Martin Johnson / STM32F3-Discovery

Dependents:   Space_Invaders_Demo neopixels gpio_test_stm32f3_discovery gpio_test_systimer ... more

Embed: (wiki syntax)

« Back to documentation index

Analog Watchdog configuration functions

Analog Watchdog configuration functions
[ADC_Private_Functions]

Analog Watchdog configuration functions. More...

Functions

void ADC_AnalogWatchdogCmd (ADC_TypeDef *ADCx, uint32_t ADC_AnalogWatchdog)
 Enables or disables the analog watchdog on single/all regular or injected channels.
void ADC_AnalogWatchdog1ThresholdsConfig (ADC_TypeDef *ADCx, uint16_t HighThreshold, uint16_t LowThreshold)
 Configures the high and low thresholds of the analog watchdog1.
void ADC_AnalogWatchdog2ThresholdsConfig (ADC_TypeDef *ADCx, uint8_t HighThreshold, uint8_t LowThreshold)
 Configures the high and low thresholds of the analog watchdog2.
void ADC_AnalogWatchdog3ThresholdsConfig (ADC_TypeDef *ADCx, uint8_t HighThreshold, uint8_t LowThreshold)
 Configures the high and low thresholds of the analog watchdog3.
void ADC_AnalogWatchdog1SingleChannelConfig (ADC_TypeDef *ADCx, uint8_t ADC_Channel)
 Configures the analog watchdog 2 guarded single channel.
void ADC_AnalogWatchdog2SingleChannelConfig (ADC_TypeDef *ADCx, uint8_t ADC_Channel)
 Configures the analog watchdog 2 guarded single channel.
void ADC_AnalogWatchdog3SingleChannelConfig (ADC_TypeDef *ADCx, uint8_t ADC_Channel)
 Configures the analog watchdog 3 guarded single channel.

Detailed Description

Analog Watchdog configuration functions.

 ===============================================================================
                    ##### Analog Watchdog configuration functions #####
 ===============================================================================  

  [..] This section provides functions allowing to configure the 3 Analog Watchdogs 
       (AWDG1, AWDG2 and AWDG3) in the ADC.
  
  [..] A typical configuration Analog Watchdog is done following these steps :
   (#) The ADC guarded channel(s) is (are) selected using the functions: 
      (++) ADC_AnalogWatchdog1SingleChannelConfig().
      (++) ADC_AnalogWatchdog2SingleChannelConfig().
      (++) ADC_AnalogWatchdog3SingleChannelConfig().

   (#) The Analog watchdog lower and higher threshold are configured using the functions: 
      (++) ADC_AnalogWatchdog1ThresholdsConfig().
      (++) ADC_AnalogWatchdog2ThresholdsConfig().
      (++) ADC_AnalogWatchdog3ThresholdsConfig().

   (#) The Analog watchdog is enabled and configured to enable the check, on one
      or more channels, using the function:
      (++) ADC_AnalogWatchdogCmd().


Function Documentation

void ADC_AnalogWatchdog1SingleChannelConfig ( ADC_TypeDef *  ADCx,
uint8_t  ADC_Channel 
)

Configures the analog watchdog 2 guarded single channel.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
ADC_Channel,:the ADC channel to configure for the analog watchdog. This parameter can be one of the following values:

  • 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
Return values:
None

Definition at line 808 of file stm32f30x_adc.c.

void ADC_AnalogWatchdog1ThresholdsConfig ( ADC_TypeDef *  ADCx,
uint16_t  HighThreshold,
uint16_t  LowThreshold 
)

Configures the high and low thresholds of the analog watchdog1.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
HighThreshold,:the ADC analog watchdog High threshold value. This parameter must be a 12bit value.
LowThreshold,:the ADC analog watchdog Low threshold value. This parameter must be a 12bit value.
Return values:
None

Definition at line 719 of file stm32f30x_adc.c.

void ADC_AnalogWatchdog2SingleChannelConfig ( ADC_TypeDef *  ADCx,
uint8_t  ADC_Channel 
)

Configures the analog watchdog 2 guarded single channel.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
ADC_Channel,:the ADC channel to configure for the analog watchdog. This parameter can be one of the following values:

  • 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
Return values:
None

Definition at line 849 of file stm32f30x_adc.c.

void ADC_AnalogWatchdog2ThresholdsConfig ( ADC_TypeDef *  ADCx,
uint8_t  HighThreshold,
uint8_t  LowThreshold 
)

Configures the high and low thresholds of the analog watchdog2.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
HighThreshold,:the ADC analog watchdog High threshold value. This parameter must be a 8bit value.
LowThreshold,:the ADC analog watchdog Low threshold value. This parameter must be a 8bit value.
Return values:
None

Definition at line 744 of file stm32f30x_adc.c.

void ADC_AnalogWatchdog3SingleChannelConfig ( ADC_TypeDef *  ADCx,
uint8_t  ADC_Channel 
)

Configures the analog watchdog 3 guarded single channel.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
ADC_Channel,:the ADC channel to configure for the analog watchdog. This parameter can be one of the following values:

  • 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
Return values:
None

Definition at line 890 of file stm32f30x_adc.c.

void ADC_AnalogWatchdog3ThresholdsConfig ( ADC_TypeDef *  ADCx,
uint8_t  HighThreshold,
uint8_t  LowThreshold 
)

Configures the high and low thresholds of the analog watchdog3.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
HighThreshold,:the ADC analog watchdog High threshold value. This parameter must be a 8bit value.
LowThreshold,:the ADC analog watchdog Low threshold value. This parameter must be a 8bit value.
Return values:
None

Definition at line 768 of file stm32f30x_adc.c.

void ADC_AnalogWatchdogCmd ( ADC_TypeDef *  ADCx,
uint32_t  ADC_AnalogWatchdog 
)

Enables or disables the analog watchdog on single/all regular or injected channels.

Parameters:
ADCx,:where x can be 1, 2, 3 or 4 to select the ADC peripheral.
ADC_AnalogWatchdog,:the ADC analog watchdog configuration. This parameter can be one of the following values:

  • ADC_AnalogWatchdog_SingleRegEnable: Analog watchdog on a single regular channel
  • ADC_AnalogWatchdog_SingleInjecEnable: Analog watchdog on a single injected channel
  • ADC_AnalogWatchdog_SingleRegOrInjecEnable: Analog watchdog on a single regular or injected channel
  • ADC_AnalogWatchdog_AllRegEnable: Analog watchdog on all regular channel
  • ADC_AnalogWatchdog_AllInjecEnable: Analog watchdog on all injected channel
  • ADC_AnalogWatchdog_AllRegAllInjecEnable: Analog watchdog on all regular and injected channels
  • ADC_AnalogWatchdog_None: No channel guarded by the analog watchdog
Return values:
None

Definition at line 694 of file stm32f30x_adc.c.