MainbusComponent Class Reference

Back to the index.

Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
MainbusComponent Class Reference

Main bus Component. More...

#include <MainbusComponent.h>

Inheritance diagram for MainbusComponent:
Component AddressDataBus UnitTestable ReferenceCountable

Public Member Functions

 MainbusComponent ()
 Constructs a MainbusComponent. More...
 
virtual ~MainbusComponent ()
 
virtual AddressDataBusAsAddressDataBus ()
 Returns the component's AddressDataBus interface. More...
 
virtual void AddressSelect (uint64_t address)
 Place an address on the bus. More...
 
virtual bool ReadData (uint8_t &data, Endianness endianness)
 Reads 8-bit data from the currently selected address. More...
 
virtual bool ReadData (uint16_t &data, Endianness endianness)
 Reads 16-bit data from the currently selected address. More...
 
virtual bool ReadData (uint32_t &data, Endianness endianness)
 Reads 32-bit data from the currently selected address. More...
 
virtual bool ReadData (uint64_t &data, Endianness endianness)
 Reads 64-bit data from the currently selected address. More...
 
virtual bool WriteData (const uint8_t &data, Endianness endianness)
 Writes 8-bit data to the currently selected address. More...
 
virtual bool WriteData (const uint16_t &data, Endianness endianness)
 Writes 16-bit data to the currently selected address. More...
 
virtual bool WriteData (const uint32_t &data, Endianness endianness)
 Writes 32-bit data to the currently selected address. More...
 
virtual bool WriteData (const uint64_t &data, Endianness endianness)
 Writes 64-bit data to the currently selected address. More...
 
- Public Member Functions inherited from Component
virtual ~Component ()
 
string GetClassName () const
 Gets the class name of the component. More...
 
string GetVisibleClassName () const
 Gets the visible class name of the component. More...
 
refcount_ptr< ComponentClone () const
 Clones the component and all its children. More...
 
const refcount_ptr< ComponentLightClone () const
 Makes a light clone of the component and all its children. More...
 
void DetectChanges (const refcount_ptr< Component > &oldClone, ostream &changeMessages) const
 Compare an older clone to the current tree, to find changes. More...
 
string GenerateTreeDump (const string &branchTemplate, bool htmlLinksForClassNames=false, string prefixForComponentUrls="") const
 Generates an ASCII tree dump of a component tree. More...
 
virtual string GenerateDetails () const
 Generate details about the component. More...
 
void Reset ()
 Resets the state of this component and all its children. More...
 
bool PreRunCheck (GXemul *gxemul)
 Checks the state of this component and all its children, before starting execution. More...
 
void FlushCachedState ()
 Resets the cached state of this component and all its children. More...
 
virtual int Execute (GXemul *gxemul, int nrOfCycles)
 Execute one or more cycles. More...
 
virtual double GetCurrentFrequency () const
 Returns the current frequency (in Hz) that the component runs at. More...
 
virtual RootComponentAsRootComponent ()
 Returns the component's RootComponent interface. More...
 
virtual CPUComponentAsCPUComponent ()
 Returns the component's CPUComponent interface. More...
 
void SetParent (Component *parentComponent)
 Sets the parent component of this component. More...
 
ComponentGetParent ()
 Gets this component's parent component, if any. More...
 
const ComponentGetParent () const
 
virtual void GetMethodNames (vector< string > &names) const
 Retrieves a component's implemented method names. More...
 
virtual bool MethodMayBeReexecutedWithoutArgs (const string &methodName) const
 Returns whether a method name may be re-executed without args. More...
 
virtual void ExecuteMethod (GXemul *gxemul, const string &methodName, const vector< string > &arguments)
 Executes a method on the component. More...
 
string GeneratePath () const
 Generates a string representation of the path to the Component. More...
 
string GenerateShortestPossiblePath () const
 Generates a short string representation of the path to the Component. More...
 
const refcount_ptr< ComponentLookupPath (string path) const
 Looks up a path from this Component, and returns a pointer to the found Component, if any. More...
 
vector< string > FindPathByPartialMatch (const string &partialPath, bool shortestPossible=false) const
 Finds complete component paths, given a partial path. More...
 
void AddChild (refcount_ptr< Component > childComponent, size_t insertPosition=(size_t) -1)
 Adds a reference to a child component. More...
 
size_t RemoveChild (Component *childToRemove)
 Removes a reference to a child component. More...
 
ComponentsGetChildren ()
 Gets pointers to child components. More...
 
const ComponentsGetChildren () const
 Gets pointers to child components, as a const reference. More...
 
void GetVariableNames (vector< string > &names) const
 Retrieves a component's state variable names. More...
 
StateVariableGetVariable (const string &name)
 Gets a pointer to a state variable. More...
 
const StateVariableGetVariable (const string &name) const
 Gets a pointer to a state variable. More...
 
bool SetVariableValue (const string &name, const string &expression)
 Sets a variable to a new value. More...
 
void Serialize (ostream &ss, SerializationContext &context) const
 Serializes the Component into a string stream. More...
 
bool CheckConsistency () const
 Checks consistency by serializing and deserializing the component (including all its child components), and comparing the checksum of the original tree with the deserialized tree. More...
 
void AddChecksum (Checksum &checksum) const
 Adds this component's state, including children, to a checksum. More...
 
- Public Member Functions inherited from ReferenceCountable
 ReferenceCountable ()
 Default constructor, which initializes the reference count to zero. More...
 
 ~ReferenceCountable ()
 
- Public Member Functions inherited from AddressDataBus
 AddressDataBus ()
 Constructs an AddressDataBus instance. More...
 
virtual ~AddressDataBus ()
 

Static Public Member Functions

static refcount_ptr< ComponentCreate (const ComponentCreateArgs &args)
 Creates a MainbusComponent. More...
 
static string GetAttribute (const string &attributeName)
 Get attribute information about the MainbusComponent class. More...
 
static void RunUnitTests (int &nSucceeded, int &nFailures)
 
- Static Public Member Functions inherited from Component
static string GetAttribute (const string &attributeName)
 Creates a Component. More...
 
static refcount_ptr< ComponentDeserialize (ostream &messages, const string &str, size_t &pos)
 Deserializes a string into a component tree. More...
 
- Static Public Member Functions inherited from UnitTestable
static void RunUnitTests (int &nSucceeded, int &nFailures)
 Runs unit test cases. More...
 

Protected Member Functions

virtual void FlushCachedStateForComponent ()
 Resets the cached state of this component. More...
 
virtual bool PreRunCheckForComponent (GXemul *gxemul)
 Checks the state of this component, before starting execution. More...
 
- Protected Member Functions inherited from Component
 Component (const string &className, const string &visibleClassName)
 Base constructor for a Component. More...
 
template<class T >
bool AddVariable (const string &name, T *variablePointer)
 Adds a state variable of type T to the Component. More...
 
bool AddCustomVariable (const string &name, CustomStateVariableHandler *variableHandler)
 Adds a custom state variable to the Component. More...
 
virtual bool CheckVariableWrite (StateVariable &var, const string &oldValue)
 Checks whether a write to a variable is OK. More...
 
virtual void ResetState ()
 Resets the state variables of this component. More...
 
GXemulGetRunningGXemulInstance ()
 Returns a reference to the current GXemul instance. More...
 
UIGetUI ()
 Gets an UI reference for outputting debug messages during runtime. More...
 

Detailed Description

Main bus Component.

An AddressDataBus Component which forwards reads and writes to MemoryMappedComponent components (which also must implement the AddressDataBus interface), e.g. the RAMComponent.

Definition at line 47 of file MainbusComponent.h.

Constructor & Destructor Documentation

◆ MainbusComponent()

MainbusComponent::MainbusComponent ( )

Constructs a MainbusComponent.

Definition at line 32 of file MainbusComponent.cc.

Referenced by Create().

◆ ~MainbusComponent()

MainbusComponent::~MainbusComponent ( )
virtual

Definition at line 41 of file MainbusComponent.cc.

Member Function Documentation

◆ AddressSelect()

void MainbusComponent::AddressSelect ( uint64_t  address)
virtual

Place an address on the bus.

Parameters
addressThe address to select.

Implements AddressDataBus.

Definition at line 181 of file MainbusComponent.cc.

References AddressDataBus::AddressSelect().

◆ AsAddressDataBus()

AddressDataBus * MainbusComponent::AsAddressDataBus ( )
virtual

Returns the component's AddressDataBus interface.

Returns
A pointer to an AddressDataBus.

Reimplemented from Component.

Definition at line 175 of file MainbusComponent.cc.

◆ Create()

refcount_ptr< Component > MainbusComponent::Create ( const ComponentCreateArgs args)
static

Creates a MainbusComponent.

Definition at line 46 of file MainbusComponent.cc.

References MainbusComponent().

◆ FlushCachedStateForComponent()

void MainbusComponent::FlushCachedStateForComponent ( )
protectedvirtual

Resets the cached state of this component.

Note 1: This function is not recursive, so children should not be traversed.

Note 2: After a component's state variables have been reset, the base class' FlushCachedStateForComponent() function should also be called.

The implementation of this function ususally takes the form of setting a number of pointers to NULL, and then the call to the base class' FlushCachedStateForComponent() function.

Reimplemented from Component.

Definition at line 64 of file MainbusComponent.cc.

References Component::FlushCachedStateForComponent().

Referenced by PreRunCheckForComponent().

◆ GetAttribute()

string MainbusComponent::GetAttribute ( const string &  attributeName)
static

Get attribute information about the MainbusComponent class.

Parameters
attributeNameThe attribute name.
Returns
A string representing the attribute value.

Definition at line 52 of file MainbusComponent.cc.

References Component::GetAttribute().

◆ PreRunCheckForComponent()

bool MainbusComponent::PreRunCheckForComponent ( GXemul gxemul)
protectedvirtual

Checks the state of this component, before starting execution.

Note 1: This function is not recursive, so children should not be traversed.

Note 2: After a component's state variables have been checked, the base class' PreRunCheckForComponent(GXemul*) function should also be called.

The implementation of this function may choose to print warning messages but still return true, or it can print error messages and return false.

Typical examples of pre-run-check failures are:

Returns
true if the component is ready to run, false otherwise.

Reimplemented from Component.

Definition at line 76 of file MainbusComponent.cc.

References FlushCachedStateForComponent(), Component::GenerateShortestPossiblePath(), Component::GenerateTreeDump(), Component::GetChildren(), GXemul::GetUI(), UI::ShowDebugMessage(), and StateVariable::ToInteger().

◆ ReadData() [1/4]

bool MainbusComponent::ReadData ( uint8_t &  data,
Endianness  endianness 
)
virtual

Reads 8-bit data from the currently selected address.

Parameters
dataA reference to a variable which will receive the data.
endiannessSelects the endianness of the operation. Ignored for 8-bit reads and writes.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 215 of file MainbusComponent.cc.

References AddressDataBus::ReadData().

◆ ReadData() [2/4]

bool MainbusComponent::ReadData ( uint16_t &  data,
Endianness  endianness 
)
virtual

Reads 16-bit data from the currently selected address.

Parameters
dataA reference to a variable which will receive the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 227 of file MainbusComponent.cc.

References AddressDataBus::ReadData().

◆ ReadData() [3/4]

bool MainbusComponent::ReadData ( uint32_t &  data,
Endianness  endianness 
)
virtual

Reads 32-bit data from the currently selected address.

Parameters
dataA reference to a variable which will receive the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 239 of file MainbusComponent.cc.

References AddressDataBus::ReadData().

◆ ReadData() [4/4]

bool MainbusComponent::ReadData ( uint64_t &  data,
Endianness  endianness 
)
virtual

Reads 64-bit data from the currently selected address.

Parameters
dataA reference to a variable which will receive the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 251 of file MainbusComponent.cc.

References AddressDataBus::ReadData().

◆ RunUnitTests()

static void MainbusComponent::RunUnitTests ( int &  nSucceeded,
int &  nFailures 
)
static

◆ WriteData() [1/4]

bool MainbusComponent::WriteData ( const uint8_t &  data,
Endianness  endianness 
)
virtual

Writes 8-bit data to the currently selected address.

Parameters
dataA reference to a variable which contains the data.
endiannessSelects the endianness of the operation. Ignored for 8-bit reads and writes.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 263 of file MainbusComponent.cc.

References AddressDataBus::WriteData().

◆ WriteData() [2/4]

bool MainbusComponent::WriteData ( const uint16_t &  data,
Endianness  endianness 
)
virtual

Writes 16-bit data to the currently selected address.

Parameters
dataA reference to a variable which contains the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 275 of file MainbusComponent.cc.

References AddressDataBus::WriteData().

◆ WriteData() [3/4]

bool MainbusComponent::WriteData ( const uint32_t &  data,
Endianness  endianness 
)
virtual

Writes 32-bit data to the currently selected address.

Parameters
dataA reference to a variable which contains the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 287 of file MainbusComponent.cc.

References AddressDataBus::WriteData().

◆ WriteData() [4/4]

bool MainbusComponent::WriteData ( const uint64_t &  data,
Endianness  endianness 
)
virtual

Writes 64-bit data to the currently selected address.

Parameters
dataA reference to a variable which contains the data.
endiannessSelects the endianness of the operation.
Returns
True if the access was successful, false otherwise (e.g. because of a timeout).

Implements AddressDataBus.

Definition at line 299 of file MainbusComponent.cc.

References Component::AddChild(), AddressDataBus::AddressSelect(), Component::AsAddressDataBus(), UnitTest::Assert(), BigEndian, ComponentFactory::CreateComponent(), data, Component::FlushCachedState(), GXemul::GetCommandInterpreter(), GXemul::GetRootComponent(), ComponentFactory::HasAttribute(), refcount_ptr< T >::IsNULL(), LittleEndian, Component::PreRunCheck(), AddressDataBus::ReadData(), CommandInterpreter::RunCommand(), Component::SetVariableValue(), UNITTEST, UNITTESTS, and AddressDataBus::WriteData().


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

Generated on Sun Sep 30 2018 16:05:18 for GXemul by doxygen 1.8.13