gnrc_lorawan_internal.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 HAW Hamburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef GNRC_LORAWAN_INTERNAL_H
#define GNRC_LORAWAN_INTERNAL_H
 
#include <stdio.h>
#include <string.h>
#include "iolist.h"
#include "net/lora.h"
#include "net/lorawan/hdr.h"
#include "net/gnrc/pktbuf.h"
#include "net/netdev.h"
#include "net/loramac.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MSG_TYPE_TIMEOUT             (0x3457)           
#define MTYPE_MASK           0xE0                       
#define MTYPE_JOIN_REQUEST   0x0                        
#define MTYPE_JOIN_ACCEPT    0x1                        
#define MTYPE_UNCNF_UPLINK   0x2                        
#define MTYPE_UNCNF_DOWNLINK 0x3                        
#define MTYPE_CNF_UPLINK     0x4                        
#define MTYPE_CNF_DOWNLINK   0x5                        
#define MTYPE_REJOIN_REQ     0x6                        
#define MTYPE_PROPIETARY     0x7                        
#define MAJOR_MASK     0x3                              
#define MAJOR_LRWAN_R1 0x0                              
#define MINOR_LRWAN    0x1                              
#define JOIN_REQUEST_SIZE (23U)                         
#define MIC_SIZE (4U)                                   
#define CFLIST_SIZE (16U)                               
#define GNRC_LORAWAN_MAX_CHANNELS (16U)                 
#define LORAWAN_STATE_IDLE (0)                          
#define LORAWAN_STATE_RX_1 (1)                          
#define LORAWAN_STATE_RX_2 (2)                          
#define LORAWAN_STATE_TX (3)                            
#define LORAWAN_STATE_JOIN (4)                          
#define GNRC_LORAWAN_DIR_UPLINK (0U)                    
#define GNRC_LORAWAN_DIR_DOWNLINK (1U)                  
#define GNRC_LORAWAN_BACKOFF_WINDOW_TICK (3600000000LL) 
#define GNRC_LORAWAN_BACKOFF_BUDGET_1   (36000000LL)    
#define GNRC_LORAWAN_BACKOFF_BUDGET_2   (36000000LL)    
#define GNRC_LORAWAN_BACKOFF_BUDGET_3   (8700000LL)     
#define GNRC_LORAWAN_MLME_OPTS_LINK_CHECK_REQ  (1 << 0) 
#define GNRC_LORAWAN_MLME_OPTS_REKEY_IND_REQ   (1 << 1) 
#define GNRC_LORAWAN_CID_SIZE (1U)                      
#define GNRC_LORAWAN_CID_LINK_CHECK_ANS (0x02)          
#define GNCR_LORAWAN_REKEY_IND_SIZE (1U)                
#define GNCR_LORAWAN_CID_REKEY_CONF (0x0B)              
#define GNRC_LORAWAN_FOPT_LINK_CHECK_ANS_SIZE (3U)      
#define GNRC_LORAWAN_FOPT_REKEY_CONF_SIZE (2U)          
#define GNRC_LORAWAN_JOIN_DELAY_U32_MASK (0x1FFFFF)     
#define GNRC_LORAWAN_MAX_PAYLOAD_1 (59U)                
#define GNRC_LORAWAN_MAX_PAYLOAD_2 (123U)               
#define GNRC_LORAWAN_MAX_PAYLOAD_3 (250U)               
#define GNRC_LORAWAN_CFLIST_ENTRY_SIZE (3U)             
#define GNRC_LORAWAN_JOIN_ACCEPT_MAX_SIZE (33U)         
#define GNRC_LORAWAN_BACKOFF_STATE_1 (0U)               
#define GNRC_LORAWAN_BACKOFF_STATE_2 (1U)               
#define GNRC_LORAWAN_BACKOFF_STATE_3 (2U)               
#define GNRC_LORAWAN_BACKOFF_TIME_1 (1U)                
#define GNRC_LORAWAN_BACKOFF_TIME_2 (10U)               
#define GNRC_LORAWAN_BACKOFF_TIME_3 (24U)               
#define GNRC_LORAWAN_APP_NONCE_SIZE (3U)                
#define GNRC_LORAWAN_JOIN_NONCE_SIZE (3U)               
#define GNRC_LORAWAN_NET_ID_SIZE (3U)                   
#define GNRC_LORAWAN_DEV_NONCE_SIZE (2U)                
#define GNRC_LORAWAN_FOPTS_MAX_SIZE (15U)               
#define GNRC_LORAWAN_FPORT_SIZE (1U)                    
#if defined(CPU_FAM_STM32F2) || defined(CPU_FAM_STM32F4) || \
    defined(CPU_FAM_STM32F7)
#define GNRC_LORAWAN_STATE_FLASHPAGE_NUM (0x7)                      
#else
#define GNRC_LORAWAN_STATE_FLASHPAGE_NUM (FLASHPAGE_NUMOF - 0x4)    
#endif
#define GNRC_LORAWAN_INITIALIZED_MARKER (0x52f94f54U)               
#define MHDR_MIC_BUF_SIZE (sizeof(lorawan_hdr_t) + \
                           GNRC_LORAWAN_FOPTS_MAX_SIZE + \
                           GNRC_LORAWAN_FPORT_SIZE + \
                           MIC_SIZE)
 
typedef struct {
    uint8_t *data;  
    uint8_t size;   
    uint8_t index;  
} lorawan_buffer_t;
 
typedef struct {
    void *deveui;   
    void *joineui;  
    void *nwkkey;   
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    void *appkey;   
#endif
    uint8_t dr;     
} mlme_lorawan_join_t;
 
typedef enum {
    REJOIN_REQ_0,       
    REJOIN_REQ_1,       
    REJOIN_REQ_2,       
    JOIN_REQ = 0xFF     
} mlme_join_req_type_t;
 
typedef struct {
    uint8_t margin;         
    uint8_t num_gateways;   
} mlme_link_req_confirm_t;
 
typedef struct {
    iolist_t *pkt;          
    uint8_t port;           
    uint8_t dr;             
} mcps_data_t;
 
typedef struct {
    uint32_t fcnt;                      
    uint32_t fcnt_down;                 
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    uint32_t afcnt_down;                
    uint32_t last_fcnt_down;            
#endif
    iolist_t *msdu;                     
    int nb_trials;                      
    int ack_requested;                  
    int waiting_for_ack;                
    uint8_t redundancy;                 
    char mhdr_mic[MHDR_MIC_BUF_SIZE];   
} gnrc_lorawan_mcps_t;
 
typedef struct {
    uint8_t activation;     
    int pending_mlme_opts;  
    uint32_t nid;           
    int32_t backoff_budget; 
    uint8_t dev_nonce[2];   
    uint8_t backoff_state;  
} gnrc_lorawan_mlme_t;
 
typedef struct {
    uint8_t *appskey;                               
    uint8_t *fnwksintkey;                           
    uint8_t *snwksintkey;                           
    uint8_t *nwksenckey;                            
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    uint8_t *jsintkey;                              
    uint8_t *jsenckey;                              
#endif
} gnrc_lorawan_key_ctx_t;
 
typedef struct {
    gnrc_lorawan_mcps_t mcps;                       
    gnrc_lorawan_mlme_t mlme;                       
    void *mlme_buf;                                 
    void *mcps_buf;                                 
    uint8_t *joineui;                               
    gnrc_lorawan_key_ctx_t ctx;                     
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    bool optneg;                                    
#endif
    uint32_t channel[GNRC_LORAWAN_MAX_CHANNELS];    
    uint16_t channel_mask;                          
    uint32_t toa;                                   
    int busy;                                       
    int shutdown_req;                               
    le_uint32_t dev_addr;                           
    int state;                                      
    uint8_t dl_settings;                            
    uint8_t rx_delay;                               
    uint8_t dr_range[GNRC_LORAWAN_MAX_CHANNELS];    
    uint8_t last_dr;                                
    uint8_t last_chan_idx;                          
} gnrc_lorawan_t;
 
typedef struct {
    uint32_t initialized_marker;    
    uint8_t dev_nonce[2];           
} gnrc_lorawan_persistent_state_t;
 
void gnrc_lorawan_encrypt_payload(iolist_t *iolist, const le_uint32_t *dev_addr,
                                  uint32_t fcnt, uint8_t dir,
                                  const uint8_t *appskey);
 
void gnrc_lorawan_encrypt_fopts(uint8_t *fopts, size_t len,
                                const le_uint32_t *dev_addr, uint32_t fcnt,
                                bool afcnt, uint8_t dir, const uint8_t *key);
 
void gnrc_lorawan_decrypt_join_accept(const uint8_t *key, uint8_t *pkt,
                                      int has_clist, uint8_t *out);
 
void gnrc_lorawan_generate_session_keys(const uint8_t *join_nonce,
                                        const uint8_t *dev_nonce,
                                        const uint8_t *joineui,
                                        gnrc_lorawan_t *mac);
 
void gnrc_lorawan_generate_lifetime_session_keys(const uint8_t *deveui,
                                                 const uint8_t *nwkkey,
                                                 uint8_t *jsintkey,
                                                 uint8_t *jsenckey);
int gnrc_lorawan_set_dr(gnrc_lorawan_t *mac, uint8_t datarate);
 
size_t gnrc_lorawan_build_uplink(gnrc_lorawan_t *mac, iolist_t *payload,
                                 int confirmed_data, uint8_t port);
 
uint8_t gnrc_lorawan_pick_channel(gnrc_lorawan_t *mac);
 
uint8_t gnrc_lorawan_build_options(gnrc_lorawan_t *mac, lorawan_buffer_t *buf);
 
void gnrc_lorawan_process_fopts(gnrc_lorawan_t *mac, uint8_t *fopts,
                                size_t size);
 
void gnrc_lorawan_calculate_join_req_mic(const uint8_t *buf, size_t len,
                                         uint8_t *key, le_uint32_t *out);
 
void gnrc_lorawan_calculate_join_acpt_mic(const uint8_t *buf, size_t len,
                                          gnrc_lorawan_t *mac, le_uint32_t *out);
 
void gnrc_lorawan_calculate_mic_uplink(iolist_t *frame, uint16_t conf_fcnt,
                                       gnrc_lorawan_t *mac, le_uint32_t *out);
 
void gnrc_lorawan_calculate_mic_downlink(const le_uint32_t *dev_addr,
                                         uint32_t fcnt, uint16_t conf_fcnt,
                                         iolist_t *frame,
                                         const uint8_t *snwksintkey,
                                         le_uint32_t *out);
 
size_t gnrc_lorawan_build_hdr(uint8_t mtype, le_uint32_t *dev_addr,
                              uint32_t fcnt, uint8_t ack, uint8_t fopts_length,
                              lorawan_buffer_t *buf);
 
void  gnrc_lorawan_mcps_process_downlink(gnrc_lorawan_t *mac, uint8_t *psdu,
                                         size_t size);
 
void gnrc_lorawan_channels_init(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_reset(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_send_pkt(gnrc_lorawan_t *mac, iolist_t *psdu, uint8_t dr,
                           uint32_t chan);
 
void gnrc_lorawan_mlme_process_join(gnrc_lorawan_t *mac, uint8_t *data,
                                    size_t size);
 
void gnrc_lorawan_mlme_no_rx(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_event_no_rx(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_event_retrans_timeout(gnrc_lorawan_t *mac);
 
uint8_t gnrc_lorawan_region_mac_payload_max(uint8_t datarate);
 
void gnrc_lorawan_mlme_backoff_expire_cb(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_process_pkt(gnrc_lorawan_t *mac, iolist_t *pkt);
 
void gnrc_lorawan_open_rx_window(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_perform_save(gnrc_lorawan_t *mac);
 
static inline int gnrc_lorawan_mac_acquire(gnrc_lorawan_t *mac)
{
    int _c = mac->busy;
 
    mac->busy = true;
    return !_c;
}
 
static inline void gnrc_lorawan_mac_release(gnrc_lorawan_t *mac)
{
    mac->busy = false;
}
 
void gnrc_lorawan_set_rx2_dr(gnrc_lorawan_t *mac, uint8_t rx2_dr);
 
void gnrc_lorawan_trigger_join(gnrc_lorawan_t *mac);
 
void gnrc_lorawan_store_dev_nonce(uint8_t *dev_nonce);
 
static inline bool gnrc_lorawan_optneg_is_set(const gnrc_lorawan_t *mac)
{
    (void)mac;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mac->optneg;
#else
    return 1; /* NO-OP */
#endif
}
 
static inline void gnrc_lorawan_set_optneg(gnrc_lorawan_t *mac, uint8_t optneg)
{
    (void)mac;
    (void)optneg;
 
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    mac->optneg = optneg;
#endif
}
 
static inline uint8_t *gnrc_lorawan_get_jsintkey(const gnrc_lorawan_t *mac)
{
    (void)mac;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mac->ctx.jsintkey;
#else
    return NULL; /* NO-OP */
#endif
}
 
static inline uint8_t *gnrc_lorawan_get_jsenckey(const gnrc_lorawan_t *mac)
{
    (void)mac;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mac->ctx.jsenckey;
#else
    return NULL; /* NO-OP */
#endif
}
 
static inline uint32_t gnrc_lorawan_get_afcnt_down(const gnrc_lorawan_t *mac)
{
    (void)mac;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mac->mcps.afcnt_down;
#else
    return 0; /* NO-OP */
#endif
}
 
static inline void gnrc_lorawan_set_afcnt_down(gnrc_lorawan_t *mac, uint32_t afcnt_down)
{
    (void)mac;
    (void)afcnt_down;
 
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    mac->mcps.afcnt_down = afcnt_down;
#endif
}
 
static inline uint32_t gnrc_lorawan_get_last_fcnt_down(const gnrc_lorawan_t *mac)
{
    (void)mac;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mac->mcps.last_fcnt_down;
#else
    return 0; /* NO-OP */
#endif
}
 
static inline void gnrc_lorawan_set_last_fcnt_down(gnrc_lorawan_t *mac, uint32_t last_fcnt_down)
{
    (void)mac;
    (void)last_fcnt_down;
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    mac->mcps.last_fcnt_down = last_fcnt_down;
#endif
}
 
static inline uint8_t * gnrc_lorawan_mlme_join_get_appkey(const mlme_lorawan_join_t *mlme_join)
{
    (void)mlme_join;
 
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    return mlme_join->appkey;
#else
    return NULL; /* NO-OP */
#endif
}
 
static inline void gnrc_lorawan_mlme_join_set_appkey(mlme_lorawan_join_t *mlme_join, uint8_t *key)
{
    (void)mlme_join;
    (void)key;
 
#if IS_USED(MODULE_GNRC_LORAWAN_1_1)
    mlme_join->appkey = key;
#endif
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* GNRC_LORAWAN_INTERNAL_H */