Line data    Source code

       1            0 : /*
       2              :  * Copyright (c) 2024 Nordic Semiconductor ASA
       3              :  *
       4              :  * SPDX-License-Identifier: Apache-2.0
       5              :  */
       6              : 
       7              : #ifndef H_MCUMGR_ENUM_MGMT_CALLBACKS_
       8              : #define H_MCUMGR_ENUM_MGMT_CALLBACKS_
       9              : 
      10              : #ifdef __cplusplus
      11              : extern "C" {
      12              : #endif
      13              : 
      14              : /**
      15              :  * @brief MCUmgr Enumeration Management Callbacks API
      16              :  * @defgroup mcumgr_callback_api_enum_mgmt Enumeration Management Callbacks
      17              :  * @ingroup mcumgr_enum_mgmt
      18              :  * @ingroup mcumgr_callback_api
      19              :  * @{
      20              :  */
      21              : 
      22              : /**
      23              :  * Structure provided in the #MGMT_EVT_OP_ENUM_MGMT_DETAILS notification callback: This callback
      24              :  * function is called once per command group when the detail command is used, it can be used to
      25              :  * return additional information/fields in the response.
      26              :  */
      27            1 : struct enum_mgmt_detail_output {
      28              :         /** The group that is currently being enumerated. */
      29            1 :         const struct mgmt_group *group;
      30              : 
      31              :         /**
      32              :          * The zcbor encoder which is currently being used to output group information, additional
      33              :          * fields to the group can be added using this.
      34              :          */
      35            1 :         zcbor_state_t *zse;
      36              : };
      37              : 
      38              : /**
      39              :  * @}
      40              :  */
      41              : 
      42              : #ifdef __cplusplus
      43              : }
      44              : #endif
      45              : 
      46              : #endif