一、FATFS文件系统详解
1、1什么是文件系统?
负责管理和存储文件信息的软件机构称为文件管理系统,简称文件系统。
即在磁盘上组织文件的方法。
常用的文件系统:
-FAT / FATFS
-NTFS: 基于安全性的文件系统,是Windows NT所采用的独特的文件系统结构
-CDFS:CDFS是大部分的光盘的文件系统
-exFAT
2、FATFS 文件系统
FATFS是一个完全免费开源的FAT文件系统模块,专门为小型的嵌入式系统而设计。完全用标准C语言编写,所以具有良好的硬件平台独立性。可以移植到8051、PIC、AVR、SH、Z80、H8、ARM等系列单片机上而只需做简单的修改。它支持FATl2、FATl6和FAT32,支持多个存储媒介;有独立的缓冲区,可以对多个文件进行读/写,并特别对8位单片机和16位单片机做了优化。
FATFS是可裁剪的文件系统。
3、FATFS文件系统特点
1)、Windows兼容的FAT文件系统(支持FAT12/FAT16/FAT32)
2)、与平台无关,移植简单。全C语言编写。
3)、代码量少、效率高。
4)、多种配置选项
支持多卷(物理驱动器或分区,最多10个卷)
多个ANSI/OEM代码页包括DBCS
支持长文件名、ANSI/OEM或Unicode
支持RTOS
支持多种扇区大小
只读、最小化的API和I/O缓冲区等
4、FATFS模块的层次结构图(三层)
①底层接口,包括存储媒介读/写接口(disk I/O)和供给文件创建修改时间的实时时钟,需要我们根据平台和存储介质编写移植代码。
②中间层FATFS模块,实现了FAT文件读/写协议。FATFS模块提供的是ff.c和ff.h。除非有必要,使用者一般不用修改,使用时将头文件直接包含进去即可。
③最顶层是应用层,使用者无需理会FATFS的内部结构和复杂的FAT协议,只需要调用FATFS模块提供给用户的一系列应用接口函数,如f_open,f_read,f_write和f_close等,就可以像在PC上读/写文件那样简单。
5、FATFS文件系统包:
下载地址:FatFs - Generic FAT Filesystem Module
此地址不仅仅包含资料包下载,还包括文件系统一些知 识,包括函数说明,函数调用实例等。
6、FATFS文件系统包结构
文件名 | 功能 | 说明 |
ffconf.h | FATFS模块配置文件 | 需要根据需求来配置参数。 |
ff.h | FATFS和应用模块公用的包含文件 | 不需要修改 |
ff.c | FATFS模块源码 | 不需要修改 |
diskio.h | FATFS和disk I/O模块公用的包含文件 | 不需要修改 |
diskio.c | FATFS和disk I/O模块接口层文件 | 与平台相关的代码,需要用户根据存储介质来编写函数。 |
interger.h | 数据类型定义 | 与编译器有关。 |
option文件夹 | 可选的外部功能(比如支持中文等) | 汉字实验把字库放到SPI FLASH需要修改 |
经验:
大部分的可移植的小系统或者应用,都是采用类似这种将与底层打交道的源码开发给用户编写,然后提供顶层配置文件供配置。
diskio.c和diskio.h是硬件层。
ff.c和ff.h是FatFs的文件系统层和文件系统的API层。
FATFS模块在移植的时候,我们一般只需要修改2个文件,即ffconf.h和diskio.c。FATFS模块的所有配置项都是存放在ffconf.h里面,我们可以通过配置里面的一些选项,来满足自己的需求。diskio.c是硬件层,负责与底层硬件接口适配。
7、ffconf.h:FATFS关键配置文件
①_FS_TINY。这个选项在R0.07版本中开始出现,之前的版本都是以独立的C文件出现(FATFS和Tiny FATFS),有了这个选项之后,两者整合在一起了,使用起来更方便。我们使用FATFS,所以把这个选项定义为0即可。
②_FS_READONLY。这个用来配置是不是只读,本章我们需要读写都用,所以这里设置为0即可。
③_USE_STRFUNC。这个用来设置是否支持字符串类操作,比如f_putc,f_puts等,本章我们需要用到,故设置这里为1。
④ _USE_MKFS。这个用来定时是否使能格式化,本章需
要用到,所以设 置这里为1。
⑤ _USE_FASTSEEK。这个用来使能快速定位,我们设置
为1,使能快速定位。
⑥ _USE_LABEL。这个用来设置是否支持磁盘盘符(磁盘名字)读取与设置。我们设置为1,使能,就可以通过相关函数来读取和设置磁盘的名字了。
⑦_CODE_PAGE。这个用于设置语言类型,包括很多选项(见FATFS官网说明),我们这里设置为936,即简体中文(GBK码,需要c936.c文件支持,该文件在option文件夹)。
⑧_USE_LFN。该选项用于设置是否支持长文件名(还需要_CODE_PAGE支持),取值范围为0~3。0,表示不支持长文件名,1~3是支持长文件名,但是存储地方不一样,我们选择使用3,通过ff_memalloc函数来动态分配长文件名的存储区域。
⑨_VOLUMES。用于设置FATFS支持的逻辑设备数目,我们设置为3的话,即支持3个设备(磁盘)。
⑩_MAX_SS。扇区缓冲的最大值,一般设置为512。
8、FATFS移植步骤
①数据类型:在integer.h里面去定义好数据的类型。这里需要了解你用的编译器的数据类型,并根据编译器定义好数据类型。
②配置:通过ffconf.h配置FATFS的相关功能,以满足你的需要。
③函数编写:打开diskio.c,进行底层驱动编写,一般需要编写6个接口函数
9、FATFS开放函数
f_mount - 注册/注销一个工作区域(Work Area)
f_open - 打开/创建一个文件
f_close - 关闭一个文件
f_read - 读文件
f_write - 写文件
f_lseek - 移动文件读/写指针
f_truncate -截断文件
f_sync - 冲洗缓冲数据 FlushCached Data
f_forward - 直接转移文件数据到一个数据流
f_stat - 获取文件状态
f_opendir - 打开一个目录
f_closedir -关闭一个已经打开的目录
f_readdir - 读取目录条目
f_mkdir - 创建一个目录
f_unlink -删除一个文件或目录
f_chmod - 改变属性(Attribute)
f_utime -改变时间戳(Timestamp)
f_rename - 重命名/移动一个文件或文件夹
f_chdir - 改变当前目录
f_chdrive - 改变当前驱动器
f_getcwd - 获取当前工作目录
f_getfree - 获取空闲簇 GetFree Clusters
f_getlabel - Get volume label
f_setlabel - Set volume label
f_mkfs - 在驱动器上创建一个文件系统
f_fdisk - Divide a physicaldrive
f_gets - 读一个字符串
f_putc - 写一个字符
f_puts - 写一个字符串
f_printf - 写一个格式化的字符串
f_tell - 获取当前读/写指针
f_eof - 测试文件结束
f_size - 获取文件大小
f_error - 测试文件上的错误
二、sd卡移植FATFS文件系统方法
方法一:官网库移植
1) 官网下载Fatfs库
FATFS官网
FatFs - Generic FAT Filesystem Module
2) 将源文件添加到工程
该工程需要实现某存储器的读写等底层驱动,比如SD卡或者FLASH亦或者磁盘等存储介质
ff.c //FatFs module.
ffconf.h //Configuration file of FatFs module.
ff.h //Common include file for FatFs and application module.
diskio.h //Common include file for FatFs and disk I/O module.
diskio.c //An example of glue function to attach existing disk I/O module to FatFs.
ffunicode.c //Optional Unicode utility functions.
ffsystem.c //An example of optional O/S related functions.
3) 修改FATFS相关函数接口
主要包括diskio.c中的:
① disk_status()//获取设备状态
DSTATUS disk_status (
BYTE pdrv /* Physical drive nmuber to identify the drive */
)
{
DSTATUS stat;
switch (pdrv)
{
case DEV_SD :
if(SD_GetCID(ciddata)) //调用SD卡的获取设备状态函数接口
stat = RES_ERROR;
else
stat = RES_OK;
return stat;
}
return STA_NOINIT;/* Drive not initialized */
}
② disk_initialize()//初始化
/*@pdrv Physical drive nmuber to identify the drive */
DSTATUS disk_initialize (BYTE pdrv)
{
DSTATUS stat;
switch (pdrv) {
case DEV_SD :
SD_Init();//初始化SD卡
if(SD_GetCID(ciddata)) //重新获取一下SD卡的ID,看是否初始化成功
stat = RES_ERROR;
else
stat = RES_OK;
return stat;
}
return STA_NOINIT;/* Drive not initialized */
}
③ disk_read()//设备读
DRESULT disk_read (
BYTE pdrv, /* Physical drive nmuber to identify the drive */
BYTE *buff, /* Data buffer to store read data */
LBA_t sector, /* Start sector in LBA */
UINT count /* Number of sectors to read */
)
{
DRESULT res;
switch (pdrv) {
case DEV_SD :
res = SD_ReadDisk(buff, sector, count);
if(res != 0) //读失败
{
SD_Init();//重新初始化SD卡
res = SD_ReadDisk(buff, sector, count);//重新读
}
return res;
}
return RES_PARERR;
}
④ disk_write()//设备写
DRESULT disk_write (
BYTE pdrv, /* Physical drive nmuber to identify the drive */
const BYTE *buff, /* Data to be written */
LBA_t sector, /* Start sector in LBA */
UINT count /* Number of sectors to write */
)
{
DRESULT res;
switch (pdrv) {
case DEV_SD :
res = SD_WriteDisk((BYTE *)buff, sector, count);
if( res != 0) //写失败
{
SD_Iint();//重新初始化SD卡
res = SD_WriteDisk((BYTE *)buff, sector, count);//重新写
}
return res;
}
return RES_PARERR;
}
⑤ disk_ioctl()//设备属性接口
DRESULT disk_ioctl (
BYTE pdrv, /* Physical drive nmuber (0..) */
BYTE cmd, /* Control code */
void *buff /* Buffer to send/receive control data */
)
{
DRESULT res;
if(pdrv == DEV_SD)
{
switch (cmd)
{
case CTRL_SYNC:
res = RES_OK;
break;
case GET_SECTOR_SIZE:
*(DWORD*)buff = 512; //每个扇区的大小为512字节
res = RES_OK;
break;
case GET_BLOCK_SIZE:
*(WORD*)buff = 8;
res = RES_OK;
break;
case GET_SECTOR_COUNT:
*(DWORD*)buff = SD_GetSectorCount();//调用获取SD卡扇区个数的函数接口
res = RES_OK;
break;
default:
res = RES_PARERR;
break;
}
}
if(res)
return RES_PARERR;
return res;
}
4) 修改ffconf.h中的宏定义来使能相应的函数接口
#define FF_FS_READONLY 0 /*This option switches read-only configuration. (0:Read/Write or 1:Read-only)*/
#define FF_USE_MKFS 1/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
//f_mkfs() The f_mkfs function creates an FAT/exFAT volume on the logical drive.格式化,一般挂载失败可以尝试调用格式化一下磁盘在再重新挂载
#define FF_CODE_PAGE 936 /*支持文件名为中文格式*/
#define FF_USE_LFN 0
#define FF_MAX_LFN 255
/* The FF_USE_LFN switches the support for LFN (long file name).
/ 0: Disable LFN. FF_MAX_LFN has no effect.
/ 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.注意开启的话,会增大代码占用空间
/ 2: Enable LFN with dynamic working buffer on the STACK. 一般使用OS时设置
*/
#define FF_VOLUMES 1 /* Number of volumes (logical drives) to be used. (1-10) */
#define FF_MIN_SS 512
#define FF_MAX_SS 512
/*
/ 配置所支持的扇区大小范围。 (512, 1024, 2048或4096),一般大容量存储介质都配置为512,像磁盘,MMC等,对于flash一般需要将最大值设置为4096
*/
#define FF_FS_NORTC 0 /*0 使能时间戳,1 关闭时间戳,需要我们自己实现get_fattime(),可以开启RTC获得具体的时间*/
具体的宏定义查看官网具体配置介绍说明
FatFs - Configuration Options
以上就完成了移植与修改
9)API使用和操作
接下来就可以调用相应的API函数来实现文件的创建,读写等操作。
//设备挂载
FRESULT f_mount (
FATFS* fs, /* [IN] Filesystem object */
const TCHAR* path, /* [IN] Logical drive number */
BYTE opt /* [IN] Initialization option */
);
//设备卸载
FRESULT f_unmount (
const TCHAR* path /* [IN] Logical drive number */
);
//格式化设备
FRESULT f_mkfs (
const TCHAR* path, /* [IN] Logical drive number */
const MKFS_PARM* opt,/* [IN] Format options */
void* work, /* [-] Working buffer */
UINT len /* [IN] Size of working buffer */
);
// 打开或者创建一个文件
FRESULT f_open (
FIL* fp, /* Pointer to the blank file object */
const TCHAR* path, /* Pointer to the file name */
BYTE mode /* Access mode and file open mode flags */
)
//mode
#define FA_READ 0x01 // 指定对对象的读取权限。可以从文件中读取数据。
#define FA_WRITE 0x02 // 指定对对象的写访问权。数据可以写入文件。
#define FA_OPEN_EXISTING 0x00 // 打开文件。如果文件不存在,该函数将失败
#define FA_CREATE_NEW 0x04 // 创建一个新文件。如果文件存在,该函数将失败并显示 FR_EXIST 。
#define FA_CREATE_ALWAYS 0x08 // 创建一个新文件。如果文件存在,它将被截断并覆盖。
#define FA_OPEN_ALWAYS 0x10 // 如果文件存在,则打开该文件。如果不是,则创建一个新文件。
#define FA_OPEN_APPEND 0x30 // 存在则打开、不存在则创建,指针指向文件尾
//举例
f_open(fp,"att_log.txt",FA_WRITE|FA_OPEN_APPEND);
//格化式写入
/*-----------------------------------------------------------------------*/
/* Put a Formatted String to the File */
/*-----------------------------------------------------------------------*/
int f_printf (
FIL* fp, /* Pointer to the file object */
const TCHAR* fmt, /* Pointer to the format string */
... /* Optional arguments... */
)
//例如
f_printf(fp,"%d,%d\n",buff[0],buff[1]);
//关闭文件
FRESULT f_close (
FIL *fp /* Pointer to the file object to be closed */
)
//打开/创建文件、写完之后要关闭,否则最终的数据不会写到SD卡中
f_close(fp);
//关闭文件
FRESULT f_close (
FIL *fp /* Pointer to the file object to be closed */
)
//打开/创建文件、写完之后要关闭,否则最终的数据不会写到SD卡中
f_close(fp);
//写数据到文件里
FRESULT f_write (
FIL* fp, /* Pointer to the file object */
const void* buff, /* Pointer to the data to be written 要写进文件的数据buff*/
UINT btw, /* Number of bytes to write 要写的数据个数*/
UINT* bw /* Pointer to number of bytes written 写进文件的实际数据个数*/
)
//从文件里读
FRESULT f_read (
FIL* fp, /* Pointer to the file object */
void* buff, /* Pointer to data buffer 要存放数据的buff*/
UINT btr, /* Number of bytes to read 指定要读的数据长度*/
UINT* br /* Pointer to number of bytes read 实际读出的数据长度*/
)
/刷新(同步)文件
FRESULT f_sync (
FIL* fp /* Pointer to the file object */
)
//也就是不关闭文件可以继续写,但是可以保证前面写的数据保存到SD卡中,
//可以降低因断电等带来的数据丢失分析,f_close调用的也是f_sync.
//但是f_close关闭文件后要想继续写需要重新打开.
具体的解释与示例参考官网FatFs - Generic FAT Filesystem Module
基本上每个函数都有官方用法的示例参考。