1 /******************************************************************************
3 * Module Name: tbxface - Public interfaces to the ACPI subsystem
4 * ACPI table oriented interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/actables.h>
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME("tbxface")
52 /* Local prototypes */
53 static acpi_status
acpi_tb_load_namespace(void);
55 static int no_auto_ssdt
;
57 /*******************************************************************************
59 * FUNCTION: acpi_allocate_root_table
61 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
62 * struct acpi_table_desc structures
66 * DESCRIPTION: Allocate a root table array. Used by i_aSL compiler and
67 * acpi_initialize_tables.
69 ******************************************************************************/
71 acpi_status
acpi_allocate_root_table(u32 initial_table_count
)
74 acpi_gbl_root_table_list
.size
= initial_table_count
;
75 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ALLOW_RESIZE
;
77 return (acpi_tb_resize_root_table_list());
80 /*******************************************************************************
82 * FUNCTION: acpi_initialize_tables
84 * PARAMETERS: initial_table_array - Pointer to an array of pre-allocated
85 * struct acpi_table_desc structures. If NULL, the
86 * array is dynamically allocated.
87 * initial_table_count - Size of initial_table_array, in number of
88 * struct acpi_table_desc structures
89 * allow_realloc - Flag to tell Table Manager if resize of
90 * pre-allocated array is allowed. Ignored
91 * if initial_table_array is NULL.
95 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
97 * NOTE: Allows static allocation of the initial table array in order
98 * to avoid the use of dynamic memory in confined environments
99 * such as the kernel boot sequence where it may not be available.
101 * If the host OS memory managers are initialized, use NULL for
102 * initial_table_array, and the table will be dynamically allocated.
104 ******************************************************************************/
107 acpi_initialize_tables(struct acpi_table_desc
* initial_table_array
,
108 u32 initial_table_count
, u8 allow_resize
)
110 acpi_physical_address rsdp_address
;
113 ACPI_FUNCTION_TRACE(acpi_initialize_tables
);
116 * Set up the Root Table Array
117 * Allocate the table array if requested
119 if (!initial_table_array
) {
120 status
= acpi_allocate_root_table(initial_table_count
);
121 if (ACPI_FAILURE(status
)) {
122 return_ACPI_STATUS(status
);
125 /* Root Table Array has been statically allocated by the host */
127 ACPI_MEMSET(initial_table_array
, 0,
128 initial_table_count
*
129 sizeof(struct acpi_table_desc
));
131 acpi_gbl_root_table_list
.tables
= initial_table_array
;
132 acpi_gbl_root_table_list
.size
= initial_table_count
;
133 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ORIGIN_UNKNOWN
;
135 acpi_gbl_root_table_list
.flags
|=
136 ACPI_ROOT_ALLOW_RESIZE
;
140 /* Get the address of the RSDP */
142 rsdp_address
= acpi_os_get_root_pointer();
144 return_ACPI_STATUS(AE_NOT_FOUND
);
148 * Get the root table (RSDT or XSDT) and extract all entries to the local
149 * Root Table Array. This array contains the information of the RSDT/XSDT
150 * in a common, more useable format.
153 acpi_tb_parse_root_table(rsdp_address
, ACPI_TABLE_ORIGIN_MAPPED
);
154 return_ACPI_STATUS(status
);
157 /*******************************************************************************
159 * FUNCTION: acpi_reallocate_root_table
165 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
166 * root list from the previously provided scratch area. Should
167 * be called once dynamic memory allocation is available in the
170 ******************************************************************************/
171 acpi_status
acpi_reallocate_root_table(void)
173 struct acpi_table_desc
*tables
;
176 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table
);
179 * Only reallocate the root table if the host provided a static buffer
180 * for the table array in the call to acpi_initialize_tables.
182 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
183 return_ACPI_STATUS(AE_SUPPORT
);
187 (acpi_gbl_root_table_list
.count
+
188 ACPI_ROOT_TABLE_SIZE_INCREMENT
) * sizeof(struct acpi_table_desc
);
190 /* Create new array and copy the old array */
192 tables
= ACPI_ALLOCATE_ZEROED(new_size
);
194 return_ACPI_STATUS(AE_NO_MEMORY
);
197 ACPI_MEMCPY(tables
, acpi_gbl_root_table_list
.tables
, new_size
);
199 acpi_gbl_root_table_list
.size
= acpi_gbl_root_table_list
.count
;
200 acpi_gbl_root_table_list
.tables
= tables
;
201 acpi_gbl_root_table_list
.flags
=
202 ACPI_ROOT_ORIGIN_ALLOCATED
| ACPI_ROOT_ALLOW_RESIZE
;
204 return_ACPI_STATUS(AE_OK
);
207 /*******************************************************************************
209 * FUNCTION: acpi_load_table
211 * PARAMETERS: table_ptr - pointer to a buffer containing the entire
216 * DESCRIPTION: This function is called to load a table from the caller's
217 * buffer. The buffer must contain an entire ACPI Table including
218 * a valid header. The header fields will be verified, and if it
219 * is determined that the table is invalid, the call will fail.
221 ******************************************************************************/
222 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
)
225 acpi_native_uint table_index
;
226 struct acpi_table_desc table_desc
;
229 return AE_BAD_PARAMETER
;
231 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
232 table_desc
.pointer
= table_ptr
;
233 table_desc
.length
= table_ptr
->length
;
234 table_desc
.flags
= ACPI_TABLE_ORIGIN_UNKNOWN
;
237 * Install the new table into the local data structures
239 status
= acpi_tb_add_table(&table_desc
, &table_index
);
240 if (ACPI_FAILURE(status
)) {
243 status
= acpi_ns_load_table(table_index
, acpi_gbl_root_node
);
247 ACPI_EXPORT_SYMBOL(acpi_load_table
)
249 /******************************************************************************
251 * FUNCTION: acpi_get_table_header
253 * PARAMETERS: Signature - ACPI signature of needed table
254 * Instance - Which instance (for SSDTs)
255 * out_table_header - The pointer to the table header to fill
257 * RETURN: Status and pointer to mapped table header
259 * DESCRIPTION: Finds an ACPI table header.
261 * NOTE: Caller is responsible in unmapping the header with
262 * acpi_os_unmap_memory
264 *****************************************************************************/
266 acpi_get_table_header(char *signature
,
267 acpi_native_uint instance
,
268 struct acpi_table_header
* out_table_header
)
272 struct acpi_table_header
*header
;
274 /* Parameter validation */
276 if (!signature
|| !out_table_header
) {
277 return (AE_BAD_PARAMETER
);
281 * Walk the root table list
283 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.count
; i
++) {
284 if (!ACPI_COMPARE_NAME
285 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
290 if (++j
< instance
) {
294 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
295 if ((acpi_gbl_root_table_list
.tables
[i
].
296 flags
& ACPI_TABLE_ORIGIN_MASK
) ==
297 ACPI_TABLE_ORIGIN_MAPPED
) {
299 acpi_os_map_memory(acpi_gbl_root_table_list
.
306 ACPI_MEMCPY(out_table_header
, header
,
307 sizeof(struct acpi_table_header
));
308 acpi_os_unmap_memory(header
,
315 ACPI_MEMCPY(out_table_header
,
316 acpi_gbl_root_table_list
.tables
[i
].pointer
,
317 sizeof(struct acpi_table_header
));
322 return (AE_NOT_FOUND
);
325 ACPI_EXPORT_SYMBOL(acpi_get_table_header
)
327 /******************************************************************************
329 * FUNCTION: acpi_unload_table_id
331 * PARAMETERS: id - Owner ID of the table to be removed.
335 * DESCRIPTION: This routine is used to force the unload of a table (by id)
337 ******************************************************************************/
338 acpi_status
acpi_unload_table_id(acpi_owner_id id
)
341 acpi_status status
= AE_NOT_EXIST
;
343 ACPI_FUNCTION_TRACE(acpi_unload_table_id
);
345 /* Find table in the global table list */
346 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
347 if (id
!= acpi_gbl_root_table_list
.tables
[i
].owner_id
) {
351 * Delete all namespace objects owned by this table. Note that these
352 * objects can appear anywhere in the namespace by virtue of the AML
353 * "Scope" operator. Thus, we need to track ownership by an ID, not
354 * simply a position within the hierarchy
356 acpi_tb_delete_namespace_by_owner(i
);
357 status
= acpi_tb_release_owner_id(i
);
358 acpi_tb_set_table_loaded_flag(i
, FALSE
);
361 return_ACPI_STATUS(status
);
364 ACPI_EXPORT_SYMBOL(acpi_unload_table_id
)
366 /*******************************************************************************
368 * FUNCTION: acpi_get_table
370 * PARAMETERS: Signature - ACPI signature of needed table
371 * Instance - Which instance (for SSDTs)
372 * out_table - Where the pointer to the table is returned
374 * RETURN: Status and pointer to table
376 * DESCRIPTION: Finds and verifies an ACPI table.
378 *****************************************************************************/
380 acpi_get_table(char *signature
,
381 acpi_native_uint instance
, struct acpi_table_header
**out_table
)
387 /* Parameter validation */
389 if (!signature
|| !out_table
) {
390 return (AE_BAD_PARAMETER
);
394 * Walk the root table list
396 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.count
; i
++) {
397 if (!ACPI_COMPARE_NAME
398 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
403 if (++j
< instance
) {
408 acpi_tb_verify_table(&acpi_gbl_root_table_list
.tables
[i
]);
409 if (ACPI_SUCCESS(status
)) {
410 *out_table
= acpi_gbl_root_table_list
.tables
[i
].pointer
;
413 if (!acpi_gbl_permanent_mmap
) {
414 acpi_gbl_root_table_list
.tables
[i
].pointer
= NULL
;
420 return (AE_NOT_FOUND
);
423 ACPI_EXPORT_SYMBOL(acpi_get_table
)
425 /*******************************************************************************
427 * FUNCTION: acpi_get_table_by_index
429 * PARAMETERS: table_index - Table index
430 * Table - Where the pointer to the table is returned
432 * RETURN: Status and pointer to the table
434 * DESCRIPTION: Obtain a table by an index into the global table list.
436 ******************************************************************************/
438 acpi_get_table_by_index(acpi_native_uint table_index
,
439 struct acpi_table_header
** table
)
443 ACPI_FUNCTION_TRACE(acpi_get_table_by_index
);
445 /* Parameter validation */
448 return_ACPI_STATUS(AE_BAD_PARAMETER
);
451 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
455 if (table_index
>= acpi_gbl_root_table_list
.count
) {
456 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
457 return_ACPI_STATUS(AE_BAD_PARAMETER
);
460 if (!acpi_gbl_root_table_list
.tables
[table_index
].pointer
) {
462 /* Table is not mapped, map it */
465 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
466 tables
[table_index
]);
467 if (ACPI_FAILURE(status
)) {
468 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
469 return_ACPI_STATUS(status
);
473 *table
= acpi_gbl_root_table_list
.tables
[table_index
].pointer
;
474 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
475 return_ACPI_STATUS(AE_OK
);
478 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index
)
480 /*******************************************************************************
482 * FUNCTION: acpi_tb_load_namespace
488 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
491 ******************************************************************************/
492 static acpi_status
acpi_tb_load_namespace(void)
495 struct acpi_table_header
*table
;
498 ACPI_FUNCTION_TRACE(tb_load_namespace
);
500 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
503 * Load the namespace. The DSDT is required, but any SSDT and PSDT tables
506 if (!acpi_gbl_root_table_list
.count
||
508 (acpi_gbl_root_table_list
.
509 tables
[ACPI_TABLE_INDEX_DSDT
].signature
),
512 ACPI_FAILURE(acpi_tb_verify_table
513 (&acpi_gbl_root_table_list
.
514 tables
[ACPI_TABLE_INDEX_DSDT
]))) {
515 status
= AE_NO_ACPI_TABLES
;
516 goto unlock_and_exit
;
523 acpi_os_table_override(acpi_gbl_root_table_list
.
524 tables
[ACPI_TABLE_INDEX_DSDT
].pointer
,
526 if (ACPI_SUCCESS(status
) && table
) {
528 * DSDT table has been found
530 acpi_tb_delete_table(&acpi_gbl_root_table_list
.
531 tables
[ACPI_TABLE_INDEX_DSDT
]);
532 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].pointer
=
534 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].length
=
536 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].flags
=
537 ACPI_TABLE_ORIGIN_UNKNOWN
;
539 ACPI_INFO((AE_INFO
, "Table DSDT replaced by host OS"));
540 acpi_tb_print_table_header(0, table
);
542 if (no_auto_ssdt
== 0) {
543 printk(KERN_WARNING
"ACPI: DSDT override uses original SSDTs unless \"acpi_no_auto_ssdt\"\n");
548 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
549 tables
[ACPI_TABLE_INDEX_DSDT
]);
550 if (ACPI_FAILURE(status
)) {
552 /* A valid DSDT is required */
554 status
= AE_NO_ACPI_TABLES
;
555 goto unlock_and_exit
;
558 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
561 * Load and parse tables.
563 status
= acpi_ns_load_table(ACPI_TABLE_INDEX_DSDT
, acpi_gbl_root_node
);
564 if (ACPI_FAILURE(status
)) {
565 return_ACPI_STATUS(status
);
569 * Load any SSDT or PSDT tables. Note: Loop leaves tables locked
571 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
572 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
573 if ((!ACPI_COMPARE_NAME
574 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
578 (acpi_gbl_root_table_list
.tables
[i
].
579 signature
), ACPI_SIG_PSDT
))
581 ACPI_FAILURE(acpi_tb_verify_table
582 (&acpi_gbl_root_table_list
.tables
[i
]))) {
587 printk(KERN_WARNING
"ACPI: SSDT ignored due to \"acpi_no_auto_ssdt\"\n");
591 /* Ignore errors while loading tables, get as many as possible */
593 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
594 (void)acpi_ns_load_table(i
, acpi_gbl_root_node
);
595 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
598 ACPI_DEBUG_PRINT((ACPI_DB_INIT
, "ACPI Tables successfully acquired\n"));
601 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
602 return_ACPI_STATUS(status
);
605 /*******************************************************************************
607 * FUNCTION: acpi_load_tables
613 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
615 ******************************************************************************/
617 acpi_status
acpi_load_tables(void)
621 ACPI_FUNCTION_TRACE(acpi_load_tables
);
624 * Load the namespace from the tables
626 status
= acpi_tb_load_namespace();
627 if (ACPI_FAILURE(status
)) {
628 ACPI_EXCEPTION((AE_INFO
, status
,
629 "While loading namespace from ACPI tables"));
632 return_ACPI_STATUS(status
);
635 ACPI_EXPORT_SYMBOL(acpi_load_tables
)
638 /*******************************************************************************
640 * FUNCTION: acpi_install_table_handler
642 * PARAMETERS: Handler - Table event handler
643 * Context - Value passed to the handler on each event
647 * DESCRIPTION: Install table event handler
649 ******************************************************************************/
651 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
)
655 ACPI_FUNCTION_TRACE(acpi_install_table_handler
);
658 return_ACPI_STATUS(AE_BAD_PARAMETER
);
661 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
662 if (ACPI_FAILURE(status
)) {
663 return_ACPI_STATUS(status
);
666 /* Don't allow more than one handler */
668 if (acpi_gbl_table_handler
) {
669 status
= AE_ALREADY_EXISTS
;
673 /* Install the handler */
675 acpi_gbl_table_handler
= handler
;
676 acpi_gbl_table_handler_context
= context
;
679 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
680 return_ACPI_STATUS(status
);
683 ACPI_EXPORT_SYMBOL(acpi_install_table_handler
)
685 /*******************************************************************************
687 * FUNCTION: acpi_remove_table_handler
689 * PARAMETERS: Handler - Table event handler that was installed
694 * DESCRIPTION: Remove table event handler
696 ******************************************************************************/
697 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
)
701 ACPI_FUNCTION_TRACE(acpi_remove_table_handler
);
703 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
704 if (ACPI_FAILURE(status
)) {
705 return_ACPI_STATUS(status
);
708 /* Make sure that the installed handler is the same */
710 if (!handler
|| handler
!= acpi_gbl_table_handler
) {
711 status
= AE_BAD_PARAMETER
;
715 /* Remove the handler */
717 acpi_gbl_table_handler
= NULL
;
720 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
721 return_ACPI_STATUS(status
);
724 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler
)
727 static int __init
acpi_no_auto_ssdt_setup(char *s
) {
729 printk(KERN_NOTICE
"ACPI: SSDT auto-load disabled\n");
736 __setup("acpi_no_auto_ssdt", acpi_no_auto_ssdt_setup
);