MityDSP::tcDspAdc9235 Class Reference

Instances of this class create an interface to an ADC9235 12-bit analog to digital converter. More...

#include <core/DspAdc9235.h>

Inheritance diagram for MityDSP::tcDspAdc9235:

List of all members.

Classes
union	tuFifoData
union	tuFifoDataPacked
Public Member Functions
	tcDspAdc9235 (void *apAddress, tcDspAdcBaseConfig *apConfig=NULL, int anLevel=gnAutoLevel)
	This constructor is used to open a tcDspAdc9235 interface with the the specified settings (optional).
	~tcDspAdc9235 ()
	Default destructor.
bool	CheckOverFlowPacked (unsigned int anLword, int anEvenOdd)
	Given a packed data word from the ADC9235 FIFO, this routine will indicate whether or not an overflow condition exists.
unsigned int	GetUserDataPacked (unsigned int anLword, int anEvenOdd)
	Given a packed data word from the ADC9235 FIFO, this routine will return any associated user data.
bool	CheckOverFlow (unsigned int anLword)
	Given an unpacked data word from the ADC9235 FIFO, this routine will indicate whether or not an overflow condition exists.
unsigned int	GetUserData (unsigned int anLword)
	Given an unpacked data word from the ADC9235 FIFO, this routine will return any associated user data.
virtual void	SetCaptureLength (unsigned short Length)
	Sets burst capture quantity.
virtual void	SetPack (bool abPackFIFO)
	Sets whether the ADC data should be packed two samples per 32 bit FIFO word.

---

Detailed Description

Instances of this class create an interface to an ADC9235 12-bit analog to digital converter.

Note:

When using packed mode, the burst capture length must be even.

See also:

tcDspAdc9235 Page

---

Constructor & Destructor Documentation

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

This constructor is used to open a tcDspAdc9235 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:

DspAdc9235.h

DspAdcBase.h

DspIntDispatch.h

tcDspAdc9235::~tcDspAdc9235

(

)

Default destructor.

Returns:

None.

---

Member Function Documentation

bool tcDspAdc9235::CheckOverFlowPacked	(	unsigned int	anLword,
		int	anEvenOdd
	)

Given a packed data word from the ADC9235 FIFO, this routine will indicate whether or not an overflow condition exists.

Parameters:

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

Returns:

Boolean indicating if overflow occurred.

See also:

DspAdc9235.h

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

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

Note:

Bit zero is not valid if saturation mode is enabled (it is used for the overflow indicator in this case).

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.

See also:

DspAdc9235.h

bool tcDspAdc9235::CheckOverFlow

(

unsigned int

anLword

)

Given an unpacked data word from the ADC9235 FIFO, this routine will indicate whether or not an overflow condition exists.

Parameters:

[in]

anLword

Data word from FIFO.

Returns:

Boolean indicating if overflow occurred.

See also:

DspAdc9235.h

unsigned int tcDspAdc9235::GetUserData

(

unsigned int

anLword

)

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

Parameters:

[in]

anLword

Data word from FIFO.

Returns:

Extracted user data.

See also:

DspAdc9235.h

void tcDspAdc9235::SetCaptureLength

(

unsigned short

Length

)

[virtual]

Sets burst capture quantity.

Parameters:

[in]

Length

The number of samples to capture in burst capture mode.

Returns:

None.

Note:

When in packed mode, the length typically refers to number of pairs of samples. For this device, the length still means number of samples. When in packed mode, the capture length must be even and if the supplied length is odd, it is increased by 1 to make it even.

See also:

DspAdc9235.h

Reimplemented from MityDSP::tcDspAdcBase.

void tcDspAdc9235::SetPack

(

bool

abPackFIFO

)

[virtual]

Sets whether the ADC data should be packed two samples per 32 bit FIFO word.

Parameters:

[in]

abPackFIFO

When true two word packing is enabled.

Returns:

None.

Note:

After setting the pack mode, the capture length is reset to make sure it becomes even if it needs to be.

See also:

DspAdc9235.h

Reimplemented from MityDSP::tcDspAdcBase.