These Components implement the MIFARE DESFire Light Data Management related commands. More...

Collaboration diagram for Commands_DataManagement:

Functions
phStatus_t	phalMfdfLight_ReadData (void pDataParams, uint8_t bOption, uint8_t bIns, 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	phalMfdfLight_WriteData (void pDataParams, uint8_t bOption, uint8_t bIns, 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	phalMfdfLight_GetValue (void pDataParams, uint8_t bCommOption, uint8_t bFileNo, uint8_t pValue)
	Reads the currently stored value from value files. More...

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

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

phStatus_t	phalMfdfLight_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	phalMfdfLight_ReadRecords (void pDataParams, uint8_t bCommOption, uint8_t bIns, uint8_t bFileNo, uint8_t pRecNo, uint8_t pRecCount, 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	phalMfdfLight_WriteRecord (void pDataParams, uint8_t bCommOption, uint8_t bIns, 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	phalMfdfLight_UpdateRecord (void pDataParams, uint8_t bCommOption, uint8_t bIns, uint8_t bFileNo, uint8_t pRecNo, uint8_t pOffset, uint8_t pData, uint8_t *pDataLen)
	Updates data to a record in a Cyclic or Linear Record File. More...

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

Detailed Description

These Components implement the MIFARE DESFire Light Data Management related commands.

Function Documentation

◆ phalMfdfLight_ReadData()

phStatus_t phalMfdfLight_ReadData	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bIns,
		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.

Remarks: Chaining upto the size of the HAL Rx buffer is handled within this function. If more data is to be read, the user has to call this function again with bOption = PH_EXCHANGE_RXCHAINING | [one of the communication options]

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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC `PH_EXCHANGE_RXCHAINING:` To be Or'd with the above option flag if Chaining status is returned.
[in]	bIns	[In] Uses ISO 14443-4 chaining instead of DESFire application chaining. This should be always Set.
[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]	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.

◆ phalMfdfLight_WriteData()

phStatus_t phalMfdfLight_WriteData	(	void *	pDataParams,
		uint8_t	bOption,
		uint8_t	bIns,
		uint8_t	bFileNo,
		uint8_t *	pOffset,
		uint8_t *	pTxData,
		uint8_t *	pTxDataLen
	)

Writes data to standard data files or backup data files.

Remarks: Implements chaining to the card.

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]	bOption	[In] Communication settings for the file. PHAL_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[in]	bIns	[In] Uses ISO 14443-4 chaining instead of DESFire application chaining. This should be always Set.
[in]	bFileNo	[In] The file number from where the data to be read.
[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.

◆ phalMfdfLight_GetValue()

phStatus_t phalMfdfLight_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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[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.

◆ phalMfdfLight_Credit()

phStatus_t phalMfdfLight_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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[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.

◆ phalMfdfLight_Debit()

phStatus_t phalMfdfLight_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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[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.

◆ phalMfdfLight_LimitedCredit()

phStatus_t phalMfdfLight_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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[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.

◆ phalMfdfLight_ReadRecords()

phStatus_t phalMfdfLight_ReadRecords	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bIns,
		uint8_t	bFileNo,
		uint8_t *	pRecNo,
		uint8_t *	pRecCount,
		uint8_t *	pRecSize,
		uint8_t **	ppRxdata,
		uint16_t *	pRxdataLen
	)

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

Remarks: The readrecords command reads and stores data in the rxbuffer upto the rxbuffer size before returning to the user. The rxbuffer is configured during the HAL init and this is specified by the user.

Chaining upto the size of the HAL Rx buffer is handled within this function. If more data is to be read, the user has to call this function again with bCommOption = PH_EXCHANGE_RXCHAINING | [one of the communication options]

If TMI collection is ON, if pRecCount is zero then pRecSize is madatory parameter. If pRecSize and RecCount are zero and TMI collection is ON, then PH_ERR_INVALID_PARAMETER error returned. If TMI collection is ON; and if wrong pRecSize is provided, then wrong RecCount value will be calculated and updated for TMI collection.

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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC `PH_EXCHANGE_RXCHAINING:` To be Or'd with the above option flag if Chaining status is returned.
[in]	bIns	[In] Uses ISO 14443-4 chaining instead of DESFire application chaining. This should be always Set.
[in]	bFileNo	[In] The file number from where the data to be read.
[in]	pRecNo	[In] 3 bytes LSB first. Record number of the newest record targeted, starting to count from the latest record written.
[in]	pRecCount	[In] 3 bytes LSB first. Number of records to be read. If 0x00 00 00, then all the records are read.
[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.

◆ phalMfdfLight_WriteRecord()

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

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

Remarks: Implements chaining to the card. The data provided on pData will be chained to the card by sending data upto the frame size of the DESFire PICC, at a time.

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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[in]	bIns	[In] Uses ISO 14443-4 chaining instead of DESFire application chaining. This should be always Set.
[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.

◆ phalMfdfLight_UpdateRecord()

phStatus_t phalMfdfLight_UpdateRecord	(	void *	pDataParams,
		uint8_t	bCommOption,
		uint8_t	bIns,
		uint8_t	bFileNo,
		uint8_t *	pRecNo,
		uint8_t *	pOffset,
		uint8_t *	pData,
		uint8_t *	pDataLen
	)

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

Remarks: Implements chaining to the card. The data provided on pData will be chained to the card by sending data upto the frame size of the DESFire PICC, at a time.

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_MFDFLIGHT_COMMUNICATION_PLAIN PHAL_MFDFLIGHT_COMMUNICATION_MACD PHAL_MFDFLIGHT_COMMUNICATION_ENC
[in]	bIns	[In] Uses ISO 14443-4 chaining instead of DESFire application chaining. This should be always Set.
[in]	bFileNo	[In] The file number to which the data should be written.
[in]	pRecNo	[In] Record number. Records are numbered starting with the latest record written.
[in]	pOffset	[In] Starting position for the update operationwithin the targeted record.
[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.

◆ phalMfdfLight_ClearRecordFile()

phStatus_t phalMfdfLight_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.

Functions

Detailed Description

Function Documentation

◆ phalMfdfLight_ReadData()

◆ phalMfdfLight_WriteData()

◆ phalMfdfLight_GetValue()

◆ phalMfdfLight_Credit()

◆ phalMfdfLight_Debit()

◆ phalMfdfLight_LimitedCredit()

◆ phalMfdfLight_ReadRecords()

◆ phalMfdfLight_WriteRecord()

◆ phalMfdfLight_UpdateRecord()

◆ phalMfdfLight_ClearRecordFile()