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 contains definitions for CLI to backbone router.
32  */
33 
34 #ifndef CLI_BBR_HPP_
35 #define CLI_BBR_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
40 
41 #include <openthread/backbone_router.h>
42 #include <openthread/backbone_router_ftd.h>
43 
44 #include "cli/cli_config.h"
45 #include "cli/cli_output.hpp"
46 
47 namespace ot {
48 namespace Cli {
49 
50 /**
51  * Implements the BBR CLI interpreter.
52  *
53  */
54 class Bbr : private Output
55 {
56 public:
57     typedef Utils::CmdLineParser::Arg Arg;
58 
59     /**
60      * Constructor.
61      *
62      * @param[in]  aInstance            The OpenThread Instance.
63      * @param[in]  aOutputImplementer   An `OutputImplementer`.
64      *
65      */
Bbr(otInstance * aInstance,OutputImplementer & aOutputImplementer)66     Bbr(otInstance *aInstance, OutputImplementer &aOutputImplementer)
67         : Output(aInstance, aOutputImplementer)
68     {
69     }
70 
71     /**
72      * Processes a CLI sub-command.
73      *
74      * @param[in]  aArgs     An array of command line arguments.
75      *
76      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
77      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
78      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
79      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
80      * @retval ...                        Error during execution of the CLI command.
81      *
82      */
83     otError Process(Arg aArgs[]);
84 
85 private:
86     using Command = CommandEntry<Bbr>;
87 
88     template <CommandId kCommandId> otError Process(Arg aArgs[]);
89 
90     void OutputConfig(const otBackboneRouterConfig &aConfig);
91 };
92 
93 } // namespace Cli
94 } // namespace ot
95 
96 #endif //  (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
97 
98 #endif // CLI_BBR_HPP_
99