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. More... | |
| HAL_StatusTypeDef | HAL_DMA2D_ConfigCLUT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx) |
| Configure the DMA2D CLUT Transfer. More... | |
| HAL_StatusTypeDef | HAL_DMA2D_ProgramLineEvent (DMA2D_HandleTypeDef *hdma2d, uint32_t Line) |
| Configure the line watermark. More... | |
| HAL_StatusTypeDef | HAL_DMA2D_EnableDeadTime (DMA2D_HandleTypeDef *hdma2d) |
| Enable DMA2D dead time feature. More... | |
| HAL_StatusTypeDef | HAL_DMA2D_DisableDeadTime (DMA2D_HandleTypeDef *hdma2d) |
| Disable DMA2D dead time feature. More... | |
| HAL_StatusTypeDef | HAL_DMA2D_ConfigDeadTime (DMA2D_HandleTypeDef *hdma2d, uint8_t DeadTime) |
| Configure dead time. More... | |
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_ConfigCLUT()
| HAL_StatusTypeDef HAL_DMA2D_ConfigCLUT | ( | DMA2D_HandleTypeDef * | hdma2d, |
| DMA2D_CLUTCfgTypeDef | CLUTCfg, | ||
| uint32_t | LayerIdx | ||
| ) |
Configure the DMA2D CLUT Transfer.
- Parameters
-
hdma2d Pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D. CLUTCfg Pointer to a DMA2D_CLUTCfgTypeDef structure that contains the configuration information for the color look up table. LayerIdx DMA2D 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
-
HAL status
Definition at line 1826 of file stm32f4xx_hal_dma2d.c.
◆ HAL_DMA2D_ConfigDeadTime()
| 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
-
hdma2d DMA2D handle. DeadTime dead time value.
- Return values
-
HAL status
Definition at line 1965 of file stm32f4xx_hal_dma2d.c.
◆ HAL_DMA2D_ConfigLayer()
| HAL_StatusTypeDef HAL_DMA2D_ConfigLayer | ( | DMA2D_HandleTypeDef * | hdma2d, |
| uint32_t | LayerIdx | ||
| ) |
Configure the DMA2D Layer according to the specified parameters in the DMA2D_HandleTypeDef.
- Parameters
-
hdma2d Pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D. LayerIdx DMA2D Layer index. This parameter can be one of the following values: DMA2D_BACKGROUND_LAYER(0) / DMA2D_FOREGROUND_LAYER(1)
- Return values
-
HAL status
Definition at line 1729 of file stm32f4xx_hal_dma2d.c.
◆ HAL_DMA2D_DisableDeadTime()
| HAL_StatusTypeDef HAL_DMA2D_DisableDeadTime | ( | DMA2D_HandleTypeDef * | hdma2d | ) |
Disable DMA2D dead time feature.
- Parameters
-
hdma2d DMA2D handle.
- Return values
-
HAL status
Definition at line 1939 of file stm32f4xx_hal_dma2d.c.
◆ HAL_DMA2D_EnableDeadTime()
| HAL_StatusTypeDef HAL_DMA2D_EnableDeadTime | ( | DMA2D_HandleTypeDef * | hdma2d | ) |
Enable DMA2D dead time feature.
- Parameters
-
hdma2d DMA2D handle.
- Return values
-
HAL status
Definition at line 1916 of file stm32f4xx_hal_dma2d.c.
◆ HAL_DMA2D_ProgramLineEvent()
| HAL_StatusTypeDef HAL_DMA2D_ProgramLineEvent | ( | DMA2D_HandleTypeDef * | hdma2d, |
| uint32_t | Line | ||
| ) |
Configure the line watermark.
- Parameters
-
hdma2d Pointer to a DMA2D_HandleTypeDef structure that contains the configuration information for the DMA2D. Line Line 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
-
HAL status
Definition at line 1880 of file stm32f4xx_hal_dma2d.c.
