Component : Rc663

RC663 Reader HAL. More...

Collaboration diagram for Component : Rc663:

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

Data Structures
struct	phhalHw_Rc663_DataParams_t
	Rc663 HAL parameter structure. More...

Macros
#define	PHHAL_HW_RC663_ID   0x01
	ID for Rc663 HAL component.
#define	PHHAL_HW_RC663_DEFAULT_TIMEOUT   150U
	Default timeout in microseconds.
#define	PHHAL_HW_RC663_SHADOW_COUNT   0x0010U
	Number of shadowed configurations.

Functions
phStatus_t	phhalHw_Rc663_Init (phhalHw_Rc663_DataParams_t *pDataParams, uint16_t wSizeOfDataParams, void *pBalDataParams, uint8_t *pLoadRegConfig, uint8_t *pTxBuffer, uint16_t wTxBufSize, uint8_t *pRxBuffer, uint16_t wRxBufSize)
	Initialise the HAL component. More...

Custom Configs
#define	PHHAL_HW_RC663_CONFIG_FIFOSIZE   (PH_CONFIG_CUSTOM_BEGIN + 0)
	Configure FIFO-Size.
#define	PHHAL_HW_RC663_CONFIG_LOADREG_MODE   (PH_CONFIG_CUSTOM_BEGIN + 1)
	Enable (PH_ON) or disable (PH_OFF) LoadReg Mode. More...

Fifo Configuration Values
#define	PHHAL_HW_RC663_VALUE_FIFOSIZE_255   0x0000U
	Configure FIFO-Size to 256 bytes.
#define	PHHAL_HW_RC663_VALUE_FIFOSIZE_512   0x0001U
	Configure FIFO-Size to 512 bytes.

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

Detailed Description

RC663 Reader HAL.

Note: This HAL takes care about the "Request Guard Time".

See also

phpalI14443p3a_RequestA

phpalI14443p3a_WakeUpA

Macro Definition Documentation

PHHAL_HW_RC663_CONFIG_LOADREG_MODE

#define PHHAL_HW_RC663_CONFIG_LOADREG_MODE   (PH_CONFIG_CUSTOM_BEGIN + 1)

Enable (PH_ON) or disable (PH_OFF) LoadReg Mode.

If this mode is enabled (it's disabled by default) then LoadReg is used
if an operation mode changes instead of applying library constants.
This is useful if custom antenna configuration values are required to be applied.
The parameters for LoadReg are taken from pLoadRegConfig which is an input parameter
of phhalHw_Rc663_Init. Refer there for a detailed description of pLoadRegConfig.

Function Documentation

phhalHw_Rc663_Init()

phStatus_t phhalHw_Rc663_Init	(	phhalHw_Rc663_DataParams_t *	pDataParams,
		uint16_t	wSizeOfDataParams,
		void *	pBalDataParams,
		uint8_t *	pLoadRegConfig,
		uint8_t *	pTxBuffer,
		uint16_t	wTxBufSize,
		uint8_t *	pRxBuffer,
		uint16_t	wRxBufSize
	)

Initialise the HAL component.

A note on pLoadRegConfig:
This is used if PHHAL_HW_RC663_CONFIG_LOADREG_MODE is enabled.
It is defined as follows:

[MSB]                                              [LSB]
31...............16..................8.................0
+------------------+------------------+----------------+
| wEEAddress (16b) | bRegAddress (8b) | bNumBytes (8b) |
+------------------+------------------+----------------+

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]	pLoadRegConfig	[In] Pointer to configuration buffer for LoadReg mode; See description above.
[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.