训练营PLSR题目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

720 lines
32 KiB

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