Adjust coding style for MemoryAllocationLib.

Add function header for an internal function of PciExpressLib
Fix a typo in one comment of UefiLib
Remove BaseSmbusLib

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1075 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2006-07-23 12:55:05 +00:00
parent 49cff29c80
commit 1f33a17ff1
7 changed files with 994 additions and 599 deletions

View File

@ -18,67 +18,75 @@
#define __MEMORY_ALLOCATION_LIB_H__ #define __MEMORY_ALLOCATION_LIB_H__
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData. Allocates one or more 4KB pages of type EfiBootServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return @param Pages The number of 4 KB pages to allocate.
A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
If Pages is 0, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocatePages ( AllocatePages (
IN UINTN Pages IN UINTN Pages
) );
;
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData. Allocates one or more 4KB pages of type EfiRuntimeServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return @param Pages The number of 4 KB pages to allocate.
A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
If Pages is 0, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateRuntimePages ( AllocateRuntimePages (
IN UINTN Pages IN UINTN Pages
) );
;
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType. Allocates one or more 4KB pages of type EfiReservedMemoryType.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return @param Pages The number of 4 KB pages to allocate.
A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
If Pages is 0, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateReservedPages ( AllocateReservedPages (
IN UINTN Pages IN UINTN Pages
) );
;
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the page allocation
one of the page allocation functions in the Memory Allocation Library. functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the page allocation services of the Memory
Allocation Library.
None. If Buffer was not allocated with a page allocation function in the Memory Allocation Library,
then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -86,19 +94,22 @@ EFIAPI
FreePages ( FreePages (
IN VOID *Buffer, IN VOID *Buffer,
IN UINTN Pages IN UINTN Pages
) );
;
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an alignment specified by Alignment. Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return @param Pages The number of 4 KB pages to allocate.
The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -106,19 +117,22 @@ EFIAPI
AllocateAlignedPages ( AllocateAlignedPages (
IN UINTN Pages, IN UINTN Pages,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an alignment specified by Alignment. Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return @param Pages The number of 4 KB pages to allocate.
The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -126,19 +140,22 @@ EFIAPI
AllocateAlignedRuntimePages ( AllocateAlignedRuntimePages (
IN UINTN Pages, IN UINTN Pages,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment. Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return @param Pages The number of 4 KB pages to allocate.
The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -146,17 +163,21 @@ EFIAPI
AllocateAlignedReservedPages ( AllocateAlignedReservedPages (
IN UINTN Pages, IN UINTN Pages,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the aligned page
one of the aligned page allocation functions in the Memory Allocation Library. allocation functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the aligned page allocation services of the Memory
Allocation Library.
None. If Buffer was not allocated with an aligned page allocation function in the Memory Allocation
Library, then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -164,120 +185,133 @@ EFIAPI
FreeAlignedPages ( FreeAlignedPages (
IN VOID *Buffer, IN VOID *Buffer,
IN UINTN Pages IN UINTN Pages
) );
;
/** /**
Allocates a buffer of type EfiBootServicesData. Allocates a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a
pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocatePool ( AllocatePool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Allocates a buffer of type EfiRuntimeServicesData. Allocates a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateRuntimePool ( AllocateRuntimePool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Allocates a buffer of type EfiReservedMemoryType. Allocates a buffer of type EfieservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateReservedPool ( AllocateReservedPool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Allocates and zeros a buffer of type EfiBootServicesData. Allocates and zeros a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateZeroPool ( AllocateZeroPool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData. Allocates and zeros a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateRuntimeZeroPool ( AllocateRuntimeZeroPool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType. Allocates and zeros a buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
EFIAPI EFIAPI
AllocateReservedZeroPool ( AllocateReservedZeroPool (
IN UINTN AllocationSize IN UINTN AllocationSize
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData. Copies a buffer to an allocated buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -285,18 +319,22 @@ EFIAPI
AllocateCopyPool ( AllocateCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer IN CONST VOID *Buffer
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -304,18 +342,22 @@ EFIAPI
AllocateRuntimeCopyPool ( AllocateRuntimeCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer IN CONST VOID *Buffer
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType. Copies a buffer to an allocated buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return @param AllocationSize The number of bytes to allocate and zero.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -323,35 +365,40 @@ EFIAPI
AllocateReservedCopyPool ( AllocateReservedCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer IN CONST VOID *Buffer
) );
;
/** /**
Frees a buffer that was previously allocated with one of the pool allocation functions Frees a buffer that was previously allocated with one of the pool allocation functions in the
in the Memory Allocation Library. Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
then ASSERT().
None. @param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID
EFIAPI EFIAPI
FreePool ( FreePool (
IN VOID *Buffer IN VOID *Buffer
) );
;
/** /**
Allocates a buffer of type EfiBootServicesData at a specified alignment. Allocates a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -359,19 +406,22 @@ EFIAPI
AllocateAlignedPool ( AllocateAlignedPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -379,19 +429,22 @@ EFIAPI
AllocateAlignedRuntimePool ( AllocateAlignedRuntimePool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates a buffer of type EfiReservedMemoryType at a specified alignment. Allocates a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -399,19 +452,23 @@ EFIAPI
AllocateAlignedReservedPool ( AllocateAlignedReservedPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment. Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -419,19 +476,23 @@ EFIAPI
AllocateAlignedZeroPool ( AllocateAlignedZeroPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -439,19 +500,23 @@ EFIAPI
AllocateAlignedRuntimeZeroPool ( AllocateAlignedRuntimeZeroPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType at a specified alignment. Allocates and zeros a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -459,20 +524,23 @@ EFIAPI
AllocateAlignedReservedZeroPool ( AllocateAlignedReservedZeroPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -481,20 +549,23 @@ AllocateAlignedCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer, IN CONST VOID *Buffer,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -503,20 +574,23 @@ AllocateAlignedRuntimeCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer, IN CONST VOID *Buffer,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment. Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return @param AllocationSize The number of bytes to allocate.
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param Buffer The buffer to copy to the allocated buffer.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -525,23 +599,24 @@ AllocateAlignedReservedCopyPool (
IN UINTN AllocationSize, IN UINTN AllocationSize,
IN CONST VOID *Buffer, IN CONST VOID *Buffer,
IN UINTN Alignment IN UINTN Alignment
) );
;
/** /**
Frees a buffer that was previously allocated with one of the aligned pool allocation functions Frees a buffer that was previously allocated with one of the aligned pool allocation functions
in the Memory Allocation Library. in the Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
aligned pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with an aligned pool allocation function in the Memory Allocation
Library, then ASSERT().
None. @param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID
EFIAPI EFIAPI
FreeAlignedPool ( FreeAlignedPool (
IN VOID *Buffer IN VOID *Buffer
) );
;
#endif #endif

View File

@ -31,8 +31,16 @@
ASSERT (((A) & ~0xfffffff) == 0) ASSERT (((A) & ~0xfffffff) == 0)
/**
Gets the base address of PCI Express.
This internal functions retrieves PCI Express Base Address via a PCD entry
PcdPciExpressBaseAddress.
@return The base address of PCI Express.
**/
UINTN UINTN
EFIAPI
GetPciExpressBaseAddress ( GetPciExpressBaseAddress (
VOID VOID
) )

View File

@ -15,17 +15,18 @@
**/ **/
/** /**
Allocates the number of 4KB pages specified by Pages of a certain memory type. Allocates one or more 4KB pages of a certain memory type.
@param MemoryType The type of memory to allocate. Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated
@param Pages The number of 4 KB pages to allocate. buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR>
If Pages is 0, then NULL is returned.<BR>
If there is not enough memory remaining to satisfy the request, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
InternalAllocatePages ( InternalAllocatePages (
@ -48,13 +49,16 @@ InternalAllocatePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData. Allocates one or more 4KB pages of type EfiBootServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR> @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.<BR>
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -67,13 +71,16 @@ AllocatePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData. Allocates one or more 4KB pages of type EfiRuntimeServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR> @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.<BR>
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -86,13 +93,16 @@ AllocateRuntimePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType. Allocates one or more 4KB pages of type EfiReservedMemoryType.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR> @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.<BR>
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -105,11 +115,18 @@ AllocateReservedPages (
} }
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the page allocation
one of the page allocation functions in the Memory Allocation Library. functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the page allocation services of the Memory
Allocation Library.
If Buffer was not allocated with a page allocation function in the Memory Allocation Library,
then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -127,17 +144,20 @@ FreePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of a certian memory type Allocates one or more 4KB pages of a certain memory type at a specified alignment.
with an alignment specified by Alignment.
@param MemoryType The type of memory to allocate. Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment
@param Pages The number of 4 KB pages to allocate. specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned.
@param Alignment The requested alignment of the allocation. Must be a power of two. If there is not enough memory at the specified alignment remaining to satisfy the request, then
If Alignment is zero, then byte alignment is used. NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@return The allocated buffer is returned.<BR> @param MemoryType The type of memory to allocate.
If Pages is 0, then NULL is returned.<BR> @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -209,16 +229,19 @@ InternalAllocateAlignedPages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.
with an alignment specified by Alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned.<BR> @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.<BR> @param Alignment The requested alignment of the allocation. Must be a power of two.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -232,15 +255,19 @@ AllocateAlignedPages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.
with an alignment specified by Alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -256,12 +283,17 @@ AllocateAlignedRuntimePages (
/** /**
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment. Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -275,11 +307,18 @@ AllocateAlignedReservedPages (
} }
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the aligned page
one of the aligned page allocation functions in the Memory Allocation Library. allocation functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the aligned page allocation services of the Memory
Allocation Library.
If Buffer was not allocated with an aligned page allocation function in the Memory Allocation
Library, then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -297,13 +336,16 @@ FreeAlignedPages (
} }
/** /**
Allocates a buffer of a certain memory type. Allocates a buffer of a certain pool type.
@param MemoryType The type of memory to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type and returns a
@param AllocationSize The number of bytes to allocate. pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param MemoryType The type of memory to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -325,10 +367,13 @@ InternalAllocatePool (
/** /**
Allocates a buffer of type EfiBootServicesData. Allocates a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a
pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -343,10 +388,13 @@ AllocatePool (
/** /**
Allocates a buffer of type EfiRuntimeServicesData. Allocates a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -359,12 +407,15 @@ AllocateRuntimePool (
} }
/** /**
Allocates a buffer of type EfiReservedMemoryType. Allocates a buffer of type EfieservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -379,11 +430,15 @@ AllocateReservedPool (
/** /**
Allocates and zeros a buffer of a certian pool type. Allocates and zeros a buffer of a certian pool type.
@param PoolType The type of memory to allocate. Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer
@param AllocationSize The number of bytes to allocate and zero. with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid
buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,
then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of memory to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate and zero.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -393,6 +448,7 @@ InternalAllocateZeroPool (
) )
{ {
VOID *Memory; VOID *Memory;
Memory = InternalAllocatePool (PoolType, AllocationSize); Memory = InternalAllocatePool (PoolType, AllocationSize);
if (Memory != NULL) { if (Memory != NULL) {
Memory = ZeroMem (Memory, AllocationSize); Memory = ZeroMem (Memory, AllocationSize);
@ -403,10 +459,14 @@ InternalAllocateZeroPool (
/** /**
Allocates and zeros a buffer of type EfiBootServicesData. Allocates and zeros a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -421,10 +481,14 @@ AllocateZeroPool (
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData. Allocates and zeros a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -439,10 +503,14 @@ AllocateRuntimeZeroPool (
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType. Allocates and zeros a buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -455,14 +523,20 @@ AllocateReservedZeroPool (
} }
/** /**
Copies a buffer to an allocated buffer of a certian memory type. Copies a buffer to an allocated buffer of a certian pool type.
@param MemoryType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certian pool type, copies
@param AllocationSize The number of bytes to allocate and zero. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
@param Buffer The buffer to copy to the allocated buffer. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate and zero.
@param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -485,13 +559,19 @@ InternalAllocateCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData. Copies a buffer to an allocated buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -505,13 +585,19 @@ AllocateCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -525,13 +611,19 @@ AllocateRuntimeCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType. Copies a buffer to an allocated buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -545,9 +637,15 @@ AllocateReservedCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment. Frees a buffer that was previously allocated with one of the pool allocation functions in the
Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
then ASSERT().
@param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID
@ -565,12 +663,18 @@ FreePool (
/** /**
Allocates a buffer of a certain pool type at a specified alignment. Allocates a buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used. buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -624,11 +728,17 @@ InternalAllocateAlignedPool (
/** /**
Allocates a buffer of type EfiBootServicesData at a specified alignment. Allocates a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -644,12 +754,17 @@ AllocateAlignedPool (
/** /**
Allocates a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -663,14 +778,19 @@ AllocateAlignedRuntimePool (
} }
/** /**
Allocates a buffer of type EfiReservedMemoryType at a specified alignment. Allocates a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -684,15 +804,20 @@ AllocateAlignedReservedPool (
} }
/** /**
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment. Allocates and zeros a buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment, clears the buffer with zeros, and returns a pointer to the allocated
@param Alignment The requested alignment of the allocation. Must be a power of two. buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -713,12 +838,18 @@ InternalAllocateAlignedZeroPool (
/** /**
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment. Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -734,12 +865,18 @@ AllocateAlignedZeroPool (
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -753,14 +890,20 @@ AllocateAlignedRuntimeZeroPool (
} }
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType at a specified alignment. Allocates and zeros a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -774,16 +917,21 @@ AllocateAlignedReservedZeroPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment. Copies a buffer to an allocated buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid
@param Buffer The buffer to copy to the allocated buffer. buffer of 0 size is returned. If there is not enough memory at the specified alignment remaining
@param Alignment The requested alignment of the allocation. Must be a power of two. to satisfy the request, then NULL is returned.
If Alignment is zero, then byte alignment is used. If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -809,13 +957,18 @@ InternalAllocateAlignedCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -832,13 +985,18 @@ AllocateAlignedCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -855,13 +1013,18 @@ AllocateAlignedRuntimeCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment. Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -879,7 +1042,12 @@ AllocateAlignedReservedCopyPool (
Frees a buffer that was previously allocated with one of the aligned pool allocation functions Frees a buffer that was previously allocated with one of the aligned pool allocation functions
in the Memory Allocation Library. in the Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
aligned pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with an aligned pool allocation function in the Memory Allocation
Library, then ASSERT().
@param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID

View File

@ -15,17 +15,18 @@
**/ **/
/** /**
Allocates the number of 4KB pages specified by Pages of a certain memory type. Allocates one or more 4KB pages of a certain memory type.
@param MemoryType The type of memory to allocate. Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated
@param Pages The number of 4 KB pages to allocate. buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
If Pages is 0, then NULL is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
InternalAllocatePages ( InternalAllocatePages (
@ -50,13 +51,16 @@ InternalAllocatePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData. Allocates one or more 4KB pages of type EfiBootServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -69,13 +73,16 @@ AllocatePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData. Allocates one or more 4KB pages of type EfiRuntimeServicesData.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -88,13 +95,16 @@ AllocateRuntimePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType. Allocates one or more 4KB pages of type EfiReservedMemoryType.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the
allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
is returned. If there is not enough memory remaining to satisfy the request, then NULL is
returned.
@return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. @param Pages The number of 4 KB pages to allocate.
If Pages is 0, then NULL is returned.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -107,11 +117,18 @@ AllocateReservedPages (
} }
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the page allocation
one of the page allocation functions in the Memory Allocation Library. functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the page allocation services of the Memory
Allocation Library.
If Buffer was not allocated with a page allocation function in the Memory Allocation Library,
then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -127,16 +144,20 @@ FreePages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of a certian memory type Allocates one or more 4KB pages of a certain memory type at a specified alignment.
with an alignment specified by Alignment.
@param MemoryType The type of memory to allocate. Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment
@param Pages The number of 4 KB pages to allocate. specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned.
@param Alignment The requested alignment of the allocation. Must be a power of two. If there is not enough memory at the specified alignment remaining to satisfy the request, then
If Alignment is zero, then byte alignment is used. NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param MemoryType The type of memory to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -174,15 +195,19 @@ InternalAllocateAlignedPages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.
with an alignment specified by Alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -196,15 +221,19 @@ AllocateAlignedPages (
} }
/** /**
Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.
with an alignment specified by Alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -220,12 +249,17 @@ AllocateAlignedRuntimePages (
/** /**
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment. Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.
@param Pages The number of 4 KB pages to allocate. Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
If Alignment is zero, then byte alignment is used. 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().
@return The allocated buffer is returned. If Pages is 0, then NULL is returned. @param Pages The number of 4 KB pages to allocate.
If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -239,11 +273,18 @@ AllocateAlignedReservedPages (
} }
/** /**
Frees one or more 4KB pages that were previously allocated with Frees one or more 4KB pages that were previously allocated with one of the aligned page
one of the aligned page allocation functions in the Memory Allocation Library. allocation functions in the Memory Allocation Library.
@param Buffer Pointer to the buffer of pages to free. Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
@param Pages The number of 4 KB pages to free. must have been allocated on a previous call to the aligned page allocation services of the Memory
Allocation Library.
If Buffer was not allocated with an aligned page allocation function in the Memory Allocation
Library, then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer Pointer to the buffer of pages to free.
@param Pages The number of 4 KB pages to free.
**/ **/
VOID VOID
@ -259,13 +300,16 @@ FreeAlignedPages (
} }
/** /**
Allocates a buffer of a certain memory type. Allocates a buffer of a certain pool type.
@param MemoryType The type of memory to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type and returns a
@param AllocationSize The number of bytes to allocate. pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param MemoryType The type of memory to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -285,10 +329,13 @@ InternalAllocatePool (
/** /**
Allocates a buffer of type EfiBootServicesData. Allocates a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a
pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -313,10 +360,13 @@ AllocatePool (
/** /**
Allocates a buffer of type EfiRuntimeServicesData. Allocates a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -329,12 +379,15 @@ AllocateRuntimePool (
} }
/** /**
Allocates a buffer of type EfiReservedMemoryType. Allocates a buffer of type EfieservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns
a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -349,11 +402,15 @@ AllocateReservedPool (
/** /**
Allocates and zeros a buffer of a certian pool type. Allocates and zeros a buffer of a certian pool type.
@param PoolType The type of memory to allocate. Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer
@param AllocationSize The number of bytes to allocate and zero. with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid
buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,
then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of memory to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate and zero.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -374,10 +431,14 @@ InternalAllocateZeroPool (
/** /**
Allocates and zeros a buffer of type EfiBootServicesData. Allocates and zeros a buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -398,10 +459,14 @@ AllocateZeroPool (
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData. Allocates and zeros a buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -416,10 +481,14 @@ AllocateRuntimeZeroPool (
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType. Allocates and zeros a buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate and zero. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the
buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
request, then NULL is returned.
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -432,14 +501,20 @@ AllocateReservedZeroPool (
} }
/** /**
Copies a buffer to an allocated buffer of a certian memory type. Copies a buffer to an allocated buffer of a certian pool type.
@param MemoryType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certian pool type, copies
@param AllocationSize The number of bytes to allocate and zero. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
@param Buffer The buffer to copy to the allocated buffer. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate and zero.
@param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -462,13 +537,19 @@ InternalAllocateCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData. Copies a buffer to an allocated buffer of type EfiBootServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -491,13 +572,19 @@ AllocateCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -511,13 +598,19 @@ AllocateRuntimeCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType. Copies a buffer to an allocated buffer of type EfiReservedMemoryType.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies
@param Buffer The buffer to copy to the allocated buffer. AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
is not enough memory remaining to satisfy the request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS Buffer + 1), then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate and zero.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -531,9 +624,15 @@ AllocateReservedCopyPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment. Frees a buffer that was previously allocated with one of the pool allocation functions in the
Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
then ASSERT().
@param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID
@ -550,12 +649,18 @@ FreePool (
/** /**
Allocates a buffer of a certain pool type at a specified alignment. Allocates a buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used. buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -594,11 +699,17 @@ InternalAllocateAlignedPool (
/** /**
Allocates a buffer of type EfiBootServicesData at a specified alignment. Allocates a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -638,12 +749,17 @@ AllocateAlignedPool (
/** /**
Allocates a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -657,14 +773,19 @@ AllocateAlignedRuntimePool (
} }
/** /**
Allocates a buffer of type EfiReservedMemoryType at a specified alignment. Allocates a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
If Alignment is zero, then byte alignment is used. then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -678,15 +799,20 @@ AllocateAlignedReservedPool (
} }
/** /**
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment. Allocates and zeros a buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment, clears the buffer with zeros, and returns a pointer to the allocated
@param Alignment The requested alignment of the allocation. Must be a power of two. buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -708,12 +834,18 @@ InternalAllocateAlignedZeroPool (
/** /**
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment. Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -735,12 +867,18 @@ AllocateAlignedZeroPool (
/** /**
Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment. Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -754,14 +892,20 @@ AllocateAlignedRuntimeZeroPool (
} }
/** /**
Allocates and zeros a buffer of type EfiReservedMemoryType at a specified alignment. Allocates and zeros a buffer of type EfieservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an
@param Alignment The requested alignment of the allocation. Must be a power of two. alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the
If Alignment is zero, then byte alignment is used. allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -775,16 +919,21 @@ AllocateAlignedReservedZeroPool (
} }
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment. Copies a buffer to an allocated buffer of a certain pool type at a specified alignment.
@param PoolType The type of pool to allocate. Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment
@param AllocationSize The number of bytes to allocate. specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid
@param Buffer The buffer to copy to the allocated buffer. buffer of 0 size is returned. If there is not enough memory at the specified alignment remaining
@param Alignment The requested alignment of the allocation. Must be a power of two. to satisfy the request, then NULL is returned.
If Alignment is zero, then byte alignment is used. If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param PoolType The type of pool to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param AllocationSize The number of bytes to allocate.
@param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -810,13 +959,18 @@ InternalAllocateAlignedCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiBootServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -842,13 +996,18 @@ AllocateAlignedCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment. Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -865,13 +1024,18 @@ AllocateAlignedRuntimeCopyPool (
/** /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment. Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.
@param AllocationSize The number of bytes to allocate. Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType type with an
@param Buffer The buffer to copy to the allocated buffer. alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,
@param Alignment The requested alignment of the allocation. Must be a power of two. then a valid buffer of 0 size is returned. If there is not enough memory at the specified
If Alignment is zero, then byte alignment is used. 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().
@return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. @param AllocationSize The number of bytes to allocate.
If there is not enough memory remaining to satisfy the request, then NULL is returned. @param Buffer The buffer to copy to the allocated buffer.
@param Alignment The requested alignment of the allocation. Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
**/ **/
VOID * VOID *
@ -889,7 +1053,12 @@ AllocateAlignedReservedCopyPool (
Frees a buffer that was previously allocated with one of the aligned pool allocation functions Frees a buffer that was previously allocated with one of the aligned pool allocation functions
in the Memory Allocation Library. in the Memory Allocation Library.
@param Buffer Pointer to the buffer to free. Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
aligned pool allocation services of the Memory Allocation Library.
If Buffer was not allocated with an aligned pool allocation function in the Memory Allocation
Library, then ASSERT().
@param Buffer Pointer to the buffer to free.
**/ **/
VOID VOID

View File

@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/** /**
An empty function to pass error checking of CreateEventEx (). An empty function to pass error checking of CreateEventEx ().
This empty function enusres that EFI_EVENT_NOTIFY_SIGNAL_ALL is error This empty function ensures that EFI_EVENT_NOTIFY_SIGNAL_ALL is error
checked correctly since it is now mapped into CreateEventEx() in UEFI 2.0. checked correctly since it is now mapped into CreateEventEx() in UEFI 2.0.
**/ **/

View File

@ -434,12 +434,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
<FfsFormatKey>LIBRARY</FfsFormatKey> <FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions> </ModuleSaBuildOptions>
</ModuleSA> </ModuleSA>
<ModuleSA SupArchList="IA32" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="4c38a173-b317-4f29-a7bf-1cc7e10ccb10">
<ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding>
<FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions>
</ModuleSA>
<ModuleSA SupArchList="IA32" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C"> <ModuleSA SupArchList="IA32" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C">
<ModuleSaBuildOptions> <ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding> <FvBinding>NULL</FvBinding>
@ -1010,12 +1004,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
<FfsFormatKey>LIBRARY</FfsFormatKey> <FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions> </ModuleSaBuildOptions>
</ModuleSA> </ModuleSA>
<ModuleSA SupArchList="IPF" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="4c38a173-b317-4f29-a7bf-1cc7e10ccb10">
<ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding>
<FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions>
</ModuleSA>
<ModuleSA SupArchList="IPF" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C"> <ModuleSA SupArchList="IPF" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C">
<ModuleSaBuildOptions> <ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding> <FvBinding>NULL</FvBinding>
@ -1592,12 +1580,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
<FfsFormatKey>LIBRARY</FfsFormatKey> <FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions> </ModuleSaBuildOptions>
</ModuleSA> </ModuleSA>
<ModuleSA SupArchList="X64" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="4c38a173-b317-4f29-a7bf-1cc7e10ccb10">
<ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding>
<FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions>
</ModuleSA>
<ModuleSA SupArchList="X64" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C"> <ModuleSA SupArchList="X64" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C">
<ModuleSaBuildOptions> <ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding> <FvBinding>NULL</FvBinding>
@ -2168,12 +2150,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
<FfsFormatKey>LIBRARY</FfsFormatKey> <FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions> </ModuleSaBuildOptions>
</ModuleSA> </ModuleSA>
<ModuleSA SupArchList="EBC" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="4c38a173-b317-4f29-a7bf-1cc7e10ccb10">
<ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding>
<FfsFormatKey>LIBRARY</FfsFormatKey>
</ModuleSaBuildOptions>
</ModuleSA>
<ModuleSA SupArchList="EBC" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C"> <ModuleSA SupArchList="EBC" PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec" ModuleGuid="51C4C059-67F0-4e3c-9A55-FF42A8291C8C">
<ModuleSaBuildOptions> <ModuleSaBuildOptions>
<FvBinding>NULL</FvBinding> <FvBinding>NULL</FvBinding>

View File

@ -1154,7 +1154,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
<Filename>Library/BasePostCodeLibPort80/BasePostCodeLibPort80.msa</Filename> <Filename>Library/BasePostCodeLibPort80/BasePostCodeLibPort80.msa</Filename>
<Filename>Library/BasePostCodeLibDebug/BasePostCodeLibDebug.msa</Filename> <Filename>Library/BasePostCodeLibDebug/BasePostCodeLibDebug.msa</Filename>
<Filename>Library/PeiDxePostCodeLibReportStatusCode/PeiDxePostCodeLibReportStatusCode.msa</Filename> <Filename>Library/PeiDxePostCodeLibReportStatusCode/PeiDxePostCodeLibReportStatusCode.msa</Filename>
<Filename>Library/BaseSmbusLib/BaseSmbusLib.msa</Filename>
<Filename>Library/PeiSmbusLib/PeiSmbusLib.msa</Filename> <Filename>Library/PeiSmbusLib/PeiSmbusLib.msa</Filename>
<Filename>Library/DxeSmbusLib/DxeSmbusLib.msa</Filename> <Filename>Library/DxeSmbusLib/DxeSmbusLib.msa</Filename>
<Filename>Library/BaseUefiDecompressLib/BaseUefiDecompressLib.msa</Filename> <Filename>Library/BaseUefiDecompressLib/BaseUefiDecompressLib.msa</Filename>