|
STM32H735xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32h7xx_hal_ltdc.h 00004 * @author MCD Application Team 00005 * @brief Header file of LTDC HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * Copyright (c) 2017 STMicroelectronics. 00010 * All rights reserved. 00011 * 00012 * This software is licensed under terms that can be found in the LICENSE file 00013 * in the root directory of this software component. 00014 * If no LICENSE file comes with this software, it is provided AS-IS. 00015 * 00016 ****************************************************************************** 00017 */ 00018 00019 /* Define to prevent recursive inclusion -------------------------------------*/ 00020 #ifndef STM32H7xx_HAL_LTDC_H 00021 #define STM32H7xx_HAL_LTDC_H 00022 00023 #ifdef __cplusplus 00024 extern "C" { 00025 #endif 00026 00027 /* Includes ------------------------------------------------------------------*/ 00028 #include "stm32h7xx_hal_def.h" 00029 00030 #if defined (LTDC) 00031 00032 /** @addtogroup STM32H7xx_HAL_Driver 00033 * @{ 00034 */ 00035 00036 /** @defgroup LTDC LTDC 00037 * @brief LTDC HAL module driver 00038 * @{ 00039 */ 00040 00041 /* Exported types ------------------------------------------------------------*/ 00042 /** @defgroup LTDC_Exported_Types LTDC Exported Types 00043 * @{ 00044 */ 00045 #define MAX_LAYER 2U 00046 00047 /** 00048 * @brief LTDC color structure definition 00049 */ 00050 typedef struct 00051 { 00052 uint8_t Blue; /*!< Configures the blue value. 00053 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */ 00054 00055 uint8_t Green; /*!< Configures the green value. 00056 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */ 00057 00058 uint8_t Red; /*!< Configures the red value. 00059 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */ 00060 00061 uint8_t Reserved; /*!< Reserved 0xFF */ 00062 } LTDC_ColorTypeDef; 00063 00064 /** 00065 * @brief LTDC Init structure definition 00066 */ 00067 typedef struct 00068 { 00069 uint32_t HSPolarity; /*!< configures the horizontal synchronization polarity. 00070 This parameter can be one value of @ref LTDC_HS_POLARITY */ 00071 00072 uint32_t VSPolarity; /*!< configures the vertical synchronization polarity. 00073 This parameter can be one value of @ref LTDC_VS_POLARITY */ 00074 00075 uint32_t DEPolarity; /*!< configures the data enable polarity. 00076 This parameter can be one of value of @ref LTDC_DE_POLARITY */ 00077 00078 uint32_t PCPolarity; /*!< configures the pixel clock polarity. 00079 This parameter can be one of value of @ref LTDC_PC_POLARITY */ 00080 00081 uint32_t HorizontalSync; /*!< configures the number of Horizontal synchronization width. 00082 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */ 00083 00084 uint32_t VerticalSync; /*!< configures the number of Vertical synchronization height. 00085 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */ 00086 00087 uint32_t AccumulatedHBP; /*!< configures the accumulated horizontal back porch width. 00088 This parameter must be a number between Min_Data = LTDC_HorizontalSync and Max_Data = 0xFFF. */ 00089 00090 uint32_t AccumulatedVBP; /*!< configures the accumulated vertical back porch height. 00091 This parameter must be a number between Min_Data = LTDC_VerticalSync and Max_Data = 0x7FF. */ 00092 00093 uint32_t AccumulatedActiveW; /*!< configures the accumulated active width. 00094 This parameter must be a number between Min_Data = LTDC_AccumulatedHBP and Max_Data = 0xFFF. */ 00095 00096 uint32_t AccumulatedActiveH; /*!< configures the accumulated active height. 00097 This parameter must be a number between Min_Data = LTDC_AccumulatedVBP and Max_Data = 0x7FF. */ 00098 00099 uint32_t TotalWidth; /*!< configures the total width. 00100 This parameter must be a number between Min_Data = LTDC_AccumulatedActiveW and Max_Data = 0xFFF. */ 00101 00102 uint32_t TotalHeigh; /*!< configures the total height. 00103 This parameter must be a number between Min_Data = LTDC_AccumulatedActiveH and Max_Data = 0x7FF. */ 00104 00105 LTDC_ColorTypeDef Backcolor; /*!< Configures the background color. */ 00106 } LTDC_InitTypeDef; 00107 00108 /** 00109 * @brief LTDC Layer structure definition 00110 */ 00111 typedef struct 00112 { 00113 uint32_t WindowX0; /*!< Configures the Window Horizontal Start Position. 00114 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */ 00115 00116 uint32_t WindowX1; /*!< Configures the Window Horizontal Stop Position. 00117 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */ 00118 00119 uint32_t WindowY0; /*!< Configures the Window vertical Start Position. 00120 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */ 00121 00122 uint32_t WindowY1; /*!< Configures the Window vertical Stop Position. 00123 This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x7FF. */ 00124 00125 uint32_t PixelFormat; /*!< Specifies the pixel format. 00126 This parameter can be one of value of @ref LTDC_Pixelformat */ 00127 00128 uint32_t Alpha; /*!< Specifies the constant alpha used for blending. 00129 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */ 00130 00131 uint32_t Alpha0; /*!< Configures the default alpha value. 00132 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */ 00133 00134 uint32_t BlendingFactor1; /*!< Select the blending factor 1. 00135 This parameter can be one of value of @ref LTDC_BlendingFactor1 */ 00136 00137 uint32_t BlendingFactor2; /*!< Select the blending factor 2. 00138 This parameter can be one of value of @ref LTDC_BlendingFactor2 */ 00139 00140 uint32_t FBStartAdress; /*!< Configures the color frame buffer address */ 00141 00142 uint32_t ImageWidth; /*!< Configures the color frame buffer line length. 00143 This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x1FFF. */ 00144 00145 uint32_t ImageHeight; /*!< Specifies the number of line in frame buffer. 00146 This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */ 00147 00148 LTDC_ColorTypeDef Backcolor; /*!< Configures the layer background color. */ 00149 } LTDC_LayerCfgTypeDef; 00150 00151 /** 00152 * @brief HAL LTDC State structures definition 00153 */ 00154 typedef enum 00155 { 00156 HAL_LTDC_STATE_RESET = 0x00U, /*!< LTDC not yet initialized or disabled */ 00157 HAL_LTDC_STATE_READY = 0x01U, /*!< LTDC initialized and ready for use */ 00158 HAL_LTDC_STATE_BUSY = 0x02U, /*!< LTDC internal process is ongoing */ 00159 HAL_LTDC_STATE_TIMEOUT = 0x03U, /*!< LTDC Timeout state */ 00160 HAL_LTDC_STATE_ERROR = 0x04U /*!< LTDC state error */ 00161 } HAL_LTDC_StateTypeDef; 00162 00163 /** 00164 * @brief LTDC handle Structure definition 00165 */ 00166 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00167 typedef struct __LTDC_HandleTypeDef 00168 #else 00169 typedef struct 00170 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */ 00171 { 00172 LTDC_TypeDef *Instance; /*!< LTDC Register base address */ 00173 00174 LTDC_InitTypeDef Init; /*!< LTDC parameters */ 00175 00176 LTDC_LayerCfgTypeDef LayerCfg[MAX_LAYER]; /*!< LTDC Layers parameters */ 00177 00178 HAL_LockTypeDef Lock; /*!< LTDC Lock */ 00179 00180 __IO HAL_LTDC_StateTypeDef State; /*!< LTDC state */ 00181 00182 __IO uint32_t ErrorCode; /*!< LTDC Error code */ 00183 00184 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00185 void (* LineEventCallback)(struct __LTDC_HandleTypeDef *hltdc); /*!< LTDC Line Event Callback */ 00186 void (* ReloadEventCallback)(struct __LTDC_HandleTypeDef *hltdc); /*!< LTDC Reload Event Callback */ 00187 void (* ErrorCallback)(struct __LTDC_HandleTypeDef *hltdc); /*!< LTDC Error Callback */ 00188 00189 void (* MspInitCallback)(struct __LTDC_HandleTypeDef *hltdc); /*!< LTDC Msp Init callback */ 00190 void (* MspDeInitCallback)(struct __LTDC_HandleTypeDef *hltdc); /*!< LTDC Msp DeInit callback */ 00191 00192 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */ 00193 00194 00195 } LTDC_HandleTypeDef; 00196 00197 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00198 /** 00199 * @brief HAL LTDC Callback ID enumeration definition 00200 */ 00201 typedef enum 00202 { 00203 HAL_LTDC_MSPINIT_CB_ID = 0x00U, /*!< LTDC MspInit callback ID */ 00204 HAL_LTDC_MSPDEINIT_CB_ID = 0x01U, /*!< LTDC MspDeInit callback ID */ 00205 00206 HAL_LTDC_LINE_EVENT_CB_ID = 0x02U, /*!< LTDC Line Event Callback ID */ 00207 HAL_LTDC_RELOAD_EVENT_CB_ID = 0x03U, /*!< LTDC Reload Callback ID */ 00208 HAL_LTDC_ERROR_CB_ID = 0x04U /*!< LTDC Error Callback ID */ 00209 00210 } HAL_LTDC_CallbackIDTypeDef; 00211 00212 /** 00213 * @brief HAL LTDC Callback pointer definition 00214 */ 00215 typedef void (*pLTDC_CallbackTypeDef)(LTDC_HandleTypeDef *hltdc); /*!< pointer to an LTDC callback function */ 00216 00217 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */ 00218 00219 /** 00220 * @} 00221 */ 00222 00223 /* Exported constants --------------------------------------------------------*/ 00224 /** @defgroup LTDC_Exported_Constants LTDC Exported Constants 00225 * @{ 00226 */ 00227 00228 /** @defgroup LTDC_Error_Code LTDC Error Code 00229 * @{ 00230 */ 00231 #define HAL_LTDC_ERROR_NONE 0x00000000U /*!< LTDC No error */ 00232 #define HAL_LTDC_ERROR_TE 0x00000001U /*!< LTDC Transfer error */ 00233 #define HAL_LTDC_ERROR_FU 0x00000002U /*!< LTDC FIFO Underrun */ 00234 #define HAL_LTDC_ERROR_TIMEOUT 0x00000020U /*!< LTDC Timeout error */ 00235 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00236 #define HAL_LTDC_ERROR_INVALID_CALLBACK 0x00000040U /*!< LTDC Invalid Callback error */ 00237 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */ 00238 /** 00239 * @} 00240 */ 00241 00242 /** @defgroup LTDC_Layer LTDC Layer 00243 * @{ 00244 */ 00245 #define LTDC_LAYER_1 0x00000000U /*!< LTDC Layer 1 */ 00246 #define LTDC_LAYER_2 0x00000001U /*!< LTDC Layer 2 */ 00247 /** 00248 * @} 00249 */ 00250 00251 /** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY 00252 * @{ 00253 */ 00254 #define LTDC_HSPOLARITY_AL 0x00000000U /*!< Horizontal Synchronization is active low. */ 00255 #define LTDC_HSPOLARITY_AH LTDC_GCR_HSPOL /*!< Horizontal Synchronization is active high. */ 00256 /** 00257 * @} 00258 */ 00259 00260 /** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY 00261 * @{ 00262 */ 00263 #define LTDC_VSPOLARITY_AL 0x00000000U /*!< Vertical Synchronization is active low. */ 00264 #define LTDC_VSPOLARITY_AH LTDC_GCR_VSPOL /*!< Vertical Synchronization is active high. */ 00265 /** 00266 * @} 00267 */ 00268 00269 /** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY 00270 * @{ 00271 */ 00272 #define LTDC_DEPOLARITY_AL 0x00000000U /*!< Data Enable, is active low. */ 00273 #define LTDC_DEPOLARITY_AH LTDC_GCR_DEPOL /*!< Data Enable, is active high. */ 00274 /** 00275 * @} 00276 */ 00277 00278 /** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY 00279 * @{ 00280 */ 00281 #define LTDC_PCPOLARITY_IPC 0x00000000U /*!< input pixel clock. */ 00282 #define LTDC_PCPOLARITY_IIPC LTDC_GCR_PCPOL /*!< inverted input pixel clock. */ 00283 /** 00284 * @} 00285 */ 00286 00287 /** @defgroup LTDC_SYNC LTDC SYNC 00288 * @{ 00289 */ 00290 #define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16U) /*!< Horizontal synchronization width. */ 00291 #define LTDC_VERTICALSYNC LTDC_SSCR_VSH /*!< Vertical synchronization height. */ 00292 /** 00293 * @} 00294 */ 00295 00296 /** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR 00297 * @{ 00298 */ 00299 #define LTDC_COLOR 0x000000FFU /*!< Color mask */ 00300 /** 00301 * @} 00302 */ 00303 00304 /** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1 00305 * @{ 00306 */ 00307 #define LTDC_BLENDING_FACTOR1_CA 0x00000400U /*!< Blending factor : Cte Alpha */ 00308 #define LTDC_BLENDING_FACTOR1_PAxCA 0x00000600U /*!< Blending factor : Cte Alpha x Pixel Alpha*/ 00309 /** 00310 * @} 00311 */ 00312 00313 /** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2 00314 * @{ 00315 */ 00316 #define LTDC_BLENDING_FACTOR2_CA 0x00000005U /*!< Blending factor : Cte Alpha */ 00317 #define LTDC_BLENDING_FACTOR2_PAxCA 0x00000007U /*!< Blending factor : Cte Alpha x Pixel Alpha*/ 00318 /** 00319 * @} 00320 */ 00321 00322 /** @defgroup LTDC_Pixelformat LTDC Pixel format 00323 * @{ 00324 */ 00325 #define LTDC_PIXEL_FORMAT_ARGB8888 0x00000000U /*!< ARGB8888 LTDC pixel format */ 00326 #define LTDC_PIXEL_FORMAT_RGB888 0x00000001U /*!< RGB888 LTDC pixel format */ 00327 #define LTDC_PIXEL_FORMAT_RGB565 0x00000002U /*!< RGB565 LTDC pixel format */ 00328 #define LTDC_PIXEL_FORMAT_ARGB1555 0x00000003U /*!< ARGB1555 LTDC pixel format */ 00329 #define LTDC_PIXEL_FORMAT_ARGB4444 0x00000004U /*!< ARGB4444 LTDC pixel format */ 00330 #define LTDC_PIXEL_FORMAT_L8 0x00000005U /*!< L8 LTDC pixel format */ 00331 #define LTDC_PIXEL_FORMAT_AL44 0x00000006U /*!< AL44 LTDC pixel format */ 00332 #define LTDC_PIXEL_FORMAT_AL88 0x00000007U /*!< AL88 LTDC pixel format */ 00333 /** 00334 * @} 00335 */ 00336 00337 /** @defgroup LTDC_Alpha LTDC Alpha 00338 * @{ 00339 */ 00340 #define LTDC_ALPHA LTDC_LxCACR_CONSTA /*!< LTDC Constant Alpha mask */ 00341 /** 00342 * @} 00343 */ 00344 00345 /** @defgroup LTDC_LAYER_Config LTDC LAYER Config 00346 * @{ 00347 */ 00348 #define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16U) /*!< LTDC Layer stop position */ 00349 #define LTDC_STARTPOSITION LTDC_LxWHPCR_WHSTPOS /*!< LTDC Layer start position */ 00350 00351 #define LTDC_COLOR_FRAME_BUFFER LTDC_LxCFBLR_CFBLL /*!< LTDC Layer Line length */ 00352 #define LTDC_LINE_NUMBER LTDC_LxCFBLNR_CFBLNBR /*!< LTDC Layer Line number */ 00353 /** 00354 * @} 00355 */ 00356 00357 /** @defgroup LTDC_Interrupts LTDC Interrupts 00358 * @{ 00359 */ 00360 #define LTDC_IT_LI LTDC_IER_LIE /*!< LTDC Line Interrupt */ 00361 #define LTDC_IT_FU LTDC_IER_FUIE /*!< LTDC FIFO Underrun Interrupt */ 00362 #define LTDC_IT_TE LTDC_IER_TERRIE /*!< LTDC Transfer Error Interrupt */ 00363 #define LTDC_IT_RR LTDC_IER_RRIE /*!< LTDC Register Reload Interrupt */ 00364 /** 00365 * @} 00366 */ 00367 00368 /** @defgroup LTDC_Flags LTDC Flags 00369 * @{ 00370 */ 00371 #define LTDC_FLAG_LI LTDC_ISR_LIF /*!< LTDC Line Interrupt Flag */ 00372 #define LTDC_FLAG_FU LTDC_ISR_FUIF /*!< LTDC FIFO Underrun interrupt Flag */ 00373 #define LTDC_FLAG_TE LTDC_ISR_TERRIF /*!< LTDC Transfer Error interrupt Flag */ 00374 #define LTDC_FLAG_RR LTDC_ISR_RRIF /*!< LTDC Register Reload interrupt Flag */ 00375 /** 00376 * @} 00377 */ 00378 00379 /** @defgroup LTDC_Reload_Type LTDC Reload Type 00380 * @{ 00381 */ 00382 #define LTDC_RELOAD_IMMEDIATE LTDC_SRCR_IMR /*!< Immediate Reload */ 00383 #define LTDC_RELOAD_VERTICAL_BLANKING LTDC_SRCR_VBR /*!< Vertical Blanking Reload */ 00384 /** 00385 * @} 00386 */ 00387 00388 /** 00389 * @} 00390 */ 00391 00392 /* Exported macro ------------------------------------------------------------*/ 00393 /** @defgroup LTDC_Exported_Macros LTDC Exported Macros 00394 * @{ 00395 */ 00396 00397 /** @brief Reset LTDC handle state. 00398 * @param __HANDLE__ LTDC handle 00399 * @retval None 00400 */ 00401 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00402 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) do{ \ 00403 (__HANDLE__)->State = HAL_LTDC_STATE_RESET; \ 00404 (__HANDLE__)->MspInitCallback = NULL; \ 00405 (__HANDLE__)->MspDeInitCallback = NULL; \ 00406 } while(0) 00407 #else 00408 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET) 00409 #endif /*USE_HAL_LTDC_REGISTER_CALLBACKS */ 00410 00411 /** 00412 * @brief Enable the LTDC. 00413 * @param __HANDLE__ LTDC handle 00414 * @retval None. 00415 */ 00416 #define __HAL_LTDC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN) 00417 00418 /** 00419 * @brief Disable the LTDC. 00420 * @param __HANDLE__ LTDC handle 00421 * @retval None. 00422 */ 00423 #define __HAL_LTDC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN)) 00424 00425 /** 00426 * @brief Enable the LTDC Layer. 00427 * @param __HANDLE__ LTDC handle 00428 * @param __LAYER__ Specify the layer to be enabled. 00429 * This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1). 00430 * @retval None. 00431 */ 00432 #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN) 00433 00434 /** 00435 * @brief Disable the LTDC Layer. 00436 * @param __HANDLE__ LTDC handle 00437 * @param __LAYER__ Specify the layer to be disabled. 00438 * This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1). 00439 * @retval None. 00440 */ 00441 #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN) 00442 00443 /** 00444 * @brief Reload immediately all LTDC Layers. 00445 * @param __HANDLE__ LTDC handle 00446 * @retval None. 00447 */ 00448 #define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR) 00449 00450 /** 00451 * @brief Reload during vertical blanking period all LTDC Layers. 00452 * @param __HANDLE__ LTDC handle 00453 * @retval None. 00454 */ 00455 #define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_VBR) 00456 00457 /* Interrupt & Flag management */ 00458 /** 00459 * @brief Get the LTDC pending flags. 00460 * @param __HANDLE__ LTDC handle 00461 * @param __FLAG__ Get the specified flag. 00462 * This parameter can be any combination of the following values: 00463 * @arg LTDC_FLAG_LI: Line Interrupt flag 00464 * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag 00465 * @arg LTDC_FLAG_TE: Transfer Error interrupt flag 00466 * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag 00467 * @retval The state of FLAG (SET or RESET). 00468 */ 00469 #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__)) 00470 00471 /** 00472 * @brief Clears the LTDC pending flags. 00473 * @param __HANDLE__ LTDC handle 00474 * @param __FLAG__ Specify the flag to clear. 00475 * This parameter can be any combination of the following values: 00476 * @arg LTDC_FLAG_LI: Line Interrupt flag 00477 * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag 00478 * @arg LTDC_FLAG_TE: Transfer Error interrupt flag 00479 * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag 00480 * @retval None 00481 */ 00482 #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 00483 00484 /** 00485 * @brief Enables the specified LTDC interrupts. 00486 * @param __HANDLE__ LTDC handle 00487 * @param __INTERRUPT__ Specify the LTDC interrupt sources to be enabled. 00488 * This parameter can be any combination of the following values: 00489 * @arg LTDC_IT_LI: Line Interrupt flag 00490 * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag 00491 * @arg LTDC_IT_TE: Transfer Error interrupt flag 00492 * @arg LTDC_IT_RR: Register Reload Interrupt Flag 00493 * @retval None 00494 */ 00495 #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__)) 00496 00497 /** 00498 * @brief Disables the specified LTDC interrupts. 00499 * @param __HANDLE__ LTDC handle 00500 * @param __INTERRUPT__ Specify the LTDC interrupt sources to be disabled. 00501 * This parameter can be any combination of the following values: 00502 * @arg LTDC_IT_LI: Line Interrupt flag 00503 * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag 00504 * @arg LTDC_IT_TE: Transfer Error interrupt flag 00505 * @arg LTDC_IT_RR: Register Reload Interrupt Flag 00506 * @retval None 00507 */ 00508 #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__)) 00509 00510 /** 00511 * @brief Check whether the specified LTDC interrupt has occurred or not. 00512 * @param __HANDLE__ LTDC handle 00513 * @param __INTERRUPT__ Specify the LTDC interrupt source to check. 00514 * This parameter can be one of the following values: 00515 * @arg LTDC_IT_LI: Line Interrupt flag 00516 * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag 00517 * @arg LTDC_IT_TE: Transfer Error interrupt flag 00518 * @arg LTDC_IT_RR: Register Reload Interrupt Flag 00519 * @retval The state of INTERRUPT (SET or RESET). 00520 */ 00521 #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER & (__INTERRUPT__)) 00522 /** 00523 * @} 00524 */ 00525 00526 /* Include LTDC HAL Extension module */ 00527 #include "stm32h7xx_hal_ltdc_ex.h" 00528 00529 /* Exported functions --------------------------------------------------------*/ 00530 /** @addtogroup LTDC_Exported_Functions 00531 * @{ 00532 */ 00533 /** @addtogroup LTDC_Exported_Functions_Group1 00534 * @{ 00535 */ 00536 /* Initialization and de-initialization functions *****************************/ 00537 HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc); 00538 HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc); 00539 void HAL_LTDC_MspInit(LTDC_HandleTypeDef *hltdc); 00540 void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef *hltdc); 00541 void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc); 00542 void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc); 00543 void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc); 00544 00545 /* Callbacks Register/UnRegister functions ***********************************/ 00546 #if (USE_HAL_LTDC_REGISTER_CALLBACKS == 1) 00547 HAL_StatusTypeDef HAL_LTDC_RegisterCallback(LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID, pLTDC_CallbackTypeDef pCallback); 00548 HAL_StatusTypeDef HAL_LTDC_UnRegisterCallback(LTDC_HandleTypeDef *hltdc, HAL_LTDC_CallbackIDTypeDef CallbackID); 00549 #endif /* USE_HAL_LTDC_REGISTER_CALLBACKS */ 00550 00551 /** 00552 * @} 00553 */ 00554 00555 /** @addtogroup LTDC_Exported_Functions_Group2 00556 * @{ 00557 */ 00558 /* IO operation functions *****************************************************/ 00559 void HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc); 00560 /** 00561 * @} 00562 */ 00563 00564 /** @addtogroup LTDC_Exported_Functions_Group3 00565 * @{ 00566 */ 00567 /* Peripheral Control functions ***********************************************/ 00568 HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx); 00569 HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx); 00570 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx); 00571 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx); 00572 HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx); 00573 HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx); 00574 HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx); 00575 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx); 00576 HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx); 00577 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00578 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00579 HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00580 HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00581 HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line); 00582 HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc); 00583 HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc); 00584 HAL_StatusTypeDef HAL_LTDC_Reload(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType); 00585 HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx); 00586 HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx); 00587 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx); 00588 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx); 00589 HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx); 00590 HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx); 00591 HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx); 00592 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx); 00593 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00594 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00595 HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00596 HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx); 00597 00598 /** 00599 * @} 00600 */ 00601 00602 /** @addtogroup LTDC_Exported_Functions_Group4 00603 * @{ 00604 */ 00605 /* Peripheral State functions *************************************************/ 00606 HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc); 00607 uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc); 00608 /** 00609 * @} 00610 */ 00611 00612 /** 00613 * @} 00614 */ 00615 00616 /* Private types -------------------------------------------------------------*/ 00617 /* Private variables ---------------------------------------------------------*/ 00618 /* Private constants ---------------------------------------------------------*/ 00619 /* Private macros ------------------------------------------------------------*/ 00620 /** @defgroup LTDC_Private_Macros LTDC Private Macros 00621 * @{ 00622 */ 00623 #define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84U + (0x80U*(__LAYER__))))) 00624 #define IS_LTDC_LAYER(__LAYER__) ((__LAYER__) < MAX_LAYER) 00625 #define IS_LTDC_HSPOL(__HSPOL__) (((__HSPOL__) == LTDC_HSPOLARITY_AL) || ((__HSPOL__) == LTDC_HSPOLARITY_AH)) 00626 #define IS_LTDC_VSPOL(__VSPOL__) (((__VSPOL__) == LTDC_VSPOLARITY_AL) || ((__VSPOL__) == LTDC_VSPOLARITY_AH)) 00627 #define IS_LTDC_DEPOL(__DEPOL__) (((__DEPOL__) == LTDC_DEPOLARITY_AL) || ((__DEPOL__) == LTDC_DEPOLARITY_AH)) 00628 #define IS_LTDC_PCPOL(__PCPOL__) (((__PCPOL__) == LTDC_PCPOLARITY_IPC) || ((__PCPOL__) == LTDC_PCPOLARITY_IIPC)) 00629 #define IS_LTDC_HSYNC(__HSYNC__) ((__HSYNC__) <= LTDC_HORIZONTALSYNC) 00630 #define IS_LTDC_VSYNC(__VSYNC__) ((__VSYNC__) <= LTDC_VERTICALSYNC) 00631 #define IS_LTDC_AHBP(__AHBP__) ((__AHBP__) <= LTDC_HORIZONTALSYNC) 00632 #define IS_LTDC_AVBP(__AVBP__) ((__AVBP__) <= LTDC_VERTICALSYNC) 00633 #define IS_LTDC_AAW(__AAW__) ((__AAW__) <= LTDC_HORIZONTALSYNC) 00634 #define IS_LTDC_AAH(__AAH__) ((__AAH__) <= LTDC_VERTICALSYNC) 00635 #define IS_LTDC_TOTALW(__TOTALW__) ((__TOTALW__) <= LTDC_HORIZONTALSYNC) 00636 #define IS_LTDC_TOTALH(__TOTALH__) ((__TOTALH__) <= LTDC_VERTICALSYNC) 00637 #define IS_LTDC_BLUEVALUE(__BBLUE__) ((__BBLUE__) <= LTDC_COLOR) 00638 #define IS_LTDC_GREENVALUE(__BGREEN__) ((__BGREEN__) <= LTDC_COLOR) 00639 #define IS_LTDC_REDVALUE(__BRED__) ((__BRED__) <= LTDC_COLOR) 00640 #define IS_LTDC_BLENDING_FACTOR1(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_CA) || \ 00641 ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_PAxCA)) 00642 #define IS_LTDC_BLENDING_FACTOR2(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_CA) || \ 00643 ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_PAxCA)) 00644 #define IS_LTDC_PIXEL_FORMAT(__PIXEL_FORMAT__) (((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB8888) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB888) || \ 00645 ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB565) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB1555) || \ 00646 ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB4444) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_L8) || \ 00647 ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL44) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL88)) 00648 #define IS_LTDC_ALPHA(__ALPHA__) ((__ALPHA__) <= LTDC_ALPHA) 00649 #define IS_LTDC_HCONFIGST(__HCONFIGST__) ((__HCONFIGST__) <= LTDC_STARTPOSITION) 00650 #define IS_LTDC_HCONFIGSP(__HCONFIGSP__) ((__HCONFIGSP__) <= LTDC_STOPPOSITION) 00651 #define IS_LTDC_VCONFIGST(__VCONFIGST__) ((__VCONFIGST__) <= LTDC_STARTPOSITION) 00652 #define IS_LTDC_VCONFIGSP(__VCONFIGSP__) ((__VCONFIGSP__) <= LTDC_STOPPOSITION) 00653 #define IS_LTDC_CFBP(__CFBP__) ((__CFBP__) <= LTDC_COLOR_FRAME_BUFFER) 00654 #define IS_LTDC_CFBLL(__CFBLL__) ((__CFBLL__) <= LTDC_COLOR_FRAME_BUFFER) 00655 #define IS_LTDC_CFBLNBR(__CFBLNBR__) ((__CFBLNBR__) <= LTDC_LINE_NUMBER) 00656 #define IS_LTDC_LIPOS(__LIPOS__) ((__LIPOS__) <= 0x7FFU) 00657 #define IS_LTDC_RELOAD(__RELOADTYPE__) (((__RELOADTYPE__) == LTDC_RELOAD_IMMEDIATE) || ((__RELOADTYPE__) == LTDC_RELOAD_VERTICAL_BLANKING)) 00658 /** 00659 * @} 00660 */ 00661 00662 /* Private functions ---------------------------------------------------------*/ 00663 /** @defgroup LTDC_Private_Functions LTDC Private Functions 00664 * @{ 00665 */ 00666 00667 /** 00668 * @} 00669 */ 00670 00671 /** 00672 * @} 00673 */ 00674 00675 /** 00676 * @} 00677 */ 00678 00679 #endif /* LTDC */ 00680 00681 #ifdef __cplusplus 00682 } 00683 #endif 00684 00685 #endif /* STM32H7xx_HAL_LTDC_H */
1.7.6.1