MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Mem / Imem.h

/** @file\r
  Data structure and functions to allocate and free memory space.\r
\r
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _IMEM_H_\r
#define _IMEM_H_\r
\r
//\r
// +---------------------------------------------------+\r
// | 0..(EfiMaxMemoryType - 1)    - Normal memory type |\r
// +---------------------------------------------------+\r
// | EfiMaxMemoryType..0x6FFFFFFF - Invalid            |\r
// +---------------------------------------------------+\r
// | 0x70000000..0x7FFFFFFF       - OEM reserved       |\r
// +---------------------------------------------------+\r
// | 0x80000000..0xFFFFFFFF       - OS reserved        |\r
// +---------------------------------------------------+\r
//\r
#define MEMORY_TYPE_OS_RESERVED_MIN                 0x80000000\r
#define MEMORY_TYPE_OS_RESERVED_MAX                 0xFFFFFFFF\r
#define MEMORY_TYPE_OEM_RESERVED_MIN                0x70000000\r
#define MEMORY_TYPE_OEM_RESERVED_MAX                0x7FFFFFFF\r
\r
//\r
// MEMORY_MAP_ENTRY\r
//\r
\r
#define MEMORY_MAP_SIGNATURE   SIGNATURE_32('m','m','a','p')\r
typedef struct {\r
  UINTN           Signature;\r
  LIST_ENTRY      Link;\r
  BOOLEAN         FromPages;\r
\r
  EFI_MEMORY_TYPE Type;\r
  UINT64          Start;\r
  UINT64          End;\r
\r
  UINT64          VirtualStart;\r
  UINT64          Attribute;\r
} MEMORY_MAP;\r
\r
//\r
// Internal prototypes\r
//\r
\r
\r
/**\r
  Internal function.  Used by the pool functions to allocate pages\r
  to back pool allocation requests.\r
\r
  @param  PoolType               The type of memory for the new pool pages\r
  @param  NumberOfPages          No of pages to allocate\r
  @param  Alignment              Bits to align.\r
  @param  NeedGuard              Flag to indicate Guard page is needed or not\r
\r
  @return The allocated memory, or NULL\r
\r
**/\r
VOID *\r
CoreAllocatePoolPages (\r
  IN EFI_MEMORY_TYPE    PoolType,\r
  IN UINTN              NumberOfPages,\r
  IN UINTN              Alignment,\r
  IN BOOLEAN            NeedGuard\r
  );\r
\r
\r
\r
/**\r
  Internal function.  Frees pool pages allocated via AllocatePoolPages ()\r
\r
  @param  Memory                 The base address to free\r
  @param  NumberOfPages          The number of pages to free\r
\r
**/\r
VOID\r
CoreFreePoolPages (\r
  IN EFI_PHYSICAL_ADDRESS   Memory,\r
  IN UINTN                  NumberOfPages\r
  );\r
\r
\r
\r
/**\r
  Internal function to allocate pool of a particular type.\r
  Caller must have the memory lock held\r
\r
  @param  PoolType               Type of pool to allocate\r
  @param  Size                   The amount of pool to allocate\r
  @param  NeedGuard              Flag to indicate Guard page is needed or not\r
\r
  @return The allocate pool, or NULL\r
\r
**/\r
VOID *\r
CoreAllocatePoolI (\r
  IN EFI_MEMORY_TYPE  PoolType,\r
  IN UINTN            Size,\r
  IN BOOLEAN          NeedGuard\r
  );\r
\r
\r
\r
/**\r
  Internal function to free a pool entry.\r
  Caller must have the memory lock held\r
\r
  @param  Buffer                 The allocated pool entry to free\r
  @param  PoolType               Pointer to pool type\r
\r
  @retval EFI_INVALID_PARAMETER  Buffer not valid\r
  @retval EFI_SUCCESS            Buffer successfully freed.\r
\r
**/\r
EFI_STATUS\r
CoreFreePoolI (\r
  IN VOID               *Buffer,\r
  OUT EFI_MEMORY_TYPE   *PoolType OPTIONAL\r
  );\r
\r
\r
\r
/**\r
  Enter critical section by gaining lock on gMemoryLock.\r
\r
**/\r
VOID\r
CoreAcquireMemoryLock (\r
  VOID\r
  );\r
\r
\r
/**\r
  Exit critical section by releasing lock on gMemoryLock.\r
\r
**/\r
VOID\r
CoreReleaseMemoryLock (\r
  VOID\r
  );\r
\r
/**\r
  Allocates pages from the memory map.\r
\r
  @param  Type                   The type of allocation to perform\r
  @param  MemoryType             The type of memory to turn the allocated pages\r
                                 into\r
  @param  NumberOfPages          The number of pages to allocate\r
  @param  Memory                 A pointer to receive the base allocated memory\r
                                 address\r
  @param  NeedGuard              Flag to indicate Guard page is needed or not\r
\r
  @return Status. On success, Memory is filled in with the base address allocated\r
  @retval EFI_INVALID_PARAMETER  Parameters violate checking rules defined in\r
                                 spec.\r
  @retval EFI_NOT_FOUND          Could not allocate pages match the requirement.\r
  @retval EFI_OUT_OF_RESOURCES   No enough pages to allocate.\r
  @retval EFI_SUCCESS            Pages successfully allocated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CoreInternalAllocatePages (\r
  IN EFI_ALLOCATE_TYPE      Type,\r
  IN EFI_MEMORY_TYPE        MemoryType,\r
  IN UINTN                  NumberOfPages,\r
  IN OUT EFI_PHYSICAL_ADDRESS  *Memory,\r
  IN BOOLEAN                NeedGuard\r
  );\r
\r
//\r
// Internal Global data\r
//\r
\r
extern EFI_LOCK           gMemoryLock;\r
extern LIST_ENTRY         gMemoryMap;\r
extern LIST_ENTRY         mGcdMemorySpaceMap;\r
#endif\r