LMiC LoRa Semtech + Nucleo
Fork of LMiC by
Embed:
(wiki syntax)
Show/hide line numbers
lmic.h
Go to the documentation of this file.
00001 /******************************************************************************* 00002 * Copyright (c) 2014-2015 IBM Corporation. 00003 * All rights reserved. This program and the accompanying materials 00004 * are made available under the terms of the Eclipse Public License v1.0 00005 * which accompanies this distribution, and is available at 00006 * http://www.eclipse.org/legal/epl-v10.html 00007 * 00008 * Contributors: 00009 * IBM Zurich Research Lab - initial API, implementation and documentation 00010 *******************************************************************************/ 00011 00012 //! @file 00013 //! @brief LMIC API 00014 00015 #ifndef _lmic_h_ 00016 #define _lmic_h_ 00017 00018 // MBED compiler options 00019 #define CFG_eu868 1 00020 //#define CFG_us915 0 00021 00022 #define USE_SMTC_RADIO_DRIVER 1 00023 00024 //#define CFG_sx1272_radio 0 00025 #define CFG_sx1276_radio 1 00026 // End MBED compiler options 00027 00028 #include "oslmic.h " 00029 #include "lorabase.h" 00030 00031 // LMIC version 00032 #define LMIC_VERSION_MAJOR 1 00033 #define LMIC_VERSION_MINOR 4 00034 #define LMIC_VERSION_BUILD 1426605786 00035 00036 enum { MAX_FRAME_LEN = 64 }; //!< Library cap on max frame length 00037 //enum { MAX_FRAME_LEN = 96 }; //!< Library cap on max frame length 00038 enum { TXCONF_ATTEMPTS = 8 }; //!< Transmit attempts for confirmed frames 00039 enum { MAX_MISSED_BCNS = 20 }; // threshold for triggering rejoin requests 00040 enum { MAX_RXSYMS = 100 }; // stop tracking beacon beyond this 00041 00042 enum { LINK_CHECK_CONT = 6 , // continue with this after reported dead link 00043 LINK_CHECK_DEAD = 12 , // after this UP frames and no response from NWK assume link is dead 00044 LINK_CHECK_INIT = -12 , // UP frame count until we inc datarate 00045 LINK_CHECK_OFF =-128 }; // link check disabled 00046 00047 enum { TIME_RESYNC = 6*128 }; // secs 00048 enum { TXRX_GUARD_ms = 6000 }; // msecs - don't start TX-RX transaction before beacon 00049 enum { JOIN_GUARD_ms = 9000 }; // msecs - don't start Join Req/Acc transaction before beacon 00050 enum { TXRX_BCNEXT_secs = 2 }; // secs - earliest start after beacon time 00051 enum { RETRY_PERIOD_secs = 3 }; // secs - random period for retrying a confirmed send 00052 00053 #if defined(CFG_eu868) // EU868 spectrum ==================================================== 00054 00055 enum { MAX_CHANNELS = 16 }; //!< Max supported channels 00056 enum { MAX_BANDS = 4 }; 00057 00058 enum { LIMIT_CHANNELS = (1<<4) }; // EU868 will never have more channels 00059 //! \internal 00060 struct band_t { 00061 u2_t txcap; // duty cycle limitation: 1/txcap 00062 s1_t txpow; // maximum TX power 00063 u1_t lastchnl; // last used channel 00064 ostime_t avail; // channel is blocked until this time 00065 }; 00066 TYPEDEF_xref2band_t; //!< \internal 00067 00068 #elif defined(CFG_us915) // US915 spectrum ================================================= 00069 00070 enum { MAX_XCHANNELS = 2 }; // extra channels in RAM, channels 0-71 are immutable 00071 enum { MAX_TXPOW_125kHz = 30 }; 00072 00073 #endif // ========================================================================== 00074 00075 // Keep in sync with evdefs.hpp::drChange 00076 enum { DRCHG_SET, DRCHG_NOJACC, DRCHG_NOACK, DRCHG_NOADRACK, DRCHG_NWKCMD }; 00077 enum { KEEP_TXPOW = -128 }; 00078 00079 00080 //! \internal 00081 struct rxsched_t { 00082 u1_t dr; 00083 u1_t intvExp; // 0..7 00084 u1_t slot; // runs from 0 to 128 00085 u1_t rxsyms; 00086 ostime_t rxbase; 00087 ostime_t rxtime; // start of next spot 00088 u4_t freq; 00089 }; 00090 TYPEDEF_xref2rxsched_t; //!< \internal 00091 00092 00093 //! Parsing and tracking states of beacons. 00094 enum { BCN_NONE = 0x00, //!< No beacon received 00095 BCN_PARTIAL = 0x01, //!< Only first (common) part could be decoded (info,lat,lon invalid/previous) 00096 BCN_FULL = 0x02, //!< Full beacon decoded 00097 BCN_NODRIFT = 0x04, //!< No drift value measured yet 00098 BCN_NODDIFF = 0x08 }; //!< No differential drift measured yet 00099 //! Information about the last and previous beacons. 00100 struct bcninfo_t { 00101 ostime_t txtime; //!< Time when the beacon was sent 00102 s1_t rssi; //!< Adjusted RSSI value of last received beacon 00103 s1_t snr; //!< Scaled SNR value of last received beacon 00104 u1_t flags; //!< Last beacon reception and tracking states. See BCN_* values. 00105 u4_t time; //!< GPS time in seconds of last beacon (received or surrogate) 00106 // 00107 u1_t info; //!< Info field of last beacon (valid only if BCN_FULL set) 00108 s4_t lat; //!< Lat field of last beacon (valid only if BCN_FULL set) 00109 s4_t lon; //!< Lon field of last beacon (valid only if BCN_FULL set) 00110 }; 00111 00112 // purpose of receive window - lmic_t.rxState 00113 enum { RADIO_RST=0, RADIO_TX=1, RADIO_RX=2, RADIO_RXON=3 }; 00114 // Netid values / lmic_t.netid 00115 enum { NETID_NONE=(int)~0U, NETID_MASK=(int)0xFFFFFF }; 00116 // MAC operation modes (lmic_t.opmode). 00117 enum { OP_NONE = 0x0000, 00118 OP_SCAN = 0x0001, // radio scan to find a beacon 00119 OP_TRACK = 0x0002, // track my networks beacon (netid) 00120 OP_JOINING = 0x0004, // device joining in progress (blocks other activities) 00121 OP_TXDATA = 0x0008, // TX user data (buffered in pendTxData) 00122 OP_POLL = 0x0010, // send empty UP frame to ACK confirmed DN/fetch more DN data 00123 OP_REJOIN = 0x0020, // occasionally send JOIN REQUEST 00124 OP_SHUTDOWN = 0x0040, // prevent MAC from doing anything 00125 OP_TXRXPEND = 0x0080, // TX/RX transaction pending 00126 OP_RNDTX = 0x0100, // prevent TX lining up after a beacon 00127 OP_PINGINI = 0x0200, // pingable is initialized and scheduling active 00128 OP_PINGABLE = 0x0400, // we're pingable 00129 OP_NEXTCHNL = 0x0800, // find a new channel 00130 OP_LINKDEAD = 0x1000, // link was reported as dead 00131 OP_TESTMODE = 0x2000, // developer test mode 00132 }; 00133 // TX-RX transaction flags - report back to user 00134 enum { TXRX_ACK = 0x80, // confirmed UP frame was acked 00135 TXRX_NACK = 0x40, // confirmed UP frame was not acked 00136 TXRX_NOPORT = 0x20, // set if a frame with a port was RXed, clr if no frame/no port 00137 TXRX_PORT = 0x10, // set if a frame with a port was RXed, LMIC.frame[LMIC.dataBeg-1] => port 00138 TXRX_DNW1 = 0x01, // received in 1st DN slot 00139 TXRX_DNW2 = 0x02, // received in 2dn DN slot 00140 TXRX_PING = 0x04 }; // received in a scheduled RX slot 00141 // Event types for event callback 00142 enum _ev_t { EV_SCAN_TIMEOUT=1, EV_BEACON_FOUND, 00143 EV_BEACON_MISSED, EV_BEACON_TRACKED, EV_JOINING, 00144 EV_JOINED, EV_RFU1, EV_JOIN_FAILED, EV_REJOIN_FAILED, 00145 EV_TXCOMPLETE, EV_LOST_TSYNC, EV_RESET, 00146 EV_RXCOMPLETE, EV_LINK_DEAD, EV_LINK_ALIVE }; 00147 typedef enum _ev_t ev_t; 00148 00149 00150 struct lmic_t { 00151 // Radio settings TX/RX (also accessed by HAL) 00152 ostime_t txend; 00153 ostime_t rxtime; 00154 u4_t freq; 00155 s1_t rssi; 00156 s1_t snr; 00157 rps_t rps; 00158 u1_t rxsyms; 00159 u1_t dndr; 00160 s1_t txpow; // dBm 00161 00162 osjob_t osjob; 00163 00164 // Channel scheduling 00165 #if defined(CFG_eu868) 00166 band_t bands[MAX_BANDS]; 00167 u4_t channelFreq[MAX_CHANNELS]; 00168 u2_t channelDrMap[MAX_CHANNELS]; 00169 u2_t channelMap; 00170 #elif defined(CFG_us915) 00171 u4_t xchFreq[MAX_XCHANNELS]; // extra channel frequencies (if device is behind a repeater) 00172 u2_t xchDrMap[MAX_XCHANNELS]; // extra channel datarate ranges ---XXX: ditto 00173 u2_t channelMap[(72+MAX_XCHANNELS+15)/16]; // enabled bits 00174 u2_t chRnd; // channel randomizer 00175 #endif 00176 u1_t txChnl; // channel for next TX 00177 u1_t globalDutyRate; // max rate: 1/2^k 00178 ostime_t globalDutyAvail; // time device can send again 00179 00180 u4_t netid; // current network id (~0 - none) 00181 u2_t opmode; 00182 u1_t upRepeat; // configured up repeat 00183 s1_t adrTxPow; // ADR adjusted TX power 00184 u1_t datarate; // current data rate 00185 u1_t errcr; // error coding rate (used for TX only) 00186 u1_t rejoinCnt; // adjustment for rejoin datarate 00187 s2_t drift; // last measured drift 00188 s2_t lastDriftDiff; 00189 s2_t maxDriftDiff; 00190 00191 u1_t pendTxPort; 00192 u1_t pendTxConf; // confirmed data 00193 u1_t pendTxLen; // +0x80 = confirmed 00194 u1_t pendTxData[MAX_LEN_PAYLOAD]; 00195 00196 u2_t devNonce; // last generated nonce 00197 u1_t nwkKey[16]; // network session key 00198 u1_t artKey[16]; // application router session key 00199 devaddr_t devaddr; 00200 u4_t seqnoDn; // device level down stream seqno 00201 u4_t seqnoUp; 00202 00203 u1_t dnConf; // dn frame confirm pending: LORA::FCT_ACK or 0 00204 s1_t adrAckReq; // counter until we reset data rate (0=off) 00205 u1_t adrChanged; 00206 00207 u1_t margin; 00208 bit_t ladrAns; // link adr adapt answer pending 00209 bit_t devsAns; // device status answer pending 00210 u1_t adrEnabled; 00211 u1_t moreData; // NWK has more data pending 00212 bit_t dutyCapAns; // have to ACK duty cycle settings 00213 u1_t snchAns; // answer set new channel 00214 // 2nd RX window (after up stream) 00215 u1_t dn2Dr; 00216 u4_t dn2Freq; 00217 u1_t dn2Ans; // 0=no answer pend, 0x80+ACKs 00218 00219 // Class B state 00220 u1_t missedBcns; // unable to track last N beacons 00221 u1_t bcninfoTries; // how often to try (scan mode only) 00222 u1_t pingSetAns; // answer set cmd and ACK bits 00223 rxsched_t ping; // pingable setup 00224 00225 // Public part of MAC state 00226 u1_t txCnt; 00227 u1_t txrxFlags; // transaction flags (TX-RX combo) 00228 u1_t dataBeg; // 0 or start of data (dataBeg-1 is port) 00229 u1_t dataLen; // 0 no data or zero length data, >0 byte count of data 00230 u1_t frame[MAX_LEN_FRAME]; 00231 00232 u1_t bcnChnl; 00233 u1_t bcnRxsyms; // 00234 ostime_t bcnRxtime; 00235 bcninfo_t bcninfo; // Last received beacon info 00236 }; 00237 //! \var struct lmic_t LMIC 00238 //! The state of LMIC MAC layer is encapsulated in this variable. 00239 DECLARE_LMIC; //!< \internal 00240 00241 //! Construct a bit map of allowed datarates from drlo to drhi (both included). 00242 #define DR_RANGE_MAP(drlo,drhi) (((u2_t)0xFFFF<<(drlo)) & ((u2_t)0xFFFF>>(15-(drhi)))) 00243 #if defined(CFG_eu868) 00244 enum { BAND_MILLI=0, BAND_CENTI=1, BAND_DECI=2, BAND_AUX=3 }; 00245 bit_t LMIC_setupBand (u1_t bandidx, s1_t txpow, u2_t txcap); 00246 #endif 00247 bit_t LMIC_setupChannel (u1_t channel, u4_t freq, u2_t drmap, s1_t band); 00248 void LMIC_disableChannel (u1_t channel); 00249 00250 void LMIC_setDrTxpow (dr_t dr, s1_t txpow); // set default/start DR/txpow 00251 void LMIC_setAdrMode (bit_t enabled); // set ADR mode (if mobile turn off) 00252 bit_t LMIC_startJoining (void); 00253 00254 void LMIC_shutdown (void); 00255 void LMIC_init (void); 00256 void LMIC_reset (void); 00257 void LMIC_clrTxData (void); 00258 void LMIC_setTxData (void); 00259 int LMIC_setTxData2 (u1_t port, xref2u1_t data, u1_t dlen, u1_t confirmed); 00260 void LMIC_sendAlive (void); 00261 00262 bit_t LMIC_enableTracking (u1_t tryBcnInfo); 00263 void LMIC_disableTracking (void); 00264 00265 void LMIC_stopPingable (void); 00266 void LMIC_setPingable (u1_t intvExp); 00267 void LMIC_tryRejoin (void); 00268 00269 void LMIC_setSession (u4_t netid, devaddr_t devaddr, xref2u1_t nwkKey, xref2u1_t artKey); 00270 void LMIC_setLinkCheckMode (bit_t enabled); 00271 00272 // Special APIs - for development or testing 00273 // !!!See implementation for caveats!!! 00274 00275 #endif // _lmic_h_
Generated on Tue Jul 12 2022 20:31:35 by 1.7.2