代码收藏家技术教程 2024-05-07

STM32 HAL开发指南：如何移植FatFs文件系统

FatFs文件系统移植

FatFs 程序结构图

移植 FatFs 之前我们先通过 FatFs 的程序结构图了解 FatFs 在程序中的关系网络

用户应用程序需要由用户编写，想实现什么功能就编写什么的程序，一般我们只用到 f_mount()、f_open()、 f_write()、f_read() 就可以实现文件的读写操作。
FatFs 组件是 FatFs 的主体，文件都在源码 src 文件夹中，其中 ff.c、 ff.h、 integer.h 以及 diskio.h 四个文件我们不需要改动，只需要修改 ffconf.h 和 diskio.c 两个文件。
底层设备输入输出要求实现存储设备的读写操作函数、存储设备信息获取函数等等。我们使用SPI Flash 芯片作为物理设备。

FatFs移植步骤一

1.将 FatFs 源码中的 src 文件夹整个文件夹拷贝一份至“SPI—FatFs 文件系统 USER”文件夹下并修改名为“FATFS

2.将 FatFs 组件文件添加到工程中，需要添加有 ff.c、 diskio.c 和 cc936.c 三个文件

添加 FATFS 文件夹到工程的 include 选项中。打开工程选项对话框，选择“C/C++”选项下的“Include Paths”项目，在弹出路径设置对话框中选择添加“FATFS”文件夹

4.如果现在编译工程，可以发现有两个错误，一个是来自 diskio.c 文件，提示有一些头文件没找到，diskio.c 文件内容是与底层设备输入输出接口函数文件，不同硬件设计驱动就不同，需要的文件也不同；另外一个错误来自 cc936.c 文件，提示该文件不是工程所必需的，这是因为 FatFs 默认使用日语，我们想要支持简体中文需要修改 FatFs 的配置，即修改 ffconf.h

5.FatFs 文件系统与底层介质的驱动分离开来，对底层介质的操作都要交给用户去实现，它仅仅是提供了一个函数接口而已。下表为 FatFs 移植时用户必须支持的函数。通过下表我们可以清晰知道很多函数是在一定条件下才需要添加的，只有前三个函数是必须添加的。我们完全可以根据实际需求选择实现用到的函数。
前三个函数是实现读文件最基本需求。接下来三个函数是实现创建文件、修改文件需要的。为实现格式化功能，需要在 disk_ioctl 添加两个获取物理设备信息选项。我们一般只要实现前面六个函数就可以了，已经足够满足大部分功能。
为支持简体中文长文件名称需要添加 ff_convert 和 ff_wtoupper 函数，实际这两个已经在 cc936.c文件中实现，我们只要直接把 cc936.c 文件添加到工程中就可以。

底层设备驱动函数是存放在 diskio.c 文件，我们的目的就是把 diskio.c 中的函数接口与 SPI Flash芯片驱动连接起来。总共有五个函数，分别为设备状态获取 (disk_status)、设备初始化 (disk_initialize)、扇区读取(disk_read)、扇区写入 (disk_write)、其他控制 (disk_ioctl)。

FatFs移植步骤二

1.设备状态获取

/* 为每个设备定义一个物理编号 */
#define ATA			    0     // 预留SD卡使用
#define SPI_FLASH		1     // 外部SPI Flash

/*-----------------------------------------------------------------------*/
/* 获取设备状态                                                          */
/*-----------------------------------------------------------------------*/
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;
}

disk_status 函数只有一个参数 pdrv，表示物理编号。一般我们都是使用 switch 函数实现对 pdrv的分支判断。对于 SD 卡只是预留接口，留空即可。对于 SPI Flash 芯片，我们直接调用在SPI_FLASH_ReadID() 获取设备 ID，然后判断是否正确，如果正确，函数返回正常标准；如果错误，函数返回异常标志。 SPI_FLASH_ReadID() 是定义在 bsp_spi_flash.c 文件中，上一章节已做了分析。

2.设备初始化

/*-----------------------------------------------------------------------*/
/* 设备初始化                                                            */
/*-----------------------------------------------------------------------*/
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;
}

disk_initialize 函数也是有一个参数 pdrv，用来指定设备物理编号。对于 SPI Flash 芯片我们调用 SPI_FLASH_Init() 函数实现对 SPI Flash 芯片引脚 GPIO 初始化配置以及 SPI 通信参数配置。SPI_Flash_WAKEUP() 函数唤醒 SPI Flash 芯片，当 SPI Flash 芯片处于睡眠模式时需要唤醒芯片才可以进行读写操作。

3.读取扇区

/*-----------------------------------------------------------------------*/
/* 读扇区：读取扇区内容到指定存储区                                              */
/*-----------------------------------------------------------------------*/
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);
      status = RES_OK;
		
		  /* 不想偏移 */
//      SPI_FLASH_BufferRead((BYTE *)buff, sector<<12, count<<12);
      status = RES_OK;
		
		break;
    
		default:
			status = RES_PARERR;
	}
	return status;
}

disk_read 函数有四个形参。 pdrv 为设备物理编号。 buff 是一个 BYTE 类型指针变量， buff指向用来存放读取到数据的存储区首地址。 sector 是一个 DWORD 类型变量，指定要读取数据的扇区首地址。 count 是一个UINT 类型变量，指定扇区数量。

BYTE 类型实际是 unsigned char 类型， DWORD 类型实际是 unsigned long 类型， UINT 类型实际是unsigned int 类型，类型定义在 integer.h 文件中。

开发板使用的 SPI Flash 芯片型号为 W25Q64FV，每个扇区大小为 4096 个字节 (4KB)，总共有 8M字节空间，为兼容后面实验程序，我们只将后部分 6MB 空间分配给 FatFs 使用，前部分 2MB 空间用于其他实验需要，即 FatFs是从 2MB 空间开始，为实现这个效果需要将所有的读写地址都偏移 512 个扇区空间。

对于 SPI Flash 芯片，主要是使用 SPI_FLASH_BufferRead() 实现在指定地址读取指定长度的数据，它接收三个参数，第一个参数为指定数据存放地址指针。第二个参数为指定数据读取地址，这里使用左移运算符，左移 12 位实际是乘以 4096，这与每个扇区大小是息息相关的。第三个参数为读取数据个数，也是需要使用左移运算符。

4.扇区写入

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((uint8_t *)buff,write_addr,count<<12);
      status = RES_OK;
		
      /* 不想偏移 */
//      SPI_FLASH_SectorErase(sector<<12);
//      SPI_FLASH_BufferWrite((BYTE *)buff, sector<<12, count<<12);
//      status = RES_OK;		
		
		break;
    
		default:
			status = RES_PARERR;
	}
	return status;
}

disk_write 函数有四个形参， pdrv 为设备物理编号。 buff 指向待写入扇区数据的首地址。 sector，指定要写入数据的扇区首地址。 count 指定扇区数量。对于 SPI Flash 芯片，在写入数据之前需要先擦除，所以用到扇区擦除函数 (SPI_FLASH_SectorErase)。然后就是在调用数据写入函数(SPI_FLASH_BufferWrite) 把数据写入到指定位置内

5.其他配置

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) {
				 /* 扇区数量：2048*4096/1024/1024=8(MB) */
        /* 扇区数量：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;
}

disk_ioctl 函数有三个形参， pdrv 为设备物理编号， cmd 为控制指令，包括发出同步信号、获取扇区数目、获取扇区大小、获取擦除块数量等等指令， buff 为指令对应的数据指针。

对于 SPI Flash 芯片，为支持 FatFs 格式化功能，需要用到获取扇区数量 (GET_SECTOR_COUNT)指令和获取擦除块数量(GET_BLOCK_SIZE)。另外， SD 卡扇区大小为 512 字节， SPI Flash 芯片一般设置扇区大小为 4096 字节，所以需要用到获取扇区大小 (GET_SECTOR_SIZE) 指令。

FatFs移植步骤三

ffconf.h 文件是 FatFs 功能配置文件，我们可以对文件内容进行修改，使得 FatFs 更符合我们的要求。 ffconf.h 对每个配置选项都做了详细的使用情况说明。下面只列出修改的配置，其他配置采用默认即可。

#define _USE_MKFS 1
#define _CODE_PAGE 936
#define _USE_LFN 2
#define _VOLUMES 2
#define _MIN_SS 512
#define _MAX_SS 4096

_USE_MKFS：格式化功能选择，为使用 FatFs 格式化功能，需要把它设置为 1。
_CODE_PAGE：语言功能选择，并要求把相关语言文件添加到工程宏。为支持简体中文文件名需要使用“936”，正如在图 25‑7 的操作，我们已经把 cc936.c 文件添加到工程中。
_USE_LFN：长文件名支持，默认不支持长文件名，这里配置为 2，支持长文件名，并指定使用栈空间为缓冲区。
_VOLUMES：指定物理设备数量，这里设置为 2，包括预留 SD 卡和 SPI Flash 芯片。
_MIN_SS 、 _MAX_SS：指定扇区大小的最小值和最大值。 SD 卡扇区大小一般都为 512 字节， SPI Flash 芯片扇区大小一般设置为 4096 字节，所以需要把 _MAX_SS 改为 4096。

作者：zhoutanooi