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_MCUMGR_OS_MGMT_CALLBACKS_
       8              : #define H_MCUMGR_OS_MGMT_CALLBACKS_
       9              : 
      10              : #ifdef __cplusplus
      11              : extern "C" {
      12              : #endif
      13              : 
      14              : /**
      15              :  * @brief MCUmgr OS Management Callbacks API
      16              :  * @defgroup mcumgr_callback_api_os_mgmt OS Management Callbacks
      17              :  * @ingroup mcumgr_os_mgmt
      18              :  * @ingroup mcumgr_callback_api
      19              :  * @{
      20              :  */
      21              : 
      22              : /**
      23              :  * Structure provided in the #MGMT_EVT_OP_OS_MGMT_RESET notification callback: This callback
      24              :  * function is used to notify the application about a pending device reboot request and to
      25              :  * authorise or deny it.
      26              :  */
      27            1 : struct os_mgmt_reset_data {
      28              :         /** Contains the value of the force parameter. */
      29            1 :         bool force;
      30              : 
      31              : #if defined(CONFIG_MCUMGR_GRP_OS_RESET_BOOT_MODE) || defined(__DOXYGEN__)
      32              :         /** Contains the value of the boot_mode parameter. */
      33            1 :         uint8_t boot_mode;
      34              : #endif
      35              : };
      36              : 
      37              : /**
      38              :  * Structure provided in the #MGMT_EVT_OP_OS_MGMT_BOOTLOADER_INFO notification callback: This
      39              :  * callback function is used to add new fields to the bootloader info response.
      40              :  */
      41            1 : struct os_mgmt_bootloader_info_data {
      42              :         /**
      43              :          * The zcbor encoder which is currently being used to output group information, additional
      44              :          * fields to the group can be added using this.
      45              :          */
      46            1 :         zcbor_state_t *zse;
      47              : 
      48              :         /** Contains the number of decoded parameters. */
      49            1 :         const size_t *decoded;
      50              : 
      51              :         /** Contains the value of the query parameter. */
      52            1 :         struct zcbor_string *query;
      53              : 
      54              :         /**
      55              :          * Must be set to true to indicate a response has been added, otherwise will return the
      56              :          * #OS_MGMT_ERR_QUERY_YIELDS_NO_ANSWER error.
      57              :          */
      58            1 :         bool *has_output;
      59              : };
      60              : 
      61              : /**
      62              :  * @}
      63              :  */
      64              : 
      65              : #ifdef __cplusplus
      66              : }
      67              : #endif
      68              : 
      69              : #endif