2 The file provides the protocol to install or remove an ACPI
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __ACPI_TABLE_H___
17 #define __ACPI_TABLE_H___
19 #define EFI_ACPI_TABLE_PROTOCOL_GUID \
20 { 0xffe06bdd, 0x6107, 0x46a6, { 0x7b, 0xb2, 0x5a, 0x9c, 0x7e, 0xc5, 0x27, 0x5c }}
23 typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL
;
27 The InstallAcpiTable() function allows a caller to install an
28 ACPI table. When successful, the table will be linked by the
29 RSDT/XSDT. AcpiTableBuffer specifies the table to be installed.
30 InstallAcpiTable() will make a copy of the table and insert the
31 copy into the RSDT/XSDT. InstallAcpiTable() must insert the new
32 table at the end of the RSDT/XSDT. To prevent namespace
33 collision, ACPI tables may be created using UEFI ACPI table
34 format. On successful output, TableKey is
35 initialized with a unique key. Its value may be used in a
36 subsequent call to UninstallAcpiTable to remove an ACPI table.
37 If an EFI application is running at the time of this call, the
38 relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no
39 longer considered valid.
42 @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.
44 @param AcpiTableBuffer A pointer to a buffer containing the
45 ACPI table to be installed.
47 @param AcpiTableBufferSize Specifies the size, in bytes, of
48 the AcpiTableBuffer buffer.
51 @param TableKey Returns a key to refer to the ACPI table.
53 @retval EFI_SUCCESS The table was successfully inserted
55 @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL,
57 AcpiTableBufferSize and the size
58 field embedded in the ACPI table
59 pointed to by AcpiTableBuffer
62 @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to
68 (EFIAPI
*EFI_ACPI_TABLE_INSTALL_ACPI_TABLE
)(
69 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
70 IN CONST VOID
*AcpiTableBuffer
,
71 IN UINTN AcpiTableBufferSize
,
78 The UninstallAcpiTable() function allows a caller to remove an
79 ACPI table. The routine will remove its reference from the
80 RSDT/XSDT. A table is referenced by the TableKey parameter
81 returned from a prior call to InstallAcpiTable(). If an EFI
82 application is running at the time of this call, the relevant
83 EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer
86 @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.
88 @param TableKey Specifies the table to uninstall. The key was
89 returned from InstallAcpiTable().
91 @retval EFI_SUCCESS The table was successfully inserted
93 @retval EFI_NOT_FOUND TableKey does not refer to a valid key
96 @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to
102 (EFIAPI
*EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE
)(
103 IN CONST EFI_ACPI_TABLE_PROTOCOL
*This
,
108 /// The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component
109 /// to install and uninstall ACPI tables from a platform.
111 struct _EFI_ACPI_TABLE_PROTOCOL
{
112 EFI_ACPI_TABLE_INSTALL_ACPI_TABLE InstallAcpiTable
;
113 EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE UninstallAcpiTable
;
116 extern EFI_GUID gEfiAcpiTableProtocolGuid
;