Instances of this class create an interface to an ADS8329 16-bit analog to digital converter. More...
#include <core/DspAdc8329.h>
Classes | |
union | tuCfgWord |
union | tuFifoData |
union | tuFifoDataPacked |
Public Member Functions | |
tcDspAdc8329 (void *apAddress, tcDspAdcBaseConfig *apConfig=NULL, int anLevel=gnAutoLevel) | |
This constructor is used to open a tcDspAdc8329 interface with the the specified settings (optional). | |
~tcDspAdc8329 () | |
Default destructor. | |
unsigned int | GetUserDataPacked (unsigned int anLword, int anEvenOdd) |
Given a packed data word from the ADC8329 FIFO, this routine will return any associated user data. | |
unsigned int | GetUserData (unsigned int anLword) |
Given an unpacked data word from the ADC8329 FIFO, this routine will return any associated user data. | |
int | IssueReset (void) |
Issue a software reset for the device. | |
Public Member Functions inherited from MityDSP::tcDspAdcBase | |
tcDspAdcBase (void *apAddress, int anLevel=gnAutoLevel) | |
This constructor is used to open a DspAdc interface with the specified settings (optional). | |
~tcDspAdcBase () | |
This destructor is used to close up and free the resources tied to the associated ADC interface. | |
virtual void | SetPack (bool abPackFIFO) |
Sets whether the ADC data should be packed two samples per 32 bit FIFO word. | |
virtual void | SetFlipBit (bool abFlipBit) |
Sets whether the ADC data should flip the most significant bit. | |
virtual void | SetUDClear (bool abABClear) |
Sets whether the user data sent to the ADC should be masked with zeros. | |
virtual void | SetExtTrigger (bool abTrigger) |
Sets trigger mode of device. | |
virtual void | SetBurstCapture (bool abBurstCapture) |
Sets capture mode of device. | |
virtual void | SetCaptureDelay (unsigned short Delay) |
Sets burst capture delay of device. | |
virtual void | SetCaptureLength (unsigned short Length) |
Sets burst capture quantity. | |
virtual void | SetSaturationMode (bool abEnable) |
Sets saturation mode. | |
virtual void | SetDifferentialMode (bool abEnable) |
Sets differential mode. | |
virtual void | SetChannelMask (unsigned int anMask) |
Sets the channel mask bits. | |
virtual bool | GetPack (void) |
Gets packing mode. | |
virtual bool | GetFlipBit (void) |
Gets Flip Bit Mode. | |
virtual bool | GetUDClear (void) |
Gets User Data Clearing Mode. | |
virtual bool | GetExtTrigger (void) |
Gets External Trigger Mode. | |
virtual bool | GetBurstCapture (void) |
Gets Capture Mode. | |
virtual unsigned short | GetCaptureDelay (void) |
Gets Capture Delay Length (minus 1). | |
virtual unsigned short | GetCaptureLength (void) |
Gets Capture Length. | |
virtual bool | GetSaturationMode (void) |
Returns the saturation mode. | |
virtual bool | GetDifferentialMode (void) |
Returns the differential mode. | |
virtual unsigned int | GetChannelMask (void) |
Returns the channel mask. | |
virtual void | Enable (bool abEnable) |
Enables the capture enginer for the ADC. | |
virtual bool | IsEnabled (void) |
Returns the enabled state of the capture engine. | |
virtual bool | GetFIFOLevel (teFIFOLevel level) |
Gets FIFO Level flag. | |
virtual unsigned short | GetFIFOLevel (void) |
Gets FIFO Level. | |
virtual bool | IsBurstComplete (void) |
Gets Burst Complete flag. | |
virtual void | ClearBurstComplete (void) |
Clears Burst Complete flag. | |
virtual void | DisableFIFOInterrupts (void) |
Clears Any Set FIFO Interrupt Enables. | |
virtual void | SetFIFOInterruptLevel (teFIFOLevel aeLevel) |
Sets the FIFO interrupt based on the level specified. | |
virtual void | SetBCInterrupt (bool Enable) |
Sets the Burst Complete Interrupt Enable Flag based on the Enable Flag. | |
virtual void | RegisterFIFOHandler (teFIFOLevel aeLevel, tfIsrCallback afCallback) |
Registers the specified ISR callback for the given FIFO level interrupt. | |
virtual void | RegisterFIFOHandler (teFIFOLevel aeLevel, tfIsrCallbackWithArg afCallback, void *apUserArg=NULL) |
Registers the specified ISR callback for the given FIFO level interrupt. | |
virtual void | RegisterBCHandler (tfIsrCallback afCallback) |
Registers the specified ISR callback for the burst complete interrupt. | |
virtual void | RegisterBCHandler (tfIsrCallbackWithArg afCallback, void *apUserArg=NULL) |
Registers the specified ISR callback for the burst complete interrupt. | |
virtual unsigned int * | GetFIFODataPtr (void) |
Returns the pointer to the FIFO containing captured ADC data. | |
virtual unsigned int | GetFIFODepth (void) |
Returns the depth (in 32 bit words) of the FIFO. | |
virtual bool | DrainFIFO (void) |
This routine will drain the FIFO on the engine. |
Instances of this class create an interface to an ADS8329 16-bit analog to digital converter.
tcDspAdc8329::tcDspAdc8329 | ( | void * | apAddress, |
tcDspAdcBaseConfig * | apConfig = NULL , |
||
int | anLevel = gnAutoLevel |
||
) |
This constructor is used to open a tcDspAdc8329 interface with the the specified settings (optional).
The interface is not yet enabled for capture following construction.
This constructor registers the capabilities of this particular ADC with the base class.
[in] | apAddress | Base Address of the ADC core |
[in] | apConfig | Optional Configuration Structure |
[in] | anLevel | The interrupt vector used by the core (default: gnAutoLevel). |
tcDspAdc8329::~tcDspAdc8329 | ( | ) |
Default destructor.
unsigned int tcDspAdc8329::GetUserDataPacked | ( | unsigned int | anLword, |
int | anEvenOdd | ||
) |
Given a packed data word from the ADC8329 FIFO, this routine will return any associated user data.
[in] | anLword | Data word from FIFO. |
[in] | anEvenOdd | Extract data from even or odd word of packed data (even int = even). |
unsigned int tcDspAdc8329::GetUserData | ( | unsigned int | anLword | ) |
Given an unpacked data word from the ADC8329 FIFO, this routine will return any associated user data.
[in] | anLword | Data word from FIFO. |
int tcDspAdc8329::IssueReset | ( | void | ) |
Issue a software reset for the device.
This routine will stall the calling routine for approximately 340 ms (the require reset interval). This routine should be called while the ADC is not enabled.