詳解stm32中的assert_param()函數(shù)
大家在用stm32庫函數(shù)的時候幾乎都會發(fā)現(xiàn)assert_param()這個函數(shù),這個函數(shù)是判斷參數(shù)有沒有錯誤,具體是什么錯誤呢,我會在后面貼圖的。
assert_param()這個函數(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
以上代碼就是stm32f10x_conf.h中的一部分,我們再看下面的代碼:
RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOB|RCC_APB2Periph_GPIOE, ENABLE);
這個函數(shù)是使能GPIOB和GPIOE端口的時鐘的。GPIOB和GPIOE是屬于APB2外設(shè)的所以用函數(shù)RCC_APB2PeriphClockCmd( xxx , xxx) 來使能,我們在進RCC_APB2PeriphClockCmd( xxx , xxx)函數(shù)里面看看:
void RCC_APB2PeriphClockCmd(uint32_t RCC_APB2Periph, FunctionalState NewState)
{
assert_param(IS_RCC_APB2_PERIPH(RCC_APB2Periph));
assert_param(IS_FUNCTIONAL_STATE(NewState));
if (NewState != DISABLE)
{
RCC->APB2ENR |= RCC_APB2Periph;
}
else
{
RCC->APB2ENR &= ~RCC_APB2Periph;
}
}
在這個函數(shù)里面就可以看見我們今天要學習的函數(shù)了,在這里我們就分析函數(shù)1,以點帶面
1、assert_param(IS_RCC_APB2_PERIPH(RCC_APB2Periph));
2、assert_param(IS_FUNCTIONAL_STATE(NewState));
函數(shù)1里面的參數(shù)是IS_RCC_APB2_PERIPH(RCC_APB2Periph),我們在進入這個函數(shù)里面看看:
這是一個宏定義
#define IS_RCC_APB2_PERIPH(PERIPH) ((((PERIPH) & 0xFFC00002) == 0x00) && ((PERIPH) != 0x00))
我們來計算一下,PERIPH 是我們傳遞的參數(shù) RCC_APB2Periph_GPIOB|RCC_APB2Periph_GPIOE,
RCC_APB2Periph_GPIOB|RCC_APB2Periph_GPIOE=0x00000008|0x00000040
(PERIPH) & 0xFFC00002 = 0x00,所以((((PERIPH) & 0xFFC00002) == 0x00) && ((PERIPH) != 0x00)) = 1
所以就相當于assert_param(1);
我們反過來在看stm32f10x_conf.h代碼的那部分,如果定義USE_FULL_ASSERT,那么就會定義
#define assert_param(expr) ((expr) ? (void)0: assert_failed((uint8_t *)__FILE__, __LINE__))
如果沒定義USE_FULL_ASSERT,那么就會定義#define assert_param(expr) ((void)0),這是為什么呢,是因為用戶在代碼調(diào)試階段很可能會輸入錯誤的參數(shù)而出現(xiàn)錯誤,一般這種錯誤不會察覺到,所以當我們想檢查這種錯誤的時候就定義USE_FULL_ASSERT,當我們完成工程項目開始投入生產(chǎn)以后,代碼肯定是沒有這方面的錯誤了,我們不需要程序在檢查我們的參數(shù)了我們就不用定義USE_FULL_ASSERT。這樣我們的代碼會小一點。
所以我們在stm32f10x_conf.h中打開注釋,這樣就會檢查我們代碼中要求檢查的參數(shù)了,當我們參數(shù)沒有錯誤時,就相當于assert_param(1);,進入函數(shù)assert_param();觀察,就會執(zhí)行(void)0,意思就是什么也不執(zhí)行,因為此時參數(shù)沒有錯誤。
我們現(xiàn)在需要制造出一個錯誤,在觀察函數(shù)是怎么執(zhí)行的。
現(xiàn)在我們傳遞一個錯誤的參數(shù)
RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM3, ENABLE);
我們在計算一下,RCC_APB1Periph_TIM3=0x00000002
(PERIPH) & 0xFFC00002) != 0x00
所以IS_RCC_APB2_PERIPH(PERIPH)返回0
所以相當于assert_param(0);
進入assert_param();函數(shù)觀察
#define assert_param(expr) ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))
就會執(zhí)行這個函數(shù)assert_failed((uint8_t *)__FILE__, __LINE__),我們解釋一下這個函數(shù)是干什么的,這個函數(shù)是用戶自己發(fā)揮的,想在這個函數(shù)里面干什么就干什么,它的原型程序里面沒有,總之我沒找到,后來我在網(wǎng)上看見一文章,他說他在官方例子main.c里面找到的,所以我就拷貝到我的main.c中,函數(shù)原型如下:
void assert_failed(u8* file, u32 line)
{
//User can add his own implementation to report the file name and line number,
// ex: printf("Wrong parameters value: file %s on line %drn", file, line)
//用戶可以在這里添加錯誤信息:比如打印出出錯的文件名和行號
// Infinite loop
while (1)
{
}
}
這個函數(shù)就是在程序運行時,可以打印出我們參數(shù)錯誤的文件和行號,我把這個函數(shù)修改為:
void assert_failed(u8* file, u32 line)
{
printf("Wrong parametersvalue: file %s on line %drn", file, line);
}
你也可以添加別的函數(shù),總之能顯示錯誤信息就ok,不一定用串口顯示。
如果參數(shù)有錯誤的話,就會向串口打印出錯誤處的文件和行號,看下圖是串口打印出的錯誤信息:
錯誤文件為stm32f10x_rcc.c 行號1098,我們在看一下程序是不是這里出現(xiàn)了參數(shù)錯誤,如下圖:
還真是這里出現(xiàn)了參數(shù)錯誤,因為我們傳遞的參數(shù)是
RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM3, ENABLE);
這里我就基本介紹完了,下面在介紹幾點。
1、assert_failed((uint8_t *)__FILE__, __LINE__)這個函數(shù)的__FILE__, __LINE__形參,可能是c語言自帶的把,具體是怎么獲取錯誤參數(shù)的文件和行號我也不知道。
2、加入我們傳遞的參數(shù)是RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM2, ENABLE);雖然RCC_APB1Periph_TIM2是屬于APB1的,則在程序運行時是打印不出錯誤參數(shù)的,因為RCC_APB1Periph_TIM2和RCC_APB2Periph_AFIO都等于0x00000001,大家可以去stm32f10x_rcc.h文件去看。所以大家在使用參數(shù)檢查功能時還要自己注意一下參數(shù)有沒有錯誤。官方這個查錯功能不是萬能的。