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 *****************************************************************************/
117 #include "accommon.h"
118 #include "actables.h"
120 #define _COMPONENT ACPI_TABLES
121 ACPI_MODULE_NAME ("tbinstal")
123 /* Local prototypes */
126 AcpiTbCompareTables (
127 ACPI_TABLE_DESC
*TableDesc
,
131 /*******************************************************************************
133 * FUNCTION: AcpiTbCompareTables
135 * PARAMETERS: TableDesc - Table 1 descriptor to be compared
136 * TableIndex - Index of table 2 to be compared
138 * RETURN: TRUE if both tables are identical.
140 * DESCRIPTION: This function compares a table with another table that has
141 * already been installed in the root table list.
143 ******************************************************************************/
146 AcpiTbCompareTables (
147 ACPI_TABLE_DESC
*TableDesc
,
150 ACPI_STATUS Status
= AE_OK
;
152 ACPI_TABLE_HEADER
*Table
;
157 Status
= AcpiTbAcquireTable (&AcpiGbl_RootTableList
.Tables
[TableIndex
],
158 &Table
, &TableLength
, &TableFlags
);
159 if (ACPI_FAILURE (Status
))
165 * Check for a table match on the entire table length,
166 * not just the header.
168 IsIdentical
= (BOOLEAN
)((TableDesc
->Length
!= TableLength
||
169 ACPI_MEMCMP (TableDesc
->Pointer
, Table
, TableLength
)) ?
172 /* Release the acquired table */
174 AcpiTbReleaseTable (Table
, TableLength
, TableFlags
);
175 return (IsIdentical
);
179 /*******************************************************************************
181 * FUNCTION: AcpiTbInstallTableWithOverride
183 * PARAMETERS: TableIndex - Index into root table array
184 * NewTableDesc - New table descriptor to install
185 * Override - Whether override should be performed
189 * DESCRIPTION: Install an ACPI table into the global data structure. The
190 * table override mechanism is called to allow the host
191 * OS to replace any table before it is installed in the root
194 ******************************************************************************/
197 AcpiTbInstallTableWithOverride (
199 ACPI_TABLE_DESC
*NewTableDesc
,
203 if (TableIndex
>= AcpiGbl_RootTableList
.CurrentTableCount
)
209 * ACPI Table Override:
211 * Before we install the table, let the host OS override it with a new
212 * one if desired. Any table within the RSDT/XSDT can be replaced,
213 * including the DSDT which is pointed to by the FADT.
217 AcpiTbOverrideTable (NewTableDesc
);
220 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList
.Tables
[TableIndex
],
221 NewTableDesc
->Address
, NewTableDesc
->Flags
, NewTableDesc
->Pointer
);
223 AcpiTbPrintTableHeader (NewTableDesc
->Address
, NewTableDesc
->Pointer
);
225 /* Set the global integer width (based upon revision of the DSDT) */
227 if (TableIndex
== ACPI_TABLE_INDEX_DSDT
)
229 AcpiUtSetIntegerWidth (NewTableDesc
->Pointer
->Revision
);
234 /*******************************************************************************
236 * FUNCTION: AcpiTbInstallFixedTable
238 * PARAMETERS: Address - Physical address of DSDT or FACS
239 * Signature - Table signature, NULL if no need to
241 * TableIndex - Index into root table array
245 * DESCRIPTION: Install a fixed ACPI table (DSDT/FACS) into the global data
248 ******************************************************************************/
251 AcpiTbInstallFixedTable (
252 ACPI_PHYSICAL_ADDRESS Address
,
256 ACPI_TABLE_DESC NewTableDesc
;
260 ACPI_FUNCTION_TRACE (TbInstallFixedTable
);
265 ACPI_ERROR ((AE_INFO
, "Null physical address for ACPI table [%s]",
267 return (AE_NO_MEMORY
);
270 /* Fill a table descriptor for validation */
272 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
273 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
274 if (ACPI_FAILURE (Status
))
276 ACPI_ERROR ((AE_INFO
, "Could not acquire table length at %p",
277 ACPI_CAST_PTR (void, Address
)));
278 return_ACPI_STATUS (Status
);
281 /* Validate and verify a table before installation */
283 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, Signature
);
284 if (ACPI_FAILURE (Status
))
289 AcpiTbInstallTableWithOverride (TableIndex
, &NewTableDesc
, TRUE
);
293 /* Release the temporary table descriptor */
295 AcpiTbReleaseTempTable (&NewTableDesc
);
296 return_ACPI_STATUS (Status
);
300 /*******************************************************************************
302 * FUNCTION: AcpiTbInstallStandardTable
304 * PARAMETERS: Address - Address of the table (might be a virtual
305 * address depending on the TableFlags)
306 * Flags - Flags for the table
307 * Reload - Whether reload should be performed
308 * Override - Whether override should be performed
309 * TableIndex - Where the table index is returned
313 * DESCRIPTION: This function is called to install an ACPI table that is
314 * neither DSDT nor FACS (a "standard" table.)
315 * When this function is called by "Load" or "LoadTable" opcodes,
316 * or by AcpiLoadTable() API, the "Reload" parameter is set.
317 * After sucessfully returning from this function, table is
318 * "INSTALLED" but not "VALIDATED".
320 ******************************************************************************/
323 AcpiTbInstallStandardTable (
324 ACPI_PHYSICAL_ADDRESS Address
,
331 ACPI_STATUS Status
= AE_OK
;
332 ACPI_TABLE_DESC NewTableDesc
;
335 ACPI_FUNCTION_TRACE (TbInstallStandardTable
);
338 /* Acquire a temporary table descriptor for validation */
340 Status
= AcpiTbAcquireTempTable (&NewTableDesc
, Address
, Flags
);
341 if (ACPI_FAILURE (Status
))
343 ACPI_ERROR ((AE_INFO
, "Could not acquire table length at %p",
344 ACPI_CAST_PTR (void, Address
)));
345 return_ACPI_STATUS (Status
);
349 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
350 * be useful for debugging ACPI problems on some machines.
353 AcpiGbl_DisableSsdtTableInstall
&&
354 ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
))
356 ACPI_INFO ((AE_INFO
, "Ignoring installation of %4.4s at %p",
357 NewTableDesc
.Signature
.Ascii
, ACPI_CAST_PTR (void, Address
)));
361 /* Validate and verify a table before installation */
363 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, NULL
);
364 if (ACPI_FAILURE (Status
))
372 * Validate the incoming table signature.
374 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
375 * 2) We added support for OEMx tables, signature "OEM".
376 * 3) Valid tables were encountered with a null signature, so we just
377 * gave up on validating the signature, (05/2008).
378 * 4) We encountered non-AML tables such as the MADT, which caused
379 * interpreter errors and kernel faults. So now, we once again allow
380 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
382 if ((NewTableDesc
.Signature
.Ascii
[0] != 0x00) &&
383 (!ACPI_COMPARE_NAME (&NewTableDesc
.Signature
, ACPI_SIG_SSDT
)) &&
384 (ACPI_STRNCMP (NewTableDesc
.Signature
.Ascii
, "OEM", 3)))
386 ACPI_BIOS_ERROR ((AE_INFO
,
387 "Table has invalid signature [%4.4s] (0x%8.8X), "
388 "must be SSDT or OEMx",
389 AcpiUtValidAcpiName (NewTableDesc
.Signature
.Ascii
) ?
390 NewTableDesc
.Signature
.Ascii
: "????",
391 NewTableDesc
.Signature
.Integer
));
393 Status
= AE_BAD_SIGNATURE
;
397 /* Check if table is already registered */
399 for (i
= 0; i
< AcpiGbl_RootTableList
.CurrentTableCount
; ++i
)
402 * Check for a table match on the entire table length,
403 * not just the header.
405 if (!AcpiTbCompareTables (&NewTableDesc
, i
))
411 * Note: the current mechanism does not unregister a table if it is
412 * dynamically unloaded. The related namespace entries are deleted,
413 * but the table remains in the root table list.
415 * The assumption here is that the number of different tables that
416 * will be loaded is actually small, and there is minimal overhead
417 * in just keeping the table in case it is needed again.
419 * If this assumption changes in the future (perhaps on large
420 * machines with many table load/unload operations), tables will
421 * need to be unregistered when they are unloaded, and slots in the
422 * root table list should be reused when empty.
424 if (AcpiGbl_RootTableList
.Tables
[i
].Flags
& ACPI_TABLE_IS_LOADED
)
426 /* Table is still loaded, this is an error */
428 Status
= AE_ALREADY_EXISTS
;
434 * Table was unloaded, allow it to be reloaded.
435 * As we are going to return AE_OK to the caller, we should
436 * take the responsibility of freeing the input descriptor.
437 * Refill the input descriptor to ensure
438 * AcpiTbInstallTableWithOverride() can be called again to
439 * indicate the re-installation.
441 AcpiTbUninstallTable (&NewTableDesc
);
443 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
444 return_ACPI_STATUS (AE_OK
);
449 /* Add the table to the global root table list */
451 Status
= AcpiTbGetNextRootIndex (&i
);
452 if (ACPI_FAILURE (Status
))
458 AcpiTbInstallTableWithOverride (i
, &NewTableDesc
, Override
);
462 /* Release the temporary table descriptor */
464 AcpiTbReleaseTempTable (&NewTableDesc
);
465 return_ACPI_STATUS (Status
);
469 /*******************************************************************************
471 * FUNCTION: AcpiTbOverrideTable
473 * PARAMETERS: OldTableDesc - Validated table descriptor to be
478 * DESCRIPTION: Attempt table override by calling the OSL override functions.
479 * Note: If the table is overridden, then the entire new table
480 * is acquired and returned by this function.
481 * Before/after invocation, the table descriptor is in a state
482 * that is "VALIDATED".
484 ******************************************************************************/
487 AcpiTbOverrideTable (
488 ACPI_TABLE_DESC
*OldTableDesc
)
492 ACPI_TABLE_DESC NewTableDesc
;
493 ACPI_TABLE_HEADER
*Table
;
494 ACPI_PHYSICAL_ADDRESS Address
;
498 /* (1) Attempt logical override (returns a logical address) */
500 Status
= AcpiOsTableOverride (OldTableDesc
->Pointer
, &Table
);
501 if (ACPI_SUCCESS (Status
) && Table
)
503 AcpiTbAcquireTempTable (&NewTableDesc
, ACPI_PTR_TO_PHYSADDR (Table
),
504 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
);
505 OverrideType
= "Logical";
509 /* (2) Attempt physical override (returns a physical address) */
511 Status
= AcpiOsPhysicalTableOverride (OldTableDesc
->Pointer
,
513 if (ACPI_SUCCESS (Status
) && Address
&& Length
)
515 AcpiTbAcquireTempTable (&NewTableDesc
, Address
,
516 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
);
517 OverrideType
= "Physical";
521 return; /* There was no override */
526 /* Validate and verify a table before overriding */
528 Status
= AcpiTbVerifyTempTable (&NewTableDesc
, NULL
);
529 if (ACPI_FAILURE (Status
))
534 ACPI_INFO ((AE_INFO
, "%4.4s " ACPI_PRINTF_UINT
535 " %s table override, new table: " ACPI_PRINTF_UINT
,
536 OldTableDesc
->Signature
.Ascii
,
537 ACPI_FORMAT_TO_UINT (OldTableDesc
->Address
),
538 OverrideType
, ACPI_FORMAT_TO_UINT (NewTableDesc
.Address
)));
540 /* We can now uninstall the original table */
542 AcpiTbUninstallTable (OldTableDesc
);
545 * Replace the original table descriptor and keep its state as
548 AcpiTbInitTableDescriptor (OldTableDesc
, NewTableDesc
.Address
,
549 NewTableDesc
.Flags
, NewTableDesc
.Pointer
);
550 AcpiTbValidateTempTable (OldTableDesc
);
552 /* Release the temporary table descriptor */
554 AcpiTbReleaseTempTable (&NewTableDesc
);
558 /*******************************************************************************
560 * FUNCTION: AcpiTbStoreTable
562 * PARAMETERS: Address - Table address
563 * Table - Table header
564 * Length - Table length
565 * Flags - Install flags
566 * TableIndex - Where the table index is returned
568 * RETURN: Status and table index.
570 * DESCRIPTION: Add an ACPI table to the global table list
572 ******************************************************************************/
576 ACPI_PHYSICAL_ADDRESS Address
,
577 ACPI_TABLE_HEADER
*Table
,
583 ACPI_TABLE_DESC
*TableDesc
;
586 Status
= AcpiTbGetNextRootIndex (TableIndex
);
587 if (ACPI_FAILURE (Status
))
592 /* Initialize added table */
594 TableDesc
= &AcpiGbl_RootTableList
.Tables
[*TableIndex
];
595 AcpiTbInitTableDescriptor (TableDesc
, Address
, Flags
, Table
);
596 TableDesc
->Pointer
= Table
;
601 /*******************************************************************************
603 * FUNCTION: AcpiTbUninstallTable
605 * PARAMETERS: TableDesc - Table descriptor
609 * DESCRIPTION: Delete one internal ACPI table
611 ******************************************************************************/
614 AcpiTbUninstallTable (
615 ACPI_TABLE_DESC
*TableDesc
)
618 ACPI_FUNCTION_TRACE (TbUninstallTable
);
621 /* Table must be installed */
623 if (!TableDesc
->Address
)
628 AcpiTbInvalidateTable (TableDesc
);
630 if ((TableDesc
->Flags
& ACPI_TABLE_ORIGIN_MASK
) ==
631 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL
)
633 ACPI_FREE (ACPI_CAST_PTR (void, TableDesc
->Address
));
636 TableDesc
->Address
= ACPI_PTR_TO_PHYSADDR (NULL
);