Rcuxx::RcuRMEM Struct Reference
[RCU interface classes]

#include <rcuxx/Rcu.h>

Inheritance diagram for Rcuxx::RcuRMEM:

Collaboration diagram for Rcuxx::RcuRMEM:

List of all members.

---

Detailed Description

Interface to the RCU result memory.

Public Member Functions
	RcuRMEM (Rcu &rcu, size_t base, size_t n, unsigned int mask)
unsigned int	FecRead (unsigned int addr, unsigned int &data, unsigned int off=0)
unsigned int	FecWrite (unsigned int addr, unsigned int data, unsigned int off=0)
unsigned int	FecCommand (unsigned int addr, unsigned int off=0)

---

Constructor & Destructor Documentation

Rcuxx::RcuRMEM::RcuRMEM	(	Rcu &	rcu,
		size_t	base,
		size_t	n,
		unsigned int	mask
	)			[inline]

Constructor.

Parameters:

	rcu	Reference to low-level interface
	base	Base address
	n	Number of words

---

Member Function Documentation

unsigned int Rcuxx::RcuRMEM::FecRead	(	unsigned int	addr,
		unsigned int &	data,
		unsigned int	off = 0
	)			[inline]

Read ALTRO bus register.

Parameters:

	addr	Full address of read register
	data	Data read
	off	Offset in RMEM

Returns:

0 on success, error code otherwise

References Rcuxx::RcuMemory::fData, Rcuxx::RcuMemory::fRcu, Rcuxx::Rcu::Layout(), and Rcuxx::RcuMemory::Update().

Referenced by Rcuxx::AltroRegister::Read().

unsigned int Rcuxx::RcuRMEM::FecWrite	(	unsigned int	addr,
		unsigned int	data,
		unsigned int	off = 0
	)			[inline]

Write ALTRO bus register.

Parameters:

	addr	Full address of read register
	data	Data written
	off	Offset in RMEM

Returns:

0 on success, error code otherwise

References Rcuxx::RcuMemory::fData, Rcuxx::RcuMemory::fRcu, Rcuxx::Rcu::kDataMismatch, Rcuxx::Rcu::Layout(), and Rcuxx::RcuMemory::Update().

Referenced by Rcuxx::AltroRegister::Write().

unsigned int Rcuxx::RcuRMEM::FecCommand	(	unsigned int	addr,
		unsigned int	off = 0
	)			[inline]

ALTRO bus command.

Parameters:

	addr	Full address of command
	off	Offset in RMEM

Returns:

0 on success, error code otherwise

References Rcuxx::RcuMemory::fRcu, Rcuxx::Rcu::Layout(), and Rcuxx::RcuMemory::Update().

Referenced by Rcuxx::AltroCommand::Commit().

---

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

• RcuRMEM.h