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