MCUXpresso SDK API Reference Manual  Rev. 0
NXP Semiconductors
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Smart Card PHY GPIO Driver

Overview

The Smart Card interface GPIO driver handles the GPIO and FTM/TPM peripheral for clock generation, which covers all necessary functions to control the ICC. These functions are ICC clock setup, ICC voltage turning on/off, activation/deactivation, and ICC reset sequences. This driver doesn't support the ICC pin short circuit protection and an emergency deactivation.

Macros

#define SMARTCARD_ATR_DURATION_ADJUSTMENT   (360u)
 Smart card define which specifies the adjustment number of clock cycles during which an ATR string has to be received.
 
#define SMARTCARD_INIT_DELAY_CLOCK_CYCLES_ADJUSTMENT   (4200u)
 Smart card define which specifies the adjustment number of clock cycles until an initial 'TS' character has to be received. More...
 

Functions

void SMARTCARD_PHY_GPIO_GetDefaultConfig (smartcard_interface_config_t *config)
 Fills in the configuration structure with default values. More...
 
status_t SMARTCARD_PHY_GPIO_Init (UART_Type *base, smartcard_interface_config_t const *config, uint32_t srcClock_Hz)
 Initializes a Smart card interface instance. More...
 
void SMARTCARD_PHY_GPIO_Deinit (UART_Type *base, smartcard_interface_config_t *config)
 De-initializes a Smart card interface, stops the Smart card clock, and disables the VCC. More...
 
status_t SMARTCARD_PHY_GPIO_Activate (UART_Type *base, smartcard_context_t *context, smartcard_reset_type_t resetType)
 Activates the Smart card IC. More...
 
status_t SMARTCARD_PHY_GPIO_Deactivate (UART_Type *base, smartcard_context_t *context)
 De-activates the Smart card IC. More...
 
status_t SMARTCARD_PHY_GPIO_Control (UART_Type *base, smartcard_context_t *context, smartcard_interface_control_t control, uint32_t param)
 Controls the Smart card interface IC. More...
 

Macro Definition Documentation

#define SMARTCARD_INIT_DELAY_CLOCK_CYCLES_ADJUSTMENT   (4200u)

Function Documentation

void SMARTCARD_PHY_GPIO_GetDefaultConfig ( smartcard_interface_config_t config)
Parameters
configThe 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.
status_t SMARTCARD_PHY_GPIO_Init ( UART_Type *  base,
smartcard_interface_config_t const *  config,
uint32_t  srcClock_Hz 
)
Parameters
baseThe Smart card peripheral module base address.
configThe user configuration structure of type smartcard_interface_config_t. Call to fill out configuration structure function SMARTCARD_PHY_GPIO_GetDefaultConfig().
srcClock_HzSmart card clock generation module source clock.
Return values
kStatus_SMARTCARD_Successor kStatus_SMARTCARD_OtherError in case of error.
void SMARTCARD_PHY_GPIO_Deinit ( UART_Type *  base,
smartcard_interface_config_t config 
)
Parameters
baseThe Smart card peripheral module base address.
configThe user configuration structure of type smartcard_interface_config_t.
status_t SMARTCARD_PHY_GPIO_Activate ( UART_Type *  base,
smartcard_context_t context,
smartcard_reset_type_t  resetType 
)
Parameters
baseThe Smart card peripheral module base address.
contextA pointer to a Smart card driver context structure.
resetTypetype of reset to be performed, possible values = kSmartcardColdReset, kSmartcardWarmReset
Return values
kStatus_SMARTCARD_Successor kStatus_SMARTCARD_OtherError in case of error.
status_t SMARTCARD_PHY_GPIO_Deactivate ( UART_Type *  base,
smartcard_context_t context 
)
Parameters
baseThe Smart card peripheral module base address.
contextA pointer to a Smart card driver context structure.
Return values
kStatus_SMARTCARD_Successor kStatus_SMARTCARD_OtherError in case of error.
status_t SMARTCARD_PHY_GPIO_Control ( UART_Type *  base,
smartcard_context_t context,
smartcard_interface_control_t  control,
uint32_t  param 
)
Parameters
baseThe Smart card peripheral module base address.
contextA pointer to a Smart card driver context structure.
controlAn interface command type.
paramInteger value specific to the control type.
Return values
kStatus_SMARTCARD_Successor kStatus_SMARTCARD_OtherError in case of error.