devbox
Monodyee
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

FATFS函数浅谈 看完学会FATSFS，建议收藏_fa_create_new

作者：Monodyee | 2024-04-04 15:22:12

赞

踩

fa_create_new

目录

一、注册工作区域

二、打开文件夹

三、读取文件夹

四、打开\新建一个文件

五、读取文件

六、写文件 

七、移动文件指针

 八、截断文件

九、刷新缓存消息 

十、新建文件夹

十一、删除文件或文件夹

十二、重命名\移动文件或文件夹

十三、获取文件信息

十四、改变文件属性 

 十五、改变时间戳

刚开始看到 FATFS 时,一头雾水,不知道从何下手,网上也搜了很多资料,要么高深莫测,要么简单地一笔代过.断断续续地摸索了一段时间,算是对文件系统有了初步的认识,整理一下思路,将自己的学习过程,及学习心得写出来与大家分享, 文笔有限,力求简洁易懂,希望对初学者有所帮助,不足之处请指正.
笔者用的是酷学玩 summer V1.3 的开发板，64M 的 microSD 卡（已格式化为 FAT32 格式），底层驱动是 yuanyin 移植的,如果你用的不是酷学玩 stm32 的板子,那也没关系,网上有很多移植的例程,可以参照着尝试移植;或者根据酷学玩的例程修改也可.
本文主要介绍 FATFS 的 API 函数，仅针对初学者入门,高手请拍砖．
例程中用到的全局变量定义如下：

  1. FATFS fs;     // Work area (file system object) for logical drive
  2. FIL fsrc, fdst; // file objects
  3.  
  4. FRESULT res; // FatFs function common result code
  5.  
  6. UINT br, bw; // File R/W count

一、注册工作区域

  1. FRESULT f_mount (
  2. BYTE
  3. Drive, /* Logical drive number */
  4. FATFS*
  5. FileSystemObject /* Pointer to the work area */
  6. )

函数说明：
１. 此函数的作用就是在磁盘里注册一个缓冲区域,用来存储 FAT32 文件系统的一些相关信
息．
２. 参数说明：
a) Drive : 盘符
b) *FileSystemObject : 指向缓冲区域的指针
３. 对磁盘进行操作之前,这个函数是不可少的
例程 : f_mount(0 , &fs);

二、打开文件夹

  1. FRESULT f_opendir (
  2. DIR*
  3. DirObject, /* Pointer to the blank directory object
  4. structure */
  5. const TCHAR*
  6. DirName /* Pointer to the directory name */
  7. )

函数说明:
1. 此函数可以打开一个已存在的文件夹
2. 参数说明:
a) *DirObject : 指向一个空白的结构体，用来存储要打开的文件夹信息
b) *DirName : 指向该文件夹名称的指针


三、读取文件夹

  1. FRESULT f_readdir (
  2. DIR*
  3. DirObject, /* Pointer to the open directory object */
  4. FILINFO*
  5. FileInfo /* Pointer to the file information structure */
  6. );

函数说明:
1. 此函数按照顺序读取文件夹内文件
2. 参数说明:
a) *DirObject : 指向读取的文件夹的信息结构体的指针
b) *FileInfo : 指向文件信息结构体，用来存储读取到的文件的信息
3. 重复调用此函数可读取文件夹内所有文件
4. 当所有文件读取结束,函数返回一个空字符串到 f_name[] 中
5. 如果一个空指针赋给 *FileInfo ,将返回从第一个文件开始读取.

例程：这段程序先打开文件夹 folde/move ，然后查找其中的存档文件，并通过串口输出
读取的文件名

  1. if (f_opendir(&dirs, "folder/move") == FR_OK) //打开文件夹
  2. {
  3. while (f_readdir(&dirs, &finfo) == FR_OK) //按照顺序读文件夹
  4. {
  5. if(!finfo.fname[0]) break; //如果文件名为 0,结束
  6. {
  7. if(finfo.fattrib == AM_ARC) //判断文件属性
  8. Debug("文件名:%s\r\n",finfo.fname);
  9. }
  10. }
  11. }

串口输出如下：


在 PC 上查看 SD 卡:


可以看到，程序输出了后面三个文件的名称，对文件夹没作处理，因为在程序里
对文件属性进行了判断：
if(finfo.fattrib == AM_ARC)，意思是只对存档文件进行处理；
至于什么是存档文件，以下是在百度知道搜到的结果：
视窗系统中文件属性有四种类型，我来告诉你这四种类型是什么意思：
只读-表示该文件不能被修改
隐藏 -表示该文件在系统中是隐藏的，在默认情况下用户不能看见这些文件。
系统 - 表示该文件是操作系统的一部分。
存档- 表示该文件在上次备份前已经修改过了，一些备份软件在备份系统后会把这些文件默
认的设为存档属性。
存档属性在一般文件管理中意义不大，但是对于频繁的文件批量管理很有帮助。

四、打开\新建一个文件

  1. FRESULT f_open (
  2. FIL*
  3. FileObject, /* Pointer to the blank file object structure
  4. */
  5. const TCHAR*
  6. FileName, /* Pointer to the file neme */
  7. BYTE
  8. ModeFlags /* Mode flags */
  9. )

 函数说明:
1. 此函数可以打开，或新建一个文件
2. 参数说明
a) *ＦileObject : 指向一个用来存储文件对象的空结构体的指针
b) *ＦileName : 指向文件名的指针
c) ModeFlags : 打 开 方 式 ， 可 以 是 以 下 一 种 或 几 种 的 组 合 （ 默 认 方 式 是
FA_OPEN_EXISTING）
ValueValueValueValue DescriptionDescriptionDescriptionDescription
FA_READ 读模式，（读写模式可同时生效）
FA_WRITE 写模式，（读写模式可同时生效）
FA_OPEN_EXISTING 默认打开方式
FA_OPEN_ALWAYS 打开文件，如果文件不存在，则创建一个新文件；
用此种方式，可以用 f_lseek 在文件后追加数据
FA_CREATE_NEW 新建文件，如果文件已存在，则新建失败
FA_CREATE_ALWAYS 新建文件，如果文件已存在，覆盖旧文件


五、读取文件

  1.  
  2. FRESULT f_read (
  3. FIL*
  4. FileObject, /* Pointer to the file object structure */
  5. void*
  6. Buffer, /* Pointer to the buffer to store read data */
  7. UINT
  8. ByteToRead, /* Number of bytes to read */
  9. UINT*
  10. ByteRead /* Pointer to the variable to return number of bytes
  11. read */
  12. );

函数说明：
１. 这个函数可以读取文件的内容
２. 参数说明：
a) *FileObject : 指向文件对象结构体的指针
b) *Buffer : 指向存储读取到的数据的缓冲的指针
c) ByteToRead : 准备读取的字节数
d) *ByteRead :
i. 它的作用就是用来检测文件的末尾，就是下面例程中的这一句：
if (res || br < sizeof(buffer)) break;
ii. 每次 f_read 执行完后，*ByteRead 值等于本次读取到的字节数，若*ByteRead
＜ByteToRead,即本次读取到的字节小于准备读取的字节，说明读指针已到达
文件末尾．

例程：以读取的方式打开文件，然后将文件内容通过串口输出。

  1. res = f_open(&fsrc, "news/news.txt", FA_READ);
  2. if(!res)
  3. {
  4. Debug("open news/news.txt : %d\r\n",res);
  5. br=1;
  6. a=0;
  7. Debug("文件内容:");
  8. for (;;)
  9. {
  10. for(a=0; a<512; a++) buffer[a]=0;
  11. res = f_read(&fsrc, buffer, sizeof(buffer), &br);
  12. Debug("%s\r\n",buffer);
  13. if (res || br < sizeof(buffer)) break; // error or eof
  14. }
  15. }
  16. f_close(&fsrc); //

不论是打开，还是新建文件，一定记得关闭运行后串口输出结果：

下面是在ＰＣ中查看：

 

六、写文件 

  1.  
  2.  
  3. FRESULT f_write (
  4. FIL*
  5. FileObject, /* Pointer to the file object structure */
  6. const void*
  7. Buffer, /* Pointer to the data to be written */
  8. UINT
  9. ByteToWrite, /* Number of bytes to write */
  10. UINT*
  11. ByteWritten /* Pointer to the variable to return number of
  12. bytes written */
  13. );

函数说明：
１. 此函数用来向文件中写入数据，前提是以写文件的方式打开文件
２. 参数说明：
a) *FileObject : 指向文件对象结构体的指针
b) *Buffer : 指向数据缓冲的指针
c) ByteToWrite : 准备写入的字节数
d) *ByteWritten : 记录已写入的字节数，用来检测是否写完
３. 后两个参数的长度都是两个字节，计数值最大为 65536，所以一次写入字节数最大为
64K。一般情况下一次不会写这么长的数据,因为就算 RAM 足够用，也不会在里面开一
个几十 K 的数据缓冲区。
例程：
结合前面的 f_open 函数，在下面例程中以写的方式新建一个 txt 文档，然后写入 100 个字节。
已定义：unsighed char buffer[100] = "This is a new file, the data is just written in! 这是一个新
文件，数据也是新的!";

  1. res = f_open(&fsrc, "new/NewText.txt", FA_WRITE | FA_CREATE_ALWAYS);
  2. if (res == FR_OK)
  3. {
  4. Debug("create file ok!\r\n");
  5. Debug("start write!\r\n");
  6. do
  7. {
  8. res = f_write(&fsrc, buffer, 100,&bw);
  9. if(res)
  10. {
  11. Debug("write error : %d\r\n",res);
  12. break;
  13. }
  14. Debug("write ok!\r\n");
  15. }
  16. while (bw < 100); // 判断是否写完(bw > 100，表示写入完成)
  17. }
  18. f_close(&fsrc); // 关闭文件，必须和 f_open 函数成对出现

运行后串口输出：

 下面是PC中查看结果：

 

掌握以上几个函数后，可以利用 FATFS 对ＳＤ卡进行基本的读写操
作了。下面介绍另外几个常用的函数。

七、移动文件指针

  1. FRESULT f_lseek (
  2. FIL*
  3. FileObject, /* Pointer to the file object structure */
  4. DWORD
  5. Offset /* File offset in unit of byte */
  6. )

函数说明：
１. 此函数在对已打开的文件进行读或写时，可以移动当前指针位置
２. 参数说明：
a) FileObject : 指向文件对象结构体的指针
b) Offset : 指针移动的长度
例程：

  1. res = f_open (&fsrc ,"news/news.txt", FA_WRITE);
  2. res = f_lseek (&fsrc , 500); 指针指向第 500 个字节
  3. res = f_write (&fsrc , "500" ,3 , &bw);
  4. res = f_lseek (&fsrc , fsrc.fptr + 100); 指针向前移动 100 个字节
  5. res = f_write (&fsrc , "forward" ,8 , &bw);
  6. res = f_lseek (&fsrc , fsrc.fptr - 200); 指针向后移动 200 个字节
  7. res = f_write (&fsrc , "backward" , 9, &bw);
  8. res = f_lseek (&fsrc , fsrc.fsize); 指针指向文件末尾
  9. res = f_write (&fsrc , "end" ,3 , &bw);
  10. res = f_close ( &fsrc );

运行后在ＰＣ中查看结果：

 

 八、截断文件

  1. FRESULT f_truncate (
  2. FIL*
  3. FileObject /* Pointer to the file object */
  4. );

函数说明：
１. 此函数可以在将文件在当前指针处截断
２. 参数说明：
a) *FileObject : 指向文件对象结构体的指针
３. 此函数可以截断文件，也可以延长文件长度
例程：以上节 news/news.txt 为基础，本段程序可将文件在指定长度处截断

  1. res = f_open (&fsrc ,"news/news.txt", FA_WRITE);
  2. res = f_lseek (&fsrc , 60); 指针指向第 60 个字节
  3. res = f_truncate (&fsrc ); 将文件在此截断
  4. res = f_sync ( &fsrc ); 关闭文件

 上图为运行程序之前在ＰＣ上查看
下图为运行程序之后，,从右面文件夹中可以看出，文件大小变成了 60 个字节．

九、刷新缓存消息 

  1. FRESULT f_sync (
  2. FIL*
  3. FileObject /* Pointer to the file object */
  4. );

函数说明：
１. 此函数功能兼容 f_close，它于 f_close 的区别就是执行后,当前文件是否仍然有效.
２. 参数说明：
a) *FileObject : 指向文件对象结构体的指针
３. 调用此函数后,当前文件仍然可读可写可查询.
４. 当文件处于长时间的写模式,如数据记录时，定期调用此函数，或在写入数据后立即调用
此函数，可以减少因断电等意外情况带来的损失．有点 WORD 中后台定期保存的意思

十、新建文件夹

  1. FRESULT f_mkdir (
  2. const TCHAR*
  3. DirName /* Pointer to the directory name */
  4. );

函数说明：
１. 新建一个文件夹
２. 参数说明：
a) *DirName : 指向将要创建的文件夹名的指针
３. 文件名应符合 fatfs 标准,不能包含非法字符,
４. 若不支持长文件名,文件名长度不能大于 8,否则新建不成功
５. 例程：

  1. a) f_mkdir("new");
  2. b) f_mkdir("folder/new");

十一、删除文件或文件夹

  1. FRESULT f_unlink (
  2. const TCHAR*
  3. FileName /* Pointer to the object name */
  4. );

函数说明：
１. 此函数可以删除一个文件或文件夹
２. 参数说明：
a) *FileName : 指向文件或文件夹的名称的指针
３. 删除文件夹时：
a) 不能为当前文件夹
b) 不能为非空文件夹
４. 删除文件时
a) 不能为已打开文件
b) 不能为只读文件

十二、重命名\移动文件或文件夹

  1. FRESULT f_rename (
  2. const TCHAR*
  3. OldName, /* Pointer to old object name */
  4. const TCHAR*
  5. NewName /* Pointer to new object name */
  6. );

函数说明：
１. 此函数可以移动或重命名一个文件或文件夹
２. 参数说明：
a) *OldName : 指向旧文件名的指针
b) *NewName : 指向新文件名的指针
３. 此函数可重命名 文件 或 文件夹 ,而不论文件夹是否为空
４. 此函数可移动 文件 或 文件夹 ,而不论文件夹是否为空
例程：

  1. res = f_rename("folder/old.txt","folder/newname.txt"); //重命名 文件，
  2. res = f_rename("folder/123.txt","new/456.txt"); //将文件夹 folder 中的 123.txt 文件，移动到文件
  3. 夹 new 中并重命名为 456.txt

十三、获取文件信息

  1. FRESULT f_stat (
  2. const TCHAR*
  3. FileName, /* Pointer to the file or directory name */
  4. FILINFO*
  5. FileInfo /* Pointer to the FILINFO structure */
  6. );

函数说明:
1. 此函数可以获取文件的最近修改时间,属性等信息,获取的信息存在 fileinfo 结构体中
2. 参数说明:
a) *FileName: 指向文件名的指针
b) *FileInfo: 指向保存文件信息的结构体的指针
3. 如果目标是文件夹,获取的大小为 0.
4. 此函数对根目录无效
5. 时间和日期均为两个字节,存储格式如下
a) 日期:
i. bit15...bit9: 年 减去 1980
ii. bit8 ... bit5: 月
iii. bit4 ... bit0: 日
b) 时间:
i. bit15... bit11 : 时
ii. bit10... bit5 : 分
iii. bit4 ... bit0 : 秒 除以 2
c) 如
i. 日期:00000010 00100001,表示 1981 年 1 月 1 日
ii. 时间:00001000 00100001,表示 1 点 1 分 2 秒
例:

  1. res = f_stat("folder/newname.txt", &finfo); //读取 folder 目录下 newname.txt 文件的信息
  2. if( res )
  3. Debug("newname.txt err : %d\r\n", res);
  4. else
  5. {
  6. Debug("newname.txt size : %lu\r\n",finfo.fsize);
  7. Debug("fdate : %d\r\n",finfo.fdate);
  8. Debug("ftime : %d\r\n",finfo.ftime);
  9. Debug("fattrib : %d\r\n",finfo.fattrib);
  10. }

串口输出结果：

 结果分析：

 

 以下式电脑侑见属性查看结果：

和串口读出来的结果一样。

十四、改变文件属性 

  1. FRESULT f_chmod (
  2. const TCHAR*
  3. FileName, /* Pointer to the file or directory */
  4. BYTE
  5. Attribute, /* Attribute flags */
  6. BYTE
  7. AttributeMask /* Attribute masks */
  8. );

函数说明:
1. 此函数可以修改文件或文件夹的属性
2. 可修改的属性只能是以下一种或几种的组合,对其它属性无效

3. 参数说明:
  a) *Filename:指向文件或文件夹的名称的指针
  b) Attribute:要置位的属性
  c) AttributeMask:需要改变的属性(包括要置位的和要清除的属性)


4. 使用方法:
a) Attribute 须为 AttributeMask 的子集
b) 函数对 AttributeMask 中的属性集合进行处理,若属性包含在 Attribute
中,则置位,否则清除
例程:
1.对文件 newname.txt,置位 ARC 和 SYS 属性,取消 HID 和 REO 属性

  1. res = f_chmod("folder/newname.txt", AM_ARC | AM_SYS, AM_ARC | AM_RDO | AM_HID |
  2. AM_SYS);
  3. if( res )
  4. Debug("err :%d\r\n", res);
  5. else
  6. {
  7. res = f_stat("folder/newname.txt", &finfo);
  8. Debug("%d\r\n",finfo.fattrib);
  9. }

2.对文件夹 new,置位 SYS 和 ARC 属性,取消 HID 和 RDO 属性

  1. res = f_chmod("new", AM_SYS | AM_ARC, AM_ARC | AM_RDO | AM_HID | AM_SYS);
  2. if( res )
  3. Debug("err :%d\r\n", res);
  4. else
  5. {
  6. res = f_stat("new", &finfo);
  7. Debug("%d\r\n",finfo.fattrib);
  8. }

 十五、改变时间戳

  1. FRESULT f_utime (
  2. const TCHAR*
  3. FileName, /* Pointer to the file or directory path */
  4. const FILINFO*
  5. TimeDate /* Time and data to be set */
  6. );

函数说明:
1. 此函数可以更改文件的最近修改时间
2. 参数说明:
a) Filename :指向文件的指针
b) Timedate :指向文件信息结构体的指针
例:

  1. FRESULT set_timestamp ( char *obj, /* Pointer to the file name */
  2. int year, int month, int mday, int hour, int min, int sec
  3. )//
  4. {
  5. FILINFO fno;
  6. fno.fdate = (WORD)(((year - 1980) * 512U) | month * 32U | mday);
  7. fno.ftime = (WORD)(hour * 2048U | min * 32U | sec / 2U);
  8. return f_utime(obj, &fno);
  9. }
  10. res = set_timestamp("123.txt",2001,06,05,02,03,34);//修改 123.txt 时间
  11. Debug("%d\r\n",res);
  12. ‘

执行函数后,串口返回 0
在 PC 上右键属性可以看到结果如下:

先写到这，后面的函数，用到时再研究：

  1. • f_forward - Forward file data to the stream directly
  2. • f_chdir - Change current directory
  3. • f_chdrive - Change current drive
  4. • f_getcwd - Retrieve the current directory
  5. • f_gets - Read a string
  6. • f_putc - Write a character
  7. • f_puts - Write a string
  8. • f_printf - Write a formatted string

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Monodyee/article/detail/359488
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号