Thiago Lima / SX1276GenericLib2

f

sx1276/sx1276.h@31:e50929bd3f32, 2017-05-01 (annotated)

Committer:
Helmut Tschemernjak
Date:
Mon May 01 11:43:25 2017 +0200
Revision:
31:e50929bd3f32
Parent:
28:6d83af9f8563
Child:
32:f6f0bff38543
Merged from head, Semtech mbed changes of 24.4.17

- Timeouts are now in ms.

- In sync with github lora-net/LoRaMac-Node

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