Some ADC host controller supports grouping multiple ADC channels into a chain. When the chain is triggered to sample ADC data, all ADC channels in the group are sampled in sequence so that client doesn't need to trigger each channel individually. Coverted ADC samples from such chain group can be passed back to the client with a single callback. This data structure is used for ioctl to define ADC chain setting. More...

#include <iot_adc.h>

Data Fields
uint8_t	ucAdcChannel

void *	pvBuffer

uint8_t	ucBufLen

uint16_t	usChainMask

Detailed Description

Some ADC host controller supports grouping multiple ADC channels into a chain. When the chain is triggered to sample ADC data, all ADC channels in the group are sampled in sequence so that client doesn't need to trigger each channel individually. Coverted ADC samples from such chain group can be passed back to the client with a single callback. This data structure is used for ioctl to define ADC chain setting.

Field Documentation

◆ ucAdcChannel

uint8_t IotAdcChain_t::ucAdcChannel

logical ADC channel number as input to ioctl. It is recommended !< that client uses the first ADC channel number in the group as its !< logical number which client can use later to trigger group sampling

◆ pvBuffer

void* IotAdcChain_t::pvBuffer

data buffer used by driver to save converted sample data. !< the buffer is allocated by client and passed to driver to use

◆ ucBufLen

uint8_t IotAdcChain_t::ucBufLen

data buffer length, shall be large enough to hold group sample data

◆ usChainMask

uint16_t IotAdcChain_t::usChainMask

define which ADC channels are in the chain group. !< e.g. 'x' bit set to 1 means ADC channel x is inclued in the group. !< Client shall manage potential ADC channel use conflict.

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