netopt.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Freie Universit├Ąt Berlin
3  * 2015 Kaspar Schleiser <kaspar@schleiser.de>
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
25 #ifndef NET_NETOPT_H
26 #define NET_NETOPT_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
42 typedef enum {
67 
94 
99 
118 
252 
264 
277 
287 
301 
310 
319 
330 
339 
348 
358 
367 
374 
379 
396 
404 
413 
418 
425 
443 
453 
463 
472 
477 
482 
491 
496 
501 
508 
515 
522 
527 
532 
537 
542 
547 
554 
561 
570 
577 
584 
592 
597 
602 
611 
617 
623 
628 
633 
653 
659 
664 
669 
674 
679 
686 
691 
696 
701 
706 
711 
716 
721 
726 
731 
736 
743 
748 
749  /* add more options if needed */
750 
755 
760 
765 
773 
784 
794 
816 } netopt_t;
817 
821 typedef enum {
825 
830 typedef enum {
847  /* add other states if needed */
849 
853 typedef enum {
859 
867 const char *netopt2str(netopt_t opt);
868 
869 #ifdef __cplusplus
870 }
871 #endif
872 
873 #endif /* NET_NETOPT_H */
netopt_enable_t
Binary parameter for enabling and disabling options.
Definition: netopt.h:821
netopt_t
Global list of configuration options available throughout the network stack, e.g.
Definition: netopt.h:42
netopt_rf_testmode_t
Option parameter to be used with NETOPT_RF_TESTMODE.
Definition: netopt.h:853
netopt_state_t
Option parameter to be used with NETOPT_STATE to set or get the state of a network device or protocol...
Definition: netopt.h:830
const char * netopt2str(netopt_t opt)
Get a string ptr corresponding to opt, for debugging.
@ NETOPT_DISABLE
disable a given option
Definition: netopt.h:822
@ NETOPT_ENABLE
enable a given option
Definition: netopt.h:823
@ NETOPT_LORAWAN_ADR
(netopt_enable_t) LoRaWAN adaptive datarate
Definition: netopt.h:627
@ NETOPT_L2_GROUP
(array of byte array) get link layer multicast groups as array of byte arrays (length of each byte ar...
Definition: netopt.h:805
@ NETOPT_CHANNEL_HOP_PERIOD
(uint8_t) channel hopping period
Definition: netopt.h:500
@ NETOPT_RETRANS
(uint8_t) maximum number of retransmissions
Definition: netopt.h:230
@ NETOPT_CSMA_RETRIES
(uint8_t) maximum number of CSMA retries
Definition: netopt.h:329
@ NETOPT_L2FILTER
(l2filter_t) add an address to a link layer filter list
Definition: netopt.h:452
@ NETOPT_MR_OFDM_MCS
(uint8_t) MR-OFDM PHY Modulation and Coding Scheme (Values: 0-6)
Definition: netopt.h:705
@ NETOPT_BATMON
(uint16_t) Set the battery monitor voltage (in mV).
Definition: netopt.h:793
@ NETOPT_OQPSK_RATE
(uint8_t) legacy O-QPSK proprietary mode Allows to select higher data rates than standard 250 kbit/s ...
Definition: netopt.h:685
@ NETOPT_LORAWAN_APPSKEY
(uint8_t*) LoRaWAN application session key (16 bytes length)
Definition: netopt.h:610
@ NETOPT_IPV6_GROUP
(ipv6_addr_t) get IPv6 multicast groups of an interface as array of ipv6_addr_t or join an IPv6 multi...
Definition: netopt.h:161
@ NETOPT_IEEE802154_PHY
(uint8_t) 802.15.4 PHY mode
Definition: netopt.h:678
@ NETOPT_ADDRESS
(byte array, see below) link layer address in network byte order
Definition: netopt.h:66
@ NETOPT_DEVICE_TYPE
(uint16_t) device type
Definition: netopt.h:373
@ NETOPT_MR_FSK_SRATE
(uint8_t) MR-FSK PHY Symbol Rate (kHz)
Definition: netopt.h:720
@ NETOPT_CHECKSUM
(netopt_enable_t) enable hardware checksumming
Definition: netopt.h:583
@ NETOPT_CHANNEL_PAGE
(uint16_t) channel page as defined by IEEE 802.15.4
Definition: netopt.h:378
@ NETOPT_MAX_PDU_SIZE
(uint16_t) maximum protocol data unit
Definition: netopt.h:181
@ NETOPT_OTAA
(netopt_enable_t) Enable or disable OTAA activation (LoRaWAN)
Definition: netopt.h:754
@ NETOPT_6LO
(netopt_enable_t) 6Lo support
Definition: netopt.h:553
@ NETOPT_NUM_GATEWAYS
(uint8_t) Get the number of gateways of the last Link Check request.
Definition: netopt.h:764
@ NETOPT_CHANNEL_HOP
(netopt_enable_t) channel hopping
Definition: netopt.h:495
@ NETOPT_RAWMODE
(netopt_enable_t) when enabled, bypass protocol processing of incoming frames
Definition: netopt.h:242
@ NETOPT_PROTO
(gnrc_nettype_t) the protocol for the layer
Definition: netopt.h:234
@ NETOPT_LORAWAN_PUBLIC_NETWORK
(netopt_enable_t) LoRaWAN public network
Definition: netopt.h:632
@ NETOPT_LINK_CHECK
(netopt_enable_t) Perform a Link Check request (LoRaWAN)
Definition: netopt.h:772
@ NETOPT_AUTOCCA
(netopt_enable_t) perform channel clear assessment before transmitting
Definition: netopt.h:300
@ NETOPT_ADDRESS_LONG
(byte array, see below) long link layer address in network byte order
Definition: netopt.h:78
@ NETOPT_ADDR_LEN
(uint16_t) get the default address length a network device expects
Definition: netopt.h:82
@ NETOPT_RSSI
(int16_t) Received Signal Strength Indicator (RSSI)
Definition: netopt.h:783
@ NETOPT_CSMA_MAXBE
(uint8_t) maximum backoff exponent for the CSMA-CA algorithm
Definition: netopt.h:338
@ NETOPT_IPV6_GROUP_LEAVE
(ipv6_addr_t) Leave an IPv6 multicast group on an interface
Definition: netopt.h:165
@ NETOPT_DEMOD_MARGIN
(uint8_t) Get the demodulation margin of the last Link Check request.
Definition: netopt.h:759
@ NETOPT_INTEGRITY_CHECK
(netopt_enable_t) frame integrity check (e.g CRC)
Definition: netopt.h:481
@ NETOPT_LORAWAN_RX2_FREQ
(uint32_t) LoRaWAN frequency used for second RX window
Definition: netopt.h:663
@ NETOPT_MR_OQPSK_RATE
(uint8_t) MR-O-QPSK Rate Mode
Definition: netopt.h:695
@ NETOPT_MR_OFDM_OPTION
(uint8_t) MR-OFDM PHY Option (Values: 1-4)
Definition: netopt.h:700
@ NETOPT_NID
(uint16_t) network ID
Definition: netopt.h:93
@ NETOPT_CSMA
(netopt_enable_t) CSMA/CA support
Definition: netopt.h:318
@ NETOPT_MR_FSK_MODULATION_INDEX
(uint8_t) MR-FSK PHY Modulation Index (x 64)
Definition: netopt.h:710
@ NETOPT_IQ_INVERT
(netopt_enable_t) IQ inverted
Definition: netopt.h:546
@ NETOPT_L2FILTER_RM
(l2filter_t) remove an address from a link layer filter list
Definition: netopt.h:462
@ NETOPT_LORAWAN_MIN_RX_SYMBOL
(uint8_t) LoRaWAN maximum system overall timing error (symbols)
Definition: netopt.h:673
@ NETOPT_IS_WIRED
(netopt_enable_t) read-only check for a wired interface.
Definition: netopt.h:366
@ NETOPT_RF_TESTMODE
(netopt_rf_testmode_t) Test mode for the radio, e.g.
Definition: netopt.h:442
@ NETOPT_CODING_RATE
(uint8_t) radio coding rate
Definition: netopt.h:536
@ NETOPT_MR_FSK_FEC
(uint8_t) MR-FSK PHY Forward Error Correction
Definition: netopt.h:725
@ NETOPT_PROMISCUOUSMODE
(netopt_enable_t) promiscuous mode
Definition: netopt.h:208
@ NETOPT_LORAWAN_APPEUI
(uint8_t*) LoRaWAN application EUI (8 bytes length)
Definition: netopt.h:596
@ NETOPT_LAST_ED_LEVEL
(int8_t) Energy level during the last performed CCA or RX frame
Definition: netopt.h:471
@ NETOPT_LINK
(netopt_enable_t) network interface link status.
Definition: netopt.h:309
@ NETOPT_IPV6_IID
(eui64_t) get the IPv6 interface identifier of a network interface
Definition: netopt.h:117
@ NETOPT_TX_START_IRQ
(netopt_enable_t) Used to check if the driver generates NETDEV_EVENT_TX_STARTED events
Definition: netopt.h:276
@ NETOPT_BANDWIDTH
(uint8_t) radio modulation bandwidth
Definition: netopt.h:526
@ NETOPT_IPV6_FORWARDING
(netopt_enable_t) IPv6 forwarding state
Definition: netopt.h:169
@ NETOPT_STATS
(netstats_t*) get statistics about sent and received packets and data of the device or protocol
Definition: netopt.h:412
@ NETOPT_PDU_SIZE
(uint16_t) protocol data unit size
Definition: netopt.h:197
@ NETOPT_TX_RETRIES_NEEDED
(uint8_t) retry amount from missing ACKs of the last transmission
Definition: netopt.h:569
@ NETOPT_CSMA_MINBE
(uint8_t) minimum backoff exponent for the CSMA-CA algorithm
Definition: netopt.h:347
@ NETOPT_CCA_MODE
(uint8_t) CCA mode for the radio transceiver
Definition: netopt.h:403
@ NETOPT_TX_POWER
(int16_t) transmit power for radio devices in dBm
Definition: netopt.h:177
@ NETOPT_STATE
(netopt_state_t) state of network device
Definition: netopt.h:238
@ NETOPT_SRC_LEN
(uint16_t) address length to use for the link layer source address
Definition: netopt.h:86
@ NETOPT_IPV6_ADDR
(ipv6_addr_t[]) get IPv6 addresses of an interface as array of ipv6_addr_t or add an IPv6 address as ...
Definition: netopt.h:133
@ NETOPT_CCA_THRESHOLD
(int8_t) CCA threshold for the radio transceiver
Definition: netopt.h:395
@ NETOPT_ENCRYPTION
(netopt_enable_t) link layer encryption.
Definition: netopt.h:417
@ NETOPT_MAC_NO_SLEEP
(netopt_enable_t) block transceiver sleep
Definition: netopt.h:357
@ NETOPT_ACK_REQ
(netopt_enable_t) acknowledgement request on outgoing frames
Definition: netopt.h:226
@ NETOPT_ENCRYPTION_KEY
(byte array) set encryption key
Definition: netopt.h:424
@ NETOPT_RX_SYMBOL_TIMEOUT
(uint16_t) Get or set the number of PHY symbols before assuming there's no data
Definition: netopt.h:747
@ NETOPT_SINGLE_RECEIVE
(netopt_enable_t) single frame reception
Definition: netopt.h:507
@ NETOPT_PRELOADING
(netopt_enable_t) frame preloading
Definition: netopt.h:204
@ NETOPT_LORAWAN_TX_PORT
(uint8_t) LoRaWAN TX application port
Definition: netopt.h:652
@ NETOPT_AUTOACK
(netopt_enable_t) automatic link layer ACKs
Definition: netopt.h:212
@ NETOPT_LORAWAN_DEVICE_CLASS
(uint8_t) LoRaWAN device class (A, B, C)
Definition: netopt.h:616
@ NETOPT_RX_END_IRQ
(netopt_enable_t) Used to check if the driver generates NETDEV_EVENT_RX_COMPLETE events
Definition: netopt.h:263
@ NETOPT_NUMOF
maximum number of options defined here.
Definition: netopt.h:815
@ NETOPT_ACK_PENDING
(netopt_enable_t) frame pending bit of ACKs
Definition: netopt.h:219
@ NETOPT_RX_TIMEOUT
(uint32_t) reception timeout of a frame
Definition: netopt.h:514
@ NETOPT_FIXED_HEADER
(netopt_enable_t) fixed header mode
Definition: netopt.h:541
@ NETOPT_MR_OQPSK_CHIPS
(uint8_t) MR-O-QPSK Chip Rate (kchip/s)
Definition: netopt.h:690
@ NETOPT_PHY_BUSY
(netopt_enable_t) enable busy mode
Definition: netopt.h:591
@ NETOPT_LORAWAN_MAX_RX_ERROR
(uint32_t) LoRaWAN maximum system overall timing error (ms)
Definition: netopt.h:668
@ NETOPT_TX_END_IRQ
(netopt_enable_t) Used to check if the driver generates NETDEV_EVENT_TX_COMPLETE events
Definition: netopt.h:286
@ NETOPT_SPREADING_FACTOR
(uint8_t) radio spreading factor
Definition: netopt.h:531
@ NETOPT_L2_GROUP_LEAVE
(array of byte arrays) Leave an link layer multicast group
Definition: netopt.h:809
@ NETOPT_CHANNEL
(uint16_t) channel number
Definition: netopt.h:46
@ NETOPT_LORAWAN_RX2_DR
(loramac_dr_idx_t) LoRaWAN datarate for second RX window
Definition: netopt.h:658
@ NETOPT_6LO_IPHC
(netopt_enable_t) header compression
Definition: netopt.h:560
@ NETOPT_MR_FSK_MODULATION_ORDER
(uint8_t) MR-FSK Modulation Order
Definition: netopt.h:715
@ NETOPT_PREAMBLE_LENGTH
(uint16_t) preamble length
Definition: netopt.h:476
@ NETOPT_IS_CHANNEL_CLR
(netopt_enable_t) check whether the network medium is clear
Definition: netopt.h:53
@ NETOPT_TX_TIMEOUT
(uint32_t) transmission timeout of a frame
Definition: netopt.h:521
@ NETOPT_RX_START_IRQ
(netopt_enable_t) Used to check if the driver generates NETDEV_EVENT_RX_STARTED events
Definition: netopt.h:251
@ NETOPT_IPV6_ADDR_REMOVE
(ipv6_addr_t) Removes an IPv6 address from an interface
Definition: netopt.h:137
@ NETOPT_SYNCWORD
(uint8_t*) phy layer syncword
Definition: netopt.h:735
@ NETOPT_LORAWAN_APPKEY
(uint8_t*) LoRaWAN application key (16 bytes length)
Definition: netopt.h:601
@ NETOPT_IPV6_SND_RTR_ADV
(netopt_enable_t) sending of IPv6 router advertisements
Definition: netopt.h:173
@ NETOPT_CHANNEL_SPACING
(uint8_t) PHY Channel Spacing (kHz)
Definition: netopt.h:730
@ NETOPT_CHANNEL_FREQUENCY
(uint32_t) channel center frequency
Definition: netopt.h:490
@ NETOPT_IPV6_ADDR_FLAGS
(array of uint8_t) get the flags to the addresses returned by NETOPT_IPV6_ADDR as array
Definition: netopt.h:146
@ NETOPT_RANDOM
(uint32_t) Get a random value from the device
Definition: netopt.h:742
@ NETOPT_LORAWAN_DR
(uint8_t) LoRaWAN datarate
Definition: netopt.h:622
@ NETOPT_BLE_CTX
(netdev_ble_ctx_t) set BLE radio context (channel, CRC, AA)
Definition: netopt.h:576
@ NETOPT_HOP_LIMIT
(uint8_t) hop limit
Definition: netopt.h:98
@ NETOPT_LORAWAN_NWKSKEY
(uint8_t*) LoRaWAN network session key (16 bytes length)
Definition: netopt.h:606
@ NETOPT_RF_TESTMODE_CTX_PRBS9
PRBS9 continuous tx mode.
Definition: netopt.h:857
@ NETOPT_RF_TESTMODE_IDLE
idle mode, radio off
Definition: netopt.h:854
@ NETOPT_RF_TESTMODE_CTX_CW
carrier wave continuous tx mode
Definition: netopt.h:856
@ NETOPT_RF_TESTMODE_CRX
continuous rx mode
Definition: netopt.h:855
@ NETOPT_STATE_IDLE
idle mode, the device listens to receive packets
Definition: netopt.h:833
@ NETOPT_STATE_OFF
powered off
Definition: netopt.h:831
@ NETOPT_STATE_RX
receive mode, the device currently receives a packet
Definition: netopt.h:835
@ NETOPT_STATE_STANDBY
standby mode.
Definition: netopt.h:845
@ NETOPT_STATE_TX
transmit mode, set: triggers transmission of a preloaded packet (see NETOPT_PRELOADING*).
Definition: netopt.h:837
@ NETOPT_STATE_RESET
triggers a hardware reset.
Definition: netopt.h:843
@ NETOPT_STATE_SLEEP
sleep mode
Definition: netopt.h:832