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 Border Router.
32  */
33 
34 #ifndef CLI_BR_HPP_
35 #define CLI_BR_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <openthread/border_routing.h>
40 
41 #include "cli/cli_config.h"
42 #include "cli/cli_utils.hpp"
43 
44 #if OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
45 
46 namespace ot {
47 namespace Cli {
48 
49 /**
50  * Implements the Border Router CLI interpreter.
51  *
52  */
53 class Br : private Utils
54 {
55 public:
56     /**
57      * Constructor
58      *
59      * @param[in]  aInstance            The OpenThread Instance.
60      * @param[in]  aOutputImplementer   An `OutputImplementer`.
61      *
62      */
Br(otInstance * aInstance,OutputImplementer & aOutputImplementer)63     Br(otInstance *aInstance, OutputImplementer &aOutputImplementer)
64         : Utils(aInstance, aOutputImplementer)
65     {
66     }
67 
68     /**
69      * Processes a CLI sub-command.
70      *
71      * @param[in]  aArgs     An array of command line arguments.
72      *
73      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
74      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
75      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
76      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
77      * @retval ...                        Error during execution of the CLI command.
78      *
79      */
80     otError Process(Arg aArgs[]);
81 
82 private:
83     using Command = CommandEntry<Br>;
84 
85     using PrefixType = uint8_t;
86     enum : PrefixType
87     {
88         kPrefixTypeLocal   = 1u << 0,
89         kPrefixTypeFavored = 1u << 1,
90     };
91 
92     enum RouterOutputMode : uint8_t
93     {
94         kShortVersion,
95         kLongVersion,
96     };
97 
98     template <CommandId kCommandId> otError Process(Arg aArgs[]);
99 
100     otError ParsePrefixTypeArgs(Arg aArgs[], PrefixType &aFlags);
101     void    OutputRouterInfo(const otBorderRoutingRouterEntry &aEntry, RouterOutputMode aMode);
102 };
103 
104 } // namespace Cli
105 } // namespace ot
106 
107 #endif // OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
108 
109 #endif // CLI_BR_HPP_
110