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