6cbe22f72dbb481bdd92cb13f342f0673447321e
[linux-2.6.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 - 2004, R. Byron Moore
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
45 #include <acpi/acpi.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acdispat.h>
49
50
51 #define _COMPONENT          ACPI_NAMESPACE
52          ACPI_MODULE_NAME    ("nsaccess")
53
54
55 /*******************************************************************************
56  *
57  * FUNCTION:    acpi_ns_root_initialize
58  *
59  * PARAMETERS:  None
60  *
61  * RETURN:      Status
62  *
63  * DESCRIPTION: Allocate and initialize the default root named objects
64  *
65  * MUTEX:       Locks namespace for entire execution
66  *
67  ******************************************************************************/
68
69 acpi_status
70 acpi_ns_root_initialize (void)
71 {
72         acpi_status                         status;
73         const struct acpi_predefined_names *init_val = NULL;
74         struct acpi_namespace_node          *new_node;
75         union acpi_operand_object           *obj_desc;
76         acpi_string                         val = NULL;
77
78
79         ACPI_FUNCTION_TRACE ("ns_root_initialize");
80
81
82         status = acpi_ut_acquire_mutex (ACPI_MTX_NAMESPACE);
83         if (ACPI_FAILURE (status)) {
84                 return_ACPI_STATUS (status);
85         }
86
87         /*
88          * The global root ptr is initially NULL, so a non-NULL value indicates
89          * that acpi_ns_root_initialize() has already been called; just return.
90          */
91         if (acpi_gbl_root_node) {
92                 status = AE_OK;
93                 goto unlock_and_exit;
94         }
95
96         /*
97          * Tell the rest of the subsystem that the root is initialized
98          * (This is OK because the namespace is locked)
99          */
100         acpi_gbl_root_node = &acpi_gbl_root_node_struct;
101
102         /* Enter the pre-defined names in the name table */
103
104         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
105                 "Entering predefined entries into namespace\n"));
106
107         for (init_val = acpi_gbl_pre_defined_names; init_val->name; init_val++) {
108                 /* _OSI is optional for now, will be permanent later */
109
110                 if (!ACPI_STRCMP (init_val->name, "_OSI") && !acpi_gbl_create_osi_method) {
111                         continue;
112                 }
113
114                 status = acpi_ns_lookup (NULL, init_val->name, init_val->type,
115                                   ACPI_IMODE_LOAD_PASS2, ACPI_NS_NO_UPSEARCH,
116                                   NULL, &new_node);
117
118                 if (ACPI_FAILURE (status) || (!new_node)) /* Must be on same line for code converter */ {
119                         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
120                                 "Could not create predefined name %s, %s\n",
121                                 init_val->name, acpi_format_exception (status)));
122                 }
123
124                 /*
125                  * Name entered successfully.
126                  * If entry in pre_defined_names[] specifies an
127                  * initial value, create the initial value.
128                  */
129                 if (init_val->val) {
130                         status = acpi_os_predefined_override (init_val, &val);
131                         if (ACPI_FAILURE (status)) {
132                                 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
133                                         "Could not override predefined %s\n",
134                                         init_val->name));
135                         }
136
137                         if (!val) {
138                                 val = init_val->val;
139                         }
140
141                         /*
142                          * Entry requests an initial value, allocate a
143                          * descriptor for it.
144                          */
145                         obj_desc = acpi_ut_create_internal_object (init_val->type);
146                         if (!obj_desc) {
147                                 status = AE_NO_MEMORY;
148                                 goto unlock_and_exit;
149                         }
150
151                         /*
152                          * Convert value string from table entry to
153                          * internal representation. Only types actually
154                          * used for initial values are implemented here.
155                          */
156                         switch (init_val->type) {
157                         case ACPI_TYPE_METHOD:
158                                 obj_desc->method.param_count = (u8) ACPI_STRTOUL
159                                                   (val, NULL, 10);
160                                 obj_desc->common.flags |= AOPOBJ_DATA_VALID;
161
162 #if defined (_ACPI_ASL_COMPILER) || defined (_ACPI_DUMP_App)
163
164                                 /*
165                                  * i_aSL Compiler cheats by putting parameter count
166                                  * in the owner_iD
167                                  */
168                                 new_node->owner_id = obj_desc->method.param_count;
169 #else
170                                 /* Mark this as a very SPECIAL method */
171
172                                 obj_desc->method.method_flags = AML_METHOD_INTERNAL_ONLY;
173                                 obj_desc->method.implementation = acpi_ut_osi_implementation;
174 #endif
175                                 break;
176
177                         case ACPI_TYPE_INTEGER:
178
179                                 obj_desc->integer.value =
180                                                 (acpi_integer) ACPI_STRTOUL (val, NULL, 10);
181                                 break;
182
183
184                         case ACPI_TYPE_STRING:
185
186                                 /*
187                                  * Build an object around the static string
188                                  */
189                                 obj_desc->string.length = (u32) ACPI_STRLEN (val);
190                                 obj_desc->string.pointer = val;
191                                 obj_desc->common.flags |= AOPOBJ_STATIC_POINTER;
192                                 break;
193
194
195                         case ACPI_TYPE_MUTEX:
196
197                                 obj_desc->mutex.node = new_node;
198                                 obj_desc->mutex.sync_level = (u8) ACPI_STRTOUL
199                                                   (val, NULL, 10);
200
201                                 if (ACPI_STRCMP (init_val->name, "_GL_") == 0) {
202                                         /*
203                                          * Create a counting semaphore for the
204                                          * global lock
205                                          */
206                                         status = acpi_os_create_semaphore (ACPI_NO_UNIT_LIMIT,
207                                                          1, &obj_desc->mutex.semaphore);
208                                         if (ACPI_FAILURE (status)) {
209                                                 acpi_ut_remove_reference (obj_desc);
210                                                 goto unlock_and_exit;
211                                         }
212
213                                         /*
214                                          * We just created the mutex for the
215                                          * global lock, save it
216                                          */
217                                         acpi_gbl_global_lock_semaphore = obj_desc->mutex.semaphore;
218                                 }
219                                 else {
220                                         /* Create a mutex */
221
222                                         status = acpi_os_create_semaphore (1, 1,
223                                                            &obj_desc->mutex.semaphore);
224                                         if (ACPI_FAILURE (status)) {
225                                                 acpi_ut_remove_reference (obj_desc);
226                                                 goto unlock_and_exit;
227                                         }
228                                 }
229                                 break;
230
231
232                         default:
233
234                                 ACPI_REPORT_ERROR (("Unsupported initial type value %X\n",
235                                         init_val->type));
236                                 acpi_ut_remove_reference (obj_desc);
237                                 obj_desc = NULL;
238                                 continue;
239                         }
240
241                         /* Store pointer to value descriptor in the Node */
242
243                         status = acpi_ns_attach_object (new_node, obj_desc,
244                                          ACPI_GET_OBJECT_TYPE (obj_desc));
245
246                         /* Remove local reference to the object */
247
248                         acpi_ut_remove_reference (obj_desc);
249                 }
250         }
251
252
253 unlock_and_exit:
254         (void) acpi_ut_release_mutex (ACPI_MTX_NAMESPACE);
255
256         /* Save a handle to "_GPE", it is always present */
257
258         if (ACPI_SUCCESS (status)) {
259                 status = acpi_ns_get_node_by_path ("\\_GPE", NULL, ACPI_NS_NO_UPSEARCH,
260                                   &acpi_gbl_fadt_gpe_device);
261         }
262
263         return_ACPI_STATUS (status);
264 }
265
266
267 /*******************************************************************************
268  *
269  * FUNCTION:    acpi_ns_lookup
270  *
271  * PARAMETERS:  prefix_node     - Search scope if name is not fully qualified
272  *              Pathname        - Search pathname, in internal format
273  *                                (as represented in the AML stream)
274  *              Type            - Type associated with name
275  *              interpreter_mode - IMODE_LOAD_PASS2 => add name if not found
276  *              Flags           - Flags describing the search restrictions
277  *              walk_state      - Current state of the walk
278  *              return_node     - Where the Node is placed (if found
279  *                                or created successfully)
280  *
281  * RETURN:      Status
282  *
283  * DESCRIPTION: Find or enter the passed name in the name space.
284  *              Log an error if name not found in Exec mode.
285  *
286  * MUTEX:       Assumes namespace is locked.
287  *
288  ******************************************************************************/
289
290 acpi_status
291 acpi_ns_lookup (
292         union acpi_generic_state        *scope_info,
293         char                            *pathname,
294         acpi_object_type                type,
295         acpi_interpreter_mode           interpreter_mode,
296         u32                             flags,
297         struct acpi_walk_state          *walk_state,
298         struct acpi_namespace_node      **return_node)
299 {
300         acpi_status                     status;
301         char                            *path = pathname;
302         struct acpi_namespace_node      *prefix_node;
303         struct acpi_namespace_node      *current_node = NULL;
304         struct acpi_namespace_node      *this_node = NULL;
305         u32                             num_segments;
306         u32                             num_carats;
307         acpi_name                       simple_name;
308         acpi_object_type                type_to_check_for;
309         acpi_object_type                this_search_type;
310         u32                             search_parent_flag = ACPI_NS_SEARCH_PARENT;
311         u32                             local_flags = flags & ~(ACPI_NS_ERROR_IF_FOUND |
312                            ACPI_NS_SEARCH_PARENT);
313
314
315         ACPI_FUNCTION_TRACE ("ns_lookup");
316
317
318         if (!return_node) {
319                 return_ACPI_STATUS (AE_BAD_PARAMETER);
320         }
321
322         acpi_gbl_ns_lookup_count++;
323         *return_node = ACPI_ENTRY_NOT_FOUND;
324
325         if (!acpi_gbl_root_node) {
326                 return_ACPI_STATUS (AE_NO_NAMESPACE);
327         }
328
329         /*
330          * Get the prefix scope.
331          * A null scope means use the root scope
332          */
333         if ((!scope_info) ||
334                 (!scope_info->scope.node)) {
335                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
336                         "Null scope prefix, using root node (%p)\n",
337                         acpi_gbl_root_node));
338
339                 prefix_node = acpi_gbl_root_node;
340         }
341         else {
342                 prefix_node = scope_info->scope.node;
343                 if (ACPI_GET_DESCRIPTOR_TYPE (prefix_node) != ACPI_DESC_TYPE_NAMED) {
344                         ACPI_REPORT_ERROR (("ns_lookup: %p is not a namespace node [%s]\n",
345                                         prefix_node, acpi_ut_get_descriptor_name (prefix_node)));
346                         return_ACPI_STATUS (AE_AML_INTERNAL);
347                 }
348
349                 /*
350                  * This node might not be a actual "scope" node (such as a
351                  * Device/Method, etc.)  It could be a Package or other object node.
352                  * Backup up the tree to find the containing scope node.
353                  */
354                 while (!acpi_ns_opens_scope (prefix_node->type) &&
355                                 prefix_node->type != ACPI_TYPE_ANY) {
356                         prefix_node = acpi_ns_get_parent_node (prefix_node);
357                 }
358         }
359
360         /* Save type   TBD: may be no longer necessary */
361
362         type_to_check_for = type;
363
364         /*
365          * Begin examination of the actual pathname
366          */
367         if (!pathname) {
368                 /* A Null name_path is allowed and refers to the root */
369
370                 num_segments = 0;
371                 this_node    = acpi_gbl_root_node;
372                 path     = "";
373
374                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
375                         "Null Pathname (Zero segments), Flags=%X\n", flags));
376         }
377         else {
378                 /*
379                  * Name pointer is valid (and must be in internal name format)
380                  *
381                  * Check for scope prefixes:
382                  *
383                  * As represented in the AML stream, a namepath consists of an
384                  * optional scope prefix followed by a name segment part.
385                  *
386                  * If present, the scope prefix is either a Root Prefix (in
387                  * which case the name is fully qualified), or one or more
388                  * Parent Prefixes (in which case the name's scope is relative
389                  * to the current scope).
390                  */
391                 if (*path == (u8) AML_ROOT_PREFIX) {
392                         /* Pathname is fully qualified, start from the root */
393
394                         this_node = acpi_gbl_root_node;
395                         search_parent_flag = ACPI_NS_NO_UPSEARCH;
396
397                         /* Point to name segment part */
398
399                         path++;
400
401                         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
402                                 "Path is absolute from root [%p]\n", this_node));
403                 }
404                 else {
405                         /* Pathname is relative to current scope, start there */
406
407                         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
408                                 "Searching relative to prefix scope [%4.4s] (%p)\n",
409                                 acpi_ut_get_node_name (prefix_node), prefix_node));
410
411                         /*
412                          * Handle multiple Parent Prefixes (carat) by just getting
413                          * the parent node for each prefix instance.
414                          */
415                         this_node = prefix_node;
416                         num_carats = 0;
417                         while (*path == (u8) AML_PARENT_PREFIX) {
418                                 /* Name is fully qualified, no search rules apply */
419
420                                 search_parent_flag = ACPI_NS_NO_UPSEARCH;
421                                 /*
422                                  * Point past this prefix to the name segment
423                                  * part or the next Parent Prefix
424                                  */
425                                 path++;
426
427                                 /* Backup to the parent node */
428
429                                 num_carats++;
430                                 this_node = acpi_ns_get_parent_node (this_node);
431                                 if (!this_node) {
432                                         /* Current scope has no parent scope */
433
434                                         ACPI_REPORT_ERROR (
435                                                 ("ACPI path has too many parent prefixes (^) - reached beyond root node\n"));
436                                         return_ACPI_STATUS (AE_NOT_FOUND);
437                                 }
438                         }
439
440                         if (search_parent_flag == ACPI_NS_NO_UPSEARCH) {
441                                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
442                                         "Search scope is [%4.4s], path has %d carat(s)\n",
443                                         acpi_ut_get_node_name (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", flags));
487                         break;
488
489                 case AML_MULTI_NAME_PREFIX_OP:
490
491                         /* More than one name_seg, search rules do not apply */
492
493                         search_parent_flag = ACPI_NS_NO_UPSEARCH;
494
495                         /* Extract segment count, point to first name segment */
496
497                         path++;
498                         num_segments = (u32) (u8) *path;
499                         path++;
500
501                         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
502                                 "Multi Pathname (%d Segments, Flags=%X) \n",
503                                 num_segments, flags));
504                         break;
505
506                 default:
507                         /*
508                          * Not a Null name, no Dual or Multi prefix, hence there is
509                          * only one name segment and Pathname is already pointing to it.
510                          */
511                         num_segments = 1;
512
513                         ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
514                                 "Simple Pathname (1 segment, Flags=%X)\n", flags));
515                         break;
516                 }
517
518                 ACPI_DEBUG_EXEC (acpi_ns_print_pathname (num_segments, path));
519         }
520
521
522         /*
523          * Search namespace for each segment of the name.  Loop through and
524          * verify (or add to the namespace) each name segment.
525          *
526          * The object type is significant only at the last name
527          * segment.  (We don't care about the types along the path, only
528          * the type of the final target object.)
529          */
530         this_search_type = ACPI_TYPE_ANY;
531         current_node = this_node;
532         while (num_segments && current_node) {
533                 num_segments--;
534                 if (!num_segments) {
535                         /*
536                          * This is the last segment, enable typechecking
537                          */
538                         this_search_type = type;
539
540                         /*
541                          * Only allow automatic parent search (search rules) if the caller
542                          * requested it AND we have a single, non-fully-qualified name_seg
543                          */
544                         if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
545                                 (flags & ACPI_NS_SEARCH_PARENT)) {
546                                 local_flags |= ACPI_NS_SEARCH_PARENT;
547                         }
548
549                         /* Set error flag according to caller */
550
551                         if (flags & ACPI_NS_ERROR_IF_FOUND) {
552                                 local_flags |= ACPI_NS_ERROR_IF_FOUND;
553                         }
554                 }
555
556                 /* Extract one ACPI name from the front of the pathname */
557
558                 ACPI_MOVE_32_TO_32 (&simple_name, path);
559
560                 /* Try to find the single (4 character) ACPI name */
561
562                 status = acpi_ns_search_and_enter (simple_name, walk_state, current_node,
563                                  interpreter_mode, this_search_type, local_flags, &this_node);
564                 if (ACPI_FAILURE (status)) {
565                         if (status == AE_NOT_FOUND) {
566                                 /* Name not found in ACPI namespace */
567
568                                 ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
569                                         "Name [%4.4s] not found in scope [%4.4s] %p\n",
570                                         (char *) &simple_name, (char *) &current_node->name,
571                                         current_node));
572                         }
573
574                         *return_node = this_node;
575                         return_ACPI_STATUS (status);
576                 }
577
578                 /*
579                  * Sanity typecheck of the target object:
580                  *
581                  * If 1) This is the last segment (num_segments == 0)
582                  *    2) And we are looking for a specific type
583                  *       (Not checking for TYPE_ANY)
584                  *    3) Which is not an alias
585                  *    4) Which is not a local type (TYPE_SCOPE)
586                  *    5) And the type of target object is known (not TYPE_ANY)
587                  *    6) And target object does not match what we are looking for
588                  *
589                  * Then we have a type mismatch.  Just warn and ignore it.
590                  */
591                 if ((num_segments       == 0)                               &&
592                         (type_to_check_for  != ACPI_TYPE_ANY)                   &&
593                         (type_to_check_for  != ACPI_TYPE_LOCAL_ALIAS)           &&
594                         (type_to_check_for  != ACPI_TYPE_LOCAL_METHOD_ALIAS)    &&
595                         (type_to_check_for  != ACPI_TYPE_LOCAL_SCOPE)           &&
596                         (this_node->type    != ACPI_TYPE_ANY)                   &&
597                         (this_node->type    != type_to_check_for)) {
598                         /* Complain about a type mismatch */
599
600                         ACPI_REPORT_WARNING (
601                                 ("ns_lookup: Type mismatch on %4.4s (%s), searching for (%s)\n",
602                                 (char *) &simple_name, acpi_ut_get_type_name (this_node->type),
603                                 acpi_ut_get_type_name (type_to_check_for)));
604                 }
605
606                 /*
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.
610                  */
611                 if ((num_segments == 0) && (type == ACPI_TYPE_ANY)) {
612                         type = this_node->type;
613                 }
614
615                 /* Point to next name segment and make this node current */
616
617                 path += ACPI_NAME_SIZE;
618                 current_node = this_node;
619         }
620
621         /*
622          * Always check if we need to open a new scope
623          */
624         if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
625                 /*
626                  * If entry is a type which opens a scope, push the new scope on the
627                  * scope stack.
628                  */
629                 if (acpi_ns_opens_scope (type)) {
630                         status = acpi_ds_scope_stack_push (this_node, type, walk_state);
631                         if (ACPI_FAILURE (status)) {
632                                 return_ACPI_STATUS (status);
633                         }
634                 }
635         }
636
637         *return_node = this_node;
638         return_ACPI_STATUS (AE_OK);
639 }
640