痞子衡嵌入式：恩智浦i.MX RT1xxx系列MCU硬件那些事（2.5）- 串行NOR Flash下載算法(IAR EWARM篇)

---

　　你們好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給你們介紹的是IAR開發環境下i.MXRT的串行NOR Flash下載算法設計。

　　在i.MXRT硬件那些事系列之《在串行NOR Flash XIP調試原理》一文中，痞子衡簡單提了一下串行NOR Flash下載算法的概念，並無介紹具體設計細節，關於NOR Flash下載算法每一個IDE都有本身的一套設計，雖然基本設計理念是同樣的，可是細節方面仍是有區別。在前面的文章裏，痞子衡分別介紹過《J-Link下算法設計》、《Keil MDK下算法設計》，今天痞子衡就來細聊IAR下的NOR Flash下載算法：

1、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包便可。

2、爲當前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文件就是真正的下載算法可執行文件。

\arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.board
\arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.flash
\arm\config\flashloader\NXP\FlashIMXRT600_EVK_FLEXSPI.mac
\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參數是必須的，其餘是可選）：

loader     -- 指示.flash文件路徑。
range      -- Flash在芯片內存中的映射空間範圍。
abs_offset -- 當被下載的app連接地址與往Flash中下載的映射地址不一樣時，指示Flash下載地址。
rel_offset -- 做用與abs_offset相似，可是指示連接地址與下載地址間的偏移，可正可負。
flash_base -- Flash在芯片內存中的映射基地址，會覆蓋.flash文件中同名參數。
args       -- 傳入下載算法FlashInit()函數，類argc/argv格式。

2.2 .flash文件代碼分析

　　.flash就是flash描述文件了，這些信息最終會提供給調試器。讓咱們繼續分析 FlashIMXRT600_EVK_FLEXSPI.flash 文件中那些模板代碼的含義：.flash文件裏最多有以下12個參數（其中前四個參數是必須的，其餘是可選）：

exe        -- 指示下載算法文件(.out)路徑。
flash_base -- Flash在芯片內存中的映射基地址。
page       -- Flash的頁大小。
block      -- Flash的塊數量及大小。
gap        -- 標示Flash中塊的無效區間，C-SPY會檢查並返回錯誤。
macro      -- 指示預加載文件(.mac)路徑。
online     -- 指示下載算法是否支持Flash斷點。
filler     -- 下載時的padding內容，默認255(0xFF).
checks     -- 設爲0則強制檢查下載算法中函數（好比FlashWrite)的返回值，不啓用這些檢查能提高下載性能。
aggregate  -- 若是Flash塊大小明顯小於RAM緩衝區，該參數設爲1，可指示C-SPY高效使用RAM緩衝區去下載（好比將多個block數據放到RAM緩衝區）。
args       -- 傳入下載算法FlashInit()函數，類argc/argv格式。
args_doc   -- args參數的描述字段（IDE裏會顯示）。

2.3 使用下載算法

　　隨便打開一個i.MXRT600 SDK工程，在工程Option裏找到Debugger，而後進入Flashloader配置，在界面裏你能夠看到前面介紹的.board和.flash文件，以及能夠直接設置這些xml文件裏的部分參數。若是安裝的Flash下載算法文件不適用你的板子，那麼你須要本身提供合適的算法文件(.out)，並修改.flash文件裏相應路徑以及參數便可。

3、NOR Flash下載算法設計

　　IAR下Flash下載算法是開源的，\IAR Systems\Embedded Workbench 8.50.6\arm\doc\FlashLoaderGuide.ENU.pdf 文檔有很是詳細的介紹，篇幅不長，只有47頁，建議所有讀一遍。

3.1 下載算法模板工程

　　IAR提供了一個Flash下載算法的基礎模板，可從官網下載，也能夠在IAR安裝目錄下找到，這個模板只是通用的算法源文件，沒有相應模板工程，而且源文件只是算法框架，沒有具體芯片相關的Flash驅動實現。

• 模板官網下載：https://files.iar.com/public/cmsis/IAR_flashloader_framework_200.zip
• IAR下模板路徑：\IAR Systems\Embedded Workbench 8.50.6\arm\src\flashloader\framework2

　　該算法基礎模板包含四個文件，咱們須要根據模板源文件建立具體目標芯片的算法工程，而後將flash_loader.h裏聲明的算法API函數根據芯片去具體實現。

\IAR\arm\src\flashloader\framework2\flash_loader.c
\IAR\arm\src\flashloader\framework2\flash_loader.h
\IAR\arm\src\flashloader\framework2\flash_loader_asm.s
\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()入口，這個入口是直接由調試器來調用的。

;---------------------------------
; FlashInitEntry()
;---------------------------------
        SECTION .text:CODE:ROOT(2)
        THUMB

FlashInitEntry:
        BL       Fl2FlashInitEntry
        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代碼結構相似，不予贅述。

// parameter passing structure
typedef struct {
  uint32_t base_ptr;
  uint32_t count;
  uint32_t offset_into_block;
  void *buffer;
  uint32_t block_size;
} FlashParamsHolder;

__root __no_init FlashParamsHolder  theFlashParams;

__no_init int __argc;
__no_init char __argvbuf[MAX_ARG_SIZE];
#pragma required=__argvbuf
__no_init const char* __argv[MAX_ARGS];

void Fl2FlashInitEntry()
{
#if USE_ARGC_ARGV
  theFlashParams.count = FlashInit((CODE_REF)theFlashParams.base_ptr,
                                   theFlashParams.block_size,       // Image size
                                   theFlashParams.offset_into_block,// link adr
                                   theFlashParams.count,            // flags
                                   __argc,
                                   __argv);
#else
  theFlashParams.count = FlashInit((CODE_REF)theFlashParams.base_ptr,
                                   theFlashParams.block_size,       // Image size
                                   theFlashParams.offset_into_block,// link adr
                                   theFlashParams.count);           // flags
#endif
}

　　讓咱們再打開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下載算法設計痞子衡便介紹完畢了，掌聲在哪裏~~~

歡迎訂閱

文章會同時發佈到個人 博客園主頁、CSDN主頁、知乎主頁、微信公衆號 平臺上。

微信搜索"痞子衡嵌入式"或者掃描下面二維碼，就能夠在手機上第一時間看了哦。