lorawan.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Fundación Inria Chile
 * SPDX-FileCopyrightText: 2019 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "compiler_hints.h"
#include "gnrc_lorawan_internal.h"
#include "assert.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_GNRC_LORAWAN_MIN_SYMBOLS_TIMEOUT
#define CONFIG_GNRC_LORAWAN_MIN_SYMBOLS_TIMEOUT 30
#endif
 
#define GNRC_LORAWAN_REQ_STATUS_SUCCESS (0)     
#define GNRC_LORAWAN_REQ_STATUS_DEFERRED (1)    

typedef enum {
    MCPS_EVENT_RX,              
    MCPS_EVENT_NO_RX,           
} mcps_event_t;

typedef enum {
    MLME_ACTIVATION_NONE,       
    MLME_ACTIVATION_ABP,        
    MLME_ACTIVATION_OTAA        
} mlme_activation_t;

typedef enum {
    MIB_ACTIVATION_METHOD,      
    MIB_DEV_ADDR,               
    MIB_RX2_DR,                 
} mlme_mib_type_t;

typedef enum {
    MLME_JOIN,                  
    MLME_LINK_CHECK,            
    MLME_RESET,                 
    MLME_SET,                   
    MLME_GET,                   
    MLME_SCHEDULE_UPLINK        
} mlme_type_t;

typedef enum {
    MCPS_CONFIRMED,             
    MCPS_UNCONFIRMED            
} mcps_type_t;

typedef struct {
    mlme_mib_type_t type;               
    union {
        mlme_activation_t activation;   
        void *dev_addr;                 
        uint8_t rx2_dr;                 
    };
} mlme_mib_t;

typedef struct {
    union {
        mlme_lorawan_join_t join;   
        mlme_mib_t mib;             
    };
    mlme_type_t type;               
} mlme_request_t;

typedef struct {
    union {
        mcps_data_t data;   
    };
    mcps_type_t type;       
} mcps_request_t;

typedef struct {
    int16_t status;                         
    mlme_type_t type;                       
    union {
        mlme_link_req_confirm_t link_req;   
        mlme_mib_t mib;                     
    };
} mlme_confirm_t;

typedef struct {
    int16_t status;     
    mcps_type_t type;   
    iolist_t *msdu;     
} mcps_confirm_t;

typedef struct {
    mcps_type_t type;       
    union {
        mcps_data_t data;   
    };
} mcps_indication_t;

typedef struct {
    mlme_type_t type; 
} mlme_indication_t;

void gnrc_lorawan_radio_rx_timeout_cb(gnrc_lorawan_t *mac);

void gnrc_lorawan_radio_tx_done_cb(gnrc_lorawan_t *mac);

static inline void gnrc_lorawan_radio_rx_error_cb(gnrc_lorawan_t *mac)
{
    /* The failed reception is seen by the MAC layer as an RX timeout */
    gnrc_lorawan_radio_rx_timeout_cb(mac);
}

void gnrc_lorawan_timeout_cb(gnrc_lorawan_t *mac);

void gnrc_lorawan_init(gnrc_lorawan_t *mac, uint8_t *joineui, const gnrc_lorawan_key_ctx_t *ctx);

void gnrc_lorawan_mlme_request(gnrc_lorawan_t *mac,
                               const mlme_request_t *mlme_request,
                               mlme_confirm_t *mlme_confirm);

void gnrc_lorawan_mcps_request(gnrc_lorawan_t *mac,
                               const mcps_request_t *mcps_request,
                               mcps_confirm_t *mcps_confirm);

ACCESS(read_write, 2, 3)
void gnrc_lorawan_radio_rx_done_cb(gnrc_lorawan_t *mac, uint8_t *data,
                                   size_t size);

void gnrc_lorawan_mcps_indication(gnrc_lorawan_t *mac, mcps_indication_t *ind);

void gnrc_lorawan_mlme_indication(gnrc_lorawan_t *mac, mlme_indication_t *ind);

void gnrc_lorawan_mcps_confirm(gnrc_lorawan_t *mac, mcps_confirm_t *confirm);

void gnrc_lorawan_mlme_confirm(gnrc_lorawan_t *mac, mlme_confirm_t *confirm);

netdev_t *gnrc_lorawan_get_netdev(gnrc_lorawan_t *mac);

int gnrc_lorawan_phy_set_channel_mask(gnrc_lorawan_t *mac, uint16_t channel_mask);

void gnrc_lorawan_set_timer(gnrc_lorawan_t *mac, uint32_t us);

void gnrc_lorawan_remove_timer(gnrc_lorawan_t *mac);

static inline void gnrc_lorawan_set_uncnf_redundancy(gnrc_lorawan_t *mac,
                                                     uint8_t redundancy)
{
    assert(redundancy <= (0xF - 1));
    mac->mcps.redundancy = redundancy;
}
 
#ifdef __cplusplus
}
#endif