1 /******************************************************************************
3 * Module Name: tbinstal - ACPI table installation and removal
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, 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 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/actables.h>
156 #define _COMPONENT ACPI_TABLES
157 ACPI_MODULE_NAME ("tbinstal")
159 /* Local prototypes */
162 AcpiTbCompareTables (
163 ACPI_TABLE_DESC *TableDesc,
167 /*******************************************************************************
169 * FUNCTION: AcpiTbCompareTables
171 * PARAMETERS: TableDesc - Table 1 descriptor to be compared
172 * TableIndex - Index of table 2 to be compared
174 * RETURN: TRUE if both tables are identical.
176 * DESCRIPTION: This function compares a table with another table that has
177 * already been installed in the root table list.
179 ******************************************************************************/
182 AcpiTbCompareTables (
183 ACPI_TABLE_DESC *TableDesc,
186 ACPI_STATUS Status = AE_OK;
188 ACPI_TABLE_HEADER *Table;
193 Status = AcpiTbAcquireTable (&AcpiGbl_RootTableList.Tables[TableIndex],
194 &Table, &TableLength, &TableFlags);
195 if (ACPI_FAILURE (Status))
201 * Check for a table match on the entire table length,
202 * not just the header.
204 IsIdentical = (BOOLEAN)((TableDesc->Length != TableLength ||
205 memcmp (TableDesc->Pointer, Table, TableLength)) ?
208 /* Release the acquired table */
210 AcpiTbReleaseTable (Table, TableLength, TableFlags);
211 return (IsIdentical);
215 /*******************************************************************************
217 * FUNCTION: AcpiTbInstallTableWithOverride
219 * PARAMETERS: NewTableDesc - New table descriptor to install
220 * Override - Whether override should be performed
221 * TableIndex - Where the table index is returned
225 * DESCRIPTION: Install an ACPI table into the global data structure. The
226 * table override mechanism is called to allow the host
227 * OS to replace any table before it is installed in the root
230 ******************************************************************************/
233 AcpiTbInstallTableWithOverride (
234 ACPI_TABLE_DESC *NewTableDesc,
242 Status = AcpiTbGetNextTableDescriptor (&i, NULL);
243 if (ACPI_FAILURE (Status))
249 * ACPI Table Override:
251 * Before we install the table, let the host OS override it with a new
252 * one if desired. Any table within the RSDT/XSDT can be replaced,
253 * including the DSDT which is pointed to by the FADT.
257 AcpiTbOverrideTable (NewTableDesc);
260 AcpiTbInitTableDescriptor (&AcpiGbl_RootTableList.Tables[i],
261 NewTableDesc->Address, NewTableDesc->Flags, NewTableDesc->Pointer);
263 AcpiTbPrintTableHeader (NewTableDesc->Address, NewTableDesc->Pointer);
265 /* This synchronizes AcpiGbl_DsdtIndex */
269 /* Set the global integer width (based upon revision of the DSDT) */
271 if (i == AcpiGbl_DsdtIndex)
273 AcpiUtSetIntegerWidth (NewTableDesc->Pointer->Revision);
278 /*******************************************************************************
280 * FUNCTION: AcpiTbInstallStandardTable
282 * PARAMETERS: Address - Address of the table (might be a virtual
283 * address depending on the TableFlags)
284 * Flags - Flags for the table
285 * Reload - Whether reload should be performed
286 * Override - Whether override should be performed
287 * TableIndex - Where the table index is returned
291 * DESCRIPTION: This function is called to verify and install an ACPI table.
292 * When this function is called by "Load" or "LoadTable" opcodes,
293 * or by AcpiLoadTable() API, the "Reload" parameter is set.
294 * After sucessfully returning from this function, table is
295 * "INSTALLED" but not "VALIDATED".
297 ******************************************************************************/
300 AcpiTbInstallStandardTable (
301 ACPI_PHYSICAL_ADDRESS Address,
308 ACPI_STATUS Status = AE_OK;
309 ACPI_TABLE_DESC NewTableDesc;
312 ACPI_FUNCTION_TRACE (TbInstallStandardTable);
315 /* Acquire a temporary table descriptor for validation */
317 Status = AcpiTbAcquireTempTable (&NewTableDesc, Address, Flags);
318 if (ACPI_FAILURE (Status))
320 ACPI_ERROR ((AE_INFO,
321 "Could not acquire table length at %8.8X%8.8X",
322 ACPI_FORMAT_UINT64 (Address)));
323 return_ACPI_STATUS (Status);
327 * Optionally do not load any SSDTs from the RSDT/XSDT. This can
328 * be useful for debugging ACPI problems on some machines.
331 AcpiGbl_DisableSsdtTableInstall &&
332 ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT))
335 "Ignoring installation of %4.4s at %8.8X%8.8X",
336 NewTableDesc.Signature.Ascii, ACPI_FORMAT_UINT64 (Address)));
340 /* Validate and verify a table before installation */
342 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL);
343 if (ACPI_FAILURE (Status))
351 * Validate the incoming table signature.
353 * 1) Originally, we checked the table signature for "SSDT" or "PSDT".
354 * 2) We added support for OEMx tables, signature "OEM".
355 * 3) Valid tables were encountered with a null signature, so we just
356 * gave up on validating the signature, (05/2008).
357 * 4) We encountered non-AML tables such as the MADT, which caused
358 * interpreter errors and kernel faults. So now, we once again allow
359 * only "SSDT", "OEMx", and now, also a null signature. (05/2011).
361 if ((NewTableDesc.Signature.Ascii[0] != 0x00) &&
362 (!ACPI_COMPARE_NAME (&NewTableDesc.Signature, ACPI_SIG_SSDT)) &&
363 (strncmp (NewTableDesc.Signature.Ascii, "OEM", 3)))
365 ACPI_BIOS_ERROR ((AE_INFO,
366 "Table has invalid signature [%4.4s] (0x%8.8X), "
367 "must be SSDT or OEMx",
368 AcpiUtValidNameseg (NewTableDesc.Signature.Ascii) ?
369 NewTableDesc.Signature.Ascii : "????",
370 NewTableDesc.Signature.Integer));
372 Status = AE_BAD_SIGNATURE;
376 /* Check if table is already registered */
378 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
381 * Check for a table match on the entire table length,
382 * not just the header.
384 if (!AcpiTbCompareTables (&NewTableDesc, i))
390 * Note: the current mechanism does not unregister a table if it is
391 * dynamically unloaded. The related namespace entries are deleted,
392 * but the table remains in the root table list.
394 * The assumption here is that the number of different tables that
395 * will be loaded is actually small, and there is minimal overhead
396 * in just keeping the table in case it is needed again.
398 * If this assumption changes in the future (perhaps on large
399 * machines with many table load/unload operations), tables will
400 * need to be unregistered when they are unloaded, and slots in the
401 * root table list should be reused when empty.
403 if (AcpiGbl_RootTableList.Tables[i].Flags &
404 ACPI_TABLE_IS_LOADED)
406 /* Table is still loaded, this is an error */
408 Status = AE_ALREADY_EXISTS;
414 * Table was unloaded, allow it to be reloaded.
415 * As we are going to return AE_OK to the caller, we should
416 * take the responsibility of freeing the input descriptor.
417 * Refill the input descriptor to ensure
418 * AcpiTbInstallTableWithOverride() can be called again to
419 * indicate the re-installation.
421 AcpiTbUninstallTable (&NewTableDesc);
423 return_ACPI_STATUS (AE_OK);
428 /* Add the table to the global root table list */
430 AcpiTbInstallTableWithOverride (&NewTableDesc, Override, TableIndex);
432 /* Invoke table handler if present */
434 if (AcpiGbl_TableHandler)
436 (void) AcpiGbl_TableHandler (ACPI_TABLE_EVENT_INSTALL,
437 NewTableDesc.Pointer, AcpiGbl_TableHandlerContext);
442 /* Release the temporary table descriptor */
444 AcpiTbReleaseTempTable (&NewTableDesc);
445 return_ACPI_STATUS (Status);
449 /*******************************************************************************
451 * FUNCTION: AcpiTbOverrideTable
453 * PARAMETERS: OldTableDesc - Validated table descriptor to be
458 * DESCRIPTION: Attempt table override by calling the OSL override functions.
459 * Note: If the table is overridden, then the entire new table
460 * is acquired and returned by this function.
461 * Before/after invocation, the table descriptor is in a state
462 * that is "VALIDATED".
464 ******************************************************************************/
467 AcpiTbOverrideTable (
468 ACPI_TABLE_DESC *OldTableDesc)
472 ACPI_TABLE_DESC NewTableDesc;
473 ACPI_TABLE_HEADER *Table;
474 ACPI_PHYSICAL_ADDRESS Address;
478 /* (1) Attempt logical override (returns a logical address) */
480 Status = AcpiOsTableOverride (OldTableDesc->Pointer, &Table);
481 if (ACPI_SUCCESS (Status) && Table)
483 AcpiTbAcquireTempTable (&NewTableDesc, ACPI_PTR_TO_PHYSADDR (Table),
484 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL);
485 OverrideType = "Logical";
489 /* (2) Attempt physical override (returns a physical address) */
491 Status = AcpiOsPhysicalTableOverride (OldTableDesc->Pointer,
493 if (ACPI_SUCCESS (Status) && Address && Length)
495 AcpiTbAcquireTempTable (&NewTableDesc, Address,
496 ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL);
497 OverrideType = "Physical";
501 return; /* There was no override */
506 /* Validate and verify a table before overriding */
508 Status = AcpiTbVerifyTempTable (&NewTableDesc, NULL);
509 if (ACPI_FAILURE (Status))
514 ACPI_INFO (("%4.4s 0x%8.8X%8.8X"
515 " %s table override, new table: 0x%8.8X%8.8X",
516 OldTableDesc->Signature.Ascii,
517 ACPI_FORMAT_UINT64 (OldTableDesc->Address),
518 OverrideType, ACPI_FORMAT_UINT64 (NewTableDesc.Address)));
520 /* We can now uninstall the original table */
522 AcpiTbUninstallTable (OldTableDesc);
525 * Replace the original table descriptor and keep its state as
528 AcpiTbInitTableDescriptor (OldTableDesc, NewTableDesc.Address,
529 NewTableDesc.Flags, NewTableDesc.Pointer);
530 AcpiTbValidateTempTable (OldTableDesc);
532 /* Release the temporary table descriptor */
534 AcpiTbReleaseTempTable (&NewTableDesc);
538 /*******************************************************************************
540 * FUNCTION: AcpiTbUninstallTable
542 * PARAMETERS: TableDesc - Table descriptor
546 * DESCRIPTION: Delete one internal ACPI table
548 ******************************************************************************/
551 AcpiTbUninstallTable (
552 ACPI_TABLE_DESC *TableDesc)
555 ACPI_FUNCTION_TRACE (TbUninstallTable);
558 /* Table must be installed */
560 if (!TableDesc->Address)
565 AcpiTbInvalidateTable (TableDesc);
567 if ((TableDesc->Flags & ACPI_TABLE_ORIGIN_MASK) ==
568 ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL)
570 ACPI_FREE (ACPI_PHYSADDR_TO_PTR (TableDesc->Address));
573 TableDesc->Address = ACPI_PTR_TO_PHYSADDR (NULL);