Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
os_mgmt.h File Reference

Go to the source code of this file.

Data Structures

struct  os_mgmt_info_check
 
struct  os_mgmt_info_append
 

Macros

#define OS_MGMT_ID_ECHO   0
 Command IDs for OS management group.
 
#define OS_MGMT_ID_CONS_ECHO_CTRL   1
 
#define OS_MGMT_ID_TASKSTAT   2
 
#define OS_MGMT_ID_MPSTAT   3
 
#define OS_MGMT_ID_DATETIME_STR   4
 
#define OS_MGMT_ID_RESET   5
 
#define OS_MGMT_ID_MCUMGR_PARAMS   6
 
#define OS_MGMT_ID_INFO   7
 
#define OS_MGMT_ID_BOOTLOADER_INFO   8
 

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
}
 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)
}
 

Macro Definition Documentation

◆ OS_MGMT_ID_BOOTLOADER_INFO

#define OS_MGMT_ID_BOOTLOADER_INFO   8

◆ OS_MGMT_ID_CONS_ECHO_CTRL

#define OS_MGMT_ID_CONS_ECHO_CTRL   1

◆ OS_MGMT_ID_DATETIME_STR

#define OS_MGMT_ID_DATETIME_STR   4

◆ OS_MGMT_ID_ECHO

#define OS_MGMT_ID_ECHO   0

Command IDs for OS management group.

◆ OS_MGMT_ID_INFO

#define OS_MGMT_ID_INFO   7

◆ OS_MGMT_ID_MCUMGR_PARAMS

#define OS_MGMT_ID_MCUMGR_PARAMS   6

◆ OS_MGMT_ID_MPSTAT

#define OS_MGMT_ID_MPSTAT   3

◆ OS_MGMT_ID_RESET

#define OS_MGMT_ID_RESET   5

◆ OS_MGMT_ID_TASKSTAT

#define OS_MGMT_ID_TASKSTAT   2

Enumeration Type Documentation

◆ os_mgmt_err_code_t

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_info_formats

Enumerator
OS_MGMT_INFO_FORMAT_KERNEL_NAME 
OS_MGMT_INFO_FORMAT_NODE_NAME 
OS_MGMT_INFO_FORMAT_KERNEL_RELEASE 
OS_MGMT_INFO_FORMAT_KERNEL_VERSION 
OS_MGMT_INFO_FORMAT_BUILD_DATE_TIME 
OS_MGMT_INFO_FORMAT_MACHINE 
OS_MGMT_INFO_FORMAT_PROCESSOR 
OS_MGMT_INFO_FORMAT_HARDWARE_PLATFORM 
OS_MGMT_INFO_FORMAT_OPERATING_SYSTEM 
OS_MGMT_INFO_FORMAT_USER_CUSTOM_START