STM32F439xx HAL User Manual
Defines
DCMI Exported Macros
DCMI

Defines

#define __HAL_DCMI_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)
 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 Documentation

#define __HAL_DCMI_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__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 349 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_IRQHandler().

#define __HAL_DCMI_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR &= ~(DCMI_CR_ENABLE))

Disable the DCMI.

Parameters:
__HANDLE__DCMI handle
Return values:
None

Definition at line 310 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_Stop().

#define __HAL_DCMI_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__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 377 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_IRQHandler().

#define __HAL_DCMI_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= DCMI_CR_ENABLE)

Enable the DCMI.

Parameters:
__HANDLE__DCMI handle
Return values:
None

Definition at line 303 of file stm32f4xx_hal_dcmi.h.

Referenced by HAL_DCMI_Start_DMA().

#define __HAL_DCMI_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__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 363 of file stm32f4xx_hal_dcmi.h.

Referenced by DCMI_DMAXferCplt(), and HAL_DCMI_Init().

#define __HAL_DCMI_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)
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:
Thestate of FLAG.

Definition at line 333 of file stm32f4xx_hal_dcmi.h.

#define __HAL_DCMI_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    ((__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:
Thestate of INTERRUPT.

Definition at line 391 of file stm32f4xx_hal_dcmi.h.

#define __HAL_DCMI_RESET_HANDLE_STATE (   __HANDLE__)    ((__HANDLE__)->State = HAL_DCMI_STATE_RESET)

Reset DCMI handle state.

Parameters:
__HANDLE__specifies the DCMI handle.
Return values:
None

Definition at line 296 of file stm32f4xx_hal_dcmi.h.