From 53b55831e01f2050dbd9fd110758b7e5d96d0ae4 Mon Sep 17 00:00:00 2001
From: Laszlo Ersek <lersek@redhat.com>
Date: Fri, 15 Sep 2017 10:14:53 +0200
Subject: [PATCH] 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>
---
 OvmfPkg/VirtioNetDxe/TechNotes.txt | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

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