rn2xx3.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 Inria
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "ztimer.h"
#include "periph/uart.h"
#include "periph/gpio.h"
#include "net/netdev.h"
 
#include "net/loramac.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define RN2XX3_MAX_BUF                  (40U)

#define RN2XX3_RX_MAX_BUF               (250U)

#define RN2XX3_REPLY_DELAY_TIMEOUT      (60U)

#define RN2XX3_SLEEP_MIN                (100U)

#ifndef CONFIG_RN2XX3_DEFAULT_SLEEP
#define CONFIG_RN2XX3_DEFAULT_SLEEP            (5000U)
#endif

#ifdef DOXYGEN
#define CONFIG_RN2XX3_DEFAULT_AR
#endif
 
#if defined(MODULE_RN2903)
#define RN2XX3_FREQ_BAND                (915U)
#elif defined(MODULE_RN2483)
#define RN2XX3_FREQ_BAND                (868U)
#else
#error "Unsupported module type, use either RN2483 or RN2903"
#endif

enum {
    RN2XX3_OK,                         
    RN2XX3_DATA,                       
    RN2XX3_TIMEOUT,                    
    /* all other error codes */
    RN2XX3_ERR_MAC_INIT,               
    RN2XX3_ERR_INVALID_PARAM,          
    RN2XX3_ERR_NOT_JOINED,             
    RN2XX3_ERR_NO_FREE_CH,             
    RN2XX3_ERR_SILENT,                 
    RN2XX3_ERR_FR_CNT_REJOIN_NEEDED,   
    RN2XX3_ERR_BUSY,                   
    RN2XX3_ERR_MAC_PAUSED,             
    RN2XX3_ERR_INVALID_DATA_LENGTH,    
    RN2XX3_ERR_KEYS_NOT_INIT,          
    RN2XX3_ERR_SLEEP_MODE,             
    /* all other reply codes */
    RN2XX3_REPLY_TX_MAC_OK,            
    RN2XX3_REPLY_TX_MAC_ERR,           
    RN2XX3_REPLY_TX_INVALID_DATA_LEN,  
    RN2XX3_REPLY_TX_MAC_RX,            
    RN2XX3_REPLY_JOIN_ACCEPTED,        
    RN2XX3_REPLY_JOIN_DENIED,          
    RN2XX3_REPLY_TIMEOUT,              
    RN2XX3_REPLY_OTHER,                
};

enum {
    RN2XX3_INT_STATE_RESET,            
    RN2XX3_INT_STATE_CMD,              
    RN2XX3_INT_STATE_IDLE,             
    RN2XX3_INT_STATE_SLEEP,            
    RN2XX3_INT_STATE_MAC_JOIN,         
    RN2XX3_INT_STATE_MAC_TX,           
    RN2XX3_INT_STATE_MAC_RX_PORT,      
    RN2XX3_INT_STATE_MAC_RX_MESSAGE,   
};

typedef struct {
    uint32_t rx2_freq;                 
    loramac_dr_idx_t rx2_dr;           
    uint8_t tx_port;                   
    loramac_tx_mode_t tx_mode;         
    uint8_t rx_port;                   
} loramac_settings_t;

typedef struct {
    uart_t uart;                       
    uint32_t baudrate;                 
    gpio_t pin_reset;                  
} rn2xx3_params_t;

typedef struct {
    netdev_t netdev;                   
    /* device driver specific fields */
    rn2xx3_params_t p;                 
    loramac_settings_t loramac;        
 
    /* values for the UART TX state machine  */
    char cmd_buf[RN2XX3_MAX_BUF];      
    mutex_t cmd_lock;                  
    uint8_t int_state;                 
 
    /* buffer and synchronization for command responses */
    mutex_t resp_lock;                 
    char resp_buf[RN2XX3_MAX_BUF];     
    uint16_t resp_size;                
    uint8_t resp_done;                 
 
    /* buffer for RX messages */
    char rx_tmp_buf[2];                
    uint8_t rx_buf[RN2XX3_RX_MAX_BUF]; 
    uint16_t rx_size;                  
 
    /* timers */
    ztimer_t sleep_timer;              
    uint32_t sleep;                    
} rn2xx3_t;

void rn2xx3_setup(rn2xx3_t *dev, const rn2xx3_params_t *params);

int rn2xx3_init(rn2xx3_t *dev);

int rn2xx3_sys_reset(rn2xx3_t *dev);

int rn2xx3_sys_factory_reset(rn2xx3_t *dev);

 int rn2xx3_sys_sleep(rn2xx3_t *dev);

int rn2xx3_mac_init(rn2xx3_t *dev);

int rn2xx3_write_cmd(rn2xx3_t *dev);

int rn2xx3_write_cmd_no_wait(rn2xx3_t *dev);

int rn2xx3_wait_response(rn2xx3_t *dev);

int rn2xx3_wait_reply(rn2xx3_t *dev, uint8_t timeout);

int rn2xx3_mac_tx(rn2xx3_t *dev, uint8_t *payload, uint8_t payload_len);

int rn2xx3_mac_join_network(rn2xx3_t *dev, loramac_join_mode_t mode);

int rn2xx3_mac_save(rn2xx3_t *dev);
 
/* Get/Set functions definitions */

void rn2xx3_mac_get_deveui(rn2xx3_t *dev, uint8_t *eui);

void rn2xx3_mac_set_deveui(rn2xx3_t *dev, const uint8_t *eui);

void rn2xx3_mac_get_appeui(rn2xx3_t *dev, uint8_t *eui);

void rn2xx3_mac_set_appeui(rn2xx3_t *dev, const uint8_t *eui);

void rn2xx3_mac_set_appkey(rn2xx3_t *dev, const uint8_t *key);

void rn2xx3_mac_set_appskey(rn2xx3_t *dev, const uint8_t *key);

void rn2xx3_mac_set_nwkskey(rn2xx3_t *dev, const uint8_t *key);

void rn2xx3_mac_get_devaddr(rn2xx3_t *dev, uint8_t *addr);

void rn2xx3_mac_set_devaddr(rn2xx3_t *dev, const uint8_t *addr);

loramac_tx_pwr_idx_t rn2xx3_mac_get_tx_power(rn2xx3_t *dev);

void rn2xx3_mac_set_tx_power(rn2xx3_t *dev, loramac_tx_pwr_idx_t power);

loramac_dr_idx_t rn2xx3_mac_get_dr(rn2xx3_t *dev);

void rn2xx3_mac_set_dr(rn2xx3_t *dev, loramac_dr_idx_t dr);

 uint16_t rn2xx3_mac_get_band(rn2xx3_t *dev);

bool rn2xx3_mac_get_adr(rn2xx3_t *dev);

void rn2xx3_mac_set_adr(rn2xx3_t *dev, bool adr);

void rn2xx3_mac_set_battery(rn2xx3_t *dev, uint8_t battery);

uint8_t rn2xx3_mac_get_retx(rn2xx3_t *dev);

void rn2xx3_mac_set_retx(rn2xx3_t *dev, uint8_t retx);

void rn2xx3_mac_set_linkchk_interval(rn2xx3_t *dev, uint16_t linkchk);

uint16_t rn2xx3_mac_get_rx1_delay(rn2xx3_t *dev);

void rn2xx3_mac_set_rx1_delay(rn2xx3_t *dev, uint16_t rx1);

uint16_t rn2xx3_mac_get_rx2_delay(rn2xx3_t *dev);

bool rn2xx3_mac_get_ar(rn2xx3_t *dev);

void rn2xx3_mac_set_ar(rn2xx3_t *dev, bool ar);

loramac_dr_idx_t rn2xx3_mac_get_rx2_dr(rn2xx3_t *dev);

void rn2xx3_mac_set_rx2_dr(rn2xx3_t *dev, loramac_dr_idx_t dr);

uint32_t rn2xx3_mac_get_rx2_freq(rn2xx3_t *dev);

void rn2xx3_mac_set_rx2_freq(rn2xx3_t *dev, uint32_t freq);

uint8_t rn2xx3_mac_get_tx_port(rn2xx3_t *dev);

void rn2xx3_mac_set_tx_port(rn2xx3_t *dev, uint8_t port);

loramac_tx_mode_t rn2xx3_mac_get_tx_mode(rn2xx3_t *dev);

void rn2xx3_mac_set_tx_mode(rn2xx3_t *dev, loramac_tx_mode_t mode);

uint8_t rn2xx3_mac_get_rx_port(rn2xx3_t *dev);

void rn2xx3_sys_set_sleep_duration(rn2xx3_t *dev, uint32_t sleep);
 
#ifdef __cplusplus
}
#endif