Merge master.kernel.org:/pub/scm/linux/kernel/git/wim/linux-2.6-watchdog
[pandora-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 - 2006, 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 #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                                 if (ACPI_STRCMP(init_val->name, "_GL_") == 0) {
199                                         /*
200                                          * Create a counting semaphore for the
201                                          * global lock
202                                          */
203                                         status =
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
209                                                     (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 =
218                                             obj_desc->mutex.semaphore;
219                                 } else {
220                                         /* Create a mutex */
221
222                                         status = acpi_os_create_semaphore(1, 1,
223                                                                           &obj_desc->
224                                                                           mutex.
225                                                                           semaphore);
226                                         if (ACPI_FAILURE(status)) {
227                                                 acpi_ut_remove_reference
228                                                     (obj_desc);
229                                                 goto unlock_and_exit;
230                                         }
231                                 }
232                                 break;
233
234                         default:
235
236                                 ACPI_ERROR((AE_INFO,
237                                             "Unsupported initial type value %X",
238                                             init_val->type));
239                                 acpi_ut_remove_reference(obj_desc);
240                                 obj_desc = NULL;
241                                 continue;
242                         }
243
244                         /* Store pointer to value descriptor in the Node */
245
246                         status = acpi_ns_attach_object(new_node, obj_desc,
247                                                        ACPI_GET_OBJECT_TYPE
248                                                        (obj_desc));
249
250                         /* Remove local reference to the object */
251
252                         acpi_ut_remove_reference(obj_desc);
253                 }
254         }
255
256       unlock_and_exit:
257         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
258
259         /* Save a handle to "_GPE", it is always present */
260
261         if (ACPI_SUCCESS(status)) {
262                 status = acpi_ns_get_node(NULL, "\\_GPE", ACPI_NS_NO_UPSEARCH,
263                                           &acpi_gbl_fadt_gpe_device);
264         }
265
266         return_ACPI_STATUS(status);
267 }
268
269 /*******************************************************************************
270  *
271  * FUNCTION:    acpi_ns_lookup
272  *
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)
282  *
283  * RETURN:      Status
284  *
285  * DESCRIPTION: Find or enter the passed name in the name space.
286  *              Log an error if name not found in Exec mode.
287  *
288  * MUTEX:       Assumes namespace is locked.
289  *
290  ******************************************************************************/
291
292 acpi_status
293 acpi_ns_lookup(union acpi_generic_state *scope_info,
294                char *pathname,
295                acpi_object_type type,
296                acpi_interpreter_mode interpreter_mode,
297                u32 flags,
298                struct acpi_walk_state *walk_state,
299                struct acpi_namespace_node **return_node)
300 {
301         acpi_status status;
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;
306         u32 num_segments;
307         u32 num_carats;
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;
313
314         ACPI_FUNCTION_TRACE(ns_lookup);
315
316         if (!return_node) {
317                 return_ACPI_STATUS(AE_BAD_PARAMETER);
318         }
319
320         local_flags = flags & ~(ACPI_NS_ERROR_IF_FOUND | ACPI_NS_SEARCH_PARENT);
321         *return_node = ACPI_ENTRY_NOT_FOUND;
322         acpi_gbl_ns_lookup_count++;
323
324         if (!acpi_gbl_root_node) {
325                 return_ACPI_STATUS(AE_NO_NAMESPACE);
326         }
327
328         /*
329          * Get the prefix scope.
330          * A null scope means use the root scope
331          */
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));
336
337                 prefix_node = acpi_gbl_root_node;
338         } else {
339                 prefix_node = scope_info->scope.node;
340                 if (ACPI_GET_DESCRIPTOR_TYPE(prefix_node) !=
341                     ACPI_DESC_TYPE_NAMED) {
342                         ACPI_ERROR((AE_INFO, "%p is not a namespace node [%s]",
343                                     prefix_node,
344                                     acpi_ut_get_descriptor_name(prefix_node)));
345                         return_ACPI_STATUS(AE_AML_INTERNAL);
346                 }
347
348                 if (!(flags & ACPI_NS_PREFIX_IS_SCOPE)) {
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 =
357                                     acpi_ns_get_parent_node(prefix_node);
358                         }
359                 }
360         }
361
362         /* Save type   TBD: may be no longer necessary */
363
364         type_to_check_for = type;
365
366         /*
367          * Begin examination of the actual pathname
368          */
369         if (!pathname) {
370
371                 /* A Null name_path is allowed and refers to the root */
372
373                 num_segments = 0;
374                 this_node = acpi_gbl_root_node;
375                 path = "";
376
377                 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
378                                   "Null Pathname (Zero segments), Flags=%X\n",
379                                   flags));
380         } else {
381                 /*
382                  * Name pointer is valid (and must be in internal name format)
383                  *
384                  * Check for scope prefixes:
385                  *
386                  * As represented in the AML stream, a namepath consists of an
387                  * optional scope prefix followed by a name segment part.
388                  *
389                  * If present, the scope prefix is either a Root Prefix (in
390                  * which case the name is fully qualified), or one or more
391                  * Parent Prefixes (in which case the name's scope is relative
392                  * to the current scope).
393                  */
394                 if (*path == (u8) AML_ROOT_PREFIX) {
395
396                         /* Pathname is fully qualified, start from the root */
397
398                         this_node = acpi_gbl_root_node;
399                         search_parent_flag = ACPI_NS_NO_UPSEARCH;
400
401                         /* Point to name segment part */
402
403                         path++;
404
405                         ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
406                                           "Path is absolute from root [%p]\n",
407                                           this_node));
408                 } else {
409                         /* Pathname is relative to current scope, start there */
410
411                         ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
412                                           "Searching relative to prefix scope [%4.4s] (%p)\n",
413                                           acpi_ut_get_node_name(prefix_node),
414                                           prefix_node));
415
416                         /*
417                          * Handle multiple Parent Prefixes (carat) by just getting
418                          * the parent node for each prefix instance.
419                          */
420                         this_node = prefix_node;
421                         num_carats = 0;
422                         while (*path == (u8) AML_PARENT_PREFIX) {
423
424                                 /* Name is fully qualified, no search rules apply */
425
426                                 search_parent_flag = ACPI_NS_NO_UPSEARCH;
427                                 /*
428                                  * Point past this prefix to the name segment
429                                  * part or the next Parent Prefix
430                                  */
431                                 path++;
432
433                                 /* Backup to the parent node */
434
435                                 num_carats++;
436                                 this_node = acpi_ns_get_parent_node(this_node);
437                                 if (!this_node) {
438
439                                         /* Current scope has no parent scope */
440
441                                         ACPI_ERROR((AE_INFO,
442                                                     "ACPI path has too many parent prefixes (^) - reached beyond root node"));
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 %d 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_OP:
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 (%d 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         while (num_segments && current_node) {
542                 num_segments--;
543                 if (!num_segments) {
544                         /*
545                          * This is the last segment, enable typechecking
546                          */
547                         this_search_type = type;
548
549                         /*
550                          * Only allow automatic parent search (search rules) if the caller
551                          * requested it AND we have a single, non-fully-qualified name_seg
552                          */
553                         if ((search_parent_flag != ACPI_NS_NO_UPSEARCH) &&
554                             (flags & ACPI_NS_SEARCH_PARENT)) {
555                                 local_flags |= ACPI_NS_SEARCH_PARENT;
556                         }
557
558                         /* Set error flag according to caller */
559
560                         if (flags & ACPI_NS_ERROR_IF_FOUND) {
561                                 local_flags |= ACPI_NS_ERROR_IF_FOUND;
562                         }
563                 }
564
565                 /* Extract one ACPI name from the front of the pathname */
566
567                 ACPI_MOVE_32_TO_32(&simple_name, path);
568
569                 /* Try to find the single (4 character) ACPI name */
570
571                 status =
572                     acpi_ns_search_and_enter(simple_name, walk_state,
573                                              current_node, interpreter_mode,
574                                              this_search_type, local_flags,
575                                              &this_node);
576                 if (ACPI_FAILURE(status)) {
577                         if (status == AE_NOT_FOUND) {
578
579                                 /* Name not found in ACPI namespace */
580
581                                 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
582                                                   "Name [%4.4s] not found in scope [%4.4s] %p\n",
583                                                   (char *)&simple_name,
584                                                   (char *)&current_node->name,
585                                                   current_node));
586                         }
587
588                         *return_node = this_node;
589                         return_ACPI_STATUS(status);
590                 }
591
592                 /*
593                  * Sanity typecheck of the target object:
594                  *
595                  * If 1) This is the last segment (num_segments == 0)
596                  *    2) And we are looking for a specific type
597                  *       (Not checking for TYPE_ANY)
598                  *    3) Which is not an alias
599                  *    4) Which is not a local type (TYPE_SCOPE)
600                  *    5) And the type of target object is known (not TYPE_ANY)
601                  *    6) And target object does not match what we are looking for
602                  *
603                  * Then we have a type mismatch.  Just warn and ignore it.
604                  */
605                 if ((num_segments == 0) &&
606                     (type_to_check_for != ACPI_TYPE_ANY) &&
607                     (type_to_check_for != ACPI_TYPE_LOCAL_ALIAS) &&
608                     (type_to_check_for != ACPI_TYPE_LOCAL_METHOD_ALIAS) &&
609                     (type_to_check_for != ACPI_TYPE_LOCAL_SCOPE) &&
610                     (this_node->type != ACPI_TYPE_ANY) &&
611                     (this_node->type != type_to_check_for)) {
612
613                         /* Complain about a type mismatch */
614
615                         ACPI_WARNING((AE_INFO,
616                                       "NsLookup: Type mismatch on %4.4s (%s), searching for (%s)",
617                                       ACPI_CAST_PTR(char, &simple_name),
618                                       acpi_ut_get_type_name(this_node->type),
619                                       acpi_ut_get_type_name
620                                       (type_to_check_for)));
621                 }
622
623                 /*
624                  * If this is the last name segment and we are not looking for a
625                  * specific type, but the type of found object is known, use that type
626                  * to see if it opens a scope.
627                  */
628                 if ((num_segments == 0) && (type == ACPI_TYPE_ANY)) {
629                         type = this_node->type;
630                 }
631
632                 /* Point to next name segment and make this node current */
633
634                 path += ACPI_NAME_SIZE;
635                 current_node = this_node;
636         }
637
638         /*
639          * Always check if we need to open a new scope
640          */
641         if (!(flags & ACPI_NS_DONT_OPEN_SCOPE) && (walk_state)) {
642                 /*
643                  * If entry is a type which opens a scope, push the new scope on the
644                  * scope stack.
645                  */
646                 if (acpi_ns_opens_scope(type)) {
647                         status =
648                             acpi_ds_scope_stack_push(this_node, type,
649                                                      walk_state);
650                         if (ACPI_FAILURE(status)) {
651                                 return_ACPI_STATUS(status);
652                         }
653                 }
654         }
655
656         *return_node = this_node;
657         return_ACPI_STATUS(AE_OK);
658 }