OvmfPkg: AcpiTimerLib: Split into multiple phase-specific instances

[mirror_edk2.git] / OvmfPkg / Library / AcpiTimerLib / BaseRomAcpiTimerLib.c

/** @file\r
  Provide constructor and GetTick for BaseRom instance of ACPI Timer Library\r
\r
  Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.\r
  Copyright (c) 2011, Andrei Warkentin <andreiw@motorola.com>\r
\r
  This program and the accompanying materials are licensed and made\r
  available under the terms and conditions of the BSD License which\r
  accompanies this distribution.   The full text of the license may\r
  be found at 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
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/PcdLib.h>\r
#include <OvmfPlatforms.h>\r
\r
//\r
// Power Management PCI Configuration Register fields\r
//\r
#define PMBA_RTE  BIT0\r
#define PMIOSE    BIT0\r
\r
//\r
// Offset in the Power Management Base Address to the ACPI Timer\r
//\r
#define ACPI_TIMER_OFFSET      0x8\r
\r
/**\r
  The constructor function enables ACPI IO space.\r
\r
  If ACPI I/O space not enabled, this function will enable it.\r
  It will always return RETURN_SUCCESS.\r
\r
  @retval EFI_SUCCESS   The constructor always returns RETURN_SUCCESS.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
AcpiTimerLibConstructor (\r
  VOID\r
  )\r
{\r
  UINT16 HostBridgeDevId;\r
  UINTN Pmba;\r
  UINTN PmRegMisc;\r
\r
  //\r
  // Query Host Bridge DID to determine platform type\r
  //\r
  HostBridgeDevId = PciRead16 (OVMF_HOSTBRIDGE_DID);\r
  switch (HostBridgeDevId) {\r
    case INTEL_82441_DEVICE_ID:\r
      Pmba      = POWER_MGMT_REGISTER_PIIX4 (0x40);\r
      PmRegMisc = POWER_MGMT_REGISTER_PIIX4 (0x80);\r
      break;\r
    case INTEL_Q35_MCH_DEVICE_ID:\r
      Pmba      = POWER_MGMT_REGISTER_Q35 (0x40);\r
      PmRegMisc = POWER_MGMT_REGISTER_Q35 (0x80);\r
      break;\r
    default:\r
      DEBUG ((EFI_D_ERROR, "%a: Unknown Host Bridge Device ID: 0x%04x\n",\r
        __FUNCTION__, HostBridgeDevId));\r
      ASSERT (FALSE);\r
      return RETURN_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Check to see if the Power Management Base Address is already enabled\r
  //\r
  if ((PciRead8 (PmRegMisc) & PMIOSE) == 0) {\r
    //\r
    // If the Power Management Base Address is not programmed,\r
    // then program the Power Management Base Address from a PCD.\r
    //\r
    PciAndThenOr32 (Pmba, (UINT32) ~0xFFC0, PcdGet16 (PcdAcpiPmBaseAddress));\r
\r
    //\r
    // Enable PMBA I/O port decodes in PMREGMISC\r
    //\r
    PciOr8 (PmRegMisc, PMIOSE);\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Internal function to read the current tick counter of ACPI.\r
\r
  Dynamically compute the address of the ACPI tick counter based on the\r
  properties of the underlying platform, to avoid relying on global variables.\r
\r
  @return The tick counter read.\r
\r
**/\r
UINT32\r
InternalAcpiGetTimerTick (\r
  VOID\r
  )\r
{\r
  UINT16 HostBridgeDevId;\r
  UINTN Pmba;\r
\r
  //\r
  // Query Host Bridge DID to determine platform type\r
  //\r
  HostBridgeDevId = PciRead16 (OVMF_HOSTBRIDGE_DID);\r
  switch (HostBridgeDevId) {\r
    case INTEL_82441_DEVICE_ID:\r
      Pmba = POWER_MGMT_REGISTER_PIIX4 (0x40);\r
      break;\r
    case INTEL_Q35_MCH_DEVICE_ID:\r
      Pmba = POWER_MGMT_REGISTER_Q35 (0x40);\r
      break;\r
    default:\r
      DEBUG ((EFI_D_ERROR, "%a: Unknown Host Bridge Device ID: 0x%04x\n",\r
        __FUNCTION__, HostBridgeDevId));\r
      ASSERT (FALSE);\r
      return 0;\r
  }\r
\r
  //\r
  //   Read PMBA to read and return the current ACPI timer value.\r
  //\r
  return IoRead32 ((PciRead32 (Pmba) & ~PMBA_RTE) + ACPI_TIMER_OFFSET);\r
}\r