printf()是如何與UART外設(shè)驅(qū)動函數(shù)“勾搭”起來的？
大家好，我是痞子衡，是正經(jīng)搞技術(shù)的痞子。今天痞子衡給大家分享的是IAR下調(diào)試信息輸出機(jī)制之硬件UART外設(shè)。
在嵌入式世界里，輸出打印信息是一種非常常用的輔助調(diào)試手段，借助打印信息，我們可以比較容易地定位和分析程序問題。在嵌入式應(yīng)用設(shè)計(jì)里實(shí)現(xiàn)打印信息輸出的方式有很多，本系列將以 IAR 環(huán)境為例逐一介紹 ARM Cortex-M 內(nèi)核 MCU 下打印信息輸出方法。
本篇是第一篇，我們先介紹最常見的輸出打印信息方式，即利用 MCU 芯片內(nèi)的硬件 UART 外設(shè)。本篇其實(shí)并不是要具體介紹 UART 外設(shè)模塊使用方法，而是重點(diǎn)分析 IAR 下是如何聯(lián)系 C 標(biāo)準(zhǔn)頭文件 stdio.h 定義的 printf() 函數(shù)與 UART 外設(shè)底層驅(qū)動函數(shù)的。
- Note：本文使用的 IAR EWARM 軟件版本是 v9.10.2。
一、打印輸出整體框圖
首先簡介下本文介紹的打印輸出方法整體軟硬件框圖，硬件上主要是 PC 主機(jī)、MCU 目標(biāo)板、一根連接線（連接線有兩種方案：一種是 RS232 串口線、另一種是 TTL 串口轉(zhuǎn) USB 模塊板）。
軟件上 PC 這邊需要安裝一個(gè)串口調(diào)試助手軟件，然后目標(biāo)板 MCU 應(yīng)用程序需要包含打印輸出相關(guān)代碼，當(dāng) MCU 程序運(yùn)行起來后，驅(qū)動片內(nèi) UART 外設(shè)實(shí)現(xiàn)打印字符數(shù)據(jù) (hello world.) 物理傳輸，在 PC 上串口調(diào)試助手軟件里可以看到打印信息。
上圖里的 MCU 應(yīng)用程序是在 IAR 環(huán)境下編譯鏈接的，因此我們的重點(diǎn)就是 stdio.h 頭文件里的 printf() 在 IAR 下到底是如何與 UART 外設(shè)驅(qū)動函數(shù)“勾搭”起來的。
二、C 標(biāo)準(zhǔn)頭文件 stdio.h
熟悉嵌入式工程的朋友應(yīng)該都知道 stdio.h 頭文件并不在用戶工程文件夾里，無需我們手動添加該文件進(jìn)工程目錄，該文件是 C 標(biāo)準(zhǔn)定義的頭文件，由工具鏈自動提供。
stdio.h 是 C 語言為輸入輸出提供的標(biāo)準(zhǔn)庫頭文件，其前身是邁克·萊斯克 20 世紀(jì) 70 年代編寫的“可移植輸入輸出程序庫”。C 語言中的所有輸入和輸出都由抽象的字節(jié)流來完成，對文件的訪問也通過關(guān)聯(lián)的輸入或輸出流進(jìn)行。
- stdio.h 原型：https://cplusplus.com/reference/cstdio/
大部分人學(xué) C 語言一般都是在 Visual Studio / C++ 環(huán)境下，在這個(gè)環(huán)境里 stdio.h 定義的那些函數(shù)底層實(shí)現(xiàn)都由 Visual Studio 軟件直接搞定，我們通常無需關(guān)心其實(shí)現(xiàn)細(xì)節(jié)。
在嵌入式 IAR 環(huán)境下，這些標(biāo)準(zhǔn) C 定義的頭文件大部分也都是可以被支持的，我們可以在如下 IAR 軟件目錄找到它們，當(dāng)我們在工程代碼里加入 #include
\IAR Systems\Embedded Workbench 9.10.2\arm\inc\c\stdio.h
但是 IAR 目錄下 stdio.h 文件里定義的諸如 printf() 函數(shù)具體實(shí)現(xiàn)我們是需要關(guān)注的，畢竟是要編譯鏈接生成具體機(jī)器碼下載進(jìn) MCU 運(yùn)行的，但是 printf() 函數(shù)原型在哪呢？我們先留個(gè)懸念。
三、UART 外設(shè)驅(qū)動函數(shù)
說到 UART 外設(shè)驅(qū)動函數(shù)，這個(gè)大家應(yīng)該再熟悉不過了。我們以恩智浦 i.MXRT1060 型號（ARM Cortex-M7 內(nèi)核）為例來具體介紹，在其官方 SDK 包里有相應(yīng)的 LPUART 驅(qū)動文件：
\SDK_2.11.0_EVK-MIMXRT1060\devices\MIMXRT1062\drivers\fsl_lpuart.h \SDK_2.11.0_EVK-MIMXRT1060\devices\MIMXRT1062\drivers\fsl_lpuart.c
這個(gè) LPUART 驅(qū)動庫里的 LPUART_WriteBlocking() 和 LPUART_ReadBlocking() 函數(shù)可以完成用戶數(shù)據(jù)包的發(fā)送和接收，其實(shí)單純利用 LPUART_WriteBlocking() 函數(shù)也可以實(shí)現(xiàn)打印信息輸出，只是沒有 printf() 函數(shù)那樣包含格式化輸出的強(qiáng)大功能。
status_t LPUART_Init(LPUART_Type *base, const lpuart_config_t *config, uint32_t srcClock_Hz) status_t LPUART_WriteBlocking(LPUART_Type *base, const uint8_t *data, size_t length) status_t LPUART_ReadBlocking(LPUART_Type *base, uint8_t *data, size_t length)
四、IAR 對 C 標(biāo)準(zhǔn) I/O 庫的支持
IAR 顯然是對 C 標(biāo)準(zhǔn) I/O 庫有支持的，不然我們不可能在工程里能使用 printf() 函數(shù)，只是這個(gè)支持我們?nèi)绾稳ポp松發(fā)現(xiàn)呢？痞子衡今天教大家一個(gè)方法，就是看工程編譯鏈接后生成的 .map 文件，這個(gè) map 文件里會列出工程里所有函數(shù)的來源。
4.1 引出底層接口 __write()
我們以 \SDK_2.11.0_EVK-MIMXRT1060\boards\evkmimxrt1060\demo_apps\hello_world\iar 工程為例來介紹，需要簡單改造一下工程里 hello_world.c 文件里的 main() 函數(shù)，將原來代碼全部刪掉（原來的打印輸出涉及恩智浦 SDK 封裝，本文沒必要關(guān)心其實(shí)現(xiàn)），只要如下一句打印即可：
#includeint main(void) { printf("hello world.\r\n"); while (1); }
然后注意工程選項(xiàng)里跟 Library 實(shí)現(xiàn)相關(guān)的如下三處設(shè)置。其中 Library 選項(xiàng)配置的是 runtime lib 的功能，有 Normal 和 Full 兩個(gè)選項(xiàng)（可按需選擇）；Printf formatter 選項(xiàng)決定格式化輸出功能細(xì)節(jié)，分 Full、Large、Small、Tiny 四個(gè)選項(xiàng)（可按需選擇）。Library low-level interface implementation 選項(xiàng)決定低層 I/O 實(shí)現(xiàn)，這里我們選 None，即由用戶來實(shí)現(xiàn)。
配置好 Library 后編譯工程會發(fā)現(xiàn)有如下報(bào)錯，根據(jù)這個(gè)報(bào)錯我們可以猜到 dl7M_tln.a 是 IAR 編譯好的 C/C++ 庫，庫里面實(shí)現(xiàn)了 printf() 函數(shù)及其所依賴的 putchar() 函數(shù)，而 puchar() 函數(shù)對外提供了底層 I/O 接口函數(shù)，這個(gè) I/O 函數(shù)名字叫 __write()，它就是需要用戶結(jié)合芯片 UART 外設(shè)去實(shí)現(xiàn)的發(fā)送函數(shù)。
Error[Li005]: no definition for "__write" [referenced from putchar.o(dl7M_tln.a)]
在 IAR 目錄下我們可以找到 dl7M_tln.a 文件路徑，經(jīng)過測試，工程 Library 設(shè)置里 Normal 和 Full 選項(xiàng)其實(shí)就是選 dl7M_tln.a 還是 dl7M_tlf.a 進(jìn)用戶工程去鏈接。
4.2 DLIB底層 I/O 接口設(shè)計(jì)
找到了 __write() 函數(shù)，但是它的原型到底是什么？我們該如何實(shí)現(xiàn)它？這時(shí)候需要去查萬能的 \IAR Systems\Embedded Workbench 9.10.2\arm\doc\EWARM_DevelopmentGuide.ENU 手冊，在里面搜索 __write 字樣可以找到如下設(shè)計(jì)，原來我們在代碼里調(diào)用的 C 標(biāo)準(zhǔn) I/O 接口均是由 IAR 底層預(yù)編譯好的 DLIB 去具體實(shí)現(xiàn)的，這個(gè) DLIB 庫也留下了給用戶實(shí)現(xiàn)的最底層與硬件相關(guān)的接口函數(shù)。
IAR 為 DLIB 里那些最底層的 I/O 接口函數(shù)都創(chuàng)建了模板源文件，在這些模板文件里我們可以找到它們的原型，所以我們在 write.c 文件里找到了 __write() 原型及其示例實(shí)現(xiàn)。
size_t __write(int handle, const unsigned char * buffer, size_t size)
4.3 DLIB庫 I/O 相關(guān)源碼實(shí)現(xiàn)
有了 __write() 原型及示例代碼，我們很容易便能用 LPUART_WriteBlocking() 函數(shù)去實(shí)現(xiàn)它，將這個(gè)代碼添加進(jìn) hello_world 工程編譯，這時(shí)候就不會報(bào)錯了（當(dāng)然要想真正在板子上測試打印功能，main 函數(shù)里還得加入 LPUART 初始化代碼）。
#include "fsl_lpuart.h" size_t __write(int handle, const unsigned char *buf, size_t size) { // 假設(shè)使用 LPUART1 去做輸出 (void)LPUART_WriteBlocking(LPUART1, buf, size); return 0; }
工程編譯完成后，查看生成的 hello_world.map 文件，找到 dl7M_tln.a 部分的信息，可以看到其由很多個(gè) .o 文件組成（功能比較豐富），這些 .o 文件都是可以在 IAR 安裝目錄下找到其源碼的。
*******************************************************************************
*** MODULE SUMMARY
***
Module ro code ro data rw data
------ ------- ------- -------
dl7M_tln.a: [10]
abort.o 6
exit.o 4
low_level_init.o 4
printf.o 40
putchar.o 32
xfail_s.o 64 4
xprintfsmall_nomb.o 1'281
xprout.o 22
-----------------------------------------------
Total: 1'453 4
DLIB 庫中關(guān)于 I/O 相關(guān)的源碼放在了如下目錄里，感興趣的可以去查看其具體實(shí)現(xiàn)，這里特別提一下 formatter 文件夾下 xprintf 有很多種不同的源文件實(shí)現(xiàn)，其實(shí)就對應(yīng)了工程選項(xiàng) Printf formatter 里的不同配置。
\IAR Systems\Embedded Workbench 9.10.2\arm\src\lib\dlib\file \IAR Systems\Embedded Workbench 9.10.2\arm\src\lib\dlib\formatters
至此，IAR下調(diào)試信息輸出機(jī)制之硬件UART外設(shè)痞子衡便介紹完畢了，掌聲在哪里~~~
下載文檔
