Rcuxx::U2F Class Reference
[Implementation of the RCU communications]

#include <U2F.h>

Inheritance diagram for Rcuxx::U2F:

Collaboration diagram for Rcuxx::U2F:

List of all members.

---

Detailed Description

This provides a concrete implementation of the communication protocol to the RCU via the U2F (USB to Front end) driver and library.

Public Member Functions
	~U2F ()
std::string	ErrorString (unsigned int code)
virtual void	SetDebug (int id, int lvl)
virtual unsigned int	ExecCommand (unsigned int cmd)
virtual unsigned int	ReadMemory (unsigned int addr, unsigned int offset, unsigned int &size, unsigned int *data)
virtual unsigned int	WriteMemory (unsigned int addr, unsigned int offset, unsigned int &size, unsigned int *data)
virtual unsigned int	ReadDataMemory (unsigned int lbase, unsigned int hbase, unsigned int offset, unsigned int &size, unsigned int *data)
virtual unsigned int	WriteDataMemory (unsigned int lbase, unsigned int hbase, unsigned int offset, unsigned int &size, unsigned int *data)
Protected Member Functions
	U2F ()
	U2F (const U2F &other)
	U2F (const Url &node, bool debug=false)
void	SetupRegisters ()
Protected Attributes
int	fHandle

---

Constructor & Destructor Documentation

Rcuxx::U2F::~U2F

(

)

Destructor.

Rcuxx::U2F::U2F

(

)

[protected]

Default ctor.

Rcuxx::U2F::U2F

(

const U2F &

other

)

[protected]

Copy ctor.

Rcuxx::U2F::U2F	(	const Url &	node,
		bool	debug = false
	)			[protected]

Create the register interface tab.

---

Member Function Documentation

std::string Rcuxx::U2F::ErrorString

(

unsigned int

code

)

[virtual]

Get an error string corresponding to an error code.

Parameters:

code

The error code

Returns:

Pointer to static string

Reimplemented from Rcuxx::Rcu.

virtual void Rcuxx::U2F::SetDebug	(	int	id,
		int	lvl
	)			[virtual]

Set the debuging stuff.

Reimplemented from Rcuxx::Rcu.

virtual unsigned int Rcuxx::U2F::ExecCommand

(

unsigned int

cmd

)

[virtual]

Execute a command.

Parameters:

cmd

Command to execute

Returns:

0 on success, error code otherwise

Implements Rcuxx::Rcu.

virtual unsigned int Rcuxx::U2F::ReadMemory	(	unsigned int	addr,
		unsigned int	offset,
		unsigned int &	size,
		unsigned int *	data
	)			[virtual]

Read a memory block.

Parameters:

	addr	Base address
	offset	Where to start reading
	size	How many words to read.
	data	Array of data to read into

Returns:

0 on success, error code otherwise

Implements Rcuxx::Rcu.

virtual unsigned int Rcuxx::U2F::WriteMemory	(	unsigned int	addr,
		unsigned int	offset,
		unsigned int &	size,
		unsigned int *	data
	)			[virtual]

Write to a memory block.

Parameters:

	addr	Base address
	offset	Where to start writing
	size	How many words to write
	data	Array of data to write into

Returns:

0 on success, error code otherwise

Implements Rcuxx::Rcu.

virtual unsigned int Rcuxx::U2F::ReadDataMemory	(	unsigned int	lbase,
		unsigned int	hbase,
		unsigned int	offset,
		unsigned int &	size,
		unsigned int *	data
	)			[virtual]

Read a data memory block.

Parameters:

	lbase	Base address for low bits
	hbase	Base address for high bits
	offset	Where to start reading
	size	How many words to read.
	data	Array of data to read into

Returns:

0 on success, error code otherwise

Reimplemented from Rcuxx::Rcu.

virtual unsigned int Rcuxx::U2F::WriteDataMemory	(	unsigned int	lbase,
		unsigned int	hbase,
		unsigned int	offset,
		unsigned int &	size,
		unsigned int *	data
	)			[virtual]

Write a data memory block.

Parameters:

	lbase	Base address for low bits
	hbase	Base address for high bits
	offset	Where to start writing
	size	How many words to write
	data	Array of data to write

Returns:

0 on success, error code otherwise

Reimplemented from Rcuxx::Rcu.

void Rcuxx::U2F::SetupRegisters

(

)

[protected, virtual]

Overloaded from parent.

Reimplemented from Rcuxx::Rcu.

---

Member Data Documentation

int Rcuxx::U2F::fHandle [protected]

Handle to U2F.

---

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

• U2F.h