單片機之STM32 中的 assert_param 函數

我們在學STM32的時候函數assert_param出現的機率非常大,上網搜索一下,網上一般解釋斷言機制,做爲程序開發調試階段時使用。下面我就談一下我對這些應用的看法,學習東西抱着知其然也要知其所以然。
4 斷言機制函數assert_param
我們在分析庫函數的時候,幾乎每一個函數的原型有這個函數assert_param();下面以assert_param(IS_GPIO_ALL_PERIPH(GPIOx));爲例說一下我的理解,函數的參數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))
這個宏定義的作用就是檢查參數PERIPH,判斷參數PERIPH是否爲GPIOX(A...G)基址中的一個,只要有一個爲真則其值爲真,否則爲假,不用多說,這是C語言中基本的邏輯運算。當然這個庫函數也用的很有意思,看:首先對PERIPH進行取址,也就是求地址,&PERIPH,然後對這個地址強制轉化爲32位的指針,即前面加(uint32_t *),然後通過*進行訪問這個地址(指針)中的內容。不多說了,看幾遍就能明白。
下面我們再回到assert_param這個函數,這個函數是哪裏的呢?在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 
這是一個預編譯文件,若是定義了USE_FULL_ASSERT這個文件,則執行後面的文件,我們在程序中一般都沒什麼定義,即執行後面這個語句((void)0),這個語句不用多想,沒有定義USE_FULL_ASSERT就是什麼也不執行。說的明白點,對上面的那個語句IS_GPIO_ALL_PERIPH(GPIOx)不執行任何操作。
若是定義了USE_FULL_ASSERT它,我們調用這個函數assert_param時,及對參數IS_GPIO_ALL_PERIPH(GPIOx)的正確性進行檢查,通過一個C語言中的雙目運算符來判斷,若是返回1,執行語句(void)0,跟上面一樣,若是返回0,則執行後面的函數assert_failed((uint8_t *)__FILE__,__LINE__),函數的作用在庫函數中有解釋,用來指示出錯的行數和文件。注意:__FILE__,__LINE__是標準庫函數中的宏定義!切記
void assert_failed(uint8_t* file, uint32_t line);剛開始沒看明白爲什麼加在這裏,仔細一想是在頭文件的函數聲明。至於函數實體呢?我們從官方文件的模板中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) { } 
} 英文註釋也說明了怎麼應用,通過輸入參數來確定位置,最簡單的方法就是串口打印了,這個函數的主要思想是在輸入參數有問題的時候,但是有編譯不出來,它可以幫你檢查參數的有效性,好處不必多言,自己領悟就行。
繼續說明如下: assert_param是怎樣包含進去的呢?我們在stm32f10x_conf.h這個頭文件中定義的函數聲明還是宏定義,怎麼在其它文件中都能應用呢?也很多網上朋友在剛開始學習的時候都遇到編譯不過去的問題出現,最後通過在文件中添加USE_STDPERIPH_DRIVER來解決的:

我們可以在整個工程中進行搜索USE_STDPERIPH_DRIVER,通過頭文件可以看出,是使用標準外設文件。在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
可以很容易看出來,我們不在那裏添加,這個頭文件中也給我們設置了開關,只要把第一個的註釋去掉,就不用在配置中添加USE_STDPERIPH_DRIVER了,在第二個文件中我們可以知道怎樣包含這個控制開關文件了,呵呵。我們也明白爲什麼我們在寫程序的時候只要包含stm32f10x.h就能很容易的包含所有的文件文件了吧,我們只要在stm32f10x_conf.h配置一下就能包含所需要的庫文件了。
通過以上可以看出,通過頭文件的相互包含,來控制外設以及調試文件的調用,這樣我們理清思路,理解起來就好多了。當然在學習中可能有些C語言問題還沒有理解透徹,多上網搜一下,或者多看書,很快就搞明白的。



PS 2:

       

在STM32的固件庫和提供的例程中,到處都可以見到assert_param()的使用。如果打開任何一個例程中的stm32f10x_conf.h文件,就可以看到實際上assert_param是一個宏定義;
在固件庫中,它的作用就是檢測傳遞給函數的參數是否是有效的參數。
所謂有效的參數是指滿足規定範圍的參數,比如某個參數的取值範圍只能是小於3的正整數,如果給出的參數大於3,
則這個assert_param()可以在運行的程序調用到這個函數時報告錯誤,使程序員可以及時發現錯誤,而不必等到程序運行結果的錯誤而大費周折。

這是一種常見的軟件技術,可以在調試階段幫助程序員快速地排除那些明顯的錯誤。

它確實在程序的運行上犧牲了效率(但只是在調試階段),但在項目的開發上卻幫助你提高了效率。

當你的項目開發成功,使用release模式編譯之後,或在stm32f10x_conf.h文件中註釋掉對USE_FULL_ASSERT的宏定義,所有的assert_param()檢驗都消失了,不會影響最終程序的運行效率。

#define assert_param(expr) ((expr) ? (void)0 : assert_failed((u8 *)__FILE__, __LINE__))
。。。

assert_param(IS_ADC_ALL_PERIPH(ADCx));
。。。

在執行assert_param()的檢驗時,如果發現參數出錯,它會調用函數assert_failed()向程序員報告錯誤,在任何一個例程中的main.c中都有這個函數的模板,如下:

void assert_failed(uint8_t* file, uint32_t line)
{


while (1)
{}
}

你可以按照自己使用的環境需求,添加適當的語句輸出錯誤的信息提示,或修改這個函數做出適當的錯誤處理。

1、STM32F10xD.LIB是DEBUG模式的庫庫文件。
2、STM32F10xR.LIB是Release模式的庫庫文件。
3、要選擇DEBUG和RELEASE模式,需要修改stm32f10x_conf.h的內容。
    #define DEBUG 表示DEBUG模式,把該語句註釋掉,則爲RELEASE模式。
4、要選擇DEBUG和RELEASE模式,也可以在Options,C/C++,Define裏填入DEBUG的預定義。
    這樣,就不需要修改stm32f10x_conf.h的內容。
5、如果把庫加入項目,則不需要將ST的庫源文件加入項目,比較方便。
    但是,庫的選擇要和DEBUG預定義對應。

感謝作者

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章