[edk2-devel] [PATCH 1/2] OvmfPkg/PlatformInitLib: update PlatformScanOrAdd64BitE820Ram documentation

[Gerd Hoffmann]

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

Signed-off-by: Gerd Hoffmann <kraxel at 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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#98124): https://edk2.groups.io/g/devel/message/98124
Mute This Topic: https://groups.io/mt/96093485/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-