1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * acpi_bus.c - ACPI Bus Driver ($Revision: 80 $)
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8 #define pr_fmt(fmt) "ACPI: " fmt
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>
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>
26 #include <asm/mpspec.h>
27 #include <linux/dmi.h>
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>
38 struct acpi_device *acpi_root;
39 struct proc_dir_entry *acpi_root_dir;
40 EXPORT_SYMBOL(acpi_root_dir);
43 #ifdef CONFIG_ACPI_CUSTOM_DSDT
44 static inline int set_copy_dsdt(const struct dmi_system_id *id)
49 static int set_copy_dsdt(const struct dmi_system_id *id)
51 pr_notice("%s detected - force copy of DSDT to local memory\n", id->ident);
52 acpi_gbl_copy_dsdt_locally = 1;
57 static const struct dmi_system_id dsdt_dmi_table[] __initconst = {
59 * Invoke DSDT corruption work-around on all Toshiba Satellite.
60 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
63 .callback = set_copy_dsdt,
64 .ident = "TOSHIBA Satellite",
66 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
67 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
74 /* --------------------------------------------------------------------------
76 -------------------------------------------------------------------------- */
78 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
79 unsigned long long *sta)
83 status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
84 if (ACPI_SUCCESS(status))
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;
94 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
96 int acpi_bus_get_status(struct acpi_device *device)
99 unsigned long long sta;
101 if (acpi_device_override_status(device, &sta)) {
102 acpi_set_device_status(device, sta);
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);
112 status = acpi_bus_get_status_handle(device->handle, &sta);
113 if (ACPI_FAILURE(status))
116 acpi_set_device_status(device, sta);
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);
123 pr_debug("Device [%s] status [%08x]\n", device->pnp.bus_id, (u32)sta);
126 EXPORT_SYMBOL(acpi_bus_get_status);
128 void acpi_bus_private_data_handler(acpi_handle handle,
133 EXPORT_SYMBOL(acpi_bus_private_data_handler);
135 int acpi_bus_attach_private_data(acpi_handle handle, void *data)
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");
148 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
150 int acpi_bus_get_private_data(acpi_handle handle, void **data)
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");
165 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
167 void acpi_bus_detach_private_data(acpi_handle handle)
169 acpi_detach_data(handle, acpi_bus_private_data_handler);
171 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
173 static void acpi_print_osc_error(acpi_handle handle,
174 struct acpi_osc_context *context, char *error)
178 acpi_handle_debug(handle, "(%s): %s\n", context->uuid_str, error);
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)));
187 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
190 struct acpi_object_list input;
191 union acpi_object in_params[4];
192 union acpi_object *out_obj;
195 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
199 if (guid_parse(context->uuid_str, &guid))
201 context->ret.length = ACPI_ALLOCATE_BUFFER;
202 context->ret.pointer = NULL;
204 /* Setting up input parameters */
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;
218 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
219 if (ACPI_FAILURE(status))
223 return AE_NULL_OBJECT;
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");
233 /* Need to ignore the bit0 in result code */
234 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
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]
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;
266 kfree(output.pointer);
269 EXPORT_SYMBOL(acpi_run_osc);
271 bool osc_sb_apei_support_acked;
274 * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
275 * OSPM supports platform coordinated low power idle(LPI) states
277 bool osc_pc_lpi_support_confirmed;
278 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
281 * ACPI 6.4 Operating System Capabilities for USB.
283 bool osc_sb_native_usb4_support_confirmed;
284 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_support_confirmed);
286 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
287 static void acpi_bus_osc_negotiate_platform_control(void)
289 u32 capbuf[2], *capbuf_ret;
290 struct acpi_osc_context context = {
291 .uuid_str = sb_uuid_str,
294 .cap.pointer = capbuf,
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;
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;
311 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
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;
321 if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
322 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
324 if (IS_ENABLED(CONFIG_USB4))
325 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_NATIVE_USB4_SUPPORT;
328 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
329 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
332 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
335 kfree(context.ret.pointer);
337 /* Now run _OSC again with query flag clear */
338 capbuf[OSC_QUERY_DWORD] = 0;
340 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
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;
351 kfree(context.ret.pointer);
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
359 u32 osc_sb_native_usb4_control;
360 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_control);
362 static void acpi_bus_decode_usb_osc(const char *msg, u32 bits)
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) ? '+' : '-');
371 static u8 sb_usb_uuid_str[] = "23A0D13A-26AB-486C-9C5F-0FFA525A575A";
372 static void acpi_bus_osc_negotiate_usb_control(void)
375 struct acpi_osc_context context = {
376 .uuid_str = sb_usb_uuid_str,
378 .cap.length = sizeof(capbuf),
379 .cap.pointer = capbuf,
385 if (!osc_sb_native_usb4_support_confirmed)
388 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
391 control = OSC_USB_USB3_TUNNELING | OSC_USB_DP_TUNNELING |
392 OSC_USB_PCIE_TUNNELING | OSC_USB_XDOMAIN;
394 capbuf[OSC_QUERY_DWORD] = 0;
395 capbuf[OSC_SUPPORT_DWORD] = 0;
396 capbuf[OSC_CONTROL_DWORD] = control;
398 status = acpi_run_osc(handle, &context);
399 if (ACPI_FAILURE(status))
402 if (context.ret.length != sizeof(capbuf)) {
403 pr_info("USB4 _OSC: returned invalid length buffer\n");
407 osc_sb_native_usb4_control =
408 control & ((u32 *)context.ret.pointer)[OSC_CONTROL_DWORD];
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);
415 kfree(context.ret.pointer);
418 /* --------------------------------------------------------------------------
419 Notification Handling
420 -------------------------------------------------------------------------- */
425 * Callback for all 'system-level' device notifications (values 0x00-0x7F).
427 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
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;
435 case ACPI_NOTIFY_BUS_CHECK:
436 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
437 hotplug_event = true;
440 case ACPI_NOTIFY_DEVICE_CHECK:
441 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
442 hotplug_event = true;
445 case ACPI_NOTIFY_DEVICE_WAKE:
446 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
449 case ACPI_NOTIFY_EJECT_REQUEST:
450 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
451 hotplug_event = true;
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? */
459 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
460 acpi_handle_err(handle, "Device cannot be configured due "
461 "to a frequency mismatch\n");
464 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
465 acpi_handle_err(handle, "Device cannot be configured due "
466 "to a bus mode mismatch\n");
469 case ACPI_NOTIFY_POWER_FAULT:
470 acpi_handle_err(handle, "Device has suffered a power fault\n");
474 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
478 adev = acpi_bus_get_acpi_device(handle);
482 driver = adev->driver;
483 if (driver && driver->ops.notify &&
484 (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS))
485 driver->ops.notify(adev, type);
487 if (!hotplug_event) {
488 acpi_bus_put_acpi_device(adev);
492 if (ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
495 acpi_bus_put_acpi_device(adev);
498 acpi_evaluate_ost(handle, type, ost_code, NULL);
501 static void acpi_notify_device(acpi_handle handle, u32 event, void *data)
503 struct acpi_device *device = data;
505 device->driver->ops.notify(device, event);
508 static void acpi_notify_device_fixed(void *data)
510 struct acpi_device *device = data;
512 /* Fixed hardware devices have no handles */
513 acpi_notify_device(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
516 static u32 acpi_device_fixed_event(void *data)
518 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_notify_device_fixed, data);
519 return ACPI_INTERRUPT_HANDLED;
522 static int acpi_device_install_notify_handler(struct acpi_device *device)
526 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
528 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
529 acpi_device_fixed_event,
531 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
533 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
534 acpi_device_fixed_event,
537 status = acpi_install_notify_handler(device->handle,
542 if (ACPI_FAILURE(status))
547 static void acpi_device_remove_notify_handler(struct acpi_device *device)
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);
556 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
560 /* Handle events targeting \_SB device (at present only graceful shutdown) */
562 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
563 #define ACPI_SB_INDICATE_INTERVAL 10000
565 static void sb_notify_work(struct work_struct *dummy)
567 acpi_handle sb_handle;
569 orderly_poweroff(true);
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
576 acpi_get_handle(NULL, "\\_SB", &sb_handle);
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);
585 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
587 static DECLARE_WORK(acpi_sb_work, sb_notify_work);
589 if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
590 if (!work_busy(&acpi_sb_work))
591 schedule_work(&acpi_sb_work);
593 pr_warn("event %x is not supported by \\_SB device\n", event);
596 static int __init acpi_setup_sb_notify_handler(void)
598 acpi_handle sb_handle;
600 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
603 if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
604 acpi_sb_notify, NULL)))
610 /* --------------------------------------------------------------------------
612 -------------------------------------------------------------------------- */
615 * acpi_get_first_physical_node - Get first physical node of an ACPI device
616 * @adev: ACPI device in question
618 * Return: First physical node of ACPI device @adev
620 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
622 struct mutex *physical_node_lock = &adev->physical_node_lock;
623 struct device *phys_dev;
625 mutex_lock(physical_node_lock);
626 if (list_empty(&adev->physical_node_list)) {
629 const struct acpi_device_physical_node *node;
631 node = list_first_entry(&adev->physical_node_list,
632 struct acpi_device_physical_node, node);
634 phys_dev = node->dev;
636 mutex_unlock(physical_node_lock);
639 EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
641 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
642 const struct device *dev)
644 const struct device *phys_dev = acpi_get_first_physical_node(adev);
646 return phys_dev && phys_dev == dev ? adev : NULL;
650 * acpi_device_is_first_physical_node - Is given dev first physical node
651 * @adev: ACPI companion device
652 * @dev: Physical device to check
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.
658 * Note that the caller have to provide valid @adev pointer.
660 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
661 const struct device *dev)
663 return !!acpi_primary_dev_companion(adev, dev);
667 * acpi_companion_match() - Can we match via ACPI companion device
668 * @dev: Device in question
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
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
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).
687 struct acpi_device *acpi_companion_match(const struct device *dev)
689 struct acpi_device *adev;
691 adev = ACPI_COMPANION(dev);
695 if (list_empty(&adev->pnp.ids))
698 return acpi_primary_dev_companion(adev, dev);
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
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.
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)
715 const union acpi_object *of_compatible, *obj;
721 of_compatible = adev->data.of_compatible;
722 if (!of_match_table || !of_compatible)
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. */
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;
736 for (id = of_match_table; id->compatible[0]; id++)
737 if (!strcasecmp(obj->string.pointer, id->compatible)) {
747 static bool acpi_of_modalias(struct acpi_device *adev,
748 char *modalias, size_t len)
750 const union acpi_object *of_compatible;
751 const union acpi_object *obj;
752 const char *str, *chr;
754 of_compatible = adev->data.of_compatible;
758 if (of_compatible->type == ACPI_TYPE_PACKAGE)
759 obj = of_compatible->package.elements;
760 else /* Must be ACPI_TYPE_STRING. */
763 str = obj->string.pointer;
764 chr = strchr(str, ',');
765 strlcpy(modalias, chr ? chr + 1 : str, len);
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
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.
781 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
782 char *modalias, size_t len)
784 if (!acpi_of_modalias(adev, modalias, len))
785 strlcpy(modalias, default_id, len);
787 EXPORT_SYMBOL_GPL(acpi_set_modalias);
789 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
790 struct acpi_hardware_id *hwid)
792 int i, msk, byte_shift;
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;
805 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
806 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
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)
818 const struct acpi_device_id *id;
819 struct acpi_hardware_id *hwid;
822 * If the device is not present, it is unnecessary to load device
825 if (!device || !device->status.present)
828 list_for_each_entry(hwid, &device->pnp.ids, list) {
829 /* First, check the ACPI/PNP IDs provided by the caller. */
831 for (id = acpi_ids; id->id[0] || id->cls; id++) {
832 if (id->id[0] && !strcmp((char *)id->id, hwid->id))
834 if (id->cls && __acpi_match_device_cls(id, hwid))
840 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
841 * "compatible" property if found.
843 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
844 return acpi_of_match_device(device, of_ids, of_id);
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.
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
863 * Return a pointer to the first matching ID on success or %NULL on failure.
865 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
866 const struct device *dev)
868 const struct acpi_device_id *id = NULL;
870 __acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL);
873 EXPORT_SYMBOL_GPL(acpi_match_device);
875 static const void *acpi_of_device_get_match_data(const struct device *dev)
877 struct acpi_device *adev = ACPI_COMPANION(dev);
878 const struct of_device_id *match = NULL;
880 if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
886 const void *acpi_device_get_match_data(const struct device *dev)
888 const struct acpi_device_id *match;
890 if (!dev->driver->acpi_match_table)
891 return acpi_of_device_get_match_data(dev);
893 match = acpi_match_device(dev->driver->acpi_match_table, dev);
897 return (const void *)match->driver_data;
899 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
901 int acpi_match_device_ids(struct acpi_device *device,
902 const struct acpi_device_id *ids)
904 return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
906 EXPORT_SYMBOL(acpi_match_device_ids);
908 bool acpi_driver_match_device(struct device *dev,
909 const struct device_driver *drv)
911 if (!drv->acpi_match_table)
912 return acpi_of_match_device(ACPI_COMPANION(dev),
916 return __acpi_match_device(acpi_companion_match(dev),
917 drv->acpi_match_table, drv->of_match_table,
920 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
922 /* --------------------------------------------------------------------------
923 ACPI Driver Management
924 -------------------------------------------------------------------------- */
927 * acpi_bus_register_driver - register a driver with the ACPI bus
928 * @driver: driver being registered
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.
934 int acpi_bus_register_driver(struct acpi_driver *driver)
940 driver->drv.name = driver->name;
941 driver->drv.bus = &acpi_bus_type;
942 driver->drv.owner = driver->owner;
944 ret = driver_register(&driver->drv);
948 EXPORT_SYMBOL(acpi_bus_register_driver);
951 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
952 * @driver: driver to unregister
954 * Unregisters a driver with the ACPI bus. Searches the namespace for all
955 * devices that match the driver's criteria and unbinds.
957 void acpi_bus_unregister_driver(struct acpi_driver *driver)
959 driver_unregister(&driver->drv);
962 EXPORT_SYMBOL(acpi_bus_unregister_driver);
964 /* --------------------------------------------------------------------------
966 -------------------------------------------------------------------------- */
968 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
970 struct acpi_device *acpi_dev = to_acpi_device(dev);
971 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
973 return acpi_dev->flags.match_driver
974 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
977 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
979 return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
982 static int acpi_device_probe(struct device *dev)
984 struct acpi_device *acpi_dev = to_acpi_device(dev);
985 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
988 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
991 if (!acpi_drv->ops.add)
994 ret = acpi_drv->ops.add(acpi_dev);
998 acpi_dev->driver = acpi_drv;
1000 pr_debug("Driver [%s] successfully bound to device [%s]\n",
1001 acpi_drv->name, acpi_dev->pnp.bus_id);
1003 if (acpi_drv->ops.notify) {
1004 ret = acpi_device_install_notify_handler(acpi_dev);
1006 if (acpi_drv->ops.remove)
1007 acpi_drv->ops.remove(acpi_dev);
1009 acpi_dev->driver = NULL;
1010 acpi_dev->driver_data = NULL;
1015 pr_debug("Found driver [%s] for device [%s]\n", acpi_drv->name,
1016 acpi_dev->pnp.bus_id);
1022 static void acpi_device_remove(struct device *dev)
1024 struct acpi_device *acpi_dev = to_acpi_device(dev);
1025 struct acpi_driver *acpi_drv = acpi_dev->driver;
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);
1033 acpi_dev->driver = NULL;
1034 acpi_dev->driver_data = NULL;
1039 struct bus_type acpi_bus_type = {
1041 .match = acpi_bus_match,
1042 .probe = acpi_device_probe,
1043 .remove = acpi_device_remove,
1044 .uevent = acpi_device_uevent,
1046 EXPORT_SYMBOL_GPL(acpi_bus_type);
1048 /* --------------------------------------------------------------------------
1049 Initialization/Cleanup
1050 -------------------------------------------------------------------------- */
1052 static int __init acpi_bus_init_irq(void)
1055 char *message = NULL;
1059 * Let the system know what interrupt model we are using by
1060 * evaluating the \_PIC object, if exists.
1063 switch (acpi_irq_model) {
1064 case ACPI_IRQ_MODEL_PIC:
1067 case ACPI_IRQ_MODEL_IOAPIC:
1070 case ACPI_IRQ_MODEL_IOSAPIC:
1071 message = "IOSAPIC";
1073 case ACPI_IRQ_MODEL_GIC:
1076 case ACPI_IRQ_MODEL_PLATFORM:
1077 message = "platform specific model";
1080 pr_info("Unknown interrupt routing model\n");
1084 pr_info("Using %s for interrupt routing\n", message);
1086 status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1087 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1088 pr_info("_PIC evaluation failed: %s\n", acpi_format_exception(status));
1096 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1098 * The ACPI tables are accessible after this, but the handling of events has not
1099 * been initialized and the global lock is not available yet, so AML should not
1100 * be executed at this point.
1102 * Doing this before switching the EFI runtime services to virtual mode allows
1103 * the EfiBootServices memory to be freed slightly earlier on boot.
1105 void __init acpi_early_init(void)
1112 pr_info("Core revision %08x\n", ACPI_CA_VERSION);
1114 /* enable workarounds, unless strict ACPI spec. compliance */
1116 acpi_gbl_enable_interpreter_slack = TRUE;
1118 acpi_permanent_mmap = true;
1122 * If the machine falls into the DMI check table,
1123 * DSDT will be copied to memory.
1124 * Note that calling dmi_check_system() here on other architectures
1125 * would not be OK because only x86 initializes dmi early enough.
1126 * Thankfully only x86 systems need such quirks for now.
1128 dmi_check_system(dsdt_dmi_table);
1131 status = acpi_reallocate_root_table();
1132 if (ACPI_FAILURE(status)) {
1133 pr_err("Unable to reallocate ACPI tables\n");
1137 status = acpi_initialize_subsystem();
1138 if (ACPI_FAILURE(status)) {
1139 pr_err("Unable to initialize the ACPI Interpreter\n");
1145 /* compatible (0) means level (3) */
1146 if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1147 acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1148 acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1150 /* Set PIC-mode SCI trigger type */
1151 acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1152 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1155 * now that acpi_gbl_FADT is initialized,
1156 * update it with result from INT_SRC_OVR parsing
1158 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1168 * acpi_subsystem_init - Finalize the early initialization of ACPI.
1170 * Switch over the platform to the ACPI mode (if possible).
1172 * Doing this too early is generally unsafe, but at the same time it needs to be
1173 * done before all things that really depend on ACPI. The right spot appears to
1174 * be before finalizing the EFI initialization.
1176 void __init acpi_subsystem_init(void)
1183 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1184 if (ACPI_FAILURE(status)) {
1185 pr_err("Unable to enable ACPI\n");
1189 * If the system is using ACPI then we can be reasonably
1190 * confident that any regulators are managed by the firmware
1191 * so tell the regulator core it has everything it needs to
1194 regulator_has_full_constraints();
1198 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1200 if (event == ACPI_TABLE_EVENT_LOAD)
1201 acpi_scan_table_notify();
1203 return acpi_sysfs_table_handler(event, table, context);
1206 static int __init acpi_bus_init(void)
1211 acpi_os_initialize1();
1213 status = acpi_load_tables();
1214 if (ACPI_FAILURE(status)) {
1215 pr_err("Unable to load the System Description Tables\n");
1220 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1221 * device is found in the namespace.
1223 * This is accomplished by looking for the ECDT table and getting the EC
1224 * parameters out of that.
1226 * Do that before calling acpi_initialize_objects() which may trigger EC
1227 * address space accesses.
1229 acpi_ec_ecdt_probe();
1231 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1232 if (ACPI_FAILURE(status)) {
1233 pr_err("Unable to start the ACPI Interpreter\n");
1237 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1238 if (ACPI_FAILURE(status)) {
1239 pr_err("Unable to initialize ACPI objects\n");
1243 /* Set capability bits for _OSC under processor scope */
1244 acpi_early_processor_osc();
1247 * _OSC method may exist in module level code,
1248 * so it must be run after ACPI_FULL_INITIALIZATION
1250 acpi_bus_osc_negotiate_platform_control();
1251 acpi_bus_osc_negotiate_usb_control();
1254 * _PDC control method may load dynamic SSDT tables,
1255 * and we need to install the table handler before that.
1257 status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1261 acpi_early_processor_set_pdc();
1264 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1265 * is necessary to enable it as early as possible.
1267 acpi_ec_dsdt_probe();
1269 pr_info("Interpreter enabled\n");
1271 /* Initialize sleep structures */
1275 * Get the system interrupt model and evaluate \_PIC.
1277 result = acpi_bus_init_irq();
1282 * Register the for all standard device notifications.
1285 acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1286 &acpi_bus_notify, NULL);
1287 if (ACPI_FAILURE(status)) {
1288 pr_err("Unable to register for system notifications\n");
1293 * Create the top ACPI proc directory
1295 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1297 result = bus_register(&acpi_bus_type);
1301 /* Mimic structured exception handling */
1307 struct kobject *acpi_kobj;
1308 EXPORT_SYMBOL_GPL(acpi_kobj);
1310 static int __init acpi_init(void)
1314 if (acpi_disabled) {
1315 pr_info("Interpreter disabled.\n");
1319 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1321 pr_debug("%s: kset create error\n", __func__);
1325 result = acpi_bus_init();
1327 kobject_put(acpi_kobj);
1332 pci_mmcfg_late_init();
1336 acpi_debugfs_init();
1337 acpi_sleep_proc_init();
1338 acpi_wakeup_device_init();
1339 acpi_debugger_init();
1340 acpi_setup_sb_notify_handler();
1345 subsys_initcall(acpi_init);