Atar Babgei / SX1276Lib

Fork of SX1276 Lib

Fork of SX1276Lib by Semtech

sx1276/sx1276.h@27:2aed13d8cd19, 2016-11-25 (annotated)

Committer:
atarbey
Date:
Fri Nov 25 16:31:26 2016 +0000
Revision:
27:2aed13d8cd19
Parent:
22:7f3aab69cca9
Child:
28:8fb2ff77baef
Working with RFM95

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