]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: tbinstal - ACPI table installation and removal | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, Intel Corp. |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
14 | * 1. Redistributions of source code must retain the above copyright | |
15 | * notice, this list of conditions, and the following disclaimer, | |
16 | * without modification. | |
17 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
18 | * substantially similar to the "NO WARRANTY" disclaimer below | |
19 | * ("Disclaimer") and any redistribution must be conditioned upon | |
20 | * including a substantially similar Disclaimer requirement for further | |
21 | * binary redistribution. | |
22 | * 3. Neither the names of the above-listed copyright holders nor the names | |
23 | * of any contributors may be used to endorse or promote products derived | |
24 | * from this software without specific prior written permission. | |
25 | * | |
26 | * Alternatively, this software may be distributed under the terms of the | |
27 | * GNU General Public License ("GPL") version 2 as published by the Free | |
28 | * Software Foundation. | |
29 | * | |
30 | * NO WARRANTY | |
31 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
32 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
33 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
34 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
35 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
36 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
37 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
38 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
39 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
40 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
41 | * POSSIBILITY OF SUCH DAMAGES. | |
42 | */ | |
43 | ||
1da177e4 | 44 | #include <acpi/acpi.h> |
e2f7a777 | 45 | #include "accommon.h" |
e2f7a777 | 46 | #include "actables.h" |
1da177e4 | 47 | |
1da177e4 | 48 | #define _COMPONENT ACPI_TABLES |
4be44fcd | 49 | ACPI_MODULE_NAME("tbinstal") |
1da177e4 | 50 | |
86dfc6f3 | 51 | /* Local prototypes */ |
86dfc6f3 | 52 | static u8 |
c418ce19 | 53 | acpi_tb_compare_tables(struct acpi_table_desc *table_desc, u32 table_index); |
1da177e4 | 54 | |
7f9fc99c LZ |
55 | /******************************************************************************* |
56 | * | |
c418ce19 | 57 | * FUNCTION: acpi_tb_compare_tables |
7f9fc99c | 58 | * |
c418ce19 BM |
59 | * PARAMETERS: table_desc - Table 1 descriptor to be compared |
60 | * table_index - Index of table 2 to be compared | |
7f9fc99c | 61 | * |
c418ce19 | 62 | * RETURN: TRUE if both tables are identical. |
7f9fc99c | 63 | * |
c418ce19 BM |
64 | * DESCRIPTION: This function compares a table with another table that has |
65 | * already been installed in the root table list. | |
7f9fc99c LZ |
66 | * |
67 | ******************************************************************************/ | |
68 | ||
c418ce19 BM |
69 | static u8 |
70 | acpi_tb_compare_tables(struct acpi_table_desc *table_desc, u32 table_index) | |
1da177e4 | 71 | { |
f3d2e786 | 72 | acpi_status status = AE_OK; |
c418ce19 BM |
73 | u8 is_identical; |
74 | struct acpi_table_header *table; | |
75 | u32 table_length; | |
76 | u8 table_flags; | |
1da177e4 | 77 | |
86dfc6f3 | 78 | status = |
c418ce19 BM |
79 | acpi_tb_acquire_table(&acpi_gbl_root_table_list.tables[table_index], |
80 | &table, &table_length, &table_flags); | |
86dfc6f3 | 81 | if (ACPI_FAILURE(status)) { |
c418ce19 | 82 | return (FALSE); |
86dfc6f3 | 83 | } |
f3d2e786 | 84 | |
86dfc6f3 | 85 | /* |
c418ce19 BM |
86 | * Check for a table match on the entire table length, |
87 | * not just the header. | |
86dfc6f3 | 88 | */ |
c418ce19 | 89 | is_identical = (u8)((table_desc->length != table_length || |
4fa4616e BM |
90 | memcmp(table_desc->pointer, table, table_length)) ? |
91 | FALSE : TRUE); | |
e56f5617 | 92 | |
c418ce19 | 93 | /* Release the acquired table */ |
ed6f1d44 | 94 | |
c418ce19 BM |
95 | acpi_tb_release_table(table, table_length, table_flags); |
96 | return (is_identical); | |
86dfc6f3 | 97 | } |
e56f5617 | 98 | |
86dfc6f3 LZ |
99 | /******************************************************************************* |
100 | * | |
ed6f1d44 | 101 | * FUNCTION: acpi_tb_install_table_with_override |
86dfc6f3 | 102 | * |
8ec3f459 | 103 | * PARAMETERS: new_table_desc - New table descriptor to install |
caf4a15c | 104 | * override - Whether override should be performed |
8ec3f459 | 105 | * table_index - Where the table index is returned |
86dfc6f3 LZ |
106 | * |
107 | * RETURN: None | |
108 | * | |
109 | * DESCRIPTION: Install an ACPI table into the global data structure. The | |
110 | * table override mechanism is called to allow the host | |
111 | * OS to replace any table before it is installed in the root | |
112 | * table array. | |
113 | * | |
114 | ******************************************************************************/ | |
115 | ||
116 | void | |
8ec3f459 LZ |
117 | acpi_tb_install_table_with_override(struct acpi_table_desc *new_table_desc, |
118 | u8 override, u32 *table_index) | |
86dfc6f3 | 119 | { |
8ec3f459 LZ |
120 | u32 i; |
121 | acpi_status status; | |
ed6f1d44 | 122 | |
8ec3f459 LZ |
123 | status = acpi_tb_get_next_table_descriptor(&i, NULL); |
124 | if (ACPI_FAILURE(status)) { | |
86dfc6f3 | 125 | return; |
1da177e4 LT |
126 | } |
127 | ||
d3ccaff8 BM |
128 | /* |
129 | * ACPI Table Override: | |
86dfc6f3 LZ |
130 | * |
131 | * Before we install the table, let the host OS override it with a new | |
132 | * one if desired. Any table within the RSDT/XSDT can be replaced, | |
133 | * including the DSDT which is pointed to by the FADT. | |
d3ccaff8 | 134 | */ |
caf4a15c LZ |
135 | if (override) { |
136 | acpi_tb_override_table(new_table_desc); | |
137 | } | |
7f9fc99c | 138 | |
8ec3f459 | 139 | acpi_tb_init_table_descriptor(&acpi_gbl_root_table_list.tables[i], |
ed6f1d44 BM |
140 | new_table_desc->address, |
141 | new_table_desc->flags, | |
142 | new_table_desc->pointer); | |
7f9fc99c | 143 | |
86dfc6f3 LZ |
144 | acpi_tb_print_table_header(new_table_desc->address, |
145 | new_table_desc->pointer); | |
146 | ||
8ec3f459 LZ |
147 | /* This synchronizes acpi_gbl_dsdt_index */ |
148 | ||
149 | *table_index = i; | |
150 | ||
86dfc6f3 LZ |
151 | /* Set the global integer width (based upon revision of the DSDT) */ |
152 | ||
8ec3f459 | 153 | if (i == acpi_gbl_dsdt_index) { |
86dfc6f3 LZ |
154 | acpi_ut_set_integer_width(new_table_desc->pointer->revision); |
155 | } | |
156 | } | |
157 | ||
86dfc6f3 LZ |
158 | /******************************************************************************* |
159 | * | |
ed6f1d44 | 160 | * FUNCTION: acpi_tb_install_standard_table |
86dfc6f3 | 161 | * |
8a216d7f | 162 | * PARAMETERS: address - Address of the table (might be a virtual |
86dfc6f3 LZ |
163 | * address depending on the table_flags) |
164 | * flags - Flags for the table | |
165 | * reload - Whether reload should be performed | |
caf4a15c | 166 | * override - Whether override should be performed |
86dfc6f3 LZ |
167 | * table_index - Where the table index is returned |
168 | * | |
169 | * RETURN: Status | |
170 | * | |
752db101 | 171 | * DESCRIPTION: This function is called to verify and install an ACPI table. |
86dfc6f3 LZ |
172 | * When this function is called by "Load" or "LoadTable" opcodes, |
173 | * or by acpi_load_table() API, the "Reload" parameter is set. | |
174 | * After sucessfully returning from this function, table is | |
175 | * "INSTALLED" but not "VALIDATED". | |
176 | * | |
177 | ******************************************************************************/ | |
178 | ||
179 | acpi_status | |
ed6f1d44 BM |
180 | acpi_tb_install_standard_table(acpi_physical_address address, |
181 | u8 flags, | |
182 | u8 reload, u8 override, u32 *table_index) | |
86dfc6f3 LZ |
183 | { |
184 | u32 i; | |
185 | acpi_status status = AE_OK; | |
186 | struct acpi_table_desc new_table_desc; | |
187 | ||
ed6f1d44 | 188 | ACPI_FUNCTION_TRACE(tb_install_standard_table); |
86dfc6f3 | 189 | |
ed6f1d44 | 190 | /* Acquire a temporary table descriptor for validation */ |
86dfc6f3 | 191 | |
ed6f1d44 | 192 | status = acpi_tb_acquire_temp_table(&new_table_desc, address, flags); |
86dfc6f3 | 193 | if (ACPI_FAILURE(status)) { |
cc2080b0 LZ |
194 | ACPI_ERROR((AE_INFO, |
195 | "Could not acquire table length at %8.8X%8.8X", | |
196 | ACPI_FORMAT_UINT64(address))); | |
86dfc6f3 LZ |
197 | return_ACPI_STATUS(status); |
198 | } | |
199 | ||
a94e88cd LZ |
200 | /* |
201 | * Optionally do not load any SSDTs from the RSDT/XSDT. This can | |
202 | * be useful for debugging ACPI problems on some machines. | |
203 | */ | |
ed6f1d44 BM |
204 | if (!reload && |
205 | acpi_gbl_disable_ssdt_table_install && | |
a94e88cd | 206 | ACPI_COMPARE_NAME(&new_table_desc.signature, ACPI_SIG_SSDT)) { |
05fb04b5 | 207 | ACPI_INFO(("Ignoring installation of %4.4s at %8.8X%8.8X", |
6d3fd3cc | 208 | new_table_desc.signature.ascii, |
cc2080b0 | 209 | ACPI_FORMAT_UINT64(address))); |
a94e88cd LZ |
210 | goto release_and_exit; |
211 | } | |
212 | ||
86dfc6f3 LZ |
213 | /* Validate and verify a table before installation */ |
214 | ||
47d68c7f | 215 | status = acpi_tb_verify_temp_table(&new_table_desc, NULL); |
86dfc6f3 LZ |
216 | if (ACPI_FAILURE(status)) { |
217 | goto release_and_exit; | |
218 | } | |
219 | ||
220 | if (reload) { | |
221 | /* | |
222 | * Validate the incoming table signature. | |
223 | * | |
224 | * 1) Originally, we checked the table signature for "SSDT" or "PSDT". | |
225 | * 2) We added support for OEMx tables, signature "OEM". | |
226 | * 3) Valid tables were encountered with a null signature, so we just | |
227 | * gave up on validating the signature, (05/2008). | |
228 | * 4) We encountered non-AML tables such as the MADT, which caused | |
229 | * interpreter errors and kernel faults. So now, we once again allow | |
230 | * only "SSDT", "OEMx", and now, also a null signature. (05/2011). | |
231 | */ | |
232 | if ((new_table_desc.signature.ascii[0] != 0x00) && | |
233 | (!ACPI_COMPARE_NAME | |
234 | (&new_table_desc.signature, ACPI_SIG_SSDT)) | |
4fa4616e | 235 | && (strncmp(new_table_desc.signature.ascii, "OEM", 3))) { |
86dfc6f3 LZ |
236 | ACPI_BIOS_ERROR((AE_INFO, |
237 | "Table has invalid signature [%4.4s] (0x%8.8X), " | |
238 | "must be SSDT or OEMx", | |
6a0df32c BM |
239 | acpi_ut_valid_nameseg(new_table_desc. |
240 | signature. | |
241 | ascii) ? | |
86dfc6f3 LZ |
242 | new_table_desc.signature. |
243 | ascii : "????", | |
244 | new_table_desc.signature.integer)); | |
245 | ||
246 | status = AE_BAD_SIGNATURE; | |
247 | goto release_and_exit; | |
248 | } | |
249 | ||
250 | /* Check if table is already registered */ | |
251 | ||
252 | for (i = 0; i < acpi_gbl_root_table_list.current_table_count; | |
253 | ++i) { | |
254 | /* | |
255 | * Check for a table match on the entire table length, | |
256 | * not just the header. | |
257 | */ | |
c418ce19 | 258 | if (!acpi_tb_compare_tables(&new_table_desc, i)) { |
86dfc6f3 LZ |
259 | continue; |
260 | } | |
261 | ||
262 | /* | |
263 | * Note: the current mechanism does not unregister a table if it is | |
264 | * dynamically unloaded. The related namespace entries are deleted, | |
265 | * but the table remains in the root table list. | |
266 | * | |
267 | * The assumption here is that the number of different tables that | |
268 | * will be loaded is actually small, and there is minimal overhead | |
269 | * in just keeping the table in case it is needed again. | |
270 | * | |
271 | * If this assumption changes in the future (perhaps on large | |
272 | * machines with many table load/unload operations), tables will | |
273 | * need to be unregistered when they are unloaded, and slots in the | |
274 | * root table list should be reused when empty. | |
275 | */ | |
1fad8738 BM |
276 | if (acpi_gbl_root_table_list.tables[i].flags & |
277 | ACPI_TABLE_IS_LOADED) { | |
86dfc6f3 LZ |
278 | |
279 | /* Table is still loaded, this is an error */ | |
280 | ||
281 | status = AE_ALREADY_EXISTS; | |
282 | goto release_and_exit; | |
283 | } else { | |
284 | /* | |
285 | * Table was unloaded, allow it to be reloaded. | |
286 | * As we are going to return AE_OK to the caller, we should | |
287 | * take the responsibility of freeing the input descriptor. | |
288 | * Refill the input descriptor to ensure | |
ed6f1d44 | 289 | * acpi_tb_install_table_with_override() can be called again to |
86dfc6f3 LZ |
290 | * indicate the re-installation. |
291 | */ | |
292 | acpi_tb_uninstall_table(&new_table_desc); | |
293 | *table_index = i; | |
86dfc6f3 LZ |
294 | return_ACPI_STATUS(AE_OK); |
295 | } | |
296 | } | |
7f9fc99c | 297 | } |
d3ccaff8 | 298 | |
e56f5617 BM |
299 | /* Add the table to the global root table list */ |
300 | ||
8ec3f459 LZ |
301 | acpi_tb_install_table_with_override(&new_table_desc, override, |
302 | table_index); | |
86dfc6f3 | 303 | |
bdbe5df0 LZ |
304 | /* Invoke table handler if present */ |
305 | ||
306 | if (acpi_gbl_table_handler) { | |
307 | (void)acpi_gbl_table_handler(ACPI_TABLE_EVENT_INSTALL, | |
308 | new_table_desc.pointer, | |
309 | acpi_gbl_table_handler_context); | |
310 | } | |
311 | ||
86dfc6f3 | 312 | release_and_exit: |
0c9938cc | 313 | |
ed6f1d44 | 314 | /* Release the temporary table descriptor */ |
1da177e4 | 315 | |
ed6f1d44 | 316 | acpi_tb_release_temp_table(&new_table_desc); |
4be44fcd | 317 | return_ACPI_STATUS(status); |
1da177e4 LT |
318 | } |
319 | ||
f7b004a1 BM |
320 | /******************************************************************************* |
321 | * | |
7f9fc99c | 322 | * FUNCTION: acpi_tb_override_table |
f7b004a1 | 323 | * |
86dfc6f3 LZ |
324 | * PARAMETERS: old_table_desc - Validated table descriptor to be |
325 | * overridden | |
f7b004a1 | 326 | * |
86dfc6f3 | 327 | * RETURN: None |
f7b004a1 BM |
328 | * |
329 | * DESCRIPTION: Attempt table override by calling the OSL override functions. | |
330 | * Note: If the table is overridden, then the entire new table | |
7f9fc99c | 331 | * is acquired and returned by this function. |
86dfc6f3 LZ |
332 | * Before/after invocation, the table descriptor is in a state |
333 | * that is "VALIDATED". | |
f7b004a1 BM |
334 | * |
335 | ******************************************************************************/ | |
336 | ||
86dfc6f3 | 337 | void acpi_tb_override_table(struct acpi_table_desc *old_table_desc) |
f7b004a1 BM |
338 | { |
339 | acpi_status status; | |
f7b004a1 | 340 | char *override_type; |
7f9fc99c | 341 | struct acpi_table_desc new_table_desc; |
86dfc6f3 LZ |
342 | struct acpi_table_header *table; |
343 | acpi_physical_address address; | |
344 | u32 length; | |
f7b004a1 BM |
345 | |
346 | /* (1) Attempt logical override (returns a logical address) */ | |
347 | ||
86dfc6f3 LZ |
348 | status = acpi_os_table_override(old_table_desc->pointer, &table); |
349 | if (ACPI_SUCCESS(status) && table) { | |
ed6f1d44 BM |
350 | acpi_tb_acquire_temp_table(&new_table_desc, |
351 | ACPI_PTR_TO_PHYSADDR(table), | |
352 | ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL); | |
f7b004a1 BM |
353 | override_type = "Logical"; |
354 | goto finish_override; | |
355 | } | |
356 | ||
357 | /* (2) Attempt physical override (returns a physical address) */ | |
358 | ||
86dfc6f3 LZ |
359 | status = acpi_os_physical_table_override(old_table_desc->pointer, |
360 | &address, &length); | |
361 | if (ACPI_SUCCESS(status) && address && length) { | |
ed6f1d44 BM |
362 | acpi_tb_acquire_temp_table(&new_table_desc, address, |
363 | ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL); | |
f7b004a1 | 364 | override_type = "Physical"; |
f7b004a1 BM |
365 | goto finish_override; |
366 | } | |
367 | ||
86dfc6f3 | 368 | return; /* There was no override */ |
f7b004a1 | 369 | |
10622bf8 | 370 | finish_override: |
f7b004a1 | 371 | |
86dfc6f3 LZ |
372 | /* Validate and verify a table before overriding */ |
373 | ||
47d68c7f | 374 | status = acpi_tb_verify_temp_table(&new_table_desc, NULL); |
7f9fc99c | 375 | if (ACPI_FAILURE(status)) { |
86dfc6f3 | 376 | return; |
7f9fc99c LZ |
377 | } |
378 | ||
05fb04b5 | 379 | ACPI_INFO(("%4.4s 0x%8.8X%8.8X" |
1d0a0b2f | 380 | " %s table override, new table: 0x%8.8X%8.8X", |
86dfc6f3 | 381 | old_table_desc->signature.ascii, |
1d0a0b2f LZ |
382 | ACPI_FORMAT_UINT64(old_table_desc->address), |
383 | override_type, ACPI_FORMAT_UINT64(new_table_desc.address))); | |
f7b004a1 | 384 | |
86dfc6f3 | 385 | /* We can now uninstall the original table */ |
f7b004a1 | 386 | |
86dfc6f3 | 387 | acpi_tb_uninstall_table(old_table_desc); |
f7b004a1 | 388 | |
86dfc6f3 LZ |
389 | /* |
390 | * Replace the original table descriptor and keep its state as | |
391 | * "VALIDATED". | |
392 | */ | |
ed6f1d44 BM |
393 | acpi_tb_init_table_descriptor(old_table_desc, new_table_desc.address, |
394 | new_table_desc.flags, | |
395 | new_table_desc.pointer); | |
47d68c7f | 396 | acpi_tb_validate_temp_table(old_table_desc); |
f7b004a1 | 397 | |
ed6f1d44 | 398 | /* Release the temporary table descriptor */ |
f7b004a1 | 399 | |
ed6f1d44 | 400 | acpi_tb_release_temp_table(&new_table_desc); |
f7b004a1 BM |
401 | } |
402 | ||
f3d2e786 BM |
403 | /******************************************************************************* |
404 | * | |
7f9fc99c | 405 | * FUNCTION: acpi_tb_uninstall_table |
f3d2e786 | 406 | * |
7f9fc99c | 407 | * PARAMETERS: table_desc - Table descriptor |
f3d2e786 BM |
408 | * |
409 | * RETURN: None | |
410 | * | |
411 | * DESCRIPTION: Delete one internal ACPI table | |
412 | * | |
413 | ******************************************************************************/ | |
1da177e4 | 414 | |
7f9fc99c | 415 | void acpi_tb_uninstall_table(struct acpi_table_desc *table_desc) |
f3d2e786 | 416 | { |
5582982d | 417 | |
7f9fc99c | 418 | ACPI_FUNCTION_TRACE(tb_uninstall_table); |
5582982d | 419 | |
7f9fc99c | 420 | /* Table must be installed */ |
5582982d | 421 | |
7f9fc99c LZ |
422 | if (!table_desc->address) { |
423 | return_VOID; | |
424 | } | |
f7b004a1 | 425 | |
7f9fc99c | 426 | acpi_tb_invalidate_table(table_desc); |
1d1ea1b7 | 427 | |
7f9fc99c | 428 | if ((table_desc->flags & ACPI_TABLE_ORIGIN_MASK) == |
ed6f1d44 | 429 | ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL) { |
6d3fd3cc | 430 | ACPI_FREE(ACPI_PHYSADDR_TO_PTR(table_desc->address)); |
1da177e4 LT |
431 | } |
432 | ||
7f9fc99c | 433 | table_desc->address = ACPI_PTR_TO_PHYSADDR(NULL); |
7f9fc99c | 434 | return_VOID; |
1da177e4 | 435 | } |