Describes a register Proxy. More...

#include <RegisterSet.hpp>

Public Attributes
const Register::ident_type	id
	ID. Must be unique within all registers and register proxies within a register set.

const char *	name
	String identifier for this register proxy. This name must be unique from all other RegisterProxies in the same RegisterSet as well as all other Registers in this RegisterSet. TreeNode::validateName. Must NOT be NULL.

const Register::group_num_type	group_num
	Group number by which the a Register will be looked up when this RegisterProxy is accessed.

const char *	group
	String name of group in which this register resides (e.g. gpr). Must NOT be NULL. This is the same as (and is validated like) Register::Definition::group.

const Register::group_idx_type	group_idx
	Group index by which the a Register will be looked up when this RegisterProxy is accessed.

const char *	desc
	Description of this proxy as if it were a Register. Must NOT be NULL.

Detailed Description

Describes a register Proxy.

Can be constructed with initializer list as in:

sparta::RegisterProxy::Definition proxies[] =
    { {1001, "reg1", 0, GROUP_REG, "reg", 1, "This is Register 1"},
      {1002, "reg2", 0, GROUP_REG, "reg", 2, "This is Register 2"}
      sparta::RegisterProxy::DEFINITION_END };

Definition at line 52 of file RegisterSet.hpp.

Member Data Documentation

◆ desc

const char* sparta::RegisterProxyBase::Definition::desc

Description of this proxy as if it were a Register. Must NOT be NULL.

Definition at line 93 of file RegisterSet.hpp.

◆ group

const char* sparta::RegisterProxyBase::Definition::group

String name of group in which this register resides (e.g. gpr). Must NOT be NULL. This is the same as (and is validated like) Register::Definition::group.

Definition at line 80 of file RegisterSet.hpp.

◆ group_idx

const Register::group_idx_type sparta::RegisterProxyBase::Definition::group_idx

Group index by which the a Register will be looked up when this RegisterProxy is accessed.

See also: Register::Definition::group_num

Definition at line 87 of file RegisterSet.hpp.

◆ group_num

const Register::group_num_type sparta::RegisterProxyBase::Definition::group_num

Group number by which the a Register will be looked up when this RegisterProxy is accessed.

See also: Register::Definition::group_num

Definition at line 73 of file RegisterSet.hpp.

◆ id

const Register::ident_type sparta::RegisterProxyBase::Definition::id

ID. Must be unique within all registers and register proxies within a register set.

Definition at line 58 of file RegisterSet.hpp.

◆ name

const char* sparta::RegisterProxyBase::Definition::name

String identifier for this register proxy. This name must be unique from all other RegisterProxies in the same RegisterSet as well as all other Registers in this RegisterSet. TreeNode::validateName. Must NOT be NULL.

Definition at line 66 of file RegisterSet.hpp.

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

/github/workspace/sparta/sparta/functional/RegisterSet.hpp

Public Attributes