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