gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
gem5::VirtIOConsole Class Reference

VirtIO console. More...

#include <console.hh>

Inheritance diagram for gem5::VirtIOConsole:
gem5::VirtIODeviceBase gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  Config
 Console configuration structure. More...
 
class  TermRecvQueue
 Virtqueue for data going from the host to the guest. More...
 
class  TermTransQueue
 Virtqueue for data going from the guest to the host. More...
 

Public Types

typedef VirtIOConsoleParams Params
 
- Public Types inherited from gem5::VirtIODeviceBase
typedef uint16_t QueueID
 
typedef uint32_t FeatureBits
 
typedef uint16_t VirtAddress
 This is a VirtQueue address as exposed through the low-level interface. The address needs to be multiplied by the page size (seems to be hardcoded to 4096 in the spec) to get the real physical address. More...
 
typedef uint16_t DeviceId
 Device Type (sometimes known as subsystem ID) More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 VirtIOConsole (const Params &params)
 
virtual ~VirtIOConsole ()
 
void readConfig (PacketPtr pkt, Addr cfgOffset)
 Read from the configuration space of a device. More...
 
- Public Member Functions inherited from gem5::VirtIODeviceBase
 BitUnion8 (DeviceStatus) Bitfield< 7 > failed
 
 EndBitUnion (DeviceStatus) typedef VirtIODeviceBaseParams Params
 
 VirtIODeviceBase (const Params &params, DeviceId id, size_t config_size, FeatureBits features)
 
virtual ~VirtIODeviceBase ()
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
virtual void writeConfig (PacketPtr pkt, Addr cfgOffset)
 Write to the configuration space of a device. More...
 
virtual void reset ()
 Driver-request device reset. More...
 
void registerKickCallback (const std::function< void()> &callback)
 Register a callback to kick the guest through the transport interface. More...
 
void onNotify (QueueID index)
 Driver is requesting service. More...
 
void setQueueSelect (QueueID idx)
 Change currently active queue. More...
 
QueueID getQueueSelect () const
 Get the currently active queue. More...
 
void setQueueAddress (uint32_t address)
 Change the host physical address of the currently active queue. More...
 
uint32_t getQueueAddress () const
 Get the host physical address of the currently active queue. More...
 
uint16_t getQueueSize () const
 Get the size (descriptors) of the currently active queue. More...
 
void setDeviceStatus (DeviceStatus status)
 Update device status and optionally reset device. More...
 
DeviceStatus getDeviceStatus () const
 Retrieve the device status. More...
 
void setGuestFeatures (FeatureBits features)
 Set feature bits accepted by the guest driver. More...
 
FeatureBits getGuestFeatures () const
 Get features accepted by the guest driver. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
 

Protected Attributes

Config config
 Currently active configuration (host byte order) More...
 
TermRecvQueue qRecv
 Receive queue for port 0. More...
 
TermTransQueue qTrans
 Transmit queue for port 0. More...
 
SerialDevicedevice
 
- Protected Attributes inherited from gem5::VirtIODeviceBase
FeatureBits guestFeatures
 Feature set accepted by the guest. More...
 
ByteOrder byteOrder
 The byte order of the queues, descriptors, etc. 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 DeviceId ID_CONSOLE = 0x03
 VirtIO device ID. More...
 
Feature bits
static const FeatureBits F_SIZE = 0x01
 Provides the size information. More...
 
static const FeatureBits F_MULTIPORT = 0x02
 Supports the multi-port interface. More...
 

Additional Inherited Members

- 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::VirtIODeviceBase
Bitfield< 2 > driver_ok
 
Bitfield< 1 > driver
 
Bitfield< 0 > acknowledge
 
const DeviceId deviceId
 Device ID (sometimes known as subsystem ID) More...
 
const size_t configSize
 Size of the device's configuration space. More...
 
const FeatureBits deviceFeatures
 Feature set offered by the device. More...
 
- Protected Member Functions inherited from gem5::VirtIODeviceBase
void kick ()
 Inform the guest of available buffers. More...
 
void registerQueue (VirtQueue &queue)
 Register a new VirtQueue with the device model. More...
 
void readConfigBlob (PacketPtr pkt, Addr cfgOffset, const uint8_t *cfg)
 Read configuration data from a device structure. More...
 
void writeConfigBlob (PacketPtr pkt, Addr cfgOffset, uint8_t *cfg)
 Write configuration data to a device structure. More...
 
- 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...
 

Detailed Description

VirtIO console.

The VirtIO console uses the following queues:

  1. Port0 receive (from host to guest)
  2. Port0 transmit (from guest to host)
  3. Control receive (optional)
  4. Control transmit (optional)
  5. Port1 receive (optional)
  6. Port1 transmit (optional)

This implementation implements the minimum of features for one port, which means that the multiport feature is not announced and only queue 0 and 1 are available.

See also
https://github.com/rustyrussell/virtio-spec
http://docs.oasis-open.org/virtio/virtio/v1.0/virtio-v1.0.html

Definition at line 68 of file console.hh.

Member Typedef Documentation

◆ Params

typedef VirtIOConsoleParams gem5::VirtIOConsole::Params

Definition at line 71 of file console.hh.

Constructor & Destructor Documentation

◆ VirtIOConsole()

gem5::VirtIOConsole::VirtIOConsole ( const Params params)

◆ ~VirtIOConsole()

gem5::VirtIOConsole::~VirtIOConsole ( )
virtual

Definition at line 63 of file console.cc.

Member Function Documentation

◆ readConfig()

void gem5::VirtIOConsole::readConfig ( PacketPtr  pkt,
Addr  cfgOffset 
)
virtual

Read from the configuration space of a device.

This method is called by the transport interface to read data from a device model's configuration space. The device model should use the cfgOffset parameter as the offset into its configuration space.

Warning
The address in the packet should not be used to determine the offset into a device's configuration space.
Parameters
pktRead request packet.
cfgOffsetOffset into the device's configuration space.

Reimplemented from gem5::VirtIODeviceBase.

Definition at line 67 of file console.cc.

References gem5::VirtIODeviceBase::byteOrder, gem5::VirtIOConsole::Config::cols, config, gem5::htog(), gem5::VirtIODeviceBase::readConfigBlob(), and gem5::VirtIOConsole::Config::rows.

Member Data Documentation

◆ config

Config gem5::VirtIOConsole::config
protected

Currently active configuration (host byte order)

Definition at line 91 of file console.hh.

Referenced by readConfig(), and VirtIOConsole().

◆ device

SerialDevice& gem5::VirtIOConsole::device
protected

Definition at line 155 of file console.hh.

Referenced by gem5::VirtIOConsole::TermRecvQueue::trySend(), and VirtIOConsole().

◆ F_MULTIPORT

const FeatureBits gem5::VirtIOConsole::F_MULTIPORT = 0x02
staticprotected

Supports the multi-port interface.

Definition at line 102 of file console.hh.

◆ F_SIZE

const FeatureBits gem5::VirtIOConsole::F_SIZE = 0x01
staticprotected

Provides the size information.

Definition at line 100 of file console.hh.

◆ ID_CONSOLE

const DeviceId gem5::VirtIOConsole::ID_CONSOLE = 0x03
staticprotected

VirtIO device ID.

Definition at line 94 of file console.hh.

◆ qRecv

TermRecvQueue gem5::VirtIOConsole::qRecv
protected

Receive queue for port 0.

Definition at line 130 of file console.hh.

Referenced by VirtIOConsole().

◆ qTrans

TermTransQueue gem5::VirtIOConsole::qTrans
protected

Transmit queue for port 0.

Definition at line 152 of file console.hh.

Referenced by VirtIOConsole().


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

Generated on Tue Sep 21 2021 12:28:20 for gem5 by doxygen 1.8.17