1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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))) {
142 "Table has invalid signature [%4.4s] (0x%8.8X), must be SSDT or OEMx",
143 acpi_ut_valid_acpi_name(*(u32
*)table_desc
->
145 signature
) ? table_desc
->
146 pointer
->signature
: "????",
147 *(u32
*)table_desc
->pointer
->signature
));
149 return_ACPI_STATUS(AE_BAD_SIGNATURE
);
152 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
154 /* Check if table is already registered */
156 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; ++i
) {
157 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
159 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
161 if (ACPI_FAILURE(status
)
162 || !acpi_gbl_root_table_list
.tables
[i
].pointer
) {
168 * Check for a table match on the entire table length,
169 * not just the header.
171 if (table_desc
->length
!=
172 acpi_gbl_root_table_list
.tables
[i
].length
) {
176 if (ACPI_MEMCMP(table_desc
->pointer
,
177 acpi_gbl_root_table_list
.tables
[i
].pointer
,
178 acpi_gbl_root_table_list
.tables
[i
].length
)) {
183 * Note: the current mechanism does not unregister a table if it is
184 * dynamically unloaded. The related namespace entries are deleted,
185 * but the table remains in the root table list.
187 * The assumption here is that the number of different tables that
188 * will be loaded is actually small, and there is minimal overhead
189 * in just keeping the table in case it is needed again.
191 * If this assumption changes in the future (perhaps on large
192 * machines with many table load/unload operations), tables will
193 * need to be unregistered when they are unloaded, and slots in the
194 * root table list should be reused when empty.
198 * Table is already registered.
199 * We can delete the table that was passed as a parameter.
201 acpi_tb_delete_table(table_desc
);
204 if (acpi_gbl_root_table_list
.tables
[i
].
205 flags
& ACPI_TABLE_IS_LOADED
) {
207 /* Table is still loaded, this is an error */
209 status
= AE_ALREADY_EXISTS
;
212 /* Table was unloaded, allow it to be reloaded */
214 table_desc
->pointer
=
215 acpi_gbl_root_table_list
.tables
[i
].pointer
;
216 table_desc
->address
=
217 acpi_gbl_root_table_list
.tables
[i
].address
;
224 * ACPI Table Override:
225 * Allow the host to override dynamically loaded tables.
226 * NOTE: the table is fully mapped at this point, and the mapping will
227 * be deleted by tb_table_override if the table is actually overridden.
229 (void)acpi_tb_table_override(table_desc
->pointer
, table_desc
);
231 /* Add the table to the global root table list */
233 status
= acpi_tb_store_table(table_desc
->address
, table_desc
->pointer
,
234 table_desc
->length
, table_desc
->flags
,
236 if (ACPI_FAILURE(status
)) {
241 acpi_tb_print_table_header(table_desc
->address
, table_desc
->pointer
);
244 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
245 return_ACPI_STATUS(status
);
248 /*******************************************************************************
250 * FUNCTION: acpi_tb_table_override
252 * PARAMETERS: table_header - Header for the original table
253 * table_desc - Table descriptor initialized for the
254 * original table. May or may not be mapped.
256 * RETURN: Pointer to the entire new table. NULL if table not overridden.
257 * If overridden, installs the new table within the input table
260 * DESCRIPTION: Attempt table override by calling the OSL override functions.
261 * Note: If the table is overridden, then the entire new table
262 * is mapped and returned by this function.
264 ******************************************************************************/
266 struct acpi_table_header
*acpi_tb_table_override(struct acpi_table_header
268 struct acpi_table_desc
272 struct acpi_table_header
*new_table
= NULL
;
273 acpi_physical_address new_address
= 0;
274 u32 new_table_length
= 0;
278 /* (1) Attempt logical override (returns a logical address) */
280 status
= acpi_os_table_override(table_header
, &new_table
);
281 if (ACPI_SUCCESS(status
) && new_table
) {
282 new_address
= ACPI_PTR_TO_PHYSADDR(new_table
);
283 new_table_length
= new_table
->length
;
284 new_flags
= ACPI_TABLE_ORIGIN_OVERRIDE
;
285 override_type
= "Logical";
286 goto finish_override
;
289 /* (2) Attempt physical override (returns a physical address) */
291 status
= acpi_os_physical_table_override(table_header
,
294 if (ACPI_SUCCESS(status
) && new_address
&& new_table_length
) {
296 /* Map the entire new table */
298 new_table
= acpi_os_map_memory(new_address
, new_table_length
);
300 ACPI_EXCEPTION((AE_INFO
, AE_NO_MEMORY
,
301 "%4.4s %p Attempted physical table override failed",
302 table_header
->signature
,
304 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_CAST_PTR(void, 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
;
353 ACPI_FUNCTION_TRACE(tb_resize_root_table_list
);
355 /* allow_resize flag is a parameter to acpi_initialize_tables */
357 if (!(acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ALLOW_RESIZE
)) {
359 "Resize of Root Table Array is not allowed"));
360 return_ACPI_STATUS(AE_SUPPORT
);
363 /* Increase the Table Array size */
365 tables
= ACPI_ALLOCATE_ZEROED(((acpi_size
) acpi_gbl_root_table_list
.
367 ACPI_ROOT_TABLE_SIZE_INCREMENT
) *
368 sizeof(struct acpi_table_desc
));
371 "Could not allocate new root table array"));
372 return_ACPI_STATUS(AE_NO_MEMORY
);
375 /* Copy and free the previous table array */
377 if (acpi_gbl_root_table_list
.tables
) {
378 ACPI_MEMCPY(tables
, acpi_gbl_root_table_list
.tables
,
379 (acpi_size
) acpi_gbl_root_table_list
.
380 max_table_count
* sizeof(struct acpi_table_desc
));
382 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
383 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
387 acpi_gbl_root_table_list
.tables
= tables
;
388 acpi_gbl_root_table_list
.max_table_count
+=
389 ACPI_ROOT_TABLE_SIZE_INCREMENT
;
390 acpi_gbl_root_table_list
.flags
|= (u8
)ACPI_ROOT_ORIGIN_ALLOCATED
;
392 return_ACPI_STATUS(AE_OK
);
395 /*******************************************************************************
397 * FUNCTION: acpi_tb_store_table
399 * PARAMETERS: Address - Table address
400 * Table - Table header
401 * Length - Table length
404 * RETURN: Status and table index.
406 * DESCRIPTION: Add an ACPI table to the global table list
408 ******************************************************************************/
411 acpi_tb_store_table(acpi_physical_address address
,
412 struct acpi_table_header
*table
,
413 u32 length
, u8 flags
, u32
*table_index
)
416 struct acpi_table_desc
*new_table
;
418 /* Ensure that there is room for the table in the Root Table List */
420 if (acpi_gbl_root_table_list
.current_table_count
>=
421 acpi_gbl_root_table_list
.max_table_count
) {
422 status
= acpi_tb_resize_root_table_list();
423 if (ACPI_FAILURE(status
)) {
429 &acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.
430 current_table_count
];
432 /* Initialize added table */
434 new_table
->address
= address
;
435 new_table
->pointer
= table
;
436 new_table
->length
= length
;
437 new_table
->owner_id
= 0;
438 new_table
->flags
= flags
;
440 ACPI_MOVE_32_TO_32(&new_table
->signature
, table
->signature
);
442 *table_index
= acpi_gbl_root_table_list
.current_table_count
;
443 acpi_gbl_root_table_list
.current_table_count
++;
447 /*******************************************************************************
449 * FUNCTION: acpi_tb_delete_table
451 * PARAMETERS: table_index - Table index
455 * DESCRIPTION: Delete one internal ACPI table
457 ******************************************************************************/
459 void acpi_tb_delete_table(struct acpi_table_desc
*table_desc
)
461 /* Table must be mapped or allocated */
462 if (!table_desc
->pointer
) {
465 switch (table_desc
->flags
& ACPI_TABLE_ORIGIN_MASK
) {
466 case ACPI_TABLE_ORIGIN_MAPPED
:
467 acpi_os_unmap_memory(table_desc
->pointer
, table_desc
->length
);
469 case ACPI_TABLE_ORIGIN_ALLOCATED
:
470 ACPI_FREE(table_desc
->pointer
);
473 /* Not mapped or allocated, there is nothing we can do */
479 table_desc
->pointer
= NULL
;
482 /*******************************************************************************
484 * FUNCTION: acpi_tb_terminate
490 * DESCRIPTION: Delete all internal ACPI tables
492 ******************************************************************************/
494 void acpi_tb_terminate(void)
498 ACPI_FUNCTION_TRACE(tb_terminate
);
500 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
502 /* Delete the individual tables */
504 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; i
++) {
505 acpi_tb_delete_table(&acpi_gbl_root_table_list
.tables
[i
]);
509 * Delete the root table array if allocated locally. Array cannot be
510 * mapped, so we don't need to check for that flag.
512 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
513 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
516 acpi_gbl_root_table_list
.tables
= NULL
;
517 acpi_gbl_root_table_list
.flags
= 0;
518 acpi_gbl_root_table_list
.current_table_count
= 0;
520 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "ACPI Tables freed\n"));
521 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
524 /*******************************************************************************
526 * FUNCTION: acpi_tb_delete_namespace_by_owner
528 * PARAMETERS: table_index - Table index
532 * DESCRIPTION: Delete all namespace objects created when this table was loaded.
534 ******************************************************************************/
536 acpi_status
acpi_tb_delete_namespace_by_owner(u32 table_index
)
538 acpi_owner_id owner_id
;
541 ACPI_FUNCTION_TRACE(tb_delete_namespace_by_owner
);
543 status
= acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
544 if (ACPI_FAILURE(status
)) {
545 return_ACPI_STATUS(status
);
548 if (table_index
>= acpi_gbl_root_table_list
.current_table_count
) {
550 /* The table index does not exist */
552 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
553 return_ACPI_STATUS(AE_NOT_EXIST
);
556 /* Get the owner ID for this table, used to delete namespace nodes */
558 owner_id
= acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
559 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
562 * Need to acquire the namespace writer lock to prevent interference
563 * with any concurrent namespace walks. The interpreter must be
564 * released during the deletion since the acquisition of the deletion
565 * lock may block, and also since the execution of a namespace walk
566 * must be allowed to use the interpreter.
568 (void)acpi_ut_release_mutex(ACPI_MTX_INTERPRETER
);
569 status
= acpi_ut_acquire_write_lock(&acpi_gbl_namespace_rw_lock
);
571 acpi_ns_delete_namespace_by_owner(owner_id
);
572 if (ACPI_FAILURE(status
)) {
573 return_ACPI_STATUS(status
);
576 acpi_ut_release_write_lock(&acpi_gbl_namespace_rw_lock
);
578 status
= acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER
);
579 return_ACPI_STATUS(status
);
582 /*******************************************************************************
584 * FUNCTION: acpi_tb_allocate_owner_id
586 * PARAMETERS: table_index - Table index
590 * DESCRIPTION: Allocates owner_id in table_desc
592 ******************************************************************************/
594 acpi_status
acpi_tb_allocate_owner_id(u32 table_index
)
596 acpi_status status
= AE_BAD_PARAMETER
;
598 ACPI_FUNCTION_TRACE(tb_allocate_owner_id
);
600 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
601 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
602 status
= acpi_ut_allocate_owner_id
603 (&(acpi_gbl_root_table_list
.tables
[table_index
].owner_id
));
606 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
607 return_ACPI_STATUS(status
);
610 /*******************************************************************************
612 * FUNCTION: acpi_tb_release_owner_id
614 * PARAMETERS: table_index - Table index
618 * DESCRIPTION: Releases owner_id in table_desc
620 ******************************************************************************/
622 acpi_status
acpi_tb_release_owner_id(u32 table_index
)
624 acpi_status status
= AE_BAD_PARAMETER
;
626 ACPI_FUNCTION_TRACE(tb_release_owner_id
);
628 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
629 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
630 acpi_ut_release_owner_id(&
631 (acpi_gbl_root_table_list
.
632 tables
[table_index
].owner_id
));
636 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
637 return_ACPI_STATUS(status
);
640 /*******************************************************************************
642 * FUNCTION: acpi_tb_get_owner_id
644 * PARAMETERS: table_index - Table index
645 * owner_id - Where the table owner_id is returned
649 * DESCRIPTION: returns owner_id for the ACPI table
651 ******************************************************************************/
653 acpi_status
acpi_tb_get_owner_id(u32 table_index
, acpi_owner_id
*owner_id
)
655 acpi_status status
= AE_BAD_PARAMETER
;
657 ACPI_FUNCTION_TRACE(tb_get_owner_id
);
659 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
660 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
662 acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
666 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
667 return_ACPI_STATUS(status
);
670 /*******************************************************************************
672 * FUNCTION: acpi_tb_is_table_loaded
674 * PARAMETERS: table_index - Table index
676 * RETURN: Table Loaded Flag
678 ******************************************************************************/
680 u8
acpi_tb_is_table_loaded(u32 table_index
)
682 u8 is_loaded
= FALSE
;
684 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
685 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
687 (acpi_gbl_root_table_list
.tables
[table_index
].flags
&
688 ACPI_TABLE_IS_LOADED
);
691 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
695 /*******************************************************************************
697 * FUNCTION: acpi_tb_set_table_loaded_flag
699 * PARAMETERS: table_index - Table index
700 * is_loaded - TRUE if table is loaded, FALSE otherwise
704 * DESCRIPTION: Sets the table loaded flag to either TRUE or FALSE.
706 ******************************************************************************/
708 void acpi_tb_set_table_loaded_flag(u32 table_index
, u8 is_loaded
)
711 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
712 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
714 acpi_gbl_root_table_list
.tables
[table_index
].flags
|=
715 ACPI_TABLE_IS_LOADED
;
717 acpi_gbl_root_table_list
.tables
[table_index
].flags
&=
718 ~ACPI_TABLE_IS_LOADED
;
722 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);