Smart Card PHY Driver

Overview

Macros
#define	SMARTCARD_ATR_DURATION_ADJUSTMENT   (360u)
	Smart card definition 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 definition which specifies the adjustment number of clock cycles until an initial 'TS' character has to be received. More...

Functions
void	SMARTCARD_PHY_GetDefaultConfig (smartcard_interface_config_t *config)
	Fills in the configuration structure with default values. More...
status_t	SMARTCARD_PHY_Init (void *base, smartcard_interface_config_t const *config, uint32_t srcClock_Hz)
	Initializes a Smart card interface instance. More...
void	SMARTCARD_PHY_Deinit (void *base, smartcard_interface_config_t const *config)
	De-initializes a Smart card interface, stops the Smart card clock, and disables the VCC. More...
status_t	SMARTCARD_PHY_Activate (void *base, smartcard_context_t *context, smartcard_reset_type_t resetType)
	Activates the Smart card IC. More...
status_t	SMARTCARD_PHY_Deactivate (void *base, smartcard_context_t *context)
	De-activates the Smart card IC. More...
status_t	SMARTCARD_PHY_Control (void *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_GetDefaultConfig

(

smartcard_interface_config_t *

config

)

Parameters

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.

status_t SMARTCARD_PHY_Init	(	void *	base,
		smartcard_interface_config_t const *	config,
		uint32_t	srcClock_Hz
	)

Parameters

base	The Smart card peripheral base address.
config	The user configuration structure of type smartcard_interface_config_t. Call the function SMARTCARD_PHY_GetDefaultConfig() to fill the configuration structure.
srcClock_Hz	Smart card clock generation module source clock.

Return values

kStatus_SMARTCARD_Success

or kStatus_SMARTCARD_OtherError in case of error.

void SMARTCARD_PHY_Deinit	(	void *	base,
		smartcard_interface_config_t const *	config
	)

Parameters

base	The Smart card peripheral module base address.
config	The user configuration structure of type smartcard_interface_config_t.

status_t SMARTCARD_PHY_Activate	(	void *	base,
		smartcard_context_t *	context,
		smartcard_reset_type_t	resetType
	)

Parameters

base	The Smart card peripheral module base address.
context	A pointer to a Smart card driver context structure.
resetType	type of reset to be performed, possible values = kSmartcardColdReset, kSmartcardWarmReset

Return values

kStatus_SMARTCARD_Success

or kStatus_SMARTCARD_OtherError in case of error.

status_t SMARTCARD_PHY_Deactivate	(	void *	base,
		smartcard_context_t *	context
	)

Parameters

base	The Smart card peripheral module base address.
context	A pointer to a Smart card driver context structure.

Return values

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
	)

Parameters

base	The Smart card peripheral module base address.
context	A pointer to a Smart card driver context structure.
control	A interface command type.
param	Integer value specific to control type

Return values

kStatus_SMARTCARD_Success

or kStatus_SMARTCARD_OtherError in case of error.