FatFS文件系统是单片机领域有名的一个文件系统,由于它的轻量级和兼容性,备受MCU开发者青睐。
在实现如U盘文件读写,SD卡的文件读写等工作时,我们往往需要一个文件系统来支持我们的工作。特别在一些MCU应用中,文件系统的加入能明显改善系统交互的友好性。
在这一篇中,我们就来讨论FatFS文件系统在STM32F4上的移植和应用。
1、准备工作
在开始FatFS的移植之前我们需要做一些必要的准备工作。首先需要准备相应的硬件平台,我们在这里使用的是STM32F407VET6的操作平台。USB硬件相关的库的移植工作也已完成。
其次我们还需要准备FatFS的相关源码,在这里我们使用最新的R0.14b版本,该文件可在网站下载:
http://elm-chan.org/fsw/ff/00index_e.html
下载的源码解压后有两个文件夹:document和source,其中document文件夹中是相关的文档资料,与网站上的内容一样,在移植时可以查看这些文档来工作。Source文件夹中则是源码相关的文件,主要包括:
在上图所示的一系列文件中,00readme.txt文件有对各个文件的介绍,我们查看其内容如下:
00readme.txt | readme文件 |
---|---|
00history.txt | 版本记录文件 |
ff.c | FatFs模块 |
ffconf.h | FatFs模块的配置文件 |
ff.h | FatFs应用模块的头文件 |
diskio.h | FatFs和磁盘IO模块的头文件 |
diskio.c | 一个将磁盘IO函数附加到FatFS的实例 |
ffunicode.c | Unicode编码功能函数 |
ffsystem.c | 可选的操作系统相关文件实例 |
在这些文件中,ff.c和ff.h是核心文件。ffunicode.c是字符编码,会根据配置文件的配置选择编码。ffsystem.c文件根据自己的需要决定。所以与具体的应用平台相关的,并需要我们来实现的文件是配置文件ffconf.h和磁盘操作文件diskio.h与diskio.c,这几个文件也是我们移植的重点。
2、实现移植
我们已经完成了移植的准备工作,接下来就来实现面向大容量U盘的应用移植。前面我们已经说过,移植需要处理的文件是配置文件ffconf.h和磁盘操作文件diskio.h与diskio.c。
关于配置文件ffconf.h其实它本身有一个实例,我们只需要根据需要修改配置就好。这里我们需要修改的配置参数包括:
所支持的编码方式配置参数FF_CODE_PAGE,这个关系到文件编码的问题,我们将其配置为简体中文支持。
逻辑驱动器的数量配置参数FF_VOLUMES,FatFS可以同时应用于多个驱动器,所以我们需要根据实际情况配置驱动器的数量。
时间戳配置参数FF_FS_NORTC,我们大多时候并不需要记录时间戳,所以在这里我们将其关闭。
余下就是实现磁盘IO操作的相关函数,在FatFS的帮助文档中告诉了我们需要实现的函数有两类:一类是磁盘设备控制相关的函数,主要是获取设备状态函数、初始化设备函数、读取数据函数、写入数据函数以及控制设备相关功能函数;二类是实时时钟操作函数,主要是获取当前时间函数。所以实现这6个函数就是移植的主要工作。
2.1、获取设备状态函数
磁盘状态检测函数disk_status。用于检测磁盘状态,在ff.c文件中会被调用。其函数原型如下:
DSTATUS disk_status(BYTE drV);
根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘状态获取函数如下:
/*用于USBH的状态获取函数*/
static DSTATUS USBH_status(BYTE lun)
{
DRESULT res = RES_ERROR;
if(USBH_MSC_UnitIsReady(&hUsbHostFS, lun))
{
res = RES_OK;
}
else
{
res = RES_ERROR;
}
return res;
}
2.2、初始化设备函数
存储媒介初始化函数disk_initialize。用于对磁盘设备进行初始化,在ff.c文件中会被调用。其函数原型如下:
DSTATUS disk_initialize(BYTE drv);
根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘驱动器初始化函数,但这里我们其实不需要,因为在USB HOST库中已经完成了初始化,所以直接返回正确就可以了。
/*用于USBH的初始化函数*/
static DSTATUS USBH_initialize(BYTE lun)
{
//USB HOST库中已经完成了初始化
return RES_OK;
}
2.3、读取数据
读扇区函数disk_read。用于实现对磁盘数据的读取,根据具体的磁盘IO编写,在ff.c文件中会被调用。其函数原型如下:
DRESULT disk_read(BYTE drv,BYTE*buff,DWORD sector,BYTE.count);
根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘数据读取函数如下:
/*用于USBH的读扇区函数*/
static DRESULT USBH_read(BYTE lun, BYTE *buff, DWORD sector, UINT count)
{
DRESULT res = RES_ERROR;
MSC_LUNTypeDef info;
if(USBH_MSC_Read(&hUsbHostFS, lun, sector, buff, count) == USBH_OK)
{
res = RES_OK;
}
else
{
USBH_MSC_GetLUNInfo(&hUsbHostFS, lun, &info);
switch (info.sense.asc)
{
case SCSI_ASC_LOGICAL_UNIT_NOT_READY:
case SCSI_ASC_MEDIUM_NOT_PRESENT:
case SCSI_ASC_NOT_READY_TO_READY_CHANGE:
USBH_ErrLog ("USB Disk is not ready!");
res = RES_NOTRDY;
break;
default:
res = RES_ERROR;
break;
}
}
return res;
}
2.4、写入数据
写扇区函数disk_write。用于实现对磁盘数据的写入,根据具体的磁盘IO编写,在ff.c文件中会被调用。其函数原型如下:
DRESULT disk_write(BYTE drv,const BYTE*buff,DWORD sector,BYTE count);
根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘数据写入函数如下:
/*用于USBH的写扇区函数*/
static DRESULT USBH_write(BYTE lun, const BYTE *buff, DWORD sector, UINT count)
{
DRESULT res = RES_ERROR;
MSC_LUNTypeDef info;
if(USBH_MSC_Write(&hUsbHostFS, lun, sector, (BYTE *)buff, count) == USBH_OK)
{
res = RES_OK;
}
else
{
USBH_MSC_GetLUNInfo(&hUsbHostFS, lun, &info);
switch (info.sense.asc)
{
case SCSI_ASC_WRITE_PROTECTED:
USBH_ErrLog("USB Disk is Write protected!");
res = RES_WRPRT;
break;
case SCSI_ASC_LOGICAL_UNIT_NOT_READY:
case SCSI_ASC_MEDIUM_NOT_PRESENT:
case SCSI_ASC_NOT_READY_TO_READY_CHANGE:
USBH_ErrLog("USB Disk is not ready!");
res = RES_NOTRDY;
break;
default:
res = RES_ERROR;
break;
}
}
return res;
}
2.5、控制设备相关功能
存储媒介控制函数disk_ioctl。可以在此函数里编写自己需要的功能代码,比如获得存储媒介的大小、检测存储媒介的上电与否存储媒介的扇区数等。如果是简单的应用,也可以不用编写。其函数原型如下:
DRESULT disk_ioctl(BYTE drv,BYTE ctrl,VoiI*buff); 根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘设备控制相关功能函数如下:
/*USBH IO控制函数 */
static DRESULT USBH_ioctl(BYTE lun, BYTE cmd, void *buff)
{
DRESULT res = RES_ERROR;
MSC_LUNTypeDef info;
switch (cmd)
{
/* Make sure that no pending write process */
case CTRL_SYNC:
res = RES_OK;
break;
/* Get number of sectors on the disk (DWORD) */
case GET_SECTOR_COUNT :
if(USBH_MSC_GetLUNInfo(&hUsbHostFS, lun, &info) == USBH_OK)
{
*(DWORD*)buff = info.capacity.block_nbr;
res = RES_OK;
}
else
{
res = RES_ERROR;
}
break;
/* Get R/W sector size (WORD) */
case GET_SECTOR_SIZE :
if(USBH_MSC_GetLUNInfo(&hUsbHostFS, lun, &info) == USBH_OK)
{
*(DWORD*)buff = info.capacity.block_size;
res = RES_OK;
}
else
{
res = RES_ERROR;
}
break;
/* Get erase block size in unit of sector (DWORD) */
case GET_BLOCK_SIZE :
if(USBH_MSC_GetLUNInfo(&hUsbHostFS, lun, &info) == USBH_OK)
{
*(DWORD*)buff = info.capacity.block_size / USB_DEFAULT_BLOCK_SIZE;
res = RES_OK;
}
else
{
res = RES_ERROR;
}
break;
default:
res = RES_PARERR;
}
return res;
}
2.6、获取当前时间
实时时钟函数get_fattime。用于获取当前时间,返回一个32位无符号整数,时钟信息包含在这32位中。如果不使用时间戳,可以直接返回一个数,如0。其函数原型如下:
DWORD get_fattime(Void);
根据其原型定义以及我们USB大容量存储设备的要求,我们可以实现磁盘状态获取函数如下:
/*读取时钟函数*/
DWORD get_fattime(void)
{
return 0;
}
完成上述6个程序的编写,移植工作也就基本完成了。大家可能会发现,我们实现的函数名似乎与原型函数不一样,主要是考虑方便在多个存储设备同时存在时进行操作,我们在目标函数中调用我们实现的函数就可以了。
3、应用测试
我们完成了FatFS的移植,现在来验证移植的是否正确。为此,我们来编写一个应用,向U盘中写入数据到文件以及读取文件的数据等。
/* USB HOST MSC操作函数,这部分功能根据需求设定 */
static void MSC_Application(void)
{
FRESULT res; /* FatFs函数返回值 */
uint32_t byteswritten, bytesread; /* 文件读写的数量 */
uint8_t wtext[] = "This is STM32 working with FatFs!"; /* 写文件缓冲器 */
uint8_t wtext2[] = "这是一个FatFs读写的例子!"; /* 写文件缓冲器 */
uint8_t wtext3[] = "这是一个向文件追加数据的测试!"; /* 写文件缓冲器 */
uint8_t rtext[100]; /* 读文件缓冲器 */
/* 注册文件系统对象到FatFs模块 */
if(f_mount(&USBHFatFS, (TCHAR const*)USBHPath, 0) != FR_OK)
{
/* 错误处理 */
Error_Handler();
}
else
{
/* 打开一个文件 */
if(f_open(&USBHFile, "STM32.TXT", FA_OPEN_EXISTING | FA_WRITE) != FR_OK)
{
/* 错误处理 */
Error_Handler();
}
else
{
res=f_lseek(&USBHFile,f_size(&USBHFile)); //将指针指向文件末
//res=f_lseek(&USBHFile,100); //将指针指向文件末
/* 写数据到文件 */
res = f_write(&USBHFile, wtext, sizeof(wtext), (void *)&byteswritten);
res = f_write(&USBHFile, "\r\n", sizeof("\r\n")-1, &byteswritten);
res = f_write(&USBHFile, wtext2, sizeof(wtext2), (void *)&byteswritten);
res = f_write(&USBHFile, "\r\n", sizeof("\r\n")-1, &byteswritten);
res = f_write(&USBHFile, wtext3, sizeof(wtext3), (void *)&byteswritten);
res = f_write(&USBHFile, "\r\n", sizeof("\r\n")-1, &byteswritten);
if((byteswritten == 0) || (res != FR_OK))
{
/* 错误处理 */
Error_Handler();
}
else
{
/* 关闭文件 */
f_close(&USBHFile);
/* 打开文件读 */
if(f_open(&USBHFile, "STM32.TXT", FA_READ) != FR_OK)
{
/* 错误处理 */
Error_Handler();
}
else
{
/* 从文件读数据 */
res = f_read(&USBHFile, rtext, sizeof(rtext), (void *)&bytesread);
if((bytesread == 0) || (res != FR_OK))
{
/* 错误处理 */
Error_Handler();
}
else
{
/* 关闭文件 */
f_close(&USBHFile);
/* 比较读和写的数据 */
if((bytesread != byteswritten))
{
/* 错误处理*/
Error_Handler();
}
else
{
/* 无错误 */
}
}
}
}
}
}
FATFS_UnLinkDriver(USBHPath);
}
我们先在U盘上创建的文件,名为"STM32.TXT",在上述源码中,我们创建完文件后将其修改为打开与存在文件。创建的文件如下图所示:
向创建的STM32.TXT文件中写入"This is STM32 working with FatFs!",我们查看文件内容,结果如下:
接着我们尝试向已经存在的文件中追加内容。依然是STM32.TXT文件,我们操作完毕,查看其内容图下:
至此,我们完成了FatFS文件系统的移植与测试,从测试结果看,移植是正确的,至少在简单应用下没有发现问题。
4、移植小结
在这篇中,我们移植了FatFS文件系统,并进行了简单的读写测试。从测试的结果来看,FatFS的一直是没有问题的,至少验证了在一般的读写操作方面是没有问题的。
在我们移植时,我们考虑到在同时有多种驱动器的情况下能够方便的操作。我们定义的磁盘IO操作函数是需要根据实际硬件实现的,然后在系统指定的回调函数中调用我们编写的磁盘IO函数。这样就可以实现多个驱动器的操作,事实上FatFS给出的磁盘IO示例中也是这样建议的。