ArmPlatformPkg/Include/Library/ArmPlatformLib.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011-2012, ARM Limited. All rights reserved.
   4 *
   5 *  This program and the accompanying materials
   6 *  are licensed and made available under the terms and conditions of the BSD License
   7 *  which accompanies this distribution.  The full text of the license may be found at
   8 *  http://opensource.org/licenses/bsd-license.php
   9 *
  10 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 *
  13 **/
  14
  15 #ifndef _ARMPLATFORMLIB_H_
  16 #define _ARMPLATFORMLIB_H_
  17
  18 //
  19 // The package level header files this module uses
  20 //
  21 #include <PiPei.h>
  22 //
  23 // The protocols, PPI and GUID defintions for this module
  24 //
  25 #include <Ppi/MasterBootMode.h>
  26 #include <Ppi/BootInRecoveryMode.h>
  27 #include <Guid/MemoryTypeInformation.h>
  28
  29 #include <Library/ArmLib.h>
  30
  31 /**
  32   This structure is used to describe a region of the EFI memory map
  33
  34   Every EFI regions of the system memory described by their physical start address and their size
  35   can have different attributes. Some regions can be tested and other untested.
  36
  37 **/
  38 typedef struct {
  39   EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute;
  40   EFI_PHYSICAL_ADDRESS         PhysicalStart;
  41   UINT64                       NumberOfBytes;
  42 } ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;
  43
  44 UINTN
  45 ArmPlatformGetCorePosition (
  46   IN UINTN MpId
  47   );
  48
  49 /**
  50   Return the current Boot Mode
  51
  52   This function returns the boot reason on the platform
  53
  54   @return   Return the current Boot Mode of the platform
  55
  56 **/
  57 EFI_BOOT_MODE
  58 ArmPlatformGetBootMode (
  59   VOID
  60   );
  61
  62 /**
  63   Initialize controllers that must setup in the normal world
  64
  65   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
  66   in the PEI phase.
  67
  68 **/
  69 RETURN_STATUS
  70 ArmPlatformInitialize (
  71   IN  UINTN                     MpId
  72   );
  73
  74 /**
  75   Initialize the system (or sometimes called permanent) memory
  76
  77   This memory is generally represented by the DRAM.
  78
  79 **/
  80 VOID
  81 ArmPlatformInitializeSystemMemory (
  82   VOID
  83   );
  84
  85 /**
  86   Return the Virtual Memory Map of your platform
  87
  88   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
  89
  90   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
  91                                     Virtual Memory mapping. This array must be ended by a zero-filled
  92                                     entry
  93
  94 **/
  95 VOID
  96 ArmPlatformGetVirtualMemoryMap (
  97   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
  98   );
  99
 100 /**
 101   Return the EFI Memory Map of your platform
 102
 103   This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
 104   Descriptor HOBs used by DXE core.
 105
 106   @param[out]   EfiMemoryMap        Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
 107                                     EFI Memory region. This array must be ended by a zero-filled entry
 108
 109 **/
 110 EFI_STATUS
 111 ArmPlatformGetAdditionalSystemMemory (
 112   OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
 113   );
 114
 115 /**
 116   Return the Platform specific PPIs
 117
 118   This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
 119   to the PeiCore by PrePeiCore.
 120
 121   @param[out]   PpiListSize         Size in Bytes of the Platform PPI List
 122   @param[out]   PpiList             Platform PPI List
 123
 124 **/
 125 VOID
 126 ArmPlatformGetPlatformPpiList (
 127   OUT UINTN                   *PpiListSize,
 128   OUT EFI_PEI_PPI_DESCRIPTOR  **PpiList
 129   );
 130
 131 #endif