1 // SPDX-License-Identifier: GPL-2.0-only
3 * scan.c - support for transforming the ACPI namespace into individual objects
6 #include <linux/module.h>
7 #include <linux/init.h>
8 #include <linux/slab.h>
9 #include <linux/kernel.h>
10 #include <linux/acpi.h>
11 #include <linux/acpi_iort.h>
12 #include <linux/signal.h>
13 #include <linux/kthread.h>
14 #include <linux/dmi.h>
15 #include <linux/nls.h>
16 #include <linux/dma-map-ops.h>
17 #include <linux/platform_data/x86/apple.h>
18 #include <linux/pgtable.h>
22 #define _COMPONENT ACPI_BUS_COMPONENT
23 ACPI_MODULE_NAME("scan");
24 extern struct acpi_device *acpi_root;
26 #define ACPI_BUS_CLASS "system_bus"
27 #define ACPI_BUS_HID "LNXSYBUS"
28 #define ACPI_BUS_DEVICE_NAME "System Bus"
30 #define ACPI_IS_ROOT_DEVICE(device) (!(device)->parent)
32 #define INVALID_ACPI_HANDLE ((acpi_handle)empty_zero_page)
34 static const char *dummy_hid = "device";
36 static LIST_HEAD(acpi_dep_list);
37 static DEFINE_MUTEX(acpi_dep_list_lock);
38 LIST_HEAD(acpi_bus_id_list);
39 static DEFINE_MUTEX(acpi_scan_lock);
40 static LIST_HEAD(acpi_scan_handlers_list);
41 DEFINE_MUTEX(acpi_device_lock);
42 LIST_HEAD(acpi_wakeup_device_list);
43 static DEFINE_MUTEX(acpi_hp_context_lock);
46 * The UART device described by the SPCR table is the only object which needs
47 * special-casing. Everything else is covered by ACPI namespace paths in STAO
50 static u64 spcr_uart_addr;
52 struct acpi_dep_data {
53 struct list_head node;
58 void acpi_scan_lock_acquire(void)
60 mutex_lock(&acpi_scan_lock);
62 EXPORT_SYMBOL_GPL(acpi_scan_lock_acquire);
64 void acpi_scan_lock_release(void)
66 mutex_unlock(&acpi_scan_lock);
68 EXPORT_SYMBOL_GPL(acpi_scan_lock_release);
70 void acpi_lock_hp_context(void)
72 mutex_lock(&acpi_hp_context_lock);
75 void acpi_unlock_hp_context(void)
77 mutex_unlock(&acpi_hp_context_lock);
80 void acpi_initialize_hp_context(struct acpi_device *adev,
81 struct acpi_hotplug_context *hp,
82 int (*notify)(struct acpi_device *, u32),
83 void (*uevent)(struct acpi_device *, u32))
85 acpi_lock_hp_context();
88 acpi_set_hp_context(adev, hp);
89 acpi_unlock_hp_context();
91 EXPORT_SYMBOL_GPL(acpi_initialize_hp_context);
93 int acpi_scan_add_handler(struct acpi_scan_handler *handler)
98 list_add_tail(&handler->list_node, &acpi_scan_handlers_list);
102 int acpi_scan_add_handler_with_hotplug(struct acpi_scan_handler *handler,
103 const char *hotplug_profile_name)
107 error = acpi_scan_add_handler(handler);
111 acpi_sysfs_add_hotplug_profile(&handler->hotplug, hotplug_profile_name);
115 bool acpi_scan_is_offline(struct acpi_device *adev, bool uevent)
117 struct acpi_device_physical_node *pn;
119 char *envp[] = { "EVENT=offline", NULL };
122 * acpi_container_offline() calls this for all of the container's
123 * children under the container's physical_node_lock lock.
125 mutex_lock_nested(&adev->physical_node_lock, SINGLE_DEPTH_NESTING);
127 list_for_each_entry(pn, &adev->physical_node_list, node)
128 if (device_supports_offline(pn->dev) && !pn->dev->offline) {
130 kobject_uevent_env(&pn->dev->kobj, KOBJ_CHANGE, envp);
136 mutex_unlock(&adev->physical_node_lock);
140 static acpi_status acpi_bus_offline(acpi_handle handle, u32 lvl, void *data,
143 struct acpi_device *device = NULL;
144 struct acpi_device_physical_node *pn;
145 bool second_pass = (bool)data;
146 acpi_status status = AE_OK;
148 if (acpi_bus_get_device(handle, &device))
151 if (device->handler && !device->handler->hotplug.enabled) {
152 *ret_p = &device->dev;
156 mutex_lock(&device->physical_node_lock);
158 list_for_each_entry(pn, &device->physical_node_list, node) {
162 /* Skip devices offlined by the first pass. */
166 pn->put_online = false;
168 ret = device_offline(pn->dev);
170 pn->put_online = !ret;
180 mutex_unlock(&device->physical_node_lock);
185 static acpi_status acpi_bus_online(acpi_handle handle, u32 lvl, void *data,
188 struct acpi_device *device = NULL;
189 struct acpi_device_physical_node *pn;
191 if (acpi_bus_get_device(handle, &device))
194 mutex_lock(&device->physical_node_lock);
196 list_for_each_entry(pn, &device->physical_node_list, node)
197 if (pn->put_online) {
198 device_online(pn->dev);
199 pn->put_online = false;
202 mutex_unlock(&device->physical_node_lock);
207 static int acpi_scan_try_to_offline(struct acpi_device *device)
209 acpi_handle handle = device->handle;
210 struct device *errdev = NULL;
214 * Carry out two passes here and ignore errors in the first pass,
215 * because if the devices in question are memory blocks and
216 * CONFIG_MEMCG is set, one of the blocks may hold data structures
217 * that the other blocks depend on, but it is not known in advance which
220 * If the first pass is successful, the second one isn't needed, though.
222 status = acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
223 NULL, acpi_bus_offline, (void *)false,
225 if (status == AE_SUPPORT) {
226 dev_warn(errdev, "Offline disabled.\n");
227 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
228 acpi_bus_online, NULL, NULL, NULL);
231 acpi_bus_offline(handle, 0, (void *)false, (void **)&errdev);
234 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
235 NULL, acpi_bus_offline, (void *)true,
238 acpi_bus_offline(handle, 0, (void *)true,
242 dev_warn(errdev, "Offline failed.\n");
243 acpi_bus_online(handle, 0, NULL, NULL);
244 acpi_walk_namespace(ACPI_TYPE_ANY, handle,
245 ACPI_UINT32_MAX, acpi_bus_online,
253 static int acpi_scan_hot_remove(struct acpi_device *device)
255 acpi_handle handle = device->handle;
256 unsigned long long sta;
259 if (device->handler && device->handler->hotplug.demand_offline) {
260 if (!acpi_scan_is_offline(device, true))
263 int error = acpi_scan_try_to_offline(device);
268 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
269 "Hot-removing device %s...\n", dev_name(&device->dev)));
271 acpi_bus_trim(device);
273 acpi_evaluate_lck(handle, 0);
277 status = acpi_evaluate_ej0(handle);
278 if (status == AE_NOT_FOUND)
280 else if (ACPI_FAILURE(status))
284 * Verify if eject was indeed successful. If not, log an error
285 * message. No need to call _OST since _EJ0 call was made OK.
287 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
288 if (ACPI_FAILURE(status)) {
289 acpi_handle_warn(handle,
290 "Status check after eject failed (0x%x)\n", status);
291 } else if (sta & ACPI_STA_DEVICE_ENABLED) {
292 acpi_handle_warn(handle,
293 "Eject incomplete - status 0x%llx\n", sta);
299 static int acpi_scan_device_not_present(struct acpi_device *adev)
301 if (!acpi_device_enumerated(adev)) {
302 dev_warn(&adev->dev, "Still not present\n");
309 static int acpi_scan_device_check(struct acpi_device *adev)
313 acpi_bus_get_status(adev);
314 if (adev->status.present || adev->status.functional) {
316 * This function is only called for device objects for which
317 * matching scan handlers exist. The only situation in which
318 * the scan handler is not attached to this device object yet
319 * is when the device has just appeared (either it wasn't
320 * present at all before or it was removed and then added
324 dev_warn(&adev->dev, "Already enumerated\n");
327 error = acpi_bus_scan(adev->handle);
329 dev_warn(&adev->dev, "Namespace scan failure\n");
332 if (!adev->handler) {
333 dev_warn(&adev->dev, "Enumeration failure\n");
337 error = acpi_scan_device_not_present(adev);
342 static int acpi_scan_bus_check(struct acpi_device *adev)
344 struct acpi_scan_handler *handler = adev->handler;
345 struct acpi_device *child;
348 acpi_bus_get_status(adev);
349 if (!(adev->status.present || adev->status.functional)) {
350 acpi_scan_device_not_present(adev);
353 if (handler && handler->hotplug.scan_dependent)
354 return handler->hotplug.scan_dependent(adev);
356 error = acpi_bus_scan(adev->handle);
358 dev_warn(&adev->dev, "Namespace scan failure\n");
361 list_for_each_entry(child, &adev->children, node) {
362 error = acpi_scan_bus_check(child);
369 static int acpi_generic_hotplug_event(struct acpi_device *adev, u32 type)
372 case ACPI_NOTIFY_BUS_CHECK:
373 return acpi_scan_bus_check(adev);
374 case ACPI_NOTIFY_DEVICE_CHECK:
375 return acpi_scan_device_check(adev);
376 case ACPI_NOTIFY_EJECT_REQUEST:
377 case ACPI_OST_EC_OSPM_EJECT:
378 if (adev->handler && !adev->handler->hotplug.enabled) {
379 dev_info(&adev->dev, "Eject disabled\n");
382 acpi_evaluate_ost(adev->handle, ACPI_NOTIFY_EJECT_REQUEST,
383 ACPI_OST_SC_EJECT_IN_PROGRESS, NULL);
384 return acpi_scan_hot_remove(adev);
389 void acpi_device_hotplug(struct acpi_device *adev, u32 src)
391 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
394 lock_device_hotplug();
395 mutex_lock(&acpi_scan_lock);
398 * The device object's ACPI handle cannot become invalid as long as we
399 * are holding acpi_scan_lock, but it might have become invalid before
400 * that lock was acquired.
402 if (adev->handle == INVALID_ACPI_HANDLE)
405 if (adev->flags.is_dock_station) {
406 error = dock_notify(adev, src);
407 } else if (adev->flags.hotplug_notify) {
408 error = acpi_generic_hotplug_event(adev, src);
410 int (*notify)(struct acpi_device *, u32);
412 acpi_lock_hp_context();
413 notify = adev->hp ? adev->hp->notify : NULL;
414 acpi_unlock_hp_context();
416 * There may be additional notify handlers for device objects
417 * without the .event() callback, so ignore them here.
420 error = notify(adev, src);
426 ost_code = ACPI_OST_SC_SUCCESS;
429 ost_code = ACPI_OST_SC_EJECT_NOT_SUPPORTED;
432 ost_code = ACPI_OST_SC_DEVICE_BUSY;
435 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE;
440 acpi_evaluate_ost(adev->handle, src, ost_code, NULL);
443 acpi_bus_put_acpi_device(adev);
444 mutex_unlock(&acpi_scan_lock);
445 unlock_device_hotplug();
448 static void acpi_free_power_resources_lists(struct acpi_device *device)
452 if (device->wakeup.flags.valid)
453 acpi_power_resources_list_free(&device->wakeup.resources);
455 if (!device->power.flags.power_resources)
458 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
459 struct acpi_device_power_state *ps = &device->power.states[i];
460 acpi_power_resources_list_free(&ps->resources);
464 static void acpi_device_release(struct device *dev)
466 struct acpi_device *acpi_dev = to_acpi_device(dev);
468 acpi_free_properties(acpi_dev);
469 acpi_free_pnp_ids(&acpi_dev->pnp);
470 acpi_free_power_resources_lists(acpi_dev);
474 static void acpi_device_del(struct acpi_device *device)
476 struct acpi_device_bus_id *acpi_device_bus_id;
478 mutex_lock(&acpi_device_lock);
480 list_del(&device->node);
482 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node)
483 if (!strcmp(acpi_device_bus_id->bus_id,
484 acpi_device_hid(device))) {
485 ida_simple_remove(&acpi_device_bus_id->instance_ida, device->pnp.instance_no);
486 if (ida_is_empty(&acpi_device_bus_id->instance_ida)) {
487 list_del(&acpi_device_bus_id->node);
488 kfree_const(acpi_device_bus_id->bus_id);
489 kfree(acpi_device_bus_id);
494 list_del(&device->wakeup_list);
495 mutex_unlock(&acpi_device_lock);
497 acpi_power_add_remove_device(device, false);
498 acpi_device_remove_files(device);
500 device->remove(device);
502 device_del(&device->dev);
505 static BLOCKING_NOTIFIER_HEAD(acpi_reconfig_chain);
507 static LIST_HEAD(acpi_device_del_list);
508 static DEFINE_MUTEX(acpi_device_del_lock);
510 static void acpi_device_del_work_fn(struct work_struct *work_not_used)
513 struct acpi_device *adev;
515 mutex_lock(&acpi_device_del_lock);
517 if (list_empty(&acpi_device_del_list)) {
518 mutex_unlock(&acpi_device_del_lock);
521 adev = list_first_entry(&acpi_device_del_list,
522 struct acpi_device, del_list);
523 list_del(&adev->del_list);
525 mutex_unlock(&acpi_device_del_lock);
527 blocking_notifier_call_chain(&acpi_reconfig_chain,
528 ACPI_RECONFIG_DEVICE_REMOVE, adev);
530 acpi_device_del(adev);
532 * Drop references to all power resources that might have been
533 * used by the device.
535 acpi_power_transition(adev, ACPI_STATE_D3_COLD);
536 put_device(&adev->dev);
541 * acpi_scan_drop_device - Drop an ACPI device object.
542 * @handle: Handle of an ACPI namespace node, not used.
543 * @context: Address of the ACPI device object to drop.
545 * This is invoked by acpi_ns_delete_node() during the removal of the ACPI
546 * namespace node the device object pointed to by @context is attached to.
548 * The unregistration is carried out asynchronously to avoid running
549 * acpi_device_del() under the ACPICA's namespace mutex and the list is used to
550 * ensure the correct ordering (the device objects must be unregistered in the
551 * same order in which the corresponding namespace nodes are deleted).
553 static void acpi_scan_drop_device(acpi_handle handle, void *context)
555 static DECLARE_WORK(work, acpi_device_del_work_fn);
556 struct acpi_device *adev = context;
558 mutex_lock(&acpi_device_del_lock);
561 * Use the ACPI hotplug workqueue which is ordered, so this work item
562 * won't run after any hotplug work items submitted subsequently. That
563 * prevents attempts to register device objects identical to those being
564 * deleted from happening concurrently (such attempts result from
565 * hotplug events handled via the ACPI hotplug workqueue). It also will
566 * run after all of the work items submitted previosuly, which helps
567 * those work items to ensure that they are not accessing stale device
570 if (list_empty(&acpi_device_del_list))
571 acpi_queue_hotplug_work(&work);
573 list_add_tail(&adev->del_list, &acpi_device_del_list);
574 /* Make acpi_ns_validate_handle() return NULL for this handle. */
575 adev->handle = INVALID_ACPI_HANDLE;
577 mutex_unlock(&acpi_device_del_lock);
580 static int acpi_get_device_data(acpi_handle handle, struct acpi_device **device,
581 void (*callback)(void *))
590 status = acpi_get_data_full(handle, acpi_scan_drop_device,
591 (void **)device, callback);
592 if (ACPI_FAILURE(status) || !*device) {
593 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "No context for object [%p]\n",
600 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device)
602 return acpi_get_device_data(handle, device, NULL);
604 EXPORT_SYMBOL(acpi_bus_get_device);
606 static void get_acpi_device(void *dev)
609 get_device(&((struct acpi_device *)dev)->dev);
612 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle)
614 struct acpi_device *adev = NULL;
616 acpi_get_device_data(handle, &adev, get_acpi_device);
620 void acpi_bus_put_acpi_device(struct acpi_device *adev)
622 put_device(&adev->dev);
625 static struct acpi_device_bus_id *acpi_device_bus_id_match(const char *dev_id)
627 struct acpi_device_bus_id *acpi_device_bus_id;
629 /* Find suitable bus_id and instance number in acpi_bus_id_list. */
630 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
631 if (!strcmp(acpi_device_bus_id->bus_id, dev_id))
632 return acpi_device_bus_id;
637 static int acpi_device_set_name(struct acpi_device *device,
638 struct acpi_device_bus_id *acpi_device_bus_id)
640 struct ida *instance_ida = &acpi_device_bus_id->instance_ida;
643 result = ida_simple_get(instance_ida, 0, ACPI_MAX_DEVICE_INSTANCES, GFP_KERNEL);
647 device->pnp.instance_no = result;
648 dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, result);
652 int acpi_device_add(struct acpi_device *device,
653 void (*release)(struct device *))
655 struct acpi_device_bus_id *acpi_device_bus_id;
658 if (device->handle) {
661 status = acpi_attach_data(device->handle, acpi_scan_drop_device,
663 if (ACPI_FAILURE(status)) {
664 acpi_handle_err(device->handle,
665 "Unable to attach device data\n");
673 * Link this device to its parent and siblings.
675 INIT_LIST_HEAD(&device->children);
676 INIT_LIST_HEAD(&device->node);
677 INIT_LIST_HEAD(&device->wakeup_list);
678 INIT_LIST_HEAD(&device->physical_node_list);
679 INIT_LIST_HEAD(&device->del_list);
680 mutex_init(&device->physical_node_lock);
682 mutex_lock(&acpi_device_lock);
684 acpi_device_bus_id = acpi_device_bus_id_match(acpi_device_hid(device));
685 if (acpi_device_bus_id) {
686 result = acpi_device_set_name(device, acpi_device_bus_id);
690 acpi_device_bus_id = kzalloc(sizeof(*acpi_device_bus_id),
692 if (!acpi_device_bus_id) {
696 acpi_device_bus_id->bus_id =
697 kstrdup_const(acpi_device_hid(device), GFP_KERNEL);
698 if (!acpi_device_bus_id->bus_id) {
699 kfree(acpi_device_bus_id);
704 ida_init(&acpi_device_bus_id->instance_ida);
706 result = acpi_device_set_name(device, acpi_device_bus_id);
708 kfree_const(acpi_device_bus_id->bus_id);
709 kfree(acpi_device_bus_id);
713 list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
717 list_add_tail(&device->node, &device->parent->children);
719 if (device->wakeup.flags.valid)
720 list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);
721 mutex_unlock(&acpi_device_lock);
724 device->dev.parent = &device->parent->dev;
725 device->dev.bus = &acpi_bus_type;
726 device->dev.release = release;
727 result = device_add(&device->dev);
729 dev_err(&device->dev, "Error registering device\n");
733 result = acpi_device_setup_files(device);
735 printk(KERN_ERR PREFIX "Error creating sysfs interface for device %s\n",
736 dev_name(&device->dev));
741 mutex_lock(&acpi_device_lock);
743 list_del(&device->node);
744 list_del(&device->wakeup_list);
747 mutex_unlock(&acpi_device_lock);
749 acpi_detach_data(device->handle, acpi_scan_drop_device);
753 /* --------------------------------------------------------------------------
755 -------------------------------------------------------------------------- */
756 static struct acpi_device *acpi_bus_get_parent(acpi_handle handle)
758 struct acpi_device *device = NULL;
762 * Fixed hardware devices do not appear in the namespace and do not
763 * have handles, but we fabricate acpi_devices for them, so we have
764 * to deal with them specially.
770 status = acpi_get_parent(handle, &handle);
771 if (ACPI_FAILURE(status))
772 return status == AE_NULL_ENTRY ? NULL : acpi_root;
773 } while (acpi_bus_get_device(handle, &device));
778 acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
782 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
783 union acpi_object *obj;
785 status = acpi_get_handle(handle, "_EJD", &tmp);
786 if (ACPI_FAILURE(status))
789 status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
790 if (ACPI_SUCCESS(status)) {
791 obj = buffer.pointer;
792 status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
794 kfree(buffer.pointer);
798 EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);
800 static int acpi_bus_extract_wakeup_device_power_package(struct acpi_device *dev)
802 acpi_handle handle = dev->handle;
803 struct acpi_device_wakeup *wakeup = &dev->wakeup;
804 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
805 union acpi_object *package = NULL;
806 union acpi_object *element = NULL;
810 INIT_LIST_HEAD(&wakeup->resources);
813 status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
814 if (ACPI_FAILURE(status)) {
815 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRW"));
819 package = (union acpi_object *)buffer.pointer;
821 if (!package || package->package.count < 2)
824 element = &(package->package.elements[0]);
828 if (element->type == ACPI_TYPE_PACKAGE) {
829 if ((element->package.count < 2) ||
830 (element->package.elements[0].type !=
831 ACPI_TYPE_LOCAL_REFERENCE)
832 || (element->package.elements[1].type != ACPI_TYPE_INTEGER))
836 element->package.elements[0].reference.handle;
838 (u32) element->package.elements[1].integer.value;
839 } else if (element->type == ACPI_TYPE_INTEGER) {
840 wakeup->gpe_device = NULL;
841 wakeup->gpe_number = element->integer.value;
846 element = &(package->package.elements[1]);
847 if (element->type != ACPI_TYPE_INTEGER)
850 wakeup->sleep_state = element->integer.value;
852 err = acpi_extract_power_resources(package, 2, &wakeup->resources);
856 if (!list_empty(&wakeup->resources)) {
859 err = acpi_power_wakeup_list_init(&wakeup->resources,
862 acpi_handle_warn(handle, "Retrieving current states "
863 "of wakeup power resources failed\n");
864 acpi_power_resources_list_free(&wakeup->resources);
867 if (sleep_state < wakeup->sleep_state) {
868 acpi_handle_warn(handle, "Overriding _PRW sleep state "
869 "(S%d) by S%d from power resources\n",
870 (int)wakeup->sleep_state, sleep_state);
871 wakeup->sleep_state = sleep_state;
876 kfree(buffer.pointer);
880 static bool acpi_wakeup_gpe_init(struct acpi_device *device)
882 static const struct acpi_device_id button_device_ids[] = {
883 {"PNP0C0C", 0}, /* Power button */
884 {"PNP0C0D", 0}, /* Lid */
885 {"PNP0C0E", 0}, /* Sleep button */
888 struct acpi_device_wakeup *wakeup = &device->wakeup;
891 wakeup->flags.notifier_present = 0;
893 /* Power button, Lid switch always enable wakeup */
894 if (!acpi_match_device_ids(device, button_device_ids)) {
895 if (!acpi_match_device_ids(device, &button_device_ids[1])) {
896 /* Do not use Lid/sleep button for S5 wakeup */
897 if (wakeup->sleep_state == ACPI_STATE_S5)
898 wakeup->sleep_state = ACPI_STATE_S4;
900 acpi_mark_gpe_for_wake(wakeup->gpe_device, wakeup->gpe_number);
901 device_set_wakeup_capable(&device->dev, true);
905 status = acpi_setup_gpe_for_wake(device->handle, wakeup->gpe_device,
907 return ACPI_SUCCESS(status);
910 static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
914 /* Presence of _PRW indicates wake capable */
915 if (!acpi_has_method(device->handle, "_PRW"))
918 err = acpi_bus_extract_wakeup_device_power_package(device);
920 dev_err(&device->dev, "_PRW evaluation error: %d\n", err);
924 device->wakeup.flags.valid = acpi_wakeup_gpe_init(device);
925 device->wakeup.prepare_count = 0;
927 * Call _PSW/_DSW object to disable its ability to wake the sleeping
928 * system for the ACPI device with the _PRW object.
929 * The _PSW object is deprecated in ACPI 3.0 and is replaced by _DSW.
930 * So it is necessary to call _DSW object first. Only when it is not
931 * present will the _PSW object used.
933 err = acpi_device_sleep_wake(device, 0, 0, 0);
935 pr_debug("error in _DSW or _PSW evaluation\n");
938 static void acpi_bus_init_power_state(struct acpi_device *device, int state)
940 struct acpi_device_power_state *ps = &device->power.states[state];
941 char pathname[5] = { '_', 'P', 'R', '0' + state, '\0' };
942 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
945 INIT_LIST_HEAD(&ps->resources);
947 /* Evaluate "_PRx" to get referenced power resources */
948 status = acpi_evaluate_object(device->handle, pathname, NULL, &buffer);
949 if (ACPI_SUCCESS(status)) {
950 union acpi_object *package = buffer.pointer;
952 if (buffer.length && package
953 && package->type == ACPI_TYPE_PACKAGE
954 && package->package.count)
955 acpi_extract_power_resources(package, 0, &ps->resources);
957 ACPI_FREE(buffer.pointer);
960 /* Evaluate "_PSx" to see if we can do explicit sets */
962 if (acpi_has_method(device->handle, pathname))
963 ps->flags.explicit_set = 1;
965 /* State is valid if there are means to put the device into it. */
966 if (!list_empty(&ps->resources) || ps->flags.explicit_set)
969 ps->power = -1; /* Unknown - driver assigned */
970 ps->latency = -1; /* Unknown - driver assigned */
973 static void acpi_bus_get_power_flags(struct acpi_device *device)
977 /* Presence of _PS0|_PR0 indicates 'power manageable' */
978 if (!acpi_has_method(device->handle, "_PS0") &&
979 !acpi_has_method(device->handle, "_PR0"))
982 device->flags.power_manageable = 1;
985 * Power Management Flags
987 if (acpi_has_method(device->handle, "_PSC"))
988 device->power.flags.explicit_get = 1;
990 if (acpi_has_method(device->handle, "_IRC"))
991 device->power.flags.inrush_current = 1;
993 if (acpi_has_method(device->handle, "_DSW"))
994 device->power.flags.dsw_present = 1;
997 * Enumerate supported power management states
999 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++)
1000 acpi_bus_init_power_state(device, i);
1002 INIT_LIST_HEAD(&device->power.states[ACPI_STATE_D3_COLD].resources);
1004 /* Set the defaults for D0 and D3hot (always supported). */
1005 device->power.states[ACPI_STATE_D0].flags.valid = 1;
1006 device->power.states[ACPI_STATE_D0].power = 100;
1007 device->power.states[ACPI_STATE_D3_HOT].flags.valid = 1;
1010 * Use power resources only if the D0 list of them is populated, because
1011 * some platforms may provide _PR3 only to indicate D3cold support and
1012 * in those cases the power resources list returned by it may be bogus.
1014 if (!list_empty(&device->power.states[ACPI_STATE_D0].resources)) {
1015 device->power.flags.power_resources = 1;
1017 * D3cold is supported if the D3hot list of power resources is
1020 if (!list_empty(&device->power.states[ACPI_STATE_D3_HOT].resources))
1021 device->power.states[ACPI_STATE_D3_COLD].flags.valid = 1;
1024 if (acpi_bus_init_power(device))
1025 device->flags.power_manageable = 0;
1028 static void acpi_bus_get_flags(struct acpi_device *device)
1030 /* Presence of _STA indicates 'dynamic_status' */
1031 if (acpi_has_method(device->handle, "_STA"))
1032 device->flags.dynamic_status = 1;
1034 /* Presence of _RMV indicates 'removable' */
1035 if (acpi_has_method(device->handle, "_RMV"))
1036 device->flags.removable = 1;
1038 /* Presence of _EJD|_EJ0 indicates 'ejectable' */
1039 if (acpi_has_method(device->handle, "_EJD") ||
1040 acpi_has_method(device->handle, "_EJ0"))
1041 device->flags.ejectable = 1;
1044 static void acpi_device_get_busid(struct acpi_device *device)
1046 char bus_id[5] = { '?', 0 };
1047 struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
1053 * The device's Bus ID is simply the object name.
1054 * TBD: Shouldn't this value be unique (within the ACPI namespace)?
1056 if (ACPI_IS_ROOT_DEVICE(device)) {
1057 strcpy(device->pnp.bus_id, "ACPI");
1061 switch (device->device_type) {
1062 case ACPI_BUS_TYPE_POWER_BUTTON:
1063 strcpy(device->pnp.bus_id, "PWRF");
1065 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1066 strcpy(device->pnp.bus_id, "SLPF");
1068 case ACPI_BUS_TYPE_ECDT_EC:
1069 strcpy(device->pnp.bus_id, "ECDT");
1072 acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
1073 /* Clean up trailing underscores (if any) */
1074 for (i = 3; i > 1; i--) {
1075 if (bus_id[i] == '_')
1080 strcpy(device->pnp.bus_id, bus_id);
1086 * acpi_ata_match - see if an acpi object is an ATA device
1088 * If an acpi object has one of the ACPI ATA methods defined,
1089 * then we can safely call it an ATA device.
1091 bool acpi_ata_match(acpi_handle handle)
1093 return acpi_has_method(handle, "_GTF") ||
1094 acpi_has_method(handle, "_GTM") ||
1095 acpi_has_method(handle, "_STM") ||
1096 acpi_has_method(handle, "_SDD");
1100 * acpi_bay_match - see if an acpi object is an ejectable driver bay
1102 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
1103 * then we can safely call it an ejectable drive bay
1105 bool acpi_bay_match(acpi_handle handle)
1107 acpi_handle phandle;
1109 if (!acpi_has_method(handle, "_EJ0"))
1111 if (acpi_ata_match(handle))
1113 if (ACPI_FAILURE(acpi_get_parent(handle, &phandle)))
1116 return acpi_ata_match(phandle);
1119 bool acpi_device_is_battery(struct acpi_device *adev)
1121 struct acpi_hardware_id *hwid;
1123 list_for_each_entry(hwid, &adev->pnp.ids, list)
1124 if (!strcmp("PNP0C0A", hwid->id))
1130 static bool is_ejectable_bay(struct acpi_device *adev)
1132 acpi_handle handle = adev->handle;
1134 if (acpi_has_method(handle, "_EJ0") && acpi_device_is_battery(adev))
1137 return acpi_bay_match(handle);
1141 * acpi_dock_match - see if an acpi object has a _DCK method
1143 bool acpi_dock_match(acpi_handle handle)
1145 return acpi_has_method(handle, "_DCK");
1149 acpi_backlight_cap_match(acpi_handle handle, u32 level, void *context,
1150 void **return_value)
1152 long *cap = context;
1154 if (acpi_has_method(handle, "_BCM") &&
1155 acpi_has_method(handle, "_BCL")) {
1156 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found generic backlight "
1158 *cap |= ACPI_VIDEO_BACKLIGHT;
1159 /* We have backlight support, no need to scan further */
1160 return AE_CTRL_TERMINATE;
1165 /* Returns true if the ACPI object is a video device which can be
1166 * handled by video.ko.
1167 * The device will get a Linux specific CID added in scan.c to
1168 * identify the device as an ACPI graphics device
1169 * Be aware that the graphics device may not be physically present
1170 * Use acpi_video_get_capabilities() to detect general ACPI video
1171 * capabilities of present cards
1173 long acpi_is_video_device(acpi_handle handle)
1175 long video_caps = 0;
1177 /* Is this device able to support video switching ? */
1178 if (acpi_has_method(handle, "_DOD") || acpi_has_method(handle, "_DOS"))
1179 video_caps |= ACPI_VIDEO_OUTPUT_SWITCHING;
1181 /* Is this device able to retrieve a video ROM ? */
1182 if (acpi_has_method(handle, "_ROM"))
1183 video_caps |= ACPI_VIDEO_ROM_AVAILABLE;
1185 /* Is this device able to configure which video head to be POSTed ? */
1186 if (acpi_has_method(handle, "_VPO") &&
1187 acpi_has_method(handle, "_GPD") &&
1188 acpi_has_method(handle, "_SPD"))
1189 video_caps |= ACPI_VIDEO_DEVICE_POSTING;
1191 /* Only check for backlight functionality if one of the above hit. */
1193 acpi_walk_namespace(ACPI_TYPE_DEVICE, handle,
1194 ACPI_UINT32_MAX, acpi_backlight_cap_match, NULL,
1199 EXPORT_SYMBOL(acpi_is_video_device);
1201 const char *acpi_device_hid(struct acpi_device *device)
1203 struct acpi_hardware_id *hid;
1205 if (list_empty(&device->pnp.ids))
1208 hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
1211 EXPORT_SYMBOL(acpi_device_hid);
1213 static void acpi_add_id(struct acpi_device_pnp *pnp, const char *dev_id)
1215 struct acpi_hardware_id *id;
1217 id = kmalloc(sizeof(*id), GFP_KERNEL);
1221 id->id = kstrdup_const(dev_id, GFP_KERNEL);
1227 list_add_tail(&id->list, &pnp->ids);
1228 pnp->type.hardware_id = 1;
1232 * Old IBM workstations have a DSDT bug wherein the SMBus object
1233 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
1234 * prefix. Work around this.
1236 static bool acpi_ibm_smbus_match(acpi_handle handle)
1238 char node_name[ACPI_PATH_SEGMENT_LENGTH];
1239 struct acpi_buffer path = { sizeof(node_name), node_name };
1241 if (!dmi_name_in_vendors("IBM"))
1244 /* Look for SMBS object */
1245 if (ACPI_FAILURE(acpi_get_name(handle, ACPI_SINGLE_NAME, &path)) ||
1246 strcmp("SMBS", path.pointer))
1249 /* Does it have the necessary (but misnamed) methods? */
1250 if (acpi_has_method(handle, "SBI") &&
1251 acpi_has_method(handle, "SBR") &&
1252 acpi_has_method(handle, "SBW"))
1258 static bool acpi_object_is_system_bus(acpi_handle handle)
1262 if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_SB", &tmp)) &&
1265 if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_TZ", &tmp)) &&
1272 static void acpi_set_pnp_ids(acpi_handle handle, struct acpi_device_pnp *pnp,
1276 struct acpi_device_info *info;
1277 struct acpi_pnp_device_id_list *cid_list;
1280 switch (device_type) {
1281 case ACPI_BUS_TYPE_DEVICE:
1282 if (handle == ACPI_ROOT_OBJECT) {
1283 acpi_add_id(pnp, ACPI_SYSTEM_HID);
1287 status = acpi_get_object_info(handle, &info);
1288 if (ACPI_FAILURE(status)) {
1289 pr_err(PREFIX "%s: Error reading device info\n",
1294 if (info->valid & ACPI_VALID_HID) {
1295 acpi_add_id(pnp, info->hardware_id.string);
1296 pnp->type.platform_id = 1;
1298 if (info->valid & ACPI_VALID_CID) {
1299 cid_list = &info->compatible_id_list;
1300 for (i = 0; i < cid_list->count; i++)
1301 acpi_add_id(pnp, cid_list->ids[i].string);
1303 if (info->valid & ACPI_VALID_ADR) {
1304 pnp->bus_address = info->address;
1305 pnp->type.bus_address = 1;
1307 if (info->valid & ACPI_VALID_UID)
1308 pnp->unique_id = kstrdup(info->unique_id.string,
1310 if (info->valid & ACPI_VALID_CLS)
1311 acpi_add_id(pnp, info->class_code.string);
1316 * Some devices don't reliably have _HIDs & _CIDs, so add
1317 * synthetic HIDs to make sure drivers can find them.
1319 if (acpi_is_video_device(handle))
1320 acpi_add_id(pnp, ACPI_VIDEO_HID);
1321 else if (acpi_bay_match(handle))
1322 acpi_add_id(pnp, ACPI_BAY_HID);
1323 else if (acpi_dock_match(handle))
1324 acpi_add_id(pnp, ACPI_DOCK_HID);
1325 else if (acpi_ibm_smbus_match(handle))
1326 acpi_add_id(pnp, ACPI_SMBUS_IBM_HID);
1327 else if (list_empty(&pnp->ids) &&
1328 acpi_object_is_system_bus(handle)) {
1329 /* \_SB, \_TZ, LNXSYBUS */
1330 acpi_add_id(pnp, ACPI_BUS_HID);
1331 strcpy(pnp->device_name, ACPI_BUS_DEVICE_NAME);
1332 strcpy(pnp->device_class, ACPI_BUS_CLASS);
1336 case ACPI_BUS_TYPE_POWER:
1337 acpi_add_id(pnp, ACPI_POWER_HID);
1339 case ACPI_BUS_TYPE_PROCESSOR:
1340 acpi_add_id(pnp, ACPI_PROCESSOR_OBJECT_HID);
1342 case ACPI_BUS_TYPE_THERMAL:
1343 acpi_add_id(pnp, ACPI_THERMAL_HID);
1345 case ACPI_BUS_TYPE_POWER_BUTTON:
1346 acpi_add_id(pnp, ACPI_BUTTON_HID_POWERF);
1348 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1349 acpi_add_id(pnp, ACPI_BUTTON_HID_SLEEPF);
1351 case ACPI_BUS_TYPE_ECDT_EC:
1352 acpi_add_id(pnp, ACPI_ECDT_HID);
1357 void acpi_free_pnp_ids(struct acpi_device_pnp *pnp)
1359 struct acpi_hardware_id *id, *tmp;
1361 list_for_each_entry_safe(id, tmp, &pnp->ids, list) {
1362 kfree_const(id->id);
1365 kfree(pnp->unique_id);
1369 * acpi_dma_supported - Check DMA support for the specified device.
1370 * @adev: The pointer to acpi device
1372 * Return false if DMA is not supported. Otherwise, return true
1374 bool acpi_dma_supported(struct acpi_device *adev)
1379 if (adev->flags.cca_seen)
1383 * Per ACPI 6.0 sec 6.2.17, assume devices can do cache-coherent
1384 * DMA on "Intel platforms". Presumably that includes all x86 and
1385 * ia64, and other arches will set CONFIG_ACPI_CCA_REQUIRED=y.
1387 if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
1394 * acpi_get_dma_attr - Check the supported DMA attr for the specified device.
1395 * @adev: The pointer to acpi device
1397 * Return enum dev_dma_attr.
1399 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
1401 if (!acpi_dma_supported(adev))
1402 return DEV_DMA_NOT_SUPPORTED;
1404 if (adev->flags.coherent_dma)
1405 return DEV_DMA_COHERENT;
1407 return DEV_DMA_NON_COHERENT;
1411 * acpi_dma_get_range() - Get device DMA parameters.
1413 * @dev: device to configure
1414 * @dma_addr: pointer device DMA address result
1415 * @offset: pointer to the DMA offset result
1416 * @size: pointer to DMA range size result
1418 * Evaluate DMA regions and return respectively DMA region start, offset
1419 * and size in dma_addr, offset and size on parsing success; it does not
1420 * update the passed in values on failure.
1422 * Return 0 on success, < 0 on failure.
1424 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
1427 struct acpi_device *adev;
1429 struct resource_entry *rentry;
1431 struct device *dma_dev = dev;
1432 u64 len, dma_start = U64_MAX, dma_end = 0, dma_offset = 0;
1435 * Walk the device tree chasing an ACPI companion with a _DMA
1436 * object while we go. Stop if we find a device with an ACPI
1437 * companion containing a _DMA method.
1440 adev = ACPI_COMPANION(dma_dev);
1441 if (adev && acpi_has_method(adev->handle, METHOD_NAME__DMA))
1444 dma_dev = dma_dev->parent;
1450 if (!acpi_has_method(adev->handle, METHOD_NAME__CRS)) {
1451 acpi_handle_warn(adev->handle, "_DMA is valid only if _CRS is present\n");
1455 ret = acpi_dev_get_dma_resources(adev, &list);
1457 list_for_each_entry(rentry, &list, node) {
1458 if (dma_offset && rentry->offset != dma_offset) {
1460 dev_warn(dma_dev, "Can't handle multiple windows with different offsets\n");
1463 dma_offset = rentry->offset;
1465 /* Take lower and upper limits */
1466 if (rentry->res->start < dma_start)
1467 dma_start = rentry->res->start;
1468 if (rentry->res->end > dma_end)
1469 dma_end = rentry->res->end;
1472 if (dma_start >= dma_end) {
1474 dev_dbg(dma_dev, "Invalid DMA regions configuration\n");
1478 *dma_addr = dma_start - dma_offset;
1479 len = dma_end - dma_start;
1480 *size = max(len, len + 1);
1481 *offset = dma_offset;
1484 acpi_dev_free_resource_list(&list);
1486 return ret >= 0 ? 0 : ret;
1490 * acpi_dma_configure_id - Set-up DMA configuration for the device.
1491 * @dev: The pointer to the device
1492 * @attr: device dma attributes
1493 * @input_id: input device id const value pointer
1495 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
1496 const u32 *input_id)
1498 const struct iommu_ops *iommu;
1499 u64 dma_addr = 0, size = 0;
1501 if (attr == DEV_DMA_NOT_SUPPORTED) {
1502 set_dma_ops(dev, &dma_dummy_ops);
1506 iort_dma_setup(dev, &dma_addr, &size);
1508 iommu = iort_iommu_configure_id(dev, input_id);
1509 if (PTR_ERR(iommu) == -EPROBE_DEFER)
1510 return -EPROBE_DEFER;
1512 arch_setup_dma_ops(dev, dma_addr, size,
1513 iommu, attr == DEV_DMA_COHERENT);
1517 EXPORT_SYMBOL_GPL(acpi_dma_configure_id);
1519 static void acpi_init_coherency(struct acpi_device *adev)
1521 unsigned long long cca = 0;
1523 struct acpi_device *parent = adev->parent;
1525 if (parent && parent->flags.cca_seen) {
1527 * From ACPI spec, OSPM will ignore _CCA if an ancestor
1530 adev->flags.cca_seen = 1;
1531 cca = parent->flags.coherent_dma;
1533 status = acpi_evaluate_integer(adev->handle, "_CCA",
1535 if (ACPI_SUCCESS(status))
1536 adev->flags.cca_seen = 1;
1537 else if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
1539 * If architecture does not specify that _CCA is
1540 * required for DMA-able devices (e.g. x86),
1541 * we default to _CCA=1.
1545 acpi_handle_debug(adev->handle,
1546 "ACPI device is missing _CCA.\n");
1549 adev->flags.coherent_dma = cca;
1552 static int acpi_check_serial_bus_slave(struct acpi_resource *ares, void *data)
1554 bool *is_serial_bus_slave_p = data;
1556 if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
1559 *is_serial_bus_slave_p = true;
1561 /* no need to do more checking */
1565 static bool acpi_is_indirect_io_slave(struct acpi_device *device)
1567 struct acpi_device *parent = device->parent;
1568 static const struct acpi_device_id indirect_io_hosts[] = {
1573 return parent && !acpi_match_device_ids(parent, indirect_io_hosts);
1576 static bool acpi_device_enumeration_by_parent(struct acpi_device *device)
1578 struct list_head resource_list;
1579 bool is_serial_bus_slave = false;
1580 static const struct acpi_device_id ignore_serial_bus_ids[] = {
1582 * These devices have multiple I2cSerialBus resources and an i2c-client
1583 * must be instantiated for each, each with its own i2c_device_id.
1584 * Normally we only instantiate an i2c-client for the first resource,
1585 * using the ACPI HID as id. These special cases are handled by the
1586 * drivers/platform/x86/i2c-multi-instantiate.c driver, which knows
1587 * which i2c_device_id to use for each resource.
1594 * HIDs of device with an UartSerialBusV2 resource for which userspace
1595 * expects a regular tty cdev to be created (instead of the in kernel
1596 * serdev) and which have a kernel driver which expects a platform_dev
1597 * such as the rfkill-gpio driver.
1604 if (acpi_is_indirect_io_slave(device))
1607 /* Macs use device properties in lieu of _CRS resources */
1608 if (x86_apple_machine &&
1609 (fwnode_property_present(&device->fwnode, "spiSclkPeriod") ||
1610 fwnode_property_present(&device->fwnode, "i2cAddress") ||
1611 fwnode_property_present(&device->fwnode, "baud")))
1614 if (!acpi_match_device_ids(device, ignore_serial_bus_ids))
1617 INIT_LIST_HEAD(&resource_list);
1618 acpi_dev_get_resources(device, &resource_list,
1619 acpi_check_serial_bus_slave,
1620 &is_serial_bus_slave);
1621 acpi_dev_free_resource_list(&resource_list);
1623 return is_serial_bus_slave;
1626 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
1627 int type, unsigned long long sta)
1629 INIT_LIST_HEAD(&device->pnp.ids);
1630 device->device_type = type;
1631 device->handle = handle;
1632 device->parent = acpi_bus_get_parent(handle);
1633 device->fwnode.ops = &acpi_device_fwnode_ops;
1634 acpi_set_device_status(device, sta);
1635 acpi_device_get_busid(device);
1636 acpi_set_pnp_ids(handle, &device->pnp, type);
1637 acpi_init_properties(device);
1638 acpi_bus_get_flags(device);
1639 device->flags.match_driver = false;
1640 device->flags.initialized = true;
1641 device->flags.enumeration_by_parent =
1642 acpi_device_enumeration_by_parent(device);
1643 acpi_device_clear_enumerated(device);
1644 device_initialize(&device->dev);
1645 dev_set_uevent_suppress(&device->dev, true);
1646 acpi_init_coherency(device);
1647 /* Assume there are unmet deps until acpi_device_dep_initialize() runs */
1648 device->dep_unmet = 1;
1651 void acpi_device_add_finalize(struct acpi_device *device)
1653 dev_set_uevent_suppress(&device->dev, false);
1654 kobject_uevent(&device->dev.kobj, KOBJ_ADD);
1657 static int acpi_add_single_object(struct acpi_device **child,
1658 acpi_handle handle, int type,
1659 unsigned long long sta)
1662 struct acpi_device *device;
1663 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1665 device = kzalloc(sizeof(struct acpi_device), GFP_KERNEL);
1667 printk(KERN_ERR PREFIX "Memory allocation error\n");
1671 acpi_init_device_object(device, handle, type, sta);
1673 * For ACPI_BUS_TYPE_DEVICE getting the status is delayed till here so
1674 * that we can call acpi_bus_get_status() and use its quirk handling.
1675 * Note this must be done before the get power-/wakeup_dev-flags calls.
1677 if (type == ACPI_BUS_TYPE_DEVICE)
1678 if (acpi_bus_get_status(device) < 0)
1679 acpi_set_device_status(device, 0);
1681 acpi_bus_get_power_flags(device);
1682 acpi_bus_get_wakeup_device_flags(device);
1684 result = acpi_device_add(device, acpi_device_release);
1686 acpi_device_release(&device->dev);
1690 acpi_power_add_remove_device(device, true);
1691 acpi_device_add_finalize(device);
1692 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1693 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Added %s [%s] parent %s\n",
1694 dev_name(&device->dev), (char *) buffer.pointer,
1695 device->parent ? dev_name(&device->parent->dev) : "(null)"));
1696 kfree(buffer.pointer);
1701 static acpi_status acpi_get_resource_memory(struct acpi_resource *ares,
1704 struct resource *res = context;
1706 if (acpi_dev_resource_memory(ares, res))
1707 return AE_CTRL_TERMINATE;
1712 static bool acpi_device_should_be_hidden(acpi_handle handle)
1715 struct resource res;
1717 /* Check if it should ignore the UART device */
1718 if (!(spcr_uart_addr && acpi_has_method(handle, METHOD_NAME__CRS)))
1722 * The UART device described in SPCR table is assumed to have only one
1723 * memory resource present. So we only look for the first one here.
1725 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1726 acpi_get_resource_memory, &res);
1727 if (ACPI_FAILURE(status) || res.start != spcr_uart_addr)
1730 acpi_handle_info(handle, "The UART device @%pa in SPCR table will be hidden\n",
1736 static int acpi_bus_type_and_status(acpi_handle handle, int *type,
1737 unsigned long long *sta)
1740 acpi_object_type acpi_type;
1742 status = acpi_get_type(handle, &acpi_type);
1743 if (ACPI_FAILURE(status))
1746 switch (acpi_type) {
1747 case ACPI_TYPE_ANY: /* for ACPI_ROOT_OBJECT */
1748 case ACPI_TYPE_DEVICE:
1749 if (acpi_device_should_be_hidden(handle))
1752 *type = ACPI_BUS_TYPE_DEVICE;
1754 * acpi_add_single_object updates this once we've an acpi_device
1755 * so that acpi_bus_get_status' quirk handling can be used.
1757 *sta = ACPI_STA_DEFAULT;
1759 case ACPI_TYPE_PROCESSOR:
1760 *type = ACPI_BUS_TYPE_PROCESSOR;
1761 status = acpi_bus_get_status_handle(handle, sta);
1762 if (ACPI_FAILURE(status))
1765 case ACPI_TYPE_THERMAL:
1766 *type = ACPI_BUS_TYPE_THERMAL;
1767 *sta = ACPI_STA_DEFAULT;
1769 case ACPI_TYPE_POWER:
1770 *type = ACPI_BUS_TYPE_POWER;
1771 *sta = ACPI_STA_DEFAULT;
1780 bool acpi_device_is_present(const struct acpi_device *adev)
1782 return adev->status.present || adev->status.functional;
1785 static bool acpi_scan_handler_matching(struct acpi_scan_handler *handler,
1787 const struct acpi_device_id **matchid)
1789 const struct acpi_device_id *devid;
1792 return handler->match(idstr, matchid);
1794 for (devid = handler->ids; devid->id[0]; devid++)
1795 if (!strcmp((char *)devid->id, idstr)) {
1805 static struct acpi_scan_handler *acpi_scan_match_handler(const char *idstr,
1806 const struct acpi_device_id **matchid)
1808 struct acpi_scan_handler *handler;
1810 list_for_each_entry(handler, &acpi_scan_handlers_list, list_node)
1811 if (acpi_scan_handler_matching(handler, idstr, matchid))
1817 void acpi_scan_hotplug_enabled(struct acpi_hotplug_profile *hotplug, bool val)
1819 if (!!hotplug->enabled == !!val)
1822 mutex_lock(&acpi_scan_lock);
1824 hotplug->enabled = val;
1826 mutex_unlock(&acpi_scan_lock);
1829 static void acpi_scan_init_hotplug(struct acpi_device *adev)
1831 struct acpi_hardware_id *hwid;
1833 if (acpi_dock_match(adev->handle) || is_ejectable_bay(adev)) {
1834 acpi_dock_add(adev);
1837 list_for_each_entry(hwid, &adev->pnp.ids, list) {
1838 struct acpi_scan_handler *handler;
1840 handler = acpi_scan_match_handler(hwid->id, NULL);
1842 adev->flags.hotplug_notify = true;
1848 static void acpi_device_dep_initialize(struct acpi_device *adev)
1850 struct acpi_dep_data *dep;
1851 struct acpi_handle_list dep_devices;
1855 adev->dep_unmet = 0;
1857 if (!acpi_has_method(adev->handle, "_DEP"))
1860 status = acpi_evaluate_reference(adev->handle, "_DEP", NULL,
1862 if (ACPI_FAILURE(status)) {
1863 dev_dbg(&adev->dev, "Failed to evaluate _DEP.\n");
1867 for (i = 0; i < dep_devices.count; i++) {
1868 struct acpi_device_info *info;
1871 status = acpi_get_object_info(dep_devices.handles[i], &info);
1872 if (ACPI_FAILURE(status)) {
1873 dev_dbg(&adev->dev, "Error reading _DEP device info\n");
1878 * Skip the dependency of Windows System Power
1879 * Management Controller
1881 skip = info->valid & ACPI_VALID_HID &&
1882 !strcmp(info->hardware_id.string, "INT3396");
1889 dep = kzalloc(sizeof(struct acpi_dep_data), GFP_KERNEL);
1893 dep->master = dep_devices.handles[i];
1894 dep->slave = adev->handle;
1897 mutex_lock(&acpi_dep_list_lock);
1898 list_add_tail(&dep->node , &acpi_dep_list);
1899 mutex_unlock(&acpi_dep_list_lock);
1903 static acpi_status acpi_bus_check_add(acpi_handle handle, u32 lvl_not_used,
1904 void *not_used, void **return_value)
1906 struct acpi_device *device = NULL;
1908 unsigned long long sta;
1911 acpi_bus_get_device(handle, &device);
1915 result = acpi_bus_type_and_status(handle, &type, &sta);
1919 if (type == ACPI_BUS_TYPE_POWER) {
1920 acpi_add_power_resource(handle);
1924 acpi_add_single_object(&device, handle, type, sta);
1926 return AE_CTRL_DEPTH;
1928 acpi_scan_init_hotplug(device);
1929 acpi_device_dep_initialize(device);
1933 *return_value = device;
1938 static void acpi_default_enumeration(struct acpi_device *device)
1941 * Do not enumerate devices with enumeration_by_parent flag set as
1942 * they will be enumerated by their respective parents.
1944 if (!device->flags.enumeration_by_parent) {
1945 acpi_create_platform_device(device, NULL);
1946 acpi_device_set_enumerated(device);
1948 blocking_notifier_call_chain(&acpi_reconfig_chain,
1949 ACPI_RECONFIG_DEVICE_ADD, device);
1953 static const struct acpi_device_id generic_device_ids[] = {
1954 {ACPI_DT_NAMESPACE_HID, },
1958 static int acpi_generic_device_attach(struct acpi_device *adev,
1959 const struct acpi_device_id *not_used)
1962 * Since ACPI_DT_NAMESPACE_HID is the only ID handled here, the test
1963 * below can be unconditional.
1965 if (adev->data.of_compatible)
1966 acpi_default_enumeration(adev);
1971 static struct acpi_scan_handler generic_device_handler = {
1972 .ids = generic_device_ids,
1973 .attach = acpi_generic_device_attach,
1976 static int acpi_scan_attach_handler(struct acpi_device *device)
1978 struct acpi_hardware_id *hwid;
1981 list_for_each_entry(hwid, &device->pnp.ids, list) {
1982 const struct acpi_device_id *devid;
1983 struct acpi_scan_handler *handler;
1985 handler = acpi_scan_match_handler(hwid->id, &devid);
1987 if (!handler->attach) {
1988 device->pnp.type.platform_id = 0;
1991 device->handler = handler;
1992 ret = handler->attach(device, devid);
1996 device->handler = NULL;
2005 static void acpi_bus_attach(struct acpi_device *device)
2007 struct acpi_device *child;
2011 if (ACPI_SUCCESS(acpi_bus_get_ejd(device->handle, &ejd)))
2012 register_dock_dependent_device(device, ejd);
2014 acpi_bus_get_status(device);
2015 /* Skip devices that are not present. */
2016 if (!acpi_device_is_present(device)) {
2017 device->flags.initialized = false;
2018 acpi_device_clear_enumerated(device);
2019 device->flags.power_manageable = 0;
2022 if (device->handler)
2025 if (!device->flags.initialized) {
2026 device->flags.power_manageable =
2027 device->power.states[ACPI_STATE_D0].flags.valid;
2028 if (acpi_bus_init_power(device))
2029 device->flags.power_manageable = 0;
2031 device->flags.initialized = true;
2032 } else if (device->flags.visited) {
2036 ret = acpi_scan_attach_handler(device);
2040 device->flags.match_driver = true;
2041 if (ret > 0 && !device->flags.enumeration_by_parent) {
2042 acpi_device_set_enumerated(device);
2046 ret = device_attach(&device->dev);
2050 if (device->pnp.type.platform_id || device->flags.enumeration_by_parent)
2051 acpi_default_enumeration(device);
2053 acpi_device_set_enumerated(device);
2056 list_for_each_entry(child, &device->children, node)
2057 acpi_bus_attach(child);
2059 if (device->handler && device->handler->hotplug.notify_online)
2060 device->handler->hotplug.notify_online(device);
2063 void acpi_walk_dep_device_list(acpi_handle handle)
2065 struct acpi_dep_data *dep, *tmp;
2066 struct acpi_device *adev;
2068 mutex_lock(&acpi_dep_list_lock);
2069 list_for_each_entry_safe(dep, tmp, &acpi_dep_list, node) {
2070 if (dep->master == handle) {
2071 acpi_bus_get_device(dep->slave, &adev);
2076 if (!adev->dep_unmet)
2077 acpi_bus_attach(adev);
2078 list_del(&dep->node);
2082 mutex_unlock(&acpi_dep_list_lock);
2084 EXPORT_SYMBOL_GPL(acpi_walk_dep_device_list);
2087 * acpi_bus_scan - Add ACPI device node objects in a given namespace scope.
2088 * @handle: Root of the namespace scope to scan.
2090 * Scan a given ACPI tree (probably recently hot-plugged) and create and add
2093 * If no devices were found, -ENODEV is returned, but it does not mean that
2094 * there has been a real error. There just have been no suitable ACPI objects
2095 * in the table trunk from which the kernel could create a device and add an
2096 * appropriate driver.
2098 * Must be called under acpi_scan_lock.
2100 int acpi_bus_scan(acpi_handle handle)
2102 void *device = NULL;
2104 if (ACPI_SUCCESS(acpi_bus_check_add(handle, 0, NULL, &device)))
2105 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
2106 acpi_bus_check_add, NULL, NULL, &device);
2109 acpi_bus_attach(device);
2114 EXPORT_SYMBOL(acpi_bus_scan);
2117 * acpi_bus_trim - Detach scan handlers and drivers from ACPI device objects.
2118 * @adev: Root of the ACPI namespace scope to walk.
2120 * Must be called under acpi_scan_lock.
2122 void acpi_bus_trim(struct acpi_device *adev)
2124 struct acpi_scan_handler *handler = adev->handler;
2125 struct acpi_device *child;
2127 list_for_each_entry_reverse(child, &adev->children, node)
2128 acpi_bus_trim(child);
2130 adev->flags.match_driver = false;
2132 if (handler->detach)
2133 handler->detach(adev);
2135 adev->handler = NULL;
2137 device_release_driver(&adev->dev);
2140 * Most likely, the device is going away, so put it into D3cold before
2143 acpi_device_set_power(adev, ACPI_STATE_D3_COLD);
2144 adev->flags.initialized = false;
2145 acpi_device_clear_enumerated(adev);
2147 EXPORT_SYMBOL_GPL(acpi_bus_trim);
2149 int acpi_bus_register_early_device(int type)
2151 struct acpi_device *device = NULL;
2154 result = acpi_add_single_object(&device, NULL,
2155 type, ACPI_STA_DEFAULT);
2159 device->flags.match_driver = true;
2160 return device_attach(&device->dev);
2162 EXPORT_SYMBOL_GPL(acpi_bus_register_early_device);
2164 static int acpi_bus_scan_fixed(void)
2169 * Enumerate all fixed-feature devices.
2171 if (!(acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON)) {
2172 struct acpi_device *device = NULL;
2174 result = acpi_add_single_object(&device, NULL,
2175 ACPI_BUS_TYPE_POWER_BUTTON,
2180 device->flags.match_driver = true;
2181 result = device_attach(&device->dev);
2185 device_init_wakeup(&device->dev, true);
2188 if (!(acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON)) {
2189 struct acpi_device *device = NULL;
2191 result = acpi_add_single_object(&device, NULL,
2192 ACPI_BUS_TYPE_SLEEP_BUTTON,
2197 device->flags.match_driver = true;
2198 result = device_attach(&device->dev);
2201 return result < 0 ? result : 0;
2204 static void __init acpi_get_spcr_uart_addr(void)
2207 struct acpi_table_spcr *spcr_ptr;
2209 status = acpi_get_table(ACPI_SIG_SPCR, 0,
2210 (struct acpi_table_header **)&spcr_ptr);
2211 if (ACPI_FAILURE(status)) {
2212 pr_warn(PREFIX "STAO table present, but SPCR is missing\n");
2216 spcr_uart_addr = spcr_ptr->serial_port.address;
2217 acpi_put_table((struct acpi_table_header *)spcr_ptr);
2220 static bool acpi_scan_initialized;
2222 int __init acpi_scan_init(void)
2226 struct acpi_table_stao *stao_ptr;
2228 acpi_pci_root_init();
2229 acpi_pci_link_init();
2230 acpi_processor_init();
2231 acpi_platform_init();
2234 acpi_cmos_rtc_init();
2235 acpi_container_init();
2236 acpi_memory_hotplug_init();
2237 acpi_watchdog_init();
2239 acpi_int340x_thermal_init();
2243 acpi_scan_add_handler(&generic_device_handler);
2246 * If there is STAO table, check whether it needs to ignore the UART
2247 * device in SPCR table.
2249 status = acpi_get_table(ACPI_SIG_STAO, 0,
2250 (struct acpi_table_header **)&stao_ptr);
2251 if (ACPI_SUCCESS(status)) {
2252 if (stao_ptr->header.length > sizeof(struct acpi_table_stao))
2253 pr_info(PREFIX "STAO Name List not yet supported.\n");
2255 if (stao_ptr->ignore_uart)
2256 acpi_get_spcr_uart_addr();
2258 acpi_put_table((struct acpi_table_header *)stao_ptr);
2261 acpi_gpe_apply_masked_gpes();
2262 acpi_update_all_gpes();
2265 * Although we call __add_memory() that is documented to require the
2266 * device_hotplug_lock, it is not necessary here because this is an
2267 * early code when userspace or any other code path cannot trigger
2268 * hotplug/hotunplug operations.
2270 mutex_lock(&acpi_scan_lock);
2272 * Enumerate devices in the ACPI namespace.
2274 result = acpi_bus_scan(ACPI_ROOT_OBJECT);
2278 result = acpi_bus_get_device(ACPI_ROOT_OBJECT, &acpi_root);
2282 /* Fixed feature devices do not exist on HW-reduced platform */
2283 if (!acpi_gbl_reduced_hardware) {
2284 result = acpi_bus_scan_fixed();
2286 acpi_detach_data(acpi_root->handle,
2287 acpi_scan_drop_device);
2288 acpi_device_del(acpi_root);
2289 put_device(&acpi_root->dev);
2294 acpi_scan_initialized = true;
2297 mutex_unlock(&acpi_scan_lock);
2301 static struct acpi_probe_entry *ape;
2302 static int acpi_probe_count;
2303 static DEFINE_MUTEX(acpi_probe_mutex);
2305 static int __init acpi_match_madt(union acpi_subtable_headers *header,
2306 const unsigned long end)
2308 if (!ape->subtable_valid || ape->subtable_valid(&header->common, ape))
2309 if (!ape->probe_subtbl(header, end))
2315 int __init __acpi_probe_device_table(struct acpi_probe_entry *ap_head, int nr)
2322 mutex_lock(&acpi_probe_mutex);
2323 for (ape = ap_head; nr; ape++, nr--) {
2324 if (ACPI_COMPARE_NAMESEG(ACPI_SIG_MADT, ape->id)) {
2325 acpi_probe_count = 0;
2326 acpi_table_parse_madt(ape->type, acpi_match_madt, 0);
2327 count += acpi_probe_count;
2330 res = acpi_table_parse(ape->id, ape->probe_table);
2335 mutex_unlock(&acpi_probe_mutex);
2340 struct acpi_table_events_work {
2341 struct work_struct work;
2346 static void acpi_table_events_fn(struct work_struct *work)
2348 struct acpi_table_events_work *tew;
2350 tew = container_of(work, struct acpi_table_events_work, work);
2352 if (tew->event == ACPI_TABLE_EVENT_LOAD) {
2353 acpi_scan_lock_acquire();
2354 acpi_bus_scan(ACPI_ROOT_OBJECT);
2355 acpi_scan_lock_release();
2361 void acpi_scan_table_handler(u32 event, void *table, void *context)
2363 struct acpi_table_events_work *tew;
2365 if (!acpi_scan_initialized)
2368 if (event != ACPI_TABLE_EVENT_LOAD)
2371 tew = kmalloc(sizeof(*tew), GFP_KERNEL);
2375 INIT_WORK(&tew->work, acpi_table_events_fn);
2379 schedule_work(&tew->work);
2382 int acpi_reconfig_notifier_register(struct notifier_block *nb)
2384 return blocking_notifier_chain_register(&acpi_reconfig_chain, nb);
2386 EXPORT_SYMBOL(acpi_reconfig_notifier_register);
2388 int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
2390 return blocking_notifier_chain_unregister(&acpi_reconfig_chain, nb);
2392 EXPORT_SYMBOL(acpi_reconfig_notifier_unregister);