痞子衡嵌入式：恩智浦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下載演算法：

一、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檔案就是真正的下載演算法可執行檔案。

\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檔案裡相應路徑以及引數即可。

三、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演算法工程並沒有啟用位置無關的編譯，它更接近標準的嵌入式應用程式工程。