A21 STM32_HAL库函数 之 I2c通用驱动程序 -- B -- 所有函数的介绍及使用

本文详细介绍了STM32HAL库中I2C接口的各种通用驱动函数,包括初始化、通信、中断和DMA传输,以及相应的中断处理和错误回调机制。
摘要由CSDN通过智能技术生成

1 该驱动函数预览

序号函数名描述
1HAL_I2C_Init()初始化I2C总线。
2HAL_I2C_DeInit()反初始化I2C总线。
3HAL_I2C_MspInit()初始化MCU外设相关的I2C引脚或资源。
4HAL_I2C_MspDeInit()反初始化MCU外设相关的I2C引脚或资源。
5HAL_I2C_Master_Transmit()主机发送数据到I2C设备。
6HAL_I2C_Master_Receive()主机从I2C设备接收数据。
7HAL_I2C_Slave_Transmit()从I2C设备发送数据到主机。
8HAL_I2C_Slave_Receive()从I2C设备接收主机发送的数据。
9HAL_I2C_Master_Transmit_IT()使用中断发送数据到I2C设备。
10HAL_I2C_Master_Receive_IT()使用中断从I2C设备接收数据。
11HAL_I2C_Master_Sequential_Transmit_IT()使用中断连续发送数据到I2C设备。
12HAL_I2C_Master_Sequential_Receive_IT()使用中断连续从I2C设备接收数据。
13HAL_I2C_Slave_Transmit_IT()使用中断从I2C设备发送数据到主机。
14HAL_I2C_Slave_Receive_IT()使用中断从I2C设备接收主机发送的数据。
15HAL_I2C_Slave_Sequential_Transmit_IT()使用中断连续从I2C设备发送数据到主机。
16HAL_I2C_Slave_Sequential_Receive_IT()使用中断连续从I2C设备接收主机发送的数据。
17HAL_I2C_EnableListen_IT()启用I2C设备的监听模式,并使用中断处理监听事件。
18HAL_I2C_DisableListen_IT()禁用I2C设备的监听模式。
19HAL_I2C_Master_Transmit_DMA()使用DMA发送数据到I2C设备。
20HAL_I2C_Master_Receive_DMA()使用DMA从I2C设备接收数据。
21HAL_I2C_Master_Abort_IT()使用中断终止I2C主机模式下的传输。
22HAL_I2C_Slave_Transmit_DMA()使用DMA从I2C设备发送数据到主机。
23HAL_I2C_Slave_Receive_DMA()使用DMA从I2C设备接收主机发送的数据。
24HAL_I2C_Mem_Write()写入I2C外设的存储器。
25HAL_I2C_Mem_Read()从I2C外设的存储器读取数据。
26HAL_I2C_Mem_Write_IT()使用中断写入I2C外设的存储器。
27HAL_I2C_Mem_Read_IT()使用中断从I2C外设的存储器读取数据。
28HAL_I2C_Mem_Write_DMA()使用DMA写入I2C外设的存储器。
29HAL_I2C_Mem_Read_DMA()使用DMA从I2C外设的存储器读取数据。
30HAL_I2C_IsDeviceReady()检测I2C设备是否准备好。
31HAL_I2C_EV_IRQHandler()I2C事件中断处理程序。
32HAL_I2C_ER_IRQHandler()I2C错误中断处理程序。
33HAL_I2C_MasterT

xCpltCallback() | I2C主机发送完成回调函数。 |
| 34 | HAL_I2C_MasterRxCpltCallback() | I2C主机接收完成回调函数。 |
| 35 | HAL_I2C_SlaveTxCpltCallback() | I2C从机发送完成回调函数。 |
| 36 | HAL_I2C_SlaveRxCpltCallback() | I2C从机接收完成回调函数。 |
| 37 | HAL_I2C_AddrCallback() | I2C地址匹配回调函数。 |
| 38 | HAL_I2C_ListenCpltCallback() | I2C监听模式完成回调函数。 |
| 39 | HAL_I2C_MemTxCpltCallback() | I2C存储器发送完成回调函数。 |
| 40 | HAL_I2C_MemRxCpltCallback() | I2C存储器接收完成回调函数。 |
| 41 | HAL_I2C_ErrorCallback() | I2C错误回调函数。 |
| 42 | HAL_I2C_AbortCpltCallback() | I2C终止完成回调函数。 |
| 43 | HAL_I2C_GetState() | 获取I2C总线的状态。 |
| 44 | HAL_I2C_GetMode() | 获取I2C总线的模式。 |
| 45 | HAL_I2C_GetError() | 获取I2C总线的错误状态。 |

以下是使用模板:

#include "stm32f4xx_hal.h"

int main(void) {
    // HAL初始化
    HAL_Init();
    
    // 初始化MCU外设相关的I2C引脚或资源
    HAL_I2C_MspInit();
    
    // 初始化I2C总线
    HAL_I2C_Init();
    
    // 进行其他操作...
    
    // 主机发送数据到I2C设备
    HAL_I2C_Master_Transmit();
    
    // 主机从I2C设备接收数据
    HAL_I2C_Master_Receive();
    
    // 从I2C设备发送数据到主机
    HAL_I2C_Slave_Transmit();
    
    // 从I2C设备接收主机发送的数据
    HAL_I2C_Slave_Receive();
    
    // 使用中断发送数据到I2C设备
    HAL_I2C_Master_Transmit_IT();
    
    // 使用中断从I2C设备接收数据
    HAL_I2C_Master_Receive_IT();
    
    // 使用DMA发送数据到I2C设备
    HAL_I2C_Master_Transmit_DMA();
    
    // 使用DMA从I2C设备接收数据
    HAL_I2C_Master_Receive_DMA();
    
    // I2C事件中断处理程序
    HAL_I2C_EV_IRQHandler();
    
    // I2C错误中断处理程序
    HAL_I2C_ER_IRQHandler();
    
    // 获取I2C总线的状态
    uint32_t i2cState = HAL_I2C_GetState();
    
    // 获取I2C总线的模式
    uint32_t i2cMode = HAL_I2C_GetMode();
    
    // 获取I2C总线的错误状态
    uint32_t i2cError = HAL_I2C_GetError();
    
    // 反初始化I2C总线
    HAL_I2C_DeInit();
    
    // 反初始化MCU外设相关的I2C引脚或资源
    HAL_I2C_MspDeInit();
    
    return 0;
}

1.12 HAL_I2C_Master_Sequential_Receive_IT

函数名HAL_I2C_Master_Sequential_Receive_IT
函数原形HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
功能描述通过中断以顺序传输方式从 I2C 从机接收数据
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2DevAddress:从机地址
输入参数 3pData:指向存储接收数据的缓冲区
输入参数 4Size:要接收的数据长度
输入参数 5XferOptions:传输选项
输出参数
返回值HAL_StatusTypeDef:接收状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.13 HAL_I2C_Slave_Transmit_IT

函数名HAL_I2C_Slave_Transmit_IT
函数原形HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
功能描述通过中断发送数据到 I2C 主机

输入参数 1 | hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体 |
| 输入参数 2 | pData:指向要发送的数据缓冲区 |
| 输入参数 3 | Size:要发送的数据长度 |
| 输出参数 | 无 |
| 返回值 | HAL_StatusTypeDef:传输状态,可以是 HAL_OK 或 HAL_ERROR |
| 先决条件 | 无 |
| 被调用函数 | 无 |


1.14 HAL_I2C_Slave_Receive_IT

函数名HAL_I2C_Slave_Receive_IT
函数原形HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
功能描述通过中断从 I2C 主机接收数据
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2pData:指向存储接收数据的缓冲区
输入参数 3Size:要接收的数据长度
输出参数
返回值HAL_StatusTypeDef:接收状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.15 HAL_I2C_Slave_Sequential_Transmit_IT

函数名HAL_I2C_Slave_Sequential_Transmit_IT
函数原形HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
功能描述通过中断以顺序传输方式发送数据到 I2C 主机
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2pData:指向要发送的数据缓冲区
输入参数 3Size:要发送的数据长度
输入参数 4XferOptions:传输选项
输出参数
返回值HAL_StatusTypeDef:传输状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.16 HAL_I2C_Slave_Sequential_Receive_IT

函数名HAL_I2C_Slave_Sequential_Receive_IT
函数原形HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
功能描述通过中断以顺序传输方式从 I2C 主机接收数据
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2pData:指向存储接收数据的缓冲区
输入参数 3Size:要接收的数据长度
输入参数 4XferOptions:传输选项
输出参数
返回值HAL_StatusTypeDef:接收状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.17 HAL_I2C_EnableListen_IT

函数名HAL_I2C_EnableListen_IT
函数原形HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c)
功能描述使能 I2C 的监听模式
输入参数hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.18 HAL_I2C_DisableListen_IT

函数名HAL_I2C_DisableListen_IT
函数原形HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c)
功能描述禁用 I2C 的监听模式
输入参数hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.19 HAL_I2C_Master_Transmit_DMA

函数名HAL_I2C_Master_Transmit_DMA
函数原形HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size)
功能描述通过 DMA 发送数据到 I2C 从机
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2DevAddress:从机地址
输入参数 3pData:指向要发送的数据缓冲区
输入参数 4Size:要发送的数据长度
输出参数
返回值HAL_StatusTypeDef:传输状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.20 HAL_I2C_Master_Receive_DMA

函数名HAL_I2C_Master_Receive_DMA
函数原形HAL_Status

TypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size) |
| 功能描述 | 通过 DMA 从 I2C 从机接收数据 |
| 输入参数 1 | hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体 |
| 输入参数 2 | DevAddress:从机地址 |
| 输入参数 3 | pData:指向存储接收数据的缓冲区 |
| 输入参数 4 | Size:要接收的数据长度 |
| 输出参数 | 无 |
| 返回值 | HAL_StatusTypeDef:接收状态,可以是 HAL_OK 或 HAL_ERROR |
| 先决条件 | 无 |
| 被调用函数 | 无 |


1.21 HAL_I2C_Master_Abort_IT

函数名HAL_I2C_Master_Abort_IT
函数原形HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c)
功能描述通过中断终止 I2C 主机的传输
输入参数hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.22 HAL_I2C_Slave_Transmit_DMA

函数名HAL_I2C_Slave_Transmit_DMA
函数原形HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
功能描述通过 DMA 发送数据到 I2C 主机
输入参数 1hi2c:I2C 句柄,指向一个 I2C_HandleTypeDef 结构体
输入参数 2pData:指向要发送的数据缓冲区
输入参数 3Size:要发送的数据长度
输出参数
返回值HAL_StatusTypeDef:传输状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

该文档修改记录:

修改时间修改说明
2024年4月30日第一次发布,介绍了该博客驱动所有函数的介绍及使用

总结

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

  • 17
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

常驻客栈

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

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

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

打赏作者

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

抵扣说明:

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

余额充值