nrf24l01p_ng_types.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_TYPES_H
#define NRF24L01P_NG_TYPES_H
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF24L01P_NG_TRANSITION_TO_POWER_DOWN   (1 << 3)
#define NRF24L01P_NG_TRANSITION_TO_STANDBY_1    (1 << 4)
#define NRF24L01P_NG_TRANSITION_TO_STANDBY_2    (1 << 5)
#define NRF24L01P_NG_TRANSITION_TO_RX_MODE      (1 << 6)
#define NRF24L01P_NG_TRANSITION_TO_TX_MODE      (1 << 7)
 
typedef enum nrf24l01p_ng_state {
    NRF24L01P_NG_STATE_UNDEFINED  = (0 |
                                    (NRF24L01P_NG_TRANSITION_TO_POWER_DOWN)),
    NRF24L01P_NG_STATE_POWER_DOWN = (1 |
                                    (NRF24L01P_NG_TRANSITION_TO_STANDBY_1)),
    NRF24L01P_NG_STATE_STANDBY_1  = (2 |
                                    (NRF24L01P_NG_TRANSITION_TO_POWER_DOWN |
                                    NRF24L01P_NG_TRANSITION_TO_STANDBY_2   |
                                    NRF24L01P_NG_TRANSITION_TO_RX_MODE     |
                                    NRF24L01P_NG_TRANSITION_TO_TX_MODE)),
    NRF24L01P_NG_STATE_STANDBY_2  = (3 |
                                    (NRF24L01P_NG_TRANSITION_TO_POWER_DOWN |
                                    NRF24L01P_NG_TRANSITION_TO_TX_MODE)),
    NRF24L01P_NG_STATE_RX_MODE    = (4 |
                                    (NRF24L01P_NG_TRANSITION_TO_POWER_DOWN |
                                    NRF24L01P_NG_TRANSITION_TO_STANDBY_1)),
    NRF24L01P_NG_STATE_TX_MODE    = (5 |
                                    (NRF24L01P_NG_TRANSITION_TO_POWER_DOWN |
                                    NRF24L01P_NG_TRANSITION_TO_STANDBY_1   |
                                    NRF24L01P_NG_TRANSITION_TO_STANDBY_2)),
} nrf24l01p_ng_state_t;
 
typedef enum nrf24l01p_ng_pipe {
    NRF24L01P_NG_P0    = 0, 
    NRF24L01P_NG_P1    = 1, 
    NRF24L01P_NG_P2    = 2, 
    NRF24L01P_NG_P3    = 3, 
    NRF24L01P_NG_P4    = 4, 
    NRF24L01P_NG_P5    = 5, 
    NRF24L01P_NG_PX_NUM_OF  
} nrf24l01p_ng_pipe_t;
 
typedef enum nrf24l01p_ng_aw {
    NRF24L01P_NG_AW_3BYTE = 1, 
    NRF24L01P_NG_AW_4BYTE = 2, 
    NRF24L01P_NG_AW_5BYTE = 3, 
    NRF24L01P_NG_AW_NUM_OF     
} nrf24l01p_ng_aw_t;
 
typedef enum nrf24l01p_ng_ard {
    NRF24L01P_NG_ARD_250US  = 0,  
    NRF24L01P_NG_ARD_500US  = 1,  
    NRF24L01P_NG_ARD_750US  = 2,  
    NRF24L01P_NG_ARD_1000US = 3,  
    NRF24L01P_NG_ARD_1250US = 4,  
    NRF24L01P_NG_ARD_1500US = 5,  
    NRF24L01P_NG_ARD_1750US = 6,  
    NRF24L01P_NG_ARD_2000US = 7,  
    NRF24L01P_NG_ARD_2250US = 8,  
    NRF24L01P_NG_ARD_2500US = 9,  
    NRF24L01P_NG_ARD_2750US = 10, 
    NRF24L01P_NG_ARD_3000US = 11, 
    NRF24L01P_NG_ARD_3250US = 12, 
    NRF24L01P_NG_ARD_3500US = 13, 
    NRF24L01P_NG_ARD_3750US = 14, 
    NRF24L01P_NG_ARD_4000US = 15, 
    NRF24L01P_NG_ARD_NUM_OF       
} nrf24l01p_ng_ard_t;
 
typedef enum nrf24l01p_ng_crc {
    NRF24L01P_NG_CRC_0BYTE = 1, 
    NRF24L01P_NG_CRC_1BYTE = 2, 
    NRF24L01P_NG_CRC_2BYTE = 3, 
} nrf24l01p_ng_crc_t;
 
typedef enum nrf24l01p_ng_tx_power {
    NRF24L01P_NG_TX_POWER_MINUS_18DBM = 0, 
    NRF24L01P_NG_TX_POWER_MINUS_12DBM = 1, 
    NRF24L01P_NG_TX_POWER_MINUS_6DBM  = 2, 
    NRF24L01P_NG_TX_POWER_0DBM        = 3, 
    NRF24L01P_NG_TX_POWER_NUM_OF           
} nrf24l01p_ng_tx_power_t;
 
typedef enum nrf24l01p_ng_rfdr {
    NRF24L01P_NG_RF_DR_1MBPS   = 0, 
    NRF24L01P_NG_RF_DR_250KBPS = 1, 
    NRF24L01P_NG_RF_DR_2MBPS   = 2, 
    NRF24L01P_NG_RF_DR_NUM_OF       
} nrf24l01p_ng_rfdr_t;
 
struct nrf24l01p_ng;
typedef struct nrf24l01p_ng nrf24l01p_ng_t; 
static inline
uint8_t nrf24l01p_ng_etoval_aw(nrf24l01p_ng_aw_t address_width)
{
    if (address_width <= NRF24L01P_NG_AW_3BYTE) {
        return 3;
    }
    if (address_width == NRF24L01P_NG_AW_4BYTE) {
        return 4;
    }
    return 5;
}
 
static inline
nrf24l01p_ng_aw_t nrf24l01p_ng_valtoe_aw(uint8_t address_width)
{
    if (address_width <= 3) {
        return NRF24L01P_NG_AW_3BYTE;
    }
    if (address_width == 4) {
        return NRF24L01P_NG_AW_4BYTE;
    }
    return NRF24L01P_NG_AW_5BYTE;
}
 
static inline
uint16_t nrf24l01p_ng_etoval_ard(nrf24l01p_ng_ard_t retr_delay)
{
    if (retr_delay >= NRF24L01P_NG_ARD_4000US) {
        return 4000;
    }
    return (retr_delay + 1) * 250;
}
 
static inline
nrf24l01p_ng_ard_t nrf24l01p_ng_valtoe_ard(uint16_t retr_delay)
{
    if (retr_delay >= 4000) {
        return NRF24L01P_NG_ARD_4000US;
    }
    if (retr_delay < 250) {
        return NRF24L01P_NG_ARD_250US;
    }
    return (nrf24l01p_ng_ard_t)((retr_delay / 250) - 1);
}
 
static inline
uint8_t nrf24l01p_ng_etoval_crc(nrf24l01p_ng_crc_t crc_len)
{
    if (crc_len <= NRF24L01P_NG_CRC_0BYTE) {
        return 0;
    }
    if (crc_len == NRF24L01P_NG_CRC_1BYTE) {
        return 1;
    }
    return 2;
}
 
static inline
nrf24l01p_ng_crc_t nrf24l01p_ng_valtoe_crc(uint8_t crc_len)
{
    if (!crc_len) {
        return NRF24L01P_NG_CRC_0BYTE;
    }
    if (crc_len == 1) {
        return NRF24L01P_NG_CRC_1BYTE;
    }
    return NRF24L01P_NG_CRC_2BYTE;
}
 
static inline
int8_t nrf24l01p_ng_etoval_tx_power(nrf24l01p_ng_tx_power_t power)
{
    if (power == NRF24L01P_NG_TX_POWER_MINUS_18DBM) {
        return -18;
    }
    if (power == NRF24L01P_NG_TX_POWER_MINUS_12DBM) {
        return -12;
    }
    if (power == NRF24L01P_NG_TX_POWER_MINUS_6DBM) {
        return -6;
    }
    return 0;
}
 
static inline
nrf24l01p_ng_tx_power_t nrf24l01p_ng_valtoe_tx_power(int16_t power)
{
    if (power <= -18) {
        return NRF24L01P_NG_TX_POWER_MINUS_18DBM;
    }
    if (power <= -12) {
        return NRF24L01P_NG_TX_POWER_MINUS_12DBM;
    }
    if (power <= -6) {
        return NRF24L01P_NG_TX_POWER_MINUS_6DBM;
    }
    return NRF24L01P_NG_TX_POWER_0DBM;
}
 
static inline
uint16_t nrf24l01p_ng_etoval_rfdr(nrf24l01p_ng_rfdr_t data_rate)
{
    if (data_rate == NRF24L01P_NG_RF_DR_1MBPS) {
        return 1000;
    }
    if (data_rate == NRF24L01P_NG_RF_DR_250KBPS) {
        return 250;
    }
    return 2000;
}
 
static inline
nrf24l01p_ng_rfdr_t nrf24l01p_ng_valtoe_rfdr(uint16_t data_rate)
{
    if (data_rate <= 250) {
        return NRF24L01P_NG_RF_DR_250KBPS;
    }
    if (data_rate <= 1000) {
        return NRF24L01P_NG_RF_DR_1MBPS;
    }
    return NRF24L01P_NG_RF_DR_2MBPS;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF24L01P_NG_TYPES_H */