This bridge lets packets pass from upstream to downstream of a PCI bridge. More...

#include <up_down_bridge.hh>

Inheritance diagram for gem5::PciUpDownBridge:

Public Member Functions
void	setConfigRange (AddrRange config_range)
	Set the PCI configuration range that is behind the bridge.
	PARAMS (PciUpDownBridge)
	PciUpDownBridge (const Params &p)
Public Member Functions inherited from gem5::BridgeBase
Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.
void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected.
	PARAMS (BridgeBase)
	BridgeBase (const Params &p)
Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::SimObject
const Params &	params () const
	SimObject (const Params &p)
virtual	~SimObject ()
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 ()=delete
	Group (const Group &)=delete
Group &	operator= (const Group &)=delete
Public Member Functions inherited from gem5::Named
	Named (std::string_view name_)
virtual	~Named ()=default
virtual std::string	name () const
Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	Update the tick to the current tick.
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.
Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.
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.
uint64_t	frequency () const
Tick	clockPeriod () const
double	voltage () const
Cycles	ticksToCycles (Tick t) const
Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
AddrRangeList	getAddrRanges () const override
	Get a list of the non-overlapping address ranges the bridge is responsible for.
void	recvRangeChange () override
	Called when the memory side port receives an address range change from the peer response port.
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.
Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.
	Clocked (Clocked &)=delete
Clocked &	operator= (Clocked &)=delete
virtual	~Clocked ()
	Virtual destructor due to inheritance.
void	resetClock () const
	Reset the object's clock using the current global tick value.
virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Private Attributes
AddrRangeList	memSideRanges
	Addresses ranges that the memory side buses can respond to.
AddrRange	configRange
	PCI configuration range that is behind the bridge.

Additional Inherited Members
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params
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.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
Protected Attributes inherited from gem5::BridgeBase
BridgeResponsePort	cpuSidePort
	Response port of the bridge.
BridgeRequestPort	memSidePort
	Request port of the bridge.
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.

Detailed Description

This bridge lets packets pass from upstream to downstream of a PCI bridge.

All the address ranges are dynamically determined based on the connected bus. A PCI configuration range can be set, the bridge will be able to respond to any of the address in that range.

Definition at line 54 of file up_down_bridge.hh.

Constructor & Destructor Documentation

◆ PciUpDownBridge()

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

Definition at line 48 of file up_down_bridge.cc.

References gem5::BridgeBase::BridgeBase(), configRange, memSideRanges, and gem5::MipsISA::p.

Referenced by PARAMS().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::PciUpDownBridge::getAddrRanges ( ) const

overrideprotectedvirtual

Get a list of the non-overlapping address ranges the bridge is responsible for.

Returns: a list of ranges responded to

Implements gem5::BridgeBase.

Definition at line 60 of file up_down_bridge.cc.

References configRange, and memSideRanges.

◆ PARAMS()

gem5::PciUpDownBridge::PARAMS ( PciUpDownBridge )

References gem5::MipsISA::p, and PciUpDownBridge().

◆ recvRangeChange()

void gem5::PciUpDownBridge::recvRangeChange ( )

overrideprotectedvirtual

Called when the memory side port receives an address range change from the peer response port.

This allows the bridge to dynamically update address ranges that can pass through with the new ones.

Reimplemented from gem5::BridgeBase.

Definition at line 75 of file up_down_bridge.cc.

References gem5::BridgeBase::cpuSidePort, DPRINTF, gem5::BridgeBase::memSidePort, memSideRanges, and gem5::MipsISA::r.

◆ setConfigRange()

void gem5::PciUpDownBridge::setConfigRange ( AddrRange config_range )

Set the PCI configuration range that is behind the bridge.

Definition at line 53 of file up_down_bridge.cc.

References configRange, and gem5::BridgeBase::cpuSidePort.

Member Data Documentation

◆ configRange

AddrRange gem5::PciUpDownBridge::configRange

private

PCI configuration range that is behind the bridge.

Definition at line 61 of file up_down_bridge.hh.

Referenced by getAddrRanges(), PciUpDownBridge(), and setConfigRange().

◆ memSideRanges

AddrRangeList gem5::PciUpDownBridge::memSideRanges

private

Addresses ranges that the memory side buses can respond to.

Definition at line 58 of file up_down_bridge.hh.

Referenced by getAddrRanges(), PciUpDownBridge(), and recvRangeChange().

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

dev/pci/up_down_bridge.hh
dev/pci/up_down_bridge.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members