X Mode

SAM commands used for Virtual Card communication in X-Mode. More...

Collaboration diagram for X Mode:

Functions
phStatus_t	phhalHw_SamAV3_Cmd_VCA_Select (phhalHw_SamAV3_DataParams_t *pDataParams, uint8_t bOption, uint8_t bEncKeyNo, uint8_t bEncKeyVer, uint8_t bMacKeyNo, uint8_t bMacKeyVer, uint8_t *pIID, uint8_t bIIDLen, uint8_t *pDivInput, uint8_t bDivInputLen, uint8_t **pResponse, uint16_t *pRespLen, uint16_t *pPiccRetCode)
	Performs Virtual card selection in X-Mode. More...
phStatus_t	phhalHw_SamAV3_Cmd_VCA_ProximityCheck (phhalHw_SamAV3_DataParams_t *pDataParams, uint8_t bOption, uint8_t bKeyNo, uint8_t bKeyVer, uint8_t bNumOfRand, uint8_t *pDivInput, uint8_t bDivInputLen, uint8_t **ppResponse, uint16_t *pRespLen)
	Performs Proximity Check command execution in X-Mode. More...

Sam AV3 command code for VCA / PC X mode features.
#define	PHHAL_HW_SAMAV3_CMD_VCA_SELECT_INS   0x45
	Sam AV3 Instruction code for Cmd.VCA_SelectVC command.
#define	PHHAL_HW_SAMAV3_CMD_VCA_PROXIMITY_CHECK_INS   0xFB
	Sam AV3 Instruction code for Cmd.VCA_ProximityCheck command.

Option macros for Sam AV3 VCA / PC 2-part variants for VC selection.
#define	PHHAL_HW_SAMAV3_CMD_VCA_SELECT_VARIANT_PART1   0x00
	Option mask for complete VC selection in 1 part.
#define	PHHAL_HW_SAMAV3_CMD_VCA_SELECT_VARIANT_PART2   0x08
	Option mask for complete VC selection in 2 part.

Option macros for Sam AV3 VCA / PC Proximity check command format (Native or Wrapped).
#define	PHHAL_HW_SAMAV3_CMD_PC_NATIVE_FORMAT   0x00
	Option mask to perform Proximity Check in native format.
#define	PHHAL_HW_SAMAV3_CMD_PC_WRAPPED_FORMAT   0x04
	Option mask to perform Proximity Check in Iso7816-4 wrapped format.

Option macros for Sam AV3 VCA / PC Proximity check random or normal processing.
#define	PHHAL_HW_SAMAV3_CMD_PC_NORMAL_PROCESSING   0x00
	Option mask to perform Normal Cmd.VerifyPC processing.
#define	PHHAL_HW_SAMAV3_CMD_PC_RANDOM_PROCESSING   0x02
	Option mask to perform Random Cmd.VerifyPC processing.

Detailed Description

SAM commands used for Virtual Card communication in X-Mode.

Function Documentation

phhalHw_SamAV3_Cmd_VCA_Select()

phStatus_t phhalHw_SamAV3_Cmd_VCA_Select	(	phhalHw_SamAV3_DataParams_t *	pDataParams,
		uint8_t	bOption,
		uint8_t	bEncKeyNo,
		uint8_t	bEncKeyVer,
		uint8_t	bMacKeyNo,
		uint8_t	bMacKeyVer,
		uint8_t *	pIID,
		uint8_t	bIIDLen,
		uint8_t *	pDivInput,
		uint8_t	bDivInputLen,
		uint8_t **	pResponse,
		uint16_t *	pRespLen,
		uint16_t *	pPiccRetCode
	)

Performs Virtual card selection in X-Mode.

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]	bOption	[In] Option to indicate diversification options for VCSelectMAC key. PHHAL_HW_SAMAV3_CMD_SELECT_MAC_KEY_DIV_OFF PHHAL_HW_SAMAV3_CMD_SELECT_MAC_KEY_DIV_INPUT PHHAL_HW_SAMAV3_CMD_SELECT_MAC_KEY_DIV_VCUID PHHAL_HW_SAMAV3_CMD_SELECT_MAC_KEY_DIV_INPUT_VCUID Option to indicate diversification options for VcSelectENC key. PHHAL_HW_SAMAV3_CMD_SELECT_ENC_KEY_DIV_OFF PHHAL_HW_SAMAV3_CMD_SELECT_ENC_KEY_DIV_INPUT Option to disable the diversification for VcSelect MAC and ENC keys. PHHAL_HW_SAMAV3_CMD_SELECT_DIV_DEFAULT VC selection can be done in 1-part of 2-parts. PHHAL_HW_SAMAV3_CMD_VCA_SELECT_VARIANT_PART1 PHHAL_HW_SAMAV3_CMD_VCA_SELECT_VARIANT_PART2
[in]	bEncKeyNo	[In] Reference key number to be used in hardware keystore for VCSelectENC key.
[in]	bEncKeyVer	[In] Reference key version to be used in hardware keystore for VCSelectENC key.
[in]	bMacKeyNo	[In] Reference key number to be used in hardware keystore for VCSelectMAC key.
[in]	bMacKeyVer	[In] Reference key version to be used in hardware keystore for VCSelectMAC key.
[in]	pIID	[In] The Installation Identifier (IID) to be selected.
[in]	bIIDLen	[In] Length of the IID.
[in]	pDivInput	[In] Diversification Input used to diversify the key.
[in]	bDivInputLen	[In] Length of diversification input used to diversify the key.
[out]	pResponse	[Out] Response received from SAM based on the variants and AuthVCMandatory settings AuthVC Not Mandatory & Variant 1 : Conf0 (1byte), FCI (N bytes) AuthVC Mandatory & Variant 1 : Conf1 (1byte), VC Data (16 bytes) AuthVC Mandatory & Variant 2 : VC Data (16 bytes)
[out]	pRespLen	[Out] Length bytes available in response buffer.
[out]	pPiccRetCode	[Out] The status code returned from the PICC. This will be applicable for both the variants.

phhalHw_SamAV3_Cmd_VCA_ProximityCheck()

phStatus_t phhalHw_SamAV3_Cmd_VCA_ProximityCheck	(	phhalHw_SamAV3_DataParams_t *	pDataParams,
		uint8_t	bOption,
		uint8_t	bKeyNo,
		uint8_t	bKeyVer,
		uint8_t	bNumOfRand,
		uint8_t *	pDivInput,
		uint8_t	bDivInputLen,
		uint8_t **	ppResponse,
		uint16_t *	pRespLen
	)

Performs Proximity Check command execution in X-Mode.

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]	bOption	[In] Option to indicate diversification options. PHHAL_HW_SAMAV3_CMD_PROXIMITY_CHECK_DIV_OFF PHHAL_HW_SAMAV3_CMD_PROXIMITY_CHECK_DIV_ON Option to indicate Cmd.VerifyPC processing. PHHAL_HW_SAMAV3_CMD_PC_NORMAL_PROCESSING PHHAL_HW_SAMAV3_CMD_PC_RANDOM_PROCESSING The command format to be used to communicated to PICC. PHHAL_HW_SAMAV3_CMD_PC_NATIVE_FORMAT PHHAL_HW_SAMAV3_CMD_PC_WRAPPED_FORMAT
[in]	bKeyNo	[In] Reference key number to be used in hardware keystore.
[in]	bKeyVer	[In] Reference key version to be used in hardware keystore.
[in]	bNumOfRand	[In] Maximum number of random bytes sent in one Cmd.ProxmityCheck
[in]	pDivInput	[In] Diversification Input used to diversify the key.
[in]	bDivInputLen	[In] Length of diversification input used to diversify the key.
[out]	ppResponse	[Out] Response received from SAM. For PICC Error : The PICC error code will be returned. For PICC Success: The PPCDataLen and PPCData will be returned.
[out]	pRespLen	[Out] Length bytes available in response buffer.