]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
4a71b21a | 2 | This protocol provides some basic services to support publishing ACPI system tables. The\r |
3 | services handle many of the more mundane tasks that are required to publish a set of tables. The\r | |
5259c97d | 4 | services will:\r |
f22f941e | 5 | - Generate common tables.\r |
1c2f052d LG |
6 | - Update the table links.\r |
7 | - Ensure that tables are properly aligned and use correct types of memory.\r | |
8 | - Update checksum values and IDs.\r | |
9 | - Complete the final installation of the tables.\r | |
10 | \r | |
11 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
12 | This program and the accompanying materials are licensed and made available under\r | |
13 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
f22f941e | 14 | The full text of the license may be found at\r |
1c2f052d LG |
15 | http://opensource.org/licenses/bsd-license.php.\r |
16 | \r | |
17 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
f22f941e | 18 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
79964ac8 | 19 | \r |
534b8251 | 20 | @par Revision Reference:\r |
689aa0d6 | 21 | This Protocol is defined in Framework ACPI Specification.\r |
534b8251 | 22 | Version 0.9.\r |
23 | \r | |
79964ac8 | 24 | **/\r |
25 | \r | |
26 | #ifndef _ACPI_SUPPORT_PROTOCOL_H_\r | |
27 | #define _ACPI_SUPPORT_PROTOCOL_H_\r | |
28 | \r | |
bde67768 LG |
29 | #include <Protocol/AcpiSystemDescriptionTable.h>\r |
30 | \r | |
79964ac8 | 31 | typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;\r |
32 | \r | |
33 | //\r | |
34 | // ACPI Support Protocol GUID\r | |
35 | //\r | |
36 | #define EFI_ACPI_SUPPORT_GUID \\r | |
37 | { \\r | |
38 | 0xdbff9d55, 0x89b7, 0x46da, {0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d } \\r | |
39 | }\r | |
40 | \r | |
79964ac8 | 41 | \r |
42 | //\r | |
43 | // Protocol Member Functions\r | |
44 | //\r | |
45 | \r | |
46 | /**\r | |
47 | Returns a requested ACPI table.\r | |
48 | \r | |
49 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r | |
50 | @param Index The zero-based index of the table to retrieve.\r | |
f22f941e | 51 | @param Table The pointer for returning the table buffer.\r |
79964ac8 | 52 | @param Version Updated with the ACPI versions to which this table belongs.\r |
f22f941e | 53 | @param Handle The pointer for identifying the table.\r |
79964ac8 | 54 | \r |
55 | @retval EFI_SUCCESS The function completed successfully.\r | |
56 | @retval EFI_NOT_FOUND The requested index is too large and a table was not found.\r | |
57 | \r | |
58 | **/\r | |
59 | typedef\r | |
60 | EFI_STATUS\r | |
69686d56 | 61 | (EFIAPI *EFI_ACPI_GET_ACPI_TABLE)(\r |
79964ac8 | 62 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
63 | IN INTN Index,\r | |
64 | OUT VOID **Table,\r | |
65 | OUT EFI_ACPI_TABLE_VERSION *Version,\r | |
66 | OUT UINTN *Handle\r | |
67 | );\r | |
68 | \r | |
69 | /**\r | |
70 | Used to add, remove, or update ACPI tables.\r | |
71 | \r | |
72 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r | |
f22f941e | 73 | @param Table The pointer to the new table to add or update.\r |
79964ac8 | 74 | @param Checksum If TRUE, indicates that the checksum should be\r |
75 | calculated for this table.\r | |
76 | @param Version Indicates to which version(s) of ACPI the table should be added.\r | |
f22f941e | 77 | @param Handle The pointer to the handle of the table to remove or update.\r |
79964ac8 | 78 | \r |
79 | @retval EFI_SUCCESS The function completed successfully.\r | |
80 | @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r | |
81 | @retval EFI_ABORTED Could not complete the desired action.\r | |
82 | \r | |
83 | **/\r | |
84 | typedef\r | |
85 | EFI_STATUS\r | |
69686d56 | 86 | (EFIAPI *EFI_ACPI_SET_ACPI_TABLE)(\r |
79964ac8 | 87 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
88 | IN VOID *Table OPTIONAL,\r | |
89 | IN BOOLEAN Checksum,\r | |
90 | IN EFI_ACPI_TABLE_VERSION Version,\r | |
91 | IN OUT UINTN *Handle\r | |
92 | );\r | |
93 | \r | |
94 | /**\r | |
95 | Causes one or more versions of the ACPI tables to be published in\r | |
96 | the EFI system configuration tables.\r | |
97 | \r | |
1c2f052d LG |
98 | The PublishTables() function installs the ACPI tables for the versions that are specified in\r |
99 | Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once\r | |
100 | published, tables will continue to be updated as tables are modified with\r | |
101 | EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().\r | |
534b8251 | 102 | \r |
79964ac8 | 103 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r |
5259c97d | 104 | @param Version Indicates to which version(s) of ACPI the table should be published.\r |
79964ac8 | 105 | \r |
106 | @retval EFI_SUCCESS The function completed successfully.\r | |
107 | @retval EFI_ABORTED An error occurred and the function could not complete successfully.\r | |
108 | \r | |
109 | **/\r | |
110 | typedef\r | |
111 | EFI_STATUS\r | |
69686d56 | 112 | (EFIAPI *EFI_ACPI_PUBLISH_TABLES)(\r |
79964ac8 | 113 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
114 | IN EFI_ACPI_TABLE_VERSION Version\r | |
115 | );\r | |
116 | \r | |
117 | //\r | |
118 | // ACPI Support Protocol\r | |
119 | //\r | |
120 | /**\r | |
79964ac8 | 121 | This protocol provides some basic services to support publishing ACPI system\r |
122 | tables. The services handle many of the more mundane tasks that are required\r | |
123 | to publish a set of tables.\r | |
79964ac8 | 124 | **/\r |
125 | struct _EFI_ACPI_SUPPORT_PROTOCOL {\r | |
2bbaeb0d | 126 | ///\r |
127 | /// Returns a table specified by an index if it exists.\r | |
128 | ///\r | |
79964ac8 | 129 | EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r |
2bbaeb0d | 130 | \r |
131 | ///\r | |
f22f941e | 132 | /// Adds, removes, or updates ACPI tables.\r |
2bbaeb0d | 133 | ///\r |
79964ac8 | 134 | EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r |
2bbaeb0d | 135 | \r |
136 | ///\r | |
137 | /// Publishes the ACPI tables.\r | |
138 | ///\r | |
79964ac8 | 139 | EFI_ACPI_PUBLISH_TABLES PublishTables;\r |
140 | };\r | |
141 | \r | |
142 | //\r | |
143 | // Extern the GUID for protocol users.\r | |
144 | //\r | |
145 | extern EFI_GUID gEfiAcpiSupportProtocolGuid;\r | |
146 | \r | |
147 | #endif\r | |
148 | \r |