Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Functions
HAL_StatusTypeDef	HAL_DMA2D_Init (DMA2D_HandleTypeDef *hdma2d)
	Initialize the DMA2D according to the specified parameters in the DMA2D_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_DMA2D_DeInit (DMA2D_HandleTypeDef *hdma2d)
	Deinitializes the DMA2D peripheral registers to their default reset values. More...
void	HAL_DMA2D_MspInit (DMA2D_HandleTypeDef *hdma2d)
	Initializes the DMA2D MSP. More...
void	HAL_DMA2D_MspDeInit (DMA2D_HandleTypeDef *hdma2d)
	DeInitializes the DMA2D MSP. More...
HAL_StatusTypeDef	HAL_DMA2D_RegisterCallback (DMA2D_HandleTypeDef *hdma2d, HAL_DMA2D_CallbackIDTypeDef CallbackID, pDMA2D_CallbackTypeDef pCallback)
	Register a User DMA2D Callback To be used instead of the weak (overridden) predefined callback. More...
HAL_StatusTypeDef	HAL_DMA2D_UnRegisterCallback (DMA2D_HandleTypeDef *hdma2d, HAL_DMA2D_CallbackIDTypeDef CallbackID)
	Unregister a DMA2D Callback DMA2D Callback is redirected to the weak (overridden) predefined callback. More...

Detailed Description

Initialization and Configuration functions.

 ===============================================================================
                ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Initialize and configure the DMA2D
      (+) De-initialize the DMA2D

Function Documentation

HAL_DMA2D_DeInit()

HAL_StatusTypeDef HAL_DMA2D_DeInit

(

DMA2D_HandleTypeDef *

hdma2d

)

Deinitializes the DMA2D peripheral registers to their default reset values.

Parameters

hdma2d

pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.

Return values

None

Definition at line 306 of file stm32f4xx_hal_dma2d.c.

HAL_DMA2D_Init()

HAL_StatusTypeDef HAL_DMA2D_Init

(

DMA2D_HandleTypeDef *

hdma2d

)

Initialize the DMA2D according to the specified parameters in the DMA2D_InitTypeDef and create the associated handle.

Parameters

hdma2d

pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.

Return values

HAL

status

Definition at line 238 of file stm32f4xx_hal_dma2d.c.

HAL_DMA2D_MspDeInit()

__weak void HAL_DMA2D_MspDeInit

(

DMA2D_HandleTypeDef *

hdma2d

)

DeInitializes the DMA2D MSP.

Parameters

hdma2d

pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.

Return values

None

Definition at line 412 of file stm32f4xx_hal_dma2d.c.

HAL_DMA2D_MspInit()

__weak void HAL_DMA2D_MspInit

(

DMA2D_HandleTypeDef *

hdma2d

)

Initializes the DMA2D MSP.

Parameters

hdma2d

pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.

Return values

None

Definition at line 396 of file stm32f4xx_hal_dma2d.c.

HAL_DMA2D_RegisterCallback()

HAL_StatusTypeDef HAL_DMA2D_RegisterCallback	(	DMA2D_HandleTypeDef *	hdma2d,
		HAL_DMA2D_CallbackIDTypeDef	CallbackID,
		pDMA2D_CallbackTypeDef	pCallback
	)

Register a User DMA2D Callback To be used instead of the weak (overridden) predefined callback.

Parameters

hdma2d	DMA2D handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_DMA2D_TRANSFERCOMPLETE_CB_ID DMA2D transfer complete Callback ID HAL_DMA2D_TRANSFERERROR_CB_ID DMA2D transfer error Callback ID HAL_DMA2D_LINEEVENT_CB_ID DMA2D line event Callback ID HAL_DMA2D_CLUTLOADINGCPLT_CB_ID DMA2D CLUT loading completion Callback ID HAL_DMA2D_MSPINIT_CB_ID DMA2D MspInit callback ID HAL_DMA2D_MSPDEINIT_CB_ID DMA2D MspDeInit callback ID
pCallback	pointer to the Callback function

Note

No weak predefined callbacks are defined for HAL_DMA2D_TRANSFERCOMPLETE_CB_ID or HAL_DMA2D_TRANSFERERROR_CB_ID

Return values

status

Definition at line 439 of file stm32f4xx_hal_dma2d.c.

HAL_DMA2D_UnRegisterCallback()

HAL_StatusTypeDef HAL_DMA2D_UnRegisterCallback	(	DMA2D_HandleTypeDef *	hdma2d,
		HAL_DMA2D_CallbackIDTypeDef	CallbackID
	)

Unregister a DMA2D Callback DMA2D Callback is redirected to the weak (overridden) predefined callback.

Parameters

hdma2d

DMA2D handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_DMA2D_TRANSFERCOMPLETE_CB_ID DMA2D transfer complete Callback ID HAL_DMA2D_TRANSFERERROR_CB_ID DMA2D transfer error Callback ID HAL_DMA2D_LINEEVENT_CB_ID DMA2D line event Callback ID HAL_DMA2D_CLUTLOADINGCPLT_CB_ID DMA2D CLUT loading completion Callback ID HAL_DMA2D_MSPINIT_CB_ID DMA2D MspInit callback ID HAL_DMA2D_MSPDEINIT_CB_ID DMA2D MspDeInit callback ID

Note

No weak predefined callbacks are defined for HAL_DMA2D_TRANSFERCOMPLETE_CB_ID or HAL_DMA2D_TRANSFERERROR_CB_ID

Return values

status

Definition at line 537 of file stm32f4xx_hal_dma2d.c.