MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / CapsuleRuntimeDxe / X64 / SaveLongModeContext.c

/** @file\r
  Create the variable to save the base address of page table and stack\r
  for transferring into long mode in IA32 capsule PEI.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/Capsule.h>\r
#include <Protocol/DxeSmmReadyToLock.h>\r
#include <Protocol/VariableLock.h>\r
\r
#include <Guid/CapsuleVendor.h>\r
#include <Guid/AcpiS3Context.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
//\r
// 8 extra pages for PF handler.\r
//\r
#define EXTRA_PAGE_TABLE_PAGES   8\r
\r
/**\r
  Allocate EfiReservedMemoryType below 4G memory address.\r
\r
  This function allocates EfiReservedMemoryType below 4G memory address.\r
\r
  @param  Size      Size of memory to allocate.\r
\r
  @return Allocated Address for output.\r
\r
**/\r
VOID*\r
AllocateReservedMemoryBelow4G (\r
  IN   UINTN   Size\r
  )\r
{\r
  UINTN                 Pages;\r
  EFI_PHYSICAL_ADDRESS  Address;\r
  EFI_STATUS            Status;\r
  VOID*                 Buffer;\r
\r
  Pages = EFI_SIZE_TO_PAGES (Size);\r
  Address = 0xffffffff;\r
\r
  Status  = gBS->AllocatePages (\r
                   AllocateMaxAddress,\r
                   EfiReservedMemoryType,\r
                   Pages,\r
                   &Address\r
                   );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Buffer = (VOID *) (UINTN) Address;\r
  ZeroMem (Buffer, Size);\r
\r
  return Buffer;\r
}\r
\r
/**\r
  Register callback function upon VariableLockProtocol\r
  to lock EFI_CAPSULE_LONG_MODE_BUFFER_NAME variable to avoid malicious code to update it.\r
\r
  @param[in] Event    Event whose notification function is being invoked.\r
  @param[in] Context  Pointer to the notification function's context.\r
**/\r
VOID\r
EFIAPI\r
VariableLockCapsuleLongModeBufferVariable (\r
  IN  EFI_EVENT                             Event,\r
  IN  VOID                                  *Context\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EDKII_VARIABLE_LOCK_PROTOCOL  *VariableLock;\r
  //\r
  // Mark EFI_CAPSULE_LONG_MODE_BUFFER_NAME variable to read-only if the Variable Lock protocol exists\r
  //\r
  Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
  if (!EFI_ERROR (Status)) {\r
    Status = VariableLock->RequestToLock (VariableLock, EFI_CAPSULE_LONG_MODE_BUFFER_NAME, &gEfiCapsuleVendorGuid);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
}\r
\r
/**\r
  1. Allocate Reserved memory for capsule PEIM to establish a 1:1 Virtual to Physical mapping.\r
  2. Allocate Reserved memroy as a stack for capsule PEIM to transfer from 32-bit mdoe to 64-bit mode.\r
\r
**/\r
VOID\r
EFIAPI\r
PrepareContextForCapsulePei (\r
  VOID\r
  )\r
{\r
  UINTN                                         ExtraPageTablePages;\r
  UINT32                                        RegEax;\r
  UINT32                                        RegEdx;\r
  UINTN                                         TotalPagesNum;\r
  UINT8                                         PhysicalAddressBits;\r
  UINT32                                        NumberOfPml4EntriesNeeded;\r
  UINT32                                        NumberOfPdpEntriesNeeded;\r
  BOOLEAN                                       Page1GSupport;\r
  EFI_CAPSULE_LONG_MODE_BUFFER                  LongModeBuffer;\r
  EFI_STATUS                                    Status;\r
  VOID                                          *Registration;\r
\r
  //\r
  // Calculate the size of page table, allocate the memory.\r
  //\r
  Page1GSupport = FALSE;\r
  if (PcdGetBool(PcdUse1GPageTable)) {\r
    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
    if (RegEax >= 0x80000001) {\r
      AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
      if ((RegEdx & BIT26) != 0) {\r
        Page1GSupport = TRUE;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Create 4G page table by default,\r
  // and let PF handler to handle > 4G request.\r
  //\r
  PhysicalAddressBits = 32;\r
  ExtraPageTablePages = EXTRA_PAGE_TABLE_PAGES;\r
\r
  //\r
  // Calculate the table entries needed.\r
  //\r
  if (PhysicalAddressBits <= 39 ) {\r
    NumberOfPml4EntriesNeeded = 1;\r
    NumberOfPdpEntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 30));\r
  } else {\r
    NumberOfPml4EntriesNeeded = (UINT32)LShiftU64 (1, (PhysicalAddressBits - 39));\r
    NumberOfPdpEntriesNeeded = 512;\r
  }\r
\r
  if (!Page1GSupport) {\r
    TotalPagesNum = (NumberOfPdpEntriesNeeded + 1) * NumberOfPml4EntriesNeeded + 1;\r
  } else {\r
    TotalPagesNum = NumberOfPml4EntriesNeeded + 1;\r
  }\r
  TotalPagesNum += ExtraPageTablePages;\r
  DEBUG ((DEBUG_INFO, "CapsuleRuntimeDxe X64 TotalPagesNum - 0x%x pages\n", TotalPagesNum));\r
\r
  LongModeBuffer.PageTableAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)AllocateReservedMemoryBelow4G (EFI_PAGES_TO_SIZE (TotalPagesNum));\r
  ASSERT (LongModeBuffer.PageTableAddress != 0);\r
\r
  //\r
  // Allocate stack\r
  //\r
  LongModeBuffer.StackSize        = PcdGet32 (PcdCapsulePeiLongModeStackSize);\r
  LongModeBuffer.StackBaseAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)AllocateReservedMemoryBelow4G (PcdGet32 (PcdCapsulePeiLongModeStackSize));\r
  ASSERT (LongModeBuffer.StackBaseAddress != 0);\r
\r
  Status = gRT->SetVariable (\r
                  EFI_CAPSULE_LONG_MODE_BUFFER_NAME,\r
                  &gEfiCapsuleVendorGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  sizeof (EFI_CAPSULE_LONG_MODE_BUFFER),\r
                  &LongModeBuffer\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
      //\r
      // Register callback function upon VariableLockProtocol\r
      // to lock EFI_CAPSULE_LONG_MODE_BUFFER_NAME variable to avoid malicious code to update it.\r
      //\r
      EfiCreateProtocolNotifyEvent (\r
        &gEdkiiVariableLockProtocolGuid,\r
        TPL_CALLBACK,\r
        VariableLockCapsuleLongModeBufferVariable,\r
        NULL,\r
        &Registration\r
        );\r
  } else {\r
      DEBUG ((EFI_D_ERROR, "FATAL ERROR: CapsuleLongModeBuffer cannot be saved: %r. Capsule in PEI may fail!\n", Status));\r
      gBS->FreePages (LongModeBuffer.StackBaseAddress, EFI_SIZE_TO_PAGES (LongModeBuffer.StackSize));\r
  }\r
}\r
\r
/**\r
  Create the variable to save the base address of page table and stack\r
  for transferring into long mode in IA32 capsule PEI.\r
**/\r
VOID\r
SaveLongModeContext (\r
  VOID\r
  )\r
{\r
  if ((FeaturePcdGet(PcdSupportUpdateCapsuleReset)) && (FeaturePcdGet (PcdDxeIplSwitchToLongMode))) {\r
    //\r
    // Allocate memory for Capsule IA32 PEIM, it will create page table to transfer to long mode to access capsule above 4GB.\r
    //\r
    PrepareContextForCapsulePei ();\r
  }\r
}\r