1 /* 2 * Copyright (c) 2019, 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 Border Router services. 32 */ 33 34 #ifndef CONFIG_BORDER_ROUTER_H_ 35 #define CONFIG_BORDER_ROUTER_H_ 36 37 /** 38 * @addtogroup config-border-router 39 * 40 * @brief 41 * This module includes configuration variables for Border Router services. 42 * 43 * @{ 44 */ 45 46 #include <config/border_routing.h> 47 48 /** 49 * @def OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 50 * 51 * Define to 1 to enable Border Router support. 52 */ 53 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 54 #define OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 0 55 #endif 56 57 /** 58 * @def OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 59 * 60 * Define to 1 to enable mechanism on a Border Router which provides IP connectivity to request router role upgrade. 61 * 62 * This config is applicable on an `OPENTHREAD_FTD` build and when `OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE` is also 63 * enabled. 64 * 65 * A Border Router is considered to provide external IP connectivity if at least one of the below conditions hold: 66 * 67 * - It has added at least one external route entry. 68 * - It has added at least one prefix entry with default-route and on-mesh flags set. 69 * - It has added at least one domain prefix (domain and on-mesh flags set). 70 * 71 * A Border Router which provides IP connectivity and is acting as a REED is eligible to request a router role upgrade 72 * by sending an "Address Solicit" request to leader with status reason `BorderRouterRequest`. This reason is used when 73 * the number of active routers in the Thread mesh is above the threshold, and only if the number of existing eligible 74 * BRs (determined from the Thread Network Data) that are acting as router is less than two. This mechanism allows up 75 * to two eligible Border Routers to request router role upgrade when the number of routers is already above the 76 * threshold. 77 */ 78 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 79 #define OPENTHREAD_CONFIG_BORDER_ROUTER_REQUEST_ROUTER_ROLE 1 80 #endif 81 82 /** 83 * @def OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL 84 * 85 * Define as 1 to enable mechanism to detect and signal when local or leader Network Data gets full. 86 */ 87 #ifndef OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL 88 #define OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 89 #endif 90 91 /** 92 * @} 93 */ 94 95 #endif // CONFIG_BORDER_ROUTER_H_ 96
