芯耀
1281
在i.MXRT硬件那些事系列之《在串行NOR Flash XIP調(diào)試原理》一文中，痞子衡簡單提了一下串行NOR Flash下載算法的概念，并沒有介紹具體設(shè)計細(xì)節(jié)，關(guān)于NOR Flash下載算法每個IDE都有自己的一套設(shè)計，雖然基本設(shè)計理念是一樣的，但是細(xì)節(jié)方面還是有區(qū)別。在前面的文章里，痞子衡分別介紹過《J-Link下算法設(shè)計》、《Keil MDK下算法設(shè)計》，今天痞子衡就來細(xì)聊IAR下的NOR Flash下載算法：
1.IAR各版本對i.MXRT的支持
IAR跟Keil一樣都是非常經(jīng)典的MCU開發(fā)IDE，可以說是難分伯仲，痞子衡求學(xué)期間就用IAR開發(fā)過MSP430單片機(jī)，但是只是淺嘗輒止，因為搞ARM Cortex-M就切換到更熟悉的Keil下了，直到畢業(yè)后加入恩智浦才一直在用IAR。這么多年過去了，IAR還是當(dāng)初那個獨立小公司，沒有被收購，而且依然保持競爭力，這一波RISC-V浪潮估計會讓它超越被ARM束縛的Keil。
從IAR官網(wǎng)上看，目前最新的IAR EWARM版本是v8.50.6，其能夠支持目前所有已量產(chǎn)的i.MXRT系列。如果你安裝的不是最新版本，比如安裝了v8.40，從 IAR歷史各版本Release Note 上看，v8.40版本不支持RT500和RT600，那么如果想要支持新芯片（比如RT600），是不是一定要重新安裝最新IAR呢？其實未必！
IAR對新MCU型號的支持并不是與自身版本嚴(yán)格綁定的，其增加新芯片的方式很靈活，只需要按要求打上相應(yīng)芯片的patch包即可。
2.為當(dāng)前IAR增加新i.MXRT型號支持
在 IAR歷史各版本Release Note 頁面點擊 8.50 進(jìn)入這個版本的專屬頁面，往下翻你會找到專門的i.MXRT600 patch包，直接下載這個包(ewarm850-nxp-imxrt5xx-6xx-patch4.zip文件)。
有了patch包之后，打patch就相當(dāng)簡單了，直接將ewarm850-nxp-imxrt5xx-6xx-patch4.zip包解壓放到IAR安裝目錄下即可，patch包的文件目錄結(jié)構(gòu)與IAR下安裝目錄結(jié)構(gòu)是一樣的。
patch包里的文件很多，其中跟下載算法相關(guān)的一共如下四個文件：.board和.flash是xml文件，其功能類似JLink下的JLinkDevices.xml文件。.mac是預(yù)加載文件，功能類似JLink下的.JLinkScript文件，.out文件就是真正的下載算法可執(zhí)行文件。
armconfigflashloaderNXPFlashIMXRT600_EVK_FLEXSPI.board
armconfigflashloaderNXPFlashIMXRT600_EVK_FLEXSPI.flash
armconfigflashloaderNXPFlashIMXRT600_EVK_FLEXSPI.mac
armconfigflashloaderNXPFlashIMXRT600_EVK_FLEXSPI.out
兩個xml文件里的代碼含義在 IAR SystemsEmbedded Workbench 8.50.6armdocFlashLoaderGuide.ENU.pdf 文檔的 The flash memory configuration file 和 The flash memory system configuration file 兩小節(jié)里有詳細(xì)解釋。
2.1 .board文件代碼分析
.board顧名思義就是板級描述文件，每個.board文件可以指向多個.flash文件（如果這塊板子存在多塊flash）。讓我們試著分析FlashIMXRT600_EVK_FLEXSPI.board 文件中那些模板代碼的含義：.board文件里可以有多個<pass>塊，每個pass對應(yīng)一種flash類型。在每個<pass>里最多有如下6個參數(shù)（其中l(wèi)oader參數(shù)是必須的，其他是可選）：
loader -- 指示.flash文件路徑。
range -- Flash在芯片內(nèi)存中的映射空間范圍。
abs_offset -- 當(dāng)被下載的app鏈接地址與往Flash中下載的映射地址不同時，指示Flash下載地址。
rel_offset -- 作用與abs_offset類似，但是指示鏈接地址與下載地址間的偏移，可正可負(fù)。
flash_base -- Flash在芯片內(nèi)存中的映射基地址，會覆蓋.flash文件中同名參數(shù)。
args -- 傳入下載算法FlashInit()函數(shù)，類argc/argv格式。
2.2 .flash文件代碼分析
.flash就是flash描述文件了，這些信息最終會提供給調(diào)試器。讓我們繼續(xù)分析 FlashIMXRT600_EVK_FLEXSPI.flash 文件中那些模板代碼的含義：.flash文件里最多有如下12個參數(shù)（其中前四個參數(shù)是必須的，其他是可選）：
exe -- 指示下載算法文件(.out)路徑。
flash_base -- Flash在芯片內(nèi)存中的映射基地址。
page -- Flash的頁大小。
block -- Flash的塊數(shù)量及大小。
gap -- 標(biāo)示Flash中塊的無效區(qū)間，C-SPY會檢查并返回錯誤。
macro -- 指示預(yù)加載文件(.mac)路徑。
online -- 指示下載算法是否支持Flash斷點。
filler -- 下載時的padding內(nèi)容，默認(rèn)255(0xFF).
checks -- 設(shè)為0則強(qiáng)制檢查下載算法中函數(shù)（比如FlashWrite)的返回值，不啟用這些檢查能提升下載性能。
aggregate -- 如果Flash塊大小明顯小于RAM緩沖區(qū)，該參數(shù)設(shè)為1，可指示C-SPY高效使用RAM緩沖區(qū)去下載（比如將多個block數(shù)據(jù)放到RAM緩沖區(qū)）。
args -- 傳入下載算法FlashInit()函數(shù)，類argc/argv格式。
args_doc -- args參數(shù)的描述字段（IDE里會顯示）。
2.3 使用下載算法
隨便打開一個i.MXRT600 SDK工程，在工程Option里找到Debugger，然后進(jìn)入Flashloader配置，在界面里你可以看到前面介紹的.board和.flash文件，以及可以直接設(shè)置這些xml文件里的部分參數(shù)。如果安裝的Flash下載算法文件不適用你的板子，那么你需要自己提供合適的算法文件(.out)，并修改.flash文件里相應(yīng)路徑以及參數(shù)即可。
3.NOR Flash下載算法設(shè)計
IAR下Flash下載算法是開源的，IAR SystemsEmbedded Workbench 8.50.6armdocFlashLoaderGuide.ENU.pdf 文檔有非常詳細(xì)的介紹，篇幅不長，只有47頁，建議全部讀一遍。
3.1 下載算法模板工程
IAR提供了一個Flash下載算法的基礎(chǔ)模板，可從官網(wǎng)下載，也可以在IAR安裝目錄下找到，這個模板只是通用的算法源文件，沒有相應(yīng)模板工程，并且源文件只是算法框架，沒有具體芯片相關(guān)的Flash驅(qū)動實現(xiàn)。
模板官網(wǎng)下載：https://files.iar.com/public/cmsis/IAR_flashloader_framework_200.zip
IAR下模板路徑：IAR SystemsEmbedded Workbench 8.50.6armsrcflashloaderframework2
該算法基礎(chǔ)模板包含四個文件，我們需要根據(jù)模板源文件創(chuàng)建具體目標(biāo)芯片的算法工程，然后將flash_loader.h里聲明的算法API函數(shù)根據(jù)芯片去具體實現(xiàn)。
IARarmsrcflashloaderframework2flash_loader.c
IARarmsrcflashloaderframework2flash_loader.h
IARarmsrcflashloaderframework2flash_loader_asm.s
IARarmsrcflashloaderframework2flash_loader_extra.h
算法總共定義了如下5個API函數(shù)，其中關(guān)于初始化以及擦寫的API函數(shù)（FlashInit、FlashWrite、FlashErase）是必須要實現(xiàn)的，另外兩個是可選的。
其實在IAR安裝目錄下也提供了生成最終算法文件的IAR工程，我們可以直接在這個工程基礎(chǔ)上修改生成新算法文件。i.MXRT系列有四個算法源工程。
3.2 下載算法結(jié)構(gòu)設(shè)計
算法本身結(jié)構(gòu)相比MDK下算法設(shè)計相對來說稍微復(fù)雜一點，僅以FlashInit相關(guān)的代碼來介紹。flash_loader_asm.s文件中定義了FlashInitEntry()入口，這個入口是直接由調(diào)試器來調(diào)用的。
;---------------------------------
; FlashInitEntry()
;---------------------------------
SECTION .text:CODE:ROOT(2)
THUMB
FlashInitEntry:
BL Fl2FlashInitEntry
BL FlashBreak
FlashInitEntry()函數(shù)功能非常簡單，主要就是跳轉(zhuǎn)到Fl2FlashInitEntry()函數(shù)中，這個Fl2FlashInitEntry()函數(shù)原型在flash_loader.c文件中。Fl2FlashInitEntry()還是只是個架子，其主要是將theFlashParams全局變量的一些Flash屬性相關(guān)內(nèi)容傳入最關(guān)鍵的也是由用戶來實現(xiàn)的FlashInit()函數(shù)。theFlashParams內(nèi)容由調(diào)試器根據(jù)xml文件中設(shè)置來初始化。
FlashInit()函數(shù)有兩個版本，__argc和__argv參數(shù)可帶也可不帶，實際上這個可選參數(shù)就是為i.MXRT系列單獨加的，主要用于傳遞外接Flash的信息（比如2.3節(jié)圖片里的 --MxicOct ）。其余兩個重要函數(shù)FlashWrite、FlashErase與FlashInit代碼結(jié)構(gòu)類似，不予贅述。
// 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示例算法工程，可以看到這個工程既包含了算法基礎(chǔ)模板源文件，也包含了用戶實現(xiàn)的i.MXRT1060的FlexSPI驅(qū)動。關(guān)于這個工程，有一個跟MDK下算法工程比較大的區(qū)別就是，IAR算法工程并沒有啟用位置無關(guān)的編譯，它更接近標(biāo)準(zhǔn)的嵌入式應(yīng)用程序工程。
3.3 下載算法API調(diào)用流程
IAR SystemsEmbedded Workbench 8.50.6armdocFlashLoaderGuide.ENU.pdf 文檔的 The IAR Flash Loader process 小節(jié)里對于下載算法調(diào)用過程有詳細(xì)解釋。將其簡要整理在了下面這張圖里：
至此，IAR開發(fā)環(huán)境下i.MXRT的串行NOR Flash下載算法設(shè)計便介紹完畢了
