1 /******************************************************************************
3 * Module Name: tbxface - Public interfaces to the ACPI subsystem
4 * ACPI table oriented interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, 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 <linux/export.h>
46 #include <acpi/acpi.h>
51 #define _COMPONENT ACPI_TABLES
52 ACPI_MODULE_NAME("tbxface")
54 /* Local prototypes */
55 static acpi_status
acpi_tb_load_namespace(void);
57 static int no_auto_ssdt
;
59 /*******************************************************************************
61 * FUNCTION: acpi_allocate_root_table
63 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
64 * struct acpi_table_desc structures
68 * DESCRIPTION: Allocate a root table array. Used by i_aSL compiler and
69 * acpi_initialize_tables.
71 ******************************************************************************/
73 acpi_status
acpi_allocate_root_table(u32 initial_table_count
)
76 acpi_gbl_root_table_list
.max_table_count
= initial_table_count
;
77 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ALLOW_RESIZE
;
79 return (acpi_tb_resize_root_table_list());
82 /*******************************************************************************
84 * FUNCTION: acpi_initialize_tables
86 * PARAMETERS: initial_table_array - Pointer to an array of pre-allocated
87 * struct acpi_table_desc structures. If NULL, the
88 * array is dynamically allocated.
89 * initial_table_count - Size of initial_table_array, in number of
90 * struct acpi_table_desc structures
91 * allow_realloc - Flag to tell Table Manager if resize of
92 * pre-allocated array is allowed. Ignored
93 * if initial_table_array is NULL.
97 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
99 * NOTE: Allows static allocation of the initial table array in order
100 * to avoid the use of dynamic memory in confined environments
101 * such as the kernel boot sequence where it may not be available.
103 * If the host OS memory managers are initialized, use NULL for
104 * initial_table_array, and the table will be dynamically allocated.
106 ******************************************************************************/
109 acpi_initialize_tables(struct acpi_table_desc
* initial_table_array
,
110 u32 initial_table_count
, u8 allow_resize
)
112 acpi_physical_address rsdp_address
;
115 ACPI_FUNCTION_TRACE(acpi_initialize_tables
);
118 * Set up the Root Table Array
119 * Allocate the table array if requested
121 if (!initial_table_array
) {
122 status
= acpi_allocate_root_table(initial_table_count
);
123 if (ACPI_FAILURE(status
)) {
124 return_ACPI_STATUS(status
);
127 /* Root Table Array has been statically allocated by the host */
129 ACPI_MEMSET(initial_table_array
, 0,
130 (acpi_size
) initial_table_count
*
131 sizeof(struct acpi_table_desc
));
133 acpi_gbl_root_table_list
.tables
= initial_table_array
;
134 acpi_gbl_root_table_list
.max_table_count
= initial_table_count
;
135 acpi_gbl_root_table_list
.flags
= ACPI_ROOT_ORIGIN_UNKNOWN
;
137 acpi_gbl_root_table_list
.flags
|=
138 ACPI_ROOT_ALLOW_RESIZE
;
142 /* Get the address of the RSDP */
144 rsdp_address
= acpi_os_get_root_pointer();
146 return_ACPI_STATUS(AE_NOT_FOUND
);
150 * Get the root table (RSDT or XSDT) and extract all entries to the local
151 * Root Table Array. This array contains the information of the RSDT/XSDT
152 * in a common, more useable format.
154 status
= acpi_tb_parse_root_table(rsdp_address
);
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
;
176 acpi_size current_size
;
178 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table
);
181 * Only reallocate the root table if the host provided a static buffer
182 * for the table array in the call to acpi_initialize_tables.
184 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
185 return_ACPI_STATUS(AE_SUPPORT
);
189 * Get the current size of the root table and add the default
190 * increment to create the new table size.
192 current_size
= (acpi_size
)
193 acpi_gbl_root_table_list
.current_table_count
*
194 sizeof(struct acpi_table_desc
);
196 new_size
= current_size
+
197 (ACPI_ROOT_TABLE_SIZE_INCREMENT
* sizeof(struct acpi_table_desc
));
199 /* Create new array and copy the old array */
201 tables
= ACPI_ALLOCATE_ZEROED(new_size
);
203 return_ACPI_STATUS(AE_NO_MEMORY
);
206 ACPI_MEMCPY(tables
, acpi_gbl_root_table_list
.tables
, current_size
);
209 * Update the root table descriptor. The new size will be the current
210 * number of tables plus the increment, independent of the reserved
211 * size of the original table list.
213 acpi_gbl_root_table_list
.tables
= tables
;
214 acpi_gbl_root_table_list
.max_table_count
=
215 acpi_gbl_root_table_list
.current_table_count
+
216 ACPI_ROOT_TABLE_SIZE_INCREMENT
;
217 acpi_gbl_root_table_list
.flags
=
218 ACPI_ROOT_ORIGIN_ALLOCATED
| ACPI_ROOT_ALLOW_RESIZE
;
220 return_ACPI_STATUS(AE_OK
);
223 /*******************************************************************************
225 * FUNCTION: acpi_load_table
227 * PARAMETERS: table_ptr - pointer to a buffer containing the entire
232 * DESCRIPTION: This function is called to load a table from the caller's
233 * buffer. The buffer must contain an entire ACPI Table including
234 * a valid header. The header fields will be verified, and if it
235 * is determined that the table is invalid, the call will fail.
237 ******************************************************************************/
238 acpi_status
acpi_load_table(struct acpi_table_header
*table_ptr
)
242 struct acpi_table_desc table_desc
;
245 return AE_BAD_PARAMETER
;
247 ACPI_MEMSET(&table_desc
, 0, sizeof(struct acpi_table_desc
));
248 table_desc
.pointer
= table_ptr
;
249 table_desc
.length
= table_ptr
->length
;
250 table_desc
.flags
= ACPI_TABLE_ORIGIN_UNKNOWN
;
253 * Install the new table into the local data structures
255 status
= acpi_tb_add_table(&table_desc
, &table_index
);
256 if (ACPI_FAILURE(status
)) {
259 status
= acpi_ns_load_table(table_index
, acpi_gbl_root_node
);
263 ACPI_EXPORT_SYMBOL(acpi_load_table
)
265 /*******************************************************************************
267 * FUNCTION: acpi_get_table_header
269 * PARAMETERS: Signature - ACPI signature of needed table
270 * Instance - Which instance (for SSDTs)
271 * out_table_header - The pointer to the table header to fill
273 * RETURN: Status and pointer to mapped table header
275 * DESCRIPTION: Finds an ACPI table header.
277 * NOTE: Caller is responsible in unmapping the header with
278 * acpi_os_unmap_memory
280 ******************************************************************************/
282 acpi_get_table_header(char *signature
,
283 u32 instance
, struct acpi_table_header
*out_table_header
)
287 struct acpi_table_header
*header
;
289 /* Parameter validation */
291 if (!signature
|| !out_table_header
) {
292 return (AE_BAD_PARAMETER
);
295 /* Walk the root table list */
297 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.current_table_count
;
299 if (!ACPI_COMPARE_NAME
300 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
305 if (++j
< instance
) {
309 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
310 if ((acpi_gbl_root_table_list
.tables
[i
].flags
&
311 ACPI_TABLE_ORIGIN_MASK
) ==
312 ACPI_TABLE_ORIGIN_MAPPED
) {
314 acpi_os_map_memory(acpi_gbl_root_table_list
.
321 ACPI_MEMCPY(out_table_header
, header
,
322 sizeof(struct acpi_table_header
));
323 acpi_os_unmap_memory(header
,
330 ACPI_MEMCPY(out_table_header
,
331 acpi_gbl_root_table_list
.tables
[i
].pointer
,
332 sizeof(struct acpi_table_header
));
337 return (AE_NOT_FOUND
);
340 ACPI_EXPORT_SYMBOL(acpi_get_table_header
)
342 /*******************************************************************************
344 * FUNCTION: acpi_unload_table_id
346 * PARAMETERS: id - Owner ID of the table to be removed.
350 * DESCRIPTION: This routine is used to force the unload of a table (by id)
352 ******************************************************************************/
353 acpi_status
acpi_unload_table_id(acpi_owner_id id
)
356 acpi_status status
= AE_NOT_EXIST
;
358 ACPI_FUNCTION_TRACE(acpi_unload_table_id
);
360 /* Find table in the global table list */
361 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; ++i
) {
362 if (id
!= acpi_gbl_root_table_list
.tables
[i
].owner_id
) {
366 * Delete all namespace objects owned by this table. Note that these
367 * objects can appear anywhere in the namespace by virtue of the AML
368 * "Scope" operator. Thus, we need to track ownership by an ID, not
369 * simply a position within the hierarchy
371 acpi_tb_delete_namespace_by_owner(i
);
372 status
= acpi_tb_release_owner_id(i
);
373 acpi_tb_set_table_loaded_flag(i
, FALSE
);
376 return_ACPI_STATUS(status
);
379 ACPI_EXPORT_SYMBOL(acpi_unload_table_id
)
381 /*******************************************************************************
383 * FUNCTION: acpi_get_table_with_size
385 * PARAMETERS: Signature - ACPI signature of needed table
386 * Instance - Which instance (for SSDTs)
387 * out_table - Where the pointer to the table is returned
389 * RETURN: Status and pointer to table
391 * DESCRIPTION: Finds and verifies an ACPI table.
393 ******************************************************************************/
395 acpi_get_table_with_size(char *signature
,
396 u32 instance
, struct acpi_table_header
**out_table
,
403 /* Parameter validation */
405 if (!signature
|| !out_table
) {
406 return (AE_BAD_PARAMETER
);
409 /* Walk the root table list */
411 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.current_table_count
;
413 if (!ACPI_COMPARE_NAME
414 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
419 if (++j
< instance
) {
424 acpi_tb_verify_table(&acpi_gbl_root_table_list
.tables
[i
]);
425 if (ACPI_SUCCESS(status
)) {
426 *out_table
= acpi_gbl_root_table_list
.tables
[i
].pointer
;
427 *tbl_size
= acpi_gbl_root_table_list
.tables
[i
].length
;
430 if (!acpi_gbl_permanent_mmap
) {
431 acpi_gbl_root_table_list
.tables
[i
].pointer
= NULL
;
437 return (AE_NOT_FOUND
);
441 acpi_get_table(char *signature
,
442 u32 instance
, struct acpi_table_header
**out_table
)
446 return acpi_get_table_with_size(signature
,
447 instance
, out_table
, &tbl_size
);
449 ACPI_EXPORT_SYMBOL(acpi_get_table
)
451 /*******************************************************************************
453 * FUNCTION: acpi_get_table_by_index
455 * PARAMETERS: table_index - Table index
456 * Table - Where the pointer to the table is returned
458 * RETURN: Status and pointer to the table
460 * DESCRIPTION: Obtain a table by an index into the global table list.
462 ******************************************************************************/
464 acpi_get_table_by_index(u32 table_index
, struct acpi_table_header
**table
)
468 ACPI_FUNCTION_TRACE(acpi_get_table_by_index
);
470 /* Parameter validation */
473 return_ACPI_STATUS(AE_BAD_PARAMETER
);
476 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
480 if (table_index
>= acpi_gbl_root_table_list
.current_table_count
) {
481 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
482 return_ACPI_STATUS(AE_BAD_PARAMETER
);
485 if (!acpi_gbl_root_table_list
.tables
[table_index
].pointer
) {
487 /* Table is not mapped, map it */
490 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
491 tables
[table_index
]);
492 if (ACPI_FAILURE(status
)) {
493 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
494 return_ACPI_STATUS(status
);
498 *table
= acpi_gbl_root_table_list
.tables
[table_index
].pointer
;
499 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
500 return_ACPI_STATUS(AE_OK
);
503 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index
)
505 /*******************************************************************************
507 * FUNCTION: acpi_tb_load_namespace
513 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
516 ******************************************************************************/
517 static acpi_status
acpi_tb_load_namespace(void)
521 struct acpi_table_header
*new_dsdt
;
523 ACPI_FUNCTION_TRACE(tb_load_namespace
);
525 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
528 * Load the namespace. The DSDT is required, but any SSDT and
529 * PSDT tables are optional. Verify the DSDT.
531 if (!acpi_gbl_root_table_list
.current_table_count
||
533 (acpi_gbl_root_table_list
.
534 tables
[ACPI_TABLE_INDEX_DSDT
].signature
),
537 ACPI_FAILURE(acpi_tb_verify_table
538 (&acpi_gbl_root_table_list
.
539 tables
[ACPI_TABLE_INDEX_DSDT
]))) {
540 status
= AE_NO_ACPI_TABLES
;
541 goto unlock_and_exit
;
545 * Save the DSDT pointer for simple access. This is the mapped memory
546 * address. We must take care here because the address of the .Tables
547 * array can change dynamically as tables are loaded at run-time. Note:
548 * .Pointer field is not validated until after call to acpi_tb_verify_table.
551 acpi_gbl_root_table_list
.tables
[ACPI_TABLE_INDEX_DSDT
].pointer
;
554 * Optionally copy the entire DSDT to local memory (instead of simply
555 * mapping it.) There are some BIOSs that corrupt or replace the original
556 * DSDT, creating the need for this option. Default is FALSE, do not copy
559 if (acpi_gbl_copy_dsdt_locally
) {
560 new_dsdt
= acpi_tb_copy_dsdt(ACPI_TABLE_INDEX_DSDT
);
562 acpi_gbl_DSDT
= new_dsdt
;
567 * Save the original DSDT header for detection of table corruption
568 * and/or replacement of the DSDT from outside the OS.
570 ACPI_MEMCPY(&acpi_gbl_original_dsdt_header
, acpi_gbl_DSDT
,
571 sizeof(struct acpi_table_header
));
573 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
575 /* Load and parse tables */
577 status
= acpi_ns_load_table(ACPI_TABLE_INDEX_DSDT
, acpi_gbl_root_node
);
578 if (ACPI_FAILURE(status
)) {
579 return_ACPI_STATUS(status
);
582 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
584 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
585 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; ++i
) {
586 if ((!ACPI_COMPARE_NAME
587 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
591 (acpi_gbl_root_table_list
.tables
[i
].
592 signature
), ACPI_SIG_PSDT
))
594 ACPI_FAILURE(acpi_tb_verify_table
595 (&acpi_gbl_root_table_list
.tables
[i
]))) {
600 printk(KERN_WARNING
"ACPI: SSDT ignored due to \"acpi_no_auto_ssdt\"\n");
604 /* Ignore errors while loading tables, get as many as possible */
606 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
607 (void)acpi_ns_load_table(i
, acpi_gbl_root_node
);
608 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
611 ACPI_DEBUG_PRINT((ACPI_DB_INIT
, "ACPI Tables successfully acquired\n"));
614 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
615 return_ACPI_STATUS(status
);
618 /*******************************************************************************
620 * FUNCTION: acpi_load_tables
626 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
628 ******************************************************************************/
630 acpi_status
acpi_load_tables(void)
634 ACPI_FUNCTION_TRACE(acpi_load_tables
);
636 /* Load the namespace from the tables */
638 status
= acpi_tb_load_namespace();
639 if (ACPI_FAILURE(status
)) {
640 ACPI_EXCEPTION((AE_INFO
, status
,
641 "While loading namespace from ACPI tables"));
644 return_ACPI_STATUS(status
);
647 ACPI_EXPORT_SYMBOL(acpi_load_tables
)
650 /*******************************************************************************
652 * FUNCTION: acpi_install_table_handler
654 * PARAMETERS: Handler - Table event handler
655 * Context - Value passed to the handler on each event
659 * DESCRIPTION: Install table event handler
661 ******************************************************************************/
663 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
)
667 ACPI_FUNCTION_TRACE(acpi_install_table_handler
);
670 return_ACPI_STATUS(AE_BAD_PARAMETER
);
673 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
674 if (ACPI_FAILURE(status
)) {
675 return_ACPI_STATUS(status
);
678 /* Don't allow more than one handler */
680 if (acpi_gbl_table_handler
) {
681 status
= AE_ALREADY_EXISTS
;
685 /* Install the handler */
687 acpi_gbl_table_handler
= handler
;
688 acpi_gbl_table_handler_context
= context
;
691 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
692 return_ACPI_STATUS(status
);
695 ACPI_EXPORT_SYMBOL(acpi_install_table_handler
)
697 /*******************************************************************************
699 * FUNCTION: acpi_remove_table_handler
701 * PARAMETERS: Handler - Table event handler that was installed
706 * DESCRIPTION: Remove table event handler
708 ******************************************************************************/
709 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
)
713 ACPI_FUNCTION_TRACE(acpi_remove_table_handler
);
715 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
716 if (ACPI_FAILURE(status
)) {
717 return_ACPI_STATUS(status
);
720 /* Make sure that the installed handler is the same */
722 if (!handler
|| handler
!= acpi_gbl_table_handler
) {
723 status
= AE_BAD_PARAMETER
;
727 /* Remove the handler */
729 acpi_gbl_table_handler
= NULL
;
732 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
733 return_ACPI_STATUS(status
);
736 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler
)
739 static int __init
acpi_no_auto_ssdt_setup(char *s
) {
741 printk(KERN_NOTICE
"ACPI: SSDT auto-load disabled\n");
748 __setup("acpi_no_auto_ssdt", acpi_no_auto_ssdt_setup
);