1 /*******************************************************************************
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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 <acpi/acpi.h>
45 #include <acpi/amlcode.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acdispat.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsaccess")
52 /*******************************************************************************
54 * FUNCTION: acpi_ns_root_initialize
60 * DESCRIPTION: Allocate and initialize the default root named objects
62 * MUTEX: Locks namespace for entire execution
64 ******************************************************************************/
65 acpi_status acpi_ns_root_initialize(void)
68 const struct acpi_predefined_names *init_val = NULL;
69 struct acpi_namespace_node *new_node;
70 union acpi_operand_object *obj_desc;
71 acpi_string val = NULL;
73 ACPI_FUNCTION_TRACE("ns_root_initialize");
75 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
76 if (ACPI_FAILURE(status)) {
77 return_ACPI_STATUS(status);
81 * The global root ptr is initially NULL, so a non-NULL value indicates
82 * that acpi_ns_root_initialize() has already been called; just return.
84 if (acpi_gbl_root_node) {
90 * Tell the rest of the subsystem that the root is initialized
91 * (This is OK because the namespace is locked)
93 acpi_gbl_root_node = &acpi_gbl_root_node_struct;
95 /* Enter the pre-defined names in the name table */
97 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
98 "Entering predefined entries into namespace\n"));
100 for (init_val = acpi_gbl_pre_defined_names; init_val->name; init_val++) {
101 /* _OSI is optional for now, will be permanent later */
103 if (!ACPI_STRCMP(init_val->name, "_OSI")
104 && !acpi_gbl_create_osi_method) {
108 status = acpi_ns_lookup(NULL, init_val->name, init_val->type,
109 ACPI_IMODE_LOAD_PASS2,
110 ACPI_NS_NO_UPSEARCH, NULL, &new_node);
112 if (ACPI_FAILURE(status) || (!new_node)) { /* Must be on same line for code converter */
113 ACPI_REPORT_ERROR(("Could not create predefined name %s, %s\n", init_val->name, acpi_format_exception(status)));
117 * Name entered successfully.
118 * If entry in pre_defined_names[] specifies an
119 * initial value, create the initial value.
122 status = acpi_os_predefined_override(init_val, &val);
123 if (ACPI_FAILURE(status)) {
124 ACPI_REPORT_ERROR(("Could not override predefined %s\n", init_val->name));
132 * Entry requests an initial value, allocate a
136 acpi_ut_create_internal_object(init_val->type);
138 status = AE_NO_MEMORY;
139 goto unlock_and_exit;
143 * Convert value string from table entry to
144 * internal representation. Only types actually
145 * used for initial values are implemented here.
147 switch (init_val->type) {
148 case ACPI_TYPE_METHOD:
149 obj_desc->method.param_count =
150 (u8) ACPI_TO_INTEGER(val);
151 obj_desc->common.flags |= AOPOBJ_DATA_VALID;
153 #if defined (ACPI_ASL_COMPILER)
155 /* save the parameter count for the i_aSL compiler */
157 new_node->value = obj_desc->method.param_count;
159 /* Mark this as a very SPECIAL method */
161 obj_desc->method.method_flags =
162 AML_METHOD_INTERNAL_ONLY;
164 #ifndef ACPI_DUMP_APP
165 obj_desc->method.implementation =
166 acpi_ut_osi_implementation;
171 case ACPI_TYPE_INTEGER:
173 obj_desc->integer.value = ACPI_TO_INTEGER(val);
176 case ACPI_TYPE_STRING:
179 * Build an object around the static string
181 obj_desc->string.length =
182 (u32) ACPI_STRLEN(val);
183 obj_desc->string.pointer = val;
184 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
187 case ACPI_TYPE_MUTEX:
189 obj_desc->mutex.node = new_node;
190 obj_desc->mutex.sync_level =
191 (u8) (ACPI_TO_INTEGER(val) - 1);
193 if (ACPI_STRCMP(init_val->name, "_GL_") == 0) {
195 * Create a counting semaphore for the
199 acpi_os_create_semaphore
200 (ACPI_NO_UNIT_LIMIT, 1,
201 &obj_desc->mutex.semaphore);
202 if (ACPI_FAILURE(status)) {
203 acpi_ut_remove_reference
205 goto unlock_and_exit;
209 * We just created the mutex for the
210 * global lock, save it
212 acpi_gbl_global_lock_semaphore =
213 obj_desc->mutex.semaphore;
217 status = acpi_os_create_semaphore(1, 1,
221 if (ACPI_FAILURE(status)) {
222 acpi_ut_remove_reference
224 goto unlock_and_exit;
231 ACPI_REPORT_ERROR(("Unsupported initial type value %X\n", init_val->type));
232 acpi_ut_remove_reference(obj_desc);
237 /* Store pointer to value descriptor in the Node */
239 status = acpi_ns_attach_object(new_node, obj_desc,
243 /* Remove local reference to the object */
245 acpi_ut_remove_reference(obj_desc);
250 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
252 /* Save a handle to "_GPE", it is always present */
254 if (ACPI_SUCCESS(status)) {
256 acpi_ns_get_node_by_path("\\_GPE", NULL,
258 &acpi_gbl_fadt_gpe_device);
261 return_ACPI_STATUS(status);
264 /*******************************************************************************
266 * FUNCTION: acpi_ns_lookup
268 * PARAMETERS: scope_info - Current scope info block
269 * Pathname - Search pathname, in internal format
270 * (as represented in the AML stream)
271 * Type - Type associated with name
272 * interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
273 * Flags - Flags describing the search restrictions
274 * walk_state - Current state of the walk
275 * return_node - Where the Node is placed (if found
276 * or created successfully)
280 * DESCRIPTION: Find or enter the passed name in the name space.
281 * Log an error if name not found in Exec mode.
283 * MUTEX: Assumes namespace is locked.
285 ******************************************************************************/
288 acpi_ns_lookup(union acpi_generic_state *scope_info,
290 acpi_object_type type,
291 acpi_interpreter_mode interpreter_mode,
293 struct acpi_walk_state *walk_state,
294 struct acpi_namespace_node **return_node)
297 char *path = pathname;
298 struct acpi_namespace_node *prefix_node;
299 struct acpi_namespace_node *current_node = NULL;
300 struct acpi_namespace_node *this_node = NULL;
303 acpi_name simple_name;
304 acpi_object_type type_to_check_for;
305 acpi_object_type this_search_type;
306 u32 search_parent_flag = ACPI_NS_SEARCH_PARENT;
307 u32 local_flags = flags & ~(ACPI_NS_ERROR_IF_FOUND |
308 ACPI_NS_SEARCH_PARENT);
310 ACPI_FUNCTION_TRACE("ns_lookup");
313 return_ACPI_STATUS(AE_BAD_PARAMETER);
316 acpi_gbl_ns_lookup_count++;
317 *return_node = ACPI_ENTRY_NOT_FOUND;
319 if (!acpi_gbl_root_node) {
320 return_ACPI_STATUS(AE_NO_NAMESPACE);
324 * Get the prefix scope.
325 * A null scope means use the root scope
327 if ((!scope_info) || (!scope_info->scope.node)) {
328 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
329 "Null scope prefix, using root node (%p)\n",
330 acpi_gbl_root_node));
332 prefix_node = acpi_gbl_root_node;
334 prefix_node = scope_info->scope.node;
335 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node) !=
336 ACPI_DESC_TYPE_NAMED) {
337 ACPI_REPORT_ERROR(("%p is not a namespace node [%s]\n",
339 acpi_ut_get_descriptor_name
341 return_ACPI_STATUS(AE_AML_INTERNAL);
345 * This node might not be a actual "scope" node (such as a
346 * Device/Method, etc.) It could be a Package or other object node.
347 * Backup up the tree to find the containing scope node.
349 while (!acpi_ns_opens_scope(prefix_node->type) &&
350 prefix_node->type != ACPI_TYPE_ANY) {
351 prefix_node = acpi_ns_get_parent_node(prefix_node);
355 /* Save type TBD: may be no longer necessary */
357 type_to_check_for = type;
360 * Begin examination of the actual pathname
363 /* A Null name_path is allowed and refers to the root */
366 this_node = acpi_gbl_root_node;
369 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
370 "Null Pathname (Zero segments), Flags=%X\n",
374 * Name pointer is valid (and must be in internal name format)
376 * Check for scope prefixes:
378 * As represented in the AML stream, a namepath consists of an
379 * optional scope prefix followed by a name segment part.
381 * If present, the scope prefix is either a Root Prefix (in
382 * which case the name is fully qualified), or one or more
383 * Parent Prefixes (in which case the name's scope is relative
384 * to the current scope).
386 if (*path == (u8) AML_ROOT_PREFIX) {
387 /* Pathname is fully qualified, start from the root */
389 this_node = acpi_gbl_root_node;
390 search_parent_flag = ACPI_NS_NO_UPSEARCH;
392 /* Point to name segment part */
396 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
397 "Path is absolute from root [%p]\n",
400 /* Pathname is relative to current scope, start there */
402 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
403 "Searching relative to prefix scope [%4.4s] (%p)\n",
404 acpi_ut_get_node_name(prefix_node),
408 * Handle multiple Parent Prefixes (carat) by just getting
409 * the parent node for each prefix instance.
411 this_node = prefix_node;
413 while (*path == (u8) AML_PARENT_PREFIX) {
414 /* Name is fully qualified, no search rules apply */
416 search_parent_flag = ACPI_NS_NO_UPSEARCH;
418 * Point past this prefix to the name segment
419 * part or the next Parent Prefix
423 /* Backup to the parent node */
426 this_node = acpi_ns_get_parent_node(this_node);
428 /* Current scope has no parent scope */
430 ACPI_REPORT_ERROR(("ACPI path has too many parent prefixes (^) - reached beyond root node\n"));
431 return_ACPI_STATUS(AE_NOT_FOUND);
435 if (search_parent_flag == ACPI_NS_NO_UPSEARCH) {
436 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
437 "Search scope is [%4.4s], path has %d carat(s)\n",
438 acpi_ut_get_node_name
439 (this_node), num_carats));
444 * Determine the number of ACPI name segments in this pathname.
446 * The segment part consists of either:
447 * - A Null name segment (0)
448 * - A dual_name_prefix followed by two 4-byte name segments
449 * - A multi_name_prefix followed by a byte indicating the
450 * number of segments and the segments themselves.
451 * - A single 4-byte name segment
453 * Examine the name prefix opcode, if any, to determine the number of
459 * Null name after a root or parent prefixes. We already
460 * have the correct target node and there are no name segments.
463 type = this_node->type;
465 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
466 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
470 case AML_DUAL_NAME_PREFIX:
472 /* More than one name_seg, search rules do not apply */
474 search_parent_flag = ACPI_NS_NO_UPSEARCH;
476 /* Two segments, point to first name segment */
481 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
482 "Dual Pathname (2 segments, Flags=%X)\n",
486 case AML_MULTI_NAME_PREFIX_OP:
488 /* More than one name_seg, search rules do not apply */
490 search_parent_flag = ACPI_NS_NO_UPSEARCH;
492 /* Extract segment count, point to first name segment */
495 num_segments = (u32) (u8) * path;
498 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
499 "Multi Pathname (%d Segments, Flags=%X)\n",
500 num_segments, flags));
505 * Not a Null name, no Dual or Multi prefix, hence there is
506 * only one name segment and Pathname is already pointing to it.
510 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
511 "Simple Pathname (1 segment, Flags=%X)\n",
516 ACPI_DEBUG_EXEC(acpi_ns_print_pathname(num_segments, path));
520 * Search namespace for each segment of the name. Loop through and
521 * verify (or add to the namespace) each name segment.
523 * The object type is significant only at the last name
524 * segment. (We don't care about the types along the path, only
525 * the type of the final target object.)
527 this_search_type = ACPI_TYPE_ANY;
528 current_node = this_node;
529 while (num_segments && current_node) {
533 * This is the last segment, enable typechecking
535 this_search_type = type;
538 * Only allow automatic parent search (search rules) if the caller
539 * requested it AND we have a single, non-fully-qualified name_seg
541 if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
542 (flags & ACPI_NS_SEARCH_PARENT)) {
543 local_flags |= ACPI_NS_SEARCH_PARENT;
546 /* Set error flag according to caller */
548 if (flags & ACPI_NS_ERROR_IF_FOUND) {
549 local_flags |= ACPI_NS_ERROR_IF_FOUND;
553 /* Extract one ACPI name from the front of the pathname */
555 ACPI_MOVE_32_TO_32(&simple_name, path);
557 /* Try to find the single (4 character) ACPI name */
560 acpi_ns_search_and_enter(simple_name, walk_state,
561 current_node, interpreter_mode,
562 this_search_type, local_flags,
564 if (ACPI_FAILURE(status)) {
565 if (status == AE_NOT_FOUND) {
566 /* Name not found in ACPI namespace */
568 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
569 "Name [%4.4s] not found in scope [%4.4s] %p\n",
570 (char *)&simple_name,
571 (char *)¤t_node->name,
575 *return_node = this_node;
576 return_ACPI_STATUS(status);
580 * Sanity typecheck of the target object:
582 * If 1) This is the last segment (num_segments == 0)
583 * 2) And we are looking for a specific type
584 * (Not checking for TYPE_ANY)
585 * 3) Which is not an alias
586 * 4) Which is not a local type (TYPE_SCOPE)
587 * 5) And the type of target object is known (not TYPE_ANY)
588 * 6) And target object does not match what we are looking for
590 * Then we have a type mismatch. Just warn and ignore it.
592 if ((num_segments == 0) &&
593 (type_to_check_for != ACPI_TYPE_ANY) &&
594 (type_to_check_for != ACPI_TYPE_LOCAL_ALIAS) &&
595 (type_to_check_for != ACPI_TYPE_LOCAL_METHOD_ALIAS) &&
596 (type_to_check_for != ACPI_TYPE_LOCAL_SCOPE) &&
597 (this_node->type != ACPI_TYPE_ANY) &&
598 (this_node->type != type_to_check_for)) {
599 /* Complain about a type mismatch */
601 ACPI_REPORT_WARNING(("ns_lookup: Type mismatch on %4.4s (%s), searching for (%s)\n", ACPI_CAST_PTR(char, &simple_name), acpi_ut_get_type_name(this_node->type), acpi_ut_get_type_name(type_to_check_for)));
605 * If this is the last name segment and we are not looking for a
606 * specific type, but the type of found object is known, use that type
607 * to see if it opens a scope.
609 if ((num_segments == 0) && (type == ACPI_TYPE_ANY)) {
610 type = this_node->type;
613 /* Point to next name segment and make this node current */
615 path += ACPI_NAME_SIZE;
616 current_node = this_node;
620 * Always check if we need to open a new scope
622 if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
624 * If entry is a type which opens a scope, push the new scope on the
627 if (acpi_ns_opens_scope(type)) {
629 acpi_ds_scope_stack_push(this_node, type,
631 if (ACPI_FAILURE(status)) {
632 return_ACPI_STATUS(status);
637 *return_node = this_node;
638 return_ACPI_STATUS(AE_OK);