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>
50 #define _COMPONENT ACPI_TABLES
51 ACPI_MODULE_NAME("tbxface")
53 /* Local prototypes */
54 static acpi_status
acpi_tb_load_namespace(void);
56 static int no_auto_ssdt
;
58 /*******************************************************************************
60 * FUNCTION: acpi_allocate_root_table
62 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
63 * struct acpi_table_desc structures
67 * DESCRIPTION: Allocate a root table array. Used by i_aSL compiler and
68 * acpi_initialize_tables.
70 ******************************************************************************/
72 acpi_status
acpi_allocate_root_table(u32 initial_table_count
)
75 acpi_gbl_root_table_list
.size
= initial_table_count
;
76 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ALLOW_RESIZE
;
78 return (acpi_tb_resize_root_table_list());
81 /*******************************************************************************
83 * FUNCTION: acpi_initialize_tables
85 * PARAMETERS: initial_table_array - Pointer to an array of pre-allocated
86 * struct acpi_table_desc structures. If NULL, the
87 * array is dynamically allocated.
88 * initial_table_count - Size of initial_table_array, in number of
89 * struct acpi_table_desc structures
90 * allow_realloc - Flag to tell Table Manager if resize of
91 * pre-allocated array is allowed. Ignored
92 * if initial_table_array is NULL.
96 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
98 * NOTE: Allows static allocation of the initial table array in order
99 * to avoid the use of dynamic memory in confined environments
100 * such as the kernel boot sequence where it may not be available.
102 * If the host OS memory managers are initialized, use NULL for
103 * initial_table_array, and the table will be dynamically allocated.
105 ******************************************************************************/
108 acpi_initialize_tables(struct acpi_table_desc
* initial_table_array
,
109 u32 initial_table_count
, u8 allow_resize
)
111 acpi_physical_address rsdp_address
;
114 ACPI_FUNCTION_TRACE(acpi_initialize_tables
);
117 * Set up the Root Table Array
118 * Allocate the table array if requested
120 if (!initial_table_array
) {
121 status
= acpi_allocate_root_table(initial_table_count
);
122 if (ACPI_FAILURE(status
)) {
123 return_ACPI_STATUS(status
);
126 /* Root Table Array has been statically allocated by the host */
128 ACPI_MEMSET(initial_table_array
, 0,
129 (acpi_size
) initial_table_count
*
130 sizeof(struct acpi_table_desc
));
132 acpi_gbl_root_table_list
.tables
= initial_table_array
;
133 acpi_gbl_root_table_list
.size
= initial_table_count
;
134 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ORIGIN_UNKNOWN
;
136 acpi_gbl_root_table_list
.flags
|=
137 ACPI_ROOT_ALLOW_RESIZE
;
141 /* Get the address of the RSDP */
143 rsdp_address
= acpi_os_get_root_pointer();
145 return_ACPI_STATUS(AE_NOT_FOUND
);
149 * Get the root table (RSDT or XSDT) and extract all entries to the local
150 * Root Table Array. This array contains the information of the RSDT/XSDT
151 * in a common, more useable format.
154 acpi_tb_parse_root_table(rsdp_address
, ACPI_TABLE_ORIGIN_MAPPED
);
155 return_ACPI_STATUS(status
);
158 /*******************************************************************************
160 * FUNCTION: acpi_reallocate_root_table
166 * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the
167 * root list from the previously provided scratch area. Should
168 * be called once dynamic memory allocation is available in the
171 ******************************************************************************/
172 acpi_status
acpi_reallocate_root_table(void)
174 struct acpi_table_desc
*tables
;
177 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table
);
180 * Only reallocate the root table if the host provided a static buffer
181 * for the table array in the call to acpi_initialize_tables.
183 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
184 return_ACPI_STATUS(AE_SUPPORT
);
187 new_size
= ((acpi_size
) acpi_gbl_root_table_list
.count
+
188 ACPI_ROOT_TABLE_SIZE_INCREMENT
) *
189 sizeof(struct acpi_table_desc
);
191 /* Create new array and copy the old array */
193 tables
= ACPI_ALLOCATE_ZEROED(new_size
);
195 return_ACPI_STATUS(AE_NO_MEMORY
);
198 ACPI_MEMCPY(tables
, acpi_gbl_root_table_list
.tables
, new_size
);
200 acpi_gbl_root_table_list
.size
= acpi_gbl_root_table_list
.count
;
201 acpi_gbl_root_table_list
.tables
= tables
;
202 acpi_gbl_root_table_list
.flags
=
203 ACPI_ROOT_ORIGIN_ALLOCATED
| ACPI_ROOT_ALLOW_RESIZE
;
205 return_ACPI_STATUS(AE_OK
);
208 /*******************************************************************************
210 * FUNCTION: acpi_load_table
212 * PARAMETERS: table_ptr - pointer to a buffer containing the entire
217 * DESCRIPTION: This function is called to load a table from the caller's
218 * buffer. The buffer must contain an entire ACPI Table including
219 * a valid header. The header fields will be verified, and if it
220 * is determined that the table is invalid, the call will fail.
222 ******************************************************************************/
223 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
)
227 struct acpi_table_desc table_desc
;
230 return AE_BAD_PARAMETER
;
232 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
233 table_desc
.pointer
= table_ptr
;
234 table_desc
.length
= table_ptr
->length
;
235 table_desc
.flags
= ACPI_TABLE_ORIGIN_UNKNOWN
;
238 * Install the new table into the local data structures
240 status
= acpi_tb_add_table(&table_desc
, &table_index
);
241 if (ACPI_FAILURE(status
)) {
244 status
= acpi_ns_load_table(table_index
, acpi_gbl_root_node
);
248 ACPI_EXPORT_SYMBOL(acpi_load_table
)
250 /******************************************************************************
252 * FUNCTION: acpi_get_table_header
254 * PARAMETERS: Signature - ACPI signature of needed table
255 * Instance - Which instance (for SSDTs)
256 * out_table_header - The pointer to the table header to fill
258 * RETURN: Status and pointer to mapped table header
260 * DESCRIPTION: Finds an ACPI table header.
262 * NOTE: Caller is responsible in unmapping the header with
263 * acpi_os_unmap_memory
265 *****************************************************************************/
267 acpi_get_table_header(char *signature
,
268 u32 instance
, 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_with_size
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_with_size(char *signature
,
381 u32 instance
, struct acpi_table_header
**out_table
,
388 /* Parameter validation */
390 if (!signature
|| !out_table
) {
391 return (AE_BAD_PARAMETER
);
395 * Walk the root table list
397 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.count
; i
++) {
398 if (!ACPI_COMPARE_NAME
399 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
404 if (++j
< instance
) {
409 acpi_tb_verify_table(&acpi_gbl_root_table_list
.tables
[i
]);
410 if (ACPI_SUCCESS(status
)) {
411 *out_table
= acpi_gbl_root_table_list
.tables
[i
].pointer
;
412 *tbl_size
= acpi_gbl_root_table_list
.tables
[i
].length
;
415 if (!acpi_gbl_permanent_mmap
) {
416 acpi_gbl_root_table_list
.tables
[i
].pointer
= NULL
;
422 return (AE_NOT_FOUND
);
426 acpi_get_table(char *signature
,
427 u32 instance
, struct acpi_table_header
**out_table
)
431 return acpi_get_table_with_size(signature
,
432 instance
, out_table
, &tbl_size
);
434 ACPI_EXPORT_SYMBOL(acpi_get_table
)
436 /*******************************************************************************
438 * FUNCTION: acpi_get_table_by_index
440 * PARAMETERS: table_index - Table index
441 * Table - Where the pointer to the table is returned
443 * RETURN: Status and pointer to the table
445 * DESCRIPTION: Obtain a table by an index into the global table list.
447 ******************************************************************************/
449 acpi_get_table_by_index(u32 table_index
, struct acpi_table_header
**table
)
453 ACPI_FUNCTION_TRACE(acpi_get_table_by_index
);
455 /* Parameter validation */
458 return_ACPI_STATUS(AE_BAD_PARAMETER
);
461 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
465 if (table_index
>= acpi_gbl_root_table_list
.count
) {
466 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
467 return_ACPI_STATUS(AE_BAD_PARAMETER
);
470 if (!acpi_gbl_root_table_list
.tables
[table_index
].pointer
) {
472 /* Table is not mapped, map it */
475 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
476 tables
[table_index
]);
477 if (ACPI_FAILURE(status
)) {
478 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
479 return_ACPI_STATUS(status
);
483 *table
= acpi_gbl_root_table_list
.tables
[table_index
].pointer
;
484 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
485 return_ACPI_STATUS(AE_OK
);
488 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index
)
490 /*******************************************************************************
492 * FUNCTION: acpi_tb_load_namespace
498 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
501 ******************************************************************************/
502 static acpi_status
acpi_tb_load_namespace(void)
505 struct acpi_table_header
*table
;
508 ACPI_FUNCTION_TRACE(tb_load_namespace
);
510 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
513 * Load the namespace. The DSDT is required, but any SSDT and PSDT tables
516 if (!acpi_gbl_root_table_list
.count
||
518 (acpi_gbl_root_table_list
.
519 tables
[ACPI_TABLE_INDEX_DSDT
].signature
),
522 ACPI_FAILURE(acpi_tb_verify_table
523 (&acpi_gbl_root_table_list
.
524 tables
[ACPI_TABLE_INDEX_DSDT
]))) {
525 status
= AE_NO_ACPI_TABLES
;
526 goto unlock_and_exit
;
533 acpi_os_table_override(acpi_gbl_root_table_list
.
534 tables
[ACPI_TABLE_INDEX_DSDT
].pointer
,
536 if (ACPI_SUCCESS(status
) && table
) {
538 * DSDT table has been found
540 acpi_tb_delete_table(&acpi_gbl_root_table_list
.
541 tables
[ACPI_TABLE_INDEX_DSDT
]);
542 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].pointer
=
544 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].length
=
546 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].flags
=
547 ACPI_TABLE_ORIGIN_UNKNOWN
;
549 ACPI_INFO((AE_INFO
, "Table DSDT replaced by host OS"));
550 acpi_tb_print_table_header(0, table
);
552 if (no_auto_ssdt
== 0) {
553 printk(KERN_WARNING
"ACPI: DSDT override uses original SSDTs unless \"acpi_no_auto_ssdt\"\n");
558 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
559 tables
[ACPI_TABLE_INDEX_DSDT
]);
560 if (ACPI_FAILURE(status
)) {
562 /* A valid DSDT is required */
564 status
= AE_NO_ACPI_TABLES
;
565 goto unlock_and_exit
;
568 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
571 * Load and parse tables.
573 status
= acpi_ns_load_table(ACPI_TABLE_INDEX_DSDT
, acpi_gbl_root_node
);
574 if (ACPI_FAILURE(status
)) {
575 return_ACPI_STATUS(status
);
579 * Load any SSDT or PSDT tables. Note: Loop leaves tables locked
581 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
582 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
583 if ((!ACPI_COMPARE_NAME
584 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
588 (acpi_gbl_root_table_list
.tables
[i
].
589 signature
), ACPI_SIG_PSDT
))
591 ACPI_FAILURE(acpi_tb_verify_table
592 (&acpi_gbl_root_table_list
.tables
[i
]))) {
597 printk(KERN_WARNING
"ACPI: SSDT ignored due to \"acpi_no_auto_ssdt\"\n");
601 /* Ignore errors while loading tables, get as many as possible */
603 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
604 (void)acpi_ns_load_table(i
, acpi_gbl_root_node
);
605 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
608 ACPI_DEBUG_PRINT((ACPI_DB_INIT
, "ACPI Tables successfully acquired\n"));
611 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
612 return_ACPI_STATUS(status
);
615 /*******************************************************************************
617 * FUNCTION: acpi_load_tables
623 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
625 ******************************************************************************/
627 acpi_status
acpi_load_tables(void)
631 ACPI_FUNCTION_TRACE(acpi_load_tables
);
634 * Load the namespace from the tables
636 status
= acpi_tb_load_namespace();
637 if (ACPI_FAILURE(status
)) {
638 ACPI_EXCEPTION((AE_INFO
, status
,
639 "While loading namespace from ACPI tables"));
642 return_ACPI_STATUS(status
);
645 ACPI_EXPORT_SYMBOL(acpi_load_tables
)
648 /*******************************************************************************
650 * FUNCTION: acpi_install_table_handler
652 * PARAMETERS: Handler - Table event handler
653 * Context - Value passed to the handler on each event
657 * DESCRIPTION: Install table event handler
659 ******************************************************************************/
661 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
)
665 ACPI_FUNCTION_TRACE(acpi_install_table_handler
);
668 return_ACPI_STATUS(AE_BAD_PARAMETER
);
671 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
672 if (ACPI_FAILURE(status
)) {
673 return_ACPI_STATUS(status
);
676 /* Don't allow more than one handler */
678 if (acpi_gbl_table_handler
) {
679 status
= AE_ALREADY_EXISTS
;
683 /* Install the handler */
685 acpi_gbl_table_handler
= handler
;
686 acpi_gbl_table_handler_context
= context
;
689 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
690 return_ACPI_STATUS(status
);
693 ACPI_EXPORT_SYMBOL(acpi_install_table_handler
)
695 /*******************************************************************************
697 * FUNCTION: acpi_remove_table_handler
699 * PARAMETERS: Handler - Table event handler that was installed
704 * DESCRIPTION: Remove table event handler
706 ******************************************************************************/
707 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
)
711 ACPI_FUNCTION_TRACE(acpi_remove_table_handler
);
713 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
714 if (ACPI_FAILURE(status
)) {
715 return_ACPI_STATUS(status
);
718 /* Make sure that the installed handler is the same */
720 if (!handler
|| handler
!= acpi_gbl_table_handler
) {
721 status
= AE_BAD_PARAMETER
;
725 /* Remove the handler */
727 acpi_gbl_table_handler
= NULL
;
730 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
731 return_ACPI_STATUS(status
);
734 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler
)
737 static int __init
acpi_no_auto_ssdt_setup(char *s
) {
739 printk(KERN_NOTICE
"ACPI: SSDT auto-load disabled\n");
746 __setup("acpi_no_auto_ssdt", acpi_no_auto_ssdt_setup
);