gem5  v20.1.0.0
Public Member Functions | Protected Attributes | List of all members
VirtIOConsole::TermRecvQueue Class Reference

Virtqueue for data going from the host to the guest. More...

#include <console.hh>

Inheritance diagram for VirtIOConsole::TermRecvQueue:
VirtQueue Serializable

Public Member Functions

 TermRecvQueue (PortProxy &proxy, ByteOrder bo, uint16_t size, VirtIOConsole &_parent)
 
virtual ~TermRecvQueue ()
 
void onNotify ()
 Notify queue of pending events. More...
 
void trySend ()
 Try to send data pending data from the terminal. More...
 
std::string name () const
 
- Public Member Functions inherited from VirtQueue
virtual ~VirtQueue ()
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void setAddress (Addr address)
 Set the base address of this queue. More...
 
Addr getAddress () const
 Get the guest physical address of this queue. More...
 
uint16_t getSize () const
 Get the number of descriptors available in this queue. More...
 
VirtDescriptorgetDescriptor (VirtDescriptor::Index index)
 Get a pointer to a specific descriptor in the queue. More...
 
VirtDescriptorconsumeDescriptor ()
 Get an incoming descriptor chain from the queue. More...
 
void produceDescriptor (VirtDescriptor *desc, uint32_t len)
 Send a descriptor chain to the guest. More...
 
virtual void onNotifyDescriptor (VirtDescriptor *desc)
 Notify queue of pending incoming descriptor. More...
 
void dump () const
 Dump the contents of a queue. More...
 
- 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)
 

Protected Attributes

VirtIOConsoleparent
 
- Protected Attributes inherited from VirtQueue
ByteOrder byteOrder
 Byte order in this queue. More...
 

Additional Inherited Members

- 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)
 
- Static Public Attributes inherited from VirtQueue
static const Addr ALIGN_BITS = 12
 Page size used by VirtIO. It's hard-coded to 4096 bytes in the spec for historical reasons. More...
 
static const Addr ALIGN_SIZE = 1 << ALIGN_BITS
 
- Protected Member Functions inherited from VirtQueue
 VirtQueue (PortProxy &proxy, ByteOrder bo, uint16_t size)
 Instantiate a new virtqueue. More...
 

Detailed Description

Virtqueue for data going from the host to the guest.

Definition at line 105 of file console.hh.

Constructor & Destructor Documentation

◆ TermRecvQueue()

VirtIOConsole::TermRecvQueue::TermRecvQueue ( PortProxy proxy,
ByteOrder  bo,
uint16_t  size,
VirtIOConsole _parent 
)
inline

Definition at line 109 of file console.hh.

◆ ~TermRecvQueue()

virtual VirtIOConsole::TermRecvQueue::~TermRecvQueue ( )
inlinevirtual

Definition at line 112 of file console.hh.

Member Function Documentation

◆ name()

std::string VirtIOConsole::TermRecvQueue::name ( ) const
inline

Definition at line 119 of file console.hh.

References SimObject::name(), and parent.

◆ onNotify()

void VirtIOConsole::TermRecvQueue::onNotify ( )
inlinevirtual

Notify queue of pending events.

This method is called by VirtIODeviceBase::onNotify() to notify the device model of pending data in a virtqueue. The default implementation of this method iterates over the available descriptor chains and calls onNotifyDescriptor() for every new incoming chain.

Device models should normally overload one of onNotify() and onNotifyDescriptor().

Reimplemented from VirtQueue.

Definition at line 114 of file console.hh.

References trySend().

◆ trySend()

void VirtIOConsole::TermRecvQueue::trySend ( )

Member Data Documentation

◆ parent

VirtIOConsole& VirtIOConsole::TermRecvQueue::parent
protected

Definition at line 122 of file console.hh.

Referenced by name(), and trySend().


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

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