]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / IntelFrameworkModulePkg / Csm / LegacyBiosDxe / LegacyBios.c
index 3ead2d98280929b0192ecf1222c02f9023db9fd2..05e3ffd2bbb86a9bbc7162a1c9bf48364941ffa2 100644 (file)
@@ -1,15 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions\r
-of the BSD License which accompanies this distribution.  The\r
-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
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -40,30 +33,33 @@ VOID                  *mRuntimeSmbiosEntryPoint = NULL;
 EFI_PHYSICAL_ADDRESS  mReserveSmbiosEntryPoint = 0;\r
 EFI_PHYSICAL_ADDRESS  mStructureTableAddress   = 0;\r
 UINTN                 mStructureTablePages     = 0;\r
+BOOLEAN               mEndOfDxe                = FALSE;\r
 \r
 /**\r
-  Do an AllocatePages () of type AllocateMaxAddress for EfiBootServicesCode\r
-  memory.\r
+  Allocate memory for legacy usage. The memory is executable.\r
 \r
-  @param  AllocateType               Allocated Legacy Memory Type\r
+  @param  AllocateType               The type of allocation to perform.\r
+  @param  MemoryType                 The type of memory to allocate.\r
   @param  StartPageAddress           Start address of range\r
   @param  Pages                      Number of pages to allocate\r
   @param  Result                     Result of allocation\r
 \r
-  @retval EFI_SUCCESS                Legacy16 code loaded\r
-  @retval Other                      No protocol installed, unload driver.\r
+  @retval EFI_SUCCESS                Legacy memory is allocated successfully.\r
+  @retval Other                      Legacy memory is not allocated.\r
 \r
 **/\r
 EFI_STATUS\r
 AllocateLegacyMemory (\r
   IN  EFI_ALLOCATE_TYPE         AllocateType,\r
+  IN  EFI_MEMORY_TYPE           MemoryType,\r
   IN  EFI_PHYSICAL_ADDRESS      StartPageAddress,\r
   IN  UINTN                     Pages,\r
   OUT EFI_PHYSICAL_ADDRESS      *Result\r
   )\r
 {\r
-  EFI_STATUS            Status;\r
-  EFI_PHYSICAL_ADDRESS  MemPage;\r
+  EFI_STATUS                      Status;\r
+  EFI_PHYSICAL_ADDRESS            MemPage;\r
+  EFI_GCD_MEMORY_SPACE_DESCRIPTOR MemDesc;\r
 \r
   //\r
   // Allocate Pages of memory less <= StartPageAddress\r
@@ -71,7 +67,7 @@ AllocateLegacyMemory (
   MemPage = (EFI_PHYSICAL_ADDRESS) (UINTN) StartPageAddress;\r
   Status = gBS->AllocatePages (\r
                   AllocateType,\r
-                  EfiBootServicesCode,\r
+                  MemoryType,\r
                   Pages,\r
                   &MemPage\r
                   );\r
@@ -79,12 +75,29 @@ AllocateLegacyMemory (
   // Do not ASSERT on Status error but let caller decide since some cases\r
   // memory is already taken but that is ok.\r
   //\r
+  if (!EFI_ERROR (Status)) {\r
+    if (MemoryType != EfiBootServicesCode) {\r
+      //\r
+      // Make sure that the buffer can be used to store code.\r
+      //\r
+      Status = gDS->GetMemorySpaceDescriptor (MemPage, &MemDesc);\r
+      if (!EFI_ERROR (Status) && (MemDesc.Attributes & EFI_MEMORY_XP) != 0) {\r
+        Status = gDS->SetMemorySpaceAttributes (\r
+                        MemPage,\r
+                        EFI_PAGES_TO_SIZE (Pages),\r
+                        MemDesc.Attributes & (~EFI_MEMORY_XP)\r
+                        );\r
+      }\r
+      if (EFI_ERROR (Status)) {\r
+        gBS->FreePages (MemPage, Pages);\r
+      }\r
+    }\r
+  }\r
+\r
   if (!EFI_ERROR (Status)) {\r
     *Result = (EFI_PHYSICAL_ADDRESS) (UINTN) MemPage;\r
   }\r
-  //\r
-  // If reach here the status = EFI_SUCCESS\r
-  //\r
+\r
   return Status;\r
 }\r
 \r
@@ -269,7 +282,7 @@ ShadowAndStartLegacy16 (
     if (EFI_ERROR (Status)) {\r
       //\r
       // Bugbug: need to figure out whether C/D/E/F segment should be marked as reserved memory.\r
-      // \r
+      //\r
       DEBUG ((DEBUG_ERROR, "Failed to allocate the C/D/E/F segment Status = %r", Status));\r
     }\r
   }\r
@@ -413,7 +426,7 @@ ShadowAndStartLegacy16 (
   Private->Legacy8259->GetMask(Private->Legacy8259, &OldMask, NULL, NULL, NULL);\r
   NewMask = 0xFFFF;\r
   Private->Legacy8259->SetMask(Private->Legacy8259, &NewMask, NULL, NULL, NULL);\r
-  \r
+\r
   //\r
   // Call into Legacy16 code to do an INIT\r
   //\r
@@ -435,7 +448,7 @@ ShadowAndStartLegacy16 (
   // Restore original legacy interrupt mask value\r
   //\r
   Private->Legacy8259->SetMask(Private->Legacy8259, &OldMask, NULL, NULL, NULL);\r
-  \r
+\r
   if (Regs.X.AX != 0) {\r
     return EFI_DEVICE_ERROR;\r
   }\r
@@ -651,7 +664,7 @@ GetPciInterfaceVersion (
   UINT16                PciInterfaceVersion;\r
 \r
   PciInterfaceVersion = 0;\r
-  \r
+\r
   Reg.X.AX = 0xB101;\r
   Reg.E.EDI = 0;\r
 \r
@@ -691,7 +704,7 @@ InstallSmbiosEventCallback (
 {\r
   EFI_STATUS                  Status;\r
   SMBIOS_TABLE_ENTRY_POINT    *EntryPointStructure;\r
-  \r
+\r
   //\r
   // Get SMBIOS table from EFI configuration table\r
   //\r
@@ -702,7 +715,7 @@ InstallSmbiosEventCallback (
   if ((EFI_ERROR (Status)) || (mRuntimeSmbiosEntryPoint == NULL)) {\r
     return;\r
   }\r
-  \r
+\r
   EntryPointStructure = (SMBIOS_TABLE_ENTRY_POINT *) mRuntimeSmbiosEntryPoint;\r
 \r
   //\r
@@ -726,8 +739,8 @@ InstallSmbiosEventCallback (
     }\r
     DEBUG ((EFI_D_INFO, "Allocate memory for Smbios Entry Point Structure\n"));\r
   }\r
-  \r
-  if ((mStructureTableAddress != 0) && \r
+\r
+  if ((mStructureTableAddress != 0) &&\r
       (mStructureTablePages < EFI_SIZE_TO_PAGES ((UINT32)EntryPointStructure->TableLength))) {\r
     //\r
     // If original buffer is not enough for the new SMBIOS table, free original buffer and re-allocate\r
@@ -737,7 +750,7 @@ InstallSmbiosEventCallback (
     mStructureTablePages   = 0;\r
     DEBUG ((EFI_D_INFO, "Original size is not enough. Re-allocate the memory.\n"));\r
   }\r
-  \r
+\r
   if (mStructureTableAddress == 0) {\r
     //\r
     // Allocate reserved memory below 4GB.\r
@@ -753,7 +766,7 @@ InstallSmbiosEventCallback (
                     );\r
     if (EFI_ERROR (Status)) {\r
       gBS->FreePages (\r
-        mReserveSmbiosEntryPoint, \r
+        mReserveSmbiosEntryPoint,\r
         EFI_SIZE_TO_PAGES ((UINTN) (EntryPointStructure->EntryPointLength))\r
         );\r
       mReserveSmbiosEntryPoint = 0;\r
@@ -765,6 +778,26 @@ InstallSmbiosEventCallback (
   }\r
 }\r
 \r
+/**\r
+  Callback function to toggle EndOfDxe status. NULL pointer detection needs\r
+  this status to decide if it's necessary to change attributes of page 0.\r
+\r
+  @param  Event            Event whose notification function is being invoked.\r
+  @param  Context          The pointer to the notification function's context,\r
+                           which is implementation-dependent.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ToggleEndOfDxeStatus (\r
+  IN EFI_EVENT                Event,\r
+  IN VOID                     *Context\r
+  )\r
+{\r
+  mEndOfDxe = TRUE;\r
+  return;\r
+}\r
+\r
 /**\r
   Install Driver to produce Legacy BIOS protocol.\r
 \r
@@ -802,6 +835,7 @@ LegacyBiosInstall (
   UINT64                             Length;\r
   UINT8                              *SecureBoot;\r
   EFI_EVENT                          InstallSmbiosEvent;\r
+  EFI_EVENT                          EndOfDxeEvent;\r
 \r
   //\r
   // Load this driver's image to memory\r
@@ -820,7 +854,7 @@ LegacyBiosInstall (
     FreePool (SecureBoot);\r
     return EFI_SECURITY_VIOLATION;\r
   }\r
-  \r
+\r
   if (SecureBoot != NULL) {\r
     FreePool (SecureBoot);\r
   }\r
@@ -952,6 +986,7 @@ LegacyBiosInstall (
   //\r
   AllocateLegacyMemory (\r
     AllocateAddress,\r
+    EfiReservedMemoryType,\r
     0,\r
     1,\r
     &MemoryAddress\r
@@ -964,8 +999,10 @@ LegacyBiosInstall (
   // Initialize region from 0x0000 to 4k. This initializes interrupt vector\r
   // range.\r
   //\r
-  gBS->SetMem ((VOID *) ClearPtr, 0x400, INITIAL_VALUE_BELOW_1K);\r
-  ZeroMem ((VOID *) ((UINTN)ClearPtr + 0x400), 0xC00);\r
+  ACCESS_PAGE0_CODE (\r
+    gBS->SetMem ((VOID *) ClearPtr, 0x400, INITIAL_VALUE_BELOW_1K);\r
+    ZeroMem ((VOID *) ((UINTN)ClearPtr + 0x400), 0xC00);\r
+  );\r
 \r
   //\r
   // Allocate pages for OPROM usage\r
@@ -975,6 +1012,7 @@ LegacyBiosInstall (
 \r
   Status = AllocateLegacyMemory (\r
              AllocateAddress,\r
+             EfiReservedMemoryType,\r
              CONVENTIONAL_MEMORY_TOP - MemorySize,\r
              EFI_SIZE_TO_PAGES (MemorySize),\r
              &MemoryAddress\r
@@ -1003,6 +1041,7 @@ LegacyBiosInstall (
   for (MemStart = MemoryAddress; MemStart < MemoryAddress + MemorySize; MemStart += 0x1000) {\r
     Status = AllocateLegacyMemory (\r
                AllocateAddress,\r
+               EfiBootServicesCode,\r
                MemStart,\r
                1,\r
                &StartAddress\r
@@ -1019,9 +1058,10 @@ LegacyBiosInstall (
   // Allocate low PMM memory and zero it out\r
   //\r
   MemorySize = PcdGet32 (PcdLowPmmMemorySize);\r
-  ASSERT ((MemorySize & 0xFFF) == 0);  \r
+  ASSERT ((MemorySize & 0xFFF) == 0);\r
   Status = AllocateLegacyMemory (\r
              AllocateMaxAddress,\r
+             EfiBootServicesCode,\r
              CONVENTIONAL_MEMORY_TOP,\r
              EFI_SIZE_TO_PAGES (MemorySize),\r
              &MemoryAddressUnder1MB\r
@@ -1035,6 +1075,7 @@ LegacyBiosInstall (
   //\r
   Status = AllocateLegacyMemory (\r
              AllocateMaxAddress,\r
+             EfiReservedMemoryType,\r
              CONVENTIONAL_MEMORY_TOP,\r
              (sizeof (LOW_MEMORY_THUNK) / EFI_PAGE_SIZE) + 2,\r
              &MemoryAddress\r
@@ -1059,9 +1100,10 @@ LegacyBiosInstall (
   ASSERT ((MemorySize & 0xFFF) == 0);\r
   //\r
   // Allocate high PMM Memory under 16 MB\r
-  //   \r
+  //\r
   Status = AllocateLegacyMemory (\r
              AllocateMaxAddress,\r
+             EfiBootServicesCode,\r
              0x1000000,\r
              EFI_SIZE_TO_PAGES (MemorySize),\r
              &MemoryAddress\r
@@ -1069,18 +1111,19 @@ LegacyBiosInstall (
   if (EFI_ERROR (Status)) {\r
     //\r
     // If it fails, allocate high PMM Memory under 4GB\r
-    //   \r
+    //\r
     Status = AllocateLegacyMemory (\r
                AllocateMaxAddress,\r
+               EfiBootServicesCode,\r
                0xFFFFFFFF,\r
                EFI_SIZE_TO_PAGES (MemorySize),\r
                &MemoryAddress\r
-               );    \r
+               );\r
   }\r
   if (!EFI_ERROR (Status)) {\r
     EfiToLegacy16InitTable->HiPmmMemory            = (UINT32) (EFI_PHYSICAL_ADDRESS) (UINTN) MemoryAddress;\r
     EfiToLegacy16InitTable->HiPmmMemorySizeInBytes = MemorySize;\r
-  } \r
+  }\r
 \r
   //\r
   //  ShutdownAPs();\r
@@ -1104,17 +1147,20 @@ LegacyBiosInstall (
   //\r
   // Save Unexpected interrupt vector so can restore it just prior to boot\r
   //\r
-  BaseVectorMaster = (UINT32 *) (sizeof (UINT32) * PROTECTED_MODE_BASE_VECTOR_MASTER);\r
-  Private->BiosUnexpectedInt = BaseVectorMaster[0];\r
-  IntRedirCode = (UINT32) (UINTN) Private->IntThunk->InterruptRedirectionCode;\r
-  for (Index = 0; Index < 8; Index++) {\r
-    BaseVectorMaster[Index] = (EFI_SEGMENT (IntRedirCode + Index * 4) << 16) | EFI_OFFSET (IntRedirCode + Index * 4);\r
-  }\r
+  ACCESS_PAGE0_CODE (\r
+    BaseVectorMaster = (UINT32 *) (sizeof (UINT32) * PROTECTED_MODE_BASE_VECTOR_MASTER);\r
+    Private->BiosUnexpectedInt = BaseVectorMaster[0];\r
+    IntRedirCode = (UINT32) (UINTN) Private->IntThunk->InterruptRedirectionCode;\r
+    for (Index = 0; Index < 8; Index++) {\r
+      BaseVectorMaster[Index] = (EFI_SEGMENT (IntRedirCode + Index * 4) << 16) | EFI_OFFSET (IntRedirCode + Index * 4);\r
+    }\r
+  );\r
+\r
   //\r
   // Save EFI value\r
   //\r
   Private->ThunkSeg = (UINT16) (EFI_SEGMENT (IntRedirCode));\r
-  \r
+\r
   //\r
   // Allocate reserved memory for SMBIOS table used in legacy boot if SMBIOS table exists\r
   //\r
@@ -1131,7 +1177,21 @@ LegacyBiosInstall (
                   &gEfiSmbiosTableGuid,\r
                   &InstallSmbiosEvent\r
                   );\r
-  ASSERT_EFI_ERROR (Status);  \r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  //\r
+  // Create callback to update status of EndOfDxe, which is needed by NULL\r
+  // pointer detection\r
+  //\r
+  Status = gBS->CreateEventEx (\r
+                  EVT_NOTIFY_SIGNAL,\r
+                  TPL_NOTIFY,\r
+                  ToggleEndOfDxeStatus,\r
+                  NULL,\r
+                  &gEfiEndOfDxeEventGroupGuid,\r
+                  &EndOfDxeEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
 \r
   //\r
   // Make a new handle and install the protocol\r
@@ -1144,9 +1204,9 @@ LegacyBiosInstall (
                   &Private->LegacyBios\r
                   );\r
   Private->Csm16PciInterfaceVersion = GetPciInterfaceVersion (Private);\r
-  \r
-  DEBUG ((EFI_D_INFO, "CSM16 PCI BIOS Interface Version: %02x.%02x\n", \r
-          (UINT8) (Private->Csm16PciInterfaceVersion >> 8), \r
+\r
+  DEBUG ((EFI_D_INFO, "CSM16 PCI BIOS Interface Version: %02x.%02x\n",\r
+          (UINT8) (Private->Csm16PciInterfaceVersion >> 8),\r
           (UINT8) Private->Csm16PciInterfaceVersion\r
         ));\r
   ASSERT (Private->Csm16PciInterfaceVersion != 0);\r