UefiCpuPkg/CpuS3DataDxe: Add module to initialize ACPI_CPU_DATA for S3

This module initializes the ACPI_CPU_DATA structure and registers the
address of this structure in the PcdCpuS3DataAddress PCD.  This is a
generic/simple version of this module.  It does not provide a machine
check handler or CPU register initialization tables for ACPI S3 resume.
It also only supports the number of CPUs reported by the MP Services
Protocol, so this module does not support hot plug CPUs.  This module
can be copied into a CPU specific package and customized if these
additional features are required.

This patch series is in response to the OvmfPkg patch series from
Laszlo Ersek that enables SMM on OVMF.  The v4 version of the patch
series from Laszlo includes an OVMF specific CPU module to initialize
the ACPI_CPU_DATA structure.

This proposed patch series replaces the patches listed below.

[PATCH v4 27/41] OvmfPkg:
  add skeleton QuarkPort/CpuS3DataDxe

[PATCH v4 28/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: fill in ACPI_CPU_DATA.StartupVector

[PATCH v4 29/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: handle IDT, GDT and MCE in ACPI_CPU_DATA

[PATCH v4 30/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: handle StackAddress and StackSize

[PATCH v4 31/41] OvmfPkg:
  import CpuConfigLib header from Quark_EDKII_v1.1.0/IA32FamilyCpuBasePkg

[PATCH v4 32/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: fill in ACPI_CPU_DATA.NumberOfCpus

[PATCH v4 33/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: fill in ACPI_CPU_DATA.MtrrTable

[PATCH v4 34/41] OvmfPkg:
  QuarkPort/CpuS3DataDxe: handle register tables in ACPI_CPU_DATA

[PATCH v4 35/41] OvmfPkg:
  port CpuS3DataDxe to X64
  patch originally authored by Paolo Bonzini

[PATCH v4 36/41] OvmfPkg:
  build QuarkPort/CpuS3DataDxe for -D SMM_REQUIRE

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: "Yao, Jiewen" <jiewen.yao@intel.com>
Cc: "Fan, Jeff" <jeff.fan@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Laszlo Ersek <lersek@redhat.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18951 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 271 insertions, 0 deletions

diff --git a/UefiCpuPkg/CpuS3DataDxe/CpuS3Data.c b/UefiCpuPkg/CpuS3DataDxe/CpuS3Data.c
new file mode 100644
index 0000000000..9fb47dc528
--- /dev/null
+++ b/UefiCpuPkg/CpuS3DataDxe/CpuS3Data.c
@@ -0,0 +1,271 @@
+/** @file

+ACPI CPU Data initialization module

+

+This module initializes the ACPI_CPU_DATA structure and registers the address

+of this structure in the PcdCpuS3DataAddress PCD.  This is a generic/simple

+version of this module.  It does not provide a machine check handler or CPU

+register initialization tables for ACPI S3 resume.  It also only supports the

+number of CPUs reported by the MP Services Protocol, so this module does not

+support hot plug CPUs.  This module can be copied into a CPU specific package

+and customized if these additional features are required.

+

+Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2015, Red Hat, Inc.

+

+This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#include <PiDxe.h>

+

+#include <AcpiCpuData.h>

+

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/DebugLib.h>

+#include <Library/MtrrLib.h>

+

+#include <Protocol/MpService.h>

+#include <Guid/EventGroup.h>

+

+//

+// Data structure used to allocate ACPI_CPU_DATA and its supporting structures

+//

+typedef struct {

+  ACPI_CPU_DATA             AcpiCpuData;

+  MTRR_SETTINGS             MtrrTable;

+  IA32_DESCRIPTOR           GdtrProfile;

+  IA32_DESCRIPTOR           IdtrProfile;

+} ACPI_CPU_DATA_EX;

+

+/**

+  Allocate EfiACPIMemoryNVS below 4G memory address.

+

+  This function allocates EfiACPIMemoryNVS below 4G memory address.

+

+  @param[in] Size   Size of memory to allocate.

+

+  @return       Allocated address for output.

+

+**/

+VOID *

+AllocateAcpiNvsMemoryBelow4G (

+  IN UINTN  Size

+  )

+{

+  EFI_PHYSICAL_ADDRESS  Address;

+  EFI_STATUS            Status;

+  VOID                  *Buffer;

+

+  Address = BASE_4GB - 1;

+  Status  = gBS->AllocatePages (

+                   AllocateMaxAddress,

+                   EfiACPIMemoryNVS,

+                   EFI_SIZE_TO_PAGES (Size),

+                   &Address

+                   );

+  if (EFI_ERROR (Status)) {

+    return NULL;

+  }

+

+  Buffer = (VOID *)(UINTN)Address;

+  ZeroMem (Buffer, Size);

+

+  return Buffer;

+}

+

+/**

+  Callback function executed when the EndOfDxe event group is signaled.

+

+  We delay saving the MTRR settings until BDS signals EndOfDxe.

+

+  @param[in]  Event    Event whose notification function is being invoked.

+  @param[out] Context  Pointer to the MTRR_SETTINGS buffer to fill in.

+**/

+VOID

+EFIAPI

+SaveMtrrsOnEndOfDxe (

+  IN  EFI_EVENT  Event,

+  OUT VOID       *Context

+  )

+{

+  DEBUG ((EFI_D_VERBOSE, "%a\n", __FUNCTION__));

+  MtrrGetAllMtrrs (Context);

+

+  //

+  // Close event, so it will not be invoked again.

+  //

+  gBS->CloseEvent (Event);

+}

+

+/**

+   The entry function of the CpuS3Data driver.

+

+   Allocate and initialize all fields of the ACPI_CPU_DATA structure except the

+   MTRR settings.  Register an event notification on gEfiEndOfDxeEventGroupGuid

+   to capture the ACPI_CPU_DATA MTRR settings.  The PcdCpuS3DataAddress is set

+   to the address that ACPI_CPU_DATA is allocated at.

+

+   @param[in] ImageHandle  The firmware allocated handle for the EFI image.

+   @param[in] SystemTable  A pointer to the EFI System Table.

+

+   @retval EFI_SUCCESS     The entry point is executed successfully.

+   @retval other           Some error occurs when executing this entry point.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuS3DataInitialize (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+{

+  EFI_STATUS                 Status;

+  ACPI_CPU_DATA_EX           *AcpiCpuDataEx;

+  ACPI_CPU_DATA              *AcpiCpuData;

+  EFI_MP_SERVICES_PROTOCOL   *MpServices;

+  UINTN                      NumberOfCpus;

+  UINTN                      NumberOfEnabledProcessors;

+  VOID                       *Stack;

+  UINTN                      TableSize;

+  CPU_REGISTER_TABLE         *RegisterTable;

+  UINTN                      Index;

+  EFI_PROCESSOR_INFORMATION  ProcessorInfoBuffer;

+  UINTN                      GdtSize;

+  UINTN                      IdtSize;

+  VOID                       *Gdt;

+  VOID                       *Idt;

+  EFI_EVENT                  Event;

+

+  //

+  // Allocate ACPI NVS memory below 4G memory for use on ACPI S3 resume.

+  //

+  AcpiCpuDataEx = AllocateAcpiNvsMemoryBelow4G (sizeof (ACPI_CPU_DATA_EX));

+  ASSERT (AcpiCpuDataEx != NULL);

+  AcpiCpuData = &AcpiCpuDataEx->AcpiCpuData;

+

+  //

+  // Get MP Services Protocol

+  //

+  Status = gBS->LocateProtocol (

+                  &gEfiMpServiceProtocolGuid,

+                  NULL,

+                  (VOID **)&MpServices

+                  );

+  ASSERT_EFI_ERROR (Status);

+

+  //

+  // Allocate a 4KB reserved page below 1MB

+  //

+  AcpiCpuData->StartupVector = BASE_1MB - 1;

+  Status = gBS->AllocatePages (

+                  AllocateMaxAddress,

+                  EfiReservedMemoryType,

+                  1,

+                  &AcpiCpuData->StartupVector

+                  );

+  ASSERT_EFI_ERROR (Status);

+

+  //

+  // Get the number of CPUs

+  //

+  Status = MpServices->GetNumberOfProcessors (

+                         MpServices,

+                         &NumberOfCpus,

+                         &NumberOfEnabledProcessors

+                         );

+  ASSERT_EFI_ERROR (Status);

+  AcpiCpuData->NumberOfCpus = (UINT32)NumberOfCpus;

+

+  //

+  // Initialize ACPI_CPU_DATA fields

+  //

+  AcpiCpuData->StackSize                 = PcdGet32 (PcdCpuApStackSize);

+  AcpiCpuData->ApMachineCheckHandlerBase = 0;

+  AcpiCpuData->ApMachineCheckHandlerSize = 0;

+  AcpiCpuData->GdtrProfile  = (EFI_PHYSICAL_ADDRESS)(UINTN)&AcpiCpuDataEx->GdtrProfile;

+  AcpiCpuData->IdtrProfile  = (EFI_PHYSICAL_ADDRESS)(UINTN)&AcpiCpuDataEx->IdtrProfile;

+  AcpiCpuData->MtrrTable    = (EFI_PHYSICAL_ADDRESS)(UINTN)&AcpiCpuDataEx->MtrrTable;

+

+  //

+  // Allocate stack space for all CPUs

+  //

+  Stack = AllocateAcpiNvsMemoryBelow4G (NumberOfCpus * AcpiCpuData->StackSize);

+  ASSERT (Stack != NULL);

+  AcpiCpuData->StackAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)Stack;

+

+  //

+  // Get the boot processor's GDT and IDT

+  //

+  AsmReadGdtr (&AcpiCpuDataEx->GdtrProfile);

+  AsmReadIdtr (&AcpiCpuDataEx->IdtrProfile);

+

+  //

+  // Allocate GDT and IDT in ACPI NVS and copy current GDT and IDT contents

+  //

+  GdtSize = AcpiCpuDataEx->GdtrProfile.Limit + 1;

+  IdtSize = AcpiCpuDataEx->IdtrProfile.Limit + 1;

+  Gdt = AllocateAcpiNvsMemoryBelow4G (GdtSize + IdtSize);

+  ASSERT (Gdt != NULL);

+  Idt = (VOID *)((UINTN)Gdt + GdtSize);

+  CopyMem (Gdt, (VOID *)AcpiCpuDataEx->GdtrProfile.Base, GdtSize);

+  CopyMem (Idt, (VOID *)AcpiCpuDataEx->IdtrProfile.Base, IdtSize);

+  AcpiCpuDataEx->GdtrProfile.Base = (UINTN)Gdt;

+  AcpiCpuDataEx->IdtrProfile.Base = (UINTN)Idt;

+

+  //

+  // Allocate buffer for empty RegisterTable and PreSmmInitRegisterTable for all CPUs

+  //

+  TableSize = 2 * NumberOfCpus * sizeof (CPU_REGISTER_TABLE);

+  RegisterTable = (CPU_REGISTER_TABLE *)AllocateAcpiNvsMemoryBelow4G (TableSize);

+  ASSERT (RegisterTable != NULL);

+  for (Index = 0; Index < NumberOfCpus; Index++) {

+    Status = MpServices->GetProcessorInfo (

+                           MpServices,

+                           Index,

+                           &ProcessorInfoBuffer

+                           );

+    ASSERT_EFI_ERROR (Status);

+

+    RegisterTable[Index].InitialApicId      = (UINT32)ProcessorInfoBuffer.ProcessorId;

+    RegisterTable[Index].TableLength        = 0;

+    RegisterTable[Index].AllocatedSize      = 0;

+    RegisterTable[Index].RegisterTableEntry = NULL;

+

+    RegisterTable[NumberOfCpus + Index].InitialApicId      = (UINT32)ProcessorInfoBuffer.ProcessorId;

+    RegisterTable[NumberOfCpus + Index].TableLength        = 0;

+    RegisterTable[NumberOfCpus + Index].AllocatedSize      = 0;

+    RegisterTable[NumberOfCpus + Index].RegisterTableEntry = NULL;

+  }

+  AcpiCpuData->RegisterTable           = (EFI_PHYSICAL_ADDRESS)(UINTN)RegisterTable;

+  AcpiCpuData->PreSmmInitRegisterTable = (EFI_PHYSICAL_ADDRESS)(UINTN)(RegisterTable + NumberOfCpus);

+

+  //

+  // Set PcdCpuS3DataAddress to the base address of the ACPI_CPU_DATA structure

+  //

+  Status = PcdSet64S (PcdCpuS3DataAddress, (UINT64)(UINTN)AcpiCpuData);

+  ASSERT_EFI_ERROR (Status);

+

+  //

+  // Register EFI_END_OF_DXE_EVENT_GROUP_GUID event.

+  // The notification function saves MTRRs for ACPI_CPU_DATA

+  //

+  Status = gBS->CreateEventEx (

+                  EVT_NOTIFY_SIGNAL,

+                  TPL_CALLBACK,

+                  SaveMtrrsOnEndOfDxe,

+                  &AcpiCpuDataEx->MtrrTable,

+                  &gEfiEndOfDxeEventGroupGuid,

+                  &Event

+                  );

+  ASSERT_EFI_ERROR (Status);

+

+  return EFI_SUCCESS;

+}