semtech_loramac.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Inria
 *
 * 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.
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <inttypes.h>
 
#include "mutex.h"
 
#include "net/netdev.h"
#include "net/loramac.h"

#define MSG_TYPE_ISR                        (0x3456) 
#define MSG_TYPE_RX_TIMEOUT                 (0x3457) 
#define MSG_TYPE_TX_TIMEOUT                 (0x3458) 
#define MSG_TYPE_MAC_TIMEOUT                (0x3459) 
#define MSG_TYPE_LORAMAC_CMD                (0x3460) 
#define MSG_TYPE_LORAMAC_JOIN_STATUS        (0x3461) 
#define MSG_TYPE_LORAMAC_TX_STATUS          (0x3462) 
#define MSG_TYPE_LORAMAC_MLME_CONFIRM       (0x3463) 
#define MSG_TYPE_LORAMAC_MLME_INDICATION    (0x3464) 
#define MSG_TYPE_LORAMAC_MCPS_CONFIRM       (0x3465) 
#define MSG_TYPE_LORAMAC_MCPS_INDICATION    (0x3466) 

#define LORAWAN_APP_DATA_MAX_SIZE      (242U)

enum {
    SEMTECH_LORAMAC_JOIN_SUCCEEDED,             
    SEMTECH_LORAMAC_JOIN_FAILED,                
    SEMTECH_LORAMAC_NOT_JOINED,                 
    SEMTECH_LORAMAC_ALREADY_JOINED,             
    SEMTECH_LORAMAC_TX_OK,                      
    SEMTECH_LORAMAC_TX_SCHEDULE,                
    SEMTECH_LORAMAC_TX_DONE,                    
    SEMTECH_LORAMAC_TX_CNF_FAILED,              
    SEMTECH_LORAMAC_TX_ERROR,                   
    SEMTECH_LORAMAC_RX_DATA,                    
    SEMTECH_LORAMAC_RX_LINK_CHECK,              
    SEMTECH_LORAMAC_RX_CONFIRMED,               
    SEMTECH_LORAMAC_BUSY,                       
    SEMTECH_LORAMAC_DUTYCYCLE_RESTRICTED        
};

enum {
    SEMTECH_LORAMAC_STATE_IDLE = 0,
    SEMTECH_LORAMAC_STATE_BUSY
};

typedef struct {
    uint32_t frequency;                          
    uint8_t datarate;                            
} semtech_loramac_channel_params_t;

typedef struct {
    uint8_t payload[LORAWAN_APP_DATA_MAX_SIZE];  
    uint8_t payload_len;                         
    uint8_t port;                                
} semtech_loramac_rx_data_t;
 
#if defined(MODULE_SEMTECH_LORAMAC_RX) || DOXYGEN
typedef struct {
    uint8_t demod_margin;                        
    uint8_t nb_gateways;                         
} semtech_loramac_link_check_info_t;
#endif

typedef struct {
    netdev_t *netdev;                            
    mutex_t lock;                                
    uint8_t tx_pid;                              
#if defined(MODULE_SEMTECH_LORAMAC_RX) || DOXYGEN
    uint8_t rx_pid;                              
#endif
    uint8_t port;                                
    uint8_t cnf;                                 
    uint8_t deveui[LORAMAC_DEVEUI_LEN];          
    uint8_t appeui[LORAMAC_APPEUI_LEN];          
    uint8_t appkey[LORAMAC_APPKEY_LEN];          
#if defined(MODULE_SEMTECH_LORAMAC_RX) || DOXYGEN
    semtech_loramac_rx_data_t rx_data;           
    semtech_loramac_link_check_info_t link_chk;  
#endif
} semtech_loramac_t;

int semtech_loramac_init(semtech_loramac_t *mac);

uint8_t semtech_loramac_join(semtech_loramac_t *mac, uint8_t type);

uint8_t semtech_loramac_send(semtech_loramac_t *mac, uint8_t *data, uint8_t len);
 
#if defined(MODULE_SEMTECH_LORAMAC_RX) || DOXYGEN
uint8_t semtech_loramac_recv(semtech_loramac_t *mac);
#endif

bool semtech_loramac_is_mac_joined(semtech_loramac_t *mac);
 
#if defined(MODULE_SEMTECH_LORAMAC_RX) || DOXYGEN
void semtech_loramac_request_link_check(semtech_loramac_t *mac);
#endif

void semtech_loramac_set_deveui(semtech_loramac_t *mac, const uint8_t *eui);

void semtech_loramac_get_deveui(const semtech_loramac_t *mac, uint8_t *eui);

void semtech_loramac_set_appeui(semtech_loramac_t *mac, const uint8_t *eui);

void semtech_loramac_get_appeui(const semtech_loramac_t *mac, uint8_t *eui);

void semtech_loramac_set_appkey(semtech_loramac_t *mac, const uint8_t *key);

void semtech_loramac_get_appkey(const semtech_loramac_t *mac, uint8_t *key);

void semtech_loramac_set_appskey(semtech_loramac_t *mac, const uint8_t *skey);

void semtech_loramac_get_appskey(semtech_loramac_t *mac, uint8_t *skey);

void semtech_loramac_set_nwkskey(semtech_loramac_t *mac, const uint8_t *skey);

void semtech_loramac_get_nwkskey(semtech_loramac_t *mac, uint8_t *skey);

void semtech_loramac_set_devaddr(semtech_loramac_t *mac, const uint8_t *addr);

void semtech_loramac_get_devaddr(semtech_loramac_t *mac, uint8_t *addr);

void semtech_loramac_set_class(semtech_loramac_t *mac, loramac_class_t cls);

loramac_class_t semtech_loramac_get_class(semtech_loramac_t *mac);

void semtech_loramac_set_dr(semtech_loramac_t *mac, uint8_t dr);

uint8_t semtech_loramac_get_dr(semtech_loramac_t *mac);

void semtech_loramac_set_adr(semtech_loramac_t *mac, bool adr);

bool semtech_loramac_get_adr(semtech_loramac_t *mac);

void semtech_loramac_set_public_network(semtech_loramac_t *mac, bool public);

bool semtech_loramac_get_public_network(semtech_loramac_t *mac);

void semtech_loramac_set_netid(semtech_loramac_t *mac, uint32_t netid);

uint32_t semtech_loramac_get_netid(semtech_loramac_t *mac);

void semtech_loramac_set_tx_power(semtech_loramac_t *mac, uint8_t power);

uint8_t semtech_loramac_get_tx_power(semtech_loramac_t *mac);

void semtech_loramac_set_tx_port(semtech_loramac_t *mac, uint8_t port);

void semtech_loramac_set_system_max_rx_error(semtech_loramac_t *mac, uint32_t error);

void semtech_loramac_set_min_rx_symbols(semtech_loramac_t *mac, uint8_t min_rx);

uint8_t semtech_loramac_get_tx_port(semtech_loramac_t *mac);

void semtech_loramac_set_tx_mode(semtech_loramac_t *mac, uint8_t mode);

uint8_t semtech_loramac_get_tx_mode(semtech_loramac_t *mac);

void semtech_loramac_set_rx2_freq(semtech_loramac_t *mac, uint32_t freq);

uint32_t semtech_loramac_get_rx2_freq(semtech_loramac_t *mac);

void semtech_loramac_set_rx2_dr(semtech_loramac_t *mac, uint8_t dr);

uint8_t semtech_loramac_get_rx2_dr(semtech_loramac_t *mac);

void semtech_loramac_set_uplink_counter(semtech_loramac_t *mac, uint32_t counter);

uint32_t semtech_loramac_get_uplink_counter(semtech_loramac_t *mac);

void semtech_loramac_set_channels_mask(semtech_loramac_t *mac, uint16_t *mask);

void semtech_loramac_get_channels_mask(semtech_loramac_t *mac, uint16_t *mask);
 
#ifdef MODULE_PERIPH_EEPROM
#ifndef SEMTECH_LORAMAC_EEPROM_MAGIC
#define SEMTECH_LORAMAC_EEPROM_MAGIC        {0x52, 0x49, 0x4F, 0x54} /* RIOT */
#endif

#ifndef SEMTECH_LORAMAC_EEPROM_MAGIC_LEN
#define SEMTECH_LORAMAC_EEPROM_MAGIC_LEN    4
#endif

#ifndef SEMTECH_LORAMAC_EEPROM_START
#define SEMTECH_LORAMAC_EEPROM_START        (0)
#endif

void semtech_loramac_save_config(semtech_loramac_t *mac);

void semtech_loramac_erase_config(void);
#endif
 
#ifdef __cplusplus
}
#endif