Utilities

Describes the utility interfaces. These interfaces are actually not part of ISO15693 These are generic interfaces as part of reader library for internal purpose. More...

Collaboration diagram for Utilities:

Modules
	Defines
	Configuration and Option definitions. These options shall be used along with SetConfig and GetConfig to configure PAL Sli15693 layer.

Functions
phStatus_t	phpalSli15693_GetSerialNo (void *pDataParams, uint8_t *pUid, uint8_t *bUidLen)
	Retrieve the serial number (UID). More...
phStatus_t	phpalSli15693_SetSerialNo (void *pDataParams, uint8_t *pUid, uint8_t bUidLen)
	Set serial number (UID). More...
phStatus_t	phpalSli15693_SetConfig (void *pDataParams, uint16_t wConfig, uint16_t wValue)
	Set value of the specified Configuration Identifier. More...
phStatus_t	phpalSli15693_GetConfig (void *pDataParams, uint16_t wConfig, uint16_t *pValue)
	Get value of the specified Configuration Identifier. More...

Detailed Description

Describes the utility interfaces. These interfaces are actually not part of ISO15693 These are generic interfaces as part of reader library for internal purpose.

Function Documentation

phpalSli15693_GetSerialNo()

phStatus_t phpalSli15693_GetSerialNo	(	void *	pDataParams,
		uint8_t *	pUid,
		uint8_t *	bUidLen
	)

Retrieve the serial number (UID).

This API is used to get the UID of current VICC with which this layer is communicating.

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_USE_CONDITION	No UID available.
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.
[out]	pUid	[Out] Buffer, holding the UID (8 bytes)
[out]	bUidLen	[Out] Length of bytes available in pUid buffer.

phpalSli15693_SetSerialNo()

phStatus_t phpalSli15693_SetSerialNo	(	void *	pDataParams,
		uint8_t *	pUid,
		uint8_t	bUidLen
	)

Set serial number (UID).

When multiple VICCs are detected, this API shall be used to set a specific UID to this layer from the list of detected UIDs.

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.
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]	pUid	[In] Buffer, holding the UID (8 bytes)
[in]	bUidLen	[In] Length of UID in bytes.

phpalSli15693_SetConfig()

phStatus_t phpalSli15693_SetConfig	(	void *	pDataParams,
		uint16_t	wConfig,
		uint16_t	wValue
	)

Set value of the specified Configuration Identifier.

• The SetConfig command is used to set values for the different configuration parameters of this layer.
• wConfig can be one of:
  • Flags
  • Additional Information
  • Timeout in us
  • Timeout in ms
  • Tx DataRate
  • Rx DataRate
  • T1 Parameter
  • Enable Buffering
  • Maximum Retry Count
  • IC Manufacturer Code
  • Transparent

NOTE: Both the flags values DataRate and Fast DataRate should not be combined, it should be passed separately along with other flags.

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_UNSUPPORTED_PARAMETER	Invalid wConfig.
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]	wConfig	[In] Configuration to configure.
[in]	wValue	[In] Value to set.

phpalSli15693_GetConfig()

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

Get value of the specified Configuration Identifier.

• The SetConfig command is used to set values for the different configuration parameters of this layer.
• wConfig can be one of:
  • Flags
  • Additional Information
  • Timeout in us
  • Timeout in ms
  • Tx DataRate
  • Rx DataRate
  • T1 Parameter
  • Enable Buffering
  • Maximum Retry Count
  • IC Manufacturer Code
  • Transparent

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_UNSUPPORTED_PARAMETER	Invalid wConfig.
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]	wConfig	[In] Configuration to read.
[in]	pValue	[In] Read value.