synchronize the MdePkg/Include/Library/MemoryAllocationLib.h,PalLib.h the MDE_Library...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6660 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/MemoryAllocationLib.h b/MdePkg/Include/Library/MemoryAllocationLib.h
index 17328b3bf5f2a1c68781465bbc694d39ef4a88ec..347e45a24eb6c5b055922b108e8412f21a3c01ef 100644 (file)
--- a/MdePkg/Include/Library/MemoryAllocationLib.h
+++ b/MdePkg/Include/Library/MemoryAllocationLib.h
@@ -1,6 +1,11 @@
 /** @file\r
   Provides services to allocate and free memory buffers of various memory types and alignments.\r
-\r
+  \r
+  The Memory Allocation Library abstracts various common memory allocation operations. This library \r
+  allows code to be written in a phase-independent manner because the allocation of memory in PEI, DXE, \r
+  and SMM (for example) is done via a different mechanism. Using a common library interface makes it \r
+  much easier to port algorithms from phase to phase. \r
+  \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
@@ -79,6 +84,7 @@ AllocateReservedPages (
   Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.  Buffer\r
   must have been allocated on a previous call to the page allocation services of the Memory\r
   Allocation Library.\r
+  \r
   If Buffer was not allocated with a page allocation function in the Memory Allocation Library,\r
   then ASSERT().\r
   If Pages is zero, then ASSERT().\r
@@ -101,6 +107,7 @@ FreePages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -124,6 +131,7 @@ AllocateAlignedPages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -147,6 +155,7 @@ AllocateAlignedRuntimePages (
   alignment specified by Alignment.  The allocated buffer is returned.  If Pages is 0, then NULL is\r
   returned.  If there is not enough memory at the specified alignment remaining to satisfy the\r
   request, then NULL is returned.\r
+  \r
   If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
 \r
   @param  Pages                 The number of 4 KB pages to allocate.\r
@@ -170,6 +179,7 @@ AllocateAlignedReservedPages (
   Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.  Buffer\r
   must have been allocated on a previous call to the aligned page allocation services of the Memory\r
   Allocation Library.\r
+  \r
   If Buffer was not allocated with an aligned page allocation function in the Memory Allocation\r
   Library, then ASSERT().\r
   If Pages is zero, then ASSERT().\r
@@ -222,9 +232,9 @@ AllocateRuntimePool (
   );\r
 \r
 /**\r
-  Allocates a buffer of type EfieservedMemoryType.\r
+  Allocates a buffer of type EfiReservedMemoryType.\r
 \r
-  Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns\r
+  Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType and returns\r
   a pointer to the allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is\r
   returned.  If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
 \r
@@ -303,6 +313,7 @@ AllocateReservedZeroPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -326,6 +337,7 @@ AllocateCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -349,6 +361,7 @@ AllocateRuntimeCopyPool (
   AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
   allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is returned.  If there\r
   is not enough memory remaining to satisfy the request, then NULL is returned.\r
+  \r
   If Buffer is NULL, then ASSERT().\r
   If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
@@ -371,6 +384,7 @@ AllocateReservedCopyPool (
 \r
   Frees the buffer specified by Buffer.  Buffer must have been allocated on a previous call to the\r
   pool allocation services of the Memory Allocation Library.\r
+  \r
   If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
   then ASSERT().\r
 \r

diff --git a/MdePkg/Include/Library/PalLib.h b/MdePkg/Include/Library/PalLib.h
index 33480a171ea2f182135dbe1297c1f44771501fe5..5b9761f57fdba5f9f1b233ed40a85725a8cbe4cf 100644 (file)
--- a/MdePkg/Include/Library/PalLib.h
+++ b/MdePkg/Include/Library/PalLib.h
@@ -1,6 +1,14 @@
 /** @file\r
   Provides library services to make PAL Calls.\r
-\r
+  \r
+  The PAL Library provides a service to make a PAL CALL.  This service is identical\r
+  in functionality to AsmPalCall() in the Itanium specific functions of the Base Library.\r
+  The only difference is that the  PAL Entry Point is not passed in.  Implementations\r
+  of this library class must manage PAL Entry Point on their own.  For example, a PEI\r
+  implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation\r
+  can contain a constructor to look up the PAL Entry Point from a HOB.  This library class \r
+  is only available on IPF.\r
+  \r
 Copyright (c) 2006 -2008, Intel Corporation All rights\r
 reserved. This program and the accompanying materials are\r
 licensed and made available under the terms and conditions of\r

diff --git a/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
index 5df1ce6cfbf67580cad354d461e6742331716196..a94a5508866ca2280adb741c61ecb7801a7dbc1e 100644 (file)
--- a/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c
@@ -382,9 +382,9 @@ AllocateRuntimePool (
 }\r
 \r
 /**\r
-  Allocates a buffer of type EfieservedMemoryType.\r
+  Allocates a buffer of type EfiReservedMemoryType.\r
 \r
-  Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns\r
+  Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType and returns\r
   a pointer to the allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is\r
   returned.  If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
 \r

diff --git a/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
index d4ac3b86e6e2bcc0c5f7e251a69a7b6433eff880..e2aeccd546e0c32b4cd1dae0e5dd67090c6dd841 100644 (file)
--- a/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
+++ b/MdePkg/Library/UefiMemoryAllocationLib/MemoryAllocationLib.c
@@ -414,9 +414,9 @@ AllocateRuntimePool (
 }\r
 \r
 /**\r
-  Allocates a buffer of type EfieservedMemoryType.\r
+  Allocates a buffer of type EfiReservedMemoryType.\r
 \r
-  Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns\r
+  Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType and returns\r
   a pointer to the allocated buffer.  If AllocationSize is 0, then a valid buffer of 0 size is\r
   returned.  If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
 \r