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_agdi.h>
30 #include <linux/acpi_apmt.h>
31 #include <linux/acpi_iort.h>
32 #include <linux/acpi_viot.h>
33 #include <linux/pci.h>
34 #include <acpi/apei.h>
35 #include <linux/suspend.h>
36 #include <linux/prmt.h>
40 struct acpi_device *acpi_root;
41 struct proc_dir_entry *acpi_root_dir;
42 EXPORT_SYMBOL(acpi_root_dir);
45 #ifdef CONFIG_ACPI_CUSTOM_DSDT
46 static inline int set_copy_dsdt(const struct dmi_system_id *id)
51 static int set_copy_dsdt(const struct dmi_system_id *id)
53 pr_notice("%s detected - force copy of DSDT to local memory\n", id->ident);
54 acpi_gbl_copy_dsdt_locally = 1;
59 static const struct dmi_system_id dsdt_dmi_table[] __initconst = {
61 * Invoke DSDT corruption work-around on all Toshiba Satellite.
62 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
65 .callback = set_copy_dsdt,
66 .ident = "TOSHIBA Satellite",
68 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
69 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
76 /* --------------------------------------------------------------------------
78 -------------------------------------------------------------------------- */
80 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
81 unsigned long long *sta)
85 status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
86 if (ACPI_SUCCESS(status))
89 if (status == AE_NOT_FOUND) {
90 *sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
91 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING;
96 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
98 int acpi_bus_get_status(struct acpi_device *device)
101 unsigned long long sta;
103 if (acpi_device_override_status(device, &sta)) {
104 acpi_set_device_status(device, sta);
108 /* Battery devices must have their deps met before calling _STA */
109 if (acpi_device_is_battery(device) && device->dep_unmet) {
110 acpi_set_device_status(device, 0);
114 status = acpi_bus_get_status_handle(device->handle, &sta);
115 if (ACPI_FAILURE(status))
118 acpi_set_device_status(device, sta);
120 if (device->status.functional && !device->status.present) {
121 pr_debug("Device [%s] status [%08x]: functional but not present\n",
122 device->pnp.bus_id, (u32)sta);
125 pr_debug("Device [%s] status [%08x]\n", device->pnp.bus_id, (u32)sta);
128 EXPORT_SYMBOL(acpi_bus_get_status);
130 void acpi_bus_private_data_handler(acpi_handle handle,
135 EXPORT_SYMBOL(acpi_bus_private_data_handler);
137 int acpi_bus_attach_private_data(acpi_handle handle, void *data)
141 status = acpi_attach_data(handle,
142 acpi_bus_private_data_handler, data);
143 if (ACPI_FAILURE(status)) {
144 acpi_handle_debug(handle, "Error attaching device data\n");
150 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
152 int acpi_bus_get_private_data(acpi_handle handle, void **data)
159 status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
160 if (ACPI_FAILURE(status)) {
161 acpi_handle_debug(handle, "No context for object\n");
167 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
169 void acpi_bus_detach_private_data(acpi_handle handle)
171 acpi_detach_data(handle, acpi_bus_private_data_handler);
173 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
175 static void acpi_print_osc_error(acpi_handle handle,
176 struct acpi_osc_context *context, char *error)
180 acpi_handle_debug(handle, "(%s): %s\n", context->uuid_str, error);
182 pr_debug("_OSC request data:");
183 for (i = 0; i < context->cap.length; i += sizeof(u32))
184 pr_debug(" %x", *((u32 *)(context->cap.pointer + i)));
189 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
192 struct acpi_object_list input;
193 union acpi_object in_params[4];
194 union acpi_object *out_obj;
197 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
201 if (guid_parse(context->uuid_str, &guid))
203 context->ret.length = ACPI_ALLOCATE_BUFFER;
204 context->ret.pointer = NULL;
206 /* Setting up input parameters */
208 input.pointer = in_params;
209 in_params[0].type = ACPI_TYPE_BUFFER;
210 in_params[0].buffer.length = 16;
211 in_params[0].buffer.pointer = (u8 *)&guid;
212 in_params[1].type = ACPI_TYPE_INTEGER;
213 in_params[1].integer.value = context->rev;
214 in_params[2].type = ACPI_TYPE_INTEGER;
215 in_params[2].integer.value = context->cap.length/sizeof(u32);
216 in_params[3].type = ACPI_TYPE_BUFFER;
217 in_params[3].buffer.length = context->cap.length;
218 in_params[3].buffer.pointer = context->cap.pointer;
220 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
221 if (ACPI_FAILURE(status))
225 return AE_NULL_OBJECT;
227 out_obj = output.pointer;
228 if (out_obj->type != ACPI_TYPE_BUFFER
229 || out_obj->buffer.length != context->cap.length) {
230 acpi_print_osc_error(handle, context,
231 "_OSC evaluation returned wrong type");
235 /* Need to ignore the bit0 in result code */
236 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
238 if (errors & OSC_REQUEST_ERROR)
239 acpi_print_osc_error(handle, context,
240 "_OSC request failed");
241 if (errors & OSC_INVALID_UUID_ERROR)
242 acpi_print_osc_error(handle, context,
243 "_OSC invalid UUID");
244 if (errors & OSC_INVALID_REVISION_ERROR)
245 acpi_print_osc_error(handle, context,
246 "_OSC invalid revision");
247 if (errors & OSC_CAPABILITIES_MASK_ERROR) {
248 if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD]
258 context->ret.length = out_obj->buffer.length;
259 context->ret.pointer = kmemdup(out_obj->buffer.pointer,
260 context->ret.length, GFP_KERNEL);
261 if (!context->ret.pointer) {
262 status = AE_NO_MEMORY;
268 kfree(output.pointer);
271 EXPORT_SYMBOL(acpi_run_osc);
273 bool osc_sb_apei_support_acked;
276 * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
277 * OSPM supports platform coordinated low power idle(LPI) states
279 bool osc_pc_lpi_support_confirmed;
280 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
283 * ACPI 6.2 Section 6.2.11.2 'Platform-Wide OSPM Capabilities':
284 * Starting with ACPI Specification 6.2, all _CPC registers can be in
285 * PCC, System Memory, System IO, or Functional Fixed Hardware address
286 * spaces. OSPM support for this more flexible register space scheme is
287 * indicated by the “Flexible Address Space for CPPC Registers” _OSC bit.
289 * Otherwise (cf ACPI 6.1, s8.4.7.1.1.X), _CPC registers must be in:
290 * - PCC or Functional Fixed Hardware address space if defined
291 * - SystemMemory address space (NULL register) if not defined
293 bool osc_cpc_flexible_adr_space_confirmed;
294 EXPORT_SYMBOL_GPL(osc_cpc_flexible_adr_space_confirmed);
297 * ACPI 6.4 Operating System Capabilities for USB.
299 bool osc_sb_native_usb4_support_confirmed;
300 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_support_confirmed);
302 bool osc_sb_cppc2_support_acked;
304 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
305 static void acpi_bus_osc_negotiate_platform_control(void)
307 u32 capbuf[2], *capbuf_ret;
308 struct acpi_osc_context context = {
309 .uuid_str = sb_uuid_str,
312 .cap.pointer = capbuf,
316 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
317 capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */
318 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR))
319 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT;
320 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR))
321 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT;
323 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT;
324 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PCLPI_SUPPORT;
325 if (IS_ENABLED(CONFIG_ACPI_PRMT))
326 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PRM_SUPPORT;
327 if (IS_ENABLED(CONFIG_ACPI_FFH))
328 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_FFH_OPR_SUPPORT;
331 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
334 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
337 #ifdef CONFIG_ACPI_CPPC_LIB
338 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_SUPPORT;
339 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPCV2_SUPPORT;
342 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
344 if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
345 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
347 if (IS_ENABLED(CONFIG_USB4))
348 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_NATIVE_USB4_SUPPORT;
351 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
352 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
355 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
358 capbuf_ret = context.ret.pointer;
359 if (context.ret.length <= OSC_SUPPORT_DWORD) {
360 kfree(context.ret.pointer);
365 * Now run _OSC again with query flag clear and with the caps
366 * supported by both the OS and the platform.
368 capbuf[OSC_QUERY_DWORD] = 0;
369 capbuf[OSC_SUPPORT_DWORD] = capbuf_ret[OSC_SUPPORT_DWORD];
370 kfree(context.ret.pointer);
372 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
375 capbuf_ret = context.ret.pointer;
376 if (context.ret.length > OSC_SUPPORT_DWORD) {
377 #ifdef CONFIG_ACPI_CPPC_LIB
378 osc_sb_cppc2_support_acked = capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_CPCV2_SUPPORT;
381 osc_sb_apei_support_acked =
382 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
383 osc_pc_lpi_support_confirmed =
384 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT;
385 osc_sb_native_usb4_support_confirmed =
386 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_NATIVE_USB4_SUPPORT;
387 osc_cpc_flexible_adr_space_confirmed =
388 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
391 kfree(context.ret.pointer);
395 * Native control of USB4 capabilities. If any of the tunneling bits is
396 * set it means OS is in control and we use software based connection
399 u32 osc_sb_native_usb4_control;
400 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_control);
402 static void acpi_bus_decode_usb_osc(const char *msg, u32 bits)
404 pr_info("%s USB3%c DisplayPort%c PCIe%c XDomain%c\n", msg,
405 (bits & OSC_USB_USB3_TUNNELING) ? '+' : '-',
406 (bits & OSC_USB_DP_TUNNELING) ? '+' : '-',
407 (bits & OSC_USB_PCIE_TUNNELING) ? '+' : '-',
408 (bits & OSC_USB_XDOMAIN) ? '+' : '-');
411 static u8 sb_usb_uuid_str[] = "23A0D13A-26AB-486C-9C5F-0FFA525A575A";
412 static void acpi_bus_osc_negotiate_usb_control(void)
415 struct acpi_osc_context context = {
416 .uuid_str = sb_usb_uuid_str,
418 .cap.length = sizeof(capbuf),
419 .cap.pointer = capbuf,
425 if (!osc_sb_native_usb4_support_confirmed)
428 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
431 control = OSC_USB_USB3_TUNNELING | OSC_USB_DP_TUNNELING |
432 OSC_USB_PCIE_TUNNELING | OSC_USB_XDOMAIN;
434 capbuf[OSC_QUERY_DWORD] = 0;
435 capbuf[OSC_SUPPORT_DWORD] = 0;
436 capbuf[OSC_CONTROL_DWORD] = control;
438 status = acpi_run_osc(handle, &context);
439 if (ACPI_FAILURE(status))
442 if (context.ret.length != sizeof(capbuf)) {
443 pr_info("USB4 _OSC: returned invalid length buffer\n");
447 osc_sb_native_usb4_control =
448 control & acpi_osc_ctx_get_pci_control(&context);
450 acpi_bus_decode_usb_osc("USB4 _OSC: OS supports", control);
451 acpi_bus_decode_usb_osc("USB4 _OSC: OS controls",
452 osc_sb_native_usb4_control);
455 kfree(context.ret.pointer);
458 /* --------------------------------------------------------------------------
459 Notification Handling
460 -------------------------------------------------------------------------- */
463 * acpi_bus_notify - Global system-level (0x00-0x7F) notifications handler
464 * @handle: Target ACPI object.
465 * @type: Notification type.
468 * This only handles notifications related to device hotplug.
470 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
472 struct acpi_device *adev;
475 case ACPI_NOTIFY_BUS_CHECK:
476 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
479 case ACPI_NOTIFY_DEVICE_CHECK:
480 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
483 case ACPI_NOTIFY_DEVICE_WAKE:
484 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
487 case ACPI_NOTIFY_EJECT_REQUEST:
488 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
491 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
492 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
493 /* TBD: Exactly what does 'light' mean? */
496 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
497 acpi_handle_err(handle, "Device cannot be configured due "
498 "to a frequency mismatch\n");
501 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
502 acpi_handle_err(handle, "Device cannot be configured due "
503 "to a bus mode mismatch\n");
506 case ACPI_NOTIFY_POWER_FAULT:
507 acpi_handle_err(handle, "Device has suffered a power fault\n");
511 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
515 adev = acpi_get_acpi_dev(handle);
517 if (adev && ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
520 acpi_put_acpi_dev(adev);
522 acpi_evaluate_ost(handle, type, ACPI_OST_SC_NON_SPECIFIC_FAILURE, NULL);
525 static void acpi_notify_device(acpi_handle handle, u32 event, void *data)
527 struct acpi_device *device = data;
528 struct acpi_driver *acpi_drv = to_acpi_driver(device->dev.driver);
530 acpi_drv->ops.notify(device, event);
533 static void acpi_notify_device_fixed(void *data)
535 struct acpi_device *device = data;
537 /* Fixed hardware devices have no handles */
538 acpi_notify_device(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
541 static u32 acpi_device_fixed_event(void *data)
543 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_notify_device_fixed, data);
544 return ACPI_INTERRUPT_HANDLED;
547 static int acpi_device_install_notify_handler(struct acpi_device *device,
548 struct acpi_driver *acpi_drv)
552 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON) {
554 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
555 acpi_device_fixed_event,
557 } else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON) {
559 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
560 acpi_device_fixed_event,
563 u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
564 ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
566 status = acpi_install_notify_handler(device->handle, type,
571 if (ACPI_FAILURE(status))
576 static void acpi_device_remove_notify_handler(struct acpi_device *device,
577 struct acpi_driver *acpi_drv)
579 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON) {
580 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
581 acpi_device_fixed_event);
582 } else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON) {
583 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
584 acpi_device_fixed_event);
586 u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
587 ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
589 acpi_remove_notify_handler(device->handle, type,
592 acpi_os_wait_events_complete();
595 /* Handle events targeting \_SB device (at present only graceful shutdown) */
597 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
598 #define ACPI_SB_INDICATE_INTERVAL 10000
600 static void sb_notify_work(struct work_struct *dummy)
602 acpi_handle sb_handle;
604 orderly_poweroff(true);
607 * After initiating graceful shutdown, the ACPI spec requires OSPM
608 * to evaluate _OST method once every 10seconds to indicate that
609 * the shutdown is in progress
611 acpi_get_handle(NULL, "\\_SB", &sb_handle);
613 pr_info("Graceful shutdown in progress.\n");
614 acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN,
615 ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL);
616 msleep(ACPI_SB_INDICATE_INTERVAL);
620 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
622 static DECLARE_WORK(acpi_sb_work, sb_notify_work);
624 if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
625 if (!work_busy(&acpi_sb_work))
626 schedule_work(&acpi_sb_work);
628 pr_warn("event %x is not supported by \\_SB device\n", event);
632 static int __init acpi_setup_sb_notify_handler(void)
634 acpi_handle sb_handle;
636 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
639 if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
640 acpi_sb_notify, NULL)))
646 /* --------------------------------------------------------------------------
648 -------------------------------------------------------------------------- */
651 * acpi_get_first_physical_node - Get first physical node of an ACPI device
652 * @adev: ACPI device in question
654 * Return: First physical node of ACPI device @adev
656 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
658 struct mutex *physical_node_lock = &adev->physical_node_lock;
659 struct device *phys_dev;
661 mutex_lock(physical_node_lock);
662 if (list_empty(&adev->physical_node_list)) {
665 const struct acpi_device_physical_node *node;
667 node = list_first_entry(&adev->physical_node_list,
668 struct acpi_device_physical_node, node);
670 phys_dev = node->dev;
672 mutex_unlock(physical_node_lock);
675 EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
677 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
678 const struct device *dev)
680 const struct device *phys_dev = acpi_get_first_physical_node(adev);
682 return phys_dev && phys_dev == dev ? adev : NULL;
686 * acpi_device_is_first_physical_node - Is given dev first physical node
687 * @adev: ACPI companion device
688 * @dev: Physical device to check
690 * Function checks if given @dev is the first physical devices attached to
691 * the ACPI companion device. This distinction is needed in some cases
692 * where the same companion device is shared between many physical devices.
694 * Note that the caller have to provide valid @adev pointer.
696 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
697 const struct device *dev)
699 return !!acpi_primary_dev_companion(adev, dev);
703 * acpi_companion_match() - Can we match via ACPI companion device
704 * @dev: Device in question
706 * Check if the given device has an ACPI companion and if that companion has
707 * a valid list of PNP IDs, and if the device is the first (primary) physical
708 * device associated with it. Return the companion pointer if that's the case
711 * If multiple physical devices are attached to a single ACPI companion, we need
712 * to be careful. The usage scenario for this kind of relationship is that all
713 * of the physical devices in question use resources provided by the ACPI
714 * companion. A typical case is an MFD device where all the sub-devices share
715 * the parent's ACPI companion. In such cases we can only allow the primary
716 * (first) physical device to be matched with the help of the companion's PNP
719 * Additional physical devices sharing the ACPI companion can still use
720 * resources available from it but they will be matched normally using functions
721 * provided by their bus types (and analogously for their modalias).
723 struct acpi_device *acpi_companion_match(const struct device *dev)
725 struct acpi_device *adev;
727 adev = ACPI_COMPANION(dev);
731 if (list_empty(&adev->pnp.ids))
734 return acpi_primary_dev_companion(adev, dev);
738 * acpi_of_match_device - Match device object using the "compatible" property.
739 * @adev: ACPI device object to match.
740 * @of_match_table: List of device IDs to match against.
741 * @of_id: OF ID if matched
743 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
744 * identifiers and a _DSD object with the "compatible" property, use that
745 * property to match against the given list of identifiers.
747 static bool acpi_of_match_device(struct acpi_device *adev,
748 const struct of_device_id *of_match_table,
749 const struct of_device_id **of_id)
751 const union acpi_object *of_compatible, *obj;
757 of_compatible = adev->data.of_compatible;
758 if (!of_match_table || !of_compatible)
761 if (of_compatible->type == ACPI_TYPE_PACKAGE) {
762 nval = of_compatible->package.count;
763 obj = of_compatible->package.elements;
764 } else { /* Must be ACPI_TYPE_STRING. */
768 /* Now we can look for the driver DT compatible strings */
769 for (i = 0; i < nval; i++, obj++) {
770 const struct of_device_id *id;
772 for (id = of_match_table; id->compatible[0]; id++)
773 if (!strcasecmp(obj->string.pointer, id->compatible)) {
783 static bool acpi_of_modalias(struct acpi_device *adev,
784 char *modalias, size_t len)
786 const union acpi_object *of_compatible;
787 const union acpi_object *obj;
788 const char *str, *chr;
790 of_compatible = adev->data.of_compatible;
794 if (of_compatible->type == ACPI_TYPE_PACKAGE)
795 obj = of_compatible->package.elements;
796 else /* Must be ACPI_TYPE_STRING. */
799 str = obj->string.pointer;
800 chr = strchr(str, ',');
801 strscpy(modalias, chr ? chr + 1 : str, len);
807 * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
808 * @adev: ACPI device object to match
809 * @default_id: ID string to use as default if no compatible string found
810 * @modalias: Pointer to buffer that modalias value will be copied into
811 * @len: Length of modalias buffer
813 * This is a counterpart of of_alias_from_compatible() for struct acpi_device
814 * objects. If there is a compatible string for @adev, it will be copied to
815 * @modalias with the vendor prefix stripped; otherwise, @default_id will be
818 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
819 char *modalias, size_t len)
821 if (!acpi_of_modalias(adev, modalias, len))
822 strscpy(modalias, default_id, len);
824 EXPORT_SYMBOL_GPL(acpi_set_modalias);
826 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
827 struct acpi_hardware_id *hwid)
829 int i, msk, byte_shift;
835 /* Apply class-code bitmask, before checking each class-code byte */
836 for (i = 1; i <= 3; i++) {
837 byte_shift = 8 * (3 - i);
838 msk = (id->cls_msk >> byte_shift) & 0xFF;
842 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
843 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
849 static bool __acpi_match_device(struct acpi_device *device,
850 const struct acpi_device_id *acpi_ids,
851 const struct of_device_id *of_ids,
852 const struct acpi_device_id **acpi_id,
853 const struct of_device_id **of_id)
855 const struct acpi_device_id *id;
856 struct acpi_hardware_id *hwid;
859 * If the device is not present, it is unnecessary to load device
862 if (!device || !device->status.present)
865 list_for_each_entry(hwid, &device->pnp.ids, list) {
866 /* First, check the ACPI/PNP IDs provided by the caller. */
868 for (id = acpi_ids; id->id[0] || id->cls; id++) {
869 if (id->id[0] && !strcmp((char *)id->id, hwid->id))
871 if (id->cls && __acpi_match_device_cls(id, hwid))
877 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
878 * "compatible" property if found.
880 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
881 return acpi_of_match_device(device, of_ids, of_id);
892 * acpi_match_device - Match a struct device against a given list of ACPI IDs
893 * @ids: Array of struct acpi_device_id object to match against.
894 * @dev: The device structure to match.
896 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
897 * object for that handle and use that object to match against a given list of
900 * Return a pointer to the first matching ID on success or %NULL on failure.
902 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
903 const struct device *dev)
905 const struct acpi_device_id *id = NULL;
907 __acpi_match_device(acpi_companion_match(dev), ids, NULL, &id, NULL);
910 EXPORT_SYMBOL_GPL(acpi_match_device);
912 static const void *acpi_of_device_get_match_data(const struct device *dev)
914 struct acpi_device *adev = ACPI_COMPANION(dev);
915 const struct of_device_id *match = NULL;
917 if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
923 const void *acpi_device_get_match_data(const struct device *dev)
925 const struct acpi_device_id *acpi_ids = dev->driver->acpi_match_table;
926 const struct acpi_device_id *match;
929 return acpi_of_device_get_match_data(dev);
931 match = acpi_match_device(acpi_ids, dev);
935 return (const void *)match->driver_data;
937 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
939 int acpi_match_device_ids(struct acpi_device *device,
940 const struct acpi_device_id *ids)
942 return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
944 EXPORT_SYMBOL(acpi_match_device_ids);
946 bool acpi_driver_match_device(struct device *dev,
947 const struct device_driver *drv)
949 const struct acpi_device_id *acpi_ids = drv->acpi_match_table;
950 const struct of_device_id *of_ids = drv->of_match_table;
953 return acpi_of_match_device(ACPI_COMPANION(dev), of_ids, NULL);
955 return __acpi_match_device(acpi_companion_match(dev), acpi_ids, of_ids, NULL, NULL);
957 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
959 /* --------------------------------------------------------------------------
960 ACPI Driver Management
961 -------------------------------------------------------------------------- */
964 * acpi_bus_register_driver - register a driver with the ACPI bus
965 * @driver: driver being registered
967 * Registers a driver with the ACPI bus. Searches the namespace for all
968 * devices that match the driver's criteria and binds. Returns zero for
969 * success or a negative error status for failure.
971 int acpi_bus_register_driver(struct acpi_driver *driver)
975 driver->drv.name = driver->name;
976 driver->drv.bus = &acpi_bus_type;
977 driver->drv.owner = driver->owner;
979 return driver_register(&driver->drv);
982 EXPORT_SYMBOL(acpi_bus_register_driver);
985 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
986 * @driver: driver to unregister
988 * Unregisters a driver with the ACPI bus. Searches the namespace for all
989 * devices that match the driver's criteria and unbinds.
991 void acpi_bus_unregister_driver(struct acpi_driver *driver)
993 driver_unregister(&driver->drv);
996 EXPORT_SYMBOL(acpi_bus_unregister_driver);
998 /* --------------------------------------------------------------------------
1000 -------------------------------------------------------------------------- */
1002 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
1004 struct acpi_device *acpi_dev = to_acpi_device(dev);
1005 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
1007 return acpi_dev->flags.match_driver
1008 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
1011 static int acpi_device_uevent(const struct device *dev, struct kobj_uevent_env *env)
1013 return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
1016 static int acpi_device_probe(struct device *dev)
1018 struct acpi_device *acpi_dev = to_acpi_device(dev);
1019 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1022 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
1025 if (!acpi_drv->ops.add)
1028 ret = acpi_drv->ops.add(acpi_dev);
1032 pr_debug("Driver [%s] successfully bound to device [%s]\n",
1033 acpi_drv->name, acpi_dev->pnp.bus_id);
1035 if (acpi_drv->ops.notify) {
1036 ret = acpi_device_install_notify_handler(acpi_dev, acpi_drv);
1038 if (acpi_drv->ops.remove)
1039 acpi_drv->ops.remove(acpi_dev);
1041 acpi_dev->driver_data = NULL;
1046 pr_debug("Found driver [%s] for device [%s]\n", acpi_drv->name,
1047 acpi_dev->pnp.bus_id);
1053 static void acpi_device_remove(struct device *dev)
1055 struct acpi_device *acpi_dev = to_acpi_device(dev);
1056 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1058 if (acpi_drv->ops.notify)
1059 acpi_device_remove_notify_handler(acpi_dev, acpi_drv);
1061 if (acpi_drv->ops.remove)
1062 acpi_drv->ops.remove(acpi_dev);
1064 acpi_dev->driver_data = NULL;
1069 struct bus_type acpi_bus_type = {
1071 .match = acpi_bus_match,
1072 .probe = acpi_device_probe,
1073 .remove = acpi_device_remove,
1074 .uevent = acpi_device_uevent,
1077 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data)
1079 return bus_for_each_dev(&acpi_bus_type, NULL, data, fn);
1081 EXPORT_SYMBOL_GPL(acpi_bus_for_each_dev);
1083 struct acpi_dev_walk_context {
1084 int (*fn)(struct acpi_device *, void *);
1088 static int acpi_dev_for_one_check(struct device *dev, void *context)
1090 struct acpi_dev_walk_context *adwc = context;
1092 if (dev->bus != &acpi_bus_type)
1095 return adwc->fn(to_acpi_device(dev), adwc->data);
1097 EXPORT_SYMBOL_GPL(acpi_dev_for_each_child);
1099 int acpi_dev_for_each_child(struct acpi_device *adev,
1100 int (*fn)(struct acpi_device *, void *), void *data)
1102 struct acpi_dev_walk_context adwc = {
1107 return device_for_each_child(&adev->dev, &adwc, acpi_dev_for_one_check);
1110 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
1111 int (*fn)(struct acpi_device *, void *),
1114 struct acpi_dev_walk_context adwc = {
1119 return device_for_each_child_reverse(&adev->dev, &adwc, acpi_dev_for_one_check);
1122 /* --------------------------------------------------------------------------
1123 Initialization/Cleanup
1124 -------------------------------------------------------------------------- */
1126 static int __init acpi_bus_init_irq(void)
1129 char *message = NULL;
1133 * Let the system know what interrupt model we are using by
1134 * evaluating the \_PIC object, if exists.
1137 switch (acpi_irq_model) {
1138 case ACPI_IRQ_MODEL_PIC:
1141 case ACPI_IRQ_MODEL_IOAPIC:
1144 case ACPI_IRQ_MODEL_IOSAPIC:
1145 message = "IOSAPIC";
1147 case ACPI_IRQ_MODEL_GIC:
1150 case ACPI_IRQ_MODEL_PLATFORM:
1151 message = "platform specific model";
1153 case ACPI_IRQ_MODEL_LPIC:
1157 pr_info("Unknown interrupt routing model\n");
1161 pr_info("Using %s for interrupt routing\n", message);
1163 status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1164 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1165 pr_info("_PIC evaluation failed: %s\n", acpi_format_exception(status));
1173 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1175 * The ACPI tables are accessible after this, but the handling of events has not
1176 * been initialized and the global lock is not available yet, so AML should not
1177 * be executed at this point.
1179 * Doing this before switching the EFI runtime services to virtual mode allows
1180 * the EfiBootServices memory to be freed slightly earlier on boot.
1182 void __init acpi_early_init(void)
1189 pr_info("Core revision %08x\n", ACPI_CA_VERSION);
1191 /* enable workarounds, unless strict ACPI spec. compliance */
1193 acpi_gbl_enable_interpreter_slack = TRUE;
1195 acpi_permanent_mmap = true;
1199 * If the machine falls into the DMI check table,
1200 * DSDT will be copied to memory.
1201 * Note that calling dmi_check_system() here on other architectures
1202 * would not be OK because only x86 initializes dmi early enough.
1203 * Thankfully only x86 systems need such quirks for now.
1205 dmi_check_system(dsdt_dmi_table);
1208 status = acpi_reallocate_root_table();
1209 if (ACPI_FAILURE(status)) {
1210 pr_err("Unable to reallocate ACPI tables\n");
1214 status = acpi_initialize_subsystem();
1215 if (ACPI_FAILURE(status)) {
1216 pr_err("Unable to initialize the ACPI Interpreter\n");
1222 /* compatible (0) means level (3) */
1223 if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1224 acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1225 acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1227 /* Set PIC-mode SCI trigger type */
1228 acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1229 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1232 * now that acpi_gbl_FADT is initialized,
1233 * update it with result from INT_SRC_OVR parsing
1235 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1245 * acpi_subsystem_init - Finalize the early initialization of ACPI.
1247 * Switch over the platform to the ACPI mode (if possible).
1249 * Doing this too early is generally unsafe, but at the same time it needs to be
1250 * done before all things that really depend on ACPI. The right spot appears to
1251 * be before finalizing the EFI initialization.
1253 void __init acpi_subsystem_init(void)
1260 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1261 if (ACPI_FAILURE(status)) {
1262 pr_err("Unable to enable ACPI\n");
1266 * If the system is using ACPI then we can be reasonably
1267 * confident that any regulators are managed by the firmware
1268 * so tell the regulator core it has everything it needs to
1271 regulator_has_full_constraints();
1275 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1277 if (event == ACPI_TABLE_EVENT_LOAD)
1278 acpi_scan_table_notify();
1280 return acpi_sysfs_table_handler(event, table, context);
1283 static int __init acpi_bus_init(void)
1288 acpi_os_initialize1();
1290 status = acpi_load_tables();
1291 if (ACPI_FAILURE(status)) {
1292 pr_err("Unable to load the System Description Tables\n");
1297 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1298 * device is found in the namespace.
1300 * This is accomplished by looking for the ECDT table and getting the EC
1301 * parameters out of that.
1303 * Do that before calling acpi_initialize_objects() which may trigger EC
1304 * address space accesses.
1306 acpi_ec_ecdt_probe();
1308 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1309 if (ACPI_FAILURE(status)) {
1310 pr_err("Unable to start the ACPI Interpreter\n");
1314 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1315 if (ACPI_FAILURE(status)) {
1316 pr_err("Unable to initialize ACPI objects\n");
1320 /* Set capability bits for _OSC under processor scope */
1321 acpi_early_processor_osc();
1324 * _OSC method may exist in module level code,
1325 * so it must be run after ACPI_FULL_INITIALIZATION
1327 acpi_bus_osc_negotiate_platform_control();
1328 acpi_bus_osc_negotiate_usb_control();
1331 * _PDC control method may load dynamic SSDT tables,
1332 * and we need to install the table handler before that.
1334 status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1338 acpi_early_processor_set_pdc();
1341 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1342 * is necessary to enable it as early as possible.
1344 acpi_ec_dsdt_probe();
1346 pr_info("Interpreter enabled\n");
1348 /* Initialize sleep structures */
1352 * Get the system interrupt model and evaluate \_PIC.
1354 result = acpi_bus_init_irq();
1359 * Register the for all standard device notifications.
1362 acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1363 &acpi_bus_notify, NULL);
1364 if (ACPI_FAILURE(status)) {
1365 pr_err("Unable to register for system notifications\n");
1370 * Create the top ACPI proc directory
1372 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1374 result = bus_register(&acpi_bus_type);
1378 /* Mimic structured exception handling */
1384 struct kobject *acpi_kobj;
1385 EXPORT_SYMBOL_GPL(acpi_kobj);
1387 static int __init acpi_init(void)
1391 if (acpi_disabled) {
1392 pr_info("Interpreter disabled.\n");
1396 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1398 pr_debug("%s: kset create error\n", __func__);
1402 result = acpi_bus_init();
1404 kobject_put(acpi_kobj);
1410 pci_mmcfg_late_init();
1412 acpi_viot_early_init();
1417 acpi_debugfs_init();
1418 acpi_sleep_proc_init();
1419 acpi_wakeup_device_init();
1420 acpi_debugger_init();
1421 acpi_setup_sb_notify_handler();
1428 subsys_initcall(acpi_init);