OvmfPkg: install an SSDT with a dynamic OperationRegion called FWDT

[mirror_edk2.git] / OvmfPkg / AcpiPlatformDxe / Qemu.c

/** @file\r
  OVMF ACPI QEMU support\r
\r
  Copyright (c) 2008 - 2012, 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
  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 "AcpiPlatform.h"\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/QemuFwCfgLib.h>\r
\r
\r
BOOLEAN\r
QemuDetected (\r
  VOID\r
  )\r
{\r
  if (!QemuFwCfgIsAvailable ()) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
QemuInstallAcpiMadtTable (\r
  IN   EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol,\r
  IN   VOID                          *AcpiTableBuffer,\r
  IN   UINTN                         AcpiTableBufferSize,\r
  OUT  UINTN                         *TableKey\r
  )\r
{\r
  EFI_STATUS                                   Status;\r
  UINTN                                        Count;\r
  UINTN                                        Loop;\r
  EFI_ACPI_DESCRIPTION_HEADER                  *Hdr;\r
  UINTN                                        NewBufferSize;\r
  EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE  *LocalApic;\r
\r
  QemuFwCfgSelectItem (QemuFwCfgItemSmpCpuCount);\r
  Count = (UINTN) QemuFwCfgRead16 ();\r
  ASSERT (Count >= 1);\r
\r
  if (Count == 1) {\r
    //\r
    // The pre-built MADT table covers the single CPU case\r
    //\r
    return InstallAcpiTable (\r
             AcpiProtocol,\r
             AcpiTableBuffer,\r
             AcpiTableBufferSize,\r
             TableKey\r
             );\r
  }\r
\r
  //\r
  // We need to add additional Local APIC entries to the MADT\r
  //\r
  NewBufferSize = AcpiTableBufferSize + ((Count - 1) * sizeof (*LocalApic));\r
  Hdr = (EFI_ACPI_DESCRIPTION_HEADER*) AllocatePool (NewBufferSize);\r
  ASSERT (Hdr != NULL);\r
\r
  CopyMem (Hdr, AcpiTableBuffer, AcpiTableBufferSize);\r
\r
  LocalApic = (EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE*)\r
                (((UINT8*) Hdr) + AcpiTableBufferSize);\r
\r
  //\r
  // Add Local APIC entries for the APs to the MADT\r
  //\r
  for (Loop = 1; Loop < Count; Loop++) {\r
    LocalApic->Type = EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC;\r
    LocalApic->Length = sizeof (*LocalApic);\r
    LocalApic->AcpiProcessorId = (UINT8) Loop;\r
    LocalApic->ApicId = (UINT8) Loop;\r
    LocalApic->Flags = 1;\r
    LocalApic++;\r
  }\r
\r
  Hdr->Length = (UINT32) NewBufferSize;\r
\r
  Status = InstallAcpiTable (AcpiProtocol, Hdr, NewBufferSize, TableKey);\r
\r
  FreePool (Hdr);\r
\r
  return Status;\r
}\r
\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT64 Base;\r
  UINT64 End;\r
  UINT64 Length;\r
} PCI_WINDOW;\r
\r
typedef struct {\r
  PCI_WINDOW PciWindow32;\r
  PCI_WINDOW PciWindow64;\r
} FIRMWARE_DATA;\r
\r
#pragma pack()\r
\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PopulateFwData(\r
  OUT  FIRMWARE_DATA *FwData\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
QemuInstallAcpiSsdtTable (\r
  IN   EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol,\r
  IN   VOID                          *AcpiTableBuffer,\r
  IN   UINTN                         AcpiTableBufferSize,\r
  OUT  UINTN                         *TableKey\r
  )\r
{\r
  EFI_STATUS    Status;\r
  FIRMWARE_DATA *FwData;\r
\r
  Status = EFI_OUT_OF_RESOURCES;\r
\r
  FwData = AllocateReservedPool (sizeof (*FwData));\r
  if (FwData != NULL) {\r
    UINTN SsdtSize;\r
    UINT8 *Ssdt;\r
\r
    SsdtSize = AcpiTableBufferSize + 17;\r
    Ssdt = AllocatePool (SsdtSize);\r
\r
    if (Ssdt != NULL) {\r
      Status = PopulateFwData (FwData);\r
\r
      if (Status == EFI_SUCCESS) {\r
        UINT8 *SsdtPtr;\r
\r
        SsdtPtr = Ssdt;\r
\r
        CopyMem (SsdtPtr, AcpiTableBuffer, AcpiTableBufferSize);\r
        SsdtPtr += AcpiTableBufferSize;\r
\r
        //\r
        // build "OperationRegion(FWDT, SystemMemory, 0x12345678, 0x87654321)"\r
        //\r
        *(SsdtPtr++) = 0x5B; // ExtOpPrefix\r
        *(SsdtPtr++) = 0x80; // OpRegionOp\r
        *(SsdtPtr++) = 'F';\r
        *(SsdtPtr++) = 'W';\r
        *(SsdtPtr++) = 'D';\r
        *(SsdtPtr++) = 'T';\r
        *(SsdtPtr++) = 0x00; // SystemMemory\r
        *(SsdtPtr++) = 0x0C; // DWordPrefix\r
\r
        //\r
        // no virtual addressing yet, take the four least significant bytes\r
        //\r
        CopyMem(SsdtPtr, &FwData, 4);\r
        SsdtPtr += 4;\r
\r
        *(SsdtPtr++) = 0x0C; // DWordPrefix\r
\r
        *(UINT32*) SsdtPtr = sizeof (*FwData);\r
        SsdtPtr += 4;\r
\r
        ASSERT(SsdtPtr - Ssdt == SsdtSize);\r
        ((EFI_ACPI_DESCRIPTION_HEADER *) Ssdt)->Length = SsdtSize;\r
        Status = InstallAcpiTable (AcpiProtocol, Ssdt, SsdtSize, TableKey);\r
      }\r
\r
      FreePool(Ssdt);\r
    }\r
\r
    if (Status != EFI_SUCCESS) {\r
      FreePool(FwData);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
QemuInstallAcpiTable (\r
  IN   EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol,\r
  IN   VOID                          *AcpiTableBuffer,\r
  IN   UINTN                         AcpiTableBufferSize,\r
  OUT  UINTN                         *TableKey\r
  )\r
{\r
  EFI_ACPI_DESCRIPTION_HEADER        *Hdr;\r
  EFI_ACPI_TABLE_INSTALL_ACPI_TABLE  TableInstallFunction;\r
\r
  Hdr = (EFI_ACPI_DESCRIPTION_HEADER*) AcpiTableBuffer;\r
  switch (Hdr->Signature) {\r
  case EFI_ACPI_1_0_APIC_SIGNATURE:\r
    TableInstallFunction = QemuInstallAcpiMadtTable;\r
    break;\r
  case EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
    TableInstallFunction = QemuInstallAcpiSsdtTable;\r
    break;\r
  default:\r
    TableInstallFunction = InstallAcpiTable;\r
  }\r
\r
  return TableInstallFunction (\r
           AcpiProtocol,\r
           AcpiTableBuffer,\r
           AcpiTableBufferSize,\r
           TableKey\r
           );\r
}\r
\r