1 /******************************************************************************
3 * Module Name: nsinit - namespace initialization
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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>
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_EXEC
,
88 "[Init] Completing Initialization of ACPI Objects\n"));
89 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
90 "**** Starting initialization of namespace objects ****\n"));
91 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
92 "Completing Region/Field/Buffer/Package initialization:\n"));
94 /* Set all init info to zero */
96 memset(&info
, 0, sizeof(struct acpi_init_walk_info
));
98 /* Walk entire namespace from the supplied root */
100 status
= acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
101 ACPI_UINT32_MAX
, acpi_ns_init_one_object
,
103 if (ACPI_FAILURE(status
)) {
104 ACPI_EXCEPTION((AE_INFO
, status
, "During WalkNamespace"));
107 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
108 " Initialized %u/%u Regions %u/%u Fields %u/%u "
109 "Buffers %u/%u Packages (%u nodes)\n",
110 info
.op_region_init
, info
.op_region_count
,
111 info
.field_init
, info
.field_count
,
112 info
.buffer_init
, info
.buffer_count
,
113 info
.package_init
, info
.package_count
,
116 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
117 "%u Control Methods found\n%u Op Regions found\n",
118 info
.method_count
, info
.op_region_count
));
120 return_ACPI_STATUS(AE_OK
);
123 /*******************************************************************************
125 * FUNCTION: acpi_ns_initialize_devices
129 * RETURN: acpi_status
131 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
132 * This means running _INI on all present devices.
134 * Note: We install PCI config space handler on region access,
137 ******************************************************************************/
139 acpi_status
acpi_ns_initialize_devices(u32 flags
)
141 acpi_status status
= AE_OK
;
142 struct acpi_device_walk_info info
;
145 ACPI_FUNCTION_TRACE(ns_initialize_devices
);
147 if (!(flags
& ACPI_NO_DEVICE_INIT
)) {
148 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
149 "[Init] Initializing ACPI Devices\n"));
153 info
.device_count
= 0;
157 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
158 "Initializing Device/Processor/Thermal objects "
159 "and executing _INI/_STA methods:\n"));
161 /* Tree analysis: find all subtrees that contain _INI methods */
163 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
164 ACPI_UINT32_MAX
, FALSE
,
165 acpi_ns_find_ini_methods
, NULL
,
167 if (ACPI_FAILURE(status
)) {
171 /* Allocate the evaluation information block */
174 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
175 if (!info
.evaluate_info
) {
176 status
= AE_NO_MEMORY
;
181 * Execute the "global" _INI method that may appear at the root.
182 * This support is provided for Windows compatibility (Vista+) and
183 * is not part of the ACPI specification.
185 info
.evaluate_info
->prefix_node
= acpi_gbl_root_node
;
186 info
.evaluate_info
->relative_pathname
= METHOD_NAME__INI
;
187 info
.evaluate_info
->parameters
= NULL
;
188 info
.evaluate_info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
190 status
= acpi_ns_evaluate(info
.evaluate_info
);
191 if (ACPI_SUCCESS(status
)) {
197 * There appears to be a strict order requirement for \_SB._INI,
198 * which should be evaluated before any _REG evaluations.
200 status
= acpi_get_handle(NULL
, "\\_SB", &handle
);
201 if (ACPI_SUCCESS(status
)) {
202 memset(info
.evaluate_info
, 0,
203 sizeof(struct acpi_evaluate_info
));
204 info
.evaluate_info
->prefix_node
= handle
;
205 info
.evaluate_info
->relative_pathname
=
207 info
.evaluate_info
->parameters
= NULL
;
208 info
.evaluate_info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
210 status
= acpi_ns_evaluate(info
.evaluate_info
);
211 if (ACPI_SUCCESS(status
)) {
218 * Run all _REG methods
220 * Note: Any objects accessed by the _REG methods will be automatically
221 * initialized, even if they contain executable AML (see the call to
222 * acpi_ns_initialize_objects below).
224 * Note: According to the ACPI specification, we actually needn't execute
225 * _REG for system_memory/system_io operation regions, but for PCI_Config
226 * operation regions, it is required to evaluate _REG for those on a PCI
227 * root bus that doesn't contain _BBN object. So this code is kept here
228 * in order not to break things.
230 if (!(flags
& ACPI_NO_ADDRESS_SPACE_INIT
)) {
231 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
232 "[Init] Executing _REG OpRegion methods\n"));
234 status
= acpi_ev_initialize_op_regions();
235 if (ACPI_FAILURE(status
)) {
240 if (!(flags
& ACPI_NO_DEVICE_INIT
)) {
242 /* Walk namespace to execute all _INIs on present devices */
244 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
245 ACPI_UINT32_MAX
, FALSE
,
246 acpi_ns_init_one_device
, NULL
,
250 * Any _OSI requests should be completed by now. If the BIOS has
251 * requested any Windows OSI strings, we will always truncate
252 * I/O addresses to 16 bits -- for Windows compatibility.
254 if (acpi_gbl_osi_data
>= ACPI_OSI_WIN_2000
) {
255 acpi_gbl_truncate_io_addresses
= TRUE
;
258 ACPI_FREE(info
.evaluate_info
);
259 if (ACPI_FAILURE(status
)) {
263 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
264 " Executed %u _INI methods requiring %u _STA executions "
265 "(examined %u objects)\n",
266 info
.num_INI
, info
.num_STA
,
270 return_ACPI_STATUS(status
);
273 ACPI_EXCEPTION((AE_INFO
, status
, "During device initialization"));
274 return_ACPI_STATUS(status
);
277 /*******************************************************************************
279 * FUNCTION: acpi_ns_init_one_object
281 * PARAMETERS: obj_handle - Node
282 * level - Current nesting level
283 * context - Points to a init info struct
284 * return_value - Not used
288 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
289 * within the namespace.
291 * Currently, the only objects that require initialization are:
295 ******************************************************************************/
298 acpi_ns_init_one_object(acpi_handle obj_handle
,
299 u32 level
, void *context
, void **return_value
)
301 acpi_object_type type
;
302 acpi_status status
= AE_OK
;
303 struct acpi_init_walk_info
*info
=
304 (struct acpi_init_walk_info
*)context
;
305 struct acpi_namespace_node
*node
=
306 (struct acpi_namespace_node
*)obj_handle
;
307 union acpi_operand_object
*obj_desc
;
309 ACPI_FUNCTION_NAME(ns_init_one_object
);
311 info
->object_count
++;
313 /* And even then, we are only interested in a few object types */
315 type
= acpi_ns_get_type(obj_handle
);
316 obj_desc
= acpi_ns_get_attached_object(node
);
321 /* Increment counters for object types we are looking for */
324 case ACPI_TYPE_REGION
:
326 info
->op_region_count
++;
329 case ACPI_TYPE_BUFFER_FIELD
:
334 case ACPI_TYPE_LOCAL_BANK_FIELD
:
339 case ACPI_TYPE_BUFFER
:
341 info
->buffer_count
++;
344 case ACPI_TYPE_PACKAGE
:
346 info
->package_count
++;
351 /* No init required, just exit now */
356 /* If the object is already initialized, nothing else to do */
358 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
362 /* Must lock the interpreter before executing AML code */
364 acpi_ex_enter_interpreter();
367 * Each of these types can contain executable AML code within the
371 case ACPI_TYPE_REGION
:
373 info
->op_region_init
++;
374 status
= acpi_ds_get_region_arguments(obj_desc
);
377 case ACPI_TYPE_BUFFER_FIELD
:
380 status
= acpi_ds_get_buffer_field_arguments(obj_desc
);
383 case ACPI_TYPE_LOCAL_BANK_FIELD
:
386 status
= acpi_ds_get_bank_field_arguments(obj_desc
);
389 case ACPI_TYPE_BUFFER
:
392 status
= acpi_ds_get_buffer_arguments(obj_desc
);
395 case ACPI_TYPE_PACKAGE
:
397 info
->package_init
++;
398 status
= acpi_ds_get_package_arguments(obj_desc
);
403 /* No other types can get here */
408 if (ACPI_FAILURE(status
)) {
409 ACPI_EXCEPTION((AE_INFO
, status
,
410 "Could not execute arguments for [%4.4s] (%s)",
411 acpi_ut_get_node_name(node
),
412 acpi_ut_get_type_name(type
)));
416 * We ignore errors from above, and always return OK, since we don't want
417 * to abort the walk on any single error.
419 acpi_ex_exit_interpreter();
423 /*******************************************************************************
425 * FUNCTION: acpi_ns_find_ini_methods
427 * PARAMETERS: acpi_walk_callback
429 * RETURN: acpi_status
431 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
432 * device/processor/thermal objects, and marks the entire subtree
433 * with a SUBTREE_HAS_INI flag. This flag is used during the
434 * subsequent device initialization walk to avoid entire subtrees
435 * that do not contain an _INI.
437 ******************************************************************************/
440 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
441 u32 nesting_level
, void *context
, void **return_value
)
443 struct acpi_device_walk_info
*info
=
444 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
445 struct acpi_namespace_node
*node
;
446 struct acpi_namespace_node
*parent_node
;
448 /* Keep count of device/processor/thermal objects */
450 node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
451 if ((node
->type
== ACPI_TYPE_DEVICE
) ||
452 (node
->type
== ACPI_TYPE_PROCESSOR
) ||
453 (node
->type
== ACPI_TYPE_THERMAL
)) {
454 info
->device_count
++;
458 /* We are only looking for methods named _INI */
460 if (!ACPI_COMPARE_NAME(node
->name
.ascii
, METHOD_NAME__INI
)) {
465 * The only _INI methods that we care about are those that are
466 * present under Device, Processor, and Thermal objects.
468 parent_node
= node
->parent
;
469 switch (parent_node
->type
) {
470 case ACPI_TYPE_DEVICE
:
471 case ACPI_TYPE_PROCESSOR
:
472 case ACPI_TYPE_THERMAL
:
474 /* Mark parent and bubble up the INI present flag to the root */
476 while (parent_node
) {
477 parent_node
->flags
|= ANOBJ_SUBTREE_HAS_INI
;
478 parent_node
= parent_node
->parent
;
490 /*******************************************************************************
492 * FUNCTION: acpi_ns_init_one_device
494 * PARAMETERS: acpi_walk_callback
496 * RETURN: acpi_status
498 * DESCRIPTION: This is called once per device soon after ACPI is enabled
499 * to initialize each device. It determines if the device is
500 * present, and if so, calls _INI.
502 ******************************************************************************/
505 acpi_ns_init_one_device(acpi_handle obj_handle
,
506 u32 nesting_level
, void *context
, void **return_value
)
508 struct acpi_device_walk_info
*walk_info
=
509 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
510 struct acpi_evaluate_info
*info
= walk_info
->evaluate_info
;
513 struct acpi_namespace_node
*device_node
;
515 ACPI_FUNCTION_TRACE(ns_init_one_device
);
517 /* We are interested in Devices, Processors and thermal_zones only */
519 device_node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
520 if ((device_node
->type
!= ACPI_TYPE_DEVICE
) &&
521 (device_node
->type
!= ACPI_TYPE_PROCESSOR
) &&
522 (device_node
->type
!= ACPI_TYPE_THERMAL
)) {
523 return_ACPI_STATUS(AE_OK
);
527 * Because of an earlier namespace analysis, all subtrees that contain an
528 * _INI method are tagged.
530 * If this device subtree does not contain any _INI methods, we
531 * can exit now and stop traversing this entire subtree.
533 if (!(device_node
->flags
& ANOBJ_SUBTREE_HAS_INI
)) {
534 return_ACPI_STATUS(AE_CTRL_DEPTH
);
538 * Run _STA to determine if this device is present and functioning. We
539 * must know this information for two important reasons (from ACPI spec):
541 * 1) We can only run _INI if the device is present.
542 * 2) We must abort the device tree walk on this subtree if the device is
543 * not present and is not functional (we will not examine the children)
545 * The _STA method is not required to be present under the device, we
546 * assume the device is present if _STA does not exist.
548 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
549 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__STA
));
551 status
= acpi_ut_execute_STA(device_node
, &flags
);
552 if (ACPI_FAILURE(status
)) {
554 /* Ignore error and move on to next device */
556 return_ACPI_STATUS(AE_OK
);
560 * Flags == -1 means that _STA was not found. In this case, we assume that
561 * the device is both present and functional.
563 * From the ACPI spec, description of _STA:
565 * "If a device object (including the processor object) does not have an
566 * _STA object, then OSPM assumes that all of the above bits are set (in
567 * other words, the device is present, ..., and functioning)"
569 if (flags
!= ACPI_UINT32_MAX
) {
570 walk_info
->num_STA
++;
574 * Examine the PRESENT and FUNCTIONING status bits
576 * Note: ACPI spec does not seem to specify behavior for the present but
577 * not functioning case, so we assume functioning if present.
579 if (!(flags
& ACPI_STA_DEVICE_PRESENT
)) {
581 /* Device is not present, we must examine the Functioning bit */
583 if (flags
& ACPI_STA_DEVICE_FUNCTIONING
) {
585 * Device is not present but is "functioning". In this case,
586 * we will not run _INI, but we continue to examine the children
589 * From the ACPI spec, description of _STA: (note - no mention
590 * of whether to run _INI or not on the device in question)
592 * "_STA may return bit 0 clear (not present) with bit 3 set
593 * (device is functional). This case is used to indicate a valid
594 * device for which no device driver should be loaded (for example,
595 * a bridge device.) Children of this device may be present and
596 * valid. OSPM should continue enumeration below a device whose
597 * _STA returns this bit combination"
599 return_ACPI_STATUS(AE_OK
);
602 * Device is not present and is not functioning. We must abort the
603 * walk of this subtree immediately -- don't look at the children
606 * From the ACPI spec, description of _INI:
608 * "If the _STA method indicates that the device is not present,
609 * OSPM will not run the _INI and will not examine the children
610 * of the device for _INI methods"
612 return_ACPI_STATUS(AE_CTRL_DEPTH
);
617 * The device is present or is assumed present if no _STA exists.
618 * Run the _INI if it exists (not required to exist)
620 * Note: We know there is an _INI within this subtree, but it may not be
621 * under this particular device, it may be lower in the branch.
623 if (!ACPI_COMPARE_NAME(device_node
->name
.ascii
, "_SB_") ||
624 device_node
->parent
!= acpi_gbl_root_node
) {
625 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
626 (ACPI_TYPE_METHOD
, device_node
,
629 memset(info
, 0, sizeof(struct acpi_evaluate_info
));
630 info
->prefix_node
= device_node
;
631 info
->relative_pathname
= METHOD_NAME__INI
;
632 info
->parameters
= NULL
;
633 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
635 status
= acpi_ns_evaluate(info
);
636 if (ACPI_SUCCESS(status
)) {
637 walk_info
->num_INI
++;
639 #ifdef ACPI_DEBUG_OUTPUT
640 else if (status
!= AE_NOT_FOUND
) {
642 /* Ignore error and move on to next device */
645 acpi_ns_get_normalized_pathname(device_node
, TRUE
);
647 ACPI_EXCEPTION((AE_INFO
, status
,
648 "during %s._INI execution",
650 ACPI_FREE(scope_name
);
655 /* Ignore errors from above */
660 * The _INI method has been run if present; call the Global Initialization
661 * Handler for this device.
663 if (acpi_gbl_init_handler
) {
665 acpi_gbl_init_handler(device_node
, ACPI_INIT_DEVICE_INI
);
668 return_ACPI_STATUS(status
);