MdePkg/ProcessorBind: add defines for page allocation granularity

[mirror_edk2.git] / MdePkg / Include / Protocol / AcpiTable.h

diff --git a/MdePkg/Include/Protocol/AcpiTable.h b/MdePkg/Include/Protocol/AcpiTable.h
index fbcc82780f244196730e41c32707514471d38b0f..6149b7e4533584b7ee259001582db5eafe9b4169 100644 (file)
--- a/MdePkg/Include/Protocol/AcpiTable.h
+++ b/MdePkg/Include/Protocol/AcpiTable.h
@@ -2,8 +2,8 @@
   The file provides the protocol to install or remove an ACPI\r
   table from a platform. \r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2014, 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
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -31,7 +31,12 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;
   copy into the RSDT/XSDT. InstallAcpiTable() must insert the new   \r
   table at the end of the RSDT/XSDT. To prevent namespace   \r
   collision, ACPI tables may be created using UEFI ACPI table   \r
-  format. See Appendix O. On successful output, TableKey is   \r
+  format. If this protocol is used to install a table with a\r
+  signature already present in the system, the new table will not\r
+  replace the existing table. It is a platform implementation\r
+  decision to add a new table with a signature matching an\r
+  existing table or disallow duplicate table signatures and\r
+  return EFI_ACCESS_DENIED. On successful output, TableKey is   \r
   initialized with a unique key. Its value may be used in a   \r
   subsequent call to UninstallAcpiTable to remove an ACPI table.   \r
   If an EFI application is running at the time of this call, the   \r
@@ -39,18 +44,18 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;
   longer considered valid.   \r
 \r
 \r
-  @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
+  @param This                 A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
 \r
-  @param AcpiTableBuffer  A pointer to a buffer containing the\r
-                          ACPI table to be installed.\r
+  @param AcpiTableBuffer      A pointer to a buffer containing the\r
+                              ACPI table to be installed.\r
 \r
   @param AcpiTableBufferSize  Specifies the size, in bytes, of\r
                               the AcpiTableBuffer buffer.\r
 \r
 \r
-  @param TableKey   Returns a key to refer to the ACPI table.\r
+  @param TableKey             Returns a key to refer to the ACPI table.\r
   \r
-  @retval EFI_SUCCESS The table was successfully inserted\r
+  @retval EFI_SUCCESS           The table was successfully inserted\r
   \r
   @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL,\r
                                 TableKey is NULL, or\r
@@ -61,13 +66,16 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;
   \r
   @retval EFI_OUT_OF_RESOURCES  Insufficient resources exist to\r
                                 complete the request.\r
-  \r
+  @retval EFI_ACCESS_DENIED     The table signature matches a table already\r
+                                present in the system and platform policy\r
+                                does not allow duplicate tables of this type.\r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_ACPI_TABLE_INSTALL_ACPI_TABLE) (\r
-  IN   CONST EFI_ACPI_TABLE_PROTOCOL *This,\r
-  IN   CONST VOID                    *AcpiTableBuffer,\r
+(EFIAPI *EFI_ACPI_TABLE_INSTALL_ACPI_TABLE)(\r
+  IN   EFI_ACPI_TABLE_PROTOCOL       *This,\r
+  IN   VOID                          *AcpiTableBuffer,\r
   IN   UINTN                         AcpiTableBufferSize,\r
   OUT  UINTN                         *TableKey\r
 );\r
@@ -83,15 +91,15 @@ EFI_STATUS
   EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer\r
   considered valid.\r
 \r
-  @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
+  @param This                   A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
 \r
-  @param TableKey Specifies the table to uninstall. The key was\r
-                  returned from InstallAcpiTable().\r
+  @param TableKey               Specifies the table to uninstall. The key was\r
+                                returned from InstallAcpiTable().\r
 \r
-  @retval EFI_SUCCESS The table was successfully inserted\r
+  @retval EFI_SUCCESS           The table was successfully inserted\r
 \r
-  @retval EFI_NOT_FOUND TableKey does not refer to a valid key\r
-                        for a table entry.\r
+  @retval EFI_NOT_FOUND         TableKey does not refer to a valid key\r
+                                for a table entry.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Insufficient resources exist to\r
                                 complete the request.\r
@@ -99,23 +107,15 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE) (\r
-  IN CONST EFI_ACPI_TABLE_PROTOCOL *This,\r
-  IN UINTN                         TableKey\r
+(EFIAPI *EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE)(\r
+  IN  EFI_ACPI_TABLE_PROTOCOL       *This,\r
+  IN  UINTN                         TableKey\r
 );\r
 \r
-/**\r
-  The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component\r
-  to install and uninstall ACPI tables from a platform.\r
-\r
-\r
-  @param InstallAcpiTable Installs an ACPI table into the\r
-                          system.\r
-\r
-  @param UninstallAcpiTable Removes a previously installed ACPI\r
-                            table from the system.\r
-\r
-**/   \r
+///\r
+/// The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component\r
+/// to install and uninstall ACPI tables from a platform.\r
+///\r
 struct _EFI_ACPI_TABLE_PROTOCOL {\r
   EFI_ACPI_TABLE_INSTALL_ACPI_TABLE   InstallAcpiTable;\r
   EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE UninstallAcpiTable;\r