A5 STM32_HAL库函数 之 CAN通用驱动程序所有函数的介绍及使用

1 CAN通用驱动程序所有函数预览

序号函数名描述
1HAL_CAN_Init()初始化CAN外设。
2HAL_CAN_ConfigFilter()配置CAN过滤器。
3HAL_CAN_DeInit()反初始化CAN外设。
4HAL_CAN_MspInit()初始化MCU外设相关的CAN引脚或资源。
5HAL_CAN_MspDeInit()反初始化MCU外设相关的CAN引脚或资源。
6HAL_CAN_Transmit()同步发送CAN消息。
7HAL_CAN_Transmit_IT()异步发送CAN消息,使用中断处理发送完成。
8HAL_CAN_Receive()同步接收CAN消息。
9HAL_CAN_Receive_IT()异步接收CAN消息,使用中断处理接收完成。
10HAL_CAN_Sleep()进入CAN休眠模式。
11HAL_CAN_WakeUp()唤醒CAN设备。
12HAL_CAN_IRQHandler()CAN中断处理程序。
13HAL_CAN_TxCpltCallback()CAN发送完成回调函数。
14HAL_CAN_RxCpltCallback()CAN接收完成回调函数。
15HAL_CAN_ErrorCallback()CAN错误回调函数。
16HAL_CAN_GetState()获取CAN状态。
17HAL_CAN_GetError()获取CAN错误状态。

使用模板:

#include "stm32f4xx_hal.h"

int main(void) {
    // HAL初始化
    HAL_Init();
    
    // 初始化MCU外设相关的引脚或资源
    HAL_MspInit();
    
    // 初始化CAN外设
    HAL_CAN_Init();
    
    // 配置CAN过滤器
    HAL_CAN_ConfigFilter();
    
    // 启动CAN设备
    
    // 进行其他操作...
    
    // 发送CAN消息
    HAL_CAN_Transmit();
    
    // 异步发送CAN消息
    HAL_CAN_Transmit_IT();
    
    // 接收CAN消息
    HAL_CAN_Receive();
    
    // 异步接收CAN消息
    HAL_CAN_Receive_IT();
    
    // 进入CAN休眠模式
    HAL_CAN_Sleep();
    
    // 唤醒CAN设备
    HAL_CAN_WakeUp();
    
    // 获取CAN状态
    uint32_t canState = HAL_CAN_GetState();
    
    // 获取CAN错误状态
    uint32_t canError = HAL_CAN_GetError();
    
    // 反初始化CAN外设
    HAL_CAN_DeInit();
    
    // 反初始化MCU外设相关的引脚或资源
    HAL_MspDeInit();
    
    return 0;
}

1.1 HAL_CAN_Init

函数名HAL_CAN_Init
函数原形HAL_StatusTypeDef HAL_CAN_Init(CAN_HandleTypeDef* hcan)
功能描述初始化 CAN 控制器
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:初始化结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.2 HAL_CAN_ConfigFilter

函数名HAL_CAN_ConfigFilter
函数原形HAL_StatusTypeDef HAL_CAN_ConfigFilter(CAN_HandleTypeDef* hcan, CAN_FilterTypeDef* sFilter)
功能描述配置 CAN 过滤器
输入参数 1hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输入参数 2sFilter:CAN 过滤器配置结构体,包含过滤器编号、模式、掩码等信息
输出参数
返回值HAL_StatusTypeDef:配置结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.3 HAL_CAN_DeInit

函数名HAL_CAN_DeInit
函数原形HAL_StatusTypeDef HAL_CAN_DeInit(CAN_HandleTypeDef* hcan)
功能描述反初始化 CAN 控制器
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:反初始化结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.4 HAL_CAN_MspInit

函数名HAL_CAN_MspInit
函数原形void HAL_CAN_MspInit(CAN_HandleTypeDef* hcan)
功能描述CAN 外设底层初始化,典型的用途是配置外设的时钟和引脚
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.5 HAL_CAN_MspDeInit

函数名HAL_CAN_MspDeInit
函数原形void HAL_CAN_MspDeInit(CAN_HandleTypeDef* hcan)
功能描述CAN 外设底层反初始化,典型的用途是恢复外设的默认配置
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.6 HAL_CAN_Transmit

函数名HAL_CAN_Transmit
函数原形HAL_StatusTypeDef HAL_CAN_Transmit(CAN_HandleTypeDef* hcan, uint32_t Timeout)
功能描述启动 CAN 数据传输
输入参数 1hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输入参数 2Timeout:传输超时时间,单位为毫秒
输出参数
返回值HAL_StatusTypeDef:传输结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.7 HAL_CAN_Transmit_IT

函数名HAL_CAN_Transmit_IT
函数原形HAL_StatusTypeDef HAL_CAN_Transmit_IT(CAN_HandleTypeDef* hcan)
功能描述以中断方式启动 CAN 数据传输
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:传输结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.8 HAL_CAN_Receive

函数名HAL_CAN_Receive
函数原形HAL_StatusTypeDef HAL_CAN_Receive(CAN_HandleTypeDef* hcan, uint8_t FIFONumber, uint32_t Timeout)
功能描述接收 CAN 数据
输入参数 1hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输入参数 2FIFONumber:FIFO 编号,可以是 CAN_FIFO0 或 CAN_FIFO1
输入参数 3Timeout:接收超时时间,单位为毫秒
输出参数
返回值HAL_StatusTypeDef:接收结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.9 HAL_CAN_Receive_IT

函数名HAL_CAN_Receive_IT
函数原形HAL_StatusTypeDef HAL_CAN_Receive_IT(CAN_HandleTypeDef* hcan, uint8_t FIFONumber)
功能描述以中断方式启动 CAN 数据接收
输入参数 1hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输入参数 2FIFONumber:FIFO 编号,可以是 CAN_FIFO0 或 CAN_FIFO1
输出参数
返回值HAL_StatusTypeDef:接收结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.10 HAL_CAN_Sleep

函数名HAL_CAN_Sleep
函数原形HAL_StatusTypeDef HAL_CAN_Sleep(CAN_HandleTypeDef* hcan)
功能描述进入 CAN 休眠模式
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.11 HAL_CAN_WakeUp

函数名HAL_CAN_WakeUp
函数原形HAL_StatusTypeDef HAL_CAN_WakeUp(CAN_HandleTypeDef* hcan)
功能描述唤醒 CAN 控制器
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作结果,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.12 HAL_CAN_IRQHandler

函数名HAL_CAN_IRQHandler
函数原形void HAL_CAN_IRQHandler(CAN_HandleTypeDef* hcan)
功能描述CAN 中断处理函数
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.13 HAL_CAN_TxCpltCallback

函数名HAL_CAN_TxCpltCallback
函数原形void HAL_CAN_TxCpltCallback(CAN_HandleTypeDef* hcan)
功能描述CAN 数据传输完成回调函数
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.14 HAL_CAN_RxCpltCallback

函数名HAL_CAN_RxCpltCallback
函数原形void HAL_CAN_RxCpltCallback(CAN_HandleTypeDef* hcan)
功能描述CAN 数据接收完成回调函数
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.15 HAL_CAN_ErrorCallback

函数名HAL_CAN_ErrorCallback
函数原形void HAL_CAN_ErrorCallback(CAN_HandleTypeDef *hcan)
功能描述CAN 错误处理回调函数
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.16 HAL_CAN_GetState

函数名HAL_CAN_GetState
函数原形uint32_t HAL_CAN_GetState(CAN_HandleTypeDef* hcan)
功能描述获取 CAN 控制器状态
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值uint32_t:CAN 控制器状态,可能的值有:
                            - HAL_CAN_STATE_READY:就绪状态
                            - HAL_CAN_STATE_BUSY:忙碌状态
                            - HAL_CAN_STATE_BUSY_TX:忙碌发送状态
                            - HAL_CAN_STATE_BUSY_RX:忙碌接收状态
                            - HAL_CAN_STATE_BUSY_TX_RX:忙碌发送接收状态
                            - HAL_CAN_STATE_TIMEOUT:超时状态
                            - HAL_CAN_STATE_ERROR:错误状态 |

| 先决条件 | 无 |
| 被调用函数 | 无 |


1.17 HAL_CAN_GetError

函数名HAL_CAN_GetError
函数原形uint32_t HAL_CAN_GetError(CAN_HandleTypeDef* hcan)
功能描述获取 CAN 错误状态
输入参数hcan:CAN 句柄,指向一个 CAN_HandleTypeDef 结构体
输出参数
返回值uint32_t:CAN 错误状态,可能的值有:
                            - HAL_CAN_ERROR_NONE:无错误
                            - HAL_CAN_ERROR_EWG:错误警告
                            - HAL_CAN_ERROR_EPV:误差传动器警告
                            - HAL_CAN_ERROR_BOF:总线关闭错误
                            - HAL_CAN_ERROR_LEC:最后的错误代码
                            - HAL_CAN_ERROR_SOF:起始帧错误
                            - HAL_CAN_ERROR_ACK:确认错误
                            - HAL_CAN_ERROR_BR:位错误
                            - HAL_CAN_ERROR_BD:数据错误 |

| 先决条件 | 无 |
| 被调用函数 | 无 |

该文档修改记录:

修改时间修改说明
2024年4月8日第一次发布,介绍了 A5 STM32_HAL库函数 之 CAN通用驱动程序所有函数的介绍及使用

总结

以上就是A5 STM32_HAL库函数 之 CAN通用驱动程序所有函数的介绍及使用的内容。
有不明白的地方欢迎留言;有建议欢迎留言,我后面编写文档好改进。
创作不容,如果文档对您有帮助,记得给个赞。

  • 20
    点赞
  • 24
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
以下是STM32G单片机HAL库函数HAL_FLASHEx_Erase的代码实现及解析: ```c HAL_StatusTypeDef HAL_FLASHEx_Erase(FLASH_EraseInitTypeDef *pEraseInit, uint32_t *SectorError) { uint32_t nbSectorsToErase = 0U; uint32_t sectorErrorTmp; uint32_t sectorErrorMask; HAL_StatusTypeDef status = HAL_OK; /* Check the parameters */ assert_param(IS_FLASH_TYPEERASE(pEraseInit->TypeErase)); assert_param(IS_FLASH_BANK_EXCLUSIVE(pEraseInit->Banks)); assert_param(IS_FLASH_NBSECTORS(pEraseInit->NbSectors)); /* Wait for last operation to be completed */ status = FLASH_WaitForLastOperation(FLASH_TIMEOUT_VALUE); if (status != HAL_OK) { return status; } /* Clear OPTVERR bit set on virgin samples */ __HAL_FLASH_CLEAR_FLAG(FLASH_FLAG_OPTVERR); /* Get the number of sectors to erase from 1st sector*/ nbSectorsToErase = pEraseInit->NbSectors; /* Check if there are any sectors to erase */ if (nbSectorsToErase == 0U) { return HAL_ERROR; } /* Initialize sectorErrorMask to 0 */ sectorErrorMask = 0U; /* Erase by sector by sector to have a higher granularity than the page erase */ while (nbSectorsToErase > 0U) { /* Fill EraseInit structure*/ pEraseInit->TypeErase = FLASH_TYPEERASE_SECTORS; /* Select the bank to erase */ if (pEraseInit->Banks == FLASH_BANK_1) { pEraseInit->Bank = FLASH_BANK_1; } #if defined(FLASH_BANK_2) else if (pEraseInit->Banks == FLASH_BANK_2) { pEraseInit->Bank = FLASH_BANK_2; } #endif /* FLASH_BANK_2 */ /* Get the sector to erase */ uint32_t sectorNb = FLASH_SECTOR_0; for (uint32_t i = 0; i < FLASH_SECTOR_NUMBER; i++) { if (pEraseInit->Sector & (1UL << i)) { sectorNb = i; break; } } pEraseInit->Sector = sectorNb; /* Call the erase module */ HAL_FLASHEx_Erase_IT(pEraseInit); /* Wait for last operation to be completed */ status = FLASH_WaitForLastOperation(FLASH_TIMEOUT_VALUE); /* If the erase operation is completed, disable the SER Bit */ CLEAR_BIT(FLASH->CR, FLASH_CR_SER); if (status != HAL_OK) { /* In case of error, stop erase procedure and return the faulty sector */ sectorErrorMask |= (1UL << sectorNb); /* Save the error code */ sectorErrorTmp |= status; } else { /* No error occurred in sector erase operation sectorErrorMask is reset */ sectorErrorMask = 0U; } /* Decrement number of sectors to erase */ nbSectorsToErase--; /* Point on next sector */ pEraseInit->Sector = (uint32_t)(pEraseInit->Sector << 1U); } /* Return the erase status */ if (SectorError != NULL) { *SectorError = sectorErrorTmp; } if (sectorErrorMask != 0U) { status = HAL_ERROR; } return status; } ``` HAL_FLASHEx_Erase函数的实现过程如下: 1. 检查输入参数pEraseInit是否合法。该结构体包含了要擦除的Flash扇区的相关信息,如起始地址、扇区数量和擦除方式等。 2. 等待上一次Flash操作(如写入或擦除)完成,并且清除OPTVERR标志位。如果等待超时,则返回错误。 3. 计算需要擦除的Flash扇区数量,并且检查是否有扇区需要擦除。如果扇区数量为0,则直接返回错误。 4. 循环执行Flash扇区擦除操作,直到所有需要擦除的扇区都被擦除。具体的操作包括: - 将需要擦除的扇区信息填入FLASH_EraseInitTypeDef结构体中,并且调用HAL_FLASHEx_Erase_IT函数执行擦除操作。 - 等待Flash擦除操作完成,并且检查是否有错误发生。如果发生了错误,则保存错误信息,但是继续执行擦除操作直到所有需要擦除的扇区都被擦除。 - 将擦除完成的扇区数量减1,继续执行下一个扇区的擦除操作。 5. 返回擦除操作的结果。如果有错误发生,则返回错误代码;否则,返回HAL_OK表示操作成功。 需要注意的是,该函数执行期间会禁止中断,并且解锁Flash,并且在函数执行完毕之后会恢复中断,并且重新锁定Flash。因此,在调用该函数之前,需要确保中断不会影响到Flash的操作,并且需要适当地设置Flash的保护等级以避免意外修改Flash。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

常驻客栈

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值