lmic_accessors.h

/*
 
Module:  lmic_accessors.h
 
Function:
        Accessors for the LMIC instance: getters for status and settings,
        setters for the few things a client may change directly.
 
Copyright notice and license info:
        See LICENSE file accompanying this project.
 
Author:
        Terry Moore, MCCI Corporation   September 2026
 
Description:
        Clients should use these instead of reading or writing fields of
        the LMIC object. The field layout changes in V7 (regional state
        moves into unions); these accessors do not.
 
        Where the LMIC field name differs from the LoRaWAN specification's
        name for the same thing, the accessor uses the specification's name
        (LoRaWAN 1.0.3 and Regional Parameters 1.0.3revA): FCntUp, FCntDown,
        DevAddr, NetID, DevNonce, DataRate, TXPower, ChIndex, RX2DataRate,
        FPort, FRMPayload, RSSI, SNR. Things the specification does not name
        (operating mode, radio parameter word, timing) keep LMIC names.
 
        Fields that exist only when a feature is compiled in (beacons,
        ping, DeviceTimeReq) have getters only when the feature is
        compiled in. Fields that depend on the region have getters that
        return false when the active region has no such field.
 
        See mcci-catena/arduino-lmic#1089.
 
*/
 
#ifndef _lmic_accessors_h_      /* prevent multiple includes */
#define _lmic_accessors_h_
 
#ifndef _lmic_h_
# include "lmic.h"
#endif
 
LMIC_BEGIN_DECLS
 
/****************************************************************************\
|
|       Region
|
\****************************************************************************/

typedef enum lmic_region_kind_e {
        LMIC_REGION_KIND_CONFIGURABLE = 1,      
        LMIC_REGION_KIND_FIXED = 2,             
} lmic_region_kind_t;

static inline u1_t LMIC_getRegion(void) {
        return CFG_region;
}

static inline lmic_region_kind_t LMIC_getRegionKind(void) {
#if CFG_LMIC_EU_like
        return LMIC_REGION_KIND_CONFIGURABLE;
#else
        return LMIC_REGION_KIND_FIXED;
#endif
}
 
/****************************************************************************\
|
|       Radio and link status
|
\****************************************************************************/

static inline u4_t LMIC_getFrequency(void) {
        return LMIC.freq;
}

static inline dr_t LMIC_getDataRate(void) {
        return LMIC.datarate;
}

static inline rps_t LMIC_getRps(void) {
        return LMIC.rps;
}

static inline s1_t LMIC_getAdrTXPower(void) {
        return LMIC.adrTxPow;
}

static inline s1_t LMIC_getRadioTxPower(void) {
        return LMIC.txpow;
}

static inline s1_t LMIC_getRSSI(void) {
        return LMIC.rssi;
}

static inline s1_t LMIC_getSNR(void) {
        return LMIC.snr;
}

static inline u1_t LMIC_getTxChIndex(void) {
        return LMIC.txChnl;
}

static inline dr_t LMIC_getRX2DataRate(void) {
        return LMIC.dn2Dr;
}

static inline u4_t LMIC_getRX2Frequency(void) {
        return LMIC.dn2Freq;
}

static inline rxsyms_t LMIC_getRxsyms(void) {
        return LMIC.rxsyms;
}

static inline u1_t LMIC_getSaveIrqFlags(void) {
        return LMIC.saveIrqFlags;
}

static inline bit_t LMIC_getNoRxIqInversion(void) {
        return LMIC.noRXIQinversion != 0;
}

static inline ostime_t LMIC_getLbtTicks(void) {
        return LMIC.lbt_ticks;
}

static inline s1_t LMIC_getLbtDbmax(void) {
        return LMIC.lbt_dbmax;
}
 
/****************************************************************************\
|
|       Timing
|
\****************************************************************************/

static inline ostime_t LMIC_getTxend(void) {
        return LMIC.txend;
}

static inline ostime_t LMIC_getRxtime(void) {
        return LMIC.rxtime;
}

static inline ostime_t LMIC_getNextRxTime(void) {
        return LMIC.nextRxTime;
}

static inline ostime_t LMIC_getGlobalDutyAvail(void) {
        return LMIC.globalDutyAvail;
}
 
/****************************************************************************\
|
|       MAC state
|
\****************************************************************************/

static inline u2_t LMIC_getOpmode(void) {
        return LMIC.opmode;
}

static inline u2_t LMIC_getTxrxFlags(void) {
        return LMIC.txrxFlags;
}

static inline u4_t LMIC_getFCntUp(void) {
        return LMIC.seqnoUp;
}

static inline u4_t LMIC_getFCntDown(void) {
        return LMIC.seqnoDn;
}

static inline devaddr_t LMIC_getDevAddr(void) {
        return LMIC.devaddr;
}

static inline u4_t LMIC_getNetID(void) {
        return LMIC.netid;
}

static inline u2_t LMIC_getDevNonce(void) {
        return LMIC.devNonce;
}
 
/****************************************************************************\
|
|       Received data
|
\****************************************************************************/

static inline u1_t LMIC_getFRMPayload(const u1_t **ppData, u1_t *pLen) {
        if (LMIC.dataLen == 0 || LMIC.dataBeg == 0) {
                *ppData = NULL;
                *pLen = 0;
                return 0;
        }
        *ppData = LMIC.frame + LMIC.dataBeg;
        *pLen = LMIC.dataLen;
        return LMIC.frame[LMIC.dataBeg - 1];
}

static inline u1_t LMIC_getFRMPayloadLen(void) {
        return LMIC.dataLen;
}
 
/****************************************************************************\
|
|       Setters for raw (non-LoRaWAN) transmission
|
\****************************************************************************/

static inline void LMIC_setFrequency(u4_t freq) {
        LMIC.freq = freq;
}

static inline void LMIC_setDataRate(dr_t dr) {
        LMIC.datarate = dr;
}

static inline void LMIC_setRps(rps_t rps) {
        LMIC.rps = rps;
}

static inline void LMIC_setRadioTxPower(s1_t txpow) {
        LMIC.txpow = txpow;
}

static inline void LMIC_setLbt(ostime_t ticks, s1_t dbmax) {
        LMIC.lbt_ticks = ticks;
        LMIC.lbt_dbmax = dbmax;
}

static inline void LMIC_setNoRxIqInversion(bit_t fNoInversion) {
        LMIC.noRXIQinversion = fNoInversion;
}

static inline void LMIC_setRX2DataRate(dr_t dr) {
        LMIC.dn2Dr = dr;
}

static inline u1_t LMIC_setRawTxData(const u1_t *pData, u1_t len) {
        // MAX_LEN_FRAME is an int enumerator, usually 255. Comparing a u1_t
        // against it directly draws -Wtype-limits ("always false") in that
        // configuration; comparing against a u1_t holding the same value does not,
        // and still clamps when MAX_LEN_FRAME is configured to be less than 255.
        u1_t const maxLen = MAX_LEN_FRAME;
 
        if (len > maxLen)
                len = maxLen;
        os_copyMem(LMIC.frame, pData, len);
        LMIC.dataLen = len;
        return len;
}

static inline void LMIC_getRawRxData(const u1_t **ppData, u1_t *pLen) {
        *ppData = LMIC.frame;
        *pLen = LMIC.dataLen;
}

static inline void LMIC_setNextRxTime(ostime_t t) {
        LMIC.nextRxTime = t;
}
 
LMIC_END_DECLS
 
#endif /* _lmic_accessors_h_ */