PerformancePkg/Include/Ich/GenericIch.h

/** @file
  Generic definitions for registers in the Intel Ich devices.

  These definitions should work for any version of Ich.

  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
  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.

**/

#ifndef _GENERIC_ICH_H_
#define _GENERIC_ICH_H_

/** @defgroup GenericIchDefs  Generic ICH Definitions.

Definitions beginning with "R_" are registers.
Definitions beginning with "B_" are bits within registers.
Definitions beginning with "V_" are meaningful values of bits within the registers.
**/
///@{

/// @defgroup IchPciAddressing  PCI Bus Address for ICH.
///@{
#define PCI_BUS_NUMBER_ICH                0x00  ///< ICH is on PCI Bus 0.
#define PCI_DEVICE_NUMBER_ICH_LPC           31  ///< ICH is Device 31.
#define PCI_FUNCTION_NUMBER_ICH_LPC          0  ///< ICH is Function 0.
///@}

/// @defgroup IchAcpiCntr   Control for the ICH's ACPI Counter.
///@{
#define R_ICH_LPC_ACPI_BASE                   0x40
#define R_ICH_LPC_ACPI_CNT                    0x44
#define   B_ICH_LPC_ACPI_CNT_ACPI_EN              0x80
///@}

/// @defgroup IchAcpiTimer  The ICH's ACPI Timer.
///@{
#define R_ACPI_PM1_TMR                        0x08
#define   V_ACPI_TMR_FREQUENCY                    3579545
#define   V_ACPI_PM1_TMR_MAX_VAL                  0x1000000 ///< The timer is 24 bit overflow.
///@}

/// Macro to generate the PCI address of any given ICH Register.
#define PCI_ICH_LPC_ADDRESS(Register) \
  ((UINTN)(PCI_LIB_ADDRESS (PCI_BUS_NUMBER_ICH, PCI_DEVICE_NUMBER_ICH_LPC, PCI_FUNCTION_NUMBER_ICH_LPC, Register)))

///@}
#endif  // _GENERIC_ICH_H_