Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
netopt.h File Reference
Networking » Netopt - Configuration options for network APIs

Definition of global configuration options. More...

Detailed Description

Definition of global configuration options.

Author
Hauke Petersen hauke.nosp@m..pet.nosp@m.ersen.nosp@m.@fu-.nosp@m.berli.nosp@m.n.de
Oliver Hahm olive.nosp@m.r.ha.nosp@m.hm@in.nosp@m.ria..nosp@m.fr
Kaspar Schleiser kaspa.nosp@m.r@sc.nosp@m.hleis.nosp@m.er.d.nosp@m.e

Definition in file netopt.h.

#include <stdint.h>
#include <stdbool.h>
+ Include dependency graph for netopt.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  netopt_scan_result
 Basic network scan result. More...
 
struct  netopt_scan_request
 Basic network scan request. More...
 
struct  netopt_connect_result
 Basic network connect result. More...
 
struct  netopt_disconnect_result
 Basic disconnect result. More...
 
struct  netopt_connect_request
 Basic network connect request. More...
 
struct  netopt_disconnect_request
 Basic network disconnect request. More...
 

Macros

#define NETOPT_SCAN_REQ_ALL_CH   ((netopt_channel_t)(-1))
 Request to scan all channels.
 
#define NETOPT_SCAN_RESULT_INITIALIZER(ch, str)
 Static initializer for a netopt_scan_result_t.
 
#define NETOPT_SCAN_REQUEST_INITIALIZER(ch, cb)
 Static initializer for a netopt_scan_request_t.
 
#define NETOPT_CONNECT_RESULT_INITIALIZER(ch)
 Static initializer for a netopt_connect_result_t.
 
#define NETOPT_DISCONNECT_RESULT_INITIALIZER(ch)
 Static initializer for a netopt_disconnect_result_t.
 
#define NETOPT_CONNECT_REQUEST_INITIALIZER(ch, ccb, dcb)
 Static initializer for a netopt_connect_request_t.
 
#define NETOPT_DISCONNECT_REQUEST_INITIALIZER(dcb)
 Static initializer for a netopt_disconnect_request_t.
 

Typedefs

typedef uint16_t netopt_channel_t
 Netopt RF channel type.
 
typedef int16_t netopt_rssi_t
 Netopt RSSI type.
 
typedef struct netopt_scan_result netopt_scan_result_t
 Basic network scan result.
 
typedef void(* netopt_on_scan_result_t) (void *netif, const struct l2scan_list *res)
 Basic callback type on network scan NETOPT_CONNECT.
 
typedef struct netopt_scan_request netopt_scan_request_t
 Basic network scan request.
 
typedef struct netopt_connect_result netopt_connect_result_t
 Basic network connect result.
 
typedef struct netopt_disconnect_result netopt_disconnect_result_t
 Basic disconnect result.
 
typedef void(* netopt_on_connect_result_t) (void *netif, const struct netopt_connect_result *res)
 Basic callback type on network connection NETOPT_CONNECT.
 
typedef void(* netopt_on_disconnect_result_t) (void *netif, const struct netopt_disconnect_result *res)
 Basic callback type on network disconnection NETOPT_CONNECT.
 
typedef struct netopt_connect_request netopt_connect_request_t
 Basic network connect request.
 
typedef struct netopt_disconnect_request netopt_disconnect_request_t
 Basic network disconnect request.
 

Enumerations

enum  netopt_t {
  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_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 , 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
}
 Global list of configuration options available throughout the network stack, e.g. More...
 
enum  netopt_enable_t { NETOPT_DISABLE = 0 , NETOPT_ENABLE = 1 }
 Binary parameter for enabling and disabling options. More...
 
enum  netopt_state_t {
  NETOPT_STATE_OFF = 0 , NETOPT_STATE_SLEEP , NETOPT_STATE_IDLE , NETOPT_STATE_RX ,
  NETOPT_STATE_TX , NETOPT_STATE_RESET , NETOPT_STATE_STANDBY
}
 Option parameter to be used with NETOPT_STATE to set or get the state of a network device or protocol implementation. More...
 
enum  netopt_rf_testmode_t { NETOPT_RF_TESTMODE_IDLE = 0 , NETOPT_RF_TESTMODE_CRX , NETOPT_RF_TESTMODE_CTX_CW , NETOPT_RF_TESTMODE_CTX_PRBS9 }
 Option parameter to be used with NETOPT_RF_TESTMODE. More...
 

Functions

const char * netopt2str (netopt_t opt)
 Get a string ptr corresponding to opt, for debugging.