stm32h7/include/stm32h7xx_hal_ltdc.h

0001 /**
0002   ******************************************************************************
0003   * @file    stm32h7xx_hal_ltdc.h
0004   * @author  MCD Application Team
0005   * @brief   Header file of LTDC HAL module.
0006   ******************************************************************************
0007   * @attention
0008   *
0009   * Copyright (c) 2017 STMicroelectronics.
0010   * All rights reserved.
0011   *
0012   * This software is licensed under terms that can be found in the LICENSE file
0013   * in the root directory of this software component.
0014   * If no LICENSE file comes with this software, it is provided AS-IS.
0015   *
0016   ******************************************************************************
0017   */
0018
0019 /* Define to prevent recursive inclusion -------------------------------------*/
0020 #ifndef STM32H7xx_HAL_LTDC_H
0021 #define STM32H7xx_HAL_LTDC_H
0022
0023 #ifdef __cplusplus
0024 extern "C" {
0025 #endif
0026
0027 /* Includes ------------------------------------------------------------------*/
0028 #include "stm32h7xx_hal_def.h"
0029
0030 #if defined (LTDC)
0031
0032 /** @addtogroup STM32H7xx_HAL_Driver
0033   * @{
0034   */
0035
0036 /** @defgroup LTDC LTDC
0037   * @ingroup RTEMSBSPsARMSTM32H7
0038   * @brief LTDC HAL module driver
0039   * @{
0040   */
0041
0042 /* Exported types ------------------------------------------------------------*/
0043 /** @defgroup LTDC_Exported_Types LTDC Exported Types
0044   * @ingroup RTEMSBSPsARMSTM32H7
0045   * @{
0046   */
0047 #define MAX_LAYER  2U
0048
0049 /**
0050   * @brief  LTDC color structure definition
0051   */
0052 typedef struct
0053 {
0054   uint8_t Blue;                    /*!< Configures the blue value.
0055                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
0056
0057   uint8_t Green;                   /*!< Configures the green value.
0058                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
0059
0060   uint8_t Red;                     /*!< Configures the red value.
0061                                         This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
0062
0063   uint8_t Reserved;                /*!< Reserved 0xFF */
0064 } LTDC_ColorTypeDef;
0065
0066 /**
0067   * @brief  LTDC Init structure definition
0068   */
0069 typedef struct
0070 {
0071   uint32_t            HSPolarity;                /*!< configures the horizontal synchronization polarity.
0072                                                       This parameter can be one value of @ref LTDC_HS_POLARITY */
0073
0074   uint32_t            VSPolarity;                /*!< configures the vertical synchronization polarity.
0075                                                       This parameter can be one value of @ref LTDC_VS_POLARITY */
0076
0077   uint32_t            DEPolarity;                /*!< configures the data enable polarity.
0078                                                       This parameter can be one of value of @ref LTDC_DE_POLARITY */
0079
0080   uint32_t            PCPolarity;                /*!< configures the pixel clock polarity.
0081                                                       This parameter can be one of value of @ref LTDC_PC_POLARITY */
0082
0083   uint32_t            HorizontalSync;            /*!< configures the number of Horizontal synchronization width.
0084                                                       This parameter must be a number between
0085                                                       Min_Data = 0x000 and Max_Data = 0xFFF. */
0086
0087   uint32_t            VerticalSync;              /*!< configures the number of Vertical synchronization height.
0088                                                       This parameter must be a number between
0089                                                       Min_Data = 0x000 and Max_Data = 0x7FF. */
0090
0091   uint32_t            AccumulatedHBP;            /*!< configures the accumulated horizontal back porch width.
0092                                                       This parameter must be a number between
0093                                                       Min_Data = LTDC_HorizontalSync and Max_Data = 0xFFF. */
0094
0095   uint32_t            AccumulatedVBP;            /*!< configures the accumulated vertical back porch height.
0096                                                       This parameter must be a number between
0097                                                       Min_Data = LTDC_VerticalSync and Max_Data = 0x7FF. */
0098
0099   uint32_t            AccumulatedActiveW;        /*!< configures the accumulated active width.
0100                                                       This parameter must be a number between
0101                                                       Min_Data = LTDC_AccumulatedHBP and Max_Data = 0xFFF. */
0102
0103   uint32_t            AccumulatedActiveH;        /*!< configures the accumulated active height.
0104                                                       This parameter must be a number between
0105                                                       Min_Data = LTDC_AccumulatedVBP and Max_Data = 0x7FF. */
0106
0107   uint32_t            TotalWidth;                /*!< configures the total width.
0108                                                       This parameter must be a number between
0109                                                       Min_Data = LTDC_AccumulatedActiveW and Max_Data = 0xFFF. */
0110
0111   uint32_t            TotalHeigh;                /*!< configures the total height.
0112                                                       This parameter must be a number between
0113                                                       Min_Data = LTDC_AccumulatedActiveH and Max_Data = 0x7FF. */
0114
0115   LTDC_ColorTypeDef   Backcolor;                 /*!< Configures the background color. */
0116 } LTDC_InitTypeDef;
0117
0118 /**
0119   * @brief  LTDC Layer structure definition
0120   */
0121 typedef struct
0122 {
0123   uint32_t WindowX0;                   /*!< Configures the Window Horizontal Start Position.
0124                                             This parameter must be a number between
0125                                             Min_Data = 0x000 and Max_Data = 0xFFF. */
0126
0127   uint32_t WindowX1;                   /*!< Configures the Window Horizontal Stop Position.
0128                                             This parameter must be a number between
0129                                             Min_Data = 0x000 and Max_Data = 0xFFF. */
0130
0131   uint32_t WindowY0;                   /*!< Configures the Window vertical Start Position.
0132                                             This parameter must be a number between
0133                                             Min_Data = 0x000 and Max_Data = 0x7FF. */
0134
0135   uint32_t WindowY1;                   /*!< Configures the Window vertical Stop Position.
0136                                             This parameter must be a number between
0137                                             Min_Data = 0x0000 and Max_Data = 0x7FF. */
0138
0139   uint32_t PixelFormat;                /*!< Specifies the pixel format.
0140                                             This parameter can be one of value of @ref LTDC_Pixelformat */
0141
0142   uint32_t Alpha;                      /*!< Specifies the constant alpha used for blending.
0143                                             This parameter must be a number between
0144                                             Min_Data = 0x00 and Max_Data = 0xFF. */
0145
0146   uint32_t Alpha0;                     /*!< Configures the default alpha value.
0147                                             This parameter must be a number between
0148                                             Min_Data = 0x00 and Max_Data = 0xFF. */
0149
0150   uint32_t BlendingFactor1;            /*!< Select the blending factor 1.
0151                                             This parameter can be one of value of @ref LTDC_BlendingFactor1 */
0152
0153   uint32_t BlendingFactor2;            /*!< Select the blending factor 2.
0154                                             This parameter can be one of value of @ref LTDC_BlendingFactor2 */
0155
0156   uint32_t FBStartAdress;              /*!< Configures the color frame buffer address */
0157
0158   uint32_t ImageWidth;                 /*!< Configures the color frame buffer line length.
0159                                             This parameter must be a number between
0160                                             Min_Data = 0x0000 and Max_Data = 0x1FFF. */
0161
0162   uint32_t ImageHeight;                /*!< Specifies the number of line in frame buffer.
0163                                             This parameter must be a number between
0164                                             Min_Data = 0x000 and Max_Data = 0x7FF. */
0165
0166   LTDC_ColorTypeDef   Backcolor;       /*!< Configures the layer background color. */
0167 } LTDC_LayerCfgTypeDef;
0168
0169 /**
0170   * @brief  HAL LTDC State structures definition
0171   */
0172 typedef enum
0173 {
0174   HAL_LTDC_STATE_RESET             = 0x00U,    /*!< LTDC not yet initialized or disabled */
0175   HAL_LTDC_STATE_READY             = 0x01U,    /*!< LTDC initialized and ready for use   */
0176   HAL_LTDC_STATE_BUSY              = 0x02U,    /*!< LTDC internal process is ongoing     */
0177   HAL_LTDC_STATE_TIMEOUT           = 0x03U,    /*!< LTDC Timeout state                   */
0178   HAL_LTDC_STATE_ERROR             = 0x04U     /*!< LTDC state error                     */
0179 } HAL_LTDC_StateTypeDef;
0180
0181 /**
0182   * @brief  LTDC handle Structure definition
0183   */
0184 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0185 typedef struct __LTDC_HandleTypeDef
0186 #else
0187 typedef struct
0188 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */
0189 {
0190   LTDC_TypeDef                *Instance;                /*!< LTDC Register base address                */
0191
0192   LTDC_InitTypeDef            Init;                     /*!< LTDC parameters                           */
0193
0194   LTDC_LayerCfgTypeDef        LayerCfg[MAX_LAYER];      /*!< LTDC Layers parameters                    */
0195
0196   HAL_LockTypeDef             Lock;                     /*!< LTDC Lock                                 */
0197
0198   __IO HAL_LTDC_StateTypeDef  State;                    /*!< LTDC state                                */
0199
0200   __IO uint32_t               ErrorCode;                /*!< LTDC Error code                           */
0201
0202 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0203   void (* LineEventCallback)(struct __LTDC_HandleTypeDef *hltdc);     /*!< LTDC Line Event Callback    */
0204   void (* ReloadEventCallback)(struct __LTDC_HandleTypeDef *hltdc);   /*!< LTDC Reload Event Callback  */
0205   void (* ErrorCallback)(struct __LTDC_HandleTypeDef *hltdc);         /*!< LTDC Error Callback         */
0206
0207   void (* MspInitCallback)(struct __LTDC_HandleTypeDef *hltdc);       /*!< LTDC Msp Init callback      */
0208   void (* MspDeInitCallback)(struct __LTDC_HandleTypeDef *hltdc);     /*!< LTDC Msp DeInit callback    */
0209
0210 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */
0211
0212
0213 } LTDC_HandleTypeDef;
0214
0215 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0216 /**
0217   * @brief  HAL LTDC Callback ID enumeration definition
0218   */
0219 typedef enum
0220 {
0221   HAL_LTDC_MSPINIT_CB_ID            = 0x00U,    /*!< LTDC MspInit callback ID       */
0222   HAL_LTDC_MSPDEINIT_CB_ID          = 0x01U,    /*!< LTDC MspDeInit callback ID     */
0223
0224   HAL_LTDC_LINE_EVENT_CB_ID         = 0x02U,    /*!< LTDC Line Event Callback ID    */
0225   HAL_LTDC_RELOAD_EVENT_CB_ID       = 0x03U,    /*!< LTDC Reload Callback ID        */
0226   HAL_LTDC_ERROR_CB_ID              = 0x04U     /*!< LTDC Error Callback ID         */
0227
0228 } HAL_LTDC_CallbackIDTypeDef;
0229
0230 /**
0231   * @brief  HAL LTDC Callback pointer definition
0232   */
0233 typedef  void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc);  /*!< pointer to an LTDC callback function */
0234
0235 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */
0236
0237 /**
0238   * @}
0239   */
0240
0241 /* Exported constants --------------------------------------------------------*/
0242 /** @defgroup LTDC_Exported_Constants LTDC Exported Constants
0243   * @ingroup RTEMSBSPsARMSTM32H7
0244   * @{
0245   */
0246
0247 /** @defgroup LTDC_Error_Code LTDC Error Code
0248   * @ingroup RTEMSBSPsARMSTM32H7
0249   * @{
0250   */
0251 #define HAL_LTDC_ERROR_NONE               0x00000000U   /*!< LTDC No error             */
0252 #define HAL_LTDC_ERROR_TE                 0x00000001U   /*!< LTDC Transfer error       */
0253 #define HAL_LTDC_ERROR_FU                 0x00000002U   /*!< LTDC FIFO Underrun        */
0254 #define HAL_LTDC_ERROR_TIMEOUT            0x00000020U   /*!< LTDC Timeout error        */
0255 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0256 #define  HAL_LTDC_ERROR_INVALID_CALLBACK  0x00000040U   /*!< LTDC Invalid Callback error  */
0257 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */
0258 /**
0259   * @}
0260   */
0261
0262 /** @defgroup LTDC_Layer LTDC Layer
0263   * @ingroup RTEMSBSPsARMSTM32H7
0264   * @{
0265   */
0266 #define LTDC_LAYER_1                      0x00000000U   /*!< LTDC Layer 1 */
0267 #define LTDC_LAYER_2                      0x00000001U   /*!< LTDC Layer 2 */
0268 /**
0269   * @}
0270   */
0271
0272 /** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY
0273   * @ingroup RTEMSBSPsARMSTM32H7
0274   * @{
0275   */
0276 #define LTDC_HSPOLARITY_AL                0x00000000U   /*!< Horizontal Synchronization is active low. */
0277 #define LTDC_HSPOLARITY_AH                LTDC_GCR_HSPOL            /*!< Horizontal Synchronization is active high. */
0278 /**
0279   * @}
0280   */
0281
0282 /** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY
0283   * @ingroup RTEMSBSPsARMSTM32H7
0284   * @{
0285   */
0286 #define LTDC_VSPOLARITY_AL                0x00000000U   /*!< Vertical Synchronization is active low. */
0287 #define LTDC_VSPOLARITY_AH                LTDC_GCR_VSPOL            /*!< Vertical Synchronization is active high. */
0288 /**
0289   * @}
0290   */
0291
0292 /** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY
0293   * @ingroup RTEMSBSPsARMSTM32H7
0294   * @{
0295   */
0296 #define LTDC_DEPOLARITY_AL                0x00000000U   /*!< Data Enable, is active low. */
0297 #define LTDC_DEPOLARITY_AH                LTDC_GCR_DEPOL            /*!< Data Enable, is active high. */
0298 /**
0299   * @}
0300   */
0301
0302 /** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY
0303   * @ingroup RTEMSBSPsARMSTM32H7
0304   * @{
0305   */
0306 #define LTDC_PCPOLARITY_IPC               0x00000000U   /*!< input pixel clock. */
0307 #define LTDC_PCPOLARITY_IIPC              LTDC_GCR_PCPOL            /*!< inverted input pixel clock. */
0308 /**
0309   * @}
0310   */
0311
0312 /** @defgroup LTDC_SYNC LTDC SYNC
0313   * @ingroup RTEMSBSPsARMSTM32H7
0314   * @{
0315   */
0316 #define LTDC_HORIZONTALSYNC               (LTDC_SSCR_HSW >> 16U)    /*!< Horizontal synchronization width. */
0317 #define LTDC_VERTICALSYNC                 LTDC_SSCR_VSH             /*!< Vertical synchronization height. */
0318 /**
0319   * @}
0320   */
0321
0322 /** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR
0323   * @ingroup RTEMSBSPsARMSTM32H7
0324   * @{
0325   */
0326 #define LTDC_COLOR                        0x000000FFU   /*!< Color mask */
0327 /**
0328   * @}
0329   */
0330
0331 /** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1
0332   * @ingroup RTEMSBSPsARMSTM32H7
0333   * @{
0334   */
0335 #define LTDC_BLENDING_FACTOR1_CA          0x00000400U   /*!< Blending factor : Cte Alpha */
0336 #define LTDC_BLENDING_FACTOR1_PAxCA       0x00000600U   /*!< Blending factor : Cte Alpha x Pixel Alpha*/
0337 /**
0338   * @}
0339   */
0340
0341 /** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2
0342   * @ingroup RTEMSBSPsARMSTM32H7
0343   * @{
0344   */
0345 #define LTDC_BLENDING_FACTOR2_CA          0x00000005U   /*!< Blending factor : Cte Alpha */
0346 #define LTDC_BLENDING_FACTOR2_PAxCA       0x00000007U   /*!< Blending factor : Cte Alpha x Pixel Alpha*/
0347 /**
0348   * @}
0349   */
0350
0351 /** @defgroup LTDC_Pixelformat LTDC Pixel format
0352   * @ingroup RTEMSBSPsARMSTM32H7
0353   * @{
0354   */
0355 #define LTDC_PIXEL_FORMAT_ARGB8888        0x00000000U   /*!< ARGB8888 LTDC pixel format             */
0356 #define LTDC_PIXEL_FORMAT_RGB888          0x00000001U   /*!< RGB888 LTDC pixel format               */
0357 #define LTDC_PIXEL_FORMAT_RGB565          0x00000002U   /*!< RGB565 LTDC pixel format               */
0358 #define LTDC_PIXEL_FORMAT_ARGB1555        0x00000003U   /*!< ARGB1555 LTDC pixel format             */
0359 #define LTDC_PIXEL_FORMAT_ARGB4444        0x00000004U   /*!< ARGB4444 LTDC pixel format             */
0360 #define LTDC_PIXEL_FORMAT_L8              0x00000005U   /*!< L8 LTDC pixel format                   */
0361 #define LTDC_PIXEL_FORMAT_AL44            0x00000006U   /*!< AL44 LTDC pixel format                 */
0362 #define LTDC_PIXEL_FORMAT_AL88            0x00000007U   /*!< AL88 LTDC pixel format                 */
0363 /**
0364   * @}
0365   */
0366
0367 /** @defgroup LTDC_Alpha LTDC Alpha
0368   * @ingroup RTEMSBSPsARMSTM32H7
0369   * @{
0370   */
0371 #define LTDC_ALPHA                        LTDC_LxCACR_CONSTA        /*!< LTDC Constant Alpha mask */
0372 /**
0373   * @}
0374   */
0375
0376 /** @defgroup LTDC_LAYER_Config LTDC LAYER Config
0377   * @ingroup RTEMSBSPsARMSTM32H7
0378   * @{
0379   */
0380 #define LTDC_STOPPOSITION                 (LTDC_LxWHPCR_WHSPPOS >> 16U) /*!< LTDC Layer stop position  */
0381 #define LTDC_STARTPOSITION                LTDC_LxWHPCR_WHSTPOS          /*!< LTDC Layer start position */
0382
0383 #define LTDC_COLOR_FRAME_BUFFER           LTDC_LxCFBLR_CFBLL            /*!< LTDC Layer Line length    */
0384 #define LTDC_LINE_NUMBER                  LTDC_LxCFBLNR_CFBLNBR         /*!< LTDC Layer Line number    */
0385 /**
0386   * @}
0387   */
0388
0389 /** @defgroup LTDC_Interrupts LTDC Interrupts
0390   * @ingroup RTEMSBSPsARMSTM32H7
0391   * @{
0392   */
0393 #define LTDC_IT_LI                        LTDC_IER_LIE              /*!< LTDC Line Interrupt            */
0394 #define LTDC_IT_FU                        LTDC_IER_FUIE             /*!< LTDC FIFO Underrun Interrupt   */
0395 #define LTDC_IT_TE                        LTDC_IER_TERRIE           /*!< LTDC Transfer Error Interrupt  */
0396 #define LTDC_IT_RR                        LTDC_IER_RRIE             /*!< LTDC Register Reload Interrupt */
0397 /**
0398   * @}
0399   */
0400
0401 /** @defgroup LTDC_Flags LTDC Flags
0402   * @ingroup RTEMSBSPsARMSTM32H7
0403   * @{
0404   */
0405 #define LTDC_FLAG_LI                      LTDC_ISR_LIF              /*!< LTDC Line Interrupt Flag            */
0406 #define LTDC_FLAG_FU                      LTDC_ISR_FUIF             /*!< LTDC FIFO Underrun interrupt Flag   */
0407 #define LTDC_FLAG_TE                      LTDC_ISR_TERRIF           /*!< LTDC Transfer Error interrupt Flag  */
0408 #define LTDC_FLAG_RR                      LTDC_ISR_RRIF             /*!< LTDC Register Reload interrupt Flag */
0409 /**
0410   * @}
0411   */
0412
0413 /** @defgroup LTDC_Reload_Type LTDC Reload Type
0414   * @ingroup RTEMSBSPsARMSTM32H7
0415   * @{
0416   */
0417 #define LTDC_RELOAD_IMMEDIATE             LTDC_SRCR_IMR             /*!< Immediate Reload */
0418 #define LTDC_RELOAD_VERTICAL_BLANKING     LTDC_SRCR_VBR             /*!< Vertical Blanking Reload */
0419 /**
0420   * @}
0421   */
0422
0423 /**
0424   * @}
0425   */
0426
0427 /* Exported macro ------------------------------------------------------------*/
0428 /** @defgroup LTDC_Exported_Macros LTDC Exported Macros
0429   * @ingroup RTEMSBSPsARMSTM32H7
0430   * @{
0431   */
0432
0433 /** @brief Reset LTDC handle state.
0434   * @param  __HANDLE__  LTDC handle
0435   * @retval None
0436   */
0437 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0438 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) do{                                                 \
0439                                                       (__HANDLE__)->State = HAL_LTDC_STATE_RESET;     \
0440                                                       (__HANDLE__)->MspInitCallback = NULL;           \
0441                                                       (__HANDLE__)->MspDeInitCallback = NULL;         \
0442                                                     } while(0)
0443 #else
0444 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
0445 #endif /*USE_HAL_LTDC_REGISTER_CALLBACKS */
0446
0447 /**
0448   * @brief  Enable the LTDC.
0449   * @param  __HANDLE__  LTDC handle
0450   * @retval None.
0451   */
0452 #define __HAL_LTDC_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
0453
0454 /**
0455   * @brief  Disable the LTDC.
0456   * @param  __HANDLE__  LTDC handle
0457   * @retval None.
0458   */
0459 #define __HAL_LTDC_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
0460
0461 /**
0462   * @brief  Enable the LTDC Layer.
0463   * @param  __HANDLE__  LTDC handle
0464   * @param  __LAYER__   Specify the layer to be enabled.
0465   *                     This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
0466   * @retval None.
0467   */
0468 #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__)  ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR\
0469                                                          |= (uint32_t)LTDC_LxCR_LEN)
0470
0471 /**
0472   * @brief  Disable the LTDC Layer.
0473   * @param  __HANDLE__  LTDC handle
0474   * @param  __LAYER__   Specify the layer to be disabled.
0475   *                     This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
0476   * @retval None.
0477   */
0478 #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR\
0479                                                          &= ~(uint32_t)LTDC_LxCR_LEN)
0480
0481 /**
0482   * @brief  Reload immediately all LTDC Layers.
0483   * @param  __HANDLE__  LTDC handle
0484   * @retval None.
0485   */
0486 #define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG(__HANDLE__)  ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
0487
0488 /**
0489   * @brief  Reload during vertical blanking period all LTDC Layers.
0490   * @param  __HANDLE__  LTDC handle
0491   * @retval None.
0492   */
0493 #define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG(__HANDLE__)  ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_VBR)
0494
0495 /* Interrupt & Flag management */
0496 /**
0497   * @brief  Get the LTDC pending flags.
0498   * @param  __HANDLE__  LTDC handle
0499   * @param  __FLAG__    Get the specified flag.
0500   *          This parameter can be any combination of the following values:
0501   *            @arg LTDC_FLAG_LI: Line Interrupt flag
0502   *            @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
0503   *            @arg LTDC_FLAG_TE: Transfer Error interrupt flag
0504   *            @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
0505   * @retval The state of FLAG (SET or RESET).
0506   */
0507 #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
0508
0509 /**
0510   * @brief  Clears the LTDC pending flags.
0511   * @param  __HANDLE__  LTDC handle
0512   * @param  __FLAG__    Specify the flag to clear.
0513   *          This parameter can be any combination of the following values:
0514   *            @arg LTDC_FLAG_LI: Line Interrupt flag
0515   *            @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
0516   *            @arg LTDC_FLAG_TE: Transfer Error interrupt flag
0517   *            @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
0518   * @retval None
0519   */
0520 #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
0521
0522 /**
0523   * @brief  Enables the specified LTDC interrupts.
0524   * @param  __HANDLE__  LTDC handle
0525   * @param __INTERRUPT__ Specify the LTDC interrupt sources to be enabled.
0526   *          This parameter can be any combination of the following values:
0527   *            @arg LTDC_IT_LI: Line Interrupt flag
0528   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
0529   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
0530   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
0531   * @retval None
0532   */
0533 #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
0534
0535 /**
0536   * @brief  Disables the specified LTDC interrupts.
0537   * @param  __HANDLE__  LTDC handle
0538   * @param __INTERRUPT__ Specify the LTDC interrupt sources to be disabled.
0539   *          This parameter can be any combination of the following values:
0540   *            @arg LTDC_IT_LI: Line Interrupt flag
0541   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
0542   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
0543   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
0544   * @retval None
0545   */
0546 #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
0547
0548 /**
0549   * @brief  Check whether the specified LTDC interrupt has occurred or not.
0550   * @param  __HANDLE__  LTDC handle
0551   * @param __INTERRUPT__ Specify the LTDC interrupt source to check.
0552   *          This parameter can be one of the following values:
0553   *            @arg LTDC_IT_LI: Line Interrupt flag
0554   *            @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
0555   *            @arg LTDC_IT_TE: Transfer Error interrupt flag
0556   *            @arg LTDC_IT_RR: Register Reload Interrupt Flag
0557   * @retval The state of INTERRUPT (SET or RESET).
0558   */
0559 #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER & (__INTERRUPT__))
0560 /**
0561   * @}
0562   */
0563
0564 /* Include LTDC HAL Extension module */
0565 #include "stm32h7xx_hal_ltdc_ex.h"
0566
0567 /* Exported functions --------------------------------------------------------*/
0568 /** @addtogroup LTDC_Exported_Functions
0569   * @{
0570   */
0571 /** @addtogroup LTDC_Exported_Functions_Group1
0572   * @{
0573   */
0574 /* Initialization and de-initialization functions *****************************/
0575 HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
0576 HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
0577 void HAL_LTDC_MspInit(LTDC_HandleTypeDef *hltdc);
0578 void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef *hltdc);
0579 void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
0580 void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc);
0581 void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc);
0582
0583 /* Callbacks Register/UnRegister functions  ***********************************/
0584 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1)
0585 HAL_StatusTypeDef HAL_LTDC_RegisterCallback(LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID,
0586                                             pLTDC_CallbackTypeDef pCallback);
0587 HAL_StatusTypeDef HAL_LTDC_UnRegisterCallback(LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID);
0588 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */
0589
0590 /**
0591   * @}
0592   */
0593
0594 /** @addtogroup LTDC_Exported_Functions_Group2
0595   * @{
0596   */
0597 /* IO operation functions *****************************************************/
0598 void  HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
0599 /**
0600   * @}
0601   */
0602
0603 /** @addtogroup LTDC_Exported_Functions_Group3
0604   * @{
0605   */
0606 /* Peripheral Control functions ***********************************************/
0607 HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
0608 HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
0609 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
0610 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
0611 HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
0612 HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
0613 HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
0614 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
0615 HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
0616 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0617 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0618 HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0619 HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0620 HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
0621 HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
0622 HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
0623 HAL_StatusTypeDef HAL_LTDC_Reload(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType);
0624 HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg,
0625                                                 uint32_t LayerIdx);
0626 HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize,
0627                                                   uint32_t LayerIdx);
0628 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0,
0629                                                       uint32_t LayerIdx);
0630 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
0631 HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
0632 HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
0633 HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
0634 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
0635 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0636 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0637 HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0638 HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
0639
0640 /**
0641   * @}
0642   */
0643
0644 /** @addtogroup LTDC_Exported_Functions_Group4
0645   * @{
0646   */
0647 /* Peripheral State functions *************************************************/
0648 HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
0649 uint32_t              HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
0650 /**
0651   * @}
0652   */
0653
0654 /**
0655   * @}
0656   */
0657
0658 /* Private types -------------------------------------------------------------*/
0659 /* Private variables ---------------------------------------------------------*/
0660 /* Private constants ---------------------------------------------------------*/
0661 /* Private macros ------------------------------------------------------------*/
0662 /** @defgroup LTDC_Private_Macros LTDC Private Macros
0663   * @ingroup RTEMSBSPsARMSTM32H7
0664   * @{
0665   */
0666 #define LTDC_LAYER(__HANDLE__, __LAYER__)              ((LTDC_Layer_TypeDef *)((uint32_t)(\
0667                                                                                ((uint32_t)((__HANDLE__)->Instance))\
0668                                                                                + 0x84U + (0x80U*(__LAYER__)))))
0669 #define IS_LTDC_LAYER(__LAYER__)                       ((__LAYER__) < MAX_LAYER)
0670 #define IS_LTDC_HSPOL(__HSPOL__)                       (((__HSPOL__) == LTDC_HSPOLARITY_AL)\
0671                                                         || ((__HSPOL__) == LTDC_HSPOLARITY_AH))
0672 #define IS_LTDC_VSPOL(__VSPOL__)                       (((__VSPOL__) == LTDC_VSPOLARITY_AL)\
0673                                                         || ((__VSPOL__) == LTDC_VSPOLARITY_AH))
0674 #define IS_LTDC_DEPOL(__DEPOL__)                       (((__DEPOL__) == LTDC_DEPOLARITY_AL)\
0675                                                         || ((__DEPOL__) ==  LTDC_DEPOLARITY_AH))
0676 #define IS_LTDC_PCPOL(__PCPOL__)                       (((__PCPOL__) == LTDC_PCPOLARITY_IPC)\
0677                                                         || ((__PCPOL__) ==  LTDC_PCPOLARITY_IIPC))
0678 #define IS_LTDC_HSYNC(__HSYNC__)                       ((__HSYNC__)  <= LTDC_HORIZONTALSYNC)
0679 #define IS_LTDC_VSYNC(__VSYNC__)                       ((__VSYNC__)  <= LTDC_VERTICALSYNC)
0680 #define IS_LTDC_AHBP(__AHBP__)                         ((__AHBP__)   <= LTDC_HORIZONTALSYNC)
0681 #define IS_LTDC_AVBP(__AVBP__)                         ((__AVBP__)   <= LTDC_VERTICALSYNC)
0682 #define IS_LTDC_AAW(__AAW__)                           ((__AAW__)    <= LTDC_HORIZONTALSYNC)
0683 #define IS_LTDC_AAH(__AAH__)                           ((__AAH__)    <= LTDC_VERTICALSYNC)
0684 #define IS_LTDC_TOTALW(__TOTALW__)                     ((__TOTALW__) <= LTDC_HORIZONTALSYNC)
0685 #define IS_LTDC_TOTALH(__TOTALH__)                     ((__TOTALH__) <= LTDC_VERTICALSYNC)
0686 #define IS_LTDC_BLUEVALUE(__BBLUE__)                   ((__BBLUE__)  <= LTDC_COLOR)
0687 #define IS_LTDC_GREENVALUE(__BGREEN__)                 ((__BGREEN__) <= LTDC_COLOR)
0688 #define IS_LTDC_REDVALUE(__BRED__)                     ((__BRED__)   <= LTDC_COLOR)
0689 #define IS_LTDC_BLENDING_FACTOR1(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_CA) || \
0690                                                         ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_PAxCA))
0691 #define IS_LTDC_BLENDING_FACTOR2(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_CA) || \
0692                                                         ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_PAxCA))
0693 #define IS_LTDC_PIXEL_FORMAT(__PIXEL_FORMAT__)         (((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB8888) || \
0694                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB888)   || \
0695                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB565)   || \
0696                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB1555) || \
0697                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB4444) || \
0698                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_L8)       || \
0699                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL44)     || \
0700                                                         ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL88))
0701 #define IS_LTDC_ALPHA(__ALPHA__)                       ((__ALPHA__) <= LTDC_ALPHA)
0702 #define IS_LTDC_HCONFIGST(__HCONFIGST__)               ((__HCONFIGST__) <= LTDC_STARTPOSITION)
0703 #define IS_LTDC_HCONFIGSP(__HCONFIGSP__)               ((__HCONFIGSP__) <= LTDC_STOPPOSITION)
0704 #define IS_LTDC_VCONFIGST(__VCONFIGST__)               ((__VCONFIGST__) <= LTDC_STARTPOSITION)
0705 #define IS_LTDC_VCONFIGSP(__VCONFIGSP__)               ((__VCONFIGSP__) <= LTDC_STOPPOSITION)
0706 #define IS_LTDC_CFBP(__CFBP__)                         ((__CFBP__) <= LTDC_COLOR_FRAME_BUFFER)
0707 #define IS_LTDC_CFBLL(__CFBLL__)                       ((__CFBLL__) <= LTDC_COLOR_FRAME_BUFFER)
0708 #define IS_LTDC_CFBLNBR(__CFBLNBR__)                   ((__CFBLNBR__) <= LTDC_LINE_NUMBER)
0709 #define IS_LTDC_LIPOS(__LIPOS__)                       ((__LIPOS__) <= 0x7FFU)
0710 #define IS_LTDC_RELOAD(__RELOADTYPE__)                 (((__RELOADTYPE__) == LTDC_RELOAD_IMMEDIATE) || \
0711                                                         ((__RELOADTYPE__) == LTDC_RELOAD_VERTICAL_BLANKING))
0712 /**
0713   * @}
0714   */
0715
0716 /* Private functions ---------------------------------------------------------*/
0717 /** @defgroup LTDC_Private_Functions LTDC Private Functions
0718   * @ingroup RTEMSBSPsARMSTM32H7
0719   * @{
0720   */
0721
0722 /**
0723   * @}
0724   */
0725
0726 /**
0727   * @}
0728   */
0729
0730 /**
0731   * @}
0732   */
0733
0734 #endif /* LTDC */
0735
0736 #ifdef __cplusplus
0737 }
0738 #endif
0739
0740 #endif /* STM32H7xx_HAL_LTDC_H */
0741