Initialization and De-initialization Functions

Functions
ErrorStatus	LL_DMA2D_DeInit (DMA2D_TypeDef *DMA2Dx)
	De-initialize DMA2D registers (registers restored to their default values).
ErrorStatus	LL_DMA2D_Init (DMA2D_TypeDef *DMA2Dx, LL_DMA2D_InitTypeDef *DMA2D_InitStruct)
	Initialize DMA2D registers according to the specified parameters in DMA2D_InitStruct.
void	LL_DMA2D_StructInit (LL_DMA2D_InitTypeDef *DMA2D_InitStruct)
	Set each LL_DMA2D_InitTypeDef field to default value.
void	LL_DMA2D_ConfigLayer (DMA2D_TypeDef *DMA2Dx, LL_DMA2D_LayerCfgTypeDef *DMA2D_LayerCfg, uint32_t LayerIdx)
	Configure the foreground or background according to the specified parameters in the LL_DMA2D_LayerCfgTypeDef structure.
void	LL_DMA2D_LayerCfgStructInit (LL_DMA2D_LayerCfgTypeDef *DMA2D_LayerCfg)
	Set each LL_DMA2D_LayerCfgTypeDef field to default value.
void	LL_DMA2D_ConfigOutputColor (DMA2D_TypeDef *DMA2Dx, LL_DMA2D_ColorTypeDef *DMA2D_ColorStruct)
	Initialize DMA2D output color register according to the specified parameters in DMA2D_ColorStruct.
uint32_t	LL_DMA2D_GetOutputBlueColor (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
	Return DMA2D output Blue color.
uint32_t	LL_DMA2D_GetOutputGreenColor (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
	Return DMA2D output Green color.
uint32_t	LL_DMA2D_GetOutputRedColor (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
	Return DMA2D output Red color.
uint32_t	LL_DMA2D_GetOutputAlphaColor (DMA2D_TypeDef *DMA2Dx, uint32_t ColorMode)
	Return DMA2D output Alpha color.
void	LL_DMA2D_ConfigSize (DMA2D_TypeDef *DMA2Dx, uint32_t NbrOfLines, uint32_t NbrOfPixelsPerLines)
	Configure DMA2D transfer size.

---

Function Documentation

void LL_DMA2D_ConfigLayer	(	DMA2D_TypeDef *	DMA2Dx,
		LL_DMA2D_LayerCfgTypeDef *	DMA2D_LayerCfg,
		uint32_t	LayerIdx
	)

Configure the foreground or background according to the specified parameters in the LL_DMA2D_LayerCfgTypeDef structure.

Parameters:

DMA2Dx	DMA2D Instance
DMA2D_LayerCfg	pointer to a LL_DMA2D_LayerCfgTypeDef structure that contains the configuration information for the specified layer.
LayerIdx	DMA2D Layer index. This parameter can be one of the following values: 0(background) / 1(foreground)

Return values:

None

Definition at line 257 of file stm32f4xx_ll_dma2d.c.

References LL_DMA2D_LayerCfgTypeDef::Alpha, LL_DMA2D_LayerCfgTypeDef::AlphaMode, assert_param, LL_DMA2D_LayerCfgTypeDef::Blue, LL_DMA2D_LayerCfgTypeDef::CLUTColorMode, LL_DMA2D_LayerCfgTypeDef::CLUTMemoryAddress, LL_DMA2D_LayerCfgTypeDef::CLUTSize, LL_DMA2D_LayerCfgTypeDef::ColorMode, LL_DMA2D_LayerCfgTypeDef::Green, IS_LL_DMA2D_ALPHA, IS_LL_DMA2D_ALPHAMODE, IS_LL_DMA2D_BLUE, IS_LL_DMA2D_CLUTCMODE, IS_LL_DMA2D_CLUTSIZE, IS_LL_DMA2D_GREEN, IS_LL_DMA2D_LCMODE, IS_LL_DMA2D_OFFSET, IS_LL_DMA2D_RED, LL_DMA2D_LayerCfgTypeDef::LineOffset, LL_DMA2D_BGND_SetCLUTMemAddr(), LL_DMA2D_BGND_SetColor(), LL_DMA2D_BGND_SetLineOffset(), LL_DMA2D_BGND_SetMemAddr(), LL_DMA2D_FGND_SetCLUTMemAddr(), LL_DMA2D_FGND_SetColor(), LL_DMA2D_FGND_SetLineOffset(), LL_DMA2D_FGND_SetMemAddr(), LL_DMA2D_LayerCfgTypeDef::MemoryAddress, and LL_DMA2D_LayerCfgTypeDef::Red.

void LL_DMA2D_ConfigOutputColor	(	DMA2D_TypeDef *	DMA2Dx,
		LL_DMA2D_ColorTypeDef *	DMA2D_ColorStruct
	)

Initialize DMA2D output color register according to the specified parameters in DMA2D_ColorStruct.

Parameters:

DMA2Dx	DMA2D Instance
DMA2D_ColorStruct	pointer to a LL_DMA2D_ColorTypeDef structure that contains the color configuration information for the specified DMA2D peripheral.

Return values:

None

Definition at line 344 of file stm32f4xx_ll_dma2d.c.

References assert_param, LL_DMA2D_ColorTypeDef::ColorMode, IS_LL_DMA2D_ALPHA, IS_LL_DMA2D_BLUE, IS_LL_DMA2D_GREEN, IS_LL_DMA2D_OCMODE, IS_LL_DMA2D_RED, LL_DMA2D_OUTPUT_MODE_ARGB1555, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_OUTPUT_MODE_RGB565, LL_DMA2D_OUTPUT_MODE_RGB888, LL_DMA2D_SetOutputColor(), LL_DMA2D_ColorTypeDef::OutputAlpha, LL_DMA2D_ColorTypeDef::OutputBlue, LL_DMA2D_ColorTypeDef::OutputGreen, and LL_DMA2D_ColorTypeDef::OutputRed.

Referenced by LL_DMA2D_Init().

void LL_DMA2D_ConfigSize	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	NbrOfLines,
		uint32_t	NbrOfPixelsPerLines
	)

Configure DMA2D transfer size.

Parameters:

DMA2Dx	DMA2D Instance
NbrOfLines	Value between Min_Data=0 and Max_Data=0xFFFF
NbrOfPixelsPerLines	Value between Min_Data=0 and Max_Data=0x3FFF

Return values:

None

Definition at line 571 of file stm32f4xx_ll_dma2d.c.

Referenced by LL_DMA2D_Init().

ErrorStatus LL_DMA2D_DeInit

(

DMA2D_TypeDef *

DMA2Dx

)

De-initialize DMA2D registers (registers restored to their default values).

Parameters:

DMA2Dx

DMA2D Instance

Return values:

An	ErrorStatus enumeration value: SUCCESS: DMA2D registers are de-initialized ERROR: DMA2D registers are not de-initialized

Definition at line 137 of file stm32f4xx_ll_dma2d.c.

References assert_param, LL_AHB1_GRP1_ForceReset(), LL_AHB1_GRP1_PERIPH_DMA2D, and LL_AHB1_GRP1_ReleaseReset().

uint32_t LL_DMA2D_GetOutputAlphaColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	ColorMode
	)

Return DMA2D output Alpha color.

Parameters:

DMA2Dx	DMA2D Instance.
ColorMode	This parameter can be one of the following values: LL_DMA2D_OUTPUT_MODE_ARGB8888 LL_DMA2D_OUTPUT_MODE_RGB888 LL_DMA2D_OUTPUT_MODE_RGB565 LL_DMA2D_OUTPUT_MODE_ARGB1555 LL_DMA2D_OUTPUT_MODE_ARGB4444

Return values:

Output

Alpha color value between Min_Data=0 and Max_Data=0xFF

Definition at line 535 of file stm32f4xx_ll_dma2d.c.

References assert_param, IS_LL_DMA2D_OCMODE, LL_DMA2D_OUTPUT_MODE_ARGB1555, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_OUTPUT_MODE_RGB565, and LL_DMA2D_OUTPUT_MODE_RGB888.

uint32_t LL_DMA2D_GetOutputBlueColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	ColorMode
	)

Return DMA2D output Blue color.

Parameters:

DMA2Dx	DMA2D Instance.
ColorMode	This parameter can be one of the following values: LL_DMA2D_OUTPUT_MODE_ARGB8888 LL_DMA2D_OUTPUT_MODE_RGB888 LL_DMA2D_OUTPUT_MODE_RGB565 LL_DMA2D_OUTPUT_MODE_ARGB1555 LL_DMA2D_OUTPUT_MODE_ARGB4444

Return values:

Output

Blue color value between Min_Data=0 and Max_Data=0xFF

Definition at line 403 of file stm32f4xx_ll_dma2d.c.

References assert_param, IS_LL_DMA2D_OCMODE, LL_DMA2D_OUTPUT_MODE_ARGB1555, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_OUTPUT_MODE_RGB565, and LL_DMA2D_OUTPUT_MODE_RGB888.

uint32_t LL_DMA2D_GetOutputGreenColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	ColorMode
	)

Return DMA2D output Green color.

Parameters:

DMA2Dx	DMA2D Instance.
ColorMode	This parameter can be one of the following values: LL_DMA2D_OUTPUT_MODE_ARGB8888 LL_DMA2D_OUTPUT_MODE_RGB888 LL_DMA2D_OUTPUT_MODE_RGB565 LL_DMA2D_OUTPUT_MODE_ARGB1555 LL_DMA2D_OUTPUT_MODE_ARGB4444

Return values:

Output

Green color value between Min_Data=0 and Max_Data=0xFF

Definition at line 447 of file stm32f4xx_ll_dma2d.c.

References assert_param, IS_LL_DMA2D_OCMODE, LL_DMA2D_OUTPUT_MODE_ARGB1555, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_OUTPUT_MODE_RGB565, and LL_DMA2D_OUTPUT_MODE_RGB888.

uint32_t LL_DMA2D_GetOutputRedColor	(	DMA2D_TypeDef *	DMA2Dx,
		uint32_t	ColorMode
	)

Return DMA2D output Red color.

Parameters:

DMA2Dx	DMA2D Instance.
ColorMode	This parameter can be one of the following values: LL_DMA2D_OUTPUT_MODE_ARGB8888 LL_DMA2D_OUTPUT_MODE_RGB888 LL_DMA2D_OUTPUT_MODE_RGB565 LL_DMA2D_OUTPUT_MODE_ARGB1555 LL_DMA2D_OUTPUT_MODE_ARGB4444

Return values:

Output

Red color value between Min_Data=0 and Max_Data=0xFF

Definition at line 491 of file stm32f4xx_ll_dma2d.c.

References assert_param, IS_LL_DMA2D_OCMODE, LL_DMA2D_OUTPUT_MODE_ARGB1555, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_OUTPUT_MODE_RGB565, and LL_DMA2D_OUTPUT_MODE_RGB888.

ErrorStatus LL_DMA2D_Init	(	DMA2D_TypeDef *	DMA2Dx,
		LL_DMA2D_InitTypeDef *	DMA2D_InitStruct
	)

Initialize DMA2D registers according to the specified parameters in DMA2D_InitStruct.

Note:

DMA2D transfers must be disabled to set initialization bits in configuration registers, otherwise ERROR result is returned.

Parameters:

DMA2Dx	DMA2D Instance
DMA2D_InitStruct	pointer to a LL_DMA2D_InitTypeDef structure that contains the configuration information for the specified DMA2D peripheral.

Return values:

An	ErrorStatus enumeration value: SUCCESS: DMA2D registers are initialized according to DMA2D_InitStruct content ERROR: Issue occurred during DMA2D registers initialization

Definition at line 171 of file stm32f4xx_ll_dma2d.c.

References assert_param, LL_DMA2D_InitTypeDef::ColorMode, LL_DMA2D_ColorTypeDef::ColorMode, IS_LL_DMA2D_ALPHA, IS_LL_DMA2D_BLUE, IS_LL_DMA2D_GREEN, IS_LL_DMA2D_LINE, IS_LL_DMA2D_MODE, IS_LL_DMA2D_OCMODE, IS_LL_DMA2D_OFFSET, IS_LL_DMA2D_PIXEL, IS_LL_DMA2D_RED, LL_DMA2D_InitTypeDef::LineOffset, LL_DMA2D_BGND_IsEnabledCLUTLoad(), LL_DMA2D_ConfigOutputColor(), LL_DMA2D_ConfigSize(), LL_DMA2D_FGND_IsEnabledCLUTLoad(), LL_DMA2D_IsTransferOngoing(), LL_DMA2D_SetLineOffset(), LL_DMA2D_SetMode(), LL_DMA2D_SetOutputMemAddr(), LL_DMA2D_InitTypeDef::Mode, LL_DMA2D_InitTypeDef::NbrOfLines, LL_DMA2D_InitTypeDef::NbrOfPixelsPerLines, LL_DMA2D_InitTypeDef::OutputAlpha, LL_DMA2D_ColorTypeDef::OutputAlpha, LL_DMA2D_InitTypeDef::OutputBlue, LL_DMA2D_ColorTypeDef::OutputBlue, LL_DMA2D_InitTypeDef::OutputGreen, LL_DMA2D_ColorTypeDef::OutputGreen, LL_DMA2D_InitTypeDef::OutputMemoryAddress, LL_DMA2D_InitTypeDef::OutputRed, and LL_DMA2D_ColorTypeDef::OutputRed.

void LL_DMA2D_LayerCfgStructInit

(

LL_DMA2D_LayerCfgTypeDef *

DMA2D_LayerCfg

)

Set each LL_DMA2D_LayerCfgTypeDef field to default value.

Parameters:

DMA2D_LayerCfg

pointer to a LL_DMA2D_LayerCfgTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 320 of file stm32f4xx_ll_dma2d.c.

References LL_DMA2D_LayerCfgTypeDef::Alpha, LL_DMA2D_LayerCfgTypeDef::AlphaMode, LL_DMA2D_LayerCfgTypeDef::Blue, LL_DMA2D_LayerCfgTypeDef::CLUTColorMode, LL_DMA2D_LayerCfgTypeDef::CLUTMemoryAddress, LL_DMA2D_LayerCfgTypeDef::CLUTSize, LL_DMA2D_LayerCfgTypeDef::ColorMode, LL_DMA2D_LayerCfgTypeDef::Green, LL_DMA2D_LayerCfgTypeDef::LineOffset, LL_DMA2D_ALPHA_MODE_NO_MODIF, LL_DMA2D_CLUT_COLOR_MODE_ARGB8888, LL_DMA2D_INPUT_MODE_ARGB8888, LL_DMA2D_LayerCfgTypeDef::MemoryAddress, and LL_DMA2D_LayerCfgTypeDef::Red.

void LL_DMA2D_StructInit

(

LL_DMA2D_InitTypeDef *

DMA2D_InitStruct

)

Set each LL_DMA2D_InitTypeDef field to default value.

Parameters:

DMA2D_InitStruct

pointer to a LL_DMA2D_InitTypeDef structure whose fields will be set to default values.

Return values:

None

Definition at line 231 of file stm32f4xx_ll_dma2d.c.

References LL_DMA2D_InitTypeDef::ColorMode, LL_DMA2D_InitTypeDef::LineOffset, LL_DMA2D_MODE_M2M, LL_DMA2D_OUTPUT_MODE_ARGB8888, LL_DMA2D_InitTypeDef::Mode, LL_DMA2D_InitTypeDef::NbrOfLines, LL_DMA2D_InitTypeDef::NbrOfPixelsPerLines, LL_DMA2D_InitTypeDef::OutputAlpha, LL_DMA2D_InitTypeDef::OutputBlue, LL_DMA2D_InitTypeDef::OutputGreen, LL_DMA2D_InitTypeDef::OutputMemoryAddress, and LL_DMA2D_InitTypeDef::OutputRed.