nv.h

浏览该文件的文档.

 
#ifndef NV_H
#define NV_H
 
#include <stdint.h>
#include <stdbool.h>
#include "errcode.h"
#include "key_id.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
typedef void (*nv_storage_completed_callback)(errcode_t result);
 
typedef void (*nv_changed_notify_func)(uint16_t key);
 
typedef struct {
    bool permanent;     
    bool encrypted;     
    bool non_upgrade;   
    uint8_t reserve;    
} nv_key_attr_t;
 
typedef struct {
    uint32_t total_space;       
    uint32_t used_space;        
    uint32_t reclaimable_space; 
    uint32_t corrupted_space;   
    uint32_t max_key_space;     
} nv_store_status_t;
 
typedef enum {
    KEY_ID_REGION0,        
    KEY_ID_REGION1,        
    KEY_ID_REGION2,        
    KEY_ID_REGION3,        
    KEY_ID_REGION4,        
    KEY_ID_REGION5,        
    KEY_ID_REGION6,        
    KEY_ID_REGION7,        
    KEY_ID_REGION8,        
    KEY_ID_REGION9,        
    KEY_ID_REGION10,       
    KEY_ID_REGION11,       
    KEY_ID_REGION12,       
    KEY_ID_REGION13,       
    KEY_ID_REGION14,       
    KEY_ID_REGION15,       
    KEY_ID_REGION_MAX_NUM, 
} nv_key_id_region_t;
 
typedef struct {
    bool region_mode[KEY_ID_REGION_MAX_NUM];     
} nv_restore_mode_t;
 
typedef struct {
    bool region_mode[KEY_ID_REGION_MAX_NUM];     
} nv_backup_mode_t;
 
void uapi_nv_init(void);
 
errcode_t uapi_nv_write(uint16_t key, const uint8_t *kvalue, uint16_t kvalue_length);
 
 
errcode_t uapi_nv_write_with_attr(uint16_t key, const uint8_t *kvalue, uint16_t kvalue_length, nv_key_attr_t *attr,
                                  nv_storage_completed_callback func);
 
errcode_t uapi_nv_read(uint16_t key, uint16_t kvalue_max_length, uint16_t *kvalue_length, uint8_t *kvalue);
 
errcode_t uapi_nv_read_with_attr(uint16_t key, uint16_t kvalue_max_length, uint16_t *kvalue_length, uint8_t *kvalue,
                                 nv_key_attr_t *attr);
 
errcode_t uapi_nv_get_store_status(nv_store_status_t *status);
 
errcode_t uapi_nv_backup(const nv_backup_mode_t *backup_mode);
 
errcode_t uapi_nv_set_restore_mode_all(void);
 
errcode_t uapi_nv_set_restore_mode_partitial(const nv_restore_mode_t *restore_mode);
 
 
errcode_t uapi_nv_flush(void);
 
errcode_t uapi_nv_register_change_notify_proc(uint16_t min_key, uint16_t max_key, nv_changed_notify_func func);
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif /* NV_H */