A12 STM32_HAL库函数之 HAL-ETH通用驱动 -- A -- 所有函数的介绍及使用

[1 通用定时器（TIM）预览](#1 通用定时器（TIM）预览)
- [1.1 HAL_ETH_Init](#1.1 HAL_ETH_Init)
- [1.2 HAL_ETH_DeInit](#1.2 HAL_ETH_DeInit)
- [1.3 HAL_ETH_DMATxDescListInit](#1.3 HAL_ETH_DMATxDescListInit)
- [1.4 HAL_ETH_DMARxDescListInit](#1.4 HAL_ETH_DMARxDescListInit)
- [1.5 HAL_ETH_MspInit](#1.5 HAL_ETH_MspInit)
- [1.6 HAL_ETH_MspDeInit](#1.6 HAL_ETH_MspDeInit)
- [1.7 HAL_ETH_TransmitFrame](#1.7 HAL_ETH_TransmitFrame)
- [1.8 HAL_ETH_GetReceivedFrame](#1.8 HAL_ETH_GetReceivedFrame)
- [1.9 HAL_ETH_GetReceivedFrame_IT](#1.9 HAL_ETH_GetReceivedFrame_IT)
- [1.10 HAL_ETH_IRQHandler](#1.10 HAL_ETH_IRQHandler)
该文档修改记录：
总结

1 通用定时器（TIM）预览

序号	函数名	描述
1	HAL_ETH_Init()	初始化以太网控制器。
2	HAL_ETH_DeInit()	反初始化以太网控制器。
3	HAL_ETH_DMATxDescListInit()	初始化以太网DMA发送描述符列表。
4	HAL_ETH_DMARxDescListInit()	初始化以太网DMA接收描述符列表。
5	HAL_ETH_MspInit()	初始化MCU外设相关的以太网控制器引脚或资源。
6	HAL_ETH_MspDeInit()	反初始化MCU外设相关的以太网控制器引脚或资源。
7	HAL_ETH_TransmitFrame()	传输以太网帧。
8	HAL_ETH_GetReceivedFrame()	获取接收到的以太网帧。
9	HAL_ETH_GetReceivedFrame_IT()	异步获取接收到的以太网帧，使用中断处理接收完成。
10	HAL_ETH_IRQHandler()	以太网控制器中断处理程序。
11	HAL_ETH_TxCpltCallback()	以太网发送完成回调函数。
12	HAL_ETH_RxCpltCallback()	以太网接收完成回调函数。
13	HAL_ETH_ErrorCallback()	以太网错误回调函数。
14	HAL_ETH_ReadPHYRegister()	读取PHY寄存器。
15	HAL_ETH_WritePHYRegister()	写入PHY寄存器。
16	HAL_ETH_Start()	启动以太网控制器。
17	HAL_ETH_Stop()	停止以太网控制器。
18	HAL_ETH_ConfigMAC()	配置以太网MAC。
19	HAL_ETH_ConfigDMA()	配置以太网DMA。
20	HAL_ETH_GetState()	获取以太网控制器状态。

使用模板：

c 复制代码

#include "stm32f4xx_hal.h"

int main(void) {
    // HAL初始化
    HAL_Init();
    
    // 初始化MCU外设相关的以太网控制器引脚或资源
    HAL_ETH_MspInit();
    
    // 初始化以太网控制器
    HAL_ETH_Init();
    
    // 进行其他操作...
    
    // 启动以太网控制器
    HAL_ETH_Start();
    
    // 启动DMA传输
    HAL_ETH_TransmitFrame();
    
    // 获取接收到的以太网帧
    HAL_ETH_GetReceivedFrame();
    
    // 异步获取接收到的以太网帧，使用中断处理接收完成
    HAL_ETH_GetReceivedFrame_IT();
    
    // 以太网中断处理程序
    HAL_ETH_IRQHandler();
    
    // 获取以太网控制器状态
    uint32_t ethState = HAL_ETH_GetState();
    
    // 停止以太网控制器
    HAL_ETH_Stop();
    
    // 反初始化以太网控制器
    HAL_ETH_DeInit();
    
    // 反初始化MCU外设相关的以太网控制器引脚或资源
    HAL_ETH_MspDeInit();
    
    return 0;
}

1.1 HAL_ETH_Init

函数名	HAL_ETH_Init
函数原形	HAL_StatusTypeDef HAL_ETH_Init(ETH_HandleTypeDef* heth)
功能描述	初始化以太网模块
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	HAL_StatusTypeDef：初始化结果，可以是 HAL_OK 或 HAL_ERROR
先决条件	无
被调用函数	无

1.2 HAL_ETH_DeInit

函数名	HAL_ETH_DeInit
函数原形	HAL_StatusTypeDef HAL_ETH_DeInit(ETH_HandleTypeDef* heth)
功能描述	反初始化以太网模块
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	HAL_StatusTypeDef：反初始化结果，可以是 HAL_OK 或 HAL_ERROR
先决条件	无
被调用函数	无

1.3 HAL_ETH_DMATxDescListInit

函数名	HAL_ETH_DMATxDescListInit
函数原形	void HAL_ETH_DMATxDescListInit(ETH_HandleTypeDef heth, ETH_DMADescTypeDef DMATxDescTab, uint8_t *TxBuffer, uint32_t BufferSize)
功能描述	初始化以太网 DMA 发送描述符列表
输入参数 1	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输入参数 2	DMATxDescTab：指向 DMA 发送描述符列表的指针
输入参数 3	TxBuffer：发送缓冲区的指针
输入参数 4	BufferSize：发送缓冲区大小
输出参数	无
返回值	无
先决条件	无
被调用函数	无

1.4 HAL_ETH_DMARxDescListInit

函数名	HAL_ETH_DMARxDescListInit
函数原形	void HAL_ETH_DMARxDescListInit(ETH_HandleTypeDef heth, ETH_DMADescTypeDef DMARxDescTab, uint8_t *RxBuffer, uint32_t BufferSize)
功能描述	初始化以太网 DMA 接收描述符列表
输入参数 1	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输入参数 2	DMARxDescTab：指向 DMA 接收描述符列表的指针
输入参数 3	RxBuffer：接收缓冲区的指针
输入参数 4	BufferSize：接收缓冲区大小
输出参数	无
返回值	无
先决条件	无
被调用函数	无

1.5 HAL_ETH_MspInit

函数名	HAL_ETH_MspInit
函数原形	void HAL_ETH_MspInit(ETH_HandleTypeDef* heth)
功能描述	初始化以太网外设（底层驱动的 MSP 初始化回调函数）
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	无
先决条件	无
被调用函数	无

1.6 HAL_ETH_MspDeInit

函数名	HAL_ETH_MspDeInit
函数原形	void HAL_ETH_MspDeInit(ETH_HandleTypeDef* heth)
功能描述	反初始化以太网外设（底层驱动的 MSP 反初始化回调函数）
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	无
先决条件	无
被调用函数	无

1.7 HAL_ETH_TransmitFrame

函数名	HAL_ETH_TransmitFrame
函数原形	HAL_StatusTypeDef HAL_ETH_TransmitFrame(ETH_HandleTypeDef *heth, uint32_t FrameLength)
功能描述	以太网发送数据帧
输入参数 1	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输入参数 2	FrameLength：要发送的数据帧长度
输出参数	无
返回值	HAL_StatusTypeDef：发送结果，可以是 HAL_OK 或 HAL_ERROR
先决条件	无
被调用函数	无

1.8 HAL_ETH_GetReceivedFrame

函数名	HAL_ETH_GetReceivedFrame
函数原形	HAL_StatusTypeDef HAL_ETH_GetReceivedFrame(ETH_HandleTypeDef *heth)
功能

描述 | 获取以太网接收到的数据帧 |

| 输入参数 | heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体 |

| 输出参数 | 无 |

| 返回值 | HAL_StatusTypeDef：获取结果，可以是 HAL_OK 或 HAL_ERROR |

| 先决条件 | 无 |

| 被调用函数 | 无 |

1.9 HAL_ETH_GetReceivedFrame_IT

函数名	HAL_ETH_GetReceivedFrame_IT
函数原形	HAL_StatusTypeDef HAL_ETH_GetReceivedFrame_IT(ETH_HandleTypeDef *heth)
功能描述	在中断中获取以太网接收到的数据帧
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	HAL_StatusTypeDef：获取结果，可以是 HAL_OK 或 HAL_ERROR
先决条件	无
被调用函数	无

1.10 HAL_ETH_IRQHandler

函数名	HAL_ETH_IRQHandler
函数原形	void HAL_ETH_IRQHandler(ETH_HandleTypeDef *heth)
功能描述	以太网中断服务函数
输入参数	heth：以太网句柄，指向一个 ETH_HandleTypeDef 结构体
输出参数	无
返回值	无
先决条件	无
被调用函数	无

该文档修改记录：

修改时间	修改说明
2024年4月12日	第一次发布，介绍了 A12 STM32_HAL库函数之 HALETH通用驱动 -- A -- 所有函数的介绍及使用

总结

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

A12 STM32_HAL库函数 之 HAL-ETH通用驱动 -- A -- 所有函数的介绍及使用

A12 STM32_HAL库函数 之 HAL-ETH通用驱动 -- A -- 所有函数的介绍及使用

1 通用定时器（TIM）预览

1.1 HAL_ETH_Init

1.2 HAL_ETH_DeInit

1.3 HAL_ETH_DMATxDescListInit

1.4 HAL_ETH_DMARxDescListInit

1.5 HAL_ETH_MspInit

1.6 HAL_ETH_MspDeInit

1.7 HAL_ETH_TransmitFrame

1.8 HAL_ETH_GetReceivedFrame

1.9 HAL_ETH_GetReceivedFrame_IT

1.10 HAL_ETH_IRQHandler

该文档修改记录：

总结

A12 STM32_HAL库函数之 HAL-ETH通用驱动 -- A -- 所有函数的介绍及使用

A12 STM32_HAL库函数之 HAL-ETH通用驱动 -- A -- 所有函数的介绍及使用