NXP NFC Reader Library v4.040.05.011646

NXP NFC Library Definitions
Simplified API Layer » NXP NFC Library Top Level API

Common defines used within the API of NFC library. More...

Collaboration diagram for NXP NFC Library Definitions:

## RF Technologies
Definitions used within phNfcLib_Activate and struct phNfcLib_PeerInfo_t
#define | PH_NFCLIB_TECHNOLOGY_DEFAULT 0x0UL
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_A (PH_NFCLIB_TECHNOLOGY_ISO_14443_A << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| ISO 14443-3A, Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_B (PH_NFCLIB_TECHNOLOGY_ISO_14443_B << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| ISO 14443-3B, Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_FELICA (PH_NFCLIB_TECHNOLOGY_FELICA << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| FELICA Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_15693 (PH_NFCLIB_TECHNOLOGY_ISO_15693 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| ISO 15693, Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18000_3_3 (PH_NFCLIB_TECHNOLOGY_ISO_18000_3_3 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| ISO 18000-3m3, Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18092 (PH_NFCLIB_TECHNOLOGY_ISO_18092 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)
| ISO 18092 active mode, Initiator mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_A (PH_NFCLIB_TECHNOLOGY_ISO_14443_A << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)
| ISO 14443-3A, Target mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_B (PH_NFCLIB_TECHNOLOGY_ISO_14443_B << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)
| ISO 14443-3B, Target mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_TARGET_FELICA (PH_NFCLIB_TECHNOLOGY_FELICA << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)
| FELICA Target mode RF technology. More...
#define | PH_NFCLIB_TECHNOLOGY_TARGET_ISO_18092 (PH_NFCLIB_TECHNOLOGY_ISO_18092 << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)
| ISO 18092 active mode, Target mode RF technology. More...

## Configuration Defaults
Definition used for default configuration mode
#define | PH_NFCLIB_ACTIVATION_BLOCKINGMODE_DEFAULT PH_ON
#define | PH_NFCLIB_DEACTIVATION_BLOCKINGMODE_DEFAULT PH_ON

## Activation Priority
Definitions used as values for phNfcLib_SetConfig_Value and phNfcLib_GetConfig when using configuration tag PH_NFCLIB_CONFIG_ACTIVATION_MERGED_SAK_PRIO
#define | PH_NFCLIB_ACTIVATION_MERGED_SAK_PRIO_14443 0x0U
| Priority given to ISO 14443.
#define | PH_NFCLIB_ACTIVATION_MERGED_SAK_PRIO_18092 0x1U
| Priority given to ISO 18092.

## Deactivation Mode
Definitions used within phNfcLib_DeActivate for bDeactivateMode parameter.
#define | PH_NFCLIB_DEACTIVATION_MODE_RF_OFF 0x0U
| No target deactivation procedure is performed, RF field is just switched off and wait for 5.1ms. More...
#define | PH_NFCLIB_DEACTIVATION_MODE_RELEASE 0x1U
| A target deactivation procedure is performed if applicable. More...

## Activation Profiles
Definitions used as values for phNfcLib_SetConfig_Value and phNfcLib_GetConfig when using configuration tag PH_NFCLIB_CONFIG_ACTIVATION_PROFILE
#define | PH_NFCLIB_ACTIVATION_PROFILE_NFC 0x0U
| NFC Forum Activation Loop Profile and NDEF communication channel. More...
#define | PH_NFCLIB_ACTIVATION_PROFILE_EMVCO 0x1U
| EMVCo Activation Loop Profile and ISO14443-4 communication channel.
#define | PH_NFCLIB_ACTIVATION_PROFILE_ISO 0x2U
| Generic ISO Activation Loop Profile and block/frame oriented communication channel (depending on underlying protocol)

## Simplified API Errors
#define | PH_NFCLIB_STATUS_SUCCESS (0x0UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_INVALID_STATE (0x1UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_INVALID_PARAMETER (0x2UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_BUFFER_OVERFLOW (0x4UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_ABORTED (0x8UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_INTERNAL_ERROR (0x10UL << PH_NFCLIB_STATUS_GROUP_GENERAL)
#define | PH_NFCLIB_STATUS_PEER_ACTIVATION_DONE (0x1UL << PH_NFCLIB_STATUS_GROUP_ACTIVATION)
#define | PH_NFCLIB_STATUS_MULTIPLE_PEERS_DETECTED (0x2UL << PH_NFCLIB_STATUS_GROUP_ACTIVATION)
#define | PH_NFCLIB_STATUS_PEER_ACTIVATION_FAILED (0x4UL << PH_NFCLIB_STATUS_GROUP_ACTIVATION)
#define | PH_NFCLIB_STATUS_NO_PEER_DISCOVERED (0x8UL << PH_NFCLIB_STATUS_GROUP_ACTIVATION)
#define | PH_NFCLIB_STATUS_PEER_DEACTIVATION_FAILED (0x10UL << PH_NFCLIB_STATUS_GROUP_ACTIVATION)
#define | PH_NFCLIB_STATUS_RF_TRANSMISSION_ERROR (0x1UL << PH_NFCLIB_STATUS_GROUP_RF_COMMUNICATION)
#define | PH_NFCLIB_STATUS_RF_TIMEOUT_ERROR (0x2UL << PH_NFCLIB_STATUS_GROUP_RF_COMMUNICATION)
#define | PH_NFCLIB_STATUS_RF_PROTOCOL_ERROR (0x4UL << PH_NFCLIB_STATUS_GROUP_RF_COMMUNICATION)
#define | PH_NFCLIB_STATUS_RF_PEER_LOST (0x8UL << PH_NFCLIB_STATUS_GROUP_RF_COMMUNICATION)

## Detailed Description

Common defines used within the API of NFC library.

## Macro Definition Documentation

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_A

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_A (PH_NFCLIB_TECHNOLOGY_ISO_14443_A << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

ISO 14443-3A, Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_B

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_14443_B (PH_NFCLIB_TECHNOLOGY_ISO_14443_B << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

ISO 14443-3B, Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_FELICA

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_FELICA (PH_NFCLIB_TECHNOLOGY_FELICA << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

FELICA Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_15693

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_15693 (PH_NFCLIB_TECHNOLOGY_ISO_15693 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

ISO 15693, Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18000_3_3

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18000_3_3 (PH_NFCLIB_TECHNOLOGY_ISO_18000_3_3 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

ISO 18000-3m3, Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18092

#define PH_NFCLIB_TECHNOLOGY_INITIATOR_ISO_18092 (PH_NFCLIB_TECHNOLOGY_ISO_18092 << PH_NFCLIB_TECHNOLOGY_ROLE_INITIATOR_SHIFT)

ISO 18092 active mode, Initiator mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_A

#define PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_A (PH_NFCLIB_TECHNOLOGY_ISO_14443_A << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)

ISO 14443-3A, Target mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_B

#define PH_NFCLIB_TECHNOLOGY_TARGET_ISO_14443_B (PH_NFCLIB_TECHNOLOGY_ISO_14443_B << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)

ISO 14443-3B, Target mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_TARGET_FELICA

#define PH_NFCLIB_TECHNOLOGY_TARGET_FELICA (PH_NFCLIB_TECHNOLOGY_FELICA << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)

FELICA Target mode RF technology.

## § PH_NFCLIB_TECHNOLOGY_TARGET_ISO_18092

#define PH_NFCLIB_TECHNOLOGY_TARGET_ISO_18092 (PH_NFCLIB_TECHNOLOGY_ISO_18092 << PH_NFCLIB_TECHNOLOGY_ROLE_TARGET_SHIFT)

ISO 18092 active mode, Target mode RF technology.

## § PH_NFCLIB_DEACTIVATION_MODE_RF_OFF

#define PH_NFCLIB_DEACTIVATION_MODE_RF_OFF 0x0U

No target deactivation procedure is performed, RF field is just switched off and wait for 5.1ms.

## § PH_NFCLIB_DEACTIVATION_MODE_RELEASE

#define PH_NFCLIB_DEACTIVATION_MODE_RELEASE 0x1U

A target deactivation procedure is performed if applicable.

(Example, in case of activation profile PH_NFCLIB_ACTIVATION_PROFILE_EMVCO this means the removal procedure is performed. In other profiles this could imply execution of deactivation procedures like DSL_REQ.) RF field is not switched off. phNfcLib_DeActivate should be called with PH_NFCLIB_DEACTIVATION_MODE_RF_OFF to switch off RF field.

## § PH_NFCLIB_ACTIVATION_PROFILE_NFC

#define PH_NFCLIB_ACTIVATION_PROFILE_NFC 0x0U

NFC Forum Activation Loop Profile and NDEF communication channel.

Warning
  NFC Profile is not implementend/available in this release.