STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Peripheral Control functions

Peripheral Control functions. More...

Collaboration diagram for Peripheral Control functions:

Functions

HAL_StatusTypeDef HAL_DMA2D_ConfigLayer (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Configure the DMA2D Layer according to the specified parameters in the DMA2D_HandleTypeDef.
 
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_DMA2D_ConfigLayer()

HAL_StatusTypeDef HAL_DMA2D_ConfigLayer ( DMA2D_HandleTypeDef * hdma2d,
uint32_t LayerIdx )

#include <stm32f4xx_hal_dma2d.h>

Configure the DMA2D Layer according to the specified parameters in the DMA2D_HandleTypeDef.

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: DMA2D_BACKGROUND_LAYER(0) / DMA2D_FOREGROUND_LAYER(1)
Return values
HALstatus

Definition at line 1729 of file stm32f4xx_hal_dma2d.c.

References __HAL_LOCK, __HAL_UNLOCK, DMA2D_LayerCfgTypeDef::AlphaMode, assert_param, DMA2D_BACKGROUND_LAYER, DMA2D_INPUT_A4, DMA2D_INPUT_A8, DMA2D_M2M, DMA2D_R2M, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_OK, __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_DMA2D_ConfigCLUT()

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

#include <stm32f4xx_hal_dma2d.h>

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: DMA2D_BACKGROUND_LAYER(0) / DMA2D_FOREGROUND_LAYER(1)
Note
API obsolete and maintained for compatibility with legacy. User is invited to resort to HAL_DMA2D_CLUTStartLoad() instead to benefit from code compactness, code size and improved heap usage.
Return values
HALstatus

Definition at line 1826 of file stm32f4xx_hal_dma2d.c.

References __HAL_LOCK, __HAL_UNLOCK, assert_param, DMA2D_CLUTCfgTypeDef::CLUTColorMode, DMA2D_BACKGROUND_LAYER, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_OK, __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_DMA2D_ProgramLineEvent()

HAL_StatusTypeDef HAL_DMA2D_ProgramLineEvent ( DMA2D_HandleTypeDef * hdma2d,
uint32_t Line )

#include <stm32f4xx_hal_dma2d.h>

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 1880 of file stm32f4xx_hal_dma2d.c.

References __HAL_DMA2D_ENABLE_IT, __HAL_LOCK, __HAL_UNLOCK, DMA2D_IT_TW, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_ERROR, HAL_OK, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

◆ HAL_DMA2D_EnableDeadTime()

HAL_StatusTypeDef HAL_DMA2D_EnableDeadTime ( DMA2D_HandleTypeDef * hdma2d)

#include <stm32f4xx_hal_dma2d.h>

Enable DMA2D dead time feature.

Parameters
hdma2dDMA2D handle.
Return values
HALstatus

Definition at line 1916 of file stm32f4xx_hal_dma2d.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_OK, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

◆ HAL_DMA2D_DisableDeadTime()

HAL_StatusTypeDef HAL_DMA2D_DisableDeadTime ( DMA2D_HandleTypeDef * hdma2d)

#include <stm32f4xx_hal_dma2d.h>

Disable DMA2D dead time feature.

Parameters
hdma2dDMA2D handle.
Return values
HALstatus

Definition at line 1939 of file stm32f4xx_hal_dma2d.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_OK, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.

◆ HAL_DMA2D_ConfigDeadTime()

HAL_StatusTypeDef HAL_DMA2D_ConfigDeadTime ( DMA2D_HandleTypeDef * hdma2d,
uint8_t DeadTime )

#include <stm32f4xx_hal_dma2d.h>

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 1965 of file stm32f4xx_hal_dma2d.c.

References __HAL_LOCK, __HAL_UNLOCK, HAL_DMA2D_STATE_BUSY, HAL_DMA2D_STATE_READY, HAL_OK, __DMA2D_HandleTypeDef::Instance, and __DMA2D_HandleTypeDef::State.