netopt.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-FileCopyrightText: 2015 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NETOPT_CHANNEL,
    NETOPT_IS_CHANNEL_CLR,
    NETOPT_ADDRESS,

    NETOPT_ADDRESS_LONG,
    NETOPT_ADDR_LEN,
    NETOPT_SRC_LEN,
    NETOPT_NID,

    NETOPT_HOP_LIMIT,

    NETOPT_IPV6_IID,

    NETOPT_IPV6_ADDR,
    NETOPT_IPV6_ADDR_REMOVE,
    NETOPT_IPV6_ADDR_FLAGS,
    NETOPT_IPV6_GROUP,
    NETOPT_IPV6_GROUP_LEAVE,
    NETOPT_IPV6_FORWARDING,
    NETOPT_IPV6_SND_RTR_ADV,
    NETOPT_TX_POWER,
    NETOPT_MAX_PDU_SIZE,
    NETOPT_PDU_SIZE,
    NETOPT_PRELOADING,
    NETOPT_PROMISCUOUSMODE,
    NETOPT_AUTOACK,
    NETOPT_ACK_PENDING,
    NETOPT_ACK_REQ,
    NETOPT_RETRANS,
    NETOPT_PROTO,
    NETOPT_STATE,
    NETOPT_RAWMODE,
    NETOPT_RX_START_IRQ,

    NETOPT_TX_START_IRQ,

    NETOPT_TX_END_IRQ,

    NETOPT_AUTOCCA,

    NETOPT_LINK,

    NETOPT_ACTIVE,

    NETOPT_CSMA,

    NETOPT_CSMA_RETRIES,

    NETOPT_CSMA_MAXBE,

    NETOPT_CSMA_MINBE,

    NETOPT_MAC_NO_SLEEP,

    NETOPT_IS_WIRED,

    NETOPT_DEVICE_TYPE,

    NETOPT_CHANNEL_PAGE,

    NETOPT_CCA_THRESHOLD,

    NETOPT_CCA_MODE,

    NETOPT_STATS,

    NETOPT_ENCRYPTION,

    NETOPT_ENCRYPTION_KEY,

    NETOPT_RF_TESTMODE,

    NETOPT_L2FILTER,

    NETOPT_L2FILTER_RM,

    NETOPT_LAST_ED_LEVEL,

    NETOPT_PREAMBLE_LENGTH,

    NETOPT_INTEGRITY_CHECK,

    NETOPT_CHANNEL_FREQUENCY,

    NETOPT_CHANNEL_HOP,

    NETOPT_CHANNEL_HOP_PERIOD,

    NETOPT_SINGLE_RECEIVE,

    NETOPT_RX_TIMEOUT,

    NETOPT_TX_TIMEOUT,

    NETOPT_BANDWIDTH,

    NETOPT_SPREADING_FACTOR,

    NETOPT_CODING_RATE,

    NETOPT_FIXED_HEADER,

    NETOPT_IQ_INVERT,

    NETOPT_6LO,

    NETOPT_6LO_IPHC,

    NETOPT_6LO_ABR,

    NETOPT_TX_RETRIES_NEEDED,

    NETOPT_BLE_CTX,

    NETOPT_CHECKSUM,

    NETOPT_PHY_BUSY,

    NETOPT_LORAWAN_APPEUI,

    NETOPT_LORAWAN_JOINEUI,

    NETOPT_LORAWAN_APPKEY,

    NETOPT_LORAWAN_NWKKEY,

    NETOPT_LORAWAN_NWKSKEY,

    NETOPT_LORAWAN_APPSKEY,

    NETOPT_LORAWAN_FNWKSINTKEY,

    NETOPT_LORAWAN_SNWKSINTKEY,

    NETOPT_LORAWAN_NWKSENCKEY,

    NETOPT_LORAWAN_DEVICE_CLASS,

    NETOPT_LORAWAN_DR,

    NETOPT_LORAWAN_ADR,

    NETOPT_LORAWAN_PUBLIC_NETWORK,

    NETOPT_LORAWAN_RX2_DR,

    NETOPT_LORAWAN_RX2_FREQ,

    NETOPT_LORAWAN_MAX_RX_ERROR,

    NETOPT_LORAWAN_MIN_RX_SYMBOL,

    NETOPT_IEEE802154_PHY,

    NETOPT_OQPSK_RATE,

    NETOPT_MR_OQPSK_CHIPS,

    NETOPT_MR_OQPSK_RATE,

    NETOPT_MR_OFDM_OPTION,

    NETOPT_MR_OFDM_MCS,

    NETOPT_MR_FSK_MODULATION_INDEX,

    NETOPT_MR_FSK_MODULATION_ORDER,

    NETOPT_MR_FSK_SRATE,

    NETOPT_MR_FSK_FEC,

    NETOPT_CHANNEL_SPACING,

    NETOPT_SYNCWORD,

    NETOPT_RANDOM,

    NETOPT_RX_SYMBOL_TIMEOUT,
 
    /* add more options if needed */

    NETOPT_OTAA,

    NETOPT_DEMOD_MARGIN,

    NETOPT_NUM_GATEWAYS,

    NETOPT_LINK_CHECK,

    NETOPT_RSSI,

    NETOPT_SCAN,

    NETOPT_CONNECT,

    NETOPT_DISCONNECT,

    NETOPT_BATMON,

    NETOPT_L2_GROUP,
    NETOPT_L2_GROUP_LEAVE,

    NETOPT_PAN_COORD,

    NETOPT_GTS_ALLOC,

    NETOPT_GTS_TX,

    NETOPT_NUMOF,
} netopt_t;

typedef enum {
    NETOPT_DISABLE = 0,         
    NETOPT_ENABLE = 1,          
} netopt_enable_t;

typedef enum {
    NETOPT_STATE_OFF = 0,       
    NETOPT_STATE_SLEEP,         
    NETOPT_STATE_IDLE,          
    NETOPT_STATE_RX,            
    NETOPT_STATE_TX,            
    NETOPT_STATE_RESET,         
    NETOPT_STATE_STANDBY,       
    /* add other states if needed */
} netopt_state_t;

typedef enum {
    NETOPT_RF_TESTMODE_IDLE = 0,    
    NETOPT_RF_TESTMODE_CRX,         
    NETOPT_RF_TESTMODE_CTX_CW,      
    NETOPT_RF_TESTMODE_CTX_PRBS9,   
} netopt_rf_testmode_t;

typedef uint16_t netopt_channel_t;

typedef int16_t netopt_rssi_t;

#define NETOPT_SCAN_REQ_ALL_CH      ((netopt_channel_t)(-1))

typedef struct netopt_scan_result {
    netopt_channel_t channel;       
    netopt_rssi_t strength;         
} netopt_scan_result_t;

#define NETOPT_SCAN_RESULT_INITIALIZER(ch, str)         \
    (netopt_scan_result_t) {                            \
        .channel = ch,                                  \
        .strength = str,                                \
    }

struct l2scan_list;

typedef void (*netopt_on_scan_result_t) (void *netif, const struct l2scan_list *res);

typedef struct netopt_scan_request {
    netopt_on_scan_result_t scan_cb;    
    netopt_channel_t channel;           
} netopt_scan_request_t;

#define NETOPT_SCAN_REQUEST_INITIALIZER(ch, cb)         \
    (netopt_scan_request_t) {                           \
        .channel = ch,                                  \
        .scan_cb = (netopt_on_scan_result_t)cb,         \
    }

typedef struct netopt_connect_result {
    netopt_channel_t channel;           
} netopt_connect_result_t;

#define NETOPT_CONNECT_RESULT_INITIALIZER(ch)               \
    (netopt_connect_result_t) {                             \
        .channel = ch,                                      \
    }

typedef struct netopt_disconnect_result {
    netopt_channel_t channel;           
} netopt_disconnect_result_t;

#define NETOPT_DISCONNECT_RESULT_INITIALIZER(ch)        \
    (netopt_disconnect_result_t) {                      \
        .channel = ch,                                  \
    }

typedef void (*netopt_on_connect_result_t) (void *netif, const struct netopt_connect_result *res);

typedef void (*netopt_on_disconnect_result_t) (void *netif, const struct netopt_disconnect_result *res);

typedef struct netopt_connect_request {
    netopt_on_disconnect_result_t disconn_cb;   
    netopt_on_connect_result_t conn_cb;         
    netopt_channel_t channel;                   
} netopt_connect_request_t;

#define NETOPT_CONNECT_REQUEST_INITIALIZER(ch, ccb, dcb)    \
    (netopt_connect_request_t) {                            \
        .disconn_cb = (netopt_on_disconnect_result_t)dcb,   \
        .conn_cb = (netopt_on_connect_result_t)ccb,         \
        .channel = ch,                                      \
    }

typedef struct netopt_disconnect_request {
    netopt_on_disconnect_result_t disconn_cb;   
} netopt_disconnect_request_t;

#define NETOPT_DISCONNECT_REQUEST_INITIALIZER(dcb)          \
    (netopt_disconnect_request_t) {                         \
        .disconn_cb = (netopt_on_disconnect_result_t)dcb,   \
    }

const char *netopt2str(netopt_t opt);
 
#ifdef __cplusplus
}
#endif