MdeModulePkg/Core/Pei/PeiMain/PeiMain.c

   1 /** @file
   2   Pei Core Main Entry Point
   3
   4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   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 #include "PeiMain.h"
  16
  17 EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {
  18   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  19   &gEfiPeiMemoryDiscoveredPpiGuid,
  20   NULL
  21 };
  22
  23 ///
  24 /// Pei service instance
  25 ///
  26 EFI_PEI_SERVICES  gPs = {
  27   {
  28     PEI_SERVICES_SIGNATURE,
  29     PEI_SERVICES_REVISION,
  30     sizeof (EFI_PEI_SERVICES),
  31     0,
  32     0
  33   },
  34   PeiInstallPpi,
  35   PeiReInstallPpi,
  36   PeiLocatePpi,
  37   PeiNotifyPpi,
  38
  39   PeiGetBootMode,
  40   PeiSetBootMode,
  41
  42   PeiGetHobList,
  43   PeiCreateHob,
  44
  45   PeiFfsFindNextVolume,
  46   PeiFfsFindNextFile,
  47   PeiFfsFindSectionData,
  48
  49   PeiInstallPeiMemory,
  50   PeiAllocatePages,
  51   PeiAllocatePool,
  52   (EFI_PEI_COPY_MEM)CopyMem,
  53   (EFI_PEI_SET_MEM)SetMem,
  54
  55   PeiReportStatusCode,
  56   PeiResetSystem,
  57
  58   &gPeiDefaultCpuIoPpi,
  59   &gPeiDefaultPciCfg2Ppi,
  60
  61   PeiFfsFindFileByName,
  62   PeiFfsGetFileInfo,
  63   PeiFfsGetVolumeInfo,
  64   PeiRegisterForShadow,
  65   PeiFfsFindSectionData3,
  66   PeiFfsGetFileInfo2,
  67   PeiResetSystem2,
  68   PeiFreePages,
  69 };
  70
  71 /**
  72   Shadow PeiCore module from flash to installed memory.
  73
  74   @param PrivateData    PeiCore's private data structure
  75
  76   @return PeiCore function address after shadowing.
  77 **/
  78 PEICORE_FUNCTION_POINTER
  79 ShadowPeiCore (
  80   IN PEI_CORE_INSTANCE  *PrivateData
  81   )
  82 {
  83   EFI_PEI_FILE_HANDLE  PeiCoreFileHandle;
  84   EFI_PHYSICAL_ADDRESS EntryPoint;
  85   EFI_STATUS           Status;
  86   UINT32               AuthenticationState;
  87
  88   PeiCoreFileHandle = NULL;
  89
  90   //
  91   // Find the PEI Core in the BFV
  92   //
  93   Status = PrivateData->Fv[0].FvPpi->FindFileByType (
  94                                        PrivateData->Fv[0].FvPpi,
  95                                        EFI_FV_FILETYPE_PEI_CORE,
  96                                        PrivateData->Fv[0].FvHandle,
  97                                        &PeiCoreFileHandle
  98                                        );
  99   ASSERT_EFI_ERROR (Status);
 100
 101   //
 102   // Shadow PEI Core into memory so it will run faster
 103   //
 104   Status = PeiLoadImage (
 105               GetPeiServicesTablePointer (),
 106               *((EFI_PEI_FILE_HANDLE*)&PeiCoreFileHandle),
 107               PEIM_STATE_REGISTER_FOR_SHADOW,
 108               &EntryPoint,
 109               &AuthenticationState
 110               );
 111   ASSERT_EFI_ERROR (Status);
 112
 113   //
 114   // Compute the PeiCore's function address after shaowed PeiCore.
 115   // _ModuleEntryPoint is PeiCore main function entry
 116   //
 117   return (PEICORE_FUNCTION_POINTER)((UINTN) EntryPoint + (UINTN) PeiCore - (UINTN) _ModuleEntryPoint);
 118 }
 119
 120 /**
 121   This routine is invoked by main entry of PeiMain module during transition
 122   from SEC to PEI. After switching stack in the PEI core, it will restart
 123   with the old core data.
 124
 125   @param SecCoreDataPtr  Points to a data structure containing information about the PEI core's operating
 126                          environment, such as the size and location of temporary RAM, the stack location and
 127                          the BFV location.
 128   @param PpiList         Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
 129                          An empty PPI list consists of a single descriptor with the end-tag
 130                          EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
 131                          phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
 132                          that both the PEI Foundation and any modules can leverage the associated service
 133                          calls and/or code in these early PPIs
 134   @param Data            Pointer to old core data that is used to initialize the
 135                          core's data areas.
 136                          If NULL, it is first PeiCore entering.
 137
 138 **/
 139 VOID
 140 EFIAPI
 141 PeiCore (
 142   IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreDataPtr,
 143   IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,
 144   IN VOID                              *Data
 145   )
 146 {
 147   PEI_CORE_INSTANCE           PrivateData;
 148   EFI_SEC_PEI_HAND_OFF        *SecCoreData;
 149   EFI_SEC_PEI_HAND_OFF        NewSecCoreData;
 150   EFI_STATUS                  Status;
 151   PEI_CORE_TEMP_POINTERS      TempPtr;
 152   PEI_CORE_INSTANCE           *OldCoreData;
 153   EFI_PEI_CPU_IO_PPI          *CpuIo;
 154   EFI_PEI_PCI_CFG2_PPI        *PciCfg;
 155   EFI_HOB_HANDOFF_INFO_TABLE  *HandoffInformationTable;
 156   EFI_PEI_TEMPORARY_RAM_DONE_PPI *TemporaryRamDonePpi;
 157   UINTN                       Index;
 158
 159   //
 160   // Retrieve context passed into PEI Core
 161   //
 162   OldCoreData = (PEI_CORE_INSTANCE *) Data;
 163   SecCoreData = (EFI_SEC_PEI_HAND_OFF *) SecCoreDataPtr;
 164
 165   //
 166   // Perform PEI Core phase specific actions.
 167   //
 168   if (OldCoreData == NULL) {
 169     //
 170     // If OldCoreData is NULL, means current is the first entry into the PEI Core before memory is available.
 171     //
 172     ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));
 173     PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;
 174     CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));
 175   } else {
 176     //
 177     // Memory is available to the PEI Core.  See if the PEI Core has been shadowed to memory yet.
 178     //
 179     if (OldCoreData->ShadowedPeiCore == NULL) {
 180       //
 181       // Fixup the PeiCore's private data
 182       //
 183       OldCoreData->Ps    = &OldCoreData->ServiceTableShadow;
 184       OldCoreData->CpuIo = &OldCoreData->ServiceTableShadow.CpuIo;
 185       if (OldCoreData->HeapOffsetPositive) {
 186         OldCoreData->HobList.Raw = (VOID *)(OldCoreData->HobList.Raw + OldCoreData->HeapOffset);
 187         OldCoreData->UnknownFvInfo        = (PEI_CORE_UNKNOW_FORMAT_FV_INFO *) ((UINT8 *) OldCoreData->UnknownFvInfo + OldCoreData->HeapOffset);
 188         if (OldCoreData->CurrentFvFileHandles != NULL) {
 189           OldCoreData->CurrentFvFileHandles = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->CurrentFvFileHandles + OldCoreData->HeapOffset);
 190         }
 191         OldCoreData->PpiData.PpiListPtrs  = (PEI_PPI_LIST_POINTERS *) ((UINT8 *) OldCoreData->PpiData.PpiListPtrs + OldCoreData->HeapOffset);
 192         OldCoreData->Fv                   = (PEI_CORE_FV_HANDLE *) ((UINT8 *) OldCoreData->Fv + OldCoreData->HeapOffset);
 193         for (Index = 0; Index < PcdGet32 (PcdPeiCoreMaxFvSupported); Index ++) {
 194           if (OldCoreData->Fv[Index].PeimState != NULL) {
 195             OldCoreData->Fv[Index].PeimState     = (UINT8 *) OldCoreData->Fv[Index].PeimState + OldCoreData->HeapOffset;
 196           }
 197           if (OldCoreData->Fv[Index].FvFileHandles != NULL) {
 198             OldCoreData->Fv[Index].FvFileHandles = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->Fv[Index].FvFileHandles + OldCoreData->HeapOffset);
 199           }
 200         }
 201         OldCoreData->TempFileGuid         = (EFI_GUID *) ((UINT8 *) OldCoreData->TempFileGuid + OldCoreData->HeapOffset);
 202         OldCoreData->TempFileHandles      = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->TempFileHandles + OldCoreData->HeapOffset);
 203       } else {
 204         OldCoreData->HobList.Raw = (VOID *)(OldCoreData->HobList.Raw - OldCoreData->HeapOffset);
 205         OldCoreData->UnknownFvInfo        = (PEI_CORE_UNKNOW_FORMAT_FV_INFO *) ((UINT8 *) OldCoreData->UnknownFvInfo - OldCoreData->HeapOffset);
 206         if (OldCoreData->CurrentFvFileHandles != NULL) {
 207           OldCoreData->CurrentFvFileHandles = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->CurrentFvFileHandles - OldCoreData->HeapOffset);
 208         }
 209         OldCoreData->PpiData.PpiListPtrs  = (PEI_PPI_LIST_POINTERS *) ((UINT8 *) OldCoreData->PpiData.PpiListPtrs - OldCoreData->HeapOffset);
 210         OldCoreData->Fv                   = (PEI_CORE_FV_HANDLE *) ((UINT8 *) OldCoreData->Fv - OldCoreData->HeapOffset);
 211         for (Index = 0; Index < PcdGet32 (PcdPeiCoreMaxFvSupported); Index ++) {
 212           if (OldCoreData->Fv[Index].PeimState != NULL) {
 213             OldCoreData->Fv[Index].PeimState     = (UINT8 *) OldCoreData->Fv[Index].PeimState - OldCoreData->HeapOffset;
 214           }
 215           if (OldCoreData->Fv[Index].FvFileHandles != NULL) {
 216             OldCoreData->Fv[Index].FvFileHandles = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->Fv[Index].FvFileHandles - OldCoreData->HeapOffset);
 217           }
 218         }
 219         OldCoreData->TempFileGuid         = (EFI_GUID *) ((UINT8 *) OldCoreData->TempFileGuid - OldCoreData->HeapOffset);
 220         OldCoreData->TempFileHandles      = (EFI_PEI_FILE_HANDLE *) ((UINT8 *) OldCoreData->TempFileHandles - OldCoreData->HeapOffset);
 221       }
 222
 223       //
 224       // Fixup for PeiService's address
 225       //
 226       SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES **)&OldCoreData->Ps);
 227
 228       //
 229       // Initialize libraries that the PEI Core is linked against
 230       //
 231       ProcessLibraryConstructorList (NULL, (CONST EFI_PEI_SERVICES **)&OldCoreData->Ps);
 232
 233       //
 234       // Update HandOffHob for new installed permanent memory
 235       //
 236       HandoffInformationTable = OldCoreData->HobList.HandoffInformationTable;
 237       if (OldCoreData->HeapOffsetPositive) {
 238         HandoffInformationTable->EfiEndOfHobList   = HandoffInformationTable->EfiEndOfHobList + OldCoreData->HeapOffset;
 239       } else {
 240         HandoffInformationTable->EfiEndOfHobList   = HandoffInformationTable->EfiEndOfHobList - OldCoreData->HeapOffset;
 241       }
 242       HandoffInformationTable->EfiMemoryTop        = OldCoreData->PhysicalMemoryBegin + OldCoreData->PhysicalMemoryLength;
 243       HandoffInformationTable->EfiMemoryBottom     = OldCoreData->PhysicalMemoryBegin;
 244       HandoffInformationTable->EfiFreeMemoryTop    = OldCoreData->FreePhysicalMemoryTop;
 245       HandoffInformationTable->EfiFreeMemoryBottom = HandoffInformationTable->EfiEndOfHobList + sizeof (EFI_HOB_GENERIC_HEADER);
 246
 247       //
 248       // We need convert MemoryBaseAddress in memory allocation HOBs
 249       //
 250       ConvertMemoryAllocationHobs (OldCoreData);
 251
 252       //
 253       // We need convert the PPI descriptor's pointer
 254       //
 255       ConvertPpiPointers (SecCoreData, OldCoreData);
 256
 257       //
 258       // After the whole temporary memory is migrated, then we can allocate page in
 259       // permanent memory.
 260       //
 261       OldCoreData->PeiMemoryInstalled = TRUE;
 262
 263       //
 264       // Indicate that PeiCore reenter
 265       //
 266       OldCoreData->PeimDispatcherReenter = TRUE;
 267
 268       if (PcdGet64(PcdLoadModuleAtFixAddressEnable) != 0 && (OldCoreData->HobList.HandoffInformationTable->BootMode != BOOT_ON_S3_RESUME)) {
 269         //
 270         // if Loading Module at Fixed Address is enabled, allocate the PEI code memory range usage bit map array.
 271         // Every bit in the array indicate the status of the corresponding memory page available or not
 272         //
 273         OldCoreData->PeiCodeMemoryRangeUsageBitMap = AllocateZeroPool (((PcdGet32(PcdLoadFixAddressPeiCodePageNumber)>>6) + 1)*sizeof(UINT64));
 274       }
 275
 276       //
 277       // Shadow PEI Core. When permanent memory is avaiable, shadow
 278       // PEI Core and PEIMs to get high performance.
 279       //
 280       OldCoreData->ShadowedPeiCore = (PEICORE_FUNCTION_POINTER) (UINTN) PeiCore;
 281       if ((HandoffInformationTable->BootMode == BOOT_ON_S3_RESUME && PcdGetBool (PcdShadowPeimOnS3Boot))
 282           || (HandoffInformationTable->BootMode != BOOT_ON_S3_RESUME && PcdGetBool (PcdShadowPeimOnBoot))) {
 283         OldCoreData->ShadowedPeiCore = ShadowPeiCore (OldCoreData);
 284       }
 285
 286       //
 287       // PEI Core has now been shadowed to memory.  Restart PEI Core in memory.
 288       //
 289       OldCoreData->ShadowedPeiCore (SecCoreData, PpiList, OldCoreData);
 290
 291       //
 292       // Should never reach here.
 293       //
 294       ASSERT (FALSE);
 295       CpuDeadLoop();
 296
 297       UNREACHABLE ();
 298     }
 299
 300     //
 301     // Memory is available to the PEI Core and the PEI Core has been shadowed to memory.
 302     //
 303     CopyMem (&NewSecCoreData, SecCoreDataPtr, sizeof (NewSecCoreData));
 304     SecCoreData = &NewSecCoreData;
 305
 306     CopyMem (&PrivateData, OldCoreData, sizeof (PrivateData));
 307
 308     CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;
 309     PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;
 310
 311     CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));
 312
 313     PrivateData.ServiceTableShadow.CpuIo  = CpuIo;
 314     PrivateData.ServiceTableShadow.PciCfg = PciCfg;
 315   }
 316
 317   //
 318   // Cache a pointer to the PEI Services Table that is either in temporary memory or permanent memory
 319   //
 320   PrivateData.Ps = &PrivateData.ServiceTableShadow;
 321
 322   //
 323   // Save PeiServicePointer so that it can be retrieved anywhere.
 324   //
 325   SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES **)&PrivateData.Ps);
 326
 327   //
 328   // Initialize libraries that the PEI Core is linked against
 329   //
 330   ProcessLibraryConstructorList (NULL, (CONST EFI_PEI_SERVICES **)&PrivateData.Ps);
 331
 332   //
 333   // Initialize PEI Core Services
 334   //
 335   InitializeMemoryServices   (&PrivateData, SecCoreData, OldCoreData);
 336   if (OldCoreData == NULL) {
 337     //
 338     // Initialize PEI Core Private Data Buffer
 339     //
 340     PrivateData.PpiData.PpiListPtrs  = AllocateZeroPool (sizeof (PEI_PPI_LIST_POINTERS) * PcdGet32 (PcdPeiCoreMaxPpiSupported));
 341     ASSERT (PrivateData.PpiData.PpiListPtrs != NULL);
 342     PrivateData.Fv                   = AllocateZeroPool (sizeof (PEI_CORE_FV_HANDLE) * PcdGet32 (PcdPeiCoreMaxFvSupported));
 343     ASSERT (PrivateData.Fv != NULL);
 344     PrivateData.UnknownFvInfo        = AllocateZeroPool (sizeof (PEI_CORE_UNKNOW_FORMAT_FV_INFO) * PcdGet32 (PcdPeiCoreMaxFvSupported));
 345     ASSERT (PrivateData.UnknownFvInfo != NULL);
 346   }
 347   InitializePpiServices      (&PrivateData,    OldCoreData);
 348
 349   //
 350   // Update performance measurements
 351   //
 352   if (OldCoreData == NULL) {
 353     PERF_EVENT ("SEC"); // Means the end of SEC phase.
 354
 355     //
 356     // If first pass, start performance measurement.
 357     //
 358     PERF_CROSSMODULE_BEGIN ("PEI");
 359     PERF_INMODULE_BEGIN ("PreMem");
 360
 361   } else {
 362     PERF_INMODULE_END ("PreMem");
 363     PERF_INMODULE_BEGIN ("PostMem");
 364   }
 365
 366   //
 367   // Complete PEI Core Service initialization
 368   //
 369   InitializeSecurityServices (&PrivateData.Ps, OldCoreData);
 370   InitializeDispatcherData   (&PrivateData,    OldCoreData, SecCoreData);
 371   InitializeImageServices    (&PrivateData,    OldCoreData);
 372
 373   //
 374   // Perform PEI Core Phase specific actions
 375   //
 376   if (OldCoreData == NULL) {
 377     //
 378     // Report Status Code EFI_SW_PC_INIT
 379     //
 380     REPORT_STATUS_CODE (
 381       EFI_PROGRESS_CODE,
 382       (EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT)
 383       );
 384
 385     //
 386     // If SEC provided the PpiList, process it.
 387     //
 388     if (PpiList != NULL) {
 389       ProcessPpiListFromSec ((CONST EFI_PEI_SERVICES **) &PrivateData.Ps, PpiList);
 390     }
 391   } else {
 392     //
 393     // Try to locate Temporary RAM Done Ppi.
 394     //
 395     Status = PeiServicesLocatePpi (
 396                &gEfiTemporaryRamDonePpiGuid,
 397                0,
 398                NULL,
 399                (VOID**)&TemporaryRamDonePpi
 400                );
 401     if (!EFI_ERROR (Status)) {
 402       //
 403       // Disable the use of Temporary RAM after the transition from Temporary RAM to Permanent RAM is complete.
 404       //
 405       TemporaryRamDonePpi->TemporaryRamDone ();
 406     }
 407
 408     //
 409     // Alert any listeners that there is permanent memory available
 410     //
 411     PERF_INMODULE_BEGIN ("DisMem");
 412     Status = PeiServicesInstallPpi (&mMemoryDiscoveredPpi);
 413
 414     //
 415     // Process the Notify list and dispatch any notifies for the Memory Discovered PPI
 416     //
 417     ProcessNotifyList (&PrivateData);
 418
 419     PERF_INMODULE_END ("DisMem");
 420   }
 421
 422   //
 423   // Call PEIM dispatcher
 424   //
 425   PeiDispatcher (SecCoreData, &PrivateData);
 426
 427   if (PrivateData.HobList.HandoffInformationTable->BootMode != BOOT_ON_S3_RESUME) {
 428     //
 429     // Check if InstallPeiMemory service was called on non-S3 resume boot path.
 430     //
 431     ASSERT(PrivateData.PeiMemoryInstalled == TRUE);
 432   }
 433
 434   //
 435   // Measure PEI Core execution time.
 436   //
 437   PERF_INMODULE_END ("PostMem");
 438
 439   //
 440   // Lookup DXE IPL PPI
 441   //
 442   Status = PeiServicesLocatePpi (
 443              &gEfiDxeIplPpiGuid,
 444              0,
 445              NULL,
 446              (VOID **)&TempPtr.DxeIpl
 447              );
 448   ASSERT_EFI_ERROR (Status);
 449
 450   if (EFI_ERROR (Status)) {
 451     //
 452     // Report status code to indicate DXE IPL PPI could not be found.
 453     //
 454     REPORT_STATUS_CODE (
 455       EFI_ERROR_CODE | EFI_ERROR_MAJOR,
 456       (EFI_SOFTWARE_PEI_CORE | EFI_SW_PEI_CORE_EC_DXEIPL_NOT_FOUND)
 457       );
 458     CpuDeadLoop ();
 459   }
 460
 461   //
 462   // Enter DxeIpl to load Dxe core.
 463   //
 464   DEBUG ((EFI_D_INFO, "DXE IPL Entry\n"));
 465   Status = TempPtr.DxeIpl->Entry (
 466                              TempPtr.DxeIpl,
 467                              &PrivateData.Ps,
 468                              PrivateData.HobList
 469                              );
 470   //
 471   // Should never reach here.
 472   //
 473   ASSERT_EFI_ERROR (Status);
 474   CpuDeadLoop();
 475
 476   UNREACHABLE ();
 477 }