44da029e31c34416a51356b107675573/doc-preview/nrf24l01p__ng__registers_8h_source.html

 /*

  * Copyright (C) 2019 Otto-von-Guericke-Universität Magdeburg

  *

  * This file is subject to the terms and conditions of the GNU Lesser

  * General Public License v2.1. See the file LICENSE in the top level

  * directory for more details.

  */

 #ifndef NRF24L01P_NG_REGISTERS_H

 #define NRF24L01P_NG_REGISTERS_H


 #include <stdint.h>


 #include "nrf24l01p_ng.h"

 #include "nrf24l01p_ng_communication.h"


 #ifdef __cplusplus

 extern "C" {

 #endif


 #define NRF24L01P_NG_REG_CONFIG             (0x00)

 #define NRF24L01P_NG_FLG_MASK_RX_DR         (0x40)

 #define NRF24L01P_NG_VAL_MASK_RX_DR(reg)    (((reg) & \

                                             NRF24L01P_NG_FLG_MASK_RX_DR) >> 6)

 #define NRF24L01P_NG_FLG_MASK_TX_DS         (0x20)

 #define NRF24L01P_NG_VAL_MASK_TX_DS(reg)    (((reg) & \

                                             NRF24L01P_NG_FLG_MASK_TX_DS) >> 5)

 #define NRF24L01P_NG_FLG_MASK_MAX_RT        (0x10)

 #define NRF24L01P_NG_VAL_MASK_MAX_RT        (((reg) & \

                                             NRF24L01P_NG_FLG_MASK_MAX_RT) >> 4)

 #define NRF24L01P_NG_FLG_EN_CRC             (0x08)

 #define NRF24L01P_NG_VAL_EN_CRC(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_EN_CRC) >> 3)

 #define NRF24L01P_NG_FLG_CRCO_1_BYTE        (0x00)

 #define NRF24L01P_NG_FLG_CRCO_2_BYTE        (0x04)

 #define NRF24L01P_NG_MSK_CRC                (0x0c)

 #define NRF24L01P_NG_FLG_CRCO(val)          (((val) << 2) & \

                                             NRF24L01P_NG_MSK_CRC)

 #define NRF24L01P_NG_VAL_CRCO(reg)          (((reg) & \

                                             NRF24L01P_NG_FLG_CRCO_2_BYTE) >> 2)

 #define NRF24L01P_NG_FLG_PWR_UP             (0x02)

 #define NRF24L01P_NG_VAL_PWR_UP(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_PWR_UP) >> 1)

 #define NRF24L01P_NG_FLG_PRIM_RX            (0x01)

 #define NRF24L01P_NG_VAL_PRIM_RX(reg)       ((reg) & NRF24L01P_NG_FLG_PRIM_RX)

 #define NRF24L01P_NG_REG_EN_AA              (0x01)

 #define NRF24L01P_NG_FLG_ENAA_P5            (0x20)

 #define NRF24L01P_NG_VAL_ENAA_P5(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_ENAA_P5) >> 5)

 #define NRF24L01P_NG_FLG_ENAA_P4            (0x10)

 #define NRF24L01P_NG_VAL_ENAA_P4(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_ENAA_P4) >> 4)

 #define NRF24L01P_NG_FLG_ENAA_P3            (0x08)

 #define NRF24L01P_NG_VAL_ENAA_P3(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_ENAA_P3) >> 3)

 #define NRF24L01P_NG_FLG_ENAA_P2            (0x04)

 #define NRF24L01P_NG_VAL_ENAA_P2(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_ENAA_P2) >> 2)

 #define NRF24L01P_NG_FLG_ENAA_P1            (0x02)

 #define NRF24L01P_NG_VAL_ENAA_P1(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_ENAA_P1) >> 1)

 #define NRF24L01P_NG_FLG_ENAA_P0            (0x01)

 #define NRF24L01P_NG_VAL_ENAA_P0(reg)       ((reg) & NRF24L01P_NG_FLG_ENAA_P0)

 #define NRF24L01P_NG_REG_EN_RXADDR          (0x02)

 #define NRF24L01P_NG_FLG_ERX_P5             (0x20)

 #define NRF24L01P_NG_VAL_ERX_P5(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_ERX_P5) >> 5)

 #define NRF24L01P_NG_FLG_ERX_P4             (0x10)

 #define NRF24L01P_NG_VAL_ERX_P4(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_ERX_P4) >> 4)

 #define NRF24L01P_NG_FLG_ERX_P3             (0x08)

 #define NRF24L01P_NG_VAL_ERX_P3(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_ERX_P3) >> 3)

 #define NRF24L01P_NG_FLG_ERX_P2             (0x04)

 #define NRF24L01P_NG_VAL_ERX_P2(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_ERX_P2) >> 2)

 #define NRF24L01P_NG_FLG_ERX_P1             (0x02)

 #define NRF24L01P_NG_VAL_ERX_P1(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_ERX_P1) >> 1)

 #define NRF24L01P_NG_FLG_ERX_P0             (0x01)

 #define NRF24L01P_NG_VAL_ERX_P0(reg)        ((reg) & NRF24L01P_NG_FLG_ERX_P0)

 #define NRF24L01P_NG_REG_SETUP_AW           (0x03)

 #define NRF24L01P_NG_FLG_AW_3               (0x01)

 #define NRF24L01P_NG_FLG_AW_4               (0x02)

 #define NRF24L01P_NG_FLG_AW_5               (0x03)

 #define NRF24L01P_NG_MSK_AW                 (0x03)

 #define NRF24L01P_NG_FLG_AW(val)            ((val) & NRF24L01P_NG_MSK_AW)

 #define NRF24L01P_NG_VAL_AW(reg)            ((reg) & NRF24L01P_NG_MSK_AW)

 #define NRF24L01P_NG_REG_SETUP_RETR         (0x04)

 #define NRF24L01P_NG_FLG_ARD_250_US         (0x00)

 #define NRF24L01P_NG_FLG_ARD_500_US         (0x10)

 #define NRF24L01P_NG_FLG_ARD_750_US         (0x20)

 #define NRF24L01P_NG_FLG_ARD_1000_US        (0x30)

 #define NRF24L01P_NG_FLG_ARD_1250_US        (0x40)

 #define NRF24L01P_NG_FLG_ARD_1500_US        (0x50)

 #define NRF24L01P_NG_FLG_ARD_1750_US        (0x60)

 #define NRF24L01P_NG_FLG_ARD_2000_US        (0x70)

 #define NRF24L01P_NG_FLG_ARD_2250_US        (0x80)

 #define NRF24L01P_NG_FLG_ARD_2500_US        (0x90)

 #define NRF24L01P_NG_FLG_ARD_2750_US        (0xa0)

 #define NRF24L01P_NG_FLG_ARD_3000_US        (0xb0)

 #define NRF24L01P_NG_FLG_ARD_3250_US        (0xc0)

 #define NRF24L01P_NG_FLG_ARD_3500_US        (0xd0)

 #define NRF24L01P_NG_FLG_ARD_3750_US        (0xe0)

 #define NRF24L01P_NG_FLG_ARD_4000_US        (0xf0)

 #define NRF24L01P_NG_MSK_ARD                (0xf0)

 #define NRF24L01P_NG_FLG_ARD(val)           (((val) << 4) & \

                                             NRF24L01P_NG_MSK_ARD)

 #define NRF24L01P_NG_VAL_ARD(reg)           (((reg) & \

                                             NRF24L01P_NG_MSK_ARD) >> 4)

 #define NRF24L01P_NG_MSK_ARC                (0x0f)

 #define NRF24L01P_NG_FLG_ARC(val)           ((val) & NRF24L01P_NG_MSK_ARC)

 #define NRF24L01P_NG_VAL_ARC(reg)           ((reg) & NRF24L01P_NG_MSK_ARC)

 #define NRF24L01P_NG_REG_RF_CH              (0x05)

 #define NRF24L01P_NG_MSK_RF_CH              (0x7f)

 #define NRF24L01P_NG_FLG_RF_CH(val)         ((val) & NRF24L01P_NG_MSK_RF_CH)

 #define NRF24L01P_NG_VAL_RF_CH(reg)         ((reg) & NRF24L01P_NG_MSK_RF_CH)

 #define NRF24L01P_NG_REG_RF_SETUP           (0x06)

 #define NRF24L01P_NG_FLG_CONT_WAVE          (0x80)

 #define NRF24L01P_NG_VAL_CONT_WAVE(reg)     (((reg) & \

                                             NRF24L01P_NG_FLG_CONT_WAVE) >> 7)

 #define NRF24L01P_NG_FLG_RF_DR_LOW          (0x20)

 #define NRF24L01P_NG_VAL_RF_DR_LOW(reg)     (((reg) & \

                                             NRF24L01P_NG_FLG_RF_DR_LOW) >> 5)

 #define NRF24L01P_NG_FLG_PLL_LOCK           (0x10)

 #define NRF24L01P_NG_VAL_PLL_LOCK(reg)      (((reg) & \

                                             NRF24L01P_NG_FLG_PLL_LOCK) >> 4)

 #define NRF24L01P_NG_FLG_RF_DR_HIGH         (0x08)

 #define NRF24L01P_NG_VAL_RF_DR_HIGH(reg)    (((reg) & \

                                             NRF24L01P_NG_FLG_RF_DR_HIGH) >> 3)

 #define NRF24L01P_NG_FLG_RF_DR_250_KBPS     (0x08)

 #define NRF24L01P_NG_FLG_RF_DR_1_MBPS       (0x00)

 #define NRF24L01P_NG_FLG_RF_DR_2_MBPS       (0x20)

 #define NRF24L01P_NG_MSK_RF_DR              (0x28)

 #define NRF24L01P_NG_FLG_RF_DR(val)         ((((val) & 1) << 5) | \

                                             (((val) & 2) << 2))

 #define NRF24L01P_NG_VAL_RF_DR(reg)         ((((reg) & \

                                             NRF24L01P_NG_FLG_RF_DR_LOW) >> 5) \

                                             | \

                                             (((reg) & \

                                             NRF24L01P_NG_FLG_RF_DR_HIGH) >> 2))

 #define NRF24L01P_NG_FLG_RF_PWR_MINUS_18    (0x00)

 #define NRF24L01P_NG_FLG_RF_PWR_MINUS_12    (0x02)

 #define NRF24L01P_NG_FLG_RF_PWR_MINUS_6     (0x04)

 #define NRF24L01P_NG_FLG_RF_PWR_0           (0x06)

 #define NRF24L01P_NG_MSK_RF_PWR             (0x06)

 #define NRF24L01P_NG_FLG_RF_PWR(val)        (((val) << 1) & \

                                             NRF24L01P_NG_MSK_RF_PWR)

 #define NRF24L01P_NG_VAL_RF_PWR(reg)        (((reg) & \

                                             NRF24L01P_NG_MSK_RF_PWR) >> 1)

 #define NRF24L01P_NG_REG_STATUS             (0x07)

 #define NRF24L01P_NG_FLG_RX_DR              (0x40)

 #define NRF24L01P_NG_VAL_RX_DR(reg)         (((reg) & \

                                             NRF24L01P_NG_FLG_RX_DR) >> 6)

 #define NRF24L01P_NG_FLG_TX_DS              (0x20)

 #define NRF24L01P_NG_VAL_TX_DS(reg)         (((reg) & \

                                             NRF24L01P_NG_FLG_TX_DS) >> 5)

 #define NRF24L01P_NG_FLG_MAX_RT             (0x10)

 #define NRF24L01P_NG_VAL_MAX_RT(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_MAX_RT) >> 4)


 #define NRF24L01P_NG_FLG_RX_P_NO_NONE       (0x0e)

 #define NRF24L01P_NG_MSK_RX_P_NO            (0x0e)

 #define NRF24L01P_NG_FLG_RX_P_NO(val)       (((val) << 1) & \

                                             NRF24L01P_NG_MSK_RX_P_NO)

 #define NRF24L01P_NG_VAL_RX_P_NO(reg)       (((reg) & \

                                             NRF24L01P_NG_MSK_RX_P_NO) >> 1)


 #define NRF24L01P_NG_FLG_TX_FULL            (0x01)

 #define NRF24L01P_NG_VAL_TX_FULL(reg)       ((reg) & NRF24L01P_NG_FLG_TX_FULL)

 #define NRF24L01P_NG_REG_OBSERVE_TX         (0x08)

 #define NRF24L01P_NG_MSK_PLOS_CNT           (0xf0)

 #define NRF24L01P_NG_FLG_PLOS_CNT(val)      (((val) << 4) & \

                                             NRF24L01P_NG_MSK_PLOS_CNT)

 #define NRF24L01P_NG_VAL_PLOS_CNT(reg)      (((reg) & \

                                             NRF24L01P_NG_MSK_PLOS_CNT) >> 4)


 #define NRF24L01P_NG_MSK_ARC_CNT            (0x0f)

 #define NRF24L01P_NG_FLG_ARC_CNT(val)       ((val) & NRF24L01P_NG_MSK_ARC_CNT)

 #define NRF24L01P_NG_VAL_ARC_CNT(reg)       ((reg) & NRF24L01P_NG_MSK_ARC_CNT)

 #define NRF24L01P_NG_REG_RPD                (0x09)

 #define NRF24L01P_NG_FLG_RPD                (0x01)

 #define NRF24L01P_NG_VAL_RPD(reg)           ((reg) & NRF24L01P_NG_FLG_RPD)

 #define NRF24L01P_NG_REG_RX_ADDR_P0         (0x0A)

 #define NRF24L01P_NG_REG_RX_ADDR_P1         (0x0B)

 #define NRF24L01P_NG_REG_RX_ADDR_P2         (0x0C)

 #define NRF24L01P_NG_REG_RX_ADDR_P3         (0x0D)

 #define NRF24L01P_NG_REG_RX_ADDR_P4         (0x0E)

 #define NRF24L01P_NG_REG_RX_ADDR_P5         (0x0F)

 #define NRF24L01P_NG_REG_TX_ADDR            (0x10)

 #define NRF24L01P_NG_REG_RX_PW_P0           (0x11)

 #define NRF24L01P_NG_REG_RX_PW_P1           (0x12)

 #define NRF24L01P_NG_REG_RX_PW_P2           (0x13)

 #define NRF24L01P_NG_REG_RX_PW_P3           (0x14)

 #define NRF24L01P_NG_REG_RX_PW_P4           (0x15)

 #define NRF24L01P_NG_REG_RX_PW_P5           (0x16)

 #define NRF24L01P_NG_MSK_RX_PW_PX           (0x1f)

 #define NRF24L01P_NG_FLG_RX_PW_PX(val)      ((val) & NRF24L01P_NG_MSK_RX_PW_PX)

 #define NRF24L01P_NG_VAL_RX_PW_PX(reg)      ((reg) & NRF24L01P_NG_MSK_RX_PW_PX)

 #define NRF24L01P_NG_REG_FIFO_STATUS        (0x17)

 #define NRF24L01P_NG_FLG_TX_REUSE           (0x40)

 #define NRF24L01P_NG_VAL_TX_REUSE(reg)      (((reg) & \

                                             NRF24L01P_NG_FLG_TX_REUSE) >> 6)

 #define NRF24L01P_NG_FLG_TX_FULL_           (0x20)

 #define NRF24L01P_NG_VAL_TX_FULL_(reg)      (((reg) & \

                                             NRF24L01P_NG_FLG_TX_FULL_) >> 5)

 #define NRF24L01P_NG_FLG_TX_EMPTY           (0x10)

 #define NRF24L01P_NG_VAL_TX_EMPTY(reg)      (((reg) & \

                                             NRF24L01P_NG_FLG_TX_EMPTY) >> 4)

 #define NRF24L01P_NG_FLG_RX_FULL            (0x02)

 #define NRF24L01P_NG_VAL_RX_FULL(reg)       (((reg) & \

                                             NRF24L01P_NG_FLG_RX_FULL) >> 1)

 #define NRF24L01P_NG_FLG_RX_EMPTY           (0x01)

 #define NRF24L01P_NG_VAL_RX_EMPTY(reg)      ((reg) & NRF24L01P_NG_FLG_RX_EMPTY)

 #define NRF24L01P_NG_REG_DYNPD              (0x1C)

 #define NRF24L01P_NG_FLG_DPL_P5             (0x20)

 #define NRF24L01P_NG_VAL_DPL_P5(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_DPL_P5) >> 5)

 #define NRF24L01P_NG_FLG_DPL_P4             (0x10)

 #define NRF24L01P_NG_VAL_DPL_P4(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_DPL_P4) >> 4)

 #define NRF24L01P_NG_FLG_DPL_P3             (0x08)

 #define NRF24L01P_NG_VAL_DPL_P3(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_DPL_P3) >> 3)

 #define NRF24L01P_NG_FLG_DPL_P2             (0x04)

 #define NRF24L01P_NG_VAL_DPL_P2(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_DPL_P2) >> 2)

 #define NRF24L01P_NG_FLG_DPL_P1             (0x02)

 #define NRF24L01P_NG_VAL_DPL_P1(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_DPL_P1) >> 1)

 #define NRF24L01P_NG_FLG_DPL_P0             (0x01)

 #define NRF24L01P_NG_VAL_DPL_P0(reg)        ((reg) & NRF24L01P_NG_FLG_DPL_P0)

 #define NRF24L01P_NG_REG_FEATURES           (0x1D)

 #define NRF24L01P_NG_FLG_EN_DPL             (0x04)

 #define NRF24L01P_NG_VAL_EN_DPL(reg)        (((reg) & \

                                             NRF24L01P_NG_FLG_EN_DPL) >> 2)

 #define NRF24L01P_NG_FLG_EN_ACK_PAY         (0x02)

 #define NRF24L01P_NG_VAL_EN_ACK_PAY(reg)    (((reg) & \

                                             NRF24L01P_NG_FLG_EN_ACK_PAY) >> 1)

 #define NRF24L01P_NG_FLG_EN_DYN_ACK         (0x01)

 #define NRF24L01P_NG_VAL_EN_DYN_ACK(reg)    ((reg) & \

                                             NRF24L01P_NG_FLG_EN_DYN_ACK)

 static inline

 uint8_t nrf24l01p_ng_reg8_read(const nrf24l01p_ng_t *dev, uint8_t reg_addr) {

     uint8_t reg_val;

     nrf24l01p_ng_read_reg(dev, reg_addr, &reg_val, 1);

     return reg_val;

 }


 static inline

 uint8_t nrf24l01p_ng_reg8_write(const nrf24l01p_ng_t *dev,

                                 uint8_t reg_addr, uint8_t reg_val) {

     return nrf24l01p_ng_write_reg(dev, reg_addr, &reg_val, 1);

 }


 static inline

 uint8_t nrf24l01p_ng_reg8_set(const nrf24l01p_ng_t *dev,

                               uint8_t reg_addr, uint8_t *reg_val) {

     uint8_t reg_val_old;

     nrf24l01p_ng_read_reg(dev, reg_addr, &reg_val_old, sizeof(reg_val_old));

     *reg_val = reg_val_old | *reg_val;

     return nrf24l01p_ng_write_reg(dev, reg_addr, reg_val, sizeof(*reg_val));

 }

 static inline

 uint8_t nrf24l01p_ng_reg8_clear(const nrf24l01p_ng_t *dev,

                                 uint8_t reg_addr, uint8_t *reg_val) {

     uint8_t reg_val_old;

     nrf24l01p_ng_read_reg(dev, reg_addr, &reg_val_old, sizeof(reg_val_old));

     *reg_val = reg_val_old &= ~(*reg_val);

     return nrf24l01p_ng_write_reg(dev, reg_addr, reg_val, sizeof(*reg_val));

 }


 static inline

 uint8_t nrf24l01p_ng_reg8_mod(const nrf24l01p_ng_t *dev, uint8_t reg_addr,

                               uint8_t mask, uint8_t *reg_val) {

     uint8_t reg_val_old;

     nrf24l01p_ng_read_reg(dev, reg_addr, &reg_val_old, sizeof(reg_val_old));

     reg_val_old &= ~mask;

     *reg_val = reg_val_old | *reg_val;

     return nrf24l01p_ng_write_reg(dev, reg_addr, reg_val, sizeof(*reg_val));

 }


 #ifdef __cplusplus

 }

 #endif


 #endif /* NRF24L01P_NG_REGISTERS_H */

nrf24l01p_ng.h
Public interface for NRF24L01+ (NG) devices.

nrf24l01p_ng_communication.h
Functions to communicate with the NRF24L01+ (NG) transceiver via SPI.

nrf24l01p_ng_write_reg
uint8_t nrf24l01p_ng_write_reg(const nrf24l01p_ng_t *dev, uint8_t reg, const uint8_t *src, size_t len)
Write a register value.

nrf24l01p_ng_read_reg
uint8_t nrf24l01p_ng_read_reg(const nrf24l01p_ng_t *dev, uint8_t reg, uint8_t *dest, size_t len)
Read a register value.

nrf24l01p_ng_reg8_set
static uint8_t nrf24l01p_ng_reg8_set(const nrf24l01p_ng_t *dev, uint8_t reg_addr, uint8_t *reg_val)
Set bits in a certain 8-bit register.
Definition: nrf24l01p_ng_registers.h:922

nrf24l01p_ng_reg8_read
static uint8_t nrf24l01p_ng_reg8_read(const nrf24l01p_ng_t *dev, uint8_t reg_addr)
Read the contents of an 8 bit register.
Definition: nrf24l01p_ng_registers.h:891

nrf24l01p_ng_reg8_clear
static uint8_t nrf24l01p_ng_reg8_clear(const nrf24l01p_ng_t *dev, uint8_t reg_addr, uint8_t *reg_val)
Clear bits in a certain 8-bit register.
Definition: nrf24l01p_ng_registers.h:939

nrf24l01p_ng_reg8_mod
static uint8_t nrf24l01p_ng_reg8_mod(const nrf24l01p_ng_t *dev, uint8_t reg_addr, uint8_t mask, uint8_t *reg_val)
Modify bits in a certain 8-bit register.
Definition: nrf24l01p_ng_registers.h:958

nrf24l01p_ng_reg8_write
static uint8_t nrf24l01p_ng_reg8_write(const nrf24l01p_ng_t *dev, uint8_t reg_addr, uint8_t reg_val)
Write the contents of an 8 bit register.
Definition: nrf24l01p_ng_registers.h:907

nrf24l01p_ng
NRF24L01+ device struct.
Definition: nrf24l01p_ng.h:142