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.
 
 
 

650 lines
30 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_ltdc.h
  4. * @author MCD Application Team
  5. * @version V1.7.1
  6. * @date 14-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 __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 2U
  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 = 0x7FF. */
  113. uint32_t WindowY1; /*!< Configures the Window vertical Stop Position.
  114. This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x7FF. */
  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 = 0x00U, /*!< LTDC not yet initialized or disabled */
  138. HAL_LTDC_STATE_READY = 0x01U, /*!< LTDC initialized and ready for use */
  139. HAL_LTDC_STATE_BUSY = 0x02U, /*!< LTDC internal process is ongoing */
  140. HAL_LTDC_STATE_TIMEOUT = 0x03U, /*!< LTDC Timeout state */
  141. HAL_LTDC_STATE_ERROR = 0x04U /*!< 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 0x00000000U /*!< LTDC No error */
  166. #define HAL_LTDC_ERROR_TE 0x00000001U /*!< LTDC Transfer error */
  167. #define HAL_LTDC_ERROR_FU 0x00000002U /*!< LTDC FIFO Underrun */
  168. #define HAL_LTDC_ERROR_TIMEOUT 0x00000020U /*!< LTDC Timeout error */
  169. /**
  170. * @}
  171. */
  172. /** @defgroup LTDC_Layer LTDC Layer
  173. * @{
  174. */
  175. #define LTDC_LAYER_1 0x00000000U /*!< LTDC Layer 1 */
  176. #define LTDC_LAYER_2 0x00000001U /*!< LTDC Layer 2 */
  177. /**
  178. * @}
  179. */
  180. /** @defgroup LTDC_HS_POLARITY LTDC HS POLARITY
  181. * @{
  182. */
  183. #define LTDC_HSPOLARITY_AL 0x00000000U /*!< Horizontal Synchronization is active low. */
  184. #define LTDC_HSPOLARITY_AH LTDC_GCR_HSPOL /*!< Horizontal Synchronization is active high. */
  185. /**
  186. * @}
  187. */
  188. /** @defgroup LTDC_VS_POLARITY LTDC VS POLARITY
  189. * @{
  190. */
  191. #define LTDC_VSPOLARITY_AL 0x00000000U /*!< Vertical Synchronization is active low. */
  192. #define LTDC_VSPOLARITY_AH LTDC_GCR_VSPOL /*!< Vertical Synchronization is active high. */
  193. /**
  194. * @}
  195. */
  196. /** @defgroup LTDC_DE_POLARITY LTDC DE POLARITY
  197. * @{
  198. */
  199. #define LTDC_DEPOLARITY_AL 0x00000000U /*!< Data Enable, is active low. */
  200. #define LTDC_DEPOLARITY_AH LTDC_GCR_DEPOL /*!< Data Enable, is active high. */
  201. /**
  202. * @}
  203. */
  204. /** @defgroup LTDC_PC_POLARITY LTDC PC POLARITY
  205. * @{
  206. */
  207. #define LTDC_PCPOLARITY_IPC 0x00000000U /*!< input pixel clock. */
  208. #define LTDC_PCPOLARITY_IIPC LTDC_GCR_PCPOL /*!< inverted input pixel clock. */
  209. /**
  210. * @}
  211. */
  212. /** @defgroup LTDC_SYNC LTDC SYNC
  213. * @{
  214. */
  215. #define LTDC_HORIZONTALSYNC (LTDC_SSCR_HSW >> 16U) /*!< Horizontal synchronization width. */
  216. #define LTDC_VERTICALSYNC LTDC_SSCR_VSH /*!< Vertical synchronization height. */
  217. /**
  218. * @}
  219. */
  220. /** @defgroup LTDC_BACK_COLOR LTDC BACK COLOR
  221. * @{
  222. */
  223. #define LTDC_COLOR 0x000000FFU /*!< Color mask */
  224. /**
  225. * @}
  226. */
  227. /** @defgroup LTDC_BlendingFactor1 LTDC Blending Factor1
  228. * @{
  229. */
  230. #define LTDC_BLENDING_FACTOR1_CA 0x00000400U /*!< Blending factor : Cte Alpha */
  231. #define LTDC_BLENDING_FACTOR1_PAxCA 0x00000600U /*!< Blending factor : Cte Alpha x Pixel Alpha*/
  232. /**
  233. * @}
  234. */
  235. /** @defgroup LTDC_BlendingFactor2 LTDC Blending Factor2
  236. * @{
  237. */
  238. #define LTDC_BLENDING_FACTOR2_CA 0x00000005U /*!< Blending factor : Cte Alpha */
  239. #define LTDC_BLENDING_FACTOR2_PAxCA 0x00000007U /*!< Blending factor : Cte Alpha x Pixel Alpha*/
  240. /**
  241. * @}
  242. */
  243. /** @defgroup LTDC_Pixelformat LTDC Pixel format
  244. * @{
  245. */
  246. #define LTDC_PIXEL_FORMAT_ARGB8888 0x00000000U /*!< ARGB8888 LTDC pixel format */
  247. #define LTDC_PIXEL_FORMAT_RGB888 0x00000001U /*!< RGB888 LTDC pixel format */
  248. #define LTDC_PIXEL_FORMAT_RGB565 0x00000002U /*!< RGB565 LTDC pixel format */
  249. #define LTDC_PIXEL_FORMAT_ARGB1555 0x00000003U /*!< ARGB1555 LTDC pixel format */
  250. #define LTDC_PIXEL_FORMAT_ARGB4444 0x00000004U /*!< ARGB4444 LTDC pixel format */
  251. #define LTDC_PIXEL_FORMAT_L8 0x00000005U /*!< L8 LTDC pixel format */
  252. #define LTDC_PIXEL_FORMAT_AL44 0x00000006U /*!< AL44 LTDC pixel format */
  253. #define LTDC_PIXEL_FORMAT_AL88 0x00000007U /*!< AL88 LTDC pixel format */
  254. /**
  255. * @}
  256. */
  257. /** @defgroup LTDC_Alpha LTDC Alpha
  258. * @{
  259. */
  260. #define LTDC_ALPHA LTDC_LxCACR_CONSTA /*!< LTDC Constant Alpha mask */
  261. /**
  262. * @}
  263. */
  264. /** @defgroup LTDC_LAYER_Config LTDC LAYER Config
  265. * @{
  266. */
  267. #define LTDC_STOPPOSITION (LTDC_LxWHPCR_WHSPPOS >> 16U) /*!< LTDC Layer stop position */
  268. #define LTDC_STARTPOSITION LTDC_LxWHPCR_WHSTPOS /*!< LTDC Layer start position */
  269. #define LTDC_COLOR_FRAME_BUFFER LTDC_LxCFBLR_CFBLL /*!< LTDC Layer Line length */
  270. #define LTDC_LINE_NUMBER LTDC_LxCFBLNR_CFBLNBR /*!< LTDC Layer Line number */
  271. /**
  272. * @}
  273. */
  274. /** @defgroup LTDC_Interrupts LTDC Interrupts
  275. * @{
  276. */
  277. #define LTDC_IT_LI LTDC_IER_LIE /*!< LTDC Line Interrupt */
  278. #define LTDC_IT_FU LTDC_IER_FUIE /*!< LTDC FIFO Underrun Interrupt */
  279. #define LTDC_IT_TE LTDC_IER_TERRIE /*!< LTDC Transfer Error Interrupt */
  280. #define LTDC_IT_RR LTDC_IER_RRIE /*!< LTDC Register Reload Interrupt */
  281. /**
  282. * @}
  283. */
  284. /** @defgroup LTDC_Flags LTDC Flags
  285. * @{
  286. */
  287. #define LTDC_FLAG_LI LTDC_ISR_LIF /*!< LTDC Line Interrupt Flag */
  288. #define LTDC_FLAG_FU LTDC_ISR_FUIF /*!< LTDC FIFO Underrun interrupt Flag */
  289. #define LTDC_FLAG_TE LTDC_ISR_TERRIF /*!< LTDC Transfer Error interrupt Flag */
  290. #define LTDC_FLAG_RR LTDC_ISR_RRIF /*!< LTDC Register Reload interrupt Flag */
  291. /**
  292. * @}
  293. */
  294. /** @defgroup LTDC_Reload_Type LTDC Reload Type
  295. * @{
  296. */
  297. #define LTDC_RELOAD_IMMEDIATE LTDC_SRCR_IMR /*!< Immediate Reload */
  298. #define LTDC_RELOAD_VERTICAL_BLANKING LTDC_SRCR_VBR /*!< Vertical Blanking Reload */
  299. /**
  300. * @}
  301. */
  302. /**
  303. * @}
  304. */
  305. /* Exported macro ------------------------------------------------------------*/
  306. /** @defgroup LTDC_Exported_Macros LTDC Exported Macros
  307. * @{
  308. */
  309. /** @brief Reset LTDC handle state.
  310. * @param __HANDLE__ LTDC handle
  311. * @retval None
  312. */
  313. #define __HAL_LTDC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LTDC_STATE_RESET)
  314. /**
  315. * @brief Enable the LTDC.
  316. * @param __HANDLE__ LTDC handle
  317. * @retval None.
  318. */
  319. #define __HAL_LTDC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR |= LTDC_GCR_LTDCEN)
  320. /**
  321. * @brief Disable the LTDC.
  322. * @param __HANDLE__ LTDC handle
  323. * @retval None.
  324. */
  325. #define __HAL_LTDC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->GCR &= ~(LTDC_GCR_LTDCEN))
  326. /**
  327. * @brief Enable the LTDC Layer.
  328. * @param __HANDLE__ LTDC handle
  329. * @param __LAYER__ Specify the layer to be enabled.
  330. * This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
  331. * @retval None.
  332. */
  333. #define __HAL_LTDC_LAYER_ENABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR |= (uint32_t)LTDC_LxCR_LEN)
  334. /**
  335. * @brief Disable the LTDC Layer.
  336. * @param __HANDLE__ LTDC handle
  337. * @param __LAYER__ Specify the layer to be disabled.
  338. * This parameter can be LTDC_LAYER_1 (0) or LTDC_LAYER_2 (1).
  339. * @retval None.
  340. */
  341. #define __HAL_LTDC_LAYER_DISABLE(__HANDLE__, __LAYER__) ((LTDC_LAYER((__HANDLE__), (__LAYER__)))->CR &= ~(uint32_t)LTDC_LxCR_LEN)
  342. /**
  343. * @brief Reload immediately all LTDC Layers.
  344. * @param __HANDLE__ LTDC handle
  345. * @retval None.
  346. */
  347. #define __HAL_LTDC_RELOAD_IMMEDIATE_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_IMR)
  348. /**
  349. * @brief Reload during vertical blanking period all LTDC Layers.
  350. * @param __HANDLE__ LTDC handle
  351. * @retval None.
  352. */
  353. #define __HAL_LTDC_VERTICAL_BLANKING_RELOAD_CONFIG(__HANDLE__) ((__HANDLE__)->Instance->SRCR |= LTDC_SRCR_VBR)
  354. /* Interrupt & Flag management */
  355. /**
  356. * @brief Get the LTDC pending flags.
  357. * @param __HANDLE__ LTDC handle
  358. * @param __FLAG__ Get the specified flag.
  359. * This parameter can be any combination of the following values:
  360. * @arg LTDC_FLAG_LI: Line Interrupt flag
  361. * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  362. * @arg LTDC_FLAG_TE: Transfer Error interrupt flag
  363. * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
  364. * @retval The state of FLAG (SET or RESET).
  365. */
  366. #define __HAL_LTDC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
  367. /**
  368. * @brief Clears the LTDC pending flags.
  369. * @param __HANDLE__ LTDC handle
  370. * @param __FLAG__ Specify the flag to clear.
  371. * This parameter can be any combination of the following values:
  372. * @arg LTDC_FLAG_LI: Line Interrupt flag
  373. * @arg LTDC_FLAG_FU: FIFO Underrun Interrupt flag
  374. * @arg LTDC_FLAG_TE: Transfer Error interrupt flag
  375. * @arg LTDC_FLAG_RR: Register Reload Interrupt Flag
  376. * @retval None
  377. */
  378. #define __HAL_LTDC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  379. /**
  380. * @brief Enables the specified LTDC interrupts.
  381. * @param __HANDLE__ LTDC handle
  382. * @param __INTERRUPT__ Specify the LTDC interrupt sources to be enabled.
  383. * This parameter can be any combination of the following values:
  384. * @arg LTDC_IT_LI: Line Interrupt flag
  385. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  386. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  387. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  388. * @retval None
  389. */
  390. #define __HAL_LTDC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  391. /**
  392. * @brief Disables the specified LTDC interrupts.
  393. * @param __HANDLE__ LTDC handle
  394. * @param __INTERRUPT__ Specify the LTDC interrupt sources to be disabled.
  395. * This parameter can be any combination of the following values:
  396. * @arg LTDC_IT_LI: Line Interrupt flag
  397. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  398. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  399. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  400. * @retval None
  401. */
  402. #define __HAL_LTDC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
  403. /**
  404. * @brief Check whether the specified LTDC interrupt has occurred or not.
  405. * @param __HANDLE__ LTDC handle
  406. * @param __INTERRUPT__ Specify the LTDC interrupt source to check.
  407. * This parameter can be one of the following values:
  408. * @arg LTDC_IT_LI: Line Interrupt flag
  409. * @arg LTDC_IT_FU: FIFO Underrun Interrupt flag
  410. * @arg LTDC_IT_TE: Transfer Error interrupt flag
  411. * @arg LTDC_IT_RR: Register Reload Interrupt Flag
  412. * @retval The state of INTERRUPT (SET or RESET).
  413. */
  414. #define __HAL_LTDC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER & (__INTERRUPT__))
  415. /**
  416. * @}
  417. */
  418. /* Include LTDC HAL Extension module */
  419. #include "stm32f4xx_hal_ltdc_ex.h"
  420. /* Exported functions --------------------------------------------------------*/
  421. /** @addtogroup LTDC_Exported_Functions
  422. * @{
  423. */
  424. /** @addtogroup LTDC_Exported_Functions_Group1
  425. * @{
  426. */
  427. /* Initialization and de-initialization functions *****************************/
  428. HAL_StatusTypeDef HAL_LTDC_Init(LTDC_HandleTypeDef *hltdc);
  429. HAL_StatusTypeDef HAL_LTDC_DeInit(LTDC_HandleTypeDef *hltdc);
  430. void HAL_LTDC_MspInit(LTDC_HandleTypeDef* hltdc);
  431. void HAL_LTDC_MspDeInit(LTDC_HandleTypeDef* hltdc);
  432. void HAL_LTDC_ErrorCallback(LTDC_HandleTypeDef *hltdc);
  433. void HAL_LTDC_LineEventCallback(LTDC_HandleTypeDef *hltdc);
  434. void HAL_LTDC_ReloadEventCallback(LTDC_HandleTypeDef *hltdc);
  435. /**
  436. * @}
  437. */
  438. /** @addtogroup LTDC_Exported_Functions_Group2
  439. * @{
  440. */
  441. /* IO operation functions *****************************************************/
  442. void HAL_LTDC_IRQHandler(LTDC_HandleTypeDef *hltdc);
  443. /**
  444. * @}
  445. */
  446. /** @addtogroup LTDC_Exported_Functions_Group3
  447. * @{
  448. */
  449. /* Peripheral Control functions ***********************************************/
  450. HAL_StatusTypeDef HAL_LTDC_ConfigLayer(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
  451. HAL_StatusTypeDef HAL_LTDC_SetWindowSize(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
  452. HAL_StatusTypeDef HAL_LTDC_SetWindowPosition(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
  453. HAL_StatusTypeDef HAL_LTDC_SetPixelFormat(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
  454. HAL_StatusTypeDef HAL_LTDC_SetAlpha(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
  455. HAL_StatusTypeDef HAL_LTDC_SetAddress(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
  456. HAL_StatusTypeDef HAL_LTDC_SetPitch(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
  457. HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
  458. HAL_StatusTypeDef HAL_LTDC_ConfigCLUT(LTDC_HandleTypeDef *hltdc, uint32_t *pCLUT, uint32_t CLUTSize, uint32_t LayerIdx);
  459. HAL_StatusTypeDef HAL_LTDC_EnableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  460. HAL_StatusTypeDef HAL_LTDC_DisableColorKeying(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  461. HAL_StatusTypeDef HAL_LTDC_EnableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  462. HAL_StatusTypeDef HAL_LTDC_DisableCLUT(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  463. HAL_StatusTypeDef HAL_LTDC_ProgramLineEvent(LTDC_HandleTypeDef *hltdc, uint32_t Line);
  464. HAL_StatusTypeDef HAL_LTDC_EnableDither(LTDC_HandleTypeDef *hltdc);
  465. HAL_StatusTypeDef HAL_LTDC_DisableDither(LTDC_HandleTypeDef *hltdc);
  466. HAL_StatusTypeDef HAL_LTDC_Reload(LTDC_HandleTypeDef *hltdc, uint32_t ReloadType);
  467. HAL_StatusTypeDef HAL_LTDC_ConfigLayer_NoReload(LTDC_HandleTypeDef *hltdc, LTDC_LayerCfgTypeDef *pLayerCfg, uint32_t LayerIdx);
  468. HAL_StatusTypeDef HAL_LTDC_SetWindowSize_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t XSize, uint32_t YSize, uint32_t LayerIdx);
  469. HAL_StatusTypeDef HAL_LTDC_SetWindowPosition_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t X0, uint32_t Y0, uint32_t LayerIdx);
  470. HAL_StatusTypeDef HAL_LTDC_SetPixelFormat_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Pixelformat, uint32_t LayerIdx);
  471. HAL_StatusTypeDef HAL_LTDC_SetAlpha_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Alpha, uint32_t LayerIdx);
  472. HAL_StatusTypeDef HAL_LTDC_SetAddress_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t Address, uint32_t LayerIdx);
  473. HAL_StatusTypeDef HAL_LTDC_SetPitch_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LinePitchInPixels, uint32_t LayerIdx);
  474. HAL_StatusTypeDef HAL_LTDC_ConfigColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t RGBValue, uint32_t LayerIdx);
  475. HAL_StatusTypeDef HAL_LTDC_EnableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  476. HAL_StatusTypeDef HAL_LTDC_DisableColorKeying_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  477. HAL_StatusTypeDef HAL_LTDC_EnableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  478. HAL_StatusTypeDef HAL_LTDC_DisableCLUT_NoReload(LTDC_HandleTypeDef *hltdc, uint32_t LayerIdx);
  479. /**
  480. * @}
  481. */
  482. /** @addtogroup LTDC_Exported_Functions_Group4
  483. * @{
  484. */
  485. /* Peripheral State functions *************************************************/
  486. HAL_LTDC_StateTypeDef HAL_LTDC_GetState(LTDC_HandleTypeDef *hltdc);
  487. uint32_t HAL_LTDC_GetError(LTDC_HandleTypeDef *hltdc);
  488. /**
  489. * @}
  490. */
  491. /**
  492. * @}
  493. */
  494. /* Private types -------------------------------------------------------------*/
  495. /* Private variables ---------------------------------------------------------*/
  496. /* Private constants ---------------------------------------------------------*/
  497. /* Private macros ------------------------------------------------------------*/
  498. /** @defgroup LTDC_Private_Macros LTDC Private Macros
  499. * @{
  500. */
  501. #define LTDC_LAYER(__HANDLE__, __LAYER__) ((LTDC_Layer_TypeDef *)((uint32_t)(((uint32_t)((__HANDLE__)->Instance)) + 0x84U + (0x80U*(__LAYER__)))))
  502. #define IS_LTDC_LAYER(__LAYER__) ((__LAYER__) < MAX_LAYER)
  503. #define IS_LTDC_HSPOL(__HSPOL__) (((__HSPOL__) == LTDC_HSPOLARITY_AL) || ((__HSPOL__) == LTDC_HSPOLARITY_AH))
  504. #define IS_LTDC_VSPOL(__VSPOL__) (((__VSPOL__) == LTDC_VSPOLARITY_AL) || ((__VSPOL__) == LTDC_VSPOLARITY_AH))
  505. #define IS_LTDC_DEPOL(__DEPOL__) (((__DEPOL__) == LTDC_DEPOLARITY_AL) || ((__DEPOL__) == LTDC_DEPOLARITY_AH))
  506. #define IS_LTDC_PCPOL(__PCPOL__) (((__PCPOL__) == LTDC_PCPOLARITY_IPC) || ((__PCPOL__) == LTDC_PCPOLARITY_IIPC))
  507. #define IS_LTDC_HSYNC(__HSYNC__) ((__HSYNC__) <= LTDC_HORIZONTALSYNC)
  508. #define IS_LTDC_VSYNC(__VSYNC__) ((__VSYNC__) <= LTDC_VERTICALSYNC)
  509. #define IS_LTDC_AHBP(__AHBP__) ((__AHBP__) <= LTDC_HORIZONTALSYNC)
  510. #define IS_LTDC_AVBP(__AVBP__) ((__AVBP__) <= LTDC_VERTICALSYNC)
  511. #define IS_LTDC_AAW(__AAW__) ((__AAW__) <= LTDC_HORIZONTALSYNC)
  512. #define IS_LTDC_AAH(__AAH__) ((__AAH__) <= LTDC_VERTICALSYNC)
  513. #define IS_LTDC_TOTALW(__TOTALW__) ((__TOTALW__) <= LTDC_HORIZONTALSYNC)
  514. #define IS_LTDC_TOTALH(__TOTALH__) ((__TOTALH__) <= LTDC_VERTICALSYNC)
  515. #define IS_LTDC_BLUEVALUE(__BBLUE__) ((__BBLUE__) <= LTDC_COLOR)
  516. #define IS_LTDC_GREENVALUE(__BGREEN__) ((__BGREEN__) <= LTDC_COLOR)
  517. #define IS_LTDC_REDVALUE(__BRED__) ((__BRED__) <= LTDC_COLOR)
  518. #define IS_LTDC_BLENDING_FACTOR1(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_CA) || \
  519. ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR1_PAxCA))
  520. #define IS_LTDC_BLENDING_FACTOR2(__BLENDING_FACTOR1__) (((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_CA) || \
  521. ((__BLENDING_FACTOR1__) == LTDC_BLENDING_FACTOR2_PAxCA))
  522. #define IS_LTDC_PIXEL_FORMAT(__PIXEL_FORMAT__) (((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB8888) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB888) || \
  523. ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_RGB565) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB1555) || \
  524. ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_ARGB4444) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_L8) || \
  525. ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL44) || ((__PIXEL_FORMAT__) == LTDC_PIXEL_FORMAT_AL88))
  526. #define IS_LTDC_ALPHA(__ALPHA__) ((__ALPHA__) <= LTDC_ALPHA)
  527. #define IS_LTDC_HCONFIGST(__HCONFIGST__) ((__HCONFIGST__) <= LTDC_STARTPOSITION)
  528. #define IS_LTDC_HCONFIGSP(__HCONFIGSP__) ((__HCONFIGSP__) <= LTDC_STOPPOSITION)
  529. #define IS_LTDC_VCONFIGST(__VCONFIGST__) ((__VCONFIGST__) <= LTDC_STARTPOSITION)
  530. #define IS_LTDC_VCONFIGSP(__VCONFIGSP__) ((__VCONFIGSP__) <= LTDC_STOPPOSITION)
  531. #define IS_LTDC_CFBP(__CFBP__) ((__CFBP__) <= LTDC_COLOR_FRAME_BUFFER)
  532. #define IS_LTDC_CFBLL(__CFBLL__) ((__CFBLL__) <= LTDC_COLOR_FRAME_BUFFER)
  533. #define IS_LTDC_CFBLNBR(__CFBLNBR__) ((__CFBLNBR__) <= LTDC_LINE_NUMBER)
  534. #define IS_LTDC_LIPOS(__LIPOS__) ((__LIPOS__) <= 0x7FFU)
  535. #define IS_LTDC_RELOAD(__RELOADTYPE__) (((__RELOADTYPE__) == LTDC_RELOAD_IMMEDIATE) || ((__RELOADTYPE__) == LTDC_SRCR_VBR))
  536. /**
  537. * @}
  538. */
  539. /* Private functions ---------------------------------------------------------*/
  540. /** @defgroup LTDC_Private_Functions LTDC Private Functions
  541. * @{
  542. */
  543. /**
  544. * @}
  545. */
  546. /**
  547. * @}
  548. */
  549. /**
  550. * @}
  551. */
  552. #endif /* STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */
  553. #ifdef __cplusplus
  554. }
  555. #endif
  556. #endif /* __STM32F4xx_HAL_LTDC_H */
  557. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/