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