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   Call at the beginning of the platform boot up
  87
  88   This function allows the firmware platform to do extra actions at the early
  89   stage of the platform power up.
  90
  91   Note: This function must be implemented in assembler as there is no stack set up yet
  92
  93 **/
  94 VOID
  95 ArmPlatformSecBootAction (
  96   VOID
  97   );
  98
  99 /**
 100   Initialize controllers that must setup at the early stage
 101
 102   Some peripherals must be initialized in Secure World.
 103   For example, some L2x0 requires to be initialized in Secure World
 104
 105 **/
 106 VOID
 107 ArmPlatformSecInitialize (
 108   VOID
 109   );
 110
 111 /**
 112   Call before jumping to Normal World
 113
 114   This function allows the firmware platform to do extra actions before
 115   jumping to the Normal World
 116
 117 **/
 118 VOID
 119 ArmPlatformSecExtraAction (
 120   IN  UINTN         MpId,
 121   OUT UINTN*        JumpAddress
 122   );
 123
 124 /**
 125   Initialize controllers that must setup in the normal world
 126
 127   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
 128   in the PEI phase.
 129
 130 **/
 131 VOID
 132 ArmPlatformNormalInitialize (
 133   VOID
 134   );
 135
 136 /**
 137   Initialize the system (or sometimes called permanent) memory
 138
 139   This memory is generally represented by the DRAM.
 140
 141 **/
 142 VOID
 143 ArmPlatformInitializeSystemMemory (
 144   VOID
 145   );
 146
 147 /**
 148   Remap the memory at 0x0
 149
 150   Some platform requires or gives the ability to remap the memory at the address 0x0.
 151   This function can do nothing if this feature is not relevant to your platform.
 152
 153 **/
 154 VOID
 155 ArmPlatformBootRemapping (
 156   VOID
 157   );
 158
 159 /**
 160   Return if Trustzone is supported by your platform
 161
 162   A non-zero value must be returned if you want to support a Secure World on your platform.
 163   ArmPlatformTrustzoneInit() will later set up the secure regions.
 164   This function can return 0 even if Trustzone is supported by your processor. In this case,
 165   the platform will continue to run in Secure World.
 166
 167   @return   A non-zero value if Trustzone supported.
 168
 169 **/
 170 UINTN
 171 ArmPlatformTrustzoneSupported (
 172   VOID
 173   );
 174
 175 /**
 176   Initialize the Secure peripherals and memory regions
 177
 178   If Trustzone is supported by your platform then this function makes the required initialization
 179   of the secure peripherals and memory regions.
 180
 181 **/
 182 VOID
 183 ArmPlatformTrustzoneInit (
 184   VOID
 185   );
 186
 187 /**
 188   Return the Virtual Memory Map of your platform
 189
 190   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
 191
 192   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
 193                                     Virtual Memory mapping. This array must be ended by a zero-filled
 194                                     entry
 195
 196 **/
 197 VOID
 198 ArmPlatformGetVirtualMemoryMap (
 199   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
 200   );
 201
 202 /**
 203   Return the EFI Memory Map of your platform
 204
 205   This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
 206   Descriptor HOBs used by DXE core.
 207
 208   @param[out]   EfiMemoryMap        Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
 209                                     EFI Memory region. This array must be ended by a zero-filled entry
 210
 211 **/
 212 EFI_STATUS
 213 ArmPlatformGetAdditionalSystemMemory (
 214   OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
 215   );
 216
 217 #endif