1 /******************************************************************************
2  *
3  * Module Name: utxfinit - External interfaces for ACPICA initialization
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
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
19  * property rights.
20  *
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
27  *
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;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
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.
53  *
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
64  * make.
65  *
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
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
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.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
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
88  * PARTICULAR PURPOSE.
89  *
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
97  * LIMITED REMEDY.
98  *
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.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
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.
133  *
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.
145  *
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.
149  *
150  *****************************************************************************/
151 
152 #define EXPORT_ACPI_INTERFACES
153 
154 #include "acpi.h"
155 #include "accommon.h"
156 #include "acevents.h"
157 #include "acnamesp.h"
158 #include "acdebug.h"
159 #include "actables.h"
160 
161 #define _COMPONENT          ACPI_UTILITIES
162         ACPI_MODULE_NAME    ("utxfinit")
163 
164 /* For AcpiExec only */
165 void
166 AeDoObjectOverrides (
167     void);
168 
169 
170 /*******************************************************************************
171  *
172  * FUNCTION:    AcpiInitializeSubsystem
173  *
174  * PARAMETERS:  None
175  *
176  * RETURN:      Status
177  *
178  * DESCRIPTION: Initializes all global variables. This is the first function
179  *              called, so any early initialization belongs here.
180  *
181  ******************************************************************************/
182 
183 ACPI_STATUS ACPI_INIT_FUNCTION
AcpiInitializeSubsystem(void)184 AcpiInitializeSubsystem (
185     void)
186 {
187     ACPI_STATUS             Status;
188 
189 
190     ACPI_FUNCTION_TRACE (AcpiInitializeSubsystem);
191 
192 
193     AcpiGbl_StartupFlags = ACPI_SUBSYSTEM_INITIALIZE;
194     ACPI_DEBUG_EXEC (AcpiUtInitStackPtrTrace ());
195 
196     /* Initialize the OS-Dependent layer */
197 
198     Status = AcpiOsInitialize ();
199     if (ACPI_FAILURE (Status))
200     {
201         ACPI_EXCEPTION ((AE_INFO, Status, "During OSL initialization"));
202         return_ACPI_STATUS (Status);
203     }
204 
205     /* Initialize all globals used by the subsystem */
206 
207     Status = AcpiUtInitGlobals ();
208     if (ACPI_FAILURE (Status))
209     {
210         ACPI_EXCEPTION ((AE_INFO, Status, "During initialization of globals"));
211         return_ACPI_STATUS (Status);
212     }
213 
214     /* Create the default mutex objects */
215 
216     Status = AcpiUtMutexInitialize ();
217     if (ACPI_FAILURE (Status))
218     {
219         ACPI_EXCEPTION ((AE_INFO, Status, "During Global Mutex creation"));
220         return_ACPI_STATUS (Status);
221     }
222 
223     /*
224      * Initialize the namespace manager and
225      * the root of the namespace tree
226      */
227     Status = AcpiNsRootInitialize ();
228     if (ACPI_FAILURE (Status))
229     {
230         ACPI_EXCEPTION ((AE_INFO, Status, "During Namespace initialization"));
231         return_ACPI_STATUS (Status);
232     }
233 
234     /* Initialize the global OSI interfaces list with the static names */
235 
236     Status = AcpiUtInitializeInterfaces ();
237     if (ACPI_FAILURE (Status))
238     {
239         ACPI_EXCEPTION ((AE_INFO, Status, "During OSI interfaces initialization"));
240         return_ACPI_STATUS (Status);
241     }
242 
243     return_ACPI_STATUS (AE_OK);
244 }
245 
ACPI_EXPORT_SYMBOL_INIT(AcpiInitializeSubsystem)246 ACPI_EXPORT_SYMBOL_INIT (AcpiInitializeSubsystem)
247 
248 
249 /*******************************************************************************
250  *
251  * FUNCTION:    AcpiEnableSubsystem
252  *
253  * PARAMETERS:  Flags               - Init/enable Options
254  *
255  * RETURN:      Status
256  *
257  * DESCRIPTION: Completes the subsystem initialization including hardware.
258  *              Puts system into ACPI mode if it isn't already.
259  *
260  ******************************************************************************/
261 
262 ACPI_STATUS ACPI_INIT_FUNCTION
263 AcpiEnableSubsystem (
264     UINT32                  Flags)
265 {
266     ACPI_STATUS             Status = AE_OK;
267 
268 
269     ACPI_FUNCTION_TRACE (AcpiEnableSubsystem);
270 
271 
272     /*
273      * The early initialization phase is complete. The namespace is loaded,
274      * and we can now support address spaces other than Memory, I/O, and
275      * PCI_Config.
276      */
277     AcpiGbl_EarlyInitialization = FALSE;
278 
279 #if (!ACPI_REDUCED_HARDWARE)
280 
281     /* Enable ACPI mode */
282 
283     if (!(Flags & ACPI_NO_ACPI_ENABLE))
284     {
285         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n"));
286 
287         AcpiGbl_OriginalMode = AcpiHwGetMode();
288 
289         Status = AcpiEnable ();
290         if (ACPI_FAILURE (Status))
291         {
292             ACPI_WARNING ((AE_INFO, "AcpiEnable failed"));
293             return_ACPI_STATUS (Status);
294         }
295     }
296 
297     /*
298      * Obtain a permanent mapping for the FACS. This is required for the
299      * Global Lock and the Firmware Waking Vector
300      */
301     if (!(Flags & ACPI_NO_FACS_INIT))
302     {
303         Status = AcpiTbInitializeFacs ();
304         if (ACPI_FAILURE (Status))
305         {
306             ACPI_WARNING ((AE_INFO, "Could not map the FACS table"));
307             return_ACPI_STATUS (Status);
308         }
309     }
310 
311     /*
312      * Initialize ACPI Event handling (Fixed and General Purpose)
313      *
314      * Note1: We must have the hardware and events initialized before we can
315      * execute any control methods safely. Any control method can require
316      * ACPI hardware support, so the hardware must be fully initialized before
317      * any method execution!
318      *
319      * Note2: Fixed events are initialized and enabled here. GPEs are
320      * initialized, but cannot be enabled until after the hardware is
321      * completely initialized (SCI and GlobalLock activated) and the various
322      * initialization control methods are run (_REG, _STA, _INI) on the
323      * entire namespace.
324      */
325     if (!(Flags & ACPI_NO_EVENT_INIT))
326     {
327         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
328             "[Init] Initializing ACPI events\n"));
329 
330         Status = AcpiEvInitializeEvents ();
331         if (ACPI_FAILURE (Status))
332         {
333             return_ACPI_STATUS (Status);
334         }
335     }
336 
337     /*
338      * Install the SCI handler and Global Lock handler. This completes the
339      * hardware initialization.
340      */
341     if (!(Flags & ACPI_NO_HANDLER_INIT))
342     {
343         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
344             "[Init] Installing SCI/GL handlers\n"));
345 
346         Status = AcpiEvInstallXruptHandlers ();
347         if (ACPI_FAILURE (Status))
348         {
349             return_ACPI_STATUS (Status);
350         }
351     }
352 
353 #endif /* !ACPI_REDUCED_HARDWARE */
354 
355     return_ACPI_STATUS (Status);
356 }
357 
ACPI_EXPORT_SYMBOL_INIT(AcpiEnableSubsystem)358 ACPI_EXPORT_SYMBOL_INIT (AcpiEnableSubsystem)
359 
360 
361 /*******************************************************************************
362  *
363  * FUNCTION:    AcpiInitializeObjects
364  *
365  * PARAMETERS:  Flags               - Init/enable Options
366  *
367  * RETURN:      Status
368  *
369  * DESCRIPTION: Completes namespace initialization by initializing device
370  *              objects and executing AML code for Regions, buffers, etc.
371  *
372  ******************************************************************************/
373 
374 ACPI_STATUS ACPI_INIT_FUNCTION
375 AcpiInitializeObjects (
376     UINT32                  Flags)
377 {
378     ACPI_STATUS             Status = AE_OK;
379 
380 
381     ACPI_FUNCTION_TRACE (AcpiInitializeObjects);
382 
383 
384     /*
385      * This case handles the legacy option that groups all module-level
386      * code blocks together and defers execution until all of the tables
387      * are loaded. Execute all of these blocks at this time.
388      * Execute any module-level code that was detected during the table
389      * load phase.
390      *
391      * Note: this option is deprecated and will be eliminated in the
392      * future. Use of this option can cause problems with AML code that
393      * depends upon in-order immediate execution of module-level code.
394      */
395     AcpiNsExecModuleCodeList ();
396 
397     /*
398      * Initialize the objects that remain uninitialized. This
399      * runs the executable AML that may be part of the
400      * declaration of these objects:
401      * OperationRegions, BufferFields, Buffers, and Packages.
402      */
403     if (!(Flags & ACPI_NO_OBJECT_INIT))
404     {
405         Status = AcpiNsInitializeObjects ();
406         if (ACPI_FAILURE (Status))
407         {
408             return_ACPI_STATUS (Status);
409         }
410     }
411 
412     /*
413      * Initialize all device/region objects in the namespace. This runs
414      * the device _STA and _INI methods and region _REG methods.
415      */
416     if (!(Flags & (ACPI_NO_DEVICE_INIT | ACPI_NO_ADDRESS_SPACE_INIT)))
417     {
418         Status = AcpiNsInitializeDevices (Flags);
419         if (ACPI_FAILURE (Status))
420         {
421             return_ACPI_STATUS (Status);
422         }
423     }
424 
425     /*
426      * Empty the caches (delete the cached objects) on the assumption that
427      * the table load filled them up more than they will be at runtime --
428      * thus wasting non-paged memory.
429      */
430     Status = AcpiPurgeCachedObjects ();
431 
432     AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK;
433     return_ACPI_STATUS (Status);
434 }
435 
436 ACPI_EXPORT_SYMBOL_INIT (AcpiInitializeObjects)
437