2 * scan.c - support for transforming the ACPI namespace into individual objects
5 #include <linux/module.h>
6 #include <linux/init.h>
7 #include <linux/slab.h>
8 #include <linux/kernel.h>
9 #include <linux/acpi.h>
10 #include <linux/signal.h>
11 #include <linux/kthread.h>
12 #include <linux/dmi.h>
13 #include <linux/nls.h>
15 #include <acpi/acpi_drivers.h>
19 #define _COMPONENT ACPI_BUS_COMPONENT
20 ACPI_MODULE_NAME("scan");
21 #define STRUCT_TO_INT(s) (*((int*)&s))
22 extern struct acpi_device *acpi_root;
24 #define ACPI_BUS_CLASS "system_bus"
25 #define ACPI_BUS_HID "LNXSYBUS"
26 #define ACPI_BUS_DEVICE_NAME "System Bus"
28 #define ACPI_IS_ROOT_DEVICE(device) (!(device)->parent)
30 static const char *dummy_hid = "device";
33 * The following ACPI IDs are known to be suitable for representing as
36 static const struct acpi_device_id acpi_platform_device_ids[] = {
40 /* Haswell LPSS devices */
53 static LIST_HEAD(acpi_device_list);
54 static LIST_HEAD(acpi_bus_id_list);
55 DEFINE_MUTEX(acpi_device_lock);
56 LIST_HEAD(acpi_wakeup_device_list);
58 struct acpi_device_bus_id{
60 unsigned int instance_no;
61 struct list_head node;
65 * Creates hid/cid(s) string needed for modalias and uevent
66 * e.g. on a device with hid:IBM0001 and cid:ACPI0001 you get:
67 * char *modalias: "acpi:IBM0001:ACPI0001"
69 static int create_modalias(struct acpi_device *acpi_dev, char *modalias,
74 struct acpi_hardware_id *id;
76 if (list_empty(&acpi_dev->pnp.ids))
79 len = snprintf(modalias, size, "acpi:");
82 list_for_each_entry(id, &acpi_dev->pnp.ids, list) {
83 count = snprintf(&modalias[len], size, "%s:", id->id);
84 if (count < 0 || count >= size)
95 acpi_device_modalias_show(struct device *dev, struct device_attribute *attr, char *buf) {
96 struct acpi_device *acpi_dev = to_acpi_device(dev);
99 /* Device has no HID and no CID or string is >1024 */
100 len = create_modalias(acpi_dev, buf, 1024);
106 static DEVICE_ATTR(modalias, 0444, acpi_device_modalias_show, NULL);
109 * acpi_bus_hot_remove_device: hot-remove a device and its children
110 * @context: struct acpi_eject_event pointer (freed in this func)
112 * Hot-remove a device and its children. This function frees up the
113 * memory space passed by arg context, so that the caller may call
114 * this function asynchronously through acpi_os_hotplug_execute().
116 void acpi_bus_hot_remove_device(void *context)
118 struct acpi_eject_event *ej_event = (struct acpi_eject_event *) context;
119 struct acpi_device *device = ej_event->device;
120 acpi_handle handle = device->handle;
122 struct acpi_object_list arg_list;
123 union acpi_object arg;
124 acpi_status status = AE_OK;
125 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */
127 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
128 "Hot-removing device %s...\n", dev_name(&device->dev)));
130 if (acpi_bus_trim(device)) {
131 printk(KERN_ERR PREFIX
132 "Removing device failed\n");
136 /* device has been freed */
139 /* power off device */
140 status = acpi_evaluate_object(handle, "_PS3", NULL, NULL);
141 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
142 printk(KERN_WARNING PREFIX
143 "Power-off device failed\n");
145 if (ACPI_SUCCESS(acpi_get_handle(handle, "_LCK", &temp))) {
147 arg_list.pointer = &arg;
148 arg.type = ACPI_TYPE_INTEGER;
149 arg.integer.value = 0;
150 acpi_evaluate_object(handle, "_LCK", &arg_list, NULL);
154 arg_list.pointer = &arg;
155 arg.type = ACPI_TYPE_INTEGER;
156 arg.integer.value = 1;
161 status = acpi_evaluate_object(handle, "_EJ0", &arg_list, NULL);
162 if (ACPI_FAILURE(status)) {
163 if (status != AE_NOT_FOUND)
164 printk(KERN_WARNING PREFIX
165 "Eject device failed\n");
173 /* Inform firmware the hot-remove operation has completed w/ error */
174 (void) acpi_evaluate_hotplug_ost(handle,
175 ej_event->event, ost_code, NULL);
179 EXPORT_SYMBOL(acpi_bus_hot_remove_device);
182 acpi_eject_store(struct device *d, struct device_attribute *attr,
183 const char *buf, size_t count)
187 acpi_object_type type = 0;
188 struct acpi_device *acpi_device = to_acpi_device(d);
189 struct acpi_eject_event *ej_event;
191 if ((!count) || (buf[0] != '1')) {
195 if (acpi_device->driver == NULL) {
200 status = acpi_get_type(acpi_device->handle, &type);
201 if (ACPI_FAILURE(status) || (!acpi_device->flags.ejectable)) {
206 ej_event = kmalloc(sizeof(*ej_event), GFP_KERNEL);
212 ej_event->device = acpi_device;
213 if (acpi_device->flags.eject_pending) {
214 /* event originated from ACPI eject notification */
215 ej_event->event = ACPI_NOTIFY_EJECT_REQUEST;
216 acpi_device->flags.eject_pending = 0;
218 /* event originated from user */
219 ej_event->event = ACPI_OST_EC_OSPM_EJECT;
220 (void) acpi_evaluate_hotplug_ost(acpi_device->handle,
221 ej_event->event, ACPI_OST_SC_EJECT_IN_PROGRESS, NULL);
224 acpi_os_hotplug_execute(acpi_bus_hot_remove_device, (void *)ej_event);
229 static DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store);
232 acpi_device_hid_show(struct device *dev, struct device_attribute *attr, char *buf) {
233 struct acpi_device *acpi_dev = to_acpi_device(dev);
235 return sprintf(buf, "%s\n", acpi_device_hid(acpi_dev));
237 static DEVICE_ATTR(hid, 0444, acpi_device_hid_show, NULL);
239 static ssize_t acpi_device_uid_show(struct device *dev,
240 struct device_attribute *attr, char *buf)
242 struct acpi_device *acpi_dev = to_acpi_device(dev);
244 return sprintf(buf, "%s\n", acpi_dev->pnp.unique_id);
246 static DEVICE_ATTR(uid, 0444, acpi_device_uid_show, NULL);
248 static ssize_t acpi_device_adr_show(struct device *dev,
249 struct device_attribute *attr, char *buf)
251 struct acpi_device *acpi_dev = to_acpi_device(dev);
253 return sprintf(buf, "0x%08x\n",
254 (unsigned int)(acpi_dev->pnp.bus_address));
256 static DEVICE_ATTR(adr, 0444, acpi_device_adr_show, NULL);
259 acpi_device_path_show(struct device *dev, struct device_attribute *attr, char *buf) {
260 struct acpi_device *acpi_dev = to_acpi_device(dev);
261 struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
264 result = acpi_get_name(acpi_dev->handle, ACPI_FULL_PATHNAME, &path);
268 result = sprintf(buf, "%s\n", (char*)path.pointer);
273 static DEVICE_ATTR(path, 0444, acpi_device_path_show, NULL);
275 /* sysfs file that shows description text from the ACPI _STR method */
276 static ssize_t description_show(struct device *dev,
277 struct device_attribute *attr,
279 struct acpi_device *acpi_dev = to_acpi_device(dev);
282 if (acpi_dev->pnp.str_obj == NULL)
286 * The _STR object contains a Unicode identifier for a device.
287 * We need to convert to utf-8 so it can be displayed.
289 result = utf16s_to_utf8s(
290 (wchar_t *)acpi_dev->pnp.str_obj->buffer.pointer,
291 acpi_dev->pnp.str_obj->buffer.length,
292 UTF16_LITTLE_ENDIAN, buf,
295 buf[result++] = '\n';
299 static DEVICE_ATTR(description, 0444, description_show, NULL);
302 acpi_device_sun_show(struct device *dev, struct device_attribute *attr,
304 struct acpi_device *acpi_dev = to_acpi_device(dev);
306 return sprintf(buf, "%lu\n", acpi_dev->pnp.sun);
308 static DEVICE_ATTR(sun, 0444, acpi_device_sun_show, NULL);
310 static int acpi_device_setup_files(struct acpi_device *dev)
312 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
315 unsigned long long sun;
319 * Devices gotten from FADT don't have a "path" attribute
322 result = device_create_file(&dev->dev, &dev_attr_path);
327 if (!list_empty(&dev->pnp.ids)) {
328 result = device_create_file(&dev->dev, &dev_attr_hid);
332 result = device_create_file(&dev->dev, &dev_attr_modalias);
338 * If device has _STR, 'description' file is created
340 status = acpi_get_handle(dev->handle, "_STR", &temp);
341 if (ACPI_SUCCESS(status)) {
342 status = acpi_evaluate_object(dev->handle, "_STR",
344 if (ACPI_FAILURE(status))
345 buffer.pointer = NULL;
346 dev->pnp.str_obj = buffer.pointer;
347 result = device_create_file(&dev->dev, &dev_attr_description);
352 if (dev->flags.bus_address)
353 result = device_create_file(&dev->dev, &dev_attr_adr);
354 if (dev->pnp.unique_id)
355 result = device_create_file(&dev->dev, &dev_attr_uid);
357 status = acpi_evaluate_integer(dev->handle, "_SUN", NULL, &sun);
358 if (ACPI_SUCCESS(status)) {
359 dev->pnp.sun = (unsigned long)sun;
360 result = device_create_file(&dev->dev, &dev_attr_sun);
364 dev->pnp.sun = (unsigned long)-1;
368 * If device has _EJ0, 'eject' file is created that is used to trigger
369 * hot-removal function from userland.
371 status = acpi_get_handle(dev->handle, "_EJ0", &temp);
372 if (ACPI_SUCCESS(status))
373 result = device_create_file(&dev->dev, &dev_attr_eject);
378 static void acpi_device_remove_files(struct acpi_device *dev)
384 * If device has _STR, remove 'description' file
386 status = acpi_get_handle(dev->handle, "_STR", &temp);
387 if (ACPI_SUCCESS(status)) {
388 kfree(dev->pnp.str_obj);
389 device_remove_file(&dev->dev, &dev_attr_description);
392 * If device has _EJ0, remove 'eject' file.
394 status = acpi_get_handle(dev->handle, "_EJ0", &temp);
395 if (ACPI_SUCCESS(status))
396 device_remove_file(&dev->dev, &dev_attr_eject);
398 status = acpi_get_handle(dev->handle, "_SUN", &temp);
399 if (ACPI_SUCCESS(status))
400 device_remove_file(&dev->dev, &dev_attr_sun);
402 if (dev->pnp.unique_id)
403 device_remove_file(&dev->dev, &dev_attr_uid);
404 if (dev->flags.bus_address)
405 device_remove_file(&dev->dev, &dev_attr_adr);
406 device_remove_file(&dev->dev, &dev_attr_modalias);
407 device_remove_file(&dev->dev, &dev_attr_hid);
409 device_remove_file(&dev->dev, &dev_attr_path);
411 /* --------------------------------------------------------------------------
413 -------------------------------------------------------------------------- */
415 static const struct acpi_device_id *__acpi_match_device(
416 struct acpi_device *device, const struct acpi_device_id *ids)
418 const struct acpi_device_id *id;
419 struct acpi_hardware_id *hwid;
422 * If the device is not present, it is unnecessary to load device
425 if (!device->status.present)
428 for (id = ids; id->id[0]; id++)
429 list_for_each_entry(hwid, &device->pnp.ids, list)
430 if (!strcmp((char *) id->id, hwid->id))
437 * acpi_match_device - Match a struct device against a given list of ACPI IDs
438 * @ids: Array of struct acpi_device_id object to match against.
439 * @dev: The device structure to match.
441 * Check if @dev has a valid ACPI handle and if there is a struct acpi_device
442 * object for that handle and use that object to match against a given list of
445 * Return a pointer to the first matching ID on success or %NULL on failure.
447 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
448 const struct device *dev)
450 struct acpi_device *adev;
452 if (!ids || !ACPI_HANDLE(dev)
453 || ACPI_FAILURE(acpi_bus_get_device(ACPI_HANDLE(dev), &adev)))
456 return __acpi_match_device(adev, ids);
458 EXPORT_SYMBOL_GPL(acpi_match_device);
460 int acpi_match_device_ids(struct acpi_device *device,
461 const struct acpi_device_id *ids)
463 return __acpi_match_device(device, ids) ? 0 : -ENOENT;
465 EXPORT_SYMBOL(acpi_match_device_ids);
467 void acpi_free_ids(struct acpi_device *device)
469 struct acpi_hardware_id *id, *tmp;
471 list_for_each_entry_safe(id, tmp, &device->pnp.ids, list) {
475 kfree(device->pnp.unique_id);
478 static void acpi_free_power_resources_lists(struct acpi_device *device)
482 if (device->wakeup.flags.valid)
483 acpi_power_resources_list_free(&device->wakeup.resources);
485 if (!device->flags.power_manageable)
488 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
489 struct acpi_device_power_state *ps = &device->power.states[i];
490 acpi_power_resources_list_free(&ps->resources);
494 static void acpi_device_release(struct device *dev)
496 struct acpi_device *acpi_dev = to_acpi_device(dev);
498 acpi_free_ids(acpi_dev);
499 acpi_free_power_resources_lists(acpi_dev);
503 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
505 struct acpi_device *acpi_dev = to_acpi_device(dev);
506 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
508 return acpi_dev->flags.match_driver
509 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
512 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
514 struct acpi_device *acpi_dev = to_acpi_device(dev);
517 if (list_empty(&acpi_dev->pnp.ids))
520 if (add_uevent_var(env, "MODALIAS="))
522 len = create_modalias(acpi_dev, &env->buf[env->buflen - 1],
523 sizeof(env->buf) - env->buflen);
524 if (len >= (sizeof(env->buf) - env->buflen))
530 static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
532 struct acpi_device *device = data;
534 device->driver->ops.notify(device, event);
537 static acpi_status acpi_device_notify_fixed(void *data)
539 struct acpi_device *device = data;
541 /* Fixed hardware devices have no handles */
542 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
546 static int acpi_device_install_notify_handler(struct acpi_device *device)
550 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
552 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
553 acpi_device_notify_fixed,
555 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
557 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
558 acpi_device_notify_fixed,
561 status = acpi_install_notify_handler(device->handle,
566 if (ACPI_FAILURE(status))
571 static void acpi_device_remove_notify_handler(struct acpi_device *device)
573 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
574 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
575 acpi_device_notify_fixed);
576 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
577 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
578 acpi_device_notify_fixed);
580 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
584 static int acpi_bus_driver_init(struct acpi_device *, struct acpi_driver *);
585 static int acpi_device_probe(struct device * dev)
587 struct acpi_device *acpi_dev = to_acpi_device(dev);
588 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
591 ret = acpi_bus_driver_init(acpi_dev, acpi_drv);
593 if (acpi_drv->ops.notify) {
594 ret = acpi_device_install_notify_handler(acpi_dev);
596 if (acpi_drv->ops.remove)
597 acpi_drv->ops.remove(acpi_dev,
598 acpi_dev->removal_type);
603 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
604 "Found driver [%s] for device [%s]\n",
605 acpi_drv->name, acpi_dev->pnp.bus_id));
611 static int acpi_device_remove(struct device * dev)
613 struct acpi_device *acpi_dev = to_acpi_device(dev);
614 struct acpi_driver *acpi_drv = acpi_dev->driver;
617 if (acpi_drv->ops.notify)
618 acpi_device_remove_notify_handler(acpi_dev);
619 if (acpi_drv->ops.remove)
620 acpi_drv->ops.remove(acpi_dev, acpi_dev->removal_type);
622 acpi_dev->driver = NULL;
623 acpi_dev->driver_data = NULL;
629 struct bus_type acpi_bus_type = {
631 .match = acpi_bus_match,
632 .probe = acpi_device_probe,
633 .remove = acpi_device_remove,
634 .uevent = acpi_device_uevent,
637 int acpi_device_register(struct acpi_device *device,
638 void (*release)(struct device *))
641 struct acpi_device_bus_id *acpi_device_bus_id, *new_bus_id;
644 if (device->handle) {
647 status = acpi_attach_data(device->handle, acpi_bus_data_handler,
649 if (ACPI_FAILURE(status)) {
650 acpi_handle_err(device->handle,
651 "Unable to attach device data\n");
659 * Link this device to its parent and siblings.
661 INIT_LIST_HEAD(&device->children);
662 INIT_LIST_HEAD(&device->node);
663 INIT_LIST_HEAD(&device->wakeup_list);
664 INIT_LIST_HEAD(&device->physical_node_list);
665 mutex_init(&device->physical_node_lock);
666 INIT_LIST_HEAD(&device->power_dependent);
668 new_bus_id = kzalloc(sizeof(struct acpi_device_bus_id), GFP_KERNEL);
670 pr_err(PREFIX "Memory allocation error\n");
675 mutex_lock(&acpi_device_lock);
677 * Find suitable bus_id and instance number in acpi_bus_id_list
678 * If failed, create one and link it into acpi_bus_id_list
680 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
681 if (!strcmp(acpi_device_bus_id->bus_id,
682 acpi_device_hid(device))) {
683 acpi_device_bus_id->instance_no++;
690 acpi_device_bus_id = new_bus_id;
691 strcpy(acpi_device_bus_id->bus_id, acpi_device_hid(device));
692 acpi_device_bus_id->instance_no = 0;
693 list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
695 dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, acpi_device_bus_id->instance_no);
698 list_add_tail(&device->node, &device->parent->children);
700 if (device->wakeup.flags.valid)
701 list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);
702 mutex_unlock(&acpi_device_lock);
705 device->dev.parent = &device->parent->dev;
706 device->dev.bus = &acpi_bus_type;
707 device->dev.release = release;
708 result = device_register(&device->dev);
710 dev_err(&device->dev, "Error registering device\n");
714 result = acpi_device_setup_files(device);
716 printk(KERN_ERR PREFIX "Error creating sysfs interface for device %s\n",
717 dev_name(&device->dev));
719 device->removal_type = ACPI_BUS_REMOVAL_NORMAL;
723 mutex_lock(&acpi_device_lock);
725 list_del(&device->node);
726 list_del(&device->wakeup_list);
727 mutex_unlock(&acpi_device_lock);
730 acpi_detach_data(device->handle, acpi_bus_data_handler);
734 static void acpi_device_unregister(struct acpi_device *device)
736 mutex_lock(&acpi_device_lock);
738 list_del(&device->node);
740 list_del(&device->wakeup_list);
741 mutex_unlock(&acpi_device_lock);
743 acpi_detach_data(device->handle, acpi_bus_data_handler);
745 acpi_power_add_remove_device(device, false);
746 acpi_device_remove_files(device);
747 device_unregister(&device->dev);
749 * Drop the reference counts of all power resources the device depends
750 * on and turn off the ones that have no more references.
752 acpi_power_transition(device, ACPI_STATE_D3_COLD);
755 /* --------------------------------------------------------------------------
757 -------------------------------------------------------------------------- */
759 * acpi_bus_driver_init - add a device to a driver
760 * @device: the device to add and initialize
761 * @driver: driver for the device
763 * Used to initialize a device via its device driver. Called whenever a
764 * driver is bound to a device. Invokes the driver's add() ops.
767 acpi_bus_driver_init(struct acpi_device *device, struct acpi_driver *driver)
771 if (!device || !driver)
774 if (!driver->ops.add)
777 result = driver->ops.add(device);
779 device->driver = NULL;
780 device->driver_data = NULL;
784 device->driver = driver;
787 * TBD - Configuration Management: Assign resources to device based
788 * upon possible configuration and currently allocated resources.
791 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
792 "Driver successfully bound to device\n"));
797 * acpi_bus_register_driver - register a driver with the ACPI bus
798 * @driver: driver being registered
800 * Registers a driver with the ACPI bus. Searches the namespace for all
801 * devices that match the driver's criteria and binds. Returns zero for
802 * success or a negative error status for failure.
804 int acpi_bus_register_driver(struct acpi_driver *driver)
810 driver->drv.name = driver->name;
811 driver->drv.bus = &acpi_bus_type;
812 driver->drv.owner = driver->owner;
814 ret = driver_register(&driver->drv);
818 EXPORT_SYMBOL(acpi_bus_register_driver);
821 * acpi_bus_unregister_driver - unregisters a driver with the APIC bus
822 * @driver: driver to unregister
824 * Unregisters a driver with the ACPI bus. Searches the namespace for all
825 * devices that match the driver's criteria and unbinds.
827 void acpi_bus_unregister_driver(struct acpi_driver *driver)
829 driver_unregister(&driver->drv);
832 EXPORT_SYMBOL(acpi_bus_unregister_driver);
834 /* --------------------------------------------------------------------------
836 -------------------------------------------------------------------------- */
837 static struct acpi_device *acpi_bus_get_parent(acpi_handle handle)
841 struct acpi_device *device;
844 * Fixed hardware devices do not appear in the namespace and do not
845 * have handles, but we fabricate acpi_devices for them, so we have
846 * to deal with them specially.
852 status = acpi_get_parent(handle, &handle);
853 if (status == AE_NULL_ENTRY)
855 if (ACPI_FAILURE(status))
858 ret = acpi_bus_get_device(handle, &device);
865 acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
869 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
870 union acpi_object *obj;
872 status = acpi_get_handle(handle, "_EJD", &tmp);
873 if (ACPI_FAILURE(status))
876 status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
877 if (ACPI_SUCCESS(status)) {
878 obj = buffer.pointer;
879 status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
881 kfree(buffer.pointer);
885 EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);
887 void acpi_bus_data_handler(acpi_handle handle, void *context)
896 acpi_bus_extract_wakeup_device_power_package(acpi_handle handle,
897 struct acpi_device_wakeup *wakeup)
899 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
900 union acpi_object *package = NULL;
901 union acpi_object *element = NULL;
905 return AE_BAD_PARAMETER;
907 INIT_LIST_HEAD(&wakeup->resources);
910 status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
911 if (ACPI_FAILURE(status)) {
912 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRW"));
916 package = (union acpi_object *)buffer.pointer;
918 if (!package || (package->package.count < 2)) {
919 status = AE_BAD_DATA;
923 element = &(package->package.elements[0]);
925 status = AE_BAD_DATA;
928 if (element->type == ACPI_TYPE_PACKAGE) {
929 if ((element->package.count < 2) ||
930 (element->package.elements[0].type !=
931 ACPI_TYPE_LOCAL_REFERENCE)
932 || (element->package.elements[1].type != ACPI_TYPE_INTEGER)) {
933 status = AE_BAD_DATA;
937 element->package.elements[0].reference.handle;
939 (u32) element->package.elements[1].integer.value;
940 } else if (element->type == ACPI_TYPE_INTEGER) {
941 wakeup->gpe_device = NULL;
942 wakeup->gpe_number = element->integer.value;
944 status = AE_BAD_DATA;
948 element = &(package->package.elements[1]);
949 if (element->type != ACPI_TYPE_INTEGER) {
950 status = AE_BAD_DATA;
953 wakeup->sleep_state = element->integer.value;
955 status = acpi_extract_power_resources(package, 2, &wakeup->resources);
956 if (ACPI_FAILURE(status))
959 acpi_setup_gpe_for_wake(handle, wakeup->gpe_device, wakeup->gpe_number);
962 kfree(buffer.pointer);
967 static void acpi_bus_set_run_wake_flags(struct acpi_device *device)
969 struct acpi_device_id button_device_ids[] = {
976 acpi_event_status event_status;
978 device->wakeup.flags.notifier_present = 0;
980 /* Power button, Lid switch always enable wakeup */
981 if (!acpi_match_device_ids(device, button_device_ids)) {
982 device->wakeup.flags.run_wake = 1;
983 if (!acpi_match_device_ids(device, &button_device_ids[1])) {
984 /* Do not use Lid/sleep button for S5 wakeup */
985 if (device->wakeup.sleep_state == ACPI_STATE_S5)
986 device->wakeup.sleep_state = ACPI_STATE_S4;
988 device_set_wakeup_capable(&device->dev, true);
992 status = acpi_get_gpe_status(device->wakeup.gpe_device,
993 device->wakeup.gpe_number,
996 device->wakeup.flags.run_wake =
997 !!(event_status & ACPI_EVENT_FLAG_HANDLE);
1000 static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
1003 acpi_status status = 0;
1006 /* Presence of _PRW indicates wake capable */
1007 status = acpi_get_handle(device->handle, "_PRW", &temp);
1008 if (ACPI_FAILURE(status))
1011 status = acpi_bus_extract_wakeup_device_power_package(device->handle,
1013 if (ACPI_FAILURE(status)) {
1014 ACPI_EXCEPTION((AE_INFO, status, "Extracting _PRW package"));
1018 device->wakeup.flags.valid = 1;
1019 device->wakeup.prepare_count = 0;
1020 acpi_bus_set_run_wake_flags(device);
1021 /* Call _PSW/_DSW object to disable its ability to wake the sleeping
1022 * system for the ACPI device with the _PRW object.
1023 * The _PSW object is depreciated in ACPI 3.0 and is replaced by _DSW.
1024 * So it is necessary to call _DSW object first. Only when it is not
1025 * present will the _PSW object used.
1027 psw_error = acpi_device_sleep_wake(device, 0, 0, 0);
1029 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1030 "error in _DSW or _PSW evaluation\n"));
1033 static void acpi_bus_init_power_state(struct acpi_device *device, int state)
1035 struct acpi_device_power_state *ps = &device->power.states[state];
1036 char pathname[5] = { '_', 'P', 'R', '0' + state, '\0' };
1037 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1041 INIT_LIST_HEAD(&ps->resources);
1043 /* Evaluate "_PRx" to get referenced power resources */
1044 status = acpi_evaluate_object(device->handle, pathname, NULL, &buffer);
1045 if (ACPI_SUCCESS(status)) {
1046 union acpi_object *package = buffer.pointer;
1048 if (buffer.length && package
1049 && package->type == ACPI_TYPE_PACKAGE
1050 && package->package.count) {
1051 status = acpi_extract_power_resources(package, 0,
1053 if (ACPI_SUCCESS(status))
1054 device->power.flags.power_resources = 1;
1056 ACPI_FREE(buffer.pointer);
1059 /* Evaluate "_PSx" to see if we can do explicit sets */
1061 status = acpi_get_handle(device->handle, pathname, &handle);
1062 if (ACPI_SUCCESS(status))
1063 ps->flags.explicit_set = 1;
1066 * State is valid if there are means to put the device into it.
1067 * D3hot is only valid if _PR3 present.
1069 if (!list_empty(&ps->resources)
1070 || (ps->flags.explicit_set && state < ACPI_STATE_D3_HOT)) {
1071 ps->flags.valid = 1;
1072 ps->flags.os_accessible = 1;
1075 ps->power = -1; /* Unknown - driver assigned */
1076 ps->latency = -1; /* Unknown - driver assigned */
1079 static void acpi_bus_get_power_flags(struct acpi_device *device)
1085 /* Presence of _PS0|_PR0 indicates 'power manageable' */
1086 status = acpi_get_handle(device->handle, "_PS0", &handle);
1087 if (ACPI_FAILURE(status)) {
1088 status = acpi_get_handle(device->handle, "_PR0", &handle);
1089 if (ACPI_FAILURE(status))
1093 device->flags.power_manageable = 1;
1096 * Power Management Flags
1098 status = acpi_get_handle(device->handle, "_PSC", &handle);
1099 if (ACPI_SUCCESS(status))
1100 device->power.flags.explicit_get = 1;
1101 status = acpi_get_handle(device->handle, "_IRC", &handle);
1102 if (ACPI_SUCCESS(status))
1103 device->power.flags.inrush_current = 1;
1106 * Enumerate supported power management states
1108 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++)
1109 acpi_bus_init_power_state(device, i);
1111 INIT_LIST_HEAD(&device->power.states[ACPI_STATE_D3_COLD].resources);
1113 /* Set defaults for D0 and D3 states (always valid) */
1114 device->power.states[ACPI_STATE_D0].flags.valid = 1;
1115 device->power.states[ACPI_STATE_D0].power = 100;
1116 device->power.states[ACPI_STATE_D3].flags.valid = 1;
1117 device->power.states[ACPI_STATE_D3].power = 0;
1119 /* Set D3cold's explicit_set flag if _PS3 exists. */
1120 if (device->power.states[ACPI_STATE_D3_HOT].flags.explicit_set)
1121 device->power.states[ACPI_STATE_D3_COLD].flags.explicit_set = 1;
1123 /* Presence of _PS3 or _PRx means we can put the device into D3 cold */
1124 if (device->power.states[ACPI_STATE_D3_HOT].flags.explicit_set ||
1125 device->power.flags.power_resources)
1126 device->power.states[ACPI_STATE_D3_COLD].flags.os_accessible = 1;
1128 acpi_bus_init_power(device);
1131 static void acpi_bus_get_flags(struct acpi_device *device)
1133 acpi_status status = AE_OK;
1134 acpi_handle temp = NULL;
1136 /* Presence of _STA indicates 'dynamic_status' */
1137 status = acpi_get_handle(device->handle, "_STA", &temp);
1138 if (ACPI_SUCCESS(status))
1139 device->flags.dynamic_status = 1;
1141 /* Presence of _RMV indicates 'removable' */
1142 status = acpi_get_handle(device->handle, "_RMV", &temp);
1143 if (ACPI_SUCCESS(status))
1144 device->flags.removable = 1;
1146 /* Presence of _EJD|_EJ0 indicates 'ejectable' */
1147 status = acpi_get_handle(device->handle, "_EJD", &temp);
1148 if (ACPI_SUCCESS(status))
1149 device->flags.ejectable = 1;
1151 status = acpi_get_handle(device->handle, "_EJ0", &temp);
1152 if (ACPI_SUCCESS(status))
1153 device->flags.ejectable = 1;
1157 static void acpi_device_get_busid(struct acpi_device *device)
1159 char bus_id[5] = { '?', 0 };
1160 struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
1166 * The device's Bus ID is simply the object name.
1167 * TBD: Shouldn't this value be unique (within the ACPI namespace)?
1169 if (ACPI_IS_ROOT_DEVICE(device)) {
1170 strcpy(device->pnp.bus_id, "ACPI");
1174 switch (device->device_type) {
1175 case ACPI_BUS_TYPE_POWER_BUTTON:
1176 strcpy(device->pnp.bus_id, "PWRF");
1178 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1179 strcpy(device->pnp.bus_id, "SLPF");
1182 acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
1183 /* Clean up trailing underscores (if any) */
1184 for (i = 3; i > 1; i--) {
1185 if (bus_id[i] == '_')
1190 strcpy(device->pnp.bus_id, bus_id);
1196 * acpi_bay_match - see if a device is an ejectable driver bay
1198 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
1199 * then we can safely call it an ejectable drive bay
1201 static int acpi_bay_match(struct acpi_device *device){
1205 acpi_handle phandle;
1207 handle = device->handle;
1209 status = acpi_get_handle(handle, "_EJ0", &tmp);
1210 if (ACPI_FAILURE(status))
1213 if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) ||
1214 (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) ||
1215 (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) ||
1216 (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp))))
1219 if (acpi_get_parent(handle, &phandle))
1222 if ((ACPI_SUCCESS(acpi_get_handle(phandle, "_GTF", &tmp))) ||
1223 (ACPI_SUCCESS(acpi_get_handle(phandle, "_GTM", &tmp))) ||
1224 (ACPI_SUCCESS(acpi_get_handle(phandle, "_STM", &tmp))) ||
1225 (ACPI_SUCCESS(acpi_get_handle(phandle, "_SDD", &tmp))))
1232 * acpi_dock_match - see if a device has a _DCK method
1234 static int acpi_dock_match(struct acpi_device *device)
1237 return acpi_get_handle(device->handle, "_DCK", &tmp);
1240 const char *acpi_device_hid(struct acpi_device *device)
1242 struct acpi_hardware_id *hid;
1244 if (list_empty(&device->pnp.ids))
1247 hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
1250 EXPORT_SYMBOL(acpi_device_hid);
1252 static void acpi_add_id(struct acpi_device *device, const char *dev_id)
1254 struct acpi_hardware_id *id;
1256 id = kmalloc(sizeof(*id), GFP_KERNEL);
1260 id->id = kstrdup(dev_id, GFP_KERNEL);
1266 list_add_tail(&id->list, &device->pnp.ids);
1270 * Old IBM workstations have a DSDT bug wherein the SMBus object
1271 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
1272 * prefix. Work around this.
1274 static int acpi_ibm_smbus_match(struct acpi_device *device)
1276 acpi_handle h_dummy;
1277 struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
1280 if (!dmi_name_in_vendors("IBM"))
1283 /* Look for SMBS object */
1284 result = acpi_get_name(device->handle, ACPI_SINGLE_NAME, &path);
1288 if (strcmp("SMBS", path.pointer)) {
1293 /* Does it have the necessary (but misnamed) methods? */
1295 if (ACPI_SUCCESS(acpi_get_handle(device->handle, "SBI", &h_dummy)) &&
1296 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBR", &h_dummy)) &&
1297 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBW", &h_dummy)))
1300 kfree(path.pointer);
1304 static void acpi_device_set_id(struct acpi_device *device)
1307 struct acpi_device_info *info;
1308 struct acpi_pnp_device_id_list *cid_list;
1311 switch (device->device_type) {
1312 case ACPI_BUS_TYPE_DEVICE:
1313 if (ACPI_IS_ROOT_DEVICE(device)) {
1314 acpi_add_id(device, ACPI_SYSTEM_HID);
1318 status = acpi_get_object_info(device->handle, &info);
1319 if (ACPI_FAILURE(status)) {
1320 printk(KERN_ERR PREFIX "%s: Error reading device info\n", __func__);
1324 if (info->valid & ACPI_VALID_HID)
1325 acpi_add_id(device, info->hardware_id.string);
1326 if (info->valid & ACPI_VALID_CID) {
1327 cid_list = &info->compatible_id_list;
1328 for (i = 0; i < cid_list->count; i++)
1329 acpi_add_id(device, cid_list->ids[i].string);
1331 if (info->valid & ACPI_VALID_ADR) {
1332 device->pnp.bus_address = info->address;
1333 device->flags.bus_address = 1;
1335 if (info->valid & ACPI_VALID_UID)
1336 device->pnp.unique_id = kstrdup(info->unique_id.string,
1342 * Some devices don't reliably have _HIDs & _CIDs, so add
1343 * synthetic HIDs to make sure drivers can find them.
1345 if (acpi_is_video_device(device))
1346 acpi_add_id(device, ACPI_VIDEO_HID);
1347 else if (ACPI_SUCCESS(acpi_bay_match(device)))
1348 acpi_add_id(device, ACPI_BAY_HID);
1349 else if (ACPI_SUCCESS(acpi_dock_match(device)))
1350 acpi_add_id(device, ACPI_DOCK_HID);
1351 else if (!acpi_ibm_smbus_match(device))
1352 acpi_add_id(device, ACPI_SMBUS_IBM_HID);
1353 else if (list_empty(&device->pnp.ids) &&
1354 ACPI_IS_ROOT_DEVICE(device->parent)) {
1355 acpi_add_id(device, ACPI_BUS_HID); /* \_SB, LNXSYBUS */
1356 strcpy(device->pnp.device_name, ACPI_BUS_DEVICE_NAME);
1357 strcpy(device->pnp.device_class, ACPI_BUS_CLASS);
1361 case ACPI_BUS_TYPE_POWER:
1362 acpi_add_id(device, ACPI_POWER_HID);
1364 case ACPI_BUS_TYPE_PROCESSOR:
1365 acpi_add_id(device, ACPI_PROCESSOR_OBJECT_HID);
1367 case ACPI_BUS_TYPE_THERMAL:
1368 acpi_add_id(device, ACPI_THERMAL_HID);
1370 case ACPI_BUS_TYPE_POWER_BUTTON:
1371 acpi_add_id(device, ACPI_BUTTON_HID_POWERF);
1373 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1374 acpi_add_id(device, ACPI_BUTTON_HID_SLEEPF);
1379 void acpi_init_device_object(struct acpi_device *device, acpi_handle handle,
1380 int type, unsigned long long sta)
1382 INIT_LIST_HEAD(&device->pnp.ids);
1383 device->device_type = type;
1384 device->handle = handle;
1385 device->parent = acpi_bus_get_parent(handle);
1386 STRUCT_TO_INT(device->status) = sta;
1387 acpi_device_get_busid(device);
1388 acpi_device_set_id(device);
1389 acpi_bus_get_flags(device);
1392 static int acpi_add_single_object(struct acpi_device **child,
1393 acpi_handle handle, int type,
1394 unsigned long long sta, bool match_driver)
1397 struct acpi_device *device;
1398 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1400 device = kzalloc(sizeof(struct acpi_device), GFP_KERNEL);
1402 printk(KERN_ERR PREFIX "Memory allocation error\n");
1406 acpi_init_device_object(device, handle, type, sta);
1407 acpi_bus_get_power_flags(device);
1408 acpi_bus_get_wakeup_device_flags(device);
1410 device->flags.match_driver = match_driver;
1411 result = acpi_device_register(device, acpi_device_release);
1413 acpi_device_release(&device->dev);
1417 acpi_power_add_remove_device(device, true);
1418 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1419 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Added %s [%s] parent %s\n",
1420 dev_name(&device->dev), (char *) buffer.pointer,
1421 device->parent ? dev_name(&device->parent->dev) : "(null)"));
1422 kfree(buffer.pointer);
1427 static int acpi_bus_type_and_status(acpi_handle handle, int *type,
1428 unsigned long long *sta)
1431 acpi_object_type acpi_type;
1433 status = acpi_get_type(handle, &acpi_type);
1434 if (ACPI_FAILURE(status))
1437 switch (acpi_type) {
1438 case ACPI_TYPE_ANY: /* for ACPI_ROOT_OBJECT */
1439 case ACPI_TYPE_DEVICE:
1440 *type = ACPI_BUS_TYPE_DEVICE;
1441 status = acpi_bus_get_status_handle(handle, sta);
1442 if (ACPI_FAILURE(status))
1445 case ACPI_TYPE_PROCESSOR:
1446 *type = ACPI_BUS_TYPE_PROCESSOR;
1447 status = acpi_bus_get_status_handle(handle, sta);
1448 if (ACPI_FAILURE(status))
1451 case ACPI_TYPE_THERMAL:
1452 *type = ACPI_BUS_TYPE_THERMAL;
1453 *sta = ACPI_STA_DEFAULT;
1455 case ACPI_TYPE_POWER:
1456 *type = ACPI_BUS_TYPE_POWER;
1457 *sta = ACPI_STA_DEFAULT;
1466 static acpi_status acpi_bus_check_add(acpi_handle handle, u32 lvl_not_used,
1467 void *not_used, void **return_value)
1469 struct acpi_device *device = NULL;
1471 unsigned long long sta;
1475 acpi_bus_get_device(handle, &device);
1479 result = acpi_bus_type_and_status(handle, &type, &sta);
1483 if (type == ACPI_BUS_TYPE_POWER) {
1484 acpi_add_power_resource(handle);
1488 if (!(sta & ACPI_STA_DEVICE_PRESENT) &&
1489 !(sta & ACPI_STA_DEVICE_FUNCTIONING)) {
1490 struct acpi_device_wakeup wakeup;
1493 status = acpi_get_handle(handle, "_PRW", &temp);
1494 if (ACPI_SUCCESS(status)) {
1495 acpi_bus_extract_wakeup_device_power_package(handle,
1497 acpi_power_resources_list_free(&wakeup.resources);
1499 return AE_CTRL_DEPTH;
1502 acpi_add_single_object(&device, handle, type, sta, false);
1504 return AE_CTRL_DEPTH;
1506 device->flags.match_driver = true;
1510 *return_value = device;
1515 static acpi_status acpi_bus_device_attach(acpi_handle handle, u32 lvl_not_used,
1516 void *not_used, void **ret_not_used)
1518 acpi_status status = AE_OK;
1519 struct acpi_device *device;
1520 unsigned long long sta_not_used;
1524 * Ignore errors ignored by acpi_bus_check_add() to avoid terminating
1525 * namespace walks prematurely.
1527 if (acpi_bus_type_and_status(handle, &type_not_used, &sta_not_used))
1530 if (acpi_bus_get_device(handle, &device))
1531 return AE_CTRL_DEPTH;
1533 if (!acpi_match_device_ids(device, acpi_platform_device_ids)) {
1534 /* This is a known good platform device. */
1535 acpi_create_platform_device(device);
1536 } else if (device_attach(&device->dev) < 0) {
1537 status = AE_CTRL_DEPTH;
1542 static int acpi_bus_scan(acpi_handle handle)
1544 void *device = NULL;
1546 if (ACPI_SUCCESS(acpi_bus_check_add(handle, 0, NULL, &device)))
1547 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
1548 acpi_bus_check_add, NULL, NULL, &device);
1553 if (ACPI_SUCCESS(acpi_bus_device_attach(handle, 0, NULL, NULL)))
1554 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
1555 acpi_bus_device_attach, NULL, NULL, NULL);
1561 * acpi_bus_add - Add ACPI device node objects in a given namespace scope.
1562 * @handle: Root of the namespace scope to scan.
1564 * Scan a given ACPI tree (probably recently hot-plugged) and create and add
1567 * If no devices were found, -ENODEV is returned, but it does not mean that
1568 * there has been a real error. There just have been no suitable ACPI objects
1569 * in the table trunk from which the kernel could create a device and add an
1570 * appropriate driver.
1572 int acpi_bus_add(acpi_handle handle)
1576 err = acpi_bus_scan(handle);
1580 acpi_update_all_gpes();
1583 EXPORT_SYMBOL(acpi_bus_add);
1585 static acpi_status acpi_bus_device_detach(acpi_handle handle, u32 lvl_not_used,
1586 void *not_used, void **ret_not_used)
1588 struct acpi_device *device = NULL;
1590 if (!acpi_bus_get_device(handle, &device)) {
1591 device->removal_type = ACPI_BUS_REMOVAL_EJECT;
1592 device_release_driver(&device->dev);
1597 static acpi_status acpi_bus_remove(acpi_handle handle, u32 lvl_not_used,
1598 void *not_used, void **ret_not_used)
1600 struct acpi_device *device = NULL;
1602 if (!acpi_bus_get_device(handle, &device))
1603 acpi_device_unregister(device);
1608 int acpi_bus_trim(struct acpi_device *start)
1611 * Execute acpi_bus_device_detach() as a post-order callback to detach
1612 * all ACPI drivers from the device nodes being removed.
1614 acpi_walk_namespace(ACPI_TYPE_ANY, start->handle, ACPI_UINT32_MAX, NULL,
1615 acpi_bus_device_detach, NULL, NULL);
1616 acpi_bus_device_detach(start->handle, 0, NULL, NULL);
1618 * Execute acpi_bus_remove() as a post-order callback to remove device
1619 * nodes in the given namespace scope.
1621 acpi_walk_namespace(ACPI_TYPE_ANY, start->handle, ACPI_UINT32_MAX, NULL,
1622 acpi_bus_remove, NULL, NULL);
1623 acpi_bus_remove(start->handle, 0, NULL, NULL);
1626 EXPORT_SYMBOL_GPL(acpi_bus_trim);
1628 static int acpi_bus_scan_fixed(void)
1631 struct acpi_device *device = NULL;
1634 * Enumerate all fixed-feature devices.
1636 if ((acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON) == 0) {
1637 result = acpi_add_single_object(&device, NULL,
1638 ACPI_BUS_TYPE_POWER_BUTTON,
1639 ACPI_STA_DEFAULT, true);
1640 device_init_wakeup(&device->dev, true);
1643 if ((acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1644 result = acpi_add_single_object(&device, NULL,
1645 ACPI_BUS_TYPE_SLEEP_BUTTON,
1646 ACPI_STA_DEFAULT, true);
1652 int __init acpi_scan_init(void)
1656 result = bus_register(&acpi_bus_type);
1658 /* We don't want to quit even if we failed to add suspend/resume */
1659 printk(KERN_ERR PREFIX "Could not register bus type\n");
1662 acpi_pci_root_init();
1665 * Enumerate devices in the ACPI namespace.
1667 result = acpi_bus_scan(ACPI_ROOT_OBJECT);
1671 result = acpi_bus_get_device(ACPI_ROOT_OBJECT, &acpi_root);
1673 result = acpi_bus_scan_fixed();
1676 acpi_device_unregister(acpi_root);
1678 acpi_update_all_gpes();