stm32h7xx_hal_dcmi.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624
  1. /**
  2. ******************************************************************************
  3. * @file stm32h7xx_hal_dcmi.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 21-April-2017
  7. * @brief Header file of DCMI 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_DCMI_H
  39. #define __STM32H7xx_HAL_DCMI_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 DCMI DCMI
  49. * @brief DCMI HAL module driver
  50. * @{
  51. */
  52. /* Exported types ------------------------------------------------------------*/
  53. /** @defgroup DCMI_Exported_Types DCMI Exported Types
  54. * @{
  55. */
  56. /**
  57. * @brief HAL DCMI State structures definition
  58. */
  59. typedef enum
  60. {
  61. HAL_DCMI_STATE_RESET = 0x00U, /*!< DCMI not yet initialized or disabled */
  62. HAL_DCMI_STATE_READY = 0x01U, /*!< DCMI initialized and ready for use */
  63. HAL_DCMI_STATE_BUSY = 0x02U, /*!< DCMI internal processing is ongoing */
  64. HAL_DCMI_STATE_TIMEOUT = 0x03U, /*!< DCMI timeout state */
  65. HAL_DCMI_STATE_ERROR = 0x04U, /*!< DCMI error state */
  66. HAL_DCMI_STATE_SUSPENDED = 0x05U /*!< DCMI suspend state */
  67. }HAL_DCMI_StateTypeDef;
  68. /**
  69. * @brief DCMI Embedded Synchronisation CODE Init structure definition
  70. */
  71. typedef struct
  72. {
  73. uint8_t FrameStartCode; /*!< Specifies the code of the frame start delimiter. */
  74. uint8_t LineStartCode; /*!< Specifies the code of the line start delimiter. */
  75. uint8_t LineEndCode; /*!< Specifies the code of the line end delimiter. */
  76. uint8_t FrameEndCode; /*!< Specifies the code of the frame end delimiter. */
  77. }DCMI_CodesInitTypeDef;
  78. /**
  79. * @brief DCMI Init structure definition
  80. */
  81. typedef struct
  82. {
  83. uint32_t SynchroMode; /*!< Specifies the Synchronization Mode: Hardware or Embedded.
  84. This parameter can be a value of @ref DCMI_Synchronization_Mode */
  85. uint32_t PCKPolarity; /*!< Specifies the Pixel clock polarity: Falling or Rising.
  86. This parameter can be a value of @ref DCMI_PIXCK_Polarity */
  87. uint32_t VSPolarity; /*!< Specifies the Vertical synchronization polarity: High or Low.
  88. This parameter can be a value of @ref DCMI_VSYNC_Polarity */
  89. uint32_t HSPolarity; /*!< Specifies the Horizontal synchronization polarity: High or Low.
  90. This parameter can be a value of @ref DCMI_HSYNC_Polarity */
  91. uint32_t CaptureRate; /*!< Specifies the frequency of frame capture: All, 1/2 or 1/4.
  92. This parameter can be a value of @ref DCMI_Capture_Rate */
  93. uint32_t ExtendedDataMode; /*!< Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit.
  94. This parameter can be a value of @ref DCMI_Extended_Data_Mode */
  95. DCMI_CodesInitTypeDef SyncroCode; /*!< Specifies the code of the line/frame start delimiter and the
  96. line/frame end delimiter */
  97. uint32_t JPEGMode; /*!< Enable or Disable the JPEG mode.
  98. This parameter can be a value of @ref DCMI_MODE_JPEG */
  99. uint32_t ByteSelectMode; /*!< Specifies the data to be captured by the interface
  100. This parameter can be a value of @ref DCMI_Byte_Select_Mode */
  101. uint32_t ByteSelectStart; /*!< Specifies if the data to be captured by the interface is even or odd
  102. This parameter can be a value of @ref DCMI_Byte_Select_Start */
  103. uint32_t LineSelectMode; /*!< Specifies the line of data to be captured by the interface
  104. This parameter can be a value of @ref DCMI_Line_Select_Mode */
  105. uint32_t LineSelectStart; /*!< Specifies if the line of data to be captured by the interface is even or odd
  106. This parameter can be a value of @ref DCMI_Line_Select_Start */
  107. }DCMI_InitTypeDef;
  108. /**
  109. * @brief DCMI handle Structure definition
  110. */
  111. typedef struct
  112. {
  113. DCMI_TypeDef *Instance; /*!< DCMI Register base address */
  114. DCMI_InitTypeDef Init; /*!< DCMI parameters */
  115. HAL_LockTypeDef Lock; /*!< DCMI locking object */
  116. __IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */
  117. __IO uint32_t XferCount; /*!< DMA transfer counter */
  118. __IO uint32_t XferSize; /*!< DMA transfer size */
  119. uint32_t XferTransferNumber; /*!< DMA transfer number */
  120. uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */
  121. DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to the DMA handler */
  122. __IO uint32_t ErrorCode; /*!< DCMI Error code */
  123. }DCMI_HandleTypeDef;
  124. /**
  125. * @}
  126. */
  127. /* Exported constants --------------------------------------------------------*/
  128. /** @defgroup DCMI_Exported_Constants DCMI Exported Constants
  129. * @{
  130. */
  131. /** @defgroup DCMI_Error_Code DCMI Error Code
  132. * @{
  133. */
  134. #define HAL_DCMI_ERROR_NONE (0x00000000U) /*!< No error */
  135. #define HAL_DCMI_ERROR_OVR (0x00000001U) /*!< Overrun error */
  136. #define HAL_DCMI_ERROR_SYNC (0x00000002U) /*!< Synchronization error */
  137. #define HAL_DCMI_ERROR_TIMEOUT (0x00000020U) /*!< Timeout error */
  138. #define HAL_DCMI_ERROR_DMA (0x00000040U) /*!< DMA error */
  139. /**
  140. * @}
  141. */
  142. /** @defgroup DCMI_Capture_Mode DCMI Capture Mode
  143. * @{
  144. */
  145. #define DCMI_MODE_CONTINUOUS (0x00000000U) /*!< The received data are transferred continuously
  146. into the destination memory through the DMA */
  147. #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of
  148. frame and then transfers a single frame through the DMA */
  149. /**
  150. * @}
  151. */
  152. /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode
  153. * @{
  154. */
  155. #define DCMI_SYNCHRO_HARDWARE (0x00000000U) /*!< Hardware synchronization data capture (frame/line start/stop)
  156. is synchronized with the HSYNC/VSYNC signals */
  157. #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with
  158. synchronization codes embedded in the data flow */
  159. /**
  160. * @}
  161. */
  162. /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity
  163. * @{
  164. */
  165. #define DCMI_PCKPOLARITY_FALLING (0x00000000U) /*!< Pixel clock active on Falling edge */
  166. #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */
  167. /**
  168. * @}
  169. */
  170. /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity
  171. * @{
  172. */
  173. #define DCMI_VSPOLARITY_LOW (0x00000000U) /*!< Vertical synchronization active Low */
  174. #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */
  175. /**
  176. * @}
  177. */
  178. /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity
  179. * @{
  180. */
  181. #define DCMI_HSPOLARITY_LOW (0x00000000U) /*!< Horizontal synchronization active Low */
  182. #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */
  183. /**
  184. * @}
  185. */
  186. /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG
  187. * @{
  188. */
  189. #define DCMI_JPEG_DISABLE (0x00000000U) /*!< Mode JPEG Disabled */
  190. #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< Mode JPEG Enabled */
  191. /**
  192. * @}
  193. */
  194. /** @defgroup DCMI_Capture_Rate DCMI Capture Rate
  195. * @{
  196. */
  197. #define DCMI_CR_ALL_FRAME (0x00000000U) /*!< All frames are captured */
  198. #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */
  199. #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */
  200. /**
  201. * @}
  202. */
  203. /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode
  204. * @{
  205. */
  206. #define DCMI_EXTEND_DATA_8B (0x00000000U) /*!< Interface captures 8-bit data on every pixel clock */
  207. #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */
  208. #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */
  209. #define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1)) /*!< Interface captures 14-bit data on every pixel clock */
  210. /**
  211. * @}
  212. */
  213. /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate
  214. * @{
  215. */
  216. #define DCMI_WINDOW_COORDINATE (0x3FFFU) /*!< Window coordinate */
  217. /**
  218. * @}
  219. */
  220. /** @defgroup DCMI_Window_Height DCMI Window Height
  221. * @{
  222. */
  223. #define DCMI_WINDOW_HEIGHT (0x1FFFU) /*!< Window Height */
  224. /**
  225. * @}
  226. */
  227. /** @defgroup DCMI_interrupt_sources DCMI interrupt sources
  228. * @{
  229. */
  230. #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */
  231. #define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE) /*!< Overrun interrupt */
  232. #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE) /*!< Synchronization error interrupt */
  233. #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE) /*!< VSYNC interrupt */
  234. #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE) /*!< Line interrupt */
  235. /**
  236. * @}
  237. */
  238. /** @defgroup DCMI_Flags DCMI Flags
  239. * @{
  240. */
  241. /**
  242. * @brief DCMI SR register
  243. */
  244. #define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC) /*!< HSYNC pin state (active line / synchronization between lines) */
  245. #define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC) /*!< VSYNC pin state (active frame / synchronization between frames) */
  246. #define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE) /*!< FIFO not empty flag */
  247. /**
  248. * @brief DCMI RIS register
  249. */
  250. #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RIS_FRAME_RIS) /*!< Frame capture complete interrupt flag */
  251. #define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RIS_OVR_RIS) /*!< Overrun interrupt flag */
  252. #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RIS_ERR_RIS) /*!< Synchronization error interrupt flag */
  253. #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RIS_VSYNC_RIS) /*!< VSYNC interrupt flag */
  254. #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RIS_LINE_RIS) /*!< Line interrupt flag */
  255. /**
  256. * @brief DCMI MIS register
  257. */
  258. #define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS) /*!< DCMI Frame capture complete masked interrupt status */
  259. #define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS ) /*!< DCMI Overrun masked interrupt status */
  260. #define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS ) /*!< DCMI Synchronization error masked interrupt status */
  261. #define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS) /*!< DCMI VSYNC masked interrupt status */
  262. #define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS ) /*!< DCMI Line masked interrupt status */
  263. /**
  264. * @}
  265. */
  266. /** @defgroup DCMI_Byte_Select_Mode DCMI Byte Select Mode
  267. * @{
  268. */
  269. #define DCMI_BSM_ALL (0x00000000U) /*!< Interface captures all received data */
  270. #define DCMI_BSM_OTHER ((uint32_t)DCMI_CR_BSM_0) /*!< Interface captures every other byte from the received data */
  271. #define DCMI_BSM_ALTERNATE_4 ((uint32_t)DCMI_CR_BSM_1) /*!< Interface captures one byte out of four */
  272. #define DCMI_BSM_ALTERNATE_2 ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1)) /*!< Interface captures two bytes out of four */
  273. /**
  274. * @}
  275. */
  276. /** @defgroup DCMI_Byte_Select_Start DCMI Byte Select Start
  277. * @{
  278. */
  279. #define DCMI_OEBS_ODD (0x00000000U) /*!< Interface captures first data from the frame/line start, second one being dropped */
  280. #define DCMI_OEBS_EVEN ((uint32_t)DCMI_CR_OEBS) /*!< Interface captures second data from the frame/line start, first one being dropped */
  281. /**
  282. * @}
  283. */
  284. /** @defgroup DCMI_Line_Select_Mode DCMI Line Select Mode
  285. * @{
  286. */
  287. #define DCMI_LSM_ALL (0x00000000U) /*!< Interface captures all received lines */
  288. #define DCMI_LSM_ALTERNATE_2 ((uint32_t)DCMI_CR_LSM) /*!< Interface captures one line out of two */
  289. /**
  290. * @}
  291. */
  292. /** @defgroup DCMI_Line_Select_Start DCMI Line Select Start
  293. * @{
  294. */
  295. #define DCMI_OELS_ODD (0x00000000U) /*!< Interface captures first line from the frame start, second one being dropped */
  296. #define DCMI_OELS_EVEN ((uint32_t)DCMI_CR_OELS) /*!< Interface captures second line from the frame start, first one being dropped */
  297. /**
  298. * @}
  299. */
  300. /**
  301. * @}
  302. */
  303. /* Exported macro ------------------------------------------------------------*/
  304. /** @defgroup DCMI_Exported_Macros DCMI Exported Macros
  305. * @{
  306. */
  307. /** @brief Reset DCMI handle state
  308. * @param __HANDLE__: specifies the DCMI handle.
  309. * @retval None
  310. */
  311. #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
  312. /**
  313. * @brief Enable the DCMI.
  314. * @param __HANDLE__: DCMI handle
  315. * @retval None
  316. */
  317. #define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
  318. /**
  319. * @brief Disable the DCMI.
  320. * @param __HANDLE__: DCMI handle
  321. * @retval None
  322. */
  323. #define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
  324. /* Interrupt & Flag management */
  325. /**
  326. * @brief Get the DCMI pending flag.
  327. * @param __HANDLE__: DCMI handle
  328. * @param __FLAG__: Get the specified flag.
  329. * This parameter can be one of the following values (no combination allowed)
  330. * @arg DCMI_FLAG_HSYNC: HSYNC pin state (active line / synchronization between lines)
  331. * @arg DCMI_FLAG_VSYNC: VSYNC pin state (active frame / synchronization between frames)
  332. * @arg DCMI_FLAG_FNE: FIFO empty flag
  333. * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
  334. * @arg DCMI_FLAG_OVRRI: Overrun flag mask
  335. * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
  336. * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
  337. * @arg DCMI_FLAG_LINERI: Line flag mask
  338. * @arg DCMI_FLAG_FRAMEMI: DCMI Capture complete masked interrupt status
  339. * @arg DCMI_FLAG_OVRMI: DCMI Overrun masked interrupt status
  340. * @arg DCMI_FLAG_ERRMI: DCMI Synchronization error masked interrupt status
  341. * @arg DCMI_FLAG_VSYNCMI: DCMI VSYNC masked interrupt status
  342. * @arg DCMI_FLAG_LINEMI: DCMI Line masked interrupt status
  343. * @retval The state of FLAG.
  344. */
  345. #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
  346. ((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0)? ((__HANDLE__)->Instance->RIS & (__FLAG__)) :\
  347. (((__FLAG__) & DCMI_SR_INDEX) == 0x0)? ((__HANDLE__)->Instance->MIS & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
  348. /**
  349. * @brief Clear the DCMI pending flags.
  350. * @param __HANDLE__: DCMI handle
  351. * @param __FLAG__: specifies the flag to clear.
  352. * This parameter can be any combination of the following values:
  353. * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
  354. * @arg DCMI_FLAG_OVFRI: Overflow flag mask
  355. * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
  356. * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
  357. * @arg DCMI_FLAG_LINERI: Line flag mask
  358. * @retval None
  359. */
  360. #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  361. /**
  362. * @brief Enable the specified DCMI interrupts.
  363. * @param __HANDLE__: DCMI handle
  364. * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
  365. * This parameter can be any combination of the following values:
  366. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  367. * @arg DCMI_IT_OVF: Overflow interrupt mask
  368. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  369. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  370. * @arg DCMI_IT_LINE: Line interrupt mask
  371. * @retval None
  372. */
  373. #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  374. /**
  375. * @brief Disable the specified DCMI interrupts.
  376. * @param __HANDLE__: DCMI handle
  377. * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
  378. * This parameter can be any combination of the following values:
  379. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  380. * @arg DCMI_IT_OVF: Overflow interrupt mask
  381. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  382. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  383. * @arg DCMI_IT_LINE: Line interrupt mask
  384. * @retval None
  385. */
  386. #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
  387. /**
  388. * @brief Check whether the specified DCMI interrupt has occurred or not.
  389. * @param __HANDLE__: DCMI handle
  390. * @param __INTERRUPT__: specifies the DCMI interrupt source to check.
  391. * This parameter can be one of the following values:
  392. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  393. * @arg DCMI_IT_OVF: Overflow interrupt mask
  394. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  395. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  396. * @arg DCMI_IT_LINE: Line interrupt mask
  397. * @retval The state of INTERRUPT.
  398. */
  399. #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
  400. /**
  401. * @}
  402. */
  403. /* Exported functions --------------------------------------------------------*/
  404. /** @addtogroup DCMI_Exported_Functions DCMI Exported Functions
  405. * @{
  406. */
  407. /** @addtogroup DCMI_Exported_Functions_Group1 Initialization and Configuration functions
  408. * @{
  409. */
  410. /* Initialization and de-initialization functions *****************************/
  411. HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
  412. HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
  413. void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
  414. void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
  415. /**
  416. * @}
  417. */
  418. /** @addtogroup DCMI_Exported_Functions_Group2 IO operation functions
  419. * @{
  420. */
  421. /* IO operation functions *****************************************************/
  422. HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
  423. HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
  424. HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi);
  425. HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi);
  426. void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
  427. void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
  428. void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
  429. void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
  430. void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
  431. /**
  432. * @}
  433. */
  434. /** @addtogroup DCMI_Exported_Functions_Group3 Peripheral Control functions
  435. * @{
  436. */
  437. /* Peripheral Control functions ***********************************************/
  438. HAL_StatusTypeDef HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
  439. HAL_StatusTypeDef HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi);
  440. HAL_StatusTypeDef HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi);
  441. /**
  442. * @}
  443. */
  444. /** @addtogroup DCMI_Exported_Functions_Group4 Peripheral State functions
  445. * @{
  446. */
  447. /* Peripheral State functions *************************************************/
  448. HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
  449. uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
  450. /**
  451. * @}
  452. */
  453. /**
  454. * @}
  455. */
  456. /* Private types -------------------------------------------------------------*/
  457. /* Private variables ---------------------------------------------------------*/
  458. /* Private constants ---------------------------------------------------------*/
  459. /** @defgroup DCMI_Private_Constants DCMI Private Constants
  460. * @{
  461. */
  462. #define DCMI_MIS_INDEX (0x1000) /*!< DCMI MIS register index */
  463. #define DCMI_SR_INDEX (0x2000) /*!< DCMI SR register index */
  464. /**
  465. * @}
  466. */
  467. /* Private macro -------------------------------------------------------------*/
  468. /** @defgroup DCMI_Private_Macros DCMI Private Macros
  469. * @{
  470. */
  471. #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
  472. ((MODE) == DCMI_MODE_SNAPSHOT))
  473. #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
  474. ((MODE) == DCMI_SYNCHRO_EMBEDDED))
  475. #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
  476. ((POLARITY) == DCMI_PCKPOLARITY_RISING))
  477. #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
  478. ((POLARITY) == DCMI_VSPOLARITY_HIGH))
  479. #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
  480. ((POLARITY) == DCMI_HSPOLARITY_HIGH))
  481. #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
  482. ((JPEG_MODE) == DCMI_JPEG_ENABLE))
  483. #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
  484. ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
  485. ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
  486. #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
  487. ((DATA) == DCMI_EXTEND_DATA_10B) || \
  488. ((DATA) == DCMI_EXTEND_DATA_12B) || \
  489. ((DATA) == DCMI_EXTEND_DATA_14B))
  490. #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
  491. #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
  492. #define IS_DCMI_BYTE_SELECT_MODE(MODE)(((MODE) == DCMI_BSM_ALL) || \
  493. ((MODE) == DCMI_BSM_OTHER) || \
  494. ((MODE) == DCMI_BSM_ALTERNATE_4) || \
  495. ((MODE) == DCMI_BSM_ALTERNATE_2))
  496. #define IS_DCMI_BYTE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OEBS_ODD) || \
  497. ((POLARITY) == DCMI_OEBS_EVEN))
  498. #define IS_DCMI_LINE_SELECT_MODE(MODE)(((MODE) == DCMI_LSM_ALL) || \
  499. ((MODE) == DCMI_LSM_ALTERNATE_2))
  500. #define IS_DCMI_LINE_SELECT_START(POLARITY)(((POLARITY) == DCMI_OELS_ODD) || \
  501. ((POLARITY) == DCMI_OELS_EVEN))
  502. /**
  503. * @}
  504. */
  505. /* Private functions ---------------------------------------------------------*/
  506. /** @addtogroup DCMI_Private_Functions DCMI Private Functions
  507. * @{
  508. */
  509. /**
  510. * @}
  511. */
  512. /**
  513. * @}
  514. */
  515. /**
  516. * @}
  517. */
  518. #ifdef __cplusplus
  519. }
  520. #endif
  521. #endif /* __STM32H7xx_HAL_DCMI_H */
  522. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/