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