lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_ltdc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_ltdc.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of LTDC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_LTDC_H
  40 #define __STM32F4xx_HAL_LTDC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 #if defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F469xx) || defined(STM32F479xx)
  47 /* Includes ------------------------------------------------------------------*/
  48 #include "stm32f4xx_hal_def.h"
  49
  50 /** @addtogroup STM32F4xx_HAL_Driver
  51   * @{
  52   */
  53
  54 /** @defgroup LTDC LTDC
  55   * @brief LTDC HAL module driver
  56   * @{
  57   */
  58
  59 /* Exported types ------------------------------------------------------------*/
  60 /** @defgroup LTDC_Exported_Types LTDC Exported Types
  61   * @{
  62   */
  63 #define MAX_LAYER  2U
  64
  65 /**
  66   * @brief  LTDC color structure definition
  67   */
  68 typedef struct
  69 {
  70   uint8_t Blue;                    /*!< Configures the blue value.
  71                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  72
  73   uint8_t Green;                   /*!< Configures the green value.
  74                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  75
  76   uint8_t Red;                     /*!< Configures the red value.
  77                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  78
  79   uint8_t Reserved;                /*!< Reserved 0xFF */
  80 } LTDC_ColorTypeDef;
  81
  82 /**
  83   * @brief  LTDC Init structure definition
  84   */
  85 typedef struct
  86 {
  87   uint32_t            HSPolarity;                /*!< configures the horizontal synchronization polarity.
  88                                                       This parameter can be one value of @ref LTDC_HS_POLARITY */
  89
  90   uint32_t            VSPolarity;                /*!< configures the vertical synchronization polarity.
  91                                                       This parameter can be one value of @ref LTDC_VS_POLARITY */
  92
  93   uint32_t            DEPolarity;                /*!< configures the data enable polarity.
  94                                                       This parameter can be one of value of @ref LTDC_DE_POLARITY */
  95
  96   uint32_t            PCPolarity;                /*!< configures the pixel clock polarity.
  97                                                       This parameter can be one of value of @ref LTDC_PC_POLARITY */
  98
  99   uint32_t            HorizontalSync;            /*!< configures the number of Horizontal synchronization width.
 100                                                       This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
 101
 102   uint32_t            VerticalSync;              /*!< configures the number of Vertical synchronization height.
 103                                                       This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */
 104
 105   uint32_t            AccumulatedHBP;            /*!< configures the accumulated horizontal back porch width.
 106                                                       This parameter must be a number between Min_Data = LTDC_HorizontalSync and Max_Data = 0xFFF. */
 107
 108   uint32_t            AccumulatedVBP;            /*!< configures the accumulated vertical back porch height.
 109                                                       This parameter must be a number between Min_Data = LTDC_VerticalSync and Max_Data = 0x7FF. */
 110
 111   uint32_t            AccumulatedActiveW;        /*!< configures the accumulated active width.
 112                                                       This parameter must be a number between Min_Data = LTDC_AccumulatedHBP and Max_Data = 0xFFF. */
 113
 114   uint32_t            AccumulatedActiveH;        /*!< configures the accumulated active height.
 115                                                       This parameter must be a number between Min_Data = LTDC_AccumulatedVBP and Max_Data = 0x7FF. */
 116
 117   uint32_t            TotalWidth;                /*!< configures the total width.
 118                                                       This parameter must be a number between Min_Data = LTDC_AccumulatedActiveW and Max_Data = 0xFFF. */
 119
 120   uint32_t            TotalHeigh;                /*!< configures the total height.
 121                                                       This parameter must be a number between Min_Data = LTDC_AccumulatedActiveH and Max_Data = 0x7FF. */
 122
 123   LTDC_ColorTypeDef   Backcolor;                 /*!< Configures the background color. */
 124 } LTDC_InitTypeDef;
 125
 126 /**
 127   * @brief  LTDC Layer structure definition
 128   */
 129 typedef struct
 130 {
 131   uint32_t WindowX0;                   /*!< Configures the Window Horizontal Start Position.
 132                                             This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
 133
 134   uint32_t WindowX1;                   /*!< Configures the Window Horizontal Stop Position.
 135                                             This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
 136
 137   uint32_t WindowY0;                   /*!< Configures the Window vertical Start Position.
 138                                             This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */
 139
 140   uint32_t WindowY1;                   /*!< Configures the Window vertical Stop Position.
 141                                             This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x7FF. */
 142
 143   uint32_t PixelFormat;                /*!< Specifies the pixel format.
 144                                             This parameter can be one of value of @ref LTDC_Pixelformat */
 145
 146   uint32_t Alpha;                      /*!< Specifies the constant alpha used for blending.
 147                                             This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
 148
 149   uint32_t Alpha0;                     /*!< Configures the default alpha value.
 150                                             This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
 151
 152   uint32_t BlendingFactor1;            /*!< Select the blending factor 1.
 153                                             This parameter can be one of value of @ref LTDC_BlendingFactor1 */
 154
 155   uint32_t BlendingFactor2;            /*!< Select the blending factor 2.
 156                                             This parameter can be one of value of @ref LTDC_BlendingFactor2 */
 157
 158   uint32_t FBStartAdress;              /*!< Configures the color frame buffer address */
 159
 160   uint32_t ImageWidth;                 /*!< Configures the color frame buffer line length.
 161                                             This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x1FFF. */
 162
 163   uint32_t ImageHeight;                /*!< Specifies the number of line in frame buffer.
 164                                             This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */
 165
 166   LTDC_ColorTypeDef   Backcolor;       /*!< Configures the layer background color. */
 167 } LTDC_LayerCfgTypeDef;
 168
 169 /**
 170   * @brief  HAL LTDC State structures definition
 171   */
 172 typedef enum
 173 {
 174   HAL_LTDC_STATE_RESET             = 0x00U,    /*!< LTDC not yet initialized or disabled */
 175   HAL_LTDC_STATE_READY             = 0x01U,    /*!< LTDC initialized and ready for use   */
 176   HAL_LTDC_STATE_BUSY              = 0x02U,    /*!< LTDC internal process is ongoing     */
 177   HAL_LTDC_STATE_TIMEOUT           = 0x03U,    /*!< LTDC Timeout state                   */
 178   HAL_LTDC_STATE_ERROR             = 0x04U     /*!< LTDC state error                     */
 179 }HAL_LTDC_StateTypeDef;
 180
 181 /**
 182   * @brief  LTDC handle Structure definition
 183   */
 184 typedef struct
 185 {
 186   LTDC_TypeDef                *Instance;                /*!< LTDC Register base address                */
 187
 188   LTDC_InitTypeDef            Init;                     /*!< LTDC parameters                           */
 189
 190   LTDC_LayerCfgTypeDef        LayerCfg[MAX_LAYER];      /*!< LTDC Layers parameters                    */
 191
 192   HAL_LockTypeDef             Lock;                     /*!< LTDC Lock                                 */
 193
 194   __IO HAL_LTDC_StateTypeDef  State;                    /*!< LTDC state                                */
 195
 196   __IO uint32_t               ErrorCode;                /*!< LTDC Error code                           */
 197
 198 } LTDC_HandleTypeDef;
 199 /**
 200   * @}
 201   */
 202
 203 /* Exported constants --------------------------------------------------------*/
 204 /** @defgroup LTDC_Exported_Constants LTDC Exported Constants
 205   * @{
 206   */
 207
 208 /** @defgroup LTDC_Error_Code LTDC Error Code
 209   * @{
 210   */
 211 #define HAL_LTDC_ERROR_NONE               0x00000000U   /*!< LTDC No error             */
 212 #define HAL_LTDC_ERROR_TE                 0x00000001U   /*!< LTDC Transfer error       */
 213 #define HAL_LTDC_ERROR_FU                 0x00000002U   /*!< LTDC FIFO Underrun        */
 214 #define HAL_LTDC_ERROR_TIMEOUT            0x00000020U   /*!< LTDC Timeout error        */
 215 /**
 216   * @}
 217   */
 218
 219 /** @defgroup LTDC_Layer LTDC Layer
 220   * @{
 221   */
 222 #define LTDC_LAYER_1                      0x00000000U   /*!< LTDC Layer 1 */
 223 #define LTDC_LAYER_2                      0x00000001U   /*!< LTDC Layer 2 */
 224 /**
 225   * @}
 226   */
 227
 228 /** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY
 229   * @{
 230   */
 231 #define LTDC_HSPOLARITY_AL                0x00000000U   /*!< Horizontal Synchronization is active low. */
 232 #define LTDC_HSPOLARITY_AH                LTDC_GCR_HSPOL            /*!< Horizontal Synchronization is active high. */
 233 /**
 234   * @}
 235   */
 236
 237 /** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY
 238   * @{
 239   */
 240 #define LTDC_VSPOLARITY_AL                0x00000000U   /*!< Vertical Synchronization is active low. */
 241 #define LTDC_VSPOLARITY_AH                LTDC_GCR_VSPOL            /*!< Vertical Synchronization is active high. */
 242 /**
 243   * @}
 244   */
 245
 246 /** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY
 247   * @{
 248   */
 249 #define LTDC_DEPOLARITY_AL                0x00000000U   /*!< Data Enable, is active low. */
 250 #define LTDC_DEPOLARITY_AH                LTDC_GCR_DEPOL            /*!< Data Enable, is active high. */
 251 /**
 252   * @}
 253   */
 254
 255 /** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY
 256   * @{
 257   */
 258 #define LTDC_PCPOLARITY_IPC               0x00000000U   /*!< input pixel clock. */
 259 #define LTDC_PCPOLARITY_IIPC              LTDC_GCR_PCPOL            /*!< inverted input pixel clock. */
 260 /**
 261   * @}
 262   */
 263
 264 /** @defgroup LTDC_SYNC LTDC SYNC
 265   * @{
 266   */
 267 #define LTDC_HORIZONTALSYNC               (LTDC_SSCR_HSW >> 16U)    /*!< Horizontal synchronization width. */
 268 #define LTDC_VERTICALSYNC                 LTDC_SSCR_VSH             /*!< Vertical synchronization height. */
 269 /**
 270   * @}
 271   */
 272
 273 /** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR
 274   * @{
 275   */
 276 #define LTDC_COLOR                        0x000000FFU   /*!< Color mask */
 277 /**
 278   * @}
 279   */
 280
 281 /** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1
 282   * @{
 283   */
 284 #define LTDC_BLENDING_FACTOR1_CA          0x00000400U   /*!< Blending factor : Cte Alpha */
 285 #define LTDC_BLENDING_FACTOR1_PAxCA       0x00000600U   /*!< Blending factor : Cte Alpha x Pixel Alpha*/
 286 /**
 287   * @}
 288   */
 289
 290 /** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2
 291   * @{
 292   */
 293 #define LTDC_BLENDING_FACTOR2_CA          0x00000005U   /*!< Blending factor : Cte Alpha */
 294 #define LTDC_BLENDING_FACTOR2_PAxCA       0x00000007U   /*!< Blending factor : Cte Alpha x Pixel Alpha*/
 295 /**
 296   * @}
 297   */
 298
 299 /** @defgroup LTDC_Pixelformat LTDC Pixel format
 300   * @{
 301   */
 302 #define LTDC_PIXEL_FORMAT_ARGB8888        0x00000000U   /*!< ARGB8888 LTDC pixel format */
 303 #define LTDC_PIXEL_FORMAT_RGB888          0x00000001U   /*!< RGB888 LTDC pixel format   */
 304 #define LTDC_PIXEL_FORMAT_RGB565          0x00000002U   /*!< RGB565 LTDC pixel format   */
 305 #define LTDC_PIXEL_FORMAT_ARGB1555        0x00000003U   /*!< ARGB1555 LTDC pixel format */
 306 #define LTDC_PIXEL_FORMAT_ARGB4444        0x00000004U   /*!< ARGB4444 LTDC pixel format */
 307 #define LTDC_PIXEL_FORMAT_L8              0x00000005U   /*!< L8 LTDC pixel format       */
 308 #define LTDC_PIXEL_FORMAT_AL44            0x00000006U   /*!< AL44 LTDC pixel format     */
 309 #define LTDC_PIXEL_FORMAT_AL88            0x00000007U   /*!< AL88 LTDC pixel format     */
 310 /**
 311   * @}
 312   */
 313
 314 /** @defgroup LTDC_Alpha LTDC Alpha
 315   * @{
 316   */
 317 #define LTDC_ALPHA                        LTDC_LxCACR_CONSTA        /*!< LTDC Constant Alpha mask */
 318 /**
 319   * @}
 320   */
 321
 322 /** @defgroup LTDC_LAYER_Config LTDC LAYER Config
 323   * @{
 324   */
 325 #define LTDC_STOPPOSITION                 (LTDC_LxWHPCR_WHSPPOS >> 16U) /*!< LTDC Layer stop position  */
 326 #define LTDC_STARTPOSITION                LTDC_LxWHPCR_WHSTPOS          /*!< LTDC Layer start position */
 327
 328 #define LTDC_COLOR_FRAME_BUFFER           LTDC_LxCFBLR_CFBLL            /*!< LTDC Layer Line length    */
 329 #define LTDC_LINE_NUMBER                  LTDC_LxCFBLNR_CFBLNBR         /*!< LTDC Layer Line number    */
 330 /**
 331   * @}
 332   */
 333
 334 /** @defgroup LTDC_Interrupts LTDC Interrupts
 335   * @{
 336   */
 337 #define LTDC_IT_LI                        LTDC_IER_LIE              /*!< LTDC Line Interrupt            */
 338 #define LTDC_IT_FU                        LTDC_IER_FUIE             /*!< LTDC FIFO Underrun Interrupt   */
 339 #define LTDC_IT_TE                        LTDC_IER_TERRIE           /*!< LTDC Transfer Error Interrupt  */
 340 #define LTDC_IT_RR                        LTDC_IER_RRIE             /*!< LTDC Register Reload Interrupt */
 341 /**
 342   * @}
 343   */
 344
 345 /** @defgroup LTDC_Flags LTDC Flags
 346   * @{
 347   */
 348 #define LTDC_FLAG_LI                      LTDC_ISR_LIF              /*!< LTDC Line Interrupt Flag            */
 349 #define LTDC_FLAG_FU                      LTDC_ISR_FUIF             /*!< LTDC FIFO Underrun interrupt Flag   */
 350 #define LTDC_FLAG_TE                      LTDC_ISR_TERRIF           /*!< LTDC Transfer Error interrupt Flag  */
 351 #define LTDC_FLAG_RR                      LTDC_ISR_RRIF             /*!< LTDC Register Reload interrupt Flag */
 352 /**
 353   * @}
 354   */
 355
 356 /** @defgroup LTDC_Reload_Type LTDC Reload Type
 357   * @{
 358   */
 359 #define LTDC_RELOAD_IMMEDIATE             LTDC_SRCR_IMR             /*!< Immediate Reload */
 360 #define LTDC_RELOAD_VERTICAL_BLANKING     LTDC_SRCR_VBR             /*!< Vertical Blanking Reload */
 361 /**
 362   * @}
 363   */
 364
 365 /**
 366   * @}
 367   */
 368
 369 /* Exported macro ------------------------------------------------------------*/
 370 /** @defgroup LTDC_Exported_Macros LTDC Exported Macros
 371   * @{
 372   */
 373
 374 /** @brief Reset LTDC handle state.
 375   * @param  __HANDLE__  LTDC handle
 376   * @retval None
 377   */
 378 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
 379
 380 /**
 381   * @brief  Enable the LTDC.
 382   * @param  __HANDLE__  LTDC handle
 383   * @retval None.
 384   */
 385 #define __HAL_LTDC_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
 386
 387 /**
 388   * @brief  Disable the LTDC.
 389   * @param  __HANDLE__  LTDC handle
 390   * @retval None.
 391   */
 392 #define __HAL_LTDC_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
 393
 394 /**
 395   * @brief  Enable the LTDC Layer.
 396   * @param  __HANDLE__  LTDC handle
 397   * @param  __LAYER__   Specify the layer to be enabled.
 398   *                     This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
 399   * @retval None.
 400   */
 401 #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__)  ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN)
 402
 403 /**
 404   * @brief  Disable the LTDC Layer.
 405   * @param  __HANDLE__  LTDC handle
 406   * @param  __LAYER__   Specify the layer to be disabled.
 407   *                     This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
 408   * @retval None.
 409   */
 410 #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN)
 411
 412 /**
 413   * @brief  Reload immediately all LTDC Layers.
 414   * @param  __HANDLE__  LTDC handle
 415   * @retval None.
 416   */
 417 #define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG(__HANDLE__)  ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
 418
 419 /**
 420   * @brief  Reload during vertical blanking period all LTDC Layers.
 421   * @param  __HANDLE__  LTDC handle
 422   * @retval None.
 423   */
 424 #define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG(__HANDLE__)  ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_VBR)
 425
 426 /* Interrupt & Flag management */
 427 /**
 428   * @brief  Get the LTDC pending flags.
 429   * @param  __HANDLE__  LTDC handle
 430   * @param  __FLAG__    Get the specified flag.
 431   *          This parameter can be any combination of the following values:
 432   *            @arg LTDC_FLAG_LI: Line Interrupt flag
 433   *            @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
 434   *            @arg LTDC_FLAG_TE: Transfer Error interrupt flag
 435   *            @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
 436   * @retval The state of FLAG (SET or RESET).
 437   */
 438 #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
 439
 440 /**
 441   * @brief  Clears the LTDC pending flags.
 442   * @param  __HANDLE__  LTDC handle
 443   * @param  __FLAG__    Specify the flag to clear.
 444   *          This parameter can be any combination of the following values:
 445   *            @arg LTDC_FLAG_LI: Line Interrupt flag
 446   *            @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
 447   *            @arg LTDC_FLAG_TE: Transfer Error interrupt flag
 448   *            @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
 449   * @retval None
 450   */
 451 #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
 452
 453 /**
 454   * @brief  Enables the specified LTDC interrupts.
 455   * @param  __HANDLE__  LTDC handle
 456   * @param __INTERRUPT__ Specify the LTDC interrupt sources to be enabled.
 457   *          This parameter can be any combination of the following values:
 458   *            @arg LTDC_IT_LI: Line Interrupt flag
 459   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
 460   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
 461   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
 462   * @retval None
 463   */
 464 #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
 465
 466 /**
 467   * @brief  Disables the specified LTDC interrupts.
 468   * @param  __HANDLE__  LTDC handle
 469   * @param __INTERRUPT__ Specify the LTDC interrupt sources to be disabled.
 470   *          This parameter can be any combination of the following values:
 471   *            @arg LTDC_IT_LI: Line Interrupt flag
 472   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
 473   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
 474   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
 475   * @retval None
 476   */
 477 #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
 478
 479 /**
 480   * @brief  Check whether the specified LTDC interrupt has occurred or not.
 481   * @param  __HANDLE__  LTDC handle
 482   * @param __INTERRUPT__ Specify the LTDC interrupt source to check.
 483   *          This parameter can be one of the following values:
 484   *            @arg LTDC_IT_LI: Line Interrupt flag
 485   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
 486   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
 487   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
 488   * @retval The state of INTERRUPT (SET or RESET).
 489   */
 490 #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER & (__INTERRUPT__))
 491 /**
 492   * @}
 493   */
 494
 495 /* Include LTDC HAL Extension module */
 496 #include "stm32f4xx_hal_ltdc_ex.h"
 497
 498 /* Exported functions --------------------------------------------------------*/
 499 /** @addtogroup LTDC_Exported_Functions
 500   * @{
 501   */
 502 /** @addtogroup LTDC_Exported_Functions_Group1
 503   * @{
 504   */
 505 /* Initialization and de-initialization functions *****************************/
 506 HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
 507 HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
 508 void HAL_LTDC_MspInit(LTDC_HandleTypeDef* hltdc);
 509 void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef* hltdc);
 510 void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
 511 void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc);
 512 void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc);
 513 /**
 514   * @}
 515   */
 516
 517 /** @addtogroup LTDC_Exported_Functions_Group2
 518   * @{
 519   */
 520 /* IO operation functions *****************************************************/
 521 void  HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
 522 /**
 523   * @}
 524   */
 525
 526 /** @addtogroup LTDC_Exported_Functions_Group3
 527   * @{
 528   */
 529 /* Peripheral Control functions ***********************************************/
 530 HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
 531 HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
 532 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
 533 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
 534 HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
 535 HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
 536 HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
 537 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
 538 HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
 539 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 540 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 541 HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 542 HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 543 HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
 544 HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
 545 HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
 546 HAL_StatusTypeDef HAL_LTDC_Reload(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType);
 547 HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
 548 HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
 549 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
 550 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
 551 HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
 552 HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
 553 HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
 554 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
 555 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 556 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 557 HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 558 HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
 559
 560 /**
 561   * @}
 562   */
 563
 564 /** @addtogroup LTDC_Exported_Functions_Group4
 565   * @{
 566   */
 567 /* Peripheral State functions *************************************************/
 568 HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
 569 uint32_t              HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
 570 /**
 571   * @}
 572   */
 573
 574 /**
 575   * @}
 576   */
 577
 578 /* Private types -------------------------------------------------------------*/
 579 /* Private variables ---------------------------------------------------------*/
 580 /* Private constants ---------------------------------------------------------*/
 581 /* Private macros ------------------------------------------------------------*/
 582 /** @defgroup LTDC_Private_Macros LTDC Private Macros
 583   * @{
 584   */
 585 #define LTDC_LAYER(__HANDLE__, __LAYER__)              ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84U + (0x80U*(__LAYER__)))))
 586 #define IS_LTDC_LAYER(__LAYER__)                       ((__LAYER__) < MAX_LAYER)
 587 #define IS_LTDC_HSPOL(__HSPOL__)                       (((__HSPOL__) == LTDC_HSPOLARITY_AL) || ((__HSPOL__) == LTDC_HSPOLARITY_AH))
 588 #define IS_LTDC_VSPOL(__VSPOL__)                       (((__VSPOL__) == LTDC_VSPOLARITY_AL) || ((__VSPOL__) == LTDC_VSPOLARITY_AH))
 589 #define IS_LTDC_DEPOL(__DEPOL__)                       (((__DEPOL__) == LTDC_DEPOLARITY_AL) || ((__DEPOL__) ==  LTDC_DEPOLARITY_AH))
 590 #define IS_LTDC_PCPOL(__PCPOL__)                       (((__PCPOL__) == LTDC_PCPOLARITY_IPC) || ((__PCPOL__) ==  LTDC_PCPOLARITY_IIPC))
 591 #define IS_LTDC_HSYNC(__HSYNC__)                       ((__HSYNC__)  <= LTDC_HORIZONTALSYNC)
 592 #define IS_LTDC_VSYNC(__VSYNC__)                       ((__VSYNC__)  <= LTDC_VERTICALSYNC)
 593 #define IS_LTDC_AHBP(__AHBP__)                         ((__AHBP__)   <= LTDC_HORIZONTALSYNC)
 594 #define IS_LTDC_AVBP(__AVBP__)                         ((__AVBP__)   <= LTDC_VERTICALSYNC)
 595 #define IS_LTDC_AAW(__AAW__)                           ((__AAW__)    <= LTDC_HORIZONTALSYNC)
 596 #define IS_LTDC_AAH(__AAH__)                           ((__AAH__)    <= LTDC_VERTICALSYNC)
 597 #define IS_LTDC_TOTALW(__TOTALW__)                     ((__TOTALW__) <= LTDC_HORIZONTALSYNC)
 598 #define IS_LTDC_TOTALH(__TOTALH__)                     ((__TOTALH__) <= LTDC_VERTICALSYNC)
 599 #define IS_LTDC_BLUEVALUE(__BBLUE__)                   ((__BBLUE__)  <= LTDC_COLOR)
 600 #define IS_LTDC_GREENVALUE(__BGREEN__)                 ((__BGREEN__) <= LTDC_COLOR)
 601 #define IS_LTDC_REDVALUE(__BRED__)                     ((__BRED__)   <= LTDC_COLOR)
 602 #define IS_LTDC_BLENDING_FACTOR1(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_CA) || \
 603                                                         ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_PAxCA))
 604 #define IS_LTDC_BLENDING_FACTOR2(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_CA) || \
 605                                                         ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_PAxCA))
 606 #define IS_LTDC_PIXEL_FORMAT(__PIXEL_FORMAT__)         (((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB8888) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB888)   || \
 607                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB565)   || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB1555) || \
 608                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB4444) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_L8)       || \
 609                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL44)     || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL88))
 610 #define IS_LTDC_ALPHA(__ALPHA__)                       ((__ALPHA__) <= LTDC_ALPHA)
 611 #define IS_LTDC_HCONFIGST(__HCONFIGST__)               ((__HCONFIGST__) <= LTDC_STARTPOSITION)
 612 #define IS_LTDC_HCONFIGSP(__HCONFIGSP__)               ((__HCONFIGSP__) <= LTDC_STOPPOSITION)
 613 #define IS_LTDC_VCONFIGST(__VCONFIGST__)               ((__VCONFIGST__) <= LTDC_STARTPOSITION)
 614 #define IS_LTDC_VCONFIGSP(__VCONFIGSP__)               ((__VCONFIGSP__) <= LTDC_STOPPOSITION)
 615 #define IS_LTDC_CFBP(__CFBP__)                         ((__CFBP__) <= LTDC_COLOR_FRAME_BUFFER)
 616 #define IS_LTDC_CFBLL(__CFBLL__)                       ((__CFBLL__) <= LTDC_COLOR_FRAME_BUFFER)
 617 #define IS_LTDC_CFBLNBR(__CFBLNBR__)                   ((__CFBLNBR__) <= LTDC_LINE_NUMBER)
 618 #define IS_LTDC_LIPOS(__LIPOS__)                       ((__LIPOS__) <= 0x7FFU)
 619 #define IS_LTDC_RELOAD(__RELOADTYPE__)                 (((__RELOADTYPE__) == LTDC_RELOAD_IMMEDIATE) || ((__RELOADTYPE__) == LTDC_SRCR_VBR))
 620 /**
 621   * @}
 622   */
 623
 624 /* Private functions ---------------------------------------------------------*/
 625 /** @defgroup LTDC_Private_Functions LTDC Private Functions
 626   * @{
 627   */
 628
 629 /**
 630   * @}
 631   */
 632
 633 /**
 634   * @}
 635   */
 636
 637 /**
 638   * @}
 639   */
 640
 641 #endif /* STM32F429xx || STM32F439xx  || STM32F469xx || STM32F479xx */
 642
 643 #ifdef __cplusplus
 644 }
 645 #endif
 646
 647 #endif /* __STM32F4xx_HAL_LTDC_H */
 648
 649 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/