NXP NFC Reader Library v4.040.05.011646

Macros
NXP NFC Library Configuration Tags
Simplified API Layer » NXP NFC Library Top Level API

These tags are used as `bConfigTag` parameter for phNfcLib_SetConfig_Value, phNfcLib_SetConfig and phNfcLib_GetConfig. More...

Collaboration diagram for NXP NFC Library Configuration Tags:

## Macros
#define | PH_NFCLIB_CONFIG_ACTIVATION_MERGED_SAK_PRIO 0x3U

## Tags Activation
Activation Influencing Configuration Tags
#define | PH_NFCLIB_CONFIG_ACTIVATION_BLOCKING 0x0U
#define | PH_NFCLIB_CONFIG_ACTIVATION_TARGET_PAUSE_TIME 0x1U
| This configuration parameter specifies the time in milliseconds the activation procedure, or in fact its internal discovery loop, should wait in target/listen phase or in pause phase (in case no target technology is specified.) These two phases are following the initiator/poll phase, i.e. More...
#define | PH_NFCLIB_CONFIG_ACTIVATION_PROFILE 0x2U

## Detailed Description

These tags are used as `bConfigTag` parameter for phNfcLib_SetConfig_Value, phNfcLib_SetConfig and phNfcLib_GetConfig.

## Macro Definition Documentation

## § PH_NFCLIB_CONFIG_ACTIVATION_BLOCKING

#define PH_NFCLIB_CONFIG_ACTIVATION_BLOCKING 0x0U

This configuration parameter indicates if the activation procedure (in fact phNfcLib_Activate) should return only on successful activation or if it should return after every activation loop iteration.

Parameter Size
  1 Byte (`uint8_t`)

Allowed Values
  - `PH_OFF` Activation procedure is not blocking, i.e. phNfcLib_Activate returns after every iteration of its internal discovery loop.
  - `PH_ON` Activation procedure is blocking, i.e. phNfcLib_Activate only returns upon successful activation or in case of an activation related error (e.g. collision can't be resolved).

Default Value
  `PH_ON`

## § PH_NFCLIB_CONFIG_ACTIVATION_TARGET_PAUSE_TIME

#define PH_NFCLIB_CONFIG_ACTIVATION_TARGET_PAUSE_TIME 0x1U

This configuration parameter specifies the time in milliseconds the activation procedure, or in fact its internal discovery loop, should wait in target/listen phase or in pause phase (in case no target technology is specified.) These two phases are following the initiator/poll phase, i.e.

the total duration of one discovery loop iteration is this target/pause time + time required for executing the polling phase.

Parameter Size
  2 Byte (`uint16_t`)

Allowed Value Range
  `0` - `65535`

Default Value
  `1000`

Example
  phNfcLib_SetConfig_Value(PH_NFCLIB_CONFIG_ACTIVATION_TARGET_PAUSE_TIME, 1000); // 1sec

## § PH_NFCLIB_CONFIG_ACTIVATION_PROFILE

#define PH_NFCLIB_CONFIG_ACTIVATION_PROFILE 0x2U

This configuration parameter is used to select the profile to be used when running the activation. Depending on the profile the behavior of activation procedure (guard times, discovery loop execution order) is adapted.

Transmission Channel Mapping
  This setting also defines how phNfcLib_Transmit and phNfcLib_Receive are mapped on the transmission channel:
  - PH_NFCLIB_ACTIVATION_PROFILE_ISO establishes a raw communication channel, i.e. data is transmitted in blocks/frames as defined by the corresponding standard. For ISO14443 this refers to Layer 4 block oriented half duplex protocol, for ISO18092 it refers to the half duplex data exchange protocol, for all other protocols (FELICA, ISO15693, ISO18000, Mifare Ultralight etc.) the data is encapsulated in frames of the respective standard.
  - PH_NFCLIB_ACTIVATION_PROFILE_EMVCO Here only ISO14443 layer 4 block oriented half duplex protocol is supported.
  - PH_NFCLIB_ACTIVATION_PROFILE_NFC Here the data is sent is actually a well formatted NDEF record. The NFC library in this case performs the NDEF detection procedure. If the tag is not formatted yet, it will be automatically formatted. Existing data will be replaced.

Parameter Size
  1 Byte (uint8_t)

Allowed Values
  Refer to nfc_lib_definitions_activation_profile

Example
  phNfcLib_SetConfig_Value(PH_NFCLIB_CONFIG_ACTIVATION_PROFILE, PH_NFCLIB_ACTIVATION_PROFILE_EMVCO); // set EMVCo Profile

## § PH_NFCLIB_CONFIG_ACTIVATION_MERGED_SAK_PRIO

#define PH_NFCLIB_CONFIG_ACTIVATION_MERGED_SAK_PRIO 0x3U

This configuration parameter is used set the activation priority in case a peer indicate a 'merged SAK', i.e. peer supports both, ISO18092 and ISO14443 Layer 4. Depending on this parameter, activation procedure then activates the protocol indicated by its value.

Parameter Size
  1 Byte (`uint8_t`)

Allowed Values
  Refer to nfc_lib_definitions_activation_priority

Default Value
  PH_NFCLIB_ACTIVATION_MERGED_SAK_PRIO_14443