Line data    Source code

       1            0 : /*
       2              :  * Copyright (c) 2023 Nordic Semiconductor ASA
       3              :  *
       4              :  * SPDX-License-Identifier: Apache-2.0
       5              :  */
       6              : 
       7              : #ifndef H_SETTINGS_MGMT_
       8              : #define H_SETTINGS_MGMT_
       9              : 
      10              : /**
      11              :  * @brief MCUmgr Settings Management API
      12              :  * @defgroup mcumgr_settings_mgmt Settings Management
      13              :  * @ingroup mcumgr_mgmt_api
      14              :  * @{
      15              :  */
      16              : 
      17              : #ifdef __cplusplus
      18              : extern "C" {
      19              : #endif
      20              : 
      21              : /**
      22              :  * @name Command IDs for Settings Management group.
      23              :  * @{
      24              :  */
      25            1 : #define SETTINGS_MGMT_ID_READ_WRITE 0 /**< Read/write setting */
      26            1 : #define SETTINGS_MGMT_ID_DELETE     1 /**< Delete setting */
      27            1 : #define SETTINGS_MGMT_ID_COMMIT     2 /**< Commit settings */
      28            1 : #define SETTINGS_MGMT_ID_LOAD_SAVE  3 /**< Load/save settings */
      29              : /** @} */
      30              : 
      31              : /**
      32              :  * Command result codes for settings management group.
      33              :  */
      34            1 : enum settings_mgmt_ret_code_t {
      35              :         /** No error, this is implied if there is no ret value in the response. */
      36              :         SETTINGS_MGMT_ERR_OK = 0,
      37              : 
      38              :         /** Unknown error occurred. */
      39              :         SETTINGS_MGMT_ERR_UNKNOWN,
      40              : 
      41              :         /** The provided key name is too long to be used. */
      42              :         SETTINGS_MGMT_ERR_KEY_TOO_LONG,
      43              : 
      44              :         /** The provided key name does not exist. */
      45              :         SETTINGS_MGMT_ERR_KEY_NOT_FOUND,
      46              : 
      47              :         /** The provided key name does not support being read. */
      48              :         SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED,
      49              : 
      50              :         /** The provided root key name does not exist. */
      51              :         SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND,
      52              : 
      53              :         /** The provided key name does not support being written. */
      54              :         SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED,
      55              : 
      56              :         /** The provided key name does not support being deleted. */
      57              :         SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED,
      58              : };
      59              : 
      60              : #ifdef __cplusplus
      61              : }
      62              : #endif
      63              : 
      64              : /**
      65              :  * @}
      66              :  */
      67              : 
      68              : #endif