浅析IAR下的串行Flash下载算法设计

NXP管管

浅析IAR下的串行Flash下载算法设计

大家好，我是痞子衡，是正经搞技术的痞子。今天痞子衡给大家介绍的是IAR开发环境下i.MXRT的串行NOR Flash下载算法设计。


在i.MXRT硬件那些事系列之《在串行NOR Flash XIP调试原理》一文中，痞子衡简单提了一下串行NOR Flash下载算法的概念，并没有介绍具体设计细节，关于NOR Flash下载算法每个IDE都有自己的一套设计，虽然基本设计理念是一样的，但是细节方面还是有区别。在前面的文章里，痞子衡分别介绍过《J-Link下算法设计》、《Keil MDK下算法设计》，今天痞子衡就来细聊IAR下的NOR Flash下载算法：

一、IAR各版本对i.MXRT的支持
IAR跟Keil一样都是非常经典的MCU开发IDE，可以说是难分伯仲，痞子衡求学期间就用IAR开发过MSP430单片机，但是只是浅尝辄止，因为搞ARM Cortex-M就切换到更熟悉的Keil下了，直到毕业后加入恩智浦才一直在用IAR。这么多年过去了，IAR还是当初那个独立小公司，没有被收购，而且依然保持竞争力，这一波RISC-V浪潮估计会让它超越被ARM束缚的Keil。


从IAR官网上看，目前最新的IAR EWARM版本是v8.50.6，其能够支持目前所有已量产的i.MXRT系列。如果你安装的不是最新版本，比如安装了v8.40，从 IAR历史各版本Release Note 上看，v8.40版本不支持RT500和RT600，那么如果想要支持新芯片（比如RT600），是不是一定要重新安装最新IAR呢？其实未必！

IAR对新MCU型号的支持并不是与自身版本严格绑定的，其增加新芯片的方式很灵活，只需要按要求打上相应芯片的patch包即可。

二、为当前IAR增加新i.MXRT型号支持
在 IAR历史各版本Release Note 页面点击 8.50 进入这个版本的专属页面，往下翻你会找到专门的i.MXRT600 patch包，直接下载这个包(ewarm850-nxp-imxrt5xx-6xx-patch4.zip文件)。

有了patch包之后，打patch就相当简单了，直接将ewarm850-nxp-imxrt5xx-6xx-patch4.zip包解压放到IAR安装目录下即可，patch包的文件目录结构与IAR下安装目录结构是一样的。

patch包里的文件很多，其中跟下载算法相关的一共如下四个文件：.board和.flash是xml文件，其功能类似JLink下的JLinkDevices.xml文件。.mac是预加载文件，功能类似JLink下的.JLinkScript文件，.out文件就是真正的下载算法可执行文件。

1. \arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.board
   
2. \arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.flash
   
3. \arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.mac
   
4. \arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.out

复制代码

两个xml文件里的代码含义在 \IAR Systems\Embedded Workbench 8.50.6\arm\doc\FlashLoaderGuide.ENU.pdf 文档的 The flash memory configuration file 和 The flash memory system configuration file 两小节里有详细解释。


2.1 .board文件代码分析
.board顾名思义就是板级描述文件，每个.board文件可以指向多个.flash文件（如果这块板子存在多块flash）。让我们试着分析 FlashIMXRT600_EVK_FLEXSPI.board 文件中那些模板代码的含义：.board文件里可以有多个<pass>块，每个pass对应一种flash类型。在每个<pass>里最多有如下6个参数（其中loader参数是必须的，其他是可选）：

1. loader     -- 指示.flash文件路径。
   
2. range      -- Flash在芯片内存中的映射空间范围。
   
3. abs_offset -- 当被下载的app链接地址与往Flash中下载的映射地址不同时，指示Flash下载地址。
   
4. rel_offset -- 作用与abs_offset类似，但是指示链接地址与下载地址间的偏移，可正可负。
   
5. flash_base -- Flash在芯片内存中的映射基地址，会覆盖.flash文件中同名参数。
   
6. args       -- 传入下载算法FlashInit()函数，类argc/argv格式。

复制代码

2.2 .flash文件代码分析
.flash就是flash描述文件了，这些信息最终会提供给调试器。让我们继续分析 FlashIMXRT600_EVK_FLEXSPI.flash 文件中那些模板代码的含义：.flash文件里最多有如下12个参数（其中前四个参数是必须的，其他是可选）：

1. exe        -- 指示下载算法文件(.out)路径。
   
2. flash_base -- Flash在芯片内存中的映射基地址。
   
3. page       -- Flash的页大小。
   
4. block      -- Flash的块数量及大小。
   
5. gap        -- 标示Flash中块的无效区间，C-SPY会检查并返回错误。
   
6. macro      -- 指示预加载文件(.mac)路径。
   
7. online     -- 指示下载算法是否支持Flash断点。
   
8. filler     -- 下载时的padding内容，默认255(0xFF).
   
9. checks     -- 设为0则强制检查下载算法中函数（比如FlashWrite)的返回值，不启用这些检查能提升下载性能。
   
10. aggregate  -- 如果Flash块大小明显小于RAM缓冲区，该参数设为1，可指示C-SPY高效使用RAM缓冲区去下载（比如将多个block数据放到RAM缓冲区）。
    
11. args       -- 传入下载算法FlashInit()函数，类argc/argv格式。
    
12. args_doc   -- args参数的描述字段（IDE里会显示）。

复制代码

2.3 使用下载算法
随便打开一个i.MXRT600 SDK工程，在工程Option里找到Debugger，然后进入Flashloader配置，在界面里你可以看到前面介绍的.board和.flash文件，以及可以直接设置这些xml文件里的部分参数。如果安装的Flash下载算法文件不适用你的板子，那么你需要自己提供合适的算法文件(.out)，并修改.flash文件里相应路径以及参数即可。

三、NOR Flash下载算法设计
IAR下Flash下载算法是开源的，\IAR Systems\Embedded Workbench 8.50.6\arm\doc\FlashLoaderGuide.ENU.pdf 文档有非常详细的介绍，篇幅不长，只有47页，建议全部读一遍。


3.1 下载算法模板工程
IAR提供了一个Flash下载算法的基础模板，可从官网下载，也可以在IAR安装目录下找到，这个模板只是通用的算法源文件，没有相应模板工程，并且源文件只是算法框架，没有具体芯片相关的Flash驱动实现。

1. 模板官网下载：https://files.iar.com/public/cmsis/IAR_flashloader_framework_200.zip
   
2. IAR下模板路径：\IAR Systems\Embedded Workbench 8.50.6\arm\src\flashloader\framework2

复制代码

该算法基础模板包含四个文件，我们需要根据模板源文件创建具体目标芯片的算法工程，然后将flash_loader.h里声明的算法API函数根据芯片去具体实现。

1. \IAR\arm\src\flashloader\framework2\flash_loader.c
   
2. \IAR\arm\src\flashloader\framework2\flash_loader.h
   
3. \IAR\arm\src\flashloader\framework2\flash_loader_asm.s
   
4. \IAR\arm\src\flashloader\framework2\flash_loader_extra.h

复制代码

算法总共定义了如下5个API函数，其中关于初始化以及擦写的API函数（FlashInit、FlashWrite、FlashErase）是必须要实现的，另外两个是可选的。

其实在IAR安装目录下也提供了生成最终算法文件的IAR工程，我们可以直接在这个工程基础上修改生成新算法文件。i.MXRT系列有四个算法源工程。

3.2 下载算法结构设计
算法本身结构相比MDK下算法设计相对来说稍微复杂一点，仅以FlashInit相关的代码来介绍。flash_loader_asm.s文件中定义了FlashInitEntry()入口，这个入口是直接由调试器来调用的。

1. ;---------------------------------
   
2. ; FlashInitEntry()
   
3. ;---------------------------------
   
4.         SECTION .text:CODE:ROOT(2)
   
5.         THUMB
   
6. 
   
7. FlashInitEntry:
   
8.         BL       Fl2FlashInitEntry
   
9.         BL       FlashBreak

复制代码

FlashInitEntry()函数功能非常简单，主要就是跳转到Fl2FlashInitEntry()函数中，这个Fl2FlashInitEntry()函数原型在flash_loader.c文件中。Fl2FlashInitEntry()还是只是个架子，其主要是将theFlashParams全局变量的一些Flash属性相关内容传入最关键的也是由用户来实现的FlashInit()函数。theFlashParams内容由调试器根据xml文件中设置来初始化。


FlashInit()函数有两个版本，__argc和__argv参数可带也可不带，实际上这个可选参数就是为i.MXRT系列单独加的，主要用于传递外接Flash的信息（比如2.3节图片里的 --MxicOct ）。其余两个重要函数FlashWrite、FlashErase与FlashInit代码结构类似，不予赘述。

1. // parameter passing structure
   
2. typedef struct {
   
3.   uint32_t base_ptr;
   
4.   uint32_t count;
   
5.   uint32_t offset_into_block;
   
6.   void *buffer;
   
7.   uint32_t block_size;
   
8. } FlashParamsHolder;
   
9. 
   
10. __root __no_init FlashParamsHolder  theFlashParams;
    
11. 
    
12. __no_init int __argc;
    
13. __no_init char __argvbuf[MAX_ARG_SIZE];
    
14. #pragma required=__argvbuf
    
15. __no_init const char* __argv[MAX_ARGS];
    
16. 
    
17. void Fl2FlashInitEntry()
    
18. {
    
19. #if USE_ARGC_ARGV
    
20.   theFlashParams.count = FlashInit((CODE_REF)theFlashParams.base_ptr,
    
21.                                    theFlashParams.block_size,       // Image size
    
22.                                    theFlashParams.offset_into_block,// link adr
    
23.                                    theFlashParams.count,            // flags
    
24.                                    __argc,
    
25.                                    __argv);
    
26. #else
    
27.   theFlashParams.count = FlashInit((CODE_REF)theFlashParams.base_ptr,
    
28.                                    theFlashParams.block_size,       // Image size
    
29.                                    theFlashParams.offset_into_block,// link adr
    
30.                                    theFlashParams.count);           // flags
    
31. #endif
    
32. }

复制代码

让我们再打开FlashIMXRT1060_FlexSPI示例算法工程，可以看到这个工程既包含了算法基础模板源文件，也包含了用户实现的i.MXRT1060的FlexSPI驱动。关于这个工程，有一个跟MDK下算法工程比较大的区别就是，IAR算法工程并没有启用位置无关的编译，它更接近标准的嵌入式应用程序工程。

3.3 下载算法API调用流程
\IAR Systems\Embedded Workbench 8.50.6\arm\doc\FlashLoaderGuide.ENU.pdf 文档的 The IAR Flash Loader process 小节里对于下载算法调用过程有详细解释。痞子衡将其简要整理在了下面这张图里：

至此，IAR开发环境下i.MXRT的串行NOR Flash下载算法设计痞子衡便介绍完毕了，掌声在哪里~~~

阅读全文