public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Gerd Hoffmann" <kraxel@redhat.com>
To: devel@edk2.groups.io
Cc: "Ard Biesheuvel" <ardb+tianocore@kernel.org>,
	"László Érsek" <lersek@redhat.com>,
	"Jordan Justen" <jordan.l.justen@intel.com>,
	"Pawel Polawski" <ppolawsk@redhat.com>,
	"Oliver Steffen" <osteffen@redhat.com>,
	"Jiewen Yao" <jiewen.yao@intel.com>,
	"Gerd Hoffmann" <kraxel@redhat.com>
Subject: [PATCH 1/2] OvmfPkg/PlatformInitLib: update PlatformScanOrAdd64BitE820Ram documentation
Date: Fri,  6 Jan 2023 15:04:02 +0100	[thread overview]
Message-ID: <20230106140403.2889131-2-kraxel@redhat.com> (raw)
In-Reply-To: <20230106140403.2889131-1-kraxel@redhat.com>

Documentation of PlatformScanOrAdd64BitE820Ram() ran out of sync
with the implementation.  Fix that.

Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
---
 OvmfPkg/Library/PlatformInitLib/MemDetect.c | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/OvmfPkg/Library/PlatformInitLib/MemDetect.c b/OvmfPkg/Library/PlatformInitLib/MemDetect.c
index 0c4956852689..1255d6300fdd 100644
--- a/OvmfPkg/Library/PlatformInitLib/MemDetect.c
+++ b/OvmfPkg/Library/PlatformInitLib/MemDetect.c
@@ -121,15 +121,19 @@ PlatformQemuUc32BaseInitialization (
   Find the highest exclusive >=4GB RAM address, or produce memory resource
   descriptor HOBs for RAM entries that start at or above 4GB.
 
-  @param[out] MaxAddress  If MaxAddress is NULL, then PlatformScanOrAdd64BitE820Ram()
+  @param[in] AddHighHob   If True then PlatformScanOrAdd64BitE820Ram()
                           produces memory resource descriptor HOBs for RAM
                           entries that start at or above 4GB.
+                          It also produces HOBs for reserved entries.
 
-                          Otherwise, MaxAddress holds the highest exclusive
-                          >=4GB RAM address on output. If QEMU's fw_cfg E820
-                          RAM map contains no RAM entry that starts outside of
-                          the 32-bit address range, then MaxAddress is exactly
-                          4GB on output.
+  @param[out] LowMemory  If Lowmemory is not NULL, then Lowmemory MaxAddress
+                         holds the amout of emory below 4G on output.
+
+  @param[out] MaxAddress  If MaxAddress is not NULL, then MaxAddress holds
+                          the highest exclusive >=4GB RAM address on output.
+                          If QEMU's fw_cfg E820 RAM map contains no RAM entry
+                          that starts outside of the 32-bit address range,
+                          then MaxAddress is exactly 4GB on output.
 
   @retval EFI_SUCCESS         The fw_cfg E820 RAM map was found and processed.
 
-- 
2.39.0


  reply	other threads:[~2023-01-06 14:04 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-06 14:04 [PATCH 0/2] OvmfPkg: check 64bit mmio window for resource conflicts Gerd Hoffmann
2023-01-06 14:04 ` Gerd Hoffmann [this message]
2023-01-09  8:07   ` [edk2-devel] [PATCH 1/2] OvmfPkg/PlatformInitLib: update PlatformScanOrAdd64BitE820Ram documentation Laszlo Ersek
2023-01-09 10:15     ` Gerd Hoffmann
2023-01-09 11:30       ` Laszlo Ersek
2023-01-06 14:04 ` [PATCH 2/2] OvmfPkg/PlatformInitLib: check 64bit mmio window for resource conflicts Gerd Hoffmann
2023-01-06 20:39   ` [edk2-devel] " Pedro Falcato
2023-01-09  7:02     ` Gerd Hoffmann
2023-01-06 14:14 ` [PATCH 0/2] OvmfPkg: " Ard Biesheuvel
2023-01-06 15:32   ` Gerd Hoffmann
2023-01-06 15:39     ` Yao, Jiewen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230106140403.2889131-2-kraxel@redhat.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox