stm32f4xx_hal_dcmi.h 23 KB

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