rt-thread-official/bsp/imxrt/libraries/MIMXRT1170/MIMXRT1176/drivers/fsl_smartcard_phy.h

128 lines
4.2 KiB
C

/*
* Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
* Copyright 2016-2017 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef _FSL_SMARTCARD_PHY_H_
#define _FSL_SMARTCARD_PHY_H_
#include "fsl_smartcard.h"
/*!
* @addtogroup smartcard_phy_driver
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @brief Smart card definition which specifies the adjustment number of clock cycles during which an ATR string has to
* be received.
*/
#define SMARTCARD_ATR_DURATION_ADJUSTMENT (360u)
/*! @brief Smart card definition which specifies the adjustment number of clock cycles until an initial 'TS' character
* has to be
* received. */
#define SMARTCARD_INIT_DELAY_CLOCK_CYCLES_ADJUSTMENT (4200u)
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @brief Fills in the configuration structure with default values.
*
* @param config The Smart card user configuration structure which contains configuration structure of type
* smartcard_interface_config_t.
* Function fill in members:
* clockToResetDelay = 42000,
* vcc = kSmartcardVoltageClassB3_3V,
* with default values.
*/
void SMARTCARD_PHY_GetDefaultConfig(smartcard_interface_config_t *config);
/*!
* @brief Initializes a Smart card interface instance.
*
* @param base The Smart card peripheral base address.
* @param config The user configuration structure of type smartcard_interface_config_t. Call the
* function SMARTCARD_PHY_GetDefaultConfig() to fill the configuration structure.
* @param srcClock_Hz Smart card clock generation module source clock.
*
* @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
*/
status_t SMARTCARD_PHY_Init(void *base, smartcard_interface_config_t const *config, uint32_t srcClock_Hz);
/*!
* @brief De-initializes a Smart card interface, stops the Smart card clock, and disables the VCC.
*
* @param base The Smart card peripheral module base address.
* @param config The user configuration structure of type smartcard_interface_config_t.
*/
void SMARTCARD_PHY_Deinit(void *base, smartcard_interface_config_t const *config);
/*!
* @brief Activates the Smart card IC.
*
* @param base The Smart card peripheral module base address.
* @param context A pointer to a Smart card driver context structure.
* @param resetType type of reset to be performed, possible values
* = kSmartcardColdReset, kSmartcardWarmReset
*
* @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
*/
status_t SMARTCARD_PHY_Activate(void *base, smartcard_context_t *context, smartcard_reset_type_t resetType);
/*!
* @brief De-activates the Smart card IC.
*
* @param base The Smart card peripheral module base address.
* @param context A pointer to a Smart card driver context structure.
*
* @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
*/
status_t SMARTCARD_PHY_Deactivate(void *base, smartcard_context_t *context);
/*!
* @brief Controls the Smart card interface IC.
*
* @param base The Smart card peripheral module base address.
* @param context A pointer to a Smart card driver context structure.
* @param control A interface command type.
* @param param Integer value specific to control type
*
* @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
*/
status_t SMARTCARD_PHY_Control(void *base,
smartcard_context_t *context,
smartcard_interface_control_t control,
uint32_t param);
/*!
* @brief Smart card interface IC IRQ ISR.
*
* @param base The Smart card peripheral module base address.
* @param context The Smart card context pointer.
*/
#if defined(USING_PHY_TDA8035)
void SMARTCARD_PHY_IRQHandler(void *base, smartcard_context_t *context);
#endif
/*@}*/
#if defined(__cplusplus)
}
#endif
/*! @}*/
#endif /* _FSL_SMARTCARD_PHY_H_*/