Steven Osborn / SX1276GenericLib

Fork for LoDev

sx1276/sx1276-mbed-hal.h@39:706c32eda7e7, 2017-05-07 (annotated)

Committer:
Helmut Tschemernjak
Date:
Sun May 07 20:26:02 2017 +0200
Revision:
39:706c32eda7e7
Parent:
38:d9189d958db8
Child:
42:72deced1a4c4
Further cleanup, removed enum.h which is not needed.

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