第045例：SDIO-FatFS文件系统功能使用

【HAL库每天一例】系列例程从今天开始持续更新。
我们将坚持每天至少发布一个基于YS-F1Pro开发板的HAL库例程，
该系列例程将带领大家从零开始使用HAL库，后面会持续添加模块应用例程。
同样的，我们还程序发布基于HAL库的指导文档和视频教程，欢迎持续关注，并提出改进意见。
例程下载：
资料包括程序、相关说明资料以及软件使用截图
链接：http://pan.baidu.com/s/1i574oPv
密码：r3s3
（硬石YS-F1Pro开发板HAL库例程持续更新\1. 软件设计之基本裸机例程(HAL库版本)\YSF1_HAL-045. SDIO-FatFS文件系统功能使用）
/**
  ******************************************************************************
  *                           硬石YS-F1Pro开发板例程功能说明
  *
  *  例程名称: YSF1_HAL-045. SDIO-FatFS文件系统功能使用
  *   
  ******************************************************************************
  * 说明：
  * 本例程配套硬石stm32开发板YS-F1Pro使用。
  *
  * 淘宝：
  * 论坛：http://www.ing10bbs.com
  * 版权归硬石嵌入式开发团队所有，请勿商用。
  ******************************************************************************
  */
【1】例程简介
  SDIO是安全输入输出接口，采用在SD卡上。SD卡做为一种性价比极高的存储介质，在生活中非常
普遍可见。
  上个例程是直接对SD卡进行读写操作，一般使用SD卡都需要通过文件系统，使得类似电脑操作文件
一样简单明了。
  FatFS是一个专门为嵌入式开发的开源小型文件系统。提供了非常丰富的文件操作函数，本例程使用
其中部分函数实现文件操作。
  
【2】跳线帽情况
******* 为保证例程正常运行，必须插入以下跳线帽 **********
丝印编号     IO端口      目标功能引脚        出厂默认设置
  JP1        PA10        TXD(CH340G)          已接入
  JP2        PA9         RXD(CH340G)          已接入
  
【3】操作及现象
  将一张小于32G大小的Micro SD卡插入到开发板上的SD卡槽内，使用开发板配套的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.   * 功    能: 基于SD卡的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 "sdio/bsp_sdcard.h"
    
21. #include "ff.h"
    
22. #include "ff_gen_drv.h"
    
23. #include "drivers\sd_diskio.h"
    
24. #include "string.h"
    
25. 
    
26. /* 私有类型定义 --------------------------------------------------------------*/
    
27. /* 私有宏定义 ----------------------------------------------------------------*/
    
28. /* 私有变量 ------------------------------------------------------------------*/
    
29. char SDPath[4];                   /* SD卡逻辑设备路径 */
    
30. FATFS fs;                                                                                                        /* FatFs文件系统对象 */
    
31. FIL file;                                                                                                        /* 文件对象 */
    
32. FRESULT f_res;                    /* 文件操作结果 */
    
33. UINT fnum;                                                      /* 文件成功读写数量 */
    
34. char fpath[100];                  /* 保存当前扫描路径 */
    
35. char readbuffer[512];
    
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("****** 这是一个基于SD卡的FatFS文件系统功能使用 ******\n");
    
98.   
    
99.   /* 注册一个FatFS设备：SD卡 */
    
100.   if(FATFS_LinkDriver(&SD_Driver, SDPath) == 0)
     
101.   {
     
102.     //在SD卡挂载文件系统，文件系统挂载时会对SD卡初始化
     
103.     f_res = f_mount(&fs,(TCHAR const*)SDPath,1);
     
104.     printf_fatfs_error(f_res);
     
105.     if(f_res！=FR_OK)
     
106.     {
     
107.       printf("！SD卡挂载文件系统失败。\n");
     
108.       while(1);
     
109.     }
     
110.     else
     
111.     {
     
112.       printf("》SD卡文件系统挂载成功，可以进行测试。\n");   
     
113.     }
     
114.    
     
115.     /* FatFs多项功能测试 */
     
116.     f_res = miscellaneous();
     
117.    
     
118.     printf("\n*************** 文件信息获取测试 **************\r\n");
     
119.     f_res = file_check();
     
120. 
     
121.    
     
122.     printf("***************** 文件扫描测试 ****************\r\n");
     
123.     strcpy(fpath,SDPath);
     
124.     scan_files(fpath);
     
125.    
     
126.     /* 不再使用，取消挂载 */
     
127.     f_res = f_mount(NULL,(TCHAR const*)SDPath,1);       
     
128.   }  
     
129.   
     
130.   /* 注销一个FatFS设备：SD卡 */
     
131.   FATFS_UnLinkDriver(SDPath);
     
132.   
     
133.   /* 无限循环 */
     
134.   while (1)
     
135.   {
     
136.   }
     
137. }
     
138. 
     
139. /**
     
140.   * 函数功能: FatFS文件系统操作结果信息处理.
     
141.   * 输入参数: FatFS文件系统操作结果：FRESULT
     
142.   * 返 回 值: 无
     
143.   * 说    明: 无
     
144.   */
     
145. static void printf_fatfs_error(FRESULT fresult)
     
146. {
     
147.   switch(fresult)
     
148.   {
     
149.     case FR_OK:                   //(0)
     
150.       printf("》操作成功。\n");
     
151.     break;
     
152.     case FR_DISK_ERR:             //(1)
     
153.       printf("！硬件输入输出驱动出错。\n");
     
154.     break;
     
155.     case FR_INT_ERR:              //(2)
     
156.       printf("！断言错误。\n");
     
157.     break;
     
158.     case FR_NOT_READY:            //(3)
     
159.       printf("！物理设备无法工作。\n");
     
160.     break;
     
161.     case FR_NO_FILE:              //(4)
     
162.       printf("！无法找到文件。\n");
     
163.     break;
     
164.     case FR_NO_PATH:              //(5)
     
165.       printf("！无法找到路径。\n");
     
166.     break;
     
167.     case FR_INVALID_NAME:         //(6)
     
168.       printf("！无效的路径名。\n");
     
169.     break;
     
170.     case FR_DENIED:               //(7)
     
171.     case FR_EXIST:                //(8)
     
172.       printf("！拒绝访问。\n");
     
173.     break;
     
174.     case FR_INVALID_OBJECT:       //(9)
     
175.       printf("！无效的文件或路径。\n");
     
176.     break;
     
177.     case FR_WRITE_PROTECTED:      //(10)
     
178.       printf("！逻辑设备写保护。\n");
     
179.     break;
     
180.     case FR_INVALID_DRIVE:        //(11)
     
181.       printf("！无效的逻辑设备。\n");
     
182.     break;
     
183.     case FR_NOT_ENABLED:          //(12)
     
184.       printf("！无效的工作区。\n");
     
185.     break;
     
186.     case FR_NO_FILESYSTEM:        //(13)
     
187.       printf("！无效的文件系统。\n");
     
188.     break;
     
189.     case FR_MKFS_ABORTED:         //(14)
     
190.       printf("！因函数参数问题导致f_mkfs函数操作失败。\n");
     
191.     break;
     
192.     case FR_TIMEOUT:              //(15)
     
193.       printf("！操作超时。\n");
     
194.     break;
     
195.     case FR_LOCKED:               //(16)
     
196.       printf("！文件被保护。\n");
     
197.     break;
     
198.     case FR_NOT_ENOUGH_CORE:      //(17)
     
199.       printf("！长文件名支持获取堆空间失败。\n");
     
200.     break;
     
201.     case FR_TOO_MANY_OPEN_FILES:  //(18)
     
202.       printf("！打开太多文件。\n");
     
203.     break;
     
204.     case FR_INVALID_PARAMETER:    // (19)
     
205.       printf("！参数无效。\n");
     
206.     break;
     
207.   }
     
208. }
     
209. 
     
210. /* FatFs多项功能测试 */
     
211. static FRESULT miscellaneous(void)
     
212. {
     
213.   DIR dir;
     
214.   FATFS *pfs;
     
215.   DWORD fre_clust, fre_sect, tot_sect;
     
216.   
     
217.   printf("\n*************** 设备信息获取 ***************\r\n");
     
218.   /* 获取设备信息和空簇大小 */
     
219.   f_res = f_getfree((TCHAR const*)SDPath, &fre_clust, &pfs);
     
220. 
     
221.   /* 计算得到总的扇区个数和空扇区个数 */
     
222.   tot_sect = (pfs->n_fatent - 2) * pfs->csize;
     
223.   fre_sect = fre_clust * pfs->csize;
     
224. 
     
225.   /* 打印信息(4096 字节/扇区) */
     
226.   printf("》设备总空间：%10lu KB。\n》可用空间：  %10lu KB。\n", tot_sect *4, fre_sect *4);
     
227.   
     
228.   printf("\n******** 文件定位和格式化写入功能测试 ********\r\n");
     
229.   f_res = f_open(&file, "FatFs读写测试文件.txt",
     
230.                             FA_OPEN_EXISTING|FA_WRITE|FA_READ );
     
231.         if ( f_res == FR_OK )
     
232.         {
     
233.     /*  文件定位 */
     
234.     f_res = f_lseek(&file,f_size(&file)-1);
     
235.     if (f_res == FR_OK)
     
236.     {
     
237.       /* 格式化写入，参数格式类似printf函数 */
     
238.       f_printf(&file,"\n在原来文件新添加一行内容\n");
     
239.       f_printf(&file,"》设备总空间：%10lu KB。\n》可用空间：  %10lu KB。\n", tot_sect *4, fre_sect *4);
     
240.       /*  文件定位到文件起始位置 */
     
241.       f_res = f_lseek(&file,0);
     
242.       /* 读取文件所有内容到缓存区 */
     
243.       f_res = f_read(&file,readbuffer,f_size(&file),&fnum);
     
244.       if(f_res == FR_OK)
     
245.       {
     
246.         printf("》文件内容：\n%s\n",readbuffer);
     
247.       }
     
248.     }
     
249.     f_close(&file);   
     
250.    
     
251.     printf("\n********** 目录创建和重命名功能测试 **********\r\n");
     
252.     /* 尝试打开目录 */
     
253.     f_res=f_opendir(&dir,"TestDir");
     
254.     if(f_res！=FR_OK)
     
255.     {
     
256.       /* 打开目录失败，就创建目录 */
     
257.       f_res=f_mkdir("TestDir");
     
258.     }
     
259.     else
     
260.     {
     
261.       /* 如果目录已经存在，关闭它 */
     
262.       f_res=f_closedir(&dir);
     
263.       /* 删除文件 */
     
264.       f_unlink("TestDir/testdir.txt");
     
265.     }
     
266.     if(f_res==FR_OK)
     
267.     {
     
268.       /* 重命名并移动文件 */
     
269.       f_res=f_rename("FatFs读写测试文件.txt","TestDir/testdir.txt");      
     
270.     }
     
271.         }
     
272.   else
     
273.   {
     
274.     printf("！ 打开文件失败：%d\n",f_res);
     
275.     printf("！ 或许需要再次运行“FatFs移植与读写测试”工程\n");
     
276.   }
     
277.   return f_res;
     
278. }
     
279. 
     
280. 
     
281. /**
     
282.   * 文件信息获取
     
283.   */
     
284. static FRESULT file_check(void)
     
285. {  
     
286.   static FILINFO finfo;
     
287.   /* 获取文件信息 */
     
288.   f_res=f_stat("0:TestDir/testdir.txt",&finfo);
     
289.   if(f_res==FR_OK)
     
290.   {
     
291.     printf("“testdir.txt”文件信息：\n");
     
292.     printf("》文件大小: %ld(字节)\n", finfo.fsize);
     
293.     printf("》时间戳: %u/%02u/%02u, %02u:%02u\n",
     
294.            (finfo.fdate >> 9) + 1980, finfo.fdate >> 5 & 15, finfo.fdate & 31,finfo.ftime >> 11, finfo.ftime >> 5 & 63);
     
295.     printf("》属性: %c%c%c%c%c\n\n",
     
296.            (finfo.fattrib & AM_DIR) ? 'D' : '-',      // 是一个目录
     
297.            (finfo.fattrib & AM_RDO) ? 'R' : '-',      // 只读文件
     
298.            (finfo.fattrib & AM_HID) ? 'H' : '-',      // 隐藏文件
     
299.            (finfo.fattrib & AM_SYS) ? 'S' : '-',      // 系统文件
     
300.            (finfo.fattrib & AM_ARC) ? 'A' : '-');     // 档案文件
     
301.   }
     
302.   return f_res;
     
303. }
     
304. 
     
305. /**
     
306.   * @brief  scan_files 递归扫描FatFs内的文件
     
307.   * @param  path:初始扫描路径
     
308.   * @retval result:文件系统的返回值
     
309.   */
     
310. static FRESULT scan_files (char* path)
     
311. {
     
312.   FRESULT res;                 //部分在递归过程被修改的变量，不用全局变量       
     
313.   FILINFO fno;
     
314.   DIR dir;
     
315.   int i;            
     
316.   char *fn;        // 文件名       
     
317.        
     
318. #if _USE_LFN
     
319.   /* 长文件名支持 */
     
320.   /* 简体中文需要2个字节保存一个“字”*/
     
321.   static char lfn[_MAX_LFN*2 + 1];        
     
322.   fno.lfname = lfn;
     
323.   fno.lfsize = sizeof(lfn);
     
324. #endif
     
325.   //打开目录
     
326.   res = f_opendir(&dir, path);
     
327.   if (res == FR_OK)
     
328.         {
     
329.     i = strlen(path);
     
330.     for (;;)
     
331.                 {
     
332.       //读取目录下的内容，再读会自动读下一个文件
     
333.       res = f_readdir(&dir, &fno);                                                                
     
334.       //为空时表示所有项目读取完毕，跳出
     
335.       if (res ！= FR_OK || fno.fname[0] == 0) break;        
     
336. #if _USE_LFN
     
337.       fn = *fno.lfname ? fno.lfname : fno.fname;
     
338. #else
     
339.       fn = fno.fname;
     
340. #endif
     
341.       //点表示当前目录，跳过                       
     
342.       if (*fn == '.') continue;        
     
343.       //目录，递归读取      
     
344.       if (fno.fattrib & AM_DIR)         
     
345.                         {                        
     
346.         //合成完整目录名        
     
347.         sprintf(&path[i], "/%s", fn);                
     
348.         //递归遍历         
     
349.         res = scan_files(path);       
     
350.         path[i] = 0;         
     
351.         //打开失败，跳出循环        
     
352.         if (res ！= FR_OK)
     
353.                                         break;
     
354.       }
     
355.                         else
     
356.                         {
     
357.                                 printf("%s/%s\n", path, fn);                                                                //输出文件名       
     
358.         /* 可以在这里提取特定格式的文件路径 */        
     
359.       }//else
     
360.     } //for
     
361.   }
     
362.   return res;
     
363. }
     
364. 
     
365. /******************* (C) COPYRIGHT 2015-2020 硬石嵌入式开发团队 *****END OF FILE****/
     

复制代码