IotAdcChBuffer_t Struct Reference

data structure for ioctl SetChBuffer setting channel data buffer is optional using this ioctl if client doesn't pass in data buffer for driver to use, callback is triggered for every ADC sample to pass data back to client as driver doesn't have buffer to accumulate data. As soon as callback returns, xConverted_Data becomes invalid. On the other hand however if client does pass a buffer for driver to use, callback is triggered only after driver has filled buffer with xBufLen samples, client buffer is passed back in callback as XConverted_Data whose life span is controlled by the client even after callback returns. More...

#include <iot_adc.h>

Data Fields
uint8_t	ucAdcChannel
void *	pvBuffer
uint8_t	ucBufLen

Detailed Description

data structure for ioctl SetChBuffer setting channel data buffer is optional using this ioctl if client doesn't pass in data buffer for driver to use, callback is triggered for every ADC sample to pass data back to client as driver doesn't have buffer to accumulate data. As soon as callback returns, xConverted_Data becomes invalid. On the other hand however if client does pass a buffer for driver to use, callback is triggered only after driver has filled buffer with xBufLen samples, client buffer is passed back in callback as XConverted_Data whose life span is controlled by the client even after callback returns.

Field Documentation

ucAdcChannel

uint8_t IotAdcChBuffer_t::ucAdcChannel

Adc Channel number

pvBuffer

void* IotAdcChBuffer_t::pvBuffer

Buffer to store adc results in

ucBufLen

uint8_t IotAdcChBuffer_t::ucBufLen

Max buffer length to write into pvBuffer

---

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

• iot_adc.h