STM32F4 Standard Peripheral bibliotheek  1.0
ST Microelectronics bibliotheek documentatie voor de STM32F4 Standard Peripheral Library
 All Data Structures Files Functions Variables Enumerations Enumerator Groups
Regular Channels Configuration functions

Regular Channels Configuration functions. More...

Functions

void ADC_RegularChannelConfig (ADC_TypeDef *ADCx, uint8_t ADC_Channel, uint8_t Rank, uint8_t ADC_SampleTime)
 Configures for the selected ADC regular channel its corresponding rank in the sequencer and its sample time. More...
 
void ADC_SoftwareStartConv (ADC_TypeDef *ADCx)
 Enables the selected ADC software start conversion of the regular channels. More...
 
FlagStatus ADC_GetSoftwareStartConvStatus (ADC_TypeDef *ADCx)
 Gets the selected ADC Software start regular conversion Status. More...
 
void ADC_EOCOnEachRegularChannelCmd (ADC_TypeDef *ADCx, FunctionalState NewState)
 Enables or disables the EOC on each regular channel conversion. More...
 
void ADC_ContinuousModeCmd (ADC_TypeDef *ADCx, FunctionalState NewState)
 Enables or disables the ADC continuous conversion mode. More...
 
void ADC_DiscModeChannelCountConfig (ADC_TypeDef *ADCx, uint8_t Number)
 Configures the discontinuous mode for the selected ADC regular group channel. More...
 
void ADC_DiscModeCmd (ADC_TypeDef *ADCx, FunctionalState NewState)
 Enables or disables the discontinuous mode on regular group channel for the specified ADC. More...
 
uint16_t ADC_GetConversionValue (ADC_TypeDef *ADCx)
 Returns the last ADCx conversion result data for regular channel. More...
 
uint32_t ADC_GetMultiModeConversionValue (void)
 Returns the last ADC1, ADC2 and ADC3 regular conversions results data in the selected multi mode. More...
 

Detailed Description

Regular Channels Configuration functions.

 ===============================================================================
                  Regular Channels Configuration functions
 ===============================================================================  

  This section provides functions allowing to manage the ADC's regular channels,
  it is composed of 2 sub sections : 
  
  1. Configuration and management functions for regular channels: This subsection 
     provides functions allowing to configure the ADC regular channels :    
          - Configure the rank in the regular group sequencer for each channel
          - Configure the sampling time for each channel
          - select the conversion Trigger for regular channels
          - select the desired EOC event behavior configuration
          - Activate the continuous Mode  (*)
          - Activate the Discontinuous Mode 
     Please Note that the following features for regular channels are configurated
     using the ADC_Init() function : 
          - scan mode activation 
          - continuous mode activation (**) 
          - External trigger source  
          - External trigger edge 
          - number of conversion in the regular channels group sequencer.
     
     @note (*) and (**) are performing the same configuration
     
  2. Get the conversion data: This subsection provides an important function in 
     the ADC peripheral since it returns the converted data of the current 
     regular channel. When the Conversion value is read, the EOC Flag is 
     automatically cleared.
     
     @note For multi ADC mode, the last ADC1, ADC2 and ADC3 regular conversions 
           results data (in the selected multi mode) can be returned in the same 
           time using ADC_GetMultiModeConversionValue() function. 

Function Documentation

void ADC_ContinuousModeCmd ( ADC_TypeDef *  ADCx,
FunctionalState  NewState 
)

Enables or disables the ADC continuous conversion mode.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
NewState,:new state of the selected ADC continuous conversion mode This parameter can be: ENABLE or DISABLE.
Return values
None
void ADC_DiscModeChannelCountConfig ( ADC_TypeDef *  ADCx,
uint8_t  Number 
)

Configures the discontinuous mode for the selected ADC regular group channel.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
Number,:specifies the discontinuous mode regular channel count value. This number must be between 1 and 8.
Return values
None
void ADC_DiscModeCmd ( ADC_TypeDef *  ADCx,
FunctionalState  NewState 
)

Enables or disables the discontinuous mode on regular group channel for the specified ADC.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
NewState,:new state of the selected ADC discontinuous mode on regular group channel. This parameter can be: ENABLE or DISABLE.
Return values
None
void ADC_EOCOnEachRegularChannelCmd ( ADC_TypeDef *  ADCx,
FunctionalState  NewState 
)

Enables or disables the EOC on each regular channel conversion.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
NewState,:new state of the selected ADC EOC flag rising This parameter can be: ENABLE or DISABLE.
Return values
None
uint16_t ADC_GetConversionValue ( ADC_TypeDef *  ADCx)

Returns the last ADCx conversion result data for regular channel.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
Return values
TheData conversion value.
uint32_t ADC_GetMultiModeConversionValue ( void  )

Returns the last ADC1, ADC2 and ADC3 regular conversions results data in the selected multi mode.

Parameters
None
Return values
TheData conversion value.
Note
In dual mode, the value returned by this function is as following Data[15:0] : these bits contain the regular data of ADC1. Data[31:16]: these bits contain the regular data of ADC2.
In triple mode, the value returned by this function is as following Data[15:0] : these bits contain alternatively the regular data of ADC1, ADC3 and ADC2. Data[31:16]: these bits contain alternatively the regular data of ADC2, ADC1 and ADC3.
FlagStatus ADC_GetSoftwareStartConvStatus ( ADC_TypeDef *  ADCx)

Gets the selected ADC Software start regular conversion Status.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
Return values
Thenew state of ADC software start conversion (SET or RESET).
void ADC_RegularChannelConfig ( ADC_TypeDef *  ADCx,
uint8_t  ADC_Channel,
uint8_t  Rank,
uint8_t  ADC_SampleTime 
)

Configures for the selected ADC regular channel its corresponding rank in the sequencer and its sample time.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
ADC_Channel,:the ADC channel to configure. This parameter can be one of the following values:
  • ADC_Channel_0: ADC Channel0 selected
  • ADC_Channel_1: ADC Channel1 selected
  • ADC_Channel_2: ADC Channel2 selected
  • ADC_Channel_3: ADC Channel3 selected
  • ADC_Channel_4: ADC Channel4 selected
  • ADC_Channel_5: ADC Channel5 selected
  • ADC_Channel_6: ADC Channel6 selected
  • ADC_Channel_7: ADC Channel7 selected
  • ADC_Channel_8: ADC Channel8 selected
  • ADC_Channel_9: ADC Channel9 selected
  • ADC_Channel_10: ADC Channel10 selected
  • ADC_Channel_11: ADC Channel11 selected
  • ADC_Channel_12: ADC Channel12 selected
  • ADC_Channel_13: ADC Channel13 selected
  • ADC_Channel_14: ADC Channel14 selected
  • ADC_Channel_15: ADC Channel15 selected
  • ADC_Channel_16: ADC Channel16 selected
  • ADC_Channel_17: ADC Channel17 selected
  • ADC_Channel_18: ADC Channel18 selected
Rank,:The rank in the regular group sequencer. This parameter must be between 1 to 16.
ADC_SampleTime,:The sample time value to be set for the selected channel. This parameter can be one of the following values:
  • ADC_SampleTime_3Cycles: Sample time equal to 3 cycles
  • ADC_SampleTime_15Cycles: Sample time equal to 15 cycles
  • ADC_SampleTime_28Cycles: Sample time equal to 28 cycles
  • ADC_SampleTime_56Cycles: Sample time equal to 56 cycles
  • ADC_SampleTime_84Cycles: Sample time equal to 84 cycles
  • ADC_SampleTime_112Cycles: Sample time equal to 112 cycles
  • ADC_SampleTime_144Cycles: Sample time equal to 144 cycles
  • ADC_SampleTime_480Cycles: Sample time equal to 480 cycles
Return values
None
void ADC_SoftwareStartConv ( ADC_TypeDef *  ADCx)

Enables the selected ADC software start conversion of the regular channels.

Parameters
ADCx,:where x can be 1, 2 or 3 to select the ADC peripheral.
Return values
None