gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
VirtQueue::VirtRing< T > Class Template Reference

VirtIO ring buffer wrapper. More...

Classes

struct  Header
 

Public Types

typedef uint16_t Flags
 
typedef uint16_t Index
 

Public Member Functions

 VirtRing (PortProxy &proxy, uint16_t size)
 
void setAddress (Addr addr)
 Set the base address of the VirtIO ring buffer. More...
 
void readHeader ()
 Update the ring buffer header with data from the guest. More...
 
void writeHeader ()
 
void read ()
 
void write ()
 

Public Attributes

struct VirtQueue::VirtRing::Header M5_ATTR_PACKED
 
Header header
 Ring buffer header in host byte order. More...
 
std::vector< T > ring
 Elements in ring in host byte order. More...
 

Private Member Functions

 VirtRing ()
 

Private Attributes

PortProxy_proxy
 Guest physical memory proxy. More...
 
Addr _base
 Guest physical base address of the ring buffer. More...
 

Detailed Description

template<typename T>
class VirtQueue::VirtRing< T >

VirtIO ring buffer wrapper.

This class wraps a VirtIO ring buffer. The template parameter T is used to select the data type for the items in the ring (used or available descriptors).

Definition at line 471 of file base.hh.

Member Typedef Documentation

template<typename T>
typedef uint16_t VirtQueue::VirtRing< T >::Flags

Definition at line 474 of file base.hh.

template<typename T>
typedef uint16_t VirtQueue::VirtRing< T >::Index

Definition at line 475 of file base.hh.

Constructor & Destructor Documentation

template<typename T>
VirtQueue::VirtRing< T >::VirtRing ( PortProxy proxy,
uint16_t  size 
)
inline

Definition at line 482 of file base.hh.

template<typename T>
VirtQueue::VirtRing< T >::VirtRing ( )
private

Member Function Documentation

template<typename T>
void VirtQueue::VirtRing< T >::read ( )
inline

Definition at line 508 of file base.hh.

Referenced by VirtQueue::consumeDescriptor().

template<typename T>
void VirtQueue::VirtRing< T >::readHeader ( )
inline

Update the ring buffer header with data from the guest.

Definition at line 493 of file base.hh.

Referenced by VirtQueue::produceDescriptor(), and VirtQueue::VirtRing< struct vring_used_elem >::read().

template<typename T>
void VirtQueue::VirtRing< T >::setAddress ( Addr  addr)
inline

Set the base address of the VirtIO ring buffer.

Parameters
addrNew host physical address

Definition at line 490 of file base.hh.

Referenced by VirtQueue::setAddress().

template<typename T>
void VirtQueue::VirtRing< T >::write ( )
inline

Definition at line 519 of file base.hh.

Referenced by VirtQueue::produceDescriptor().

template<typename T>
void VirtQueue::VirtRing< T >::writeHeader ( )
inline

Definition at line 500 of file base.hh.

Referenced by VirtQueue::VirtRing< struct vring_used_elem >::write().

Member Data Documentation

template<typename T>
Addr VirtQueue::VirtRing< T >::_base
private
template<typename T>
PortProxy& VirtQueue::VirtRing< T >::_proxy
private
template<typename T>
Header VirtQueue::VirtRing< T >::header
template<typename T>
struct VirtQueue::VirtRing::Header VirtQueue::VirtRing< T >::M5_ATTR_PACKED
template<typename T>
std::vector<T> VirtQueue::VirtRing< T >::ring

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

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