Update MemoryAllocationLib AllocateAlignedPages API comments for memory overflow ASSERT case.

Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15034 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 10 insertions, 2 deletions

diff --git a/MdeModulePkg/Library/DxeCoreMemoryAllocationLib/MemoryAllocationLib.c b/MdeModulePkg/Library/DxeCoreMemoryAllocationLib/MemoryAllocationLib.c
index 97e065aee7..bbb755fa2f 100644
--- a/MdeModulePkg/Library/DxeCoreMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdeModulePkg/Library/DxeCoreMemoryAllocationLib/MemoryAllocationLib.c
@@ -2,7 +2,7 @@
   Support routines for memory allocation routines based 

   on boot services for Dxe phase drivers.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -160,6 +160,7 @@ FreePages (
   If there is not enough memory at the specified alignment remaining to satisfy the request, then

   NULL is returned.

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  MemoryType            The type of memory to allocate.

   @param  Pages                 The number of 4 KB pages to allocate.

@@ -246,6 +247,7 @@ InternalAllocateAlignedPages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.

@@ -273,6 +275,7 @@ AllocateAlignedPages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.

@@ -300,6 +303,7 @@ AllocateAlignedRuntimePages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.

diff --git a/MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/MemoryAllocationLib.c b/MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/MemoryAllocationLib.c
index 7435844fb9..a6372ed752 100644
--- a/MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/MemoryAllocationLib.c
@@ -1,7 +1,7 @@
 /** @file

   Support routines for memory allocation routines based on SMM Core internal functions.

 

-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -251,6 +251,7 @@ FreePages (
   If there is not enough memory at the specified alignment remaining to satisfy the request, then

   NULL is returned.

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  MemoryType            The type of memory to allocate.

   @param  Pages                 The number of 4 KB pages to allocate.

@@ -337,6 +338,7 @@ InternalAllocateAlignedPages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.

@@ -364,6 +366,7 @@ AllocateAlignedPages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.

@@ -391,6 +394,7 @@ AllocateAlignedRuntimePages (
   request, then NULL is returned.

   

   If Alignment is not a power of two and Alignment is not zero, then ASSERT().

+  If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

 

   @param  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  Must be a power of two.