LoRaMac.c 153 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733
  1. /*!
  2. * \file LoRaMac.c
  3. *
  4. * \brief LoRa MAC layer 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. * ___ _____ _ ___ _ _____ ___ ___ ___ ___
  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. * \author Johannes Bruder ( STACKFORCE )
  32. */
  33. #include "utilities.h"
  34. #include "Region.h"
  35. #include "LoRaMacClassB.h"
  36. #include "LoRaMacCrypto.h"
  37. #include "secure-element.h"
  38. #include "LoRaMacTest.h"
  39. #include "LoRaMacTypes.h"
  40. #include "LoRaMacConfirmQueue.h"
  41. #include "LoRaMacHeaderTypes.h"
  42. #include "LoRaMacMessageTypes.h"
  43. #include "LoRaMacParser.h"
  44. #include "LoRaMacCommands.h"
  45. #include "LoRaMacAdr.h"
  46. #include "lora-radio-timer.h"
  47. #include "LoRaMac.h"
  48. /*!
  49. * Maximum PHY layer payload size
  50. */
  51. #define LORAMAC_PHY_MAXPAYLOAD 255
  52. /*!
  53. * Maximum MAC commands buffer size
  54. */
  55. #define LORA_MAC_COMMAND_MAX_LENGTH 128
  56. /*!
  57. * Maximum length of the fOpts field
  58. */
  59. #define LORA_MAC_COMMAND_MAX_FOPTS_LENGTH 15
  60. /*!
  61. * LoRaMac duty cycle for the back-off procedure during the first hour.
  62. */
  63. #define BACKOFF_DC_1_HOUR 100
  64. /*!
  65. * LoRaMac duty cycle for the back-off procedure during the next 10 hours.
  66. */
  67. #define BACKOFF_DC_10_HOURS 1000
  68. /*!
  69. * LoRaMac duty cycle for the back-off procedure during the next 24 hours.
  70. */
  71. #define BACKOFF_DC_24_HOURS 10000
  72. /*!
  73. * LoRaMac internal states
  74. */
  75. enum eLoRaMacState
  76. {
  77. LORAMAC_IDLE = 0x00000000,
  78. LORAMAC_STOPPED = 0x00000001,
  79. LORAMAC_TX_RUNNING = 0x00000002,
  80. LORAMAC_RX = 0x00000004,
  81. LORAMAC_ACK_RETRY = 0x00000010,
  82. LORAMAC_TX_DELAYED = 0x00000020,
  83. LORAMAC_TX_CONFIG = 0x00000040,
  84. LORAMAC_RX_ABORT = 0x00000080,
  85. };
  86. /*
  87. * Request permission state
  88. */
  89. typedef enum eLoRaMacRequestHandling
  90. {
  91. LORAMAC_REQUEST_HANDLING_OFF = 0,
  92. LORAMAC_REQUEST_HANDLING_ON = !LORAMAC_REQUEST_HANDLING_OFF
  93. }LoRaMacRequestHandling_t;
  94. typedef struct sLoRaMacNvmCtx
  95. {
  96. /*
  97. * LoRaMac region.
  98. */
  99. LoRaMacRegion_t Region;
  100. /*
  101. * LoRaMac default parameters
  102. */
  103. LoRaMacParams_t MacParamsDefaults;
  104. /*
  105. * Network ID ( 3 bytes )
  106. */
  107. uint32_t NetID;
  108. /*
  109. * Mote Address
  110. */
  111. uint32_t DevAddr;
  112. /*!
  113. * Multicast channel list
  114. */
  115. MulticastCtx_t MulticastChannelList[LORAMAC_MAX_MC_CTX];
  116. /*
  117. * Actual device class
  118. */
  119. DeviceClass_t DeviceClass;
  120. /*
  121. * Indicates if the node is connected to
  122. * a private or public network
  123. */
  124. bool PublicNetwork;
  125. /*
  126. * LoRaMac ADR control status
  127. */
  128. bool AdrCtrlOn;
  129. /*
  130. * Counts the number of missed ADR acknowledgements
  131. */
  132. uint32_t AdrAckCounter;
  133. /*
  134. * LoRaMac parameters
  135. */
  136. LoRaMacParams_t MacParams;
  137. /*
  138. * Maximum duty cycle
  139. * \remark Possibility to shutdown the device.
  140. */
  141. uint8_t MaxDCycle;
  142. /*
  143. * Enables/Disables duty cycle management (Test only)
  144. */
  145. bool DutyCycleOn;
  146. /*
  147. * Current channel index
  148. */
  149. uint8_t LastTxChannel;
  150. /*
  151. * Holds the current rx window slot
  152. */
  153. bool RepeaterSupport;
  154. /*
  155. * Buffer containing the MAC layer commands
  156. */
  157. uint8_t MacCommandsBuffer[LORA_MAC_COMMAND_MAX_LENGTH];
  158. /*
  159. * If the server has sent a FRAME_TYPE_DATA_CONFIRMED_DOWN this variable indicates
  160. * if the ACK bit must be set for the next transmission
  161. */
  162. bool SrvAckRequested;
  163. /*
  164. * Aggregated duty cycle management
  165. */
  166. uint16_t AggregatedDCycle;
  167. /*
  168. * Aggregated duty cycle management
  169. */
  170. TimerTime_t LastTxDoneTime;
  171. TimerTime_t AggregatedTimeOff;
  172. /*
  173. * Stores the time at LoRaMac initialization.
  174. *
  175. * \remark Used for the BACKOFF_DC computation.
  176. */
  177. SysTime_t InitializationTime;
  178. /*
  179. * Current LoRaWAN Version
  180. */
  181. Version_t Version;
  182. /*
  183. * End-Device network activation
  184. */
  185. ActivationType_t NetworkActivation;
  186. /*!
  187. * Last received Message integrity Code (MIC)
  188. */
  189. uint32_t LastRxMic;
  190. }LoRaMacNvmCtx_t;
  191. typedef struct sLoRaMacCtx
  192. {
  193. /*
  194. * Length of packet in PktBuffer
  195. */
  196. uint16_t PktBufferLen;
  197. /*
  198. * Buffer containing the data to be sent or received.
  199. */
  200. uint8_t PktBuffer[LORAMAC_PHY_MAXPAYLOAD];
  201. /*!
  202. * Current processed transmit message
  203. */
  204. LoRaMacMessage_t TxMsg;
  205. /*!
  206. * Buffer containing the data received by the application.
  207. */
  208. uint8_t AppData[LORAMAC_PHY_MAXPAYLOAD];
  209. /*
  210. * Size of buffer containing the application data.
  211. */
  212. uint8_t AppDataSize;
  213. /*
  214. * Buffer containing the upper layer data.
  215. */
  216. uint8_t RxPayload[LORAMAC_PHY_MAXPAYLOAD];
  217. SysTime_t LastTxSysTime;
  218. /*
  219. * LoRaMac internal state
  220. */
  221. uint32_t MacState;
  222. /*
  223. * LoRaMac upper layer event functions
  224. */
  225. LoRaMacPrimitives_t* MacPrimitives;
  226. /*
  227. * LoRaMac upper layer callback functions
  228. */
  229. LoRaMacCallback_t* MacCallbacks;
  230. /*
  231. * Radio events function pointer
  232. */
  233. RadioEvents_t RadioEvents;
  234. /*
  235. * LoRaMac duty cycle delayed Tx timer
  236. */
  237. TimerEvent_t TxDelayedTimer;
  238. /*
  239. * LoRaMac reception windows timers
  240. */
  241. TimerEvent_t RxWindowTimer1;
  242. TimerEvent_t RxWindowTimer2;
  243. /*
  244. * LoRaMac reception windows delay
  245. * \remark normal frame: RxWindowXDelay = ReceiveDelayX - RADIO_WAKEUP_TIME
  246. * join frame : RxWindowXDelay = JoinAcceptDelayX - RADIO_WAKEUP_TIME
  247. */
  248. uint32_t RxWindow1Delay;
  249. uint32_t RxWindow2Delay;
  250. /*
  251. * LoRaMac Rx windows configuration
  252. */
  253. RxConfigParams_t RxWindow1Config;
  254. RxConfigParams_t RxWindow2Config;
  255. RxConfigParams_t RxWindowCConfig;
  256. /*
  257. * Limit of uplinks without any donwlink response before the ADRACKReq bit will be set.
  258. */
  259. uint16_t AdrAckLimit;
  260. /*
  261. * Limit of uplinks without any donwlink response after a the first frame with set ADRACKReq bit
  262. * before the trying to regain the connectivity.
  263. */
  264. uint16_t AdrAckDelay;
  265. /*
  266. * Acknowledge timeout timer. Used for packet retransmissions.
  267. */
  268. TimerEvent_t AckTimeoutTimer;
  269. /*
  270. * Uplink messages repetitions counter
  271. */
  272. uint8_t ChannelsNbTransCounter;
  273. /*
  274. * Number of trials to get a frame acknowledged
  275. */
  276. uint8_t AckTimeoutRetries;
  277. /*
  278. * Number of trials to get a frame acknowledged
  279. */
  280. uint8_t AckTimeoutRetriesCounter;
  281. /*
  282. * Indicates if the AckTimeout timer has expired or not
  283. */
  284. bool AckTimeoutRetry;
  285. /*
  286. * If the node has sent a FRAME_TYPE_DATA_CONFIRMED_UP this variable indicates
  287. * if the nodes needs to manage the server acknowledgement.
  288. */
  289. bool NodeAckRequested;
  290. /*
  291. * Current channel index
  292. */
  293. uint8_t Channel;
  294. /*
  295. * Last transmission time on air
  296. */
  297. TimerTime_t TxTimeOnAir;
  298. /*
  299. * Structure to hold an MCPS indication data.
  300. */
  301. McpsIndication_t McpsIndication;
  302. /*
  303. * Structure to hold MCPS confirm data.
  304. */
  305. McpsConfirm_t McpsConfirm;
  306. /*
  307. * Structure to hold MLME confirm data.
  308. */
  309. MlmeConfirm_t MlmeConfirm;
  310. /*
  311. * Structure to hold MLME indication data.
  312. */
  313. MlmeIndication_t MlmeIndication;
  314. /*
  315. * Holds the current rx window slot
  316. */
  317. LoRaMacRxSlot_t RxSlot;
  318. /*
  319. * LoRaMac tx/rx operation state
  320. */
  321. LoRaMacFlags_t MacFlags;
  322. /*
  323. * Data structure indicating if a request is allowed or not.
  324. */
  325. LoRaMacRequestHandling_t AllowRequests;
  326. /*
  327. * Non-volatile module context structure
  328. */
  329. LoRaMacNvmCtx_t* NvmCtx;
  330. }LoRaMacCtx_t;
  331. /*
  332. * Module context.
  333. */
  334. static LoRaMacCtx_t MacCtx;
  335. /*
  336. * Non-volatile module context.
  337. */
  338. static LoRaMacNvmCtx_t NvmMacCtx;
  339. /*
  340. * List of module contexts.
  341. */
  342. LoRaMacCtxs_t Contexts;
  343. /*!
  344. * Defines the LoRaMac radio events status
  345. */
  346. typedef union uLoRaMacRadioEvents
  347. {
  348. uint32_t Value;
  349. struct sEvents
  350. {
  351. uint32_t RxTimeout : 1;
  352. uint32_t RxError : 1;
  353. uint32_t TxTimeout : 1;
  354. uint32_t RxDone : 1;
  355. uint32_t TxDone : 1;
  356. }Events;
  357. }LoRaMacRadioEvents_t;
  358. /*!
  359. * LoRaMac radio events status
  360. */
  361. LoRaMacRadioEvents_t LoRaMacRadioEvents = { .Value = 0 };
  362. /*!
  363. * \brief Function to be executed on Radio Tx Done event
  364. */
  365. static void OnRadioTxDone( void );
  366. /*!
  367. * \brief This function prepares the MAC to abort the execution of function
  368. * OnRadioRxDone in case of a reception error.
  369. */
  370. static void PrepareRxDoneAbort( void );
  371. /*!
  372. * \brief Function to be executed on Radio Rx Done event
  373. */
  374. static void OnRadioRxDone( uint8_t* payload, uint16_t size, int16_t rssi, int8_t snr );
  375. /*!
  376. * \brief Function executed on Radio Tx Timeout event
  377. */
  378. static void OnRadioTxTimeout( void );
  379. /*!
  380. * \brief Function executed on Radio Rx error event
  381. */
  382. static void OnRadioRxError( void );
  383. /*!
  384. * \brief Function executed on Radio Rx Timeout event
  385. */
  386. static void OnRadioRxTimeout( void );
  387. /*!
  388. * \brief Function executed on duty cycle delayed Tx timer event
  389. */
  390. static void OnTxDelayedTimerEvent( void );
  391. /*!
  392. * \brief Function executed on first Rx window timer event
  393. */
  394. static void OnRxWindow1TimerEvent( void );
  395. /*!
  396. * \brief Function executed on second Rx window timer event
  397. */
  398. static void OnRxWindow2TimerEvent( void );
  399. /*!
  400. * \brief Function executed on AckTimeout timer event
  401. */
  402. static void OnAckTimeoutTimerEvent( void );
  403. /*!
  404. * \brief Configures the events to trigger an MLME-Indication with
  405. * a MLME type of MLME_SCHEDULE_UPLINK.
  406. */
  407. static void SetMlmeScheduleUplinkIndication( void );
  408. /*!
  409. * Computes next 32 bit downlink counter value and determines the frame counter ID.
  410. *
  411. * \param[IN] addrID - Address identifier
  412. * \param[IN] fType - Frame type
  413. * \param[IN] macMsg - Data message object, holding the current 16 bit transmitted frame counter
  414. * \param[IN] lrWanVersion - LoRaWAN version
  415. * \param[IN] maxFCntGap - Maximum allowed frame counter difference (only for 1.0.X necessary)
  416. * \param[OUT] fCntID - Frame counter identifier
  417. * \param[OUT] currentDown - Current downlink counter value
  418. *
  419. * \retval - Status of the operation
  420. */
  421. static LoRaMacCryptoStatus_t GetFCntDown( AddressIdentifier_t addrID, FType_t fType, LoRaMacMessageData_t* macMsg, Version_t lrWanVersion,
  422. uint16_t maxFCntGap, FCntIdentifier_t* fCntID, uint32_t* currentDown );
  423. /*!
  424. * \brief Switches the device class
  425. *
  426. * \param [IN] deviceClass Device class to switch to
  427. */
  428. static LoRaMacStatus_t SwitchClass( DeviceClass_t deviceClass );
  429. /*!
  430. * \brief Gets the maximum application payload length in the absence of the optional FOpt field.
  431. *
  432. * \param [IN] datarate Current datarate
  433. *
  434. * \retval Max length
  435. */
  436. static uint8_t GetMaxAppPayloadWithoutFOptsLength( int8_t datarate );
  437. /*!
  438. * \brief Validates if the payload fits into the frame, taking the datarate
  439. * into account.
  440. *
  441. * \details Refer to chapter 4.3.2 of the LoRaWAN specification, v1.0
  442. *
  443. * \param lenN Length of the application payload. The length depends on the
  444. * datarate and is region specific
  445. *
  446. * \param datarate Current datarate
  447. *
  448. * \param fOptsLen Length of the fOpts field
  449. *
  450. * \retval [false: payload does not fit into the frame, true: payload fits into
  451. * the frame]
  452. */
  453. static bool ValidatePayloadLength( uint8_t lenN, int8_t datarate, uint8_t fOptsLen );
  454. /*!
  455. * \brief Decodes MAC commands in the fOpts field and in the payload
  456. *
  457. * \param [IN] payload A pointer to the payload
  458. * \param [IN] macIndex The index of the payload where the MAC commands start
  459. * \param [IN] commandsSize The size of the MAC commands
  460. * \param [IN] snr The SNR value of the frame
  461. * \param [IN] rxSlot The RX slot where the frame was received
  462. */
  463. static void ProcessMacCommands( uint8_t* payload, uint8_t macIndex, uint8_t commandsSize, int8_t snr, LoRaMacRxSlot_t rxSlot );
  464. /*!
  465. * \brief LoRaMAC layer generic send frame
  466. *
  467. * \param [IN] macHdr MAC header field
  468. * \param [IN] fPort MAC payload port
  469. * \param [IN] fBuffer MAC data buffer to be sent
  470. * \param [IN] fBufferSize MAC data buffer size
  471. * \retval status Status of the operation.
  472. */
  473. LoRaMacStatus_t Send( LoRaMacHeader_t* macHdr, uint8_t fPort, void* fBuffer, uint16_t fBufferSize );
  474. /*!
  475. * \brief LoRaMAC layer send join/rejoin request
  476. *
  477. * \param [IN] joinReqType Type of join-request or rejoin
  478. *
  479. * \retval status Status of the operation.
  480. */
  481. LoRaMacStatus_t SendReJoinReq( JoinReqIdentifier_t joinReqType );
  482. /*!
  483. * \brief LoRaMAC layer frame buffer initialization
  484. *
  485. * \param [IN] macHdr MAC header field
  486. * \param [IN] fCtrl MAC frame control field
  487. * \param [IN] fOpts MAC commands buffer
  488. * \param [IN] fPort MAC payload port
  489. * \param [IN] fBuffer MAC data buffer to be sent
  490. * \param [IN] fBufferSize MAC data buffer size
  491. * \retval status Status of the operation.
  492. */
  493. LoRaMacStatus_t PrepareFrame( LoRaMacHeader_t* macHdr, LoRaMacFrameCtrl_t* fCtrl, uint8_t fPort, void* fBuffer, uint16_t fBufferSize );
  494. /*
  495. * \brief Schedules the frame according to the duty cycle
  496. *
  497. * \param [IN] allowDelayedTx When set to true, the a frame will be delayed,
  498. * the duty cycle restriction is active
  499. * \retval Status of the operation
  500. */
  501. static LoRaMacStatus_t ScheduleTx( bool allowDelayedTx );
  502. /*
  503. * \brief Secures the current processed frame ( TxMsg )
  504. * \param[IN] txDr Data rate used for the transmission
  505. * \param[IN] txCh Index of the channel used for the transmission
  506. * \retval status Status of the operation
  507. */
  508. static LoRaMacStatus_t SecureFrame( uint8_t txDr, uint8_t txCh );
  509. /*
  510. * \brief Calculates the back-off time for the band of a channel.
  511. *
  512. * \param [IN] channel The last Tx channel index
  513. */
  514. static void CalculateBackOff( uint8_t channel );
  515. /*
  516. * \brief Function to remove pending MAC commands
  517. *
  518. * \param [IN] rxSlot The RX slot on which the frame was received
  519. * \param [IN] fCtrl The frame control field of the received frame
  520. * \param [IN] request The request type
  521. */
  522. static void RemoveMacCommands( LoRaMacRxSlot_t rxSlot, LoRaMacFrameCtrl_t fCtrl, Mcps_t request );
  523. /*!
  524. * \brief LoRaMAC layer prepared frame buffer transmission with channel specification
  525. *
  526. * \remark PrepareFrame must be called at least once before calling this
  527. * function.
  528. *
  529. * \param [IN] channel Channel to transmit on
  530. * \retval status Status of the operation.
  531. */
  532. LoRaMacStatus_t SendFrameOnChannel( uint8_t channel );
  533. /*!
  534. * \brief Sets the radio in continuous transmission mode
  535. *
  536. * \remark Uses the radio parameters set on the previous transmission.
  537. *
  538. * \param [IN] timeout Time in seconds while the radio is kept in continuous wave mode
  539. * \retval status Status of the operation.
  540. */
  541. LoRaMacStatus_t SetTxContinuousWave( uint16_t timeout );
  542. /*!
  543. * \brief Sets the radio in continuous transmission mode
  544. *
  545. * \remark Uses the radio parameters set on the previous transmission.
  546. *
  547. * \param [IN] timeout Time in seconds while the radio is kept in continuous wave mode
  548. * \param [IN] frequency RF frequency to be set.
  549. * \param [IN] power RF output power to be set.
  550. * \retval status Status of the operation.
  551. */
  552. LoRaMacStatus_t SetTxContinuousWave1( uint16_t timeout, uint32_t frequency, uint8_t power );
  553. /*!
  554. * \brief Resets MAC specific parameters to default
  555. */
  556. static void ResetMacParameters( void );
  557. /*!
  558. * \brief Initializes and opens the reception window
  559. *
  560. * \param [IN] rxTimer Window timer to be topped.
  561. * \param [IN] rxConfig Window parameters to be setup
  562. */
  563. static void RxWindowSetup( TimerEvent_t* rxTimer, RxConfigParams_t* rxConfig );
  564. /*!
  565. * \brief Opens up a continuous RX C window. This is used for
  566. * class c devices.
  567. */
  568. static void OpenContinuousRxCWindow( void );
  569. /*!
  570. * \brief Returns a pointer to the internal contexts structure.
  571. *
  572. * \retval void Points to a structure containing all contexts
  573. */
  574. LoRaMacCtxs_t* GetCtxs( void );
  575. /*!
  576. * \brief Restoring of internal module contexts
  577. *
  578. * \details This function allows to restore module contexts by a given pointer.
  579. *
  580. *
  581. * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
  582. * returns are:
  583. * \ref LORAMAC_STATUS_OK,
  584. * \ref LORAMAC_STATUS_PARAMETER_INVALID,
  585. */
  586. LoRaMacStatus_t RestoreCtxs( LoRaMacCtxs_t* contexts );
  587. /*!
  588. * \brief Determines the frame type
  589. *
  590. * \param [IN] macMsg Data message object
  591. *
  592. * \param [OUT] fType Frame type
  593. *
  594. * \retval LoRaMacStatus_t Status of the operation. Possible returns are:
  595. * returns are:
  596. * \ref LORAMAC_STATUS_OK,
  597. * \ref LORAMAC_STATUS_PARAMETER_INVALID,
  598. */
  599. LoRaMacStatus_t DetermineFrameType( LoRaMacMessageData_t* macMsg, FType_t* fType );
  600. /*!
  601. * \brief Checks if the retransmission should be stopped in case of a unconfirmed uplink
  602. *
  603. * \retval Returns true if it should be stopped.
  604. */
  605. static bool CheckRetransUnconfirmedUplink( void );
  606. /*!
  607. * \brief Checks if the retransmission should be stopped in case of a confirmed uplink
  608. *
  609. * \retval Returns true it should be stopped.
  610. */
  611. static bool CheckRetransConfirmedUplink( void );
  612. /*!
  613. * \brief Stops the uplink retransmission
  614. *
  615. * \retval Returns true if successful.
  616. */
  617. static bool StopRetransmission( void );
  618. /*!
  619. * \brief Handles the ACK retries algorithm.
  620. * Increments the re-tries counter up until the specified number of
  621. * trials or the allowed maximum. Decrease the uplink datarate every 2
  622. * trials.
  623. */
  624. static void AckTimeoutRetriesProcess( void );
  625. /*!
  626. * \brief Finalizes the ACK retries algorithm.
  627. * If no ACK is received restores the default channels
  628. */
  629. static void AckTimeoutRetriesFinalize( void );
  630. /*!
  631. * \brief Calls the callback to indicate that a context changed
  632. */
  633. static void CallNvmCtxCallback( LoRaMacNvmCtxModule_t module );
  634. /*!
  635. * \brief MAC NVM Context has been changed
  636. */
  637. static void EventMacNvmCtxChanged( void );
  638. /*!
  639. * \brief Region NVM Context has been changed
  640. */
  641. static void EventRegionNvmCtxChanged( void );
  642. /*!
  643. * \brief Crypto NVM Context has been changed
  644. */
  645. static void EventCryptoNvmCtxChanged( void );
  646. /*!
  647. * \brief Secure Element NVM Context has been changed
  648. */
  649. static void EventSecureElementNvmCtxChanged( void );
  650. /*!
  651. * \brief MAC commands module nvm context has been changed
  652. */
  653. static void EventCommandsNvmCtxChanged( void );
  654. /*!
  655. * \brief Class B module nvm context has been changed
  656. */
  657. static void EventClassBNvmCtxChanged( void );
  658. /*!
  659. * \brief Confirm Queue module nvm context has been changed
  660. */
  661. static void EventConfirmQueueNvmCtxChanged( void );
  662. /*!
  663. * \brief Verifies if a request is pending currently
  664. *
  665. *\retval 1: Request pending, 0: request not pending
  666. */
  667. static uint8_t IsRequestPending( void );
  668. /*!
  669. * \brief Enabled the possibility to perform requests
  670. *
  671. * \param [IN] requestState Request permission state
  672. */
  673. static void LoRaMacEnableRequests( LoRaMacRequestHandling_t requestState );
  674. /*!
  675. * \brief This function verifies if a RX abort occurred
  676. */
  677. static void LoRaMacCheckForRxAbort( void );
  678. /*!
  679. * \brief This function verifies if a beacon acquisition MLME
  680. * request was pending
  681. *
  682. * \retval 1: Request pending, 0: no request pending
  683. */
  684. static uint8_t LoRaMacCheckForBeaconAcquisition( void );
  685. /*!
  686. * \brief This function handles join request
  687. */
  688. static void LoRaMacHandleMlmeRequest( void );
  689. /*!
  690. * \brief This function handles mcps request
  691. */
  692. static void LoRaMacHandleMcpsRequest( void );
  693. /*!
  694. * \brief This function handles callback events for requests
  695. */
  696. static void LoRaMacHandleRequestEvents( void );
  697. /*!
  698. * \brief This function handles callback events for indications
  699. */
  700. static void LoRaMacHandleIndicationEvents( void );
  701. /*!
  702. * Structure used to store the radio Tx event data
  703. */
  704. struct
  705. {
  706. TimerTime_t CurTime;
  707. }TxDoneParams;
  708. /*!
  709. * Structure used to store the radio Rx event data
  710. */
  711. struct
  712. {
  713. TimerTime_t LastRxDone;
  714. uint8_t *Payload;
  715. uint16_t Size;
  716. int16_t Rssi;
  717. int8_t Snr;
  718. }RxDoneParams;
  719. static void OnRadioTxDone( void )
  720. {
  721. TxDoneParams.CurTime = TimerGetCurrentTime( );
  722. // MacCtx.LastTxSysTime = SysTimeGet( );
  723. LoRaMacRadioEvents.Events.TxDone = 1;
  724. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  725. {
  726. MacCtx.MacCallbacks->MacProcessNotify( );
  727. }
  728. }
  729. static void OnRadioRxDone( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr )
  730. {
  731. RxDoneParams.LastRxDone = TimerGetCurrentTime( );
  732. RxDoneParams.Payload = payload;
  733. RxDoneParams.Size = size;
  734. RxDoneParams.Rssi = rssi;
  735. RxDoneParams.Snr = snr;
  736. LoRaMacRadioEvents.Events.RxDone = 1;
  737. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  738. {
  739. MacCtx.MacCallbacks->MacProcessNotify( );
  740. }
  741. }
  742. static void OnRadioTxTimeout( void )
  743. {
  744. LoRaMacRadioEvents.Events.TxTimeout = 1;
  745. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  746. {
  747. MacCtx.MacCallbacks->MacProcessNotify( );
  748. }
  749. }
  750. static void OnRadioRxError( void )
  751. {
  752. LoRaMacRadioEvents.Events.RxError = 1;
  753. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  754. {
  755. MacCtx.MacCallbacks->MacProcessNotify( );
  756. }
  757. }
  758. static void OnRadioRxTimeout( void )
  759. {
  760. LoRaMacRadioEvents.Events.RxTimeout = 1;
  761. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  762. {
  763. MacCtx.MacCallbacks->MacProcessNotify( );
  764. }
  765. }
  766. static void UpdateRxSlotIdleState( void )
  767. {
  768. if( MacCtx.NvmCtx->DeviceClass != CLASS_C )
  769. {
  770. MacCtx.RxSlot = RX_SLOT_NONE;
  771. }
  772. else
  773. {
  774. MacCtx.RxSlot = RX_SLOT_WIN_CLASS_C;
  775. }
  776. }
  777. static void ProcessRadioTxDone( void )
  778. {
  779. GetPhyParams_t getPhy;
  780. PhyParam_t phyParam;
  781. SetBandTxDoneParams_t txDone;
  782. if( MacCtx.NvmCtx->DeviceClass != CLASS_C )
  783. {
  784. Radio.Sleep( );
  785. }
  786. // Setup timers
  787. TimerSetValue( &MacCtx.RxWindowTimer1, MacCtx.RxWindow1Delay );
  788. TimerStart( &MacCtx.RxWindowTimer1 );
  789. TimerSetValue( &MacCtx.RxWindowTimer2, MacCtx.RxWindow2Delay );
  790. TimerStart( &MacCtx.RxWindowTimer2 );
  791. if( ( MacCtx.NvmCtx->DeviceClass == CLASS_C ) || ( MacCtx.NodeAckRequested == true ) )
  792. {
  793. getPhy.Attribute = PHY_ACK_TIMEOUT;
  794. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  795. TimerSetValue( &MacCtx.AckTimeoutTimer, MacCtx.RxWindow2Delay + phyParam.Value );
  796. TimerStart( &MacCtx.AckTimeoutTimer );
  797. }
  798. // Store last Tx channel
  799. MacCtx.NvmCtx->LastTxChannel = MacCtx.Channel;
  800. // Update last tx done time for the current channel
  801. txDone.Channel = MacCtx.Channel;
  802. if( MacCtx.NvmCtx->NetworkActivation == ACTIVATION_TYPE_NONE )
  803. {
  804. txDone.Joined = false;
  805. }
  806. else
  807. {
  808. txDone.Joined = true;
  809. }
  810. txDone.LastTxDoneTime = TxDoneParams.CurTime;
  811. RegionSetBandTxDone( MacCtx.NvmCtx->Region, &txDone );
  812. // Update Aggregated last tx done time
  813. MacCtx.NvmCtx->LastTxDoneTime = TxDoneParams.CurTime;
  814. if( MacCtx.NodeAckRequested == false )
  815. {
  816. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_OK;
  817. }
  818. }
  819. static void PrepareRxDoneAbort( void )
  820. {
  821. MacCtx.MacState |= LORAMAC_RX_ABORT;
  822. if( MacCtx.NodeAckRequested == true )
  823. {
  824. OnAckTimeoutTimerEvent( );
  825. }
  826. MacCtx.MacFlags.Bits.McpsInd = 1;
  827. MacCtx.MacFlags.Bits.MacDone = 1;
  828. UpdateRxSlotIdleState( );
  829. }
  830. static void ProcessRadioRxDone( void )
  831. {
  832. LoRaMacHeader_t macHdr;
  833. ApplyCFListParams_t applyCFList;
  834. GetPhyParams_t getPhy;
  835. PhyParam_t phyParam;
  836. LoRaMacCryptoStatus_t macCryptoStatus = LORAMAC_CRYPTO_ERROR;
  837. LoRaMacMessageData_t macMsgData;
  838. LoRaMacMessageJoinAccept_t macMsgJoinAccept;
  839. uint8_t *payload = RxDoneParams.Payload;
  840. uint16_t size = RxDoneParams.Size;
  841. int16_t rssi = RxDoneParams.Rssi;
  842. int8_t snr = RxDoneParams.Snr;
  843. uint8_t pktHeaderLen = 0;
  844. uint32_t downLinkCounter = 0;
  845. uint32_t address = MacCtx.NvmCtx->DevAddr;
  846. uint8_t multicast = 0;
  847. AddressIdentifier_t addrID = UNICAST_DEV_ADDR;
  848. FCntIdentifier_t fCntID;
  849. MacCtx.McpsConfirm.AckReceived = false;
  850. MacCtx.McpsIndication.Rssi = rssi;
  851. MacCtx.McpsIndication.Snr = snr;
  852. MacCtx.McpsIndication.RxSlot = MacCtx.RxSlot;
  853. MacCtx.McpsIndication.Port = 0;
  854. MacCtx.McpsIndication.Multicast = 0;
  855. MacCtx.McpsIndication.FramePending = 0;
  856. MacCtx.McpsIndication.Buffer = NULL;
  857. MacCtx.McpsIndication.BufferSize = 0;
  858. MacCtx.McpsIndication.RxData = false;
  859. MacCtx.McpsIndication.AckReceived = false;
  860. MacCtx.McpsIndication.DownLinkCounter = 0;
  861. MacCtx.McpsIndication.McpsIndication = MCPS_UNCONFIRMED;
  862. MacCtx.McpsIndication.DevAddress = 0;
  863. MacCtx.McpsIndication.DeviceTimeAnsReceived = false;
  864. Radio.Sleep( );
  865. TimerStop( &MacCtx.RxWindowTimer2 );
  866. // This function must be called even if we are not in class b mode yet.
  867. if( LoRaMacClassBRxBeacon( payload, size ) == true )
  868. {
  869. MacCtx.MlmeIndication.BeaconInfo.Rssi = rssi;
  870. MacCtx.MlmeIndication.BeaconInfo.Snr = snr;
  871. return;
  872. }
  873. // Check if we expect a ping or a multicast slot.
  874. if( MacCtx.NvmCtx->DeviceClass == CLASS_B )
  875. {
  876. if( LoRaMacClassBIsPingExpected( ) == true )
  877. {
  878. LoRaMacClassBSetPingSlotState( PINGSLOT_STATE_CALC_PING_OFFSET );
  879. LoRaMacClassBPingSlotTimerEvent( NULL );
  880. MacCtx.McpsIndication.RxSlot = RX_SLOT_WIN_CLASS_B_PING_SLOT;
  881. }
  882. else if( LoRaMacClassBIsMulticastExpected( ) == true )
  883. {
  884. LoRaMacClassBSetMulticastSlotState( PINGSLOT_STATE_CALC_PING_OFFSET );
  885. LoRaMacClassBMulticastSlotTimerEvent( NULL );
  886. MacCtx.McpsIndication.RxSlot = RX_SLOT_WIN_CLASS_B_MULTICAST_SLOT;
  887. }
  888. }
  889. macHdr.Value = payload[pktHeaderLen++];
  890. switch( macHdr.Bits.MType )
  891. {
  892. case FRAME_TYPE_JOIN_ACCEPT:
  893. macMsgJoinAccept.Buffer = payload;
  894. macMsgJoinAccept.BufSize = size;
  895. // Abort in case if the device isn't joined yet and no rejoin request is ongoing.
  896. if( MacCtx.NvmCtx->NetworkActivation != ACTIVATION_TYPE_NONE )
  897. {
  898. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  899. PrepareRxDoneAbort( );
  900. return;
  901. }
  902. macCryptoStatus = LoRaMacCryptoHandleJoinAccept( JOIN_REQ, SecureElementGetJoinEui( ), &macMsgJoinAccept );
  903. if( LORAMAC_CRYPTO_SUCCESS == macCryptoStatus )
  904. {
  905. // Network ID
  906. MacCtx.NvmCtx->NetID = ( uint32_t ) macMsgJoinAccept.NetID[0];
  907. MacCtx.NvmCtx->NetID |= ( ( uint32_t ) macMsgJoinAccept.NetID[1] << 8 );
  908. MacCtx.NvmCtx->NetID |= ( ( uint32_t ) macMsgJoinAccept.NetID[2] << 16 );
  909. // Device Address
  910. MacCtx.NvmCtx->DevAddr = macMsgJoinAccept.DevAddr;
  911. // DLSettings
  912. MacCtx.NvmCtx->MacParams.Rx1DrOffset = macMsgJoinAccept.DLSettings.Bits.RX1DRoffset;
  913. MacCtx.NvmCtx->MacParams.Rx2Channel.Datarate = macMsgJoinAccept.DLSettings.Bits.RX2DataRate;
  914. MacCtx.NvmCtx->MacParams.RxCChannel.Datarate = macMsgJoinAccept.DLSettings.Bits.RX2DataRate;
  915. // RxDelay
  916. MacCtx.NvmCtx->MacParams.ReceiveDelay1 = macMsgJoinAccept.RxDelay;
  917. if( MacCtx.NvmCtx->MacParams.ReceiveDelay1 == 0 )
  918. {
  919. MacCtx.NvmCtx->MacParams.ReceiveDelay1 = 1;
  920. }
  921. MacCtx.NvmCtx->MacParams.ReceiveDelay1 *= 1000;
  922. MacCtx.NvmCtx->MacParams.ReceiveDelay2 = MacCtx.NvmCtx->MacParams.ReceiveDelay1 + 1000;
  923. MacCtx.NvmCtx->Version.Fields.Minor = 0;
  924. // Apply CF list
  925. applyCFList.Payload = macMsgJoinAccept.CFList;
  926. // Size of the regular payload is 12. Plus 1 byte MHDR and 4 bytes MIC
  927. applyCFList.Size = size - 17;
  928. RegionApplyCFList( MacCtx.NvmCtx->Region, &applyCFList );
  929. MacCtx.NvmCtx->NetworkActivation = ACTIVATION_TYPE_OTAA;
  930. // MLME handling
  931. if( LoRaMacConfirmQueueIsCmdActive( MLME_JOIN ) == true )
  932. {
  933. LoRaMacConfirmQueueSetStatus( LORAMAC_EVENT_INFO_STATUS_OK, MLME_JOIN );
  934. }
  935. }
  936. else
  937. {
  938. // MLME handling
  939. if( LoRaMacConfirmQueueIsCmdActive( MLME_JOIN ) == true )
  940. {
  941. LoRaMacConfirmQueueSetStatus( LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL, MLME_JOIN );
  942. }
  943. }
  944. break;
  945. case FRAME_TYPE_DATA_CONFIRMED_DOWN:
  946. MacCtx.McpsIndication.McpsIndication = MCPS_CONFIRMED;
  947. // Intentional fall through
  948. case FRAME_TYPE_DATA_UNCONFIRMED_DOWN:
  949. // Check if the received payload size is valid
  950. getPhy.UplinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  951. getPhy.Datarate = MacCtx.McpsIndication.RxDatarate;
  952. getPhy.Attribute = PHY_MAX_PAYLOAD;
  953. // Get the maximum payload length
  954. if( MacCtx.NvmCtx->RepeaterSupport == true )
  955. {
  956. getPhy.Attribute = PHY_MAX_PAYLOAD_REPEATER;
  957. }
  958. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  959. if( MAX( 0, ( int16_t )( ( int16_t ) size - ( int16_t ) LORA_MAC_FRMPAYLOAD_OVERHEAD ) ) > ( int16_t )phyParam.Value )
  960. {
  961. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  962. PrepareRxDoneAbort( );
  963. return;
  964. }
  965. macMsgData.Buffer = payload;
  966. macMsgData.BufSize = size;
  967. macMsgData.FRMPayload = MacCtx.RxPayload;
  968. macMsgData.FRMPayloadSize = LORAMAC_PHY_MAXPAYLOAD;
  969. if( LORAMAC_PARSER_SUCCESS != LoRaMacParserData( &macMsgData ) )
  970. {
  971. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  972. PrepareRxDoneAbort( );
  973. return;
  974. }
  975. // Store device address
  976. MacCtx.McpsIndication.DevAddress = macMsgData.FHDR.DevAddr;
  977. FType_t fType;
  978. if( LORAMAC_STATUS_OK != DetermineFrameType( &macMsgData, &fType ) )
  979. {
  980. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  981. PrepareRxDoneAbort( );
  982. return;
  983. }
  984. //Check if it is a multicast message
  985. multicast = 0;
  986. downLinkCounter = 0;
  987. for( uint8_t i = 0; i < LORAMAC_MAX_MC_CTX; i++ )
  988. {
  989. if( ( MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.Address == macMsgData.FHDR.DevAddr ) &&
  990. ( MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.IsEnabled == true ) )
  991. {
  992. multicast = 1;
  993. addrID = MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.GroupID;
  994. downLinkCounter = *( MacCtx.NvmCtx->MulticastChannelList[i].DownLinkCounter );
  995. address = MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.Address;
  996. if( MacCtx.NvmCtx->DeviceClass == CLASS_C )
  997. {
  998. MacCtx.McpsIndication.RxSlot = RX_SLOT_WIN_CLASS_C_MULTICAST;
  999. }
  1000. break;
  1001. }
  1002. }
  1003. // Get maximum allowed counter difference
  1004. getPhy.Attribute = PHY_MAX_FCNT_GAP;
  1005. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  1006. // Get downlink frame counter value
  1007. macCryptoStatus = GetFCntDown( addrID, fType, &macMsgData, MacCtx.NvmCtx->Version, phyParam.Value, &fCntID, &downLinkCounter );
  1008. if( macCryptoStatus != LORAMAC_CRYPTO_SUCCESS )
  1009. {
  1010. if( macCryptoStatus == LORAMAC_CRYPTO_FAIL_FCNT_DUPLICATED )
  1011. {
  1012. // Catch the case of repeated downlink frame counter
  1013. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_DOWNLINK_REPEATED;
  1014. if( ( MacCtx.NvmCtx->Version.Fields.Minor == 0 ) && ( macHdr.Bits.MType == FRAME_TYPE_DATA_CONFIRMED_DOWN ) && ( MacCtx.NvmCtx->LastRxMic == macMsgData.MIC ) )
  1015. {
  1016. MacCtx.NvmCtx->SrvAckRequested = true;
  1017. }
  1018. }
  1019. else if( macCryptoStatus == LORAMAC_CRYPTO_FAIL_MAX_GAP_FCNT )
  1020. {
  1021. // Lost too many frames
  1022. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_DOWNLINK_TOO_MANY_FRAMES_LOSS;
  1023. }
  1024. else
  1025. {
  1026. // Other errors
  1027. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  1028. }
  1029. MacCtx.McpsIndication.DownLinkCounter = downLinkCounter;
  1030. PrepareRxDoneAbort( );
  1031. return;
  1032. }
  1033. macCryptoStatus = LoRaMacCryptoUnsecureMessage( addrID, address, fCntID, downLinkCounter, &macMsgData );
  1034. if( macCryptoStatus != LORAMAC_CRYPTO_SUCCESS )
  1035. {
  1036. if( macCryptoStatus == LORAMAC_CRYPTO_FAIL_ADDRESS )
  1037. {
  1038. // We are not the destination of this frame.
  1039. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL;
  1040. }
  1041. else
  1042. {
  1043. // MIC calculation fail
  1044. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_MIC_FAIL;
  1045. }
  1046. PrepareRxDoneAbort( );
  1047. return;
  1048. }
  1049. // Frame is valid
  1050. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_OK;
  1051. MacCtx.McpsIndication.Multicast = multicast;
  1052. MacCtx.McpsIndication.FramePending = macMsgData.FHDR.FCtrl.Bits.FPending;
  1053. MacCtx.McpsIndication.Buffer = NULL;
  1054. MacCtx.McpsIndication.BufferSize = 0;
  1055. MacCtx.McpsIndication.DownLinkCounter = downLinkCounter;
  1056. MacCtx.McpsIndication.AckReceived = macMsgData.FHDR.FCtrl.Bits.Ack;
  1057. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_OK;
  1058. MacCtx.McpsConfirm.AckReceived = macMsgData.FHDR.FCtrl.Bits.Ack;
  1059. // Reset ADR ACK Counter only, when RX1 or RX2 slot
  1060. if( ( MacCtx.McpsIndication.RxSlot == RX_SLOT_WIN_1 ) ||
  1061. ( MacCtx.McpsIndication.RxSlot == RX_SLOT_WIN_2 ) )
  1062. {
  1063. MacCtx.NvmCtx->AdrAckCounter = 0;
  1064. }
  1065. // MCPS Indication and ack requested handling
  1066. if( multicast == 1 )
  1067. {
  1068. MacCtx.McpsIndication.McpsIndication = MCPS_MULTICAST;
  1069. }
  1070. else
  1071. {
  1072. if( macHdr.Bits.MType == FRAME_TYPE_DATA_CONFIRMED_DOWN )
  1073. {
  1074. MacCtx.NvmCtx->SrvAckRequested = true;
  1075. if( MacCtx.NvmCtx->Version.Fields.Minor == 0 )
  1076. {
  1077. MacCtx.NvmCtx->LastRxMic = macMsgData.MIC;
  1078. }
  1079. MacCtx.McpsIndication.McpsIndication = MCPS_CONFIRMED;
  1080. }
  1081. else
  1082. {
  1083. MacCtx.NvmCtx->SrvAckRequested = false;
  1084. MacCtx.McpsIndication.McpsIndication = MCPS_UNCONFIRMED;
  1085. }
  1086. }
  1087. RemoveMacCommands( MacCtx.McpsIndication.RxSlot, macMsgData.FHDR.FCtrl, MacCtx.McpsConfirm.McpsRequest );
  1088. switch( fType )
  1089. {
  1090. case FRAME_TYPE_A:
  1091. { /* +----------+------+-------+--------------+
  1092. * | FOptsLen | Fopt | FPort | FRMPayload |
  1093. * +----------+------+-------+--------------+
  1094. * | > 0 | X | > 0 | X |
  1095. * +----------+------+-------+--------------+
  1096. */
  1097. // Decode MAC commands in FOpts field
  1098. ProcessMacCommands( macMsgData.FHDR.FOpts, 0, macMsgData.FHDR.FCtrl.Bits.FOptsLen, snr, MacCtx.McpsIndication.RxSlot );
  1099. MacCtx.McpsIndication.Port = macMsgData.FPort;
  1100. MacCtx.McpsIndication.Buffer = macMsgData.FRMPayload;
  1101. MacCtx.McpsIndication.BufferSize = macMsgData.FRMPayloadSize;
  1102. MacCtx.McpsIndication.RxData = true;
  1103. break;
  1104. }
  1105. case FRAME_TYPE_B:
  1106. { /* +----------+------+-------+--------------+
  1107. * | FOptsLen | Fopt | FPort | FRMPayload |
  1108. * +----------+------+-------+--------------+
  1109. * | > 0 | X | - | - |
  1110. * +----------+------+-------+--------------+
  1111. */
  1112. // Decode MAC commands in FOpts field
  1113. ProcessMacCommands( macMsgData.FHDR.FOpts, 0, macMsgData.FHDR.FCtrl.Bits.FOptsLen, snr, MacCtx.McpsIndication.RxSlot );
  1114. MacCtx.McpsIndication.Port = macMsgData.FPort;
  1115. break;
  1116. }
  1117. case FRAME_TYPE_C:
  1118. { /* +----------+------+-------+--------------+
  1119. * | FOptsLen | Fopt | FPort | FRMPayload |
  1120. * +----------+------+-------+--------------+
  1121. * | = 0 | - | = 0 | MAC commands |
  1122. * +----------+------+-------+--------------+
  1123. */
  1124. // Decode MAC commands in FRMPayload
  1125. ProcessMacCommands( macMsgData.FRMPayload, 0, macMsgData.FRMPayloadSize, snr, MacCtx.McpsIndication.RxSlot );
  1126. MacCtx.McpsIndication.Port = macMsgData.FPort;
  1127. break;
  1128. }
  1129. case FRAME_TYPE_D:
  1130. { /* +----------+------+-------+--------------+
  1131. * | FOptsLen | Fopt | FPort | FRMPayload |
  1132. * +----------+------+-------+--------------+
  1133. * | = 0 | - | > 0 | X |
  1134. * +----------+------+-------+--------------+
  1135. */
  1136. // No MAC commands just application payload
  1137. MacCtx.McpsIndication.Port = macMsgData.FPort;
  1138. MacCtx.McpsIndication.Buffer = macMsgData.FRMPayload;
  1139. MacCtx.McpsIndication.BufferSize = macMsgData.FRMPayloadSize;
  1140. MacCtx.McpsIndication.RxData = true;
  1141. break;
  1142. }
  1143. default:
  1144. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  1145. PrepareRxDoneAbort( );
  1146. break;
  1147. }
  1148. // Provide always an indication, skip the callback to the user application,
  1149. // in case of a confirmed downlink retransmission.
  1150. MacCtx.MacFlags.Bits.McpsInd = 1;
  1151. break;
  1152. case FRAME_TYPE_PROPRIETARY:
  1153. memcpy1( MacCtx.RxPayload, &payload[pktHeaderLen], size - pktHeaderLen );
  1154. MacCtx.McpsIndication.McpsIndication = MCPS_PROPRIETARY;
  1155. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_OK;
  1156. MacCtx.McpsIndication.Buffer = MacCtx.RxPayload;
  1157. MacCtx.McpsIndication.BufferSize = size - pktHeaderLen;
  1158. MacCtx.MacFlags.Bits.McpsInd = 1;
  1159. break;
  1160. default:
  1161. MacCtx.McpsIndication.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  1162. PrepareRxDoneAbort( );
  1163. break;
  1164. }
  1165. // Verify if we need to disable the AckTimeoutTimer
  1166. if( MacCtx.NodeAckRequested == true )
  1167. {
  1168. if( MacCtx.McpsConfirm.AckReceived == true )
  1169. {
  1170. OnAckTimeoutTimerEvent( );
  1171. }
  1172. }
  1173. else
  1174. {
  1175. if( MacCtx.NvmCtx->DeviceClass == CLASS_C )
  1176. {
  1177. OnAckTimeoutTimerEvent( );
  1178. }
  1179. }
  1180. MacCtx.MacFlags.Bits.MacDone = 1;
  1181. UpdateRxSlotIdleState( );
  1182. }
  1183. static void ProcessRadioTxTimeout( void )
  1184. {
  1185. if( MacCtx.NvmCtx->DeviceClass != CLASS_C )
  1186. {
  1187. Radio.Sleep( );
  1188. }
  1189. UpdateRxSlotIdleState( );
  1190. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT;
  1191. LoRaMacConfirmQueueSetStatusCmn( LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT );
  1192. if( MacCtx.NodeAckRequested == true )
  1193. {
  1194. MacCtx.AckTimeoutRetry = true;
  1195. }
  1196. MacCtx.MacFlags.Bits.MacDone = 1;
  1197. }
  1198. static void HandleRadioRxErrorTimeout( LoRaMacEventInfoStatus_t rx1EventInfoStatus, LoRaMacEventInfoStatus_t rx2EventInfoStatus )
  1199. {
  1200. bool classBRx = false;
  1201. if( MacCtx.NvmCtx->DeviceClass != CLASS_C )
  1202. {
  1203. Radio.Sleep( );
  1204. }
  1205. if( LoRaMacClassBIsBeaconExpected( ) == true )
  1206. {
  1207. LoRaMacClassBSetBeaconState( BEACON_STATE_TIMEOUT );
  1208. LoRaMacClassBBeaconTimerEvent( NULL );
  1209. classBRx = true;
  1210. }
  1211. if( MacCtx.NvmCtx->DeviceClass == CLASS_B )
  1212. {
  1213. if( LoRaMacClassBIsPingExpected( ) == true )
  1214. {
  1215. LoRaMacClassBSetPingSlotState( PINGSLOT_STATE_CALC_PING_OFFSET );
  1216. LoRaMacClassBPingSlotTimerEvent( NULL );
  1217. classBRx = true;
  1218. }
  1219. if( LoRaMacClassBIsMulticastExpected( ) == true )
  1220. {
  1221. LoRaMacClassBSetMulticastSlotState( PINGSLOT_STATE_CALC_PING_OFFSET );
  1222. LoRaMacClassBMulticastSlotTimerEvent( NULL );
  1223. classBRx = true;
  1224. }
  1225. }
  1226. if( classBRx == false )
  1227. {
  1228. if( MacCtx.RxSlot == RX_SLOT_WIN_1 )
  1229. {
  1230. if( MacCtx.NodeAckRequested == true )
  1231. {
  1232. MacCtx.McpsConfirm.Status = rx1EventInfoStatus;
  1233. }
  1234. LoRaMacConfirmQueueSetStatusCmn( rx1EventInfoStatus );
  1235. if( TimerGetElapsedTime( MacCtx.NvmCtx->LastTxDoneTime ) >= MacCtx.RxWindow2Delay )
  1236. {
  1237. TimerStop( &MacCtx.RxWindowTimer2 );
  1238. MacCtx.MacFlags.Bits.MacDone = 1;
  1239. }
  1240. }
  1241. else
  1242. {
  1243. if( MacCtx.NodeAckRequested == true )
  1244. {
  1245. MacCtx.McpsConfirm.Status = rx2EventInfoStatus;
  1246. }
  1247. LoRaMacConfirmQueueSetStatusCmn( rx2EventInfoStatus );
  1248. if( MacCtx.NvmCtx->DeviceClass != CLASS_C )
  1249. {
  1250. MacCtx.MacFlags.Bits.MacDone = 1;
  1251. }
  1252. }
  1253. }
  1254. UpdateRxSlotIdleState( );
  1255. }
  1256. static void ProcessRadioRxError( void )
  1257. {
  1258. HandleRadioRxErrorTimeout( LORAMAC_EVENT_INFO_STATUS_RX1_ERROR, LORAMAC_EVENT_INFO_STATUS_RX2_ERROR );
  1259. }
  1260. static void ProcessRadioRxTimeout( void )
  1261. {
  1262. HandleRadioRxErrorTimeout( LORAMAC_EVENT_INFO_STATUS_RX1_TIMEOUT, LORAMAC_EVENT_INFO_STATUS_RX2_TIMEOUT );
  1263. }
  1264. static void LoRaMacHandleIrqEvents( void )
  1265. {
  1266. LoRaMacRadioEvents_t events;
  1267. CRITICAL_SECTION_BEGIN( );
  1268. events = LoRaMacRadioEvents;
  1269. LoRaMacRadioEvents.Value = 0;
  1270. CRITICAL_SECTION_END( );
  1271. if( events.Value != 0 )
  1272. {
  1273. if( events.Events.TxDone == 1 )
  1274. {
  1275. ProcessRadioTxDone( );
  1276. }
  1277. if( events.Events.RxDone == 1 )
  1278. {
  1279. ProcessRadioRxDone( );
  1280. }
  1281. if( events.Events.TxTimeout == 1 )
  1282. {
  1283. ProcessRadioTxTimeout( );
  1284. }
  1285. if( events.Events.RxError == 1 )
  1286. {
  1287. ProcessRadioRxError( );
  1288. }
  1289. if( events.Events.RxTimeout == 1 )
  1290. {
  1291. ProcessRadioRxTimeout( );
  1292. }
  1293. }
  1294. }
  1295. bool LoRaMacIsBusy( void )
  1296. {
  1297. if( ( MacCtx.MacState == LORAMAC_IDLE ) &&
  1298. ( MacCtx.AllowRequests == LORAMAC_REQUEST_HANDLING_ON ) )
  1299. {
  1300. return false;
  1301. }
  1302. return true;
  1303. }
  1304. static void LoRaMacEnableRequests( LoRaMacRequestHandling_t requestState )
  1305. {
  1306. MacCtx.AllowRequests = requestState;
  1307. }
  1308. static void LoRaMacHandleRequestEvents( void )
  1309. {
  1310. // Handle events
  1311. LoRaMacFlags_t reqEvents = MacCtx.MacFlags;
  1312. if( MacCtx.MacState == LORAMAC_IDLE )
  1313. {
  1314. // Update event bits
  1315. if( MacCtx.MacFlags.Bits.McpsReq == 1 )
  1316. {
  1317. MacCtx.MacFlags.Bits.McpsReq = 0;
  1318. }
  1319. if( MacCtx.MacFlags.Bits.MlmeReq == 1 )
  1320. {
  1321. MacCtx.MacFlags.Bits.MlmeReq = 0;
  1322. }
  1323. // Allow requests again
  1324. LoRaMacEnableRequests( LORAMAC_REQUEST_HANDLING_ON );
  1325. // Handle callbacks
  1326. if( reqEvents.Bits.McpsReq == 1 )
  1327. {
  1328. MacCtx.MacPrimitives->MacMcpsConfirm( &MacCtx.McpsConfirm );
  1329. }
  1330. if( reqEvents.Bits.MlmeReq == 1 )
  1331. {
  1332. LoRaMacConfirmQueueHandleCb( &MacCtx.MlmeConfirm );
  1333. if( LoRaMacConfirmQueueGetCnt( ) > 0 )
  1334. {
  1335. MacCtx.MacFlags.Bits.MlmeReq = 1;
  1336. }
  1337. }
  1338. // Start beaconing again
  1339. LoRaMacClassBResumeBeaconing( );
  1340. // Procedure done. Reset variables.
  1341. MacCtx.MacFlags.Bits.MacDone = 0;
  1342. }
  1343. }
  1344. static void LoRaMacHandleScheduleUplinkEvent( void )
  1345. {
  1346. // Handle events
  1347. if( MacCtx.MacState == LORAMAC_IDLE )
  1348. {
  1349. // Verify if sticky MAC commands are pending or not
  1350. bool isStickyMacCommandPending = false;
  1351. LoRaMacCommandsStickyCmdsPending( &isStickyMacCommandPending );
  1352. if( isStickyMacCommandPending == true )
  1353. {// Setup MLME indication
  1354. SetMlmeScheduleUplinkIndication( );
  1355. }
  1356. }
  1357. }
  1358. static void LoRaMacHandleIndicationEvents( void )
  1359. {
  1360. // Handle MLME indication
  1361. if( MacCtx.MacFlags.Bits.MlmeInd == 1 )
  1362. {
  1363. MacCtx.MacFlags.Bits.MlmeInd = 0;
  1364. MacCtx.MacPrimitives->MacMlmeIndication( &MacCtx.MlmeIndication );
  1365. }
  1366. if( MacCtx.MacFlags.Bits.MlmeSchedUplinkInd == 1 )
  1367. {
  1368. MlmeIndication_t schduleUplinkIndication;
  1369. schduleUplinkIndication.MlmeIndication = MLME_SCHEDULE_UPLINK;
  1370. schduleUplinkIndication.Status = LORAMAC_EVENT_INFO_STATUS_OK;
  1371. MacCtx.MacPrimitives->MacMlmeIndication( &schduleUplinkIndication );
  1372. MacCtx.MacFlags.Bits.MlmeSchedUplinkInd = 0;
  1373. }
  1374. // Handle MCPS indication
  1375. if( MacCtx.MacFlags.Bits.McpsInd == 1 )
  1376. {
  1377. MacCtx.MacFlags.Bits.McpsInd = 0;
  1378. MacCtx.MacPrimitives->MacMcpsIndication( &MacCtx.McpsIndication );
  1379. }
  1380. }
  1381. static void LoRaMacHandleMcpsRequest( void )
  1382. {
  1383. // Handle MCPS uplinks
  1384. if( MacCtx.MacFlags.Bits.McpsReq == 1 )
  1385. {
  1386. bool stopRetransmission = false;
  1387. bool waitForRetransmission = false;
  1388. if( ( MacCtx.McpsConfirm.McpsRequest == MCPS_UNCONFIRMED ) ||
  1389. ( MacCtx.McpsConfirm.McpsRequest == MCPS_PROPRIETARY ) )
  1390. {
  1391. stopRetransmission = CheckRetransUnconfirmedUplink( );
  1392. }
  1393. else if( MacCtx.McpsConfirm.McpsRequest == MCPS_CONFIRMED )
  1394. {
  1395. if( MacCtx.AckTimeoutRetry == true )
  1396. {
  1397. stopRetransmission = CheckRetransConfirmedUplink( );
  1398. if( MacCtx.NvmCtx->Version.Fields.Minor == 0 )
  1399. {
  1400. if( stopRetransmission == false )
  1401. {
  1402. AckTimeoutRetriesProcess( );
  1403. }
  1404. else
  1405. {
  1406. AckTimeoutRetriesFinalize( );
  1407. }
  1408. }
  1409. }
  1410. else
  1411. {
  1412. waitForRetransmission = true;
  1413. }
  1414. }
  1415. if( stopRetransmission == true )
  1416. {// Stop retransmission
  1417. TimerStop( &MacCtx.TxDelayedTimer );
  1418. MacCtx.MacState &= ~LORAMAC_TX_DELAYED;
  1419. StopRetransmission( );
  1420. }
  1421. else if( waitForRetransmission == false )
  1422. {// Arrange further retransmission
  1423. MacCtx.MacFlags.Bits.MacDone = 0;
  1424. // Reset the state of the AckTimeout
  1425. MacCtx.AckTimeoutRetry = false;
  1426. // Sends the same frame again
  1427. OnTxDelayedTimerEvent( );
  1428. }
  1429. }
  1430. }
  1431. static void LoRaMacHandleMlmeRequest( void )
  1432. {
  1433. // Handle join request
  1434. if( MacCtx.MacFlags.Bits.MlmeReq == 1 )
  1435. {
  1436. if( ( LoRaMacConfirmQueueIsCmdActive( MLME_JOIN ) == true ) )
  1437. {
  1438. if( LoRaMacConfirmQueueGetStatus( MLME_JOIN ) == LORAMAC_EVENT_INFO_STATUS_OK )
  1439. {// Node joined successfully
  1440. MacCtx.ChannelsNbTransCounter = 0;
  1441. }
  1442. MacCtx.MacState &= ~LORAMAC_TX_RUNNING;
  1443. }
  1444. else if( ( LoRaMacConfirmQueueIsCmdActive( MLME_TXCW ) == true ) ||
  1445. ( LoRaMacConfirmQueueIsCmdActive( MLME_TXCW_1 ) == true ) )
  1446. {
  1447. MacCtx.MacState &= ~LORAMAC_TX_RUNNING;
  1448. }
  1449. }
  1450. }
  1451. static uint8_t LoRaMacCheckForBeaconAcquisition( void )
  1452. {
  1453. if( ( LoRaMacConfirmQueueIsCmdActive( MLME_BEACON_ACQUISITION ) == true ) &&
  1454. ( MacCtx.MacFlags.Bits.McpsReq == 0 ) )
  1455. {
  1456. if( MacCtx.MacFlags.Bits.MlmeReq == 1 )
  1457. {
  1458. MacCtx.MacState &= ~LORAMAC_TX_RUNNING;
  1459. return 0x01;
  1460. }
  1461. }
  1462. return 0x00;
  1463. }
  1464. static void LoRaMacCheckForRxAbort( void )
  1465. {
  1466. // A error occurs during receiving
  1467. if( ( MacCtx.MacState & LORAMAC_RX_ABORT ) == LORAMAC_RX_ABORT )
  1468. {
  1469. MacCtx.MacState &= ~LORAMAC_RX_ABORT;
  1470. MacCtx.MacState &= ~LORAMAC_TX_RUNNING;
  1471. }
  1472. }
  1473. void LoRaMacProcess( void )
  1474. {
  1475. uint8_t noTx = false;
  1476. LoRaMacHandleIrqEvents( );
  1477. LoRaMacClassBProcess( );
  1478. // MAC proceeded a state and is ready to check
  1479. if( MacCtx.MacFlags.Bits.MacDone == 1 )
  1480. {
  1481. LoRaMacEnableRequests( LORAMAC_REQUEST_HANDLING_OFF );
  1482. LoRaMacCheckForRxAbort( );
  1483. // An error occurs during transmitting
  1484. if( IsRequestPending( ) > 0 )
  1485. {
  1486. noTx |= LoRaMacCheckForBeaconAcquisition( );
  1487. }
  1488. if( noTx == 0x00 )
  1489. {
  1490. LoRaMacHandleMlmeRequest( );
  1491. LoRaMacHandleMcpsRequest( );
  1492. }
  1493. LoRaMacHandleRequestEvents( );
  1494. LoRaMacHandleScheduleUplinkEvent( );
  1495. LoRaMacEnableRequests( LORAMAC_REQUEST_HANDLING_ON );
  1496. }
  1497. LoRaMacHandleIndicationEvents( );
  1498. if( MacCtx.RxSlot == RX_SLOT_WIN_CLASS_C )
  1499. {
  1500. OpenContinuousRxCWindow( );
  1501. }
  1502. }
  1503. static void OnTxDelayedTimerEvent( void )
  1504. {
  1505. TimerStop( &MacCtx.TxDelayedTimer );
  1506. MacCtx.MacState &= ~LORAMAC_TX_DELAYED;
  1507. // Schedule frame, allow delayed frame transmissions
  1508. switch( ScheduleTx( true ) )
  1509. {
  1510. case LORAMAC_STATUS_OK:
  1511. case LORAMAC_STATUS_DUTYCYCLE_RESTRICTED:
  1512. {
  1513. break;
  1514. }
  1515. default:
  1516. {
  1517. // Stop retransmission attempt
  1518. MacCtx.McpsConfirm.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  1519. MacCtx.McpsConfirm.NbRetries = MacCtx.AckTimeoutRetriesCounter;
  1520. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_TX_DR_PAYLOAD_SIZE_ERROR;
  1521. LoRaMacConfirmQueueSetStatusCmn( LORAMAC_EVENT_INFO_STATUS_TX_DR_PAYLOAD_SIZE_ERROR );
  1522. StopRetransmission( );
  1523. break;
  1524. }
  1525. }
  1526. }
  1527. static void OnRxWindow1TimerEvent( void )
  1528. {
  1529. MacCtx.RxWindow1Config.Channel = MacCtx.Channel;
  1530. MacCtx.RxWindow1Config.DrOffset = MacCtx.NvmCtx->MacParams.Rx1DrOffset;
  1531. MacCtx.RxWindow1Config.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  1532. MacCtx.RxWindow1Config.RepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  1533. MacCtx.RxWindow1Config.RxContinuous = false;
  1534. MacCtx.RxWindow1Config.RxSlot = RX_SLOT_WIN_1;
  1535. RxWindowSetup( &MacCtx.RxWindowTimer1, &MacCtx.RxWindow1Config );
  1536. }
  1537. static void OnRxWindow2TimerEvent( void )
  1538. {
  1539. // Check if we are processing Rx1 window.
  1540. // If yes, we don't setup the Rx2 window.
  1541. if( MacCtx.RxSlot == RX_SLOT_WIN_1 )
  1542. {
  1543. return;
  1544. }
  1545. MacCtx.RxWindow2Config.Channel = MacCtx.Channel;
  1546. MacCtx.RxWindow2Config.Frequency = MacCtx.NvmCtx->MacParams.Rx2Channel.Frequency;
  1547. MacCtx.RxWindow2Config.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  1548. MacCtx.RxWindow2Config.RepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  1549. MacCtx.RxWindow2Config.RxContinuous = false;
  1550. MacCtx.RxWindow2Config.RxSlot = RX_SLOT_WIN_2;
  1551. RxWindowSetup( &MacCtx.RxWindowTimer2, &MacCtx.RxWindow2Config );
  1552. }
  1553. static void OnAckTimeoutTimerEvent( void )
  1554. {
  1555. TimerStop( &MacCtx.AckTimeoutTimer );
  1556. if( MacCtx.NodeAckRequested == true )
  1557. {
  1558. MacCtx.AckTimeoutRetry = true;
  1559. }
  1560. if( MacCtx.NvmCtx->DeviceClass == CLASS_C )
  1561. {
  1562. MacCtx.MacFlags.Bits.MacDone = 1;
  1563. }
  1564. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->MacProcessNotify != NULL ) )
  1565. {
  1566. MacCtx.MacCallbacks->MacProcessNotify( );
  1567. }
  1568. }
  1569. static LoRaMacCryptoStatus_t GetFCntDown( AddressIdentifier_t addrID, FType_t fType, LoRaMacMessageData_t* macMsg, Version_t lrWanVersion,
  1570. uint16_t maxFCntGap, FCntIdentifier_t* fCntID, uint32_t* currentDown )
  1571. {
  1572. if( ( macMsg == NULL ) || ( fCntID == NULL ) ||
  1573. ( currentDown == NULL ) )
  1574. {
  1575. return LORAMAC_CRYPTO_ERROR_NPE;
  1576. }
  1577. // Determine the frame counter identifier and choose counter from FCntList
  1578. switch( addrID )
  1579. {
  1580. case UNICAST_DEV_ADDR:
  1581. if( lrWanVersion.Fields.Minor == 1 )
  1582. {
  1583. if( ( fType == FRAME_TYPE_A ) || ( fType == FRAME_TYPE_D ) )
  1584. {
  1585. *fCntID = A_FCNT_DOWN;
  1586. }
  1587. else
  1588. {
  1589. *fCntID = N_FCNT_DOWN;
  1590. }
  1591. }
  1592. else
  1593. { // For LoRaWAN 1.0.X
  1594. *fCntID = FCNT_DOWN;
  1595. }
  1596. break;
  1597. case MULTICAST_0_ADDR:
  1598. *fCntID = MC_FCNT_DOWN_0;
  1599. break;
  1600. case MULTICAST_1_ADDR:
  1601. *fCntID = MC_FCNT_DOWN_1;
  1602. break;
  1603. case MULTICAST_2_ADDR:
  1604. *fCntID = MC_FCNT_DOWN_2;
  1605. break;
  1606. case MULTICAST_3_ADDR:
  1607. *fCntID = MC_FCNT_DOWN_3;
  1608. break;
  1609. default:
  1610. return LORAMAC_CRYPTO_FAIL_FCNT_ID;
  1611. }
  1612. return LoRaMacCryptoGetFCntDown( *fCntID, maxFCntGap, macMsg->FHDR.FCnt, currentDown );
  1613. }
  1614. static LoRaMacStatus_t SwitchClass( DeviceClass_t deviceClass )
  1615. {
  1616. LoRaMacStatus_t status = LORAMAC_STATUS_PARAMETER_INVALID;
  1617. switch( MacCtx.NvmCtx->DeviceClass )
  1618. {
  1619. case CLASS_A:
  1620. {
  1621. if( deviceClass == CLASS_A )
  1622. {
  1623. // Revert back RxC parameters
  1624. MacCtx.NvmCtx->MacParams.RxCChannel = MacCtx.NvmCtx->MacParams.Rx2Channel;
  1625. }
  1626. if( deviceClass == CLASS_B )
  1627. {
  1628. status = LoRaMacClassBSwitchClass( deviceClass );
  1629. if( status == LORAMAC_STATUS_OK )
  1630. {
  1631. MacCtx.NvmCtx->DeviceClass = deviceClass;
  1632. }
  1633. }
  1634. if( deviceClass == CLASS_C )
  1635. {
  1636. MacCtx.NvmCtx->DeviceClass = deviceClass;
  1637. MacCtx.RxWindowCConfig = MacCtx.RxWindow2Config;
  1638. MacCtx.RxWindowCConfig.RxSlot = RX_SLOT_WIN_CLASS_C;
  1639. for( int8_t i = 0; i < LORAMAC_MAX_MC_CTX; i++ )
  1640. {
  1641. if( MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.IsEnabled == true )
  1642. // TODO: Check multicast channel device class.
  1643. {
  1644. MacCtx.NvmCtx->MacParams.RxCChannel.Frequency = MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.RxParams.ClassC.Frequency;
  1645. MacCtx.NvmCtx->MacParams.RxCChannel.Datarate = MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.RxParams.ClassC.Datarate;
  1646. MacCtx.RxWindowCConfig.Channel = MacCtx.Channel;
  1647. MacCtx.RxWindowCConfig.Frequency = MacCtx.NvmCtx->MacParams.RxCChannel.Frequency;
  1648. MacCtx.RxWindowCConfig.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  1649. MacCtx.RxWindowCConfig.RepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  1650. MacCtx.RxWindowCConfig.RxSlot = RX_SLOT_WIN_CLASS_C_MULTICAST;
  1651. MacCtx.RxWindowCConfig.RxContinuous = true;
  1652. break;
  1653. }
  1654. }
  1655. // Set the NodeAckRequested indicator to default
  1656. MacCtx.NodeAckRequested = false;
  1657. // Set the radio into sleep mode in case we are still in RX mode
  1658. Radio.Sleep( );
  1659. OpenContinuousRxCWindow( );
  1660. status = LORAMAC_STATUS_OK;
  1661. }
  1662. break;
  1663. }
  1664. case CLASS_B:
  1665. {
  1666. status = LoRaMacClassBSwitchClass( deviceClass );
  1667. if( status == LORAMAC_STATUS_OK )
  1668. {
  1669. MacCtx.NvmCtx->DeviceClass = deviceClass;
  1670. }
  1671. break;
  1672. }
  1673. case CLASS_C:
  1674. {
  1675. if( deviceClass == CLASS_A )
  1676. {
  1677. MacCtx.NvmCtx->DeviceClass = deviceClass;
  1678. // Set the radio into sleep to setup a defined state
  1679. Radio.Sleep( );
  1680. status = LORAMAC_STATUS_OK;
  1681. }
  1682. break;
  1683. }
  1684. }
  1685. return status;
  1686. }
  1687. static uint8_t GetMaxAppPayloadWithoutFOptsLength( int8_t datarate )
  1688. {
  1689. GetPhyParams_t getPhy;
  1690. PhyParam_t phyParam;
  1691. // Setup PHY request
  1692. getPhy.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  1693. getPhy.Datarate = datarate;
  1694. getPhy.Attribute = PHY_MAX_PAYLOAD;
  1695. // Get the maximum payload length
  1696. if( MacCtx.NvmCtx->RepeaterSupport == true )
  1697. {
  1698. getPhy.Attribute = PHY_MAX_PAYLOAD_REPEATER;
  1699. }
  1700. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  1701. return phyParam.Value;
  1702. }
  1703. static bool ValidatePayloadLength( uint8_t lenN, int8_t datarate, uint8_t fOptsLen )
  1704. {
  1705. uint16_t maxN = 0;
  1706. uint16_t payloadSize = 0;
  1707. maxN = GetMaxAppPayloadWithoutFOptsLength( datarate );
  1708. // Calculate the resulting payload size
  1709. payloadSize = ( lenN + fOptsLen );
  1710. // Validation of the application payload size
  1711. if( ( payloadSize <= maxN ) && ( payloadSize <= LORAMAC_PHY_MAXPAYLOAD ) )
  1712. {
  1713. return true;
  1714. }
  1715. return false;
  1716. }
  1717. static void SetMlmeScheduleUplinkIndication( void )
  1718. {
  1719. MacCtx.MacFlags.Bits.MlmeSchedUplinkInd = 1;
  1720. }
  1721. static void ProcessMacCommands( uint8_t *payload, uint8_t macIndex, uint8_t commandsSize, int8_t snr, LoRaMacRxSlot_t rxSlot )
  1722. {
  1723. uint8_t status = 0;
  1724. bool adrBlockFound = false;
  1725. uint8_t macCmdPayload[2] = { 0x00, 0x00 };
  1726. while( macIndex < commandsSize )
  1727. {
  1728. // Decode Frame MAC commands
  1729. switch( payload[macIndex++] )
  1730. {
  1731. case SRV_MAC_LINK_CHECK_ANS:
  1732. {
  1733. if( LoRaMacConfirmQueueIsCmdActive( MLME_LINK_CHECK ) == true )
  1734. {
  1735. LoRaMacConfirmQueueSetStatus( LORAMAC_EVENT_INFO_STATUS_OK, MLME_LINK_CHECK );
  1736. MacCtx.MlmeConfirm.DemodMargin = payload[macIndex++];
  1737. MacCtx.MlmeConfirm.NbGateways = payload[macIndex++];
  1738. }
  1739. break;
  1740. }
  1741. case SRV_MAC_LINK_ADR_REQ:
  1742. {
  1743. LinkAdrReqParams_t linkAdrReq;
  1744. int8_t linkAdrDatarate = DR_0;
  1745. int8_t linkAdrTxPower = TX_POWER_0;
  1746. uint8_t linkAdrNbRep = 0;
  1747. uint8_t linkAdrNbBytesParsed = 0;
  1748. if( adrBlockFound == false )
  1749. {
  1750. adrBlockFound = true;
  1751. // Fill parameter structure
  1752. linkAdrReq.Payload = &payload[macIndex - 1];
  1753. linkAdrReq.PayloadSize = commandsSize - ( macIndex - 1 );
  1754. linkAdrReq.AdrEnabled = MacCtx.NvmCtx->AdrCtrlOn;
  1755. linkAdrReq.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  1756. linkAdrReq.CurrentDatarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  1757. linkAdrReq.CurrentTxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  1758. linkAdrReq.CurrentNbRep = MacCtx.NvmCtx->MacParams.ChannelsNbTrans;
  1759. linkAdrReq.Version = MacCtx.NvmCtx->Version;
  1760. // Process the ADR requests
  1761. status = RegionLinkAdrReq( MacCtx.NvmCtx->Region, &linkAdrReq, &linkAdrDatarate,
  1762. &linkAdrTxPower, &linkAdrNbRep, &linkAdrNbBytesParsed );
  1763. if( ( status & 0x07 ) == 0x07 )
  1764. {
  1765. MacCtx.NvmCtx->MacParams.ChannelsDatarate = linkAdrDatarate;
  1766. MacCtx.NvmCtx->MacParams.ChannelsTxPower = linkAdrTxPower;
  1767. MacCtx.NvmCtx->MacParams.ChannelsNbTrans = linkAdrNbRep;
  1768. }
  1769. // Add the answers to the buffer
  1770. for( uint8_t i = 0; i < ( linkAdrNbBytesParsed / 5 ); i++ )
  1771. {
  1772. LoRaMacCommandsAddCmd( MOTE_MAC_LINK_ADR_ANS, &status, 1 );
  1773. }
  1774. // Update MAC index
  1775. macIndex += linkAdrNbBytesParsed - 1;
  1776. }
  1777. break;
  1778. }
  1779. case SRV_MAC_DUTY_CYCLE_REQ:
  1780. {
  1781. MacCtx.NvmCtx->MaxDCycle = payload[macIndex++] & 0x0F;
  1782. MacCtx.NvmCtx->AggregatedDCycle = 1 << MacCtx.NvmCtx->MaxDCycle;
  1783. LoRaMacCommandsAddCmd( MOTE_MAC_DUTY_CYCLE_ANS, macCmdPayload, 0 );
  1784. break;
  1785. }
  1786. case SRV_MAC_RX_PARAM_SETUP_REQ:
  1787. {
  1788. RxParamSetupReqParams_t rxParamSetupReq;
  1789. status = 0x07;
  1790. rxParamSetupReq.DrOffset = ( payload[macIndex] >> 4 ) & 0x07;
  1791. rxParamSetupReq.Datarate = payload[macIndex] & 0x0F;
  1792. macIndex++;
  1793. rxParamSetupReq.Frequency = ( uint32_t ) payload[macIndex++];
  1794. rxParamSetupReq.Frequency |= ( uint32_t ) payload[macIndex++] << 8;
  1795. rxParamSetupReq.Frequency |= ( uint32_t ) payload[macIndex++] << 16;
  1796. rxParamSetupReq.Frequency *= 100;
  1797. // Perform request on region
  1798. status = RegionRxParamSetupReq( MacCtx.NvmCtx->Region, &rxParamSetupReq );
  1799. if( ( status & 0x07 ) == 0x07 )
  1800. {
  1801. MacCtx.NvmCtx->MacParams.Rx2Channel.Datarate = rxParamSetupReq.Datarate;
  1802. MacCtx.NvmCtx->MacParams.RxCChannel.Datarate = rxParamSetupReq.Datarate;
  1803. MacCtx.NvmCtx->MacParams.Rx2Channel.Frequency = rxParamSetupReq.Frequency;
  1804. MacCtx.NvmCtx->MacParams.RxCChannel.Frequency = rxParamSetupReq.Frequency;
  1805. MacCtx.NvmCtx->MacParams.Rx1DrOffset = rxParamSetupReq.DrOffset;
  1806. }
  1807. macCmdPayload[0] = status;
  1808. LoRaMacCommandsAddCmd( MOTE_MAC_RX_PARAM_SETUP_ANS, macCmdPayload, 1 );
  1809. // Setup indication to inform the application
  1810. SetMlmeScheduleUplinkIndication( );
  1811. break;
  1812. }
  1813. case SRV_MAC_DEV_STATUS_REQ:
  1814. {
  1815. uint8_t batteryLevel = BAT_LEVEL_NO_MEASURE;
  1816. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->GetBatteryLevel != NULL ) )
  1817. {
  1818. batteryLevel = MacCtx.MacCallbacks->GetBatteryLevel( );
  1819. }
  1820. macCmdPayload[0] = batteryLevel;
  1821. macCmdPayload[1] = ( uint8_t )( snr & 0x3F );
  1822. LoRaMacCommandsAddCmd( MOTE_MAC_DEV_STATUS_ANS, macCmdPayload, 2 );
  1823. break;
  1824. }
  1825. case SRV_MAC_NEW_CHANNEL_REQ:
  1826. {
  1827. NewChannelReqParams_t newChannelReq;
  1828. ChannelParams_t chParam;
  1829. status = 0x03;
  1830. newChannelReq.ChannelId = payload[macIndex++];
  1831. newChannelReq.NewChannel = &chParam;
  1832. chParam.Frequency = ( uint32_t ) payload[macIndex++];
  1833. chParam.Frequency |= ( uint32_t ) payload[macIndex++] << 8;
  1834. chParam.Frequency |= ( uint32_t ) payload[macIndex++] << 16;
  1835. chParam.Frequency *= 100;
  1836. chParam.Rx1Frequency = 0;
  1837. chParam.DrRange.Value = payload[macIndex++];
  1838. status = RegionNewChannelReq( MacCtx.NvmCtx->Region, &newChannelReq );
  1839. macCmdPayload[0] = status;
  1840. LoRaMacCommandsAddCmd( MOTE_MAC_NEW_CHANNEL_ANS, macCmdPayload, 1 );
  1841. break;
  1842. }
  1843. case SRV_MAC_RX_TIMING_SETUP_REQ:
  1844. {
  1845. uint8_t delay = payload[macIndex++] & 0x0F;
  1846. if( delay == 0 )
  1847. {
  1848. delay++;
  1849. }
  1850. MacCtx.NvmCtx->MacParams.ReceiveDelay1 = delay * 1000;
  1851. MacCtx.NvmCtx->MacParams.ReceiveDelay2 = MacCtx.NvmCtx->MacParams.ReceiveDelay1 + 1000;
  1852. LoRaMacCommandsAddCmd( MOTE_MAC_RX_TIMING_SETUP_ANS, macCmdPayload, 0 );
  1853. // Setup indication to inform the application
  1854. SetMlmeScheduleUplinkIndication( );
  1855. break;
  1856. }
  1857. case SRV_MAC_TX_PARAM_SETUP_REQ:
  1858. {
  1859. TxParamSetupReqParams_t txParamSetupReq;
  1860. GetPhyParams_t getPhy;
  1861. PhyParam_t phyParam;
  1862. uint8_t eirpDwellTime = payload[macIndex++];
  1863. txParamSetupReq.UplinkDwellTime = 0;
  1864. txParamSetupReq.DownlinkDwellTime = 0;
  1865. if( ( eirpDwellTime & 0x20 ) == 0x20 )
  1866. {
  1867. txParamSetupReq.DownlinkDwellTime = 1;
  1868. }
  1869. if( ( eirpDwellTime & 0x10 ) == 0x10 )
  1870. {
  1871. txParamSetupReq.UplinkDwellTime = 1;
  1872. }
  1873. txParamSetupReq.MaxEirp = eirpDwellTime & 0x0F;
  1874. // Check the status for correctness
  1875. if( RegionTxParamSetupReq( MacCtx.NvmCtx->Region, &txParamSetupReq ) != -1 )
  1876. {
  1877. // Accept command
  1878. MacCtx.NvmCtx->MacParams.UplinkDwellTime = txParamSetupReq.UplinkDwellTime;
  1879. MacCtx.NvmCtx->MacParams.DownlinkDwellTime = txParamSetupReq.DownlinkDwellTime;
  1880. MacCtx.NvmCtx->MacParams.MaxEirp = LoRaMacMaxEirpTable[txParamSetupReq.MaxEirp];
  1881. // Update the datarate in case of the new configuration limits it
  1882. getPhy.Attribute = PHY_MIN_TX_DR;
  1883. getPhy.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  1884. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  1885. MacCtx.NvmCtx->MacParams.ChannelsDatarate = MAX( MacCtx.NvmCtx->MacParams.ChannelsDatarate, ( int8_t )phyParam.Value );
  1886. // Add command response
  1887. LoRaMacCommandsAddCmd( MOTE_MAC_TX_PARAM_SETUP_ANS, macCmdPayload, 0 );
  1888. }
  1889. break;
  1890. }
  1891. case SRV_MAC_DL_CHANNEL_REQ:
  1892. {
  1893. DlChannelReqParams_t dlChannelReq;
  1894. status = 0x03;
  1895. dlChannelReq.ChannelId = payload[macIndex++];
  1896. dlChannelReq.Rx1Frequency = ( uint32_t ) payload[macIndex++];
  1897. dlChannelReq.Rx1Frequency |= ( uint32_t ) payload[macIndex++] << 8;
  1898. dlChannelReq.Rx1Frequency |= ( uint32_t ) payload[macIndex++] << 16;
  1899. dlChannelReq.Rx1Frequency *= 100;
  1900. status = RegionDlChannelReq( MacCtx.NvmCtx->Region, &dlChannelReq );
  1901. macCmdPayload[0] = status;
  1902. LoRaMacCommandsAddCmd( MOTE_MAC_DL_CHANNEL_ANS, macCmdPayload, 1 );
  1903. // Setup indication to inform the application
  1904. SetMlmeScheduleUplinkIndication( );
  1905. break;
  1906. }
  1907. case SRV_MAC_DEVICE_TIME_ANS:
  1908. {
  1909. SysTime_t gpsEpochTime = { 0 };
  1910. SysTime_t sysTime = { 0 };
  1911. //SysTime_t sysTimeCurrent = { 0 };
  1912. gpsEpochTime.Seconds = ( uint32_t )payload[macIndex++];
  1913. gpsEpochTime.Seconds |= ( uint32_t )payload[macIndex++] << 8;
  1914. gpsEpochTime.Seconds |= ( uint32_t )payload[macIndex++] << 16;
  1915. gpsEpochTime.Seconds |= ( uint32_t )payload[macIndex++] << 24;
  1916. gpsEpochTime.SubSeconds = payload[macIndex++];
  1917. // Convert the fractional second received in ms
  1918. // round( pow( 0.5, 8.0 ) * 1000 ) = 3.90625
  1919. gpsEpochTime.SubSeconds = ( int16_t )( ( ( int32_t )gpsEpochTime.SubSeconds * 1000 ) >> 8 );
  1920. // Copy received GPS Epoch time into system time
  1921. sysTime = gpsEpochTime;
  1922. // Add Unix to Gps epcoh offset. The system time is based on Unix time.
  1923. sysTime.Seconds += UNIX_GPS_EPOCH_OFFSET;
  1924. // Compensate time difference between Tx Done time and now
  1925. //sysTimeCurrent = SysTimeGet( );
  1926. //sysTime = SysTimeAdd( sysTimeCurrent, SysTimeSub( sysTime, MacCtx.LastTxSysTime ) );
  1927. // Apply the new system time.
  1928. // SysTimeSet( sysTime );
  1929. LoRaMacClassBDeviceTimeAns( );
  1930. MacCtx.McpsIndication.DeviceTimeAnsReceived = true;
  1931. break;
  1932. }
  1933. case SRV_MAC_PING_SLOT_INFO_ANS:
  1934. {
  1935. // According to the specification, it is not allowed to process this answer in
  1936. // a ping or multicast slot
  1937. if( ( MacCtx.RxSlot != RX_SLOT_WIN_CLASS_B_PING_SLOT ) && ( MacCtx.RxSlot != RX_SLOT_WIN_CLASS_B_MULTICAST_SLOT ) )
  1938. {
  1939. LoRaMacClassBPingSlotInfoAns( );
  1940. }
  1941. break;
  1942. }
  1943. case SRV_MAC_PING_SLOT_CHANNEL_REQ:
  1944. {
  1945. uint8_t status = 0x03;
  1946. uint32_t frequency = 0;
  1947. uint8_t datarate;
  1948. frequency = ( uint32_t )payload[macIndex++];
  1949. frequency |= ( uint32_t )payload[macIndex++] << 8;
  1950. frequency |= ( uint32_t )payload[macIndex++] << 16;
  1951. frequency *= 100;
  1952. datarate = payload[macIndex++] & 0x0F;
  1953. status = LoRaMacClassBPingSlotChannelReq( datarate, frequency );
  1954. macCmdPayload[0] = status;
  1955. LoRaMacCommandsAddCmd( MOTE_MAC_PING_SLOT_FREQ_ANS, macCmdPayload, 1 );
  1956. break;
  1957. }
  1958. case SRV_MAC_BEACON_TIMING_ANS:
  1959. {
  1960. uint16_t beaconTimingDelay = 0;
  1961. uint8_t beaconTimingChannel = 0;
  1962. beaconTimingDelay = ( uint16_t )payload[macIndex++];
  1963. beaconTimingDelay |= ( uint16_t )payload[macIndex++] << 8;
  1964. beaconTimingChannel = payload[macIndex++];
  1965. LoRaMacClassBBeaconTimingAns( beaconTimingDelay, beaconTimingChannel, RxDoneParams.LastRxDone );
  1966. break;
  1967. }
  1968. case SRV_MAC_BEACON_FREQ_REQ:
  1969. {
  1970. uint32_t frequency = 0;
  1971. frequency = ( uint32_t )payload[macIndex++];
  1972. frequency |= ( uint32_t )payload[macIndex++] << 8;
  1973. frequency |= ( uint32_t )payload[macIndex++] << 16;
  1974. frequency *= 100;
  1975. if( LoRaMacClassBBeaconFreqReq( frequency ) == true )
  1976. {
  1977. macCmdPayload[0] = 1;
  1978. }
  1979. else
  1980. {
  1981. macCmdPayload[0] = 0;
  1982. }
  1983. LoRaMacCommandsAddCmd( MOTE_MAC_BEACON_FREQ_ANS, macCmdPayload, 1 );
  1984. }
  1985. break;
  1986. default:
  1987. // Unknown command. ABORT MAC commands processing
  1988. return;
  1989. }
  1990. }
  1991. }
  1992. LoRaMacStatus_t Send( LoRaMacHeader_t* macHdr, uint8_t fPort, void* fBuffer, uint16_t fBufferSize )
  1993. {
  1994. LoRaMacFrameCtrl_t fCtrl;
  1995. LoRaMacStatus_t status = LORAMAC_STATUS_PARAMETER_INVALID;
  1996. int8_t datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  1997. int8_t txPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  1998. uint32_t adrAckCounter = MacCtx.NvmCtx->AdrAckCounter;
  1999. CalcNextAdrParams_t adrNext;
  2000. // Check if we are joined
  2001. if( MacCtx.NvmCtx->NetworkActivation == ACTIVATION_TYPE_NONE )
  2002. {
  2003. return LORAMAC_STATUS_NO_NETWORK_JOINED;
  2004. }
  2005. if( MacCtx.NvmCtx->MaxDCycle == 0 )
  2006. {
  2007. MacCtx.NvmCtx->AggregatedTimeOff = 0;
  2008. }
  2009. fCtrl.Value = 0;
  2010. fCtrl.Bits.FOptsLen = 0;
  2011. fCtrl.Bits.Adr = MacCtx.NvmCtx->AdrCtrlOn;
  2012. // Check class b
  2013. if( MacCtx.NvmCtx->DeviceClass == CLASS_B )
  2014. {
  2015. fCtrl.Bits.FPending = 1;
  2016. }
  2017. else
  2018. {
  2019. fCtrl.Bits.FPending = 0;
  2020. }
  2021. // Check server ack
  2022. if( MacCtx.NvmCtx->SrvAckRequested == true )
  2023. {
  2024. fCtrl.Bits.Ack = 1;
  2025. }
  2026. // ADR next request
  2027. adrNext.Version = MacCtx.NvmCtx->Version;
  2028. adrNext.UpdateChanMask = true;
  2029. adrNext.AdrEnabled = fCtrl.Bits.Adr;
  2030. adrNext.AdrAckCounter = MacCtx.NvmCtx->AdrAckCounter;
  2031. adrNext.AdrAckLimit = MacCtx.AdrAckLimit;
  2032. adrNext.AdrAckDelay = MacCtx.AdrAckDelay;
  2033. adrNext.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2034. adrNext.TxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  2035. adrNext.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  2036. adrNext.Region = MacCtx.NvmCtx->Region;
  2037. fCtrl.Bits.AdrAckReq = LoRaMacAdrCalcNext( &adrNext, &MacCtx.NvmCtx->MacParams.ChannelsDatarate,
  2038. &MacCtx.NvmCtx->MacParams.ChannelsTxPower, &adrAckCounter );
  2039. // Prepare the frame
  2040. status = PrepareFrame( macHdr, &fCtrl, fPort, fBuffer, fBufferSize );
  2041. // Validate status
  2042. if( ( status == LORAMAC_STATUS_OK ) || ( status == LORAMAC_STATUS_SKIPPED_APP_DATA ) )
  2043. {
  2044. // Schedule frame, do not allow delayed transmissions
  2045. status = ScheduleTx( false );
  2046. }
  2047. // Post processing
  2048. if( status != LORAMAC_STATUS_OK )
  2049. {
  2050. // Bad case - restore
  2051. // Store local variables
  2052. MacCtx.NvmCtx->MacParams.ChannelsDatarate = datarate;
  2053. MacCtx.NvmCtx->MacParams.ChannelsTxPower = txPower;
  2054. }
  2055. else
  2056. {
  2057. // Good case
  2058. MacCtx.NvmCtx->SrvAckRequested = false;
  2059. MacCtx.NvmCtx->AdrAckCounter = adrAckCounter;
  2060. // Remove all none sticky MAC commands
  2061. if( LoRaMacCommandsRemoveNoneStickyCmds( ) != LORAMAC_COMMANDS_SUCCESS )
  2062. {
  2063. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2064. }
  2065. }
  2066. return status;
  2067. }
  2068. LoRaMacStatus_t SendReJoinReq( JoinReqIdentifier_t joinReqType )
  2069. {
  2070. LoRaMacStatus_t status = LORAMAC_STATUS_OK;
  2071. LoRaMacHeader_t macHdr;
  2072. macHdr.Value = 0;
  2073. bool allowDelayedTx = true;
  2074. // Setup join/rejoin message
  2075. switch( joinReqType )
  2076. {
  2077. case JOIN_REQ:
  2078. {
  2079. SwitchClass( CLASS_A );
  2080. MacCtx.TxMsg.Type = LORAMAC_MSG_TYPE_JOIN_REQUEST;
  2081. MacCtx.TxMsg.Message.JoinReq.Buffer = MacCtx.PktBuffer;
  2082. MacCtx.TxMsg.Message.JoinReq.BufSize = LORAMAC_PHY_MAXPAYLOAD;
  2083. macHdr.Bits.MType = FRAME_TYPE_JOIN_REQ;
  2084. MacCtx.TxMsg.Message.JoinReq.MHDR.Value = macHdr.Value;
  2085. memcpy1( MacCtx.TxMsg.Message.JoinReq.JoinEUI, SecureElementGetJoinEui( ), LORAMAC_JOIN_EUI_FIELD_SIZE );
  2086. memcpy1( MacCtx.TxMsg.Message.JoinReq.DevEUI, SecureElementGetDevEui( ), LORAMAC_DEV_EUI_FIELD_SIZE );
  2087. allowDelayedTx = false;
  2088. break;
  2089. }
  2090. default:
  2091. status = LORAMAC_STATUS_SERVICE_UNKNOWN;
  2092. break;
  2093. }
  2094. // Schedule frame
  2095. status = ScheduleTx( allowDelayedTx );
  2096. return status;
  2097. }
  2098. static LoRaMacStatus_t CheckForClassBCollision( void )
  2099. {
  2100. if( LoRaMacClassBIsBeaconExpected( ) == true )
  2101. {
  2102. return LORAMAC_STATUS_BUSY_BEACON_RESERVED_TIME;
  2103. }
  2104. if( MacCtx.NvmCtx->DeviceClass == CLASS_B )
  2105. {
  2106. if( LoRaMacClassBIsPingExpected( ) == true )
  2107. {
  2108. return LORAMAC_STATUS_BUSY_PING_SLOT_WINDOW_TIME;
  2109. }
  2110. else if( LoRaMacClassBIsMulticastExpected( ) == true )
  2111. {
  2112. return LORAMAC_STATUS_BUSY_PING_SLOT_WINDOW_TIME;
  2113. }
  2114. }
  2115. return LORAMAC_STATUS_OK;
  2116. }
  2117. static LoRaMacStatus_t ScheduleTx( bool allowDelayedTx )
  2118. {
  2119. LoRaMacStatus_t status = LORAMAC_STATUS_PARAMETER_INVALID;
  2120. TimerTime_t dutyCycleTimeOff = 0;
  2121. NextChanParams_t nextChan;
  2122. size_t macCmdsSize = 0;
  2123. // Check class b collisions
  2124. status = CheckForClassBCollision( );
  2125. if( status != LORAMAC_STATUS_OK )
  2126. {
  2127. return status;
  2128. }
  2129. // Update back-off
  2130. CalculateBackOff( MacCtx.NvmCtx->LastTxChannel );
  2131. nextChan.AggrTimeOff = MacCtx.NvmCtx->AggregatedTimeOff;
  2132. nextChan.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2133. nextChan.DutyCycleEnabled = MacCtx.NvmCtx->DutyCycleOn;
  2134. if( MacCtx.NvmCtx->NetworkActivation == ACTIVATION_TYPE_NONE )
  2135. {
  2136. nextChan.Joined = false;
  2137. }
  2138. else
  2139. {
  2140. nextChan.Joined = true;
  2141. }
  2142. nextChan.LastAggrTx = MacCtx.NvmCtx->LastTxDoneTime;
  2143. // Select channel
  2144. status = RegionNextChannel( MacCtx.NvmCtx->Region, &nextChan, &MacCtx.Channel, &dutyCycleTimeOff, &MacCtx.NvmCtx->AggregatedTimeOff );
  2145. if( status != LORAMAC_STATUS_OK )
  2146. {
  2147. if( ( status == LORAMAC_STATUS_DUTYCYCLE_RESTRICTED ) &&
  2148. ( allowDelayedTx == true ) )
  2149. {
  2150. // Allow delayed transmissions. We have to allow it in case
  2151. // the MAC must retransmit a frame with the frame repetitions
  2152. if( dutyCycleTimeOff != 0 )
  2153. {// Send later - prepare timer
  2154. MacCtx.MacState |= LORAMAC_TX_DELAYED;
  2155. TimerSetValue( &MacCtx.TxDelayedTimer, dutyCycleTimeOff );
  2156. TimerStart( &MacCtx.TxDelayedTimer );
  2157. }
  2158. return LORAMAC_STATUS_OK;
  2159. }
  2160. else
  2161. {// State where the MAC cannot send a frame
  2162. return status;
  2163. }
  2164. }
  2165. // Compute Rx1 windows parameters
  2166. RegionComputeRxWindowParameters( MacCtx.NvmCtx->Region,
  2167. RegionApplyDrOffset( MacCtx.NvmCtx->Region, MacCtx.NvmCtx->MacParams.DownlinkDwellTime, MacCtx.NvmCtx->MacParams.ChannelsDatarate, MacCtx.NvmCtx->MacParams.Rx1DrOffset ),
  2168. MacCtx.NvmCtx->MacParams.MinRxSymbols,
  2169. MacCtx.NvmCtx->MacParams.SystemMaxRxError,
  2170. &MacCtx.RxWindow1Config );
  2171. // Compute Rx2 windows parameters
  2172. RegionComputeRxWindowParameters( MacCtx.NvmCtx->Region,
  2173. MacCtx.NvmCtx->MacParams.Rx2Channel.Datarate,
  2174. MacCtx.NvmCtx->MacParams.MinRxSymbols,
  2175. MacCtx.NvmCtx->MacParams.SystemMaxRxError,
  2176. &MacCtx.RxWindow2Config );
  2177. if( MacCtx.NvmCtx->NetworkActivation == ACTIVATION_TYPE_NONE )
  2178. {
  2179. MacCtx.RxWindow1Delay = MacCtx.NvmCtx->MacParams.JoinAcceptDelay1 + MacCtx.RxWindow1Config.WindowOffset;
  2180. MacCtx.RxWindow2Delay = MacCtx.NvmCtx->MacParams.JoinAcceptDelay2 + MacCtx.RxWindow2Config.WindowOffset;
  2181. }
  2182. else
  2183. {
  2184. if( LoRaMacCommandsGetSizeSerializedCmds( &macCmdsSize ) != LORAMAC_COMMANDS_SUCCESS )
  2185. {
  2186. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2187. }
  2188. if( ValidatePayloadLength( MacCtx.AppDataSize, MacCtx.NvmCtx->MacParams.ChannelsDatarate, macCmdsSize ) == false )
  2189. {
  2190. return LORAMAC_STATUS_LENGTH_ERROR;
  2191. }
  2192. MacCtx.RxWindow1Delay = MacCtx.NvmCtx->MacParams.ReceiveDelay1 + MacCtx.RxWindow1Config.WindowOffset;
  2193. MacCtx.RxWindow2Delay = MacCtx.NvmCtx->MacParams.ReceiveDelay2 + MacCtx.RxWindow2Config.WindowOffset;
  2194. }
  2195. // Secure frame
  2196. LoRaMacStatus_t retval = SecureFrame( MacCtx.NvmCtx->MacParams.ChannelsDatarate, MacCtx.Channel );
  2197. if( retval != LORAMAC_STATUS_OK )
  2198. {
  2199. return retval;
  2200. }
  2201. // Try to send now
  2202. return SendFrameOnChannel( MacCtx.Channel );
  2203. }
  2204. static LoRaMacStatus_t SecureFrame( uint8_t txDr, uint8_t txCh )
  2205. {
  2206. LoRaMacCryptoStatus_t macCryptoStatus = LORAMAC_CRYPTO_ERROR;
  2207. uint32_t fCntUp = 0;
  2208. switch( MacCtx.TxMsg.Type )
  2209. {
  2210. case LORAMAC_MSG_TYPE_JOIN_REQUEST:
  2211. macCryptoStatus = LoRaMacCryptoPrepareJoinRequest( &MacCtx.TxMsg.Message.JoinReq );
  2212. if( LORAMAC_CRYPTO_SUCCESS != macCryptoStatus )
  2213. {
  2214. return LORAMAC_STATUS_CRYPTO_ERROR;
  2215. }
  2216. MacCtx.PktBufferLen = MacCtx.TxMsg.Message.JoinReq.BufSize;
  2217. break;
  2218. case LORAMAC_MSG_TYPE_DATA:
  2219. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoGetFCntUp( &fCntUp ) )
  2220. {
  2221. return LORAMAC_STATUS_FCNT_HANDLER_ERROR;
  2222. }
  2223. if( ( MacCtx.ChannelsNbTransCounter >= 1 ) || ( MacCtx.AckTimeoutRetriesCounter > 1 ) )
  2224. {
  2225. fCntUp -= 1;
  2226. }
  2227. macCryptoStatus = LoRaMacCryptoSecureMessage( fCntUp, txDr, txCh, &MacCtx.TxMsg.Message.Data );
  2228. if( LORAMAC_CRYPTO_SUCCESS != macCryptoStatus )
  2229. {
  2230. return LORAMAC_STATUS_CRYPTO_ERROR;
  2231. }
  2232. MacCtx.PktBufferLen = MacCtx.TxMsg.Message.Data.BufSize;
  2233. break;
  2234. case LORAMAC_MSG_TYPE_JOIN_ACCEPT:
  2235. case LORAMAC_MSG_TYPE_UNDEF:
  2236. default:
  2237. return LORAMAC_STATUS_PARAMETER_INVALID;
  2238. }
  2239. return LORAMAC_STATUS_OK;
  2240. }
  2241. static void CalculateBackOff( uint8_t channel )
  2242. {
  2243. CalcBackOffParams_t calcBackOff;
  2244. if( MacCtx.NvmCtx->NetworkActivation == ACTIVATION_TYPE_NONE )
  2245. {
  2246. calcBackOff.Joined = false;
  2247. }
  2248. else
  2249. {
  2250. calcBackOff.Joined = true;
  2251. }
  2252. calcBackOff.DutyCycleEnabled = MacCtx.NvmCtx->DutyCycleOn;
  2253. calcBackOff.Channel = channel;
  2254. //calcBackOff.ElapsedTime = SysTimeSub( SysTimeGetMcuTime( ), MacCtx.NvmCtx->InitializationTime );
  2255. calcBackOff.TxTimeOnAir = MacCtx.TxTimeOnAir;
  2256. calcBackOff.LastTxIsJoinRequest = false;
  2257. if( ( MacCtx.MacFlags.Bits.MlmeReq == 1 ) && ( LoRaMacConfirmQueueIsCmdActive( MLME_JOIN ) == true ) )
  2258. {
  2259. calcBackOff.LastTxIsJoinRequest = true;
  2260. }
  2261. // Update regional back-off
  2262. RegionCalcBackOff( MacCtx.NvmCtx->Region, &calcBackOff );
  2263. // Update aggregated time-off. This must be an assignment and no incremental
  2264. // update as we do only calculate the time-off based on the last transmission
  2265. MacCtx.NvmCtx->AggregatedTimeOff = ( MacCtx.TxTimeOnAir * MacCtx.NvmCtx->AggregatedDCycle - MacCtx.TxTimeOnAir );
  2266. }
  2267. static void RemoveMacCommands( LoRaMacRxSlot_t rxSlot, LoRaMacFrameCtrl_t fCtrl, Mcps_t request )
  2268. {
  2269. if( rxSlot == RX_SLOT_WIN_1 || rxSlot == RX_SLOT_WIN_2 )
  2270. {
  2271. // Remove all sticky MAC commands answers since we can assume
  2272. // that they have been received by the server.
  2273. if( request == MCPS_CONFIRMED )
  2274. {
  2275. if( fCtrl.Bits.Ack == 1 )
  2276. { // For confirmed uplinks only if we have received an ACK.
  2277. LoRaMacCommandsRemoveStickyAnsCmds( );
  2278. }
  2279. }
  2280. else
  2281. {
  2282. LoRaMacCommandsRemoveStickyAnsCmds( );
  2283. }
  2284. }
  2285. }
  2286. static void ResetMacParameters( void )
  2287. {
  2288. MacCtx.NvmCtx->NetworkActivation = ACTIVATION_TYPE_NONE;
  2289. // ADR counter
  2290. MacCtx.NvmCtx->AdrAckCounter = 0;
  2291. MacCtx.ChannelsNbTransCounter = 0;
  2292. MacCtx.AckTimeoutRetries = 1;
  2293. MacCtx.AckTimeoutRetriesCounter = 1;
  2294. MacCtx.AckTimeoutRetry = false;
  2295. MacCtx.NvmCtx->MaxDCycle = 0;
  2296. MacCtx.NvmCtx->AggregatedDCycle = 1;
  2297. MacCtx.NvmCtx->MacParams.ChannelsTxPower = MacCtx.NvmCtx->MacParamsDefaults.ChannelsTxPower;
  2298. MacCtx.NvmCtx->MacParams.ChannelsDatarate = MacCtx.NvmCtx->MacParamsDefaults.ChannelsDatarate;
  2299. MacCtx.NvmCtx->MacParams.Rx1DrOffset = MacCtx.NvmCtx->MacParamsDefaults.Rx1DrOffset;
  2300. MacCtx.NvmCtx->MacParams.Rx2Channel = MacCtx.NvmCtx->MacParamsDefaults.Rx2Channel;
  2301. MacCtx.NvmCtx->MacParams.RxCChannel = MacCtx.NvmCtx->MacParamsDefaults.RxCChannel;
  2302. MacCtx.NvmCtx->MacParams.UplinkDwellTime = MacCtx.NvmCtx->MacParamsDefaults.UplinkDwellTime;
  2303. MacCtx.NvmCtx->MacParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParamsDefaults.DownlinkDwellTime;
  2304. MacCtx.NvmCtx->MacParams.MaxEirp = MacCtx.NvmCtx->MacParamsDefaults.MaxEirp;
  2305. MacCtx.NvmCtx->MacParams.AntennaGain = MacCtx.NvmCtx->MacParamsDefaults.AntennaGain;
  2306. MacCtx.NodeAckRequested = false;
  2307. MacCtx.NvmCtx->SrvAckRequested = false;
  2308. // Reset to application defaults
  2309. InitDefaultsParams_t params;
  2310. params.Type = INIT_TYPE_RESTORE_DEFAULT_CHANNELS;
  2311. params.NvmCtx = NULL;
  2312. RegionInitDefaults( MacCtx.NvmCtx->Region, &params );
  2313. // Initialize channel index.
  2314. MacCtx.Channel = 0;
  2315. MacCtx.NvmCtx->LastTxChannel = MacCtx.Channel;
  2316. // Initialize Rx2 config parameters.
  2317. MacCtx.RxWindow2Config.Channel = MacCtx.Channel;
  2318. MacCtx.RxWindow2Config.Frequency = MacCtx.NvmCtx->MacParams.Rx2Channel.Frequency;
  2319. MacCtx.RxWindow2Config.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  2320. MacCtx.RxWindow2Config.RepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  2321. MacCtx.RxWindow2Config.RxContinuous = false;
  2322. MacCtx.RxWindow2Config.RxSlot = RX_SLOT_WIN_2;
  2323. // Initialize RxC config parameters.
  2324. MacCtx.RxWindowCConfig = MacCtx.RxWindow2Config;
  2325. MacCtx.RxWindowCConfig.RxContinuous = true;
  2326. MacCtx.RxWindowCConfig.RxSlot = RX_SLOT_WIN_CLASS_C;
  2327. }
  2328. /*!
  2329. * \brief Initializes and opens the reception window
  2330. *
  2331. * \param [IN] rxTimer Window timer to be topped.
  2332. * \param [IN] rxConfig Window parameters to be setup
  2333. */
  2334. static void RxWindowSetup( TimerEvent_t* rxTimer, RxConfigParams_t* rxConfig )
  2335. {
  2336. TimerStop( rxTimer );
  2337. // Ensure the radio is Idle
  2338. Radio.Standby( );
  2339. if( RegionRxConfig( MacCtx.NvmCtx->Region, rxConfig, ( int8_t* )&MacCtx.McpsIndication.RxDatarate ) == true )
  2340. {
  2341. Radio.Rx( MacCtx.NvmCtx->MacParams.MaxRxWindow );
  2342. MacCtx.RxSlot = rxConfig->RxSlot;
  2343. }
  2344. }
  2345. static void OpenContinuousRxCWindow( void )
  2346. {
  2347. // Compute RxC windows parameters
  2348. RegionComputeRxWindowParameters( MacCtx.NvmCtx->Region,
  2349. MacCtx.NvmCtx->MacParams.RxCChannel.Datarate,
  2350. MacCtx.NvmCtx->MacParams.MinRxSymbols,
  2351. MacCtx.NvmCtx->MacParams.SystemMaxRxError,
  2352. &MacCtx.RxWindowCConfig );
  2353. MacCtx.RxWindowCConfig.RxSlot = RX_SLOT_WIN_CLASS_C;
  2354. // Setup continuous listening
  2355. MacCtx.RxWindowCConfig.RxContinuous = true;
  2356. // At this point the Radio should be idle.
  2357. // Thus, there is no need to set the radio in standby mode.
  2358. if( RegionRxConfig( MacCtx.NvmCtx->Region, &MacCtx.RxWindowCConfig, ( int8_t* )&MacCtx.McpsIndication.RxDatarate ) == true )
  2359. {
  2360. Radio.Rx( 0 ); // Continuous mode
  2361. MacCtx.RxSlot = MacCtx.RxWindowCConfig.RxSlot;
  2362. }
  2363. }
  2364. LoRaMacStatus_t PrepareFrame( LoRaMacHeader_t* macHdr, LoRaMacFrameCtrl_t* fCtrl, uint8_t fPort, void* fBuffer, uint16_t fBufferSize )
  2365. {
  2366. MacCtx.PktBufferLen = 0;
  2367. MacCtx.NodeAckRequested = false;
  2368. uint32_t fCntUp = 0;
  2369. size_t macCmdsSize = 0;
  2370. uint8_t availableSize = 0;
  2371. if( fBuffer == NULL )
  2372. {
  2373. fBufferSize = 0;
  2374. }
  2375. memcpy1( MacCtx.AppData, ( uint8_t* ) fBuffer, fBufferSize );
  2376. MacCtx.AppDataSize = fBufferSize;
  2377. MacCtx.PktBuffer[0] = macHdr->Value;
  2378. switch( macHdr->Bits.MType )
  2379. {
  2380. case FRAME_TYPE_DATA_CONFIRMED_UP:
  2381. MacCtx.NodeAckRequested = true;
  2382. // Intentional fall through
  2383. case FRAME_TYPE_DATA_UNCONFIRMED_UP:
  2384. MacCtx.TxMsg.Type = LORAMAC_MSG_TYPE_DATA;
  2385. MacCtx.TxMsg.Message.Data.Buffer = MacCtx.PktBuffer;
  2386. MacCtx.TxMsg.Message.Data.BufSize = LORAMAC_PHY_MAXPAYLOAD;
  2387. MacCtx.TxMsg.Message.Data.MHDR.Value = macHdr->Value;
  2388. MacCtx.TxMsg.Message.Data.FPort = fPort;
  2389. MacCtx.TxMsg.Message.Data.FHDR.DevAddr = MacCtx.NvmCtx->DevAddr;
  2390. MacCtx.TxMsg.Message.Data.FHDR.FCtrl.Value = fCtrl->Value;
  2391. MacCtx.TxMsg.Message.Data.FRMPayloadSize = MacCtx.AppDataSize;
  2392. MacCtx.TxMsg.Message.Data.FRMPayload = MacCtx.AppData;
  2393. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoGetFCntUp( &fCntUp ) )
  2394. {
  2395. return LORAMAC_STATUS_FCNT_HANDLER_ERROR;
  2396. }
  2397. MacCtx.TxMsg.Message.Data.FHDR.FCnt = ( uint16_t )fCntUp;
  2398. // Reset confirm parameters
  2399. MacCtx.McpsConfirm.NbRetries = 0;
  2400. MacCtx.McpsConfirm.AckReceived = false;
  2401. MacCtx.McpsConfirm.UpLinkCounter = fCntUp;
  2402. // Handle the MAC commands if there are any available
  2403. if( LoRaMacCommandsGetSizeSerializedCmds( &macCmdsSize ) != LORAMAC_COMMANDS_SUCCESS )
  2404. {
  2405. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2406. }
  2407. if( macCmdsSize > 0 )
  2408. {
  2409. availableSize = GetMaxAppPayloadWithoutFOptsLength( MacCtx.NvmCtx->MacParams.ChannelsDatarate );
  2410. // There is application payload available and the MAC commands fit into FOpts field.
  2411. if( ( MacCtx.AppDataSize > 0 ) && ( macCmdsSize <= LORA_MAC_COMMAND_MAX_FOPTS_LENGTH ) )
  2412. {
  2413. if( LoRaMacCommandsSerializeCmds( LORA_MAC_COMMAND_MAX_FOPTS_LENGTH, &macCmdsSize, MacCtx.TxMsg.Message.Data.FHDR.FOpts ) != LORAMAC_COMMANDS_SUCCESS )
  2414. {
  2415. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2416. }
  2417. fCtrl->Bits.FOptsLen = macCmdsSize;
  2418. // Update FCtrl field with new value of FOptionsLength
  2419. MacCtx.TxMsg.Message.Data.FHDR.FCtrl.Value = fCtrl->Value;
  2420. }
  2421. // There is application payload available but the MAC commands does NOT fit into FOpts field.
  2422. else if( ( MacCtx.AppDataSize > 0 ) && ( macCmdsSize > LORA_MAC_COMMAND_MAX_FOPTS_LENGTH ) )
  2423. {
  2424. if( LoRaMacCommandsSerializeCmds( availableSize, &macCmdsSize, MacCtx.NvmCtx->MacCommandsBuffer ) != LORAMAC_COMMANDS_SUCCESS )
  2425. {
  2426. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2427. }
  2428. return LORAMAC_STATUS_SKIPPED_APP_DATA;
  2429. }
  2430. // No application payload available therefore add all mac commands to the FRMPayload.
  2431. else
  2432. {
  2433. if( LoRaMacCommandsSerializeCmds( availableSize, &macCmdsSize, MacCtx.NvmCtx->MacCommandsBuffer ) != LORAMAC_COMMANDS_SUCCESS )
  2434. {
  2435. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2436. }
  2437. // Force FPort to be zero
  2438. MacCtx.TxMsg.Message.Data.FPort = 0;
  2439. MacCtx.TxMsg.Message.Data.FRMPayload = MacCtx.NvmCtx->MacCommandsBuffer;
  2440. MacCtx.TxMsg.Message.Data.FRMPayloadSize = macCmdsSize;
  2441. }
  2442. }
  2443. break;
  2444. case FRAME_TYPE_PROPRIETARY:
  2445. if( ( fBuffer != NULL ) && ( MacCtx.AppDataSize > 0 ) )
  2446. {
  2447. memcpy1( MacCtx.PktBuffer + LORAMAC_MHDR_FIELD_SIZE, ( uint8_t* ) fBuffer, MacCtx.AppDataSize );
  2448. MacCtx.PktBufferLen = LORAMAC_MHDR_FIELD_SIZE + MacCtx.AppDataSize;
  2449. }
  2450. break;
  2451. default:
  2452. return LORAMAC_STATUS_SERVICE_UNKNOWN;
  2453. }
  2454. return LORAMAC_STATUS_OK;
  2455. }
  2456. LoRaMacStatus_t SendFrameOnChannel( uint8_t channel )
  2457. {
  2458. TxConfigParams_t txConfig;
  2459. int8_t txPower = 0;
  2460. txConfig.Channel = channel;
  2461. txConfig.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2462. txConfig.TxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  2463. txConfig.MaxEirp = MacCtx.NvmCtx->MacParams.MaxEirp;
  2464. txConfig.AntennaGain = MacCtx.NvmCtx->MacParams.AntennaGain;
  2465. txConfig.PktLen = MacCtx.PktBufferLen;
  2466. RegionTxConfig( MacCtx.NvmCtx->Region, &txConfig, &txPower, &MacCtx.TxTimeOnAir );
  2467. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  2468. MacCtx.McpsConfirm.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2469. MacCtx.McpsConfirm.TxPower = txPower;
  2470. MacCtx.McpsConfirm.Channel = channel;
  2471. // Store the time on air
  2472. MacCtx.McpsConfirm.TxTimeOnAir = MacCtx.TxTimeOnAir;
  2473. MacCtx.MlmeConfirm.TxTimeOnAir = MacCtx.TxTimeOnAir;
  2474. if( LoRaMacClassBIsBeaconModeActive( ) == true )
  2475. {
  2476. // Currently, the Time-On-Air can only be computed when the radio is configured with
  2477. // the TX configuration
  2478. TimerTime_t collisionTime = LoRaMacClassBIsUplinkCollision( MacCtx.TxTimeOnAir );
  2479. if( collisionTime > 0 )
  2480. {
  2481. return LORAMAC_STATUS_BUSY_UPLINK_COLLISION;
  2482. }
  2483. }
  2484. if( MacCtx.NvmCtx->DeviceClass == CLASS_B )
  2485. {
  2486. // Stop slots for class b
  2487. LoRaMacClassBStopRxSlots( );
  2488. }
  2489. LoRaMacClassBHaltBeaconing( );
  2490. MacCtx.MacState |= LORAMAC_TX_RUNNING;
  2491. if( MacCtx.NodeAckRequested == false )
  2492. {
  2493. MacCtx.ChannelsNbTransCounter++;
  2494. }
  2495. // Send now
  2496. Radio.Send( MacCtx.PktBuffer, MacCtx.PktBufferLen );
  2497. return LORAMAC_STATUS_OK;
  2498. }
  2499. LoRaMacStatus_t SetTxContinuousWave( uint16_t timeout )
  2500. {
  2501. ContinuousWaveParams_t continuousWave;
  2502. continuousWave.Channel = MacCtx.Channel;
  2503. continuousWave.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2504. continuousWave.TxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  2505. continuousWave.MaxEirp = MacCtx.NvmCtx->MacParams.MaxEirp;
  2506. continuousWave.AntennaGain = MacCtx.NvmCtx->MacParams.AntennaGain;
  2507. continuousWave.Timeout = timeout;
  2508. RegionSetContinuousWave( MacCtx.NvmCtx->Region, &continuousWave );
  2509. MacCtx.MacState |= LORAMAC_TX_RUNNING;
  2510. return LORAMAC_STATUS_OK;
  2511. }
  2512. LoRaMacStatus_t SetTxContinuousWave1( uint16_t timeout, uint32_t frequency, uint8_t power )
  2513. {
  2514. Radio.SetTxContinuousWave( frequency, power, timeout );
  2515. MacCtx.MacState |= LORAMAC_TX_RUNNING;
  2516. return LORAMAC_STATUS_OK;
  2517. }
  2518. LoRaMacCtxs_t* GetCtxs( void )
  2519. {
  2520. Contexts.MacNvmCtx = &NvmMacCtx;
  2521. Contexts.MacNvmCtxSize = sizeof( NvmMacCtx );
  2522. Contexts.CryptoNvmCtx = LoRaMacCryptoGetNvmCtx( &Contexts.CryptoNvmCtxSize );
  2523. GetNvmCtxParams_t params ={ 0 };
  2524. Contexts.RegionNvmCtx = RegionGetNvmCtx( MacCtx.NvmCtx->Region, &params );
  2525. Contexts.RegionNvmCtxSize = params.nvmCtxSize;
  2526. Contexts.SecureElementNvmCtx = SecureElementGetNvmCtx( &Contexts.SecureElementNvmCtxSize );
  2527. Contexts.CommandsNvmCtx = LoRaMacCommandsGetNvmCtx( &Contexts.CommandsNvmCtxSize );
  2528. Contexts.ClassBNvmCtx = LoRaMacClassBGetNvmCtx( &Contexts.ClassBNvmCtxSize );
  2529. Contexts.ConfirmQueueNvmCtx = LoRaMacConfirmQueueGetNvmCtx( &Contexts.ConfirmQueueNvmCtxSize );
  2530. return &Contexts;
  2531. }
  2532. LoRaMacStatus_t RestoreCtxs( LoRaMacCtxs_t* contexts )
  2533. {
  2534. if( contexts == NULL )
  2535. {
  2536. return LORAMAC_STATUS_PARAMETER_INVALID;
  2537. }
  2538. if( MacCtx.MacState != LORAMAC_STOPPED )
  2539. {
  2540. return LORAMAC_STATUS_BUSY;
  2541. }
  2542. if( contexts->MacNvmCtx != NULL )
  2543. {
  2544. memcpy1( ( uint8_t* ) &NvmMacCtx, ( uint8_t* ) contexts->MacNvmCtx, contexts->MacNvmCtxSize );
  2545. }
  2546. InitDefaultsParams_t params;
  2547. params.Type = INIT_TYPE_RESTORE_CTX;
  2548. params.NvmCtx = contexts->RegionNvmCtx;
  2549. RegionInitDefaults( MacCtx.NvmCtx->Region, &params );
  2550. // Initialize RxC config parameters.
  2551. MacCtx.RxWindowCConfig.Channel = MacCtx.Channel;
  2552. MacCtx.RxWindowCConfig.Frequency = MacCtx.NvmCtx->MacParams.RxCChannel.Frequency;
  2553. MacCtx.RxWindowCConfig.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  2554. MacCtx.RxWindowCConfig.RepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  2555. MacCtx.RxWindowCConfig.RxContinuous = true;
  2556. MacCtx.RxWindowCConfig.RxSlot = RX_SLOT_WIN_CLASS_C;
  2557. if( SecureElementRestoreNvmCtx( contexts->SecureElementNvmCtx ) != SECURE_ELEMENT_SUCCESS )
  2558. {
  2559. return LORAMAC_STATUS_CRYPTO_ERROR;
  2560. }
  2561. if( LoRaMacCryptoRestoreNvmCtx( contexts->CryptoNvmCtx ) != LORAMAC_CRYPTO_SUCCESS )
  2562. {
  2563. return LORAMAC_STATUS_CRYPTO_ERROR;
  2564. }
  2565. if( LoRaMacCommandsRestoreNvmCtx( contexts->CommandsNvmCtx ) != LORAMAC_COMMANDS_SUCCESS )
  2566. {
  2567. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2568. }
  2569. if( LoRaMacClassBRestoreNvmCtx( contexts->ClassBNvmCtx ) != true )
  2570. {
  2571. return LORAMAC_STATUS_CLASS_B_ERROR;
  2572. }
  2573. if( LoRaMacConfirmQueueRestoreNvmCtx( contexts->ConfirmQueueNvmCtx ) != true )
  2574. {
  2575. return LORAMAC_STATUS_CONFIRM_QUEUE_ERROR;
  2576. }
  2577. return LORAMAC_STATUS_OK;
  2578. }
  2579. LoRaMacStatus_t DetermineFrameType( LoRaMacMessageData_t* macMsg, FType_t* fType )
  2580. {
  2581. if( ( macMsg == NULL ) || ( fType == NULL ) )
  2582. {
  2583. return LORAMAC_STATUS_PARAMETER_INVALID;
  2584. }
  2585. /* The LoRaWAN specification allows several possible configurations how data up/down frames are built up.
  2586. * In sake of clearness the following naming is applied. Please keep in mind that this is
  2587. * implementation specific since there is no definition in the LoRaWAN specification included.
  2588. *
  2589. * X -> Field is available
  2590. * - -> Field is not available
  2591. *
  2592. * +-------+ +----------+------+-------+--------------+
  2593. * | FType | | FOptsLen | Fopt | FPort | FRMPayload |
  2594. * +-------+ +----------+------+-------+--------------+
  2595. * | A | | > 0 | X | > 0 | X |
  2596. * +-------+ +----------+------+-------+--------------+
  2597. * | B | | >= 0 | X/- | - | - |
  2598. * +-------+ +----------+------+-------+--------------+
  2599. * | C | | = 0 | - | = 0 | MAC commands |
  2600. * +-------+ +----------+------+-------+--------------+
  2601. * | D | | = 0 | - | > 0 | X |
  2602. * +-------+ +----------+------+-------+--------------+
  2603. */
  2604. if( ( macMsg->FHDR.FCtrl.Bits.FOptsLen > 0 ) && ( macMsg->FPort > 0 ) )
  2605. {
  2606. *fType = FRAME_TYPE_A;
  2607. }
  2608. else if( macMsg->FRMPayloadSize == 0 )
  2609. {
  2610. *fType = FRAME_TYPE_B;
  2611. }
  2612. else if( ( macMsg->FHDR.FCtrl.Bits.FOptsLen == 0 ) && ( macMsg->FPort == 0 ) )
  2613. {
  2614. *fType = FRAME_TYPE_C;
  2615. }
  2616. else if( ( macMsg->FHDR.FCtrl.Bits.FOptsLen == 0 ) && ( macMsg->FPort > 0 ) )
  2617. {
  2618. *fType = FRAME_TYPE_D;
  2619. }
  2620. else
  2621. {
  2622. // Should never happen.
  2623. return LORAMAC_STATUS_ERROR;
  2624. }
  2625. return LORAMAC_STATUS_OK;
  2626. }
  2627. static bool CheckRetransUnconfirmedUplink( void )
  2628. {
  2629. // Unconfirmed uplink, when all retransmissions are done.
  2630. if( MacCtx.ChannelsNbTransCounter >=
  2631. MacCtx.NvmCtx->MacParams.ChannelsNbTrans )
  2632. {
  2633. return true;
  2634. }
  2635. else if( MacCtx.MacFlags.Bits.McpsInd == 1 )
  2636. {
  2637. // For Class A stop in each case
  2638. if( MacCtx.NvmCtx->DeviceClass == CLASS_A )
  2639. {
  2640. return true;
  2641. }
  2642. else
  2643. {// For Class B & C stop only if the frame was received in RX1 window
  2644. if( MacCtx.McpsIndication.RxSlot == RX_SLOT_WIN_1 )
  2645. {
  2646. return true;
  2647. }
  2648. }
  2649. }
  2650. return false;
  2651. }
  2652. static bool CheckRetransConfirmedUplink( void )
  2653. {
  2654. // Confirmed uplink, when all retransmissions ( tries to get a ack ) are done.
  2655. if( MacCtx.AckTimeoutRetriesCounter >=
  2656. MacCtx.AckTimeoutRetries )
  2657. {
  2658. return true;
  2659. }
  2660. else if( MacCtx.MacFlags.Bits.McpsInd == 1 )
  2661. {
  2662. if( MacCtx.McpsConfirm.AckReceived == true )
  2663. {
  2664. return true;
  2665. }
  2666. }
  2667. return false;
  2668. }
  2669. static bool StopRetransmission( void )
  2670. {
  2671. if( ( MacCtx.MacFlags.Bits.McpsInd == 0 ) ||
  2672. ( ( MacCtx.McpsIndication.RxSlot != RX_SLOT_WIN_1 ) &&
  2673. ( MacCtx.McpsIndication.RxSlot != RX_SLOT_WIN_2 ) ) )
  2674. { // Maximum repetitions without downlink. Increase ADR Ack counter.
  2675. // Only process the case when the MAC did not receive a downlink.
  2676. if( MacCtx.NvmCtx->AdrCtrlOn == true )
  2677. {
  2678. MacCtx.NvmCtx->AdrAckCounter++;
  2679. }
  2680. }
  2681. MacCtx.ChannelsNbTransCounter = 0;
  2682. MacCtx.NodeAckRequested = false;
  2683. MacCtx.AckTimeoutRetry = false;
  2684. MacCtx.MacState &= ~LORAMAC_TX_RUNNING;
  2685. return true;
  2686. }
  2687. static void AckTimeoutRetriesProcess( void )
  2688. {
  2689. if( MacCtx.AckTimeoutRetriesCounter < MacCtx.AckTimeoutRetries )
  2690. {
  2691. MacCtx.AckTimeoutRetriesCounter++;
  2692. if( ( MacCtx.AckTimeoutRetriesCounter % 2 ) == 1 )
  2693. {
  2694. GetPhyParams_t getPhy;
  2695. PhyParam_t phyParam;
  2696. getPhy.Attribute = PHY_NEXT_LOWER_TX_DR;
  2697. getPhy.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  2698. getPhy.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2699. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2700. MacCtx.NvmCtx->MacParams.ChannelsDatarate = phyParam.Value;
  2701. }
  2702. }
  2703. }
  2704. static void AckTimeoutRetriesFinalize( void )
  2705. {
  2706. if( MacCtx.McpsConfirm.AckReceived == false )
  2707. {
  2708. InitDefaultsParams_t params;
  2709. params.Type = INIT_TYPE_RESTORE_DEFAULT_CHANNELS;
  2710. params.NvmCtx = Contexts.RegionNvmCtx;
  2711. RegionInitDefaults( MacCtx.NvmCtx->Region, &params );
  2712. MacCtx.NodeAckRequested = false;
  2713. MacCtx.McpsConfirm.AckReceived = false;
  2714. }
  2715. MacCtx.McpsConfirm.NbRetries = MacCtx.AckTimeoutRetriesCounter;
  2716. }
  2717. static void CallNvmCtxCallback( LoRaMacNvmCtxModule_t module )
  2718. {
  2719. if( ( MacCtx.MacCallbacks != NULL ) && ( MacCtx.MacCallbacks->NvmContextChange != NULL ) )
  2720. {
  2721. MacCtx.MacCallbacks->NvmContextChange( module );
  2722. }
  2723. }
  2724. static void EventMacNvmCtxChanged( void )
  2725. {
  2726. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_MAC );
  2727. }
  2728. static void EventRegionNvmCtxChanged( void )
  2729. {
  2730. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_REGION );
  2731. }
  2732. static void EventCryptoNvmCtxChanged( void )
  2733. {
  2734. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_CRYPTO );
  2735. }
  2736. static void EventSecureElementNvmCtxChanged( void )
  2737. {
  2738. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_SECURE_ELEMENT );
  2739. }
  2740. static void EventCommandsNvmCtxChanged( void )
  2741. {
  2742. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_COMMANDS );
  2743. }
  2744. static void EventClassBNvmCtxChanged( void )
  2745. {
  2746. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_CLASS_B );
  2747. }
  2748. static void EventConfirmQueueNvmCtxChanged( void )
  2749. {
  2750. CallNvmCtxCallback( LORAMAC_NVMCTXMODULE_CONFIRM_QUEUE );
  2751. }
  2752. static uint8_t IsRequestPending( void )
  2753. {
  2754. if( ( MacCtx.MacFlags.Bits.MlmeReq == 1 ) ||
  2755. ( MacCtx.MacFlags.Bits.McpsReq == 1 ) )
  2756. {
  2757. return 1;
  2758. }
  2759. return 0;
  2760. }
  2761. LoRaMacStatus_t LoRaMacInitialization( LoRaMacPrimitives_t* primitives, LoRaMacCallback_t* callbacks, LoRaMacRegion_t region )
  2762. {
  2763. GetPhyParams_t getPhy;
  2764. PhyParam_t phyParam;
  2765. LoRaMacClassBCallback_t classBCallbacks;
  2766. LoRaMacClassBParams_t classBParams;
  2767. if( ( primitives == NULL ) ||
  2768. ( callbacks == NULL ) )
  2769. {
  2770. return LORAMAC_STATUS_PARAMETER_INVALID;
  2771. }
  2772. if( ( primitives->MacMcpsConfirm == NULL ) ||
  2773. ( primitives->MacMcpsIndication == NULL ) ||
  2774. ( primitives->MacMlmeConfirm == NULL ) ||
  2775. ( primitives->MacMlmeIndication == NULL ) )
  2776. {
  2777. return LORAMAC_STATUS_PARAMETER_INVALID;
  2778. }
  2779. // Verify if the region is supported
  2780. if( RegionIsActive( region ) == false )
  2781. {
  2782. return LORAMAC_STATUS_REGION_NOT_SUPPORTED;
  2783. }
  2784. // Confirm queue reset
  2785. LoRaMacConfirmQueueInit( primitives, EventConfirmQueueNvmCtxChanged );
  2786. // Initialize the module context with zeros
  2787. memset1( ( uint8_t* ) &NvmMacCtx, 0x00, sizeof( LoRaMacNvmCtx_t ) );
  2788. memset1( ( uint8_t* ) &MacCtx, 0x00, sizeof( LoRaMacCtx_t ) );
  2789. MacCtx.NvmCtx = &NvmMacCtx;
  2790. // Set non zero variables to its default value
  2791. MacCtx.AckTimeoutRetriesCounter = 1;
  2792. MacCtx.AckTimeoutRetries = 1;
  2793. MacCtx.NvmCtx->Region = region;
  2794. MacCtx.NvmCtx->DeviceClass = CLASS_A;
  2795. MacCtx.NvmCtx->RepeaterSupport = false;
  2796. Version_t lrWanVersion;
  2797. lrWanVersion.Fields.Major = 1;
  2798. lrWanVersion.Fields.Minor = 0;
  2799. lrWanVersion.Fields.Revision = 3;
  2800. lrWanVersion.Fields.Rfu = 0;
  2801. MacCtx.NvmCtx->Version = lrWanVersion;
  2802. // Reset to defaults
  2803. getPhy.Attribute = PHY_DUTY_CYCLE;
  2804. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2805. MacCtx.NvmCtx->DutyCycleOn = ( bool ) phyParam.Value;
  2806. getPhy.Attribute = PHY_DEF_TX_POWER;
  2807. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2808. MacCtx.NvmCtx->MacParamsDefaults.ChannelsTxPower = phyParam.Value;
  2809. getPhy.Attribute = PHY_DEF_TX_DR;
  2810. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2811. MacCtx.NvmCtx->MacParamsDefaults.ChannelsDatarate = phyParam.Value;
  2812. getPhy.Attribute = PHY_MAX_RX_WINDOW;
  2813. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2814. MacCtx.NvmCtx->MacParamsDefaults.MaxRxWindow = phyParam.Value;
  2815. getPhy.Attribute = PHY_RECEIVE_DELAY1;
  2816. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2817. MacCtx.NvmCtx->MacParamsDefaults.ReceiveDelay1 = phyParam.Value;
  2818. getPhy.Attribute = PHY_RECEIVE_DELAY2;
  2819. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2820. MacCtx.NvmCtx->MacParamsDefaults.ReceiveDelay2 = phyParam.Value;
  2821. getPhy.Attribute = PHY_JOIN_ACCEPT_DELAY1;
  2822. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2823. MacCtx.NvmCtx->MacParamsDefaults.JoinAcceptDelay1 = phyParam.Value;
  2824. getPhy.Attribute = PHY_JOIN_ACCEPT_DELAY2;
  2825. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2826. MacCtx.NvmCtx->MacParamsDefaults.JoinAcceptDelay2 = phyParam.Value;
  2827. getPhy.Attribute = PHY_DEF_DR1_OFFSET;
  2828. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2829. MacCtx.NvmCtx->MacParamsDefaults.Rx1DrOffset = phyParam.Value;
  2830. getPhy.Attribute = PHY_DEF_RX2_FREQUENCY;
  2831. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2832. MacCtx.NvmCtx->MacParamsDefaults.Rx2Channel.Frequency = phyParam.Value;
  2833. MacCtx.NvmCtx->MacParamsDefaults.RxCChannel.Frequency = phyParam.Value;
  2834. getPhy.Attribute = PHY_DEF_RX2_DR;
  2835. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2836. MacCtx.NvmCtx->MacParamsDefaults.Rx2Channel.Datarate = phyParam.Value;
  2837. MacCtx.NvmCtx->MacParamsDefaults.RxCChannel.Datarate = phyParam.Value;
  2838. getPhy.Attribute = PHY_DEF_UPLINK_DWELL_TIME;
  2839. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2840. MacCtx.NvmCtx->MacParamsDefaults.UplinkDwellTime = phyParam.Value;
  2841. getPhy.Attribute = PHY_DEF_DOWNLINK_DWELL_TIME;
  2842. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2843. MacCtx.NvmCtx->MacParamsDefaults.DownlinkDwellTime = phyParam.Value;
  2844. getPhy.Attribute = PHY_DEF_MAX_EIRP;
  2845. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2846. MacCtx.NvmCtx->MacParamsDefaults.MaxEirp = phyParam.fValue;
  2847. getPhy.Attribute = PHY_DEF_ANTENNA_GAIN;
  2848. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2849. MacCtx.NvmCtx->MacParamsDefaults.AntennaGain = phyParam.fValue;
  2850. getPhy.Attribute = PHY_DEF_ADR_ACK_LIMIT;
  2851. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2852. MacCtx.AdrAckLimit = phyParam.Value;
  2853. getPhy.Attribute = PHY_DEF_ADR_ACK_DELAY;
  2854. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  2855. MacCtx.AdrAckDelay = phyParam.Value;
  2856. // Init parameters which are not set in function ResetMacParameters
  2857. MacCtx.NvmCtx->MacParamsDefaults.ChannelsNbTrans = 1;
  2858. MacCtx.NvmCtx->MacParamsDefaults.SystemMaxRxError = 10;
  2859. MacCtx.NvmCtx->MacParamsDefaults.MinRxSymbols = 6;
  2860. MacCtx.NvmCtx->MacParams.SystemMaxRxError = MacCtx.NvmCtx->MacParamsDefaults.SystemMaxRxError;
  2861. MacCtx.NvmCtx->MacParams.MinRxSymbols = MacCtx.NvmCtx->MacParamsDefaults.MinRxSymbols;
  2862. MacCtx.NvmCtx->MacParams.MaxRxWindow = MacCtx.NvmCtx->MacParamsDefaults.MaxRxWindow;
  2863. MacCtx.NvmCtx->MacParams.ReceiveDelay1 = MacCtx.NvmCtx->MacParamsDefaults.ReceiveDelay1;
  2864. MacCtx.NvmCtx->MacParams.ReceiveDelay2 = MacCtx.NvmCtx->MacParamsDefaults.ReceiveDelay2;
  2865. MacCtx.NvmCtx->MacParams.JoinAcceptDelay1 = MacCtx.NvmCtx->MacParamsDefaults.JoinAcceptDelay1;
  2866. MacCtx.NvmCtx->MacParams.JoinAcceptDelay2 = MacCtx.NvmCtx->MacParamsDefaults.JoinAcceptDelay2;
  2867. MacCtx.NvmCtx->MacParams.ChannelsNbTrans = MacCtx.NvmCtx->MacParamsDefaults.ChannelsNbTrans;
  2868. ResetMacParameters( );
  2869. MacCtx.NvmCtx->PublicNetwork = true;
  2870. MacCtx.MacPrimitives = primitives;
  2871. MacCtx.MacCallbacks = callbacks;
  2872. MacCtx.MacFlags.Value = 0;
  2873. MacCtx.MacState = LORAMAC_STOPPED;
  2874. // Reset duty cycle times
  2875. MacCtx.NvmCtx->LastTxDoneTime = 0;
  2876. MacCtx.NvmCtx->AggregatedTimeOff = 0;
  2877. // Initialize timers
  2878. TimerInit( &MacCtx.TxDelayedTimer, OnTxDelayedTimerEvent );
  2879. TimerInit( &MacCtx.RxWindowTimer1, OnRxWindow1TimerEvent );
  2880. TimerInit( &MacCtx.RxWindowTimer2, OnRxWindow2TimerEvent );
  2881. TimerInit( &MacCtx.AckTimeoutTimer,OnAckTimeoutTimerEvent );
  2882. // Store the current initialization time
  2883. //MacCtx.NvmCtx->InitializationTime = SysTimeGetMcuTime( );
  2884. // Initialize Radio driver
  2885. MacCtx.RadioEvents.TxDone = OnRadioTxDone;
  2886. MacCtx.RadioEvents.RxDone = OnRadioRxDone;
  2887. MacCtx.RadioEvents.RxError = OnRadioRxError;
  2888. MacCtx.RadioEvents.TxTimeout = OnRadioTxTimeout;
  2889. MacCtx.RadioEvents.RxTimeout = OnRadioRxTimeout;
  2890. Radio.Init( &MacCtx.RadioEvents );
  2891. InitDefaultsParams_t params;
  2892. params.Type = INIT_TYPE_INIT;
  2893. params.NvmCtx = NULL;
  2894. RegionInitDefaults( MacCtx.NvmCtx->Region, &params );
  2895. // Initialize the Secure Element driver
  2896. if( SecureElementInit( EventSecureElementNvmCtxChanged ) != SECURE_ELEMENT_SUCCESS )
  2897. {
  2898. return LORAMAC_STATUS_CRYPTO_ERROR;
  2899. }
  2900. // Initialize Crypto module
  2901. if( LoRaMacCryptoInit( EventCryptoNvmCtxChanged ) != LORAMAC_CRYPTO_SUCCESS )
  2902. {
  2903. return LORAMAC_STATUS_CRYPTO_ERROR;
  2904. }
  2905. // Initialize MAC commands module
  2906. if( LoRaMacCommandsInit( EventCommandsNvmCtxChanged ) != LORAMAC_COMMANDS_SUCCESS )
  2907. {
  2908. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2909. }
  2910. // Set multicast downlink counter reference
  2911. if( LoRaMacCryptoSetMulticastReference( MacCtx.NvmCtx->MulticastChannelList ) != LORAMAC_CRYPTO_SUCCESS )
  2912. {
  2913. return LORAMAC_STATUS_CRYPTO_ERROR;
  2914. }
  2915. // Random seed initialization
  2916. srand1( Radio.Random( ) );
  2917. Radio.SetPublicNetwork( MacCtx.NvmCtx->PublicNetwork );
  2918. Radio.Sleep( );
  2919. // Initialize class b
  2920. // Apply callback
  2921. classBCallbacks.GetTemperatureLevel = NULL;
  2922. classBCallbacks.MacProcessNotify = NULL;
  2923. if( callbacks != NULL )
  2924. {
  2925. classBCallbacks.GetTemperatureLevel = callbacks->GetTemperatureLevel;
  2926. classBCallbacks.MacProcessNotify = callbacks->MacProcessNotify;
  2927. }
  2928. // Must all be static. Don't use local references.
  2929. classBParams.MlmeIndication = &MacCtx.MlmeIndication;
  2930. classBParams.McpsIndication = &MacCtx.McpsIndication;
  2931. classBParams.MlmeConfirm = &MacCtx.MlmeConfirm;
  2932. classBParams.LoRaMacFlags = &MacCtx.MacFlags;
  2933. classBParams.LoRaMacDevAddr = &MacCtx.NvmCtx->DevAddr;
  2934. classBParams.LoRaMacRegion = &MacCtx.NvmCtx->Region;
  2935. classBParams.LoRaMacParams = &MacCtx.NvmCtx->MacParams;
  2936. classBParams.MulticastChannels = &MacCtx.NvmCtx->MulticastChannelList[0];
  2937. LoRaMacClassBInit( &classBParams, &classBCallbacks, &EventClassBNvmCtxChanged );
  2938. LoRaMacEnableRequests( LORAMAC_REQUEST_HANDLING_ON );
  2939. return LORAMAC_STATUS_OK;
  2940. }
  2941. LoRaMacStatus_t LoRaMacStart( void )
  2942. {
  2943. MacCtx.MacState = LORAMAC_IDLE;
  2944. return LORAMAC_STATUS_OK;
  2945. }
  2946. LoRaMacStatus_t LoRaMacStop( void )
  2947. {
  2948. if( LoRaMacIsBusy( ) == false )
  2949. {
  2950. MacCtx.MacState = LORAMAC_STOPPED;
  2951. return LORAMAC_STATUS_OK;
  2952. }
  2953. else if( MacCtx.MacState == LORAMAC_STOPPED )
  2954. {
  2955. return LORAMAC_STATUS_OK;
  2956. }
  2957. return LORAMAC_STATUS_BUSY;
  2958. }
  2959. LoRaMacStatus_t LoRaMacQueryTxPossible( uint8_t size, LoRaMacTxInfo_t* txInfo )
  2960. {
  2961. CalcNextAdrParams_t adrNext;
  2962. uint32_t adrAckCounter = MacCtx.NvmCtx->AdrAckCounter;
  2963. int8_t datarate = MacCtx.NvmCtx->MacParamsDefaults.ChannelsDatarate;
  2964. int8_t txPower = MacCtx.NvmCtx->MacParamsDefaults.ChannelsTxPower;
  2965. size_t macCmdsSize = 0;
  2966. if( txInfo == NULL )
  2967. {
  2968. return LORAMAC_STATUS_PARAMETER_INVALID;
  2969. }
  2970. // Setup ADR request
  2971. adrNext.Version = MacCtx.NvmCtx->Version;
  2972. adrNext.UpdateChanMask = false;
  2973. adrNext.AdrEnabled = MacCtx.NvmCtx->AdrCtrlOn;
  2974. adrNext.AdrAckCounter = MacCtx.NvmCtx->AdrAckCounter;
  2975. adrNext.AdrAckLimit = MacCtx.AdrAckLimit;
  2976. adrNext.AdrAckDelay = MacCtx.AdrAckDelay;
  2977. adrNext.Datarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  2978. adrNext.TxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  2979. adrNext.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  2980. adrNext.Region = MacCtx.NvmCtx->Region;
  2981. // We call the function for information purposes only. We don't want to
  2982. // apply the datarate, the tx power and the ADR ack counter.
  2983. LoRaMacAdrCalcNext( &adrNext, &datarate, &txPower, &adrAckCounter );
  2984. txInfo->CurrentPossiblePayloadSize = GetMaxAppPayloadWithoutFOptsLength( datarate );
  2985. if( LoRaMacCommandsGetSizeSerializedCmds( &macCmdsSize ) != LORAMAC_COMMANDS_SUCCESS )
  2986. {
  2987. return LORAMAC_STATUS_MAC_COMMAD_ERROR;
  2988. }
  2989. // Verify if the MAC commands fit into the FOpts and into the maximum payload.
  2990. if( ( LORA_MAC_COMMAND_MAX_FOPTS_LENGTH >= macCmdsSize ) && ( txInfo->CurrentPossiblePayloadSize >= macCmdsSize ) )
  2991. {
  2992. txInfo->MaxPossibleApplicationDataSize = txInfo->CurrentPossiblePayloadSize - macCmdsSize;
  2993. // Verify if the application data together with MAC command fit into the maximum payload.
  2994. if( txInfo->CurrentPossiblePayloadSize >= ( macCmdsSize + size ) )
  2995. {
  2996. return LORAMAC_STATUS_OK;
  2997. }
  2998. else
  2999. {
  3000. return LORAMAC_STATUS_LENGTH_ERROR;
  3001. }
  3002. }
  3003. else
  3004. {
  3005. txInfo->MaxPossibleApplicationDataSize = 0;
  3006. return LORAMAC_STATUS_LENGTH_ERROR;
  3007. }
  3008. }
  3009. LoRaMacStatus_t LoRaMacMibGetRequestConfirm( MibRequestConfirm_t* mibGet )
  3010. {
  3011. LoRaMacStatus_t status = LORAMAC_STATUS_OK;
  3012. GetPhyParams_t getPhy;
  3013. PhyParam_t phyParam;
  3014. if( mibGet == NULL )
  3015. {
  3016. return LORAMAC_STATUS_PARAMETER_INVALID;
  3017. }
  3018. switch( mibGet->Type )
  3019. {
  3020. case MIB_DEVICE_CLASS:
  3021. {
  3022. mibGet->Param.Class = MacCtx.NvmCtx->DeviceClass;
  3023. break;
  3024. }
  3025. case MIB_NETWORK_ACTIVATION:
  3026. {
  3027. mibGet->Param.NetworkActivation = MacCtx.NvmCtx->NetworkActivation;
  3028. break;
  3029. }
  3030. case MIB_DEV_EUI:
  3031. {
  3032. mibGet->Param.DevEui = SecureElementGetDevEui( );
  3033. break;
  3034. }
  3035. case MIB_JOIN_EUI:
  3036. {
  3037. mibGet->Param.JoinEui = SecureElementGetJoinEui( );
  3038. break;
  3039. }
  3040. case MIB_ADR:
  3041. {
  3042. mibGet->Param.AdrEnable = MacCtx.NvmCtx->AdrCtrlOn;
  3043. break;
  3044. }
  3045. case MIB_NET_ID:
  3046. {
  3047. mibGet->Param.NetID = MacCtx.NvmCtx->NetID;
  3048. break;
  3049. }
  3050. case MIB_DEV_ADDR:
  3051. {
  3052. mibGet->Param.DevAddr = MacCtx.NvmCtx->DevAddr;
  3053. break;
  3054. }
  3055. case MIB_PUBLIC_NETWORK:
  3056. {
  3057. mibGet->Param.EnablePublicNetwork = MacCtx.NvmCtx->PublicNetwork;
  3058. break;
  3059. }
  3060. case MIB_REPEATER_SUPPORT:
  3061. {
  3062. mibGet->Param.EnableRepeaterSupport = MacCtx.NvmCtx->RepeaterSupport;
  3063. break;
  3064. }
  3065. case MIB_CHANNELS:
  3066. {
  3067. getPhy.Attribute = PHY_CHANNELS;
  3068. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  3069. mibGet->Param.ChannelList = phyParam.Channels;
  3070. break;
  3071. }
  3072. case MIB_RX2_CHANNEL:
  3073. {
  3074. mibGet->Param.Rx2Channel = MacCtx.NvmCtx->MacParams.Rx2Channel;
  3075. break;
  3076. }
  3077. case MIB_RX2_DEFAULT_CHANNEL:
  3078. {
  3079. mibGet->Param.Rx2Channel = MacCtx.NvmCtx->MacParamsDefaults.Rx2Channel;
  3080. break;
  3081. }
  3082. case MIB_RXC_CHANNEL:
  3083. {
  3084. mibGet->Param.RxCChannel = MacCtx.NvmCtx->MacParams.RxCChannel;
  3085. break;
  3086. }
  3087. case MIB_RXC_DEFAULT_CHANNEL:
  3088. {
  3089. mibGet->Param.RxCChannel = MacCtx.NvmCtx->MacParamsDefaults.RxCChannel;
  3090. break;
  3091. }
  3092. case MIB_CHANNELS_DEFAULT_MASK:
  3093. {
  3094. getPhy.Attribute = PHY_CHANNELS_DEFAULT_MASK;
  3095. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  3096. mibGet->Param.ChannelsDefaultMask = phyParam.ChannelsMask;
  3097. break;
  3098. }
  3099. case MIB_CHANNELS_MASK:
  3100. {
  3101. getPhy.Attribute = PHY_CHANNELS_MASK;
  3102. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  3103. mibGet->Param.ChannelsMask = phyParam.ChannelsMask;
  3104. break;
  3105. }
  3106. case MIB_CHANNELS_NB_TRANS:
  3107. {
  3108. mibGet->Param.ChannelsNbTrans = MacCtx.NvmCtx->MacParams.ChannelsNbTrans;
  3109. break;
  3110. }
  3111. case MIB_MAX_RX_WINDOW_DURATION:
  3112. {
  3113. mibGet->Param.MaxRxWindow = MacCtx.NvmCtx->MacParams.MaxRxWindow;
  3114. break;
  3115. }
  3116. case MIB_RECEIVE_DELAY_1:
  3117. {
  3118. mibGet->Param.ReceiveDelay1 = MacCtx.NvmCtx->MacParams.ReceiveDelay1;
  3119. break;
  3120. }
  3121. case MIB_RECEIVE_DELAY_2:
  3122. {
  3123. mibGet->Param.ReceiveDelay2 = MacCtx.NvmCtx->MacParams.ReceiveDelay2;
  3124. break;
  3125. }
  3126. case MIB_JOIN_ACCEPT_DELAY_1:
  3127. {
  3128. mibGet->Param.JoinAcceptDelay1 = MacCtx.NvmCtx->MacParams.JoinAcceptDelay1;
  3129. break;
  3130. }
  3131. case MIB_JOIN_ACCEPT_DELAY_2:
  3132. {
  3133. mibGet->Param.JoinAcceptDelay2 = MacCtx.NvmCtx->MacParams.JoinAcceptDelay2;
  3134. break;
  3135. }
  3136. case MIB_CHANNELS_DEFAULT_DATARATE:
  3137. {
  3138. mibGet->Param.ChannelsDefaultDatarate = MacCtx.NvmCtx->MacParamsDefaults.ChannelsDatarate;
  3139. break;
  3140. }
  3141. case MIB_CHANNELS_DATARATE:
  3142. {
  3143. mibGet->Param.ChannelsDatarate = MacCtx.NvmCtx->MacParams.ChannelsDatarate;
  3144. break;
  3145. }
  3146. case MIB_CHANNELS_DEFAULT_TX_POWER:
  3147. {
  3148. mibGet->Param.ChannelsDefaultTxPower = MacCtx.NvmCtx->MacParamsDefaults.ChannelsTxPower;
  3149. break;
  3150. }
  3151. case MIB_CHANNELS_TX_POWER:
  3152. {
  3153. mibGet->Param.ChannelsTxPower = MacCtx.NvmCtx->MacParams.ChannelsTxPower;
  3154. break;
  3155. }
  3156. case MIB_SYSTEM_MAX_RX_ERROR:
  3157. {
  3158. mibGet->Param.SystemMaxRxError = MacCtx.NvmCtx->MacParams.SystemMaxRxError;
  3159. break;
  3160. }
  3161. case MIB_MIN_RX_SYMBOLS:
  3162. {
  3163. mibGet->Param.MinRxSymbols = MacCtx.NvmCtx->MacParams.MinRxSymbols;
  3164. break;
  3165. }
  3166. case MIB_ANTENNA_GAIN:
  3167. {
  3168. mibGet->Param.AntennaGain = MacCtx.NvmCtx->MacParams.AntennaGain;
  3169. break;
  3170. }
  3171. case MIB_NVM_CTXS:
  3172. {
  3173. mibGet->Param.Contexts = GetCtxs( );
  3174. break;
  3175. }
  3176. case MIB_DEFAULT_ANTENNA_GAIN:
  3177. {
  3178. mibGet->Param.DefaultAntennaGain = MacCtx.NvmCtx->MacParamsDefaults.AntennaGain;
  3179. break;
  3180. }
  3181. default:
  3182. {
  3183. status = LoRaMacClassBMibGetRequestConfirm( mibGet );
  3184. break;
  3185. }
  3186. }
  3187. return status;
  3188. }
  3189. LoRaMacStatus_t LoRaMacMibSetRequestConfirm( MibRequestConfirm_t* mibSet )
  3190. {
  3191. LoRaMacStatus_t status = LORAMAC_STATUS_OK;
  3192. ChanMaskSetParams_t chanMaskSet;
  3193. VerifyParams_t verify;
  3194. if( mibSet == NULL )
  3195. {
  3196. return LORAMAC_STATUS_PARAMETER_INVALID;
  3197. }
  3198. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3199. {
  3200. return LORAMAC_STATUS_BUSY;
  3201. }
  3202. switch( mibSet->Type )
  3203. {
  3204. case MIB_DEVICE_CLASS:
  3205. {
  3206. status = SwitchClass( mibSet->Param.Class );
  3207. break;
  3208. }
  3209. case MIB_NETWORK_ACTIVATION:
  3210. {
  3211. if( mibSet->Param.NetworkActivation != ACTIVATION_TYPE_OTAA )
  3212. {
  3213. MacCtx.NvmCtx->NetworkActivation = mibSet->Param.NetworkActivation;
  3214. }
  3215. else
  3216. { // Do not allow to set ACTIVATION_TYPE_OTAA since the MAC will set it automatically after a successful join process.
  3217. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3218. }
  3219. break;
  3220. }
  3221. case MIB_DEV_EUI:
  3222. {
  3223. if( SecureElementSetDevEui( mibSet->Param.DevEui ) != SECURE_ELEMENT_SUCCESS )
  3224. {
  3225. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3226. }
  3227. break;
  3228. }
  3229. case MIB_JOIN_EUI:
  3230. {
  3231. if( SecureElementSetJoinEui( mibSet->Param.JoinEui ) != SECURE_ELEMENT_SUCCESS )
  3232. {
  3233. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3234. }
  3235. break;
  3236. }
  3237. case MIB_ADR:
  3238. {
  3239. MacCtx.NvmCtx->AdrCtrlOn = mibSet->Param.AdrEnable;
  3240. break;
  3241. }
  3242. case MIB_NET_ID:
  3243. {
  3244. MacCtx.NvmCtx->NetID = mibSet->Param.NetID;
  3245. break;
  3246. }
  3247. case MIB_DEV_ADDR:
  3248. {
  3249. MacCtx.NvmCtx->DevAddr = mibSet->Param.DevAddr;
  3250. break;
  3251. }
  3252. case MIB_GEN_APP_KEY:
  3253. {
  3254. if( mibSet->Param.GenAppKey != NULL )
  3255. {
  3256. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( GEN_APP_KEY, mibSet->Param.GenAppKey ) )
  3257. {
  3258. return LORAMAC_STATUS_CRYPTO_ERROR;
  3259. }
  3260. }
  3261. else
  3262. {
  3263. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3264. }
  3265. break;
  3266. }
  3267. case MIB_APP_KEY:
  3268. {
  3269. if( mibSet->Param.AppKey != NULL )
  3270. {
  3271. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( APP_KEY, mibSet->Param.AppKey ) )
  3272. {
  3273. return LORAMAC_STATUS_CRYPTO_ERROR;
  3274. }
  3275. }
  3276. else
  3277. {
  3278. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3279. }
  3280. break;
  3281. }
  3282. case MIB_NWK_KEY:
  3283. {
  3284. if( mibSet->Param.NwkKey != NULL )
  3285. {
  3286. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( NWK_KEY, mibSet->Param.NwkKey ) )
  3287. {
  3288. return LORAMAC_STATUS_CRYPTO_ERROR;
  3289. }
  3290. }
  3291. else
  3292. {
  3293. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3294. }
  3295. break;
  3296. }
  3297. case MIB_J_S_INT_KEY:
  3298. {
  3299. if( mibSet->Param.JSIntKey != NULL )
  3300. {
  3301. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( J_S_INT_KEY, mibSet->Param.JSIntKey ) )
  3302. {
  3303. return LORAMAC_STATUS_CRYPTO_ERROR;
  3304. }
  3305. }
  3306. else
  3307. {
  3308. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3309. }
  3310. break;
  3311. }
  3312. case MIB_J_S_ENC_KEY:
  3313. {
  3314. if( mibSet->Param.JSEncKey != NULL )
  3315. {
  3316. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( J_S_ENC_KEY, mibSet->Param.JSEncKey ) )
  3317. {
  3318. return LORAMAC_STATUS_CRYPTO_ERROR;
  3319. }
  3320. }
  3321. else
  3322. {
  3323. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3324. }
  3325. break;
  3326. }
  3327. case MIB_F_NWK_S_INT_KEY:
  3328. {
  3329. if( mibSet->Param.FNwkSIntKey != NULL )
  3330. {
  3331. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( F_NWK_S_INT_KEY, mibSet->Param.FNwkSIntKey ) )
  3332. {
  3333. return LORAMAC_STATUS_CRYPTO_ERROR;
  3334. }
  3335. }
  3336. else
  3337. {
  3338. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3339. }
  3340. break;
  3341. }
  3342. case MIB_S_NWK_S_INT_KEY:
  3343. {
  3344. if( mibSet->Param.SNwkSIntKey != NULL )
  3345. {
  3346. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( S_NWK_S_INT_KEY, mibSet->Param.SNwkSIntKey ) )
  3347. {
  3348. return LORAMAC_STATUS_CRYPTO_ERROR;
  3349. }
  3350. }
  3351. else
  3352. {
  3353. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3354. }
  3355. break;
  3356. }
  3357. case MIB_NWK_S_ENC_KEY:
  3358. {
  3359. if( mibSet->Param.NwkSEncKey != NULL )
  3360. {
  3361. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( NWK_S_ENC_KEY, mibSet->Param.NwkSEncKey ) )
  3362. {
  3363. return LORAMAC_STATUS_CRYPTO_ERROR;
  3364. }
  3365. }
  3366. else
  3367. {
  3368. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3369. }
  3370. break;
  3371. }
  3372. case MIB_APP_S_KEY:
  3373. {
  3374. if( mibSet->Param.AppSKey != NULL )
  3375. {
  3376. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( APP_S_KEY, mibSet->Param.AppSKey ) )
  3377. {
  3378. return LORAMAC_STATUS_CRYPTO_ERROR;
  3379. }
  3380. }
  3381. else
  3382. {
  3383. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3384. }
  3385. break;
  3386. }
  3387. case MIB_MC_KE_KEY:
  3388. {
  3389. if( mibSet->Param.McKEKey != NULL )
  3390. {
  3391. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_KE_KEY, mibSet->Param.McKEKey ) )
  3392. {
  3393. return LORAMAC_STATUS_CRYPTO_ERROR;
  3394. }
  3395. }
  3396. else
  3397. {
  3398. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3399. }
  3400. break;
  3401. }
  3402. case MIB_MC_KEY_0:
  3403. {
  3404. if( mibSet->Param.McKey0 != NULL )
  3405. {
  3406. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_KEY_0, mibSet->Param.McKey0 ) )
  3407. {
  3408. return LORAMAC_STATUS_CRYPTO_ERROR;
  3409. }
  3410. }
  3411. else
  3412. {
  3413. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3414. }
  3415. break;
  3416. }
  3417. case MIB_MC_APP_S_KEY_0:
  3418. {
  3419. if( mibSet->Param.McAppSKey0 != NULL )
  3420. {
  3421. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_APP_S_KEY_0, mibSet->Param.McAppSKey0 ) )
  3422. {
  3423. return LORAMAC_STATUS_CRYPTO_ERROR;
  3424. }
  3425. }
  3426. else
  3427. {
  3428. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3429. }
  3430. break;
  3431. }
  3432. case MIB_MC_NWK_S_KEY_0:
  3433. {
  3434. if( mibSet->Param.McNwkSKey0 != NULL )
  3435. {
  3436. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_NWK_S_KEY_0, mibSet->Param.McNwkSKey0 ) )
  3437. {
  3438. return LORAMAC_STATUS_CRYPTO_ERROR;
  3439. }
  3440. }
  3441. else
  3442. {
  3443. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3444. }
  3445. break;
  3446. }
  3447. case MIB_MC_KEY_1:
  3448. {
  3449. if( mibSet->Param.McKey1 != NULL )
  3450. {
  3451. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_KEY_1, mibSet->Param.McKey1 ) )
  3452. {
  3453. return LORAMAC_STATUS_CRYPTO_ERROR;
  3454. }
  3455. }
  3456. else
  3457. {
  3458. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3459. }
  3460. break;
  3461. }
  3462. case MIB_MC_APP_S_KEY_1:
  3463. {
  3464. if( mibSet->Param.McAppSKey1 != NULL )
  3465. {
  3466. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_APP_S_KEY_1, mibSet->Param.McAppSKey1 ) )
  3467. {
  3468. return LORAMAC_STATUS_CRYPTO_ERROR;
  3469. }
  3470. }
  3471. else
  3472. {
  3473. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3474. }
  3475. break;
  3476. }
  3477. case MIB_MC_NWK_S_KEY_1:
  3478. {
  3479. if( mibSet->Param.McNwkSKey1 != NULL )
  3480. {
  3481. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_NWK_S_KEY_1, mibSet->Param.McNwkSKey1 ) )
  3482. {
  3483. return LORAMAC_STATUS_CRYPTO_ERROR;
  3484. }
  3485. }
  3486. else
  3487. {
  3488. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3489. }
  3490. break;
  3491. }
  3492. case MIB_MC_KEY_2:
  3493. {
  3494. if( mibSet->Param.McKey2 != NULL )
  3495. {
  3496. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_KEY_2, mibSet->Param.McKey2 ) )
  3497. {
  3498. return LORAMAC_STATUS_CRYPTO_ERROR;
  3499. }
  3500. }
  3501. else
  3502. {
  3503. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3504. }
  3505. break;
  3506. }
  3507. case MIB_MC_APP_S_KEY_2:
  3508. {
  3509. if( mibSet->Param.McAppSKey2 != NULL )
  3510. {
  3511. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_APP_S_KEY_2, mibSet->Param.McAppSKey2 ) )
  3512. {
  3513. return LORAMAC_STATUS_CRYPTO_ERROR;
  3514. }
  3515. }
  3516. else
  3517. {
  3518. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3519. }
  3520. break;
  3521. }
  3522. case MIB_MC_NWK_S_KEY_2:
  3523. {
  3524. if( mibSet->Param.McNwkSKey2 != NULL )
  3525. {
  3526. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_NWK_S_KEY_2, mibSet->Param.McNwkSKey2 ) )
  3527. {
  3528. return LORAMAC_STATUS_CRYPTO_ERROR;
  3529. }
  3530. }
  3531. else
  3532. {
  3533. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3534. }
  3535. break;
  3536. }
  3537. case MIB_MC_KEY_3:
  3538. {
  3539. if( mibSet->Param.McKey3 != NULL )
  3540. {
  3541. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_KEY_3, mibSet->Param.McKey3 ) )
  3542. {
  3543. return LORAMAC_STATUS_CRYPTO_ERROR;
  3544. }
  3545. }
  3546. else
  3547. {
  3548. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3549. }
  3550. break;
  3551. }
  3552. case MIB_MC_APP_S_KEY_3:
  3553. {
  3554. if( mibSet->Param.McAppSKey3 != NULL )
  3555. {
  3556. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_APP_S_KEY_3, mibSet->Param.McAppSKey3 ) )
  3557. {
  3558. return LORAMAC_STATUS_CRYPTO_ERROR;
  3559. }
  3560. }
  3561. else
  3562. {
  3563. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3564. }
  3565. break;
  3566. }
  3567. case MIB_MC_NWK_S_KEY_3:
  3568. {
  3569. if( mibSet->Param.McNwkSKey3 != NULL )
  3570. {
  3571. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetKey( MC_NWK_S_KEY_3, mibSet->Param.McNwkSKey3 ) )
  3572. {
  3573. return LORAMAC_STATUS_CRYPTO_ERROR;
  3574. }
  3575. }
  3576. else
  3577. {
  3578. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3579. }
  3580. break;
  3581. }
  3582. case MIB_PUBLIC_NETWORK:
  3583. {
  3584. MacCtx.NvmCtx->PublicNetwork = mibSet->Param.EnablePublicNetwork;
  3585. Radio.SetPublicNetwork( MacCtx.NvmCtx->PublicNetwork );
  3586. break;
  3587. }
  3588. case MIB_REPEATER_SUPPORT:
  3589. {
  3590. MacCtx.NvmCtx->RepeaterSupport = mibSet->Param.EnableRepeaterSupport;
  3591. break;
  3592. }
  3593. case MIB_RX2_CHANNEL:
  3594. {
  3595. verify.DatarateParams.Datarate = mibSet->Param.Rx2Channel.Datarate;
  3596. verify.DatarateParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  3597. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_RX_DR ) == true )
  3598. {
  3599. MacCtx.NvmCtx->MacParams.Rx2Channel = mibSet->Param.Rx2Channel;
  3600. }
  3601. else
  3602. {
  3603. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3604. }
  3605. break;
  3606. }
  3607. case MIB_RX2_DEFAULT_CHANNEL:
  3608. {
  3609. verify.DatarateParams.Datarate = mibSet->Param.Rx2Channel.Datarate;
  3610. verify.DatarateParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  3611. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_RX_DR ) == true )
  3612. {
  3613. MacCtx.NvmCtx->MacParamsDefaults.Rx2Channel = mibSet->Param.Rx2DefaultChannel;
  3614. }
  3615. else
  3616. {
  3617. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3618. }
  3619. break;
  3620. }
  3621. case MIB_RXC_CHANNEL:
  3622. {
  3623. verify.DatarateParams.Datarate = mibSet->Param.RxCChannel.Datarate;
  3624. verify.DatarateParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  3625. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_RX_DR ) == true )
  3626. {
  3627. MacCtx.NvmCtx->MacParams.RxCChannel = mibSet->Param.RxCChannel;
  3628. if( ( MacCtx.NvmCtx->DeviceClass == CLASS_C ) && ( MacCtx.NvmCtx->NetworkActivation != ACTIVATION_TYPE_NONE ) )
  3629. {
  3630. // We can only compute the RX window parameters directly, if we are already
  3631. // in class c mode and joined. We cannot setup an RX window in case of any other
  3632. // class type.
  3633. // Set the radio into sleep mode in case we are still in RX mode
  3634. Radio.Sleep( );
  3635. OpenContinuousRxCWindow( );
  3636. }
  3637. }
  3638. else
  3639. {
  3640. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3641. }
  3642. break;
  3643. }
  3644. case MIB_RXC_DEFAULT_CHANNEL:
  3645. {
  3646. verify.DatarateParams.Datarate = mibSet->Param.RxCChannel.Datarate;
  3647. verify.DatarateParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  3648. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_RX_DR ) == true )
  3649. {
  3650. MacCtx.NvmCtx->MacParamsDefaults.RxCChannel = mibSet->Param.RxCDefaultChannel;
  3651. }
  3652. else
  3653. {
  3654. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3655. }
  3656. break;
  3657. }
  3658. case MIB_CHANNELS_DEFAULT_MASK:
  3659. {
  3660. chanMaskSet.ChannelsMaskIn = mibSet->Param.ChannelsDefaultMask;
  3661. chanMaskSet.ChannelsMaskType = CHANNELS_DEFAULT_MASK;
  3662. if( RegionChanMaskSet( MacCtx.NvmCtx->Region, &chanMaskSet ) == false )
  3663. {
  3664. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3665. }
  3666. break;
  3667. }
  3668. case MIB_CHANNELS_MASK:
  3669. {
  3670. chanMaskSet.ChannelsMaskIn = mibSet->Param.ChannelsMask;
  3671. chanMaskSet.ChannelsMaskType = CHANNELS_MASK;
  3672. if( RegionChanMaskSet( MacCtx.NvmCtx->Region, &chanMaskSet ) == false )
  3673. {
  3674. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3675. }
  3676. break;
  3677. }
  3678. case MIB_CHANNELS_NB_TRANS:
  3679. {
  3680. if( ( mibSet->Param.ChannelsNbTrans >= 1 ) &&
  3681. ( mibSet->Param.ChannelsNbTrans <= 15 ) )
  3682. {
  3683. MacCtx.NvmCtx->MacParams.ChannelsNbTrans = mibSet->Param.ChannelsNbTrans;
  3684. }
  3685. else
  3686. {
  3687. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3688. }
  3689. break;
  3690. }
  3691. case MIB_MAX_RX_WINDOW_DURATION:
  3692. {
  3693. MacCtx.NvmCtx->MacParams.MaxRxWindow = mibSet->Param.MaxRxWindow;
  3694. break;
  3695. }
  3696. case MIB_RECEIVE_DELAY_1:
  3697. {
  3698. MacCtx.NvmCtx->MacParams.ReceiveDelay1 = mibSet->Param.ReceiveDelay1;
  3699. break;
  3700. }
  3701. case MIB_RECEIVE_DELAY_2:
  3702. {
  3703. MacCtx.NvmCtx->MacParams.ReceiveDelay2 = mibSet->Param.ReceiveDelay2;
  3704. break;
  3705. }
  3706. case MIB_JOIN_ACCEPT_DELAY_1:
  3707. {
  3708. MacCtx.NvmCtx->MacParams.JoinAcceptDelay1 = mibSet->Param.JoinAcceptDelay1;
  3709. break;
  3710. }
  3711. case MIB_JOIN_ACCEPT_DELAY_2:
  3712. {
  3713. MacCtx.NvmCtx->MacParams.JoinAcceptDelay2 = mibSet->Param.JoinAcceptDelay2;
  3714. break;
  3715. }
  3716. case MIB_CHANNELS_DEFAULT_DATARATE:
  3717. {
  3718. verify.DatarateParams.Datarate = mibSet->Param.ChannelsDefaultDatarate;
  3719. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_DEF_TX_DR ) == true )
  3720. {
  3721. MacCtx.NvmCtx->MacParamsDefaults.ChannelsDatarate = verify.DatarateParams.Datarate;
  3722. }
  3723. else
  3724. {
  3725. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3726. }
  3727. break;
  3728. }
  3729. case MIB_CHANNELS_DATARATE:
  3730. {
  3731. verify.DatarateParams.Datarate = mibSet->Param.ChannelsDatarate;
  3732. verify.DatarateParams.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  3733. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_TX_DR ) == true )
  3734. {
  3735. MacCtx.NvmCtx->MacParams.ChannelsDatarate = verify.DatarateParams.Datarate;
  3736. }
  3737. else
  3738. {
  3739. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3740. }
  3741. break;
  3742. }
  3743. case MIB_CHANNELS_DEFAULT_TX_POWER:
  3744. {
  3745. verify.TxPower = mibSet->Param.ChannelsDefaultTxPower;
  3746. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_DEF_TX_POWER ) == true )
  3747. {
  3748. MacCtx.NvmCtx->MacParamsDefaults.ChannelsTxPower = verify.TxPower;
  3749. }
  3750. else
  3751. {
  3752. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3753. }
  3754. break;
  3755. }
  3756. case MIB_CHANNELS_TX_POWER:
  3757. {
  3758. verify.TxPower = mibSet->Param.ChannelsTxPower;
  3759. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_TX_POWER ) == true )
  3760. {
  3761. MacCtx.NvmCtx->MacParams.ChannelsTxPower = verify.TxPower;
  3762. }
  3763. else
  3764. {
  3765. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3766. }
  3767. break;
  3768. }
  3769. case MIB_SYSTEM_MAX_RX_ERROR:
  3770. {
  3771. MacCtx.NvmCtx->MacParams.SystemMaxRxError = MacCtx.NvmCtx->MacParamsDefaults.SystemMaxRxError = mibSet->Param.SystemMaxRxError;
  3772. break;
  3773. }
  3774. case MIB_MIN_RX_SYMBOLS:
  3775. {
  3776. MacCtx.NvmCtx->MacParams.MinRxSymbols = MacCtx.NvmCtx->MacParamsDefaults.MinRxSymbols = mibSet->Param.MinRxSymbols;
  3777. break;
  3778. }
  3779. case MIB_ANTENNA_GAIN:
  3780. {
  3781. MacCtx.NvmCtx->MacParams.AntennaGain = mibSet->Param.AntennaGain;
  3782. break;
  3783. }
  3784. case MIB_DEFAULT_ANTENNA_GAIN:
  3785. {
  3786. MacCtx.NvmCtx->MacParamsDefaults.AntennaGain = mibSet->Param.DefaultAntennaGain;
  3787. break;
  3788. }
  3789. case MIB_NVM_CTXS:
  3790. {
  3791. if( mibSet->Param.Contexts != 0 )
  3792. {
  3793. status = RestoreCtxs( mibSet->Param.Contexts );
  3794. }
  3795. else
  3796. {
  3797. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3798. }
  3799. break;
  3800. }
  3801. case MIB_ABP_LORAWAN_VERSION:
  3802. {
  3803. if( mibSet->Param.AbpLrWanVersion.Fields.Minor <= 1 )
  3804. {
  3805. MacCtx.NvmCtx->Version = mibSet->Param.AbpLrWanVersion;
  3806. if( LORAMAC_CRYPTO_SUCCESS != LoRaMacCryptoSetLrWanVersion( mibSet->Param.AbpLrWanVersion ) )
  3807. {
  3808. return LORAMAC_STATUS_CRYPTO_ERROR;
  3809. }
  3810. }
  3811. else
  3812. {
  3813. status = LORAMAC_STATUS_PARAMETER_INVALID;
  3814. }
  3815. break;
  3816. }
  3817. default:
  3818. {
  3819. status = LoRaMacMibClassBSetRequestConfirm( mibSet );
  3820. break;
  3821. }
  3822. }
  3823. EventRegionNvmCtxChanged( );
  3824. EventMacNvmCtxChanged( );
  3825. return status;
  3826. }
  3827. LoRaMacStatus_t LoRaMacChannelAdd( uint8_t id, ChannelParams_t params )
  3828. {
  3829. ChannelAddParams_t channelAdd;
  3830. // Validate if the MAC is in a correct state
  3831. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3832. {
  3833. if( ( MacCtx.MacState & LORAMAC_TX_CONFIG ) != LORAMAC_TX_CONFIG )
  3834. {
  3835. return LORAMAC_STATUS_BUSY;
  3836. }
  3837. }
  3838. channelAdd.NewChannel = &params;
  3839. channelAdd.ChannelId = id;
  3840. EventRegionNvmCtxChanged( );
  3841. return RegionChannelAdd( MacCtx.NvmCtx->Region, &channelAdd );
  3842. }
  3843. LoRaMacStatus_t LoRaMacChannelRemove( uint8_t id )
  3844. {
  3845. ChannelRemoveParams_t channelRemove;
  3846. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3847. {
  3848. if( ( MacCtx.MacState & LORAMAC_TX_CONFIG ) != LORAMAC_TX_CONFIG )
  3849. {
  3850. return LORAMAC_STATUS_BUSY;
  3851. }
  3852. }
  3853. channelRemove.ChannelId = id;
  3854. if( RegionChannelsRemove( MacCtx.NvmCtx->Region, &channelRemove ) == false )
  3855. {
  3856. return LORAMAC_STATUS_PARAMETER_INVALID;
  3857. }
  3858. EventRegionNvmCtxChanged( );
  3859. return LORAMAC_STATUS_OK;
  3860. }
  3861. LoRaMacStatus_t LoRaMacMcChannelSetup( McChannelParams_t *channel )
  3862. {
  3863. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3864. {
  3865. return LORAMAC_STATUS_BUSY;
  3866. }
  3867. if( channel->GroupID >= LORAMAC_MAX_MC_CTX )
  3868. {
  3869. return LORAMAC_STATUS_MC_GROUP_UNDEFINED;
  3870. }
  3871. MacCtx.NvmCtx->MulticastChannelList[channel->GroupID].ChannelParams = *channel;
  3872. const KeyIdentifier_t mcKeys[LORAMAC_MAX_MC_CTX] = { MC_KEY_0, MC_KEY_1, MC_KEY_2, MC_KEY_3 };
  3873. if( LoRaMacCryptoSetKey( mcKeys[channel->GroupID], channel->McKeyE ) != LORAMAC_CRYPTO_SUCCESS )
  3874. {
  3875. return LORAMAC_STATUS_CRYPTO_ERROR;
  3876. }
  3877. if( LoRaMacCryptoDeriveMcSessionKeyPair( channel->GroupID, channel->Address ) != LORAMAC_CRYPTO_SUCCESS )
  3878. {
  3879. return LORAMAC_STATUS_CRYPTO_ERROR;
  3880. }
  3881. if( channel->Class == CLASS_B )
  3882. {
  3883. // Calculate class b parameters
  3884. LoRaMacClassBSetMulticastPeriodicity( &MacCtx.NvmCtx->MulticastChannelList[channel->GroupID] );
  3885. }
  3886. // Reset multicast channel downlink counter to initial value.
  3887. *MacCtx.NvmCtx->MulticastChannelList[channel->GroupID].DownLinkCounter = FCNT_DOWN_INITAL_VALUE;
  3888. EventMacNvmCtxChanged( );
  3889. EventRegionNvmCtxChanged( );
  3890. return LORAMAC_STATUS_OK;
  3891. }
  3892. LoRaMacStatus_t LoRaMacMcChannelDelete( AddressIdentifier_t groupID )
  3893. {
  3894. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3895. {
  3896. return LORAMAC_STATUS_BUSY;
  3897. }
  3898. if( ( groupID >= LORAMAC_MAX_MC_CTX ) ||
  3899. ( MacCtx.NvmCtx->MulticastChannelList[groupID].ChannelParams.IsEnabled == false ) )
  3900. {
  3901. return LORAMAC_STATUS_MC_GROUP_UNDEFINED;
  3902. }
  3903. McChannelParams_t channel;
  3904. // Set all channel fields with 0
  3905. memset1( ( uint8_t* )&channel, 0, sizeof( McChannelParams_t ) );
  3906. MacCtx.NvmCtx->MulticastChannelList[groupID].ChannelParams = channel;
  3907. EventMacNvmCtxChanged( );
  3908. EventRegionNvmCtxChanged( );
  3909. return LORAMAC_STATUS_OK;
  3910. }
  3911. uint8_t LoRaMacMcChannelGetGroupId( uint32_t mcAddress )
  3912. {
  3913. for( uint8_t i = 0; i < LORAMAC_MAX_MC_CTX; i++ )
  3914. {
  3915. if( mcAddress == MacCtx.NvmCtx->MulticastChannelList[i].ChannelParams.Address )
  3916. {
  3917. return i;
  3918. }
  3919. }
  3920. return 0xFF;
  3921. }
  3922. LoRaMacStatus_t LoRaMacMcChannelSetupRxParams( AddressIdentifier_t groupID, McRxParams_t *rxParams, uint8_t *status )
  3923. {
  3924. *status = 0x1C + ( groupID & 0x03 );
  3925. if( ( MacCtx.MacState & LORAMAC_TX_RUNNING ) == LORAMAC_TX_RUNNING )
  3926. {
  3927. return LORAMAC_STATUS_BUSY;
  3928. }
  3929. DeviceClass_t devClass = MacCtx.NvmCtx->MulticastChannelList[groupID].ChannelParams.Class;
  3930. if( ( devClass == CLASS_A ) || ( devClass > CLASS_C ) )
  3931. {
  3932. return LORAMAC_STATUS_PARAMETER_INVALID;
  3933. }
  3934. if( ( groupID >= LORAMAC_MAX_MC_CTX ) ||
  3935. ( MacCtx.NvmCtx->MulticastChannelList[groupID].ChannelParams.IsEnabled == false ) )
  3936. {
  3937. return LORAMAC_STATUS_MC_GROUP_UNDEFINED;
  3938. }
  3939. *status &= 0x0F; // groupID OK
  3940. VerifyParams_t verify;
  3941. // Check datarate
  3942. if( devClass == CLASS_B )
  3943. {
  3944. verify.DatarateParams.Datarate = rxParams->ClassB.Datarate;
  3945. }
  3946. else
  3947. {
  3948. verify.DatarateParams.Datarate = rxParams->ClassC.Datarate;
  3949. }
  3950. verify.DatarateParams.DownlinkDwellTime = MacCtx.NvmCtx->MacParams.DownlinkDwellTime;
  3951. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_RX_DR ) == true )
  3952. {
  3953. *status &= 0xFB; // datarate OK
  3954. }
  3955. // Check frequency
  3956. if( devClass == CLASS_B )
  3957. {
  3958. verify.Frequency = rxParams->ClassB.Frequency;
  3959. }
  3960. else
  3961. {
  3962. verify.Frequency = rxParams->ClassC.Frequency;
  3963. }
  3964. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_FREQUENCY ) == true )
  3965. {
  3966. *status &= 0xF7; // frequency OK
  3967. }
  3968. if( *status == ( groupID & 0x03 ) )
  3969. {
  3970. // Apply parameters
  3971. MacCtx.NvmCtx->MulticastChannelList[groupID].ChannelParams.RxParams = *rxParams;
  3972. }
  3973. EventMacNvmCtxChanged( );
  3974. EventRegionNvmCtxChanged( );
  3975. return LORAMAC_STATUS_OK;
  3976. }
  3977. LoRaMacStatus_t LoRaMacMlmeRequest( MlmeReq_t* mlmeRequest )
  3978. {
  3979. LoRaMacStatus_t status = LORAMAC_STATUS_SERVICE_UNKNOWN;
  3980. MlmeConfirmQueue_t queueElement;
  3981. uint8_t macCmdPayload[2] = { 0x00, 0x00 };
  3982. if( mlmeRequest == NULL )
  3983. {
  3984. return LORAMAC_STATUS_PARAMETER_INVALID;
  3985. }
  3986. if( LoRaMacIsBusy( ) == true )
  3987. {
  3988. return LORAMAC_STATUS_BUSY;
  3989. }
  3990. if( LoRaMacConfirmQueueIsFull( ) == true )
  3991. {
  3992. return LORAMAC_STATUS_BUSY;
  3993. }
  3994. if( LoRaMacConfirmQueueGetCnt( ) == 0 )
  3995. {
  3996. memset1( ( uint8_t* ) &MacCtx.MlmeConfirm, 0, sizeof( MacCtx.MlmeConfirm ) );
  3997. }
  3998. MacCtx.MlmeConfirm.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  3999. MacCtx.MacFlags.Bits.MlmeReq = 1;
  4000. queueElement.Request = mlmeRequest->Type;
  4001. queueElement.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  4002. queueElement.RestrictCommonReadyToHandle = false;
  4003. switch( mlmeRequest->Type )
  4004. {
  4005. case MLME_JOIN:
  4006. {
  4007. if( ( MacCtx.MacState & LORAMAC_TX_DELAYED ) == LORAMAC_TX_DELAYED )
  4008. {
  4009. return LORAMAC_STATUS_BUSY;
  4010. }
  4011. ResetMacParameters( );
  4012. MacCtx.NvmCtx->MacParams.ChannelsDatarate = RegionAlternateDr( MacCtx.NvmCtx->Region, mlmeRequest->Req.Join.Datarate, ALTERNATE_DR );
  4013. queueElement.Status = LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL;
  4014. status = SendReJoinReq( JOIN_REQ );
  4015. if( status != LORAMAC_STATUS_OK )
  4016. {
  4017. // Revert back the previous datarate ( mainly used for US915 like regions )
  4018. MacCtx.NvmCtx->MacParams.ChannelsDatarate = RegionAlternateDr( MacCtx.NvmCtx->Region, mlmeRequest->Req.Join.Datarate, ALTERNATE_DR_RESTORE );
  4019. }
  4020. break;
  4021. }
  4022. case MLME_LINK_CHECK:
  4023. {
  4024. // LoRaMac will send this command piggy-pack
  4025. status = LORAMAC_STATUS_OK;
  4026. if( LoRaMacCommandsAddCmd( MOTE_MAC_LINK_CHECK_REQ, macCmdPayload, 0 ) != LORAMAC_COMMANDS_SUCCESS )
  4027. {
  4028. status = LORAMAC_STATUS_MAC_COMMAD_ERROR;
  4029. }
  4030. break;
  4031. }
  4032. case MLME_TXCW:
  4033. {
  4034. status = SetTxContinuousWave( mlmeRequest->Req.TxCw.Timeout );
  4035. break;
  4036. }
  4037. case MLME_TXCW_1:
  4038. {
  4039. status = SetTxContinuousWave1( mlmeRequest->Req.TxCw.Timeout, mlmeRequest->Req.TxCw.Frequency, mlmeRequest->Req.TxCw.Power );
  4040. break;
  4041. }
  4042. case MLME_DEVICE_TIME:
  4043. {
  4044. // LoRaMac will send this command piggy-pack
  4045. status = LORAMAC_STATUS_OK;
  4046. if( LoRaMacCommandsAddCmd( MOTE_MAC_DEVICE_TIME_REQ, macCmdPayload, 0 ) != LORAMAC_COMMANDS_SUCCESS )
  4047. {
  4048. status = LORAMAC_STATUS_MAC_COMMAD_ERROR;
  4049. }
  4050. break;
  4051. }
  4052. case MLME_PING_SLOT_INFO:
  4053. {
  4054. if( MacCtx.NvmCtx->DeviceClass == CLASS_A )
  4055. {
  4056. uint8_t value = mlmeRequest->Req.PingSlotInfo.PingSlot.Value;
  4057. // LoRaMac will send this command piggy-pack
  4058. LoRaMacClassBSetPingSlotInfo( mlmeRequest->Req.PingSlotInfo.PingSlot.Fields.Periodicity );
  4059. macCmdPayload[0] = value;
  4060. status = LORAMAC_STATUS_OK;
  4061. if( LoRaMacCommandsAddCmd( MOTE_MAC_PING_SLOT_INFO_REQ, macCmdPayload, 1 ) != LORAMAC_COMMANDS_SUCCESS )
  4062. {
  4063. status = LORAMAC_STATUS_MAC_COMMAD_ERROR;
  4064. }
  4065. }
  4066. break;
  4067. }
  4068. case MLME_BEACON_TIMING:
  4069. {
  4070. // LoRaMac will send this command piggy-pack
  4071. status = LORAMAC_STATUS_OK;
  4072. if( LoRaMacCommandsAddCmd( MOTE_MAC_BEACON_TIMING_REQ, macCmdPayload, 0 ) != LORAMAC_COMMANDS_SUCCESS )
  4073. {
  4074. status = LORAMAC_STATUS_MAC_COMMAD_ERROR;
  4075. }
  4076. break;
  4077. }
  4078. case MLME_BEACON_ACQUISITION:
  4079. {
  4080. // Apply the request
  4081. queueElement.RestrictCommonReadyToHandle = true;
  4082. if( LoRaMacClassBIsAcquisitionInProgress( ) == false )
  4083. {
  4084. // Start class B algorithm
  4085. LoRaMacClassBSetBeaconState( BEACON_STATE_ACQUISITION );
  4086. LoRaMacClassBBeaconTimerEvent( NULL );
  4087. status = LORAMAC_STATUS_OK;
  4088. }
  4089. else
  4090. {
  4091. status = LORAMAC_STATUS_BUSY;
  4092. }
  4093. break;
  4094. }
  4095. default:
  4096. break;
  4097. }
  4098. if( status != LORAMAC_STATUS_OK )
  4099. {
  4100. if( LoRaMacConfirmQueueGetCnt( ) == 0 )
  4101. {
  4102. MacCtx.NodeAckRequested = false;
  4103. MacCtx.MacFlags.Bits.MlmeReq = 0;
  4104. }
  4105. }
  4106. else
  4107. {
  4108. LoRaMacConfirmQueueAdd( &queueElement );
  4109. EventMacNvmCtxChanged( );
  4110. }
  4111. return status;
  4112. }
  4113. LoRaMacStatus_t LoRaMacMcpsRequest( McpsReq_t* mcpsRequest )
  4114. {
  4115. GetPhyParams_t getPhy;
  4116. PhyParam_t phyParam;
  4117. LoRaMacStatus_t status = LORAMAC_STATUS_SERVICE_UNKNOWN;
  4118. LoRaMacHeader_t macHdr;
  4119. VerifyParams_t verify;
  4120. uint8_t fPort = 0;
  4121. void* fBuffer;
  4122. uint16_t fBufferSize;
  4123. int8_t datarate = DR_0;
  4124. bool readyToSend = false;
  4125. if( mcpsRequest == NULL )
  4126. {
  4127. return LORAMAC_STATUS_PARAMETER_INVALID;
  4128. }
  4129. if( LoRaMacIsBusy( ) == true )
  4130. {
  4131. return LORAMAC_STATUS_BUSY;
  4132. }
  4133. macHdr.Value = 0;
  4134. memset1( ( uint8_t* ) &MacCtx.McpsConfirm, 0, sizeof( MacCtx.McpsConfirm ) );
  4135. MacCtx.McpsConfirm.Status = LORAMAC_EVENT_INFO_STATUS_ERROR;
  4136. // AckTimeoutRetriesCounter must be reset every time a new request (unconfirmed or confirmed) is performed.
  4137. MacCtx.AckTimeoutRetriesCounter = 1;
  4138. switch( mcpsRequest->Type )
  4139. {
  4140. case MCPS_UNCONFIRMED:
  4141. {
  4142. readyToSend = true;
  4143. MacCtx.AckTimeoutRetries = 1;
  4144. macHdr.Bits.MType = FRAME_TYPE_DATA_UNCONFIRMED_UP;
  4145. fPort = mcpsRequest->Req.Unconfirmed.fPort;
  4146. fBuffer = mcpsRequest->Req.Unconfirmed.fBuffer;
  4147. fBufferSize = mcpsRequest->Req.Unconfirmed.fBufferSize;
  4148. datarate = mcpsRequest->Req.Unconfirmed.Datarate;
  4149. break;
  4150. }
  4151. case MCPS_CONFIRMED:
  4152. {
  4153. readyToSend = true;
  4154. MacCtx.AckTimeoutRetries = MIN( mcpsRequest->Req.Confirmed.NbTrials, MAX_ACK_RETRIES );
  4155. macHdr.Bits.MType = FRAME_TYPE_DATA_CONFIRMED_UP;
  4156. fPort = mcpsRequest->Req.Confirmed.fPort;
  4157. fBuffer = mcpsRequest->Req.Confirmed.fBuffer;
  4158. fBufferSize = mcpsRequest->Req.Confirmed.fBufferSize;
  4159. datarate = mcpsRequest->Req.Confirmed.Datarate;
  4160. break;
  4161. }
  4162. case MCPS_PROPRIETARY:
  4163. {
  4164. readyToSend = true;
  4165. MacCtx.AckTimeoutRetries = 1;
  4166. macHdr.Bits.MType = FRAME_TYPE_PROPRIETARY;
  4167. fBuffer = mcpsRequest->Req.Proprietary.fBuffer;
  4168. fBufferSize = mcpsRequest->Req.Proprietary.fBufferSize;
  4169. datarate = mcpsRequest->Req.Proprietary.Datarate;
  4170. break;
  4171. }
  4172. default:
  4173. break;
  4174. }
  4175. // Get the minimum possible datarate
  4176. getPhy.Attribute = PHY_MIN_TX_DR;
  4177. getPhy.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  4178. phyParam = RegionGetPhyParam( MacCtx.NvmCtx->Region, &getPhy );
  4179. // Apply the minimum possible datarate.
  4180. // Some regions have limitations for the minimum datarate.
  4181. datarate = MAX( datarate, ( int8_t )phyParam.Value );
  4182. if( readyToSend == true )
  4183. {
  4184. if( MacCtx.NvmCtx->AdrCtrlOn == false )
  4185. {
  4186. verify.DatarateParams.Datarate = datarate;
  4187. verify.DatarateParams.UplinkDwellTime = MacCtx.NvmCtx->MacParams.UplinkDwellTime;
  4188. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_TX_DR ) == true )
  4189. {
  4190. MacCtx.NvmCtx->MacParams.ChannelsDatarate = verify.DatarateParams.Datarate;
  4191. }
  4192. else
  4193. {
  4194. return LORAMAC_STATUS_PARAMETER_INVALID;
  4195. }
  4196. }
  4197. status = Send( &macHdr, fPort, fBuffer, fBufferSize );
  4198. if( status == LORAMAC_STATUS_OK )
  4199. {
  4200. MacCtx.McpsConfirm.McpsRequest = mcpsRequest->Type;
  4201. MacCtx.MacFlags.Bits.McpsReq = 1;
  4202. }
  4203. else
  4204. {
  4205. MacCtx.NodeAckRequested = false;
  4206. }
  4207. }
  4208. EventMacNvmCtxChanged( );
  4209. return status;
  4210. }
  4211. void LoRaMacTestSetDutyCycleOn( bool enable )
  4212. {
  4213. VerifyParams_t verify;
  4214. verify.DutyCycle = enable;
  4215. if( RegionVerify( MacCtx.NvmCtx->Region, &verify, PHY_DUTY_CYCLE ) == true )
  4216. {
  4217. MacCtx.NvmCtx->DutyCycleOn = enable;
  4218. }
  4219. }