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

Macros

#define __HAL_DMA2D_RESET_HANDLE_STATE(__HANDLE__)
 Reset DMA2D handle state.
 
#define __HAL_DMA2D_ENABLE(__HANDLE__)
 Enable the DMA2D.
 
#define __HAL_DMA2D_GET_FLAG(__HANDLE__, __FLAG__)
 Get the DMA2D pending flags.
 
#define __HAL_DMA2D_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clear the DMA2D pending flags.
 
#define __HAL_DMA2D_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified DMA2D interrupts.
 
#define __HAL_DMA2D_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the specified DMA2D interrupts.
 
#define __HAL_DMA2D_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified DMA2D interrupt source is enabled or not.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_DMA2D_RESET_HANDLE_STATE

#define __HAL_DMA2D_RESET_HANDLE_STATE ( __HANDLE__)

#include <stm32f4xx_hal_dma2d.h>

Value:
((__HANDLE__)->State = HAL_DMA2D_STATE_RESET)
HAL_DMA2D_STATE_RESET
@ HAL_DMA2D_STATE_RESET
Definition stm32f4xx_hal_dma2d.h:117

Reset DMA2D handle state.

Parameters
__HANDLE__specifies the DMA2D handle.
Return values
None

Definition at line 316 of file stm32f4xx_hal_dma2d.h.

◆ __HAL_DMA2D_ENABLE

#define __HAL_DMA2D_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_dma2d.h>

Value:
((__HANDLE__)->Instance->CR |= DMA2D_CR_START)

Enable the DMA2D.

Parameters
__HANDLE__DMA2D handle
Return values
None.

Definition at line 325 of file stm32f4xx_hal_dma2d.h.

Referenced by HAL_DMA2D_BlendingStart(), HAL_DMA2D_BlendingStart_IT(), HAL_DMA2D_Start(), and HAL_DMA2D_Start_IT().

◆ __HAL_DMA2D_GET_FLAG

#define __HAL_DMA2D_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_dma2d.h>

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

Get the DMA2D pending flags.

Parameters
__HANDLE__DMA2D handle
__FLAG__flag to check. This parameter can be any combination of the following values:
  • DMA2D_FLAG_CE: Configuration error flag
  • DMA2D_FLAG_CTC: CLUT transfer complete flag
  • DMA2D_FLAG_CAE: CLUT access error flag
  • DMA2D_FLAG_TW: Transfer Watermark flag
  • DMA2D_FLAG_TC: Transfer complete flag
  • DMA2D_FLAG_TE: Transfer error flag
Return values
Thestate of FLAG.

Definition at line 342 of file stm32f4xx_hal_dma2d.h.

Referenced by HAL_DMA2D_PollForTransfer().

◆ __HAL_DMA2D_CLEAR_FLAG

#define __HAL_DMA2D_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_dma2d.h>

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

Clear the DMA2D pending flags.

Parameters
__HANDLE__DMA2D handle
__FLAG__specifies the flag to clear. This parameter can be any combination of the following values:
  • DMA2D_FLAG_CE: Configuration error flag
  • DMA2D_FLAG_CTC: CLUT transfer complete flag
  • DMA2D_FLAG_CAE: CLUT access error flag
  • DMA2D_FLAG_TW: Transfer Watermark flag
  • DMA2D_FLAG_TC: Transfer complete flag
  • DMA2D_FLAG_TE: Transfer error flag
Return values
None

Definition at line 357 of file stm32f4xx_hal_dma2d.h.

Referenced by HAL_DMA2D_IRQHandler(), and HAL_DMA2D_PollForTransfer().

◆ __HAL_DMA2D_ENABLE_IT

#define __HAL_DMA2D_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dma2d.h>

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

Enable the specified DMA2D interrupts.

Parameters
__HANDLE__DMA2D handle
__INTERRUPT__specifies the DMA2D interrupt sources to be enabled. This parameter can be any combination of the following values:
  • DMA2D_IT_CE: Configuration error interrupt mask
  • DMA2D_IT_CTC: CLUT transfer complete interrupt mask
  • DMA2D_IT_CAE: CLUT access error interrupt mask
  • DMA2D_IT_TW: Transfer Watermark interrupt mask
  • DMA2D_IT_TC: Transfer complete interrupt mask
  • DMA2D_IT_TE: Transfer error interrupt mask
Return values
None

Definition at line 372 of file stm32f4xx_hal_dma2d.h.

Referenced by HAL_DMA2D_BlendingStart_IT(), HAL_DMA2D_CLUTLoad_IT(), HAL_DMA2D_CLUTStartLoad_IT(), HAL_DMA2D_ProgramLineEvent(), and HAL_DMA2D_Start_IT().

◆ __HAL_DMA2D_DISABLE_IT

#define __HAL_DMA2D_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dma2d.h>

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

Disable the specified DMA2D interrupts.

Parameters
__HANDLE__DMA2D handle
__INTERRUPT__specifies the DMA2D interrupt sources to be disabled. This parameter can be any combination of the following values:
  • DMA2D_IT_CE: Configuration error interrupt mask
  • DMA2D_IT_CTC: CLUT transfer complete interrupt mask
  • DMA2D_IT_CAE: CLUT access error interrupt mask
  • DMA2D_IT_TW: Transfer Watermark interrupt mask
  • DMA2D_IT_TC: Transfer complete interrupt mask
  • DMA2D_IT_TE: Transfer error interrupt mask
Return values
None

Definition at line 387 of file stm32f4xx_hal_dma2d.h.

Referenced by HAL_DMA2D_Abort(), HAL_DMA2D_CLUTLoading_Abort(), and HAL_DMA2D_IRQHandler().

◆ __HAL_DMA2D_GET_IT_SOURCE

#define __HAL_DMA2D_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_dma2d.h>

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

Check whether the specified DMA2D interrupt source is enabled or not.

Parameters
__HANDLE__DMA2D handle
__INTERRUPT__specifies the DMA2D interrupt source to check. This parameter can be one of the following values:
  • DMA2D_IT_CE: Configuration error interrupt mask
  • DMA2D_IT_CTC: CLUT transfer complete interrupt mask
  • DMA2D_IT_CAE: CLUT access error interrupt mask
  • DMA2D_IT_TW: Transfer Watermark interrupt mask
  • DMA2D_IT_TC: Transfer complete interrupt mask
  • DMA2D_IT_TE: Transfer error interrupt mask
Return values
Thestate of INTERRUPT source.

Definition at line 402 of file stm32f4xx_hal_dma2d.h.