#include <pci.hh>

Inheritance diagram for gem5::PciVirtIO:

Public Types
typedef PciVirtIOParams	Params
Public Types inherited from gem5::DmaDevice
typedef DmaDeviceParams	Params
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

Public Member Functions
	PciVirtIO (const Params &params)
virtual	~PciVirtIO ()
Tick	read (PacketPtr pkt)
	Pure virtual function that the device must implement.
Tick	write (PacketPtr pkt)
	Pure virtual function that the device must implement.
void	kick ()
Public Member Functions inherited from gem5::PciEndpoint
	PciEndpoint (const PciEndpointParams &params)
	Constructor for PCI Dev.
Tick	writeConfig (PacketPtr pkt) override
	Write to the PCI config space data that is stored locally.
void	unserialize (CheckpointIn &cp) override
	Reconstruct the state of this object from a checkpoint.
Public Member Functions inherited from gem5::PciDevice
virtual Tick	readConfig (PacketPtr pkt)
	Read from the PCI config space data that is stored locally.
Addr	pciToDma (Addr pci_addr) const
void	intrPost ()
void	intrClear ()
uint8_t	interruptLine () const
AddrRangeList	getAddrRanges () const override
	Determine the address ranges that this device responds to.
	PciDevice (const PciDeviceParams &params, std::initializer_list< PciBar * > BARs_init)
	Constructor for PCI Dev.
void	serialize (CheckpointOut &cp) const override
	Serialize this object to the given output stream.
const PciBusAddr &	busAddr () const
Public Member Functions inherited from gem5::DmaDevice
	DmaDevice (const Params &p)
virtual	~DmaDevice ()=default
void	dmaWrite (Addr addr, int size, Event event, uint8_t data, std::optional< uint32_t > sid, std::optional< uint32_t > ssid, Tick delay=0)
void	dmaWrite (Addr addr, int size, Event event, uint8_t data, Tick delay=0)
void	dmaRead (Addr addr, int size, Event event, uint8_t data, std::optional< uint32_t > sid, std::optional< uint32_t > ssid, Tick delay=0)
void	dmaRead (Addr addr, int size, Event event, uint8_t data, Tick delay=0)
bool	dmaPending () const
void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected.
Addr	cacheBlockSize () const
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::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)
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 Attributes
VirtIODeviceBase::QueueID	queueNotify
bool	interruptDeliveryPending
VirtIODeviceBase &	vio
Protected Attributes inherited from gem5::PciDevice
const PciBusAddr	_busAddr
std::vector< MSIXTable >	msix_table
	MSIX Table and PBA Structures.
std::vector< MSIXPbaEntry >	msix_pba
std::vector< PciBar * >	BARs {}
PciHost::DeviceInterface	hostInterface
Tick	pioDelay
Tick	configDelay
const int	PMCAP_BASE
	The capability list structures and base addresses.
const int	PMCAP_ID_OFFSET
const int	PMCAP_PC_OFFSET
const int	PMCAP_PMCS_OFFSET
PMCAP	pmcap
const int	MSICAP_BASE
MSICAP	msicap
const int	MSIXCAP_BASE
const int	MSIXCAP_ID_OFFSET
const int	MSIXCAP_MXC_OFFSET
const int	MSIXCAP_MTAB_OFFSET
const int	MSIXCAP_MPBA_OFFSET
int	MSIX_TABLE_OFFSET
int	MSIX_TABLE_END
int	MSIX_PBA_OFFSET
int	MSIX_PBA_END
MSIXCAP	msixcap
const int	PXCAP_BASE
PXCAP	pxcap
Protected Attributes inherited from gem5::DmaDevice
DmaPort	dmaPort
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.

Static Protected Attributes
static const Addr	BAR0_SIZE_BASE = OFF_VIO_DEVICE

static const Addr	OFF_DEVICE_FEATURES = 0x00
	Offsets into VirtIO header (BAR0 relative).
static const Addr	OFF_GUEST_FEATURES = 0x04
static const Addr	OFF_QUEUE_ADDRESS = 0x08
static const Addr	OFF_QUEUE_SIZE = 0x0C
static const Addr	OFF_QUEUE_SELECT = 0x0E
static const Addr	OFF_QUEUE_NOTIFY = 0x10
static const Addr	OFF_DEVICE_STATUS = 0x12
static const Addr	OFF_ISR_STATUS = 0x13
static const Addr	OFF_VIO_DEVICE = 0x14

Additional Inherited Members
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 Member Functions inherited from gem5::PciEndpoint
PCIConfigType0 &	config ()
Protected Member Functions inherited from gem5::PciDevice
bool	getBAR (Addr addr, int &num, Addr &offs)
	Which base address register (if any) maps the given 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.

Detailed Description

Definition at line 50 of file pci.hh.

Member Typedef Documentation

◆ Params

typedef PciVirtIOParams gem5::PciVirtIO::Params

Definition at line 53 of file pci.hh.

Constructor & Destructor Documentation

◆ PciVirtIO()

gem5::PciVirtIO::PciVirtIO ( const Params & params )

Definition at line 49 of file pci.cc.

References gem5::alignToPowerOfTwo(), BAR0_SIZE_BASE, gem5::PciDevice::BARs, gem5::PciEndpoint::config(), gem5::htole(), interruptDeliveryPending, kick(), gem5::SimObject::params(), gem5::PciEndpoint::PciEndpoint(), queueNotify, PCIConfigType0::subsystemID, and vio.

◆ ~PciVirtIO()

gem5::PciVirtIO::~PciVirtIO ( )

virtual

Definition at line 65 of file pci.cc.

Member Function Documentation

◆ kick()

void gem5::PciVirtIO::kick ( )

Definition at line 223 of file pci.cc.

References DPRINTF, interruptDeliveryPending, and gem5::PciDevice::intrPost().

Referenced by PciVirtIO().

◆ read()

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

virtual

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 70 of file pci.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::PciDevice::getBAR(), gem5::Packet::getSize(), interruptDeliveryPending, gem5::PciDevice::intrClear(), gem5::Packet::makeResponse(), OFF_DEVICE_FEATURES, OFF_DEVICE_STATUS, OFF_GUEST_FEATURES, OFF_ISR_STATUS, OFF_QUEUE_ADDRESS, OFF_QUEUE_NOTIFY, OFF_QUEUE_SELECT, OFF_QUEUE_SIZE, OFF_VIO_DEVICE, gem5::ArmISA::offset, panic, queueNotify, gem5::Packet::setLE(), and vio.

◆ write()

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

virtual

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 151 of file pci.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::PciDevice::getBAR(), gem5::Packet::getLE(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), OFF_DEVICE_FEATURES, OFF_DEVICE_STATUS, OFF_GUEST_FEATURES, OFF_ISR_STATUS, OFF_QUEUE_ADDRESS, OFF_QUEUE_NOTIFY, OFF_QUEUE_SELECT, OFF_QUEUE_SIZE, OFF_VIO_DEVICE, gem5::ArmISA::offset, panic, queueNotify, gem5::ArmISA::status, vio, and warn.

Member Data Documentation

◆ BAR0_SIZE_BASE

const Addr gem5::PciVirtIO::BAR0_SIZE_BASE = OFF_VIO_DEVICE

staticprotected

Definition at line 78 of file pci.hh.

Referenced by PciVirtIO().

◆ interruptDeliveryPending

bool gem5::PciVirtIO::interruptDeliveryPending

protected

Definition at line 83 of file pci.hh.

Referenced by kick(), PciVirtIO(), and read().

◆ OFF_DEVICE_FEATURES

const Addr gem5::PciVirtIO::OFF_DEVICE_FEATURES = 0x00

staticprotected

Offsets into VirtIO header (BAR0 relative).

Definition at line 66 of file pci.hh.

Referenced by read(), and write().

◆ OFF_DEVICE_STATUS

const Addr gem5::PciVirtIO::OFF_DEVICE_STATUS = 0x12

staticprotected

Definition at line 72 of file pci.hh.

Referenced by read(), and write().

◆ OFF_GUEST_FEATURES

const Addr gem5::PciVirtIO::OFF_GUEST_FEATURES = 0x04

staticprotected

Definition at line 67 of file pci.hh.

Referenced by read(), and write().

◆ OFF_ISR_STATUS

const Addr gem5::PciVirtIO::OFF_ISR_STATUS = 0x13

staticprotected

Definition at line 73 of file pci.hh.

Referenced by read(), and write().

◆ OFF_QUEUE_ADDRESS

const Addr gem5::PciVirtIO::OFF_QUEUE_ADDRESS = 0x08

staticprotected

Definition at line 68 of file pci.hh.

Referenced by read(), and write().

◆ OFF_QUEUE_NOTIFY

const Addr gem5::PciVirtIO::OFF_QUEUE_NOTIFY = 0x10

staticprotected

Definition at line 71 of file pci.hh.

Referenced by read(), and write().

◆ OFF_QUEUE_SELECT

const Addr gem5::PciVirtIO::OFF_QUEUE_SELECT = 0x0E

staticprotected

Definition at line 70 of file pci.hh.

Referenced by read(), and write().

◆ OFF_QUEUE_SIZE

const Addr gem5::PciVirtIO::OFF_QUEUE_SIZE = 0x0C

staticprotected

Definition at line 69 of file pci.hh.

Referenced by read(), and write().

◆ OFF_VIO_DEVICE

const Addr gem5::PciVirtIO::OFF_VIO_DEVICE = 0x14

staticprotected

Definition at line 74 of file pci.hh.

Referenced by read(), and write().

◆ queueNotify

VirtIODeviceBase::QueueID gem5::PciVirtIO::queueNotify

protected

Definition at line 81 of file pci.hh.

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

◆ vio

VirtIODeviceBase& gem5::PciVirtIO::vio

protected

Definition at line 85 of file pci.hh.

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

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

dev/virtio/pci.hh
dev/virtio/pci.cc

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ PciVirtIO()

◆ ~PciVirtIO()

Member Function Documentation

◆ kick()

◆ read()

◆ write()

Member Data Documentation

◆ BAR0_SIZE_BASE

◆ interruptDeliveryPending

◆ OFF_DEVICE_FEATURES

◆ OFF_DEVICE_STATUS

◆ OFF_GUEST_FEATURES

◆ OFF_ISR_STATUS

◆ OFF_QUEUE_ADDRESS

◆ OFF_QUEUE_NOTIFY

◆ OFF_QUEUE_SELECT

◆ OFF_QUEUE_SIZE

◆ OFF_VIO_DEVICE

◆ queueNotify

◆ vio