upg_patch.h

浏览该文件的文档.

/*
 * Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2020-2021. All rights reserved.
 * @brief    FOTA patch application library public header
 */
 
#ifndef UPG_PATCH_H
#define UPG_PATCH_H
 
#include <stdint.h>
#include <stdbool.h>
#include "errcode.h"
#include "upg_common_porting.h"
#include "upg.h"
#include "upg_definitions.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif
 
#define DIFF_STATUS_FLASH_SIZE  0x800000
#define FLASH_PAGES             (DIFF_STATUS_FLASH_SIZE / UPG_FLASH_PAGE_SIZE)
 
#define NUM_BITS_PER_BYTE       8
 
typedef struct patch_description patch;
 
typedef void (*failfunc)(patch *desc);
 
typedef errcode_t (*fetch_image_contents)(patch *desc, uint32_t size, int32_t location, uint8_t *dest);
 
typedef errcode_t (*prep_image_contents_for_write)(patch *desc, uint32_t image_page_no, uint8_t *page_contents);
 
typedef errcode_t (*copy_recovered_buffer_to_flash_cache)(patch *desc, int32_t flash_page, uint8_t *recover_buffer);
 
typedef errcode_t (*plaintext_flash_cache_init)(patch *desc);
 
typedef errcode_t (*encrypt_one_flash_page)(upg_key_area_data_t *aes_ctrl,
                                            uint8_t *src, uint8_t *dst, int32_t ptxt_len);
 
struct patch_description {
    uint32_t   image_id;
    int32_t   maxsize;
    int32_t   newsize;
    int32_t   oldsize;
    uint32_t   num_new_pages;
    uint32_t   num_old_pages;
    uint32_t   num_maxsize_pages;
    uint32_t   new_sig_page;
    uint32_t   old_sig_page;
 
    /* If non zero, simulate a failure */
    int32_t   failpoint;
    failfunc failfn;
    uint32_t   patch_contents_ram_copy;
    uint32_t   patch_contents_flash_offset;
    uint32_t   patch_contents_len;
    bool  bottom_up;
    /* Memory layout info */
    uint32_t   image_flash_offset;
    uint32_t   image_flash_length;
    uint32_t   buffers_flash_offset;
    uint32_t   buffers_length;
    fetch_image_contents                 fetch_image_contents_fn;
    prep_image_contents_for_write        prep_image_contents_for_write_fn;
    copy_recovered_buffer_to_flash_cache copy_recovered_buffer_to_flash_cache_fn;
    plaintext_flash_cache_init           plaintext_flash_cache_init_fn;
    encrypt_one_flash_page               encrypt_flash_page_fn;
    bool  use_plain_text_cache;       /* Use a plaintext RAM cache of the flash image for patching, e.g SEMAIN */
    uint8_t    *image_cache;
    bool  image_encrypted;
    uint16_t   image_hdrs_len;        /* Length of images key area + code area hdr. */
    uint16_t   image_signature_size;  /* Length of image signature */
    upg_key_area_data_t key_area_aes_params;
};
 
errcode_t process_patch(patch *desc);
 
errcode_t fota_pkg_task_apply_code_diff(const upg_image_header_t *image);
 
#ifdef __cplusplus
#if __cplusplus
}
#endif
#endif
 
#endif /* UPG_PATCH_H */