_xf_fal_flash_ops_t结构体 参考

flash 操作集。 更多...

#include <xf_fal_types.h>

_xf_fal_flash_ops_t 的协作图:

成员变量
xf_err_t(*	init )(void)
	初始化 flash 设备。
xf_err_t(*	deinit )(void)
	反初始化 flash 设备。
xf_err_t(*	read )(size_t src_offset, void *dst, size_t size)
	从 flash 的指定偏移地址读取数据。
xf_err_t(*	write )(size_t dst_offset, const void *src, size_t size)
	写数据到 flash 的指定偏移地址。
xf_err_t(*	erase )(size_t offset, size_t size)
	擦除 flash 的指定偏移地址指定长度。

详细描述

flash 操作集。

• 由对接层提供给 xf_fal 调用。
• 每个操作集合对应一个 flash 设备。
• 除 xf_fal_flash_ops_t.init 和 xf_fal_flash_ops_t.deinit 外，必须全部实现。 对于内部 flash, 不一定需要 xf_fal_flash_ops_t.init 和 xf_fal_flash_ops_t.deinit.

在文件 xf_fal_types.h 第 45 行定义.

结构体成员变量说明

init

xf_err_t(* init) (void)

初始化 flash 设备。

在文件 xf_fal_types.h 第 49 行定义.

deinit

xf_err_t(* deinit) (void)

反初始化 flash 设备。

在文件 xf_fal_types.h 第 53 行定义.

read

xf_err_t(* read) (size_t src_offset, void *dst, size_t size)

从 flash 的指定偏移地址读取数据。

注解

xf_fal 只保证读取大小不超过分区长度。 对于跨页的读取，接口需要自行处理。

注意

xf_fal 对于传入的 src_offset, 不 加上 flash 的起始地址。 对接层需要自行加上 xf_fal_flash_dev_t.addr .

参数

	src_offset	要读取的数据的地址。 已在 xf_fal 内加上分区的偏移地址。 若 flash 起始地址不为 0, 对接层需要自行加上 xf_fal_flash_dev_t.addr .
[out]	dst	指向读取缓冲区。 已在 xf_fal 内判断是否为 NULL.
	size	要读取的数据大小，单位：字节。 src_offset + size 不会大于分区长度。

返回

xf_err_t

• XF_OK 成功，当成功从 src_offset 读取了 size 字节数到 dst
• XF_FAIL 失败，其他情况

在文件 xf_fal_types.h 第 73 行定义.

write

xf_err_t(* write) (size_t dst_offset, const void *src, size_t size)

写数据到 flash 的指定偏移地址。

注解

xf_fal 只保证写入大小不超过分区长度。 对于跨页的写入，接口需要自行处理。

注意

xf_fal 对于传入的 dst_offset, 不 加上 flash 的起始地址。 对接层需要自行加上 xf_fal_flash_dev_t.addr .

参数

dst_offset	待写入数据的目标地址。 已在 xf_fal 内加上分区的偏移地址。 若 flash 起始地址不为 0, 对接层需要自行加上 xf_fal_flash_dev_t.addr .
src	指向数据来源缓冲区。 已在 xf_fal 内判断是否为 NULL.
size	要写入的数据大小，单位：字节。 dst_offset + size 不会大于分区长度。

返回

xf_err_t

• XF_OK 成功，当成功将 src 存的 size 字节写入到 dst_offset
• XF_FAIL 失败，其他情况

在文件 xf_fal_types.h 第 93 行定义.

erase

xf_err_t(* erase) (size_t offset, size_t size)

擦除 flash 的指定偏移地址指定长度。

参数

offset	待擦除的地址。 已在 xf_fal 内加上分区的偏移地址。
size	需要擦除的大小，单位：字节。 offset + size 不会大于分区长度。

返回

xf_err_t

• XF_OK 成功，当擦除指定地址的指定字节数
• XF_FAIL 失败，其他情况

在文件 xf_fal_types.h 第 105 行定义.

---

该结构体的文档由以下文件生成:

• components/xf_fal/xf_fal/src/xf_fal_types.h