assert_param函数详解

一、assert_param是什么

assert_param是STM32固件库中的函数，用于检查传入的参数是否合法。该函数的原型为assert_param()，在代码中使用时通常会被宏定义为以下形式：

#define assert_param(expr) ((void)0)

由此可见，如果表达式expr为真，则assert_param()函数不做任何操作，否则程序将进入死循环，表示传入的参数不合法。

二、assert_param的作用

在程序开发过程中，我们经常需要在函数中检查传入的参数是否合法。例如，在初始化GPIO口之前，需要检查GPIO口是否已经被使能，在设置ADC采样率之前，需要检查采样率是否符合ADC的要求。这些参数的检查需要花费大量的时间和精力，而assert_param函数正是为了解决这个问题而存在的。

assert_param函数能够大大简化参数检查的工作，同时能够提高代码的可读性和可维护性。使用assert_param函数，可以避免程序在使用不合法的参数时崩溃，提高了程序的稳定性和安全性。

三、assert_param的使用

assert_param函数通常用于STM32的固件库中，我们可以在我们的代码中使用这个函数来检查传入的参数是否合法。assert_param函数通常有如下几个步骤：

第一步，定义assert_param()函数：

#define assert_param(expr) ((void)0)

第二步，根据表达式，判断参数是否合法：

if(expr)
{
    // do nothing
}
else
{
    assert_param_failed(file, line);
}

第三步，当参数不合法时，调用assert_param_failed()函数：

void assert_param_failed(uint8_t *file, uint32_t line)
{
    // 程序运行到这里表示执行了不合法的操作，需要进行相应的处理
    while (1)
    {
        // 程序进入死循环
    }
}

在使用assert_param函数时，需要注意以下几点：

1、assert_param函数仅用于检查传入的参数是否合法，不作为程序中断或调试的依据；

2、在使用assert_param函数时，需要确保被检查的参数已经被正确初始化，否则可能会出现错误的判断结果；

3、在使用assert_param函数时，需要确保被检查的参数不会修改被编译器优化掉，否则可能会导致assert_param函数失效。

四、assert_param的示例代码

下面是一个使用assert_param函数的示例程序，该程序功能是通过LM35传感器采集环境温度，并将温度值通过串口输出：

#include "stm32f10x.h"
#include "stdio.h"

#define assert_param(expr) ((void)0)

USART_InitTypeDef USART_InitStructure;
GPIO_InitTypeDef GPIO_InitStructure;
ADC_InitTypeDef ADC_InitStructure;

void delay_ms(unsigned long n)
{
    unsigned long i;
    for(i=0;i<n;i++);
}

void USARTx_SendChar(USART_TypeDef *USARTx, char Data)
{
    while (USART_GetFlagStatus(USARTx, USART_FLAG_TXE) == RESET);
    USART_SendData(USARTx, Data);
}

void USARTx_SendString(USART_TypeDef *USARTx, char *str)
{
    while(*str != '\0')
    {
        USARTx_SendChar(USARTx, *str);
        str++;
    }
}

int main(void)
{
    float temp = 0.0;
    char buffer[50] = {0};

    RCC_APB2PeriphClockCmd(RCC_APB2Periph_USART1 | RCC_APB2Periph_GPIOA | RCC_APB2Periph_ADC1, ENABLE);

    GPIO_InitStructure.GPIO_Pin = GPIO_Pin_9;
    GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;
    GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF_PP;
    GPIO_Init(GPIOA, &GPIO_InitStructure);

    GPIO_InitStructure.GPIO_Pin = GPIO_Pin_10;
    GPIO_InitStructure.GPIO_Mode = GPIO_Mode_IN_FLOATING;
    GPIO_Init(GPIOA, &GPIO_InitStructure);

    USART_InitStructure.USART_BaudRate = 115200;
    USART_InitStructure.USART_WordLength = USART_WordLength_8b;
    USART_InitStructure.USART_StopBits = USART_StopBits_1;
    USART_InitStructure.USART_Parity = USART_Parity_No ;
    USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;
    USART_InitStructure.USART_Mode = USART_Mode_Tx;

    USART_Init(USART1, &USART_InitStructure);
    USART_ITConfig(USART1, USART_IT_RXNE, ENABLE);
    USART_Cmd(USART1, ENABLE);

    ADC_InitStructure.ADC_Mode = ADC_Mode_Independent;
    ADC_InitStructure.ADC_ScanConvMode = DISABLE;
    ADC_InitStructure.ADC_ContinuousConvMode = ENABLE;
    ADC_InitStructure.ADC_ExternalTrigConv = ADC_ExternalTrigConv_None;
    ADC_InitStructure.ADC_DataAlign = ADC_DataAlign_Right;
    ADC_InitStructure.ADC_NbrOfChannel = 1;
    ADC_Init(ADC1, &ADC_InitStructure);

    ADC_RegularChannelConfig(ADC1, ADC_Channel_0, 1, ADC_SampleTime_239Cycles5);

    ADC_Cmd(ADC1, ENABLE);
    delay_ms(10);
    ADC_SoftwareStartConvCmd(ADC1, ENABLE);

    while (1)
    {
        while(ADC_GetFlagStatus(ADC1, ADC_FLAG_EOC) == RESET);
        temp = (float)ADC_GetConversionValue(ADC1)*3.3/4096*1000/10;
        sprintf(buffer, "Temperature = %.2f\r\n", temp);
        USARTx_SendString(USART1, buffer);
        delay_ms(1000);
    }
}

在上述代码中，我们使用assert_param函数来检查串口和ADC的初始化参数是否合法：

USART_Init(USART1, &USART_InitStructure);
ADC_Init(ADC1, &ADC_InitStructure);

这里需要注意的是，在使用assert_param函数时，需要先定义一个常量，以便在assert_param_failed()函数中使用：

#define FILE_NAME        __FILE__

assert_param_failed()函数的代码如下：

void assert_param_failed(uint8_t *file, uint32_t line)
{
    char buffer[50] = {0};
    sprintf(buffer, "assert_param_failed - file %s, line %d\r\n", file, line);
    USARTx_SendString(USART1, buffer);

    while (1)
    {
        // 程序进入死循环
    }
}

在上述代码中，我们使用串口将错误信息输出，以方便我们进行调试和错误定位。