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";
32 static LIST_HEAD(acpi_device_list);
33 static LIST_HEAD(acpi_bus_id_list);
34 DEFINE_MUTEX(acpi_device_lock);
35 LIST_HEAD(acpi_wakeup_device_list);
37 struct acpi_device_bus_id{
39 unsigned int instance_no;
40 struct list_head node;
44 * Creates hid/cid(s) string needed for modalias and uevent
45 * e.g. on a device with hid:IBM0001 and cid:ACPI0001 you get:
46 * char *modalias: "acpi:IBM0001:ACPI0001"
48 static int create_modalias(struct acpi_device *acpi_dev, char *modalias,
53 struct acpi_hardware_id *id;
55 if (list_empty(&acpi_dev->pnp.ids))
58 len = snprintf(modalias, size, "acpi:");
61 list_for_each_entry(id, &acpi_dev->pnp.ids, list) {
62 count = snprintf(&modalias[len], size, "%s:", id->id);
63 if (count < 0 || count >= size)
74 acpi_device_modalias_show(struct device *dev, struct device_attribute *attr, char *buf) {
75 struct acpi_device *acpi_dev = to_acpi_device(dev);
78 /* Device has no HID and no CID or string is >1024 */
79 len = create_modalias(acpi_dev, buf, 1024);
85 static DEVICE_ATTR(modalias, 0444, acpi_device_modalias_show, NULL);
88 * acpi_bus_hot_remove_device: hot-remove a device and its children
89 * @context: struct acpi_eject_event pointer (freed in this func)
91 * Hot-remove a device and its children. This function frees up the
92 * memory space passed by arg context, so that the caller may call
93 * this function asynchronously through acpi_os_hotplug_execute().
95 void acpi_bus_hot_remove_device(void *context)
97 struct acpi_eject_event *ej_event = (struct acpi_eject_event *) context;
98 struct acpi_device *device;
99 acpi_handle handle = ej_event->handle;
101 struct acpi_object_list arg_list;
102 union acpi_object arg;
103 acpi_status status = AE_OK;
104 u32 ost_code = ACPI_OST_SC_NON_SPECIFIC_FAILURE; /* default */
106 if (acpi_bus_get_device(handle, &device))
112 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
113 "Hot-removing device %s...\n", dev_name(&device->dev)));
115 if (acpi_bus_trim(device, 1)) {
116 printk(KERN_ERR PREFIX
117 "Removing device failed\n");
121 /* device has been freed */
124 /* power off device */
125 status = acpi_evaluate_object(handle, "_PS3", NULL, NULL);
126 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
127 printk(KERN_WARNING PREFIX
128 "Power-off device failed\n");
130 if (ACPI_SUCCESS(acpi_get_handle(handle, "_LCK", &temp))) {
132 arg_list.pointer = &arg;
133 arg.type = ACPI_TYPE_INTEGER;
134 arg.integer.value = 0;
135 acpi_evaluate_object(handle, "_LCK", &arg_list, NULL);
139 arg_list.pointer = &arg;
140 arg.type = ACPI_TYPE_INTEGER;
141 arg.integer.value = 1;
146 status = acpi_evaluate_object(handle, "_EJ0", &arg_list, NULL);
147 if (ACPI_FAILURE(status)) {
148 if (status != AE_NOT_FOUND)
149 printk(KERN_WARNING PREFIX
150 "Eject device failed\n");
158 /* Inform firmware the hot-remove operation has completed w/ error */
159 (void) acpi_evaluate_hotplug_ost(handle,
160 ej_event->event, ost_code, NULL);
164 EXPORT_SYMBOL(acpi_bus_hot_remove_device);
167 acpi_eject_store(struct device *d, struct device_attribute *attr,
168 const char *buf, size_t count)
172 acpi_object_type type = 0;
173 struct acpi_device *acpi_device = to_acpi_device(d);
174 struct acpi_eject_event *ej_event;
176 if ((!count) || (buf[0] != '1')) {
180 if (acpi_device->driver == NULL) {
185 status = acpi_get_type(acpi_device->handle, &type);
186 if (ACPI_FAILURE(status) || (!acpi_device->flags.ejectable)) {
191 ej_event = kmalloc(sizeof(*ej_event), GFP_KERNEL);
197 ej_event->handle = acpi_device->handle;
198 if (acpi_device->flags.eject_pending) {
199 /* event originated from ACPI eject notification */
200 ej_event->event = ACPI_NOTIFY_EJECT_REQUEST;
201 acpi_device->flags.eject_pending = 0;
203 /* event originated from user */
204 ej_event->event = ACPI_OST_EC_OSPM_EJECT;
205 (void) acpi_evaluate_hotplug_ost(ej_event->handle,
206 ej_event->event, ACPI_OST_SC_EJECT_IN_PROGRESS, NULL);
209 acpi_os_hotplug_execute(acpi_bus_hot_remove_device, (void *)ej_event);
214 static DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store);
217 acpi_device_hid_show(struct device *dev, struct device_attribute *attr, char *buf) {
218 struct acpi_device *acpi_dev = to_acpi_device(dev);
220 return sprintf(buf, "%s\n", acpi_device_hid(acpi_dev));
222 static DEVICE_ATTR(hid, 0444, acpi_device_hid_show, NULL);
224 static ssize_t acpi_device_uid_show(struct device *dev,
225 struct device_attribute *attr, char *buf)
227 struct acpi_device *acpi_dev = to_acpi_device(dev);
229 return sprintf(buf, "%s\n", acpi_dev->pnp.unique_id);
231 static DEVICE_ATTR(uid, 0444, acpi_device_uid_show, NULL);
233 static ssize_t acpi_device_adr_show(struct device *dev,
234 struct device_attribute *attr, char *buf)
236 struct acpi_device *acpi_dev = to_acpi_device(dev);
238 return sprintf(buf, "0x%08x\n",
239 (unsigned int)(acpi_dev->pnp.bus_address));
241 static DEVICE_ATTR(adr, 0444, acpi_device_adr_show, NULL);
244 acpi_device_path_show(struct device *dev, struct device_attribute *attr, char *buf) {
245 struct acpi_device *acpi_dev = to_acpi_device(dev);
246 struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
249 result = acpi_get_name(acpi_dev->handle, ACPI_FULL_PATHNAME, &path);
253 result = sprintf(buf, "%s\n", (char*)path.pointer);
258 static DEVICE_ATTR(path, 0444, acpi_device_path_show, NULL);
260 /* sysfs file that shows description text from the ACPI _STR method */
261 static ssize_t description_show(struct device *dev,
262 struct device_attribute *attr,
264 struct acpi_device *acpi_dev = to_acpi_device(dev);
267 if (acpi_dev->pnp.str_obj == NULL)
271 * The _STR object contains a Unicode identifier for a device.
272 * We need to convert to utf-8 so it can be displayed.
274 result = utf16s_to_utf8s(
275 (wchar_t *)acpi_dev->pnp.str_obj->buffer.pointer,
276 acpi_dev->pnp.str_obj->buffer.length,
277 UTF16_LITTLE_ENDIAN, buf,
280 buf[result++] = '\n';
284 static DEVICE_ATTR(description, 0444, description_show, NULL);
287 acpi_device_sun_show(struct device *dev, struct device_attribute *attr,
289 struct acpi_device *acpi_dev = to_acpi_device(dev);
291 return sprintf(buf, "%lu\n", acpi_dev->pnp.sun);
293 static DEVICE_ATTR(sun, 0444, acpi_device_sun_show, NULL);
295 static int acpi_device_setup_files(struct acpi_device *dev)
297 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
300 unsigned long long sun;
304 * Devices gotten from FADT don't have a "path" attribute
307 result = device_create_file(&dev->dev, &dev_attr_path);
312 if (!list_empty(&dev->pnp.ids)) {
313 result = device_create_file(&dev->dev, &dev_attr_hid);
317 result = device_create_file(&dev->dev, &dev_attr_modalias);
323 * If device has _STR, 'description' file is created
325 status = acpi_get_handle(dev->handle, "_STR", &temp);
326 if (ACPI_SUCCESS(status)) {
327 status = acpi_evaluate_object(dev->handle, "_STR",
329 if (ACPI_FAILURE(status))
330 buffer.pointer = NULL;
331 dev->pnp.str_obj = buffer.pointer;
332 result = device_create_file(&dev->dev, &dev_attr_description);
337 if (dev->flags.bus_address)
338 result = device_create_file(&dev->dev, &dev_attr_adr);
339 if (dev->pnp.unique_id)
340 result = device_create_file(&dev->dev, &dev_attr_uid);
342 status = acpi_evaluate_integer(dev->handle, "_SUN", NULL, &sun);
343 if (ACPI_SUCCESS(status)) {
344 dev->pnp.sun = (unsigned long)sun;
345 result = device_create_file(&dev->dev, &dev_attr_sun);
349 dev->pnp.sun = (unsigned long)-1;
353 * If device has _EJ0, 'eject' file is created that is used to trigger
354 * hot-removal function from userland.
356 status = acpi_get_handle(dev->handle, "_EJ0", &temp);
357 if (ACPI_SUCCESS(status))
358 result = device_create_file(&dev->dev, &dev_attr_eject);
363 static void acpi_device_remove_files(struct acpi_device *dev)
369 * If device has _STR, remove 'description' file
371 status = acpi_get_handle(dev->handle, "_STR", &temp);
372 if (ACPI_SUCCESS(status)) {
373 kfree(dev->pnp.str_obj);
374 device_remove_file(&dev->dev, &dev_attr_description);
377 * If device has _EJ0, remove 'eject' file.
379 status = acpi_get_handle(dev->handle, "_EJ0", &temp);
380 if (ACPI_SUCCESS(status))
381 device_remove_file(&dev->dev, &dev_attr_eject);
383 status = acpi_get_handle(dev->handle, "_SUN", &temp);
384 if (ACPI_SUCCESS(status))
385 device_remove_file(&dev->dev, &dev_attr_sun);
387 if (dev->pnp.unique_id)
388 device_remove_file(&dev->dev, &dev_attr_uid);
389 if (dev->flags.bus_address)
390 device_remove_file(&dev->dev, &dev_attr_adr);
391 device_remove_file(&dev->dev, &dev_attr_modalias);
392 device_remove_file(&dev->dev, &dev_attr_hid);
394 device_remove_file(&dev->dev, &dev_attr_path);
396 /* --------------------------------------------------------------------------
398 -------------------------------------------------------------------------- */
400 int acpi_match_device_ids(struct acpi_device *device,
401 const struct acpi_device_id *ids)
403 const struct acpi_device_id *id;
404 struct acpi_hardware_id *hwid;
407 * If the device is not present, it is unnecessary to load device
410 if (!device->status.present)
413 for (id = ids; id->id[0]; id++)
414 list_for_each_entry(hwid, &device->pnp.ids, list)
415 if (!strcmp((char *) id->id, hwid->id))
420 EXPORT_SYMBOL(acpi_match_device_ids);
422 static void acpi_free_ids(struct acpi_device *device)
424 struct acpi_hardware_id *id, *tmp;
426 list_for_each_entry_safe(id, tmp, &device->pnp.ids, list) {
432 static void acpi_device_release(struct device *dev)
434 struct acpi_device *acpi_dev = to_acpi_device(dev);
436 acpi_free_ids(acpi_dev);
437 kfree(acpi_dev->pnp.unique_id);
441 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
443 struct acpi_device *acpi_dev = to_acpi_device(dev);
444 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
446 return !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
449 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
451 struct acpi_device *acpi_dev = to_acpi_device(dev);
454 if (list_empty(&acpi_dev->pnp.ids))
457 if (add_uevent_var(env, "MODALIAS="))
459 len = create_modalias(acpi_dev, &env->buf[env->buflen - 1],
460 sizeof(env->buf) - env->buflen);
461 if (len >= (sizeof(env->buf) - env->buflen))
467 static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
469 struct acpi_device *device = data;
471 device->driver->ops.notify(device, event);
474 static acpi_status acpi_device_notify_fixed(void *data)
476 struct acpi_device *device = data;
478 /* Fixed hardware devices have no handles */
479 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
483 static int acpi_device_install_notify_handler(struct acpi_device *device)
487 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
489 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
490 acpi_device_notify_fixed,
492 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
494 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
495 acpi_device_notify_fixed,
498 status = acpi_install_notify_handler(device->handle,
503 if (ACPI_FAILURE(status))
508 static void acpi_device_remove_notify_handler(struct acpi_device *device)
510 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
511 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
512 acpi_device_notify_fixed);
513 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
514 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
515 acpi_device_notify_fixed);
517 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
521 static int acpi_bus_driver_init(struct acpi_device *, struct acpi_driver *);
522 static int acpi_start_single_object(struct acpi_device *);
523 static int acpi_device_probe(struct device * dev)
525 struct acpi_device *acpi_dev = to_acpi_device(dev);
526 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
529 ret = acpi_bus_driver_init(acpi_dev, acpi_drv);
531 if (acpi_dev->bus_ops.acpi_op_start)
532 acpi_start_single_object(acpi_dev);
534 if (acpi_drv->ops.notify) {
535 ret = acpi_device_install_notify_handler(acpi_dev);
537 if (acpi_drv->ops.remove)
538 acpi_drv->ops.remove(acpi_dev,
539 acpi_dev->removal_type);
544 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
545 "Found driver [%s] for device [%s]\n",
546 acpi_drv->name, acpi_dev->pnp.bus_id));
552 static int acpi_device_remove(struct device * dev)
554 struct acpi_device *acpi_dev = to_acpi_device(dev);
555 struct acpi_driver *acpi_drv = acpi_dev->driver;
558 if (acpi_drv->ops.notify)
559 acpi_device_remove_notify_handler(acpi_dev);
560 if (acpi_drv->ops.remove)
561 acpi_drv->ops.remove(acpi_dev, acpi_dev->removal_type);
563 acpi_dev->driver = NULL;
564 acpi_dev->driver_data = NULL;
570 struct bus_type acpi_bus_type = {
572 .match = acpi_bus_match,
573 .probe = acpi_device_probe,
574 .remove = acpi_device_remove,
575 .uevent = acpi_device_uevent,
578 static int acpi_device_register(struct acpi_device *device)
581 struct acpi_device_bus_id *acpi_device_bus_id, *new_bus_id;
587 * Link this device to its parent and siblings.
589 INIT_LIST_HEAD(&device->children);
590 INIT_LIST_HEAD(&device->node);
591 INIT_LIST_HEAD(&device->wakeup_list);
592 INIT_LIST_HEAD(&device->physical_node_list);
593 mutex_init(&device->physical_node_lock);
595 new_bus_id = kzalloc(sizeof(struct acpi_device_bus_id), GFP_KERNEL);
597 printk(KERN_ERR PREFIX "Memory allocation error\n");
601 mutex_lock(&acpi_device_lock);
603 * Find suitable bus_id and instance number in acpi_bus_id_list
604 * If failed, create one and link it into acpi_bus_id_list
606 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
607 if (!strcmp(acpi_device_bus_id->bus_id,
608 acpi_device_hid(device))) {
609 acpi_device_bus_id->instance_no++;
616 acpi_device_bus_id = new_bus_id;
617 strcpy(acpi_device_bus_id->bus_id, acpi_device_hid(device));
618 acpi_device_bus_id->instance_no = 0;
619 list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
621 dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, acpi_device_bus_id->instance_no);
624 list_add_tail(&device->node, &device->parent->children);
626 if (device->wakeup.flags.valid)
627 list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);
628 mutex_unlock(&acpi_device_lock);
631 device->dev.parent = &device->parent->dev;
632 device->dev.bus = &acpi_bus_type;
633 device->dev.release = &acpi_device_release;
634 result = device_register(&device->dev);
636 dev_err(&device->dev, "Error registering device\n");
640 result = acpi_device_setup_files(device);
642 printk(KERN_ERR PREFIX "Error creating sysfs interface for device %s\n",
643 dev_name(&device->dev));
645 device->removal_type = ACPI_BUS_REMOVAL_NORMAL;
648 mutex_lock(&acpi_device_lock);
650 list_del(&device->node);
651 list_del(&device->wakeup_list);
652 mutex_unlock(&acpi_device_lock);
656 static void acpi_device_unregister(struct acpi_device *device, int type)
658 mutex_lock(&acpi_device_lock);
660 list_del(&device->node);
662 list_del(&device->wakeup_list);
663 mutex_unlock(&acpi_device_lock);
665 acpi_detach_data(device->handle, acpi_bus_data_handler);
667 acpi_device_remove_files(device);
668 device_unregister(&device->dev);
671 /* --------------------------------------------------------------------------
673 -------------------------------------------------------------------------- */
675 * acpi_bus_driver_init - add a device to a driver
676 * @device: the device to add and initialize
677 * @driver: driver for the device
679 * Used to initialize a device via its device driver. Called whenever a
680 * driver is bound to a device. Invokes the driver's add() ops.
683 acpi_bus_driver_init(struct acpi_device *device, struct acpi_driver *driver)
687 if (!device || !driver)
690 if (!driver->ops.add)
693 result = driver->ops.add(device);
695 device->driver = NULL;
696 device->driver_data = NULL;
700 device->driver = driver;
703 * TBD - Configuration Management: Assign resources to device based
704 * upon possible configuration and currently allocated resources.
707 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
708 "Driver successfully bound to device\n"));
712 static int acpi_start_single_object(struct acpi_device *device)
715 struct acpi_driver *driver;
718 if (!(driver = device->driver))
721 if (driver->ops.start) {
722 result = driver->ops.start(device);
723 if (result && driver->ops.remove)
724 driver->ops.remove(device, ACPI_BUS_REMOVAL_NORMAL);
731 * acpi_bus_register_driver - register a driver with the ACPI bus
732 * @driver: driver being registered
734 * Registers a driver with the ACPI bus. Searches the namespace for all
735 * devices that match the driver's criteria and binds. Returns zero for
736 * success or a negative error status for failure.
738 int acpi_bus_register_driver(struct acpi_driver *driver)
744 driver->drv.name = driver->name;
745 driver->drv.bus = &acpi_bus_type;
746 driver->drv.owner = driver->owner;
748 ret = driver_register(&driver->drv);
752 EXPORT_SYMBOL(acpi_bus_register_driver);
755 * acpi_bus_unregister_driver - unregisters a driver with the APIC bus
756 * @driver: driver to unregister
758 * Unregisters a driver with the ACPI bus. Searches the namespace for all
759 * devices that match the driver's criteria and unbinds.
761 void acpi_bus_unregister_driver(struct acpi_driver *driver)
763 driver_unregister(&driver->drv);
766 EXPORT_SYMBOL(acpi_bus_unregister_driver);
768 /* --------------------------------------------------------------------------
770 -------------------------------------------------------------------------- */
771 static struct acpi_device *acpi_bus_get_parent(acpi_handle handle)
775 struct acpi_device *device;
778 * Fixed hardware devices do not appear in the namespace and do not
779 * have handles, but we fabricate acpi_devices for them, so we have
780 * to deal with them specially.
786 status = acpi_get_parent(handle, &handle);
787 if (status == AE_NULL_ENTRY)
789 if (ACPI_FAILURE(status))
792 ret = acpi_bus_get_device(handle, &device);
799 acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
803 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
804 union acpi_object *obj;
806 status = acpi_get_handle(handle, "_EJD", &tmp);
807 if (ACPI_FAILURE(status))
810 status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
811 if (ACPI_SUCCESS(status)) {
812 obj = buffer.pointer;
813 status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
815 kfree(buffer.pointer);
819 EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);
821 void acpi_bus_data_handler(acpi_handle handle, void *context)
829 static int acpi_bus_get_perf_flags(struct acpi_device *device)
831 device->performance.state = ACPI_STATE_UNKNOWN;
836 acpi_bus_extract_wakeup_device_power_package(acpi_handle handle,
837 struct acpi_device_wakeup *wakeup)
839 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
840 union acpi_object *package = NULL;
841 union acpi_object *element = NULL;
846 return AE_BAD_PARAMETER;
849 status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
850 if (ACPI_FAILURE(status)) {
851 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRW"));
855 package = (union acpi_object *)buffer.pointer;
857 if (!package || (package->package.count < 2)) {
858 status = AE_BAD_DATA;
862 element = &(package->package.elements[0]);
864 status = AE_BAD_DATA;
867 if (element->type == ACPI_TYPE_PACKAGE) {
868 if ((element->package.count < 2) ||
869 (element->package.elements[0].type !=
870 ACPI_TYPE_LOCAL_REFERENCE)
871 || (element->package.elements[1].type != ACPI_TYPE_INTEGER)) {
872 status = AE_BAD_DATA;
876 element->package.elements[0].reference.handle;
878 (u32) element->package.elements[1].integer.value;
879 } else if (element->type == ACPI_TYPE_INTEGER) {
880 wakeup->gpe_device = NULL;
881 wakeup->gpe_number = element->integer.value;
883 status = AE_BAD_DATA;
887 element = &(package->package.elements[1]);
888 if (element->type != ACPI_TYPE_INTEGER) {
889 status = AE_BAD_DATA;
892 wakeup->sleep_state = element->integer.value;
894 if ((package->package.count - 2) > ACPI_MAX_HANDLES) {
895 status = AE_NO_MEMORY;
898 wakeup->resources.count = package->package.count - 2;
899 for (i = 0; i < wakeup->resources.count; i++) {
900 element = &(package->package.elements[i + 2]);
901 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
902 status = AE_BAD_DATA;
906 wakeup->resources.handles[i] = element->reference.handle;
909 acpi_setup_gpe_for_wake(handle, wakeup->gpe_device, wakeup->gpe_number);
912 kfree(buffer.pointer);
917 static void acpi_bus_set_run_wake_flags(struct acpi_device *device)
919 struct acpi_device_id button_device_ids[] = {
926 acpi_event_status event_status;
928 device->wakeup.flags.notifier_present = 0;
930 /* Power button, Lid switch always enable wakeup */
931 if (!acpi_match_device_ids(device, button_device_ids)) {
932 device->wakeup.flags.run_wake = 1;
933 device_set_wakeup_capable(&device->dev, true);
937 status = acpi_get_gpe_status(device->wakeup.gpe_device,
938 device->wakeup.gpe_number,
941 device->wakeup.flags.run_wake =
942 !!(event_status & ACPI_EVENT_FLAG_HANDLE);
945 static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
948 acpi_status status = 0;
951 /* Presence of _PRW indicates wake capable */
952 status = acpi_get_handle(device->handle, "_PRW", &temp);
953 if (ACPI_FAILURE(status))
956 status = acpi_bus_extract_wakeup_device_power_package(device->handle,
958 if (ACPI_FAILURE(status)) {
959 ACPI_EXCEPTION((AE_INFO, status, "Extracting _PRW package"));
963 device->wakeup.flags.valid = 1;
964 device->wakeup.prepare_count = 0;
965 acpi_bus_set_run_wake_flags(device);
966 /* Call _PSW/_DSW object to disable its ability to wake the sleeping
967 * system for the ACPI device with the _PRW object.
968 * The _PSW object is depreciated in ACPI 3.0 and is replaced by _DSW.
969 * So it is necessary to call _DSW object first. Only when it is not
970 * present will the _PSW object used.
972 psw_error = acpi_device_sleep_wake(device, 0, 0, 0);
974 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
975 "error in _DSW or _PSW evaluation\n"));
978 static void acpi_bus_add_power_resource(acpi_handle handle);
980 static int acpi_bus_get_power_flags(struct acpi_device *device)
982 acpi_status status = 0;
983 acpi_handle handle = NULL;
988 * Power Management Flags
990 status = acpi_get_handle(device->handle, "_PSC", &handle);
991 if (ACPI_SUCCESS(status))
992 device->power.flags.explicit_get = 1;
993 status = acpi_get_handle(device->handle, "_IRC", &handle);
994 if (ACPI_SUCCESS(status))
995 device->power.flags.inrush_current = 1;
998 * Enumerate supported power management states
1000 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
1001 struct acpi_device_power_state *ps = &device->power.states[i];
1002 char object_name[5] = { '_', 'P', 'R', '0' + i, '\0' };
1004 /* Evaluate "_PRx" to se if power resources are referenced */
1005 acpi_evaluate_reference(device->handle, object_name, NULL,
1007 if (ps->resources.count) {
1010 device->power.flags.power_resources = 1;
1011 for (j = 0; j < ps->resources.count; j++)
1012 acpi_bus_add_power_resource(ps->resources.handles[j]);
1015 /* Evaluate "_PSx" to see if we can do explicit sets */
1016 object_name[2] = 'S';
1017 status = acpi_get_handle(device->handle, object_name, &handle);
1018 if (ACPI_SUCCESS(status))
1019 ps->flags.explicit_set = 1;
1022 * State is valid if there are means to put the device into it.
1023 * D3hot is only valid if _PR3 present.
1025 if (ps->resources.count ||
1026 (ps->flags.explicit_set && i < ACPI_STATE_D3_HOT))
1027 ps->flags.valid = 1;
1029 ps->power = -1; /* Unknown - driver assigned */
1030 ps->latency = -1; /* Unknown - driver assigned */
1033 /* Set defaults for D0 and D3 states (always valid) */
1034 device->power.states[ACPI_STATE_D0].flags.valid = 1;
1035 device->power.states[ACPI_STATE_D0].power = 100;
1036 device->power.states[ACPI_STATE_D3].flags.valid = 1;
1037 device->power.states[ACPI_STATE_D3].power = 0;
1039 /* Set D3cold's explicit_set flag if _PS3 exists. */
1040 if (device->power.states[ACPI_STATE_D3_HOT].flags.explicit_set)
1041 device->power.states[ACPI_STATE_D3_COLD].flags.explicit_set = 1;
1043 acpi_bus_init_power(device);
1048 static int acpi_bus_get_flags(struct acpi_device *device)
1050 acpi_status status = AE_OK;
1051 acpi_handle temp = NULL;
1054 /* Presence of _STA indicates 'dynamic_status' */
1055 status = acpi_get_handle(device->handle, "_STA", &temp);
1056 if (ACPI_SUCCESS(status))
1057 device->flags.dynamic_status = 1;
1059 /* Presence of _RMV indicates 'removable' */
1060 status = acpi_get_handle(device->handle, "_RMV", &temp);
1061 if (ACPI_SUCCESS(status))
1062 device->flags.removable = 1;
1064 /* Presence of _EJD|_EJ0 indicates 'ejectable' */
1065 status = acpi_get_handle(device->handle, "_EJD", &temp);
1066 if (ACPI_SUCCESS(status))
1067 device->flags.ejectable = 1;
1069 status = acpi_get_handle(device->handle, "_EJ0", &temp);
1070 if (ACPI_SUCCESS(status))
1071 device->flags.ejectable = 1;
1074 /* Power resources cannot be power manageable. */
1075 if (device->device_type == ACPI_BUS_TYPE_POWER)
1078 /* Presence of _PS0|_PR0 indicates 'power manageable' */
1079 status = acpi_get_handle(device->handle, "_PS0", &temp);
1080 if (ACPI_FAILURE(status))
1081 status = acpi_get_handle(device->handle, "_PR0", &temp);
1082 if (ACPI_SUCCESS(status))
1083 device->flags.power_manageable = 1;
1085 /* TBD: Performance management */
1090 static void acpi_device_get_busid(struct acpi_device *device)
1092 char bus_id[5] = { '?', 0 };
1093 struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
1099 * The device's Bus ID is simply the object name.
1100 * TBD: Shouldn't this value be unique (within the ACPI namespace)?
1102 if (ACPI_IS_ROOT_DEVICE(device)) {
1103 strcpy(device->pnp.bus_id, "ACPI");
1107 switch (device->device_type) {
1108 case ACPI_BUS_TYPE_POWER_BUTTON:
1109 strcpy(device->pnp.bus_id, "PWRF");
1111 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1112 strcpy(device->pnp.bus_id, "SLPF");
1115 acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
1116 /* Clean up trailing underscores (if any) */
1117 for (i = 3; i > 1; i--) {
1118 if (bus_id[i] == '_')
1123 strcpy(device->pnp.bus_id, bus_id);
1129 * acpi_bay_match - see if a device is an ejectable driver bay
1131 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
1132 * then we can safely call it an ejectable drive bay
1134 static int acpi_bay_match(struct acpi_device *device){
1138 acpi_handle phandle;
1140 handle = device->handle;
1142 status = acpi_get_handle(handle, "_EJ0", &tmp);
1143 if (ACPI_FAILURE(status))
1146 if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) ||
1147 (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) ||
1148 (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) ||
1149 (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp))))
1152 if (acpi_get_parent(handle, &phandle))
1155 if ((ACPI_SUCCESS(acpi_get_handle(phandle, "_GTF", &tmp))) ||
1156 (ACPI_SUCCESS(acpi_get_handle(phandle, "_GTM", &tmp))) ||
1157 (ACPI_SUCCESS(acpi_get_handle(phandle, "_STM", &tmp))) ||
1158 (ACPI_SUCCESS(acpi_get_handle(phandle, "_SDD", &tmp))))
1165 * acpi_dock_match - see if a device has a _DCK method
1167 static int acpi_dock_match(struct acpi_device *device)
1170 return acpi_get_handle(device->handle, "_DCK", &tmp);
1173 const char *acpi_device_hid(struct acpi_device *device)
1175 struct acpi_hardware_id *hid;
1177 if (list_empty(&device->pnp.ids))
1180 hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
1183 EXPORT_SYMBOL(acpi_device_hid);
1185 static void acpi_add_id(struct acpi_device *device, const char *dev_id)
1187 struct acpi_hardware_id *id;
1189 id = kmalloc(sizeof(*id), GFP_KERNEL);
1193 id->id = kstrdup(dev_id, GFP_KERNEL);
1199 list_add_tail(&id->list, &device->pnp.ids);
1203 * Old IBM workstations have a DSDT bug wherein the SMBus object
1204 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
1205 * prefix. Work around this.
1207 static int acpi_ibm_smbus_match(struct acpi_device *device)
1209 acpi_handle h_dummy;
1210 struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
1213 if (!dmi_name_in_vendors("IBM"))
1216 /* Look for SMBS object */
1217 result = acpi_get_name(device->handle, ACPI_SINGLE_NAME, &path);
1221 if (strcmp("SMBS", path.pointer)) {
1226 /* Does it have the necessary (but misnamed) methods? */
1228 if (ACPI_SUCCESS(acpi_get_handle(device->handle, "SBI", &h_dummy)) &&
1229 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBR", &h_dummy)) &&
1230 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBW", &h_dummy)))
1233 kfree(path.pointer);
1237 static void acpi_device_set_id(struct acpi_device *device)
1240 struct acpi_device_info *info;
1241 struct acpica_device_id_list *cid_list;
1244 switch (device->device_type) {
1245 case ACPI_BUS_TYPE_DEVICE:
1246 if (ACPI_IS_ROOT_DEVICE(device)) {
1247 acpi_add_id(device, ACPI_SYSTEM_HID);
1251 status = acpi_get_object_info(device->handle, &info);
1252 if (ACPI_FAILURE(status)) {
1253 printk(KERN_ERR PREFIX "%s: Error reading device info\n", __func__);
1257 if (info->valid & ACPI_VALID_HID)
1258 acpi_add_id(device, info->hardware_id.string);
1259 if (info->valid & ACPI_VALID_CID) {
1260 cid_list = &info->compatible_id_list;
1261 for (i = 0; i < cid_list->count; i++)
1262 acpi_add_id(device, cid_list->ids[i].string);
1264 if (info->valid & ACPI_VALID_ADR) {
1265 device->pnp.bus_address = info->address;
1266 device->flags.bus_address = 1;
1268 if (info->valid & ACPI_VALID_UID)
1269 device->pnp.unique_id = kstrdup(info->unique_id.string,
1275 * Some devices don't reliably have _HIDs & _CIDs, so add
1276 * synthetic HIDs to make sure drivers can find them.
1278 if (acpi_is_video_device(device))
1279 acpi_add_id(device, ACPI_VIDEO_HID);
1280 else if (ACPI_SUCCESS(acpi_bay_match(device)))
1281 acpi_add_id(device, ACPI_BAY_HID);
1282 else if (ACPI_SUCCESS(acpi_dock_match(device)))
1283 acpi_add_id(device, ACPI_DOCK_HID);
1284 else if (!acpi_ibm_smbus_match(device))
1285 acpi_add_id(device, ACPI_SMBUS_IBM_HID);
1286 else if (!acpi_device_hid(device) &&
1287 ACPI_IS_ROOT_DEVICE(device->parent)) {
1288 acpi_add_id(device, ACPI_BUS_HID); /* \_SB, LNXSYBUS */
1289 strcpy(device->pnp.device_name, ACPI_BUS_DEVICE_NAME);
1290 strcpy(device->pnp.device_class, ACPI_BUS_CLASS);
1294 case ACPI_BUS_TYPE_POWER:
1295 acpi_add_id(device, ACPI_POWER_HID);
1297 case ACPI_BUS_TYPE_PROCESSOR:
1298 acpi_add_id(device, ACPI_PROCESSOR_OBJECT_HID);
1300 case ACPI_BUS_TYPE_THERMAL:
1301 acpi_add_id(device, ACPI_THERMAL_HID);
1303 case ACPI_BUS_TYPE_POWER_BUTTON:
1304 acpi_add_id(device, ACPI_BUTTON_HID_POWERF);
1306 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1307 acpi_add_id(device, ACPI_BUTTON_HID_SLEEPF);
1312 static int acpi_device_set_context(struct acpi_device *device)
1319 * Attach this 'struct acpi_device' to the ACPI object. This makes
1320 * resolutions from handle->device very efficient. Fixed hardware
1321 * devices have no handles, so we skip them.
1323 if (!device->handle)
1326 status = acpi_attach_data(device->handle,
1327 acpi_bus_data_handler, device);
1328 if (ACPI_SUCCESS(status))
1331 printk(KERN_ERR PREFIX "Error attaching device data\n");
1335 static int acpi_bus_remove(struct acpi_device *dev, int rmdevice)
1340 dev->removal_type = ACPI_BUS_REMOVAL_EJECT;
1341 device_release_driver(&dev->dev);
1347 * unbind _ADR-Based Devices when hot removal
1349 if (dev->flags.bus_address) {
1350 if ((dev->parent) && (dev->parent->ops.unbind))
1351 dev->parent->ops.unbind(dev);
1353 acpi_device_unregister(dev, ACPI_BUS_REMOVAL_EJECT);
1358 static int acpi_add_single_object(struct acpi_device **child,
1359 acpi_handle handle, int type,
1360 unsigned long long sta,
1361 struct acpi_bus_ops *ops)
1364 struct acpi_device *device;
1365 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1367 device = kzalloc(sizeof(struct acpi_device), GFP_KERNEL);
1369 printk(KERN_ERR PREFIX "Memory allocation error\n");
1373 INIT_LIST_HEAD(&device->pnp.ids);
1374 device->device_type = type;
1375 device->handle = handle;
1376 device->parent = acpi_bus_get_parent(handle);
1377 device->bus_ops = *ops; /* workround for not call .start */
1378 STRUCT_TO_INT(device->status) = sta;
1380 acpi_device_get_busid(device);
1385 * Note that we only look for object handles -- cannot evaluate objects
1386 * until we know the device is present and properly initialized.
1388 result = acpi_bus_get_flags(device);
1395 * TBD: Synch with Core's enumeration/initialization process.
1397 acpi_device_set_id(device);
1403 if (device->flags.power_manageable) {
1404 result = acpi_bus_get_power_flags(device);
1410 * Wakeup device management
1411 *-----------------------
1413 acpi_bus_get_wakeup_device_flags(device);
1416 * Performance Management
1417 * ----------------------
1419 if (device->flags.performance_manageable) {
1420 result = acpi_bus_get_perf_flags(device);
1425 if ((result = acpi_device_set_context(device)))
1428 result = acpi_device_register(device);
1431 * Bind _ADR-Based Devices when hot add
1433 if (device->flags.bus_address) {
1434 if (device->parent && device->parent->ops.bind)
1435 device->parent->ops.bind(device);
1440 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1441 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1442 "Adding %s [%s] parent %s\n", dev_name(&device->dev),
1443 (char *) buffer.pointer,
1444 device->parent ? dev_name(&device->parent->dev) :
1446 kfree(buffer.pointer);
1449 acpi_device_release(&device->dev);
1454 #define ACPI_STA_DEFAULT (ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED | \
1455 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING)
1457 static void acpi_bus_add_power_resource(acpi_handle handle)
1459 struct acpi_bus_ops ops = {
1463 struct acpi_device *device = NULL;
1465 acpi_bus_get_device(handle, &device);
1467 acpi_add_single_object(&device, handle, ACPI_BUS_TYPE_POWER,
1468 ACPI_STA_DEFAULT, &ops);
1471 static int acpi_bus_type_and_status(acpi_handle handle, int *type,
1472 unsigned long long *sta)
1475 acpi_object_type acpi_type;
1477 status = acpi_get_type(handle, &acpi_type);
1478 if (ACPI_FAILURE(status))
1481 switch (acpi_type) {
1482 case ACPI_TYPE_ANY: /* for ACPI_ROOT_OBJECT */
1483 case ACPI_TYPE_DEVICE:
1484 *type = ACPI_BUS_TYPE_DEVICE;
1485 status = acpi_bus_get_status_handle(handle, sta);
1486 if (ACPI_FAILURE(status))
1489 case ACPI_TYPE_PROCESSOR:
1490 *type = ACPI_BUS_TYPE_PROCESSOR;
1491 status = acpi_bus_get_status_handle(handle, sta);
1492 if (ACPI_FAILURE(status))
1495 case ACPI_TYPE_THERMAL:
1496 *type = ACPI_BUS_TYPE_THERMAL;
1497 *sta = ACPI_STA_DEFAULT;
1499 case ACPI_TYPE_POWER:
1500 *type = ACPI_BUS_TYPE_POWER;
1501 *sta = ACPI_STA_DEFAULT;
1510 static acpi_status acpi_bus_check_add(acpi_handle handle, u32 lvl,
1511 void *context, void **return_value)
1513 struct acpi_bus_ops *ops = context;
1515 unsigned long long sta;
1516 struct acpi_device *device;
1520 result = acpi_bus_type_and_status(handle, &type, &sta);
1524 if (!(sta & ACPI_STA_DEVICE_PRESENT) &&
1525 !(sta & ACPI_STA_DEVICE_FUNCTIONING)) {
1526 struct acpi_device_wakeup wakeup;
1529 status = acpi_get_handle(handle, "_PRW", &temp);
1530 if (ACPI_SUCCESS(status))
1531 acpi_bus_extract_wakeup_device_power_package(handle,
1533 return AE_CTRL_DEPTH;
1537 * We may already have an acpi_device from a previous enumeration. If
1538 * so, we needn't add it again, but we may still have to start it.
1541 acpi_bus_get_device(handle, &device);
1542 if (ops->acpi_op_add && !device)
1543 acpi_add_single_object(&device, handle, type, sta, ops);
1546 return AE_CTRL_DEPTH;
1548 if (ops->acpi_op_start && !(ops->acpi_op_add)) {
1549 status = acpi_start_single_object(device);
1550 if (ACPI_FAILURE(status))
1551 return AE_CTRL_DEPTH;
1555 *return_value = device;
1559 static int acpi_bus_scan(acpi_handle handle, struct acpi_bus_ops *ops,
1560 struct acpi_device **child)
1563 void *device = NULL;
1565 status = acpi_bus_check_add(handle, 0, ops, &device);
1566 if (ACPI_SUCCESS(status))
1567 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
1568 acpi_bus_check_add, NULL, ops, &device);
1580 * acpi_bus_add and acpi_bus_start
1582 * scan a given ACPI tree and (probably recently hot-plugged)
1583 * create and add or starts found devices.
1585 * If no devices were found -ENODEV is returned which does not
1586 * mean that this is a real error, there just have been no suitable
1587 * ACPI objects in the table trunk from which the kernel could create
1588 * a device and add/start an appropriate driver.
1592 acpi_bus_add(struct acpi_device **child,
1593 struct acpi_device *parent, acpi_handle handle, int type)
1595 struct acpi_bus_ops ops;
1597 memset(&ops, 0, sizeof(ops));
1598 ops.acpi_op_add = 1;
1600 return acpi_bus_scan(handle, &ops, child);
1602 EXPORT_SYMBOL(acpi_bus_add);
1604 int acpi_bus_start(struct acpi_device *device)
1606 struct acpi_bus_ops ops;
1612 memset(&ops, 0, sizeof(ops));
1613 ops.acpi_op_start = 1;
1615 result = acpi_bus_scan(device->handle, &ops, NULL);
1617 acpi_update_all_gpes();
1621 EXPORT_SYMBOL(acpi_bus_start);
1623 int acpi_bus_trim(struct acpi_device *start, int rmdevice)
1626 struct acpi_device *parent, *child;
1627 acpi_handle phandle, chandle;
1628 acpi_object_type type;
1633 phandle = start->handle;
1634 child = chandle = NULL;
1636 while ((level > 0) && parent && (!err)) {
1637 status = acpi_get_next_object(ACPI_TYPE_ANY, phandle,
1641 * If this scope is exhausted then move our way back up.
1643 if (ACPI_FAILURE(status)) {
1646 acpi_get_parent(phandle, &phandle);
1648 parent = parent->parent;
1651 err = acpi_bus_remove(child, rmdevice);
1653 err = acpi_bus_remove(child, 1);
1658 status = acpi_get_type(chandle, &type);
1659 if (ACPI_FAILURE(status)) {
1663 * If there is a device corresponding to chandle then
1664 * parse it (depth-first).
1666 if (acpi_bus_get_device(chandle, &child) == 0) {
1676 EXPORT_SYMBOL_GPL(acpi_bus_trim);
1678 static int acpi_bus_scan_fixed(void)
1681 struct acpi_device *device = NULL;
1682 struct acpi_bus_ops ops;
1684 memset(&ops, 0, sizeof(ops));
1685 ops.acpi_op_add = 1;
1686 ops.acpi_op_start = 1;
1689 * Enumerate all fixed-feature devices.
1691 if ((acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON) == 0) {
1692 result = acpi_add_single_object(&device, NULL,
1693 ACPI_BUS_TYPE_POWER_BUTTON,
1696 device_init_wakeup(&device->dev, true);
1699 if ((acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1700 result = acpi_add_single_object(&device, NULL,
1701 ACPI_BUS_TYPE_SLEEP_BUTTON,
1709 int __init acpi_scan_init(void)
1712 struct acpi_bus_ops ops;
1714 memset(&ops, 0, sizeof(ops));
1715 ops.acpi_op_add = 1;
1716 ops.acpi_op_start = 1;
1718 result = bus_register(&acpi_bus_type);
1720 /* We don't want to quit even if we failed to add suspend/resume */
1721 printk(KERN_ERR PREFIX "Could not register bus type\n");
1727 * Enumerate devices in the ACPI namespace.
1729 result = acpi_bus_scan(ACPI_ROOT_OBJECT, &ops, &acpi_root);
1732 result = acpi_bus_scan_fixed();
1735 acpi_device_unregister(acpi_root, ACPI_BUS_REMOVAL_NORMAL);
1737 acpi_update_all_gpes();