1 /******************************************************************************
3 * Module Name: tbxface - Public interfaces to the ACPI subsystem
4 * ACPI table oriented interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2010, 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.
153 status
= acpi_tb_parse_root_table(rsdp_address
);
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
);
186 new_size
= ((acpi_size
) acpi_gbl_root_table_list
.count
+
187 ACPI_ROOT_TABLE_SIZE_INCREMENT
) *
188 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
)
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 u32 instance
, struct acpi_table_header
*out_table_header
)
271 struct acpi_table_header
*header
;
273 /* Parameter validation */
275 if (!signature
|| !out_table_header
) {
276 return (AE_BAD_PARAMETER
);
279 /* Walk the root table list */
281 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.count
; i
++) {
282 if (!ACPI_COMPARE_NAME
283 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
288 if (++j
< instance
) {
292 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
293 if ((acpi_gbl_root_table_list
.tables
[i
].flags
&
294 ACPI_TABLE_ORIGIN_MASK
) ==
295 ACPI_TABLE_ORIGIN_MAPPED
) {
297 acpi_os_map_memory(acpi_gbl_root_table_list
.
304 ACPI_MEMCPY(out_table_header
, header
,
305 sizeof(struct acpi_table_header
));
306 acpi_os_unmap_memory(header
,
313 ACPI_MEMCPY(out_table_header
,
314 acpi_gbl_root_table_list
.tables
[i
].pointer
,
315 sizeof(struct acpi_table_header
));
320 return (AE_NOT_FOUND
);
323 ACPI_EXPORT_SYMBOL(acpi_get_table_header
)
325 /*******************************************************************************
327 * FUNCTION: acpi_unload_table_id
329 * PARAMETERS: id - Owner ID of the table to be removed.
333 * DESCRIPTION: This routine is used to force the unload of a table (by id)
335 ******************************************************************************/
336 acpi_status
acpi_unload_table_id(acpi_owner_id id
)
339 acpi_status status
= AE_NOT_EXIST
;
341 ACPI_FUNCTION_TRACE(acpi_unload_table_id
);
343 /* Find table in the global table list */
344 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
345 if (id
!= acpi_gbl_root_table_list
.tables
[i
].owner_id
) {
349 * Delete all namespace objects owned by this table. Note that these
350 * objects can appear anywhere in the namespace by virtue of the AML
351 * "Scope" operator. Thus, we need to track ownership by an ID, not
352 * simply a position within the hierarchy
354 acpi_tb_delete_namespace_by_owner(i
);
355 status
= acpi_tb_release_owner_id(i
);
356 acpi_tb_set_table_loaded_flag(i
, FALSE
);
359 return_ACPI_STATUS(status
);
362 ACPI_EXPORT_SYMBOL(acpi_unload_table_id
)
364 /*******************************************************************************
366 * FUNCTION: acpi_get_table_with_size
368 * PARAMETERS: Signature - ACPI signature of needed table
369 * Instance - Which instance (for SSDTs)
370 * out_table - Where the pointer to the table is returned
372 * RETURN: Status and pointer to table
374 * DESCRIPTION: Finds and verifies an ACPI table.
376 ******************************************************************************/
378 acpi_get_table_with_size(char *signature
,
379 u32 instance
, struct acpi_table_header
**out_table
,
386 /* Parameter validation */
388 if (!signature
|| !out_table
) {
389 return (AE_BAD_PARAMETER
);
392 /* Walk the root table list */
394 for (i
= 0, j
= 0; i
< acpi_gbl_root_table_list
.count
; i
++) {
395 if (!ACPI_COMPARE_NAME
396 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
401 if (++j
< instance
) {
406 acpi_tb_verify_table(&acpi_gbl_root_table_list
.tables
[i
]);
407 if (ACPI_SUCCESS(status
)) {
408 *out_table
= acpi_gbl_root_table_list
.tables
[i
].pointer
;
409 *tbl_size
= acpi_gbl_root_table_list
.tables
[i
].length
;
412 if (!acpi_gbl_permanent_mmap
) {
413 acpi_gbl_root_table_list
.tables
[i
].pointer
= NULL
;
419 return (AE_NOT_FOUND
);
423 acpi_get_table(char *signature
,
424 u32 instance
, struct acpi_table_header
**out_table
)
428 return acpi_get_table_with_size(signature
,
429 instance
, out_table
, &tbl_size
);
431 ACPI_EXPORT_SYMBOL(acpi_get_table
)
433 /*******************************************************************************
435 * FUNCTION: acpi_get_table_by_index
437 * PARAMETERS: table_index - Table index
438 * Table - Where the pointer to the table is returned
440 * RETURN: Status and pointer to the table
442 * DESCRIPTION: Obtain a table by an index into the global table list.
444 ******************************************************************************/
446 acpi_get_table_by_index(u32 table_index
, struct acpi_table_header
**table
)
450 ACPI_FUNCTION_TRACE(acpi_get_table_by_index
);
452 /* Parameter validation */
455 return_ACPI_STATUS(AE_BAD_PARAMETER
);
458 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
462 if (table_index
>= acpi_gbl_root_table_list
.count
) {
463 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
464 return_ACPI_STATUS(AE_BAD_PARAMETER
);
467 if (!acpi_gbl_root_table_list
.tables
[table_index
].pointer
) {
469 /* Table is not mapped, map it */
472 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
473 tables
[table_index
]);
474 if (ACPI_FAILURE(status
)) {
475 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
476 return_ACPI_STATUS(status
);
480 *table
= acpi_gbl_root_table_list
.tables
[table_index
].pointer
;
481 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
482 return_ACPI_STATUS(AE_OK
);
485 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index
)
487 /*******************************************************************************
489 * FUNCTION: acpi_tb_load_namespace
495 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
498 ******************************************************************************/
499 static acpi_status
acpi_tb_load_namespace(void)
504 ACPI_FUNCTION_TRACE(tb_load_namespace
);
506 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
509 * Load the namespace. The DSDT is required, but any SSDT and PSDT tables
512 if (!acpi_gbl_root_table_list
.count
||
514 (acpi_gbl_root_table_list
.
515 tables
[ACPI_TABLE_INDEX_DSDT
].signature
),
518 ACPI_FAILURE(acpi_tb_verify_table
519 (&acpi_gbl_root_table_list
.
520 tables
[ACPI_TABLE_INDEX_DSDT
]))) {
521 status
= AE_NO_ACPI_TABLES
;
522 goto unlock_and_exit
;
525 /* A valid DSDT is required */
528 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
529 tables
[ACPI_TABLE_INDEX_DSDT
]);
530 if (ACPI_FAILURE(status
)) {
532 status
= AE_NO_ACPI_TABLES
;
533 goto unlock_and_exit
;
536 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
538 /* Load and parse tables */
540 status
= acpi_ns_load_table(ACPI_TABLE_INDEX_DSDT
, acpi_gbl_root_node
);
541 if (ACPI_FAILURE(status
)) {
542 return_ACPI_STATUS(status
);
545 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
547 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
548 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
549 if ((!ACPI_COMPARE_NAME
550 (&(acpi_gbl_root_table_list
.tables
[i
].signature
),
554 (acpi_gbl_root_table_list
.tables
[i
].
555 signature
), ACPI_SIG_PSDT
))
557 ACPI_FAILURE(acpi_tb_verify_table
558 (&acpi_gbl_root_table_list
.tables
[i
]))) {
563 printk(KERN_WARNING
"ACPI: SSDT ignored due to \"acpi_no_auto_ssdt\"\n");
567 /* Ignore errors while loading tables, get as many as possible */
569 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
570 (void)acpi_ns_load_table(i
, acpi_gbl_root_node
);
571 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
574 ACPI_DEBUG_PRINT((ACPI_DB_INIT
, "ACPI Tables successfully acquired\n"));
577 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
578 return_ACPI_STATUS(status
);
581 /*******************************************************************************
583 * FUNCTION: acpi_load_tables
589 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
591 ******************************************************************************/
593 acpi_status
acpi_load_tables(void)
597 ACPI_FUNCTION_TRACE(acpi_load_tables
);
599 /* Load the namespace from the tables */
601 status
= acpi_tb_load_namespace();
602 if (ACPI_FAILURE(status
)) {
603 ACPI_EXCEPTION((AE_INFO
, status
,
604 "While loading namespace from ACPI tables"));
607 return_ACPI_STATUS(status
);
610 ACPI_EXPORT_SYMBOL(acpi_load_tables
)
613 /*******************************************************************************
615 * FUNCTION: acpi_install_table_handler
617 * PARAMETERS: Handler - Table event handler
618 * Context - Value passed to the handler on each event
622 * DESCRIPTION: Install table event handler
624 ******************************************************************************/
626 acpi_install_table_handler(acpi_tbl_handler handler
, void *context
)
630 ACPI_FUNCTION_TRACE(acpi_install_table_handler
);
633 return_ACPI_STATUS(AE_BAD_PARAMETER
);
636 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
637 if (ACPI_FAILURE(status
)) {
638 return_ACPI_STATUS(status
);
641 /* Don't allow more than one handler */
643 if (acpi_gbl_table_handler
) {
644 status
= AE_ALREADY_EXISTS
;
648 /* Install the handler */
650 acpi_gbl_table_handler
= handler
;
651 acpi_gbl_table_handler_context
= context
;
654 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
655 return_ACPI_STATUS(status
);
658 ACPI_EXPORT_SYMBOL(acpi_install_table_handler
)
660 /*******************************************************************************
662 * FUNCTION: acpi_remove_table_handler
664 * PARAMETERS: Handler - Table event handler that was installed
669 * DESCRIPTION: Remove table event handler
671 ******************************************************************************/
672 acpi_status
acpi_remove_table_handler(acpi_tbl_handler handler
)
676 ACPI_FUNCTION_TRACE(acpi_remove_table_handler
);
678 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
679 if (ACPI_FAILURE(status
)) {
680 return_ACPI_STATUS(status
);
683 /* Make sure that the installed handler is the same */
685 if (!handler
|| handler
!= acpi_gbl_table_handler
) {
686 status
= AE_BAD_PARAMETER
;
690 /* Remove the handler */
692 acpi_gbl_table_handler
= NULL
;
695 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
696 return_ACPI_STATUS(status
);
699 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler
)
702 static int __init
acpi_no_auto_ssdt_setup(char *s
) {
704 printk(KERN_NOTICE
"ACPI: SSDT auto-load disabled\n");
711 __setup("acpi_no_auto_ssdt", acpi_no_auto_ssdt_setup
);