os_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 mcumgr authors
 * Copyright (c) 2022 Laird Connectivity
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef H_OS_MGMT_
#define H_OS_MGMT_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OS_MGMT_ID_ECHO            0 
#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 
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,
};
 
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), 
};
 
/* Structure provided in the #MGMT_EVT_OP_OS_MGMT_INFO_CHECK notification callback */
struct os_mgmt_info_check {
        struct zcbor_string *format;
        uint32_t *format_bitmask;
        uint16_t *valid_formats;
        bool *custom_os_name;
};
 
/* Structure provided in the MGMT_EVT_OP_OS_MGMT_INFO_APPEND notification callback */
struct os_mgmt_info_append {
        uint32_t *format_bitmask;
        bool all_format_specified;
        uint8_t *output;
        uint16_t *output_length;
        uint16_t buffer_size;
        /* If there has been prior output, must be set to true if a response has been output */
        bool *prior_output;
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* H_OS_MGMT_ */