Fatfs文件系所有函数总结

Fatfs文件系统常用函数f_mount、f_open、f_close、f_read、f_write、f_lseek、f_truncate、f_sync、f_opendir 

Fatfs文件系所有函数总结_第1张图片 

Fatfs文件系所有函数总结_第2张图片

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

Fatfs文件系所有函数总结_第3张图片

特点Windows兼容的FAT文件系统不依赖于平台,易于移植代码和工作区占用空间非常小多种配置选项:多卷(物理驱动器和分区)ANSI/OEM代码页,包括DBCSANSI/OEM或Unicode中长文件名的支持RTOS的支持多扇区大小的支持只读,最少API,I/O缓冲区

应用程序接口

FatFs 模块为应用程序提供了下列函数,这些函数描述了FatFs能对FAT卷执行哪些操作。

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:打开一个目录

。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。

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将被创建的文件对象结构的指针。FileNameNULL结尾的字符串指针,该字符串指定了将被创建或打开的文件名。ModeFlags指定文件的访问类型和打开方法。它是由下列标志的一个组合指定的。

Fatfs文件系所有函数总结_第4张图片

注意:当 _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由于下列原因,所需的访问被拒绝:

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

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

3)由于目录表或磁盘已满,而导致文件无法被创建。

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, 首先要定义一个至少512的内存 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磁盘满。卷上没有足够的空闲空间去扩展文件大小。

用法:其实这个函数可以解决文件从头开始读的问题,如果你想打开一个文件,读取里面的内容,但又不想从头开始读,那么你可以使用这个函数来解决

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

 

你可能感兴趣的:(STM32)