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_viot.h>
30 #include <linux/pci.h>
31 #include <acpi/apei.h>
32 #include <linux/suspend.h>
33 #include <linux/prmt.h>
37 struct acpi_device *acpi_root;
38 struct proc_dir_entry *acpi_root_dir;
39 EXPORT_SYMBOL(acpi_root_dir);
42 #ifdef CONFIG_ACPI_CUSTOM_DSDT
43 static inline int set_copy_dsdt(const struct dmi_system_id *id)
48 static int set_copy_dsdt(const struct dmi_system_id *id)
50 pr_notice("%s detected - force copy of DSDT to local memory\n", id->ident);
51 acpi_gbl_copy_dsdt_locally = 1;
56 static const struct dmi_system_id dsdt_dmi_table[] __initconst = {
58 * Invoke DSDT corruption work-around on all Toshiba Satellite.
59 * https://bugzilla.kernel.org/show_bug.cgi?id=14679
62 .callback = set_copy_dsdt,
63 .ident = "TOSHIBA Satellite",
65 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
66 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite"),
73 /* --------------------------------------------------------------------------
75 -------------------------------------------------------------------------- */
77 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
78 unsigned long long *sta)
82 status = acpi_evaluate_integer(handle, "_STA", NULL, sta);
83 if (ACPI_SUCCESS(status))
86 if (status == AE_NOT_FOUND) {
87 *sta = ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED |
88 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING;
93 EXPORT_SYMBOL_GPL(acpi_bus_get_status_handle);
95 int acpi_bus_get_status(struct acpi_device *device)
98 unsigned long long sta;
100 if (acpi_device_override_status(device, &sta)) {
101 acpi_set_device_status(device, sta);
105 /* Battery devices must have their deps met before calling _STA */
106 if (acpi_device_is_battery(device) && device->dep_unmet) {
107 acpi_set_device_status(device, 0);
111 status = acpi_bus_get_status_handle(device->handle, &sta);
112 if (ACPI_FAILURE(status))
115 acpi_set_device_status(device, sta);
117 if (device->status.functional && !device->status.present) {
118 pr_debug("Device [%s] status [%08x]: functional but not present\n",
119 device->pnp.bus_id, (u32)sta);
122 pr_debug("Device [%s] status [%08x]\n", device->pnp.bus_id, (u32)sta);
125 EXPORT_SYMBOL(acpi_bus_get_status);
127 void acpi_bus_private_data_handler(acpi_handle handle,
132 EXPORT_SYMBOL(acpi_bus_private_data_handler);
134 int acpi_bus_attach_private_data(acpi_handle handle, void *data)
138 status = acpi_attach_data(handle,
139 acpi_bus_private_data_handler, data);
140 if (ACPI_FAILURE(status)) {
141 acpi_handle_debug(handle, "Error attaching device data\n");
147 EXPORT_SYMBOL_GPL(acpi_bus_attach_private_data);
149 int acpi_bus_get_private_data(acpi_handle handle, void **data)
156 status = acpi_get_data(handle, acpi_bus_private_data_handler, data);
157 if (ACPI_FAILURE(status)) {
158 acpi_handle_debug(handle, "No context for object\n");
164 EXPORT_SYMBOL_GPL(acpi_bus_get_private_data);
166 void acpi_bus_detach_private_data(acpi_handle handle)
168 acpi_detach_data(handle, acpi_bus_private_data_handler);
170 EXPORT_SYMBOL_GPL(acpi_bus_detach_private_data);
172 static void acpi_print_osc_error(acpi_handle handle,
173 struct acpi_osc_context *context, char *error)
177 acpi_handle_debug(handle, "(%s): %s\n", context->uuid_str, error);
179 pr_debug("_OSC request data:");
180 for (i = 0; i < context->cap.length; i += sizeof(u32))
181 pr_debug(" %x", *((u32 *)(context->cap.pointer + i)));
186 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context)
189 struct acpi_object_list input;
190 union acpi_object in_params[4];
191 union acpi_object *out_obj;
194 struct acpi_buffer output = {ACPI_ALLOCATE_BUFFER, NULL};
198 if (guid_parse(context->uuid_str, &guid))
200 context->ret.length = ACPI_ALLOCATE_BUFFER;
201 context->ret.pointer = NULL;
203 /* Setting up input parameters */
205 input.pointer = in_params;
206 in_params[0].type = ACPI_TYPE_BUFFER;
207 in_params[0].buffer.length = 16;
208 in_params[0].buffer.pointer = (u8 *)&guid;
209 in_params[1].type = ACPI_TYPE_INTEGER;
210 in_params[1].integer.value = context->rev;
211 in_params[2].type = ACPI_TYPE_INTEGER;
212 in_params[2].integer.value = context->cap.length/sizeof(u32);
213 in_params[3].type = ACPI_TYPE_BUFFER;
214 in_params[3].buffer.length = context->cap.length;
215 in_params[3].buffer.pointer = context->cap.pointer;
217 status = acpi_evaluate_object(handle, "_OSC", &input, &output);
218 if (ACPI_FAILURE(status))
222 return AE_NULL_OBJECT;
224 out_obj = output.pointer;
225 if (out_obj->type != ACPI_TYPE_BUFFER
226 || out_obj->buffer.length != context->cap.length) {
227 acpi_print_osc_error(handle, context,
228 "_OSC evaluation returned wrong type");
232 /* Need to ignore the bit0 in result code */
233 errors = *((u32 *)out_obj->buffer.pointer) & ~(1 << 0);
235 if (errors & OSC_REQUEST_ERROR)
236 acpi_print_osc_error(handle, context,
237 "_OSC request failed");
238 if (errors & OSC_INVALID_UUID_ERROR)
239 acpi_print_osc_error(handle, context,
240 "_OSC invalid UUID");
241 if (errors & OSC_INVALID_REVISION_ERROR)
242 acpi_print_osc_error(handle, context,
243 "_OSC invalid revision");
244 if (errors & OSC_CAPABILITIES_MASK_ERROR) {
245 if (((u32 *)context->cap.pointer)[OSC_QUERY_DWORD]
255 context->ret.length = out_obj->buffer.length;
256 context->ret.pointer = kmemdup(out_obj->buffer.pointer,
257 context->ret.length, GFP_KERNEL);
258 if (!context->ret.pointer) {
259 status = AE_NO_MEMORY;
265 kfree(output.pointer);
268 EXPORT_SYMBOL(acpi_run_osc);
270 bool osc_sb_apei_support_acked;
273 * ACPI 6.0 Section 8.4.4.2 Idle State Coordination
274 * OSPM supports platform coordinated low power idle(LPI) states
276 bool osc_pc_lpi_support_confirmed;
277 EXPORT_SYMBOL_GPL(osc_pc_lpi_support_confirmed);
280 * ACPI 6.2 Section 6.2.11.2 'Platform-Wide OSPM Capabilities':
281 * Starting with ACPI Specification 6.2, all _CPC registers can be in
282 * PCC, System Memory, System IO, or Functional Fixed Hardware address
283 * spaces. OSPM support for this more flexible register space scheme is
284 * indicated by the “Flexible Address Space for CPPC Registers” _OSC bit.
286 * Otherwise (cf ACPI 6.1, s8.4.7.1.1.X), _CPC registers must be in:
287 * - PCC or Functional Fixed Hardware address space if defined
288 * - SystemMemory address space (NULL register) if not defined
290 bool osc_cpc_flexible_adr_space_confirmed;
291 EXPORT_SYMBOL_GPL(osc_cpc_flexible_adr_space_confirmed);
294 * ACPI 6.4 Operating System Capabilities for USB.
296 bool osc_sb_native_usb4_support_confirmed;
297 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_support_confirmed);
299 bool osc_sb_cppc2_support_acked;
301 static u8 sb_uuid_str[] = "0811B06E-4A27-44F9-8D60-3CBBC22E7B48";
302 static void acpi_bus_osc_negotiate_platform_control(void)
304 u32 capbuf[2], *capbuf_ret;
305 struct acpi_osc_context context = {
306 .uuid_str = sb_uuid_str,
309 .cap.pointer = capbuf,
313 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
314 capbuf[OSC_SUPPORT_DWORD] = OSC_SB_PR3_SUPPORT; /* _PR3 is in use */
315 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR_AGGREGATOR))
316 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PAD_SUPPORT;
317 if (IS_ENABLED(CONFIG_ACPI_PROCESSOR))
318 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PPC_OST_SUPPORT;
320 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_HOTPLUG_OST_SUPPORT;
321 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PCLPI_SUPPORT;
322 if (IS_ENABLED(CONFIG_ACPI_PRMT))
323 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_PRM_SUPPORT;
324 if (IS_ENABLED(CONFIG_ACPI_FFH))
325 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_FFH_OPR_SUPPORT;
328 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
331 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_GENERIC_INITIATOR_SUPPORT;
334 #ifdef CONFIG_ACPI_CPPC_LIB
335 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_SUPPORT;
336 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPCV2_SUPPORT;
339 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
341 if (IS_ENABLED(CONFIG_SCHED_MC_PRIO))
342 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_CPC_DIVERSE_HIGH_SUPPORT;
344 if (IS_ENABLED(CONFIG_USB4))
345 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_NATIVE_USB4_SUPPORT;
348 capbuf[OSC_SUPPORT_DWORD] |= OSC_SB_APEI_SUPPORT;
349 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
352 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
355 capbuf_ret = context.ret.pointer;
356 if (context.ret.length <= OSC_SUPPORT_DWORD) {
357 kfree(context.ret.pointer);
362 * Now run _OSC again with query flag clear and with the caps
363 * supported by both the OS and the platform.
365 capbuf[OSC_QUERY_DWORD] = 0;
366 capbuf[OSC_SUPPORT_DWORD] = capbuf_ret[OSC_SUPPORT_DWORD];
367 kfree(context.ret.pointer);
369 if (ACPI_FAILURE(acpi_run_osc(handle, &context)))
372 capbuf_ret = context.ret.pointer;
373 if (context.ret.length > OSC_SUPPORT_DWORD) {
374 #ifdef CONFIG_ACPI_CPPC_LIB
375 osc_sb_cppc2_support_acked = capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_CPCV2_SUPPORT;
378 osc_sb_apei_support_acked =
379 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_APEI_SUPPORT;
380 osc_pc_lpi_support_confirmed =
381 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_PCLPI_SUPPORT;
382 osc_sb_native_usb4_support_confirmed =
383 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_NATIVE_USB4_SUPPORT;
384 osc_cpc_flexible_adr_space_confirmed =
385 capbuf_ret[OSC_SUPPORT_DWORD] & OSC_SB_CPC_FLEXIBLE_ADR_SPACE;
388 kfree(context.ret.pointer);
392 * Native control of USB4 capabilities. If any of the tunneling bits is
393 * set it means OS is in control and we use software based connection
396 u32 osc_sb_native_usb4_control;
397 EXPORT_SYMBOL_GPL(osc_sb_native_usb4_control);
399 static void acpi_bus_decode_usb_osc(const char *msg, u32 bits)
401 pr_info("%s USB3%c DisplayPort%c PCIe%c XDomain%c\n", msg,
402 (bits & OSC_USB_USB3_TUNNELING) ? '+' : '-',
403 (bits & OSC_USB_DP_TUNNELING) ? '+' : '-',
404 (bits & OSC_USB_PCIE_TUNNELING) ? '+' : '-',
405 (bits & OSC_USB_XDOMAIN) ? '+' : '-');
408 static u8 sb_usb_uuid_str[] = "23A0D13A-26AB-486C-9C5F-0FFA525A575A";
409 static void acpi_bus_osc_negotiate_usb_control(void)
411 u32 capbuf[3], *capbuf_ret;
412 struct acpi_osc_context context = {
413 .uuid_str = sb_usb_uuid_str,
415 .cap.length = sizeof(capbuf),
416 .cap.pointer = capbuf,
422 if (!osc_sb_native_usb4_support_confirmed)
425 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &handle)))
428 control = OSC_USB_USB3_TUNNELING | OSC_USB_DP_TUNNELING |
429 OSC_USB_PCIE_TUNNELING | OSC_USB_XDOMAIN;
432 * Run _OSC first with query bit set, trying to get control over
433 * all tunneling. The platform can then clear out bits in the
434 * control dword that it does not want to grant to the OS.
436 capbuf[OSC_QUERY_DWORD] = OSC_QUERY_ENABLE;
437 capbuf[OSC_SUPPORT_DWORD] = 0;
438 capbuf[OSC_CONTROL_DWORD] = control;
440 status = acpi_run_osc(handle, &context);
441 if (ACPI_FAILURE(status))
444 if (context.ret.length != sizeof(capbuf)) {
445 pr_info("USB4 _OSC: returned invalid length buffer\n");
450 * Run _OSC again now with query bit clear and the control dword
451 * matching what the platform granted (which may not have all
452 * the control bits set).
454 capbuf_ret = context.ret.pointer;
456 capbuf[OSC_QUERY_DWORD] = 0;
457 capbuf[OSC_CONTROL_DWORD] = capbuf_ret[OSC_CONTROL_DWORD];
459 kfree(context.ret.pointer);
461 status = acpi_run_osc(handle, &context);
462 if (ACPI_FAILURE(status))
465 if (context.ret.length != sizeof(capbuf)) {
466 pr_info("USB4 _OSC: returned invalid length buffer\n");
470 osc_sb_native_usb4_control =
471 control & acpi_osc_ctx_get_pci_control(&context);
473 acpi_bus_decode_usb_osc("USB4 _OSC: OS supports", control);
474 acpi_bus_decode_usb_osc("USB4 _OSC: OS controls",
475 osc_sb_native_usb4_control);
478 kfree(context.ret.pointer);
481 /* --------------------------------------------------------------------------
482 Notification Handling
483 -------------------------------------------------------------------------- */
486 * acpi_bus_notify - Global system-level (0x00-0x7F) notifications handler
487 * @handle: Target ACPI object.
488 * @type: Notification type.
491 * This only handles notifications related to device hotplug.
493 static void acpi_bus_notify(acpi_handle handle, u32 type, void *data)
495 struct acpi_device *adev;
498 case ACPI_NOTIFY_BUS_CHECK:
499 acpi_handle_debug(handle, "ACPI_NOTIFY_BUS_CHECK event\n");
502 case ACPI_NOTIFY_DEVICE_CHECK:
503 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK event\n");
506 case ACPI_NOTIFY_DEVICE_WAKE:
507 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_WAKE event\n");
510 case ACPI_NOTIFY_EJECT_REQUEST:
511 acpi_handle_debug(handle, "ACPI_NOTIFY_EJECT_REQUEST event\n");
514 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
515 acpi_handle_debug(handle, "ACPI_NOTIFY_DEVICE_CHECK_LIGHT event\n");
516 /* TBD: Exactly what does 'light' mean? */
519 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
520 acpi_handle_err(handle, "Device cannot be configured due "
521 "to a frequency mismatch\n");
524 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
525 acpi_handle_err(handle, "Device cannot be configured due "
526 "to a bus mode mismatch\n");
529 case ACPI_NOTIFY_POWER_FAULT:
530 acpi_handle_err(handle, "Device has suffered a power fault\n");
534 acpi_handle_debug(handle, "Unknown event type 0x%x\n", type);
538 adev = acpi_get_acpi_dev(handle);
540 if (adev && ACPI_SUCCESS(acpi_hotplug_schedule(adev, type)))
543 acpi_put_acpi_dev(adev);
545 acpi_evaluate_ost(handle, type, ACPI_OST_SC_NON_SPECIFIC_FAILURE, NULL);
548 static void acpi_notify_device(acpi_handle handle, u32 event, void *data)
550 struct acpi_device *device = data;
551 struct acpi_driver *acpi_drv = to_acpi_driver(device->dev.driver);
553 acpi_drv->ops.notify(device, event);
556 static int acpi_device_install_notify_handler(struct acpi_device *device,
557 struct acpi_driver *acpi_drv)
559 u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
560 ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
563 status = acpi_install_notify_handler(device->handle, type,
564 acpi_notify_device, device);
565 if (ACPI_FAILURE(status))
571 static void acpi_device_remove_notify_handler(struct acpi_device *device,
572 struct acpi_driver *acpi_drv)
574 u32 type = acpi_drv->flags & ACPI_DRIVER_ALL_NOTIFY_EVENTS ?
575 ACPI_ALL_NOTIFY : ACPI_DEVICE_NOTIFY;
577 acpi_remove_notify_handler(device->handle, type,
580 acpi_os_wait_events_complete();
583 int acpi_dev_install_notify_handler(struct acpi_device *adev,
585 acpi_notify_handler handler, void *context)
589 status = acpi_install_notify_handler(adev->handle, handler_type,
591 if (ACPI_FAILURE(status))
596 EXPORT_SYMBOL_GPL(acpi_dev_install_notify_handler);
598 void acpi_dev_remove_notify_handler(struct acpi_device *adev,
600 acpi_notify_handler handler)
602 acpi_remove_notify_handler(adev->handle, handler_type, handler);
603 acpi_os_wait_events_complete();
605 EXPORT_SYMBOL_GPL(acpi_dev_remove_notify_handler);
607 /* Handle events targeting \_SB device (at present only graceful shutdown) */
609 #define ACPI_SB_NOTIFY_SHUTDOWN_REQUEST 0x81
610 #define ACPI_SB_INDICATE_INTERVAL 10000
612 static void sb_notify_work(struct work_struct *dummy)
614 acpi_handle sb_handle;
616 orderly_poweroff(true);
619 * After initiating graceful shutdown, the ACPI spec requires OSPM
620 * to evaluate _OST method once every 10seconds to indicate that
621 * the shutdown is in progress
623 acpi_get_handle(NULL, "\\_SB", &sb_handle);
625 pr_info("Graceful shutdown in progress.\n");
626 acpi_evaluate_ost(sb_handle, ACPI_OST_EC_OSPM_SHUTDOWN,
627 ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS, NULL);
628 msleep(ACPI_SB_INDICATE_INTERVAL);
632 static void acpi_sb_notify(acpi_handle handle, u32 event, void *data)
634 static DECLARE_WORK(acpi_sb_work, sb_notify_work);
636 if (event == ACPI_SB_NOTIFY_SHUTDOWN_REQUEST) {
637 if (!work_busy(&acpi_sb_work))
638 schedule_work(&acpi_sb_work);
640 pr_warn("event %x is not supported by \\_SB device\n", event);
644 static int __init acpi_setup_sb_notify_handler(void)
646 acpi_handle sb_handle;
648 if (ACPI_FAILURE(acpi_get_handle(NULL, "\\_SB", &sb_handle)))
651 if (ACPI_FAILURE(acpi_install_notify_handler(sb_handle, ACPI_DEVICE_NOTIFY,
652 acpi_sb_notify, NULL)))
658 /* --------------------------------------------------------------------------
660 -------------------------------------------------------------------------- */
663 * acpi_get_first_physical_node - Get first physical node of an ACPI device
664 * @adev: ACPI device in question
666 * Return: First physical node of ACPI device @adev
668 struct device *acpi_get_first_physical_node(struct acpi_device *adev)
670 struct mutex *physical_node_lock = &adev->physical_node_lock;
671 struct device *phys_dev;
673 mutex_lock(physical_node_lock);
674 if (list_empty(&adev->physical_node_list)) {
677 const struct acpi_device_physical_node *node;
679 node = list_first_entry(&adev->physical_node_list,
680 struct acpi_device_physical_node, node);
682 phys_dev = node->dev;
684 mutex_unlock(physical_node_lock);
687 EXPORT_SYMBOL_GPL(acpi_get_first_physical_node);
689 static struct acpi_device *acpi_primary_dev_companion(struct acpi_device *adev,
690 const struct device *dev)
692 const struct device *phys_dev = acpi_get_first_physical_node(adev);
694 return phys_dev && phys_dev == dev ? adev : NULL;
698 * acpi_device_is_first_physical_node - Is given dev first physical node
699 * @adev: ACPI companion device
700 * @dev: Physical device to check
702 * Function checks if given @dev is the first physical devices attached to
703 * the ACPI companion device. This distinction is needed in some cases
704 * where the same companion device is shared between many physical devices.
706 * Note that the caller have to provide valid @adev pointer.
708 bool acpi_device_is_first_physical_node(struct acpi_device *adev,
709 const struct device *dev)
711 return !!acpi_primary_dev_companion(adev, dev);
715 * acpi_companion_match() - Can we match via ACPI companion device
716 * @dev: Device in question
718 * Check if the given device has an ACPI companion and if that companion has
719 * a valid list of PNP IDs, and if the device is the first (primary) physical
720 * device associated with it. Return the companion pointer if that's the case
723 * If multiple physical devices are attached to a single ACPI companion, we need
724 * to be careful. The usage scenario for this kind of relationship is that all
725 * of the physical devices in question use resources provided by the ACPI
726 * companion. A typical case is an MFD device where all the sub-devices share
727 * the parent's ACPI companion. In such cases we can only allow the primary
728 * (first) physical device to be matched with the help of the companion's PNP
731 * Additional physical devices sharing the ACPI companion can still use
732 * resources available from it but they will be matched normally using functions
733 * provided by their bus types (and analogously for their modalias).
735 const struct acpi_device *acpi_companion_match(const struct device *dev)
737 struct acpi_device *adev;
739 adev = ACPI_COMPANION(dev);
743 if (list_empty(&adev->pnp.ids))
746 return acpi_primary_dev_companion(adev, dev);
750 * acpi_of_match_device - Match device object using the "compatible" property.
751 * @adev: ACPI device object to match.
752 * @of_match_table: List of device IDs to match against.
753 * @of_id: OF ID if matched
755 * If @dev has an ACPI companion which has ACPI_DT_NAMESPACE_HID in its list of
756 * identifiers and a _DSD object with the "compatible" property, use that
757 * property to match against the given list of identifiers.
759 static bool acpi_of_match_device(const struct acpi_device *adev,
760 const struct of_device_id *of_match_table,
761 const struct of_device_id **of_id)
763 const union acpi_object *of_compatible, *obj;
769 of_compatible = adev->data.of_compatible;
770 if (!of_match_table || !of_compatible)
773 if (of_compatible->type == ACPI_TYPE_PACKAGE) {
774 nval = of_compatible->package.count;
775 obj = of_compatible->package.elements;
776 } else { /* Must be ACPI_TYPE_STRING. */
780 /* Now we can look for the driver DT compatible strings */
781 for (i = 0; i < nval; i++, obj++) {
782 const struct of_device_id *id;
784 for (id = of_match_table; id->compatible[0]; id++)
785 if (!strcasecmp(obj->string.pointer, id->compatible)) {
795 static bool acpi_of_modalias(struct acpi_device *adev,
796 char *modalias, size_t len)
798 const union acpi_object *of_compatible;
799 const union acpi_object *obj;
800 const char *str, *chr;
802 of_compatible = adev->data.of_compatible;
806 if (of_compatible->type == ACPI_TYPE_PACKAGE)
807 obj = of_compatible->package.elements;
808 else /* Must be ACPI_TYPE_STRING. */
811 str = obj->string.pointer;
812 chr = strchr(str, ',');
813 strscpy(modalias, chr ? chr + 1 : str, len);
819 * acpi_set_modalias - Set modalias using "compatible" property or supplied ID
820 * @adev: ACPI device object to match
821 * @default_id: ID string to use as default if no compatible string found
822 * @modalias: Pointer to buffer that modalias value will be copied into
823 * @len: Length of modalias buffer
825 * This is a counterpart of of_alias_from_compatible() for struct acpi_device
826 * objects. If there is a compatible string for @adev, it will be copied to
827 * @modalias with the vendor prefix stripped; otherwise, @default_id will be
830 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
831 char *modalias, size_t len)
833 if (!acpi_of_modalias(adev, modalias, len))
834 strscpy(modalias, default_id, len);
836 EXPORT_SYMBOL_GPL(acpi_set_modalias);
838 static bool __acpi_match_device_cls(const struct acpi_device_id *id,
839 struct acpi_hardware_id *hwid)
841 int i, msk, byte_shift;
847 /* Apply class-code bitmask, before checking each class-code byte */
848 for (i = 1; i <= 3; i++) {
849 byte_shift = 8 * (3 - i);
850 msk = (id->cls_msk >> byte_shift) & 0xFF;
854 sprintf(buf, "%02x", (id->cls >> byte_shift) & msk);
855 if (strncmp(buf, &hwid->id[(i - 1) * 2], 2))
861 static bool __acpi_match_device(const struct acpi_device *device,
862 const struct acpi_device_id *acpi_ids,
863 const struct of_device_id *of_ids,
864 const struct acpi_device_id **acpi_id,
865 const struct of_device_id **of_id)
867 const struct acpi_device_id *id;
868 struct acpi_hardware_id *hwid;
871 * If the device is not present, it is unnecessary to load device
874 if (!device || !device->status.present)
877 list_for_each_entry(hwid, &device->pnp.ids, list) {
878 /* First, check the ACPI/PNP IDs provided by the caller. */
880 for (id = acpi_ids; id->id[0] || id->cls; id++) {
881 if (id->id[0] && !strcmp((char *)id->id, hwid->id))
883 if (id->cls && __acpi_match_device_cls(id, hwid))
889 * Next, check ACPI_DT_NAMESPACE_HID and try to match the
890 * "compatible" property if found.
892 if (!strcmp(ACPI_DT_NAMESPACE_HID, hwid->id))
893 return acpi_of_match_device(device, of_ids, of_id);
904 * acpi_match_acpi_device - Match an ACPI device against a given list of ACPI IDs
905 * @ids: Array of struct acpi_device_id objects to match against.
906 * @adev: The ACPI device pointer to match.
908 * Match the ACPI device @adev against a given list of ACPI IDs @ids.
911 * a pointer to the first matching ACPI ID on success or %NULL on failure.
913 const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
914 const struct acpi_device *adev)
916 const struct acpi_device_id *id = NULL;
918 __acpi_match_device(adev, ids, NULL, &id, NULL);
921 EXPORT_SYMBOL_GPL(acpi_match_acpi_device);
924 * acpi_match_device - Match a struct device against a given list of ACPI IDs
925 * @ids: Array of struct acpi_device_id object to match against.
926 * @dev: The device structure to match.
928 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
929 * object for that handle and use that object to match against a given list of
932 * Return a pointer to the first matching ID on success or %NULL on failure.
934 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
935 const struct device *dev)
937 return acpi_match_acpi_device(ids, acpi_companion_match(dev));
939 EXPORT_SYMBOL_GPL(acpi_match_device);
941 static const void *acpi_of_device_get_match_data(const struct device *dev)
943 struct acpi_device *adev = ACPI_COMPANION(dev);
944 const struct of_device_id *match = NULL;
946 if (!acpi_of_match_device(adev, dev->driver->of_match_table, &match))
952 const void *acpi_device_get_match_data(const struct device *dev)
954 const struct acpi_device_id *acpi_ids = dev->driver->acpi_match_table;
955 const struct acpi_device_id *match;
958 return acpi_of_device_get_match_data(dev);
960 match = acpi_match_device(acpi_ids, dev);
964 return (const void *)match->driver_data;
966 EXPORT_SYMBOL_GPL(acpi_device_get_match_data);
968 int acpi_match_device_ids(struct acpi_device *device,
969 const struct acpi_device_id *ids)
971 return __acpi_match_device(device, ids, NULL, NULL, NULL) ? 0 : -ENOENT;
973 EXPORT_SYMBOL(acpi_match_device_ids);
975 bool acpi_driver_match_device(struct device *dev,
976 const struct device_driver *drv)
978 const struct acpi_device_id *acpi_ids = drv->acpi_match_table;
979 const struct of_device_id *of_ids = drv->of_match_table;
982 return acpi_of_match_device(ACPI_COMPANION(dev), of_ids, NULL);
984 return __acpi_match_device(acpi_companion_match(dev), acpi_ids, of_ids, NULL, NULL);
986 EXPORT_SYMBOL_GPL(acpi_driver_match_device);
988 /* --------------------------------------------------------------------------
989 ACPI Driver Management
990 -------------------------------------------------------------------------- */
993 * acpi_bus_register_driver - register a driver with the ACPI bus
994 * @driver: driver being registered
996 * Registers a driver with the ACPI bus. Searches the namespace for all
997 * devices that match the driver's criteria and binds. Returns zero for
998 * success or a negative error status for failure.
1000 int acpi_bus_register_driver(struct acpi_driver *driver)
1004 driver->drv.name = driver->name;
1005 driver->drv.bus = &acpi_bus_type;
1006 driver->drv.owner = driver->owner;
1008 return driver_register(&driver->drv);
1011 EXPORT_SYMBOL(acpi_bus_register_driver);
1014 * acpi_bus_unregister_driver - unregisters a driver with the ACPI bus
1015 * @driver: driver to unregister
1017 * Unregisters a driver with the ACPI bus. Searches the namespace for all
1018 * devices that match the driver's criteria and unbinds.
1020 void acpi_bus_unregister_driver(struct acpi_driver *driver)
1022 driver_unregister(&driver->drv);
1025 EXPORT_SYMBOL(acpi_bus_unregister_driver);
1027 /* --------------------------------------------------------------------------
1029 -------------------------------------------------------------------------- */
1031 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
1033 struct acpi_device *acpi_dev = to_acpi_device(dev);
1034 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
1036 return acpi_dev->flags.match_driver
1037 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
1040 static int acpi_device_uevent(const struct device *dev, struct kobj_uevent_env *env)
1042 return __acpi_device_uevent_modalias(to_acpi_device(dev), env);
1045 static int acpi_device_probe(struct device *dev)
1047 struct acpi_device *acpi_dev = to_acpi_device(dev);
1048 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1051 if (acpi_dev->handler && !acpi_is_pnp_device(acpi_dev))
1054 if (!acpi_drv->ops.add)
1057 ret = acpi_drv->ops.add(acpi_dev);
1059 acpi_dev->driver_data = NULL;
1063 pr_debug("Driver [%s] successfully bound to device [%s]\n",
1064 acpi_drv->name, acpi_dev->pnp.bus_id);
1066 if (acpi_drv->ops.notify) {
1067 ret = acpi_device_install_notify_handler(acpi_dev, acpi_drv);
1069 if (acpi_drv->ops.remove)
1070 acpi_drv->ops.remove(acpi_dev);
1072 acpi_dev->driver_data = NULL;
1077 pr_debug("Found driver [%s] for device [%s]\n", acpi_drv->name,
1078 acpi_dev->pnp.bus_id);
1084 static void acpi_device_remove(struct device *dev)
1086 struct acpi_device *acpi_dev = to_acpi_device(dev);
1087 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
1089 if (acpi_drv->ops.notify)
1090 acpi_device_remove_notify_handler(acpi_dev, acpi_drv);
1092 if (acpi_drv->ops.remove)
1093 acpi_drv->ops.remove(acpi_dev);
1095 acpi_dev->driver_data = NULL;
1100 const struct bus_type acpi_bus_type = {
1102 .match = acpi_bus_match,
1103 .probe = acpi_device_probe,
1104 .remove = acpi_device_remove,
1105 .uevent = acpi_device_uevent,
1108 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data)
1110 return bus_for_each_dev(&acpi_bus_type, NULL, data, fn);
1112 EXPORT_SYMBOL_GPL(acpi_bus_for_each_dev);
1114 struct acpi_dev_walk_context {
1115 int (*fn)(struct acpi_device *, void *);
1119 static int acpi_dev_for_one_check(struct device *dev, void *context)
1121 struct acpi_dev_walk_context *adwc = context;
1123 if (dev->bus != &acpi_bus_type)
1126 return adwc->fn(to_acpi_device(dev), adwc->data);
1128 EXPORT_SYMBOL_GPL(acpi_dev_for_each_child);
1130 int acpi_dev_for_each_child(struct acpi_device *adev,
1131 int (*fn)(struct acpi_device *, void *), void *data)
1133 struct acpi_dev_walk_context adwc = {
1138 return device_for_each_child(&adev->dev, &adwc, acpi_dev_for_one_check);
1141 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
1142 int (*fn)(struct acpi_device *, void *),
1145 struct acpi_dev_walk_context adwc = {
1150 return device_for_each_child_reverse(&adev->dev, &adwc, acpi_dev_for_one_check);
1153 /* --------------------------------------------------------------------------
1154 Initialization/Cleanup
1155 -------------------------------------------------------------------------- */
1157 static int __init acpi_bus_init_irq(void)
1160 char *message = NULL;
1164 * Let the system know what interrupt model we are using by
1165 * evaluating the \_PIC object, if exists.
1168 switch (acpi_irq_model) {
1169 case ACPI_IRQ_MODEL_PIC:
1172 case ACPI_IRQ_MODEL_IOAPIC:
1175 case ACPI_IRQ_MODEL_IOSAPIC:
1176 message = "IOSAPIC";
1178 case ACPI_IRQ_MODEL_GIC:
1181 case ACPI_IRQ_MODEL_PLATFORM:
1182 message = "platform specific model";
1184 case ACPI_IRQ_MODEL_LPIC:
1188 pr_info("Unknown interrupt routing model\n");
1192 pr_info("Using %s for interrupt routing\n", message);
1194 status = acpi_execute_simple_method(NULL, "\\_PIC", acpi_irq_model);
1195 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
1196 pr_info("_PIC evaluation failed: %s\n", acpi_format_exception(status));
1204 * acpi_early_init - Initialize ACPICA and populate the ACPI namespace.
1206 * The ACPI tables are accessible after this, but the handling of events has not
1207 * been initialized and the global lock is not available yet, so AML should not
1208 * be executed at this point.
1210 * Doing this before switching the EFI runtime services to virtual mode allows
1211 * the EfiBootServices memory to be freed slightly earlier on boot.
1213 void __init acpi_early_init(void)
1220 pr_info("Core revision %08x\n", ACPI_CA_VERSION);
1222 /* enable workarounds, unless strict ACPI spec. compliance */
1224 acpi_gbl_enable_interpreter_slack = TRUE;
1226 acpi_permanent_mmap = true;
1230 * If the machine falls into the DMI check table,
1231 * DSDT will be copied to memory.
1232 * Note that calling dmi_check_system() here on other architectures
1233 * would not be OK because only x86 initializes dmi early enough.
1234 * Thankfully only x86 systems need such quirks for now.
1236 dmi_check_system(dsdt_dmi_table);
1239 status = acpi_reallocate_root_table();
1240 if (ACPI_FAILURE(status)) {
1241 pr_err("Unable to reallocate ACPI tables\n");
1245 status = acpi_initialize_subsystem();
1246 if (ACPI_FAILURE(status)) {
1247 pr_err("Unable to initialize the ACPI Interpreter\n");
1253 /* compatible (0) means level (3) */
1254 if (!(acpi_sci_flags & ACPI_MADT_TRIGGER_MASK)) {
1255 acpi_sci_flags &= ~ACPI_MADT_TRIGGER_MASK;
1256 acpi_sci_flags |= ACPI_MADT_TRIGGER_LEVEL;
1258 /* Set PIC-mode SCI trigger type */
1259 acpi_pic_sci_set_trigger(acpi_gbl_FADT.sci_interrupt,
1260 (acpi_sci_flags & ACPI_MADT_TRIGGER_MASK) >> 2);
1263 * now that acpi_gbl_FADT is initialized,
1264 * update it with result from INT_SRC_OVR parsing
1266 acpi_gbl_FADT.sci_interrupt = acpi_sci_override_gsi;
1276 * acpi_subsystem_init - Finalize the early initialization of ACPI.
1278 * Switch over the platform to the ACPI mode (if possible).
1280 * Doing this too early is generally unsafe, but at the same time it needs to be
1281 * done before all things that really depend on ACPI. The right spot appears to
1282 * be before finalizing the EFI initialization.
1284 void __init acpi_subsystem_init(void)
1291 status = acpi_enable_subsystem(~ACPI_NO_ACPI_ENABLE);
1292 if (ACPI_FAILURE(status)) {
1293 pr_err("Unable to enable ACPI\n");
1297 * If the system is using ACPI then we can be reasonably
1298 * confident that any regulators are managed by the firmware
1299 * so tell the regulator core it has everything it needs to
1302 regulator_has_full_constraints();
1306 static acpi_status acpi_bus_table_handler(u32 event, void *table, void *context)
1308 if (event == ACPI_TABLE_EVENT_LOAD)
1309 acpi_scan_table_notify();
1311 return acpi_sysfs_table_handler(event, table, context);
1314 static int __init acpi_bus_init(void)
1319 acpi_os_initialize1();
1321 status = acpi_load_tables();
1322 if (ACPI_FAILURE(status)) {
1323 pr_err("Unable to load the System Description Tables\n");
1328 * ACPI 2.0 requires the EC driver to be loaded and work before the EC
1329 * device is found in the namespace.
1331 * This is accomplished by looking for the ECDT table and getting the EC
1332 * parameters out of that.
1334 * Do that before calling acpi_initialize_objects() which may trigger EC
1335 * address space accesses.
1337 acpi_ec_ecdt_probe();
1339 status = acpi_enable_subsystem(ACPI_NO_ACPI_ENABLE);
1340 if (ACPI_FAILURE(status)) {
1341 pr_err("Unable to start the ACPI Interpreter\n");
1345 status = acpi_initialize_objects(ACPI_FULL_INITIALIZATION);
1346 if (ACPI_FAILURE(status)) {
1347 pr_err("Unable to initialize ACPI objects\n");
1352 * _OSC method may exist in module level code,
1353 * so it must be run after ACPI_FULL_INITIALIZATION
1355 acpi_bus_osc_negotiate_platform_control();
1356 acpi_bus_osc_negotiate_usb_control();
1359 * _PDC control method may load dynamic SSDT tables,
1360 * and we need to install the table handler before that.
1362 status = acpi_install_table_handler(acpi_bus_table_handler, NULL);
1366 acpi_early_processor_control_setup();
1369 * Maybe EC region is required at bus_scan/acpi_get_devices. So it
1370 * is necessary to enable it as early as possible.
1372 acpi_ec_dsdt_probe();
1374 pr_info("Interpreter enabled\n");
1376 /* Initialize sleep structures */
1380 * Get the system interrupt model and evaluate \_PIC.
1382 result = acpi_bus_init_irq();
1387 * Register the for all standard device notifications.
1390 acpi_install_notify_handler(ACPI_ROOT_OBJECT, ACPI_SYSTEM_NOTIFY,
1391 &acpi_bus_notify, NULL);
1392 if (ACPI_FAILURE(status)) {
1393 pr_err("Unable to register for system notifications\n");
1398 * Create the top ACPI proc directory
1400 acpi_root_dir = proc_mkdir(ACPI_BUS_FILE_ROOT, NULL);
1402 result = bus_register(&acpi_bus_type);
1406 /* Mimic structured exception handling */
1412 struct kobject *acpi_kobj;
1413 EXPORT_SYMBOL_GPL(acpi_kobj);
1415 static int __init acpi_init(void)
1419 if (acpi_disabled) {
1420 pr_info("Interpreter disabled.\n");
1424 acpi_kobj = kobject_create_and_add("acpi", firmware_kobj);
1426 pr_debug("%s: kset create error\n", __func__);
1430 result = acpi_bus_init();
1432 kobject_put(acpi_kobj);
1438 pci_mmcfg_late_init();
1439 acpi_viot_early_init();
1445 acpi_debugfs_init();
1446 acpi_sleep_proc_init();
1447 acpi_wakeup_device_init();
1448 acpi_debugger_init();
1449 acpi_setup_sb_notify_handler();
1454 subsys_initcall(acpi_init);