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