STM32固件库中assert_param的作用

最新推荐文章于 2023-03-24 10:46:58 发布

原创最新推荐文章于 2023-03-24 10:46:58 发布 · 750 阅读

5 ·

CC 4.0 BY-SA版权

stm32单片机/嵌入式知识库专栏收录该内容

28 篇文章

订阅专栏

本文介绍了assert_param宏在固件库中的应用，通过检测函数参数的有效性来预防编程错误。使用ADC_Cmd函数作为示例，解释了如何利用assert_param确保参数符合预设条件，并通过KEIL工具快速查找参数的有效范围。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

assert_param是一个宏定义；
在固件库中，它的作用就是检测传递给函数的参数是否是有效的参数。
所谓有效的参数是指满足规定范围的参数，比如某个参数的取值范围只能是小于3的正整数，如果给出的参数大于3，
则这个assert_param()可以在运行的程序调用到这个函数时报告错误，使程序员可以及时发现错误，而不必等到程序运行结果的错误而大费周折。

以下是从固件库中复制粘贴的：

void ADC_Cmd(ADC_TypeDef* ADCx, FunctionalState NewState)
{
  /* Check the parameters */
  assert_param(IS_ADC_ALL_PERIPH(ADCx));
  assert_param(IS_FUNCTIONAL_STATE(NewState));
  if (NewState != DISABLE)
  {
    /* Set the ADON bit to wake up the ADC from power down mode */
    ADCx->CR2 |= (uint32_t)ADC_CR2_ADON;
  }
  else
  {
    /* Disable the selected ADC peripheral */
    ADCx->CR2 &= (uint32_t)(~ADC_CR2_ADON);
  }
}

笔者用keil中的鼠标右键“go to definition xxxxxx"" 查看assert_param(IS_ADC_ALL_PERIPH(ADCx));语句中IS_ADC_ALL_PERIPH的定义，得到如下结果：

#define IS_ADC_ALL_PERIPH(PERIPH) (((PERIPH) == ADC1) || \
                                   ((PERIPH) == ADC2) || \
                                   ((PERIPH) == ADC3))

当我们调用这个函数的时候，所给它的参数必须是以上规定的几个数值中的一个，不可随意填一个未定义的值进去。assert_param（）函数有效的解决了这个问题，它在函数运行之初，便判断工程师所给的值是否为这个函数的有效值，以达到纠错报错的功能。同时，当我们不知道这个函数该填入什么样的值的时候，就可以使用keil中提供的右键“go to definition xxxx"查看assert_param（）括号中的定义。