The PCI host describes the interface between PCI devices and a simulated system. More...

#include <host.hh>

Inheritance diagram for gem5::PciHost:

Classes
class	DeviceInterface
	Callback interface from PCI devices to the host. More...

Public Member Functions
	PciHost (const PciHostParams &p)

virtual	~PciHost ()

Device interface
virtual DeviceInterface	registerDevice (PciDevice *device, PciBusAddr bus_addr, PciIntPin pin)
	Register a PCI device with the host. More...

Public Member Functions inherited from gem5::PioDevice
	PioDevice (const Params &p)

virtual	~PioDevice ()

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

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

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

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

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

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. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. 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 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. More...

void	setCurTick (Tick newVal)

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

	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. 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 gem5::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 gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

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

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

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

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

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

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

	Group ()=delete

	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

Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	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

Protected Member Functions
PciDevice *	getDevice (const PciBusAddr &addr)
	Retrieve a PCI device from its bus address. More...

const PciDevice *	getDevice (const PciBusAddr &addr) const
	Retrieve a PCI device from its bus address. More...

PciHost controller interface
virtual void	postInt (const PciBusAddr &bus_addr, PciIntPin pin)=0
	Post an interrupt to the CPU. More...

virtual void	clearInt (const PciBusAddr &bus_addr, PciIntPin pin)=0
	Post an interrupt to the CPU. More...

virtual Addr	pioAddr (const PciBusAddr &bus_addr, Addr pci_addr) const =0
	Calculate the physical address of an IO location on the PCI bus. More...

virtual Addr	memAddr (const PciBusAddr &bus_addr, Addr pci_addr) const =0
	Calculate the physical address of a non-prefetchable memory location in the PCI address space. More...

virtual Addr	dmaAddr (const PciBusAddr &bus_addr, Addr pci_addr) const =0
	Calculate the physical address of a prefetchable memory location in the PCI address space. More...

Protected Member Functions inherited from gem5::PioDevice
virtual AddrRangeList	getAddrRanges () const =0
	Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...

virtual Tick	read (PacketPtr pkt)=0
	Pure virtual function that the device must implement. More...

virtual Tick	write (PacketPtr pkt)=0
	Pure virtual function that the device must implement. More...

Protected Member Functions inherited from gem5::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 gem5::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...

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...

Private Attributes
std::map< PciBusAddr, PciDevice * >	devices
	Currently registered PCI devices. More...

Additional Inherited Members
Public Types inherited from gem5::PioDevice
using	Params = PioDeviceParams

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject. More...

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. More...

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

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

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

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

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

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Protected Attributes inherited from gem5::PioDevice
System *	sys

PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees. More...

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

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

Detailed Description

The PCI host describes the interface between PCI devices and a simulated system.

The PCI host controller has three main responsibilities:

Expose a configuration memory space that allows devices to be discovered and configured.
Map and deliver interrupts to the CPU.
Map memory addresses from the PCI bus's various memory spaces (Legacy IO, non-prefetchable memory, and prefetchable memory) to physical memory.

PCI devices need to register themselves with a PCI host using the PciHost::registerDevice() call. This call returns a PciHost::DeviceInterface that provides for common functionality such as interrupt delivery and memory mapping.

The PciHost class itself provides very little functionality. Simple PciHost functionality is implemented by the GenericPciHost class.

Definition at line 75 of file host.hh.

Constructor & Destructor Documentation

◆ PciHost()

gem5::PciHost::PciHost ( const PciHostParams & p )

Definition at line 51 of file host.cc.

◆ ~PciHost()

gem5::PciHost::~PciHost ( )

virtual

Definition at line 56 of file host.cc.

Member Function Documentation

◆ clearInt()

virtual void gem5::PciHost::clearInt	(	const PciBusAddr &	bus_addr,
		PciIntPin	pin
	)

protectedpure virtual

Post an interrupt to the CPU.

Parameters

bus_addr	The device's position on the PCI bus
pin	PCI interrupt pin

Implemented in gem5::GenericPciHost.

◆ dmaAddr()

virtual Addr gem5::PciHost::dmaAddr	(	const PciBusAddr &	bus_addr,
		Addr	pci_addr
	)		const

protectedpure virtual

Calculate the physical address of a prefetchable memory location in the PCI address space.

Parameters

bus_addr	The device's position on the PCI bus
pci_addr	Address in the PCI DMA memory address space

Returns: Address in the system's physical address space.

Implemented in gem5::GenericPciHost.

Referenced by gem5::PciHost::DeviceInterface::dmaAddr().

◆ getDevice() [1/2]

PciDevice * gem5::PciHost::getDevice ( const PciBusAddr & addr )

protected

Retrieve a PCI device from its bus address.

Returns: Pointer to a PciDevice instance or nullptr if the device doesn't exist.

Definition at line 76 of file host.cc.

References gem5::X86ISA::addr, and devices.

Referenced by gem5::GenericPciHost::mapPciInterrupt(), gem5::GenericPciHost::read(), and gem5::GenericPciHost::write().

◆ getDevice() [2/2]

const PciDevice * gem5::PciHost::getDevice ( const PciBusAddr & addr ) const

protected

Retrieve a PCI device from its bus address.

Returns: Pointer to a constant PciDevice instance or nullptr if the device doesn't exist.

Definition at line 83 of file host.cc.

References gem5::X86ISA::addr, and devices.

◆ memAddr()

virtual Addr gem5::PciHost::memAddr	(	const PciBusAddr &	bus_addr,
		Addr	pci_addr
	)		const

protectedpure virtual

Calculate the physical address of a non-prefetchable memory location in the PCI address space.

Parameters

bus_addr	The device's position on the PCI bus
pci_addr	Address in the PCI memory address space

Returns: Address in the system's physical address space.

Implemented in gem5::GenericPciHost.

Referenced by gem5::PciHost::DeviceInterface::memAddr().

◆ pioAddr()

virtual Addr gem5::PciHost::pioAddr	(	const PciBusAddr &	bus_addr,
		Addr	pci_addr
	)		const

protectedpure virtual

Calculate the physical address of an IO location on the PCI bus.

Parameters

bus_addr	The device's position on the PCI bus
pci_addr	Address in the PCI IO address space

Returns: Address in the system's physical address space.

Implemented in gem5::GenericPciHost.

Referenced by gem5::PciHost::DeviceInterface::pioAddr().

◆ postInt()

virtual void gem5::PciHost::postInt	(	const PciBusAddr &	bus_addr,
		PciIntPin	pin
	)

protectedpure virtual

Post an interrupt to the CPU.

Parameters

bus_addr	The device's position on the PCI bus
pin	PCI interrupt pin

Implemented in gem5::GenericPciHost.

◆ registerDevice()

PciHost::DeviceInterface gem5::PciHost::registerDevice	(	PciDevice *	device,
		PciBusAddr	bus_addr,
		PciIntPin	pin
	)

virtual

Register a PCI device with the host.

Parameters

device	Device to register
bus_addr	The device's position on the PCI bus
pin	Interrupt pin

Returns: A device-specific DeviceInterface instance.

Definition at line 61 of file host.cc.

References gem5::PciBusAddr::bus, gem5::PciBusAddr::dev, devices, DPRINTF, fatal_if, and gem5::PciBusAddr::func.

Member Data Documentation

◆ devices

std::map<PciBusAddr, PciDevice *> gem5::PciHost::devices

private

Currently registered PCI devices.

Definition at line 245 of file host.hh.

Referenced by getDevice(), and registerDevice().

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

dev/pci/host.hh
dev/pci/host.cc

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PciHost()

◆ ~PciHost()

Member Function Documentation

◆ clearInt()

◆ dmaAddr()

◆ getDevice() [1/2]

◆ getDevice() [2/2]

◆ memAddr()

◆ pioAddr()

◆ postInt()

◆ registerDevice()

Member Data Documentation

◆ devices