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