d1f95000 |
1 | /** @file\r |
2 | The file provides the protocol to install or remove an ACPI\r |
3 | table from a platform. \r |
4 | \r |
5 | Copyright (c) 2006 - 2007, Intel Corporation\r |
6 | All rights reserved. This program and the accompanying materials \r |
7 | are licensed and made available under the terms and conditions of the BSD License \r |
8 | which accompanies this distribution. The full text of the license may be found at \r |
9 | http://opensource.org/licenses/bsd-license.php \r |
10 | \r |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
13 | \r |
d1f95000 |
14 | **/\r |
15 | \r |
16 | #ifndef __ACPI_TABLE_H___\r |
17 | #define __ACPI_TABLE_H___\r |
18 | \r |
19 | #define EFI_ACPI_TABLE_PROTOCOL_GUID \\r |
20 | { 0xffe06bdd, 0x6107, 0x46a6, { 0x7b, 0xb2, 0x5a, 0x9c, 0x7e, 0xc5, 0x27, 0x5c }}\r |
21 | \r |
22 | \r |
23 | typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;\r |
24 | \r |
25 | /**\r |
26 | \r |
27 | The InstallAcpiTable() function allows a caller to install an \r |
28 | ACPI table. When successful, the table will be linked by the \r |
29 | RSDT/XSDT. AcpiTableBuffer specifies the table to be installed. \r |
30 | InstallAcpiTable() will make a copy of the table and insert the \r |
31 | copy into the RSDT/XSDT. InstallAcpiTable() must insert the new \r |
32 | table at the end of the RSDT/XSDT. To prevent namespace \r |
33 | collision, ACPI tables may be created using UEFI ACPI table \r |
34 | format. See Appendix O. On successful output, TableKey is \r |
35 | initialized with a unique key. Its value may be used in a \r |
36 | subsequent call to UninstallAcpiTable to remove an ACPI table. \r |
37 | If an EFI application is running at the time of this call, the \r |
38 | relevant EFI_CONFIGURATION_TABLE pointer to the RSDT is no \r |
39 | longer considered valid. \r |
40 | \r |
41 | \r |
42 | @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r |
43 | \r |
44 | @param AcpiTableBuffer A pointer to a buffer containing the\r |
45 | ACPI table to be installed.\r |
46 | \r |
47 | @param AcpiTableBufferSize Specifies the size, in bytes, of\r |
48 | the AcpiTableBuffer buffer.\r |
49 | \r |
50 | \r |
51 | @param TableKey Returns a key to refer to the ACPI table.\r |
52 | \r |
53 | @retval EFI_SUCCESS The table was successfully inserted\r |
54 | \r |
55 | @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL,\r |
56 | TableKey is NULL, or\r |
57 | AcpiTableBufferSize and the size\r |
58 | field embedded in the ACPI table\r |
59 | pointed to by AcpiTableBuffer\r |
60 | are not in sync.\r |
61 | \r |
62 | @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to\r |
63 | complete the request.\r |
64 | \r |
65 | **/\r |
66 | typedef\r |
67 | EFI_STATUS\r |
68 | (EFIAPI *EFI_ACPI_TABLE_INSTALL_ACPI_TABLE) (\r |
69 | IN CONST EFI_ACPI_TABLE_PROTOCOL *This,\r |
70 | IN CONST VOID *AcpiTableBuffer,\r |
71 | IN CONST UINTN AcpiTableBufferSize,\r |
72 | OUT UINTN *TableKey\r |
73 | );\r |
74 | \r |
75 | \r |
76 | /**\r |
77 | \r |
78 | The UninstallAcpiTable() function allows a caller to remove an\r |
79 | ACPI table. The routine will remove its reference from the\r |
80 | RSDT/XSDT. A table is referenced by the TableKey parameter\r |
81 | returned from a prior call to InstallAcpiTable(). If an EFI\r |
82 | application is running at the time of this call, the relevant\r |
83 | EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer\r |
84 | considered valid.\r |
85 | \r |
86 | @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r |
87 | \r |
88 | @param TableKey Specifies the table to uninstall. The key was\r |
89 | returned from InstallAcpiTable().\r |
90 | \r |
91 | @retval EFI_SUCCESS The table was successfully inserted\r |
92 | \r |
93 | @retval EFI_NOT_FOUND TableKey does not refer to a valid key\r |
94 | for a table entry.\r |
95 | \r |
96 | @retval EFI_OUT_OF_RESOURCES Insufficient resources exist to\r |
97 | complete the request.\r |
98 | \r |
99 | **/\r |
100 | typedef\r |
101 | EFI_STATUS\r |
102 | (EFIAPI *EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE) (\r |
103 | IN CONST EFI_ACPI_TABLE_PROTOCOL *This,\r |
104 | IN CONST UINTN TableKey\r |
105 | );\r |
106 | \r |
107 | /**\r |
108 | The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component\r |
109 | to install and uninstall ACPI tables from a platform.\r |
110 | \r |
111 | \r |
112 | @param InstallAcpiTable Installs an ACPI table into the\r |
113 | system.\r |
114 | \r |
115 | @param UninstallAcpiTable Removes a previously installed ACPI\r |
116 | table from the system.\r |
117 | \r |
118 | **/ \r |
119 | struct _EFI_ACPI_TABLE_PROTOCOL {\r |
120 | EFI_ACPI_TABLE_INSTALL_ACPI_TABLE InstallAcpiTable;\r |
121 | EFI_ACPI_TABLE_UNINSTALL_ACPI_TABLE UninstallAcpiTable;\r |
122 | };\r |
123 | \r |
124 | extern EFI_GUID gEfiAcpiTableProtocolGuid;\r |
125 | \r |
126 | #endif\r |
127 | \r |