]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/DxeIplPeim/DxeLoad.c
MdeModulePkg PiSmmCore: Set ForwardLink to NULL in RemoveOldEntry()
[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeLoad.c
index 87fc18cfaed339f6610841abeb8a38fdb27a9de3..178bac47e4d2c35b75a82a0d0efd514759cd7032 100644 (file)
@@ -2,7 +2,8 @@
   Last PEIM.\r
   Responsibility of this module is to load the DXE Core from a Firmware Volume.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2016 HP Development Company, L.P.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -24,6 +25,12 @@ CONST EFI_DXE_IPL_PPI mDxeIplPpi = {
   DxeLoadCore\r
 };\r
 \r
+CONST EFI_PEI_PPI_DESCRIPTOR mDxeIplPpiList = {\r
+  EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
+  &gEfiDxeIplPpiGuid,\r
+  (VOID *) &mDxeIplPpi\r
+};\r
+\r
 CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI mCustomGuidedSectionExtractionPpi = {\r
   CustomGuidedSectionExtract\r
 };\r
@@ -32,17 +39,10 @@ CONST EFI_PEI_DECOMPRESS_PPI mDecompressPpi = {
   Decompress\r
 };\r
 \r
-CONST EFI_PEI_PPI_DESCRIPTOR mPpiList[] = {\r
-  {\r
-    EFI_PEI_PPI_DESCRIPTOR_PPI,\r
-    &gEfiDxeIplPpiGuid,\r
-    (VOID *) &mDxeIplPpi\r
-  },\r
-  {\r
-    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
-    &gEfiPeiDecompressPpiGuid,\r
-    (VOID *) &mDecompressPpi\r
-  }\r
+CONST EFI_PEI_PPI_DESCRIPTOR mDecompressPpiList = {\r
+  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+  &gEfiPeiDecompressPpiGuid,\r
+  (VOID *) &mDecompressPpi\r
 };\r
 \r
 CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi = {\r
@@ -51,10 +51,16 @@ CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi = {
   NULL\r
 };\r
 \r
+CONST EFI_PEI_NOTIFY_DESCRIPTOR mMemoryDiscoveredNotifyList = {\r
+  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
+  &gEfiPeiMemoryDiscoveredPpiGuid,\r
+  InstallIplPermanentMemoryPpis\r
+};\r
+\r
 /**\r
   Entry point of DXE IPL PEIM.\r
-  \r
-  This function installs DXE IPL PPI and Decompress PPI.  It also reloads\r
+\r
+  This function installs DXE IPL PPI.  It also reloads\r
   itself to memory on non-S3 resume boot path.\r
 \r
   @param  FileHandle  Handle of the file being invoked.\r
@@ -73,10 +79,8 @@ PeimInitializeDxeIpl (
 {\r
   EFI_STATUS                                Status;\r
   EFI_BOOT_MODE                             BootMode;\r
-  EFI_GUID                                  *ExtractHandlerGuidTable;\r
-  UINTN                                     ExtractHandlerNumber;\r
-  EFI_PEI_PPI_DESCRIPTOR                    *GuidPpi;\r
-  \r
+  VOID                                      *Dummy;\r
+\r
   BootMode = GetBootModeHob ();\r
 \r
   if (BootMode != BOOT_ON_S3_RESUME) {\r
@@ -87,43 +91,150 @@ PeimInitializeDxeIpl (
       // \r
       return Status;\r
     }\r
-    \r
+\r
     //\r
     // Ensure that DXE IPL is shadowed to permanent memory.\r
     //\r
     ASSERT (Status == EFI_ALREADY_STARTED);\r
-     \r
+\r
     //\r
-    // Get custom extract guided section method guid list \r
+    // DXE core load requires permanent memory.\r
     //\r
-    ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
-    \r
+    Status = PeiServicesLocatePpi (\r
+               &gEfiPeiMemoryDiscoveredPpiGuid,\r
+               0,\r
+               NULL,\r
+               (VOID **) &Dummy\r
+               );\r
+    ASSERT_EFI_ERROR (Status);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+\r
     //\r
-    // Install custom extraction guid PPI\r
-    //\r
-    if (ExtractHandlerNumber > 0) {\r
-      GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePool (ExtractHandlerNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
-      ASSERT (GuidPpi != NULL);\r
-      while (ExtractHandlerNumber-- > 0) {\r
-        GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
-        GuidPpi->Ppi   = (VOID *) &mCustomGuidedSectionExtractionPpi;\r
-        GuidPpi->Guid  = &ExtractHandlerGuidTable[ExtractHandlerNumber];\r
-        Status = PeiServicesInstallPpi (GuidPpi++);\r
-        ASSERT_EFI_ERROR(Status);\r
-      }\r
+    // Now the permanent memory exists, install the PPIs for decompression\r
+    // and section extraction.\r
+    //\r
+    Status = InstallIplPermanentMemoryPpis (NULL, NULL, NULL);\r
+    ASSERT_EFI_ERROR (Status);    \r
+  } else {\r
+    //\r
+    // Install memory discovered PPI notification to install PPIs for\r
+    // decompression and section extraction.\r
+    //\r
+    Status = PeiServicesNotifyPpi (&mMemoryDiscoveredNotifyList);\r
+    ASSERT_EFI_ERROR (Status);\r
+  }\r
+\r
+  //\r
+  // Install DxeIpl PPI.\r
+  //\r
+  Status = PeiServicesInstallPpi (&mDxeIplPpiList);\r
+  ASSERT_EFI_ERROR(Status);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+   This function installs the PPIs that require permanent memory.\r
+\r
+   @param  PeiServices      Indirect reference to the PEI Services Table.\r
+   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
+   @param  Ppi              Address of the PPI that was installed.\r
+\r
+   @return EFI_SUCCESS      The PPIs were installed successfully.\r
+   @return Others           Some error occurs during the execution of this function.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InstallIplPermanentMemoryPpis (\r
+  IN EFI_PEI_SERVICES           **PeiServices,\r
+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
+  IN VOID                       *Ppi\r
+  )\r
+{\r
+  EFI_STATUS                    Status;\r
+  EFI_GUID                      *ExtractHandlerGuidTable;\r
+  UINTN                         ExtractHandlerNumber;\r
+  EFI_PEI_PPI_DESCRIPTOR        *GuidPpi;\r
+\r
+  //\r
+  // Get custom extract guided section method guid list \r
+  //\r
+  ExtractHandlerNumber = ExtractGuidedSectionGetGuidList (&ExtractHandlerGuidTable);\r
+\r
+  //\r
+  // Install custom guided section extraction PPI\r
+  //\r
+  if (ExtractHandlerNumber > 0) {\r
+    GuidPpi = (EFI_PEI_PPI_DESCRIPTOR *) AllocatePool (ExtractHandlerNumber * sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
+    ASSERT (GuidPpi != NULL);\r
+    while (ExtractHandlerNumber-- > 0) {\r
+      GuidPpi->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
+      GuidPpi->Ppi   = (VOID *) &mCustomGuidedSectionExtractionPpi;\r
+      GuidPpi->Guid  = &ExtractHandlerGuidTable[ExtractHandlerNumber];\r
+      Status = PeiServicesInstallPpi (GuidPpi++);\r
+      ASSERT_EFI_ERROR(Status);\r
     }\r
-    \r
   }\r
-  \r
+\r
   //\r
-  // Install DxeIpl and Decompress PPIs.\r
+  // Install Decompress PPI.\r
   //\r
-  Status = PeiServicesInstallPpi (mPpiList);\r
+  Status = PeiServicesInstallPpi (&mDecompressPpiList);\r
   ASSERT_EFI_ERROR(Status);\r
 \r
   return Status;\r
 }\r
 \r
+/**\r
+   Validate variable data for the MemoryTypeInformation. \r
+\r
+   @param MemoryData       Variable data.\r
+   @param MemoryDataSize   Variable data length.\r
+\r
+   @return TRUE            The variable data is valid.\r
+   @return FALSE           The variable data is invalid.\r
+\r
+**/\r
+BOOLEAN\r
+ValidateMemoryTypeInfoVariable (\r
+  IN EFI_MEMORY_TYPE_INFORMATION      *MemoryData,\r
+  IN UINTN                            MemoryDataSize\r
+  )\r
+{\r
+  UINTN                       Count;\r
+  UINTN                       Index;\r
+\r
+  // Check the input parameter.\r
+  if (MemoryData == NULL) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Get Count\r
+  Count = MemoryDataSize / sizeof (*MemoryData);\r
+\r
+  // Check Size\r
+  if (Count * sizeof(*MemoryData) != MemoryDataSize) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Check last entry type filed.\r
+  if (MemoryData[Count - 1].Type != EfiMaxMemoryType) {\r
+    return FALSE;\r
+  }\r
+\r
+  // Check the type filed.\r
+  for (Index = 0; Index < Count - 1; Index++) {\r
+    if (MemoryData[Index].Type >= EfiMaxMemoryType) {\r
+      return FALSE;\r
+    }\r
+  }\r
+\r
+  return TRUE;\r
+}\r
+\r
 /**\r
    Main entry point to last PEIM. \r
 \r
@@ -174,55 +285,89 @@ DxeLoadCore (
                NULL,\r
                (VOID **) &S3Resume\r
                );\r
+    if (EFI_ERROR (Status)) {\r
+      //\r
+      // Report Status code that S3Resume PPI can not be found\r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_S3_RESUME_PPI_NOT_FOUND)\r
+        );\r
+    }\r
     ASSERT_EFI_ERROR (Status);\r
     \r
     Status = S3Resume->S3RestoreConfig2 (S3Resume);\r
     ASSERT_EFI_ERROR (Status);\r
   } else if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_RECOVERY_BEGIN));\r
     Status = PeiServicesLocatePpi (\r
                &gEfiPeiRecoveryModulePpiGuid,\r
                0,\r
                NULL,\r
                (VOID **) &PeiRecovery\r
                );\r
-    ASSERT_EFI_ERROR (Status);\r
-    \r
+\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((DEBUG_ERROR, "Locate Recovery PPI Failed.(Status = %r)\n", Status));\r
+      //\r
+      // Report Status code the failure of locating Recovery PPI \r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_RECOVERY_PPI_NOT_FOUND)\r
+        );\r
+      CpuDeadLoop ();\r
+    }\r
+\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_LOAD));\r
     Status = PeiRecovery->LoadRecoveryCapsule (PeiServices, PeiRecovery);\r
     if (EFI_ERROR (Status)) {\r
       DEBUG ((DEBUG_ERROR, "Load Recovery Capsule Failed.(Status = %r)\n", Status));\r
+      //\r
+      // Report Status code that recovery image can not be found\r
+      //\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r
+        (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_EC_NO_RECOVERY_CAPSULE)\r
+        );\r
       CpuDeadLoop ();\r
     }\r
-\r
+    REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_PC_CAPSULE_START));\r
     //\r
     // Now should have a HOB with the DXE core\r
     //\r
   }\r
 \r
-  Status = PeiServicesLocatePpi (\r
-             &gEfiPeiReadOnlyVariable2PpiGuid,\r
-             0,\r
-             NULL,\r
-             (VOID **)&Variable\r
-             );\r
-  if (!EFI_ERROR (Status)) {\r
-    DataSize = sizeof (MemoryData);\r
-    Status = Variable->GetVariable ( \r
-                         Variable, \r
-                         EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
-                         &gEfiMemoryTypeInformationGuid,\r
-                         NULL,\r
-                         &DataSize,\r
-                         &MemoryData\r
-                         );\r
+  if (GetFirstGuidHob ((CONST EFI_GUID *)&gEfiMemoryTypeInformationGuid) == NULL) {\r
+    //\r
+    // Don't build GuidHob if GuidHob has been installed.\r
+    //\r
+    Status = PeiServicesLocatePpi (\r
+               &gEfiPeiReadOnlyVariable2PpiGuid,\r
+               0,\r
+               NULL,\r
+               (VOID **)&Variable\r
+               );\r
     if (!EFI_ERROR (Status)) {\r
-      //\r
-      // Build the GUID'd HOB for DXE\r
-      //\r
-      BuildGuidDataHob (\r
-        &gEfiMemoryTypeInformationGuid,\r
-        MemoryData,\r
-        DataSize\r
-        );\r
+      DataSize = sizeof (MemoryData);\r
+      Status = Variable->GetVariable ( \r
+                           Variable, \r
+                           EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
+                           &gEfiMemoryTypeInformationGuid,\r
+                           NULL,\r
+                           &DataSize,\r
+                           &MemoryData\r
+                           );\r
+      if (!EFI_ERROR (Status) && ValidateMemoryTypeInfoVariable(MemoryData, DataSize)) {\r
+        //\r
+        // Build the GUID'd HOB for DXE\r
+        //\r
+        BuildGuidDataHob (\r
+          &gEfiMemoryTypeInformationGuid,\r
+          MemoryData,\r
+          DataSize\r
+          );\r
+      }\r
     }\r
   }\r
 \r
@@ -318,6 +463,9 @@ DxeIplFindDxeCore (
     // If some error occurs here, then we cannot find any firmware\r
     // volume that may contain DxeCore.\r
     //\r
+    if (EFI_ERROR (Status)) {\r
+      REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_EC_DXE_CORRUPT));\r
+    }\r
     ASSERT_EFI_ERROR (Status);\r
     \r
     //\r
@@ -445,16 +593,11 @@ CustomGuidedSectionExtract (
     //\r
     // Allocate output buffer\r
     //\r
-    *OutputBuffer = AllocatePages (EFI_SIZE_TO_PAGES (OutputBufferSize) + 1);\r
+    *OutputBuffer = AllocatePages (EFI_SIZE_TO_PAGES (OutputBufferSize));\r
     if (*OutputBuffer == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
     DEBUG ((DEBUG_INFO, "Customized Guided section Memory Size required is 0x%x and address is 0x%p\n", OutputBufferSize, *OutputBuffer));\r
-    //\r
-    // *OutputBuffer still is one section. Adjust *OutputBuffer offset, \r
-    // skip EFI section header to make section data at page alignment.\r
-    //\r
-    *OutputBuffer = (VOID *)((UINT8 *) *OutputBuffer + EFI_PAGE_SIZE - sizeof (EFI_COMMON_SECTION_HEADER));\r
   }\r
   \r
   Status = ExtractGuidedSectionDecode (\r
@@ -512,21 +655,32 @@ Decompress (
   UINT8                           *ScratchBuffer;\r
   UINT32                          DstBufferSize;\r
   UINT32                          ScratchBufferSize;\r
-  EFI_COMMON_SECTION_HEADER       *Section;\r
-  UINT32                          SectionLength;\r
+  VOID                            *CompressionSource;\r
+  UINT32                          CompressionSourceSize;\r
+  UINT32                          UncompressedLength;\r
+  UINT8                           CompressionType;\r
 \r
   if (CompressionSection->CommonHeader.Type != EFI_SECTION_COMPRESSION) {\r
     ASSERT (FALSE);\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  Section = (EFI_COMMON_SECTION_HEADER *) CompressionSection;\r
-  SectionLength = *(UINT32 *) (Section->Size) & 0x00ffffff;\r
+  if (IS_SECTION2 (CompressionSection)) {\r
+    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION2));\r
+    CompressionSourceSize = (UINT32) (SECTION2_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION2));\r
+    UncompressedLength = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->UncompressedLength;\r
+    CompressionType = ((EFI_COMPRESSION_SECTION2 *) CompressionSection)->CompressionType;\r
+  } else {\r
+    CompressionSource = (VOID *) ((UINT8 *) CompressionSection + sizeof (EFI_COMPRESSION_SECTION));\r
+    CompressionSourceSize = (UINT32) (SECTION_SIZE (CompressionSection) - sizeof (EFI_COMPRESSION_SECTION));\r
+    UncompressedLength = CompressionSection->UncompressedLength;\r
+    CompressionType = CompressionSection->CompressionType;\r
+  }\r
   \r
   //\r
   // This is a compression set, expand it\r
   //\r
-  switch (CompressionSection->CompressionType) {\r
+  switch (CompressionType) {\r
   case EFI_STANDARD_COMPRESSION:\r
     if (FeaturePcdGet(PcdDxeIplSupportUefiDecompress)) {\r
       //\r
@@ -534,8 +688,8 @@ Decompress (
       // For compressed data, decompress them to destination buffer.\r
       //\r
       Status = UefiDecompressGetInfo (\r
-                 (UINT8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
-                 SectionLength - sizeof (EFI_COMPRESSION_SECTION),\r
+                 CompressionSource,\r
+                 CompressionSourceSize,\r
                  &DstBufferSize,\r
                  &ScratchBufferSize\r
                  );\r
@@ -554,22 +708,17 @@ Decompress (
         return EFI_OUT_OF_RESOURCES;\r
       }\r
       //\r
-      // Allocate destination buffer, extra one page for adjustment \r
+      // Allocate destination buffer\r
       //\r
-      DstBuffer = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize) + 1);\r
+      DstBuffer = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));\r
       if (DstBuffer == NULL) {\r
         return EFI_OUT_OF_RESOURCES;\r
       }\r
       //\r
-      // DstBuffer still is one section. Adjust DstBuffer offset, skip EFI section header\r
-      // to make section data at page alignment.\r
-      //\r
-      DstBuffer = DstBuffer + EFI_PAGE_SIZE - sizeof (EFI_COMMON_SECTION_HEADER);\r
-      //\r
       // Call decompress function\r
       //\r
       Status = UefiDecompress (\r
-                  (CHAR8 *) ((EFI_COMPRESSION_SECTION *) Section + 1),\r
+                  CompressionSource,\r
                   DstBuffer,\r
                   ScratchBuffer\r
                   );\r
@@ -594,20 +743,15 @@ Decompress (
     //\r
     // Allocate destination buffer\r
     //\r
-    DstBufferSize = CompressionSection->UncompressedLength;\r
-    DstBuffer     = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize) + 1);\r
+    DstBufferSize = UncompressedLength;\r
+    DstBuffer     = AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));\r
     if (DstBuffer == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
     //\r
-    // Adjust DstBuffer offset, skip EFI section header\r
-    // to make section data at page alignment.\r
-    //\r
-    DstBuffer = DstBuffer + EFI_PAGE_SIZE - sizeof (EFI_COMMON_SECTION_HEADER);\r
-    //\r
     // stream is not actually compressed, just encapsulated.  So just copy it.\r
     //\r
-    CopyMem (DstBuffer, CompressionSection + 1, DstBufferSize);\r
+    CopyMem (DstBuffer, CompressionSource, DstBufferSize);\r
     break;\r
 \r
   default:\r
@@ -647,13 +791,14 @@ UpdateStackHob (
   while ((Hob.Raw = GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, Hob.Raw)) != NULL) {\r
     if (CompareGuid (&gEfiHobMemoryAllocStackGuid, &(Hob.MemoryAllocationStack->AllocDescriptor.Name))) {\r
       //\r
-      // Build a new memory allocation HOB with old stack info with EfiConventionalMemory type\r
-      // to be reclaimed by DXE core.\r
+      // Build a new memory allocation HOB with old stack info with EfiBootServicesData type. Need to \r
+      // avoid this region be reclaimed by DXE core as the IDT built in SEC might be on stack, and some \r
+      // PEIMs may also keep key information on stack\r
       //\r
       BuildMemoryAllocationHob (\r
         Hob.MemoryAllocationStack->AllocDescriptor.MemoryBaseAddress,\r
         Hob.MemoryAllocationStack->AllocDescriptor.MemoryLength,\r
-        EfiConventionalMemory\r
+        EfiBootServicesData\r
         );\r
       //\r
       // Update the BSP Stack Hob to reflect the new stack info.\r
@@ -665,3 +810,4 @@ UpdateStackHob (
     Hob.Raw = GET_NEXT_HOB (Hob);\r
   }\r
 }\r
+\r