1 /******************************************************************************
3 * Module Name: nsinit - namespace initialization
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
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>
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME("nsinit")
53 /* Local prototypes */
55 acpi_ns_init_one_object(acpi_handle obj_handle
,
56 u32 level
, void *context
, void **return_value
);
59 acpi_ns_init_one_device(acpi_handle obj_handle
,
60 u32 nesting_level
, void *context
, void **return_value
);
63 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
64 u32 nesting_level
, void *context
, void **return_value
);
66 /*******************************************************************************
68 * FUNCTION: acpi_ns_initialize_objects
74 * DESCRIPTION: Walk the entire namespace and perform any necessary
75 * initialization on the objects found therein
77 ******************************************************************************/
79 acpi_status
acpi_ns_initialize_objects(void)
82 struct acpi_init_walk_info info
;
84 ACPI_FUNCTION_TRACE(ns_initialize_objects
);
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:"));
91 /* Set all init info to zero */
93 ACPI_MEMSET(&info
, 0, sizeof(struct acpi_init_walk_info
));
95 /* Walk entire namespace from the supplied root */
97 status
= acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
98 ACPI_UINT32_MAX
, acpi_ns_init_one_object
,
100 if (ACPI_FAILURE(status
)) {
101 ACPI_EXCEPTION((AE_INFO
, status
, "During WalkNamespace"));
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
,
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
));
117 return_ACPI_STATUS(AE_OK
);
120 /*******************************************************************************
122 * FUNCTION: acpi_ns_initialize_devices
126 * RETURN: acpi_status
128 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
129 * This means running _INI on all present devices.
131 * Note: We install PCI config space handler on region access,
134 ******************************************************************************/
136 acpi_status
acpi_ns_initialize_devices(void)
139 struct acpi_device_walk_info info
;
141 ACPI_FUNCTION_TRACE(ns_initialize_devices
);
145 info
.device_count
= 0;
149 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
150 "Initializing Device/Processor/Thermal objects by executing _INI methods:"));
152 /* Tree analysis: find all subtrees that contain _INI methods */
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
)) {
161 /* Allocate the evaluation information block */
164 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
165 if (!info
.evaluate_info
) {
166 status
= AE_NO_MEMORY
;
170 /* Walk namespace to execute all _INIs on present devices */
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
);
176 ACPI_FREE(info
.evaluate_info
);
177 if (ACPI_FAILURE(status
)) {
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
));
185 return_ACPI_STATUS(status
);
188 ACPI_EXCEPTION((AE_INFO
, status
, "During device initialization"));
189 return_ACPI_STATUS(status
);
192 /*******************************************************************************
194 * FUNCTION: acpi_ns_init_one_object
196 * PARAMETERS: obj_handle - Node
197 * Level - Current nesting level
198 * Context - Points to a init info struct
199 * return_value - Not used
203 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
204 * within the namespace.
206 * Currently, the only objects that require initialization are:
210 ******************************************************************************/
213 acpi_ns_init_one_object(acpi_handle obj_handle
,
214 u32 level
, void *context
, void **return_value
)
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
;
224 ACPI_FUNCTION_NAME(ns_init_one_object
);
226 info
->object_count
++;
228 /* And even then, we are only interested in a few object types */
230 type
= acpi_ns_get_type(obj_handle
);
231 obj_desc
= acpi_ns_get_attached_object(node
);
236 /* Increment counters for object types we are looking for */
239 case ACPI_TYPE_REGION
:
240 info
->op_region_count
++;
243 case ACPI_TYPE_BUFFER_FIELD
:
247 case ACPI_TYPE_LOCAL_BANK_FIELD
:
251 case ACPI_TYPE_BUFFER
:
252 info
->buffer_count
++;
255 case ACPI_TYPE_PACKAGE
:
256 info
->package_count
++;
261 /* No init required, just exit now */
266 * If the object is already initialized, nothing else to do
268 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
273 * Must lock the interpreter before executing AML code
275 acpi_ex_enter_interpreter();
278 * Each of these types can contain executable AML code within the
282 case ACPI_TYPE_REGION
:
284 info
->op_region_init
++;
285 status
= acpi_ds_get_region_arguments(obj_desc
);
288 case ACPI_TYPE_BUFFER_FIELD
:
291 status
= acpi_ds_get_buffer_field_arguments(obj_desc
);
294 case ACPI_TYPE_LOCAL_BANK_FIELD
:
297 status
= acpi_ds_get_bank_field_arguments(obj_desc
);
300 case ACPI_TYPE_BUFFER
:
303 status
= acpi_ds_get_buffer_arguments(obj_desc
);
306 case ACPI_TYPE_PACKAGE
:
308 info
->package_init
++;
309 status
= acpi_ds_get_package_arguments(obj_desc
);
313 /* No other types can get here */
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
)));
325 * Print a dot for each object unless we are going to print the entire
328 if (!(acpi_dbg_level
& ACPI_LV_INIT_NAMES
)) {
329 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
, "."));
333 * We ignore errors from above, and always return OK, since we don't want
334 * to abort the walk on any single error.
336 acpi_ex_exit_interpreter();
340 /*******************************************************************************
342 * FUNCTION: acpi_ns_find_ini_methods
344 * PARAMETERS: acpi_walk_callback
346 * RETURN: acpi_status
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.
354 ******************************************************************************/
357 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
358 u32 nesting_level
, void *context
, void **return_value
)
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
;
365 /* Keep count of device/processor/thermal objects */
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
++;
375 /* We are only looking for methods named _INI */
377 if (!ACPI_COMPARE_NAME(node
->name
.ascii
, METHOD_NAME__INI
)) {
382 * The only _INI methods that we care about are those that are
383 * present under Device, Processor, and Thermal objects.
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
:
391 /* Mark parent and bubble up the INI present flag to the root */
393 while (parent_node
) {
394 parent_node
->flags
|= ANOBJ_SUBTREE_HAS_INI
;
395 parent_node
= acpi_ns_get_parent_node(parent_node
);
406 /*******************************************************************************
408 * FUNCTION: acpi_ns_init_one_device
410 * PARAMETERS: acpi_walk_callback
412 * RETURN: acpi_status
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.
418 ******************************************************************************/
421 acpi_ns_init_one_device(acpi_handle obj_handle
,
422 u32 nesting_level
, void *context
, void **return_value
)
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
;
429 struct acpi_namespace_node
*device_node
;
431 ACPI_FUNCTION_TRACE(ns_init_one_device
);
433 /* We are interested in Devices, Processors and thermal_zones only */
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
);
443 * Because of an earlier namespace analysis, all subtrees that contain an
444 * _INI method are tagged.
446 * If this device subtree does not contain any _INI methods, we
447 * can exit now and stop traversing this entire subtree.
449 if (!(device_node
->flags
& ANOBJ_SUBTREE_HAS_INI
)) {
450 return_ACPI_STATUS(AE_CTRL_DEPTH
);
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):
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)
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.
464 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
465 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__STA
));
467 status
= acpi_ut_execute_STA(device_node
, &flags
);
468 if (ACPI_FAILURE(status
)) {
470 /* Ignore error and move on to next device */
472 return_ACPI_STATUS(AE_OK
);
476 * Flags == -1 means that _STA was not found. In this case, we assume that
477 * the device is both present and functional.
479 * From the ACPI spec, description of _STA:
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)"
485 if (flags
!= ACPI_UINT32_MAX
) {
486 walk_info
->num_STA
++;
490 * Examine the PRESENT and FUNCTIONING status bits
492 * Note: ACPI spec does not seem to specify behavior for the present but
493 * not functioning case, so we assume functioning if present.
495 if (!(flags
& ACPI_STA_DEVICE_PRESENT
)) {
497 /* Device is not present, we must examine the Functioning bit */
499 if (flags
& ACPI_STA_DEVICE_FUNCTIONING
) {
501 * Device is not present but is "functioning". In this case,
502 * we will not run _INI, but we continue to examine the children
505 * From the ACPI spec, description of _STA: (Note - no mention
506 * of whether to run _INI or not on the device in question)
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"
515 return_ACPI_STATUS(AE_OK
);
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
522 * From the ACPI spec, description of _INI:
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"
528 return_ACPI_STATUS(AE_CTRL_DEPTH
);
533 * The device is present or is assumed present if no _STA exists.
534 * Run the _INI if it exists (not required to exist)
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.
539 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
540 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__INI
));
542 info
->prefix_node
= device_node
;
543 info
->pathname
= METHOD_NAME__INI
;
544 info
->parameters
= NULL
;
545 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
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:
553 status
= acpi_ns_evaluate(info
);
556 if (ACPI_SUCCESS(status
)) {
557 walk_info
->num_INI
++;
559 if ((acpi_dbg_level
<= ACPI_LV_ALL_EXCEPTIONS
) &&
560 (!(acpi_dbg_level
& ACPI_LV_INFO
))) {
561 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
, "."));
564 #ifdef ACPI_DEBUG_OUTPUT
565 else if (status
!= AE_NOT_FOUND
) {
567 /* Ignore error and move on to next device */
570 acpi_ns_get_external_pathname(info
->resolved_node
);
572 ACPI_EXCEPTION((AE_INFO
, status
, "during %s._INI execution",
574 ACPI_FREE(scope_name
);
578 /* Ignore errors from above */
583 * The _INI method has been run if present; call the Global Initialization
584 * Handler for this device.
586 if (acpi_gbl_init_handler
) {
588 acpi_gbl_init_handler(device_node
, ACPI_INIT_DEVICE_INI
);
591 return_ACPI_STATUS(status
);