1 /* 2 * Copyright (c) 2016, 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 * @brief 32 * This file includes the OpenThread API for Factory Diagnostics. 33 */ 34 35 #ifndef OPENTHREAD_DIAG_H_ 36 #define OPENTHREAD_DIAG_H_ 37 38 #include <openthread/instance.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @addtogroup api-factory-diagnostics 46 * 47 * @brief 48 * This module includes functions that control the Thread stack's execution. 49 * 50 * @{ 51 * 52 */ 53 54 /** 55 * Processes a factory diagnostics command line. 56 * 57 * The output of this function (the content written to @p aOutput) MUST terminate with `\0` and the `\0` is within the 58 * output buffer. 59 * 60 * @param[in] aInstance A pointer to an OpenThread instance. 61 * @param[in] aArgsLength The number of elements in @p aArgs. 62 * @param[in] aArgs An array of arguments. 63 * @param[out] aOutput The diagnostics execution result. 64 * @param[in] aOutputMaxLen The output buffer size. 65 * 66 * @retval OT_ERROR_INVALID_ARGS The command is supported but invalid arguments provided. 67 * @retval OT_ERROR_NONE The command is successfully process. 68 * @retval OT_ERROR_NOT_IMPLEMENTED The command is not supported. 69 * 70 */ 71 otError otDiagProcessCmd(otInstance *aInstance, 72 uint8_t aArgsLength, 73 char *aArgs[], 74 char *aOutput, 75 size_t aOutputMaxLen); 76 77 /** 78 * Processes a factory diagnostics command line. 79 * 80 * The output of this function (the content written to @p aOutput) MUST terminate with `\0` and the `\0` is within the 81 * output buffer. 82 * 83 * @param[in] aInstance A pointer to an OpenThread instance. 84 * @param[in] aString A NULL-terminated input string. 85 * @param[out] aOutput The diagnostics execution result. 86 * @param[in] aOutputMaxLen The output buffer size. 87 * 88 * @retval OT_ERROR_NONE The command is successfully process. 89 * @retval OT_ERROR_INVALID_ARGS The command is supported but invalid arguments provided. 90 * @retval OT_ERROR_NOT_IMPLEMENTED The command is not supported. 91 * @retval OT_ERROR_NO_BUFS The command string is too long. 92 * 93 */ 94 otError otDiagProcessCmdLine(otInstance *aInstance, const char *aString, char *aOutput, size_t aOutputMaxLen); 95 96 /** 97 * Indicates whether or not the factory diagnostics mode is enabled. 98 * 99 * @param[in] aInstance A pointer to an OpenThread instance. 100 * 101 * @retval TRUE if factory diagnostics mode is enabled 102 * @retval FALSE if factory diagnostics mode is disabled. 103 * 104 */ 105 bool otDiagIsEnabled(otInstance *aInstance); 106 107 /** 108 * @} 109 * 110 */ 111 112 #ifdef __cplusplus 113 } // extern "C" 114 #endif 115 116 #endif // OPENTHREAD_DIAG_H_ 117
