ADC Driver Backend API

Data Structures
struct	adc_driver_api
	Driver Operations ADC driver operations More...

Typedefs
typedef int(*	adc_api_channel_setup) (const struct device *dev, const struct adc_channel_cfg *channel_cfg)
	Type definition of ADC API function for configuring a channel.
typedef int(*	adc_api_read) (const struct device *dev, const struct adc_sequence *sequence)
	Type definition of ADC API function for setting a read request.
typedef void(*	adc_api_submit) (const struct device *dev, struct rtio_iodev_sqe *sqe)
	Type definition of ADC API function for submitting a stream request.
typedef int(*	adc_api_get_decoder) (const struct device *dev, const struct adc_decoder_api **api)
	Get the decoder associate with the given device.
typedef int(*	adc_api_read_async) (const struct device *dev, const struct adc_sequence *sequence, struct k_poll_signal *async)
	Type definition of ADC API function for setting an asynchronous read request.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a ADC driver.

Typedef Documentation

adc_api_channel_setup

typedef int(* adc_api_channel_setup) (const struct device *dev, const struct adc_channel_cfg *channel_cfg)

#include <zephyr/drivers/adc.h>

Type definition of ADC API function for configuring a channel.

See adc_channel_setup() for argument descriptions.

adc_api_get_decoder

typedef int(* adc_api_get_decoder) (const struct device *dev, const struct adc_decoder_api **api)

#include <zephyr/drivers/adc.h>

Get the decoder associate with the given device.

See also

adc_get_decoder() for more details

adc_api_read

typedef int(* adc_api_read) (const struct device *dev, const struct adc_sequence *sequence)

#include <zephyr/drivers/adc.h>

Type definition of ADC API function for setting a read request.

See adc_read() for argument descriptions.

adc_api_read_async

typedef int(* adc_api_read_async) (const struct device *dev, const struct adc_sequence *sequence, struct k_poll_signal *async)

#include <zephyr/drivers/adc.h>

Type definition of ADC API function for setting an asynchronous read request.

See adc_read_async() for argument descriptions.

adc_api_submit

typedef void(* adc_api_submit) (const struct device *dev, struct rtio_iodev_sqe *sqe)

#include <zephyr/drivers/adc.h>

Type definition of ADC API function for submitting a stream request.