FatFS文件系统 （指令详解）

    来源：http://blog.chinaunix.net/uid-20766895-id-2827635.html

 

       FATFS是一个为小型嵌入式系统设计的通用FAT(File Allocation Table)文件系统模块。FatFs 的编写遵循ANSI C，并且完全与磁盘I/O层分开。因此，它独立(不依赖)于硬件架构。它可以被嵌入到低成本的微控制器中，如AVR, 8051, PIC, ARM, Z80, 68K 等等，而不需要做任何修改。  

    FatFs 模块为应用程序提供了下列函数：

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  

由于下列原因，所需的访问被拒绝： 

n  ▲ 以写模式打开一个只读文件。   

n  ▲ 由于存在一个同名的只读文件或目录，而导致文件无法被创建。   

n  ▲ 由于目录表或磁盘已满，而导致文件无法被创建。   

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 函数为驱动器注册一个工作区。只有这样，其他文件函数才能正常工作。  

 

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 不是所期望的值，则发生了下列情况之一。   

n   ★ 文件结束。指定的 offset 被钳在文件大小，因为文件已被以只读模式打开。   

n   ★ 磁盘满。卷上没有足够的空闲空间去扩展文件大小。   

 

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  

'\0' 结尾的字符串指针，该字符串指定了将被打开的目录名。   

返回值   

FR_OK (0)  

函数成功，目录对象被创建。该目录对象被后续调用，用来读取目录项。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_opendir 函数当 _FS_MINIMIZE <= 1 时可用。  

f_opendir 函数打开一个已存在的目录，并为后续的调用创建一个目录对象。该目录对象结构可以在任何时候不经任何步骤而被丢弃。   

 

10.f_readdir 

读取目录项   

FRESULT f_readdir (DIR* DirObject,          /*  指向打开的目录对象结构的指针  */ 

  FILINFO* FileInfo        /*  指向文件信息结构的指针  */ 

); 

参数   

DirObject  

打开的目录对象的指针。   

FileInfo  

存储已读取项的文件信息结构指针。   

返回值   

FR_OK (0)  

函数成功。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_INVALID_OBJECT  文件对象无效。   

 

f_readdir 函数当 _FS_MINIMIZE <= 1 时可用。  

f_readdir 函数顺序读取目录项。目录中的所有项可以通过重复调用 f_readdir 函数被读取。当所有目录项已被读取并且没有项要读取时，该函数没有任何错误地返回一个空字符串到 f_name[] 成员中。当 FileInfo 给定一个空指针时，目录对象的读索引将被回绕。  

当 LFN 功能被使能时，在使用 f_readdir 函数之前，文件信息结构中的 lfname 和 lfsize 必须被初始化为有效数值。 lfname 是一个返回长文件名的字符串缓冲区指针。 lfsize 是以字符为单位的字符串缓冲区的大小。如果读缓冲区或 LFN 工作缓冲区的大小 ( 对于 LFN) 不足，或者对象没有 LFN ，则一个空字符串将被返回到 LFN 读缓冲区。如果 LFN 包含任何不能被转换为 OEM 代码的字符，则一个空字符串将被返回，但是这不是 Unicode API配置的情况。当 lfname 是一个空字符串时，没有 LFN 的任何数据被返回。当对象没有 LFN 时，任何小型大写字母可以被包含在 SFN 中。  

当相对路径功能被使能 (_FS_RPATH == 1) 时， "." 和 ".." 目录项不会被过滤掉，并且它将出现在读目录项中。   

 

11.f_getfree 

获取空闲簇的数目   

FRESULT f_getfree ( 

  const XCHAR* Path,       /*  驱动器的根目录  */ 

  DWORD* Clusters,         /*  存储空闲簇数目变量的指针  */ 

  FATFS** FileSystemObject /*  文件系统对象指针的指针  */ 

); 

参数   

Path  

'\0' 结尾的字符串指针，该字符串指定了逻辑驱动器的目录。   

Clusters  

存储空闲簇数目的 DWORD 变量的指针。

FileSystemObject  

相应文件系统对象指针的指针。   

返回值   

FR_OK (0)  

函数成功。 *Clusters 表示空闲簇的数目，并且 *FileSystemObject 指向文件系统对象。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_getfree 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时有效。  

f_getfree 函数获取驱动器上空闲簇的数目。文件系统对象中的成员 csize 是每簇中的扇区数，因此，以扇区为单位的空闲空间可以被计算出来。当 FAT32 卷上的 FSInfo 结构不同步时，该函数返回一个错误的空闲簇计数。   

 

12.f_stat 

获取文件状态   

FRESULT f_stat ( 

  const XCHAR* FileName,   /*  文件名或目录名的指针  */ 

  FILINFO* FileInfo        /* FILINFO 结构的指针  */ 

); 

参数   

FileName  

'\0' 结尾的字符串指针，该字符串指定了待获取其信息的文件或目录。   

FileInfo  

存储信息的空白 FILINFO 结构的指针。   

返回值   

FR_OK (0)  

函数成功。   

FR_NO_FILE  

找不到文件或目录。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_stat 函数当 _FS_MINIMIZE == 0 时可用。  

f_stat 函数获取一个文件或目录的信息。信息的详情，请参考 FILINFO 结构和 f_readdir 函数。   

13.f_mkdir 

创建一个目录   

FRESULT f_mkdir ( 

  const XCHAR* DirName /*  目录名的指针  */ 

); 

参数   

DirName  

'\0' 结尾的字符串指针，该字符串指定了待创建的目录名。   

返回值   

FR_OK (0)  

函数成功。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_DENIED  

由于目录表或磁盘满，而导致目录不能被创建。   

FR_EXIST  

已经存在同名的文件或目录。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_WRITE_PROTECTED  

存储介质被写保护。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_mkdir 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。  

f_mkdir 函数创建一个新目录。   

14.f_unlink 

移除一个对象   

FRESULT f_unlink ( 

  const XCHAR* FileName  /*  对象名的指针  */ 

); 

参数   

FileName  

'\0' 结尾的字符串指针，该字符串指定了一个待移除的对象。

返回值   

FR_OK (0)  

函数成功。   

FR_NO_FILE  

找不到文件或目录。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_DENIED  

由于下列原因之一，而导致该函数被拒绝： 

n   ★对象具有只读属性   

n   ★目录不是空的   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_WRITE_PROTECTED  

存储介质被写保护。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_unlink 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。  

f_unlink 函数移除一个对象。不要移除打开的对象或当前目录。

 

15.f_chmod 

修改一个文件或目录的属性。   

FRESULT f_chmod ( 

  const XCHAR* FileName, /*  文件或目录的指针  */ 

  BYTE Attribute,        /*  属性标志  */ 

  BYTE AttributeMask     /*  属性掩码  */ 

); 

参数   

FileName  

'\0' 结尾的字符串指针，该字符串指定了一个待被修改属性的文件或目录。   

Attribute  

待被设置的属性标志，可以是下列标志的一个或任意组合。指定的标志被设置，其他的被清除。

 

属性	描述
AM_RDO	只读
AM_ARC	存档
AM_SYS	系统
AM_HID	隐藏

AttributeMask  

属性掩码，指定修改哪个属性。指定的属性被设置或清除。   

返回值   

FR_OK (0)  

函数成功。   

FR_NO_FILE  

找不到文件或目录。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_WRITE_PROTECTED  

存储介质被写保护。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

  

f_chmod 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。  

f_chmod 函数修改一个文件或目录的属性。   

16.f_utime 

f_utime 函数修改一个文件或目录的时间戳。   

FRESULT f_utime ( 

  const XCHAR* FileName,   /*  文件或目录路径的指针  */ 

  const FILINFO* TimeDate  /*  待设置的时间和日期  */ 

); 

参数   

FileName  

'\0' 结尾的字符串的指针，该字符串指定了一个待修改时间戳的文件或目录。   

TimeDate  

文件信息结构指针，其中成员 ftime 和 fdata 存储了一个待被设置的的时间戳。不关心任何其他成员。 

返回值   

FR_OK (0)  

函数成功。   

FR_NO_FILE  

找不到文件或目录。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_WRITE_PROTECTED  

存储介质被写保护。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

 

f_utime 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。  

f_utime 函数修改一个文件或目录的时间戳。

   

17.f_rename 

重命名一个对象。   

FRESULT f_rename (const XCHAR* OldName, /*  原对象名的指针  */ 

  const XCHAR* NewName  /*  新对象名的指针  */ 

); 

参数   

OldName  

'\0' 结尾的字符串的指针，该字符串指定了待被重命名的原对象名。   

NewName  

'\0' 结尾的字符串的指针，该字符串指定了重命名后的新对象名，不能包含驱动器号。   

返回值   

FR_OK (0)  

函数成功。   

FR_NO_FILE  

找不到原名。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME  

文件名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_EXIST  

新名和一个已存在的对象名冲突。   

FR_DENIED  

由于任何原因，而导致新名不能被创建。   

FR_WRITE_PROTECTED  

存储介质被写保护。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

  

f_rename 函数当 _FS_READONLY == 0 并且 _FS_MINIMIZE == 0 时可用。  

f_rename 函数重命名一个对象，并且也可以将对象移动到其他目录。逻辑驱动器号由原名决定，新名不能包含一个逻辑驱动器号。不要重命名打开的对象。   

18.f_mkfs 

在驱动器上创建一个文件系统   

FRESULT f_mkfs ( 

  BYTE  Drive,            /*  逻辑驱动器号  */ 

  BYTE  PartitioningRule, /*  分区规则  */ 

  WORD  AllocSize         /*  分配单元大小  */ 

); 

参数   

Drive  

待格式化的逻辑驱动器号 (0-9) 。   

PartitioningRule  

当给定 0 时，首先在驱动器上的第一个扇区创建一个分区表，然后文件系统被创建在分区上。这被称为FDISK 格式化，用于硬盘和存储卡。当给定 1 时，文件系统从第一个扇区开始创建，而没有分区表。这被称为超级软盘 (SFD) 格式化，用于软盘和可移动磁盘。   

AllocSize  

指定每簇中以字节为单位的分配单元大小。数值必须是 0 或从 512 到 32K 之间 2 的幂。当指定 0 时，簇大小取决于卷大小。   

返回值   

FR_OK (0)  

函数成功。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_WRITE_PROTECTED  

驱动器被写保护。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_MKFS_ABORTED  

由于下列原因之一，而导致函数在开始格式化前终止： 

n  ★ 磁盘容量太小   

n  ★ 参数无效   

n  ★ 该驱动器不允许的簇大小。   

  

f_mkfs 函数当 _FS_READOLNY == 0 并且 _USE_MKFS == 1 时可用。  

f_mkfs 函数在驱动器中创建一个 FAT 文件系统。对于可移动媒介，有两种分区规则： FDISK 和 SFD ，通过参数PartitioningRule 选择。 FDISK 格式在大多数情况下被推荐使用。该函数当前不支持多分区，因此，物理驱动器上已存在的分区将被删除，并且重新创建一个占据全部磁盘空间的新分区。  

根据 Microsoft 发布的 FAT 规范， FAT 分类： FAT12/FAT16/FAT32 ，由驱动器上的簇数决定。因此，选择哪种 FAT 分类，取决于卷大小和指定的簇大小。簇大小影响文件系统的性能，并且大簇会提高性能。 

  

19.f_forward 

读取文件数据并将其转发到数据流设备。   

FRESULT f_forward ( 

  FIL* FileObject,                 /*  文件对象  */ 

  UINT (*Func)(const BYTE*,UINT),  /*  数据流函数  */ 

  UINT ByteToFwd,                  /*  要转发的字节数  */ 

  UINT* ByteFwd                    /*  已转发的字节数  */ 

); 

参数   

FileObject  

打开的文件对象的指针。   

Func  

用户定义的数据流函数的指针。详情参考示例代码。   

ByteToFwd  

要转发的字节数， UINT 范围内。   

ByteFwd  

返回已转发的字节数的 UINT 变量的指针。   

返回值   

FR_OK (0)  

函数成功。   

FR_DENIED  

由于文件已经以非读模式打开，而导致函数失败。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_INVALID_OBJECT  

文件对象无效。   

  

f_forward 函数当 _USE_FORWARD == 1 并且 _FS_TINY == 1 时可用。  

f_forward 函数从文件中读取数据并将数据转发到输出流，而不使用数据缓冲区。这适用于小存储系统，因为它在应用模块中不需要任何数据缓冲区。文件对象的文件指针以转发的字节数增加。如果 *ByteFwd < ByteToFwd 并且没有错误，则意味着由于文件结束或在数据传输过程中流忙，请求的字节不能被传输。   

20.f_chdir 

f_chdir 函数改变一个驱动器的当前目录。   

 

 

FRESULT f_chdir ( 

  const XCHAR* Path /*  路径名的指针  */

); 

参数   

Path  

'\0' 结尾的字符串的指针，该字符串指定了将要进去的目录。   

返回值   

FR_OK (0)  

函数成功。   

FR_NO_PATH  

找不到路径。   

FR_INVALID_NAME 

路径名无效。   

FR_INVALID_DRIVE  

驱动器号无效。   

FR_NOT_READY  

由于驱动器中没有存储介质或任何其他原因，而导致磁盘驱动器无法工作。   

FR_DISK_ERR  

由于底层磁盘 I/O 函数中的错误，而导致该函数失败。   

FR_INT_ERR  

由于一个错误的 FAT 结构或一个内部错误，而导致该函数失败。   

FR_NOT_ENABLED  

逻辑驱动器没有工作区。   

FR_NO_FILESYSTEM  

磁盘上没有有效的 FAT 卷。   

  

f_chdir 函数当 _FS_RPATH == 1 时可用。  

f_chdir 函数改变一个逻辑驱动器的当前目录。当一个逻辑驱动器被自动挂载时，它的当前目录被初始化为根目录。注意：当前目录被保存在每个文件系统对象中，因此它也影响使用同一逻辑驱动器的其它任务。   

21.f_chdrive 

f_chdrive 函数改变当前驱动器。   

FRESULT f_chdrive ( 

  BYTE Drive /*  逻辑驱动器号  */ 

); 

Drive  

指定将被设置为当前驱动器的逻辑驱动器号。   

返回值   

FR_OK (0)  

函数成功。   

FR_INVALID_DRIVE  

驱动器号无效。   

 

f_chdrive 函数当 _FS_RPATH == 1 时可用。  

f_chdrive 函数改变当前驱动器。当前驱动器号初始值为 0 ，注意：当前驱动器被保存为一个静态变量，因此它也影响使用文件函数的其它任务。   

22.f_gets 

f_gets 从文件中读取一个字符串。   

char* f_gets ( 

  char* Str,        /*  读缓冲区  */ 

  int Size,         /*  读缓冲区大小  */ 

  FIL* FileObject   /*  文件对象  */ 

); 

参数   

Str  

存储读取字符串的读缓冲区指针。   

Size  

读缓冲区大小。   

FileObject  

打开的文件对象结构指针。   

返回值   

当函数成功后， Str 将被返回。   

  

f_gets 函数当 _USE_STRFUNC == 1 或者 _USE_STRFUNC == 2 时可用。如果 _USE_STRFUNC == 2 ，文件中包含的 '\r' 则被去除。  

f_gets 函数是 f_read 的一个封装函数。当读取到 '\n' 、文件结束或缓冲区被填冲了 Size - 1 个字符时，读操作结束。读取的字符串以 '\0' 结束。当文件结束或读操作中发生了任何错误， f_gets() 返回一个空字符串。可以使用宏 f_eof() 和 f_error() 检查 EOF 和错误状态。

   

23.f_putc 

f_putc 函数向文件中写入一个字符。   

int f_putc ( 

  int Chr,          /*  字符  */ 

  FIL* FileObject   /*  文件对象  */ 

); 

参数   

Chr  

待写入的字符。   

FileObject  

打开的文件对象结构的指针。   

返回值   

当字符被成功地写入后，函数返回该字符。由于磁盘满或任何错误而导致函数失败，将返回 EOF 。   

描述   

f_putc 函数当 (_FS_READONLY == 0)&&(_USE_STRFUNC == 1 || _USE_STRFUNC == 2) 时可用。当_USE_STRFUNC == 2 时，字符 '\n' 被转换为 "\r\n" 写入文件中。  

f_putc 函数是 f_write 的一个封装函数。

  

24.f_puts 

f_puts 函数向文件中写入一个字符串。   

int f_puts ( 

  const char* Str,  /*  字符串指针  */ 

  FIL* FileObject   /*  文件对象指针  */

);

参数   

Str  

待写入的 '\0' 结尾的字符串的指针。 '\0' 字符不会被写入。   

FileObject  

打开的文件对象结构的指针。   

返回值   

函数成功后，将返回写入的字符数。由于磁盘满或任何错误而导致函数失败，将返回 EOF 。  

  

f_puts() 当 (_FS_READONLY == 0)&&(_USE_STRFUNC == 1 || _USE_STRFUNC == 2) 时可用。当_USE_STRFUNC == 2 时，字符串中的 '\n' 被转换为 "\r\n" 写入文件中。  

f_puts() 是 f_putc() 的一个封装函数。

  

25.f_printf 

f_printf 函数向文件中写入一个格式化字符串。  

int f_printf ( 

  FIL* FileObject,     /*  文件对象指针  */ 

  const char* Foramt,  /*  格式化字符串指针  */ 

  ... 

); 

参数   

FileObject  

已打开的文件对象结构的指针。   

Format  

'\0' 结尾的格式化字符串指针。   

...  

可选参数   

 

返回值   

函数成功后，将返回写入的字符数。由于磁盘满或任何错误而导致函数失败，将返回 EOF 。  

 

f_printf 函数当 (_FS_READONLY == 0)&&(_USE_STRFUNC == 1 || _USE_STRFUNC == 2) 时可用。当 _USE_STRFUNC == 2 时，包含在格式化字符串中的 '\n' 将被转换成 "\r\n" 写入文件中。 f_printf 函数是 f_putc 和 f_puts 的一个封装函数。如下所示，格式控制符是标准库的一个子集：

类型： c s d u X 

大小： l 

标志： 0 

磁盘I/O接口  

由于FatFs模块完全与磁盘I/O层分开，因此底层磁盘I/O需要下列函数去读/写物理磁盘以及获取当前时间。由于底层磁盘I/O模块并不是FatFs的一部分，因此它必须由用户提供。  

26.disk_initialize 

初始化磁盘驱动器   

DSTATUS disk_initialize ( 

  BYTE Drive           /*  物理驱动器号  */ 

); 

参数   

Drive  

指定待初始化的物理驱动器号。   

返回值   

disk_initialize 函数返回一个磁盘状态作为结果。磁盘状态的详情，参考 disk_status 函数。   

disk_initialize 函数初始化一个物理驱动器。函数成功后，返回值中的 STA_NOINIT 标志被清除。disk_initialize 函数被 FatFs 模块在卷挂载过程中调用，去管理存储介质的改变。当 FatFs 模块起作用时，或卷上的 FAT 结构可以被瓦解时，应用程序不能调用该函数。可以使用 f_mount 函数去重新初始化文件系统。

   

27.disk_status 

获取当前磁盘的状态   

DSTATUS disk_status ( 

  BYTE Drive     /*  物理驱动器号 */ 

);

参数   

Drive  

指定待确认的物理驱动器号。   

返回值   

磁盘状态，是下列标志的组合：  STA_NOINIT 指示磁盘驱动器还没有被初始化。当系统复位、磁盘移除和 disk_initialize 函数失败时，该标志被设置；当 disk_initialize 函数成功时，该标志被清除。 STA_NODISK 指示驱动器中没有存储介质。当安装了磁盘驱动器后，该标志始终被清除。   

STA_PROTECTED  

指示存储介质被写保护。在不支持写保护缺口的驱动器上，该标志始终被清除。当 STA_NODISK 被设置时，该标志无效。   

28.disk_read 

从磁盘驱动器中读取扇区   

DRESULT disk_read ( 

  BYTE Drive,          /*  物理驱动器号  */ 

  BYTE* Buffer,        /*  读取数据缓冲区的指针  */ 

  DWORD SectorNumber,  /*  起始扇区号  */ 

  BYTE SectorCount     /*  要读取的扇区数  */ 

); 

参数   

Drive  

指定物理驱动器号。   

Buffer  

存储读取数据的缓冲区的指针。该缓冲区大小需要满足要读取的字节数 ( 扇区大小  *  扇区总数。由上层指定的存储器地址可能会也可能不会以字边界对齐。 SectorNumber  指定在逻辑块地址 (LBA) 中的起始扇区号。   

SectorCount  

指定要读取的扇区数 (1-255) 。   

返回值   

RES_OK (0)  

函数成功   

RES_ERROR  

在读操作过程中发生了不能恢复的硬错误。   

RES_PARERR  

无效的参数。   

RES_NOTRDY  

磁盘驱动器还没被初始化。   

29.disk_write 

向磁盘驱动器中写入扇区   

DRESULT disk_write ( 

  BYTE Drive,          /*  物理驱动器号  */ 

  const BYTE* Buffer,  /*  写入数据缓冲区的指针 ( 可能未对齐 ) */ 

  DWORD SectorNumber,  /*  起始扇区号  */ 

  BYTE SectorCount     /*  要写入的扇区数  */ 

); 

参数   

Drive  

指定物理驱动器号。   

Buffer  

存储写入数据的缓冲区的指针。由上层指定的存储器地址可能会也可能不会以字边界对齐。   

SectorNumber  

指定在逻辑块地址 (LBA) 中的起始扇区号。   

SectorCount  

指定要写入的扇区数 (1-255) 。   

返回值   

RES_OK (0)  

函数成功   

RES_ERROR  

在读操作过程中发生了不能恢复的硬错误。   

RES_WRPRT  

存储介质被写保护。   

RES_PARERR  

无效的参数。   

RES_NOTRDY  

磁盘驱动器还没被初始化。   

 

在只读配置中，不需要此函数。   

30.disk_ioctl 

控制设备特定的功能以及磁盘读写以外的其它功能。   

DRESULT disk_ioctl ( 

  BYTE Drive,      /*  驱动器号  */ 

  BYTE Command,    /*  控制命令代码  */ 

  void* Buffer     /*  数据传输缓冲区  */ 

); 

参数   

Drive  

指定驱动器号 (1-9) 。   

Command  

指定命令代码。   

Buffer  

取决于命令代码的参数缓冲区的指针。当不使用时，指定一个 NULL 指针。   

返回值   

RES_OK (0)  

函数成功。   

RES_ERROR  

发生错误。   

RES_PARERR  

无效的命令代码。   

RES_NOTRDY  

磁盘驱动器还没被初始化。   

 

FatFs 模块只使用下述与设备无关的命令，没有使用任何设备相关功能。

命令	描述
GET_SECTOR_SIZE	返回驱动器的扇区大小赋给 Buffer 指向的 WORD 变量。在单个扇区大小配置中(_MAX_SS  为  512) ，不需要该命令。
GET_SECTOR_COUNT	返回总扇区数赋给 Buffer 指向的 DWORD 变量。只在 f_mkfs 函数中，使用了该命令。
GET_BLOCK_SIZE	返回以扇区为单位的存储阵列的擦除块大小赋给 Buffer 指向的 DWORD 变量。当擦除块大小未知或是磁盘设备时，返回 1 。只在 f_mkfs 函数中，使用了该命令。

 

31.get_fattime 

获取当前时间   

DWORD get_fattime (void); 

返回值   

返回的当前时间被打包进一个 DWORD 数值。各位域定义如下：  

bit31:25  

年，从 1980 年开始算起 (0..127)  

bit24:21  

月 (1..12)  

bit20:16  

日 (1..31)  

bit15:11  

时 (0..23)  

bit10:5  

分 (0..59)  

bit4:0  

秒 /2(0..29) ，由此可见 FatFs 的时间分辨率为 2 秒   

get_fattime 函数必须返回任何有效的时间，即使系统不支持实时时钟。如果返回一个 0 ，则文件将没有一个有效的时间。在只读配置中，不需要此函数。