ADC Analog watchdog API

ADC analog watchdog API definitions. More...

Collaboration diagram for ADC Analog watchdog API:

Functions
void	adc_enable_analog_watchdog_on_all_channels (uint32_t adc)
	ADC Enable Analog Watchdog for All Channels. More...
void	adc_enable_analog_watchdog_on_selected_channel (uint32_t adc, uint8_t chan)
	ADC Enable Analog Watchdog for a Selected Channel. More...
void	adc_disable_analog_watchdog (uint32_t adc)
	ADC Disable Analog Watchdog. More...
void	adc_set_watchdog_high_threshold (uint32_t adc, uint16_t threshold)
	ADC Set Analog Watchdog Upper Threshold. More...
void	adc_set_watchdog_low_threshold (uint32_t adc, uint16_t threshold)
	ADC Set Analog Watchdog Lower Threshold. More...

Detailed Description

ADC analog watchdog API definitions.

The analog watchdog allows the monitoring of an analog signal between two threshold levels. The thresholds must be preset. Analog watchdog is disabled by default.

Warning

Comparison is done before data alignment takes place, so the thresholds are left-aligned.

Example 1: Enable watchdog checking on all channels

// in configuration
adc_enable_analog_watchdog_on_all_channels(ADC1);
adc_set_watchdog_high_threshold(ADC1, 0xE00);
adc_set_watchdog_low_threshold(ADC1, 0x200);
 
// in the main application thread
if (adc_get_watchdog_flag(ADC1)) {
    // the converted signal is out of AWD ranges
    adc_clear_watchdog_flag(ADC1);
}

Example 2: Enable watchdog checking on channel 5

// in configuration
adc_enable_analog_watchdog_on_selected_channel(ADC1,5);
adc_set_watchdog_high_threshold(ADC1, 0xE00);
adc_set_watchdog_low_threshold(ADC1, 0x200);
 
// in the main application thread
if (adc_get_watchdog_flag(ADC1)) {
    // the converted signal is out of AWD ranges
    adc_clear_watchdog_flag(ADC1);
}

Function Documentation

adc_disable_analog_watchdog()

void adc_disable_analog_watchdog

(

uint32_t

adc

)

ADC Disable Analog Watchdog.

Parameters

[in]

adc

Unsigned int32. ADC base address (ADC register base addresses)

Definition at line 507 of file adc.c.

References ADC_CFGR1.

adc_enable_analog_watchdog_on_all_channels()

void adc_enable_analog_watchdog_on_all_channels

(

uint32_t

adc

)

ADC Enable Analog Watchdog for All Channels.

Parameters

[in]

adc

Unsigned int32. ADC base address (ADC register base addresses)

Definition at line 481 of file adc.c.

References ADC_CFGR1, and ADC_CFGR1_AWD1EN.

adc_enable_analog_watchdog_on_selected_channel()

void adc_enable_analog_watchdog_on_selected_channel	(	uint32_t	adc,
		uint8_t	chan
	)

ADC Enable Analog Watchdog for a Selected Channel.

Parameters

[in]	adc	Unsigned int32. ADC base address (ADC register base addresses)
[in]	chan	Unsigned int8. ADC channel number adc_api_channel

Definition at line 494 of file adc.c.

References ADC_CFGR1, ADC_CFGR1_AWD1CH_VAL, ADC_CFGR1_AWD1EN, and ADC_CFGR1_AWD1SGL.

adc_set_watchdog_high_threshold()

void adc_set_watchdog_high_threshold	(	uint32_t	adc,
		uint16_t	threshold
	)

ADC Set Analog Watchdog Upper Threshold.

Parameters

[in]	adc	Unsigned int32. ADC base address (ADC register base addresses)
[in]	threshold	Upper threshold value

Definition at line 519 of file adc.c.

References ADC_TR1, and ADC_TR1_HT_VAL.

adc_set_watchdog_low_threshold()

void adc_set_watchdog_low_threshold	(	uint32_t	adc,
		uint16_t	threshold
	)

ADC Set Analog Watchdog Lower Threshold.

Parameters

[in]	adc	Unsigned int32. ADC base address (ADC register base addresses)
[in]	threshold	Lower threshold value

Definition at line 531 of file adc.c.

References ADC_TR1, and ADC_TR1_LT_VAL.