/** @file\r
This protocol provides some basic services to support publishing ACPI system tables. The\r
services handle many of the more mundane tasks that are required to publish a set of tables. The\r
- services will do the following:\r
- - Generate common tables.\r
- - Update the table links.\r
- - Ensure that tables are properly aligned and use correct types of memory.\r
- - Update checksum values and IDs.\r
- - Complete the final installation of the tables.\r
-\r
- This is defined in the ACPI Specification 0.9.\r
- \r
- Copyright (c) 2007, Intel Corporation\r
- All rights reserved. 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
+ services will:\r
+ - Generate common tables.\r
+ - Update the table links.\r
+ - Ensure that tables are properly aligned and use correct types of memory.\r
+ - Update checksum values and IDs.\r
+ - Complete the final installation of the tables.\r
+\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+ @par Revision Reference:\r
+ This Protocol is defined in Framework ACPI Specification.\r
+ Version 0.9.\r
\r
**/\r
\r
#ifndef _ACPI_SUPPORT_PROTOCOL_H_\r
#define _ACPI_SUPPORT_PROTOCOL_H_\r
\r
-#include <PiDxe.h>\r
+#include <Protocol/AcpiSystemDescriptionTable.h>\r
\r
typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;\r
\r
0xdbff9d55, 0x89b7, 0x46da, {0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d } \\r
}\r
\r
-//\r
-// Protocol Data Definitions\r
-//\r
-//\r
-// ACPI Version bitmap definition:\r
-//\r
-// EFI_ACPI_TABLE_VERSION_1_0B - ACPI Version 1.0b\r
-// EFI_ACPI_TABLE_VERSION_2_0 - ACPI Version 2.0\r
-// EFI_ACPI_TABLE_VERSION_3_0 - ACPI Version 3.0\r
-// EFI_ACPI_TABLE_VERSION_NONE - No ACPI Versions. This might be used\r
-// to create memory-based operation regions or other information\r
-// that is not part of the ACPI "tree" but must still be found\r
-// in ACPI memory space and/or managed by the core ACPI driver.\r
-//\r
-// Note that EFI provides discrete GUIDs for each version of ACPI\r
-// that is supported. It is expected that each EFI GUIDed\r
-// version of ACPI will also have a corresponding bitmap\r
-// definition. This allows maintenance of separate ACPI trees\r
-// for each distinctly different version of ACPI.\r
-//\r
-#define EFI_ACPI_TABLE_VERSION UINT32\r
-\r
-#define EFI_ACPI_TABLE_VERSION_NONE (1 << 0)\r
-#define EFI_ACPI_TABLE_VERSION_1_0B (1 << 1)\r
-#define EFI_ACPI_TABLE_VERSION_2_0 (1 << 2)\r
-#define EFI_ACPI_TABLE_VERSION_3_0 (1 << 3)\r
\r
//\r
// Protocol Member Functions\r
\r
@param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
@param Index The zero-based index of the table to retrieve.\r
- @param Table Pointer for returning the table buffer.\r
+ @param Table The pointer for returning the table buffer.\r
@param Version Updated with the ACPI versions to which this table belongs.\r
- @param Handle Pointer for identifying the table.\r
+ @param Handle The pointer for identifying the table.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The requested index is too large and a table was not found.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ACPI_GET_ACPI_TABLE) (\r
+(EFIAPI *EFI_ACPI_GET_ACPI_TABLE)(\r
IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
IN INTN Index,\r
OUT VOID **Table,\r
Used to add, remove, or update ACPI tables.\r
\r
@param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
- @param Table Pointer to the new table to add or update.\r
+ @param Table The pointer to the new table to add or update.\r
@param Checksum If TRUE, indicates that the checksum should be\r
calculated for this table.\r
@param Version Indicates to which version(s) of ACPI the table should be added.\r
- @param Pointer to the handle of the table to remove or update.\r
+ @param Handle The pointer to the handle of the table to remove or update.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ACPI_SET_ACPI_TABLE) (\r
+(EFIAPI *EFI_ACPI_SET_ACPI_TABLE)(\r
IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
IN VOID *Table OPTIONAL,\r
IN BOOLEAN Checksum,\r
Causes one or more versions of the ACPI tables to be published in\r
the EFI system configuration tables.\r
\r
+ The PublishTables() function installs the ACPI tables for the versions that are specified in\r
+ Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once\r
+ published, tables will continue to be updated as tables are modified with\r
+ EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().\r
+\r
@param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
- @param Version Indicates to which version(s) of ACPI that the table should be published.\r
+ @param Version Indicates to which version(s) of ACPI the table should be published.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_ABORTED An error occurred and the function could not complete successfully.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ACPI_PUBLISH_TABLES) (\r
+(EFIAPI *EFI_ACPI_PUBLISH_TABLES)(\r
IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
IN EFI_ACPI_TABLE_VERSION Version\r
);\r
// ACPI Support Protocol\r
//\r
/**\r
- @par Protocol Description:\r
This protocol provides some basic services to support publishing ACPI system\r
tables. The services handle many of the more mundane tasks that are required\r
to publish a set of tables.\r
-\r
- @param GetAcpiTable\r
- Returns a table specified by an index if it exists.\r
-\r
- @param SetAcpiTable\r
- Adds, removes, or updates ACPI tables\r
-\r
- @param PublishTables\r
- Publishes the ACPI tables.\r
-\r
**/\r
struct _EFI_ACPI_SUPPORT_PROTOCOL {\r
+ ///\r
+ /// Returns a table specified by an index if it exists.\r
+ ///\r
EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r
+\r
+ ///\r
+ /// Adds, removes, or updates ACPI tables.\r
+ ///\r
EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
+\r
+ ///\r
+ /// Publishes the ACPI tables.\r
+ ///\r
EFI_ACPI_PUBLISH_TABLES PublishTables;\r
};\r
\r