详解stm32中的assert_param()函数

转载自http://blog.sina.com.cn/s/blog_dc9571b90102vhuw.html

大家在用stm32库函数的时候几乎都会发现assert_param()这个函数，这个函数是判断参数有没有错误，具体是什么错误呢，我会在后面贴图的。

 

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 

 

以上代码就是stm32f10x_conf.h中的一部分，我们再看下面的代码：

 

RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOB|RCC_APB2Periph_GPIOE, ENABLE);

 

这个函数是使能GPIOB和GPIOE端口的时钟的。GPIOB和GPIOE是属于APB2外设的所以用函数RCC_APB2PeriphClockCmd ( xxx , xxx) 来使能，我们在进RCC_APB2PeriphClockCmd ( xxx , xxx)函数里面看看：

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;

}

}

 

在这个函数里面就可以看见我们今天要学习的函数了，在这里我们就分析函数1，以点带面

1、assert_param(IS_RCC_APB2_PERIPH(RCC_APB2Periph));

2、assert_param(IS_FUNCTIONAL_STATE(NewState));

 

函数1里面的参数是IS_RCC_APB2_PERIPH(RCC_APB2Periph)，我们在进入这个函数里面看看：

这是一个宏定义

#define   IS_RCC_APB2_PERIPH(PERIPH)   ((((PERIPH) & 0xFFC00002) == 0x00) && ((PERIPH) != 0x00))

我们来计算一下，PERIPH   是我们传递的参数   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)，这是为什么呢，是因为用户在代码调试阶段很可能会输入错误的参数而出现错误，一般这种错误不会察觉到，所以当我们想检查这种错误的时候就定义USE_FULL_ASSERT，当我们完成工程项目开始投入生产以后，代码肯定是没有这方面的错误了，我们不需要程序在检查我们的参数了我们就不用定义USE_FULL_ASSERT。这样我们的代码会小一点。

所以我们在stm32f10x_conf.h中打开注释，这样就会检查我们代码中要求检查的参数了，当我们参数没有错误时，就相当于assert_param(1);，进入函数assert_param();观察，就会执行(void)0，意思就是什么也不执行，因为此时参数没有错误。

 

我们现在需要制造出一个错误，在观察函数是怎么执行的。

 

现在我们传递一个错误的参数

RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM3, ENABLE);

我们在计算一下，RCC_APB1Periph_TIM3 = 0x00000002

(PERIPH) & 0xFFC00002) ！= 0x00

所以IS_RCC_APB2_PERIPH(PERIPH)返回0

所以相当于assert_param(0);

进入assert_param();函数观察

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

就会执行这个函数assert_failed((uint8_t *)__FILE__, __LINE__)，我们解释一下这个函数是干什么的，这个函数是用户自己发挥的，想在这个函数里面干什么就干什么，它的原型程序里面没有，总之我没找到，后来我在网上看见一文章，他说他在官方例子main.c里面找到的，所以我就拷贝到我的main.c中，函数原型如下：

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 %d\r\n", file, line) 
  //用户可以在这里添加错误信息:比如打印出出错的文件名和行号

  // Infinite loop 
  while (1)
  {
  }
}

 

这个函数就是在程序运行时，可以打印出我们参数错误的文件和行号，我把这个函数修改为：

void assert_failed(u8* file, u32 line) 

{ 

printf("Wrong parameters value: file %s on line %d\r\n", file, line);

}

你也可以添加别的函数，总之能显示错误信息就ok，不一定用串口显示。

如果参数有错误的话，就会向串口打印出错误处的文件和行号，看下图是串口打印出的错误信息：

错误文件为stm32f10x_rcc.c   行号1098，我们在看一下程序是不是这里出现了参数错误，如下图：

还真是这里出现了参数错误，因为我们传递的参数是

RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM3, ENABLE);

 

这里我就基本介绍完了，下面在介绍几点。

 

1、assert_failed((uint8_t *)__FILE__, __LINE__)这个函数的__FILE__, __LINE__形参，可能是c语言自带的把，具体是怎么获取错误参数的文件和行号我也不知道。

 

2、加入我们传递的参数是RCC_APB2PeriphClockCmd(RCC_APB1Periph_TIM2, ENABLE);   虽然RCC_APB1Periph_TIM2是属于APB1的，则在程序运行时是打印不出错误参数的，因为RCC_APB1Periph_TIM2 和 RCC_APB2Periph_AFIO 都等于0x00000001，大家可以去stm32f10x_rcc.h文件去看。所以大家在使用参数检查功能时还要自己注意一下参数有没有错误。