1 /******************************************************************************
3 * Module Name: tbxfload - Table load/unload external interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2019, 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 #define EXPORT_ACPI_INTERFACES
154 #include <contrib/dev/acpica/include/acpi.h>
155 #include <contrib/dev/acpica/include/accommon.h>
156 #include <contrib/dev/acpica/include/acnamesp.h>
157 #include <contrib/dev/acpica/include/actables.h>
158 #include <contrib/dev/acpica/include/acevents.h>
160 #define _COMPONENT ACPI_TABLES
161 ACPI_MODULE_NAME ("tbxfload")
164 /*******************************************************************************
166 * FUNCTION: AcpiLoadTables
172 * DESCRIPTION: Load the ACPI tables from the RSDT/XSDT
174 ******************************************************************************/
176 ACPI_STATUS ACPI_INIT_FUNCTION
183 ACPI_FUNCTION_TRACE (AcpiLoadTables);
187 * Install the default operation region handlers. These are the
188 * handlers that are defined by the ACPI specification to be
189 * "always accessible" -- namely, SystemMemory, SystemIO, and
190 * PCI_Config. This also means that no _REG methods need to be
191 * run for these address spaces. We need to have these handlers
192 * installed before any AML code can be executed, especially any
193 * module-level code (11/2015).
194 * Note that we allow OSPMs to install their own region handlers
195 * between AcpiInitializeSubsystem() and AcpiLoadTables() to use
196 * their customized default region handlers.
198 Status = AcpiEvInstallRegionHandlers ();
199 if (ACPI_FAILURE (Status))
201 ACPI_EXCEPTION ((AE_INFO, Status, "During Region initialization"));
202 return_ACPI_STATUS (Status);
205 /* Load the namespace from the tables */
207 Status = AcpiTbLoadNamespace ();
209 /* Don't let single failures abort the load */
211 if (Status == AE_CTRL_TERMINATE)
216 if (ACPI_FAILURE (Status))
218 ACPI_EXCEPTION ((AE_INFO, Status,
219 "While loading namespace from ACPI tables"));
223 * Initialize the objects in the namespace that remain uninitialized.
224 * This runs the executable AML that may be part of the declaration of
225 * these name objects:
226 * OperationRegions, BufferFields, Buffers, and Packages.
229 Status = AcpiNsInitializeObjects ();
230 if (ACPI_SUCCESS (Status))
232 AcpiGbl_NamespaceInitialized = TRUE;
235 return_ACPI_STATUS (Status);
238 ACPI_EXPORT_SYMBOL_INIT (AcpiLoadTables)
241 /*******************************************************************************
243 * FUNCTION: AcpiTbLoadNamespace
249 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
252 ******************************************************************************/
255 AcpiTbLoadNamespace (
260 ACPI_TABLE_HEADER *NewDsdt;
261 ACPI_TABLE_DESC *Table;
262 UINT32 TablesLoaded = 0;
263 UINT32 TablesFailed = 0;
266 ACPI_FUNCTION_TRACE (TbLoadNamespace);
269 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
272 * Load the namespace. The DSDT is required, but any SSDT and
273 * PSDT tables are optional. Verify the DSDT.
275 Table = &AcpiGbl_RootTableList.Tables[AcpiGbl_DsdtIndex];
277 if (!AcpiGbl_RootTableList.CurrentTableCount ||
278 !ACPI_COMPARE_NAMESEG (Table->Signature.Ascii, ACPI_SIG_DSDT) ||
279 ACPI_FAILURE (AcpiTbValidateTable (Table)))
281 Status = AE_NO_ACPI_TABLES;
286 * Save the DSDT pointer for simple access. This is the mapped memory
287 * address. We must take care here because the address of the .Tables
288 * array can change dynamically as tables are loaded at run-time. Note:
289 * .Pointer field is not validated until after call to AcpiTbValidateTable.
291 AcpiGbl_DSDT = Table->Pointer;
294 * Optionally copy the entire DSDT to local memory (instead of simply
295 * mapping it.) There are some BIOSs that corrupt or replace the original
296 * DSDT, creating the need for this option. Default is FALSE, do not copy
299 if (AcpiGbl_CopyDsdtLocally)
301 NewDsdt = AcpiTbCopyDsdt (AcpiGbl_DsdtIndex);
304 AcpiGbl_DSDT = NewDsdt;
309 * Save the original DSDT header for detection of table corruption
310 * and/or replacement of the DSDT from outside the OS.
312 memcpy (&AcpiGbl_OriginalDsdtHeader, AcpiGbl_DSDT,
313 sizeof (ACPI_TABLE_HEADER));
315 /* Load and parse tables */
317 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
318 Status = AcpiNsLoadTable (AcpiGbl_DsdtIndex, AcpiGbl_RootNode);
319 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
320 if (ACPI_FAILURE (Status))
322 ACPI_EXCEPTION ((AE_INFO, Status, "[DSDT] table load failed"));
330 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
332 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; ++i)
334 Table = &AcpiGbl_RootTableList.Tables[i];
336 if (!Table->Address ||
337 (!ACPI_COMPARE_NAMESEG (Table->Signature.Ascii, ACPI_SIG_SSDT) &&
338 !ACPI_COMPARE_NAMESEG (Table->Signature.Ascii, ACPI_SIG_PSDT) &&
339 !ACPI_COMPARE_NAMESEG (Table->Signature.Ascii, ACPI_SIG_OSDT)) ||
340 ACPI_FAILURE (AcpiTbValidateTable (Table)))
345 /* Ignore errors while loading tables, get as many as possible */
347 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
348 Status = AcpiNsLoadTable (i, AcpiGbl_RootNode);
349 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
350 if (ACPI_FAILURE (Status))
352 ACPI_EXCEPTION ((AE_INFO, Status, "(%4.4s:%8.8s) while loading table",
353 Table->Signature.Ascii, Table->Pointer->OemTableId));
357 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
358 "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n",
359 Table->Signature.Ascii, Table->Pointer->OemTableId));
370 "%u ACPI AML tables successfully acquired and loaded",
375 ACPI_ERROR ((AE_INFO,
376 "%u table load failures, %u successful",
377 TablesFailed, TablesLoaded));
379 /* Indicate at least one failure */
381 Status = AE_CTRL_TERMINATE;
384 #ifdef ACPI_APPLICATION
385 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT, "\n"));
390 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
391 return_ACPI_STATUS (Status);
395 /*******************************************************************************
397 * FUNCTION: AcpiInstallTable
399 * PARAMETERS: Address - Address of the ACPI table to be installed.
400 * Physical - Whether the address is a physical table
405 * DESCRIPTION: Dynamically install an ACPI table.
406 * Note: This function should only be invoked after
407 * AcpiInitializeTables() and before AcpiLoadTables().
409 ******************************************************************************/
411 ACPI_STATUS ACPI_INIT_FUNCTION
413 ACPI_PHYSICAL_ADDRESS Address,
421 ACPI_FUNCTION_TRACE (AcpiInstallTable);
426 Flags = ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL;
430 Flags = ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL;
433 Status = AcpiTbInstallStandardTable (Address, Flags,
434 FALSE, FALSE, &TableIndex);
436 return_ACPI_STATUS (Status);
439 ACPI_EXPORT_SYMBOL_INIT (AcpiInstallTable)
442 /*******************************************************************************
444 * FUNCTION: AcpiLoadTable
446 * PARAMETERS: Table - Pointer to a buffer containing the ACPI
447 * table to be loaded.
451 * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
452 * be a valid ACPI table with a valid ACPI table header.
453 * Note1: Mainly intended to support hotplug addition of SSDTs.
454 * Note2: Does not copy the incoming table. User is responsible
455 * to ensure that the table is not deleted or unmapped.
457 ******************************************************************************/
461 ACPI_TABLE_HEADER *Table)
467 ACPI_FUNCTION_TRACE (AcpiLoadTable);
470 /* Parameter validation */
474 return_ACPI_STATUS (AE_BAD_PARAMETER);
477 /* Install the table and load it into the namespace */
479 ACPI_INFO (("Host-directed Dynamic ACPI Table Load:"));
480 Status = AcpiTbInstallAndLoadTable (ACPI_PTR_TO_PHYSADDR (Table),
481 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL, FALSE, &TableIndex);
482 if (ACPI_SUCCESS (Status))
484 /* Complete the initialization/resolution of new objects */
486 AcpiNsInitializeObjects ();
489 return_ACPI_STATUS (Status);
492 ACPI_EXPORT_SYMBOL (AcpiLoadTable)
495 /*******************************************************************************
497 * FUNCTION: AcpiUnloadParentTable
499 * PARAMETERS: Object - Handle to any namespace object owned by
500 * the table to be unloaded
504 * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
505 * the table and deletes all namespace objects associated with
506 * that table. Unloading of the DSDT is not allowed.
507 * Note: Mainly intended to support hotplug removal of SSDTs.
509 ******************************************************************************/
512 AcpiUnloadParentTable (
515 ACPI_NAMESPACE_NODE *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Object);
516 ACPI_STATUS Status = AE_NOT_EXIST;
517 ACPI_OWNER_ID OwnerId;
521 ACPI_FUNCTION_TRACE (AcpiUnloadParentTable);
524 /* Parameter validation */
528 return_ACPI_STATUS (AE_BAD_PARAMETER);
532 * The node OwnerId is currently the same as the parent table ID.
533 * However, this could change in the future.
535 OwnerId = Node->OwnerId;
538 /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */
540 return_ACPI_STATUS (AE_TYPE);
543 /* Must acquire the table lock during this operation */
545 Status = AcpiUtAcquireMutex (ACPI_MTX_TABLES);
546 if (ACPI_FAILURE (Status))
548 return_ACPI_STATUS (Status);
551 /* Find the table in the global table list */
553 for (i = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++)
555 if (OwnerId != AcpiGbl_RootTableList.Tables[i].OwnerId)
561 * Allow unload of SSDT and OEMx tables only. Do not allow unload
562 * of the DSDT. No other types of tables should get here, since
563 * only these types can contain AML and thus are the only types
564 * that can create namespace objects.
566 if (ACPI_COMPARE_NAMESEG (
567 AcpiGbl_RootTableList.Tables[i].Signature.Ascii,
574 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
575 Status = AcpiTbUnloadTable (i);
576 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES);
580 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES);
581 return_ACPI_STATUS (Status);
584 ACPI_EXPORT_SYMBOL (AcpiUnloadParentTable)