Christopher De Bank / SX1276Lib

pcb changes

Fork of SingleFrequencyLora by Christopher De Bank

sx1276/sx1276.h@21:2e496deb7858, 2015-11-26 (annotated)

Committer:
mluis
Date:
Thu Nov 26 10:39:03 2015 +0000
Revision:
21:2e496deb7858
Parent:
20:e05596ba4166
Child:
22:7f3aab69cca9
Made radio driver API compatible with GitHub radio driver

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