1 /* 2 * Copyright (c) 2023, 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 Network Diagnostics. 32 */ 33 34 #ifndef CONFIG_NETWORK_DIAGNOSTIC_H_ 35 #define CONFIG_NETWORK_DIAGNOSTIC_H_ 36 37 /** 38 * @addtogroup config-network-diagnostic 39 * 40 * @brief 41 * This module includes configuration variables for Network Diagnostics. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME 48 * 49 * Specifies the default Vendor Name string. 50 */ 51 #ifndef OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME 52 #define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME "" 53 #endif 54 55 /** 56 * @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL 57 * 58 * Specifies the default Vendor Model string. 59 */ 60 #ifndef OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL 61 #define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL "" 62 #endif 63 64 /** 65 * @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION 66 * 67 * Specifies the default Vendor SW Version string. 68 */ 69 #ifndef OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION 70 #define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION "" 71 #endif 72 73 /** 74 * @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_APP_URL 75 * 76 * Specifies the default Vendor App URL string. 77 */ 78 #ifndef OPENTHREAD_CONFIG_NET_DIAG_VENDOR_APP_URL 79 #define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_APP_URL "" 80 #endif 81 82 /** 83 * @def OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE 84 * 85 * Define as 1 to add APIs to allow Vendor Name, Model, SW Version to change at run-time. 86 * 87 * It is recommended that Vendor Name, Model, and SW Version are set at build time using the OpenThread configurations 88 * `OPENTHREAD_CONFIG_NET_DIAG_VENDOR_*`. This way they are treated as constants and won't consume RAM. 89 * 90 * However, for situations where the OpenThread stack is integrated as a library into different projects/products, this 91 * config can be used to add API to change Vendor Name, Model, and SW Version at run-time. In this case, the strings in 92 * `OPENTHREAD_CONFIG_NET_DIAG_VENDOR_*` are treated as the default values (used when OT stack is initialized). 93 * 94 * Enabled by default for reference devices, when `OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE` is defined. 95 */ 96 #ifndef OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE 97 #define OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 98 #endif 99 100 /** 101 * @} 102 */ 103 104 #endif // CONFIG_NETWORK_DIAGNOSTIC_H_ 105