#include <etherbus.hh>

Inheritance diagram for gem5::EtherBus:

Public Types
using	Params = EtherBusParams

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	EtherBus (const Params &p)

virtual	~EtherBus ()

void	txDone ()

void	reg (EtherInt *dev)

bool	busy () const

bool	send (EtherInt *sender, EthPacketPtr &packet)

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from gem5::EventManager
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)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

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

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

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

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

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

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

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Types
typedef std::list< EtherInt * >	devlist_t

Protected Attributes
devlist_t	devlist

double	ticksPerByte

bool	loopback

EventFunctionWrapper	event

EthPacketPtr	packet

EtherInt *	sender

EtherDump *	dump

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

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

Additional Inherited Members
Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

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

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

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

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

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

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

Detailed Description

Definition at line 46 of file etherbus.hh.

Member Typedef Documentation

◆ devlist_t

typedef std::list<EtherInt *> gem5::EtherBus::devlist_t

protected

Definition at line 49 of file etherbus.hh.

◆ Params

using gem5::EtherBus::Params = EtherBusParams

Definition at line 61 of file etherbus.hh.

Constructor & Destructor Documentation

◆ EtherBus()

gem5::EtherBus::EtherBus ( const Params & p )

Definition at line 52 of file etherbus.cc.

References txDone().

◆ ~EtherBus()

virtual gem5::EtherBus::~EtherBus ( )

inlinevirtual

Definition at line 63 of file etherbus.hh.

Member Function Documentation

◆ busy()

bool gem5::EtherBus::busy ( ) const

inline

Definition at line 67 of file etherbus.hh.

References packet.

Referenced by send().

◆ getPort()

Port & gem5::EtherBus::getPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

overridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 84 of file etherbus.cc.

References panic.

◆ reg()

void gem5::EtherBus::reg ( EtherInt * dev )

◆ send()

bool gem5::EtherBus::send	(	EtherInt *	sender,
		EthPacketPtr &	packet
	)

Definition at line 90 of file etherbus.cc.

References busy(), gem5::curTick(), DDUMP, DPRINTF, event, packet, gem5::EventManager::schedule(), sender, and ticksPerByte.

◆ txDone()

void gem5::EtherBus::txDone ( )

Definition at line 60 of file etherbus.cc.

References DDUMP, devlist, DPRINTF, dump, gem5::EtherDump::dump(), gem5::ArmISA::i, loopback, packet, gem5::EtherInt::sendDone(), and sender.

Referenced by EtherBus().

Member Data Documentation

◆ devlist

devlist_t gem5::EtherBus::devlist

protected

Definition at line 50 of file etherbus.hh.

Referenced by txDone().

◆ dump

EtherDump* gem5::EtherBus::dump

protected

Definition at line 58 of file etherbus.hh.

Referenced by txDone().

◆ event

EventFunctionWrapper gem5::EtherBus::event

protected

Definition at line 55 of file etherbus.hh.

Referenced by send().

◆ loopback

bool gem5::EtherBus::loopback

protected

Definition at line 52 of file etherbus.hh.

Referenced by txDone().

◆ packet

EthPacketPtr gem5::EtherBus::packet

protected

Definition at line 56 of file etherbus.hh.

Referenced by busy(), send(), and txDone().

◆ sender

EtherInt* gem5::EtherBus::sender

protected

Definition at line 57 of file etherbus.hh.

Referenced by send(), and txDone().

◆ ticksPerByte

double gem5::EtherBus::ticksPerByte

protected

Definition at line 51 of file etherbus.hh.

Referenced by send().

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

dev/net/etherbus.hh
dev/net/etherbus.cc

Public Types

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ devlist_t

◆ Params

Constructor & Destructor Documentation

◆ EtherBus()

◆ ~EtherBus()

Member Function Documentation

◆ busy()

◆ getPort()

◆ reg()

◆ send()

◆ txDone()

Member Data Documentation

◆ devlist

◆ dump

◆ event

◆ loopback

◆ packet

◆ sender

◆ ticksPerByte