stm32h7xx_hal_dcmi.h File Reference

Header file of DCMI HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	DCMI_CodesInitTypeDef
	DCMI Embedded Synchronisation CODE Init structure definition. More...
struct	DCMI_SyncUnmaskTypeDef
	DCMI Embedded Synchronisation UNMASK Init structure definition. More...
struct	DCMI_InitTypeDef
	DCMI Init structure definition. More...
struct	__DCMI_HandleTypeDef
	DCMI handle Structure definition. More...
Defines
#define	HAL_DCMI_ERROR_NONE   (0x00000000U)
#define	HAL_DCMI_ERROR_OVR   (0x00000001U)
#define	HAL_DCMI_ERROR_SYNC   (0x00000002U)
#define	HAL_DCMI_ERROR_TIMEOUT   (0x00000020U)
#define	HAL_DCMI_ERROR_DMA   (0x00000040U)
#define	HAL_DCMI_ERROR_INVALID_CALLBACK   (0x00000080U)
#define	DCMI_MODE_CONTINUOUS   (0x00000000U)
#define	DCMI_MODE_SNAPSHOT   ((uint32_t)DCMI_CR_CM)
#define	DCMI_SYNCHRO_HARDWARE   (0x00000000U)
#define	DCMI_SYNCHRO_EMBEDDED   ((uint32_t)DCMI_CR_ESS)
#define	DCMI_PCKPOLARITY_FALLING   (0x00000000U)
#define	DCMI_PCKPOLARITY_RISING   ((uint32_t)DCMI_CR_PCKPOL)
#define	DCMI_VSPOLARITY_LOW   (0x00000000U)
#define	DCMI_VSPOLARITY_HIGH   ((uint32_t)DCMI_CR_VSPOL)
#define	DCMI_HSPOLARITY_LOW   (0x00000000U)
#define	DCMI_HSPOLARITY_HIGH   ((uint32_t)DCMI_CR_HSPOL)
#define	DCMI_JPEG_DISABLE   (0x00000000U)
#define	DCMI_JPEG_ENABLE   ((uint32_t)DCMI_CR_JPEG)
#define	DCMI_CR_ALL_FRAME   (0x00000000U)
#define	DCMI_CR_ALTERNATE_2_FRAME   ((uint32_t)DCMI_CR_FCRC_0)
#define	DCMI_CR_ALTERNATE_4_FRAME   ((uint32_t)DCMI_CR_FCRC_1)
#define	DCMI_EXTEND_DATA_8B   (0x00000000U)
#define	DCMI_EXTEND_DATA_10B   ((uint32_t)DCMI_CR_EDM_0)
#define	DCMI_EXTEND_DATA_12B   ((uint32_t)DCMI_CR_EDM_1)
#define	DCMI_EXTEND_DATA_14B   ((uint32_t)(DCMI_CR_EDM_0 | DCMI_CR_EDM_1))
#define	DCMI_WINDOW_COORDINATE   (0x3FFFU)
#define	DCMI_WINDOW_HEIGHT   (0x1FFFU)
#define	DCMI_IT_FRAME   ((uint32_t)DCMI_IER_FRAME_IE)
#define	DCMI_IT_OVR   ((uint32_t)DCMI_IER_OVR_IE)
#define	DCMI_IT_ERR   ((uint32_t)DCMI_IER_ERR_IE)
#define	DCMI_IT_VSYNC   ((uint32_t)DCMI_IER_VSYNC_IE)
#define	DCMI_IT_LINE   ((uint32_t)DCMI_IER_LINE_IE)
#define	DCMI_FLAG_HSYNC   ((uint32_t)DCMI_SR_INDEX|DCMI_SR_HSYNC)
	DCMI SR register.
#define	DCMI_FLAG_VSYNC   ((uint32_t)DCMI_SR_INDEX|DCMI_SR_VSYNC)
#define	DCMI_FLAG_FNE   ((uint32_t)DCMI_SR_INDEX|DCMI_SR_FNE)
#define	DCMI_FLAG_FRAMERI   ((uint32_t)DCMI_RIS_FRAME_RIS)
	DCMI RIS register.
#define	DCMI_FLAG_OVRRI   ((uint32_t)DCMI_RIS_OVR_RIS)
#define	DCMI_FLAG_ERRRI   ((uint32_t)DCMI_RIS_ERR_RIS)
#define	DCMI_FLAG_VSYNCRI   ((uint32_t)DCMI_RIS_VSYNC_RIS)
#define	DCMI_FLAG_LINERI   ((uint32_t)DCMI_RIS_LINE_RIS)
#define	DCMI_FLAG_FRAMEMI   ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_FRAME_MIS)
	DCMI MIS register.
#define	DCMI_FLAG_OVRMI   ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_OVR_MIS )
#define	DCMI_FLAG_ERRMI   ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_ERR_MIS )
#define	DCMI_FLAG_VSYNCMI   ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_VSYNC_MIS)
#define	DCMI_FLAG_LINEMI   ((uint32_t)DCMI_MIS_INDEX|DCMI_MIS_LINE_MIS )
#define	DCMI_BSM_ALL   (0x00000000U)
#define	DCMI_BSM_OTHER   ((uint32_t)DCMI_CR_BSM_0)
#define	DCMI_BSM_ALTERNATE_4   ((uint32_t)DCMI_CR_BSM_1)
#define	DCMI_BSM_ALTERNATE_2   ((uint32_t)(DCMI_CR_BSM_0 | DCMI_CR_BSM_1))
#define	DCMI_OEBS_ODD   (0x00000000U)
#define	DCMI_OEBS_EVEN   ((uint32_t)DCMI_CR_OEBS)
#define	DCMI_LSM_ALL   (0x00000000U)
#define	DCMI_LSM_ALTERNATE_2   ((uint32_t)DCMI_CR_LSM)
#define	DCMI_OELS_ODD   (0x00000000U)
#define	DCMI_OELS_EVEN   ((uint32_t)DCMI_CR_OELS)
#define	__HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__)
	Reset DCMI handle state.
#define	__HAL_DCMI_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)
	Enable the DCMI.
#define	__HAL_DCMI_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))
	Disable the DCMI.
#define	__HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)
	Get the DCMI pending flag.
#define	__HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
	Clear the DCMI pending flags.
#define	__HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
	Enable the specified DCMI interrupts.
#define	__HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))
	Disable the specified DCMI interrupts.
#define	__HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->MISR & (__INTERRUPT__))
	Check whether the specified DCMI interrupt has occurred or not.
#define	DCMI_MIS_INDEX   ((uint32_t)0x1000)
#define	DCMI_SR_INDEX   ((uint32_t)0x2000)
#define	IS_DCMI_CAPTURE_MODE(MODE)
#define	IS_DCMI_SYNCHRO(MODE)
#define	IS_DCMI_PCKPOLARITY(POLARITY)
#define	IS_DCMI_VSPOLARITY(POLARITY)
#define	IS_DCMI_HSPOLARITY(POLARITY)
#define	IS_DCMI_MODE_JPEG(JPEG_MODE)
#define	IS_DCMI_CAPTURE_RATE(RATE)
#define	IS_DCMI_EXTENDED_DATA(DATA)
#define	IS_DCMI_WINDOW_COORDINATE(COORDINATE)   ((COORDINATE) <= DCMI_WINDOW_COORDINATE)
#define	IS_DCMI_WINDOW_HEIGHT(HEIGHT)   ((HEIGHT) <= DCMI_WINDOW_HEIGHT)
#define	IS_DCMI_BYTE_SELECT_MODE(MODE)
#define	IS_DCMI_BYTE_SELECT_START(POLARITY)
#define	IS_DCMI_LINE_SELECT_MODE(MODE)
#define	IS_DCMI_LINE_SELECT_START(POLARITY)
Typedefs
typedef struct __DCMI_HandleTypeDef	DCMI_HandleTypeDef
	DCMI handle Structure definition.
typedef void(*	pDCMI_CallbackTypeDef )(DCMI_HandleTypeDef *hdcmi)
	HAL DCMI Callback pointer definition.
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 }
	HAL DCMI Callback ID enumeration definition. More...
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.
HAL_StatusTypeDef	HAL_DCMI_DeInit (DCMI_HandleTypeDef *hdcmi)
	Deinitializes the DCMI peripheral registers to their default reset values.
__weak void	HAL_DCMI_MspInit (DCMI_HandleTypeDef *hdcmi)
	Initializes the DCMI MSP.
__weak void	HAL_DCMI_MspDeInit (DCMI_HandleTypeDef *hdcmi)
	DeInitializes the DCMI MSP.
HAL_StatusTypeDef	HAL_DCMI_RegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback)
	Register a User DCMI Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_DCMI_UnRegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID)
	Unregister a DCMI Callback DCMI callabck is redirected to the weak predefined callback.
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.
HAL_StatusTypeDef	HAL_DCMI_Stop (DCMI_HandleTypeDef *hdcmi)
	Disable DCMI DMA request and Disable DCMI capture.
HAL_StatusTypeDef	HAL_DCMI_Suspend (DCMI_HandleTypeDef *hdcmi)
	Suspend DCMI capture.
HAL_StatusTypeDef	HAL_DCMI_Resume (DCMI_HandleTypeDef *hdcmi)
	Resume DCMI capture.
__weak void	HAL_DCMI_ErrorCallback (DCMI_HandleTypeDef *hdcmi)
	Error DCMI callback.
__weak void	HAL_DCMI_LineEventCallback (DCMI_HandleTypeDef *hdcmi)
	Line Event callback.
__weak void	HAL_DCMI_FrameEventCallback (DCMI_HandleTypeDef *hdcmi)
	Frame Event callback.
__weak void	HAL_DCMI_VsyncEventCallback (DCMI_HandleTypeDef *hdcmi)
	VSYNC Event callback.
void	HAL_DCMI_IRQHandler (DCMI_HandleTypeDef *hdcmi)
	Handles DCMI interrupt request.
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.
HAL_StatusTypeDef	HAL_DCMI_EnableCrop (DCMI_HandleTypeDef *hdcmi)
	Enable the Crop feature.
HAL_StatusTypeDef	HAL_DCMI_DisableCrop (DCMI_HandleTypeDef *hdcmi)
	Disable the Crop feature.
HAL_StatusTypeDef	HAL_DCMI_ConfigSyncUnmask (DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask)
	Set embedded synchronization delimiters unmasks.
HAL_DCMI_StateTypeDef	HAL_DCMI_GetState (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI state.
uint32_t	HAL_DCMI_GetError (DCMI_HandleTypeDef *hdcmi)
	Return the DCMI error code.

---

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 stm32h7xx_hal_dcmi.h.