OS Management

MCUmgr OS Management API . More...

Topics
	OS Management Callbacks
	MCUmgr OS Management Callbacks API .
	OS Management Client
	MCUmgr OS Management Client API .

Data Structures
struct	os_mgmt_info_check
	Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback. More...
struct	os_mgmt_info_append
	Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_APPEND notification callback. More...

Enumerations
enum	os_mgmt_err_code_t {   OS_MGMT_ERR_OK = 0 , OS_MGMT_ERR_UNKNOWN , OS_MGMT_ERR_INVALID_FORMAT , OS_MGMT_ERR_QUERY_YIELDS_NO_ANSWER ,   OS_MGMT_ERR_RTC_NOT_SET , OS_MGMT_ERR_RTC_COMMAND_FAILED , OS_MGMT_ERR_QUERY_RESPONSE_VALUE_NOT_VALID , OS_MGMT_ERR_HEAP_STATS_FETCH_FAILED }
	Command result codes for OS management group. More...
enum	os_mgmt_info_formats {   OS_MGMT_INFO_FORMAT_KERNEL_NAME = BIT(0) , OS_MGMT_INFO_FORMAT_NODE_NAME = BIT(1) , OS_MGMT_INFO_FORMAT_KERNEL_RELEASE = BIT(2) , OS_MGMT_INFO_FORMAT_KERNEL_VERSION = BIT(3) ,   OS_MGMT_INFO_FORMAT_BUILD_DATE_TIME = BIT(4) , OS_MGMT_INFO_FORMAT_MACHINE = BIT(5) , OS_MGMT_INFO_FORMAT_PROCESSOR = BIT(6) , OS_MGMT_INFO_FORMAT_HARDWARE_PLATFORM = BIT(7) ,   OS_MGMT_INFO_FORMAT_OPERATING_SYSTEM = BIT(8) , OS_MGMT_INFO_FORMAT_USER_CUSTOM_START = BIT(9) }
	OS/Application information formats. More...

Command IDs for OS Management group.
#define	OS_MGMT_ID_ECHO   0
	Echo.
#define	OS_MGMT_ID_CONS_ECHO_CTRL   1
	Console/terminal echo control.
#define	OS_MGMT_ID_TASKSTAT   2
	Task statistics.
#define	OS_MGMT_ID_MPSTAT   3
	Memory pool statistics.
#define	OS_MGMT_ID_DATETIME_STR   4
	Date-time string.
#define	OS_MGMT_ID_RESET   5
	System reset.
#define	OS_MGMT_ID_MCUMGR_PARAMS   6
	MCUMgr parameters.
#define	OS_MGMT_ID_INFO   7
	OS/Application information.
#define	OS_MGMT_ID_BOOTLOADER_INFO   8
	Bootloader information.

Detailed Description

MCUmgr OS Management API .

Macro Definition Documentation

OS_MGMT_ID_BOOTLOADER_INFO

#define OS_MGMT_ID_BOOTLOADER_INFO   8

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Bootloader information.

OS_MGMT_ID_CONS_ECHO_CTRL

#define OS_MGMT_ID_CONS_ECHO_CTRL   1

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Console/terminal echo control.

OS_MGMT_ID_DATETIME_STR

#define OS_MGMT_ID_DATETIME_STR   4

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Date-time string.

OS_MGMT_ID_ECHO

#define OS_MGMT_ID_ECHO   0

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Echo.

OS_MGMT_ID_INFO

#define OS_MGMT_ID_INFO   7

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

OS/Application information.

OS_MGMT_ID_MCUMGR_PARAMS

#define OS_MGMT_ID_MCUMGR_PARAMS   6

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

MCUMgr parameters.

OS_MGMT_ID_MPSTAT

#define OS_MGMT_ID_MPSTAT   3

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Memory pool statistics.

OS_MGMT_ID_RESET

#define OS_MGMT_ID_RESET   5

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

System reset.

OS_MGMT_ID_TASKSTAT

#define OS_MGMT_ID_TASKSTAT   2

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Task statistics.

Enumeration Type Documentation

os_mgmt_err_code_t

enum os_mgmt_err_code_t

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

Command result codes for OS management group.

Enumerator
OS_MGMT_ERR_OK	No error, this is implied if there is no ret value in the response.
OS_MGMT_ERR_UNKNOWN	Unknown error occurred.
OS_MGMT_ERR_INVALID_FORMAT	The provided format value is not valid.
OS_MGMT_ERR_QUERY_YIELDS_NO_ANSWER	Query was not recognized.
OS_MGMT_ERR_RTC_NOT_SET	RTC is not set.
OS_MGMT_ERR_RTC_COMMAND_FAILED	RTC command failed.
OS_MGMT_ERR_QUERY_RESPONSE_VALUE_NOT_VALID	Query was recognized but there is no valid value for the response.
OS_MGMT_ERR_HEAP_STATS_FETCH_FAILED	Heap statistic fetch failed.

os_mgmt_info_formats

enum os_mgmt_info_formats

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>

OS/Application information formats.

Bitmask values used by the os info command handler. Note that the width of this variable is 32-bits, allowing 32 flags, custom user-level implementations should start at OS_MGMT_INFO_FORMAT_USER_CUSTOM_START and reference that directly as additional format specifiers might be added to this list in the future.

Enumerator
OS_MGMT_INFO_FORMAT_KERNEL_NAME	Kernel name.
OS_MGMT_INFO_FORMAT_NODE_NAME	Node name.
OS_MGMT_INFO_FORMAT_KERNEL_RELEASE	Kernel release.
OS_MGMT_INFO_FORMAT_KERNEL_VERSION	Kernel version.
OS_MGMT_INFO_FORMAT_BUILD_DATE_TIME	Build date and time.
OS_MGMT_INFO_FORMAT_MACHINE	Machine.
OS_MGMT_INFO_FORMAT_PROCESSOR	Processor.
OS_MGMT_INFO_FORMAT_HARDWARE_PLATFORM	Hardware platform.
OS_MGMT_INFO_FORMAT_OPERATING_SYSTEM	Operating system.
OS_MGMT_INFO_FORMAT_USER_CUSTOM_START	Custom user-level start bit.