scireg_ns Namespace Reference

Classes
class	scireg_notification_if
	The scireg_notification_if is used to notify tools of additions/deletions of scireg region objects. More...
class	scireg_tool_registry
struct	scireg_mapped_region
struct	scireg_value_info
class	scireg_callback
	The scireg_callback is an abstract base class that is used to implement callbacks to tools. More...
class	scireg_region_if

Typedefs
typedef std::vector< unsigned char >	vector_byte

Enumerations
enum	scireg_region_type {   SCIREG_MEMORY, SCIREG_BANK, SCIREG_REGISTER, SCIREG_FIELD,   SCIREG_STRING_REGISTER }
enum	scireg_response { SCIREG_SUCCESS, SCIREG_FAILURE, SCIREG_UNSUPPORTED }
	SCIREG API response codes: More...
enum	scireg_bit_attributes_type { SCIREG_READABLE, SCIREG_WRITEABLE }
	Attributes assocated with individual bits within regions: More...
enum	scireg_string_attribute_type { SCIREG_NAME, SCIREG_DESCRIPTION, SCIREG_STRING_VALUE }
	String attributes associated with region objects: More...
enum	scireg_callback_type { SCIREG_READ_ACCESS, SCIREG_WRITE_ACCESS, SCIREG_STATE_CHANGE }
	The types of callbacks that can be assocated with regions: More...

Typedef Documentation

typedef std::vector<unsigned char> scireg_ns::vector_byte

Enumeration Type Documentation

enum scireg_ns::scireg_bit_attributes_type

Attributes assocated with individual bits within regions:

Enumerator
SCIREG_READABLE	< Bit is readable from perspective of HW Bus
SCIREG_WRITEABLE	< Bit is writeable from perspective of HW Bus

enum scireg_ns::scireg_callback_type

The types of callbacks that can be assocated with regions:

Enumerator
SCIREG_READ_ACCESS	< Execute callback when read occurs in region - does not include reads executed via DMI
SCIREG_WRITE_ACCESS	< Execute callback when write occurs in region - does not include writes executed via DMI
SCIREG_STATE_CHANGE	< Execute callback when there is ANY kind of state change associated with region

enum scireg_ns::scireg_region_type

A region represents a SystemC object that occupies a region (ie portion) of the address space within a SystemC model. The SCIREG API uses a single interface (scireg_region_if) to represent all types of regions. The types of regions are:

Enumerator
SCIREG_MEMORY	< A Memory
SCIREG_BANK	< A Register Bank
SCIREG_REGISTER	< A Register
SCIREG_FIELD	< A Register Field
SCIREG_STRING_REGISTER	< A string register (i.e. an object in a model which contains textual string values to be made available to tools)

enum scireg_ns::scireg_response

SCIREG API response codes:

Enumerator
SCIREG_SUCCESS	< Function succeeded.
SCIREG_FAILURE	< Function failed at runtime.
SCIREG_UNSUPPORTED	< Function failed since it is unsupported at compile time.

enum scireg_ns::scireg_string_attribute_type

String attributes associated with region objects:

Enumerator
SCIREG_NAME	< Name of object (typically short identifier, not fully rooted name)
SCIREG_DESCRIPTION	< Textual description (typically short phrase or sentence).
SCIREG_STRING_VALUE	< String Value stored in a string register