• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef CLI_TCAT_HPP_
30 #define CLI_TCAT_HPP_
31 
32 #include "openthread-core-config.h"
33 
34 #include <openthread/tcat.h>
35 
36 #include "cli/cli_utils.hpp"
37 
38 #if OPENTHREAD_CONFIG_BLE_TCAT_ENABLE && OPENTHREAD_CONFIG_CLI_BLE_SECURE_ENABLE
39 
40 namespace ot {
41 
42 namespace Cli {
43 
44 /**
45  * Implements the Tcat CLI interpreter.
46  */
47 class Tcat : private Utils
48 {
49 public:
50     /**
51      * Constructor
52      *
53      * @param[in]  aInstance            The OpenThread Instance.
54      * @param[in]  aOutputImplementer   An `OutputImplementer`.
55      */
Tcat(otInstance * aInstance,OutputImplementer & aOutputImplementer)56     Tcat(otInstance *aInstance, OutputImplementer &aOutputImplementer)
57         : Utils(aInstance, aOutputImplementer)
58     {
59     }
60 
61     /**
62      * Processes a CLI sub-command.
63      *
64      * @param[in]  aArgs     An array of command line arguments.
65      *
66      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
67      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
68      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
69      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
70      * @retval ...                        Error during execution of the CLI command.
71      */
72     otError Process(Arg aArgs[]);
73 
74 private:
75     using Command = CommandEntry<Tcat>;
76 
77     template <CommandId kCommandId> otError Process(Arg aArgs[]);
78 
79     otTcatVendorInfo mVendorInfo;
80 };
81 
82 } // namespace Cli
83 
84 } // namespace ot
85 
86 #endif // OPENTHREAD_CONFIG_BLE_TCAT_ENABLE && OPENTHREAD_CONFIG_CLI_BLE_SECURE_ENABLE
87 
88 #endif // CLI_TCAT_HPP_
89