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@15033 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 18 insertions, 3 deletions

diff --git a/MdePkg/Include/Library/MemoryAllocationLib.h b/MdePkg/Include/Library/MemoryAllocationLib.h
index b5384498ef..0df59e60a3 100644
--- a/MdePkg/Include/Library/MemoryAllocationLib.h
+++ b/MdePkg/Include/Library/MemoryAllocationLib.h
@@ -6,7 +6,7 @@
   and SMM (for example) is done via a different mechanism. Using a common library interface makes it 

   much easier to port algorithms from phase to phase. 

   

-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

@@ -110,6 +110,7 @@ FreePages (
   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.

@@ -134,6 +135,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.

@@ -158,6 +160,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/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
index 90d4bbfd49..e325908aad 100644
--- a/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
@@ -189,6 +189,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.

@@ -242,6 +243,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.  

@@ -270,6 +272,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.  

@@ -298,6 +301,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.  

diff --git a/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c
index d68c1a1b65..49d7a57a02 100644
--- a/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c
@@ -11,7 +11,7 @@
   In addition, allocation for the Reserved memory types are not supported and 

   will always return NULL.

 

-  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        

@@ -285,6 +285,7 @@ FreePages (
   If Pages is 0, then NULL is returned. 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.

@@ -372,6 +373,7 @@ InternalAllocateAlignedPages (
   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  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  

@@ -400,6 +402,7 @@ AllocateAlignedPages (
   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  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  

@@ -428,6 +431,7 @@ AllocateAlignedRuntimePages (
   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  Pages                 The number of 4 KB pages to allocate.

   @param  Alignment             The requested alignment of the allocation.  

diff --git a/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
index 0ccb524496..f1eaccc8dc 100644
--- a/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
@@ -2,7 +2,7 @@
   Support routines for memory allocation routines based 

   on boot services for Dxe phase drivers.

 

-  Copyright (c) 2006 - 2009, 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.