Lorenzo Maiorfi / SX1276Lib_RTOS

SX1276Lib updated in order to be RTOS aware

Fork of SX1276Lib by Semtech

sx1276/sx1276.h@22:7f3aab69cca9, 2015-11-26 (annotated)

Committer:
mluis
Date:
Thu Nov 26 16:55:15 2015 +0000
Revision:
22:7f3aab69cca9
Parent:
21:2e496deb7858
Child:
23:1e143575df0f
Child:
26:d09a8ef807e2
Synchronized the drivers with GitHub version.; Mainly added errata note recommendations

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