These Components implement the MIFARE DESFire Data Manipulation commands. More...

Collaboration diagram for Commands_DataManipulation:

Functions
phStatus_t	phalMfdf_ReadData (void pDataParams, uint8_t bOption, uint8_t bFileNo, uint8_t pOffset, uint8_t pLength, uint8_t ppRxdata, uint16_t pRxdataLen)
	Reads data from standard data files or backup data files. More...

phStatus_t	phalMfdf_WriteData (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pOffset, uint8_t pTxData, uint8_t pTxDataLen)
	Writes data to standard data files or backup data files. More...

phStatus_t	phalMfdf_GetValue (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pValue)
	Reads the currently stored value from value files. More...

phStatus_t	phalMfdf_Credit (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pValue)
	Increases a value stored in a Value File. More...

phStatus_t	phalMfdf_Debit (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pValue)
	Decreases a value stored in a Value File. More...

phStatus_t	phalMfdf_LimitedCredit (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pValue)
	Allows a limited increase of a value stored in a Value File without having full credit permissions to the file. More...

phStatus_t	phalMfdf_WriteRecord (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pOffset, uint8_t pData, uint8_t pDataLen)
	Writes data to a record in a Cyclic or Linear Record File. More...

phStatus_t	phalMfdf_ReadRecords (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pOffset, uint8_t pNumRec, uint8_t pRecSize, uint8_t *ppRxdata, uint16_t pRxdataLen)
	Reads out a set of complete records from a Cyclic or Linear Record File. More...

phStatus_t	phalMfdf_ClearRecordFile (void *pDataParams, uint8_t bFileNo)
	Resets a Cyclic or Linear Record File. More...

phStatus_t	phalMfdf_CommitTransaction (void *pDataParams)
	Validates all previous write access' on Backup Data files, value files and record files within one application. More...

phStatus_t	phalMfdf_AbortTransaction (void *pDataParams)
	Invalidates all previous write access' on Backup Data files, value files and record files within one application. More...

Detailed Description

These Components implement the MIFARE DESFire Data Manipulation commands.

Function Documentation

◆ phalMfdf_ReadData()

phStatus_t phalMfdf_ReadData	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bFileNo,
		uint8_t *	pOffset,
		uint8_t *	pLength,
		uint8_t **	ppRxdata,
		uint16_t *	pRxdataLen
	)

Reads data from standard data files or backup data files.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_SUCCESS_CHAINING	indicating more data to be read.
Depending	on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
	bFileNo	`PH_EXCHANGE_RXCHAINING:` To be Or'd with the above option flag if the PICC returns AF followed by data. [In] The file number from where the data to be read.
[in]	pOffset	[In] The offset from where the data should be read. Will be of 3 bytes with LSB first. `If` 0x10 need to be offset then it will be 10 00 00.
[in]	pLength	[In] The number of bytes to be read. Will be of 3 bytes with LSB first. `If` 0x10 bytes need to be read then it will be 10 00 00. `If` complete file need to be read then it will be 00 00 00.
[out]	ppRxdata	[Out] The data retuned by the PICC.
[out]	pRxdataLen	[Out] Length of bytes available in RxData buffer.

◆ phalMfdf_WriteData()

phStatus_t phalMfdf_WriteData	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pOffset,
		uint8_t *	pTxData,
		uint8_t *	pTxDataLen
	)

Writes data to standard data files or backup data files.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number to which the data should be written.
[in]	pOffset	[In] The offset from where the data should be written. Will be of 3 bytes with LSB first. `If` 0x10 need to be offset then it will be 10 00 00.
[in]	pTxData	[In] The data to be written to the PICC.
[in]	pTxDataLen	[In] The number of bytes to be written. Will be of 3 bytes with LSB first. `If` 0x10 bytes need to be written then it will be 10 00 00.

◆ phalMfdf_GetValue()

phStatus_t phalMfdf_GetValue	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pValue
	)

Reads the currently stored value from value files.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number for which the value to the retrieved.
[out]	pValue	[Out] The value returned by the PICC. The buffer should be 4 bytes.

◆ phalMfdf_Credit()

phStatus_t phalMfdf_Credit	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pValue
	)

Increases a value stored in a Value File.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number to which the value should be credited.
[out]	pValue	[Out] The value to be credited. Will be of 4 bytes with LSB first. `If` 0x10 bytes need to be credited then it will be 10 00 00 00.

◆ phalMfdf_Debit()

phStatus_t phalMfdf_Debit	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pValue
	)

Decreases a value stored in a Value File.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number to which the value should be debited.
[out]	pValue	[Out] The value to be debited. Will be of 4 bytes with LSB first. `If` 0x10 bytes need to be debited then it will be 10 00 00 00.

◆ phalMfdf_LimitedCredit()

phStatus_t phalMfdf_LimitedCredit	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pValue
	)

Allows a limited increase of a value stored in a Value File without having full credit permissions to the file.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number to which the value should be credited.
[out]	pValue	[Out] The value to be credited. Will be of 4 bytes with LSB first. `If` 0x10 bytes need to be credited then it will be 10 00 00 00.

◆ phalMfdf_WriteRecord()

phStatus_t phalMfdf_WriteRecord	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pOffset,
		uint8_t *	pData,
		uint8_t *	pDataLen
	)

Writes data to a record in a Cyclic or Linear Record File.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number to which the data should be written.
[in]	pOffset	[In] The offset from where the data should be written. Will be of 3 bytes with LSB first. `If` 0x10 need to be offset then it will be 10 00 00.
[in]	pData	[In] The data to be written to the PICC.
[in]	pDataLen	[In] The number of bytes to be written. Will be of 3 bytes with LSB first. `If` 0x10 bytes need to be written then it will be 10 00 00.

◆ phalMfdf_ReadRecords()

phStatus_t phalMfdf_ReadRecords	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bFileNo,
		uint8_t *	pOffset,
		uint8_t *	pNumRec,
		uint8_t *	pRecSize,
		uint8_t **	ppRxdata,
		uint16_t *	pRxdataLen
	)

Reads out a set of complete records from a Cyclic or Linear Record File.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
PH_ERR_SUCCESS_CHAINING	indicating more data to be read.
Depending	on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	bCommOption	[In] Communication settings for the file. PHAL_MFDF_COMMUNICATION_PLAIN
[in]	bFileNo	[In] The file number from where the data to be read.
[in]	pOffset	[In] The offset from where the data should be read. Will be of 3 bytes with LSB first. `If` 0x10 need to be offset then it will be 10 00 00.
[in]	pNumRec	[In] The number of records to be read. Will be of 3 bytes with LSB first. `If` 0x10 record need to be read then it will be 10 00 00. `If` all records need to be read then it will be 00 00 00.
[in]	pRecSize	[In] The number of bytes to be read. Will be of 3 bytes with LSB first.
[out]	ppRxdata	[Out] The data retuned by the PICC.
[out]	pRxdataLen	[Out] Length of bytes available in RxData buffer.

◆ phalMfdf_ClearRecordFile()

phStatus_t phalMfdf_ClearRecordFile	(	void *	pDataParams,
		uint8_t	bFileNo
	)

Resets a Cyclic or Linear Record File.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
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 cleared.

◆ phalMfdf_CommitTransaction()

phStatus_t phalMfdf_CommitTransaction ( void * pDataParams )

Validates all previous write access' on Backup Data files, value files and record files within one application.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

◆ phalMfdf_AbortTransaction()

phStatus_t phalMfdf_AbortTransaction ( void * pDataParams )

Invalidates all previous write access' on Backup Data files, value files and record files within one application.

Returns: Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in] pDataParams [In] Pointer to this layer's parameter structure.

Functions

Detailed Description

Function Documentation

◆ phalMfdf_ReadData()

◆ phalMfdf_WriteData()

◆ phalMfdf_GetValue()

◆ phalMfdf_Credit()

◆ phalMfdf_Debit()

◆ phalMfdf_LimitedCredit()

◆ phalMfdf_WriteRecord()

◆ phalMfdf_ReadRecords()

◆ phalMfdf_ClearRecordFile()

◆ phalMfdf_CommitTransaction()

◆ phalMfdf_AbortTransaction()