#include <reg_bank.hh>

Inheritance diagram for RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >:

Public Types
using	ReadFunc = std::function< Data(This &reg)>

using	PartialReadFunc = std::function< Data(This &reg, int first, int last)>

using	WriteFunc = std::function< void(This &reg, const Data &value)>

using	PartialWriteFunc = std::function< void(This &reg, const Data &value, int first, int last)>

Public Member Functions
constexpr	Register (const std::string &new_name)

constexpr	Register (const std::string &new_name, const Data &new_data)

constexpr	Register (const std::string &new_name, const Data &&new_data)

constexpr This &	writeable (const Data &new_mask)

constexpr This &	readonly ()

constexpr This &	reader (const ReadFunc &new_reader)

template<class Parent , class... Args>
constexpr This &	reader (Parent parent, Data(Parent::nr)(Args... args))

constexpr This &	writer (const WriteFunc &new_writer)

template<class Parent , class... Args>
constexpr This &	writer (Parent parent, void(Parent::nw)(Args... args))

constexpr This &	partialReader (const PartialReadFunc &new_reader)

template<class Parent , class... Args>
constexpr This &	partialReader (Parent parent, Data(Parent::nr)(Args... args))

constexpr This &	partialWriter (const PartialWriteFunc &new_writer)

template<class Parent , class... Args>
constexpr This &	partialWriter (Parent parent, void(Parent::nw)(Args... args))

const Data &	writeable () const

const Data &	get () const

Data &	get ()

void	update (const Data &new_data, const Data &bitmask)

void	update (const Data &new_data)

void	read (void *buf) override

void	read (void *buf, off_t offset, size_t bytes) override

void	write (const void *buf) override

void	write (const void *buf, off_t offset, size_t bytes) override

void	serialize (std::ostream &os) const override

bool	unserialize (const std::string &s) override

Public Member Functions inherited from RegisterBank< BankByteOrder >::RegisterBase
constexpr	RegisterBase (const std::string &new_name, size_t new_size)

virtual	~RegisterBase ()

virtual const std::string &	name () const

size_t	size () const

Protected Types
using	This = Register< Data, RegByteOrder >

Protected Member Functions
constexpr Data	htoreg (Data data)

constexpr Data	regtoh (Data data)

Static Protected Member Functions
static Data	defaultReader (This &reg)

static Data	defaultPartialReader (This &reg, int first, int last)

static void	defaultWriter (This &reg, const Data &value)

static void	defaultPartialWriter (This &reg, const Data &value, int first, int last)

Private Attributes
Data	_data = {}

Data	_writeMask = mask(sizeof(Data) * 8)

ReadFunc	_reader = defaultReader

WriteFunc	_writer = defaultWriter

PartialWriteFunc	_partialWriter = defaultPartialWriter

PartialReadFunc	_partialReader = defaultPartialReader

Additional Inherited Members
Protected Attributes inherited from RegisterBank< BankByteOrder >::RegisterBase
const std::string	_name

size_t	_size = 0

Detailed Description

template<ByteOrder BankByteOrder>
template<typename Data, ByteOrder RegByteOrder = BankByteOrder>
class RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >

Definition at line 485 of file reg_bank.hh.

Member Typedef Documentation

◆ PartialReadFunc

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

using RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::PartialReadFunc = std::function< Data (This &reg, int first, int last)>

Definition at line 493 of file reg_bank.hh.

◆ PartialWriteFunc

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

using RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::PartialWriteFunc = std::function< void (This &reg, const Data &value, int first, int last)>

Definition at line 496 of file reg_bank.hh.

◆ ReadFunc

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

using RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::ReadFunc = std::function<Data (This &reg)>

Definition at line 491 of file reg_bank.hh.

◆ This

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

using RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::This = Register<Data, RegByteOrder>

protected

Definition at line 488 of file reg_bank.hh.

◆ WriteFunc

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

using RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::WriteFunc = std::function<void (This &reg, const Data &value)>

Definition at line 494 of file reg_bank.hh.

Constructor & Destructor Documentation

◆ Register() [1/3]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::Register ( const std::string & new_name )

inlineconstexpr

Definition at line 562 of file reg_bank.hh.

◆ Register() [2/3]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::Register	(	const std::string &	new_name,
		const Data &	new_data
	)

inlineconstexpr

Definition at line 567 of file reg_bank.hh.

◆ Register() [3/3]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::Register	(	const std::string &	new_name,
		const Data &&	new_data
	)

inlineconstexpr

Definition at line 570 of file reg_bank.hh.

Member Function Documentation

◆ defaultPartialReader()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

static Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::defaultPartialReader	(	This &	reg,
		int	first,
		int	last
	)

inlinestaticprotected

Definition at line 511 of file reg_bank.hh.

◆ defaultPartialWriter()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

static void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::defaultPartialWriter	(	This &	reg,
		const Data &	value,
		int	first,
		int	last
	)

inlinestaticprotected

Definition at line 523 of file reg_bank.hh.

◆ defaultReader()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

static Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::defaultReader ( This & reg )

inlinestaticprotected

Definition at line 508 of file reg_bank.hh.

◆ defaultWriter()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

static void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::defaultWriter	(	This &	reg,
		const Data &	value
	)

inlinestaticprotected

Definition at line 517 of file reg_bank.hh.

◆ get() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

Data& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::get ( )

inline

Definition at line 671 of file reg_bank.hh.

◆ get() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

const Data& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::get ( ) const

inline

Definition at line 670 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::serialize(), and RegisterBank< BankByteOrder >::Register< BackingType >::unserialize().

◆ htoreg()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::htoreg ( Data data )

inlineconstexprprotected

Definition at line 530 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::read().

◆ partialReader() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::partialReader ( const PartialReadFunc & new_reader )

inlineconstexpr

Definition at line 631 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::partialReader().

◆ partialReader() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

template<class Parent , class... Args>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::partialReader	(	Parent *	parent,
		Data(Parent::*)(Args... args)	nr
	)

inlineconstexpr

Definition at line 638 of file reg_bank.hh.

◆ partialWriter() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::partialWriter ( const PartialWriteFunc & new_writer )

inlineconstexpr

Definition at line 646 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::partialWriter().

◆ partialWriter() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

template<class Parent , class... Args>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::partialWriter	(	Parent *	parent,
		void(Parent::*)(Args... args)	nw
	)

inlineconstexpr

Definition at line 653 of file reg_bank.hh.

◆ read() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::read ( void * buf )

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 694 of file reg_bank.hh.

◆ read() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::read	(	void *	buf,
		off_t	offset,
		size_t	bytes
	)

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 701 of file reg_bank.hh.

◆ reader() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::reader ( const ReadFunc & new_reader )

inlineconstexpr

Definition at line 590 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::reader(), and Uart8250::Registers::Registers().

◆ reader() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

template<class Parent , class... Args>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::reader	(	Parent *	parent,
		Data(Parent::*)(Args... args)	nr
	)

inlineconstexpr

Definition at line 597 of file reg_bank.hh.

◆ readonly()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::readonly ( )

inlineconstexpr

Definition at line 584 of file reg_bank.hh.

Referenced by Uart8250::Registers::Registers().

◆ regtoh()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::regtoh ( Data data )

inlineconstexprprotected

Definition at line 543 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::write().

◆ serialize()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::serialize ( std::ostream & os ) const

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 745 of file reg_bank.hh.

◆ unserialize()

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

bool RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::unserialize ( const std::string & s )

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 751 of file reg_bank.hh.

◆ update() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::update ( const Data & new_data )

inline

Definition at line 681 of file reg_bank.hh.

◆ update() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::update	(	const Data &	new_data,
		const Data &	bitmask
	)

inline

Definition at line 675 of file reg_bank.hh.

◆ write() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::write ( const void * buf )

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 717 of file reg_bank.hh.

◆ write() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

void RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::write	(	const void *	buf,
		off_t	offset,
		size_t	bytes
	)

inlineoverridevirtual

Implements RegisterBank< BankByteOrder >::RegisterBase.

Definition at line 726 of file reg_bank.hh.

◆ writeable() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

const Data& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::writeable ( ) const

inline

Definition at line 667 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::readonly().

◆ writeable() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::writeable ( const Data & new_mask )

inlineconstexpr

Definition at line 577 of file reg_bank.hh.

◆ writer() [1/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::writer ( const WriteFunc & new_writer )

inlineconstexpr

Definition at line 605 of file reg_bank.hh.

Referenced by Uart8250::Registers::Registers(), and RegisterBank< BankByteOrder >::Register< BackingType >::writer().

◆ writer() [2/2]

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

template<class Parent , class... Args>

constexpr This& RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::writer	(	Parent *	parent,
		void(Parent::*)(Args... args)	nw
	)

inlineconstexpr

Definition at line 612 of file reg_bank.hh.

Member Data Documentation

◆ _data

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_data = {}

private

Definition at line 499 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::get(), and RegisterBank< BankByteOrder >::Register< BackingType >::update().

◆ _partialReader

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

PartialReadFunc RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_partialReader = defaultPartialReader

private

Definition at line 505 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::partialReader(), and RegisterBank< BankByteOrder >::Register< BackingType >::read().

◆ _partialWriter

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

PartialWriteFunc RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_partialWriter = defaultPartialWriter

private

Definition at line 504 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::partialWriter(), and RegisterBank< BankByteOrder >::Register< BackingType >::write().

◆ _reader

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

ReadFunc RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_reader = defaultReader

private

Definition at line 502 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::read(), and RegisterBank< BankByteOrder >::Register< BackingType >::reader().

◆ _writeMask

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

Data RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_writeMask = mask(sizeof(Data) * 8)

private

Definition at line 500 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::update(), and RegisterBank< BankByteOrder >::Register< BackingType >::writeable().

◆ _writer

template<ByteOrder BankByteOrder>

template<typename Data , ByteOrder RegByteOrder = BankByteOrder>

WriteFunc RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >::_writer = defaultWriter

private

Definition at line 503 of file reg_bank.hh.

Referenced by RegisterBank< BankByteOrder >::Register< BackingType >::write(), and RegisterBank< BankByteOrder >::Register< BackingType >::writer().

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

dev/reg_bank.hh

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<ByteOrder BankByteOrder> template<typename Data, ByteOrder RegByteOrder = BankByteOrder> class RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >

Member Typedef Documentation

◆ PartialReadFunc

◆ PartialWriteFunc

◆ ReadFunc

◆ This

◆ WriteFunc

Constructor & Destructor Documentation

◆ Register() [1/3]

◆ Register() [2/3]

◆ Register() [3/3]

Member Function Documentation

◆ defaultPartialReader()

◆ defaultPartialWriter()

◆ defaultReader()

◆ defaultWriter()

◆ get() [1/2]

◆ get() [2/2]

◆ htoreg()

◆ partialReader() [1/2]

◆ partialReader() [2/2]

◆ partialWriter() [1/2]

◆ partialWriter() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ reader() [1/2]

◆ reader() [2/2]

◆ readonly()

◆ regtoh()

◆ serialize()

◆ unserialize()

◆ update() [1/2]

◆ update() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ writeable() [1/2]

◆ writeable() [2/2]

◆ writer() [1/2]

◆ writer() [2/2]

Member Data Documentation

◆ _data

◆ _partialReader

◆ _partialWriter

◆ _reader

◆ _writeMask

◆ _writer

template<ByteOrder BankByteOrder>
template<typename Data, ByteOrder RegByteOrder = BankByteOrder>
class RegisterBank< BankByteOrder >::Register< Data, RegByteOrder >