stm32f4xx_hal_dcmi.h File Reference

Header file of DCMI HAL module. More...

Go to the source code of this file.

Data Structures
struct	__DCMI_HandleTypeDef
	DCMI handle Structure definition. More...

Typedefs
typedef struct __DCMI_HandleTypeDef	DCMI_HandleTypeDef
	DCMI handle Structure definition.
typedef void(*	pDCMI_CallbackTypeDef) (DCMI_HandleTypeDef *hdcmi)

Enumerations
enum	HAL_DCMI_StateTypeDef {   HAL_DCMI_STATE_RESET = 0x00U , HAL_DCMI_STATE_READY = 0x01U , HAL_DCMI_STATE_BUSY = 0x02U , HAL_DCMI_STATE_TIMEOUT = 0x03U ,   HAL_DCMI_STATE_ERROR = 0x04U , HAL_DCMI_STATE_SUSPENDED = 0x05U }
	HAL DCMI State structures definition. More...
enum	HAL_DCMI_CallbackIDTypeDef {   HAL_DCMI_FRAME_EVENT_CB_ID = 0x00U , HAL_DCMI_VSYNC_EVENT_CB_ID = 0x01U , HAL_DCMI_LINE_EVENT_CB_ID = 0x02U , HAL_DCMI_ERROR_CB_ID = 0x03U ,   HAL_DCMI_MSPINIT_CB_ID = 0x04U , HAL_DCMI_MSPDEINIT_CB_ID = 0x05U }

Functions
HAL_StatusTypeDef	HAL_DCMI_Init (DCMI_HandleTypeDef *hdcmi)
	Initializes the DCMI according to the specified parameters in the DCMI_InitTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_DCMI_DeInit (DCMI_HandleTypeDef *hdcmi)
	Deinitializes the DCMI peripheral registers to their default reset values. More...
void	HAL_DCMI_MspInit (DCMI_HandleTypeDef *hdcmi)
	Initializes the DCMI MSP. More...
void	HAL_DCMI_MspDeInit (DCMI_HandleTypeDef *hdcmi)
	DeInitializes the DCMI MSP. More...
HAL_StatusTypeDef	HAL_DCMI_RegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback)
	DCMI Callback registering. More...
HAL_StatusTypeDef	HAL_DCMI_UnRegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID)
	DCMI Callback Unregistering. More...
HAL_StatusTypeDef	HAL_DCMI_Start_DMA (DCMI_HandleTypeDef *hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length)
	Enables DCMI DMA request and enables DCMI capture. More...
HAL_StatusTypeDef	HAL_DCMI_Stop (DCMI_HandleTypeDef *hdcmi)
	Disable DCMI DMA request and Disable DCMI capture. More...
HAL_StatusTypeDef	HAL_DCMI_Suspend (DCMI_HandleTypeDef *hdcmi)
	Suspend DCMI capture More...
HAL_StatusTypeDef	HAL_DCMI_Resume (DCMI_HandleTypeDef *hdcmi)
	Resume DCMI capture More...
void	HAL_DCMI_ErrorCallback (DCMI_HandleTypeDef *hdcmi)
	Error DCMI callback. More...
void	HAL_DCMI_LineEventCallback (DCMI_HandleTypeDef *hdcmi)
	Line Event callback. More...
void	HAL_DCMI_FrameEventCallback (DCMI_HandleTypeDef *hdcmi)
	Frame Event callback. More...
void	HAL_DCMI_VsyncEventCallback (DCMI_HandleTypeDef *hdcmi)
	VSYNC Event callback. More...
void	HAL_DCMI_VsyncCallback (DCMI_HandleTypeDef *hdcmi)
void	HAL_DCMI_HsyncCallback (DCMI_HandleTypeDef *hdcmi)
void	HAL_DCMI_IRQHandler (DCMI_HandleTypeDef *hdcmi)
	Handles DCMI interrupt request. More...
HAL_StatusTypeDef	HAL_DCMI_ConfigCrop (DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize)
	Configure the DCMI CROP coordinate. More...
HAL_StatusTypeDef	HAL_DCMI_EnableCrop (DCMI_HandleTypeDef *hdcmi)
	Enable the Crop feature. More...
HAL_StatusTypeDef	HAL_DCMI_DisableCrop (DCMI_HandleTypeDef *hdcmi)
	Disable the Crop feature. More...
HAL_StatusTypeDef	HAL_DCMI_ConfigSyncUnmask (DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask)
	Set embedded synchronization delimiters unmasks. More...
HAL_DCMI_StateTypeDef	HAL_DCMI_GetState (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI state. More...
uint32_t	HAL_DCMI_GetError (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI error code. More...

Variables
	C

Detailed Description

Header file of DCMI HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_dcmi.h.

Enumeration Type Documentation

HAL_DCMI_CallbackIDTypeDef

enum HAL_DCMI_CallbackIDTypeDef

Enumerator
HAL_DCMI_FRAME_EVENT_CB_ID	DCMI Frame Event Callback ID
HAL_DCMI_VSYNC_EVENT_CB_ID	DCMI Vsync Event Callback ID
HAL_DCMI_LINE_EVENT_CB_ID	DCMI Line Event Callback ID
HAL_DCMI_ERROR_CB_ID	DCMI Error Callback ID
HAL_DCMI_MSPINIT_CB_ID	DCMI MspInit callback ID
HAL_DCMI_MSPDEINIT_CB_ID	DCMI MspDeInit callback ID

Definition at line 107 of file stm32f4xx_hal_dcmi.h.

HAL_DCMI_StateTypeDef

enum HAL_DCMI_StateTypeDef

HAL DCMI State structures definition.

Enumerator
HAL_DCMI_STATE_RESET	DCMI not yet initialized or disabled
HAL_DCMI_STATE_READY	DCMI initialized and ready for use
HAL_DCMI_STATE_BUSY	DCMI internal processing is ongoing
HAL_DCMI_STATE_TIMEOUT	DCMI timeout state
HAL_DCMI_STATE_ERROR	DCMI error state
HAL_DCMI_STATE_SUSPENDED	DCMI suspend state

Definition at line 62 of file stm32f4xx_hal_dcmi.h.

Variable Documentation

C

C

extern

Initial value:

{
#endif
 
#if defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) ||\
    defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
    defined(STM32F479xx)
 
#include "stm32f4xx_hal_def.h"
 
 
 
#include "stm32f4xx_hal_dcmi_ex.h"
 
 
 
 
 
 
 
 
typedef struct
{
  uint8_t FrameStartUnmask; 
  uint8_t LineStartUnmask;  
  uint8_t LineEndUnmask;    
  uint8_t FrameEndUnmask;   
}DCMI_SyncUnmaskTypeDef