gem5 [DEVELOP-FOR-25.1]
Loading...
Searching...
No Matches
gem5::PciDevice Class Referenceabstract

Base class to represent a PCI device. More...

#include <device.hh>

Inheritance diagram for gem5::PciDevice:
gem5::DmaDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::PciEndpoint gem5::PciType1Device gem5::AMDGPUDevice gem5::CopyEngine gem5::EtherDevice gem5::IdeController gem5::PciVirtIO gem5::EtherDevBase gem5::IGbE gem5::X86IdeController gem5::NSGigE gem5::sinic::Base gem5::sinic::Device

Public Member Functions

Tick write (PacketPtr pkt) final
 Final implementation of write access from DmaDevice.
Tick read (PacketPtr pkt) final
 Final implementation of read access from PioDevice.
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.
void unserialize (CheckpointIn &cp) override
 Reconstruct the state of this object from a checkpoint.
const PciDevAddrdevAddr () const
void recvBusChange ()
 Called to receive a bus number change from the PCI upstream.
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
PortgetPort (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.
PortgetPort (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 Paramsparams () 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.
ProbeManagergetProbeManager ()
 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
EventQueueeventQueue () 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 InforesolveStat (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
Groupoperator= (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

bool getBAR (Addr addr, int &num, Addr &offs)
 Which base address register (if any) maps the given address?
virtual Tick writeConfig (PacketPtr pkt)
 Write to the PCI config space data that is stored locally.
virtual Tick readConfig (PacketPtr pkt)
 Read from the PCI config space data that is stored locally.
virtual Tick writeDevice (PacketPtr pkt)=0
 Write to the PCI device.
virtual Tick readDevice (PacketPtr pkt)=0
 Read from the PCI device.
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
Clockedoperator= (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

const PciDevAddr _devAddr
std::vector< MSIXTablemsix_table
 MSIX Table and PBA Structures.
std::vector< MSIXPbaEntrymsix_pba
std::vector< PciBar * > BARs {}
PciUpstream::DeviceInterface upstreamInterface
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
Systemsys
PioPort< PioDevicepioPort
 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
EventQueueeventq
 A pointer to this object's event queue.

Private Member Functions

bool isCommonConfig (Addr offs)

Private Attributes

friend PciEndpoint
friend PciType1Device
PCIConfig _config
 The current config space.

Additional Inherited Members

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
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 SimObjectfind (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 SimObjectResolvergetSimObjectResolver ()
 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
PowerStatepowerState

Detailed Description

Base class to represent a PCI device.

Two main types of PCI device exists:

  • Type 0: Any endpoint card (GPU, network card, ...)
  • Type 1: A bridge that extend the PCI hierarchy with a new bus, where endpoints or other bridges can be connected.

The class PciDevice implements the common behavior between the two types and should not be inherited directly.

PCI devices have a configuration header of 256 bytes. The first 64 bytes of the configuration are specific to the device type and they are represented by the struct PciConfigType0/1. The remaining bytes are specifics to the device itself and can contain a set of PCI capabilities (power management, interrupts, ...) or other registres depending on vendor implementation.

Devices inheriting from a PCI device type can override readConfig() and writeConfig() to manage the configuration access after the 64th byte.

The functions readDevice() and writeDevice() can be overriden to provide functionnality based on BAR access.

Definition at line 296 of file device.hh.

Constructor & Destructor Documentation

◆ PciDevice()

Member Function Documentation

◆ devAddr()

const PciDevAddr & gem5::PciDevice::devAddr ( ) const
inline

Definition at line 481 of file device.hh.

References _devAddr.

◆ getAddrRanges()

AddrRangeList gem5::PciDevice::getAddrRanges ( ) const
overridevirtual

Determine the address ranges that this device responds to.

Returns
a list of non-overlapping address ranges

Implements gem5::PioDevice.

Definition at line 274 of file device.cc.

References _config, BARs, gem5::letoh(), and upstreamInterface.

◆ getBAR()

bool gem5::PciDevice::getBAR ( Addr addr,
int & num,
Addr & offs )
inlineprotected

Which base address register (if any) maps the given address?

Parameters
addrThe address to check.
Return values
numThe BAR number (0-5 inclusive), only valid if return value is true.
offsThe offset from the base address, only valid if return value is true.
Returns
True iff address maps to a base address register's region.

Definition at line 358 of file device.hh.

References gem5::X86ISA::addr, BARs, and gem5::ArmISA::i.

Referenced by gem5::IdeController::dispatchAccess(), gem5::AMDGPUDevice::readDevice(), gem5::CopyEngine::readDevice(), gem5::IGbE::readDevice(), gem5::PciVirtIO::readDevice(), gem5::AMDGPUDevice::writeDevice(), gem5::CopyEngine::writeDevice(), gem5::IGbE::writeDevice(), and gem5::PciVirtIO::writeDevice().

◆ interruptLine()

uint8_t gem5::PciDevice::interruptLine ( ) const
inline

Definition at line 447 of file device.hh.

References _config, and gem5::letoh().

Referenced by gem5::GenericPciHost::mapPciInterrupt().

◆ intrClear()

◆ intrPost()

◆ isCommonConfig()

bool gem5::PciDevice::isCommonConfig ( Addr offs)
inlineprivate

◆ pciToDma()

◆ read()

Tick gem5::PciDevice::read ( PacketPtr pkt)
finalvirtual

Final implementation of read access from PioDevice.

This function should not be overriden by the device. For device access the function PciDevice::readDevice() should be overriden.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 264 of file device.cc.

References gem5::Packet::getAddr(), readConfig(), readDevice(), and upstreamInterface.

Referenced by gem5::IdeController::Channel::accessBMI(), gem5::IdeController::Channel::accessCommand(), gem5::IdeController::Channel::accessControl(), gem5::AMDGPUDevice::dispatchAccess(), and gem5::IdeController::dispatchAccess().

◆ readConfig()

Tick gem5::PciDevice::readConfig ( PacketPtr pkt)
protectedvirtual

Read from the PCI config space data that is stored locally.

This may be overridden by the device but at some point it will eventually call this for normal operations that it does not need to override.

Parameters
pktpacket containing the read offset into config space

Reimplemented in gem5::AMDGPUDevice, and gem5::IdeController.

Definition at line 207 of file device.cc.

References _config, _devAddr, configDelay, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), gem5::Packet::makeAtomicResponse(), name(), gem5::ArmISA::offset, panic, PCI_CONFIG_SIZE, PCI_DEVICE_SPECIFIC, PciDevice(), gem5::Packet::setLE(), and warn_once.

Referenced by read(), gem5::AMDGPUDevice::readConfig(), gem5::IdeController::readConfig(), and gem5::NSGigE::readDevice().

◆ readDevice()

virtual Tick gem5::PciDevice::readDevice ( PacketPtr pkt)
protectedpure virtual

Read from the PCI device.

This must be implemented by the device to respond to IO, memory, ... request.

Parameters
pktpacket containing the read request

Implemented in gem5::AMDGPUDevice, gem5::CopyEngine, gem5::IdeController, gem5::IGbE, gem5::NSGigE, gem5::PciVirtIO, and gem5::sinic::Device.

Referenced by read().

◆ recvBusChange()

void gem5::PciDevice::recvBusChange ( )

Called to receive a bus number change from the PCI upstream.

A bus number change means that all address ranges (configuration, ...) can be changed, so this will send a range change to the peer request port.

Definition at line 406 of file device.cc.

References gem5::PioDevice::pioPort.

◆ serialize()

void gem5::PciDevice::serialize ( CheckpointOut & cp) const
overridevirtual

◆ unserialize()

void gem5::PciDevice::unserialize ( CheckpointIn & cp)
overridevirtual

Reconstruct the state of this object from a checkpoint.

Parameters
cpThe checkpoint use.
sectionThe section name of this object

Reimplemented from gem5::ClockedObject.

Reimplemented in gem5::PciEndpoint, and gem5::PciType1Device.

Definition at line 489 of file device.cc.

References _config, gem5::bits(), gem5::csprintf(), gem5::ArmISA::i, msicap, msix_pba, msix_table, msixcap, MSIXCAP_BASE, gem5::paramIn(), pmcap, pxcap, UNSERIALIZE_ARRAY, and UNSERIALIZE_SCALAR.

Referenced by gem5::PciEndpoint::unserialize(), and gem5::PciType1Device::unserialize().

◆ write()

Tick gem5::PciDevice::write ( PacketPtr pkt)
finalvirtual

Final implementation of write access from DmaDevice.

This function should not be overriden by the device. For device access the function PciDevice::writeDevice() should be overriden.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 396 of file device.cc.

References gem5::Packet::getAddr(), upstreamInterface, writeConfig(), and writeDevice().

Referenced by gem5::PciEndpoint::unserialize(), and gem5::PciType1Device::unserialize().

◆ writeConfig()

Tick gem5::PciDevice::writeConfig ( PacketPtr pkt)
protectedvirtual

Write to the PCI config space data that is stored locally.

This may be overridden by the device but at some point it will eventually call this for normal operations that it does not need to override.

Parameters
pktpacket containing the write offset into config space

Reimplemented in gem5::AMDGPUDevice, gem5::IdeController, gem5::IGbE, gem5::NSGigE, gem5::PciEndpoint, and gem5::PciType1Device.

Definition at line 291 of file device.cc.

References _config, _devAddr, configDelay, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), isCommonConfig(), gem5::Packet::makeAtomicResponse(), name(), gem5::ArmISA::offset, panic, PCI_CACHE_LINE_SIZE, PCI_CLASS_CODE, PCI_COMMAND, PCI_CONFIG_SIZE, PCI_DEVICE_SPECIFIC, PCI_INTERRUPT_LINE, PCI_INTERRUPT_PIN, PCI_LATENCY_TIMER, PCI_REVISION_ID, PCI_STATUS, PciDevice(), gem5::PioDevice::pioPort, and warn_once.

Referenced by write(), gem5::PciEndpoint::writeConfig(), and gem5::PciType1Device::writeConfig().

◆ writeDevice()

virtual Tick gem5::PciDevice::writeDevice ( PacketPtr pkt)
protectedpure virtual

Write to the PCI device.

This must be implemented by the device to respond to IO, memory, ... request.

Parameters
pktpacket containing the write request

Implemented in gem5::AMDGPUDevice, gem5::CopyEngine, gem5::IdeController, gem5::IGbE, gem5::NSGigE, gem5::PciVirtIO, and gem5::sinic::Device.

Referenced by write().

Member Data Documentation

◆ _config

◆ _devAddr

◆ BARs

◆ configDelay

◆ msicap

MSICAP gem5::PciDevice::msicap
protected

Definition at line 325 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ MSICAP_BASE

const int gem5::PciDevice::MSICAP_BASE
protected

Definition at line 324 of file device.hh.

Referenced by PciDevice().

◆ msix_pba

std::vector<MSIXPbaEntry> gem5::PciDevice::msix_pba
protected

Definition at line 344 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ MSIX_PBA_END

int gem5::PciDevice::MSIX_PBA_END
protected

Definition at line 335 of file device.hh.

Referenced by PciDevice().

◆ MSIX_PBA_OFFSET

int gem5::PciDevice::MSIX_PBA_OFFSET
protected

Definition at line 334 of file device.hh.

Referenced by PciDevice().

◆ msix_table

std::vector<MSIXTable> gem5::PciDevice::msix_table
protected

MSIX Table and PBA Structures.

Definition at line 343 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ MSIX_TABLE_END

int gem5::PciDevice::MSIX_TABLE_END
protected

Definition at line 333 of file device.hh.

Referenced by PciDevice().

◆ MSIX_TABLE_OFFSET

int gem5::PciDevice::MSIX_TABLE_OFFSET
protected

Definition at line 332 of file device.hh.

Referenced by PciDevice().

◆ msixcap

MSIXCAP gem5::PciDevice::msixcap
protected

Definition at line 336 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ MSIXCAP_BASE

const int gem5::PciDevice::MSIXCAP_BASE
protected

Definition at line 327 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ MSIXCAP_ID_OFFSET

const int gem5::PciDevice::MSIXCAP_ID_OFFSET
protected

Definition at line 328 of file device.hh.

Referenced by PciDevice().

◆ MSIXCAP_MPBA_OFFSET

const int gem5::PciDevice::MSIXCAP_MPBA_OFFSET
protected

Definition at line 331 of file device.hh.

Referenced by PciDevice().

◆ MSIXCAP_MTAB_OFFSET

const int gem5::PciDevice::MSIXCAP_MTAB_OFFSET
protected

Definition at line 330 of file device.hh.

Referenced by PciDevice().

◆ MSIXCAP_MXC_OFFSET

const int gem5::PciDevice::MSIXCAP_MXC_OFFSET
protected

Definition at line 329 of file device.hh.

Referenced by PciDevice().

◆ PciEndpoint

friend gem5::PciDevice::PciEndpoint
private

Definition at line 298 of file device.hh.

◆ PciType1Device

friend gem5::PciDevice::PciType1Device
private

Definition at line 299 of file device.hh.

◆ pioDelay

◆ pmcap

PMCAP gem5::PciDevice::pmcap
protected

Definition at line 322 of file device.hh.

Referenced by PciDevice(), serialize(), and unserialize().

◆ PMCAP_BASE

const int gem5::PciDevice::PMCAP_BASE
protected

The capability list structures and base addresses.

Definition at line 318 of file device.hh.

Referenced by PciDevice().

◆ PMCAP_ID_OFFSET

const int gem5::PciDevice::PMCAP_ID_OFFSET
protected

Definition at line 319 of file device.hh.

Referenced by PciDevice().

◆ PMCAP_PC_OFFSET

const int gem5::PciDevice::PMCAP_PC_OFFSET
protected

Definition at line 320 of file device.hh.

Referenced by PciDevice().

◆ PMCAP_PMCS_OFFSET

const int gem5::PciDevice::PMCAP_PMCS_OFFSET
protected

Definition at line 321 of file device.hh.

Referenced by PciDevice().

◆ pxcap

PXCAP gem5::PciDevice::pxcap
protected

◆ PXCAP_BASE

const int gem5::PciDevice::PXCAP_BASE
protected

◆ upstreamInterface


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

Generated on Mon Oct 27 2025 04:13:12 for gem5 by doxygen 1.14.0