Steven Osborn / SX1276GenericLib

Fork for LoDev

sx1276/sx1276-mbed-hal.h@102:3e0f7696f4a5, 2017-11-20 (annotated)

Committer:
Helmut Tschemernjak
Date:
Mon Nov 20 08:53:43 2017 +0100
Revision:
102:3e0f7696f4a5
Parent:
65:b2d98328fcba
Child:
109:528f37db941f
Formatting fixed

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