nrf24l01p_ng.h

Go to the documentation of this file.

/*
 * 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_H
#define NRF24L01P_NG_H
 
#include <stdint.h>
 
#include "board.h"
#include "kernel_defines.h"
#include "net/gnrc/nettype.h"
#include "net/netdev.h"
#include "periph/gpio.h"
#include "periph/spi.h"
 
#include "nrf24l01p_ng_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF24L01P_NG_MIN_ADDR_WIDTH         (3)
 
#define NRF24L01P_NG_MAX_ADDR_WIDTH         (5)
 
#ifndef NRF24L01P_NG_ADDR_WIDTH
#define NRF24L01P_NG_ADDR_WIDTH             NRF24L01P_NG_MAX_ADDR_WIDTH
#elif (NRF24L01P_NG_ADDR_WIDTH < NRF24L01P_NG_MIN_ADDR_WIDTH) || \
      (NRF24L01P_NG_ADDR_WIDTH > NRF24L01P_NG_MAX_ADDR_WIDTH)
#error "NRF24L01P_NG_ADDR_WIDTH must be within [3, 5]"
#endif
 
#define NRF24L01P_NG_BROADCAST_ADDR         { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }
 
#define NRF24L01P_NG_ADDR_P0(dev)           ((dev)->arxaddr.rx_addr_long[NRF24L01P_NG_P0])
 
#define NRF24L01P_NG_ADDR_P1(dev)           ((dev)->arxaddr.rx_addr_long[NRF24L01P_NG_P1])
 
#define NRF24L01P_NG_ADDR_PX_LSB(dev, pipe) ((dev)->arxaddr.rx_addr_short[(pipe) - 2])
 
typedef struct __attribute__((packed)) {
    uint8_t :                    1;
    uint8_t cfg_channel :        7;
    uint8_t :                    2;
    uint8_t cfg_crc :            2;
    uint8_t cfg_tx_power :       2;
    uint8_t cfg_data_rate :      2;
    uint8_t cfg_max_retr :       4;
    uint8_t cfg_retr_delay :     4;
} nrf24l01p_ng_cfg_t;
 
typedef struct {
    spi_t spi;                      
    spi_clk_t spi_clk;              
    gpio_t pin_cs;                  
    gpio_t pin_ce;                  
    gpio_t pin_irq;                 
    nrf24l01p_ng_cfg_t config;      
} nrf24l01p_ng_params_t;
 
struct nrf24l01p_ng {
    netdev_t netdev;                
    nrf24l01p_ng_params_t params;   
    uint8_t state;                  
    uint8_t idle_state;             
    struct {
        uint8_t rx_addr_long[2][NRF24L01P_NG_ADDR_WIDTH];
        uint8_t rx_addr_short[4];
    } arxaddr;
};
 
int nrf24l01p_ng_setup(nrf24l01p_ng_t *dev,
                       const nrf24l01p_ng_params_t *params,
                       uint8_t index);
 
int nrf24l01p_ng_set_enable_pipe(nrf24l01p_ng_t *dev, nrf24l01p_ng_pipe_t pipe,
                                 bool enable);
 
int nrf24l01p_ng_get_enable_pipe(nrf24l01p_ng_t *dev, nrf24l01p_ng_pipe_t pipe,
                                 bool* enable);
 
int nrf24l01p_ng_set_air_data_rate(nrf24l01p_ng_t *dev,
                                   nrf24l01p_ng_rfdr_t data_rate);
 
uint16_t nrf24l01p_ng_get_air_data_rate(const nrf24l01p_ng_t *dev,
                                        nrf24l01p_ng_rfdr_t *data_rate);
 
int nrf24l01p_ng_set_crc(nrf24l01p_ng_t *dev, nrf24l01p_ng_crc_t crc);
 
uint8_t nrf24l01p_ng_get_crc(const nrf24l01p_ng_t *dev,
                             nrf24l01p_ng_crc_t *crc);
 
int nrf24l01p_ng_set_tx_power(nrf24l01p_ng_t *dev,
                              nrf24l01p_ng_tx_power_t power);
 
int8_t nrf24l01p_ng_get_tx_power(const nrf24l01p_ng_t *dev,
                                 nrf24l01p_ng_tx_power_t *power);
 
int nrf24l01p_ng_set_channel(nrf24l01p_ng_t *dev, uint8_t channel);
 
uint8_t nrf24l01p_ng_get_channel(const nrf24l01p_ng_t *dev);
 
int nrf24l01p_ng_set_rx_address(nrf24l01p_ng_t *dev, const uint8_t *addr,
                                nrf24l01p_ng_pipe_t pipe);
 
int nrf24l01p_ng_get_rx_address(const nrf24l01p_ng_t *dev, uint8_t *addr,
                                nrf24l01p_ng_pipe_t pipe);
 
int nrf24l01p_ng_set_max_retransm(nrf24l01p_ng_t *dev, uint8_t max_rt);
 
uint8_t nrf24l01p_ng_get_max_retransm(const nrf24l01p_ng_t *dev);
 
int nrf24l01p_ng_set_retransm_delay(nrf24l01p_ng_t *dev,
                                    nrf24l01p_ng_ard_t rt_delay);
 
uint16_t nrf24l01p_ng_get_retransm_delay(const nrf24l01p_ng_t *dev,
                                         nrf24l01p_ng_ard_t *rt_delay);
 
int nrf24l01p_ng_set_state(nrf24l01p_ng_t *dev, nrf24l01p_ng_state_t state);
 
nrf24l01p_ng_state_t nrf24l01p_ng_get_state(const nrf24l01p_ng_t *dev);
 
void nrf24l01p_ng_eui_get(const netdev_t *dev, uint8_t *eui);
 
#if IS_USED(MODULE_NRF24L01P_NG_DIAGNOSTICS)
const char *
nrf24l01p_ng_diagnostics_state_to_string(nrf24l01p_ng_state_t state);
 
nrf24l01p_ng_state_t
nrf24l01p_ng_diagnostics_string_to_state(const char *sstate);
 
void nrf24l01p_ng_print_all_regs(nrf24l01p_ng_t *dev);
 
void nrf24l01p_ng_print_dev_info(const nrf24l01p_ng_t *dev);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF24L01P_NG_H */