1 /******************************************************************************
3 * Module Name: nsload - namespace loading/expanding/contracting procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acnamesp.h>
47 #include <contrib/dev/acpica/include/acdispat.h>
48 #include <contrib/dev/acpica/include/actables.h>
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME ("nsload")
54 /* Local prototypes */
56 #ifdef ACPI_FUTURE_IMPLEMENTATION
58 AcpiNsUnloadNamespace (
63 ACPI_HANDLE StartHandle);
67 #ifndef ACPI_NO_METHOD_EXECUTION
68 /*******************************************************************************
70 * FUNCTION: AcpiNsLoadTable
72 * PARAMETERS: TableIndex - Index for table to be loaded
73 * Node - Owning NS node
77 * DESCRIPTION: Load one ACPI table into the namespace
79 ******************************************************************************/
84 ACPI_NAMESPACE_NODE *Node)
89 ACPI_FUNCTION_TRACE (NsLoadTable);
93 * Parse the table and load the namespace with all named
94 * objects found within. Control methods are NOT parsed
95 * at this time. In fact, the control methods cannot be
96 * parsed until the entire namespace is loaded, because
97 * if a control method makes a forward reference (call)
98 * to another control method, we can't continue parsing
99 * because we don't know how many arguments to parse next!
101 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
102 if (ACPI_FAILURE (Status))
104 return_ACPI_STATUS (Status);
107 /* If table already loaded into namespace, just return */
109 if (AcpiTbIsTableLoaded (TableIndex))
111 Status = AE_ALREADY_EXISTS;
115 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
116 "**** Loading table into namespace ****\n"));
118 Status = AcpiTbAllocateOwnerId (TableIndex);
119 if (ACPI_FAILURE (Status))
124 Status = AcpiNsParseTable (TableIndex, Node);
125 if (ACPI_SUCCESS (Status))
127 AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
132 * On error, delete any namespace objects created by this table.
133 * We cannot initialize these objects, so delete them. There are
134 * a couple of expecially bad cases:
135 * AE_ALREADY_EXISTS - namespace collision.
136 * AE_NOT_FOUND - the target of a Scope operator does not
137 * exist. This target of Scope must already exist in the
138 * namespace, as per the ACPI specification.
140 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
141 AcpiNsDeleteNamespaceByOwner (
142 AcpiGbl_RootTableList.Tables[TableIndex].OwnerId);
143 AcpiTbReleaseOwnerId (TableIndex);
145 return_ACPI_STATUS (Status);
149 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
151 if (ACPI_FAILURE (Status))
153 return_ACPI_STATUS (Status);
157 * Now we can parse the control methods. We always parse
158 * them here for a sanity check, and if configured for
159 * just-in-time parsing, we delete the control method
162 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
163 "**** Begin Table Object Initialization\n"));
165 Status = AcpiDsInitializeObjects (TableIndex, Node);
167 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
168 "**** Completed Table Object Initialization\n"));
170 return_ACPI_STATUS (Status);
174 #ifdef ACPI_OBSOLETE_FUNCTIONS
175 /*******************************************************************************
177 * FUNCTION: AcpiLoadNamespace
183 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
184 * (DSDT points to either the BIOS or a buffer.)
186 ******************************************************************************/
189 AcpiNsLoadNamespace (
195 ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
198 /* There must be at least a DSDT installed */
200 if (AcpiGbl_DSDT == NULL)
202 ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
203 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
207 * Load the namespace. The DSDT is required,
208 * but the SSDT and PSDT tables are optional.
210 Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
211 if (ACPI_FAILURE (Status))
213 return_ACPI_STATUS (Status);
216 /* Ignore exceptions from these */
218 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
219 (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
221 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
222 "ACPI Namespace successfully loaded at root %p\n",
225 return_ACPI_STATUS (Status);
229 #ifdef ACPI_FUTURE_IMPLEMENTATION
230 /*******************************************************************************
232 * FUNCTION: AcpiNsDeleteSubtree
234 * PARAMETERS: StartHandle - Handle in namespace where search begins
238 * DESCRIPTION: Walks the namespace starting at the given handle and deletes
239 * all objects, entries, and scopes in the entire subtree.
241 * Namespace/Interpreter should be locked or the subsystem should
242 * be in shutdown before this routine is called.
244 ******************************************************************************/
247 AcpiNsDeleteSubtree (
248 ACPI_HANDLE StartHandle)
251 ACPI_HANDLE ChildHandle;
252 ACPI_HANDLE ParentHandle;
253 ACPI_HANDLE NextChildHandle;
258 ACPI_FUNCTION_TRACE (NsDeleteSubtree);
261 ParentHandle = StartHandle;
266 * Traverse the tree of objects until we bubble back up
267 * to where we started.
271 /* Attempt to get the next object in this scope */
273 Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
274 ChildHandle, &NextChildHandle);
276 ChildHandle = NextChildHandle;
278 /* Did we get a new object? */
280 if (ACPI_SUCCESS (Status))
282 /* Check if this object has any children */
284 if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
288 * There is at least one child of this object,
292 ParentHandle = ChildHandle;
299 * No more children in this object, go back up to
300 * the object's parent
304 /* Delete all children now */
306 AcpiNsDeleteChildren (ChildHandle);
308 ChildHandle = ParentHandle;
309 Status = AcpiGetParent (ParentHandle, &ParentHandle);
310 if (ACPI_FAILURE (Status))
312 return_ACPI_STATUS (Status);
317 /* Now delete the starting object, and we are done */
319 AcpiNsRemoveNode (ChildHandle);
320 return_ACPI_STATUS (AE_OK);
324 /*******************************************************************************
326 * FUNCTION: AcpiNsUnloadNameSpace
328 * PARAMETERS: Handle - Root of namespace subtree to be deleted
332 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking
333 * event. Deletes an entire subtree starting from (and
334 * including) the given handle.
336 ******************************************************************************/
339 AcpiNsUnloadNamespace (
345 ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
348 /* Parameter validation */
350 if (!AcpiGbl_RootNode)
352 return_ACPI_STATUS (AE_NO_NAMESPACE);
357 return_ACPI_STATUS (AE_BAD_PARAMETER);
360 /* This function does the real work */
362 Status = AcpiNsDeleteSubtree (Handle);
364 return_ACPI_STATUS (Status);