**/\r
\r
\r
-\r
/**\r
- Allocates the number of 4KB pages specified by Pages of a certain memory type.\r
-\r
- @param MemoryType The type of memory to allocate.\r
- @param Pages The number of 4 KB pages to allocate.\r
+ Allocates one or more 4KB pages of a certain memory type.\r
\r
- @return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
+ Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated\r
+ buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned.\r
If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
+ @param MemoryType The type of memory to allocate.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
**/\r
VOID *\r
InternalAllocatePages (\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData.\r
+ Allocates one or more 4KB pages of type EfiBootServicesData.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData. \r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType. \r
+ Allocates one or more 4KB pages of type EfiReservedMemoryType.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
+ Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the\r
+ allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL\r
+ is returned. If there is not enough memory remaining to satisfy the request, then NULL is\r
+ returned.\r
\r
- @return A pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Frees one or more 4KB pages that were previously allocated with \r
- one of the page allocation functions in the Memory Allocation Library.\r
-\r
- @param Buffer Pointer to the buffer of pages to free.\r
- @param Pages The number of 4 KB pages to free.\r
+ Frees one or more 4KB pages that were previously allocated with one of the page allocation\r
+ functions in the Memory Allocation Library.\r
+\r
+ Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r
+ must have been allocated on a previous call to the page allocation services of the Memory\r
+ Allocation Library.\r
+ If Buffer was not allocated with a page allocation function in the Memory Allocation Library,\r
+ then ASSERT().\r
+ If Pages is zero, then ASSERT().\r
+ \r
+ @param Buffer Pointer to the buffer of pages to free.\r
+ @param Pages The number of 4 KB pages to free.\r
\r
**/\r
VOID\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of a certian memory type \r
- with an alignment specified by Alignment. \r
+ Allocates one or more 4KB pages of a certain memory type at a specified alignment.\r
\r
- @param MemoryType The type of memory to allocate.\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment\r
+ specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
+ If there is not enough memory at the specified alignment remaining to satisfy the request, then\r
+ NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return The allocated buffer is returned.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @param MemoryType The type of memory to allocate.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData\r
- with an alignment specified by Alignment. \r
+ Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.\r
+\r
+ Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r
+ returned. If there is not enough memory at the specified alignment remaining to satisfy the\r
+ request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
\r
- @return The allocated buffer is returned.<BR>\r
- If Pages is 0, then NULL is returned.<BR>\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData\r
- with an alignment specified by Alignment. \r
+ Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r
+ returned. If there is not enough memory at the specified alignment remaining to satisfy the\r
+ request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.\r
\r
- @param Pages The number of 4 KB pages to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is\r
+ returned. If there is not enough memory at the specified alignment remaining to satisfy the\r
+ request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
+\r
+ @param Pages The number of 4 KB pages to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
\r
- @return The allocated buffer is returned. If Pages is 0, then NULL is returned.\r
- If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Frees one or more 4KB pages that were previously allocated with \r
- one of the aligned page allocation functions in the Memory Allocation Library.\r
-\r
- @param Buffer Pointer to the buffer of pages to free.\r
- @param Pages The number of 4 KB pages to free.\r
+ Frees one or more 4KB pages that were previously allocated with one of the aligned page\r
+ allocation functions in the Memory Allocation Library.\r
+\r
+ Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer\r
+ must have been allocated on a previous call to the aligned page allocation services of the Memory\r
+ Allocation Library.\r
+ If Buffer was not allocated with an aligned page allocation function in the Memory Allocation\r
+ Library, then ASSERT().\r
+ If Pages is zero, then ASSERT().\r
+ \r
+ @param Buffer Pointer to the buffer of pages to free.\r
+ @param Pages The number of 4 KB pages to free.\r
\r
**/\r
VOID\r
}\r
\r
/**\r
- Allocates a buffer of a certain memory type.\r
+ Allocates a buffer of a certain pool type.\r
\r
- @param MemoryType The type of memory to allocate.\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type and returns a\r
+ pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r
+ returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param MemoryType The type of memory to allocate.\r
+ @param AllocationSize The number of bytes to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates a buffer of type EfiBootServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a\r
+ pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r
+ returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates a buffer of type EfiRuntimeServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns\r
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r
+ returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates a buffer of type EfiReservedMemoryType.\r
+ Allocates a buffer of type EfieservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
+ Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType and returns\r
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is\r
+ returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates and zeros a buffer of a certian pool type.\r
\r
- @param PoolType The type of memory to allocate.\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of a certian pool type, clears the buffer\r
+ with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid\r
+ buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,\r
+ then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param PoolType The type of memory to allocate.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
) \r
{\r
VOID *Memory;\r
+\r
Memory = InternalAllocatePool (PoolType, AllocationSize);\r
if (Memory != NULL) {\r
Memory = ZeroMem (Memory, AllocationSize);\r
/**\r
Allocates and zeros a buffer of type EfiBootServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates and zeros a buffer of type EfiRuntimeServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates and zeros a buffer of type EfiReservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate and zero.\r
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the\r
+ buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a\r
+ valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the\r
+ request, then NULL is returned.\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of a certian memory type. \r
+ Copies a buffer to an allocated buffer of a certian pool type.\r
\r
- @param MemoryType The type of pool to allocate.\r
- @param AllocationSize The number of bytes to allocate and zero.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ Allocates the number bytes specified by AllocationSize of a certian pool type, copies\r
+ AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ If Buffer is NULL, then ASSERT().\r
+ If AllocationSize is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT(). \r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param PoolType The type of pool to allocate.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
} \r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiBootServicesData. \r
+ Copies a buffer to an allocated buffer of type EfiBootServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies\r
+ AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ If Buffer is NULL, then ASSERT().\r
+ If AllocationSize is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT(). \r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiRuntimeServicesData. \r
+ Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies\r
+ AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ If Buffer is NULL, then ASSERT().\r
+ If AllocationSize is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT(). \r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiReservedMemoryType. \r
+ Copies a buffer to an allocated buffer of type EfiReservedMemoryType.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies\r
+ AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ If Buffer is NULL, then ASSERT().\r
+ If AllocationSize is greater than (MAX_ADDRESS \96 Buffer + 1), then ASSERT(). \r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate and zero.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.\r
+ Frees a buffer that was previously allocated with one of the pool allocation functions in the\r
+ Memory Allocation Library.\r
+\r
+ Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the\r
+ pool allocation services of the Memory Allocation Library.\r
+ If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
+ then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ @param Buffer Pointer to the buffer to free.\r
\r
**/\r
VOID\r
/**\r
Allocates a buffer of a certain pool type at a specified alignment.\r
\r
- @param PoolType The type of pool to allocate.\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment\r
+ specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid\r
+ buffer of 0 size is returned. If there is not enough memory at the specified alignment remaining\r
+ to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param PoolType The type of pool to allocate.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates a buffer of type EfiBootServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates a buffer of type EfiRuntimeServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates a buffer of type EfiReservedMemoryType at a specified alignment.\r
+ Allocates a buffer of type EfieservedMemoryType at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.\r
+ Allocates and zeros a buffer of a certain pool type at a specified alignment.\r
\r
- @param PoolType The type of pool to allocate.\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment\r
+ specified by Alignment, clears the buffer with zeros, and returns a pointer to the allocated\r
+ buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not\r
+ enough memory at the specified alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param PoolType The type of pool to allocate.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates and zeros a buffer of type EfiBootServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData with an\r
+ alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory at the specified alignment remaining to satisfy the request, then NULL is\r
+ returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Allocates and zeros a buffer of type EfiRuntimeServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData with an\r
+ alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory at the specified alignment remaining to satisfy the request, then NULL is\r
+ returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Allocates and zeros a buffer of type EfiReservedMemoryType at a specified alignment.\r
+ Allocates and zeros a buffer of type EfieservedMemoryType at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfieservedMemoryType with an\r
+ alignment specified by Alignment, clears the buffer with zeros, and returns a pointer to the\r
+ allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there\r
+ is not enough memory at the specified alignment remaining to satisfy the request, then NULL is\r
+ returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
}\r
\r
/**\r
- Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.\r
+ Copies a buffer to an allocated buffer of a certain pool type at a specified alignment.\r
\r
- @param PoolType The type of pool to allocate.\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of a certain pool type with an alignment\r
+ specified by Alignment. The allocated buffer is returned. If AllocationSize is 0, then a valid\r
+ buffer of 0 size is returned. If there is not enough memory at the specified alignment remaining\r
+ to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param PoolType The type of pool to allocate.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Copies a buffer to an allocated buffer of type EfiBootServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData type with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData type with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
/**\r
Copies a buffer to an allocated buffer of type EfiReservedMemoryType at a specified alignment.\r
\r
- @param AllocationSize The number of bytes to allocate.\r
- @param Buffer The buffer to copy to the allocated buffer.\r
- @param Alignment The requested alignment of the allocation. Must be a power of two.\r
- If Alignment is zero, then byte alignment is used.\r
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType type with an\r
+ alignment specified by Alignment. The allocated buffer is returned. If AllocationSize is 0,\r
+ then a valid buffer of 0 size is returned. If there is not enough memory at the specified\r
+ alignment remaining to satisfy the request, then NULL is returned.\r
+ If Alignment is not a power of two and Alignment is not zero, then ASSERT().\r
\r
- @return A pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned.\r
- If there is not enough memory remaining to satisfy the request, then NULL is returned.\r
+ @param AllocationSize The number of bytes to allocate.\r
+ @param Buffer The buffer to copy to the allocated buffer.\r
+ @param Alignment The requested alignment of the allocation. Must be a power of two.\r
+ If Alignment is zero, then byte alignment is used.\r
+\r
+ @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
Frees a buffer that was previously allocated with one of the aligned pool allocation functions \r
in the Memory Allocation Library.\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the\r
+ aligned pool allocation services of the Memory Allocation Library.\r
+ If Buffer was not allocated with an aligned pool allocation function in the Memory Allocation\r
+ Library, then ASSERT().\r
+\r
+ @param Buffer Pointer to the buffer to free.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff