RegionEU433.c 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034
  1. /*!
  2. * \file RegionEU433.c
  3. *
  4. * \brief Region implementation for EU433
  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. * ___ _____ _ ___ _ _____ ___ ___ ___ ___
  18. * / __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __|
  19. * \__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _|
  20. * |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
  21. * embedded.connectivity.solutions===============
  22. *
  23. * \endcode
  24. *
  25. * \author Miguel Luis ( Semtech )
  26. *
  27. * \author Gregory Cristian ( Semtech )
  28. *
  29. * \author Daniel Jaeckle ( STACKFORCE )
  30. */
  31. #include "utilities.h"
  32. #include "RegionCommon.h"
  33. #include "RegionEU433.h"
  34. // Definitions
  35. #define CHANNELS_MASK_SIZE 1
  36. /*!
  37. * Region specific context
  38. */
  39. typedef struct sRegionEU433NvmCtx
  40. {
  41. /*!
  42. * LoRaMAC channels
  43. */
  44. ChannelParams_t Channels[ EU433_MAX_NB_CHANNELS ];
  45. /*!
  46. * LoRaMac bands
  47. */
  48. Band_t Bands[ EU433_MAX_NB_BANDS ];
  49. /*!
  50. * LoRaMac channels mask
  51. */
  52. uint16_t ChannelsMask[ CHANNELS_MASK_SIZE ];
  53. /*!
  54. * LoRaMac channels default mask
  55. */
  56. uint16_t ChannelsDefaultMask[ CHANNELS_MASK_SIZE ];
  57. }RegionEU433NvmCtx_t;
  58. /*
  59. * Non-volatile module context.
  60. */
  61. static RegionEU433NvmCtx_t NvmCtx;
  62. // Static functions
  63. static int8_t GetNextLowerTxDr( int8_t dr, int8_t minDr )
  64. {
  65. uint8_t nextLowerDr = 0;
  66. if( dr == minDr )
  67. {
  68. nextLowerDr = minDr;
  69. }
  70. else
  71. {
  72. nextLowerDr = dr - 1;
  73. }
  74. return nextLowerDr;
  75. }
  76. static uint32_t GetBandwidth( uint32_t drIndex )
  77. {
  78. switch( BandwidthsEU433[drIndex] )
  79. {
  80. default:
  81. case 125000:
  82. return 0;
  83. case 250000:
  84. return 1;
  85. case 500000:
  86. return 2;
  87. }
  88. }
  89. static int8_t LimitTxPower( int8_t txPower, int8_t maxBandTxPower, int8_t datarate, uint16_t* channelsMask )
  90. {
  91. int8_t txPowerResult = txPower;
  92. // Limit tx power to the band max
  93. txPowerResult = MAX( txPower, maxBandTxPower );
  94. return txPowerResult;
  95. }
  96. static bool VerifyRfFreq( uint32_t freq )
  97. {
  98. // Check radio driver support
  99. if( Radio.CheckRfFrequency( freq ) == false )
  100. {
  101. return false;
  102. }
  103. if( ( freq < 433175000 ) || ( freq > 434665000 ) )
  104. {
  105. return false;
  106. }
  107. return true;
  108. }
  109. static uint8_t CountNbOfEnabledChannels( bool joined, uint8_t datarate, uint16_t* channelsMask, ChannelParams_t* channels, Band_t* bands, uint8_t* enabledChannels, uint8_t* delayTx )
  110. {
  111. uint8_t nbEnabledChannels = 0;
  112. uint8_t delayTransmission = 0;
  113. for( uint8_t i = 0, k = 0; i < EU433_MAX_NB_CHANNELS; i += 16, k++ )
  114. {
  115. for( uint8_t j = 0; j < 16; j++ )
  116. {
  117. if( ( channelsMask[k] & ( 1 << j ) ) != 0 )
  118. {
  119. if( channels[i + j].Frequency == 0 )
  120. { // Check if the channel is enabled
  121. continue;
  122. }
  123. if( joined == false )
  124. {
  125. if( ( EU433_JOIN_CHANNELS & ( 1 << j ) ) == 0 )
  126. {
  127. continue;
  128. }
  129. }
  130. if( RegionCommonValueInRange( datarate, channels[i + j].DrRange.Fields.Min,
  131. channels[i + j].DrRange.Fields.Max ) == false )
  132. { // Check if the current channel selection supports the given datarate
  133. continue;
  134. }
  135. if( bands[channels[i + j].Band].TimeOff > 0 )
  136. { // Check if the band is available for transmission
  137. delayTransmission++;
  138. continue;
  139. }
  140. enabledChannels[nbEnabledChannels++] = i + j;
  141. }
  142. }
  143. }
  144. *delayTx = delayTransmission;
  145. return nbEnabledChannels;
  146. }
  147. PhyParam_t RegionEU433GetPhyParam( GetPhyParams_t* getPhy )
  148. {
  149. PhyParam_t phyParam = { 0 };
  150. switch( getPhy->Attribute )
  151. {
  152. case PHY_MIN_RX_DR:
  153. {
  154. phyParam.Value = EU433_RX_MIN_DATARATE;
  155. break;
  156. }
  157. case PHY_MIN_TX_DR:
  158. {
  159. phyParam.Value = EU433_TX_MIN_DATARATE;
  160. break;
  161. }
  162. case PHY_DEF_TX_DR:
  163. {
  164. phyParam.Value = EU433_DEFAULT_DATARATE;
  165. break;
  166. }
  167. case PHY_NEXT_LOWER_TX_DR:
  168. {
  169. phyParam.Value = GetNextLowerTxDr( getPhy->Datarate, EU433_TX_MIN_DATARATE );
  170. break;
  171. }
  172. case PHY_MAX_TX_POWER:
  173. {
  174. phyParam.Value = EU433_MAX_TX_POWER;
  175. break;
  176. }
  177. case PHY_DEF_TX_POWER:
  178. {
  179. phyParam.Value = EU433_DEFAULT_TX_POWER;
  180. break;
  181. }
  182. case PHY_DEF_ADR_ACK_LIMIT:
  183. {
  184. phyParam.Value = EU433_ADR_ACK_LIMIT;
  185. break;
  186. }
  187. case PHY_DEF_ADR_ACK_DELAY:
  188. {
  189. phyParam.Value = EU433_ADR_ACK_DELAY;
  190. break;
  191. }
  192. case PHY_MAX_PAYLOAD:
  193. {
  194. phyParam.Value = MaxPayloadOfDatarateEU433[getPhy->Datarate];
  195. break;
  196. }
  197. case PHY_MAX_PAYLOAD_REPEATER:
  198. {
  199. phyParam.Value = MaxPayloadOfDatarateRepeaterEU433[getPhy->Datarate];
  200. break;
  201. }
  202. case PHY_DUTY_CYCLE:
  203. {
  204. phyParam.Value = EU433_DUTY_CYCLE_ENABLED;
  205. break;
  206. }
  207. case PHY_MAX_RX_WINDOW:
  208. {
  209. phyParam.Value = EU433_MAX_RX_WINDOW;
  210. break;
  211. }
  212. case PHY_RECEIVE_DELAY1:
  213. {
  214. phyParam.Value = EU433_RECEIVE_DELAY1;
  215. break;
  216. }
  217. case PHY_RECEIVE_DELAY2:
  218. {
  219. phyParam.Value = EU433_RECEIVE_DELAY2;
  220. break;
  221. }
  222. case PHY_JOIN_ACCEPT_DELAY1:
  223. {
  224. phyParam.Value = EU433_JOIN_ACCEPT_DELAY1;
  225. break;
  226. }
  227. case PHY_JOIN_ACCEPT_DELAY2:
  228. {
  229. phyParam.Value = EU433_JOIN_ACCEPT_DELAY2;
  230. break;
  231. }
  232. case PHY_MAX_FCNT_GAP:
  233. {
  234. phyParam.Value = EU433_MAX_FCNT_GAP;
  235. break;
  236. }
  237. case PHY_ACK_TIMEOUT:
  238. {
  239. phyParam.Value = ( EU433_ACKTIMEOUT + randr( -EU433_ACK_TIMEOUT_RND, EU433_ACK_TIMEOUT_RND ) );
  240. break;
  241. }
  242. case PHY_DEF_DR1_OFFSET:
  243. {
  244. phyParam.Value = EU433_DEFAULT_RX1_DR_OFFSET;
  245. break;
  246. }
  247. case PHY_DEF_RX2_FREQUENCY:
  248. {
  249. phyParam.Value = EU433_RX_WND_2_FREQ;
  250. break;
  251. }
  252. case PHY_DEF_RX2_DR:
  253. {
  254. phyParam.Value = EU433_RX_WND_2_DR;
  255. break;
  256. }
  257. case PHY_CHANNELS_MASK:
  258. {
  259. phyParam.ChannelsMask = NvmCtx.ChannelsMask;
  260. break;
  261. }
  262. case PHY_CHANNELS_DEFAULT_MASK:
  263. {
  264. phyParam.ChannelsMask = NvmCtx.ChannelsDefaultMask;
  265. break;
  266. }
  267. case PHY_MAX_NB_CHANNELS:
  268. {
  269. phyParam.Value = EU433_MAX_NB_CHANNELS;
  270. break;
  271. }
  272. case PHY_CHANNELS:
  273. {
  274. phyParam.Channels = NvmCtx.Channels;
  275. break;
  276. }
  277. case PHY_DEF_UPLINK_DWELL_TIME:
  278. case PHY_DEF_DOWNLINK_DWELL_TIME:
  279. {
  280. phyParam.Value = 0;
  281. break;
  282. }
  283. case PHY_DEF_MAX_EIRP:
  284. {
  285. phyParam.fValue = EU433_DEFAULT_MAX_EIRP;
  286. break;
  287. }
  288. case PHY_DEF_ANTENNA_GAIN:
  289. {
  290. phyParam.fValue = EU433_DEFAULT_ANTENNA_GAIN;
  291. break;
  292. }
  293. case PHY_BEACON_CHANNEL_FREQ:
  294. {
  295. phyParam.Value = EU433_BEACON_CHANNEL_FREQ;
  296. break;
  297. }
  298. case PHY_BEACON_FORMAT:
  299. {
  300. phyParam.BeaconFormat.BeaconSize = EU433_BEACON_SIZE;
  301. phyParam.BeaconFormat.Rfu1Size = EU433_RFU1_SIZE;
  302. phyParam.BeaconFormat.Rfu2Size = EU433_RFU2_SIZE;
  303. break;
  304. }
  305. case PHY_BEACON_CHANNEL_DR:
  306. {
  307. phyParam.Value = EU433_BEACON_CHANNEL_DR;
  308. break;
  309. }
  310. case PHY_PING_SLOT_CHANNEL_DR:
  311. {
  312. phyParam.Value = EU433_PING_SLOT_CHANNEL_DR;
  313. break;
  314. }
  315. default:
  316. {
  317. break;
  318. }
  319. }
  320. return phyParam;
  321. }
  322. void RegionEU433SetBandTxDone( SetBandTxDoneParams_t* txDone )
  323. {
  324. RegionCommonSetBandTxDone( txDone->Joined, &NvmCtx.Bands[NvmCtx.Channels[txDone->Channel].Band], txDone->LastTxDoneTime );
  325. }
  326. void RegionEU433InitDefaults( InitDefaultsParams_t* params )
  327. {
  328. Band_t bands[EU433_MAX_NB_BANDS] =
  329. {
  330. EU433_BAND0
  331. };
  332. switch( params->Type )
  333. {
  334. case INIT_TYPE_INIT:
  335. {
  336. // Initialize bands
  337. memcpy1( ( uint8_t* )NvmCtx.Bands, ( uint8_t* )bands, sizeof( Band_t ) * EU433_MAX_NB_BANDS );
  338. // Channels
  339. NvmCtx.Channels[0] = ( ChannelParams_t ) EU433_LC1;
  340. NvmCtx.Channels[1] = ( ChannelParams_t ) EU433_LC2;
  341. NvmCtx.Channels[2] = ( ChannelParams_t ) EU433_LC3;
  342. // Initialize the channels default mask
  343. NvmCtx.ChannelsDefaultMask[0] = LC( 1 ) + LC( 2 ) + LC( 3 );
  344. // Update the channels mask
  345. RegionCommonChanMaskCopy( NvmCtx.ChannelsMask, NvmCtx.ChannelsDefaultMask, 1 );
  346. break;
  347. }
  348. case INIT_TYPE_RESTORE_CTX:
  349. {
  350. if( params->NvmCtx != 0 )
  351. {
  352. memcpy1( (uint8_t*) &NvmCtx, (uint8_t*) params->NvmCtx, sizeof( NvmCtx ) );
  353. }
  354. break;
  355. }
  356. case INIT_TYPE_RESTORE_DEFAULT_CHANNELS:
  357. {
  358. // Restore channels default mask
  359. NvmCtx.ChannelsMask[0] |= NvmCtx.ChannelsDefaultMask[0];
  360. // Channels
  361. NvmCtx.Channels[0] = ( ChannelParams_t ) EU433_LC1;
  362. NvmCtx.Channels[1] = ( ChannelParams_t ) EU433_LC2;
  363. NvmCtx.Channels[2] = ( ChannelParams_t ) EU433_LC3;
  364. break;
  365. }
  366. default:
  367. {
  368. break;
  369. }
  370. }
  371. }
  372. void* RegionEU433GetNvmCtx( GetNvmCtxParams_t* params )
  373. {
  374. params->nvmCtxSize = sizeof( RegionEU433NvmCtx_t );
  375. return &NvmCtx;
  376. }
  377. bool RegionEU433Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute )
  378. {
  379. switch( phyAttribute )
  380. {
  381. case PHY_FREQUENCY:
  382. {
  383. return VerifyRfFreq( verify->Frequency );
  384. }
  385. case PHY_TX_DR:
  386. {
  387. return RegionCommonValueInRange( verify->DatarateParams.Datarate, EU433_TX_MIN_DATARATE, EU433_TX_MAX_DATARATE );
  388. }
  389. case PHY_DEF_TX_DR:
  390. {
  391. return RegionCommonValueInRange( verify->DatarateParams.Datarate, DR_0, DR_5 );
  392. }
  393. case PHY_RX_DR:
  394. {
  395. return RegionCommonValueInRange( verify->DatarateParams.Datarate, EU433_RX_MIN_DATARATE, EU433_RX_MAX_DATARATE );
  396. }
  397. case PHY_DEF_TX_POWER:
  398. case PHY_TX_POWER:
  399. {
  400. // Remark: switched min and max!
  401. return RegionCommonValueInRange( verify->TxPower, EU433_MAX_TX_POWER, EU433_MIN_TX_POWER );
  402. }
  403. case PHY_DUTY_CYCLE:
  404. {
  405. return EU433_DUTY_CYCLE_ENABLED;
  406. }
  407. default:
  408. return false;
  409. }
  410. }
  411. void RegionEU433ApplyCFList( ApplyCFListParams_t* applyCFList )
  412. {
  413. ChannelParams_t newChannel;
  414. ChannelAddParams_t channelAdd;
  415. ChannelRemoveParams_t channelRemove;
  416. // Setup default datarate range
  417. newChannel.DrRange.Value = ( DR_5 << 4 ) | DR_0;
  418. // Size of the optional CF list
  419. if( applyCFList->Size != 16 )
  420. {
  421. return;
  422. }
  423. // Last byte CFListType must be 0 to indicate the CFList contains a list of frequencies
  424. if( applyCFList->Payload[15] != 0 )
  425. {
  426. return;
  427. }
  428. // Last byte is RFU, don't take it into account
  429. for( uint8_t i = 0, chanIdx = EU433_NUMB_DEFAULT_CHANNELS; chanIdx < EU433_MAX_NB_CHANNELS; i+=3, chanIdx++ )
  430. {
  431. if( chanIdx < ( EU433_NUMB_CHANNELS_CF_LIST + EU433_NUMB_DEFAULT_CHANNELS ) )
  432. {
  433. // Channel frequency
  434. newChannel.Frequency = (uint32_t) applyCFList->Payload[i];
  435. newChannel.Frequency |= ( (uint32_t) applyCFList->Payload[i + 1] << 8 );
  436. newChannel.Frequency |= ( (uint32_t) applyCFList->Payload[i + 2] << 16 );
  437. newChannel.Frequency *= 100;
  438. // Initialize alternative frequency to 0
  439. newChannel.Rx1Frequency = 0;
  440. }
  441. else
  442. {
  443. newChannel.Frequency = 0;
  444. newChannel.DrRange.Value = 0;
  445. newChannel.Rx1Frequency = 0;
  446. }
  447. if( newChannel.Frequency != 0 )
  448. {
  449. channelAdd.NewChannel = &newChannel;
  450. channelAdd.ChannelId = chanIdx;
  451. // Try to add all channels
  452. RegionEU433ChannelAdd( &channelAdd );
  453. }
  454. else
  455. {
  456. channelRemove.ChannelId = chanIdx;
  457. RegionEU433ChannelsRemove( &channelRemove );
  458. }
  459. }
  460. }
  461. bool RegionEU433ChanMaskSet( ChanMaskSetParams_t* chanMaskSet )
  462. {
  463. switch( chanMaskSet->ChannelsMaskType )
  464. {
  465. case CHANNELS_MASK:
  466. {
  467. RegionCommonChanMaskCopy( NvmCtx.ChannelsMask, chanMaskSet->ChannelsMaskIn, 1 );
  468. break;
  469. }
  470. case CHANNELS_DEFAULT_MASK:
  471. {
  472. RegionCommonChanMaskCopy( NvmCtx.ChannelsDefaultMask, chanMaskSet->ChannelsMaskIn, 1 );
  473. break;
  474. }
  475. default:
  476. return false;
  477. }
  478. return true;
  479. }
  480. void RegionEU433ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams )
  481. {
  482. double tSymbol = 0.0;
  483. // Get the datarate, perform a boundary check
  484. rxConfigParams->Datarate = MIN( datarate, EU433_RX_MAX_DATARATE );
  485. rxConfigParams->Bandwidth = GetBandwidth( rxConfigParams->Datarate );
  486. if( rxConfigParams->Datarate == DR_7 )
  487. { // FSK
  488. tSymbol = RegionCommonComputeSymbolTimeFsk( DataratesEU433[rxConfigParams->Datarate] );
  489. }
  490. else
  491. { // LoRa
  492. tSymbol = RegionCommonComputeSymbolTimeLoRa( DataratesEU433[rxConfigParams->Datarate], BandwidthsEU433[rxConfigParams->Datarate] );
  493. }
  494. RegionCommonComputeRxWindowParameters( tSymbol, minRxSymbols, rxError, Radio.GetWakeupTime( ), &rxConfigParams->WindowTimeout, &rxConfigParams->WindowOffset );
  495. }
  496. bool RegionEU433RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate )
  497. {
  498. RadioModems_t modem;
  499. int8_t dr = rxConfig->Datarate;
  500. uint8_t maxPayload = 0;
  501. int8_t phyDr = 0;
  502. uint32_t frequency = rxConfig->Frequency;
  503. if( Radio.GetStatus( ) != RF_IDLE )
  504. {
  505. return false;
  506. }
  507. if( rxConfig->RxSlot == RX_SLOT_WIN_1 )
  508. {
  509. // Apply window 1 frequency
  510. frequency = NvmCtx.Channels[rxConfig->Channel].Frequency;
  511. // Apply the alternative RX 1 window frequency, if it is available
  512. if( NvmCtx.Channels[rxConfig->Channel].Rx1Frequency != 0 )
  513. {
  514. frequency = NvmCtx.Channels[rxConfig->Channel].Rx1Frequency;
  515. }
  516. }
  517. // Read the physical datarate from the datarates table
  518. phyDr = DataratesEU433[dr];
  519. Radio.SetChannel( frequency );
  520. // Radio configuration
  521. if( dr == DR_7 )
  522. {
  523. modem = MODEM_FSK;
  524. Radio.SetRxConfig( modem, 50000, phyDr * 1000, 0, 83333, 5, rxConfig->WindowTimeout, false, 0, true, 0, 0, false, rxConfig->RxContinuous );
  525. }
  526. else
  527. {
  528. modem = MODEM_LORA;
  529. Radio.SetRxConfig( modem, rxConfig->Bandwidth, phyDr, 1, 0, 8, rxConfig->WindowTimeout, false, 0, false, 0, 0, true, rxConfig->RxContinuous );
  530. }
  531. if( rxConfig->RepeaterSupport == true )
  532. {
  533. maxPayload = MaxPayloadOfDatarateRepeaterEU433[dr];
  534. }
  535. else
  536. {
  537. maxPayload = MaxPayloadOfDatarateEU433[dr];
  538. }
  539. Radio.SetMaxPayloadLength( modem, maxPayload + LORA_MAC_FRMPAYLOAD_OVERHEAD );
  540. *datarate = (uint8_t) dr;
  541. return true;
  542. }
  543. static TimerTime_t GetTimeOnAir( int8_t datarate, uint16_t pktLen )
  544. {
  545. int8_t phyDr = DataratesEU433[datarate];
  546. uint32_t bandwidth = GetBandwidth( datarate );
  547. return Radio.TimeOnAir( MODEM_LORA, bandwidth, phyDr, 1, 8, false, pktLen, true );
  548. }
  549. bool RegionEU433TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir )
  550. {
  551. RadioModems_t modem;
  552. int8_t phyDr = DataratesEU433[txConfig->Datarate];
  553. int8_t txPowerLimited = LimitTxPower( txConfig->TxPower, NvmCtx.Bands[NvmCtx.Channels[txConfig->Channel].Band].TxMaxPower, txConfig->Datarate, NvmCtx.ChannelsMask );
  554. uint32_t bandwidth = GetBandwidth( txConfig->Datarate );
  555. int8_t phyTxPower = 0;
  556. // Calculate physical TX power
  557. phyTxPower = RegionCommonComputeTxPower( txPowerLimited, txConfig->MaxEirp, txConfig->AntennaGain );
  558. // Setup the radio frequency
  559. Radio.SetChannel( NvmCtx.Channels[txConfig->Channel].Frequency );
  560. if( txConfig->Datarate == DR_7 )
  561. { // High Speed FSK channel
  562. modem = MODEM_FSK;
  563. Radio.SetTxConfig( modem, phyTxPower, 25000, bandwidth, phyDr * 1000, 0, 5, false, true, 0, 0, false, 4000 );
  564. }
  565. else
  566. {
  567. modem = MODEM_LORA;
  568. Radio.SetTxConfig( modem, phyTxPower, 0, bandwidth, phyDr, 1, 8, false, true, 0, 0, false, 4000 );
  569. }
  570. // Setup maximum payload lenght of the radio driver
  571. Radio.SetMaxPayloadLength( modem, txConfig->PktLen );
  572. // Get the time-on-air of the next tx frame
  573. *txTimeOnAir = GetTimeOnAir( modem, txConfig->PktLen );
  574. *txPower = txPowerLimited;
  575. return true;
  576. }
  577. uint8_t RegionEU433LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed )
  578. {
  579. uint8_t status = 0x07;
  580. RegionCommonLinkAdrParams_t linkAdrParams;
  581. uint8_t nextIndex = 0;
  582. uint8_t bytesProcessed = 0;
  583. uint16_t chMask = 0;
  584. GetPhyParams_t getPhy;
  585. PhyParam_t phyParam;
  586. RegionCommonLinkAdrReqVerifyParams_t linkAdrVerifyParams;
  587. while( bytesProcessed < linkAdrReq->PayloadSize )
  588. {
  589. // Get ADR request parameters
  590. nextIndex = RegionCommonParseLinkAdrReq( &( linkAdrReq->Payload[bytesProcessed] ), &linkAdrParams );
  591. if( nextIndex == 0 )
  592. break; // break loop, since no more request has been found
  593. // Update bytes processed
  594. bytesProcessed += nextIndex;
  595. // Revert status, as we only check the last ADR request for the channel mask KO
  596. status = 0x07;
  597. // Setup temporary channels mask
  598. chMask = linkAdrParams.ChMask;
  599. // Verify channels mask
  600. if( ( linkAdrParams.ChMaskCtrl == 0 ) && ( chMask == 0 ) )
  601. {
  602. status &= 0xFE; // Channel mask KO
  603. }
  604. else if( ( ( linkAdrParams.ChMaskCtrl >= 1 ) && ( linkAdrParams.ChMaskCtrl <= 5 )) ||
  605. ( linkAdrParams.ChMaskCtrl >= 7 ) )
  606. {
  607. // RFU
  608. status &= 0xFE; // Channel mask KO
  609. }
  610. else
  611. {
  612. for( uint8_t i = 0; i < EU433_MAX_NB_CHANNELS; i++ )
  613. {
  614. if( linkAdrParams.ChMaskCtrl == 6 )
  615. {
  616. if( NvmCtx.Channels[i].Frequency != 0 )
  617. {
  618. chMask |= 1 << i;
  619. }
  620. }
  621. else
  622. {
  623. if( ( ( chMask & ( 1 << i ) ) != 0 ) &&
  624. ( NvmCtx.Channels[i].Frequency == 0 ) )
  625. {// Trying to enable an undefined channel
  626. status &= 0xFE; // Channel mask KO
  627. }
  628. }
  629. }
  630. }
  631. }
  632. // Get the minimum possible datarate
  633. getPhy.Attribute = PHY_MIN_TX_DR;
  634. getPhy.UplinkDwellTime = linkAdrReq->UplinkDwellTime;
  635. phyParam = RegionEU433GetPhyParam( &getPhy );
  636. linkAdrVerifyParams.Status = status;
  637. linkAdrVerifyParams.AdrEnabled = linkAdrReq->AdrEnabled;
  638. linkAdrVerifyParams.Datarate = linkAdrParams.Datarate;
  639. linkAdrVerifyParams.TxPower = linkAdrParams.TxPower;
  640. linkAdrVerifyParams.NbRep = linkAdrParams.NbRep;
  641. linkAdrVerifyParams.CurrentDatarate = linkAdrReq->CurrentDatarate;
  642. linkAdrVerifyParams.CurrentTxPower = linkAdrReq->CurrentTxPower;
  643. linkAdrVerifyParams.CurrentNbRep = linkAdrReq->CurrentNbRep;
  644. linkAdrVerifyParams.NbChannels = EU433_MAX_NB_CHANNELS;
  645. linkAdrVerifyParams.ChannelsMask = &chMask;
  646. linkAdrVerifyParams.MinDatarate = ( int8_t )phyParam.Value;
  647. linkAdrVerifyParams.MaxDatarate = EU433_TX_MAX_DATARATE;
  648. linkAdrVerifyParams.Channels = NvmCtx.Channels;
  649. linkAdrVerifyParams.MinTxPower = EU433_MIN_TX_POWER;
  650. linkAdrVerifyParams.MaxTxPower = EU433_MAX_TX_POWER;
  651. linkAdrVerifyParams.Version = linkAdrReq->Version;
  652. // Verify the parameters and update, if necessary
  653. status = RegionCommonLinkAdrReqVerifyParams( &linkAdrVerifyParams, &linkAdrParams.Datarate, &linkAdrParams.TxPower, &linkAdrParams.NbRep );
  654. // Update channelsMask if everything is correct
  655. if( status == 0x07 )
  656. {
  657. // Set the channels mask to a default value
  658. memset1( ( uint8_t* ) NvmCtx.ChannelsMask, 0, sizeof( NvmCtx.ChannelsMask ) );
  659. // Update the channels mask
  660. NvmCtx.ChannelsMask[0] = chMask;
  661. }
  662. // Update status variables
  663. *drOut = linkAdrParams.Datarate;
  664. *txPowOut = linkAdrParams.TxPower;
  665. *nbRepOut = linkAdrParams.NbRep;
  666. *nbBytesParsed = bytesProcessed;
  667. return status;
  668. }
  669. uint8_t RegionEU433RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq )
  670. {
  671. uint8_t status = 0x07;
  672. // Verify radio frequency
  673. if( VerifyRfFreq( rxParamSetupReq->Frequency ) == false )
  674. {
  675. status &= 0xFE; // Channel frequency KO
  676. }
  677. // Verify datarate
  678. if( RegionCommonValueInRange( rxParamSetupReq->Datarate, EU433_RX_MIN_DATARATE, EU433_RX_MAX_DATARATE ) == false )
  679. {
  680. status &= 0xFD; // Datarate KO
  681. }
  682. // Verify datarate offset
  683. if( RegionCommonValueInRange( rxParamSetupReq->DrOffset, EU433_MIN_RX1_DR_OFFSET, EU433_MAX_RX1_DR_OFFSET ) == false )
  684. {
  685. status &= 0xFB; // Rx1DrOffset range KO
  686. }
  687. return status;
  688. }
  689. uint8_t RegionEU433NewChannelReq( NewChannelReqParams_t* newChannelReq )
  690. {
  691. uint8_t status = 0x03;
  692. ChannelAddParams_t channelAdd;
  693. ChannelRemoveParams_t channelRemove;
  694. if( newChannelReq->NewChannel->Frequency == 0 )
  695. {
  696. channelRemove.ChannelId = newChannelReq->ChannelId;
  697. // Remove
  698. if( RegionEU433ChannelsRemove( &channelRemove ) == false )
  699. {
  700. status &= 0xFC;
  701. }
  702. }
  703. else
  704. {
  705. channelAdd.NewChannel = newChannelReq->NewChannel;
  706. channelAdd.ChannelId = newChannelReq->ChannelId;
  707. switch( RegionEU433ChannelAdd( &channelAdd ) )
  708. {
  709. case LORAMAC_STATUS_OK:
  710. {
  711. break;
  712. }
  713. case LORAMAC_STATUS_FREQUENCY_INVALID:
  714. {
  715. status &= 0xFE;
  716. break;
  717. }
  718. case LORAMAC_STATUS_DATARATE_INVALID:
  719. {
  720. status &= 0xFD;
  721. break;
  722. }
  723. case LORAMAC_STATUS_FREQ_AND_DR_INVALID:
  724. {
  725. status &= 0xFC;
  726. break;
  727. }
  728. default:
  729. {
  730. status &= 0xFC;
  731. break;
  732. }
  733. }
  734. }
  735. return status;
  736. }
  737. int8_t RegionEU433TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq )
  738. {
  739. return -1;
  740. }
  741. uint8_t RegionEU433DlChannelReq( DlChannelReqParams_t* dlChannelReq )
  742. {
  743. uint8_t status = 0x03;
  744. // Verify if the frequency is supported
  745. if( VerifyRfFreq( dlChannelReq->Rx1Frequency ) == false )
  746. {
  747. status &= 0xFE;
  748. }
  749. // Verify if an uplink frequency exists
  750. if( NvmCtx.Channels[dlChannelReq->ChannelId].Frequency == 0 )
  751. {
  752. status &= 0xFD;
  753. }
  754. // Apply Rx1 frequency, if the status is OK
  755. if( status == 0x03 )
  756. {
  757. NvmCtx.Channels[dlChannelReq->ChannelId].Rx1Frequency = dlChannelReq->Rx1Frequency;
  758. }
  759. return status;
  760. }
  761. int8_t RegionEU433AlternateDr( int8_t currentDr, AlternateDrType_t type )
  762. {
  763. return currentDr;
  764. }
  765. void RegionEU433CalcBackOff( CalcBackOffParams_t* calcBackOff )
  766. {
  767. RegionCommonCalcBackOffParams_t calcBackOffParams;
  768. calcBackOffParams.Channels = NvmCtx.Channels;
  769. calcBackOffParams.Bands = NvmCtx.Bands;
  770. calcBackOffParams.LastTxIsJoinRequest = calcBackOff->LastTxIsJoinRequest;
  771. calcBackOffParams.Joined = calcBackOff->Joined;
  772. calcBackOffParams.DutyCycleEnabled = calcBackOff->DutyCycleEnabled;
  773. calcBackOffParams.Channel = calcBackOff->Channel;
  774. calcBackOffParams.ElapsedTime = calcBackOff->ElapsedTime;
  775. calcBackOffParams.TxTimeOnAir = calcBackOff->TxTimeOnAir;
  776. RegionCommonCalcBackOff( &calcBackOffParams );
  777. }
  778. LoRaMacStatus_t RegionEU433NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff )
  779. {
  780. uint8_t nbEnabledChannels = 0;
  781. uint8_t delayTx = 0;
  782. uint8_t enabledChannels[EU433_MAX_NB_CHANNELS] = { 0 };
  783. TimerTime_t nextTxDelay = 0;
  784. if( RegionCommonCountChannels( NvmCtx.ChannelsMask, 0, 1 ) == 0 )
  785. { // Reactivate default channels
  786. NvmCtx.ChannelsMask[0] |= LC( 1 ) + LC( 2 ) + LC( 3 );
  787. }
  788. TimerTime_t elapsed = TimerGetElapsedTime( nextChanParams->LastAggrTx );
  789. if( ( nextChanParams->LastAggrTx == 0 ) || ( nextChanParams->AggrTimeOff <= elapsed ) )
  790. {
  791. // Reset Aggregated time off
  792. *aggregatedTimeOff = 0;
  793. // Update bands Time OFF
  794. nextTxDelay = RegionCommonUpdateBandTimeOff( nextChanParams->Joined, nextChanParams->DutyCycleEnabled, NvmCtx.Bands, EU433_MAX_NB_BANDS );
  795. // Search how many channels are enabled
  796. nbEnabledChannels = CountNbOfEnabledChannels( nextChanParams->Joined, nextChanParams->Datarate,
  797. NvmCtx.ChannelsMask, NvmCtx.Channels,
  798. NvmCtx.Bands, enabledChannels, &delayTx );
  799. }
  800. else
  801. {
  802. delayTx++;
  803. nextTxDelay = nextChanParams->AggrTimeOff - elapsed;
  804. }
  805. if( nbEnabledChannels > 0 )
  806. {
  807. // We found a valid channel
  808. *channel = enabledChannels[randr( 0, nbEnabledChannels - 1 )];
  809. *time = 0;
  810. return LORAMAC_STATUS_OK;
  811. }
  812. else
  813. {
  814. if( delayTx > 0 )
  815. {
  816. // Delay transmission due to AggregatedTimeOff or to a band time off
  817. *time = nextTxDelay;
  818. return LORAMAC_STATUS_DUTYCYCLE_RESTRICTED;
  819. }
  820. // Datarate not supported by any channel, restore defaults
  821. NvmCtx.ChannelsMask[0] |= LC( 1 ) + LC( 2 ) + LC( 3 );
  822. *time = 0;
  823. return LORAMAC_STATUS_NO_CHANNEL_FOUND;
  824. }
  825. }
  826. LoRaMacStatus_t RegionEU433ChannelAdd( ChannelAddParams_t* channelAdd )
  827. {
  828. bool drInvalid = false;
  829. bool freqInvalid = false;
  830. uint8_t id = channelAdd->ChannelId;
  831. if( id < EU433_NUMB_DEFAULT_CHANNELS )
  832. {
  833. return LORAMAC_STATUS_FREQ_AND_DR_INVALID;
  834. }
  835. if( id >= EU433_MAX_NB_CHANNELS )
  836. {
  837. return LORAMAC_STATUS_PARAMETER_INVALID;
  838. }
  839. // Validate the datarate range
  840. if( RegionCommonValueInRange( channelAdd->NewChannel->DrRange.Fields.Min, EU433_TX_MIN_DATARATE, EU433_TX_MAX_DATARATE ) == false )
  841. {
  842. drInvalid = true;
  843. }
  844. if( RegionCommonValueInRange( channelAdd->NewChannel->DrRange.Fields.Max, EU433_TX_MIN_DATARATE, EU433_TX_MAX_DATARATE ) == false )
  845. {
  846. drInvalid = true;
  847. }
  848. if( channelAdd->NewChannel->DrRange.Fields.Min > channelAdd->NewChannel->DrRange.Fields.Max )
  849. {
  850. drInvalid = true;
  851. }
  852. // Check frequency
  853. if( freqInvalid == false )
  854. {
  855. if( VerifyRfFreq( channelAdd->NewChannel->Frequency ) == false )
  856. {
  857. freqInvalid = true;
  858. }
  859. }
  860. // Check status
  861. if( ( drInvalid == true ) && ( freqInvalid == true ) )
  862. {
  863. return LORAMAC_STATUS_FREQ_AND_DR_INVALID;
  864. }
  865. if( drInvalid == true )
  866. {
  867. return LORAMAC_STATUS_DATARATE_INVALID;
  868. }
  869. if( freqInvalid == true )
  870. {
  871. return LORAMAC_STATUS_FREQUENCY_INVALID;
  872. }
  873. memcpy1( ( uint8_t* ) &(NvmCtx.Channels[id]), ( uint8_t* ) channelAdd->NewChannel, sizeof( NvmCtx.Channels[id] ) );
  874. NvmCtx.Channels[id].Band = 0;
  875. NvmCtx.ChannelsMask[0] |= ( 1 << id );
  876. return LORAMAC_STATUS_OK;
  877. }
  878. bool RegionEU433ChannelsRemove( ChannelRemoveParams_t* channelRemove )
  879. {
  880. uint8_t id = channelRemove->ChannelId;
  881. if( id < EU433_NUMB_DEFAULT_CHANNELS )
  882. {
  883. return false;
  884. }
  885. // Remove the channel from the list of channels
  886. NvmCtx.Channels[id] = ( ChannelParams_t ){ 0, 0, { 0 }, 0 };
  887. return RegionCommonChanDisable( NvmCtx.ChannelsMask, id, EU433_MAX_NB_CHANNELS );
  888. }
  889. void RegionEU433SetContinuousWave( ContinuousWaveParams_t* continuousWave )
  890. {
  891. int8_t txPowerLimited = LimitTxPower( continuousWave->TxPower, NvmCtx.Bands[NvmCtx.Channels[continuousWave->Channel].Band].TxMaxPower, continuousWave->Datarate, NvmCtx.ChannelsMask );
  892. int8_t phyTxPower = 0;
  893. uint32_t frequency = NvmCtx.Channels[continuousWave->Channel].Frequency;
  894. // Calculate physical TX power
  895. phyTxPower = RegionCommonComputeTxPower( txPowerLimited, continuousWave->MaxEirp, continuousWave->AntennaGain );
  896. Radio.SetTxContinuousWave( frequency, phyTxPower, continuousWave->Timeout );
  897. }
  898. uint8_t RegionEU433ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset )
  899. {
  900. int8_t datarate = dr - drOffset;
  901. if( datarate < 0 )
  902. {
  903. datarate = DR_0;
  904. }
  905. return datarate;
  906. }
  907. void RegionEU433RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr )
  908. {
  909. RegionCommonRxBeaconSetupParams_t regionCommonRxBeaconSetup;
  910. regionCommonRxBeaconSetup.Datarates = DataratesEU433;
  911. regionCommonRxBeaconSetup.Frequency = rxBeaconSetup->Frequency;
  912. regionCommonRxBeaconSetup.BeaconSize = EU433_BEACON_SIZE;
  913. regionCommonRxBeaconSetup.BeaconDatarate = EU433_BEACON_CHANNEL_DR;
  914. regionCommonRxBeaconSetup.BeaconChannelBW = EU433_BEACON_CHANNEL_BW;
  915. regionCommonRxBeaconSetup.RxTime = rxBeaconSetup->RxTime;
  916. regionCommonRxBeaconSetup.SymbolTimeout = rxBeaconSetup->SymbolTimeout;
  917. RegionCommonRxBeaconSetup( &regionCommonRxBeaconSetup );
  918. // Store downlink datarate
  919. *outDr = EU433_BEACON_CHANNEL_DR;
  920. }