Supported Reader commands. More...

Collaboration diagram for Commands:

Functions
phStatus_t	phhalHw_Rd710_Cmd_InitReader (phhalHw_Rd710_DataParams_t *pDataParams)
	The function starts the reader in direct PCSC mode and initializes the following stack components: HAL, I14443P3A, I14443P4A, I14443P4, MIFARE, CID and KEYSTORE. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_LedOff (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t bLeds)
	The function turns-off the LEDs of the reader device. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_LedOn (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t bLeds)
	The function turns-on the LEDs of the reader device. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_ResetReader (phhalHw_Rd710_DataParams_t *pDataParams)
	The function resets the reader IC. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_ResetFactoryDefaults (phhalHw_Rd710_DataParams_t *pDataParams)
	The function overwrites the current user configuration with factory defaults. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_SetConfigOption (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pConfig, uint8_t *pData, uint16_t wDataLength)
	The function writes data for a configuration option in the NVM of the reader. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_GetConfigOption (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pConfig, uint8_t pData, uint16_t pDataLength)
	The function reads a configuration option from the reader's NVM. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_GetReaderStatus (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pReaderStatus)
	The function outputs the current reader status. More...

phStatus_t	phhalHw_Rd710_Cmd_RD_SetPcscMode (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t Mode)
	The function sets the reader PCSC mode to standard or direct. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_Activate (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pAtr, uint16_t *pAtrLen)
	The function performs contact card activation procedure according to ISO7816-3 and when successful outputs the returned ATR. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_ColdReset (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pAtr, uint16_t *pAtrLen)
	The function performs contact card cold reset. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_WarmReset (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pAtr, uint16_t *pAtrLen)
	The function performs contact card warm reset. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_StopClock (phhalHw_Rd710_DataParams_t *pDataParams)
	The function stops the clock of the contact card interface. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_StartClock (phhalHw_Rd710_DataParams_t *pDataParams)
	The function starts the clock pulse of the contact card interface. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_Deactivate (phhalHw_Rd710_DataParams_t *pDataParams)
	The function deactivates the card connected to the contact inteface. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_PresenceCheck (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pCardInserted)
	The function checks if a card is present at the contact inteface. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_TransmitData (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function transmits data with the indicated length to a contact card. More...

phStatus_t	phhalHw_Rd710_Cmd_CC_SendPPS (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bOption, uint8_t pPPS, uint8_t *pRxBuffer)
	The function performs protocol and parameter exchange(PPS) with a contact card according to ISO7816-3. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_FormatKeyEntry (phhalHw_Rd710_DataParams_t *pDataParams, uint16_t wKeyNo, uint16_t wNewKeyType)
	The function resets to 0 all key versions and their corresponding key values for the indicated key wKeyNo. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetKey (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wKeyType, uint16_t wKeyNo, uint16_t wKeyVersion, uint16_t wNewKeyVersion, uint16_t wNewKeyLen, uint8_t pNewKey)
	The function initializes a new version of the indicated wKeyNo, having key type wKeyType. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetKeyAtPos (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wKeyType, uint16_t wKeyNo, uint16_t wNewKeyVersion, uint16_t wPos, uint16_t wKeyLen, uint8_t pNewKey)
	The function initializes a new version of the indicated wKeyNo, having key type wKeyType. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetKUC (phhalHw_Rd710_DataParams_t *pDataParams, uint16_t wKeyNo, uint16_t wRefNoKUC)
	The function changes the key usage counter(KUC) pertaing to a key number wKeyNo to the specified value wRefNoKUC. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetFullKeyEntry (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wNoOfKeys, uint16_t wNewKeyType, uint16_t wKeyNo, uint16_t wNewRefNoKUC, uint16_t wSingleKeyLen, uint8_t pNewKeys, uint16_t *pNewKeyVersionList)
	The function initializes all key versions and the corresponding key data for the indicated key wKeyNo. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_GetKeyEntry (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wKeyVersionBufSize, uint16_t wKeyVersion, uint16_t wKeyVersionLength, uint16_t pKeyType)
	The function retrieves the key type and the available key versions of the indicated key. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_GetKey (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wKeyVersion, uint8_t bKeyBufSize, uint8_t pKey, uint16_t *pKeyType)
	The function retrieves the key type and the available key versions of the indicated key. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetConfig (phhalHw_Rd710_DataParams_t *pDataParams, uint16_t wConfig, uint16_t wValue)
	This function is void. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_SetConfigStr (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wConfig, uint8_t pBuffer, uint16_t wBufferLength)
	This function is not implemented in P2 FW v100. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_GetConfig (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wConfig, uint16_t pValue)
	This function is not implemented in P2 FW v100. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_GetConfigStr (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wConfig, uint8_t ppBuffer, uint16_t pBufferLength)
	This function is void. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_ChangeKUC (phhalHw_Rd710_DataParams_t *pDataParams, uint16_t wRefNoKUC, uint32_t dwLimit)
	The function initalizes the indicated key usage counter(KUC) with a limit value dwLimit. More...

phStatus_t	phhalHw_Rd710_Cmd_KS_GetKUC (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wRefNoKUC, uint32_t pdwLimit, uint32_t *pdwCurVal)
	The function retrieves the indicated key usage counter(KUC) and stores its limit and current values at the indicated dwLimit and pdwCurVal respectively. More...

phStatus_t	phhalHw_Rd710_Cmd_CID_GetFreeCid (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pCid)
	The function returns a free CID for communication with ISO14443-4 card. More...

phStatus_t	phhalHw_Rd710_Cmd_CID_FreeCid (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t bCid)
	The function frees the indicated CID. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_SetProtocol (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t bCidEnable, uint8_t bCid, uint8_t bNadEnable, uint8_t bNad, uint8_t bFwi, uint8_t bFsdi, uint8_t bFsci)
	The function intializes the ISO14443-4 protocol parameters. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_ResetProtocol (phhalHw_Rd710_DataParams_t *pDataParams)
	The function resets the ISO14443-4 protocol parameters. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_Deselect (phhalHw_Rd710_DataParams_t *pDataParams)
	The function executes DESELECT command in S-Block PCB in order to deactivate a PICC according to ISO14443-4 specification. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_PresCheck (phhalHw_Rd710_DataParams_t *pDataParams)
	The function performs presence check for current PICC through R(NAK) polling. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_Exchange (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function performs ISO14443-4 data exchange with PICC. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_SetConfig (phhalHw_Rd710_DataParams_t *pDataParams, uint16_t wConfig, uint16_t wValue)
	The function sets a configuration parameter to a indicated value. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4_GetConfig (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wConfig, uint16_t pValue)
	The function retrieves a configuration parameter.The configuration parameter can have following identiferes: More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4A_Rats (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bFsdi, uint8_t bCid, uint8_t pAts)
	The function performs the "Request Answer to Select" command according to ISO14443-4A. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4A_Pps (phhalHw_Rd710_DataParams_t *pDataParams, uint8_t bDri, uint8_t bDsi)
	The function performs the "Protocol and Parameter Selection" procedure according to ISO14443-4A. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4A_ActivateCard (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bFsdi, uint8_t bCid, uint8_t bDri, uint8_t bDsi, uint8_t pAts)
	The function performs ISO14443-4A RATS and PPS commands. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P4A_GetProtocolParams (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pCidEnabled, uint8_t pCid, uint8_t pNadSupported, uint8_t pFwi, uint8_t pFsdi, uint8_t *pFsci)
	The function retrieves the ISO14443-4A protocol parameters. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_RequestA (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pAtqa)
	The function performs the "Request" command according to ISO14443-3A. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_WakeUpA (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pAtqa)
	The function performs the "Wakeup" command according to ISO14443-3A. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_HaltA (phhalHw_Rd710_DataParams_t *pDataParams)
	The function performs the ISO14443-3A "Halt" command. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_Anticollision (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bCascadeLevel, uint8_t pUidIn, uint8_t bNvbUidIn, uint8_t pUidOut, uint8_t pNvbUidOut)
	The function perform a ISO14443-3A Anticollision or Select command. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_Select (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bCascadeLevel, uint8_t pUidIn, uint8_t *pSak)
	The function performs a ISO14443-3A "Select" command. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_ActivateCard (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pUidIn, uint8_t bLenUidIn, uint8_t pUidOut, uint8_t pLenUidOut, uint8_t pSak, uint8_t pMoreCardsAvailable)
	The function performs ISO14443-3A "ReqA" or "WupA" and "Anticollision"/"Select" commands for all cascade levels. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_Exchange (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function performs data exchange with PICC according to ISO14443-3A. More...

phStatus_t	phhalHw_Rd710_Cmd_I14443P3A_GetSerialNo (phhalHw_Rd710_DataParams_t pDataParams, uint8_t pRxBuffer, uint8_t *pRxLength)
	The function petrieves the serial number of the indicated PICC. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_ExchangeL3 (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function performs ISO14443-3 data exchange with MIFARE PICC. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_ExchangeL4 (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function performs ISO14443-4 data exchange with MIFARE PICC. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_ExchangePc (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t *ppRxBuffer, uint16_t pRxLength)
	The function performs proximity-check data exchange with MIFARE Picc. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_ExchangeRaw (phhalHw_Rd710_DataParams_t pDataParams, uint16_t wOption, uint8_t pTxBuffer, uint16_t wTxLength, uint8_t bTxLastBits, uint8_t *ppRxBuffer, uint16_t pRxLength, uint8_t *pRxLastBits)
	The function performs raw data exchange with MIFARE PICC. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticateKeyNo (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bBlockNo, uint8_t bKeyType, uint16_t wKeyNo, uint16_t wKeyVersion, uint8_t pUid)
	The function performs MIFARE "Authenticate" command with PICC using a key number. More...

phStatus_t	phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticate (phhalHw_Rd710_DataParams_t pDataParams, uint8_t bBlockNo, uint8_t bKeyType, uint8_t pKey, uint8_t *pUid)
	The function performs MIFARE "Authenticate" command with PICC using a key. More...

Detailed Description

Supported Reader commands.

Function Documentation

◆ phhalHw_Rd710_Cmd_InitReader()

phStatus_t phhalHw_Rd710_Cmd_InitReader ( phhalHw_Rd710_DataParams_t * pDataParams )

The function starts the reader in direct PCSC mode and initializes the following stack components: HAL, I14443P3A, I14443P4A, I14443P4, MIFARE, CID and KEYSTORE.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_RD_LedOff()

phStatus_t phhalHw_Rd710_Cmd_RD_LedOff	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bLeds
	)

The function turns-off the LEDs of the reader device.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	bLeds	[In] Bitmap of the LEDs to be swichted OFF, 1=switch-off, 0=don't change.

◆ phhalHw_Rd710_Cmd_RD_LedOn()

phStatus_t phhalHw_Rd710_Cmd_RD_LedOn	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bLeds
	)

The function turns-on the LEDs of the reader device.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	bLeds	[In] Bitmap of the LEDs to be swichted ON, 1=switch-on, 0=don't change.

◆ phhalHw_Rd710_Cmd_RD_ResetReader()

phStatus_t phhalHw_Rd710_Cmd_RD_ResetReader ( phhalHw_Rd710_DataParams_t * pDataParams )

The function resets the reader IC.

Return values

PH_ERR_SUCCESS Command successfully executed.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_RD_ResetFactoryDefaults()

phStatus_t phhalHw_Rd710_Cmd_RD_ResetFactoryDefaults ( phhalHw_Rd710_DataParams_t * pDataParams )

The function overwrites the current user configuration with factory defaults.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_RD_SetConfigOption()

phStatus_t phhalHw_Rd710_Cmd_RD_SetConfigOption	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pConfig,
		uint8_t *	pData,
		uint16_t	wDataLength
	)

The function writes data for a configuration option in the NVM of the reader.

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	pConfig	[In] Pointer to a 4-byte buffer holding the ID of a configuration option.
[in]	pData	[In] Pointer to buffer holding the configuration data that shall be written.
[in]	wDataLength	[In] Length of the configuration data

◆ phhalHw_Rd710_Cmd_RD_GetConfigOption()

phStatus_t phhalHw_Rd710_Cmd_RD_GetConfigOption	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pConfig,
		uint8_t *	pData,
		uint16_t *	pDataLength
	)

The function reads a configuration option from the reader's NVM.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	pConfig	[In] Pointer to a 4-byte buffer holding the ID of a configuration option.
[out]	pData	[Out] Pointer to buffer holding the read-out data corresponding to the configuration ID.
[out]	pDataLength	[Out] Length of the read configuration data.

◆ phhalHw_Rd710_Cmd_RD_GetReaderStatus()

phStatus_t phhalHw_Rd710_Cmd_RD_GetReaderStatus	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pReaderStatus
	)

The function outputs the current reader status.

The first byte in the reader response buffer is type of the reader chip, the second byte is the current state of DIP switches.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pReaderStatus	[Out] Pointer to a buffer holding the reader response.

◆ phhalHw_Rd710_Cmd_RD_SetPcscMode()

phStatus_t phhalHw_Rd710_Cmd_RD_SetPcscMode	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	Mode
	)

The function sets the reader PCSC mode to standard or direct.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	Mode	[In] The PCSC mode to be set: 0 for standard or 1 for direct.

◆ phhalHw_Rd710_Cmd_CC_Activate()

phStatus_t phhalHw_Rd710_Cmd_CC_Activate	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pAtr,
		uint16_t *	pAtrLen
	)

The function performs contact card activation procedure according to ISO7816-3 and when successful outputs the returned ATR.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pAtr	[Out] Pointer to a buffer holding the returned ATR string from the contact card.
[out]	pAtrLen	[Out] Pointer to a buffer where the length of the returned ATR string shall be saved.

◆ phhalHw_Rd710_Cmd_CC_ColdReset()

phStatus_t phhalHw_Rd710_Cmd_CC_ColdReset	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pAtr,
		uint16_t *	pAtrLen
	)

The function performs contact card cold reset.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pAtr	[Out] Pointer to a buffer holding the returned ATR string from the contact card.
[out]	pAtrLen	[Out] Pointer to a buffer where the length of the returned ATR string shall be saved.

◆ phhalHw_Rd710_Cmd_CC_WarmReset()

phStatus_t phhalHw_Rd710_Cmd_CC_WarmReset	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pAtr,
		uint16_t *	pAtrLen
	)

The function performs contact card warm reset.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pAtr	[Out] Pointer to a buffer holding the returned ATR string from the contact card.
[out]	pAtrLen	[Out] Pointer to a buffer where the length of the returned ATR string shall be saved.

◆ phhalHw_Rd710_Cmd_CC_StopClock()

phStatus_t phhalHw_Rd710_Cmd_CC_StopClock ( phhalHw_Rd710_DataParams_t * pDataParams )

The function stops the clock of the contact card interface.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_CC_StartClock()

phStatus_t phhalHw_Rd710_Cmd_CC_StartClock ( phhalHw_Rd710_DataParams_t * pDataParams )

The function starts the clock pulse of the contact card interface.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_CC_Deactivate()

phStatus_t phhalHw_Rd710_Cmd_CC_Deactivate ( phhalHw_Rd710_DataParams_t * pDataParams )

The function deactivates the card connected to the contact inteface.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_Rd710_Cmd_CC_PresenceCheck()

phStatus_t phhalHw_Rd710_Cmd_CC_PresenceCheck	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pCardInserted
	)

The function checks if a card is present at the contact inteface.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pCardInserted	[Out] Pointer to a byte variable indicating if a card is present(0x01) or not present(0x00).

◆ phhalHw_Rd710_Cmd_CC_TransmitData()

phStatus_t phhalHw_Rd710_Cmd_CC_TransmitData	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function transmits data with the indicated length to a contact card.

The response data and its length is stored at the pointed addresses.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	pTxBuffer	[In] Pointer to a buffer with data to be transmitted over the contact interface.
[in]	wTxLength	[In] Length of the transmit data.
[out]	ppRxBuffer	[Out] Pointer to pointer to a buffer where the received data from the contact card shall be stored.
[out]	pRxLength	[Out] Pointer to a buffer where the received data length shall be stored.

◆ phhalHw_Rd710_Cmd_CC_SendPPS()

phStatus_t phhalHw_Rd710_Cmd_CC_SendPPS	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bOption,
		uint8_t *	pPPS,
		uint8_t *	pRxBuffer
	)

The function performs protocol and parameter exchange(PPS) with a contact card according to ISO7816-3.

Note that the PPSS identifier byte, having value 0xff is not included in the pPPS buffer. The first byte in the pPPS buffer, i.e. pPPS[0] is PPS0. In case of set exchange speed bOption=0x01, the first byte in the pPPS buffer, i.e. pPPS[0] indicates the transmission factors Fi[b7-b4],Di[b3-b0]. Supported are the following values:

0x12, etu=186
0x13, etu=93
0x18, etu=31 speed 145.161 bit/s
0x95, etu=32
0x96, etu=16 - speed 281.250 bit/s

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	bOption	[in] 0x00=Perform PPS, 0x01=Set only the exchange speed.
[in]	pPPS	[In] Pointer to a buffer holding valid PPS exchange data. The presence of the optional bytes, respectively the length the PPS message is indicated by pPPS[0]
[out]	pRxBuffer	[Out] Pointer to a buffer where the received data from the contact card shall be stored.

◆ phhalHw_Rd710_Cmd_KS_FormatKeyEntry()

phStatus_t phhalHw_Rd710_Cmd_KS_FormatKeyEntry	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wNewKeyType
	)

The function resets to 0 all key versions and their corresponding key values for the indicated key wKeyNo.

The key type, which is valid for all key versions of wKeyNo is initialized through this function to the specified wNewKeyType.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	The key number wKeyNo is beyond the available or wNewKeyType is not among the predefined types.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be formated [0-15].
[in]	wNewKeyType	[In] Key type of the key (predefined type).

◆ phhalHw_Rd710_Cmd_KS_SetKey()

phStatus_t phhalHw_Rd710_Cmd_KS_SetKey	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyType,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersion,
		uint16_t	wNewKeyVersion,
		uint16_t	wNewKeyLen,
		uint8_t *	pNewKey
	)

The function initializes a new version of the indicated wKeyNo, having key type wKeyType.

Note that the key type is not set here, but this done by the phhalHw_Rd710_Cmd_KS_FormatKeyEntry function. All key versions of wKeyNo are searched for the indicated wKeyVersion and when found it gets overwritten together with its key data by the new version and data.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Key type wKeyType mismatches with current key type for the indicated wKeyNo.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyType	[In] Key type of the key which has to be initialized.
[in]	wKeyNo	[In] Key number of the key, which has to be initialized [0-15].
[in]	wKeyVersion	[In] Key version of the key, which has to be initialized.
[in]	wNewKeyVersion	[In] New key version for the indicated key number
[in]	wNewKeyLen	[In] Length of the new key
[in]	pNewKey	[In] Pointer to a buffer holding the new key data for the indicated key number and version.

◆ phhalHw_Rd710_Cmd_KS_SetKeyAtPos()

phStatus_t phhalHw_Rd710_Cmd_KS_SetKeyAtPos	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyType,
		uint16_t	wKeyNo,
		uint16_t	wNewKeyVersion,
		uint16_t	wPos,
		uint16_t	wKeyLen,
		uint8_t *	pNewKey
	)

The function initializes a new version of the indicated wKeyNo, having key type wKeyType.

Note that the key type is not set here, but this is done by the phhalHw_Rd710_Cmd_KS_FormatKeyEntry function. The key version at position wPos gets overwritten togther with its key data by the new version and data.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Key type wKeyType mismatches with current key type for the indicated wKeyNo.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyType	[In] Key type of the key, which has to be initialized.
[in]	wKeyNo	[In] Key number of the key, which has to be initialized [0-15].
[in]	wNewKeyVersion	[In] New key version for the indicated key number
[in]	wPos	[In] Position of the key version for the indicated key
[in]	wKeyLen	[In] Length of the new key data.
[in]	pNewKey	[In] Pointer to a buffer holding the new key data for the indicated key number and version.

◆ phhalHw_Rd710_Cmd_KS_SetKUC()

phStatus_t phhalHw_Rd710_Cmd_KS_SetKUC	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wRefNoKUC
	)

The function changes the key usage counter(KUC) pertaing to a key number wKeyNo to the specified value wRefNoKUC.

The current KUC gets overwritten with the indicated value.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Invalid KUC entry
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be [0-15].
[in]	wRefNoKUC	[In] Key usage counter(KUC) value for the indicated key wKeyNo

◆ phhalHw_Rd710_Cmd_KS_SetFullKeyEntry()

phStatus_t phhalHw_Rd710_Cmd_KS_SetFullKeyEntry	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wNoOfKeys,
		uint16_t	wNewKeyType,
		uint16_t	wKeyNo,
		uint16_t	wNewRefNoKUC,
		uint16_t	wSingleKeyLen,
		uint8_t *	pNewKeys,
		uint16_t *	pNewKeyVersionList
	)

The function initializes all key versions and the corresponding key data for the indicated key wKeyNo.

The key usage couter(KUC) and the key type are set equal to the specified values.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Key type wNewKeyType is not among the specified or invalid wKeyNo ,wNoOfKeys.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wNoOfKeys	[In] Number of keys versions in pNewKeys buffer.
[in]	wNewKeyType	[In] Key type to be initialized
[in]	wKeyNo	[In] Key number of the key to be initialized.
[in]	wNewRefNoKUC	[In] Key usage counter(KUC) value for the indicated key.
[in]	wSingleKeyLen	[In] Length of a single key
[in]	pNewKeys	[In] Pointer to array of key entries to load. The order of the key-data entriey corresponds to the order of the version numbers in pNewKeyVersionList.
[in]	pNewKeyVersionList	[In] Pointer to key version list of the key to be loaded.

◆ phhalHw_Rd710_Cmd_KS_GetKeyEntry()

phStatus_t phhalHw_Rd710_Cmd_KS_GetKeyEntry	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersionBufSize,
		uint16_t *	wKeyVersion,
		uint16_t *	wKeyVersionLength,
		uint16_t *	pKeyType
	)

The function retrieves the key type and the available key versions of the indicated key.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Key version buffer size wKeyVersionBufSize is smaller than the received data wKeyVersionLength.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, whose version data is retrieved.
[in]	wKeyVersionBufSize	[In] Size of the key versions buffer wKeyVersion.
[out]	wKeyVersion	[Out] Pointer to a byffer where the key versions shall be stored.
[out]	wKeyVersionLength	[Out] Pointer to a variable holding the number of the retrieved key versions.
[out]	pKeyType	[Out] Pointer to a variable that shall store the key type of the retrived key.

◆ phhalHw_Rd710_Cmd_KS_GetKey()

phStatus_t phhalHw_Rd710_Cmd_KS_GetKey	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersion,
		uint8_t	bKeyBufSize,
		uint8_t *	pKey,
		uint16_t *	pKeyType
	)

The function retrieves the key type and the available key versions of the indicated key.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Key buffer size bKeyBufSize is smaller than the received key data.
PH_ERR_INVALID_PARAMETER	The buffer size bKeyBufSize is not enough to receive all key data of the specified type.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key whose data is retrieved.
[in]	wKeyVersion	[In] Key version of the key which has to be retrieved.
[in]	bKeyBufSize	[In] Size of the key buffer pKey.
[out]	pKey	[Out] Pointer to a buffer receiving the key data for the indicated key number and version.
[out]	pKeyType	[Out] Pointer to a variable that shall store the key type of the retrived key.

◆ phhalHw_Rd710_Cmd_KS_SetConfig()

phStatus_t phhalHw_Rd710_Cmd_KS_SetConfig	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t	wValue
	)

This function is void.

Returns: Status code

Return values

PH_ERR_UNSUPPORTED_PARAMETER Always

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Dummy
[in]	wValue	[In] Dummy

◆ phhalHw_Rd710_Cmd_KS_SetConfigStr()

phStatus_t phhalHw_Rd710_Cmd_KS_SetConfigStr	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint8_t *	pBuffer,
		uint16_t	wBufferLength
	)

This function is not implemented in P2 FW v100.

Returns: Status code

Return values

PH_ERR_UNSUPPORTED_PARAMETER Always

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Dummy
[in]	pBuffer	[In] Dummy
[in]	wBufferLength	[In] Dummy

◆ phhalHw_Rd710_Cmd_KS_GetConfig()

phStatus_t phhalHw_Rd710_Cmd_KS_GetConfig	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t *	pValue
	)

This function is not implemented in P2 FW v100.

Returns: Status code

Return values

PH_ERR_UNSUPPORTED_PARAMETER Always

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Confog Id
[in]	pValue	[In] Value

◆ phhalHw_Rd710_Cmd_KS_GetConfigStr()

phStatus_t phhalHw_Rd710_Cmd_KS_GetConfigStr	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint8_t **	ppBuffer,
		uint16_t *	pBufferLength
	)

This function is void.

Returns: Status code

Return values

PH_ERR_UNSUPPORTED_PARAMETER Always

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Dummy
[in]	ppBuffer	[In] Dummy
[in]	pBufferLength	[In] Dummy

◆ phhalHw_Rd710_Cmd_KS_ChangeKUC()

phStatus_t phhalHw_Rd710_Cmd_KS_ChangeKUC	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t	dwLimit
	)

The function initalizes the indicated key usage counter(KUC) with a limit value dwLimit.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	The indicated key usage counter number is beyond the limits of the available KUCs.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wRefNoKUC	[In] Reference number of the key usage counter.
[in]	dwLimit	[In] Limit of the key usage counter(KUC).

◆ phhalHw_Rd710_Cmd_KS_GetKUC()

phStatus_t phhalHw_Rd710_Cmd_KS_GetKUC	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t *	pdwLimit,
		uint32_t *	pdwCurVal
	)

The function retrieves the indicated key usage counter(KUC) and stores its limit and current values at the indicated dwLimit and pdwCurVal respectively.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	The indicate key usage counter number is beyond the limits of the available KUCs.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wRefNoKUC	[In] Reference number of the key usage counter.
[out]	pdwLimit	[Out] Pointer to received limit of key usage counter.
[out]	pdwCurVal	[Out] Pointer to received current key usage counter.

◆ phhalHw_Rd710_Cmd_CID_GetFreeCid()

phStatus_t phhalHw_Rd710_Cmd_CID_GetFreeCid	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pCid
	)

The function returns a free CID for communication with ISO14443-4 card.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[out]	pCid	[Out] Pointer to a byte variable where the returned CID value shall be stored.

◆ phhalHw_Rd710_Cmd_CID_FreeCid()

phStatus_t phhalHw_Rd710_Cmd_CID_FreeCid	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bCid
	)

The function frees the indicated CID.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	bCid	[In] CID to be disposed.

◆ phhalHw_Rd710_Cmd_I14443P4_SetProtocol()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_SetProtocol	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bCidEnable,
		uint8_t	bCid,
		uint8_t	bNadEnable,
		uint8_t	bNad,
		uint8_t	bFwi,
		uint8_t	bFsdi,
		uint8_t	bFsci
	)

The function intializes the ISO14443-4 protocol parameters.

It is recommended to input this function with the parameters retrieved from either phpalI14443p4a_GetProtocolParams or phpalI14443p3b_GetProtocolParams after card activation. Note: Refer to the ISO/IEC 14443-4:2008(E) specification for a detailed description of the parameters.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCidEnable	[In] CID is enabled if not equal to 0, otherwise it is disabled.
[in]	bCid	[In] Card identifier(CID). Ignored if bCidEnable is equal to '0'.
[in]	bNadEnable	[In] NAD is enabled if not equal to 0, otherwise it is disabled.
[in]	bNad	[In] Node addrss(NAD). Ignored if bNadEnabled is equal 0.
[in]	bFwi	[In] Frame waiting time integer.
[in]	bFsdi	[In] PCD Frame size PCD integer; 0-8
[in]	bFsci	[In] PICC Frame size PICC integer; 0-8

◆ phhalHw_Rd710_Cmd_I14443P4_ResetProtocol()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_ResetProtocol ( phhalHw_Rd710_DataParams_t * pDataParams )

The function resets the ISO14443-4 protocol parameters.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

◆ phhalHw_Rd710_Cmd_I14443P4_Deselect()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_Deselect ( phhalHw_Rd710_DataParams_t * pDataParams )

The function executes DESELECT command in S-Block PCB in order to deactivate a PICC according to ISO14443-4 specification.

The function can also be applied for transmission and protocol error recovery.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

◆ phhalHw_Rd710_Cmd_I14443P4_PresCheck()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_PresCheck ( phhalHw_Rd710_DataParams_t * pDataParams )

The function performs presence check for current PICC through R(NAK) polling.

It forces the PICC to response with R(ACK) and consecutive last I-block retransmission, as defined in ISO 14443-4:2008(E) scenario 6.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

◆ phhalHw_Rd710_Cmd_I14443P4_Exchange()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_Exchange	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function performs ISO14443-4 data exchange with PICC.

wOption can be one of:

wOption can be combined with:

PH_EXCHANGE_BUFFERED_BIT

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer with transmit data.
[in]	wTxLength	[In] Length of transmit data.
[out]	ppRxBuffer	[Out] Pointer to pointer of buffer holding the received data.
[out]	pRxLength	[Out] Number of received data bytes.

◆ phhalHw_Rd710_Cmd_I14443P4_SetConfig()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_SetConfig	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t	wValue
	)

The function sets a configuration parameter to a indicated value.

The configuration parameter can have following identiferes:

PHPAL_I14443P4_PARAM_BLOCKNO 0x0000
PHPAL_I14443P4_PARAM_CID 0x0001
PHPAL_I14443P4_PARAM_NAD 0x0002
PHPAL_I14443P4_PARAM_FWI 0x0003
PHPAL_I14443P4_PARAM_FSI 0x0004
PHPAL_I14443P4_PARAM_MAXRETRYCOUNT 0x0005

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Invalid CID or ivalid FWI or invalid FSI or invalid configuration identifier.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wConfig	[In] Configuration identifier
[in]	wValue	[In] Configuration value

◆ phhalHw_Rd710_Cmd_I14443P4_GetConfig()

phStatus_t phhalHw_Rd710_Cmd_I14443P4_GetConfig	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t *	pValue
	)

The function retrieves a configuration parameter.The configuration parameter can have following identiferes:

PHPAL_I14443P4_PARAM_BLOCKNO 0x0000
PHPAL_I14443P4_PARAM_CID 0x0001
PHPAL_I14443P4_PARAM_NAD 0x0002
PHPAL_I14443P4_PARAM_FWI 0x0003
PHPAL_I14443P4_PARAM_FSI 0x0004
PHPAL_I14443P4_PARAM_MAXRETRYCOUNT 0x0005

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_INVALID_PARAMETER	Invalid configuration identifier.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wConfig	[In] Configuration identifier
[out]	pValue	[Out] Pointer to a variable where the configuration value shall be stored.

◆ phhalHw_Rd710_Cmd_I14443P4A_Rats()

phStatus_t phhalHw_Rd710_Cmd_I14443P4A_Rats	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bFsdi,
		uint8_t	bCid,
		uint8_t *	pAts
	)

The function performs the "Request Answer to Select" command according to ISO14443-4A.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bFsdi	[In] Frame Size Integer, 0-8
[in]	bCid	[In] Card Identifier, 0-14
[out]	pAts	[Out]Pointer to a buffer that shall store the received ATS.

◆ phhalHw_Rd710_Cmd_I14443P4A_Pps()

phStatus_t phhalHw_Rd710_Cmd_I14443P4A_Pps	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bDri,
		uint8_t	bDsi
	)

The function performs the "Protocol and Parameter Selection" procedure according to ISO14443-4A.

The following values for bDri and bDsi are possible:

PHPAL_I14443P4A_DATARATE_106
PHPAL_I14443P4A_DATARATE_212
PHPAL_I14443P4A_DATARATE_424

PHPAL_I14443P4A_DATARATE_848

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bDri	[In] Divisor Receive (PCD to PICC) Integer; 0-3
[in]	bDsi	[In] Divisor Send (PICC to PCD) Integer; 0-3

◆ phhalHw_Rd710_Cmd_I14443P4A_ActivateCard()

phStatus_t phhalHw_Rd710_Cmd_I14443P4A_ActivateCard	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bFsdi,
		uint8_t	bCid,
		uint8_t	bDri,
		uint8_t	bDsi,
		uint8_t *	pAts
	)

The function performs ISO14443-4A RATS and PPS commands.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bFsdi	[In] Frame Size Integer, 0-8
[in]	bCid	[In] Card Identifier, 0-14
[in]	bDri	[In] Divisor receive PCD to PICC integer, 0-3
[in]	bDsi	[In] Divisor send PICC to PCD integer, 0-3
[out]	pAts	[Out]Pointer to a buffer storing the received ATS.

◆ phhalHw_Rd710_Cmd_I14443P4A_GetProtocolParams()

phStatus_t phhalHw_Rd710_Cmd_I14443P4A_GetProtocolParams	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pCidEnabled,
		uint8_t *	pCid,
		uint8_t *	pNadSupported,
		uint8_t *	pFwi,
		uint8_t *	pFsdi,
		uint8_t *	pFsci
	)

The function retrieves the ISO14443-4A protocol parameters.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	pCidEnabled	[Out] Pointer to storage for CID enabled variable.
[out]	pCid	[Out] Pointer to storage for CID.
[out]	pNadSupported	[Out] Pointer to storage for NAD enabled variable.
[out]	pFwi	[Out] Pointer to storage for FWI.
[out]	pFsdi	[Out] Pointer to a storage for FSDI.
[out]	pFsci	[Out] Pointer to a storage for FSCI.

◆ phhalHw_Rd710_Cmd_I14443P3A_RequestA()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_RequestA	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pAtqa
	)

The function performs the "Request" command according to ISO14443-3A.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	pAtqa	[Out]Pointer to a buffer storing the received ATS.

◆ phhalHw_Rd710_Cmd_I14443P3A_WakeUpA()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_WakeUpA	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pAtqa
	)

The function performs the "Wakeup" command according to ISO14443-3A.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	pAtqa	[Out] Pointer to a buffer storing the AtqA.

◆ phhalHw_Rd710_Cmd_I14443P3A_HaltA()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_HaltA ( phhalHw_Rd710_DataParams_t * pDataParams )

The function performs the ISO14443-3A "Halt" command.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

◆ phhalHw_Rd710_Cmd_I14443P3A_Anticollision()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_Anticollision	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bCascadeLevel,
		uint8_t *	pUidIn,
		uint8_t	bNvbUidIn,
		uint8_t *	pUidOut,
		uint8_t *	pNvbUidOut
	)

The function perform a ISO14443-3A Anticollision or Select command.

bNvbUidIn != 0x40: Perform Anticollision command.
bNvbUidIn = 0x40: Perform Select command.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCascadeLevel	[In] Cascade level code.
[in]	pUidIn	[In] Known UID, can also be NULL.
[in]	bNvbUidIn	[In] Number of valid bits of UidIn. MSB codes the valid bytes, LSB codes the valid bits.
[out]	pUidOut	[Out] Pointer to the complete UID.
[out]	pNvbUidOut	[Out] Pointer to number of valid bits of UidOut. MSB codes the valid bytes, LSB codes the valid bits.

◆ phhalHw_Rd710_Cmd_I14443P3A_Select()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_Select	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bCascadeLevel,
		uint8_t *	pUidIn,
		uint8_t *	pSak
	)

The function performs a ISO14443-3A "Select" command.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCascadeLevel	[In] Cascade level code.
[in]	pUidIn	[In] Pointer to UID.
[out]	pSak	[Out] Pointer to select acknowledge; uint8_t.

◆ phhalHw_Rd710_Cmd_I14443P3A_ActivateCard()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_ActivateCard	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pUidIn,
		uint8_t	bLenUidIn,
		uint8_t *	pUidOut,
		uint8_t *	pLenUidOut,
		uint8_t *	pSak,
		uint8_t *	pMoreCardsAvailable
	)

The function performs ISO14443-3A "ReqA" or "WupA" and "Anticollision"/"Select" commands for all cascade levels.

If bLenUidIn is equal to '0', CardUid not given, a ReqA command is performed. If CardUid is given, a WupA is performed.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	pUidIn	[In] Known UID, can be NULL if bLenUidIn is 0.
[in]	bLenUidIn	[In] Length of known UID.
[out]	pUidOut	[Out] Pointer to Complete UID.
[out]	pLenUidOut	[Out] Pointer to Length of UID.
[out]	pSak	[Out] Pointer to Select Acknowledge.
[out]	pMoreCardsAvailable	[Out] Pointer to a variable indicating whether more cards are in the HF or not.

◆ phhalHw_Rd710_Cmd_I14443P3A_Exchange()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_Exchange	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function performs data exchange with PICC according to ISO14443-3A.

wOption can be one of:

PH_EXCHANGE_DEFAULT

wOption can be combined with:

PH_EXCHANGE_BUFFERED_BIT

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer holding the transmit data.
[in]	wTxLength	[In] Length of data to transmit.
[out]	ppRxBuffer	[Out] Pointer to pointer to the received data buffer.
[out]	pRxLength	[Out] Pointer to the number of the received data bytes.

◆ phhalHw_Rd710_Cmd_I14443P3A_GetSerialNo()

phStatus_t phhalHw_Rd710_Cmd_I14443P3A_GetSerialNo	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t *	pRxBuffer,
		uint8_t *	pRxLength
	)

The function petrieves the serial number of the indicated PICC.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	pRxBuffer	[Out] Pointer to the last UID.
[out]	pRxLength	[Out] Pointer to the length of UID.

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeL3()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_ExchangeL3	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function performs ISO14443-3 data exchange with MIFARE PICC.

wOption can be one of:

PH_EXCHANGE_DEFAULT

wOption can be combined with:

PH_EXCHANGE_BUFFERED_BIT

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer holding the transmit data.
[in]	wTxLength	[In] Length of data to transmit.
[out]	ppRxBuffer	[Out] Pointer to pointer to the received data buffer.
[out]	pRxLength	[Out] Pointer to the number of the received data bytes.

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeL4()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_ExchangeL4	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function performs ISO14443-4 data exchange with MIFARE PICC.

wOption can be one of:

wOption can be combined with:

PH_EXCHANGE_BUFFERED_BIT

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer holding the transmit data.
[in]	wTxLength	[In] Length of data to transmit.
[out]	ppRxBuffer	[Out] Pointer to pointer to the received data buffer.
[out]	pRxLength	[Out] Pointer to the number of the received data bytes.

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangePc()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_ExchangePc	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength
	)

The function performs proximity-check data exchange with MIFARE Picc.

Note: The wOption parameter is currently RFU.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer holding the transmit data.
[in]	wTxLength	[In] Length of data to transmit.
[out]	ppRxBuffer	[Out] Pointer to pointer to the received data buffer.
[out]	pRxLength	[Out] Pointer to the number of the received data bytes.

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeRaw()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_ExchangeRaw	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxLength,
		uint8_t	bTxLastBits,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxLength,
		uint8_t *	pRxLastBits
	)

The function performs raw data exchange with MIFARE PICC.

No CRC or parity bytes are transferred to PICC. wOption can be one of:

PH_EXCHANGE_DEFAULT

wOption can be combined with:

PH_EXCHANGE_BUFFERED_BIT

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wOption	[In] Option parameter.
[in]	pTxBuffer	[In] Pointer to a buffer holding the transmit data.
[in]	wTxLength	[In] Length of the transmit data.
[in]	bTxLastBits	[In] Number of valid bits of last byte in the transmit buffer.
[out]	ppRxBuffer	[Out] Pointer to pointer to the received data buffer.
[out]	pRxLength	[Out] Pointer to the number of the received data bytes.
[out]	pRxLastBits	[Out] Number of valid bits of last byte in the receive buffer.

◆ phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticateKeyNo()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticateKeyNo	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bBlockNo,
		uint8_t	bKeyType,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersion,
		uint8_t *	pUid
	)

The function performs MIFARE "Authenticate" command with PICC using a key number.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bBlockNo	[In] Block number whithin a card sector that shall be authenticated.
[in]	bKeyType	[In] Either PHPAL_MIFARE_KEYA or PHPAL_MIFARE_KEYB
[in]	wKeyNo	[In] Key number to be used in authentication.
[in]	wKeyVersion	[In] Key version to be used in authentication.
[in]	pUid	[In] Serial number of current cascade level; uint8_t[4].

◆ phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticate()

phStatus_t phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticate	(	phhalHw_Rd710_DataParams_t *	pDataParams,
		uint8_t	bBlockNo,
		uint8_t	bKeyType,
		uint8_t *	pKey,
		uint8_t *	pUid
	)

The function performs MIFARE "Authenticate" command with PICC using a key.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
PH_ERR_BUFFER_OVERFLOW	Transimit data length is longer than the allocated transmit buffer size.
PH_ERR_PROTOCOL_ERROR	Invalid frame or unexpected receive data length or command code mismatch.
Other	Status word returned from the reader after the exchange function.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bBlockNo	[In] Block number whithin a card sector that shall be authenticated.
[in]	bKeyType	[In] Either PHPAL_MIFARE_KEYA or PHPAL_MIFARE_KEYB
[in]	pKey	[In] Key to be used in authentication.
[in]	pUid	[In] Serial number of current cascade level; uint8_t[4].

Functions

Detailed Description

Function Documentation

◆ phhalHw_Rd710_Cmd_InitReader()

◆ phhalHw_Rd710_Cmd_RD_LedOff()

◆ phhalHw_Rd710_Cmd_RD_LedOn()

◆ phhalHw_Rd710_Cmd_RD_ResetReader()

◆ phhalHw_Rd710_Cmd_RD_ResetFactoryDefaults()

◆ phhalHw_Rd710_Cmd_RD_SetConfigOption()

◆ phhalHw_Rd710_Cmd_RD_GetConfigOption()

◆ phhalHw_Rd710_Cmd_RD_GetReaderStatus()

◆ phhalHw_Rd710_Cmd_RD_SetPcscMode()

◆ phhalHw_Rd710_Cmd_CC_Activate()

◆ phhalHw_Rd710_Cmd_CC_ColdReset()

◆ phhalHw_Rd710_Cmd_CC_WarmReset()

◆ phhalHw_Rd710_Cmd_CC_StopClock()

◆ phhalHw_Rd710_Cmd_CC_StartClock()

◆ phhalHw_Rd710_Cmd_CC_Deactivate()

◆ phhalHw_Rd710_Cmd_CC_PresenceCheck()

◆ phhalHw_Rd710_Cmd_CC_TransmitData()

◆ phhalHw_Rd710_Cmd_CC_SendPPS()

◆ phhalHw_Rd710_Cmd_KS_FormatKeyEntry()

◆ phhalHw_Rd710_Cmd_KS_SetKey()

◆ phhalHw_Rd710_Cmd_KS_SetKeyAtPos()

◆ phhalHw_Rd710_Cmd_KS_SetKUC()

◆ phhalHw_Rd710_Cmd_KS_SetFullKeyEntry()

◆ phhalHw_Rd710_Cmd_KS_GetKeyEntry()

◆ phhalHw_Rd710_Cmd_KS_GetKey()

◆ phhalHw_Rd710_Cmd_KS_SetConfig()

◆ phhalHw_Rd710_Cmd_KS_SetConfigStr()

◆ phhalHw_Rd710_Cmd_KS_GetConfig()

◆ phhalHw_Rd710_Cmd_KS_GetConfigStr()

◆ phhalHw_Rd710_Cmd_KS_ChangeKUC()

◆ phhalHw_Rd710_Cmd_KS_GetKUC()

◆ phhalHw_Rd710_Cmd_CID_GetFreeCid()

◆ phhalHw_Rd710_Cmd_CID_FreeCid()

◆ phhalHw_Rd710_Cmd_I14443P4_SetProtocol()

◆ phhalHw_Rd710_Cmd_I14443P4_ResetProtocol()

◆ phhalHw_Rd710_Cmd_I14443P4_Deselect()

◆ phhalHw_Rd710_Cmd_I14443P4_PresCheck()

◆ phhalHw_Rd710_Cmd_I14443P4_Exchange()

◆ phhalHw_Rd710_Cmd_I14443P4_SetConfig()

◆ phhalHw_Rd710_Cmd_I14443P4_GetConfig()

◆ phhalHw_Rd710_Cmd_I14443P4A_Rats()

◆ phhalHw_Rd710_Cmd_I14443P4A_Pps()

◆ phhalHw_Rd710_Cmd_I14443P4A_ActivateCard()

◆ phhalHw_Rd710_Cmd_I14443P4A_GetProtocolParams()

◆ phhalHw_Rd710_Cmd_I14443P3A_RequestA()

◆ phhalHw_Rd710_Cmd_I14443P3A_WakeUpA()

◆ phhalHw_Rd710_Cmd_I14443P3A_HaltA()

◆ phhalHw_Rd710_Cmd_I14443P3A_Anticollision()

◆ phhalHw_Rd710_Cmd_I14443P3A_Select()

◆ phhalHw_Rd710_Cmd_I14443P3A_ActivateCard()

◆ phhalHw_Rd710_Cmd_I14443P3A_Exchange()

◆ phhalHw_Rd710_Cmd_I14443P3A_GetSerialNo()

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeL3()

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeL4()

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangePc()

◆ phhalHw_Rd710_Cmd_MIFARE_ExchangeRaw()

◆ phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticateKeyNo()

◆ phhalHw_Rd710_Cmd_MIFARE_MfcAuthenticate()