ACPICA: Update comments in module header
[deliverable/linux.git] / drivers / acpi / acpica / tbxface.c
1 /******************************************************************************
2 *
3 * Module Name: tbxface - Public interfaces to the ACPI subsystem
4 * ACPI table oriented interfaces
5 *
6 *****************************************************************************/
7
8 /*
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
26 *
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.
30 *
31 * NO WARRANTY
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.
43 */
44
45 #include <acpi/acpi.h>
46 #include "accommon.h"
47 #include "acnamesp.h"
48 #include "actables.h"
49
50 #define _COMPONENT ACPI_TABLES
51 ACPI_MODULE_NAME("tbxface")
52
53 /* Local prototypes */
54 static acpi_status acpi_tb_load_namespace(void);
55
56 static int no_auto_ssdt;
57
58 /*******************************************************************************
59 *
60 * FUNCTION: acpi_allocate_root_table
61 *
62 * PARAMETERS: initial_table_count - Size of initial_table_array, in number of
63 * struct acpi_table_desc structures
64 *
65 * RETURN: Status
66 *
67 * DESCRIPTION: Allocate a root table array. Used by i_aSL compiler and
68 * acpi_initialize_tables.
69 *
70 ******************************************************************************/
71
72 acpi_status acpi_allocate_root_table(u32 initial_table_count)
73 {
74
75 acpi_gbl_root_table_list.size = initial_table_count;
76 acpi_gbl_root_table_list.flags = ACPI_ROOT_ALLOW_RESIZE;
77
78 return (acpi_tb_resize_root_table_list());
79 }
80
81 /*******************************************************************************
82 *
83 * FUNCTION: acpi_initialize_tables
84 *
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.
93 *
94 * RETURN: Status
95 *
96 * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT.
97 *
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.
101 *
102 * If the host OS memory managers are initialized, use NULL for
103 * initial_table_array, and the table will be dynamically allocated.
104 *
105 ******************************************************************************/
106
107 acpi_status __init
108 acpi_initialize_tables(struct acpi_table_desc * initial_table_array,
109 u32 initial_table_count, u8 allow_resize)
110 {
111 acpi_physical_address rsdp_address;
112 acpi_status status;
113
114 ACPI_FUNCTION_TRACE(acpi_initialize_tables);
115
116 /*
117 * Set up the Root Table Array
118 * Allocate the table array if requested
119 */
120 if (!initial_table_array) {
121 status = acpi_allocate_root_table(initial_table_count);
122 if (ACPI_FAILURE(status)) {
123 return_ACPI_STATUS(status);
124 }
125 } else {
126 /* Root Table Array has been statically allocated by the host */
127
128 ACPI_MEMSET(initial_table_array, 0,
129 (acpi_size) initial_table_count *
130 sizeof(struct acpi_table_desc));
131
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;
135 if (allow_resize) {
136 acpi_gbl_root_table_list.flags |=
137 ACPI_ROOT_ALLOW_RESIZE;
138 }
139 }
140
141 /* Get the address of the RSDP */
142
143 rsdp_address = acpi_os_get_root_pointer();
144 if (!rsdp_address) {
145 return_ACPI_STATUS(AE_NOT_FOUND);
146 }
147
148 /*
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.
152 */
153 status = acpi_tb_parse_root_table(rsdp_address);
154 return_ACPI_STATUS(status);
155 }
156
157 /*******************************************************************************
158 *
159 * FUNCTION: acpi_reallocate_root_table
160 *
161 * PARAMETERS: None
162 *
163 * RETURN: Status
164 *
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
168 * kernel
169 *
170 ******************************************************************************/
171 acpi_status acpi_reallocate_root_table(void)
172 {
173 struct acpi_table_desc *tables;
174 acpi_size new_size;
175
176 ACPI_FUNCTION_TRACE(acpi_reallocate_root_table);
177
178 /*
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.
181 */
182 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
183 return_ACPI_STATUS(AE_SUPPORT);
184 }
185
186 new_size = ((acpi_size) acpi_gbl_root_table_list.count +
187 ACPI_ROOT_TABLE_SIZE_INCREMENT) *
188 sizeof(struct acpi_table_desc);
189
190 /* Create new array and copy the old array */
191
192 tables = ACPI_ALLOCATE_ZEROED(new_size);
193 if (!tables) {
194 return_ACPI_STATUS(AE_NO_MEMORY);
195 }
196
197 ACPI_MEMCPY(tables, acpi_gbl_root_table_list.tables, new_size);
198
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;
203
204 return_ACPI_STATUS(AE_OK);
205 }
206
207 /*******************************************************************************
208 *
209 * FUNCTION: acpi_load_table
210 *
211 * PARAMETERS: table_ptr - pointer to a buffer containing the entire
212 * table to be loaded
213 *
214 * RETURN: Status
215 *
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.
220 *
221 ******************************************************************************/
222 acpi_status acpi_load_table(struct acpi_table_header *table_ptr)
223 {
224 acpi_status status;
225 u32 table_index;
226 struct acpi_table_desc table_desc;
227
228 if (!table_ptr)
229 return AE_BAD_PARAMETER;
230
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;
235
236 /*
237 * Install the new table into the local data structures
238 */
239 status = acpi_tb_add_table(&table_desc, &table_index);
240 if (ACPI_FAILURE(status)) {
241 return status;
242 }
243 status = acpi_ns_load_table(table_index, acpi_gbl_root_node);
244 return status;
245 }
246
247 ACPI_EXPORT_SYMBOL(acpi_load_table)
248
249 /******************************************************************************
250 *
251 * FUNCTION: acpi_get_table_header
252 *
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
256 *
257 * RETURN: Status and pointer to mapped table header
258 *
259 * DESCRIPTION: Finds an ACPI table header.
260 *
261 * NOTE: Caller is responsible in unmapping the header with
262 * acpi_os_unmap_memory
263 *
264 *****************************************************************************/
265 acpi_status
266 acpi_get_table_header(char *signature,
267 u32 instance, struct acpi_table_header *out_table_header)
268 {
269 u32 i;
270 u32 j;
271 struct acpi_table_header *header;
272
273 /* Parameter validation */
274
275 if (!signature || !out_table_header) {
276 return (AE_BAD_PARAMETER);
277 }
278
279 /*
280 * Walk the root table list
281 */
282 for (i = 0, j = 0; i < acpi_gbl_root_table_list.count; i++) {
283 if (!ACPI_COMPARE_NAME
284 (&(acpi_gbl_root_table_list.tables[i].signature),
285 signature)) {
286 continue;
287 }
288
289 if (++j < instance) {
290 continue;
291 }
292
293 if (!acpi_gbl_root_table_list.tables[i].pointer) {
294 if ((acpi_gbl_root_table_list.tables[i].
295 flags & ACPI_TABLE_ORIGIN_MASK) ==
296 ACPI_TABLE_ORIGIN_MAPPED) {
297 header =
298 acpi_os_map_memory(acpi_gbl_root_table_list.
299 tables[i].address,
300 sizeof(struct
301 acpi_table_header));
302 if (!header) {
303 return AE_NO_MEMORY;
304 }
305 ACPI_MEMCPY(out_table_header, header,
306 sizeof(struct acpi_table_header));
307 acpi_os_unmap_memory(header,
308 sizeof(struct
309 acpi_table_header));
310 } else {
311 return AE_NOT_FOUND;
312 }
313 } else {
314 ACPI_MEMCPY(out_table_header,
315 acpi_gbl_root_table_list.tables[i].pointer,
316 sizeof(struct acpi_table_header));
317 }
318 return (AE_OK);
319 }
320
321 return (AE_NOT_FOUND);
322 }
323
324 ACPI_EXPORT_SYMBOL(acpi_get_table_header)
325
326 /******************************************************************************
327 *
328 * FUNCTION: acpi_unload_table_id
329 *
330 * PARAMETERS: id - Owner ID of the table to be removed.
331 *
332 * RETURN: Status
333 *
334 * DESCRIPTION: This routine is used to force the unload of a table (by id)
335 *
336 ******************************************************************************/
337 acpi_status acpi_unload_table_id(acpi_owner_id id)
338 {
339 int i;
340 acpi_status status = AE_NOT_EXIST;
341
342 ACPI_FUNCTION_TRACE(acpi_unload_table_id);
343
344 /* Find table in the global table list */
345 for (i = 0; i < acpi_gbl_root_table_list.count; ++i) {
346 if (id != acpi_gbl_root_table_list.tables[i].owner_id) {
347 continue;
348 }
349 /*
350 * Delete all namespace objects owned by this table. Note that these
351 * objects can appear anywhere in the namespace by virtue of the AML
352 * "Scope" operator. Thus, we need to track ownership by an ID, not
353 * simply a position within the hierarchy
354 */
355 acpi_tb_delete_namespace_by_owner(i);
356 status = acpi_tb_release_owner_id(i);
357 acpi_tb_set_table_loaded_flag(i, FALSE);
358 break;
359 }
360 return_ACPI_STATUS(status);
361 }
362
363 ACPI_EXPORT_SYMBOL(acpi_unload_table_id)
364
365 /*******************************************************************************
366 *
367 * FUNCTION: acpi_get_table
368 *
369 * PARAMETERS: Signature - ACPI signature of needed table
370 * Instance - Which instance (for SSDTs)
371 * out_table - Where the pointer to the table is returned
372 *
373 * RETURN: Status and pointer to table
374 *
375 * DESCRIPTION: Finds and verifies an ACPI table.
376 *
377 *****************************************************************************/
378 acpi_status
379 acpi_get_table(char *signature,
380 u32 instance, struct acpi_table_header **out_table)
381 {
382 u32 i;
383 u32 j;
384 acpi_status status;
385
386 /* Parameter validation */
387
388 if (!signature || !out_table) {
389 return (AE_BAD_PARAMETER);
390 }
391
392 /*
393 * Walk the root table list
394 */
395 for (i = 0, j = 0; i < acpi_gbl_root_table_list.count; i++) {
396 if (!ACPI_COMPARE_NAME
397 (&(acpi_gbl_root_table_list.tables[i].signature),
398 signature)) {
399 continue;
400 }
401
402 if (++j < instance) {
403 continue;
404 }
405
406 status =
407 acpi_tb_verify_table(&acpi_gbl_root_table_list.tables[i]);
408 if (ACPI_SUCCESS(status)) {
409 *out_table = acpi_gbl_root_table_list.tables[i].pointer;
410 }
411
412 if (!acpi_gbl_permanent_mmap) {
413 acpi_gbl_root_table_list.tables[i].pointer = NULL;
414 }
415
416 return (status);
417 }
418
419 return (AE_NOT_FOUND);
420 }
421
422 ACPI_EXPORT_SYMBOL(acpi_get_table)
423
424 /*******************************************************************************
425 *
426 * FUNCTION: acpi_get_table_by_index
427 *
428 * PARAMETERS: table_index - Table index
429 * Table - Where the pointer to the table is returned
430 *
431 * RETURN: Status and pointer to the table
432 *
433 * DESCRIPTION: Obtain a table by an index into the global table list.
434 *
435 ******************************************************************************/
436 acpi_status
437 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **table)
438 {
439 acpi_status status;
440
441 ACPI_FUNCTION_TRACE(acpi_get_table_by_index);
442
443 /* Parameter validation */
444
445 if (!table) {
446 return_ACPI_STATUS(AE_BAD_PARAMETER);
447 }
448
449 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
450
451 /* Validate index */
452
453 if (table_index >= acpi_gbl_root_table_list.count) {
454 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
455 return_ACPI_STATUS(AE_BAD_PARAMETER);
456 }
457
458 if (!acpi_gbl_root_table_list.tables[table_index].pointer) {
459
460 /* Table is not mapped, map it */
461
462 status =
463 acpi_tb_verify_table(&acpi_gbl_root_table_list.
464 tables[table_index]);
465 if (ACPI_FAILURE(status)) {
466 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
467 return_ACPI_STATUS(status);
468 }
469 }
470
471 *table = acpi_gbl_root_table_list.tables[table_index].pointer;
472 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
473 return_ACPI_STATUS(AE_OK);
474 }
475
476 ACPI_EXPORT_SYMBOL(acpi_get_table_by_index)
477
478 /*******************************************************************************
479 *
480 * FUNCTION: acpi_tb_load_namespace
481 *
482 * PARAMETERS: None
483 *
484 * RETURN: Status
485 *
486 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
487 * the RSDT/XSDT.
488 *
489 ******************************************************************************/
490 static acpi_status acpi_tb_load_namespace(void)
491 {
492 acpi_status status;
493 u32 i;
494
495 ACPI_FUNCTION_TRACE(tb_load_namespace);
496
497 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
498
499 /*
500 * Load the namespace. The DSDT is required, but any SSDT and PSDT tables
501 * are optional.
502 */
503 if (!acpi_gbl_root_table_list.count ||
504 !ACPI_COMPARE_NAME(&
505 (acpi_gbl_root_table_list.
506 tables[ACPI_TABLE_INDEX_DSDT].signature),
507 ACPI_SIG_DSDT)
508 ||
509 ACPI_FAILURE(acpi_tb_verify_table
510 (&acpi_gbl_root_table_list.
511 tables[ACPI_TABLE_INDEX_DSDT]))) {
512 status = AE_NO_ACPI_TABLES;
513 goto unlock_and_exit;
514 }
515
516 /* A valid DSDT is required */
517
518 status =
519 acpi_tb_verify_table(&acpi_gbl_root_table_list.
520 tables[ACPI_TABLE_INDEX_DSDT]);
521 if (ACPI_FAILURE(status)) {
522
523 status = AE_NO_ACPI_TABLES;
524 goto unlock_and_exit;
525 }
526
527 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
528
529 /*
530 * Load and parse tables.
531 */
532 status = acpi_ns_load_table(ACPI_TABLE_INDEX_DSDT, acpi_gbl_root_node);
533 if (ACPI_FAILURE(status)) {
534 return_ACPI_STATUS(status);
535 }
536
537 /*
538 * Load any SSDT or PSDT tables. Note: Loop leaves tables locked
539 */
540 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
541 for (i = 0; i < acpi_gbl_root_table_list.count; ++i) {
542 if ((!ACPI_COMPARE_NAME
543 (&(acpi_gbl_root_table_list.tables[i].signature),
544 ACPI_SIG_SSDT)
545 &&
546 !ACPI_COMPARE_NAME(&
547 (acpi_gbl_root_table_list.tables[i].
548 signature), ACPI_SIG_PSDT))
549 ||
550 ACPI_FAILURE(acpi_tb_verify_table
551 (&acpi_gbl_root_table_list.tables[i]))) {
552 continue;
553 }
554
555 if (no_auto_ssdt) {
556 printk(KERN_WARNING "ACPI: SSDT ignored due to \"acpi_no_auto_ssdt\"\n");
557 continue;
558 }
559
560 /* Ignore errors while loading tables, get as many as possible */
561
562 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
563 (void)acpi_ns_load_table(i, acpi_gbl_root_node);
564 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
565 }
566
567 ACPI_DEBUG_PRINT((ACPI_DB_INIT, "ACPI Tables successfully acquired\n"));
568
569 unlock_and_exit:
570 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
571 return_ACPI_STATUS(status);
572 }
573
574 /*******************************************************************************
575 *
576 * FUNCTION: acpi_load_tables
577 *
578 * PARAMETERS: None
579 *
580 * RETURN: Status
581 *
582 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
583 *
584 ******************************************************************************/
585
586 acpi_status acpi_load_tables(void)
587 {
588 acpi_status status;
589
590 ACPI_FUNCTION_TRACE(acpi_load_tables);
591
592 /*
593 * Load the namespace from the tables
594 */
595 status = acpi_tb_load_namespace();
596 if (ACPI_FAILURE(status)) {
597 ACPI_EXCEPTION((AE_INFO, status,
598 "While loading namespace from ACPI tables"));
599 }
600
601 return_ACPI_STATUS(status);
602 }
603
604 ACPI_EXPORT_SYMBOL(acpi_load_tables)
605
606
607 /*******************************************************************************
608 *
609 * FUNCTION: acpi_install_table_handler
610 *
611 * PARAMETERS: Handler - Table event handler
612 * Context - Value passed to the handler on each event
613 *
614 * RETURN: Status
615 *
616 * DESCRIPTION: Install table event handler
617 *
618 ******************************************************************************/
619 acpi_status
620 acpi_install_table_handler(acpi_tbl_handler handler, void *context)
621 {
622 acpi_status status;
623
624 ACPI_FUNCTION_TRACE(acpi_install_table_handler);
625
626 if (!handler) {
627 return_ACPI_STATUS(AE_BAD_PARAMETER);
628 }
629
630 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
631 if (ACPI_FAILURE(status)) {
632 return_ACPI_STATUS(status);
633 }
634
635 /* Don't allow more than one handler */
636
637 if (acpi_gbl_table_handler) {
638 status = AE_ALREADY_EXISTS;
639 goto cleanup;
640 }
641
642 /* Install the handler */
643
644 acpi_gbl_table_handler = handler;
645 acpi_gbl_table_handler_context = context;
646
647 cleanup:
648 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
649 return_ACPI_STATUS(status);
650 }
651
652 ACPI_EXPORT_SYMBOL(acpi_install_table_handler)
653
654 /*******************************************************************************
655 *
656 * FUNCTION: acpi_remove_table_handler
657 *
658 * PARAMETERS: Handler - Table event handler that was installed
659 * previously.
660 *
661 * RETURN: Status
662 *
663 * DESCRIPTION: Remove table event handler
664 *
665 ******************************************************************************/
666 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler)
667 {
668 acpi_status status;
669
670 ACPI_FUNCTION_TRACE(acpi_remove_table_handler);
671
672 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
673 if (ACPI_FAILURE(status)) {
674 return_ACPI_STATUS(status);
675 }
676
677 /* Make sure that the installed handler is the same */
678
679 if (!handler || handler != acpi_gbl_table_handler) {
680 status = AE_BAD_PARAMETER;
681 goto cleanup;
682 }
683
684 /* Remove the handler */
685
686 acpi_gbl_table_handler = NULL;
687
688 cleanup:
689 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
690 return_ACPI_STATUS(status);
691 }
692
693 ACPI_EXPORT_SYMBOL(acpi_remove_table_handler)
694
695
696 static int __init acpi_no_auto_ssdt_setup(char *s) {
697
698 printk(KERN_NOTICE "ACPI: SSDT auto-load disabled\n");
699
700 no_auto_ssdt = 1;
701
702 return 1;
703 }
704
705 __setup("acpi_no_auto_ssdt", acpi_no_auto_ssdt_setup);
This page took 0.058217 seconds and 5 git commands to generate.