A25 STM32_HAL库函数 之 I2s通用驱动 -- B-- 所有函数的介绍及使用
1 该驱动函数预览
序号 | 函数名 | 描述 |
---|
1 | HAL_I2S_Init() | 初始化I2S接口。 |
2 | HAL_I2S_DeInit() | 反初始化I2S接口。 |
3 | HAL_I2S_MspInit() | 初始化MCU外设相关的I2S引脚或资源。 |
4 | HAL_I2S_MspDeInit() | 反初始化MCU外设相关的I2S引脚或资源。 |
5 | HAL_I2S_Transmit() | 通过I2S接口发送数据。 |
6 | HAL_I2S_Receive() | 通过I2S接口接收数据。 |
7 | HAL_I2S_Transmit_IT() | 使用中断发送数据通过I2S接口。 |
8 | HAL_I2S_Receive_IT() | 使用中断接收数据通过I2S接口。 |
9 | HAL_I2S_Transmit_DMA() | 使用DMA发送数据通过I2S接口。 |
10 | HAL_I2S_Receive_DMA() | 使用DMA接收数据通过I2S接口。 |
11 | HAL_I2S_DMAPause() | 暂停I2S DMA传输。 |
12 | HAL_I2S_DMAResume() | 恢复I2S DMA传输。 |
13 | HAL_I2S_DMAStop() | 停止I2S DMA传输。 |
14 | HAL_I2S_IRQHandler() | I2S中断处理程序。 |
15 | HAL_I2S_TxHalfCpltCallback() | I2S发送半完成回调函数。 |
16 | HAL_I2S_TxCpltCallback() | I2S发送完成回调函数。 |
17 | HAL_I2S_RxHalfCpltCallback() | I2S接收半完成回调函数。 |
18 | HAL_I2S_RxCpltCallback() | I2S接收完成回调函数。 |
19 | HAL_I2S_ErrorCallback() | I2S错误回调函数。 |
20 | HAL_I2S_GetState() | 获取I2S接口的状态。 |
21 | HAL_I2S_GetError() | 获取I2S接口的错误状态。 |
以下是使用模板:
#include "stm32f4xx_hal.h"
int main(void) {
HAL_Init();
HAL_I2S_MspInit();
HAL_I2S_Init();
HAL_I2S_Transmit();
HAL_I2S_Receive();
HAL_I2S_Transmit_DMA();
HAL_I2S_Receive_DMA();
HAL_I2S_IRQHandler();
uint32_t i2sState = HAL_I2S_GetState();
uint32_t i2sError = HAL_I2S_GetError();
HAL_I2S_DeInit();
HAL_I2S_MspDeInit();
return 0;
}
1.11 HAL_I2S_DMAPause
函数名 | HAL_I2S_DMAPause |
---|
函数原形 | HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s) |
功能描述 | 暂停 I2S 外设的 DMA 传输 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR |
先决条件 | 无 |
被调用函数 | 无 |
1.12 HAL_I2S_DMAResume
函数名 | HAL_I2S_DMAResume |
---|
函数原形 | HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s) |
功能描述 | 恢复 I2S 外设的 DMA 传输 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR |
先决条件 | 无 |
被调用函数 | 无 |
1.13 HAL_I2S_DMAStop
函数名 | HAL_I2S_DMAStop |
---|
函数原形 | HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s) |
功能描述 | 停止 I2S 外设的 DMA 传输 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | HAL_StatusTypeDef:操作状态,可以是 HAL_OK 或 HAL_ERROR |
先决条件 | 无 |
被调用函数 | 无 |
1.14 HAL_I2S_IRQHandler
函数名 | HAL_I2S_IRQHandler |
---|
函数原形 | void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 外设中断处理函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.15 HAL_I2S_TxHalfCpltCallback
函数名 | HAL_I2S_TxHalfCpltCallback |
---|
函数原形 | void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 发送一半完成回调函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.16 HAL_I2S_TxCpltCallback
函数名 | HAL_I2S_TxCpltCallback |
---|
函数原形 | void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 发送完成回调函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.17 HAL_I2S_RxHalfCpltCallback
函数名 | HAL_I2S_RxHalfCpltCallback |
---|
函数原形 | void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 接收一半完成回调函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.18 HAL_I2S_RxCpltCallback
函数名 | HAL_I2S_RxCpltCallback |
---|
函数原形 | void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 接收完成回调函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.19 HAL_I2S_ErrorCallback
函数名 | HAL_I2S_ErrorCallback |
---|
函数原形 | void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s) |
功能描述 | I2S 错误回调函数 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | 无 |
先决条件 | 无 |
被调用函数 | 无 |
1.20 HAL_I2S_GetState
函数名 | HAL_I2S_GetState |
---|
函数原形 | HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s) |
功能描述 | 获取 I2S 外设的状态 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | HAL_I2S_StateTypeDef:I2S 外设的状态 |
先决条件 | 无 |
被调用函数 | 无 |
1.21 HAL_I2S_GetError
函数名 | HAL_I2S_GetError |
---|
函数原形 | HAL_I2S_ErrorTypeDef HAL_I2S_GetError(I2S_HandleTypeDef *hi2s) |
功能描述 | 获取 I2S 外设的错误状态 |
输入参数 | hi2s:I2S 句柄,指向一个 I2S_HandleTypeDef 结构体 |
输出参数 | 无 |
返回值 | HAL_I2S_ErrorTypeDef:I2S 外设的错误状态 |
先决条件 | 无 |
被调用函数 | 无 |
该文档修改记录:
修改时间 | 修改说明 |
---|
2024年4月30日 | 第一次发布,介绍了该博客驱动所有函数的介绍及使用 |
总结
以上就是该博客驱动所有函数的介绍及使用的内容。
有不明白的地方欢迎留言;有建议欢迎留言,我后面编写文档好改进。
创作不容,如果文档对您有帮助,记得给个赞。