STM32F769IDiscovery  1.00
uDANTE Audio Networking with STM32F7 DISCO board
stm32f7xx_hal_ltdc.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F7xx_HAL_LTDC_H
40 #define __STM32F7xx_HAL_LTDC_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 #if defined (STM32F746xx) || defined (STM32F756xx) || defined (STM32F767xx) || defined (STM32F769xx) || defined (STM32F777xx) || defined (STM32F779xx)
47 
48 /* Includes ------------------------------------------------------------------*/
49 #include "stm32f7xx_hal_def.h"
50 
51 
61 /* Exported types ------------------------------------------------------------*/
65 #define MAX_LAYER 2
66 
70 typedef struct
71 {
72  uint8_t Blue;
75  uint8_t Green;
78  uint8_t Red;
81  uint8_t Reserved;
82 } LTDC_ColorTypeDef;
83 
87 typedef struct
88 {
89  uint32_t HSPolarity;
92  uint32_t VSPolarity;
95  uint32_t DEPolarity;
98  uint32_t PCPolarity;
101  uint32_t HorizontalSync;
104  uint32_t VerticalSync;
107  uint32_t AccumulatedHBP;
110  uint32_t AccumulatedVBP;
113  uint32_t AccumulatedActiveW;
116  uint32_t AccumulatedActiveH;
119  uint32_t TotalWidth;
122  uint32_t TotalHeigh;
125  LTDC_ColorTypeDef Backcolor;
126 } LTDC_InitTypeDef;
127 
131 typedef struct
132 {
133  uint32_t WindowX0;
136  uint32_t WindowX1;
139  uint32_t WindowY0;
142  uint32_t WindowY1;
145  uint32_t PixelFormat;
148  uint32_t Alpha;
151  uint32_t Alpha0;
154  uint32_t BlendingFactor1;
157  uint32_t BlendingFactor2;
160  uint32_t FBStartAdress;
162  uint32_t ImageWidth;
165  uint32_t ImageHeight;
168  LTDC_ColorTypeDef Backcolor;
169 } LTDC_LayerCfgTypeDef;
170 
174 typedef enum
175 {
176  HAL_LTDC_STATE_RESET = 0x00U,
177  HAL_LTDC_STATE_READY = 0x01U,
178  HAL_LTDC_STATE_BUSY = 0x02U,
179  HAL_LTDC_STATE_TIMEOUT = 0x03U,
180  HAL_LTDC_STATE_ERROR = 0x04U
181 }HAL_LTDC_StateTypeDef;
182 
186 typedef struct
187 {
188  LTDC_TypeDef *Instance;
190  LTDC_InitTypeDef Init;
192  LTDC_LayerCfgTypeDef LayerCfg[MAX_LAYER];
194  HAL_LockTypeDef Lock;
196  __IO HAL_LTDC_StateTypeDef State;
198  __IO uint32_t ErrorCode;
200 } LTDC_HandleTypeDef;
205 /* Exported constants --------------------------------------------------------*/
213 #define HAL_LTDC_ERROR_NONE ((uint32_t)0x00000000U)
214 #define HAL_LTDC_ERROR_TE ((uint32_t)0x00000001U)
215 #define HAL_LTDC_ERROR_FU ((uint32_t)0x00000002U)
216 #define HAL_LTDC_ERROR_TIMEOUT ((uint32_t)0x00000020U)
224 #define LTDC_HSPOLARITY_AL ((uint32_t)0x00000000U)
225 #define LTDC_HSPOLARITY_AH LTDC_GCR_HSPOL
233 #define LTDC_VSPOLARITY_AL ((uint32_t)0x00000000U)
234 #define LTDC_VSPOLARITY_AH LTDC_GCR_VSPOL
242 #define LTDC_DEPOLARITY_AL ((uint32_t)0x00000000U)
243 #define LTDC_DEPOLARITY_AH LTDC_GCR_DEPOL
251 #define LTDC_PCPOLARITY_IPC ((uint32_t)0x00000000U)
252 #define LTDC_PCPOLARITY_IIPC LTDC_GCR_PCPOL
260 #define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16)
261 #define LTDC_VERTICALSYNC LTDC_SSCR_VSH
269 #define LTDC_COLOR ((uint32_t)0x000000FFU)
277 #define LTDC_BLENDING_FACTOR1_CA ((uint32_t)0x00000400U)
278 #define LTDC_BLENDING_FACTOR1_PAxCA ((uint32_t)0x00000600U)
286 #define LTDC_BLENDING_FACTOR2_CA ((uint32_t)0x00000005U)
287 #define LTDC_BLENDING_FACTOR2_PAxCA ((uint32_t)0x00000007U)
295 #define LTDC_PIXEL_FORMAT_ARGB8888 ((uint32_t)0x00000000U)
296 #define LTDC_PIXEL_FORMAT_RGB888 ((uint32_t)0x00000001U)
297 #define LTDC_PIXEL_FORMAT_RGB565 ((uint32_t)0x00000002U)
298 #define LTDC_PIXEL_FORMAT_ARGB1555 ((uint32_t)0x00000003U)
299 #define LTDC_PIXEL_FORMAT_ARGB4444 ((uint32_t)0x00000004U)
300 #define LTDC_PIXEL_FORMAT_L8 ((uint32_t)0x00000005U)
301 #define LTDC_PIXEL_FORMAT_AL44 ((uint32_t)0x00000006U)
302 #define LTDC_PIXEL_FORMAT_AL88 ((uint32_t)0x00000007U)
310 #define LTDC_ALPHA LTDC_LxCACR_CONSTA
318 #define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16)
319 #define LTDC_STARTPOSITION LTDC_LxWHPCR_WHSTPOS
321 #define LTDC_COLOR_FRAME_BUFFER LTDC_LxCFBLR_CFBLL
322 #define LTDC_LINE_NUMBER LTDC_LxCFBLNR_CFBLNBR
330 #define LTDC_IT_LI LTDC_IER_LIE
331 #define LTDC_IT_FU LTDC_IER_FUIE
332 #define LTDC_IT_TE LTDC_IER_TERRIE
333 #define LTDC_IT_RR LTDC_IER_RRIE
334 
341 #define LTDC_FLAG_LI LTDC_ISR_LIF
342 #define LTDC_FLAG_FU LTDC_ISR_FUIF
343 #define LTDC_FLAG_TE LTDC_ISR_TERRIF
344 #define LTDC_FLAG_RR LTDC_ISR_RRIF
345 
352 #define LTDC_RELOAD_IMMEDIATE LTDC_SRCR_IMR
353 #define LTDC_RELOAD_VERTICAL_BLANKING LTDC_SRCR_VBR
362 /* Exported macro ------------------------------------------------------------*/
363 
371 #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
372 
378 #define __HAL_LTDC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
379 
385 #define __HAL_LTDC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
386 
394 #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN)
395 
403 #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN)
404 
410 #define __HAL_LTDC_RELOAD_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
411 
412 /* Interrupt & Flag management */
424 #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
425 
437 #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
438 
450 #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
451 
463 #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
464 
476 #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->ISR & (__INTERRUPT__))
477 
481 #if defined (STM32F769xx) || defined (STM32F779xx)
482 /* Include LTDC HAL Extension module */
483 #include "stm32f7xx_hal_ltdc_ex.h"
484 #endif /* STM32F769xx) | STM32F779xx */
485 
486 /* Exported functions --------------------------------------------------------*/
493 /* Initialization and de-initialization functions *****************************/
494 HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
495 HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
496 void HAL_LTDC_MspInit(LTDC_HandleTypeDef* hltdc);
497 void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef* hltdc);
498 void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
499 void HAL_LTDC_LineEvenCallback(LTDC_HandleTypeDef *hltdc);
500 void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc);
508 /* IO operation functions *****************************************************/
509 void HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
517 /* Peripheral Control functions ***********************************************/
518 HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
519 HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
520 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
521 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
522 HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
523 HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
524 HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
525 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
526 HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
527 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
528 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
529 HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
530 HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
531 HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
532 HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
533 HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
534 HAL_StatusTypeDef HAL_LTDC_Reload(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType);
535 HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
536 HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
537 HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
538 HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
539 HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
540 HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
541 HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
542 HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
543 HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
544 HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
545 HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
546 HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
547 
555 /* Peripheral State functions *************************************************/
556 HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
557 uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
565 /* Private types -------------------------------------------------------------*/
574 /* Private variables ---------------------------------------------------------*/
583 /* Private constants ---------------------------------------------------------*/
592 /* Private macros ------------------------------------------------------------*/
596 #define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84 + (0x80*(__LAYER__)))))
597 #define IS_LTDC_LAYER(LAYER) ((LAYER) <= MAX_LAYER)
598 #define IS_LTDC_HSPOL(HSPOL) (((HSPOL) == LTDC_HSPOLARITY_AL) || \
599  ((HSPOL) == LTDC_HSPOLARITY_AH))
600 #define IS_LTDC_VSPOL(VSPOL) (((VSPOL) == LTDC_VSPOLARITY_AL) || \
601  ((VSPOL) == LTDC_VSPOLARITY_AH))
602 #define IS_LTDC_DEPOL(DEPOL) (((DEPOL) == LTDC_DEPOLARITY_AL) || \
603  ((DEPOL) == LTDC_DEPOLARITY_AH))
604 #define IS_LTDC_PCPOL(PCPOL) (((PCPOL) == LTDC_PCPOLARITY_IPC) || \
605  ((PCPOL) == LTDC_PCPOLARITY_IIPC))
606 #define IS_LTDC_HSYNC(HSYNC) ((HSYNC) <= LTDC_HORIZONTALSYNC)
607 #define IS_LTDC_VSYNC(VSYNC) ((VSYNC) <= LTDC_VERTICALSYNC)
608 #define IS_LTDC_AHBP(AHBP) ((AHBP) <= LTDC_HORIZONTALSYNC)
609 #define IS_LTDC_AVBP(AVBP) ((AVBP) <= LTDC_VERTICALSYNC)
610 #define IS_LTDC_AAW(AAW) ((AAW) <= LTDC_HORIZONTALSYNC)
611 #define IS_LTDC_AAH(AAH) ((AAH) <= LTDC_VERTICALSYNC)
612 #define IS_LTDC_TOTALW(TOTALW) ((TOTALW) <= LTDC_HORIZONTALSYNC)
613 #define IS_LTDC_TOTALH(TOTALH) ((TOTALH) <= LTDC_VERTICALSYNC)
614 #define IS_LTDC_BLUEVALUE(BBLUE) ((BBLUE) <= LTDC_COLOR)
615 #define IS_LTDC_GREENVALUE(BGREEN) ((BGREEN) <= LTDC_COLOR)
616 #define IS_LTDC_REDVALUE(BRED) ((BRED) <= LTDC_COLOR)
617 #define IS_LTDC_BLENDING_FACTOR1(BlendingFactor1) (((BlendingFactor1) == LTDC_BLENDING_FACTOR1_CA) || \
618  ((BlendingFactor1) == LTDC_BLENDING_FACTOR1_PAxCA))
619 #define IS_LTDC_BLENDING_FACTOR2(BlendingFactor2) (((BlendingFactor2) == LTDC_BLENDING_FACTOR2_CA) || \
620  ((BlendingFactor2) == LTDC_BLENDING_FACTOR2_PAxCA))
621 #define IS_LTDC_PIXEL_FORMAT(Pixelformat) (((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB8888) || ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB888) || \
622  ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB565) || ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB1555) || \
623  ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB4444) || ((Pixelformat) == LTDC_PIXEL_FORMAT_L8) || \
624  ((Pixelformat) == LTDC_PIXEL_FORMAT_AL44) || ((Pixelformat) == LTDC_PIXEL_FORMAT_AL88))
625 #define IS_LTDC_ALPHA(ALPHA) ((ALPHA) <= LTDC_ALPHA)
626 #define IS_LTDC_HCONFIGST(HCONFIGST) ((HCONFIGST) <= LTDC_STARTPOSITION)
627 #define IS_LTDC_HCONFIGSP(HCONFIGSP) ((HCONFIGSP) <= LTDC_STOPPOSITION)
628 #define IS_LTDC_VCONFIGST(VCONFIGST) ((VCONFIGST) <= LTDC_STARTPOSITION)
629 #define IS_LTDC_VCONFIGSP(VCONFIGSP) ((VCONFIGSP) <= LTDC_STOPPOSITION)
630 #define IS_LTDC_CFBP(CFBP) ((CFBP) <= LTDC_COLOR_FRAME_BUFFER)
631 #define IS_LTDC_CFBLL(CFBLL) ((CFBLL) <= LTDC_COLOR_FRAME_BUFFER)
632 #define IS_LTDC_CFBLNBR(CFBLNBR) ((CFBLNBR) <= LTDC_LINE_NUMBER)
633 #define IS_LTDC_LIPOS(LIPOS) ((LIPOS) <= 0x7FF)
634 #define IS_LTDC_RELAOD(RELOADTYPE) (((RELOADTYPE) == LTDC_RELOAD_IMMEDIATE) || ((RELOADTYPE) == LTDC_SRCR_VBR))
635 
639 /* Private functions ---------------------------------------------------------*/
651 #endif /* STM32F746xx || STM32F756xx || STM32F767xx || STM32F769xx || STM32F777xx || STM32F779xx */
652 
656 #ifdef __cplusplus
657 }
658 #endif
659 
660 #endif /* __STM32F7xx_HAL_LTDC_H */
661 
662 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
LTDC_TypeDef
LCD-TFT Display Controller.
Definition: stm32f746xx.h:661
__I2C_HandleTypeDef::ErrorCode
__IO uint32_t ErrorCode
Definition: stm32f7xx_hal_i2c.h:230
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f7xx_hal_def.h:67
__IO
#define __IO
Definition: core_cm0.h:213
HAL_LTDC_LineEvenCallback
void HAL_LTDC_LineEvenCallback(LTDC_HandleTypeDef *hltdc_eval)
Line Event callback.
Definition: LCDConf.c:738
__I2C_HandleTypeDef::Instance
I2C_TypeDef * Instance
Definition: stm32f7xx_hal_i2c.h:203
__I2C_HandleTypeDef::Lock
HAL_LockTypeDef Lock
Definition: stm32f7xx_hal_i2c.h:224
stm32f7xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
__I2C_HandleTypeDef::State
__IO HAL_I2C_StateTypeDef State
Definition: stm32f7xx_hal_i2c.h:226
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f7xx_hal_def.h:56
stm32f7xx_hal_ltdc_ex.h
Header file of LTDC HAL Extension module.
__I2C_HandleTypeDef::Init
I2C_InitTypeDef Init
Definition: stm32f7xx_hal_i2c.h:205
Generated by   doxygen 1.8.11