FatFs移植

绝地灬酷狼 2022-11-06 15:54 264阅读 0赞

注：本文移植的FatFs版本号R0.14a

## 一、FatFs简介 ##

FatFs是用于小型嵌入式系统的通用FAT/exFAT文件系统模块。FatFs模块是按照ANSI C（C89）编写的，与磁盘I/O层完全分离。因此它独立于平台。它可以集成到资源有限的小型微控制器中，如8051、PIC、AVR、ARM、Z80、RX等。这里还提供用于微型微控制器的Petit-FatFs模块。

**特征**  
DOS/Windows兼容的FAT/exFAT文件系统。  
与平台无关。易于移植。  
程序代码和工作区占用空间非常小。

支持的各种配置选项：  
ANSI/OEM或Unicode格式的长文件名。  
exFAT文件系统，64位LBA和GPT，用于巨大的存储空间。  
线程安全的RTOS。  
多个卷（物理驱动器和分区）。  
可变扇区大小。  
包含DBC的多个代码页。  
只读、可选API、I/O缓冲区等。。。

### 1.1 获取最新版本 ###

从官网获取最新版本，持续更新：[FatFs官网][FatFs]  
如何获取可以参考： [FatFs最新版本获取方法][FatFs 1]

### 1.2 目录结构 ###

下载FatFs源码包解压后，在documents文件夹里面是一些使用的帮助文档；在source中是FatFs文件系统的源代码，source文件夹就是我们需要添加到工程中的文件。  
![在这里插入图片描述][20210310141540859.png]  
documents文件夹里有比较详细的帮助文档，查看**00index\_e.html**即可，00index\_e.html文件相当于doc文件夹内html文件的索引页。  
![在这里插入图片描述][2021031014210165.png]  
source中是FatFs文件系统的源码文件  
![在这里插入图片描述][20210310151911426.png]

**diskio.c**： 包含底层存储介质的操作函数，这些函数需要用户自己实现，主要添加底层驱动函数。

**ff.c**： FatFs 核心文件，文件管理的实现方法。该文件独立于底层介质操作文件的函数，利用这些函数实现文件的读写。

**ff.h**：里面有针对文件系统所统一的字节类型：WORD、DWORD等类型，这是为了避免因内核不同而导致一些字节类型的定义不统一。所以，关乎到文件系统的字节定义都是要该文件系统中的字节类型进行定义就可以实现统一性。

**ffconf.h**：这个头文件包含了对 FatFs 功能配置的宏定义， 通过修改这些宏定义就可以裁剪 FatFs的功能。如需要支持简体中文，需要把 ffconf.h中的\_CODE\_PAGE 的宏改成 936 并把上面的 ffunicode.c 文件加入到工程之中。

以前的版本里有cc936.c文件等分别用于不同编码支持，现在只有一个ffunicode.c实现。

## 二、FatFs移植 ##

首先说重点，**移植只需要修改 ffconf.h 和 diskio.c 两个文件**  
FatFs要求用户提供的接口如下（主要是一些底层媒体介质的读写接口）：

![20210310143851195.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70][]  
上图中的六个函数位于diskio.c文件中，再加上我们需要适当的修改宏定义，位于ffconf.h中。所以实际上我们在进行文件系统移植的时候，只需要修改ffconf.h和diskio.c两个文件。

### 2.1 添加文件到工程 ###

这里我们以STM32平台为例，首先准备一个能顺利运行的SPI-FLASH的基础工程，能实现初始化，读写，擦除操作等，本示例工程应用的型号是W25Q64，即总容量8M字节。  
将下载的源码包里的source文件夹复制到工程路径下，更换名称为文件名为FatFs，同时在KEIL中新建分组名为FatFs，添加三个文件diskio.c，ff.c，以及ffuicode.c，其中ffuicode.c是用于中文支持，如果不需要中文支持，可不添加。  
![在这里插入图片描述][20210310145028410.png]  
添加 FatFs 文件夹到工程的 include 选项中。打开工程选项对话框，选择“C/C++”选项下的“Include Paths”项目，在弹出路径设置对话框中选择添加“FatFs”文件夹  
![在这里插入图片描述][20210310145634827.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70]

### 2.2 修改diskio.c ###

（1）include bsp\_spi\_flash.h文件，屏蔽或删除原示例的设备物理编号宏定义，添加我们自己的宏定义，这里定义了两个，一个预留给SD卡使用，一个是我们需要用的SPI\_FLASH  
![在这里插入图片描述][20210310150112106.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70]  
（2）修改disk\_status 函数（原来的diskio.c文件里有该函数的示例，需要在原基础上修改，后面的函数也是同理，不再赘述）

/*-----------------------------------------------------------------------*/
    /* 获取设备状态 */
    /*-----------------------------------------------------------------------*/
    DSTATUS disk_status (
    	BYTE pdrv		/* 物理编号 */
    )
    { 
    
    	DSTATUS status = STA_NOINIT;
    	
    	switch (pdrv) { 
    		case ATA:	/* SD CARD */
    			break;
        
    		case SPI_FLASH:      
    			/* SPI Flash状态检测：读取SPI Flash 设备ID */
    			if(sFLASH_ID == SPI_FLASH_ReadID())
    			{ 
    			  /* 设备ID读取结果正确 */
    			  status &= ~STA_NOINIT;
    			}
    			else
    			{ 
    			  /* 设备ID读取结果错误 */
    			  status = STA_NOINIT;;
    			}
    			break;
    
    		default:
    			status = STA_NOINIT;
    	}
    	return status;
    }

（3）修改disk\_initialize 函数

/*-----------------------------------------------------------------------*/
    /* 设备初始化 */
    /*-----------------------------------------------------------------------*/
    DSTATUS disk_initialize (
    	BYTE pdrv				/* 物理编号 */
    )
    { 
      uint16_t i;
    	DSTATUS status = STA_NOINIT;	
    	switch (pdrv) { 
    		case ATA:	         /* SD CARD */
    			break;
        
    		case SPI_FLASH:    /* SPI Flash */ 
    			/* 初始化SPI Flash */
    			SPI_FLASH_Init();
    			/* 延时一小段时间 */
    			i=500;
    			while(--i);	
    			/* 唤醒SPI Flash */
    			SPI_Flash_WAKEUP();
    			/* 获取SPI Flash芯片状态 */
    			status=disk_status(SPI_FLASH);
    			break;
          
    		default:
    			status = STA_NOINIT;
    	}
    	return status;
    }

（4）修改disk\_read 函数

/*-----------------------------------------------------------------------*/
    /* 读扇区：读取扇区内容到指定存储区 */
    /*-----------------------------------------------------------------------*/
    DRESULT disk_read (
    	BYTE pdrv,		/* 设备物理编号(0..) */
    	BYTE *buff,		/* 数据缓存区 */
    	DWORD sector,	/* 扇区首地址 */
    	UINT count		/* 扇区个数(1..128) */
    )
    { 
    	DRESULT status = RES_PARERR;
    	switch (pdrv) { 
    		case ATA:	/* SD CARD */
    			break;
        
    		case SPI_FLASH:
    			/* 扇区偏移2MB，外部Flash文件系统空间放在SPI Flash后面6MB空间 */
    			sector+=512;      
    			SPI_FLASH_BufferRead(buff, sector <<12, count<<12);//<<12是*4096
    			status = RES_OK;
    			break;
        
    		default:
    			status = RES_PARERR;
    	}
    	return status;
    }

（5）修改disk\_write 函数

/*-----------------------------------------------------------------------*/
    /* 写扇区：见数据写入指定扇区空间上 */
    /*-----------------------------------------------------------------------*/
    #if FF_FS_READONLY == 0
    
    DRESULT disk_write (
    	BYTE pdrv,			  /* 设备物理编号(0..) */
    	const BYTE *buff,	/* 欲写入数据的缓存区 */
    	DWORD sector,		  /* 扇区首地址 */
    	UINT count			  /* 扇区个数(1..128) */
    )
    { 
      uint32_t write_addr; 
    	DRESULT status = RES_PARERR;
    	if (!count) { 
    		return RES_PARERR;		/* Check parameter */
    	}
    
    	switch (pdrv) { 
    		case ATA:	/* SD CARD */      
    		break;
    
    		case SPI_FLASH:
    			/* 扇区偏移2MB，外部Flash文件系统空间放在SPI Flash后面6MB空间 */
    			sector+=512;
    			write_addr = sector<<12;    
    			SPI_FLASH_SectorErase(write_addr);
    			SPI_FLASH_BufferWrite((u8 *)buff,write_addr,count<<12);
    			status = RES_OK;
    			break;
        
    		default:
    			status = RES_PARERR;
    	}
    	return status;
    }
    #endif

（6）修改disk\_ioctl 函数

DRESULT disk_ioctl (
    	BYTE pdrv,		/* 物理编号 */
    	BYTE cmd,		  /* 控制指令 */
    	void *buff		/* 写入或者读取数据地址指针 */
    )
    { 
    	DRESULT status = RES_PARERR;
    	switch (pdrv) { 
    		case ATA:	/* SD CARD */
    			break;
        
    		case SPI_FLASH:
    			switch (cmd) { 
    				/* 扇区数量：1536*4096/1024/1024=6(MB) */
    				case GET_SECTOR_COUNT:
    					*(DWORD * )buff = 1536;		
    					break;
    				/* 扇区大小 */
    				case GET_SECTOR_SIZE :
    					*(WORD * )buff = 4096;
    					break;
    				/* 同时擦除扇区个数 */
    				case GET_BLOCK_SIZE :
    					*(DWORD * )buff = 1;
    	        	break;        
    			}
    			status = RES_OK;
    			break;
        
    		default:
    			status = RES_PARERR;
    	}
    	return status;
    }

（7）添加get\_fattime函数，这里只是模拟给了一个固定的时间，不是实际的当前时间。  
get\_fattime 函数用于获取当前时间戳，在 ff.c 文件中被调用。 FatFs 在文件创建、被修改时会记录时间，这里我们直接使用赋值方法设定时间戳。为更好的记录时间，可以使用 RTC 功能，在该函数中通过RTC获取当前系统时间即可。  
具体要求返回值格式为：  
bit\[31:25\] ——从 1980 至今是多少年，范围是 (0…127) ；  
bit\[24:21\] ——月份，范围为 (1…12) ；  
bit\[20:16\] ——该月份中的第几日，范围为(1…31) ；  
bit\[15:11\]——时，范围为 (0…23)；  
bit\[10:5\] ——分，范围为 (0…59)；  
bit\[4:0\] ——秒/ 2，范围为 (0…29) 。

__weak DWORD get_fattime(void) { 
    	/* 返回当前时间戳 */
    	return	  ((DWORD)(2015 - 1980) << 25)	/* Year 2015 */
    			| ((DWORD)1 << 21)				/* Month 1 */
    			| ((DWORD)1 << 16)				/* Mday 1 */
    			| ((DWORD)0 << 11)				/* Hour 0 */
    			| ((DWORD)0 << 5)				  /* Min 0 */
    			| ((DWORD)0 >> 1);				/* Sec 0 */
    }

### 2.3 修改ffconf.h ###

使能用到的功能，下面只列出要修改的

#define FF_USE_MKFS 1
    /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
    
    #define FF_CODE_PAGE 936
    /* This option specifies the OEM code page to be used on the target system. / Incorrect code page setting can cause a file open failure. / / 437 - U.S. / 720 - Arabic / 737 - Greek / 771 - KBL / 775 - Baltic / 850 - Latin 1 / 852 - Latin 2 / 855 - Cyrillic / 857 - Turkish / 860 - Portuguese / 861 - Icelandic / 862 - Hebrew / 863 - Canadian French / 864 - Arabic / 865 - Nordic / 866 - Russian / 869 - Greek 2 / 932 - Japanese (DBCS) / 936 - Simplified Chinese (DBCS) / 949 - Korean (DBCS) / 950 - Traditional Chinese (DBCS) / 0 - Include all code pages above and configured by f_setcp() */
    
    #define FF_USE_LFN 1
    #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. / 3: Enable LFN with dynamic working buffer on the HEAP. / / To enable the LFN, ffunicode.c needs to be added to the project. The LFN function / requiers certain internal working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and / additional (FF_MAX_LFN + 44) / 15 * 32 bytes when exFAT is enabled. / The FF_MAX_LFN defines size of the working buffer in UTF-16 code unit and it can / be in range of 12 to 255. It is recommended to be set it 255 to fully support LFN / specification. / When use stack for the working buffer, take care on stack overflow. When use heap / memory for the working buffer, memory management functions, ff_memalloc() and / ff_memfree() exemplified in ffsystem.c, need to be added to the project. */
    
    #define FF_VOLUMES 2
    /* Number of volumes (logical drives) to be used. (1-10) */
    
    #define FF_MIN_SS 512
    #define FF_MAX_SS 4096

1.  FF\_USE\_MKFS：格式化功能选择，为使用 FatFs 格式化功能即f\_mkfs()函数，需要把它设置为 1。
2.  FF\_CODE\_PAGE：语言功能选择，并要求把相关语言文件添加到工程宏。为支持简体中文文件名需要使用“936”。
3.  FF\_USE\_LFN：长文件名支持，默认不支持长文件名，这里配置为 1。  
    配置为“\#define FF\_USE\_LFN 1”就是将文件名存储在BSS段（数据段），也就是将其作为全局变量进行存储;  
    配置为“\#define FF\_USE\_LFN 2”就是将 文件名存储在STACK区（栈区）；  
    配置为“\#define FF\_USE\_LFN 3”就是将文件名存储在HEAP（堆区）
4.  FF \_VOLUMES：指定物理设备数量，这里设置为 2，包括预留 SD 卡和 SPI Flash 芯片。
5.  FF\_MIN\_SS 、FF\_MAX\_SS：指定扇区大小的最小值和最大值。 SD 卡扇区大小一般都为 512字节， SPI Flash芯片扇区大小一般设置为 4096字节，所以需要把\_MAX\_SS改为 4096。

新版本的ffconf.h里的宏都在前面新增加了FF，如FF\_USE\_MKFS以前是\_USE\_MKFS，这里了解就行。

以上步骤至此就完成了FatFs移植了。

好文推荐：  
[https://blog.csdn.net/qq\_39778488/article/details/107129578][https_blog.csdn.net_qq_39778488_article_details_107129578]

[FatFs]: http://elm-chan.org/fsw/ff/00index_e.html
[FatFs 1]: https://blog.csdn.net/weixin_44788542/article/details/114589201
[20210310141540859.png]: /images/20221023/7aa78d38e3c54f93b434d1602145c2e3.png
[2021031014210165.png]: /images/20221023/77484b0e14de4b65aa299427a3660448.png
[20210310151911426.png]: /images/20221023/8de35e82cc49484ca6b0896c82477520.png
[20210310143851195.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70]: /images/20221023/293ee9697829400daf45d5555f696aa2.png
[20210310145028410.png]: /images/20221023/1bdbf4a6f2de42c49e61473a097d2f2c.png
[20210310145634827.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70]: /images/20221023/00a756ab41c14ae186f3a890e7fde84f.png
[20210310150112106.png_x-oss-process_image_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc4ODU0Mg_size_16_color_FFFFFF_t_70]: /images/20221023/aa877b60b66c4a25a09224054123b35d.png
[https_blog.csdn.net_qq_39778488_article_details_107129578]: https://blog.csdn.net/qq_39778488/article/details/107129578