Vlv2TbltDevicePkg/AcpiPlatform/AcpiPlatformHooksLib.h

   1 /*++
   2
   3   Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>
   4
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14 Module Name:
  15
  16   AcpiPlatformHooksLib.h
  17
  18 Abstract:
  19
  20   This is an implementation of the ACPI platform driver.  Requirements for
  21   this driver are defined in the Tiano ACPI External Product Specification,
  22   revision 0.3.6.
  23
  24 --*/
  25
  26 #ifndef _ACPI_PLATFORM_HOOKS_LIB_H_
  27 #define _ACPI_PLATFORM_HOOKS_LIB_H_
  28
  29 //
  30 // Statements that include other header files.
  31 //
  32 #include <IndustryStandard/Acpi.h>
  33
  34 /**
  35   Returns the ACPI table version that the platform wants.
  36
  37   @param[in]  None
  38
  39   @retval  EFI_ACPI_TABLE_VERSION_NONE  if ACPI is to be disabled.
  40   @retval  EFI_ACPI_TABLE_VERSION_1_0B  if 1.0b.
  41   @retval  EFI_ACPI_TABLE_VERSION_2_00  if 2.00.
  42 **/
  43 EFI_ACPI_TABLE_VERSION
  44 AcpiPlatformHooksGetAcpiTableVersion (
  45   VOID
  46   );
  47
  48 /**
  49   Returns the OEMID, OEM Table ID, OEM Revision.
  50
  51   @param[in]  None
  52
  53   @retval  OemId        OEM ID string for ACPI tables, maximum 6 ASCII characters.
  54                         This is an OEM-supplied string that identifies the OEM.
  55   @retval  OemTableId   An OEM-supplied string that the OEM uses to identify
  56                         the particular data table. This field is particularly useful
  57                         when defining a definition block to distinguish definition block
  58                         functions. The OEM assigns each dissimilar table a new OEM Table ID.
  59   @retval  OemRevision  An OEM-supplied revision number for ACPI tables.
  60                         Larger numbers are assumed to be newer revisions.
  61
  62 **/
  63 EFI_STATUS
  64 AcpiPlatformHooksGetOemFields (
  65   OUT UINT8   *OemId,
  66   OUT UINT64  *OemTableId,
  67   OUT UINT32  *OemRevision
  68   );
  69
  70  /**
  71   Called for every ACPI table found in the BIOS flash.
  72   Returns whether a table is active or not. Inactive tables
  73   are not published in the ACPI table list. This hook can be
  74   used to implement optional SSDT tables or enabling/disabling
  75   specific functionality (e.g. SPCR table) based on a setup
  76   switch or platform preference. In case of optional SSDT tables,
  77   the platform flash will include all the SSDT tables but will
  78   return EFI_SUCCESS only for those tables that need to be
  79   published.
  80   This hook can also be used to update the table data. The header
  81   is updated by the common code. For example, if a platform wants
  82   to use an SSDT table to export some platform settings to the
  83   ACPI code, it needs to update the data inside that SSDT based
  84   on platform preferences in this hook.
  85
  86   @param[in]  None
  87
  88   @retval  EFI_SUCCESS      if the table is active.
  89   @retval  EFI_UNSUPPORTED  if the table is not active.
  90 **/
  91 EFI_STATUS
  92 AcpiPlatformHooksIsActiveTable (
  93   IN OUT EFI_ACPI_COMMON_HEADER     *Table
  94   );
  95
  96 #endif