ADC - Analog to Digital Converter#

sl_hal_adc_warmup_mode_t#

sl_hal_adc_warmup_mode_t

Warm-up mode.

sl_hal_adc_voltage_reference_t#

sl_hal_adc_voltage_reference_t

Voltage reference.

sl_hal_adc_high_speed_clock_rate_t#

sl_hal_adc_high_speed_clock_rate_t

First clock divider.

sl_hal_adc_trigger_t#

sl_hal_adc_trigger_t

ADC scan trigger.

sl_hal_adc_trigger_action_t#

sl_hal_adc_trigger_action_t

ADC scan trigger action.

sl_hal_adc_repetition_delay_t#

sl_hal_adc_repetition_delay_t

Delay value between one sequence of the table and the next start of sequence.

sl_hal_adc_analog_gain_t#

sl_hal_adc_analog_gain_t

Analog gain.

sl_hal_adc_samples_t#

sl_hal_adc_samples_t

Number of samples used for averaging.

sl_hal_adc_alignment_t#

sl_hal_adc_alignment_t

Alignment of output data written into FIFO.

sl_hal_adc_data_valid_t#

sl_hal_adc_data_valid_t

Data valid level before requesting DMA transfer.

sl_hal_adc_port_negative_t#

sl_hal_adc_port_negative_t

Port (A, B, C, D) or special signal assigned to the negative input of the ADC.

sl_hal_adc_port_positive_t#

sl_hal_adc_port_positive_t

Port (A, B, C, D) or special signal assigned to the positive input of the ADC.

sl_hal_adc_config_id_t#

sl_hal_adc_config_id_t

Configuration identifier.

sl_hal_adc_channel_id_t#

sl_hal_adc_channel_id_t

Channel identifier.

sl_hal_adc_init#

void sl_hal_adc_init (ADC_TypeDef * adc, const sl_hal_adc_init_t * init, uint32_t branch_clock_freq)

Initialize the ADC.

Note

• The ADC peripheral's internal clock prescalers and timebase will be set to sensible defaults according to the input parameter branch_clock_freq provided. These default prescalers can be modified using sl_hal_adc_set_clock_prescalers. The branch_clock_freq can be obtained for adc0 using the Device Manager and Clock Manager services as such:

  {
    #include "sl_clock_manager.h"
    #include "sl_device_peripheral.h"
  
    sl_clock_branch_t clock_branch;
    clock_branch = sl_device_peripheral_get_clock_branch(SL_PERIPHERAL_ADC0);
  
    uint32_t branch_clock_freq;
    sl_clock_manager_get_clock_branch_frequency(clock_branch, &branch_clock_freq);
  }
  

• For SiXG301, due to hardware limitations, the ADC cannot be configured for hardware averaging if the adcprescale is 0 (divide by 1). If hardware averaging is desired, then an adc0 branch_clock_freq of 34 - 40Mhz, 68 - 80Mhz, 102 - 120Mhz or 136 - 160Mhz can be used to guarantee that the calculated adcprescale is 1.

sl_hal_adc_reset#

void sl_hal_adc_reset (ADC_TypeDef * adc)

Reset the ADC.

sl_hal_adc_set_scan_mask#

void sl_hal_adc_set_scan_mask (ADC_TypeDef * adc, uint32_t mask)

Set a new Scan Table mask.

Note

• The working scan table is updated when it's not being scanned. Each bit in the mask corresponds to a given ADC channel, and setting a given bit to 1 will enable the conversion of the respective ADC channel.

sl_hal_adc_get_scan_mask#

uint32_t sl_hal_adc_get_scan_mask (ADC_TypeDef * adc)

Get the working scan table mask.

Returns

• The working scan table mask.

sl_hal_adc_update_scan_entry#

void sl_hal_adc_update_scan_entry (ADC_TypeDef * adc, uint8_t id, const sl_hal_adc_scan_entry_t * entry)

Update an entry in the scan table.

sl_hal_adc_pull#

sl_hal_adc_result_t sl_hal_adc_pull (const ADC_TypeDef * adc)

Pull the value at the top of the FIFO.

FIFO count reduced.

Returns

• The data at the top of the FIFO.

sl_hal_adc_peek#

sl_hal_adc_result_t sl_hal_adc_peek (const ADC_TypeDef * adc)

Peek at the top of the FIFO without removing the data.

Returns

• The data at the top of the FIFO.

Note

• The FIFO's count remains unchanged.

sl_hal_adc_get_fifo_count#

uint32_t sl_hal_adc_get_fifo_count (const ADC_TypeDef * adc)

Get the ADC's current FIFO count.

Returns

• The ADC's current FIFO count.

sl_hal_adc_get_internal_reference_voltage#

uint32_t sl_hal_adc_get_internal_reference_voltage (const ADC_TypeDef * adc)

Get the ADC's internal reference voltage in millivolts.

Returns

• The ADC's internal reference voltage in millivolts.

sl_hal_adc_get_timer_frequency#

uint32_t sl_hal_adc_get_timer_frequency (const ADC_TypeDef * adc, uint32_t branch_clock_freq)

Calculate and return the clock frequency of the ADC's local timer.

Returned value is based on the clock branch selected for the ADC peripheral and the current hsclkrate prescaler.

Returns

• The clock frequency of the ADC's local timer.

Note

• The local timer can be used to trigger conversions periodically by setting the timer period with sl_hal_adc_set_timer_period.

The branch_clock_freq can be obtained for adc0 using the Device Manager and Clock Manager services as such:

#include "sl_clock_manager.h"
#include "sl_device_peripheral.h"

sl_clock_branch_t clock_branch;
clock_branch = sl_device_peripheral_get_clock_branch(SL_PERIPHERAL_ADC0);

uint32_t branch_clock_freq;
sl_clock_manager_get_clock_branch_frequency(clock_branch, &branch_clock_freq);

sl_hal_adc_set_timer_period#

void sl_hal_adc_set_timer_period (ADC_TypeDef * adc, uint16_t timer_period)

Set the timer period to periodically trigger a timer event.

Timer events can be used to trigger an ADC scan.

Note

• The ADC's local timer must be disabled before calling this function.

sl_hal_adc_set_clock_prescalers#

void sl_hal_adc_set_clock_prescalers (ADC_TypeDef * adc, uint32_t branch_clock_freq, uint8_t hsclkrate, uint8_t adcprescale)

Set both ADC prescalers.

Re-calculates and updates the timebase.

Note

• The ADC must be disabled before making changes to the clock prescalers. The branch_clock_freq can be obtained for adc0 using the Device Manager and Clock Manager services as such:

  {
    #include "sl_clock_manager.h"
    #include "sl_device_peripheral.h"
  
    sl_clock_branch_t clock_branch;
    clock_branch = sl_device_peripheral_get_clock_branch(SL_PERIPHERAL_ADC0);
  
    uint32_t branch_clock_freq;
    sl_clock_manager_get_clock_branch_frequency(clock_branch, &branch_clock_freq);
  }
  

sl_hal_adc_enable#

void sl_hal_adc_enable (ADC_TypeDef * adc)

Enable the ADC.

sl_hal_adc_disable#

void sl_hal_adc_disable (ADC_TypeDef * adc)

Disable the ADC.

sl_hal_adc_start#

void sl_hal_adc_start (ADC_TypeDef * adc)

Start the ADC.

Note

• Enables the scan sequence and will start a scan if using the immediate trigger mode.

sl_hal_adc_stop#

void sl_hal_adc_stop (ADC_TypeDef * adc)

Stop the ADC.

sl_hal_adc_enable_timer#

void sl_hal_adc_enable_timer (ADC_TypeDef * adc)

Enable the ADC's local timer.

sl_hal_adc_disable_timer#

void sl_hal_adc_disable_timer (ADC_TypeDef * adc)

Disable the ADC's local timer and resets the counter.

sl_hal_adc_flush_fifo#

void sl_hal_adc_flush_fifo (ADC_TypeDef * adc)

Flush the scan FIFO.

Note

• The ADC must be enabled. The operation is completed when SCANFIFOFLUSHING STATUS bit is low. The Scan queue should be disabled. Any incoming scan queue data will be discarded during the flush.

sl_hal_adc_wait_sync#

void sl_hal_adc_wait_sync (ADC_TypeDef * adc)

Wait for ongoing sync of register(s) to the low-frequency domain to complete.

sl_hal_adc_wait_ready#

void sl_hal_adc_wait_ready (ADC_TypeDef * adc)

Wait for disabling to finish.

sl_hal_adc_get_status#

uint32_t sl_hal_adc_get_status (ADC_TypeDef * adc)

Return the content of the status register.

Returns

• Status register.

sl_hal_adc_enable_interrupts#

void sl_hal_adc_enable_interrupts (ADC_TypeDef * adc, uint32_t flags)

Enable one or more ADC interrupts.

sl_hal_adc_disable_interrupts#

void sl_hal_adc_disable_interrupts (ADC_TypeDef * adc, uint32_t flags)

Disable one or more ADC interrupts.

sl_hal_adc_clear_interrupts#

void sl_hal_adc_clear_interrupts (ADC_TypeDef * adc, uint32_t flags)

Clear one or more pending ADC interrupts.

sl_hal_adc_set_interrupts#

void sl_hal_adc_set_interrupts (ADC_TypeDef * adc, uint32_t flags)

Set one or more pending ADC interrupts from software.

sl_hal_adc_get_pending_interrupts#

uint32_t sl_hal_adc_get_pending_interrupts (ADC_TypeDef * adc)

Get pending ADC interrupt flags.

Returns

• Pending ADC interrupt sources.

sl_hal_adc_get_enabled_pending_interrupts#

uint32_t sl_hal_adc_get_enabled_pending_interrupts (ADC_TypeDef * adc)

Get enabled and pending ADC interrupt flags.

Useful for handling more interrupt sources in the same interrupt handler.

Returns

• Pending and enabled ADC interrupt sources.