DCMI
[STM32F4xx_StdPeriph_Driver]

DCMI driver modules. More...

Data Structures

struct  DCMI_InitTypeDef
 DCMI Init structure definition. More...
struct  DCMI_CROPInitTypeDef
 DCMI CROP Init structure definition. More...
struct  DCMI_CodesInitTypeDef
 DCMI Embedded Synchronisation CODE Init structure definition. More...

Modules

 DCMI_Exported_Constants
 DCMI_Private_Functions

Functions

void DCMI_DeInit (void)
 Deinitializes the DCMI registers to their default reset values.
void DCMI_Init (DCMI_InitTypeDef *DCMI_InitStruct)
 Initializes the DCMI according to the specified parameters in the DCMI_InitStruct.
void DCMI_StructInit (DCMI_InitTypeDef *DCMI_InitStruct)
 Fills each DCMI_InitStruct member with its default value.
void DCMI_CROPConfig (DCMI_CROPInitTypeDef *DCMI_CROPInitStruct)
 Initializes the DCMI peripheral CROP mode according to the specified parameters in the DCMI_CROPInitStruct.
void DCMI_CROPCmd (FunctionalState NewState)
 Enables or disables the DCMI Crop feature.
void DCMI_SetEmbeddedSynchroCodes (DCMI_CodesInitTypeDef *DCMI_CodesInitStruct)
 Sets the embedded synchronization codes.
void DCMI_JPEGCmd (FunctionalState NewState)
 Enables or disables the DCMI JPEG format.
void DCMI_Cmd (FunctionalState NewState)
 Enables or disables the DCMI interface.
void DCMI_CaptureCmd (FunctionalState NewState)
 Enables or disables the DCMI Capture.
uint32_t DCMI_ReadData (void)
 Reads the data stored in the DR register.
void DCMI_ITConfig (uint16_t DCMI_IT, FunctionalState NewState)
 Enables or disables the DCMI interface interrupts.
FlagStatus DCMI_GetFlagStatus (uint16_t DCMI_FLAG)
 Checks whether the DCMI interface flag is set or not.
void DCMI_ClearFlag (uint16_t DCMI_FLAG)
 Clears the DCMI's pending flags.
ITStatus DCMI_GetITStatus (uint16_t DCMI_IT)
 Checks whether the DCMI interrupt has occurred or not.
void DCMI_ClearITPendingBit (uint16_t DCMI_IT)
 Clears the DCMI's interrupt pending bits.

Detailed Description

DCMI driver modules.

Function Documentation

void DCMI_CaptureCmd ( FunctionalState  NewState  ) 

Enables or disables the DCMI Capture.

Parameters:
NewState,: new state of the DCMI capture. This parameter can be: ENABLE or DISABLE.
Return values:
None 
void DCMI_ClearFlag ( uint16_t  DCMI_FLAG  ) 

Clears the DCMI's pending flags.

Parameters:
DCMI_FLAG,: specifies the flag to clear. This parameter can be any combination of the following values:

  • DCMI_FLAG_FRAMERI: Frame capture complete Raw flag mask
  • DCMI_FLAG_OVFRI: Overflow Raw flag mask
  • DCMI_FLAG_ERRRI: Synchronization error Raw flag mask
  • DCMI_FLAG_VSYNCRI: VSYNC Raw flag mask
  • DCMI_FLAG_LINERI: Line Raw flag mask
Return values:
None 
void DCMI_ClearITPendingBit ( uint16_t  DCMI_IT  ) 

Clears the DCMI's interrupt pending bits.

Parameters:
DCMI_IT,: specifies the DCMI interrupt pending bit to clear. This parameter can be any combination of the following values:

  • DCMI_IT_FRAME: Frame capture complete interrupt mask
  • DCMI_IT_OVF: Overflow interrupt mask
  • DCMI_IT_ERR: Synchronization error interrupt mask
  • DCMI_IT_VSYNC: VSYNC interrupt mask
  • DCMI_IT_LINE: Line interrupt mask
Return values:
None 
void DCMI_Cmd ( FunctionalState  NewState  ) 

Enables or disables the DCMI interface.

Parameters:
NewState,: new state of the DCMI interface. This parameter can be: ENABLE or DISABLE.
Return values:
None 
void DCMI_CROPCmd ( FunctionalState  NewState  ) 

Enables or disables the DCMI Crop feature.

Note:
This function should be called before to enable and start the DCMI interface.
Parameters:
NewState,: new state of the DCMI Crop feature. This parameter can be: ENABLE or DISABLE.
Return values:
None 
void DCMI_CROPConfig ( DCMI_CROPInitTypeDef *  DCMI_CROPInitStruct  ) 

Initializes the DCMI peripheral CROP mode according to the specified parameters in the DCMI_CROPInitStruct.

Note:
This function should be called before to enable and start the DCMI interface.
Parameters:
DCMI_CROPInitStruct,: pointer to a DCMI_CROPInitTypeDef structure that contains the configuration information for the DCMI peripheral CROP mode.
Return values:
None 
void DCMI_DeInit ( void   ) 

Deinitializes the DCMI registers to their default reset values.

Parameters:
None 
Return values:
None 
FlagStatus DCMI_GetFlagStatus ( uint16_t  DCMI_FLAG  ) 

Checks whether the DCMI interface flag is set or not.

Parameters:
DCMI_FLAG,: specifies the flag to check. This parameter can be one of the following values:

  • DCMI_FLAG_FRAMERI: Frame capture complete Raw flag mask
  • DCMI_FLAG_OVFRI: Overflow Raw flag mask
  • DCMI_FLAG_ERRRI: Synchronization error Raw flag mask
  • DCMI_FLAG_VSYNCRI: VSYNC Raw flag mask
  • DCMI_FLAG_LINERI: Line Raw flag mask
  • DCMI_FLAG_FRAMEMI: Frame capture complete Masked flag mask
  • DCMI_FLAG_OVFMI: Overflow Masked flag mask
  • DCMI_FLAG_ERRMI: Synchronization error Masked flag mask
  • DCMI_FLAG_VSYNCMI: VSYNC Masked flag mask
  • DCMI_FLAG_LINEMI: Line Masked flag mask
  • DCMI_FLAG_HSYNC: HSYNC flag mask
  • DCMI_FLAG_VSYNC: VSYNC flag mask
  • DCMI_FLAG_FNE: Fifo not empty flag mask
Return values:
The new state of DCMI_FLAG (SET or RESET).
ITStatus DCMI_GetITStatus ( uint16_t  DCMI_IT  ) 

Checks whether the DCMI interrupt has occurred or not.

Parameters:
DCMI_IT,: 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_OVF: Overflow interrupt mask
  • DCMI_IT_ERR: Synchronization error interrupt mask
  • DCMI_IT_VSYNC: VSYNC interrupt mask
  • DCMI_IT_LINE: Line interrupt mask
Return values:
The new state of DCMI_IT (SET or RESET).
void DCMI_Init ( DCMI_InitTypeDef *  DCMI_InitStruct  ) 

Initializes the DCMI according to the specified parameters in the DCMI_InitStruct.

Parameters:
DCMI_InitStruct,: pointer to a DCMI_InitTypeDef structure that contains the configuration information for the DCMI.
Return values:
None 
void DCMI_ITConfig ( uint16_t  DCMI_IT,
FunctionalState  NewState 
)

Enables or disables the DCMI interface interrupts.

Parameters:
DCMI_IT,: specifies the DCMI interrupt sources to be enabled or disabled. This parameter can be any combination of the following values:

  • DCMI_IT_FRAME: Frame capture complete interrupt mask
  • DCMI_IT_OVF: Overflow interrupt mask
  • DCMI_IT_ERR: Synchronization error interrupt mask
  • DCMI_IT_VSYNC: VSYNC interrupt mask
  • DCMI_IT_LINE: Line interrupt mask
NewState,: new state of the specified DCMI interrupts. This parameter can be: ENABLE or DISABLE.
Return values:
None 
void DCMI_JPEGCmd ( FunctionalState  NewState  ) 

Enables or disables the DCMI JPEG format.

Note:
The Crop and Embedded Synchronization features cannot be used in this mode.
Parameters:
NewState,: new state of the DCMI JPEG format. This parameter can be: ENABLE or DISABLE.
Return values:
None 
uint32_t DCMI_ReadData ( void   ) 

Reads the data stored in the DR register.

Parameters:
None 
Return values:
Data register value
void DCMI_SetEmbeddedSynchroCodes ( DCMI_CodesInitTypeDef *  DCMI_CodesInitStruct  ) 

Sets the embedded synchronization codes.

Parameters:
DCMI_CodesInitTypeDef,: pointer to a DCMI_CodesInitTypeDef structure that contains the embedded synchronization codes for the DCMI peripheral.
Return values:
None 
void DCMI_StructInit ( DCMI_InitTypeDef *  DCMI_InitStruct  ) 

Fills each DCMI_InitStruct member with its default value.

Parameters:
DCMI_InitStruct : pointer to a DCMI_InitTypeDef structure which will be initialized.
Return values:
None 
Generated on Fri Jun 22 00:58:30 2012 for STM32F4xx_StdPeriph_Driver by  doxygen 1.6.3