Kevin Barnett / SX1276GenericLib

Fork with intent to refactor and add support for American 902-928(915) Frequency Bands

sx1276/sx1276-mbed-hal.h@43:90de42f3c1fd, 2017-05-09 (annotated)

Committer:
Helmut Tschemernjak
Date:
Tue May 09 11:19:51 2017 +0200
Revision:
43:90de42f3c1fd
Parent:
42:72deced1a4c4 
Added proper TCXO support (being using in the Murata module)

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: -
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 */
Helmut Tschemernjak 34:07e89f23c734 15
Helmut Tschemernjak 34:07e89f23c734 16 /*
Helmut Tschemernjak 38:d9189d958db8 17 * additional development to make it more generic across multiple OS versions
Helmut Tschemernjak 34:07e89f23c734 18 * (c) 2017 Helmut Tschemernjak
Helmut Tschemernjak 34:07e89f23c734 19 * 30826 Garbsen (Hannover) Germany
Helmut Tschemernjak 34:07e89f23c734 20 */
Helmut Tschemernjak 34:07e89f23c734 21
Helmut Tschemernjak 39:706c32eda7e7 22 #ifndef __SX1276_MBED_HAL_H__
Helmut Tschemernjak 39:706c32eda7e7 23 #define __SX1276_MBED_HAL_H__
GregCr 0:e6ceb13d2d05 24 #include "sx1276.h"
GregCr 0:e6ceb13d2d05 25
Helmut Tschemernjak 38:d9189d958db8 26
Helmut Tschemernjak 38:d9189d958db8 27
Helmut Tschemernjak 38:d9189d958db8 28 /*!
GregCr 0:e6ceb13d2d05 29 * Actual implementation of a SX1276 radio, includes some modifications to make it compatible with the MB1 LAS board
GregCr 0:e6ceb13d2d05 30 */
Helmut Tschemernjak 34:07e89f23c734 31 class SX1276Generic : public SX1276
GregCr 0:e6ceb13d2d05 32 {
GregCr 0:e6ceb13d2d05 33 protected:
GregCr 0:e6ceb13d2d05 34 /*!
GregCr 0:e6ceb13d2d05 35 * Antenna switch GPIO pins objects
GregCr 0:e6ceb13d2d05 36 */
Helmut Tschemernjak 34:07e89f23c734 37 DigitalInOut *_antSwitch;
Helmut Tschemernjak 34:07e89f23c734 38 DigitalInOut *_antSwitchTX;
Helmut Tschemernjak 34:07e89f23c734 39 DigitalInOut *_antSwitchTXBoost;
Helmut Tschemernjak 34:07e89f23c734 40
Helmut Tschemernjak 34:07e89f23c734 41 /*!
Helmut Tschemernjak 34:07e89f23c734 42 * SX1276 Reset pin
Helmut Tschemernjak 34:07e89f23c734 43 */
Helmut Tschemernjak 34:07e89f23c734 44 DigitalInOut *_reset;
Helmut Tschemernjak 34:07e89f23c734 45
Helmut Tschemernjak 34:07e89f23c734 46 /*!
Helmut Tschemernjak 34:07e89f23c734 47 * TCXO being used with the Murata Module
Helmut Tschemernjak 43:90de42f3c1fd 48 * 32.768 MHz crystal.
Helmut Tschemernjak 34:07e89f23c734 49 */
Helmut Tschemernjak 34:07e89f23c734 50 DigitalOut *_tcxo;
mluis 25:3778e6204cc1 51
Helmut Tschemernjak 34:07e89f23c734 52 /*!
Helmut Tschemernjak 34:07e89f23c734 53 * SPI Interface
Helmut Tschemernjak 34:07e89f23c734 54 */
Helmut Tschemernjak 34:07e89f23c734 55 SPI *_spi; // mosi, miso, sclk
Helmut Tschemernjak 34:07e89f23c734 56 DigitalOut *_nss;
Helmut Tschemernjak 34:07e89f23c734 57
Helmut Tschemernjak 34:07e89f23c734 58 /*!
Helmut Tschemernjak 34:07e89f23c734 59 * SX1276 DIO pins
Helmut Tschemernjak 34:07e89f23c734 60 */
Helmut Tschemernjak 34:07e89f23c734 61 InterruptIn *_dio0;
Helmut Tschemernjak 34:07e89f23c734 62 InterruptIn *_dio1;
Helmut Tschemernjak 34:07e89f23c734 63 InterruptIn *_dio2;
Helmut Tschemernjak 34:07e89f23c734 64 InterruptIn *_dio3;
Helmut Tschemernjak 34:07e89f23c734 65 InterruptIn *_dio4;
Helmut Tschemernjak 34:07e89f23c734 66 DigitalIn *_dio5;
Helmut Tschemernjak 34:07e89f23c734 67
Helmut Tschemernjak 42:72deced1a4c4 68 /*!
Helmut Tschemernjak 42:72deced1a4c4 69 * Tx and Rx timers
Helmut Tschemernjak 42:72deced1a4c4 70 */
Helmut Tschemernjak 38:d9189d958db8 71 Timeout txTimeoutTimer;
Helmut Tschemernjak 42:72deced1a4c4 72 Timeout rxTimeoutTimer;
Helmut Tschemernjak 42:72deced1a4c4 73 Timeout rxTimeoutSyncWord;
Helmut Tschemernjak 38:d9189d958db8 74
Helmut Tschemernjak 43:90de42f3c1fd 75 static const int TCXO_STARTUP_MS = 3; // crystal startup time
Helmut Tschemernjak 43:90de42f3c1fd 76
Helmut Tschemernjak 38:d9189d958db8 77
GregCr 0:e6ceb13d2d05 78 private:
Helmut Tschemernjak 39:706c32eda7e7 79 /*!
Helmut Tschemernjak 39:706c32eda7e7 80 * triggers definition
Helmut Tschemernjak 39:706c32eda7e7 81 */
Helmut Tschemernjak 39:706c32eda7e7 82 typedef void (SX1276Generic::*Trigger)(void);
Helmut Tschemernjak 39:706c32eda7e7 83
mluis 25:3778e6204cc1 84
GregCr 0:e6ceb13d2d05 85 public:
Helmut Tschemernjak 34:07e89f23c734 86 SX1276Generic( RadioEvents_t *events, BoardType_t board,
GregCr 0:e6ceb13d2d05 87 PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset,
GregCr 0:e6ceb13d2d05 88 PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5,
Helmut Tschemernjak 34:07e89f23c734 89 PinName antSwitch = NC, PinName antSwitchTX= NC, PinName antSwitchTXBoost = NC, PinName tcxo = NC);
mluis 25:3778e6204cc1 90
Helmut Tschemernjak 34:07e89f23c734 91
Helmut Tschemernjak 34:07e89f23c734 92 SX1276Generic( RadioEvents_t *events );
mluis 25:3778e6204cc1 93
Helmut Tschemernjak 34:07e89f23c734 94 virtual ~SX1276Generic();
mluis 25:3778e6204cc1 95
mluis 25:3778e6204cc1 96 protected:
GregCr 0:e6ceb13d2d05 97 /*!
GregCr 0:e6ceb13d2d05 98 * @brief Initializes the radio I/Os pins interface
GregCr 0:e6ceb13d2d05 99 */
GregCr 0:e6ceb13d2d05 100 virtual void IoInit( void );
mluis 25:3778e6204cc1 101
GregCr 0:e6ceb13d2d05 102 /*!
GregCr 0:e6ceb13d2d05 103 * @brief Initializes the radio SPI
GregCr 0:e6ceb13d2d05 104 */
GregCr 0:e6ceb13d2d05 105 virtual void SpiInit( void );
mluis 25:3778e6204cc1 106
GregCr 0:e6ceb13d2d05 107 /*!
GregCr 0:e6ceb13d2d05 108 * @brief Initializes DIO IRQ handlers
GregCr 0:e6ceb13d2d05 109 *
GregCr 0:e6ceb13d2d05 110 * @param [IN] irqHandlers Array containing the IRQ callback functions
GregCr 0:e6ceb13d2d05 111 */
GregCr 0:e6ceb13d2d05 112 virtual void IoIrqInit( DioIrqHandler *irqHandlers );
GregCr 0:e6ceb13d2d05 113
GregCr 0:e6ceb13d2d05 114 /*!
GregCr 0:e6ceb13d2d05 115 * @brief De-initializes the radio I/Os pins interface.
GregCr 0:e6ceb13d2d05 116 *
GregCr 0:e6ceb13d2d05 117 * \remark Useful when going in MCU lowpower modes
GregCr 0:e6ceb13d2d05 118 */
GregCr 0:e6ceb13d2d05 119 virtual void IoDeInit( void );
GregCr 0:e6ceb13d2d05 120
GregCr 0:e6ceb13d2d05 121 /*!
Helmut Tschemernjak 31:e50929bd3f32 122 * \brief Sets the radio output power.
Helmut Tschemernjak 31:e50929bd3f32 123 *
Helmut Tschemernjak 31:e50929bd3f32 124 * @param [IN] power Sets the RF output power
Helmut Tschemernjak 31:e50929bd3f32 125 */
Helmut Tschemernjak 31:e50929bd3f32 126 virtual void SetRfTxPower( int8_t power );
Helmut Tschemernjak 31:e50929bd3f32 127
Helmut Tschemernjak 31:e50929bd3f32 128 /*!
GregCr 0:e6ceb13d2d05 129 * @brief Gets the board PA selection configuration
GregCr 0:e6ceb13d2d05 130 *
GregCr 0:e6ceb13d2d05 131 * @param [IN] channel Channel frequency in Hz
GregCr 0:e6ceb13d2d05 132 * @retval PaSelect RegPaConfig PaSelect value
GregCr 0:e6ceb13d2d05 133 */
GregCr 0:e6ceb13d2d05 134 virtual uint8_t GetPaSelect( uint32_t channel );
GregCr 0:e6ceb13d2d05 135
GregCr 0:e6ceb13d2d05 136 /*!
GregCr 0:e6ceb13d2d05 137 * @brief Set the RF Switch I/Os pins in Low Power mode
GregCr 0:e6ceb13d2d05 138 *
GregCr 0:e6ceb13d2d05 139 * @param [IN] status enable or disable
GregCr 0:e6ceb13d2d05 140 */
GregCr 0:e6ceb13d2d05 141 virtual void SetAntSwLowPower( bool status );
GregCr 0:e6ceb13d2d05 142
GregCr 0:e6ceb13d2d05 143 /*!
GregCr 0:e6ceb13d2d05 144 * @brief Initializes the RF Switch I/Os pins interface
GregCr 0:e6ceb13d2d05 145 */
GregCr 0:e6ceb13d2d05 146 virtual void AntSwInit( void );
GregCr 0:e6ceb13d2d05 147
GregCr 0:e6ceb13d2d05 148 /*!
GregCr 0:e6ceb13d2d05 149 * @brief De-initializes the RF Switch I/Os pins interface
GregCr 0:e6ceb13d2d05 150 *
Helmut Tschemernjak 31:e50929bd3f32 151 * @remark Needed to decrease the power consumption in MCU lowpower modes
GregCr 0:e6ceb13d2d05 152 */
GregCr 0:e6ceb13d2d05 153 virtual void AntSwDeInit( void );
GregCr 0:e6ceb13d2d05 154
GregCr 0:e6ceb13d2d05 155 /*!
GregCr 0:e6ceb13d2d05 156 * @brief Controls the antena switch if necessary.
GregCr 0:e6ceb13d2d05 157 *
Helmut Tschemernjak 31:e50929bd3f32 158 * @remark see errata note
GregCr 0:e6ceb13d2d05 159 *
Helmut Tschemernjak 31:e50929bd3f32 160 * @param [IN] opMode Current radio operating mode
GregCr 0:e6ceb13d2d05 161 */
Helmut Tschemernjak 31:e50929bd3f32 162 virtual void SetAntSw( uint8_t opMode );
Helmut Tschemernjak 38:d9189d958db8 163
Helmut Tschemernjak 38:d9189d958db8 164 /*
Helmut Tschemernjak 38:d9189d958db8 165 * The the Timeout for a given Timer.
Helmut Tschemernjak 38:d9189d958db8 166 */
Helmut Tschemernjak 42:72deced1a4c4 167 virtual void SetTimeout(TimeoutTimer_t timer, int timeout_ms);
mluis 25:3778e6204cc1 168
mluis 25:3778e6204cc1 169 public:
Helmut Tschemernjak 38:d9189d958db8 170
GregCr 0:e6ceb13d2d05 171 /*!
GregCr 2:5eb3066446dd 172 * @brief Detect the board connected by reading the value of the antenna switch pin
GregCr 2:5eb3066446dd 173 */
Helmut Tschemernjak 31:e50929bd3f32 174 virtual uint8_t DetectBoardType( void );
mluis 25:3778e6204cc1 175
GregCr 2:5eb3066446dd 176 /*!
GregCr 0:e6ceb13d2d05 177 * @brief Checks if the given RF frequency is supported by the hardware
GregCr 0:e6ceb13d2d05 178 *
GregCr 0:e6ceb13d2d05 179 * @param [IN] frequency RF frequency to be checked
GregCr 0:e6ceb13d2d05 180 * @retval isSupported [true: supported, false: unsupported]
GregCr 0:e6ceb13d2d05 181 */
GregCr 0:e6ceb13d2d05 182 virtual bool CheckRfFrequency( uint32_t frequency );
mluis 25:3778e6204cc1 183
mluis 25:3778e6204cc1 184 /*!
GregCr 0:e6ceb13d2d05 185 * @brief Writes the radio register at the specified address
GregCr 0:e6ceb13d2d05 186 *
GregCr 0:e6ceb13d2d05 187 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 188 * @param [IN]: data New register value
GregCr 0:e6ceb13d2d05 189 */
GregCr 0:e6ceb13d2d05 190 virtual void Write ( uint8_t addr, uint8_t data ) ;
mluis 25:3778e6204cc1 191
GregCr 0:e6ceb13d2d05 192 /*!
GregCr 0:e6ceb13d2d05 193 * @brief Reads the radio register at the specified address
GregCr 0:e6ceb13d2d05 194 *
GregCr 0:e6ceb13d2d05 195 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 196 * @retval data Register value
GregCr 0:e6ceb13d2d05 197 */
GregCr 0:e6ceb13d2d05 198 virtual uint8_t Read ( uint8_t addr ) ;
mluis 25:3778e6204cc1 199
GregCr 0:e6ceb13d2d05 200 /*!
GregCr 0:e6ceb13d2d05 201 * @brief Writes multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 202 *
GregCr 0:e6ceb13d2d05 203 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 204 * @param [IN] buffer Buffer containing the new register's values
GregCr 0:e6ceb13d2d05 205 * @param [IN] size Number of registers to be written
GregCr 0:e6ceb13d2d05 206 */
GregCr 0:e6ceb13d2d05 207 virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) ;
mluis 25:3778e6204cc1 208
GregCr 0:e6ceb13d2d05 209 /*!
GregCr 0:e6ceb13d2d05 210 * @brief Reads multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 211 *
GregCr 0:e6ceb13d2d05 212 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 213 * @param [OUT] buffer Buffer where to copy the registers data
GregCr 0:e6ceb13d2d05 214 * @param [IN] size Number of registers to be read
GregCr 0:e6ceb13d2d05 215 */
GregCr 0:e6ceb13d2d05 216 virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) ;
mluis 25:3778e6204cc1 217
GregCr 0:e6ceb13d2d05 218 /*!
GregCr 0:e6ceb13d2d05 219 * @brief Writes the buffer contents to the SX1276 FIFO
GregCr 0:e6ceb13d2d05 220 *
GregCr 0:e6ceb13d2d05 221 * @param [IN] buffer Buffer containing data to be put on the FIFO.
GregCr 0:e6ceb13d2d05 222 * @param [IN] size Number of bytes to be written to the FIFO
GregCr 0:e6ceb13d2d05 223 */
GregCr 0:e6ceb13d2d05 224 virtual void WriteFifo( uint8_t *buffer, uint8_t size ) ;
GregCr 0:e6ceb13d2d05 225
GregCr 0:e6ceb13d2d05 226 /*!
GregCr 0:e6ceb13d2d05 227 * @brief Reads the contents of the SX1276 FIFO
GregCr 0:e6ceb13d2d05 228 *
GregCr 0:e6ceb13d2d05 229 * @param [OUT] buffer Buffer where to copy the FIFO read data.
GregCr 0:e6ceb13d2d05 230 * @param [IN] size Number of bytes to be read from the FIFO
GregCr 0:e6ceb13d2d05 231 */
GregCr 0:e6ceb13d2d05 232 virtual void ReadFifo( uint8_t *buffer, uint8_t size ) ;
mluis 25:3778e6204cc1 233
GregCr 0:e6ceb13d2d05 234 /*!
GregCr 0:e6ceb13d2d05 235 * @brief Reset the SX1276
GregCr 0:e6ceb13d2d05 236 */
GregCr 0:e6ceb13d2d05 237 virtual void Reset( void );
GregCr 0:e6ceb13d2d05 238 };
GregCr 0:e6ceb13d2d05 239
Helmut Tschemernjak 39:706c32eda7e7 240 #endif // __SX1276_MBED_HAL_H__