gem5  v22.1.0.0
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
gem5::RiscvISA::MmioVirtIO Class Reference

#include <vio_mmio.hh>

Inheritance diagram for gem5::RiscvISA::MmioVirtIO:
gem5::PlicIntDevice gem5::BasicPioDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 MmioVirtIO (const RiscvMmioVirtIOParams &params)
 
virtual ~MmioVirtIO ()
 
- Public Member Functions inherited from gem5::PlicIntDevice
const Paramsparams () const
 
 PlicIntDevice (const Params &params)
 
const int & id ()
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. More...
 
- 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. 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 gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- 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. 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 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. 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &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. 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 Types

enum  { INT_USED_RING = 1 << 0 , INT_CONFIG = 1 << 1 }
 
enum  : Addr {
  OFF_MAGIC = 0x00 , OFF_VERSION = 0x04 , OFF_DEVICE_ID = 0x08 , OFF_VENDOR_ID = 0x0C ,
  OFF_HOST_FEATURES = 0x10 , OFF_HOST_FEATURES_SELECT = 0x14 , OFF_GUEST_FEATURES = 0x20 , OFF_GUEST_FEATURES_SELECT = 0x24 ,
  OFF_GUEST_PAGE_SIZE = 0x28 , OFF_QUEUE_SELECT = 0x30 , OFF_QUEUE_NUM_MAX = 0x34 , OFF_QUEUE_NUM = 0x38 ,
  OFF_QUEUE_ALIGN = 0x3C , OFF_QUEUE_PFN = 0x40 , OFF_QUEUE_NOTIFY = 0x50 , OFF_INTERRUPT_STATUS = 0x60 ,
  OFF_INTERRUPT_ACK = 0x64 , OFF_STATUS = 0x70 , OFF_CONFIG = 0x100
}
 Offsets into VirtIO MMIO space. More...
 

Protected Member Functions

Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
uint32_t read (Addr offset)
 
void write (Addr offset, uint32_t value)
 
void kick ()
 
void setInterrupts (uint32_t value)
 
- Protected Member Functions inherited from gem5::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 gem5::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

uint32_t hostFeaturesSelect
 
uint32_t guestFeaturesSelect
 
uint32_t pageSize
 
uint32_t interruptStatus
 
VirtIODeviceBasevio
 
- Protected Attributes inherited from gem5::PlicIntDevice
Systemsystem
 
Platformplatform
 
int _interruptID
 
- Protected Attributes inherited from gem5::BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. More...
 
- Protected Attributes inherited from gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Static Protected Attributes

static const uint32_t MAGIC = 0x74726976
 
static const uint32_t VERSION = 1
 
static const uint32_t VENDOR_ID = 0x1AF4
 

Additional Inherited Members

- Public Types inherited from gem5::PlicIntDevice
typedef PlicIntDeviceParams Params
 
- Public Types inherited from gem5::PioDevice
using Params = PioDeviceParams
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- 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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 54 of file vio_mmio.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : Addr
protected

Offsets into VirtIO MMIO space.

Enumerator
OFF_MAGIC 
OFF_VERSION 
OFF_DEVICE_ID 
OFF_VENDOR_ID 
OFF_HOST_FEATURES 
OFF_HOST_FEATURES_SELECT 
OFF_GUEST_FEATURES 
OFF_GUEST_FEATURES_SELECT 
OFF_GUEST_PAGE_SIZE 
OFF_QUEUE_SELECT 
OFF_QUEUE_NUM_MAX 
OFF_QUEUE_NUM 
OFF_QUEUE_ALIGN 
OFF_QUEUE_PFN 
OFF_QUEUE_NOTIFY 
OFF_INTERRUPT_STATUS 
OFF_INTERRUPT_ACK 
OFF_STATUS 
OFF_CONFIG 

Definition at line 68 of file vio_mmio.hh.

◆ anonymous enum

anonymous enum
protected
Enumerator
INT_USED_RING 
INT_CONFIG 

Definition at line 93 of file vio_mmio.hh.

Constructor & Destructor Documentation

◆ MmioVirtIO()

gem5::RiscvISA::MmioVirtIO::MmioVirtIO ( const RiscvMmioVirtIOParams &  params)

Definition at line 52 of file vio_mmio.cc.

References kick(), gem5::VirtIODeviceBase::registerKickCallback(), and vio.

◆ ~MmioVirtIO()

gem5::RiscvISA::MmioVirtIO::~MmioVirtIO ( )
virtual

Definition at line 60 of file vio_mmio.cc.

Member Function Documentation

◆ kick()

void gem5::RiscvISA::MmioVirtIO::kick ( )
protected

Definition at line 261 of file vio_mmio.cc.

References DPRINTF, INT_USED_RING, interruptStatus, and setInterrupts().

Referenced by MmioVirtIO().

◆ read() [1/2]

uint32_t gem5::RiscvISA::MmioVirtIO::read ( Addr  offset)
protected

◆ read() [2/2]

Tick gem5::RiscvISA::MmioVirtIO::read ( PacketPtr  pkt)
overrideprotectedvirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

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

Implements gem5::PioDevice.

Definition at line 65 of file vio_mmio.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), OFF_CONFIG, gem5::ArmISA::offset, panic_if, gem5::BasicPioDevice::pioAddr, gem5::VirtIODeviceBase::readConfig(), gem5::Packet::setLE(), and vio.

◆ setInterrupts()

void gem5::RiscvISA::MmioVirtIO::setInterrupts ( uint32_t  value)
protected

Definition at line 268 of file vio_mmio.cc.

References gem5::PlicIntDevice::_interruptID, interruptStatus, and gem5::PlicIntDevice::platform.

Referenced by kick(), and write().

◆ write() [1/2]

void gem5::RiscvISA::MmioVirtIO::write ( Addr  offset,
uint32_t  value 
)
protected

◆ write() [2/2]

Tick gem5::RiscvISA::MmioVirtIO::write ( PacketPtr  pkt)
overrideprotectedvirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

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

Implements gem5::PioDevice.

Definition at line 162 of file vio_mmio.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), OFF_CONFIG, gem5::ArmISA::offset, panic_if, gem5::BasicPioDevice::pioAddr, vio, and gem5::VirtIODeviceBase::writeConfig().

Member Data Documentation

◆ guestFeaturesSelect

uint32_t gem5::RiscvISA::MmioVirtIO::guestFeaturesSelect
protected

Definition at line 111 of file vio_mmio.hh.

Referenced by read(), and write().

◆ hostFeaturesSelect

uint32_t gem5::RiscvISA::MmioVirtIO::hostFeaturesSelect
protected

Definition at line 110 of file vio_mmio.hh.

Referenced by read(), and write().

◆ interruptStatus

uint32_t gem5::RiscvISA::MmioVirtIO::interruptStatus
protected

Definition at line 113 of file vio_mmio.hh.

Referenced by kick(), read(), setInterrupts(), and write().

◆ MAGIC

const uint32_t gem5::RiscvISA::MmioVirtIO::MAGIC = 0x74726976
staticprotected

Definition at line 99 of file vio_mmio.hh.

Referenced by read().

◆ pageSize

uint32_t gem5::RiscvISA::MmioVirtIO::pageSize
protected

Definition at line 112 of file vio_mmio.hh.

Referenced by read(), and write().

◆ VENDOR_ID

const uint32_t gem5::RiscvISA::MmioVirtIO::VENDOR_ID = 0x1AF4
staticprotected

Definition at line 101 of file vio_mmio.hh.

Referenced by read().

◆ VERSION

const uint32_t gem5::RiscvISA::MmioVirtIO::VERSION = 1
staticprotected

Definition at line 100 of file vio_mmio.hh.

Referenced by read().

◆ vio

VirtIODeviceBase& gem5::RiscvISA::MmioVirtIO::vio
protected

Definition at line 116 of file vio_mmio.hh.

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


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

Generated on Wed Dec 21 2022 10:24:22 for gem5 by doxygen 1.9.1