sx126x.h

Go to the documentation of this file.

 
#ifndef SX126X_H
#define SX126X_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include <stdint.h>
#include <stdbool.h>
#include "networkif.h"
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define SX126X_MAX_TIMEOUT_IN_RTC_STEP 0x00FFFFFE
 
#define SX126X_MAX_TIMEOUT_IN_MS (SX126X_MAX_TIMEOUT_IN_RTC_STEP / 64)
 
#define SX126X_RX_SINGLE_MODE 0x00000000
 
#define SX126X_RX_CONTINUOUS 0x00FFFFFF
 
#define SX126X_CHIP_MODES_POS (4U)
#define SX126X_CHIP_MODES_MASK (0x07UL << SX126X_CHIP_MODES_POS)
 
#define SX126X_CMD_STATUS_POS (1U)
#define SX126X_CMD_STATUS_MASK (0x07UL << SX126X_CMD_STATUS_POS)
 
#define SX126X_GFSK_RX_STATUS_PKT_SENT_POS (0U)
#define SX126X_GFSK_RX_STATUS_PKT_SENT_MASK (0x01UL << SX126X_GFSK_RX_STATUS_PKT_SENT_POS)
 
#define SX126X_GFSK_RX_STATUS_PKT_RECEIVED_POS (1U)
#define SX126X_GFSK_RX_STATUS_PKT_RECEIVED_MASK (0x01UL << SX126X_GFSK_RX_STATUS_PKT_RECEIVED_POS)
 
#define SX126X_GFSK_RX_STATUS_ABORT_ERROR_POS (2U)
#define SX126X_GFSK_RX_STATUS_ABORT_ERROR_MASK (0x01UL << SX126X_GFSK_RX_STATUS_ABORT_ERROR_POS)
 
#define SX126X_GFSK_RX_STATUS_LENGTH_ERROR_POS (3U)
#define SX126X_GFSK_RX_STATUS_LENGTH_ERROR_MASK (0x01UL << SX126X_GFSK_RX_STATUS_LENGTH_ERROR_POS)
 
#define SX126X_GFSK_RX_STATUS_CRC_ERROR_POS (4U)
#define SX126X_GFSK_RX_STATUS_CRC_ERROR_MASK (0x01UL << SX126X_GFSK_RX_STATUS_CRC_ERROR_POS)
 
#define SX126X_GFSK_RX_STATUS_ADRS_ERROR_POS (5U)
#define SX126X_GFSK_RX_STATUS_ADRS_ERROR_MASK (0x01UL << SX126X_GFSK_RX_STATUS_ADRS_ERROR_POS)
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
typedef enum sx126x_status_e {
  SX126X_STATUS_OK = 0,
  SX126X_STATUS_UNSUPPORTED_FEATURE,
  SX126X_STATUS_UNKNOWN_VALUE,
  SX126X_STATUS_ERROR,
} sx126x_status_t;
 
typedef enum sx126x_sleep_cfgs_e {
  SX126X_SLEEP_CFG_COLD_START   = (0 << 2),
  SX126X_SLEEP_CFG_WARM_START   = (1 << 2),
} sx126x_sleep_cfgs_t;
 
typedef enum sx126x_standby_cfgs_e {
  SX126X_STANDBY_CFG_RC         = 0x00,
  SX126X_STANDBY_CFG_XOSC       = 0x01,
} sx126x_standby_cfgs_t;
 
typedef uint8_t sx126x_standby_cfg_t;
 
typedef enum sx126x_reg_mods_e {
  SX126X_REG_MODE_LDO   = 0x00,   // default
  SX126X_REG_MODE_DCDC  = 0x01,
} sx126x_reg_mod_t;
 
typedef struct sx126x_pa_cfg_params_s {
  uint8_t       pa_duty_cycle;
  uint8_t       hp_max;
  uint8_t       device_sel;
  uint8_t       pa_lut;
} sx126x_pa_cfg_params_t;
 
typedef enum sx126x_fallback_modes_e {
  SX126X_FALLBACK_STDBY_RC      = 0x20,
  SX126X_FALLBACK_STDBY_XOSC    = 0x30,
  SX126X_FALLBACK_FS            = 0x40,
} sx126x_fallback_modes_t;
 
enum sx126x_irq_masks_e {
  SX126X_IRQ_NONE               = (0 << 0),
  SX126X_IRQ_TX_DONE            = (1 << 0),
  SX126X_IRQ_RX_DONE            = (1 << 1),
  SX126X_IRQ_PREAMBLE_DETECTED  = (1 << 2),
  SX126X_IRQ_SYNC_WORD_VALID    = (1 << 3),
  SX126X_IRQ_HEADER_VALID       = (1 << 4),
  SX126X_IRQ_HEADER_ERROR       = (1 << 5),
  SX126X_IRQ_CRC_ERROR          = (1 << 6),
  SX126X_IRQ_CAD_DONE           = (1 << 7),
  SX126X_IRQ_CAD_DETECTED       = (1 << 8),
  SX126X_IRQ_TIMEOUT            = (1 << 9),
  SX126X_IRQ_ALL                = SX126X_IRQ_TX_DONE | SX126X_IRQ_RX_DONE | SX126X_IRQ_PREAMBLE_DETECTED |
                                  SX126X_IRQ_SYNC_WORD_VALID | SX126X_IRQ_HEADER_VALID | SX126X_IRQ_HEADER_ERROR |
                                  SX126X_IRQ_CRC_ERROR | SX126X_IRQ_CAD_DONE | SX126X_IRQ_CAD_DETECTED | SX126X_IRQ_TIMEOUT,
};
 
typedef uint16_t sx126x_irq_mask_t;
 
enum sx126x_cal_mask_e {
  SX126X_CAL_RC64K      = (1 << 0),
  SX126X_CAL_RC13M      = (1 << 1),
  SX126X_CAL_PLL        = (1 << 2),
  SX126X_CAL_ADC_PULSE  = (1 << 3),
  SX126X_CAL_ADC_BULK_N = (1 << 4),
  SX126X_CAL_ADC_BULK_P = (1 << 5),
  SX126X_CAL_IMAGE      = (1 << 6),
  SX126X_CAL_ALL        = SX126X_CAL_RC64K | SX126X_CAL_RC13M | SX126X_CAL_PLL | SX126X_CAL_ADC_PULSE |
                          SX126X_CAL_ADC_BULK_N | SX126X_CAL_ADC_BULK_P | SX126X_CAL_IMAGE,
};
 
typedef uint8_t sx126x_cal_mask_t;
 
typedef enum sx126x_tcxo_ctrl_voltages_e {
  SX126X_TCXO_CTRL_1_6V = 0x00,
  SX126X_TCXO_CTRL_1_7V = 0x01,
  SX126X_TCXO_CTRL_1_8V = 0x02,
  SX126X_TCXO_CTRL_2_2V = 0x03,
  SX126X_TCXO_CTRL_2_4V = 0x04,
  SX126X_TCXO_CTRL_2_7V = 0x05,
  SX126X_TCXO_CTRL_3_0V = 0x06,
  SX126X_TCXO_CTRL_3_3V = 0x07,
} sx126x_tcxo_ctrl_voltages_t;
 
typedef enum sx126x_pkt_types_e {
  SX126X_PKT_TYPE_GFSK  = 0x00,
  SX126X_PKT_TYPE_LORA  = 0x01,
} sx126x_pkt_type_t;
 
typedef enum sx126x_ramp_time_e {
  SX126X_RAMP_10_US     = 0x00,
  SX126X_RAMP_20_US     = 0x01,
  SX126X_RAMP_40_US     = 0x02,
  SX126X_RAMP_80_US     = 0x03,
  SX126X_RAMP_200_US    = 0x04,
  SX126X_RAMP_800_US    = 0x05,
  SX126X_RAMP_1700_US   = 0x06,
  SX126X_RAMP_3400_US   = 0x07,
} sx126x_ramp_time_t;
 
typedef enum sx126x_gfsk_pulse_shape_e {
  SX126X_GFSK_PULSE_SHAPE_OFF   = 0x00,
  SX126X_GFSK_PULSE_SHAPE_BT_03 = 0x08,
  SX126X_GFSK_PULSE_SHAPE_BT_05 = 0x09,
  SX126X_GFSK_PULSE_SHAPE_BT_07 = 0x0A,
  SX126X_GFSK_PULSE_SHAPE_BT_1  = 0x0B,
} sx126x_gfsk_pulse_shape_t;
 
typedef enum sx126x_gfsk_bw_e {
  SX126X_GFSK_BW_4800   = 0x1F,
  SX126X_GFSK_BW_5800   = 0x17,
  SX126X_GFSK_BW_7300   = 0x0F,
  SX126X_GFSK_BW_9700   = 0x1E,
  SX126X_GFSK_BW_11700  = 0x16,
  SX126X_GFSK_BW_14600  = 0x0E,
  SX126X_GFSK_BW_19500  = 0x1D,
  SX126X_GFSK_BW_23400  = 0x15,
  SX126X_GFSK_BW_29300  = 0x0D,
  SX126X_GFSK_BW_39000  = 0x1C,
  SX126X_GFSK_BW_46900  = 0x14,
  SX126X_GFSK_BW_58600  = 0x0C,
  SX126X_GFSK_BW_78200  = 0x1B,
  SX126X_GFSK_BW_93800  = 0x13,
  SX126X_GFSK_BW_117300 = 0x0B,
  SX126X_GFSK_BW_156200 = 0x1A,
  SX126X_GFSK_BW_187200 = 0x12,
  SX126X_GFSK_BW_234300 = 0x0A,
  SX126X_GFSK_BW_312000 = 0x19,
  SX126X_GFSK_BW_373600 = 0x11,
  SX126X_GFSK_BW_467000 = 0x09,
} sx126x_gfsk_bw_t;
 
typedef struct sx126x_mod_params_gfsk_s {
  uint32_t                      br_in_bps;
  uint32_t                      fdev_in_hz;
  sx126x_gfsk_pulse_shape_t     pulse_shape;
  sx126x_gfsk_bw_t              bw_dsb_param;
} sx126x_mod_params_gfsk_t;
 
typedef enum sx126x_lora_sf_e {
  SX126X_LORA_SF5       = 0x05,
  SX126X_LORA_SF6       = 0x06,
  SX126X_LORA_SF7       = 0x07,
  SX126X_LORA_SF8       = 0x08,
  SX126X_LORA_SF9       = 0x09,
  SX126X_LORA_SF10      = 0x0A,
  SX126X_LORA_SF11      = 0x0B,
  SX126X_LORA_SF12      = 0x0C,
} sx126x_lora_sf_t;
 
typedef enum sx126x_lora_bw_e {
  SX126X_LORA_BW_500    = 6,
  SX126X_LORA_BW_250    = 5,
  SX126X_LORA_BW_125    = 4,
  SX126X_LORA_BW_062    = 3,
  SX126X_LORA_BW_041    = 10,
  SX126X_LORA_BW_031    = 2,
  SX126X_LORA_BW_020    = 9,
  SX126X_LORA_BW_015    = 1,
  SX126X_LORA_BW_010    = 8,
  SX126X_LORA_BW_007    = 0,
} sx126x_lora_bw_t;
 
typedef enum sx126x_lora_cr_e {
  SX126X_LORA_CR_4_5    = 0x01,
  SX126X_LORA_CR_4_6    = 0x02,
  SX126X_LORA_CR_4_7    = 0x03,
  SX126X_LORA_CR_4_8    = 0x04,
} sx126x_lora_cr_t;
 
typedef struct sx126x_mod_params_lora_s {
  sx126x_lora_sf_t      sf;     
  sx126x_lora_bw_t      bw;     
  sx126x_lora_cr_t      cr;     
  uint8_t               ldro;   
} sx126x_mod_params_lora_t;
 
typedef enum sx126x_gfsk_preamble_detector_e {
  SX126X_GFSK_PREAMBLE_DETECTOR_OFF             = 0x00,
  SX126X_GFSK_PREAMBLE_DETECTOR_MIN_8BITS       = 0x04,
  SX126X_GFSK_PREAMBLE_DETECTOR_MIN_16BITS      = 0x05,
  SX126X_GFSK_PREAMBLE_DETECTOR_MIN_24BITS      = 0x06,
  SX126X_GFSK_PREAMBLE_DETECTOR_MIN_32BITS      = 0x07,
} sx126x_gfsk_preamble_detector_t;
 
typedef enum sx126x_gfsk_address_filtering_e {
  SX126X_GFSK_ADDRESS_FILTERING_DISABLE                         = 0x00,
  SX126X_GFSK_ADDRESS_FILTERING_NODE_ADDRESS                    = 0x01,
  SX126X_GFSK_ADDRESS_FILTERING_NODE_AND_BROADCAST_ADDRESSES    = 0x02,
} sx126x_gfsk_address_filtering_t;
 
typedef enum sx126x_gfsk_pkt_len_modes_e {
  SX126X_GFSK_PKT_FIX_LEN       = 0x00, 
  SX126X_GFSK_PKT_VAR_LEN       = 0x01, 
} sx126x_gfsk_pkt_len_modes_t;
 
typedef enum sx16x_gfsk_crc_types_e {
  SX126X_GFSK_CRC_OFF           = 0x01,
  SX126X_GFSK_CRC_1_BYTE        = 0x00,
  SX126X_GFSK_CRC_2_BYTES       = 0x02,
  SX126X_GFSK_CRC_1_BYTE_INV    = 0x04,
  SX126X_GFSK_CRC_2_BYTES_INV   = 0x06,
} sx126x_gfsk_crc_types_t;
 
typedef enum sx126x_gfsk_dc_free_e {
  SX126X_GFSK_DC_FREE_OFF       = 0x00,
  SX126X_GFSK_DC_FREE_WHITENING = 0x01,
} sx126x_gfsk_dc_free_t;
 
typedef enum sx126x_lora_pkt_len_modes_e {
  SX126X_LORA_PKT_EXPLICIT      = 0x00, 
  SX126X_LORA_PKT_IMPLICIT      = 0x01, 
} sx126x_lora_pkt_len_modes_t;
 
typedef struct sx126x_pkt_params_lora_s {
  uint16_t                      preamble_len_in_symb;   
  sx126x_lora_pkt_len_modes_t   header_type;            
  uint8_t                       pld_len_in_bytes;       
  bool                          crc_is_on;              
  bool                          invert_iq_is_on;        
} sx126x_pkt_params_lora_t;
 
typedef struct sx126x_pkt_params_gfsk_s {
  uint16_t                              preamble_len_in_bits;   
  sx126x_gfsk_preamble_detector_t       preamble_detector;      
  uint8_t                               sync_word_len_in_bits;  
  sx126x_gfsk_address_filtering_t       address_filtering;      
  sx126x_gfsk_pkt_len_modes_t           header_type;            
  uint8_t                               pld_len_in_bytes;       
  sx126x_gfsk_crc_types_t               crc_type;               
  sx126x_gfsk_dc_free_t                 dc_free;                
} sx126x_pkt_params_gfsk_t;
 
typedef enum sx126x_cad_symbs_e {
  SX126X_CAD_01_SYMB    = 0x00,
  SX126X_CAD_02_SYMB    = 0x01,
  SX126X_CAD_04_SYMB    = 0x02,
  SX126X_CAD_08_SYMB    = 0x03,
  SX126X_CAD_16_SYMB    = 0x04,
} sx126x_cad_symbs_t;
 
typedef enum sx126x_cad_exit_modes_e {
  SX126X_CAD_ONLY       = 0x00,
  SX126X_CAD_RX         = 0x01,
  SX126X_CAD_LBT        = 0x10,
} sx126x_cad_exit_modes_t;
 
typedef struct sx126x_cad_param_s {
  sx126x_cad_symbs_t            cad_symb_nb;            
  uint8_t                       cad_detect_peak;        
  uint8_t                       cad_detect_min;         
  sx126x_cad_exit_modes_t       cad_exit_mode;          
  uint32_t                      cad_timeout;            
} sx126x_cad_params_t;
 
typedef enum sx126x_chip_modes_e {
  SX126X_CHIP_MODE_UNUSED       = 0,
  SX126X_CHIP_MODE_RFU          = 1,
  SX126X_CHIP_MODE_STBY_RC      = 2,
  SX126X_CHIP_MODE_STBY_XOSC    = 3,
  SX126X_CHIP_MODE_FS           = 4,
  SX126X_CHIP_MODE_RX           = 5,
  SX126X_CHIP_MODE_TX           = 6,
} sx126x_chip_modes_t;
 
typedef enum sx126x_cmd_status_e {
  SX126X_CMD_STATUS_RESERVED            = 0,
  SX126X_CMD_STATUS_RFU                 = 1,
  SX126X_CMD_STATUS_DATA_AVAILABLE      = 2,
  SX126X_CMD_STATUS_CMD_TIMEOUT         = 3,
  SX126X_CMD_STATUS_CMD_PROCESS_ERROR   = 4,
  SX126X_CMD_STATUS_CMD_EXEC_FAILURE    = 5,
  SX126X_CMD_STATUS_CMD_TX_DONE         = 6,
} sx126x_cmd_status_t;
 
typedef struct sx126x_chip_status_s {
  sx126x_cmd_status_t   cmd_status;     
  sx126x_chip_modes_t   chip_mode;      
} sx126x_chip_status_t;
 
typedef struct sx126x_rx_buffer_status_s {
  uint8_t       pld_len_in_bytes;       
  uint8_t       buffer_start_pointer;   
} sx126x_rx_buffer_status_t;
 
typedef struct sx126x_rx_status_gfsk_s {
  bool  pkt_sent;
  bool  pkt_received;
  bool  abort_error;
  bool  length_error;
  bool  crc_error;
  bool  adrs_error;
} sx126x_rx_status_gfsk_t;
 
typedef struct sx126x_pkt_status_gfsk_s {
  sx126x_rx_status_gfsk_t       rx_status;
  int8_t                        rssi_sync;      
  int8_t                        rssi_avg;       
} sx126x_pkt_status_gfsk_t;
 
typedef struct sx126x_pkt_status_lora_s {
  int8_t        rssi_pkt_in_dbm;        
  int8_t        snr_pkt_in_db;          
  int8_t        signal_rssi_pkt_in_dbm; 
} sx126x_pkt_status_lora_t;
 
typedef struct sx126x_stats_gfsk_s {
  uint16_t      nb_pkt_received;
  uint16_t      nb_pkt_crc_error;
  uint16_t      nb_pkt_len_error;
} sx126x_stats_gfsk_t;
 
typedef struct sx126x_stats_lora_s {
  uint16_t      nb_pkt_received;
  uint16_t      nb_pkt_crc_error;
  uint16_t      nb_pkt_header_error;
} sx126x_stats_lora_t;
 
enum sx126x_errors_e {
  SX126X_ERRORS_RC64K_CALIBRATION       = (1 << 0),
  SX126X_ERRORS_RC13M_CALIBRATION       = (1 << 1),
  SX126X_ERRORS_PLL_CALIBRATION         = (1 << 2),
  SX126X_ERRORS_ADC_CALIBRATION         = (1 << 3),
  SX126X_ERRORS_IMG_CALIBRATION         = (1 << 4),
  SX126X_ERRORS_XOSC_START              = (1 << 5),
  SX126X_ERRORS_PLL_LOCK                = (1 << 6),
  SX126X_ERRORS_PA_RAMP                 = (1 << 8),
};
 
typedef uint16_t sx126x_errors_mask_t;
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
//
// Operational Modes Functions
//
 
sx126x_status_t sx126x_set_sleep(struct network_context *nctx, const sx126x_sleep_cfgs_t cfg);
 
sx126x_status_t sx126x_set_standby(struct network_context *nctx, const sx126x_standby_cfg_t cfg);
 
sx126x_status_t sx126x_set_fs(struct network_context *nctx);
 
sx126x_status_t sx126x_set_tx(struct network_context *nctx, const uint32_t timeout_in_ms);
 
sx126x_status_t sx126x_set_tx_with_timeout_in_rtc_step(struct network_context *nctx, const uint32_t timeout_in_rtc_step);
 
sx126x_status_t sx126x_set_rx(struct network_context *nctx, const uint32_t timeout_in_ms);
 
sx126x_status_t sx126x_set_rx_with_timeout_in_rtc_step(struct network_context *nctx, const uint32_t timeout_in_rtc_step);
 
sx126x_status_t sx126x_stop_timer_on_preamble(struct network_context *nctx, const bool enable);
 
sx126x_status_t sx126x_set_rx_duty_cycle(struct network_context *nctx, const uint32_t rx_time_in_ms, const uint32_t sleep_time_in_ms);
 
sx126x_status_t sx126x_set_rx_duty_cycle_with_timings_in_rtc_step(struct network_context *nctx, const uint32_t rx_time_in_rtc_step, const uint32_t sleep_time_in_rtc_step);
 
sx126x_status_t sx126x_set_cad(struct network_context *nctx);
 
sx126x_status_t sx126x_set_tx_cw(struct network_context *nctx);
 
sx126x_status_t sx126x_set_tx_infinite_preamble(struct network_context *nctx);
 
sx126x_status_t sx126x_set_reg_mode(struct network_context *nctx, const sx126x_reg_mod_t mode);
 
sx126x_status_t sx126x_cal(struct network_context *nctx, const sx126x_cal_mask_t param);
 
sx126x_status_t sx126x_cal_img(struct network_context *nctx, const uint32_t freq_in_hz);
 
sx126x_status_t sx126x_set_pa_cfg(struct network_context *nctx, const sx126x_pa_cfg_params_t *params);
 
sx126x_status_t sx126x_set_rx_tx_fallback_mode(struct network_context *nctx, const sx126x_fallback_modes_t fallback_mode);
 
//
// Registers and Buffer Access
//
 
sx126x_status_t sx126x_write_register(struct network_context *nctx, const uint16_t address, const uint8_t *buffer, const uint8_t size);
 
sx126x_status_t sx126x_read_register(struct network_context *nctx, const uint16_t address, uint8_t *buffer, const uint8_t size);
 
sx126x_status_t sx126x_write_buffer(struct network_context *nctx, const uint8_t offset, const uint8_t *buffer, const uint8_t size);
 
sx126x_status_t sx126x_read_buffer(struct network_context *nctx, const uint8_t offset, uint8_t *buffer, const uint8_t size);
 
//
// DIO and IRQ Control Functions
//
 
sx126x_status_t sx126x_set_dio_irq_params(struct network_context *nctx, const uint16_t irq_mask, const uint16_t dio1_mask, const uint16_t dio2_mask, const uint16_t dio3_mask);
 
sx126x_status_t sx126x_get_irq_status(struct network_context *nctx, sx126x_irq_mask_t *irq);
 
sx126x_status_t sx126x_clear_irq_status(struct network_context *nctx, const sx126x_irq_mask_t irq_mask);
 
sx126x_status_t sx126x_get_and_clear_irq_status(struct network_context *nctx, sx126x_irq_mask_t *irq);
 
sx126x_status_t sx126x_set_dio2_as_rf_sw_ctrl(struct network_context *nctx, const bool enable);
 
sx126x_status_t sx126x_set_dio3_as_tcxo_ctrl(struct network_context *nctx, const sx126x_tcxo_ctrl_voltages_t tcxo_voltage, const uint32_t timeout);
 
//
// RF Modulation and Packet-Related Functions
//
 
sx126x_status_t sx126x_set_rf_freq(struct network_context *nctx, const uint32_t freq_in_hz);
 
sx126x_status_t sx126x_set_rf_freq_in_pll_steps(struct network_context *nctx, const uint32_t freq);
 
sx126x_status_t sx126x_set_pkt_type(struct network_context *nctx, const sx126x_pkt_type_t pkt_type);
 
sx126x_status_t sx126x_get_pkt_type(struct network_context *nctx, sx126x_pkt_type_t *pkt_type);
 
sx126x_status_t sx126x_set_tx_params(struct network_context *nctx, const int8_t pwr_in_dbm, const sx126x_ramp_time_t ramp_time);
 
sx126x_status_t sx126x_set_gfsk_mod_params(struct network_context *nctx, const sx126x_mod_params_gfsk_t *params);
 
sx126x_status_t sx126x_set_lora_mod_params(struct network_context *nctx, const sx126x_mod_params_lora_t *params);
 
sx126x_status_t sx126x_set_gfsk_pkt_params(struct network_context *nctx, const sx126x_pkt_params_gfsk_t *params);
 
sx126x_status_t sx126x_set_lora_pkt_params(struct network_context *nctx, const sx126x_pkt_params_lora_t *params);
 
sx126x_status_t sx126x_set_cad_params(struct network_context *nctx, const sx126x_cad_params_t *params);
 
sx126x_status_t sx126x_set_buffer_base_address(struct network_context *nctx, const uint8_t tx_base_address, const uint8_t rx_base_address);
 
sx126x_status_t sx126x_set_lora_symb_nb_timeout(struct network_context *nctx, const uint8_t nb_of_symbs);
 
//
// Communication Status Information
//
 
sx126x_status_t sx126x_get_status(struct network_context *nctx, sx126x_chip_status_t *radio_status);
 
sx126x_status_t sx126x_get_rx_buffer_status(struct network_context *nctx, sx126x_rx_buffer_status_t *rx_buffer_status);
 
sx126x_status_t sx126x_get_gfsk_pkt_status(struct network_context *nctx, sx126x_pkt_status_gfsk_t *pkt_status);
 
sx126x_status_t sx126x_get_lora_pkt_status(struct network_context *nctx, sx126x_pkt_status_lora_t *pkt_status);
 
sx126x_status_t sx126x_get_rssi_inst(struct network_context *nctx, int16_t *rssi_in_dbm);
 
sx126x_status_t sx126x_get_gfsk_stats(struct network_context *nctx, sx126x_stats_gfsk_t *stats);
 
sx126x_status_t sx126x_get_lora_stats(struct network_context *nctx, sx126x_stats_lora_t *stats);
 
sx126x_status_t sx126x_reset_stats(struct network_context *nctx);
 
//
// Miscellaneous
//
 
sx126x_status_t sx126x_reset(struct network_context *nctx);
 
sx126x_status_t sx126x_wakeup(struct network_context *nctx);
 
sx126x_status_t sx126x_get_device_errors(struct network_context *nctx, sx126x_errors_mask_t *errors);
 
sx126x_status_t sx126x_clear_device_errors(struct network_context *nctx);
 
sx126x_status_t sx126x_get_gfsk_bw_param(const uint32_t bw, uint8_t *param);
 
uint32_t sx126x_get_lora_bw_in_hz(sx126x_lora_bw_t bw);
 
uint32_t sx126x_get_lora_time_on_air_numerator(const sx126x_pkt_params_lora_t *pkt_p, const sx126x_mod_params_lora_t *mod_p);
 
uint32_t sx126x_get_lora_time_on_air_in_ms(const sx126x_pkt_params_lora_t *pkt_p, const sx126x_mod_params_lora_t *mod_p);
 
uint32_t sx126x_get_gfsk_time_on_air_numerator(const sx126x_pkt_params_gfsk_t *pkt_p);
 
uint32_t sx126x_get_gfsk_time_on_air_in_ms(const sx126x_pkt_params_gfsk_t *pkt_p, const sx126x_mod_params_gfsk_t *mod_p);
 
sx126x_status_t sx126x_get_random_numbers(struct network_context *nctx, uint32_t *numbers, unsigned int n);
 
uint32_t sx126x_convert_freq_in_hz_to_pll_step(uint32_t freq_in_hz);
 
uint32_t sx126x_convert_timeout_in_ms_to_rtc_step(uint32_t timeout_in_ms);
 
//
// Registers access
//
 
sx126x_status_t sx126x_cfg_rx_boosted(struct network_context *nctx, const bool state);
 
sx126x_status_t sx126x_set_gfsk_sync_word(struct network_context *nctx, const uint8_t *sync_word, const uint8_t sync_word_len);
 
sx126x_status_t sx126x_set_lora_sync_word(struct network_context *nctx, const uint8_t sync_word);
 
sx126x_status_t sx126x_set_gfsk_crc_seed(struct network_context *nctx, uint16_t seed);
 
sx126x_status_t sx126x_set_gfsk_crc_polynomial(struct network_context *nctx, const uint16_t polynomial);
 
sx126x_status_t sx126x_set_gfsk_whitening_seed(struct network_context *nctx, const uint16_t seed);
 
sx126x_status_t sx126x_cfg_tx_clamp(struct network_context *nctx);
 
sx126x_status_t sx126x_stop_rtc(struct network_context *nctx);
 
sx126x_status_t sx126x_set_ocp_value(struct network_context *nctx, const uint8_t ocp_in_step_of_2_5_ma);
 
sx126x_status_t sx126x_set_trimming_capacitor_values(struct network_context *nctx, const uint8_t trimming_cap_xta, const uint8_t trimming_cap_xtb);
 
#ifdef __cplusplus
}
#endif
 
#endif  // SX126X_H
 
/* --- EOF ------------------------------------------------------------------ */