Capstone / SX1276Lib_modtronix

SX1276 library for modtronix inair9. Edited for use with NRF51DK board.

Dependents:   InAir9_PingPong

Fork of SX1276Lib_modtronix by modtronix H

radio/radio.h@26:ad32782125eb, 2017-11-19 (annotated)

Committer:
AMNoll
Date:
Sun Nov 19 18:19:55 2017 +0000
Revision:
26:ad32782125eb
Parent:
23:2da0dcafe430 
latest version of pingpong on inair9

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: Interface for the radios, contains the main functions that a radio needs, and 5 callback functions
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 __RADIO_H__
GregCr 0:e6ceb13d2d05 16 #define __RADIO_H__
GregCr 0:e6ceb13d2d05 17
GregCr 0:e6ceb13d2d05 18 #include "mbed.h"
GregCr 0:e6ceb13d2d05 19
GregCr 0:e6ceb13d2d05 20 #include "./enums/enums.h"
GregCr 0:e6ceb13d2d05 21
GregCr 0:e6ceb13d2d05 22 /*!
mluis 13:618826a997e2 23 * Interface for the radios, contains the main functions that a radio needs, and 5 callback functions
GregCr 0:e6ceb13d2d05 24 */
GregCr 0:e6ceb13d2d05 25 class Radio
GregCr 0:e6ceb13d2d05 26 {
GregCr 0:e6ceb13d2d05 27 protected:
GregCr 0:e6ceb13d2d05 28
mluis 13:618826a997e2 29 //-------------------------------------------------------------------------
mluis 13:618826a997e2 30 // Callback functions pointers
mluis 13:618826a997e2 31 //-------------------------------------------------------------------------
mluis 13:618826a997e2 32
mluis 13:618826a997e2 33 /*!
GregCr 0:e6ceb13d2d05 34 * @brief Tx Done callback prototype.
GregCr 0:e6ceb13d2d05 35 */
mluis 13:618826a997e2 36 void ( *txDone )( );
GregCr 0:e6ceb13d2d05 37
mluis 13:618826a997e2 38 /*!
GregCr 0:e6ceb13d2d05 39 * @brief Tx Timeout callback prototype.
GregCr 0:e6ceb13d2d05 40 */
mluis 13:618826a997e2 41 void ( *txTimeout ) ( );
GregCr 0:e6ceb13d2d05 42
mluis 13:618826a997e2 43 /*!
GregCr 0:e6ceb13d2d05 44 * @brief Rx Done callback prototype.
GregCr 0:e6ceb13d2d05 45 *
GregCr 0:e6ceb13d2d05 46 * @param [IN] payload Received buffer pointer
GregCr 0:e6ceb13d2d05 47 * @param [IN] size Received buffer size
GregCr 0:e6ceb13d2d05 48 * @param [IN] rssi RSSI value computed while receiving the frame [dBm]
GregCr 0:e6ceb13d2d05 49 * @param [IN] snr Raw SNR value given by the radio hardware
GregCr 0:e6ceb13d2d05 50 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 51 * LoRa: SNR value in dB
GregCr 0:e6ceb13d2d05 52 */
mluis 13:618826a997e2 53 void ( *rxDone ) ( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr );
GregCr 0:e6ceb13d2d05 54
GregCr 0:e6ceb13d2d05 55 /*!
GregCr 0:e6ceb13d2d05 56 * @brief Rx Timeout callback prototype.
GregCr 0:e6ceb13d2d05 57 */
mluis 13:618826a997e2 58 void ( *rxTimeout ) ( );
mluis 13:618826a997e2 59
GregCr 0:e6ceb13d2d05 60 /*!
GregCr 0:e6ceb13d2d05 61 * @brief Rx Error callback prototype.
GregCr 0:e6ceb13d2d05 62 */
mluis 13:618826a997e2 63 void ( *rxError ) ( );
mluis 13:618826a997e2 64
mluis 13:618826a997e2 65 /*!
GregCr 6:e7f02929cd3d 66 * \brief FHSS Change Channel callback prototype.
GregCr 6:e7f02929cd3d 67 *
GregCr 6:e7f02929cd3d 68 * \param [IN] CurrentChannel Index number of the current channel
GregCr 6:e7f02929cd3d 69 */
GregCr 6:e7f02929cd3d 70 void ( *fhssChangeChannel )( uint8_t CurrentChannel );
GregCr 7:2b555111463f 71
GregCr 7:2b555111463f 72 /*!
GregCr 7:2b555111463f 73 * @brief CAD Done callback prototype.
GregCr 12:aa5b3bf7fdf4 74 *
GregCr 12:aa5b3bf7fdf4 75 * @param [IN] ChannelDetected Channel Activity detected during the CAD
GregCr 7:2b555111463f 76 */
mluis 13:618826a997e2 77 void ( *cadDone ) ( bool channelActivityDetected );
mluis 13:618826a997e2 78
GregCr 0:e6ceb13d2d05 79 public:
mluis 13:618826a997e2 80 //-------------------------------------------------------------------------
mluis 13:618826a997e2 81 // Constructor
mluis 13:618826a997e2 82 //-------------------------------------------------------------------------
mluis 13:618826a997e2 83 /*!
mluis 13:618826a997e2 84 * @brief Constructor of the radio object, the parameters are the callback functions described in the header.
mluis 13:618826a997e2 85 * @param [IN] txDone
mluis 13:618826a997e2 86 * @param [IN] txTimeout
mluis 13:618826a997e2 87 * @param [IN] rxDone
mluis 13:618826a997e2 88 * @param [IN] rxTimeout
mluis 13:618826a997e2 89 * @param [IN] rxError
mluis 13:618826a997e2 90 */
mluis 13:618826a997e2 91 Radio( void ( *txDone )( ), void ( *txTimeout ) ( ), void ( *rxDone ) ( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ),
mluis 13:618826a997e2 92 void ( *rxTimeout ) ( ), void ( *rxError ) ( ), void ( *fhssChangeChannel ) ( uint8_t channelIndex ), void ( *cadDone ) ( bool channelActivityDetected ) );
mluis 13:618826a997e2 93 virtual ~Radio( ) {};
GregCr 0:e6ceb13d2d05 94
mluis 13:618826a997e2 95 //-------------------------------------------------------------------------
mluis 13:618826a997e2 96 // Pure virtual functions
mluis 13:618826a997e2 97 //-------------------------------------------------------------------------
GregCr 0:e6ceb13d2d05 98
modtronix 22:20db480143c9 99
modtronix 22:20db480143c9 100 /*!
modtronix 22:20db480143c9 101 * Return board type
modtronix 22:20db480143c9 102 *
modtronix 23:2da0dcafe430 103 * @return Returns a BOARD_XXX define
modtronix 22:20db480143c9 104 */
modtronix 22:20db480143c9 105 virtual uint8_t GetBoardType( void ) = 0;
modtronix 22:20db480143c9 106
modtronix 22:20db480143c9 107 /*!
modtronix 22:20db480143c9 108 * Sets the board type, is a BOARD_XXX define
modtronix 22:20db480143c9 109 *
modtronix 22:20db480143c9 110 * @param boardType The board type, is a BOARD_XXX define
modtronix 22:20db480143c9 111 */
modtronix 22:20db480143c9 112 virtual void SetBoardType( uint8_t boardType) = 0;
modtronix 22:20db480143c9 113
mluis 13:618826a997e2 114 /*!
GregCr 0:e6ceb13d2d05 115 * Return current radio status
GregCr 0:e6ceb13d2d05 116 *
GregCr 0:e6ceb13d2d05 117 * @param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
GregCr 0:e6ceb13d2d05 118 */
GregCr 0:e6ceb13d2d05 119 virtual RadioState GetState( void ) = 0;
mluis 13:618826a997e2 120
mluis 13:618826a997e2 121 /*!
mluis 13:618826a997e2 122 * \brief Configures the radio with the given modem
mluis 13:618826a997e2 123 *
mluis 13:618826a997e2 124 * \param [IN] modem Modem to be used [0: FSK, 1: LoRa]
mluis 13:618826a997e2 125 */
mluis 13:618826a997e2 126 virtual void SetModem( ModemType modem ) = 0;
mluis 13:618826a997e2 127
mluis 13:618826a997e2 128 /*!
GregCr 0:e6ceb13d2d05 129 * @brief Sets the channel frequency
GregCr 0:e6ceb13d2d05 130 *
GregCr 0:e6ceb13d2d05 131 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 132 */
GregCr 0:e6ceb13d2d05 133 virtual void SetChannel( uint32_t freq ) = 0;
GregCr 0:e6ceb13d2d05 134
mluis 13:618826a997e2 135 /*!
GregCr 0:e6ceb13d2d05 136 * @brief Sets the channels configuration
GregCr 0:e6ceb13d2d05 137 *
GregCr 0:e6ceb13d2d05 138 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 139 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 140 * @param [IN] rssiThresh RSSI threshold
GregCr 0:e6ceb13d2d05 141 *
GregCr 0:e6ceb13d2d05 142 * @retval isFree [true: Channel is free, false: Channel is not free]
GregCr 0:e6ceb13d2d05 143 */
GregCr 0:e6ceb13d2d05 144 virtual bool IsChannelFree( ModemType modem, uint32_t freq, int8_t rssiThresh ) = 0;
GregCr 0:e6ceb13d2d05 145
mluis 13:618826a997e2 146 /*!
GregCr 0:e6ceb13d2d05 147 * @brief Generates a 32 bits random value based on the RSSI readings
GregCr 0:e6ceb13d2d05 148 *
GregCr 0:e6ceb13d2d05 149 * \remark This function sets the radio in LoRa modem mode and disables
GregCr 0:e6ceb13d2d05 150 * all interrupts.
GregCr 0:e6ceb13d2d05 151 * After calling this function either Radio.SetRxConfig or
GregCr 0:e6ceb13d2d05 152 * Radio.SetTxConfig functions must be called.
GregCr 0:e6ceb13d2d05 153 *
GregCr 0:e6ceb13d2d05 154 * @retval randomValue 32 bits random value
GregCr 0:e6ceb13d2d05 155 */
GregCr 0:e6ceb13d2d05 156 virtual uint32_t Random( void )= 0;
GregCr 0:e6ceb13d2d05 157
mluis 13:618826a997e2 158 /*!
GregCr 0:e6ceb13d2d05 159 * @brief Sets the reception parameters
GregCr 0:e6ceb13d2d05 160 *
GregCr 0:e6ceb13d2d05 161 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 162 * @param [IN] bandwidth Sets the bandwidth
GregCr 0:e6ceb13d2d05 163 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 164 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 165 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 166 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 167 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 168 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 169 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 170 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 171 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 172 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 173 * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only )
GregCr 0:e6ceb13d2d05 174 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 175 * LoRa: N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 176 * @param [IN] preambleLen Sets the Preamble length ( LoRa only )
GregCr 0:e6ceb13d2d05 177 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 178 * LoRa: Length in symbols ( the hardware adds 4 more symbols )
GregCr 0:e6ceb13d2d05 179 * @param [IN] symbTimeout Sets the RxSingle timeout value ( LoRa only )
GregCr 0:e6ceb13d2d05 180 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 181 * LoRa: timeout in symbols
GregCr 0:e6ceb13d2d05 182 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
mluis 13:618826a997e2 183 * @param [IN] payloadLen Sets payload length when fixed lenght is used
GregCr 0:e6ceb13d2d05 184 * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 185 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 186 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 187 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 188 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 189 * LoRa: [0: not inverted, 1: inverted]
GregCr 0:e6ceb13d2d05 190 * @param [IN] rxContinuous Sets the reception in continuous mode
GregCr 0:e6ceb13d2d05 191 * [false: single mode, true: continuous mode]
GregCr 0:e6ceb13d2d05 192 */
GregCr 0:e6ceb13d2d05 193 virtual void SetRxConfig ( ModemType modem, uint32_t bandwidth,
GregCr 0:e6ceb13d2d05 194 uint32_t datarate, uint8_t coderate,
GregCr 0:e6ceb13d2d05 195 uint32_t bandwidthAfc, uint16_t preambleLen,
GregCr 0:e6ceb13d2d05 196 uint16_t symbTimeout, bool fixLen,
mluis 13:618826a997e2 197 uint8_t payloadLen,
mluis 13:618826a997e2 198 bool crcOn, bool freqHopOn, uint8_t hopPeriod,
GregCr 6:e7f02929cd3d 199 bool iqInverted, bool rxContinuous ) = 0;
GregCr 0:e6ceb13d2d05 200
mluis 13:618826a997e2 201 /*!
GregCr 0:e6ceb13d2d05 202 * @brief Sets the transmission parameters
GregCr 0:e6ceb13d2d05 203 *
GregCr 0:e6ceb13d2d05 204 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 205 * @param [IN] power Sets the output power [dBm]
GregCr 0:e6ceb13d2d05 206 * @param [IN] fdev Sets the frequency deviation ( FSK only )
GregCr 0:e6ceb13d2d05 207 * FSK : [Hz]
GregCr 0:e6ceb13d2d05 208 * LoRa: 0
GregCr 0:e6ceb13d2d05 209 * @param [IN] bandwidth Sets the bandwidth ( LoRa only )
GregCr 0:e6ceb13d2d05 210 * FSK : 0
GregCr 0:e6ceb13d2d05 211 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 212 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 213 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 214 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 215 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 216 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 217 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 218 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 219 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 220 * @param [IN] preambleLen Sets the preamble length
GregCr 0:e6ceb13d2d05 221 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
GregCr 0:e6ceb13d2d05 222 * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 223 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 224 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 225 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 226 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 227 * LoRa: [0: not inverted, 1: inverted]
GregCr 0:e6ceb13d2d05 228 * @param [IN] timeout Transmission timeout [us]
GregCr 0:e6ceb13d2d05 229 */
GregCr 0:e6ceb13d2d05 230 virtual void SetTxConfig( ModemType modem, int8_t power, uint32_t fdev,
GregCr 6:e7f02929cd3d 231 uint32_t bandwidth, uint32_t datarate,
GregCr 6:e7f02929cd3d 232 uint8_t coderate, uint16_t preambleLen,
mluis 13:618826a997e2 233 bool fixLen, bool crcOn, bool freqHopOn,
mluis 13:618826a997e2 234 uint8_t hopPeriod, bool iqInverted, uint32_t timeout ) = 0;
GregCr 0:e6ceb13d2d05 235
mluis 13:618826a997e2 236 /*!
GregCr 0:e6ceb13d2d05 237 * @brief Checks if the given RF frequency is supported by the hardware
GregCr 0:e6ceb13d2d05 238 *
GregCr 0:e6ceb13d2d05 239 * @param [IN] frequency RF frequency to be checked
GregCr 0:e6ceb13d2d05 240 * @retval isSupported [true: supported, false: unsupported]
GregCr 0:e6ceb13d2d05 241 */
GregCr 0:e6ceb13d2d05 242 virtual bool CheckRfFrequency( uint32_t frequency ) = 0;
GregCr 0:e6ceb13d2d05 243
mluis 13:618826a997e2 244 /*!
GregCr 0:e6ceb13d2d05 245 * @brief Computes the packet time on air for the given payload
GregCr 0:e6ceb13d2d05 246 *
GregCr 0:e6ceb13d2d05 247 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
GregCr 0:e6ceb13d2d05 248 *
GregCr 0:e6ceb13d2d05 249 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 250 * @param [IN] pktLen Packet payload length
GregCr 0:e6ceb13d2d05 251 *
GregCr 0:e6ceb13d2d05 252 * @retval airTime Computed airTime for the given packet payload length
GregCr 0:e6ceb13d2d05 253 */
GregCr 0:e6ceb13d2d05 254 virtual double TimeOnAir ( ModemType modem, uint8_t pktLen ) = 0;
GregCr 0:e6ceb13d2d05 255
mluis 13:618826a997e2 256 /*!
GregCr 0:e6ceb13d2d05 257 * @brief Sends the buffer of size. Prepares the packet to be sent and sets
GregCr 0:e6ceb13d2d05 258 * the radio in transmission
GregCr 0:e6ceb13d2d05 259 *
GregCr 0:e6ceb13d2d05 260 * @param [IN]: buffer Buffer pointer
GregCr 0:e6ceb13d2d05 261 * @param [IN]: size Buffer size
GregCr 0:e6ceb13d2d05 262 */
GregCr 0:e6ceb13d2d05 263 virtual void Send( uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 264
mluis 13:618826a997e2 265 /*!
GregCr 0:e6ceb13d2d05 266 * @brief Sets the radio in sleep mode
GregCr 0:e6ceb13d2d05 267 */
GregCr 0:e6ceb13d2d05 268 virtual void Sleep( void ) = 0;
GregCr 0:e6ceb13d2d05 269
mluis 13:618826a997e2 270 /*!
GregCr 0:e6ceb13d2d05 271 * @brief Sets the radio in standby mode
GregCr 0:e6ceb13d2d05 272 */
GregCr 7:2b555111463f 273 virtual void Standby( void ) = 0;
GregCr 7:2b555111463f 274
mluis 13:618826a997e2 275 /*!
GregCr 7:2b555111463f 276 * @brief Sets the radio in CAD mode
GregCr 7:2b555111463f 277 */
GregCr 7:2b555111463f 278 virtual void StartCad( void ) = 0;
GregCr 0:e6ceb13d2d05 279
mluis 13:618826a997e2 280 /*!
GregCr 0:e6ceb13d2d05 281 * @brief Sets the radio in reception mode for the given time
GregCr 0:e6ceb13d2d05 282 * @param [IN] timeout Reception timeout [us]
GregCr 0:e6ceb13d2d05 283 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 284 */
GregCr 0:e6ceb13d2d05 285 virtual void Rx( uint32_t timeout ) = 0;
GregCr 0:e6ceb13d2d05 286
mluis 13:618826a997e2 287 /*!
GregCr 0:e6ceb13d2d05 288 * @brief Sets the radio in transmission mode for the given time
GregCr 0:e6ceb13d2d05 289 * @param [IN] timeout Transmission timeout [us]
GregCr 0:e6ceb13d2d05 290 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 291 */
GregCr 0:e6ceb13d2d05 292 virtual void Tx( uint32_t timeout ) = 0;
GregCr 0:e6ceb13d2d05 293
mluis 13:618826a997e2 294 /*!
GregCr 0:e6ceb13d2d05 295 * @brief Reads the current RSSI value
GregCr 0:e6ceb13d2d05 296 *
GregCr 0:e6ceb13d2d05 297 * @retval rssiValue Current RSSI value in [dBm]
GregCr 0:e6ceb13d2d05 298 */
GregCr 7:2b555111463f 299 virtual int16_t GetRssi ( ModemType modem ) = 0;
GregCr 0:e6ceb13d2d05 300
mluis 13:618826a997e2 301 /*!
GregCr 0:e6ceb13d2d05 302 * @brief Writes the radio register at the specified address
GregCr 0:e6ceb13d2d05 303 *
GregCr 0:e6ceb13d2d05 304 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 305 * @param [IN]: data New register value
GregCr 0:e6ceb13d2d05 306 */
GregCr 0:e6ceb13d2d05 307 virtual void Write ( uint8_t addr, uint8_t data ) = 0;
GregCr 0:e6ceb13d2d05 308
mluis 13:618826a997e2 309 /*!
GregCr 0:e6ceb13d2d05 310 * @brief Reads the radio register at the specified address
GregCr 0:e6ceb13d2d05 311 *
GregCr 0:e6ceb13d2d05 312 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 313 * @retval data Register value
GregCr 0:e6ceb13d2d05 314 */
GregCr 0:e6ceb13d2d05 315 virtual uint8_t Read ( uint8_t addr ) = 0;
GregCr 0:e6ceb13d2d05 316
mluis 13:618826a997e2 317 /*!
GregCr 0:e6ceb13d2d05 318 * @brief Writes multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 319 *
GregCr 0:e6ceb13d2d05 320 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 321 * @param [IN] buffer Buffer containing the new register's values
GregCr 0:e6ceb13d2d05 322 * @param [IN] size Number of registers to be written
GregCr 0:e6ceb13d2d05 323 */
GregCr 0:e6ceb13d2d05 324 virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 325
mluis 13:618826a997e2 326 /*!
GregCr 0:e6ceb13d2d05 327 * @brief Reads multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 328 *
GregCr 0:e6ceb13d2d05 329 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 330 * @param [OUT] buffer Buffer where to copy the registers data
GregCr 0:e6ceb13d2d05 331 * @param [IN] size Number of registers to be read
GregCr 0:e6ceb13d2d05 332 */
GregCr 0:e6ceb13d2d05 333 virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
mluis 13:618826a997e2 334
mluis 13:618826a997e2 335 /*!
mluis 13:618826a997e2 336 * @brief Writes the buffer contents to the SX1276 FIFO
mluis 13:618826a997e2 337 *
mluis 13:618826a997e2 338 * @param [IN] buffer Buffer containing data to be put on the FIFO.
mluis 13:618826a997e2 339 * @param [IN] size Number of bytes to be written to the FIFO
mluis 13:618826a997e2 340 */
mluis 13:618826a997e2 341 virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 342
mluis 13:618826a997e2 343 /*!
mluis 13:618826a997e2 344 * @brief Reads the contents of the SX1276 FIFO
mluis 13:618826a997e2 345 *
mluis 13:618826a997e2 346 * @param [OUT] buffer Buffer where to copy the FIFO read data.
mluis 13:618826a997e2 347 * @param [IN] size Number of bytes to be read from the FIFO
mluis 13:618826a997e2 348 */
mluis 13:618826a997e2 349 virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 350 };
GregCr 0:e6ceb13d2d05 351
GregCr 0:e6ceb13d2d05 352 #endif // __RADIO_H__
GregCr 0:e6ceb13d2d05 353