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 if (acpi_device_bus_id->instance_no > 0)
486 acpi_device_bus_id->instance_no--;
488 list_del(&acpi_device_bus_id->node);
489 kfree_const(acpi_device_bus_id->bus_id);
490 kfree(acpi_device_bus_id);
495 list_del(&device->wakeup_list);
496 mutex_unlock(&acpi_device_lock);
498 acpi_power_add_remove_device(device, false);
499 acpi_device_remove_files(device);
501 device->remove(device);
503 device_del(&device->dev);
506 static BLOCKING_NOTIFIER_HEAD(acpi_reconfig_chain);
508 static LIST_HEAD(acpi_device_del_list);
509 static DEFINE_MUTEX(acpi_device_del_lock);
511 static void acpi_device_del_work_fn(struct work_struct *work_not_used)
514 struct acpi_device *adev;
516 mutex_lock(&acpi_device_del_lock);
518 if (list_empty(&acpi_device_del_list)) {
519 mutex_unlock(&acpi_device_del_lock);
522 adev = list_first_entry(&acpi_device_del_list,
523 struct acpi_device, del_list);
524 list_del(&adev->del_list);
526 mutex_unlock(&acpi_device_del_lock);
528 blocking_notifier_call_chain(&acpi_reconfig_chain,
529 ACPI_RECONFIG_DEVICE_REMOVE, adev);
531 acpi_device_del(adev);
533 * Drop references to all power resources that might have been
534 * used by the device.
536 acpi_power_transition(adev, ACPI_STATE_D3_COLD);
537 put_device(&adev->dev);
542 * acpi_scan_drop_device - Drop an ACPI device object.
543 * @handle: Handle of an ACPI namespace node, not used.
544 * @context: Address of the ACPI device object to drop.
546 * This is invoked by acpi_ns_delete_node() during the removal of the ACPI
547 * namespace node the device object pointed to by @context is attached to.
549 * The unregistration is carried out asynchronously to avoid running
550 * acpi_device_del() under the ACPICA's namespace mutex and the list is used to
551 * ensure the correct ordering (the device objects must be unregistered in the
552 * same order in which the corresponding namespace nodes are deleted).
554 static void acpi_scan_drop_device(acpi_handle handle, void *context)
556 static DECLARE_WORK(work, acpi_device_del_work_fn);
557 struct acpi_device *adev = context;
559 mutex_lock(&acpi_device_del_lock);
562 * Use the ACPI hotplug workqueue which is ordered, so this work item
563 * won't run after any hotplug work items submitted subsequently. That
564 * prevents attempts to register device objects identical to those being
565 * deleted from happening concurrently (such attempts result from
566 * hotplug events handled via the ACPI hotplug workqueue). It also will
567 * run after all of the work items submitted previosuly, which helps
568 * those work items to ensure that they are not accessing stale device
571 if (list_empty(&acpi_device_del_list))
572 acpi_queue_hotplug_work(&work);
574 list_add_tail(&adev->del_list, &acpi_device_del_list);
575 /* Make acpi_ns_validate_handle() return NULL for this handle. */
576 adev->handle = INVALID_ACPI_HANDLE;
578 mutex_unlock(&acpi_device_del_lock);
581 static int acpi_get_device_data(acpi_handle handle, struct acpi_device **device,
582 void (*callback)(void *))
591 status = acpi_get_data_full(handle, acpi_scan_drop_device,
592 (void **)device, callback);
593 if (ACPI_FAILURE(status) || !*device) {
594 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "No context for object [%p]\n",
601 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device)
603 return acpi_get_device_data(handle, device, NULL);
605 EXPORT_SYMBOL(acpi_bus_get_device);
607 static void get_acpi_device(void *dev)
610 get_device(&((struct acpi_device *)dev)->dev);
613 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle)
615 struct acpi_device *adev = NULL;
617 acpi_get_device_data(handle, &adev, get_acpi_device);
621 void acpi_bus_put_acpi_device(struct acpi_device *adev)
623 put_device(&adev->dev);
626 int acpi_device_add(struct acpi_device *device,
627 void (*release)(struct device *))
630 struct acpi_device_bus_id *acpi_device_bus_id, *new_bus_id;
633 if (device->handle) {
636 status = acpi_attach_data(device->handle, acpi_scan_drop_device,
638 if (ACPI_FAILURE(status)) {
639 acpi_handle_err(device->handle,
640 "Unable to attach device data\n");
648 * Link this device to its parent and siblings.
650 INIT_LIST_HEAD(&device->children);
651 INIT_LIST_HEAD(&device->node);
652 INIT_LIST_HEAD(&device->wakeup_list);
653 INIT_LIST_HEAD(&device->physical_node_list);
654 INIT_LIST_HEAD(&device->del_list);
655 mutex_init(&device->physical_node_lock);
657 new_bus_id = kzalloc(sizeof(struct acpi_device_bus_id), GFP_KERNEL);
659 pr_err(PREFIX "Memory allocation error\n");
664 mutex_lock(&acpi_device_lock);
666 * Find suitable bus_id and instance number in acpi_bus_id_list
667 * If failed, create one and link it into acpi_bus_id_list
669 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
670 if (!strcmp(acpi_device_bus_id->bus_id,
671 acpi_device_hid(device))) {
672 acpi_device_bus_id->instance_no++;
679 acpi_device_bus_id = new_bus_id;
680 acpi_device_bus_id->bus_id =
681 kstrdup_const(acpi_device_hid(device), GFP_KERNEL);
682 if (!acpi_device_bus_id->bus_id) {
683 pr_err(PREFIX "Memory allocation error for bus id\n");
685 goto err_free_new_bus_id;
688 acpi_device_bus_id->instance_no = 0;
689 list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
691 dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, acpi_device_bus_id->instance_no);
694 list_add_tail(&device->node, &device->parent->children);
696 if (device->wakeup.flags.valid)
697 list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);
698 mutex_unlock(&acpi_device_lock);
701 device->dev.parent = &device->parent->dev;
702 device->dev.bus = &acpi_bus_type;
703 device->dev.release = release;
704 result = device_add(&device->dev);
706 dev_err(&device->dev, "Error registering device\n");
710 result = acpi_device_setup_files(device);
712 printk(KERN_ERR PREFIX "Error creating sysfs interface for device %s\n",
713 dev_name(&device->dev));
718 mutex_lock(&acpi_device_lock);
720 list_del(&device->node);
721 list_del(&device->wakeup_list);
727 mutex_unlock(&acpi_device_lock);
730 acpi_detach_data(device->handle, acpi_scan_drop_device);
734 /* --------------------------------------------------------------------------
736 -------------------------------------------------------------------------- */
737 static bool acpi_info_matches_ids(struct acpi_device_info *info,
738 const char * const ids[])
740 struct acpi_pnp_device_id_list *cid_list = NULL;
743 if (!(info->valid & ACPI_VALID_HID))
746 if (info->valid & ACPI_VALID_CID)
747 cid_list = &info->compatible_id_list;
749 for (i = 0; ids[i]; i++) {
752 if (!strcmp(info->hardware_id.string, ids[i]))
758 for (j = 0; j < cid_list->count; j++) {
759 if (!strcmp(cid_list->ids[j].string, ids[i]))
767 /* List of HIDs for which we ignore matching ACPI devices, when checking _DEP lists. */
768 static const char * const acpi_ignore_dep_ids[] = {
769 "PNP0D80", /* Windows-compatible System Power Management Controller */
770 "INT33BD", /* Intel Baytrail Mailbox Device */
774 static struct acpi_device *acpi_bus_get_parent(acpi_handle handle)
776 struct acpi_device *device = NULL;
780 * Fixed hardware devices do not appear in the namespace and do not
781 * have handles, but we fabricate acpi_devices for them, so we have
782 * to deal with them specially.
788 status = acpi_get_parent(handle, &handle);
789 if (ACPI_FAILURE(status))
790 return status == AE_NULL_ENTRY ? NULL : acpi_root;
791 } while (acpi_bus_get_device(handle, &device));
796 acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
800 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
801 union acpi_object *obj;
803 status = acpi_get_handle(handle, "_EJD", &tmp);
804 if (ACPI_FAILURE(status))
807 status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
808 if (ACPI_SUCCESS(status)) {
809 obj = buffer.pointer;
810 status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
812 kfree(buffer.pointer);
816 EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);
818 static int acpi_bus_extract_wakeup_device_power_package(struct acpi_device *dev)
820 acpi_handle handle = dev->handle;
821 struct acpi_device_wakeup *wakeup = &dev->wakeup;
822 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
823 union acpi_object *package = NULL;
824 union acpi_object *element = NULL;
828 INIT_LIST_HEAD(&wakeup->resources);
831 status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
832 if (ACPI_FAILURE(status)) {
833 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRW"));
837 package = (union acpi_object *)buffer.pointer;
839 if (!package || package->package.count < 2)
842 element = &(package->package.elements[0]);
846 if (element->type == ACPI_TYPE_PACKAGE) {
847 if ((element->package.count < 2) ||
848 (element->package.elements[0].type !=
849 ACPI_TYPE_LOCAL_REFERENCE)
850 || (element->package.elements[1].type != ACPI_TYPE_INTEGER))
854 element->package.elements[0].reference.handle;
856 (u32) element->package.elements[1].integer.value;
857 } else if (element->type == ACPI_TYPE_INTEGER) {
858 wakeup->gpe_device = NULL;
859 wakeup->gpe_number = element->integer.value;
864 element = &(package->package.elements[1]);
865 if (element->type != ACPI_TYPE_INTEGER)
868 wakeup->sleep_state = element->integer.value;
870 err = acpi_extract_power_resources(package, 2, &wakeup->resources);
874 if (!list_empty(&wakeup->resources)) {
877 err = acpi_power_wakeup_list_init(&wakeup->resources,
880 acpi_handle_warn(handle, "Retrieving current states "
881 "of wakeup power resources failed\n");
882 acpi_power_resources_list_free(&wakeup->resources);
885 if (sleep_state < wakeup->sleep_state) {
886 acpi_handle_warn(handle, "Overriding _PRW sleep state "
887 "(S%d) by S%d from power resources\n",
888 (int)wakeup->sleep_state, sleep_state);
889 wakeup->sleep_state = sleep_state;
894 kfree(buffer.pointer);
898 static bool acpi_wakeup_gpe_init(struct acpi_device *device)
900 static const struct acpi_device_id button_device_ids[] = {
901 {"PNP0C0C", 0}, /* Power button */
902 {"PNP0C0D", 0}, /* Lid */
903 {"PNP0C0E", 0}, /* Sleep button */
906 struct acpi_device_wakeup *wakeup = &device->wakeup;
909 wakeup->flags.notifier_present = 0;
911 /* Power button, Lid switch always enable wakeup */
912 if (!acpi_match_device_ids(device, button_device_ids)) {
913 if (!acpi_match_device_ids(device, &button_device_ids[1])) {
914 /* Do not use Lid/sleep button for S5 wakeup */
915 if (wakeup->sleep_state == ACPI_STATE_S5)
916 wakeup->sleep_state = ACPI_STATE_S4;
918 acpi_mark_gpe_for_wake(wakeup->gpe_device, wakeup->gpe_number);
919 device_set_wakeup_capable(&device->dev, true);
923 status = acpi_setup_gpe_for_wake(device->handle, wakeup->gpe_device,
925 return ACPI_SUCCESS(status);
928 static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
932 /* Presence of _PRW indicates wake capable */
933 if (!acpi_has_method(device->handle, "_PRW"))
936 err = acpi_bus_extract_wakeup_device_power_package(device);
938 dev_err(&device->dev, "_PRW evaluation error: %d\n", err);
942 device->wakeup.flags.valid = acpi_wakeup_gpe_init(device);
943 device->wakeup.prepare_count = 0;
945 * Call _PSW/_DSW object to disable its ability to wake the sleeping
946 * system for the ACPI device with the _PRW object.
947 * The _PSW object is deprecated in ACPI 3.0 and is replaced by _DSW.
948 * So it is necessary to call _DSW object first. Only when it is not
949 * present will the _PSW object used.
951 err = acpi_device_sleep_wake(device, 0, 0, 0);
953 pr_debug("error in _DSW or _PSW evaluation\n");
956 static void acpi_bus_init_power_state(struct acpi_device *device, int state)
958 struct acpi_device_power_state *ps = &device->power.states[state];
959 char pathname[5] = { '_', 'P', 'R', '0' + state, '\0' };
960 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
963 INIT_LIST_HEAD(&ps->resources);
965 /* Evaluate "_PRx" to get referenced power resources */
966 status = acpi_evaluate_object(device->handle, pathname, NULL, &buffer);
967 if (ACPI_SUCCESS(status)) {
968 union acpi_object *package = buffer.pointer;
970 if (buffer.length && package
971 && package->type == ACPI_TYPE_PACKAGE
972 && package->package.count)
973 acpi_extract_power_resources(package, 0, &ps->resources);
975 ACPI_FREE(buffer.pointer);
978 /* Evaluate "_PSx" to see if we can do explicit sets */
980 if (acpi_has_method(device->handle, pathname))
981 ps->flags.explicit_set = 1;
983 /* State is valid if there are means to put the device into it. */
984 if (!list_empty(&ps->resources) || ps->flags.explicit_set)
987 ps->power = -1; /* Unknown - driver assigned */
988 ps->latency = -1; /* Unknown - driver assigned */
991 static void acpi_bus_get_power_flags(struct acpi_device *device)
995 /* Presence of _PS0|_PR0 indicates 'power manageable' */
996 if (!acpi_has_method(device->handle, "_PS0") &&
997 !acpi_has_method(device->handle, "_PR0"))
1000 device->flags.power_manageable = 1;
1003 * Power Management Flags
1005 if (acpi_has_method(device->handle, "_PSC"))
1006 device->power.flags.explicit_get = 1;
1008 if (acpi_has_method(device->handle, "_IRC"))
1009 device->power.flags.inrush_current = 1;
1011 if (acpi_has_method(device->handle, "_DSW"))
1012 device->power.flags.dsw_present = 1;
1015 * Enumerate supported power management states
1017 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++)
1018 acpi_bus_init_power_state(device, i);
1020 INIT_LIST_HEAD(&device->power.states[ACPI_STATE_D3_COLD].resources);
1022 /* Set the defaults for D0 and D3hot (always supported). */
1023 device->power.states[ACPI_STATE_D0].flags.valid = 1;
1024 device->power.states[ACPI_STATE_D0].power = 100;
1025 device->power.states[ACPI_STATE_D3_HOT].flags.valid = 1;
1028 * Use power resources only if the D0 list of them is populated, because
1029 * some platforms may provide _PR3 only to indicate D3cold support and
1030 * in those cases the power resources list returned by it may be bogus.
1032 if (!list_empty(&device->power.states[ACPI_STATE_D0].resources)) {
1033 device->power.flags.power_resources = 1;
1035 * D3cold is supported if the D3hot list of power resources is
1038 if (!list_empty(&device->power.states[ACPI_STATE_D3_HOT].resources))
1039 device->power.states[ACPI_STATE_D3_COLD].flags.valid = 1;
1042 if (acpi_bus_init_power(device))
1043 device->flags.power_manageable = 0;
1046 static void acpi_bus_get_flags(struct acpi_device *device)
1048 /* Presence of _STA indicates 'dynamic_status' */
1049 if (acpi_has_method(device->handle, "_STA"))
1050 device->flags.dynamic_status = 1;
1052 /* Presence of _RMV indicates 'removable' */
1053 if (acpi_has_method(device->handle, "_RMV"))
1054 device->flags.removable = 1;
1056 /* Presence of _EJD|_EJ0 indicates 'ejectable' */
1057 if (acpi_has_method(device->handle, "_EJD") ||
1058 acpi_has_method(device->handle, "_EJ0"))
1059 device->flags.ejectable = 1;
1062 static void acpi_device_get_busid(struct acpi_device *device)
1064 char bus_id[5] = { '?', 0 };
1065 struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
1071 * The device's Bus ID is simply the object name.
1072 * TBD: Shouldn't this value be unique (within the ACPI namespace)?
1074 if (ACPI_IS_ROOT_DEVICE(device)) {
1075 strcpy(device->pnp.bus_id, "ACPI");
1079 switch (device->device_type) {
1080 case ACPI_BUS_TYPE_POWER_BUTTON:
1081 strcpy(device->pnp.bus_id, "PWRF");
1083 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1084 strcpy(device->pnp.bus_id, "SLPF");
1086 case ACPI_BUS_TYPE_ECDT_EC:
1087 strcpy(device->pnp.bus_id, "ECDT");
1090 acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
1091 /* Clean up trailing underscores (if any) */
1092 for (i = 3; i > 1; i--) {
1093 if (bus_id[i] == '_')
1098 strcpy(device->pnp.bus_id, bus_id);
1104 * acpi_ata_match - see if an acpi object is an ATA device
1106 * If an acpi object has one of the ACPI ATA methods defined,
1107 * then we can safely call it an ATA device.
1109 bool acpi_ata_match(acpi_handle handle)
1111 return acpi_has_method(handle, "_GTF") ||
1112 acpi_has_method(handle, "_GTM") ||
1113 acpi_has_method(handle, "_STM") ||
1114 acpi_has_method(handle, "_SDD");
1118 * acpi_bay_match - see if an acpi object is an ejectable driver bay
1120 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
1121 * then we can safely call it an ejectable drive bay
1123 bool acpi_bay_match(acpi_handle handle)
1125 acpi_handle phandle;
1127 if (!acpi_has_method(handle, "_EJ0"))
1129 if (acpi_ata_match(handle))
1131 if (ACPI_FAILURE(acpi_get_parent(handle, &phandle)))
1134 return acpi_ata_match(phandle);
1137 bool acpi_device_is_battery(struct acpi_device *adev)
1139 struct acpi_hardware_id *hwid;
1141 list_for_each_entry(hwid, &adev->pnp.ids, list)
1142 if (!strcmp("PNP0C0A", hwid->id))
1148 static bool is_ejectable_bay(struct acpi_device *adev)
1150 acpi_handle handle = adev->handle;
1152 if (acpi_has_method(handle, "_EJ0") && acpi_device_is_battery(adev))
1155 return acpi_bay_match(handle);
1159 * acpi_dock_match - see if an acpi object has a _DCK method
1161 bool acpi_dock_match(acpi_handle handle)
1163 return acpi_has_method(handle, "_DCK");
1167 acpi_backlight_cap_match(acpi_handle handle, u32 level, void *context,
1168 void **return_value)
1170 long *cap = context;
1172 if (acpi_has_method(handle, "_BCM") &&
1173 acpi_has_method(handle, "_BCL")) {
1174 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found generic backlight "
1176 *cap |= ACPI_VIDEO_BACKLIGHT;
1177 /* We have backlight support, no need to scan further */
1178 return AE_CTRL_TERMINATE;
1183 /* Returns true if the ACPI object is a video device which can be
1184 * handled by video.ko.
1185 * The device will get a Linux specific CID added in scan.c to
1186 * identify the device as an ACPI graphics device
1187 * Be aware that the graphics device may not be physically present
1188 * Use acpi_video_get_capabilities() to detect general ACPI video
1189 * capabilities of present cards
1191 long acpi_is_video_device(acpi_handle handle)
1193 long video_caps = 0;
1195 /* Is this device able to support video switching ? */
1196 if (acpi_has_method(handle, "_DOD") || acpi_has_method(handle, "_DOS"))
1197 video_caps |= ACPI_VIDEO_OUTPUT_SWITCHING;
1199 /* Is this device able to retrieve a video ROM ? */
1200 if (acpi_has_method(handle, "_ROM"))
1201 video_caps |= ACPI_VIDEO_ROM_AVAILABLE;
1203 /* Is this device able to configure which video head to be POSTed ? */
1204 if (acpi_has_method(handle, "_VPO") &&
1205 acpi_has_method(handle, "_GPD") &&
1206 acpi_has_method(handle, "_SPD"))
1207 video_caps |= ACPI_VIDEO_DEVICE_POSTING;
1209 /* Only check for backlight functionality if one of the above hit. */
1211 acpi_walk_namespace(ACPI_TYPE_DEVICE, handle,
1212 ACPI_UINT32_MAX, acpi_backlight_cap_match, NULL,
1217 EXPORT_SYMBOL(acpi_is_video_device);
1219 const char *acpi_device_hid(struct acpi_device *device)
1221 struct acpi_hardware_id *hid;
1223 if (list_empty(&device->pnp.ids))
1226 hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
1229 EXPORT_SYMBOL(acpi_device_hid);
1231 static void acpi_add_id(struct acpi_device_pnp *pnp, const char *dev_id)
1233 struct acpi_hardware_id *id;
1235 id = kmalloc(sizeof(*id), GFP_KERNEL);
1239 id->id = kstrdup_const(dev_id, GFP_KERNEL);
1245 list_add_tail(&id->list, &pnp->ids);
1246 pnp->type.hardware_id = 1;
1250 * Old IBM workstations have a DSDT bug wherein the SMBus object
1251 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
1252 * prefix. Work around this.
1254 static bool acpi_ibm_smbus_match(acpi_handle handle)
1256 char node_name[ACPI_PATH_SEGMENT_LENGTH];
1257 struct acpi_buffer path = { sizeof(node_name), node_name };
1259 if (!dmi_name_in_vendors("IBM"))
1262 /* Look for SMBS object */
1263 if (ACPI_FAILURE(acpi_get_name(handle, ACPI_SINGLE_NAME, &path)) ||
1264 strcmp("SMBS", path.pointer))
1267 /* Does it have the necessary (but misnamed) methods? */
1268 if (acpi_has_method(handle, "SBI") &&
1269 acpi_has_method(handle, "SBR") &&
1270 acpi_has_method(handle, "SBW"))
1276 static bool acpi_object_is_system_bus(acpi_handle handle)
1280 if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_SB", &tmp)) &&
1283 if (ACPI_SUCCESS(acpi_get_handle(NULL, "\\_TZ", &tmp)) &&
1290 static void acpi_set_pnp_ids(acpi_handle handle, struct acpi_device_pnp *pnp,
1291 int device_type, struct acpi_device_info *info)
1293 struct acpi_pnp_device_id_list *cid_list;
1296 switch (device_type) {
1297 case ACPI_BUS_TYPE_DEVICE:
1298 if (handle == ACPI_ROOT_OBJECT) {
1299 acpi_add_id(pnp, ACPI_SYSTEM_HID);
1304 pr_err(PREFIX "%s: Error reading device info\n",
1309 if (info->valid & ACPI_VALID_HID) {
1310 acpi_add_id(pnp, info->hardware_id.string);
1311 pnp->type.platform_id = 1;
1313 if (info->valid & ACPI_VALID_CID) {
1314 cid_list = &info->compatible_id_list;
1315 for (i = 0; i < cid_list->count; i++)
1316 acpi_add_id(pnp, cid_list->ids[i].string);
1318 if (info->valid & ACPI_VALID_ADR) {
1319 pnp->bus_address = info->address;
1320 pnp->type.bus_address = 1;
1322 if (info->valid & ACPI_VALID_UID)
1323 pnp->unique_id = kstrdup(info->unique_id.string,
1325 if (info->valid & ACPI_VALID_CLS)
1326 acpi_add_id(pnp, info->class_code.string);
1329 * Some devices don't reliably have _HIDs & _CIDs, so add
1330 * synthetic HIDs to make sure drivers can find them.
1332 if (acpi_is_video_device(handle))
1333 acpi_add_id(pnp, ACPI_VIDEO_HID);
1334 else if (acpi_bay_match(handle))
1335 acpi_add_id(pnp, ACPI_BAY_HID);
1336 else if (acpi_dock_match(handle))
1337 acpi_add_id(pnp, ACPI_DOCK_HID);
1338 else if (acpi_ibm_smbus_match(handle))
1339 acpi_add_id(pnp, ACPI_SMBUS_IBM_HID);
1340 else if (list_empty(&pnp->ids) &&
1341 acpi_object_is_system_bus(handle)) {
1342 /* \_SB, \_TZ, LNXSYBUS */
1343 acpi_add_id(pnp, ACPI_BUS_HID);
1344 strcpy(pnp->device_name, ACPI_BUS_DEVICE_NAME);
1345 strcpy(pnp->device_class, ACPI_BUS_CLASS);
1349 case ACPI_BUS_TYPE_POWER:
1350 acpi_add_id(pnp, ACPI_POWER_HID);
1352 case ACPI_BUS_TYPE_PROCESSOR:
1353 acpi_add_id(pnp, ACPI_PROCESSOR_OBJECT_HID);
1355 case ACPI_BUS_TYPE_THERMAL:
1356 acpi_add_id(pnp, ACPI_THERMAL_HID);
1358 case ACPI_BUS_TYPE_POWER_BUTTON:
1359 acpi_add_id(pnp, ACPI_BUTTON_HID_POWERF);
1361 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1362 acpi_add_id(pnp, ACPI_BUTTON_HID_SLEEPF);
1364 case ACPI_BUS_TYPE_ECDT_EC:
1365 acpi_add_id(pnp, ACPI_ECDT_HID);
1370 void acpi_free_pnp_ids(struct acpi_device_pnp *pnp)
1372 struct acpi_hardware_id *id, *tmp;
1374 list_for_each_entry_safe(id, tmp, &pnp->ids, list) {
1375 kfree_const(id->id);
1378 kfree(pnp->unique_id);
1382 * acpi_dma_supported - Check DMA support for the specified device.
1383 * @adev: The pointer to acpi device
1385 * Return false if DMA is not supported. Otherwise, return true
1387 bool acpi_dma_supported(struct acpi_device *adev)
1392 if (adev->flags.cca_seen)
1396 * Per ACPI 6.0 sec 6.2.17, assume devices can do cache-coherent
1397 * DMA on "Intel platforms". Presumably that includes all x86 and
1398 * ia64, and other arches will set CONFIG_ACPI_CCA_REQUIRED=y.
1400 if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
1407 * acpi_get_dma_attr - Check the supported DMA attr for the specified device.
1408 * @adev: The pointer to acpi device
1410 * Return enum dev_dma_attr.
1412 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
1414 if (!acpi_dma_supported(adev))
1415 return DEV_DMA_NOT_SUPPORTED;
1417 if (adev->flags.coherent_dma)
1418 return DEV_DMA_COHERENT;
1420 return DEV_DMA_NON_COHERENT;
1424 * acpi_dma_get_range() - Get device DMA parameters.
1426 * @dev: device to configure
1427 * @dma_addr: pointer device DMA address result
1428 * @offset: pointer to the DMA offset result
1429 * @size: pointer to DMA range size result
1431 * Evaluate DMA regions and return respectively DMA region start, offset
1432 * and size in dma_addr, offset and size on parsing success; it does not
1433 * update the passed in values on failure.
1435 * Return 0 on success, < 0 on failure.
1437 int acpi_dma_get_range(struct device *dev, u64 *dma_addr, u64 *offset,
1440 struct acpi_device *adev;
1442 struct resource_entry *rentry;
1444 struct device *dma_dev = dev;
1445 u64 len, dma_start = U64_MAX, dma_end = 0, dma_offset = 0;
1448 * Walk the device tree chasing an ACPI companion with a _DMA
1449 * object while we go. Stop if we find a device with an ACPI
1450 * companion containing a _DMA method.
1453 adev = ACPI_COMPANION(dma_dev);
1454 if (adev && acpi_has_method(adev->handle, METHOD_NAME__DMA))
1457 dma_dev = dma_dev->parent;
1463 if (!acpi_has_method(adev->handle, METHOD_NAME__CRS)) {
1464 acpi_handle_warn(adev->handle, "_DMA is valid only if _CRS is present\n");
1468 ret = acpi_dev_get_dma_resources(adev, &list);
1470 list_for_each_entry(rentry, &list, node) {
1471 if (dma_offset && rentry->offset != dma_offset) {
1473 dev_warn(dma_dev, "Can't handle multiple windows with different offsets\n");
1476 dma_offset = rentry->offset;
1478 /* Take lower and upper limits */
1479 if (rentry->res->start < dma_start)
1480 dma_start = rentry->res->start;
1481 if (rentry->res->end > dma_end)
1482 dma_end = rentry->res->end;
1485 if (dma_start >= dma_end) {
1487 dev_dbg(dma_dev, "Invalid DMA regions configuration\n");
1491 *dma_addr = dma_start - dma_offset;
1492 len = dma_end - dma_start;
1493 *size = max(len, len + 1);
1494 *offset = dma_offset;
1497 acpi_dev_free_resource_list(&list);
1499 return ret >= 0 ? 0 : ret;
1503 * acpi_dma_configure_id - Set-up DMA configuration for the device.
1504 * @dev: The pointer to the device
1505 * @attr: device dma attributes
1506 * @input_id: input device id const value pointer
1508 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
1509 const u32 *input_id)
1511 const struct iommu_ops *iommu;
1512 u64 dma_addr = 0, size = 0;
1514 if (attr == DEV_DMA_NOT_SUPPORTED) {
1515 set_dma_ops(dev, &dma_dummy_ops);
1519 iort_dma_setup(dev, &dma_addr, &size);
1521 iommu = iort_iommu_configure_id(dev, input_id);
1522 if (PTR_ERR(iommu) == -EPROBE_DEFER)
1523 return -EPROBE_DEFER;
1525 arch_setup_dma_ops(dev, dma_addr, size,
1526 iommu, attr == DEV_DMA_COHERENT);
1530 EXPORT_SYMBOL_GPL(acpi_dma_configure_id);
1532 static void acpi_init_coherency(struct acpi_device *adev)
1534 unsigned long long cca = 0;
1536 struct acpi_device *parent = adev->parent;
1538 if (parent && parent->flags.cca_seen) {
1540 * From ACPI spec, OSPM will ignore _CCA if an ancestor
1543 adev->flags.cca_seen = 1;
1544 cca = parent->flags.coherent_dma;
1546 status = acpi_evaluate_integer(adev->handle, "_CCA",
1548 if (ACPI_SUCCESS(status))
1549 adev->flags.cca_seen = 1;
1550 else if (!IS_ENABLED(CONFIG_ACPI_CCA_REQUIRED))
1552 * If architecture does not specify that _CCA is
1553 * required for DMA-able devices (e.g. x86),
1554 * we default to _CCA=1.
1558 acpi_handle_debug(adev->handle,
1559 "ACPI device is missing _CCA.\n");
1562 adev->flags.coherent_dma = cca;
1565 static int acpi_check_serial_bus_slave(struct acpi_resource *ares, void *data)
1567 bool *is_serial_bus_slave_p = data;
1569 if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
1572 *is_serial_bus_slave_p = true;
1574 /* no need to do more checking */
1578 static bool acpi_is_indirect_io_slave(struct acpi_device *device)
1580 struct acpi_device *parent = device->parent;
1581 static const struct acpi_device_id indirect_io_hosts[] = {
1586 return parent && !acpi_match_device_ids(parent, indirect_io_hosts);
1589 static bool acpi_device_enumeration_by_parent(struct acpi_device *device)
1591 struct list_head resource_list;
1592 bool is_serial_bus_slave = false;
1594 * These devices have multiple I2cSerialBus resources and an i2c-client
1595 * must be instantiated for each, each with its own i2c_device_id.
1596 * Normally we only instantiate an i2c-client for the first resource,
1597 * using the ACPI HID as id. These special cases are handled by the
1598 * drivers/platform/x86/i2c-multi-instantiate.c driver, which knows
1599 * which i2c_device_id to use for each resource.
1601 static const struct acpi_device_id i2c_multi_instantiate_ids[] = {
1609 if (acpi_is_indirect_io_slave(device))
1612 /* Macs use device properties in lieu of _CRS resources */
1613 if (x86_apple_machine &&
1614 (fwnode_property_present(&device->fwnode, "spiSclkPeriod") ||
1615 fwnode_property_present(&device->fwnode, "i2cAddress") ||
1616 fwnode_property_present(&device->fwnode, "baud")))
1619 /* Instantiate a pdev for the i2c-multi-instantiate drv to bind to */
1620 if (!acpi_match_device_ids(device, i2c_multi_instantiate_ids))
1623 INIT_LIST_HEAD(&resource_list);
1624 acpi_dev_get_resources(device, &resource_list,
1625 acpi_check_serial_bus_slave,
1626 &is_serial_bus_slave);
1627 acpi_dev_free_resource_list(&resource_list);
1629 return is_serial_bus_slave;
1632 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
1633 int type, unsigned long long sta,
1634 struct acpi_device_info *info)
1636 INIT_LIST_HEAD(&device->pnp.ids);
1637 device->device_type = type;
1638 device->handle = handle;
1639 device->parent = acpi_bus_get_parent(handle);
1640 fwnode_init(&device->fwnode, &acpi_device_fwnode_ops);
1641 acpi_set_device_status(device, sta);
1642 acpi_device_get_busid(device);
1643 acpi_set_pnp_ids(handle, &device->pnp, type, info);
1644 acpi_init_properties(device);
1645 acpi_bus_get_flags(device);
1646 device->flags.match_driver = false;
1647 device->flags.initialized = true;
1648 device->flags.enumeration_by_parent =
1649 acpi_device_enumeration_by_parent(device);
1650 acpi_device_clear_enumerated(device);
1651 device_initialize(&device->dev);
1652 dev_set_uevent_suppress(&device->dev, true);
1653 acpi_init_coherency(device);
1656 void acpi_device_add_finalize(struct acpi_device *device)
1658 dev_set_uevent_suppress(&device->dev, false);
1659 kobject_uevent(&device->dev.kobj, KOBJ_ADD);
1662 static int acpi_add_single_object(struct acpi_device **child,
1663 acpi_handle handle, int type,
1664 unsigned long long sta)
1667 struct acpi_device *device;
1668 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1669 struct acpi_device_info *info = NULL;
1671 if (handle != ACPI_ROOT_OBJECT && type == ACPI_BUS_TYPE_DEVICE)
1672 acpi_get_object_info(handle, &info);
1674 device = kzalloc(sizeof(struct acpi_device), GFP_KERNEL);
1676 printk(KERN_ERR PREFIX "Memory allocation error\n");
1681 acpi_init_device_object(device, handle, type, sta, info);
1684 * For ACPI_BUS_TYPE_DEVICE getting the status is delayed till here so
1685 * that we can call acpi_bus_get_status() and use its quirk handling.
1686 * Note this must be done before the get power-/wakeup_dev-flags calls.
1688 if (type == ACPI_BUS_TYPE_DEVICE)
1689 if (acpi_bus_get_status(device) < 0)
1690 acpi_set_device_status(device, 0);
1692 acpi_bus_get_power_flags(device);
1693 acpi_bus_get_wakeup_device_flags(device);
1695 result = acpi_device_add(device, acpi_device_release);
1697 acpi_device_release(&device->dev);
1701 acpi_power_add_remove_device(device, true);
1702 acpi_device_add_finalize(device);
1703 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1704 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Added %s [%s] parent %s\n",
1705 dev_name(&device->dev), (char *) buffer.pointer,
1706 device->parent ? dev_name(&device->parent->dev) : "(null)"));
1707 kfree(buffer.pointer);
1712 static acpi_status acpi_get_resource_memory(struct acpi_resource *ares,
1715 struct resource *res = context;
1717 if (acpi_dev_resource_memory(ares, res))
1718 return AE_CTRL_TERMINATE;
1723 static bool acpi_device_should_be_hidden(acpi_handle handle)
1726 struct resource res;
1728 /* Check if it should ignore the UART device */
1729 if (!(spcr_uart_addr && acpi_has_method(handle, METHOD_NAME__CRS)))
1733 * The UART device described in SPCR table is assumed to have only one
1734 * memory resource present. So we only look for the first one here.
1736 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1737 acpi_get_resource_memory, &res);
1738 if (ACPI_FAILURE(status) || res.start != spcr_uart_addr)
1741 acpi_handle_info(handle, "The UART device @%pa in SPCR table will be hidden\n",
1747 static int acpi_bus_type_and_status(acpi_handle handle, int *type,
1748 unsigned long long *sta)
1751 acpi_object_type acpi_type;
1753 status = acpi_get_type(handle, &acpi_type);
1754 if (ACPI_FAILURE(status))
1757 switch (acpi_type) {
1758 case ACPI_TYPE_ANY: /* for ACPI_ROOT_OBJECT */
1759 case ACPI_TYPE_DEVICE:
1760 if (acpi_device_should_be_hidden(handle))
1763 *type = ACPI_BUS_TYPE_DEVICE;
1765 * acpi_add_single_object updates this once we've an acpi_device
1766 * so that acpi_bus_get_status' quirk handling can be used.
1768 *sta = ACPI_STA_DEFAULT;
1770 case ACPI_TYPE_PROCESSOR:
1771 *type = ACPI_BUS_TYPE_PROCESSOR;
1772 status = acpi_bus_get_status_handle(handle, sta);
1773 if (ACPI_FAILURE(status))
1776 case ACPI_TYPE_THERMAL:
1777 *type = ACPI_BUS_TYPE_THERMAL;
1778 *sta = ACPI_STA_DEFAULT;
1780 case ACPI_TYPE_POWER:
1781 *type = ACPI_BUS_TYPE_POWER;
1782 *sta = ACPI_STA_DEFAULT;
1791 bool acpi_device_is_present(const struct acpi_device *adev)
1793 return adev->status.present || adev->status.functional;
1796 static bool acpi_scan_handler_matching(struct acpi_scan_handler *handler,
1798 const struct acpi_device_id **matchid)
1800 const struct acpi_device_id *devid;
1803 return handler->match(idstr, matchid);
1805 for (devid = handler->ids; devid->id[0]; devid++)
1806 if (!strcmp((char *)devid->id, idstr)) {
1816 static struct acpi_scan_handler *acpi_scan_match_handler(const char *idstr,
1817 const struct acpi_device_id **matchid)
1819 struct acpi_scan_handler *handler;
1821 list_for_each_entry(handler, &acpi_scan_handlers_list, list_node)
1822 if (acpi_scan_handler_matching(handler, idstr, matchid))
1828 void acpi_scan_hotplug_enabled(struct acpi_hotplug_profile *hotplug, bool val)
1830 if (!!hotplug->enabled == !!val)
1833 mutex_lock(&acpi_scan_lock);
1835 hotplug->enabled = val;
1837 mutex_unlock(&acpi_scan_lock);
1840 static void acpi_scan_init_hotplug(struct acpi_device *adev)
1842 struct acpi_hardware_id *hwid;
1844 if (acpi_dock_match(adev->handle) || is_ejectable_bay(adev)) {
1845 acpi_dock_add(adev);
1848 list_for_each_entry(hwid, &adev->pnp.ids, list) {
1849 struct acpi_scan_handler *handler;
1851 handler = acpi_scan_match_handler(hwid->id, NULL);
1853 adev->flags.hotplug_notify = true;
1859 static u32 acpi_scan_check_dep(acpi_handle handle)
1861 struct acpi_handle_list dep_devices;
1867 * Check for _HID here to avoid deferring the enumeration of:
1869 * 2. ACPI nodes describing USB ports.
1870 * Still, checking for _HID catches more then just these cases ...
1872 if (!acpi_has_method(handle, "_DEP") || !acpi_has_method(handle, "_HID"))
1875 status = acpi_evaluate_reference(handle, "_DEP", NULL, &dep_devices);
1876 if (ACPI_FAILURE(status)) {
1877 acpi_handle_debug(handle, "Failed to evaluate _DEP.\n");
1881 for (count = 0, i = 0; i < dep_devices.count; i++) {
1882 struct acpi_device_info *info;
1883 struct acpi_dep_data *dep;
1886 status = acpi_get_object_info(dep_devices.handles[i], &info);
1887 if (ACPI_FAILURE(status)) {
1888 acpi_handle_debug(handle, "Error reading _DEP device info\n");
1892 skip = acpi_info_matches_ids(info, acpi_ignore_dep_ids);
1898 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
1904 dep->supplier = dep_devices.handles[i];
1905 dep->consumer = handle;
1907 mutex_lock(&acpi_dep_list_lock);
1908 list_add_tail(&dep->node , &acpi_dep_list);
1909 mutex_unlock(&acpi_dep_list_lock);
1915 static void acpi_scan_dep_init(struct acpi_device *adev)
1917 struct acpi_dep_data *dep;
1919 mutex_lock(&acpi_dep_list_lock);
1921 list_for_each_entry(dep, &acpi_dep_list, node) {
1922 if (dep->consumer == adev->handle)
1926 mutex_unlock(&acpi_dep_list_lock);
1929 static bool acpi_bus_scan_second_pass;
1931 static acpi_status acpi_bus_check_add(acpi_handle handle, bool check_dep,
1932 struct acpi_device **adev_p)
1934 struct acpi_device *device = NULL;
1935 unsigned long long sta;
1939 acpi_bus_get_device(handle, &device);
1943 result = acpi_bus_type_and_status(handle, &type, &sta);
1947 if (type == ACPI_BUS_TYPE_POWER) {
1948 acpi_add_power_resource(handle);
1952 if (type == ACPI_BUS_TYPE_DEVICE && check_dep) {
1953 u32 count = acpi_scan_check_dep(handle);
1954 /* Bail out if the number of recorded dependencies is not 0. */
1956 acpi_bus_scan_second_pass = true;
1957 return AE_CTRL_DEPTH;
1961 acpi_add_single_object(&device, handle, type, sta);
1963 return AE_CTRL_DEPTH;
1965 acpi_scan_init_hotplug(device);
1967 acpi_scan_dep_init(device);
1976 static acpi_status acpi_bus_check_add_1(acpi_handle handle, u32 lvl_not_used,
1977 void *not_used, void **ret_p)
1979 return acpi_bus_check_add(handle, true, (struct acpi_device **)ret_p);
1982 static acpi_status acpi_bus_check_add_2(acpi_handle handle, u32 lvl_not_used,
1983 void *not_used, void **ret_p)
1985 return acpi_bus_check_add(handle, false, (struct acpi_device **)ret_p);
1988 static void acpi_default_enumeration(struct acpi_device *device)
1991 * Do not enumerate devices with enumeration_by_parent flag set as
1992 * they will be enumerated by their respective parents.
1994 if (!device->flags.enumeration_by_parent) {
1995 acpi_create_platform_device(device, NULL);
1996 acpi_device_set_enumerated(device);
1998 blocking_notifier_call_chain(&acpi_reconfig_chain,
1999 ACPI_RECONFIG_DEVICE_ADD, device);
2003 static const struct acpi_device_id generic_device_ids[] = {
2004 {ACPI_DT_NAMESPACE_HID, },
2008 static int acpi_generic_device_attach(struct acpi_device *adev,
2009 const struct acpi_device_id *not_used)
2012 * Since ACPI_DT_NAMESPACE_HID is the only ID handled here, the test
2013 * below can be unconditional.
2015 if (adev->data.of_compatible)
2016 acpi_default_enumeration(adev);
2021 static struct acpi_scan_handler generic_device_handler = {
2022 .ids = generic_device_ids,
2023 .attach = acpi_generic_device_attach,
2026 static int acpi_scan_attach_handler(struct acpi_device *device)
2028 struct acpi_hardware_id *hwid;
2031 list_for_each_entry(hwid, &device->pnp.ids, list) {
2032 const struct acpi_device_id *devid;
2033 struct acpi_scan_handler *handler;
2035 handler = acpi_scan_match_handler(hwid->id, &devid);
2037 if (!handler->attach) {
2038 device->pnp.type.platform_id = 0;
2041 device->handler = handler;
2042 ret = handler->attach(device, devid);
2046 device->handler = NULL;
2055 static void acpi_bus_attach(struct acpi_device *device, bool first_pass)
2057 struct acpi_device *child;
2058 bool skip = !first_pass && device->flags.visited;
2065 if (ACPI_SUCCESS(acpi_bus_get_ejd(device->handle, &ejd)))
2066 register_dock_dependent_device(device, ejd);
2068 acpi_bus_get_status(device);
2069 /* Skip devices that are not present. */
2070 if (!acpi_device_is_present(device)) {
2071 device->flags.initialized = false;
2072 acpi_device_clear_enumerated(device);
2073 device->flags.power_manageable = 0;
2076 if (device->handler)
2079 if (!device->flags.initialized) {
2080 device->flags.power_manageable =
2081 device->power.states[ACPI_STATE_D0].flags.valid;
2082 if (acpi_bus_init_power(device))
2083 device->flags.power_manageable = 0;
2085 device->flags.initialized = true;
2086 } else if (device->flags.visited) {
2090 ret = acpi_scan_attach_handler(device);
2094 device->flags.match_driver = true;
2095 if (ret > 0 && !device->flags.enumeration_by_parent) {
2096 acpi_device_set_enumerated(device);
2100 ret = device_attach(&device->dev);
2104 if (device->pnp.type.platform_id || device->flags.enumeration_by_parent)
2105 acpi_default_enumeration(device);
2107 acpi_device_set_enumerated(device);
2110 list_for_each_entry(child, &device->children, node)
2111 acpi_bus_attach(child, first_pass);
2113 if (!skip && device->handler && device->handler->hotplug.notify_online)
2114 device->handler->hotplug.notify_online(device);
2117 void acpi_walk_dep_device_list(acpi_handle handle)
2119 struct acpi_dep_data *dep, *tmp;
2120 struct acpi_device *adev;
2122 mutex_lock(&acpi_dep_list_lock);
2123 list_for_each_entry_safe(dep, tmp, &acpi_dep_list, node) {
2124 if (dep->supplier == handle) {
2125 acpi_bus_get_device(dep->consumer, &adev);
2129 if (!adev->dep_unmet)
2130 acpi_bus_attach(adev, true);
2133 list_del(&dep->node);
2137 mutex_unlock(&acpi_dep_list_lock);
2139 EXPORT_SYMBOL_GPL(acpi_walk_dep_device_list);
2142 * acpi_bus_scan - Add ACPI device node objects in a given namespace scope.
2143 * @handle: Root of the namespace scope to scan.
2145 * Scan a given ACPI tree (probably recently hot-plugged) and create and add
2148 * If no devices were found, -ENODEV is returned, but it does not mean that
2149 * there has been a real error. There just have been no suitable ACPI objects
2150 * in the table trunk from which the kernel could create a device and add an
2151 * appropriate driver.
2153 * Must be called under acpi_scan_lock.
2155 int acpi_bus_scan(acpi_handle handle)
2157 struct acpi_device *device = NULL;
2159 acpi_bus_scan_second_pass = false;
2161 /* Pass 1: Avoid enumerating devices with missing dependencies. */
2163 if (ACPI_SUCCESS(acpi_bus_check_add(handle, true, &device)))
2164 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
2165 acpi_bus_check_add_1, NULL, NULL,
2171 acpi_bus_attach(device, true);
2173 if (!acpi_bus_scan_second_pass)
2176 /* Pass 2: Enumerate all of the remaining devices. */
2180 if (ACPI_SUCCESS(acpi_bus_check_add(handle, false, &device)))
2181 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
2182 acpi_bus_check_add_2, NULL, NULL,
2185 acpi_bus_attach(device, false);
2189 EXPORT_SYMBOL(acpi_bus_scan);
2192 * acpi_bus_trim - Detach scan handlers and drivers from ACPI device objects.
2193 * @adev: Root of the ACPI namespace scope to walk.
2195 * Must be called under acpi_scan_lock.
2197 void acpi_bus_trim(struct acpi_device *adev)
2199 struct acpi_scan_handler *handler = adev->handler;
2200 struct acpi_device *child;
2202 list_for_each_entry_reverse(child, &adev->children, node)
2203 acpi_bus_trim(child);
2205 adev->flags.match_driver = false;
2207 if (handler->detach)
2208 handler->detach(adev);
2210 adev->handler = NULL;
2212 device_release_driver(&adev->dev);
2215 * Most likely, the device is going away, so put it into D3cold before
2218 acpi_device_set_power(adev, ACPI_STATE_D3_COLD);
2219 adev->flags.initialized = false;
2220 acpi_device_clear_enumerated(adev);
2222 EXPORT_SYMBOL_GPL(acpi_bus_trim);
2224 int acpi_bus_register_early_device(int type)
2226 struct acpi_device *device = NULL;
2229 result = acpi_add_single_object(&device, NULL,
2230 type, ACPI_STA_DEFAULT);
2234 device->flags.match_driver = true;
2235 return device_attach(&device->dev);
2237 EXPORT_SYMBOL_GPL(acpi_bus_register_early_device);
2239 static int acpi_bus_scan_fixed(void)
2244 * Enumerate all fixed-feature devices.
2246 if (!(acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON)) {
2247 struct acpi_device *device = NULL;
2249 result = acpi_add_single_object(&device, NULL,
2250 ACPI_BUS_TYPE_POWER_BUTTON,
2255 device->flags.match_driver = true;
2256 result = device_attach(&device->dev);
2260 device_init_wakeup(&device->dev, true);
2263 if (!(acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON)) {
2264 struct acpi_device *device = NULL;
2266 result = acpi_add_single_object(&device, NULL,
2267 ACPI_BUS_TYPE_SLEEP_BUTTON,
2272 device->flags.match_driver = true;
2273 result = device_attach(&device->dev);
2276 return result < 0 ? result : 0;
2279 static void __init acpi_get_spcr_uart_addr(void)
2282 struct acpi_table_spcr *spcr_ptr;
2284 status = acpi_get_table(ACPI_SIG_SPCR, 0,
2285 (struct acpi_table_header **)&spcr_ptr);
2286 if (ACPI_FAILURE(status)) {
2287 pr_warn(PREFIX "STAO table present, but SPCR is missing\n");
2291 spcr_uart_addr = spcr_ptr->serial_port.address;
2292 acpi_put_table((struct acpi_table_header *)spcr_ptr);
2295 static bool acpi_scan_initialized;
2297 int __init acpi_scan_init(void)
2301 struct acpi_table_stao *stao_ptr;
2303 acpi_pci_root_init();
2304 acpi_pci_link_init();
2305 acpi_processor_init();
2306 acpi_platform_init();
2309 acpi_cmos_rtc_init();
2310 acpi_container_init();
2311 acpi_memory_hotplug_init();
2312 acpi_watchdog_init();
2314 acpi_int340x_thermal_init();
2318 acpi_scan_add_handler(&generic_device_handler);
2321 * If there is STAO table, check whether it needs to ignore the UART
2322 * device in SPCR table.
2324 status = acpi_get_table(ACPI_SIG_STAO, 0,
2325 (struct acpi_table_header **)&stao_ptr);
2326 if (ACPI_SUCCESS(status)) {
2327 if (stao_ptr->header.length > sizeof(struct acpi_table_stao))
2328 pr_info(PREFIX "STAO Name List not yet supported.\n");
2330 if (stao_ptr->ignore_uart)
2331 acpi_get_spcr_uart_addr();
2333 acpi_put_table((struct acpi_table_header *)stao_ptr);
2336 acpi_gpe_apply_masked_gpes();
2337 acpi_update_all_gpes();
2340 * Although we call __add_memory() that is documented to require the
2341 * device_hotplug_lock, it is not necessary here because this is an
2342 * early code when userspace or any other code path cannot trigger
2343 * hotplug/hotunplug operations.
2345 mutex_lock(&acpi_scan_lock);
2347 * Enumerate devices in the ACPI namespace.
2349 result = acpi_bus_scan(ACPI_ROOT_OBJECT);
2353 result = acpi_bus_get_device(ACPI_ROOT_OBJECT, &acpi_root);
2357 /* Fixed feature devices do not exist on HW-reduced platform */
2358 if (!acpi_gbl_reduced_hardware) {
2359 result = acpi_bus_scan_fixed();
2361 acpi_detach_data(acpi_root->handle,
2362 acpi_scan_drop_device);
2363 acpi_device_del(acpi_root);
2364 put_device(&acpi_root->dev);
2369 acpi_scan_initialized = true;
2372 mutex_unlock(&acpi_scan_lock);
2376 static struct acpi_probe_entry *ape;
2377 static int acpi_probe_count;
2378 static DEFINE_MUTEX(acpi_probe_mutex);
2380 static int __init acpi_match_madt(union acpi_subtable_headers *header,
2381 const unsigned long end)
2383 if (!ape->subtable_valid || ape->subtable_valid(&header->common, ape))
2384 if (!ape->probe_subtbl(header, end))
2390 int __init __acpi_probe_device_table(struct acpi_probe_entry *ap_head, int nr)
2397 mutex_lock(&acpi_probe_mutex);
2398 for (ape = ap_head; nr; ape++, nr--) {
2399 if (ACPI_COMPARE_NAMESEG(ACPI_SIG_MADT, ape->id)) {
2400 acpi_probe_count = 0;
2401 acpi_table_parse_madt(ape->type, acpi_match_madt, 0);
2402 count += acpi_probe_count;
2405 res = acpi_table_parse(ape->id, ape->probe_table);
2410 mutex_unlock(&acpi_probe_mutex);
2415 struct acpi_table_events_work {
2416 struct work_struct work;
2421 static void acpi_table_events_fn(struct work_struct *work)
2423 struct acpi_table_events_work *tew;
2425 tew = container_of(work, struct acpi_table_events_work, work);
2427 if (tew->event == ACPI_TABLE_EVENT_LOAD) {
2428 acpi_scan_lock_acquire();
2429 acpi_bus_scan(ACPI_ROOT_OBJECT);
2430 acpi_scan_lock_release();
2436 void acpi_scan_table_handler(u32 event, void *table, void *context)
2438 struct acpi_table_events_work *tew;
2440 if (!acpi_scan_initialized)
2443 if (event != ACPI_TABLE_EVENT_LOAD)
2446 tew = kmalloc(sizeof(*tew), GFP_KERNEL);
2450 INIT_WORK(&tew->work, acpi_table_events_fn);
2454 schedule_work(&tew->work);
2457 int acpi_reconfig_notifier_register(struct notifier_block *nb)
2459 return blocking_notifier_chain_register(&acpi_reconfig_chain, nb);
2461 EXPORT_SYMBOL(acpi_reconfig_notifier_register);
2463 int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
2465 return blocking_notifier_chain_unregister(&acpi_reconfig_chain, nb);
2467 EXPORT_SYMBOL(acpi_reconfig_notifier_unregister);