STM32F4xx HAL Driver master
STM32CubeF4 HAL / LL Drivers API Reference
Loading...
Searching...
No Matches
stm32f4xx_hal_dcmi.h
Go to the documentation of this file.
1
17
18/* Define to prevent recursive inclusion -------------------------------------*/
19#ifndef __STM32F4xx_HAL_DCMI_H
20#define __STM32F4xx_HAL_DCMI_H
21
22#ifdef __cplusplus
23 extern "C" {
24#endif
25
26#if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
27 defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
28 defined(STM32F479xx)
29/* Includes ------------------------------------------------------------------*/
30#include "stm32f4xx_hal_def.h"
31
32/* Include DCMI HAL Extended module */
33/* (include on top of file since DCMI structures are defined in extended file) */
34#include "stm32f4xx_hal_dcmi_ex.h"
35
39
44
45/* Exported types ------------------------------------------------------------*/
52typedef struct
53{
54 uint8_t FrameStartUnmask;
55 uint8_t LineStartUnmask;
56 uint8_t LineEndUnmask;
57 uint8_t FrameEndUnmask;
58}DCMI_SyncUnmaskTypeDef;
62typedef enum
63{
64 HAL_DCMI_STATE_RESET = 0x00U,
65 HAL_DCMI_STATE_READY = 0x01U,
66 HAL_DCMI_STATE_BUSY = 0x02U,
67 HAL_DCMI_STATE_TIMEOUT = 0x03U,
68 HAL_DCMI_STATE_ERROR = 0x04U,
69 HAL_DCMI_STATE_SUSPENDED = 0x05U
70}HAL_DCMI_StateTypeDef;
71
75typedef struct __DCMI_HandleTypeDef
76{
77 DCMI_TypeDef *Instance;
78
79 DCMI_InitTypeDef Init;
80
81 HAL_LockTypeDef Lock;
82
83 __IO HAL_DCMI_StateTypeDef State;
84
85 __IO uint32_t XferCount;
86
87 __IO uint32_t XferSize;
88
89 uint32_t XferTransferNumber;
90
91 uint32_t pBuffPtr;
92
93 DMA_HandleTypeDef *DMA_Handle;
94
95 __IO uint32_t ErrorCode;
96#if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
97 void (* FrameEventCallback) ( struct __DCMI_HandleTypeDef *hdcmi);
98 void (* VsyncEventCallback) ( struct __DCMI_HandleTypeDef *hdcmi);
99 void (* LineEventCallback ) ( struct __DCMI_HandleTypeDef *hdcmi);
100 void (* ErrorCallback) ( struct __DCMI_HandleTypeDef *hdcmi);
101 void (* MspInitCallback) ( struct __DCMI_HandleTypeDef *hdcmi);
102 void (* MspDeInitCallback) ( struct __DCMI_HandleTypeDef *hdcmi);
103#endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
104}DCMI_HandleTypeDef;
105
106#if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
107typedef enum
108{
109 HAL_DCMI_FRAME_EVENT_CB_ID = 0x00U,
110 HAL_DCMI_VSYNC_EVENT_CB_ID = 0x01U,
111 HAL_DCMI_LINE_EVENT_CB_ID = 0x02U,
112 HAL_DCMI_ERROR_CB_ID = 0x03U,
113 HAL_DCMI_MSPINIT_CB_ID = 0x04U,
114 HAL_DCMI_MSPDEINIT_CB_ID = 0x05U
115
116}HAL_DCMI_CallbackIDTypeDef;
117
118typedef void (*pDCMI_CallbackTypeDef)(DCMI_HandleTypeDef *hdcmi);
119#endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
120
121
125
126/* Exported constants --------------------------------------------------------*/
130
134#define HAL_DCMI_ERROR_NONE 0x00000000U
135#define HAL_DCMI_ERROR_OVR 0x00000001U
136#define HAL_DCMI_ERROR_SYNC 0x00000002U
137#define HAL_DCMI_ERROR_TIMEOUT 0x00000020U
138#define HAL_DCMI_ERROR_DMA 0x00000040U
139#if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
140#define HAL_DCMI_ERROR_INVALID_CALLBACK ((uint32_t)0x00000080U)
141#endif
145
149#define DCMI_MODE_CONTINUOUS 0x00000000U
151#define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM)
156
160#define DCMI_SYNCHRO_HARDWARE 0x00000000U
162#define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS)
164
168
172#define DCMI_PCKPOLARITY_FALLING 0x00000000U
173#define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL)
174
178
182#define DCMI_VSPOLARITY_LOW 0x00000000U
183#define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL)
184
188
192#define DCMI_HSPOLARITY_LOW 0x00000000U
193#define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL)
194
198
202#define DCMI_JPEG_DISABLE 0x00000000U
203#define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG)
204
208
212#define DCMI_CR_ALL_FRAME 0x00000000U
213#define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0)
214#define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1)
215
219
223#define DCMI_EXTEND_DATA_8B 0x00000000U
224#define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0)
225#define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1)
226#define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1))
227
231
235#define DCMI_WINDOW_COORDINATE 0x3FFFU
236
240
244#define DCMI_WINDOW_HEIGHT 0x1FFFU
245
249
253#define DCMI_POSITION_CWSIZE_VLINE (uint32_t)DCMI_CWSIZE_VLINE_Pos
254#define DCMI_POSITION_CWSTRT_VST (uint32_t)DCMI_CWSTRT_VST_Pos
255
259
263#define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE)
264#define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE)
265#define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE)
266#define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE)
267#define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE)
271
275
279#define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC)
280#define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC)
281#define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE)
285#define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RISR_FRAME_RIS)
286#define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RISR_OVR_RIS)
287#define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RISR_ERR_RIS)
288#define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RISR_VSYNC_RIS)
289#define DCMI_FLAG_LINERI ((uint32_t)DCMI_RISR_LINE_RIS)
293#define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS)
294#define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS )
295#define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS )
296#define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS)
297#define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS )
301
305
306/* Exported macro ------------------------------------------------------------*/
310
315#define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) do{ \
316 (__HANDLE__)->State = HAL_DCMI_STATE_RESET; \
317 (__HANDLE__)->MspInitCallback = NULL; \
318 (__HANDLE__)->MspDeInitCallback = NULL; \
319 } while(0)
320
326#define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
327
333#define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
334
335/* Interrupt & Flag management */
356#define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
357((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0U)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\
358 (((__FLAG__) & DCMI_SR_INDEX) == 0x0U)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
359
372#define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
373
386#define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
387
400#define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
401
414#define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
415
419
420/* Exported functions --------------------------------------------------------*/
424
428/* Initialization and de-initialization functions *****************************/
429HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
430HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
431void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
432void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
433
434/* Callbacks Register/UnRegister functions ***********************************/
435#if (USE_HAL_DCMI_REGISTER_CALLBACKS == 1)
436HAL_StatusTypeDef HAL_DCMI_RegisterCallback(DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback);
437HAL_StatusTypeDef HAL_DCMI_UnRegisterCallback(DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID);
438#endif /* USE_HAL_DCMI_REGISTER_CALLBACKS */
442
446/* IO operation functions *****************************************************/
447HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
448HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
449HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi);
450HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi);
451void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
452void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
453void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
454void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
455void HAL_DCMI_VsyncCallback(DCMI_HandleTypeDef *hdcmi);
456void HAL_DCMI_HsyncCallback(DCMI_HandleTypeDef *hdcmi);
457void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
461
465/* Peripheral Control functions ***********************************************/
466HAL_StatusTypeDef HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
467HAL_StatusTypeDef HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi);
468HAL_StatusTypeDef HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi);
469HAL_StatusTypeDef HAL_DCMI_ConfigSyncUnmask(DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask);
473
477/* Peripheral State functions *************************************************/
478HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
479uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
483
487
488/* Private types -------------------------------------------------------------*/
489/* Private variables ---------------------------------------------------------*/
490/* Private constants ---------------------------------------------------------*/
494#define DCMI_MIS_INDEX 0x1000U
495#define DCMI_SR_INDEX 0x2000U
499/* Private macro -------------------------------------------------------------*/
503#define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
504 ((MODE) == DCMI_MODE_SNAPSHOT))
505
506#define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
507 ((MODE) == DCMI_SYNCHRO_EMBEDDED))
508
509#define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
510 ((POLARITY) == DCMI_PCKPOLARITY_RISING))
511
512#define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
513 ((POLARITY) == DCMI_VSPOLARITY_HIGH))
514
515#define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
516 ((POLARITY) == DCMI_HSPOLARITY_HIGH))
517
518#define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
519 ((JPEG_MODE) == DCMI_JPEG_ENABLE))
520
521#define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
522 ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
523 ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
524
525#define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
526 ((DATA) == DCMI_EXTEND_DATA_10B) || \
527 ((DATA) == DCMI_EXTEND_DATA_12B) || \
528 ((DATA) == DCMI_EXTEND_DATA_14B))
529
530#define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
531
532#define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
533
537
538/* Private functions ---------------------------------------------------------*/
542
546
547#endif /* STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
548 STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx ||\
549 STM32F479xx */
550
554
558
559#ifdef __cplusplus
560}
561#endif
562
563#endif /* __STM32F4xx_HAL_DCMI_H */
DMA_HandleTypeDef
struct __DMA_HandleTypeDef DMA_HandleTypeDef
DMA handle Structure definition.
stm32f4xx_hal_dcmi_ex.h
Header file of DCMI Extension HAL module.
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition stm32f4xx_hal_def.h:39
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition stm32f4xx_hal_def.h:50