1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: nsinit - namespace initialization
6 * Copyright (C) 2000 - 2020, Intel Corp.
8 *****************************************************************************/
10 #include <acpi/acpi.h>
17 #define _COMPONENT ACPI_NAMESPACE
18 ACPI_MODULE_NAME("nsinit")
20 /* Local prototypes */
22 acpi_ns_init_one_object(acpi_handle obj_handle
,
23 u32 level
, void *context
, void **return_value
);
26 acpi_ns_init_one_device(acpi_handle obj_handle
,
27 u32 nesting_level
, void *context
, void **return_value
);
30 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
31 u32 nesting_level
, void *context
, void **return_value
);
33 /*******************************************************************************
35 * FUNCTION: acpi_ns_initialize_objects
41 * DESCRIPTION: Walk the entire namespace and perform any necessary
42 * initialization on the objects found therein
44 ******************************************************************************/
46 acpi_status
acpi_ns_initialize_objects(void)
49 struct acpi_init_walk_info info
;
51 ACPI_FUNCTION_TRACE(ns_initialize_objects
);
53 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
54 "[Init] Completing Initialization of ACPI Objects\n"));
55 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
56 "**** Starting initialization of namespace objects ****\n"));
57 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
58 "Final data object initialization: "));
60 /* Clear the info block */
62 memset(&info
, 0, sizeof(struct acpi_init_walk_info
));
64 /* Walk entire namespace from the supplied root */
67 * TBD: will become ACPI_TYPE_PACKAGE as this type object
68 * is now the only one that supports deferred initialization
69 * (forward references).
71 status
= acpi_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
72 ACPI_UINT32_MAX
, acpi_ns_init_one_object
,
74 if (ACPI_FAILURE(status
)) {
75 ACPI_EXCEPTION((AE_INFO
, status
, "During WalkNamespace"));
78 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
79 "Namespace contains %u (0x%X) objects\n",
80 info
.object_count
, info
.object_count
));
82 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH
,
83 "%u Control Methods found\n%u Op Regions found\n",
84 info
.method_count
, info
.op_region_count
));
86 return_ACPI_STATUS(AE_OK
);
89 /*******************************************************************************
91 * FUNCTION: acpi_ns_initialize_devices
97 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices.
98 * This means running _INI on all present devices.
100 * Note: We install PCI config space handler on region access,
103 ******************************************************************************/
105 acpi_status
acpi_ns_initialize_devices(u32 flags
)
107 acpi_status status
= AE_OK
;
108 struct acpi_device_walk_info info
;
111 ACPI_FUNCTION_TRACE(ns_initialize_devices
);
113 if (!(flags
& ACPI_NO_DEVICE_INIT
)) {
114 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
115 "[Init] Initializing ACPI Devices\n"));
119 info
.device_count
= 0;
123 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
124 "Initializing Device/Processor/Thermal objects "
125 "and executing _INI/_STA methods:\n"));
127 /* Tree analysis: find all subtrees that contain _INI methods */
129 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
130 ACPI_UINT32_MAX
, FALSE
,
131 acpi_ns_find_ini_methods
, NULL
,
133 if (ACPI_FAILURE(status
)) {
137 /* Allocate the evaluation information block */
140 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
141 if (!info
.evaluate_info
) {
142 status
= AE_NO_MEMORY
;
147 * Execute the "global" _INI method that may appear at the root.
148 * This support is provided for Windows compatibility (Vista+) and
149 * is not part of the ACPI specification.
151 info
.evaluate_info
->prefix_node
= acpi_gbl_root_node
;
152 info
.evaluate_info
->relative_pathname
= METHOD_NAME__INI
;
153 info
.evaluate_info
->parameters
= NULL
;
154 info
.evaluate_info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
156 status
= acpi_ns_evaluate(info
.evaluate_info
);
157 if (ACPI_SUCCESS(status
)) {
163 * There appears to be a strict order requirement for \_SB._INI,
164 * which should be evaluated before any _REG evaluations.
166 status
= acpi_get_handle(NULL
, "\\_SB", &handle
);
167 if (ACPI_SUCCESS(status
)) {
168 memset(info
.evaluate_info
, 0,
169 sizeof(struct acpi_evaluate_info
));
170 info
.evaluate_info
->prefix_node
= handle
;
171 info
.evaluate_info
->relative_pathname
=
173 info
.evaluate_info
->parameters
= NULL
;
174 info
.evaluate_info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
176 status
= acpi_ns_evaluate(info
.evaluate_info
);
177 if (ACPI_SUCCESS(status
)) {
184 * Run all _REG methods
186 * Note: Any objects accessed by the _REG methods will be automatically
187 * initialized, even if they contain executable AML (see the call to
188 * acpi_ns_initialize_objects below).
190 * Note: According to the ACPI specification, we actually needn't execute
191 * _REG for system_memory/system_io operation regions, but for PCI_Config
192 * operation regions, it is required to evaluate _REG for those on a PCI
193 * root bus that doesn't contain _BBN object. So this code is kept here
194 * in order not to break things.
196 if (!(flags
& ACPI_NO_ADDRESS_SPACE_INIT
)) {
197 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
198 "[Init] Executing _REG OpRegion methods\n"));
200 status
= acpi_ev_initialize_op_regions();
201 if (ACPI_FAILURE(status
)) {
206 if (!(flags
& ACPI_NO_DEVICE_INIT
)) {
208 /* Walk namespace to execute all _INIs on present devices */
210 status
= acpi_ns_walk_namespace(ACPI_TYPE_ANY
, ACPI_ROOT_OBJECT
,
211 ACPI_UINT32_MAX
, FALSE
,
212 acpi_ns_init_one_device
, NULL
,
216 * Any _OSI requests should be completed by now. If the BIOS has
217 * requested any Windows OSI strings, we will always truncate
218 * I/O addresses to 16 bits -- for Windows compatibility.
220 if (acpi_gbl_osi_data
>= ACPI_OSI_WIN_2000
) {
221 acpi_gbl_truncate_io_addresses
= TRUE
;
224 ACPI_FREE(info
.evaluate_info
);
225 if (ACPI_FAILURE(status
)) {
229 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT
,
230 " Executed %u _INI methods requiring %u _STA executions "
231 "(examined %u objects)\n",
232 info
.num_INI
, info
.num_STA
,
236 return_ACPI_STATUS(status
);
239 ACPI_EXCEPTION((AE_INFO
, status
, "During device initialization"));
240 return_ACPI_STATUS(status
);
243 /*******************************************************************************
245 * FUNCTION: acpi_ns_init_one_package
247 * PARAMETERS: obj_handle - Node
248 * level - Current nesting level
250 * return_value - Not used
254 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every package
255 * within the namespace. Used during dynamic load of an SSDT.
257 ******************************************************************************/
260 acpi_ns_init_one_package(acpi_handle obj_handle
,
261 u32 level
, void *context
, void **return_value
)
264 union acpi_operand_object
*obj_desc
;
265 struct acpi_namespace_node
*node
=
266 (struct acpi_namespace_node
*)obj_handle
;
268 obj_desc
= acpi_ns_get_attached_object(node
);
273 /* Exit if package is already initialized */
275 if (obj_desc
->package
.flags
& AOPOBJ_DATA_VALID
) {
279 status
= acpi_ds_get_package_arguments(obj_desc
);
280 if (ACPI_FAILURE(status
)) {
285 acpi_ut_walk_package_tree(obj_desc
, NULL
,
286 acpi_ds_init_package_element
, NULL
);
287 if (ACPI_FAILURE(status
)) {
291 obj_desc
->package
.flags
|= AOPOBJ_DATA_VALID
;
295 /*******************************************************************************
297 * FUNCTION: acpi_ns_init_one_object
299 * PARAMETERS: obj_handle - Node
300 * level - Current nesting level
301 * context - Points to a init info struct
302 * return_value - Not used
306 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object
307 * within the namespace.
309 * Currently, the only objects that require initialization are:
313 ******************************************************************************/
316 acpi_ns_init_one_object(acpi_handle obj_handle
,
317 u32 level
, void *context
, void **return_value
)
319 acpi_object_type type
;
320 acpi_status status
= AE_OK
;
321 struct acpi_init_walk_info
*info
=
322 (struct acpi_init_walk_info
*)context
;
323 struct acpi_namespace_node
*node
=
324 (struct acpi_namespace_node
*)obj_handle
;
325 union acpi_operand_object
*obj_desc
;
327 ACPI_FUNCTION_NAME(ns_init_one_object
);
329 info
->object_count
++;
331 /* And even then, we are only interested in a few object types */
333 type
= acpi_ns_get_type(obj_handle
);
334 obj_desc
= acpi_ns_get_attached_object(node
);
339 /* Increment counters for object types we are looking for */
342 case ACPI_TYPE_REGION
:
344 info
->op_region_count
++;
347 case ACPI_TYPE_BUFFER_FIELD
:
352 case ACPI_TYPE_LOCAL_BANK_FIELD
:
357 case ACPI_TYPE_BUFFER
:
359 info
->buffer_count
++;
362 case ACPI_TYPE_PACKAGE
:
364 info
->package_count
++;
369 /* No init required, just exit now */
374 /* If the object is already initialized, nothing else to do */
376 if (obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
) {
380 /* Must lock the interpreter before executing AML code */
382 acpi_ex_enter_interpreter();
385 * Only initialization of Package objects can be deferred, in order
386 * to support forward references.
389 case ACPI_TYPE_LOCAL_BANK_FIELD
:
391 /* TBD: bank_fields do not require deferred init, remove this code */
394 status
= acpi_ds_get_bank_field_arguments(obj_desc
);
397 case ACPI_TYPE_PACKAGE
:
399 /* Complete the initialization/resolution of the package object */
401 info
->package_init
++;
403 acpi_ns_init_one_package(obj_handle
, level
, NULL
, NULL
);
408 /* No other types should get here */
411 ACPI_EXCEPTION((AE_INFO
, status
,
412 "Opcode is not deferred [%4.4s] (%s)",
413 acpi_ut_get_node_name(node
),
414 acpi_ut_get_type_name(type
)));
418 if (ACPI_FAILURE(status
)) {
419 ACPI_EXCEPTION((AE_INFO
, status
,
420 "Could not execute arguments for [%4.4s] (%s)",
421 acpi_ut_get_node_name(node
),
422 acpi_ut_get_type_name(type
)));
426 * We ignore errors from above, and always return OK, since we don't want
427 * to abort the walk on any single error.
429 acpi_ex_exit_interpreter();
433 /*******************************************************************************
435 * FUNCTION: acpi_ns_find_ini_methods
437 * PARAMETERS: acpi_walk_callback
439 * RETURN: acpi_status
441 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
442 * device/processor/thermal objects, and marks the entire subtree
443 * with a SUBTREE_HAS_INI flag. This flag is used during the
444 * subsequent device initialization walk to avoid entire subtrees
445 * that do not contain an _INI.
447 ******************************************************************************/
450 acpi_ns_find_ini_methods(acpi_handle obj_handle
,
451 u32 nesting_level
, void *context
, void **return_value
)
453 struct acpi_device_walk_info
*info
=
454 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
455 struct acpi_namespace_node
*node
;
456 struct acpi_namespace_node
*parent_node
;
458 /* Keep count of device/processor/thermal objects */
460 node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
461 if ((node
->type
== ACPI_TYPE_DEVICE
) ||
462 (node
->type
== ACPI_TYPE_PROCESSOR
) ||
463 (node
->type
== ACPI_TYPE_THERMAL
)) {
464 info
->device_count
++;
468 /* We are only looking for methods named _INI */
470 if (!ACPI_COMPARE_NAMESEG(node
->name
.ascii
, METHOD_NAME__INI
)) {
475 * The only _INI methods that we care about are those that are
476 * present under Device, Processor, and Thermal objects.
478 parent_node
= node
->parent
;
479 switch (parent_node
->type
) {
480 case ACPI_TYPE_DEVICE
:
481 case ACPI_TYPE_PROCESSOR
:
482 case ACPI_TYPE_THERMAL
:
484 /* Mark parent and bubble up the INI present flag to the root */
486 while (parent_node
) {
487 parent_node
->flags
|= ANOBJ_SUBTREE_HAS_INI
;
488 parent_node
= parent_node
->parent
;
500 /*******************************************************************************
502 * FUNCTION: acpi_ns_init_one_device
504 * PARAMETERS: acpi_walk_callback
506 * RETURN: acpi_status
508 * DESCRIPTION: This is called once per device soon after ACPI is enabled
509 * to initialize each device. It determines if the device is
510 * present, and if so, calls _INI.
512 ******************************************************************************/
515 acpi_ns_init_one_device(acpi_handle obj_handle
,
516 u32 nesting_level
, void *context
, void **return_value
)
518 struct acpi_device_walk_info
*walk_info
=
519 ACPI_CAST_PTR(struct acpi_device_walk_info
, context
);
520 struct acpi_evaluate_info
*info
= walk_info
->evaluate_info
;
523 struct acpi_namespace_node
*device_node
;
525 ACPI_FUNCTION_TRACE(ns_init_one_device
);
527 /* We are interested in Devices, Processors and thermal_zones only */
529 device_node
= ACPI_CAST_PTR(struct acpi_namespace_node
, obj_handle
);
530 if ((device_node
->type
!= ACPI_TYPE_DEVICE
) &&
531 (device_node
->type
!= ACPI_TYPE_PROCESSOR
) &&
532 (device_node
->type
!= ACPI_TYPE_THERMAL
)) {
533 return_ACPI_STATUS(AE_OK
);
537 * Because of an earlier namespace analysis, all subtrees that contain an
538 * _INI method are tagged.
540 * If this device subtree does not contain any _INI methods, we
541 * can exit now and stop traversing this entire subtree.
543 if (!(device_node
->flags
& ANOBJ_SUBTREE_HAS_INI
)) {
544 return_ACPI_STATUS(AE_CTRL_DEPTH
);
548 * Run _STA to determine if this device is present and functioning. We
549 * must know this information for two important reasons (from ACPI spec):
551 * 1) We can only run _INI if the device is present.
552 * 2) We must abort the device tree walk on this subtree if the device is
553 * not present and is not functional (we will not examine the children)
555 * The _STA method is not required to be present under the device, we
556 * assume the device is present if _STA does not exist.
558 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
559 (ACPI_TYPE_METHOD
, device_node
, METHOD_NAME__STA
));
561 status
= acpi_ut_execute_STA(device_node
, &flags
);
562 if (ACPI_FAILURE(status
)) {
564 /* Ignore error and move on to next device */
566 return_ACPI_STATUS(AE_OK
);
570 * Flags == -1 means that _STA was not found. In this case, we assume that
571 * the device is both present and functional.
573 * From the ACPI spec, description of _STA:
575 * "If a device object (including the processor object) does not have an
576 * _STA object, then OSPM assumes that all of the above bits are set (in
577 * other words, the device is present, ..., and functioning)"
579 if (flags
!= ACPI_UINT32_MAX
) {
580 walk_info
->num_STA
++;
584 * Examine the PRESENT and FUNCTIONING status bits
586 * Note: ACPI spec does not seem to specify behavior for the present but
587 * not functioning case, so we assume functioning if present.
589 if (!(flags
& ACPI_STA_DEVICE_PRESENT
)) {
591 /* Device is not present, we must examine the Functioning bit */
593 if (flags
& ACPI_STA_DEVICE_FUNCTIONING
) {
595 * Device is not present but is "functioning". In this case,
596 * we will not run _INI, but we continue to examine the children
599 * From the ACPI spec, description of _STA: (note - no mention
600 * of whether to run _INI or not on the device in question)
602 * "_STA may return bit 0 clear (not present) with bit 3 set
603 * (device is functional). This case is used to indicate a valid
604 * device for which no device driver should be loaded (for example,
605 * a bridge device.) Children of this device may be present and
606 * valid. OSPM should continue enumeration below a device whose
607 * _STA returns this bit combination"
609 return_ACPI_STATUS(AE_OK
);
612 * Device is not present and is not functioning. We must abort the
613 * walk of this subtree immediately -- don't look at the children
616 * From the ACPI spec, description of _INI:
618 * "If the _STA method indicates that the device is not present,
619 * OSPM will not run the _INI and will not examine the children
620 * of the device for _INI methods"
622 return_ACPI_STATUS(AE_CTRL_DEPTH
);
627 * The device is present or is assumed present if no _STA exists.
628 * Run the _INI if it exists (not required to exist)
630 * Note: We know there is an _INI within this subtree, but it may not be
631 * under this particular device, it may be lower in the branch.
633 if (!ACPI_COMPARE_NAMESEG(device_node
->name
.ascii
, "_SB_") ||
634 device_node
->parent
!= acpi_gbl_root_node
) {
635 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
636 (ACPI_TYPE_METHOD
, device_node
,
639 memset(info
, 0, sizeof(struct acpi_evaluate_info
));
640 info
->prefix_node
= device_node
;
641 info
->relative_pathname
= METHOD_NAME__INI
;
642 info
->parameters
= NULL
;
643 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
645 status
= acpi_ns_evaluate(info
);
646 if (ACPI_SUCCESS(status
)) {
647 walk_info
->num_INI
++;
649 #ifdef ACPI_DEBUG_OUTPUT
650 else if (status
!= AE_NOT_FOUND
) {
652 /* Ignore error and move on to next device */
655 acpi_ns_get_normalized_pathname(device_node
, TRUE
);
657 ACPI_EXCEPTION((AE_INFO
, status
,
658 "during %s._INI execution",
660 ACPI_FREE(scope_name
);
665 /* Ignore errors from above */
670 * The _INI method has been run if present; call the Global Initialization
671 * Handler for this device.
673 if (acpi_gbl_init_handler
) {
675 acpi_gbl_init_handler(device_node
, ACPI_INIT_DEVICE_INI
);
678 return_ACPI_STATUS(status
);