STM CMSIS
stm32f4xx_hal_dcmi.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_DCMI_H
40 #define __STM32F4xx_HAL_DCMI_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 #if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
47  defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
48  defined(STM32F479xx)
49 /* Includes ------------------------------------------------------------------*/
50 #include "stm32f4xx_hal_def.h"
51 
52 /* Include DCMI HAL Extended module */
53 /* (include on top of file since DCMI structures are defined in extended file) */
54 #include "stm32f4xx_hal_dcmi_ex.h"
55 
65 /* Exported types ------------------------------------------------------------*/
72 typedef enum
73 {
74  HAL_DCMI_STATE_RESET = 0x00U,
75  HAL_DCMI_STATE_READY = 0x01U,
76  HAL_DCMI_STATE_BUSY = 0x02U,
77  HAL_DCMI_STATE_TIMEOUT = 0x03U,
78  HAL_DCMI_STATE_ERROR = 0x04U,
79  HAL_DCMI_STATE_SUSPENDED = 0x05U
80 }HAL_DCMI_StateTypeDef;
81 
85 typedef struct
86 {
87  DCMI_TypeDef *Instance;
89  DCMI_InitTypeDef Init;
91  HAL_LockTypeDef Lock;
93  __IO HAL_DCMI_StateTypeDef State;
95  __IO uint32_t XferCount;
97  __IO uint32_t XferSize;
99  uint32_t XferTransferNumber;
101  uint32_t pBuffPtr;
103  DMA_HandleTypeDef *DMA_Handle;
105  __IO uint32_t ErrorCode;
107 }DCMI_HandleTypeDef;
112 /* Exported constants --------------------------------------------------------*/
120 #define HAL_DCMI_ERROR_NONE ((uint32_t)0x00000000U)
121 #define HAL_DCMI_ERROR_OVR ((uint32_t)0x00000001U)
122 #define HAL_DCMI_ERROR_SYNC ((uint32_t)0x00000002U)
123 #define HAL_DCMI_ERROR_TIMEOUT ((uint32_t)0x00000020U)
124 #define HAL_DCMI_ERROR_DMA ((uint32_t)0x00000040U)
132 #define DCMI_MODE_CONTINUOUS ((uint32_t)0x00000000U)
134 #define DCMI_MODE_SNAPSHOT ((uint32_t)DCMI_CR_CM)
143 #define DCMI_SYNCHRO_HARDWARE ((uint32_t)0x00000000U)
145 #define DCMI_SYNCHRO_EMBEDDED ((uint32_t)DCMI_CR_ESS)
155 #define DCMI_PCKPOLARITY_FALLING ((uint32_t)0x00000000U)
156 #define DCMI_PCKPOLARITY_RISING ((uint32_t)DCMI_CR_PCKPOL)
165 #define DCMI_VSPOLARITY_LOW ((uint32_t)0x00000000U)
166 #define DCMI_VSPOLARITY_HIGH ((uint32_t)DCMI_CR_VSPOL)
175 #define DCMI_HSPOLARITY_LOW ((uint32_t)0x00000000U)
176 #define DCMI_HSPOLARITY_HIGH ((uint32_t)DCMI_CR_HSPOL)
185 #define DCMI_JPEG_DISABLE ((uint32_t)0x00000000U)
186 #define DCMI_JPEG_ENABLE ((uint32_t)DCMI_CR_JPEG)
195 #define DCMI_CR_ALL_FRAME ((uint32_t)0x00000000U)
196 #define DCMI_CR_ALTERNATE_2_FRAME ((uint32_t)DCMI_CR_FCRC_0)
197 #define DCMI_CR_ALTERNATE_4_FRAME ((uint32_t)DCMI_CR_FCRC_1)
206 #define DCMI_EXTEND_DATA_8B ((uint32_t)0x00000000U)
207 #define DCMI_EXTEND_DATA_10B ((uint32_t)DCMI_CR_EDM_0)
208 #define DCMI_EXTEND_DATA_12B ((uint32_t)DCMI_CR_EDM_1)
209 #define DCMI_EXTEND_DATA_14B ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1))
218 #define DCMI_WINDOW_COORDINATE ((uint32_t)0x3FFFU)
227 #define DCMI_WINDOW_HEIGHT ((uint32_t)0x1FFFU)
236 #define DCMI_POSITION_CWSIZE_VLINE (uint32_t)POSITION_VAL(DCMI_CWSIZE_VLINE)
237 #define DCMI_POSITION_CWSTRT_VST (uint32_t)POSITION_VAL(DCMI_CWSTRT_VST)
246 #define DCMI_IT_FRAME ((uint32_t)DCMI_IER_FRAME_IE)
247 #define DCMI_IT_OVR ((uint32_t)DCMI_IER_OVR_IE)
248 #define DCMI_IT_ERR ((uint32_t)DCMI_IER_ERR_IE)
249 #define DCMI_IT_VSYNC ((uint32_t)DCMI_IER_VSYNC_IE)
250 #define DCMI_IT_LINE ((uint32_t)DCMI_IER_LINE_IE)
262 #define DCMI_FLAG_HSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC)
263 #define DCMI_FLAG_VSYNC ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC)
264 #define DCMI_FLAG_FNE ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE)
268 #define DCMI_FLAG_FRAMERI ((uint32_t)DCMI_RISR_FRAME_RIS)
269 #define DCMI_FLAG_OVRRI ((uint32_t)DCMI_RISR_OVR_RIS)
270 #define DCMI_FLAG_ERRRI ((uint32_t)DCMI_RISR_ERR_RIS)
271 #define DCMI_FLAG_VSYNCRI ((uint32_t)DCMI_RISR_VSYNC_RIS)
272 #define DCMI_FLAG_LINERI ((uint32_t)DCMI_RISR_LINE_RIS)
276 #define DCMI_FLAG_FRAMEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS)
277 #define DCMI_FLAG_OVRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS )
278 #define DCMI_FLAG_ERRMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS )
279 #define DCMI_FLAG_VSYNCMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS)
280 #define DCMI_FLAG_LINEMI ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS )
289 /* Exported macro ------------------------------------------------------------*/
290 
298 #define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
299 
305 #define __HAL_DCMI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
306 
312 #define __HAL_DCMI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
313 
314 /* Interrupt & Flag management */
335 #define __HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)\
336 ((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0U)? ((__HANDLE__)->Instance->RIS & (__FLAG__)) :\
337  (((__FLAG__) & DCMI_SR_INDEX) == 0x0U)? ((__HANDLE__)->Instance->MIS & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))
338 
351 #define __HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
352 
365 #define __HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
366 
379 #define __HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
380 
393 #define __HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
394 
399 /* Exported functions --------------------------------------------------------*/
407 /* Initialization and de-initialization functions *****************************/
408 HAL_StatusTypeDef HAL_DCMI_Init(DCMI_HandleTypeDef *hdcmi);
409 HAL_StatusTypeDef HAL_DCMI_DeInit(DCMI_HandleTypeDef *hdcmi);
410 void HAL_DCMI_MspInit(DCMI_HandleTypeDef* hdcmi);
411 void HAL_DCMI_MspDeInit(DCMI_HandleTypeDef* hdcmi);
419 /* IO operation functions *****************************************************/
420 HAL_StatusTypeDef HAL_DCMI_Start_DMA(DCMI_HandleTypeDef* hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length);
421 HAL_StatusTypeDef HAL_DCMI_Stop(DCMI_HandleTypeDef* hdcmi);
422 HAL_StatusTypeDef HAL_DCMI_Suspend(DCMI_HandleTypeDef* hdcmi);
423 HAL_StatusTypeDef HAL_DCMI_Resume(DCMI_HandleTypeDef* hdcmi);
424 void HAL_DCMI_ErrorCallback(DCMI_HandleTypeDef *hdcmi);
425 void HAL_DCMI_LineEventCallback(DCMI_HandleTypeDef *hdcmi);
426 void HAL_DCMI_FrameEventCallback(DCMI_HandleTypeDef *hdcmi);
427 void HAL_DCMI_VsyncEventCallback(DCMI_HandleTypeDef *hdcmi);
428 void HAL_DCMI_VsyncCallback(DCMI_HandleTypeDef *hdcmi);
429 void HAL_DCMI_HsyncCallback(DCMI_HandleTypeDef *hdcmi);
430 void HAL_DCMI_IRQHandler(DCMI_HandleTypeDef *hdcmi);
438 /* Peripheral Control functions ***********************************************/
439 HAL_StatusTypeDef HAL_DCMI_ConfigCrop(DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize);
440 HAL_StatusTypeDef HAL_DCMI_EnableCrop(DCMI_HandleTypeDef *hdcmi);
441 HAL_StatusTypeDef HAL_DCMI_DisableCrop(DCMI_HandleTypeDef *hdcmi);
449 /* Peripheral State functions *************************************************/
450 HAL_DCMI_StateTypeDef HAL_DCMI_GetState(DCMI_HandleTypeDef *hdcmi);
451 uint32_t HAL_DCMI_GetError(DCMI_HandleTypeDef *hdcmi);
460 /* Private types -------------------------------------------------------------*/
461 /* Private variables ---------------------------------------------------------*/
462 /* Private constants ---------------------------------------------------------*/
466 #define DCMI_MIS_INDEX ((uint32_t)0x1000)
467 #define DCMI_SR_INDEX ((uint32_t)0x2000)
471 /* Private macro -------------------------------------------------------------*/
472 
475 #define IS_DCMI_CAPTURE_MODE(MODE)(((MODE) == DCMI_MODE_CONTINUOUS) || \
476  ((MODE) == DCMI_MODE_SNAPSHOT))
477 
478 #define IS_DCMI_SYNCHRO(MODE)(((MODE) == DCMI_SYNCHRO_HARDWARE) || \
479  ((MODE) == DCMI_SYNCHRO_EMBEDDED))
480 
481 #define IS_DCMI_PCKPOLARITY(POLARITY)(((POLARITY) == DCMI_PCKPOLARITY_FALLING) || \
482  ((POLARITY) == DCMI_PCKPOLARITY_RISING))
483 
484 #define IS_DCMI_VSPOLARITY(POLARITY)(((POLARITY) == DCMI_VSPOLARITY_LOW) || \
485  ((POLARITY) == DCMI_VSPOLARITY_HIGH))
486 
487 #define IS_DCMI_HSPOLARITY(POLARITY)(((POLARITY) == DCMI_HSPOLARITY_LOW) || \
488  ((POLARITY) == DCMI_HSPOLARITY_HIGH))
489 
490 #define IS_DCMI_MODE_JPEG(JPEG_MODE)(((JPEG_MODE) == DCMI_JPEG_DISABLE) || \
491  ((JPEG_MODE) == DCMI_JPEG_ENABLE))
492 
493 #define IS_DCMI_CAPTURE_RATE(RATE) (((RATE) == DCMI_CR_ALL_FRAME) || \
494  ((RATE) == DCMI_CR_ALTERNATE_2_FRAME) || \
495  ((RATE) == DCMI_CR_ALTERNATE_4_FRAME))
496 
497 #define IS_DCMI_EXTENDED_DATA(DATA)(((DATA) == DCMI_EXTEND_DATA_8B) || \
498  ((DATA) == DCMI_EXTEND_DATA_10B) || \
499  ((DATA) == DCMI_EXTEND_DATA_12B) || \
500  ((DATA) == DCMI_EXTEND_DATA_14B))
501 
502 #define IS_DCMI_WINDOW_COORDINATE(COORDINATE) ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
503 
504 #define IS_DCMI_WINDOW_HEIGHT(HEIGHT) ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
505 
510 /* Private functions ---------------------------------------------------------*/
519 #endif /* STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
520  STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx ||\
521  STM32F479xx */
522 
531 #ifdef __cplusplus
532 }
533 #endif
534 
535 #endif /* __STM32F4xx_HAL_DCMI_H */
536 
537 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
stm32f4xx_hal_dcmi_ex.h
Header file of DCMI Extension HAL module.
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57
__IO
#define __IO
Definition: core_cm0.h:213
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f4xx_hal_def.h:68
DCMI_TypeDef
DCMI.
Definition: stm32f407xx.h:344
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f4xx_hal_dma.h:157