1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #define __TBINSTAL_C__
119 #include "accommon.h"
120 #include "actables.h"
122 #define _COMPONENT ACPI_TABLES
123 ACPI_MODULE_NAME ("tbinstal")
125 /* Local prototypes */
128 AcpiTbCompareTables (
129 ACPI_TABLE_DESC
*TableDesc
,
133 /*******************************************************************************
135 * FUNCTION: AcpiTbCompareTables
137 * PARAMETERS: TableDesc - Table 1 descriptor to be compared
138 * TableIndex - Index of table 2 to be compared
140 * RETURN: TRUE if both tables are identical.
142 * DESCRIPTION: This function compares a table with another table that has
143 * already been installed in the root table list.
145 ******************************************************************************/
148 AcpiTbCompareTables (
149 ACPI_TABLE_DESC
*TableDesc
,
152 ACPI_STATUS Status
= AE_OK
;
154 ACPI_TABLE_HEADER
*Table
;
159 Status
= AcpiTbAcquireTable (&AcpiGbl_RootTableList
.Tables
[TableIndex
],
160 &Table
, &TableLength
, &TableFlags
);
161 if (ACPI_FAILURE (Status
))
167 * Check for a table match on the entire table length,
168 * not just the header.
170 IsIdentical
= (BOOLEAN
)((TableDesc
->Length
!= TableLength
||
171 ACPI_MEMCMP (TableDesc
->Pointer
, Table
, TableLength
)) ?
174 /* Release the acquired table */
176 AcpiTbReleaseTable (Table
, TableLength
, TableFlags
);
177 return (IsIdentical
);
181 /*******************************************************************************
183 * FUNCTION: AcpiTbInstallTableWithOverride
185 * PARAMETERS: TableIndex - Index into root table array
186 * NewTableDesc - New table descriptor to install
187 * Override - Whether override should be performed
191 * DESCRIPTION: Install an ACPI table into the global data structure. The
192 * table override mechanism is called to allow the host
193 * OS to replace any table before it is installed in the root
196 ******************************************************************************/
199 AcpiTbInstallTableWithOverride (
201 ACPI_TABLE_DESC
*NewTableDesc
,
205 if (TableIndex
>= AcpiGbl_RootTableList
.CurrentTableCount
)
211 * ACPI Table Override:
213 * Before we install the table, let the host OS override it with a new
214 * one if desired. Any table within the RSDT/XSDT can be replaced,
215 * including the DSDT which is pointed to by the FADT.
219 AcpiTbOverrideTable (NewTableDesc
);
222 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList
.Tables
[TableIndex
],
223 NewTableDesc
->Address
, NewTableDesc
->Flags
, NewTableDesc
->Pointer
);
225 AcpiTbPrintTableHeader (NewTableDesc
->Address
, NewTableDesc
->Pointer
);
227 /* Set the global integer width (based upon revision of the DSDT) */
229 if (TableIndex
== ACPI_TABLE_INDEX_DSDT
)
231 AcpiUtSetIntegerWidth (NewTableDesc
->Pointer
->Revision
);
236 /*******************************************************************************
238 * FUNCTION: AcpiTbInstallFixedTable
240 * PARAMETERS: Address - Physical address of DSDT or FACS
241 * Signature - Table signature, NULL if no need to
243 * TableIndex - Index into root table array
247 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data
250 ******************************************************************************/
253 AcpiTbInstallFixedTable (
254 ACPI_PHYSICAL_ADDRESS Address
,
258 ACPI_TABLE_DESC NewTableDesc
;
262 ACPI_FUNCTION_TRACE (TbInstallFixedTable
);
267 ACPI_ERROR ((AE_INFO
, "Null physical address for ACPI table [%s]",
269 return (AE_NO_MEMORY
);
272 /* Fill a table descriptor for validation */
274 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
275 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
276 if (ACPI_FAILURE (Status
))
278 ACPI_ERROR ((AE_INFO
, "Could not acquire table length at %p",
279 ACPI_CAST_PTR (void, Address
)));
280 return_ACPI_STATUS (Status
);
283 /* Validate and verify a table before installation */
285 Status
= AcpiTbVerifyTable (&NewTableDesc
, Signature
);
286 if (ACPI_FAILURE (Status
))
291 AcpiTbInstallTableWithOverride (TableIndex
, &NewTableDesc
, TRUE
);
295 /* Release the temporary table descriptor */
297 AcpiTbReleaseTempTable (&NewTableDesc
);
298 return_ACPI_STATUS (Status
);
302 /*******************************************************************************
304 * FUNCTION: AcpiTbInstallStandardTable
306 * PARAMETERS: Address - Address of the table (might be a virtual
307 * address depending on the TableFlags)
308 * Flags - Flags for the table
309 * Reload - Whether reload should be performed
310 * Override - Whether override should be performed
311 * TableIndex - Where the table index is returned
315 * DESCRIPTION: This function is called to install an ACPI table that is
316 * neither DSDT nor FACS (a "standard" table.)
317 * When this function is called by "Load" or "LoadTable" opcodes,
318 * or by AcpiLoadTable() API, the "Reload" parameter is set.
319 * After sucessfully returning from this function, table is
320 * "INSTALLED" but not "VALIDATED".
322 ******************************************************************************/
325 AcpiTbInstallStandardTable (
326 ACPI_PHYSICAL_ADDRESS Address
,
333 ACPI_STATUS Status
= AE_OK
;
334 ACPI_TABLE_DESC NewTableDesc
;
337 ACPI_FUNCTION_TRACE (TbInstallStandardTable
);
340 /* Acquire a temporary table descriptor for validation */
342 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
, Flags
);
343 if (ACPI_FAILURE (Status
))
345 ACPI_ERROR ((AE_INFO
, "Could not acquire table length at %p",
346 ACPI_CAST_PTR (void, Address
)));
347 return_ACPI_STATUS (Status
);
351 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
352 * be useful for debugging ACPI problems on some machines.
355 AcpiGbl_DisableSsdtTableInstall
&&
356 ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
))
358 ACPI_INFO ((AE_INFO
, "Ignoring installation of %4.4s at %p",
359 NewTableDesc
.Signature
.Ascii
, ACPI_CAST_PTR (void, Address
)));
363 /* Validate and verify a table before installation */
365 Status
= AcpiTbVerifyTable (&NewTableDesc
, NULL
);
366 if (ACPI_FAILURE (Status
))
374 * Validate the incoming table signature.
376 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
377 * 2) We added support for OEMx tables, signature "OEM".
378 * 3) Valid tables were encountered with a null signature, so we just
379 * gave up on validating the signature, (05/2008).
380 * 4) We encountered non-AML tables such as the MADT, which caused
381 * interpreter errors and kernel faults. So now, we once again allow
382 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
384 if ((NewTableDesc
.Signature
.Ascii
[0] != 0x00) &&
385 (!ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
)) &&
386 (ACPI_STRNCMP (NewTableDesc
.Signature
.Ascii
, "OEM", 3)))
388 ACPI_BIOS_ERROR ((AE_INFO
,
389 "Table has invalid signature [%4.4s] (0x%8.8X), "
390 "must be SSDT or OEMx",
391 AcpiUtValidAcpiName (NewTableDesc
.Signature
.Ascii
) ?
392 NewTableDesc
.Signature
.Ascii
: "????",
393 NewTableDesc
.Signature
.Integer
));
395 Status
= AE_BAD_SIGNATURE
;
399 /* Check if table is already registered */
401 for (i
= 0; i
< AcpiGbl_RootTableList
.CurrentTableCount
; ++i
)
404 * Check for a table match on the entire table length,
405 * not just the header.
407 if (!AcpiTbCompareTables (&NewTableDesc
, i
))
413 * Note: the current mechanism does not unregister a table if it is
414 * dynamically unloaded. The related namespace entries are deleted,
415 * but the table remains in the root table list.
417 * The assumption here is that the number of different tables that
418 * will be loaded is actually small, and there is minimal overhead
419 * in just keeping the table in case it is needed again.
421 * If this assumption changes in the future (perhaps on large
422 * machines with many table load/unload operations), tables will
423 * need to be unregistered when they are unloaded, and slots in the
424 * root table list should be reused when empty.
426 if (AcpiGbl_RootTableList
.Tables
[i
].Flags
& ACPI_TABLE_IS_LOADED
)
428 /* Table is still loaded, this is an error */
430 Status
= AE_ALREADY_EXISTS
;
436 * Table was unloaded, allow it to be reloaded.
437 * As we are going to return AE_OK to the caller, we should
438 * take the responsibility of freeing the input descriptor.
439 * Refill the input descriptor to ensure
440 * AcpiTbInstallTableWithOverride() can be called again to
441 * indicate the re-installation.
443 AcpiTbUninstallTable (&NewTableDesc
);
445 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
446 return_ACPI_STATUS (AE_OK
);
451 /* Add the table to the global root table list */
453 Status
= AcpiTbGetNextRootIndex (&i
);
454 if (ACPI_FAILURE (Status
))
460 AcpiTbInstallTableWithOverride (i
, &NewTableDesc
, Override
);
464 /* Release the temporary table descriptor */
466 AcpiTbReleaseTempTable (&NewTableDesc
);
467 return_ACPI_STATUS (Status
);
471 /*******************************************************************************
473 * FUNCTION: AcpiTbOverrideTable
475 * PARAMETERS: OldTableDesc - Validated table descriptor to be
480 * DESCRIPTION: Attempt table override by calling the OSL override functions.
481 * Note: If the table is overridden, then the entire new table
482 * is acquired and returned by this function.
483 * Before/after invocation, the table descriptor is in a state
484 * that is "VALIDATED".
486 ******************************************************************************/
489 AcpiTbOverrideTable (
490 ACPI_TABLE_DESC
*OldTableDesc
)
494 ACPI_TABLE_DESC NewTableDesc
;
495 ACPI_TABLE_HEADER
*Table
;
496 ACPI_PHYSICAL_ADDRESS Address
;
500 /* (1) Attempt logical override (returns a logical address) */
502 Status
= AcpiOsTableOverride (OldTableDesc
->Pointer
, &Table
);
503 if (ACPI_SUCCESS (Status
) && Table
)
505 AcpiTbAcquireTempTable (&NewTableDesc
, ACPI_PTR_TO_PHYSADDR (Table
),
506 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
);
507 OverrideType
= "Logical";
511 /* (2) Attempt physical override (returns a physical address) */
513 Status
= AcpiOsPhysicalTableOverride (OldTableDesc
->Pointer
,
515 if (ACPI_SUCCESS (Status
) && Address
&& Length
)
517 AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
518 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
519 OverrideType
= "Physical";
523 return; /* There was no override */
528 /* Validate and verify a table before overriding */
530 Status
= AcpiTbVerifyTable (&NewTableDesc
, NULL
);
531 if (ACPI_FAILURE (Status
))
536 ACPI_INFO ((AE_INFO
, "%4.4s " ACPI_PRINTF_UINT
537 " %s table override, new table: " ACPI_PRINTF_UINT
,
538 OldTableDesc
->Signature
.Ascii
,
539 ACPI_FORMAT_TO_UINT (OldTableDesc
->Address
),
540 OverrideType
, ACPI_FORMAT_TO_UINT (NewTableDesc
.Address
)));
542 /* We can now uninstall the original table */
544 AcpiTbUninstallTable (OldTableDesc
);
547 * Replace the original table descriptor and keep its state as
550 AcpiTbInitTableDescriptor (OldTableDesc
, NewTableDesc
.Address
,
551 NewTableDesc
.Flags
, NewTableDesc
.Pointer
);
552 AcpiTbValidateTable (OldTableDesc
);
554 /* Release the temporary table descriptor */
556 AcpiTbReleaseTempTable (&NewTableDesc
);
560 /*******************************************************************************
562 * FUNCTION: AcpiTbStoreTable
564 * PARAMETERS: Address - Table address
565 * Table - Table header
566 * Length - Table length
567 * Flags - Install flags
568 * TableIndex - Where the table index is returned
570 * RETURN: Status and table index.
572 * DESCRIPTION: Add an ACPI table to the global table list
574 ******************************************************************************/
578 ACPI_PHYSICAL_ADDRESS Address
,
579 ACPI_TABLE_HEADER
*Table
,
585 ACPI_TABLE_DESC
*TableDesc
;
588 Status
= AcpiTbGetNextRootIndex (TableIndex
);
589 if (ACPI_FAILURE (Status
))
594 /* Initialize added table */
596 TableDesc
= &AcpiGbl_RootTableList
.Tables
[*TableIndex
];
597 AcpiTbInitTableDescriptor (TableDesc
, Address
, Flags
, Table
);
598 TableDesc
->Pointer
= Table
;
603 /*******************************************************************************
605 * FUNCTION: AcpiTbUninstallTable
607 * PARAMETERS: TableDesc - Table descriptor
611 * DESCRIPTION: Delete one internal ACPI table
613 ******************************************************************************/
616 AcpiTbUninstallTable (
617 ACPI_TABLE_DESC
*TableDesc
)
620 ACPI_FUNCTION_TRACE (TbUninstallTable
);
623 /* Table must be installed */
625 if (!TableDesc
->Address
)
630 AcpiTbInvalidateTable (TableDesc
);
632 if ((TableDesc
->Flags
& ACPI_TABLE_ORIGIN_MASK
) ==
633 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL
)
635 ACPI_FREE (ACPI_CAST_PTR (void, TableDesc
->Address
));
638 TableDesc
->Address
= ACPI_PTR_TO_PHYSADDR (NULL
);