1 /******************************************************************************
3 * Module Name: nsinit - namespace initialization
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2010, 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>
49 #include <linux/nmi.h>
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME("nsinit")
54 /* Local prototypes */
56 acpi_ns_init_one_object(acpi_handle obj_handle
,
57 u32 level
, void *context
, void **return_value
);
60 acpi_ns_init_one_device(acpi_handle obj_handle
,
61 u32 nesting_level
, void *context
, void **return_value
);
64 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
65 u32 nesting_level
, void *context
, void **return_value
);
67 /*******************************************************************************
69 * FUNCTION: acpi_ns_initialize_objects
75 * DESCRIPTION: Walk the entire namespace and perform any necessary
76 * initialization on the objects found therein
78 ******************************************************************************/
80 acpi_status
acpi_ns_initialize_objects(void)
83 struct acpi_init_walk_info info
;
85 ACPI_FUNCTION_TRACE(ns_initialize_objects
);
87 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
88 "**** Starting initialization of namespace objects ****\n"));
89 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
90 "Completing Region/Field/Buffer/Package initialization:"));
92 /* Set all init info to zero */
94 ACPI_MEMSET(&info
, 0, sizeof(struct acpi_init_walk_info
));
96 /* Walk entire namespace from the supplied root */
98 status
= acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
99 ACPI_UINT32_MAX
, acpi_ns_init_one_object
, NULL
,
101 if (ACPI_FAILURE(status
)) {
102 ACPI_EXCEPTION((AE_INFO
, status
, "During WalkNamespace"));
105 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
106 "\nInitialized %hd/%hd Regions %hd/%hd Fields %hd/%hd "
107 "Buffers %hd/%hd Packages (%hd nodes)\n",
108 info
.op_region_init
, info
.op_region_count
,
109 info
.field_init
, info
.field_count
,
110 info
.buffer_init
, info
.buffer_count
,
111 info
.package_init
, info
.package_count
,
114 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
115 "%hd Control Methods found\n", info
.method_count
));
116 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
117 "%hd Op Regions found\n", info
.op_region_count
));
119 return_ACPI_STATUS(AE_OK
);
122 /*******************************************************************************
124 * FUNCTION: acpi_ns_initialize_devices
128 * RETURN: acpi_status
130 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
131 * This means running _INI on all present devices.
133 * Note: We install PCI config space handler on region access,
136 ******************************************************************************/
138 acpi_status
acpi_ns_initialize_devices(void)
141 struct acpi_device_walk_info info
;
143 ACPI_FUNCTION_TRACE(ns_initialize_devices
);
147 info
.device_count
= 0;
151 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
152 "Initializing Device/Processor/Thermal objects "
153 "by executing _INI methods:"));
155 /* Tree analysis: find all subtrees that contain _INI methods */
157 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
158 ACPI_UINT32_MAX
, FALSE
,
159 acpi_ns_find_ini_methods
, NULL
, &info
,
161 if (ACPI_FAILURE(status
)) {
165 /* Allocate the evaluation information block */
168 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
169 if (!info
.evaluate_info
) {
170 status
= AE_NO_MEMORY
;
175 * Execute the "global" _INI method that may appear at the root. This
176 * support is provided for Windows compatibility (Vista+) and is not
177 * part of the ACPI specification.
179 info
.evaluate_info
->prefix_node
= acpi_gbl_root_node
;
180 info
.evaluate_info
->pathname
= METHOD_NAME__INI
;
181 info
.evaluate_info
->parameters
= NULL
;
182 info
.evaluate_info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
184 status
= acpi_ns_evaluate(info
.evaluate_info
);
185 if (ACPI_SUCCESS(status
)) {
189 /* Walk namespace to execute all _INIs on present devices */
191 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
192 ACPI_UINT32_MAX
, FALSE
,
193 acpi_ns_init_one_device
, NULL
, &info
,
196 ACPI_FREE(info
.evaluate_info
);
197 if (ACPI_FAILURE(status
)) {
201 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
202 "\nExecuted %hd _INI methods requiring %hd _STA executions "
203 "(examined %hd objects)\n",
204 info
.num_INI
, info
.num_STA
, info
.device_count
));
206 return_ACPI_STATUS(status
);
209 ACPI_EXCEPTION((AE_INFO
, status
, "During device initialization"));
210 return_ACPI_STATUS(status
);
213 /*******************************************************************************
215 * FUNCTION: acpi_ns_init_one_object
217 * PARAMETERS: obj_handle - Node
218 * Level - Current nesting level
219 * Context - Points to a init info struct
220 * return_value - Not used
224 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
225 * within the namespace.
227 * Currently, the only objects that require initialization are:
231 ******************************************************************************/
234 acpi_ns_init_one_object(acpi_handle obj_handle
,
235 u32 level
, void *context
, void **return_value
)
237 acpi_object_type type
;
238 acpi_status status
= AE_OK
;
239 struct acpi_init_walk_info
*info
=
240 (struct acpi_init_walk_info
*)context
;
241 struct acpi_namespace_node
*node
=
242 (struct acpi_namespace_node
*)obj_handle
;
243 union acpi_operand_object
*obj_desc
;
245 ACPI_FUNCTION_NAME(ns_init_one_object
);
247 info
->object_count
++;
249 /* And even then, we are only interested in a few object types */
251 type
= acpi_ns_get_type(obj_handle
);
252 obj_desc
= acpi_ns_get_attached_object(node
);
257 /* Increment counters for object types we are looking for */
260 case ACPI_TYPE_REGION
:
261 info
->op_region_count
++;
264 case ACPI_TYPE_BUFFER_FIELD
:
268 case ACPI_TYPE_LOCAL_BANK_FIELD
:
272 case ACPI_TYPE_BUFFER
:
273 info
->buffer_count
++;
276 case ACPI_TYPE_PACKAGE
:
277 info
->package_count
++;
282 /* No init required, just exit now */
286 /* If the object is already initialized, nothing else to do */
288 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
292 /* Must lock the interpreter before executing AML code */
294 acpi_ex_enter_interpreter();
297 * Each of these types can contain executable AML code within the
301 case ACPI_TYPE_REGION
:
303 info
->op_region_init
++;
304 status
= acpi_ds_get_region_arguments(obj_desc
);
307 case ACPI_TYPE_BUFFER_FIELD
:
310 status
= acpi_ds_get_buffer_field_arguments(obj_desc
);
313 case ACPI_TYPE_LOCAL_BANK_FIELD
:
316 status
= acpi_ds_get_bank_field_arguments(obj_desc
);
319 case ACPI_TYPE_BUFFER
:
322 status
= acpi_ds_get_buffer_arguments(obj_desc
);
325 case ACPI_TYPE_PACKAGE
:
327 info
->package_init
++;
328 status
= acpi_ds_get_package_arguments(obj_desc
);
332 /* No other types can get here */
336 if (ACPI_FAILURE(status
)) {
337 ACPI_EXCEPTION((AE_INFO
, status
,
338 "Could not execute arguments for [%4.4s] (%s)",
339 acpi_ut_get_node_name(node
),
340 acpi_ut_get_type_name(type
)));
344 * Print a dot for each object unless we are going to print the entire
347 if (!(acpi_dbg_level
& ACPI_LV_INIT_NAMES
)) {
348 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
, "."));
352 * We ignore errors from above, and always return OK, since we don't want
353 * to abort the walk on any single error.
355 acpi_ex_exit_interpreter();
359 /*******************************************************************************
361 * FUNCTION: acpi_ns_find_ini_methods
363 * PARAMETERS: acpi_walk_callback
365 * RETURN: acpi_status
367 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
368 * device/processor/thermal objects, and marks the entire subtree
369 * with a SUBTREE_HAS_INI flag. This flag is used during the
370 * subsequent device initialization walk to avoid entire subtrees
371 * that do not contain an _INI.
373 ******************************************************************************/
376 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
377 u32 nesting_level
, void *context
, void **return_value
)
379 struct acpi_device_walk_info
*info
=
380 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
381 struct acpi_namespace_node
*node
;
382 struct acpi_namespace_node
*parent_node
;
384 /* Keep count of device/processor/thermal objects */
386 node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
387 if ((node
->type
== ACPI_TYPE_DEVICE
) ||
388 (node
->type
== ACPI_TYPE_PROCESSOR
) ||
389 (node
->type
== ACPI_TYPE_THERMAL
)) {
390 info
->device_count
++;
394 /* We are only looking for methods named _INI */
396 if (!ACPI_COMPARE_NAME(node
->name
.ascii
, METHOD_NAME__INI
)) {
401 * The only _INI methods that we care about are those that are
402 * present under Device, Processor, and Thermal objects.
404 parent_node
= acpi_ns_get_parent_node(node
);
405 switch (parent_node
->type
) {
406 case ACPI_TYPE_DEVICE
:
407 case ACPI_TYPE_PROCESSOR
:
408 case ACPI_TYPE_THERMAL
:
410 /* Mark parent and bubble up the INI present flag to the root */
412 while (parent_node
) {
413 parent_node
->flags
|= ANOBJ_SUBTREE_HAS_INI
;
414 parent_node
= acpi_ns_get_parent_node(parent_node
);
425 /*******************************************************************************
427 * FUNCTION: acpi_ns_init_one_device
429 * PARAMETERS: acpi_walk_callback
431 * RETURN: acpi_status
433 * DESCRIPTION: This is called once per device soon after ACPI is enabled
434 * to initialize each device. It determines if the device is
435 * present, and if so, calls _INI.
437 ******************************************************************************/
440 acpi_ns_init_one_device(acpi_handle obj_handle
,
441 u32 nesting_level
, void *context
, void **return_value
)
443 struct acpi_device_walk_info
*walk_info
=
444 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
445 struct acpi_evaluate_info
*info
= walk_info
->evaluate_info
;
448 struct acpi_namespace_node
*device_node
;
450 ACPI_FUNCTION_TRACE(ns_init_one_device
);
452 /* We are interested in Devices, Processors and thermal_zones only */
454 device_node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
455 if ((device_node
->type
!= ACPI_TYPE_DEVICE
) &&
456 (device_node
->type
!= ACPI_TYPE_PROCESSOR
) &&
457 (device_node
->type
!= ACPI_TYPE_THERMAL
)) {
458 return_ACPI_STATUS(AE_OK
);
462 * Because of an earlier namespace analysis, all subtrees that contain an
463 * _INI method are tagged.
465 * If this device subtree does not contain any _INI methods, we
466 * can exit now and stop traversing this entire subtree.
468 if (!(device_node
->flags
& ANOBJ_SUBTREE_HAS_INI
)) {
469 return_ACPI_STATUS(AE_CTRL_DEPTH
);
473 * Run _STA to determine if this device is present and functioning. We
474 * must know this information for two important reasons (from ACPI spec):
476 * 1) We can only run _INI if the device is present.
477 * 2) We must abort the device tree walk on this subtree if the device is
478 * not present and is not functional (we will not examine the children)
480 * The _STA method is not required to be present under the device, we
481 * assume the device is present if _STA does not exist.
483 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
484 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__STA
));
486 status
= acpi_ut_execute_STA(device_node
, &flags
);
487 if (ACPI_FAILURE(status
)) {
489 /* Ignore error and move on to next device */
491 return_ACPI_STATUS(AE_OK
);
495 * Flags == -1 means that _STA was not found. In this case, we assume that
496 * the device is both present and functional.
498 * From the ACPI spec, description of _STA:
500 * "If a device object (including the processor object) does not have an
501 * _STA object, then OSPM assumes that all of the above bits are set (in
502 * other words, the device is present, ..., and functioning)"
504 if (flags
!= ACPI_UINT32_MAX
) {
505 walk_info
->num_STA
++;
509 * Examine the PRESENT and FUNCTIONING status bits
511 * Note: ACPI spec does not seem to specify behavior for the present but
512 * not functioning case, so we assume functioning if present.
514 if (!(flags
& ACPI_STA_DEVICE_PRESENT
)) {
516 /* Device is not present, we must examine the Functioning bit */
518 if (flags
& ACPI_STA_DEVICE_FUNCTIONING
) {
520 * Device is not present but is "functioning". In this case,
521 * we will not run _INI, but we continue to examine the children
524 * From the ACPI spec, description of _STA: (Note - no mention
525 * of whether to run _INI or not on the device in question)
527 * "_STA may return bit 0 clear (not present) with bit 3 set
528 * (device is functional). This case is used to indicate a valid
529 * device for which no device driver should be loaded (for example,
530 * a bridge device.) Children of this device may be present and
531 * valid. OSPM should continue enumeration below a device whose
532 * _STA returns this bit combination"
534 return_ACPI_STATUS(AE_OK
);
537 * Device is not present and is not functioning. We must abort the
538 * walk of this subtree immediately -- don't look at the children
541 * From the ACPI spec, description of _INI:
543 * "If the _STA method indicates that the device is not present,
544 * OSPM will not run the _INI and will not examine the children
545 * of the device for _INI methods"
547 return_ACPI_STATUS(AE_CTRL_DEPTH
);
552 * The device is present or is assumed present if no _STA exists.
553 * Run the _INI if it exists (not required to exist)
555 * Note: We know there is an _INI within this subtree, but it may not be
556 * under this particular device, it may be lower in the branch.
558 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
559 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__INI
));
561 info
->prefix_node
= device_node
;
562 info
->pathname
= METHOD_NAME__INI
;
563 info
->parameters
= NULL
;
564 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
567 * Some hardware relies on this being executed as atomically
568 * as possible (without an NMI being received in the middle of
569 * this) - so disable NMIs and initialize the device:
572 status
= acpi_ns_evaluate(info
);
575 if (ACPI_SUCCESS(status
)) {
576 walk_info
->num_INI
++;
578 if ((acpi_dbg_level
<= ACPI_LV_ALL_EXCEPTIONS
) &&
579 (!(acpi_dbg_level
& ACPI_LV_INFO
))) {
580 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
, "."));
583 #ifdef ACPI_DEBUG_OUTPUT
584 else if (status
!= AE_NOT_FOUND
) {
586 /* Ignore error and move on to next device */
589 acpi_ns_get_external_pathname(info
->resolved_node
);
591 ACPI_EXCEPTION((AE_INFO
, status
, "during %s._INI execution",
593 ACPI_FREE(scope_name
);
597 /* Ignore errors from above */
602 * The _INI method has been run if present; call the Global Initialization
603 * Handler for this device.
605 if (acpi_gbl_init_handler
) {
607 acpi_gbl_init_handler(device_node
, ACPI_INIT_DEVICE_INI
);
610 return_ACPI_STATUS(status
);