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