Describes about the NTAG X DNA Memory and Configuration Management commands. More...

Collaboration diagram for Commands_MemoryConfiguration:

Modules
	Defines
	Macro Definitions for Memory and Configuration Management commands.

Functions
phStatus_t	phalNtagXDna_FreeMem (void pDataParams, uint8_t ppMemInfo, uint16_t pMemInfoLen)
	Returns free memory available on the tag. More...

phStatus_t	phalNtagXDna_SetConfiguration (void pDataParams, uint8_t bOption, uint8_t pData, uint8_t bDataLen)
	Performs SetConfiguration to configures several aspects of the card or the application. More...

phStatus_t	phalNtagXDna_GetConfiguration (void pDataParams, uint8_t bOption, uint8_t bExchangeOption, uint8_t ppData, uint16_t pDataLen)
	Performs GetConfiguration to retrieve configuration aspects of the card or the application. More...

phStatus_t	phalNtagXDna_ActivateConfiguration (void pDataParams, uint8_t bConfCount, uint8_t pConfigList, uint8_t bConfigList_Len)
	Performs ActivateConfiguration to abolish a deferred configuration. More...

phStatus_t	phalNtagXDna_GetVersion (void pDataParams, uint8_t bOption, uint8_t ppVersion, uint16_t pVerLen)
	Returns manufacturing related data of the tag. More...

phStatus_t	phalNtagXDna_GetCardUID (void pDataParams, uint8_t ppUid, uint16_t pUidLen)
	Returns the Unique Identifier of the tag. More...

Detailed Description

Describes about the NTAG X DNA Memory and Configuration Management commands.

Function Documentation

◆ phalNtagXDna_FreeMem()

phStatus_t phalNtagXDna_FreeMem	(	void *	pDataParams,
		uint8_t **	ppMemInfo,
		uint16_t *	pMemInfoLen
	)

Returns free memory available on 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 buffer is null.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	ppMemInfo	[Out] Current free memory available. Response Will be of 3 bytes with LSB first. If the free memory available is 7592 bytes, then 7592 in Hex will be 0x001F10 ppMemInfo will contain 10 1F 00.
[out]	pMemInfoLen	[Out] Length of bytes available in ppMemInfo buffer.

◆ phalNtagXDna_SetConfiguration()

phStatus_t phalNtagXDna_SetConfiguration	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t *	pData,
		uint8_t	bDataLen
	)

Performs SetConfiguration to configures several aspects of the card or the application.

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 buffer is null.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bOption	[In] Configuration Option to configure. Refer supported Set Configurations options.
[in]	pData	[In] Data for the option specified.
[in]	bDataLen	[In] Length of bytes available in pData buffer.

◆ phalNtagXDna_GetConfiguration()

phStatus_t phalNtagXDna_GetConfiguration	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bExchangeOption,
		uint8_t **	ppData,
		uint16_t *	pDataLen
	)

Performs GetConfiguration to retrieve configuration aspects of the card or the application.

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 buffer is null. For Invalid ExchangeOption (bExchangeOption) value.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bOption	[In] Configuration Option to configure. Refer supported Set Configurations options. All the options are supported except option 0x01.
[in]	bExchangeOption	[In] Whether or not to exchange Option (bOption) information to tag. OFF: Do not exchange Option information to tag. ON : Exchange Option information to tag.
[in]	ppData	[In] One of the following information. If bExchangeOption = OFF then, Manufacturer Data. will be returned. If bExchangeOption = ON then, information based on the Option data will be returned.
[in]	pDataLen	[In] Length of bytes available in ppData buffer.

◆ phalNtagXDna_ActivateConfiguration()

phStatus_t phalNtagXDna_ActivateConfiguration	(	void *	pDataParams,
		uint8_t	bConfCount,
		uint8_t *	pConfigList,
		uint8_t	bConfigList_Len
	)

Performs ActivateConfiguration to abolish a deferred configuration.

ActivateConfiguration provides the list of deferred configurations for which the deferral can be ended.

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 buffer is null.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bConfCount	[In] Number Of Configurations to be Activated (N).
[in]	pConfigList	[In] List of configurations to be activated (with size N * 2). List must hold one or more of following values. Activate SetConfiguration 0x01 (RandomID) Activate SetConfiguration 0x0D (Silent Mode) Activate SetConfiguration 0x11 (TagTamper boot measurements) Activate ChangeFileSettings SDM encryptions
[in]	bConfigList_Len	[In] Length of bytes available in pConfigList buffer.

◆ phalNtagXDna_GetVersion()

phStatus_t phalNtagXDna_GetVersion	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t **	ppVersion,
		uint16_t *	pVerLen
	)

Returns manufacturing related data 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 buffer is null.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bOption	[In] Option information to be exchanged. Will be one of the following, Do Not Return FabID: Option byte is not exchanged to tag. Return FabID: Option byte is exchanged to tag.
[out]	ppVersion	[Out] Returns the complete version information of the tag. The information includes, Hardware Information Software Information Production Related Information Will have FabID based on bOption information.
[out]	pVerLen	[Out] Length of bytes available in ppVersion buffer.

◆ phalNtagXDna_GetCardUID()

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

Returns the Unique Identifier 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 buffer is null.
XXXX	Depending on status codes return by tag. Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[out]	ppUid	[Out] Returns the complete UID information of the tag.
[out]	pUidLen	[Out] Length of bytes available in ppUid buffer.

Modules

Functions

Detailed Description

Function Documentation

◆ phalNtagXDna_FreeMem()

◆ phalNtagXDna_SetConfiguration()

◆ phalNtagXDna_GetConfiguration()

◆ phalNtagXDna_ActivateConfiguration()

◆ phalNtagXDna_GetVersion()

◆ phalNtagXDna_GetCardUID()