Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
adc_data_generic_header Struct Reference

Generic header for encoded ADC streaming frames. More...

#include <zephyr/drivers/adc.h>

Data Fields

uint64_t timestamp_ns
 Timestamp (in nanoseconds) at which the data was collected.
uint8_t num_channels
 Number of channels present in this frame.
int8_t shift
 Shift value for Q-format decoding of all samples in the frame.
struct adc_chan_spec channels [0]
 Channel specifications for the channels present in the frame.

Detailed Description

Generic header for encoded ADC streaming frames.

This packed structure is placed at the beginning of each frame produced by the ADC RTIO subsystem. It provides the metadata needed to re-assemble the samples that follow.

Field Documentation

◆ channels

struct adc_chan_spec adc_data_generic_header::channels[0]

Channel specifications for the channels present in the frame.

◆ num_channels

uint8_t adc_data_generic_header::num_channels

Number of channels present in this frame.

◆ shift

int8_t adc_data_generic_header::shift

Shift value for Q-format decoding of all samples in the frame.

◆ timestamp_ns

uint64_t adc_data_generic_header::timestamp_ns

Timestamp (in nanoseconds) at which the data was collected.


The documentation for this struct was generated from the following file: