#include <external_master.hh>

Inheritance diagram for ExternalMaster:

Classes
class	Handler

class	Port
	Derive from this class to create an external port interface. More...

Public Member Functions
	ExternalMaster (ExternalMasterParams *params)

BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	MasterPort interface. More...

void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

virtual BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...

virtual void	resetStats ()
	Reset statistics associated with this object. More...

virtual void	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual void	startup ()
	startup() is the final initialization call before simulation. More...

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick)-1)

void	setCurTick (Tick newVal)

Public Member Functions inherited from Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section. More...

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object. More...

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...

virtual void	notifyFork ()
	Notify a child process of a fork. More...

Public Member Functions inherited from Clocked
void	updateClockPeriod () const
	Update the tick to the current tick. More...

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Static Public Member Functions
static void	registerHandler (const std::string &handler_name, Handler *handler)
	Register a handler which can provide ports with port_type == handler_name. More...

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes
const MasterID	masterId

Protected Attributes
Port *	externalPort
	The peer port for the gem5 port "port". More...

std::string	portName
	Name of the bound port. More...

std::string	portType
	Key to select a port handler. More...

std::string	portData
	Handler-specific port configuration. More...

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Static Protected Attributes
static std::map< std::string, Handler * >	portHandlers
	Registered handlers. More...

Additional Inherited Members
Public Types inherited from MemObject
typedef MemObjectParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain. More...

void	signalDrainDone () const
	Signal that an object is drained. More...

Protected Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

Detailed Description

Definition at line 66 of file external_master.hh.

Constructor & Destructor Documentation

ExternalMaster::ExternalMaster ( ExternalMasterParams * params )

Definition at line 54 of file external_master.cc.

Member Function Documentation

BaseMasterPort & ExternalMaster::getMasterPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

virtual

MasterPort interface.

Responds only to port "port"

Reimplemented from MemObject.

Definition at line 64 of file external_master.cc.

References DPRINTF, externalPort, fatal, MemObject::getMasterPort(), portData, portHandlers, portName, and portType.

void ExternalMaster::init ( )

virtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from SimObject.

Definition at line 92 of file external_master.cc.

References externalPort, fatal, BaseMasterPort::isConnected(), and SimObject::name().

void ExternalMaster::registerHandler	(	const std::string &	handler_name,
		Handler *	handler
	)

static

Register a handler which can provide ports with port_type == handler_name.

Definition at line 108 of file external_master.cc.

References portHandlers.

Member Data Documentation

Port* ExternalMaster::externalPort

protected

The peer port for the gem5 port "port".

Definition at line 103 of file external_master.hh.

Referenced by getMasterPort(), and init().

const MasterID ExternalMaster::masterId

Definition at line 134 of file external_master.hh.

std::string ExternalMaster::portData

protected

Handler-specific port configuration.

Definition at line 112 of file external_master.hh.

Referenced by getMasterPort().

std::map< std::string, ExternalMaster::Handler * > ExternalMaster::portHandlers

staticprotected

Registered handlers.

Handlers are chosen using the port_type parameter on ExternalMasters. port_types form a global namespace across the simulation and so handlers are registered into a global structure

Definition at line 118 of file external_master.hh.

Referenced by getMasterPort(), and registerHandler().

std::string ExternalMaster::portName

protected

Name of the bound port.

This will be name() + ".port"

Definition at line 106 of file external_master.hh.

Referenced by getMasterPort().

std::string ExternalMaster::portType

protected

Key to select a port handler.

Definition at line 109 of file external_master.hh.