stm32f7xx_hal_ltdc.c File Reference

LTDC HAL module driver. This file provides firmware functions to manage the following functionalities of the LTDC peripheral: More...

#include "stm32f7xx_hal.h"

Go to the source code of this file.

Detailed Description

LTDC HAL module driver. This file provides firmware functions to manage the following functionalities of the LTDC peripheral:

Author

MCD Application Team

Version

V1.1.0

Date

22-April-2016

• Initialization and de-initialization functions
• IO operation functions
• Peripheral Control functions
• Peripheral State and Errors functions

==============================================================================
                      ##### 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 the LTDC Layer.
    (+) __HAL_LTDC_LAYER_DISABLE: Disable the LTDC Layer.
    (+) __HAL_LTDC_RELOAD_CONFIG: Reload  Layer Configuration.
    (+) __HAL_LTDC_GET_FLAG: Get the LTDC pending flags.
    (+) __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.
    (+) __HAL_LTDC_GET_IT_SOURCE: Check whether the specified LTDC interrupt has occurred or not.
    
   [..] 
     (@) You can refer to the LTDC HAL driver header file for more useful macros

Attention

© COPYRIGHT(c) 2016 STMicroelectronics

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