img_mgmt_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_MGMT_MCUMGR_GRP_IMG_MGMT_IMG_MGMT_CLIENT_H_
#define ZEPHYR_INCLUDE_MGMT_MCUMGR_GRP_IMG_MGMT_IMG_MGMT_CLIENT_H_
 
#include <inttypes.h>
#include <zephyr/mgmt/mcumgr/mgmt/mgmt_defines.h>
#include <zephyr/mgmt/mcumgr/grp/img_mgmt/img_mgmt.h>
#include <zephyr/mgmt/mcumgr/smp/smp_client.h>

 
#ifdef __cplusplus
extern "C" {
#endif

#define IMG_MGMT_CLIENT_HASH_MAX_LEN 64

struct mcumgr_image_list_flags {
        bool bootable: 1;
        bool pending: 1;
        bool confirmed: 1;
        bool active: 1;
        bool permanent: 1;
};

struct mcumgr_image_data {
        uint32_t slot_num;
        uint32_t img_num;
        char hash[IMG_MGMT_CLIENT_HASH_MAX_LEN];
        size_t hash_len;
        char version[IMG_MGMT_VER_MAX_STR_LEN + 1];
        struct mcumgr_image_list_flags flags;
};

struct mcumgr_image_state {
        enum mcumgr_err_t status;
        int image_list_length;
        struct mcumgr_image_data *image_list;
};

struct mcumgr_image_upload {
        enum mcumgr_err_t status;
        size_t image_upload_offset;
};

struct img_gr_upload {
        char sha256[IMG_MGMT_DATA_SHA_LEN];
        bool hash_initialized;
        size_t image_size;
        size_t offset;
        size_t upload_header_size;
        uint32_t image_num;
};

struct img_mgmt_client {
        struct smp_client_object *smp_client;
        struct img_gr_upload upload;
        int image_list_length;
        struct mcumgr_image_data *image_list;
        int status;
};

void img_mgmt_client_init(struct img_mgmt_client *client, struct smp_client_object *smp_client,
                          int image_list_size, struct mcumgr_image_data *image_list);

int img_mgmt_client_upload_init(struct img_mgmt_client *client, size_t image_size,
                                uint32_t image_num, const char *image_hash);

int img_mgmt_client_upload(struct img_mgmt_client *client, const uint8_t *data, size_t length,
                           struct mcumgr_image_upload *res_buf);

int img_mgmt_client_state_write(struct img_mgmt_client *client, const char *hash, size_t hash_len,
                                bool confirm, struct mcumgr_image_state *res_buf);

int img_mgmt_client_state_read(struct img_mgmt_client *client, struct mcumgr_image_state *res_buf);

 
int img_mgmt_client_erase(struct img_mgmt_client *client, uint32_t slot);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_MGMT_MCUMGR_GRP_IMG_MGMT_IMG_MGMT_CLIENT_H_ */