NXP Reader Library  v17.1.0.2535
Collaboration diagram for Component : Software:

Data Structures

struct  phalVca_Sw_CardTableEntry_t
 Structure for Card table. More...
 
struct  phalVca_Sw_IidTableEntry_t
 Structure for IID table. More...
 
struct  phalVca_Sw_DataParams_t
 VCA Software parameter structure. More...
 

Macros

#define PHAL_VCA_SW_ID   0x01
 ID for Software Virtual Card Architecture layer.
 

Enumerations

enum  phalVca_VirtualCardState {
  VC_NOT_SELECTED = 0x00, VC_PROXIMITYFAILED = 0x01, VC_PROXIMITYCHECK = 0x02, VC_DF_NOT_AUTH = 0x03,
  VC_DF_AUTH_D40 = 0x04, VC_DF_AUTH_ISO = 0x05, VC_DF_AUTH_AES = 0x07, VC_DF_AUTH_EV2 = 0x06,
  VC_DF_AUTH_ECC = 0x0A, VC_MFP_AUTH_AES_SL1 = 0x08, VC_MFP_AUTH_AES_SL3 = 0x09
}
 Enum defining VC states. More...
 
enum  phalVca_ProximityCheckState {
  PC_NO_PCHK_IN_PROGRESS = 0x00, PC_PPC_IN_PROGRESS = 0x01, PC_PCHK_PREPARED = 0x02, PC_PCHK_IN_PROGRESS = 0x03,
  PC_WAITING_PC_VERIFICATION = 0x04, PC_VPC_IN_PROGRESS = 0x05
}
 Enum defining PC states. More...
 

Functions

phStatus_t phalVca_Sw_Init (phalVca_Sw_DataParams_t *pDataParams, uint16_t wSizeOfDataParams, void *pPalMifareDataParams, void *pKeyStoreDataParams, void *pCryptoDataParams, void *pCryptoRngDataParams, phalVca_Sw_IidTableEntry_t *pIidTableStorage, uint16_t wNumIidTableStorageEntries, phalVca_Sw_CardTableEntry_t *pCardTableStorage, uint16_t wNumCardTableStorageEntries)
 Initialization API for AL VCA / PC to communicate with direct reader and PICC. More...
 

Detailed Description

Enumeration Type Documentation

◆ phalVca_VirtualCardState

Enum defining VC states.

Enumerator
VC_NOT_SELECTED 

State to indicate no VC selection.

VC_PROXIMITYFAILED 

State to indicate Proximity Check Failure.

VC_PROXIMITYCHECK 

State to indicate Proximity Check.

VC_DF_NOT_AUTH 

State to indicate DESFire / DUOX PICC in not authenticated.

VC_DF_AUTH_D40 

State to indicate DESFire PICC in D40 authenticated.

VC_DF_AUTH_ISO 

State to indicate DESFire PICC in ISO authenticated.

VC_DF_AUTH_AES 

State to indicate DESFire PICC in AES Authenticated.

VC_DF_AUTH_EV2 

State to indicate DESFire / DUOX PICC in EV2 Authenticated.

VC_DF_AUTH_ECC 

State to indicate DUOX PICC in ECC Authenticated.

VC_MFP_AUTH_AES_SL1 

State to indicate MIFARE Plus PICC authenticated in Security Level 1.

VC_MFP_AUTH_AES_SL3 

State to indicate MIFARE Plus PICC authenticated in Security Level 3.

◆ phalVca_ProximityCheckState

Enum defining PC states.

Enumerator
PC_NO_PCHK_IN_PROGRESS 

State to indicate there is no Proximity check in progress.

PC_PPC_IN_PROGRESS 

State to indicate Proximity check preparation is in progress.

PC_PCHK_PREPARED 

State to indicate Proximity check is prepared.

PC_PCHK_IN_PROGRESS 

State to indicate Proximity check is in progress.

PC_WAITING_PC_VERIFICATION 

State to indicate waiting of Proximity check verification .

PC_VPC_IN_PROGRESS 

State to indicate Proximity check verification is in progress.

Function Documentation

◆ phalVca_Sw_Init()

phStatus_t phalVca_Sw_Init ( phalVca_Sw_DataParams_t pDataParams,
uint16_t  wSizeOfDataParams,
void *  pPalMifareDataParams,
void *  pKeyStoreDataParams,
void *  pCryptoDataParams,
void *  pCryptoRngDataParams,
phalVca_Sw_IidTableEntry_t pIidTableStorage,
uint16_t  wNumIidTableStorageEntries,
phalVca_Sw_CardTableEntry_t pCardTableStorage,
uint16_t  wNumCardTableStorageEntries 
)

Initialization API for AL VCA / PC to communicate with direct reader and PICC.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wSizeOfDataParams[In] Specifies the size of the data parameter structure.
[in]pPalMifareDataParams[In] Pointer to the parameter structure of the palMifare layer.
[in]pKeyStoreDataParams[In] Pointer to the parameter structure of the keyStore layer.
[in]pCryptoDataParams[In] Pointer to the parameter structure of the Crypto layer.
[in]pCryptoRngDataParams[In] Pointer to the parameter structure of the CryptoRng layer.
[in]pIidTableStorage[In] Pointer to the Iid Table storage for the layer.
[in]wNumIidTableStorageEntries[In] Number of possible Iid table entries in the storage.
[in]pCardTableStorage[In] Pointer to the Card Table storage for the layer.
[in]wNumCardTableStorageEntries[In] Number of possible Card table entries in the storage.