sx126x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Inria
 *
 * 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.
 */
 
#pragma once
 
#include <assert.h>
 
#include_next "sx126x.h"
 
#include "net/netdev.h"
 
#include "periph/gpio.h"
#include "periph/spi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(DOXYGEN)
#  define CONFIG_SX126X_DEFAULT_SYNC_WORD       0x12
#endif
 
typedef struct sx126x sx126x_t;
 
typedef enum {
    SX126X_RF_MODE_RX,
    SX126X_RF_MODE_TX_LPA,
    SX126X_RF_MODE_TX_HPA,
} sx126x_rf_mode_t;
 
#define SX126X_SINGLE ((            \
                          IS_USED(MODULE_SX1261) \
                        + IS_USED(MODULE_SX1262) \
                        + IS_USED(MODULE_SX1268) \
                        + IS_USED(MODULE_LLCC68) \
                        + IS_USED(MODULE_SX126X_STM32WL) \
                        ) == 1)
 
#if (IS_USED(MODULE_SX1261) || IS_USED(MODULE_SX1262) || \
     IS_USED(MODULE_SX1268) || IS_USED(MODULE_LLCC68))
#define SX126X_SPI    1
#endif
 
typedef enum {
    SX126X_TYPE_SX1261,
    SX126X_TYPE_SX1262,
    SX126X_TYPE_SX1268,
    SX126X_TYPE_LLCC68,
    SX126X_TYPE_STM32WL,
} sx126x_type_t;
 
typedef enum {
    SX126X_DIO2_UNUSED,     
    SX126X_DIO2_IRQ,        
    SX126X_DIO2_RF_SWITCH,  
} sx126x_dio2_mode_t;
 
typedef enum {
    SX126X_DIO3_UNUSED,     
    SX126X_DIO3_IRQ,        
    SX126X_DIO3_TCXO,       
} sx126x_dio3_mode_t;
 
#define SX126X_IRQ_MASK_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 struct {
    spi_t spi;                          
    gpio_t nss_pin;                     
    gpio_t reset_pin;                   
    gpio_t busy_pin;                    
    gpio_t dio1_pin;                    
#if IS_USED(MODULE_SX126X_DIO2)
    sx126x_dio2_mode_t dio2_mode;       
#endif
#if IS_USED(MODULE_SX126X_DIO3)
    sx126x_dio3_mode_t dio3_mode;       
    struct {
        unsigned tcxo_volt    :8;   
        unsigned tcxo_timeout :24;  
    } dio3_arg;
#endif
    sx126x_reg_mod_t regulator;         
    sx126x_type_t type;                 
#if IS_USED(MODULE_SX126X_RF_SWITCH)
    void(*set_rf_mode)(sx126x_t *dev, sx126x_rf_mode_t rf_mode);
    sx126x_rf_mode_t tx_pa_mode;        
#endif
} sx126x_params_t;
 
struct sx126x {
    netdev_t netdev;                        
    sx126x_params_t *params;                
    sx126x_pkt_params_lora_t pkt_params;    
    sx126x_mod_params_lora_t mod_params;    
    uint32_t channel;                       
    uint16_t rx_timeout;                    
    bool radio_sleep;                       
};
 
void sx126x_setup(sx126x_t *dev, const sx126x_params_t *params, uint8_t index);
 
int sx126x_init(sx126x_t *dev);
 
static inline int sx126x_symbol_to_msec(sx126x_t *dev, uint16_t symbols)
{
    assert(dev && (dev->mod_params.bw <= SX126X_LORA_BW_500) && \
           (dev->mod_params.bw >= SX126X_LORA_BW_125));
 
    /* Refer section 6.1.4 LoRa Time-on-Air in SX1268 datasheet */
    return (symbols * (1 << (dev->mod_params.sf + 7 - dev->mod_params.bw)) / 1000);
}
 
uint32_t sx126x_get_channel(const sx126x_t *dev);
 
void sx126x_set_channel(sx126x_t *dev, uint32_t freq);
 
uint8_t sx126x_get_bandwidth(const sx126x_t *dev);
 
void sx126x_set_bandwidth(sx126x_t *dev, uint8_t bandwidth);
 
uint8_t sx126x_get_spreading_factor(const sx126x_t *dev);
 
void sx126x_set_spreading_factor(sx126x_t *dev, uint8_t sf);
 
uint8_t sx126x_get_coding_rate(const sx126x_t *dev);
 
void sx126x_set_coding_rate(sx126x_t *dev, uint8_t cr);
 
void sx126x_set_tx_power(sx126x_t *dev, int8_t power_dbm, sx126x_ramp_time_t ramp_time);
 
uint8_t sx126x_get_lora_payload_length(const sx126x_t *dev);
 
void sx126x_set_lora_payload_length(sx126x_t *dev, uint8_t len);
 
bool sx126x_get_lora_crc(const sx126x_t *dev);
 
void sx126x_set_lora_crc(sx126x_t *dev, bool crc);
 
bool sx126x_get_lora_implicit_header(const sx126x_t *dev);
 
void sx126x_set_lora_implicit_header(sx126x_t *dev, bool mode);
 
uint16_t sx126x_get_lora_preamble_length(const sx126x_t *dev);
 
void sx126x_set_lora_preamble_length(sx126x_t *dev, uint16_t preamble);
 
bool sx126x_get_lora_iq_invert(const sx126x_t *dev);
 
void sx126x_set_lora_iq_invert(sx126x_t *dev, bool iq_invert);
 
#ifdef __cplusplus
}
#endif