Commands_Commmon

Common commands that performs Activation of the VICC, Exchange to VICC, etc... More...

Collaboration diagram for Commands_Commmon:

Functions
phStatus_t	phpalSli15693_ActivateCard (void *pDataParams, uint8_t bOption, uint8_t bFlags, uint8_t bAfi, uint8_t *pMask, uint8_t bMaskBitLen, uint8_t *pDsfid, uint8_t *pUid, uint8_t *pMoreCardsAvailable)
	Perform ISO15693 ActivateCard command. More...
phStatus_t	phpalSli15693_SendEof (void *pDataParams, uint8_t bOption, uint8_t *pDsfid, uint8_t *pUid, uint8_t *pUidLen, uint8_t *pData, uint16_t *pDataLen)
	Send a ISO15693 EOF (End of Frame). More...
phStatus_t	phpalSli15693_Exchange (void *pDataParams, uint16_t wOption, uint8_t *pTxBuffer, uint16_t wTxBuffLen, uint8_t **ppRxBuffer, uint16_t *pRxBuffLen)
	Perform ISO15693 Data Exchange with VICC. More...
phStatus_t	phpalSli15693_InProcessReplyASync (void *pDataParams, uint8_t *pTxBuffer, uint16_t wTxBuffLen, uint8_t *pResponse1, uint16_t *pResp1_Len, uint8_t *pResponse2, uint16_t *pResp2_Len)
	Perform ISO15693 Data Exchange with VICC with dual response for a single command. More...

Detailed Description

Common commands that performs Activation of the VICC, Exchange to VICC, etc...

Function Documentation

phpalSli15693_ActivateCard()

phStatus_t phpalSli15693_ActivateCard	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bFlags,
		uint8_t	bAfi,
		uint8_t *	pMask,
		uint8_t	bMaskBitLen,
		uint8_t *	pDsfid,
		uint8_t *	pUid,
		uint8_t *	pMoreCardsAvailable
	)

Perform ISO15693 ActivateCard command.

• This function activates the first VICC detected during the collision resolution and optionally move it to selected state based on the wOption specified.
• bOption can be one of:
  • Default
  • Selected
  • Addressed

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	If the buffers are null.
PH_ERR_PROTOCOL_ERROR	Invalid response received.
XXXX	Depending on status codes return by PICC. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layers parameter structure.
[in]	bOption	[In] Selected or addressed. Refer description for supported options.
[in]	bFlags	[In] Request flags byte. Refer below set of flags Common Inventory_NotSet Inventory_Set
[in]	bAfi	[In] Application Family Identifier.
[in]	pMask	[In] UID mask, holding known UID bits.
[in]	bMaskBitLen	[In] Number of UID bits within pMask.
[out]	pDsfid	[Out] Data Storage Format Identifier.
[out]	pUid	[Out] Received UID of first found card
[out]	pMoreCardsAvailable	[Out] If there are more cards available this value is different from zero.

phpalSli15693_SendEof()

phStatus_t phpalSli15693_SendEof	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t *	pDsfid,
		uint8_t *	pUid,
		uint8_t *	pUidLen,
		uint8_t *	pData,
		uint16_t *	pDataLen
	)

Send a ISO15693 EOF (End of Frame).

• When 16 slots are used in the inventory process, to switch to the next slot, the reader shall send an EOF with option EOF Next Slot.
• To send EOF for write alike commands, Write Alike or Write Alike with Wait shall be used. For ISO15693 custom commands like Inventory Read, EOF Next Slot with Inventory Read option shall be used.
• bOption can be one of
  • EOF Next Slot
  • EOF Write Alike
  • EOF Next Slot with Inventory Read
  • EOF Write Alike with Wait

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	If the buffers are null.
PH_ERR_PROTOCOL_ERROR	Invalid response received.
XXXX	Depending on status codes return by PICC. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layers parameter structure.
[in]	bOption	[In] Option parameter. Refer description for supported options.
[out]	pDsfid	[Out] Data Storage Format Identifier.
[out]	pUid	[Out] Received UID
[out]	pUidLen	[Out] Length of bytes available in pUid buffer.
[out]	pData	[Out] Received data.
[out]	pDataLen	[Out] Length of bytes available in pData buffer.

phpalSli15693_Exchange()

phStatus_t phpalSli15693_Exchange	(	void *	pDataParams,
		uint16_t	wOption,
		uint8_t *	pTxBuffer,
		uint16_t	wTxBuffLen,
		uint8_t **	ppRxBuffer,
		uint16_t *	pRxBuffLen
	)

Perform ISO15693 Data Exchange with VICC.

• wOption can be one of:
  • Default. VICC Exchange is performed.
  • Buffer Initial Information. VICC Exchange is not performed.
  • Buffer intermediate information. VICC Exchange is not performed.
  • Buffer last information (if any) and Exchange to VICC.

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	If the buffers are null.
PH_ERR_PROTOCOL_ERROR	Invalid response received.
XXXX	Depending on status codes return by PICC. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layers parameter structure.
[in]	wOption	[In] Buffering options. Refer description for supported options.
[in]	pTxBuffer	[In] Data to be transmitted to VICC.

Note

: Flags, IC MFC code and UID will be added automatically by the library internally.

Parameters

[in]	wTxBuffLen	[In] Length of bytes available in pTxBuffer buffer.
[out]	ppRxBuffer	[Out] Received information from VICC.
[out]	pRxBuffLen	[Out] Length of bytes available in ppRxBuffer buffer.

phpalSli15693_InProcessReplyASync()

phStatus_t phpalSli15693_InProcessReplyASync	(	void *	pDataParams,
		uint8_t *	pTxBuffer,
		uint16_t	wTxBuffLen,
		uint8_t *	pResponse1,
		uint16_t *	pResp1_Len,
		uint8_t *	pResponse2,
		uint16_t *	pResp2_Len
	)

Perform ISO15693 Data Exchange with VICC with dual response for a single command.

Note

:

• The implementation is based on ISO/IEC 15693-3:2019, VICC in-reply process — Asynchronous mode, section 9.8.3.3
• The response is given out as is received from the VICC removing the Flags in case of SUCCESS or FAILURE.
• The actual error code received from VICC can be retrieved using SetConfig with Additional Information as configuration identifier.
• Validation of the response is not carried out by this interface.

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	If the buffers are null.
PH_ERR_PROTOCOL_ERROR	Invalid response received.
PHPAL_SLI15693_ERR_IN_PROCESS_REPLY_PART1	Error in Part 1 Response
PHPAL_SLI15693_ERR_IN_PROCESS_REPLY_PART2	Error in Part 2 Response
XXXX	Depending on status codes return by PICC. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layers parameter structure.
[in]	pTxBuffer	[In] Data to be transmitted to VICC.

Note

: Flags, IC MFC code and UID will be added automatically by the library internally.

Parameters

[in]	wTxBuffLen	[In] Length of bytes available in pTxBuffer buffer.
[out]	pResponse1	[Out] First Information received from VICC.
[out]	pResp1_Len	[Out] Length of bytes available in pResponse1 buffer.
[out]	pResponse2	[Out] Second Information received from VICC.
[out]	pResp2_Len	[Out] Length of bytes available in pResponse2 buffer.