stm32f4xx_hal_ltdc.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_ltdc.h
  4. * @author MCD Application Team
  5. * @version V1.4.3
  6. * @date 11-December-2015
  7. * @brief Header file of LTDC HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32F4xx_HAL_LTDC_H
  39. #define __STM32F4xx_HAL_LTDC_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. #if defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F469xx) || defined(STM32F479xx)
  44. /* Includes ------------------------------------------------------------------*/
  45. #include "stm32f4xx_hal_def.h"
  46. /** @addtogroup STM32F4xx_HAL_Driver
  47. * @{
  48. */
  49. /** @defgroup LTDC LTDC
  50. * @brief LTDC HAL module driver
  51. * @{
  52. */
  53. /* Exported types ------------------------------------------------------------*/
  54. /** @defgroup LTDC_Exported_Types LTDC Exported Types
  55. * @{
  56. */
  57. #define MAX_LAYER 2
  58. /**
  59. * @brief LTDC color structure definition
  60. */
  61. typedef struct
  62. {
  63. uint8_t Blue; /*!< Configures the blue value.
  64. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  65. uint8_t Green; /*!< Configures the green value.
  66. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  67. uint8_t Red; /*!< Configures the red value.
  68. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  69. uint8_t Reserved; /*!< Reserved 0xFF */
  70. } LTDC_ColorTypeDef;
  71. /**
  72. * @brief LTDC Init structure definition
  73. */
  74. typedef struct
  75. {
  76. uint32_t HSPolarity; /*!< configures the horizontal synchronization polarity.
  77. This parameter can be one value of @ref LTDC_HS_POLARITY */
  78. uint32_t VSPolarity; /*!< configures the vertical synchronization polarity.
  79. This parameter can be one value of @ref LTDC_VS_POLARITY */
  80. uint32_t DEPolarity; /*!< configures the data enable polarity.
  81. This parameter can be one of value of @ref LTDC_DE_POLARITY */
  82. uint32_t PCPolarity; /*!< configures the pixel clock polarity.
  83. This parameter can be one of value of @ref LTDC_PC_POLARITY */
  84. uint32_t HorizontalSync; /*!< configures the number of Horizontal synchronization width.
  85. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
  86. uint32_t VerticalSync; /*!< configures the number of Vertical synchronization height.
  87. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */
  88. uint32_t AccumulatedHBP; /*!< configures the accumulated horizontal back porch width.
  89. This parameter must be a number between Min_Data = LTDC_HorizontalSync and Max_Data = 0xFFF. */
  90. uint32_t AccumulatedVBP; /*!< configures the accumulated vertical back porch height.
  91. This parameter must be a number between Min_Data = LTDC_VerticalSync and Max_Data = 0x7FF. */
  92. uint32_t AccumulatedActiveW; /*!< configures the accumulated active width.
  93. This parameter must be a number between Min_Data = LTDC_AccumulatedHBP and Max_Data = 0xFFF. */
  94. uint32_t AccumulatedActiveH; /*!< configures the accumulated active height.
  95. This parameter must be a number between Min_Data = LTDC_AccumulatedVBP and Max_Data = 0x7FF. */
  96. uint32_t TotalWidth; /*!< configures the total width.
  97. This parameter must be a number between Min_Data = LTDC_AccumulatedActiveW and Max_Data = 0xFFF. */
  98. uint32_t TotalHeigh; /*!< configures the total height.
  99. This parameter must be a number between Min_Data = LTDC_AccumulatedActiveH and Max_Data = 0x7FF. */
  100. LTDC_ColorTypeDef Backcolor; /*!< Configures the background color. */
  101. } LTDC_InitTypeDef;
  102. /**
  103. * @brief LTDC Layer structure definition
  104. */
  105. typedef struct
  106. {
  107. uint32_t WindowX0; /*!< Configures the Window Horizontal Start Position.
  108. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
  109. uint32_t WindowX1; /*!< Configures the Window Horizontal Stop Position.
  110. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
  111. uint32_t WindowY0; /*!< Configures the Window vertical Start Position.
  112. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0xFFF. */
  113. uint32_t WindowY1; /*!< Configures the Window vertical Stop Position.
  114. This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0xFFFF. */
  115. uint32_t PixelFormat; /*!< Specifies the pixel format.
  116. This parameter can be one of value of @ref LTDC_Pixelformat */
  117. uint32_t Alpha; /*!< Specifies the constant alpha used for blending.
  118. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  119. uint32_t Alpha0; /*!< Configures the default alpha value.
  120. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFF. */
  121. uint32_t BlendingFactor1; /*!< Select the blending factor 1.
  122. This parameter can be one of value of @ref LTDC_BlendingFactor1 */
  123. uint32_t BlendingFactor2; /*!< Select the blending factor 2.
  124. This parameter can be one of value of @ref LTDC_BlendingFactor2 */
  125. uint32_t FBStartAdress; /*!< Configures the color frame buffer address */
  126. uint32_t ImageWidth; /*!< Configures the color frame buffer line length.
  127. This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x1FFF. */
  128. uint32_t ImageHeight; /*!< Specifies the number of line in frame buffer.
  129. This parameter must be a number between Min_Data = 0x000 and Max_Data = 0x7FF. */
  130. LTDC_ColorTypeDef Backcolor; /*!< Configures the layer background color. */
  131. } LTDC_LayerCfgTypeDef;
  132. /**
  133. * @brief HAL LTDC State structures definition
  134. */
  135. typedef enum
  136. {
  137. HAL_LTDC_STATE_RESET = 0x00, /*!< LTDC not yet initialized or disabled */
  138. HAL_LTDC_STATE_READY = 0x01, /*!< LTDC initialized and ready for use */
  139. HAL_LTDC_STATE_BUSY = 0x02, /*!< LTDC internal process is ongoing */
  140. HAL_LTDC_STATE_TIMEOUT = 0x03, /*!< LTDC Timeout state */
  141. HAL_LTDC_STATE_ERROR = 0x04 /*!< LTDC state error */
  142. }HAL_LTDC_StateTypeDef;
  143. /**
  144. * @brief LTDC handle Structure definition
  145. */
  146. typedef struct
  147. {
  148. LTDC_TypeDef *Instance; /*!< LTDC Register base address */
  149. LTDC_InitTypeDef Init; /*!< LTDC parameters */
  150. LTDC_LayerCfgTypeDef LayerCfg[MAX_LAYER]; /*!< LTDC Layers parameters */
  151. HAL_LockTypeDef Lock; /*!< LTDC Lock */
  152. __IO HAL_LTDC_StateTypeDef State; /*!< LTDC state */
  153. __IO uint32_t ErrorCode; /*!< LTDC Error code */
  154. } LTDC_HandleTypeDef;
  155. /**
  156. * @}
  157. */
  158. /* Exported constants --------------------------------------------------------*/
  159. /** @defgroup LTDC_Exported_Constants LTDC Exported Constants
  160. * @{
  161. */
  162. /** @defgroup LTDC_Error_Code LTDC Error Code
  163. * @{
  164. */
  165. #define HAL_LTDC_ERROR_NONE ((uint32_t)0x00000000) /*!< LTDC No error */
  166. #define HAL_LTDC_ERROR_TE ((uint32_t)0x00000001) /*!< LTDC Transfer error */
  167. #define HAL_LTDC_ERROR_FU ((uint32_t)0x00000002) /*!< LTDC FIFO Underrun */
  168. #define HAL_LTDC_ERROR_TIMEOUT ((uint32_t)0x00000020) /*!< LTDC Timeout error */
  169. /**
  170. * @}
  171. */
  172. /** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY
  173. * @{
  174. */
  175. #define LTDC_HSPOLARITY_AL ((uint32_t)0x00000000) /*!< Horizontal Synchronization is active low. */
  176. #define LTDC_HSPOLARITY_AH LTDC_GCR_HSPOL /*!< Horizontal Synchronization is active high. */
  177. /**
  178. * @}
  179. */
  180. /** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY
  181. * @{
  182. */
  183. #define LTDC_VSPOLARITY_AL ((uint32_t)0x00000000) /*!< Vertical Synchronization is active low. */
  184. #define LTDC_VSPOLARITY_AH LTDC_GCR_VSPOL /*!< Vertical Synchronization is active high. */
  185. /**
  186. * @}
  187. */
  188. /** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY
  189. * @{
  190. */
  191. #define LTDC_DEPOLARITY_AL ((uint32_t)0x00000000) /*!< Data Enable, is active low. */
  192. #define LTDC_DEPOLARITY_AH LTDC_GCR_DEPOL /*!< Data Enable, is active high. */
  193. /**
  194. * @}
  195. */
  196. /** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY
  197. * @{
  198. */
  199. #define LTDC_PCPOLARITY_IPC ((uint32_t)0x00000000) /*!< input pixel clock. */
  200. #define LTDC_PCPOLARITY_IIPC LTDC_GCR_PCPOL /*!< inverted input pixel clock. */
  201. /**
  202. * @}
  203. */
  204. /** @defgroup LTDC_SYNC LTDC SYNC
  205. * @{
  206. */
  207. #define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16) /*!< Horizontal synchronization width. */
  208. #define LTDC_VERTICALSYNC LTDC_SSCR_VSH /*!< Vertical synchronization height. */
  209. /**
  210. * @}
  211. */
  212. /** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR
  213. * @{
  214. */
  215. #define LTDC_COLOR ((uint32_t)0x000000FF) /*!< Color mask */
  216. /**
  217. * @}
  218. */
  219. /** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1
  220. * @{
  221. */
  222. #define LTDC_BLENDING_FACTOR1_CA ((uint32_t)0x00000400) /*!< Blending factor : Cte Alpha */
  223. #define LTDC_BLENDING_FACTOR1_PAxCA ((uint32_t)0x00000600) /*!< Blending factor : Cte Alpha x Pixel Alpha*/
  224. /**
  225. * @}
  226. */
  227. /** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2
  228. * @{
  229. */
  230. #define LTDC_BLENDING_FACTOR2_CA ((uint32_t)0x00000005) /*!< Blending factor : Cte Alpha */
  231. #define LTDC_BLENDING_FACTOR2_PAxCA ((uint32_t)0x00000007) /*!< Blending factor : Cte Alpha x Pixel Alpha*/
  232. /**
  233. * @}
  234. */
  235. /** @defgroup LTDC_Pixelformat LTDC Pixel format
  236. * @{
  237. */
  238. #define LTDC_PIXEL_FORMAT_ARGB8888 ((uint32_t)0x00000000) /*!< ARGB8888 LTDC pixel format */
  239. #define LTDC_PIXEL_FORMAT_RGB888 ((uint32_t)0x00000001) /*!< RGB888 LTDC pixel format */
  240. #define LTDC_PIXEL_FORMAT_RGB565 ((uint32_t)0x00000002) /*!< RGB565 LTDC pixel format */
  241. #define LTDC_PIXEL_FORMAT_ARGB1555 ((uint32_t)0x00000003) /*!< ARGB1555 LTDC pixel format */
  242. #define LTDC_PIXEL_FORMAT_ARGB4444 ((uint32_t)0x00000004) /*!< ARGB4444 LTDC pixel format */
  243. #define LTDC_PIXEL_FORMAT_L8 ((uint32_t)0x00000005) /*!< L8 LTDC pixel format */
  244. #define LTDC_PIXEL_FORMAT_AL44 ((uint32_t)0x00000006) /*!< AL44 LTDC pixel format */
  245. #define LTDC_PIXEL_FORMAT_AL88 ((uint32_t)0x00000007) /*!< AL88 LTDC pixel format */
  246. /**
  247. * @}
  248. */
  249. /** @defgroup LTDC_Alpha LTDC Alpha
  250. * @{
  251. */
  252. #define LTDC_ALPHA LTDC_LxCACR_CONSTA /*!< LTDC Cte Alpha mask */
  253. /**
  254. * @}
  255. */
  256. /** @defgroup LTDC_LAYER_Config LTDC LAYER Config
  257. * @{
  258. */
  259. #define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16) /*!< LTDC Layer stop position */
  260. #define LTDC_STARTPOSITION LTDC_LxWHPCR_WHSTPOS /*!< LTDC Layer start position */
  261. #define LTDC_COLOR_FRAME_BUFFER LTDC_LxCFBLR_CFBLL /*!< LTDC Layer Line length */
  262. #define LTDC_LINE_NUMBER LTDC_LxCFBLNR_CFBLNBR /*!< LTDC Layer Line number */
  263. /**
  264. * @}
  265. */
  266. /** @defgroup LTDC_Interrupts LTDC Interrupts
  267. * @{
  268. */
  269. #define LTDC_IT_LI LTDC_IER_LIE
  270. #define LTDC_IT_FU LTDC_IER_FUIE
  271. #define LTDC_IT_TE LTDC_IER_TERRIE
  272. #define LTDC_IT_RR LTDC_IER_RRIE
  273. /**
  274. * @}
  275. */
  276. /** @defgroup LTDC_Flag LTDC Flag
  277. * @{
  278. */
  279. #define LTDC_FLAG_LI LTDC_ISR_LIF
  280. #define LTDC_FLAG_FU LTDC_ISR_FUIF
  281. #define LTDC_FLAG_TE LTDC_ISR_TERRIF
  282. #define LTDC_FLAG_RR LTDC_ISR_RRIF
  283. /**
  284. * @}
  285. */
  286. /**
  287. * @}
  288. */
  289. /* Exported macro ------------------------------------------------------------*/
  290. /** @defgroup LTDC_Exported_Macros LTDC Exported Macros
  291. * @{
  292. */
  293. /** @brief Reset LTDC handle state
  294. * @param __HANDLE__: specifies the LTDC handle.
  295. * @retval None
  296. */
  297. #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
  298. /**
  299. * @brief Enable the LTDC.
  300. * @param __HANDLE__: LTDC handle
  301. * @retval None.
  302. */
  303. #define __HAL_LTDC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
  304. /**
  305. * @brief Disable the LTDC.
  306. * @param __HANDLE__: LTDC handle
  307. * @retval None.
  308. */
  309. #define __HAL_LTDC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
  310. /**
  311. * @brief Enable the LTDC Layer.
  312. * @param __HANDLE__: LTDC handle
  313. * @param __LAYER__: Specify the layer to be enabled
  314. * This parameter can be 0 or 1
  315. * @retval None.
  316. */
  317. #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN)
  318. /**
  319. * @brief Disable the LTDC Layer.
  320. * @param __HANDLE__: LTDC handle
  321. * @param __LAYER__: Specify the layer to be disabled
  322. * This parameter can be 0 or 1
  323. * @retval None.
  324. */
  325. #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN)
  326. /**
  327. * @brief Reload Layer Configuration.
  328. * @param __HANDLE__: LTDC handle
  329. * @retval None.
  330. */
  331. #define __HAL_LTDC_RELOAD_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
  332. /* Interrupt & Flag management */
  333. /**
  334. * @brief Get the LTDC pending flags.
  335. * @param __HANDLE__: LTDC handle
  336. * @param __FLAG__: Get the specified flag.
  337. * This parameter can be any combination of the following values:
  338. * @arg LTDC_FLAG_LI: Line Interrupt flag
  339. * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  340. * @arg LTDC_FLAG_TE: Transfer Error interrupt flag
  341. * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
  342. * @retval The state of FLAG (SET or RESET).
  343. */
  344. #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
  345. /**
  346. * @brief Clears the LTDC pending flags.
  347. * @param __HANDLE__: LTDC handle
  348. * @param __FLAG__: specifies the flag to clear.
  349. * This parameter can be any combination of the following values:
  350. * @arg LTDC_FLAG_LI: Line Interrupt flag
  351. * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  352. * @arg LTDC_FLAG_TE: Transfer Error interrupt flag
  353. * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
  354. * @retval None
  355. */
  356. #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  357. /**
  358. * @brief Enables the specified LTDC interrupts.
  359. * @param __HANDLE__: LTDC handle
  360. * @param __INTERRUPT__: specifies the LTDC interrupt sources to be enabled.
  361. * This parameter can be any combination of the following values:
  362. * @arg LTDC_IT_LI: Line Interrupt flag
  363. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  364. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  365. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  366. * @retval None
  367. */
  368. #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  369. /**
  370. * @brief Disables the specified LTDC interrupts.
  371. * @param __HANDLE__: LTDC handle
  372. * @param __INTERRUPT__: specifies the LTDC interrupt sources to be disabled.
  373. * This parameter can be any combination of the following values:
  374. * @arg LTDC_IT_LI: Line Interrupt flag
  375. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  376. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  377. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  378. * @retval None
  379. */
  380. #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
  381. /**
  382. * @brief Checks whether the specified LTDC interrupt has occurred or not.
  383. * @param __HANDLE__: LTDC handle
  384. * @param __INTERRUPT__: specifies the LTDC interrupt source to check.
  385. * This parameter can be one of the following values:
  386. * @arg LTDC_IT_LI: Line Interrupt flag
  387. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  388. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  389. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  390. * @retval The state of INTERRUPT (SET or RESET).
  391. */
  392. #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->ISR & (__INTERRUPT__))
  393. /**
  394. * @}
  395. */
  396. /* Include LTDC HAL Extension module */
  397. #include "stm32f4xx_hal_ltdc_ex.h"
  398. /* Exported functions --------------------------------------------------------*/
  399. /** @addtogroup LTDC_Exported_Functions
  400. * @{
  401. */
  402. /** @addtogroup LTDC_Exported_Functions_Group1
  403. * @{
  404. */
  405. /* Initialization and de-initialization functions *****************************/
  406. HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
  407. HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
  408. void HAL_LTDC_MspInit(LTDC_HandleTypeDef* hltdc);
  409. void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef* hltdc);
  410. void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
  411. void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc);
  412. /**
  413. * @}
  414. */
  415. /** @addtogroup LTDC_Exported_Functions_Group2
  416. * @{
  417. */
  418. /* IO operation functions *****************************************************/
  419. void HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
  420. /**
  421. * @}
  422. */
  423. /** @addtogroup LTDC_Exported_Functions_Group3
  424. * @{
  425. */
  426. /* Peripheral Control functions ***********************************************/
  427. HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
  428. HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
  429. HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
  430. HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
  431. HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
  432. HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
  433. HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
  434. HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
  435. HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
  436. HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  437. HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  438. HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  439. HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  440. HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
  441. HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
  442. HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
  443. /**
  444. * @}
  445. */
  446. /** @addtogroup LTDC_Exported_Functions_Group4
  447. * @{
  448. */
  449. /* Peripheral State functions *************************************************/
  450. HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
  451. uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
  452. /**
  453. * @}
  454. */
  455. /**
  456. * @}
  457. */
  458. /* Private types -------------------------------------------------------------*/
  459. /** @defgroup LTDC_Private_Types LTDC Private Types
  460. * @{
  461. */
  462. /**
  463. * @}
  464. */
  465. /* Private variables ---------------------------------------------------------*/
  466. /** @defgroup LTDC_Private_Variables LTDC Private Variables
  467. * @{
  468. */
  469. /**
  470. * @}
  471. */
  472. /* Private constants ---------------------------------------------------------*/
  473. /** @defgroup LTDC_Private_Constants LTDC Private Constants
  474. * @{
  475. */
  476. /**
  477. * @}
  478. */
  479. /* Private macros ------------------------------------------------------------*/
  480. /** @defgroup LTDC_Private_Macros LTDC Private Macros
  481. * @{
  482. */
  483. #define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84 + (0x80*(__LAYER__)))))
  484. #define IS_LTDC_LAYER(LAYER) ((LAYER) <= MAX_LAYER)
  485. #define IS_LTDC_HSPOL(HSPOL) (((HSPOL) == LTDC_HSPOLARITY_AL) || \
  486. ((HSPOL) == LTDC_HSPOLARITY_AH))
  487. #define IS_LTDC_VSPOL(VSPOL) (((VSPOL) == LTDC_VSPOLARITY_AL) || \
  488. ((VSPOL) == LTDC_VSPOLARITY_AH))
  489. #define IS_LTDC_DEPOL(DEPOL) (((DEPOL) == LTDC_DEPOLARITY_AL) || \
  490. ((DEPOL) == LTDC_DEPOLARITY_AH))
  491. #define IS_LTDC_PCPOL(PCPOL) (((PCPOL) == LTDC_PCPOLARITY_IPC) || \
  492. ((PCPOL) == LTDC_PCPOLARITY_IIPC))
  493. #define IS_LTDC_HSYNC(HSYNC) ((HSYNC) <= LTDC_HORIZONTALSYNC)
  494. #define IS_LTDC_VSYNC(VSYNC) ((VSYNC) <= LTDC_VERTICALSYNC)
  495. #define IS_LTDC_AHBP(AHBP) ((AHBP) <= LTDC_HORIZONTALSYNC)
  496. #define IS_LTDC_AVBP(AVBP) ((AVBP) <= LTDC_VERTICALSYNC)
  497. #define IS_LTDC_AAW(AAW) ((AAW) <= LTDC_HORIZONTALSYNC)
  498. #define IS_LTDC_AAH(AAH) ((AAH) <= LTDC_VERTICALSYNC)
  499. #define IS_LTDC_TOTALW(TOTALW) ((TOTALW) <= LTDC_HORIZONTALSYNC)
  500. #define IS_LTDC_TOTALH(TOTALH) ((TOTALH) <= LTDC_VERTICALSYNC)
  501. #define IS_LTDC_BLUEVALUE(BBLUE) ((BBLUE) <= LTDC_COLOR)
  502. #define IS_LTDC_GREENVALUE(BGREEN) ((BGREEN) <= LTDC_COLOR)
  503. #define IS_LTDC_REDVALUE(BRED) ((BRED) <= LTDC_COLOR)
  504. #define IS_LTDC_BLENDING_FACTOR1(BlendingFactor1) (((BlendingFactor1) == LTDC_BLENDING_FACTOR1_CA) || \
  505. ((BlendingFactor1) == LTDC_BLENDING_FACTOR1_PAxCA))
  506. #define IS_LTDC_BLENDING_FACTOR2(BlendingFactor2) (((BlendingFactor2) == LTDC_BLENDING_FACTOR2_CA) || \
  507. ((BlendingFactor2) == LTDC_BLENDING_FACTOR2_PAxCA))
  508. #define IS_LTDC_PIXEL_FORMAT(Pixelformat) (((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB8888) || ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB888) || \
  509. ((Pixelformat) == LTDC_PIXEL_FORMAT_RGB565) || ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB1555) || \
  510. ((Pixelformat) == LTDC_PIXEL_FORMAT_ARGB4444) || ((Pixelformat) == LTDC_PIXEL_FORMAT_L8) || \
  511. ((Pixelformat) == LTDC_PIXEL_FORMAT_AL44) || ((Pixelformat) == LTDC_PIXEL_FORMAT_AL88))
  512. #define IS_LTDC_ALPHA(ALPHA) ((ALPHA) <= LTDC_ALPHA)
  513. #define IS_LTDC_HCONFIGST(HCONFIGST) ((HCONFIGST) <= LTDC_STARTPOSITION)
  514. #define IS_LTDC_HCONFIGSP(HCONFIGSP) ((HCONFIGSP) <= LTDC_STOPPOSITION)
  515. #define IS_LTDC_VCONFIGST(VCONFIGST) ((VCONFIGST) <= LTDC_STARTPOSITION)
  516. #define IS_LTDC_VCONFIGSP(VCONFIGSP) ((VCONFIGSP) <= LTDC_STOPPOSITION)
  517. #define IS_LTDC_CFBP(CFBP) ((CFBP) <= LTDC_COLOR_FRAME_BUFFER)
  518. #define IS_LTDC_CFBLL(CFBLL) ((CFBLL) <= LTDC_COLOR_FRAME_BUFFER)
  519. #define IS_LTDC_CFBLNBR(CFBLNBR) ((CFBLNBR) <= LTDC_LINE_NUMBER)
  520. #define IS_LTDC_LIPOS(LIPOS) ((LIPOS) <= 0x7FF)
  521. /**
  522. * @}
  523. */
  524. /* Private functions ---------------------------------------------------------*/
  525. /** @defgroup LTDC_Private_Functions LTDC Private Functions
  526. * @{
  527. */
  528. /**
  529. * @}
  530. */
  531. /**
  532. * @}
  533. */
  534. /**
  535. * @}
  536. */
  537. #endif /* STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
  538. #ifdef __cplusplus
  539. }
  540. #endif
  541. #endif /* __STM32F4xx_HAL_LTDC_H */
  542. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/