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