modtronix H / SX1276Lib_modtronix

Enabled all bandwidths, added Modtronix inAir9 module

Dependents:   SX1276PingPong_modtronix

Fork of SX1276Lib by Gregory Cristian

sx1276/sx1276.h@25:72381be1b0ce, 2015-07-29 (annotated)

Committer:
modtronix
Date:
Wed Jul 29 12:07:40 2015 +1000
Revision:
25:72381be1b0ce
Parent:
23:2da0dcafe430 
Removed DIO4 and DIO5 from code. Not available on inAir Modules.

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