--- /dev/null
+/** @file\r
+ Definition of the ACPI Support protocol.\r
+\r
+ Copyright (c) 2006, 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
+ which accompanies this distribution. The full text of the license may be found at \r
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ 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
+ \r
+**/\r
+\r
+#ifndef _ACPI_SUPPORT_PROTOCOL_H_\r
+#define _ACPI_SUPPORT_PROTOCOL_H_\r
+\r
+typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;\r
+\r
+//\r
+// ACPI Support Protocol GUID\r
+//\r
+#define EFI_ACPI_SUPPORT_GUID \\r
+ { \\r
+ 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
+//\r
+\r
+/**\r
+ Returns a requested ACPI table.\r
+\r
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+ @param Index The zero-based index of the table to retrieve.\r
+ @param Table Pointer for returning the table buffer.\r
+ @param Version Updated with the ACPI versions to which this table belongs.\r
+ @param Handle Pointer for identifying 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
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_ACPI_GET_ACPI_TABLE) (\r
+ IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
+ IN INTN Index,\r
+ OUT VOID **Table,\r
+ OUT EFI_ACPI_TABLE_VERSION *Version,\r
+ OUT UINTN *Handle\r
+ );\r
+\r
+/**\r
+ Used to add, remove, or update ACPI tables.\r
+\r
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+ @param Table Pointer to the new table to add or update.\r
+ @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
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r
+ @retval EFI_ABORTED Could not complete the desired action.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_ACPI_SET_ACPI_TABLE) (\r
+ IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
+ IN VOID *Table OPTIONAL,\r
+ IN BOOLEAN Checksum,\r
+ IN EFI_ACPI_TABLE_VERSION Version,\r
+ IN OUT UINTN *Handle\r
+ );\r
+\r
+/**\r
+ Causes one or more versions of the ACPI tables to be published in \r
+ the EFI system configuration tables.\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
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_ABORTED An error occurred and the function could not complete successfully.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_ACPI_PUBLISH_TABLES) (\r
+ IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r
+ IN EFI_ACPI_TABLE_VERSION Version\r
+ );\r
+\r
+//\r
+// 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
+ EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r
+ EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r
+ EFI_ACPI_PUBLISH_TABLES PublishTables;\r
+};\r
+\r
+//\r
+// Extern the GUID for protocol users.\r
+//\r
+extern EFI_GUID gEfiAcpiSupportProtocolGuid;\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff