Line data    Source code

       1            0 : /*
       2              :  * Copyright (c) 2018-2021 mcumgr authors
       3              :  * Copyright (c) 2023 Nordic Semiconductor ASA
       4              :  *
       5              :  * SPDX-License-Identifier: Apache-2.0
       6              :  */
       7              : 
       8              : #ifndef H_SHELL_MGMT_
       9              : #define H_SHELL_MGMT_
      10              : 
      11              : /**
      12              :  * @brief MCUmgr Shell Management API
      13              :  * @defgroup mcumgr_shell_mgmt Shell Management
      14              :  * @ingroup mcumgr_mgmt_api
      15              :  * @{
      16              :  */
      17              : 
      18              : #ifdef __cplusplus
      19              : extern "C" {
      20              : #endif
      21              : 
      22              : /**
      23              :  * @name Command IDs for Shell Management group.
      24              :  * @{
      25              :  */
      26            1 : #define SHELL_MGMT_ID_EXEC 0 /**< Shell command line execute */
      27              : /** @} */
      28              : 
      29              : /**
      30              :  * Command result codes for shell management group.
      31              :  */
      32            1 : enum shell_mgmt_err_code_t {
      33              :         /** No error, this is implied if there is no ret value in the response */
      34              :         SHELL_MGMT_ERR_OK = 0,
      35              : 
      36              :         /** Unknown error occurred. */
      37              :         SHELL_MGMT_ERR_UNKNOWN,
      38              : 
      39              :         /** The provided command to execute is too long. */
      40              :         SHELL_MGMT_ERR_COMMAND_TOO_LONG,
      41              : 
      42              :         /** No command to execute was provided. */
      43              :         SHELL_MGMT_ERR_EMPTY_COMMAND,
      44              : };
      45              : 
      46              : #ifdef __cplusplus
      47              : }
      48              : #endif
      49              : 
      50              : /**
      51              :  * @}
      52              :  */
      53              : 
      54              : #endif /* H_SHELL_MGMT_ */