Configurable generic PCI host interface. More...

#include <host.hh>

Inheritance diagram for gem5::GenericPciHost:

Public Member Functions
	GenericPciHost (const GenericPciHostParams &p)
virtual	~GenericPciHost ()
AddrRange	getConfigAddrRange () const override
	Get the range for the configuration memory space for which this PCI upstream is responsible.
Public Member Functions inherited from gem5::PciHost
	PciHost (const PciHostParams &p)
virtual	~PciHost ()
Public Member Functions inherited from gem5::PciUpstream
	PARAMS (PciUpstream)
	PciUpstream (const Params &p)
void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected.
void	sendBusChange ()
	Inform each PCI devices connected to this upstream of a bus number change.
virtual DeviceInterface	registerDevice (PciDevice *device, PciDevAddr dev_addr, PciIntPin pin)
	Register a PCI device with the host.
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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
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
AddrRange	interfaceConfigRange (const PciDevAddr &dev_addr) const override
	Calculate the physical address range of the PCI device configuration space.
Addr	interfacePioAddr (const PciDevAddr &dev_addr, Addr pci_addr) const override
	Calculate the physical address of an IO location on the PCI bus.
Addr	interfaceMemAddr (const PciDevAddr &dev_addr, Addr pci_addr) const override
	Calculate the physical address of a non-prefetchable memory location in the PCI address space.
Addr	interfaceDmaAddr (const PciDevAddr &dev_addr, Addr pci_addr) const override
	Calculate the physical address of a prefetchable memory location in the PCI address space.
PciBusNum	getBusNum () const override
	Get the PCI bus number assign to that upstream.
void	interfacePostInt (const PciDevAddr &addr, PciIntPin pin) override
	Post an interrupt to the CPU.
void	interfaceClearInt (const PciDevAddr &addr, PciIntPin pin) override
	Post an interrupt to the CPU.
virtual uint32_t	mapPciInterrupt (const PciDevAddr &dev_addr, PciIntPin pin) const
Protected Member Functions inherited from gem5::PciUpstream
PciDevice *	getDevice (const PciDevAddr &addr)
	Retrieve a PCI device from its bus address.
const PciDevice *	getDevice (const PciDevAddr &addr) const
	Retrieve a PCI device from its bus address.
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.

Protected Attributes
Platform &	platform
const Addr	confBase
const Addr	confSize
const uint8_t	confDeviceBits
const Addr	pciPioBase
const Addr	pciMemBase
const Addr	pciDmaBase
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
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

Detailed Description

Configurable generic PCI host interface.

The GenericPciHost provides a configurable generic PCI host implementation.

The generic controller binds to one range of physical addresses to implement the PCI subsystem's configuraiton space. The base address, size and mapping between memory addresses and PCI devices are all configurable as simulation parameters. The basic implementation supports both the Configuration Access Mechanism (CAM) and Enhanced Configuration Access Mechanism (ECAM) configuration space layout. The layouts can be configured by changing the number of bits allocated to each device in the configuration space. ECAM uses 12 bits per device, while CAM uses 8 bits per device.

Interrupts are delivered via the Platform::postInt() and Platform::clearInt() calls. Interrupt numbers are mapped statically using the interrupt line (PciDevice::interruptLine()) returned from the device. Implementations may override mapPciInterrupt() to dynamically map a PciDevAddr and PciIntPin to a platform-specific interrupt.

All PCI memory spaces (IO, prefetchable, and non-prefetchable) support a simple base+offset mapping that can be configured using simulation parameters. The base defaults to 0 for all of them.

Definition at line 108 of file host.hh.