第049例：SPI-基于串行Flash的FatFS功能使用

【HAL库每天一例】系列例程从今天开始持续更新。
我们将坚持每天至少发布一个基于YS-F1Pro开发板的HAL库例程，
该系列例程将带领大家从零开始使用HAL库，后面会持续添加模块应用例程。
同样的，我们还程序发布基于HAL库的指导文档和视频教程，欢迎持续关注，并提出改进意见。
例程下载：
资料包括程序、相关说明资料以及软件使用截图
链接：http://pan.baidu.com/s/1i574oPv
密码：r3s3
（硬石YS-F1Pro开发板HAL库例程持续更新\1. 软件设计之基本裸机例程(HAL库版本)\YSF1_HAL-049. SPI-基于串行Flash的FatFS功能使用）
/**
  ******************************************************************************
  *                           硬石YS-F1Pro开发板例程功能说明
  *
  *  例程名称: YSF1_HAL-049. SPI-基于串行Flash的FatFS功能使用
  *   
  ******************************************************************************
  * 说明：
  * 本例程配套硬石stm32开发板YS-F1Pro使用。
  *
  * 淘宝：
  * 论坛：http://www.ing10bbs.com
  * 版权归硬石嵌入式开发团队所有，请勿商用。
  ******************************************************************************
  */
【1】例程简介
  串行Flash用于存储数据。YS-F1Pro开发板集成了一个16M字节的W25Q128串行Flash芯片，可以
用于存放数据。该芯片使用SPI1通信接口
  FatFS是一个专门为嵌入式开发的开源小型文件系统。FatFS可以提供丰富的文件操作函数，方便
文件操作，我们可以在串行Flash空间上移植FatFS文件系统。
  
【2】跳线帽情况
******* 为保证例程正常运行，必须插入以下跳线帽 **********
丝印编号     IO端口      目标功能引脚        出厂默认设置
  JP1        PA10        TXD(CH340G)          已接入
  JP2        PA9         RXD(CH340G)          已接入
  
【3】操作及现象
使用开发板配套的MINI USB线连接到开发板标示“调试串口”字样的MIMI USB接口（需要安装驱
动），在电脑端打开串口调试助手工具，设置参数为115200 8-N-1。下载完程序之后，在串口调试
助手窗口可接收到信息。
/******************* (C) COPYRIGHT 2015-2020 硬石嵌入式开发团队 *****END OF FILE****/
main.c文件内容

1. /**
   
2.   ******************************************************************************
   
3.   * 文件名程: main.c
   
4.   * 作    者: 硬石嵌入式开发团队
   
5.   * 版    本: V1.0
   
6.   * 编写日期: 2015-10-04
   
7.   * 功    能: 基于串行Flash的FatFS文件系统功能测试
   
8.   ******************************************************************************
   
9.   * 说明：
   
10.   * 本例程配套硬石stm32开发板YS-F1Pro使用。
    
11.   *
    
12.   * 淘宝：
    
13.   * 论坛：http://www.ing10bbs.com
    
14.   * 版权归硬石嵌入式开发团队所有，请勿商用。
    
15.   ******************************************************************************
    
16.   */
    
17. /* 包含头文件 ----------------------------------------------------------------*/
    
18. #include "stm32f1xx_hal.h"
    
19. #include "usart/bsp_debug_usart.h"
    
20. #include "ff.h"
    
21. #include "ff_gen_drv.h"
    
22. #include "drivers\spiflash_diskio.h"
    
23. #include "string.h"
    
24. 
    
25. /* 私有类型定义 --------------------------------------------------------------*/
    
26. /* 私有宏定义 ----------------------------------------------------------------*/
    
27. /* 私有变量 ------------------------------------------------------------------*/
    
28. char SPIFLASH_Path[4];            /* 串行Flash逻辑设备路径 */
    
29. FATFS fs;                                                                                                        /* FatFs文件系统对象 */
    
30. FIL file;                                                                                                        /* 文件对象 */
    
31. FRESULT f_res;                    /* 文件操作结果 */
    
32. UINT fnum;                                                      /* 文件成功读写数量 */
    
33. char fpath[100];                  /* 保存当前扫描路径 */
    
34. char readbuffer[512];
    
35. DIR dir;
    
36. 
    
37. /* 扩展变量 ------------------------------------------------------------------*/
    
38. /* 私有函数原形 --------------------------------------------------------------*/
    
39. static void printf_fatfs_error(FRESULT fresult);
    
40. static FRESULT miscellaneous(void);
    
41. static FRESULT file_check(void);
    
42. static FRESULT scan_files (char* path);
    
43. 
    
44. /* 函数体 --------------------------------------------------------------------*/
    
45. /**
    
46.   * 函数功能: 系统时钟配置
    
47.   * 输入参数: 无
    
48.   * 返 回 值: 无
    
49.   * 说    明: 无
    
50.   */
    
51. void SystemClock_Config(void)
    
52. {
    
53.   RCC_OscInitTypeDef RCC_OscInitStruct;
    
54.   RCC_ClkInitTypeDef RCC_ClkInitStruct;
    
55. 
    
56.   RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;  // 外部晶振，8MHz
    
57.   RCC_OscInitStruct.HSEState = RCC_HSE_ON;
    
58.   RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREdiv_div1;
    
59.   RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
    
60.   RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
    
61.   RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL9;  // 9倍频，得到72MHz主时钟
    
62.   HAL_RCC_OscConfig(&RCC_OscInitStruct);
    
63. 
    
64.   RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
    
65.                               |RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
    
66.   RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;       // 系统时钟：72MHz
    
67.   RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_div1;              // AHB时钟：72MHz
    
68.   RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_div2;               // APB1时钟：36MHz
    
69.   RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_div1;               // APB2时钟：72MHz
    
70.   HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2);
    
71. 
    
72.          // HAL_RCC_GetHCLKFreq()/1000    1ms中断一次
    
73.         // HAL_RCC_GetHCLKFreq()/100000         10us中断一次
    
74.         // HAL_RCC_GetHCLKFreq()/1000000 1us中断一次
    
75.   HAL_SYSTICK_Config(HAL_RCC_GetHCLKFreq()/1000);  // 配置并启动系统滴答定时器
    
76.   /* 系统滴答定时器时钟源 */
    
77.   HAL_SYSTICK_CLKSourceConfig(SYSTICK_CLKSOURCE_HCLK);
    
78.   /* 系统滴答定时器中断优先级配置 */
    
79.   HAL_NVIC_SetPriority(SysTick_IRQn, 0, 0);
    
80. }
    
81. 
    
82. /**
    
83.   * 函数功能: 主函数.
    
84.   * 输入参数: 无
    
85.   * 返 回 值: 无
    
86.   * 说    明: 无
    
87.   */
    
88. int main(void)
    
89. {  
    
90.   /* 复位所有外设，初始化Flash接口和系统滴答定时器 */
    
91.   HAL_Init();
    
92.   /* 配置系统时钟 */
    
93.   SystemClock_Config();
    
94. 
    
95.   /* 初始化串口并配置串口中断优先级 */
    
96.   MX_DEBUG_USART_Init();
    
97.   printf("****** 这是一个基于串行Flash的FatFS文件系统功能使用 ******\n");
    
98.   
    
99.   /* 注册一个FatFS设备：串行Flash */
    
100.   if(FATFS_LinkDriver(&SPIFLASH_Driver, SPIFLASH_Path) == 0)
     
101.   {
     
102.     //在串行Flash挂载文件系统，文件系统挂载时会对串行Flash初始化
     
103.     f_res = f_mount(&fs,(TCHAR const*)SPIFLASH_Path,1);
     
104.     printf_fatfs_error(f_res);
     
105.     if(f_res！=FR_OK)
     
106.     {
     
107.       printf("！串行Flash挂载文件系统失败。\n");
     
108.       while(1);
     
109.     }
     
110.     else
     
111.     {
     
112.       printf("》串行Flash文件系统挂载成功，可以进行测试。\n");   
     
113.     }
     
114.    
     
115.     /* FatFs多项功能测试 */
     
116.     f_res = miscellaneous();
     
117.    
     
118.     printf("\n*************** 文件信息获取测试 **************\r\n");
     
119.     f_res = file_check();
     
120. 
     
121.     printf("***************** 文件扫描测试 ****************\r\n");
     
122.     strcpy(fpath,SPIFLASH_Path);
     
123.     scan_files(fpath);
     
124.    
     
125.     /* 不再使用，取消挂载 */
     
126.     f_res = f_mount(NULL,(TCHAR const*)SPIFLASH_Path,1);        
     
127.   }  
     
128.   
     
129.   /* 注销一个FatFS设备：串行Flash */
     
130.   FATFS_UnLinkDriver(SPIFLASH_Path);
     
131.   
     
132.   /* 无限循环 */
     
133.   while (1)
     
134.   {
     
135.   }
     
136. }
     
137. 
     
138. /**
     
139.   * 函数功能: FatFS文件系统操作结果信息处理.
     
140.   * 输入参数: FatFS文件系统操作结果：FRESULT
     
141.   * 返 回 值: 无
     
142.   * 说    明: 无
     
143.   */
     
144. static void printf_fatfs_error(FRESULT fresult)
     
145. {
     
146.   switch(fresult)
     
147.   {
     
148.     case FR_OK:                   //(0)
     
149.       printf("》操作成功。\n");
     
150.     break;
     
151.     case FR_DISK_ERR:             //(1)
     
152.       printf("！硬件输入输出驱动出错。\n");
     
153.     break;
     
154.     case FR_INT_ERR:              //(2)
     
155.       printf("！断言错误。\n");
     
156.     break;
     
157.     case FR_NOT_READY:            //(3)
     
158.       printf("！物理设备无法工作。\n");
     
159.     break;
     
160.     case FR_NO_FILE:              //(4)
     
161.       printf("！无法找到文件。\n");
     
162.     break;
     
163.     case FR_NO_PATH:              //(5)
     
164.       printf("！无法找到路径。\n");
     
165.     break;
     
166.     case FR_INVALID_NAME:         //(6)
     
167.       printf("！无效的路径名。\n");
     
168.     break;
     
169.     case FR_DENIED:               //(7)
     
170.     case FR_EXIST:                //(8)
     
171.       printf("！拒绝访问。\n");
     
172.     break;
     
173.     case FR_INVALID_OBJECT:       //(9)
     
174.       printf("！无效的文件或路径。\n");
     
175.     break;
     
176.     case FR_WRITE_PROTECTED:      //(10)
     
177.       printf("！逻辑设备写保护。\n");
     
178.     break;
     
179.     case FR_INVALID_DRIVE:        //(11)
     
180.       printf("！无效的逻辑设备。\n");
     
181.     break;
     
182.     case FR_NOT_ENABLED:          //(12)
     
183.       printf("！无效的工作区。\n");
     
184.     break;
     
185.     case FR_NO_FILESYSTEM:        //(13)
     
186.       printf("！无效的文件系统。\n");
     
187.     break;
     
188.     case FR_MKFS_ABORTED:         //(14)
     
189.       printf("！因函数参数问题导致f_mkfs函数操作失败。\n");
     
190.     break;
     
191.     case FR_TIMEOUT:              //(15)
     
192.       printf("！操作超时。\n");
     
193.     break;
     
194.     case FR_LOCKED:               //(16)
     
195.       printf("！文件被保护。\n");
     
196.     break;
     
197.     case FR_NOT_ENOUGH_CORE:      //(17)
     
198.       printf("！长文件名支持获取堆空间失败。\n");
     
199.     break;
     
200.     case FR_TOO_MANY_OPEN_FILES:  //(18)
     
201.       printf("！打开太多文件。\n");
     
202.     break;
     
203.     case FR_INVALID_PARAMETER:    // (19)
     
204.       printf("！参数无效。\n");
     
205.     break;
     
206.   }
     
207. }
     
208. 
     
209. /* FatFs多项功能测试 */
     
210. static FRESULT miscellaneous(void)
     
211. {
     
212.   FATFS *pfs;
     
213.   DWORD fre_clust, fre_sect, tot_sect;
     
214.   
     
215.   printf("\n*************** 设备信息获取 ***************\r\n");
     
216.   /* 获取设备信息和空簇大小 */
     
217.   f_res = f_getfree((TCHAR const*)SPIFLASH_Path, &fre_clust, &pfs);
     
218. 
     
219.   /* 计算得到总的扇区个数和空扇区个数 */
     
220.   tot_sect = (pfs->n_fatent - 2) * pfs->csize;
     
221.   fre_sect = fre_clust * pfs->csize;
     
222. 
     
223.   /* 打印信息(4096 字节/扇区) */
     
224.   printf("》设备总空间：%10lu KB。\n》可用空间：  %10lu KB。\n", tot_sect *4, fre_sect *4);
     
225.   
     
226.   printf("\n******** 文件定位和格式化写入功能测试 ********\r\n");
     
227.   f_res = f_open(&file, "FatFs读写测试文件.txt",
     
228.                             FA_OPEN_EXISTING|FA_WRITE|FA_READ );
     
229.         if ( f_res == FR_OK )
     
230.         {
     
231.     /*  文件定位 */
     
232.     f_res = f_lseek(&file,f_size(&file)-1);
     
233.     if (f_res == FR_OK)
     
234.     {
     
235.       /* 格式化写入，参数格式类似printf函数 */
     
236.       f_printf(&file,"\n在原来文件新添加一行内容\n");
     
237.       f_printf(&file,"》设备总空间：%10lu KB。\n》可用空间：  %10lu KB。\n", tot_sect *4, fre_sect *4);
     
238.       /*  文件定位到文件起始位置 */
     
239.       f_res = f_lseek(&file,0);
     
240.       /* 读取文件所有内容到缓存区 */
     
241.       f_res = f_read(&file,readbuffer,f_size(&file),&fnum);
     
242.       if(f_res == FR_OK)
     
243.       {
     
244.         printf("》文件内容：\n%s\n",readbuffer);
     
245.       }
     
246.     }
     
247.     f_close(&file);   
     
248.    
     
249.     printf("\n********** 目录创建和重命名功能测试 **********\r\n");
     
250.     /* 尝试打开目录 */
     
251.     f_res=f_opendir(&dir,"TestDir");
     
252.     if(f_res！=FR_OK)
     
253.     {
     
254.       /* 打开目录失败，就创建目录 */
     
255.       f_res=f_mkdir("TestDir");
     
256.     }
     
257.     else
     
258.     {
     
259.       /* 如果目录已经存在，关闭它 */
     
260.       f_res=f_closedir(&dir);
     
261.       /* 删除文件 */
     
262.       f_unlink("TestDir/testdir.txt");
     
263.     }
     
264.     if(f_res==FR_OK)
     
265.     {
     
266.       /* 重命名并移动文件 */
     
267.       f_res=f_rename("FatFs读写测试文件.txt","TestDir/testdir.txt");      
     
268.     }
     
269.         }
     
270.   else
     
271.   {
     
272.     printf("！ 打开文件失败：%d\n",f_res);
     
273.     printf("！ 或许需要再次运行“FatFs移植与读写测试”工程\n");
     
274.   }
     
275.   return f_res;
     
276. }
     
277. 
     
278. 
     
279. /**
     
280.   * 文件信息获取
     
281.   */
     
282. static FRESULT file_check(void)
     
283. {  
     
284.   static FILINFO finfo;
     
285.   /* 获取文件信息 */
     
286.   f_res=f_stat("TestDir/testdir.txt",&finfo);
     
287.   if(f_res==FR_OK)
     
288.   {
     
289.     printf("“testdir.txt”文件信息：\n");
     
290.     printf("》文件大小: %ld(字节)\n", finfo.fsize);
     
291.     printf("》时间戳: %u/%02u/%02u, %02u:%02u\n",
     
292.            (finfo.fdate >> 9) + 1980, finfo.fdate >> 5 & 15, finfo.fdate & 31,finfo.ftime >> 11, finfo.ftime >> 5 & 63);
     
293.     printf("》属性: %c%c%c%c%c\n\n",
     
294.            (finfo.fattrib & AM_DIR) ? 'D' : '-',      // 是一个目录
     
295.            (finfo.fattrib & AM_RDO) ? 'R' : '-',      // 只读文件
     
296.            (finfo.fattrib & AM_HID) ? 'H' : '-',      // 隐藏文件
     
297.            (finfo.fattrib & AM_SYS) ? 'S' : '-',      // 系统文件
     
298.            (finfo.fattrib & AM_ARC) ? 'A' : '-');     // 档案文件
     
299.   }
     
300.   return f_res;
     
301. }
     
302. 
     
303. /**
     
304.   * @brief  scan_files 递归扫描FatFs内的文件
     
305.   * @param  path:初始扫描路径
     
306.   * @retval result:文件系统的返回值
     
307.   */
     
308. static FRESULT scan_files (char* path)
     
309. {
     
310.   FRESULT res;                 //部分在递归过程被修改的变量，不用全局变量        
     
311.   FILINFO fno;  
     
312.   int i;            
     
313.   char *fn;        // 文件名        
     
314.         
     
315. #if _USE_LFN
     
316.   /* 长文件名支持 */
     
317.   /* 简体中文需要2个字节保存一个“字”*/
     
318.   static char lfn[_MAX_LFN*2 + 1];         
     
319.   fno.lfname = lfn;
     
320.   fno.lfsize = sizeof(lfn);
     
321. #endif
     
322.   //打开目录
     
323.   res = f_opendir(&dir, path);
     
324.   if (res == FR_OK)
     
325.         {
     
326.     i = strlen(path);
     
327.     for (;;)
     
328.                 {
     
329.       //读取目录下的内容，再读会自动读下一个文件
     
330.       res = f_readdir(&dir, &fno);                                                                 
     
331.       //为空时表示所有项目读取完毕，跳出
     
332.       if (res ！= FR_OK || fno.fname[0] == 0) break;         
     
333. #if _USE_LFN
     
334.       fn = *fno.lfname ? fno.lfname : fno.fname;
     
335. #else
     
336.       fn = fno.fname;
     
337. #endif
     
338.       //点表示当前目录，跳过                        
     
339.       if (*fn == '.') continue;         
     
340.       //目录，递归读取      
     
341.       if (fno.fattrib & AM_DIR)         
     
342.                         {                        
     
343.         //合成完整目录名        
     
344.         sprintf(&path[i], "/%s", fn);                 
     
345.         //递归遍历         
     
346.         res = scan_files(path);        
     
347.         path[i] = 0;         
     
348.         //打开失败，跳出循环        
     
349.         if (res ！= FR_OK)
     
350.                                         break;
     
351.       }
     
352.                         else
     
353.                         {
     
354.                                 printf("%s/%s\n", path, fn);                                                                //输出文件名        
     
355.         /* 可以在这里提取特定格式的文件路径 */        
     
356.       }//else
     
357.     } //for
     
358.   }
     
359.   return res;
     
360. }
     
361. 
     
362. /******************* (C) COPYRIGHT 2015-2020 硬石嵌入式开发团队 *****END OF FILE****/
     

复制代码