NXP Reader Library  v17.1.0.2535
Commands_MemoryConfiguration

Describes about the MIFARE DUOX Memory and Configuration Management commands. More...

Collaboration diagram for Commands_MemoryConfiguration:

Modules

 Defines
 Macro Definitions for Memory and Configuration Management commands.
 

Functions

phStatus_t phalMfDuoX_FreeMem (void *pDataParams, uint8_t **ppMemInfo, uint16_t *pMemInfoLen)
 Returns free memory available on the PICC. More...
 
phStatus_t phalMfDuoX_Format (void *pDataParams)
 Releases the PICC user memory. More...
 
phStatus_t phalMfDuoX_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 phalMfDuoX_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 phalMfDuoX_GetVersion (void *pDataParams, uint8_t bOption, uint8_t **ppVersion, uint16_t *pVerLen)
 Returns manufacturing related data of the PICC. More...
 
phStatus_t phalMfDuoX_GetCardUID (void *pDataParams, uint8_t **ppUid, uint16_t *pUidLen)
 Returns the Unique Identifier of the PICC. More...
 

Detailed Description

Describes about the MIFARE DUOX Memory and Configuration Management commands.

Function Documentation

◆ phalMfDuoX_FreeMem()

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

Returns free memory available on the PICC.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETERIf the buffer is null.
XXXX
  • Depending on status codes return by PICC.
  • 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.

◆ phalMfDuoX_Format()

phStatus_t phalMfDuoX_Format ( void *  pDataParams)

Releases the PICC user memory.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf any of the DataParams are null.
XXXX
  • Depending on status codes return by PICC.
  • Other Depending on implementation and underlying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.

◆ phalMfDuoX_SetConfiguration()

phStatus_t phalMfDuoX_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_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETERIf the buffer is null.
XXXX
  • Depending on status codes return by PICC.
  • 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.

◆ phalMfDuoX_GetConfiguration()

phStatus_t phalMfDuoX_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_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETER
  • If the buffer is null.
  • For Invalid ExchangeOption (bExchangeOption) value.
XXXX
  • Depending on status codes return by PICC.
  • 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 PICC.
  • OFF: Do not exchange Option information to PICC.
  • ON : Exchange Option information to PICC.
[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.

◆ phalMfDuoX_GetVersion()

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

Returns manufacturing related data of the PICC.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETERIf the buffer is null.
XXXX
  • Depending on status codes return by PICC.
  • 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,
[out]ppVersion[Out] Returns the complete version information of the PICC. 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.

◆ phalMfDuoX_GetCardUID()

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

Returns the Unique Identifier of the PICC.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETERIf the buffer is null.
XXXX
  • Depending on status codes return by PICC.
  • 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 PICC.
[out]pUidLen[Out] Length of bytes available in ppUid buffer.