Vlv2DeviceRefCodePkg&Vlv2TbltDevicePkg:Convert Mix to DOS.

[mirror_edk2.git] / Vlv2TbltDevicePkg / AcpiPlatform / AcpiPlatformHooksLib.h

/*++\r
\r
  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
                                                                                   \r\r
  This program and the accompanying materials are licensed and made available under\r\r
  the terms and conditions of the BSD License that accompanies this distribution.  \r\r
  The full text of the license may be found at                                     \r\r
  http://opensource.org/licenses/bsd-license.php.                                  \r\r
                                                                                   \r\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,            \r\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.    \r\r
                                                                                   \r\r
\r
Module Name:\r
\r
  AcpiPlatformHooksLib.h\r
\r
Abstract:\r
\r
  This is an implementation of the ACPI platform driver.  Requirements for\r
  this driver are defined in the Tiano ACPI External Product Specification,\r
  revision 0.3.6.\r
\r
--*/\r
\r
#ifndef _ACPI_PLATFORM_HOOKS_LIB_H_\r
#define _ACPI_PLATFORM_HOOKS_LIB_H_\r
\r
//\r
// Statements that include other header files.\r
//\r
#include <IndustryStandard/Acpi.h>\r
\r
/**\r
  Returns the ACPI table version that the platform wants.\r
\r
  @param[in]  None\r
\r
  @retval  EFI_ACPI_TABLE_VERSION_NONE  if ACPI is to be disabled.\r
  @retval  EFI_ACPI_TABLE_VERSION_1_0B  if 1.0b.\r
  @retval  EFI_ACPI_TABLE_VERSION_2_00  if 2.00.\r
**/\r
EFI_ACPI_TABLE_VERSION\r
AcpiPlatformHooksGetAcpiTableVersion (\r
  VOID\r
  );\r
\r
/**\r
  Returns the OEMID, OEM Table ID, OEM Revision.\r
\r
  @param[in]  None\r
\r
  @retval  OemId        OEM ID string for ACPI tables, maximum 6 ASCII characters.\r
                        This is an OEM-supplied string that identifies the OEM.\r
  @retval  OemTableId   An OEM-supplied string that the OEM uses to identify\r
                        the particular data table. This field is particularly useful\r
                        when defining a definition block to distinguish definition block\r
                        functions. The OEM assigns each dissimilar table a new OEM Table ID.\r
  @retval  OemRevision  An OEM-supplied revision number for ACPI tables.\r
                        Larger numbers are assumed to be newer revisions.\r
\r
**/\r
EFI_STATUS\r
AcpiPlatformHooksGetOemFields (\r
  OUT UINT8   *OemId,\r
  OUT UINT64  *OemTableId,\r
  OUT UINT32  *OemRevision\r
  );\r
\r
 /**\r
  Called for every ACPI table found in the BIOS flash.\r
  Returns whether a table is active or not. Inactive tables\r
  are not published in the ACPI table list. This hook can be\r
  used to implement optional SSDT tables or enabling/disabling\r
  specific functionality (e.g. SPCR table) based on a setup\r
  switch or platform preference. In case of optional SSDT tables,\r
  the platform flash will include all the SSDT tables but will\r
  return EFI_SUCCESS only for those tables that need to be\r
  published.\r
  This hook can also be used to update the table data. The header\r
  is updated by the common code. For example, if a platform wants\r
  to use an SSDT table to export some platform settings to the\r
  ACPI code, it needs to update the data inside that SSDT based\r
  on platform preferences in this hook.\r
\r
  @param[in]  None\r
\r
  @retval  EFI_SUCCESS      if the table is active.\r
  @retval  EFI_UNSUPPORTED  if the table is not active.\r
**/\r
EFI_STATUS\r
AcpiPlatformHooksIsActiveTable (\r
  IN OUT EFI_ACPI_COMMON_HEADER     *Table\r
  );\r
\r
#endif\r