1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /******************************************************************************
4 * Module Name: nsinit - namespace initialization
6 * Copyright (C) 2000 - 2018, 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 "Completing Region/Field/Buffer/Package initialization:\n"));
60 /* Set all init info to zero */
62 memset(&info, 0, sizeof(struct acpi_init_walk_info));
64 /* Walk entire namespace from the supplied root */
66 status = acpi_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT,
67 ACPI_UINT32_MAX, acpi_ns_init_one_object,
69 if (ACPI_FAILURE(status)) {
70 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace"));
73 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT,
74 " Initialized %u/%u Regions %u/%u Fields %u/%u "
75 "Buffers %u/%u Packages (%u nodes)\n",
76 info.op_region_init, info.op_region_count,
77 info.field_init, info.field_count,
78 info.buffer_init, info.buffer_count,
79 info.package_init, info.package_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 * Each of these types can contain executable AML code within the
389 case ACPI_TYPE_REGION:
391 info->op_region_init++;
392 status = acpi_ds_get_region_arguments(obj_desc);
395 case ACPI_TYPE_BUFFER_FIELD:
398 status = acpi_ds_get_buffer_field_arguments(obj_desc);
401 case ACPI_TYPE_LOCAL_BANK_FIELD:
404 status = acpi_ds_get_bank_field_arguments(obj_desc);
407 case ACPI_TYPE_BUFFER:
410 status = acpi_ds_get_buffer_arguments(obj_desc);
413 case ACPI_TYPE_PACKAGE:
415 /* Complete the initialization/resolution of the package object */
417 info->package_init++;
419 acpi_ns_init_one_package(obj_handle, level, NULL, NULL);
424 /* No other types can get here */
429 if (ACPI_FAILURE(status)) {
430 ACPI_EXCEPTION((AE_INFO, status,
431 "Could not execute arguments for [%4.4s] (%s)",
432 acpi_ut_get_node_name(node),
433 acpi_ut_get_type_name(type)));
437 * We ignore errors from above, and always return OK, since we don't want
438 * to abort the walk on any single error.
440 acpi_ex_exit_interpreter();
444 /*******************************************************************************
446 * FUNCTION: acpi_ns_find_ini_methods
448 * PARAMETERS: acpi_walk_callback
450 * RETURN: acpi_status
452 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under
453 * device/processor/thermal objects, and marks the entire subtree
454 * with a SUBTREE_HAS_INI flag. This flag is used during the
455 * subsequent device initialization walk to avoid entire subtrees
456 * that do not contain an _INI.
458 ******************************************************************************/
461 acpi_ns_find_ini_methods(acpi_handle obj_handle,
462 u32 nesting_level, void *context, void **return_value)
464 struct acpi_device_walk_info *info =
465 ACPI_CAST_PTR(struct acpi_device_walk_info, context);
466 struct acpi_namespace_node *node;
467 struct acpi_namespace_node *parent_node;
469 /* Keep count of device/processor/thermal objects */
471 node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
472 if ((node->type == ACPI_TYPE_DEVICE) ||
473 (node->type == ACPI_TYPE_PROCESSOR) ||
474 (node->type == ACPI_TYPE_THERMAL)) {
475 info->device_count++;
479 /* We are only looking for methods named _INI */
481 if (!ACPI_COMPARE_NAME(node->name.ascii, METHOD_NAME__INI)) {
486 * The only _INI methods that we care about are those that are
487 * present under Device, Processor, and Thermal objects.
489 parent_node = node->parent;
490 switch (parent_node->type) {
491 case ACPI_TYPE_DEVICE:
492 case ACPI_TYPE_PROCESSOR:
493 case ACPI_TYPE_THERMAL:
495 /* Mark parent and bubble up the INI present flag to the root */
497 while (parent_node) {
498 parent_node->flags |= ANOBJ_SUBTREE_HAS_INI;
499 parent_node = parent_node->parent;
511 /*******************************************************************************
513 * FUNCTION: acpi_ns_init_one_device
515 * PARAMETERS: acpi_walk_callback
517 * RETURN: acpi_status
519 * DESCRIPTION: This is called once per device soon after ACPI is enabled
520 * to initialize each device. It determines if the device is
521 * present, and if so, calls _INI.
523 ******************************************************************************/
526 acpi_ns_init_one_device(acpi_handle obj_handle,
527 u32 nesting_level, void *context, void **return_value)
529 struct acpi_device_walk_info *walk_info =
530 ACPI_CAST_PTR(struct acpi_device_walk_info, context);
531 struct acpi_evaluate_info *info = walk_info->evaluate_info;
534 struct acpi_namespace_node *device_node;
536 ACPI_FUNCTION_TRACE(ns_init_one_device);
538 /* We are interested in Devices, Processors and thermal_zones only */
540 device_node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle);
541 if ((device_node->type != ACPI_TYPE_DEVICE) &&
542 (device_node->type != ACPI_TYPE_PROCESSOR) &&
543 (device_node->type != ACPI_TYPE_THERMAL)) {
544 return_ACPI_STATUS(AE_OK);
548 * Because of an earlier namespace analysis, all subtrees that contain an
549 * _INI method are tagged.
551 * If this device subtree does not contain any _INI methods, we
552 * can exit now and stop traversing this entire subtree.
554 if (!(device_node->flags & ANOBJ_SUBTREE_HAS_INI)) {
555 return_ACPI_STATUS(AE_CTRL_DEPTH);
559 * Run _STA to determine if this device is present and functioning. We
560 * must know this information for two important reasons (from ACPI spec):
562 * 1) We can only run _INI if the device is present.
563 * 2) We must abort the device tree walk on this subtree if the device is
564 * not present and is not functional (we will not examine the children)
566 * The _STA method is not required to be present under the device, we
567 * assume the device is present if _STA does not exist.
569 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
570 (ACPI_TYPE_METHOD, device_node, METHOD_NAME__STA));
572 status = acpi_ut_execute_STA(device_node, &flags);
573 if (ACPI_FAILURE(status)) {
575 /* Ignore error and move on to next device */
577 return_ACPI_STATUS(AE_OK);
581 * Flags == -1 means that _STA was not found. In this case, we assume that
582 * the device is both present and functional.
584 * From the ACPI spec, description of _STA:
586 * "If a device object (including the processor object) does not have an
587 * _STA object, then OSPM assumes that all of the above bits are set (in
588 * other words, the device is present, ..., and functioning)"
590 if (flags != ACPI_UINT32_MAX) {
591 walk_info->num_STA++;
595 * Examine the PRESENT and FUNCTIONING status bits
597 * Note: ACPI spec does not seem to specify behavior for the present but
598 * not functioning case, so we assume functioning if present.
600 if (!(flags & ACPI_STA_DEVICE_PRESENT)) {
602 /* Device is not present, we must examine the Functioning bit */
604 if (flags & ACPI_STA_DEVICE_FUNCTIONING) {
606 * Device is not present but is "functioning". In this case,
607 * we will not run _INI, but we continue to examine the children
610 * From the ACPI spec, description of _STA: (note - no mention
611 * of whether to run _INI or not on the device in question)
613 * "_STA may return bit 0 clear (not present) with bit 3 set
614 * (device is functional). This case is used to indicate a valid
615 * device for which no device driver should be loaded (for example,
616 * a bridge device.) Children of this device may be present and
617 * valid. OSPM should continue enumeration below a device whose
618 * _STA returns this bit combination"
620 return_ACPI_STATUS(AE_OK);
623 * Device is not present and is not functioning. We must abort the
624 * walk of this subtree immediately -- don't look at the children
627 * From the ACPI spec, description of _INI:
629 * "If the _STA method indicates that the device is not present,
630 * OSPM will not run the _INI and will not examine the children
631 * of the device for _INI methods"
633 return_ACPI_STATUS(AE_CTRL_DEPTH);
638 * The device is present or is assumed present if no _STA exists.
639 * Run the _INI if it exists (not required to exist)
641 * Note: We know there is an _INI within this subtree, but it may not be
642 * under this particular device, it may be lower in the branch.
644 if (!ACPI_COMPARE_NAME(device_node->name.ascii, "_SB_") ||
645 device_node->parent != acpi_gbl_root_node) {
646 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
647 (ACPI_TYPE_METHOD, device_node,
650 memset(info, 0, sizeof(struct acpi_evaluate_info));
651 info->prefix_node = device_node;
652 info->relative_pathname = METHOD_NAME__INI;
653 info->parameters = NULL;
654 info->flags = ACPI_IGNORE_RETURN_VALUE;
656 status = acpi_ns_evaluate(info);
657 if (ACPI_SUCCESS(status)) {
658 walk_info->num_INI++;
660 #ifdef ACPI_DEBUG_OUTPUT
661 else if (status != AE_NOT_FOUND) {
663 /* Ignore error and move on to next device */
666 acpi_ns_get_normalized_pathname(device_node, TRUE);
668 ACPI_EXCEPTION((AE_INFO, status,
669 "during %s._INI execution",
671 ACPI_FREE(scope_name);
676 /* Ignore errors from above */
681 * The _INI method has been run if present; call the Global Initialization
682 * Handler for this device.
684 if (acpi_gbl_init_handler) {
686 acpi_gbl_init_handler(device_node, ACPI_INIT_DEVICE_INI);
689 return_ACPI_STATUS(status);