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 
35 #ifndef CONFIG_BACKBONE_ROUTER_H_
36 #define CONFIG_BACKBONE_ROUTER_H_
37 
38 /**
39  * @addtogroup config-backbone-router
40  *
41  * @brief
42  *   This module includes configuration variables for Backbone Router services.
43  *
44  * @{
45  *
46  */
47 
48 /**
49  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
50  *
51  * Define to 1 to enable Backbone Router support.
52  *
53  */
54 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
55 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE 0
56 #endif
57 
58 /**
59  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
60  *
61  * Define to 1 to enable Backbone Router ND Proxying for Thread 1.2 DUA feature.
62  * It's turned on by default for Thread 1.2 Backbone Router.
63  *
64  */
65 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE
66 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
67 #endif
68 
69 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE && !OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
70 #error \
71     "OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE is required for OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE"
72 #endif
73 
74 /**
75  * @def OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
76  *
77  * Define to 1 to enable Backbone Router Multicast Routing for Thread 1.2 MLR feature.
78  * It's turned on by default for Thread 1.2 Backbone Router.
79  *
80  */
81 #ifndef OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
82 #define OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
83 #endif
84 
85 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE && !OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
86 #error \
87     "OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE is required for OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE"
88 #endif
89 
90 #if OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE
91 #if !OPENTHREAD_CONFIG_BACKBONE_ROUTER_DUA_NDPROXYING_ENABLE && \
92     !OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE
93 #error \
94     "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"
95 #endif
96 #endif
97 
98 /**
99  * @def OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS
100  *
101  * This setting configures the maximum number of Multicast Listeners on a Backbone Router.
102  *
103  * Note: According to Thread Conformance v1.2.0, a Thread Border Router MUST be able to hold a Multicast Listeners Table
104  * in memory with at least seventy five (75) entries.
105  *
106  * @sa MulticastListenersTable
107  *
108  */
109 #ifndef OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS
110 #define OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS 75
111 #endif
112 
113 /**
114  * @def OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM
115  *
116  * The maximum number of supported DUA that Backbone Router could proxy.
117  *
118  * Note: According to Thread Conformance v1.2.0, a Thread Border Router MUST be able to hold a DUA Devices Table in
119  * memory with at least two hundred and fifty (250) entries.
120  *
121  */
122 #ifndef OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM
123 #define OPENTHREAD_CONFIG_NDPROXY_TABLE_ENTRY_NUM 250
124 #endif
125 
126 /**
127  * @}
128  *
129  */
130 
131 #endif // CONFIG_BACKBONE_ROUTER_H_
132