gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
EtherDevBase Class Reference

Dummy class to keep the Python class hierarchy in sync with the C++ object hierarchy. More...

#include <etherdevice.hh>

Inheritance diagram for EtherDevBase:
EtherDevice PciDevice DmaDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable NSGigE Sinic::Base Sinic::Device

Public Member Functions

 EtherDevBase (const EtherDevBaseParams *params)
 
const EtherDevBaseParams * params () const
 
- Public Member Functions inherited from EtherDevice
 EtherDevice (const Params *params)
 
const Paramsparams () const
 
virtual EtherIntgetEthPort (const std::string &if_name, int idx=-1)=0
 Additional function to return the Port of a memory object. More...
 
void regStats ()
 Register statistics for this object. More...
 
- 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
 

Additional Inherited Members

- Public Types inherited from EtherDevice
typedef EtherDeviceParams 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
 
- 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 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...
 
- Protected Attributes inherited from EtherDevice
Stats::Scalar txBytes
 
Stats::Scalar rxBytes
 
Stats::Scalar txPackets
 
Stats::Scalar rxPackets
 
Stats::Scalar txIpChecksums
 
Stats::Scalar rxIpChecksums
 
Stats::Scalar txTcpChecksums
 
Stats::Scalar rxTcpChecksums
 
Stats::Scalar txUdpChecksums
 
Stats::Scalar rxUdpChecksums
 
Stats::Scalar descDmaReads
 
Stats::Scalar descDmaWrites
 
Stats::Scalar descDmaRdBytes
 
Stats::Scalar descDmaWrBytes
 
Stats::Formula totBandwidth
 
Stats::Formula totPackets
 
Stats::Formula totBytes
 
Stats::Formula totPacketRate
 
Stats::Formula txBandwidth
 
Stats::Formula rxBandwidth
 
Stats::Formula txPacketRate
 
Stats::Formula rxPacketRate
 
Stats::Scalar postedSwi
 
Stats::Formula coalescedSwi
 
Stats::Scalar totalSwi
 
Stats::Scalar postedRxIdle
 
Stats::Formula coalescedRxIdle
 
Stats::Scalar totalRxIdle
 
Stats::Scalar postedRxOk
 
Stats::Formula coalescedRxOk
 
Stats::Scalar totalRxOk
 
Stats::Scalar postedRxDesc
 
Stats::Formula coalescedRxDesc
 
Stats::Scalar totalRxDesc
 
Stats::Scalar postedTxOk
 
Stats::Formula coalescedTxOk
 
Stats::Scalar totalTxOk
 
Stats::Scalar postedTxIdle
 
Stats::Formula coalescedTxIdle
 
Stats::Scalar totalTxIdle
 
Stats::Scalar postedTxDesc
 
Stats::Formula coalescedTxDesc
 
Stats::Scalar totalTxDesc
 
Stats::Scalar postedRxOrn
 
Stats::Formula coalescedRxOrn
 
Stats::Scalar totalRxOrn
 
Stats::Formula coalescedTotal
 
Stats::Scalar postedInterrupts
 
Stats::Scalar droppedPackets
 
- 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...
 

Detailed Description

Dummy class to keep the Python class hierarchy in sync with the C++ object hierarchy.

The Python object hierarchy includes the EtherDevBase class which is used by some ethernet devices as a way to share common configuration information in the generated param structs. Since the Python hierarchy is used to generate a Python interfaces for all C++ SimObjects, we need to reflect this in the C++ object hierarchy.

Definition at line 134 of file etherdevice.hh.

Constructor & Destructor Documentation

EtherDevBase::EtherDevBase ( const EtherDevBaseParams *  params)
inline

Definition at line 137 of file etherdevice.hh.

Member Function Documentation

const EtherDevBaseParams* EtherDevBase::params ( ) const
inline

Definition at line 142 of file etherdevice.hh.

References SimObject::_params.


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

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