MityDSP::tcDspAdc8402 Class Reference

Instances of this class create an interface to an ADS8402 16-bit analog to digital converter. More...

#include <core/DspAdc8402.h>

Inheritance diagram for MityDSP::tcDspAdc8402:

List of all members.

Classes
union	tuFifoData
union	tuFifoDataPacked
Public Member Functions
	tcDspAdc8402 (void *apAddress, tcDspAdcBaseConfig *apConfig=NULL, int anLevel=gnAutoLevel)
	This constructor is used to open a tcDspAdc8402 interface with the the specified settings (optional).
	~tcDspAdc8402 ()
	Default destructor.
unsigned int	GetUserDataPacked (unsigned int anLword, int anEvenOdd)
	Given a packed data word from the ADC8402 FIFO, this routine will return any associated user data.
unsigned int	GetUserData (unsigned int anLword)
	Given an unpacked data word from the ADC8402 FIFO, this routine will return any associated user data.
unsigned int	GetLatestSample (void)
	Returns the most recent sample clocked in from ADC8402 device, as if polling the ADC for a readout.

---

Detailed Description

Instances of this class create an interface to an ADS8402 16-bit analog to digital converter.

See also:

tcDspAdc8402 Page

---

Constructor & Destructor Documentation

tcDspAdc8402::tcDspAdc8402	(	void *	apAddress,
		tcDspAdcBaseConfig *	apConfig = NULL,
		int	anLevel = gnAutoLevel
	)

This constructor is used to open a tcDspAdc8402 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.

Parameters:

[in]	apAddress	Base Address of the ADC core
[in]	apConfig	Optional Configuration Structure
[in]	anLevel	The interrupt vector used by the core (default: gnAutoLevel).

Returns:

None.

See also:

DspAdc8402.h

DspAdcBase.h

DspIntDispatch.h

tcDspAdc8402::~tcDspAdc8402

(

)

Default destructor.

Returns:

None.

---

Member Function Documentation

unsigned int tcDspAdc8402::GetUserDataPacked	(	unsigned int	anLword,
		int	anEvenOdd
	)

Given a packed data word from the ADC8402 FIFO, this routine will return any associated user data.

Note:

There is no user data available in packed mode. This routine is provided only for consistency with other ADC's which do allow user data in packed mode.

Parameters:

[in]	anLword	Data word from FIFO.
[in]	anEvenOdd	Extract data from even or odd word of packed data (even int = even).

Returns:

Extracted user data (always zero for this device).

See also:

DspAdc8402.h

unsigned int tcDspAdc8402::GetUserData

(

unsigned int

anLword

)

Given an unpacked data word from the ADC8402 FIFO, this routine will return any associated user data.

Parameters:

[in]

anLword

Data word from FIFO.

Returns:

Extracted user data.

See also:

DspAdc8402.h

unsigned int tcDspAdc8402::GetLatestSample

(

void

)

Returns the most recent sample clocked in from ADC8402 device, as if polling the ADC for a readout.

Returns:

The most recent sample that may be injected into the FIFO if the capture engine were running (this may be a PACKED sample).

See also:

DspAdc8402.h