Configurable generic PCI host interface. More...

#include <host.hh>

Inheritance diagram for gem5::GenericPciHost:

Public Member Functions
	GenericPciHost (const GenericPciHostParams &p)

virtual	~GenericPciHost ()

Tick	read (PacketPtr pkt) override
	Pure virtual function that the device must implement.

Tick	write (PacketPtr pkt) override
	Pure virtual function that the device must implement.

AddrRangeList	getAddrRanges () const override
	Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Public Member Functions inherited from gem5::PciHost
	PciHost (const PciHostParams &p)

virtual	~PciHost ()

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

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.

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::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 (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.

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
Addr	pioAddr (const PciBusAddr &bus_addr, Addr pci_addr) const override
	Calculate the physical address of an IO location on the PCI bus.

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

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

virtual std::pair< PciBusAddr, Addr >	decodeAddress (Addr address)
	Decode a configuration space address.

void	postInt (const PciBusAddr &addr, PciIntPin pin) override
	Post an interrupt to the CPU.

void	clearInt (const PciBusAddr &addr, PciIntPin pin) override
	Post an interrupt to the CPU.

virtual uint32_t	mapPciInterrupt (const PciBusAddr &bus_addr, PciIntPin pin) const

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

const PciDevice *	getDevice (const PciBusAddr &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::PioDevice
System *	sys

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

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::PioDevice
using	Params = PioDeviceParams

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 PciBusAddr 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 276 of file host.hh.

Constructor & Destructor Documentation

◆ GenericPciHost()

gem5::GenericPciHost::GenericPciHost ( const GenericPciHostParams & p )

Definition at line 121 of file host.cc.

◆ ~GenericPciHost()

gem5::GenericPciHost::~GenericPciHost ( )

virtual

Definition at line 131 of file host.cc.

Member Function Documentation

◆ clearInt()

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

overrideprotectedvirtual

Post an interrupt to the CPU.

Parameters

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

Implements gem5::PciHost.

Definition at line 208 of file host.cc.

References gem5::X86ISA::addr, mapPciInterrupt(), and platform.

◆ decodeAddress()

std::pair< PciBusAddr, Addr > gem5::GenericPciHost::decodeAddress ( Addr address )

protectedvirtual

Decode a configuration space address.

Parameters

addr	Offset into the configuration space

Returns: Tuple containing the PCI bus address and an offset into the device's configuration space.

Definition at line 188 of file host.cc.

References gem5::X86ISA::addr, gem5::bits(), confDeviceBits, gem5::ArmISA::mask, and gem5::ArmISA::offset.

Referenced by read(), and write().

◆ dmaAddr()

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

inlineoverrideprotectedvirtual

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.

Implements gem5::PciHost.

Definition at line 297 of file host.hh.

References pciDmaBase.

◆ getAddrRanges()

AddrRangeList gem5::GenericPciHost::getAddrRanges ( ) const

overridevirtual

Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Returns: a list of non-overlapping address ranges

Implements gem5::PioDevice.

Definition at line 182 of file host.cc.

References confBase, confSize, and gem5::RangeSize().

◆ mapPciInterrupt()

uint32_t gem5::GenericPciHost::mapPciInterrupt	(	const PciBusAddr &	bus_addr,
		PciIntPin	pin ) const

protectedvirtual

Reimplemented in gem5::GenericArmPciHost, and gem5::GenericRiscvPciHost.

Definition at line 215 of file host.cc.

References gem5::X86ISA::addr, gem5::PciHost::getDevice(), and gem5::PciDevice::interruptLine().

Referenced by clearInt(), gem5::GenericArmPciHost::mapPciInterrupt(), and postInt().

◆ memAddr()

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

inlineoverrideprotectedvirtual

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.

Implements gem5::PciHost.

Definition at line 293 of file host.hh.

References pciMemBase.

◆ pioAddr()

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

inlineoverrideprotectedvirtual

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.

Implements gem5::PciHost.

Definition at line 289 of file host.hh.

References pciPioBase.

◆ postInt()

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

overrideprotectedvirtual

Post an interrupt to the CPU.

Parameters

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

Implements gem5::PciHost.

Definition at line 202 of file host.cc.

References gem5::X86ISA::addr, mapPciInterrupt(), and platform.

◆ read()

Tick gem5::GenericPciHost::read ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 137 of file host.cc.

References confBase, decodeAddress(), DPRINTF, gem5::Packet::getAddr(), gem5::PciHost::getDevice(), gem5::Packet::getPtr(), gem5::Packet::getSize(), gem5::Packet::headerDelay, gem5::Packet::makeAtomicResponse(), gem5::Packet::payloadDelay, and gem5::PciDevice::readConfig().

◆ write()

Tick gem5::GenericPciHost::write ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 161 of file host.cc.

References confBase, decodeAddress(), DPRINTF, gem5::Packet::getAddr(), gem5::PciHost::getDevice(), gem5::Packet::getSize(), gem5::Packet::headerDelay, panic_if, gem5::Packet::payloadDelay, and gem5::PciDevice::writeConfig().

Member Data Documentation

◆ confBase

const Addr gem5::GenericPciHost::confBase

protected

Definition at line 322 of file host.hh.

Referenced by getAddrRanges(), read(), and write().

◆ confDeviceBits

const uint8_t gem5::GenericPciHost::confDeviceBits

protected

Definition at line 324 of file host.hh.

Referenced by decodeAddress().

◆ confSize

const Addr gem5::GenericPciHost::confSize

protected

Definition at line 323 of file host.hh.

Referenced by getAddrRanges().

◆ pciDmaBase

const Addr gem5::GenericPciHost::pciDmaBase

protected

Definition at line 328 of file host.hh.

Referenced by dmaAddr().

◆ pciMemBase

const Addr gem5::GenericPciHost::pciMemBase

protected

Definition at line 327 of file host.hh.

Referenced by memAddr().

◆ pciPioBase

const Addr gem5::GenericPciHost::pciPioBase

protected

Definition at line 326 of file host.hh.

Referenced by pioAddr().

◆ platform

Platform& gem5::GenericPciHost::platform

protected

Definition at line 320 of file host.hh.

Referenced by clearInt(), and postInt().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenericPciHost()

◆ ~GenericPciHost()

Member Function Documentation

◆ clearInt()

◆ decodeAddress()

◆ dmaAddr()

◆ getAddrRanges()

◆ mapPciInterrupt()

◆ memAddr()

◆ pioAddr()

◆ postInt()

◆ read()

◆ write()

Member Data Documentation

◆ confBase

◆ confDeviceBits

◆ confSize

◆ pciDmaBase

◆ pciMemBase

◆ pciPioBase

◆ platform