Support routines for memory allocation routines \r
based on PeiService for PEI phase drivers.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials \r
+ Copyright (c) 2006 - 2010, 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
- http://opensource.org/licenses/bsd-license.php \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
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. If it is not possible to free allocated pages, then this function will\r
- peform no actions.\r
+ perform no actions.\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 Buffer The pointer to the buffer of pages to free.\r
@param Pages The number of 4 KB pages to free.\r
\r
**/\r
\r
@param MemoryType The type of memory to allocate.\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
+ @param Alignment The requested alignment of the allocation. \r
+ 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
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
+ @param Alignment The requested alignment of the allocation. \r
+ 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
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
+ @param Alignment The requested alignment of the allocation. \r
+ 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
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
+ @param Alignment The requested alignment of the allocation. \r
+ 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
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. If it is not possible to free allocated pages, then this function will \r
- peform no actions.\r
+ perform no actions.\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 Buffer The pointer to the buffer of pages to free.\r
@param Pages The number of 4 KB pages to free.\r
\r
**/\r
}\r
\r
/**\r
- Allocates and zeros a buffer of a certian pool type.\r
+ Allocates and zeros a buffer of a certain pool type.\r
\r
- Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type, clears the buffer\r
with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid\r
buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,\r
then NULL is returned.\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of a certian pool type.\r
+ Copies a buffer to an allocated buffer of a certain pool type.\r
\r
- Allocates the number bytes specified by AllocationSize of a certian pool type, copies\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type, 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
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 the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().\r
\r
@param PoolType The type of pool to allocate.\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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an \r
+ optional parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
\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 the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 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
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 the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 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
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 the smaller of NewSize and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1),\r
- then ASSERT(). \r
+ If the allocation of the new buffer is successful and the smaller of NewSize and OldSize\r
+ is greater than (MAX_ADDRESS - OldBuffer + 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
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an \r
+ optional parameter that may be NULL.\r
\r
@return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
\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. If it is not possible to free pool\r
- resources, then this function will peform no actions.\r
+ resources, then this function will perform no actions.\r
\r
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ @param Buffer The pointer to the buffer to free.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff