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 class Br : private Utils 53 { 54 public: 55 /** 56 * Constructor 57 * 58 * @param[in] aInstance The OpenThread Instance. 59 * @param[in] aOutputImplementer An `OutputImplementer`. 60 */ Br(otInstance * aInstance,OutputImplementer & aOutputImplementer)61 Br(otInstance *aInstance, OutputImplementer &aOutputImplementer) 62 : Utils(aInstance, aOutputImplementer) 63 { 64 } 65 66 /** 67 * Processes a CLI sub-command. 68 * 69 * @param[in] aArgs An array of command line arguments. 70 * 71 * @retval OT_ERROR_NONE Successfully executed the CLI command. 72 * @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending. 73 * @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command. 74 * @retval OT_ERROR_INVALID_ARGS Invalid arguments. 75 * @retval ... Error during execution of the CLI command. 76 */ 77 otError Process(Arg aArgs[]); 78 79 private: 80 using Command = CommandEntry<Br>; 81 using PrefixType = uint8_t; 82 83 static constexpr PrefixType kPrefixTypeLocal = 1u << 0; 84 static constexpr PrefixType kPrefixTypeFavored = 1u << 1; 85 86 enum RouterOutputMode : uint8_t 87 { 88 kShortVersion, 89 kLongVersion, 90 }; 91 92 template <CommandId kCommandId> otError Process(Arg aArgs[]); 93 94 otError ParsePrefixTypeArgs(Arg aArgs[], PrefixType &aFlags); 95 void OutputRouterInfo(const otBorderRoutingRouterEntry &aEntry, RouterOutputMode aMode); 96 }; 97 98 } // namespace Cli 99 } // namespace ot 100 101 #endif // OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE 102 103 #endif // CLI_BR_HPP_ 104