Atar Babgei / SX1276Lib

Fork of SX1276 Lib

Fork of SX1276Lib by Semtech

sx1276/sx1276.h@29:d0d219851731, 2017-01-23 (annotated)

Committer:
atarbey
Date:
Mon Jan 23 12:18:01 2017 +0000
Revision:
29:d0d219851731
Parent:
28:8fb2ff77baef 
Modified for Drifter v1.1

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