《STM32H7R7开发指南 V1.1 》第四十九章 FLASH模拟EEPROM实验

正点原子运营

第四十九章 FLASH模拟EEPROM实验

1）实验平台：正点原子STM32H7R7开发板

2）章节摘自【正点原子】STM32H7R7开发指南 V1.1

3）购买链接： https://detail.tmall.com/item.htm?id=820823382459

4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/stm32/zdyz_stm32h7rx.html

5）正点原子官方B站：https://space.bilibili.com/394620890

6）正点原子STM32开发板技术交流群：756580169





STM32H7R7本身没有自带EEPROM，但是STM32H7R7具有IAP（在应用编程）功能，所以我们可以把它的FLASH当成EEPROM来使用。本章，我们将利用STM32H7R7内部的FLASH来实现第四十章实验类似的效果，不过这次我们是将数据直接存放在STM32H7R7内部，而不是存放在NOR FLASH。
本章分为如下几个小节：
49.1 STM32H7R7 FLASH简介
49.2 硬件设计
49.3 程序设计
49.4 下载验证

49.1 STM32H7R7 FLASH简介
STM32H7R7内部只有64KB FLASH，STM32H7R7的闪存模块组织如表49.1.1所示：

表49.1.1 STM32H7R7闪存模块组织

STM32H7R7只有一个块Bank，每个扇区容量为8KB，并具128位FLASH字，每个字有9个ECC（误码校正）位。
关于STM32H7R7内部FLASH的详细说明，详见《STM32H7Rx参考手册_V6（英文版）》第5.3节相关内容。
在执行闪存写操作时，任何对闪存的读操作都会锁住总线，在写操作完成后读操作才能正确地进行。既在进行写或擦除操作时，不能进行代码或数据的读取操作。

49.1.1 闪存的读取
为了准确读取 Flash 数据，必须根据 HCLK 时钟 (flash_aclk) 频率和Vcore电压范围在 Flash 存取控制寄存器 (FLASH_ACR) 中正确地设置等待周期数 (LATENCY)。Flash 等待周期与HCLK时钟频率之间的对应关系，如表49.1.1.2所示：

表49.1.1.2 HCLK时钟频率对应的FLASH等待周期表

等待周期通过FLASH_ACR寄存器的LATENCY[3:0]四个位设置。系统复位后，CPU时钟频率为内部64M RC振荡器，LATENCY默认是1，即2个等待周期。为了得到更佳的FLASH访问性能，我们设置Vcore电压范围为VOS0级别（1.30V~1.40V）。rcc_aclk和rcc_hclk的频率是一样的，都是来自RCC_BMCFGR的BMPRE[3:0]分频，rcc_hclk我们一般设置的是300MHz，这样rcc_aclk也是300MHz的频率。我们设置等待周期为8（LATENCY[3:0]=7），否则FLASH读写可能出错，导致死机。
STM32H7R7的FLASH读取是很简单的。例如，我们要从地址addr，读取一个字（一个字为32位），可以通过如下的语句读取：

Data = *(volatile uint32_t *)faddr;

将faddr强制转换为volatile uint32_t指针，然后取该指针所指向的地址的值，即得到了faddr地址的值。类似的，将上面的volatile uint32_t改为volatile uint8_t，即可读取指定地址的一个字节。相对FLASH读取来说，STM32H7R7 FLASH的写就复杂一点了，下面我们介绍STM32H7R7闪存的编程和擦除。

49.1.2 闪存的编程和擦除
在对 STM32H7R7的Flash执行写入或擦除操作期间，任何读取Flash的尝试都会导致总线阻塞。只有在完成编程操作后，才能正确处理读操作。这意味着，写/擦除操作进行期间不能从Flash中执行代码或数据获取操作。
STM32H7R7用户闪存的编程一般由5个32位寄存器控制，他们分别是：
FLASH访问控制寄存器(FLASH_ACR)
FLASH秘钥寄存器(FLASH_KEYR)
FLASH状态寄存器(FLASH_SR)  
FLASH控制寄存器(FLASH_CR)  
FLASH CRC控制寄存器(FLASH_CRCCR)  
注意：这里的FLASH_KEYR、FLASH_SR、FLASH_CR、FLASH_CRCCR分别对应Bank1的相关寄存器，所以单个Bank的控制寄存器由：FLASH_KEYR、SR、CR和CCR等四个寄存器控制。下面，我们直接以FLASH_KEYR、FLASH_CR、FLASH_SR和FLASH_CCR来介绍相关操作。
STM32H7R7复位后，FLASH编程操作是被保护的，不能写入FLASH_CR寄存器；通过写入特定的序列（0X45670123和0XCDEF89AB）到FLASH_KEYR寄存器才可解除写保护，只有在写保护被解除后，我们才能操作相关寄存器。
FLASH_CR的解锁序列为：
1，写0X45670123到FLASH_KEYR
2，写0XCDEF89AB到FLASH_KEYR
通过这两个步骤，即可解锁FLASH_CR，如果写入错误，那么FLASH_CR将被锁定，直到下次复位后才可以再次解锁。
FLASH配置步骤
STM32H7R7的FLASH在编程的时候，也必须要求其写入地址的FLASH是被擦除了的（也就是其值必须是0XFFFFFFFF），否则无法写入。STM32H7R7的标准编程步骤如下：
1，检查FLASH_CR的LOCK是否解锁，如果没有则先解锁
2，检查FLASH_SR中的BUSY位，确保当前未执行任何FLASH操作。
3，将FLASH_CR寄存器中的PG位置1，激活FLASH编程。
4，等待BUSY位清零，完成一次编程。
按以上步骤，就可以完成一次FLASH编程。不过需要注意：编程前，要确保要写入地址的FLASH已经擦除。
在STM32H7R7的FLASH编程的时候，要先判断缩写地址是否被擦除了，所以，我们有必要再介绍一下STM32H7R7的闪存擦除，STM32H7R7的闪存擦除分为两种：扇区擦除和块擦除。
扇区擦除步骤如下：
1，检查FLASH_CR的LOCK是否解锁，如果没有则先解锁。
2，检查FLASH_SR寄存器中的BUSY 位，确保当前未执行任何FLASH操作。
3，在FLASH_CR寄存器中，将SER位置1，并设置SSN[2:0]=需要擦除的扇区号。
4，将FLASH_CR寄存器中的START位置1，触发擦除操作。
5，等待BUSY位清零。
经过以上五步，就可以擦除某个扇区。本章，我们只用到了STM32H7R7的扇区擦除功能。块擦除功能我们在这里就不介绍了，想了解的朋友请看《STM32H7Rx参考手册_V6（英文版）.pdf》的相关内容。

49.1.3 FLASH寄存器
Flash访问控制寄存器（FLASH_ACR）
Flash访问控制寄存器描述如图49.1.3.1所示：

图49.1.3.1 FLASH_ACR寄存器

WRHIGHFREQ[1:0]位，用于控制FLASH编程操作时的延迟，必须根据FLASH操作频率（rcc_aclk）进行正确的设置：00，rcc_aclk≤80Mhz；01，rcc_aclk≤160Mhz；10，rcc_aclk≤240Mhz；11，rcc_aclk≤320Mhz；我们的flash_aclk设置的是300Mhz，设置WRHIGHFREQ[1:0]=11即可。
LATENCY[3:0]位，用于控制FLASH读延迟，必须根据我们MCU内核的工作电压和频率，来进行正确的设置，否则，可能死机。
FLASH密钥寄存器（FLASH_KEYR）
FLASH密钥寄存器描述如图49.1.3.2所示：

图49.1.3.2 FLASH_KEYR寄存器

该寄存器主要用来解锁FLASH_CR，必须在该寄存器写入特定的序列（KEY1和KEY2）解锁后，才能对FLASH_CR寄存器进行写操作。
存储区1的FLASH控制寄存器（FLASH_CR）
存储区1的FLASH控制寄存器描述如图49.1.3.3所示：

图49.1.3.3 FLASH_CR寄存器

LOCK位，该位用于指示FLASH_CR寄存器是否被锁住，该位在检测到正确的解锁序列后，硬件将其清零。在一次不成功的解锁操作后，在下次系统复位之前，该位将不再改变。
PG位，该位用于选择编程操作，在往FLASH写数据的时候，该位需要置1。
SER位，该位用于选择扇区擦除操作，在扇区擦除的时候，需要将该位置1。
START位，该位用于开始一次擦除操作。在该位写入1 ，将执行一次擦除操作。
SSN[2:0]位，这3个位用于选择要擦除的扇区编号，取值范围为0~7。
其他位，我们就不在这里介绍了，请大家参考《STM32H7Rx参考手册_V6（英文版）.pdf》 。
存储区1的FLASH状态寄存器（FLASH_SR）
存储区1的FLASH状态寄存器描述如图49.1.3.4所示：

图49.1.3.4 FLASH_SR寄存器

BUSY位：表示BANK当前正在执行编程操作，必须等待该位为0，才可以执行其他操作。
WBNE位：表示BANK写BUFFER是否为空。当该位为1时，表示写BUFFER里面还有数据待写入FLASH，需要等待该位为0，才表示数据写入全部完成了。
QW位：表示操作序列里面是否还有编程操作需要执行，需要等待该位为0，才表示所有的编程操作完成了。
最后，FLASH清除控制寄存器FLASH_CRCCR用于清除相关错误，这里我们就不做介绍了，详见《STM32H7Rx参考手册_V6（英文版）.pdf》第5.9.8节。

49.2 硬件设计

1. 例程功能
按键KEY1控制写入FLASH的操作，按键KEY0控制读出操作，并在TFTLCD模块上显示相关信息。LED0闪烁用于提示程序正在运行。

2. 硬件资源
1）LED灯
       LED：LED0 – PD14
2）串口1(PB14/PB15连接在板载USB转串口芯片CH340上面)
3）正点原子2.8/3.5/4.3/7/10寸TFTLCD模块(包括MCU屏和RGB屏,都支持)
4）独立按键 ：
       KEY0 – PE9
       KEY1 – PE8

49.3 程序设计

49.3.1 FLASH的HAL库驱动
FLASH在HAL库中的驱动代码在stm32h7rsxx_hal_flash.c和stm32h7rsxx_hal_flash_ex.c文件（及其头文件）中。

1. HAL_FLASH_Unlock函数
解锁闪存控制寄存器访问的函数，其声明如下：

1. HAL_StatusTypeDef HAL_FLASH_Unlock(void);

复制代码

函数描述：
用于解锁闪存控制寄存器的访问，在对FLASH进行写操作前必须先解锁，解锁操作也就是必须在FLASH_KEYR寄存器写入特定的序列（KEY1和KEY0）。
函数形参：无
函数返回值：HAL_StatusTypeDef枚举类型的值。

2. HAL_FLASH_Lock函数
锁定闪存控制寄存器访问的函数，其声明如下：

1. HAL_StatusTypeDef HAL_FLASH_Lock (void);

复制代码

函数描述：
用于锁定闪存控制寄存器的访问。
函数形参：无
函数返回值：HAL_StatusTypeDef枚举类型的值。

3. HAL_FLASH_Program函数
闪存写操作函数，其声明如下：

1. HAL_StatusTypeDef HAL_FLASHEx_Program(uint32_t TypeProgram, uint32_t Address,
   
2. uint64_t Data);

复制代码

函数描述：
该函数用于FLASH的写入。
函数形参：
形参1是TypeProgram用来区分要写入的数据类型。
形参2是Address用来设置要写入数据的FLASH地址
形参3是Data是要写入的数据类型。
函数返回值：
HAL_StatusTypeDef枚举类型的值。

4. HAL_FLASHEx_Erase函数
闪存擦除函数，其声明如下：

1. HAL_StatusTypeDef HAL_FLASHEx_Erase(FLASH_EraseInitTypeDef *pEraseInit,
   
2. uint32_t *SectorError);

复制代码

函数描述：
该函数用于大量擦除或擦除指定的闪存扇区。
函数形参：
形参1是FLASH_EraseInitTypeDef结构体类型指针变量。

1. typedef struct
   
2. {
   
3.   uint32_t TypeErase;    /* 擦除类型 */
   
4.   uint32_t Sector;       /* 擦除的Sector编号 */   
   
5.   uint32_t NbSectors;    /* 擦除Sector的数量 */
   
6. } FLASH_EraseInitTypeDef;

复制代码

形参2是uint32_t类型指针变量，存放错误码，0xFFFFFFFF值表示扇区已被正确擦除，其它值表示擦除过程中的错误扇区。
函数返回值：HAL_StatusTypeDef枚举类型的值。

49.3.2 程序解析

1. STMFLASH驱动代码
这里我们只讲解核心代码，详细的源码请大家参考光盘本实验对应源码。STMFLASH驱动源码包括两个文件：stmflash.c和stmflash.h。
stmflash.h头文件做了一些比较重要的宏定义，定义如下：

1. /* FLASH起始地址 */
   
2. #define STM32_FLASH_BASE        0x08000000      /* STM32 FLASH 起始地址 */
   
3. #define STM32_FLASH_SIZE        0x10000         /* STM32 FLASH 总大小64KByte */

复制代码

STM32_FLASH_BASE和STM32_FLASH_SIZE分别是FLASH的起始地址和FLASH总大小，这两个宏定义随着芯片是固定的，STM32H7R7芯片的FLASH是64K字节，所以STM32_FLASH_SIZE宏定义值为0x10000。
下面我们开始介绍stmflash.c的程序，具体程序源码如下：

1. /**
   
2. * @brief       从指定地址读取一个字 (32位数据)
   
3. * [url=home.php?mod=space&uid=271674]@param[/url]       faddr   : 读取地址 (此地址必须为4倍数!!)
   
4. * @retval      读取到的数据 (32位)
   
5. */
   
6. uint32_t stmflash_read_word(uint32_t faddr)
   
7. {
   
8.     return *(volatile uint32_t *)faddr;
   
9. }
   
10. 
    
11. /**
    
12. * @brief       从指定地址开始读出指定长度的数据
    
13. * @param       raddr : 起始地址
    
14. * @param       pbuf  : 数据指针
    
15. * @param       length: 要读取的字(32位)数,即4个字节的整数倍
    
16. * @retval      无
    
17. */
    
18. void stmflash_read(uint32_t raddr, uint32_t *pbuf, uint32_t length)
    
19. {
    
20.     uint32_t  i;
    
21.     for (i = 0; i < length; i++)
    
22.     {
    
23.         pbuf[i] = stmflash_read_word(raddr);/* 读取4个字节 */
    
24.         raddr += 4;                         /* 偏移4个字节 */
    
25.     }
    
26. }
    
27. 
    
28. 
    
29. /**
    
30. * @brief       获取某个地址所在的flash扇区
    
31. * @param       addr: flash地址
    
32. * @retval      指定地址所在的flash扇区
    
33. */
    
34. static uint32_t stmflash_get_flash_sector(uint32_t addr)
    
35. {
    
36.     uint32_t sector = 0;
    
37. 
    
38.     if ((addr >= FLASH_BASE) && (addr < FLASH_BASE + FLASH_BANK_SIZE))
    
39.     {
    
40.         sector = (addr & ~FLASH_BASE) / FLASH_SECTOR_SIZE;
    
41.     }
    
42.     else
    
43.     {
    
44.         sector = 0xFFFFFFFF;    /* 地址溢出 */
    
45.     }
    
46. 
    
47.     return sector;
    
48. }
    
49. 
    
50. /**
    
51. * @brief       向指定地址写入指定长度的数据
    
52. * @param       waddr : 指定写入数据的起始地址
    
53. * @param       pbuf  : 保存写入数据的起始地址
    
54. * @param       length: 指定写入数据的长度，单位：字
    
55. * @retval      无
    
56. */
    
57. void stmflash_write(uint32_t waddr, uint32_t *pbuf, uint32_t length)
    
58. {
    
59.     uint32_t addrx;
    
60.     uint32_t endaddr;
    
61.     uint32_t first_sector = 0;
    
62.     uint32_t num_sectors = 0;
    
63.     uint32_t bank_number = 0;
    
64.     uint32_t erase_addr;                /* 擦除错误，这个值为发生错误的扇区地址 */
    
65.     FLASH_EraseInitTypeDef flash_erase_init = {0};
    
66.     HAL_StatusTypeDef status = HAL_OK;
    
67. 
    
68.     if ((waddr < STM32_FLASH_BASE) ||   /* 指定地址小于flash的起始地址 */
    
69.         (waddr > (STM32_FLASH_BASE + STM32_FLASH_SIZE)) || waddr % 4)
    
70.     /* 指定地址大于flash的末地址 */
    
71.     /* 指定地址没有按4字节对齐 */
    
72.     {
    
73.         return;                         /* 非法地址 */
    
74.     }
    
75. 
    
76.     HAL_ICACHE_Disable();               /* 禁用指令缓存 */
    
77.     HAL_FLASH_Unlock();                 /* FLASH解锁 */
    
78.     addrx = waddr;                      /* 数据写入的起始地址 */
    
79.     endaddr = waddr + length * 4;       /* 数据写入的结束地址 */
    
80. 
    
81. first_sector = stmflash_get_flash_sector(addrx);
    
82. /* 获取要擦除的第一个扇区 */
    
83. num_sectors = stmflash_get_flash_sector(endaddr) - first_sector + 1;
    
84. /* 获取要擦除的扇区数 */
    
85. 
    
86.     if (addrx < 0x08010000)              /* 只有主存储区，才需要进行擦除操作 */
    
87.     {
    
88.         while (addrx < endaddr)          /* 扫清障碍(对非FFFFFFFF的地方,先擦除) */
    
89.         {
    
90.             SCB_CleanInvalidateDCache(); /* 清除无效的D-Cache */
    
91.             if ((uint32_t)stmflash_read_word(addrx) != 0xFFFFFFFF)
    
92.             /* 存在非0xFFFFFFFF */
    
93.             {
    
94.                 flash_erase_init.TypeErase = FLASH_TYPEERASE_SECTORS;
    
95.                 /* 以扇区擦除的方式 */
    
96.                 flash_erase_init.Sector = first_sector;
    
97.                 /* 要擦除的第一个扇区 */
    
98.                 flash_erase_init.NbSectors = num_sectors;
    
99.                 /* 要擦除的扇区数 */
    
100.                 status = HAL_FLASHEx_Erase( &flash_erase_init, &erase_addr);
     
101.                 if (status == HAL_OK)          /* 擦除成功 */
     
102.                 {
     
103.                     break;
     
104.                 }
     
105.             }
     
106.             else                               /* 无需擦除 */
     
107.             {
     
108.                 addrx += 4;
     
109.             }
     
110.         }
     
111.     }
     
112.    
     
113.     if (status == HAL_OK)                     /* 擦除扇区没有错误 */
     
114.     {
     
115.         for(int i = 0; i < length; i++)
     
116.         {
     
117.             HAL_FLASH_Program(FLASH_TYPEPROGRAM_QUADWORD, waddr,
     
118. (uint32_t)&pbuf[i]);
     
119.             waddr += 4;                       /* 指向下一个半字 */
     
120.         }
     
121.     }
     
122.    
     
123.     HAL_FLASH_Lock();                         /* 上锁 */
     
124.     HAL_ICACHE_Enable();                      /* 启用指令缓存 */
     
125. }

复制代码

该部分代码，我们重点介绍一下stmflash_write函数，该函数用于在STM32H7R7的指定地址写入指定长度的数据，有几个要注意的点：
1，写入地址必须是用户代码区以外的地址。
2，写入地址必须是32的倍数。
3，单次写入长度必须是32字节的倍数（4个字）。
4，第 1 点比较好理解，如果把用户代码给擦除了，可想而知你运行的程序可能就被废了，从而很可能出现死机的情况。另外，STM32H7R7的扇区大小为8KB，而FLASH的擦除方式是以扇区为单位进行擦除的，所以建议大家使用该函数的时候，写入地址定位到用户代码占用扇区以外的扇区，比较保险。
5，第2点和第3点则是由于STM32H7R7的FLASH特性，每次写入必须是128位宽，也就是16字节，因此写入首地址必须是16字节的倍数，且写入数据长度必须是32字节的倍数。
由于我们使用了分散加载（ATK-DNH7R7_flash_ROMxspi1.sct），stmflash.c编译后是自动存放到外部QSPI FLASH的，所以不需要做额外的设置。关于分散加载说明，详见：7.2小节。

2. main.c代码
在main.c里面编写如下代码：

1. /* 要写入到STM32 FLASH的字符串数组 */
   
2. uint8_t g_text_buf[] = {"STM32 FLASH TEST"};
   
3. 
   
4. #define TEXT_LENTH sizeof(g_text_buf) /* 数组长度 */
   
5. 
   
6. /*SIZE表示半字长(4字节), 大小必须是4的整数倍, 如果不是的话, 强制对齐到4的整数倍 */
   
7. #define SIZE TEXT_LENTH / 4 + ((TEXT_LENTH % 4) ? 1 : 0)
   
8. 
   
9. #define FLASH_SAVE_ADDR 0x0800E000
   
10. /* 设置FLASH 保存地址(必须大于用于代码区地址范围，且为4的倍数 */
    
11. 
    
12. int main(void)
    
13. {
    
14.     uint8_t key = 0;
    
15.     uint8_t i = 0;
    
16.     uint32_t datatemp[SIZE];
    
17. 
    
18.     sys_mpu_config();                   /* 配置MPU */
    
19.     sys_cache_enable();                 /* 使能Cache */
    
20.     HAL_Init();                         /* 初始化HAL库 */
    
21.     sys_stm32_clock_init(300, 6, 2);    /* 配置时钟，600MHz */
    
22.     delay_init(600);                    /* 初始化延时 */
    
23.     usart_init(115200);                 /* 初始化串口 */
    
24.     usmart_dev.init(300);               /* 初始化USMART */
    
25.     led_init();                         /* 初始化LED */
    
26.     key_init();                         /* 初始化按键 */
    
27.     hyperram_init();                    /* 初始化HyperRAM */
    
28.     lcd_init();                         /* 初始化LCD */
    
29. 
    
30.     lcd_show_string(30, 50, 200, 16, 16, "STM32", RED);
    
31.     lcd_show_string(30, 70, 200, 16, 16, "FLASH EEPROM TEST", RED);
    
32.     lcd_show_string(30, 90, 200, 16, 16, "ATOM@ALIENTEK", RED);
    
33.     lcd_show_string(30, 110, 200, 16, 16, "KEY1:Write  KEY0:Read", RED);
    
34. 
    
35.     while (1)
    
36.     {
    
37.         key = key_scan(0);
    
38. 
    
39.         if (key == KEY1_PRES)                  /* KEY1按下,写入STM32 FLASH */
    
40.         {
    
41.             lcd_fill(0, 150, 239, 319, WHITE); /* 清除半屏 */
    
42.             lcd_show_string(30,150, 200, 16, 16, "Start Write FLASH....", RED);
    
43.             stmflash_write(FLASH_SAVE_ADDR, (uint32_t *)g_text_buf, SIZE);
    
44.             lcd_show_string(30,150, 200, 16, 16, "FLASH Write Finished!", RED);                    /* 提示传送完成 */
    
45.         }
    
46. 
    
47.         if (key == KEY0_PRES)                 /* KEY0按下,读取字符串并显示 */
    
48.         {
    
49.             lcd_show_string(30,150, 200, 16, 16, "Start Read FLASH.... ", RED);
    
50.             stmflash_read(FLASH_SAVE_ADDR, (uint32_t *)datatemp, SIZE);
    
51.             lcd_show_string(30,150, 200, 16, 16, "The Data Readed Is:  ", RED);                         /* 提示传送完成 */
    
52.             lcd_show_string(30,170, 200, 16, 16, (char *)datatemp, BLUE);                               /* 显示读到的字符串 */
    
53.         }
    
54. 
    
55.         i++;
    
56.         delay_ms(10);
    
57. 
    
58.         if (i == 20)
    
59.         {
    
60.             LED0_TOGGLE();               /* 提示系统正在运行 */
    
61.             i = 0;
    
62.         }
    
63.     }
    
64. }

复制代码

主函数代码逻辑比较简单，当检测到按键KEY1按下后往FLASH指定地址开始的连续地址空间写入一段数据，当检测到按键KEY0按下后读取FLASH指定地址开始的连续空间数据。
最后，我们将stmflash_read_word和test_write函数加入USMART控制，这样，我们就可以通过串口调试助手，调用STM32H7R7的FLASH读写函数，方便测试。

49.4 下载验证
将程序下载到开发板后，可以看到LED0不停的闪烁，提示程序已经在运行了。LCD显示的内容如图49.4.1所示：

图49.4.1程序运行效果图

通过先按KEY1按键写入数据，然后按KEY0读取数据，得到如图49.4.2所示：

图49.4.2 操作后的显示效果图