MdePkg AcpiSdt: Update description of AcpiVersion and GetAcpiTable().

Follow PI 1.4 spec,
1. Add EFI_ACPI_TABLE_VERSION_5_0 definition.
2. Update AcpiVersion description in the EFI_ACPI_SDT_PROTOCOL section.
3. Update TableKey parameter description in the
EFI_ACPI_SDT_PROTOCOL.GetAcpiTable() section.
4. Update EFI_ACPI_SDT_PROTOCOL.GetAcpiTable() description.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17648 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h b/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h
index f7e859719dc23daec9cccd4673bed2e094760308..faacbfc46f6fd1def21a1b9bf1ec01b525cd9ad6 100644 (file)
--- a/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h
+++ b/MdePkg/Include/Protocol/AcpiSystemDescriptionTable.h
@@ -1,7 +1,7 @@
 /** @file\r
   This protocol provides services for creating ACPI system description tables.\r
   \r
-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 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
@@ -26,6 +26,7 @@ typedef VOID    *EFI_ACPI_HANDLE;
 #define EFI_ACPI_TABLE_VERSION_2_0  (1 << 2)\r
 #define EFI_ACPI_TABLE_VERSION_3_0  (1 << 3)\r
 #define EFI_ACPI_TABLE_VERSION_4_0  (1 << 4)\r
+#define EFI_ACPI_TABLE_VERSION_5_0  (1 << 5)\r
   \r
 typedef UINT32 EFI_ACPI_DATA_TYPE;\r
 #define EFI_ACPI_DATA_TYPE_NONE         0\r
@@ -66,16 +67,19 @@ EFI_STATUS
   - 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
-                            \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
 **/  \r
@@ -243,7 +247,7 @@ EFI_STATUS
 \r
 typedef struct _EFI_ACPI_SDT_PROTOCOL {\r
   ///\r
-  /// Specifies the ACPI version supported by this protocol.\r
+  /// A bit map containing all the ACPI versions supported by this protocol.\r
   ///\r
   EFI_ACPI_TABLE_VERSION    AcpiVersion;\r
   EFI_ACPI_GET_ACPI_TABLE2  GetAcpiTable;\r