nv_task_adapt.h

浏览该文件的文档.

/*
 * Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2021-2022. All rights reserved.
 * Description: FLASH task shared definitions between the SCPU and A/PCPU.
 */
 
#ifndef FLASH_TASK_ETYPES_H
#define FLASH_TASK_ETYPES_H
 
#include "stdbool.h"
#include "errcode.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#define FLASH_TASK_NODE_IDENTIFIER        0xd3a71f85
 
/* Normal values of the flash_task_node.result field; anything else is an error being reported - must remain in sync
 * with the SCPU soc_errno.  The A/PCPU can use these defines in case they have a different set of error codes */
#define FLASH_TASK_DISCARD                0x80002040
#define FLASH_TASK_DISCARDED              0x80002041
#define FLASH_TASK_READY                  0x80002042
#define FLASH_TASK_BEING_PROCESSED        0x80002043
#define FLASH_TASK_COMPLETED              0x80003130
 
#define FLASH_TASK_ERASE_ALL_MAGIC_VALUE_LEN    10
 
typedef enum {
    /* Create KV storage in flash memory */
    FLASH_TASK_KV_PAGE_INIT = 0,
    /* A new or modification to an existing key-value */
    FLASH_TASK_KV_DATA,
    /* Modify the attribute on an existing key-value */
    FLASH_TASK_KV_ATTRIBUTE,
    /* Erase a key-value */
    FLASH_TASK_KV_ERASE,
    /* Write / overwrite some FOTA patch data in FLASH */
    FLASH_TASK_FOTA_DATA,
    /* Erase some FOTA patch data in FLASH and re-write the FOTA header */
    FLASH_TASK_FOTA_ERASE,
    /* Write some data to ACPU storage in FLASH */
    FLASH_TASK_ACPU_DATA,
    /* Erase some ACPU storage in FLASH */
    FLASH_TASK_ACPU_ERASE,
    /* Number of task types */
    FLASH_TASK_NUM_TYPES,
} flash_task_type_t;
 
 
typedef uint16_t kv_storage_key;
 
typedef struct {
    uint32_t        kv_addr;
    uint32_t        kv_size;
} flash_task_kv_init_t;
 
typedef struct {
    const uint8_t   *kvalue;
    kv_storage_key   key;
    uint16_t           kvalue_length;
    uint8_t            attribute;
    bool          force_write;
} flash_task_kv_data_t;
 
typedef struct {
    kv_storage_key  key;
    uint8_t         attribute;
} flash_task_kv_attribute_t;
 
typedef struct {
    kv_storage_key  key;
} flash_task_kv_erase_t;
 
typedef struct {
    kv_storage_key  key;
} flash_task_kv_backup_t;
 
typedef struct {
    /* Used to ensure erase all is not called by mistake. */
    uint8_t   magic_value[FLASH_TASK_ERASE_ALL_MAGIC_VALUE_LEN];
} kv_erase_all_t;
 
typedef struct {
    uint8_t   *src; /* Mapped address in calling core memory map, can in RAM or FLASH. */
    uint8_t   *dst; /* Mapped address in calling core memory map FOTA FLASH region
                     * - must not include the FOTA header. */
    uint16_t  length;
} flash_task_flash_data_t;
 
typedef struct {
    uint32_t  start_address; /* Core mapped address in FOTA FLASH region; must be at the start of a flash page. */
    uint32_t  length;        /* Must be a multiple of the page size. */
} flash_task_flash_erase_t;
 
typedef union {
    flash_task_kv_init_t      kv_region;
    flash_task_kv_data_t      kv;
    flash_task_kv_attribute_t kv_attribute;
    flash_task_kv_erase_t     kv_erase;
    flash_task_flash_data_t   flash;
    flash_task_flash_erase_t  flash_erase;
} task_node_data_t;
 
typedef struct owner_callback_data_t owner_callback;
 
typedef errcode_t (*flash_task_completed_callback)(errcode_t result, owner_callback *callback);
 
struct owner_callback_data_t {
    flash_task_completed_callback  func;
    /* Include any owner data to be available to the callback function upon execution. */
};
 
typedef struct flash_task_description_t flash_task_node;
struct flash_task_description_t {
    uint32_t                               identifier;
    volatile flash_task_node              *next;
    owner_callback                         *owner_callback;
    volatile uint32_t                      state_code;
    flash_task_type_t                        task;
    task_node_data_t                         data;
    uint32_t                               checksum;
};
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif /* _EXTERNAL_ETYPES_5GNBRBIV100_SHARED_FLASH_TASK_ETYPES_H */