Interrupts and flags management functions
[ADC_Private_Functions]

Interrupts and flags management functions. More...

Functions

void ADC_ITConfig (ADC_TypeDef *ADCx, uint16_t ADC_IT, FunctionalState NewState)
 Enables or disables the specified ADC interrupts.
FlagStatus ADC_GetFlagStatus (ADC_TypeDef *ADCx, uint8_t ADC_FLAG)
 Checks whether the specified ADC flag is set or not.
void ADC_ClearFlag (ADC_TypeDef *ADCx, uint8_t ADC_FLAG)
 Clears the ADCx's pending flags.
ITStatus ADC_GetITStatus (ADC_TypeDef *ADCx, uint16_t ADC_IT)
 Checks whether the specified ADC interrupt has occurred or not.
void ADC_ClearITPendingBit (ADC_TypeDef *ADCx, uint16_t ADC_IT)
 Clears the ADCx's interrupt pending bits.

Detailed Description

Interrupts and flags management functions.

 ===============================================================================
                   Interrupts and flags management functions
 ===============================================================================  

  This section provides functions allowing to configure the ADC Interrupts and 
  to get the status and clear flags and Interrupts pending bits.
  
  Each ADC provides 4 Interrupts sources and 6 Flags which can be divided into 
  3 groups:
  
  I. Flags and Interrupts for ADC regular channels
  =================================================
  Flags :
  ---------- 
     1. ADC_FLAG_OVR : Overrun detection when regular converted data are lost

     2. ADC_FLAG_EOC : Regular channel end of conversion ==> to indicate (depending 
              on EOCS bit, managed by ADC_EOCOnEachRegularChannelCmd() ) the end of:
               ==> a regular CHANNEL conversion 
               ==> sequence of regular GROUP conversions .

     3. ADC_FLAG_STRT: Regular channel start ==> to indicate when regular CHANNEL 
              conversion starts.

  Interrupts :
  ------------
     1. ADC_IT_OVR : specifies the interrupt source for Overrun detection event.  
     2. ADC_IT_EOC : specifies the interrupt source for Regular channel end of 
                     conversion event.
  
  
  II. Flags and Interrupts for ADC Injected channels
  =================================================
  Flags :
  ---------- 
     1. ADC_FLAG_JEOC : Injected channel end of conversion ==> to indicate at 
               the end of injected GROUP conversion  
              
     2. ADC_FLAG_JSTRT: Injected channel start ==> to indicate hardware when 
               injected GROUP conversion starts.

  Interrupts :
  ------------
     1. ADC_IT_JEOC : specifies the interrupt source for Injected channel end of 
                      conversion event.     

  III. General Flags and Interrupts for the ADC
  ================================================= 
  Flags :
  ---------- 
     1. ADC_FLAG_AWD: Analog watchdog ==> to indicate if the converted voltage 
              crosses the programmed thresholds values.
              
  Interrupts :
  ------------
     1. ADC_IT_AWD : specifies the interrupt source for Analog watchdog event. 

  
  The user should identify which mode will be used in his application to manage 
  the ADC controller events: Polling mode or Interrupt mode.
  
  In the Polling Mode it is advised to use the following functions:
      - ADC_GetFlagStatus() : to check if flags events occur. 
      - ADC_ClearFlag()     : to clear the flags events.
      
  In the Interrupt Mode it is advised to use the following functions:
     - ADC_ITConfig()          : to enable or disable the interrupt source.
     - ADC_GetITStatus()       : to check if Interrupt occurs.
     - ADC_ClearITPendingBit() : to clear the Interrupt pending Bit 
                                 (corresponding Flag). 

Function Documentation

void ADC_ClearFlag ( ADC_TypeDef *  ADCx,
uint8_t  ADC_FLAG 
)

Clears the ADCx's pending flags.

Parameters:
ADCx,: where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_FLAG,: specifies the flag to clear. This parameter can be any combination of the following values:

  • ADC_FLAG_AWD: Analog watchdog flag
  • ADC_FLAG_EOC: End of conversion flag
  • ADC_FLAG_JEOC: End of injected group conversion flag
  • ADC_FLAG_JSTRT: Start of injected group conversion flag
  • ADC_FLAG_STRT: Start of regular group conversion flag
  • ADC_FLAG_OVR: Overrun flag
Return values:
None 
void ADC_ClearITPendingBit ( ADC_TypeDef *  ADCx,
uint16_t  ADC_IT 
)

Clears the ADCx's interrupt pending bits.

Parameters:
ADCx,: where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_IT,: specifies the ADC interrupt pending bit to clear. This parameter can be one of the following values:

  • ADC_IT_EOC: End of conversion interrupt mask
  • ADC_IT_AWD: Analog watchdog interrupt mask
  • ADC_IT_JEOC: End of injected conversion interrupt mask
  • ADC_IT_OVR: Overrun interrupt mask
Return values:
None 
FlagStatus ADC_GetFlagStatus ( ADC_TypeDef *  ADCx,
uint8_t  ADC_FLAG 
)

Checks whether the specified ADC flag is set or not.

Parameters:
ADCx,: where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_FLAG,: specifies the flag to check. This parameter can be one of the following values:

  • ADC_FLAG_AWD: Analog watchdog flag
  • ADC_FLAG_EOC: End of conversion flag
  • ADC_FLAG_JEOC: End of injected group conversion flag
  • ADC_FLAG_JSTRT: Start of injected group conversion flag
  • ADC_FLAG_STRT: Start of regular group conversion flag
  • ADC_FLAG_OVR: Overrun flag
Return values:
The new state of ADC_FLAG (SET or RESET).
ITStatus ADC_GetITStatus ( ADC_TypeDef *  ADCx,
uint16_t  ADC_IT 
)

Checks whether the specified ADC interrupt has occurred or not.

Parameters:
ADCx,: where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_IT,: specifies the ADC interrupt source to check. This parameter can be one of the following values:

  • ADC_IT_EOC: End of conversion interrupt mask
  • ADC_IT_AWD: Analog watchdog interrupt mask
  • ADC_IT_JEOC: End of injected conversion interrupt mask
  • ADC_IT_OVR: Overrun interrupt mask
Return values:
The new state of ADC_IT (SET or RESET).
void ADC_ITConfig ( ADC_TypeDef *  ADCx,
uint16_t  ADC_IT,
FunctionalState  NewState 
)

Enables or disables the specified ADC interrupts.

Parameters:
ADCx,: where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_IT,: specifies the ADC interrupt sources to be enabled or disabled. This parameter can be one of the following values:

  • ADC_IT_EOC: End of conversion interrupt mask
  • ADC_IT_AWD: Analog watchdog interrupt mask
  • ADC_IT_JEOC: End of injected conversion interrupt mask
  • ADC_IT_OVR: Overrun interrupt enable
NewState,: new state of the specified ADC interrupts. This parameter can be: ENABLE or DISABLE.
Return values:
None 
Generated on Fri Jun 22 00:58:30 2012 for STM32F4xx_StdPeriph_Driver by  doxygen 1.6.3