1 /******************************************************************************
3 * Module Name: tbxfload - Table load/unload external interfaces
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, 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
155 #include "accommon.h"
156 #include "acnamesp.h"
157 #include "actables.h"
158 #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"));
222 if (AcpiGbl_ExecuteTablesAsMethods
|| !AcpiGbl_GroupModuleLevelCode
)
225 * If the module-level code support is enabled, initialize the objects
226 * in the namespace that remain uninitialized. This runs the executable
227 * AML that may be part of the declaration of these name objects:
228 * OperationRegions, BufferFields, Buffers, and Packages.
230 * Note: The module-level code is optional at this time, but will
231 * become the default in the future.
233 Status
= AcpiNsInitializeObjects ();
234 if (ACPI_FAILURE (Status
))
236 return_ACPI_STATUS (Status
);
240 AcpiGbl_NamespaceInitialized
= TRUE
;
241 return_ACPI_STATUS (Status
);
244 ACPI_EXPORT_SYMBOL_INIT (AcpiLoadTables
)
247 /*******************************************************************************
249 * FUNCTION: AcpiTbLoadNamespace
255 * DESCRIPTION: Load the namespace from the DSDT and all SSDTs/PSDTs found in
258 ******************************************************************************/
261 AcpiTbLoadNamespace (
266 ACPI_TABLE_HEADER
*NewDsdt
;
267 ACPI_TABLE_DESC
*Table
;
268 UINT32 TablesLoaded
= 0;
269 UINT32 TablesFailed
= 0;
272 ACPI_FUNCTION_TRACE (TbLoadNamespace
);
275 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
278 * Load the namespace. The DSDT is required, but any SSDT and
279 * PSDT tables are optional. Verify the DSDT.
281 Table
= &AcpiGbl_RootTableList
.Tables
[AcpiGbl_DsdtIndex
];
283 if (!AcpiGbl_RootTableList
.CurrentTableCount
||
284 !ACPI_COMPARE_NAME (Table
->Signature
.Ascii
, ACPI_SIG_DSDT
) ||
285 ACPI_FAILURE (AcpiTbValidateTable (Table
)))
287 Status
= AE_NO_ACPI_TABLES
;
292 * Save the DSDT pointer for simple access. This is the mapped memory
293 * address. We must take care here because the address of the .Tables
294 * array can change dynamically as tables are loaded at run-time. Note:
295 * .Pointer field is not validated until after call to AcpiTbValidateTable.
297 AcpiGbl_DSDT
= Table
->Pointer
;
300 * Optionally copy the entire DSDT to local memory (instead of simply
301 * mapping it.) There are some BIOSs that corrupt or replace the original
302 * DSDT, creating the need for this option. Default is FALSE, do not copy
305 if (AcpiGbl_CopyDsdtLocally
)
307 NewDsdt
= AcpiTbCopyDsdt (AcpiGbl_DsdtIndex
);
310 AcpiGbl_DSDT
= NewDsdt
;
315 * Save the original DSDT header for detection of table corruption
316 * and/or replacement of the DSDT from outside the OS.
318 memcpy (&AcpiGbl_OriginalDsdtHeader
, AcpiGbl_DSDT
,
319 sizeof (ACPI_TABLE_HEADER
));
321 /* Load and parse tables */
323 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
324 Status
= AcpiNsLoadTable (AcpiGbl_DsdtIndex
, AcpiGbl_RootNode
);
325 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
326 if (ACPI_FAILURE (Status
))
328 ACPI_EXCEPTION ((AE_INFO
, Status
, "[DSDT] table load failed"));
336 /* Load any SSDT or PSDT tables. Note: Loop leaves tables locked */
338 for (i
= 0; i
< AcpiGbl_RootTableList
.CurrentTableCount
; ++i
)
340 Table
= &AcpiGbl_RootTableList
.Tables
[i
];
342 if (!Table
->Address
||
343 (!ACPI_COMPARE_NAME (Table
->Signature
.Ascii
, ACPI_SIG_SSDT
) &&
344 !ACPI_COMPARE_NAME (Table
->Signature
.Ascii
, ACPI_SIG_PSDT
) &&
345 !ACPI_COMPARE_NAME (Table
->Signature
.Ascii
, ACPI_SIG_OSDT
)) ||
346 ACPI_FAILURE (AcpiTbValidateTable (Table
)))
351 /* Ignore errors while loading tables, get as many as possible */
353 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
354 Status
= AcpiNsLoadTable (i
, AcpiGbl_RootNode
);
355 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
356 if (ACPI_FAILURE (Status
))
358 ACPI_EXCEPTION ((AE_INFO
, Status
, "(%4.4s:%8.8s) while loading table",
359 Table
->Signature
.Ascii
, Table
->Pointer
->OemTableId
));
363 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT
,
364 "Table [%4.4s:%8.8s] (id FF) - Table namespace load failed\n\n",
365 Table
->Signature
.Ascii
, Table
->Pointer
->OemTableId
));
376 "%u ACPI AML tables successfully acquired and loaded",
381 ACPI_ERROR ((AE_INFO
,
382 "%u table load failures, %u successful",
383 TablesFailed
, TablesLoaded
));
385 /* Indicate at least one failure */
387 Status
= AE_CTRL_TERMINATE
;
390 #ifdef ACPI_APPLICATION
391 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT
, "\n"));
396 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
397 return_ACPI_STATUS (Status
);
401 /*******************************************************************************
403 * FUNCTION: AcpiInstallTable
405 * PARAMETERS: Address - Address of the ACPI table to be installed.
406 * Physical - Whether the address is a physical table
411 * DESCRIPTION: Dynamically install an ACPI table.
412 * Note: This function should only be invoked after
413 * AcpiInitializeTables() and before AcpiLoadTables().
415 ******************************************************************************/
417 ACPI_STATUS ACPI_INIT_FUNCTION
419 ACPI_PHYSICAL_ADDRESS Address
,
427 ACPI_FUNCTION_TRACE (AcpiInstallTable
);
432 Flags
= ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL
;
436 Flags
= ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
;
439 Status
= AcpiTbInstallStandardTable (Address
, Flags
,
440 FALSE
, FALSE
, &TableIndex
);
442 return_ACPI_STATUS (Status
);
445 ACPI_EXPORT_SYMBOL_INIT (AcpiInstallTable
)
448 /*******************************************************************************
450 * FUNCTION: AcpiLoadTable
452 * PARAMETERS: Table - Pointer to a buffer containing the ACPI
453 * table to be loaded.
457 * DESCRIPTION: Dynamically load an ACPI table from the caller's buffer. Must
458 * be a valid ACPI table with a valid ACPI table header.
459 * Note1: Mainly intended to support hotplug addition of SSDTs.
460 * Note2: Does not copy the incoming table. User is responsible
461 * to ensure that the table is not deleted or unmapped.
463 ******************************************************************************/
467 ACPI_TABLE_HEADER
*Table
)
473 ACPI_FUNCTION_TRACE (AcpiLoadTable
);
476 /* Parameter validation */
480 return_ACPI_STATUS (AE_BAD_PARAMETER
);
483 /* Install the table and load it into the namespace */
485 ACPI_INFO (("Host-directed Dynamic ACPI Table Load:"));
486 Status
= AcpiTbInstallAndLoadTable (ACPI_PTR_TO_PHYSADDR (Table
),
487 ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL
, FALSE
, &TableIndex
);
488 return_ACPI_STATUS (Status
);
491 ACPI_EXPORT_SYMBOL (AcpiLoadTable
)
494 /*******************************************************************************
496 * FUNCTION: AcpiUnloadParentTable
498 * PARAMETERS: Object - Handle to any namespace object owned by
499 * the table to be unloaded
503 * DESCRIPTION: Via any namespace object within an SSDT or OEMx table, unloads
504 * the table and deletes all namespace objects associated with
505 * that table. Unloading of the DSDT is not allowed.
506 * Note: Mainly intended to support hotplug removal of SSDTs.
508 ******************************************************************************/
511 AcpiUnloadParentTable (
514 ACPI_NAMESPACE_NODE
*Node
= ACPI_CAST_PTR (ACPI_NAMESPACE_NODE
, Object
);
515 ACPI_STATUS Status
= AE_NOT_EXIST
;
516 ACPI_OWNER_ID OwnerId
;
520 ACPI_FUNCTION_TRACE (AcpiUnloadParentTable
);
523 /* Parameter validation */
527 return_ACPI_STATUS (AE_BAD_PARAMETER
);
531 * The node OwnerId is currently the same as the parent table ID.
532 * However, this could change in the future.
534 OwnerId
= Node
->OwnerId
;
537 /* OwnerId==0 means DSDT is the owner. DSDT cannot be unloaded */
539 return_ACPI_STATUS (AE_TYPE
);
542 /* Must acquire the table lock during this operation */
544 Status
= AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
545 if (ACPI_FAILURE (Status
))
547 return_ACPI_STATUS (Status
);
550 /* Find the table in the global table list */
552 for (i
= 0; i
< AcpiGbl_RootTableList
.CurrentTableCount
; i
++)
554 if (OwnerId
!= AcpiGbl_RootTableList
.Tables
[i
].OwnerId
)
560 * Allow unload of SSDT and OEMx tables only. Do not allow unload
561 * of the DSDT. No other types of tables should get here, since
562 * only these types can contain AML and thus are the only types
563 * that can create namespace objects.
565 if (ACPI_COMPARE_NAME (
566 AcpiGbl_RootTableList
.Tables
[i
].Signature
.Ascii
,
573 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
574 Status
= AcpiTbUnloadTable (i
);
575 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES
);
579 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES
);
580 return_ACPI_STATUS (Status
);
583 ACPI_EXPORT_SYMBOL (AcpiUnloadParentTable
)