第1页 / 共27页
第2页 / 共27页
第3页 / 共27页
第4页 / 共27页
第5页 / 共27页
第6页 / 共27页
第7页 / 共27页
第8页 / 共27页
FATFS中文应用手册说明.doc
FATFS 中文资料
目录
1：f_mount..在 FatFs 模块上注册/注销一个工作区(文件系统对象)
2： f_open 创建/打开一个用于访问文件的文件对象
3：f_close 关闭一个打开的文件
4：f_read 从一个文件读取数据
5： f_write 写入数据到一个文件
6：f_lseek 移动一个打开的文件对象的文件读/写指针。也可以被用来扩展文件大小(簇预分配)
7：f_truncate 截断文件大小
8： f_sync 冲洗一个写文件的缓存信息
9： f_opendir 打开一个目录
10： f_readdir 读取目录项
11：f_getfree 获取空闲簇的数目
12： f_stat 获取文件状态
13： f_mkdir 创建一个目录
14； f_unlink 移除一个对象
15 ； f_chmod 修改一个文件或目录的属性。
16 ；f_utime 函数修改一个文件或目录的时间戳。
17；f_rename 重命名一个对象。
18 ； f_mkfs 在驱动器上创建一个文件系统
19 ；f_forward 读取文件数据并将其转发到数据流设备。
20 ：f_chdir 函数改变一个驱动器的当前目录。
21 ：f_chdrive 函数改变当前驱动器。
22； f_gets 从文件中读取一个字符串。
23 ：f_putc 函数向文件中写入一个字符。
24： f_puts
25：f_printf 函数向文件中写入一个格式化字符串。
26 磁盘 I/O 接口
由于 FatFs 模块完全与磁盘 I/O 层分开，因此底层磁盘 I/O 需要下列函数去读/写物理磁盘以及获取当前
时间。由于底层磁盘 I/O 模块并不是 FatFs 的一部分，因此它必须由用户提供。
27： disk_initialize 初始化磁盘驱动器
28 ：disk_status 获取当前磁盘的状态
29 ：disk_read 从磁盘驱动器中读取扇区
30 ：disk_write 向磁盘驱动器中写入扇区
31： disk_ioctl 控制设备特定的功能以及磁盘读写以外的其它功能
32： get_fattime 获取当前时间
f_puts 函数向文件中写入一个字符串。
了解 FatFs 文件系统的原理
掌握 FatFs 文件系统的移植方法
实现 SD 卡中文件的读写及其它操作
实验要求
在 SD 驱动移植实验的基础上，加上 FatFs 文件系统，实现 SD 卡中文件的读写及其它操作
实验 目的
•
•
•
FatFs
FatFS 是一个为小型嵌入式系统设计的通用 FAT(File Allocation Table)文件系统模块。FatFs 的编写遵
循 ANSI C，并且完全与磁盘 I/O 层分开。因此，它独立(不依赖)于硬件架构。它可以被嵌入到低成本的
微控制器中，如 AVR, 8051, PIC, ARM, Z80, 68K 等等，而不需要做任何修改。
代码和工作区占用空间非常小
Windows 兼容的 FAT 文件系统
不依赖于平台，易于移植
特点
•
•
•
•
多种配置选项：
多卷(物理驱动器和分区)
多 ANSI/OEM 代码页，包括 DBCS
在 ANSI/OEM 或 Unicode 中长文件名的支持
RTOS 的支持
多扇区大小的支持
只读，最少 API，I/O 缓冲区等等
应用程序接口
FatFs 模块为应用程序提供了下列函数，这些函数描述了 FatFs 能对 FAT 卷执行哪些操作。
[函数名] f_mount
在 FatFs 模块上注册/注销一个工作区(文件系统对象)
FRESULT f_mount (
BYTE Drive,
FATFS* FileSystemObject /* 工作区指针 */
/* 逻辑驱动器号 */
);
参数
Drive 注册/注销工作区的逻辑驱动器号(0-9)。
FileSystemObject 工作区(文件系统对象)指针。
返回值:FR_OK (0)函数成功。FR_INVALID_DRIVE，驱动器号无效
描述
f_mount 函数在 FatFs 模块上注册/注销一个工作区。 在使用任何其他文件函数之前，必须使用该函数为
每个卷注册一个工作区。要注销一个工作区，只要指定 FileSystemObject 为 NULL 即可，然后该工作区
可以被丢弃。
该函数只初始化给定的工作区，以及将该工作区的地址注册到内部表中，不访问磁盘 I/O 层。卷装入过程
是在 f_mount 函数后或存储介质改变后的第一次文件访问时完成的。
[函数名] f_open
创建/打开一个用于访问文件的文件对象
FRESULT f_open (
FIL* FileObject, /* 空白文件对象结构指针 */ 是不是把一个文件的的信息读取过来存放呢？
const XCHAR* FileName,
BYTE ModeFlags
/* 文件名指针 */
/* 模式标志 */
);
参数
FileObject……将被创建的文件对象结构的指针。
FileName：：ULL 结尾的字符串指针，该字符串指定了将被创建或打开的文件名。
ModeFlags
指定文件的访问类型和打开方法。它是由下列标志的一个组合指定的。
描述
指定读访问对象。可以从文件中读取数据。
指定写访问对象。可以向文件中写入数据。
如果文件存在，则打开；否则，创建一个新文件。
创建一个新文件。如果文件已存在，则创建失败。
创建一个新文件。如果文件已存在，则它将被截断并覆盖。
打开文件。如果文件不存在，则打开失败。(默认)
模式
FA_READ
与 FA_WRITE 结合可以进行读写访问。
FA_WRITE
与 FA_READ 结合可以进行读写访问。
FA_OPEN_EXISTING
FA_OPEN_ALWAYS
FA_CREATE_NEW
FA_CREATE_ALWAYS
注 意 ： 当 _FS_READONLY == 1 时 ， 模 式 标 志 FA_WRITE, FA_CREATE_ALWAYS,
FA_CREATE_NEW, FA_OPEN_ALWAYS 是无效的。
返回值
FR_OK (0)：：函数成功，该文件对象有效。
FR_NO_FILE：：找不到该文件。
FR_NO_PATH：；找不到该路径。
FR_INVALID_NAME：：文件名无效。
FR_INVALID_DRIVE：：驱动器号无效。
FR_EXIST：：该文件已存在。
FR_DENIED：：由于下列原因，所需的访问被拒绝：
•
•
•
FR_NOT_READY：
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_WRITE_PROTECTED
在存储介质被写保护的情况下，以写模式打开或创建文件对象。
FR_DISK_ERR
由于底层磁盘 I/O 接口函数中的一个错误，而导致该函数失败。
FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_ENABLED
逻辑驱动器没有工作区。
由于存在一个同名的只读文件或目录，而导致文件无法被创建。
由于目录表或磁盘已满，而导致文件无法被创建。
以写模式打开一个只读文件。
FR_NO_FILESYSTEM
磁盘上没有有效地 FAT 卷。
描述
如果函数成功，则创建一个文件对象。该文件对象被后续的读/写函数用来访问文件。如果想要关闭一个打
开的文件对象，则使用 f_close 函数。如果不关闭修改后的文件，那么文件可能会崩溃。
在使用任何文件函数之前，必须使用 f_mount 函数为驱动器注册一个工作区。只有这样，其他文件函数
才能正常工作。
例子(文件拷贝)
void main (void)
{
FATFS fs[2];
FIL fsrc, fdst;
BYTE buffer[4096];
FRESULT res;
UINT br, bw;
/* 逻辑驱动器的工作区(文件系统对象) */
/* 文件对象 */
/* 文件拷贝缓冲区 */
/* FatFs 函数公共结果代码 */
/* 文件读/写字节计数 */
/* 为逻辑驱动器注册工作区 */
f_mount(0, &fs[0]);
f_mount(1, &fs[1]);
/* 打开驱动器 1 上的源文件 */
res = f_open(&fsrc, "1:srcfile.dat", FA_OPEN_EXISTING | FA_READ);
if (res) die(res);
/* 在驱动器 0 上创建目标文件 */
res = f_open(&fdst, "0:dstfile.dat", FA_CREATE_ALWAYS | FA_WRITE);
if (res) die(res);
/* 拷贝源文件到目标文件 */
for (;;) {
res = f_read(&fsrc, buffer, sizeof(buffer), &br);
if (res || br == 0) break;
/* 文件结束错误 */
res = f_write(&fdst, buffer, br, &bw);
if (res || bw < br) break;
/* 磁盘满错误 */
}
/* 关闭打开的文件 */
f_close(&fsrc);
f_close(&fdst);
/* 注销工作区(在废弃前) */
f_mount(0, NULL);
f_mount(1, NULL);
}
[函数名] f_close
关闭一个打开的文件
FRESULT f_close (
FIL* FileObject
/* 文件对象结构的指针 */
);
参数
FileObject：：指向将被关闭的已打开的文件对象结构的指针。
返回值
FR_OK (0)文件对象已被成功关闭。>FR_DISK_ERR 由于底层磁盘 I/O 函数中的错误，而导致该函数失
败。FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT
文件对象无效。
描述
f_close 函数关闭一个打开的文件对象。无论向文件写入任何数据，文件的缓存信息都将被写回到磁盘。
该函数成功后，文件对象不再有效，并且可以被丢弃。如果文件对象是在只读模式下打开的，不需要使用
该函数，也能被丢弃。
[函数名] f_read
从一个文件读取数据
FRESULT f_read (
FIL* FileObject,
void* Buffer,
UINT ByteToRead,
UINT* ByteRead
/* 文件对象结构的指针 */
/* 存储读取数据的缓冲区的指针 */ 首先要定义一个至少 512 的内存
/* 要读取的字节数 */
/* 返回已读取字节数变量的指针 */
);
参数
FileObject：指向将被读取的已打开的文件对象结构的指针。
Buffer：指向存储读取数据的缓冲区的指针。
ByteToRead：要读取的字节数，UINT 范围内。
ByteRead：：指向返回已读取字节数的 UINT 变量的指针。在调用该函数后，无论结果如何，数值都是有
效的。
返回值
FR_OK (0)：：函数成功。
FR_DENIED：：由于文件是以非读模式打开的，而导致该函数被拒绝。
FR_DISK_ERR：：由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
FR_INT_ERR：：由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT 文件对象无效。
描述
文件对象中的读/写指针以已读取字节数增加。该函数成功后，应该检查 *ByteRead 来检测文件是否结
束。在读操作过程中，一旦 *ByteRead < ByteToRead ，则读/写指针到达了文件结束位置。
[函数名] f_write
写入数据到一个文件
FRESULT f_write (
FIL* FileObject,
const void* Buffer,
UINT ByteToWrite,
UINT* ByteWritten
/* 文件对象结构的指针 */
/* 存储写入数据的缓冲区的指针 */
/* 要写入的字节数 */
/* 返回已写入字节数变量的指针 */
);
参数
FileObject
指向将被写入的已打开的文件对象结构的指针。
Buffer
指向存储写入数据的缓冲区的指针。
ByteToRead
要写入的字节数，UINT 范围内。
ByteRead
指向返回已写入字节数的 UINT 变量的指针。在调用该函数后，无论结果如何，数值都是有效的。
返回值
FR_OK (0)
函数成功。
FR_DENIED
由于文件是以非写模式打开的，而导致该函数被拒绝。
FR_DISK_ERR
由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT 文件对象无效。
描述
文件对象中的读/写指针以已写入字节数增加。该函数成功后，应该检查 *ByteWritten 来检测磁盘是否
已满。在写操作过程中，一旦 *ByteWritten < *ByteToWritten ，则意味着该卷已满。
[函数名] f_lseek
移动一个打开的文件对象的文件读/写指针。也可以被用来扩展文件大小(簇预分配)。
FRESULT f_lseek (
FIL* FileObject,
DWORD Offset
/* 文件对象结构指针 */
/* 文件字节偏移 */
);
参数
FileObject
打开的文件对象的指针
Offset
相对于文件起始处的字节数
返回值
FR_OK (0)
函数成功。
FR_DISK_ERR
由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT 文件对象无效。
描述
f_lseek 函数当 FS_MINIMIZE <= 2 时可用。
offset 只能被指定为相对于文件起始处的字节数。当在写模式下指定了一个超过文件大小的 offset 时，文
件的大小将被扩展，并且该扩展的区域中的数据是未定义的。这适用于为快速写操作迅速地创建一个大的
文件。f_lseek 函数成功后，为了确保读/写指针已被正确地移动，必须检查文件对象中的成员 fptr。如果
fptr 不是所期望的值，则发生了下列情况之一。
•
•
例子
文件结束。指定的 offset 被钳在文件大小，因为文件已被以只读模式打开。
磁盘满。卷上没有足够的空闲空间去扩展文件大小。
/* 移动文件读/写指针到相对于文件起始处偏移为 5000 字节处 */
res = f_lseek(file, 5000);
/* 移动文件读/写指针到文件结束处，以便添加数据 */
res = f_lseek(file, file->fsize);
/* 向前 3000 字节 */
res = f_lseek(file, file->fptr + 3000);
/* 向后(倒带)2000 字节(注意溢出) */
res = f_lseek(file, file->fptr - 2000);
/* 簇预分配(为了防止在流写时缓冲区上溢 */
res = f_open(file, recfile, FA_CREATE_NEW | FA_WRITE); /* 创建一个文件 */
res = f_lseek(file, PRE_SIZE);
if (res || file->fptr != PRE_SIZE) ... /* 检查文件大小是否已被正确扩展 */
/* 预分配簇 */
res = f_lseek(file, DATA_START);
...
/* 没有簇分配延迟地记录数据流 */
res = f_truncate(file);
res = f_lseek(file, 0);
...
/* 截断未使用的区域 */
/* 移动到文件起始处 */
res = f_close(file);
[函数名] f_truncate
截断文件大小
FRESULT f_truncate (
FIL* FileObject
/* 文件对象结构指针 */
);
参数
FileObject
待截断的打开的文件对象的指针。
返回值
FR_OK (0
函数成功。
FR_DENIED
由于文件是以非写模式打开的，而导致该函数被拒绝。
FR_DISK_ERR
由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT 文件对象无效。
描述
f_truncate 函数当_FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。
f_truncate 函数截断文件到当前的文件读/写指针。当文件读/写指针已经指向文件结束时，该函数不起作
用。
[函数名] f_sync
冲洗一个写文件的缓存信息
FRESULT f_sync (
FIL* FileObject
/* 文件对象结构的指针 */
);
参数
FileObject
待冲洗的打开的文件对象的指针。
返回值
FR_OK (0)
函数成功。
FR_DISK_ERR
由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
FR_INT_ERR
由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。
FR_INVALID_OBJECT 文件对象无效。
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
