STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_dma2d.h File Reference

Header file of DMA2D HAL module. More...

Go to the source code of this file.

Data Structures

struct  DMA2D_CLUTCfgTypeDef
 DMA2D CLUT Structure definition. More...
 
struct  DMA2D_InitTypeDef
 DMA2D Init structure definition. More...
 
struct  DMA2D_LayerCfgTypeDef
 DMA2D Layer structure definition. More...
 
struct  __DMA2D_HandleTypeDef
 DMA2D handle Structure definition. More...
 

Typedefs

typedef struct __DMA2D_HandleTypeDef DMA2D_HandleTypeDef
 DMA2D handle Structure definition.
 
typedef void(* pDMA2D_CallbackTypeDef) (DMA2D_HandleTypeDef *hdma2d)
 HAL DMA2D Callback pointer definition. More...
 

Enumerations

enum  HAL_DMA2D_StateTypeDef {
  HAL_DMA2D_STATE_RESET = 0x00U , HAL_DMA2D_STATE_READY = 0x01U , HAL_DMA2D_STATE_BUSY = 0x02U , HAL_DMA2D_STATE_TIMEOUT = 0x03U ,
  HAL_DMA2D_STATE_ERROR = 0x04U , HAL_DMA2D_STATE_SUSPEND = 0x05U
}
 HAL DMA2D State structures definition. More...
 
enum  HAL_DMA2D_CallbackIDTypeDef {
  HAL_DMA2D_MSPINIT_CB_ID = 0x00U , HAL_DMA2D_MSPDEINIT_CB_ID = 0x01U , HAL_DMA2D_TRANSFERCOMPLETE_CB_ID = 0x02U , HAL_DMA2D_TRANSFERERROR_CB_ID = 0x03U ,
  HAL_DMA2D_LINEEVENT_CB_ID = 0x04U , HAL_DMA2D_CLUTLOADINGCPLT_CB_ID = 0x05U
}
 HAL DMA2D common Callback ID enumeration definition. More...
 

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...
 
HAL_StatusTypeDef HAL_DMA2D_Start (DMA2D_HandleTypeDef *hdma2d, uint32_t pdata, uint32_t DstAddress, uint32_t Width, uint32_t Height)
 Start the DMA2D Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_BlendingStart (DMA2D_HandleTypeDef *hdma2d, uint32_t SrcAddress1, uint32_t SrcAddress2, uint32_t DstAddress, uint32_t Width, uint32_t Height)
 Start the multi-source DMA2D Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_Start_IT (DMA2D_HandleTypeDef *hdma2d, uint32_t pdata, uint32_t DstAddress, uint32_t Width, uint32_t Height)
 Start the DMA2D Transfer with interrupt enabled. More...
 
HAL_StatusTypeDef HAL_DMA2D_BlendingStart_IT (DMA2D_HandleTypeDef *hdma2d, uint32_t SrcAddress1, uint32_t SrcAddress2, uint32_t DstAddress, uint32_t Width, uint32_t Height)
 Start the multi-source DMA2D Transfer with interrupt enabled. More...
 
HAL_StatusTypeDef HAL_DMA2D_Suspend (DMA2D_HandleTypeDef *hdma2d)
 Suspend the DMA2D Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_Resume (DMA2D_HandleTypeDef *hdma2d)
 Resume the DMA2D Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_Abort (DMA2D_HandleTypeDef *hdma2d)
 Abort the DMA2D Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_EnableCLUT (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Enable the DMA2D CLUT Transfer. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTStartLoad (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef *CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTStartLoad_IT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef *CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading with interrupt enabled. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoad (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoad_IT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading with interrupt enabled. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Abort (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Abort the DMA2D CLUT loading. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Suspend (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Suspend the DMA2D CLUT loading. More...
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Resume (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Resume the DMA2D CLUT loading. More...
 
HAL_StatusTypeDef HAL_DMA2D_PollForTransfer (DMA2D_HandleTypeDef *hdma2d, uint32_t Timeout)
 Polling for transfer complete or CLUT loading. More...
 
void HAL_DMA2D_IRQHandler (DMA2D_HandleTypeDef *hdma2d)
 Handle DMA2D interrupt request. More...
 
void HAL_DMA2D_LineEventCallback (DMA2D_HandleTypeDef *hdma2d)
 Transfer watermark callback. More...
 
void HAL_DMA2D_CLUTLoadingCpltCallback (DMA2D_HandleTypeDef *hdma2d)
 CLUT Transfer Complete callback. More...
 
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...
 
HAL_DMA2D_StateTypeDef HAL_DMA2D_GetState (DMA2D_HandleTypeDef *hdma2d)
 Return the DMA2D state. More...
 
uint32_t HAL_DMA2D_GetError (DMA2D_HandleTypeDef *hdma2d)
 Return the DMA2D error code. More...
 

Detailed Description

Header file of DMA2D HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_dma2d.h.