Component : Rc523

RC523 Reader HAL. More...

Collaboration diagram for Component : Rc523:

Modules
	Commands
	Supported ReaderIC commands.
	Internal
	Internal definitions.
	Register Definitions
	Register definitions.
	Configuration
	Custom Configuration of hardware related settings.

Data Structures
struct	phhalHw_Rc523_DataParams_t
	Rc523 HAL parameter structure. More...

Macros
#define	PHHAL_HW_RC523_ID   0x02
	ID for Rc523 HAL component.
#define	PHHAL_HW_RC523_SHADOW_COUNT   0x000FU
	Number of shadowed configurations.

Functions
phStatus_t	phhalHw_Rc523_Init (phhalHw_Rc523_DataParams_t *pDataParams, uint16_t wSizeOfDataParams, void *pBalDataParams, void *pKeyStoreDataParams, uint8_t *pTxBuffer, uint16_t wTxBufSize, uint8_t *pRxBuffer, uint16_t wRxBufSize)
	Initialise the HAL component. More...

Custom Option Bits : Can be used for \ref phhalHw_Exchange, \ref phhalHw_Rc663_Cmd_Receive and \ref phhalHw_Rc663_Cmd_Transmit.
#define	PHHAL_HW_RC523_OPTION_RXTX_TIMER_NOSTART   0x0000U
	Do not start timer after transmission / before reception; (only for phhalHw_Rc523_Cmd_Receive and phhalHw_Rc523_Cmd_Transmit).
#define	PHHAL_HW_RC523_OPTION_RXTX_TIMER_START   0x0010U
	Start timer after transmission / before reception, reset timer counter value; (only for phhalHw_Rc523_Cmd_Receive and phhalHw_Rc523_Cmd_Transmit).

Detailed Description

RC523 Reader HAL.

Since RC523 and PN512 are quite compatible, the following PN512 features are also supported:

• PHHAL_HW_CARDTYPE_FELICA
• PHHAL_HW_CARDTYPE_I18092MPI
• PHHAL_HW_CARDTYPE_I18092MPT
• phhalHw_Rc523_Cmd_Config
• phhalHw_Rc523_Cmd_Autocoll

If PHHAL_HW_CARDTYPE_I18092MPT is chosen, Exchange performs the reception BEFORE the transmission.

This makes it neccessary for the application to know what to send before actually having received
the request. Therefore using phhalHw_Exchange for PN512 operation is only useful for test applications.
For other applications it's recommended to use phhalHw_Rc523_Cmd_Transmit and phhalHw_Rc523_Cmd_Receive.

Function Documentation

phhalHw_Rc523_Init()

phStatus_t phhalHw_Rc523_Init	(	phhalHw_Rc523_DataParams_t *	pDataParams,
		uint16_t	wSizeOfDataParams,
		void *	pBalDataParams,
		void *	pKeyStoreDataParams,
		uint8_t *	pTxBuffer,
		uint16_t	wTxBufSize,
		uint8_t *	pRxBuffer,
		uint16_t	wRxBufSize
	)

Initialise the HAL component.

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlaying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wSizeOfDataParams	[In] Specifies the size of the data parameter structure.
[in]	pBalDataParams	[In] Pointer to the lower layers parameter structure.
[in]	pKeyStoreDataParams	[In] Pointer to the parameter structure of the keyStore layer.
[in]	pTxBuffer	[In] Pointer to global transmit buffer used by the Exchange() function.
[in]	wTxBufSize	[In] Size of the global transmit buffer.
[in]	pRxBuffer	[In] Pointer to global receive buffer used by the Exchange() function.
[in]	wRxBufSize	[In] Size of the global receive buffer. Specify the buffer +1 byte, because one byte is reserved for SPI communication.