STM32F439xx HAL User Manual: stm32f4xx_hal

LTDC HAL module driver. This file provides firmware functions to manage the following functionalities of the LTDC peripheral: + Initialization and de-initialization functions + IO operation functions + Peripheral Control functions + Peripheral State and Errors functions. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

Functions
static void	LTDC_SetConfig (LTDC_HandleTypeDef hltdc, LTDC_LayerCfgTypeDef pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC peripheral.
HAL_StatusTypeDef	HAL_LTDC_Init (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC according to the specified parameters in the LTDC_InitTypeDef.
HAL_StatusTypeDef	HAL_LTDC_DeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC peripheral.
__weak void	HAL_LTDC_MspInit (LTDC_HandleTypeDef *hltdc)
	Initialize the LTDC MSP.
__weak void	HAL_LTDC_MspDeInit (LTDC_HandleTypeDef *hltdc)
	De-initialize the LTDC MSP.
void	HAL_LTDC_IRQHandler (LTDC_HandleTypeDef *hltdc)
	Handle LTDC interrupt request.
__weak void	HAL_LTDC_ErrorCallback (LTDC_HandleTypeDef *hltdc)
	Error LTDC callback.
__weak void	HAL_LTDC_LineEventCallback (LTDC_HandleTypeDef *hltdc)
	Line Event callback.
__weak void	HAL_LTDC_ReloadEventCallback (LTDC_HandleTypeDef *hltdc)
	Reload Event callback.
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer (LTDC_HandleTypeDef hltdc, LTDC_LayerCfgTypeDef pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified parameters in the LTDC_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying.
HAL_StatusTypeDef	HAL_LTDC_ConfigCLUT (LTDC_HandleTypeDef hltdc, uint32_t pCLUT, uint32_t CLUTSize, uint32_t LayerIdx)
	Load the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying.
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying.
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table.
HAL_StatusTypeDef	HAL_LTDC_EnableDither (LTDC_HandleTypeDef *hltdc)
	Enable Dither.
HAL_StatusTypeDef	HAL_LTDC_DisableDither (LTDC_HandleTypeDef *hltdc)
	Disable Dither.
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size.
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position.
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format.
HAL_StatusTypeDef	HAL_LTDC_SetAlpha (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value.
HAL_StatusTypeDef	HAL_LTDC_SetAddress (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address.
HAL_StatusTypeDef	HAL_LTDC_SetPitch (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.
HAL_StatusTypeDef	HAL_LTDC_ProgramLineEvent (LTDC_HandleTypeDef *hltdc, uint32_t Line)
	Define the position of the line interrupt.
HAL_StatusTypeDef	HAL_LTDC_Reload (LTDC_HandleTypeDef *hltdc, uint32_t ReloadType)
	Reload LTDC Layers configuration.
HAL_StatusTypeDef	HAL_LTDC_ConfigLayer_NoReload (LTDC_HandleTypeDef hltdc, LTDC_LayerCfgTypeDef pLayerCfg, uint32_t LayerIdx)
	Configure the LTDC Layer according to the specified without reloading parameters in the LTDC_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_LTDC_SetWindowSize_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx)
	Set the LTDC window size without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetWindowPosition_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx)
	Set the LTDC window position without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetPixelFormat_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx)
	Reconfigure the pixel format without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetAlpha_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx)
	Reconfigure the layer alpha value without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetAddress_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx)
	Reconfigure the frame buffer Address without reloading.
HAL_StatusTypeDef	HAL_LTDC_SetPitch_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx)
	Function used to reconfigure the pitch for specific cases where the attached LayerIdx buffer have a width that is larger than the one intended to be displayed on screen.
HAL_StatusTypeDef	HAL_LTDC_ConfigColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx)
	Configure the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_EnableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_DisableColorKeying_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color keying without reloading.
HAL_StatusTypeDef	HAL_LTDC_EnableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Enable the color lookup table without reloading.
HAL_StatusTypeDef	HAL_LTDC_DisableCLUT_NoReload (LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx)
	Disable the color lookup table without reloading.
HAL_LTDC_StateTypeDef	HAL_LTDC_GetState (LTDC_HandleTypeDef *hltdc)
	Return the LTDC handle state.
uint32_t	HAL_LTDC_GetError (LTDC_HandleTypeDef *hltdc)
	Return the LTDC handle error code.

Detailed Description

Author:

MCD Application Team

  ==============================================================================
                        ##### How to use this driver #####
  ==============================================================================
    [..]
     (#) Program the required configuration through the following parameters:   
         the LTDC timing, the horizontal and vertical polarity, 
         the pixel clock polarity, Data Enable polarity and the LTDC background color value 
         using HAL_LTDC_Init() function

     (#) Program the required configuration through the following parameters:   
         the pixel format, the blending factors, input alpha value, the window size 
         and the image size using HAL_LTDC_ConfigLayer() function for foreground
         or/and background layer.     
  
     (#) Optionally, configure and enable the CLUT using HAL_LTDC_ConfigCLUT() and 
         HAL_LTDC_EnableCLUT functions.
       
     (#) Optionally, enable the Dither using HAL_LTDC_EnableDither().       

     (#) Optionally, configure and enable the Color keying using HAL_LTDC_ConfigColorKeying()
         and HAL_LTDC_EnableColorKeying functions.

     (#) Optionally, configure LineInterrupt using HAL_LTDC_ProgramLineEvent()
         function

     (#) If needed, reconfigure and change the pixel format value, the alpha value
         value, the window size, the window position and the layer start address 
         for foreground or/and background layer using respectively the following 
         functions: HAL_LTDC_SetPixelFormat(), HAL_LTDC_SetAlpha(), HAL_LTDC_SetWindowSize(),
         HAL_LTDC_SetWindowPosition(), HAL_LTDC_SetAddress.

     (#) Variant functions with �_NoReload� post fix allows to set the LTDC configuration/settings without immediate reload.
         This is useful in case when the program requires to modify serval LTDC settings (on one or both layers) 
         then applying(reload) these settings in one shot by calling the function �HAL_LTDC_Reload�

         After calling the �_NoReload� functions to set different color/format/layer settings, 
         the program can call the function  �HAL_LTDC_Reload� To apply(Reload) these settings. 
         Function �HAL_LTDC_Reload� can be called with the parameter  �ReloadType� 
         set to LTDC_RELOAD_IMMEDIATE if an immediate reload is required.
         Function �HAL_LTDC_Reload� can be called with the parameter  �ReloadType� 
         set to LTDC_RELOAD_VERTICAL_BLANKING if the reload should be done in the next vertical blanking period, 
         this option allows to avoid display flicker by applying the new settings during the vertical blanking period.
           
                     
     (#) To control LTDC state you can use the following function: HAL_LTDC_GetState()               

     *** LTDC HAL driver macros list ***
     ============================================= 
     [..]
       Below the list of most used macros in LTDC HAL driver.
       
      (+) __HAL_LTDC_ENABLE: Enable the LTDC.
      (+) __HAL_LTDC_DISABLE: Disable the LTDC.
      (+) __HAL_LTDC_LAYER_ENABLE: Enable a LTDC Layer.
      (+) __HAL_LTDC_LAYER_DISABLE: Disable a LTDC Layer.
      (+) __HAL_LTDC_CLEAR_FLAG: Clear the LTDC pending flags.
      (+) __HAL_LTDC_ENABLE_IT: Enable the specified LTDC interrupts. 
      (+) __HAL_LTDC_DISABLE_IT: Disable the specified LTDC interrupts.
      
     [..] 
       (@) You can refer to the LTDC HAL driver header file for more useful macros

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_ltdc.c.

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics