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 /**
  45   Initialize the memory where the initial stacks will reside
  46
  47   This memory can contain the initial stacks (Secure and Secure Monitor stacks).
  48   In some platform, this region is already initialized and the implementation of this function can
  49   do nothing. This memory can also represent the Secure RAM.
  50   This function is called before the satck has been set up. Its implementation must ensure the stack
  51   pointer is not used (probably required to use assembly language)
  52
  53 **/
  54 VOID
  55 ArmPlatformInitializeBootMemory (
  56   VOID
  57   );
  58
  59 /**
  60   Return the current Boot Mode
  61
  62   This function returns the boot reason on the platform
  63
  64   @return   Return the current Boot Mode of the platform
  65
  66 **/
  67 EFI_BOOT_MODE
  68 ArmPlatformGetBootMode (
  69   VOID
  70   );
  71
  72 /**
  73   Call at the beginning of the platform boot up
  74
  75   This function allows the firmware platform to do extra actions at the early
  76   stage of the platform power up.
  77
  78   Note: This function must be implemented in assembler as there is no stack set up yet
  79
  80 **/
  81 VOID
  82 ArmPlatformSecBootAction (
  83   VOID
  84   );
  85
  86 /**
  87   Initialize controllers that must setup at the early stage
  88
  89   Some peripherals must be initialized in Secure World.
  90   For example, some L2x0 requires to be initialized in Secure World
  91
  92 **/
  93 VOID
  94 ArmPlatformSecInitialize (
  95   VOID
  96   );
  97
  98 /**
  99   Call before jumping to Normal World
 100
 101   This function allows the firmware platform to do extra actions before
 102   jumping to the Normal World
 103
 104 **/
 105 VOID
 106 ArmPlatformSecExtraAction (
 107   IN  UINTN         MpId,
 108   OUT UINTN*        JumpAddress
 109   );
 110
 111 /**
 112   Initialize controllers that must setup in the normal world
 113
 114   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
 115   in the PEI phase.
 116
 117 **/
 118 VOID
 119 ArmPlatformNormalInitialize (
 120   VOID
 121   );
 122
 123 /**
 124   Initialize the system (or sometimes called permanent) memory
 125
 126   This memory is generally represented by the DRAM.
 127
 128 **/
 129 VOID
 130 ArmPlatformInitializeSystemMemory (
 131   VOID
 132   );
 133
 134 /**
 135   Initialize the Secure peripherals and memory regions
 136
 137   If Trustzone is supported by your platform then this function makes the required initialization
 138   of the secure peripherals and memory regions.
 139
 140 **/
 141 VOID
 142 ArmPlatformTrustzoneInit (
 143   VOID
 144   );
 145
 146 /**
 147   Return the Virtual Memory Map of your platform
 148
 149   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
 150
 151   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
 152                                     Virtual Memory mapping. This array must be ended by a zero-filled
 153                                     entry
 154
 155 **/
 156 VOID
 157 ArmPlatformGetVirtualMemoryMap (
 158   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
 159   );
 160
 161 /**
 162   Return the EFI Memory Map of your platform
 163
 164   This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
 165   Descriptor HOBs used by DXE core.
 166
 167   @param[out]   EfiMemoryMap        Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
 168                                     EFI Memory region. This array must be ended by a zero-filled entry
 169
 170 **/
 171 EFI_STATUS
 172 ArmPlatformGetAdditionalSystemMemory (
 173   OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
 174   );
 175
 176 /**
 177   Return the Platform specific PPIs
 178
 179   This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
 180   to the PeiCore by PrePeiCore.
 181
 182   @param[out]   PpiListSize         Size in Bytes of the Platform PPI List
 183   @param[out]   PpiList             Platform PPI List
 184
 185 **/
 186 VOID
 187 ArmPlatformGetPlatformPpiList (
 188   OUT UINTN                   *PpiListSize,
 189   OUT EFI_PEI_PPI_DESCRIPTOR  **PpiList
 190   );
 191
 192 #endif