RIOT/html/gnrc__lorawan__internal_8h_source.html

/*

 * 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 "xtimer.h"

#include "msg.h"

#include "net/netdev.h"

#include "net/netdev/layer.h"

#include "net/loramac.h"


#ifdef __cplusplus

extern "C" {

#endif


#define MSG_TYPE_TIMEOUT             (0x3457)

#define MSG_TYPE_MCPS_ACK_TIMEOUT    (0x3458)

#define MSG_TYPE_MLME_BACKOFF_EXPIRE (0x3459)

#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 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 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_CID_SIZE (1U)

#define GNRC_LORAWAN_CID_LINK_CHECK_ANS (0x02)

#define GNRC_LORAWAN_FOPT_LINK_CHECK_ANS_SIZE (3U)

#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_NET_ID_SIZE (3U)

#define GNRC_LORAWAN_DEV_NONCE_SIZE (2U)

#define GNRC_LORAWAN_FOPTS_MAX_SIZE (15U)

#define GNRC_LORAWAN_FPORT_SIZE (1U)

#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 *appeui;

    void *appkey;

    uint8_t dr;

} mlme_lorawan_join_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;

    iolist_t *msdu;

    int nb_trials;

    int ack_requested;

    int waiting_for_ack;

    char mhdr_mic[MHDR_MIC_BUF_SIZE];

} gnrc_lorawan_mcps_t;


typedef struct {

    xtimer_t backoff_timer;

    msg_t backoff_msg;

    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 {

    xtimer_t rx;

    msg_t msg;

    gnrc_lorawan_mcps_t mcps;

    gnrc_lorawan_mlme_t mlme;

    void *mlme_buf;

    void *mcps_buf;

    uint8_t *nwkskey;

    uint8_t *appskey;

    uint32_t channel[GNRC_LORAWAN_MAX_CHANNELS];

    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;

} gnrc_lorawan_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_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 *app_nonce,

                                        const uint8_t *dev_nonce,

                                        const uint8_t *appkey, uint8_t *nwkskey,

                                        uint8_t *appskey);


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);


uint32_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_mic(const uint8_t *buf, size_t len,

                                     const uint8_t *key, le_uint32_t *out);


void gnrc_lorawan_calculate_mic(const le_uint32_t *dev_addr, uint32_t fcnt,

                                uint8_t dir, iolist_t *frame,

                                const uint8_t *nwkskey, 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);


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_ack_timeout(gnrc_lorawan_t *mac);


uint8_t gnrc_lorawan_region_mac_payload_max(uint8_t datarate);


void gnrc_lorawan_mlme_backoff_expire(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);


#ifdef __cplusplus

}

#endif


#endif /* GNRC_LORAWAN_INTERNAL_H */