MityDSP::tcDspAdc8329 Class Reference

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

#include <core/DspAdc8329.h>

Inheritance diagram for MityDSP::tcDspAdc8329:

List of all members.

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.

---

Detailed Description

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

See also:

tcDspAdc8329 Page

---

Constructor & Destructor Documentation

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.

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:

DspAdc8329.h

DspAdcBase.h

DspIntDispatch.h

tcDspAdc8329::~tcDspAdc8329

(

)

Default destructor.

Returns:

None.

---

Member Function Documentation

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.

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:

DspAdc8329.h

unsigned int tcDspAdc8329::GetUserData

(

unsigned int

anLword

)

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

Parameters:

[in]

anLword

Data word from FIFO.

Returns:

Extracted user data.

See also:

DspAdc8329.h

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.

Returns:

non-zero on error 0 on success

See also:

DspAdc8329.h