第1页 / 共30页
第2页 / 共30页
第3页 / 共30页
第4页 / 共30页
第5页 / 共30页
第6页 / 共30页
第7页 / 共30页
第8页 / 共30页
FATFS文件系统应用程序手册(中文版).pdf
FATFS
文件系统应用程序技术手册（中文版）
-------基于 R0.009A 版本
FATFS文件系统应用程序目录：
函数名 描述
f_mount 注册/ 注销一个工作区
f_open 打开/ 创建一个文件
f_close 关闭一个文件
f_read 读取文件
f_write 写文件
f_lseek 移动读/ 写指针，扩展文件大小
f_truncate 截断文件大小
f_sync 清空缓冲数据
f_opendir 打开一个目录
f_readdir 读取一个目录项
f_getfree 获取空闲簇
f_stat 获取文件状态
f_mkdir 创建一个目录
f_unlink 删除一个文件或目录
f_chmod 修改属性
f_utime
f_rename
f_chdir 修改当前目录
f_chdrive 修改当前驱动器
f_getcwd
f_forward
f_mkfs
f_fdisk
f_gets
f_putc
f_puts
f_printf
f_tell
f_eof
f_size
f_error
在驱动器上创建一个文件系统
划分一个物理驱动器
读取一个字符串
写一个字符
写一个字符串
修改日间戳
删除/ 移动一个文件或目录
恢复当前目录
直接输出文件数据流
写一个格式化的字符串
测试一个文件是否到达文件末尾
获取当前读/ 写指针
获取一个文件的大小
测试一个文件是否出错
一．应用程序
1． 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 函数执行后或存储介质改变后的第
一次文件访问时完成的。
2. f_open
创建/ 打开一个用于访问文件的文件对象
FRESULT f_open (
FIL* FileObject, /* 空白文件对象结构指针 */
const XCHAR* FileName, /* 文件名指针 */
BYTE ModeFlags /* 模式标志 */
);
参数
FileObject 将被创建的文件对象结构的指针。
FileName NULL 结尾的字符串指针，该字符串指定了将被创建或打开的文件名。
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
FR_INT_ERR
件对象。
由于底层磁盘 I/O 接口函数中的一个错误，而导致该函
数失败。
由于一个错误的 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; /* FatFs 函数公共结果代码 */
UINT br, bw; /* 文件读/写字节计数 */
/* 为逻辑驱动器注册工作区 */
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, buffe r, 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);
}
3． 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 函数关闭一个打开的文件对象。无论向文件写入任何数据，文件的
缓存信息都将被写回到磁盘。
该函数执行成功后，文件对象不再有效，并且可以被丢弃。如果文件对象是
在只读模式下打开的，不需要使用该函数，也能被丢弃。
4． f_read
从一个文件读取数据
FRESULT f_read (
FIL* FileObject, /* 文件对象结构的指针 */
void* Buffer, /* 存储读取数据的缓冲区的指针 */
UINT ByteToRead, /* 要读取的字节数 */
UINT* ByteRead /* 返回已读取字节数变量的指针 */
);
参数
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 ，则表示
读/写指针到达了文件结束位置。
5． 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 ，
则意味着该卷已满。
6． 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 不是所期望的值，则发生了下列情况之一。
（1）.文件结束。指定的 offset 被限制在文件大小内，因为文件已被以只读模
式打开。
（2）.磁盘满。卷上没有足够的空闲空间去扩展文件大小。
示例
/* 移动文件读/ 写指针到相对于文件起始处偏移为 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);
7． 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 函数截断文件到当前的文件读/ 写指针。当文件读/ 写指针已经
指向文件结束时，该函数不起作用。
8． 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 文件对象无效。
描述
f_sync 函数当_FS_READONLY == 0 时可用。
f_sync 函数和 f_close 函数执行同样的过程，但是文件仍处于打开状态，
并且可以继续对文件执行读/写/ 移动指针操作。这适用于以写模式长时间打开
文件，比如数据记录器。
定期的或 f_write 后立即执行 f_sync 可以将由于突然断电或移去磁盘而导
致数据丢失的风险最小化。在 f_close 前立即执行 f_sync 没有作用，因为在
f_close 中执行了 f_sync 。换句话说，这两个函数的差异就是文件对象是不是
无效的。
9． f_opendir
打开一个目录
FRESULT f_opendir (
DIR* DirObject, /* 空白目录对象结构的指针 */
const XCHAR* DirName /* 目录名的指针 */
);
参数
DirObject 待创建的空白目录对象的指针。
DirName
返回值
FR_OK (0)
'\0' 结尾的字符串指针，该字符串指定了将被打开的目录名。
函数执行成功，目录对象被创建。该目录对象被后续调
用，用来读取目录项。
FR_NO_PATH
找不到路径。
FR_INVALID_NAME 路径名无效。
FR_INVALID_DRIVE 驱动器号无效。
FR_NOT_READY
由于驱动器中没有存储介质或任何其他原因，而导致磁
盘驱动器无法工作。
FR_DISK_ERR
FR_INT_ERR
由于底层磁盘 I/O 函数中的错误，而导致该函数失败。
由于一个错误的 FAT 结构或一个内部错误，而导致该函
数失败。
FR_NOT_ENABLED 逻辑驱动器没有工作区。
FR_NO_FILESYSTEM 磁盘上没有有效的 FAT 卷。
描述
f_opendir 函数当_FS_MINIMIZE <= 1 时可用。
f_opendir 函数打开一个已存在的目录，并为后续的调用创建一个目录对象。
该目录对象结构可以在任何时候不经任何步骤而被丢弃。
相关推荐
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
