NXP Reader Library  v17.1.0.2535

These Components implement the Felica commands. More...

Collaboration diagram for Felica:

Modules

 Component : Software
 

Functions

phStatus_t phalFelica_RequestResponse (void *pDataParams, uint8_t *pMode)
 When receiving the RequestResponse command, the VICC shall respond. More...
 
phStatus_t phalFelica_RequestService (void *pDataParams, uint8_t bTxNumServices, uint8_t *pTxServiceList, uint8_t *pRxNumServices, uint8_t *pRxServiceList)
 When receiving the RequestService command, the VICC shall respond. More...
 
phStatus_t phalFelica_Read (void *pDataParams, uint8_t bNumServices, uint8_t *pServiceList, uint8_t bTxNumBlocks, uint8_t *pBlockList, uint8_t bBlockListLength, uint8_t *pRxNumBlocks, uint8_t *pBlockData)
 When receiving the Read command, the VICC shall respond. More...
 
phStatus_t phalFelica_Write (void *pDataParams, uint8_t bNumServices, uint8_t *pServiceList, uint8_t bNumBlocks, uint8_t *pBlockList, uint8_t bBlockListLength, uint8_t *pBlockData)
 When receiving the Write command, the VICC shall respond. More...
 
phStatus_t phalFelica_GetConfig (void *pDataParams, uint16_t wConfig, uint16_t *pValue)
 Perform a GetConfig command. More...
 

Felica constant definitions

#define PHAL_FELICA_CONFIG_ADD_INFO   0x0000U
 Set or get the additional info word.
 

FELICA error codes

#define PHAL_FELICA_ERR_FELICA   (PH_ERR_CUSTOM_BEGIN + 0)
 General Felica error.
 

Misc. Defines

#define PHAL_FELICA_MAX_SERVICES   121U
 Maximum number of services.
 

Detailed Description

These Components implement the Felica commands.

Function Documentation

◆ phalFelica_RequestResponse()

phStatus_t phalFelica_RequestResponse ( void *  pDataParams,
uint8_t pMode 
)

When receiving the RequestResponse command, the VICC shall respond.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layers parameter structure.
[out]pMode[Out] Current Card Mode. (0, 1, 2).

◆ phalFelica_RequestService()

phStatus_t phalFelica_RequestService ( void *  pDataParams,
uint8_t  bTxNumServices,
uint8_t pTxServiceList,
uint8_t pRxNumServices,
uint8_t pRxServiceList 
)

When receiving the RequestService command, the VICC shall respond.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layers parameter structure.
[in]bTxNumServices[In] Number of services or areas within the command message.
[in]pTxServiceList[In] Service code or area code list within the command message.
[out]pRxNumServices[Out] Number of received services or areas.
[out]pRxServiceList[Out] Received Service Key version or area version list, max 64 bytes.

◆ phalFelica_Read()

phStatus_t phalFelica_Read ( void *  pDataParams,
uint8_t  bNumServices,
uint8_t pServiceList,
uint8_t  bTxNumBlocks,
uint8_t pBlockList,
uint8_t  bBlockListLength,
uint8_t pRxNumBlocks,
uint8_t pBlockData 
)

When receiving the Read command, the VICC shall respond.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layers parameter structure.
[in]bNumServices[In] Number of Services.
[in]pServiceList[In] List of Services.
[in]bTxNumBlocks[In] Number of Blocks to send.
[in]pBlockList[In] List of Blocks to read.
[in]bBlockListLength[In] Number of Blocks to read.
[out]pRxNumBlocks[Out] Number of received blocks.
[out]pBlockData[Out] Received Block data.

◆ phalFelica_Write()

phStatus_t phalFelica_Write ( void *  pDataParams,
uint8_t  bNumServices,
uint8_t pServiceList,
uint8_t  bNumBlocks,
uint8_t pBlockList,
uint8_t  bBlockListLength,
uint8_t pBlockData 
)

When receiving the Write command, the VICC shall respond.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layers parameter structure.
[in]bNumServices[In] Number of Services.
[in]pServiceList[In] List of Services.
[in]bNumBlocks[In] Number of Blocks to send.
[in]pBlockList[In] List of Blocks to write.
[in]bBlockListLength[In] Number of Blocks to write.
[in]pBlockData[In] Block data to write.

◆ phalFelica_GetConfig()

phStatus_t phalFelica_GetConfig ( void *  pDataParams,
uint16_t  wConfig,
uint16_t pValue 
)

Perform a GetConfig command.

wConfig can be one of:

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_PROTOCOL_ERRORInvalid response received.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layers parameter structure.
[in]wConfig[In] Configuration Identifier.
[out]pValue[Out] Configuration Value.