]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/VirtioNetDxe/TechNotes.txt
OvmfPkg/VirtioNetDxe: update TechNotes
[mirror_edk2.git] / OvmfPkg / VirtioNetDxe / TechNotes.txt
index fedbaee07ec7b3b28d71b3d44f1c5e0b95116a99..40a22f66dc22e89f45c3fbb4bae19faa31cd40ba 100644 (file)
@@ -312,10 +312,14 @@ in the following:
   that is shared by all of the head descriptors. This virtio-net request header\r
   is never modified by the host.\r
 \r
-- Each tail descriptor is re-pointed to the caller-supplied packet buffer\r
-  whenever VirtioNetTransmit places the corresponding head descriptor on the\r
-  Available Ring. The caller is responsible to hang on to the unmodified buffer\r
-  until it is reported transmitted by VirtioNetGetStatus.\r
+- Each tail descriptor is re-pointed to the device-mapped address of the\r
+  caller-supplied packet buffer whenever VirtioNetTransmit places the\r
+  corresponding head descriptor on the Available Ring. A reverse mapping, from\r
+  the device-mapped address to the caller-supplied packet address, is saved in\r
+  an associative data structure that belongs to the driver instance.\r
+\r
+- Per spec, the caller is responsible to hang on to the unmodified packet\r
+  buffer until it is reported transmitted by VirtioNetGetStatus.\r
 \r
 Steps of packet transmission:\r
 \r
@@ -338,9 +342,11 @@ Steps of packet transmission:
 - Client code calls VirtioNetGetStatus. In case the Used Ring is empty, the\r
   function reports no Tx completion. Otherwise, a head descriptor's index is\r
   consumed from the Used Ring and recycled to the private stack. The client\r
-  code's original packet buffer address is fetched from the tail descriptor\r
-  (where it has been stored at VirtioNetTransmit time) and returned to the\r
-  caller.\r
+  code's original packet buffer address is calculated by fetching the\r
+  device-mapped address from the tail descriptor (where it has been stored at\r
+  VirtioNetTransmit time), and by looking up the device-mapped address in the\r
+  associative data structure. The reverse-mapped packet buffer address is\r
+  returned to the caller.\r
 \r
 - The Len field of the Used Ring Element is not checked. The host is assumed to\r
   have transmitted the entire packet -- VirtioNetTransmit had forced it below\r