Brendan Kelly / libmDot-mbed5

libMDot form for loop/dht22 project

Dependents:   mDot_LoRa_Connect_ABPA_DHT22_sleep mDot_LoRa_Connect_ABPA FrostyBoySensor mDot_LoRa_Connect_ABPA_Lux ... more

Fork of libmDot-mbed5 by MultiTech

SxRadio.h@63:af2fa55cbace, 2017-08-21 (annotated)

Committer:
kellybs1
Date:
Mon Aug 21 05:00:54 2017 +0000
Revision:
63:af2fa55cbace
Parent:
61:58ed1e136af5 
Working version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 1 /*
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 2 / _____) _ | |
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 3 ( (____ _____ ____ _| |_ _____ ____| |__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 5 _____) ) ____| | | || |_| ____( (___| | | |
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 7 (C)2013 Semtech
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 8
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 9 Description: Generic radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 10
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 11 License: Revised BSD License, see LICENSE.TXT file include in the project
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 12
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 13 Maintainer: Miguel Luis and Gregory Cristian
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 14 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 15 #ifndef __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 16 #define __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 17
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 18 #include <stdint.h>
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 19 #include "rtos.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 20 #include "SxRadioEvents.h"
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 21
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 22 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 23 * \brief Radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 24 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 25 class SxRadio
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 26 {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 27 public:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 28 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 29 * Radio driver supported modems
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 30 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 31 typedef enum
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 32 {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 33 MODEM_FSK = 0,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 34 MODEM_LORA,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 35 }RadioModems_t;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 36
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 37 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 38 * Radio driver internal state machine states definition
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 39 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 40 typedef enum
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 41 {
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 42 RF_IDLE = 0,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 43 RF_RX_RUNNING,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 44 RF_TX_RUNNING,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 45 RF_CAD,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 46 }RadioState_t;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 47
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 48 SxRadio(uint32_t WakeupTime) : WakeupTime(WakeupTime), State(RF_IDLE), Modem(MODEM_LORA) { }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 49 virtual ~SxRadio() {};
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 50
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 51 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 52 * \brief Initializes the radio
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 53 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 54 * \param [IN] events Structure containing the driver callback functions
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 55 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 56 virtual void Init( SxRadioEvents *events ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 57 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 58 * \brief Prepares the radio for destruction
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 59 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 60 virtual void Terminate( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 61 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 62 * Return current radio status
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 63 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 64 * \param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 65 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 66 virtual RadioState_t Status( void ) { return State; }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 67 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 68 * \brief Configures the radio with the given modem
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 69 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 70 * \param [IN] modem Modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 71 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 72 virtual void SetModem( RadioModems_t modem ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 73 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 74 * \brief Sets the channel frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 75 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 76 * \param [IN] freq Channel RF frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 77 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 78 virtual void SetChannel( uint32_t freq ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 79 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 80 * \brief Sets the channels configuration
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 81 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 82 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 83 * \param [IN] freq Channel RF frequency
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 84 * \param [IN] rssiThresh RSSI threshold
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 85 * \param [IN] rssiVal pointer to variable to hold RSSI value if desired - ignored if NULL
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 86 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 87 * \retval isFree [true: Channel is free, false: Channel is not free]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 88 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 89 virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, uint8_t datarate, int16_t rssiThresh, uint8_t bandwidth, uint32_t timeout = 5000, int16_t *rssiVal = NULL ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 90 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 91 * \brief Generates a 32 bits random value based on the RSSI readings
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 92 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 93 * \remark This function sets the radio in LoRa modem mode and disables
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 94 * all interrupts.
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 95 * After calling this function either Radio.SetRxConfig or
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 96 * Radio.SetTxConfig functions must be called.
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 97 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 98 * \retval randomValue 32 bits random value
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 99 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 100 virtual uint32_t Random( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 101 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 102 * \brief Sets the reception parameters
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 103 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 104 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 105 * \param [IN] bandwidth Sets the bandwidth
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 106 * FSK : >= 2600 and <= 250000 Hz
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 107 * LoRa: [0: 125 kHz, 1: 250 kHz,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 108 * 2: 500 kHz, 3: Reserved]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 109 * \param [IN] datarate Sets the Datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 110 * FSK : 600..300000 bits/s
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 111 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 112 * 10: 1024, 11: 2048, 12: 4096 chips]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 113 * \param [IN] coderate Sets the coding rate (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 114 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 115 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 116 * \param [IN] bandwidthAfc Sets the AFC Bandwidth (FSK only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 117 * FSK : >= 2600 and <= 250000 Hz
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 118 * LoRa: N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 119 * \param [IN] preambleLen Sets the Preamble length
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 120 * FSK : Number of bytes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 121 * LoRa: Length in symbols (the hardware adds 4 more symbols)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 122 * \param [IN] symbTimeout Sets the RxSingle timeout value (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 123 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 124 * LoRa: timeout in symbols
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 125 * \param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 126 * \param [IN] payloadLen Sets payload length when fixed length is used
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 127 * \param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 128 * \param [IN] FreqHopOn Enables disables the intra-packet frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 129 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 130 * LoRa: [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 131 * \param [IN] HopPeriod Number of symbols bewteen each hop
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 132 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 133 * LoRa: Number of symbols
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 134 * \param [IN] iqInverted Inverts IQ signals (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 135 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 136 * LoRa: [0: not inverted, 1: inverted]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 137 * \param [IN] rxContinuous Sets the reception in continuous mode
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 138 * [false: single mode, true: continuous mode]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 139 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 140 virtual void SetRxConfig( RadioModems_t modem, uint32_t bandwidth,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 141 uint32_t datarate, uint8_t coderate,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 142 uint32_t bandwidthAfc, uint16_t preambleLen,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 143 uint16_t symbTimeout, bool fixLen,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 144 uint8_t payloadLen,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 145 bool crcOn, bool FreqHopOn, uint8_t HopPeriod,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 146 bool iqInverted, bool rxContinuous ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 147 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 148 * \brief Sets the transmission parameters
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 149 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 150 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 151 * \param [IN] power Sets the output power [dBm]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 152 * \param [IN] fdev Sets the frequency deviation (FSK only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 153 * FSK : [Hz]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 154 * LoRa: 0
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 155 * \param [IN] bandwidth Sets the bandwidth (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 156 * FSK : 0
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 157 * LoRa: [0: 125 kHz, 1: 250 kHz,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 158 * 2: 500 kHz, 3: Reserved]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 159 * \param [IN] datarate Sets the Datarate
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 160 * FSK : 600..300000 bits/s
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 161 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 162 * 10: 1024, 11: 2048, 12: 4096 chips]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 163 * \param [IN] coderate Sets the coding rate (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 164 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 165 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 166 * \param [IN] preambleLen Sets the preamble length
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 167 * FSK : Number of bytes
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 168 * LoRa: Length in symbols (the hardware adds 4 more symbols)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 169 * \param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 170 * \param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 171 * \param [IN] FreqHopOn Enables disables the intra-packet frequency hopping
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 172 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 173 * LoRa: [0: OFF, 1: ON]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 174 * \param [IN] HopPeriod Number of symbols bewteen each hop
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 175 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 176 * LoRa: Number of symbols
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 177 * \param [IN] iqInverted Inverts IQ signals (LoRa only)
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 178 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 179 * LoRa: [0: not inverted, 1: inverted]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 180 * \param [IN] timeout Transmission timeout [us]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 181 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 182 virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 183 uint32_t bandwidth, uint32_t datarate,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 184 uint8_t coderate, uint16_t preambleLen,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 185 bool fixLen, bool crcOn, bool FreqHopOn,
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 186 uint8_t HopPeriod, bool iqInverted, uint32_t timeout ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 187
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 188 virtual void SetTxContinuous(bool enable) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 189
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 190 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 191 * \brief Checks if the given RF frequency is supported by the hardware
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 192 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 193 * \param [IN] frequency RF frequency to be checked
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 194 * \retval isSupported [true: supported, false: unsupported]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 195 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 196 virtual bool CheckRfFrequency( uint32_t frequency ) { return true; }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 197 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 198 * \brief Computes the packet time on air for the given payload
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 199 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 200 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 201 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 202 * \param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 203 * \param [IN] pktLen Packet payload length
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 204 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 205 * \retval airTime Computed airTime for the given packet payload length
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 206 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 207 virtual double TimeOnAir( RadioModems_t modem, uint8_t pktLen ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 208 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 209 * \brief Sends the buffer of size. Prepares the packet to be sent and sets
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 210 * the radio in transmission
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 211 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 212 * \param [IN]: buffer Buffer pointer
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 213 * \param [IN]: size Buffer size
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 214 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 215 virtual void Send( const uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 216 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 217 * \brief Sets the radio in sleep mode
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 218 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 219 virtual void Sleep( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 220 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 221 * \brief Sets the radio in standby mode
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 222 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 223 virtual void Standby( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 224 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 225 * \brief Sets the radio in reception mode for the given time
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 226 * \param [IN] timeout Reception timeout [us]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 227 * [0: continuous, others timeout]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 228 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 229 virtual void Rx( uint32_t timeout ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 230 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 231 * \brief Start a Channel Activity Detection
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 232 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 233 virtual void StartCad( void ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 234 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 235 * \brief Reads the current RSSI value
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 236 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 237 * \retval rssiValue Current RSSI value in [dBm]
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 238 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 239 virtual int16_t Rssi( RadioModems_t modem ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 240 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 241 * \brief Writes the radio register at the specified address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 242 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 243 * \param [IN]: addr Register address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 244 * \param [IN]: data New register value
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 245 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 246 virtual void Write( uint8_t addr, uint8_t data ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 247 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 248 * \brief Reads the radio register at the specified address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 249 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 250 * \param [IN]: addr Register address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 251 * \retval data Register value
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 252 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 253 virtual uint8_t Read ( uint8_t addr ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 254 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 255 * \brief Writes multiple radio registers starting at address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 256 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 257 * \param [IN] addr First Radio register address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 258 * \param [IN] buffer Buffer containing the new register's values
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 259 * \param [IN] size Number of registers to be written
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 260 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 261 virtual void WriteBuffer( uint8_t addr, const uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 262 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 263 * \brief Reads multiple radio registers starting at address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 264 *
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 265 * \param [IN] addr First Radio register address
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 266 * \param [OUT] buffer Buffer where to copy the registers data
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 267 * \param [IN] size Number of registers to be read
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 268 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 269 virtual void ReadBuffer( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 270
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 271 virtual void SignalMacEvent(void) {};
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 272
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 273 void GrabMutex(void) { mutex.lock(); }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 274 void ReleaseMutex(void) { mutex.unlock(); }
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 275
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 276 const uint32_t WakeupTime;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 277
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 278 protected:
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 279 RadioState_t State;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 280
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 281 RadioModems_t Modem;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 282
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 283 /*!
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 284 * Access protection
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 285 */
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 286 Mutex mutex;
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 287 };
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 288
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 289 #endif // __SXRADIO_H__
Jenkins@KEILDM1.dc.multitech.prv 61:58ed1e136af5 290