Steven Osborn / SX1276RonothLib

1276 hal configured for Ronoth devices

Dependents:   LoDev_RXTX

sx1276/sx1276.h@26:87796ee62589, 2017-03-24 (annotated)

Committer:
Helmut64
Date:
Fri Mar 24 15:06:46 2017 +0000
Revision:
26:87796ee62589
Parent:
25:3778e6204cc1
Child:
27:1a9d7dadb593
Added support to work with the Murata Lora Modul, in addition to the mbed SX1276 board.

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