+++ /dev/null
-/** @file\r
- Internal include file of DXE Memory Allocation Library.\r
-\r
- Copyright (c) 2006, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
- Module Name: MemoryAllocationLibInternals.h\r
-\r
-**/\r
-\r
-#ifndef __DXE_MEMORY_ALLOCATION_LIB_INTERNALS_H__\r
-#define __DXE_MEMORY_ALLOCATION_LIB_INTERNALS_H__\r
-\r
-/**\r
- Allocates one or more 4KB pages of a certain memory type.\r
-\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
- IN EFI_MEMORY_TYPE MemoryType, \r
- IN UINTN Pages\r
- );\r
-\r
-/**\r
- Allocates one or more 4KB pages of a certain memory type at a specified alignment.\r
-\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
- @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
-InternalAllocateAlignedPages (\r
- IN EFI_MEMORY_TYPE MemoryType, \r
- IN UINTN Pages,\r
- IN UINTN Alignment\r
- );\r
-\r
-/**\r
- Allocates a buffer of a certain pool type.\r
-\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
- @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
-InternalAllocatePool (\r
- IN EFI_MEMORY_TYPE MemoryType, \r
- IN UINTN AllocationSize\r
- );\r
-\r
-/**\r
- Allocates and zeros a buffer of a certian pool type.\r
-\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
- @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
-InternalAllocateZeroPool (\r
- IN EFI_MEMORY_TYPE PoolType, \r
- IN UINTN AllocationSize\r
- );\r
-\r
-/**\r
- Copies a buffer to an allocated buffer of a certian pool type.\r
-\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 ? Buffer + 1), then ASSERT(). \r
-\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
-InternalAllocateCopyPool (\r
- IN EFI_MEMORY_TYPE PoolType, \r
- IN UINTN AllocationSize,\r
- IN CONST VOID *Buffer\r
- );\r
-\r
-/**\r
- Allocates a buffer of a certain pool type at a specified alignment.\r
-\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
- @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
-InternalAllocateAlignedPool (\r
- IN EFI_MEMORY_TYPE PoolType,\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- );\r
-\r
-/**\r
- Allocates and zeros a buffer of a certain pool type at a specified alignment.\r
-\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
- @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
-InternalAllocateAlignedZeroPool (\r
- IN EFI_MEMORY_TYPE PoolType,\r
- IN UINTN AllocationSize,\r
- IN UINTN Alignment\r
- );\r
-\r
-/**\r
- Copies a buffer to an allocated buffer of a certain pool type at a specified alignment.\r
-\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
- @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
-InternalAllocateAlignedCopyPool (\r
- IN EFI_MEMORY_TYPE PoolType,\r
- IN UINTN AllocationSize,\r
- IN CONST VOID *Buffer,\r
- IN UINTN Alignment\r
- );\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff