Thiago Lima / SX1276GenericLib2

f

sx1276/sx1276.h@28:6d83af9f8563, 2017-04-25 (annotated)

Committer:
Helmut Tschemernjak
Date:
Tue Apr 25 21:02:48 2017 +0200
Revision:
28:6d83af9f8563
Parent:
27:1a9d7dadb593
Child:
31:e50929bd3f32
Fixed MURATA spelling

Added proper support of the RFM95 module detection

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