Linux 4.1.16
[linux/fpc-iii.git] / drivers / acpi / acpica / tbdata.c
blobd7f8386455bdc0e2ce35a36b7f80c188d376b86f
1 /******************************************************************************
3 * Module Name: tbdata - Table manager data structure functions
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2015, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
45 #include "accommon.h"
46 #include "acnamesp.h"
47 #include "actables.h"
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME("tbdata")
52 /*******************************************************************************
54 * FUNCTION: acpi_tb_init_table_descriptor
56 * PARAMETERS: table_desc - Table descriptor
57 * address - Physical address of the table
58 * flags - Allocation flags of the table
59 * table - Pointer to the table
61 * RETURN: None
63 * DESCRIPTION: Initialize a new table descriptor
65 ******************************************************************************/
66 void
67 acpi_tb_init_table_descriptor(struct acpi_table_desc *table_desc,
68 acpi_physical_address address,
69 u8 flags, struct acpi_table_header *table)
73 * Initialize the table descriptor. Set the pointer to NULL, since the
74 * table is not fully mapped at this time.
76 ACPI_MEMSET(table_desc, 0, sizeof(struct acpi_table_desc));
77 table_desc->address = address;
78 table_desc->length = table->length;
79 table_desc->flags = flags;
80 ACPI_MOVE_32_TO_32(table_desc->signature.ascii, table->signature);
83 /*******************************************************************************
85 * FUNCTION: acpi_tb_acquire_table
87 * PARAMETERS: table_desc - Table descriptor
88 * table_ptr - Where table is returned
89 * table_length - Where table length is returned
90 * table_flags - Where table allocation flags are returned
92 * RETURN: Status
94 * DESCRIPTION: Acquire an ACPI table. It can be used for tables not
95 * maintained in the acpi_gbl_root_table_list.
97 ******************************************************************************/
99 acpi_status
100 acpi_tb_acquire_table(struct acpi_table_desc *table_desc,
101 struct acpi_table_header **table_ptr,
102 u32 *table_length, u8 *table_flags)
104 struct acpi_table_header *table = NULL;
106 switch (table_desc->flags & ACPI_TABLE_ORIGIN_MASK) {
107 case ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL:
109 table =
110 acpi_os_map_memory(table_desc->address, table_desc->length);
111 break;
113 case ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL:
114 case ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL:
116 table = ACPI_CAST_PTR(struct acpi_table_header,
117 ACPI_PHYSADDR_TO_PTR(table_desc->
118 address));
119 break;
121 default:
123 break;
126 /* Table is not valid yet */
128 if (!table) {
129 return (AE_NO_MEMORY);
132 /* Fill the return values */
134 *table_ptr = table;
135 *table_length = table_desc->length;
136 *table_flags = table_desc->flags;
137 return (AE_OK);
140 /*******************************************************************************
142 * FUNCTION: acpi_tb_release_table
144 * PARAMETERS: table - Pointer for the table
145 * table_length - Length for the table
146 * table_flags - Allocation flags for the table
148 * RETURN: None
150 * DESCRIPTION: Release a table. The inverse of acpi_tb_acquire_table().
152 ******************************************************************************/
154 void
155 acpi_tb_release_table(struct acpi_table_header *table,
156 u32 table_length, u8 table_flags)
159 switch (table_flags & ACPI_TABLE_ORIGIN_MASK) {
160 case ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL:
162 acpi_os_unmap_memory(table, table_length);
163 break;
165 case ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL:
166 case ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL:
167 default:
169 break;
173 /*******************************************************************************
175 * FUNCTION: acpi_tb_acquire_temp_table
177 * PARAMETERS: table_desc - Table descriptor to be acquired
178 * address - Address of the table
179 * flags - Allocation flags of the table
181 * RETURN: Status
183 * DESCRIPTION: This function validates the table header to obtain the length
184 * of a table and fills the table descriptor to make its state as
185 * "INSTALLED". Such a table descriptor is only used for verified
186 * installation.
188 ******************************************************************************/
190 acpi_status
191 acpi_tb_acquire_temp_table(struct acpi_table_desc *table_desc,
192 acpi_physical_address address, u8 flags)
194 struct acpi_table_header *table_header;
196 switch (flags & ACPI_TABLE_ORIGIN_MASK) {
197 case ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL:
199 /* Get the length of the full table from the header */
201 table_header =
202 acpi_os_map_memory(address,
203 sizeof(struct acpi_table_header));
204 if (!table_header) {
205 return (AE_NO_MEMORY);
208 acpi_tb_init_table_descriptor(table_desc, address, flags,
209 table_header);
210 acpi_os_unmap_memory(table_header,
211 sizeof(struct acpi_table_header));
212 return (AE_OK);
214 case ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL:
215 case ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL:
217 table_header = ACPI_CAST_PTR(struct acpi_table_header,
218 ACPI_PHYSADDR_TO_PTR(address));
219 if (!table_header) {
220 return (AE_NO_MEMORY);
223 acpi_tb_init_table_descriptor(table_desc, address, flags,
224 table_header);
225 return (AE_OK);
227 default:
229 break;
232 /* Table is not valid yet */
234 return (AE_NO_MEMORY);
237 /*******************************************************************************
239 * FUNCTION: acpi_tb_release_temp_table
241 * PARAMETERS: table_desc - Table descriptor to be released
243 * RETURN: Status
245 * DESCRIPTION: The inverse of acpi_tb_acquire_temp_table().
247 *****************************************************************************/
249 void acpi_tb_release_temp_table(struct acpi_table_desc *table_desc)
253 * Note that the .Address is maintained by the callers of
254 * acpi_tb_acquire_temp_table(), thus do not invoke acpi_tb_uninstall_table()
255 * where .Address will be freed.
257 acpi_tb_invalidate_table(table_desc);
260 /******************************************************************************
262 * FUNCTION: acpi_tb_validate_table
264 * PARAMETERS: table_desc - Table descriptor
266 * RETURN: Status
268 * DESCRIPTION: This function is called to validate the table, the returned
269 * table descriptor is in "VALIDATED" state.
271 *****************************************************************************/
273 acpi_status acpi_tb_validate_table(struct acpi_table_desc *table_desc)
275 acpi_status status = AE_OK;
277 ACPI_FUNCTION_TRACE(tb_validate_table);
279 /* Validate the table if necessary */
281 if (!table_desc->pointer) {
282 status = acpi_tb_acquire_table(table_desc, &table_desc->pointer,
283 &table_desc->length,
284 &table_desc->flags);
285 if (!table_desc->pointer) {
286 status = AE_NO_MEMORY;
290 return_ACPI_STATUS(status);
293 /*******************************************************************************
295 * FUNCTION: acpi_tb_invalidate_table
297 * PARAMETERS: table_desc - Table descriptor
299 * RETURN: None
301 * DESCRIPTION: Invalidate one internal ACPI table, this is the inverse of
302 * acpi_tb_validate_table().
304 ******************************************************************************/
306 void acpi_tb_invalidate_table(struct acpi_table_desc *table_desc)
309 ACPI_FUNCTION_TRACE(tb_invalidate_table);
311 /* Table must be validated */
313 if (!table_desc->pointer) {
314 return_VOID;
317 acpi_tb_release_table(table_desc->pointer, table_desc->length,
318 table_desc->flags);
319 table_desc->pointer = NULL;
321 return_VOID;
324 /******************************************************************************
326 * FUNCTION: acpi_tb_validate_temp_table
328 * PARAMETERS: table_desc - Table descriptor
330 * RETURN: Status
332 * DESCRIPTION: This function is called to validate the table, the returned
333 * table descriptor is in "VALIDATED" state.
335 *****************************************************************************/
337 acpi_status acpi_tb_validate_temp_table(struct acpi_table_desc *table_desc)
340 if (!table_desc->pointer && !acpi_gbl_verify_table_checksum) {
342 * Only validates the header of the table.
343 * Note that Length contains the size of the mapping after invoking
344 * this work around, this value is required by
345 * acpi_tb_release_temp_table().
346 * We can do this because in acpi_init_table_descriptor(), the Length
347 * field of the installed descriptor is filled with the actual
348 * table length obtaining from the table header.
350 table_desc->length = sizeof(struct acpi_table_header);
353 return (acpi_tb_validate_table(table_desc));
356 /******************************************************************************
358 * FUNCTION: acpi_tb_verify_temp_table
360 * PARAMETERS: table_desc - Table descriptor
361 * signature - Table signature to verify
363 * RETURN: Status
365 * DESCRIPTION: This function is called to validate and verify the table, the
366 * returned table descriptor is in "VALIDATED" state.
368 *****************************************************************************/
370 acpi_status
371 acpi_tb_verify_temp_table(struct acpi_table_desc * table_desc, char *signature)
373 acpi_status status = AE_OK;
375 ACPI_FUNCTION_TRACE(tb_verify_temp_table);
377 /* Validate the table */
379 status = acpi_tb_validate_temp_table(table_desc);
380 if (ACPI_FAILURE(status)) {
381 return_ACPI_STATUS(AE_NO_MEMORY);
384 /* If a particular signature is expected (DSDT/FACS), it must match */
386 if (signature && !ACPI_COMPARE_NAME(&table_desc->signature, signature)) {
387 ACPI_BIOS_ERROR((AE_INFO,
388 "Invalid signature 0x%X for ACPI table, expected [%s]",
389 table_desc->signature.integer, signature));
390 status = AE_BAD_SIGNATURE;
391 goto invalidate_and_exit;
394 /* Verify the checksum */
396 if (acpi_gbl_verify_table_checksum) {
397 status =
398 acpi_tb_verify_checksum(table_desc->pointer,
399 table_desc->length);
400 if (ACPI_FAILURE(status)) {
401 ACPI_EXCEPTION((AE_INFO, AE_NO_MEMORY,
402 "%4.4s 0x%8.8X%8.8X"
403 " Attempted table install failed",
404 acpi_ut_valid_acpi_name(table_desc->
405 signature.
406 ascii) ?
407 table_desc->signature.ascii : "????",
408 ACPI_FORMAT_UINT64(table_desc->
409 address)));
410 goto invalidate_and_exit;
414 return_ACPI_STATUS(AE_OK);
416 invalidate_and_exit:
417 acpi_tb_invalidate_table(table_desc);
418 return_ACPI_STATUS(status);
421 /*******************************************************************************
423 * FUNCTION: acpi_tb_resize_root_table_list
425 * PARAMETERS: None
427 * RETURN: Status
429 * DESCRIPTION: Expand the size of global table array
431 ******************************************************************************/
433 acpi_status acpi_tb_resize_root_table_list(void)
435 struct acpi_table_desc *tables;
436 u32 table_count;
438 ACPI_FUNCTION_TRACE(tb_resize_root_table_list);
440 /* allow_resize flag is a parameter to acpi_initialize_tables */
442 if (!(acpi_gbl_root_table_list.flags & ACPI_ROOT_ALLOW_RESIZE)) {
443 ACPI_ERROR((AE_INFO,
444 "Resize of Root Table Array is not allowed"));
445 return_ACPI_STATUS(AE_SUPPORT);
448 /* Increase the Table Array size */
450 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
451 table_count = acpi_gbl_root_table_list.max_table_count;
452 } else {
453 table_count = acpi_gbl_root_table_list.current_table_count;
456 tables = ACPI_ALLOCATE_ZEROED(((acpi_size) table_count +
457 ACPI_ROOT_TABLE_SIZE_INCREMENT) *
458 sizeof(struct acpi_table_desc));
459 if (!tables) {
460 ACPI_ERROR((AE_INFO,
461 "Could not allocate new root table array"));
462 return_ACPI_STATUS(AE_NO_MEMORY);
465 /* Copy and free the previous table array */
467 if (acpi_gbl_root_table_list.tables) {
468 ACPI_MEMCPY(tables, acpi_gbl_root_table_list.tables,
469 (acpi_size) table_count *
470 sizeof(struct acpi_table_desc));
472 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
473 ACPI_FREE(acpi_gbl_root_table_list.tables);
477 acpi_gbl_root_table_list.tables = tables;
478 acpi_gbl_root_table_list.max_table_count =
479 table_count + ACPI_ROOT_TABLE_SIZE_INCREMENT;
480 acpi_gbl_root_table_list.flags |= ACPI_ROOT_ORIGIN_ALLOCATED;
482 return_ACPI_STATUS(AE_OK);
485 /*******************************************************************************
487 * FUNCTION: acpi_tb_get_next_table_descriptor
489 * PARAMETERS: table_index - Where table index is returned
490 * table_desc - Where table descriptor is returned
492 * RETURN: Status and table index/descriptor.
494 * DESCRIPTION: Allocate a new ACPI table entry to the global table list
496 ******************************************************************************/
498 acpi_status
499 acpi_tb_get_next_table_descriptor(u32 *table_index,
500 struct acpi_table_desc **table_desc)
502 acpi_status status;
503 u32 i;
505 /* Ensure that there is room for the table in the Root Table List */
507 if (acpi_gbl_root_table_list.current_table_count >=
508 acpi_gbl_root_table_list.max_table_count) {
509 status = acpi_tb_resize_root_table_list();
510 if (ACPI_FAILURE(status)) {
511 return (status);
515 i = acpi_gbl_root_table_list.current_table_count;
516 acpi_gbl_root_table_list.current_table_count++;
518 if (table_index) {
519 *table_index = i;
521 if (table_desc) {
522 *table_desc = &acpi_gbl_root_table_list.tables[i];
525 return (AE_OK);
528 /*******************************************************************************
530 * FUNCTION: acpi_tb_terminate
532 * PARAMETERS: None
534 * RETURN: None
536 * DESCRIPTION: Delete all internal ACPI tables
538 ******************************************************************************/
540 void acpi_tb_terminate(void)
542 u32 i;
544 ACPI_FUNCTION_TRACE(tb_terminate);
546 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
548 /* Delete the individual tables */
550 for (i = 0; i < acpi_gbl_root_table_list.current_table_count; i++) {
551 acpi_tb_uninstall_table(&acpi_gbl_root_table_list.tables[i]);
555 * Delete the root table array if allocated locally. Array cannot be
556 * mapped, so we don't need to check for that flag.
558 if (acpi_gbl_root_table_list.flags & ACPI_ROOT_ORIGIN_ALLOCATED) {
559 ACPI_FREE(acpi_gbl_root_table_list.tables);
562 acpi_gbl_root_table_list.tables = NULL;
563 acpi_gbl_root_table_list.flags = 0;
564 acpi_gbl_root_table_list.current_table_count = 0;
566 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "ACPI Tables freed\n"));
568 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
569 return_VOID;
572 /*******************************************************************************
574 * FUNCTION: acpi_tb_delete_namespace_by_owner
576 * PARAMETERS: table_index - Table index
578 * RETURN: Status
580 * DESCRIPTION: Delete all namespace objects created when this table was loaded.
582 ******************************************************************************/
584 acpi_status acpi_tb_delete_namespace_by_owner(u32 table_index)
586 acpi_owner_id owner_id;
587 acpi_status status;
589 ACPI_FUNCTION_TRACE(tb_delete_namespace_by_owner);
591 status = acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
592 if (ACPI_FAILURE(status)) {
593 return_ACPI_STATUS(status);
596 if (table_index >= acpi_gbl_root_table_list.current_table_count) {
598 /* The table index does not exist */
600 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
601 return_ACPI_STATUS(AE_NOT_EXIST);
604 /* Get the owner ID for this table, used to delete namespace nodes */
606 owner_id = acpi_gbl_root_table_list.tables[table_index].owner_id;
607 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
610 * Need to acquire the namespace writer lock to prevent interference
611 * with any concurrent namespace walks. The interpreter must be
612 * released during the deletion since the acquisition of the deletion
613 * lock may block, and also since the execution of a namespace walk
614 * must be allowed to use the interpreter.
616 (void)acpi_ut_release_mutex(ACPI_MTX_INTERPRETER);
617 status = acpi_ut_acquire_write_lock(&acpi_gbl_namespace_rw_lock);
619 acpi_ns_delete_namespace_by_owner(owner_id);
620 if (ACPI_FAILURE(status)) {
621 return_ACPI_STATUS(status);
624 acpi_ut_release_write_lock(&acpi_gbl_namespace_rw_lock);
626 status = acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER);
627 return_ACPI_STATUS(status);
630 /*******************************************************************************
632 * FUNCTION: acpi_tb_allocate_owner_id
634 * PARAMETERS: table_index - Table index
636 * RETURN: Status
638 * DESCRIPTION: Allocates owner_id in table_desc
640 ******************************************************************************/
642 acpi_status acpi_tb_allocate_owner_id(u32 table_index)
644 acpi_status status = AE_BAD_PARAMETER;
646 ACPI_FUNCTION_TRACE(tb_allocate_owner_id);
648 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
649 if (table_index < acpi_gbl_root_table_list.current_table_count) {
650 status =
651 acpi_ut_allocate_owner_id(&
652 (acpi_gbl_root_table_list.
653 tables[table_index].owner_id));
656 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
657 return_ACPI_STATUS(status);
660 /*******************************************************************************
662 * FUNCTION: acpi_tb_release_owner_id
664 * PARAMETERS: table_index - Table index
666 * RETURN: Status
668 * DESCRIPTION: Releases owner_id in table_desc
670 ******************************************************************************/
672 acpi_status acpi_tb_release_owner_id(u32 table_index)
674 acpi_status status = AE_BAD_PARAMETER;
676 ACPI_FUNCTION_TRACE(tb_release_owner_id);
678 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
679 if (table_index < acpi_gbl_root_table_list.current_table_count) {
680 acpi_ut_release_owner_id(&
681 (acpi_gbl_root_table_list.
682 tables[table_index].owner_id));
683 status = AE_OK;
686 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
687 return_ACPI_STATUS(status);
690 /*******************************************************************************
692 * FUNCTION: acpi_tb_get_owner_id
694 * PARAMETERS: table_index - Table index
695 * owner_id - Where the table owner_id is returned
697 * RETURN: Status
699 * DESCRIPTION: returns owner_id for the ACPI table
701 ******************************************************************************/
703 acpi_status acpi_tb_get_owner_id(u32 table_index, acpi_owner_id * owner_id)
705 acpi_status status = AE_BAD_PARAMETER;
707 ACPI_FUNCTION_TRACE(tb_get_owner_id);
709 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
710 if (table_index < acpi_gbl_root_table_list.current_table_count) {
711 *owner_id =
712 acpi_gbl_root_table_list.tables[table_index].owner_id;
713 status = AE_OK;
716 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
717 return_ACPI_STATUS(status);
720 /*******************************************************************************
722 * FUNCTION: acpi_tb_is_table_loaded
724 * PARAMETERS: table_index - Index into the root table
726 * RETURN: Table Loaded Flag
728 ******************************************************************************/
730 u8 acpi_tb_is_table_loaded(u32 table_index)
732 u8 is_loaded = FALSE;
734 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
735 if (table_index < acpi_gbl_root_table_list.current_table_count) {
736 is_loaded = (u8)
737 (acpi_gbl_root_table_list.tables[table_index].flags &
738 ACPI_TABLE_IS_LOADED);
741 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);
742 return (is_loaded);
745 /*******************************************************************************
747 * FUNCTION: acpi_tb_set_table_loaded_flag
749 * PARAMETERS: table_index - Table index
750 * is_loaded - TRUE if table is loaded, FALSE otherwise
752 * RETURN: None
754 * DESCRIPTION: Sets the table loaded flag to either TRUE or FALSE.
756 ******************************************************************************/
758 void acpi_tb_set_table_loaded_flag(u32 table_index, u8 is_loaded)
761 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES);
762 if (table_index < acpi_gbl_root_table_list.current_table_count) {
763 if (is_loaded) {
764 acpi_gbl_root_table_list.tables[table_index].flags |=
765 ACPI_TABLE_IS_LOADED;
766 } else {
767 acpi_gbl_root_table_list.tables[table_index].flags &=
768 ~ACPI_TABLE_IS_LOADED;
772 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES);