mirror of https://github.com/acidanthera/audk.git
123 lines
4.3 KiB
C
123 lines
4.3 KiB
C
/** @file
|
|
Provides primitives to allocate and free memory buffers of various memory types and alignments.
|
|
|
|
The Phase Memory Allocation Library abstracts primitive memory allocation operations. This library
|
|
allows code to be written in a phase-independent manner because the allocation of memory in PEI, DXE,
|
|
and SMM (for example) is done via a different mechanism. Using a common library interface makes it
|
|
much easier to port algorithms from phase to phase.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __PHASE_MEMORY_ALLOCATION_LIB_H__
|
|
#define __PHASE_MEMORY_ALLOCATION_LIB_H__
|
|
|
|
/**
|
|
Allocates one or more 4KB pages of a certain memory type.
|
|
|
|
Allocates the number of 4KB pages of a certain memory type and returns a pointer
|
|
to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
|
|
|
|
@param Type The type of allocation to perform.
|
|
@param MemoryType The type of memory to allocate.
|
|
@param Pages The number of 4 KB pages to allocate.
|
|
@param Memory The pointer to a physical address. On input, the
|
|
way in which the address is used depends on the
|
|
value of Type.
|
|
|
|
@retval EFI_SUCCESS The requested pages were allocated.
|
|
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
|
|
@retval EFI_NOT_FOUND The requested pages could not be found.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PhaseAllocatePages (
|
|
IN EFI_ALLOCATE_TYPE Type,
|
|
IN EFI_MEMORY_TYPE MemoryType,
|
|
IN UINTN Pages,
|
|
IN OUT EFI_PHYSICAL_ADDRESS *Memory
|
|
);
|
|
|
|
/**
|
|
Frees one or more 4KB pages that were previously allocated with one of the page allocation
|
|
functions in the Memory Allocation Library.
|
|
|
|
Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.
|
|
Buffer must have been allocated on a previous call to the page allocation services
|
|
of the Memory Allocation Library. If it is not possible to free allocated pages,
|
|
then this function will perform no actions.
|
|
|
|
If Buffer was not allocated with a page allocation function in the Memory Allocation
|
|
Library, then ASSERT().
|
|
If Pages is zero, then ASSERT().
|
|
|
|
@param Memory The base physical address of the pages to be freed.
|
|
@param Pages The number of 4 KB pages to free.
|
|
|
|
@retval EFI_SUCCESS The requested pages were freed.
|
|
@retval EFI_NOT_FOUND The requested memory pages were not allocated with
|
|
PhaseAllocatePages().
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PhaseFreePages (
|
|
IN EFI_PHYSICAL_ADDRESS Memory,
|
|
IN UINTN Pages
|
|
);
|
|
|
|
/**
|
|
Allocates a buffer of a certain pool type.
|
|
|
|
Allocates the number bytes specified by AllocationSize of a certain pool type 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.
|
|
|
|
@param MemoryType The type of memory to allocate.
|
|
@param AllocationSize The number of bytes to allocate.
|
|
|
|
@return A pointer to the allocated buffer or NULL if allocation fails.
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
PhaseAllocatePool (
|
|
IN EFI_MEMORY_TYPE MemoryType,
|
|
IN UINTN AllocationSize
|
|
);
|
|
|
|
/**
|
|
Frees a buffer that was previously allocated with one of the pool allocation functions in the
|
|
Memory Allocation Library.
|
|
|
|
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 it is not possible to free pool
|
|
resources, then this function will perform no actions.
|
|
|
|
If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
|
|
then ASSERT().
|
|
|
|
@param Buffer The pointer to the buffer to free.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
PhaseFreePool (
|
|
IN VOID *Buffer
|
|
);
|
|
|
|
///
|
|
/// The memory type to allocate for calls to AllocatePages().
|
|
///
|
|
extern CONST EFI_MEMORY_TYPE gPhaseDefaultDataType;
|
|
|
|
///
|
|
/// The memory type to allocate for calls to AllocateCodePages().
|
|
///
|
|
extern CONST EFI_MEMORY_TYPE gPhaseDefaultCodeType;
|
|
|
|
#endif
|