1 /******************************************************************************
3 * Module Name: tbdata - Table manager data structure functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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>
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
63 * DESCRIPTION: Initialize a new table descriptor
65 ******************************************************************************/
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 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
94 * DESCRIPTION: Acquire an ACPI table. It can be used for tables not
95 * maintained in the acpi_gbl_root_table_list.
97 ******************************************************************************/
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
:
110 acpi_os_map_memory(table_desc
->address
, table_desc
->length
);
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
->
126 /* Table is not valid yet */
129 return (AE_NO_MEMORY
);
132 /* Fill the return values */
135 *table_length
= table_desc
->length
;
136 *table_flags
= table_desc
->flags
;
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
150 * DESCRIPTION: Release a table. The inverse of acpi_tb_acquire_table().
152 ******************************************************************************/
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
);
165 case ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL
:
166 case ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
:
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
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
188 ******************************************************************************/
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 */
202 acpi_os_map_memory(address
,
203 sizeof(struct acpi_table_header
));
205 return (AE_NO_MEMORY
);
208 acpi_tb_init_table_descriptor(table_desc
, address
, flags
,
210 acpi_os_unmap_memory(table_header
,
211 sizeof(struct acpi_table_header
));
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
));
220 return (AE_NO_MEMORY
);
223 acpi_tb_init_table_descriptor(table_desc
, address
, flags
,
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
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
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
,
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
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
) {
317 acpi_tb_release_table(table_desc
->pointer
, table_desc
->length
,
319 table_desc
->pointer
= NULL
;
324 /******************************************************************************
326 * FUNCTION: acpi_tb_validate_temp_table
328 * PARAMETERS: table_desc - Table descriptor
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
365 * DESCRIPTION: This function is called to validate and verify the table, the
366 * returned table descriptor is in "VALIDATED" state.
368 *****************************************************************************/
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
) {
398 acpi_tb_verify_checksum(table_desc
->pointer
,
400 if (ACPI_FAILURE(status
)) {
401 ACPI_EXCEPTION((AE_INFO
, AE_NO_MEMORY
,
403 " Attempted table install failed",
404 acpi_ut_valid_acpi_name(table_desc
->
407 table_desc
->signature
.ascii
: "????",
408 ACPI_FORMAT_UINT64(table_desc
->
411 goto invalidate_and_exit
;
415 return_ACPI_STATUS(AE_OK
);
418 acpi_tb_invalidate_table(table_desc
);
419 return_ACPI_STATUS(status
);
422 /*******************************************************************************
424 * FUNCTION: acpi_tb_resize_root_table_list
430 * DESCRIPTION: Expand the size of global table array
432 ******************************************************************************/
434 acpi_status
acpi_tb_resize_root_table_list(void)
436 struct acpi_table_desc
*tables
;
439 ACPI_FUNCTION_TRACE(tb_resize_root_table_list
);
441 /* allow_resize flag is a parameter to acpi_initialize_tables */
443 if (!(acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ALLOW_RESIZE
)) {
445 "Resize of Root Table Array is not allowed"));
446 return_ACPI_STATUS(AE_SUPPORT
);
449 /* Increase the Table Array size */
451 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
452 table_count
= acpi_gbl_root_table_list
.max_table_count
;
454 table_count
= acpi_gbl_root_table_list
.current_table_count
;
457 tables
= ACPI_ALLOCATE_ZEROED(((acpi_size
) table_count
+
458 ACPI_ROOT_TABLE_SIZE_INCREMENT
) *
459 sizeof(struct acpi_table_desc
));
462 "Could not allocate new root table array"));
463 return_ACPI_STATUS(AE_NO_MEMORY
);
466 /* Copy and free the previous table array */
468 if (acpi_gbl_root_table_list
.tables
) {
469 memcpy(tables
, acpi_gbl_root_table_list
.tables
,
470 (acpi_size
) table_count
*
471 sizeof(struct acpi_table_desc
));
473 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
474 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
478 acpi_gbl_root_table_list
.tables
= tables
;
479 acpi_gbl_root_table_list
.max_table_count
=
480 table_count
+ ACPI_ROOT_TABLE_SIZE_INCREMENT
;
481 acpi_gbl_root_table_list
.flags
|= ACPI_ROOT_ORIGIN_ALLOCATED
;
483 return_ACPI_STATUS(AE_OK
);
486 /*******************************************************************************
488 * FUNCTION: acpi_tb_get_next_table_descriptor
490 * PARAMETERS: table_index - Where table index is returned
491 * table_desc - Where table descriptor is returned
493 * RETURN: Status and table index/descriptor.
495 * DESCRIPTION: Allocate a new ACPI table entry to the global table list
497 ******************************************************************************/
500 acpi_tb_get_next_table_descriptor(u32
*table_index
,
501 struct acpi_table_desc
**table_desc
)
506 /* Ensure that there is room for the table in the Root Table List */
508 if (acpi_gbl_root_table_list
.current_table_count
>=
509 acpi_gbl_root_table_list
.max_table_count
) {
510 status
= acpi_tb_resize_root_table_list();
511 if (ACPI_FAILURE(status
)) {
516 i
= acpi_gbl_root_table_list
.current_table_count
;
517 acpi_gbl_root_table_list
.current_table_count
++;
523 *table_desc
= &acpi_gbl_root_table_list
.tables
[i
];
529 /*******************************************************************************
531 * FUNCTION: acpi_tb_terminate
537 * DESCRIPTION: Delete all internal ACPI tables
539 ******************************************************************************/
541 void acpi_tb_terminate(void)
545 ACPI_FUNCTION_TRACE(tb_terminate
);
547 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
549 /* Delete the individual tables */
551 for (i
= 0; i
< acpi_gbl_root_table_list
.current_table_count
; i
++) {
552 acpi_tb_uninstall_table(&acpi_gbl_root_table_list
.tables
[i
]);
556 * Delete the root table array if allocated locally. Array cannot be
557 * mapped, so we don't need to check for that flag.
559 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
560 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
563 acpi_gbl_root_table_list
.tables
= NULL
;
564 acpi_gbl_root_table_list
.flags
= 0;
565 acpi_gbl_root_table_list
.current_table_count
= 0;
567 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "ACPI Tables freed\n"));
569 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
573 /*******************************************************************************
575 * FUNCTION: acpi_tb_delete_namespace_by_owner
577 * PARAMETERS: table_index - Table index
581 * DESCRIPTION: Delete all namespace objects created when this table was loaded.
583 ******************************************************************************/
585 acpi_status
acpi_tb_delete_namespace_by_owner(u32 table_index
)
587 acpi_owner_id owner_id
;
590 ACPI_FUNCTION_TRACE(tb_delete_namespace_by_owner
);
592 status
= acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
593 if (ACPI_FAILURE(status
)) {
594 return_ACPI_STATUS(status
);
597 if (table_index
>= acpi_gbl_root_table_list
.current_table_count
) {
599 /* The table index does not exist */
601 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
602 return_ACPI_STATUS(AE_NOT_EXIST
);
605 /* Get the owner ID for this table, used to delete namespace nodes */
607 owner_id
= acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
608 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
611 * Need to acquire the namespace writer lock to prevent interference
612 * with any concurrent namespace walks. The interpreter must be
613 * released during the deletion since the acquisition of the deletion
614 * lock may block, and also since the execution of a namespace walk
615 * must be allowed to use the interpreter.
617 (void)acpi_ut_release_mutex(ACPI_MTX_INTERPRETER
);
618 status
= acpi_ut_acquire_write_lock(&acpi_gbl_namespace_rw_lock
);
620 acpi_ns_delete_namespace_by_owner(owner_id
);
621 if (ACPI_FAILURE(status
)) {
622 return_ACPI_STATUS(status
);
625 acpi_ut_release_write_lock(&acpi_gbl_namespace_rw_lock
);
627 status
= acpi_ut_acquire_mutex(ACPI_MTX_INTERPRETER
);
628 return_ACPI_STATUS(status
);
631 /*******************************************************************************
633 * FUNCTION: acpi_tb_allocate_owner_id
635 * PARAMETERS: table_index - Table index
639 * DESCRIPTION: Allocates owner_id in table_desc
641 ******************************************************************************/
643 acpi_status
acpi_tb_allocate_owner_id(u32 table_index
)
645 acpi_status status
= AE_BAD_PARAMETER
;
647 ACPI_FUNCTION_TRACE(tb_allocate_owner_id
);
649 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
650 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
652 acpi_ut_allocate_owner_id(&
653 (acpi_gbl_root_table_list
.
654 tables
[table_index
].owner_id
));
657 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
658 return_ACPI_STATUS(status
);
661 /*******************************************************************************
663 * FUNCTION: acpi_tb_release_owner_id
665 * PARAMETERS: table_index - Table index
669 * DESCRIPTION: Releases owner_id in table_desc
671 ******************************************************************************/
673 acpi_status
acpi_tb_release_owner_id(u32 table_index
)
675 acpi_status status
= AE_BAD_PARAMETER
;
677 ACPI_FUNCTION_TRACE(tb_release_owner_id
);
679 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
680 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
681 acpi_ut_release_owner_id(&
682 (acpi_gbl_root_table_list
.
683 tables
[table_index
].owner_id
));
687 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
688 return_ACPI_STATUS(status
);
691 /*******************************************************************************
693 * FUNCTION: acpi_tb_get_owner_id
695 * PARAMETERS: table_index - Table index
696 * owner_id - Where the table owner_id is returned
700 * DESCRIPTION: returns owner_id for the ACPI table
702 ******************************************************************************/
704 acpi_status
acpi_tb_get_owner_id(u32 table_index
, acpi_owner_id
* owner_id
)
706 acpi_status status
= AE_BAD_PARAMETER
;
708 ACPI_FUNCTION_TRACE(tb_get_owner_id
);
710 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
711 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
713 acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
717 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
718 return_ACPI_STATUS(status
);
721 /*******************************************************************************
723 * FUNCTION: acpi_tb_is_table_loaded
725 * PARAMETERS: table_index - Index into the root table
727 * RETURN: Table Loaded Flag
729 ******************************************************************************/
731 u8
acpi_tb_is_table_loaded(u32 table_index
)
733 u8 is_loaded
= FALSE
;
735 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
736 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
738 (acpi_gbl_root_table_list
.tables
[table_index
].flags
&
739 ACPI_TABLE_IS_LOADED
);
742 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
746 /*******************************************************************************
748 * FUNCTION: acpi_tb_set_table_loaded_flag
750 * PARAMETERS: table_index - Table index
751 * is_loaded - TRUE if table is loaded, FALSE otherwise
755 * DESCRIPTION: Sets the table loaded flag to either TRUE or FALSE.
757 ******************************************************************************/
759 void acpi_tb_set_table_loaded_flag(u32 table_index
, u8 is_loaded
)
762 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
763 if (table_index
< acpi_gbl_root_table_list
.current_table_count
) {
765 acpi_gbl_root_table_list
.tables
[table_index
].flags
|=
766 ACPI_TABLE_IS_LOADED
;
768 acpi_gbl_root_table_list
.tables
[table_index
].flags
&=
769 ~ACPI_TABLE_IS_LOADED
;
773 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);