File syn_adc.c

FileList > drivers > syn_adc.c

Go to the source code of this file

General-purpose ADC driver implementation.

• #include "../util/syn_assert.h"
• #include "syn_adc.h"
• #include <string.h>

Public Functions

Type	Name
SYN_Status	syn_adc_deinit (SYN_ADC * adc) De-initialize an ADC instance.
SYN_Status	syn_adc_init (SYN_ADC * adc, const SYN_ADC_Config * cfg) Initialize an ADC instance.
uint32_t	syn_adc_read_mv (SYN_ADC * adc, uint8_t channel) Read a single channel as calibrated millivolts (0..vref_mv).
uint16_t	syn_adc_read_raw (SYN_ADC * adc, uint8_t channel) Read a single channel as raw 12-bit count (0..4095).
SYN_Status	syn_adc_start_dma_scan (SYN_ADC * adc, uint16_t * buf, size_t num_channels) Start continuous multi-channel background scanning into SRAM via DMA.

Public Functions Documentation

function syn_adc_deinit

De-initialize an ADC instance.

SYN_Status syn_adc_deinit (
    SYN_ADC * adc
) 

Parameters:

• adc Pointer to SYN_ADC handle.

Returns:

SYN_OK on success.

---

function syn_adc_init

Initialize an ADC instance.

SYN_Status syn_adc_init (
    SYN_ADC * adc,
    const SYN_ADC_Config * cfg
) 

Parameters:

• adc Pointer to user-allocated SYN_ADC handle.
• cfg Configuration parameters.

Returns:

SYN_OK on success.

---

function syn_adc_read_mv

Read a single channel as calibrated millivolts (0..vref_mv).

uint32_t syn_adc_read_mv (
    SYN_ADC * adc,
    uint8_t channel
) 

Parameters:

• adc Pointer to initialized ADC handle.
• channel Channel index (0..18).

Returns:

Calibrated voltage in millivolts.

---

function syn_adc_read_raw

Read a single channel as raw 12-bit count (0..4095).

uint16_t syn_adc_read_raw (
    SYN_ADC * adc,
    uint8_t channel
) 

Parameters:

• adc Pointer to initialized ADC handle.
• channel Channel index (0..18).

Returns:

12-bit raw conversion count.

---

function syn_adc_start_dma_scan

Start continuous multi-channel background scanning into SRAM via DMA.

SYN_Status syn_adc_start_dma_scan (
    SYN_ADC * adc,
    uint16_t * buf,
    size_t num_channels
) 

Parameters:

• adc Pointer to initialized ADC handle.
• buf Destination buffer in SRAM.
• num_channels Number of active channels in scan sequence.

Returns:

SYN_OK on success.

---

---

The documentation for this class was generated from the following file src/syntropic/drivers/syn_adc.c