FreeRTOS: Common I/O
AWS IoT Common I/O library
Return to main page ↑
Data Structures
Here are the data structures with brief descriptions:
 CIotAdcChain_tSome 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
 CIotAdcChBuffer_tData 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
 CIotAdcChStatus_tData structure for ioctl GetChStatus
 CIotAdcConfig_tData structures for ioctl request
 CIotBatteryInfo_tBattery information
 CIotFlashInfo_tFlash information
 CIotFlashWriteProtectConfig_tFlash protection configuration
 CIotI2CConfig_tI2C bus configuration
 CIotI2sIoctlConfig_tI2S configuration
 CIotPowerWakeupSources_tWakeup source information
 CIotPwmConfig_tPWM configuration type
 CIotRtcDatetime_tRTC date and time format info
 CIotSPIMasterConfig_tThe configuration parameters for SPI Master
 CIotUARTConfig_tConfiguration parameters for the UART
 CIotUsbDeviceEndpointConfig_tEndpoint configuration structure
 CIotUsbDeviceEndpointInfo_tEndpoint status structure