blob: 5cbf15ffe7d8ed38a38782b26f10114374b109cb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: nsload - namespace loading/expanding/contracting procedures
4 *
5 *****************************************************************************/
6
7/*
Bob Moore77848132012-01-12 13:27:23 +08008 * Copyright (C) 2000 - 2012, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
46#include "acnamesp.h"
47#include "acdispat.h"
48#include "actables.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#define _COMPONENT ACPI_NAMESPACE
Len Brown4be44fc2005-08-05 00:44:28 -040051ACPI_MODULE_NAME("nsload")
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Robert Moore44f6c012005-04-18 22:49:35 -040053/* Local prototypes */
Robert Moore44f6c012005-04-18 22:49:35 -040054#ifdef ACPI_FUTURE_IMPLEMENTATION
Len Brown4be44fc2005-08-05 00:44:28 -040055acpi_status acpi_ns_unload_namespace(acpi_handle handle);
Robert Moore44f6c012005-04-18 22:49:35 -040056
Len Brown4be44fc2005-08-05 00:44:28 -040057static acpi_status acpi_ns_delete_subtree(acpi_handle start_handle);
Robert Moore44f6c012005-04-18 22:49:35 -040058#endif
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#ifndef ACPI_NO_METHOD_EXECUTION
Linus Torvalds1da177e2005-04-16 15:20:36 -070061/*******************************************************************************
62 *
63 * FUNCTION: acpi_ns_load_table
64 *
Bob Mooref3d2e782007-02-02 19:48:18 +030065 * PARAMETERS: table_index - Index for table to be loaded
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 * Node - Owning NS node
67 *
68 * RETURN: Status
69 *
70 * DESCRIPTION: Load one ACPI table into the namespace
71 *
72 ******************************************************************************/
73
74acpi_status
Bob Moore67a119f2008-06-10 13:42:13 +080075acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076{
Len Brown4be44fc2005-08-05 00:44:28 -040077 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Bob Mooreb229cf92006-04-21 17:15:00 -040079 ACPI_FUNCTION_TRACE(ns_load_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 /*
82 * Parse the table and load the namespace with all named
83 * objects found within. Control methods are NOT parsed
84 * at this time. In fact, the control methods cannot be
85 * parsed until the entire namespace is loaded, because
86 * if a control method makes a forward reference (call)
87 * to another control method, we can't continue parsing
88 * because we don't know how many arguments to parse next!
89 */
Len Brown4be44fc2005-08-05 00:44:28 -040090 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
91 if (ACPI_FAILURE(status)) {
92 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 }
94
Bob Mooref3d2e782007-02-02 19:48:18 +030095 /* If table already loaded into namespace, just return */
96
97 if (acpi_tb_is_table_loaded(table_index)) {
98 status = AE_ALREADY_EXISTS;
99 goto unlock;
100 }
101
102 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
103 "**** Loading table into namespace ****\n"));
104
105 status = acpi_tb_allocate_owner_id(table_index);
106 if (ACPI_FAILURE(status)) {
107 goto unlock;
108 }
109
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400110 status = acpi_ns_parse_table(table_index, node);
Bob Mooref3d2e782007-02-02 19:48:18 +0300111 if (ACPI_SUCCESS(status)) {
112 acpi_tb_set_table_loaded_flag(table_index, TRUE);
113 } else {
Bob Moore1d18c052008-04-10 19:06:40 +0400114 (void)acpi_tb_release_owner_id(table_index);
Bob Mooref3d2e782007-02-02 19:48:18 +0300115 }
116
117 unlock:
Len Brown4be44fc2005-08-05 00:44:28 -0400118 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Len Brown4be44fc2005-08-05 00:44:28 -0400120 if (ACPI_FAILURE(status)) {
121 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 }
123
124 /*
125 * Now we can parse the control methods. We always parse
126 * them here for a sanity check, and if configured for
127 * just-in-time parsing, we delete the control method
128 * parse trees.
129 */
Len Brown4be44fc2005-08-05 00:44:28 -0400130 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
Bob Moored4913dc2009-03-06 10:05:18 +0800131 "**** Begin Table Method Parsing and Object Initialization\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Bob Mooref3d2e782007-02-02 19:48:18 +0300133 status = acpi_ds_initialize_objects(table_index, node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Len Brown4be44fc2005-08-05 00:44:28 -0400135 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
Bob Moored4913dc2009-03-06 10:05:18 +0800136 "**** Completed Table Method Parsing and Object Initialization\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Len Brown4be44fc2005-08-05 00:44:28 -0400138 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139}
140
Bob Mooref3d2e782007-02-02 19:48:18 +0300141#ifdef ACPI_OBSOLETE_FUNCTIONS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142/*******************************************************************************
143 *
144 * FUNCTION: acpi_load_namespace
145 *
146 * PARAMETERS: None
147 *
148 * RETURN: Status
149 *
150 * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
151 * (DSDT points to either the BIOS or a buffer.)
152 *
153 ******************************************************************************/
154
Len Brown4be44fc2005-08-05 00:44:28 -0400155acpi_status acpi_ns_load_namespace(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Len Brown4be44fc2005-08-05 00:44:28 -0400157 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Bob Mooreb229cf92006-04-21 17:15:00 -0400159 ACPI_FUNCTION_TRACE(acpi_load_name_space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161 /* There must be at least a DSDT installed */
162
163 if (acpi_gbl_DSDT == NULL) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500164 ACPI_ERROR((AE_INFO, "DSDT is not in memory"));
Len Brown4be44fc2005-08-05 00:44:28 -0400165 return_ACPI_STATUS(AE_NO_ACPI_TABLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 }
167
168 /*
169 * Load the namespace. The DSDT is required,
170 * but the SSDT and PSDT tables are optional.
171 */
Bob Mooreb229cf92006-04-21 17:15:00 -0400172 status = acpi_ns_load_table_by_type(ACPI_TABLE_ID_DSDT);
Len Brown4be44fc2005-08-05 00:44:28 -0400173 if (ACPI_FAILURE(status)) {
174 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 }
176
177 /* Ignore exceptions from these */
178
Bob Mooreb229cf92006-04-21 17:15:00 -0400179 (void)acpi_ns_load_table_by_type(ACPI_TABLE_ID_SSDT);
180 (void)acpi_ns_load_table_by_type(ACPI_TABLE_ID_PSDT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Len Brown4be44fc2005-08-05 00:44:28 -0400182 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
183 "ACPI Namespace successfully loaded at root %p\n",
184 acpi_gbl_root_node));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Len Brown4be44fc2005-08-05 00:44:28 -0400186 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187}
Bob Mooref3d2e782007-02-02 19:48:18 +0300188#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Robert Moore44f6c012005-04-18 22:49:35 -0400190#ifdef ACPI_FUTURE_IMPLEMENTATION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191/*******************************************************************************
192 *
193 * FUNCTION: acpi_ns_delete_subtree
194 *
195 * PARAMETERS: start_handle - Handle in namespace where search begins
196 *
197 * RETURNS Status
198 *
199 * DESCRIPTION: Walks the namespace starting at the given handle and deletes
200 * all objects, entries, and scopes in the entire subtree.
201 *
202 * Namespace/Interpreter should be locked or the subsystem should
203 * be in shutdown before this routine is called.
204 *
205 ******************************************************************************/
206
Len Brown4be44fc2005-08-05 00:44:28 -0400207static acpi_status acpi_ns_delete_subtree(acpi_handle start_handle)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
Len Brown4be44fc2005-08-05 00:44:28 -0400209 acpi_status status;
210 acpi_handle child_handle;
211 acpi_handle parent_handle;
212 acpi_handle next_child_handle;
213 acpi_handle dummy;
214 u32 level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Bob Mooreb229cf92006-04-21 17:15:00 -0400216 ACPI_FUNCTION_TRACE(ns_delete_subtree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 parent_handle = start_handle;
219 child_handle = NULL;
Len Brown4be44fc2005-08-05 00:44:28 -0400220 level = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222 /*
223 * Traverse the tree of objects until we bubble back up
224 * to where we started.
225 */
226 while (level > 0) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 /* Attempt to get the next object in this scope */
229
Len Brown4be44fc2005-08-05 00:44:28 -0400230 status = acpi_get_next_object(ACPI_TYPE_ANY, parent_handle,
231 child_handle, &next_child_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233 child_handle = next_child_handle;
234
235 /* Did we get a new object? */
236
Len Brown4be44fc2005-08-05 00:44:28 -0400237 if (ACPI_SUCCESS(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 /* Check if this object has any children */
240
Len Brown4be44fc2005-08-05 00:44:28 -0400241 if (ACPI_SUCCESS
242 (acpi_get_next_object
243 (ACPI_TYPE_ANY, child_handle, NULL, &dummy))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 /*
245 * There is at least one child of this object,
246 * visit the object
247 */
248 level++;
249 parent_handle = child_handle;
250 child_handle = NULL;
251 }
Len Brown4be44fc2005-08-05 00:44:28 -0400252 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 /*
254 * No more children in this object, go back up to
255 * the object's parent
256 */
257 level--;
258
259 /* Delete all children now */
260
Len Brown4be44fc2005-08-05 00:44:28 -0400261 acpi_ns_delete_children(child_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263 child_handle = parent_handle;
Len Brown4be44fc2005-08-05 00:44:28 -0400264 status = acpi_get_parent(parent_handle, &parent_handle);
265 if (ACPI_FAILURE(status)) {
266 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 }
268 }
269 }
270
271 /* Now delete the starting object, and we are done */
272
Bob Moore8e4319c2009-06-29 13:43:27 +0800273 acpi_ns_remove_node(child_handle);
Len Brown4be44fc2005-08-05 00:44:28 -0400274 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275}
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277/*******************************************************************************
278 *
279 * FUNCTION: acpi_ns_unload_name_space
280 *
281 * PARAMETERS: Handle - Root of namespace subtree to be deleted
282 *
283 * RETURN: Status
284 *
285 * DESCRIPTION: Shrinks the namespace, typically in response to an undocking
286 * event. Deletes an entire subtree starting from (and
287 * including) the given handle.
288 *
289 ******************************************************************************/
290
Len Brown4be44fc2005-08-05 00:44:28 -0400291acpi_status acpi_ns_unload_namespace(acpi_handle handle)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
Len Brown4be44fc2005-08-05 00:44:28 -0400293 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Bob Mooreb229cf92006-04-21 17:15:00 -0400295 ACPI_FUNCTION_TRACE(ns_unload_name_space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297 /* Parameter validation */
298
299 if (!acpi_gbl_root_node) {
Len Brown4be44fc2005-08-05 00:44:28 -0400300 return_ACPI_STATUS(AE_NO_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 }
302
303 if (!handle) {
Len Brown4be44fc2005-08-05 00:44:28 -0400304 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 }
306
307 /* This function does the real work */
308
Len Brown4be44fc2005-08-05 00:44:28 -0400309 status = acpi_ns_delete_subtree(handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Len Brown4be44fc2005-08-05 00:44:28 -0400311 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
Robert Moore44f6c012005-04-18 22:49:35 -0400313#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314#endif