ENEL400 / SX1276Lib

Add support of Nucleo-F446RE

Dependents:   Aloha LoRaBaseStation

Fork of SX1276Lib by Semtech

sx1276/sx1276.h@26:8eef98087d91, 2016-05-31 (annotated)

Committer:
rba90
Date:
Tue May 31 09:51:27 2016 +0000
Revision:
26:8eef98087d91
Parent:
25:3778e6204cc1 
Add support of Nucleo-F446RE

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