第046例：SPI-串行Flash

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

bsp_flash.h文件内容

1. #ifndef __BSP_SPIFLASH_H__
   
2. #define __BSP_SPIFLASH_H__
   
3. 
   
4. /* 包含头文件 ----------------------------------------------------------------*/
   
5. #include "stm32f1xx_hal.h"
   
6. 
   
7. /* 类型定义 ------------------------------------------------------------------*/
   
8. /* 宏定义 --------------------------------------------------------------------*/
   
9. //#define  SPI_FLASH_ID                       0xEF3015     //W25X16   2MB
   
10. //#define  SPI_FLASH_ID                       0xEF4015           //W25Q16   4MB
    
11. //#define  SPI_FLASH_ID                       0XEF4017     //W25Q64   8MB
    
12. #define  SPI_FLASH_ID                       0XEF4018     //W25Q128  16MB YS-F1Pro开发默认使用
    
13. 
    
14. #define FLASH_SPIx                                 SPI1
    
15. #define FLASH_SPIx_RCC_CLK_ENABLE()                __HAL_RCC_SPI1_CLK_ENABLE()
    
16. #define FLASH_SPIx_RCC_CLK_DISABLE()               __HAL_RCC_SPI1_CLK_DISABLE()
    
17. 
    
18. #define FLASH_SPI_GPIO_ClK_ENABLE()                __HAL_RCC_GPIOA_CLK_ENABLE()
    
19. #define FLASH_SPI_GPIO_PORT                        GPIOA
    
20. #define FLASH_SPI_SCK_PIN                          GPIO_PIN_5
    
21. #define FLASH_SPI_MISO_PIN                         GPIO_PIN_6
    
22. #define FLASH_SPI_MOSI_PIN                         GPIO_PIN_7
    
23. 
    
24. #define FLASH_SPI_CS_CLK_ENABLE()                  __HAL_RCC_GPIOA_CLK_ENABLE()   
    
25. #define FLASH_SPI_CS_PORT                          GPIOA
    
26. #define FLASH_SPI_CS_PIN                           GPIO_PIN_4
    
27. 
    
28. #define FLASH_SPI_CS_ENABLE()                      HAL_GPIO_WritePin(FLASH_SPI_CS_PORT, FLASH_SPI_CS_PIN, GPIO_PIN_RESET)
    
29. #define FLASH_SPI_CS_DISABLE()                     HAL_GPIO_WritePin(FLASH_SPI_CS_PORT, FLASH_SPI_CS_PIN, GPIO_PIN_SET)
    
30. 
    
31. /* 扩展变量 ------------------------------------------------------------------*/
    
32. extern SPI_HandleTypeDef hspiflash;
    
33. 
    
34. /* 函数声明 ------------------------------------------------------------------*/
    
35. 
    
36. void MX_SPIFlash_Init(void);
    
37. void SPI_FLASH_SectorErase(uint32_t SectorAddr);
    
38. void SPI_FLASH_BulkErase(void);
    
39. void SPI_FLASH_PageWrite(uint8_t* pBuffer, uint32_t WriteAddr, uint16_t NumByteToWrite);
    
40. void SPI_FLASH_BufferWrite(uint8_t* pBuffer, uint32_t WriteAddr, uint16_t NumByteToWrite);
    
41. void SPI_FLASH_BufferRead(uint8_t* pBuffer, uint32_t ReadAddr, uint16_t NumByteToRead);
    
42. uint32_t SPI_FLASH_ReadID(void);
    
43. uint32_t SPI_FLASH_ReadDeviceID(void);
    
44. void SPI_FLASH_StartReadSequence(uint32_t ReadAddr);
    
45. void SPI_Flash_PowerDown(void);
    
46. void SPI_Flash_WAKEUP(void);
    
47. 
    
48. uint8_t SPI_FLASH_ReadByte(void);
    
49. uint8_t SPI_FLASH_SendByte(uint8_t byte);
    
50. void SPI_FLASH_WriteEnable(void);
    
51. void SPI_FLASH_WaitForWriteEnd(void);
    
52. 
    
53. #endif  /* __BSP_SPIFLASH_H__ */
    
54. 
    
55. /******************* (C) COPYRIGHT 2015-2020 硬石嵌入式开发团队 *****END OF FILE****/
    

复制代码

main.c文件内容

1. /**
   
2.   ******************************************************************************
   
3.   * 文件名程: main.c
   
4.   * 作    者: 硬石嵌入式开发团队
   
5.   * 版    本: V1.0
   
6.   * 编写日期: 2015-10-04
   
7.   * 功    能: 串行Flash驱动实现、读写测试
   
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 "spiflash/bsp_spiflash.h"
    
21. #include "led/bsp_led.h"
    
22. 
    
23. /* 私有类型定义 --------------------------------------------------------------*/
    
24. typedef enum {FAILED = 0, PASSED = ！FAILED} TestStatus;
    
25. 
    
26. /* 私有宏定义 ----------------------------------------------------------------*/
    
27. /* 获取缓冲区的长度 */
    
28. #define countof(a)      (sizeof(a) / sizeof(*(a)))
    
29. #define TxBufferSize1   (countof(TxBuffer1) - 1)
    
30. #define RxBufferSize1   (countof(TxBuffer1) - 1)
    
31. #define BufferSize      (countof(Tx_Buffer)-1)
    
32. 
    
33. #define  FLASH_WriteAddress     0x00000
    
34. #define  FLASH_ReadAddress      FLASH_WriteAddress
    
35. #define  FLASH_SectorToErase    FLASH_WriteAddress
    
36. 
    
37. /* 私有变量 ------------------------------------------------------------------*/
    
38. uint8_t Tx_Buffer[] = " 感谢您选用硬石stm32开发板\n今天是个好日子";
    
39. uint8_t Rx_Buffer[BufferSize];
    
40. 
    
41. __IO uint32_t DeviceID = 0;
    
42. __IO uint32_t FlashID = 0;
    
43. __IO TestStatus TransferStatus1 = FAILED;
    
44. 
    
45. /* 扩展变量 ------------------------------------------------------------------*/
    
46. /* 私有函数原形 --------------------------------------------------------------*/
    
47. static TestStatus Buffercmp(uint8_t* pBuffer1, uint8_t* pBuffer2, uint16_t BufferLength);
    
48. 
    
49. /* 函数体 --------------------------------------------------------------------*/
    
50. /**
    
51.   * 函数功能: 系统时钟配置
    
52.   * 输入参数: 无
    
53.   * 返 回 值: 无
    
54.   * 说    明: 无
    
55.   */
    
56. void SystemClock_Config(void)
    
57. {
    
58.   RCC_OscInitTypeDef RCC_OscInitStruct;
    
59.   RCC_ClkInitTypeDef RCC_ClkInitStruct;
    
60. 
    
61.   RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;  // 外部晶振，8MHz
    
62.   RCC_OscInitStruct.HSEState = RCC_HSE_ON;
    
63.   RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREdiv_div1;
    
64.   RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
    
65.   RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
    
66.   RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL9;  // 9倍频，得到72MHz主时钟
    
67.   HAL_RCC_OscConfig(&RCC_OscInitStruct);
    
68. 
    
69.   RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
    
70.                               |RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
    
71.   RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;       // 系统时钟：72MHz
    
72.   RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_div1;              // AHB时钟：72MHz
    
73.   RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_div2;               // APB1时钟：36MHz
    
74.   RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_div1;               // APB2时钟：72MHz
    
75.   HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2);
    
76. 
    
77.          // HAL_RCC_GetHCLKFreq()/1000    1ms中断一次
    
78.         // HAL_RCC_GetHCLKFreq()/100000         10us中断一次
    
79.         // HAL_RCC_GetHCLKFreq()/1000000 1us中断一次
    
80.   HAL_SYSTICK_Config(HAL_RCC_GetHCLKFreq()/1000);  // 配置并启动系统滴答定时器
    
81.   /* 系统滴答定时器时钟源 */
    
82.   HAL_SYSTICK_CLKSourceConfig(SYSTICK_CLKSOURCE_HCLK);
    
83.   /* 系统滴答定时器中断优先级配置 */
    
84.   HAL_NVIC_SetPriority(SysTick_IRQn, 0, 0);
    
85. }
    
86. 
    
87. /**
    
88.   * 函数功能: 主函数.
    
89.   * 输入参数: 无
    
90.   * 返 回 值: 无
    
91.   * 说    明: 无
    
92.   */
    
93. int main(void)
    
94. {  
    
95.   /* 复位所有外设，初始化Flash接口和系统滴答定时器 */
    
96.   HAL_Init();
    
97.   /* 配置系统时钟 */
    
98.   SystemClock_Config();
    
99. 
    
100.   /* LED灯初始化 */
     
101.   LED_GPIO_Init();
     
102.   
     
103.   /* 初始化串口并配置串口中断优先级 */
     
104.   MX_DEBUG_USART_Init();
     
105.   /* 调用格式化输出函数打印输出数据 */
     
106.   printf("这是一个16M byte串行flash(W25Q128)读写测试实验\n");
     
107.   
     
108.   MX_SPIFlash_Init();
     
109.   
     
110.   /* Get SPI Flash Device ID */
     
111.         DeviceID = SPI_FLASH_ReadDeviceID();
     
112.   
     
113.   HAL_Delay(100);
     
114.   
     
115.   /* Get SPI Flash ID */
     
116.         FlashID = SPI_FLASH_ReadID();
     
117.   
     
118.   printf("FlashID is 0x%X,  Manufacturer Device ID is 0x%X\n", FlashID, DeviceID);
     
119.         
     
120.         /* Check the SPI Flash ID */
     
121.         if (FlashID == SPI_FLASH_ID)  /* #define  sFLASH_ID  0XEF4018 */
     
122.         {        
     
123.                 printf("检测到华邦串行flash W25Q128 ！\n");
     
124.                
     
125.                 /* 擦除SPI的扇区以写入 */
     
126.                 SPI_FLASH_SectorErase(FLASH_SectorToErase);                  
     
127.                
     
128.                 /* 将发送缓冲区的数据写到flash中 */         
     
129.                 SPI_FLASH_BufferWrite(Tx_Buffer, FLASH_WriteAddress, BufferSize);
     
130.                 SPI_FLASH_BufferWrite(Tx_Buffer, 252, BufferSize);
     
131.                 printf("写入的数据为：\n%s \n", Tx_Buffer);
     
132.                
     
133.                 /* 将刚刚写入的数据读出来放到接收缓冲区中 */
     
134.                 SPI_FLASH_BufferRead(Rx_Buffer, FLASH_ReadAddress, BufferSize);
     
135.                 printf("读出的数据为：\n %s\n", Rx_Buffer);
     
136.                
     
137.                 /* 检查写入的数据与读出的数据是否相等 */
     
138.                 TransferStatus1 = Buffercmp(Tx_Buffer, Rx_Buffer, BufferSize);
     
139.                
     
140.                 if( PASSED == TransferStatus1 )
     
141.                 {   
     
142.                         printf("16M串行flash(W25Q128)测试成功！\r");
     
143.                         LED1_ON;
     
144.                 }
     
145.                 else
     
146.                 {        
     
147.                         printf("16M串行flash(W25Q128)测试失败！\r");
     
148.                         LED2_ON;
     
149.                 }
     
150.         }
     
151.         else
     
152.         {   
     
153.                 printf("获取不到 W25Q128 ID！\n");
     
154.                 LED3_ON;
     
155.         }
     
156.   
     
157.   /* 无限循环 */
     
158.   while (1)
     
159.   {
     
160.   }
     
161. }
     
162. 
     
163. /**
     
164.   * 函数功能: 比较两个缓冲区中的数据是否相等
     
165.   * 输入参数: pBuffer1：要比较的缓冲区1的指针
     
166.   *           pBuffer2：要比较的缓冲区2的指针
     
167.   *           BufferLength：缓冲区长度
     
168.   * 返 回 值: PASSED：相等
     
169.   *           FAILED：不等
     
170.   * 说    明: 无
     
171.   */
     
172. static TestStatus Buffercmp(uint8_t* pBuffer1, uint8_t* pBuffer2, uint16_t BufferLength)
     
173. {
     
174.   while(BufferLength--)
     
175.   {
     
176.     if(*pBuffer1 ！= *pBuffer2)
     
177.     {
     
178.       return FAILED;
     
179.     }
     
180. 
     
181.     pBuffer1++;
     
182.     pBuffer2++;
     
183.   }
     
184.   return PASSED;
     
185. }
     
186. 
     
187. /******************* (C) COPYRIGHT 2015-2020 硬石嵌入式开发团队 *****END OF FILE****/
     

复制代码