CaryCoders / SX1276Lib

local copy of sx1276 library

Dependents:   SX1276_GPS demo_SX1276_standalone

Fork of SX1276Lib by Gregory Cristian

sx1276/sx1276.h@16:29f09ac61412, 2015-06-16 (annotated)

Committer:
ftagius
Date:
Tue Jun 16 11:52:30 2015 +0000
Revision:
16:29f09ac61412
Parent:
13:618826a997e2 
working version of sx1276

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