Dave Kjendal
Fix ADR channel mask handling
Fork of
lmic_MOTE_L152RC
by 
canuck lehead
Diff: lmic.h
- Revision:
- 0:f2716e543d97
- Child:
- 5:e4ba433f0ac1
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/lmic.h Tue Jun 02 19:04:29 2015 +0000
@@ -0,0 +1,264 @@
+/*******************************************************************************
+ * Copyright (c) 2014-2015 IBM Corporation.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * IBM Zurich Research Lab - initial API, implementation and documentation
+ *******************************************************************************/
+
+//! @file
+//! @brief LMIC API
+
+#ifndef _lmic_h_
+#define _lmic_h_
+
+#include "oslmic.h"
+#include "lorabase.h"
+
+// LMIC version
+#define LMIC_VERSION_MAJOR 1
+#define LMIC_VERSION_MINOR 5
+#define LMIC_VERSION_BUILD 1431528305
+
+enum { MAX_FRAME_LEN = 64 }; //!< Library cap on max frame length
+enum { TXCONF_ATTEMPTS = 8 }; //!< Transmit attempts for confirmed frames
+enum { MAX_MISSED_BCNS = 20 }; // threshold for triggering rejoin requests
+enum { MAX_RXSYMS = 100 }; // stop tracking beacon beyond this
+
+enum { LINK_CHECK_CONT = 12 , // continue with this after reported dead link
+ LINK_CHECK_DEAD = 24 , // after this UP frames and no response from NWK assume link is dead
+ LINK_CHECK_INIT = -12 , // UP frame count until we inc datarate
+ LINK_CHECK_OFF =-128 }; // link check disabled
+
+enum { TIME_RESYNC = 6*128 }; // secs
+enum { TXRX_GUARD_ms = 6000 }; // msecs - don't start TX-RX transaction before beacon
+enum { JOIN_GUARD_ms = 9000 }; // msecs - don't start Join Req/Acc transaction before beacon
+enum { TXRX_BCNEXT_secs = 2 }; // secs - earliest start after beacon time
+enum { RETRY_PERIOD_secs = 3 }; // secs - random period for retrying a confirmed send
+
+#if defined(CFG_eu868) // EU868 spectrum ====================================================
+
+enum { MAX_CHANNELS = 16 }; //!< Max supported channels
+enum { MAX_BANDS = 4 };
+
+enum { LIMIT_CHANNELS = (1<<4) }; // EU868 will never have more channels
+//! \internal
+struct band_t {
+ u2_t txcap; // duty cycle limitation: 1/txcap
+ s1_t txpow; // maximum TX power
+ u1_t lastchnl; // last used channel
+ ostime_t avail; // channel is blocked until this time
+};
+TYPEDEF_xref2band_t; //!< \internal
+
+#elif defined(CFG_us915) // US915 spectrum =================================================
+
+enum { MAX_XCHANNELS = 2 }; // extra channels in RAM, channels 0-71 are immutable
+enum { MAX_TXPOW_125kHz = 30 };
+
+#endif // ==========================================================================
+
+// Keep in sync with evdefs.hpp::drChange
+enum { DRCHG_SET, DRCHG_NOJACC, DRCHG_NOACK, DRCHG_NOADRACK, DRCHG_NWKCMD };
+enum { KEEP_TXPOW = -128 };
+
+
+//! \internal
+struct rxsched_t {
+ u1_t dr;
+ u1_t intvExp; // 0..7
+ u1_t slot; // runs from 0 to 128
+ u1_t rxsyms;
+ ostime_t rxbase;
+ ostime_t rxtime; // start of next spot
+ u4_t freq;
+};
+TYPEDEF_xref2rxsched_t; //!< \internal
+
+
+//! Parsing and tracking states of beacons.
+enum { BCN_NONE = 0x00, //!< No beacon received
+ BCN_PARTIAL = 0x01, //!< Only first (common) part could be decoded (info,lat,lon invalid/previous)
+ BCN_FULL = 0x02, //!< Full beacon decoded
+ BCN_NODRIFT = 0x04, //!< No drift value measured yet
+ BCN_NODDIFF = 0x08 }; //!< No differential drift measured yet
+//! Information about the last and previous beacons.
+struct bcninfo_t {
+ ostime_t txtime; //!< Time when the beacon was sent
+ s1_t rssi; //!< Adjusted RSSI value of last received beacon
+ s1_t snr; //!< Scaled SNR value of last received beacon
+ u1_t flags; //!< Last beacon reception and tracking states. See BCN_* values.
+ u4_t time; //!< GPS time in seconds of last beacon (received or surrogate)
+ //
+ u1_t info; //!< Info field of last beacon (valid only if BCN_FULL set)
+ s4_t lat; //!< Lat field of last beacon (valid only if BCN_FULL set)
+ s4_t lon; //!< Lon field of last beacon (valid only if BCN_FULL set)
+};
+
+// purpose of receive window - lmic_t.rxState
+enum { RADIO_RST=0, RADIO_TX=1, RADIO_RX=2, RADIO_RXON=3 };
+// Netid values / lmic_t.netid
+enum { NETID_NONE=(int)~0U, NETID_MASK=(int)0xFFFFFF };
+// MAC operation modes (lmic_t.opmode).
+enum { OP_NONE = 0x0000,
+ OP_SCAN = 0x0001, // radio scan to find a beacon
+ OP_TRACK = 0x0002, // track my networks beacon (netid)
+ OP_JOINING = 0x0004, // device joining in progress (blocks other activities)
+ OP_TXDATA = 0x0008, // TX user data (buffered in pendTxData)
+ OP_POLL = 0x0010, // send empty UP frame to ACK confirmed DN/fetch more DN data
+ OP_REJOIN = 0x0020, // occasionally send JOIN REQUEST
+ OP_SHUTDOWN = 0x0040, // prevent MAC from doing anything
+ OP_TXRXPEND = 0x0080, // TX/RX transaction pending
+ OP_RNDTX = 0x0100, // prevent TX lining up after a beacon
+ OP_PINGINI = 0x0200, // pingable is initialized and scheduling active
+ OP_PINGABLE = 0x0400, // we're pingable
+ OP_NEXTCHNL = 0x0800, // find a new channel
+ OP_LINKDEAD = 0x1000, // link was reported as dead
+ OP_TESTMODE = 0x2000, // developer test mode
+};
+// TX-RX transaction flags - report back to user
+enum { TXRX_ACK = 0x80, // confirmed UP frame was acked
+ TXRX_NACK = 0x40, // confirmed UP frame was not acked
+ TXRX_NOPORT = 0x20, // set if a frame with a port was RXed, clr if no frame/no port
+ TXRX_PORT = 0x10, // set if a frame with a port was RXed, LMIC.frame[LMIC.dataBeg-1] => port
+ TXRX_DNW1 = 0x01, // received in 1st DN slot
+ TXRX_DNW2 = 0x02, // received in 2dn DN slot
+ TXRX_PING = 0x04 }; // received in a scheduled RX slot
+// Event types for event callback
+enum _ev_t { EV_SCAN_TIMEOUT=1, EV_BEACON_FOUND,
+ EV_BEACON_MISSED, EV_BEACON_TRACKED, EV_JOINING,
+ EV_JOINED, EV_RFU1, EV_JOIN_FAILED, EV_REJOIN_FAILED,
+ EV_TXCOMPLETE, EV_LOST_TSYNC, EV_RESET,
+ EV_RXCOMPLETE, EV_LINK_DEAD, EV_LINK_ALIVE };
+typedef enum _ev_t ev_t;
+
+
+struct lmic_t {
+ // Radio settings TX/RX (also accessed by HAL)
+ ostime_t txend;
+ ostime_t rxtime;
+ u4_t freq;
+ s1_t rssi;
+ s1_t snr;
+ rps_t rps;
+ u1_t rxsyms;
+ u1_t dndr;
+ s1_t txpow; // dBm
+
+ osjob_t osjob;
+
+ // Channel scheduling
+#if defined(CFG_eu868)
+ band_t bands[MAX_BANDS];
+ u4_t channelFreq[MAX_CHANNELS];
+ u2_t channelDrMap[MAX_CHANNELS];
+ u2_t channelMap;
+#elif defined(CFG_us915)
+ u4_t xchFreq[MAX_XCHANNELS]; // extra channel frequencies (if device is behind a repeater)
+ u2_t xchDrMap[MAX_XCHANNELS]; // extra channel datarate ranges ---XXX: ditto
+ u2_t channelMap[(72+MAX_XCHANNELS+15)/16]; // enabled bits
+ u2_t chRnd; // channel randomizer
+#endif
+ u1_t txChnl; // channel for next TX
+ u1_t globalDutyRate; // max rate: 1/2^k
+ ostime_t globalDutyAvail; // time device can send again
+
+ u4_t netid; // current network id (~0 - none)
+ u2_t opmode;
+ u1_t upRepeat; // configured up repeat
+ s1_t adrTxPow; // ADR adjusted TX power
+ u1_t datarate; // current data rate
+ u1_t errcr; // error coding rate (used for TX only)
+ u1_t rejoinCnt; // adjustment for rejoin datarate
+ s2_t drift; // last measured drift
+ s2_t lastDriftDiff;
+ s2_t maxDriftDiff;
+
+ u1_t pendTxPort;
+ u1_t pendTxConf; // confirmed data
+ u1_t pendTxLen; // +0x80 = confirmed
+ u1_t pendTxData[MAX_LEN_PAYLOAD];
+
+ u2_t devNonce; // last generated nonce
+ u1_t nwkKey[16]; // network session key
+ u1_t artKey[16]; // application router session key
+ devaddr_t devaddr;
+ u4_t seqnoDn; // device level down stream seqno
+ u4_t seqnoUp;
+
+ u1_t dnConf; // dn frame confirm pending: LORA::FCT_ACK or 0
+ s1_t adrAckReq; // counter until we reset data rate (0=off)
+ u1_t adrChanged;
+
+ u1_t margin;
+ bit_t ladrAns; // link adr adapt answer pending
+ bit_t devsAns; // device status answer pending
+ u1_t adrEnabled;
+ u1_t moreData; // NWK has more data pending
+ bit_t dutyCapAns; // have to ACK duty cycle settings
+ u1_t snchAns; // answer set new channel
+ // 2nd RX window (after up stream)
+ u1_t dn2Dr;
+ u4_t dn2Freq;
+ u1_t dn2Ans; // 0=no answer pend, 0x80+ACKs
+
+ // Class B state
+ u1_t missedBcns; // unable to track last N beacons
+ u1_t bcninfoTries; // how often to try (scan mode only)
+ u1_t pingSetAns; // answer set cmd and ACK bits
+ rxsched_t ping; // pingable setup
+
+ // Public part of MAC state
+ u1_t txCnt;
+ u1_t txrxFlags; // transaction flags (TX-RX combo)
+ u1_t dataBeg; // 0 or start of data (dataBeg-1 is port)
+ u1_t dataLen; // 0 no data or zero length data, >0 byte count of data
+ u1_t frame[MAX_LEN_FRAME];
+
+ u1_t bcnChnl;
+ u1_t bcnRxsyms; //
+ ostime_t bcnRxtime;
+ bcninfo_t bcninfo; // Last received beacon info
+};
+//! \var struct lmic_t LMIC
+//! The state of LMIC MAC layer is encapsulated in this variable.
+DECLARE_LMIC; //!< \internal
+
+//! Construct a bit map of allowed datarates from drlo to drhi (both included).
+#define DR_RANGE_MAP(drlo,drhi) (((u2_t)0xFFFF<<(drlo)) & ((u2_t)0xFFFF>>(15-(drhi))))
+#if defined(CFG_eu868)
+enum { BAND_MILLI=0, BAND_CENTI=1, BAND_DECI=2, BAND_AUX=3 };
+bit_t LMIC_setupBand (u1_t bandidx, s1_t txpow, u2_t txcap);
+#endif
+bit_t LMIC_setupChannel (u1_t channel, u4_t freq, u2_t drmap, s1_t band);
+void LMIC_disableChannel (u1_t channel);
+
+void LMIC_setDrTxpow (dr_t dr, s1_t txpow); // set default/start DR/txpow
+void LMIC_setAdrMode (bit_t enabled); // set ADR mode (if mobile turn off)
+bit_t LMIC_startJoining (void);
+
+void LMIC_shutdown (void);
+void LMIC_init (void);
+void LMIC_reset (void);
+void LMIC_clrTxData (void);
+void LMIC_setTxData (void);
+int LMIC_setTxData2 (u1_t port, xref2u1_t data, u1_t dlen, u1_t confirmed);
+void LMIC_sendAlive (void);
+
+bit_t LMIC_enableTracking (u1_t tryBcnInfo);
+void LMIC_disableTracking (void);
+
+void LMIC_stopPingable (void);
+void LMIC_setPingable (u1_t intvExp);
+void LMIC_tryRejoin (void);
+
+void LMIC_setSession (u4_t netid, devaddr_t devaddr, xref2u1_t nwkKey, xref2u1_t artKey);
+void LMIC_setLinkCheckMode (bit_t enabled);
+
+// Special APIs - for development or testing
+// !!!See implementation for caveats!!!
+
+#endif // _lmic_h_