Changeset 85030 in vbox for trunk/src/VBox/Devices

Timestamp:

Jul 1, 2020 3:14:59 PM (4 years ago)

Author:

vboxsync

Message:

Minor edits to comments in VirtioCore.h

File:

• trunk/src/VBox/Devices/VirtIO/VirtioCore.h (modified) (6 diffs)

trunk/src/VBox/Devices/VirtIO/VirtioCore.h

@@ -84 +84 @@
  * Each descriptor, e.g. [len, GCPhys] pair in the chain represents either an OUT segment (e.g. guest-to-host)
  * or an IN segment (host-to-guest). A VIRTQBUF is created and retured from a call to virtioCoreR3VirtqAvailBufPeek()
- * or virtioCoreR3VirtqAvailBufGet(), which consolodates the VirtIO descriptor chain into a representation, where
- * pSgPhysSend is GCPhys s/g buffer containing all of the OUT descriptors and pSgPhysReturn is a GCPhys s/g
- * buffer containing all of IN descriptors to be filled with data on the
- * host to return to the guest.
+ * or virtioCoreR3VirtqAvailBufGet(). That function consolodates the VirtIO descriptor chain into a
+ * representation, where pSgPhysSend is GCPhys s/g buffer containing all of the OUT descriptors and pSgPhysReturn \
+ * is a GCPhys s/g buffer containing all of IN descriptors to be filled with data on the host to return to the
+ * guest.
  */
 typedef struct VIRTQBUF
@@ -445 +445 @@
 void  virtioCoreVirtqEnableNotify(PVIRTIOCORE pVirtio, uint16_t uVirtqNbr, bool fEnable);
 
-/*
+/**
  * Notifies guest (via ISR or MSI-X) of device configuration change
  *
@@ -452 +452 @@
 void  virtioCoreNotifyConfigChanged(PVIRTIOCORE pVirtio);
 
-/*
+/**
  * Displays the VirtIO spec-related features offered by the core component,
  * as well as which features have been negotiated and accepted or declined by the guest driver,
@@ -483 +483 @@
 void  virtioCoreR3VirtqInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs, int uVirtqNbr);
 
-/*
+/**
  * Returns the number of avail bufs in the virtq.
  *
@@ -515 +515 @@
 
 /**
- * This functionf fetches the next buffer (descriptor chain) from the VirtIO "avail" ring of
+ * This function fetches the next buffer (descriptor chain) from the VirtIO "avail" ring of
  * indicated queue, and converts the buf's s/g vectors into OUT (e.g. guest-to-host)
  * components and and IN (host-to-guest) components.
@@ -614 +614 @@
 
 /**
- * Add some bytes out of a virtq (s/g) buffer, converting them from virtual memory to GCPhys
+ * Add some bytes to a virtq (s/g) buffer, converting them from virtual memory to GCPhys
  *
  * To be performant it is left to the caller to validate the size of the buffer with regard