ADuCM4x50 Device Drivers API Reference Manual  Release 4.0.0.0
__ADI_ADC_BUFFER Struct Reference

#include <adi_adc.h>

Data Fields

uint32_t nChannels
 
void * pDataBuffer
 
uint32_t nNumConversionPasses
 
uint32_t nBuffSize
 

Detailed Description

Structure which hold the details of the buffer and sampling details

Definition at line 114 of file adi_adc.h.

Field Documentation

◆ nChannels

uint32_t nChannels

Channels to sample. Should be an ORed value of ADI_ADC_CHANNEL enum

Definition at line 115 of file adi_adc.h.

Referenced by adi_adc_SubmitBuffer().

◆ pDataBuffer

void* pDataBuffer

Pointer to the Buffer to read the sample value into. If single channel(say Channel 0) is selected then the format of buffer will be <Chan0 conversion 0><Chan0 conversion 1><Chan0 conversion 2>.... but if multiple channels (say Channel 1 and Channel2) are selected then the format of buffer will be <Chan1 conversion 0><Chan2 conversion 0><Chan1 conversion 1><Chan2 conversion 1><Chan1 conversion 2><Chan2 conversion 2>....
The pBuffer should be 2 byte aligned.

If N is the number of channels selected then in single iteration mode the number of samples written to in the buffer will be N and for multiple iteration, the driver will try to fill the whole buffer with data and it is preferred that the nBuffSize be able to accommodate a multiple of N samples.

Definition at line 116 of file adi_adc.h.

Referenced by adi_adc_SubmitBuffer().

◆ nNumConversionPasses

uint32_t nNumConversionPasses

Num of conversion passes

Definition at line 126 of file adi_adc.h.

Referenced by adi_adc_SubmitBuffer().

◆ nBuffSize

uint32_t nBuffSize

Size of the buffer supplied

Definition at line 127 of file adi_adc.h.