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

Macros

#define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__)
 Reset LTDC handle state.
 
#define __HAL_LTDC_ENABLE(__HANDLE__)
 Enable the LTDC.
 
#define __HAL_LTDC_DISABLE(__HANDLE__)
 Disable the LTDC.
 
#define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__)
 Enable the LTDC Layer.
 
#define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__)
 Disable the LTDC Layer.
 
#define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG(__HANDLE__)
 Reload immediately all LTDC Layers.
 
#define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG(__HANDLE__)
 Reload during vertical blanking period all LTDC Layers.
 
#define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__)
 Get the LTDC pending flags.
 
#define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clears the LTDC pending flags.
 
#define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enables the specified LTDC interrupts.
 
#define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disables the specified LTDC interrupts.
 
#define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified LTDC interrupt has occurred or not.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_LTDC_RESET_HANDLE_STATE

#define __HAL_LTDC_RESET_HANDLE_STATE ( __HANDLE__)

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
HAL_LTDC_STATE_RESET
@ HAL_LTDC_STATE_RESET
Definition stm32f4xx_hal_ltdc.h:172

Reset LTDC handle state.

Parameters
__HANDLE__LTDC handle
Return values
None

Definition at line 424 of file stm32f4xx_hal_ltdc.h.

◆ __HAL_LTDC_ENABLE

#define __HAL_LTDC_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)

Enable the LTDC.

Parameters
__HANDLE__LTDC handle
Return values
None.

Definition at line 432 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_Init().

◆ __HAL_LTDC_DISABLE

#define __HAL_LTDC_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))

Disable the LTDC.

Parameters
__HANDLE__LTDC handle
Return values
None.

Definition at line 439 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_DeInit().

◆ __HAL_LTDC_LAYER_ENABLE

#define __HAL_LTDC_LAYER_ENABLE ( __HANDLE__,
__LAYER__ )

#include <stm32f4xx_hal_ltdc.h>

Value:
((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR\
|= (uint32_t)LTDC_LxCR_LEN)
LTDC_LAYER
#define LTDC_LAYER(__HANDLE__, __LAYER__)
Definition stm32f4xx_hal_ltdc.h:645

Enable the LTDC Layer.

Parameters
__HANDLE__LTDC handle
__LAYER__Specify the layer to be enabled. This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
Return values
None.

Definition at line 448 of file stm32f4xx_hal_ltdc.h.

◆ __HAL_LTDC_LAYER_DISABLE

#define __HAL_LTDC_LAYER_DISABLE ( __HANDLE__,
__LAYER__ )

#include <stm32f4xx_hal_ltdc.h>

Value:
((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR\
&= ~(uint32_t)LTDC_LxCR_LEN)

Disable the LTDC Layer.

Parameters
__HANDLE__LTDC handle
__LAYER__Specify the layer to be disabled. This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
Return values
None.

Definition at line 458 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_DeInit().

◆ __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG

#define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG ( __HANDLE__)

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)

Reload immediately all LTDC Layers.

Parameters
__HANDLE__LTDC handle
Return values
None.

Definition at line 466 of file stm32f4xx_hal_ltdc.h.

◆ __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG

#define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG ( __HANDLE__)

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_VBR)

Reload during vertical blanking period all LTDC Layers.

Parameters
__HANDLE__LTDC handle
Return values
None.

Definition at line 473 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_DeInit().

◆ __HAL_LTDC_GET_FLAG

#define __HAL_LTDC_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->ISR & (__FLAG__))

Get the LTDC pending flags.

Parameters
__HANDLE__LTDC handle
__FLAG__Get the specified flag. This parameter can be any combination of the following values:
  • LTDC_FLAG_LI: Line Interrupt flag
  • LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  • LTDC_FLAG_TE: Transfer Error interrupt flag
  • LTDC_FLAG_RR: Register Reload Interrupt Flag
Return values
Thestate of FLAG (SET or RESET).

Definition at line 487 of file stm32f4xx_hal_ltdc.h.

◆ __HAL_LTDC_CLEAR_FLAG

#define __HAL_LTDC_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_ltdc.h>

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

Clears the LTDC pending flags.

Parameters
__HANDLE__LTDC handle
__FLAG__Specify the flag to clear. This parameter can be any combination of the following values:
  • LTDC_FLAG_LI: Line Interrupt flag
  • LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  • LTDC_FLAG_TE: Transfer Error interrupt flag
  • LTDC_FLAG_RR: Register Reload Interrupt Flag
Return values
None

Definition at line 500 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_IRQHandler().

◆ __HAL_LTDC_ENABLE_IT

#define __HAL_LTDC_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->IER |= (__INTERRUPT__))

Enables the specified LTDC interrupts.

Parameters
__HANDLE__LTDC handle
__INTERRUPT__Specify the LTDC interrupt sources to be enabled. This parameter can be any combination of the following values:
  • LTDC_IT_LI: Line Interrupt flag
  • LTDC_IT_FU: FIFO Underrun Interrupt flag
  • LTDC_IT_TE: Transfer Error interrupt flag
  • LTDC_IT_RR: Register Reload Interrupt Flag
Return values
None

Definition at line 513 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_Init(), HAL_LTDC_ProgramLineEvent(), and HAL_LTDC_Reload().

◆ __HAL_LTDC_DISABLE_IT

#define __HAL_LTDC_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_ltdc.h>

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

Disables the specified LTDC interrupts.

Parameters
__HANDLE__LTDC handle
__INTERRUPT__Specify the LTDC interrupt sources to be disabled. This parameter can be any combination of the following values:
  • LTDC_IT_LI: Line Interrupt flag
  • LTDC_IT_FU: FIFO Underrun Interrupt flag
  • LTDC_IT_TE: Transfer Error interrupt flag
  • LTDC_IT_RR: Register Reload Interrupt Flag
Return values
None

Definition at line 526 of file stm32f4xx_hal_ltdc.h.

Referenced by HAL_LTDC_IRQHandler(), and HAL_LTDC_ProgramLineEvent().

◆ __HAL_LTDC_GET_IT_SOURCE

#define __HAL_LTDC_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_ltdc.h>

Value:
((__HANDLE__)->Instance->IER & (__INTERRUPT__))

Check whether the specified LTDC interrupt has occurred or not.

Parameters
__HANDLE__LTDC handle
__INTERRUPT__Specify the LTDC interrupt source to check. This parameter can be one of the following values:
  • LTDC_IT_LI: Line Interrupt flag
  • LTDC_IT_FU: FIFO Underrun Interrupt flag
  • LTDC_IT_TE: Transfer Error interrupt flag
  • LTDC_IT_RR: Register Reload Interrupt Flag
Return values
Thestate of INTERRUPT (SET or RESET).

Definition at line 539 of file stm32f4xx_hal_ltdc.h.