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 the SRP (Service Registration Protocol) Server. 32 * 33 */ 34 35 #ifndef CONFIG_SRP_SERVER_H_ 36 #define CONFIG_SRP_SERVER_H_ 37 38 /** 39 * @addtogroup config-srp-server 40 * 41 * @brief 42 * This module includes configuration variables for the SRP Server. 43 * 44 * @{ 45 * 46 */ 47 48 /** 49 * @def OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 50 * 51 * Define to 1 to enable SRP Server support. 52 * 53 */ 54 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 55 #define OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 0 56 #endif 57 58 /** 59 * @def OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE 60 * 61 * Specifies the default address mode used by the SRP server. 62 * 63 * The address mode specifies how address and port number are determined by the SRP server and how this info is 64 * published in the Thread Network Data. 65 * 66 * The value of this configuration should be from `otSrpServerAddressMode` enumeration. 67 * 68 */ 69 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE 70 #define OPENTHREAD_CONFIG_SRP_SERVER_DEFAULT_ADDRESS_MODE OT_SRP_SERVER_ADDRESS_MODE_UNICAST 71 #endif 72 73 /** 74 * @def OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN 75 * 76 * Specifies the min port number in the port range reserved for SRP server. 77 * 78 */ 79 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN 80 #define OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MIN 53535 81 #endif 82 83 /** 84 * @def OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX 85 * 86 * Specifies the max port number in the port range reserved for SRP server. 87 * 88 */ 89 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX 90 #define OPENTHREAD_CONFIG_SRP_SERVER_UDP_PORT_MAX 53554 91 #endif 92 93 /** 94 * @def OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE 95 * 96 * Define to 1 to enable SRP server feature to save its own port in non-volatile settings. 97 * 98 * When enabled, the SRP server will save its port in the non-volatile settings. On a server 99 * restart (e.g., due to a device reset) it will restore the port and change to a different one. The info is written to 100 * Settings after the first service has been registered due to receiving an SRP Update. 101 * 102 */ 103 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE 104 #define OPENTHREAD_CONFIG_SRP_SERVER_PORT_SWITCH_ENABLE 1 105 #endif 106 107 /** 108 * @def OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT 109 * 110 * Specifies the timeout value (in milliseconds) for the service update handler. 111 * 112 * The default timeout value is the sum of the maximum total mDNS probing delays 113 * and a loose IPC timeout of 250ms. It is recommended that this configuration should 114 * not use a value smaller than the default value here, if an Advertising Proxy is used 115 * to handle the service update events. 116 * 117 */ 118 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT 119 #define OPENTHREAD_CONFIG_SRP_SERVER_SERVICE_UPDATE_TIMEOUT ((4 * 250u) + 250u) 120 #endif 121 122 /** 123 * @def OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE 124 * 125 * Define to 1 to enable Advertising Proxy for SRP Sever. 126 * 127 */ 128 #ifndef OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE 129 #define OPENTHREAD_CONFIG_SRP_SERVER_ADVERTISING_PROXY_ENABLE 0 130 #endif 131 132 /** 133 * @} 134 * 135 */ 136 137 #endif // CONFIG_SRP_SERVER_H_ 138