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_always_present(device)) {
102 acpi_set_device_status(device, ACPI_STA_DEFAULT);
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 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PRM_SUPPORT;
310 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
313 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
314 if (boot_cpu_has(X86_FEATURE_HWP)) {
315 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_SUPPORT;
316 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPCV2_SUPPORT;
320 if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
321 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
323 if (IS_ENABLED(CONFIG_USB4))
324 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_NATIVE_USB4_SUPPORT;
327 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
328 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
331 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
334 kfree(context.ret.pointer);
336 /* Now run _OSC again with query flag clear */
337 capbuf[OSC_QUERY_DWORD] = 0;
339 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
342 capbuf_ret = context.ret.pointer;
343 osc_sb_apei_support_acked =
344 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
345 osc_pc_lpi_support_confirmed =
346 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT;
347 osc_sb_native_usb4_support_confirmed =
348 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_NATIVE_USB4_SUPPORT;
350 kfree(context.ret.pointer);
354 * Native control of USB4 capabilities. If any of the tunneling bits is
355 * set it means OS is in control and we use software based connection
358 u32 osc_sb_native_usb4_control;
359 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_control);
361 static void acpi_bus_decode_usb_osc(const char *msg, u32 bits)
363 pr_info("%s USB3%c DisplayPort%c PCIe%c XDomain%c\n", msg,
364 (bits & OSC_USB_USB3_TUNNELING) ? '+' : '-',
365 (bits & OSC_USB_DP_TUNNELING) ? '+' : '-',
366 (bits & OSC_USB_PCIE_TUNNELING) ? '+' : '-',
367 (bits & OSC_USB_XDOMAIN) ? '+' : '-');
370 static u8 sb_usb_uuid_str[] = "23A0D13A-26AB-486C-9C5F-0FFA525A575A";
371 static void acpi_bus_osc_negotiate_usb_control(void)
374 struct acpi_osc_context context = {
375 .uuid_str = sb_usb_uuid_str,
377 .cap.length = sizeof(capbuf),
378 .cap.pointer = capbuf,
384 if (!osc_sb_native_usb4_support_confirmed)
387 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
390 control = OSC_USB_USB3_TUNNELING | OSC_USB_DP_TUNNELING |
391 OSC_USB_PCIE_TUNNELING | OSC_USB_XDOMAIN;
393 capbuf[OSC_QUERY_DWORD] = 0;
394 capbuf[OSC_SUPPORT_DWORD] = 0;
395 capbuf[OSC_CONTROL_DWORD] = control;
397 status = acpi_run_osc(handle, &context);
398 if (ACPI_FAILURE(status))
401 if (context.ret.length != sizeof(capbuf)) {
402 pr_info("USB4 _OSC: returned invalid length buffer\n");
406 osc_sb_native_usb4_control =
407 control & ((u32 *)context.ret.pointer)[OSC_CONTROL_DWORD];
409 acpi_bus_decode_usb_osc("USB4 _OSC: OS supports", control);
410 acpi_bus_decode_usb_osc("USB4 _OSC: OS controls",
411 osc_sb_native_usb4_control);
414 kfree(context.ret.pointer);
417 /* --------------------------------------------------------------------------
418 Notification Handling
419 -------------------------------------------------------------------------- */
424 * Callback for all 'system-level' device notifications (values 0x00-0x7F).
426 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
428 struct acpi_device *adev;
429 struct acpi_driver *driver;
430 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
431 bool hotplug_event = false;
434 case ACPI_NOTIFY_BUS_CHECK:
435 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
436 hotplug_event = true;
439 case ACPI_NOTIFY_DEVICE_CHECK:
440 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
441 hotplug_event = true;
444 case ACPI_NOTIFY_DEVICE_WAKE:
445 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
448 case ACPI_NOTIFY_EJECT_REQUEST:
449 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
450 hotplug_event = true;
453 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
454 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
455 /* TBD: Exactly what does 'light' mean? */
458 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
459 acpi_handle_err(handle, "Device cannot be configured due "
460 "to a frequency mismatch\n");
463 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
464 acpi_handle_err(handle, "Device cannot be configured due "
465 "to a bus mode mismatch\n");
468 case ACPI_NOTIFY_POWER_FAULT:
469 acpi_handle_err(handle, "Device has suffered a power fault\n");
473 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
477 adev = acpi_bus_get_acpi_device(handle);
481 driver = adev->driver;
482 if (driver && driver->ops.notify &&
483 (driver->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS))
484 driver->ops.notify(adev, type);
486 if (!hotplug_event) {
487 acpi_bus_put_acpi_device(adev);
491 if (ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
494 acpi_bus_put_acpi_device(adev);
497 acpi_evaluate_ost(handle, type, ost_code, NULL);
500 static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
502 struct acpi_device *device = data;
504 device->driver->ops.notify(device, event);
507 static void acpi_device_notify_fixed(void *data)
509 struct acpi_device *device = data;
511 /* Fixed hardware devices have no handles */
512 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
515 static u32 acpi_device_fixed_event(void *data)
517 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_device_notify_fixed, data);
518 return ACPI_INTERRUPT_HANDLED;
521 static int acpi_device_install_notify_handler(struct acpi_device *device)
525 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
527 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
528 acpi_device_fixed_event,
530 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
532 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
533 acpi_device_fixed_event,
536 status = acpi_install_notify_handler(device->handle,
541 if (ACPI_FAILURE(status))
546 static void acpi_device_remove_notify_handler(struct acpi_device *device)
548 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
549 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
550 acpi_device_fixed_event);
551 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
552 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
553 acpi_device_fixed_event);
555 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
559 /* Handle events targeting \_SB device (at present only graceful shutdown) */
561 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
562 #define ACPI_SB_INDICATE_INTERVAL 10000
564 static void sb_notify_work(struct work_struct *dummy)
566 acpi_handle sb_handle;
568 orderly_poweroff(true);
571 * After initiating graceful shutdown, the ACPI spec requires OSPM
572 * to evaluate _OST method once every 10seconds to indicate that
573 * the shutdown is in progress
575 acpi_get_handle(NULL, "\\_SB", &sb_handle);
577 pr_info("Graceful shutdown in progress.\n");
578 acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN,
579 ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL);
580 msleep(ACPI_SB_INDICATE_INTERVAL);
584 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
586 static DECLARE_WORK(acpi_sb_work, sb_notify_work);
588 if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
589 if (!work_busy(&acpi_sb_work))
590 schedule_work(&acpi_sb_work);
592 pr_warn("event %x is not supported by \\_SB device\n", event);
595 static int __init acpi_setup_sb_notify_handler(void)
597 acpi_handle sb_handle;
599 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
602 if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
603 acpi_sb_notify, NULL)))
609 /* --------------------------------------------------------------------------
611 -------------------------------------------------------------------------- */
614 * acpi_get_first_physical_node - Get first physical node of an ACPI device
615 * @adev: ACPI device in question
617 * Return: First physical node of ACPI device @adev
619 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
621 struct mutex *physical_node_lock = &adev->physical_node_lock;
622 struct device *phys_dev;
624 mutex_lock(physical_node_lock);
625 if (list_empty(&adev->physical_node_list)) {
628 const struct acpi_device_physical_node *node;
630 node = list_first_entry(&adev->physical_node_list,
631 struct acpi_device_physical_node, node);
633 phys_dev = node->dev;
635 mutex_unlock(physical_node_lock);
638 EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
640 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
641 const struct device *dev)
643 const struct device *phys_dev = acpi_get_first_physical_node(adev);
645 return phys_dev && phys_dev == dev ? adev : NULL;
649 * acpi_device_is_first_physical_node - Is given dev first physical node
650 * @adev: ACPI companion device
651 * @dev: Physical device to check
653 * Function checks if given @dev is the first physical devices attached to
654 * the ACPI companion device. This distinction is needed in some cases
655 * where the same companion device is shared between many physical devices.
657 * Note that the caller have to provide valid @adev pointer.
659 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
660 const struct device *dev)
662 return !!acpi_primary_dev_companion(adev, dev);
666 * acpi_companion_match() - Can we match via ACPI companion device
667 * @dev: Device in question
669 * Check if the given device has an ACPI companion and if that companion has
670 * a valid list of PNP IDs, and if the device is the first (primary) physical
671 * device associated with it. Return the companion pointer if that's the case
674 * If multiple physical devices are attached to a single ACPI companion, we need
675 * to be careful. The usage scenario for this kind of relationship is that all
676 * of the physical devices in question use resources provided by the ACPI
677 * companion. A typical case is an MFD device where all the sub-devices share
678 * the parent's ACPI companion. In such cases we can only allow the primary
679 * (first) physical device to be matched with the help of the companion's PNP
682 * Additional physical devices sharing the ACPI companion can still use
683 * resources available from it but they will be matched normally using functions
684 * provided by their bus types (and analogously for their modalias).
686 struct acpi_device *acpi_companion_match(const struct device *dev)
688 struct acpi_device *adev;
690 adev = ACPI_COMPANION(dev);
694 if (list_empty(&adev->pnp.ids))
697 return acpi_primary_dev_companion(adev, dev);
701 * acpi_of_match_device - Match device object using the "compatible" property.
702 * @adev: ACPI device object to match.
703 * @of_match_table: List of device IDs to match against.
704 * @of_id: OF ID if matched
706 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
707 * identifiers and a _DSD object with the "compatible" property, use that
708 * property to match against the given list of identifiers.
710 static bool acpi_of_match_device(struct acpi_device *adev,
711 const struct of_device_id *of_match_table,
712 const struct of_device_id **of_id)
714 const union acpi_object *of_compatible, *obj;
720 of_compatible = adev->data.of_compatible;
721 if (!of_match_table || !of_compatible)
724 if (of_compatible->type == ACPI_TYPE_PACKAGE) {
725 nval = of_compatible->package.count;
726 obj = of_compatible->package.elements;
727 } else { /* Must be ACPI_TYPE_STRING. */
731 /* Now we can look for the driver DT compatible strings */
732 for (i = 0; i < nval; i++, obj++) {
733 const struct of_device_id *id;
735 for (id = of_match_table; id->compatible[0]; id++)
736 if (!strcasecmp(obj->string.pointer, id->compatible)) {
746 static bool acpi_of_modalias(struct acpi_device *adev,
747 char *modalias, size_t len)
749 const union acpi_object *of_compatible;
750 const union acpi_object *obj;
751 const char *str, *chr;
753 of_compatible = adev->data.of_compatible;
757 if (of_compatible->type == ACPI_TYPE_PACKAGE)
758 obj = of_compatible->package.elements;
759 else /* Must be ACPI_TYPE_STRING. */
762 str = obj->string.pointer;
763 chr = strchr(str, ',');
764 strlcpy(modalias, chr ? chr + 1 : str, len);
770 * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
771 * @adev: ACPI device object to match
772 * @default_id: ID string to use as default if no compatible string found
773 * @modalias: Pointer to buffer that modalias value will be copied into
774 * @len: Length of modalias buffer
776 * This is a counterpart of of_modalias_node() for struct acpi_device objects.
777 * If there is a compatible string for @adev, it will be copied to @modalias
778 * with the vendor prefix stripped; otherwise, @default_id will be used.
780 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
781 char *modalias, size_t len)
783 if (!acpi_of_modalias(adev, modalias, len))
784 strlcpy(modalias, default_id, len);
786 EXPORT_SYMBOL_GPL(acpi_set_modalias);
788 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
789 struct acpi_hardware_id *hwid)
791 int i, msk, byte_shift;
797 /* Apply class-code bitmask, before checking each class-code byte */
798 for (i = 1; i <= 3; i++) {
799 byte_shift = 8 * (3 - i);
800 msk = (id->cls_msk >> byte_shift) & 0xFF;
804 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
805 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
811 static bool __acpi_match_device(struct acpi_device *device,
812 const struct acpi_device_id *acpi_ids,
813 const struct of_device_id *of_ids,
814 const struct acpi_device_id **acpi_id,
815 const struct of_device_id **of_id)
817 const struct acpi_device_id *id;
818 struct acpi_hardware_id *hwid;
821 * If the device is not present, it is unnecessary to load device
824 if (!device || !device->status.present)
827 list_for_each_entry(hwid, &device->pnp.ids, list) {
828 /* First, check the ACPI/PNP IDs provided by the caller. */
830 for (id = acpi_ids; id->id[0] || id->cls; id++) {
831 if (id->id[0] && !strcmp((char *)id->id, hwid->id))
833 if (id->cls && __acpi_match_device_cls(id, hwid))
839 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
840 * "compatible" property if found.
842 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
843 return acpi_of_match_device(device, of_ids, of_id);
854 * acpi_match_device - Match a struct device against a given list of ACPI IDs
855 * @ids: Array of struct acpi_device_id object to match against.
856 * @dev: The device structure to match.
858 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
859 * object for that handle and use that object to match against a given list of
862 * Return a pointer to the first matching ID on success or %NULL on failure.
864 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
865 const struct device *dev)
867 const struct acpi_device_id *id = NULL;
869 __acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL);
872 EXPORT_SYMBOL_GPL(acpi_match_device);
874 static const void *acpi_of_device_get_match_data(const struct device *dev)
876 struct acpi_device *adev = ACPI_COMPANION(dev);
877 const struct of_device_id *match = NULL;
879 if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
885 const void *acpi_device_get_match_data(const struct device *dev)
887 const struct acpi_device_id *match;
889 if (!dev->driver->acpi_match_table)
890 return acpi_of_device_get_match_data(dev);
892 match = acpi_match_device(dev->driver->acpi_match_table, dev);
896 return (const void *)match->driver_data;
898 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
900 int acpi_match_device_ids(struct acpi_device *device,
901 const struct acpi_device_id *ids)
903 return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
905 EXPORT_SYMBOL(acpi_match_device_ids);
907 bool acpi_driver_match_device(struct device *dev,
908 const struct device_driver *drv)
910 if (!drv->acpi_match_table)
911 return acpi_of_match_device(ACPI_COMPANION(dev),
915 return __acpi_match_device(acpi_companion_match(dev),
916 drv->acpi_match_table, drv->of_match_table,
919 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
921 /* --------------------------------------------------------------------------
922 ACPI Driver Management
923 -------------------------------------------------------------------------- */
926 * acpi_bus_register_driver - register a driver with the ACPI bus
927 * @driver: driver being registered
929 * Registers a driver with the ACPI bus. Searches the namespace for all
930 * devices that match the driver's criteria and binds. Returns zero for
931 * success or a negative error status for failure.
933 int acpi_bus_register_driver(struct acpi_driver *driver)
939 driver->drv.name = driver->name;
940 driver->drv.bus = &acpi_bus_type;
941 driver->drv.owner = driver->owner;
943 ret = driver_register(&driver->drv);
947 EXPORT_SYMBOL(acpi_bus_register_driver);
950 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
951 * @driver: driver to unregister
953 * Unregisters a driver with the ACPI bus. Searches the namespace for all
954 * devices that match the driver's criteria and unbinds.
956 void acpi_bus_unregister_driver(struct acpi_driver *driver)
958 driver_unregister(&driver->drv);
961 EXPORT_SYMBOL(acpi_bus_unregister_driver);
963 /* --------------------------------------------------------------------------
965 -------------------------------------------------------------------------- */
967 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
969 struct acpi_device *acpi_dev = to_acpi_device(dev);
970 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
972 return acpi_dev->flags.match_driver
973 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
976 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
978 return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
981 static int acpi_device_probe(struct device *dev)
983 struct acpi_device *acpi_dev = to_acpi_device(dev);
984 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
987 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
990 if (!acpi_drv->ops.add)
993 ret = acpi_drv->ops.add(acpi_dev);
997 acpi_dev->driver = acpi_drv;
999 pr_debug("Driver [%s] successfully bound to device [%s]\n",
1000 acpi_drv->name, acpi_dev->pnp.bus_id);
1002 if (acpi_drv->ops.notify) {
1003 ret = acpi_device_install_notify_handler(acpi_dev);
1005 if (acpi_drv->ops.remove)
1006 acpi_drv->ops.remove(acpi_dev);
1008 acpi_dev->driver = NULL;
1009 acpi_dev->driver_data = NULL;
1014 pr_debug("Found driver [%s] for device [%s]\n", acpi_drv->name,
1015 acpi_dev->pnp.bus_id);
1021 static int acpi_device_remove(struct device *dev)
1023 struct acpi_device *acpi_dev = to_acpi_device(dev);
1024 struct acpi_driver *acpi_drv = acpi_dev->driver;
1027 if (acpi_drv->ops.notify)
1028 acpi_device_remove_notify_handler(acpi_dev);
1029 if (acpi_drv->ops.remove)
1030 acpi_drv->ops.remove(acpi_dev);
1032 acpi_dev->driver = NULL;
1033 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,
1047 /* --------------------------------------------------------------------------
1048 Initialization/Cleanup
1049 -------------------------------------------------------------------------- */
1051 static int __init acpi_bus_init_irq(void)
1054 char *message = NULL;
1058 * Let the system know what interrupt model we are using by
1059 * evaluating the \_PIC object, if exists.
1062 switch (acpi_irq_model) {
1063 case ACPI_IRQ_MODEL_PIC:
1066 case ACPI_IRQ_MODEL_IOAPIC:
1069 case ACPI_IRQ_MODEL_IOSAPIC:
1070 message = "IOSAPIC";
1072 case ACPI_IRQ_MODEL_GIC:
1075 case ACPI_IRQ_MODEL_PLATFORM:
1076 message = "platform specific model";
1079 pr_info("Unknown interrupt routing model\n");
1083 pr_info("Using %s for interrupt routing\n", message);
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));
1095 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
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.
1101 * Doing this before switching the EFI runtime services to virtual mode allows
1102 * the EfiBootServices memory to be freed slightly earlier on boot.
1104 void __init acpi_early_init(void)
1111 pr_info("Core revision %08x\n", ACPI_CA_VERSION);
1113 /* enable workarounds, unless strict ACPI spec. compliance */
1115 acpi_gbl_enable_interpreter_slack = TRUE;
1117 acpi_permanent_mmap = true;
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.
1127 dmi_check_system(dsdt_dmi_table);
1130 status = acpi_reallocate_root_table();
1131 if (ACPI_FAILURE(status)) {
1132 pr_err("Unable to reallocate ACPI tables\n");
1136 status = acpi_initialize_subsystem();
1137 if (ACPI_FAILURE(status)) {
1138 pr_err("Unable to initialize the ACPI Interpreter\n");
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;
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);
1154 * now that acpi_gbl_FADT is initialized,
1155 * update it with result from INT_SRC_OVR parsing
1157 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1167 * acpi_subsystem_init - Finalize the early initialization of ACPI.
1169 * Switch over the platform to the ACPI mode (if possible).
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.
1175 void __init acpi_subsystem_init(void)
1182 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1183 if (ACPI_FAILURE(status)) {
1184 pr_err("Unable to enable ACPI\n");
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
1193 regulator_has_full_constraints();
1197 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1199 if (event == ACPI_TABLE_EVENT_LOAD)
1200 acpi_scan_table_notify();
1202 return acpi_sysfs_table_handler(event, table, context);
1205 static int __init acpi_bus_init(void)
1210 acpi_os_initialize1();
1212 status = acpi_load_tables();
1213 if (ACPI_FAILURE(status)) {
1214 pr_err("Unable to load the System Description Tables\n");
1219 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1220 * device is found in the namespace.
1222 * This is accomplished by looking for the ECDT table and getting the EC
1223 * parameters out of that.
1225 * Do that before calling acpi_initialize_objects() which may trigger EC
1226 * address space accesses.
1228 acpi_ec_ecdt_probe();
1230 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1231 if (ACPI_FAILURE(status)) {
1232 pr_err("Unable to start the ACPI Interpreter\n");
1236 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1237 if (ACPI_FAILURE(status)) {
1238 pr_err("Unable to initialize ACPI objects\n");
1242 /* Set capability bits for _OSC under processor scope */
1243 acpi_early_processor_osc();
1246 * _OSC method may exist in module level code,
1247 * so it must be run after ACPI_FULL_INITIALIZATION
1249 acpi_bus_osc_negotiate_platform_control();
1250 acpi_bus_osc_negotiate_usb_control();
1253 * _PDC control method may load dynamic SSDT tables,
1254 * and we need to install the table handler before that.
1256 status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1260 acpi_early_processor_set_pdc();
1263 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1264 * is necessary to enable it as early as possible.
1266 acpi_ec_dsdt_probe();
1268 pr_info("Interpreter enabled\n");
1270 /* Initialize sleep structures */
1274 * Get the system interrupt model and evaluate \_PIC.
1276 result = acpi_bus_init_irq();
1281 * Register the for all standard device notifications.
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");
1292 * Create the top ACPI proc directory
1294 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1296 result = bus_register(&acpi_bus_type);
1300 /* Mimic structured exception handling */
1306 struct kobject *acpi_kobj;
1307 EXPORT_SYMBOL_GPL(acpi_kobj);
1309 static int __init acpi_init(void)
1313 if (acpi_disabled) {
1314 pr_info("Interpreter disabled.\n");
1318 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1320 pr_debug("%s: kset create error\n", __func__);
1323 result = acpi_bus_init();
1325 kobject_put(acpi_kobj);
1330 pci_mmcfg_late_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();
1343 subsys_initcall(acpi_init);