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.
45 #include <acpi/acpi.h>
46 #include <acpi/actables.h>
49 #define _COMPONENT ACPI_TABLES
50 ACPI_MODULE_NAME ("tbinstal")
52 /* Local prototypes */
55 acpi_tb_match_signature (
57 struct acpi_table_desc *table_info,
61 /*******************************************************************************
63 * FUNCTION: acpi_tb_match_signature
65 * PARAMETERS: Signature - Table signature to match
66 * table_info - Return data
67 * search_type - Table type to match (primary/secondary)
71 * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned"
72 * tables (DSDT/FADT/SSDT, etc.) Returns the table_type_iD on match.
74 ******************************************************************************/
77 acpi_tb_match_signature (
79 struct acpi_table_desc *table_info,
85 ACPI_FUNCTION_TRACE ("tb_match_signature");
88 /* Search for a signature match among the known table types */
90 for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++) {
91 if (!(acpi_gbl_table_data[i].flags & search_type)) {
95 if (!ACPI_STRNCMP (signature, acpi_gbl_table_data[i].signature,
96 acpi_gbl_table_data[i].sig_length)) {
97 /* Found a signature match, return index if requested */
100 table_info->type = (u8) i;
103 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
104 "Table [%4.4s] is an ACPI table consumed by the core subsystem\n",
105 (char *) acpi_gbl_table_data[i].signature));
107 return_ACPI_STATUS (AE_OK);
111 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
112 "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n",
113 (char *) signature));
115 return_ACPI_STATUS (AE_TABLE_NOT_SUPPORTED);
119 /*******************************************************************************
121 * FUNCTION: acpi_tb_install_table
123 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
127 * DESCRIPTION: Install the table into the global data structures.
129 ******************************************************************************/
132 acpi_tb_install_table (
133 struct acpi_table_desc *table_info)
138 ACPI_FUNCTION_TRACE ("tb_install_table");
141 /* Lock tables while installing */
143 status = acpi_ut_acquire_mutex (ACPI_MTX_TABLES);
144 if (ACPI_FAILURE (status)) {
145 ACPI_REPORT_ERROR (("Could not acquire table mutex, %s\n",
146 acpi_format_exception (status)));
147 return_ACPI_STATUS (status);
151 * Ignore a table that is already installed. For example, some BIOS
152 * ASL code will repeatedly attempt to load the same SSDT.
154 status = acpi_tb_is_table_installed (table_info);
155 if (ACPI_FAILURE (status)) {
156 goto unlock_and_exit;
159 /* Install the table into the global data structure */
161 status = acpi_tb_init_table_descriptor (table_info->type, table_info);
162 if (ACPI_FAILURE (status)) {
163 ACPI_REPORT_ERROR (("Could not install table [%4.4s], %s\n",
164 table_info->pointer->signature, acpi_format_exception (status)));
167 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "%s located at %p\n",
168 acpi_gbl_table_data[table_info->type].name, table_info->pointer));
172 (void) acpi_ut_release_mutex (ACPI_MTX_TABLES);
173 return_ACPI_STATUS (status);
177 /*******************************************************************************
179 * FUNCTION: acpi_tb_recognize_table
181 * PARAMETERS: table_info - Return value from acpi_tb_get_table_body
182 * search_type - Table type to match (primary/secondary)
186 * DESCRIPTION: Check a table signature for a match against known table types
188 * NOTE: All table pointers are validated as follows:
189 * 1) Table pointer must point to valid physical memory
190 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
192 * 3) Table must be readable for length specified in the header
193 * 4) Table checksum must be valid (with the exception of the FACS
194 * which has no checksum for some odd reason)
196 ******************************************************************************/
199 acpi_tb_recognize_table (
200 struct acpi_table_desc *table_info,
203 struct acpi_table_header *table_header;
207 ACPI_FUNCTION_TRACE ("tb_recognize_table");
210 /* Ensure that we have a valid table pointer */
212 table_header = (struct acpi_table_header *) table_info->pointer;
214 return_ACPI_STATUS (AE_BAD_PARAMETER);
218 * We only "recognize" a limited number of ACPI tables -- namely, the
219 * ones that are used by the subsystem (DSDT, FADT, etc.)
221 * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized.
222 * This can be any one of many valid ACPI tables, it just isn't one of
223 * the tables that is consumed by the core subsystem
225 status = acpi_tb_match_signature (table_header->signature,
226 table_info, search_type);
227 if (ACPI_FAILURE (status)) {
228 return_ACPI_STATUS (status);
231 status = acpi_tb_validate_table_header (table_header);
232 if (ACPI_FAILURE (status)) {
233 return_ACPI_STATUS (status);
236 /* Return the table type and length via the info struct */
238 table_info->length = (acpi_size) table_header->length;
240 return_ACPI_STATUS (status);
244 /*******************************************************************************
246 * FUNCTION: acpi_tb_init_table_descriptor
248 * PARAMETERS: table_type - The type of the table
249 * table_info - A table info struct
253 * DESCRIPTION: Install a table into the global data structs.
255 ******************************************************************************/
258 acpi_tb_init_table_descriptor (
259 acpi_table_type table_type,
260 struct acpi_table_desc *table_info)
262 struct acpi_table_list *list_head;
263 struct acpi_table_desc *table_desc;
267 ACPI_FUNCTION_TRACE_U32 ("tb_init_table_descriptor", table_type);
270 /* Allocate a descriptor for this table */
272 table_desc = ACPI_MEM_CALLOCATE (sizeof (struct acpi_table_desc));
274 return_ACPI_STATUS (AE_NO_MEMORY);
277 /* Get a new owner ID for the table */
279 status = acpi_ut_allocate_owner_id (&table_desc->owner_id);
280 if (ACPI_FAILURE (status)) {
281 return_ACPI_STATUS (status);
284 /* Install the table into the global data structure */
286 list_head = &acpi_gbl_table_lists[table_type];
289 * Two major types of tables: 1) Only one instance is allowed. This
290 * includes most ACPI tables such as the DSDT. 2) Multiple instances of
291 * the table are allowed. This includes SSDT and PSDTs.
293 if (ACPI_IS_SINGLE_TABLE (acpi_gbl_table_data[table_type].flags)) {
295 * Only one table allowed, and a table has alread been installed
296 * at this location, so return an error.
298 if (list_head->next) {
299 ACPI_MEM_FREE (table_desc);
300 return_ACPI_STATUS (AE_ALREADY_EXISTS);
303 table_desc->next = list_head->next;
304 list_head->next = table_desc;
306 if (table_desc->next) {
307 table_desc->next->prev = table_desc;
314 * Link the new table in to the list of tables of this type.
315 * Insert at the end of the list, order IS IMPORTANT.
317 * table_desc->Prev & Next are already NULL from calloc()
321 if (!list_head->next) {
322 list_head->next = table_desc;
325 table_desc->next = list_head->next;
327 while (table_desc->next->next) {
328 table_desc->next = table_desc->next->next;
331 table_desc->next->next = table_desc;
332 table_desc->prev = table_desc->next;
333 table_desc->next = NULL;
337 /* Finish initialization of the table descriptor */
339 table_desc->type = (u8) table_type;
340 table_desc->pointer = table_info->pointer;
341 table_desc->length = table_info->length;
342 table_desc->allocation = table_info->allocation;
343 table_desc->aml_start = (u8 *) (table_desc->pointer + 1),
344 table_desc->aml_length = (u32) (table_desc->length -
345 (u32) sizeof (struct acpi_table_header));
346 table_desc->loaded_into_namespace = FALSE;
349 * Set the appropriate global pointer (if there is one) to point to the
350 * newly installed table
352 if (acpi_gbl_table_data[table_type].global_ptr) {
353 *(acpi_gbl_table_data[table_type].global_ptr) = table_info->pointer;
358 table_info->owner_id = table_desc->owner_id;
359 table_info->installed_desc = table_desc;
361 return_ACPI_STATUS (AE_OK);
365 /*******************************************************************************
367 * FUNCTION: acpi_tb_delete_all_tables
373 * DESCRIPTION: Delete all internal ACPI tables
375 ******************************************************************************/
378 acpi_tb_delete_all_tables (
381 acpi_table_type type;
385 * Free memory allocated for ACPI tables
386 * Memory can either be mapped or allocated
388 for (type = 0; type < NUM_ACPI_TABLE_TYPES; type++) {
389 acpi_tb_delete_tables_by_type (type);
394 /*******************************************************************************
396 * FUNCTION: acpi_tb_delete_tables_by_type
398 * PARAMETERS: Type - The table type to be deleted
402 * DESCRIPTION: Delete an internal ACPI table
403 * Locks the ACPI table mutex
405 ******************************************************************************/
408 acpi_tb_delete_tables_by_type (
409 acpi_table_type type)
411 struct acpi_table_desc *table_desc;
416 ACPI_FUNCTION_TRACE_U32 ("tb_delete_tables_by_type", type);
419 if (type > ACPI_TABLE_MAX) {
423 if (ACPI_FAILURE (acpi_ut_acquire_mutex (ACPI_MTX_TABLES))) {
427 /* Clear the appropriate "typed" global table pointer */
430 case ACPI_TABLE_RSDP:
431 acpi_gbl_RSDP = NULL;
434 case ACPI_TABLE_DSDT:
435 acpi_gbl_DSDT = NULL;
438 case ACPI_TABLE_FADT:
439 acpi_gbl_FADT = NULL;
442 case ACPI_TABLE_FACS:
443 acpi_gbl_FACS = NULL;
446 case ACPI_TABLE_XSDT:
447 acpi_gbl_XSDT = NULL;
450 case ACPI_TABLE_SSDT:
451 case ACPI_TABLE_PSDT:
458 * 1) Get the head of the list
460 table_desc = acpi_gbl_table_lists[type].next;
461 count = acpi_gbl_table_lists[type].count;
464 * 2) Walk the entire list, deleting both the allocated tables
465 * and the table descriptors
467 for (i = 0; i < count; i++) {
468 table_desc = acpi_tb_uninstall_table (table_desc);
471 (void) acpi_ut_release_mutex (ACPI_MTX_TABLES);
476 /*******************************************************************************
478 * FUNCTION: acpi_tb_delete_single_table
480 * PARAMETERS: table_info - A table info struct
484 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where
485 * the table was allocated a buffer or was mapped.
487 ******************************************************************************/
490 acpi_tb_delete_single_table (
491 struct acpi_table_desc *table_desc)
494 /* Must have a valid table descriptor and pointer */
497 (!table_desc->pointer)) {
501 /* Valid table, determine type of memory allocation */
503 switch (table_desc->allocation) {
504 case ACPI_MEM_NOT_ALLOCATED:
507 case ACPI_MEM_ALLOCATED:
509 ACPI_MEM_FREE (table_desc->pointer);
512 case ACPI_MEM_MAPPED:
514 acpi_os_unmap_memory (table_desc->pointer, table_desc->length);
523 /*******************************************************************************
525 * FUNCTION: acpi_tb_uninstall_table
527 * PARAMETERS: table_info - A table info struct
529 * RETURN: Pointer to the next table in the list (of same type)
531 * DESCRIPTION: Free the memory associated with an internal ACPI table that
532 * is either installed or has never been installed.
533 * Table mutex should be locked.
535 ******************************************************************************/
537 struct acpi_table_desc *
538 acpi_tb_uninstall_table (
539 struct acpi_table_desc *table_desc)
541 struct acpi_table_desc *next_desc;
544 ACPI_FUNCTION_TRACE_PTR ("tb_uninstall_table", table_desc);
551 /* Unlink the descriptor from the doubly linked list */
553 if (table_desc->prev) {
554 table_desc->prev->next = table_desc->next;
557 /* Is first on list, update list head */
559 acpi_gbl_table_lists[table_desc->type].next = table_desc->next;
562 if (table_desc->next) {
563 table_desc->next->prev = table_desc->prev;
566 /* Free the memory allocated for the table itself */
568 acpi_tb_delete_single_table (table_desc);
570 /* Free the table descriptor */
572 next_desc = table_desc->next;
573 ACPI_MEM_FREE (table_desc);
575 /* Return pointer to the next descriptor */
577 return_PTR (next_desc);