Fix function comment to follows doxygen format.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / PeiMain / PeiMain.c

/** @file\r
  Pei Core Main Entry Point\r
  \r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <PeiMain.h>\r
\r
STATIC EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMemoryDiscoveredPpiGuid,\r
  NULL\r
};\r
\r
//\r
// Pei Core Module Variables\r
//\r
//\r
STATIC EFI_PEI_SERVICES  gPs = {\r
  {\r
    PEI_SERVICES_SIGNATURE,\r
    PEI_SERVICES_REVISION,\r
    sizeof (EFI_PEI_SERVICES),\r
    0,\r
    0\r
  },\r
  PeiInstallPpi,\r
  PeiReInstallPpi,\r
  PeiLocatePpi,\r
  PeiNotifyPpi,\r
\r
  PeiGetBootMode,\r
  PeiSetBootMode,\r
\r
  PeiGetHobList,\r
  PeiCreateHob,\r
\r
  PeiFvFindNextVolume,\r
  PeiFfsFindNextFile,\r
  PeiFfsFindSectionData,\r
\r
  PeiInstallPeiMemory,      \r
  PeiAllocatePages,\r
  PeiAllocatePool,\r
  (EFI_PEI_COPY_MEM)CopyMem,\r
  (EFI_PEI_SET_MEM)SetMem,\r
\r
  PeiReportStatusCode,\r
  PeiResetSystem,\r
\r
  NULL,\r
  NULL,\r
\r
  PeiFfsFindFileByName,\r
  PeiFfsGetFileInfo,\r
  PeiFfsGetVolumeInfo,\r
  PeiRegisterForShadow\r
};\r
\r
/**\r
\r
  The entry routine to Pei Core, invoked by PeiMain during transition\r
  from SEC to PEI. After switching stack in the PEI core, it will restart\r
  with the old core data.\r
\r
\r
  @param SecCoreData     Points to a data structure containing information about the PEI core's operating\r
                         environment, such as the size and location of temporary RAM, the stack location and\r
                         the BFV location.\r
  @param PpiList         Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
                         An empty PPI list consists of a single descriptor with the end-tag\r
                         EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
                         phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r
                         that both the PEI Foundation and any modules can leverage the associated service\r
                         calls and/or code in these early PPIs\r
  @param Data            Pointer to old core data that is used to initialize the\r
                         core's data areas.\r
\r
  @retval EFI_NOT_FOUND  Never reach\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCore (\r
  IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,\r
  IN VOID                              *Data\r
  )\r
{\r
  PEI_CORE_INSTANCE                                     PrivateData;\r
  EFI_STATUS                                            Status;\r
  PEI_CORE_TEMP_POINTERS                                TempPtr;\r
  UINT64                                                mTick;\r
  PEI_CORE_INSTANCE                                     *OldCoreData;\r
  EFI_PEI_CPU_IO_PPI                                    *CpuIo;\r
  EFI_PEI_PCI_CFG2_PPI                                  *PciCfg;\r
  PEI_CORE_ENTRY_POINT                                  ShadowedPeiCore;\r
\r
  mTick = 0;\r
  OldCoreData = (PEI_CORE_INSTANCE *) Data;\r
\r
  if (PerformanceMeasurementEnabled()) {\r
    if (OldCoreData == NULL) {\r
      mTick = GetPerformanceCounter ();\r
    }\r
  }\r
\r
  if (OldCoreData != NULL) {\r
    ShadowedPeiCore = (PEI_CORE_ENTRY_POINT) (UINTN) OldCoreData->ShadowedPeiCore;\r
    if (ShadowedPeiCore != NULL) {\r
      OldCoreData->ShadowedPeiCore = NULL;\r
      ShadowedPeiCore (\r
        SecCoreData,\r
        PpiList,\r
        OldCoreData\r
        );\r
    }\r
\r
    CopyMem (&PrivateData, OldCoreData, sizeof (PEI_CORE_INSTANCE));\r
    \r
    CpuIo = (VOID*)PrivateData.ServiceTableShadow.CpuIo;\r
    PciCfg = (VOID*)PrivateData.ServiceTableShadow.PciCfg;\r
    \r
    CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));\r
    \r
    PrivateData.ServiceTableShadow.CpuIo  = CpuIo;\r
    PrivateData.ServiceTableShadow.PciCfg = PciCfg;\r
  } else {\r
    ZeroMem (&PrivateData, sizeof (PEI_CORE_INSTANCE));\r
    PrivateData.Signature = PEI_CORE_HANDLE_SIGNATURE;\r
    CopyMem (&PrivateData.ServiceTableShadow, &gPs, sizeof (gPs));\r
  }\r
\r
  PrivateData.PS = &PrivateData.ServiceTableShadow;\r
\r
  //\r
  // Initialize libraries that the PeiCore is linked against\r
  // BUGBUG: The FileHandle is passed in as NULL.  Do we look it up or remove it from the lib init?\r
  //\r
  ProcessLibraryConstructorList (NULL, &PrivateData.PS);\r
\r
  InitializeMemoryServices (&PrivateData, SecCoreData, OldCoreData);\r
\r
  InitializePpiServices (&PrivateData, OldCoreData);\r
\r
  //\r
  // Save PeiServicePointer so that it can be retrieved anywhere.\r
  //\r
  SetPeiServicesTablePointer(&PrivateData.PS);\r
  \r
  if (OldCoreData != NULL) {\r
\r
    PERF_END (NULL,"PreMem", NULL, 0);\r
    PERF_START (NULL,"PostMem", NULL, 0);\r
\r
    //\r
    // Alert any listeners that there is permanent memory available\r
    //\r
    \r
    PERF_START (NULL,"DisMem", NULL, 0);\r
    Status = PeiServicesInstallPpi (&mMemoryDiscoveredPpi);\r
    PERF_END (NULL,"DisMem", NULL, 0);\r
\r
  } else {\r
\r
    //\r
    // Report Status Code EFI_SW_PC_INIT\r
    //\r
    REPORT_STATUS_CODE (\r
      EFI_PROGRESS_CODE,\r
      FixedPcdGet32 (PcdStatusCodeValuePeiCoreEntry)\r
      );\r
\r
    PERF_START (NULL,"PEI", NULL, mTick);\r
    //\r
    // If first pass, start performance measurement.\r
    //\r
    PERF_START (NULL,"PreMem", NULL, mTick);\r
\r
    //\r
    // If SEC provided any PPI services to PEI, install them.\r
    //\r
    if (PpiList != NULL) {\r
      Status = PeiServicesInstallPpi (PpiList);\r
      ASSERT_EFI_ERROR (Status);\r
    }\r
  }\r
\r
  InitializeSecurityServices (&PrivateData.PS, OldCoreData);\r
\r
  InitializeDispatcherData (&PrivateData, OldCoreData, SecCoreData);\r
\r
  //\r
  // Install Pei Load File PPI. \r
  //\r
  InitializeImageServices (&PrivateData, OldCoreData);\r
\r
  //\r
  // Call PEIM dispatcher\r
  //\r
  PeiDispatcher (SecCoreData, &PrivateData);\r
\r
  //\r
  // Check if InstallPeiMemory service was called.\r
  //\r
  ASSERT(PrivateData.PeiMemoryInstalled == TRUE);\r
\r
  PERF_END (NULL, "PostMem", NULL, 0);\r
\r
  Status = PeiServicesLocatePpi (\r
             &gEfiDxeIplPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&TempPtr.DxeIpl\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  DEBUG ((EFI_D_INFO, "DXE IPL Entry\n"));\r
  Status = TempPtr.DxeIpl->Entry (\r
                             TempPtr.DxeIpl,\r
                             &PrivateData.PS,\r
                             PrivateData.HobList\r
                             );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r