STM CMSIS
stm32f4xx_hal_ltdc.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_LTDC_H
40 #define __STM32F4xx_HAL_LTDC_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 #if defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F469xx) || defined(STM32F479xx)
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32f4xx_hal_def.h"
49 
59 /* Exported types ------------------------------------------------------------*/
63 #define MAX_LAYER 2
64 
68 typedef struct
69 {
70  uint8_t Blue;
73  uint8_t Green;
76  uint8_t Red;
79  uint8_t Reserved;
80 } LTDC_ColorTypeDef;
81 
85 typedef struct
86 {
87  uint32_t HSPolarity;
90  uint32_t VSPolarity;
93  uint32_t DEPolarity;
96  uint32_t PCPolarity;
99  uint32_t HorizontalSync;
102  uint32_t VerticalSync;
105  uint32_t AccumulatedHBP;
108  uint32_t AccumulatedVBP;
111  uint32_t AccumulatedActiveW;
114  uint32_t AccumulatedActiveH;
117  uint32_t TotalWidth;
120  uint32_t TotalHeigh;
123  LTDC_ColorTypeDef Backcolor;
124 } LTDC_InitTypeDef;
125 
129 typedef struct
130 {
131  uint32_t WindowX0;
134  uint32_t WindowX1;
137  uint32_t WindowY0;
140  uint32_t WindowY1;
143  uint32_t PixelFormat;
146  uint32_t Alpha;
149  uint32_t Alpha0;
152  uint32_t BlendingFactor1;
155  uint32_t BlendingFactor2;
158  uint32_t FBStartAdress;
160  uint32_t ImageWidth;
163  uint32_t ImageHeight;
166  LTDC_ColorTypeDef Backcolor;
167 } LTDC_LayerCfgTypeDef;
168 
172 typedef enum
173 {
174  HAL_LTDC_STATE_RESET = 0x00U,
175  HAL_LTDC_STATE_READY = 0x01U,
176  HAL_LTDC_STATE_BUSY = 0x02U,
177  HAL_LTDC_STATE_TIMEOUT = 0x03U,
178  HAL_LTDC_STATE_ERROR = 0x04U
179 }HAL_LTDC_StateTypeDef;
180 
184 typedef struct
185 {
186  LTDC_TypeDef *Instance;
188  LTDC_InitTypeDef Init;
190  LTDC_LayerCfgTypeDef LayerCfg[MAX_LAYER];
192  HAL_LockTypeDef Lock;
194  __IO HAL_LTDC_StateTypeDef State;
196  __IO uint32_t ErrorCode;
198 } LTDC_HandleTypeDef;
203 /* Exported constants --------------------------------------------------------*/
211 #define HAL_LTDC_ERROR_NONE ((uint32_t)0x00000000U)
212 #define HAL_LTDC_ERROR_TE ((uint32_t)0x00000001U)
213 #define HAL_LTDC_ERROR_FU ((uint32_t)0x00000002U)
214 #define HAL_LTDC_ERROR_TIMEOUT ((uint32_t)0x00000020U)
222 #define LTDC_HSPOLARITY_AL ((uint32_t)0x00000000U)
223 #define LTDC_HSPOLARITY_AH LTDC_GCR_HSPOL
231 #define LTDC_VSPOLARITY_AL ((uint32_t)0x00000000U)
232 #define LTDC_VSPOLARITY_AH LTDC_GCR_VSPOL
240 #define LTDC_DEPOLARITY_AL ((uint32_t)0x00000000U)
241 #define LTDC_DEPOLARITY_AH LTDC_GCR_DEPOL
249 #define LTDC_PCPOLARITY_IPC ((uint32_t)0x00000000U)
250 #define LTDC_PCPOLARITY_IIPC LTDC_GCR_PCPOL
258 #define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16U)
259 #define LTDC_VERTICALSYNC LTDC_SSCR_VSH
267 #define LTDC_COLOR ((uint32_t)0x000000FFU)
275 #define LTDC_BLENDING_FACTOR1_CA ((uint32_t)0x00000400U)
276 #define LTDC_BLENDING_FACTOR1_PAxCA ((uint32_t)0x00000600U)
284 #define LTDC_BLENDING_FACTOR2_CA ((uint32_t)0x00000005U)
285 #define LTDC_BLENDING_FACTOR2_PAxCA ((uint32_t)0x00000007U)
293 #define LTDC_PIXEL_FORMAT_ARGB8888 ((uint32_t)0x00000000U)
294 #define LTDC_PIXEL_FORMAT_RGB888 ((uint32_t)0x00000001U)
295 #define LTDC_PIXEL_FORMAT_RGB565 ((uint32_t)0x00000002U)
296 #define LTDC_PIXEL_FORMAT_ARGB1555 ((uint32_t)0x00000003U)
297 #define LTDC_PIXEL_FORMAT_ARGB4444 ((uint32_t)0x00000004U)
298 #define LTDC_PIXEL_FORMAT_L8 ((uint32_t)0x00000005U)
299 #define LTDC_PIXEL_FORMAT_AL44 ((uint32_t)0x00000006U)
300 #define LTDC_PIXEL_FORMAT_AL88 ((uint32_t)0x00000007U)
308 #define LTDC_ALPHA LTDC_LxCACR_CONSTA
316 #define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16U)
317 #define LTDC_STARTPOSITION LTDC_LxWHPCR_WHSTPOS
319 #define LTDC_COLOR_FRAME_BUFFER LTDC_LxCFBLR_CFBLL
320 #define LTDC_LINE_NUMBER LTDC_LxCFBLNR_CFBLNBR
328 #define LTDC_IT_LI LTDC_IER_LIE
329 #define LTDC_IT_FU LTDC_IER_FUIE
330 #define LTDC_IT_TE LTDC_IER_TERRIE
331 #define LTDC_IT_RR LTDC_IER_RRIE
332 
339 #define LTDC_FLAG_LI LTDC_ISR_LIF
340 #define LTDC_FLAG_FU LTDC_ISR_FUIF
341 #define LTDC_FLAG_TE LTDC_ISR_TERRIF
342 #define LTDC_FLAG_RR LTDC_ISR_RRIF
343 
350 #define LTDC_RELOAD_IMMEDIATE LTDC_SRCR_IMR
351 #define LTDC_RELOAD_VERTICAL_BLANKING LTDC_SRCR_VBR
360 /* Exported macro ------------------------------------------------------------*/
361 
369 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
370 
376 #define __HAL_LTDC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
377 
383 #define __HAL_LTDC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
384 
392 #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN)
393 
401 #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN)
402 
408 #define __HAL_LTDC_RELOAD_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
409 
410 /* Interrupt & Flag management */
422 #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
423 
435 #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
436 
448 #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
449 
461 #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
462 
474 #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->ISR & (__INTERRUPT__))
475 
479 /* Include LTDC HAL Extension module */
480 #include "stm32f4xx_hal_ltdc_ex.h"
481 
482 /* Exported functions --------------------------------------------------------*/
489 /* Initialization and de-initialization functions *****************************/
490 HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
491 HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
492 void HAL_LTDC_MspInit(LTDC_HandleTypeDef* hltdc);
493 void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef* hltdc);
494 void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
495 void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc);
496 void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc);
504 /* IO operation functions *****************************************************/
505 void HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
513 /* Peripheral Control functions ***********************************************/
514 HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
515 HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
516 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
517 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
518 HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
519 HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
520 HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
521 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
522 HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
523 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
524 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
525 HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
526 HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
527 HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
528 HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
529 HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
530 HAL_StatusTypeDef HAL_LTDC_Relaod(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType);
531 HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
532 HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
533 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
534 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
535 HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
536 HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
537 HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
538 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
539 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
540 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
541 HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
542 HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
543 
551 /* Peripheral State functions *************************************************/
552 HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
553 uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
561 /* Private types -------------------------------------------------------------*/
570 /* Private variables ---------------------------------------------------------*/
579 /* Private constants ---------------------------------------------------------*/
588 /* Private macros ------------------------------------------------------------*/
592 #define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84U + (0x80U * (__LAYER__)))))
593 #define IS_LTDC_LAYER(LAYER) ((LAYER) <= MAX_LAYER)
594 #define IS_LTDC_HSPOL(HSPOL) (((HSPOL) == LTDC_HSPOLARITY_AL) || \
595  ((HSPOL) == LTDC_HSPOLARITY_AH))
596 #define IS_LTDC_VSPOL(VSPOL) (((VSPOL) == LTDC_VSPOLARITY_AL) || \
597  ((VSPOL) == LTDC_VSPOLARITY_AH))
598 #define IS_LTDC_DEPOL(DEPOL) (((DEPOL) == LTDC_DEPOLARITY_AL) || \
599  ((DEPOL) == LTDC_DEPOLARITY_AH))
600 #define IS_LTDC_PCPOL(PCPOL) (((PCPOL) == LTDC_PCPOLARITY_IPC) || \
601  ((PCPOL) == LTDC_PCPOLARITY_IIPC))
602 #define IS_LTDC_HSYNC(HSYNC) ((HSYNC) <= LTDC_HORIZONTALSYNC)
603 #define IS_LTDC_VSYNC(VSYNC) ((VSYNC) <= LTDC_VERTICALSYNC)
604 #define IS_LTDC_AHBP(AHBP) ((AHBP) <= LTDC_HORIZONTALSYNC)
605 #define IS_LTDC_AVBP(AVBP) ((AVBP) <= LTDC_VERTICALSYNC)
606 #define IS_LTDC_AAW(AAW) ((AAW) <= LTDC_HORIZONTALSYNC)
607 #define IS_LTDC_AAH(AAH) ((AAH) <= LTDC_VERTICALSYNC)
608 #define IS_LTDC_TOTALW(TOTALW) ((TOTALW) <= LTDC_HORIZONTALSYNC)
609 #define IS_LTDC_TOTALH(TOTALH) ((TOTALH) <= LTDC_VERTICALSYNC)
610 #define IS_LTDC_BLUEVALUE(BBLUE) ((BBLUE) <= LTDC_COLOR)
611 #define IS_LTDC_GREENVALUE(BGREEN) ((BGREEN) <= LTDC_COLOR)
612 #define IS_LTDC_REDVALUE(BRED) ((BRED) <= LTDC_COLOR)
613 #define IS_LTDC_BLENDING_FACTOR1(BlendingFactor1) (((BlendingFactor1) == LTDC_BLENDING_FACTOR1_CA) || \
614  ((BlendingFactor1) == LTDC_BLENDING_FACTOR1_PAxCA))
615 #define IS_LTDC_BLENDING_FACTOR2(BlendingFactor2) (((BlendingFactor2) == LTDC_BLENDING_FACTOR2_CA) || \
616  ((BlendingFactor2) == LTDC_BLENDING_FACTOR2_PAxCA))
617 #define IS_LTDC_PIXEL_FORMAT(Pixelformat) (((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB8888) || ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB888) || \
618  ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB565) || ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB1555) || \
619  ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB4444) || ((Pixelformat) == LTDC_PIXEL_FORMAT_L8) || \
620  ((Pixelformat) == LTDC_PIXEL_FORMAT_AL44) || ((Pixelformat) == LTDC_PIXEL_FORMAT_AL88))
621 #define IS_LTDC_ALPHA(ALPHA) ((ALPHA) <= LTDC_ALPHA)
622 #define IS_LTDC_HCONFIGST(HCONFIGST) ((HCONFIGST) <= LTDC_STARTPOSITION)
623 #define IS_LTDC_HCONFIGSP(HCONFIGSP) ((HCONFIGSP) <= LTDC_STOPPOSITION)
624 #define IS_LTDC_VCONFIGST(VCONFIGST) ((VCONFIGST) <= LTDC_STARTPOSITION)
625 #define IS_LTDC_VCONFIGSP(VCONFIGSP) ((VCONFIGSP) <= LTDC_STOPPOSITION)
626 #define IS_LTDC_CFBP(CFBP) ((CFBP) <= LTDC_COLOR_FRAME_BUFFER)
627 #define IS_LTDC_CFBLL(CFBLL) ((CFBLL) <= LTDC_COLOR_FRAME_BUFFER)
628 #define IS_LTDC_CFBLNBR(CFBLNBR) ((CFBLNBR) <= LTDC_LINE_NUMBER)
629 #define IS_LTDC_LIPOS(LIPOS) ((LIPOS) <= 0x7FFU)
630 #define IS_LTDC_RELAOD(RELOADTYPE) (((RELOADTYPE) == LTDC_RELOAD_IMMEDIATE) || ((RELOADTYPE) == LTDC_SRCR_VBR))
631 
635 /* Private functions ---------------------------------------------------------*/
652 #endif /* STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
653 
654 #ifdef __cplusplus
655 }
656 #endif
657 
658 #endif /* __STM32F4xx_HAL_LTDC_H */
659 
660 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
LTDC_TypeDef
LCD-TFT Display Controller.
Definition: stm32f429xx.h:653
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57
__IO
#define __IO
Definition: core_cm0.h:213
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f4xx_hal_def.h:68
stm32f4xx_hal_ltdc_ex.h
Header file of LTDC HAL Extension module.