LoRaMacTypes.h

Go to the documentation of this file.

 
#ifndef __LORAMAC_TYPES_H__
#define __LORAMAC_TYPES_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include "timer.h"
#include "systime.h"
 
#define LORAMAC_CRYPTO_UNICAST_KEYS                 0
 
#define LORAMAC_CRYPTO_MULTICAST_KEYS               127
 
#define LORAMAC_MAX_MC_CTX                          4
 
#define DR_0                                        0
 
#define DR_1                                        1
 
#define DR_2                                        2
 
#define DR_3                                        3
 
#define DR_4                                        4
 
#define DR_5                                        5
 
#define DR_6                                        6
 
#define DR_7                                        7
 
#define DR_8                                        8
 
#define DR_9                                        9
 
#define DR_10                                       10
 
#define DR_11                                       11
 
#define DR_12                                       12
 
#define DR_13                                       13
 
#define DR_14                                       14
 
#define DR_15                                       15
 
 
 
#define TX_POWER_0                                  0
 
#define TX_POWER_1                                  1
 
#define TX_POWER_2                                  2
 
#define TX_POWER_3                                  3
 
#define TX_POWER_4                                  4
 
#define TX_POWER_5                                  5
 
#define TX_POWER_6                                  6
 
#define TX_POWER_7                                  7
 
#define TX_POWER_8                                  8
 
#define TX_POWER_9                                  9
 
#define TX_POWER_10                                 10
 
#define TX_POWER_11                                 11
 
#define TX_POWER_12                                 12
 
#define TX_POWER_13                                 13
 
#define TX_POWER_14                                 14
 
#define TX_POWER_15                                 15
 
typedef enum DeviceClass_e
{
    CLASS_A = 0x00,
    CLASS_B = 0x01,
    CLASS_C = 0x02,
}DeviceClass_t;
 
typedef enum eFType
{
    FRAME_TYPE_A,
    FRAME_TYPE_B,
    FRAME_TYPE_C,
    FRAME_TYPE_D,
}FType_t;
 
typedef enum eFCntIdentifier
{
    FCNT_UP = 0,
    N_FCNT_DOWN,
    A_FCNT_DOWN,
    FCNT_DOWN,
    MC_FCNT_DOWN_0,
    MC_FCNT_DOWN_1,
    MC_FCNT_DOWN_2,
    MC_FCNT_DOWN_3,
}FCntIdentifier_t;
 
typedef enum eKeyIdentifier
{
    APP_KEY = 0,
    NWK_KEY,
    J_S_INT_KEY,
    J_S_ENC_KEY,
    F_NWK_S_INT_KEY,
    S_NWK_S_INT_KEY,
    NWK_S_ENC_KEY,
    APP_S_KEY,
    MC_ROOT_KEY,
    MC_KE_KEY = LORAMAC_CRYPTO_MULTICAST_KEYS,
    MC_KEY_0,
    MC_APP_S_KEY_0,
    MC_NWK_S_KEY_0,
    MC_KEY_1,
    MC_APP_S_KEY_1,
    MC_NWK_S_KEY_1,
    MC_KEY_2,
    MC_APP_S_KEY_2,
    MC_NWK_S_KEY_2,
    MC_KEY_3,
    MC_APP_S_KEY_3,
    MC_NWK_S_KEY_3,
    SLOT_RAND_ZERO_KEY,
    NO_KEY,
}KeyIdentifier_t;
 
typedef enum eAddressIdentifier
{
    MULTICAST_0_ADDR = 0,
    MULTICAST_1_ADDR = 1,
    MULTICAST_2_ADDR = 2,
    MULTICAST_3_ADDR = 3,
    UNICAST_DEV_ADDR = 4,
}AddressIdentifier_t;
 
/*
 * Multicast Rx window parameters
 */
typedef union uMcRxParams
{
    struct
    {
        uint32_t Frequency;
        int8_t Datarate;
        uint16_t Periodicity;
    }ClassB;
    struct
    {
        uint32_t Frequency;
        int8_t Datarate;
    }ClassC;
}McRxParams_t;
 
typedef struct sMcChannelParams
{
    bool IsRemotelySetup;
    DeviceClass_t Class;
    bool IsEnabled;
    /*
     * Address identifier
     */
    AddressIdentifier_t GroupID;
    uint32_t Address;
    union uMcKeys
    {
        uint8_t *McKeyE;
        struct
        {
            uint8_t *McAppSKey;
            uint8_t *McNwkSKey;
        }Session;
    }McKeys;
    uint32_t FCountMin;
    uint32_t FCountMax;
    McRxParams_t RxParams;
}McChannelParams_t;
 
typedef struct sMulticastCtx
{
    McChannelParams_t ChannelParams;
    uint32_t* DownLinkCounter;
    /*
     * Following parameters are only used for ClassB multicast channels
     */
    uint8_t PingNb;
    uint16_t PingPeriod;
    uint16_t PingOffset;
    uint8_t FPendingSet;
}MulticastCtx_t;
 
typedef enum eJoinReqIdentifier
{
    REJOIN_REQ_0 = 0x00,
    REJOIN_REQ_1 = 0x01,
    REJOIN_REQ_2 = 0x02,
    JOIN_REQ = 0xFF,
}JoinReqIdentifier_t;
 
typedef enum eLoRaMacMoteCmd
{
    MOTE_MAC_LINK_CHECK_REQ          = 0x02,
    MOTE_MAC_LINK_ADR_ANS            = 0x03,
    MOTE_MAC_DUTY_CYCLE_ANS          = 0x04,
    MOTE_MAC_RX_PARAM_SETUP_ANS      = 0x05,
    MOTE_MAC_DEV_STATUS_ANS          = 0x06,
    MOTE_MAC_NEW_CHANNEL_ANS         = 0x07,
    MOTE_MAC_RX_TIMING_SETUP_ANS     = 0x08,
    MOTE_MAC_TX_PARAM_SETUP_ANS      = 0x09,
    MOTE_MAC_DL_CHANNEL_ANS          = 0x0A,
    MOTE_MAC_DEVICE_TIME_REQ         = 0x0D,
    MOTE_MAC_PING_SLOT_INFO_REQ      = 0x10,
    MOTE_MAC_PING_SLOT_CHANNEL_ANS   = 0x11,
    MOTE_MAC_BEACON_TIMING_REQ       = 0x12,
    MOTE_MAC_BEACON_FREQ_ANS         = 0x13,
}LoRaMacMoteCmd_t;
 
typedef enum eLoRaMacSrvCmd
{
    SRV_MAC_RESET_CONF               = 0x01,
    SRV_MAC_LINK_CHECK_ANS           = 0x02,
    SRV_MAC_LINK_ADR_REQ             = 0x03,
    SRV_MAC_DUTY_CYCLE_REQ           = 0x04,
    SRV_MAC_RX_PARAM_SETUP_REQ       = 0x05,
    SRV_MAC_DEV_STATUS_REQ           = 0x06,
    SRV_MAC_NEW_CHANNEL_REQ          = 0x07,
    SRV_MAC_RX_TIMING_SETUP_REQ      = 0x08,
    SRV_MAC_TX_PARAM_SETUP_REQ       = 0x09,
    SRV_MAC_DL_CHANNEL_REQ           = 0x0A,
    SRV_MAC_DEVICE_TIME_ANS          = 0x0D,
    SRV_MAC_PING_SLOT_INFO_ANS       = 0x10,
    SRV_MAC_PING_SLOT_CHANNEL_REQ    = 0x11,
    SRV_MAC_BEACON_TIMING_ANS        = 0x12,
    SRV_MAC_BEACON_FREQ_REQ          = 0x13,
}LoRaMacSrvCmd_t;
 
typedef struct sBand
{
    uint16_t DCycle;
    int8_t TxMaxPower;
    TimerTime_t LastBandUpdateTime;
    TimerTime_t LastMaxCreditAssignTime;
    TimerTime_t TimeCredits;
    TimerTime_t MaxTimeCredits;
    bool ReadyForTransmission;
}Band_t;
 
typedef union uDrRange
{
    int8_t Value;
    struct sFields
    {
        int8_t Min : 4;
        int8_t Max : 4;
    }Fields;
}DrRange_t;
 
typedef struct sChannelParams
{
    uint32_t Frequency;
    uint32_t Rx1Frequency;
    DrRange_t DrRange;
    uint8_t Band;
}ChannelParams_t;
 
typedef enum eLoRaMacFrameType
{
    FRAME_TYPE_JOIN_REQ              = 0x00,
    FRAME_TYPE_JOIN_ACCEPT           = 0x01,
    FRAME_TYPE_DATA_UNCONFIRMED_UP   = 0x02,
    FRAME_TYPE_DATA_UNCONFIRMED_DOWN = 0x03,
    FRAME_TYPE_DATA_CONFIRMED_UP     = 0x04,
    FRAME_TYPE_DATA_CONFIRMED_DOWN   = 0x05,
    FRAME_TYPE_PROPRIETARY           = 0x07,
}LoRaMacFrameType_t;
 
typedef enum eLoRaMacBatteryLevel
{
    BAT_LEVEL_EXT_SRC                = 0x00,
    BAT_LEVEL_EMPTY                  = 0x01,
    BAT_LEVEL_FULL                   = 0xFE,
    BAT_LEVEL_NO_MEASURE             = 0xFF,
}LoRaMacBatteryLevel_t;
 
#ifdef __cplusplus
}
#endif
 
#endif // __LORAMAC_TYPES_H__