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

/** @file\r
  OVMF ACPI QEMU support\r
\r
  Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
\r
  Copyright (C) 2012-2014, Red Hat, Inc.\r
\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 "QemuLoader.h"\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/QemuFwCfgLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/OrderedCollectionLib.h>\r
#include <IndustryStandard/Acpi.h>\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
UINTN\r
CountBits16 (\r
  UINT16 Mask\r
  )\r
{\r
  //\r
  // For all N >= 1, N bits are enough to represent the number of bits set\r
  // among N bits. It's true for N == 1. When adding a new bit (N := N+1),\r
  // the maximum number of possibly set bits increases by one, while the\r
  // representable maximum doubles.\r
  //\r
  Mask = ((Mask & 0xAAAA) >> 1) + (Mask & 0x5555);\r
  Mask = ((Mask & 0xCCCC) >> 2) + (Mask & 0x3333);\r
  Mask = ((Mask & 0xF0F0) >> 4) + (Mask & 0x0F0F);\r
  Mask = ((Mask & 0xFF00) >> 8) + (Mask & 0x00FF);\r
\r
  return Mask;\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
  UINTN                                               CpuCount;\r
  UINTN                                               PciLinkIsoCount;\r
  UINTN                                               NewBufferSize;\r
  EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER *Madt;\r
  EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE         *LocalApic;\r
  EFI_ACPI_1_0_IO_APIC_STRUCTURE                      *IoApic;\r
  EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE    *Iso;\r
  EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE               *LocalApicNmi;\r
  VOID                                                *Ptr;\r
  UINTN                                               Loop;\r
  EFI_STATUS                                          Status;\r
\r
  ASSERT (AcpiTableBufferSize >= sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
\r
  QemuFwCfgSelectItem (QemuFwCfgItemSmpCpuCount);\r
  CpuCount = QemuFwCfgRead16 ();\r
  ASSERT (CpuCount >= 1);\r
\r
  //\r
  // Set Level-tiggered, Active High for these identity mapped IRQs. The bitset\r
  // corresponds to the union of all possible interrupt assignments for the LNKA,\r
  // LNKB, LNKC, LNKD PCI interrupt lines. See the DSDT.\r
  //\r
  PciLinkIsoCount = CountBits16 (PcdGet16 (Pcd8259LegacyModeEdgeLevel));\r
\r
  NewBufferSize = 1                     * sizeof (*Madt) +\r
                  CpuCount              * sizeof (*LocalApic) +\r
                  1                     * sizeof (*IoApic) +\r
                  (1 + PciLinkIsoCount) * sizeof (*Iso) +\r
                  1                     * sizeof (*LocalApicNmi);\r
\r
  Madt = AllocatePool (NewBufferSize);\r
  if (Madt == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  CopyMem (&(Madt->Header), AcpiTableBuffer, sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
  Madt->Header.Length    = (UINT32) NewBufferSize;\r
  Madt->LocalApicAddress = PcdGet32 (PcdCpuLocalApicBaseAddress);\r
  Madt->Flags            = EFI_ACPI_1_0_PCAT_COMPAT;\r
  Ptr = Madt + 1;\r
\r
  LocalApic = Ptr;\r
  for (Loop = 0; Loop < CpuCount; ++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; // enabled\r
    ++LocalApic;\r
  }\r
  Ptr = LocalApic;\r
\r
  IoApic = Ptr;\r
  IoApic->Type             = EFI_ACPI_1_0_IO_APIC;\r
  IoApic->Length           = sizeof (*IoApic);\r
  IoApic->IoApicId         = (UINT8) CpuCount;\r
  IoApic->Reserved         = EFI_ACPI_RESERVED_BYTE;\r
  IoApic->IoApicAddress    = 0xFEC00000;\r
  IoApic->SystemVectorBase = 0x00000000;\r
  Ptr = IoApic + 1;\r
\r
  //\r
  // IRQ0 (8254 Timer) => IRQ2 (PIC) Interrupt Source Override Structure\r
  //\r
  Iso = Ptr;\r
  Iso->Type                        = EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE;\r
  Iso->Length                      = sizeof (*Iso);\r
  Iso->Bus                         = 0x00; // ISA\r
  Iso->Source                      = 0x00; // IRQ0\r
  Iso->GlobalSystemInterruptVector = 0x00000002;\r
  Iso->Flags                       = 0x0000; // Conforms to specs of the bus\r
  ++Iso;\r
\r
  //\r
  // Set Level-tiggered, Active High for all possible PCI link targets.\r
  //\r
  for (Loop = 0; Loop < 16; ++Loop) {\r
    if ((PcdGet16 (Pcd8259LegacyModeEdgeLevel) & (1 << Loop)) == 0) {\r
      continue;\r
    }\r
    Iso->Type                        = EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE;\r
    Iso->Length                      = sizeof (*Iso);\r
    Iso->Bus                         = 0x00; // ISA\r
    Iso->Source                      = (UINT8) Loop;\r
    Iso->GlobalSystemInterruptVector = (UINT32) Loop;\r
    Iso->Flags                       = 0x000D; // Level-tiggered, Active High\r
    ++Iso;\r
  }\r
  ASSERT (\r
    (UINTN) (Iso - (EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE *)Ptr) ==\r
      1 + PciLinkIsoCount\r
    );\r
  Ptr = Iso;\r
\r
  LocalApicNmi = Ptr;\r
  LocalApicNmi->Type            = EFI_ACPI_1_0_LOCAL_APIC_NMI;\r
  LocalApicNmi->Length          = sizeof (*LocalApicNmi);\r
  LocalApicNmi->AcpiProcessorId = 0xFF; // applies to all processors\r
  //\r
  // polarity and trigger mode of the APIC I/O input signals conform to the\r
  // specifications of the bus\r
  //\r
  LocalApicNmi->Flags           = 0x0000;\r
  //\r
  // Local APIC interrupt input LINTn to which NMI is connected.\r
  //\r
  LocalApicNmi->LocalApicInti   = 0x01;\r
  Ptr = LocalApicNmi + 1;\r
\r
  ASSERT ((UINTN) ((UINT8 *)Ptr - (UINT8 *)Madt) == NewBufferSize);\r
  Status = InstallAcpiTable (AcpiProtocol, Madt, NewBufferSize, TableKey);\r
\r
  FreePool (Madt);\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
typedef struct {\r
  UINT8 BytePrefix;\r
  UINT8 ByteValue;\r
} AML_BYTE;\r
\r
typedef struct {\r
  UINT8    NameOp;\r
  UINT8    RootChar;\r
  UINT8    NameChar[4];\r
  UINT8    PackageOp;\r
  UINT8    PkgLength;\r
  UINT8    NumElements;\r
  AML_BYTE Pm1aCntSlpTyp;\r
  AML_BYTE Pm1bCntSlpTyp;\r
  AML_BYTE Reserved[2];\r
} SYSTEM_STATE_PACKAGE;\r
\r
#pragma pack()\r
\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
PopulateFwData(\r
  OUT  FIRMWARE_DATA *FwData\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  UINTN                           NumDesc;\r
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR *AllDesc;\r
\r
  Status = gDS->GetMemorySpaceMap (&NumDesc, &AllDesc);\r
  if (Status == EFI_SUCCESS) {\r
    UINT64 NonMmio32MaxExclTop;\r
    UINT64 Mmio32MinBase;\r
    UINT64 Mmio32MaxExclTop;\r
    UINTN CurDesc;\r
\r
    Status = EFI_UNSUPPORTED;\r
\r
    NonMmio32MaxExclTop = 0;\r
    Mmio32MinBase = BASE_4GB;\r
    Mmio32MaxExclTop = 0;\r
\r
    for (CurDesc = 0; CurDesc < NumDesc; ++CurDesc) {\r
      CONST EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Desc;\r
      UINT64 ExclTop;\r
\r
      Desc = &AllDesc[CurDesc];\r
      ExclTop = Desc->BaseAddress + Desc->Length;\r
\r
      if (ExclTop <= (UINT64) PcdGet32 (PcdOvmfFdBaseAddress)) {\r
        switch (Desc->GcdMemoryType) {\r
          case EfiGcdMemoryTypeNonExistent:\r
            break;\r
\r
          case EfiGcdMemoryTypeReserved:\r
          case EfiGcdMemoryTypeSystemMemory:\r
            if (NonMmio32MaxExclTop < ExclTop) {\r
              NonMmio32MaxExclTop = ExclTop;\r
            }\r
            break;\r
\r
          case EfiGcdMemoryTypeMemoryMappedIo:\r
            if (Mmio32MinBase > Desc->BaseAddress) {\r
              Mmio32MinBase = Desc->BaseAddress;\r
            }\r
            if (Mmio32MaxExclTop < ExclTop) {\r
              Mmio32MaxExclTop = ExclTop;\r
            }\r
            break;\r
\r
          default:\r
            ASSERT(0);\r
        }\r
      }\r
    }\r
\r
    if (Mmio32MinBase < NonMmio32MaxExclTop) {\r
      Mmio32MinBase = NonMmio32MaxExclTop;\r
    }\r
\r
    if (Mmio32MinBase < Mmio32MaxExclTop) {\r
      FwData->PciWindow32.Base   = Mmio32MinBase;\r
      FwData->PciWindow32.End    = Mmio32MaxExclTop - 1;\r
      FwData->PciWindow32.Length = Mmio32MaxExclTop - Mmio32MinBase;\r
\r
      FwData->PciWindow64.Base   = 0;\r
      FwData->PciWindow64.End    = 0;\r
      FwData->PciWindow64.Length = 0;\r
\r
      Status = EFI_SUCCESS;\r
    }\r
\r
    FreePool (AllDesc);\r
  }\r
\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "ACPI PciWindow32: Base=0x%08lx End=0x%08lx Length=0x%08lx\n",\r
    FwData->PciWindow32.Base,\r
    FwData->PciWindow32.End,\r
    FwData->PciWindow32.Length\r
    ));\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "ACPI PciWindow64: Base=0x%08lx End=0x%08lx Length=0x%08lx\n",\r
    FwData->PciWindow64.Base,\r
    FwData->PciWindow64.End,\r
    FwData->PciWindow64.Length\r
    ));\r
\r
  return Status;\r
}\r
\r
\r
STATIC\r
VOID\r
EFIAPI\r
GetSuspendStates (\r
  UINTN                *SuspendToRamSize,\r
  SYSTEM_STATE_PACKAGE *SuspendToRam,\r
  UINTN                *SuspendToDiskSize,\r
  SYSTEM_STATE_PACKAGE *SuspendToDisk\r
  )\r
{\r
  STATIC CONST SYSTEM_STATE_PACKAGE Template = {\r
    0x08,                   // NameOp\r
    '\\',                   // RootChar\r
    { '_', 'S', 'x', '_' }, // NameChar[4]\r
    0x12,                   // PackageOp\r
    0x0A,                   // PkgLength\r
    0x04,                   // NumElements\r
    { 0x0A, 0x00 },         // Pm1aCntSlpTyp\r
    { 0x0A, 0x00 },         // Pm1bCntSlpTyp -- we don't support it\r
    {                       // Reserved[2]\r
      { 0x0A, 0x00 },\r
      { 0x0A, 0x00 }\r
    }\r
  };\r
  RETURN_STATUS                     Status;\r
  FIRMWARE_CONFIG_ITEM              FwCfgItem;\r
  UINTN                             FwCfgSize;\r
  UINT8                             SystemStates[6];\r
\r
  //\r
  // configure defaults\r
  //\r
  *SuspendToRamSize = sizeof Template;\r
  CopyMem (SuspendToRam, &Template, sizeof Template);\r
  SuspendToRam->NameChar[2]             = '3'; // S3\r
  SuspendToRam->Pm1aCntSlpTyp.ByteValue = 1;   // PIIX4: STR\r
\r
  *SuspendToDiskSize = sizeof Template;\r
  CopyMem (SuspendToDisk, &Template, sizeof Template);\r
  SuspendToDisk->NameChar[2]             = '4'; // S4\r
  SuspendToDisk->Pm1aCntSlpTyp.ByteValue = 2;   // PIIX4: POSCL\r
\r
  //\r
  // check for overrides\r
  //\r
  Status = QemuFwCfgFindFile ("etc/system-states", &FwCfgItem, &FwCfgSize);\r
  if (Status != RETURN_SUCCESS || FwCfgSize != sizeof SystemStates) {\r
    DEBUG ((DEBUG_INFO, "ACPI using S3/S4 defaults\n"));\r
    return;\r
  }\r
  QemuFwCfgSelectItem (FwCfgItem);\r
  QemuFwCfgReadBytes (sizeof SystemStates, SystemStates);\r
\r
  //\r
  // Each byte corresponds to a system state. In each byte, the MSB tells us\r
  // whether the given state is enabled. If so, the three LSBs specify the\r
  // value to be written to the PM control register's SUS_TYP bits.\r
  //\r
  if (SystemStates[3] & BIT7) {\r
    SuspendToRam->Pm1aCntSlpTyp.ByteValue =\r
        SystemStates[3] & (BIT2 | BIT1 | BIT0);\r
    DEBUG ((DEBUG_INFO, "ACPI S3 value: %d\n",\r
            SuspendToRam->Pm1aCntSlpTyp.ByteValue));\r
  } else {\r
    *SuspendToRamSize = 0;\r
    DEBUG ((DEBUG_INFO, "ACPI S3 disabled\n"));\r
  }\r
\r
  if (SystemStates[4] & BIT7) {\r
    SuspendToDisk->Pm1aCntSlpTyp.ByteValue =\r
        SystemStates[4] & (BIT2 | BIT1 | BIT0);\r
    DEBUG ((DEBUG_INFO, "ACPI S4 value: %d\n",\r
            SuspendToDisk->Pm1aCntSlpTyp.ByteValue));\r
  } else {\r
    *SuspendToDiskSize = 0;\r
    DEBUG ((DEBUG_INFO, "ACPI S4 disabled\n"));\r
  }\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                SuspendToRamSize;\r
    SYSTEM_STATE_PACKAGE SuspendToRam;\r
    UINTN                SuspendToDiskSize;\r
    SYSTEM_STATE_PACKAGE SuspendToDisk;\r
    UINTN                SsdtSize;\r
    UINT8                *Ssdt;\r
\r
    GetSuspendStates (&SuspendToRamSize,  &SuspendToRam,\r
                      &SuspendToDiskSize, &SuspendToDisk);\r
    SsdtSize = AcpiTableBufferSize + 17 + SuspendToRamSize + SuspendToDiskSize;\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
        //\r
        // add suspend system states\r
        //\r
        CopyMem (SsdtPtr, &SuspendToRam, SuspendToRamSize);\r
        SsdtPtr += SuspendToRamSize;\r
        CopyMem (SsdtPtr, &SuspendToDisk, SuspendToDiskSize);\r
        SsdtPtr += SuspendToDiskSize;\r
\r
        ASSERT((UINTN) (SsdtPtr - Ssdt) == SsdtSize);\r
        ((EFI_ACPI_DESCRIPTION_HEADER *) Ssdt)->Length = (UINT32) 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
Commit	Line	Data
522203de	1	/** @file\r
	2	OVMF ACPI QEMU support\r
	3	\r
ce883845	4	Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
14430c55	5	\r
2d1fe950	6	Copyright (C) 2012-2014, Red Hat, Inc.\r
14430c55	7	\r
522203de	8	This program and the accompanying materials\r
	9	are licensed and made available under the terms and conditions of the BSD License\r
	10	which accompanies this distribution. The full text of the license may be found at\r
	11	http://opensource.org/licenses/bsd-license.php\r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	15	\r
253a2ea7	16	**/\r
522203de	17	\r
522203de	18	#include "AcpiPlatform.h"\r
a618eaa1	19	#include "QemuLoader.h"\r
255b4184	20	#include <Library/BaseMemoryLib.h>\r
255b4184	21	#include <Library/MemoryAllocationLib.h>\r
522203de	22	#include <Library/QemuFwCfgLib.h>\r
57c0beb6	23	#include <Library/DxeServicesTableLib.h>\r
498f7d8d	24	#include <Library/PcdLib.h>\r
387536e4	25	#include <Library/OrderedCollectionLib.h>\r
498f7d8d	26	#include <IndustryStandard/Acpi.h>\r
522203de	27	\r
	28	BOOLEAN\r
	29	QemuDetected (\r
	30	VOID\r
	31	)\r
	32	{\r
	33	if (!QemuFwCfgIsAvailable ()) {\r
	34	return FALSE;\r
	35	}\r
	36	\r
	37	return TRUE;\r
	38	}\r
	39	\r
	40	\r
498f7d8d	41	STATIC\r
	42	UINTN\r
	43	CountBits16 (\r
	44	UINT16 Mask\r
	45	)\r
	46	{\r
	47	//\r
	48	// For all N >= 1, N bits are enough to represent the number of bits set\r
	49	// among N bits. It's true for N == 1. When adding a new bit (N := N+1),\r
	50	// the maximum number of possibly set bits increases by one, while the\r
	51	// representable maximum doubles.\r
	52	//\r
	53	Mask = ((Mask & 0xAAAA) >> 1) + (Mask & 0x5555);\r
	54	Mask = ((Mask & 0xCCCC) >> 2) + (Mask & 0x3333);\r
	55	Mask = ((Mask & 0xF0F0) >> 4) + (Mask & 0x0F0F);\r
	56	Mask = ((Mask & 0xFF00) >> 8) + (Mask & 0x00FF);\r
	57	\r
	58	return Mask;\r
	59	}\r
	60	\r
	61	\r
255b4184	62	STATIC\r
	63	EFI_STATUS\r
	64	EFIAPI\r
	65	QemuInstallAcpiMadtTable (\r
	66	IN EFI_ACPI_TABLE_PROTOCOL *AcpiProtocol,\r
	67	IN VOID *AcpiTableBuffer,\r
	68	IN UINTN AcpiTableBufferSize,\r
	69	OUT UINTN *TableKey\r
	70	)\r
	71	{\r
498f7d8d	72	UINTN CpuCount;\r
	73	UINTN PciLinkIsoCount;\r
	74	UINTN NewBufferSize;\r
	75	EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER *Madt;\r
	76	EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE *LocalApic;\r
	77	EFI_ACPI_1_0_IO_APIC_STRUCTURE *IoApic;\r
	78	EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE *Iso;\r
	79	EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE *LocalApicNmi;\r
	80	VOID *Ptr;\r
	81	UINTN Loop;\r
	82	EFI_STATUS Status;\r
	83	\r
	84	ASSERT (AcpiTableBufferSize >= sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
255b4184	85	\r
255b4184	86	QemuFwCfgSelectItem (QemuFwCfgItemSmpCpuCount);\r
498f7d8d	87	CpuCount = QemuFwCfgRead16 ();\r
498f7d8d	88	ASSERT (CpuCount >= 1);\r
255b4184	89	\r
255b4184	90	//\r
498f7d8d	91	// Set Level-tiggered, Active High for these identity mapped IRQs. The bitset\r
	92	// corresponds to the union of all possible interrupt assignments for the LNKA,\r
	93	// LNKB, LNKC, LNKD PCI interrupt lines. See the DSDT.\r
255b4184	94	//\r
498f7d8d	95	PciLinkIsoCount = CountBits16 (PcdGet16 (Pcd8259LegacyModeEdgeLevel));\r
255b4184	96	\r
498f7d8d	97	NewBufferSize = 1 * sizeof (*Madt) +\r
	98	CpuCount * sizeof (*LocalApic) +\r
	99	1 * sizeof (*IoApic) +\r
	100	(1 + PciLinkIsoCount) * sizeof (*Iso) +\r
	101	1 * sizeof (*LocalApicNmi);\r
255b4184	102	\r
498f7d8d	103	Madt = AllocatePool (NewBufferSize);\r
	104	if (Madt == NULL) {\r
	105	return EFI_OUT_OF_RESOURCES;\r
	106	}\r
	107	\r
ff8dd312	108	CopyMem (&(Madt->Header), AcpiTableBuffer, sizeof (EFI_ACPI_DESCRIPTION_HEADER));\r
ff8dd312	109	Madt->Header.Length = (UINT32) NewBufferSize;\r
498f7d8d	110	Madt->LocalApicAddress = PcdGet32 (PcdCpuLocalApicBaseAddress);\r
	111	Madt->Flags = EFI_ACPI_1_0_PCAT_COMPAT;\r
	112	Ptr = Madt + 1;\r
	113	\r
	114	LocalApic = Ptr;\r
	115	for (Loop = 0; Loop < CpuCount; ++Loop) {\r
	116	LocalApic->Type = EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC;\r
	117	LocalApic->Length = sizeof (*LocalApic);\r
ff8dd312	118	LocalApic->AcpiProcessorId = (UINT8) Loop;\r
ff8dd312	119	LocalApic->ApicId = (UINT8) Loop;\r
498f7d8d	120	LocalApic->Flags = 1; // enabled\r
	121	++LocalApic;\r
	122	}\r
	123	Ptr = LocalApic;\r
	124	\r
	125	IoApic = Ptr;\r
	126	IoApic->Type = EFI_ACPI_1_0_IO_APIC;\r
	127	IoApic->Length = sizeof (*IoApic);\r
ff8dd312	128	IoApic->IoApicId = (UINT8) CpuCount;\r
498f7d8d	129	IoApic->Reserved = EFI_ACPI_RESERVED_BYTE;\r
	130	IoApic->IoApicAddress = 0xFEC00000;\r
	131	IoApic->SystemVectorBase = 0x00000000;\r
	132	Ptr = IoApic + 1;\r
255b4184	133	\r
255b4184	134	//\r
498f7d8d	135	// IRQ0 (8254 Timer) => IRQ2 (PIC) Interrupt Source Override Structure\r
255b4184	136	//\r
498f7d8d	137	Iso = Ptr;\r
	138	Iso->Type = EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE;\r
	139	Iso->Length = sizeof (*Iso);\r
	140	Iso->Bus = 0x00; // ISA\r
	141	Iso->Source = 0x00; // IRQ0\r
	142	Iso->GlobalSystemInterruptVector = 0x00000002;\r
	143	Iso->Flags = 0x0000; // Conforms to specs of the bus\r
	144	++Iso;\r
255b4184	145	\r
498f7d8d	146	//\r
	147	// Set Level-tiggered, Active High for all possible PCI link targets.\r
	148	//\r
	149	for (Loop = 0; Loop < 16; ++Loop) {\r
	150	if ((PcdGet16 (Pcd8259LegacyModeEdgeLevel) & (1 << Loop)) == 0) {\r
	151	continue;\r
	152	}\r
	153	Iso->Type = EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE;\r
	154	Iso->Length = sizeof (*Iso);\r
	155	Iso->Bus = 0x00; // ISA\r
ff8dd312	156	Iso->Source = (UINT8) Loop;\r
ff8dd312	157	Iso->GlobalSystemInterruptVector = (UINT32) Loop;\r
498f7d8d	158	Iso->Flags = 0x000D; // Level-tiggered, Active High\r
	159	++Iso;\r
	160	}\r
	161	ASSERT (\r
ff8dd312	162	(UINTN) (Iso - (EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE *)Ptr) ==\r
498f7d8d	163	1 + PciLinkIsoCount\r
	164	);\r
	165	Ptr = Iso;\r
	166	\r
	167	LocalApicNmi = Ptr;\r
	168	LocalApicNmi->Type = EFI_ACPI_1_0_LOCAL_APIC_NMI;\r
	169	LocalApicNmi->Length = sizeof (*LocalApicNmi);\r
	170	LocalApicNmi->AcpiProcessorId = 0xFF; // applies to all processors\r
	171	//\r
	172	// polarity and trigger mode of the APIC I/O input signals conform to the\r
	173	// specifications of the bus\r
	174	//\r
	175	LocalApicNmi->Flags = 0x0000;\r
	176	//\r
	177	// Local APIC interrupt input LINTn to which NMI is connected.\r
	178	//\r
	179	LocalApicNmi->LocalApicInti = 0x01;\r
	180	Ptr = LocalApicNmi + 1;\r
255b4184	181	\r
ff8dd312	182	ASSERT ((UINTN) ((UINT8 )Ptr - (UINT8 )Madt) == NewBufferSize);\r
498f7d8d	183	Status = InstallAcpiTable (AcpiProtocol, Madt, NewBufferSize, TableKey);\r
255b4184	184	\r
498f7d8d	185	FreePool (Madt);\r
255b4184	186	\r
	187	return Status;\r
	188	}\r
	189	\r
	190	\r
253a2ea7	191	#pragma pack(1)\r
	192	\r
	193	typedef struct {\r
	194	UINT64 Base;\r
	195	UINT64 End;\r
	196	UINT64 Length;\r
	197	} PCI_WINDOW;\r
	198	\r
	199	typedef struct {\r
	200	PCI_WINDOW PciWindow32;\r
	201	PCI_WINDOW PciWindow64;\r
	202	} FIRMWARE_DATA;\r
	203	\r
14430c55	204	typedef struct {\r
3d80db51	205	UINT8 BytePrefix;\r
	206	UINT8 ByteValue;\r
	207	} AML_BYTE;\r
	208	\r
	209	typedef struct {\r
	210	UINT8 NameOp;\r
	211	UINT8 RootChar;\r
	212	UINT8 NameChar[4];\r
	213	UINT8 PackageOp;\r
	214	UINT8 PkgLength;\r
	215	UINT8 NumElements;\r
	216	AML_BYTE Pm1aCntSlpTyp;\r
	217	AML_BYTE Pm1bCntSlpTyp;\r
	218	AML_BYTE Reserved[2];\r
14430c55	219	} SYSTEM_STATE_PACKAGE;\r
14430c55	220	\r
253a2ea7	221	#pragma pack()\r
	222	\r
	223	\r
	224	STATIC\r
	225	EFI_STATUS\r
	226	EFIAPI\r
	227	PopulateFwData(\r
	228	OUT FIRMWARE_DATA *FwData\r
	229	)\r
	230	{\r
57c0beb6	231	EFI_STATUS Status;\r
	232	UINTN NumDesc;\r
	233	EFI_GCD_MEMORY_SPACE_DESCRIPTOR *AllDesc;\r
	234	\r
	235	Status = gDS->GetMemorySpaceMap (&NumDesc, &AllDesc);\r
	236	if (Status == EFI_SUCCESS) {\r
	237	UINT64 NonMmio32MaxExclTop;\r
	238	UINT64 Mmio32MinBase;\r
	239	UINT64 Mmio32MaxExclTop;\r
	240	UINTN CurDesc;\r
	241	\r
	242	Status = EFI_UNSUPPORTED;\r
	243	\r
	244	NonMmio32MaxExclTop = 0;\r
	245	Mmio32MinBase = BASE_4GB;\r
	246	Mmio32MaxExclTop = 0;\r
	247	\r
	248	for (CurDesc = 0; CurDesc < NumDesc; ++CurDesc) {\r
	249	CONST EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Desc;\r
	250	UINT64 ExclTop;\r
	251	\r
	252	Desc = &AllDesc[CurDesc];\r
	253	ExclTop = Desc->BaseAddress + Desc->Length;\r
	254	\r
2662fa8d	255	if (ExclTop <= (UINT64) PcdGet32 (PcdOvmfFdBaseAddress)) {\r
57c0beb6	256	switch (Desc->GcdMemoryType) {\r
	257	case EfiGcdMemoryTypeNonExistent:\r
	258	break;\r
	259	\r
	260	case EfiGcdMemoryTypeReserved:\r
	261	case EfiGcdMemoryTypeSystemMemory:\r
	262	if (NonMmio32MaxExclTop < ExclTop) {\r
	263	NonMmio32MaxExclTop = ExclTop;\r
	264	}\r
	265	break;\r
	266	\r
	267	case EfiGcdMemoryTypeMemoryMappedIo:\r
	268	if (Mmio32MinBase > Desc->BaseAddress) {\r
	269	Mmio32MinBase = Desc->BaseAddress;\r
	270	}\r
	271	if (Mmio32MaxExclTop < ExclTop) {\r
	272	Mmio32MaxExclTop = ExclTop;\r
	273	}\r
	274	break;\r
	275	\r
	276	default:\r
	277	ASSERT(0);\r
	278	}\r
	279	}\r
	280	}\r
	281	\r
	282	if (Mmio32MinBase < NonMmio32MaxExclTop) {\r
	283	Mmio32MinBase = NonMmio32MaxExclTop;\r
	284	}\r
	285	\r
	286	if (Mmio32MinBase < Mmio32MaxExclTop) {\r
	287	FwData->PciWindow32.Base = Mmio32MinBase;\r
	288	FwData->PciWindow32.End = Mmio32MaxExclTop - 1;\r
	289	FwData->PciWindow32.Length = Mmio32MaxExclTop - Mmio32MinBase;\r
	290	\r
	291	FwData->PciWindow64.Base = 0;\r
	292	FwData->PciWindow64.End = 0;\r
	293	FwData->PciWindow64.Length = 0;\r
	294	\r
	295	Status = EFI_SUCCESS;\r
	296	}\r
	297	\r
	298	FreePool (AllDesc);\r
	299	}\r
	300	\r
	301	DEBUG ((\r
	302	DEBUG_INFO,\r
	303	"ACPI PciWindow32: Base=0x%08lx End=0x%08lx Length=0x%08lx\n",\r
	304	FwData->PciWindow32.Base,\r
	305	FwData->PciWindow32.End,\r
	306	FwData->PciWindow32.Length\r
	307	));\r
	308	DEBUG ((\r
	309	DEBUG_INFO,\r
	310	"ACPI PciWindow64: Base=0x%08lx End=0x%08lx Length=0x%08lx\n",\r
	311	FwData->PciWindow64.Base,\r
	312	FwData->PciWindow64.End,\r
	313	FwData->PciWindow64.Length\r
	314	));\r
	315	\r
	316	return Status;\r
253a2ea7	317	}\r
	318	\r
	319	\r
14430c55	320	STATIC\r
	321	VOID\r
	322	EFIAPI\r
	323	GetSuspendStates (\r
	324	UINTN *SuspendToRamSize,\r
	325	SYSTEM_STATE_PACKAGE *SuspendToRam,\r
	326	UINTN *SuspendToDiskSize,\r
	327	SYSTEM_STATE_PACKAGE *SuspendToDisk\r
	328	)\r
	329	{\r
	330	STATIC CONST SYSTEM_STATE_PACKAGE Template = {\r
	331	0x08, // NameOp\r
	332	'\\', // RootChar\r
	333	{ '_', 'S', 'x', '_' }, // NameChar[4]\r
	334	0x12, // PackageOp\r
3d80db51	335	0x0A, // PkgLength\r
	336	0x04, // NumElements\r
	337	{ 0x0A, 0x00 }, // Pm1aCntSlpTyp\r
	338	{ 0x0A, 0x00 }, // Pm1bCntSlpTyp -- we don't support it\r
	339	{ // Reserved[2]\r
	340	{ 0x0A, 0x00 },\r
	341	{ 0x0A, 0x00 }\r
	342	}\r
14430c55	343	};\r
	344	RETURN_STATUS Status;\r
	345	FIRMWARE_CONFIG_ITEM FwCfgItem;\r
	346	UINTN FwCfgSize;\r
	347	UINT8 SystemStates[6];\r
	348	\r
	349	//\r
	350	// configure defaults\r
	351	//\r
	352	*SuspendToRamSize = sizeof Template;\r
	353	CopyMem (SuspendToRam, &Template, sizeof Template);\r
3d80db51	354	SuspendToRam->NameChar[2] = '3'; // S3\r
3d80db51	355	SuspendToRam->Pm1aCntSlpTyp.ByteValue = 1; // PIIX4: STR\r
14430c55	356	\r
	357	*SuspendToDiskSize = sizeof Template;\r
	358	CopyMem (SuspendToDisk, &Template, sizeof Template);\r
3d80db51	359	SuspendToDisk->NameChar[2] = '4'; // S4\r
3d80db51	360	SuspendToDisk->Pm1aCntSlpTyp.ByteValue = 2; // PIIX4: POSCL\r
14430c55	361	\r
	362	//\r
	363	// check for overrides\r
	364	//\r
	365	Status = QemuFwCfgFindFile ("etc/system-states", &FwCfgItem, &FwCfgSize);\r
	366	if (Status != RETURN_SUCCESS \|\| FwCfgSize != sizeof SystemStates) {\r
	367	DEBUG ((DEBUG_INFO, "ACPI using S3/S4 defaults\n"));\r
	368	return;\r
	369	}\r
	370	QemuFwCfgSelectItem (FwCfgItem);\r
	371	QemuFwCfgReadBytes (sizeof SystemStates, SystemStates);\r
	372	\r
	373	//\r
	374	// Each byte corresponds to a system state. In each byte, the MSB tells us\r
	375	// whether the given state is enabled. If so, the three LSBs specify the\r
	376	// value to be written to the PM control register's SUS_TYP bits.\r
	377	//\r
	378	if (SystemStates[3] & BIT7) {\r
3d80db51	379	SuspendToRam->Pm1aCntSlpTyp.ByteValue =\r
	380	SystemStates[3] & (BIT2 \| BIT1 \| BIT0);\r
	381	DEBUG ((DEBUG_INFO, "ACPI S3 value: %d\n",\r
	382	SuspendToRam->Pm1aCntSlpTyp.ByteValue));\r
14430c55	383	} else {\r
	384	*SuspendToRamSize = 0;\r
	385	DEBUG ((DEBUG_INFO, "ACPI S3 disabled\n"));\r
	386	}\r
	387	\r
	388	if (SystemStates[4] & BIT7) {\r
3d80db51	389	SuspendToDisk->Pm1aCntSlpTyp.ByteValue =\r
	390	SystemStates[4] & (BIT2 \| BIT1 \| BIT0);\r
	391	DEBUG ((DEBUG_INFO, "ACPI S4 value: %d\n",\r
	392	SuspendToDisk->Pm1aCntSlpTyp.ByteValue));\r
14430c55	393	} else {\r
	394	*SuspendToDiskSize = 0;\r
	395	DEBUG ((DEBUG_INFO, "ACPI S4 disabled\n"));\r
	396	}\r
	397	}\r
	398	\r
	399	\r
253a2ea7	400	STATIC\r
	401	EFI_STATUS\r
	402	EFIAPI\r
	403	QemuInstallAcpiSsdtTable (\r
	404	IN EFI_ACPI_TABLE_PROTOCOL *AcpiProtocol,\r
	405	IN VOID *AcpiTableBuffer,\r
	406	IN UINTN AcpiTableBufferSize,\r
	407	OUT UINTN *TableKey\r
	408	)\r
	409	{\r
	410	EFI_STATUS Status;\r
	411	FIRMWARE_DATA *FwData;\r
	412	\r
	413	Status = EFI_OUT_OF_RESOURCES;\r
	414	\r
	415	FwData = AllocateReservedPool (sizeof (*FwData));\r
	416	if (FwData != NULL) {\r
14430c55	417	UINTN SuspendToRamSize;\r
	418	SYSTEM_STATE_PACKAGE SuspendToRam;\r
	419	UINTN SuspendToDiskSize;\r
	420	SYSTEM_STATE_PACKAGE SuspendToDisk;\r
	421	UINTN SsdtSize;\r
	422	UINT8 *Ssdt;\r
	423	\r
	424	GetSuspendStates (&SuspendToRamSize, &SuspendToRam,\r
	425	&SuspendToDiskSize, &SuspendToDisk);\r
	426	SsdtSize = AcpiTableBufferSize + 17 + SuspendToRamSize + SuspendToDiskSize;\r
253a2ea7	427	Ssdt = AllocatePool (SsdtSize);\r
	428	\r
	429	if (Ssdt != NULL) {\r
	430	Status = PopulateFwData (FwData);\r
	431	\r
	432	if (Status == EFI_SUCCESS) {\r
	433	UINT8 *SsdtPtr;\r
	434	\r
	435	SsdtPtr = Ssdt;\r
	436	\r
	437	CopyMem (SsdtPtr, AcpiTableBuffer, AcpiTableBufferSize);\r
	438	SsdtPtr += AcpiTableBufferSize;\r
	439	\r
	440	//\r
	441	// build "OperationRegion(FWDT, SystemMemory, 0x12345678, 0x87654321)"\r
	442	//\r
	443	*(SsdtPtr++) = 0x5B; // ExtOpPrefix\r
	444	*(SsdtPtr++) = 0x80; // OpRegionOp\r
	445	*(SsdtPtr++) = 'F';\r
	446	*(SsdtPtr++) = 'W';\r
	447	*(SsdtPtr++) = 'D';\r
	448	*(SsdtPtr++) = 'T';\r
	449	*(SsdtPtr++) = 0x00; // SystemMemory\r
	450	*(SsdtPtr++) = 0x0C; // DWordPrefix\r
	451	\r
	452	//\r
	453	// no virtual addressing yet, take the four least significant bytes\r
	454	//\r
	455	CopyMem(SsdtPtr, &FwData, 4);\r
	456	SsdtPtr += 4;\r
	457	\r
	458	*(SsdtPtr++) = 0x0C; // DWordPrefix\r
	459	\r
	460	(UINT32) SsdtPtr = sizeof (*FwData);\r
	461	SsdtPtr += 4;\r
	462	\r
14430c55	463	//\r
	464	// add suspend system states\r
	465	//\r
	466	CopyMem (SsdtPtr, &SuspendToRam, SuspendToRamSize);\r
	467	SsdtPtr += SuspendToRamSize;\r
	468	CopyMem (SsdtPtr, &SuspendToDisk, SuspendToDiskSize);\r
	469	SsdtPtr += SuspendToDiskSize;\r
	470	\r
26af9aca	471	ASSERT((UINTN) (SsdtPtr - Ssdt) == SsdtSize);\r
26af9aca	472	((EFI_ACPI_DESCRIPTION_HEADER *) Ssdt)->Length = (UINT32) SsdtSize;\r
253a2ea7	473	Status = InstallAcpiTable (AcpiProtocol, Ssdt, SsdtSize, TableKey);\r
	474	}\r
	475	\r
	476	FreePool(Ssdt);\r
	477	}\r
	478	\r
	479	if (Status != EFI_SUCCESS) {\r
	480	FreePool(FwData);\r
	481	}\r
	482	}\r
	483	\r
	484	return Status;\r
	485	}\r
	486	\r
	487	\r
522203de	488	EFI_STATUS\r
	489	EFIAPI\r
	490	QemuInstallAcpiTable (\r
	491	IN EFI_ACPI_TABLE_PROTOCOL *AcpiProtocol,\r
	492	IN VOID *AcpiTableBuffer,\r
	493	IN UINTN AcpiTableBufferSize,\r
	494	OUT UINTN *TableKey\r
	495	)\r
	496	{\r
255b4184	497	EFI_ACPI_DESCRIPTION_HEADER *Hdr;\r
	498	EFI_ACPI_TABLE_INSTALL_ACPI_TABLE TableInstallFunction;\r
	499	\r
	500	Hdr = (EFI_ACPI_DESCRIPTION_HEADER*) AcpiTableBuffer;\r
	501	switch (Hdr->Signature) {\r
	502	case EFI_ACPI_1_0_APIC_SIGNATURE:\r
	503	TableInstallFunction = QemuInstallAcpiMadtTable;\r
	504	break;\r
253a2ea7	505	case EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE:\r
	506	TableInstallFunction = QemuInstallAcpiSsdtTable;\r
	507	break;\r
255b4184	508	default:\r
	509	TableInstallFunction = InstallAcpiTable;\r
	510	}\r
	511	\r
	512	return TableInstallFunction (\r
522203de	513	AcpiProtocol,\r
	514	AcpiTableBuffer,\r
	515	AcpiTableBufferSize,\r
	516	TableKey\r
	517	);\r
	518	}\r