assert_param

在STM32的固件库和提供的例程中,到处都可以见到assert_param()的使用。如果打开任何一个例程中的stm32f10x_conf.h文件,就可以看到实际上assert_param是一个宏定义;

在固件库中,它的作用就是检测传递给函数的参数是否是有效的参数。

举例说明:

  assert_param(IS_USART_ALL_PERIPH(USARTx));  

 这句代码用于检查参数USARTx是否有效,其中IS_USART_ALL_PERIPH(USARTx)是一个宏定义,如下:

#define IS_USART_ALL_PERIPH(PERIPH) (((PERIPH) == USART1) || \
                                     ((PERIPH) == USART2) || \
                                     ((PERIPH) == USART3) || \
                                     ((PERIPH) == USART4) || \
                                     ((PERIPH) == USART5) || \
                                     ((PERIPH) == USART6) || \
                                     ((PERIPH) == USART7) || \
                                     ((PERIPH) == USART8))

宏定义的功能是参数USARTx是USART1~USART8其中的一个,表示参数USARTx有效,返回true,否则返回false。

assert_param()也是一个宏,定义在stm32f4xx_conf.h中,具体如下

#ifdef  USE_FULL_ASSERT

/**
  * @brief  The assert_param macro is used for function's parameters check.
  * @param  expr: If expr is false, it calls assert_failed function
  *   which reports the name of the source file and the source
  *   line number of the call that failed. 
  *   If expr is true, it returns no value.
  * @retval None
  */
  #define assert_param(expr) ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))
/* Exported functions ------------------------------------------------------- */
  void assert_failed(uint8_t* file, uint32_t line);
#else
  #define assert_param(expr) ((void)0)
#endif /* USE_FULL_ASSERT */

#endif /* __STM32F4xx_CONF_H */

如果USE_FULL_ASSERT宏定义了,则执行下面的代码:

#define assert_param(expr) ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))  //表示参数expr为false,则执行后面的assert_failed()函数,__FILE__, __LINE__是标准库函数中的宏定义,表示文件名和行号
 void assert_failed(uint8_t* file, uint32_t line);  //申明该函数

如果USE_FULL_ASSERT没有宏定义,则执行((void)0),即什么都不做。

参考:https://www.cnblogs.com/leo0621/p/9435794.html

<think>好的,我现在要回答用户关于如何使用assert_param函数的问题。首先,我需要确认assert_param函数的一般用途。通常,在嵌入式开发中,特别是在STM32的标准库或HAL库中,assert_param被用来进行参数检查,确保传入函数的参数是有效的。比如,检查某个枚举值是否在允许的范围内。 接下来,我需要回忆assert_param的典型用法。用户可能希望看到示例代码,所以我应该提供一个简单的例子。例如,在配置GPIO时,检查引脚编号是否有效。这里需要用到assert_param(IS_GPIO_PIN(GPIO_Pin))这样的结构,其中IS_GPIO_PIN是一个宏,用于验证引脚值是否符合要求。 然后,用户可能需要了解如何启用或禁用这些断言。通常在stm32fxxx_hal_conf.h文件中,通过定义USE_FULL_ASSERT宏来开启断言功能。如果未定义该宏,assert_param会被定义为空,从而不进行参数检查,这样可以减少代码大小和运行时间。 另外,可能需要解释如何自定义断言失败的处理方式。默认情况下,断言失败会调用assert_failed函数,用户需要在自己的代码中实现这个函数,通常包括打印错误信息或进入死循环等处理。 还要注意用户提到的示例代码是否符合他们的需求。根据用户提供的引用内容,他们可能希望看到类似引用[1]中的宏检查方式,比如使用BOOST_VMD_ASSERT_IS_NUMBER宏的例子。虽然assert_param的具体实现不同,但结构上类似,都是通过宏进行参数验证。 需要确保回答的结构清晰,分步骤说明用法、示例、配置方法和自定义处理。同时,要指出相关的引用来源,比如在STM32的HAL库中的配置方法,可能参考了类似引用[2]和引用[3]中的函数分析结构,但需要确认是否有直接关联。不过由于用户提供的引用可能与assert_param无直接关系,所以可能不需要直接引用,但需要保持回答的准确性和实用性。 最后,生成相关问题,帮助用户进一步理解,比如断言的使用场景、禁用影响、自定义处理等。</think>### 如何正确使用assert_param函数 `assert_param`函数常见于嵌入式开发(如STM32的标准库或HAL库),用于在运行时验证函数参数的合法性。若参数不满足条件,则触发断言失败,帮助开发者快速定位错误。 --- #### 1. **基本用法与示例** 在代码中,`assert_param`通常与参数校验宏结合使用。例如,在配置GPIO引脚时: ```c void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init) { assert_param(IS_GPIO_PIN(GPIO_Init->Pin)); // 检查引脚编号是否合法 assert_param(IS_GPIO_MODE(GPIO_Init->Mode)); // 检查模式是否合法 // 后续初始化逻辑 } ``` - `IS_GPIO_PIN`和`IS_GPIO_MODE`是库提供的校验宏,用于判断参数是否在允许范围内。 - 若参数非法,断言会触发错误处理(如输出日志或进入死循环)。 --- #### 2. **启用/禁用断言** 断言功能默认可能关闭,需在配置文件中手动启用: ```c // 在stm32fxxx_hal_conf.h中定义以下宏 #define USE_FULL_ASSERT 1 ``` - **启用时**:`assert_param`会执行参数检查。 - **禁用时**:`assert_param`会被定义为空宏,不产生额外代码[^1]。 --- #### 3. **自定义断言失败处理** 当断言触发时,默认会调用`assert_failed`函数。开发者需自行实现该函数以处理错误: ```c // 在用户代码中实现 void assert_failed(uint8_t *file, uint32_t line) { printf("Assert failed: File %s, Line %lu\n", file, line); while(1); // 死循环或重启系统 } ``` --- #### 4. **典型应用场景** - 检查函数输入参数的有效性(如寄存器地址、枚举值范围)。 - 验证硬件状态是否符合预期(如时钟配置是否正确)。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值