]>
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 | |
22a69a5e | 12 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
79964ac8 | 13 | \r |
534b8251 | 14 | @par Revision Reference:\r |
689aa0d6 | 15 | This Protocol is defined in Framework ACPI Specification.\r |
534b8251 | 16 | Version 0.9.\r |
17 | \r | |
79964ac8 | 18 | **/\r |
19 | \r | |
20 | #ifndef _ACPI_SUPPORT_PROTOCOL_H_\r | |
21 | #define _ACPI_SUPPORT_PROTOCOL_H_\r | |
22 | \r | |
bde67768 LG |
23 | #include <Protocol/AcpiSystemDescriptionTable.h>\r |
24 | \r | |
79964ac8 | 25 | typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;\r |
26 | \r | |
27 | //\r | |
28 | // ACPI Support Protocol GUID\r | |
29 | //\r | |
30 | #define EFI_ACPI_SUPPORT_GUID \\r | |
31 | { \\r | |
32 | 0xdbff9d55, 0x89b7, 0x46da, {0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d } \\r | |
33 | }\r | |
34 | \r | |
79964ac8 | 35 | \r |
36 | //\r | |
37 | // Protocol Member Functions\r | |
38 | //\r | |
39 | \r | |
40 | /**\r | |
41 | Returns a requested ACPI table.\r | |
42 | \r | |
43 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r | |
44 | @param Index The zero-based index of the table to retrieve.\r | |
f22f941e | 45 | @param Table The pointer for returning the table buffer.\r |
79964ac8 | 46 | @param Version Updated with the ACPI versions to which this table belongs.\r |
f22f941e | 47 | @param Handle The pointer for identifying the table.\r |
79964ac8 | 48 | \r |
49 | @retval EFI_SUCCESS The function completed successfully.\r | |
50 | @retval EFI_NOT_FOUND The requested index is too large and a table was not found.\r | |
51 | \r | |
52 | **/\r | |
53 | typedef\r | |
54 | EFI_STATUS\r | |
69686d56 | 55 | (EFIAPI *EFI_ACPI_GET_ACPI_TABLE)(\r |
79964ac8 | 56 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
57 | IN INTN Index,\r | |
58 | OUT VOID **Table,\r | |
59 | OUT EFI_ACPI_TABLE_VERSION *Version,\r | |
60 | OUT UINTN *Handle\r | |
61 | );\r | |
62 | \r | |
63 | /**\r | |
64 | Used to add, remove, or update ACPI tables.\r | |
65 | \r | |
66 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r | |
f22f941e | 67 | @param Table The pointer to the new table to add or update.\r |
79964ac8 | 68 | @param Checksum If TRUE, indicates that the checksum should be\r |
69 | calculated for this table.\r | |
70 | @param Version Indicates to which version(s) of ACPI the table should be added.\r | |
f22f941e | 71 | @param Handle The pointer to the handle of the table to remove or update.\r |
79964ac8 | 72 | \r |
73 | @retval EFI_SUCCESS The function completed successfully.\r | |
74 | @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r | |
75 | @retval EFI_ABORTED Could not complete the desired action.\r | |
76 | \r | |
77 | **/\r | |
78 | typedef\r | |
79 | EFI_STATUS\r | |
69686d56 | 80 | (EFIAPI *EFI_ACPI_SET_ACPI_TABLE)(\r |
79964ac8 | 81 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
82 | IN VOID *Table OPTIONAL,\r | |
83 | IN BOOLEAN Checksum,\r | |
84 | IN EFI_ACPI_TABLE_VERSION Version,\r | |
85 | IN OUT UINTN *Handle\r | |
86 | );\r | |
87 | \r | |
88 | /**\r | |
89 | Causes one or more versions of the ACPI tables to be published in\r | |
90 | the EFI system configuration tables.\r | |
91 | \r | |
1c2f052d LG |
92 | The PublishTables() function installs the ACPI tables for the versions that are specified in\r |
93 | Version. No tables are published for Version equal to EFI_ACPI_VERSION_NONE. Once\r | |
94 | published, tables will continue to be updated as tables are modified with\r | |
95 | EFI_ACPI_SUPPORT_PROTOCOL.SetAcpiTable().\r | |
534b8251 | 96 | \r |
79964ac8 | 97 | @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r |
5259c97d | 98 | @param Version Indicates to which version(s) of ACPI the table should be published.\r |
79964ac8 | 99 | \r |
100 | @retval EFI_SUCCESS The function completed successfully.\r | |
101 | @retval EFI_ABORTED An error occurred and the function could not complete successfully.\r | |
102 | \r | |
103 | **/\r | |
104 | typedef\r | |
105 | EFI_STATUS\r | |
69686d56 | 106 | (EFIAPI *EFI_ACPI_PUBLISH_TABLES)(\r |
79964ac8 | 107 | IN EFI_ACPI_SUPPORT_PROTOCOL *This,\r |
108 | IN EFI_ACPI_TABLE_VERSION Version\r | |
109 | );\r | |
110 | \r | |
111 | //\r | |
112 | // ACPI Support Protocol\r | |
113 | //\r | |
114 | /**\r | |
79964ac8 | 115 | This protocol provides some basic services to support publishing ACPI system\r |
116 | tables. The services handle many of the more mundane tasks that are required\r | |
117 | to publish a set of tables.\r | |
79964ac8 | 118 | **/\r |
119 | struct _EFI_ACPI_SUPPORT_PROTOCOL {\r | |
2bbaeb0d | 120 | ///\r |
121 | /// Returns a table specified by an index if it exists.\r | |
122 | ///\r | |
79964ac8 | 123 | EFI_ACPI_GET_ACPI_TABLE GetAcpiTable;\r |
2bbaeb0d | 124 | \r |
125 | ///\r | |
f22f941e | 126 | /// Adds, removes, or updates ACPI tables.\r |
2bbaeb0d | 127 | ///\r |
79964ac8 | 128 | EFI_ACPI_SET_ACPI_TABLE SetAcpiTable;\r |
2bbaeb0d | 129 | \r |
130 | ///\r | |
131 | /// Publishes the ACPI tables.\r | |
132 | ///\r | |
79964ac8 | 133 | EFI_ACPI_PUBLISH_TABLES PublishTables;\r |
134 | };\r | |
135 | \r | |
136 | //\r | |
137 | // Extern the GUID for protocol users.\r | |
138 | //\r | |
139 | extern EFI_GUID gEfiAcpiSupportProtocolGuid;\r | |
140 | \r | |
141 | #endif\r | |
142 | \r |