FatFs

青樓滿座wu0pn9 2018-08-24

展开全文

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

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

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

由于底层磁盘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;         /* 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, 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           /* 返回已读取字节数变量的指针 */
);

参数

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 文件对象无效。

描述

f_sync函数当_FS_READONLY == 0时可用。

f_sync函数和f_close函数执行同样的过程，但是文件仍处于打开状态，并且可以继续对文件执行读/写/移动指针操作。这适用于以写模式长时间打开文件，比如数据记录器。定期的或f_write后立即执行f_sync可以将由于突然断电或移去磁盘而导致数据丢失的风险最小化。在f_close前立即执行f_sync没有作用，因为在f_close中执行了f_sync。换句话说，这两个函数的差异就是文件对象是不是无效的。

[编辑] 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函数打开一个已存在的目录，并为后续的调用创建一个目录对象。该目录对象结构可以在任何时候不经任何步骤而被丢弃。

[编辑] 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)时，"."和".."目录项不会被过滤掉，并且它将出现在读目录项中。

例子

FRESULT scan_files (char* path)
{
    FRESULT res;
    FILINFO fno;
    DIR dir;
    int i;
    char *fn;
#if _USE_LFN
    static char lfn[_MAX_LFN * (_DF1S ? 2 : 1) + 1];
    fno.lfname = lfn;
    fno.lfsize = sizeof(lfn);
#endif
 
 
    res = f_opendir(&dir, path);
    if (res == FR_OK) {
        i = strlen(path);
        for (;;) {
            res = f_readdir(&dir, &fno);
            if (res != FR_OK || fno.fname[0] == 0) break;
            if (fno.fname[0] == '.') continue;
#if _USE_LFN
            fn = *fno.lfname ? fno.lfname : fno.fname;
#else
            fn = fno.fname;
#endif
            if (fno.fattrib & AM_DIR) {
                sprintf(&path[i], "/%s", fn);
                res = scan_files(path);
                if (res != FR_OK) break;
                path[i] = 0;
            } else {
                printf("%s/%s\n", path, fn);
            }
        }
    }
 
    return res;
}

[编辑] 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结构不同步时，该函数返回一个错误的空闲簇计数。

列子

    FATFS *fs;
    DWORD fre_clust, fre_sect, tot_sect;
 
 
    /* Get drive information and free clusters */
    res = f_getfree("/", &fre_clust, &fs);
    if (res) die(res);
 
    /* Get total sectors and free sectors */
    tot_sect = (fs->max_clust - 2) * fs->csize;
    fre_sect = fre_clust * fs->csize;
 
    /* Print free space in unit of KB (assuming 512B/sector) */
    printf("%lu KB total drive space.\n"
           "%lu KB available.\n",
           fre_sect / 2, tot_sect / 2);

[编辑] 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函数。

[编辑] 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函数创建一个新目录。

例子

    res = f_mkdir("sub1");
    if (res) die(res);
    res = f_mkdir("sub1/sub2");
    if (res) die(res);
    res = f_mkdir("sub1/sub2/sub3");
    if (res) die(res);

[编辑] 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

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

对象具有只读属性
目录不是空的

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函数移除一个对象。不要移除打开的对象或当前目录。

[编辑] 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函数修改一个文件或目录的属性。

例子

    // 设置只读标志，清除存档标志，其他不变
    f_chmod("file.txt", AR_RDO, AR_RDO | AR_ARC);

[编辑] 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函数修改一个文件或目录的时间戳。

[编辑] 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函数重命名一个对象，并且也可以将对象移动到其他目录。逻辑驱动器号由原名决定，新名不能包含一个逻辑驱动器号。不要重命名打开的对象。

例子

    /* 重命名一个对象 */
    f_rename("oldname.txt", "newname.txt");
 
    /* 重命名并且移动一个对象到另一个目录 */
    f_rename("oldname.txt", "dir1/newname.txt");

[编辑] 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

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

磁盘容量太小
参数无效
该驱动器不允许的簇大小。

描述

f_mkfs函数当_FS_READOLNY == 0并且_USE_MKFS == 1时可用。
f_mkfs函数在驱动器中创建一个FAT文件系统。对于可移动媒介，有两种分区规则：FDISK和SFD，通过参数PartitioningRule选择。FDISK格式在大多数情况下被推荐使用。该函数当前不支持多分区，因此，物理驱动器上已存在的分区将被删除，并且重新创建一个占据全部磁盘空间的新分区。
根据Microsoft发布的FAT规范，FAT分类：FAT12/FAT16/FAT32，由驱动器上的簇数决定。因此，选择哪种FAT分类，取决于卷大小和指定的簇大小。簇大小影响文件系统的性能，并且大簇会提高性能。

[编辑] 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并且没有错误，则意味着由于文件结束或在数据传输过程中流忙，请求的字节不能被传输。

例子(音频播放)

/*-----------------------------------------------------------------------*/
/* 示例代码：数据传输函数，将被f_forward函数调用                                 */
/*-----------------------------------------------------------------------*/
 
UINT out_stream (   /* 返回已发送字节数或流状态 */
    const BYTE *p,  /* 将被发送的数据块的指针 */
    UINT btf        /* >0: 传输调用(将被发送的字节数)。0: 检测调用 */
)
{
    UINT cnt = 0;
 
 
    if (btf == 0) {     /* 检测调用 */
        /* 返回流状态(0: 忙，1: 就绪) */
        /* 当检测调用时，一旦它返回就绪，那么在后续的传输调用时，它必须接收至少一个字节，或者f_forward将以FR_INT_ERROR而失败。 */
        if (FIFO_READY) cnt = 1;
    }
    else {              /* 传输调用 */
        do {    /* 当有数据要发送并且流就绪时重复 */
            FIFO_PORT = *p++;
            cnt++;
        } while (cnt < btf && FIFO_READY);
    }
 
    return cnt;
}
 
 
/*-----------------------------------------------------------------------*/
/* 示例代码：使用f_forward函数                                                    */
/*-----------------------------------------------------------------------*/
 
FRESULT play_file (
    char *fn        /* 待播放的音频文件名的指针 */
)
{
    FRESULT rc;
    FIL fil;
    UINT dmy;
 
    /* 以只读模式打开音频文件 */
    rc = f_open(&fil, fn, FA_READ);
 
    /* 重复，直到文件指针到达文件结束位置 */
    while (rc == FR_OK && fil.fptr < fil.fsize) {
 
        /* 任何其他处理... */
 
        /* 定期或请求式填充输出流 */
        rc = f_forward(&fil, out_stream, 1000, &dmy);
    }
 
    /* 该只读的音频文件对象不需要关闭就可以被丢弃 */
    return rc;
}

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

例子

    // 改变当前驱动器的当前目录(根目录下的dir1)
    f_chdir("/dir1");
 
    // 改变驱动器2的当前目录(父目录)
    f_chdir("2:..");

[编辑] f_chdrive

f_chdrive函数改变当前驱动器。

FRESULT f_chdrive (
  BYTE Drive /* 逻辑驱动器号 */
);

Drive

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

返回值

FR_OK (0)

函数成功。

FR_INVALID_DRIVE

驱动器号无效。

描述

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

[编辑] 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和错误状态。

[编辑] 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的一个封装函数。

[编辑] 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()的一个封装函数。

[编辑] 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

例子

    f_printf(&fil, "%6d", -200);         /* "  -200" */
    f_printf(&fil, "%02u", 5);           /* "05" */
    f_printf(&fil, "%ld", 12345678L);    /* "12345678" */
    f_printf(&fil, "%08lX", 1194684UL);  /* "00123ABC" */
    f_printf(&fil, "%s", "String");      /* "String" */
    f_printf(&fil, "%c", 'a');           /* "a" */

[编辑] 磁盘I/O接口

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

[编辑] disk_initialize

初始化磁盘驱动器

DSTATUS disk_initialize (
  BYTE Drive           /* 物理驱动器号 */
);

参数

Drive

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

返回值

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

描述

disk_initialize函数初始化一个物理驱动器。函数成功后，返回值中的STA_NOINIT标志被清除。

disk_initialize函数被FatFs模块在卷挂载过程中调用，去管理存储介质的改变。当FatFs模块起作用时，或卷上的FAT结构可以被瓦解时，应用程序不能调用该函数。可以使用f_mount函数去重新初始化文件系统。

[编辑] disk_status

获取当前磁盘的状态

DSTATUS disk_status (
  BYTE Drive     /* 物理驱动器号*/
);

参数

Drive

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

返回值

磁盘状态，是下列标志的组合： STA_NOINIT

指示磁盘驱动器还没有被初始化。当系统复位、磁盘移除和disk_initialize函数失败时，该标志被设置；当disk_initialize函数成功时，该标志被清除。STA_NODISK

指示驱动器中没有存储介质。当安装了磁盘驱动器后，该标志始终被清除。

STA_PROTECTED

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

[编辑] 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

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

[编辑] 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

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

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

[编辑] 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模块只使用下述与设备无关的命令，没有使用任何设备相关功能。

命令	描述
CTRL_SYNC	确保磁盘驱动器已经完成等待写过程。当磁盘I/O模块有一个写回高速缓存时，立即冲洗脏扇区。在只读配置中，不需要该命令。
GET_SECTOR_SIZE	返回驱动器的扇区大小赋给Buffer指向的WORD变量。在单个扇区大小配置中(_MAX_SS 为 512)，不需要该命令。
GET_SECTOR_COUNT	返回总扇区数赋给Buffer指向的DWORD变量。只在f_mkfs函数中，使用了该命令。
GET_BLOCK_SIZE	返回以扇区为单位的存储阵列的擦除块大小赋给Buffer指向的DWORD变量。当擦除块大小未知或是磁盘设备时，返回1。只在f_mkfs函数中，使用了该命令。