DCMI Exported Macros

Collaboration diagram for DCMI Exported Macros:

Macros
#define	__HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__)
	Reset DCMI handle state.
#define	__HAL_DCMI_ENABLE(__HANDLE__)
	Enable the DCMI.
#define	__HAL_DCMI_DISABLE(__HANDLE__)
	Disable the DCMI.
#define	__HAL_DCMI_GET_FLAG(__HANDLE__, __FLAG__)
	Get the DCMI pending flag.
#define	__HAL_DCMI_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the DCMI pending flags.
#define	__HAL_DCMI_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified DCMI interrupts.
#define	__HAL_DCMI_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified DCMI interrupts.
#define	__HAL_DCMI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified DCMI interrupt has occurred or not.

Detailed Description

Macro Definition Documentation

__HAL_DCMI_RESET_HANDLE_STATE

#define __HAL_DCMI_RESET_HANDLE_STATE

(

__HANDLE__

)

#include <stm32f4xx_hal_dcmi.h>

Value:

                                                     do{                                            \
                                                     (__HANDLE__)->State = HAL_DCMI_STATE_RESET; \
                                                     (__HANDLE__)->MspInitCallback = NULL;      \
                                                     (__HANDLE__)->MspDeInitCallback = NULL;    \
                                                   } while(0)

Reset DCMI handle state.

Parameters

__HANDLE__

specifies the DCMI handle.

Return values

None

Definition at line 315 of file stm32f4xx_hal_dcmi.h.

__HAL_DCMI_ENABLE

#define __HAL_DCMI_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)

Enable the DCMI.

Parameters

__HANDLE__

DCMI handle

Return values

None

Definition at line 326 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_Start_DMA().

__HAL_DCMI_DISABLE

#define __HAL_DCMI_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))

Disable the DCMI.

Parameters

__HANDLE__

DCMI handle

Return values

None

Definition at line 333 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_Stop().

__HAL_DCMI_GET_FLAG

#define __HAL_DCMI_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_dcmi.h>

Value:

((((__FLAG__) & (DCMI_SR_INDEX|DCMI_MIS_INDEX)) == 0x0U)? ((__HANDLE__)->Instance->RISR & (__FLAG__)) :\
 (((__FLAG__) & DCMI_SR_INDEX) == 0x0U)? ((__HANDLE__)->Instance->MISR & (__FLAG__)) : ((__HANDLE__)->Instance->SR & (__FLAG__)))

Get the DCMI pending flag.

Parameters

__HANDLE__

DCMI handle

__FLAG__

Get the specified flag. This parameter can be one of the following values (no combination allowed) DCMI_FLAG_HSYNC: HSYNC pin state (active line / synchronization between lines) DCMI_FLAG_VSYNC: VSYNC pin state (active frame / synchronization between frames) DCMI_FLAG_FNE: FIFO empty flag DCMI_FLAG_FRAMERI: Frame capture complete flag mask DCMI_FLAG_OVRRI: Overrun flag mask DCMI_FLAG_ERRRI: Synchronization error flag mask DCMI_FLAG_VSYNCRI: VSYNC flag mask DCMI_FLAG_LINERI: Line flag mask DCMI_FLAG_FRAMEMI: DCMI Capture complete masked interrupt status DCMI_FLAG_OVRMI: DCMI Overrun masked interrupt status DCMI_FLAG_ERRMI: DCMI Synchronization error masked interrupt status DCMI_FLAG_VSYNCMI: DCMI VSYNC masked interrupt status DCMI_FLAG_LINEMI: DCMI Line masked interrupt status

Return values

The	state of FLAG.

Definition at line 356 of file stm32f4xx_hal_dcmi.h.

__HAL_DCMI_CLEAR_FLAG

#define __HAL_DCMI_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->ICR = (__FLAG__))

Clear the DCMI pending flags.

Parameters

__HANDLE__	DCMI handle
__FLAG__	specifies the flag to clear. This parameter can be any combination of the following values: DCMI_FLAG_FRAMERI: Frame capture complete flag mask DCMI_FLAG_OVRRI: Overrun flag mask DCMI_FLAG_ERRRI: Synchronization error flag mask DCMI_FLAG_VSYNCRI: VSYNC flag mask DCMI_FLAG_LINERI: Line flag mask

Return values

None

Definition at line 372 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_IRQHandler().

__HAL_DCMI_ENABLE_IT

#define __HAL_DCMI_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->IER |= (__INTERRUPT__))

Enable the specified DCMI interrupts.

Parameters

__HANDLE__	DCMI handle
__INTERRUPT__	specifies the DCMI interrupt sources to be enabled. This parameter can be any combination of the following values: DCMI_IT_FRAME: Frame capture complete interrupt mask DCMI_IT_OVR: Overrun interrupt mask DCMI_IT_ERR: Synchronization error interrupt mask DCMI_IT_VSYNC: VSYNC interrupt mask DCMI_IT_LINE: Line interrupt mask

Return values

None

Definition at line 386 of file stm32f4xx_hal_dcmi.h.

Referenced by DCMI_DMAXferCplt(), and HAL_DCMI_Init().

__HAL_DCMI_DISABLE_IT

#define __HAL_DCMI_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->IER &= ~(__INTERRUPT__))

Disable the specified DCMI interrupts.

Parameters

__HANDLE__	DCMI handle
__INTERRUPT__	specifies the DCMI interrupt sources to be enabled. This parameter can be any combination of the following values: DCMI_IT_FRAME: Frame capture complete interrupt mask DCMI_IT_OVR: Overrun interrupt mask DCMI_IT_ERR: Synchronization error interrupt mask DCMI_IT_VSYNC: VSYNC interrupt mask DCMI_IT_LINE: Line interrupt mask

Return values

None

Definition at line 400 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_IRQHandler().

__HAL_DCMI_GET_IT_SOURCE

#define __HAL_DCMI_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_dcmi.h>

Value:

((__HANDLE__)->Instance->MISR & (__INTERRUPT__))

Check whether the specified DCMI interrupt has occurred or not.

Parameters

__HANDLE__	DCMI handle
__INTERRUPT__	specifies the DCMI interrupt source to check. This parameter can be one of the following values: DCMI_IT_FRAME: Frame capture complete interrupt mask DCMI_IT_OVR: Overrun interrupt mask DCMI_IT_ERR: Synchronization error interrupt mask DCMI_IT_VSYNC: VSYNC interrupt mask DCMI_IT_LINE: Line interrupt mask

Return values

The	state of INTERRUPT.

Definition at line 414 of file stm32f4xx_hal_dcmi.h.