stm32f4xx_hal_dcmi.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_dcmi.h
  4. * @author MCD Application Team
  5. * @version V1.6.0
  6. * @date 04-November-2016
  7. * @brief Header file of DCMI HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2016 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_DCMI_H
  39. #define __STM32F4xx_HAL_DCMI_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. #if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
  44. defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
  45. defined(STM32F479xx)
  46. /* Includes ------------------------------------------------------------------*/
  47. #include "stm32f4xx_hal_def.h"
  48. /* Include DCMI HAL Extended module */
  49. /* (include on top of file since DCMI structures are defined in extended file) */
  50. #include "stm32f4xx_hal_dcmi_ex.h"
  51. /** @addtogroup STM32F4xx_HAL_Driver
  52. * @{
  53. */
  54. /** @addtogroup DCMI DCMI
  55. * @brief DCMI HAL module driver
  56. * @{
  57. */
  58. /* Exported types ------------------------------------------------------------*/
  59. /** @defgroup DCMI_Exported_Types DCMI Exported Types
  60. * @{
  61. */
  62. /**
  63. * @brief HAL DCMI State structures definition
  64. */
  65. typedef enum
  66. {
  67. HAL_DCMI_STATE_RESET = 0x00U, /*!< DCMI not yet initialized or disabled */
  68. HAL_DCMI_STATE_READY = 0x01U, /*!< DCMI initialized and ready for use */
  69. HAL_DCMI_STATE_BUSY = 0x02U, /*!< DCMI internal processing is ongoing */
  70. HAL_DCMI_STATE_TIMEOUT = 0x03U, /*!< DCMI timeout state */
  71. HAL_DCMI_STATE_ERROR = 0x04U, /*!< DCMI error state */
  72. HAL_DCMI_STATE_SUSPENDED = 0x05U /*!< DCMI suspend state */
  73. }HAL_DCMI_StateTypeDef;
  74. /**
  75. * @brief DCMI handle Structure definition
  76. */
  77. typedef struct
  78. {
  79. DCMI_TypeDef *Instance; /*!< DCMI Register base address */
  80. DCMI_InitTypeDef Init; /*!< DCMI parameters */
  81. HAL_LockTypeDef Lock; /*!< DCMI locking object */
  82. __IO HAL_DCMI_StateTypeDef State; /*!< DCMI state */
  83. __IO uint32_t XferCount; /*!< DMA transfer counter */
  84. __IO uint32_t XferSize; /*!< DMA transfer size */
  85. uint32_t XferTransferNumber; /*!< DMA transfer number */
  86. uint32_t pBuffPtr; /*!< Pointer to DMA output buffer */
  87. DMA_HandleTypeDef *DMA_Handle; /*!< Pointer to the DMA handler */
  88. __IO uint32_t ErrorCode; /*!< DCMI Error code */
  89. }DCMI_HandleTypeDef;
  90. /**
  91. * @}
  92. */
  93. /* Exported constants --------------------------------------------------------*/
  94. /** @defgroup DCMI_Exported_Constants DCMI Exported Constants
  95. * @{
  96. */
  97. /** @defgroup DCMI_Error_Code DCMI Error Code
  98. * @{
  99. */
  100. #define HAL_DCMI_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
  101. #define HAL_DCMI_ERROR_OVR ((uint32_t)0x00000001U) /*!< Overrun error */
  102. #define HAL_DCMI_ERROR_SYNC ((uint32_t)0x00000002U) /*!< Synchronization error */
  103. #define HAL_DCMI_ERROR_TIMEOUT ((uint32_t)0x00000020U) /*!< Timeout error */
  104. #define HAL_DCMI_ERROR_DMA ((uint32_t)0x00000040U) /*!< DMA error */
  105. /**
  106. * @}
  107. */
  108. /** @defgroup DCMI_Capture_Mode DCMI Capture Mode
  109. * @{
  110. */
  111. #define DCMI_MODE_CONTINUOUS ((uint32_t)0x00000000U) /*!< The received data are transferred continuously
  112. into the destination memory through the DMA */
  113. #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM) /*!< Once activated, the interface waits for the start of
  114. frame and then transfers a single frame through the DMA */
  115. /**
  116. * @}
  117. */
  118. /** @defgroup DCMI_Synchronization_Mode DCMI Synchronization Mode
  119. * @{
  120. */
  121. #define DCMI_SYNCHRO_HARDWARE ((uint32_t)0x00000000U) /*!< Hardware synchronization data capture (frame/line start/stop)
  122. is synchronized with the HSYNC/VSYNC signals */
  123. #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS) /*!< Embedded synchronization data capture is synchronized with
  124. synchronization codes embedded in the data flow */
  125. /**
  126. * @}
  127. */
  128. /** @defgroup DCMI_PIXCK_Polarity DCMI PIXCK Polarity
  129. * @{
  130. */
  131. #define DCMI_PCKPOLARITY_FALLING ((uint32_t)0x00000000U) /*!< Pixel clock active on Falling edge */
  132. #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL) /*!< Pixel clock active on Rising edge */
  133. /**
  134. * @}
  135. */
  136. /** @defgroup DCMI_VSYNC_Polarity DCMI VSYNC Polarity
  137. * @{
  138. */
  139. #define DCMI_VSPOLARITY_LOW ((uint32_t)0x00000000U) /*!< Vertical synchronization active Low */
  140. #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL) /*!< Vertical synchronization active High */
  141. /**
  142. * @}
  143. */
  144. /** @defgroup DCMI_HSYNC_Polarity DCMI HSYNC Polarity
  145. * @{
  146. */
  147. #define DCMI_HSPOLARITY_LOW ((uint32_t)0x00000000U) /*!< Horizontal synchronization active Low */
  148. #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL) /*!< Horizontal synchronization active High */
  149. /**
  150. * @}
  151. */
  152. /** @defgroup DCMI_MODE_JPEG DCMI MODE JPEG
  153. * @{
  154. */
  155. #define DCMI_JPEG_DISABLE ((uint32_t)0x00000000U) /*!< Mode JPEG Disabled */
  156. #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG) /*!< Mode JPEG Enabled */
  157. /**
  158. * @}
  159. */
  160. /** @defgroup DCMI_Capture_Rate DCMI Capture Rate
  161. * @{
  162. */
  163. #define DCMI_CR_ALL_FRAME ((uint32_t)0x00000000U) /*!< All frames are captured */
  164. #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0) /*!< Every alternate frame captured */
  165. #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1) /*!< One frame in 4 frames captured */
  166. /**
  167. * @}
  168. */
  169. /** @defgroup DCMI_Extended_Data_Mode DCMI Extended Data Mode
  170. * @{
  171. */
  172. #define DCMI_EXTEND_DATA_8B ((uint32_t)0x00000000U) /*!< Interface captures 8-bit data on every pixel clock */
  173. #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0) /*!< Interface captures 10-bit data on every pixel clock */
  174. #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1) /*!< Interface captures 12-bit data on every pixel clock */
  175. #define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1)) /*!< Interface captures 14-bit data on every pixel clock */
  176. /**
  177. * @}
  178. */
  179. /** @defgroup DCMI_Window_Coordinate DCMI Window Coordinate
  180. * @{
  181. */
  182. #define DCMI_WINDOW_COORDINATE ((uint32_t)0x3FFFU) /*!< Window coordinate */
  183. /**
  184. * @}
  185. */
  186. /** @defgroup DCMI_Window_Height DCMI Window Height
  187. * @{
  188. */
  189. #define DCMI_WINDOW_HEIGHT ((uint32_t)0x1FFFU) /*!< Window Height */
  190. /**
  191. * @}
  192. */
  193. /** @defgroup DCMI_Window_Vertical_Line DCMI Window Vertical Line
  194. * @{
  195. */
  196. #define DCMI_POSITION_CWSIZE_VLINE (uint32_t)POSITION_VAL(DCMI_CWSIZE_VLINE) /*!< Required left shift to set crop window vertical line count */
  197. #define DCMI_POSITION_CWSTRT_VST (uint32_t)POSITION_VAL(DCMI_CWSTRT_VST) /*!< Required left shift to set crop window vertical start line count */
  198. /**
  199. * @}
  200. */
  201. /** @defgroup DCMI_interrupt_sources DCMI interrupt sources
  202. * @{
  203. */
  204. #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE) /*!< Capture complete interrupt */
  205. #define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE) /*!< Overrun interrupt */
  206. #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE) /*!< Synchronization error interrupt */
  207. #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE) /*!< VSYNC interrupt */
  208. #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE) /*!< Line interrupt */
  209. /**
  210. * @}
  211. */
  212. /** @defgroup DCMI_Flags DCMI Flags
  213. * @{
  214. */
  215. /**
  216. * @brief DCMI SR register
  217. */
  218. #define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC) /*!< HSYNC pin state (active line / synchronization between lines) */
  219. #define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC) /*!< VSYNC pin state (active frame / synchronization between frames) */
  220. #define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE) /*!< FIFO not empty flag */
  221. /**
  222. * @brief DCMI RIS register
  223. */
  224. #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RISR_FRAME_RIS) /*!< Frame capture complete interrupt flag */
  225. #define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RISR_OVR_RIS) /*!< Overrun interrupt flag */
  226. #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RISR_ERR_RIS) /*!< Synchronization error interrupt flag */
  227. #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RISR_VSYNC_RIS) /*!< VSYNC interrupt flag */
  228. #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RISR_LINE_RIS) /*!< Line interrupt flag */
  229. /**
  230. * @brief DCMI MIS register
  231. */
  232. #define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS) /*!< DCMI Frame capture complete masked interrupt status */
  233. #define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS ) /*!< DCMI Overrun masked interrupt status */
  234. #define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS ) /*!< DCMI Synchronization error masked interrupt status */
  235. #define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS) /*!< DCMI VSYNC masked interrupt status */
  236. #define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS ) /*!< DCMI Line masked interrupt status */
  237. /**
  238. * @}
  239. */
  240. /**
  241. * @}
  242. */
  243. /* Exported macro ------------------------------------------------------------*/
  244. /** @defgroup DCMI_Exported_Macros DCMI Exported Macros
  245. * @{
  246. */
  247. /** @brief Reset DCMI handle state
  248. * @param __HANDLE__: specifies the DCMI handle.
  249. * @retval None
  250. */
  251. #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
  252. /**
  253. * @brief Enable the DCMI.
  254. * @param __HANDLE__: DCMI handle
  255. * @retval None
  256. */
  257. #define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
  258. /**
  259. * @brief Disable the DCMI.
  260. * @param __HANDLE__: DCMI handle
  261. * @retval None
  262. */
  263. #define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
  264. /* Interrupt & Flag management */
  265. /**
  266. * @brief Get the DCMI pending flag.
  267. * @param __HANDLE__: DCMI handle
  268. * @param __FLAG__: Get the specified flag.
  269. * This parameter can be one of the following values (no combination allowed)
  270. * @arg DCMI_FLAG_HSYNC: HSYNC pin state (active line / synchronization between lines)
  271. * @arg DCMI_FLAG_VSYNC: VSYNC pin state (active frame / synchronization between frames)
  272. * @arg DCMI_FLAG_FNE: FIFO empty flag
  273. * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
  274. * @arg DCMI_FLAG_OVRRI: Overrun flag mask
  275. * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
  276. * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
  277. * @arg DCMI_FLAG_LINERI: Line flag mask
  278. * @arg DCMI_FLAG_FRAMEMI: DCMI Capture complete masked interrupt status
  279. * @arg DCMI_FLAG_OVRMI: DCMI Overrun masked interrupt status
  280. * @arg DCMI_FLAG_ERRMI: DCMI Synchronization error masked interrupt status
  281. * @arg DCMI_FLAG_VSYNCMI: DCMI VSYNC masked interrupt status
  282. * @arg DCMI_FLAG_LINEMI: DCMI Line masked interrupt status
  283. * @retval The state of FLAG.
  284. */
  285. #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
  286. ((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0U)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\
  287. (((__FLAG__) & DCMI_SR_INDEX) == 0x0U)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
  288. /**
  289. * @brief Clear the DCMI pending flags.
  290. * @param __HANDLE__: DCMI handle
  291. * @param __FLAG__: specifies the flag to clear.
  292. * This parameter can be any combination of the following values:
  293. * @arg DCMI_FLAG_FRAMERI: Frame capture complete flag mask
  294. * @arg DCMI_FLAG_OVRRI: Overrun flag mask
  295. * @arg DCMI_FLAG_ERRRI: Synchronization error flag mask
  296. * @arg DCMI_FLAG_VSYNCRI: VSYNC flag mask
  297. * @arg DCMI_FLAG_LINERI: Line flag mask
  298. * @retval None
  299. */
  300. #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  301. /**
  302. * @brief Enable the specified DCMI interrupts.
  303. * @param __HANDLE__: DCMI handle
  304. * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
  305. * This parameter can be any combination of the following values:
  306. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  307. * @arg DCMI_IT_OVR: Overrun interrupt mask
  308. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  309. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  310. * @arg DCMI_IT_LINE: Line interrupt mask
  311. * @retval None
  312. */
  313. #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  314. /**
  315. * @brief Disable the specified DCMI interrupts.
  316. * @param __HANDLE__: DCMI handle
  317. * @param __INTERRUPT__: specifies the DCMI interrupt sources to be enabled.
  318. * This parameter can be any combination of the following values:
  319. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  320. * @arg DCMI_IT_OVR: Overrun interrupt mask
  321. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  322. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  323. * @arg DCMI_IT_LINE: Line interrupt mask
  324. * @retval None
  325. */
  326. #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
  327. /**
  328. * @brief Check whether the specified DCMI interrupt has occurred or not.
  329. * @param __HANDLE__: DCMI handle
  330. * @param __INTERRUPT__: specifies the DCMI interrupt source to check.
  331. * This parameter can be one of the following values:
  332. * @arg DCMI_IT_FRAME: Frame capture complete interrupt mask
  333. * @arg DCMI_IT_OVR: Overrun interrupt mask
  334. * @arg DCMI_IT_ERR: Synchronization error interrupt mask
  335. * @arg DCMI_IT_VSYNC: VSYNC interrupt mask
  336. * @arg DCMI_IT_LINE: Line interrupt mask
  337. * @retval The state of INTERRUPT.
  338. */
  339. #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
  340. /**
  341. * @}
  342. */
  343. /* Exported functions --------------------------------------------------------*/
  344. /** @addtogroup DCMI_Exported_Functions DCMI Exported Functions
  345. * @{
  346. */
  347. /** @addtogroup DCMI_Exported_Functions_Group1 Initialization and Configuration functions
  348. * @{
  349. */
  350. /* Initialization and de-initialization functions *****************************/
  351. HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
  352. HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
  353. void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
  354. void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
  355. /**
  356. * @}
  357. */
  358. /** @addtogroup DCMI_Exported_Functions_Group2 IO operation functions
  359. * @{
  360. */
  361. /* IO operation functions *****************************************************/
  362. HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
  363. HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
  364. HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi);
  365. HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi);
  366. void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
  367. void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
  368. void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
  369. void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
  370. void HAL_DCMI_VsyncCallback(DCMI_HandleTypeDef *hdcmi);
  371. void HAL_DCMI_HsyncCallback(DCMI_HandleTypeDef *hdcmi);
  372. void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
  373. /**
  374. * @}
  375. */
  376. /** @addtogroup DCMI_Exported_Functions_Group3 Peripheral Control functions
  377. * @{
  378. */
  379. /* Peripheral Control functions ***********************************************/
  380. HAL_StatusTypeDef HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
  381. HAL_StatusTypeDef HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi);
  382. HAL_StatusTypeDef HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi);
  383. /**
  384. * @}
  385. */
  386. /** @addtogroup DCMI_Exported_Functions_Group4 Peripheral State functions
  387. * @{
  388. */
  389. /* Peripheral State functions *************************************************/
  390. HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
  391. uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
  392. /**
  393. * @}
  394. */
  395. /**
  396. * @}
  397. */
  398. /* Private types -------------------------------------------------------------*/
  399. /* Private variables ---------------------------------------------------------*/
  400. /* Private constants ---------------------------------------------------------*/
  401. /** @defgroup DCMI_Private_Constants DCMI Private Constants
  402. * @{
  403. */
  404. #define DCMI_MIS_INDEX ((uint32_t)0x1000) /*!< DCMI MIS register index */
  405. #define DCMI_SR_INDEX ((uint32_t)0x2000) /*!< DCMI SR register index */
  406. /**
  407. * @}
  408. */
  409. /* Private macro -------------------------------------------------------------*/
  410. /** @defgroup DCMI_Private_Macros DCMI Private Macros
  411. * @{
  412. */
  413. #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
  414. ((MODE) == DCMI_MODE_SNAPSHOT))
  415. #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
  416. ((MODE) == DCMI_SYNCHRO_EMBEDDED))
  417. #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
  418. ((POLARITY) == DCMI_PCKPOLARITY_RISING))
  419. #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
  420. ((POLARITY) == DCMI_VSPOLARITY_HIGH))
  421. #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
  422. ((POLARITY) == DCMI_HSPOLARITY_HIGH))
  423. #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
  424. ((JPEG_MODE) == DCMI_JPEG_ENABLE))
  425. #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
  426. ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
  427. ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
  428. #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
  429. ((DATA) == DCMI_EXTEND_DATA_10B) || \
  430. ((DATA) == DCMI_EXTEND_DATA_12B) || \
  431. ((DATA) == DCMI_EXTEND_DATA_14B))
  432. #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
  433. #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
  434. /**
  435. * @}
  436. */
  437. /* Private functions ---------------------------------------------------------*/
  438. /** @addtogroup DCMI_Private_Functions DCMI Private Functions
  439. * @{
  440. */
  441. /**
  442. * @}
  443. */
  444. #endif /* STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
  445. STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx ||\
  446. STM32F479xx */
  447. /**
  448. * @}
  449. */
  450. /**
  451. * @}
  452. */
  453. #ifdef __cplusplus
  454. }
  455. #endif
  456. #endif /* __STM32F4xx_HAL_DCMI_H */
  457. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/