Thiago Lima / SX1276GenericLib2

f

sx1276/sx1276.h@34:07e89f23c734, 2017-05-06 (annotated)

Committer:
Helmut Tschemernjak
Date:
Sat May 06 11:52:23 2017 +0200
Revision:
34:07e89f23c734
Parent:
33:5db0d1e716b1
Child:
38:d9189d958db8
Updated the SX1276 driver to be way more generic.

Common support for Murata, RFM95 and Semtech SX1276MB1MAS

and SX1276MB1LAS modules.

Operating system dependent code is now the the _hal files.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
GregCr 0:e6ceb13d2d05 1 /*
GregCr 0:e6ceb13d2d05 2 / _____) _ | |
GregCr 0:e6ceb13d2d05 3 ( (____ _____ ____ _| |_ _____ ____| |__
GregCr 0:e6ceb13d2d05 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
GregCr 0:e6ceb13d2d05 5 _____) ) ____| | | || |_| ____( (___| | | |
GregCr 0:e6ceb13d2d05 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
mluis 22:7f3aab69cca9 7 (C) 2014 Semtech
GregCr 0:e6ceb13d2d05 8
GregCr 0:e6ceb13d2d05 9 Description: Actual implementation of a SX1276 radio, inherits Radio
GregCr 0:e6ceb13d2d05 10
GregCr 0:e6ceb13d2d05 11 License: Revised BSD License, see LICENSE.TXT file include in the project
GregCr 0:e6ceb13d2d05 12
GregCr 0:e6ceb13d2d05 13 Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin
GregCr 0:e6ceb13d2d05 14 */
Helmut Tschemernjak 34:07e89f23c734 15
Helmut Tschemernjak 34:07e89f23c734 16 /*
Helmut Tschemernjak 34:07e89f23c734 17 * additional development to make it more generic across multiple os versions
Helmut Tschemernjak 34:07e89f23c734 18 * (c) 2017 Helmut Tschemernjak
Helmut Tschemernjak 34:07e89f23c734 19 * 30826 Garbsen (Hannover) Germany
Helmut Tschemernjak 34:07e89f23c734 20 */
Helmut Tschemernjak 34:07e89f23c734 21
GregCr 0:e6ceb13d2d05 22 #ifndef __SX1276_H__
GregCr 0:e6ceb13d2d05 23 #define __SX1276_H__
GregCr 0:e6ceb13d2d05 24
GregCr 0:e6ceb13d2d05 25 #include "radio.h"
GregCr 0:e6ceb13d2d05 26 #include "./registers/sx1276Regs-Fsk.h"
GregCr 0:e6ceb13d2d05 27 #include "./registers/sx1276Regs-LoRa.h"
GregCr 0:e6ceb13d2d05 28 #include "./typedefs/typedefs.h"
GregCr 0:e6ceb13d2d05 29
mluis 16:d447f8d2d2d6 30 /*!
Helmut Tschemernjak 31:e50929bd3f32 31 * Radio wake-up time from sleep
Helmut Tschemernjak 31:e50929bd3f32 32 */
Helmut Tschemernjak 32:f6f0bff38543 33 #define RADIO_WAKEUP_TIME 1 // [ms]
Helmut Tschemernjak 31:e50929bd3f32 34
Helmut Tschemernjak 31:e50929bd3f32 35 /*!
Helmut Tschemernjak 31:e50929bd3f32 36 * Sync word for Private LoRa networks
mluis 16:d447f8d2d2d6 37 */
Helmut Tschemernjak 31:e50929bd3f32 38 #define LORA_MAC_PRIVATE_SYNCWORD 0x12
Helmut Tschemernjak 31:e50929bd3f32 39
Helmut Tschemernjak 31:e50929bd3f32 40 /*!
Helmut Tschemernjak 31:e50929bd3f32 41 * Sync word for Public LoRa networks
Helmut Tschemernjak 31:e50929bd3f32 42 */
Helmut Tschemernjak 31:e50929bd3f32 43 #define LORA_MAC_PUBLIC_SYNCWORD 0x34
Helmut Tschemernjak 31:e50929bd3f32 44
mluis 25:3778e6204cc1 45
mluis 25:3778e6204cc1 46 /*!
mluis 16:d447f8d2d2d6 47 * SX1276 definitions
mluis 16:d447f8d2d2d6 48 */
GregCr 0:e6ceb13d2d05 49 #define XTAL_FREQ 32000000
GregCr 0:e6ceb13d2d05 50 #define FREQ_STEP 61.03515625
GregCr 0:e6ceb13d2d05 51
GregCr 0:e6ceb13d2d05 52 #define RX_BUFFER_SIZE 256
GregCr 0:e6ceb13d2d05 53
GregCr 0:e6ceb13d2d05 54 /*!
GregCr 0:e6ceb13d2d05 55 * Constant values need to compute the RSSI value
GregCr 0:e6ceb13d2d05 56 */
GregCr 0:e6ceb13d2d05 57 #define RSSI_OFFSET_LF -164.0
GregCr 0:e6ceb13d2d05 58 #define RSSI_OFFSET_HF -157.0
GregCr 0:e6ceb13d2d05 59
GregCr 0:e6ceb13d2d05 60 #define RF_MID_BAND_THRESH 525000000
GregCr 0:e6ceb13d2d05 61
Helmut Tschemernjak 34:07e89f23c734 62 #if 0
Helmut64 27:1a9d7dadb593 63 #ifdef TARGET_STM32L0
Helmut Tschemernjak 28:6d83af9f8563 64 #define MURATA_ANT_SWITCH 1 // STM B-L072Z-LRWAN1 device
Helmut Tschemernjak 28:6d83af9f8563 65 #elif TARGET_STM32L4
Helmut Tschemernjak 28:6d83af9f8563 66 #define RFM95_MODULE 1 // RFM95 modules are SX1276MB1LAS compatible
Helmut64 27:1a9d7dadb593 67 #endif
Helmut Tschemernjak 34:07e89f23c734 68 #endif
Helmut Tschemernjak 34:07e89f23c734 69
Helmut64 26:87796ee62589 70
Helmut Tschemernjak 33:5db0d1e716b1 71 typedef enum {
Helmut Tschemernjak 33:5db0d1e716b1 72 LORA_BANKWIDTH_7kHz = 0, // 7.8 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 73 LORA_BANKWIDTH_10kHz = 1, // 10.4 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 74 LORA_BANKWIDTH_15kHz = 2, // 15.6 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 75 LORA_BANKWIDTH_20kHz = 3, // 20.8 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 76 LORA_BANKWIDTH_31kHz = 4, // 31.2 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 77 LORA_BANKWIDTH_41kHz = 5, // 41.4 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 78 LORA_BANKWIDTH_62kHz = 6, // 62.5 kHz requires TCXO
Helmut Tschemernjak 33:5db0d1e716b1 79
Helmut Tschemernjak 33:5db0d1e716b1 80 LORA_BANKWIDTH_125kHz = 7,
Helmut Tschemernjak 33:5db0d1e716b1 81 LORA_BANKWIDTH_250kHz = 8,
Helmut Tschemernjak 33:5db0d1e716b1 82 LORA_BANKWIDTH_500kHz = 9,
Helmut Tschemernjak 33:5db0d1e716b1 83 LORA_BANKWIDTH_RESERVED = 10,
Helmut Tschemernjak 33:5db0d1e716b1 84 } Lora_bandwidth_t;
Helmut Tschemernjak 33:5db0d1e716b1 85
Helmut Tschemernjak 33:5db0d1e716b1 86
Helmut Tschemernjak 33:5db0d1e716b1 87
Helmut Tschemernjak 33:5db0d1e716b1 88 typedef enum {
Helmut Tschemernjak 33:5db0d1e716b1 89 LORA_SF6 = 6, // 64 chips/symbol, SF6 requires an TCXO!
Helmut Tschemernjak 33:5db0d1e716b1 90 LORA_SF7 = 7, // 128 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 91 LORA_SF8 = 8, // 256 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 92 LORA_SF9 = 9, // 512 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 93 LORA_SF10 = 10, // 1024 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 94 LORA_SF11 = 11, // 2048 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 95 LORA_SF12 = 12, // 4096 chips/symbol
Helmut Tschemernjak 33:5db0d1e716b1 96 } lora_spreading_factor_t;
Helmut Tschemernjak 33:5db0d1e716b1 97
Helmut Tschemernjak 33:5db0d1e716b1 98
Helmut Tschemernjak 33:5db0d1e716b1 99 typedef enum { // cyclic error coding to perform forward error detection and correction
Helmut Tschemernjak 33:5db0d1e716b1 100 LORA_ERROR_CODING_RATE_4_5 = 1, // 1.25x overhead
Helmut Tschemernjak 33:5db0d1e716b1 101 LORA_ERROR_CODING_RATE_4_6 = 2, // 1.50x overhead
Helmut Tschemernjak 33:5db0d1e716b1 102 LORA_ERROR_CODING_RATE_4_7 = 3, // 1.75x overhead
Helmut Tschemernjak 33:5db0d1e716b1 103 LORA_ERROR_CODING_RATE_4_8 = 4, // 2.00x overhead
Helmut Tschemernjak 33:5db0d1e716b1 104 } lora_coding_rate_t;
Helmut Tschemernjak 33:5db0d1e716b1 105
Helmut Tschemernjak 33:5db0d1e716b1 106
Helmut Tschemernjak 33:5db0d1e716b1 107 typedef enum {
Helmut Tschemernjak 33:5db0d1e716b1 108 RF_FREQUENCY_868_0 = 868000000, // Hz
Helmut Tschemernjak 33:5db0d1e716b1 109 RF_FREQUENCY_868_1 = 868100000, // Hz
Helmut Tschemernjak 33:5db0d1e716b1 110 RF_FREQUENCY_868_3 = 868300000, // Hz
Helmut Tschemernjak 33:5db0d1e716b1 111 RF_FREQUENCY_868_5 = 868500000, // Hz
Helmut Tschemernjak 33:5db0d1e716b1 112 } rf_frequency_t;
Helmut Tschemernjak 33:5db0d1e716b1 113
Helmut Tschemernjak 33:5db0d1e716b1 114
Helmut Tschemernjak 33:5db0d1e716b1 115
Helmut Tschemernjak 33:5db0d1e716b1 116 /*!
GregCr 0:e6ceb13d2d05 117 * Actual implementation of a SX1276 radio, inherits Radio
GregCr 0:e6ceb13d2d05 118 */
GregCr 0:e6ceb13d2d05 119 class SX1276 : public Radio
GregCr 0:e6ceb13d2d05 120 {
GregCr 0:e6ceb13d2d05 121 protected:
mluis 25:3778e6204cc1 122
mluis 13:618826a997e2 123 bool isRadioActive;
mluis 25:3778e6204cc1 124
Helmut Tschemernjak 34:07e89f23c734 125 BoardType_t boardConnected; //1 = SX1276MB1LAS; 0 = SX1276MB1MAS
mluis 25:3778e6204cc1 126
GregCr 23:1e143575df0f 127 uint8_t *rxtxBuffer;
mluis 13:618826a997e2 128
mluis 13:618826a997e2 129 /*!
mluis 13:618826a997e2 130 * Hardware DIO IRQ functions
mluis 13:618826a997e2 131 */
mluis 13:618826a997e2 132 DioIrqHandler *dioIrq;
mluis 25:3778e6204cc1 133
mluis 13:618826a997e2 134 /*!
mluis 13:618826a997e2 135 * Tx and Rx timers
mluis 13:618826a997e2 136 */
mluis 13:618826a997e2 137 Timeout txTimeoutTimer;
mluis 13:618826a997e2 138 Timeout rxTimeoutTimer;
mluis 13:618826a997e2 139 Timeout rxTimeoutSyncWord;
mluis 25:3778e6204cc1 140
mluis 13:618826a997e2 141 RadioSettings_t settings;
mluis 25:3778e6204cc1 142
Helmut Tschemernjak 31:e50929bd3f32 143 static const FskBandwidth_t FskBandwidths[];
GregCr 0:e6ceb13d2d05 144 protected:
GregCr 0:e6ceb13d2d05 145
mluis 13:618826a997e2 146 /*!
mluis 13:618826a997e2 147 * Performs the Rx chain calibration for LF and HF bands
mluis 13:618826a997e2 148 * \remark Must be called just after the reset so all registers are at their
mluis 13:618826a997e2 149 * default values
mluis 13:618826a997e2 150 */
mluis 13:618826a997e2 151 void RxChainCalibration( void );
GregCr 0:e6ceb13d2d05 152
GregCr 0:e6ceb13d2d05 153 public:
Helmut Tschemernjak 34:07e89f23c734 154 SX1276( RadioEvents_t *events);
mluis 13:618826a997e2 155 virtual ~SX1276( );
mluis 13:618826a997e2 156
mluis 13:618826a997e2 157 //-------------------------------------------------------------------------
mluis 13:618826a997e2 158 // Redefined Radio functions
mluis 13:618826a997e2 159 //-------------------------------------------------------------------------
mluis 13:618826a997e2 160 /*!
mluis 21:2e496deb7858 161 * @brief Initializes the radio
mluis 21:2e496deb7858 162 *
mluis 21:2e496deb7858 163 * @param [IN] events Structure containing the driver callback functions
mluis 21:2e496deb7858 164 */
mluis 21:2e496deb7858 165 virtual void Init( RadioEvents_t *events );
mluis 21:2e496deb7858 166 /*!
GregCr 0:e6ceb13d2d05 167 * Return current radio status
GregCr 0:e6ceb13d2d05 168 *
mluis 21:2e496deb7858 169 * @param status Radio status. [RF_IDLE, RX_RUNNING, TX_RUNNING]
GregCr 0:e6ceb13d2d05 170 */
GregCr 19:71a47bb03fbb 171 virtual RadioState GetStatus( void );
mluis 25:3778e6204cc1 172
mluis 13:618826a997e2 173 /*!
mluis 13:618826a997e2 174 * @brief Configures the SX1276 with the given modem
mluis 13:618826a997e2 175 *
mluis 13:618826a997e2 176 * @param [IN] modem Modem to be used [0: FSK, 1: LoRa]
mluis 13:618826a997e2 177 */
mluis 22:7f3aab69cca9 178 virtual void SetModem( RadioModems_t modem );
mluis 13:618826a997e2 179
mluis 13:618826a997e2 180 /*!
GregCr 0:e6ceb13d2d05 181 * @brief Sets the channel frequency
GregCr 0:e6ceb13d2d05 182 *
GregCr 0:e6ceb13d2d05 183 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 184 */
GregCr 0:e6ceb13d2d05 185 virtual void SetChannel( uint32_t freq );
mluis 25:3778e6204cc1 186
mluis 13:618826a997e2 187 /*!
GregCr 0:e6ceb13d2d05 188 * @brief Sets the channels configuration
GregCr 0:e6ceb13d2d05 189 *
GregCr 0:e6ceb13d2d05 190 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 191 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 192 * @param [IN] rssiThresh RSSI threshold
GregCr 0:e6ceb13d2d05 193 *
GregCr 0:e6ceb13d2d05 194 * @retval isFree [true: Channel is free, false: Channel is not free]
GregCr 0:e6ceb13d2d05 195 */
mluis 22:7f3aab69cca9 196 virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh );
mluis 25:3778e6204cc1 197
mluis 13:618826a997e2 198 /*!
GregCr 0:e6ceb13d2d05 199 * @brief Generates a 32 bits random value based on the RSSI readings
GregCr 0:e6ceb13d2d05 200 *
GregCr 0:e6ceb13d2d05 201 * \remark This function sets the radio in LoRa modem mode and disables
GregCr 0:e6ceb13d2d05 202 * all interrupts.
GregCr 0:e6ceb13d2d05 203 * After calling this function either Radio.SetRxConfig or
GregCr 0:e6ceb13d2d05 204 * Radio.SetTxConfig functions must be called.
GregCr 0:e6ceb13d2d05 205 *
GregCr 0:e6ceb13d2d05 206 * @retval randomValue 32 bits random value
GregCr 0:e6ceb13d2d05 207 */
GregCr 0:e6ceb13d2d05 208 virtual uint32_t Random( void );
mluis 25:3778e6204cc1 209
mluis 13:618826a997e2 210 /*!
GregCr 0:e6ceb13d2d05 211 * @brief Sets the reception parameters
GregCr 0:e6ceb13d2d05 212 *
GregCr 0:e6ceb13d2d05 213 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 214 * @param [IN] bandwidth Sets the bandwidth
GregCr 0:e6ceb13d2d05 215 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 216 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 217 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 218 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 219 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 220 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 221 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 222 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 223 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 224 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 225 * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only )
GregCr 0:e6ceb13d2d05 226 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 227 * LoRa: N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 228 * @param [IN] preambleLen Sets the Preamble length ( LoRa only )
GregCr 0:e6ceb13d2d05 229 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 230 * LoRa: Length in symbols ( the hardware adds 4 more symbols )
Helmut Tschemernjak 31:e50929bd3f32 231 * @param [IN] symbTimeout Sets the RxSingle timeout value
Helmut Tschemernjak 31:e50929bd3f32 232 * FSK : timeout number of bytes
GregCr 0:e6ceb13d2d05 233 * LoRa: timeout in symbols
GregCr 0:e6ceb13d2d05 234 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
mluis 13:618826a997e2 235 * @param [IN] payloadLen Sets payload length when fixed lenght is used
GregCr 0:e6ceb13d2d05 236 * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 237 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 238 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 239 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 240 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 241 * LoRa: [0: not inverted, 1: inverted]
GregCr 0:e6ceb13d2d05 242 * @param [IN] rxContinuous Sets the reception in continuous mode
GregCr 0:e6ceb13d2d05 243 * [false: single mode, true: continuous mode]
GregCr 0:e6ceb13d2d05 244 */
mluis 22:7f3aab69cca9 245 virtual void SetRxConfig ( RadioModems_t modem, uint32_t bandwidth,
GregCr 0:e6ceb13d2d05 246 uint32_t datarate, uint8_t coderate,
GregCr 0:e6ceb13d2d05 247 uint32_t bandwidthAfc, uint16_t preambleLen,
GregCr 0:e6ceb13d2d05 248 uint16_t symbTimeout, bool fixLen,
mluis 13:618826a997e2 249 uint8_t payloadLen,
mluis 13:618826a997e2 250 bool crcOn, bool freqHopOn, uint8_t hopPeriod,
GregCr 6:e7f02929cd3d 251 bool iqInverted, bool rxContinuous );
mluis 25:3778e6204cc1 252
mluis 13:618826a997e2 253 /*!
GregCr 0:e6ceb13d2d05 254 * @brief Sets the transmission parameters
GregCr 0:e6ceb13d2d05 255 *
GregCr 0:e6ceb13d2d05 256 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 257 * @param [IN] power Sets the output power [dBm]
GregCr 0:e6ceb13d2d05 258 * @param [IN] fdev Sets the frequency deviation ( FSK only )
GregCr 0:e6ceb13d2d05 259 * FSK : [Hz]
GregCr 0:e6ceb13d2d05 260 * LoRa: 0
GregCr 0:e6ceb13d2d05 261 * @param [IN] bandwidth Sets the bandwidth ( LoRa only )
GregCr 0:e6ceb13d2d05 262 * FSK : 0
GregCr 0:e6ceb13d2d05 263 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 264 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 265 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 266 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 267 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 268 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 269 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 270 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 271 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 272 * @param [IN] preambleLen Sets the preamble length
GregCr 0:e6ceb13d2d05 273 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
GregCr 0:e6ceb13d2d05 274 * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 275 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 276 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 277 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 278 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 279 * LoRa: [0: not inverted, 1: inverted]
Helmut Tschemernjak 31:e50929bd3f32 280 * @param [IN] timeout Transmission timeout [ms]
GregCr 0:e6ceb13d2d05 281 */
mluis 22:7f3aab69cca9 282 virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
GregCr 0:e6ceb13d2d05 283 uint32_t bandwidth, uint32_t datarate,
GregCr 0:e6ceb13d2d05 284 uint8_t coderate, uint16_t preambleLen,
mluis 13:618826a997e2 285 bool fixLen, bool crcOn, bool freqHopOn,
mluis 13:618826a997e2 286 uint8_t hopPeriod, bool iqInverted, uint32_t timeout );
mluis 25:3778e6204cc1 287
mluis 13:618826a997e2 288 /*!
Helmut Tschemernjak 31:e50929bd3f32 289 * @brief Checks if the given RF frequency is supported by the hardware
Helmut Tschemernjak 31:e50929bd3f32 290 *
Helmut Tschemernjak 31:e50929bd3f32 291 * @param [IN] frequency RF frequency to be checked
Helmut Tschemernjak 31:e50929bd3f32 292 * @retval isSupported [true: supported, false: unsupported]
Helmut Tschemernjak 31:e50929bd3f32 293 */
Helmut Tschemernjak 31:e50929bd3f32 294 virtual bool CheckRfFrequency( uint32_t frequency ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 295
Helmut Tschemernjak 31:e50929bd3f32 296 /*!
GregCr 0:e6ceb13d2d05 297 * @brief Computes the packet time on air for the given payload
GregCr 0:e6ceb13d2d05 298 *
GregCr 0:e6ceb13d2d05 299 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
GregCr 0:e6ceb13d2d05 300 *
GregCr 0:e6ceb13d2d05 301 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 302 * @param [IN] pktLen Packet payload length
GregCr 0:e6ceb13d2d05 303 *
GregCr 0:e6ceb13d2d05 304 * @retval airTime Computed airTime for the given packet payload length
GregCr 0:e6ceb13d2d05 305 */
Helmut Tschemernjak 31:e50929bd3f32 306 virtual uint32_t TimeOnAir ( RadioModems_t modem, uint8_t pktLen );
mluis 25:3778e6204cc1 307
mluis 13:618826a997e2 308 /*!
GregCr 0:e6ceb13d2d05 309 * @brief Sends the buffer of size. Prepares the packet to be sent and sets
GregCr 0:e6ceb13d2d05 310 * the radio in transmission
GregCr 0:e6ceb13d2d05 311 *
GregCr 0:e6ceb13d2d05 312 * @param [IN]: buffer Buffer pointer
GregCr 0:e6ceb13d2d05 313 * @param [IN]: size Buffer size
GregCr 0:e6ceb13d2d05 314 */
GregCr 0:e6ceb13d2d05 315 virtual void Send( uint8_t *buffer, uint8_t size );
mluis 25:3778e6204cc1 316
mluis 13:618826a997e2 317 /*!
GregCr 0:e6ceb13d2d05 318 * @brief Sets the radio in sleep mode
GregCr 0:e6ceb13d2d05 319 */
GregCr 0:e6ceb13d2d05 320 virtual void Sleep( void );
GregCr 0:e6ceb13d2d05 321
mluis 13:618826a997e2 322 /*!
GregCr 0:e6ceb13d2d05 323 * @brief Sets the radio in standby mode
GregCr 0:e6ceb13d2d05 324 */
GregCr 0:e6ceb13d2d05 325 virtual void Standby( void );
Helmut Tschemernjak 31:e50929bd3f32 326
Helmut Tschemernjak 31:e50929bd3f32 327 /*!
Helmut Tschemernjak 31:e50929bd3f32 328 * @brief Sets the radio in CAD mode
Helmut Tschemernjak 31:e50929bd3f32 329 */
Helmut Tschemernjak 31:e50929bd3f32 330 virtual void StartCad( void );
mluis 25:3778e6204cc1 331
mluis 13:618826a997e2 332 /*!
GregCr 0:e6ceb13d2d05 333 * @brief Sets the radio in reception mode for the given time
Helmut Tschemernjak 31:e50929bd3f32 334 * @param [IN] timeout Reception timeout [ms]
GregCr 0:e6ceb13d2d05 335 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 336 */
GregCr 0:e6ceb13d2d05 337 virtual void Rx( uint32_t timeout );
mluis 25:3778e6204cc1 338
mluis 13:618826a997e2 339 /*!
GregCr 0:e6ceb13d2d05 340 * @brief Sets the radio in transmission mode for the given time
Helmut Tschemernjak 31:e50929bd3f32 341 * @param [IN] timeout Transmission timeout [ms]
GregCr 0:e6ceb13d2d05 342 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 343 */
GregCr 0:e6ceb13d2d05 344 virtual void Tx( uint32_t timeout );
mluis 25:3778e6204cc1 345
mluis 13:618826a997e2 346 /*!
Helmut Tschemernjak 31:e50929bd3f32 347 * @brief Sets the radio in continuous wave transmission mode
Helmut Tschemernjak 31:e50929bd3f32 348 *
Helmut Tschemernjak 31:e50929bd3f32 349 * @param [IN]: freq Channel RF frequency
Helmut Tschemernjak 31:e50929bd3f32 350 * @param [IN]: power Sets the output power [dBm]
Helmut Tschemernjak 31:e50929bd3f32 351 * @param [IN]: time Transmission mode timeout [s]
GregCr 7:2b555111463f 352 */
Helmut Tschemernjak 31:e50929bd3f32 353
Helmut Tschemernjak 31:e50929bd3f32 354 virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time );
mluis 25:3778e6204cc1 355
mluis 13:618826a997e2 356 /*!
GregCr 0:e6ceb13d2d05 357 * @brief Reads the current RSSI value
GregCr 0:e6ceb13d2d05 358 *
GregCr 0:e6ceb13d2d05 359 * @retval rssiValue Current RSSI value in [dBm]
GregCr 0:e6ceb13d2d05 360 */
mluis 22:7f3aab69cca9 361 virtual int16_t GetRssi ( RadioModems_t modem );
mluis 25:3778e6204cc1 362
mluis 13:618826a997e2 363 /*!
GregCr 0:e6ceb13d2d05 364 * @brief Writes the radio register at the specified address
GregCr 0:e6ceb13d2d05 365 *
GregCr 0:e6ceb13d2d05 366 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 367 * @param [IN]: data New register value
GregCr 0:e6ceb13d2d05 368 */
GregCr 0:e6ceb13d2d05 369 virtual void Write ( uint8_t addr, uint8_t data ) = 0;
mluis 25:3778e6204cc1 370
mluis 13:618826a997e2 371 /*!
GregCr 0:e6ceb13d2d05 372 * @brief Reads the radio register at the specified address
GregCr 0:e6ceb13d2d05 373 *
GregCr 0:e6ceb13d2d05 374 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 375 * @retval data Register value
GregCr 0:e6ceb13d2d05 376 */
GregCr 0:e6ceb13d2d05 377 virtual uint8_t Read ( uint8_t addr ) = 0;
mluis 25:3778e6204cc1 378
mluis 13:618826a997e2 379 /*!
GregCr 0:e6ceb13d2d05 380 * @brief Writes multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 381 *
GregCr 0:e6ceb13d2d05 382 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 383 * @param [IN] buffer Buffer containing the new register's values
GregCr 0:e6ceb13d2d05 384 * @param [IN] size Number of registers to be written
GregCr 0:e6ceb13d2d05 385 */
GregCr 0:e6ceb13d2d05 386 virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
mluis 25:3778e6204cc1 387
mluis 13:618826a997e2 388 /*!
GregCr 0:e6ceb13d2d05 389 * @brief Reads multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 390 *
GregCr 0:e6ceb13d2d05 391 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 392 * @param [OUT] buffer Buffer where to copy the registers data
GregCr 0:e6ceb13d2d05 393 * @param [IN] size Number of registers to be read
GregCr 0:e6ceb13d2d05 394 */
GregCr 0:e6ceb13d2d05 395 virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
mluis 25:3778e6204cc1 396
mluis 13:618826a997e2 397 /*!
mluis 13:618826a997e2 398 * @brief Writes the buffer contents to the SX1276 FIFO
mluis 13:618826a997e2 399 *
mluis 13:618826a997e2 400 * @param [IN] buffer Buffer containing data to be put on the FIFO.
mluis 13:618826a997e2 401 * @param [IN] size Number of bytes to be written to the FIFO
mluis 13:618826a997e2 402 */
mluis 13:618826a997e2 403 virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 404
mluis 13:618826a997e2 405 /*!
mluis 13:618826a997e2 406 * @brief Reads the contents of the SX1276 FIFO
mluis 13:618826a997e2 407 *
mluis 13:618826a997e2 408 * @param [OUT] buffer Buffer where to copy the FIFO read data.
mluis 13:618826a997e2 409 * @param [IN] size Number of bytes to be read from the FIFO
mluis 13:618826a997e2 410 */
mluis 13:618826a997e2 411 virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0;
mluis 13:618826a997e2 412 /*!
mluis 13:618826a997e2 413 * @brief Resets the SX1276
mluis 13:618826a997e2 414 */
mluis 13:618826a997e2 415 virtual void Reset( void ) = 0;
mluis 25:3778e6204cc1 416
mluis 20:e05596ba4166 417 /*!
mluis 20:e05596ba4166 418 * @brief Sets the maximum payload length.
mluis 20:e05596ba4166 419 *
mluis 20:e05596ba4166 420 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
mluis 20:e05596ba4166 421 * @param [IN] max Maximum payload length in bytes
mluis 20:e05596ba4166 422 */
mluis 22:7f3aab69cca9 423 virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max );
mluis 25:3778e6204cc1 424
Helmut Tschemernjak 31:e50929bd3f32 425 /*!
Helmut Tschemernjak 31:e50929bd3f32 426 * \brief Sets the network to public or private. Updates the sync byte.
Helmut Tschemernjak 31:e50929bd3f32 427 *
Helmut Tschemernjak 31:e50929bd3f32 428 * \remark Applies to LoRa modem only
Helmut Tschemernjak 31:e50929bd3f32 429 *
Helmut Tschemernjak 31:e50929bd3f32 430 * \param [IN] enable if true, it enables a public network
Helmut Tschemernjak 31:e50929bd3f32 431 */
Helmut Tschemernjak 31:e50929bd3f32 432 virtual void SetPublicNetwork( bool enable );
Helmut Tschemernjak 31:e50929bd3f32 433
Helmut Tschemernjak 31:e50929bd3f32 434
mluis 13:618826a997e2 435 //-------------------------------------------------------------------------
mluis 13:618826a997e2 436 // Board relative functions
mluis 13:618826a997e2 437 //-------------------------------------------------------------------------
mluis 25:3778e6204cc1 438
GregCr 0:e6ceb13d2d05 439 protected:
mluis 13:618826a997e2 440 /*!
mluis 13:618826a997e2 441 * @brief Initializes the radio I/Os pins interface
mluis 13:618826a997e2 442 */
mluis 13:618826a997e2 443 virtual void IoInit( void ) = 0;
mluis 13:618826a997e2 444
mluis 13:618826a997e2 445 /*!
mluis 13:618826a997e2 446 * @brief Initializes the radio registers
mluis 13:618826a997e2 447 */
mluis 13:618826a997e2 448 virtual void RadioRegistersInit( ) = 0;
mluis 13:618826a997e2 449
mluis 13:618826a997e2 450 /*!
mluis 13:618826a997e2 451 * @brief Initializes the radio SPI
mluis 13:618826a997e2 452 */
mluis 13:618826a997e2 453 virtual void SpiInit( void ) = 0;
mluis 25:3778e6204cc1 454
mluis 13:618826a997e2 455 /*!
mluis 13:618826a997e2 456 * @brief Initializes DIO IRQ handlers
mluis 13:618826a997e2 457 *
mluis 13:618826a997e2 458 * @param [IN] irqHandlers Array containing the IRQ callback functions
mluis 13:618826a997e2 459 */
mluis 13:618826a997e2 460 virtual void IoIrqInit( DioIrqHandler *irqHandlers ) = 0;
GregCr 0:e6ceb13d2d05 461
mluis 13:618826a997e2 462 /*!
mluis 13:618826a997e2 463 * @brief De-initializes the radio I/Os pins interface.
mluis 13:618826a997e2 464 *
mluis 13:618826a997e2 465 * \remark Useful when going in MCU lowpower modes
mluis 13:618826a997e2 466 */
mluis 13:618826a997e2 467 virtual void IoDeInit( void ) = 0;
GregCr 0:e6ceb13d2d05 468
mluis 13:618826a997e2 469 /*!
Helmut Tschemernjak 31:e50929bd3f32 470 * @brief Sets the radio output power.
Helmut Tschemernjak 31:e50929bd3f32 471 *
Helmut Tschemernjak 31:e50929bd3f32 472 * @param [IN] power Sets the RF output power
Helmut Tschemernjak 31:e50929bd3f32 473 */
Helmut Tschemernjak 31:e50929bd3f32 474 virtual void SetRfTxPower( int8_t power ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 475
Helmut Tschemernjak 31:e50929bd3f32 476 /*!
mluis 13:618826a997e2 477 * @brief Gets the board PA selection configuration
mluis 13:618826a997e2 478 *
mluis 13:618826a997e2 479 * @param [IN] channel Channel frequency in Hz
mluis 13:618826a997e2 480 * @retval PaSelect RegPaConfig PaSelect value
mluis 13:618826a997e2 481 */
mluis 13:618826a997e2 482 virtual uint8_t GetPaSelect( uint32_t channel ) = 0;
GregCr 0:e6ceb13d2d05 483
mluis 13:618826a997e2 484 /*!
mluis 13:618826a997e2 485 * @brief Set the RF Switch I/Os pins in Low Power mode
mluis 13:618826a997e2 486 *
mluis 13:618826a997e2 487 * @param [IN] status enable or disable
mluis 13:618826a997e2 488 */
mluis 13:618826a997e2 489 virtual void SetAntSwLowPower( bool status ) = 0;
GregCr 0:e6ceb13d2d05 490
mluis 13:618826a997e2 491 /*!
mluis 13:618826a997e2 492 * @brief Initializes the RF Switch I/Os pins interface
mluis 13:618826a997e2 493 */
mluis 13:618826a997e2 494 virtual void AntSwInit( void ) = 0;
GregCr 0:e6ceb13d2d05 495
mluis 13:618826a997e2 496 /*!
mluis 13:618826a997e2 497 * @brief De-initializes the RF Switch I/Os pins interface
mluis 13:618826a997e2 498 *
mluis 13:618826a997e2 499 * \remark Needed to decrease the power consumption in MCU lowpower modes
mluis 13:618826a997e2 500 */
mluis 13:618826a997e2 501 virtual void AntSwDeInit( void ) = 0;
GregCr 0:e6ceb13d2d05 502
mluis 13:618826a997e2 503 /*!
Helmut Tschemernjak 31:e50929bd3f32 504 * @brief Controls the antenna switch if necessary.
mluis 13:618826a997e2 505 *
mluis 13:618826a997e2 506 * \remark see errata note
mluis 13:618826a997e2 507 *
Helmut Tschemernjak 31:e50929bd3f32 508 * @param [IN] opMode Current radio operating mode
mluis 13:618826a997e2 509 */
Helmut Tschemernjak 31:e50929bd3f32 510 virtual void SetAntSw( uint8_t opMode ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 511
GregCr 0:e6ceb13d2d05 512 protected:
GregCr 0:e6ceb13d2d05 513
mluis 13:618826a997e2 514 /*!
mluis 13:618826a997e2 515 * @brief Sets the SX1276 operating mode
mluis 13:618826a997e2 516 *
mluis 13:618826a997e2 517 * @param [IN] opMode New operating mode
mluis 13:618826a997e2 518 */
mluis 13:618826a997e2 519 virtual void SetOpMode( uint8_t opMode );
GregCr 0:e6ceb13d2d05 520
mluis 13:618826a997e2 521 /*
mluis 13:618826a997e2 522 * SX1276 DIO IRQ callback functions prototype
mluis 13:618826a997e2 523 */
GregCr 0:e6ceb13d2d05 524
mluis 13:618826a997e2 525 /*!
mluis 13:618826a997e2 526 * @brief DIO 0 IRQ callback
mluis 13:618826a997e2 527 */
mluis 13:618826a997e2 528 virtual void OnDio0Irq( void );
GregCr 0:e6ceb13d2d05 529
mluis 13:618826a997e2 530 /*!
mluis 13:618826a997e2 531 * @brief DIO 1 IRQ callback
mluis 13:618826a997e2 532 */
mluis 13:618826a997e2 533 virtual void OnDio1Irq( void );
GregCr 0:e6ceb13d2d05 534
mluis 13:618826a997e2 535 /*!
mluis 13:618826a997e2 536 * @brief DIO 2 IRQ callback
mluis 13:618826a997e2 537 */
mluis 13:618826a997e2 538 virtual void OnDio2Irq( void );
GregCr 0:e6ceb13d2d05 539
mluis 13:618826a997e2 540 /*!
mluis 13:618826a997e2 541 * @brief DIO 3 IRQ callback
mluis 13:618826a997e2 542 */
mluis 13:618826a997e2 543 virtual void OnDio3Irq( void );
GregCr 0:e6ceb13d2d05 544
mluis 13:618826a997e2 545 /*!
mluis 13:618826a997e2 546 * @brief DIO 4 IRQ callback
mluis 13:618826a997e2 547 */
mluis 13:618826a997e2 548 virtual void OnDio4Irq( void );
GregCr 0:e6ceb13d2d05 549
mluis 13:618826a997e2 550 /*!
mluis 13:618826a997e2 551 * @brief DIO 5 IRQ callback
mluis 13:618826a997e2 552 */
mluis 13:618826a997e2 553 virtual void OnDio5Irq( void );
GregCr 0:e6ceb13d2d05 554
mluis 13:618826a997e2 555 /*!
mluis 13:618826a997e2 556 * @brief Tx & Rx timeout timer callback
mluis 13:618826a997e2 557 */
mluis 13:618826a997e2 558 virtual void OnTimeoutIrq( void );
mluis 25:3778e6204cc1 559
mluis 13:618826a997e2 560 /*!
mluis 13:618826a997e2 561 * Returns the known FSK bandwidth registers value
mluis 13:618826a997e2 562 *
mluis 13:618826a997e2 563 * \param [IN] bandwidth Bandwidth value in Hz
mluis 13:618826a997e2 564 * \retval regValue Bandwidth register value.
mluis 13:618826a997e2 565 */
mluis 13:618826a997e2 566 static uint8_t GetFskBandwidthRegValue( uint32_t bandwidth );
GregCr 0:e6ceb13d2d05 567 };
GregCr 0:e6ceb13d2d05 568
mluis 22:7f3aab69cca9 569 #endif // __SX1276_H__