1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #define __TBINSTAL_C__
121 #include "actables.h"
124 #define _COMPONENT ACPI_TABLES
125 ACPI_MODULE_NAME ("tbinstal")
128 /*******************************************************************************
130 * FUNCTION: AcpiTbMatchSignature
132 * PARAMETERS: Signature - Table signature to match
133 * TableInfo - Return data
137 * DESCRIPTION: Compare signature against the list of "ACPI-subsystem-owned"
138 * tables (DSDT/FADT/SSDT, etc.) Returns the TableTypeID on match.
140 ******************************************************************************/
143 AcpiTbMatchSignature (
145 ACPI_TABLE_DESC
*TableInfo
,
151 ACPI_FUNCTION_TRACE ("TbMatchSignature");
155 * Search for a signature match among the known table types
157 for (i
= 0; i
< NUM_ACPI_TABLE_TYPES
; i
++)
159 if (!(AcpiGbl_TableData
[i
].Flags
& SearchType
))
164 if (!ACPI_STRNCMP (Signature
, AcpiGbl_TableData
[i
].Signature
,
165 AcpiGbl_TableData
[i
].SigLength
))
167 /* Found a signature match, return index if requested */
171 TableInfo
->Type
= (UINT8
) i
;
174 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
175 "Table [%4.4s] is an ACPI table consumed by the core subsystem\n",
176 (char *) AcpiGbl_TableData
[i
].Signature
));
178 return_ACPI_STATUS (AE_OK
);
182 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
,
183 "Table [%4.4s] is not an ACPI table consumed by the core subsystem - ignored\n",
184 (char *) Signature
));
186 return_ACPI_STATUS (AE_TABLE_NOT_SUPPORTED
);
190 /*******************************************************************************
192 * FUNCTION: AcpiTbInstallTable
194 * PARAMETERS: TableInfo - Return value from AcpiTbGetTableBody
198 * DESCRIPTION: Load and validate all tables other than the RSDT. The RSDT must
199 * already be loaded and validated.
200 * Install the table into the global data structs.
202 ******************************************************************************/
206 ACPI_TABLE_DESC
*TableInfo
)
210 ACPI_FUNCTION_TRACE ("TbInstallTable");
213 /* Lock tables while installing */
215 Status
= AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
216 if (ACPI_FAILURE (Status
))
218 ACPI_REPORT_ERROR (("Could not acquire table mutex for [%4.4s], %s\n",
219 TableInfo
->Pointer
->Signature
, AcpiFormatException (Status
)));
220 return_ACPI_STATUS (Status
);
223 /* Install the table into the global data structure */
225 Status
= AcpiTbInitTableDescriptor (TableInfo
->Type
, TableInfo
);
226 if (ACPI_FAILURE (Status
))
228 ACPI_REPORT_ERROR (("Could not install ACPI table [%4.4s], %s\n",
229 TableInfo
->Pointer
->Signature
, AcpiFormatException (Status
)));
232 ACPI_DEBUG_PRINT ((ACPI_DB_INFO
, "%s located at %p\n",
233 AcpiGbl_TableData
[TableInfo
->Type
].Name
, TableInfo
->Pointer
));
235 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
236 return_ACPI_STATUS (Status
);
240 /*******************************************************************************
242 * FUNCTION: AcpiTbRecognizeTable
244 * PARAMETERS: TableInfo - Return value from AcpiTbGetTableBody
248 * DESCRIPTION: Check a table signature for a match against known table types
250 * NOTE: All table pointers are validated as follows:
251 * 1) Table pointer must point to valid physical memory
252 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
254 * 3) Table must be readable for length specified in the header
255 * 4) Table checksum must be valid (with the exception of the FACS
256 * which has no checksum for some odd reason)
258 ******************************************************************************/
261 AcpiTbRecognizeTable (
262 ACPI_TABLE_DESC
*TableInfo
,
265 ACPI_TABLE_HEADER
*TableHeader
;
269 ACPI_FUNCTION_TRACE ("TbRecognizeTable");
272 /* Ensure that we have a valid table pointer */
274 TableHeader
= (ACPI_TABLE_HEADER
*) TableInfo
->Pointer
;
277 return_ACPI_STATUS (AE_BAD_PARAMETER
);
281 * We only "recognize" a limited number of ACPI tables -- namely, the
282 * ones that are used by the subsystem (DSDT, FADT, etc.)
284 * An AE_TABLE_NOT_SUPPORTED means that the table was not recognized.
285 * This can be any one of many valid ACPI tables, it just isn't one of
286 * the tables that is consumed by the core subsystem
288 Status
= AcpiTbMatchSignature (TableHeader
->Signature
, TableInfo
, SearchType
);
289 if (ACPI_FAILURE (Status
))
291 return_ACPI_STATUS (Status
);
294 Status
= AcpiTbValidateTableHeader (TableHeader
);
295 if (ACPI_FAILURE (Status
))
297 return_ACPI_STATUS (Status
);
300 /* Return the table type and length via the info struct */
302 TableInfo
->Length
= (ACPI_SIZE
) TableHeader
->Length
;
304 return_ACPI_STATUS (Status
);
308 /*******************************************************************************
310 * FUNCTION: AcpiTbInitTableDescriptor
312 * PARAMETERS: TableType - The type of the table
313 * TableInfo - A table info struct
317 * DESCRIPTION: Install a table into the global data structs.
319 ******************************************************************************/
322 AcpiTbInitTableDescriptor (
323 ACPI_TABLE_TYPE TableType
,
324 ACPI_TABLE_DESC
*TableInfo
)
326 ACPI_TABLE_LIST
*ListHead
;
327 ACPI_TABLE_DESC
*TableDesc
;
330 ACPI_FUNCTION_TRACE_U32 ("TbInitTableDescriptor", TableType
);
333 /* Allocate a descriptor for this table */
335 TableDesc
= ACPI_MEM_CALLOCATE (sizeof (ACPI_TABLE_DESC
));
338 return_ACPI_STATUS (AE_NO_MEMORY
);
342 * Install the table into the global data structure
344 ListHead
= &AcpiGbl_TableLists
[TableType
];
347 * Two major types of tables: 1) Only one instance is allowed. This
348 * includes most ACPI tables such as the DSDT. 2) Multiple instances of
349 * the table are allowed. This includes SSDT and PSDTs.
351 if (ACPI_IS_SINGLE_TABLE (AcpiGbl_TableData
[TableType
].Flags
))
354 * Only one table allowed, and a table has alread been installed
355 * at this location, so return an error.
359 ACPI_MEM_FREE (TableDesc
);
360 return_ACPI_STATUS (AE_ALREADY_EXISTS
);
363 TableDesc
->Next
= ListHead
->Next
;
364 ListHead
->Next
= TableDesc
;
368 TableDesc
->Next
->Prev
= TableDesc
;
376 * Link the new table in to the list of tables of this type.
377 * Insert at the end of the list, order IS IMPORTANT.
379 * TableDesc->Prev & Next are already NULL from calloc()
385 ListHead
->Next
= TableDesc
;
389 TableDesc
->Next
= ListHead
->Next
;
391 while (TableDesc
->Next
->Next
)
393 TableDesc
->Next
= TableDesc
->Next
->Next
;
396 TableDesc
->Next
->Next
= TableDesc
;
397 TableDesc
->Prev
= TableDesc
->Next
;
398 TableDesc
->Next
= NULL
;
402 /* Finish initialization of the table descriptor */
404 TableDesc
->Type
= (UINT8
) TableType
;
405 TableDesc
->Pointer
= TableInfo
->Pointer
;
406 TableDesc
->Length
= TableInfo
->Length
;
407 TableDesc
->Allocation
= TableInfo
->Allocation
;
408 TableDesc
->AmlStart
= (UINT8
*) (TableDesc
->Pointer
+ 1),
409 TableDesc
->AmlLength
= (UINT32
) (TableDesc
->Length
-
410 (UINT32
) sizeof (ACPI_TABLE_HEADER
));
411 TableDesc
->TableId
= AcpiUtAllocateOwnerId (ACPI_OWNER_TYPE_TABLE
);
412 TableDesc
->LoadedIntoNamespace
= FALSE
;
415 * Set the appropriate global pointer (if there is one) to point to the
416 * newly installed table
418 if (AcpiGbl_TableData
[TableType
].GlobalPtr
)
420 *(AcpiGbl_TableData
[TableType
].GlobalPtr
) = TableInfo
->Pointer
;
425 TableInfo
->TableId
= TableDesc
->TableId
;
426 TableInfo
->InstalledDesc
= TableDesc
;
428 return_ACPI_STATUS (AE_OK
);
432 /*******************************************************************************
434 * FUNCTION: AcpiTbDeleteAllTables
440 * DESCRIPTION: Delete all internal ACPI tables
442 ******************************************************************************/
445 AcpiTbDeleteAllTables (void)
447 ACPI_TABLE_TYPE Type
;
451 * Free memory allocated for ACPI tables
452 * Memory can either be mapped or allocated
454 for (Type
= 0; Type
< NUM_ACPI_TABLE_TYPES
; Type
++)
456 AcpiTbDeleteTablesByType (Type
);
461 /*******************************************************************************
463 * FUNCTION: AcpiTbDeleteTablesByType
465 * PARAMETERS: Type - The table type to be deleted
469 * DESCRIPTION: Delete an internal ACPI table
470 * Locks the ACPI table mutex
472 ******************************************************************************/
475 AcpiTbDeleteTablesByType (
476 ACPI_TABLE_TYPE Type
)
478 ACPI_TABLE_DESC
*TableDesc
;
483 ACPI_FUNCTION_TRACE_U32 ("TbDeleteTablesByType", Type
);
486 if (Type
> ACPI_TABLE_MAX
)
491 if (ACPI_FAILURE (AcpiUtAcquireMutex (ACPI_MTX_TABLES
)))
496 /* Clear the appropriate "typed" global table pointer */
500 case ACPI_TABLE_RSDP
:
504 case ACPI_TABLE_DSDT
:
508 case ACPI_TABLE_FADT
:
512 case ACPI_TABLE_FACS
:
516 case ACPI_TABLE_XSDT
:
520 case ACPI_TABLE_SSDT
:
521 case ACPI_TABLE_PSDT
:
528 * 1) Get the head of the list
530 TableDesc
= AcpiGbl_TableLists
[Type
].Next
;
531 Count
= AcpiGbl_TableLists
[Type
].Count
;
534 * 2) Walk the entire list, deleting both the allocated tables
535 * and the table descriptors
537 for (i
= 0; i
< Count
; i
++)
539 TableDesc
= AcpiTbUninstallTable (TableDesc
);
542 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
547 /*******************************************************************************
549 * FUNCTION: AcpiTbDeleteSingleTable
551 * PARAMETERS: TableInfo - A table info struct
555 * DESCRIPTION: Low-level free for a single ACPI table. Handles cases where
556 * the table was allocated a buffer or was mapped.
558 ******************************************************************************/
561 AcpiTbDeleteSingleTable (
562 ACPI_TABLE_DESC
*TableDesc
)
565 /* Must have a valid table descriptor and pointer */
568 (!TableDesc
->Pointer
))
573 /* Valid table, determine type of memory allocation */
575 switch (TableDesc
->Allocation
)
577 case ACPI_MEM_NOT_ALLOCATED
:
580 case ACPI_MEM_ALLOCATED
:
582 ACPI_MEM_FREE (TableDesc
->Pointer
);
585 case ACPI_MEM_MAPPED
:
587 AcpiOsUnmapMemory (TableDesc
->Pointer
, TableDesc
->Length
);
596 /*******************************************************************************
598 * FUNCTION: AcpiTbUninstallTable
600 * PARAMETERS: TableInfo - A table info struct
602 * RETURN: Pointer to the next table in the list (of same type)
604 * DESCRIPTION: Free the memory associated with an internal ACPI table that
605 * is either installed or has never been installed.
606 * Table mutex should be locked.
608 ******************************************************************************/
611 AcpiTbUninstallTable (
612 ACPI_TABLE_DESC
*TableDesc
)
614 ACPI_TABLE_DESC
*NextDesc
;
617 ACPI_FUNCTION_TRACE_PTR ("TbUninstallTable", TableDesc
);
625 /* Unlink the descriptor from the doubly linked list */
629 TableDesc
->Prev
->Next
= TableDesc
->Next
;
633 /* Is first on list, update list head */
635 AcpiGbl_TableLists
[TableDesc
->Type
].Next
= TableDesc
->Next
;
640 TableDesc
->Next
->Prev
= TableDesc
->Prev
;
643 /* Free the memory allocated for the table itself */
645 AcpiTbDeleteSingleTable (TableDesc
);
647 /* Free the table descriptor */
649 NextDesc
= TableDesc
->Next
;
650 ACPI_MEM_FREE (TableDesc
);
652 /* Return pointer to the next descriptor */
654 return_PTR (NextDesc
);