STM32库函数中的assert_param和assert_failed

使用STM32库函数的时候，你会发现带参数的库函数前面都有assert_param语句。

例如我们随便看一个库函数，如下所示：

这个函数是3.5版本库函数stm32f10x_tim.c中的定时器复位函数。

assert_param语句的作用？

assert_param语句是用于程序开发的时候，调试用的检测语句。默认是不开启的，你可以无视它的存在。但是，当你在调试程序的时候，可以打开这个检测机制，调试完了再关闭。

怎么使assert_param起作用？

查看assert_param的定义，位于stm32f10x_conf.h文件，你会发现它实际上是个宏，看它的条件编译语句，你会发现，把USE_FULL_ASSERT定义后，即可打开assert_param这个参数检测机制。USE_FULL_ASSERT这个宏定义已经在文件中隐掉，我们把它的注释符号去掉即可。

看上图中第59行代码，是个条件编译语句，意思是：如果定义了USE_FULL_ASSERT，就把assert_param定义为一个三目运算的结构（第68行），否则（第71行），就把assert_param定义成((void)0)(第72行)。也就是说，你只有定义了USE_FULL_ASSERT，assert_param才会起作用，这个作用就是通过一个三目运算结构（如下）来判断的。关于三目运算的基础知识，请看https://rationmcu.com/clang/382.html

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

assert_param语句的作用是检测函数的参数是否符合该函数的要求，例如上面的函数中的参数就是TIMx，我们找到IS_TIM_ALL_PERIPH这个定义，可以看到TIMx中的x的范围是1~17，也就是说，你要是把函数写成TIM_DeInit(TIM1);assert_param的结果就是(void)0，如果你把函数写成TIM_DeInit(TIM18);就会调用assert_failed函数。

#define IS_TIM_ALL_PERIPH(PERIPH) (((PERIPH) == TIM1) || \
 ((PERIPH) == TIM2) || \
 ((PERIPH) == TIM3) || \
 ((PERIPH) == TIM4) || \
 ((PERIPH) == TIM5) || \
 ((PERIPH) == TIM6) || \
 ((PERIPH) == TIM7) || \
 ((PERIPH) == TIM8) || \
 ((PERIPH) == TIM9) || \
 ((PERIPH) == TIM10)|| \
 ((PERIPH) == TIM11)|| \
 ((PERIPH) == TIM12)|| \
 ((PERIPH) == TIM13)|| \
 ((PERIPH) == TIM14)|| \
 ((PERIPH) == TIM15)|| \
 ((PERIPH) == TIM16)|| \
 ((PERIPH) == TIM17))

assert_failed函数怎么写？

如上，当你定义了USE_FULL_ASSET之后，你立即编译，编译器会报错，提示assert_failed函数没有定义。我们把assert_failed这个函数放到mian.c文件中，如下定义：

void assert_failed(uint8_t* file, uint32_t line)
{
 printf("Wrong parameters value: file %s on line %d\r\n", file, line);
 while(1);
}

上面函数的意思就是，如果参数出错，输出出错的文件名称和行号。结果是输出到串口，用串口调试助手可以看到输出结果。注意，编译器Build Output栏是不会报错的。

下面给出一个例程，故意写错参数，通过STM32串口1把错误参数的文件名称和行数发到串口，你打开串口调试助手即可看到结果。

点击下载assert_param（MDK5文件）