Loading...
Searching...
No Matches
Variables
dsme_settings.h File Reference
Packages | Networking » openDSME - IEEE 802.15.4 DSME

Detailed Description

Author
José I. Álamos jose..nosp@m.alam.nosp@m.os@ha.nosp@m.w-ha.nosp@m.mburg.nosp@m..de

Definition in file dsme_settings.h.

#include <stdint.h>
#include <stdio.h>
#include "kernel_defines.h"
#include "net/ieee802154.h"
#include "opendsme.h"
+ Include dependency graph for dsme_settings.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Variables

constexpr uint8_t dsme::const_redefines::aNumSuperframeSlots = 16
 fixed value, see Table 8-80 of IEEE 802.15.4-2015, this includes beacon, CAP and GTS
 
constexpr uint8_t dsme::const_redefines::macSIFSPeriod = 12
 fixed value, see 8.1.3 of IEEE 802.15.4-2011 (assuming no UWB PHY)
 
constexpr uint8_t dsme::const_redefines::macLIFSPeriod = 40
 fixed value, see 8.1.3 of IEEE 802.15.4-2011 (assuming no UWB PHY)
 
constexpr uint8_t dsme::PRE_EVENT_SHIFT = const_redefines::macLIFSPeriod
 guard time before a DSME event
 
constexpr uint8_t dsme::MIN_CSMA_SLOTS = 0
 Minimum number of CSMA slots.
 
constexpr uint8_t dsme::MAX_GTSLOTS = const_redefines::aNumSuperframeSlots - MIN_CSMA_SLOTS - 1
 maximum number of GTS slots
 
constexpr uint8_t dsme::MAX_CHANNELS = 16
 maximum number of IEEE 802.15.4 channels
 
constexpr uint8_t dsme::MIN_CHANNEL = 11
 minimum number of IEEE 802.15.4 channels
 
constexpr uint8_t dsme::MAC_DEFAULT_CHANNEL = CONFIG_IEEE802154_DEFAULT_CHANNEL
 default MAC channel
 
constexpr uint8_t dsme::MAX_NEIGHBORS = CONFIG_OPENDSME_MAX_NEIGHBOURS
 maximum number of neighbors
 
constexpr uint16_t dsme::MAC_DEFAULT_NWK_ID = CONFIG_IEEE802154_DEFAULT_PANID
 default PAN ID
 
constexpr uint8_t dsme::MIN_SO = CONFIG_IEEE802154_DSME_SUPERFRAME_ORDER
 Minimum superframe order.
 
constexpr uint8_t dsme::MAX_BO = CONFIG_IEEE802154_DSME_BEACON_ORDER
 Maximum beacon order.
 
constexpr uint8_t dsme::MAX_MO = CONFIG_IEEE802154_DSME_MULTISUPERFRAME_ORDER
 Maximum multi-superframe order.
 
constexpr uint16_t dsme::MAX_SLOTS_PER_SUPERFRAMES = 1 << (uint16_t)(MAX_BO - MIN_SO)
 Maximum number of slots per superframe.
 
constexpr uint16_t dsme::MAX_TOTAL_SUPERFRAMES = 1 << (uint16_t)(MAX_BO - MIN_SO)
 Maximum number of superframes per beacon interval.
 
constexpr uint16_t dsme::MAX_SUPERFRAMES_PER_MULTI_SUPERFRAME = 1 << (uint16_t)(MAX_MO - MIN_SO)
 Maximum number of superframes per multi-superframe.
 
constexpr uint16_t dsme::MAX_OCCUPIED_SLOTS = MAX_SUPERFRAMES_PER_MULTI_SUPERFRAME*MAX_GTSLOTS*MAX_CHANNELS
 Maximum number of GTS slots per superframe.
 
constexpr uint8_t dsme::MAX_SAB_UNITS = 1
 Maximum number of SAB units.
 
constexpr uint16_t dsme::CAP_QUEUE_SIZE = CONFIG_OPENDSME_CAP_QUEUE_SIZE
 Size of the CAP queue.
 
constexpr uint16_t dsme::TOTAL_GTS_QUEUE_SIZE = CONFIG_OPENDSME_CFP_QUEUE_SIZE
 Size of the CFP queue.
 
constexpr uint16_t dsme::UPPER_LAYER_QUEUE_SIZE = 4
 Size of the CAP queue.
 
constexpr uint16_t dsme::DSME_BROADCAST_PAN_ID = 0xffff
 Broadcast PAN ID.
 
constexpr uint8_t dsme::ADDITIONAL_ACK_WAIT_DURATION = 63
 Additional time to wait for an ACK.
 
#define DSME_MAX_LOST_BEACONS   CONFIG_OPENDSME_MAX_LOST_BEACONS
 maximum number of lost beacons before leaving the network
 

Macro Definition Documentation

◆ DSME_MAX_LOST_BEACONS

#define DSME_MAX_LOST_BEACONS   CONFIG_OPENDSME_MAX_LOST_BEACONS

maximum number of lost beacons before leaving the network

Definition at line 35 of file dsme_settings.h.

Variable Documentation

◆ ADDITIONAL_ACK_WAIT_DURATION

constexpr uint8_t dsme::ADDITIONAL_ACK_WAIT_DURATION = 63
constexpr

Additional time to wait for an ACK.

Definition at line 158 of file dsme_settings.h.

◆ aNumSuperframeSlots

constexpr uint8_t dsme::const_redefines::aNumSuperframeSlots = 16
constexpr

fixed value, see Table 8-80 of IEEE 802.15.4-2015, this includes beacon, CAP and GTS

Definition at line 43 of file dsme_settings.h.

◆ CAP_QUEUE_SIZE

constexpr uint16_t dsme::CAP_QUEUE_SIZE = CONFIG_OPENDSME_CAP_QUEUE_SIZE
constexpr

Size of the CAP queue.

Definition at line 138 of file dsme_settings.h.

◆ DSME_BROADCAST_PAN_ID

constexpr uint16_t dsme::DSME_BROADCAST_PAN_ID = 0xffff
constexpr

Broadcast PAN ID.

Definition at line 153 of file dsme_settings.h.

◆ MAC_DEFAULT_CHANNEL

constexpr uint8_t dsme::MAC_DEFAULT_CHANNEL = CONFIG_IEEE802154_DEFAULT_CHANNEL
constexpr

default MAC channel

Definition at line 83 of file dsme_settings.h.

◆ MAC_DEFAULT_NWK_ID

constexpr uint16_t dsme::MAC_DEFAULT_NWK_ID = CONFIG_IEEE802154_DEFAULT_PANID
constexpr

default PAN ID

Definition at line 93 of file dsme_settings.h.

◆ macLIFSPeriod

constexpr uint8_t dsme::const_redefines::macLIFSPeriod = 40
constexpr

fixed value, see 8.1.3 of IEEE 802.15.4-2011 (assuming no UWB PHY)

Definition at line 52 of file dsme_settings.h.

◆ macSIFSPeriod

constexpr uint8_t dsme::const_redefines::macSIFSPeriod = 12
constexpr

fixed value, see 8.1.3 of IEEE 802.15.4-2011 (assuming no UWB PHY)

Definition at line 47 of file dsme_settings.h.

◆ MAX_BO

constexpr uint8_t dsme::MAX_BO = CONFIG_IEEE802154_DSME_BEACON_ORDER
constexpr

Maximum beacon order.

Definition at line 103 of file dsme_settings.h.

◆ MAX_CHANNELS

constexpr uint8_t dsme::MAX_CHANNELS = 16
constexpr

maximum number of IEEE 802.15.4 channels

Definition at line 73 of file dsme_settings.h.

◆ MAX_GTSLOTS

constexpr uint8_t dsme::MAX_GTSLOTS = const_redefines::aNumSuperframeSlots - MIN_CSMA_SLOTS - 1
constexpr

maximum number of GTS slots

Definition at line 68 of file dsme_settings.h.

◆ MAX_MO

constexpr uint8_t dsme::MAX_MO = CONFIG_IEEE802154_DSME_MULTISUPERFRAME_ORDER
constexpr

Maximum multi-superframe order.

Definition at line 108 of file dsme_settings.h.

◆ MAX_NEIGHBORS

constexpr uint8_t dsme::MAX_NEIGHBORS = CONFIG_OPENDSME_MAX_NEIGHBOURS
constexpr

maximum number of neighbors

Definition at line 88 of file dsme_settings.h.

◆ MAX_OCCUPIED_SLOTS

constexpr uint16_t dsme::MAX_OCCUPIED_SLOTS = MAX_SUPERFRAMES_PER_MULTI_SUPERFRAME*MAX_GTSLOTS*MAX_CHANNELS
constexpr

Maximum number of GTS slots per superframe.

Definition at line 128 of file dsme_settings.h.

◆ MAX_SAB_UNITS

constexpr uint8_t dsme::MAX_SAB_UNITS = 1
constexpr

Maximum number of SAB units.

Definition at line 133 of file dsme_settings.h.

◆ MAX_SLOTS_PER_SUPERFRAMES

constexpr uint16_t dsme::MAX_SLOTS_PER_SUPERFRAMES = 1 << (uint16_t)(MAX_BO - MIN_SO)
constexpr

Maximum number of slots per superframe.

Definition at line 113 of file dsme_settings.h.

◆ MAX_SUPERFRAMES_PER_MULTI_SUPERFRAME

constexpr uint16_t dsme::MAX_SUPERFRAMES_PER_MULTI_SUPERFRAME = 1 << (uint16_t)(MAX_MO - MIN_SO)
constexpr

Maximum number of superframes per multi-superframe.

Definition at line 123 of file dsme_settings.h.

◆ MAX_TOTAL_SUPERFRAMES

constexpr uint16_t dsme::MAX_TOTAL_SUPERFRAMES = 1 << (uint16_t)(MAX_BO - MIN_SO)
constexpr

Maximum number of superframes per beacon interval.

Definition at line 118 of file dsme_settings.h.

◆ MIN_CHANNEL

constexpr uint8_t dsme::MIN_CHANNEL = 11
constexpr

minimum number of IEEE 802.15.4 channels

Definition at line 78 of file dsme_settings.h.

◆ MIN_CSMA_SLOTS

constexpr uint8_t dsme::MIN_CSMA_SLOTS = 0
constexpr

Minimum number of CSMA slots.

Definition at line 63 of file dsme_settings.h.

◆ MIN_SO

constexpr uint8_t dsme::MIN_SO = CONFIG_IEEE802154_DSME_SUPERFRAME_ORDER
constexpr

Minimum superframe order.

Definition at line 98 of file dsme_settings.h.

◆ PRE_EVENT_SHIFT

constexpr uint8_t dsme::PRE_EVENT_SHIFT = const_redefines::macLIFSPeriod
constexpr

guard time before a DSME event

Definition at line 58 of file dsme_settings.h.

◆ TOTAL_GTS_QUEUE_SIZE

constexpr uint16_t dsme::TOTAL_GTS_QUEUE_SIZE = CONFIG_OPENDSME_CFP_QUEUE_SIZE
constexpr

Size of the CFP queue.

Definition at line 143 of file dsme_settings.h.

◆ UPPER_LAYER_QUEUE_SIZE

constexpr uint16_t dsme::UPPER_LAYER_QUEUE_SIZE = 4
constexpr

Size of the CAP queue.

Definition at line 148 of file dsme_settings.h.