Loading...
1/*******************************************************************************
2 *
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
4 *
5 ******************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * 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
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "amlcode.h"
47#include "acnamesp.h"
48#include "acdispat.h"
49
50#define _COMPONENT ACPI_NAMESPACE
51ACPI_MODULE_NAME("nsaccess")
52
53/*******************************************************************************
54 *
55 * FUNCTION: acpi_ns_root_initialize
56 *
57 * PARAMETERS: None
58 *
59 * RETURN: Status
60 *
61 * DESCRIPTION: Allocate and initialize the default root named objects
62 *
63 * MUTEX: Locks namespace for entire execution
64 *
65 ******************************************************************************/
66acpi_status acpi_ns_root_initialize(void)
67{
68 acpi_status status;
69 const struct acpi_predefined_names *init_val = NULL;
70 struct acpi_namespace_node *new_node;
71 union acpi_operand_object *obj_desc;
72 acpi_string val = NULL;
73
74 ACPI_FUNCTION_TRACE(ns_root_initialize);
75
76 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
77 if (ACPI_FAILURE(status)) {
78 return_ACPI_STATUS(status);
79 }
80
81 /*
82 * The global root ptr is initially NULL, so a non-NULL value indicates
83 * that acpi_ns_root_initialize() has already been called; just return.
84 */
85 if (acpi_gbl_root_node) {
86 status = AE_OK;
87 goto unlock_and_exit;
88 }
89
90 /*
91 * Tell the rest of the subsystem that the root is initialized
92 * (This is OK because the namespace is locked)
93 */
94 acpi_gbl_root_node = &acpi_gbl_root_node_struct;
95
96 /* Enter the pre-defined names in the name table */
97
98 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
99 "Entering predefined entries into namespace\n"));
100
101 for (init_val = acpi_gbl_pre_defined_names; init_val->name; init_val++) {
102
103 /* _OSI is optional for now, will be permanent later */
104
105 if (!ACPI_STRCMP(init_val->name, "_OSI")
106 && !acpi_gbl_create_osi_method) {
107 continue;
108 }
109
110 status = acpi_ns_lookup(NULL, init_val->name, init_val->type,
111 ACPI_IMODE_LOAD_PASS2,
112 ACPI_NS_NO_UPSEARCH, NULL, &new_node);
113
114 if (ACPI_FAILURE(status) || (!new_node)) { /* Must be on same line for code converter */
115 ACPI_EXCEPTION((AE_INFO, status,
116 "Could not create predefined name %s",
117 init_val->name));
118 }
119
120 /*
121 * Name entered successfully. If entry in pre_defined_names[] specifies
122 * an initial value, create the initial value.
123 */
124 if (init_val->val) {
125 status = acpi_os_predefined_override(init_val, &val);
126 if (ACPI_FAILURE(status)) {
127 ACPI_ERROR((AE_INFO,
128 "Could not override predefined %s",
129 init_val->name));
130 }
131
132 if (!val) {
133 val = init_val->val;
134 }
135
136 /*
137 * Entry requests an initial value, allocate a
138 * descriptor for it.
139 */
140 obj_desc =
141 acpi_ut_create_internal_object(init_val->type);
142 if (!obj_desc) {
143 status = AE_NO_MEMORY;
144 goto unlock_and_exit;
145 }
146
147 /*
148 * Convert value string from table entry to
149 * internal representation. Only types actually
150 * used for initial values are implemented here.
151 */
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;
157
158#if defined (ACPI_ASL_COMPILER)
159
160 /* Save the parameter count for the i_aSL compiler */
161
162 new_node->value = obj_desc->method.param_count;
163#else
164 /* Mark this as a very SPECIAL method */
165
166 obj_desc->method.info_flags =
167 ACPI_METHOD_INTERNAL_ONLY;
168 obj_desc->method.dispatch.implementation =
169 acpi_ut_osi_implementation;
170#endif
171 break;
172
173 case ACPI_TYPE_INTEGER:
174
175 obj_desc->integer.value = ACPI_TO_INTEGER(val);
176 break;
177
178 case ACPI_TYPE_STRING:
179
180 /* Build an object around the static string */
181
182 obj_desc->string.length =
183 (u32) ACPI_STRLEN(val);
184 obj_desc->string.pointer = val;
185 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
186 break;
187
188 case ACPI_TYPE_MUTEX:
189
190 obj_desc->mutex.node = new_node;
191 obj_desc->mutex.sync_level =
192 (u8) (ACPI_TO_INTEGER(val) - 1);
193
194 /* Create a mutex */
195
196 status =
197 acpi_os_create_mutex(&obj_desc->mutex.
198 os_mutex);
199 if (ACPI_FAILURE(status)) {
200 acpi_ut_remove_reference(obj_desc);
201 goto unlock_and_exit;
202 }
203
204 /* Special case for ACPI Global Lock */
205
206 if (ACPI_STRCMP(init_val->name, "_GL_") == 0) {
207 acpi_gbl_global_lock_mutex = obj_desc;
208
209 /* Create additional counting semaphore for global lock */
210
211 status =
212 acpi_os_create_semaphore(1, 0,
213 &acpi_gbl_global_lock_semaphore);
214 if (ACPI_FAILURE(status)) {
215 acpi_ut_remove_reference
216 (obj_desc);
217 goto unlock_and_exit;
218 }
219 }
220 break;
221
222 default:
223
224 ACPI_ERROR((AE_INFO,
225 "Unsupported initial type value 0x%X",
226 init_val->type));
227 acpi_ut_remove_reference(obj_desc);
228 obj_desc = NULL;
229 continue;
230 }
231
232 /* Store pointer to value descriptor in the Node */
233
234 status = acpi_ns_attach_object(new_node, obj_desc,
235 obj_desc->common.type);
236
237 /* Remove local reference to the object */
238
239 acpi_ut_remove_reference(obj_desc);
240 }
241 }
242
243 unlock_and_exit:
244 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
245
246 /* Save a handle to "_GPE", it is always present */
247
248 if (ACPI_SUCCESS(status)) {
249 status = acpi_ns_get_node(NULL, "\\_GPE", ACPI_NS_NO_UPSEARCH,
250 &acpi_gbl_fadt_gpe_device);
251 }
252
253 return_ACPI_STATUS(status);
254}
255
256/*******************************************************************************
257 *
258 * FUNCTION: acpi_ns_lookup
259 *
260 * PARAMETERS: scope_info - Current scope info block
261 * Pathname - Search pathname, in internal format
262 * (as represented in the AML stream)
263 * Type - Type associated with name
264 * interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
265 * Flags - Flags describing the search restrictions
266 * walk_state - Current state of the walk
267 * return_node - Where the Node is placed (if found
268 * or created successfully)
269 *
270 * RETURN: Status
271 *
272 * DESCRIPTION: Find or enter the passed name in the name space.
273 * Log an error if name not found in Exec mode.
274 *
275 * MUTEX: Assumes namespace is locked.
276 *
277 ******************************************************************************/
278
279acpi_status
280acpi_ns_lookup(union acpi_generic_state *scope_info,
281 char *pathname,
282 acpi_object_type type,
283 acpi_interpreter_mode interpreter_mode,
284 u32 flags,
285 struct acpi_walk_state *walk_state,
286 struct acpi_namespace_node **return_node)
287{
288 acpi_status status;
289 char *path = pathname;
290 struct acpi_namespace_node *prefix_node;
291 struct acpi_namespace_node *current_node = NULL;
292 struct acpi_namespace_node *this_node = NULL;
293 u32 num_segments;
294 u32 num_carats;
295 acpi_name simple_name;
296 acpi_object_type type_to_check_for;
297 acpi_object_type this_search_type;
298 u32 search_parent_flag = ACPI_NS_SEARCH_PARENT;
299 u32 local_flags;
300
301 ACPI_FUNCTION_TRACE(ns_lookup);
302
303 if (!return_node) {
304 return_ACPI_STATUS(AE_BAD_PARAMETER);
305 }
306
307 local_flags = flags & ~(ACPI_NS_ERROR_IF_FOUND | ACPI_NS_SEARCH_PARENT);
308 *return_node = ACPI_ENTRY_NOT_FOUND;
309 acpi_gbl_ns_lookup_count++;
310
311 if (!acpi_gbl_root_node) {
312 return_ACPI_STATUS(AE_NO_NAMESPACE);
313 }
314
315 /* Get the prefix scope. A null scope means use the root scope */
316
317 if ((!scope_info) || (!scope_info->scope.node)) {
318 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
319 "Null scope prefix, using root node (%p)\n",
320 acpi_gbl_root_node));
321
322 prefix_node = acpi_gbl_root_node;
323 } else {
324 prefix_node = scope_info->scope.node;
325 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node) !=
326 ACPI_DESC_TYPE_NAMED) {
327 ACPI_ERROR((AE_INFO, "%p is not a namespace node [%s]",
328 prefix_node,
329 acpi_ut_get_descriptor_name(prefix_node)));
330 return_ACPI_STATUS(AE_AML_INTERNAL);
331 }
332
333 if (!(flags & ACPI_NS_PREFIX_IS_SCOPE)) {
334 /*
335 * This node might not be a actual "scope" node (such as a
336 * Device/Method, etc.) It could be a Package or other object
337 * node. Backup up the tree to find the containing scope node.
338 */
339 while (!acpi_ns_opens_scope(prefix_node->type) &&
340 prefix_node->type != ACPI_TYPE_ANY) {
341 prefix_node = prefix_node->parent;
342 }
343 }
344 }
345
346 /* Save type. TBD: may be no longer necessary */
347
348 type_to_check_for = type;
349
350 /*
351 * Begin examination of the actual pathname
352 */
353 if (!pathname) {
354
355 /* A Null name_path is allowed and refers to the root */
356
357 num_segments = 0;
358 this_node = acpi_gbl_root_node;
359 path = "";
360
361 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
362 "Null Pathname (Zero segments), Flags=%X\n",
363 flags));
364 } else {
365 /*
366 * Name pointer is valid (and must be in internal name format)
367 *
368 * Check for scope prefixes:
369 *
370 * As represented in the AML stream, a namepath consists of an
371 * optional scope prefix followed by a name segment part.
372 *
373 * If present, the scope prefix is either a Root Prefix (in
374 * which case the name is fully qualified), or one or more
375 * Parent Prefixes (in which case the name's scope is relative
376 * to the current scope).
377 */
378 if (*path == (u8) AML_ROOT_PREFIX) {
379
380 /* Pathname is fully qualified, start from the root */
381
382 this_node = acpi_gbl_root_node;
383 search_parent_flag = ACPI_NS_NO_UPSEARCH;
384
385 /* Point to name segment part */
386
387 path++;
388
389 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
390 "Path is absolute from root [%p]\n",
391 this_node));
392 } else {
393 /* Pathname is relative to current scope, start there */
394
395 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
396 "Searching relative to prefix scope [%4.4s] (%p)\n",
397 acpi_ut_get_node_name(prefix_node),
398 prefix_node));
399
400 /*
401 * Handle multiple Parent Prefixes (carat) by just getting
402 * the parent node for each prefix instance.
403 */
404 this_node = prefix_node;
405 num_carats = 0;
406 while (*path == (u8) AML_PARENT_PREFIX) {
407
408 /* Name is fully qualified, no search rules apply */
409
410 search_parent_flag = ACPI_NS_NO_UPSEARCH;
411
412 /*
413 * Point past this prefix to the name segment
414 * part or the next Parent Prefix
415 */
416 path++;
417
418 /* Backup to the parent node */
419
420 num_carats++;
421 this_node = this_node->parent;
422 if (!this_node) {
423
424 /* Current scope has no parent scope */
425
426 ACPI_ERROR((AE_INFO,
427 "ACPI path has too many parent prefixes (^) "
428 "- reached beyond root node"));
429 return_ACPI_STATUS(AE_NOT_FOUND);
430 }
431 }
432
433 if (search_parent_flag == ACPI_NS_NO_UPSEARCH) {
434 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
435 "Search scope is [%4.4s], path has %u carat(s)\n",
436 acpi_ut_get_node_name
437 (this_node), num_carats));
438 }
439 }
440
441 /*
442 * Determine the number of ACPI name segments in this pathname.
443 *
444 * The segment part consists of either:
445 * - A Null name segment (0)
446 * - A dual_name_prefix followed by two 4-byte name segments
447 * - A multi_name_prefix followed by a byte indicating the
448 * number of segments and the segments themselves.
449 * - A single 4-byte name segment
450 *
451 * Examine the name prefix opcode, if any, to determine the number of
452 * segments.
453 */
454 switch (*path) {
455 case 0:
456 /*
457 * Null name after a root or parent prefixes. We already
458 * have the correct target node and there are no name segments.
459 */
460 num_segments = 0;
461 type = this_node->type;
462
463 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
464 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
465 flags));
466 break;
467
468 case AML_DUAL_NAME_PREFIX:
469
470 /* More than one name_seg, search rules do not apply */
471
472 search_parent_flag = ACPI_NS_NO_UPSEARCH;
473
474 /* Two segments, point to first name segment */
475
476 num_segments = 2;
477 path++;
478
479 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
480 "Dual Pathname (2 segments, Flags=%X)\n",
481 flags));
482 break;
483
484 case AML_MULTI_NAME_PREFIX_OP:
485
486 /* More than one name_seg, search rules do not apply */
487
488 search_parent_flag = ACPI_NS_NO_UPSEARCH;
489
490 /* Extract segment count, point to first name segment */
491
492 path++;
493 num_segments = (u32) (u8) * path;
494 path++;
495
496 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
497 "Multi Pathname (%u Segments, Flags=%X)\n",
498 num_segments, flags));
499 break;
500
501 default:
502 /*
503 * Not a Null name, no Dual or Multi prefix, hence there is
504 * only one name segment and Pathname is already pointing to it.
505 */
506 num_segments = 1;
507
508 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
509 "Simple Pathname (1 segment, Flags=%X)\n",
510 flags));
511 break;
512 }
513
514 ACPI_DEBUG_EXEC(acpi_ns_print_pathname(num_segments, path));
515 }
516
517 /*
518 * Search namespace for each segment of the name. Loop through and
519 * verify (or add to the namespace) each name segment.
520 *
521 * The object type is significant only at the last name
522 * segment. (We don't care about the types along the path, only
523 * the type of the final target object.)
524 */
525 this_search_type = ACPI_TYPE_ANY;
526 current_node = this_node;
527 while (num_segments && current_node) {
528 num_segments--;
529 if (!num_segments) {
530
531 /* This is the last segment, enable typechecking */
532
533 this_search_type = type;
534
535 /*
536 * Only allow automatic parent search (search rules) if the caller
537 * requested it AND we have a single, non-fully-qualified name_seg
538 */
539 if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
540 (flags & ACPI_NS_SEARCH_PARENT)) {
541 local_flags |= ACPI_NS_SEARCH_PARENT;
542 }
543
544 /* Set error flag according to caller */
545
546 if (flags & ACPI_NS_ERROR_IF_FOUND) {
547 local_flags |= ACPI_NS_ERROR_IF_FOUND;
548 }
549 }
550
551 /* Extract one ACPI name from the front of the pathname */
552
553 ACPI_MOVE_32_TO_32(&simple_name, path);
554
555 /* Try to find the single (4 character) ACPI name */
556
557 status =
558 acpi_ns_search_and_enter(simple_name, walk_state,
559 current_node, interpreter_mode,
560 this_search_type, local_flags,
561 &this_node);
562 if (ACPI_FAILURE(status)) {
563 if (status == AE_NOT_FOUND) {
564
565 /* Name not found in ACPI namespace */
566
567 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
568 "Name [%4.4s] not found in scope [%4.4s] %p\n",
569 (char *)&simple_name,
570 (char *)¤t_node->name,
571 current_node));
572 }
573
574 *return_node = this_node;
575 return_ACPI_STATUS(status);
576 }
577
578 /* More segments to follow? */
579
580 if (num_segments > 0) {
581 /*
582 * If we have an alias to an object that opens a scope (such as a
583 * device or processor), we need to dereference the alias here so
584 * that we can access any children of the original node (via the
585 * remaining segments).
586 */
587 if (this_node->type == ACPI_TYPE_LOCAL_ALIAS) {
588 if (!this_node->object) {
589 return_ACPI_STATUS(AE_NOT_EXIST);
590 }
591
592 if (acpi_ns_opens_scope
593 (((struct acpi_namespace_node *)
594 this_node->object)->type)) {
595 this_node =
596 (struct acpi_namespace_node *)
597 this_node->object;
598 }
599 }
600 }
601
602 /* Special handling for the last segment (num_segments == 0) */
603
604 else {
605 /*
606 * Sanity typecheck of the target object:
607 *
608 * If 1) This is the last segment (num_segments == 0)
609 * 2) And we are looking for a specific type
610 * (Not checking for TYPE_ANY)
611 * 3) Which is not an alias
612 * 4) Which is not a local type (TYPE_SCOPE)
613 * 5) And the type of target object is known (not TYPE_ANY)
614 * 6) And target object does not match what we are looking for
615 *
616 * Then we have a type mismatch. Just warn and ignore it.
617 */
618 if ((type_to_check_for != ACPI_TYPE_ANY) &&
619 (type_to_check_for != ACPI_TYPE_LOCAL_ALIAS) &&
620 (type_to_check_for != ACPI_TYPE_LOCAL_METHOD_ALIAS)
621 && (type_to_check_for != ACPI_TYPE_LOCAL_SCOPE)
622 && (this_node->type != ACPI_TYPE_ANY)
623 && (this_node->type != type_to_check_for)) {
624
625 /* Complain about a type mismatch */
626
627 ACPI_WARNING((AE_INFO,
628 "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
629 ACPI_CAST_PTR(char, &simple_name),
630 acpi_ut_get_type_name(this_node->
631 type),
632 acpi_ut_get_type_name
633 (type_to_check_for)));
634 }
635
636 /*
637 * If this is the last name segment and we are not looking for a
638 * specific type, but the type of found object is known, use that
639 * type to (later) see if it opens a scope.
640 */
641 if (type == ACPI_TYPE_ANY) {
642 type = this_node->type;
643 }
644 }
645
646 /* Point to next name segment and make this node current */
647
648 path += ACPI_NAME_SIZE;
649 current_node = this_node;
650 }
651
652 /* Always check if we need to open a new scope */
653
654 if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
655 /*
656 * If entry is a type which opens a scope, push the new scope on the
657 * scope stack.
658 */
659 if (acpi_ns_opens_scope(type)) {
660 status =
661 acpi_ds_scope_stack_push(this_node, type,
662 walk_state);
663 if (ACPI_FAILURE(status)) {
664 return_ACPI_STATUS(status);
665 }
666 }
667 }
668
669 *return_node = this_node;
670 return_ACPI_STATUS(AE_OK);
671}
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/*******************************************************************************
3 *
4 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
5 *
6 ******************************************************************************/
7
8#include <acpi/acpi.h>
9#include "accommon.h"
10#include "amlcode.h"
11#include "acnamesp.h"
12#include "acdispat.h"
13
14#ifdef ACPI_ASL_COMPILER
15#include "acdisasm.h"
16#endif
17
18#define _COMPONENT ACPI_NAMESPACE
19ACPI_MODULE_NAME("nsaccess")
20
21/*******************************************************************************
22 *
23 * FUNCTION: acpi_ns_root_initialize
24 *
25 * PARAMETERS: None
26 *
27 * RETURN: Status
28 *
29 * DESCRIPTION: Allocate and initialize the default root named objects
30 *
31 * MUTEX: Locks namespace for entire execution
32 *
33 ******************************************************************************/
34acpi_status acpi_ns_root_initialize(void)
35{
36 acpi_status status;
37 const struct acpi_predefined_names *init_val = NULL;
38 struct acpi_namespace_node *new_node;
39 struct acpi_namespace_node *prev_node = NULL;
40 union acpi_operand_object *obj_desc;
41 acpi_string val = NULL;
42
43 ACPI_FUNCTION_TRACE(ns_root_initialize);
44
45 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
46 if (ACPI_FAILURE(status)) {
47 return_ACPI_STATUS(status);
48 }
49
50 /*
51 * The global root ptr is initially NULL, so a non-NULL value indicates
52 * that acpi_ns_root_initialize() has already been called; just return.
53 */
54 if (acpi_gbl_root_node) {
55 status = AE_OK;
56 goto unlock_and_exit;
57 }
58
59 /*
60 * Tell the rest of the subsystem that the root is initialized
61 * (This is OK because the namespace is locked)
62 */
63 acpi_gbl_root_node = &acpi_gbl_root_node_struct;
64
65 /* Enter the predefined names in the name table */
66
67 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
68 "Entering predefined entries into namespace\n"));
69
70 /*
71 * Create the initial (default) namespace.
72 * This namespace looks like something similar to this:
73 *
74 * ACPI Namespace (from Namespace Root):
75 * 0 _GPE Scope 00203160 00
76 * 0 _PR_ Scope 002031D0 00
77 * 0 _SB_ Device 00203240 00 Notify Object: 0020ADD8
78 * 0 _SI_ Scope 002032B0 00
79 * 0 _TZ_ Device 00203320 00
80 * 0 _REV Integer 00203390 00 = 0000000000000002
81 * 0 _OS_ String 00203488 00 Len 14 "Microsoft Windows NT"
82 * 0 _GL_ Mutex 00203580 00 Object 002035F0
83 * 0 _OSI Method 00203678 00 Args 1 Len 0000 Aml 00000000
84 */
85 for (init_val = acpi_gbl_pre_defined_names; init_val->name; init_val++) {
86 status = AE_OK;
87
88 /* _OSI is optional for now, will be permanent later */
89
90 if (!strcmp(init_val->name, "_OSI")
91 && !acpi_gbl_create_osi_method) {
92 continue;
93 }
94
95 /*
96 * Create, init, and link the new predefined name
97 * Note: No need to use acpi_ns_lookup here because all the
98 * predefined names are at the root level. It is much easier to
99 * just create and link the new node(s) here.
100 */
101 new_node =
102 acpi_ns_create_node(*ACPI_CAST_PTR(u32, init_val->name));
103 if (!new_node) {
104 status = AE_NO_MEMORY;
105 goto unlock_and_exit;
106 }
107
108 new_node->descriptor_type = ACPI_DESC_TYPE_NAMED;
109 new_node->type = init_val->type;
110
111 if (!prev_node) {
112 acpi_gbl_root_node_struct.child = new_node;
113 } else {
114 prev_node->peer = new_node;
115 }
116
117 new_node->parent = &acpi_gbl_root_node_struct;
118 prev_node = new_node;
119
120 /*
121 * Name entered successfully. If entry in pre_defined_names[] specifies
122 * an initial value, create the initial value.
123 */
124 if (init_val->val) {
125 status = acpi_os_predefined_override(init_val, &val);
126 if (ACPI_FAILURE(status)) {
127 ACPI_ERROR((AE_INFO,
128 "Could not override predefined %s",
129 init_val->name));
130 }
131
132 if (!val) {
133 val = init_val->val;
134 }
135
136 /*
137 * Entry requests an initial value, allocate a
138 * descriptor for it.
139 */
140 obj_desc =
141 acpi_ut_create_internal_object(init_val->type);
142 if (!obj_desc) {
143 status = AE_NO_MEMORY;
144 goto unlock_and_exit;
145 }
146
147 /*
148 * Convert value string from table entry to
149 * internal representation. Only types actually
150 * used for initial values are implemented here.
151 */
152 switch (init_val->type) {
153 case ACPI_TYPE_METHOD:
154
155 obj_desc->method.param_count =
156 (u8) ACPI_TO_INTEGER(val);
157 obj_desc->common.flags |= AOPOBJ_DATA_VALID;
158
159#if defined (ACPI_ASL_COMPILER)
160
161 /* Save the parameter count for the iASL compiler */
162
163 new_node->value = obj_desc->method.param_count;
164#else
165 /* Mark this as a very SPECIAL method (_OSI) */
166
167 obj_desc->method.info_flags =
168 ACPI_METHOD_INTERNAL_ONLY;
169 obj_desc->method.dispatch.implementation =
170 acpi_ut_osi_implementation;
171#endif
172 break;
173
174 case ACPI_TYPE_INTEGER:
175
176 obj_desc->integer.value = ACPI_TO_INTEGER(val);
177 break;
178
179 case ACPI_TYPE_STRING:
180
181 /* Build an object around the static string */
182
183 obj_desc->string.length = (u32)strlen(val);
184 obj_desc->string.pointer = val;
185 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
186 break;
187
188 case ACPI_TYPE_MUTEX:
189
190 obj_desc->mutex.node = new_node;
191 obj_desc->mutex.sync_level =
192 (u8) (ACPI_TO_INTEGER(val) - 1);
193
194 /* Create a mutex */
195
196 status =
197 acpi_os_create_mutex(&obj_desc->mutex.
198 os_mutex);
199 if (ACPI_FAILURE(status)) {
200 acpi_ut_remove_reference(obj_desc);
201 goto unlock_and_exit;
202 }
203
204 /* Special case for ACPI Global Lock */
205
206 if (strcmp(init_val->name, "_GL_") == 0) {
207 acpi_gbl_global_lock_mutex = obj_desc;
208
209 /* Create additional counting semaphore for global lock */
210
211 status =
212 acpi_os_create_semaphore(1, 0,
213 &acpi_gbl_global_lock_semaphore);
214 if (ACPI_FAILURE(status)) {
215 acpi_ut_remove_reference
216 (obj_desc);
217 goto unlock_and_exit;
218 }
219 }
220 break;
221
222 default:
223
224 ACPI_ERROR((AE_INFO,
225 "Unsupported initial type value 0x%X",
226 init_val->type));
227 acpi_ut_remove_reference(obj_desc);
228 obj_desc = NULL;
229 continue;
230 }
231
232 /* Store pointer to value descriptor in the Node */
233
234 status = acpi_ns_attach_object(new_node, obj_desc,
235 obj_desc->common.type);
236
237 /* Remove local reference to the object */
238
239 acpi_ut_remove_reference(obj_desc);
240 }
241 }
242
243unlock_and_exit:
244 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
245
246 /* Save a handle to "_GPE", it is always present */
247
248 if (ACPI_SUCCESS(status)) {
249 status = acpi_ns_get_node(NULL, "\\_GPE", ACPI_NS_NO_UPSEARCH,
250 &acpi_gbl_fadt_gpe_device);
251 }
252
253 return_ACPI_STATUS(status);
254}
255
256/*******************************************************************************
257 *
258 * FUNCTION: acpi_ns_lookup
259 *
260 * PARAMETERS: scope_info - Current scope info block
261 * pathname - Search pathname, in internal format
262 * (as represented in the AML stream)
263 * type - Type associated with name
264 * interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
265 * flags - Flags describing the search restrictions
266 * walk_state - Current state of the walk
267 * return_node - Where the Node is placed (if found
268 * or created successfully)
269 *
270 * RETURN: Status
271 *
272 * DESCRIPTION: Find or enter the passed name in the name space.
273 * Log an error if name not found in Exec mode.
274 *
275 * MUTEX: Assumes namespace is locked.
276 *
277 ******************************************************************************/
278
279acpi_status
280acpi_ns_lookup(union acpi_generic_state *scope_info,
281 char *pathname,
282 acpi_object_type type,
283 acpi_interpreter_mode interpreter_mode,
284 u32 flags,
285 struct acpi_walk_state *walk_state,
286 struct acpi_namespace_node **return_node)
287{
288 acpi_status status;
289 char *path = pathname;
290 char *external_path;
291 struct acpi_namespace_node *prefix_node;
292 struct acpi_namespace_node *current_node = NULL;
293 struct acpi_namespace_node *this_node = NULL;
294 u32 num_segments;
295 u32 num_carats;
296 acpi_name simple_name;
297 acpi_object_type type_to_check_for;
298 acpi_object_type this_search_type;
299 u32 search_parent_flag = ACPI_NS_SEARCH_PARENT;
300 u32 local_flags;
301 acpi_interpreter_mode local_interpreter_mode;
302
303 ACPI_FUNCTION_TRACE(ns_lookup);
304
305 if (!return_node) {
306 return_ACPI_STATUS(AE_BAD_PARAMETER);
307 }
308
309 local_flags = flags &
310 ~(ACPI_NS_ERROR_IF_FOUND | ACPI_NS_OVERRIDE_IF_FOUND |
311 ACPI_NS_SEARCH_PARENT);
312 *return_node = ACPI_ENTRY_NOT_FOUND;
313 acpi_gbl_ns_lookup_count++;
314
315 if (!acpi_gbl_root_node) {
316 return_ACPI_STATUS(AE_NO_NAMESPACE);
317 }
318
319 /* Get the prefix scope. A null scope means use the root scope */
320
321 if ((!scope_info) || (!scope_info->scope.node)) {
322 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
323 "Null scope prefix, using root node (%p)\n",
324 acpi_gbl_root_node));
325
326 prefix_node = acpi_gbl_root_node;
327 } else {
328 prefix_node = scope_info->scope.node;
329 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node) !=
330 ACPI_DESC_TYPE_NAMED) {
331 ACPI_ERROR((AE_INFO, "%p is not a namespace node [%s]",
332 prefix_node,
333 acpi_ut_get_descriptor_name(prefix_node)));
334 return_ACPI_STATUS(AE_AML_INTERNAL);
335 }
336
337 if (!(flags & ACPI_NS_PREFIX_IS_SCOPE)) {
338 /*
339 * This node might not be a actual "scope" node (such as a
340 * Device/Method, etc.) It could be a Package or other object
341 * node. Backup up the tree to find the containing scope node.
342 */
343 while (!acpi_ns_opens_scope(prefix_node->type) &&
344 prefix_node->type != ACPI_TYPE_ANY) {
345 prefix_node = prefix_node->parent;
346 }
347 }
348 }
349
350 /* Save type. TBD: may be no longer necessary */
351
352 type_to_check_for = type;
353
354 /*
355 * Begin examination of the actual pathname
356 */
357 if (!pathname) {
358
359 /* A Null name_path is allowed and refers to the root */
360
361 num_segments = 0;
362 this_node = acpi_gbl_root_node;
363 path = "";
364
365 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
366 "Null Pathname (Zero segments), Flags=%X\n",
367 flags));
368 } else {
369 /*
370 * Name pointer is valid (and must be in internal name format)
371 *
372 * Check for scope prefixes:
373 *
374 * As represented in the AML stream, a namepath consists of an
375 * optional scope prefix followed by a name segment part.
376 *
377 * If present, the scope prefix is either a Root Prefix (in
378 * which case the name is fully qualified), or one or more
379 * Parent Prefixes (in which case the name's scope is relative
380 * to the current scope).
381 */
382 if (*path == (u8) AML_ROOT_PREFIX) {
383
384 /* Pathname is fully qualified, start from the root */
385
386 this_node = acpi_gbl_root_node;
387 search_parent_flag = ACPI_NS_NO_UPSEARCH;
388
389 /* Point to name segment part */
390
391 path++;
392
393 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
394 "Path is absolute from root [%p]\n",
395 this_node));
396 } else {
397 /* Pathname is relative to current scope, start there */
398
399 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
400 "Searching relative to prefix scope [%4.4s] (%p)\n",
401 acpi_ut_get_node_name(prefix_node),
402 prefix_node));
403
404 /*
405 * Handle multiple Parent Prefixes (carat) by just getting
406 * the parent node for each prefix instance.
407 */
408 this_node = prefix_node;
409 num_carats = 0;
410 while (*path == (u8) AML_PARENT_PREFIX) {
411
412 /* Name is fully qualified, no search rules apply */
413
414 search_parent_flag = ACPI_NS_NO_UPSEARCH;
415
416 /*
417 * Point past this prefix to the name segment
418 * part or the next Parent Prefix
419 */
420 path++;
421
422 /* Backup to the parent node */
423
424 num_carats++;
425 this_node = this_node->parent;
426 if (!this_node) {
427 /*
428 * Current scope has no parent scope. Externalize
429 * the internal path for error message.
430 */
431 status =
432 acpi_ns_externalize_name
433 (ACPI_UINT32_MAX, pathname, NULL,
434 &external_path);
435 if (ACPI_SUCCESS(status)) {
436 ACPI_ERROR((AE_INFO,
437 "%s: Path has too many parent prefixes (^)",
438 external_path));
439
440 ACPI_FREE(external_path);
441 }
442
443 return_ACPI_STATUS(AE_NOT_FOUND);
444 }
445 }
446
447 if (search_parent_flag == ACPI_NS_NO_UPSEARCH) {
448 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
449 "Search scope is [%4.4s], path has %u carat(s)\n",
450 acpi_ut_get_node_name
451 (this_node), num_carats));
452 }
453 }
454
455 /*
456 * Determine the number of ACPI name segments in this pathname.
457 *
458 * The segment part consists of either:
459 * - A Null name segment (0)
460 * - A dual_name_prefix followed by two 4-byte name segments
461 * - A multi_name_prefix followed by a byte indicating the
462 * number of segments and the segments themselves.
463 * - A single 4-byte name segment
464 *
465 * Examine the name prefix opcode, if any, to determine the number of
466 * segments.
467 */
468 switch (*path) {
469 case 0:
470 /*
471 * Null name after a root or parent prefixes. We already
472 * have the correct target node and there are no name segments.
473 */
474 num_segments = 0;
475 type = this_node->type;
476
477 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
478 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
479 flags));
480 break;
481
482 case AML_DUAL_NAME_PREFIX:
483
484 /* More than one name_seg, search rules do not apply */
485
486 search_parent_flag = ACPI_NS_NO_UPSEARCH;
487
488 /* Two segments, point to first name segment */
489
490 num_segments = 2;
491 path++;
492
493 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
494 "Dual Pathname (2 segments, Flags=%X)\n",
495 flags));
496 break;
497
498 case AML_MULTI_NAME_PREFIX:
499
500 /* More than one name_seg, search rules do not apply */
501
502 search_parent_flag = ACPI_NS_NO_UPSEARCH;
503
504 /* Extract segment count, point to first name segment */
505
506 path++;
507 num_segments = (u32) (u8) * path;
508 path++;
509
510 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
511 "Multi Pathname (%u Segments, Flags=%X)\n",
512 num_segments, flags));
513 break;
514
515 default:
516 /*
517 * Not a Null name, no Dual or Multi prefix, hence there is
518 * only one name segment and Pathname is already pointing to it.
519 */
520 num_segments = 1;
521
522 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
523 "Simple Pathname (1 segment, Flags=%X)\n",
524 flags));
525 break;
526 }
527
528 ACPI_DEBUG_EXEC(acpi_ns_print_pathname(num_segments, path));
529 }
530
531 /*
532 * Search namespace for each segment of the name. Loop through and
533 * verify (or add to the namespace) each name segment.
534 *
535 * The object type is significant only at the last name
536 * segment. (We don't care about the types along the path, only
537 * the type of the final target object.)
538 */
539 this_search_type = ACPI_TYPE_ANY;
540 current_node = this_node;
541
542 while (num_segments && current_node) {
543 num_segments--;
544 if (!num_segments) {
545
546 /* This is the last segment, enable typechecking */
547
548 this_search_type = type;
549
550 /*
551 * Only allow automatic parent search (search rules) if the caller
552 * requested it AND we have a single, non-fully-qualified name_seg
553 */
554 if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
555 (flags & ACPI_NS_SEARCH_PARENT)) {
556 local_flags |= ACPI_NS_SEARCH_PARENT;
557 }
558
559 /* Set error flag according to caller */
560
561 if (flags & ACPI_NS_ERROR_IF_FOUND) {
562 local_flags |= ACPI_NS_ERROR_IF_FOUND;
563 }
564
565 /* Set override flag according to caller */
566
567 if (flags & ACPI_NS_OVERRIDE_IF_FOUND) {
568 local_flags |= ACPI_NS_OVERRIDE_IF_FOUND;
569 }
570 }
571
572 /* Handle opcodes that create a new name_seg via a full name_path */
573
574 local_interpreter_mode = interpreter_mode;
575 if ((flags & ACPI_NS_PREFIX_MUST_EXIST) && (num_segments > 0)) {
576
577 /* Every element of the path must exist (except for the final name_seg) */
578
579 local_interpreter_mode = ACPI_IMODE_EXECUTE;
580 }
581
582 /* Extract one ACPI name from the front of the pathname */
583
584 ACPI_MOVE_32_TO_32(&simple_name, path);
585
586 /* Try to find the single (4 character) ACPI name */
587
588 status =
589 acpi_ns_search_and_enter(simple_name, walk_state,
590 current_node,
591 local_interpreter_mode,
592 this_search_type, local_flags,
593 &this_node);
594 if (ACPI_FAILURE(status)) {
595 if (status == AE_NOT_FOUND) {
596#if !defined ACPI_ASL_COMPILER /* Note: iASL reports this error by itself, not needed here */
597 if (flags & ACPI_NS_PREFIX_MUST_EXIST) {
598 acpi_os_printf(ACPI_MSG_BIOS_ERROR
599 "Object does not exist: %4.4s\n",
600 (char *)&simple_name);
601 }
602#endif
603 /* Name not found in ACPI namespace */
604
605 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
606 "Name [%4.4s] not found in scope [%4.4s] %p\n",
607 (char *)&simple_name,
608 (char *)¤t_node->name,
609 current_node));
610 }
611#ifdef ACPI_EXEC_APP
612 if ((status == AE_ALREADY_EXISTS) &&
613 (this_node->flags & ANOBJ_NODE_EARLY_INIT)) {
614 this_node->flags &= ~ANOBJ_NODE_EARLY_INIT;
615 status = AE_OK;
616 }
617#endif
618
619#ifdef ACPI_ASL_COMPILER
620 /*
621 * If this ACPI name already exists within the namespace as an
622 * external declaration, then mark the external as a conflicting
623 * declaration and proceed to process the current node as if it did
624 * not exist in the namespace. If this node is not processed as
625 * normal, then it could cause improper namespace resolution
626 * by failing to open a new scope.
627 */
628 if (acpi_gbl_disasm_flag &&
629 (status == AE_ALREADY_EXISTS) &&
630 ((this_node->flags & ANOBJ_IS_EXTERNAL) ||
631 (walk_state
632 && walk_state->opcode == AML_EXTERNAL_OP))) {
633 this_node->flags &= ~ANOBJ_IS_EXTERNAL;
634 this_node->type = (u8)this_search_type;
635 if (walk_state->opcode != AML_EXTERNAL_OP) {
636 acpi_dm_mark_external_conflict
637 (this_node);
638 }
639 break;
640 }
641#endif
642
643 *return_node = this_node;
644 return_ACPI_STATUS(status);
645 }
646
647 /* More segments to follow? */
648
649 if (num_segments > 0) {
650 /*
651 * If we have an alias to an object that opens a scope (such as a
652 * device or processor), we need to dereference the alias here so
653 * that we can access any children of the original node (via the
654 * remaining segments).
655 */
656 if (this_node->type == ACPI_TYPE_LOCAL_ALIAS) {
657 if (!this_node->object) {
658 return_ACPI_STATUS(AE_NOT_EXIST);
659 }
660
661 if (acpi_ns_opens_scope
662 (((struct acpi_namespace_node *)
663 this_node->object)->type)) {
664 this_node =
665 (struct acpi_namespace_node *)
666 this_node->object;
667 }
668 }
669 }
670
671 /* Special handling for the last segment (num_segments == 0) */
672
673 else {
674 /*
675 * Sanity typecheck of the target object:
676 *
677 * If 1) This is the last segment (num_segments == 0)
678 * 2) And we are looking for a specific type
679 * (Not checking for TYPE_ANY)
680 * 3) Which is not an alias
681 * 4) Which is not a local type (TYPE_SCOPE)
682 * 5) And the type of target object is known (not TYPE_ANY)
683 * 6) And target object does not match what we are looking for
684 *
685 * Then we have a type mismatch. Just warn and ignore it.
686 */
687 if ((type_to_check_for != ACPI_TYPE_ANY) &&
688 (type_to_check_for != ACPI_TYPE_LOCAL_ALIAS) &&
689 (type_to_check_for != ACPI_TYPE_LOCAL_METHOD_ALIAS)
690 && (type_to_check_for != ACPI_TYPE_LOCAL_SCOPE)
691 && (this_node->type != ACPI_TYPE_ANY)
692 && (this_node->type != type_to_check_for)) {
693
694 /* Complain about a type mismatch */
695
696 ACPI_WARNING((AE_INFO,
697 "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
698 ACPI_CAST_PTR(char, &simple_name),
699 acpi_ut_get_type_name(this_node->
700 type),
701 acpi_ut_get_type_name
702 (type_to_check_for)));
703 }
704
705 /*
706 * If this is the last name segment and we are not looking for a
707 * specific type, but the type of found object is known, use that
708 * type to (later) see if it opens a scope.
709 */
710 if (type == ACPI_TYPE_ANY) {
711 type = this_node->type;
712 }
713 }
714
715 /* Point to next name segment and make this node current */
716
717 path += ACPI_NAMESEG_SIZE;
718 current_node = this_node;
719 }
720
721 /* Always check if we need to open a new scope */
722
723 if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
724 /*
725 * If entry is a type which opens a scope, push the new scope on the
726 * scope stack.
727 */
728 if (acpi_ns_opens_scope(type)) {
729 status =
730 acpi_ds_scope_stack_push(this_node, type,
731 walk_state);
732 if (ACPI_FAILURE(status)) {
733 return_ACPI_STATUS(status);
734 }
735 }
736 }
737#ifdef ACPI_EXEC_APP
738 if (flags & ACPI_NS_EARLY_INIT) {
739 this_node->flags |= ANOBJ_NODE_EARLY_INIT;
740 }
741#endif
742
743 *return_node = this_node;
744 return_ACPI_STATUS(AE_OK);
745}