ad_nvms.h

Go to the documentation of this file.

 
#ifndef AD_NVMS_H_
#define AD_NVMS_H_
 
#if dg_configNVMS_ADAPTER
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include "ad_flash.h"
#include "partition_def.h"
#include "sdk_defs.h"
 
/*
 * DEFINES
 ****************************************************************************************
 */
 
typedef void *nvms_t;
 
void ad_nvms_init(void);
 
nvms_t ad_nvms_open(nvms_partition_id_t id);
 
size_t ad_nvms_get_size(nvms_t handle);
 
int ad_nvms_read(nvms_t handle, uint32_t addr, uint8_t *buf, uint32_t len);
 
int ad_nvms_write(nvms_t handle, uint32_t addr, const uint8_t *buf, uint32_t size);
 
bool ad_nvms_erase_region(nvms_t handle, uint32_t addr, size_t size);
 
size_t ad_nvms_get_pointer(nvms_t handle, uint32_t addr, size_t size, const void **ptr);
 
size_t ad_nvms_erase_size(nvms_t handle);
 
struct partition_t;
 
typedef struct driver_t {
        bool (* bind)(struct partition_t *part);
        size_t (* get_size)(struct partition_t *part);
        int (* read)(struct partition_t *part, uint32_t addr, uint8_t *buf, uint32_t size);
        int (* write)(struct partition_t *part, uint32_t addr, const uint8_t *buf, uint32_t size);
        bool (* erase)(struct partition_t *part, uint32_t addr, uint32_t size);
        size_t (* get_ptr)(struct partition_t *part, uint32_t addr, uint32_t size, const void **ptr);
        void (* flush)(struct partition_t *part, bool free_mem);
} partition_driver_t;
 
typedef struct partition_t {
        struct partition_t *next;        
        const partition_driver_t *driver;
        void *driver_data;               
        partition_entry_t data;          
} partition_t;
 
size_t ad_nvms_get_partition_count(void);
 
bool ad_nvms_get_partition_info(size_t index, partition_entry_t *info);
 
bool ad_nvms_no_cache_flushing(nvms_t handle, uint32_t base, uint32_t size);
 
__STATIC_INLINE void ad_nvms_mandatory_cache_flushing(void)
{
        ad_flash_skip_cache_flushing(AD_FLASH_ALWAYS_FLUSH_CACHE, 0);
}
 
void ad_nvms_flush(nvms_t handle, bool free_mem);
 
#endif /* dg_configNVMS_ADAPTER */
 
#endif /* AD_NVMS_H_ */