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