Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
adc_driver_api Struct Reference

@driver_ops{ADC} More...

#include <adc.h>

Data Fields

adc_api_channel_setup channel_setup
 @driver_ops_mandatory Configure an ADC channel.
adc_api_read read
 @driver_ops_mandatory Set a read request.
adc_api_read_async read_async
 @driver_ops_mandatory Set an asynchronous read request.
adc_api_submit submit
 @driver_ops_mandatory Submit a stream request.
adc_api_get_decoder get_decoder
 @driver_ops_optional Get decoder APIs for that device.
uint16_t ref_internal
 @driver_ops_mandatory Internal reference voltage, in millivolts.

Detailed Description

@driver_ops{ADC}

Field Documentation

◆ channel_setup

adc_api_channel_setup adc_driver_api::channel_setup

@driver_ops_mandatory Configure an ADC channel.

◆ get_decoder

adc_api_get_decoder adc_driver_api::get_decoder

@driver_ops_optional Get decoder APIs for that device.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_ADC_STREAM 
.

◆ read

adc_api_read adc_driver_api::read

@driver_ops_mandatory Set a read request.

◆ read_async

adc_api_read_async adc_driver_api::read_async

@driver_ops_mandatory Set an asynchronous read request.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_ADC_ASYNC 
.

◆ ref_internal

uint16_t adc_driver_api::ref_internal

@driver_ops_mandatory Internal reference voltage, in millivolts.

Set to 0 if internal reference is not supported.

◆ submit

adc_api_submit adc_driver_api::submit

@driver_ops_mandatory Submit a stream request.

Attention
Available only when the following Kconfig option is enabled:
CONFIG_ADC_STREAM 
.

The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/adc.h