xf_fal.h

浏览该文件的文档.

 
#ifndef __XF_FAL_H__
#define __XF_FAL_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_fal_types.h"
 
#include "xf_fal_config_internal.h"
#include "xf_utils.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_fal_check_and_update_cache(void);
 
const xf_fal_ctx_t *xf_fal_get_ctx(void);
 
xf_err_t xf_fal_register_flash_device(const xf_fal_flash_dev_t *p_dev);
 
xf_err_t xf_fal_register_partition_table(
    const xf_fal_partition_t *p_table, size_t table_len);
 
xf_err_t xf_fal_unregister_flash_device(const xf_fal_flash_dev_t *p_dev);
 
xf_err_t xf_fal_unregister_partition_table(const xf_fal_partition_t *p_table);
 
bool xf_fal_check_register_state(void);
 
xf_err_t xf_fal_init(void);
 
xf_err_t xf_fal_deinit(void);
 
const xf_fal_flash_dev_t *xf_fal_flash_device_find(const char *name);
 
const xf_fal_flash_dev_t *xf_fal_flash_device_find_by_part(
    const xf_fal_partition_t *part);
 
const xf_fal_partition_t *xf_fal_partition_find(const char *name);
 
xf_err_t xf_fal_partition_read(
    const xf_fal_partition_t *part,
    size_t src_offset, void *dst, size_t size);
 
xf_err_t xf_fal_partition_write(
    const xf_fal_partition_t *part,
    size_t dst_offset, const void *src, size_t size);
 
xf_err_t xf_fal_partition_erase(
    const xf_fal_partition_t *part, size_t offset, size_t size);
 
xf_err_t xf_fal_partition_erase_all(const xf_fal_partition_t *part);
 
void xf_fal_show_part_table(void);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_FAL_H__