99#ifndef H_OS_MGMT_
1010#define H_OS_MGMT_
1111
12+ /**
13+ * @brief MCUmgr OS Management API
14+ * @defgroup mcumgr_os_mgmt OS Management
15+ * @ingroup mcumgr_mgmt_api
16+ * @{
17+ */
18+
1219#ifdef __cplusplus
1320extern "C" {
1421#endif
1522
1623/**
17- * Command IDs for OS management group.
24+ * @name Command IDs for OS Management group.
25+ * @{
26+ */
27+ #define OS_MGMT_ID_ECHO 0 /**< Echo */
28+ #define OS_MGMT_ID_CONS_ECHO_CTRL 1 /**< Console/terminal echo control */
29+ #define OS_MGMT_ID_TASKSTAT 2 /**< Task statistics */
30+ #define OS_MGMT_ID_MPSTAT 3 /**< Memory pool statistics */
31+ #define OS_MGMT_ID_DATETIME_STR 4 /**< Date-time string */
32+ #define OS_MGMT_ID_RESET 5 /**< System reset */
33+ #define OS_MGMT_ID_MCUMGR_PARAMS 6 /**< MCUMgr parameters */
34+ #define OS_MGMT_ID_INFO 7 /**< OS/Application information */
35+ #define OS_MGMT_ID_BOOTLOADER_INFO 8 /**< Bootloader information */
36+ /**
37+ * @}
1838 */
19- #define OS_MGMT_ID_ECHO 0
20- #define OS_MGMT_ID_CONS_ECHO_CTRL 1
21- #define OS_MGMT_ID_TASKSTAT 2
22- #define OS_MGMT_ID_MPSTAT 3
23- #define OS_MGMT_ID_DATETIME_STR 4
24- #define OS_MGMT_ID_RESET 5
25- #define OS_MGMT_ID_MCUMGR_PARAMS 6
26- #define OS_MGMT_ID_INFO 7
27- #define OS_MGMT_ID_BOOTLOADER_INFO 8
2839
2940/**
3041 * Command result codes for OS management group.
@@ -52,57 +63,60 @@ enum os_mgmt_err_code_t {
5263 OS_MGMT_ERR_QUERY_RESPONSE_VALUE_NOT_VALID ,
5364};
5465
55- /* Bitmask values used by the os info command handler. Note that the width of this variable is
66+ /**
67+ * OS/Application information formats.
68+ *
69+ * Bitmask values used by the os info command handler. Note that the width of this variable is
5670 * 32-bits, allowing 32 flags, custom user-level implementations should start at
57- * OS_MGMT_INFO_FORMAT_USER_CUSTOM_START and reference that directly as additional format
71+ * # OS_MGMT_INFO_FORMAT_USER_CUSTOM_START and reference that directly as additional format
5872 * specifiers might be added to this list in the future.
5973 */
6074enum os_mgmt_info_formats {
61- OS_MGMT_INFO_FORMAT_KERNEL_NAME = BIT (0 ),
62- OS_MGMT_INFO_FORMAT_NODE_NAME = BIT (1 ),
63- OS_MGMT_INFO_FORMAT_KERNEL_RELEASE = BIT (2 ),
64- OS_MGMT_INFO_FORMAT_KERNEL_VERSION = BIT (3 ),
65- OS_MGMT_INFO_FORMAT_BUILD_DATE_TIME = BIT (4 ),
66- OS_MGMT_INFO_FORMAT_MACHINE = BIT (5 ),
67- OS_MGMT_INFO_FORMAT_PROCESSOR = BIT (6 ),
68- OS_MGMT_INFO_FORMAT_HARDWARE_PLATFORM = BIT (7 ),
69- OS_MGMT_INFO_FORMAT_OPERATING_SYSTEM = BIT (8 ),
70-
71- OS_MGMT_INFO_FORMAT_USER_CUSTOM_START = BIT (9 ),
75+ OS_MGMT_INFO_FORMAT_KERNEL_NAME = BIT (0 ), /**< Kernel name */
76+ OS_MGMT_INFO_FORMAT_NODE_NAME = BIT (1 ), /**< Node name */
77+ OS_MGMT_INFO_FORMAT_KERNEL_RELEASE = BIT (2 ), /**< Kernel release */
78+ OS_MGMT_INFO_FORMAT_KERNEL_VERSION = BIT (3 ), /**< Kernel version */
79+ OS_MGMT_INFO_FORMAT_BUILD_DATE_TIME = BIT (4 ), /**< Build date and time */
80+ OS_MGMT_INFO_FORMAT_MACHINE = BIT (5 ), /**< Machine */
81+ OS_MGMT_INFO_FORMAT_PROCESSOR = BIT (6 ), /**< Processor */
82+ OS_MGMT_INFO_FORMAT_HARDWARE_PLATFORM = BIT (7 ), /**< Hardware platform */
83+ OS_MGMT_INFO_FORMAT_OPERATING_SYSTEM = BIT (8 ), /**< Operating system */
84+
85+ OS_MGMT_INFO_FORMAT_USER_CUSTOM_START = BIT (9 ), /**< Custom user-level start bit */
7286};
7387
74- /* Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback */
88+ /* Structure provided in the # MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback */
7589struct os_mgmt_info_check {
76- /* Input format string from the mcumgr client */
90+ /** Input format string from the mcumgr client */
7791 struct zcbor_string * format ;
78- /* Bitmask of values specifying which outputs should be present */
92+ /** Bitmask of values specifying which outputs should be present */
7993 uint32_t * format_bitmask ;
80- /* Number of valid format characters parsed, must be incremented by 1 for each valid
94+ /** Number of valid format characters parsed, must be incremented by 1 for each valid
8195 * character
8296 */
8397 uint16_t * valid_formats ;
84- /* Needs to be set to true if the OS name is being provided by external code */
98+ /** Needs to be set to true if the OS name is being provided by external code */
8599 bool * custom_os_name ;
86100};
87101
88102/* Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_APPEND notification callback */
89103struct os_mgmt_info_append {
90- /* The format bitmask from the processed commands, the bits should be cleared once
104+ /** The format bitmask from the processed commands, the bits should be cleared once
91105 * processed, note that if all_format_specified is specified, the corresponding bits here
92106 * will not be set
93107 */
94108 uint32_t * format_bitmask ;
95- /* Will be true if the all 'a' specifier was provided */
109+ /** Will be true if the all 'a' specifier was provided */
96110 bool all_format_specified ;
97- /* The output buffer which the responses should be appended to. If prior_output is true, a
111+ /** The output buffer which the responses should be appended to. If prior_output is true, a
98112 * space must be added prior to the output response
99113 */
100114 uint8_t * output ;
101- /* The current size of the output response in the output buffer, must be updated to be the
115+ /** The current size of the output response in the output buffer, must be updated to be the
102116 * size of the output response after appending data
103117 */
104118 uint16_t * output_length ;
105- /* The size of the output buffer, including null terminator character, if the output
119+ /** The size of the output buffer, including null terminator character, if the output
106120 * response would exceed this size, the function must abort and return false to return a
107121 * memory error to the client
108122 */
@@ -115,4 +129,8 @@ struct os_mgmt_info_append {
115129}
116130#endif
117131
132+ /**
133+ * @}
134+ */
135+
118136#endif /* H_OS_MGMT_ */
0 commit comments