upg.h

浏览该文件的文档.

 
#ifndef UPG_INTERFACE_H
#define UPG_INTERFACE_H
 
#include <stdint.h>
#include <stdbool.h>
#include "errcode.h"
#include "upg_definitions_porting.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif
 
#define SHA_256_LENGTH  32
 
#define DIE_ID_LEN      16
 
#define PROTECT_KEY_LEN 16
 
#define IV_LEN          16
 
typedef enum upg_result {
    UPG_RESULT_UPDATE_SUCCESS,           
    UPG_RESULT_VERIFY_HEAD_FAILED,       
    UPG_RESULT_VERIFY_HASH_TABLE_FAILED, 
    UPG_RESULT_VERIFY_IMAGE_FAILED,      
    UPG_RESULT_VERIFY_OLD_IMAGE_FAILED,  
    UPG_RESULT_DECOMPRESS_IMAGE_FAILED,  
    UPG_RESULT_DECRYPT_IMAGE_FAILED,     
    UPG_RESULT_RECRYPT_IMAGE_FAILED,     
    UPG_RESULT_DIFF_IMAGE_FAILED,        
    UPG_RESULT_UPDATE_IMAGE_FAILED,      
    UPG_RESULT_PROCESS_NV_FAILED,        
    UPG_RESULT_VERIFY_VERSION_FAILED,    
    UPG_RESULT_IMAGE_ID_FAILED,          
    UPG_RESULT_RETRY_ALL_FAILED,          
    UPG_RESULT_MAX,                      
} upg_result_t;
 
typedef enum upg_status {
    UPG_STATUS_SUCC,     
    UPG_STATUS_FAIL,     
    UPG_STATUS_UPDATING, 
    UPG_STATUS_NONE      
} upg_status_t;
 
typedef struct upg_key_area_data {
    uint32_t image_id;            
    uint32_t struct_version;      
    uint32_t struct_length;       
    uint32_t signature_length;    
    uint32_t key_owner_id;        
    uint32_t key_id;              
    uint32_t key_alg;             
    uint32_t ecc_curve_type;      
    uint32_t key_length;          
    uint32_t fota_key_version_ext;
    uint32_t mask_fota_key_version_ext;
    uint32_t msid_ext;            
    uint32_t mask_msid_ext;       
    uint32_t maintenance_mode;    
    uint8_t die_id[DIE_ID_LEN];   
    uint32_t fota_info_addr;      
    uint8_t reserved[KEY_AREA_RESERVED_LEN];         
    uint8_t fota_external_public_key[PUBLIC_KEY_LEN];
    uint8_t sig_fota_key_area[SIG_LEN];
} upg_key_area_data_t;
 
typedef struct upg_fota_info_data {
    uint32_t image_id;             
    uint32_t struct_version;       
    uint32_t struct_length;        
    uint32_t signature_length;     
    uint32_t fota_version_ext;     
    uint32_t mask_fota_version_ext;
    uint32_t msid_ext;             
    uint32_t mask_msid_ext;        
    uint32_t image_hash_table_addr;
    uint32_t image_hash_table_length;
    uint8_t image_hash_table_hash[SHA_256_LENGTH];
    uint32_t image_num;            
    uint32_t hardware_id;          
    uint8_t user_defined[INFO_AREA_USER_LEN];      
    uint8_t sign_fota_info[SIG_LEN];
} upg_fota_info_data_t;
 
typedef struct upg_image_hash_node {
    uint32_t image_id;                  
    uint32_t image_addr;                
    uint32_t image_length;              
    uint8_t image_hash[SHA_256_LENGTH]; 
} upg_image_hash_node_t;
 
typedef struct upg_package_header {
    upg_key_area_data_t  key_area;
    upg_fota_info_data_t info_area;
} upg_package_header_t;
 
typedef struct upg_image_header {
    uint32_t header_magic; 
    uint32_t image_id;     
    uint32_t image_offset; 
    uint32_t image_len;    
    uint8_t image_hash[SHA_256_LENGTH]; 
    uint32_t old_image_len; 
    uint8_t old_image_hash[SHA_256_LENGTH]; 
    uint32_t new_image_len;             
    uint32_t version_ext;               
    uint32_t version_mask;              
    uint32_t decompress_flag;           
    uint32_t re_enc_flag;               
    uint32_t root_key_type;             
    uint8_t enc_pk_l1[PROTECT_KEY_LEN]; 
    uint8_t enc_pk_l2[PROTECT_KEY_LEN]; 
    uint8_t iv[IV_LEN];       
    uint8_t padding[4];       
} upg_image_header_t;
 
typedef void (*uapi_upg_write_done_cb)(errcode_t result);
 
typedef void (*uapi_upg_progress_cb)(uint32_t percent);
 
typedef errcode_t (*uapi_upg_user_defined_check)(uint8_t *user_info, uint32_t info_len, uintptr_t param);
 
typedef void *(*upg_func_malloc)(const uint32_t size);
 
typedef void (*upg_func_free)(void *ptr);
 
typedef void (*upg_func_serial_putc)(const char c);
 
typedef struct upg_func {
    upg_func_malloc malloc;            
    upg_func_free free;                
    upg_func_serial_putc serial_putc;  
} upg_func_t;
 
typedef struct upg_prepare_info {
    uint32_t package_len;   
} upg_prepare_info_t;
 
errcode_t uapi_upg_init(const upg_func_t *func_list);
 
errcode_t uapi_upg_start(void);
 
errcode_t uapi_upg_register_progress_callback(uapi_upg_progress_cb func);
 
errcode_t uapi_upg_get_result(upg_result_t *result, uint32_t *last_image_index);
 
upg_status_t uapi_upg_get_status(void);
 
errcode_t uapi_upg_prepare(upg_prepare_info_t *prepare_info);
 
errcode_t uapi_upg_reset_upgrade_flag(void);
 
errcode_t uapi_upg_write_package_async(uint32_t offset, const uint8_t *buff, uint16_t len,
                                       uapi_upg_write_done_cb callback);
 
errcode_t uapi_upg_write_package_sync(uint32_t offset, const uint8_t *buff, uint16_t len);
 
errcode_t uapi_upg_read_package(uint32_t offset, uint8_t *buff, uint32_t len);
 
uint32_t uapi_upg_get_storage_size(void);
 
errcode_t uapi_upg_request_upgrade(bool reset);
 
errcode_t uapi_upg_verify_file_head(const upg_package_header_t *pkg_header);
 
errcode_t uapi_upg_verify_file_image(const upg_image_header_t *img_header,
                                     const uint8_t *hash, uint32_t hash_len, bool verify_old);
 
errcode_t uapi_upg_verify_file(const upg_package_header_t *pkg_header);
 
void uapi_upg_register_user_defined_verify_func(uapi_upg_user_defined_check func, uintptr_t param);
 
#ifdef __cplusplus
#if __cplusplus
}
#endif
#endif
 
#endif /* UPG_INTERFACE_H */