SamAV2

Provides a Secure Messaging interface for HostComm AV2. More...

Collaboration diagram for SamAV2:

Functions
phStatus_t	phhalHw_SamAV2_Hc_AV2_AuthenticateHost (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t bAuthType, uint16_t wRdKeyRefNum, uint16_t wRdKeyRefVer, uint8_t bSamKeyRefNum, uint8_t bSamKeyRefVer)
	Perform Host Authentication Commands and responses using SamAV2 Host Protocol. More...
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_Encrypt (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t *pBuffer, uint16_t wTxLength, uint16_t wBufferSize, uint16_t *pTxLength, uint8_t bFirst, uint8_t bLast)
	Perform Encryption using SamAV2 Host Protocol. More...
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_Decrypt (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t *pBuffer, uint16_t wRxLength, uint16_t *pRxLength, uint8_t bFirst, uint8_t bLast)
	Perform Decryption using SamAV2 Host Protocol. More...
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_AppendMac (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t *pBuffer, uint16_t wTxLength, uint16_t wBufferSize, uint16_t *pTxLength, uint8_t bFirst, uint8_t bLast)
	Append MAC to a data stream using SamAV2 Host Protocol. More...
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_VerifyRemoveMac (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t *pBuffer, uint16_t wRxLength, uint16_t *pRxLength, uint8_t bFirst, uint8_t bLast)
	Remove Mac and verify it using SamAV2 Host Protocol. More...
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastCommand (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t bCmd, uint8_t bP1, uint8_t bP2, uint8_t *pFirstCmd, uint8_t *pLastCmd)
phStatus_t	phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastResponse (phhalHw_SamAV2_DataParams_t *pDataParams, uint8_t bSw1, uint8_t bSw2, uint8_t *pFirstResponse, uint8_t *pLastResponse)

Detailed Description

Provides a Secure Messaging interface for HostComm AV2.

Function Documentation

phhalHw_SamAV2_Hc_AV2_AuthenticateHost()

phStatus_t phhalHw_SamAV2_Hc_AV2_AuthenticateHost	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t	bAuthType,
		uint16_t	wRdKeyRefNum,
		uint16_t	wRdKeyRefVer,
		uint8_t	bSamKeyRefNum,
		uint8_t	bSamKeyRefVer
	)

Perform Host Authentication Commands and responses using SamAV2 Host Protocol.

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]	bAuthType	[In] The type of Authentication to perform.
[in]	wRdKeyRefNum	[In] The key reference number for readerLib KeyStorage.
[in]	wRdKeyRefVer	[In] The key reference version for readerLib KeyStorage.
[in]	bSamKeyRefNum	[In] The key reference number for SAM KeyStorage.
[in]	bSamKeyRefVer	[In] The key reference version for SAM KeyStorage.

phhalHw_SamAV2_Hc_AV2_Int_Encrypt()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_Encrypt	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t *	pBuffer,
		uint16_t	wTxLength,
		uint16_t	wBufferSize,
		uint16_t *	pTxLength,
		uint8_t	bFirst,
		uint8_t	bLast
	)

Perform Encryption using SamAV2 Host Protocol.

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]	pBuffer	[In] Data to encrypt.
[in]	wTxLength	[In] Length of data to encrypt.
[in]	wBufferSize	[In] Size of the buffer.
[out]	pTxLength	[Out] Number of encrypted data bytes.
[in]	bFirst	[In] Whether this is the first block.
[in]	bLast	[In] Whether this is the last block.

phhalHw_SamAV2_Hc_AV2_Int_Decrypt()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_Decrypt	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t *	pBuffer,
		uint16_t	wRxLength,
		uint16_t *	pRxLength,
		uint8_t	bFirst,
		uint8_t	bLast
	)

Perform Decryption using SamAV2 Host Protocol.

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]	pBuffer	[In] Data to decrypt.
[in]	wRxLength	[In] Length of data to decrypt.
[out]	pRxLength	[Out] Number of decrypted data bytes.
[in]	bFirst	[In] Whether this is the first block.
[in]	bLast	[In] Whether this is the last block.

phhalHw_SamAV2_Hc_AV2_Int_AppendMac()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_AppendMac	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t *	pBuffer,
		uint16_t	wTxLength,
		uint16_t	wBufferSize,
		uint16_t *	pTxLength,
		uint8_t	bFirst,
		uint8_t	bLast
	)

Append MAC to a data stream using SamAV2 Host Protocol.

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]	pBuffer	[In] Data to mac.
[in]	wTxLength	[In] Length of data to mac.
[in]	wBufferSize	[In] Size of the buffer.
[out]	pTxLength	[Out] Number of data bytes incl. MAC.
[in]	bFirst	[In] Whether this is the first block.
[in]	bLast	[In] Whether this is the last block.

phhalHw_SamAV2_Hc_AV2_Int_VerifyRemoveMac()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_VerifyRemoveMac	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t *	pBuffer,
		uint16_t	wRxLength,
		uint16_t *	pRxLength,
		uint8_t	bFirst,
		uint8_t	bLast
	)

Remove Mac and verify it using SamAV2 Host Protocol.

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]	pBuffer	[In] data to unmac.
[in]	wRxLength	[In] length of data to unmac.
[out]	pRxLength	[Out] number of unmaced data bytes.
[in]	bFirst	[In] Whether this is the first block.
[in]	bLast	[In] Whether this is the last block.

phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastCommand()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastCommand	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t	bCmd,
		uint8_t	bP1,
		uint8_t	bP2,
		uint8_t *	pFirstCmd,
		uint8_t *	pLastCmd
	)

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCmd	[In] Command code.
[in]	bP1	[In] P1 of command.
[in]	bP2	[In] P2 of command.
[out]	pFirstCmd	[Out] Whether this is the first block.
[out]	pLastCmd	[Out] Whether this is the last block.

phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastResponse()

phStatus_t phhalHw_SamAV2_Hc_AV2_Int_GetFirstLastResponse	(	phhalHw_SamAV2_DataParams_t *	pDataParams,
		uint8_t	bSw1,
		uint8_t	bSw2,
		uint8_t *	pFirstResponse,
		uint8_t *	pLastResponse
	)

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bSw1	[In] SW1 of response.
[in]	bSw2	[In] SW2 of response.
[out]	pFirstResponse	[Out] Whether this is the first block.
[out]	pLastResponse	[Out] Whether this is the last block.