nrf24l01
Driver for the nRF24L01(+) transceiver
Macros
NRF24L01 SPI Register Mask Definitions


More...

Macros

#define NRF24L01_RX_PW_P0_MASK_REG   (uint8_t) NRF24L01_RX_PW_P0_REG_BITS_RX_PW_P0
 
#define NRF24L01_RX_PW_P1_MASK_REG   (uint8_t) NRF24L01_RX_PW_P1_REG_BITS_RX_PW_P1
 
#define NRF24L01_RX_PW_P2_MASK_REG   (uint8_t) NRF24L01_RX_PW_P2_REG_BITS_RX_PW_P2
 
#define NRF24L01_RX_PW_P3_MASK_REG   (uint8_t) NRF24L01_RX_PW_P3_REG_BITS_RX_PW_P3
 
#define NRF24L01_RX_PW_P4_MASK_REG   (uint8_t) NRF24L01_RX_PW_P4_REG_BITS_RX_PW_P4
 
#define NRF24L01_RX_PW_P5_MASK_REG   (uint8_t) NRF24L01_RX_PW_P5_REG_BITS_RX_PW_P5
 
#define NRF24L01_FIFO_STATUS_MASK_REG
 Mask for all defined bits in FIFO_STATUS register. More...
 
#define NRF24L01_FIFO_STATUS_MASK_RX_FLAGS
 Mask for RX_FIFO[1:0] status bits in FIFO_STATUS register. More...
 
#define NRF24L01_FIFO_STATUS_MASK_TX_FLAGS
 Mask for TX_FIFO[6:4] status bits in FIFO_STATUS register. More...
 
#define NRF24L01_DYNPD_MASK_REG
 Mask for DPL_Px[5:0] bits in DYNPD feature register. More...
 
#define NRF24L01_FEATURE_MASK_REG
 

Configuration Register (CONFIG)

Provides a register mask, an interrupt mask and a CRC mask

View details in datasheet for more information

#define NRF24L01_CONFIG_MASK_REG
 < Mask for all defined bits[6:0] in CONFIG register More...
 
#define NRF24L01_CONFIG_MASK_INTERRUPT_MASKS
 Mask for CRC[3:2] bits in CONFIG register. More...
 
#define NRF24L01_CONFIG_MASK_CRC
 RX_DR[6] bit in CONFIG register. More...
 

Enhanced ShockBurst™ Enable Register (EN_AA)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_EN_AA_MASK_REG
 Mask for all defined bits[5:0] in EN_AA register. More...
 

RX Pipe Enable Register (EN_RXADDR)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_EN_RXADDR_MASK_REG
 Mask for all defined bits[5:0] in EN_RXADDR register. More...
 

Pipe Address Width Common Configuration Register (SETUP_AW)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_SETUP_AW_MASK_REG   (uint8_t) NRF24L01_SETUP_AW_REG_BITS_AW
 Mask for all defined bits[1:0] in AW register. More...
 

Automatic Retransmission Configuration Register (SETUP_RETR)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_SETUP_RETR_MASK_REG
 Mask for all defined bits[7:0] in SETUP_RETR register. More...
 

RF Channel Configuration Register (RF_CH)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_RF_CH_MASK_REG   (uint8_t) NRF24L01_RF_CH_REG_BITS_RF_CH
 Mask for all defined bits[6:0] in RF_CH register. More...
 

RF Configuration Register (RF_SETUP)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_RF_SETUP_MASK_REG
 Mask for all defined bits[4:0] in RF_SETUP register. More...
 

Device Status Register (STATUS)

Provides a register mask and an IRQ flags mask

View details in datasheet for more information

#define NRF24L01_STATUS_MASK_REG
 Mask for all defined bits[6:0] in STATUS register. More...
 
#define NRF24L01_STATUS_MASK_IRQ_FLAGS
 Mask for IRQ[6:4] interrupt flag bits in STATUS register. More...
 

Transmission Observation Register (OBSERVE_TX)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_OBSERVE_TX_MASK_REG
 Mask for all defined bits[7:0] in OBSERVE_TX register. More...
 

Carrier Detect Register (CD)

Provides a register mask

View details in datasheet for more information

#define NRF24L01_CD_MASK_REG   (uint8_t) NRF24L01_CD_REG_BIT_CD
 Mask for all defined bits[0:0] in CD register. More...
 

Detailed Description


These definitions should be used when trying to mask out on or more properties of the NRF24L01. For individual bit definitions see NRF24L01 SPI Register Bit Definitions

The naming convention for all definitions is NRF24L01_r_MASK_x where r is the register name where the bit is found and x an arbitrary assigned name Each register also has a full mask defined for it under the name NRF24L01_r_MASK_REG

Macro Definition Documentation

◆ NRF24L01_CD_MASK_REG

#define NRF24L01_CD_MASK_REG   (uint8_t) NRF24L01_CD_REG_BIT_CD

Mask for all defined bits[0:0] in CD register.

◆ NRF24L01_CONFIG_MASK_CRC

#define NRF24L01_CONFIG_MASK_CRC
Value:

RX_DR[6] bit in CONFIG register.

◆ NRF24L01_CONFIG_MASK_INTERRUPT_MASKS

#define NRF24L01_CONFIG_MASK_INTERRUPT_MASKS
Value:

Mask for CRC[3:2] bits in CONFIG register.

◆ NRF24L01_CONFIG_MASK_REG

#define NRF24L01_CONFIG_MASK_REG
Value:

< Mask for all defined bits[6:0] in CONFIG register

Mask for INTERRUPT[6:4] bits in CONFIG register

◆ NRF24L01_DYNPD_MASK_REG

#define NRF24L01_DYNPD_MASK_REG

◆ NRF24L01_EN_AA_MASK_REG

#define NRF24L01_EN_AA_MASK_REG

◆ NRF24L01_EN_RXADDR_MASK_REG

#define NRF24L01_EN_RXADDR_MASK_REG

◆ NRF24L01_FEATURE_MASK_REG

#define NRF24L01_FEATURE_MASK_REG

◆ NRF24L01_FIFO_STATUS_MASK_REG

#define NRF24L01_FIFO_STATUS_MASK_REG

◆ NRF24L01_FIFO_STATUS_MASK_RX_FLAGS

#define NRF24L01_FIFO_STATUS_MASK_RX_FLAGS
Value:

Mask for RX_FIFO[1:0] status bits in FIFO_STATUS register.

◆ NRF24L01_FIFO_STATUS_MASK_TX_FLAGS

#define NRF24L01_FIFO_STATUS_MASK_TX_FLAGS
Value:

Mask for TX_FIFO[6:4] status bits in FIFO_STATUS register.

◆ NRF24L01_OBSERVE_TX_MASK_REG

#define NRF24L01_OBSERVE_TX_MASK_REG
Value:

Mask for all defined bits[7:0] in OBSERVE_TX register.

◆ NRF24L01_RF_CH_MASK_REG

#define NRF24L01_RF_CH_MASK_REG   (uint8_t) NRF24L01_RF_CH_REG_BITS_RF_CH

Mask for all defined bits[6:0] in RF_CH register.

◆ NRF24L01_RF_SETUP_MASK_REG

#define NRF24L01_RF_SETUP_MASK_REG
Value:

Mask for all defined bits[4:0] in RF_SETUP register.

◆ NRF24L01_RX_PW_P0_MASK_REG

#define NRF24L01_RX_PW_P0_MASK_REG   (uint8_t) NRF24L01_RX_PW_P0_REG_BITS_RX_PW_P0

◆ NRF24L01_RX_PW_P1_MASK_REG

#define NRF24L01_RX_PW_P1_MASK_REG   (uint8_t) NRF24L01_RX_PW_P1_REG_BITS_RX_PW_P1

◆ NRF24L01_RX_PW_P2_MASK_REG

#define NRF24L01_RX_PW_P2_MASK_REG   (uint8_t) NRF24L01_RX_PW_P2_REG_BITS_RX_PW_P2

◆ NRF24L01_RX_PW_P3_MASK_REG

#define NRF24L01_RX_PW_P3_MASK_REG   (uint8_t) NRF24L01_RX_PW_P3_REG_BITS_RX_PW_P3

◆ NRF24L01_RX_PW_P4_MASK_REG

#define NRF24L01_RX_PW_P4_MASK_REG   (uint8_t) NRF24L01_RX_PW_P4_REG_BITS_RX_PW_P4

◆ NRF24L01_RX_PW_P5_MASK_REG

#define NRF24L01_RX_PW_P5_MASK_REG   (uint8_t) NRF24L01_RX_PW_P5_REG_BITS_RX_PW_P5

◆ NRF24L01_SETUP_AW_MASK_REG

#define NRF24L01_SETUP_AW_MASK_REG   (uint8_t) NRF24L01_SETUP_AW_REG_BITS_AW

Mask for all defined bits[1:0] in AW register.

◆ NRF24L01_SETUP_RETR_MASK_REG

#define NRF24L01_SETUP_RETR_MASK_REG
Value:

Mask for all defined bits[7:0] in SETUP_RETR register.

◆ NRF24L01_STATUS_MASK_IRQ_FLAGS

#define NRF24L01_STATUS_MASK_IRQ_FLAGS
Value:

Mask for IRQ[6:4] interrupt flag bits in STATUS register.

◆ NRF24L01_STATUS_MASK_REG

#define NRF24L01_STATUS_MASK_REG
NRF24L01_DYNPD_REG_BIT_DPL_P2
#define NRF24L01_DYNPD_REG_BIT_DPL_P2
Definition: nrf24l01_defs.h:392
NRF24L01_CONFIG_REG_BIT_CRCO
#define NRF24L01_CONFIG_REG_BIT_CRCO
CRCO[2] bit in CONFIG register.
Definition: nrf24l01_defs.h:228
NRF24L01_SETUP_RETR_REG_BITS_ARC
#define NRF24L01_SETUP_RETR_REG_BITS_ARC
ARC[3:0] bits in SETUP_RETR register.
Definition: nrf24l01_defs.h:273
NRF24L01_RF_SETUP_REG_BIT_PLL_LOCK
#define NRF24L01_RF_SETUP_REG_BIT_PLL_LOCK
PLL_LOCK[5] bit in RF_SETUP register.
Definition: nrf24l01_defs.h:289
NRF24L01_CONFIG_REG_BIT_EN_CRC
#define NRF24L01_CONFIG_REG_BIT_EN_CRC
EN_CRC[3] bit in CONFIG register.
Definition: nrf24l01_defs.h:227
NRF24L01_FEATURE_REG_BIT_EN_ACK_PAY
#define NRF24L01_FEATURE_REG_BIT_EN_ACK_PAY
EN_ACK_PAY[1] bit in FEATURE register.
Definition: nrf24l01_defs.h:403
NRF24L01_CONFIG_REG_BIT_MASK_RX_DR
#define NRF24L01_CONFIG_REG_BIT_MASK_RX_DR
RX_DR[6] bit in CONFIG register.
Definition: nrf24l01_defs.h:224
NRF24L01_EN_RXADDR_REG_BIT_ERX_P1
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P1
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:255
NRF24L01_FIFO_STATUS_REG_BIT_RX_FULL
#define NRF24L01_FIFO_STATUS_REG_BIT_RX_FULL
RX_FULL[1] status bit in FIFO_STATUS register.
Definition: nrf24l01_defs.h:380
NRF24L01_RF_SETUP_REG_BITS_RF_PWR
#define NRF24L01_RF_SETUP_REG_BITS_RF_PWR
RF_PWR[2:1] bits in RF_SETUP register.
Definition: nrf24l01_defs.h:291
NRF24L01_STATUS_REG_BIT_TX_DS
#define NRF24L01_STATUS_REG_BIT_TX_DS
TX_DS[5] interrupt flag bit in STATUS register.
Definition: nrf24l01_defs.h:301
NRF24L01_FEATURE_REG_BIT_EN_DYN_ACK
#define NRF24L01_FEATURE_REG_BIT_EN_DYN_ACK
EN_DYN_ACK[0] bit in FEATURE register.
Definition: nrf24l01_defs.h:404
NRF24L01_STATUS_REG_BITS_RX_P_NO
#define NRF24L01_STATUS_REG_BITS_RX_P_NO
RX_P_NO[3:1] pipe number bits in STATUS register.
Definition: nrf24l01_defs.h:303
NRF24L01_OBSERVE_TX_REG_BITS_PLOS_CNT
#define NRF24L01_OBSERVE_TX_REG_BITS_PLOS_CNT
PLOS_CNT[7:4] lost packet count bits in OBSERVE_TX register.
Definition: nrf24l01_defs.h:312
NRF24L01_DYNPD_REG_BIT_DPL_P1
#define NRF24L01_DYNPD_REG_BIT_DPL_P1
Definition: nrf24l01_defs.h:393
NRF24L01_EN_AA_REG_BIT_ENAA_P0
#define NRF24L01_EN_AA_REG_BIT_ENAA_P0
ENAA_P0[0] bit in EN_AA register.
Definition: nrf24l01_defs.h:243
NRF24L01_OBSERVE_TX_REG_BITS_ARC_CNT
#define NRF24L01_OBSERVE_TX_REG_BITS_ARC_CNT
ARC_CNT[3:0] resent packet count bits in OBSERVE_TX register.
Definition: nrf24l01_defs.h:313
NRF24L01_CONFIG_REG_BIT_MASK_TX_DS
#define NRF24L01_CONFIG_REG_BIT_MASK_TX_DS
TX_DS[5] bit in CONFIG register.
Definition: nrf24l01_defs.h:225
NRF24L01_EN_RXADDR_REG_BIT_ERX_P0
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P0
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:256
NRF24L01_STATUS_REG_BIT_MAX_RT
#define NRF24L01_STATUS_REG_BIT_MAX_RT
MAX_RT[4] interrupt flag bit in STATUS register.
Definition: nrf24l01_defs.h:302
NRF24L01_EN_AA_REG_BIT_ENAA_P5
#define NRF24L01_EN_AA_REG_BIT_ENAA_P5
ENAA_P5[5] bit in EN_AA register.
Definition: nrf24l01_defs.h:238
NRF24L01_RF_SETUP_REG_BIT_RF_DR
#define NRF24L01_RF_SETUP_REG_BIT_RF_DR
RF_DR[4] bit in RF_SETUP register.
Definition: nrf24l01_defs.h:290
NRF24L01_CONFIG_REG_BIT_PWR_UP
#define NRF24L01_CONFIG_REG_BIT_PWR_UP
PWR_UP[1] bit in CONFIG register.
Definition: nrf24l01_defs.h:229
NRF24L01_CONFIG_REG_BIT_MASK_MAX_RT
#define NRF24L01_CONFIG_REG_BIT_MASK_MAX_RT
MAX_RT[4] bit in CONFIG register.
Definition: nrf24l01_defs.h:226
NRF24L01_DYNPD_REG_BIT_DPL_P0
#define NRF24L01_DYNPD_REG_BIT_DPL_P0
Definition: nrf24l01_defs.h:394
NRF24L01_CONFIG_REG_BIT_PRIM_RX
#define NRF24L01_CONFIG_REG_BIT_PRIM_RX
PRIM_RX[0] bit in CONFIG register.
Definition: nrf24l01_defs.h:230
NRF24L01_FIFO_STATUS_REG_BIT_RX_EMPTY
#define NRF24L01_FIFO_STATUS_REG_BIT_RX_EMPTY
RX_EMPTY[0] status bit in FIFO_STATUS register.
Definition: nrf24l01_defs.h:381
NRF24L01_STATUS_REG_BIT_RX_DR
#define NRF24L01_STATUS_REG_BIT_RX_DR
RX_DR[6] interrupt flag bit in STATUS register.
Definition: nrf24l01_defs.h:300
NRF24L01_EN_RXADDR_REG_BIT_ERX_P3
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P3
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:253
NRF24L01_EN_RXADDR_REG_BIT_ERX_P5
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P5
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:251
NRF24L01_DYNPD_REG_BIT_DPL_P4
#define NRF24L01_DYNPD_REG_BIT_DPL_P4
Definition: nrf24l01_defs.h:390
NRF24L01_FIFO_STATUS_REG_BIT_TX_REUSE
#define NRF24L01_FIFO_STATUS_REG_BIT_TX_REUSE
TX_REUSE[5] status bit in FIFO_STATUS register.
Definition: nrf24l01_defs.h:377
NRF24L01_EN_AA_REG_BIT_ENAA_P4
#define NRF24L01_EN_AA_REG_BIT_ENAA_P4
ENAA_P4[4] bit in EN_AA register.
Definition: nrf24l01_defs.h:239
NRF24L01_FIFO_STATUS_REG_BIT_TX_EMPTY
#define NRF24L01_FIFO_STATUS_REG_BIT_TX_EMPTY
TX_EMPTY[4] status bits [5:4] in FIFO_STATUS register.
Definition: nrf24l01_defs.h:379
NRF24L01_SETUP_RETR_REG_BITS_ARD
#define NRF24L01_SETUP_RETR_REG_BITS_ARD
ARD[7:4] bits in SETUP_RETR register.
Definition: nrf24l01_defs.h:272
NRF24L01_FEATURE_REG_BIT_EN_DPL
#define NRF24L01_FEATURE_REG_BIT_EN_DPL
EN_DPL[2] bit in FEATURE register.
Definition: nrf24l01_defs.h:402
NRF24L01_EN_RXADDR_REG_BIT_ERX_P2
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P2
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:254
NRF24L01_DYNPD_REG_BIT_DPL_P3
#define NRF24L01_DYNPD_REG_BIT_DPL_P3
Definition: nrf24l01_defs.h:391
NRF24L01_EN_AA_REG_BIT_ENAA_P1
#define NRF24L01_EN_AA_REG_BIT_ENAA_P1
ENAA_P1[1] bit in EN_AA register.
Definition: nrf24l01_defs.h:242
NRF24L01_DYNPD_REG_BIT_DPL_P5
#define NRF24L01_DYNPD_REG_BIT_DPL_P5
Definition: nrf24l01_defs.h:389
NRF24L01_FIFO_STATUS_REG_BIT_TX_FULL
#define NRF24L01_FIFO_STATUS_REG_BIT_TX_FULL
TX_FULL[6] status bit in FIFO_STATUS register.
Definition: nrf24l01_defs.h:378
NRF24L01_EN_AA_REG_BIT_ENAA_P3
#define NRF24L01_EN_AA_REG_BIT_ENAA_P3
ENAA_P3[3] bit in EN_AA register.
Definition: nrf24l01_defs.h:240
NRF24L01_RF_SETUP_REG_BIT_LNA_HCURR
#define NRF24L01_RF_SETUP_REG_BIT_LNA_HCURR
LNA_HCURR[0] bit in RF_SETUP register.
Definition: nrf24l01_defs.h:292
NRF24L01_EN_AA_REG_BIT_ENAA_P2
#define NRF24L01_EN_AA_REG_BIT_ENAA_P2
ENAA_P2[2] bit in EN_AA register.
Definition: nrf24l01_defs.h:241
NRF24L01_STATUS_REG_BIT_TX_FULL
#define NRF24L01_STATUS_REG_BIT_TX_FULL
TX_FULL[0] flag bit in STATUS register.
Definition: nrf24l01_defs.h:304
NRF24L01_EN_RXADDR_REG_BIT_ERX_P4
#define NRF24L01_EN_RXADDR_REG_BIT_ERX_P4
Mask for all defined bits[5:0] in EN_RXADDR register.
Definition: nrf24l01_defs.h:252