sx126x.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813
  1. /*!
  2. * \file sx126x.c
  3. *
  4. * \brief SX126x driver implementation
  5. *
  6. * \copyright Revised BSD License, see section \ref LICENSE.
  7. *
  8. * \code
  9. * ______ _
  10. * / _____) _ | |
  11. * ( (____ _____ ____ _| |_ _____ ____| |__
  12. * \____ \| ___ | (_ _) ___ |/ ___) _ \
  13. * _____) ) ____| | | || |_| ____( (___| | | |
  14. * (______/|_____)_|_|_| \__)_____)\____)_| |_|
  15. * (C)2013-2017 Semtech
  16. *
  17. * \endcode
  18. *
  19. * \author Miguel Luis ( Semtech )
  20. *
  21. * \author Gregory Cristian ( Semtech )
  22. */
  23. #include <string.h>
  24. #include "radio.h"
  25. #include "delay.h"
  26. #include "sx126x.h"
  27. #include "sx126x_board.h"
  28. /*!
  29. * \brief Internal frequency of the radio
  30. */
  31. #define SX126X_XTAL_FREQ 32000000UL
  32. /*!
  33. * \brief Scaling factor used to perform fixed-point operations
  34. */
  35. #define SX126X_PLL_STEP_SHIFT_AMOUNT ( 14 )
  36. /*!
  37. * \brief PLL step - scaled with SX126X_PLL_STEP_SHIFT_AMOUNT
  38. */
  39. #define SX126X_PLL_STEP_SCALED ( SX126X_XTAL_FREQ >> ( 25 - SX126X_PLL_STEP_SHIFT_AMOUNT ) )
  40. /*!
  41. * \brief Maximum value for parameter symbNum in \ref SX126xSetLoRaSymbNumTimeout
  42. */
  43. #define SX126X_MAX_LORA_SYMB_NUM_TIMEOUT 248
  44. /*!
  45. * \brief Radio registers definition
  46. */
  47. typedef struct
  48. {
  49. uint16_t Addr; //!< The address of the register
  50. uint8_t Value; //!< The value of the register
  51. }RadioRegisters_t;
  52. /*!
  53. * \brief Stores the current packet type set in the radio
  54. */
  55. static RadioPacketTypes_t PacketType;
  56. /*!
  57. * \brief Stores the current packet header type set in the radio
  58. */
  59. static volatile RadioLoRaPacketLengthsMode_t LoRaHeaderType;
  60. /*!
  61. * \brief Stores the last frequency error measured on LoRa received packet
  62. */
  63. volatile uint32_t FrequencyError = 0;
  64. /*!
  65. * \brief Hold the status of the Image calibration
  66. */
  67. static bool ImageCalibrated = false;
  68. /*!
  69. * \brief Get the number of PLL steps for a given frequency in Hertz
  70. *
  71. * \param [in] freqInHz Frequency in Hertz
  72. *
  73. * \returns Number of PLL steps
  74. */
  75. static uint32_t SX126xConvertFreqInHzToPllStep( uint32_t freqInHz );
  76. /*
  77. * SX126x DIO IRQ callback functions prototype
  78. */
  79. /*!
  80. * \brief DIO 0 IRQ callback
  81. */
  82. void SX126xOnDioIrq( void );
  83. /*!
  84. * \brief DIO 0 IRQ callback
  85. */
  86. void SX126xSetPollingMode( void );
  87. /*!
  88. * \brief DIO 0 IRQ callback
  89. */
  90. void SX126xSetInterruptMode( void );
  91. /*
  92. * \brief Process the IRQ if handled by the driver
  93. */
  94. void SX126xProcessIrqs( void );
  95. void SX126xInit( DioIrqHandler dioIrq )
  96. {
  97. SX126xReset( );
  98. SX126xIoIrqInit( dioIrq );
  99. SX126xWakeup( );
  100. SX126xSetStandby( STDBY_RC );
  101. // Initialize TCXO control
  102. SX126xIoTcxoInit( );
  103. // Initialize RF switch control
  104. SX126xIoRfSwitchInit( );
  105. SX126xSetOperatingMode( MODE_STDBY_RC );
  106. }
  107. void SX126xCheckDeviceReady( void )
  108. {
  109. if( ( SX126xGetOperatingMode( ) == MODE_SLEEP ) || ( SX126xGetOperatingMode( ) == MODE_RX_DC ) )
  110. {
  111. SX126xWakeup( );
  112. // Switch is turned off when device is in sleep mode and turned on is all other modes
  113. SX126xAntSwOn( );
  114. }
  115. SX126xWaitOnBusy( );
  116. }
  117. void SX126xSetPayload( uint8_t *payload, uint8_t size )
  118. {
  119. SX126xWriteBuffer( 0x00, payload, size );
  120. }
  121. uint8_t SX126xGetPayload( uint8_t *buffer, uint8_t *size, uint8_t maxSize )
  122. {
  123. uint8_t offset = 0;
  124. SX126xGetRxBufferStatus( size, &offset );
  125. if( *size > maxSize )
  126. {
  127. return 1;
  128. }
  129. SX126xReadBuffer( offset, buffer, *size );
  130. return 0;
  131. }
  132. void SX126xSendPayload( uint8_t *payload, uint8_t size, uint32_t timeout )
  133. {
  134. SX126xSetPayload( payload, size );
  135. SX126xSetTx( timeout );
  136. }
  137. uint8_t SX126xSetSyncWord( uint8_t *syncWord )
  138. {
  139. SX126xWriteRegisters( REG_LR_SYNCWORDBASEADDRESS, syncWord, 8 );
  140. return 0;
  141. }
  142. void SX126xSetCrcSeed( uint16_t seed )
  143. {
  144. uint8_t buf[2];
  145. buf[0] = ( uint8_t )( ( seed >> 8 ) & 0xFF );
  146. buf[1] = ( uint8_t )( seed & 0xFF );
  147. switch( SX126xGetPacketType( ) )
  148. {
  149. case PACKET_TYPE_GFSK:
  150. SX126xWriteRegisters( REG_LR_CRCSEEDBASEADDR, buf, 2 );
  151. break;
  152. default:
  153. break;
  154. }
  155. }
  156. void SX126xSetCrcPolynomial( uint16_t polynomial )
  157. {
  158. uint8_t buf[2];
  159. buf[0] = ( uint8_t )( ( polynomial >> 8 ) & 0xFF );
  160. buf[1] = ( uint8_t )( polynomial & 0xFF );
  161. switch( SX126xGetPacketType( ) )
  162. {
  163. case PACKET_TYPE_GFSK:
  164. SX126xWriteRegisters( REG_LR_CRCPOLYBASEADDR, buf, 2 );
  165. break;
  166. default:
  167. break;
  168. }
  169. }
  170. void SX126xSetWhiteningSeed( uint16_t seed )
  171. {
  172. uint8_t regValue = 0;
  173. switch( SX126xGetPacketType( ) )
  174. {
  175. case PACKET_TYPE_GFSK:
  176. regValue = SX126xReadRegister( REG_LR_WHITSEEDBASEADDR_MSB ) & 0xFE;
  177. regValue = ( ( seed >> 8 ) & 0x01 ) | regValue;
  178. SX126xWriteRegister( REG_LR_WHITSEEDBASEADDR_MSB, regValue ); // only 1 bit.
  179. SX126xWriteRegister( REG_LR_WHITSEEDBASEADDR_LSB, ( uint8_t )seed );
  180. break;
  181. default:
  182. break;
  183. }
  184. }
  185. uint32_t SX126xGetRandom( void )
  186. {
  187. uint32_t number = 0;
  188. uint8_t regAnaLna = 0;
  189. uint8_t regAnaMixer = 0;
  190. regAnaLna = SX126xReadRegister( REG_ANA_LNA );
  191. SX126xWriteRegister( REG_ANA_LNA, regAnaLna & ~( 1 << 0 ) );
  192. regAnaMixer = SX126xReadRegister( REG_ANA_MIXER );
  193. SX126xWriteRegister( REG_ANA_MIXER, regAnaMixer & ~( 1 << 7 ) );
  194. // Set radio in continuous reception
  195. SX126xSetRx( 0xFFFFFF ); // Rx Continuous
  196. SX126xReadRegisters( RANDOM_NUMBER_GENERATORBASEADDR, ( uint8_t* )&number, 4 );
  197. SX126xSetStandby( STDBY_RC );
  198. SX126xWriteRegister( REG_ANA_LNA, regAnaLna );
  199. SX126xWriteRegister( REG_ANA_MIXER, regAnaMixer );
  200. return number;
  201. }
  202. void SX126xSetSleep( SleepParams_t sleepConfig )
  203. {
  204. uint8_t value=0;
  205. SX126xAntSwOff( );
  206. value = ( ( ( uint8_t )sleepConfig.Fields.WarmStart << 2 ) |
  207. ( ( uint8_t )sleepConfig.Fields.Reset << 1 ) |
  208. ( ( uint8_t )sleepConfig.Fields.WakeUpRTC ) );
  209. SX126xWriteCommand( RADIO_SET_SLEEP, &value, 1 );
  210. SX126xSetOperatingMode( MODE_SLEEP );
  211. }
  212. void SX126xSetStandby( RadioStandbyModes_t standbyConfig )
  213. {
  214. SX126xWriteCommand( RADIO_SET_STANDBY, ( uint8_t* )&standbyConfig, 1 );
  215. if( standbyConfig == STDBY_RC )
  216. {
  217. SX126xSetOperatingMode( MODE_STDBY_RC );
  218. }
  219. else
  220. {
  221. SX126xSetOperatingMode( MODE_STDBY_XOSC );
  222. }
  223. }
  224. void SX126xSetFs( void )
  225. {
  226. SX126xWriteCommand( RADIO_SET_FS, 0, 0 );
  227. SX126xSetOperatingMode( MODE_FS );
  228. }
  229. void SX126xSetTx( uint32_t timeout )
  230. {
  231. uint8_t buf[3];
  232. SX126xSetOperatingMode( MODE_TX );
  233. buf[0] = ( uint8_t )( ( timeout >> 16 ) & 0xFF );
  234. buf[1] = ( uint8_t )( ( timeout >> 8 ) & 0xFF );
  235. buf[2] = ( uint8_t )( timeout & 0xFF );
  236. SX126xWriteCommand( RADIO_SET_TX, buf, 3 );
  237. }
  238. void SX126xSetRx( uint32_t timeout )
  239. {
  240. uint8_t buf[3];
  241. SX126xSetOperatingMode( MODE_RX );
  242. buf[0] = ( uint8_t )( ( timeout >> 16 ) & 0xFF );
  243. buf[1] = ( uint8_t )( ( timeout >> 8 ) & 0xFF );
  244. buf[2] = ( uint8_t )( timeout & 0xFF );
  245. SX126xWriteCommand( RADIO_SET_RX, buf, 3 );
  246. }
  247. void SX126xSetRxBoosted( uint32_t timeout )
  248. {
  249. uint8_t buf[3];
  250. SX126xSetOperatingMode( MODE_RX );
  251. SX126xWriteRegister( REG_RX_GAIN, 0x96 ); // max LNA gain, increase current by ~2mA for around ~3dB in sensivity
  252. buf[0] = ( uint8_t )( ( timeout >> 16 ) & 0xFF );
  253. buf[1] = ( uint8_t )( ( timeout >> 8 ) & 0xFF );
  254. buf[2] = ( uint8_t )( timeout & 0xFF );
  255. SX126xWriteCommand( RADIO_SET_RX, buf, 3 );
  256. }
  257. void SX126xSetRxDutyCycle( uint32_t rxTime, uint32_t sleepTime )
  258. {
  259. uint8_t buf[6];
  260. buf[0] = ( uint8_t )( ( rxTime >> 16 ) & 0xFF );
  261. buf[1] = ( uint8_t )( ( rxTime >> 8 ) & 0xFF );
  262. buf[2] = ( uint8_t )( rxTime & 0xFF );
  263. buf[3] = ( uint8_t )( ( sleepTime >> 16 ) & 0xFF );
  264. buf[4] = ( uint8_t )( ( sleepTime >> 8 ) & 0xFF );
  265. buf[5] = ( uint8_t )( sleepTime & 0xFF );
  266. SX126xWriteCommand( RADIO_SET_RXDUTYCYCLE, buf, 6 );
  267. SX126xSetOperatingMode( MODE_RX_DC );
  268. }
  269. void SX126xSetCad( void )
  270. {
  271. SX126xWriteCommand( RADIO_SET_CAD, 0, 0 );
  272. SX126xSetOperatingMode( MODE_CAD );
  273. }
  274. void SX126xSetTxContinuousWave( void )
  275. {
  276. SX126xWriteCommand( RADIO_SET_TXCONTINUOUSWAVE, 0, 0 );
  277. SX126xSetOperatingMode( MODE_TX );
  278. }
  279. void SX126xSetTxInfinitePreamble( void )
  280. {
  281. SX126xWriteCommand( RADIO_SET_TXCONTINUOUSPREAMBLE, 0, 0 );
  282. SX126xSetOperatingMode( MODE_TX );
  283. }
  284. void SX126xSetStopRxTimerOnPreambleDetect( bool enable )
  285. {
  286. SX126xWriteCommand( RADIO_SET_STOPRXTIMERONPREAMBLE, ( uint8_t* )&enable, 1 );
  287. }
  288. void SX126xSetLoRaSymbNumTimeout( uint8_t symbNum )
  289. {
  290. uint8_t mant = ( ( ( symbNum > SX126X_MAX_LORA_SYMB_NUM_TIMEOUT ) ?
  291. SX126X_MAX_LORA_SYMB_NUM_TIMEOUT :
  292. symbNum ) + 1 ) >> 1;
  293. uint8_t exp = 0;
  294. uint8_t reg = 0;
  295. while( mant > 31 )
  296. {
  297. mant = ( mant + 3 ) >> 2;
  298. exp++;
  299. }
  300. reg = mant << ( 2 * exp + 1 );
  301. SX126xWriteCommand( RADIO_SET_LORASYMBTIMEOUT, &reg, 1 );
  302. if( symbNum != 0 )
  303. {
  304. reg = exp + ( mant << 3 );
  305. SX126xWriteRegister( REG_LR_SYNCH_TIMEOUT, reg );
  306. }
  307. }
  308. void SX126xSetRegulatorMode( RadioRegulatorMode_t mode )
  309. {
  310. SX126xWriteCommand( RADIO_SET_REGULATORMODE, ( uint8_t* )&mode, 1 );
  311. }
  312. void SX126xCalibrate( CalibrationParams_t calibParam )
  313. {
  314. uint8_t value = ( ( ( uint8_t )calibParam.Fields.ImgEnable << 6 ) |
  315. ( ( uint8_t )calibParam.Fields.ADCBulkPEnable << 5 ) |
  316. ( ( uint8_t )calibParam.Fields.ADCBulkNEnable << 4 ) |
  317. ( ( uint8_t )calibParam.Fields.ADCPulseEnable << 3 ) |
  318. ( ( uint8_t )calibParam.Fields.PLLEnable << 2 ) |
  319. ( ( uint8_t )calibParam.Fields.RC13MEnable << 1 ) |
  320. ( ( uint8_t )calibParam.Fields.RC64KEnable ) );
  321. SX126xWriteCommand( RADIO_CALIBRATE, &value, 1 );
  322. }
  323. void SX126xCalibrateImage( uint32_t freq )
  324. {
  325. uint8_t calFreq[2];
  326. if( freq > 900000000 )
  327. {
  328. calFreq[0] = 0xE1;
  329. calFreq[1] = 0xE9;
  330. }
  331. else if( freq > 850000000 )
  332. {
  333. calFreq[0] = 0xD7;
  334. calFreq[1] = 0xDB;
  335. }
  336. else if( freq > 770000000 )
  337. {
  338. calFreq[0] = 0xC1;
  339. calFreq[1] = 0xC5;
  340. }
  341. else if( freq > 460000000 )
  342. {
  343. calFreq[0] = 0x75;
  344. calFreq[1] = 0x81;
  345. }
  346. else if( freq > 425000000 )
  347. {
  348. calFreq[0] = 0x6B;
  349. calFreq[1] = 0x6F;
  350. }
  351. SX126xWriteCommand( RADIO_CALIBRATEIMAGE, calFreq, 2 );
  352. }
  353. void SX126xSetPaConfig( uint8_t paDutyCycle, uint8_t hpMax, uint8_t deviceSel, uint8_t paLut )
  354. {
  355. uint8_t buf[4];
  356. buf[0] = paDutyCycle;
  357. buf[1] = hpMax;
  358. buf[2] = deviceSel;
  359. buf[3] = paLut;
  360. SX126xWriteCommand( RADIO_SET_PACONFIG, buf, 4 );
  361. }
  362. void SX126xSetRxTxFallbackMode( uint8_t fallbackMode )
  363. {
  364. SX126xWriteCommand( RADIO_SET_TXFALLBACKMODE, &fallbackMode, 1 );
  365. }
  366. void SX126xSetDioIrqParams( uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask, uint16_t dio3Mask )
  367. {
  368. uint8_t buf[8];
  369. buf[0] = ( uint8_t )( ( irqMask >> 8 ) & 0x00FF );
  370. buf[1] = ( uint8_t )( irqMask & 0x00FF );
  371. buf[2] = ( uint8_t )( ( dio1Mask >> 8 ) & 0x00FF );
  372. buf[3] = ( uint8_t )( dio1Mask & 0x00FF );
  373. buf[4] = ( uint8_t )( ( dio2Mask >> 8 ) & 0x00FF );
  374. buf[5] = ( uint8_t )( dio2Mask & 0x00FF );
  375. buf[6] = ( uint8_t )( ( dio3Mask >> 8 ) & 0x00FF );
  376. buf[7] = ( uint8_t )( dio3Mask & 0x00FF );
  377. SX126xWriteCommand( RADIO_CFG_DIOIRQ, buf, 8 );
  378. }
  379. uint16_t SX126xGetIrqStatus( void )
  380. {
  381. uint8_t irqStatus[2];
  382. SX126xReadCommand( RADIO_GET_IRQSTATUS, irqStatus, 2 );
  383. return ( irqStatus[0] << 8 ) | irqStatus[1];
  384. }
  385. void SX126xSetDio2AsRfSwitchCtrl( uint8_t enable )
  386. {
  387. SX126xWriteCommand( RADIO_SET_RFSWITCHMODE, &enable, 1 );
  388. }
  389. void SX126xSetDio3AsTcxoCtrl( RadioTcxoCtrlVoltage_t tcxoVoltage, uint32_t timeout )
  390. {
  391. uint8_t buf[4];
  392. buf[0] = tcxoVoltage & 0x07;
  393. buf[1] = ( uint8_t )( ( timeout >> 16 ) & 0xFF );
  394. buf[2] = ( uint8_t )( ( timeout >> 8 ) & 0xFF );
  395. buf[3] = ( uint8_t )( timeout & 0xFF );
  396. SX126xWriteCommand( RADIO_SET_TCXOMODE, buf, 4 );
  397. }
  398. void SX126xSetRfFrequency( uint32_t frequency )
  399. {
  400. uint8_t buf[4];
  401. uint32_t freqInPllSteps = 0;
  402. if( ImageCalibrated == false )
  403. {
  404. SX126xCalibrateImage( frequency );
  405. ImageCalibrated = true;
  406. }
  407. freqInPllSteps = SX126xConvertFreqInHzToPllStep( frequency );
  408. buf[0] = ( uint8_t )( ( freqInPllSteps >> 24 ) & 0xFF );
  409. buf[1] = ( uint8_t )( ( freqInPllSteps >> 16 ) & 0xFF );
  410. buf[2] = ( uint8_t )( ( freqInPllSteps >> 8 ) & 0xFF );
  411. buf[3] = ( uint8_t )( freqInPllSteps & 0xFF );
  412. SX126xWriteCommand( RADIO_SET_RFFREQUENCY, buf, 4 );
  413. }
  414. void SX126xSetPacketType( RadioPacketTypes_t packetType )
  415. {
  416. // Save packet type internally to avoid questioning the radio
  417. PacketType = packetType;
  418. SX126xWriteCommand( RADIO_SET_PACKETTYPE, ( uint8_t* )&packetType, 1 );
  419. }
  420. RadioPacketTypes_t SX126xGetPacketType( void )
  421. {
  422. return PacketType;
  423. }
  424. void SX126xSetTxParams( int8_t power, RadioRampTimes_t rampTime )
  425. {
  426. uint8_t buf[2];
  427. if( SX126xGetDeviceId( ) == SX1261 )
  428. {
  429. if( power == 15 )
  430. {
  431. SX126xSetPaConfig( 0x06, 0x00, 0x01, 0x01 );
  432. }
  433. else
  434. {
  435. SX126xSetPaConfig( 0x04, 0x00, 0x01, 0x01 );
  436. }
  437. if( power >= 14 )
  438. {
  439. power = 14;
  440. }
  441. else if( power < -17 )
  442. {
  443. power = -17;
  444. }
  445. }
  446. else // sx1262
  447. {
  448. // WORKAROUND - Better Resistance of the SX1262 Tx to Antenna Mismatch, see DS_SX1261-2_V1.2 datasheet chapter 15.2
  449. // RegTxClampConfig = @address 0x08D8
  450. SX126xWriteRegister( 0x08D8, SX126xReadRegister( 0x08D8 ) | ( 0x0F << 1 ) );
  451. // WORKAROUND END
  452. SX126xSetPaConfig( 0x04, 0x07, 0x00, 0x01 );
  453. if( power > 22 )
  454. {
  455. power = 22;
  456. }
  457. else if( power < -9 )
  458. {
  459. power = -9;
  460. }
  461. }
  462. buf[0] = power;
  463. buf[1] = ( uint8_t )rampTime;
  464. SX126xWriteCommand( RADIO_SET_TXPARAMS, buf, 2 );
  465. }
  466. void SX126xSetModulationParams( ModulationParams_t *modulationParams )
  467. {
  468. uint8_t n;
  469. uint32_t tempVal = 0;
  470. uint8_t buf[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  471. // Check if required configuration corresponds to the stored packet type
  472. // If not, silently update radio packet type
  473. if( PacketType != modulationParams->PacketType )
  474. {
  475. SX126xSetPacketType( modulationParams->PacketType );
  476. }
  477. switch( modulationParams->PacketType )
  478. {
  479. case PACKET_TYPE_GFSK:
  480. n = 8;
  481. tempVal = ( uint32_t )( 32 * SX126X_XTAL_FREQ / modulationParams->Params.Gfsk.BitRate );
  482. buf[0] = ( tempVal >> 16 ) & 0xFF;
  483. buf[1] = ( tempVal >> 8 ) & 0xFF;
  484. buf[2] = tempVal & 0xFF;
  485. buf[3] = modulationParams->Params.Gfsk.ModulationShaping;
  486. buf[4] = modulationParams->Params.Gfsk.Bandwidth;
  487. tempVal = SX126xConvertFreqInHzToPllStep( modulationParams->Params.Gfsk.Fdev );
  488. buf[5] = ( tempVal >> 16 ) & 0xFF;
  489. buf[6] = ( tempVal >> 8 ) & 0xFF;
  490. buf[7] = ( tempVal& 0xFF );
  491. SX126xWriteCommand( RADIO_SET_MODULATIONPARAMS, buf, n );
  492. break;
  493. case PACKET_TYPE_LORA:
  494. n = 4;
  495. buf[0] = modulationParams->Params.LoRa.SpreadingFactor;
  496. buf[1] = modulationParams->Params.LoRa.Bandwidth;
  497. buf[2] = modulationParams->Params.LoRa.CodingRate;
  498. buf[3] = modulationParams->Params.LoRa.LowDatarateOptimize;
  499. SX126xWriteCommand( RADIO_SET_MODULATIONPARAMS, buf, n );
  500. break;
  501. default:
  502. case PACKET_TYPE_NONE:
  503. return;
  504. }
  505. }
  506. void SX126xSetPacketParams( PacketParams_t *packetParams )
  507. {
  508. uint8_t n;
  509. uint8_t crcVal = 0;
  510. uint8_t buf[9] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
  511. // Check if required configuration corresponds to the stored packet type
  512. // If not, silently update radio packet type
  513. if( PacketType != packetParams->PacketType )
  514. {
  515. SX126xSetPacketType( packetParams->PacketType );
  516. }
  517. switch( packetParams->PacketType )
  518. {
  519. case PACKET_TYPE_GFSK:
  520. if( packetParams->Params.Gfsk.CrcLength == RADIO_CRC_2_BYTES_IBM )
  521. {
  522. SX126xSetCrcSeed( CRC_IBM_SEED );
  523. SX126xSetCrcPolynomial( CRC_POLYNOMIAL_IBM );
  524. crcVal = RADIO_CRC_2_BYTES;
  525. }
  526. else if( packetParams->Params.Gfsk.CrcLength == RADIO_CRC_2_BYTES_CCIT )
  527. {
  528. SX126xSetCrcSeed( CRC_CCITT_SEED );
  529. SX126xSetCrcPolynomial( CRC_POLYNOMIAL_CCITT );
  530. crcVal = RADIO_CRC_2_BYTES_INV;
  531. }
  532. else
  533. {
  534. crcVal = packetParams->Params.Gfsk.CrcLength;
  535. }
  536. n = 9;
  537. buf[0] = ( packetParams->Params.Gfsk.PreambleLength >> 8 ) & 0xFF;
  538. buf[1] = packetParams->Params.Gfsk.PreambleLength;
  539. buf[2] = packetParams->Params.Gfsk.PreambleMinDetect;
  540. buf[3] = ( packetParams->Params.Gfsk.SyncWordLength /*<< 3*/ ); // convert from byte to bit
  541. buf[4] = packetParams->Params.Gfsk.AddrComp;
  542. buf[5] = packetParams->Params.Gfsk.HeaderType;
  543. buf[6] = packetParams->Params.Gfsk.PayloadLength;
  544. buf[7] = crcVal;
  545. buf[8] = packetParams->Params.Gfsk.DcFree;
  546. break;
  547. case PACKET_TYPE_LORA:
  548. n = 6;
  549. buf[0] = ( packetParams->Params.LoRa.PreambleLength >> 8 ) & 0xFF;
  550. buf[1] = packetParams->Params.LoRa.PreambleLength;
  551. buf[2] = LoRaHeaderType = packetParams->Params.LoRa.HeaderType;
  552. buf[3] = packetParams->Params.LoRa.PayloadLength;
  553. buf[4] = packetParams->Params.LoRa.CrcMode;
  554. buf[5] = packetParams->Params.LoRa.InvertIQ;
  555. break;
  556. default:
  557. case PACKET_TYPE_NONE:
  558. return;
  559. }
  560. SX126xWriteCommand( RADIO_SET_PACKETPARAMS, buf, n );
  561. }
  562. void SX126xSetCadParams( RadioLoRaCadSymbols_t cadSymbolNum, uint8_t cadDetPeak, uint8_t cadDetMin, RadioCadExitModes_t cadExitMode, uint32_t cadTimeout )
  563. {
  564. uint8_t buf[7];
  565. buf[0] = ( uint8_t )cadSymbolNum;
  566. buf[1] = cadDetPeak;
  567. buf[2] = cadDetMin;
  568. buf[3] = ( uint8_t )cadExitMode;
  569. buf[4] = ( uint8_t )( ( cadTimeout >> 16 ) & 0xFF );
  570. buf[5] = ( uint8_t )( ( cadTimeout >> 8 ) & 0xFF );
  571. buf[6] = ( uint8_t )( cadTimeout & 0xFF );
  572. SX126xWriteCommand( RADIO_SET_CADPARAMS, buf, 7 );
  573. SX126xSetOperatingMode( MODE_CAD );
  574. }
  575. void SX126xSetBufferBaseAddress( uint8_t txBaseAddress, uint8_t rxBaseAddress )
  576. {
  577. uint8_t buf[2];
  578. buf[0] = txBaseAddress;
  579. buf[1] = rxBaseAddress;
  580. SX126xWriteCommand( RADIO_SET_BUFFERBASEADDRESS, buf, 2 );
  581. }
  582. RadioStatus_t SX126xGetStatus( void )
  583. {
  584. uint8_t stat = 0;
  585. RadioStatus_t status = { 0 };
  586. status.Value = 0;
  587. stat = SX126xReadCommand( RADIO_GET_STATUS, NULL, 0 );
  588. status.Fields.CmdStatus = ( stat & ( 0x07 << 1 ) ) >> 1;
  589. status.Fields.ChipMode = ( stat & ( 0x07 << 4 ) ) >> 4;
  590. return status;
  591. }
  592. int8_t SX126xGetRssiInst( void )
  593. {
  594. uint8_t buf[1];
  595. int8_t rssi = 0;
  596. SX126xReadCommand( RADIO_GET_RSSIINST, buf, 1 );
  597. rssi = -buf[0] >> 1;
  598. return rssi;
  599. }
  600. void SX126xGetRxBufferStatus( uint8_t *payloadLength, uint8_t *rxStartBufferPointer )
  601. {
  602. uint8_t status[2];
  603. SX126xReadCommand( RADIO_GET_RXBUFFERSTATUS, status, 2 );
  604. // In case of LORA fixed header, the payloadLength is obtained by reading
  605. // the register REG_LR_PAYLOADLENGTH
  606. if( ( SX126xGetPacketType( ) == PACKET_TYPE_LORA ) && ( LoRaHeaderType == LORA_PACKET_FIXED_LENGTH ) )
  607. {
  608. *payloadLength = SX126xReadRegister( REG_LR_PAYLOADLENGTH );
  609. }
  610. else
  611. {
  612. *payloadLength = status[0];
  613. }
  614. *rxStartBufferPointer = status[1];
  615. }
  616. void SX126xGetPacketStatus( PacketStatus_t *pktStatus )
  617. {
  618. uint8_t status[3];
  619. SX126xReadCommand( RADIO_GET_PACKETSTATUS, status, 3 );
  620. pktStatus->packetType = SX126xGetPacketType( );
  621. switch( pktStatus->packetType )
  622. {
  623. case PACKET_TYPE_GFSK:
  624. pktStatus->Params.Gfsk.RxStatus = status[0];
  625. pktStatus->Params.Gfsk.RssiSync = -status[1] >> 1;
  626. pktStatus->Params.Gfsk.RssiAvg = -status[2] >> 1;
  627. pktStatus->Params.Gfsk.FreqError = 0;
  628. break;
  629. case PACKET_TYPE_LORA:
  630. pktStatus->Params.LoRa.RssiPkt = -status[0] >> 1;
  631. // Returns SNR value [dB] rounded to the nearest integer value
  632. pktStatus->Params.LoRa.SnrPkt = ( ( ( int8_t )status[1] ) + 2 ) >> 2;
  633. pktStatus->Params.LoRa.SignalRssiPkt = -status[2] >> 1;
  634. pktStatus->Params.LoRa.FreqError = FrequencyError;
  635. break;
  636. default:
  637. case PACKET_TYPE_NONE:
  638. // In that specific case, we set everything in the pktStatus to zeros
  639. // and reset the packet type accordingly
  640. memset( pktStatus, 0, sizeof( PacketStatus_t ) );
  641. pktStatus->packetType = PACKET_TYPE_NONE;
  642. break;
  643. }
  644. }
  645. RadioError_t SX126xGetDeviceErrors( void )
  646. {
  647. uint8_t err[] = { 0, 0 };
  648. RadioError_t error = { 0 };
  649. error.Value = 0;
  650. SX126xReadCommand( RADIO_GET_ERROR, ( uint8_t* )err, 2 );
  651. error.Fields.PaRamp = ( err[0] & ( 1 << 0 ) ) >> 0;
  652. error.Fields.PllLock = ( err[1] & ( 1 << 6 ) ) >> 6;
  653. error.Fields.XoscStart = ( err[1] & ( 1 << 5 ) ) >> 5;
  654. error.Fields.ImgCalib = ( err[1] & ( 1 << 4 ) ) >> 4;
  655. error.Fields.AdcCalib = ( err[1] & ( 1 << 3 ) ) >> 3;
  656. error.Fields.PllCalib = ( err[1] & ( 1 << 2 ) ) >> 2;
  657. error.Fields.Rc13mCalib = ( err[1] & ( 1 << 1 ) ) >> 1;
  658. error.Fields.Rc64kCalib = ( err[1] & ( 1 << 0 ) ) >> 0;
  659. return error;
  660. }
  661. void SX126xClearDeviceErrors( void )
  662. {
  663. uint8_t buf[2] = { 0x00, 0x00 };
  664. SX126xWriteCommand( RADIO_CLR_ERROR, buf, 2 );
  665. }
  666. void SX126xClearIrqStatus( uint16_t irq )
  667. {
  668. uint8_t buf[2];
  669. buf[0] = ( uint8_t )( ( ( uint16_t )irq >> 8 ) & 0x00FF );
  670. buf[1] = ( uint8_t )( ( uint16_t )irq & 0x00FF );
  671. SX126xWriteCommand( RADIO_CLR_IRQSTATUS, buf, 2 );
  672. }
  673. static uint32_t SX126xConvertFreqInHzToPllStep( uint32_t freqInHz )
  674. {
  675. uint32_t stepsInt;
  676. uint32_t stepsFrac;
  677. // pllSteps = freqInHz / (SX126X_XTAL_FREQ / 2^19 )
  678. // Get integer and fractional parts of the frequency computed with a PLL step scaled value
  679. stepsInt = freqInHz / SX126X_PLL_STEP_SCALED;
  680. stepsFrac = freqInHz - ( stepsInt * SX126X_PLL_STEP_SCALED );
  681. // Apply the scaling factor to retrieve a frequency in Hz (+ ceiling)
  682. return ( stepsInt << SX126X_PLL_STEP_SHIFT_AMOUNT ) +
  683. ( ( ( stepsFrac << SX126X_PLL_STEP_SHIFT_AMOUNT ) + ( SX126X_PLL_STEP_SCALED >> 1 ) ) /
  684. SX126X_PLL_STEP_SCALED );
  685. }