gdump.h File Reference

Defines methods for dumping the gnat driver control registers. More...

Functions
int	gDumpCtrlReg (gnatHandle gh, LOG_level lLevel)
	logs the contents of the control register
int	gDumpStatReg (gnatHandle gh, LOG_level lLevel)
	logs the contents of the status register
int	gDumpPFReg (gnatHandle gh)
	logs the contents of the play back FIFO register
int	gDumpRFReg (gnatHandle gh)
	logs the contents of the record back FIFO register
int	gDumpIntReg (gnatHandle gh, LOG_level lLevel)
	logs the contents of the interrupt config register
int	gDumpAll (gnatHandle gh)
	dumps the contents of the control and status registers

---

Detailed Description

Defines methods for dumping the gnat driver control registers.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int gDumpAll

(

gnatHandle

gh

)

dumps the contents of the control and status registers

Parameters:

gh

handle of device

Returns:

OK if successful

References gDumpCtrlReg(), gDumpStatReg(), and VERIFY_HANDLE.

int gDumpCtrlReg	(	gnatHandle	gh,
		LOG_level	lLevel
	)

logs the contents of the control register

Parameters:

	gh	handle of device
	lLevel	logging level

Returns:

OK if successful

References _LOG1, _regControl::bf, _BFregControl::c0delay, _BFregControl::chn0clk, _BFregControl::dataChn, G_OK, _gnat::m_baseAddr, _regBlock::m_ctrlReg, _BFregControl::mode, OK, _BFregControl::pfmr, _BFregControl::pfpr, _BFregControl::rbcDelay, _BFregControl::rbfwDelay, _BFregControl::rfmr, _BFregControl::rfpr, _BFregControl::startAcq, _BFregControl::startAcqSrc, _regControl::ui, and VERIFY_HANDLE.

Referenced by gDumpAll().

int gDumpIntReg	(	gnatHandle	gh,
		LOG_level	lLevel
	)

logs the contents of the interrupt config register

Parameters:

	gh	handle of device
	lLevel	logging level

Returns:

OK if successful

References _LOG1, _regInt::bf, _BFregInt::delay, G_OK, _BFregInt::irq, _gnat::m_baseAddr, _regBlock::m_intReg, OK, _regInt::ui, _BFregInt::vec, and VERIFY_HANDLE.

int gDumpPFReg

(

gnatHandle

gh

)

logs the contents of the play back FIFO register

Parameters:

gh

handle of device

Returns:

OK if successful WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

Reading the FIFO is a destructive read

References _LOG1, _regPF::bf, _BFregPF::data, G_OK, _gnat::m_baseAddr, _regBlock::m_pfReg, OK, _regPF::ui, _BFregPF::unused1, and VERIFY_HANDLE.

int gDumpRFReg

(

gnatHandle

gh

)

logs the contents of the record back FIFO register

Parameters:

gh

handle of device

Returns:

OK if successful WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

Reading the FIFO is a destructive read

References _LOG1, _regRF::bf, _BFregRF::data, G_OK, _gnat::m_baseAddr, _regBlock::m_rfReg, OK, _regRF::ui, _BFregRF::unused1, and VERIFY_HANDLE.

int gDumpStatReg	(	gnatHandle	gh,
		LOG_level	lLevel
	)

logs the contents of the status register

Parameters:

	gh	handle of device
	lLevel	logging level

Returns:

OK if successful

References _LOG1, _regStatus::bf, G_OK, _BFregStatus::hwRev, _BFregStatus::hwVer, _gnat::m_baseAddr, _regBlock::m_statReg, OK, _BFregStatus::pfaec, _BFregStatus::pfael, _BFregStatus::pfafc, _BFregStatus::pfafl, _BFregStatus::pfec, _BFregStatus::pfel, _BFregStatus::pffc, _BFregStatus::pffl, _BFregStatus::rfaec, _BFregStatus::rfael, _BFregStatus::rfafc, _BFregStatus::rfafl, _BFregStatus::rfec, _BFregStatus::rfel, _BFregStatus::rffc, _BFregStatus::rffl, _BFregStatus::runState, _BFregStatus::swRev, _BFregStatus::swVer, _regStatus::ui, _BFregStatus::unused1, and VERIFY_HANDLE.

Referenced by gDumpAll().