STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
stm32f4xx_hal_dma2d.h File Reference

Header file of DMA2D HAL module. More...

#include "stm32f4xx_hal_def.h"
Include dependency graph for stm32f4xx_hal_dma2d.h:

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...
 

Macros

#define MAX_DMA2D_LAYER   2U
 
#define HAL_DMA2D_ERROR_NONE   0x00000000U
 
#define HAL_DMA2D_ERROR_TE   0x00000001U
 
#define HAL_DMA2D_ERROR_CE   0x00000002U
 
#define HAL_DMA2D_ERROR_CAE   0x00000004U
 
#define HAL_DMA2D_ERROR_TIMEOUT   0x00000020U
 
#define DMA2D_M2M   0x00000000U
 
#define DMA2D_M2M_PFC   DMA2D_CR_MODE_0
 
#define DMA2D_M2M_BLEND   DMA2D_CR_MODE_1
 
#define DMA2D_R2M   DMA2D_CR_MODE
 
#define DMA2D_OUTPUT_ARGB8888   0x00000000U
 
#define DMA2D_OUTPUT_RGB888   DMA2D_OPFCCR_CM_0
 
#define DMA2D_OUTPUT_RGB565   DMA2D_OPFCCR_CM_1
 
#define DMA2D_OUTPUT_ARGB1555   (DMA2D_OPFCCR_CM_0|DMA2D_OPFCCR_CM_1)
 
#define DMA2D_OUTPUT_ARGB4444   DMA2D_OPFCCR_CM_2
 
#define DMA2D_INPUT_ARGB8888   0x00000000U
 
#define DMA2D_INPUT_RGB888   0x00000001U
 
#define DMA2D_INPUT_RGB565   0x00000002U
 
#define DMA2D_INPUT_ARGB1555   0x00000003U
 
#define DMA2D_INPUT_ARGB4444   0x00000004U
 
#define DMA2D_INPUT_L8   0x00000005U
 
#define DMA2D_INPUT_AL44   0x00000006U
 
#define DMA2D_INPUT_AL88   0x00000007U
 
#define DMA2D_INPUT_L4   0x00000008U
 
#define DMA2D_INPUT_A8   0x00000009U
 
#define DMA2D_INPUT_A4   0x0000000AU
 
#define DMA2D_NO_MODIF_ALPHA   0x00000000U
 
#define DMA2D_REPLACE_ALPHA   0x00000001U
 
#define DMA2D_COMBINE_ALPHA   0x00000002U
 
#define DMA2D_CCM_ARGB8888   0x00000000U
 
#define DMA2D_CCM_RGB888   0x00000001U
 
#define DMA2D_IT_CE   DMA2D_CR_CEIE
 
#define DMA2D_IT_CTC   DMA2D_CR_CTCIE
 
#define DMA2D_IT_CAE   DMA2D_CR_CAEIE
 
#define DMA2D_IT_TW   DMA2D_CR_TWIE
 
#define DMA2D_IT_TC   DMA2D_CR_TCIE
 
#define DMA2D_IT_TE   DMA2D_CR_TEIE
 
#define DMA2D_FLAG_CE   DMA2D_ISR_CEIF
 
#define DMA2D_FLAG_CTC   DMA2D_ISR_CTCIF
 
#define DMA2D_FLAG_CAE   DMA2D_ISR_CAEIF
 
#define DMA2D_FLAG_TW   DMA2D_ISR_TWIF
 
#define DMA2D_FLAG_TC   DMA2D_ISR_TCIF
 
#define DMA2D_FLAG_TE   DMA2D_ISR_TEIF
 
#define __HAL_DMA2D_RESET_HANDLE_STATE(__HANDLE__)
 Reset DMA2D handle state.
 
#define __HAL_DMA2D_ENABLE(__HANDLE__)
 Enable the DMA2D.
 
#define __HAL_DMA2D_GET_FLAG(__HANDLE__, __FLAG__)
 Get the DMA2D pending flags.
 
#define __HAL_DMA2D_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clear the DMA2D pending flags.
 
#define __HAL_DMA2D_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified DMA2D interrupts.
 
#define __HAL_DMA2D_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the specified DMA2D interrupts.
 
#define __HAL_DMA2D_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified DMA2D interrupt source is enabled or not.
 
#define DMA2D_LINE_WATERMARK_MAX   DMA2D_LWR_LW
 
#define DMA2D_COLOR_VALUE   0x000000FFU
 
#define DMA2D_MAX_LAYER   2U
 
#define DMA2D_BACKGROUND_LAYER   0x00000000U
 
#define DMA2D_FOREGROUND_LAYER   0x00000001U
 
#define DMA2D_OFFSET   DMA2D_FGOR_LO
 
#define DMA2D_PIXEL   (DMA2D_NLR_PL >> 16U)
 
#define DMA2D_LINE   DMA2D_NLR_NL
 
#define DMA2D_CLUT_SIZE   (DMA2D_FGPFCCR_CS >> 8U)
 
#define IS_DMA2D_LAYER(LAYER)
 
#define IS_DMA2D_MODE(MODE)
 
#define IS_DMA2D_CMODE(MODE_ARGB)
 
#define IS_DMA2D_COLOR(COLOR)
 
#define IS_DMA2D_LINE(LINE)
 
#define IS_DMA2D_PIXEL(PIXEL)
 
#define IS_DMA2D_OFFSET(OOFFSET)
 
#define IS_DMA2D_INPUT_COLOR_MODE(INPUT_CM)
 
#define IS_DMA2D_ALPHA_MODE(AlphaMode)
 
#define IS_DMA2D_CLUT_CM(CLUT_CM)
 
#define IS_DMA2D_CLUT_SIZE(CLUT_SIZE)
 
#define IS_DMA2D_LINEWATERMARK(LineWatermark)
 
#define IS_DMA2D_IT(IT)
 
#define IS_DMA2D_GET_FLAG(FLAG)
 

Typedefs

typedef struct __DMA2D_HandleTypeDef DMA2D_HandleTypeDef
 DMA2D handle Structure definition.
 

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...
 

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.
 
HAL_StatusTypeDef HAL_DMA2D_DeInit (DMA2D_HandleTypeDef *hdma2d)
 Deinitializes the DMA2D peripheral registers to their default reset values.
 
void HAL_DMA2D_MspInit (DMA2D_HandleTypeDef *hdma2d)
 Initializes the DMA2D MSP.
 
void HAL_DMA2D_MspDeInit (DMA2D_HandleTypeDef *hdma2d)
 DeInitializes the DMA2D MSP.
 
HAL_StatusTypeDef HAL_DMA2D_Start (DMA2D_HandleTypeDef *hdma2d, uint32_t pdata, uint32_t DstAddress, uint32_t Width, uint32_t Height)
 Start the DMA2D Transfer.
 
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.
 
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.
 
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.
 
HAL_StatusTypeDef HAL_DMA2D_Suspend (DMA2D_HandleTypeDef *hdma2d)
 Suspend the DMA2D Transfer.
 
HAL_StatusTypeDef HAL_DMA2D_Resume (DMA2D_HandleTypeDef *hdma2d)
 Resume the DMA2D Transfer.
 
HAL_StatusTypeDef HAL_DMA2D_Abort (DMA2D_HandleTypeDef *hdma2d)
 Abort the DMA2D Transfer.
 
HAL_StatusTypeDef HAL_DMA2D_EnableCLUT (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Enable the DMA2D CLUT Transfer.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTStartLoad (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef *CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTStartLoad_IT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef *CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading with interrupt enabled.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoad (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoad_IT (DMA2D_HandleTypeDef *hdma2d, DMA2D_CLUTCfgTypeDef CLUTCfg, uint32_t LayerIdx)
 Start DMA2D CLUT Loading with interrupt enabled.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Abort (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Abort the DMA2D CLUT loading.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Suspend (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Suspend the DMA2D CLUT loading.
 
HAL_StatusTypeDef HAL_DMA2D_CLUTLoading_Resume (DMA2D_HandleTypeDef *hdma2d, uint32_t LayerIdx)
 Resume the DMA2D CLUT loading.
 
HAL_StatusTypeDef HAL_DMA2D_PollForTransfer (DMA2D_HandleTypeDef *hdma2d, uint32_t Timeout)
 Polling for transfer complete or CLUT loading.
 
void HAL_DMA2D_IRQHandler (DMA2D_HandleTypeDef *hdma2d)
 Handle DMA2D interrupt request.
 
void HAL_DMA2D_LineEventCallback (DMA2D_HandleTypeDef *hdma2d)
 Transfer watermark callback.
 
void HAL_DMA2D_CLUTLoadingCpltCallback (DMA2D_HandleTypeDef *hdma2d)
 CLUT Transfer Complete callback.
 
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.
 
HAL_DMA2D_StateTypeDef HAL_DMA2D_GetState (DMA2D_HandleTypeDef *hdma2d)
 Return the DMA2D state.
 
uint32_t HAL_DMA2D_GetError (DMA2D_HandleTypeDef *hdma2d)
 Return the DMA2D error code.
 

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.