1 /* 2 * Copyright (c) 2022, 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 strain 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 #ifndef CLI_H 30 #define CLI_H 31 32 #include "openthread-posix-config.h" 33 34 #include <stdint.h> 35 #include <stdio.h> 36 37 #include "config_file.hpp" 38 #include "power.hpp" 39 #include "utils/parse_cmdline.hpp" 40 41 #include <openthread/error.h> 42 #include <openthread/platform/radio.h> 43 44 namespace ot { 45 namespace Fct { 46 47 class Cli; 48 49 /** 50 * Implements the factory CLI. 51 */ 52 class Cli 53 { 54 public: Cli(void)55 Cli(void) 56 : mFactoryConfigFile(OPENTHREAD_POSIX_CONFIG_FACTORY_CONFIG_FILE) 57 , mProductConfigFile(OPENTHREAD_POSIX_CONFIG_PRODUCT_CONFIG_FILE) 58 { 59 } 60 61 /** 62 * Processes a factory command. 63 * 64 * @param[in] aArgs The arguments of command line. 65 * @param[in] aArgsLength The number of args in @p aArgs. 66 */ 67 void ProcessCommand(Utils::CmdLineParser::Arg aArgs[]); 68 69 /** 70 * Processes the command line. 71 * 72 * @param[in] aLine A pointer to a command line string. 73 */ 74 void ProcessLine(char *aLine); 75 76 /** 77 * Outputs the prompt. 78 */ 79 void OutputPrompt(void); 80 81 private: 82 static constexpr uint16_t kMaxValueSize = 512; 83 const char *kKeyCalibratedPower = "calibrated_power"; 84 const char *kKeyTargetPower = "target_power"; 85 const char *kKeyRegionDomainMapping = "region_domain_mapping"; 86 const char *kCommaDelimiter = ","; 87 88 struct Command 89 { 90 const char *mName; 91 otError (Cli::*mCommand)(Utils::CmdLineParser::Arg aArgs[]); 92 }; 93 94 otError ParseNextCalibratedPower(char *aCalibratedPowerString, 95 uint16_t aLength, 96 uint16_t &aIterator, 97 Power::CalibratedPower &aCalibratedPower); 98 otError ProcessCalibrationTable(Utils::CmdLineParser::Arg aArgs[]); 99 otError ProcessTargetPowerTable(Utils::CmdLineParser::Arg aArgs[]); 100 otError ProcessRegionDomainTable(Utils::CmdLineParser::Arg aArgs[]); 101 otError GetNextDomain(int &aIterator, Power::Domain &aDomain); 102 otError GetNextTargetPower(const Power::Domain &aDomain, int &aIterator, Power::TargetPower &aTargetPower); 103 104 void AppendErrorResult(otError aError); 105 106 static const struct Command sCommands[]; 107 108 ot::Posix::ConfigFile mFactoryConfigFile; 109 ot::Posix::ConfigFile mProductConfigFile; 110 }; 111 } // namespace Fct 112 } // namespace ot 113 #endif 114