Zephyr Project API 4.3.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

MCUmgr Image Management Callbacks API. More...

Data Structures

struct  img_mgmt_upload_check
 Structure provided in the MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK notification callback: This callback function is used to notify the application about a pending firmware upload packet from a client and authorise or deny it. More...
struct  img_mgmt_image_confirmed
 Structure provided in the MGMT_EVT_OP_IMG_MGMT_DFU_CONFIRMED notification callback: This callback function is used to notify the application about an image confirmation being executed successfully. More...
struct  img_mgmt_state_slot_encode
 Structure provided in the MGMT_EVT_OP_IMG_MGMT_IMAGE_SLOT_STATE notification callback: This callback function is used to allow applications or modules append custom fields to the image slot state response. More...
struct  img_mgmt_slot_info_image
 Structure provided in the MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_IMAGE notification callback: This callback function is called once per image when the slot info command is used, it can be used to return additional information/fields in the response. More...
struct  img_mgmt_slot_info_slot
 Structure provided in the MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_SLOT notification callback: This callback function is called once per slot per image when the slot info command is used, it can be used to return additional information/fields in the response. More...

Enumerations

enum  img_mgmt_group_events {
  MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 0) , MGMT_EVT_OP_IMG_MGMT_DFU_STOPPED = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 1) , MGMT_EVT_OP_IMG_MGMT_DFU_STARTED = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 2) , MGMT_EVT_OP_IMG_MGMT_DFU_PENDING = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 3) ,
  MGMT_EVT_OP_IMG_MGMT_DFU_CONFIRMED = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 4) , MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK_WRITE_COMPLETE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 5) , MGMT_EVT_OP_IMG_MGMT_IMAGE_SLOT_STATE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 6) , MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_IMAGE = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 7) ,
  MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_SLOT = MGMT_DEF_EVT_OP_ID(MGMT_EVT_GRP_IMG, 8) , MGMT_EVT_OP_IMG_MGMT_ALL = MGMT_DEF_EVT_OP_ALL(MGMT_EVT_GRP_IMG)
}
 MGMT event opcodes for image management group. More...

Detailed Description

MCUmgr Image Management Callbacks API.

Enumeration Type Documentation

◆ img_mgmt_group_events

#include </__w/bridle/bridle/workspace/zephyr/include/zephyr/mgmt/mcumgr/grp/img_mgmt/img_mgmt_callbacks.h>

MGMT event opcodes for image management group.

Enumerator
MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK 

Callback when a client sends a file upload chunk, data is img_mgmt_upload_check.

MGMT_EVT_OP_IMG_MGMT_DFU_STOPPED 

Callback when a DFU operation is stopped.

MGMT_EVT_OP_IMG_MGMT_DFU_STARTED 

Callback when a DFU operation is started.

MGMT_EVT_OP_IMG_MGMT_DFU_PENDING 

Callback when a DFU operation has finished being transferred.

MGMT_EVT_OP_IMG_MGMT_DFU_CONFIRMED 

Callback when an image has been confirmed.

data is img_mgmt_image_confirmed.

MGMT_EVT_OP_IMG_MGMT_DFU_CHUNK_WRITE_COMPLETE 

Callback when an image write command has finished writing to flash.

MGMT_EVT_OP_IMG_MGMT_IMAGE_SLOT_STATE 

Callback when an image slot's state is encoded for a response, data is img_mgmt_state_slot_encode.

MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_IMAGE 

Callback when a slot list command outputs fields for an image, data is img_mgmt_slot_info_image.

MGMT_EVT_OP_IMG_MGMT_SLOT_INFO_SLOT 

Callback when a slot list command outputs fields for a slot of an image, data is img_mgmt_slot_info_slot.

MGMT_EVT_OP_IMG_MGMT_ALL 

Used to enable all img_mgmt_group events.