Commands_MemoryConfiguration

These Components implement the MIFARE DESFire EVx Memory and Configuration Management related commands. More...

Collaboration diagram for Commands_MemoryConfiguration:

Functions
phStatus_t	phalMfdfEVx_FreeMem (void *pDataParams, uint8_t *pMemInfo)
	Returns free memory available on the PICC. More...
phStatus_t	phalMfdfEVx_Format (void *pDataParams)
	Releases the PICC user memory. More...
phStatus_t	phalMfdfEVx_SetConfiguration (void *pDataParams, uint8_t bOption, uint8_t *pData, uint8_t bDataLen)
	Configures the card and pre personalizes the card with a key, defines if the UID or the random ID is sent back during communication setup and configures the ATS string. More...
phStatus_t	phalMfdfEVx_GetVersion (void *pDataParams, uint8_t *pVerInfo)
	Returns manufacturing related data of the PICC. More...
phStatus_t	phalMfdfEVx_GetCardUID (void *pDataParams, uint8_t bExchangeOption, uint8_t bOption, uint8_t *pUid)
	Returns the Unique ID of the PICC. More...

Options for SetConfiguration command.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION0   0x00U
	Option 0 for updating the PICC Configuration.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION1   0x01U
	Option 1 for updating the Default Keys.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION2   0x02U
	Option 2 for updating the ATS.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION3   0x03U
	Option 3 for updating the SAK.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION4   0x04U
	Option 4 for updating the Secure Messaging.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION5   0x05U
	Option 5 for updating the Capability Data.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTION6   0x06U
	Option 6 for updating the VC Installation Identifier.
#define	PHAL_MFDFEVX_SET_CONFIG_OPTIONC   0x0CU
	Option C for updating the ATQA information.

Options for GetCardUID command.
#define	PHAL_MFDFEVX_GET_CARD_UID_EXCHANGE_OPTION_OFF   0x00U
	Option for not exchanging the Option information to PICC.
#define	PHAL_MFDFEVX_GET_CARD_UID_EXCHANGE_OPTION_ON   0x01U
	Option for exchanging the Option information to PICC.
#define	PHAL_MFDFEVX_GET_CARD_UID_OPTION_NUID_NOT_RETURNED   0x00U
	Option for no return of 4 byte NUID from PICC.
#define	PHAL_MFDFEVX_GET_CARD_UID_OPTION_NUID_RETURNED   0x01U
	Option for return of 4 byte NUID from PICC.

Detailed Description

These Components implement the MIFARE DESFire EVx Memory and Configuration Management related commands.

Function Documentation

phalMfdfEVx_FreeMem()

phStatus_t phalMfdfEVx_FreeMem	(	void *	pDataParams,
		uint8_t *	pMemInfo
	)

Returns free memory available on the PICC.

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.
[out]	pMemInfo	[Out] Current free memory available. Will be of 3 bytes with LSB first.

phalMfdfEVx_Format()

phStatus_t phalMfdfEVx_Format

(

void *

pDataParams

)

Releases the PICC user memory.

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.

phalMfdfEVx_SetConfiguration()

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

Configures the card and pre personalizes the card with a key, defines if the UID or the random ID is sent back during communication setup and configures the ATS string.

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] Configuration Option. PHAL_MFDFEVX_SET_CONFIG_OPTION0 PHAL_MFDFEVX_SET_CONFIG_OPTION1 PHAL_MFDFEVX_SET_CONFIG_OPTION2 PHAL_MFDFEVX_SET_CONFIG_OPTION3 PHAL_MFDFEVX_SET_CONFIG_OPTION4 PHAL_MFDFEVX_SET_CONFIG_OPTION5 PHAL_MFDFEVX_SET_CONFIG_OPTION6 PHAL_MFDFEVX_SET_CONFIG_OPTIONC
[in]	pData	[In] Data for the option specified.
[in]	bDataLen	[In] Length of bytes available in Data buffer.

phalMfdfEVx_GetVersion()

phStatus_t phalMfdfEVx_GetVersion	(	void *	pDataParams,
		uint8_t *	pVerInfo
	)

Returns manufacturing related data of the PICC.

Call phalMfdfEVx_GetConfig with PHAL_MFDFEVX_ADDITIONAL_INFO to the get the length of bytes available in VerInfo buffer.

Note

To get the Fabrication Identifier (FabID) as part of Part-3 response, perform Return of FabID configuration settings prior calling GetVersion interface.

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.
[out]	pVerInfo	[Out] The version information of the product.

phalMfdfEVx_GetCardUID()

phStatus_t phalMfdfEVx_GetCardUID	(	void *	pDataParams,
		uint8_t	bExchangeOption,
		uint8_t	bOption,
		uint8_t *	pUid
	)

Returns the Unique ID of the PICC.

Call phalMfdfEVx_GetConfig with PHAL_MFDFEVX_ADDITIONAL_INFO to the get the length of bytes available in UID buffer.

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]	bExchangeOption	[In] Flag to indicate whether the parameter information bOption to be exchanged to PICC or not. PHAL_MFDFEVX_GET_CARD_UID_EXCHANGE_OPTION_OFF PHAL_MFDFEVX_GET_CARD_UID_EXCHANGE_OPTION_ON
[in]	bOption	[In] One of the below options. PHAL_MFDFEVX_GET_CARD_UID_OPTION_NUID_NOT_RETURNED PHAL_MFDFEVX_GET_CARD_UID_OPTION_NUID_RETURNED
[out]	pUid	[Out] The complete UID of the PICC.