1 /****************************************************************************** 2 * 3 * Module Name: nsinit - namespace initialization 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 25 * 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. 29 * 30 * NO WARRANTY 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. 42 */ 43 44 #include <acpi/acpi.h> 45 #include "accommon.h" 46 #include "acnamesp.h" 47 #include "acdispat.h" 48 #include "acinterp.h" 49 #include "acevents.h" 50 51 #define _COMPONENT ACPI_NAMESPACE 52 ACPI_MODULE_NAME("nsinit") 53 54 /* Local prototypes */ 55 static acpi_status 56 acpi_ns_init_one_object(acpi_handle obj_handle, 57 u32 level, void *context, void **return_value); 58 59 static acpi_status 60 acpi_ns_init_one_device(acpi_handle obj_handle, 61 u32 nesting_level, void *context, void **return_value); 62 63 static acpi_status 64 acpi_ns_find_ini_methods(acpi_handle obj_handle, 65 u32 nesting_level, void *context, void **return_value); 66 67 /******************************************************************************* 68 * 69 * FUNCTION: acpi_ns_initialize_objects 70 * 71 * PARAMETERS: None 72 * 73 * RETURN: Status 74 * 75 * DESCRIPTION: Walk the entire namespace and perform any necessary 76 * initialization on the objects found therein 77 * 78 ******************************************************************************/ 79 80 acpi_status acpi_ns_initialize_objects(void) 81 { 82 acpi_status status; 83 struct acpi_init_walk_info info; 84 85 ACPI_FUNCTION_TRACE(ns_initialize_objects); 86 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")); 93 94 /* Set all init info to zero */ 95 96 memset(&info, 0, sizeof(struct acpi_init_walk_info)); 97 98 /* Walk entire namespace from the supplied root */ 99 100 status = acpi_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 101 ACPI_UINT32_MAX, acpi_ns_init_one_object, 102 NULL, &info, NULL); 103 if (ACPI_FAILURE(status)) { 104 ACPI_EXCEPTION((AE_INFO, status, "During WalkNamespace")); 105 } 106 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, 114 info.object_count)); 115 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)); 119 120 return_ACPI_STATUS(AE_OK); 121 } 122 123 /******************************************************************************* 124 * 125 * FUNCTION: acpi_ns_initialize_devices 126 * 127 * PARAMETERS: None 128 * 129 * RETURN: acpi_status 130 * 131 * DESCRIPTION: Walk the entire namespace and initialize all ACPI devices. 132 * This means running _INI on all present devices. 133 * 134 * Note: We install PCI config space handler on region access, 135 * not here. 136 * 137 ******************************************************************************/ 138 139 acpi_status acpi_ns_initialize_devices(u32 flags) 140 { 141 acpi_status status = AE_OK; 142 struct acpi_device_walk_info info; 143 144 ACPI_FUNCTION_TRACE(ns_initialize_devices); 145 146 if (!(flags & ACPI_NO_DEVICE_INIT)) { 147 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, 148 "[Init] Initializing ACPI Devices\n")); 149 150 /* Init counters */ 151 152 info.device_count = 0; 153 info.num_STA = 0; 154 info.num_INI = 0; 155 156 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, 157 "Initializing Device/Processor/Thermal objects " 158 "and executing _INI/_STA methods:\n")); 159 160 /* Tree analysis: find all subtrees that contain _INI methods */ 161 162 status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 163 ACPI_UINT32_MAX, FALSE, 164 acpi_ns_find_ini_methods, NULL, 165 &info, NULL); 166 if (ACPI_FAILURE(status)) { 167 goto error_exit; 168 } 169 170 /* Allocate the evaluation information block */ 171 172 info.evaluate_info = 173 ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info)); 174 if (!info.evaluate_info) { 175 status = AE_NO_MEMORY; 176 goto error_exit; 177 } 178 179 /* 180 * Execute the "global" _INI method that may appear at the root. 181 * This support is provided for Windows compatibility (Vista+) and 182 * is not part of the ACPI specification. 183 */ 184 info.evaluate_info->prefix_node = acpi_gbl_root_node; 185 info.evaluate_info->relative_pathname = METHOD_NAME__INI; 186 info.evaluate_info->parameters = NULL; 187 info.evaluate_info->flags = ACPI_IGNORE_RETURN_VALUE; 188 189 status = acpi_ns_evaluate(info.evaluate_info); 190 if (ACPI_SUCCESS(status)) { 191 info.num_INI++; 192 } 193 } 194 195 /* 196 * Run all _REG methods 197 * 198 * Note: Any objects accessed by the _REG methods will be automatically 199 * initialized, even if they contain executable AML (see the call to 200 * acpi_ns_initialize_objects below). 201 */ 202 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) { 203 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, 204 "[Init] Executing _REG OpRegion methods\n")); 205 206 status = acpi_ev_initialize_op_regions(); 207 if (ACPI_FAILURE(status)) { 208 goto error_exit; 209 } 210 } 211 212 if (!(flags & ACPI_NO_DEVICE_INIT)) { 213 214 /* Walk namespace to execute all _INIs on present devices */ 215 216 status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 217 ACPI_UINT32_MAX, FALSE, 218 acpi_ns_init_one_device, NULL, 219 &info, NULL); 220 221 /* 222 * Any _OSI requests should be completed by now. If the BIOS has 223 * requested any Windows OSI strings, we will always truncate 224 * I/O addresses to 16 bits -- for Windows compatibility. 225 */ 226 if (acpi_gbl_osi_data >= ACPI_OSI_WIN_2000) { 227 acpi_gbl_truncate_io_addresses = TRUE; 228 } 229 230 ACPI_FREE(info.evaluate_info); 231 if (ACPI_FAILURE(status)) { 232 goto error_exit; 233 } 234 235 ACPI_DEBUG_PRINT_RAW((ACPI_DB_INIT, 236 " Executed %u _INI methods requiring %u _STA executions " 237 "(examined %u objects)\n", 238 info.num_INI, info.num_STA, 239 info.device_count)); 240 } 241 242 return_ACPI_STATUS(status); 243 244 error_exit: 245 ACPI_EXCEPTION((AE_INFO, status, "During device initialization")); 246 return_ACPI_STATUS(status); 247 } 248 249 /******************************************************************************* 250 * 251 * FUNCTION: acpi_ns_init_one_object 252 * 253 * PARAMETERS: obj_handle - Node 254 * level - Current nesting level 255 * context - Points to a init info struct 256 * return_value - Not used 257 * 258 * RETURN: Status 259 * 260 * DESCRIPTION: Callback from acpi_walk_namespace. Invoked for every object 261 * within the namespace. 262 * 263 * Currently, the only objects that require initialization are: 264 * 1) Methods 265 * 2) Op Regions 266 * 267 ******************************************************************************/ 268 269 static acpi_status 270 acpi_ns_init_one_object(acpi_handle obj_handle, 271 u32 level, void *context, void **return_value) 272 { 273 acpi_object_type type; 274 acpi_status status = AE_OK; 275 struct acpi_init_walk_info *info = 276 (struct acpi_init_walk_info *)context; 277 struct acpi_namespace_node *node = 278 (struct acpi_namespace_node *)obj_handle; 279 union acpi_operand_object *obj_desc; 280 281 ACPI_FUNCTION_NAME(ns_init_one_object); 282 283 info->object_count++; 284 285 /* And even then, we are only interested in a few object types */ 286 287 type = acpi_ns_get_type(obj_handle); 288 obj_desc = acpi_ns_get_attached_object(node); 289 if (!obj_desc) { 290 return (AE_OK); 291 } 292 293 /* Increment counters for object types we are looking for */ 294 295 switch (type) { 296 case ACPI_TYPE_REGION: 297 298 info->op_region_count++; 299 break; 300 301 case ACPI_TYPE_BUFFER_FIELD: 302 303 info->field_count++; 304 break; 305 306 case ACPI_TYPE_LOCAL_BANK_FIELD: 307 308 info->field_count++; 309 break; 310 311 case ACPI_TYPE_BUFFER: 312 313 info->buffer_count++; 314 break; 315 316 case ACPI_TYPE_PACKAGE: 317 318 info->package_count++; 319 break; 320 321 default: 322 323 /* No init required, just exit now */ 324 325 return (AE_OK); 326 } 327 328 /* If the object is already initialized, nothing else to do */ 329 330 if (obj_desc->common.flags & AOPOBJ_DATA_VALID) { 331 return (AE_OK); 332 } 333 334 /* Must lock the interpreter before executing AML code */ 335 336 acpi_ex_enter_interpreter(); 337 338 /* 339 * Each of these types can contain executable AML code within the 340 * declaration. 341 */ 342 switch (type) { 343 case ACPI_TYPE_REGION: 344 345 info->op_region_init++; 346 status = acpi_ds_get_region_arguments(obj_desc); 347 break; 348 349 case ACPI_TYPE_BUFFER_FIELD: 350 351 info->field_init++; 352 status = acpi_ds_get_buffer_field_arguments(obj_desc); 353 break; 354 355 case ACPI_TYPE_LOCAL_BANK_FIELD: 356 357 info->field_init++; 358 status = acpi_ds_get_bank_field_arguments(obj_desc); 359 break; 360 361 case ACPI_TYPE_BUFFER: 362 363 info->buffer_init++; 364 status = acpi_ds_get_buffer_arguments(obj_desc); 365 break; 366 367 case ACPI_TYPE_PACKAGE: 368 369 info->package_init++; 370 status = acpi_ds_get_package_arguments(obj_desc); 371 break; 372 373 default: 374 375 /* No other types can get here */ 376 377 break; 378 } 379 380 if (ACPI_FAILURE(status)) { 381 ACPI_EXCEPTION((AE_INFO, status, 382 "Could not execute arguments for [%4.4s] (%s)", 383 acpi_ut_get_node_name(node), 384 acpi_ut_get_type_name(type))); 385 } 386 387 /* 388 * We ignore errors from above, and always return OK, since we don't want 389 * to abort the walk on any single error. 390 */ 391 acpi_ex_exit_interpreter(); 392 return (AE_OK); 393 } 394 395 /******************************************************************************* 396 * 397 * FUNCTION: acpi_ns_find_ini_methods 398 * 399 * PARAMETERS: acpi_walk_callback 400 * 401 * RETURN: acpi_status 402 * 403 * DESCRIPTION: Called during namespace walk. Finds objects named _INI under 404 * device/processor/thermal objects, and marks the entire subtree 405 * with a SUBTREE_HAS_INI flag. This flag is used during the 406 * subsequent device initialization walk to avoid entire subtrees 407 * that do not contain an _INI. 408 * 409 ******************************************************************************/ 410 411 static acpi_status 412 acpi_ns_find_ini_methods(acpi_handle obj_handle, 413 u32 nesting_level, void *context, void **return_value) 414 { 415 struct acpi_device_walk_info *info = 416 ACPI_CAST_PTR(struct acpi_device_walk_info, context); 417 struct acpi_namespace_node *node; 418 struct acpi_namespace_node *parent_node; 419 420 /* Keep count of device/processor/thermal objects */ 421 422 node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle); 423 if ((node->type == ACPI_TYPE_DEVICE) || 424 (node->type == ACPI_TYPE_PROCESSOR) || 425 (node->type == ACPI_TYPE_THERMAL)) { 426 info->device_count++; 427 return (AE_OK); 428 } 429 430 /* We are only looking for methods named _INI */ 431 432 if (!ACPI_COMPARE_NAME(node->name.ascii, METHOD_NAME__INI)) { 433 return (AE_OK); 434 } 435 436 /* 437 * The only _INI methods that we care about are those that are 438 * present under Device, Processor, and Thermal objects. 439 */ 440 parent_node = node->parent; 441 switch (parent_node->type) { 442 case ACPI_TYPE_DEVICE: 443 case ACPI_TYPE_PROCESSOR: 444 case ACPI_TYPE_THERMAL: 445 446 /* Mark parent and bubble up the INI present flag to the root */ 447 448 while (parent_node) { 449 parent_node->flags |= ANOBJ_SUBTREE_HAS_INI; 450 parent_node = parent_node->parent; 451 } 452 break; 453 454 default: 455 456 break; 457 } 458 459 return (AE_OK); 460 } 461 462 /******************************************************************************* 463 * 464 * FUNCTION: acpi_ns_init_one_device 465 * 466 * PARAMETERS: acpi_walk_callback 467 * 468 * RETURN: acpi_status 469 * 470 * DESCRIPTION: This is called once per device soon after ACPI is enabled 471 * to initialize each device. It determines if the device is 472 * present, and if so, calls _INI. 473 * 474 ******************************************************************************/ 475 476 static acpi_status 477 acpi_ns_init_one_device(acpi_handle obj_handle, 478 u32 nesting_level, void *context, void **return_value) 479 { 480 struct acpi_device_walk_info *walk_info = 481 ACPI_CAST_PTR(struct acpi_device_walk_info, context); 482 struct acpi_evaluate_info *info = walk_info->evaluate_info; 483 u32 flags; 484 acpi_status status; 485 struct acpi_namespace_node *device_node; 486 487 ACPI_FUNCTION_TRACE(ns_init_one_device); 488 489 /* We are interested in Devices, Processors and thermal_zones only */ 490 491 device_node = ACPI_CAST_PTR(struct acpi_namespace_node, obj_handle); 492 if ((device_node->type != ACPI_TYPE_DEVICE) && 493 (device_node->type != ACPI_TYPE_PROCESSOR) && 494 (device_node->type != ACPI_TYPE_THERMAL)) { 495 return_ACPI_STATUS(AE_OK); 496 } 497 498 /* 499 * Because of an earlier namespace analysis, all subtrees that contain an 500 * _INI method are tagged. 501 * 502 * If this device subtree does not contain any _INI methods, we 503 * can exit now and stop traversing this entire subtree. 504 */ 505 if (!(device_node->flags & ANOBJ_SUBTREE_HAS_INI)) { 506 return_ACPI_STATUS(AE_CTRL_DEPTH); 507 } 508 509 /* 510 * Run _STA to determine if this device is present and functioning. We 511 * must know this information for two important reasons (from ACPI spec): 512 * 513 * 1) We can only run _INI if the device is present. 514 * 2) We must abort the device tree walk on this subtree if the device is 515 * not present and is not functional (we will not examine the children) 516 * 517 * The _STA method is not required to be present under the device, we 518 * assume the device is present if _STA does not exist. 519 */ 520 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname 521 (ACPI_TYPE_METHOD, device_node, METHOD_NAME__STA)); 522 523 status = acpi_ut_execute_STA(device_node, &flags); 524 if (ACPI_FAILURE(status)) { 525 526 /* Ignore error and move on to next device */ 527 528 return_ACPI_STATUS(AE_OK); 529 } 530 531 /* 532 * Flags == -1 means that _STA was not found. In this case, we assume that 533 * the device is both present and functional. 534 * 535 * From the ACPI spec, description of _STA: 536 * 537 * "If a device object (including the processor object) does not have an 538 * _STA object, then OSPM assumes that all of the above bits are set (in 539 * other words, the device is present, ..., and functioning)" 540 */ 541 if (flags != ACPI_UINT32_MAX) { 542 walk_info->num_STA++; 543 } 544 545 /* 546 * Examine the PRESENT and FUNCTIONING status bits 547 * 548 * Note: ACPI spec does not seem to specify behavior for the present but 549 * not functioning case, so we assume functioning if present. 550 */ 551 if (!(flags & ACPI_STA_DEVICE_PRESENT)) { 552 553 /* Device is not present, we must examine the Functioning bit */ 554 555 if (flags & ACPI_STA_DEVICE_FUNCTIONING) { 556 /* 557 * Device is not present but is "functioning". In this case, 558 * we will not run _INI, but we continue to examine the children 559 * of this device. 560 * 561 * From the ACPI spec, description of _STA: (note - no mention 562 * of whether to run _INI or not on the device in question) 563 * 564 * "_STA may return bit 0 clear (not present) with bit 3 set 565 * (device is functional). This case is used to indicate a valid 566 * device for which no device driver should be loaded (for example, 567 * a bridge device.) Children of this device may be present and 568 * valid. OSPM should continue enumeration below a device whose 569 * _STA returns this bit combination" 570 */ 571 return_ACPI_STATUS(AE_OK); 572 } else { 573 /* 574 * Device is not present and is not functioning. We must abort the 575 * walk of this subtree immediately -- don't look at the children 576 * of such a device. 577 * 578 * From the ACPI spec, description of _INI: 579 * 580 * "If the _STA method indicates that the device is not present, 581 * OSPM will not run the _INI and will not examine the children 582 * of the device for _INI methods" 583 */ 584 return_ACPI_STATUS(AE_CTRL_DEPTH); 585 } 586 } 587 588 /* 589 * The device is present or is assumed present if no _STA exists. 590 * Run the _INI if it exists (not required to exist) 591 * 592 * Note: We know there is an _INI within this subtree, but it may not be 593 * under this particular device, it may be lower in the branch. 594 */ 595 ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname 596 (ACPI_TYPE_METHOD, device_node, METHOD_NAME__INI)); 597 598 memset(info, 0, sizeof(struct acpi_evaluate_info)); 599 info->prefix_node = device_node; 600 info->relative_pathname = METHOD_NAME__INI; 601 info->parameters = NULL; 602 info->flags = ACPI_IGNORE_RETURN_VALUE; 603 604 status = acpi_ns_evaluate(info); 605 606 if (ACPI_SUCCESS(status)) { 607 walk_info->num_INI++; 608 } 609 #ifdef ACPI_DEBUG_OUTPUT 610 else if (status != AE_NOT_FOUND) { 611 612 /* Ignore error and move on to next device */ 613 614 char *scope_name = 615 acpi_ns_get_normalized_pathname(device_node, TRUE); 616 617 ACPI_EXCEPTION((AE_INFO, status, "during %s._INI execution", 618 scope_name)); 619 ACPI_FREE(scope_name); 620 } 621 #endif 622 623 /* Ignore errors from above */ 624 625 status = AE_OK; 626 627 /* 628 * The _INI method has been run if present; call the Global Initialization 629 * Handler for this device. 630 */ 631 if (acpi_gbl_init_handler) { 632 status = 633 acpi_gbl_init_handler(device_node, ACPI_INIT_DEVICE_INI); 634 } 635 636 return_ACPI_STATUS(status); 637 } 638