Semtech / SX1280Lib

Driver for the SX1280 RF Transceiver

Dependents:   SX1280PingPong RangignMaster RangingSlave MSNV2-Terminal_V1-6 ... more

sx1280.h@12:c4f110f3fe3e, 2018-11-08 (annotated)

Committer:
mverdy
Date:
Thu Nov 08 10:08:44 2018 +0000
Revision:
12:c4f110f3fe3e
Parent:
11:d60df50e108f 
Synchronze driver on v1.3.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
GregCr 0:03ec2f3bde8c 1 /*
GregCr 0:03ec2f3bde8c 2 ______ _
GregCr 0:03ec2f3bde8c 3 / _____) _ | |
GregCr 0:03ec2f3bde8c 4 ( (____ _____ ____ _| |_ _____ ____| |__
GregCr 0:03ec2f3bde8c 5 \____ \| ___ | (_ _) ___ |/ ___) _ \
GregCr 0:03ec2f3bde8c 6 _____) ) ____| | | || |_| ____( (___| | | |
GregCr 0:03ec2f3bde8c 7 (______/|_____)_|_|_| \__)_____)\____)_| |_|
GregCr 0:03ec2f3bde8c 8 (C)2016 Semtech
GregCr 0:03ec2f3bde8c 9
GregCr 0:03ec2f3bde8c 10 Description: Driver for SX1280 devices
GregCr 0:03ec2f3bde8c 11
GregCr 0:03ec2f3bde8c 12 License: Revised BSD License, see LICENSE.TXT file include in the project
GregCr 0:03ec2f3bde8c 13
GregCr 0:03ec2f3bde8c 14 Maintainer: Miguel Luis, Gregory Cristian and Matthieu Verdy
GregCr 0:03ec2f3bde8c 15 */
GregCr 0:03ec2f3bde8c 16 #ifndef __SX1280_H__
GregCr 0:03ec2f3bde8c 17 #define __SX1280_H__
GregCr 0:03ec2f3bde8c 18
GregCr 0:03ec2f3bde8c 19 #include "radio.h"
GregCr 0:03ec2f3bde8c 20
GregCr 0:03ec2f3bde8c 21 /*!
GregCr 0:03ec2f3bde8c 22 * \brief Enables/disables driver debug features
GregCr 0:03ec2f3bde8c 23 */
GregCr 0:03ec2f3bde8c 24 #define SX1280_DEBUG 0
GregCr 0:03ec2f3bde8c 25
GregCr 0:03ec2f3bde8c 26 /*!
GregCr 0:03ec2f3bde8c 27 * \brief Hardware IO IRQ callback function definition
GregCr 0:03ec2f3bde8c 28 */
GregCr 0:03ec2f3bde8c 29 class SX1280;
GregCr 0:03ec2f3bde8c 30 typedef void ( SX1280::*DioIrqHandler )( void );
GregCr 0:03ec2f3bde8c 31
GregCr 0:03ec2f3bde8c 32 /*!
GregCr 0:03ec2f3bde8c 33 * \brief IRQ triggers callback function definition
GregCr 0:03ec2f3bde8c 34 */
GregCr 0:03ec2f3bde8c 35 class SX1280Hal;
GregCr 0:03ec2f3bde8c 36 typedef void ( SX1280Hal::*Trigger )( void );
GregCr 0:03ec2f3bde8c 37
GregCr 0:03ec2f3bde8c 38 /*!
GregCr 0:03ec2f3bde8c 39 * \brief Provides the frequency of the chip running on the radio and the frequency step
GregCr 0:03ec2f3bde8c 40 *
GregCr 0:03ec2f3bde8c 41 * \remark These defines are used for computing the frequency divider to set the RF frequency
GregCr 0:03ec2f3bde8c 42 */
GregCr 0:03ec2f3bde8c 43 #define XTAL_FREQ 52000000
GregCr 0:03ec2f3bde8c 44 #define FREQ_STEP ( ( double )( XTAL_FREQ / pow( 2.0, 18.0 ) ) )
GregCr 0:03ec2f3bde8c 45
GregCr 0:03ec2f3bde8c 46 /*!
GregCr 0:03ec2f3bde8c 47 * \brief Compensation delay for SetAutoTx method in microseconds
GregCr 0:03ec2f3bde8c 48 */
GregCr 0:03ec2f3bde8c 49 #define AUTO_TX_OFFSET 33
GregCr 0:03ec2f3bde8c 50
GregCr 0:03ec2f3bde8c 51 /*!
mverdy 9:3e5535d2cc1c 52 * \brief The address of the register holding the firmware version MSB
mverdy 9:3e5535d2cc1c 53 */
mverdy 9:3e5535d2cc1c 54 #define REG_LR_FIRMWARE_VERSION_MSB 0x0153
mverdy 9:3e5535d2cc1c 55
mverdy 9:3e5535d2cc1c 56 /*!
GregCr 0:03ec2f3bde8c 57 * \brief The address of the register holding the first byte defining the CRC seed
GregCr 0:03ec2f3bde8c 58 *
GregCr 0:03ec2f3bde8c 59 * \remark Only used for packet types GFSK and Flrc
GregCr 0:03ec2f3bde8c 60 */
GregCr 0:03ec2f3bde8c 61 #define REG_LR_CRCSEEDBASEADDR 0x09C8
GregCr 0:03ec2f3bde8c 62
GregCr 0:03ec2f3bde8c 63 /*!
GregCr 0:03ec2f3bde8c 64 * \brief The address of the register holding the first byte defining the CRC polynomial
GregCr 0:03ec2f3bde8c 65 *
GregCr 0:03ec2f3bde8c 66 * \remark Only used for packet types GFSK and Flrc
GregCr 0:03ec2f3bde8c 67 */
GregCr 0:03ec2f3bde8c 68 #define REG_LR_CRCPOLYBASEADDR 0x09C6
GregCr 0:03ec2f3bde8c 69
GregCr 0:03ec2f3bde8c 70 /*!
GregCr 0:03ec2f3bde8c 71 * \brief The address of the register holding the first byte defining the whitening seed
GregCr 0:03ec2f3bde8c 72 *
GregCr 0:03ec2f3bde8c 73 * \remark Only used for packet types GFSK, FLRC and BLE
GregCr 0:03ec2f3bde8c 74 */
GregCr 0:03ec2f3bde8c 75 #define REG_LR_WHITSEEDBASEADDR 0x09C5
GregCr 0:03ec2f3bde8c 76
GregCr 0:03ec2f3bde8c 77 /*!
GregCr 0:03ec2f3bde8c 78 * \brief The address of the register holding the ranging id check length
GregCr 0:03ec2f3bde8c 79 *
GregCr 0:03ec2f3bde8c 80 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 81 */
GregCr 0:03ec2f3bde8c 82 #define REG_LR_RANGINGIDCHECKLENGTH 0x0931
GregCr 0:03ec2f3bde8c 83
GregCr 0:03ec2f3bde8c 84 /*!
GregCr 0:03ec2f3bde8c 85 * \brief The address of the register holding the device ranging id
GregCr 0:03ec2f3bde8c 86 *
GregCr 0:03ec2f3bde8c 87 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 88 */
GregCr 0:03ec2f3bde8c 89 #define REG_LR_DEVICERANGINGADDR 0x0916
GregCr 0:03ec2f3bde8c 90
GregCr 0:03ec2f3bde8c 91 /*!
GregCr 0:03ec2f3bde8c 92 * \brief The address of the register holding the device ranging id
GregCr 0:03ec2f3bde8c 93 *
GregCr 0:03ec2f3bde8c 94 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 95 */
GregCr 0:03ec2f3bde8c 96 #define REG_LR_REQUESTRANGINGADDR 0x0912
GregCr 0:03ec2f3bde8c 97
GregCr 0:03ec2f3bde8c 98 /*!
GregCr 0:03ec2f3bde8c 99 * \brief The address of the register holding ranging results configuration
GregCr 0:03ec2f3bde8c 100 * and the corresponding mask
GregCr 0:03ec2f3bde8c 101 *
GregCr 0:03ec2f3bde8c 102 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 103 */
GregCr 0:03ec2f3bde8c 104 #define REG_LR_RANGINGRESULTCONFIG 0x0924
GregCr 0:03ec2f3bde8c 105 #define MASK_RANGINGMUXSEL 0xCF
GregCr 0:03ec2f3bde8c 106
GregCr 0:03ec2f3bde8c 107 /*!
GregCr 0:03ec2f3bde8c 108 * \brief The address of the register holding the first byte of ranging results
GregCr 0:03ec2f3bde8c 109 * Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 110 */
GregCr 0:03ec2f3bde8c 111 #define REG_LR_RANGINGRESULTBASEADDR 0x0961
GregCr 0:03ec2f3bde8c 112
GregCr 0:03ec2f3bde8c 113 /*!
GregCr 0:03ec2f3bde8c 114 * \brief The address of the register allowing to read ranging results
GregCr 0:03ec2f3bde8c 115 *
GregCr 0:03ec2f3bde8c 116 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 117 */
GregCr 0:03ec2f3bde8c 118 #define REG_LR_RANGINGRESULTSFREEZE 0x097F
GregCr 0:03ec2f3bde8c 119
GregCr 0:03ec2f3bde8c 120 /*!
GregCr 0:03ec2f3bde8c 121 * \brief The address of the register holding the first byte of ranging calibration
GregCr 0:03ec2f3bde8c 122 *
GregCr 0:03ec2f3bde8c 123 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 124 */
GregCr 0:03ec2f3bde8c 125 #define REG_LR_RANGINGRERXTXDELAYCAL 0x092C
GregCr 0:03ec2f3bde8c 126
GregCr 0:03ec2f3bde8c 127 /*!
GregCr 0:03ec2f3bde8c 128 *\brief The address of the register holding the ranging filter window size
GregCr 0:03ec2f3bde8c 129 *
GregCr 0:03ec2f3bde8c 130 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 131 */
GregCr 0:03ec2f3bde8c 132 #define REG_LR_RANGINGFILTERWINDOWSIZE 0x091E
GregCr 0:03ec2f3bde8c 133
GregCr 0:03ec2f3bde8c 134 /*!
GregCr 0:03ec2f3bde8c 135 *\brief The address of the register to reset for clearing ranging filter
GregCr 0:03ec2f3bde8c 136 *
GregCr 0:03ec2f3bde8c 137 * \remark Only used for packet type Ranging
GregCr 0:03ec2f3bde8c 138 */
GregCr 0:03ec2f3bde8c 139 #define REG_LR_RANGINGRESULTCLEARREG 0x0923
GregCr 0:03ec2f3bde8c 140
mverdy 12:c4f110f3fe3e 141
mverdy 12:c4f110f3fe3e 142 #define REG_RANGING_RSSI 0x0964
mverdy 12:c4f110f3fe3e 143
GregCr 0:03ec2f3bde8c 144 /*!
GregCr 0:03ec2f3bde8c 145 * \brief The default number of samples considered in built-in ranging filter
GregCr 0:03ec2f3bde8c 146 */
GregCr 0:03ec2f3bde8c 147 #define DEFAULT_RANGING_FILTER_SIZE 127
GregCr 0:03ec2f3bde8c 148
GregCr 0:03ec2f3bde8c 149 /*!
GregCr 0:03ec2f3bde8c 150 * \brief The address of the register holding LORA packet parameters
GregCr 0:03ec2f3bde8c 151 */
GregCr 0:03ec2f3bde8c 152 #define REG_LR_PACKETPARAMS 0x903
GregCr 0:03ec2f3bde8c 153
GregCr 0:03ec2f3bde8c 154 /*!
GregCr 0:03ec2f3bde8c 155 * \brief The address of the register holding payload length
GregCr 0:03ec2f3bde8c 156 *
GregCr 0:03ec2f3bde8c 157 * \remark Do NOT try to read it directly. Use GetRxBuffer( ) instead.
GregCr 0:03ec2f3bde8c 158 */
GregCr 0:03ec2f3bde8c 159 #define REG_LR_PAYLOADLENGTH 0x901
GregCr 0:03ec2f3bde8c 160
GregCr 0:03ec2f3bde8c 161 /*!
GregCr 0:03ec2f3bde8c 162 * \brief The addresses of the registers holding SyncWords values
GregCr 0:03ec2f3bde8c 163 *
GregCr 0:03ec2f3bde8c 164 * \remark The addresses depends on the Packet Type in use, and not all
GregCr 0:03ec2f3bde8c 165 * SyncWords are available for every Packet Type
GregCr 0:03ec2f3bde8c 166 */
GregCr 0:03ec2f3bde8c 167 #define REG_LR_SYNCWORDBASEADDRESS1 0x09CE
GregCr 0:03ec2f3bde8c 168 #define REG_LR_SYNCWORDBASEADDRESS2 0x09D3
GregCr 0:03ec2f3bde8c 169 #define REG_LR_SYNCWORDBASEADDRESS3 0x09D8
GregCr 0:03ec2f3bde8c 170
GregCr 0:03ec2f3bde8c 171 /*!
GregCr 0:03ec2f3bde8c 172 * \brief The MSB address and mask used to read the estimated frequency
GregCr 0:03ec2f3bde8c 173 * error
GregCr 0:03ec2f3bde8c 174 */
GregCr 0:03ec2f3bde8c 175 #define REG_LR_ESTIMATED_FREQUENCY_ERROR_MSB 0x0954
GregCr 0:03ec2f3bde8c 176 #define REG_LR_ESTIMATED_FREQUENCY_ERROR_MASK 0x0FFFFF
GregCr 0:03ec2f3bde8c 177
GregCr 0:03ec2f3bde8c 178 /*!
GregCr 0:03ec2f3bde8c 179 * \brief Defines how many bit errors are tolerated in sync word detection
GregCr 0:03ec2f3bde8c 180 */
GregCr 0:03ec2f3bde8c 181 #define REG_LR_SYNCWORDTOLERANCE 0x09CD
GregCr 0:03ec2f3bde8c 182
GregCr 0:03ec2f3bde8c 183 /*!
GregCr 4:abf14b677777 184 * \brief Register and mask for GFSK and BLE preamble length forcing
GregCr 4:abf14b677777 185 */
GregCr 4:abf14b677777 186 #define REG_LR_PREAMBLELENGTH 0x09C1
GregCr 4:abf14b677777 187 #define MASK_FORCE_PREAMBLELENGTH 0x8F
GregCr 4:abf14b677777 188
GregCr 4:abf14b677777 189 /*!
mverdy 10:c1b368a5052f 190 * \brief Register for MSB Access Address (BLE)
mverdy 10:c1b368a5052f 191 */
mverdy 10:c1b368a5052f 192 #define REG_LR_BLE_ACCESS_ADDRESS 0x09CF
mverdy 10:c1b368a5052f 193 #define BLE_ADVERTIZER_ACCESS_ADDRESS 0x8E89BED6
mverdy 10:c1b368a5052f 194
mverdy 10:c1b368a5052f 195 /*!
GregCr 11:d60df50e108f 196 * \brief Select high sensitivity versus power consumption
GregCr 11:d60df50e108f 197 */
mverdy 12:c4f110f3fe3e 198 #define REG_LNA_REGIME 0x0891
mverdy 12:c4f110f3fe3e 199 #define MASK_LNA_REGIME 0xC0
mverdy 12:c4f110f3fe3e 200
mverdy 12:c4f110f3fe3e 201 /*
mverdy 12:c4f110f3fe3e 202 * \brief Register and mask controling the enabling of manual gain control
mverdy 12:c4f110f3fe3e 203 */
mverdy 12:c4f110f3fe3e 204 #define REG_ENABLE_MANUAL_GAIN_CONTROL 0x089F
mverdy 12:c4f110f3fe3e 205 #define MASK_MANUAL_GAIN_CONTROL 0x80
mverdy 12:c4f110f3fe3e 206
mverdy 12:c4f110f3fe3e 207 /*!
mverdy 12:c4f110f3fe3e 208 * \brief Register and mask controling the demodulation detection
mverdy 12:c4f110f3fe3e 209 */
mverdy 12:c4f110f3fe3e 210 #define REG_DEMOD_DETECTION 0x0895
mverdy 12:c4f110f3fe3e 211 #define MASK_DEMOD_DETECTION 0xFE
mverdy 12:c4f110f3fe3e 212
mverdy 12:c4f110f3fe3e 213 /*!
mverdy 12:c4f110f3fe3e 214 * Register and mask to set the manual gain parameter
mverdy 12:c4f110f3fe3e 215 */
mverdy 12:c4f110f3fe3e 216 #define REG_MANUAL_GAIN_VALUE 0x089E
mverdy 12:c4f110f3fe3e 217 #define MASK_MANUAL_GAIN_VALUE 0xF0
GregCr 11:d60df50e108f 218
GregCr 11:d60df50e108f 219 /*!
GregCr 0:03ec2f3bde8c 220 * \brief Represents the states of the radio
GregCr 0:03ec2f3bde8c 221 */
GregCr 0:03ec2f3bde8c 222 typedef enum
GregCr 0:03ec2f3bde8c 223 {
GregCr 0:03ec2f3bde8c 224 RF_IDLE = 0x00, //!< The radio is idle
GregCr 0:03ec2f3bde8c 225 RF_RX_RUNNING, //!< The radio is in reception state
GregCr 0:03ec2f3bde8c 226 RF_TX_RUNNING, //!< The radio is in transmission state
GregCr 0:03ec2f3bde8c 227 RF_CAD, //!< The radio is doing channel activity detection
GregCr 0:03ec2f3bde8c 228 }RadioStates_t;
GregCr 0:03ec2f3bde8c 229
GregCr 0:03ec2f3bde8c 230 /*!
GregCr 0:03ec2f3bde8c 231 * \brief Represents the operating mode the radio is actually running
GregCr 0:03ec2f3bde8c 232 */
GregCr 0:03ec2f3bde8c 233 typedef enum
GregCr 0:03ec2f3bde8c 234 {
GregCr 0:03ec2f3bde8c 235 MODE_SLEEP = 0x00, //! The radio is in sleep mode
GregCr 0:03ec2f3bde8c 236 MODE_CALIBRATION, //! The radio is in calibration mode
GregCr 0:03ec2f3bde8c 237 MODE_STDBY_RC, //! The radio is in standby mode with RC oscillator
GregCr 0:03ec2f3bde8c 238 MODE_STDBY_XOSC, //! The radio is in standby mode with XOSC oscillator
GregCr 0:03ec2f3bde8c 239 MODE_FS, //! The radio is in frequency synthesis mode
GregCr 0:03ec2f3bde8c 240 MODE_RX, //! The radio is in receive mode
GregCr 0:03ec2f3bde8c 241 MODE_TX, //! The radio is in transmit mode
GregCr 0:03ec2f3bde8c 242 MODE_CAD //! The radio is in channel activity detection mode
GregCr 0:03ec2f3bde8c 243 }RadioOperatingModes_t;
GregCr 0:03ec2f3bde8c 244
GregCr 0:03ec2f3bde8c 245 /*!
GregCr 0:03ec2f3bde8c 246 * \brief Declares the oscillator in use while in standby mode
GregCr 0:03ec2f3bde8c 247 *
GregCr 0:03ec2f3bde8c 248 * Using the STDBY_RC standby mode allow to reduce the energy consumption
GregCr 0:03ec2f3bde8c 249 * STDBY_XOSC should be used for time critical applications
GregCr 0:03ec2f3bde8c 250 */
GregCr 0:03ec2f3bde8c 251 typedef enum
GregCr 0:03ec2f3bde8c 252 {
GregCr 0:03ec2f3bde8c 253 STDBY_RC = 0x00,
GregCr 0:03ec2f3bde8c 254 STDBY_XOSC = 0x01,
GregCr 0:03ec2f3bde8c 255 }RadioStandbyModes_t;
GregCr 0:03ec2f3bde8c 256
GregCr 0:03ec2f3bde8c 257 /*!
GregCr 0:03ec2f3bde8c 258 * \brief Declares the power regulation used to power the device
GregCr 0:03ec2f3bde8c 259 *
GregCr 0:03ec2f3bde8c 260 * This command allows the user to specify if DC-DC or LDO is used for power regulation.
GregCr 0:03ec2f3bde8c 261 * Using only LDO implies that the Rx or Tx current is doubled
GregCr 0:03ec2f3bde8c 262 */
GregCr 0:03ec2f3bde8c 263 typedef enum
GregCr 0:03ec2f3bde8c 264 {
GregCr 4:abf14b677777 265 USE_LDO = 0x00, //! Use LDO (default value)
GregCr 4:abf14b677777 266 USE_DCDC = 0x01, //! Use DCDC
GregCr 0:03ec2f3bde8c 267 }RadioRegulatorModes_t;
GregCr 0:03ec2f3bde8c 268
GregCr 0:03ec2f3bde8c 269 /*!
GregCr 0:03ec2f3bde8c 270 * \brief Represents the possible packet type (i.e. modem) used
GregCr 0:03ec2f3bde8c 271 */
GregCr 0:03ec2f3bde8c 272 typedef enum
GregCr 0:03ec2f3bde8c 273 {
GregCr 0:03ec2f3bde8c 274 PACKET_TYPE_GFSK = 0x00,
GregCr 0:03ec2f3bde8c 275 PACKET_TYPE_LORA,
GregCr 0:03ec2f3bde8c 276 PACKET_TYPE_RANGING,
GregCr 0:03ec2f3bde8c 277 PACKET_TYPE_FLRC,
GregCr 0:03ec2f3bde8c 278 PACKET_TYPE_BLE,
GregCr 0:03ec2f3bde8c 279 PACKET_TYPE_NONE = 0x0F,
GregCr 0:03ec2f3bde8c 280 }RadioPacketTypes_t;
GregCr 0:03ec2f3bde8c 281
GregCr 0:03ec2f3bde8c 282 /*!
GregCr 0:03ec2f3bde8c 283 * \brief Represents the ramping time for power amplifier
GregCr 0:03ec2f3bde8c 284 */
GregCr 0:03ec2f3bde8c 285 typedef enum
GregCr 0:03ec2f3bde8c 286 {
GregCr 0:03ec2f3bde8c 287 RADIO_RAMP_02_US = 0x00,
GregCr 0:03ec2f3bde8c 288 RADIO_RAMP_04_US = 0x20,
GregCr 0:03ec2f3bde8c 289 RADIO_RAMP_06_US = 0x40,
GregCr 0:03ec2f3bde8c 290 RADIO_RAMP_08_US = 0x60,
GregCr 0:03ec2f3bde8c 291 RADIO_RAMP_10_US = 0x80,
GregCr 0:03ec2f3bde8c 292 RADIO_RAMP_12_US = 0xA0,
GregCr 0:03ec2f3bde8c 293 RADIO_RAMP_16_US = 0xC0,
GregCr 0:03ec2f3bde8c 294 RADIO_RAMP_20_US = 0xE0,
GregCr 0:03ec2f3bde8c 295 }RadioRampTimes_t;
GregCr 0:03ec2f3bde8c 296
GregCr 0:03ec2f3bde8c 297 /*!
GregCr 0:03ec2f3bde8c 298 * \brief Represents the number of symbols to be used for channel activity detection operation
GregCr 0:03ec2f3bde8c 299 */
GregCr 0:03ec2f3bde8c 300 typedef enum
GregCr 0:03ec2f3bde8c 301 {
GregCr 0:03ec2f3bde8c 302 LORA_CAD_01_SYMBOL = 0x00,
GregCr 4:abf14b677777 303 LORA_CAD_02_SYMBOLS = 0x20,
GregCr 4:abf14b677777 304 LORA_CAD_04_SYMBOLS = 0x40,
GregCr 4:abf14b677777 305 LORA_CAD_08_SYMBOLS = 0x60,
GregCr 4:abf14b677777 306 LORA_CAD_16_SYMBOLS = 0x80,
GregCr 0:03ec2f3bde8c 307 }RadioLoRaCadSymbols_t;
GregCr 0:03ec2f3bde8c 308
GregCr 0:03ec2f3bde8c 309 /*!
GregCr 0:03ec2f3bde8c 310 * \brief Represents the possible combinations of bitrate and bandwidth for
GregCr 0:03ec2f3bde8c 311 * GFSK and BLE packet types
GregCr 0:03ec2f3bde8c 312 *
GregCr 0:03ec2f3bde8c 313 * The bitrate is expressed in Mb/s and the bandwidth in MHz
GregCr 0:03ec2f3bde8c 314 */
GregCr 0:03ec2f3bde8c 315 typedef enum
GregCr 0:03ec2f3bde8c 316 {
GregCr 0:03ec2f3bde8c 317 GFSK_BLE_BR_2_000_BW_2_4 = 0x04,
GregCr 0:03ec2f3bde8c 318 GFSK_BLE_BR_1_600_BW_2_4 = 0x28,
GregCr 0:03ec2f3bde8c 319 GFSK_BLE_BR_1_000_BW_2_4 = 0x4C,
GregCr 0:03ec2f3bde8c 320 GFSK_BLE_BR_1_000_BW_1_2 = 0x45,
GregCr 0:03ec2f3bde8c 321 GFSK_BLE_BR_0_800_BW_2_4 = 0x70,
GregCr 0:03ec2f3bde8c 322 GFSK_BLE_BR_0_800_BW_1_2 = 0x69,
GregCr 0:03ec2f3bde8c 323 GFSK_BLE_BR_0_500_BW_1_2 = 0x8D,
GregCr 0:03ec2f3bde8c 324 GFSK_BLE_BR_0_500_BW_0_6 = 0x86,
GregCr 0:03ec2f3bde8c 325 GFSK_BLE_BR_0_400_BW_1_2 = 0xB1,
GregCr 0:03ec2f3bde8c 326 GFSK_BLE_BR_0_400_BW_0_6 = 0xAA,
GregCr 0:03ec2f3bde8c 327 GFSK_BLE_BR_0_250_BW_0_6 = 0xCE,
GregCr 0:03ec2f3bde8c 328 GFSK_BLE_BR_0_250_BW_0_3 = 0xC7,
GregCr 0:03ec2f3bde8c 329 GFSK_BLE_BR_0_125_BW_0_3 = 0xEF,
GregCr 0:03ec2f3bde8c 330 }RadioGfskBleBitrates_t;
GregCr 0:03ec2f3bde8c 331
GregCr 0:03ec2f3bde8c 332 /*!
GregCr 0:03ec2f3bde8c 333 * \brief Represents the modulation index used in GFSK and BLE packet
GregCr 0:03ec2f3bde8c 334 * types
GregCr 0:03ec2f3bde8c 335 */
GregCr 0:03ec2f3bde8c 336 typedef enum
GregCr 0:03ec2f3bde8c 337 {
GregCr 0:03ec2f3bde8c 338 GFSK_BLE_MOD_IND_0_35 = 0,
GregCr 0:03ec2f3bde8c 339 GFSK_BLE_MOD_IND_0_50 = 1,
GregCr 0:03ec2f3bde8c 340 GFSK_BLE_MOD_IND_0_75 = 2,
GregCr 0:03ec2f3bde8c 341 GFSK_BLE_MOD_IND_1_00 = 3,
GregCr 0:03ec2f3bde8c 342 GFSK_BLE_MOD_IND_1_25 = 4,
GregCr 0:03ec2f3bde8c 343 GFSK_BLE_MOD_IND_1_50 = 5,
GregCr 0:03ec2f3bde8c 344 GFSK_BLE_MOD_IND_1_75 = 6,
GregCr 0:03ec2f3bde8c 345 GFSK_BLE_MOD_IND_2_00 = 7,
GregCr 0:03ec2f3bde8c 346 GFSK_BLE_MOD_IND_2_25 = 8,
GregCr 0:03ec2f3bde8c 347 GFSK_BLE_MOD_IND_2_50 = 9,
GregCr 0:03ec2f3bde8c 348 GFSK_BLE_MOD_IND_2_75 = 10,
GregCr 0:03ec2f3bde8c 349 GFSK_BLE_MOD_IND_3_00 = 11,
GregCr 0:03ec2f3bde8c 350 GFSK_BLE_MOD_IND_3_25 = 12,
GregCr 0:03ec2f3bde8c 351 GFSK_BLE_MOD_IND_3_50 = 13,
GregCr 0:03ec2f3bde8c 352 GFSK_BLE_MOD_IND_3_75 = 14,
GregCr 0:03ec2f3bde8c 353 GFSK_BLE_MOD_IND_4_00 = 15,
GregCr 0:03ec2f3bde8c 354 }RadioGfskBleModIndexes_t;
GregCr 0:03ec2f3bde8c 355
GregCr 0:03ec2f3bde8c 356 /*!
GregCr 0:03ec2f3bde8c 357 * \brief Represents the possible combination of bitrate and bandwidth for FLRC
GregCr 0:03ec2f3bde8c 358 * packet type
GregCr 0:03ec2f3bde8c 359 *
GregCr 0:03ec2f3bde8c 360 * The bitrate is in Mb/s and the bitrate in MHz
GregCr 0:03ec2f3bde8c 361 */
GregCr 0:03ec2f3bde8c 362 typedef enum
GregCr 0:03ec2f3bde8c 363 {
GregCr 0:03ec2f3bde8c 364 FLRC_BR_1_300_BW_1_2 = 0x45,
GregCr 0:03ec2f3bde8c 365 FLRC_BR_1_040_BW_1_2 = 0x69,
GregCr 0:03ec2f3bde8c 366 FLRC_BR_0_650_BW_0_6 = 0x86,
GregCr 0:03ec2f3bde8c 367 FLRC_BR_0_520_BW_0_6 = 0xAA,
GregCr 0:03ec2f3bde8c 368 FLRC_BR_0_325_BW_0_3 = 0xC7,
GregCr 0:03ec2f3bde8c 369 FLRC_BR_0_260_BW_0_3 = 0xEB,
GregCr 0:03ec2f3bde8c 370 }RadioFlrcBitrates_t;
GregCr 0:03ec2f3bde8c 371
GregCr 0:03ec2f3bde8c 372 /*!
GregCr 0:03ec2f3bde8c 373 * \brief Represents the possible values for coding rate parameter in FLRC
GregCr 0:03ec2f3bde8c 374 * packet type
GregCr 0:03ec2f3bde8c 375 */
GregCr 0:03ec2f3bde8c 376 typedef enum
GregCr 0:03ec2f3bde8c 377 {
GregCr 0:03ec2f3bde8c 378 FLRC_CR_1_2 = 0x00,
GregCr 0:03ec2f3bde8c 379 FLRC_CR_3_4 = 0x02,
GregCr 0:03ec2f3bde8c 380 FLRC_CR_1_0 = 0x04,
GregCr 0:03ec2f3bde8c 381 }RadioFlrcCodingRates_t;
GregCr 0:03ec2f3bde8c 382
GregCr 0:03ec2f3bde8c 383 /*!
GregCr 0:03ec2f3bde8c 384 * \brief Represents the modulation shaping parameter for GFSK, FLRC and BLE
GregCr 0:03ec2f3bde8c 385 * packet types
GregCr 0:03ec2f3bde8c 386 */
GregCr 0:03ec2f3bde8c 387 typedef enum
GregCr 0:03ec2f3bde8c 388 {
GregCr 0:03ec2f3bde8c 389 RADIO_MOD_SHAPING_BT_OFF = 0x00, //! No filtering
GregCr 0:03ec2f3bde8c 390 RADIO_MOD_SHAPING_BT_1_0 = 0x10,
GregCr 0:03ec2f3bde8c 391 RADIO_MOD_SHAPING_BT_0_5 = 0x20,
GregCr 0:03ec2f3bde8c 392 }RadioModShapings_t;
GregCr 0:03ec2f3bde8c 393
GregCr 0:03ec2f3bde8c 394 /*!
GregCr 0:03ec2f3bde8c 395 * \brief Represents the possible spreading factor values in LORA packet types
GregCr 0:03ec2f3bde8c 396 */
GregCr 0:03ec2f3bde8c 397 typedef enum
GregCr 0:03ec2f3bde8c 398 {
GregCr 0:03ec2f3bde8c 399 LORA_SF5 = 0x50,
GregCr 0:03ec2f3bde8c 400 LORA_SF6 = 0x60,
GregCr 0:03ec2f3bde8c 401 LORA_SF7 = 0x70,
GregCr 0:03ec2f3bde8c 402 LORA_SF8 = 0x80,
GregCr 0:03ec2f3bde8c 403 LORA_SF9 = 0x90,
GregCr 0:03ec2f3bde8c 404 LORA_SF10 = 0xA0,
GregCr 0:03ec2f3bde8c 405 LORA_SF11 = 0xB0,
GregCr 0:03ec2f3bde8c 406 LORA_SF12 = 0xC0,
GregCr 0:03ec2f3bde8c 407 }RadioLoRaSpreadingFactors_t;
GregCr 0:03ec2f3bde8c 408
GregCr 0:03ec2f3bde8c 409 /*!
GregCr 0:03ec2f3bde8c 410 * \brief Represents the bandwidth values for LORA packet type
GregCr 0:03ec2f3bde8c 411 */
GregCr 0:03ec2f3bde8c 412 typedef enum
GregCr 0:03ec2f3bde8c 413 {
GregCr 0:03ec2f3bde8c 414 LORA_BW_0200 = 0x34,
GregCr 0:03ec2f3bde8c 415 LORA_BW_0400 = 0x26,
GregCr 0:03ec2f3bde8c 416 LORA_BW_0800 = 0x18,
GregCr 0:03ec2f3bde8c 417 LORA_BW_1600 = 0x0A,
GregCr 0:03ec2f3bde8c 418 }RadioLoRaBandwidths_t;
GregCr 0:03ec2f3bde8c 419
GregCr 0:03ec2f3bde8c 420 /*!
GregCr 0:03ec2f3bde8c 421 * \brief Represents the coding rate values for LORA packet type
GregCr 0:03ec2f3bde8c 422 */
GregCr 0:03ec2f3bde8c 423 typedef enum
GregCr 0:03ec2f3bde8c 424 {
GregCr 0:03ec2f3bde8c 425 LORA_CR_4_5 = 0x01,
GregCr 0:03ec2f3bde8c 426 LORA_CR_4_6 = 0x02,
GregCr 0:03ec2f3bde8c 427 LORA_CR_4_7 = 0x03,
GregCr 0:03ec2f3bde8c 428 LORA_CR_4_8 = 0x04,
GregCr 0:03ec2f3bde8c 429 LORA_CR_LI_4_5 = 0x05,
GregCr 0:03ec2f3bde8c 430 LORA_CR_LI_4_6 = 0x06,
GregCr 0:03ec2f3bde8c 431 LORA_CR_LI_4_7 = 0x07,
GregCr 0:03ec2f3bde8c 432 }RadioLoRaCodingRates_t;
GregCr 0:03ec2f3bde8c 433
GregCr 0:03ec2f3bde8c 434 /*!
GregCr 0:03ec2f3bde8c 435 * \brief Represents the preamble length values for GFSK and FLRC packet
GregCr 0:03ec2f3bde8c 436 * types
GregCr 0:03ec2f3bde8c 437 */
GregCr 0:03ec2f3bde8c 438 typedef enum
GregCr 0:03ec2f3bde8c 439 {
GregCr 0:03ec2f3bde8c 440 PREAMBLE_LENGTH_04_BITS = 0x00, //!< Preamble length: 04 bits
GregCr 0:03ec2f3bde8c 441 PREAMBLE_LENGTH_08_BITS = 0x10, //!< Preamble length: 08 bits
GregCr 0:03ec2f3bde8c 442 PREAMBLE_LENGTH_12_BITS = 0x20, //!< Preamble length: 12 bits
GregCr 0:03ec2f3bde8c 443 PREAMBLE_LENGTH_16_BITS = 0x30, //!< Preamble length: 16 bits
GregCr 0:03ec2f3bde8c 444 PREAMBLE_LENGTH_20_BITS = 0x40, //!< Preamble length: 20 bits
GregCr 0:03ec2f3bde8c 445 PREAMBLE_LENGTH_24_BITS = 0x50, //!< Preamble length: 24 bits
GregCr 0:03ec2f3bde8c 446 PREAMBLE_LENGTH_28_BITS = 0x60, //!< Preamble length: 28 bits
GregCr 0:03ec2f3bde8c 447 PREAMBLE_LENGTH_32_BITS = 0x70, //!< Preamble length: 32 bits
GregCr 0:03ec2f3bde8c 448 }RadioPreambleLengths_t;
GregCr 0:03ec2f3bde8c 449
GregCr 0:03ec2f3bde8c 450 /*!
GregCr 0:03ec2f3bde8c 451 * \brief Represents the SyncWord length for FLRC packet type
GregCr 0:03ec2f3bde8c 452 */
GregCr 0:03ec2f3bde8c 453 typedef enum
GregCr 0:03ec2f3bde8c 454 {
GregCr 4:abf14b677777 455 FLRC_NO_SYNCWORD = 0x00,
GregCr 4:abf14b677777 456 FLRC_SYNCWORD_LENGTH_4_BYTE = 0x04,
GregCr 0:03ec2f3bde8c 457 }RadioFlrcSyncWordLengths_t;
GregCr 0:03ec2f3bde8c 458
GregCr 0:03ec2f3bde8c 459 /*!
GregCr 0:03ec2f3bde8c 460 * \brief The length of sync words for GFSK packet type
GregCr 0:03ec2f3bde8c 461 */
GregCr 0:03ec2f3bde8c 462 typedef enum
GregCr 0:03ec2f3bde8c 463 {
GregCr 0:03ec2f3bde8c 464 GFSK_SYNCWORD_LENGTH_1_BYTE = 0x00, //!< Sync word length: 1 byte
GregCr 0:03ec2f3bde8c 465 GFSK_SYNCWORD_LENGTH_2_BYTE = 0x02, //!< Sync word length: 2 bytes
GregCr 0:03ec2f3bde8c 466 GFSK_SYNCWORD_LENGTH_3_BYTE = 0x04, //!< Sync word length: 3 bytes
GregCr 0:03ec2f3bde8c 467 GFSK_SYNCWORD_LENGTH_4_BYTE = 0x06, //!< Sync word length: 4 bytes
GregCr 0:03ec2f3bde8c 468 GFSK_SYNCWORD_LENGTH_5_BYTE = 0x08, //!< Sync word length: 5 bytes
GregCr 0:03ec2f3bde8c 469 }RadioSyncWordLengths_t;
GregCr 0:03ec2f3bde8c 470
GregCr 0:03ec2f3bde8c 471 /*!
GregCr 0:03ec2f3bde8c 472 * \brief Represents the possible combinations of SyncWord correlators
GregCr 0:03ec2f3bde8c 473 * activated for GFSK and FLRC packet types
GregCr 0:03ec2f3bde8c 474 */
GregCr 0:03ec2f3bde8c 475 typedef enum
GregCr 0:03ec2f3bde8c 476 {
GregCr 0:03ec2f3bde8c 477 RADIO_RX_MATCH_SYNCWORD_OFF = 0x00, //!< No correlator turned on, i.e. do not search for SyncWord
GregCr 0:03ec2f3bde8c 478 RADIO_RX_MATCH_SYNCWORD_1 = 0x10,
GregCr 0:03ec2f3bde8c 479 RADIO_RX_MATCH_SYNCWORD_2 = 0x20,
GregCr 0:03ec2f3bde8c 480 RADIO_RX_MATCH_SYNCWORD_1_2 = 0x30,
GregCr 0:03ec2f3bde8c 481 RADIO_RX_MATCH_SYNCWORD_3 = 0x40,
GregCr 0:03ec2f3bde8c 482 RADIO_RX_MATCH_SYNCWORD_1_3 = 0x50,
GregCr 0:03ec2f3bde8c 483 RADIO_RX_MATCH_SYNCWORD_2_3 = 0x60,
GregCr 0:03ec2f3bde8c 484 RADIO_RX_MATCH_SYNCWORD_1_2_3 = 0x70,
GregCr 0:03ec2f3bde8c 485 }RadioSyncWordRxMatchs_t;
GregCr 0:03ec2f3bde8c 486
GregCr 0:03ec2f3bde8c 487 /*!
GregCr 0:03ec2f3bde8c 488 * \brief Radio packet length mode for GFSK and FLRC packet types
GregCr 0:03ec2f3bde8c 489 */
GregCr 0:03ec2f3bde8c 490 typedef enum
GregCr 0:03ec2f3bde8c 491 {
GregCr 0:03ec2f3bde8c 492 RADIO_PACKET_FIXED_LENGTH = 0x00, //!< The packet is known on both sides, no header included in the packet
GregCr 0:03ec2f3bde8c 493 RADIO_PACKET_VARIABLE_LENGTH = 0x20, //!< The packet is on variable size, header included
GregCr 0:03ec2f3bde8c 494 }RadioPacketLengthModes_t;
GregCr 0:03ec2f3bde8c 495
GregCr 0:03ec2f3bde8c 496 /*!
GregCr 0:03ec2f3bde8c 497 * \brief Represents the CRC length for GFSK and FLRC packet types
GregCr 0:03ec2f3bde8c 498 *
GregCr 0:03ec2f3bde8c 499 * \warning Not all configurations are available for both GFSK and FLRC
GregCr 0:03ec2f3bde8c 500 * packet type. Refer to the datasheet for possible configuration.
GregCr 0:03ec2f3bde8c 501 */
GregCr 0:03ec2f3bde8c 502 typedef enum
GregCr 0:03ec2f3bde8c 503 {
GregCr 0:03ec2f3bde8c 504 RADIO_CRC_OFF = 0x00, //!< No CRC in use
GregCr 0:03ec2f3bde8c 505 RADIO_CRC_1_BYTES = 0x10,
GregCr 0:03ec2f3bde8c 506 RADIO_CRC_2_BYTES = 0x20,
GregCr 0:03ec2f3bde8c 507 RADIO_CRC_3_BYTES = 0x30,
GregCr 0:03ec2f3bde8c 508 }RadioCrcTypes_t;
GregCr 0:03ec2f3bde8c 509
GregCr 0:03ec2f3bde8c 510 /*!
GregCr 0:03ec2f3bde8c 511 * \brief Radio whitening mode activated or deactivated for GFSK, FLRC and
GregCr 0:03ec2f3bde8c 512 * BLE packet types
GregCr 0:03ec2f3bde8c 513 */
GregCr 0:03ec2f3bde8c 514 typedef enum
GregCr 0:03ec2f3bde8c 515 {
GregCr 0:03ec2f3bde8c 516 RADIO_WHITENING_ON = 0x00,
GregCr 0:03ec2f3bde8c 517 RADIO_WHITENING_OFF = 0x08,
GregCr 0:03ec2f3bde8c 518 }RadioWhiteningModes_t;
GregCr 0:03ec2f3bde8c 519
GregCr 0:03ec2f3bde8c 520 /*!
GregCr 0:03ec2f3bde8c 521 * \brief Holds the packet length mode of a LORA packet type
GregCr 0:03ec2f3bde8c 522 */
GregCr 0:03ec2f3bde8c 523 typedef enum
GregCr 0:03ec2f3bde8c 524 {
GregCr 0:03ec2f3bde8c 525 LORA_PACKET_VARIABLE_LENGTH = 0x00, //!< The packet is on variable size, header included
GregCr 0:03ec2f3bde8c 526 LORA_PACKET_FIXED_LENGTH = 0x80, //!< The packet is known on both sides, no header included in the packet
GregCr 0:03ec2f3bde8c 527 LORA_PACKET_EXPLICIT = LORA_PACKET_VARIABLE_LENGTH,
GregCr 0:03ec2f3bde8c 528 LORA_PACKET_IMPLICIT = LORA_PACKET_FIXED_LENGTH,
GregCr 0:03ec2f3bde8c 529 }RadioLoRaPacketLengthsModes_t;
GregCr 0:03ec2f3bde8c 530
GregCr 0:03ec2f3bde8c 531 /*!
GregCr 0:03ec2f3bde8c 532 * \brief Represents the CRC mode for LORA packet type
GregCr 0:03ec2f3bde8c 533 */
GregCr 0:03ec2f3bde8c 534 typedef enum
GregCr 0:03ec2f3bde8c 535 {
GregCr 0:03ec2f3bde8c 536 LORA_CRC_ON = 0x20, //!< CRC activated
GregCr 0:03ec2f3bde8c 537 LORA_CRC_OFF = 0x00, //!< CRC not used
GregCr 0:03ec2f3bde8c 538 }RadioLoRaCrcModes_t;
GregCr 0:03ec2f3bde8c 539
GregCr 0:03ec2f3bde8c 540 /*!
GregCr 0:03ec2f3bde8c 541 * \brief Represents the IQ mode for LORA packet type
GregCr 0:03ec2f3bde8c 542 */
GregCr 0:03ec2f3bde8c 543 typedef enum
GregCr 0:03ec2f3bde8c 544 {
GregCr 0:03ec2f3bde8c 545 LORA_IQ_NORMAL = 0x40,
GregCr 0:03ec2f3bde8c 546 LORA_IQ_INVERTED = 0x00,
GregCr 0:03ec2f3bde8c 547 }RadioLoRaIQModes_t;
GregCr 0:03ec2f3bde8c 548
GregCr 0:03ec2f3bde8c 549 /*!
GregCr 0:03ec2f3bde8c 550 * \brief Represents the length of the ID to check in ranging operation
GregCr 0:03ec2f3bde8c 551 */
GregCr 0:03ec2f3bde8c 552 typedef enum
GregCr 0:03ec2f3bde8c 553 {
GregCr 0:03ec2f3bde8c 554 RANGING_IDCHECK_LENGTH_08_BITS = 0x00,
GregCr 0:03ec2f3bde8c 555 RANGING_IDCHECK_LENGTH_16_BITS,
GregCr 0:03ec2f3bde8c 556 RANGING_IDCHECK_LENGTH_24_BITS,
GregCr 0:03ec2f3bde8c 557 RANGING_IDCHECK_LENGTH_32_BITS,
GregCr 0:03ec2f3bde8c 558 }RadioRangingIdCheckLengths_t;
GregCr 0:03ec2f3bde8c 559
GregCr 0:03ec2f3bde8c 560 /*!
GregCr 0:03ec2f3bde8c 561 * \brief Represents the result type to be used in ranging operation
GregCr 0:03ec2f3bde8c 562 */
GregCr 0:03ec2f3bde8c 563 typedef enum
GregCr 0:03ec2f3bde8c 564 {
GregCr 0:03ec2f3bde8c 565 RANGING_RESULT_RAW = 0x00,
GregCr 0:03ec2f3bde8c 566 RANGING_RESULT_AVERAGED = 0x01,
GregCr 0:03ec2f3bde8c 567 RANGING_RESULT_DEBIASED = 0x02,
GregCr 0:03ec2f3bde8c 568 RANGING_RESULT_FILTERED = 0x03,
GregCr 0:03ec2f3bde8c 569 }RadioRangingResultTypes_t;
GregCr 0:03ec2f3bde8c 570
GregCr 0:03ec2f3bde8c 571 /*!
GregCr 0:03ec2f3bde8c 572 * \brief Represents the connection state for BLE packet type
GregCr 0:03ec2f3bde8c 573 */
GregCr 0:03ec2f3bde8c 574 typedef enum
GregCr 0:03ec2f3bde8c 575 {
GregCr 11:d60df50e108f 576 BLE_PAYLOAD_LENGTH_MAX_31_BYTES = 0x00,
GregCr 11:d60df50e108f 577 BLE_PAYLOAD_LENGTH_MAX_37_BYTES = 0x20,
GregCr 0:03ec2f3bde8c 578 BLE_TX_TEST_MODE = 0x40,
GregCr 11:d60df50e108f 579 BLE_PAYLOAD_LENGTH_MAX_255_BYTES = 0x80,
GregCr 0:03ec2f3bde8c 580 }RadioBleConnectionStates_t;
GregCr 0:03ec2f3bde8c 581
GregCr 0:03ec2f3bde8c 582 /*!
GregCr 0:03ec2f3bde8c 583 * \brief Represents the CRC field length for BLE packet type
GregCr 0:03ec2f3bde8c 584 */
GregCr 0:03ec2f3bde8c 585 typedef enum
GregCr 0:03ec2f3bde8c 586 {
GregCr 0:03ec2f3bde8c 587 BLE_CRC_OFF = 0x00,
GregCr 0:03ec2f3bde8c 588 BLE_CRC_3B = 0x10,
GregCr 4:abf14b677777 589 }RadioBleCrcTypes_t;
GregCr 0:03ec2f3bde8c 590
GregCr 0:03ec2f3bde8c 591 /*!
GregCr 0:03ec2f3bde8c 592 * \brief Represents the specific packets to use in BLE packet type
GregCr 0:03ec2f3bde8c 593 */
GregCr 0:03ec2f3bde8c 594 typedef enum
GregCr 0:03ec2f3bde8c 595 {
GregCr 0:03ec2f3bde8c 596 BLE_PRBS_9 = 0x00, //!< Pseudo Random Binary Sequence based on 9th degree polynomial
GregCr 0:03ec2f3bde8c 597 BLE_PRBS_15 = 0x0C, //!< Pseudo Random Binary Sequence based on 15th degree polynomial
GregCr 0:03ec2f3bde8c 598 BLE_EYELONG_1_0 = 0x04, //!< Repeated '11110000' sequence
GregCr 0:03ec2f3bde8c 599 BLE_EYELONG_0_1 = 0x18, //!< Repeated '00001111' sequence
GregCr 0:03ec2f3bde8c 600 BLE_EYESHORT_1_0 = 0x08, //!< Repeated '10101010' sequence
GregCr 0:03ec2f3bde8c 601 BLE_EYESHORT_0_1 = 0x1C, //!< Repeated '01010101' sequence
GregCr 0:03ec2f3bde8c 602 BLE_ALL_1 = 0x10, //!< Repeated '11111111' sequence
GregCr 0:03ec2f3bde8c 603 BLE_ALL_0 = 0x14, //!< Repeated '00000000' sequence
GregCr 4:abf14b677777 604 }RadioBleTestPayloads_t;
GregCr 0:03ec2f3bde8c 605
GregCr 0:03ec2f3bde8c 606 /*!
GregCr 0:03ec2f3bde8c 607 * \brief Represents the interruption masks available for the radio
GregCr 0:03ec2f3bde8c 608 *
GregCr 0:03ec2f3bde8c 609 * \remark Note that not all these interruptions are available for all packet types
GregCr 0:03ec2f3bde8c 610 */
GregCr 0:03ec2f3bde8c 611 typedef enum
GregCr 0:03ec2f3bde8c 612 {
GregCr 0:03ec2f3bde8c 613 IRQ_RADIO_NONE = 0x0000,
GregCr 0:03ec2f3bde8c 614 IRQ_TX_DONE = 0x0001,
GregCr 0:03ec2f3bde8c 615 IRQ_RX_DONE = 0x0002,
GregCr 0:03ec2f3bde8c 616 IRQ_SYNCWORD_VALID = 0x0004,
GregCr 0:03ec2f3bde8c 617 IRQ_SYNCWORD_ERROR = 0x0008,
GregCr 0:03ec2f3bde8c 618 IRQ_HEADER_VALID = 0x0010,
GregCr 0:03ec2f3bde8c 619 IRQ_HEADER_ERROR = 0x0020,
GregCr 0:03ec2f3bde8c 620 IRQ_CRC_ERROR = 0x0040,
GregCr 0:03ec2f3bde8c 621 IRQ_RANGING_SLAVE_RESPONSE_DONE = 0x0080,
GregCr 0:03ec2f3bde8c 622 IRQ_RANGING_SLAVE_REQUEST_DISCARDED = 0x0100,
GregCr 0:03ec2f3bde8c 623 IRQ_RANGING_MASTER_RESULT_VALID = 0x0200,
GregCr 4:abf14b677777 624 IRQ_RANGING_MASTER_TIMEOUT = 0x0400,
GregCr 0:03ec2f3bde8c 625 IRQ_RANGING_SLAVE_REQUEST_VALID = 0x0800,
GregCr 0:03ec2f3bde8c 626 IRQ_CAD_DONE = 0x1000,
GregCr 4:abf14b677777 627 IRQ_CAD_DETECTED = 0x2000,
GregCr 0:03ec2f3bde8c 628 IRQ_RX_TX_TIMEOUT = 0x4000,
GregCr 0:03ec2f3bde8c 629 IRQ_PREAMBLE_DETECTED = 0x8000,
GregCr 0:03ec2f3bde8c 630 IRQ_RADIO_ALL = 0xFFFF,
GregCr 0:03ec2f3bde8c 631 }RadioIrqMasks_t;
GregCr 0:03ec2f3bde8c 632
GregCr 0:03ec2f3bde8c 633 /*!
GregCr 0:03ec2f3bde8c 634 * \brief Represents the digital input/output of the radio
GregCr 0:03ec2f3bde8c 635 */
GregCr 0:03ec2f3bde8c 636 typedef enum
GregCr 0:03ec2f3bde8c 637 {
GregCr 0:03ec2f3bde8c 638 RADIO_DIO1 = 0x02,
GregCr 0:03ec2f3bde8c 639 RADIO_DIO2 = 0x04,
GregCr 0:03ec2f3bde8c 640 RADIO_DIO3 = 0x08,
GregCr 0:03ec2f3bde8c 641 }RadioDios_t;
GregCr 0:03ec2f3bde8c 642
GregCr 0:03ec2f3bde8c 643 /*!
GregCr 0:03ec2f3bde8c 644 * \brief Represents the tick size available for Rx/Tx timeout operations
GregCr 0:03ec2f3bde8c 645 */
GregCr 0:03ec2f3bde8c 646 typedef enum
GregCr 0:03ec2f3bde8c 647 {
GregCr 0:03ec2f3bde8c 648 RADIO_TICK_SIZE_0015_US = 0x00,
GregCr 0:03ec2f3bde8c 649 RADIO_TICK_SIZE_0062_US = 0x01,
GregCr 0:03ec2f3bde8c 650 RADIO_TICK_SIZE_1000_US = 0x02,
GregCr 0:03ec2f3bde8c 651 RADIO_TICK_SIZE_4000_US = 0x03,
GregCr 0:03ec2f3bde8c 652 }RadioTickSizes_t;
GregCr 0:03ec2f3bde8c 653
GregCr 0:03ec2f3bde8c 654 /*!
GregCr 0:03ec2f3bde8c 655 * \brief Represents the role of the radio during ranging operations
GregCr 0:03ec2f3bde8c 656 */
GregCr 0:03ec2f3bde8c 657 typedef enum
GregCr 0:03ec2f3bde8c 658 {
GregCr 0:03ec2f3bde8c 659 RADIO_RANGING_ROLE_SLAVE = 0x00,
GregCr 0:03ec2f3bde8c 660 RADIO_RANGING_ROLE_MASTER = 0x01,
GregCr 0:03ec2f3bde8c 661 }RadioRangingRoles_t;
GregCr 0:03ec2f3bde8c 662
GregCr 0:03ec2f3bde8c 663 /*!
GregCr 11:d60df50e108f 664 * \brief Represents the possible Mask settings for sensitivity selection
GregCr 0:03ec2f3bde8c 665 */
GregCr 11:d60df50e108f 666 typedef enum
GregCr 0:03ec2f3bde8c 667 {
mverdy 12:c4f110f3fe3e 668 LNA_LOW_POWER_MODE,
mverdy 12:c4f110f3fe3e 669 LNA_HIGH_SENSITIVITY_MODE,
GregCr 11:d60df50e108f 670 }RadioLnaSettings_t;
GregCr 0:03ec2f3bde8c 671
GregCr 0:03ec2f3bde8c 672 /*!
GregCr 0:03ec2f3bde8c 673 * \brief Represents an amount of time measurable by the radio clock
GregCr 0:03ec2f3bde8c 674 *
GregCr 0:03ec2f3bde8c 675 * @code
GregCr 4:abf14b677777 676 * Time = PeriodBase * PeriodBaseCount
GregCr 0:03ec2f3bde8c 677 * Example:
GregCr 4:abf14b677777 678 * PeriodBase = RADIO_TICK_SIZE_4000_US( 4 ms )
GregCr 4:abf14b677777 679 * PeriodBaseCount = 1000
GregCr 0:03ec2f3bde8c 680 * Time = 4e-3 * 1000 = 4 seconds
GregCr 0:03ec2f3bde8c 681 * @endcode
GregCr 0:03ec2f3bde8c 682 */
GregCr 0:03ec2f3bde8c 683 typedef struct TickTime_s
GregCr 0:03ec2f3bde8c 684 {
GregCr 4:abf14b677777 685 RadioTickSizes_t PeriodBase; //!< The base time of ticktime
GregCr 0:03ec2f3bde8c 686 /*!
GregCr 4:abf14b677777 687 * \brief The number of periodBase for ticktime
GregCr 0:03ec2f3bde8c 688 * Special values are:
GregCr 0:03ec2f3bde8c 689 * - 0x0000 for single mode
GregCr 0:03ec2f3bde8c 690 * - 0xFFFF for continuous mode
GregCr 0:03ec2f3bde8c 691 */
GregCr 4:abf14b677777 692 uint16_t PeriodBaseCount;
GregCr 0:03ec2f3bde8c 693 }TickTime_t;
GregCr 0:03ec2f3bde8c 694
GregCr 0:03ec2f3bde8c 695 /*!
GregCr 0:03ec2f3bde8c 696 * \brief RX_TX_CONTINUOUS and RX_TX_SINGLE are two particular values for TickTime.
GregCr 0:03ec2f3bde8c 697 * The former keep the radio in Rx or Tx mode, even after successfull reception
GregCr 0:03ec2f3bde8c 698 * or transmission. It should never generate Timeout interrupt.
GregCr 0:03ec2f3bde8c 699 * The later let the radio enought time to make one reception or transmission.
GregCr 0:03ec2f3bde8c 700 * No Timeout interrupt is generated, and the radio fall in StandBy mode after
GregCr 0:03ec2f3bde8c 701 * reception or transmission.
GregCr 0:03ec2f3bde8c 702 */
GregCr 0:03ec2f3bde8c 703 #define RX_TX_CONTINUOUS ( TickTime_t ){ RADIO_TICK_SIZE_0015_US, 0xFFFF }
GregCr 0:03ec2f3bde8c 704 #define RX_TX_SINGLE ( TickTime_t ){ RADIO_TICK_SIZE_0015_US, 0 }
GregCr 0:03ec2f3bde8c 705
GregCr 0:03ec2f3bde8c 706 /*!
GregCr 0:03ec2f3bde8c 707 * \brief The type describing the modulation parameters for every packet types
GregCr 0:03ec2f3bde8c 708 */
GregCr 0:03ec2f3bde8c 709 typedef struct
GregCr 0:03ec2f3bde8c 710 {
GregCr 4:abf14b677777 711 RadioPacketTypes_t PacketType; //!< Packet to which the modulation parameters are referring to.
GregCr 0:03ec2f3bde8c 712 struct
GregCr 0:03ec2f3bde8c 713 {
GregCr 0:03ec2f3bde8c 714 /*!
GregCr 0:03ec2f3bde8c 715 * \brief Holds the GFSK modulation parameters
GregCr 0:03ec2f3bde8c 716 *
GregCr 0:03ec2f3bde8c 717 * In GFSK modulation, the bit-rate and bandwidth are linked together. In this structure, its values are set using the same token.
GregCr 0:03ec2f3bde8c 718 */
GregCr 0:03ec2f3bde8c 719 struct
GregCr 0:03ec2f3bde8c 720 {
GregCr 4:abf14b677777 721 RadioGfskBleBitrates_t BitrateBandwidth; //!< The bandwidth and bit-rate values for BLE and GFSK modulations
GregCr 4:abf14b677777 722 RadioGfskBleModIndexes_t ModulationIndex; //!< The coding rate for BLE and GFSK modulations
GregCr 4:abf14b677777 723 RadioModShapings_t ModulationShaping; //!< The modulation shaping for BLE and GFSK modulations
GregCr 0:03ec2f3bde8c 724 }Gfsk;
GregCr 0:03ec2f3bde8c 725 /*!
GregCr 0:03ec2f3bde8c 726 * \brief Holds the LORA modulation parameters
GregCr 0:03ec2f3bde8c 727 *
GregCr 0:03ec2f3bde8c 728 * LORA modulation is defined by Spreading Factor (SF), Bandwidth and Coding Rate
GregCr 0:03ec2f3bde8c 729 */
GregCr 0:03ec2f3bde8c 730 struct
GregCr 0:03ec2f3bde8c 731 {
GregCr 0:03ec2f3bde8c 732 RadioLoRaSpreadingFactors_t SpreadingFactor; //!< Spreading Factor for the LORA modulation
GregCr 0:03ec2f3bde8c 733 RadioLoRaBandwidths_t Bandwidth; //!< Bandwidth for the LORA modulation
GregCr 0:03ec2f3bde8c 734 RadioLoRaCodingRates_t CodingRate; //!< Coding rate for the LORA modulation
GregCr 0:03ec2f3bde8c 735 }LoRa;
GregCr 0:03ec2f3bde8c 736 /*!
GregCr 0:03ec2f3bde8c 737 * \brief Holds the FLRC modulation parameters
GregCr 0:03ec2f3bde8c 738 *
GregCr 0:03ec2f3bde8c 739 * In FLRC modulation, the bit-rate and bandwidth are linked together. In this structure, its values are set using the same token.
GregCr 0:03ec2f3bde8c 740 */
GregCr 0:03ec2f3bde8c 741 struct
GregCr 0:03ec2f3bde8c 742 {
GregCr 0:03ec2f3bde8c 743 RadioFlrcBitrates_t BitrateBandwidth; //!< The bandwidth and bit-rate values for FLRC modulation
GregCr 0:03ec2f3bde8c 744 RadioFlrcCodingRates_t CodingRate; //!< The coding rate for FLRC modulation
GregCr 0:03ec2f3bde8c 745 RadioModShapings_t ModulationShaping; //!< The modulation shaping for FLRC modulation
GregCr 0:03ec2f3bde8c 746 }Flrc;
GregCr 0:03ec2f3bde8c 747 /*!
GregCr 0:03ec2f3bde8c 748 * \brief Holds the BLE modulation parameters
GregCr 0:03ec2f3bde8c 749 *
GregCr 0:03ec2f3bde8c 750 * In BLE modulation, the bit-rate and bandwidth are linked together. In this structure, its values are set using the same token.
GregCr 0:03ec2f3bde8c 751 */
GregCr 0:03ec2f3bde8c 752 struct
GregCr 0:03ec2f3bde8c 753 {
GregCr 0:03ec2f3bde8c 754 RadioGfskBleBitrates_t BitrateBandwidth; //!< The bandwidth and bit-rate values for BLE and GFSK modulations
GregCr 0:03ec2f3bde8c 755 RadioGfskBleModIndexes_t ModulationIndex; //!< The coding rate for BLE and GFSK modulations
GregCr 0:03ec2f3bde8c 756 RadioModShapings_t ModulationShaping; //!< The modulation shaping for BLE and GFSK modulations
GregCr 0:03ec2f3bde8c 757 }Ble;
GregCr 4:abf14b677777 758 }Params; //!< Holds the modulation parameters structure
GregCr 0:03ec2f3bde8c 759 }ModulationParams_t;
GregCr 0:03ec2f3bde8c 760
GregCr 0:03ec2f3bde8c 761 /*!
GregCr 0:03ec2f3bde8c 762 * \brief The type describing the packet parameters for every packet types
GregCr 0:03ec2f3bde8c 763 */
GregCr 0:03ec2f3bde8c 764 typedef struct
GregCr 0:03ec2f3bde8c 765 {
GregCr 4:abf14b677777 766 RadioPacketTypes_t PacketType; //!< Packet to which the packet parameters are referring to.
GregCr 0:03ec2f3bde8c 767 struct
GregCr 0:03ec2f3bde8c 768 {
GregCr 0:03ec2f3bde8c 769 /*!
GregCr 0:03ec2f3bde8c 770 * \brief Holds the GFSK packet parameters
GregCr 0:03ec2f3bde8c 771 */
GregCr 0:03ec2f3bde8c 772 struct
GregCr 0:03ec2f3bde8c 773 {
GregCr 0:03ec2f3bde8c 774 RadioPreambleLengths_t PreambleLength; //!< The preamble length for GFSK packet type
GregCr 0:03ec2f3bde8c 775 RadioSyncWordLengths_t SyncWordLength; //!< The synchronization word length for GFSK packet type
GregCr 0:03ec2f3bde8c 776 RadioSyncWordRxMatchs_t SyncWordMatch; //!< The synchronization correlator to use to check synchronization word
GregCr 0:03ec2f3bde8c 777 RadioPacketLengthModes_t HeaderType; //!< If the header is explicit, it will be transmitted in the GFSK packet. If the header is implicit, it will not be transmitted
GregCr 0:03ec2f3bde8c 778 uint8_t PayloadLength; //!< Size of the payload in the GFSK packet
GregCr 0:03ec2f3bde8c 779 RadioCrcTypes_t CrcLength; //!< Size of the CRC block in the GFSK packet
GregCr 0:03ec2f3bde8c 780 RadioWhiteningModes_t Whitening; //!< Usage of whitening on payload and CRC blocks plus header block if header type is variable
GregCr 0:03ec2f3bde8c 781 }Gfsk;
GregCr 0:03ec2f3bde8c 782 /*!
GregCr 0:03ec2f3bde8c 783 * \brief Holds the LORA packet parameters
GregCr 0:03ec2f3bde8c 784 */
GregCr 0:03ec2f3bde8c 785 struct
GregCr 0:03ec2f3bde8c 786 {
GregCr 4:abf14b677777 787 uint8_t PreambleLength; //!< The preamble length is the number of LORA symbols in the preamble. To set it, use the following formula @code Number of symbols = PreambleLength[3:0] * ( 2^PreambleLength[7:4] ) @endcode
GregCr 4:abf14b677777 788 RadioLoRaPacketLengthsModes_t HeaderType; //!< If the header is explicit, it will be transmitted in the LORA packet. If the header is implicit, it will not be transmitted
GregCr 4:abf14b677777 789 uint8_t PayloadLength; //!< Size of the payload in the LORA packet
GregCr 4:abf14b677777 790 RadioLoRaCrcModes_t Crc; //!< Size of CRC block in LORA packet
GregCr 4:abf14b677777 791 RadioLoRaIQModes_t InvertIQ; //!< Allows to swap IQ for LORA packet
GregCr 0:03ec2f3bde8c 792 }LoRa;
GregCr 0:03ec2f3bde8c 793 /*!
GregCr 0:03ec2f3bde8c 794 * \brief Holds the FLRC packet parameters
GregCr 0:03ec2f3bde8c 795 */
GregCr 0:03ec2f3bde8c 796 struct
GregCr 0:03ec2f3bde8c 797 {
GregCr 0:03ec2f3bde8c 798 RadioPreambleLengths_t PreambleLength; //!< The preamble length for FLRC packet type
GregCr 0:03ec2f3bde8c 799 RadioFlrcSyncWordLengths_t SyncWordLength; //!< The synchronization word length for FLRC packet type
GregCr 0:03ec2f3bde8c 800 RadioSyncWordRxMatchs_t SyncWordMatch; //!< The synchronization correlator to use to check synchronization word
GregCr 0:03ec2f3bde8c 801 RadioPacketLengthModes_t HeaderType; //!< If the header is explicit, it will be transmitted in the FLRC packet. If the header is implicit, it will not be transmitted.
GregCr 0:03ec2f3bde8c 802 uint8_t PayloadLength; //!< Size of the payload in the FLRC packet
GregCr 0:03ec2f3bde8c 803 RadioCrcTypes_t CrcLength; //!< Size of the CRC block in the FLRC packet
GregCr 0:03ec2f3bde8c 804 RadioWhiteningModes_t Whitening; //!< Usage of whitening on payload and CRC blocks plus header block if header type is variable
GregCr 0:03ec2f3bde8c 805 }Flrc;
GregCr 0:03ec2f3bde8c 806 /*!
GregCr 0:03ec2f3bde8c 807 * \brief Holds the BLE packet parameters
GregCr 0:03ec2f3bde8c 808 */
GregCr 0:03ec2f3bde8c 809 struct
GregCr 0:03ec2f3bde8c 810 {
GregCr 0:03ec2f3bde8c 811 RadioBleConnectionStates_t ConnectionState; //!< The BLE state
GregCr 4:abf14b677777 812 RadioBleCrcTypes_t CrcLength; //!< Size of the CRC block in the BLE packet
GregCr 4:abf14b677777 813 RadioBleTestPayloads_t BleTestPayload; //!< Special BLE payload for test purpose
GregCr 0:03ec2f3bde8c 814 RadioWhiteningModes_t Whitening; //!< Usage of whitening on PDU and CRC blocks of BLE packet
GregCr 0:03ec2f3bde8c 815 }Ble;
GregCr 0:03ec2f3bde8c 816 }Params; //!< Holds the packet parameters structure
GregCr 0:03ec2f3bde8c 817 }PacketParams_t;
GregCr 0:03ec2f3bde8c 818
GregCr 0:03ec2f3bde8c 819 /*!
GregCr 0:03ec2f3bde8c 820 * \brief Represents the packet status for every packet type
GregCr 0:03ec2f3bde8c 821 */
GregCr 0:03ec2f3bde8c 822 typedef struct
GregCr 0:03ec2f3bde8c 823 {
GregCr 0:03ec2f3bde8c 824 RadioPacketTypes_t packetType; //!< Packet to which the packet status are referring to.
GregCr 0:03ec2f3bde8c 825 union
GregCr 0:03ec2f3bde8c 826 {
GregCr 0:03ec2f3bde8c 827 struct
GregCr 0:03ec2f3bde8c 828 {
GregCr 0:03ec2f3bde8c 829 int8_t RssiSync; //!< The RSSI measured on last packet
GregCr 0:03ec2f3bde8c 830 struct
GregCr 0:03ec2f3bde8c 831 {
GregCr 0:03ec2f3bde8c 832 bool SyncError :1; //!< SyncWord error on last packet
GregCr 0:03ec2f3bde8c 833 bool LengthError :1; //!< Length error on last packet
GregCr 0:03ec2f3bde8c 834 bool CrcError :1; //!< CRC error on last packet
GregCr 0:03ec2f3bde8c 835 bool AbortError :1; //!< Abort error on last packet
GregCr 0:03ec2f3bde8c 836 bool HeaderReceived :1; //!< Header received on last packet
GregCr 0:03ec2f3bde8c 837 bool PacketReceived :1; //!< Packet received
GregCr 0:03ec2f3bde8c 838 bool PacketControlerBusy :1; //!< Packet controller busy
GregCr 0:03ec2f3bde8c 839 }ErrorStatus; //!< The error status Byte
GregCr 0:03ec2f3bde8c 840 struct
GregCr 0:03ec2f3bde8c 841 {
GregCr 0:03ec2f3bde8c 842 bool RxNoAck :1; //!< No acknowledgment received for Rx with variable length packets
GregCr 0:03ec2f3bde8c 843 bool PacketSent :1; //!< Packet sent, only relevant in Tx mode
GregCr 0:03ec2f3bde8c 844 }TxRxStatus; //!< The Tx/Rx status Byte
GregCr 0:03ec2f3bde8c 845 uint8_t SyncAddrStatus :3; //!< The id of the correlator who found the packet
GregCr 0:03ec2f3bde8c 846 }Gfsk;
GregCr 0:03ec2f3bde8c 847 struct
GregCr 0:03ec2f3bde8c 848 {
GregCr 0:03ec2f3bde8c 849 int8_t RssiPkt; //!< The RSSI of the last packet
GregCr 0:03ec2f3bde8c 850 int8_t SnrPkt; //!< The SNR of the last packet
GregCr 0:03ec2f3bde8c 851 }LoRa;
GregCr 0:03ec2f3bde8c 852 struct
GregCr 0:03ec2f3bde8c 853 {
GregCr 0:03ec2f3bde8c 854 int8_t RssiSync; //!< The RSSI of the last packet
GregCr 0:03ec2f3bde8c 855 struct
GregCr 0:03ec2f3bde8c 856 {
GregCr 0:03ec2f3bde8c 857 bool SyncError :1; //!< SyncWord error on last packet
GregCr 0:03ec2f3bde8c 858 bool LengthError :1; //!< Length error on last packet
GregCr 0:03ec2f3bde8c 859 bool CrcError :1; //!< CRC error on last packet
GregCr 0:03ec2f3bde8c 860 bool AbortError :1; //!< Abort error on last packet
GregCr 0:03ec2f3bde8c 861 bool HeaderReceived :1; //!< Header received on last packet
GregCr 0:03ec2f3bde8c 862 bool PacketReceived :1; //!< Packet received
GregCr 0:03ec2f3bde8c 863 bool PacketControlerBusy :1; //!< Packet controller busy
GregCr 0:03ec2f3bde8c 864 }ErrorStatus; //!< The error status Byte
GregCr 0:03ec2f3bde8c 865 struct
GregCr 0:03ec2f3bde8c 866 {
GregCr 0:03ec2f3bde8c 867 uint8_t RxPid :2; //!< PID of the Rx
GregCr 0:03ec2f3bde8c 868 bool RxNoAck :1; //!< No acknowledgment received for Rx with variable length packets
GregCr 0:03ec2f3bde8c 869 bool RxPidErr :1; //!< Received PID error
GregCr 0:03ec2f3bde8c 870 bool PacketSent :1; //!< Packet sent, only relevant in Tx mode
GregCr 0:03ec2f3bde8c 871 }TxRxStatus; //!< The Tx/Rx status Byte
GregCr 0:03ec2f3bde8c 872 uint8_t SyncAddrStatus :3; //!< The id of the correlator who found the packet
GregCr 0:03ec2f3bde8c 873 }Flrc;
GregCr 0:03ec2f3bde8c 874 struct
GregCr 0:03ec2f3bde8c 875 {
GregCr 0:03ec2f3bde8c 876 int8_t RssiSync; //!< The RSSI of the last packet
GregCr 0:03ec2f3bde8c 877 struct
GregCr 0:03ec2f3bde8c 878 {
GregCr 0:03ec2f3bde8c 879 bool SyncError :1; //!< SyncWord error on last packet
GregCr 0:03ec2f3bde8c 880 bool LengthError :1; //!< Length error on last packet
GregCr 0:03ec2f3bde8c 881 bool CrcError :1; //!< CRC error on last packet
GregCr 0:03ec2f3bde8c 882 bool AbortError :1; //!< Abort error on last packet
GregCr 0:03ec2f3bde8c 883 bool HeaderReceived :1; //!< Header received on last packet
GregCr 0:03ec2f3bde8c 884 bool PacketReceived :1; //!< Packet received
GregCr 0:03ec2f3bde8c 885 bool PacketControlerBusy :1; //!< Packet controller busy
GregCr 0:03ec2f3bde8c 886 }ErrorStatus; //!< The error status Byte
GregCr 0:03ec2f3bde8c 887 struct
GregCr 0:03ec2f3bde8c 888 {
GregCr 0:03ec2f3bde8c 889 bool PacketSent :1; //!< Packet sent, only relevant in Tx mode
GregCr 0:03ec2f3bde8c 890 }TxRxStatus; //!< The Tx/Rx status Byte
GregCr 0:03ec2f3bde8c 891 uint8_t SyncAddrStatus :3; //!< The id of the correlator who found the packet
GregCr 0:03ec2f3bde8c 892 }Ble;
GregCr 0:03ec2f3bde8c 893 };
GregCr 0:03ec2f3bde8c 894 }PacketStatus_t;
GregCr 0:03ec2f3bde8c 895
GregCr 0:03ec2f3bde8c 896 /*!
GregCr 0:03ec2f3bde8c 897 * \brief Represents the Rx internal counters values when GFSK or LORA packet type is used
GregCr 0:03ec2f3bde8c 898 */
GregCr 0:03ec2f3bde8c 899 typedef struct
GregCr 0:03ec2f3bde8c 900 {
GregCr 0:03ec2f3bde8c 901 RadioPacketTypes_t packetType; //!< Packet to which the packet status are referring to.
GregCr 0:03ec2f3bde8c 902 union
GregCr 0:03ec2f3bde8c 903 {
GregCr 0:03ec2f3bde8c 904 struct
GregCr 0:03ec2f3bde8c 905 {
GregCr 0:03ec2f3bde8c 906 uint16_t PacketReceived; //!< Number of received packets
GregCr 0:03ec2f3bde8c 907 uint16_t CrcError; //!< Number of CRC errors
GregCr 0:03ec2f3bde8c 908 uint16_t LengthError; //!< Number of length errors
GregCr 0:03ec2f3bde8c 909 uint16_t SyncwordError; //!< Number of sync-word errors
GregCr 0:03ec2f3bde8c 910 }Gfsk;
GregCr 0:03ec2f3bde8c 911 struct
GregCr 0:03ec2f3bde8c 912 {
GregCr 0:03ec2f3bde8c 913 uint16_t PacketReceived; //!< Number of received packets
GregCr 0:03ec2f3bde8c 914 uint16_t CrcError; //!< Number of CRC errors
GregCr 0:03ec2f3bde8c 915 uint16_t HeaderValid; //!< Number of valid headers
GregCr 0:03ec2f3bde8c 916 }LoRa;
GregCr 0:03ec2f3bde8c 917 };
GregCr 0:03ec2f3bde8c 918 }RxCounter_t;
GregCr 0:03ec2f3bde8c 919
GregCr 0:03ec2f3bde8c 920 /*!
GregCr 0:03ec2f3bde8c 921 * \brief Represents a calibration configuration
GregCr 0:03ec2f3bde8c 922 */
GregCr 0:03ec2f3bde8c 923 typedef struct
GregCr 0:03ec2f3bde8c 924 {
GregCr 0:03ec2f3bde8c 925 uint8_t RC64KEnable : 1; //!< Calibrate RC64K clock
GregCr 0:03ec2f3bde8c 926 uint8_t RC13MEnable : 1; //!< Calibrate RC13M clock
GregCr 0:03ec2f3bde8c 927 uint8_t PLLEnable : 1; //!< Calibrate PLL
GregCr 0:03ec2f3bde8c 928 uint8_t ADCPulseEnable : 1; //!< Calibrate ADC Pulse
GregCr 0:03ec2f3bde8c 929 uint8_t ADCBulkNEnable : 1; //!< Calibrate ADC bulkN
GregCr 0:03ec2f3bde8c 930 uint8_t ADCBulkPEnable : 1; //!< Calibrate ADC bulkP
GregCr 0:03ec2f3bde8c 931 }CalibrationParams_t;
GregCr 0:03ec2f3bde8c 932
GregCr 0:03ec2f3bde8c 933 /*!
GregCr 0:03ec2f3bde8c 934 * \brief Represents a sleep mode configuration
GregCr 0:03ec2f3bde8c 935 */
GregCr 0:03ec2f3bde8c 936 typedef struct
GregCr 0:03ec2f3bde8c 937 {
GregCr 0:03ec2f3bde8c 938 uint8_t WakeUpRTC : 1; //!< Get out of sleep mode if wakeup signal received from RTC
GregCr 0:03ec2f3bde8c 939 uint8_t InstructionRamRetention : 1; //!< InstructionRam is conserved during sleep
GregCr 0:03ec2f3bde8c 940 uint8_t DataBufferRetention : 1; //!< Data buffer is conserved during sleep
GregCr 0:03ec2f3bde8c 941 uint8_t DataRamRetention : 1; //!< Data ram is conserved during sleep
GregCr 0:03ec2f3bde8c 942 }SleepParams_t;
GregCr 0:03ec2f3bde8c 943
GregCr 0:03ec2f3bde8c 944 /*!
GregCr 0:03ec2f3bde8c 945 * \brief Represents the SX1280 and its features
GregCr 0:03ec2f3bde8c 946 *
GregCr 0:03ec2f3bde8c 947 * It implements the commands the SX1280 can understands
GregCr 0:03ec2f3bde8c 948 */
GregCr 0:03ec2f3bde8c 949 class SX1280 : public Radio
GregCr 0:03ec2f3bde8c 950 {
GregCr 0:03ec2f3bde8c 951 public:
GregCr 0:03ec2f3bde8c 952 /*!
GregCr 0:03ec2f3bde8c 953 * \brief Instantiates a SX1280 object and provides API functions to communicates with the radio
GregCr 0:03ec2f3bde8c 954 *
GregCr 0:03ec2f3bde8c 955 * \param [in] callbacks Pointer to the callbacks structure defining
GregCr 0:03ec2f3bde8c 956 * all callbacks function pointers
GregCr 0:03ec2f3bde8c 957 */
GregCr 0:03ec2f3bde8c 958 SX1280( RadioCallbacks_t *callbacks ):
GregCr 4:abf14b677777 959 // The class members are value-initialiazed in member-initilaizer list
GregCr 4:abf14b677777 960 Radio( callbacks ), OperatingMode( MODE_STDBY_RC ), PacketType( PACKET_TYPE_NONE ),
GregCr 4:abf14b677777 961 LoRaBandwidth( LORA_BW_1600 ), IrqState( false ), PollingMode( false )
GregCr 0:03ec2f3bde8c 962 {
GregCr 0:03ec2f3bde8c 963 this->dioIrq = &SX1280::OnDioIrq;
GregCr 4:abf14b677777 964
GregCr 4:abf14b677777 965 // Warning: this constructor set the LoRaBandwidth member to a valid
GregCr 4:abf14b677777 966 // value, but it is not related to the actual radio configuration!
GregCr 0:03ec2f3bde8c 967 }
GregCr 0:03ec2f3bde8c 968
GregCr 0:03ec2f3bde8c 969 virtual ~SX1280( )
GregCr 0:03ec2f3bde8c 970 {
GregCr 0:03ec2f3bde8c 971 }
GregCr 0:03ec2f3bde8c 972
GregCr 0:03ec2f3bde8c 973 private:
GregCr 0:03ec2f3bde8c 974 /*!
GregCr 0:03ec2f3bde8c 975 * \brief Holds the internal operating mode of the radio
GregCr 0:03ec2f3bde8c 976 */
GregCr 0:03ec2f3bde8c 977 RadioOperatingModes_t OperatingMode;
GregCr 0:03ec2f3bde8c 978
GregCr 0:03ec2f3bde8c 979 /*!
GregCr 0:03ec2f3bde8c 980 * \brief Stores the current packet type set in the radio
GregCr 0:03ec2f3bde8c 981 */
GregCr 0:03ec2f3bde8c 982 RadioPacketTypes_t PacketType;
GregCr 0:03ec2f3bde8c 983
GregCr 0:03ec2f3bde8c 984 /*!
GregCr 0:03ec2f3bde8c 985 * \brief Stores the current LORA bandwidth set in the radio
GregCr 0:03ec2f3bde8c 986 */
GregCr 0:03ec2f3bde8c 987 RadioLoRaBandwidths_t LoRaBandwidth;
GregCr 0:03ec2f3bde8c 988
GregCr 0:03ec2f3bde8c 989 /*!
GregCr 0:03ec2f3bde8c 990 * \brief Holds a flag raised on radio interrupt
GregCr 0:03ec2f3bde8c 991 */
GregCr 0:03ec2f3bde8c 992 bool IrqState;
GregCr 0:03ec2f3bde8c 993
GregCr 0:03ec2f3bde8c 994 /*!
GregCr 0:03ec2f3bde8c 995 * \brief Hardware DIO IRQ functions
GregCr 0:03ec2f3bde8c 996 */
GregCr 0:03ec2f3bde8c 997 DioIrqHandler dioIrq;
GregCr 0:03ec2f3bde8c 998
GregCr 0:03ec2f3bde8c 999 /*!
GregCr 0:03ec2f3bde8c 1000 * \brief Holds the polling state of the driver
GregCr 0:03ec2f3bde8c 1001 */
GregCr 0:03ec2f3bde8c 1002 bool PollingMode;
GregCr 0:03ec2f3bde8c 1003
GregCr 0:03ec2f3bde8c 1004 /*!
GregCr 0:03ec2f3bde8c 1005 * \brief Compute the two's complement for a register of size lower than
GregCr 0:03ec2f3bde8c 1006 * 32bits
GregCr 0:03ec2f3bde8c 1007 *
GregCr 4:abf14b677777 1008 * \param [in] num The register to be two's complemented
GregCr 4:abf14b677777 1009 * \param [in] bitCnt The position of the sign bit
GregCr 0:03ec2f3bde8c 1010 */
GregCr 0:03ec2f3bde8c 1011 static int32_t complement2( const uint32_t num, const uint8_t bitCnt );
GregCr 0:03ec2f3bde8c 1012
GregCr 0:03ec2f3bde8c 1013 /*!
GregCr 0:03ec2f3bde8c 1014 * \brief Returns the value of LoRa bandwidth from driver's value
GregCr 0:03ec2f3bde8c 1015 *
GregCr 0:03ec2f3bde8c 1016 * The value is returned in Hz so that it can be represented as an integer
GregCr 0:03ec2f3bde8c 1017 * type. Most computation should be done as integer to reduce floating
GregCr 0:03ec2f3bde8c 1018 * point related errors.
GregCr 0:03ec2f3bde8c 1019 *
GregCr 4:abf14b677777 1020 * \retval loRaBw The value of the current bandwidth in Hz
GregCr 0:03ec2f3bde8c 1021 */
GregCr 0:03ec2f3bde8c 1022 int32_t GetLoRaBandwidth( void );
GregCr 0:03ec2f3bde8c 1023
GregCr 0:03ec2f3bde8c 1024 protected:
GregCr 0:03ec2f3bde8c 1025 /*!
GregCr 0:03ec2f3bde8c 1026 * \brief Sets a function to be triggered on radio interrupt
GregCr 0:03ec2f3bde8c 1027 *
GregCr 0:03ec2f3bde8c 1028 * \param [in] irqHandler A pointer to a function to be run on interrupt
GregCr 0:03ec2f3bde8c 1029 * from the radio
GregCr 0:03ec2f3bde8c 1030 */
GregCr 0:03ec2f3bde8c 1031 virtual void IoIrqInit( DioIrqHandler irqHandler ) = 0;
GregCr 0:03ec2f3bde8c 1032
GregCr 0:03ec2f3bde8c 1033 /*!
GregCr 0:03ec2f3bde8c 1034 * \brief DIOs interrupt callback
GregCr 0:03ec2f3bde8c 1035 *
GregCr 0:03ec2f3bde8c 1036 * \remark Called to handle all 3 DIOs pins
GregCr 0:03ec2f3bde8c 1037 */
GregCr 0:03ec2f3bde8c 1038 void OnDioIrq( void );
GregCr 0:03ec2f3bde8c 1039
GregCr 0:03ec2f3bde8c 1040 /*!
GregCr 0:03ec2f3bde8c 1041 * \brief Set the role of the radio during ranging operations
GregCr 0:03ec2f3bde8c 1042 *
GregCr 0:03ec2f3bde8c 1043 * \param [in] role Role of the radio
GregCr 0:03ec2f3bde8c 1044 */
GregCr 0:03ec2f3bde8c 1045 void SetRangingRole( RadioRangingRoles_t role );
GregCr 0:03ec2f3bde8c 1046
GregCr 0:03ec2f3bde8c 1047 public:
GregCr 0:03ec2f3bde8c 1048 /*!
GregCr 0:03ec2f3bde8c 1049 * \brief Initializes the radio driver
GregCr 0:03ec2f3bde8c 1050 */
GregCr 0:03ec2f3bde8c 1051 void Init( void );
GregCr 0:03ec2f3bde8c 1052
GregCr 0:03ec2f3bde8c 1053 /*!
GregCr 0:03ec2f3bde8c 1054 * \brief Set the driver in polling mode.
GregCr 0:03ec2f3bde8c 1055 *
GregCr 0:03ec2f3bde8c 1056 * In polling mode the application is responsible to call ProcessIrqs( ) to
GregCr 0:03ec2f3bde8c 1057 * execute callbacks functions.
GregCr 0:03ec2f3bde8c 1058 * The default mode is Interrupt Mode.
GregCr 0:03ec2f3bde8c 1059 * @code
GregCr 0:03ec2f3bde8c 1060 * // Initializations and callbacks declaration/definition
GregCr 0:03ec2f3bde8c 1061 * radio = SX1280( mosi, miso, sclk, nss, busy, int1, int2, int3, rst, &callbacks );
GregCr 0:03ec2f3bde8c 1062 * radio.Init( );
GregCr 0:03ec2f3bde8c 1063 * radio.SetPollingMode( );
GregCr 0:03ec2f3bde8c 1064 *
GregCr 0:03ec2f3bde8c 1065 * while( true )
GregCr 0:03ec2f3bde8c 1066 * {
GregCr 0:03ec2f3bde8c 1067 * // IRQ processing is automatically done
GregCr 0:03ec2f3bde8c 1068 * radio.ProcessIrqs( ); // <-- here, as well as callback functions
GregCr 0:03ec2f3bde8c 1069 * // calls
GregCr 0:03ec2f3bde8c 1070 * // Do some applicative work
GregCr 0:03ec2f3bde8c 1071 * }
GregCr 0:03ec2f3bde8c 1072 * @endcode
GregCr 0:03ec2f3bde8c 1073 *
GregCr 0:03ec2f3bde8c 1074 * \see SX1280::SetInterruptMode
GregCr 0:03ec2f3bde8c 1075 */
GregCr 0:03ec2f3bde8c 1076 void SetPollingMode( void );
GregCr 0:03ec2f3bde8c 1077
GregCr 0:03ec2f3bde8c 1078 /*!
GregCr 0:03ec2f3bde8c 1079 * \brief Set the driver in interrupt mode.
GregCr 0:03ec2f3bde8c 1080 *
GregCr 0:03ec2f3bde8c 1081 * In interrupt mode, the driver communicate with the radio during the
GregCr 0:03ec2f3bde8c 1082 * interruption by direct calls to ProcessIrqs( ). The main advantage is
GregCr 0:03ec2f3bde8c 1083 * the possibility to have low power application architecture.
GregCr 0:03ec2f3bde8c 1084 * This is the default mode.
GregCr 0:03ec2f3bde8c 1085 * @code
GregCr 0:03ec2f3bde8c 1086 * // Initializations and callbacks declaration/definition
GregCr 0:03ec2f3bde8c 1087 * radio = SX1280( mosi, miso, sclk, nss, busy, int1, int2, int3, rst, &callbacks );
GregCr 0:03ec2f3bde8c 1088 * radio.Init( );
GregCr 0:03ec2f3bde8c 1089 * radio.SetInterruptMode( ); // Optionnal. Driver default behavior
GregCr 0:03ec2f3bde8c 1090 *
GregCr 0:03ec2f3bde8c 1091 * while( true )
GregCr 0:03ec2f3bde8c 1092 * {
GregCr 0:03ec2f3bde8c 1093 * // Do some applicative work
GregCr 0:03ec2f3bde8c 1094 * }
GregCr 0:03ec2f3bde8c 1095 * @endcode
GregCr 0:03ec2f3bde8c 1096 *
GregCr 0:03ec2f3bde8c 1097 * \see SX1280::SetPollingMode
GregCr 0:03ec2f3bde8c 1098 */
GregCr 0:03ec2f3bde8c 1099 void SetInterruptMode( void );
GregCr 0:03ec2f3bde8c 1100
GregCr 0:03ec2f3bde8c 1101 /*!
GregCr 0:03ec2f3bde8c 1102 * \brief Initializes the radio registers to the recommended default values
GregCr 0:03ec2f3bde8c 1103 */
GregCr 0:03ec2f3bde8c 1104 void SetRegistersDefault( void );
GregCr 0:03ec2f3bde8c 1105
GregCr 0:03ec2f3bde8c 1106 /*!
GregCr 0:03ec2f3bde8c 1107 * \brief Returns the current device firmware version
GregCr 0:03ec2f3bde8c 1108 *
GregCr 0:03ec2f3bde8c 1109 * \retval version Firmware version
GregCr 0:03ec2f3bde8c 1110 */
GregCr 0:03ec2f3bde8c 1111 virtual uint16_t GetFirmwareVersion( void );
GregCr 0:03ec2f3bde8c 1112
GregCr 0:03ec2f3bde8c 1113 /*!
GregCr 0:03ec2f3bde8c 1114 * \brief Resets the radio
GregCr 0:03ec2f3bde8c 1115 */
GregCr 0:03ec2f3bde8c 1116 virtual void Reset( void ) = 0;
GregCr 0:03ec2f3bde8c 1117
GregCr 0:03ec2f3bde8c 1118 /*!
GregCr 0:03ec2f3bde8c 1119 * \brief Wake-ups the radio from Sleep mode
GregCr 0:03ec2f3bde8c 1120 */
GregCr 0:03ec2f3bde8c 1121 virtual void Wakeup( void ) = 0;
GregCr 0:03ec2f3bde8c 1122
GregCr 0:03ec2f3bde8c 1123 /*!
GregCr 0:03ec2f3bde8c 1124 * \brief Writes the given command to the radio
GregCr 0:03ec2f3bde8c 1125 *
GregCr 0:03ec2f3bde8c 1126 * \param [in] opcode Command opcode
GregCr 0:03ec2f3bde8c 1127 * \param [in] buffer Command parameters byte array
GregCr 0:03ec2f3bde8c 1128 * \param [in] size Command parameters byte array size
GregCr 0:03ec2f3bde8c 1129 */
GregCr 0:03ec2f3bde8c 1130 virtual void WriteCommand( RadioCommands_t opcode, uint8_t *buffer, uint16_t size ) = 0;
GregCr 0:03ec2f3bde8c 1131
GregCr 0:03ec2f3bde8c 1132 /*!
GregCr 0:03ec2f3bde8c 1133 * \brief Reads the given command from the radio
GregCr 0:03ec2f3bde8c 1134 *
GregCr 0:03ec2f3bde8c 1135 * \param [in] opcode Command opcode
GregCr 0:03ec2f3bde8c 1136 * \param [in] buffer Command parameters byte array
GregCr 0:03ec2f3bde8c 1137 * \param [in] size Command parameters byte array size
GregCr 0:03ec2f3bde8c 1138 */
GregCr 0:03ec2f3bde8c 1139 virtual void ReadCommand( RadioCommands_t opcode, uint8_t *buffer, uint16_t size ) = 0;
GregCr 0:03ec2f3bde8c 1140
GregCr 0:03ec2f3bde8c 1141 /*!
GregCr 0:03ec2f3bde8c 1142 * \brief Writes multiple radio registers starting at address
GregCr 0:03ec2f3bde8c 1143 *
GregCr 0:03ec2f3bde8c 1144 * \param [in] address First Radio register address
GregCr 0:03ec2f3bde8c 1145 * \param [in] buffer Buffer containing the new register's values
GregCr 0:03ec2f3bde8c 1146 * \param [in] size Number of registers to be written
GregCr 0:03ec2f3bde8c 1147 */
GregCr 0:03ec2f3bde8c 1148 virtual void WriteRegister( uint16_t address, uint8_t *buffer, uint16_t size ) = 0;
GregCr 0:03ec2f3bde8c 1149
GregCr 0:03ec2f3bde8c 1150 /*!
GregCr 0:03ec2f3bde8c 1151 * \brief Writes the radio register at the specified address
GregCr 0:03ec2f3bde8c 1152 *
GregCr 0:03ec2f3bde8c 1153 * \param [in] address Register address
GregCr 0:03ec2f3bde8c 1154 * \param [in] value New register value
GregCr 0:03ec2f3bde8c 1155 */
GregCr 0:03ec2f3bde8c 1156 virtual void WriteRegister( uint16_t address, uint8_t value ) = 0;
GregCr 0:03ec2f3bde8c 1157
GregCr 0:03ec2f3bde8c 1158 /*!
GregCr 0:03ec2f3bde8c 1159 * \brief Reads multiple radio registers starting at address
GregCr 0:03ec2f3bde8c 1160 *
GregCr 0:03ec2f3bde8c 1161 * \param [in] address First Radio register address
GregCr 0:03ec2f3bde8c 1162 * \param [out] buffer Buffer where to copy the registers data
GregCr 0:03ec2f3bde8c 1163 * \param [in] size Number of registers to be read
GregCr 0:03ec2f3bde8c 1164 */
GregCr 0:03ec2f3bde8c 1165 virtual void ReadRegister( uint16_t address, uint8_t *buffer, uint16_t size ) = 0;
GregCr 0:03ec2f3bde8c 1166
GregCr 0:03ec2f3bde8c 1167 /*!
GregCr 0:03ec2f3bde8c 1168 * \brief Reads the radio register at the specified address
GregCr 0:03ec2f3bde8c 1169 *
GregCr 0:03ec2f3bde8c 1170 * \param [in] address Register address
GregCr 0:03ec2f3bde8c 1171 *
GregCr 0:03ec2f3bde8c 1172 * \retval data Register value
GregCr 0:03ec2f3bde8c 1173 */
GregCr 0:03ec2f3bde8c 1174 virtual uint8_t ReadRegister( uint16_t address ) = 0;
GregCr 0:03ec2f3bde8c 1175
GregCr 0:03ec2f3bde8c 1176 /*!
GregCr 0:03ec2f3bde8c 1177 * \brief Writes Radio Data Buffer with buffer of size starting at offset.
GregCr 0:03ec2f3bde8c 1178 *
GregCr 0:03ec2f3bde8c 1179 * \param [in] offset Offset where to start writing
GregCr 0:03ec2f3bde8c 1180 * \param [in] buffer Buffer pointer
GregCr 0:03ec2f3bde8c 1181 * \param [in] size Buffer size
GregCr 0:03ec2f3bde8c 1182 */
GregCr 0:03ec2f3bde8c 1183 virtual void WriteBuffer( uint8_t offset, uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:03ec2f3bde8c 1184
GregCr 0:03ec2f3bde8c 1185 /*!
GregCr 0:03ec2f3bde8c 1186 * \brief Reads Radio Data Buffer at offset to buffer of size
GregCr 0:03ec2f3bde8c 1187 *
GregCr 0:03ec2f3bde8c 1188 * \param [in] offset Offset where to start reading
GregCr 0:03ec2f3bde8c 1189 * \param [out] buffer Buffer pointer
GregCr 0:03ec2f3bde8c 1190 * \param [in] size Buffer size
GregCr 0:03ec2f3bde8c 1191 */
GregCr 0:03ec2f3bde8c 1192 virtual void ReadBuffer( uint8_t offset, uint8_t *buffer, uint8_t size ) = 0;
GregCr 0:03ec2f3bde8c 1193
GregCr 0:03ec2f3bde8c 1194 /*!
GregCr 0:03ec2f3bde8c 1195 * \brief Gets the current status of the radio DIOs
GregCr 0:03ec2f3bde8c 1196 *
GregCr 0:03ec2f3bde8c 1197 * \retval status [Bit #3: DIO3, Bit #2: DIO2,
GregCr 0:03ec2f3bde8c 1198 * Bit #1: DIO1, Bit #0: BUSY]
GregCr 0:03ec2f3bde8c 1199 */
GregCr 0:03ec2f3bde8c 1200 virtual uint8_t GetDioStatus( void ) = 0;
GregCr 0:03ec2f3bde8c 1201
GregCr 0:03ec2f3bde8c 1202 /*!
GregCr 0:03ec2f3bde8c 1203 * \brief Gets the current Operation Mode of the Radio
GregCr 0:03ec2f3bde8c 1204 *
GregCr 0:03ec2f3bde8c 1205 * \retval opMode Last operating mode
GregCr 0:03ec2f3bde8c 1206 */
GregCr 0:03ec2f3bde8c 1207 virtual RadioOperatingModes_t GetOpMode( void );
GregCr 0:03ec2f3bde8c 1208
GregCr 0:03ec2f3bde8c 1209 /*!
GregCr 0:03ec2f3bde8c 1210 * \brief Gets the current radio status
GregCr 0:03ec2f3bde8c 1211 *
GregCr 0:03ec2f3bde8c 1212 * \retval status Radio status
GregCr 0:03ec2f3bde8c 1213 */
GregCr 0:03ec2f3bde8c 1214 virtual RadioStatus_t GetStatus( void );
GregCr 0:03ec2f3bde8c 1215
GregCr 0:03ec2f3bde8c 1216 /*!
GregCr 0:03ec2f3bde8c 1217 * \brief Sets the radio in sleep mode
GregCr 0:03ec2f3bde8c 1218 *
GregCr 0:03ec2f3bde8c 1219 * \param [in] sleepConfig The sleep configuration describing data
GregCr 0:03ec2f3bde8c 1220 * retention and RTC wake-up
GregCr 0:03ec2f3bde8c 1221 */
GregCr 0:03ec2f3bde8c 1222 void SetSleep( SleepParams_t sleepConfig );
GregCr 0:03ec2f3bde8c 1223
GregCr 0:03ec2f3bde8c 1224 /*!
GregCr 0:03ec2f3bde8c 1225 * \brief Sets the radio in configuration mode
GregCr 0:03ec2f3bde8c 1226 *
GregCr 0:03ec2f3bde8c 1227 * \param [in] mode The standby mode to put the radio into
GregCr 0:03ec2f3bde8c 1228 */
GregCr 0:03ec2f3bde8c 1229 void SetStandby( RadioStandbyModes_t mode );
GregCr 0:03ec2f3bde8c 1230
GregCr 0:03ec2f3bde8c 1231 /*!
GregCr 0:03ec2f3bde8c 1232 * \brief Sets the radio in FS mode
GregCr 0:03ec2f3bde8c 1233 */
GregCr 0:03ec2f3bde8c 1234 void SetFs( void );
GregCr 0:03ec2f3bde8c 1235
GregCr 0:03ec2f3bde8c 1236 /*!
GregCr 0:03ec2f3bde8c 1237 * \brief Sets the radio in transmission mode
GregCr 0:03ec2f3bde8c 1238 *
GregCr 0:03ec2f3bde8c 1239 * \param [in] timeout Structure describing the transmission timeout value
GregCr 0:03ec2f3bde8c 1240 */
GregCr 0:03ec2f3bde8c 1241 void SetTx( TickTime_t timeout );
GregCr 0:03ec2f3bde8c 1242
GregCr 0:03ec2f3bde8c 1243 /*!
GregCr 0:03ec2f3bde8c 1244 * \brief Sets the radio in reception mode
GregCr 0:03ec2f3bde8c 1245 *
GregCr 0:03ec2f3bde8c 1246 * \param [in] timeout Structure describing the reception timeout value
GregCr 0:03ec2f3bde8c 1247 */
GregCr 0:03ec2f3bde8c 1248 void SetRx( TickTime_t timeout );
GregCr 0:03ec2f3bde8c 1249
GregCr 0:03ec2f3bde8c 1250 /*!
GregCr 0:03ec2f3bde8c 1251 * \brief Sets the Rx duty cycle management parameters
GregCr 0:03ec2f3bde8c 1252 *
GregCr 4:abf14b677777 1253 * \param [in] periodBase Base time for Rx and Sleep TickTime sequences
GregCr 4:abf14b677777 1254 * \param [in] periodBaseCountRx Number of base time for Rx TickTime sequence
GregCr 4:abf14b677777 1255 * \param [in] periodBaseCountSleep Number of base time for Sleep TickTime sequence
GregCr 0:03ec2f3bde8c 1256 */
GregCr 4:abf14b677777 1257 void SetRxDutyCycle( RadioTickSizes_t periodBase, uint16_t periodBaseCountRx, uint16_t periodBaseCountSleep );
GregCr 0:03ec2f3bde8c 1258
GregCr 0:03ec2f3bde8c 1259 /*!
GregCr 0:03ec2f3bde8c 1260 * \brief Sets the radio in CAD mode
GregCr 0:03ec2f3bde8c 1261 *
GregCr 0:03ec2f3bde8c 1262 * \see SX1280::SetCadParams
GregCr 0:03ec2f3bde8c 1263 */
GregCr 0:03ec2f3bde8c 1264 void SetCad( void );
GregCr 0:03ec2f3bde8c 1265
GregCr 0:03ec2f3bde8c 1266 /*!
GregCr 0:03ec2f3bde8c 1267 * \brief Sets the radio in continuous wave transmission mode
GregCr 0:03ec2f3bde8c 1268 */
GregCr 0:03ec2f3bde8c 1269 void SetTxContinuousWave( void );
GregCr 0:03ec2f3bde8c 1270
GregCr 0:03ec2f3bde8c 1271 /*!
GregCr 0:03ec2f3bde8c 1272 * \brief Sets the radio in continuous preamble transmission mode
GregCr 0:03ec2f3bde8c 1273 */
GregCr 0:03ec2f3bde8c 1274 void SetTxContinuousPreamble( void );
GregCr 0:03ec2f3bde8c 1275
GregCr 0:03ec2f3bde8c 1276 /*!
GregCr 0:03ec2f3bde8c 1277 * \brief Sets the radio for the given protocol
GregCr 0:03ec2f3bde8c 1278 *
GregCr 0:03ec2f3bde8c 1279 * \param [in] packetType [PACKET_TYPE_GFSK, PACKET_TYPE_LORA,
GregCr 0:03ec2f3bde8c 1280 * PACKET_TYPE_RANGING, PACKET_TYPE_FLRC,
GregCr 0:03ec2f3bde8c 1281 * PACKET_TYPE_BLE]
GregCr 0:03ec2f3bde8c 1282 *
GregCr 0:03ec2f3bde8c 1283 * \remark This method has to be called before SetRfFrequency,
GregCr 0:03ec2f3bde8c 1284 * SetModulationParams and SetPacketParams
GregCr 0:03ec2f3bde8c 1285 */
GregCr 0:03ec2f3bde8c 1286 void SetPacketType( RadioPacketTypes_t packetType );
GregCr 0:03ec2f3bde8c 1287
GregCr 0:03ec2f3bde8c 1288 /*!
GregCr 0:03ec2f3bde8c 1289 * \brief Gets the current radio protocol
GregCr 0:03ec2f3bde8c 1290 *
GregCr 4:abf14b677777 1291 * Default behavior return the packet type returned by the radio. To
GregCr 4:abf14b677777 1292 * reduce the SPI activity and return the packet type stored by the
GregCr 4:abf14b677777 1293 * driver, a second optional argument must be provided evaluating as true
GregCr 4:abf14b677777 1294 * boolean
GregCr 4:abf14b677777 1295 *
GregCr 5:b4014e8b7be1 1296 * \param [in] returnLocalCopy If true, the packet type returned is the last
GregCr 5:b4014e8b7be1 1297 * saved in the driver
GregCr 5:b4014e8b7be1 1298 * If false, the packet type is obtained from
GregCr 5:b4014e8b7be1 1299 * the chip
GregCr 5:b4014e8b7be1 1300 * Default: false
GregCr 4:abf14b677777 1301 *
mverdy 8:186e9b6c8627 1302 * \retval packetType [PACKET_TYPE_GENERIC, PACKET_TYPE_LORA,
GregCr 0:03ec2f3bde8c 1303 * PACKET_TYPE_RANGING, PACKET_TYPE_FLRC,
GregCr 0:03ec2f3bde8c 1304 * PACKET_TYPE_BLE, PACKET_TYPE_NONE]
GregCr 0:03ec2f3bde8c 1305 */
GregCr 5:b4014e8b7be1 1306 RadioPacketTypes_t GetPacketType( bool returnLocalCopy = false );
GregCr 0:03ec2f3bde8c 1307
GregCr 0:03ec2f3bde8c 1308 /*!
GregCr 0:03ec2f3bde8c 1309 * \brief Sets the RF frequency
GregCr 0:03ec2f3bde8c 1310 *
GregCr 4:abf14b677777 1311 * \param [in] rfFrequency RF frequency [Hz]
GregCr 0:03ec2f3bde8c 1312 */
GregCr 4:abf14b677777 1313 void SetRfFrequency( uint32_t rfFrequency );
GregCr 0:03ec2f3bde8c 1314
GregCr 0:03ec2f3bde8c 1315 /*!
GregCr 0:03ec2f3bde8c 1316 * \brief Sets the transmission parameters
GregCr 0:03ec2f3bde8c 1317 *
GregCr 0:03ec2f3bde8c 1318 * \param [in] power RF output power [-18..13] dBm
GregCr 0:03ec2f3bde8c 1319 * \param [in] rampTime Transmission ramp up time
GregCr 0:03ec2f3bde8c 1320 */
GregCr 0:03ec2f3bde8c 1321 void SetTxParams( int8_t power, RadioRampTimes_t rampTime );
GregCr 0:03ec2f3bde8c 1322
GregCr 0:03ec2f3bde8c 1323 /*!
GregCr 0:03ec2f3bde8c 1324 * \brief Sets the number of symbols to be used for Channel Activity
GregCr 0:03ec2f3bde8c 1325 * Detection operation
GregCr 0:03ec2f3bde8c 1326 *
GregCr 0:03ec2f3bde8c 1327 * \param [in] cadSymbolNum The number of symbol to use for Channel Activity
GregCr 4:abf14b677777 1328 * Detection operations [LORA_CAD_01_SYMBOL, LORA_CAD_02_SYMBOLS,
GregCr 4:abf14b677777 1329 * LORA_CAD_04_SYMBOLS, LORA_CAD_08_SYMBOLS, LORA_CAD_16_SYMBOLS]
GregCr 0:03ec2f3bde8c 1330 */
GregCr 0:03ec2f3bde8c 1331 void SetCadParams( RadioLoRaCadSymbols_t cadSymbolNum );
GregCr 0:03ec2f3bde8c 1332
GregCr 0:03ec2f3bde8c 1333 /*!
GregCr 0:03ec2f3bde8c 1334 * \brief Sets the data buffer base address for transmission and reception
GregCr 0:03ec2f3bde8c 1335 *
GregCr 0:03ec2f3bde8c 1336 * \param [in] txBaseAddress Transmission base address
GregCr 0:03ec2f3bde8c 1337 * \param [in] rxBaseAddress Reception base address
GregCr 0:03ec2f3bde8c 1338 */
GregCr 0:03ec2f3bde8c 1339 void SetBufferBaseAddresses( uint8_t txBaseAddress, uint8_t rxBaseAddress );
GregCr 0:03ec2f3bde8c 1340
GregCr 0:03ec2f3bde8c 1341 /*!
GregCr 0:03ec2f3bde8c 1342 * \brief Set the modulation parameters
GregCr 0:03ec2f3bde8c 1343 *
GregCr 0:03ec2f3bde8c 1344 * \param [in] modParams A structure describing the modulation parameters
GregCr 0:03ec2f3bde8c 1345 */
GregCr 0:03ec2f3bde8c 1346 void SetModulationParams( ModulationParams_t *modParams );
GregCr 0:03ec2f3bde8c 1347
GregCr 0:03ec2f3bde8c 1348 /*!
GregCr 0:03ec2f3bde8c 1349 * \brief Sets the packet parameters
GregCr 0:03ec2f3bde8c 1350 *
GregCr 0:03ec2f3bde8c 1351 * \param [in] packetParams A structure describing the packet parameters
GregCr 0:03ec2f3bde8c 1352 */
GregCr 0:03ec2f3bde8c 1353 void SetPacketParams( PacketParams_t *packetParams );
GregCr 0:03ec2f3bde8c 1354
GregCr 0:03ec2f3bde8c 1355 /*!
GregCr 0:03ec2f3bde8c 1356 * \brief Gets the last received packet buffer status
GregCr 0:03ec2f3bde8c 1357 *
GregCr 4:abf14b677777 1358 * \param [out] rxPayloadLength Last received packet payload length
GregCr 4:abf14b677777 1359 * \param [out] rxStartBufferPointer Last received packet buffer address pointer
GregCr 0:03ec2f3bde8c 1360 */
GregCr 4:abf14b677777 1361 void GetRxBufferStatus( uint8_t *rxPayloadLength, uint8_t *rxStartBufferPointer );
GregCr 0:03ec2f3bde8c 1362
GregCr 0:03ec2f3bde8c 1363 /*!
GregCr 11:d60df50e108f 1364 * \brief Gets the last received packet status
GregCr 11:d60df50e108f 1365 *
GregCr 11:d60df50e108f 1366 * The packet status structure returned depends on the modem type selected
GregCr 11:d60df50e108f 1367 *
GregCr 11:d60df50e108f 1368 * \see PacketStatus_t for the description of availabled informations
GregCr 0:03ec2f3bde8c 1369 *
GregCr 4:abf14b677777 1370 * \param [out] packetStatus A structure of packet status
GregCr 0:03ec2f3bde8c 1371 */
GregCr 4:abf14b677777 1372 void GetPacketStatus( PacketStatus_t *packetStatus );
GregCr 0:03ec2f3bde8c 1373
GregCr 0:03ec2f3bde8c 1374 /*!
GregCr 0:03ec2f3bde8c 1375 * \brief Returns the instantaneous RSSI value for the last packet received
GregCr 0:03ec2f3bde8c 1376 *
GregCr 0:03ec2f3bde8c 1377 * \retval rssiInst Instantaneous RSSI
GregCr 0:03ec2f3bde8c 1378 */
GregCr 0:03ec2f3bde8c 1379 int8_t GetRssiInst( void );
GregCr 0:03ec2f3bde8c 1380
GregCr 0:03ec2f3bde8c 1381 /*!
GregCr 0:03ec2f3bde8c 1382 * \brief Sets the IRQ mask and DIO masks
GregCr 0:03ec2f3bde8c 1383 *
GregCr 0:03ec2f3bde8c 1384 * \param [in] irqMask General IRQ mask
GregCr 0:03ec2f3bde8c 1385 * \param [in] dio1Mask DIO1 mask
GregCr 0:03ec2f3bde8c 1386 * \param [in] dio2Mask DIO2 mask
GregCr 0:03ec2f3bde8c 1387 * \param [in] dio3Mask DIO3 mask
GregCr 0:03ec2f3bde8c 1388 */
GregCr 0:03ec2f3bde8c 1389 void SetDioIrqParams( uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask, uint16_t dio3Mask );
GregCr 0:03ec2f3bde8c 1390
GregCr 0:03ec2f3bde8c 1391 /*!
GregCr 0:03ec2f3bde8c 1392 * \brief Returns the current IRQ status
GregCr 0:03ec2f3bde8c 1393 *
GregCr 0:03ec2f3bde8c 1394 * \retval irqStatus IRQ status
GregCr 0:03ec2f3bde8c 1395 */
GregCr 0:03ec2f3bde8c 1396 uint16_t GetIrqStatus( void );
GregCr 0:03ec2f3bde8c 1397
GregCr 0:03ec2f3bde8c 1398 /*!
GregCr 0:03ec2f3bde8c 1399 * \brief Clears the IRQs
GregCr 0:03ec2f3bde8c 1400 *
GregCr 4:abf14b677777 1401 * \param [in] irqMask IRQ(s) to be cleared
GregCr 0:03ec2f3bde8c 1402 */
GregCr 4:abf14b677777 1403 void ClearIrqStatus( uint16_t irqMask );
GregCr 0:03ec2f3bde8c 1404
GregCr 0:03ec2f3bde8c 1405 /*!
GregCr 0:03ec2f3bde8c 1406 * \brief Calibrates the given radio block
GregCr 0:03ec2f3bde8c 1407 *
GregCr 0:03ec2f3bde8c 1408 * \param [in] calibParam The description of blocks to be calibrated
GregCr 0:03ec2f3bde8c 1409 */
GregCr 0:03ec2f3bde8c 1410 void Calibrate( CalibrationParams_t calibParam );
GregCr 0:03ec2f3bde8c 1411
GregCr 0:03ec2f3bde8c 1412 /*!
GregCr 0:03ec2f3bde8c 1413 * \brief Sets the power regulators operating mode
GregCr 0:03ec2f3bde8c 1414 *
GregCr 0:03ec2f3bde8c 1415 * \param [in] mode [0: LDO, 1:DC_DC]
GregCr 0:03ec2f3bde8c 1416 */
GregCr 0:03ec2f3bde8c 1417 void SetRegulatorMode( RadioRegulatorModes_t mode );
GregCr 0:03ec2f3bde8c 1418
GregCr 0:03ec2f3bde8c 1419 /*!
GregCr 0:03ec2f3bde8c 1420 * \brief Saves the current selected modem configuration into data RAM
GregCr 0:03ec2f3bde8c 1421 */
GregCr 0:03ec2f3bde8c 1422 void SetSaveContext( void );
GregCr 0:03ec2f3bde8c 1423
GregCr 0:03ec2f3bde8c 1424 /*!
GregCr 0:03ec2f3bde8c 1425 * \brief Sets the chip to automatically send a packet after the end of a packet reception
GregCr 0:03ec2f3bde8c 1426 *
GregCr 0:03ec2f3bde8c 1427 * \remark The offset is automatically compensated inside the function
GregCr 0:03ec2f3bde8c 1428 *
GregCr 0:03ec2f3bde8c 1429 * \param [in] time The delay in us after which a Tx is done
GregCr 0:03ec2f3bde8c 1430 */
GregCr 0:03ec2f3bde8c 1431 void SetAutoTx( uint16_t time );
GregCr 0:03ec2f3bde8c 1432
GregCr 0:03ec2f3bde8c 1433 /*!
GregCr 11:d60df50e108f 1434 * \brief Stop the chip to automatically send a packet after the end of a packet reception
GregCr 11:d60df50e108f 1435 * if previously activated with SX1280::SetAutoTx command
GregCr 11:d60df50e108f 1436 */
GregCr 11:d60df50e108f 1437 void StopAutoTx( void );
GregCr 11:d60df50e108f 1438
GregCr 11:d60df50e108f 1439 /*!
GregCr 0:03ec2f3bde8c 1440 * \brief Sets the chip to stay in FS mode after sending a packet
GregCr 0:03ec2f3bde8c 1441 *
GregCr 0:03ec2f3bde8c 1442 * \param [in] enableAutoFs Turn on auto FS
GregCr 0:03ec2f3bde8c 1443 */
GregCr 0:03ec2f3bde8c 1444 void SetAutoFs( bool enableAutoFs );
GregCr 0:03ec2f3bde8c 1445
GregCr 0:03ec2f3bde8c 1446 /*!
GregCr 0:03ec2f3bde8c 1447 * \brief Enables or disables long preamble detection mode
GregCr 0:03ec2f3bde8c 1448 *
GregCr 0:03ec2f3bde8c 1449 * \param [in] enable Turn on long preamble mode
GregCr 0:03ec2f3bde8c 1450 */
GregCr 0:03ec2f3bde8c 1451 void SetLongPreamble( bool enable );
GregCr 0:03ec2f3bde8c 1452
GregCr 0:03ec2f3bde8c 1453 /*!
GregCr 0:03ec2f3bde8c 1454 * \brief Saves the payload to be send in the radio buffer
GregCr 0:03ec2f3bde8c 1455 *
GregCr 0:03ec2f3bde8c 1456 * \param [in] payload A pointer to the payload
GregCr 0:03ec2f3bde8c 1457 * \param [in] size The size of the payload
GregCr 0:03ec2f3bde8c 1458 * \param [in] offset The address in FIFO where writting first byte (default = 0x00)
GregCr 0:03ec2f3bde8c 1459 */
GregCr 0:03ec2f3bde8c 1460 void SetPayload( uint8_t *payload, uint8_t size, uint8_t offset = 0x00 );
GregCr 0:03ec2f3bde8c 1461
GregCr 0:03ec2f3bde8c 1462 /*!
GregCr 0:03ec2f3bde8c 1463 * \brief Reads the payload received. If the received payload is longer
GregCr 0:03ec2f3bde8c 1464 * than maxSize, then the method returns 1 and do not set size and payload.
GregCr 0:03ec2f3bde8c 1465 *
GregCr 0:03ec2f3bde8c 1466 * \param [out] payload A pointer to a buffer into which the payload will be copied
GregCr 0:03ec2f3bde8c 1467 * \param [out] size A pointer to the size of the payload received
GregCr 0:03ec2f3bde8c 1468 * \param [in] maxSize The maximal size allowed to copy into the buffer
GregCr 0:03ec2f3bde8c 1469 */
GregCr 0:03ec2f3bde8c 1470 uint8_t GetPayload( uint8_t *payload, uint8_t *size, uint8_t maxSize );
GregCr 0:03ec2f3bde8c 1471
GregCr 0:03ec2f3bde8c 1472 /*!
GregCr 0:03ec2f3bde8c 1473 * \brief Sends a payload
GregCr 0:03ec2f3bde8c 1474 *
GregCr 0:03ec2f3bde8c 1475 * \param [in] payload A pointer to the payload to send
GregCr 0:03ec2f3bde8c 1476 * \param [in] size The size of the payload to send
GregCr 0:03ec2f3bde8c 1477 * \param [in] timeout The timeout for Tx operation
GregCr 0:03ec2f3bde8c 1478 * \param [in] offset The address in FIFO where writting first byte (default = 0x00)
GregCr 0:03ec2f3bde8c 1479 */
GregCr 0:03ec2f3bde8c 1480 void SendPayload( uint8_t *payload, uint8_t size, TickTime_t timeout, uint8_t offset = 0x00 );
GregCr 0:03ec2f3bde8c 1481
GregCr 0:03ec2f3bde8c 1482 /*!
GregCr 0:03ec2f3bde8c 1483 * \brief Sets the Sync Word given by index used in GFSK, FLRC and BLE protocols
GregCr 0:03ec2f3bde8c 1484 *
GregCr 0:03ec2f3bde8c 1485 * \remark 5th byte isn't used in FLRC and BLE protocols
GregCr 0:03ec2f3bde8c 1486 *
GregCr 0:03ec2f3bde8c 1487 * \param [in] syncWordIdx Index of SyncWord to be set [1..3]
GregCr 0:03ec2f3bde8c 1488 * \param [in] syncWord SyncWord bytes ( 5 bytes )
GregCr 0:03ec2f3bde8c 1489 *
GregCr 0:03ec2f3bde8c 1490 * \retval status [0: OK, 1: NOK]
GregCr 0:03ec2f3bde8c 1491 */
GregCr 0:03ec2f3bde8c 1492 uint8_t SetSyncWord( uint8_t syncWordIdx, uint8_t *syncWord );
GregCr 0:03ec2f3bde8c 1493
GregCr 0:03ec2f3bde8c 1494 /*!
GregCr 0:03ec2f3bde8c 1495 * \brief Defines how many error bits are tolerated in sync word detection
GregCr 0:03ec2f3bde8c 1496 *
GregCr 0:03ec2f3bde8c 1497 * \param [in] errorBits Number of error bits supported to validate the Sync word detection
GregCr 0:03ec2f3bde8c 1498 * ( default is 4 bit, minimum is 1 bit )
GregCr 0:03ec2f3bde8c 1499 */
GregCr 0:03ec2f3bde8c 1500 void SetSyncWordErrorTolerance( uint8_t errorBits );
GregCr 0:03ec2f3bde8c 1501
GregCr 0:03ec2f3bde8c 1502 /*!
GregCr 0:03ec2f3bde8c 1503 * \brief Sets the Initial value for the LFSR used for the CRC calculation
GregCr 0:03ec2f3bde8c 1504 *
GregCr 0:03ec2f3bde8c 1505 * \param [in] seed Initial LFSR value ( 4 bytes )
GregCr 0:03ec2f3bde8c 1506 *
GregCr 4:abf14b677777 1507 * \retval updated [0: failure, 1: success]
GregCr 4:abf14b677777 1508 *
GregCr 0:03ec2f3bde8c 1509 */
GregCr 4:abf14b677777 1510 uint8_t SetCrcSeed( uint8_t *seed );
GregCr 0:03ec2f3bde8c 1511
GregCr 0:03ec2f3bde8c 1512 /*!
mverdy 10:c1b368a5052f 1513 * \brief Set the Access Address field of BLE packet
mverdy 10:c1b368a5052f 1514 *
mverdy 10:c1b368a5052f 1515 * \param [in] accessAddress The access address to be used for next BLE packet sent
mverdy 10:c1b368a5052f 1516 *
mverdy 10:c1b368a5052f 1517 * \see SX1280::SetBleAdvertizerAccessAddress
mverdy 10:c1b368a5052f 1518 */
mverdy 10:c1b368a5052f 1519 void SetBleAccessAddress( uint32_t accessAddress );
mverdy 10:c1b368a5052f 1520
mverdy 10:c1b368a5052f 1521 /*!
mverdy 10:c1b368a5052f 1522 * \brief Set the Access Address for Advertizer BLE packets
mverdy 10:c1b368a5052f 1523 *
mverdy 10:c1b368a5052f 1524 * All advertizer BLE packets must use a particular value for Access
mverdy 10:c1b368a5052f 1525 * Address field. This method sets it.
mverdy 10:c1b368a5052f 1526 *
mverdy 10:c1b368a5052f 1527 * \see SX1280::SetBleAccessAddress
mverdy 10:c1b368a5052f 1528 */
mverdy 10:c1b368a5052f 1529 void SetBleAdvertizerAccessAddress( void );
mverdy 10:c1b368a5052f 1530
mverdy 10:c1b368a5052f 1531 /*!
GregCr 0:03ec2f3bde8c 1532 * \brief Sets the seed used for the CRC calculation
GregCr 0:03ec2f3bde8c 1533 *
GregCr 0:03ec2f3bde8c 1534 * \param [in] polynomial The seed value
GregCr 0:03ec2f3bde8c 1535 *
GregCr 0:03ec2f3bde8c 1536 */
GregCr 0:03ec2f3bde8c 1537 void SetCrcPolynomial( uint16_t polynomial );
GregCr 0:03ec2f3bde8c 1538
GregCr 0:03ec2f3bde8c 1539 /*!
GregCr 0:03ec2f3bde8c 1540 * \brief Sets the Initial value of the LFSR used for the whitening in GFSK, FLRC and BLE protocols
GregCr 0:03ec2f3bde8c 1541 *
GregCr 0:03ec2f3bde8c 1542 * \param [in] seed Initial LFSR value
GregCr 0:03ec2f3bde8c 1543 */
GregCr 0:03ec2f3bde8c 1544 void SetWhiteningSeed( uint8_t seed );
mverdy 12:c4f110f3fe3e 1545
mverdy 12:c4f110f3fe3e 1546 /*!
mverdy 12:c4f110f3fe3e 1547 * \brief Enable manual gain control and disable AGC
mverdy 12:c4f110f3fe3e 1548 *
mverdy 12:c4f110f3fe3e 1549 * \see SX1280::SetManualGainValue, SX1280::DisableManualGain
mverdy 12:c4f110f3fe3e 1550 */
mverdy 12:c4f110f3fe3e 1551 void EnableManualGain( void );
mverdy 12:c4f110f3fe3e 1552
mverdy 12:c4f110f3fe3e 1553 /*!
mverdy 12:c4f110f3fe3e 1554 * \brief Disable the manual gain control and enable AGC
mverdy 12:c4f110f3fe3e 1555 *
mverdy 12:c4f110f3fe3e 1556 * \see SX1280::EnableManualGain
mverdy 12:c4f110f3fe3e 1557 */
mverdy 12:c4f110f3fe3e 1558 void DisableManualGain( void );
mverdy 12:c4f110f3fe3e 1559
mverdy 12:c4f110f3fe3e 1560 /*!
mverdy 12:c4f110f3fe3e 1561 * \brief Set the gain for the AGC
mverdy 12:c4f110f3fe3e 1562 *
mverdy 12:c4f110f3fe3e 1563 * SX1280::EnableManualGain must be called before using this method
mverdy 12:c4f110f3fe3e 1564 *
mverdy 12:c4f110f3fe3e 1565 * \param [in] gain The value of gain to set, refer to datasheet for value meaning
mverdy 12:c4f110f3fe3e 1566 *
mverdy 12:c4f110f3fe3e 1567 * \see SX1280::EnableManualGain, SX1280::DisableManualGain
mverdy 12:c4f110f3fe3e 1568 */
mverdy 12:c4f110f3fe3e 1569 void SetManualGainValue( uint8_t gain );
mverdy 12:c4f110f3fe3e 1570
mverdy 12:c4f110f3fe3e 1571 /*!
mverdy 12:c4f110f3fe3e 1572 * \brief Configure the LNA regime of operation
mverdy 12:c4f110f3fe3e 1573 *
mverdy 12:c4f110f3fe3e 1574 * \param [in] lnaSetting The LNA setting. Possible values are
mverdy 12:c4f110f3fe3e 1575 * LNA_LOW_POWER_MODE and
mverdy 12:c4f110f3fe3e 1576 * LNA_HIGH_SENSITIVITY_MODE
mverdy 12:c4f110f3fe3e 1577 */
mverdy 12:c4f110f3fe3e 1578 void SetLNAGainSetting( const RadioLnaSettings_t lnaSetting );
GregCr 0:03ec2f3bde8c 1579
GregCr 0:03ec2f3bde8c 1580 /*!
GregCr 0:03ec2f3bde8c 1581 * \brief Sets the number of bits used to check that ranging request match ranging ID
GregCr 0:03ec2f3bde8c 1582 *
GregCr 0:03ec2f3bde8c 1583 * \param [in] length [0: 8 bits, 1: 16 bits,
GregCr 0:03ec2f3bde8c 1584 * 2: 24 bits, 3: 32 bits]
GregCr 0:03ec2f3bde8c 1585 */
GregCr 0:03ec2f3bde8c 1586 void SetRangingIdLength( RadioRangingIdCheckLengths_t length );
GregCr 0:03ec2f3bde8c 1587
GregCr 0:03ec2f3bde8c 1588 /*!
GregCr 0:03ec2f3bde8c 1589 * \brief Sets ranging device id
GregCr 0:03ec2f3bde8c 1590 *
GregCr 0:03ec2f3bde8c 1591 * \param [in] address Device address
GregCr 0:03ec2f3bde8c 1592 */
GregCr 0:03ec2f3bde8c 1593 void SetDeviceRangingAddress( uint32_t address );
GregCr 0:03ec2f3bde8c 1594
GregCr 0:03ec2f3bde8c 1595 /*!
GregCr 0:03ec2f3bde8c 1596 * \brief Sets the device id to ping in a ranging request
GregCr 0:03ec2f3bde8c 1597 *
GregCr 0:03ec2f3bde8c 1598 * \param [in] address Address of the device to ping
GregCr 0:03ec2f3bde8c 1599 */
GregCr 0:03ec2f3bde8c 1600 void SetRangingRequestAddress( uint32_t address );
GregCr 0:03ec2f3bde8c 1601
GregCr 0:03ec2f3bde8c 1602 /*!
GregCr 0:03ec2f3bde8c 1603 * \brief Return the ranging result value
GregCr 0:03ec2f3bde8c 1604 *
GregCr 0:03ec2f3bde8c 1605 * \param [in] resultType Specifies the type of result.
GregCr 0:03ec2f3bde8c 1606 * [0: RAW, 1: Averaged,
GregCr 0:03ec2f3bde8c 1607 * 2: De-biased, 3:Filtered]
GregCr 0:03ec2f3bde8c 1608 *
GregCr 0:03ec2f3bde8c 1609 * \retval ranging The ranging measure filtered according to resultType [m]
GregCr 0:03ec2f3bde8c 1610 */
GregCr 0:03ec2f3bde8c 1611 double GetRangingResult( RadioRangingResultTypes_t resultType );
GregCr 0:03ec2f3bde8c 1612
GregCr 0:03ec2f3bde8c 1613 /*!
mverdy 12:c4f110f3fe3e 1614 * \brief Return the last ranging result power indicator
mverdy 12:c4f110f3fe3e 1615 *
mverdy 12:c4f110f3fe3e 1616 * The value returned is not an absolute power measurement. It is
mverdy 12:c4f110f3fe3e 1617 * a relative power measurement.
mverdy 12:c4f110f3fe3e 1618 *
mverdy 12:c4f110f3fe3e 1619 * \retval deltaThreshold A relative power indicator
mverdy 12:c4f110f3fe3e 1620 */
mverdy 12:c4f110f3fe3e 1621 uint8_t GetRangingPowerDeltaThresholdIndicator( void );
mverdy 12:c4f110f3fe3e 1622
mverdy 12:c4f110f3fe3e 1623
mverdy 12:c4f110f3fe3e 1624
mverdy 12:c4f110f3fe3e 1625 /*!
GregCr 0:03ec2f3bde8c 1626 * \brief Sets the standard processing delay between Master and Slave
GregCr 0:03ec2f3bde8c 1627 *
GregCr 0:03ec2f3bde8c 1628 * \param [in] cal RxTx delay offset for correcting ranging bias.
GregCr 0:03ec2f3bde8c 1629 *
GregCr 0:03ec2f3bde8c 1630 * The calibration value reflects the group delay of the radio front end and
GregCr 0:03ec2f3bde8c 1631 * must be re-performed for each new SX1280 PCB design. The value is obtained
GregCr 0:03ec2f3bde8c 1632 * empirically by either conducted measurement in a known electrical length
GregCr 0:03ec2f3bde8c 1633 * coaxial RF cable (where the design is connectorised) or by radiated
GregCr 0:03ec2f3bde8c 1634 * measurement, at a known distance, where an antenna is present.
GregCr 0:03ec2f3bde8c 1635 * The result of the calibration process is that the SX1280 ranging result
GregCr 0:03ec2f3bde8c 1636 * accurately reflects the physical range, the calibration procedure therefore
GregCr 0:03ec2f3bde8c 1637 * removes the average timing error from the time-of-flight measurement for a
GregCr 0:03ec2f3bde8c 1638 * given design.
GregCr 0:03ec2f3bde8c 1639 *
GregCr 0:03ec2f3bde8c 1640 * The values are Spreading Factor dependents, and depend also of the board
GregCr 0:03ec2f3bde8c 1641 * design.
GregCr 0:03ec2f3bde8c 1642 */
GregCr 0:03ec2f3bde8c 1643 void SetRangingCalibration( uint16_t cal );
GregCr 0:03ec2f3bde8c 1644
GregCr 0:03ec2f3bde8c 1645 /*!
GregCr 0:03ec2f3bde8c 1646 * \brief Clears the ranging filter
GregCr 0:03ec2f3bde8c 1647 */
GregCr 0:03ec2f3bde8c 1648 void RangingClearFilterResult( void );
GregCr 0:03ec2f3bde8c 1649
GregCr 0:03ec2f3bde8c 1650 /*!
GregCr 0:03ec2f3bde8c 1651 * \brief Set the number of samples considered in the built-in filter
GregCr 0:03ec2f3bde8c 1652 *
GregCr 0:03ec2f3bde8c 1653 * \param [in] numSample The number of samples to use built-in filter
GregCr 0:03ec2f3bde8c 1654 * [8..255]
GregCr 0:03ec2f3bde8c 1655 *
GregCr 0:03ec2f3bde8c 1656 * \remark Value inferior to 8 will be silently set to 8
GregCr 0:03ec2f3bde8c 1657 */
GregCr 0:03ec2f3bde8c 1658 void RangingSetFilterNumSamples( uint8_t numSample );
GregCr 0:03ec2f3bde8c 1659
GregCr 0:03ec2f3bde8c 1660 /*!
GregCr 0:03ec2f3bde8c 1661 * \brief Return the Estimated Frequency Error in LORA and RANGING operations
GregCr 0:03ec2f3bde8c 1662 *
GregCr 0:03ec2f3bde8c 1663 * \retval efe The estimated frequency error [Hz]
GregCr 0:03ec2f3bde8c 1664 */
GregCr 0:03ec2f3bde8c 1665 double GetFrequencyError( );
GregCr 0:03ec2f3bde8c 1666
GregCr 0:03ec2f3bde8c 1667 /*!
GregCr 0:03ec2f3bde8c 1668 * \brief Process the analysis of radio IRQs and calls callback functions
GregCr 0:03ec2f3bde8c 1669 * depending on radio state
GregCr 0:03ec2f3bde8c 1670 */
GregCr 0:03ec2f3bde8c 1671 void ProcessIrqs( void );
GregCr 4:abf14b677777 1672
GregCr 4:abf14b677777 1673 /*!
GregCr 4:abf14b677777 1674 * \brief Force the preamble length in GFSK and BLE mode
GregCr 4:abf14b677777 1675 *
GregCr 4:abf14b677777 1676 * \param [in] preambleLength The desired preamble length
GregCr 4:abf14b677777 1677 */
GregCr 4:abf14b677777 1678 void ForcePreambleLength( RadioPreambleLengths_t preambleLength );
GregCr 0:03ec2f3bde8c 1679 };
GregCr 0:03ec2f3bde8c 1680
GregCr 0:03ec2f3bde8c 1681 #endif // __SX1280_H__