gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
PciVirtIO Class Reference

#include <pci.hh>

Inheritance diagram for PciVirtIO:
PciDevice DmaDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

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

Public Member Functions

 PciVirtIO (const Params *params)
 
virtual ~PciVirtIO ()
 
Tick read (PacketPtr pkt)
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt)
 Pure virtual function that the device must implement. More...
 
void kick ()
 
- Public Member Functions inherited from PciDevice
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, 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
 
BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a master port with a given name and index. More...
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
virtual BaseSlavePortgetSlavePort (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 Paramsparams () const
 
 MemObject (const Params *params)
 
- 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...
 
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 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 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...
 
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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
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 Attributes

VirtIODeviceBase::QueueID queueNotify
 
bool interruptDeliveryPending
 
VirtIODeviceBasevio
 
MakeCallback< PciVirtIO,&PciVirtIO::kickcallbackKick
 
- Protected Attributes inherited from PciDevice
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 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
EventQueueeventq
 A pointer to this object's event queue. More...
 

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). More...
 
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 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 ()
 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 Member Functions inherited from PciDevice
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 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...
 

Detailed Description

Definition at line 49 of file pci.hh.

Member Typedef Documentation

typedef PciVirtIOParams PciVirtIO::Params

Definition at line 52 of file pci.hh.

Constructor & Destructor Documentation

PciVirtIO::PciVirtIO ( const Params params)
PciVirtIO::~PciVirtIO ( )
virtual

Definition at line 63 of file pci.cc.

Member Function Documentation

void PciVirtIO::kick ( )

Definition at line 221 of file pci.cc.

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

Tick PciVirtIO::read ( PacketPtr  pkt)
virtual
Tick PciVirtIO::write ( PacketPtr  pkt)
virtual

Member Data Documentation

const Addr PciVirtIO::BAR0_SIZE_BASE = OFF_VIO_DEVICE
staticprotected

Definition at line 77 of file pci.hh.

Referenced by PciVirtIO().

MakeCallback<PciVirtIO, &PciVirtIO::kick> PciVirtIO::callbackKick
protected

Definition at line 86 of file pci.hh.

Referenced by PciVirtIO().

bool PciVirtIO::interruptDeliveryPending
protected

Definition at line 82 of file pci.hh.

Referenced by kick(), and read().

const Addr PciVirtIO::OFF_DEVICE_FEATURES = 0x00
staticprotected

Offsets into VirtIO header (BAR0 relative).

Definition at line 65 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_DEVICE_STATUS = 0x12
staticprotected

Definition at line 71 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_GUEST_FEATURES = 0x04
staticprotected

Definition at line 66 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_ISR_STATUS = 0x13
staticprotected

Definition at line 72 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_QUEUE_ADDRESS = 0x08
staticprotected

Definition at line 67 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_QUEUE_NOTIFY = 0x10
staticprotected

Definition at line 70 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_QUEUE_SELECT = 0x0E
staticprotected

Definition at line 69 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_QUEUE_SIZE = 0x0C
staticprotected

Definition at line 68 of file pci.hh.

Referenced by read(), and write().

const Addr PciVirtIO::OFF_VIO_DEVICE = 0x14
staticprotected

Definition at line 73 of file pci.hh.

Referenced by read(), and write().

VirtIODeviceBase::QueueID PciVirtIO::queueNotify
protected

Definition at line 80 of file pci.hh.

Referenced by read(), and write().

VirtIODeviceBase& PciVirtIO::vio
protected

Definition at line 84 of file pci.hh.

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


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

Generated on Fri Jun 9 2017 13:04:16 for gem5 by doxygen 1.8.6