MdeModulePkg/Core/Pei/PeiMain/PeiMain.c

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   PeiMain.c
  15
  16 Abstract:
  17
  18   Pei Core Main Entry Point
  19
  20 Revision History
  21
  22 --*/
  23
  24 #include <PeiMain.h>
  25
  26 //
  27 //CAR is filled with this initial value during SEC phase
  28 //
  29 #define INIT_CAR_VALUE 0x5AA55AA5
  30
  31 static EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {
  32   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  33   &gEfiPeiMemoryDiscoveredPpiGuid,
  34   NULL
  35 };
  36
  37 //
  38 // Pei Core Module Variables
  39 //
  40 //
  41 static EFI_PEI_SERVICES  mPS = {
  42   {
  43     PEI_SERVICES_SIGNATURE,
  44     PEI_SERVICES_REVISION,
  45     sizeof (EFI_PEI_SERVICES),
  46     0,
  47     0
  48   },
  49   PeiInstallPpi,
  50   PeiReInstallPpi,
  51   PeiLocatePpi,
  52   PeiNotifyPpi,
  53
  54   PeiGetBootMode,
  55   PeiSetBootMode,
  56
  57   PeiGetHobList,
  58   PeiCreateHob,
  59
  60   PeiFvFindNextVolume,
  61   PeiFfsFindNextFile,
  62   PeiFfsFindSectionData,
  63
  64   PeiInstallPeiMemory,
  65   PeiAllocatePages,
  66   PeiAllocatePool,
  67   (EFI_PEI_COPY_MEM)CopyMem,
  68   (EFI_PEI_SET_MEM)SetMem,
  69
  70   PeiReportStatusCode,
  71   PeiResetSystem,
  72
  73   NULL,
  74   NULL,
  75
  76   PeiFfsFindFileByName,
  77   PeiFfsGetFileInfo,
  78   PeiFfsGetVolumeInfo,
  79   PeiRegisterForShadow
  80 };
  81
  82 EFI_STATUS
  83 EFIAPI
  84 PeiCore (
  85   IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,
  86   IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,
  87   IN VOID                              *Data
  88   )
  89 /*++
  90
  91 Routine Description:
  92
  93   The entry routine to Pei Core, invoked by PeiMain during transition
  94   from SEC to PEI. After switching stack in the PEI core, it will restart
  95   with the old core data.
  96
  97 Arguments:
  98
  99   SecCoreData          - Points to a data structure containing information about the PEI core's operating
 100                          environment, such as the size and location of temporary RAM, the stack location and
 101                          the BFV location.
 102   PpiList              - Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
 103                          An empty PPI list consists of a single descriptor with the end-tag
 104                          EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
 105                          phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
 106                          that both the PEI Foundation and any modules can leverage the associated service
 107                          calls and/or code in these early PPIs
 108   Data                 - Pointer to old core data that is used to initialize the
 109                          core's data areas.
 110
 111 Returns:
 112
 113   This function never returns
 114   EFI_NOT_FOUND        - Never reach
 115
 116 --*/
 117 {
 118   PEI_CORE_INSTANCE                                     PrivateData;
 119   EFI_STATUS                                            Status;
 120   PEI_CORE_TEMP_POINTERS                                TempPtr;
 121   UINT64                                                mTick;
 122   PEI_CORE_INSTANCE                                     *OldCoreData;
 123   EFI_PEI_CPU_IO_PPI                                    *CpuIo;
 124   EFI_PEI_PCI_CFG2_PPI                                  *PciCfg;
 125   UINT64                                                SecPlatformInfoRecordSize;
 126   EFI_SEC_PLATFORM_INFORMATION_PPI                      *SecPlatformInfoPpi;
 127   EFI_SEC_PLATFORM_INFORMATION_RECORD                   *SecPlatformInfoRecord;
 128
 129   mTick = 0;
 130   OldCoreData = (PEI_CORE_INSTANCE *) Data;
 131
 132   if (PerformanceMeasurementEnabled()) {
 133     if (OldCoreData == NULL) {
 134       mTick = GetPerformanceCounter ();
 135     }
 136   }
 137
 138   //
 139   // For IPF in CAR mode the real memory access is uncached,in InstallPeiMemory()
 140   //  the 63-bit of address is set to 1.
 141   //
 142   SWITCH_TO_CACHE_MODE (OldCoreData);
 143
 144   if (OldCoreData != NULL) {
 145     CopyMem (&PrivateData, OldCoreData, sizeof (PEI_CORE_INSTANCE));
 146
 147     CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;
 148     PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;
 149
 150     CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));
 151
 152     PrivateData.ServiceTableShadow.CpuIo  = CpuIo;
 153     PrivateData.ServiceTableShadow.PciCfg = PciCfg;
 154   } else {
 155     ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));
 156     PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;
 157     CopyMem (&PrivateData.ServiceTableShadow, &mPS, sizeof (mPS));
 158   }
 159
 160   PrivateData.PS = &PrivateData.ServiceTableShadow;
 161
 162   //
 163   // Initialize libraries that the PeiCore is linked against
 164   // BUGBUG: The FileHandle is passed in as NULL.  Do we look it up or remove it from the lib init?
 165   //
 166   ProcessLibraryConstructorList (NULL, &PrivateData.PS);
 167
 168   InitializeMemoryServices (&PrivateData, SecCoreData, OldCoreData);
 169
 170   InitializePpiServices (&PrivateData, OldCoreData);
 171
 172   //
 173   // Save PeiServicePointer so that it can be retrieved anywhere.
 174   //
 175   SetPeiServicesTablePointer(&PrivateData.PS);
 176
 177   if (OldCoreData != NULL) {
 178
 179     PERF_END (NULL,"PreMem", NULL, 0);
 180     PERF_START (NULL,"PostMem", NULL, 0);
 181
 182     //
 183     // The following code dumps out interesting cache as RAM usage information
 184     // so we can keep tabs on how the cache as RAM is being utilized.  The
 185     // DEBUG_CODE_BEGIN macro is used to prevent this code from being compiled
 186     // on a debug build.
 187     //
 188     DEBUG_CODE_BEGIN ();
 189       UINTN  *StackPointer;
 190       UINTN  StackValue;
 191
 192       StackValue = INIT_CAR_VALUE;
 193       for (StackPointer = (UINTN *) OldCoreData->MaxTopOfCarHeap;
 194            ((UINTN) StackPointer < ((UINTN) OldCoreData->BottomOfCarHeap + OldCoreData->SizeOfCacheAsRam))
 195            && StackValue == INIT_CAR_VALUE;
 196            StackPointer++) {
 197         StackValue = *StackPointer;
 198       }
 199
 200       DEBUG ((EFI_D_INFO, "Total Cache as RAM:    %d bytes.\n", OldCoreData->SizeOfCacheAsRam));
 201       DEBUG ((EFI_D_INFO, "  CAR stack ever used: %d bytes.\n",
 202         ((UINTN) OldCoreData->TopOfCarHeap - (UINTN) StackPointer)
 203         ));
 204       DEBUG ((EFI_D_INFO, "  CAR heap used:       %d bytes.\n",
 205         ((UINTN) OldCoreData->HobList.HandoffInformationTable->EfiFreeMemoryBottom -
 206         (UINTN) OldCoreData->HobList.Raw)
 207         ));
 208     DEBUG_CODE_END ();
 209
 210     //
 211     // Alert any listeners that there is permanent memory available
 212     //
 213
 214     PERF_START (NULL,"DisMem", NULL, 0);
 215     Status = PeiServicesInstallPpi (&mMemoryDiscoveredPpi);
 216     PERF_END (NULL,"DisMem", NULL, 0);
 217
 218   } else {
 219
 220     //
 221     // Report Status Code EFI_SW_PC_INIT
 222     //
 223     REPORT_STATUS_CODE (
 224       EFI_PROGRESS_CODE,
 225       EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT
 226       );
 227
 228     PERF_START (NULL,"PEI", NULL, mTick);
 229     //
 230     // If first pass, start performance measurement.
 231     //
 232     PERF_START (NULL,"PreMem", NULL, mTick);
 233
 234     //
 235     // If SEC provided any PPI services to PEI, install them.
 236     //
 237     if (PpiList != NULL) {
 238       Status = PeiServicesInstallPpi (PpiList);
 239       ASSERT_EFI_ERROR (Status);
 240
 241       //
 242       // PI spec Vol 1, 7.3.1 specifies that this same information reported by EFI_SEC_PLATFORM_INFORMATION_PPI
 243       // will be placed in a GUIDed HOB with the PPI GUID as the HOB GUID for HOB consumer phase.
 244       //
 245       Status = PeiServicesLocatePpi (
 246                  &gEfiSecPlatformInformationPpiGuid,
 247                  0,
 248                  NULL,
 249                  (VOID **) &SecPlatformInfoPpi
 250                  );
 251       if (!EFI_ERROR (Status)) {
 252         SecPlatformInfoRecord = AllocateZeroPool (sizeof(*SecPlatformInfoRecord));
 253         ASSERT (SecPlatformInfoRecord != NULL);
 254
 255         SecPlatformInfoRecordSize = sizeof(*SecPlatformInfoRecord);
 256
 257         Status = SecPlatformInfoPpi->PlatformInformation (
 258                    (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer (),
 259                    &SecPlatformInfoRecordSize,
 260                    SecPlatformInfoRecord
 261                    );
 262
 263         if (!EFI_ERROR (Status)) {
 264           BuildGuidDataHob (
 265             &gEfiSecPlatformInformationPpiGuid,
 266             SecPlatformInfoRecord,
 267             sizeof (*SecPlatformInfoRecord)
 268             );
 269         }
 270       }
 271     }
 272   }
 273
 274   InitializeSecurityServices (&PrivateData.PS, OldCoreData);
 275
 276   InitializeDispatcherData (&PrivateData, OldCoreData, SecCoreData);
 277
 278   //
 279   // Install Pei Load File PPI.
 280   //
 281   InitializeImageServices (&PrivateData, OldCoreData);
 282
 283   //
 284   // Call PEIM dispatcher
 285   //
 286   PeiDispatcher (SecCoreData, &PrivateData);
 287
 288   //
 289   // Check if InstallPeiMemory service was called.
 290   //
 291   ASSERT(PrivateData.PeiMemoryInstalled == TRUE);
 292
 293   PERF_END (NULL, "PostMem", NULL, 0);
 294
 295   Status = PeiServicesLocatePpi (
 296              &gEfiDxeIplPpiGuid,
 297              0,
 298              NULL,
 299              (VOID **)&TempPtr.DxeIpl
 300              );
 301   ASSERT_EFI_ERROR (Status);
 302
 303   DEBUG ((EFI_D_INFO, "DXE IPL Entry\n"));
 304   Status = TempPtr.DxeIpl->Entry (
 305                              TempPtr.DxeIpl,
 306                              &PrivateData.PS,
 307                              PrivateData.HobList
 308                              );
 309
 310   ASSERT_EFI_ERROR (Status);
 311
 312   return EFI_NOT_FOUND;
 313 }
 314