nrfx 3.3
Data Structures | Macros | Functions
NFCT HALY

Hardware access layer with cache and barrier support for managing the NFCT peripheral. More...

Data Structures

struct  nrfy_nfct_parameters_t
 NFCT parameters storage structure. More...
 

Macros

#define NRFY_NFCT_HAS_MODULATION_PSEL_REG   1
 
#define NRFY_NFCT_HAS_MODULATION_CTRL_REG   1
 
#define NRFY_NFCT_HAS_TAG_STATE_REG   1
 
#define NRFY_NFCT_HAS_SLEEP_STATE_REG   1
 
#define NRFY_NFCT_HAS_AUTOCOLRES_CONFIG_REG   1
 
#define NRFY_NFCT_HAS_PAD_CONFIG_REG   1
 
#define NRFY_NFCT_HAS_BIAS_CONFIG_TRIM_REG   1
 

Functions

NRFY_STATIC_INLINE void nrfy_nfct_int_init (NRF_NFCT_Type *p_reg, uint32_t mask, uint8_t irq_priority, bool enable)
 Function for initializing the specified NFCT interrupts.
 
NRFY_STATIC_INLINE void nrfy_nfct_int_uninit (NRF_NFCT_Type *p_reg)
 Function for un-initializing the NFCT interrupts.
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_events_process (NRF_NFCT_Type *p_reg, uint32_t mask)
 Function for processing the specified NFCT events.
 
NRFY_STATIC_INLINE void nrfy_nfct_parameters_save (NRF_NFCT_Type const *p_reg, nrfy_nfct_parameters_t *p_params)
 Function for saving NFCT parameters before peripheral reset.
 
NRFY_STATIC_INLINE void nrfy_nfct_parameters_restore (NRF_NFCT_Type *p_reg, nrfy_nfct_parameters_t const *p_params)
 Function for restoring NFCT parameters after peripheral reset. The parameters are written back to the peripheral registers.
 
NRFY_STATIC_INLINE void nrfy_nfct_rxtx_buffer_set (NRF_NFCT_Type *p_reg, uint8_t *p_rxtx_buf, uint16_t max_txrx_len, bool rx)
 Function for setting the the NFCT RX/TX buffer (address and maximum length).
 
NRFY_STATIC_INLINE void nrfy_nfct_task_trigger (NRF_NFCT_Type *p_reg, nrf_nfct_task_t task)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_task_address_get (NRF_NFCT_Type const *p_reg, nrf_nfct_task_t task)
 
NRFY_STATIC_INLINE void nrfy_nfct_event_clear (NRF_NFCT_Type *p_reg, nrf_nfct_event_t event)
 
NRFY_STATIC_INLINE bool nrfy_nfct_event_check (NRF_NFCT_Type const *p_reg, nrf_nfct_event_t event)
 
NRFY_STATIC_INLINE void nrfy_nfct_shorts_enable (NRF_NFCT_Type *p_reg, uint32_t short_mask)
 
NRFY_STATIC_INLINE void nrfy_nfct_shorts_disable (NRF_NFCT_Type *p_reg, uint32_t short_mask)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_shorts_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_shorts_set (NRF_NFCT_Type *p_reg, uint32_t short_mask)
 
NRFY_STATIC_INLINE void nrfy_nfct_int_enable (NRF_NFCT_Type *p_reg, uint32_t mask)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_int_enable_check (NRF_NFCT_Type const *p_reg, uint32_t mask)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_int_enable_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_int_disable (NRF_NFCT_Type *p_reg, uint32_t mask)
 
NRFY_STATIC_INLINE void nrfy_nfct_mod_ctrl_pin_set (NRF_NFCT_Type *p_reg, uint32_t mod_ctrl_pin)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_mod_ctrl_pin_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_modulation_output_set (NRF_NFCT_Type *p_reg, nrf_nfct_modulation_ctrl_t mod_ctrl)
 
NRFY_STATIC_INLINE nrf_nfct_modulation_ctrl_t nrfy_nfct_modulation_output_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_error_status_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_error_status_clear (NRF_NFCT_Type *p_reg, uint32_t error_flag)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_rx_frame_status_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_rx_frame_status_clear (NRF_NFCT_Type *p_reg, uint32_t framestatus_flags)
 
NRFY_STATIC_INLINE nrf_nfct_tag_state_t nrfy_nfct_tag_state_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE nrf_nfct_sleep_state_t nrfy_nfct_sleep_state_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE uint8_t nrfy_nfct_field_status_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE uint16_t nrfy_nfct_frame_delay_min_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_min_set (NRF_NFCT_Type *p_reg, uint16_t frame_delay_min)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_frame_delay_max_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_max_set (NRF_NFCT_Type *p_reg, uint32_t frame_delay_max)
 
NRFY_STATIC_INLINE nrf_nfct_frame_delay_mode_t nrfy_nfct_frame_delay_mode_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_mode_set (NRF_NFCT_Type *p_reg, nrf_nfct_frame_delay_mode_t frame_delay_mode)
 
NRFY_STATIC_INLINE uint8_t * nrfy_nfct_rxtx_buffer_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE uint16_t nrfy_nfct_max_rxtx_length_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE uint8_t nrfy_nfct_tx_frame_config_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_tx_frame_config_set (NRF_NFCT_Type *p_reg, uint8_t flags)
 
NRFY_STATIC_INLINE uint16_t nrfy_nfct_tx_bits_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_tx_bits_set (NRF_NFCT_Type *p_reg, uint16_t tx_bits)
 
NRFY_STATIC_INLINE uint8_t nrfy_nfct_rx_frame_config_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_rx_frame_config_set (NRF_NFCT_Type *p_reg, uint8_t flags)
 
NRFY_STATIC_INLINE uint16_t nrfy_nfct_rx_bits_get (NRF_NFCT_Type const *p_reg, bool crc_excluded)
 
NRFY_STATIC_INLINE nrf_nfct_sensres_nfcid1_size_t nrfy_nfct_nfcid1_get (NRF_NFCT_Type const *p_reg, uint8_t *p_nfcid1_buf)
 
NRFY_STATIC_INLINE void nrfy_nfct_nfcid1_set (NRF_NFCT_Type *p_reg, uint8_t const *p_nfcid1_buf, nrf_nfct_sensres_nfcid1_size_t nfcid1_size)
 
NRFY_STATIC_INLINE bool nrfy_nfct_autocolres_is_enabled (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_autocolres_enable (NRF_NFCT_Type *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_autocolres_disable (NRF_NFCT_Type *p_reg)
 
NRFY_STATIC_INLINE nrf_nfct_sensres_nfcid1_size_t nrfy_nfct_sensres_nfcid1_size_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_sensres_nfcid1_size_set (NRF_NFCT_Type *p_reg, nrf_nfct_sensres_nfcid1_size_t nfcid1_size)
 
NRFY_STATIC_INLINE nrf_nfct_sensres_bit_frame_sdd_t nrfy_nfct_sensres_bit_frame_sdd_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_sensres_bit_frame_sdd_set (NRF_NFCT_Type *p_reg, nrf_nfct_sensres_bit_frame_sdd_t bit_frame_sdd)
 
NRFY_STATIC_INLINE nrf_nfct_sensres_platform_config_t nrfy_nfct_sensres_platform_config_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_sensres_platform_config_set (NRF_NFCT_Type *p_reg, nrf_nfct_sensres_platform_config_t platform_config)
 
NRFY_STATIC_INLINE bool nrfy_nfct_selres_cascade_check (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE nrf_nfct_selres_protocol_t nrfy_nfct_selres_protocol_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_selres_protocol_set (NRF_NFCT_Type *p_reg, nrf_nfct_selres_protocol_t sel_res_protocol)
 
NRFY_STATIC_INLINE uint32_t nrfy_nfct_selres_get (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_selres_set (NRF_NFCT_Type *p_reg, uint32_t selres)
 
NRFY_STATIC_INLINE bool nrfy_nfct_pad_config_enable_check (NRF_NFCT_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_nfct_pad_config_enable_set (NRF_NFCT_Type *p_reg, bool enable)
 
NRFY_STATIC_INLINE void nrfy_nfct_bias_config_get (NRF_NFCT_Type const *p_reg, nrf_nfct_bias_config_t *p_bias_config)
 
NRFY_STATIC_INLINE void nrfy_nfct_bias_config_set (NRF_NFCT_Type *p_reg, nrf_nfct_bias_config_t const *p_bias_config)
 

Detailed Description

Hardware access layer with cache and barrier support for managing the NFCT peripheral.

Macro Definition Documentation

◆ NRFY_NFCT_HAS_AUTOCOLRES_CONFIG_REG

#define NRFY_NFCT_HAS_AUTOCOLRES_CONFIG_REG   1
See also
NRF_NFCT_HAS_AUTOCOLRES_CONFIG_REG Symbol indicating whether automatic collision resolution control register is present.

◆ NRFY_NFCT_HAS_BIAS_CONFIG_TRIM_REG

#define NRFY_NFCT_HAS_BIAS_CONFIG_TRIM_REG   1
See also
NRF_NFCT_HAS_BIAS_CONFIG_TRIM_REG Symbol indicating whether NFC bias configuration trim register is present.

◆ NRFY_NFCT_HAS_MODULATION_CTRL_REG

#define NRFY_NFCT_HAS_MODULATION_CTRL_REG   1
See also
NRF_NFCT_HAS_MODULATION_CTRL_REG Symbol indicating whether modulation output select register is present.

◆ NRFY_NFCT_HAS_MODULATION_PSEL_REG

#define NRFY_NFCT_HAS_MODULATION_PSEL_REG   1
See also
NRF_NFCT_HAS_MODULATION_PSEL_REG Symbol indicating whether pin select for modulation control register is present.

◆ NRFY_NFCT_HAS_PAD_CONFIG_REG

#define NRFY_NFCT_HAS_PAD_CONFIG_REG   1
See also
NRF_NFCT_HAS_PAD_CONFIG_REG Symbol indicating whether NFC pad configuration register is present.

◆ NRFY_NFCT_HAS_SLEEP_STATE_REG

#define NRFY_NFCT_HAS_SLEEP_STATE_REG   1
See also
NRF_NFCT_HAS_SLEEP_STATE_REG Symbol indicating whether sleep state during automatic collision resolution is present.

◆ NRFY_NFCT_HAS_TAG_STATE_REG

#define NRFY_NFCT_HAS_TAG_STATE_REG   1
See also
NRF_NFCT_HAS_TAG_STATE_REG Symbol indicating whether current operating state of NFC tag register is present.

Function Documentation

◆ nrfy_nfct_autocolres_disable()

NRFY_STATIC_INLINE void nrfy_nfct_autocolres_disable ( NRF_NFCT_Type *  p_reg)
See also
nrf_nfct_autocolres_disable Function for disabling the automatic collision resolution.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.

The automatic collision resolution mechanism as defined in ISO 14443-3 and NFC Forum Digital Protocol Technical Specification 2.0, section 6.

◆ nrfy_nfct_autocolres_enable()

NRFY_STATIC_INLINE void nrfy_nfct_autocolres_enable ( NRF_NFCT_Type *  p_reg)
See also
nrf_nfct_autocolres_enable Function for enabling the automatic collision resolution.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.

The automatic collision resolution mechanism as defined in ISO 14443-3 and NFC Forum Digital Protocol Technical Specification 2.0, section 6.

◆ nrfy_nfct_autocolres_is_enabled()

NRFY_STATIC_INLINE bool nrfy_nfct_autocolres_is_enabled ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_autocolres_is_enabled Function for getting the setting for the automatic collision resolution.

The automatic collision resolution mechanism as defined in ISO 14443-3 and NFC Forum Digital Protocol Technical Specification 2.0, section 6.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueIf automatic collision resolution is enabled.
falseIf automatic collision resolution is disabled.

◆ nrfy_nfct_bias_config_get()

NRFY_STATIC_INLINE void nrfy_nfct_bias_config_get ( NRF_NFCT_Type const *  p_reg,
nrf_nfct_bias_config_t p_bias_config 
)
See also
nrf_nfct_bias_config_get Function for getting the bias configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_bias_configPointer to the structure to be filled with bias configuration parameters.

◆ nrfy_nfct_bias_config_set()

NRFY_STATIC_INLINE void nrfy_nfct_bias_config_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_bias_config_t const *  p_bias_config 
)
See also
nrf_nfct_bias_config_set Function for setting the bias configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_bias_configPointer to the structure of bias configuration parameters.

◆ nrfy_nfct_error_status_clear()

NRFY_STATIC_INLINE void nrfy_nfct_error_status_clear ( NRF_NFCT_Type *  p_reg,
uint32_t  error_flag 
)
See also
nrf_nfct_error_status_clear Function for clearing the NFCT error status.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]error_flagError flags to be cleared, defined in nrf_nfct_error_status_t.

◆ nrfy_nfct_error_status_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_error_status_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_error_status_get Function for getting the NFCT error status.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The NFCT error status flags, defined in nrf_nfct_error_status_t.

◆ nrfy_nfct_event_check()

NRFY_STATIC_INLINE bool nrfy_nfct_event_check ( NRF_NFCT_Type const *  p_reg,
nrf_nfct_event_t  event 
)
See also
nrf_nfct_event_check Function for retrieving the state of the NFCT event.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be checked.
Return values
trueThe event has been generated.
falseThe event has not been generated.

◆ nrfy_nfct_event_clear()

NRFY_STATIC_INLINE void nrfy_nfct_event_clear ( NRF_NFCT_Type *  p_reg,
nrf_nfct_event_t  event 
)
See also
nrf_nfct_event_clear Function for clearing a specific event.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent.

◆ nrfy_nfct_events_process()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_events_process ( NRF_NFCT_Type *  p_reg,
uint32_t  mask 
)

Function for processing the specified NFCT events.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of the events to be processed, created by the NRFY_EVENT_TO_INT_BITMASK().
Returns
Mask of the events that were generated and processed. To be checked against the result of the NRFY_EVENT_TO_INT_BITMASK().

◆ nrfy_nfct_field_status_get()

NRFY_STATIC_INLINE uint8_t nrfy_nfct_field_status_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_field_status_get Function for getting the status of the external NFC field detection.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The NFC field detection status. Status bits can be checked by using nrf_nfct_field_state_t.

◆ nrfy_nfct_frame_delay_max_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_frame_delay_max_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_frame_delay_max_get Function for getting the maximum Frame Delay Time value.

This is the maximum value for Frame Delay Timer. It controls the longest time between the last symbol of the last received frame and the start of the transmission of a new TX frame. If no transmission starts before the Frame Delay Timer timeout, NRF_NFCT_ERROR_FRAMEDELAYTIMEOUT_MASK is set.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The maximum Frame Delay Time value in 13.56-MHz clock ticks.

◆ nrfy_nfct_frame_delay_max_set()

NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_max_set ( NRF_NFCT_Type *  p_reg,
uint32_t  frame_delay_max 
)
See also
nrf_nfct_frame_delay_max_set Function for setting the maximum Frame Delay Time value.

This is the maximum value for Frame Delay Timer. It controls the longest time between the last symbol of the last received frame and the start of the transmission of a new TX frame. If no transmission starts before the Frame Delay Timer timeout, NRF_NFCT_ERROR_FRAMEDELAYTIMEOUT_MASK is set.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]frame_delay_maxMaximum Frame Delay Time value in 13.56-MHz clock ticks.

◆ nrfy_nfct_frame_delay_min_get()

NRFY_STATIC_INLINE uint16_t nrfy_nfct_frame_delay_min_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_frame_delay_min_get Function for getting the minimum Frame Delay Time value.

This is the minimum value for Frame Delay Timer. It controls the shortest time between the last symbol of the last received frame and the start of the transmission of a new TX frame.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The minimum Frame Delay Time value in 13.56-MHz clock ticks.

◆ nrfy_nfct_frame_delay_min_set()

NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_min_set ( NRF_NFCT_Type *  p_reg,
uint16_t  frame_delay_min 
)
See also
nrf_nfct_frame_delay_min_set Function for setting the minimum Frame Delay Time value.

This is the minimum value for Frame Delay Timer. It controls the shortest time between the last symbol of the last received frame and the start of the transmission of a new TX frame.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]frame_delay_minMinimum Frame Delay Time value in 13.56-MHz clock ticks.

◆ nrfy_nfct_frame_delay_mode_get()

NRFY_STATIC_INLINE nrf_nfct_frame_delay_mode_t nrfy_nfct_frame_delay_mode_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_frame_delay_mode_get Function for getting the Frame Delay Mode configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The configured Frame Delay Mode.

◆ nrfy_nfct_frame_delay_mode_set()

NRFY_STATIC_INLINE void nrfy_nfct_frame_delay_mode_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_frame_delay_mode_t  frame_delay_mode 
)
See also
nrf_nfct_frame_delay_mode_set Function for setting the NFC Frame Delay Mode configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]frame_delay_modeFrame Delay Mode configuration.

◆ nrfy_nfct_int_disable()

NRFY_STATIC_INLINE void nrfy_nfct_int_disable ( NRF_NFCT_Type *  p_reg,
uint32_t  mask 
)
See also
nrf_nfct_int_disable Function for disabling the selected interrupts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be disabled. Use nrf_nfct_int_mask_t values for bit masking.

◆ nrfy_nfct_int_enable()

NRFY_STATIC_INLINE void nrfy_nfct_int_enable ( NRF_NFCT_Type *  p_reg,
uint32_t  mask 
)
See also
nrf_nfct_int_enable Function for enabling the selected interrupts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be enabled. Use nrf_nfct_int_mask_t values for bit masking.

◆ nrfy_nfct_int_enable_check()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_int_enable_check ( NRF_NFCT_Type const *  p_reg,
uint32_t  mask 
)
See also
nrf_nfct_int_enable_check Function for checking if the specified interrupts are enabled.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be checked. Use nrf_nfct_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrfy_nfct_int_enable_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_int_enable_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_int_enable_get Function for retrieving the information about enabled interrupts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The flags of the enabled interrupts.

◆ nrfy_nfct_int_init()

NRFY_STATIC_INLINE void nrfy_nfct_int_init ( NRF_NFCT_Type *  p_reg,
uint32_t  mask,
uint8_t  irq_priority,
bool  enable 
)

Function for initializing the specified NFCT interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be initialized.
[in]irq_priorityInterrupts priority.
[in]enableTrue if interrupts associated with the event mask are to be enabled, false otherwise.

◆ nrfy_nfct_int_uninit()

NRFY_STATIC_INLINE void nrfy_nfct_int_uninit ( NRF_NFCT_Type *  p_reg)

Function for un-initializing the NFCT interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrfy_nfct_max_rxtx_length_get()

NRFY_STATIC_INLINE uint16_t nrfy_nfct_max_rxtx_length_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_max_rxtx_length_get Function for getting the NFCT RX/TX maximum buffer length.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The configured maximum receive or transmit length in bytes (size of the RX/TX buffer for EasyDMA).

◆ nrfy_nfct_mod_ctrl_pin_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_mod_ctrl_pin_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_mod_ctrl_pin_get Function for getting the modulation control pin selection.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Modulation control pin selection.

◆ nrfy_nfct_mod_ctrl_pin_set()

NRFY_STATIC_INLINE void nrfy_nfct_mod_ctrl_pin_set ( NRF_NFCT_Type *  p_reg,
uint32_t  mod_ctrl_pin 
)
See also
nrf_nfct_mod_ctrl_pin_set Function for configuring the NFCT modulation control pin.

If a given signal is not needed, pass the NRF_NFCT_MOD_CTRL_PIN_NOT_CONNECTED value instead of its pin number.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]mod_ctrl_pinModulation control pin.

◆ nrfy_nfct_modulation_output_get()

NRFY_STATIC_INLINE nrf_nfct_modulation_ctrl_t nrfy_nfct_modulation_output_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_modulation_output_get Function for getting the modulation output configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The configured modulation output.

◆ nrfy_nfct_modulation_output_set()

NRFY_STATIC_INLINE void nrfy_nfct_modulation_output_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_modulation_ctrl_t  mod_ctrl 
)
See also
nrf_nfct_modulation_output_set Function for setting the modulation output. It enables the output to a GPIO pin which can be connected to a second external.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]mod_ctrlModulation control field configuration.

◆ nrfy_nfct_nfcid1_get()

NRFY_STATIC_INLINE nrf_nfct_sensres_nfcid1_size_t nrfy_nfct_nfcid1_get ( NRF_NFCT_Type const *  p_reg,
uint8_t *  p_nfcid1_buf 
)
See also
nrf_nfct_nfcid1_get Function for getting the NFCID1 (NFC tag identifier).
Note
This function always returns the full configuration of the NFCID1 setting (10 bytes), regardless of the NFCID1 size. The NFCID1 size can be configured using nrf_nfct_sensres_nfcid1_size_set or nrf_nfct_nfcid1_set.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[out]p_nfcid1_bufPointer to a buffer for the NDFCID1 parameter. The NFCID1 values are in little endian order, that is: |NFCID1_3RD_LAST|NFCID1_2ND_LAST|NFCID1_LAST|.
Returns
Configured NFCID1 length

◆ nrfy_nfct_nfcid1_set()

NRFY_STATIC_INLINE void nrfy_nfct_nfcid1_set ( NRF_NFCT_Type *  p_reg,
uint8_t const *  p_nfcid1_buf,
nrf_nfct_sensres_nfcid1_size_t  nfcid1_size 
)
See also
nrf_nfct_nfcid1_set Function for setting the NFCID1 (NFC tag identifier).
Note
This function also configures the NFCIDSIZE field in the SENSRES register of the NFCT peripheral.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_nfcid1_bufPointer to the buffer with NDFCID1 bytes.
[in]nfcid1_sizeSize of the NFCID1 in bytes.

◆ nrfy_nfct_pad_config_enable_check()

NRFY_STATIC_INLINE bool nrfy_nfct_pad_config_enable_check ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_pad_config_enable_check Function for checking the NFC pads configuration.

When the NFC pads are enabled, they are configured as the NFC antenna pins, and the NFC pins protection mechanism is enabled. When the NFC pads are disabled, they are configured as GPIO pins.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueNFC pads are enabled.
falseNFC pads are disabled.

◆ nrfy_nfct_pad_config_enable_set()

NRFY_STATIC_INLINE void nrfy_nfct_pad_config_enable_set ( NRF_NFCT_Type *  p_reg,
bool  enable 
)
See also
nrf_nfct_pad_config_enable_set Function for enabling or disabling the NFC pad configuration.

When the NFC pads are enabled, they are configured as the NFC antenna pins, and the NFC pins protection mechanism is enabled. When the NFC pads are disabled, they are configured as GPIO pins.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]enableTrue if the NFC pads are to be enabled, false otherwise.

◆ nrfy_nfct_parameters_restore()

NRFY_STATIC_INLINE void nrfy_nfct_parameters_restore ( NRF_NFCT_Type *  p_reg,
nrfy_nfct_parameters_t const *  p_params 
)

Function for restoring NFCT parameters after peripheral reset. The parameters are written back to the peripheral registers.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_paramsPointer to the structure holding peripheral parameters to be restored.

◆ nrfy_nfct_parameters_save()

NRFY_STATIC_INLINE void nrfy_nfct_parameters_save ( NRF_NFCT_Type const *  p_reg,
nrfy_nfct_parameters_t p_params 
)

Function for saving NFCT parameters before peripheral reset.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_paramsPointer to the structure where the parameters will be saved.

◆ nrfy_nfct_rx_bits_get()

NRFY_STATIC_INLINE uint16_t nrfy_nfct_rx_bits_get ( NRF_NFCT_Type const *  p_reg,
bool  crc_excluded 
)
See also
nrf_nfct_rx_bits_get Function for getting the number of bits received from the NFC poller.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]crc_excludedFlag for excluding CRC size from calculation.
Returns
Number of received bits including or excluding CRC, and excluding parity and SoF/EoF framing.

◆ nrfy_nfct_rx_frame_config_get()

NRFY_STATIC_INLINE uint8_t nrfy_nfct_rx_frame_config_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_rx_frame_config_get Function for getting the flags of the NFC frame reception configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The flags for NFCT frame reception configuration, defined in nrf_nfct_rx_frame_config_t.

◆ nrfy_nfct_rx_frame_config_set()

NRFY_STATIC_INLINE void nrfy_nfct_rx_frame_config_set ( NRF_NFCT_Type *  p_reg,
uint8_t  flags 
)
See also
nrf_nfct_rx_frame_config_set Function for setting up the NFC frame reception.
Note
Destination for the received data is set using nrf_nfct_rxtx_buffer_set.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]flagsNFCT RX configuration flags. Use nrf_nfct_rx_frame_config_t for setting the desired configuration.

◆ nrfy_nfct_rx_frame_status_clear()

NRFY_STATIC_INLINE void nrfy_nfct_rx_frame_status_clear ( NRF_NFCT_Type *  p_reg,
uint32_t  framestatus_flags 
)
See also
nrf_nfct_rx_frame_status_clear Function for clearing the NFC frame reception status.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]framestatus_flagsStatus flags to be cleared, defined in nrf_nfct_rx_frame_status_t.

◆ nrfy_nfct_rx_frame_status_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_rx_frame_status_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_rx_frame_status_get Function for getting the NFC frame reception status.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The flags of the NFC frame reception status, defined in nrf_nfct_rx_frame_status_t.

◆ nrfy_nfct_rxtx_buffer_get()

NRFY_STATIC_INLINE uint8_t * nrfy_nfct_rxtx_buffer_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_rxtx_buffer_get Function for getting the pointer to the NFCT RX/TX buffer.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The configured pointer to the receive or transmit buffer.

◆ nrfy_nfct_rxtx_buffer_set()

NRFY_STATIC_INLINE void nrfy_nfct_rxtx_buffer_set ( NRF_NFCT_Type *  p_reg,
uint8_t *  p_rxtx_buf,
uint16_t  max_txrx_len,
bool  rx 
)

Function for setting the the NFCT RX/TX buffer (address and maximum length).

Note
Buffer for the NFC RX/TX data is used by EasyDMA and must be located in RAM.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_rxtx_bufPointer to the receive or transmit buffer.
[in]max_txrx_lenMaximum receive or transmit length in bytes (size of the RAM buffer for EasyDMA).
[in]rxTrue if buffer is set for the frame reception, false if buffer is set for the frame transmission.

◆ nrfy_nfct_selres_cascade_check()

NRFY_STATIC_INLINE bool nrfy_nfct_selres_cascade_check ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_selres_cascade_check Function for checking the CASCADE bit of the SEL_RES frame.

The CASCADE bit in the SEL_RES register is handled automatically by the NFCT hardware and indicates the status of the NFCID1 read operation to the NFC poller according to the NFC Forum Digital Protocol Speficiation 2.0, section 6.8.2.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueIf NFCID1 read procedure is not complete.
falseIf NFCID1 read procedure is complete.

◆ nrfy_nfct_selres_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_selres_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_selres_get Function for getting the SEL_RES frame configuration.

The SEL_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
SEL_RES frame configuration.

◆ nrfy_nfct_selres_protocol_get()

NRFY_STATIC_INLINE nrf_nfct_selres_protocol_t nrfy_nfct_selres_protocol_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_selres_protocol_get Function for getting the Protocol field in the SEL_RES frame.

The SEL_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Value of the Protocol field in the SEL_RES frame.

◆ nrfy_nfct_selres_protocol_set()

NRFY_STATIC_INLINE void nrfy_nfct_selres_protocol_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_selres_protocol_t  sel_res_protocol 
)
See also
nrf_nfct_selres_protocol_set Function for setting the Protocol field in the SEL_RES frame configuration.

The SEL_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]sel_res_protocolValue of the Protocol field in the SEL_RES frame.

◆ nrfy_nfct_selres_set()

NRFY_STATIC_INLINE void nrfy_nfct_selres_set ( NRF_NFCT_Type *  p_reg,
uint32_t  selres 
)
See also
nrf_nfct_selres_set Function for setting the SEL_RES frame configuration.

The SEL_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selresSEL_RES frame configuration.

◆ nrfy_nfct_sensres_bit_frame_sdd_get()

NRFY_STATIC_INLINE nrf_nfct_sensres_bit_frame_sdd_t nrfy_nfct_sensres_bit_frame_sdd_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_sensres_bit_frame_sdd_get Function for getting the Bit Frame SDD field from the SENS_RES frame configuration.

The SENS_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The Bit Frame SDD field configuration.

◆ nrfy_nfct_sensres_bit_frame_sdd_set()

NRFY_STATIC_INLINE void nrfy_nfct_sensres_bit_frame_sdd_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_sensres_bit_frame_sdd_t  bit_frame_sdd 
)
See also
nrf_nfct_sensres_bit_frame_sdd_set Function for setting the Bit Frame SDD field in the SENS_RES frame configuration.
Note
The SENS_RES frame is handled automatically by the NFCT hardware.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]bit_frame_sddThe Bit Frame SDD field configuration.

◆ nrfy_nfct_sensres_nfcid1_size_get()

NRFY_STATIC_INLINE nrf_nfct_sensres_nfcid1_size_t nrfy_nfct_sensres_nfcid1_size_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_sensres_nfcid1_size_get Function for getting the NFCID1 size from the SENS_RES frame configuration.

The SENS_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
NFCID1 (tag identifier) size.

◆ nrfy_nfct_sensres_nfcid1_size_set()

NRFY_STATIC_INLINE void nrfy_nfct_sensres_nfcid1_size_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_sensres_nfcid1_size_t  nfcid1_size 
)
See also
nrf_nfct_sensres_nfcid1_size_set Function for setting the NFCID1 (tag identifier) size.field in the SENS_RES frame configuration.
Note
The SENS_RES frame is handled automatically by the NFCT hardware.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]nfcid1_sizeNFCID1 (tag identifier) size.
See also
nrf_nfct_nfcid1_set()

◆ nrfy_nfct_sensres_platform_config_get()

NRFY_STATIC_INLINE nrf_nfct_sensres_platform_config_t nrfy_nfct_sensres_platform_config_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_sensres_platform_config_get Function for getting the Platform Config field from the SENS_RES frame configuration.

The SENS_RES frame is handled automatically by the NFCT hardware.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The Platform Config field configuration.

◆ nrfy_nfct_sensres_platform_config_set()

NRFY_STATIC_INLINE void nrfy_nfct_sensres_platform_config_set ( NRF_NFCT_Type *  p_reg,
nrf_nfct_sensres_platform_config_t  platform_config 
)
See also
nrf_nfct_sensres_platform_config_set Function for setting the Platform Config field in the SENS_RES frame configuration.
Note
The SENS_RES frame is handled automatically by the NFCT hardware.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]platform_configThe Platform Config field configuration.

◆ nrfy_nfct_shorts_disable()

NRFY_STATIC_INLINE void nrfy_nfct_shorts_disable ( NRF_NFCT_Type *  p_reg,
uint32_t  short_mask 
)
See also
nrf_nfct_shorts_disable Function for disabling selected shortcuts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]short_maskMask of shortcuts.

◆ nrfy_nfct_shorts_enable()

NRFY_STATIC_INLINE void nrfy_nfct_shorts_enable ( NRF_NFCT_Type *  p_reg,
uint32_t  short_mask 
)
See also
nrf_nfct_shorts_enable Function for enabling selected shortcuts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]short_maskMask of shortcuts.

◆ nrfy_nfct_shorts_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_shorts_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_shorts_get Function for retrieving the enabled shortcuts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Flags of the currently enabled shortcuts.

◆ nrfy_nfct_shorts_set()

NRFY_STATIC_INLINE void nrfy_nfct_shorts_set ( NRF_NFCT_Type *  p_reg,
uint32_t  short_mask 
)
See also
nrf_nfct_shorts_set Function for setting shortcuts.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]short_maskShortcut mask.

◆ nrfy_nfct_sleep_state_get()

NRFY_STATIC_INLINE nrf_nfct_sleep_state_t nrfy_nfct_sleep_state_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_sleep_state_get Function for getting the NFC tag sleep state during the automatic collision resolution.

The returned value is the last state before the autimatic collision resolution started.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
NRF_NFCT_SLEEP_STATE_IDLENFC tag was in IDLE state before the automatic collision resolution started.
NRF_NFCT_SLEEP_STATE_SLEEP_ANFC tag was in SLEEP_A state before the automatic collision resolution started.

◆ nrfy_nfct_tag_state_get()

NRFY_STATIC_INLINE nrf_nfct_tag_state_t nrfy_nfct_tag_state_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_tag_state_get Function for getting the NFC tag state.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
NRF_NFCT_TAG_STATE_DISABLEDNFC tag is disabled.
NRF_NFCT_TAG_STATE_RAMP_UPNFC tag is ramping up.
NRF_NFCT_TAG_STATE_IDLENFC tag is activated and idle.
NRF_NFCT_TAG_STATE_RECEIVENFC tag is receiving data.
NRF_NFCT_TAG_STATE_FRAME_DELAYFrame Delay Timer of the NFC tag is counting ticks since the last symbol of the last received frame.
NRF_NFCT_TAG_STATE_TRANSMITNFC tag is transmitting data.

◆ nrfy_nfct_task_address_get()

NRFY_STATIC_INLINE uint32_t nrfy_nfct_task_address_get ( NRF_NFCT_Type const *  p_reg,
nrf_nfct_task_t  task 
)
See also
nrf_nfct_task_address_get Function for returning the address of a specific NFCT task register.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask.
Returns
Task address.

◆ nrfy_nfct_task_trigger()

NRFY_STATIC_INLINE void nrfy_nfct_task_trigger ( NRF_NFCT_Type *  p_reg,
nrf_nfct_task_t  task 
)
See also
nrf_nfct_task_trigger Function for activating a specific NFCT task.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask to be activated.

◆ nrfy_nfct_tx_bits_get()

NRFY_STATIC_INLINE uint16_t nrfy_nfct_tx_bits_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_tx_bits_get Function for getting the length of the configured transmission frame.
Note
NFC frames do not have to consist of full bytes only, therefore data amount for transmission is configured in number of bits.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Number of bits to be sent excluding CRC, parity, SoF, and EoF.

◆ nrfy_nfct_tx_bits_set()

NRFY_STATIC_INLINE void nrfy_nfct_tx_bits_set ( NRF_NFCT_Type *  p_reg,
uint16_t  tx_bits 
)
See also
nrf_nfct_tx_bits_set Function for setting up the NFC frame transmission.

Set the number of TX bits excluding CRC, parity, SoF, and EoF.

Note
Source of data for transmission is set by using nrf_nfct_rxtx_buffer_set.
NFC frames do not have to consist of full bytes only, therefore data amount for transmission is configured in number of bits.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]tx_bitsOverall number of bits to be sent.

◆ nrfy_nfct_tx_frame_config_get()

NRFY_STATIC_INLINE uint8_t nrfy_nfct_tx_frame_config_get ( NRF_NFCT_Type const *  p_reg)
See also
nrf_nfct_tx_frame_config_get Function for getting the flags for NFC frame transmission configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The flags of the NFCT frame transmission configuration, defined in nrf_nfct_tx_frame_config_t.

◆ nrfy_nfct_tx_frame_config_set()

NRFY_STATIC_INLINE void nrfy_nfct_tx_frame_config_set ( NRF_NFCT_Type *  p_reg,
uint8_t  flags 
)
See also
nrf_nfct_tx_frame_config_set Function for setting up the flags of the NFC frame transmission configuration.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]flagsFlags for NFCT TX configuration. Use nrf_nfct_tx_frame_config_t for setting.

Documentation feedback | Developer Zone | Subscribe | Updated