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  */
53 class Cli
54 {
55 public:
Cli(void)56     Cli(void)
57         : mFactoryConfigFile(OPENTHREAD_POSIX_CONFIG_FACTORY_CONFIG_FILE)
58         , mProductConfigFile(OPENTHREAD_POSIX_CONFIG_PRODUCT_CONFIG_FILE)
59     {
60     }
61 
62     /**
63      * Processes a factory command.
64      *
65      * @param[in]   aArgs          The arguments of command line.
66      * @param[in]   aArgsLength    The number of args in @p aArgs.
67      *
68      */
69     void ProcessCommand(Utils::CmdLineParser::Arg aArgs[]);
70 
71     /**
72      * Processes the command line.
73      *
74      * @param[in]  aLine   A pointer to a command line string.
75      *
76      */
77     void ProcessLine(char *aLine);
78 
79     /**
80      * Outputs the prompt.
81      *
82      */
83     void OutputPrompt(void);
84 
85 private:
86     static constexpr uint16_t kMaxValueSize           = 512;
87     const char               *kKeyCalibratedPower     = "calibrated_power";
88     const char               *kKeyTargetPower         = "target_power";
89     const char               *kKeyRegionDomainMapping = "region_domain_mapping";
90     const char               *kCommaDelimiter         = ",";
91 
92     struct Command
93     {
94         const char *mName;
95         otError (Cli::*mCommand)(Utils::CmdLineParser::Arg aArgs[]);
96     };
97 
98     otError ParseNextCalibratedPower(char                   *aCalibratedPowerString,
99                                      uint16_t                aLength,
100                                      uint16_t               &aIterator,
101                                      Power::CalibratedPower &aCalibratedPower);
102     otError ProcessCalibrationTable(Utils::CmdLineParser::Arg aArgs[]);
103     otError ProcessTargetPowerTable(Utils::CmdLineParser::Arg aArgs[]);
104     otError ProcessRegionDomainTable(Utils::CmdLineParser::Arg aArgs[]);
105     otError GetNextDomain(int &aIterator, Power::Domain &aDomain);
106     otError GetNextTargetPower(const Power::Domain &aDomain, int &aIterator, Power::TargetPower &aTargetPower);
107 
108     void AppendErrorResult(otError aError);
109 
110     static const struct Command sCommands[];
111 
112     ot::Posix::ConfigFile mFactoryConfigFile;
113     ot::Posix::ConfigFile mProductConfigFile;
114 };
115 } // namespace Fct
116 } // namespace ot
117 #endif
118