ArmVirtPkg/Include/Library/ArmVirtMemInfoLib.h

   1 /** @file
   2
   3   Copyright (c) 2011-2013, ARM Limited. All rights reserved.
   4   Copyright (c) 2017, Linaro, Ltd. All rights reserved.
   5
   6   This program and the accompanying materials are licensed and made available
   7   under the terms and conditions of the BSD License which accompanies this
   8   distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _ARM_VIRT_MEMINFO_LIB_H_
  17 #define _ARM_VIRT_MEMINFO_LIB_H_
  18
  19 #include <Base.h>
  20 #include <Library/ArmLib.h>
  21
  22 /**
  23   Return the Virtual Memory Map of your platform
  24
  25   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU
  26   on your platform.
  27
  28   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR
  29                                     describing a Physical-to-Virtual Memory
  30                                     mapping. This array must be ended by a
  31                                     zero-filled entry. The allocated memory
  32                                     will not be freed.
  33
  34 **/
  35 VOID
  36 EFIAPI
  37 ArmVirtGetMemoryMap (
  38   OUT ARM_MEMORY_REGION_DESCRIPTOR    **VirtualMemoryMap
  39   );
  40
  41 #endif