Describes about the NTAG X DNA File Management commands. More...

Collaboration diagram for Commands_FileManagement:

Modules
	Defines
	Macro Definitions for File Management commands.

Functions
phStatus_t	phalNtagXDna_CreateStdDataFile (void pDataParams, uint8_t bOption, uint8_t bFileNo, uint8_t pISOFileId, uint8_t bFileOption, uint8_t pAccessRights, uint8_t pFileSize)
	Creates files for the storage of plain unformatted user data within an existing application on the tag. More...

phStatus_t	phalNtagXDna_CreateCounterFile (void pDataParams, uint8_t bFileNo, uint8_t bFileOption, uint8_t pAccessRights, uint32_t dwValue)
	Creates files for the storage of plain unformatted Counter information. More...

phStatus_t	phalNtagXDna_GetFileIDs (void pDataParams, uint8_t ppFileId, uint16_t pFileIdLen)
	Returns the file IDs of all active files within the currently selected application. More...

phStatus_t	phalNtagXDna_GetISOFileIDs (void pDataParams, uint8_t ppISOFileId, uint16_t pISOFileIdLen)
	Get the ISO File IDs. More...

phStatus_t	phalNtagXDna_GetFileSettings (void pDataParams, uint8_t bFileNo, uint8_t ppFSBuffer, uint16_t pFSBufLen)
	Get information on the properties of a specific file. More...

phStatus_t	phalNtagXDna_GetFileCounters (void pDataParams, uint8_t bOption, uint8_t bFileNo, uint8_t ppFileCounters, uint16_t pFileCounterLen)
	Get file related counters used for Secure Dynamic Messaging. More...

phStatus_t	phalNtagXDna_ChangeFileSettings (void pDataParams, uint8_t bOption, uint8_t bFileNo, uint8_t bFileOption, uint8_t pAccessRights, uint8_t *pAddInfo, uint8_t bAddInfoLen)
	Changes the access parameters of an existing file. More...

Detailed Description

Describes about the NTAG X DNA File Management commands.

Function Documentation

◆ phalNtagXDna_CreateStdDataFile()

phStatus_t phalNtagXDna_CreateStdDataFile	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bFileNo,
		uint8_t *	pISOFileId,
		uint8_t	bFileOption,
		uint8_t *	pAccessRights,
		uint8_t *	pFileSize
	)

Creates files for the storage of plain unformatted user data within an existing application 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 buffers are null. For Invalid Option (bOption) information. For Invalid File numbers (bFileNo). For Invalid File communication mode (bFileOption).
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 to represent the presence of ISO information. ISO File Info not available ISO File ID Available
[in]	bFileNo	[In] The file number to be created.
[in]	pISOFileId	[In] ISO File ID to be used. Should be two bytes.
[in]	bFileOption	[In] Option for the targeted file. Communication settings for the file. Plain Mode MAC Mode Full Mode ORed with one of the above options. SDM Mirroring Enabled
[in]	pAccessRights	[In] The new access right to be applied for the file. Should be 2 byte. Bit[15 - 12]: Read Bit[11 - 8] : Write Bit[7 - 4] : ReadWrite Bit[3 - 0] : Change or RFU. Change for the 1st mandatory set of access condition else RFU (i.e. 0xF) Below are the values for the above bits. 0x00 - 0x0B: Authentication Required 0x0C : Free Access over NFC, Authentication required over I2C 0x0D : Free Access over I2C, Authentication required over NFC 0x0E : Free Access 0x0F : No Access or RFU
[in]	pFileSize	[In] The size of the file. Will be of 3 bytes with LSB first. If size 0x10 need to be created, then the FileSize will be 10 00 00.

◆ phalNtagXDna_CreateCounterFile()

phStatus_t phalNtagXDna_CreateCounterFile	(	void *	pDataParams,
		uint8_t	bFileNo,
		uint8_t	bFileOption,
		uint8_t *	pAccessRights,
		uint32_t	dwValue
	)

Creates files for the storage of plain unformatted Counter information.

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. For Invalid Option (bOption) information. For Invalid File numbers (bFileNo). For Invalid File communication mode (bFileOption).
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]	bFileNo	[In] The file number to be created.
[in]	bFileOption	[In] Option for the targeted file. Communication settings for the file. Plain Mode MAC Mode Full Mode
[in]	pAccessRights	[In] The new access right to be applied for the file. Should be 2 byte. Bit[15 - 12]: Read Bit[11 - 8] : Write Bit[7 - 4] : ReadWrite Bit[3 - 0] : Change or RFU. Change for the 1st mandatory set of access condition else RFU (i.e. 0xF) Below are the values for the above bits. 0x00 - 0x0B: Authentication Required 0x0C : Free Access over NFC, Authentication required over I2C 0x0D : Free Access over I2C, Authentication required over NFC 0x0E : Free Access 0x0F : No Access or RFU
[in]	dwValue	[In] Counter Value to be stored. Provide the counter value in regular format, like if 0x10 needs to be updated then dwValue = 0x00000010

◆ phalNtagXDna_GetFileIDs()

phStatus_t phalNtagXDna_GetFileIDs	(	void *	pDataParams,
		uint8_t **	ppFileId,
		uint16_t *	pFileIdLen
	)

Returns the file IDs of all active files within the currently selected 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.
[out]	ppFileId	[Out] The buffer containing the available File ID(s).
[out]	pFileIdLen	[Out] Length of bytes available in ppFid buffer.

◆ phalNtagXDna_GetISOFileIDs()

phStatus_t phalNtagXDna_GetISOFileIDs	(	void *	pDataParams,
		uint8_t **	ppISOFileId,
		uint16_t *	pISOFileIdLen
	)

Get the ISO File IDs.

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]	ppISOFileId	[Out] The buffer containing the available ISO File ID(s).
[out]	pISOFileIdLen	[Out] Length of bytes available in ppFid buffer.

◆ phalNtagXDna_GetFileSettings()

phStatus_t phalNtagXDna_GetFileSettings	(	void *	pDataParams,
		uint8_t	bFileNo,
		uint8_t **	ppFSBuffer,
		uint16_t *	pFSBufLen
	)

Get information on the properties of a specific file.

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]	bFileNo	[In] The file number for which the setting to be retrieved.
[out]	ppFSBuffer	[Out] The buffer containing the settings.
[out]	pFSBufLen	[Out] Length of bytes available in ppFSBuffer buffer.

◆ phalNtagXDna_GetFileCounters()

phStatus_t phalNtagXDna_GetFileCounters	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bFileNo,
		uint8_t **	ppFileCounters,
		uint16_t *	pFileCounterLen
	)

Get file related counters used for Secure Dynamic Messaging.

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] Indicates the mode of communication to be used while exchanging the data to tag. Plain Mode Full Mode
[in]	bFileNo	[In] File number for which the Counter information need to be received.
[out]	ppFileCounters	[Out] The SDMReadCounter information returned by the tag.
[out]	pFileCounterLen	[Out] Length of bytes available in ppFileCounters buffer.

◆ phalNtagXDna_ChangeFileSettings()

phStatus_t phalNtagXDna_ChangeFileSettings	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bFileNo,
		uint8_t	bFileOption,
		uint8_t *	pAccessRights,
		uint8_t *	pAddInfo,
		uint8_t	bAddInfoLen
	)

Changes the access parameters of an existing file.

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. For Invalid File numbers (bFileNo). For Invalid File communication mode (bFileOption).
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] Indicates the mode of communication to be used while exchanging the data to tag. Plain Mode Full Mode
[in]	bFileNo	[In] File number for which the setting need to be updated.
[in]	bFileOption	[In] Option for the targeted file. Communication settings for the file. Plain Mode MAC Mode Full Mode ORed with one of the above options. SDM Mirroring Enabled Deferred Configuration Enabled
[in]	pAccessRights	[In] Set of access conditions for the 1st set in the file. Should be 2 byte.
[in]	pAddInfo	[In] Buffer should contain the following information. [SDMOption \|\| SDM AccessRights \|\| UIDOffset \|\| SDMReadCtrOffset \|\| PICCDataOffset \|\| GPIOStatusOffset \|\| SDMMACInputOffset \|\| SDMENCOffset \|\| SDMENCLength \|\| SDMMACOffset \|\| SDMReadCtrLimit] \|\| [DeferOption] \|\| [DeferMethod]
[in]	bAddInfoLen	[In] Length of bytes available in pAddInfo buffer.

Modules

Functions

Detailed Description

Function Documentation

◆ phalNtagXDna_CreateStdDataFile()

◆ phalNtagXDna_CreateCounterFile()

◆ phalNtagXDna_GetFileIDs()

◆ phalNtagXDna_GetISOFileIDs()

◆ phalNtagXDna_GetFileSettings()

◆ phalNtagXDna_GetFileCounters()

◆ phalNtagXDna_ChangeFileSettings()