痞子衡嵌入式：IAR內部C-SPY除錯組件配套宏檔案(.mac)用法介紹

　　大家好，我是痞子衡，是正經搞技術的痞子，今天痞子衡給大家分享的是IAR內部C-SPY除錯組件配套宏檔案(.mac)用法，

　　痞子衡之前寫過一篇 《JLink Script檔案基礎及其在IAR下呼叫方法》，那篇文章介紹了 J-Link 硬體除錯器配套的 .JLinkScript 檔案功能及用法，今天我們要講的主角 .mac 檔案之于 IAR 內部 C-SPY 除錯組件的作用就像 .JLinkScript 之于 J-Link 除錯器的作用一樣，.mac 檔案也是為了完成在 IAR 下的特殊除錯需求而存在的，

一、C-SPY宏(macros)作用

　　我們知道在 IAR 開發環境下負責綜合調度外部硬體除錯器與芯片內部除錯模塊來完成用戶實際除錯需求的組件是 C-SPY，有了 C-SPY，你才可以愉快地在 IAR 里進行單步除錯、打斷點等操作，

　　宏檔案(.mac)是 C-SPY 組件定義和解釋執行的一種專用類腳本檔案，它的語法比較像 C 語言，但本質上是一種腳本語言，由 CSpyBat.exe 在用戶除錯的程序中解釋執行，

\IAR Systems\Embedded Workbench 9.10.2\common\bin\CSpyBat.exe

　　宏檔案的功能主要有以下 5 點，其中第 2 點配置板級硬體是最常用的功能，比如你想在板載外部 SDRAM 里直接除錯工程代碼執行，但是除錯組件在下載程式進 SDRAM 之前需要一個已經初始化好的 SDRAM，這個 SDRAM 初始化作業就可以由宏檔案來完成（當然修改 IDE flashloader 去完成也是一種可選方法），

1. 除錯流程自動化，例如跟蹤列印輸出，列印變數值，設定斷點，
2. 配置板級硬體，例如初始化硬體暫存器、初始化外存， 
3. 在運行時為應用程式提供模擬資料，
4. 模擬外圍設備（只適用于使用模擬器驅動程式的情況）
5. 開發小的除錯工具函式，例如計算堆疊深度，參見示例 \arm\src\sim\stack.mac

二、C-SPY宏檔案基礎

　　C-SPY 宏檔案這一套東西整體上由三大部分組成：基本語法、預定義系統宏函式、保留 setup 宏函式，

2.1 宏檔案基礎語法

　　C-SPY 宏語言并不是一個通用的腳本語言，因此其并不像你熟知的那些 Python 之類的腳本語言那樣語法完善，它僅是為了配合 C-SPY 完成一些必要操作，C-SPY 宏語法跟 C 語言類似，支持 C 語言中允許的大多數陳述句(if else，while，變數宣告，…)，但不是所有的陳述句，

• 全部語法： \IAR Systems\Embedded Workbench 9.10.2\arm\doc\EWARM_DebuggingGuide.ENU 手冊里的 BRIEFLY ABOUT THE MACRO LANGUAGE 章節

　　下面是一個典型的用戶自定義 C-SPY 宏函式示例（設定地址 0x400D403C 處暫存器的值），涉及的語法包括函式定義（支持引數和回傳值），變數定義（統一為 __var 型別）， 邏輯運算式， do while 陳述句，系統宏函式呼叫（加 __ 前綴），掌握示例函式里的語法基本就足夠使用宏檔案功能了，

// 定義函式，無參，默認回傳值 0（預設）
Peripheral_WaitSetDone()
{
    // 定義 reg 變數
    __var reg;
    do
    {
        // 讀取 0x400D403C 地址處的值 (32bit)
        reg = __readMemory32(0x400D403C, "Memory");
        // 延時 10 ms
        __delay(10);
    // 判斷 reg[1:0] 是否為 0
    }while((reg & 0x3) == 0);

    // 將 0x3 寫入 0x400D403C 地址處
    __writeMemory32(0x00000003, 0x400D403C, "Memory");

    // 輸出資訊到 IAR 除錯視窗
    __message "Message: Peripheral Reg Set Done\n";
}

2.2 預定義系統宏功能

　　C-SPY 宏體系里實作了很多基礎操作功能，這些功能通過 API 函式介面形式開放給用戶宏函式來呼叫，這些 API 全部以 __ 為前綴，大約有 100 多個 API，下面列舉出最常用的一些宏 API：

• 全部系統宏 API： \IAR Systems\Embedded Workbench 9.10.2\arm\doc\EWARM_DebuggingGuide.ENU 手冊里的 Summary of system macros 表

2.3 保留setup宏函式

　　終于要講到 C-SPY 宏最關鍵的部分了，前面都是基礎，而 C-SPY 宏最核心的功能其實在保留 setup 宏函式里，這些 setup 宏函式由 C-SPY 預先定義，但是內部具體操作可由用戶來撰寫，在 IAR 在線下載除錯程序中按規定觸發條件來呼叫執行這些函式，setup 宏函式里最常用的是 execUserPreload()：

三、宏檔案在IAR下使用方法

　　宏檔案在 IAR 下主要有兩種呼叫執行方式，一種是由 C-SPY 在除錯程序中自動執行（要借助保留 setup 宏函式），另一種是用戶手動指定執行（此時可以不用保留 setup 宏函式）：

3.1 在線除錯時C-SPY自動執行

　　不管是哪種呼叫方式，用戶都需要首先準備一個宏檔案(.mac)，然后在 IAR 工程選項 Debugger / Setup / Setup macros 里勾選 Use macro file(s)，并且指定宏檔案路徑，

　　我們以恩智浦軟體包 \SDK_2.11.0_MIMXRT1170-EVK\boards\evkmimxrt1170\demo_apps\hello_world\cm7\iar 工程為例，在這個路徑下創建一個測驗用的 evkmimxrt1170_connect_cm7_test.mac 檔案，并且將其指定為工程宏檔案，

　　在這個測驗用的 .mac 檔案里定義全部 13 個保留 setup 函式，函式體內不需要真實內容，只有下面這樣的一句列印資訊即可，便于我們在 IAR 除錯資訊視窗觀察其有沒有被 C-SPY 呼叫執行，

execUserPreload()
{
    __message "--------execUserPreload() is called";;
}

　　然后在 MIMXRT1170-EVK 板上借助板載 DAP-Link 除錯器直接下載 RAM build 版本工程（即不涉及 flashloader），除錯器復位型別為 Software，下面是 IAR 除錯資訊視窗的輸出，從結果里看除了 ETM/SWO 相關 setup 宏函式和 flashloader 相關 setup 宏函式未被執行外，其余 setup 宏函式均如預期執行了：

1.  用戶點擊 IAR 在線除錯按鈕，啟動 C-SPY
2.  C-SPY 嘗試呼叫 flashloader，但無資料需下載進Flash
3.  C-SPY 預加載用戶宏檔案 evkmimxrt1170_connect_cm7_test.mac
4.  C-SPY 與硬體除錯器（DAP-Link）建立了連接
5.    execUserCoreConnect() 被執行
6.  C-SPY 連接上了芯片內核
7.    execUserPreReset() 被執行
8.  C-SPY 嘗試執行軟體復位（可能此處未執行成功）
9.    execUserPreload() 被執行
10. C-SPY 將工程應用程式 hello_world_demo_cm7.out 下載進芯片內部 RAM
11.   execUserPreReset() 被執行
12. C-SPY 執行了軟體復位，芯片復位成功
13.   execUserReset() 被執行
14. C-SPY 與芯片除錯模塊ETM互動
15.   execUserSetup() 被執行
16.   execUserExecutionStarted() 被執行
17. C-SPY 接管除錯，斷點停在 main 函式
18.   execUserExecutionStopped() 被執行
19. 用戶點擊結束 IAR 在線除錯
20.   execUserExit() 被執行

　　同樣的實驗在 Flash build 版本工程（即涉及 flashloader）上再做一次，除錯器復位型別也為 Software，結果如下，此時結果與 RAM build 差異較大，因為默認 flashloader 配套 FlashIMXRT1170_FlexSPI.mac 檔案也加入了戰斗，我們測驗用的 evkmimxrt1170_connect_cm7_test.mac 檔案是在應用程式下載進 Flash 之后才出場的（記住這里的順序，非常重要，痞子衡后面會另寫文章著重介紹），因此這個測驗用的 .mac 檔案里的 flashloader 相關宏函式根本派不上用場：

1.  用戶點擊 IAR 在線除錯按鈕，啟動 C-SPY
2.  C-SPY 預加載 flashloader 配套宏檔案 FlashIMXRT1170_FlexSPI.mac（里面僅定義了execUserFlashInit ）
3.  C-SPY 與硬體除錯器（DAP-Link）建立了連接
4.  C-SPY 連接上了芯片內核
5.  C-SPY 嘗試執行軟體復位（可能此處未執行成功）
6.    execUserFlashInit() 被執行 - 來自 FlashIMXRT1170_FlexSPI.mac
7.  C-SPY 將 flashloader 加載進芯片內部 RAM
8.  C-SPY 借助 flashloader 將工程應用程式 hello_world_demo_cm7.out 下載進板載外部 Flash
9.  C-SPY 預加載用戶宏檔案 evkmimxrt1170_connect_cm7_test.mac
10.   execUserPreload() 被執行
11. C-SPY 完成 Flash 下載的資料校驗
12.   execUserPreReset() 被執行
13. C-SPY 執行了軟體復位，芯片復位成功
14.   execUserReset() 被執行
15. C-SPY 與芯片除錯模塊ETM互動
16.   execUserSetup() 被執行
17.   execUserExecutionStarted() 被執行
18. C-SPY 接管除錯，斷點停在 main 函式
19.   execUserExecutionStopped() 被執行
20. 用戶點擊結束 IAR 在線除錯
21.   execUserExit() 被執行

3.2 自定義條件觸發或Watch視窗里手動指定執行

　　宏檔案的自定義觸發或者手動呼叫方式主要跟深入除錯有關，用于除錯程序中的特殊需求，麥克泰寫的一篇文章 《C-SPY setup macro file 的作用》 里給的兩個示例就挺有參考意義的，比如我們可以在 IAR 的 Quick Watch 視窗手動填入 .mac 檔案里宏函式，并單擊執行，這時可在 IAR 除錯資訊視窗實時看到執行結果，

　　至此，IAR內部C-SPY除錯組件配套宏檔案(.mac)用法痞子衡便介紹完畢了，掌聲在哪里~~~

歡迎訂閱

文章會同時發布到我的 博客園主頁、CSDN主頁、知乎主頁、微信公眾號 平臺上，

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

  最后歡迎關注痞子衡個人微信公眾號【痞子衡嵌入式】，一個專注嵌入式技術的公眾號，跟著痞子衡一起玩轉嵌入式，

  衡杰(痞子衡)，目前就職于恩智浦MCU系統部門，擔任嵌入式系統應用工程師，

  專欄內所有文章的轉載請注明出處：http://www.cnblogs.com/henjay724/

  與痞子衡進一步交流或咨詢業務合作請發郵件至 [email protected]

  可以關注痞子衡的Github主頁 https://github.com/JayHeng，有很多好玩的嵌入式專案，

  關于專欄文章有任何疑問請直接在博客下面留言，痞子衡會及時回復免費(劃重點)答疑，

  痞子衡郵箱已被私信擠爆，技術問題不推薦私信，堅持私信請先掃碼付款(5元起步)再發，

標籤：其他

上一篇：什么？Android上面跑Linux？

下一篇：使用StringFormat將時間戳（長型別）從XAML轉換為日期和時間