]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blob - drivers/acpi/namespace/nsaccess.c
ACPICA: Fix for invalid large array index on 64-bit systems
[mirror_ubuntu-hirsute-kernel.git] / drivers / acpi / namespace / nsaccess.c
1 /*******************************************************************************
2 *
3 * Module Name: nsaccess - Top-level functions for accessing ACPI namespace
4 *
5 ******************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2008, 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 <acpi/amlcode.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acdispat.h>
48
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsaccess")
51
52 /*******************************************************************************
53 *
54 * FUNCTION: acpi_ns_root_initialize
55 *
56 * PARAMETERS: None
57 *
58 * RETURN: Status
59 *
60 * DESCRIPTION: Allocate and initialize the default root named objects
61 *
62 * MUTEX: Locks namespace for entire execution
63 *
64 ******************************************************************************/
65 acpi_status acpi_ns_root_initialize(void)
66 {
67 acpi_status status;
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;
72
73 ACPI_FUNCTION_TRACE(ns_root_initialize);
74
75 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
76 if (ACPI_FAILURE(status)) {
77 return_ACPI_STATUS(status);
78 }
79
80 /*
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.
83 */
84 if (acpi_gbl_root_node) {
85 status = AE_OK;
86 goto unlock_and_exit;
87 }
88
89 /*
90 * Tell the rest of the subsystem that the root is initialized
91 * (This is OK because the namespace is locked)
92 */
93 acpi_gbl_root_node = &acpi_gbl_root_node_struct;
94
95 /* Enter the pre-defined names in the name table */
96
97 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
98 "Entering predefined entries into namespace\n"));
99
100 for (init_val = acpi_gbl_pre_defined_names; init_val->name; init_val++) {
101
102 /* _OSI is optional for now, will be permanent later */
103
104 if (!ACPI_STRCMP(init_val->name, "_OSI")
105 && !acpi_gbl_create_osi_method) {
106 continue;
107 }
108
109 status = acpi_ns_lookup(NULL, init_val->name, init_val->type,
110 ACPI_IMODE_LOAD_PASS2,
111 ACPI_NS_NO_UPSEARCH, NULL, &new_node);
112
113 if (ACPI_FAILURE(status) || (!new_node)) { /* Must be on same line for code converter */
114 ACPI_EXCEPTION((AE_INFO, status,
115 "Could not create predefined name %s",
116 init_val->name));
117 }
118
119 /*
120 * Name entered successfully.
121 * If entry in pre_defined_names[] specifies an
122 * 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.method_flags =
167 AML_METHOD_INTERNAL_ONLY;
168
169 #ifndef ACPI_DUMP_APP
170 obj_desc->method.implementation =
171 acpi_ut_osi_implementation;
172 #endif
173 #endif
174 break;
175
176 case ACPI_TYPE_INTEGER:
177
178 obj_desc->integer.value = ACPI_TO_INTEGER(val);
179 break;
180
181 case ACPI_TYPE_STRING:
182
183 /*
184 * Build an object around the static string
185 */
186 obj_desc->string.length =
187 (u32) ACPI_STRLEN(val);
188 obj_desc->string.pointer = val;
189 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
190 break;
191
192 case ACPI_TYPE_MUTEX:
193
194 obj_desc->mutex.node = new_node;
195 obj_desc->mutex.sync_level =
196 (u8) (ACPI_TO_INTEGER(val) - 1);
197
198 /* Create a mutex */
199
200 status =
201 acpi_os_create_mutex(&obj_desc->mutex.
202 os_mutex);
203 if (ACPI_FAILURE(status)) {
204 acpi_ut_remove_reference(obj_desc);
205 goto unlock_and_exit;
206 }
207
208 /* Special case for ACPI Global Lock */
209
210 if (ACPI_STRCMP(init_val->name, "_GL_") == 0) {
211 acpi_gbl_global_lock_mutex = obj_desc;
212
213 /* Create additional counting semaphore for global lock */
214
215 status =
216 acpi_os_create_semaphore(1, 0,
217 &acpi_gbl_global_lock_semaphore);
218 if (ACPI_FAILURE(status)) {
219 acpi_ut_remove_reference
220 (obj_desc);
221 goto unlock_and_exit;
222 }
223 }
224 break;
225
226 default:
227
228 ACPI_ERROR((AE_INFO,
229 "Unsupported initial type value %X",
230 init_val->type));
231 acpi_ut_remove_reference(obj_desc);
232 obj_desc = NULL;
233 continue;
234 }
235
236 /* Store pointer to value descriptor in the Node */
237
238 status = acpi_ns_attach_object(new_node, obj_desc,
239 ACPI_GET_OBJECT_TYPE
240 (obj_desc));
241
242 /* Remove local reference to the object */
243
244 acpi_ut_remove_reference(obj_desc);
245 }
246 }
247
248 unlock_and_exit:
249 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
250
251 /* Save a handle to "_GPE", it is always present */
252
253 if (ACPI_SUCCESS(status)) {
254 status = acpi_ns_get_node(NULL, "\\_GPE", ACPI_NS_NO_UPSEARCH,
255 &acpi_gbl_fadt_gpe_device);
256 }
257
258 return_ACPI_STATUS(status);
259 }
260
261 /*******************************************************************************
262 *
263 * FUNCTION: acpi_ns_lookup
264 *
265 * PARAMETERS: scope_info - Current scope info block
266 * Pathname - Search pathname, in internal format
267 * (as represented in the AML stream)
268 * Type - Type associated with name
269 * interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
270 * Flags - Flags describing the search restrictions
271 * walk_state - Current state of the walk
272 * return_node - Where the Node is placed (if found
273 * or created successfully)
274 *
275 * RETURN: Status
276 *
277 * DESCRIPTION: Find or enter the passed name in the name space.
278 * Log an error if name not found in Exec mode.
279 *
280 * MUTEX: Assumes namespace is locked.
281 *
282 ******************************************************************************/
283
284 acpi_status
285 acpi_ns_lookup(union acpi_generic_state *scope_info,
286 char *pathname,
287 acpi_object_type type,
288 acpi_interpreter_mode interpreter_mode,
289 u32 flags,
290 struct acpi_walk_state *walk_state,
291 struct acpi_namespace_node **return_node)
292 {
293 acpi_status status;
294 char *path = pathname;
295 struct acpi_namespace_node *prefix_node;
296 struct acpi_namespace_node *current_node = NULL;
297 struct acpi_namespace_node *this_node = NULL;
298 u32 num_segments;
299 u32 num_carats;
300 acpi_name simple_name;
301 acpi_object_type type_to_check_for;
302 acpi_object_type this_search_type;
303 u32 search_parent_flag = ACPI_NS_SEARCH_PARENT;
304 u32 local_flags;
305
306 ACPI_FUNCTION_TRACE(ns_lookup);
307
308 if (!return_node) {
309 return_ACPI_STATUS(AE_BAD_PARAMETER);
310 }
311
312 local_flags = flags & ~(ACPI_NS_ERROR_IF_FOUND | ACPI_NS_SEARCH_PARENT);
313 *return_node = ACPI_ENTRY_NOT_FOUND;
314 acpi_gbl_ns_lookup_count++;
315
316 if (!acpi_gbl_root_node) {
317 return_ACPI_STATUS(AE_NO_NAMESPACE);
318 }
319
320 /*
321 * Get the prefix scope.
322 * A null scope means use the root scope
323 */
324 if ((!scope_info) || (!scope_info->scope.node)) {
325 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
326 "Null scope prefix, using root node (%p)\n",
327 acpi_gbl_root_node));
328
329 prefix_node = acpi_gbl_root_node;
330 } else {
331 prefix_node = scope_info->scope.node;
332 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node) !=
333 ACPI_DESC_TYPE_NAMED) {
334 ACPI_ERROR((AE_INFO, "%p is not a namespace node [%s]",
335 prefix_node,
336 acpi_ut_get_descriptor_name(prefix_node)));
337 return_ACPI_STATUS(AE_AML_INTERNAL);
338 }
339
340 if (!(flags & ACPI_NS_PREFIX_IS_SCOPE)) {
341 /*
342 * This node might not be a actual "scope" node (such as a
343 * Device/Method, etc.) It could be a Package or other object node.
344 * Backup up the tree to find the containing scope node.
345 */
346 while (!acpi_ns_opens_scope(prefix_node->type) &&
347 prefix_node->type != ACPI_TYPE_ANY) {
348 prefix_node =
349 acpi_ns_get_parent_node(prefix_node);
350 }
351 }
352 }
353
354 /* Save type TBD: may be no longer necessary */
355
356 type_to_check_for = type;
357
358 /*
359 * Begin examination of the actual pathname
360 */
361 if (!pathname) {
362
363 /* A Null name_path is allowed and refers to the root */
364
365 num_segments = 0;
366 this_node = acpi_gbl_root_node;
367 path = "";
368
369 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
370 "Null Pathname (Zero segments), Flags=%X\n",
371 flags));
372 } else {
373 /*
374 * Name pointer is valid (and must be in internal name format)
375 *
376 * Check for scope prefixes:
377 *
378 * As represented in the AML stream, a namepath consists of an
379 * optional scope prefix followed by a name segment part.
380 *
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).
385 */
386 if (*path == (u8) AML_ROOT_PREFIX) {
387
388 /* Pathname is fully qualified, start from the root */
389
390 this_node = acpi_gbl_root_node;
391 search_parent_flag = ACPI_NS_NO_UPSEARCH;
392
393 /* Point to name segment part */
394
395 path++;
396
397 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
398 "Path is absolute from root [%p]\n",
399 this_node));
400 } else {
401 /* Pathname is relative to current scope, start there */
402
403 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
404 "Searching relative to prefix scope [%4.4s] (%p)\n",
405 acpi_ut_get_node_name(prefix_node),
406 prefix_node));
407
408 /*
409 * Handle multiple Parent Prefixes (carat) by just getting
410 * the parent node for each prefix instance.
411 */
412 this_node = prefix_node;
413 num_carats = 0;
414 while (*path == (u8) AML_PARENT_PREFIX) {
415
416 /* Name is fully qualified, no search rules apply */
417
418 search_parent_flag = ACPI_NS_NO_UPSEARCH;
419 /*
420 * Point past this prefix to the name segment
421 * part or the next Parent Prefix
422 */
423 path++;
424
425 /* Backup to the parent node */
426
427 num_carats++;
428 this_node = acpi_ns_get_parent_node(this_node);
429 if (!this_node) {
430
431 /* Current scope has no parent scope */
432
433 ACPI_ERROR((AE_INFO,
434 "ACPI path has too many parent prefixes (^) - reached beyond root node"));
435 return_ACPI_STATUS(AE_NOT_FOUND);
436 }
437 }
438
439 if (search_parent_flag == ACPI_NS_NO_UPSEARCH) {
440 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
441 "Search scope is [%4.4s], path has %d carat(s)\n",
442 acpi_ut_get_node_name
443 (this_node), num_carats));
444 }
445 }
446
447 /*
448 * Determine the number of ACPI name segments in this pathname.
449 *
450 * The segment part consists of either:
451 * - A Null name segment (0)
452 * - A dual_name_prefix followed by two 4-byte name segments
453 * - A multi_name_prefix followed by a byte indicating the
454 * number of segments and the segments themselves.
455 * - A single 4-byte name segment
456 *
457 * Examine the name prefix opcode, if any, to determine the number of
458 * segments.
459 */
460 switch (*path) {
461 case 0:
462 /*
463 * Null name after a root or parent prefixes. We already
464 * have the correct target node and there are no name segments.
465 */
466 num_segments = 0;
467 type = this_node->type;
468
469 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
470 "Prefix-only Pathname (Zero name segments), Flags=%X\n",
471 flags));
472 break;
473
474 case AML_DUAL_NAME_PREFIX:
475
476 /* More than one name_seg, search rules do not apply */
477
478 search_parent_flag = ACPI_NS_NO_UPSEARCH;
479
480 /* Two segments, point to first name segment */
481
482 num_segments = 2;
483 path++;
484
485 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
486 "Dual Pathname (2 segments, Flags=%X)\n",
487 flags));
488 break;
489
490 case AML_MULTI_NAME_PREFIX_OP:
491
492 /* More than one name_seg, search rules do not apply */
493
494 search_parent_flag = ACPI_NS_NO_UPSEARCH;
495
496 /* Extract segment count, point to first name segment */
497
498 path++;
499 num_segments = (u32) (u8) * path;
500 path++;
501
502 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
503 "Multi Pathname (%d Segments, Flags=%X)\n",
504 num_segments, flags));
505 break;
506
507 default:
508 /*
509 * Not a Null name, no Dual or Multi prefix, hence there is
510 * only one name segment and Pathname is already pointing to it.
511 */
512 num_segments = 1;
513
514 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
515 "Simple Pathname (1 segment, Flags=%X)\n",
516 flags));
517 break;
518 }
519
520 ACPI_DEBUG_EXEC(acpi_ns_print_pathname(num_segments, path));
521 }
522
523 /*
524 * Search namespace for each segment of the name. Loop through and
525 * verify (or add to the namespace) each name segment.
526 *
527 * The object type is significant only at the last name
528 * segment. (We don't care about the types along the path, only
529 * the type of the final target object.)
530 */
531 this_search_type = ACPI_TYPE_ANY;
532 current_node = this_node;
533 while (num_segments && current_node) {
534 num_segments--;
535 if (!num_segments) {
536 /*
537 * This is the last segment, enable typechecking
538 */
539 this_search_type = type;
540
541 /*
542 * Only allow automatic parent search (search rules) if the caller
543 * requested it AND we have a single, non-fully-qualified name_seg
544 */
545 if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
546 (flags & ACPI_NS_SEARCH_PARENT)) {
547 local_flags |= ACPI_NS_SEARCH_PARENT;
548 }
549
550 /* Set error flag according to caller */
551
552 if (flags & ACPI_NS_ERROR_IF_FOUND) {
553 local_flags |= ACPI_NS_ERROR_IF_FOUND;
554 }
555 }
556
557 /* Extract one ACPI name from the front of the pathname */
558
559 ACPI_MOVE_32_TO_32(&simple_name, path);
560
561 /* Try to find the single (4 character) ACPI name */
562
563 status =
564 acpi_ns_search_and_enter(simple_name, walk_state,
565 current_node, interpreter_mode,
566 this_search_type, local_flags,
567 &this_node);
568 if (ACPI_FAILURE(status)) {
569 if (status == AE_NOT_FOUND) {
570
571 /* Name not found in ACPI namespace */
572
573 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
574 "Name [%4.4s] not found in scope [%4.4s] %p\n",
575 (char *)&simple_name,
576 (char *)&current_node->name,
577 current_node));
578 }
579
580 *return_node = this_node;
581 return_ACPI_STATUS(status);
582 }
583
584 /* More segments to follow? */
585
586 if (num_segments > 0) {
587 /*
588 * If we have an alias to an object that opens a scope (such as a
589 * device or processor), we need to dereference the alias here so that
590 * we can access any children of the original node (via the remaining
591 * segments).
592 */
593 if (this_node->type == ACPI_TYPE_LOCAL_ALIAS) {
594 if (acpi_ns_opens_scope
595 (((struct acpi_namespace_node *)this_node->
596 object)->type)) {
597 this_node =
598 (struct acpi_namespace_node *)
599 this_node->object;
600 }
601 }
602 }
603
604 /* Special handling for the last segment (num_segments == 0) */
605
606 else {
607 /*
608 * Sanity typecheck of the target object:
609 *
610 * If 1) This is the last segment (num_segments == 0)
611 * 2) And we are looking for a specific type
612 * (Not checking for TYPE_ANY)
613 * 3) Which is not an alias
614 * 4) Which is not a local type (TYPE_SCOPE)
615 * 5) And the type of target object is known (not TYPE_ANY)
616 * 6) And target object does not match what we are looking for
617 *
618 * Then we have a type mismatch. Just warn and ignore it.
619 */
620 if ((type_to_check_for != ACPI_TYPE_ANY) &&
621 (type_to_check_for != ACPI_TYPE_LOCAL_ALIAS) &&
622 (type_to_check_for != ACPI_TYPE_LOCAL_METHOD_ALIAS)
623 && (type_to_check_for != ACPI_TYPE_LOCAL_SCOPE)
624 && (this_node->type != ACPI_TYPE_ANY)
625 && (this_node->type != type_to_check_for)) {
626
627 /* Complain about a type mismatch */
628
629 ACPI_WARNING((AE_INFO,
630 "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
631 ACPI_CAST_PTR(char, &simple_name),
632 acpi_ut_get_type_name(this_node->
633 type),
634 acpi_ut_get_type_name
635 (type_to_check_for)));
636 }
637
638 /*
639 * If this is the last name segment and we are not looking for a
640 * specific type, but the type of found object is known, use that type
641 * to (later) see if it opens a scope.
642 */
643 if (type == ACPI_TYPE_ANY) {
644 type = this_node->type;
645 }
646 }
647
648 /* Point to next name segment and make this node current */
649
650 path += ACPI_NAME_SIZE;
651 current_node = this_node;
652 }
653
654 /*
655 * Always check if we need to open a new scope
656 */
657 if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
658 /*
659 * If entry is a type which opens a scope, push the new scope on the
660 * scope stack.
661 */
662 if (acpi_ns_opens_scope(type)) {
663 status =
664 acpi_ds_scope_stack_push(this_node, type,
665 walk_state);
666 if (ACPI_FAILURE(status)) {
667 return_ACPI_STATUS(status);
668 }
669 }
670 }
671
672 *return_node = this_node;
673 return_ACPI_STATUS(AE_OK);
674 }