MdeModulePkg DxeCore: Minor comments update to AllocatePool()

Follow UEFI 2.6 spec to minor update the comments of AllocatePool().

Cc: Liming Gao <liming.gao@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/MdeModulePkg/Core/Dxe/Mem/Imem.h b/MdeModulePkg/Core/Dxe/Mem/Imem.h
index a76ae2fe67acf8deae42bee5739453ee6863d18a..6f4065e3b89b4ba2da7464f8929fd0de827a7489 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Mem/Imem.h
+++ b/MdeModulePkg/Core/Dxe/Mem/Imem.h
@@ -1,7 +1,7 @@
 /** @file\r
   Data structure and functions to allocate and free memory space.\r
 \r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 // +---------------------------------------------------+\r
 // | 0..(EfiMaxMemoryType - 1)    - Normal memory type |\r
 // +---------------------------------------------------+\r
-// | EfiMaxMemoryType..0x6FFFFFFF - Ilegal             |\r
+// | EfiMaxMemoryType..0x6FFFFFFF - Invalid            |\r
 // +---------------------------------------------------+\r
 // | 0x70000000..0x7FFFFFFF       - OEM reserved       |\r
 // +---------------------------------------------------+\r

diff --git a/MdeModulePkg/Core/Dxe/Mem/Pool.c b/MdeModulePkg/Core/Dxe/Mem/Pool.c
index ad9a85feaf6a59078eae5c1975983bced98b2681..528c8e8ce9a52326d0db5e1d6dd718e158b13475 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Mem/Pool.c
+++ b/MdeModulePkg/Core/Dxe/Mem/Pool.c
@@ -197,8 +197,9 @@ LookupPoolHead (
   @param  Buffer                 The address to return a pointer to the allocated\r
                                  pool\r
 \r
-  @retval EFI_INVALID_PARAMETER  PoolType not valid or Buffer is NULL. \r
-                                 PoolType was EfiPersistentMemory.\r
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.\r
+                                 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.\r
+                                 PoolType is EfiPersistentMemory.\r
   @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
   @retval EFI_SUCCESS            Pool successfully allocated.\r
 \r
@@ -256,7 +257,9 @@ CoreInternalAllocatePool (
   @param  Buffer                 The address to return a pointer to the allocated\r
                                  pool\r
 \r
-  @retval EFI_INVALID_PARAMETER  PoolType not valid or Buffer is NULL. \r
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.\r
+                                 PoolType is in the range EfiMaxMemoryType..0x6FFFFFFF.\r
+                                 PoolType is EfiPersistentMemory.\r
   @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
   @retval EFI_SUCCESS            Pool successfully allocated.\r
 \r