STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
ETH Exported Macros
Collaboration diagram for ETH Exported Macros:

Macros

#define __HAL_ETH_RESET_HANDLE_STATE(__HANDLE__)
 Reset ETH handle state.
 
#define __HAL_ETH_DMA_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enables the specified ETHERNET DMA interrupts.
 
#define __HAL_ETH_DMA_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disables the specified ETHERNET DMA interrupts.
 
#define __HAL_ETH_DMA_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Gets the ETHERNET DMA IT source enabled or disabled.
 
#define __HAL_ETH_DMA_GET_IT(__HANDLE__, __INTERRUPT__)
 Gets the ETHERNET DMA IT pending bit.
 
#define __HAL_ETH_DMA_CLEAR_IT(__HANDLE__, __INTERRUPT__)
 Clears the ETHERNET DMA IT pending bit.
 
#define __HAL_ETH_DMA_GET_FLAG(__HANDLE__, __FLAG__)
 Checks whether the specified ETHERNET DMA flag is set or not.
 
#define __HAL_ETH_DMA_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clears the specified ETHERNET DMA flag.
 
#define __HAL_ETH_MAC_GET_IT(__HANDLE__, __INTERRUPT__)
 Checks whether the specified ETHERNET MAC flag is set or not.
 
#define ETH_WAKEUP_EXTI_LINE   0x00080000U
 
#define __HAL_ETH_WAKEUP_EXTI_ENABLE_IT(__EXTI_LINE__)
 Enable the ETH WAKEUP Exti Line.
 
#define __HAL_ETH_WAKEUP_EXTI_GET_FLAG(__EXTI_LINE__)
 checks whether the specified ETH WAKEUP Exti interrupt flag is set or not.
 
#define __HAL_ETH_WAKEUP_EXTI_CLEAR_FLAG(__EXTI_LINE__)
 Clear the ETH WAKEUP Exti flag.
 
#define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_EDGE(__EXTI_LINE__)
 enable rising edge interrupt on selected EXTI line.
 
#define __HAL_ETH_WAKEUP_EXTI_ENABLE_FALLING_EDGE(__EXTI_LINE__)
 enable falling edge interrupt on selected EXTI line.
 
#define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE(__EXTI_LINE__)
 enable falling edge interrupt on selected EXTI line.
 
#define __HAL_ETH_WAKEUP_EXTI_GENERATE_SWIT(__EXTI_LINE__)
 Generates a Software interrupt on selected EXTI line.
 
#define __HAL_ETH_GET_PTP_CONTROL(__HANDLE__, __FLAG__)
 
#define __HAL_ETH_SET_PTP_CONTROL(__HANDLE__, __FLAG__)
 

Detailed Description

Macro Definition Documentation

◆ __HAL_ETH_RESET_HANDLE_STATE

#define __HAL_ETH_RESET_HANDLE_STATE ( __HANDLE__)

#include <stm32f4xx_hal_eth.h>

Value:
do{ \
(__HANDLE__)->gState = HAL_ETH_STATE_RESET; \
} while(0)
#define HAL_ETH_STATE_RESET

Reset ETH handle state.

Parameters
__HANDLE__specifies the ETH handle.
Return values
None

Definition at line 1705 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_DMA_ENABLE_IT

#define __HAL_ETH_DMA_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
((__HANDLE__)->Instance->DMAIER \
|= (__INTERRUPT__))

Enables the specified ETHERNET DMA interrupts.

Parameters
__HANDLE__: ETH Handle
__INTERRUPT__specifies the ETHERNET DMA interrupt sources to be enabled ETH DMA Interrupts
Return values
None

Definition at line 1717 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_Start_IT().

◆ __HAL_ETH_DMA_DISABLE_IT

#define __HAL_ETH_DMA_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
((__HANDLE__)->Instance->DMAIER \
&= ~(__INTERRUPT__))

Disables the specified ETHERNET DMA interrupts.

Parameters
__HANDLE__: ETH Handle
__INTERRUPT__specifies the ETHERNET DMA interrupt sources to be disabled. ETH DMA Interrupts
Return values
None

Definition at line 1727 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_IRQHandler(), and HAL_ETH_Stop_IT().

◆ __HAL_ETH_DMA_GET_IT_SOURCE

#define __HAL_ETH_DMA_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
(((__HANDLE__)->Instance->DMAIER &\
(__INTERRUPT__)) == (__INTERRUPT__))

Gets the ETHERNET DMA IT source enabled or disabled.

Parameters
__HANDLE__: ETH Handle
__INTERRUPT__specifies the interrupt source to get . ETH DMA Interrupts
Return values
TheETH DMA IT Source enabled or disabled

Definition at line 1736 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_DMA_GET_IT

#define __HAL_ETH_DMA_GET_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
(((__HANDLE__)->Instance->DMASR &\
(__INTERRUPT__)) == (__INTERRUPT__))

Gets the ETHERNET DMA IT pending bit.

Parameters
__HANDLE__: ETH Handle
__INTERRUPT__specifies the interrupt source to get . ETH DMA Interrupts
Return values
Thestate of ETH DMA IT (SET or RESET)

Definition at line 1745 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_DMA_CLEAR_IT

#define __HAL_ETH_DMA_CLEAR_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
((__HANDLE__)->Instance->DMASR = (__INTERRUPT__))

Clears the ETHERNET DMA IT pending bit.

Parameters
__HANDLE__: ETH Handle
__INTERRUPT__specifies the interrupt pending bit to clear. ETH DMA Interrupts
Return values
None

Definition at line 1754 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_IRQHandler().

◆ __HAL_ETH_DMA_GET_FLAG

#define __HAL_ETH_DMA_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_eth.h>

Value:
(((__HANDLE__)->Instance->DMASR &\
( __FLAG__)) == ( __FLAG__))

Checks whether the specified ETHERNET DMA flag is set or not.

Parameters
__HANDLE__ETH Handle
__FLAG__specifies the flag to check. ETH DMA Status Flags
Return values
Thestate of ETH DMA FLAG (SET or RESET).

Definition at line 1762 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_DMA_CLEAR_FLAG

#define __HAL_ETH_DMA_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_eth.h>

Value:
((__HANDLE__)->Instance->DMASR = ( __FLAG__))

Clears the specified ETHERNET DMA flag.

Parameters
__HANDLE__ETH Handle
__FLAG__specifies the flag to check. ETH DMA Status Flags
Return values
Thestate of ETH DMA FLAG (SET or RESET).

Definition at line 1771 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_MAC_GET_IT

#define __HAL_ETH_MAC_GET_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_eth.h>

Value:
(((__HANDLE__)->Instance->MACSR &\
( __INTERRUPT__)) == ( __INTERRUPT__))

Checks whether the specified ETHERNET MAC flag is set or not.

Parameters
__HANDLE__ETH Handle
__INTERRUPT__specifies the flag to check. ETH MAC Interrupts
Return values
Thestate of ETH MAC IT (SET or RESET). External interrupt line 19 Connected to the ETH wakeup EXTI Line

Definition at line 1781 of file stm32f4xx_hal_eth.h.

◆ ETH_WAKEUP_EXTI_LINE

#define ETH_WAKEUP_EXTI_LINE   0x00080000U

#include <stm32f4xx_hal_eth.h>

Definition at line 1785 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_IRQHandler().

◆ __HAL_ETH_WAKEUP_EXTI_ENABLE_IT

#define __HAL_ETH_WAKEUP_EXTI_ENABLE_IT ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->IMR |= (__EXTI_LINE__))

Enable the ETH WAKEUP Exti Line.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP Exti sources to be enabled.
  • ETH_WAKEUP_EXTI_LINE
Return values
None.

Definition at line 1793 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_WAKEUP_EXTI_GET_FLAG

#define __HAL_ETH_WAKEUP_EXTI_GET_FLAG ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->PR & (__EXTI_LINE__))

checks whether the specified ETH WAKEUP Exti interrupt flag is set or not.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP Exti sources to be cleared.
  • ETH_WAKEUP_EXTI_LINE
Return values
EXTIETH WAKEUP Line Status.

Definition at line 1801 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_WAKEUP_EXTI_CLEAR_FLAG

#define __HAL_ETH_WAKEUP_EXTI_CLEAR_FLAG ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->PR = (__EXTI_LINE__))

Clear the ETH WAKEUP Exti flag.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP Exti sources to be cleared.
  • ETH_WAKEUP_EXTI_LINE
Return values
None.

Definition at line 1809 of file stm32f4xx_hal_eth.h.

Referenced by HAL_ETH_IRQHandler().

◆ __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_EDGE

#define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_EDGE ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->FTSR &= ~(__EXTI_LINE__)); \
(EXTI->RTSR |= (__EXTI_LINE__))

enable rising edge interrupt on selected EXTI line.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP EXTI sources to be disabled.
  • ETH_WAKEUP_EXTI_LINE
Return values
None

Definition at line 1817 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_WAKEUP_EXTI_ENABLE_FALLING_EDGE

#define __HAL_ETH_WAKEUP_EXTI_ENABLE_FALLING_EDGE ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->RTSR &= ~(__EXTI_LINE__));\
(EXTI->FTSR |= (__EXTI_LINE__))

enable falling edge interrupt on selected EXTI line.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP EXTI sources to be disabled.
  • ETH_WAKEUP_EXTI_LINE
Return values
None

Definition at line 1826 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE

#define __HAL_ETH_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->RTSR |= (__EXTI_LINE__));\
(EXTI->FTSR |= (__EXTI_LINE__))

enable falling edge interrupt on selected EXTI line.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP EXTI sources to be disabled.
  • ETH_WAKEUP_EXTI_LINE
Return values
None

Definition at line 1835 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_WAKEUP_EXTI_GENERATE_SWIT

#define __HAL_ETH_WAKEUP_EXTI_GENERATE_SWIT ( __EXTI_LINE__)

#include <stm32f4xx_hal_eth.h>

Value:
(EXTI->SWIER |= (__EXTI_LINE__))

Generates a Software interrupt on selected EXTI line.

Parameters
__EXTI_LINE__specifies the ETH WAKEUP EXTI sources to be disabled.
  • ETH_WAKEUP_EXTI_LINE
Return values
None

Definition at line 1844 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_GET_PTP_CONTROL

#define __HAL_ETH_GET_PTP_CONTROL ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_eth.h>

Value:
(((((__HANDLE__)->Instance->PTPTSCR) & \
(__FLAG__)) == (__FLAG__)) ? SET : RESET)

Definition at line 1846 of file stm32f4xx_hal_eth.h.

◆ __HAL_ETH_SET_PTP_CONTROL

#define __HAL_ETH_SET_PTP_CONTROL ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_eth.h>

Value:
((__HANDLE__)->Instance->PTPTSCR |= (__FLAG__))

Definition at line 1849 of file stm32f4xx_hal_eth.h.