|
STM32F4xx_HAL_Driver
1.8.3
|
ETH Transmit and Receive functions. More...
Collaboration diagram for IO operation functions:Functions | |
| HAL_StatusTypeDef | HAL_ETH_Start (ETH_HandleTypeDef *heth) |
| Enables Ethernet MAC and DMA reception and transmission. More... | |
| HAL_StatusTypeDef | HAL_ETH_Start_IT (ETH_HandleTypeDef *heth) |
| Enables Ethernet MAC and DMA reception/transmission in Interrupt mode. More... | |
| HAL_StatusTypeDef | HAL_ETH_Stop (ETH_HandleTypeDef *heth) |
| Stop Ethernet MAC and DMA reception/transmission. More... | |
| HAL_StatusTypeDef | HAL_ETH_Stop_IT (ETH_HandleTypeDef *heth) |
| Stop Ethernet MAC and DMA reception/transmission in Interrupt mode. More... | |
| HAL_StatusTypeDef | HAL_ETH_ReadData (ETH_HandleTypeDef *heth, void **pAppBuff) |
| Read a received packet. More... | |
| HAL_StatusTypeDef | HAL_ETH_RegisterRxAllocateCallback (ETH_HandleTypeDef *heth, pETH_rxAllocateCallbackTypeDef rxAllocateCallback) |
| Register the Rx alloc callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_UnRegisterRxAllocateCallback (ETH_HandleTypeDef *heth) |
| Unregister the Rx alloc callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_RegisterRxLinkCallback (ETH_HandleTypeDef *heth, pETH_rxLinkCallbackTypeDef rxLinkCallback) |
| Set the Rx link data function. More... | |
| HAL_StatusTypeDef | HAL_ETH_UnRegisterRxLinkCallback (ETH_HandleTypeDef *heth) |
| Unregister the Rx link callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_GetRxDataErrorCode (const ETH_HandleTypeDef *heth, uint32_t *pErrorCode) |
| Get the error state of the last received packet. More... | |
| HAL_StatusTypeDef | HAL_ETH_RegisterTxFreeCallback (ETH_HandleTypeDef *heth, pETH_txFreeCallbackTypeDef txFreeCallback) |
| Set the Tx free function. More... | |
| HAL_StatusTypeDef | HAL_ETH_UnRegisterTxFreeCallback (ETH_HandleTypeDef *heth) |
| Unregister the Tx free callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_ReleaseTxPacket (ETH_HandleTypeDef *heth) |
| Release transmitted Tx packets. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_SetConfig (ETH_HandleTypeDef *heth, ETH_PTP_ConfigTypeDef *ptpconfig) |
| Set the Ethernet PTP configuration. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_GetConfig (ETH_HandleTypeDef *heth, ETH_PTP_ConfigTypeDef *ptpconfig) |
| Get the Ethernet PTP configuration. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_SetTime (ETH_HandleTypeDef *heth, ETH_TimeTypeDef *time) |
| Set Seconds and Nanoseconds for the Ethernet PTP registers. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_GetTime (ETH_HandleTypeDef *heth, ETH_TimeTypeDef *time) |
| Get Seconds and Nanoseconds for the Ethernet PTP registers. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_AddTimeOffset (ETH_HandleTypeDef *heth, ETH_PtpUpdateTypeDef ptpoffsettype, ETH_TimeTypeDef *timeoffset) |
| Update time for the Ethernet PTP registers. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_InsertTxTimestamp (ETH_HandleTypeDef *heth) |
| Insert Timestamp in transmission. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_GetTxTimestamp (ETH_HandleTypeDef *heth, ETH_TimeStampTypeDef *timestamp) |
| Get transmission timestamp. More... | |
| HAL_StatusTypeDef | HAL_ETH_PTP_GetRxTimestamp (ETH_HandleTypeDef *heth, ETH_TimeStampTypeDef *timestamp) |
| Get receive timestamp. More... | |
| HAL_StatusTypeDef | HAL_ETH_RegisterTxPtpCallback (ETH_HandleTypeDef *heth, pETH_txPtpCallbackTypeDef txPtpCallback) |
| Register the Tx Ptp callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_UnRegisterTxPtpCallback (ETH_HandleTypeDef *heth) |
| Unregister the Tx Ptp callback. More... | |
| HAL_StatusTypeDef | HAL_ETH_Transmit (ETH_HandleTypeDef *heth, ETH_TxPacketConfigTypeDef *pTxConfig, uint32_t Timeout) |
| Sends an Ethernet Packet in polling mode. More... | |
| HAL_StatusTypeDef | HAL_ETH_Transmit_IT (ETH_HandleTypeDef *heth, ETH_TxPacketConfigTypeDef *pTxConfig) |
| Sends an Ethernet Packet in interrupt mode. More... | |
| HAL_StatusTypeDef | HAL_ETH_WritePHYRegister (const ETH_HandleTypeDef *heth, uint32_t PHYAddr, uint32_t PHYReg, uint32_t RegValue) |
| Writes to a PHY register. More... | |
| HAL_StatusTypeDef | HAL_ETH_ReadPHYRegister (ETH_HandleTypeDef *heth, uint32_t PHYAddr, uint32_t PHYReg, uint32_t *pRegValue) |
| Read a PHY register. More... | |
| void | HAL_ETH_IRQHandler (ETH_HandleTypeDef *heth) |
| This function handles ETH interrupt request. More... | |
| void | HAL_ETH_TxCpltCallback (ETH_HandleTypeDef *heth) |
| Tx Transfer completed callbacks. More... | |
| void | HAL_ETH_RxCpltCallback (ETH_HandleTypeDef *heth) |
| Rx Transfer completed callbacks. More... | |
| void | HAL_ETH_ErrorCallback (ETH_HandleTypeDef *heth) |
| Ethernet transfer error callbacks. More... | |
| void | HAL_ETH_PMTCallback (ETH_HandleTypeDef *heth) |
| Ethernet Power Management module IT callback. More... | |
| void | HAL_ETH_WakeUpCallback (ETH_HandleTypeDef *heth) |
| ETH WAKEUP interrupt callback. More... | |
| void | HAL_ETH_RxAllocateCallback (uint8_t **buff) |
| Rx Allocate callback. More... | |
| void | HAL_ETH_RxLinkCallback (void **pStart, void **pEnd, uint8_t *buff, uint16_t Length) |
| Rx Link callback. More... | |
| void | HAL_ETH_TxFreeCallback (uint32_t *buff) |
| Tx Free callback. More... | |
| void | HAL_ETH_TxPtpCallback (uint32_t *buff, ETH_TimeStampTypeDef *timestamp) |
| Tx Ptp callback. More... | |
ETH Transmit and Receive functions.
==============================================================================
##### IO operation functions #####
==============================================================================
[..]
This subsection provides a set of functions allowing to manage the ETH
data transfer. | __weak void HAL_ETH_ErrorCallback | ( | ETH_HandleTypeDef * | heth | ) |
Ethernet transfer error callbacks.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| None |
Definition at line 2032 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_GetRxDataErrorCode | ( | const ETH_HandleTypeDef * | heth, |
| uint32_t * | pErrorCode | ||
| ) |
Get the error state of the last received packet.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| pErrorCode | pointer to uint32_t to hold the error code |
| HAL | status |
Definition at line 1382 of file stm32f4xx_hal_eth.c.
| void HAL_ETH_IRQHandler | ( | ETH_HandleTypeDef * | heth | ) |
This function handles ETH interrupt request.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1890 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_PMTCallback | ( | ETH_HandleTypeDef * | heth | ) |
Ethernet Power Management module IT callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| None |
Definition at line 2047 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_AddTimeOffset | ( | ETH_HandleTypeDef * | heth, |
| ETH_PtpUpdateTypeDef | ptpoffsettype, | ||
| ETH_TimeTypeDef * | timeoffset | ||
| ) |
Update time for the Ethernet PTP registers.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| timeoffset | pointer to a ETH_PtpUpdateTypeDef structure that contains the time update information |
| HAL | status |
Definition at line 1708 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_GetConfig | ( | ETH_HandleTypeDef * | heth, |
| ETH_PTP_ConfigTypeDef * | ptpconfig | ||
| ) |
Get the Ethernet PTP configuration.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| ptpconfig | pointer to a ETH_PTP_ConfigTypeDef structure that contains the configuration information for PTP |
| HAL | status |
Definition at line 1606 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_GetRxTimestamp | ( | ETH_HandleTypeDef * | heth, |
| ETH_TimeStampTypeDef * | timestamp | ||
| ) |
Get receive timestamp.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| timestamp | pointer to ETH_TIMESTAMPTypeDef structure that contains receive timestamp |
| HAL | status |
Definition at line 1814 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_GetTime | ( | ETH_HandleTypeDef * | heth, |
| ETH_TimeTypeDef * | time | ||
| ) |
Get Seconds and Nanoseconds for the Ethernet PTP registers.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| time | pointer to a ETH_TimeTypeDef structure that contains time to get |
| HAL | status |
Definition at line 1681 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_GetTxTimestamp | ( | ETH_HandleTypeDef * | heth, |
| ETH_TimeStampTypeDef * | timestamp | ||
| ) |
Get transmission timestamp.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| timestamp | pointer to ETH_TIMESTAMPTypeDef structure that contains transmission timestamp |
| HAL | status |
Definition at line 1783 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_InsertTxTimestamp | ( | ETH_HandleTypeDef * | heth | ) |
Insert Timestamp in transmission.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1754 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_SetConfig | ( | ETH_HandleTypeDef * | heth, |
| ETH_PTP_ConfigTypeDef * | ptpconfig | ||
| ) |
Set the Ethernet PTP configuration.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| ptpconfig | pointer to a ETH_PTP_ConfigTypeDef structure that contains the configuration information for PTP |
| HAL | status |
Definition at line 1540 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_PTP_SetTime | ( | ETH_HandleTypeDef * | heth, |
| ETH_TimeTypeDef * | time | ||
| ) |
Set Seconds and Nanoseconds for the Ethernet PTP registers.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| time | pointer to a ETH_TimeTypeDef structure that contains time to set |
| HAL | status |
Definition at line 1650 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_ReadData | ( | ETH_HandleTypeDef * | heth, |
| void ** | pAppBuff | ||
| ) |
Read a received packet.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| pAppBuff | Pointer to an application buffer to receive the packet. |
| HAL | status |
Definition at line 1083 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_ReadPHYRegister | ( | ETH_HandleTypeDef * | heth, |
| uint32_t | PHYAddr, | ||
| uint32_t | PHYReg, | ||
| uint32_t * | pRegValue | ||
| ) |
Read a PHY register.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| PHYAddr | PHY port address, must be a value from 0 to 31 |
| PHYReg | PHY register address, must be a value from 0 to 31 |
| pRegValue | parameter to hold read value |
| HAL | status |
Definition at line 2081 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_RegisterRxAllocateCallback | ( | ETH_HandleTypeDef * | heth, |
| pETH_rxAllocateCallbackTypeDef | rxAllocateCallback | ||
| ) |
Register the Rx alloc callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| rxAllocateCallback | pointer to function to alloc buffer |
| HAL | status |
Definition at line 1277 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_RegisterRxLinkCallback | ( | ETH_HandleTypeDef * | heth, |
| pETH_rxLinkCallbackTypeDef | rxLinkCallback | ||
| ) |
Set the Rx link data function.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| rxLinkCallback | pointer to function to link data |
| HAL | status |
Definition at line 1347 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_RegisterTxFreeCallback | ( | ETH_HandleTypeDef * | heth, |
| pETH_txFreeCallbackTypeDef | txFreeCallback | ||
| ) |
Set the Tx free function.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| txFreeCallback | pointer to function to release the packet |
| HAL | status |
Definition at line 1397 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_RegisterTxPtpCallback | ( | ETH_HandleTypeDef * | heth, |
| pETH_txPtpCallbackTypeDef | txPtpCallback | ||
| ) |
Register the Tx Ptp callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| txPtpCallback | Function to handle Ptp transmission |
| HAL | status |
Definition at line 1840 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_ReleaseTxPacket | ( | ETH_HandleTypeDef * | heth | ) |
Release transmitted Tx packets.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1445 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_RxAllocateCallback | ( | uint8_t ** | buff | ) |
Rx Allocate callback.
| buff | pointer to allocated buffer |
| None |
Definition at line 1311 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_RxCpltCallback | ( | ETH_HandleTypeDef * | heth | ) |
Rx Transfer completed callbacks.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| None |
Definition at line 2017 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_RxLinkCallback | ( | void ** | pStart, |
| void ** | pEnd, | ||
| uint8_t * | buff, | ||
| uint16_t | Length | ||
| ) |
Rx Link callback.
| pStart | pointer to packet start |
| pEnd | pointer to packet end |
| buff | pointer to received data |
| Length | received data length |
| None |
Definition at line 1328 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Start | ( | ETH_HandleTypeDef * | heth | ) |
Enables Ethernet MAC and DMA reception and transmission.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 708 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Start_IT | ( | ETH_HandleTypeDef * | heth | ) |
Enables Ethernet MAC and DMA reception/transmission in Interrupt mode.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 765 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Stop | ( | ETH_HandleTypeDef * | heth | ) |
Stop Ethernet MAC and DMA reception/transmission.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 833 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Stop_IT | ( | ETH_HandleTypeDef * | heth | ) |
Stop Ethernet MAC and DMA reception/transmission in Interrupt mode.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 886 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Transmit | ( | ETH_HandleTypeDef * | heth, |
| ETH_TxPacketConfigTypeDef * | pTxConfig, | ||
| uint32_t | Timeout | ||
| ) |
Sends an Ethernet Packet in polling mode.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| pTxConfig | Hold the configuration of packet to be transmitted |
| Timeout | timeout value |
| HAL | status |
Definition at line 956 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_Transmit_IT | ( | ETH_HandleTypeDef * | heth, |
| ETH_TxPacketConfigTypeDef * | pTxConfig | ||
| ) |
Sends an Ethernet Packet in interrupt mode.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| pTxConfig | Hold the configuration of packet to be transmitted |
| HAL | status |
Definition at line 1031 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_TxCpltCallback | ( | ETH_HandleTypeDef * | heth | ) |
Tx Transfer completed callbacks.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| None |
Definition at line 2002 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_TxFreeCallback | ( | uint32_t * | buff | ) |
Tx Free callback.
| buff | pointer to buffer to free |
| None |
Definition at line 1430 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_TxPtpCallback | ( | uint32_t * | buff, |
| ETH_TimeStampTypeDef * | timestamp | ||
| ) |
Tx Ptp callback.
| buff | pointer to application buffer |
| timestamp | pointer to ETH_TimeStampTypeDef structure that contains transmission timestamp |
| None |
Definition at line 1874 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_UnRegisterRxAllocateCallback | ( | ETH_HandleTypeDef * | heth | ) |
Unregister the Rx alloc callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1298 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_UnRegisterRxLinkCallback | ( | ETH_HandleTypeDef * | heth | ) |
Unregister the Rx link callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1367 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_UnRegisterTxFreeCallback | ( | ETH_HandleTypeDef * | heth | ) |
Unregister the Tx free callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1417 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_UnRegisterTxPtpCallback | ( | ETH_HandleTypeDef * | heth | ) |
Unregister the Tx Ptp callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| HAL | status |
Definition at line 1859 of file stm32f4xx_hal_eth.c.
| __weak void HAL_ETH_WakeUpCallback | ( | ETH_HandleTypeDef * | heth | ) |
ETH WAKEUP interrupt callback.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| None |
Definition at line 2063 of file stm32f4xx_hal_eth.c.
| HAL_StatusTypeDef HAL_ETH_WritePHYRegister | ( | const ETH_HandleTypeDef * | heth, |
| uint32_t | PHYAddr, | ||
| uint32_t | PHYReg, | ||
| uint32_t | RegValue | ||
| ) |
Writes to a PHY register.
| heth | pointer to a ETH_HandleTypeDef structure that contains the configuration information for ETHERNET module |
| PHYAddr | PHY port address, must be a value from 0 to 31 |
| PHYReg | PHY register address, must be a value from 0 to 31 |
| RegValue | the value to write |
| HAL | status |
Definition at line 2132 of file stm32f4xx_hal_eth.c.