1/******************************************************************************
2 *
3 * Module Name: nsload - namespace loading/expanding/contracting procedures
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#include "acpi.h"
153#include "accommon.h"
154#include "acnamesp.h"
155#include "acdispat.h"
156#include "actables.h"
157#include "acinterp.h"
158
159
160#define _COMPONENT          ACPI_NAMESPACE
161        ACPI_MODULE_NAME    ("nsload")
162
163/* Local prototypes */
164
165#ifdef ACPI_FUTURE_IMPLEMENTATION
166ACPI_STATUS
167AcpiNsUnloadNamespace (
168    ACPI_HANDLE             Handle);
169
170static ACPI_STATUS
171AcpiNsDeleteSubtree (
172    ACPI_HANDLE             StartHandle);
173#endif
174
175
176/*******************************************************************************
177 *
178 * FUNCTION:    AcpiNsLoadTable
179 *
180 * PARAMETERS:  TableIndex      - Index for table to be loaded
181 *              Node            - Owning NS node
182 *
183 * RETURN:      Status
184 *
185 * DESCRIPTION: Load one ACPI table into the namespace
186 *
187 ******************************************************************************/
188
189ACPI_STATUS
190AcpiNsLoadTable (
191    UINT32                  TableIndex,
192    ACPI_NAMESPACE_NODE     *Node)
193{
194    ACPI_STATUS             Status;
195
196
197    ACPI_FUNCTION_TRACE (NsLoadTable);
198
199
200    /* If table already loaded into namespace, just return */
201
202    if (AcpiTbIsTableLoaded (TableIndex))
203    {
204        Status = AE_ALREADY_EXISTS;
205        goto Unlock;
206    }
207
208    ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
209        "**** Loading table into namespace ****\n"));
210
211    Status = AcpiTbAllocateOwnerId (TableIndex);
212    if (ACPI_FAILURE (Status))
213    {
214        goto Unlock;
215    }
216
217    /*
218     * Parse the table and load the namespace with all named
219     * objects found within. Control methods are NOT parsed
220     * at this time. In fact, the control methods cannot be
221     * parsed until the entire namespace is loaded, because
222     * if a control method makes a forward reference (call)
223     * to another control method, we can't continue parsing
224     * because we don't know how many arguments to parse next!
225     */
226    Status = AcpiNsParseTable (TableIndex, Node);
227    if (ACPI_SUCCESS (Status))
228    {
229        AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
230    }
231    else
232    {
233        /*
234         * On error, delete any namespace objects created by this table.
235         * We cannot initialize these objects, so delete them. There are
236         * a couple of expecially bad cases:
237         * AE_ALREADY_EXISTS - namespace collision.
238         * AE_NOT_FOUND - the target of a Scope operator does not
239         * exist. This target of Scope must already exist in the
240         * namespace, as per the ACPI specification.
241         */
242        AcpiNsDeleteNamespaceByOwner (
243            AcpiGbl_RootTableList.Tables[TableIndex].OwnerId);
244
245        AcpiTbReleaseOwnerId (TableIndex);
246        return_ACPI_STATUS (Status);
247    }
248
249Unlock:
250    if (ACPI_FAILURE (Status))
251    {
252        return_ACPI_STATUS (Status);
253    }
254
255    /*
256     * Now we can parse the control methods. We always parse
257     * them here for a sanity check, and if configured for
258     * just-in-time parsing, we delete the control method
259     * parse trees.
260     */
261    ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
262        "**** Begin Table Object Initialization\n"));
263
264    AcpiExEnterInterpreter ();
265    Status = AcpiDsInitializeObjects (TableIndex, Node);
266    AcpiExExitInterpreter ();
267
268    ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
269        "**** Completed Table Object Initialization\n"));
270
271    /*
272     * This case handles the legacy option that groups all module-level
273     * code blocks together and defers execution until all of the tables
274     * are loaded. Execute all of these blocks at this time.
275     * Execute any module-level code that was detected during the table
276     * load phase.
277     *
278     * Note: this option is deprecated and will be eliminated in the
279     * future. Use of this option can cause problems with AML code that
280     * depends upon in-order immediate execution of module-level code.
281     */
282    AcpiNsExecModuleCodeList ();
283    return_ACPI_STATUS (Status);
284}
285
286
287#ifdef ACPI_OBSOLETE_FUNCTIONS
288/*******************************************************************************
289 *
290 * FUNCTION:    AcpiLoadNamespace
291 *
292 * PARAMETERS:  None
293 *
294 * RETURN:      Status
295 *
296 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
297 *              (DSDT points to either the BIOS or a buffer.)
298 *
299 ******************************************************************************/
300
301ACPI_STATUS
302AcpiNsLoadNamespace (
303    void)
304{
305    ACPI_STATUS             Status;
306
307
308    ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
309
310
311    /* There must be at least a DSDT installed */
312
313    if (AcpiGbl_DSDT == NULL)
314    {
315        ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
316        return_ACPI_STATUS (AE_NO_ACPI_TABLES);
317    }
318
319    /*
320     * Load the namespace. The DSDT is required,
321     * but the SSDT and PSDT tables are optional.
322     */
323    Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
324    if (ACPI_FAILURE (Status))
325    {
326        return_ACPI_STATUS (Status);
327    }
328
329    /* Ignore exceptions from these */
330
331    (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
332    (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
333
334    ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
335        "ACPI Namespace successfully loaded at root %p\n",
336        AcpiGbl_RootNode));
337
338    return_ACPI_STATUS (Status);
339}
340#endif
341
342#ifdef ACPI_FUTURE_IMPLEMENTATION
343/*******************************************************************************
344 *
345 * FUNCTION:    AcpiNsDeleteSubtree
346 *
347 * PARAMETERS:  StartHandle         - Handle in namespace where search begins
348 *
349 * RETURNS      Status
350 *
351 * DESCRIPTION: Walks the namespace starting at the given handle and deletes
352 *              all objects, entries, and scopes in the entire subtree.
353 *
354 *              Namespace/Interpreter should be locked or the subsystem should
355 *              be in shutdown before this routine is called.
356 *
357 ******************************************************************************/
358
359static ACPI_STATUS
360AcpiNsDeleteSubtree (
361    ACPI_HANDLE             StartHandle)
362{
363    ACPI_STATUS             Status;
364    ACPI_HANDLE             ChildHandle;
365    ACPI_HANDLE             ParentHandle;
366    ACPI_HANDLE             NextChildHandle;
367    ACPI_HANDLE             Dummy;
368    UINT32                  Level;
369
370
371    ACPI_FUNCTION_TRACE (NsDeleteSubtree);
372
373
374    ParentHandle = StartHandle;
375    ChildHandle = NULL;
376    Level = 1;
377
378    /*
379     * Traverse the tree of objects until we bubble back up
380     * to where we started.
381     */
382    while (Level > 0)
383    {
384        /* Attempt to get the next object in this scope */
385
386        Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
387            ChildHandle, &NextChildHandle);
388
389        ChildHandle = NextChildHandle;
390
391        /* Did we get a new object? */
392
393        if (ACPI_SUCCESS (Status))
394        {
395            /* Check if this object has any children */
396
397            if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
398                NULL, &Dummy)))
399            {
400                /*
401                 * There is at least one child of this object,
402                 * visit the object
403                 */
404                Level++;
405                ParentHandle = ChildHandle;
406                ChildHandle  = NULL;
407            }
408        }
409        else
410        {
411            /*
412             * No more children in this object, go back up to
413             * the object's parent
414             */
415            Level--;
416
417            /* Delete all children now */
418
419            AcpiNsDeleteChildren (ChildHandle);
420
421            ChildHandle = ParentHandle;
422            Status = AcpiGetParent (ParentHandle, &ParentHandle);
423            if (ACPI_FAILURE (Status))
424            {
425                return_ACPI_STATUS (Status);
426            }
427        }
428    }
429
430    /* Now delete the starting object, and we are done */
431
432    AcpiNsRemoveNode (ChildHandle);
433    return_ACPI_STATUS (AE_OK);
434}
435
436
437/*******************************************************************************
438 *
439 *  FUNCTION:       AcpiNsUnloadNameSpace
440 *
441 *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
442 *
443 *  RETURN:         Status
444 *
445 *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
446 *                  event. Deletes an entire subtree starting from (and
447 *                  including) the given handle.
448 *
449 ******************************************************************************/
450
451ACPI_STATUS
452AcpiNsUnloadNamespace (
453    ACPI_HANDLE             Handle)
454{
455    ACPI_STATUS             Status;
456
457
458    ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
459
460
461    /* Parameter validation */
462
463    if (!AcpiGbl_RootNode)
464    {
465        return_ACPI_STATUS (AE_NO_NAMESPACE);
466    }
467
468    if (!Handle)
469    {
470        return_ACPI_STATUS (AE_BAD_PARAMETER);
471    }
472
473    /* This function does the real work */
474
475    Status = AcpiNsDeleteSubtree (Handle);
476    return_ACPI_STATUS (Status);
477}
478#endif
479