1 /* 2 * acpi_bus.c - ACPI Bus Driver ($Revision: 80 $) 3 * 4 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 5 * 6 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation; either version 2 of the License, or (at 11 * your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, but 14 * WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * General Public License for more details. 17 * 18 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 19 */ 20 21 #include <linux/module.h> 22 #include <linux/init.h> 23 #include <linux/ioport.h> 24 #include <linux/kernel.h> 25 #include <linux/list.h> 26 #include <linux/sched.h> 27 #include <linux/pm.h> 28 #include <linux/device.h> 29 #include <linux/proc_fs.h> 30 #include <linux/acpi.h> 31 #include <linux/slab.h> 32 #include <linux/regulator/machine.h> 33 #include <linux/workqueue.h> 34 #include <linux/reboot.h> 35 #include <linux/delay.h> 36 #ifdef CONFIG_X86 37 #include <asm/mpspec.h> 38 #endif 39 #include <linux/acpi_iort.h> 40 #include <linux/pci.h> 41 #include <acpi/apei.h> 42 #include <linux/dmi.h> 43 #include <linux/suspend.h> 44 45 #include "internal.h" 46 47 #define _COMPONENT ACPI_BUS_COMPONENT 48 ACPI_MODULE_NAME("bus"); 49 50 struct acpi_device *acpi_root; 51 struct proc_dir_entry *acpi_root_dir; 52 EXPORT_SYMBOL(acpi_root_dir); 53 54 #ifdef CONFIG_X86 55 #ifdef CONFIG_ACPI_CUSTOM_DSDT 56 static inline int set_copy_dsdt(const struct dmi_system_id *id) 57 { 58 return 0; 59 } 60 #else 61 static int set_copy_dsdt(const struct dmi_system_id *id) 62 { 63 printk(KERN_NOTICE "%s detected - " 64 "force copy of DSDT to local memory\n", id->ident); 65 acpi_gbl_copy_dsdt_locally = 1; 66 return 0; 67 } 68 #endif 69 static int set_gbl_term_list(const struct dmi_system_id *id) 70 { 71 acpi_gbl_execute_tables_as_methods = 1; 72 return 0; 73 } 74 75 static const struct dmi_system_id acpi_quirks_dmi_table[] __initconst = { 76 /* 77 * Touchpad on Dell XPS 9570/Precision M5530 doesn't work under I2C 78 * mode. 79 * https://bugzilla.kernel.org/show_bug.cgi?id=198515 80 */ 81 { 82 .callback = set_gbl_term_list, 83 .ident = "Dell Precision M5530", 84 .matches = { 85 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."), 86 DMI_MATCH(DMI_PRODUCT_NAME, "Precision M5530"), 87 }, 88 }, 89 { 90 .callback = set_gbl_term_list, 91 .ident = "Dell XPS 15 9570", 92 .matches = { 93 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."), 94 DMI_MATCH(DMI_PRODUCT_NAME, "XPS 15 9570"), 95 }, 96 }, 97 /* 98 * Invoke DSDT corruption work-around on all Toshiba Satellite. 99 * DSDT will be copied to memory. 100 * https://bugzilla.kernel.org/show_bug.cgi?id=14679 101 */ 102 { 103 .callback = set_copy_dsdt, 104 .ident = "TOSHIBA Satellite", 105 .matches = { 106 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"), 107 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"), 108 }, 109 }, 110 {} 111 }; 112 #else 113 static const struct dmi_system_id acpi_quirks_dmi_table[] __initconst = { 114 {} 115 }; 116 #endif 117 118 /* -------------------------------------------------------------------------- 119 Device Management 120 -------------------------------------------------------------------------- */ 121 122 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 123 unsigned long long *sta) 124 { 125 acpi_status status; 126 127 status = acpi_evaluate_integer(handle, "_STA", NULL, sta); 128 if (ACPI_SUCCESS(status)) 129 return AE_OK; 130 131 if (status == AE_NOT_FOUND) { 132 *sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED | 133 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING; 134 return AE_OK; 135 } 136 return status; 137 } 138 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle); 139 140 int acpi_bus_get_status(struct acpi_device *device) 141 { 142 acpi_status status; 143 unsigned long long sta; 144 145 if (acpi_device_always_present(device)) { 146 acpi_set_device_status(device, ACPI_STA_DEFAULT); 147 return 0; 148 } 149 150 /* Battery devices must have their deps met before calling _STA */ 151 if (acpi_device_is_battery(device) && device->dep_unmet) { 152 acpi_set_device_status(device, 0); 153 return 0; 154 } 155 156 status = acpi_bus_get_status_handle(device->handle, &sta); 157 if (ACPI_FAILURE(status)) 158 return -ENODEV; 159 160 acpi_set_device_status(device, sta); 161 162 if (device->status.functional && !device->status.present) { 163 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]: " 164 "functional but not present;\n", 165 device->pnp.bus_id, (u32)sta)); 166 } 167 168 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] status [%08x]\n", 169 device->pnp.bus_id, (u32)sta)); 170 return 0; 171 } 172 EXPORT_SYMBOL(acpi_bus_get_status); 173 174 void acpi_bus_private_data_handler(acpi_handle handle, 175 void *context) 176 { 177 return; 178 } 179 EXPORT_SYMBOL(acpi_bus_private_data_handler); 180 181 int acpi_bus_attach_private_data(acpi_handle handle, void *data) 182 { 183 acpi_status status; 184 185 status = acpi_attach_data(handle, 186 acpi_bus_private_data_handler, data); 187 if (ACPI_FAILURE(status)) { 188 acpi_handle_debug(handle, "Error attaching device data\n"); 189 return -ENODEV; 190 } 191 192 return 0; 193 } 194 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data); 195 196 int acpi_bus_get_private_data(acpi_handle handle, void **data) 197 { 198 acpi_status status; 199 200 if (!*data) 201 return -EINVAL; 202 203 status = acpi_get_data(handle, acpi_bus_private_data_handler, data); 204 if (ACPI_FAILURE(status)) { 205 acpi_handle_debug(handle, "No context for object\n"); 206 return -ENODEV; 207 } 208 209 return 0; 210 } 211 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data); 212 213 void acpi_bus_detach_private_data(acpi_handle handle) 214 { 215 acpi_detach_data(handle, acpi_bus_private_data_handler); 216 } 217 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data); 218 219 static void acpi_print_osc_error(acpi_handle handle, 220 struct acpi_osc_context *context, char *error) 221 { 222 int i; 223 224 acpi_handle_debug(handle, "(%s): %s\n", context->uuid_str, error); 225 226 pr_debug("_OSC request data:"); 227 for (i = 0; i < context->cap.length; i += sizeof(u32)) 228 pr_debug(" %x", *((u32 *)(context->cap.pointer + i))); 229 230 pr_debug("\n"); 231 } 232 233 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context) 234 { 235 acpi_status status; 236 struct acpi_object_list input; 237 union acpi_object in_params[4]; 238 union acpi_object *out_obj; 239 guid_t guid; 240 u32 errors; 241 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL}; 242 243 if (!context) 244 return AE_ERROR; 245 if (guid_parse(context->uuid_str, &guid)) 246 return AE_ERROR; 247 context->ret.length = ACPI_ALLOCATE_BUFFER; 248 context->ret.pointer = NULL; 249 250 /* Setting up input parameters */ 251 input.count = 4; 252 input.pointer = in_params; 253 in_params[0].type = ACPI_TYPE_BUFFER; 254 in_params[0].buffer.length = 16; 255 in_params[0].buffer.pointer = (u8 *)&guid; 256 in_params[1].type = ACPI_TYPE_INTEGER; 257 in_params[1].integer.value = context->rev; 258 in_params[2].type = ACPI_TYPE_INTEGER; 259 in_params[2].integer.value = context->cap.length/sizeof(u32); 260 in_params[3].type = ACPI_TYPE_BUFFER; 261 in_params[3].buffer.length = context->cap.length; 262 in_params[3].buffer.pointer = context->cap.pointer; 263 264 status = acpi_evaluate_object(handle, "_OSC", &input, &output); 265 if (ACPI_FAILURE(status)) 266 return status; 267 268 if (!output.length) 269 return AE_NULL_OBJECT; 270 271 out_obj = output.pointer; 272 if (out_obj->type != ACPI_TYPE_BUFFER 273 || out_obj->buffer.length != context->cap.length) { 274 acpi_print_osc_error(handle, context, 275 "_OSC evaluation returned wrong type"); 276 status = AE_TYPE; 277 goto out_kfree; 278 } 279 /* Need to ignore the bit0 in result code */ 280 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0); 281 if (errors) { 282 if (errors & OSC_REQUEST_ERROR) 283 acpi_print_osc_error(handle, context, 284 "_OSC request failed"); 285 if (errors & OSC_INVALID_UUID_ERROR) 286 acpi_print_osc_error(handle, context, 287 "_OSC invalid UUID"); 288 if (errors & OSC_INVALID_REVISION_ERROR) 289 acpi_print_osc_error(handle, context, 290 "_OSC invalid revision"); 291 if (errors & OSC_CAPABILITIES_MASK_ERROR) { 292 if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD] 293 & OSC_QUERY_ENABLE) 294 goto out_success; 295 status = AE_SUPPORT; 296 goto out_kfree; 297 } 298 status = AE_ERROR; 299 goto out_kfree; 300 } 301 out_success: 302 context->ret.length = out_obj->buffer.length; 303 context->ret.pointer = kmemdup(out_obj->buffer.pointer, 304 context->ret.length, GFP_KERNEL); 305 if (!context->ret.pointer) { 306 status = AE_NO_MEMORY; 307 goto out_kfree; 308 } 309 status = AE_OK; 310 311 out_kfree: 312 kfree(output.pointer); 313 if (status != AE_OK) 314 context->ret.pointer = NULL; 315 return status; 316 } 317 EXPORT_SYMBOL(acpi_run_osc); 318 319 bool osc_sb_apei_support_acked; 320 321 /* 322 * ACPI 6.0 Section 8.4.4.2 Idle State Coordination 323 * OSPM supports platform coordinated low power idle(LPI) states 324 */ 325 bool osc_pc_lpi_support_confirmed; 326 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed); 327 328 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48"; 329 static void acpi_bus_osc_support(void) 330 { 331 u32 capbuf[2]; 332 struct acpi_osc_context context = { 333 .uuid_str = sb_uuid_str, 334 .rev = 1, 335 .cap.length = 8, 336 .cap.pointer = capbuf, 337 }; 338 acpi_handle handle; 339 340 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE; 341 capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */ 342 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR)) 343 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT; 344 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR)) 345 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT; 346 347 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT; 348 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PCLPI_SUPPORT; 349 350 #ifdef CONFIG_X86 351 if (boot_cpu_has(X86_FEATURE_HWP)) { 352 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_SUPPORT; 353 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPCV2_SUPPORT; 354 } 355 #endif 356 357 if (IS_ENABLED(CONFIG_SCHED_MC_PRIO)) 358 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT; 359 360 if (!ghes_disable) 361 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT; 362 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle))) 363 return; 364 if (ACPI_SUCCESS(acpi_run_osc(handle, &context))) { 365 u32 *capbuf_ret = context.ret.pointer; 366 if (context.ret.length > OSC_SUPPORT_DWORD) { 367 osc_sb_apei_support_acked = 368 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT; 369 osc_pc_lpi_support_confirmed = 370 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT; 371 } 372 kfree(context.ret.pointer); 373 } 374 /* do we need to check other returned cap? Sounds no */ 375 } 376 377 /* -------------------------------------------------------------------------- 378 Notification Handling 379 -------------------------------------------------------------------------- */ 380 381 /** 382 * acpi_bus_notify 383 * --------------- 384 * Callback for all 'system-level' device notifications (values 0x00-0x7F). 385 */ 386 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data) 387 { 388 struct acpi_device *adev; 389 struct acpi_driver *driver; 390 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; 391 bool hotplug_event = false; 392 393 switch (type) { 394 case ACPI_NOTIFY_BUS_CHECK: 395 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n"); 396 hotplug_event = true; 397 break; 398 399 case ACPI_NOTIFY_DEVICE_CHECK: 400 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n"); 401 hotplug_event = true; 402 break; 403 404 case ACPI_NOTIFY_DEVICE_WAKE: 405 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n"); 406 break; 407 408 case ACPI_NOTIFY_EJECT_REQUEST: 409 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n"); 410 hotplug_event = true; 411 break; 412 413 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT: 414 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n"); 415 /* TBD: Exactly what does 'light' mean? */ 416 break; 417 418 case ACPI_NOTIFY_FREQUENCY_MISMATCH: 419 acpi_handle_err(handle, "Device cannot be configured due " 420 "to a frequency mismatch\n"); 421 break; 422 423 case ACPI_NOTIFY_BUS_MODE_MISMATCH: 424 acpi_handle_err(handle, "Device cannot be configured due " 425 "to a bus mode mismatch\n"); 426 break; 427 428 case ACPI_NOTIFY_POWER_FAULT: 429 acpi_handle_err(handle, "Device has suffered a power fault\n"); 430 break; 431 432 default: 433 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type); 434 break; 435 } 436 437 adev = acpi_bus_get_acpi_device(handle); 438 if (!adev) 439 goto err; 440 441 driver = adev->driver; 442 if (driver && driver->ops.notify && 443 (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS)) 444 driver->ops.notify(adev, type); 445 446 if (!hotplug_event) { 447 acpi_bus_put_acpi_device(adev); 448 return; 449 } 450 451 if (ACPI_SUCCESS(acpi_hotplug_schedule(adev, type))) 452 return; 453 454 acpi_bus_put_acpi_device(adev); 455 456 err: 457 acpi_evaluate_ost(handle, type, ost_code, NULL); 458 } 459 460 static void acpi_device_notify(acpi_handle handle, u32 event, void *data) 461 { 462 struct acpi_device *device = data; 463 464 device->driver->ops.notify(device, event); 465 } 466 467 static void acpi_device_notify_fixed(void *data) 468 { 469 struct acpi_device *device = data; 470 471 /* Fixed hardware devices have no handles */ 472 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device); 473 } 474 475 static u32 acpi_device_fixed_event(void *data) 476 { 477 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_device_notify_fixed, data); 478 return ACPI_INTERRUPT_HANDLED; 479 } 480 481 static int acpi_device_install_notify_handler(struct acpi_device *device) 482 { 483 acpi_status status; 484 485 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON) 486 status = 487 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON, 488 acpi_device_fixed_event, 489 device); 490 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON) 491 status = 492 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON, 493 acpi_device_fixed_event, 494 device); 495 else 496 status = acpi_install_notify_handler(device->handle, 497 ACPI_DEVICE_NOTIFY, 498 acpi_device_notify, 499 device); 500 501 if (ACPI_FAILURE(status)) 502 return -EINVAL; 503 return 0; 504 } 505 506 static void acpi_device_remove_notify_handler(struct acpi_device *device) 507 { 508 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON) 509 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON, 510 acpi_device_fixed_event); 511 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON) 512 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON, 513 acpi_device_fixed_event); 514 else 515 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY, 516 acpi_device_notify); 517 } 518 519 /* Handle events targeting \_SB device (at present only graceful shutdown) */ 520 521 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81 522 #define ACPI_SB_INDICATE_INTERVAL 10000 523 524 static void sb_notify_work(struct work_struct *dummy) 525 { 526 acpi_handle sb_handle; 527 528 orderly_poweroff(true); 529 530 /* 531 * After initiating graceful shutdown, the ACPI spec requires OSPM 532 * to evaluate _OST method once every 10seconds to indicate that 533 * the shutdown is in progress 534 */ 535 acpi_get_handle(NULL, "\\_SB", &sb_handle); 536 while (1) { 537 pr_info("Graceful shutdown in progress.\n"); 538 acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN, 539 ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL); 540 msleep(ACPI_SB_INDICATE_INTERVAL); 541 } 542 } 543 544 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data) 545 { 546 static DECLARE_WORK(acpi_sb_work, sb_notify_work); 547 548 if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) { 549 if (!work_busy(&acpi_sb_work)) 550 schedule_work(&acpi_sb_work); 551 } else 552 pr_warn("event %x is not supported by \\_SB device\n", event); 553 } 554 555 static int __init acpi_setup_sb_notify_handler(void) 556 { 557 acpi_handle sb_handle; 558 559 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle))) 560 return -ENXIO; 561 562 if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY, 563 acpi_sb_notify, NULL))) 564 return -EINVAL; 565 566 return 0; 567 } 568 569 /* -------------------------------------------------------------------------- 570 Device Matching 571 -------------------------------------------------------------------------- */ 572 573 /** 574 * acpi_get_first_physical_node - Get first physical node of an ACPI device 575 * @adev: ACPI device in question 576 * 577 * Return: First physical node of ACPI device @adev 578 */ 579 struct device *acpi_get_first_physical_node(struct acpi_device *adev) 580 { 581 struct mutex *physical_node_lock = &adev->physical_node_lock; 582 struct device *phys_dev; 583 584 mutex_lock(physical_node_lock); 585 if (list_empty(&adev->physical_node_list)) { 586 phys_dev = NULL; 587 } else { 588 const struct acpi_device_physical_node *node; 589 590 node = list_first_entry(&adev->physical_node_list, 591 struct acpi_device_physical_node, node); 592 593 phys_dev = node->dev; 594 } 595 mutex_unlock(physical_node_lock); 596 return phys_dev; 597 } 598 599 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev, 600 const struct device *dev) 601 { 602 const struct device *phys_dev = acpi_get_first_physical_node(adev); 603 604 return phys_dev && phys_dev == dev ? adev : NULL; 605 } 606 607 /** 608 * acpi_device_is_first_physical_node - Is given dev first physical node 609 * @adev: ACPI companion device 610 * @dev: Physical device to check 611 * 612 * Function checks if given @dev is the first physical devices attached to 613 * the ACPI companion device. This distinction is needed in some cases 614 * where the same companion device is shared between many physical devices. 615 * 616 * Note that the caller have to provide valid @adev pointer. 617 */ 618 bool acpi_device_is_first_physical_node(struct acpi_device *adev, 619 const struct device *dev) 620 { 621 return !!acpi_primary_dev_companion(adev, dev); 622 } 623 624 /* 625 * acpi_companion_match() - Can we match via ACPI companion device 626 * @dev: Device in question 627 * 628 * Check if the given device has an ACPI companion and if that companion has 629 * a valid list of PNP IDs, and if the device is the first (primary) physical 630 * device associated with it. Return the companion pointer if that's the case 631 * or NULL otherwise. 632 * 633 * If multiple physical devices are attached to a single ACPI companion, we need 634 * to be careful. The usage scenario for this kind of relationship is that all 635 * of the physical devices in question use resources provided by the ACPI 636 * companion. A typical case is an MFD device where all the sub-devices share 637 * the parent's ACPI companion. In such cases we can only allow the primary 638 * (first) physical device to be matched with the help of the companion's PNP 639 * IDs. 640 * 641 * Additional physical devices sharing the ACPI companion can still use 642 * resources available from it but they will be matched normally using functions 643 * provided by their bus types (and analogously for their modalias). 644 */ 645 struct acpi_device *acpi_companion_match(const struct device *dev) 646 { 647 struct acpi_device *adev; 648 649 adev = ACPI_COMPANION(dev); 650 if (!adev) 651 return NULL; 652 653 if (list_empty(&adev->pnp.ids)) 654 return NULL; 655 656 return acpi_primary_dev_companion(adev, dev); 657 } 658 659 /** 660 * acpi_of_match_device - Match device object using the "compatible" property. 661 * @adev: ACPI device object to match. 662 * @of_match_table: List of device IDs to match against. 663 * @of_id: OF ID if matched 664 * 665 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of 666 * identifiers and a _DSD object with the "compatible" property, use that 667 * property to match against the given list of identifiers. 668 */ 669 static bool acpi_of_match_device(struct acpi_device *adev, 670 const struct of_device_id *of_match_table, 671 const struct of_device_id **of_id) 672 { 673 const union acpi_object *of_compatible, *obj; 674 int i, nval; 675 676 if (!adev) 677 return false; 678 679 of_compatible = adev->data.of_compatible; 680 if (!of_match_table || !of_compatible) 681 return false; 682 683 if (of_compatible->type == ACPI_TYPE_PACKAGE) { 684 nval = of_compatible->package.count; 685 obj = of_compatible->package.elements; 686 } else { /* Must be ACPI_TYPE_STRING. */ 687 nval = 1; 688 obj = of_compatible; 689 } 690 /* Now we can look for the driver DT compatible strings */ 691 for (i = 0; i < nval; i++, obj++) { 692 const struct of_device_id *id; 693 694 for (id = of_match_table; id->compatible[0]; id++) 695 if (!strcasecmp(obj->string.pointer, id->compatible)) { 696 if (of_id) 697 *of_id = id; 698 return true; 699 } 700 } 701 702 return false; 703 } 704 705 static bool acpi_of_modalias(struct acpi_device *adev, 706 char *modalias, size_t len) 707 { 708 const union acpi_object *of_compatible; 709 const union acpi_object *obj; 710 const char *str, *chr; 711 712 of_compatible = adev->data.of_compatible; 713 if (!of_compatible) 714 return false; 715 716 if (of_compatible->type == ACPI_TYPE_PACKAGE) 717 obj = of_compatible->package.elements; 718 else /* Must be ACPI_TYPE_STRING. */ 719 obj = of_compatible; 720 721 str = obj->string.pointer; 722 chr = strchr(str, ','); 723 strlcpy(modalias, chr ? chr + 1 : str, len); 724 725 return true; 726 } 727 728 /** 729 * acpi_set_modalias - Set modalias using "compatible" property or supplied ID 730 * @adev: ACPI device object to match 731 * @default_id: ID string to use as default if no compatible string found 732 * @modalias: Pointer to buffer that modalias value will be copied into 733 * @len: Length of modalias buffer 734 * 735 * This is a counterpart of of_modalias_node() for struct acpi_device objects. 736 * If there is a compatible string for @adev, it will be copied to @modalias 737 * with the vendor prefix stripped; otherwise, @default_id will be used. 738 */ 739 void acpi_set_modalias(struct acpi_device *adev, const char *default_id, 740 char *modalias, size_t len) 741 { 742 if (!acpi_of_modalias(adev, modalias, len)) 743 strlcpy(modalias, default_id, len); 744 } 745 EXPORT_SYMBOL_GPL(acpi_set_modalias); 746 747 static bool __acpi_match_device_cls(const struct acpi_device_id *id, 748 struct acpi_hardware_id *hwid) 749 { 750 int i, msk, byte_shift; 751 char buf[3]; 752 753 if (!id->cls) 754 return false; 755 756 /* Apply class-code bitmask, before checking each class-code byte */ 757 for (i = 1; i <= 3; i++) { 758 byte_shift = 8 * (3 - i); 759 msk = (id->cls_msk >> byte_shift) & 0xFF; 760 if (!msk) 761 continue; 762 763 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk); 764 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2)) 765 return false; 766 } 767 return true; 768 } 769 770 static bool __acpi_match_device(struct acpi_device *device, 771 const struct acpi_device_id *acpi_ids, 772 const struct of_device_id *of_ids, 773 const struct acpi_device_id **acpi_id, 774 const struct of_device_id **of_id) 775 { 776 const struct acpi_device_id *id; 777 struct acpi_hardware_id *hwid; 778 779 /* 780 * If the device is not present, it is unnecessary to load device 781 * driver for it. 782 */ 783 if (!device || !device->status.present) 784 return false; 785 786 list_for_each_entry(hwid, &device->pnp.ids, list) { 787 /* First, check the ACPI/PNP IDs provided by the caller. */ 788 if (acpi_ids) { 789 for (id = acpi_ids; id->id[0] || id->cls; id++) { 790 if (id->id[0] && !strcmp((char *)id->id, hwid->id)) 791 goto out_acpi_match; 792 if (id->cls && __acpi_match_device_cls(id, hwid)) 793 goto out_acpi_match; 794 } 795 } 796 797 /* 798 * Next, check ACPI_DT_NAMESPACE_HID and try to match the 799 * "compatible" property if found. 800 */ 801 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id)) 802 return acpi_of_match_device(device, of_ids, of_id); 803 } 804 return false; 805 806 out_acpi_match: 807 if (acpi_id) 808 *acpi_id = id; 809 return true; 810 } 811 812 /** 813 * acpi_match_device - Match a struct device against a given list of ACPI IDs 814 * @ids: Array of struct acpi_device_id object to match against. 815 * @dev: The device structure to match. 816 * 817 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device 818 * object for that handle and use that object to match against a given list of 819 * device IDs. 820 * 821 * Return a pointer to the first matching ID on success or %NULL on failure. 822 */ 823 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids, 824 const struct device *dev) 825 { 826 const struct acpi_device_id *id = NULL; 827 828 __acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL); 829 return id; 830 } 831 EXPORT_SYMBOL_GPL(acpi_match_device); 832 833 const void *acpi_device_get_match_data(const struct device *dev) 834 { 835 const struct acpi_device_id *match; 836 837 match = acpi_match_device(dev->driver->acpi_match_table, dev); 838 if (!match) 839 return NULL; 840 841 return (const void *)match->driver_data; 842 } 843 EXPORT_SYMBOL_GPL(acpi_device_get_match_data); 844 845 int acpi_match_device_ids(struct acpi_device *device, 846 const struct acpi_device_id *ids) 847 { 848 return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT; 849 } 850 EXPORT_SYMBOL(acpi_match_device_ids); 851 852 bool acpi_driver_match_device(struct device *dev, 853 const struct device_driver *drv) 854 { 855 if (!drv->acpi_match_table) 856 return acpi_of_match_device(ACPI_COMPANION(dev), 857 drv->of_match_table, 858 NULL); 859 860 return __acpi_match_device(acpi_companion_match(dev), 861 drv->acpi_match_table, drv->of_match_table, 862 NULL, NULL); 863 } 864 EXPORT_SYMBOL_GPL(acpi_driver_match_device); 865 866 /* -------------------------------------------------------------------------- 867 ACPI Driver Management 868 -------------------------------------------------------------------------- */ 869 870 /** 871 * acpi_bus_register_driver - register a driver with the ACPI bus 872 * @driver: driver being registered 873 * 874 * Registers a driver with the ACPI bus. Searches the namespace for all 875 * devices that match the driver's criteria and binds. Returns zero for 876 * success or a negative error status for failure. 877 */ 878 int acpi_bus_register_driver(struct acpi_driver *driver) 879 { 880 int ret; 881 882 if (acpi_disabled) 883 return -ENODEV; 884 driver->drv.name = driver->name; 885 driver->drv.bus = &acpi_bus_type; 886 driver->drv.owner = driver->owner; 887 888 ret = driver_register(&driver->drv); 889 return ret; 890 } 891 892 EXPORT_SYMBOL(acpi_bus_register_driver); 893 894 /** 895 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus 896 * @driver: driver to unregister 897 * 898 * Unregisters a driver with the ACPI bus. Searches the namespace for all 899 * devices that match the driver's criteria and unbinds. 900 */ 901 void acpi_bus_unregister_driver(struct acpi_driver *driver) 902 { 903 driver_unregister(&driver->drv); 904 } 905 906 EXPORT_SYMBOL(acpi_bus_unregister_driver); 907 908 /* -------------------------------------------------------------------------- 909 ACPI Bus operations 910 -------------------------------------------------------------------------- */ 911 912 static int acpi_bus_match(struct device *dev, struct device_driver *drv) 913 { 914 struct acpi_device *acpi_dev = to_acpi_device(dev); 915 struct acpi_driver *acpi_drv = to_acpi_driver(drv); 916 917 return acpi_dev->flags.match_driver 918 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids); 919 } 920 921 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env) 922 { 923 return __acpi_device_uevent_modalias(to_acpi_device(dev), env); 924 } 925 926 static int acpi_device_probe(struct device *dev) 927 { 928 struct acpi_device *acpi_dev = to_acpi_device(dev); 929 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver); 930 int ret; 931 932 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev)) 933 return -EINVAL; 934 935 if (!acpi_drv->ops.add) 936 return -ENOSYS; 937 938 ret = acpi_drv->ops.add(acpi_dev); 939 if (ret) 940 return ret; 941 942 acpi_dev->driver = acpi_drv; 943 ACPI_DEBUG_PRINT((ACPI_DB_INFO, 944 "Driver [%s] successfully bound to device [%s]\n", 945 acpi_drv->name, acpi_dev->pnp.bus_id)); 946 947 if (acpi_drv->ops.notify) { 948 ret = acpi_device_install_notify_handler(acpi_dev); 949 if (ret) { 950 if (acpi_drv->ops.remove) 951 acpi_drv->ops.remove(acpi_dev); 952 953 acpi_dev->driver = NULL; 954 acpi_dev->driver_data = NULL; 955 return ret; 956 } 957 } 958 959 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found driver [%s] for device [%s]\n", 960 acpi_drv->name, acpi_dev->pnp.bus_id)); 961 get_device(dev); 962 return 0; 963 } 964 965 static int acpi_device_remove(struct device * dev) 966 { 967 struct acpi_device *acpi_dev = to_acpi_device(dev); 968 struct acpi_driver *acpi_drv = acpi_dev->driver; 969 970 if (acpi_drv) { 971 if (acpi_drv->ops.notify) 972 acpi_device_remove_notify_handler(acpi_dev); 973 if (acpi_drv->ops.remove) 974 acpi_drv->ops.remove(acpi_dev); 975 } 976 acpi_dev->driver = NULL; 977 acpi_dev->driver_data = NULL; 978 979 put_device(dev); 980 return 0; 981 } 982 983 struct bus_type acpi_bus_type = { 984 .name = "acpi", 985 .match = acpi_bus_match, 986 .probe = acpi_device_probe, 987 .remove = acpi_device_remove, 988 .uevent = acpi_device_uevent, 989 }; 990 991 /* -------------------------------------------------------------------------- 992 Initialization/Cleanup 993 -------------------------------------------------------------------------- */ 994 995 static int __init acpi_bus_init_irq(void) 996 { 997 acpi_status status; 998 char *message = NULL; 999 1000 1001 /* 1002 * Let the system know what interrupt model we are using by 1003 * evaluating the \_PIC object, if exists. 1004 */ 1005 1006 switch (acpi_irq_model) { 1007 case ACPI_IRQ_MODEL_PIC: 1008 message = "PIC"; 1009 break; 1010 case ACPI_IRQ_MODEL_IOAPIC: 1011 message = "IOAPIC"; 1012 break; 1013 case ACPI_IRQ_MODEL_IOSAPIC: 1014 message = "IOSAPIC"; 1015 break; 1016 case ACPI_IRQ_MODEL_GIC: 1017 message = "GIC"; 1018 break; 1019 case ACPI_IRQ_MODEL_PLATFORM: 1020 message = "platform specific model"; 1021 break; 1022 default: 1023 printk(KERN_WARNING PREFIX "Unknown interrupt routing model\n"); 1024 return -ENODEV; 1025 } 1026 1027 printk(KERN_INFO PREFIX "Using %s for interrupt routing\n", message); 1028 1029 status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model); 1030 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) { 1031 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PIC")); 1032 return -ENODEV; 1033 } 1034 1035 return 0; 1036 } 1037 1038 /** 1039 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace. 1040 * 1041 * The ACPI tables are accessible after this, but the handling of events has not 1042 * been initialized and the global lock is not available yet, so AML should not 1043 * be executed at this point. 1044 * 1045 * Doing this before switching the EFI runtime services to virtual mode allows 1046 * the EfiBootServices memory to be freed slightly earlier on boot. 1047 */ 1048 void __init acpi_early_init(void) 1049 { 1050 acpi_status status; 1051 1052 if (acpi_disabled) 1053 return; 1054 1055 printk(KERN_INFO PREFIX "Core revision %08x\n", ACPI_CA_VERSION); 1056 1057 /* enable workarounds, unless strict ACPI spec. compliance */ 1058 if (!acpi_strict) 1059 acpi_gbl_enable_interpreter_slack = TRUE; 1060 1061 acpi_permanent_mmap = true; 1062 1063 /* Check machine-specific quirks */ 1064 dmi_check_system(acpi_quirks_dmi_table); 1065 1066 status = acpi_reallocate_root_table(); 1067 if (ACPI_FAILURE(status)) { 1068 printk(KERN_ERR PREFIX 1069 "Unable to reallocate ACPI tables\n"); 1070 goto error0; 1071 } 1072 1073 status = acpi_initialize_subsystem(); 1074 if (ACPI_FAILURE(status)) { 1075 printk(KERN_ERR PREFIX 1076 "Unable to initialize the ACPI Interpreter\n"); 1077 goto error0; 1078 } 1079 1080 if (!acpi_gbl_execute_tables_as_methods && 1081 acpi_gbl_group_module_level_code) { 1082 status = acpi_load_tables(); 1083 if (ACPI_FAILURE(status)) { 1084 printk(KERN_ERR PREFIX 1085 "Unable to load the System Description Tables\n"); 1086 goto error0; 1087 } 1088 } 1089 1090 #ifdef CONFIG_X86 1091 if (!acpi_ioapic) { 1092 /* compatible (0) means level (3) */ 1093 if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) { 1094 acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK; 1095 acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL; 1096 } 1097 /* Set PIC-mode SCI trigger type */ 1098 acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt, 1099 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2); 1100 } else { 1101 /* 1102 * now that acpi_gbl_FADT is initialized, 1103 * update it with result from INT_SRC_OVR parsing 1104 */ 1105 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi; 1106 } 1107 #endif 1108 return; 1109 1110 error0: 1111 disable_acpi(); 1112 } 1113 1114 /** 1115 * acpi_subsystem_init - Finalize the early initialization of ACPI. 1116 * 1117 * Switch over the platform to the ACPI mode (if possible). 1118 * 1119 * Doing this too early is generally unsafe, but at the same time it needs to be 1120 * done before all things that really depend on ACPI. The right spot appears to 1121 * be before finalizing the EFI initialization. 1122 */ 1123 void __init acpi_subsystem_init(void) 1124 { 1125 acpi_status status; 1126 1127 if (acpi_disabled) 1128 return; 1129 1130 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE); 1131 if (ACPI_FAILURE(status)) { 1132 printk(KERN_ERR PREFIX "Unable to enable ACPI\n"); 1133 disable_acpi(); 1134 } else { 1135 /* 1136 * If the system is using ACPI then we can be reasonably 1137 * confident that any regulators are managed by the firmware 1138 * so tell the regulator core it has everything it needs to 1139 * know. 1140 */ 1141 regulator_has_full_constraints(); 1142 } 1143 } 1144 1145 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context) 1146 { 1147 acpi_scan_table_handler(event, table, context); 1148 1149 return acpi_sysfs_table_handler(event, table, context); 1150 } 1151 1152 static int __init acpi_bus_init(void) 1153 { 1154 int result; 1155 acpi_status status; 1156 1157 acpi_os_initialize1(); 1158 1159 /* 1160 * ACPI 2.0 requires the EC driver to be loaded and work before 1161 * the EC device is found in the namespace (i.e. before 1162 * acpi_load_tables() is called). 1163 * 1164 * This is accomplished by looking for the ECDT table, and getting 1165 * the EC parameters out of that. 1166 */ 1167 status = acpi_ec_ecdt_probe(); 1168 /* Ignore result. Not having an ECDT is not fatal. */ 1169 1170 if (acpi_gbl_execute_tables_as_methods || 1171 !acpi_gbl_group_module_level_code) { 1172 status = acpi_load_tables(); 1173 if (ACPI_FAILURE(status)) { 1174 printk(KERN_ERR PREFIX 1175 "Unable to load the System Description Tables\n"); 1176 goto error1; 1177 } 1178 } 1179 1180 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE); 1181 if (ACPI_FAILURE(status)) { 1182 printk(KERN_ERR PREFIX 1183 "Unable to start the ACPI Interpreter\n"); 1184 goto error1; 1185 } 1186 1187 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION); 1188 if (ACPI_FAILURE(status)) { 1189 printk(KERN_ERR PREFIX "Unable to initialize ACPI objects\n"); 1190 goto error1; 1191 } 1192 1193 /* Set capability bits for _OSC under processor scope */ 1194 acpi_early_processor_osc(); 1195 1196 /* 1197 * _OSC method may exist in module level code, 1198 * so it must be run after ACPI_FULL_INITIALIZATION 1199 */ 1200 acpi_bus_osc_support(); 1201 1202 /* 1203 * _PDC control method may load dynamic SSDT tables, 1204 * and we need to install the table handler before that. 1205 */ 1206 status = acpi_install_table_handler(acpi_bus_table_handler, NULL); 1207 1208 acpi_sysfs_init(); 1209 1210 acpi_early_processor_set_pdc(); 1211 1212 /* 1213 * Maybe EC region is required at bus_scan/acpi_get_devices. So it 1214 * is necessary to enable it as early as possible. 1215 */ 1216 acpi_ec_dsdt_probe(); 1217 1218 printk(KERN_INFO PREFIX "Interpreter enabled\n"); 1219 1220 /* Initialize sleep structures */ 1221 acpi_sleep_init(); 1222 1223 /* 1224 * Get the system interrupt model and evaluate \_PIC. 1225 */ 1226 result = acpi_bus_init_irq(); 1227 if (result) 1228 goto error1; 1229 1230 /* 1231 * Register the for all standard device notifications. 1232 */ 1233 status = 1234 acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY, 1235 &acpi_bus_notify, NULL); 1236 if (ACPI_FAILURE(status)) { 1237 printk(KERN_ERR PREFIX 1238 "Unable to register for device notifications\n"); 1239 goto error1; 1240 } 1241 1242 /* 1243 * Create the top ACPI proc directory 1244 */ 1245 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL); 1246 1247 result = bus_register(&acpi_bus_type); 1248 if (!result) 1249 return 0; 1250 1251 /* Mimic structured exception handling */ 1252 error1: 1253 acpi_terminate(); 1254 return -ENODEV; 1255 } 1256 1257 struct kobject *acpi_kobj; 1258 EXPORT_SYMBOL_GPL(acpi_kobj); 1259 1260 static int __init acpi_init(void) 1261 { 1262 int result; 1263 1264 if (acpi_disabled) { 1265 printk(KERN_INFO PREFIX "Interpreter disabled.\n"); 1266 return -ENODEV; 1267 } 1268 1269 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj); 1270 if (!acpi_kobj) { 1271 printk(KERN_WARNING "%s: kset create error\n", __func__); 1272 acpi_kobj = NULL; 1273 } 1274 1275 init_acpi_device_notify(); 1276 result = acpi_bus_init(); 1277 if (result) { 1278 disable_acpi(); 1279 return result; 1280 } 1281 1282 pci_mmcfg_late_init(); 1283 acpi_iort_init(); 1284 acpi_scan_init(); 1285 acpi_ec_init(); 1286 acpi_debugfs_init(); 1287 acpi_sleep_proc_init(); 1288 acpi_wakeup_device_init(); 1289 acpi_debugger_init(); 1290 acpi_setup_sb_notify_handler(); 1291 return 0; 1292 } 1293 1294 subsys_initcall(acpi_init); 1295