---

SctPixelRod::TimModule Class Reference

TimModule: A derived class for VME TIM modules. More...

#include <TimModule.h>

Inheritance diagram for SctPixelRod::TimModule:

Public Member Functions
	TimModule (UINT32 baseAddr, UINT32 mapSize, VmeInterface &ourInterface)
virtual	~TimModule ()
UINT32	getFirmware ()
UINT32	getSerialNumber ()
VmePort *	getVmePort ()
void	initialize ()
	Pure virtual method for initialization.
void	reset ()
	Pure virtual method to reset module.
void	status ()
	Pure virtual method to report module status.
UINT32	fetchL1ID ()
	Read trigger number.
UINT16	fetchTimID ()
	Read TIM ID register.
void	intTrigStart (const TimMaskFrequency frequency)
	Internal Trigger.
void	intTrigStop ()
	Stop Internal Trigger.
void	issueCommand (const TimBitCommand mask)
	Issue TIM command.
void	issueVCAL (const UINT8 pipelineDelay)
	Issue VCAL + L1A command.
void	loadBitClear (const TimRegister addr, const UINT16 mask)
	Clear bit.
void	loadBitSet (const TimRegister addr, const UINT16 mask)
	Set bit.
void	loadByteHi (const TimRegister addr, const UINT8 byte)
	Upper byte.
void	loadByteLo (const TimRegister addr, const UINT8 byte)
	Lower byte.
UINT16	regFetch (const TimRegister addr)
	Read from a 16-bit VME register.
void	regLoad (const TimRegister addr, const UINT16 data)
	Write to a 16-bit VME register.
void	seqFetch (const UINT16 size, UINT16 buffer[])
	Read sequencer.
void	seqLoad (const UINT16 size, const UINT16 buffer[])
	Load sequencer.
void	seqRun (const UINT16 size)
	Run sequencer.
UINT16	vmeFetch (const UINT32 addr) throw (VmeException &)
	Read from a 16-bit VME register.
void	vmeLoad (const UINT32 addr, const UINT16 data) throw (VmeException &)
	Write to a 16-bit VME register.
Private Attributes
UINT32	m_firmware
	Firmware version number.
UINT32	m_serialNumber
	Board serial number.
VmePort *	m_vmePort
	VME Port handle.

---

Detailed Description

TimModule: A derived class for VME TIM modules.

This is the implementation of a TIM class derived from the VmeModule base class. It should be the sole interface for VME communication with TIM.

Contributors: John Lane <jbl@hep.ucl.ac.uk> - originator

Definition at line 76 of file TimModule.h.

---

Constructor & Destructor Documentation

SctPixelRod::TimModule::TimModule (  UINT32    baseAddr, UINT32    mapSize, VmeInterface &    ourInterface )

virtual SctPixelRod::TimModule::~TimModule (    )  [virtual]

---

Member Function Documentation

UINT32 SctPixelRod::TimModule::fetchL1ID (    )

Read trigger number.

UINT16 SctPixelRod::TimModule::fetchTimID (    )

Read TIM ID register.

UINT32 SctPixelRod::TimModule::getFirmware (    )  [inline]

Definition at line 89 of file TimModule.h. References m_firmware.

UINT32 SctPixelRod::TimModule::getSerialNumber (    )  [inline]

Definition at line 90 of file TimModule.h. References m_serialNumber.

VmePort* SctPixelRod::TimModule::getVmePort (    )  [inline]

Definition at line 91 of file TimModule.h. References m_vmePort.

void SctPixelRod::TimModule::initialize (    )  [virtual]

Pure virtual method for initialization. Implements SctPixelRod::VmeModule.

void SctPixelRod::TimModule::intTrigStart (  const TimMaskFrequency    frequency )

Internal Trigger.

void SctPixelRod::TimModule::intTrigStop (    )

Stop Internal Trigger.

void SctPixelRod::TimModule::issueCommand (  const TimBitCommand    mask )

Issue TIM command.

void SctPixelRod::TimModule::issueVCAL (  const UINT8    pipelineDelay )

Issue VCAL + L1A command.

void SctPixelRod::TimModule::loadBitClear (  const TimRegister    addr, const UINT16    mask )

Clear bit.

void SctPixelRod::TimModule::loadBitSet (  const TimRegister    addr, const UINT16    mask )

Set bit.

void SctPixelRod::TimModule::loadByteHi (  const TimRegister    addr, const UINT8    byte )

Upper byte.

void SctPixelRod::TimModule::loadByteLo (  const TimRegister    addr, const UINT8    byte )

Lower byte.

UINT16 SctPixelRod::TimModule::regFetch (  const TimRegister    addr )

Read from a 16-bit VME register.

void SctPixelRod::TimModule::regLoad (  const TimRegister    addr, const UINT16    data )

Write to a 16-bit VME register.

void SctPixelRod::TimModule::reset (    )  [virtual]

Pure virtual method to reset module. Implements SctPixelRod::VmeModule.

void SctPixelRod::TimModule::seqFetch (  const UINT16    size, UINT16    buffer[] )

Read sequencer.

void SctPixelRod::TimModule::seqLoad (  const UINT16    size, const UINT16    buffer[] )

Load sequencer.

void SctPixelRod::TimModule::seqRun (  const UINT16    size )

Run sequencer.

void SctPixelRod::TimModule::status (    )  [virtual]

Pure virtual method to report module status. Implements SctPixelRod::VmeModule.

UINT16 SctPixelRod::TimModule::vmeFetch (  const UINT32    addr )  throw (VmeException &)

Read from a 16-bit VME register.

void SctPixelRod::TimModule::vmeLoad (  const UINT32    addr, const UINT16    data )  throw (VmeException &)

Write to a 16-bit VME register.

---

Field Documentation

UINT32 SctPixelRod::TimModule::m_firmware [private]

Firmware version number. Definition at line 131 of file TimModule.h. Referenced by getFirmware().

UINT32 SctPixelRod::TimModule::m_serialNumber [private]

Board serial number. Definition at line 132 of file TimModule.h. Referenced by getSerialNumber().

VmePort* SctPixelRod::TimModule::m_vmePort [private]

VME Port handle. Definition at line 133 of file TimModule.h. Referenced by getVmePort().

---

The documentation for this class was generated from the following file:

• TimModule.h

---