STM32單片機(jī)的斷言機(jī)制函數(shù)assert_param解析

我們?cè)趯W(xué)STM32的時(shí)候函數(shù)assert_param出現(xiàn)的幾率非常大，上網(wǎng)搜索一下，網(wǎng)上一般解釋斷言機(jī)制，做為程序開(kāi)發(fā)調(diào)試階段時(shí)使用。下面我就談一下我對(duì)這些應(yīng)用的看法，學(xué)習(xí)東西抱著知其然也要知其所以然。

4 斷言機(jī)制函數(shù)assert_param

我們?cè)诜治鰩?kù)函數(shù)的時(shí)候，幾乎每一個(gè)函數(shù)的原型有這個(gè)函數(shù)assert_param（）；下面以assert_param（IS_GPIO_ALL_PERIPH（GPIOx））;為例說(shuō)一下我的理解，函數(shù)的參數(shù)IS_GPIO_ALL_PERIPH（GPIOx），我們可以尋找到原型

#define IS_GPIO_ALL_PERIPH（PERIPH） （（（*（uint32_t*）&（PERIPH）） == GPIOA_BASE）|| \

（（*（uint32_t*）&（PERIPH）） == GPIOB_BASE） || \

（（*（uint32_t*）&（PERIPH）） == GPIOC_BASE） || \

（（*（uint32_t*）&（PERIPH）） == GPIOD_BASE） || \

（（*（uint32_t*）&（PERIPH）） == GPIOE_BASE） || \

（（*（uint32_t*）&（PERIPH）） == GPIOF_BASE） || \

（（*（uint32_t*）&（PERIPH）） == GPIOG_BASE））

這個(gè)宏定義的作用就是檢查參數(shù)PERIPH，判斷參數(shù)PERIPH是否為GPIOX（A.。.G）基址中的一個(gè)，只要有一個(gè)為真則其值為真，否則為假，不用多說(shuō)，這是C語(yǔ)言中基本的邏輯運(yùn)算。當(dāng)然這個(gè)庫(kù)函數(shù)也用的很有意思，看：首先對(duì)PERIPH進(jìn)行取址，也就是求地址，&PERIPH，然后對(duì)這個(gè)地址強(qiáng)制轉(zhuǎn)化為32位的指針，即前面加（uint32_t *），然后通過(guò)*進(jìn)行訪問(wèn)這個(gè)地址（指針）中的內(nèi)容。不多說(shuō)了，看幾遍就能明白。

下面我們?cè)倩氐絘ssert_param這個(gè)函數(shù)，這個(gè)函數(shù)是哪里的呢？在stm32f10x_conf.h尋找到原型如下：

#ifdef USE_FULL_ASSERT

#define assert_param（expr） （（expr） ？ （void）0 ： assert_failed（（uint8_t*）__FILE__， __LINE__））

void assert_failed（uint8_t* file， uint32_t line）;

#else

#define assert_param（expr） （（void）0）

#endif

這是一個(gè)預(yù)編譯文件，若是定義了USE_FULL_ASSERT這個(gè)文件，則執(zhí)行后面的文件，我們?cè)诔绦蛑幸话愣紱](méi)什么定義，即執(zhí)行后面這個(gè)語(yǔ)句（（void）0），這個(gè)語(yǔ)句不用多想，沒(méi)有定義USE_FULL_ASSERT就是什么也不執(zhí)行。說(shuō)的明白點(diǎn)，對(duì)上面的那個(gè)語(yǔ)句IS_GPIO_ALL_PERIPH（GPIOx）不執(zhí)行任何操作。

若是定義了USE_FULL_ASSERT它，我們調(diào)用這個(gè)函數(shù)assert_param時(shí)，及對(duì)參數(shù)IS_GPIO_ALL_PERIPH（GPIOx）的正確性進(jìn)行檢查，通過(guò)一個(gè)C語(yǔ)言中的雙目運(yùn)算符來(lái)判斷，若是返回1，執(zhí)行語(yǔ)句（void）0，跟上面一樣，若是返回0，則執(zhí)行后面的函數(shù)assert_failed（（uint8_t *）__FILE__，__LINE__），函數(shù)的作用在庫(kù)函數(shù)中有解釋，用來(lái)指示出錯(cuò)的行數(shù)和文件。注意：__FILE__，__LINE__是標(biāo)準(zhǔn)庫(kù)函數(shù)中的宏定義！切記

void assert_failed（uint8_t* file， uint32_t line）;剛開(kāi)始沒(méi)看明白為什么加在這里，仔細(xì)一想是在頭文件的函數(shù)聲明。至于函數(shù)實(shí)體呢？我們從官方文件的模板中main.c中可以找到。如下：

void assert_failed（u8* file， u32 line）

{ /* User can add his own implementation to report the file name and linenumber，

ex： printf（“Wrong parameters value： file %s on line %d\r\n”， file，line） */

/* Infinite loop */

while （1） { }

} 英文注釋也說(shuō)明了怎么應(yīng)用，通過(guò)輸入?yún)?shù)來(lái)確定位置，最簡(jiǎn)單的方法就是串口打印了，這個(gè)函數(shù)的主要思想是在輸入?yún)?shù)有問(wèn)題的時(shí)候，但是有編譯不出來(lái)，它可以幫你檢查參數(shù)的有效性，好處不必多言，自己領(lǐng)悟就行。

繼續(xù)說(shuō)明如下： assert_param是怎樣包含進(jìn)去的呢？我們?cè)趕tm32f10x_conf.h這個(gè)頭文件中定義的函數(shù)聲明還是宏定義，怎么在其它文件中都能應(yīng)用呢？也很多網(wǎng)上朋友在剛開(kāi)始學(xué)習(xí)的時(shí)候都遇到編譯不過(guò)去的問(wèn)題出現(xiàn)，最后通過(guò)在文件中添加USE_STDPERIPH_DRIVER來(lái)解決的：

我們可以在整個(gè)工程中進(jìn)行搜索USE_STDPERIPH_DRIVER，通過(guò)頭文件可以看出，是使用標(biāo)準(zhǔn)外設(shè)文件。在stm32f10x.h文件中我們可以搜索到如下情況：

#if ！defined USE_STDPERIPH_DRIVER

/**

* @brief Comment the line below if you will not use the peripherals drivers.

In this case， these drivers will not be included and the application code will

be based on direct access to peripherals registers

*/

#define USE_STDPERIPH_DRIVER

#endif

#ifdef USE_STDPERIPH_DRIVER

#include “stm32f10x_conf.h”

#endif

可以很容易看出來(lái)，我們不在那里添加，這個(gè)頭文件中也給我們?cè)O(shè)置了開(kāi)關(guān)，只要把第一個(gè)的注釋去掉，就不用在配置中添加USE_STDPERIPH_DRIVER了，在第二個(gè)文件中我們可以知道怎樣包含這個(gè)控制開(kāi)關(guān)文件了，呵呵。我們也明白為什么我們?cè)趯?xiě)程序的時(shí)候只要包含stm32f10x.h就能很容易的包含所有的文件文件了吧，我們只要在stm32f10x_conf.h配置一下就能包含所需要的庫(kù)文件了。

通過(guò)以上可以看出，通過(guò)頭文件的相互包含，來(lái)控制外設(shè)以及調(diào)試文件的調(diào)用，這樣我們理清思路，理解起來(lái)就好多了。當(dāng)然在學(xué)習(xí)中可能有些C語(yǔ)言問(wèn)題還沒(méi)有理解透徹，多上網(wǎng)搜一下，或者多看書(shū)，很快就搞明白的。

PS 2：

STM32中assert_param的使用

在STM32的固件庫(kù)和提供的例程中，到處都可以見(jiàn)到assert_param（）的使用。如果打開(kāi)任何一個(gè)例程中的stm32f10x_conf.h文件，就可以看到實(shí)際上assert_param是一個(gè)宏定義；

在固件庫(kù)中，它的作用就是檢測(cè)傳遞給函數(shù)的參數(shù)是否是有效的參數(shù)。

所謂有效的參數(shù)是指滿足規(guī)定范圍的參數(shù)，比如某個(gè)參數(shù)的取值范圍只能是小于3的正整數(shù)，如果給出的參數(shù)大于3，

則這個(gè)assert_param（）可以在運(yùn)行的程序調(diào)用到這個(gè)函數(shù)時(shí)報(bào)告錯(cuò)誤，使程序員可以及時(shí)發(fā)現(xiàn)錯(cuò)誤，而不必等到程序運(yùn)行結(jié)果的錯(cuò)誤而大費(fèi)周折。

這是一種常見(jiàn)的軟件技術(shù)，可以在調(diào)試階段幫助程序員快速地排除那些明顯的錯(cuò)誤。

它確實(shí)在程序的運(yùn)行上犧牲了效率（但只是在調(diào)試階段），但在項(xiàng)目的開(kāi)發(fā)上卻幫助你提高了效率。

當(dāng)你的項(xiàng)目開(kāi)發(fā)成功，使用release模式編譯之后，或在stm32f10x_conf.h文件中注釋掉對(duì)USE_FULL_ASSERT的宏定義，所有的assert_param（）檢驗(yàn)都消失了，不會(huì)影響最終程序的運(yùn)行效率。

#define assert_param（expr） （（expr） ？ （void）0 ： assert_failed（（u8 *）__FILE__， __LINE__））

。。。

assert_param（IS_ADC_ALL_PERIPH（ADCx））;

。。。

在執(zhí)行assert_param（）的檢驗(yàn)時(shí)，如果發(fā)現(xiàn)參數(shù)出錯(cuò)，它會(huì)調(diào)用函數(shù)assert_failed（）向程序員報(bào)告錯(cuò)誤，在任何一個(gè)例程中的main.c中都有這個(gè)函數(shù)的模板，如下：

void assert_failed（uint8_t* file， uint32_t line）

{

while （1）

{}

}

你可以按照自己使用的環(huán)境需求，添加適當(dāng)?shù)恼Z(yǔ)句輸出錯(cuò)誤的信息提示，或修改這個(gè)函數(shù)做出適當(dāng)?shù)腻e(cuò)誤處理。

1、STM32F10xD.LIB是DEBUG模式的庫(kù)庫(kù)文件。

2、STM32F10xR.LIB是Release模式的庫(kù)庫(kù)文件。

3、要選擇DEBUG和RELEASE模式，需要修改stm32f10x_conf.h的內(nèi)容。

#define DEBUG 表示DEBUG模式，把該語(yǔ)句注釋掉，則為RELEASE模式。

4、要選擇DEBUG和RELEASE模式，也可以在Options，C/C++，Define里填入DEBUG的預(yù)定義。

這樣，就不需要修改stm32f10x_conf.h的內(nèi)容。

5、如果把庫(kù)加入項(xiàng)目，則不需要將ST的庫(kù)源文件加入項(xiàng)目，比較方便。

但是，庫(kù)的選擇要和DEBUG預(yù)定義對(duì)應(yīng)。