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

#include <host.hh>

Inheritance diagram for 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 PioDevice
	PioDevice (const Params *p)

virtual	~PioDevice ()

const Params *	params () const

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

virtual BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

virtual BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a master port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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	resetStats ()
	Reset statistics associated with this object. 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 EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

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

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

Additional Inherited Members
Public Types inherited from PioDevice
typedef PioDeviceParams	Params

Public Types inherited from MemObject
typedef MemObjectParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize 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 Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Protected Attributes inherited from PioDevice
System *	sys

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

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

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

Protected Attributes inherited from 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 74 of file host.hh.

Constructor & Destructor Documentation

PciHost::PciHost ( const PciHostParams * p )

Definition at line 50 of file host.cc.

PciHost::~PciHost ( )

virtual

Definition at line 55 of file host.cc.

Member Function Documentation

virtual void 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 GenericPciHost.

virtual Addr 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 GenericPciHost, and TsunamiPChip.

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

PciDevice * 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 75 of file host.cc.

References devices.

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

const PciDevice * 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 82 of file host.cc.

References devices.

virtual Addr 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 GenericPciHost.

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

virtual Addr 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 GenericPciHost.

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

virtual void 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 GenericPciHost.

PciHost::DeviceInterface 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 60 of file host.cc.

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

Member Data Documentation

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

private

Currently registered PCI devices.

Definition at line 244 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

Member Function Documentation

Member Data Documentation