ACPI: ACPICA 20060421
[linux-drm-fsl-dcu.git] / drivers / acpi / namespace / nsinit.c
1 /******************************************************************************
2  *
3  * Module Name: nsinit - namespace initialization
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/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                 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace"));
158         }
159
160         /* Walk namespace to execute all _INIs on present devices */
161
162         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
163                                         ACPI_UINT32_MAX, FALSE,
164                                         acpi_ns_init_one_device, &info, NULL);
165         if (ACPI_FAILURE(status)) {
166                 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace"));
167         }
168
169         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
170                               "\nExecuted %hd _INI methods requiring %hd _STA executions (examined %hd objects)\n",
171                               info.num_INI, info.num_STA, info.device_count));
172
173         return_ACPI_STATUS(status);
174 }
175
176 /*******************************************************************************
177  *
178  * FUNCTION:    acpi_ns_init_one_object
179  *
180  * PARAMETERS:  obj_handle      - Node
181  *              Level           - Current nesting level
182  *              Context         - Points to a init info struct
183  *              return_value    - Not used
184  *
185  * RETURN:      Status
186  *
187  * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
188  *              within the  namespace.
189  *
190  *              Currently, the only objects that require initialization are:
191  *              1) Methods
192  *              2) Op Regions
193  *
194  ******************************************************************************/
195
196 static acpi_status
197 acpi_ns_init_one_object(acpi_handle obj_handle,
198                         u32 level, void *context, void **return_value)
199 {
200         acpi_object_type type;
201         acpi_status status;
202         struct acpi_init_walk_info *info =
203             (struct acpi_init_walk_info *)context;
204         struct acpi_namespace_node *node =
205             (struct acpi_namespace_node *)obj_handle;
206         union acpi_operand_object *obj_desc;
207
208         ACPI_FUNCTION_NAME(ns_init_one_object);
209
210         info->object_count++;
211
212         /* And even then, we are only interested in a few object types */
213
214         type = acpi_ns_get_type(obj_handle);
215         obj_desc = acpi_ns_get_attached_object(node);
216         if (!obj_desc) {
217                 return (AE_OK);
218         }
219
220         /* Increment counters for object types we are looking for */
221
222         switch (type) {
223         case ACPI_TYPE_REGION:
224                 info->op_region_count++;
225                 break;
226
227         case ACPI_TYPE_BUFFER_FIELD:
228                 info->field_count++;
229                 break;
230
231         case ACPI_TYPE_BUFFER:
232                 info->buffer_count++;
233                 break;
234
235         case ACPI_TYPE_PACKAGE:
236                 info->package_count++;
237                 break;
238
239         default:
240
241                 /* No init required, just exit now */
242                 return (AE_OK);
243         }
244
245         /*
246          * If the object is already initialized, nothing else to do
247          */
248         if (obj_desc->common.flags & AOPOBJ_DATA_VALID) {
249                 return (AE_OK);
250         }
251
252         /*
253          * Must lock the interpreter before executing AML code
254          */
255         status = acpi_ex_enter_interpreter();
256         if (ACPI_FAILURE(status)) {
257                 return (status);
258         }
259
260         /*
261          * Each of these types can contain executable AML code within the
262          * declaration.
263          */
264         switch (type) {
265         case ACPI_TYPE_REGION:
266
267                 info->op_region_init++;
268                 status = acpi_ds_get_region_arguments(obj_desc);
269                 break;
270
271         case ACPI_TYPE_BUFFER_FIELD:
272
273                 info->field_init++;
274                 status = acpi_ds_get_buffer_field_arguments(obj_desc);
275                 break;
276
277         case ACPI_TYPE_BUFFER:
278
279                 info->buffer_init++;
280                 status = acpi_ds_get_buffer_arguments(obj_desc);
281                 break;
282
283         case ACPI_TYPE_PACKAGE:
284
285                 info->package_init++;
286                 status = acpi_ds_get_package_arguments(obj_desc);
287                 break;
288
289         default:
290                 /* No other types can get here */
291                 break;
292         }
293
294         if (ACPI_FAILURE(status)) {
295                 ACPI_EXCEPTION((AE_INFO, status,
296                                 "Could not execute arguments for [%4.4s] (%s)",
297                                 acpi_ut_get_node_name(node),
298                                 acpi_ut_get_type_name(type)));
299         }
300
301         /*
302          * Print a dot for each object unless we are going to print the entire
303          * pathname
304          */
305         if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
306                 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
307         }
308
309         /*
310          * We ignore errors from above, and always return OK, since we don't want
311          * to abort the walk on any single error.
312          */
313         acpi_ex_exit_interpreter();
314         return (AE_OK);
315 }
316
317 /*******************************************************************************
318  *
319  * FUNCTION:    acpi_ns_find_ini_methods
320  *
321  * PARAMETERS:  acpi_walk_callback
322  *
323  * RETURN:      acpi_status
324  *
325  * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
326  *              device/processor/thermal objects, and marks the entire subtree
327  *              with a SUBTREE_HAS_INI flag. This flag is used during the
328  *              subsequent device initialization walk to avoid entire subtrees
329  *              that do not contain an _INI.
330  *
331  ******************************************************************************/
332
333 static acpi_status
334 acpi_ns_find_ini_methods(acpi_handle obj_handle,
335                          u32 nesting_level, void *context, void **return_value)
336 {
337         struct acpi_device_walk_info *info =
338             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
339         struct acpi_namespace_node *node;
340         struct acpi_namespace_node *parent_node;
341
342         /* Keep count of device/processor/thermal objects */
343
344         node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
345         if ((node->type == ACPI_TYPE_DEVICE) ||
346             (node->type == ACPI_TYPE_PROCESSOR) ||
347             (node->type == ACPI_TYPE_THERMAL)) {
348                 info->device_count++;
349                 return (AE_OK);
350         }
351
352         /* We are only looking for methods named _INI */
353
354         if (!ACPI_COMPARE_NAME(node->name.ascii, METHOD_NAME__INI)) {
355                 return (AE_OK);
356         }
357
358         /*
359          * The only _INI methods that we care about are those that are
360          * present under Device, Processor, and Thermal objects.
361          */
362         parent_node = acpi_ns_get_parent_node(node);
363         switch (parent_node->type) {
364         case ACPI_TYPE_DEVICE:
365         case ACPI_TYPE_PROCESSOR:
366         case ACPI_TYPE_THERMAL:
367
368                 /* Mark parent and bubble up the INI present flag to the root */
369
370                 while (parent_node) {
371                         parent_node->flags |= ANOBJ_SUBTREE_HAS_INI;
372                         parent_node = acpi_ns_get_parent_node(parent_node);
373                 }
374                 break;
375
376         default:
377                 break;
378         }
379
380         return (AE_OK);
381 }
382
383 /*******************************************************************************
384  *
385  * FUNCTION:    acpi_ns_init_one_device
386  *
387  * PARAMETERS:  acpi_walk_callback
388  *
389  * RETURN:      acpi_status
390  *
391  * DESCRIPTION: This is called once per device soon after ACPI is enabled
392  *              to initialize each device. It determines if the device is
393  *              present, and if so, calls _INI.
394  *
395  ******************************************************************************/
396
397 static acpi_status
398 acpi_ns_init_one_device(acpi_handle obj_handle,
399                         u32 nesting_level, void *context, void **return_value)
400 {
401         struct acpi_device_walk_info *info =
402             ACPI_CAST_PTR(struct acpi_device_walk_info, context);
403         struct acpi_parameter_info pinfo;
404         u32 flags;
405         acpi_status status;
406         struct acpi_namespace_node *device_node;
407
408         ACPI_FUNCTION_TRACE(ns_init_one_device);
409
410         /* We are interested in Devices, Processors and thermal_zones only */
411
412         device_node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
413         if ((device_node->type != ACPI_TYPE_DEVICE) &&
414             (device_node->type != ACPI_TYPE_PROCESSOR) &&
415             (device_node->type != ACPI_TYPE_THERMAL)) {
416                 return_ACPI_STATUS(AE_OK);
417         }
418
419         /*
420          * Because of an earlier namespace analysis, all subtrees that contain an
421          * _INI method are tagged.
422          *
423          * If this device subtree does not contain any _INI methods, we
424          * can exit now and stop traversing this entire subtree.
425          */
426         if (!(device_node->flags & ANOBJ_SUBTREE_HAS_INI)) {
427                 return_ACPI_STATUS(AE_CTRL_DEPTH);
428         }
429
430         /*
431          * Run _STA to determine if this device is present and functioning. We
432          * must know this information for two important reasons (from ACPI spec):
433          *
434          * 1) We can only run _INI if the device is present.
435          * 2) We must abort the device tree walk on this subtree if the device is
436          *    not present and is not functional (we will not examine the children)
437          *
438          * The _STA method is not required to be present under the device, we
439          * assume the device is present if _STA does not exist.
440          */
441         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
442                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__STA));
443
444         status = acpi_ut_execute_STA(device_node, &flags);
445         if (ACPI_FAILURE(status)) {
446
447                 /* Ignore error and move on to next device */
448
449                 return_ACPI_STATUS(AE_OK);
450         }
451
452         /*
453          * Flags == -1 means that _STA was not found. In this case, we assume that
454          * the device is both present and functional.
455          *
456          * From the ACPI spec, description of _STA:
457          *
458          * "If a device object (including the processor object) does not have an
459          * _STA object, then OSPM assumes that all of the above bits are set (in
460          * other words, the device is present, ..., and functioning)"
461          */
462         if (flags != ACPI_UINT32_MAX) {
463                 info->num_STA++;
464         }
465
466         /*
467          * Examine the PRESENT and FUNCTIONING status bits
468          *
469          * Note: ACPI spec does not seem to specify behavior for the present but
470          * not functioning case, so we assume functioning if present.
471          */
472         if (!(flags & ACPI_STA_DEVICE_PRESENT)) {
473
474                 /* Device is not present, we must examine the Functioning bit */
475
476                 if (flags & ACPI_STA_DEVICE_FUNCTIONING) {
477                         /*
478                          * Device is not present but is "functioning". In this case,
479                          * we will not run _INI, but we continue to examine the children
480                          * of this device.
481                          *
482                          * From the ACPI spec, description of _STA: (Note - no mention
483                          * of whether to run _INI or not on the device in question)
484                          *
485                          * "_STA may return bit 0 clear (not present) with bit 3 set
486                          * (device is functional). This case is used to indicate a valid
487                          * device for which no device driver should be loaded (for example,
488                          * a bridge device.) Children of this device may be present and
489                          * valid. OSPM should continue enumeration below a device whose
490                          * _STA returns this bit combination"
491                          */
492                         return_ACPI_STATUS(AE_OK);
493                 } else {
494                         /*
495                          * Device is not present and is not functioning. We must abort the
496                          * walk of this subtree immediately -- don't look at the children
497                          * of such a device.
498                          *
499                          * From the ACPI spec, description of _INI:
500                          *
501                          * "If the _STA method indicates that the device is not present,
502                          * OSPM will not run the _INI and will not examine the children
503                          * of the device for _INI methods"
504                          */
505                         return_ACPI_STATUS(AE_CTRL_DEPTH);
506                 }
507         }
508
509         /*
510          * The device is present or is assumed present if no _STA exists.
511          * Run the _INI if it exists (not required to exist)
512          *
513          * Note: We know there is an _INI within this subtree, but it may not be
514          * under this particular device, it may be lower in the branch.
515          */
516         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
517                         (ACPI_TYPE_METHOD, device_node, METHOD_NAME__INI));
518
519         pinfo.node = device_node;
520         pinfo.parameters = NULL;
521         pinfo.parameter_type = ACPI_PARAM_ARGS;
522
523         status = acpi_ns_evaluate_relative(METHOD_NAME__INI, &pinfo);
524         if (ACPI_SUCCESS(status)) {
525
526                 /* Delete any return object (especially if implicit_return is enabled) */
527
528                 if (pinfo.return_object) {
529                         acpi_ut_remove_reference(pinfo.return_object);
530                 }
531
532                 info->num_INI++;
533                 if ((acpi_dbg_level <= ACPI_LV_ALL_EXCEPTIONS) &&
534                     (!(acpi_dbg_level & ACPI_LV_INFO))) {
535                         ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, "."));
536                 }
537         }
538 #ifdef ACPI_DEBUG_OUTPUT
539         else if (status != AE_NOT_FOUND) {
540
541                 /* Ignore error and move on to next device */
542
543                 char *scope_name = acpi_ns_get_external_pathname(pinfo.node);
544
545                 ACPI_EXCEPTION((AE_INFO, status, "during %s._INI execution",
546                                 scope_name));
547                 ACPI_FREE(scope_name);
548         }
549 #endif
550
551         /* If an external initialization handler is present, call it */
552
553         if (acpi_gbl_init_handler) {
554                 status =
555                     acpi_gbl_init_handler(pinfo.node, ACPI_INIT_DEVICE_INI);
556         }
557
558         return_ACPI_STATUS(AE_OK);
559 }