创建Cortex-M系列芯片下载算法

     我们平时在使用$STM32$系列芯片的时候，在编译好程序之后，可能就是一个简单的鼠标操作，单机一下$KeilMDKIDE$上的$Download$就可以了，但是实际上在下载程序到$Flash$上的时候还需要一个叫做$Flashprogrammingalgorithm$的东西，如图1所示。因为我们知道一般芯片内部的$Flash$如果要进行烧录的话，需要先擦除，那么这个$Flashprogrammingalgorithm$就相当于给$KeilMDKIDE$提供了一系列操作内部的$Flash$的接口。

图1.

     一般情况下，芯片供应商已经在对应的$PACK$包里面为你准备好了对应的$Flashprogrammingalgorithm$。那我们现在的问题是如何自己去构建$Flashprogrammingalgorithm$文件。关于这一点大家可以先看一看$ARM$公司关于这一块的官方介绍。下面我将简单的介绍一下$CORTEX-M$系列芯片的$Flashprogrammingalgorithm$文件的构建过程，注意这里是$CORTEX-M$系列芯片，$ARM$公司其他系列芯片的$Flashprogrammingalgorithm$文件的构建过程可能还不同。下面的讲解主要基于$CMSIS$官方介绍。
     首先找到你的$KeilMDKIDE$的$PACK$包的安装目录，然后将到图1（这里是我的$KeilMDKIDE$的$PACK$包的安装目录，你需要确定你自己的）所示的$Flashprogrammingalgorithm$模板工程复制出来。然后可以根据自己的喜好改一下图4和图5中的名字，当然这里不改也是可以的，但是图3的地方还是需要改一下，因为我打算用$STM32F103$作为测试的例子，$STM32F103$是$M3$的内核，因此这里选择$M3$。最后一步也是最重要的一步是更改图6中的那两个文件，也就是一系列操作内部的$Flash$的接口，接下来我们会重点讲到。有了这些之后编译这个工程就会生成你所需的$Flashprogrammingalgorithm$。

图2. 图3. 图4. 图5. 图6.

     文件$FlashDev.c$里面主要是一些参数定义，定义在一个结构体中。图7是这个参数结构体的定义，结构体的第1个元素是下载算法的版本，这里自己填写，第2个元素是芯片相关描述，这里自己填写，第3个元素是$Flash$所在位置，是片上（$ONCHIP$），还是片外（$EXT\_x\_BIT$），这里自己填写。第4个元素和第5个元素分别是$Flash$的起始地址和大小（因为我这里的测试芯片是$STM32F103ZET6$，因此$Flash$是$512KB=0x00080000$，虽然芯片在启动的时候，地址$0x00000000$可以自动映射到地址$0x08000000$，但是这里的起始地址只能写为$0x08000000$），第6个元素是$Flash$的一个页的大小，$STM32F103ZET6$的$Flash$的一个页的大小为$2KB=2048BYTES$，第7个元素保留，第8个元素说明$Flash$擦除完之后的内容，一般擦除完之后都是全F。第9个元素和第10个元素分别是$Flash$页擦除和片擦除超时时间。最后一个元素定义了整片$Flash$的页的分布情况，它是一个结构体数组。这个结构体有两个元素，第一个是一个页的大小，另一个是页的起始地址，要注意的是这里不用把每一个页的起始地址和大小都列出来，比如$STM32F103ZET6$的$Flash$一共有256个页，每一个页的大小都是$2KB=2048BYTES$，因此这里结构体数组的第0个元素写为$(2048,0x00000000)$就可以了（注意这里的起始地址只能写为$0x00000000$而不能写为$0x08000000$，具体的细节的原因我占时不知道，如果你这里写为$0x08000000$，在下载程序的时候会报错，程序无法下载成功），这就表明整片$Flash$的大小都是$2KB=2048BYTES$。别忘了最后还要加一个数组元素$SECTOR\_END$。那如果出现$Flash$的所有页不是同样大小的情况怎么样，我们现在举一个简单的例子，假如$Flash$开头的8页，每一页的大小都是$8KB$，接下来的两页，每一页的大小都是$64KB$，接下来的所有页，每一页的大小都是$8KB$，如图8所示，这个例子也是上面复制的模板工程里面原来的代码。改完之后的参数结构体如图9所示。

图7. 图8. 图9.

     下面我们来详细介绍一下$Flashprogrammingalgorithm$需要用到的一些接口函数以及相应的流程，这些函数都在文$FlashPrg.c$中，如下所示，其中前面4个是必须的，后面3个可以根据需求可选，这里我在测试的时候只实现了必须要实现的接口函数。

• $Init，（必须）$
• $UnInit，（必须）$
• $EraseSector，（必须）$
• $ProgramPage，（必须）$
• $EraseChip，（可选）$
• $BlankCheck，（可选）$
• $Verify，（可选）$

     接口函数$BlankCheck$主要的功能是用来检查当前的$Flash$区域是否是空的，注意对于$Flash$区域来说空的含义就是这个区域的每一个字节的内容都是全$F$，$0xFF$，起始如果对于一个区域是全$F$的话，我们不去擦除就可以直接去烧录。当然这个函数也可以用来检查一块特定的$Flash$区域的内容是否等于特定的值，比如每一个字节的内容是否等于$0xAA$。其中参数$adr$表示要检查的$Flash$区域的起始地址，参数$sz$表示要检查的$Flash$区域的大小，参数$pat$表示要检查的$Flash$区域的预期的特定值，比如$0xFF$。

int BlankCheck (unsigned long adr, unsigned long sz, unsigned char pat);
Parameters
    adr	Block start address
    sz	Block size in bytes
    pat	Pattern to compare
Returns
    status information:0 when the block content is equal to the pattern pat.
    status information:1 when the block content differs from the pattern pat.
1
2
3
4
5
6
7
8

     接口函数$EraseChip$主要的功能是用来擦除整片$Flash$区域，如果我们在图10中配置下载算法的对话框中勾选了$EraseFullChip$的话，在下载程序的过程中，$KeilMDKIDE$就会调用下载算法中的这个接口首先将整片$Flash$区域擦除，这个函数实现起来是比较简单的，一般芯片设计公司提供的库函数里面就有响应功能的接口函数，参考一下就可以了，比如$ST$公司的$STM32F103$提供的擦除整片$Flash$区域的接口函数如图11所示。如果我们没有实现这个接口函数的话，$KeilMDKIDE$会不断调用$EraseSector$接口函数，直到整片$Flash$区域被擦除。

int EraseChip (void);
Returns 
    status information: 0 on success.
    status information: 1 on failure.
1
2
3
4

图10.

/*
 *  Erase complete Flash Memory
 *    Return Value:   0 - OK,  1 - Failed
 */

int EraseChip (void) 
{
    FLASH_Status status = FLASH_COMPLETE;

    /* Wait for last operation to be completed */
    status = FLASH_WaitForLastOperation(EraseTimeout);
    if(status == FLASH_COMPLETE)
    {
        /* if the previous operation is completed, proceed to erase all pages */
        FLASH->CR |= CR_MER_Set;
        FLASH->CR |= CR_STRT_Set;
    
        /* Wait for last operation to be completed */
        status = FLASH_WaitForLastOperation(EraseTimeout);

        /* Disable the MER Bit */
        FLASH->CR &= CR_MER_Reset;
    }
    /* Return the Erase Status */
    if(status == FLASH_COMPLETE)
    { 
        return (0);  		
	}
	else
    {
        return (1);  	
	}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

图11.

     接口函数$EraseSector$主要的功能是用来擦除$Flash$区域的一页内容，如果我们在图10中配置下载算法的对话框中勾选了$EraseFullSectors$的话，在下载程序的过程中，$KeilMDKIDE$就会调用下载算法中的这个接口。参数$adr$表示要擦除的$Flash$区域的页的起始地址，这个函数实现起来是比较简单的，一般芯片设计公司提供的库函数里面就有响应功能的接口函数，参考一下就可以了，比如$ST$公司的$STM32F103$提供的擦除$Flash$区域的一页接口函数如图12所示。

int EraseSector (unsigned long adr);
Parameters
    adr	Sector address
Returns
    status information:0 on success.
    status information:1 on failure.
1
2
3
4
5
6

     接口函数$EraseSector$我的具体实现如下所示，因为原本的工程里面没有下面函数中$FLASH$等结构体的定义，因此这些结构体的定义，你需要自己添加进去。

/*
 *  Erase Sector in Flash Memory
 *    Parameter:      adr:  Sector Address
 *    Return Value:   0 - OK,  1 - Failed
 */

int EraseSector (unsigned long adr) 
{
    FLASH_Status status = FLASH_COMPLETE;

    /* Wait for last operation to be completed */
    status = FLASH_WaitForLastOperation(EraseTimeout);
  
    if(status == FLASH_COMPLETE)
    { 
        /* if the previous operation is completed, proceed to erase the page */
        FLASH->CR|= CR_PER_Set;
        FLASH->AR = adr; 
        FLASH->CR|= CR_STRT_Set;
    
        /* Wait for last operation to be completed */
        status = FLASH_WaitForLastOperation(EraseTimeout);
    
        /* Disable the PER Bit */
        FLASH->CR &= CR_PER_Reset;
    }

    /* Return the Erase Status */
    if(status == FLASH_COMPLETE)
    { 
        return (0);  		
    }
    else
    {
        return (1);  	
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

图12.

     接口函数$Init$用来在操作$Flash$区域前的一些初始化操作，像最基本的，在操作$Flash$相关的寄存器前需要先解锁。参数$adr$表示$Flash$设备的基地址，参数$fnc$表示不同的操作，1表示擦除，2表示烧录，3表示验证，参数$clk$表示操作时的时钟频率，但是我看官方的模板函数里面这三个参数基本没有用到，这里我也没有细究了。这里我的具体实现也比较简单，也就是给$Flash$操作解锁了。

int Init (unsigned long adr, unsigned long clk, unsigned long fnc);
Parameters
    adr	Device base address
    clk	Clock frequency (Hz)
    fnc	Function code
Returns
    status information:0 on success.
    status information:1 on failure.
1
2
3
4
5
6
7
8

/*
 *  Initialize Flash Programming Functions
 *    Parameter:      adr:  Device Base Address
 *                    clk:  Clock Frequency (Hz)
 *                    fnc:  Function Code (1 - Erase, 2 - Program, 3 - Verify)
 *    Return Value:   0 - OK,  1 - Failed
 */

int Init (unsigned long adr, unsigned long clk, unsigned long fnc) 
{
  FLASH_Unlock();
  return (0);                                 
}
1
2
3
4
5
6
7
8
9
10
11
12
13

     接口函数$ProgramPage$主要的功能是在下载程序的过程中将编译好的代码文件烧录到$Flash$区域中，每调用一次该函数只能烧录一页的内容。参数$adr$表示要烧录的$Flash$区域的页的起始地址，参数$sz$表示要烧录的$Flash$区域的页的大小，参数$buf$存储要烧录到$Flash$区域的页中的代码的实际内容。这个函数实现起来是比较简单的，但是这里$ST$公司的$STM32F103$的库函数里面没有直接的烧录一页的接口函数，只有烧录一个字或半个字的接口函数，$STM32F103$的$Flash$区域一次只能烧录半个字，我们可以可以调用如图13所示的烧录半个字的接口来实现烧录一页的接口函数。

int ProgramPage (unsigned long adr, unsigned long sz, unsigned char *buf);
Parameters
    adr	Page start address
    sz	Page size
    buf	Data to be written
Returns
    status information: 0 on success.
    status information: 1 on failure.
1
2
3
4
5
6
7
8

/*
 *  Program Page in Flash Memory
 *    Parameter:      adr:  Page Start Address
 *                    sz:   Page Size
 *                    buf:  Page Data
 *    Return Value:   0 - OK,  1 - Failed
 */

int ProgramPage (unsigned long adr, unsigned long sz, unsigned char *buf) 
{
    FLASH_Status status = FLASH_COMPLETE;	
    sz = (sz + 1) & ~1;                          // Adjust size for Half Words
 
    while (sz) 
    {
        status = FLASH_COMPLETE;
        status=FLASH_ProgramHalfWord(adr, *((unsigned short *)buf));		
        /* Return the Program Status */
        if(status != FLASH_COMPLETE)
        { 
            return (1);  	
	    }	
        /* Go to next Half Word */
        adr += 2;
        buf += 2;
        sz  -= 2;				
    }
    return (0);                                 
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

图13.

     接口函数$UnInit$用来进行在操作（擦除，烧录，验证）$Flash$区域后的一些操作，像最基本的，对$Flash$相关的寄存器重新上锁。参数$fnc$表示不同的操作，1表示擦除，2表示烧录，3表示验证，但是我看官方的模板函数里面这个参数基本没有用到，这里我也没有细究了。这里我的具体实现也比较简单，也就是给$Flash$重新上锁。

int UnInit (unsigned long fnc);
Parameters
    fnc	Function code
Returns
    status information:0 on success.
    status information:1 on failure.
1
2
3
4
5
6

/*
 *  De-Initialize Flash Programming Functions
 *    Parameter:      fnc:  Function Code (1 - Erase, 2 - Program, 3 - Verify)
 *    Return Value:   0 - OK,  1 - Failed
 */

int UnInit (unsigned long fnc) 
{
  FLASH_Lock();
  return (0);                                 
}
1
2
3
4
5
6
7
8
9
10
11

     接口函数$Verify$主要的功能是对比已经下载到$Flash$区域中的代码和代码文件，也就是看下载到$Flash$区域中的代码和编译生成的代码是否一致。参数$adr$表示要对比的$Flash$区域的起始地址，参数$sz$表示要对比的$Flash$区域的大小，参数$buf$存储要对比的代码的实际内容。

unsigned long Verify (unsigned long adr, unsigned long sz, unsigned char *buf);
Parameters
    adr	Start address
    sz	Size in bytes
    buf	Data to be compared
Returns
    status information:the sum of (adr+sz) - on success.
    status information:any other number - on failure, and represents the failing address.
1
2
3
4
5
6
7
8

     有了以上修改之后，编译这个模板工程就可以生成你所需的下载算法了，下载算法的文件名后缀为$FLM$，可以将这个生成的下载算法替代以前的下载算法，测试看看能否下载成功。最后图14是$Flashprogrammingalgorithm$的擦除流程，图15是$Flashprogrammingalgorithm$的程序烧录流程，图16是$Flashprogrammingalgorithm$的验证流程。我的测试工程在这里。

图14. 图15. 图16.