【正点原子STM32连载】 第四十三章 FLASH模拟EEPROM实验 摘自【正点原子】APM32E103最小系统板使用指南

1）实验平台：正点原子APM32E103最小系统板
2）平台购买地址：https://detail.tmall.com/item.htm?id=609294757420
3）全套实验源码+手册+视频下载地址： http://www.openedv.com/docs/boards/xiaoxitongban

第四十三章 FLASH模拟EEPROM实验

本章将介绍使用APM32E103的片上Flash模拟EEPROM，并对齐进行读写操作。通过本章的学习，读者将学习到闪存存储器控制（FMC）的使用。
本章分为如下几个小节：
43.1 硬件设计
43.2 程序设计
43.3 下载验证

43.1 硬件设计
43.1.1 例程功能

1. 按下KEY_UP和KEY0按键，分别对Flash进行数据的写入和读取操作，读取到的数据会显示至LCD
2. 可通过USMART对Flash进行单字数据的读取和写入操作
3. LED0闪烁，指示程序正在运行
   43.1.2 硬件资源
4. LED
   LED0 - PB5
5. 按键
   KEY0 - PE4
   KEY_UP - PA0
6. USART1（PA9、PA10连接至板载USB转串口芯片上）
7. 正点原子 2.8/3.5/4.3/7/10寸TFTLCD模块（仅限MCU屏，16位8080并口驱动）
   43.1.3 原理图
   本章实验使用的FMC为APM32E103的片上资源，因此没有对应的连接原理图。
   43.2 程序设计
   43.2.1 Geehy标准库的FMC驱动
   APM32E103的片上Flash是可以直接读取的，但Flash无法直接写入，写入Flash前，需要先对其进行擦除操作，该操作需要有FMC来完成，其具体的操作步骤如下：
   ①：解锁访问FMC控制寄存器
   ②：擦除前禁止Flash的数据缓冲
   ③：擦除Flash的指定扇区
   ④：对Flash进行编程
   ⑤：重新使能Flash的数据缓冲
   ⑥：重新上锁访问FMC控制寄存器
   在Geehy标准库中对应的驱动函数如下：
   ①：解锁访问FMC控制寄存器
   该函数用于解锁访问FMC控制寄存器，其函数原型如下所示：
   void FMC_Unlock(void);
   该函数的形参描述，如下表所示：

形参 描述
无 无
表43.2.1.1 函数FMC_Unlock()形参描述
该函数的返回值描述，如下表所示：
返回值 描述
无 无
表43.2.1.2 函数FMC_Unlock()返回值描述
该函数的使用示例，如下所示：

#include " apm32e10x.h"
#include " apm32e10x _fmc.h"

void example_fun(void)
{
    /* 解锁访问FMC控制寄存器 */
    FMC_Unlock();
}

②：擦除指定的FMC页面
该函数用于擦除Flash的指定扇区，其函数原型如下所示：
FMC_STATUS_T FMC_ErasePage(uint32_t pageAddr);
该函数的形参描述，如下表所示：
形参 描述
pageAddr 要擦除的页面地址例（在apm32e10x_fmc.h文件中有定义）
表43.2.1.5 函数FMC_Erase Page()形参描述
该函数的返回值描述，如下表所示：
返回值 描述
FMC_STATUS_BUSY 忙
FMC_STATUS_ERROR_PG 编程错误
FMC_STATUS_ERROR_WRP 写保护错误
FMC_STATUS_COMPLETE 操作完成
FMC_STATUS_TIMEOUT 超时错误
表43.2.1.6 函数FMC_EraseSector()返回值描述
该函数的使用示例，如下所示：

#include "apm32e10x.h"
#include "apm32e10x_fmc.h"

void example_fun(void)
{
    FMC_STATUS_T status;
    
    /* 擦除Flash的扇区11（系统电压在2.7V~3.6V之间） */
    status = FMC_ErasePage(pageaddr)；
    if (status == FMC_COMPLETE)
    {
    		/* Do something. */
    }
    else
    {
    		/* Do something. */
    }
}

③：字编程Flash
该函数用于对Flash进行字编程，其函数原型如下所示：
FMC_STATUS_T FMC_ProgramHalfWord(uint32_t address, uint32_t data);
该函数的形参描述，如下表所示：
形参 描述
address 指定Flash的地址
data 指定的数据
表43.2.1.7 函数FMC_ProgramHalfWord()形参描述
该函数的返回值描述，如下表所示：
返回值 描述
FMC_STATUS_BUSY 忙
FMC_STATUS_ERROR_PG 编程错误
FMC_STATUS_ERROR_WRP 写保护错误
FMC_STATUS_COMPLETE 操作完成
FMC_STATUS_TIMEOUT 超时错误
表43.2.1.8 函数FMC_ProgramHalfWord()返回值描述
该函数的使用示例，如下所示：

#include "apm32e10x.h"
#include "apm32e10x_fmc.h"

void example_fun(void)
{
    FMC_STATUS_T status;
    
    /* 编程Flash指定地址0x08000000为0x50505050 */
    status = FMC_ProgramHalfWord(0x08000000, 0x50505050)；
    if (status == FMC_COMPLETE)
    {
    /* Do something. */
    }
    else
    {
    /* Do something. */
    }
}

④：使能Flash数据缓冲
该函数用于使能Flash的数据缓冲，其函数原型如下所示：
void FMC_EnableDataCache(void);
该函数的形参描述，如下表所示：
形参 描述
无 无
表43.2.1.9 函数FMC_EnableDataCache()形参描述
该函数的返回值描述，如下表所示：
返回值 描述
无 无
表43.2.1.10 函数FMC_EnableDataCache()返回值描述
该函数的使用示例，如下所示：

#include "apm32e10x.h"
#include "apm32e10x_fmc.h"

void example_fun(void)
{
    /* 使能Flash的数据缓冲 */
    FMC_EnableDataCache();
}

⑤：上锁访问FMC控制寄存器
该函数用于上锁FMC控制寄存器，其函数原型如下所示：
void FMC_Lock(void);
该函数的形参描述，如下表所示：
形参 描述
无 无
表43.2.1.11 函数FMC_Lock()形参描述
该函数的返回值描述，如下表所示：
返回值 描述
无 无
表43.2.1.12 函数FMC_Lock()返回值描述
该函数的使用示例，如下所示：

#include "apm32e10x.h"
#include "apm32e10x_fmc.h"

void example_fun(void)
{
    /* 上锁访问FMC控制寄存器 */
    FMC_Lock();
}

43.2.2 Flash驱动
本章实验的Flash驱动主要负责向应用层提供Flash的读写操作函数。本章实验中，Flash的驱动代码包括apmflash.c和apmflash.h两个文件。
Flash驱动中，读取Flash数据的函数，如下所示：

/**
 * @brief       从指定地址读出一个半字数据
 * @param       faddr: 读取地址，必须按2字节对齐
 * @retval      读取到的一个半字数据
 */
uint16_t apmflash_read_halfword(uint32_t faddr)
{
    return *(volatile uint16_t *)faddr;
}

/**
 * @brief       从指定地址读出指定长度的数据
 * @param       raddr : 指定读出数据的起始地址
 * @param       pbuf  : 保存读出数据的起始地址
 * @param       length: 指定读出数据的长度，单位：半字
 * @retval      无
 */
void apmflash_read(uint32_t raddr, uint16_t *pbuf, uint16_t length)
{
    uint16_t i;
    
    for (i=0; i<length; i++)
    {
        pbuf[i] = apmflash_read_halfword(raddr);    /* 读出一个半字的数据 */
        raddr += 2;                                 /* 地址偏移一个半字的长度 */
    }
}

APM32E103片上Flash的读取十分简单，仅需读取对应地址的数据即可。
Flash驱动中，往Flash写入数据的函数，如下所示：

/**
 * @brief       向指定地址写入指定长度的数据
 * @param       waddr : 指定写入数据的起始地址
 * @param       pbuf  : 保存写入数据的起始地址
 * @param       length: 指定写入数据的长度，单位：半字
 * @retval      无
 */
void apmflash_write(uint32_t waddr, uint16_t *pbuf, uint32_t length)
{
    uint32_t addrx;
    uint32_t endaddr;
    uint32_t pageaddr;
    FMC_STATUS_T status = FMC_STATUS_COMPLETE;
    /* 指定地址小于Flash的起始地址 */
if ((waddr < APM32_FLASH_BASE) ||
/* 指定地址大于Flash的末地址 */
        (waddr > (APM32_FLASH_BASE + APM32_FLASH_SIZE)) ||
/* 指定地址没有按2字节对齐 */
        ((waddr & 1) != 0))
    {
        return;
    }
    
    FMC_Unlock();
    
    addrx = waddr;                           /* 数据写入的起始地址 */
    endaddr = waddr + (length << 1);         /* 数据写入的结束地址 */
    while (addrx < endaddr)                  /* 擦除写入区域中存在非0xFFFF的扇区 */
    {   /* 存在非0xFFFF */
        if (apmflash_read_halfword(addrx) != 0xFFFF)
        {	/* 计算页地址（向下按页大小对齐） */
            pageaddr = addrx & ~(APM32_PAGE_SIZE - 1);
			/* 擦除页 */
            status = FMC_ErasePage(pageaddr);
			/* 擦除失败 */
            if (status != FMC_STATUS_COMPLETE)
            {
                break;
            }
        }
        else                                 /* 擦除成功 */
        {
            addrx += 2;
        }
    }
    
    if (status == FMC_STATUS_COMPLETE)       /* 擦除扇区没有错误 */
    {
        while (waddr < endaddr)
        {	/* 写入数据 */
            if (FMC_ProgramHalfWord(waddr, *pbuf) != FMC_STATUS_COMPLETE)
            {
                break;
            }
            
            waddr += 2;
            pbuf++;
        }
    }
    FMC_Lock();                              /* 重新上锁访问FMC控制寄存器 */
}

在写Flash前需要先判断待写入的比特位是否为1，若不为1则需要先进行擦除操作，否则将写入失败，保证待写入位置的比特位全部为0后，方可调用函数FMC_ProgramWord()对Flash进行编程。
43.2.3 实验应用代码
本章实验的应用代码，如下所示：

/* 待写入Flash的数据 */
static const uint8_t g_text_buf[] = {"APM32 FLASH TEST"};
/* 待写入Flash数据的长度 */
#define TEXT_SIZE sizeof(g_text_buf)
/* 写Flash的长度，单位：字，按2字节向上对齐 */
#define SIZE ((TEXT_SIZE >> 1) + (((TEXT_SIZE & 1) != 0) ? 1 : 0))
/* 写Flash的地址，必须大于本代码的大小+Flash的起始地址（0x08000000） */
#define FLASH_SAVE_ADDR 0x08010000

int main(void)
{
    uint8_t t = 0;
    uint8_t key;
    uint8_t data[SIZE];
    
    NVIC_ConfigPriorityGroup(NVIC_PRIORITY_GROUP_4);  /* 设置中断优先级分组为组4 */
    sys_apm32_clock_init(15);                         /* 配置系统时钟 */
    delay_init(120);                                  /* 初始化延时功能 */
    usart_init(115200);                               /* 初始化串口 */
    usmart_dev.init(120);                             /* 初始化USMART */
    led_init();                                       /* 初始化LED */
    key_init();                                       /* 初始化按键 */
    lcd_init();                                       /* 初始化LCD */
    
    lcd_show_string(30, 50, 200, 16, 16, "APM32", RED);
    lcd_show_string(30, 70, 200, 16, 16, "FLASH EEPROM TEST", RED);
    lcd_show_string(30, 90, 200, 16, 16, "ATOM@ALIENTEK", RED);
    lcd_show_string(30, 110, 200, 16, 16, "KEY_UP:Write  KEY0:Read", RED);
    
    while (1)
    {
        t++;
        key = key_scan(0);
        
        if (key == WKUP_PRES)                         /* 写Flash */
        {
            lcd_fill(0, 150, 239, 319, WHITE);
            lcd_show_string(30, 150, 200, 16, 16, "Start Write FLASH....", RED);
            apmflash_write(FLASH_SAVE_ADDR, (uint16_t *)g_text_buf, SIZE);
            lcd_show_string(30, 150, 200, 16, 16, "FLASH Write Finished!", RED);
        }
        else if (key == KEY0_PRES)                    /* 读Flash */
        {
            lcd_show_string(30, 150, 200, 16, 16, "Start Read FLASH.... ", RED);
            apmflash_read(FLASH_SAVE_ADDR, (uint16_t *)data, SIZE);
            lcd_show_string(30, 150, 200, 16, 16, "The Data Readed Is:  ", RED);
            lcd_show_string(30, 170, 200, 16, 16, (char *)data, BLUE);
        }
        
        if (t == 20)
        {
            LED0_TOGGLE();
            t = 0;
        }
        delay_ms(10);
    }
}

从本章实验的应用代码中可以看到，在完成相关的初始化工作后，便会不断地等待按键输入，若检测到KEY_UP按键被按下，则会往Flash的指定地址中写入指定的数据，若检测到KEY_0按键被按下，则会从Flash的指定地址中读取数据，并在LCD上进行显示。
43.3 下载验证
在完成编译和烧录操作后，可以看到LCD上显示了本实验相关的信息，此时便可按下KEY_UP按键往Flash的指定地址写入指定数据，然后再按下KEY_0按键从Flash的指定地址将写入的数据读回来在LCD上进行显示，此时便可以看到在LCD上显示了“APM32 FLASH TEST”的提示信息，该提示信息就是从Flash中读回的数据。