STM32F439xx HAL User Manual
Modules | Functions
Configuration Functions
DMA2D Exported Functions

Modules

 Foreground Configuration Functions
 Background Configuration Functions

Functions

__STATIC_INLINE void LL_DMA2D_Start (DMA2D_TypeDef *DMA2Dx)
 Start a DMA2D transfer.
__STATIC_INLINE uint32_t LL_DMA2D_IsTransferOngoing (DMA2D_TypeDef *DMA2Dx)
 Indicate if a DMA2D transfer is ongoing.
__STATIC_INLINE void LL_DMA2D_Suspend (DMA2D_TypeDef *DMA2Dx)
 Suspend DMA2D transfer.
__STATIC_INLINE void LL_DMA2D_Resume (DMA2D_TypeDef *DMA2Dx)
 Resume DMA2D transfer.
__STATIC_INLINE uint32_t LL_DMA2D_IsSuspended (DMA2D_TypeDef *DMA2Dx)
 Indicate if DMA2D transfer is suspended.
__STATIC_INLINE void LL_DMA2D_Abort (DMA2D_TypeDef *DMA2Dx)
 Abort DMA2D transfer.
__STATIC_INLINE uint32_t LL_DMA2D_IsAborted (DMA2D_TypeDef *DMA2Dx)
 Indicate if DMA2D transfer is aborted.
__STATIC_INLINE void LL_DMA2D_SetMode (DMA2D_TypeDef *DMA2Dx, uint32_t Mode)
 Set DMA2D mode.
__STATIC_INLINE uint32_t LL_DMA2D_GetMode (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D mode.
__STATIC_INLINE void LL_DMA2D_SetOutputColorMode (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
 Set DMA2D output color mode.
__STATIC_INLINE uint32_t LL_DMA2D_GetOutputColorMode (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D output color mode.
__STATIC_INLINE void LL_DMA2D_SetLineOffset (DMA2D_TypeDef *DMA2Dx, uint32_t LineOffset)
 Set DMA2D line offset, expressed on 14 bits ([13:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetLineOffset (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D line offset, expressed on 14 bits ([13:0] bits).
__STATIC_INLINE void LL_DMA2D_SetNbrOfPixelsPerLines (DMA2D_TypeDef *DMA2Dx, uint32_t NbrOfPixelsPerLines)
 Set DMA2D number of pixels per lines, expressed on 14 bits ([13:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetNbrOfPixelsPerLines (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D number of pixels per lines, expressed on 14 bits ([13:0] bits)
__STATIC_INLINE void LL_DMA2D_SetNbrOfLines (DMA2D_TypeDef *DMA2Dx, uint32_t NbrOfLines)
 Set DMA2D number of lines, expressed on 16 bits ([15:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetNbrOfLines (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D number of lines, expressed on 16 bits ([15:0] bits).
__STATIC_INLINE void LL_DMA2D_SetOutputMemAddr (DMA2D_TypeDef *DMA2Dx, uint32_t OutputMemoryAddress)
 Set DMA2D output memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetOutputMemAddr (DMA2D_TypeDef *DMA2Dx)
 Get DMA2D output memory address, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE void LL_DMA2D_SetOutputColor (DMA2D_TypeDef *DMA2Dx, uint32_t OutputColor)
 Set DMA2D output color, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetOutputColor (DMA2D_TypeDef *DMA2Dx)
 Get DMA2D output color, expressed on 32 bits ([31:0] bits).
__STATIC_INLINE void LL_DMA2D_SetLineWatermark (DMA2D_TypeDef *DMA2Dx, uint32_t LineWatermark)
 Set DMA2D line watermark, expressed on 16 bits ([15:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetLineWatermark (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D line watermark, expressed on 16 bits ([15:0] bits).
__STATIC_INLINE void LL_DMA2D_SetDeadTime (DMA2D_TypeDef *DMA2Dx, uint32_t DeadTime)
 Set DMA2D dead time, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE uint32_t LL_DMA2D_GetDeadTime (DMA2D_TypeDef *DMA2Dx)
 Return DMA2D dead time, expressed on 8 bits ([7:0] bits).
__STATIC_INLINE void LL_DMA2D_EnableDeadTime (DMA2D_TypeDef *DMA2Dx)
 Enable DMA2D dead time functionality.
__STATIC_INLINE void LL_DMA2D_DisableDeadTime (DMA2D_TypeDef *DMA2Dx)
 Disable DMA2D dead time functionality.
__STATIC_INLINE uint32_t LL_DMA2D_IsEnabledDeadTime (DMA2D_TypeDef *DMA2Dx)
 Indicate if DMA2D dead time functionality is enabled.

Function Documentation

__STATIC_INLINE void LL_DMA2D_Abort ( DMA2D_TypeDef *  DMA2Dx)

Abort DMA2D transfer.

Note:
This API can be used to abort automatic foreground or background CLUT loading.
Reference Manual to LL API cross reference:
CR ABORT LL_DMA2D_Abort
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 499 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_DisableDeadTime ( DMA2D_TypeDef *  DMA2Dx)

Disable DMA2D dead time functionality.

Reference Manual to LL API cross reference:
AMTCR EN LL_DMA2D_DisableDeadTime
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 774 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_EnableDeadTime ( DMA2D_TypeDef *  DMA2Dx)

Enable DMA2D dead time functionality.

Reference Manual to LL API cross reference:
AMTCR EN LL_DMA2D_EnableDeadTime
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 763 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetDeadTime ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D dead time, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:
AMTCR DT LL_DMA2D_GetDeadTime
Parameters:
DMA2DxDMA2D Instance
Return values:
Deadtime value between Min_Data=0 and Max_Data=0xFF

Definition at line 752 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetLineOffset ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D line offset, expressed on 14 bits ([13:0] bits).

Reference Manual to LL API cross reference:
OOR LO LL_DMA2D_GetLineOffset
Parameters:
DMA2DxDMA2D Instance
Return values:
Lineoffset value between Min_Data=0 and Max_Data=0x3FFF

Definition at line 599 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetLineWatermark ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D line watermark, expressed on 16 bits ([15:0] bits).

Reference Manual to LL API cross reference:
LWR LW LL_DMA2D_GetLineWatermark
Parameters:
DMA2DxDMA2D Instance
Return values:
Linewatermark value between Min_Data=0 and Max_Data=0xFFFF

Definition at line 729 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetMode ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D mode.

Reference Manual to LL API cross reference:
CR MODE LL_DMA2D_GetMode
Parameters:
DMA2DxDMA2D Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 543 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetNbrOfLines ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D number of lines, expressed on 16 bits ([15:0] bits).

Reference Manual to LL API cross reference:
NLR NL LL_DMA2D_GetNbrOfLines
Parameters:
DMA2DxDMA2D Instance
Return values:
Numberof lines value between Min_Data=0 and Max_Data=0xFFFF

Definition at line 645 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetNbrOfPixelsPerLines ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D number of pixels per lines, expressed on 14 bits ([13:0] bits)

Reference Manual to LL API cross reference:
NLR PL LL_DMA2D_GetNbrOfPixelsPerLines
Parameters:
DMA2DxDMA2D Instance
Return values:
Numberof pixels per lines value between Min_Data=0 and Max_Data=0x3FFF

Definition at line 622 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetOutputColor ( DMA2D_TypeDef *  DMA2Dx)

Get DMA2D output color, expressed on 32 bits ([31:0] bits).

Note:
Alpha channel and red, green, blue color values must be retrieved from the returned value based on the output color mode (ARGB8888, RGB888, RGB565, ARGB1555 or ARGB4444) as set by LL_DMA2D_SetOutputColorMode.
Reference Manual to LL API cross reference:
OCOLR BLUE LL_DMA2D_GetOutputColor
OCOLR GREEN LL_DMA2D_GetOutputColor
OCOLR RED LL_DMA2D_GetOutputColor
OCOLR ALPHA LL_DMA2D_GetOutputColor
Parameters:
DMA2DxDMA2D Instance
Return values:
Outputcolor value between Min_Data=0 and Max_Data=0xFFFFFFFF

Definition at line 705 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetOutputColorMode ( DMA2D_TypeDef *  DMA2Dx)

Return DMA2D output color mode.

Reference Manual to LL API cross reference:
OPFCCR CM LL_DMA2D_GetOutputColorMode
Parameters:
DMA2DxDMA2D Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 576 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_GetOutputMemAddr ( DMA2D_TypeDef *  DMA2Dx)

Get DMA2D output memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:
OMAR MA LL_DMA2D_GetOutputMemAddr
Parameters:
DMA2DxDMA2D Instance
Return values:
Outputmemory address value between Min_Data=0 and Max_Data=0xFFFFFFFF

Definition at line 668 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_ReadReg.

__STATIC_INLINE uint32_t LL_DMA2D_IsAborted ( DMA2D_TypeDef *  DMA2Dx)

Indicate if DMA2D transfer is aborted.

Note:
This API can be used to indicate whether or not automatic foreground or background CLUT loading is aborted.
Reference Manual to LL API cross reference:
CR ABORT LL_DMA2D_IsAborted
Parameters:
DMA2DxDMA2D Instance
Return values:
Stateof bit (1 or 0).

Definition at line 512 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_IsEnabledDeadTime ( DMA2D_TypeDef *  DMA2Dx)

Indicate if DMA2D dead time functionality is enabled.

Reference Manual to LL API cross reference:
AMTCR EN LL_DMA2D_IsEnabledDeadTime
Parameters:
DMA2DxDMA2D Instance
Return values:
Stateof bit (1 or 0).

Definition at line 785 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_IsSuspended ( DMA2D_TypeDef *  DMA2Dx)

Indicate if DMA2D transfer is suspended.

Note:
This API can be used to indicate whether or not automatic foreground or background CLUT loading is suspended.
Reference Manual to LL API cross reference:
CR SUSP LL_DMA2D_IsSuspended
Parameters:
DMA2DxDMA2D Instance
Return values:
Stateof bit (1 or 0).

Definition at line 487 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE uint32_t LL_DMA2D_IsTransferOngoing ( DMA2D_TypeDef *  DMA2Dx)

Indicate if a DMA2D transfer is ongoing.

Reference Manual to LL API cross reference:
CR START LL_DMA2D_IsTransferOngoing
Parameters:
DMA2DxDMA2D Instance
Return values:
Stateof bit (1 or 0).

Definition at line 450 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_Init().

__STATIC_INLINE void LL_DMA2D_Resume ( DMA2D_TypeDef *  DMA2Dx)

Resume DMA2D transfer.

Note:
This API can be used to resume automatic foreground or background CLUT loading.
Reference Manual to LL API cross reference:
CR SUSP LL_DMA2D_Resume
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 474 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetDeadTime ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  DeadTime 
)

Set DMA2D dead time, expressed on 8 bits ([7:0] bits).

Reference Manual to LL API cross reference:
AMTCR DT LL_DMA2D_SetDeadTime
Parameters:
DMA2DxDMA2D Instance
DeadTimeValue between Min_Data=0 and Max_Data=0xFF
Return values:
None

Definition at line 741 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetLineOffset ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  LineOffset 
)

Set DMA2D line offset, expressed on 14 bits ([13:0] bits).

Reference Manual to LL API cross reference:
OOR LO LL_DMA2D_SetLineOffset
Parameters:
DMA2DxDMA2D Instance
LineOffsetValue between Min_Data=0 and Max_Data=0x3FFF
Return values:
None

Definition at line 588 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_Init().

__STATIC_INLINE void LL_DMA2D_SetLineWatermark ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  LineWatermark 
)

Set DMA2D line watermark, expressed on 16 bits ([15:0] bits).

Reference Manual to LL API cross reference:
LWR LW LL_DMA2D_SetLineWatermark
Parameters:
DMA2DxDMA2D Instance
LineWatermarkValue between Min_Data=0 and Max_Data=0xFFFF
Return values:
None

Definition at line 718 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetMode ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  Mode 
)

Set DMA2D mode.

Reference Manual to LL API cross reference:
CR MODE LL_DMA2D_SetMode
Parameters:
DMA2DxDMA2D Instance
ModeThis parameter can be one of the following values:
Return values:
None

Definition at line 528 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_Init().

__STATIC_INLINE void LL_DMA2D_SetNbrOfLines ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  NbrOfLines 
)

Set DMA2D number of lines, expressed on 16 bits ([15:0] bits).

Reference Manual to LL API cross reference:
NLR NL LL_DMA2D_SetNbrOfLines
Parameters:
DMA2DxDMA2D Instance
NbrOfLinesValue between Min_Data=0 and Max_Data=0xFFFF
Return values:
None

Definition at line 634 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetNbrOfPixelsPerLines ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  NbrOfPixelsPerLines 
)

Set DMA2D number of pixels per lines, expressed on 14 bits ([13:0] bits).

Reference Manual to LL API cross reference:
NLR PL LL_DMA2D_SetNbrOfPixelsPerLines
Parameters:
DMA2DxDMA2D Instance
NbrOfPixelsPerLinesValue between Min_Data=0 and Max_Data=0x3FFF
Return values:
None

Definition at line 611 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetOutputColor ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  OutputColor 
)

Set DMA2D output color, expressed on 32 bits ([31:0] bits).

Note:
Output color format depends on output color mode, ARGB8888, RGB888, RGB565, ARGB1555 or ARGB4444.
LL_DMA2D_ConfigOutputColor() API may be used instead if colors values formatting with respect to color mode is not done by the user code.
Reference Manual to LL API cross reference:
OCOLR BLUE LL_DMA2D_SetOutputColor
OCOLR GREEN LL_DMA2D_SetOutputColor
OCOLR RED LL_DMA2D_SetOutputColor
OCOLR ALPHA LL_DMA2D_SetOutputColor
Parameters:
DMA2DxDMA2D Instance
OutputColorValue between Min_Data=0 and Max_Data=0xFFFFFFFF
Return values:
None

Definition at line 687 of file stm32f4xx_ll_dma2d.h.

Referenced by LL_DMA2D_ConfigOutputColor().

__STATIC_INLINE void LL_DMA2D_SetOutputColorMode ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  ColorMode 
)

Set DMA2D output color mode.

Reference Manual to LL API cross reference:
OPFCCR CM LL_DMA2D_SetOutputColorMode
Parameters:
DMA2DxDMA2D Instance
ColorModeThis parameter can be one of the following values:
Return values:
None

Definition at line 560 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_SetOutputMemAddr ( DMA2D_TypeDef *  DMA2Dx,
uint32_t  OutputMemoryAddress 
)

Set DMA2D output memory address, expressed on 32 bits ([31:0] bits).

Reference Manual to LL API cross reference:
OMAR MA LL_DMA2D_SetOutputMemAddr
Parameters:
DMA2DxDMA2D Instance
OutputMemoryAddressValue between Min_Data=0 and Max_Data=0xFFFFFFFF
Return values:
None

Definition at line 657 of file stm32f4xx_ll_dma2d.h.

References LL_DMA2D_WriteReg.

Referenced by LL_DMA2D_Init().

__STATIC_INLINE void LL_DMA2D_Start ( DMA2D_TypeDef *  DMA2Dx)

Start a DMA2D transfer.

Reference Manual to LL API cross reference:
CR START LL_DMA2D_Start
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 439 of file stm32f4xx_ll_dma2d.h.

__STATIC_INLINE void LL_DMA2D_Suspend ( DMA2D_TypeDef *  DMA2Dx)

Suspend DMA2D transfer.

Note:
This API can be used to suspend automatic foreground or background CLUT loading.
Reference Manual to LL API cross reference:
CR SUSP LL_DMA2D_Suspend
Parameters:
DMA2DxDMA2D Instance
Return values:
None

Definition at line 462 of file stm32f4xx_ll_dma2d.h.