xref: /titanic_50/usr/src/uts/intel/io/acpica/namespace/nsload.c (revision 42cac157f878fbb7ae190eb0339c6932f3192b87)
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 - 2009, 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 #define __NSLOAD_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acnamesp.h"
121 #include "acdispat.h"
122 #include "actables.h"
123 
124 
125 #define _COMPONENT          ACPI_NAMESPACE
126         ACPI_MODULE_NAME    ("nsload")
127 
128 /* Local prototypes */
129 
130 #ifdef ACPI_FUTURE_IMPLEMENTATION
131 ACPI_STATUS
132 AcpiNsUnloadNamespace (
133     ACPI_HANDLE             Handle);
134 
135 static ACPI_STATUS
136 AcpiNsDeleteSubtree (
137     ACPI_HANDLE             StartHandle);
138 #endif
139 
140 
141 #ifndef ACPI_NO_METHOD_EXECUTION
142 /*******************************************************************************
143  *
144  * FUNCTION:    AcpiNsLoadTable
145  *
146  * PARAMETERS:  TableIndex      - Index for table to be loaded
147  *              Node            - Owning NS node
148  *
149  * RETURN:      Status
150  *
151  * DESCRIPTION: Load one ACPI table into the namespace
152  *
153  ******************************************************************************/
154 
155 ACPI_STATUS
156 AcpiNsLoadTable (
157     UINT32                  TableIndex,
158     ACPI_NAMESPACE_NODE     *Node)
159 {
160     ACPI_STATUS             Status;
161 
162 
163     ACPI_FUNCTION_TRACE (NsLoadTable);
164 
165 
166     /*
167      * Parse the table and load the namespace with all named
168      * objects found within.  Control methods are NOT parsed
169      * at this time.  In fact, the control methods cannot be
170      * parsed until the entire namespace is loaded, because
171      * if a control method makes a forward reference (call)
172      * to another control method, we can't continue parsing
173      * because we don't know how many arguments to parse next!
174      */
175     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
176     if (ACPI_FAILURE (Status))
177     {
178         return_ACPI_STATUS (Status);
179     }
180 
181     /* If table already loaded into namespace, just return */
182 
183     if (AcpiTbIsTableLoaded (TableIndex))
184     {
185         Status = AE_ALREADY_EXISTS;
186         goto Unlock;
187     }
188 
189     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
190         "**** Loading table into namespace ****\n"));
191 
192     Status = AcpiTbAllocateOwnerId (TableIndex);
193     if (ACPI_FAILURE (Status))
194     {
195         goto Unlock;
196     }
197 
198     Status = AcpiNsParseTable (TableIndex, Node);
199     if (ACPI_SUCCESS (Status))
200     {
201         AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
202     }
203     else
204     {
205         (void) AcpiTbReleaseOwnerId (TableIndex);
206     }
207 
208 Unlock:
209     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
210 
211     if (ACPI_FAILURE (Status))
212     {
213         return_ACPI_STATUS (Status);
214     }
215 
216     /*
217      * Now we can parse the control methods.  We always parse
218      * them here for a sanity check, and if configured for
219      * just-in-time parsing, we delete the control method
220      * parse trees.
221      */
222     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
223         "**** Begin Table Method Parsing and Object Initialization\n"));
224 
225     Status = AcpiDsInitializeObjects (TableIndex, Node);
226 
227     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
228         "**** Completed Table Method Parsing and Object Initialization\n"));
229 
230     return_ACPI_STATUS (Status);
231 }
232 
233 
234 #ifdef ACPI_OBSOLETE_FUNCTIONS
235 /*******************************************************************************
236  *
237  * FUNCTION:    AcpiLoadNamespace
238  *
239  * PARAMETERS:  None
240  *
241  * RETURN:      Status
242  *
243  * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
244  *              (DSDT points to either the BIOS or a buffer.)
245  *
246  ******************************************************************************/
247 
248 ACPI_STATUS
249 AcpiNsLoadNamespace (
250     void)
251 {
252     ACPI_STATUS             Status;
253 
254 
255     ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
256 
257 
258     /* There must be at least a DSDT installed */
259 
260     if (AcpiGbl_DSDT == NULL)
261     {
262         ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
263         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
264     }
265 
266     /*
267      * Load the namespace.  The DSDT is required,
268      * but the SSDT and PSDT tables are optional.
269      */
270     Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
271     if (ACPI_FAILURE (Status))
272     {
273         return_ACPI_STATUS (Status);
274     }
275 
276     /* Ignore exceptions from these */
277 
278     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
279     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
280 
281     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
282         "ACPI Namespace successfully loaded at root %p\n",
283         AcpiGbl_RootNode));
284 
285     return_ACPI_STATUS (Status);
286 }
287 #endif
288 
289 #ifdef ACPI_FUTURE_IMPLEMENTATION
290 /*******************************************************************************
291  *
292  * FUNCTION:    AcpiNsDeleteSubtree
293  *
294  * PARAMETERS:  StartHandle         - Handle in namespace where search begins
295  *
296  * RETURNS      Status
297  *
298  * DESCRIPTION: Walks the namespace starting at the given handle and deletes
299  *              all objects, entries, and scopes in the entire subtree.
300  *
301  *              Namespace/Interpreter should be locked or the subsystem should
302  *              be in shutdown before this routine is called.
303  *
304  ******************************************************************************/
305 
306 static ACPI_STATUS
307 AcpiNsDeleteSubtree (
308     ACPI_HANDLE             StartHandle)
309 {
310     ACPI_STATUS             Status;
311     ACPI_HANDLE             ChildHandle;
312     ACPI_HANDLE             ParentHandle;
313     ACPI_HANDLE             NextChildHandle;
314     ACPI_HANDLE             Dummy;
315     UINT32                  Level;
316 
317 
318     ACPI_FUNCTION_TRACE (NsDeleteSubtree);
319 
320 
321     ParentHandle = StartHandle;
322     ChildHandle  = NULL;
323     Level        = 1;
324 
325     /*
326      * Traverse the tree of objects until we bubble back up
327      * to where we started.
328      */
329     while (Level > 0)
330     {
331         /* Attempt to get the next object in this scope */
332 
333         Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
334                                     ChildHandle, &NextChildHandle);
335 
336         ChildHandle = NextChildHandle;
337 
338         /* Did we get a new object? */
339 
340         if (ACPI_SUCCESS (Status))
341         {
342             /* Check if this object has any children */
343 
344             if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
345                                     NULL, &Dummy)))
346             {
347                 /*
348                  * There is at least one child of this object,
349                  * visit the object
350                  */
351                 Level++;
352                 ParentHandle = ChildHandle;
353                 ChildHandle  = NULL;
354             }
355         }
356         else
357         {
358             /*
359              * No more children in this object, go back up to
360              * the object's parent
361              */
362             Level--;
363 
364             /* Delete all children now */
365 
366             AcpiNsDeleteChildren (ChildHandle);
367 
368             ChildHandle = ParentHandle;
369             Status = AcpiGetParent (ParentHandle, &ParentHandle);
370             if (ACPI_FAILURE (Status))
371             {
372                 return_ACPI_STATUS (Status);
373             }
374         }
375     }
376 
377     /* Now delete the starting object, and we are done */
378 
379     AcpiNsRemoveNode (ChildHandle);
380     return_ACPI_STATUS (AE_OK);
381 }
382 
383 
384 /*******************************************************************************
385  *
386  *  FUNCTION:       AcpiNsUnloadNameSpace
387  *
388  *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
389  *
390  *  RETURN:         Status
391  *
392  *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
393  *                  event.  Deletes an entire subtree starting from (and
394  *                  including) the given handle.
395  *
396  ******************************************************************************/
397 
398 ACPI_STATUS
399 AcpiNsUnloadNamespace (
400     ACPI_HANDLE             Handle)
401 {
402     ACPI_STATUS             Status;
403 
404 
405     ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
406 
407 
408     /* Parameter validation */
409 
410     if (!AcpiGbl_RootNode)
411     {
412         return_ACPI_STATUS (AE_NO_NAMESPACE);
413     }
414 
415     if (!Handle)
416     {
417         return_ACPI_STATUS (AE_BAD_PARAMETER);
418     }
419 
420     /* This function does the real work */
421 
422     Status = AcpiNsDeleteSubtree (Handle);
423 
424     return_ACPI_STATUS (Status);
425 }
426 #endif
427 #endif
428 
429