NXP Reader Library  v17.1.0.2535
phhalHw_Sam_DataParams_t Struct Reference

Data structure for HAL SAM (AV4 and future SAM's) layer implementation
More...

Data Fields

uint16_t wId
 Layer ID for this component, NEVER MODIFY!
 
void * pBalDataParams
 Pointer to the lower layers parameter structure.
 
void * pReaderHalDataParams
 Pointer to the HAL data params of a reader. More...
 
void * pKeyStoreDataParams
 Pointer to the KeyStore used for Host Authentication.
 
void * pENCCryptoDataParams
 Pointer to the ENC crypto layers parameter structure.
 
void * pMACCryptoDataParams
 Pointer to the MAC crypto layers parameter structure.
 
void * pCryptoRngDataParams
 Pointer to the parameter structure of the CryptoRng layer.
 
void * pPLUpload_ENCCryptoDataParams
 Pointer to the ENC crypto layers parameter structure. More...
 
void * pPLUpload_MACCryptoDataParams
 Pointer to the MAC crypto layers parameter structure. More...
 
uint32_t wCmd_Ctr
 Command counter for Secure Messaging.
 
uint8_t bHostMode
 Indicates Host-Communication modes. More...
 
uint8_t bAuthType
 The current Authentication Type used for SM.
 
uint8_t bKeyNo
 Store the current authentication key.
 
uint8_t bPendingEncCmdData [16U]
 Command Data pending for encryption.
 
uint8_t bPendingEncCmdDataLength
 Length of pending command data to encrypt.
 
uint8_t bPendingCmdIv [16U]
 InitVector for pending CMD-Data encryption.
 
uint8_t bPendingMacCmdData [16U]
 Command Data pending for MACing.
 
uint8_t bPendingMacCmdDataLength
 Length of pending command data to MAC.
 
uint8_t bPendingCmdMac [16U]
 InitVector for pending CMD-Data MACing.
 
uint8_t bPendingMacRespData [16U]
 Response Data pending for MACing.
 
uint8_t bPendingMacRespDataLength
 Length of pending receive data to MAC.
 
uint8_t bPendingRespMac [16U]
 Intermediate response MAC.
 
uint8_t bPendingRespIv [16U]
 InitVector for pending receive-Data decryption.
 
uint8_t bPendingRespData [16U]
 Pending (unreturned) response data.
 
uint8_t bPendingRespDataLength
 Length of pending response data.
 
uint8_t bCmdSM
 Type of secure messaging for current command.
 
uint8_t bRespSM
 Type of secure messaging for current response.
 
uint8_t bCommandChaining
 Whether command chaining is active or not.
 
uint8_t bResponseChaining
 Whether response chaining is active or not.
 
uint8_t bUid [0x07U]
 SAM Unique Identifier.
 
uint8_t bOpMode
 Operation mode. More...
 
uint8_t bLogicalChannel
 Logical channel number to select for Authentication. More...
 
uint8_tpTxBuffer
 Pointer to global transmit buffer.
 
uint16_t wTxBufSize
 Size of the global transmit buffer.
 
uint16_t wTxBufLen
 Number of valid bytes for exchange within the transmit buffer.
 
uint16_t wTxBufLen_Cmd
 Number of valid bytes for other commands within the transmit buffer.
 
uint8_tpRxBuffer
 Pointer to global receive buffer.
 
uint16_t wRxBufSize
 Size of the global receive buffer.
 
uint16_t wRxBufLen
 Number of valid bytes within the receive buffer.
 
uint16_t wRxBufStartPos
 Starting position within the global receive buffer.
 
uint16_t wTxBufStartPos
 Starting position within the global transmit buffer (used if pTxBuffer equals pRxBuffer).
 
uint16_t wCfgShadow [0x000FU]
 Configuration shadow; Stores configuration for current CardType.
 
uint8_t bCardType
 Type of card for which the Hal is configured for.
 
uint8_t bTimeoutUnit
 Unit of current timeout value. More...
 
uint16_t wFieldOffTime
 Field-Off-Time in milliseconds.
 
uint16_t wFieldRecoveryTime
 Field-Recovery-Time in milliseconds.
 
uint16_t wAdditionalInfo
 Storage for additional error information.
 
uint16_t wErrorCode
 Actual Error Code received from SAM.
 
uint16_t wTimingMode
 Disables/Enables time measurement.
 
uint32_t dwTimingUs
 Current timing value.
 
uint8_t bRfResetAfterTo
 Storage for PHHAL_HW_CONFIG_RFRESET_ON_TIMEOUT setting.
 
uint8_t bDisableNonXCfgMapping
 Storage for PHHAL_HW_SAM_CONFIG_DISABLE_NONX_CFG_MAPPING setting.
 
uint16_t dwFdtPc
 Current timing value backup for PC.
 
uint8_tpPLUploadBuf
 Buffer to store the complete segment information of PLUpload command. More...
 
uint16_t wPLUploadBufLen
 The size of bytes available in PLUploadBuff buffer.
 
uint8_t aPLUploadSessMAC0 [32]
 Programmable Logic Initial session key for macing the data.
 
uint8_t bPLUploadKeyType
 The current key type used for crypto operations.
 
uint8_tpCmdBuff
 Pointer to global command buffer. More...
 
uint16_t wCmdBuffSize
 Size of the global command buffer.
 

Detailed Description

Data structure for HAL SAM (AV4 and future SAM's) layer implementation

Field Documentation

◆ pReaderHalDataParams

void* phhalHw_Sam_DataParams_t::pReaderHalDataParams

Pointer to the HAL data params of a reader.

NULL in case of X-Mode.

◆ pPLUpload_ENCCryptoDataParams

void* phhalHw_Sam_DataParams_t::pPLUpload_ENCCryptoDataParams

Pointer to the ENC crypto layers parameter structure.

This will be used for ProgrammableLogic feature only.

◆ pPLUpload_MACCryptoDataParams

void* phhalHw_Sam_DataParams_t::pPLUpload_MACCryptoDataParams

Pointer to the MAC crypto layers parameter structure.

This will be used for ProgrammableLogic feature only.

◆ bHostMode

uint8_t phhalHw_Sam_DataParams_t::bHostMode

Indicates Host-Communication modes.

One of the following,

◆ bOpMode

uint8_t phhalHw_Sam_DataParams_t::bOpMode

◆ bLogicalChannel

uint8_t phhalHw_Sam_DataParams_t::bLogicalChannel

Logical channel number to select for Authentication.

◆ bTimeoutUnit

uint8_t phhalHw_Sam_DataParams_t::bTimeoutUnit

Unit of current timeout value.

◆ pPLUploadBuf

uint8_t* phhalHw_Sam_DataParams_t::pPLUploadBuf

Buffer to store the complete segment information of PLUpload command.

The buffer should have a memory size equivalent to the complete PLUpload Segment(s) size.

◆ pCmdBuff

uint8_t* phhalHw_Sam_DataParams_t::pCmdBuff

Pointer to global command buffer.

This will be used to frame SAM Command.


The documentation for this struct was generated from the following file: