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

Collaboration diagram for Utilities:

Modules
	Defines
	Describes the options to be used for Utility interfaces.

Functions
phStatus_t	phalICode_GetSerialNo (void pDataParams, uint8_t ppUid, uint16_t pUidLen)
	Gets the UID of the tag. More...

phStatus_t	phalICode_SetSerialNo (void pDataParams, uint8_t pUid, uint8_t bUidLen)
	Sets the UID of the tag. More...

phStatus_t	phalICode_GetConfig (void pDataParams, uint16_t wConfig, uint16_t pValue)
	Get the configuration settings. More...

phStatus_t	phalICode_SetConfig (void *pDataParams, uint16_t wConfig, uint16_t wValue)
	Set the configuration settings. More...

phStatus_t	phalICode_GetTagType (void pDataParams, uint16_t pTagType)
	Get the type of Tag. More...

Detailed Description

Describes the utility interfaces. These interfaces are actually not of ISO15693 or any of the ICode product families. These are generic interfaces as part of reader library for internal purpose.

Function Documentation

◆ phalICode_GetSerialNo()

phStatus_t phalICode_GetSerialNo	(	void *	pDataParams,
		uint8_t **	ppUid,
		uint16_t *	pUidLen
	)

Gets the UID of the tag.

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.
[out]	ppUid	[Out] 8 byte UID of the tag.
[out]	pUidLen	[Out] Length of the UID buffer.

◆ phalICode_SetSerialNo()

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

Sets the UID of the tag.

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] 8 byte UID of the tag.
[in]	bUidLen	[In] Length of the UID buffer.

◆ phalICode_GetConfig()

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

Get the configuration settings.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	For configuration values (wConfig) that are not supported.
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. PHAL_ICODE_CONFIG_FLAGS PHAL_ICODE_CONFIG_ADD_INFO PHAL_ICODE_CONFIG_TIMEOUT_US PHAL_ICODE_CONFIG_TIMEOUT_MS PHAL_ICODE_CONFIG_ENABLE_BUFFERING PHAL_ICODE_CONFIG_CHALLENGE_TIMEOUT_US PHAL_ICODE_CONFIG_CHALLENGE_TIMEOUT_MS
[in]	pValue	[In] The value for the mentioned configuration information in wConfig parameter. PHAL_ICODE_CONFIG_FLAGS Refer below set of flags Common Inventory_NotSet Inventory_Set PHAL_ICODE_CONFIG_ADD_INFO, any additional information like error code will be available. PHAL_ICODE_CONFIG_ENABLE_BUFFERING PHAL_ICODE_DISABLE PHAL_ICODE_ENABLE

◆ phalICode_SetConfig()

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

Set the configuration settings.

NOTE: Both the flags PHAL_ICODE_FLAG_DATA_RATE and PHAL_ICODE_FLAG_FAST_DATA_RATE should not be combined, it should be passed separately along with other flag.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PH_ERR_INVALID_PARAMETER	For configuration values (wConfig) that are not supported.
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 update. PHAL_ICODE_CONFIG_FLAGS PHAL_ICODE_CONFIG_ENABLE_BUFFERING PHAL_ICODE_CONFIG_CHALLENGE_TIMEOUT_US PHAL_ICODE_CONFIG_CHALLENGE_TIMEOUT_MS
[in]	wValue	[In] The value for the mentioned configuration information in wConfig parameter. PHAL_ICODE_CONFIG_FLAGS Refer below set of flags Common Inventory_NotSet Inventory_Set PHAL_ICODE_CONFIG_ENABLE_BUFFERING PHAL_ICODE_DISABLE PHAL_ICODE_ENABLE

◆ phalICode_GetTagType()

phStatus_t phalICode_GetTagType	(	void *	pDataParams,
		uint16_t *	pTagType
	)

Get the type of Tag.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_INVALID_DATA_PARAMS	If DataParams is null.
PHAL_ICODE_TAG_TYPE_UNKNOWN	For tag types that are not supported.

Parameters

[in]	pDataParams	[In] Pointer to this layers parameter structure.
[in]	pTagType	[In] The type of ICode tag. PHAL_ICODE_TAG_TYPE_UNKNOWN PHAL_ICODE_TAG_TYPE_ICODE_SLI PHAL_ICODE_TAG_TYPE_ICODE_SLI_S PHAL_ICODE_TAG_TYPE_ICODE_SLI_L PHAL_ICODE_TAG_TYPE_ICODE_SLIX PHAL_ICODE_TAG_TYPE_ICODE_SLIX_S PHAL_ICODE_TAG_TYPE_ICODE_SLIX_L PHAL_ICODE_TAG_TYPE_ICODE_SLI_X2 PHAL_ICODE_TAG_TYPE_ICODE_SLI_X3 PHAL_ICODE_TAG_TYPE_ICODE_DNA PHAL_ICODE_TAG_TYPE_ICODE_NTAG_5

Modules

Functions

Detailed Description

Function Documentation

◆ phalICode_GetSerialNo()

◆ phalICode_SetSerialNo()

◆ phalICode_GetConfig()

◆ phalICode_SetConfig()

◆ phalICode_GetTagType()