A24 STM32_HAL库函数 之 I2s通用驱动 -- A-- 所有函数的介绍及使用

本文详细介绍了STM32HAL库中I2S接口的各种通用驱动函数,包括初始化、反初始化、数据传输、中断和DMA操作,以及相应的回调函数和状态管理。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1 该驱动函数预览

序号函数名描述
1HAL_I2S_Init()初始化I2S接口。
2HAL_I2S_DeInit()反初始化I2S接口。
3HAL_I2S_MspInit()初始化MCU外设相关的I2S引脚或资源。
4HAL_I2S_MspDeInit()反初始化MCU外设相关的I2S引脚或资源。
5HAL_I2S_Transmit()通过I2S接口发送数据。
6HAL_I2S_Receive()通过I2S接口接收数据。
7HAL_I2S_Transmit_IT()使用中断发送数据通过I2S接口。
8HAL_I2S_Receive_IT()使用中断接收数据通过I2S接口。
9HAL_I2S_Transmit_DMA()使用DMA发送数据通过I2S接口。
10HAL_I2S_Receive_DMA()使用DMA接收数据通过I2S接口。
11HAL_I2S_DMAPause()暂停I2S DMA传输。
12HAL_I2S_DMAResume()恢复I2S DMA传输。
13HAL_I2S_DMAStop()停止I2S DMA传输。
14HAL_I2S_IRQHandler()I2S中断处理程序。
15HAL_I2S_TxHalfCpltCallback()I2S发送半完成回调函数。
16HAL_I2S_TxCpltCallback()I2S发送完成回调函数。
17HAL_I2S_RxHalfCpltCallback()I2S接收半完成回调函数。
18HAL_I2S_RxCpltCallback()I2S接收完成回调函数。
19HAL_I2S_ErrorCallback()I2S错误回调函数。
20HAL_I2S_GetState()获取I2S接口的状态。
21HAL_I2S_GetError()获取I2S接口的错误状态。

以下是使用模板:

#include "stm32f4xx_hal.h"

int main(void) {
    // HAL初始化
    HAL_Init();
    
    // 初始化MCU外设相关的I2S引脚或资源
    HAL_I2S_MspInit();
    
    // 初始化I2S接口
    HAL_I2S_Init();
    
    // 进行其他操作...
    
    // 通过I2S接口发送数据
    HAL_I2S_Transmit();
    
    // 通过I2S接口接收数据
    HAL_I2S_Receive();
    
    // 使用DMA发送数据通过I2S接口
    HAL_I2S_Transmit_DMA();
    
    // 使用DMA接收数据通过I2S接口
    HAL_I2S_Receive_DMA();
    
    // I2S中断处理程序
    HAL_I2S_IRQHandler();
    
    // 获取I2S接口的状态
    uint32_t i2sState = HAL_I2S_GetState();
    
    // 获取I2S接口的错误状态
    uint32_t i2sError = HAL_I2S_GetError();
    
    // 反初始化I2S接口
    HAL_I2S_DeInit();
    
    // 反初始化MCU外设相关的I2S引脚或资源
    HAL_I2S_MspDeInit();
    
    return 0;
}

1.1 HAL_I2S_Init

函数名HAL_I2S_Init
函数原形HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s)
功能描述初始化 I2S 外设
输入参数hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.2 HAL_I2S_DeInit

函数名HAL_I2S_DeInit
函数原形HAL_StatusTypeDef HAL_I2S_DeInit(I2S_HandleTypeDef *hi2s)
功能描述反初始化 I2S 外设
输入参数hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.3 HAL_I2S_MspInit

函数名HAL_I2S_MspInit
函数原形void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s)
功能描述初始化 I2S 外设的 GPIO、时钟和 DMA 配置
输入参数hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.4 HAL_I2S_MspDeInit

函数名HAL_I2S_MspDeInit
函数原形void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s)
功能描述反初始化 I2S 外设的 GPIO、时钟和 DMA 配置
输入参数hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输出参数
返回值
先决条件
被调用函数

1.5 HAL_I2S_Transmit

函数名HAL_I2S_Transmit
函数原形HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)
功能描述通过 I2S 外设发送数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向发送数据的缓冲区
输入参数 3Size:要发送的数据长度
输入参数 4Timeout:超时时间
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.6 HAL_I2S_Receive

函数名HAL_I2S_Receive
函数原形HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout)
功能描述通过 I2S 外设接收数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向接收数据的缓冲区
输入参数 3Size:要接收的数据长度
输入参数 4Timeout:超时时间
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.7 HAL_I2S_Transmit_IT

函数名HAL_I2S_Transmit_IT
函数原形HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
功能描述使用中断方式通过 I2S 外设发送数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向发送数据的缓冲区
输入参数 3Size:要发送的数据长度
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.8 HAL_I2S_Receive_IT

函数名HAL_I2S_Receive_IT
函数原形HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
功能描述使用中断方式通过 I2S 外设接收数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向接收数据的缓冲区
输入参数 3Size:要接收的数据长度
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.9 HAL_I2S_Transmit_DMA

函数名HAL_I2S_Transmit_DMA
函数原形HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
功能描述使用 DMA 方式通过 I2S 外设发送数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向发送数据的缓冲区
输入参数 3Size:要发送的数据长度
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

1.10 HAL_I2S_Receive_DMA

函数名HAL_I2S_Receive_DMA
函数原形HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size)
功能描述使用 DMA 方式通过 I2S 外设接收数据
输入参数 1hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体
输入参数 2pData:指向接收数据的缓冲区
输入参数 3Size:要接收的数据长度
输出参数
返回值HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR
先决条件
被调用函数

该文档修改记录:

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

总结

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

### 使用STM32 HAL配置I2S时钟频率 #### 配置I2S时钟源 对于STM32系列微控制器,I2S外设依赖于特定的时钟源来工作。通常情况下,这些时钟源可以是PLL(锁相环)、HSI(内部高速RC振荡器)或HSE(外部高速晶体)。为了确保I2S能够正常运行并达到所需的采样率,必须先正确配置其时钟源。 在大多数应用中,推荐使用PLL作为I2S的时钟输入,因为这能提供更稳定和精确的时间基准[^1]。具体来说,在基于STM32F407这样的设备上,可以通过调整PLL参数使系统时钟(SYSCLK)达到最大值168 MHz,并进一步通过分频得到适合I2S使用的频率[^3]。 #### 初始化I2S模块与时钟设置 要初始化I2S接口及其关联的SPI硬件资源,需调用`HAL_I2S_Init()`函数前完成必要的RCC(Restart and Clock Control)寄存器编程以设定合适的时钟路径与频率分配给I2S外设。下面是一个简单的例子展示如何利用HAL来进行基本的I2S初始化: ```c // 定义 I2S handle 结构体实例 I2S_HandleTypeDef hi2s; void MX_I2S3_Init(void) { // 设置 I2S 的模式和其他属性... // 这里省略了其他成员变量的具体赋值 /* 初始化 I2S */ if (HAL_I2S_Init(&hi2s) != HAL_OK) { Error_Handler(); } } ``` 需要注意的是,在实际项目开发过程中,应该根据具体的芯片型号查阅官方数据手册以及参考手册中的详细说明来决定最适合的应用场景下的最佳实践方法[^2]。 #### 调整I2S时钟频率 当涉及到改变I2S的工作速率即采样频率时,则需要修改相应的定时器预分频系数或者更改PLL输出到APB/APBX总线上用于驱动I2S部分的比例因子。例如,如果希望获得48kHz的标准音频采样率,就需要计算出恰当的分频数值使得最终产生的位周期符合这一标准。 此外,还可以借助CubeMX工具自动生成初始代码框架,它可以帮助开发者快速搭建起包含所需外设在内的工程模板文件夹结构,从而简化手动编写复杂配置的过程。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

常驻客栈

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

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

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

打赏作者

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

抵扣说明:

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

余额充值