sx127x.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Unwired Devices <info@unwds.com>
 * SPDX-FileCopyrightText: 2017 Inria
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "timex.h"
#include "ztimer.h"
#include "net/netdev.h"
#include "periph/gpio.h"
#include "periph/spi.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define SX127X_MODEM_DEFAULT             (SX127X_MODEM_LORA)    
#define SX127X_CHANNEL_DEFAULT           (868300000UL)          
#define SX127X_HF_CHANNEL_DEFAULT        (868000000UL)          
#define SX127X_RF_MID_BAND_THRESH        (525000000UL)          
#define SX127X_XTAL_FREQ                 (32000000UL)           
#define SX127X_RADIO_WAKEUP_TIME         (1U)                   
 
#define SX127X_TX_TIMEOUT_DEFAULT        (30 * MS_PER_SEC)      
#define SX127X_RX_SINGLE                 (false)                
#define SX127X_RX_BUFFER_SIZE            (256)                  
#define SX127X_RADIO_TX_POWER            (14U)                  
 
#define SX127X_EVENT_HANDLER_STACK_SIZE  (2048U)                
#define SX127X_IRQ_DIO0                  (1 << 0)               
#define SX127X_IRQ_DIO1                  (1 << 1)               
#define SX127X_IRQ_DIO2                  (1 << 2)               
#define SX127X_IRQ_DIO3                  (1 << 3)               
#define SX127X_IRQ_DIO4                  (1 << 4)               
#define SX127X_IRQ_DIO5                  (1 << 5)               

#ifndef SX127X_DIO_PULL_MODE
#define SX127X_DIO_PULL_MODE             (GPIO_IN_PD)
#endif

enum {
    SX127X_INIT_OK = 0,                 
    SX127X_ERR_SPI,                     
    SX127X_ERR_GPIOS,                   
    SX127X_ERR_NODEV                    
};

enum {
    SX127X_MODEM_FSK = 0,               
    SX127X_MODEM_LORA,                  
};

enum {
    SX127X_RF_IDLE = 0,                 
    SX127X_RF_RX_RUNNING,               
    SX127X_RF_TX_RUNNING,               
    SX127X_RF_CAD,                      
};

enum {
    SX127X_RX_DONE = 0,                 
    SX127X_TX_DONE,                     
    SX127X_RX_TIMEOUT,                  
    SX127X_TX_TIMEOUT,                  
    SX127X_RX_ERROR_CRC,                
    SX127X_FHSS_CHANGE_CHANNEL,         
    SX127X_CAD_DONE,                    
};

enum {
    SX127X_PA_RFO = 0,                  
    SX127X_PA_BOOST,                    
};

#define SX127X_LOW_DATARATE_OPTIMIZE_FLAG       (1 << 0)
#define SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG  (1 << 1)
#define SX127X_ENABLE_CRC_FLAG                  (1 << 2)
#define SX127X_CHANNEL_HOPPING_FLAG             (1 << 3)
#define SX127X_IQ_INVERTED_FLAG                 (1 << 4)
#define SX127X_RX_CONTINUOUS_FLAG               (1 << 5)

typedef struct {
    uint16_t preamble_len;              
    int8_t power;                       
    uint8_t bandwidth;                  
    uint8_t datarate;                   
    uint8_t coderate;                   
    uint8_t freq_hop_period;            
    uint8_t flags;                      
    uint32_t rx_timeout;                
    uint32_t tx_timeout;                
} sx127x_lora_settings_t;

typedef struct {
    uint32_t channel;                   
    uint8_t state;                      
    uint8_t modem;                      
    sx127x_lora_settings_t lora;        
} sx127x_radio_settings_t;

typedef struct {
    /* Data that will be passed to events handler in application */
    ztimer_t tx_timeout_timer;          
    ztimer_t rx_timeout_timer;          
    uint32_t last_channel;              
    bool is_last_cad_success;           
} sx127x_internal_t;

typedef struct {
    spi_t spi;                          
    gpio_t nss_pin;                     
    gpio_t reset_pin;                   
    gpio_t dio0_pin;                    
    gpio_t dio1_pin;                    
    gpio_t dio2_pin;                    
    gpio_t dio3_pin;                    
    gpio_t dio4_pin;                    
    gpio_t dio5_pin;                    
#if defined(SX127X_USE_TX_SWITCH) || defined(SX127X_USE_RX_SWITCH)
    gpio_t rx_switch_pin;               
    gpio_t tx_switch_pin;               
#endif
    uint8_t paselect;                   
} sx127x_params_t;

typedef uint8_t sx127x_flags_t;

typedef struct {
    netdev_t netdev;                    
    sx127x_radio_settings_t settings;   
    sx127x_params_t params;             
    sx127x_internal_t _internal;        
    sx127x_flags_t irq;                 
} sx127x_t;

typedef void (sx127x_dio_irq_handler_t)(sx127x_t *dev);

void sx127x_setup(sx127x_t *dev, const sx127x_params_t *params, uint8_t index);

int sx127x_reset(const sx127x_t *dev);

int sx127x_init(sx127x_t *dev);

void sx127x_init_radio_settings(sx127x_t *dev);

uint32_t sx127x_random(sx127x_t *dev);

void sx127x_start_cad(sx127x_t *dev);

bool sx127x_is_channel_free(sx127x_t *dev, uint32_t freq, int16_t rssi_threshold);

int16_t sx127x_read_rssi(const sx127x_t *dev);

uint8_t sx127x_get_state(const sx127x_t *dev);

void sx127x_set_state(sx127x_t *dev, uint8_t state);

void sx127x_set_modem(sx127x_t *dev, uint8_t modem);

uint8_t sx127x_get_syncword(const sx127x_t *dev);

void sx127x_set_syncword(sx127x_t *dev, uint8_t syncword);

uint32_t sx127x_get_channel(const sx127x_t *dev);

void sx127x_set_channel(sx127x_t *dev, uint32_t freq);

uint32_t sx127x_get_time_on_air(const sx127x_t *dev, uint8_t pkt_len);

void sx127x_set_sleep(sx127x_t *dev);

void sx127x_set_standby(sx127x_t *dev);

void sx127x_set_rx(sx127x_t *dev);

void sx127x_set_tx(sx127x_t *dev);

uint8_t sx127x_get_max_payload_len(const sx127x_t *dev);

void sx127x_set_max_payload_len(const sx127x_t *dev, uint8_t maxlen);

uint8_t sx127x_get_op_mode(const sx127x_t *dev);

void sx127x_set_op_mode(const sx127x_t *dev, uint8_t op_mode);

uint8_t sx127x_get_bandwidth(const sx127x_t *dev);

void sx127x_set_bandwidth(sx127x_t *dev, uint8_t bandwidth);

uint8_t sx127x_get_spreading_factor(const sx127x_t *dev);

void sx127x_set_spreading_factor(sx127x_t *dev, uint8_t sf);

uint8_t sx127x_get_coding_rate(const sx127x_t *dev);

void sx127x_set_coding_rate(sx127x_t *dev, uint8_t coderate);

bool sx127x_get_rx_single(const sx127x_t *dev);

void sx127x_set_rx_single(sx127x_t *dev, bool single);

bool sx127x_get_crc(const sx127x_t *dev);

void sx127x_set_crc(sx127x_t *dev, bool crc);

uint8_t sx127x_get_hop_period(const sx127x_t *dev);

void sx127x_set_hop_period(sx127x_t *dev, uint8_t hop_period);

bool sx127x_get_fixed_header_len_mode(const sx127x_t *dev);

void sx127x_set_fixed_header_len_mode(sx127x_t *dev, bool mode);

uint8_t sx127x_get_payload_length(const sx127x_t *dev);

void sx127x_set_payload_length(sx127x_t *dev, uint8_t len);

uint8_t sx127x_get_tx_power(const sx127x_t *dev);

void sx127x_set_tx_power(sx127x_t *dev, int8_t power);

uint16_t sx127x_get_preamble_length(const sx127x_t *dev);

void sx127x_set_preamble_length(sx127x_t *dev, uint16_t preamble);

void sx127x_set_symbol_timeout(sx127x_t *dev, uint16_t timeout);

void sx127x_set_rx_timeout(sx127x_t *dev, uint32_t timeout);

void sx127x_set_tx_timeout(sx127x_t *dev, uint32_t timeout);

bool sx127x_get_iq_invert(const sx127x_t *dev);

void sx127x_set_iq_invert(sx127x_t *dev, bool iq_invert);

void sx127x_set_freq_hop(sx127x_t *dev, bool freq_hop_on);
 
#ifdef __cplusplus
}
#endif