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

#include <etherdevice.hh>

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

Public Types

typedef EtherDeviceParams Params
 
- 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
 

Public Member Functions

 EtherDevice (const Params *params)
 
const Paramsparams () const
 
void regStats ()
 Callback to set stat parameters. 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, 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 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 Attributes

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< 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

- 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
 
- Protected Member Functions inherited from PciDevice
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...
 

Detailed Description

Definition at line 45 of file etherdevice.hh.

Member Typedef Documentation

◆ Params

typedef EtherDeviceParams EtherDevice::Params

Definition at line 48 of file etherdevice.hh.

Constructor & Destructor Documentation

◆ EtherDevice()

EtherDevice::EtherDevice ( const Params params)
inline

Definition at line 49 of file etherdevice.hh.

Member Function Documentation

◆ params()

const Params* EtherDevice::params ( ) const
inline

Definition at line 54 of file etherdevice.hh.

References SimObject::_params.

◆ regStats()

void EtherDevice::regStats ( )
virtual

Member Data Documentation

◆ coalescedRxDesc

Stats::Formula EtherDevice::coalescedRxDesc
protected

Definition at line 95 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedRxIdle

Stats::Formula EtherDevice::coalescedRxIdle
protected

Definition at line 89 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedRxOk

Stats::Formula EtherDevice::coalescedRxOk
protected

Definition at line 92 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedRxOrn

Stats::Formula EtherDevice::coalescedRxOrn
protected

Definition at line 107 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedSwi

Stats::Formula EtherDevice::coalescedSwi
protected

Definition at line 86 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedTotal

Stats::Formula EtherDevice::coalescedTotal
protected

Definition at line 109 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedTxDesc

Stats::Formula EtherDevice::coalescedTxDesc
protected

Definition at line 104 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedTxIdle

Stats::Formula EtherDevice::coalescedTxIdle
protected

Definition at line 101 of file etherdevice.hh.

Referenced by regStats().

◆ coalescedTxOk

Stats::Formula EtherDevice::coalescedTxOk
protected

Definition at line 98 of file etherdevice.hh.

Referenced by regStats().

◆ descDmaRdBytes

Stats::Scalar EtherDevice::descDmaRdBytes
protected

Definition at line 75 of file etherdevice.hh.

Referenced by regStats(), NSGigE::rxKick(), and NSGigE::txKick().

◆ descDmaReads

Stats::Scalar EtherDevice::descDmaReads
protected

Definition at line 73 of file etherdevice.hh.

Referenced by regStats(), NSGigE::rxKick(), and NSGigE::txKick().

◆ descDmaWrBytes

Stats::Scalar EtherDevice::descDmaWrBytes
protected

Definition at line 76 of file etherdevice.hh.

Referenced by regStats(), NSGigE::rxKick(), and NSGigE::txKick().

◆ descDmaWrites

Stats::Scalar EtherDevice::descDmaWrites
protected

Definition at line 74 of file etherdevice.hh.

Referenced by regStats(), NSGigE::rxKick(), and NSGigE::txKick().

◆ droppedPackets

Stats::Scalar EtherDevice::droppedPackets
protected

Definition at line 111 of file etherdevice.hh.

Referenced by NSGigE::recvPacket(), and regStats().

◆ postedInterrupts

Stats::Scalar EtherDevice::postedInterrupts
protected

Definition at line 110 of file etherdevice.hh.

Referenced by IGbE::cpuPostInt(), NSGigE::devIntrPost(), and regStats().

◆ postedRxDesc

Stats::Scalar EtherDevice::postedRxDesc
protected

Definition at line 94 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedRxIdle

Stats::Scalar EtherDevice::postedRxIdle
protected

Definition at line 88 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedRxOk

Stats::Scalar EtherDevice::postedRxOk
protected

Definition at line 91 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedRxOrn

Stats::Scalar EtherDevice::postedRxOrn
protected

Definition at line 106 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedSwi

Stats::Scalar EtherDevice::postedSwi
protected

Definition at line 85 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedTxDesc

Stats::Scalar EtherDevice::postedTxDesc
protected

Definition at line 103 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedTxIdle

Stats::Scalar EtherDevice::postedTxIdle
protected

Definition at line 100 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ postedTxOk

Stats::Scalar EtherDevice::postedTxOk
protected

Definition at line 97 of file etherdevice.hh.

Referenced by NSGigE::devIntrClear(), and regStats().

◆ rxBandwidth

Stats::Formula EtherDevice::rxBandwidth
protected

Definition at line 82 of file etherdevice.hh.

Referenced by regStats().

◆ rxBytes

Stats::Scalar EtherDevice::rxBytes
protected

◆ rxIpChecksums

Stats::Scalar EtherDevice::rxIpChecksums
protected

Definition at line 68 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::rxKick(), and NSGigE::rxKick().

◆ rxPacketRate

Stats::Formula EtherDevice::rxPacketRate
protected

Definition at line 84 of file etherdevice.hh.

Referenced by regStats().

◆ rxPackets

Stats::Scalar EtherDevice::rxPackets
protected

◆ rxTcpChecksums

Stats::Scalar EtherDevice::rxTcpChecksums
protected

Definition at line 70 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::rxKick(), and NSGigE::rxKick().

◆ rxUdpChecksums

Stats::Scalar EtherDevice::rxUdpChecksums
protected

Definition at line 72 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::rxKick(), and NSGigE::rxKick().

◆ totalRxDesc

Stats::Scalar EtherDevice::totalRxDesc
protected

Definition at line 96 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalRxIdle

Stats::Scalar EtherDevice::totalRxIdle
protected

Definition at line 90 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalRxOk

Stats::Scalar EtherDevice::totalRxOk
protected

Definition at line 93 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalRxOrn

Stats::Scalar EtherDevice::totalRxOrn
protected

Definition at line 108 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalSwi

Stats::Scalar EtherDevice::totalSwi
protected

Definition at line 87 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalTxDesc

Stats::Scalar EtherDevice::totalTxDesc
protected

Definition at line 105 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalTxIdle

Stats::Scalar EtherDevice::totalTxIdle
protected

Definition at line 102 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totalTxOk

Stats::Scalar EtherDevice::totalTxOk
protected

Definition at line 99 of file etherdevice.hh.

Referenced by NSGigE::devIntrPost(), and regStats().

◆ totBandwidth

Stats::Formula EtherDevice::totBandwidth
protected

Definition at line 77 of file etherdevice.hh.

Referenced by regStats().

◆ totBytes

Stats::Formula EtherDevice::totBytes
protected

Definition at line 79 of file etherdevice.hh.

Referenced by regStats().

◆ totPacketRate

Stats::Formula EtherDevice::totPacketRate
protected

Definition at line 80 of file etherdevice.hh.

Referenced by regStats().

◆ totPackets

Stats::Formula EtherDevice::totPackets
protected

Definition at line 78 of file etherdevice.hh.

Referenced by regStats().

◆ txBandwidth

Stats::Formula EtherDevice::txBandwidth
protected

Definition at line 81 of file etherdevice.hh.

Referenced by regStats().

◆ txBytes

Stats::Scalar EtherDevice::txBytes
protected

Definition at line 63 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::transmit(), NSGigE::transmit(), and IGbE::txWire().

◆ txIpChecksums

Stats::Scalar EtherDevice::txIpChecksums
protected

Definition at line 67 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::txKick(), and NSGigE::txKick().

◆ txPacketRate

Stats::Formula EtherDevice::txPacketRate
protected

Definition at line 83 of file etherdevice.hh.

Referenced by regStats().

◆ txPackets

Stats::Scalar EtherDevice::txPackets
protected

Definition at line 65 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::transmit(), NSGigE::transmit(), and IGbE::txWire().

◆ txTcpChecksums

Stats::Scalar EtherDevice::txTcpChecksums
protected

Definition at line 69 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::txKick(), and NSGigE::txKick().

◆ txUdpChecksums

Stats::Scalar EtherDevice::txUdpChecksums
protected

Definition at line 71 of file etherdevice.hh.

Referenced by regStats(), Sinic::Device::txKick(), and NSGigE::txKick().


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

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