Merge master.kernel.org:/pub/scm/linux/kernel/git/gregkh/usb-2.6
[linux-2.6] / drivers / acpi / namespace / nsinit.c
1 /******************************************************************************
2  *
3  * Module Name: nsinit - namespace initialization
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2007, 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/acnamesp.h>
46 #include <acpi/acdispat.h>
47 #include <acpi/acinterp.h>
48
49 #define _COMPONENT          ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsinit")
51
52 /* Local prototypes */
53 static acpi_status
54 acpi_ns_init_one_object(acpi_handle obj_handle,
55                         u32 level, void *context, void **return_value);
56
57 static acpi_status
58 acpi_ns_init_one_device(acpi_handle obj_handle,
59                         u32 nesting_level, void *context, void **return_value);
60
61 static acpi_status
62 acpi_ns_find_ini_methods(acpi_handle obj_handle,
63                          u32 nesting_level, void *context, void **return_value);
64
65 /*******************************************************************************
66  *
67  * FUNCTION:    acpi_ns_initialize_objects
68  *
69  * PARAMETERS:  None
70  *
71  * RETURN:      Status
72  *
73  * DESCRIPTION: Walk the entire namespace and perform any necessary
74  *              initialization on the objects found therein
75  *
76  ******************************************************************************/
77
78 acpi_status acpi_ns_initialize_objects(void)
79 {
80         acpi_status status;
81         struct acpi_init_walk_info info;
82
83         ACPI_FUNCTION_TRACE(ns_initialize_objects);
84
85         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
86                           "**** Starting initialization of namespace objects ****\n"));
87         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
88                               "Completing Region/Field/Buffer/Package initialization:"));
89
90         /* Set all init info to zero */
91
92         ACPI_MEMSET(&info, 0, sizeof(struct acpi_init_walk_info));
93
94         /* Walk entire namespace from the supplied root */
95
96         status = acpi_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
97                                      ACPI_UINT32_MAX, acpi_ns_init_one_object,
98                                      &info, NULL);
99         if (ACPI_FAILURE(status)) {
100                 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace"));
101         }
102
103         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
104                               "\nInitialized %hd/%hd Regions %hd/%hd Fields %hd/%hd Buffers %hd/%hd Packages (%hd nodes)\n",
105                               info.op_region_init, info.op_region_count,
106                               info.field_init, info.field_count,
107                               info.buffer_init, info.buffer_count,
108                               info.package_init, info.package_count,
109                               info.object_count));
110
111         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
112                           "%hd Control Methods found\n", info.method_count));
113         ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
114                           "%hd Op Regions found\n", info.op_region_count));
115
116         return_ACPI_STATUS(AE_OK);
117 }
118
119 /*******************************************************************************
120  *
121  * FUNCTION:    acpi_ns_initialize_devices
122  *
123  * PARAMETERS:  None
124  *
125  * RETURN:      acpi_status
126  *
127  * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
128  *              This means running _INI on all present devices.
129  *
130  *              Note: We install PCI config space handler on region access,
131  *              not here.
132  *
133  ******************************************************************************/
134
135 acpi_status acpi_ns_initialize_devices(void)
136 {
137         acpi_status status;
138         struct acpi_device_walk_info info;
139
140         ACPI_FUNCTION_TRACE(ns_initialize_devices);
141
142         /* Init counters */
143
144         info.device_count = 0;
145         info.num_STA = 0;
146         info.num_INI = 0;
147
148         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
149                               "Initializing Device/Processor/Thermal objects by executing _INI methods:"));
150
151         /* Tree analysis: find all subtrees that contain _INI methods */
152
153         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
154                                         ACPI_UINT32_MAX, FALSE,
155                                         acpi_ns_find_ini_methods, &info, NULL);
156         if (ACPI_FAILURE(status)) {
157                 goto error_exit;
158         }
159
160         /* Allocate the evaluation information block */
161
162         info.evaluate_info =
163             ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
164         if (!info.evaluate_info) {
165                 status = AE_NO_MEMORY;
166                 goto error_exit;
167         }
168
169         /* Walk namespace to execute all _INIs on present devices */
170
171         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
172                                         ACPI_UINT32_MAX, FALSE,
173                                         acpi_ns_init_one_device, &info, NULL);
174
175         ACPI_FREE(info.evaluate_info);
176         if (ACPI_FAILURE(status)) {
177                 goto error_exit;
178         }
179
180         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
181                               "\nExecuted %hd _INI methods requiring %hd _STA executions (examined %hd objects)\n",
182                               info.num_INI, info.num_STA, info.device_count));
183
184         return_ACPI_STATUS(status);
185
186       error_exit:
187         ACPI_EXCEPTION((AE_INFO, status, "During device initialization"));
188         return_ACPI_STATUS(status);
189 }
190
191 /*******************************************************************************
192  *
193  * FUNCTION:    acpi_ns_init_one_object
194  *
195  * PARAMETERS:  obj_handle      - Node
196  *              Level           - Current nesting level
197  *              Context         - Points to a init info struct
198  *              return_value    - Not used
199  *
200  * RETURN:      Status
201  *
202  * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
203  *              within the  namespace.
204  *
205  *              Currently, the only objects that require initialization are:
206  *              1) Methods
207  *              2) Op Regions
208  *
209  ******************************************************************************/
210
211 static acpi_status
212 acpi_ns_init_one_object(acpi_handle obj_handle,
213                         u32 level, void *context, void **return_value)
214 {
215         acpi_object_type type;
216         acpi_status status = AE_OK;
217         struct acpi_init_walk_info *info =
218             (struct acpi_init_walk_info *)context;
219         struct acpi_namespace_node *node =
220             (struct acpi_namespace_node *)obj_handle;
221         union acpi_operand_object *obj_desc;
222
223         ACPI_FUNCTION_NAME(ns_init_one_object);
224
225         info->object_count++;
226
227         /* And even then, we are only interested in a few object types */
228
229         type = acpi_ns_get_type(obj_handle);
230         obj_desc = acpi_ns_get_attached_object(node);
231         if (!obj_desc) {
232                 return (AE_OK);
233         }
234
235         /* Increment counters for object types we are looking for */
236
237         switch (type) {
238         case ACPI_TYPE_REGION:
239                 info->op_region_count++;
240                 break;
241
242         case ACPI_TYPE_BUFFER_FIELD:
243                 info->field_count++;
244                 break;
245
246         case ACPI_TYPE_BUFFER:
247                 info->buffer_count++;
248                 break;
249
250         case ACPI_TYPE_PACKAGE:
251                 info->package_count++;
252                 break;
253
254         default:
255
256                 /* No init required, just exit now */
257                 return (AE_OK);
258         }
259
260         /*
261          * If the object is already initialized, nothing else to do
262          */
263         if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
264                 return (AE_OK);
265         }
266
267         /*
268          * Must lock the interpreter before executing AML code
269          */
270         acpi_ex_enter_interpreter();
271
272         /*
273          * Each of these types can contain executable AML code within the
274          * declaration.
275          */
276         switch (type) {
277         case ACPI_TYPE_REGION:
278
279                 info->op_region_init++;
280                 status = acpi_ds_get_region_arguments(obj_desc);
281                 break;
282
283         case ACPI_TYPE_BUFFER_FIELD:
284
285                 info->field_init++;
286                 status = acpi_ds_get_buffer_field_arguments(obj_desc);
287                 break;
288
289         case ACPI_TYPE_BUFFER:
290
291                 info->buffer_init++;
292                 status = acpi_ds_get_buffer_arguments(obj_desc);
293                 break;
294
295         case ACPI_TYPE_PACKAGE:
296
297                 info->package_init++;
298                 status = acpi_ds_get_package_arguments(obj_desc);
299                 break;
300
301         default:
302                 /* No other types can get here */
303                 break;
304         }
305
306         if (ACPI_FAILURE(status)) {
307                 ACPI_EXCEPTION((AE_INFO, status,
308                                 "Could not execute arguments for [%4.4s] (%s)",
309                                 acpi_ut_get_node_name(node),
310                                 acpi_ut_get_type_name(type)));
311         }
312
313         /*
314          * Print a dot for each object unless we are going to print the entire
315          * pathname
316          */
317         if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
318                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
319         }
320
321         /*
322          * We ignore errors from above, and always return OK, since we don't want
323          * to abort the walk on any single error.
324          */
325         acpi_ex_exit_interpreter();
326         return (AE_OK);
327 }
328
329 /*******************************************************************************
330  *
331  * FUNCTION:    acpi_ns_find_ini_methods
332  *
333  * PARAMETERS:  acpi_walk_callback
334  *
335  * RETURN:      acpi_status
336  *
337  * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
338  *              device/processor/thermal objects, and marks the entire subtree
339  *              with a SUBTREE_HAS_INI flag. This flag is used during the
340  *              subsequent device initialization walk to avoid entire subtrees
341  *              that do not contain an _INI.
342  *
343  ******************************************************************************/
344
345 static acpi_status
346 acpi_ns_find_ini_methods(acpi_handle obj_handle,
347                          u32 nesting_level, void *context, void **return_value)
348 {
349         struct acpi_device_walk_info *info =
350             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
351         struct acpi_namespace_node *node;
352         struct acpi_namespace_node *parent_node;
353
354         /* Keep count of device/processor/thermal objects */
355
356         node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
357         if ((node->type == ACPI_TYPE_DEVICE) ||
358             (node->type == ACPI_TYPE_PROCESSOR) ||
359             (node->type == ACPI_TYPE_THERMAL)) {
360                 info->device_count++;
361                 return (AE_OK);
362         }
363
364         /* We are only looking for methods named _INI */
365
366         if (!ACPI_COMPARE_NAME(node->name.ascii, METHOD_NAME__INI)) {
367                 return (AE_OK);
368         }
369
370         /*
371          * The only _INI methods that we care about are those that are
372          * present under Device, Processor, and Thermal objects.
373          */
374         parent_node = acpi_ns_get_parent_node(node);
375         switch (parent_node->type) {
376         case ACPI_TYPE_DEVICE:
377         case ACPI_TYPE_PROCESSOR:
378         case ACPI_TYPE_THERMAL:
379
380                 /* Mark parent and bubble up the INI present flag to the root */
381
382                 while (parent_node) {
383                         parent_node->flags |= ANOBJ_SUBTREE_HAS_INI;
384                         parent_node = acpi_ns_get_parent_node(parent_node);
385                 }
386                 break;
387
388         default:
389                 break;
390         }
391
392         return (AE_OK);
393 }
394
395 /*******************************************************************************
396  *
397  * FUNCTION:    acpi_ns_init_one_device
398  *
399  * PARAMETERS:  acpi_walk_callback
400  *
401  * RETURN:      acpi_status
402  *
403  * DESCRIPTION: This is called once per device soon after ACPI is enabled
404  *              to initialize each device. It determines if the device is
405  *              present, and if so, calls _INI.
406  *
407  ******************************************************************************/
408
409 static acpi_status
410 acpi_ns_init_one_device(acpi_handle obj_handle,
411                         u32 nesting_level, void *context, void **return_value)
412 {
413         struct acpi_device_walk_info *walk_info =
414             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
415         struct acpi_evaluate_info *info = walk_info->evaluate_info;
416         u32 flags;
417         acpi_status status;
418         struct acpi_namespace_node *device_node;
419
420         ACPI_FUNCTION_TRACE(ns_init_one_device);
421
422         /* We are interested in Devices, Processors and thermal_zones only */
423
424         device_node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
425         if ((device_node->type != ACPI_TYPE_DEVICE) &&
426             (device_node->type != ACPI_TYPE_PROCESSOR) &&
427             (device_node->type != ACPI_TYPE_THERMAL)) {
428                 return_ACPI_STATUS(AE_OK);
429         }
430
431         /*
432          * Because of an earlier namespace analysis, all subtrees that contain an
433          * _INI method are tagged.
434          *
435          * If this device subtree does not contain any _INI methods, we
436          * can exit now and stop traversing this entire subtree.
437          */
438         if (!(device_node->flags & ANOBJ_SUBTREE_HAS_INI)) {
439                 return_ACPI_STATUS(AE_CTRL_DEPTH);
440         }
441
442         /*
443          * Run _STA to determine if this device is present and functioning. We
444          * must know this information for two important reasons (from ACPI spec):
445          *
446          * 1) We can only run _INI if the device is present.
447          * 2) We must abort the device tree walk on this subtree if the device is
448          *    not present and is not functional (we will not examine the children)
449          *
450          * The _STA method is not required to be present under the device, we
451          * assume the device is present if _STA does not exist.
452          */
453         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
454                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__STA));
455
456         status = acpi_ut_execute_STA(device_node, &flags);
457         if (ACPI_FAILURE(status)) {
458
459                 /* Ignore error and move on to next device */
460
461                 return_ACPI_STATUS(AE_OK);
462         }
463
464         /*
465          * Flags == -1 means that _STA was not found. In this case, we assume that
466          * the device is both present and functional.
467          *
468          * From the ACPI spec, description of _STA:
469          *
470          * "If a device object (including the processor object) does not have an
471          * _STA object, then OSPM assumes that all of the above bits are set (in
472          * other words, the device is present, ..., and functioning)"
473          */
474         if (flags != ACPI_UINT32_MAX) {
475                 walk_info->num_STA++;
476         }
477
478         /*
479          * Examine the PRESENT and FUNCTIONING status bits
480          *
481          * Note: ACPI spec does not seem to specify behavior for the present but
482          * not functioning case, so we assume functioning if present.
483          */
484         if (!(flags & ACPI_STA_DEVICE_PRESENT)) {
485
486                 /* Device is not present, we must examine the Functioning bit */
487
488                 if (flags & ACPI_STA_DEVICE_FUNCTIONING) {
489                         /*
490                          * Device is not present but is "functioning". In this case,
491                          * we will not run _INI, but we continue to examine the children
492                          * of this device.
493                          *
494                          * From the ACPI spec, description of _STA: (Note - no mention
495                          * of whether to run _INI or not on the device in question)
496                          *
497                          * "_STA may return bit 0 clear (not present) with bit 3 set
498                          * (device is functional). This case is used to indicate a valid
499                          * device for which no device driver should be loaded (for example,
500                          * a bridge device.) Children of this device may be present and
501                          * valid. OSPM should continue enumeration below a device whose
502                          * _STA returns this bit combination"
503                          */
504                         return_ACPI_STATUS(AE_OK);
505                 } else {
506                         /*
507                          * Device is not present and is not functioning. We must abort the
508                          * walk of this subtree immediately -- don't look at the children
509                          * of such a device.
510                          *
511                          * From the ACPI spec, description of _INI:
512                          *
513                          * "If the _STA method indicates that the device is not present,
514                          * OSPM will not run the _INI and will not examine the children
515                          * of the device for _INI methods"
516                          */
517                         return_ACPI_STATUS(AE_CTRL_DEPTH);
518                 }
519         }
520
521         /*
522          * The device is present or is assumed present if no _STA exists.
523          * Run the _INI if it exists (not required to exist)
524          *
525          * Note: We know there is an _INI within this subtree, but it may not be
526          * under this particular device, it may be lower in the branch.
527          */
528         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
529                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__INI));
530
531         info->prefix_node = device_node;
532         info->pathname = METHOD_NAME__INI;
533         info->parameters = NULL;
534         info->parameter_type = ACPI_PARAM_ARGS;
535         info->flags = ACPI_IGNORE_RETURN_VALUE;
536
537         status = acpi_ns_evaluate(info);
538         if (ACPI_SUCCESS(status)) {
539                 walk_info->num_INI++;
540
541                 if ((acpi_dbg_level <= ACPI_LV_ALL_EXCEPTIONS) &&
542                     (!(acpi_dbg_level & ACPI_LV_INFO))) {
543                         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
544                 }
545         }
546 #ifdef ACPI_DEBUG_OUTPUT
547         else if (status != AE_NOT_FOUND) {
548
549                 /* Ignore error and move on to next device */
550
551                 char *scope_name =
552                     acpi_ns_get_external_pathname(info->resolved_node);
553
554                 ACPI_EXCEPTION((AE_INFO, status, "during %s._INI execution",
555                                 scope_name));
556                 ACPI_FREE(scope_name);
557         }
558 #endif
559
560         /* Ignore errors from above */
561
562         status = AE_OK;
563
564         /*
565          * The _INI method has been run if present; call the Global Initialization
566          * Handler for this device.
567          */
568         if (acpi_gbl_init_handler) {
569                 status =
570                     acpi_gbl_init_handler(device_node, ACPI_INIT_DEVICE_INI);
571         }
572
573         return_ACPI_STATUS(status);
574 }