From da357701406a38a94478b7f8c6a90f09cded0166 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Wed, 18 Jan 2017 13:16:28 -0800 Subject: [PATCH] CLI API cleanup. --- configure.ac | 1 - examples/apps/cli/main.c | 3 +- examples/drivers/windows/otCli/main.cpp | 4 +- include/Makefile.am | 3 - include/cli/Makefile.am | 41 ------------- include/cli/cli-uart.h | 57 ------------------- include/openthread/Makefile.am | 1 + .../{cli/cli-console.h => openthread/cli.h} | 12 +++- src/cli/cli_console.hpp | 3 +- src/cli/cli_uart.cpp | 3 +- 10 files changed, 19 insertions(+), 109 deletions(-) delete mode 100644 include/cli/Makefile.am delete mode 100644 include/cli/cli-uart.h rename include/{cli/cli-console.h => openthread/cli.h} (94%) diff --git a/configure.ac b/configure.ac index c9be9bf12..5ac478a73 100644 --- a/configure.ac +++ b/configure.ac @@ -1079,7 +1079,6 @@ NL_RESTORE_WERROR AC_CONFIG_FILES([ Makefile include/Makefile -include/cli/Makefile include/openthread/Makefile include/platform/Makefile src/Makefile diff --git a/examples/apps/cli/main.c b/examples/apps/cli/main.c index b55e66b65..3247eec41 100644 --- a/examples/apps/cli/main.c +++ b/examples/apps/cli/main.c @@ -32,11 +32,12 @@ #include #endif +#include "openthread/cli.h" + #include #include #include #include -#include #include #include diff --git a/examples/drivers/windows/otCli/main.cpp b/examples/drivers/windows/otCli/main.cpp index cd46fe54a..0fc61f565 100644 --- a/examples/drivers/windows/otCli/main.cpp +++ b/examples/drivers/windows/otCli/main.cpp @@ -30,7 +30,7 @@ #include #include -#include +#include #include bool skipNextLine = false; @@ -82,4 +82,4 @@ EXTERN_C ThreadError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength) otPlatUartSendDone(); return error; -} \ No newline at end of file +} diff --git a/include/Makefile.am b/include/Makefile.am index cddf13aa0..3a51c095d 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -31,7 +31,6 @@ include $(abs_top_nlbuild_autotools_dir)/automake/pre.am # Always package (e.g. for 'make dist') these subdirectories. DIST_SUBDIRS = \ - cli \ openthread \ platform \ $(NULL) @@ -39,7 +38,6 @@ DIST_SUBDIRS = \ # Always build (e.g. for 'make all') these subdirectories. SUBDIRS = \ - cli \ openthread \ platform \ $(NULL) @@ -47,7 +45,6 @@ SUBDIRS = \ # Always pretty (e.g. for 'make pretty') these subdirectories. PRETTY_SUBDIRS = \ - cli \ openthread \ platform \ $(NULL) diff --git a/include/cli/Makefile.am b/include/cli/Makefile.am deleted file mode 100644 index f2e9c92f0..000000000 --- a/include/cli/Makefile.am +++ /dev/null @@ -1,41 +0,0 @@ -# -# Copyright (c) 2016, The OpenThread Authors. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# 1. Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# 2. Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# 3. Neither the name of the copyright holder nor the -# names of its contributors may be used to endorse or promote products -# derived from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# - -include $(abs_top_nlbuild_autotools_dir)/automake/pre.am - -ot_cli_headers = \ - cli-console.h \ - cli-uart.h \ - $(NULL) - -ot_clidir = $(includedir)/cli -dist_ot_cli_HEADERS = $(ot_cli_headers) - -install-headers: install-includeHEADERS - -include $(abs_top_nlbuild_autotools_dir)/automake/post.am diff --git a/include/cli/cli-uart.h b/include/cli/cli-uart.h deleted file mode 100644 index 2131a3d05..000000000 --- a/include/cli/cli-uart.h +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright (c) 2016, The OpenThread Authors. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. Neither the name of the copyright holder nor the - * names of its contributors may be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - */ - -/** - * @file - * @brief - * This file defines the top-level functions for the OpenThread CLI server. - */ - -#ifndef CLI_UART_H_ -#define CLI_UART_H_ - -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/** - * Initialize the CLI UART module. - * - * @param[in] aInstance The OpenThread instance structure. - * - */ -void otCliUartInit(otInstance *aInstance); - -#ifdef __cplusplus -} // extern "C" -#endif - -#endif diff --git a/include/openthread/Makefile.am b/include/openthread/Makefile.am index e1222020e..d4ef63147 100644 --- a/include/openthread/Makefile.am +++ b/include/openthread/Makefile.am @@ -29,6 +29,7 @@ include $(abs_top_nlbuild_autotools_dir)/automake/pre.am openthread_headers = \ + cli.h \ coap.h \ commissioner.h \ crypto.h \ diff --git a/include/cli/cli-console.h b/include/openthread/cli.h similarity index 94% rename from include/cli/cli-console.h rename to include/openthread/cli.h index c1696949a..ee0694698 100644 --- a/include/cli/cli-console.h +++ b/include/openthread/cli.h @@ -32,8 +32,8 @@ * This file defines the top-level functions for the OpenThread CLI server. */ -#ifndef CLI_CONSOLE_H_ -#define CLI_CONSOLE_H_ +#ifndef CLI_H_ +#define CLI_H_ #include @@ -75,6 +75,14 @@ void otCliConsoleInit(otInstance *aInstance, otCliConsoleOutputCallback aCallbac */ void otCliConsoleInputLine(char *aBuf, uint16_t aBufLength); +/** + * Initialize the CLI UART module. + * + * @param[in] aInstance The OpenThread instance structure. + * + */ +void otCliUartInit(otInstance *aInstance); + #ifdef __cplusplus } // extern "C" #endif diff --git a/src/cli/cli_console.hpp b/src/cli/cli_console.hpp index 8ea2e9467..e1daf4a98 100644 --- a/src/cli/cli_console.hpp +++ b/src/cli/cli_console.hpp @@ -35,8 +35,9 @@ #define CLI_CONSOLE_HPP_ #include +#include "openthread/cli.h" + #include -#include namespace Thread { namespace Cli { diff --git a/src/cli/cli_uart.cpp b/src/cli/cli_uart.cpp index 5b6c4ccfe..325aaf6e1 100644 --- a/src/cli/cli_uart.cpp +++ b/src/cli/cli_uart.cpp @@ -36,8 +36,9 @@ #include #include +#include "openthread/cli.h" + #include -#include #include #include #include