OvmfPkg/PlatformPei/Platform.c

   1 /**@file
   2   Platform PEI driver
   3
   4   Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
   5   Copyright (c) 2011, Andrei Warkentin <andreiw@motorola.com>
   6
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 //
  18 // The package level header files this module uses
  19 //
  20 #include <PiPei.h>
  21
  22 //
  23 // The Library classes this module consumes
  24 //
  25 #include <Library/DebugLib.h>
  26 #include <Library/HobLib.h>
  27 #include <Library/IoLib.h>
  28 #include <Library/MemoryAllocationLib.h>
  29 #include <Library/PcdLib.h>
  30 #include <Library/PciLib.h>
  31 #include <Library/PeimEntryPoint.h>
  32 #include <Library/PeiServicesLib.h>
  33 #include <Library/ResourcePublicationLib.h>
  34 #include <Guid/MemoryTypeInformation.h>
  35 #include <Ppi/MasterBootMode.h>
  36 #include <IndustryStandard/Pci22.h>
  37
  38 #include "Platform.h"
  39 #include "Cmos.h"
  40
  41 EFI_MEMORY_TYPE_INFORMATION mDefaultMemoryTypeInformation[] = {
  42   { EfiACPIMemoryNVS,       0x004 },
  43   { EfiACPIReclaimMemory,   0x008 },
  44   { EfiReservedMemoryType,  0x004 },
  45   { EfiRuntimeServicesData, 0x024 },
  46   { EfiRuntimeServicesCode, 0x030 },
  47   { EfiBootServicesCode,    0x180 },
  48   { EfiBootServicesData,    0xF00 },
  49   { EfiMaxMemoryType,       0x000 }
  50 };
  51
  52
  53 EFI_PEI_PPI_DESCRIPTOR   mPpiBootMode[] = {
  54   {
  55     EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
  56     &gEfiPeiMasterBootModePpiGuid,
  57     NULL
  58   }
  59 };
  60
  61
  62 VOID
  63 AddIoMemoryBaseSizeHob (
  64   EFI_PHYSICAL_ADDRESS        MemoryBase,
  65   UINT64                      MemorySize
  66   )
  67 {
  68   BuildResourceDescriptorHob (
  69     EFI_RESOURCE_MEMORY_MAPPED_IO,
  70       EFI_RESOURCE_ATTRIBUTE_PRESENT     |
  71       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
  72       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |
  73       EFI_RESOURCE_ATTRIBUTE_TESTED,
  74     MemoryBase,
  75     MemorySize
  76     );
  77 }
  78
  79 VOID
  80 AddReservedMemoryBaseSizeHob (
  81   EFI_PHYSICAL_ADDRESS        MemoryBase,
  82   UINT64                      MemorySize
  83   )
  84 {
  85   BuildResourceDescriptorHob (
  86     EFI_RESOURCE_MEMORY_RESERVED,
  87       EFI_RESOURCE_ATTRIBUTE_PRESENT     |
  88       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
  89       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |
  90       EFI_RESOURCE_ATTRIBUTE_TESTED,
  91     MemoryBase,
  92     MemorySize
  93     );
  94 }
  95
  96 VOID
  97 AddIoMemoryRangeHob (
  98   EFI_PHYSICAL_ADDRESS        MemoryBase,
  99   EFI_PHYSICAL_ADDRESS        MemoryLimit
 100   )
 101 {
 102   AddIoMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));
 103 }
 104
 105
 106 VOID
 107 AddMemoryBaseSizeHob (
 108   EFI_PHYSICAL_ADDRESS        MemoryBase,
 109   UINT64                      MemorySize
 110   )
 111 {
 112   BuildResourceDescriptorHob (
 113     EFI_RESOURCE_SYSTEM_MEMORY,
 114       EFI_RESOURCE_ATTRIBUTE_PRESENT |
 115       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
 116       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |
 117       EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |
 118       EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |
 119       EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE |
 120       EFI_RESOURCE_ATTRIBUTE_TESTED,
 121     MemoryBase,
 122     MemorySize
 123     );
 124 }
 125
 126
 127 VOID
 128 AddMemoryRangeHob (
 129   EFI_PHYSICAL_ADDRESS        MemoryBase,
 130   EFI_PHYSICAL_ADDRESS        MemoryLimit
 131   )
 132 {
 133   AddMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));
 134 }
 135
 136
 137 VOID
 138 AddUntestedMemoryBaseSizeHob (
 139   EFI_PHYSICAL_ADDRESS        MemoryBase,
 140   UINT64                      MemorySize
 141   )
 142 {
 143   BuildResourceDescriptorHob (
 144     EFI_RESOURCE_SYSTEM_MEMORY,
 145       EFI_RESOURCE_ATTRIBUTE_PRESENT |
 146       EFI_RESOURCE_ATTRIBUTE_INITIALIZED |
 147       EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE |
 148       EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE |
 149       EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE |
 150       EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE,
 151     MemoryBase,
 152     MemorySize
 153     );
 154 }
 155
 156
 157 VOID
 158 AddUntestedMemoryRangeHob (
 159   EFI_PHYSICAL_ADDRESS        MemoryBase,
 160   EFI_PHYSICAL_ADDRESS        MemoryLimit
 161   )
 162 {
 163   AddUntestedMemoryBaseSizeHob (MemoryBase, (UINT64)(MemoryLimit - MemoryBase));
 164 }
 165
 166
 167 VOID
 168 MemMapInitialization (
 169   EFI_PHYSICAL_ADDRESS  TopOfMemory
 170   )
 171 {
 172   //
 173   // Create Memory Type Information HOB
 174   //
 175   BuildGuidDataHob (
 176     &gEfiMemoryTypeInformationGuid,
 177     mDefaultMemoryTypeInformation,
 178     sizeof(mDefaultMemoryTypeInformation)
 179     );
 180
 181   //
 182   // Add PCI IO Port space available for PCI resource allocations.
 183   //
 184   BuildResourceDescriptorHob (
 185     EFI_RESOURCE_IO,
 186     EFI_RESOURCE_ATTRIBUTE_PRESENT     |
 187     EFI_RESOURCE_ATTRIBUTE_INITIALIZED,
 188     0xC000,
 189     0x4000
 190     );
 191
 192   //
 193   // Video memory + Legacy BIOS region
 194   //
 195   AddIoMemoryRangeHob (0x0A0000, BASE_1MB);
 196
 197   //
 198   // address       purpose   size
 199   // ------------  --------  -------------------------
 200   // max(top, 2g)  PCI MMIO  0xFC000000 - max(top, 2g)
 201   // 0xFC000000    gap                           44 MB
 202   // 0xFEC00000    IO-APIC                        4 KB
 203   // 0xFEC01000    gap                         1020 KB
 204   // 0xFED00000    HPET                           1 KB
 205   // 0xFED00400    gap                         1023 KB
 206   // 0xFEE00000    LAPIC                          1 MB
 207   //
 208   AddIoMemoryRangeHob (TopOfMemory < BASE_2GB ? BASE_2GB : TopOfMemory, 0xFC000000);
 209   AddIoMemoryBaseSizeHob (0xFEC00000, SIZE_4KB);
 210   AddIoMemoryBaseSizeHob (0xFED00000, SIZE_1KB);
 211   AddIoMemoryBaseSizeHob (PcdGet32(PcdCpuLocalApicBaseAddress), SIZE_1MB);
 212 }
 213
 214
 215 VOID
 216 MiscInitialization (
 217   VOID
 218   )
 219 {
 220   //
 221   // Disable A20 Mask
 222   //
 223   IoOr8 (0x92, BIT1);
 224
 225   //
 226   // Build the CPU hob with 36-bit addressing and 16-bits of IO space.
 227   //
 228   BuildCpuHob (36, 16);
 229
 230   //
 231   // If PMREGMISC/PMIOSE is set, assume the ACPI PMBA has been configured (for
 232   // example by Xen) and skip the setup here. This matches the logic in
 233   // AcpiTimerLibConstructor ().
 234   //
 235   if ((PciRead8 (PCI_LIB_ADDRESS (0, 1, 3, 0x80)) & 0x01) == 0) {
 236     //
 237     // The PEI phase should be exited with fully accessibe PIIX4 IO space:
 238     // 1. set PMBA
 239     //
 240     PciAndThenOr32 (
 241       PCI_LIB_ADDRESS (0, 1, 3, 0x40),
 242       (UINT32) ~0xFFC0,
 243       PcdGet16 (PcdAcpiPmBaseAddress)
 244       );
 245
 246     //
 247     // 2. set PCICMD/IOSE
 248     //
 249     PciOr8 (
 250       PCI_LIB_ADDRESS (0, 1, 3, PCI_COMMAND_OFFSET),
 251       EFI_PCI_COMMAND_IO_SPACE
 252       );
 253
 254     //
 255     // 3. set PMREGMISC/PMIOSE
 256     //
 257     PciOr8 (PCI_LIB_ADDRESS (0, 1, 3, 0x80), 0x01);
 258   }
 259 }
 260
 261
 262 VOID
 263 BootModeInitialization (
 264   )
 265 {
 266   EFI_STATUS Status;
 267
 268   Status = PeiServicesSetBootMode (BOOT_WITH_FULL_CONFIGURATION);
 269   ASSERT_EFI_ERROR (Status);
 270
 271   Status = PeiServicesInstallPpi (mPpiBootMode);
 272   ASSERT_EFI_ERROR (Status);
 273 }
 274
 275
 276 VOID
 277 ReserveEmuVariableNvStore (
 278   )
 279 {
 280   EFI_PHYSICAL_ADDRESS VariableStore;
 281
 282   //
 283   // Allocate storage for NV variables early on so it will be
 284   // at a consistent address.  Since VM memory is preserved
 285   // across reboots, this allows the NV variable storage to survive
 286   // a VM reboot.
 287   //
 288   VariableStore =
 289     (EFI_PHYSICAL_ADDRESS)(UINTN)
 290       AllocateAlignedRuntimePages (
 291         EFI_SIZE_TO_PAGES (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize)),
 292         PcdGet32 (PcdFlashNvStorageFtwSpareSize)
 293         );
 294   DEBUG ((EFI_D_INFO,
 295           "Reserved variable store memory: 0x%lX; size: %dkb\n",
 296           VariableStore,
 297           (2 * PcdGet32 (PcdFlashNvStorageFtwSpareSize)) / 1024
 298         ));
 299   PcdSet64 (PcdEmuVariableNvStoreReserved, VariableStore);
 300 }
 301
 302
 303 VOID
 304 DebugDumpCmos (
 305   VOID
 306   )
 307 {
 308   UINTN  Loop;
 309
 310   DEBUG ((EFI_D_INFO, "CMOS:\n"));
 311
 312   for (Loop = 0; Loop < 0x80; Loop++) {
 313     if ((Loop % 0x10) == 0) {
 314       DEBUG ((EFI_D_INFO, "%02x:", Loop));
 315     }
 316     DEBUG ((EFI_D_INFO, " %02x", CmosRead8 (Loop)));
 317     if ((Loop % 0x10) == 0xf) {
 318       DEBUG ((EFI_D_INFO, "\n"));
 319     }
 320   }
 321 }
 322
 323
 324 /**
 325   Perform Platform PEI initialization.
 326
 327   @param  FileHandle      Handle of the file being invoked.
 328   @param  PeiServices     Describes the list of possible PEI Services.
 329
 330   @return EFI_SUCCESS     The PEIM initialized successfully.
 331
 332 **/
 333 EFI_STATUS
 334 EFIAPI
 335 InitializePlatform (
 336   IN       EFI_PEI_FILE_HANDLE  FileHandle,
 337   IN CONST EFI_PEI_SERVICES     **PeiServices
 338   )
 339 {
 340   EFI_PHYSICAL_ADDRESS  TopOfMemory;
 341   UINT32 XenLeaf;
 342
 343   DEBUG ((EFI_D_ERROR, "Platform PEIM Loaded\n"));
 344
 345   DebugDumpCmos ();
 346
 347   XenLeaf = XenDetect ();
 348
 349   TopOfMemory = MemDetect ();
 350
 351   if (XenLeaf != 0) {
 352     DEBUG ((EFI_D_INFO, "Xen was detected\n"));
 353     InitializeXen (XenLeaf);
 354   }
 355
 356   ReserveEmuVariableNvStore ();
 357
 358   PeiFvInitialization ();
 359
 360   MemMapInitialization (TopOfMemory);
 361
 362   MiscInitialization ();
 363
 364   BootModeInitialization ();
 365
 366   return EFI_SUCCESS;
 367 }