Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: tbinstal - ACPI table installation and removal | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
8 | * Copyright (C) 2000 - 2005, R. Byron Moore | |
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 | ||
44 | ||
45 | #include <acpi/acpi.h> | |
46 | #include <acpi/actables.h> | |
47 | ||
48 | ||
49 | #define _COMPONENT ACPI_TABLES | |
50 | ACPI_MODULE_NAME ("tbinstal") | |
51 | ||
44f6c012 RM |
52 | /* Local prototypes */ |
53 | ||
54 | static acpi_status | |
55 | acpi_tb_match_signature ( | |
56 | char *signature, | |
57 | struct acpi_table_desc *table_info, | |
58 | u8 search_type); | |
59 | ||
1da177e4 LT |
60 | |
61 | /******************************************************************************* | |
62 | * | |
63 | * FUNCTION: acpi_tb_match_signature | |
64 | * | |
65 | * PARAMETERS: Signature - Table signature to match | |
66 | * table_info - Return data | |
44f6c012 | 67 | * search_type - Table type to match (primary/secondary) |
1da177e4 LT |
68 | * |
69 | * RETURN: Status | |
70 | * | |
71 | * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned" | |
72 | * tables (DSDT/FADT/SSDT, etc.) Returns the table_type_iD on match. | |
73 | * | |
74 | ******************************************************************************/ | |
75 | ||
44f6c012 | 76 | static acpi_status |
1da177e4 LT |
77 | acpi_tb_match_signature ( |
78 | char *signature, | |
79 | struct acpi_table_desc *table_info, | |
80 | u8 search_type) | |
81 | { | |
82 | acpi_native_uint i; | |
83 | ||
84 | ||
85 | ACPI_FUNCTION_TRACE ("tb_match_signature"); | |
86 | ||
87 | ||
44f6c012 RM |
88 | /* Search for a signature match among the known table types */ |
89 | ||
1da177e4 LT |
90 | for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++) { |
91 | if (!(acpi_gbl_table_data[i].flags & search_type)) { | |
92 | continue; | |
93 | } | |
94 | ||
95 | if (!ACPI_STRNCMP (signature, acpi_gbl_table_data[i].signature, | |
96 | acpi_gbl_table_data[i].sig_length)) { | |
97 | /* Found a signature match, return index if requested */ | |
98 | ||
99 | if (table_info) { | |
100 | table_info->type = (u8) i; | |
101 | } | |
102 | ||
103 | ACPI_DEBUG_PRINT ((ACPI_DB_INFO, | |
104 | "Table [%4.4s] is an ACPI table consumed by the core subsystem\n", | |
105 | (char *) acpi_gbl_table_data[i].signature)); | |
106 | ||
107 | return_ACPI_STATUS (AE_OK); | |
108 | } | |
109 | } | |
110 | ||
111 | ACPI_DEBUG_PRINT ((ACPI_DB_INFO, | |
112 | "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n", | |
113 | (char *) signature)); | |
114 | ||
115 | return_ACPI_STATUS (AE_TABLE_NOT_SUPPORTED); | |
116 | } | |
117 | ||
118 | ||
119 | /******************************************************************************* | |
120 | * | |
121 | * FUNCTION: acpi_tb_install_table | |
122 | * | |
123 | * PARAMETERS: table_info - Return value from acpi_tb_get_table_body | |
124 | * | |
125 | * RETURN: Status | |
126 | * | |
127 | * DESCRIPTION: Load and validate all tables other than the RSDT. The RSDT must | |
128 | * already be loaded and validated. | |
129 | * Install the table into the global data structs. | |
130 | * | |
131 | ******************************************************************************/ | |
132 | ||
133 | acpi_status | |
134 | acpi_tb_install_table ( | |
135 | struct acpi_table_desc *table_info) | |
136 | { | |
137 | acpi_status status; | |
138 | ||
139 | ACPI_FUNCTION_TRACE ("tb_install_table"); | |
140 | ||
141 | ||
142 | /* Lock tables while installing */ | |
143 | ||
144 | status = acpi_ut_acquire_mutex (ACPI_MTX_TABLES); | |
145 | if (ACPI_FAILURE (status)) { | |
146 | ACPI_REPORT_ERROR (("Could not acquire table mutex for [%4.4s], %s\n", | |
147 | table_info->pointer->signature, acpi_format_exception (status))); | |
148 | return_ACPI_STATUS (status); | |
149 | } | |
150 | ||
151 | /* Install the table into the global data structure */ | |
152 | ||
153 | status = acpi_tb_init_table_descriptor (table_info->type, table_info); | |
154 | if (ACPI_FAILURE (status)) { | |
155 | ACPI_REPORT_ERROR (("Could not install ACPI table [%4.4s], %s\n", | |
156 | table_info->pointer->signature, acpi_format_exception (status))); | |
157 | } | |
158 | ||
159 | ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%s located at %p\n", | |
160 | acpi_gbl_table_data[table_info->type].name, table_info->pointer)); | |
161 | ||
162 | (void) acpi_ut_release_mutex (ACPI_MTX_TABLES); | |
163 | return_ACPI_STATUS (status); | |
164 | } | |
165 | ||
166 | ||
167 | /******************************************************************************* | |
168 | * | |
169 | * FUNCTION: acpi_tb_recognize_table | |
170 | * | |
171 | * PARAMETERS: table_info - Return value from acpi_tb_get_table_body | |
44f6c012 | 172 | * search_type - Table type to match (primary/secondary) |
1da177e4 LT |
173 | * |
174 | * RETURN: Status | |
175 | * | |
176 | * DESCRIPTION: Check a table signature for a match against known table types | |
177 | * | |
178 | * NOTE: All table pointers are validated as follows: | |
179 | * 1) Table pointer must point to valid physical memory | |
180 | * 2) Signature must be 4 ASCII chars, even if we don't recognize the | |
181 | * name | |
182 | * 3) Table must be readable for length specified in the header | |
183 | * 4) Table checksum must be valid (with the exception of the FACS | |
184 | * which has no checksum for some odd reason) | |
185 | * | |
186 | ******************************************************************************/ | |
187 | ||
188 | acpi_status | |
189 | acpi_tb_recognize_table ( | |
190 | struct acpi_table_desc *table_info, | |
191 | u8 search_type) | |
192 | { | |
193 | struct acpi_table_header *table_header; | |
194 | acpi_status status; | |
195 | ||
196 | ||
197 | ACPI_FUNCTION_TRACE ("tb_recognize_table"); | |
198 | ||
199 | ||
200 | /* Ensure that we have a valid table pointer */ | |
201 | ||
202 | table_header = (struct acpi_table_header *) table_info->pointer; | |
203 | if (!table_header) { | |
204 | return_ACPI_STATUS (AE_BAD_PARAMETER); | |
205 | } | |
206 | ||
207 | /* | |
208 | * We only "recognize" a limited number of ACPI tables -- namely, the | |
209 | * ones that are used by the subsystem (DSDT, FADT, etc.) | |
210 | * | |
211 | * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized. | |
212 | * This can be any one of many valid ACPI tables, it just isn't one of | |
213 | * the tables that is consumed by the core subsystem | |
214 | */ | |
44f6c012 RM |
215 | status = acpi_tb_match_signature (table_header->signature, |
216 | table_info, search_type); | |
1da177e4 LT |
217 | if (ACPI_FAILURE (status)) { |
218 | return_ACPI_STATUS (status); | |
219 | } | |
220 | ||
221 | status = acpi_tb_validate_table_header (table_header); | |
222 | if (ACPI_FAILURE (status)) { | |
223 | return_ACPI_STATUS (status); | |
224 | } | |
225 | ||
226 | /* Return the table type and length via the info struct */ | |
227 | ||
228 | table_info->length = (acpi_size) table_header->length; | |
229 | ||
230 | return_ACPI_STATUS (status); | |
231 | } | |
232 | ||
233 | ||
234 | /******************************************************************************* | |
235 | * | |
236 | * FUNCTION: acpi_tb_init_table_descriptor | |
237 | * | |
238 | * PARAMETERS: table_type - The type of the table | |
239 | * table_info - A table info struct | |
240 | * | |
241 | * RETURN: None. | |
242 | * | |
243 | * DESCRIPTION: Install a table into the global data structs. | |
244 | * | |
245 | ******************************************************************************/ | |
246 | ||
247 | acpi_status | |
248 | acpi_tb_init_table_descriptor ( | |
249 | acpi_table_type table_type, | |
250 | struct acpi_table_desc *table_info) | |
251 | { | |
252 | struct acpi_table_list *list_head; | |
253 | struct acpi_table_desc *table_desc; | |
254 | ||
255 | ||
256 | ACPI_FUNCTION_TRACE_U32 ("tb_init_table_descriptor", table_type); | |
257 | ||
258 | ||
259 | /* Allocate a descriptor for this table */ | |
260 | ||
261 | table_desc = ACPI_MEM_CALLOCATE (sizeof (struct acpi_table_desc)); | |
262 | if (!table_desc) { | |
263 | return_ACPI_STATUS (AE_NO_MEMORY); | |
264 | } | |
265 | ||
44f6c012 RM |
266 | /* Install the table into the global data structure */ |
267 | ||
1da177e4 LT |
268 | list_head = &acpi_gbl_table_lists[table_type]; |
269 | ||
270 | /* | |
271 | * Two major types of tables: 1) Only one instance is allowed. This | |
272 | * includes most ACPI tables such as the DSDT. 2) Multiple instances of | |
273 | * the table are allowed. This includes SSDT and PSDTs. | |
274 | */ | |
275 | if (ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags)) { | |
276 | /* | |
277 | * Only one table allowed, and a table has alread been installed | |
278 | * at this location, so return an error. | |
279 | */ | |
280 | if (list_head->next) { | |
281 | ACPI_MEM_FREE (table_desc); | |
282 | return_ACPI_STATUS (AE_ALREADY_EXISTS); | |
283 | } | |
284 | ||
285 | table_desc->next = list_head->next; | |
286 | list_head->next = table_desc; | |
287 | ||
288 | if (table_desc->next) { | |
289 | table_desc->next->prev = table_desc; | |
290 | } | |
291 | ||
292 | list_head->count++; | |
293 | } | |
294 | else { | |
295 | /* | |
296 | * Link the new table in to the list of tables of this type. | |
297 | * Insert at the end of the list, order IS IMPORTANT. | |
298 | * | |
299 | * table_desc->Prev & Next are already NULL from calloc() | |
300 | */ | |
301 | list_head->count++; | |
302 | ||
303 | if (!list_head->next) { | |
304 | list_head->next = table_desc; | |
305 | } | |
306 | else { | |
307 | table_desc->next = list_head->next; | |
308 | ||
309 | while (table_desc->next->next) { | |
310 | table_desc->next = table_desc->next->next; | |
311 | } | |
312 | ||
313 | table_desc->next->next = table_desc; | |
314 | table_desc->prev = table_desc->next; | |
315 | table_desc->next = NULL; | |
316 | } | |
317 | } | |
318 | ||
319 | /* Finish initialization of the table descriptor */ | |
320 | ||
321 | table_desc->type = (u8) table_type; | |
322 | table_desc->pointer = table_info->pointer; | |
323 | table_desc->length = table_info->length; | |
324 | table_desc->allocation = table_info->allocation; | |
325 | table_desc->aml_start = (u8 *) (table_desc->pointer + 1), | |
326 | table_desc->aml_length = (u32) (table_desc->length - | |
327 | (u32) sizeof (struct acpi_table_header)); | |
44f6c012 RM |
328 | table_desc->table_id = acpi_ut_allocate_owner_id ( |
329 | ACPI_OWNER_TYPE_TABLE); | |
1da177e4 LT |
330 | table_desc->loaded_into_namespace = FALSE; |
331 | ||
332 | /* | |
333 | * Set the appropriate global pointer (if there is one) to point to the | |
334 | * newly installed table | |
335 | */ | |
336 | if (acpi_gbl_table_data[table_type].global_ptr) { | |
337 | *(acpi_gbl_table_data[table_type].global_ptr) = table_info->pointer; | |
338 | } | |
339 | ||
340 | /* Return Data */ | |
341 | ||
342 | table_info->table_id = table_desc->table_id; | |
343 | table_info->installed_desc = table_desc; | |
344 | ||
345 | return_ACPI_STATUS (AE_OK); | |
346 | } | |
347 | ||
348 | ||
349 | /******************************************************************************* | |
350 | * | |
351 | * FUNCTION: acpi_tb_delete_all_tables | |
352 | * | |
353 | * PARAMETERS: None. | |
354 | * | |
355 | * RETURN: None. | |
356 | * | |
357 | * DESCRIPTION: Delete all internal ACPI tables | |
358 | * | |
359 | ******************************************************************************/ | |
360 | ||
361 | void | |
44f6c012 RM |
362 | acpi_tb_delete_all_tables ( |
363 | void) | |
1da177e4 LT |
364 | { |
365 | acpi_table_type type; | |
366 | ||
367 | ||
368 | /* | |
369 | * Free memory allocated for ACPI tables | |
370 | * Memory can either be mapped or allocated | |
371 | */ | |
372 | for (type = 0; type < NUM_ACPI_TABLE_TYPES; type++) { | |
373 | acpi_tb_delete_tables_by_type (type); | |
374 | } | |
375 | } | |
376 | ||
377 | ||
378 | /******************************************************************************* | |
379 | * | |
380 | * FUNCTION: acpi_tb_delete_tables_by_type | |
381 | * | |
382 | * PARAMETERS: Type - The table type to be deleted | |
383 | * | |
384 | * RETURN: None. | |
385 | * | |
386 | * DESCRIPTION: Delete an internal ACPI table | |
387 | * Locks the ACPI table mutex | |
388 | * | |
389 | ******************************************************************************/ | |
390 | ||
391 | void | |
392 | acpi_tb_delete_tables_by_type ( | |
393 | acpi_table_type type) | |
394 | { | |
395 | struct acpi_table_desc *table_desc; | |
396 | u32 count; | |
397 | u32 i; | |
398 | ||
399 | ||
400 | ACPI_FUNCTION_TRACE_U32 ("tb_delete_tables_by_type", type); | |
401 | ||
402 | ||
403 | if (type > ACPI_TABLE_MAX) { | |
404 | return_VOID; | |
405 | } | |
406 | ||
407 | if (ACPI_FAILURE (acpi_ut_acquire_mutex (ACPI_MTX_TABLES))) { | |
408 | return; | |
409 | } | |
410 | ||
411 | /* Clear the appropriate "typed" global table pointer */ | |
412 | ||
413 | switch (type) { | |
414 | case ACPI_TABLE_RSDP: | |
415 | acpi_gbl_RSDP = NULL; | |
416 | break; | |
417 | ||
418 | case ACPI_TABLE_DSDT: | |
419 | acpi_gbl_DSDT = NULL; | |
420 | break; | |
421 | ||
422 | case ACPI_TABLE_FADT: | |
423 | acpi_gbl_FADT = NULL; | |
424 | break; | |
425 | ||
426 | case ACPI_TABLE_FACS: | |
427 | acpi_gbl_FACS = NULL; | |
428 | break; | |
429 | ||
430 | case ACPI_TABLE_XSDT: | |
431 | acpi_gbl_XSDT = NULL; | |
432 | break; | |
433 | ||
434 | case ACPI_TABLE_SSDT: | |
435 | case ACPI_TABLE_PSDT: | |
436 | default: | |
437 | break; | |
438 | } | |
439 | ||
440 | /* | |
441 | * Free the table | |
442 | * 1) Get the head of the list | |
443 | */ | |
444 | table_desc = acpi_gbl_table_lists[type].next; | |
445 | count = acpi_gbl_table_lists[type].count; | |
446 | ||
447 | /* | |
448 | * 2) Walk the entire list, deleting both the allocated tables | |
449 | * and the table descriptors | |
450 | */ | |
451 | for (i = 0; i < count; i++) { | |
452 | table_desc = acpi_tb_uninstall_table (table_desc); | |
453 | } | |
454 | ||
455 | (void) acpi_ut_release_mutex (ACPI_MTX_TABLES); | |
456 | return_VOID; | |
457 | } | |
458 | ||
459 | ||
460 | /******************************************************************************* | |
461 | * | |
462 | * FUNCTION: acpi_tb_delete_single_table | |
463 | * | |
464 | * PARAMETERS: table_info - A table info struct | |
465 | * | |
466 | * RETURN: None. | |
467 | * | |
468 | * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where | |
469 | * the table was allocated a buffer or was mapped. | |
470 | * | |
471 | ******************************************************************************/ | |
472 | ||
473 | void | |
474 | acpi_tb_delete_single_table ( | |
475 | struct acpi_table_desc *table_desc) | |
476 | { | |
477 | ||
478 | /* Must have a valid table descriptor and pointer */ | |
479 | ||
480 | if ((!table_desc) || | |
481 | (!table_desc->pointer)) { | |
482 | return; | |
483 | } | |
484 | ||
485 | /* Valid table, determine type of memory allocation */ | |
486 | ||
487 | switch (table_desc->allocation) { | |
488 | case ACPI_MEM_NOT_ALLOCATED: | |
489 | break; | |
490 | ||
491 | case ACPI_MEM_ALLOCATED: | |
492 | ||
493 | ACPI_MEM_FREE (table_desc->pointer); | |
494 | break; | |
495 | ||
496 | case ACPI_MEM_MAPPED: | |
497 | ||
498 | acpi_os_unmap_memory (table_desc->pointer, table_desc->length); | |
499 | break; | |
500 | ||
501 | default: | |
502 | break; | |
503 | } | |
504 | } | |
505 | ||
506 | ||
507 | /******************************************************************************* | |
508 | * | |
509 | * FUNCTION: acpi_tb_uninstall_table | |
510 | * | |
511 | * PARAMETERS: table_info - A table info struct | |
512 | * | |
513 | * RETURN: Pointer to the next table in the list (of same type) | |
514 | * | |
515 | * DESCRIPTION: Free the memory associated with an internal ACPI table that | |
516 | * is either installed or has never been installed. | |
517 | * Table mutex should be locked. | |
518 | * | |
519 | ******************************************************************************/ | |
520 | ||
521 | struct acpi_table_desc * | |
522 | acpi_tb_uninstall_table ( | |
523 | struct acpi_table_desc *table_desc) | |
524 | { | |
525 | struct acpi_table_desc *next_desc; | |
526 | ||
527 | ||
528 | ACPI_FUNCTION_TRACE_PTR ("tb_uninstall_table", table_desc); | |
529 | ||
530 | ||
531 | if (!table_desc) { | |
532 | return_PTR (NULL); | |
533 | } | |
534 | ||
535 | /* Unlink the descriptor from the doubly linked list */ | |
536 | ||
537 | if (table_desc->prev) { | |
538 | table_desc->prev->next = table_desc->next; | |
539 | } | |
540 | else { | |
541 | /* Is first on list, update list head */ | |
542 | ||
543 | acpi_gbl_table_lists[table_desc->type].next = table_desc->next; | |
544 | } | |
545 | ||
546 | if (table_desc->next) { | |
547 | table_desc->next->prev = table_desc->prev; | |
548 | } | |
549 | ||
550 | /* Free the memory allocated for the table itself */ | |
551 | ||
552 | acpi_tb_delete_single_table (table_desc); | |
553 | ||
554 | /* Free the table descriptor */ | |
555 | ||
556 | next_desc = table_desc->next; | |
557 | ACPI_MEM_FREE (table_desc); | |
558 | ||
559 | /* Return pointer to the next descriptor */ | |
560 | ||
561 | return_PTR (next_desc); | |
562 | } | |
563 | ||
564 |