STM32F439xx HAL User Manual
Functions
Peripheral Control functions
DMA2D Exported Functions

Peripheral Control functions. More...

Functions

HAL_StatusTypeDef HAL_DMA2D_ConfigLayer (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Configure the DMA2D Layer according to the specified parameters in the DMA2D_InitTypeDef and create the associated handle.
HAL_StatusTypeDef HAL_DMA2D_ConfigCLUT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx)
 Configure the DMA2D CLUT Transfer.
HAL_StatusTypeDef HAL_DMA2D_ProgramLineEvent (DMA2D_HandleTypeDef *hdma2d, uint32_t Line)
 Configure the line watermark.
HAL_StatusTypeDef HAL_DMA2D_EnableDeadTime (DMA2D_HandleTypeDef *hdma2d)
 Enable DMA2D dead time feature.
HAL_StatusTypeDef HAL_DMA2D_DisableDeadTime (DMA2D_HandleTypeDef *hdma2d)
 Disable DMA2D dead time feature.
HAL_StatusTypeDef HAL_DMA2D_ConfigDeadTime (DMA2D_HandleTypeDef *hdma2d, uint8_t DeadTime)
 Configure dead time.

Detailed Description

Peripheral Control functions.

 ===============================================================================
                    ##### Peripheral Control functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure the DMA2D foreground or background layer parameters.
      (+) Configure the DMA2D CLUT transfer.
      (+) Configure the line watermark
      (+) Configure the dead time value.
      (+) Enable or disable the dead time value functionality.


Function Documentation

HAL_StatusTypeDef HAL_DMA2D_ConfigCLUT ( DMA2D_HandleTypeDef hdma2d,
DMA2D_CLUTCfgTypeDef  CLUTCfg,
uint32_t  LayerIdx 
)

Configure the DMA2D CLUT Transfer.

Parameters:
hdma2dPointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.
CLUTCfgPointer to a DMA2D_CLUTCfgTypeDef structure that contains the configuration information for the color look up table.
LayerIdxDMA2D Layer index. This parameter can be one of the following values: 0(background) / 1(foreground)
Return values:
HALstatus

Definition at line 1418 of file stm32f4xx_hal_dma2d.c.

References assert_param, DMA2D_CLUTCfgTypeDef::CLUTColorMode, DMA2D_POSITION_BGPFCCR_CCM, DMA2D_POSITION_BGPFCCR_CS, DMA2D_POSITION_FGPFCCR_CCM, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Instance, IS_DMA2D_CLUT_CM, IS_DMA2D_CLUT_SIZE, IS_DMA2D_LAYER, DMA2D_CLUTCfgTypeDef::pCLUT, DMA2D_CLUTCfgTypeDef::Size, and __DMA2D_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DMA2D_ConfigDeadTime ( DMA2D_HandleTypeDef hdma2d,
uint8_t  DeadTime 
)

Configure dead time.

Note:
The dead time value represents the guaranteed minimum number of cycles between two consecutive transactions on the AHB bus.
Parameters:
hdma2dDMA2D handle.
DeadTimedead time value.
Return values:
HALstatus

Definition at line 1558 of file stm32f4xx_hal_dma2d.c.

References DMA2D_POSITION_AMTCR_DT, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DMA2D_ConfigLayer ( DMA2D_HandleTypeDef hdma2d,
uint32_t  LayerIdx 
)

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

Parameters:
hdma2dpointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.
LayerIdxDMA2D Layer index. This parameter can be one of the following values: 0(background) / 1(foreground)
Return values:
HALstatus

Definition at line 1333 of file stm32f4xx_hal_dma2d.c.

References DMA2D_LayerCfgTypeDef::AlphaMode, assert_param, DMA2D_INPUT_A4, DMA2D_INPUT_A8, DMA2D_M2M, DMA2D_POSITION_BGPFCCR_ALPHA, DMA2D_POSITION_BGPFCCR_AM, DMA2D_R2M, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Init, DMA2D_LayerCfgTypeDef::InputAlpha, DMA2D_LayerCfgTypeDef::InputColorMode, DMA2D_LayerCfgTypeDef::InputOffset, __DMA2D_HandleTypeDef::Instance, IS_DMA2D_ALPHA_MODE, IS_DMA2D_INPUT_COLOR_MODE, IS_DMA2D_LAYER, IS_DMA2D_OFFSET, __DMA2D_HandleTypeDef::LayerCfg, DMA2D_InitTypeDef::Mode, and __DMA2D_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DMA2D_DisableDeadTime ( DMA2D_HandleTypeDef hdma2d)

Disable DMA2D dead time feature.

Parameters:
hdma2dDMA2D handle.
Return values:
HALstatus

Definition at line 1532 of file stm32f4xx_hal_dma2d.c.

References HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DMA2D_EnableDeadTime ( DMA2D_HandleTypeDef hdma2d)

Enable DMA2D dead time feature.

Parameters:
hdma2dDMA2D handle.
Return values:
HALstatus

Definition at line 1509 of file stm32f4xx_hal_dma2d.c.

References HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

HAL_StatusTypeDef HAL_DMA2D_ProgramLineEvent ( DMA2D_HandleTypeDef hdma2d,
uint32_t  Line 
)

Configure the line watermark.

Parameters:
hdma2dPointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D.
LineLine Watermark configuration (maximum 16-bit long value expected).
Note:
HAL_DMA2D_ProgramLineEvent() API enables the transfer watermark interrupt.
The transfer watermark interrupt is disabled once it has occurred.
Return values:
HALstatus

Definition at line 1471 of file stm32f4xx_hal_dma2d.c.

References __HAL_DMA2D_ENABLE_IT, assert_param, DMA2D_IT_TW, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, __DMA2D_HandleTypeDef::Instance, IS_DMA2D_LINEWATERMARK, and __DMA2D_HandleTypeDef::State.