NXP Reader Library  v17.1.0.2535

Sam Custom Error Codes for the respective status codes returned by Sam hardware. More...

Collaboration diagram for ErrorCodes_Mapped:

Macros

#define PHHAL_HW_SAM_ERR_HW_EEPROM   (PH_ERR_CUSTOM_BEGIN + 0U)
 SAM Custom error code - EEProm failure. More...
 
#define PHHAL_HW_SAM_ERR_HW_RC5XX   (PH_ERR_CUSTOM_BEGIN + 1U)
 SAM Custom error code - Reader IC interface error. More...
 
#define PHHAL_HW_SAM_ERR_KEY_CREATE_FAILED   (PH_ERR_CUSTOM_BEGIN + 2U)
 SAM Custom error code - Key creation failure. More...
 
#define PHHAL_HW_SAM_ERR_KEY_REF_NO_INVALID   (PH_ERR_CUSTOM_BEGIN + 3U)
 SAM Custom error code - Key reference number invalid. More...
 
#define PHHAL_HW_SAM_ERR_KEY_KUC_NO_INVALID   (PH_ERR_CUSTOM_BEGIN + 4U)
 SAM Custom error code - Key usage counter number invalid. More...
 
#define PHHAL_HW_SAM_ERR_HW_EE_HIGH_VOLTAGE   (PH_ERR_CUSTOM_BEGIN + 5U)
 SAM Custom error code - EEPROM high voltage failure; SAM permanently disabled. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_LENGTH_LC   (PH_ERR_CUSTOM_BEGIN + 6U)
 SAM Custom error code - Wrong length of the APDU or wrong LC byte. More...
 
#define PHHAL_HW_SAM_ERR_INCOMPLETE_CHAINING   (PH_ERR_CUSTOM_BEGIN + 7U)
 SAM Custom error code - Final chained command expected; running command aborted, new command ignored This error represents SAM's PHHAL_HW_SAM_RET_CODE_INCOMPLETE_CHAINING error.
 
#define PHHAL_HW_SAM_ERR_UNMATCHING_PCD_PD   (PH_ERR_CUSTOM_BEGIN + 8U)
 SAM Custom error code - [If AuthenticateFirst] Un-matching PCD/PD capabilities This error represents SAM's PHHAL_HW_SAM_RET_CODE_UNMATCHING_PCD_PD error.
 
#define PHHAL_HW_SAM_ERR_KEY_INTEGRITY_ERROR   (PH_ERR_CUSTOM_BEGIN + 9U)
 SAM Custom error code - One of the following. More...
 
#define PHHAL_HW_SAM_ERR_COND_USE_NOT_SATISFIED   (PH_ERR_CUSTOM_BEGIN + 10U)
 SAM Custom error code - Conditions of use not satisfied. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_COMMAND_NOT_ALLOWED   (PH_ERR_CUSTOM_BEGIN + 11U)
 SAM Custom error code - Command not allowed. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_PARAMS_FOR_INS   (PH_ERR_CUSTOM_BEGIN + 12U)
 SAM Custom error code - Unexpected RFU bit(s) value(s) in data field parameter. More...
 
#define PHHAL_HW_SAM_ERR_KEY_VERSION_INVALID   (PH_ERR_CUSTOM_BEGIN + 13U)
 SAM Custom error code - No valid key version found. More...
 
#define PHHAL_HW_SAM_ERR_HOST_PROTECTION   (PH_ERR_CUSTOM_BEGIN + 14U)
 SAM Custom error code - SAM Host protection error. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_P1P2   (PH_ERR_CUSTOM_BEGIN + 15U)
 SAM Custom error code - Incorrect value for parameter P1 and/or P2. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_LE   (PH_ERR_CUSTOM_BEGIN + 16U)
 SAM Custom error code - Incorrect LE value. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_INS   (PH_ERR_CUSTOM_BEGIN + 17U)
 SAM Custom error code - Instruction code not supported or invalid or not available in the current state of the SAM. More...
 
#define PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_CLASS   (PH_ERR_CUSTOM_BEGIN + 18U)
 SAM Custom error code - Class not supported. More...
 
#define PHHAL_HW_SAM_ERR_CRYPTO   (PH_ERR_CUSTOM_BEGIN + 19U)
 SAM Custom error code - MAC verification failed. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_PLUS_INCORRECT_DATA   (PH_ERR_CUSTOM_BEGIN + 20U)
 SAM Custom error code - MIFARE PICC sent incorrect amount of data (for example wrong length of MAC) This error represents SAM's PHHAL_HW_SAM_RET_CODE_MIFARE_PLUS_INCORRECT_DATA error.
 
#define PHHAL_HW_SAM_ERR_MIFARE_PLUS_GEN   (PH_ERR_CUSTOM_BEGIN + 21U)
 SAM Custom error code - Correct SAM execution but MFP response is an error return code This error represents SAM's PHHAL_HW_SAM_RET_CODE_MIFARE_PLUS_ERROR error.
 
#define PHHAL_HW_SAM_ERR_ISO_UID_INCOMPLETE   (PH_ERR_CUSTOM_BEGIN + 22U)
 SAM Custom error code - Correct execution - UID not complete (selection sequence has to be continued) This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO_UID_INCOMPLETE error.
 
#define PHHAL_HW_SAM_ERR_DESFIRE_GEN   (PH_ERR_CUSTOM_BEGIN + 23U)
 SAM Custom error code - Correct execution, DESFire returned error or incorrect length This error represents SAM's PHHAL_HW_SAM_RET_CODE_DESFIRE_ERROR error.
 
#define PHHAL_HW_SAM_ERR_ISO_WRONG_BNR   (PH_ERR_CUSTOM_BEGIN + 24U)
 SAM Custom error code - Incorrect block number This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO_WRONG_BNR error.
 
#define PHHAL_HW_SAM_ERR_ISO_INVALID_FORMAT   (PH_ERR_CUSTOM_BEGIN + 25U)
 SAM Custom error code - Status - One of the following. More...
 
#define PHHAL_HW_SAM_ERR_ISO_INVALID_PARAMETER   (PH_ERR_CUSTOM_BEGIN + 26U)
 SAM Custom error code - One of the following. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_GEN   (PH_ERR_CUSTOM_BEGIN + 27U)
 SAM Custom error code - Correct execution but PICC response is an error return code. More...
 
#define PHHAL_HW_SAM_ERR_OK_CHAINING_ACTIVE   (PH_ERR_CUSTOM_BEGIN + 28U)
 SAM Custom error code - Correct execution - more data expected This error represents SAM's PHHAL_HW_SAM_RET_CODE_OK_CHAINING_ACTIVE error.
 
#define PHHAL_HW_SAM_ERR_COMMAND_CHAINING_NOT_SUPPORTED   (PH_ERR_CUSTOM_BEGIN + 29U)
 SAM Custom error code - [If MFP command] Command-chaining not supported This error represents SAM's PHHAL_HW_SAM_RET_CODE_COMMAND_CHAINING_NOT_SUPPORTED error.
 
#define PHHAL_HW_SAM_ERR_UNKNOWN_PUBLIC_KEY_INDEX   (PH_ERR_CUSTOM_BEGIN + 30U)
 SAM Custom error code - Unknown Public Key Index when trying to update This error represents SAM's PHHAL_HW_SAM_RET_CODE_UNKNOWN_PUBLIC_KEY_INDEX error.
 
#define PHHAL_HW_SAM_ERR_NO_PRECISE_DIAGNOSIS   (PH_ERR_CUSTOM_BEGIN + 31U)
 SAM Custom error code - No precise diagnosis (physical address invalid, EEPROM error, no correct key loaded for cryptographic operation, improper length for cryptographic operation, internal limit exceeded...) This error represents SAM's PHHAL_HW_SAM_RET_CODE_NO_PRECISE_DIAGNOSIS error.
 
#define PHHAL_HW_SAM_ERR_PROGRAMMABLE_LOGIC   (PH_ERR_CUSTOM_BEGIN + 32U)
 SAM Custom error code - Programmable Logic error. More...
 
#define PHHAL_HW_SAM_ERR_OK_CHAINING_ACTIVE_EXT   (PH_ERR_CUSTOM_BEGIN + 33U)
 SAM Custom error code - Correct execution - Correct execution - more data expected (SAM-Host secure messaging to be applied on each command exchange) This error represents SAM's PHHAL_HW_SAM_RET_CODE_OK_CHAINING_ACTIVE_EXT error.
 
#define PHHAL_HW_SAM_ERR_ISO_UID_BCC_INCORRECT   (PH_ERR_CUSTOM_BEGIN + 34U)
 SAM Custom error code - UID check byte (BCC) incorrect. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK0   (PH_ERR_CUSTOM_BEGIN + 35U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK1   (PH_ERR_CUSTOM_BEGIN + 36U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK4   (PH_ERR_CUSTOM_BEGIN + 37U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK5   (PH_ERR_CUSTOM_BEGIN + 38U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK6   (PH_ERR_CUSTOM_BEGIN + 39U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_MIFARE_NAK7   (PH_ERR_CUSTOM_BEGIN + 40U)
 SAM Custom error code - NACK received from PICC. More...
 
#define PHHAL_HW_SAM_ERR_OK_CHAINING_ACTIVE_DUOX   (PH_ERR_CUSTOM_BEGIN + 41U)
 SAM Custom error code - Correct Execution with Cert.A - more data remaining This error represents SAM's PHHAL_HW_SAM_RET_CODE_OK_CHAINING_ACTIVE_DUOX error.
 

Detailed Description

Sam Custom Error Codes for the respective status codes returned by Sam hardware.

Macro Definition Documentation

◆ PHHAL_HW_SAM_ERR_HW_EEPROM

#define PHHAL_HW_SAM_ERR_HW_EEPROM   (PH_ERR_CUSTOM_BEGIN + 0U)

SAM Custom error code - EEProm failure.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_HW_EEPROM error.

◆ PHHAL_HW_SAM_ERR_HW_RC5XX

#define PHHAL_HW_SAM_ERR_HW_RC5XX   (PH_ERR_CUSTOM_BEGIN + 1U)

SAM Custom error code - Reader IC interface error.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_HW_RC5XX error.

◆ PHHAL_HW_SAM_ERR_KEY_CREATE_FAILED

#define PHHAL_HW_SAM_ERR_KEY_CREATE_FAILED   (PH_ERR_CUSTOM_BEGIN + 2U)

SAM Custom error code - Key creation failure.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_KEY_CREATE_FAILED error.

◆ PHHAL_HW_SAM_ERR_KEY_REF_NO_INVALID

#define PHHAL_HW_SAM_ERR_KEY_REF_NO_INVALID   (PH_ERR_CUSTOM_BEGIN + 3U)

SAM Custom error code - Key reference number invalid.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_KEY_REF_NO_INVALID error.

◆ PHHAL_HW_SAM_ERR_KEY_KUC_NO_INVALID

#define PHHAL_HW_SAM_ERR_KEY_KUC_NO_INVALID   (PH_ERR_CUSTOM_BEGIN + 4U)

SAM Custom error code - Key usage counter number invalid.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_KEY_KUC_NO_INVALID error.

◆ PHHAL_HW_SAM_ERR_HW_EE_HIGH_VOLTAGE

#define PHHAL_HW_SAM_ERR_HW_EE_HIGH_VOLTAGE   (PH_ERR_CUSTOM_BEGIN + 5U)

SAM Custom error code - EEPROM high voltage failure; SAM permanently disabled.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_HW_EE_HIGH_VOLTAGE error.

◆ PHHAL_HW_SAM_ERR_ISO7816_WRONG_LENGTH_LC

#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_LENGTH_LC   (PH_ERR_CUSTOM_BEGIN + 6U)

SAM Custom error code - Wrong length of the APDU or wrong LC byte.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_WRONG_LENGTH_LC error.

◆ PHHAL_HW_SAM_ERR_KEY_INTEGRITY_ERROR

#define PHHAL_HW_SAM_ERR_KEY_INTEGRITY_ERROR   (PH_ERR_CUSTOM_BEGIN + 9U)

SAM Custom error code - One of the following.

  • CRC mismatch; wrong key handling buffer size
  • HostRespData received from programmable logic is not multiple of 16 bytes, while chaining applying HostMode.Full is ongoing This error represents SAM's PHHAL_HW_SAM_RET_CODE_KEY_INTEGRITY_ERROR error.

◆ PHHAL_HW_SAM_ERR_COND_USE_NOT_SATISFIED

#define PHHAL_HW_SAM_ERR_COND_USE_NOT_SATISFIED   (PH_ERR_CUSTOM_BEGIN + 10U)

SAM Custom error code - Conditions of use not satisfied.

Multiple meaning for this status, refer the command for actual information. This error represents SAM's PHHAL_HW_SAM_RET_CODE_COND_USE_NOT_SATISFIED error.

◆ PHHAL_HW_SAM_ERR_ISO7816_COMMAND_NOT_ALLOWED

#define PHHAL_HW_SAM_ERR_ISO7816_COMMAND_NOT_ALLOWED   (PH_ERR_CUSTOM_BEGIN + 11U)

SAM Custom error code - Command not allowed.

Multiple meaning for this status, refer the command for actual information. This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_COMMAND_NOT_ALLOWED error.

◆ PHHAL_HW_SAM_ERR_ISO7816_WRONG_PARAMS_FOR_INS

#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_PARAMS_FOR_INS   (PH_ERR_CUSTOM_BEGIN + 12U)

SAM Custom error code - Unexpected RFU bit(s) value(s) in data field parameter.

Multiple meaning for this status, refer the command for actual information. This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_WRONG_PARAMS_FOR_INS error.

◆ PHHAL_HW_SAM_ERR_KEY_VERSION_INVALID

#define PHHAL_HW_SAM_ERR_KEY_VERSION_INVALID   (PH_ERR_CUSTOM_BEGIN + 13U)

SAM Custom error code - No valid key version found.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_KEY_VERSION_INVALID error.

◆ PHHAL_HW_SAM_ERR_HOST_PROTECTION

#define PHHAL_HW_SAM_ERR_HOST_PROTECTION   (PH_ERR_CUSTOM_BEGIN + 14U)

SAM Custom error code - SAM Host protection error.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_HOST_PROTECTION_ERROR error.

◆ PHHAL_HW_SAM_ERR_ISO7816_WRONG_P1P2

#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_P1P2   (PH_ERR_CUSTOM_BEGIN + 15U)

SAM Custom error code - Incorrect value for parameter P1 and/or P2.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_WRONG_P1P2 error.

◆ PHHAL_HW_SAM_ERR_ISO7816_WRONG_LE

#define PHHAL_HW_SAM_ERR_ISO7816_WRONG_LE   (PH_ERR_CUSTOM_BEGIN + 16U)

SAM Custom error code - Incorrect LE value.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_WRONG_LE error.

◆ PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_INS

#define PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_INS   (PH_ERR_CUSTOM_BEGIN + 17U)

SAM Custom error code - Instruction code not supported or invalid or not available in the current state of the SAM.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_UNKNOWN_INS error.

◆ PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_CLASS

#define PHHAL_HW_SAM_ERR_ISO7816_UNKNOWN_CLASS   (PH_ERR_CUSTOM_BEGIN + 18U)

SAM Custom error code - Class not supported.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO7816_WRONG_CLASS error.

◆ PHHAL_HW_SAM_ERR_CRYPTO

#define PHHAL_HW_SAM_ERR_CRYPTO   (PH_ERR_CUSTOM_BEGIN + 19U)

SAM Custom error code - MAC verification failed.

Multiple meaning for this status, refer the command for actual information. This error represents SAM's PHHAL_HW_SAM_RET_CODE_CRYPTO_FAILURE error.

◆ PHHAL_HW_SAM_ERR_ISO_INVALID_FORMAT

#define PHHAL_HW_SAM_ERR_ISO_INVALID_FORMAT   (PH_ERR_CUSTOM_BEGIN + 25U)

SAM Custom error code - Status - One of the following.

  • ATS length byte does not match actual length of received ATS or PPS response invalid (incorrect length or PPSS byte)
  • Block length or PCB invalid
  • Incorrect (no R-block or I-block) answer received This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO_INVALID_FORMAT error.

◆ PHHAL_HW_SAM_ERR_ISO_INVALID_PARAMETER

#define PHHAL_HW_SAM_ERR_ISO_INVALID_PARAMETER   (PH_ERR_CUSTOM_BEGIN + 26U)

SAM Custom error code - One of the following.

  • User buffer length below ISO14443-4 minimum
  • Invalid UID bit count (too many bits received)
  • CID, NAD either not expected, missing or incorrect This error represents SAM's PHHAL_HW_SAM_RET_CODE_ISO_INVALID_PARAMETER error.

◆ PHHAL_HW_SAM_ERR_MIFARE_GEN

#define PHHAL_HW_SAM_ERR_MIFARE_GEN   (PH_ERR_CUSTOM_BEGIN + 27U)

SAM Custom error code - Correct execution but PICC response is an error return code.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_ERROR error.

◆ PHHAL_HW_SAM_ERR_PROGRAMMABLE_LOGIC

#define PHHAL_HW_SAM_ERR_PROGRAMMABLE_LOGIC   (PH_ERR_CUSTOM_BEGIN + 32U)

SAM Custom error code - Programmable Logic error.

Error code returned by SAM_PLExec command. This error represents SAM's ISOXXXX error.

◆ PHHAL_HW_SAM_ERR_ISO_UID_BCC_INCORRECT

#define PHHAL_HW_SAM_ERR_ISO_UID_BCC_INCORRECT   (PH_ERR_CUSTOM_BEGIN + 34U)

SAM Custom error code - UID check byte (BCC) incorrect.

This error represents SAM's PHHAL_HW_SAM_RET_CODE_UID_BCC_INCORRECT error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK0

#define PHHAL_HW_SAM_ERR_MIFARE_NAK0   (PH_ERR_CUSTOM_BEGIN + 35U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 0 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK0 error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK1

#define PHHAL_HW_SAM_ERR_MIFARE_NAK1   (PH_ERR_CUSTOM_BEGIN + 36U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 1 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK1 error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK4

#define PHHAL_HW_SAM_ERR_MIFARE_NAK4   (PH_ERR_CUSTOM_BEGIN + 37U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 4 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK4 error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK5

#define PHHAL_HW_SAM_ERR_MIFARE_NAK5   (PH_ERR_CUSTOM_BEGIN + 38U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 5 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK5 error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK6

#define PHHAL_HW_SAM_ERR_MIFARE_NAK6   (PH_ERR_CUSTOM_BEGIN + 39U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 6 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK6 error.

◆ PHHAL_HW_SAM_ERR_MIFARE_NAK7

#define PHHAL_HW_SAM_ERR_MIFARE_NAK7   (PH_ERR_CUSTOM_BEGIN + 40U)

SAM Custom error code - NACK received from PICC.

MIFARE NACK 7 received. This error represents SAM's PHHAL_HW_SAM_RET_CODE_PROT_MIFARE_NAK7 error.