SamAV3 Reader HAL. More...

Collaboration diagram for Component : SamAV3:

Modules
	Register Definitions for Rc523
	Register definitions for Rc663.

	Register Definitions for Rc663
	Register definitions for Rc663.

	Host Communication
	Host Communication.

	Command Interface
	Command Interface.

Data Structures
struct	phhalHw_SamAV3_DataParams_t
	SamAV3 HAL parameter structure. More...

Macros
#define	PHHAL_HW_SAMAV3_ID 0x10
	ID for SamAV3 HAL component.

#define	PHHAL_HW_SAMAV3_RESERVED_TX_BUFFER_LEN 6U
	Amount of needed and reserved memory for the protocol overhead.

#define	PHHAL_HW_SAMAV3_RESERVED_RX_BUFFER_LEN 2U
	Amount of needed and reserved memory for the protocol overhead.

Functions
phStatus_t	phhalHw_SamAV3_Init (phhalHw_SamAV3_DataParams_t pDataParams, uint16_t wSizeOfDataParams, void pBalDataParams, void pReaderHalDataParams, void pKeyStoreDataParams, void pCryptoENCDataParams, void pCryptoMACDataParams, void pCryptoRngDataParams, void pPLUpload_CryptoENCDataParams, void pPLUpload_CryptoMACDataParams, uint8_t bOpMode, uint8_t bLogicalChannel, uint8_t pTxBuffer, uint16_t wTxBufSize, uint8_t pRxBuffer, uint16_t wRxBufSize, uint8_t pPLUploadBuf)
	Initialise the HAL component. More...

phStatus_t	phhalHw_SamAV3_DetectMode (phhalHw_SamAV3_DataParams_t *pDataParams)
	Detect UID, AV2/AV3 mode and HostAuth settings. More...

Operation modes
#define	PHHAL_HW_SAMAV3_OPMODE_NON_X 0x00
	Non-X operation mode.

#define	PHHAL_HW_SAMAV3_OPMODE_X_RC523 0x01
	X-Mode operation (using Rc523).

#define	PHHAL_HW_SAMAV3_OPMODE_X_RC663 0x02
	X-Mode operation (using Rc663).

Host-Communication modes
#define	PHHAL_HW_SAMAV3_HC_AV2_MODE 0x02U
	Sam AV2 hardware is used.

#define	PHHAL_HW_SAMAV3_HC_AV3_MODE 0x03U
	Sam AV3 hardware is used with sam in Un-Activated or Activated state.

Configs
#define	PHHAL_HW_SAMAV3_CONFIG_HOSTMODE (PH_CONFIG_CUSTOM_BEGIN + 0)
	Get / Set the Hostmode; (e.g. More...

#define	PHHAL_HW_SAMAV3_CONFIG_DISABLE_NONX_CFG_MAPPING (PH_CONFIG_CUSTOM_BEGIN + 1)
	Disables the mapping of standard-configs to the Reader HAL if set to PH_ON; Default is PH_OFF; Only applicable in NonX-Mode.

phhalHw_SamAV3 Custom Exchange Option Bits
#define	PHHAL_HW_SAMAV3_EXCHANGE_NO_ENCIPHERING_BIT 0x0010U
	Suppress MIFARE Crypto enciphering of transmitted data.

#define	PHHAL_HW_SAMAV3_EXCHANGE_NO_DECIPHERING_BIT 0x0020U
	Suppress deciphering of received MIFARE Crypto streams.

Detailed Description

SamAV3 Reader HAL.

Also supports AV2 backwards compatibility mode.

Macro Definition Documentation

◆ PHHAL_HW_SAMAV3_CONFIG_HOSTMODE

#define PHHAL_HW_SAMAV3_CONFIG_HOSTMODE (PH_CONFIG_CUSTOM_BEGIN + 0)

Get / Set the Hostmode; (e.g.

PHHAL_HW_SAMAV3_HC_AV2_MODE).

Function Documentation

◆ phhalHw_SamAV3_Init()

phStatus_t phhalHw_SamAV3_Init	(	phhalHw_SamAV3_DataParams_t *	pDataParams,
		uint16_t	wSizeOfDataParams,
		void *	pBalDataParams,
		void *	pReaderHalDataParams,
		void *	pKeyStoreDataParams,
		void *	pCryptoENCDataParams,
		void *	pCryptoMACDataParams,
		void *	pCryptoRngDataParams,
		void *	pPLUpload_CryptoENCDataParams,
		void *	pPLUpload_CryptoMACDataParams,
		uint8_t	bOpMode,
		uint8_t	bLogicalChannel,
		uint8_t *	pTxBuffer,
		uint16_t	wTxBufSize,
		uint8_t *	pRxBuffer,
		uint16_t	wRxBufSize,
		uint8_t *	pPLUploadBuf
	)

Initialise the HAL component.

The operation mode used is only dependend on the pReaderHalDataParams parameter.
If it's value is NULL X-Mode operation is performed, otherwise the HAL operates in Non-X Mode.
Non-X Mode Specific: It is not neccessary to do any (non-specific) calls to the linked Reader-HAL except an Init(),
the SamAV3 HAL will take over complete control of the linked Reader.
Specific initialisation like PHHAL_HW_CONFIG_BAL_CONNECTION or PHHAL_HW_CONFIG_SERIAL_BITRATE etc. though may be neccessary depending on the used HAL.

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]	pReaderHalDataParams	[In] Pointer to a Reader-HAL in Non-X Mode. Can be NULL if X-Mode is intended.
[in]	pKeyStoreDataParams	[In] Pointer to the KeyStore used for Host Authentication.
[in]	pCryptoENCDataParams	[In] Pointer to the ENC crypto layers parameter structure.
[in]	pCryptoMACDataParams	[In] Pointer to the MAC crypto layers parameter structure.
[in]	pCryptoRngDataParams	[In] Pointer to the parameter structure of the CryptoRng layer.
	pPLUpload_CryptoENCDataParams	Pointer to the ENC crypto layers parameter structure. This will be used for ProgrammableLogic feature only.
	pPLUpload_CryptoMACDataParams	Pointer to the MAC crypto layers parameter structure. This will be used for ProgrammableLogic feature only.
[in]	bOpMode	[In] The desired operation mode PHHAL_HW_SAMAV3_OPMODE_NON_X. PHHAL_HW_SAMAV3_OPMODE_X_RC523. PHHAL_HW_SAMAV3_OPMODE_X_RC663.
[in]	bLogicalChannel	[In] The desired logical channel for this HAL.
[in]	pTxBuffer	[In] Pointer to global transmit buffer.
[in]	wTxBufSize	[In] Size of the global transmit buffer.
[in]	pRxBuffer	[In] Pointer to global receive buffer.
[in]	wRxBufSize	[In] Size of the global receive buffer.
[in]	pPLUploadBuf	[In] Pointer to global PLUpload buffer.

◆ phhalHw_SamAV3_DetectMode()

phStatus_t phhalHw_SamAV3_DetectMode ( phhalHw_SamAV3_DataParams_t * pDataParams )

Detect UID, AV2/AV3 mode and HostAuth settings.

Returns: Status code

Return values

PH_ERR_SUCCESS Operation successful.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

Modules

Data Structures

Macros

Functions

Operation modes

Host-Communication modes