1 /*
2  *  Copyright (c) 2024, 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 Multicast DNS (mDNS).
32  *
33  */
34 
35 #ifndef CONFIG_MULTICAST_DNS_H_
36 #define CONFIG_MULTICAST_DNS_H_
37 
38 /**
39  * @addtogroup config-mdns
40  *
41  * @brief
42  *   This module includes configuration variables for the Multicast DNS (mDNS).
43  *
44  * @{
45  *
46  */
47 
48 /**
49  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE
50  *
51  * Define to 1 to enable Multicast DNS (mDNS) support.
52  *
53  */
54 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE
55 #define OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE 0
56 #endif
57 
58 /**
59  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE
60  *
61  * Define to 1 to allow public OpenThread APIs to be defined for Multicast DNS (mDNS) module.
62  *
63  * The OpenThread mDNS module is mainly intended for use by other OT core modules, so the public APIs are by default
64  * not provided.
65  *
66  */
67 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE
68 #define OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE 0
69 #endif
70 
71 /**
72  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_ENTRY_ITERATION_API_ENABLE
73  *
74  * Define to 1 for mDNS module to provide mechanisms and public APIs to iterate over registered host, service, and
75  * key entries, as well as browsers and resolvers.
76  *
77  */
78 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_ENTRY_ITERATION_API_ENABLE
79 #define OPENTHREAD_CONFIG_MULTICAST_DNS_ENTRY_ITERATION_API_ENABLE OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE
80 #endif
81 
82 /**
83  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_AUTO_ENABLE_ON_INFRA_IF
84  *
85  * Define to 1 for mDNS module to be automatically enabled/disabled on the same infra-if used for border routing
86  * based on infra-if state.
87  *
88  */
89 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_AUTO_ENABLE_ON_INFRA_IF
90 #define OPENTHREAD_CONFIG_MULTICAST_DNS_AUTO_ENABLE_ON_INFRA_IF OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
91 #endif
92 
93 /**
94  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_DEFAULT_QUESTION_UNICAST_ALLOWED
95  *
96  * Specified the default value for `otMdnsIsQuestionUnicastAllowed()` which indicates whether mDNS core is allowed to
97  * send "QU" questions (questions requesting unicast response). When allowed, the first probe will be sent as "QU"
98  * question. The `otMdnsSetQuestionUnicastAllowed()` can be used to change the default value at run-time.
99  *
100  */
101 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_DEFAULT_QUESTION_UNICAST_ALLOWED
102 #define OPENTHREAD_CONFIG_MULTICAST_DNS_DEFAULT_QUESTION_UNICAST_ALLOWED 1
103 #endif
104 
105 /**
106  * @def OPENTHREAD_CONFIG_MULTICAST_DNS_MOCK_PLAT_APIS_ENABLE
107  *
108  * Define to 1 to add mock (empty) implementation of mDNS platform APIs.
109  *
110  * This is intended for generating code size report only and should not be used otherwise.
111  *
112  */
113 #ifndef OPENTHREAD_CONFIG_MULTICAST_DNS_MOCK_PLAT_APIS_ENABLE
114 #define OPENTHREAD_CONFIG_MULTICAST_DNS_MOCK_PLAT_APIS_ENABLE 0
115 #endif
116 
117 /**
118  * @}
119  *
120  */
121 
122 #endif // CONFIG_MULTICAST_DNS_H_
123