ArmPlatformPkg/Include/Library/ArmPlatformLib.h

   1 /** @file
   2 *
   3 *  Copyright (c) 2011-2013, 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
  28 #include <Library/ArmLib.h>
  29
  30 /**
  31   This structure is used to describe a region of the EFI memory map
  32
  33   Every EFI regions of the system memory described by their physical start address and their size
  34   can have different attributes. Some regions can be tested and other untested.
  35
  36 **/
  37 typedef struct {
  38   EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute;
  39   EFI_PHYSICAL_ADDRESS         PhysicalStart;
  40   UINT64                       NumberOfBytes;
  41 } ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;
  42
  43 /**
  44   Return the core position from the value of its MpId register
  45
  46   This function returns the core position from the position 0 in the processor.
  47   This function might be called from assembler before any stack is set.
  48
  49   @return   Return the core position
  50
  51 **/
  52 UINTN
  53 ArmPlatformGetCorePosition (
  54   IN UINTN MpId
  55   );
  56
  57 /**
  58   Return a non-zero value if the callee is the primary core
  59
  60   This function returns a non-zero value if the callee is the primary core.
  61   The primary core is the core responsible to initialize the hardware and run UEFI.
  62   This function might be called from assembler before any stack is set.
  63
  64   @return   Return a non-zero value if the callee is the primary core.
  65
  66 **/
  67 UINTN
  68 ArmPlatformIsPrimaryCore (
  69   IN UINTN MpId
  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 in the normal world
  87
  88   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
  89   in the PEI phase.
  90
  91 **/
  92 RETURN_STATUS
  93 ArmPlatformInitialize (
  94   IN  UINTN                     MpId
  95   );
  96
  97 /**
  98   Initialize the system (or sometimes called permanent) memory
  99
 100   This memory is generally represented by the DRAM.
 101
 102 **/
 103 VOID
 104 ArmPlatformInitializeSystemMemory (
 105   VOID
 106   );
 107
 108 /**
 109   Return the Virtual Memory Map of your platform
 110
 111   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
 112
 113   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
 114                                     Virtual Memory mapping. This array must be ended by a zero-filled
 115                                     entry
 116
 117 **/
 118 VOID
 119 ArmPlatformGetVirtualMemoryMap (
 120   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
 121   );
 122
 123 /**
 124   Return the Platform specific PPIs
 125
 126   This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
 127   to the PeiCore by PrePeiCore.
 128
 129   @param[out]   PpiListSize         Size in Bytes of the Platform PPI List
 130   @param[out]   PpiList             Platform PPI List
 131
 132 **/
 133 VOID
 134 ArmPlatformGetPlatformPpiList (
 135   OUT UINTN                   *PpiListSize,
 136   OUT EFI_PEI_PPI_DESCRIPTOR  **PpiList
 137   );
 138
 139 #endif