/** @file\r
- Memory Allocation Library Services\r
-\r
- Copyright (c) 2006, 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
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
- Module Name: MemoryAllocationLib.h\r
+ Provides services to allocate and free memory buffers of various memory types and alignments.\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
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#define __MEMORY_ALLOCATION_LIB_H__\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData.\r
+ Allocates one or more 4KB pages of type EfiBootServicesData.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @return\r
- A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.\r
- If Pages is 0, then NULL is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocatePages (\r
IN UINTN Pages\r
- )\r
-;\r
+ );\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData. \r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData.\r
+\r
+ Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ @param Pages The number of 4 KB pages to allocate.\r
\r
- @return\r
- A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.\r
- If Pages is 0, then NULL is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateRuntimePages (\r
IN UINTN Pages\r
- )\r
-;\r
+ );\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType. \r
+ Allocates one or more 4KB pages of type EfiReservedMemoryType.\r
+\r
+ Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ @param Pages The number of 4 KB pages to allocate.\r
\r
- @return\r
- A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.\r
- If Pages is 0, then NULL is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateReservedPages (\r
IN UINTN Pages\r
- )\r
-;\r
+ );\r
\r
/**\r
- Frees one or more 4KB pages that were previously allocated with \r
- one of the page allocation functions in the Memory Allocation Library.\r
-\r
- @param Buffer Pointer to the buffer of pages to free.\r
- @param Pages The number of 4 KB pages to free.\r
-\r
- None.\r
+ Frees one or more 4KB pages that were previously allocated with one of the page allocation\r
+ functions in the Memory Allocation Library.\r
+\r
+ 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
+ \r
+ @param Buffer Pointer to the buffer of pages to free.\r
+ @param Pages The number of 4 KB pages to free.\r
\r
**/\r
VOID\r
FreePages (\r
IN VOID *Buffer,\r
IN UINTN Pages\r
- )\r
-;\r
+ );\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an alignment specified by Alignment. \r
+ Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.\r
+\r
+ Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an\r
+ 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
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
\r
- @return\r
- The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateAlignedPages (\r
IN UINTN Pages,\r
IN UINTN Alignment\r
- )\r
-;\r
+ );\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an alignment specified by Alignment. \r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an\r
+ 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
- @return\r
- The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateAlignedRuntimePages (\r
IN UINTN Pages,\r
IN UINTN Alignment\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an\r
+ 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
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
\r
- @return\r
- The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateAlignedReservedPages (\r
IN UINTN Pages,\r
IN UINTN Alignment\r
- )\r
-;\r
+ );\r
\r
/**\r
- Frees one or more 4KB pages that were previously allocated with \r
- one of the aligned page allocation functions in the Memory Allocation Library.\r
-\r
- @param Buffer Pointer to the buffer of pages to free.\r
- @param Pages The number of 4 KB pages to free.\r
-\r
- None.\r
+ Frees one or more 4KB pages that were previously allocated with one of the aligned page\r
+ allocation functions in the Memory Allocation Library.\r
+\r
+ 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
+ \r
+ @param Buffer Pointer to the buffer of pages to free.\r
+ @param Pages The number of 4 KB pages to free.\r
\r
**/\r
VOID\r
FreeAlignedPages (\r
IN VOID *Buffer,\r
IN UINTN Pages\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates a buffer of type EfiBootServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a\r
+ 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
+ @param AllocationSize The number of bytes to allocate.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocatePool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates a buffer of type EfiRuntimeServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData 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
+ @param AllocationSize The number of bytes to allocate.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateRuntimePool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates a buffer of type EfiReservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate.\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
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateReservedPool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates and zeros a buffer of type EfiBootServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
+\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateZeroPool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates and zeros a buffer of type EfiRuntimeServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
+\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateRuntimeZeroPool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
Allocates and zeros a buffer of type EfiReservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
AllocateReservedZeroPool (\r
IN UINTN AllocationSize\r
- )\r
-;\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiBootServicesData. \r
+ Copies a buffer to an allocated buffer of type EfiBootServicesData.\r
+\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies\r
+ 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
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateCopyPool (\r
IN UINTN AllocationSize,\r
IN CONST VOID *Buffer\r
- )\r
-;\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiRuntimeServicesData. \r
+ Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.\r
+\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies\r
+ 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
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateRuntimeCopyPool (\r
IN UINTN AllocationSize,\r
IN CONST VOID *Buffer\r
- )\r
-;\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiReservedMemoryType. \r
+ Copies a buffer to an allocated buffer of type EfiReservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies\r
+ 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
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
AllocateReservedCopyPool (\r
IN UINTN AllocationSize,\r
IN CONST VOID *Buffer\r
- )\r
-;\r
-\r
-/**\r
- Frees a buffer that was previously allocated with one of the pool allocation functions \r
- in the Memory Allocation Library.\r
-\r
- @param Buffer Pointer to the buffer to free.\r
-\r
- None.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-FreePool (\r
- IN VOID *Buffer\r
- )\r
-;\r
-\r
-/**\r
- Allocates a buffer of type EfiBootServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedPool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
-\r
-/**\r
- Allocates a buffer of type EfiRuntimeServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedRuntimePool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
-\r
-/**\r
- Allocates a buffer of type EfiReservedMemoryType at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedReservedPool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
-\r
-/**\r
- Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedZeroPool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
-\r
-/**\r
- Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedRuntimeZeroPool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
-\r
-/**\r
- Allocates and zeros a buffer of type EfiReservedMemoryType at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-AllocateAlignedReservedZeroPool (\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- )\r
-;\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ Reallocates a buffer of type EfiBootServicesData.\r
+\r
+ Allocates and zeros the number bytes specified by NewSize from memory of type\r
+ EfiBootServicesData. If OldBuffer is not NULL, then the smaller of OldSize and \r
+ NewSize bytes are copied from OldBuffer to the newly allocated buffer, and \r
+ OldBuffer is freed. A pointer to the newly allocated buffer is returned. \r
+ If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
+ enough memory remaining to satisfy the request, then NULL is returned.\r
+ \r
+ If OldBuffer is NULL, then ASSERT().\r
+ If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\r
+ @param OldSize The size, in bytes, of OldBuffer.\r
+ @param NewSize The size, in bytes, of the buffer to reallocate.\r
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional \r
+ parameter that may be NULL.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
-AllocateAlignedCopyPool (\r
- IN UINTN AllocationSize,\r
- IN CONST VOID *Buffer,\r
- IN UINTN Alignment\r
- )\r
-;\r
+ReallocatePool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ Reallocates a buffer of type EfiRuntimeServicesData.\r
+\r
+ Allocates and zeros the number bytes specified by NewSize from memory of type\r
+ EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and \r
+ NewSize bytes are copied from OldBuffer to the newly allocated buffer, and \r
+ OldBuffer is freed. A pointer to the newly allocated buffer is returned. \r
+ If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
+ enough memory remaining to satisfy the request, then NULL is returned.\r
+ \r
+ If OldBuffer is NULL, then ASSERT().\r
+ If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\r
+ @param OldSize The size, in bytes, of OldBuffer.\r
+ @param NewSize The size, in bytes, of the buffer to reallocate.\r
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional \r
+ parameter that may be NULL.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
-AllocateAlignedRuntimeCopyPool (\r
- IN UINTN AllocationSize,\r
- IN CONST VOID *Buffer,\r
- IN UINTN Alignment\r
- )\r
-;\r
+ReallocateRuntimePool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ );\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.\r
-\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
-\r
- @return\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ Reallocates a buffer of type EfiReservedMemoryType.\r
+\r
+ Allocates and zeros the number bytes specified by NewSize from memory of type\r
+ EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize and \r
+ NewSize bytes are copied from OldBuffer to the newly allocated buffer, and \r
+ OldBuffer is freed. A pointer to the newly allocated buffer is returned. \r
+ If NewSize is 0, then a valid buffer of 0 size is returned. If there is not \r
+ enough memory remaining to satisfy the request, then NULL is returned.\r
+ \r
+ If OldBuffer is NULL, then ASSERT().\r
+ If NewSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If OldSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+\r
+ @param OldSize The size, in bytes, of OldBuffer.\r
+ @param NewSize The size, in bytes, of the buffer to reallocate.\r
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an optional \r
+ parameter that may be NULL.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
EFIAPI\r
-AllocateAlignedReservedCopyPool (\r
- IN UINTN AllocationSize,\r
- IN CONST VOID *Buffer,\r
- IN UINTN Alignment\r
- )\r
-;\r
+ReallocateReservedPool (\r
+ IN UINTN OldSize,\r
+ IN UINTN NewSize,\r
+ IN VOID *OldBuffer OPTIONAL\r
+ );\r
\r
/**\r
- Frees a buffer that was previously allocated with one of the aligned pool allocation functions \r
- in the Memory Allocation Library.\r
+ Frees a buffer that was previously allocated with one of the pool allocation functions in the\r
+ Memory Allocation Library.\r
\r
- @param Buffer Pointer to the buffer to free.\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
- None.\r
+ @param Buffer Pointer to the buffer to free.\r
\r
**/\r
VOID\r
EFIAPI\r
-FreeAlignedPool (\r
+FreePool (\r
IN VOID *Buffer\r
- )\r
-;\r
+ );\r
\r
#endif\r