lr1110_radio_types.h

Go to the documentation of this file.

 
#ifndef LR1110_RADIO_TYPES_H
#define LR1110_RADIO_TYPES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdbool.h>
#include <stdint.h>
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef enum
{
    LR1110_RADIO_PA_SEL_LP = 0x00,  
    LR1110_RADIO_PA_SEL_HP = 0x01,  
    LR1110_RADIO_PA_SEL_HF = 0x02  
} lr1110_radio_pa_selection_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_ADDRESS_FILTERING_DISABLE      = 0x00,  
    LR1110_RADIO_GFSK_ADDRESS_FILTERING_NODE_ADDRESS = 0x01,  
    LR1110_RADIO_GFSK_ADDRESS_FILTERING_NODE_AND_BROADCAST_ADDRESSES =
        0x02  
} lr1110_radio_gfsk_address_filtering_t;
 
typedef enum
{
    LR1110_RADIO_FALLBACK_STDBY_RC   = 0x01,  
    LR1110_RADIO_FALLBACK_STDBY_XOSC = 0x02,  
    LR1110_RADIO_FALLBACK_FS         = 0x03   
} lr1110_radio_fallback_modes_t;
 
typedef enum
{
    LR1110_RADIO_RAMP_16_US  = 0x00,  
    LR1110_RADIO_RAMP_32_US  = 0x01,  
    LR1110_RADIO_RAMP_48_US  = 0x02,  
    LR1110_RADIO_RAMP_64_US  = 0x03,  
    LR1110_RADIO_RAMP_80_US  = 0x04,  
    LR1110_RADIO_RAMP_96_US  = 0x05,  
    LR1110_RADIO_RAMP_112_US = 0x06,  
    LR1110_RADIO_RAMP_128_US = 0x07,  
    LR1110_RADIO_RAMP_144_US = 0x08,  
    LR1110_RADIO_RAMP_160_US = 0x09,  
    LR1110_RADIO_RAMP_176_US = 0x0A,  
    LR1110_RADIO_RAMP_192_US = 0x0B,  
    LR1110_RADIO_RAMP_208_US = 0x0C,  
    LR1110_RADIO_RAMP_240_US = 0x0D,  
    LR1110_RADIO_RAMP_272_US = 0x0E,  
    LR1110_RADIO_RAMP_304_US = 0x0F  
} lr1110_radio_ramp_time_t;
 
typedef enum
{
    LR1110_RADIO_LORA_NETWORK_PRIVATE = 0x00,  
    LR1110_RADIO_LORA_NETWORK_PUBLIC  = 0x01  
} lr1110_radio_lora_network_type_t;
 
typedef enum
{
    LR1110_RADIO_LORA_SF5  = 0x05,  
    LR1110_RADIO_LORA_SF6  = 0x06,  
    LR1110_RADIO_LORA_SF7  = 0x07,  
    LR1110_RADIO_LORA_SF8  = 0x08,  
    LR1110_RADIO_LORA_SF9  = 0x09,  
    LR1110_RADIO_LORA_SF10 = 0x0A,  
    LR1110_RADIO_LORA_SF11 = 0x0B,  
    LR1110_RADIO_LORA_SF12 = 0x0C  
} lr1110_radio_lora_sf_t;
 
typedef enum
{
    LR1110_RADIO_LORA_BW_10  = 0x08,  
    LR1110_RADIO_LORA_BW_15  = 0x01,  
    LR1110_RADIO_LORA_BW_20  = 0x09,  
    LR1110_RADIO_LORA_BW_31  = 0x02,  
    LR1110_RADIO_LORA_BW_41  = 0x0A,  
    LR1110_RADIO_LORA_BW_62  = 0x03,  
    LR1110_RADIO_LORA_BW_125 = 0x04,  
    LR1110_RADIO_LORA_BW_250 = 0x05,  
    LR1110_RADIO_LORA_BW_500 = 0x06  
} lr1110_radio_lora_bw_t;
 
typedef enum
{
    LR1110_RADIO_LORA_NO_CR     = 0x00,  
    LR1110_RADIO_LORA_CR_4_5    = 0x01,  
    LR1110_RADIO_LORA_CR_4_6    = 0x02,  
    LR1110_RADIO_LORA_CR_4_7    = 0x03,  
    LR1110_RADIO_LORA_CR_4_8    = 0x04,  
    LR1110_RADIO_LORA_CR_LI_4_5 = 0x05,  
    LR1110_RADIO_LORA_CR_LI_4_6 = 0x06,  
    LR1110_RADIO_LORA_CR_LI_4_8 = 0x07  
} lr1110_radio_lora_cr_t;
 
typedef enum
{
    LR1110_RADIO_MODE_SLEEP        = 0x00,  
    LR1110_RADIO_MODE_STANDBY_RC   = 0x01,  
    LR1110_RADIO_MODE_STANDBY_XOSC = 0x02,  
    LR1110_RADIO_MODE_FS           = 0x03   
} lr1110_radio_intermediary_mode_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_CRC_OFF         = 0x01,  
    LR1110_RADIO_GFSK_CRC_1_BYTE      = 0x00,
    LR1110_RADIO_GFSK_CRC_2_BYTES     = 0x02,
    LR1110_RADIO_GFSK_CRC_1_BYTE_INV  = 0x04,
    LR1110_RADIO_GFSK_CRC_2_BYTES_INV = 0x06
} lr1110_radio_gfsk_crc_type_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_DC_FREE_OFF       = 0x00,  
    LR1110_RADIO_GFSK_DC_FREE_WHITENING = 0x01  
} lr1110_radio_gfsk_dc_free_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_PKT_FIX_LEN = 0x00,  
    LR1110_RADIO_GFSK_PKT_VAR_LEN = 0x01   
} lr1110_radio_gfsk_pkt_len_modes_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_PREAMBLE_DETECTOR_OFF        = 0x00,
    LR1110_RADIO_GFSK_PREAMBLE_DETECTOR_MIN_8BITS  = 0x04,
    LR1110_RADIO_GFSK_PREAMBLE_DETECTOR_MIN_16BITS = 0x05,
    LR1110_RADIO_GFSK_PREAMBLE_DETECTOR_MIN_24BITS = 0x06,
    LR1110_RADIO_GFSK_PREAMBLE_DETECTOR_MIN_32BITS = 0x07
} lr1110_radio_gfsk_preamble_detector_t;
 
typedef enum
{
    LR1110_RADIO_LORA_CRC_OFF = 0x00,  
    LR1110_RADIO_LORA_CRC_ON  = 0x01  
} lr1110_radio_lora_crc_t;
 
typedef enum
{
    LR1110_RADIO_LORA_PKT_EXPLICIT = 0x00,  
    LR1110_RADIO_LORA_PKT_IMPLICIT = 0x01  
} lr1110_radio_lora_pkt_len_modes_t;
 
typedef enum
{
    LR1110_RADIO_LORA_IQ_STANDARD = 0x00,  
    LR1110_RADIO_LORA_IQ_INVERTED = 0x01  
} lr1110_radio_lora_iq_t;
 
typedef enum
{
    LR1110_RADIO_PKT_NONE      = 0x00,  
    LR1110_RADIO_PKT_TYPE_GFSK = 0x01,  
    LR1110_RADIO_PKT_TYPE_LORA = 0x02  
} lr1110_radio_pkt_type_t;
 
typedef enum
{
    LR1110_RADIO_PA_REG_SUPPLY_VREG = 0x00,  
    LR1110_RADIO_PA_REG_SUPPLY_VBAT = 0x01   
} lr1110_radio_pa_reg_supply_t;
 
typedef enum
{
    LR1110_RADIO_RX_DUTY_CYCLE_MODE_RX  = 0x00,  
    LR1110_RADIO_RX_DUTY_CYCLE_MODE_CAD = 0x01  
} lr1110_radio_rx_duty_cycle_mode_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_BW_4800   = 0x1F,  
    LR1110_RADIO_GFSK_BW_5800   = 0x17,  
    LR1110_RADIO_GFSK_BW_7300   = 0x0F,  
    LR1110_RADIO_GFSK_BW_9700   = 0x1E,  
    LR1110_RADIO_GFSK_BW_11700  = 0x16,  
    LR1110_RADIO_GFSK_BW_14600  = 0x0E,  
    LR1110_RADIO_GFSK_BW_19500  = 0x1D,  
    LR1110_RADIO_GFSK_BW_23400  = 0x15,  
    LR1110_RADIO_GFSK_BW_29300  = 0x0D,  
    LR1110_RADIO_GFSK_BW_39000  = 0x1C,  
    LR1110_RADIO_GFSK_BW_46900  = 0x14,  
    LR1110_RADIO_GFSK_BW_58600  = 0x0C,  
    LR1110_RADIO_GFSK_BW_78200  = 0x1B,  
    LR1110_RADIO_GFSK_BW_93800  = 0x13,  
    LR1110_RADIO_GFSK_BW_117300 = 0x0B,  
    LR1110_RADIO_GFSK_BW_156200 = 0x1A,  
    LR1110_RADIO_GFSK_BW_187200 = 0x12,  
    LR1110_RADIO_GFSK_BW_234300 = 0x0A,  
    LR1110_RADIO_GFSK_BW_312000 = 0x19,  
    LR1110_RADIO_GFSK_BW_373600 = 0x11,  
    LR1110_RADIO_GFSK_BW_467000 = 0x09   
} lr1110_radio_gfsk_bw_t;
 
typedef enum
{
    LR1110_RADIO_CAD_EXIT_MODE_STANDBYRC = 0x00,  
    LR1110_RADIO_CAD_EXIT_MODE_RX        = 0x01,  
    LR1110_RADIO_CAD_EXIT_MODE_TX        = 0x10  
} lr1110_radio_cad_exit_mode_t;
 
typedef enum
{
    LR1110_RADIO_GFSK_PULSE_SHAPE_OFF   = 0x00,  
    LR1110_RADIO_GFSK_PULSE_SHAPE_BT_03 = 0x08,  
    LR1110_RADIO_GFSK_PULSE_SHAPE_BT_05 = 0x09,  
    LR1110_RADIO_GFSK_PULSE_SHAPE_BT_07 = 0x0A,  
    LR1110_RADIO_GFSK_PULSE_SHAPE_BT_1  = 0x0B   
} lr1110_radio_gfsk_pulse_shape_t;
 
typedef struct lr1110_radio_cad_params_s
{
    uint8_t cad_symb_nb;                         
    uint8_t cad_detect_peak;                     
    uint8_t cad_detect_min;                      
    lr1110_radio_cad_exit_mode_t cad_exit_mode;  
    uint32_t                     cad_timeout;    
} lr1110_radio_cad_params_t;
 
typedef struct lr1110_radio_pkt_status_gfsk_s
{
    int8_t  rssi_sync_in_dbm;  
    int8_t  rssi_avg_in_dbm;   
    uint8_t rx_len_in_bytes;   
    bool    is_addr_err;  
    bool is_crc_err;      
    bool is_len_err;      
    bool is_abort_err;    
    bool is_received;     
    bool is_sent;         
} lr1110_radio_pkt_status_gfsk_t;
 
typedef struct lr1110_radio_pkt_status_lora_s
{
    int8_t rssi_pkt_in_dbm;         
    int8_t snr_pkt_in_db;           
    int8_t signal_rssi_pkt_in_dbm;  
} lr1110_radio_pkt_status_lora_t;
 
typedef struct lr1110_radio_rx_buffer_status_s
{
    uint8_t pld_len_in_bytes;      
    uint8_t buffer_start_pointer;  
} lr1110_radio_rx_buffer_status_t;
 
typedef struct lr1110_radio_stats_gfsk_s
{
    uint16_t nb_pkt_received;   
    uint16_t nb_pkt_crc_error;  
    uint16_t nb_pkt_len_error;  
} lr1110_radio_stats_gfsk_t;
 
typedef struct lr1110_radio_stats_lora_s
{
    uint16_t nb_pkt_received;      
    uint16_t nb_pkt_crc_error;     
    uint16_t nb_pkt_header_error;  
    uint16_t nb_pkt_falsesync;     
} lr1110_radio_stats_lora_t;
 
typedef struct lr1110_radio_mod_params_gfsk_s
{
    uint32_t                        br_in_bps;     
    lr1110_radio_gfsk_pulse_shape_t pulse_shape;   
    lr1110_radio_gfsk_bw_t          bw_dsb_param;  
    uint32_t                        fdev_in_hz;    
} lr1110_radio_mod_params_gfsk_t;
 
typedef struct lr1110_radio_mod_params_lora_s
{
    lr1110_radio_lora_sf_t sf;    
    lr1110_radio_lora_bw_t bw;    
    lr1110_radio_lora_cr_t cr;    
    uint8_t                ldro;  
} lr1110_radio_mod_params_lora_t;
 
typedef struct lr1110_radio_pkt_params_gfsk_s
{
    uint16_t                              preamble_len_in_bits;   
    lr1110_radio_gfsk_preamble_detector_t preamble_detector;      
    uint8_t                               sync_word_len_in_bits;  
    lr1110_radio_gfsk_address_filtering_t address_filtering;      
    lr1110_radio_gfsk_pkt_len_modes_t     header_type;            
    uint8_t                               pld_len_in_bytes;       
    lr1110_radio_gfsk_crc_type_t          crc_type;               
    lr1110_radio_gfsk_dc_free_t           dc_free;                
} lr1110_radio_pkt_params_gfsk_t;
 
typedef struct lr1110_radio_pkt_params_lora_s
{
    uint16_t                          preamble_len_in_symb;  
    lr1110_radio_lora_pkt_len_modes_t header_type;           
    uint8_t                           pld_len_in_bytes;      
    lr1110_radio_lora_crc_t           crc;                   
    lr1110_radio_lora_iq_t            iq;                    
} lr1110_radio_pkt_params_lora_t;
 
typedef struct lr1110_radio_pa_cfg_s
{
    lr1110_radio_pa_selection_t  pa_sel;         
    lr1110_radio_pa_reg_supply_t pa_reg_supply;  
    uint8_t                      pa_duty_cycle;  
    uint8_t                      pa_hp_sel;      
} lr1110_radio_pa_cfg_t;
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_RADIO_TYPES_H
 
/* --- EOF ------------------------------------------------------------------ */