gem5  v20.1.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PciDevice Class Reference

PCI device, base implementation is only config space. More...

#include <device.hh>

Inheritance diagram for PciDevice:
DmaDevice PioDevice ClockedObject SimObject Clocked EventManager Serializable Drainable Stats::Group CopyEngine EtherDevice IdeController PciVirtIO EtherDevBase IGbE NSGigE Sinic::Base Sinic::Device

Public Member Functions

virtual Tick writeConfig (PacketPtr pkt)
 Write to the PCI config space data that is stored locally. More...
 
virtual Tick readConfig (PacketPtr pkt)
 Read from the PCI config space data that is stored locally. More...
 
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. More...
 
 PciDevice (const PciDeviceParams *params)
 Constructor for PCI Dev. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize this object to the given output stream. More...
 
void unserialize (CheckpointIn &cp) override
 Reconstruct the state of this object from a checkpoint. More...
 
const PciBusAddrbusAddr () const
 
- Public Member Functions inherited from DmaDevice
 DmaDevice (const Params *p)
 
virtual ~DmaDevice ()
 
void dmaWrite (Addr addr, int size, Event *event, uint8_t *data, uint32_t sid, 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, uint32_t sid, 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. More...
 
unsigned int cacheBlockSize () const
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () 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 regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 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
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. 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 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 Stats::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 (Stats::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from 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

bool isLargeBAR (int bar) const
 Does the given BAR represent 32 lower bits of a 64-bit address? More...
 
bool isBAR (Addr addr, int bar) const
 Does the given address lie within the space mapped by the given base address register? More...
 
int getBAR (Addr addr)
 Which base address register (if any) maps the given address? More...
 
bool getBAR (Addr addr, int &bar, Addr &offs)
 Which base address register (if any) maps the given address? More...
 
- Protected Member Functions inherited from PioDevice
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
 
Clockedoperator= (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...
 

Protected Attributes

const PciBusAddr _busAddr
 
PCIConfig config
 The current config space. More...
 
std::vector< MSIXTablemsix_table
 MSIX Table and PBA Structures. More...
 
std::vector< MSIXPbaEntrymsix_pba
 
uint32_t BARSize [6]
 The size of the BARs. More...
 
Addr BARAddrs [6]
 The current address mapping of the BARs. More...
 
bool legacyIO [6]
 Whether the BARs are really hardwired legacy IO locations. More...
 
PciHost::DeviceInterface hostInterface
 
Tick pioDelay
 
Tick configDelay
 
const int PMCAP_BASE
 The capability list structures and base addresses. More...
 
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 DmaDevice
DmaPort dmaPort
 
- Protected Attributes inherited from PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- Public Types inherited from DmaDevice
typedef DmaDeviceParams Params
 
- Public Types inherited from PioDevice
typedef PioDeviceParams 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 SimObjectfind (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 ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Public Attributes inherited from ClockedObject
PowerStatepowerState
 

Detailed Description

PCI device, base implementation is only config space.

Definition at line 66 of file device.hh.

Constructor & Destructor Documentation

◆ PciDevice()

PciDevice::PciDevice ( const PciDeviceParams *  params)

Member Function Documentation

◆ busAddr()

const PciBusAddr& PciDevice::busAddr ( ) const
inline

Definition at line 230 of file device.hh.

References _busAddr.

◆ getAddrRanges()

AddrRangeList PciDevice::getAddrRanges ( ) const
overridevirtual

Determine the address ranges that this device responds to.

Returns
a list of non-overlapping address ranges

Implements PioDevice.

Definition at line 273 of file device.cc.

References BARAddrs, BARSize, RangeSize(), and RiscvISA::x.

◆ getBAR() [1/2]

int PciDevice::getBAR ( Addr  addr)
inlineprotected

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

Returns
The BAR number (0-5 inclusive), or -1 if none.

Definition at line 139 of file device.hh.

References addr, ArmISA::i, and isBAR().

Referenced by getBAR(), PciVirtIO::read(), CopyEngine::read(), IGbE::read(), PciVirtIO::write(), CopyEngine::write(), and IGbE::write().

◆ getBAR() [2/2]

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

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

Parameters
addrThe address to check.
Return values
barThe 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 158 of file device.hh.

References addr, ArmISA::b, BARAddrs, and getBAR().

◆ interruptLine()

uint8_t PciDevice::interruptLine ( ) const
inline

Definition at line 201 of file device.hh.

References config, PCIConfig::interruptLine, and letoh().

Referenced by GenericPciHost::mapPciInterrupt().

◆ intrClear()

void PciDevice::intrClear ( )
inline

◆ intrPost()

void PciDevice::intrPost ( )
inline

◆ isBAR()

bool PciDevice::isBAR ( Addr  addr,
int  bar 
) const
inlineprotected

Does the given address lie within the space mapped by the given base address register?

Definition at line 128 of file device.hh.

References addr, BARAddrs, and BARSize.

Referenced by getBAR().

◆ isLargeBAR()

bool PciDevice::isLargeBAR ( int  bar) const
inlineprotected

Does the given BAR represent 32 lower bits of a 64-bit address?

Definition at line 118 of file device.hh.

References PCIConfig::baseAddr, bits(), and config.

Referenced by writeConfig().

◆ pciToDma()

Addr PciDevice::pciToDma ( Addr  pci_addr) const
inline

◆ readConfig()

Tick PciDevice::readConfig ( PacketPtr  pkt)
virtual

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 write the offset into config space

Reimplemented in IdeController.

Definition at line 216 of file device.cc.

References _busAddr, config, configDelay, PCIConfig::data, PciBusAddr::dev, DPRINTF, PciBusAddr::func, Packet::getAddr(), Packet::getLE(), Packet::getSize(), Packet::makeAtomicResponse(), SimObject::name(), ArmISA::offset, panic, PCI_CONFIG_SIZE, PCI_DEVICE_SPECIFIC, Packet::setLE(), and warn_once.

Referenced by GenericPciHost::read(), NSGigE::read(), and IdeController::readConfig().

◆ serialize()

void PciDevice::serialize ( CheckpointOut cp) const
overridevirtual

◆ unserialize()

void PciDevice::unserialize ( CheckpointIn cp)
overridevirtual

◆ writeConfig()

Tick PciDevice::writeConfig ( PacketPtr  pkt)
virtual

Member Data Documentation

◆ _busAddr

const PciBusAddr PciDevice::_busAddr
protected

Definition at line 69 of file device.hh.

Referenced by busAddr(), readConfig(), and writeConfig().

◆ BARAddrs

Addr PciDevice::BARAddrs[6]
protected

◆ BARSize

uint32_t PciDevice::BARSize[6]
protected

◆ config

PCIConfig PciDevice::config
protected

◆ configDelay

Tick PciDevice::configDelay
protected

◆ hostInterface

PciHost::DeviceInterface PciDevice::hostInterface
protected

Definition at line 188 of file device.hh.

Referenced by intrClear(), intrPost(), pciToDma(), and writeConfig().

◆ legacyIO

bool PciDevice::legacyIO[6]
protected

Whether the BARs are really hardwired legacy IO locations.

Definition at line 112 of file device.hh.

Referenced by IdeController::IdeController(), PciDevice(), and writeConfig().

◆ msicap

MSICAP PciDevice::msicap
protected

Definition at line 84 of file device.hh.

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

◆ MSICAP_BASE

const int PciDevice::MSICAP_BASE
protected

Definition at line 83 of file device.hh.

◆ msix_pba

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

Definition at line 103 of file device.hh.

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

◆ MSIX_PBA_END

int PciDevice::MSIX_PBA_END
protected

Definition at line 94 of file device.hh.

Referenced by PciDevice().

◆ MSIX_PBA_OFFSET

int PciDevice::MSIX_PBA_OFFSET
protected

Definition at line 93 of file device.hh.

Referenced by PciDevice().

◆ msix_table

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

MSIX Table and PBA Structures.

Definition at line 102 of file device.hh.

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

◆ MSIX_TABLE_END

int PciDevice::MSIX_TABLE_END
protected

Definition at line 92 of file device.hh.

Referenced by PciDevice().

◆ MSIX_TABLE_OFFSET

int PciDevice::MSIX_TABLE_OFFSET
protected

Definition at line 91 of file device.hh.

Referenced by PciDevice().

◆ msixcap

MSIXCAP PciDevice::msixcap
protected

Definition at line 95 of file device.hh.

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

◆ MSIXCAP_BASE

const int PciDevice::MSIXCAP_BASE
protected

Definition at line 86 of file device.hh.

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

◆ MSIXCAP_ID_OFFSET

const int PciDevice::MSIXCAP_ID_OFFSET
protected

Definition at line 87 of file device.hh.

◆ MSIXCAP_MPBA_OFFSET

const int PciDevice::MSIXCAP_MPBA_OFFSET
protected

Definition at line 90 of file device.hh.

◆ MSIXCAP_MTAB_OFFSET

const int PciDevice::MSIXCAP_MTAB_OFFSET
protected

Definition at line 89 of file device.hh.

◆ MSIXCAP_MXC_OFFSET

const int PciDevice::MSIXCAP_MXC_OFFSET
protected

Definition at line 88 of file device.hh.

◆ pioDelay

Tick PciDevice::pioDelay
protected

◆ pmcap

PMCAP PciDevice::pmcap
protected

Definition at line 81 of file device.hh.

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

◆ PMCAP_BASE

const int PciDevice::PMCAP_BASE
protected

The capability list structures and base addresses.

Definition at line 77 of file device.hh.

◆ PMCAP_ID_OFFSET

const int PciDevice::PMCAP_ID_OFFSET
protected

Definition at line 78 of file device.hh.

◆ PMCAP_PC_OFFSET

const int PciDevice::PMCAP_PC_OFFSET
protected

Definition at line 79 of file device.hh.

◆ PMCAP_PMCS_OFFSET

const int PciDevice::PMCAP_PMCS_OFFSET
protected

Definition at line 80 of file device.hh.

◆ pxcap

PXCAP PciDevice::pxcap
protected

Definition at line 98 of file device.hh.

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

◆ PXCAP_BASE

const int PciDevice::PXCAP_BASE
protected

Definition at line 97 of file device.hh.


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

Generated on Wed Sep 30 2020 14:02:29 for gem5 by doxygen 1.8.17