1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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>
45 #include <acpi/actables.h>
47 #define _COMPONENT ACPI_TABLES
48 ACPI_MODULE_NAME("tbinstal")
50 /* Local prototypes */
52 acpi_tb_match_signature(char *signature
,
53 struct acpi_table_desc
*table_info
, u8 search_type
);
55 /*******************************************************************************
57 * FUNCTION: acpi_tb_match_signature
59 * PARAMETERS: Signature - Table signature to match
60 * table_info - Return data
61 * search_type - Table type to match (primary/secondary)
65 * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned"
66 * tables (DSDT/FADT/SSDT, etc.) Returns the table_type_iD on match.
68 ******************************************************************************/
71 acpi_tb_match_signature(char *signature
,
72 struct acpi_table_desc
*table_info
, u8 search_type
)
76 ACPI_FUNCTION_TRACE("tb_match_signature");
78 /* Search for a signature match among the known table types */
80 for (i
= 0; i
< NUM_ACPI_TABLE_TYPES
; i
++) {
81 if (!(acpi_gbl_table_data
[i
].flags
& search_type
)) {
85 if (!ACPI_STRNCMP(signature
, acpi_gbl_table_data
[i
].signature
,
86 acpi_gbl_table_data
[i
].sig_length
)) {
87 /* Found a signature match, return index if requested */
90 table_info
->type
= (u8
) i
;
93 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
94 "Table [%4.4s] is an ACPI table consumed by the core subsystem\n",
95 (char *)acpi_gbl_table_data
[i
].
98 return_ACPI_STATUS(AE_OK
);
102 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
103 "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n",
106 return_ACPI_STATUS(AE_TABLE_NOT_SUPPORTED
);
109 /*******************************************************************************
111 * FUNCTION: acpi_tb_install_table
113 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
117 * DESCRIPTION: Install the table into the global data structures.
119 ******************************************************************************/
121 acpi_status
acpi_tb_install_table(struct acpi_table_desc
*table_info
)
125 ACPI_FUNCTION_TRACE("tb_install_table");
127 /* Lock tables while installing */
129 status
= acpi_ut_acquire_mutex(ACPI_MTX_TABLES
);
130 if (ACPI_FAILURE(status
)) {
131 ACPI_REPORT_ERROR(("Could not acquire table mutex, %s\n",
132 acpi_format_exception(status
)));
133 return_ACPI_STATUS(status
);
137 * Ignore a table that is already installed. For example, some BIOS
138 * ASL code will repeatedly attempt to load the same SSDT.
140 status
= acpi_tb_is_table_installed(table_info
);
141 if (ACPI_FAILURE(status
)) {
142 goto unlock_and_exit
;
145 /* Install the table into the global data structure */
147 status
= acpi_tb_init_table_descriptor(table_info
->type
, table_info
);
148 if (ACPI_FAILURE(status
)) {
149 ACPI_REPORT_ERROR(("Could not install table [%4.4s], %s\n",
150 table_info
->pointer
->signature
,
151 acpi_format_exception(status
)));
154 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "%s located at %p\n",
155 acpi_gbl_table_data
[table_info
->type
].name
,
156 table_info
->pointer
));
159 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
160 return_ACPI_STATUS(status
);
163 /*******************************************************************************
165 * FUNCTION: acpi_tb_recognize_table
167 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
168 * search_type - Table type to match (primary/secondary)
172 * DESCRIPTION: Check a table signature for a match against known table types
174 * NOTE: All table pointers are validated as follows:
175 * 1) Table pointer must point to valid physical memory
176 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
178 * 3) Table must be readable for length specified in the header
179 * 4) Table checksum must be valid (with the exception of the FACS
180 * which has no checksum for some odd reason)
182 ******************************************************************************/
185 acpi_tb_recognize_table(struct acpi_table_desc
*table_info
, u8 search_type
)
187 struct acpi_table_header
*table_header
;
190 ACPI_FUNCTION_TRACE("tb_recognize_table");
192 /* Ensure that we have a valid table pointer */
194 table_header
= (struct acpi_table_header
*)table_info
->pointer
;
196 return_ACPI_STATUS(AE_BAD_PARAMETER
);
200 * We only "recognize" a limited number of ACPI tables -- namely, the
201 * ones that are used by the subsystem (DSDT, FADT, etc.)
203 * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized.
204 * This can be any one of many valid ACPI tables, it just isn't one of
205 * the tables that is consumed by the core subsystem
207 status
= acpi_tb_match_signature(table_header
->signature
,
208 table_info
, search_type
);
209 if (ACPI_FAILURE(status
)) {
210 return_ACPI_STATUS(status
);
213 status
= acpi_tb_validate_table_header(table_header
);
214 if (ACPI_FAILURE(status
)) {
215 return_ACPI_STATUS(status
);
218 /* Return the table type and length via the info struct */
220 table_info
->length
= (acpi_size
) table_header
->length
;
222 return_ACPI_STATUS(status
);
225 /*******************************************************************************
227 * FUNCTION: acpi_tb_init_table_descriptor
229 * PARAMETERS: table_type - The type of the table
230 * table_info - A table info struct
234 * DESCRIPTION: Install a table into the global data structs.
236 ******************************************************************************/
239 acpi_tb_init_table_descriptor(acpi_table_type table_type
,
240 struct acpi_table_desc
*table_info
)
242 struct acpi_table_list
*list_head
;
243 struct acpi_table_desc
*table_desc
;
246 ACPI_FUNCTION_TRACE_U32("tb_init_table_descriptor", table_type
);
248 /* Allocate a descriptor for this table */
250 table_desc
= ACPI_MEM_CALLOCATE(sizeof(struct acpi_table_desc
));
252 return_ACPI_STATUS(AE_NO_MEMORY
);
255 /* Get a new owner ID for the table */
257 status
= acpi_ut_allocate_owner_id(&table_desc
->owner_id
);
258 if (ACPI_FAILURE(status
)) {
259 return_ACPI_STATUS(status
);
262 /* Install the table into the global data structure */
264 list_head
= &acpi_gbl_table_lists
[table_type
];
267 * Two major types of tables: 1) Only one instance is allowed. This
268 * includes most ACPI tables such as the DSDT. 2) Multiple instances of
269 * the table are allowed. This includes SSDT and PSDTs.
271 if (ACPI_IS_SINGLE_TABLE(acpi_gbl_table_data
[table_type
].flags
)) {
273 * Only one table allowed, and a table has alread been installed
274 * at this location, so return an error.
276 if (list_head
->next
) {
277 ACPI_MEM_FREE(table_desc
);
278 return_ACPI_STATUS(AE_ALREADY_EXISTS
);
281 table_desc
->next
= list_head
->next
;
282 list_head
->next
= table_desc
;
284 if (table_desc
->next
) {
285 table_desc
->next
->prev
= table_desc
;
291 * Link the new table in to the list of tables of this type.
292 * Insert at the end of the list, order IS IMPORTANT.
294 * table_desc->Prev & Next are already NULL from calloc()
298 if (!list_head
->next
) {
299 list_head
->next
= table_desc
;
301 table_desc
->next
= list_head
->next
;
303 while (table_desc
->next
->next
) {
304 table_desc
->next
= table_desc
->next
->next
;
307 table_desc
->next
->next
= table_desc
;
308 table_desc
->prev
= table_desc
->next
;
309 table_desc
->next
= NULL
;
313 /* Finish initialization of the table descriptor */
315 table_desc
->type
= (u8
) table_type
;
316 table_desc
->pointer
= table_info
->pointer
;
317 table_desc
->length
= table_info
->length
;
318 table_desc
->allocation
= table_info
->allocation
;
319 table_desc
->aml_start
= (u8
*) (table_desc
->pointer
+ 1),
320 table_desc
->aml_length
= (u32
) (table_desc
->length
-
323 table_desc
->loaded_into_namespace
= FALSE
;
326 * Set the appropriate global pointer (if there is one) to point to the
327 * newly installed table
329 if (acpi_gbl_table_data
[table_type
].global_ptr
) {
330 *(acpi_gbl_table_data
[table_type
].global_ptr
) =
336 table_info
->owner_id
= table_desc
->owner_id
;
337 table_info
->installed_desc
= table_desc
;
339 return_ACPI_STATUS(AE_OK
);
342 /*******************************************************************************
344 * FUNCTION: acpi_tb_delete_all_tables
350 * DESCRIPTION: Delete all internal ACPI tables
352 ******************************************************************************/
354 void acpi_tb_delete_all_tables(void)
356 acpi_table_type type
;
359 * Free memory allocated for ACPI tables
360 * Memory can either be mapped or allocated
362 for (type
= 0; type
< NUM_ACPI_TABLE_TYPES
; type
++) {
363 acpi_tb_delete_tables_by_type(type
);
367 /*******************************************************************************
369 * FUNCTION: acpi_tb_delete_tables_by_type
371 * PARAMETERS: Type - The table type to be deleted
375 * DESCRIPTION: Delete an internal ACPI table
376 * Locks the ACPI table mutex
378 ******************************************************************************/
380 void acpi_tb_delete_tables_by_type(acpi_table_type type
)
382 struct acpi_table_desc
*table_desc
;
386 ACPI_FUNCTION_TRACE_U32("tb_delete_tables_by_type", type
);
388 if (type
> ACPI_TABLE_MAX
) {
392 if (ACPI_FAILURE(acpi_ut_acquire_mutex(ACPI_MTX_TABLES
))) {
396 /* Clear the appropriate "typed" global table pointer */
399 case ACPI_TABLE_RSDP
:
400 acpi_gbl_RSDP
= NULL
;
403 case ACPI_TABLE_DSDT
:
404 acpi_gbl_DSDT
= NULL
;
407 case ACPI_TABLE_FADT
:
408 acpi_gbl_FADT
= NULL
;
411 case ACPI_TABLE_FACS
:
412 acpi_gbl_FACS
= NULL
;
415 case ACPI_TABLE_XSDT
:
416 acpi_gbl_XSDT
= NULL
;
419 case ACPI_TABLE_SSDT
:
420 case ACPI_TABLE_PSDT
:
427 * 1) Get the head of the list
429 table_desc
= acpi_gbl_table_lists
[type
].next
;
430 count
= acpi_gbl_table_lists
[type
].count
;
433 * 2) Walk the entire list, deleting both the allocated tables
434 * and the table descriptors
436 for (i
= 0; i
< count
; i
++) {
437 table_desc
= acpi_tb_uninstall_table(table_desc
);
440 (void)acpi_ut_release_mutex(ACPI_MTX_TABLES
);
444 /*******************************************************************************
446 * FUNCTION: acpi_tb_delete_single_table
448 * PARAMETERS: table_info - A table info struct
452 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where
453 * the table was allocated a buffer or was mapped.
455 ******************************************************************************/
457 void acpi_tb_delete_single_table(struct acpi_table_desc
*table_desc
)
460 /* Must have a valid table descriptor and pointer */
462 if ((!table_desc
) || (!table_desc
->pointer
)) {
466 /* Valid table, determine type of memory allocation */
468 switch (table_desc
->allocation
) {
469 case ACPI_MEM_NOT_ALLOCATED
:
472 case ACPI_MEM_ALLOCATED
:
474 ACPI_MEM_FREE(table_desc
->pointer
);
477 case ACPI_MEM_MAPPED
:
479 acpi_os_unmap_memory(table_desc
->pointer
, table_desc
->length
);
487 /*******************************************************************************
489 * FUNCTION: acpi_tb_uninstall_table
491 * PARAMETERS: table_info - A table info struct
493 * RETURN: Pointer to the next table in the list (of same type)
495 * DESCRIPTION: Free the memory associated with an internal ACPI table that
496 * is either installed or has never been installed.
497 * Table mutex should be locked.
499 ******************************************************************************/
501 struct acpi_table_desc
*acpi_tb_uninstall_table(struct acpi_table_desc
504 struct acpi_table_desc
*next_desc
;
506 ACPI_FUNCTION_TRACE_PTR("tb_uninstall_table", table_desc
);
512 /* Unlink the descriptor from the doubly linked list */
514 if (table_desc
->prev
) {
515 table_desc
->prev
->next
= table_desc
->next
;
517 /* Is first on list, update list head */
519 acpi_gbl_table_lists
[table_desc
->type
].next
= table_desc
->next
;
522 if (table_desc
->next
) {
523 table_desc
->next
->prev
= table_desc
->prev
;
526 /* Free the memory allocated for the table itself */
528 acpi_tb_delete_single_table(table_desc
);
530 /* Free the table descriptor */
532 next_desc
= table_desc
->next
;
533 ACPI_MEM_FREE(table_desc
);
535 /* Return pointer to the next descriptor */
537 return_PTR(next_desc
);