Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / AcpiSupport.h

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
index bca149ebd5c0c18c239cf76525a4c672e985555c..86d40da1462843cd0fba4841c5ed5409f339994c 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
@@ -1,8 +1,8 @@
 /** @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
+  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
@@ -18,7 +18,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
-  This Protocol is defined in Framework of ACPI Specification.\r
+  This Protocol is defined in Framework ACPI Specification.\r
   Version 0.9.\r
 \r
 **/\r
@@ -26,7 +26,7 @@
 #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
@@ -38,32 +38,6 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
     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
@@ -100,7 +74,7 @@ EFI_STATUS
   @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                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
@@ -127,7 +101,7 @@ EFI_STATUS
   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
@@ -147,20 +121,21 @@ EFI_STATUS
   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