RadioLib/_l_r__common_8h_source.html

#if !defined(RADIOLIB_LR_COMMON_H)

#define RADIOLIB_LR_COMMON_H


#include "../../Module.h"

#include "../../protocols/PhysicalLayer/PhysicalLayer.h"


#define RADIOLIB_LRXXXX_CMD_NOP                                 (0x0000)

#define RADIOLIB_LRXXXX_SPI_MAX_READ_WRITE_LEN                  (128) // intentionally limited to the length supported by LR2021


// RADIOLIB_LR11X0_CMD_GET_STATUS

// RADIOLIB_LR2021_CMD_GET_STATUS                                                   MSB   LSB   DESCRIPTION

#define RADIOLIB_LRXXXX_STAT_1_CMD_FAIL                         (0x00UL << 1)   //  3     1     command status: last command could not be executed

#define RADIOLIB_LRXXXX_STAT_1_CMD_PERR                         (0x01UL << 1)   //  3     1                     processing error

#define RADIOLIB_LRXXXX_STAT_1_CMD_OK                           (0x02UL << 1)   //  3     1                     successfully processed

#define RADIOLIB_LRXXXX_STAT_1_CMD_DAT                          (0x03UL << 1)   //  3     1                     successfully processed, data is being transmitted


// RADIOLIB_LR11X0_CMD_LR_FHSS_BUILD_FRAME

// RADIOLIB_LR2021_CMD_LR_FHSS_BUILD_FRAME

#define RADIOLIB_LRXXXX_LR_FHSS_CR_5_6                          (0x00UL << 0)   //  7     0     LR FHSS coding rate: 5/6

#define RADIOLIB_LRXXXX_LR_FHSS_CR_2_3                          (0x01UL << 0)   //  7     0                          2/3

#define RADIOLIB_LRXXXX_LR_FHSS_CR_1_2                          (0x02UL << 0)   //  7     0                          1/2

#define RADIOLIB_LRXXXX_LR_FHSS_CR_1_3                          (0x03UL << 0)   //  7     0                          1/3

#define RADIOLIB_LRXXXX_LR_FHSS_MOD_TYPE_GMSK                   (0x00UL << 0)   //  7     0     LR FHSS modulation: GMSK

#define RADIOLIB_LRXXXX_LR_FHSS_GRID_STEP_FCC                   (0x00UL << 0)   //  7     0     LR FHSS step size: 25.390625 kHz (FCC)

#define RADIOLIB_LRXXXX_LR_FHSS_GRID_STEP_NON_FCC               (0x01UL << 0)   //  7     0                        3.90625 kHz (non-FCC)

#define RADIOLIB_LRXXXX_LR_FHSS_HOPPING_DISABLED                (0x00UL << 0)   //  7     0     LR FHSS hopping: disabled

#define RADIOLIB_LRXXXX_LR_FHSS_HOPPING_ENABLED                 (0x01UL << 0)   //  7     0                      enabled

#define RADIOLIB_LRXXXX_LR_FHSS_HOPPING_TEST_NO_HOP             (0x02UL << 0)   //  7     0                      test mode (packet encoded, no hopping)

#define RADIOLIB_LRXXXX_LR_FHSS_HOPPING_TEST_PA_RAMP            (0x03UL << 0)   //  7     0                      test mode (PA ramp up, no hopping)

#define RADIOLIB_LRXXXX_LR_FHSS_BW_39_06                        (0x00UL << 0)   //  7     0     LR FHSS bandwidth: 39.06 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_85_94                        (0x01UL << 0)   //  7     0                        85.94 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_136_72                       (0x02UL << 0)   //  7     0                        136.72 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_183_59                       (0x03UL << 0)   //  7     0                        183.59 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_335_94                       (0x04UL << 0)   //  7     0                        335.94 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_386_72                       (0x05UL << 0)   //  7     0                        386.72 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_722_66                       (0x06UL << 0)   //  7     0                        722.66 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_773_44                       (0x07UL << 0)   //  7     0                        773.44 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_1523_4                       (0x08UL << 0)   //  7     0                        1523.4 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_BW_1574_2                       (0x09UL << 0)   //  7     0                        1574.2 kHz

#define RADIOLIB_LRXXXX_LR_FHSS_HEADER_BITS                     (114)           //  7     0     LR FHSS packet bit widths: header

#define RADIOLIB_LRXXXX_LR_FHSS_FRAG_BITS                       (48)            //  7     0                                payload fragment

#define RADIOLIB_LRXXXX_LR_FHSS_BLOCK_PREAMBLE_BITS             (2)             //  7     0                                block preamble

#define RADIOLIB_LRXXXX_LR_FHSS_BLOCK_BITS                      (RADIOLIB_LRXXXX_LR_FHSS_FRAG_BITS + RADIOLIB_LRXXXX_LR_FHSS_BLOCK_PREAMBLE_BITS)


// RADIOLIB_LR11X0_CMD_SET_TCXO_MODE

// RADIOLIB_LR2021_CMD_SET_TCXO_MODE

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_1_6                        (0x00UL << 0)   //  2     0     TCXO supply voltage: 1.6V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_1_7                        (0x01UL << 0)   //  2     0                          1.7V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_1_8                        (0x02UL << 0)   //  2     0                          1.8V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_2_2                        (0x03UL << 0)   //  2     0                          2.2V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_2_4                        (0x04UL << 0)   //  2     0                          2.4V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_2_7                        (0x05UL << 0)   //  2     0                          2.7V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_3_0                        (0x06UL << 0)   //  2     0                          3.0V

#define RADIOLIB_LRXXXX_TCXO_VOLTAGE_3_3                        (0x07UL << 0)   //  2     0                          3.3V


// RADIOLIB_LR11X0_CMD_SET_TX_PARAMS

// RADIOLIB_LR2021_CMD_SET_TX_PARAMS

#define RADIOLIB_LRXXXX_PA_RAMP_2U                              (0x00UL << 0)   //  7     0     PA ramp time: 2 us (LR2021 only)

#define RADIOLIB_LRXXXX_PA_RAMP_4U                              (0x01UL << 0)   //  7     0                   4 us (LR2021 only)

#define RADIOLIB_LRXXXX_PA_RAMP_8U                              (0x02UL << 0)   //  7     0                   8 us (LR2021 only)

#define RADIOLIB_LRXXXX_PA_RAMP_16U                             (0x03UL << 0)   //  7     0                   16 us

#define RADIOLIB_LRXXXX_PA_RAMP_32U                             (0x04UL << 0)   //  7     0                   32 us

#define RADIOLIB_LRXXXX_PA_RAMP_48U                             (0x05UL << 0)   //  7     0                   48 us

#define RADIOLIB_LRXXXX_PA_RAMP_64U                             (0x06UL << 0)   //  7     0                   64 us

#define RADIOLIB_LRXXXX_PA_RAMP_80U                             (0x07UL << 0)   //  7     0                   80 us

#define RADIOLIB_LRXXXX_PA_RAMP_96U                             (0x08UL << 0)   //  7     0                   96 us

#define RADIOLIB_LRXXXX_PA_RAMP_112U                            (0x09UL << 0)   //  7     0                   112 us

#define RADIOLIB_LRXXXX_PA_RAMP_128U                            (0x0AUL << 0)   //  7     0                   128 us

#define RADIOLIB_LRXXXX_PA_RAMP_144U                            (0x0BUL << 0)   //  7     0                   144 us

#define RADIOLIB_LRXXXX_PA_RAMP_160U                            (0x0CUL << 0)   //  7     0                   160 us

#define RADIOLIB_LRXXXX_PA_RAMP_176U                            (0x0DUL << 0)   //  7     0                   176 us

#define RADIOLIB_LRXXXX_PA_RAMP_192U                            (0x0EUL << 0)   //  7     0                   192 us

#define RADIOLIB_LRXXXX_PA_RAMP_208U                            (0x0FUL << 0)   //  7     0                   208 us

#define RADIOLIB_LRXXXX_PA_RAMP_240U                            (0x10UL << 0)   //  7     0                   240 us

#define RADIOLIB_LRXXXX_PA_RAMP_272U                            (0x11UL << 0)   //  7     0                   272 us

#define RADIOLIB_LRXXXX_PA_RAMP_304U                            (0x12UL << 0)   //  7     0                   304 us


// RADIOLIB_LR11X0_CMD_SET_DIO_AS_RF_SWITCH

// RADIOLIB_LR2021_CMD_SET_DIO_AS_RF_SWITCH

#define RADIOLIB_LRXXXX_DIOx(X)                                 ((X) | RFSWITCH_PIN_FLAG)

#define RADIOLIB_LRXXXX_DIOx_VAL(X)                             ((X) & ~RFSWITCH_PIN_FLAG)


// common configuration values

#define RADIOLIB_LRXXXX_LR_FHSS_BIT_RATE                        (488.28215f)    //  31    0     LR FHSS bit rate: 488.28215 bps

#define RADIOLIB_LRXXXX_LR_FHSS_BIT_RATE_RAW                    (0x8001E848UL)  //  31    0                       488.28215 bps in raw

#define RADIOLIB_LRXXXX_LORA_HEADER_EXPLICIT                    (0x00UL << 0)   //  7     0     LoRa header mode: explicit

#define RADIOLIB_LRXXXX_LORA_HEADER_IMPLICIT                    (0x01UL << 0)   //  7     0                       implicit

#define RADIOLIB_LRXXXX_LORA_CRC_ENABLED                        (0x01UL << 0)   //  7     0     CRC: enabled

#define RADIOLIB_LRXXXX_LORA_CRC_DISABLED                       (0x00UL << 0)   //  7     0          disabled


class LRxxxx: public PhysicalLayer {

  public:

    explicit LRxxxx(Module* mod);


    bool XTAL;


    int16_t reset();


    void setIrqAction(void (*func)(void));


    void clearIrqAction();


    void setPacketReceivedAction(void (*func)(void)) override;


    void clearPacketReceivedAction() override;


    void setPacketSentAction(void (*func)(void)) override;


    void clearPacketSentAction() override;


    uint32_t getIrqStatus();


    RadioLibTime_t calculateTimeOnAir(ModemType_t modem, DataRate_t dr, PacketConfig_t pc, size_t len) override;


    RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override;


  protected:

    Module* mod;


    float freqMHz = 0;

    uint32_t rxTimeout = 0;


    // cached LoRa parameters

    uint8_t bandwidth = 0, spreadingFactor = 0, codingRate = 0, ldrOptimize = 0, crcTypeLoRa = 0, headerType = 0;

    uint16_t preambleLengthLoRa = 0;

    float bandwidthKhz = 0;

    bool ldroAuto = true;

    size_t implicitLen = 0;

    bool invertIQEnabled = false;


    // cached GFSK parameters

    uint32_t bitRate = 0, frequencyDev = 0;

    uint8_t preambleDetLength = 0, rxBandwidth = 0, pulseShape = 0, crcTypeGFSK = 0, crcLenGFSK = 0, syncWordLength = 0, addrComp = 0, whitening = 0, packetType = 0, node = 0;

    uint16_t preambleLengthGFSK = 0;


    // cached LR-FHSS parameters

    uint8_t lrFhssCr = 0, lrFhssBw = 0, lrFhssHdrCount = 0, lrFhssGrid = 0;

    uint16_t lrFhssHopSeq = 0;


    // a lot of SPI commands have the same structure and arguments on both LR11xx as well as LR2021

    // the only difference is the 16-bit command code - however, having everything in this base class

    // will actually increase the binary size, because of the extra method calls that are needed

    // for that reason, only the methods that are 100% the same are kept here

    int16_t getStatus(uint8_t* stat1, uint8_t* stat2, uint32_t* irq);

    int16_t lrFhssBuildFrame(uint16_t cmd, uint8_t hdrCount, uint8_t cr, uint8_t grid, uint8_t hop, uint8_t bw, uint16_t hopSeq, int8_t devOffset, const uint8_t* payload, size_t len);

    uint8_t roundRampTime(uint32_t rampTimeUs);

    int16_t findRxBw(float rxBw, const uint8_t* lut, size_t lutSize, float rxBwMax, uint8_t* val);

    RadioLibTime_t getTimeOnAir(size_t len, ModemType_t modem);


    // several commands just send unsigned 32-bit number

    int16_t setU32(uint16_t cmd, uint32_t u32);


    int16_t writeCommon(uint16_t cmd, uint32_t addrOffset, const uint32_t* data, size_t len, bool nonvolatile);

    int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, const uint8_t* out = NULL, size_t outLen = 0);


    static int16_t SPIparseStatus(uint8_t in);

    static int16_t SPIcheckStatus(Module* mod);


  private:

};


#endif

LRxxxx
Definition LR_common.h:91

LRxxxx::getIrqStatus
uint32_t getIrqStatus()
Reads the current IRQ status.
Definition LR_common.cpp:39

LRxxxx::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition LR_common.cpp:23

LRxxxx::calculateRxTimeout
RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override
Calculate the timeout value for this specific module / series (in number of symbols or units of time)
Definition LR_common.cpp:171

LRxxxx::calculateTimeOnAir
RadioLibTime_t calculateTimeOnAir(ModemType_t modem, DataRate_t dr, PacketConfig_t pc, size_t len) override
Calculate the expected time-on-air for a given modem, data rate, packet configuration and payload siz...
Definition LR_common.cpp:99

LRxxxx::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition LR_common.cpp:31

LRxxxx::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ1 activates.
Definition LR_common.cpp:15

LRxxxx::clearIrqAction
void clearIrqAction()
Clears interrupt service routine to call when IRQ1 activates.
Definition LR_common.cpp:19

LRxxxx::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition LR_common.cpp:35

LRxxxx::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition LR_common.cpp:27

LRxxxx::reset
int16_t reset()
Reset method. Will reset the chip to the default state using RST pin.
Definition LR_common.cpp:178

LRxxxx::XTAL
bool XTAL
Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
Definition LR_common.h:98

Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73

PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:257

RadioLibTime_t
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:658

DataRate_t
Common data rate structure.
Definition PhysicalLayer.h:74

PacketConfig_t
Common packet configuration structure.
Definition PhysicalLayer.h:119