1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME("tbinstal")
52 /******************************************************************************
54 * FUNCTION: acpi_tb_verify_table
56 * PARAMETERS: table_desc - table
60 * DESCRIPTION: this function is called to verify and map table
62 *****************************************************************************/
63 acpi_status acpi_tb_verify_table(struct acpi_table_desc *table_desc)
65 acpi_status status = AE_OK;
67 ACPI_FUNCTION_TRACE(tb_verify_table);
69 /* Map the table if necessary */
71 if (!table_desc->pointer) {
72 if ((table_desc->flags & ACPI_TABLE_ORIGIN_MASK) ==
73 ACPI_TABLE_ORIGIN_MAPPED) {
75 acpi_os_map_memory(table_desc->address,
78 if (!table_desc->pointer) {
79 return_ACPI_STATUS(AE_NO_MEMORY);
83 /* FACS is the odd table, has no standard ACPI header and no checksum */
85 if (!ACPI_COMPARE_NAME(&table_desc->signature, ACPI_SIG_FACS)) {
87 /* Always calculate checksum, ignore bad checksum if requested */
90 acpi_tb_verify_checksum(table_desc->pointer,
94 return_ACPI_STATUS(status);
97 /*******************************************************************************
99 * FUNCTION: acpi_tb_add_table
101 * PARAMETERS: table_desc - Table descriptor
102 * table_index - Where the table index is returned
106 * DESCRIPTION: This function is called to add an ACPI table. It is used to
107 * dynamically load tables via the Load and load_table AML
110 ******************************************************************************/
113 acpi_tb_add_table(struct acpi_table_desc *table_desc, u32 *table_index)
116 acpi_status status = AE_OK;
118 ACPI_FUNCTION_TRACE(tb_add_table);
120 if (!table_desc->pointer) {
121 status = acpi_tb_verify_table(table_desc);
122 if (ACPI_FAILURE(status) || !table_desc->pointer) {
123 return_ACPI_STATUS(status);
128 * Validate the incoming table signature.
130 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
131 * 2) We added support for OEMx tables, signature "OEM".
132 * 3) Valid tables were encountered with a null signature, so we just
133 * gave up on validating the signature, (05/2008).
134 * 4) We encountered non-AML tables such as the MADT, which caused
135 * interpreter errors and kernel faults. So now, we once again allow
136 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
138 if ((table_desc->pointer->signature[0] != 0x00) &&
139 (!ACPI_COMPARE_NAME(table_desc->pointer->signature, ACPI_SIG_SSDT))
140 && (ACPI_STRNCMP(table_desc->pointer->signature, "OEM", 3))) {
141 ACPI_BIOS_ERROR((AE_INFO,
142 "Table has invalid signature [%4.4s] (0x%8.8X), "
143 "must be SSDT or OEMx",
144 acpi_ut_valid_acpi_name(*(u32 *)table_desc->
147 table_desc->pointer->signature : "????",
148 *(u32 *)table_desc->pointer->signature));
150 return_ACPI_STATUS(AE_BAD_SIGNATURE);
153 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
155 /* Check if table is already registered */
157 for (i = 0; i < acpi_gbl_root_table_list.current_table_count; ++i) {
158 if (!acpi_gbl_root_table_list.tables[i].pointer) {
160 acpi_tb_verify_table(&acpi_gbl_root_table_list.
162 if (ACPI_FAILURE(status)
163 || !acpi_gbl_root_table_list.tables[i].pointer) {
169 * Check for a table match on the entire table length,
170 * not just the header.
172 if (table_desc->length !=
173 acpi_gbl_root_table_list.tables[i].length) {
177 if (ACPI_MEMCMP(table_desc->pointer,
178 acpi_gbl_root_table_list.tables[i].pointer,
179 acpi_gbl_root_table_list.tables[i].length)) {
184 * Note: the current mechanism does not unregister a table if it is
185 * dynamically unloaded. The related namespace entries are deleted,
186 * but the table remains in the root table list.
188 * The assumption here is that the number of different tables that
189 * will be loaded is actually small, and there is minimal overhead
190 * in just keeping the table in case it is needed again.
192 * If this assumption changes in the future (perhaps on large
193 * machines with many table load/unload operations), tables will
194 * need to be unregistered when they are unloaded, and slots in the
195 * root table list should be reused when empty.
199 * Table is already registered.
200 * We can delete the table that was passed as a parameter.
202 acpi_tb_delete_table(table_desc);
205 if (acpi_gbl_root_table_list.tables[i].
206 flags & ACPI_TABLE_IS_LOADED) {
208 /* Table is still loaded, this is an error */
210 status = AE_ALREADY_EXISTS;
213 /* Table was unloaded, allow it to be reloaded */
215 table_desc->pointer =
216 acpi_gbl_root_table_list.tables[i].pointer;
217 table_desc->address =
218 acpi_gbl_root_table_list.tables[i].address;
225 * ACPI Table Override:
226 * Allow the host to override dynamically loaded tables.
227 * NOTE: the table is fully mapped at this point, and the mapping will
228 * be deleted by tb_table_override if the table is actually overridden.
230 (void)acpi_tb_table_override(table_desc->pointer, table_desc);
232 /* Add the table to the global root table list */
234 status = acpi_tb_store_table(table_desc->address, table_desc->pointer,
235 table_desc->length, table_desc->flags,
237 if (ACPI_FAILURE(status)) {
242 acpi_tb_print_table_header(table_desc->address, table_desc->pointer);
245 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
246 return_ACPI_STATUS(status);
249 /*******************************************************************************
251 * FUNCTION: acpi_tb_table_override
253 * PARAMETERS: table_header - Header for the original table
254 * table_desc - Table descriptor initialized for the
255 * original table. May or may not be mapped.
257 * RETURN: Pointer to the entire new table. NULL if table not overridden.
258 * If overridden, installs the new table within the input table
261 * DESCRIPTION: Attempt table override by calling the OSL override functions.
262 * Note: If the table is overridden, then the entire new table
263 * is mapped and returned by this function.
265 ******************************************************************************/
267 struct acpi_table_header *acpi_tb_table_override(struct acpi_table_header
269 struct acpi_table_desc
273 struct acpi_table_header *new_table = NULL;
274 acpi_physical_address new_address = 0;
275 u32 new_table_length = 0;
279 /* (1) Attempt logical override (returns a logical address) */
281 status = acpi_os_table_override(table_header, &new_table);
282 if (ACPI_SUCCESS(status) && new_table) {
283 new_address = ACPI_PTR_TO_PHYSADDR(new_table);
284 new_table_length = new_table->length;
285 new_flags = ACPI_TABLE_ORIGIN_OVERRIDE;
286 override_type = "Logical";
287 goto finish_override;
290 /* (2) Attempt physical override (returns a physical address) */
292 status = acpi_os_physical_table_override(table_header,
295 if (ACPI_SUCCESS(status) && new_address && new_table_length) {
297 /* Map the entire new table */
299 new_table = acpi_os_map_memory(new_address, new_table_length);
301 ACPI_EXCEPTION((AE_INFO, AE_NO_MEMORY,
302 "%4.4s %p Attempted physical table override failed",
303 table_header->signature,
304 ACPI_PHYSADDR_TO_PTR(table_desc->address)));
308 override_type = "Physical";
309 new_flags = ACPI_TABLE_ORIGIN_MAPPED;
310 goto finish_override;
313 return (NULL); /* There was no override */
318 "%4.4s %p %s table override, new table: %p",
319 table_header->signature,
320 ACPI_PHYSADDR_TO_PTR(table_desc->address),
321 override_type, new_table));
323 /* We can now unmap/delete the original table (if fully mapped) */
325 acpi_tb_delete_table(table_desc);
327 /* Setup descriptor for the new table */
329 table_desc->address = new_address;
330 table_desc->pointer = new_table;
331 table_desc->length = new_table_length;
332 table_desc->flags = new_flags;
337 /*******************************************************************************
339 * FUNCTION: acpi_tb_resize_root_table_list
345 * DESCRIPTION: Expand the size of global table array
347 ******************************************************************************/
349 acpi_status acpi_tb_resize_root_table_list(void)
351 struct acpi_table_desc *tables;
354 ACPI_FUNCTION_TRACE(tb_resize_root_table_list);
356 /* allow_resize flag is a parameter to acpi_initialize_tables */
358 if (!(acpi_gbl_root_table_list.flags & ACPI_ROOT_ALLOW_RESIZE)) {
360 "Resize of Root Table Array is not allowed"));
361 return_ACPI_STATUS(AE_SUPPORT);
364 /* Increase the Table Array size */
366 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
367 table_count = acpi_gbl_root_table_list.max_table_count;
369 table_count = acpi_gbl_root_table_list.current_table_count;
372 tables = ACPI_ALLOCATE_ZEROED(((acpi_size) table_count +
373 ACPI_ROOT_TABLE_SIZE_INCREMENT) *
374 sizeof(struct acpi_table_desc));
377 "Could not allocate new root table array"));
378 return_ACPI_STATUS(AE_NO_MEMORY);
381 /* Copy and free the previous table array */
383 if (acpi_gbl_root_table_list.tables) {
384 ACPI_MEMCPY(tables, acpi_gbl_root_table_list.tables,
385 (acpi_size) table_count *
386 sizeof(struct acpi_table_desc));
388 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
389 ACPI_FREE(acpi_gbl_root_table_list.tables);
393 acpi_gbl_root_table_list.tables = tables;
394 acpi_gbl_root_table_list.max_table_count =
395 table_count + ACPI_ROOT_TABLE_SIZE_INCREMENT;
396 acpi_gbl_root_table_list.flags |= ACPI_ROOT_ORIGIN_ALLOCATED;
398 return_ACPI_STATUS(AE_OK);
401 /*******************************************************************************
403 * FUNCTION: acpi_tb_store_table
405 * PARAMETERS: address - Table address
406 * table - Table header
407 * length - Table length
410 * RETURN: Status and table index.
412 * DESCRIPTION: Add an ACPI table to the global table list
414 ******************************************************************************/
417 acpi_tb_store_table(acpi_physical_address address,
418 struct acpi_table_header *table,
419 u32 length, u8 flags, u32 *table_index)
422 struct acpi_table_desc *new_table;
424 /* Ensure that there is room for the table in the Root Table List */
426 if (acpi_gbl_root_table_list.current_table_count >=
427 acpi_gbl_root_table_list.max_table_count) {
428 status = acpi_tb_resize_root_table_list();
429 if (ACPI_FAILURE(status)) {
435 &acpi_gbl_root_table_list.tables[acpi_gbl_root_table_list.
436 current_table_count];
438 /* Initialize added table */
440 new_table->address = address;
441 new_table->pointer = table;
442 new_table->length = length;
443 new_table->owner_id = 0;
444 new_table->flags = flags;
446 ACPI_MOVE_32_TO_32(&new_table->signature, table->signature);
448 *table_index = acpi_gbl_root_table_list.current_table_count;
449 acpi_gbl_root_table_list.current_table_count++;
453 /*******************************************************************************
455 * FUNCTION: acpi_tb_delete_table
457 * PARAMETERS: table_index - Table index
461 * DESCRIPTION: Delete one internal ACPI table
463 ******************************************************************************/
465 void acpi_tb_delete_table(struct acpi_table_desc *table_desc)
467 /* Table must be mapped or allocated */
468 if (!table_desc->pointer) {
471 switch (table_desc->flags & ACPI_TABLE_ORIGIN_MASK) {
472 case ACPI_TABLE_ORIGIN_MAPPED:
473 acpi_os_unmap_memory(table_desc->pointer, table_desc->length);
475 case ACPI_TABLE_ORIGIN_ALLOCATED:
476 ACPI_FREE(table_desc->pointer);
479 /* Not mapped or allocated, there is nothing we can do */
485 table_desc->pointer = NULL;
488 /*******************************************************************************
490 * FUNCTION: acpi_tb_terminate
496 * DESCRIPTION: Delete all internal ACPI tables
498 ******************************************************************************/
500 void acpi_tb_terminate(void)
504 ACPI_FUNCTION_TRACE(tb_terminate);
506 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
508 /* Delete the individual tables */
510 for (i = 0; i < acpi_gbl_root_table_list.current_table_count; i++) {
511 acpi_tb_delete_table(&acpi_gbl_root_table_list.tables[i]);
515 * Delete the root table array if allocated locally. Array cannot be
516 * mapped, so we don't need to check for that flag.
518 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
519 ACPI_FREE(acpi_gbl_root_table_list.tables);
522 acpi_gbl_root_table_list.tables = NULL;
523 acpi_gbl_root_table_list.flags = 0;
524 acpi_gbl_root_table_list.current_table_count = 0;
526 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "ACPI Tables freed\n"));
527 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
532 /*******************************************************************************
534 * FUNCTION: acpi_tb_delete_namespace_by_owner
536 * PARAMETERS: table_index - Table index
540 * DESCRIPTION: Delete all namespace objects created when this table was loaded.
542 ******************************************************************************/
544 acpi_status acpi_tb_delete_namespace_by_owner(u32 table_index)
546 acpi_owner_id owner_id;
549 ACPI_FUNCTION_TRACE(tb_delete_namespace_by_owner);
551 status = acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
552 if (ACPI_FAILURE(status)) {
553 return_ACPI_STATUS(status);
556 if (table_index >= acpi_gbl_root_table_list.current_table_count) {
558 /* The table index does not exist */
560 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
561 return_ACPI_STATUS(AE_NOT_EXIST);
564 /* Get the owner ID for this table, used to delete namespace nodes */
566 owner_id = acpi_gbl_root_table_list.tables[table_index].owner_id;
567 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
570 * Need to acquire the namespace writer lock to prevent interference
571 * with any concurrent namespace walks. The interpreter must be
572 * released during the deletion since the acquisition of the deletion
573 * lock may block, and also since the execution of a namespace walk
574 * must be allowed to use the interpreter.
576 (void)acpi_ut_release_mutex(ACPI_MTX_INTERPRETER);
577 status = acpi_ut_acquire_write_lock(&acpi_gbl_namespace_rw_lock);
579 acpi_ns_delete_namespace_by_owner(owner_id);
580 if (ACPI_FAILURE(status)) {
581 return_ACPI_STATUS(status);
584 acpi_ut_release_write_lock(&acpi_gbl_namespace_rw_lock);
586 status = acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER);
587 return_ACPI_STATUS(status);
590 /*******************************************************************************
592 * FUNCTION: acpi_tb_allocate_owner_id
594 * PARAMETERS: table_index - Table index
598 * DESCRIPTION: Allocates owner_id in table_desc
600 ******************************************************************************/
602 acpi_status acpi_tb_allocate_owner_id(u32 table_index)
604 acpi_status status = AE_BAD_PARAMETER;
606 ACPI_FUNCTION_TRACE(tb_allocate_owner_id);
608 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
609 if (table_index < acpi_gbl_root_table_list.current_table_count) {
610 status = acpi_ut_allocate_owner_id
611 (&(acpi_gbl_root_table_list.tables[table_index].owner_id));
614 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
615 return_ACPI_STATUS(status);
618 /*******************************************************************************
620 * FUNCTION: acpi_tb_release_owner_id
622 * PARAMETERS: table_index - Table index
626 * DESCRIPTION: Releases owner_id in table_desc
628 ******************************************************************************/
630 acpi_status acpi_tb_release_owner_id(u32 table_index)
632 acpi_status status = AE_BAD_PARAMETER;
634 ACPI_FUNCTION_TRACE(tb_release_owner_id);
636 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
637 if (table_index < acpi_gbl_root_table_list.current_table_count) {
638 acpi_ut_release_owner_id(&
639 (acpi_gbl_root_table_list.
640 tables[table_index].owner_id));
644 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
645 return_ACPI_STATUS(status);
648 /*******************************************************************************
650 * FUNCTION: acpi_tb_get_owner_id
652 * PARAMETERS: table_index - Table index
653 * owner_id - Where the table owner_id is returned
657 * DESCRIPTION: returns owner_id for the ACPI table
659 ******************************************************************************/
661 acpi_status acpi_tb_get_owner_id(u32 table_index, acpi_owner_id *owner_id)
663 acpi_status status = AE_BAD_PARAMETER;
665 ACPI_FUNCTION_TRACE(tb_get_owner_id);
667 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
668 if (table_index < acpi_gbl_root_table_list.current_table_count) {
670 acpi_gbl_root_table_list.tables[table_index].owner_id;
674 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
675 return_ACPI_STATUS(status);
678 /*******************************************************************************
680 * FUNCTION: acpi_tb_is_table_loaded
682 * PARAMETERS: table_index - Table index
684 * RETURN: Table Loaded Flag
686 ******************************************************************************/
688 u8 acpi_tb_is_table_loaded(u32 table_index)
690 u8 is_loaded = FALSE;
692 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
693 if (table_index < acpi_gbl_root_table_list.current_table_count) {
695 (acpi_gbl_root_table_list.tables[table_index].flags &
696 ACPI_TABLE_IS_LOADED);
699 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
703 /*******************************************************************************
705 * FUNCTION: acpi_tb_set_table_loaded_flag
707 * PARAMETERS: table_index - Table index
708 * is_loaded - TRUE if table is loaded, FALSE otherwise
712 * DESCRIPTION: Sets the table loaded flag to either TRUE or FALSE.
714 ******************************************************************************/
716 void acpi_tb_set_table_loaded_flag(u32 table_index, u8 is_loaded)
719 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
720 if (table_index < acpi_gbl_root_table_list.current_table_count) {
722 acpi_gbl_root_table_list.tables[table_index].flags |=
723 ACPI_TABLE_IS_LOADED;
725 acpi_gbl_root_table_list.tables[table_index].flags &=
726 ~ACPI_TABLE_IS_LOADED;
730 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);