NXP Reader Library  v17.1.0.2535
Component : Callback

Callback Reader HAL. More...

Collaboration diagram for Component : Callback:

Data Structures

struct  phhalHw_Callback_DataParams_t
 Callback HAL parameter structure. More...
 

Macros

#define PHHAL_HW_CALLBACK_ID   0xAB
 ID for Rc523 HAL component.
 

Typedefs

typedef phStatus_t(* cbExchange) (uint16_t wOption, uint8_t *pTxBuffer, uint16_t wTxLength, uint8_t **ppRxBuffer, uint16_t *pRxLength, void *pContext)
 Callback Delegate for phhalHw_Exchange.
 
typedef phStatus_t(* cbWriteRegister) (uint8_t bAddress, uint8_t bValue, void *pContext)
 Callback Delegate for phhalHw_WriteRegister.
 
typedef phStatus_t(* cbReadRegister) (uint8_t bAddress, uint8_t *pValue, void *pContext)
 Callback Delegate for phhalHw_ReadRegister.
 
typedef phStatus_t(* cbApplyProtocolSettings) (uint8_t bCardType, void *pContext)
 Callback Delegate for phhalHw_ApplyProtocolSettings.
 
typedef phStatus_t(* cbMfcAuthenticate) (uint8_t bBlockNo, uint8_t bKeyType, uint16_t wKeyNo, uint16_t wKeyVersion, uint8_t *pUid, void *pContext)
 Callback Delegate for phhalHw_MfcAuthenticate.
 
typedef phStatus_t(* cbMfcAuthenticateKey) (uint8_t bBlockNo, uint8_t bKeyType, uint8_t *pKey, uint8_t *pUid, void *pContext)
 Callback Delegate for phhalHw_MfcAuthenticateKeyNo.
 
typedef phStatus_t(* cbSetConfig) (uint16_t wConfig, uint16_t wValue, void *pContext)
 Callback Delegate for phhalHw_SetConfig.
 
typedef phStatus_t(* cbGetConfig) (uint16_t wConfig, uint16_t *pValue, void *pContext)
 Callback Delegate for phhalHw_GetConfig.
 
typedef phStatus_t(* cbFieldOn) (void *pContext)
 Callback Delegate for phhalHw_FieldOn.
 
typedef phStatus_t(* cbFieldOff) (void *pContext)
 Callback Delegate for phhalHw_FieldOff.
 
typedef phStatus_t(* cbFieldReset) (void *pContext)
 Callback Delegate for phhalHw_FieldReset.
 
typedef phStatus_t(* cbWait) (uint8_t bUnit, uint16_t wTimeout, void *pContext)
 Callback Delegate for phhalHw_Wait.
 

Functions

phStatus_t phhalHw_Callback_Init (phhalHw_Callback_DataParams_t *pDataParams, uint16_t wSizeOfDataParams, cbExchange pExchangeCb, cbWriteRegister pWriteRegisterCb, cbReadRegister pReadRegisterCb, cbApplyProtocolSettings pApplyProtocolSettingsCb, cbMfcAuthenticate pMfcAuthenticateCb, cbMfcAuthenticateKey pMfcAuthenticateKeyCb, cbSetConfig pSetConfigCb, cbGetConfig pGetConfigCb, cbFieldOn pFieldOnCb, cbFieldOff pFieldOffCb, cbFieldReset pFieldResetCb, cbWait pWaitCb, void *pCallbackContext)
 Initialise the HAL component. More...
 

Detailed Description

Callback Reader HAL.

Virtual reader device which can be used to implement custom reader devices.

Function Documentation

◆ phhalHw_Callback_Init()

phStatus_t phhalHw_Callback_Init ( phhalHw_Callback_DataParams_t pDataParams,
uint16_t  wSizeOfDataParams,
cbExchange  pExchangeCb,
cbWriteRegister  pWriteRegisterCb,
cbReadRegister  pReadRegisterCb,
cbApplyProtocolSettings  pApplyProtocolSettingsCb,
cbMfcAuthenticate  pMfcAuthenticateCb,
cbMfcAuthenticateKey  pMfcAuthenticateKeyCb,
cbSetConfig  pSetConfigCb,
cbGetConfig  pGetConfigCb,
cbFieldOn  pFieldOnCb,
cbFieldOff  pFieldOffCb,
cbFieldReset  pFieldResetCb,
cbWait  pWaitCb,
void *  pCallbackContext 
)

Initialise the HAL component.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wSizeOfDataParams[In] Specifies the size of the data parameter structure.
[in]pExchangeCb[In] Pointer to cbExchange Callback.
[in]pWriteRegisterCb[In] Pointer to cbWriteRegister Callback.
[in]pReadRegisterCb[In] Pointer to cbReadRegister Callback.
[in]pApplyProtocolSettingsCb[In] Pointer to cbApplyProtocolSettings Callback.
[in]pMfcAuthenticateCb[In] Pointer to cbMfcAuthenticate Callback.
[in]pMfcAuthenticateKeyCb[In] Pointer to cbMfcAuthenticateKey Callback.
[in]pSetConfigCb[In] Pointer to cbSetConfig Callback.
[in]pGetConfigCb[In] Pointer to cbGetConfig Callback.
[in]pFieldOnCb[In] Pointer to cbFieldOn Callback.
[in]pFieldOffCb[In] Pointer to cbFieldOff Callback.
[in]pFieldResetCb[In] Pointer to cbFieldReset Callback.
[in]pWaitCb[In] Pointer to cbWait Callback.
[in]pCallbackContext[In] Custom context which is passed back to each Callback.