sx1261/2 driver

Dependents:   alarm_slave iq_sx126x sx126x_simple_TX_shield_2020a sx126x_simple_RX_shield_2020a ... more

Driver for SX1261 or SX1262

sx12xx.h

Committer:
Wayne Roberts
Date:
2018-05-22
Revision:
1:497af0bd9e53
Child:
2:e6e159c8ab4d

File content as of revision 1:497af0bd9e53:

#include "mbed.h"
#ifndef SX126x_H
#define SX126x_H

#define RC_TICKS_PER_MS         0.015625    /* 64KHz */
#define RC_TICKS_PER_US         15.625    /* 64KHz */

#define XTAL_FREQ               32000000
#define FREQ_DIV                33554432
#define FREQ_STEP               0.95367431640625 // ( ( double )( XTAL_FREQ / ( double )FREQ_DIV ) )

/***************************************************************/
#define OPCODE_CLEAR_IRQ_STATUS         0x02
#define OPCODE_CLEAR_DEVICE_ERRORS      0x07
#define OPCODE_SET_DIO_IRQ_PARAMS       0x08
#define OPCODE_WRITE_REGISTER           0x0d
#define OPCODE_WRITE_BUFFER             0x0e
#define OPCODE_GET_PACKET_TYPE          0x11
#define OPCODE_GET_IRQ_STATUS           0x12
#define OPCODE_GET_RX_BUFFER_STATUS     0x13
#define OPCODE_GET_PACKET_STATUS        0x14
#define OPCODE_GET_RSSIINST             0x15
#define OPCODE_GET_DEVICE_ERRORS        0x17
#define OPCODE_READ_REGISTER            0x1d
#define OPCODE_READ_BUFFER              0x1e
#define OPCODE_SET_STANDBY              0x80
#define OPCODE_SET_RX                   0x82
#define OPCODE_SET_TX                   0x83
#define OPCODE_SET_SLEEP                0x84
#define OPCODE_SET_RF_FREQUENCY         0x86
#define OPCODE_CALIBRATE                0x89
#define OPCODE_SET_PACKET_TYPE          0x8a
#define OPCODE_SET_MODULATION_PARAMS    0x8b
#define OPCODE_SET_PACKET_PARAMS        0x8c
#define OPCODE_SET_TX_PARAMS            0x8e
#define OPCODE_SET_BUFFER_BASE_ADDR     0x8f
#define OPCODE_SET_PA_CONFIG            0x95
#define OPCODE_SET_REGULATOR_MODE       0x96
#define OPCODE_SET_DIO3_AS_TCXO_CTRL    0x97
#define OPCODE_SET_DIO2_AS_RFSWITCH     0x9d
#define OPCODE_SET_LORA_SYMBOL_TIMEOUT  0xa0
#define OPCODE_GET_STATUS               0xc0
#define OPCODE_SET_TX_CONTINUOUS        0xd1
/***************************************************************/
#define PACKET_TYPE_GFSK    1
#define PACKET_TYPE_LORA    1

#define HEADER_TYPE_VARIABLE_LENGTH     0
#define HEADER_TYPE_FIXED_LENGTH        1

#define CRC_OFF                         0
#define CRC_ON                          0

#define STANDARD_IQ                     0
#define INVERTED_IQ                     1

/* direct register access */
#define REG_ADDR_LORA_CONFIG0    0x0703 // 8bit  bw/sf
#define REG_ADDR_LORA_IRQ_MASK   0x070a // 24bit
#define REG_ADDR_LORA_SYNC       0x0740 // config22, config23: frame sync peak position
#define REG_ADDR_RANDOM          0x0819
#define REG_ADDR_OCP             0x08e7
#define REG_ADDR_

#define SET_RAMP_10U        0x00
#define SET_RAMP_20U        0x01
#define SET_RAMP_40U        0x02
#define SET_RAMP_80U        0x03
#define SET_RAMP_200U       0x04
#define SET_RAMP_800U       0x05
#define SET_RAMP_1700U      0x06
#define SET_RAMP_3400U      0x07



typedef union {
    struct {
        uint8_t rtcWakeup    : 1;    // 0
        uint8_t rfu          : 1;    // 1
        uint8_t warmStart    : 1;    // 2
    } bits;
    uint8_t octet;
} sleepConfig_t;

typedef union {
    struct {
        uint8_t PreambleLengthHi;   // param1
        uint8_t PreambleLengthLo;   // param2
        uint8_t HeaderType;         // param3
        uint8_t PayloadLength;      // param4
        uint8_t CRCType;            // param5
        uint8_t InvertIQ;           // param6
        uint8_t unused[2];
    } lora;
    struct {
        uint8_t PreambleLengthHi;       // param1
        uint8_t PreambleLengthLo;       // param2
        uint8_t PreambleDetectorLength; // param3
        uint8_t SyncWordLength;         // param4
        uint8_t AddrComp;               // param5
        uint8_t PacketType;             // param6
        uint8_t PayloadLength;          // param7
        uint8_t CRCType;                // param8
    } gfsk;
    uint8_t buf[8];
} PacketParams_t;


#define LORA_BW_7           0x00 // 7.81 kHz real
#define LORA_BW_10          0x08 // 10.42 kHz real
#define LORA_BW_15          0x01 // 15.63 kHz real
#define LORA_BW_20          0x09 // 20.83 kHz real
#define LORA_BW_31          0x02 // 31.25 kHz real
#define LORA_BW_41          0x0A // 41.67 kHz real
#define LORA_BW_62          0x03 // 62.50 kHz real
#define LORA_BW_125         0x04 // 125 kHz real
#define LORA_BW_250         0x05 // 250 kHz real
#define LORA_BW_500         0x06 // 500 kHz real

#define LORA_CR_4_5         1
#define LORA_CR_4_6         2
#define LORA_CR_4_7         3
#define LORA_CR_4_8         4

#define GFSK_PREAMBLE_DETECTOR_OFF                  0x00
#define GFSK_PREAMBLE_DETECTOR_LENGTH_8BITS         0x04
#define GFSK_PREAMBLE_DETECTOR_LENGTH_16BITS        0x05
#define GFSK_PREAMBLE_DETECTOR_LENGTH_24BITS        0x06
#define GFSK_PREAMBLE_DETECTOR_LENGTH_32BITS        0x07

#define GFSK_CRC_OFF            0x01
#define GFSK_CRC_1_BYTE         0x00
#define GFSK_CRC_2_BYTE         0x02
#define GFSK_CRC_1_BYTE_INV     0x04
#define GFSK_CRC_2_BYTE_INV     0x06

#define GFSK_RX_BW_4800             0x1F 
#define GFSK_RX_BW_5800             0x17 
#define GFSK_RX_BW_7300             0x0F 
#define GFSK_RX_BW_9700             0x1E 
#define GFSK_RX_BW_11700            0x16 
#define GFSK_RX_BW_14600            0x0E 
#define GFSK_RX_BW_19500            0x1D 
#define GFSK_RX_BW_23400            0x15 
#define GFSK_RX_BW_29300            0x0D 
#define GFSK_RX_BW_39000            0x1C 
#define GFSK_RX_BW_46900            0x14 
#define GFSK_RX_BW_58600            0x0C 
#define GFSK_RX_BW_78200            0x1B 
#define GFSK_RX_BW_93800            0x13 
#define GFSK_RX_BW_117300           0x0B 
#define GFSK_RX_BW_156200           0x1A 
#define GFSK_RX_BW_187200           0x12 
#define GFSK_RX_BW_234300           0x0A 
#define GFSK_RX_BW_312000           0x19 
#define GFSK_RX_BW_373600           0x11 
#define GFSK_RX_BW_467000           0x09 

#define GFSK_SHAPE_NONE             0x00
#define GFSK_SHAPE_BT0_3            0x08
#define GFSK_SHAPE_BT0_5            0x09
#define GFSK_SHAPE_BT0_7            0x0a
#define GFSK_SHAPE_BT1_0            0x0b

typedef enum {
    STBY_RC = 0,
    STBY_XOSC
} stby_t;

typedef union {
    struct {
        uint8_t spreadingFactor; // param1
        uint8_t bandwidth; // param2
        uint8_t codingRate; // param3
        uint8_t LowDatarateOptimize; // param4
    } lora;
    struct {
        uint8_t bitrateHi;  // param1
        uint8_t bitrateMid; // param2
        uint8_t bitrateLo;  // param3
        uint8_t PulseShape; // param4
        uint8_t bandwith;   // param5
        uint8_t fdevHi; // param6
        uint8_t fdevMid;    // param7
        uint8_t fdevLo; // param8
    } gfsk;
    uint8_t buf[8];
} ModulationParams_t;

typedef union {
    struct {    // 
        uint8_t TxDone           : 1;    // 0
        uint8_t RxDone           : 1;    // 1
        uint8_t PreambleDetected : 1;    // 2
        uint8_t SyncWordValid    : 1;    // 3
        uint8_t HeaderValid      : 1;    // 4
        uint8_t HeaderErr        : 1;    // 5
        uint8_t CrCerr           : 1;    // 6
        uint8_t CadDone          : 1;    // 7
        uint8_t CadDetected      : 1;    // 8
        uint8_t Timeout          : 1;    // 9
    } bits;
    uint16_t word;
} IrqFlags_t;

typedef union {
    struct {    // 
        uint8_t _reserved    : 1;    // 0
        uint8_t cmdStatus    : 3;    // 1,2,3
        uint8_t chipMode     : 3;    // 4,5,6
        uint8_t reserved_    : 1;    // 7
    } bits;
    uint8_t octet;
} status_t;

typedef enum {
    CHIPMODE_NONE = 0,
    CHIPMODE_RX,
    CHIPMODE_TX
} chipMote_e;

class SX126x {
    public:
        SX126x(SPI&, PinName nss, PinName busy, PinName dio1);


        void hw_reset(PinName nrst);
        void xfer(uint8_t opcode, uint8_t len, uint8_t* buf);
        void setPacketType(uint8_t);
        uint8_t setMHz(float);

        /* start_tx and start_rx assumes DIO1 is connected, and only pin used to generate radio interrupt */
        void start_tx(uint8_t pktLen);  // tx_buf must be filled prior to calling

#define RX_TIMEOUT_SINGLE         0x000000  /* stop RX after first packet */
#define RX_TIMEOUT_CONTINUOUS     0xffffff  /* keep RXing */
        void start_rx(unsigned);

        void ReadBuffer(uint8_t size);
        void SetDIO2AsRfSwitchCtrl(uint8_t);
        void set_tx_dbm(bool is1262, int8_t dbm);
        uint32_t readReg(uint16_t addr, uint8_t len);
        void writeReg(uint16_t addr, uint32_t data, uint8_t len);
        void setStandby(stby_t);
        void setSleep(bool warmStart, bool rtcWakeup);

        static Callback<void()> dio1_topHalf;    // low latency ISR context
        void service(void);
        Callback<void()> txDone; // user context
        void (*rxDone)(uint8_t size, float rssi, float snr); // user context
        void (*timeout)(bool tx); // user context

        //! RF transmit packet buffer
        uint8_t tx_buf[256];    // lora fifo size
        
        //! RF receive packet buffer
        uint8_t rx_buf[256];    // lora fifo size

        /** Test if dio1 pin is asserted 
         */
        inline bool getDIO1(void) { return dio1.read(); }
        void PrintChipStatus(status_t);
        //bool txing;
        chipMote_e chipMode;

    private:
        SPI& spi;
        DigitalOut nss;
        DigitalIn busy;
        InterruptIn dio1;
        static void dio1isr(void);
        bool sleeping;
};

#endif /* SX126x_H */