ew_bsp_graphics.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * E M B E D D E D   W I Z A R D   P R O J E C T
 *
 *                                                Copyright (c) TARA Systems
 *GmbH written by Paul Banach and Manfred Schweyer
 *
 ********************************************************************************
 *
 * This software is delivered "as is" and shows the usage of other software
 * components. It is provided as an example software which is intended to be
 * modified and extended according to particular requirements.
 *
 * TARA Systems hereby disclaims all warranties and conditions with regard to
 *the software, including all implied warranties and conditions of
 *merchantability and non-infringement of any third party IPR or other rights
 *which may result from the use or the inability to use the software.
 *
 ********************************************************************************
 *
 * DESCRIPTION:
 *   This file is part of the interface (glue layer) between an Embedded Wizard
 *   generated UI application and the board support package (BSP) of a dedicated
 *   target.
 *   This file contains an interface to the DMA2D hardware of the STM32 target
 *   in order to provide graphics acceleration for the Embedded Wizard generated
 *   UI applications.
 *   This interface is intended to be used only by the Graphics Engine of
 *   Embedded Wizard.
 *
 *******************************************************************************/
 
#ifndef EW_BSP_GRAPHICS_H
#define EW_BSP_GRAPHICS_H
 
#if defined STM32F746xx || defined STM32F750xx || defined STM32F756xx ||       \
    defined STM32F769xx
#include "stm32f7xx_hal.h"
#endif
 
#if defined STM32F429xx || defined STM32F439xx || defined STM32F469xx
#include "stm32f4xx_hal.h"
#endif
 
#if defined STM32L496xx || defined STM32L4R9xx
#include "stm32l4xx_hal.h"
#endif
 
#if defined STM32H743xx || defined STM32H745xx || defined STM32H747xx ||       \
    defined STM32H750xx || defined STM32H7B3xxQ
#include "stm32h7xx_hal.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
  EW_USE_DMA2D_INTERRUPT_MODE - Flag to switch on/off the usage of the interrupt
  mode for the DMA2D (graphics accelerator).
  Per default, the usage of the interrupt mode is enabled. If the interrupt mode
  is swtched off, polling mode is used instead. To switch off the usage of the
  DMA2D interrupt mode, please set the macro EW_USE_DMA2D_INTERRUPT_MODE to 0
  within your makefile. This can be achieved by using the compiler flag
  -DEW_USE_DMA2D_INTERRUPT_MODE=0
*/
#ifndef EW_USE_DMA2D_INTERRUPT_MODE
#define EW_USE_DMA2D_INTERRUPT_MODE 1
#endif
 
#if EW_USE_DMA2D_INTERRUPT_MODE == 0
#undef EW_USE_DMA2D_INTERRUPT_MODE
#endif
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsInit
 *
 * DESCRIPTION:
 *   Initialize the DMA2D graphics accelerator.
 *
 * ARGUMENTS:
 *   aDstColorMode - Colorformat of the destination bitmap
 *
 * RETURN VALUE:
 *   If successful, returns != 0.
 *
 *******************************************************************************/
int EwBspGraphicsInit(uint32_t aDstColorMode);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsDone
 *
 * DESCRIPTION:
 *   Deinitialize the DMA2D graphics accelerator.
 *
 * ARGUMENTS:
 *   None
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsDone(void);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsWaitForCompletion
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsWaitForCompletion returns as soon as the DMA2D
 *has completed a pending graphics instruction. If the DMA2D is in idle mode,
 *   the function returns immediately.
 *
 * ARGUMENTS:
 *   None
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsWaitForCompletion(void);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsConcurrentOperation
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsConcurrentOperation configures the operation mode
 *   of DMA2D and CPU. If concurrent operation is enabled, the CPU will work in
 *   parallel while the DMA2D is transferring data. If concurrent operation is
 *   disabled, the CPU will wait everytime the DMA2D is active.
 *   This feature is intended to limit the memory bandwidth, e.g. during display
 *   update or other bandwidth consuming activities.
 *
 * ARGUMENTS:
 *   aEnable - flag to switch on/off concurrent operation mode.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsConcurrentOperation(int aEnable);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsFill
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsFill is used by the Graphics Engine, when a
 *   rectangular area should be filled with a constant color by using the DMA2D
 *   functionality.
 *
 * ARGUMENTS:
 *   aDstAddr      - Destination address of the transfer.
 *   aDstOffset    - Offset in pixel to next row within the destination.
 *   aWidth,
 *   aHeight       - Size of the area to fill.
 *   aDstColorMode - Colorformat of the destination.
 *   aSrcColor     - Color to fill the rectangular area.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsFill(uint32_t aDstAddr, uint32_t aDstOffset, uint32_t aWidth,
                       uint32_t aHeight, uint32_t aDstColorMode,
                       uint32_t aSrcColor);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsFillBlend
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsFillBlend is used by the Graphics Engine, when a
 *   rectangular area should be blended with a constant color by using the DMA2D
 *   functionality.
 *
 * ARGUMENTS:
 *   aDstAddr      - Destination address of the transfer.
 *   aDstOffset    - Offset in pixel to next row within the destination.
 *   aWidth,
 *   aHeight       - Size of the area to blend.
 *   aDstColorMode - Colorformat of the destination.
 *   aSrcColor     - Color to blend the rectangular area.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsFillBlend(uint32_t aDstAddr, uint32_t aDstOffset,
                            uint32_t aWidth, uint32_t aHeight,
                            uint32_t aDstColorMode, uint32_t aSrcColor);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsCopy
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsCopy is used by the Graphics Engine, when a
 *source bitmap should be copied into a destination bitmap by using the DMA2D
 *   functionality.
 *
 * ARGUMENTS:
 *   aDstAddr      - Destination address of the transfer.
 *   aSrcAddr      - Source address of the transfer.
 *   aDstOffset    - Offset in pixel to next row within the destination bitmap.
 *   aSrcOffset    - Offset in pixel to next row within the source bitmap.
 *   aWidth,
 *   aHeight       - Size of the area to transfer the bitmap.
 *   aDstColorMode - Colorformat of the destination bitmap
 *   aSrcColorMode - Colorformat of the source bitmap.
 *   aSrcColor     - Color/alpha value to be used for the transfer.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsCopy(uint32_t aDstAddr, uint32_t aSrcAddr,
                       uint32_t aDstOffset, uint32_t aSrcOffset,
                       uint32_t aWidth, uint32_t aHeight,
                       uint32_t aDstColorMode, uint32_t aSrcColorMode,
                       uint32_t aSrcColor);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsCopyBlend
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsCopyBlend is used by the Graphics Engine, when a
 *   source bitmap should be blended over a destination bitmap by using the
 *DMA2D functionality.
 *
 * ARGUMENTS:
 *   aDstAddr      - Destination address of the transfer.
 *   aSrcAddr      - Source address of the transfer.
 *   aDstOffset    - Offset in pixel to next row within the destination bitmap.
 *   aSrcOffset    - Offset in pixel to next row within the source bitmap.
 *   aWidth,
 *   aHeight       - Size of the area to transfer the bitmap.
 *   aDstColorMode - Colorformat of the destination bitmap
 *   aSrcColorMode - Colorformat of the source bitmap.
 *   aSrcColor     - Color/alpha value to be used for the transfer.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsCopyBlend(uint32_t aDstAddr, uint32_t aSrcAddr,
                            uint32_t aDstOffset, uint32_t aSrcOffset,
                            uint32_t aWidth, uint32_t aHeight,
                            uint32_t aDstColorMode, uint32_t aSrcColorMode,
                            uint32_t aSrcColor);
 
/*******************************************************************************
 * FUNCTION:
 *   EwBspGraphicsLoadClut
 *
 * DESCRIPTION:
 *   The function EwBspGraphicsLoadClut is used by the Graphics Engine, when
 *   a Index8 source bitmap should be copied into a destination bitmap by using
 *   the DMA2D functionality. In this case, the CLUT of the DMA2D has to be
 *loaded with the given CLUT.
 *
 * ARGUMENTS:
 *   aClutAddr     - Address of the first color entry of the CLUT.
 *   aClutSize     - Number of color entries within the CLUT.
 *
 * RETURN VALUE:
 *   None
 *
 *******************************************************************************/
void EwBspGraphicsLoadClut(uint32_t aClutAddr, uint32_t aClutSize);
 
#ifdef __cplusplus
}
#endif
 
#endif /* EW_BSP_GRAPHICS_H */
 
/* msy */