OvmfPkg/VirtioNetDxe: document Rx/Tx allocs and mappings on Init/Shutdown

Document the following actions on the

  EfiSimpleNetworkStarted <-> EfiSimpleNetworkInitialized

state transitions:

* from commit 46b11f00ac70 ("OvmfPkg/VirtioNetDxe: alloc RxBuf using
  AllocateSharedPages()", 2017-09-14):

  VirtioNetInitRx ->
  { VirtIo->AllocateSharedPages, VirtioMapAllBytesInSharedBuffer }

  VirtioNetShutdownRx ->
  { VirtIo->UnmapSharedBuffer, VirtIo->FreeSharedPages }

* from commit 891f016c1b99 ("OvmfPkg/VirtioNetDxe: dynamically alloc
  transmit header", 2017-09-14):

  VirtioNetInitTx ->
  { VirtIo->AllocateSharedPages, VirtioMapAllBytesInSharedBuffer }

  VirtioNetShutdownTx ->
  { VirtIo->UnmapSharedBuffer, VirtIo->FreeSharedPages }

Cc: Brijesh Singh <brijesh.singh@amd.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Brijesh Singh <brijesh.singh@amd.com>

diff --git a/OvmfPkg/VirtioNetDxe/TechNotes.txt b/OvmfPkg/VirtioNetDxe/TechNotes.txt
index 40a22f66dc22e89f45c3fbb4bae19faa31cd40ba..cd38750a4afb060e957d1126f4cb0ec09814fc18 100644 (file)
--- a/OvmfPkg/VirtioNetDxe/TechNotes.txt
+++ b/OvmfPkg/VirtioNetDxe/TechNotes.txt
@@ -69,10 +69,14 @@ faithfully indented) that implement the transition.
   [SnpInitialize.c]            |  | [SnpShutdown.c]\r
   VirtioNetInitialize          |  | VirtioNetShutdown\r
     VirtioNetInitRing {Rx, Tx} |  |   VirtioNetShutdownRx [SnpSharedHelpers.c]\r
-      VirtioRingInit           |  |   VirtioNetShutdownTx [SnpSharedHelpers.c]\r
-      VirtioRingMap            |  |   VirtioNetUninitRing [SnpSharedHelpers.c]\r
-    VirtioNetInitTx            |  |                       {Tx, Rx}\r
-    VirtioNetInitRx            |  |     VirtIo->UnmapSharedBuffer\r
+      VirtioRingInit           |  |     VirtIo->UnmapSharedBuffer\r
+      VirtioRingMap            |  |     VirtIo->FreeSharedPages\r
+    VirtioNetInitTx            |  |   VirtioNetShutdownTx [SnpSharedHelpers.c]\r
+      VirtIo->AllocateShare... |  |     VirtIo->UnmapSharedBuffer\r
+      VirtioMapAllBytesInSh... |  |     VirtIo->FreeSharedPages\r
+    VirtioNetInitRx            |  |   VirtioNetUninitRing [SnpSharedHelpers.c]\r
+      VirtIo->AllocateShare... |  |                       {Tx, Rx}\r
+      VirtioMapAllBytesInSh... |  |     VirtIo->UnmapSharedBuffer\r
                                |  |     VirtioRingUninit\r
                                v  |\r
                   +-----------------------------+\r