1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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("tbinstal")
52 /******************************************************************************
54 * FUNCTION: acpi_tb_verify_table
56 * PARAMETERS: table_desc - table
60 * DESCRIPTION: this function is called to verify and map table
62 *****************************************************************************/
63 acpi_status
acpi_tb_verify_table(struct acpi_table_desc
*table_desc
)
65 acpi_status status
= AE_OK
;
67 ACPI_FUNCTION_TRACE(tb_verify_table
);
69 /* Map the table if necessary */
71 if (!table_desc
->pointer
) {
72 if ((table_desc
->flags
& ACPI_TABLE_ORIGIN_MASK
) ==
73 ACPI_TABLE_ORIGIN_MAPPED
) {
75 acpi_os_map_memory(table_desc
->address
,
78 if (!table_desc
->pointer
) {
79 return_ACPI_STATUS(AE_NO_MEMORY
);
83 /* FACS is the odd table, has no standard ACPI header and no checksum */
85 if (!ACPI_COMPARE_NAME(&table_desc
->signature
, ACPI_SIG_FACS
)) {
87 /* Always calculate checksum, ignore bad checksum if requested */
90 acpi_tb_verify_checksum(table_desc
->pointer
,
94 return_ACPI_STATUS(status
);
97 /*******************************************************************************
99 * FUNCTION: acpi_tb_add_table
101 * PARAMETERS: table_desc - Table descriptor
102 * table_index - Where the table index is returned
106 * DESCRIPTION: This function is called to add the ACPI table
108 ******************************************************************************/
111 acpi_tb_add_table(struct acpi_table_desc
*table_desc
, u32
*table_index
)
114 acpi_status status
= AE_OK
;
116 ACPI_FUNCTION_TRACE(tb_add_table
);
118 if (!table_desc
->pointer
) {
119 status
= acpi_tb_verify_table(table_desc
);
120 if (ACPI_FAILURE(status
) || !table_desc
->pointer
) {
121 return_ACPI_STATUS(status
);
126 * Originally, we checked the table signature for "SSDT" or "PSDT" here.
127 * Next, we added support for OEMx tables, signature "OEM".
128 * Valid tables were encountered with a null signature, so we've just
129 * given up on validating the signature, since it seems to be a waste
130 * of code. The original code was removed (05/2008).
133 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
135 /* Check if table is already registered */
137 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
138 if (!acpi_gbl_root_table_list
.tables
[i
].pointer
) {
140 acpi_tb_verify_table(&acpi_gbl_root_table_list
.
142 if (ACPI_FAILURE(status
)
143 || !acpi_gbl_root_table_list
.tables
[i
].pointer
) {
149 * Check for a table match on the entire table length,
150 * not just the header.
152 if (table_desc
->length
!=
153 acpi_gbl_root_table_list
.tables
[i
].length
) {
157 if (ACPI_MEMCMP(table_desc
->pointer
,
158 acpi_gbl_root_table_list
.tables
[i
].pointer
,
159 acpi_gbl_root_table_list
.tables
[i
].length
)) {
164 * Note: the current mechanism does not unregister a table if it is
165 * dynamically unloaded. The related namespace entries are deleted,
166 * but the table remains in the root table list.
168 * The assumption here is that the number of different tables that
169 * will be loaded is actually small, and there is minimal overhead
170 * in just keeping the table in case it is needed again.
172 * If this assumption changes in the future (perhaps on large
173 * machines with many table load/unload operations), tables will
174 * need to be unregistered when they are unloaded, and slots in the
175 * root table list should be reused when empty.
179 * Table is already registered.
180 * We can delete the table that was passed as a parameter.
182 acpi_tb_delete_table(table_desc
);
185 if (acpi_gbl_root_table_list
.tables
[i
].
186 flags
& ACPI_TABLE_IS_LOADED
) {
188 /* Table is still loaded, this is an error */
190 status
= AE_ALREADY_EXISTS
;
193 /* Table was unloaded, allow it to be reloaded */
195 table_desc
->pointer
=
196 acpi_gbl_root_table_list
.tables
[i
].pointer
;
197 table_desc
->address
=
198 acpi_gbl_root_table_list
.tables
[i
].address
;
204 /* Add the table to the global root table list */
206 status
= acpi_tb_store_table(table_desc
->address
, table_desc
->pointer
,
207 table_desc
->length
, table_desc
->flags
,
209 if (ACPI_FAILURE(status
)) {
214 acpi_tb_print_table_header(table_desc
->address
, table_desc
->pointer
);
217 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
218 return_ACPI_STATUS(status
);
221 /*******************************************************************************
223 * FUNCTION: acpi_tb_resize_root_table_list
229 * DESCRIPTION: Expand the size of global table array
231 ******************************************************************************/
233 acpi_status
acpi_tb_resize_root_table_list(void)
235 struct acpi_table_desc
*tables
;
237 ACPI_FUNCTION_TRACE(tb_resize_root_table_list
);
239 /* allow_resize flag is a parameter to acpi_initialize_tables */
241 if (!(acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ALLOW_RESIZE
)) {
243 "Resize of Root Table Array is not allowed"));
244 return_ACPI_STATUS(AE_SUPPORT
);
247 /* Increase the Table Array size */
249 tables
= ACPI_ALLOCATE_ZEROED(((acpi_size
) acpi_gbl_root_table_list
.
250 size
+ ACPI_ROOT_TABLE_SIZE_INCREMENT
)
251 * sizeof(struct acpi_table_desc
));
254 "Could not allocate new root table array"));
255 return_ACPI_STATUS(AE_NO_MEMORY
);
258 /* Copy and free the previous table array */
260 if (acpi_gbl_root_table_list
.tables
) {
261 ACPI_MEMCPY(tables
, acpi_gbl_root_table_list
.tables
,
262 (acpi_size
) acpi_gbl_root_table_list
.size
*
263 sizeof(struct acpi_table_desc
));
265 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
266 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
270 acpi_gbl_root_table_list
.tables
= tables
;
271 acpi_gbl_root_table_list
.size
+= ACPI_ROOT_TABLE_SIZE_INCREMENT
;
272 acpi_gbl_root_table_list
.flags
|= (u8
) ACPI_ROOT_ORIGIN_ALLOCATED
;
274 return_ACPI_STATUS(AE_OK
);
277 /*******************************************************************************
279 * FUNCTION: acpi_tb_store_table
281 * PARAMETERS: Address - Table address
282 * Table - Table header
283 * Length - Table length
286 * RETURN: Status and table index.
288 * DESCRIPTION: Add an ACPI table to the global table list
290 ******************************************************************************/
293 acpi_tb_store_table(acpi_physical_address address
,
294 struct acpi_table_header
*table
,
295 u32 length
, u8 flags
, u32
*table_index
)
297 acpi_status status
= AE_OK
;
299 /* Ensure that there is room for the table in the Root Table List */
301 if (acpi_gbl_root_table_list
.count
>= acpi_gbl_root_table_list
.size
) {
302 status
= acpi_tb_resize_root_table_list();
303 if (ACPI_FAILURE(status
)) {
308 /* Initialize added table */
310 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].
312 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].
314 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].length
=
316 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].
318 acpi_gbl_root_table_list
.tables
[acpi_gbl_root_table_list
.count
].flags
=
322 (acpi_gbl_root_table_list
.
323 tables
[acpi_gbl_root_table_list
.count
].signature
),
326 *table_index
= acpi_gbl_root_table_list
.count
;
327 acpi_gbl_root_table_list
.count
++;
331 /*******************************************************************************
333 * FUNCTION: acpi_tb_delete_table
335 * PARAMETERS: table_index - Table index
339 * DESCRIPTION: Delete one internal ACPI table
341 ******************************************************************************/
343 void acpi_tb_delete_table(struct acpi_table_desc
*table_desc
)
345 /* Table must be mapped or allocated */
346 if (!table_desc
->pointer
) {
349 switch (table_desc
->flags
& ACPI_TABLE_ORIGIN_MASK
) {
350 case ACPI_TABLE_ORIGIN_MAPPED
:
351 acpi_os_unmap_memory(table_desc
->pointer
, table_desc
->length
);
353 case ACPI_TABLE_ORIGIN_ALLOCATED
:
354 ACPI_FREE(table_desc
->pointer
);
359 table_desc
->pointer
= NULL
;
362 /*******************************************************************************
364 * FUNCTION: acpi_tb_terminate
370 * DESCRIPTION: Delete all internal ACPI tables
372 ******************************************************************************/
374 void acpi_tb_terminate(void)
378 ACPI_FUNCTION_TRACE(tb_terminate
);
380 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
382 /* Delete the individual tables */
384 for (i
= 0; i
< acpi_gbl_root_table_list
.count
; ++i
) {
385 acpi_tb_delete_table(&acpi_gbl_root_table_list
.tables
[i
]);
389 * Delete the root table array if allocated locally. Array cannot be
390 * mapped, so we don't need to check for that flag.
392 if (acpi_gbl_root_table_list
.flags
& ACPI_ROOT_ORIGIN_ALLOCATED
) {
393 ACPI_FREE(acpi_gbl_root_table_list
.tables
);
396 acpi_gbl_root_table_list
.tables
= NULL
;
397 acpi_gbl_root_table_list
.flags
= 0;
398 acpi_gbl_root_table_list
.count
= 0;
400 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "ACPI Tables freed\n"));
401 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
404 /*******************************************************************************
406 * FUNCTION: acpi_tb_delete_namespace_by_owner
408 * PARAMETERS: table_index - Table index
412 * DESCRIPTION: Delete all namespace objects created when this table was loaded.
414 ******************************************************************************/
416 void acpi_tb_delete_namespace_by_owner(u32 table_index
)
418 acpi_owner_id owner_id
;
420 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
421 if (table_index
< acpi_gbl_root_table_list
.count
) {
423 acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
425 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
429 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
430 acpi_ns_delete_namespace_by_owner(owner_id
);
433 /*******************************************************************************
435 * FUNCTION: acpi_tb_allocate_owner_id
437 * PARAMETERS: table_index - Table index
441 * DESCRIPTION: Allocates owner_id in table_desc
443 ******************************************************************************/
445 acpi_status
acpi_tb_allocate_owner_id(u32 table_index
)
447 acpi_status status
= AE_BAD_PARAMETER
;
449 ACPI_FUNCTION_TRACE(tb_allocate_owner_id
);
451 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
452 if (table_index
< acpi_gbl_root_table_list
.count
) {
453 status
= acpi_ut_allocate_owner_id
454 (&(acpi_gbl_root_table_list
.tables
[table_index
].owner_id
));
457 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
458 return_ACPI_STATUS(status
);
461 /*******************************************************************************
463 * FUNCTION: acpi_tb_release_owner_id
465 * PARAMETERS: table_index - Table index
469 * DESCRIPTION: Releases owner_id in table_desc
471 ******************************************************************************/
473 acpi_status
acpi_tb_release_owner_id(u32 table_index
)
475 acpi_status status
= AE_BAD_PARAMETER
;
477 ACPI_FUNCTION_TRACE(tb_release_owner_id
);
479 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
480 if (table_index
< acpi_gbl_root_table_list
.count
) {
481 acpi_ut_release_owner_id(&
482 (acpi_gbl_root_table_list
.
483 tables
[table_index
].owner_id
));
487 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
488 return_ACPI_STATUS(status
);
491 /*******************************************************************************
493 * FUNCTION: acpi_tb_get_owner_id
495 * PARAMETERS: table_index - Table index
496 * owner_id - Where the table owner_id is returned
500 * DESCRIPTION: returns owner_id for the ACPI table
502 ******************************************************************************/
504 acpi_status
acpi_tb_get_owner_id(u32 table_index
, acpi_owner_id
*owner_id
)
506 acpi_status status
= AE_BAD_PARAMETER
;
508 ACPI_FUNCTION_TRACE(tb_get_owner_id
);
510 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
511 if (table_index
< acpi_gbl_root_table_list
.count
) {
513 acpi_gbl_root_table_list
.tables
[table_index
].owner_id
;
517 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
518 return_ACPI_STATUS(status
);
521 /*******************************************************************************
523 * FUNCTION: acpi_tb_is_table_loaded
525 * PARAMETERS: table_index - Table index
527 * RETURN: Table Loaded Flag
529 ******************************************************************************/
531 u8
acpi_tb_is_table_loaded(u32 table_index
)
533 u8 is_loaded
= FALSE
;
535 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
536 if (table_index
< acpi_gbl_root_table_list
.count
) {
538 (acpi_gbl_root_table_list
.tables
[table_index
].
539 flags
& ACPI_TABLE_IS_LOADED
);
542 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
546 /*******************************************************************************
548 * FUNCTION: acpi_tb_set_table_loaded_flag
550 * PARAMETERS: table_index - Table index
551 * is_loaded - TRUE if table is loaded, FALSE otherwise
555 * DESCRIPTION: Sets the table loaded flag to either TRUE or FALSE.
557 ******************************************************************************/
559 void acpi_tb_set_table_loaded_flag(u32 table_index
, u8 is_loaded
)
562 (void)acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
563 if (table_index
< acpi_gbl_root_table_list
.count
) {
565 acpi_gbl_root_table_list
.tables
[table_index
].flags
|=
566 ACPI_TABLE_IS_LOADED
;
568 acpi_gbl_root_table_list
.tables
[table_index
].flags
&=
569 ~ACPI_TABLE_IS_LOADED
;
573 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);