stm32h7xx_hal_ltdc.h 30 KB

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