ArmVirtPkg: introduce ArmVirtMemInfoLib library class

[mirror_edk2.git] / ArmVirtPkg / Include / Library / ArmVirtMemInfoLib.h

/** @file\r
\r
  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
  Copyright (c) 2017, Linaro, Ltd. All rights reserved.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  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
**/\r
\r
#ifndef _ARM_VIRT_MEMINFO_LIB_H_\r
#define _ARM_VIRT_MEMINFO_LIB_H_\r
\r
#include <Base.h>\r
#include <Library/ArmLib.h>\r
\r
/**\r
  Return the Virtual Memory Map of your platform\r
\r
  This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU\r
  on your platform.\r
\r
  @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR\r
                                    describing a Physical-to-Virtual Memory\r
                                    mapping. This array must be ended by a\r
                                    zero-filled entry. The allocated memory\r
                                    will not be freed.\r
\r
**/\r
VOID\r
EFIAPI\r
ArmVirtGetMemoryMap (\r
  OUT ARM_MEMORY_REGION_DESCRIPTOR    **VirtualMemoryMap\r
  );\r
\r
#endif\r