ArmPlatformPkg/Include/Library/ArmPlatformLib.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011, 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 by ArmVExpressGetEfiMemoryMap to describes 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 /**
  45   Called at the early stage of the Boot phase to know if the memory has already been initialized
  46
  47   Running the code from the reset vector does not mean we start from cold boot. In some case, we
  48   can go through this code with the memory already initialized.
  49   Because this function is called at the early stage, the implementation must not use the stack.
  50   Its implementation must probably done in assembly to ensure this requirement.
  51
  52   @return   Return the condition value into the 'Z' flag
  53
  54 **/
  55 VOID ArmPlatformIsMemoryInitialized(VOID);
  56
  57 /**
  58   Initialize the memory where the initial stacks will reside
  59
  60   This memory can contain the initial stacks (Secure and Secure Monitor stacks).
  61   In some platform, this region is already initialized and the implementation of this function can
  62   do nothing. This memory can also represent the Secure RAM.
  63   This function is called before the satck has been set up. Its implementation must ensure the stack
  64   pointer is not used (probably required to use assembly language)
  65
  66 **/
  67 VOID
  68 ArmPlatformInitializeBootMemory (
  69   VOID
  70   );
  71
  72 /**
  73   Return the current Boot Mode
  74
  75   This function returns the boot reason on the platform
  76
  77   @return   Return the current Boot Mode of the platform
  78
  79 **/
  80 EFI_BOOT_MODE
  81 ArmPlatformGetBootMode (
  82   VOID
  83   );
  84
  85 /**
  86   Initialize controllers that must setup at the early stage
  87
  88   Some peripherals must be initialized in Secure World.
  89   For example, some L2x0 requires to be initialized in Secure World
  90
  91 **/
  92 VOID
  93 ArmPlatformSecInitialize (
  94   VOID
  95   );
  96
  97 /**
  98   Initialize controllers that must setup in the normal world
  99
 100   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
 101   in the PEI phase.
 102
 103 **/
 104 VOID
 105 ArmPlatformNormalInitialize (
 106   VOID
 107   );
 108
 109 /**
 110   Initialize the system (or sometimes called permanent) memory
 111
 112   This memory is generally represented by the DRAM.
 113
 114 **/
 115 VOID
 116 ArmPlatformInitializeSystemMemory (
 117   VOID
 118   );
 119
 120 /**
 121   Remap the memory at 0x0
 122
 123   Some platform requires or gives the ability to remap the memory at the address 0x0.
 124   This function can do nothing if this feature is not relevant to your platform.
 125
 126 **/
 127 VOID
 128 ArmPlatformBootRemapping (
 129   VOID
 130   );
 131
 132 /**
 133   Return if Trustzone is supported by your platform
 134
 135   A non-zero value must be returned if you want to support a Secure World on your platform.
 136   ArmPlatformTrustzoneInit() will later set up the secure regions.
 137   This function can return 0 even if Trustzone is supported by your processor. In this case,
 138   the platform will continue to run in Secure World.
 139
 140   @return   A non-zero value if Trustzone supported.
 141
 142 **/
 143 UINTN
 144 ArmPlatformTrustzoneSupported (
 145   VOID
 146   );
 147
 148 /**
 149   Initialize the Secure peripherals and memory regions
 150
 151   If Trustzone is supported by your platform then this function makes the required initialization
 152   of the secure peripherals and memory regions.
 153
 154 **/
 155 VOID
 156 ArmPlatformTrustzoneInit (
 157   VOID
 158   );
 159
 160 /**
 161   Return the Virtual Memory Map of your platform
 162
 163   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
 164
 165   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
 166                                     Virtual Memory mapping. This array must be ended by a zero-filled
 167                                     entry
 168
 169 **/
 170 VOID
 171 ArmPlatformGetVirtualMemoryMap (
 172   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
 173   );
 174
 175 /**
 176   Return the EFI Memory Map of your platform
 177
 178   This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
 179   Descriptor HOBs used by DXE core.
 180
 181   @param[out]   EfiMemoryMap        Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
 182                                     EFI Memory region. This array must be ended by a zero-filled entry
 183
 184 **/
 185 EFI_STATUS
 186 ArmPlatformGetAdditionalSystemMemory (
 187   OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
 188   );
 189
 190 #endif