MdeModulePkg AcpiTableDxe: Cover EFI_ACPI_TABLE_VERSION_5_0.

[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / AcpiTableDxe / AcpiSdt.h

diff --git a/MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiSdt.h b/MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiSdt.h
index 2eca1e432fac1680d5dd92ab1a6079fe842e679d..f11bdee9ac9dbb2e5b5451ea7172ba790494b84f 100644 (file)
--- a/MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiSdt.h
+++ b/MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiSdt.h
@@ -1,7 +1,7 @@
 /** @file\r
   ACPI Sdt Protocol Driver\r
 \r
-  Copyright (c) 2010, Intel Corporation. All rights reserved. <BR>\r
+  Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved. <BR>\r
   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
@@ -155,15 +155,18 @@ struct _AML_BYTE_ENCODING {
   - Root System Description Table (RSDT)\r
   - Extended System Description Table (XSDT)\r
   Version is updated with a bit map containing all the versions of ACPI of which the table is a\r
-  member.\r
+  member. For tables installed via the EFI_ACPI_TABLE_PROTOCOL.InstallAcpiTable() interface,\r
+  the function returns the value of EFI_ACPI_STD_PROTOCOL.AcpiVersion.\r
   \r
   @param[in]    Index       The zero-based index of the table to retrieve.\r
   @param[out]   Table       Pointer for returning the table buffer.\r
   @param[out]   Version     On return, updated with the ACPI versions to which this table belongs. Type\r
                             EFI_ACPI_TABLE_VERSION is defined in "Related Definitions" in the\r
                             EFI_ACPI_SDT_PROTOCOL.    \r
-  @param[out]   TableKey    On return, points to the table key for the specified ACPI system definition table. This\r
-                            is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL.  \r
+  @param[out]   TableKey    On return, points to the table key for the specified ACPI system definition table.\r
+                            This is identical to the table key used in the EFI_ACPI_TABLE_PROTOCOL.\r
+                            The TableKey can be passed to EFI_ACPI_TABLE_PROTOCOL.UninstallAcpiTable()\r
+                            to uninstall 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