Public Member Functions

BaseRegister (const char *name, int slotID, unsigned int regID, int r, int w, int len=1, int addrShift=0, int blockLen=1, bool useCache=true)
virtual ~BaseRegister ()
virtual unsigned long read ()
virtual unsigned long read (int elem)
virtual unsigned long read (int elem, int line)
virtual int getActiveBits (int elem=0, unsigned long mask=0xffffffff)
virtual void readBlock (unsigned long *data)
virtual void readBlock (unsigned long *data, unsigned long blockLen)
virtual void readBlock (unsigned long *data, unsigned long start, unsigned long blockLen)
virtual void readBlock (int elem, unsigned long *data)
virtual void readBlock (int elem, unsigned long *data, unsigned long blockLen)
virtual void readBlock (int elem, unsigned long *data, unsigned long start, unsigned long blockLen)
virtual void readElements (int elem0, int elem1, unsigned long *data)
virtual void readElements (unsigned long *data=0)
virtual void write (unsigned long data)
virtual void write (int elem, unsigned long data)
virtual void write (int elem, int line, unsigned long data)
virtual void write (unsigned long *data)
virtual void writeBits (unsigned long data, unsigned long mask, int shift)
virtual void writeBits (int elem, unsigned long data, unsigned long mask, int shift)
virtual void writeBits (int elem, int line, unsigned long data, unsigned long mask, int shift)
virtual void setBitsToHigh (unsigned long mask)
virtual void setBitsToHigh (int elem, unsigned long mask)
virtual void setBitsToLow (unsigned long mask)
virtual void setBitsToLow (int elem, unsigned long mask)
unsigned long getCache (int elem=0, int line=0)
void getCache (unsigned long *data)
void setCache (unsigned long data)
void setCache (int elem, unsigned long data)
virtual void setCacheBits (unsigned long data, unsigned long mask, int shift)
virtual void setCacheBits (int elem, unsigned long data, unsigned long mask, int shift)
virtual void writeCache ()
virtual void writeCache (int elem)
virtual void writeCache (int elem, int line)
virtual int writeBitsByName (char *name, unsigned long data)
const char * getName ()
bool isReadable ()
bool isWriteable ()
unsigned long getAddr ()
virtual int getLength ()
int getBlockLength ()
unsigned long getAddrShift ()
bool isCacheEnabled ()

Public Attributes

BaseRegisterItem ** itemList
int itemN

Protected Attributes

unsigned long addr
unsigned long addrShift
int len
int blockLen
const char * name
bool readable
bool writeable
bool useCache
bool hasCBWOBits
bool isMemory
unsigned long * cache

Detailed Description

The class contains the register address modell of the SLT board.

The individual register address is calculated from the slot ID and the register ID.

The register implementation contains a cache function to avoid unneccessary access to the hardware. To decode the status bits the cache content can be used without storing any additional intermediate data.

Definition at line 148 of file baseregister.h.

Constructor & Destructor Documentation

hw4::BaseRegister::BaseRegister	(	const char *	name,
		int	slotID,
		unsigned int	regID,
		int	r,
		int	w,
		int	len = `1`,
		int	addrShift = `0`,
		int	blockLen = `1`,
		bool	useCache = `true`
	)

A register (slt object) is defined by it's name and the combination of slot ID and register ID.

Every register also posses the properties readable and writeable. The register object can also be used to access register vectors and memories. For a register vector the number of elements and the address shift needs to be specified. A memory need also this both parameters. Memoreis span a contiuous space so that block access can be used to get the data for all elements.

virtual hw4::BaseRegister::~BaseRegister ( ) [virtual]

The destructor deletes all entries from the item list when called.

Do not remove the item list in the specific register implementation.

Member Function Documentation

virtual int hw4::BaseRegister::getActiveBits	(	int	elem = `0`,
		unsigned long	mask = `0xffffffff`
	)		`[virtual]`

Get number of active bits.

unsigned long hw4::BaseRegister::getAddr ( )

Get address.

unsigned long hw4::BaseRegister::getAddrShift ( )

int hw4::BaseRegister::getBlockLength ( )

unsigned long hw4::BaseRegister::getCache	(	int	elem = `0`,
		int	line = `0`
	)

Get the cache value.

This command will not read any data from the hardware.

void hw4::BaseRegister::getCache ( unsigned long * data )

virtual int hw4::BaseRegister::getLength ( ) [virtual]

Reimplemented in hw4::SltByteRegister, and hw4::FltMemory.

const char* hw4::BaseRegister::getName ( )

bool hw4::BaseRegister::isCacheEnabled ( )

Cache management.

If the cache is disabled any access to the cache will cause an exception.

bool hw4::BaseRegister::isReadable ( )

bool hw4::BaseRegister::isWriteable ( )

virtual unsigned long hw4::BaseRegister::read ( ) [virtual]

Read the register return the data and store it in the object cache.

Default: Read all data

Reimplemented in hw4::FltPeriphRegister, hw4::SltCounter, hw4::BaseRegister64, and hw4::SltSecondCounter.

virtual unsigned long hw4::BaseRegister::read ( int elem ) [virtual]

Read the register return the data and store it in the object cache.

Read all data of a element.

Reimplemented in hw4::FltPeriphRegister.

virtual unsigned long hw4::BaseRegister::read	(	int	elem,
		int	line
	)		`[virtual]`

Read the register return the data and store it in the object cache.

Reads all 'line's of item number 'elem'.

Reimplemented in hw4::FltPeriphRegister, hw4::SltByteRegister, and hw4::FltMemory.

virtual void hw4::BaseRegister::readBlock ( unsigned long * data ) [virtual]