xt_fal.h

浏览该文件的文档.

 
#ifndef __XT_FAL_H__
#define __XT_FAL_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
/* fal_id 编码: 高 4 位为 flash_id (0-15)，低 4 位为分区索引 (0-15) */
#define XT_FAL_INVALID_ID           (0xFF)
 
/* fal_id 操作宏 */
#define XT_FAL_GET_FLASH_ID(fal_id)         (((fal_id) >> 4) & 0x0F)
#define XT_FAL_GET_PARTITION_IDX(fal_id)    ((fal_id) & 0x0F)
#define XT_FAL_MAKE_ID(flash_id, part_idx)  (((flash_id) << 4) | ((part_idx) & 0x0F))
 
/* flash 控制命令 */
#define XT_FAL_CTRL_INIT            (0x00000001)  
#define XT_FAL_CTRL_DEINIT          (0x00000002)  
 
/* 最大 Flash 设备数量（fal_id 高 4 位，最多 16 个） */
#ifndef XT_FAL_MAX_FLASH_COUNT
#define XT_FAL_MAX_FLASH_COUNT      16
#endif
 
/* 名字字符数 */
#ifndef XT_FAL_NAME_MAX
#define XT_FAL_NAME_MAX             16
#endif
 
/* ==================== [Typedefs] ========================================== */
 
#if !defined(XT_FAL_SIZE_T)
typedef uint32_t xt_fal_size_t;
#else
typedef XT_FAL_SIZE_T xt_fal_size_t;
#endif
 
struct xt_fal_flash_ops {
    void (*ctrl)(uint32_t cmd, void *arg);  
    int32_t (*read)(xt_fal_size_t offset, void *dst, xt_fal_size_t size);
    int32_t (*write)(xt_fal_size_t offset, const void *src, xt_fal_size_t size);
    int32_t (*erase)(xt_fal_size_t offset, xt_fal_size_t size);
};
 
struct xt_fal_flash {
    char name[XT_FAL_NAME_MAX]; 
    xt_fal_size_t addr;         
    xt_fal_size_t size;         
    xt_fal_size_t block_size;   
    xt_fal_size_t io_size;      
    struct xt_fal_flash_ops ops;   
};
 
struct xt_fal_partition {
    char name[XT_FAL_NAME_MAX]; 
    xt_fal_size_t addr;         
    xt_fal_size_t size;         
    xt_fal_size_t flags;        
};
 
/* ==================== [Global Prototypes] ================================= */

uint8_t xt_fal_register(const struct xt_fal_flash *flash,
                        const struct xt_fal_partition *part_table,
                        uint32_t part_count);

xt_err_t xt_fal_unregister(uint8_t flash_id,
                           const struct xt_fal_flash **out_flash,
                           const struct xt_fal_partition **out_part_table,
                           uint32_t *out_part_count);

xt_err_t xt_fal_init(void);

xt_err_t xt_fal_deinit(void);

uint8_t xt_fal_get_flash_id_by_name(const char *flash_name);

uint8_t xt_fal_get_id_by_name(const char *part_name);

const struct xt_fal_partition *xt_fal_get_partition_by_id(uint8_t fal_id);

const struct xt_fal_flash *xt_fal_get_flash_by_id(uint8_t fal_id);

int32_t xt_fal_partition_read(uint8_t fal_id, xt_fal_size_t offset, void *dst, xt_fal_size_t size);

int32_t xt_fal_partition_write(uint8_t fal_id, xt_fal_size_t offset, const void *src, xt_fal_size_t size);

int32_t xt_fal_partition_erase(uint8_t fal_id, xt_fal_size_t offset, xt_fal_size_t size);
 
/* ==================== [Macros] ============================================ */
  /* xt_fal */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_FAL_H__ */