mirror of
https://github.com/espressif/openthread.git
synced 2026-07-30 07:37:46 +00:00
[config] add mesh_forwarder.h config header file (#9164)
This commit adds the `config/mesh_forwarder.h` header file, which defines all of the configurations used by the `MeshForwarder`. These configs were previously included in `misc.h`.
This commit is contained in:
Abtin Keshavarzian
@@ -791,6 +791,7 @@ source_set("libopenthread_core_config") {
|
||||
"config/logging.h",
|
||||
"config/mac.h",
|
||||
"config/mesh_diag.h",
|
||||
"config/mesh_forwarder.h",
|
||||
"config/misc.h",
|
||||
"config/mle.h",
|
||||
"config/nat64.h",
|
||||
|
||||
@@ -516,6 +516,7 @@ HEADERS_COMMON = \
|
||||
config/logging.h \
|
||||
config/mac.h \
|
||||
config/mesh_diag.h \
|
||||
config/mesh_forwarder.h \
|
||||
config/misc.h \
|
||||
config/mle.h \
|
||||
config/nat64.h \
|
||||
|
||||
@@ -0,0 +1,151 @@
|
||||
/*
|
||||
* Copyright (c) 2016-2023, The OpenThread Authors.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in the
|
||||
* documentation and/or other materials provided with the distribution.
|
||||
* 3. Neither the name of the copyright holder nor the
|
||||
* names of its contributors may be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
||||
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
* This file includes compile-time configurations for Mesh Forwarder.
|
||||
*/
|
||||
|
||||
#ifndef CONFIG_MESH_FORWARDER_H_
|
||||
#define CONFIG_MESH_FORWARDER_H_
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE
|
||||
*
|
||||
* Define as 1 for OpenThread to drop a message (and not send any remaining fragments of the message) if all transmit
|
||||
* attempts fail for a fragment of the message. For a direct transmission, a failure occurs after all MAC transmission
|
||||
* attempts for a given fragment are unsuccessful. For an indirect transmission, a failure occurs after all data poll
|
||||
* triggered transmission attempts for a given fragment fail.
|
||||
*
|
||||
* If set to zero (disabled), OpenThread will attempt to send subsequent fragments, whether or not all transmission
|
||||
* attempts fail for a given fragment.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE
|
||||
#define OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE 1
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT
|
||||
*
|
||||
* The reassembly timeout between 6LoWPAN fragments in seconds.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT
|
||||
#define OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT 2
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES
|
||||
*
|
||||
* The number of fragment priority entries.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES
|
||||
#define OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES 8
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE
|
||||
*
|
||||
* Define to 1 to enable delay-aware queue management for the send queue.
|
||||
*
|
||||
* When enabled device will monitor time-in-queue of messages in the direct tx queue and if the wait time is lager than
|
||||
* specified thresholds it may update ECN flag (if message indicates it is ECN-capable) or drop the message.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE \
|
||||
(OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_3)
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL
|
||||
*
|
||||
* Specifies the time-in-queue threshold interval in milliseconds to mark ECN on a message if it is ECN-capable or
|
||||
* drop the message if not ECN-capable.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL 500
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL
|
||||
*
|
||||
* Specifies the time-in-queue threshold interval in milliseconds to drop a message.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL 1000
|
||||
#endif
|
||||
|
||||
/**
|
||||
* OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME
|
||||
*
|
||||
* Specifies the max retain time in seconds of a mesh header fragmentation tag entry in the list.
|
||||
*
|
||||
* The entry in list is used to track whether an earlier fragment of same message was dropped by the router and if so
|
||||
* the next fragments are also dropped. The entry is removed once last fragment is processed or after the retain time
|
||||
* specified by this config parameter expires.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME (4 * 60) // 4 minutes
|
||||
#endif
|
||||
|
||||
/**
|
||||
* OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE
|
||||
*
|
||||
* Specifies the number of mesh header fragmentation tag entries in the list for delay-aware queue management.
|
||||
*
|
||||
* The list is used to track whether an earlier fragment of same message was dropped by the router and if so the next
|
||||
* fragments are also dropped.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE 16
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE
|
||||
*
|
||||
* Specifies the maximum number of frames in direct tx queue before new direct tx messages are dropped.
|
||||
*
|
||||
* If set to zero then the behavior is disabled, i.e., no check is performed on tx queue length.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE
|
||||
#if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_3)
|
||||
#define OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE 100
|
||||
#else
|
||||
#define OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE 0
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#endif // CONFIG_MESH_FORWARDER_H_
|
||||
@@ -212,32 +212,6 @@
|
||||
#define OPENTHREAD_CONFIG_DEFAULT_TRANSMIT_POWER 0
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE
|
||||
*
|
||||
* Define as 1 for OpenThread to drop a message (and not send any remaining fragments of the message) if all transmit
|
||||
* attempts fail for a fragment of the message. For a direct transmission, a failure occurs after all MAC transmission
|
||||
* attempts for a given fragment are unsuccessful. For an indirect transmission, a failure occurs after all data poll
|
||||
* triggered transmission attempts for a given fragment fail.
|
||||
*
|
||||
* If set to zero (disabled), OpenThread will attempt to send subsequent fragments, whether or not all transmission
|
||||
* attempts fail for a given fragment.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE
|
||||
#define OPENTHREAD_CONFIG_DROP_MESSAGE_ON_FRAGMENT_TX_FAILURE 1
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT
|
||||
*
|
||||
* The reassembly timeout between 6LoWPAN fragments in seconds.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT
|
||||
#define OPENTHREAD_CONFIG_6LOWPAN_REASSEMBLY_TIMEOUT 2
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_JOINER_UDP_PORT
|
||||
*
|
||||
@@ -451,94 +425,6 @@
|
||||
#define OPENTHREAD_CONFIG_DEFAULT_SED_DATAGRAM_COUNT 1
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES
|
||||
*
|
||||
* The number of fragment priority entries.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES
|
||||
#define OPENTHREAD_CONFIG_NUM_FRAGMENT_PRIORITY_ENTRIES 8
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE
|
||||
*
|
||||
* Define to 1 to enable delay-aware queue management for the send queue.
|
||||
*
|
||||
* When enabled device will monitor time-in-queue of messages in the direct tx queue and if the wait time is lager than
|
||||
* specified thresholds it may update ECN flag (if message indicates it is ECN-capable) or drop the message.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE \
|
||||
(OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_3)
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL
|
||||
*
|
||||
* Specifies the time-in-queue threshold interval in milliseconds to mark ECN on a message if it is ECN-capable or
|
||||
* drop the message if not ECN-capable.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_MARK_ECN_INTERVAL 500
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL
|
||||
*
|
||||
* Specifies the time-in-queue threshold interval in milliseconds to drop a message.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_DROP_MSG_INTERVAL 1000
|
||||
#endif
|
||||
|
||||
/**
|
||||
* OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME
|
||||
*
|
||||
* Specifies the max retain time in seconds of a mesh header fragmentation tag entry in the list.
|
||||
*
|
||||
* The entry in list is used to track whether an earlier fragment of same message was dropped by the router and if so
|
||||
* the next fragments are also dropped. The entry is removed once last fragment is processed or after the retain time
|
||||
* specified by this config parameter expires.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_RETAIN_TIME (4 * 60) // 4 minutes
|
||||
#endif
|
||||
|
||||
/**
|
||||
* OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE
|
||||
*
|
||||
* Specifies the number of mesh header fragmentation tag entries in the list for delay-aware queue management.
|
||||
*
|
||||
* The list is used to track whether an earlier fragment of same message was dropped by the router and if so the next
|
||||
* fragments are also dropped.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE
|
||||
#define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_FRAG_TAG_ENTRY_LIST_SIZE 16
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE
|
||||
*
|
||||
* Specifies the maximum number of frames in direct tx queue before new direct tx messages are dropped.
|
||||
*
|
||||
* If set to zero then the behavior is disabled, i.e., no check is performed on tx queue length.
|
||||
*
|
||||
*/
|
||||
#ifndef OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE
|
||||
#if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_3)
|
||||
#define OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE 100
|
||||
#else
|
||||
#define OPENTHREAD_CONFIG_MAX_FRAMES_IN_DIRECT_TX_QUEUE 0
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @def OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT
|
||||
*
|
||||
|
||||
@@ -84,6 +84,7 @@
|
||||
#include "config/logging.h"
|
||||
#include "config/mac.h"
|
||||
#include "config/mesh_diag.h"
|
||||
#include "config/mesh_forwarder.h"
|
||||
#include "config/misc.h"
|
||||
#include "config/mle.h"
|
||||
#include "config/nat64.h"
|
||||
|
||||
Reference in New Issue
Block a user