Update comment in SMM Library class include file.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
index b0fa68ead70cfacff37205408f86483933394490..1b4e0ab0d1d2fb078d34618fa45de37316199a87 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiSupport.h
@@ -1,6 +1,13 @@
 /** @file\r
-  Definition of the ACPI Support protocol.\r
-\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
   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
@@ -10,16 +17,17 @@
   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
 \r
-  Module Name:  AcpiSupport.h\r
-\r
   @par Revision Reference:\r
-  This is defined in the ACPI Specification 0.9.\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
+\r
 typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;\r
 \r
 //\r
@@ -76,7 +84,7 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
 **/\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
@@ -92,7 +100,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
@@ -101,7 +109,7 @@ EFI_STATUS
 **/\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
@@ -113,6 +121,11 @@ EFI_STATUS
   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
 \r
@@ -122,7 +135,7 @@ EFI_STATUS
 **/\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
@@ -131,24 +144,22 @@ EFI_STATUS
 // 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
+/// Adds, removes, or updates ACPI tables\r
+///\r
   EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
+///\r
+/// Publishes the ACPI tables.\r
+///\r
   EFI_ACPI_PUBLISH_TABLES PublishTables;\r
 };\r
 \r