1 /*******************************************************************************
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, 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_DEBUG_PRINT((ACPI_DB_ERROR
,
114 "Could not create predefined name %s, %s\n",
116 acpi_format_exception(status
)));
120 * Name entered successfully.
121 * If entry in pre_defined_names[] specifies an
122 * initial value, create the initial value.
125 status
= acpi_os_predefined_override(init_val
, &val
);
126 if (ACPI_FAILURE(status
)) {
127 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
128 "Could not override predefined %s\n",
137 * Entry requests an initial value, allocate a
141 acpi_ut_create_internal_object(init_val
->type
);
143 status
= AE_NO_MEMORY
;
144 goto unlock_and_exit
;
148 * Convert value string from table entry to
149 * internal representation. Only types actually
150 * used for initial values are implemented here.
152 switch (init_val
->type
) {
153 case ACPI_TYPE_METHOD
:
154 obj_desc
->method
.param_count
=
155 (u8
) ACPI_TO_INTEGER(val
);
156 obj_desc
->common
.flags
|= AOPOBJ_DATA_VALID
;
158 #if defined (ACPI_ASL_COMPILER)
160 /* save the parameter count for the i_aSL compiler */
162 new_node
->value
= obj_desc
->method
.param_count
;
164 /* Mark this as a very SPECIAL method */
166 obj_desc
->method
.method_flags
=
167 AML_METHOD_INTERNAL_ONLY
;
169 #ifndef ACPI_DUMP_APP
170 obj_desc
->method
.implementation
=
171 acpi_ut_osi_implementation
;
176 case ACPI_TYPE_INTEGER
:
178 obj_desc
->integer
.value
= ACPI_TO_INTEGER(val
);
181 case ACPI_TYPE_STRING
:
184 * Build an object around the static string
186 obj_desc
->string
.length
=
187 (u32
) ACPI_STRLEN(val
);
188 obj_desc
->string
.pointer
= val
;
189 obj_desc
->common
.flags
|= AOPOBJ_STATIC_POINTER
;
192 case ACPI_TYPE_MUTEX
:
194 obj_desc
->mutex
.node
= new_node
;
195 obj_desc
->mutex
.sync_level
=
196 (u8
) (ACPI_TO_INTEGER(val
) - 1);
198 if (ACPI_STRCMP(init_val
->name
, "_GL_") == 0) {
200 * Create a counting semaphore for the
204 acpi_os_create_semaphore
205 (ACPI_NO_UNIT_LIMIT
, 1,
206 &obj_desc
->mutex
.semaphore
);
207 if (ACPI_FAILURE(status
)) {
208 acpi_ut_remove_reference
210 goto unlock_and_exit
;
214 * We just created the mutex for the
215 * global lock, save it
217 acpi_gbl_global_lock_semaphore
=
218 obj_desc
->mutex
.semaphore
;
222 status
= acpi_os_create_semaphore(1, 1,
226 if (ACPI_FAILURE(status
)) {
227 acpi_ut_remove_reference
229 goto unlock_and_exit
;
236 ACPI_REPORT_ERROR(("Unsupported initial type value %X\n", init_val
->type
));
237 acpi_ut_remove_reference(obj_desc
);
242 /* Store pointer to value descriptor in the Node */
244 status
= acpi_ns_attach_object(new_node
, obj_desc
,
248 /* Remove local reference to the object */
250 acpi_ut_remove_reference(obj_desc
);
255 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
257 /* Save a handle to "_GPE", it is always present */
259 if (ACPI_SUCCESS(status
)) {
261 acpi_ns_get_node_by_path("\\_GPE", NULL
,
263 &acpi_gbl_fadt_gpe_device
);
266 return_ACPI_STATUS(status
);
269 /*******************************************************************************
271 * FUNCTION: acpi_ns_lookup
273 * PARAMETERS: scope_info - Current scope info block
274 * Pathname - Search pathname, in internal format
275 * (as represented in the AML stream)
276 * Type - Type associated with name
277 * interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
278 * Flags - Flags describing the search restrictions
279 * walk_state - Current state of the walk
280 * return_node - Where the Node is placed (if found
281 * or created successfully)
285 * DESCRIPTION: Find or enter the passed name in the name space.
286 * Log an error if name not found in Exec mode.
288 * MUTEX: Assumes namespace is locked.
290 ******************************************************************************/
293 acpi_ns_lookup(union acpi_generic_state
*scope_info
,
295 acpi_object_type type
,
296 acpi_interpreter_mode interpreter_mode
,
298 struct acpi_walk_state
*walk_state
,
299 struct acpi_namespace_node
**return_node
)
302 char *path
= pathname
;
303 struct acpi_namespace_node
*prefix_node
;
304 struct acpi_namespace_node
*current_node
= NULL
;
305 struct acpi_namespace_node
*this_node
= NULL
;
308 acpi_name simple_name
;
309 acpi_object_type type_to_check_for
;
310 acpi_object_type this_search_type
;
311 u32 search_parent_flag
= ACPI_NS_SEARCH_PARENT
;
312 u32 local_flags
= flags
& ~(ACPI_NS_ERROR_IF_FOUND
|
313 ACPI_NS_SEARCH_PARENT
);
315 ACPI_FUNCTION_TRACE("ns_lookup");
318 return_ACPI_STATUS(AE_BAD_PARAMETER
);
321 acpi_gbl_ns_lookup_count
++;
322 *return_node
= ACPI_ENTRY_NOT_FOUND
;
324 if (!acpi_gbl_root_node
) {
325 return_ACPI_STATUS(AE_NO_NAMESPACE
);
329 * Get the prefix scope.
330 * A null scope means use the root scope
332 if ((!scope_info
) || (!scope_info
->scope
.node
)) {
333 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
334 "Null scope prefix, using root node (%p)\n",
335 acpi_gbl_root_node
));
337 prefix_node
= acpi_gbl_root_node
;
339 prefix_node
= scope_info
->scope
.node
;
340 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node
) !=
341 ACPI_DESC_TYPE_NAMED
) {
342 ACPI_REPORT_ERROR(("ns_lookup: %p is not a namespace node [%s]\n", prefix_node
, acpi_ut_get_descriptor_name(prefix_node
)));
343 return_ACPI_STATUS(AE_AML_INTERNAL
);
347 * This node might not be a actual "scope" node (such as a
348 * Device/Method, etc.) It could be a Package or other object node.
349 * Backup up the tree to find the containing scope node.
351 while (!acpi_ns_opens_scope(prefix_node
->type
) &&
352 prefix_node
->type
!= ACPI_TYPE_ANY
) {
353 prefix_node
= acpi_ns_get_parent_node(prefix_node
);
357 /* Save type TBD: may be no longer necessary */
359 type_to_check_for
= type
;
362 * Begin examination of the actual pathname
365 /* A Null name_path is allowed and refers to the root */
368 this_node
= acpi_gbl_root_node
;
371 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
372 "Null Pathname (Zero segments), Flags=%X\n",
376 * Name pointer is valid (and must be in internal name format)
378 * Check for scope prefixes:
380 * As represented in the AML stream, a namepath consists of an
381 * optional scope prefix followed by a name segment part.
383 * If present, the scope prefix is either a Root Prefix (in
384 * which case the name is fully qualified), or one or more
385 * Parent Prefixes (in which case the name's scope is relative
386 * to the current scope).
388 if (*path
== (u8
) AML_ROOT_PREFIX
) {
389 /* Pathname is fully qualified, start from the root */
391 this_node
= acpi_gbl_root_node
;
392 search_parent_flag
= ACPI_NS_NO_UPSEARCH
;
394 /* Point to name segment part */
398 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
399 "Path is absolute from root [%p]\n",
402 /* Pathname is relative to current scope, start there */
404 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
405 "Searching relative to prefix scope [%4.4s] (%p)\n",
406 acpi_ut_get_node_name(prefix_node
),
410 * Handle multiple Parent Prefixes (carat) by just getting
411 * the parent node for each prefix instance.
413 this_node
= prefix_node
;
415 while (*path
== (u8
) AML_PARENT_PREFIX
) {
416 /* Name is fully qualified, no search rules apply */
418 search_parent_flag
= ACPI_NS_NO_UPSEARCH
;
420 * Point past this prefix to the name segment
421 * part or the next Parent Prefix
425 /* Backup to the parent node */
428 this_node
= acpi_ns_get_parent_node(this_node
);
430 /* Current scope has no parent scope */
432 ACPI_REPORT_ERROR(("ACPI path has too many parent prefixes (^) - reached beyond root node\n"));
433 return_ACPI_STATUS(AE_NOT_FOUND
);
437 if (search_parent_flag
== ACPI_NS_NO_UPSEARCH
) {
438 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
439 "Search scope is [%4.4s], path has %d carat(s)\n",
440 acpi_ut_get_node_name
441 (this_node
), num_carats
));
446 * Determine the number of ACPI name segments in this pathname.
448 * The segment part consists of either:
449 * - A Null name segment (0)
450 * - A dual_name_prefix followed by two 4-byte name segments
451 * - A multi_name_prefix followed by a byte indicating the
452 * number of segments and the segments themselves.
453 * - A single 4-byte name segment
455 * Examine the name prefix opcode, if any, to determine the number of
461 * Null name after a root or parent prefixes. We already
462 * have the correct target node and there are no name segments.
465 type
= this_node
->type
;
467 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
468 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
472 case AML_DUAL_NAME_PREFIX
:
474 /* More than one name_seg, search rules do not apply */
476 search_parent_flag
= ACPI_NS_NO_UPSEARCH
;
478 /* Two segments, point to first name segment */
483 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
484 "Dual Pathname (2 segments, Flags=%X)\n",
488 case AML_MULTI_NAME_PREFIX_OP
:
490 /* More than one name_seg, search rules do not apply */
492 search_parent_flag
= ACPI_NS_NO_UPSEARCH
;
494 /* Extract segment count, point to first name segment */
497 num_segments
= (u32
) (u8
) * path
;
500 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
501 "Multi Pathname (%d Segments, Flags=%X) \n",
502 num_segments
, flags
));
507 * Not a Null name, no Dual or Multi prefix, hence there is
508 * only one name segment and Pathname is already pointing to it.
512 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
513 "Simple Pathname (1 segment, Flags=%X)\n",
518 ACPI_DEBUG_EXEC(acpi_ns_print_pathname(num_segments
, path
));
522 * Search namespace for each segment of the name. Loop through and
523 * verify (or add to the namespace) each name segment.
525 * The object type is significant only at the last name
526 * segment. (We don't care about the types along the path, only
527 * the type of the final target object.)
529 this_search_type
= ACPI_TYPE_ANY
;
530 current_node
= this_node
;
531 while (num_segments
&& current_node
) {
535 * This is the last segment, enable typechecking
537 this_search_type
= type
;
540 * Only allow automatic parent search (search rules) if the caller
541 * requested it AND we have a single, non-fully-qualified name_seg
543 if ((search_parent_flag
!= ACPI_NS_NO_UPSEARCH
) &&
544 (flags
& ACPI_NS_SEARCH_PARENT
)) {
545 local_flags
|= ACPI_NS_SEARCH_PARENT
;
548 /* Set error flag according to caller */
550 if (flags
& ACPI_NS_ERROR_IF_FOUND
) {
551 local_flags
|= ACPI_NS_ERROR_IF_FOUND
;
555 /* Extract one ACPI name from the front of the pathname */
557 ACPI_MOVE_32_TO_32(&simple_name
, path
);
559 /* Try to find the single (4 character) ACPI name */
562 acpi_ns_search_and_enter(simple_name
, walk_state
,
563 current_node
, interpreter_mode
,
564 this_search_type
, local_flags
,
566 if (ACPI_FAILURE(status
)) {
567 if (status
== AE_NOT_FOUND
) {
568 /* Name not found in ACPI namespace */
570 ACPI_DEBUG_PRINT((ACPI_DB_NAMES
,
571 "Name [%4.4s] not found in scope [%4.4s] %p\n",
572 (char *)&simple_name
,
573 (char *)¤t_node
->name
,
577 *return_node
= this_node
;
578 return_ACPI_STATUS(status
);
582 * Sanity typecheck of the target object:
584 * If 1) This is the last segment (num_segments == 0)
585 * 2) And we are looking for a specific type
586 * (Not checking for TYPE_ANY)
587 * 3) Which is not an alias
588 * 4) Which is not a local type (TYPE_SCOPE)
589 * 5) And the type of target object is known (not TYPE_ANY)
590 * 6) And target object does not match what we are looking for
592 * Then we have a type mismatch. Just warn and ignore it.
594 if ((num_segments
== 0) &&
595 (type_to_check_for
!= ACPI_TYPE_ANY
) &&
596 (type_to_check_for
!= ACPI_TYPE_LOCAL_ALIAS
) &&
597 (type_to_check_for
!= ACPI_TYPE_LOCAL_METHOD_ALIAS
) &&
598 (type_to_check_for
!= ACPI_TYPE_LOCAL_SCOPE
) &&
599 (this_node
->type
!= ACPI_TYPE_ANY
) &&
600 (this_node
->type
!= type_to_check_for
)) {
601 /* Complain about a type mismatch */
603 ACPI_REPORT_WARNING(("ns_lookup: Type mismatch on %4.4s (%s), searching for (%s)\n", (char *)&simple_name
, acpi_ut_get_type_name(this_node
->type
), acpi_ut_get_type_name(type_to_check_for
)));
607 * If this is the last name segment and we are not looking for a
608 * specific type, but the type of found object is known, use that type
609 * to see if it opens a scope.
611 if ((num_segments
== 0) && (type
== ACPI_TYPE_ANY
)) {
612 type
= this_node
->type
;
615 /* Point to next name segment and make this node current */
617 path
+= ACPI_NAME_SIZE
;
618 current_node
= this_node
;
622 * Always check if we need to open a new scope
624 if (!(flags
& ACPI_NS_DONT_OPEN_SCOPE
) && (walk_state
)) {
626 * If entry is a type which opens a scope, push the new scope on the
629 if (acpi_ns_opens_scope(type
)) {
631 acpi_ds_scope_stack_push(this_node
, type
,
633 if (ACPI_FAILURE(status
)) {
634 return_ACPI_STATUS(status
);
639 *return_node
= this_node
;
640 return_ACPI_STATUS(AE_OK
);