第11章 GPIO輸出—使用固件庫點亮LED
第11章 GPIO輸出—使用固件庫點亮LED
全套200集視頻教程和1000頁PDF教程請到秉火論壇下載：www.firebbs.cn
野火視頻教程優酷觀看網址：http://i.youku.com/firege
本章參考資料：《STM32F4xx參考手冊》、庫幫助文檔《stm32f4xx_dsp_stdperiph_lib_um.chm》。
利用庫建立好的工程模板，就可以方便地使用STM32標準庫編寫應用程序了，可以說從這一章我們才開始邁入STM32開發的大門。
LED燈的控制使用到GPIO外設的基本輸出功能，本章中不再贅述GPIO外設的概念，如您忘記了，可重讀前面"GPIO框圖剖析"小節，STM32標準庫中GPIO初始化結構體GPIO_TypeDef的定義與"定義引腳模式的枚舉類型"小節中講解的相同。
11.1 硬件設計
本實驗板連接了一個RGB彩燈及一個普通LED燈，RGB彩燈實際上由三盞分別為紅色、綠色、藍色的LED燈組成，通過控制RGB顏色強度的組合，可以混合出各種色彩。
圖 111 LED硬件原理圖
這些LED燈的陰極都是連接到STM32的GPIO引腳，只要我們控制GPIO引腳的電平輸出狀態，即可控制LED燈的亮滅。圖中左上方，其中彩燈的陽極連接到的一個電路圖符號"口口"，它表示引出排針，即此處本身斷開，須通過跳線帽連接排針，把電源跟彩燈的陽極連起來，實驗時需註意。
若您使用的實驗板LED燈的連接方式或引腳不一樣，只需根據我們的工程修改引腳即可，程序的控制原理相同。
11.2 軟件設計
這裏只講解核心部分的代碼，有些變量的設置，頭文件的包含等可能不會涉及到，完整的代碼請參考本章配套的工程。
為了使工程更加有條理，我們把LED燈控制相關的代碼獨立分開存儲，方便以後移植。在"工程模板"之上新建"bsp_led.c"及"bsp_led.h"文件，其中的"bsp"即Board Support Packet的縮寫(板級支持包)，這些文件也可根據您的喜好命名，這些文件不屬於STM32標準庫的內容，是由我們自己根據應用需要編寫的。
11.2.1 編程要點
1. 使能GPIO端口時鐘；
2. 初始化GPIO目標引腳為推挽輸出模式；
3. 編寫簡單測試程序，控制GPIO引腳輸出高、低電平。
11.2.2 代碼分析
1. LED燈引腳宏定義
在編寫應用程序的過程中，要考慮更改硬件環境的情況，例如LED燈的控制引腳與當前的不一樣，我們希望程序只需要做最小的修改即可在新的環境正常運行。這個時候一般把硬件相關的部分使用宏來封裝，若更改了硬件環境，只修改這些硬件相關的宏即可，這些定義一般存儲在頭文件，即本例子中的"bsp_led.h"文件中，見代碼清單111。
代碼清單 111 LED控制引腳相關的宏
1 //引腳定義
2 /*******************************************************/
3 //R 紅色燈
4 #define LED1_PIN GPIO_Pin_10
5 #define LED1_GPIO_PORT GPIOH
6 #define LED1_GPIO_CLK RCC_AHB1Periph_GPIOH
7
8 //G 綠色燈
9 #define LED2_PIN GPIO_Pin_11
10 #define LED2_GPIO_PORT GPIOH
11 #define LED2_GPIO_CLK RCC_AHB1Periph_GPIOH
12
13 //B 藍色燈
14 #define LED3_PIN GPIO_Pin_12
15 #define LED3_GPIO_PORT GPIOH
16 #define LED3_GPIO_CLK RCC_AHB1Periph_GPIOH
17
18 //小指示燈
19 #define LED4_PIN GPIO_Pin_11
20 #define LED4_GPIO_PORT GPIOD
21 #define LED4_GPIO_CLK RCC_AHB1Periph_GPIOD
22 /************************************************************/
以上代碼分別把控制四盞LED燈的GPIO端口、GPIO引腳號以及GPIO端口時鐘封裝起來了。在實際控制的時候我們就直接用這些宏，以達到應用代碼硬件無關的效果。
其中的GPIO時鐘宏"RCC_AHB1Periph_GPIOH"和"RCC_AHB1Periph_GPIOD"是STM32標準庫定義的GPIO端口時鐘相關的宏，它的作用與"GPIO_Pin_x"這類宏類似，是用於指示寄存器位的，方便庫函數使用。它們分別指示GPIOH、GPIOD的時鐘，下面初始化GPIO時鐘的時候可以看到它的用法。
2. 控制LED燈亮滅狀態的宏定義
為了方便控制LED燈，我們把LED燈常用的亮、滅及狀態反轉的控制也直接定義成宏，見代碼清單 112。
代碼清單 112 控制LED亮滅的宏
1
2 /* 直接操作寄存器的方法控制IO */
3 #define digitalHi(p,i) {p->BSRRL=i;} //設置為高電平
4 #define digitalLo(p,i) {p->BSRRH=i;} //輸出低電平
5 #define digitalToggle(p,i) {p->ODR ^=i;} //輸出反轉狀態
6
7
8 /* 定義控制IO的宏 */
9 #define LED1_TOGGLE digitalToggle(LED1_GPIO_PORT,LED1_PIN)
10 #define LED1_OFF digitalHi(LED1_GPIO_PORT,LED1_PIN)
11 #define LED1_ON digitalLo(LED1_GPIO_PORT,LED1_PIN)
12
13 #define LED2_TOGGLE digitalToggle(LED2_GPIO_PORT,LED2_PIN)
14 #define LED2_OFF digitalHi(LED2_GPIO_PORT,LED2_PIN)
15 #define LED2_ON digitalLo(LED2_GPIO_PORT,LED2_PIN)
16
17 #define LED3_TOGGLE digitalToggle(LED3_GPIO_PORT,LED3_PIN)
18 #define LED3_OFF digitalHi(LED3_GPIO_PORT,LED3_PIN)
19 #define LED3_ON digitalLo(LED3_GPIO_PORT,LED3_PIN)
20
21 #define LED4_TOGGLE digitalToggle(LED4_GPIO_PORT,LED4_PIN)
22 #define LED4_OFF digitalHi(LED4_GPIO_PORT,LED4_PIN)
23 #define LED4_ON digitalLo(LED4_GPIO_PORT,LED4_PIN)
24
25
26 /* 基本混色，後面高級用法使用PWM可混出全彩顏色,且效果更好 */
27
28 //紅
29 #define LED_RED \
30 LED1_ON;\
31 LED2_OFF;\
32 LED3_OFF
33
34 //綠
35 #define LED_GREEN \
36 LED1_OFF;\
37 LED2_ON;\
38 LED3_OFF
39
40 //藍
41 #define LED_BLUE \
42 LED1_OFF;\
43 LED2_OFF;\
44 LED3_ON
45
46
47 //黃(紅+綠)
48 #define LED_YELLOW \
49 LED1_ON;\
50 LED2_ON;\
51 LED3_OFF
這部分宏控制LED亮滅的操作是直接向BSRR寄存器寫入控制指令來實現的，對BSRRL寫1輸出高電平，對BSRRH寫1輸出低電平，對ODR寄存器某位進行異或操作可反轉位的狀態。
RGB彩燈可以實現混色，如最後一段代碼我們控制紅燈和綠燈亮而藍燈滅，可混出黃色效果。
代碼中的"\"是C語言中的續行符語法，表示續行符的下一行與續行符所在的代碼是同一行。代碼中因為宏定義關鍵字"#define"只是對當前行有效，所以我們使用續行符來連接起來，以下的代碼是等效的：
#define LED_YELLOW LED1_ON; LED2_ON; LED3_OFF
應用續行符的時候要註意，在"\"後面不能有任何字符(包括註釋、空格)，只能直接回車。
3. LED GPIO初始化函數
利用上面的宏，編寫LED燈的初始化函數，見代碼清單 113。
代碼清單 113 LED GPIO初始化函數
1 /**
2 * @brief 初始化控制LED的IO
3 * @param 無
4 * @retval 無
5 */
6 void LED_GPIO_Config(void)
7 {
8 /*定義一個GPIO_InitTypeDef類型的結構體*/
9 GPIO_InitTypeDef GPIO_InitStructure;
10
11 /*開啟LED相關的GPIO外設時鐘*/
12 RCC_AHB1PeriphClockCmd ( LED1_GPIO_CLK|
13 LED2_GPIO_CLK|
14 LED3_GPIO_CLK|
15 LED4_GPIO_CLK,
16 ENABLE);
17
18 /*選擇要控制的GPIO引腳*/
19 GPIO_InitStructure.GPIO_Pin = LED1_PIN;
20
21 /*設置引腳模式為輸出模式*/
22 GPIO_InitStructure.GPIO_Mode = GPIO_Mode_OUT;
23
24 /*設置引腳的輸出類型為推挽輸出*/
25 GPIO_InitStructure.GPIO_OType = GPIO_OType_PP;
26
27 /*設置引腳為上拉模式*/
28 GPIO_InitStructure.GPIO_PuPd = GPIO_PuPd_UP;
29
30 /*設置引腳速率為2MHz */
31 GPIO_InitStructure.GPIO_Speed = GPIO_Speed_2MHz;
32
33 /*調用庫函數，使用上面配置的GPIO_InitStructure初始化GPIO*/
34 GPIO_Init(LED1_GPIO_PORT, &GPIO_InitStructure);
35
36 /*選擇要控制的GPIO引腳*/
37 GPIO_InitStructure.GPIO_Pin = LED2_PIN;
38 GPIO_Init(LED2_GPIO_PORT, &GPIO_InitStructure);
39
40 /*選擇要控制的GPIO引腳*/
41 GPIO_InitStructure.GPIO_Pin = LED3_PIN;
42 GPIO_Init(LED3_GPIO_PORT, &GPIO_InitStructure);
43
44 /*選擇要控制的GPIO引腳*/
45 GPIO_InitStructure.GPIO_Pin = LED4_PIN;
46 GPIO_Init(LED4_GPIO_PORT, &GPIO_InitStructure);
47
48 /*關閉RGB燈*/
49 LED_RGBOFF;
50
51 /*指示燈默認開啟*/
52 LED4(ON);
53 }
整個函數與"構建庫函數雛形"章節中的類似，主要區別是硬件相關的部分使用宏來代替，初始化GPIO端口時鐘時也采用了STM32庫函數，函數執行流程如下：
(1) 使用GPIO_InitTypeDef定義GPIO初始化結構體變量，以便下面用於存儲GPIO配置。
(2) 調用庫函數RCC_AHB1PeriphClockCmd來使能LED燈的GPIO端口時鐘，在前面的章節中我們是直接向RCC寄存器賦值來使能時鐘的，不如這樣直觀。該函數有兩個輸入參數，第一個參數用於指示要配置的時鐘，如本例中的"RCC_AHB1Periph_GPIOH"和"RCC_AHB1Periph_GPIOD"，應用時我們使用"|"操作同時配置四個LED燈的時鐘；函數的第二個參數用於設置狀態，可輸入"Disable"關閉或"Enable"使能時鐘。
(3) 向GPIO初始化結構體賦值，把引腳初始化成推挽輸出模式，其中的GPIO_Pin使用宏"LEDx_PIN"來賦值，使函數的實現方便移植。
(4) 使用以上初始化結構體的配置，調用GPIO_Init函數向寄存器寫入參數，完成GPIO的初始化，這裏的GPIO端口使用"LEDx_GPIO_PORT"宏來賦值，也是為了程序移植方便。
(5) 使用同樣的初始化結構體，只修改控制的引腳和端口，初始化其它LED燈使用的GPIO引腳。
(6) 使用宏控制RGB燈默認關閉，LED4指示燈默認開啟。
4. 主函數
編寫完LED燈的控制函數後，就可以在main函數中測試了，見代碼清單 114。
代碼清單 114 控制LED燈，main文件
1 #include "stm32f4xx.h"
2 #include "./led/bsp_led.h"
3
4 void Delay(__IO u32 nCount);
5
6 /**
7 * @brief 主函數
8 * @param 無
9 * @retval 無
10 */
11 int main(void)
12 {
13 /* LED 端口初始化 */
14 LED_GPIO_Config();
15
16 /* 控制LED燈 */
17 while (1) {
18 LED1( ON ); // 亮
19 Delay(0xFFFFFF);
20 LED1( OFF ); // 滅
21
22 LED2( ON ); // 亮
23 Delay(0xFFFFFF);
24 LED2( OFF ); // 滅
25
26 LED3( ON ); // 亮
27 Delay(0xFFFFFF);
28 LED3( OFF ); // 滅
29
30 LED4( ON ); // 亮
31 Delay(0xFFFFFF);
32 LED4( OFF ); // 滅
33
34 /*輪流顯示紅綠藍黃紫青白顏色*/
35 LED_RED;
36 Delay(0xFFFFFF);
37
38 LED_GREEN;
39 Delay(0xFFFFFF);
40
41 LED_BLUE;
42 Delay(0xFFFFFF);
43
44 LED_YELLOW;
45 Delay(0xFFFFFF);
46
47 LED_PURPLE;
48 Delay(0xFFFFFF);
49
50 LED_CYAN;
51 Delay(0xFFFFFF);
52
53 LED_WHITE;
54 Delay(0xFFFFFF);
55
56 LED_RGBOFF;
57 Delay(0xFFFFFF);
58 }
59 }
60
61 void Delay(__IO uint32_t nCount) //簡單的延時函數
62 {
63 for (; nCount != 0; nCount--);
64 }
在main函數中，調用我們前面定義的LED_GPIO_Config初始化好LED的控制引腳，然後直接調用各種控制LED燈亮滅的宏來實現LED燈的控制。
以上，就是一個使用STM32標準軟件庫開發應用的流程。
11.2.1 下載驗證
把編譯好的程序下載到開發板並復位，可看到RGB彩燈輪流顯示不同的顏色。
11.3 STM32標準庫補充知識
1. SystemInit函數去哪了？
在前幾章我們自己建工程的時候需要定義一個SystemInit空函數，但是在這個用STM32標準庫的工程卻沒有這樣做，SystemInit函數去哪了呢？
這個函數在STM32標準庫的"system_stm32f4xx.c"文件中定義了，而我們的工程已經包含該文件。標準庫中的SystemInit函數把STM32芯片的系統時鐘設置成了180MHz，即此時AHB1時鐘頻率為180MHz，APB2為90MHz，APB1為45MHz。當STM32芯片上電後，執行啟動文件中的指令後，會調用該函數，設置系統時鐘為以上狀態。
2. 斷言
細心對比過前幾章我們自己定義的GPIO_Init函數與STM32標準庫中同名函數的讀者，會發現標準庫中的函數內容多了一些亂七八糟的東西，見代碼清單 115。
代碼清單 115 GPIO_Init函數的斷言部分
1 void GPIO_Init(GPIO_TypeDef* GPIOx, GPIO_InitTypeDef* GPIO_InitStruct)
2 {
3 uint32_t pinpos = 0x00, pos = 0x00 , currentpin = 0x00;
4
5 /* Check the parameters */
6 assert_param(IS_GPIO_ALL_PERIPH(GPIOx));
7 assert_param(IS_GPIO_PIN(GPIO_InitStruct->GPIO_Pin));
8 assert_param(IS_GPIO_MODE(GPIO_InitStruct->GPIO_Mode));
9 assert_param(IS_GPIO_PUPD(GPIO_InitStruct->GPIO_PuPd));
10
11 /* ------- 以下內容省略，跟前面我們定義的函數內容相同----- */
基本上每個庫函數的開頭都會有這樣類似的內容，這裏的"assert_param"實際是一個宏，在庫函數中它用於檢查輸入參數是否符合要求，若不符合要求則執行某個函數輸出警告，"assert_param"的定義見代碼清單 116。
代碼清單 116 stm32f4xx_conf.h文件中關於斷言的定義
1
2 #ifdef USE_FULL_ASSERT
3 /**
4 * @brief assert_param 宏用於函數的輸入參數檢查
5 * @param expr:若expr值為假，則調用assert_failed函數
6 * 報告文件名及錯誤行號
7 * 若expr值為真，則不執行操作
8 */
9 #define assert_param(expr) \
10 ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))
11 /* 錯誤輸出函數 ------------------------------------------------------- */
12 void assert_failed(uint8_t* file, uint32_t line);
13 #else
14 #define assert_param(expr) ((void)0)
15 #endif
這段代碼的意思是，假如我們不定義"USE_FULL_ASSERT"宏，那麽"assert_param"就是一個空的宏(#else與#endif之間的語句生效)，沒有任何操作。從而所有庫函數中的assert_param實際上都無意義，我們就當看不見好了。
假如我們定義了"USE_FULL_ASSERT"宏，那麽"assert_param"就是一個有操作的語句(#if與#else之間的語句生效)，該宏對參數expr使用C語言中的問號表達式進行判斷，若expr值為真，則無操作(void 0)，若表達式的值為假，則調用"assert_failed"函數，且該函數的輸入參數為"__FILE__"及"__LINE__"，這兩個參數分別代表"assert_param"宏被調用時所在的"文件名"及"行號"。
但庫文件只對"assert_failed"寫了函數聲明，沒有寫函數定義，實際用時需要用戶來定義，我們一般會用printf函數來輸出這些信息，見代碼清單 117。
代碼清單 117 assert_failed 輸出錯誤信息
1 void assert_failed(uint8_t* file, uint32_t line)
2 {
3 printf("\r\n輸入參數錯誤，錯誤文件名=%s,行號=%s",file,line);
4 }
註意在我們的這個LED工程中，還不支持printf函數(在USART外設章節會講解)，想測試assert_failed輸出的讀者，可以在這個函數中做點亮紅色LED燈的操作，作為警告輸出測試。
那麽為什麽函數輸入參數不對的時候，assert_param宏中的expr參數值會是假呢？這要回到GPIO_Init函數，看它對assert_param宏的調用，它被調用時分別以"IS_GPIO_ALL_PERIPH(GPIOx)"、"IS_GPIO_PIN(GPIO_InitStruct->GPIO_Pin)"等作為輸入參數，也就是說被調用時，expr實際上是一條針對輸入參數的判斷表達式。例如"IS_GPIO_PIN"的宏定義：
1 #define IS_GPIO_PIN(PIN) ((PIN) != (uint32_t)0x00)
若它的輸入參數 PIN 值為0，則表達式的值為假，PIN非0時表達式的值為真。我們知道用於選擇GPIO引腳號的宏"GPIO_Pin_x"的值至少有一個數據位為1，這樣的輸入參數才有意義，若GPIO_InitStruct->GPIO_Pin的值為0，輸入參數就無效了。配合"IS_GPIO_PIN"這句表達式，"assert_param"就實現了檢查輸入參數的功能。對assert_param宏的其它調用方式類似，大家可以自己看庫源碼來研究一下。
3. Doxygen註釋規範
在STM32標準庫以及我們自己編寫的"bsp_led.c"文件中，可以看到一些比較特別的註釋，類似代碼清單 118。
代碼清單 118 Doxygen註釋規範
1 /**
2 * @brief 初始化控制LED的IO
3 * @param 無
4 * @retval 無
5 */
這是一種名為"Doxygen"的註釋規範，如果在工程文件中按照這種規範去註釋，可以使用Doxygen軟件自動根據註釋生成幫助文檔。我們所說非常重要的庫幫助文檔《stm32f4xx_dsp_stdperiph_lib_um.chm》，就是由該軟件根據庫文件的註釋生成的。關於Doxygen註釋規範本教程不作講解，感興趣的讀者可自行搜索網絡上的資料學習。
4. 防止頭文件重復包含
在STM32標準庫的所有頭文件以及我們自己編寫的"bsp_led.h"頭文件中，可看到類似代碼清單 119的宏定義。它的功能是防止頭文件被重復包含，避免引起編譯錯誤。
代碼清單 119 防止頭文件重復包含的宏
1 #ifndef __LED_H
2 #define __LED_H
3
4 /*此處省略頭文件的具體內容*/
5
6 #endif /* end of __LED_H */
在頭文件的開頭，使用"#ifndef"關鍵字，判斷標號"__LED_H"是否被定義，若沒有被定義，則從"#ifndef"至"#endif"關鍵字之間的內容都有效，也就是說，這個頭文件若被其它文件"#include"，它就會被包含到其該文件中了，且頭文件中緊接著使用"#define"關鍵字定義上面判斷的標號"__LED_H"。當這個頭文件被同一個文件第二次"#include"包含的時候，由於有了第一次包含中的"#define __LED_H"定義，這時再判斷"#ifndef __LED_H"，判斷的結果就是假了，從"#ifndef"至"#endif"之間的內容都無效，從而防止了同一個頭文件被包含多次，編譯時就不會出現"redefine（重復定義）"的錯誤了。
一般來說，我們不會直接在C的源文件寫兩個"#include"來包含同一個頭文件，但可能因為頭文件內部的包含導致重復，這種代碼主要是避免這樣的問題。如"bsp_led.h"文件中使用了"#include "stm32f4xx.h" "語句，按習慣，可能我們寫主程序的時候會在main文件寫"#include "bsp_led.h" 及#include "stm32f4xx.h""，這個時候"stm32f4xx.h"文件就被包含兩次了，如果沒有這種機制，就會出錯。
至於為什麽要用兩個下劃線來定義"__LED_H"標號，其實這只是防止它與其它普通宏定義重復了，如我們用"GPIO_PIN_0"來代替這個判斷標號，就會因為stm32f4xx.h已經定義了GPIO_PIN_0，結果導致"bsp_led.h"文件無效了，"bsp_led.h"文件一次都沒被包含。
11.4 每課一練
1. 參考本章中的工程範例，使用STM32標準庫編寫控制LED燈的程序。
2. 修改"bsp_led.h"頭文件中控制LED燈引腳的宏，改至實驗板的其它GPIO引腳，然後使用電壓表測量該引腳的電平狀態。(註意測量引腳狀態的時候，程序要控制GPIO輸出恒定的電平，方便電壓表檢測。部分引腳可能已連接到板子上的其它芯片，可能存在幹擾。)
3. 設置"stm32f4xx_conf.h"文件，使能"assert_param"斷言功能，並定義"assert_failed"函數，當調用庫函數參數錯誤時，該函數點亮LED紅燈警告。
第11章 GPIO輸出—使用固件庫點亮LED