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 UINTN
  44 ArmPlatformGetCorePosition (
  45   IN UINTN MpId
  46   );
  47
  48 /**
  49   Return the current Boot Mode
  50
  51   This function returns the boot reason on the platform
  52
  53   @return   Return the current Boot Mode of the platform
  54
  55 **/
  56 EFI_BOOT_MODE
  57 ArmPlatformGetBootMode (
  58   VOID
  59   );
  60
  61 /**
  62   Initialize controllers that must setup in the normal world
  63
  64   This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
  65   in the PEI phase.
  66
  67 **/
  68 RETURN_STATUS
  69 ArmPlatformInitialize (
  70   IN  UINTN                     MpId
  71   );
  72
  73 /**
  74   Initialize the system (or sometimes called permanent) memory
  75
  76   This memory is generally represented by the DRAM.
  77
  78 **/
  79 VOID
  80 ArmPlatformInitializeSystemMemory (
  81   VOID
  82   );
  83
  84 /**
  85   Return the Virtual Memory Map of your platform
  86
  87   This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
  88
  89   @param[out]   VirtualMemoryMap    Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
  90                                     Virtual Memory mapping. This array must be ended by a zero-filled
  91                                     entry
  92
  93 **/
  94 VOID
  95 ArmPlatformGetVirtualMemoryMap (
  96   OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
  97   );
  98
  99 /**
 100   Return the Platform specific PPIs
 101
 102   This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
 103   to the PeiCore by PrePeiCore.
 104
 105   @param[out]   PpiListSize         Size in Bytes of the Platform PPI List
 106   @param[out]   PpiList             Platform PPI List
 107
 108 **/
 109 VOID
 110 ArmPlatformGetPlatformPpiList (
 111   OUT UINTN                   *PpiListSize,
 112   OUT EFI_PEI_PPI_DESCRIPTOR  **PpiList
 113   );
 114
 115 #endif