• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2020, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes compile-time configurations for Backbone Router services.
32  */
33 
34 #ifndef CONFIG_BACKBONE_ROUTER_H_
35 #define CONFIG_BACKBONE_ROUTER_H_
36 
37 /**
38  * @addtogroup config-backbone-router
39  *
40  * @brief
41  *   This module includes configuration variables for Backbone Router services.
42  *
43  * @{
44  */
45 
46 /**
47  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
48  *
49  * Define to 1 to enable Backbone Router support.
50  */
51 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
52 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 0
53 #endif
54 
55 /**
56  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
57  *
58  * Define to 1 to enable Backbone Router ND Proxying for Thread 1.2 DUA feature.
59  * It's turned on by default for Thread 1.2 Backbone Router.
60  */
61 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
62 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
63 #endif
64 
65 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE && !OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
66 #error \
67     "OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE is required for OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE"
68 #endif
69 
70 /**
71  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
72  *
73  * Define to 1 to enable Backbone Router Multicast Routing for Thread 1.2 MLR feature.
74  * It's turned on by default for Thread 1.2 Backbone Router.
75  */
76 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
77 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
78 #endif
79 
80 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE && !OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
81 #error \
82     "OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE is required for OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE"
83 #endif
84 
85 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
86 #if !OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE && \
87     !OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
88 #error \
89     "At least one of OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE and OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE must be enabled for OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE"
90 #endif
91 #endif
92 
93 /**
94  * @def OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS
95  *
96  * This setting configures the maximum number of Multicast Listeners on a Backbone Router.
97  *
98  * Note: According to Thread Conformance v1.2.0, a Thread Border Router MUST be able to hold a Multicast Listeners Table
99  * in memory with at least seventy five (75) entries.
100  *
101  * @sa MulticastListenersTable
102  */
103 #ifndef OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS
104 #define OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS 75
105 #endif
106 
107 /**
108  * @def OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM
109  *
110  * The maximum number of supported DUA that Backbone Router could proxy.
111  *
112  * Note: According to Thread Conformance v1.2.0, a Thread Border Router MUST be able to hold a DUA Devices Table in
113  * memory with at least two hundred and fifty (250) entries.
114  */
115 #ifndef OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM
116 #define OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM 250
117 #endif
118 
119 /**
120  * @}
121  */
122 
123 #endif // CONFIG_BACKBONE_ROUTER_H_
124