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 static 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_device_release(struct device *dev)
480 struct acpi_device *acpi_dev = to_acpi_device(dev);
482 acpi_free_ids(acpi_dev);
486 static int acpi_bus_match(struct device *dev, struct device_driver *drv)
488 struct acpi_device *acpi_dev = to_acpi_device(dev);
489 struct acpi_driver *acpi_drv = to_acpi_driver(drv);
491 return acpi_dev->flags.match_driver
492 && !acpi_match_device_ids(acpi_dev, acpi_drv->ids);
495 static int acpi_device_uevent(struct device *dev, struct kobj_uevent_env *env)
497 struct acpi_device *acpi_dev = to_acpi_device(dev);
500 if (list_empty(&acpi_dev->pnp.ids))
503 if (add_uevent_var(env, "MODALIAS="))
505 len = create_modalias(acpi_dev, &env->buf[env->buflen - 1],
506 sizeof(env->buf) - env->buflen);
507 if (len >= (sizeof(env->buf) - env->buflen))
513 static void acpi_device_notify(acpi_handle handle, u32 event, void *data)
515 struct acpi_device *device = data;
517 device->driver->ops.notify(device, event);
520 static acpi_status acpi_device_notify_fixed(void *data)
522 struct acpi_device *device = data;
524 /* Fixed hardware devices have no handles */
525 acpi_device_notify(NULL, ACPI_FIXED_HARDWARE_EVENT, device);
529 static int acpi_device_install_notify_handler(struct acpi_device *device)
533 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
535 acpi_install_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
536 acpi_device_notify_fixed,
538 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
540 acpi_install_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
541 acpi_device_notify_fixed,
544 status = acpi_install_notify_handler(device->handle,
549 if (ACPI_FAILURE(status))
554 static void acpi_device_remove_notify_handler(struct acpi_device *device)
556 if (device->device_type == ACPI_BUS_TYPE_POWER_BUTTON)
557 acpi_remove_fixed_event_handler(ACPI_EVENT_POWER_BUTTON,
558 acpi_device_notify_fixed);
559 else if (device->device_type == ACPI_BUS_TYPE_SLEEP_BUTTON)
560 acpi_remove_fixed_event_handler(ACPI_EVENT_SLEEP_BUTTON,
561 acpi_device_notify_fixed);
563 acpi_remove_notify_handler(device->handle, ACPI_DEVICE_NOTIFY,
567 static int acpi_bus_driver_init(struct acpi_device *, struct acpi_driver *);
568 static int acpi_device_probe(struct device * dev)
570 struct acpi_device *acpi_dev = to_acpi_device(dev);
571 struct acpi_driver *acpi_drv = to_acpi_driver(dev->driver);
574 ret = acpi_bus_driver_init(acpi_dev, acpi_drv);
576 if (acpi_drv->ops.notify) {
577 ret = acpi_device_install_notify_handler(acpi_dev);
579 if (acpi_drv->ops.remove)
580 acpi_drv->ops.remove(acpi_dev,
581 acpi_dev->removal_type);
586 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
587 "Found driver [%s] for device [%s]\n",
588 acpi_drv->name, acpi_dev->pnp.bus_id));
594 static int acpi_device_remove(struct device * dev)
596 struct acpi_device *acpi_dev = to_acpi_device(dev);
597 struct acpi_driver *acpi_drv = acpi_dev->driver;
600 if (acpi_drv->ops.notify)
601 acpi_device_remove_notify_handler(acpi_dev);
602 if (acpi_drv->ops.remove)
603 acpi_drv->ops.remove(acpi_dev, acpi_dev->removal_type);
605 acpi_dev->driver = NULL;
606 acpi_dev->driver_data = NULL;
612 struct bus_type acpi_bus_type = {
614 .match = acpi_bus_match,
615 .probe = acpi_device_probe,
616 .remove = acpi_device_remove,
617 .uevent = acpi_device_uevent,
620 static int acpi_device_register(struct acpi_device *device)
623 struct acpi_device_bus_id *acpi_device_bus_id, *new_bus_id;
626 if (device->handle) {
629 status = acpi_attach_data(device->handle, acpi_bus_data_handler,
631 if (ACPI_FAILURE(status)) {
632 acpi_handle_err(device->handle,
633 "Unable to attach device data\n");
641 * Link this device to its parent and siblings.
643 INIT_LIST_HEAD(&device->children);
644 INIT_LIST_HEAD(&device->node);
645 INIT_LIST_HEAD(&device->wakeup_list);
646 INIT_LIST_HEAD(&device->physical_node_list);
647 mutex_init(&device->physical_node_lock);
648 INIT_LIST_HEAD(&device->power_dependent);
650 new_bus_id = kzalloc(sizeof(struct acpi_device_bus_id), GFP_KERNEL);
652 pr_err(PREFIX "Memory allocation error\n");
657 mutex_lock(&acpi_device_lock);
659 * Find suitable bus_id and instance number in acpi_bus_id_list
660 * If failed, create one and link it into acpi_bus_id_list
662 list_for_each_entry(acpi_device_bus_id, &acpi_bus_id_list, node) {
663 if (!strcmp(acpi_device_bus_id->bus_id,
664 acpi_device_hid(device))) {
665 acpi_device_bus_id->instance_no++;
672 acpi_device_bus_id = new_bus_id;
673 strcpy(acpi_device_bus_id->bus_id, acpi_device_hid(device));
674 acpi_device_bus_id->instance_no = 0;
675 list_add_tail(&acpi_device_bus_id->node, &acpi_bus_id_list);
677 dev_set_name(&device->dev, "%s:%02x", acpi_device_bus_id->bus_id, acpi_device_bus_id->instance_no);
680 list_add_tail(&device->node, &device->parent->children);
682 if (device->wakeup.flags.valid)
683 list_add_tail(&device->wakeup_list, &acpi_wakeup_device_list);
684 mutex_unlock(&acpi_device_lock);
687 device->dev.parent = &device->parent->dev;
688 device->dev.bus = &acpi_bus_type;
689 device->dev.release = &acpi_device_release;
690 result = device_register(&device->dev);
692 dev_err(&device->dev, "Error registering device\n");
696 result = acpi_device_setup_files(device);
698 printk(KERN_ERR PREFIX "Error creating sysfs interface for device %s\n",
699 dev_name(&device->dev));
701 device->removal_type = ACPI_BUS_REMOVAL_NORMAL;
705 mutex_lock(&acpi_device_lock);
707 list_del(&device->node);
708 list_del(&device->wakeup_list);
709 mutex_unlock(&acpi_device_lock);
712 acpi_detach_data(device->handle, acpi_bus_data_handler);
716 static void acpi_device_unregister(struct acpi_device *device)
718 mutex_lock(&acpi_device_lock);
720 list_del(&device->node);
722 list_del(&device->wakeup_list);
723 mutex_unlock(&acpi_device_lock);
725 acpi_detach_data(device->handle, acpi_bus_data_handler);
727 acpi_power_add_remove_device(device, false);
728 acpi_device_remove_files(device);
729 device_unregister(&device->dev);
731 * Drop the reference counts of all power resources the device depends
732 * on and turn off the ones that have no more references.
734 acpi_power_transition(device, ACPI_STATE_D3_COLD);
737 /* --------------------------------------------------------------------------
739 -------------------------------------------------------------------------- */
741 * acpi_bus_driver_init - add a device to a driver
742 * @device: the device to add and initialize
743 * @driver: driver for the device
745 * Used to initialize a device via its device driver. Called whenever a
746 * driver is bound to a device. Invokes the driver's add() ops.
749 acpi_bus_driver_init(struct acpi_device *device, struct acpi_driver *driver)
753 if (!device || !driver)
756 if (!driver->ops.add)
759 result = driver->ops.add(device);
761 device->driver = NULL;
762 device->driver_data = NULL;
766 device->driver = driver;
769 * TBD - Configuration Management: Assign resources to device based
770 * upon possible configuration and currently allocated resources.
773 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
774 "Driver successfully bound to device\n"));
779 * acpi_bus_register_driver - register a driver with the ACPI bus
780 * @driver: driver being registered
782 * Registers a driver with the ACPI bus. Searches the namespace for all
783 * devices that match the driver's criteria and binds. Returns zero for
784 * success or a negative error status for failure.
786 int acpi_bus_register_driver(struct acpi_driver *driver)
792 driver->drv.name = driver->name;
793 driver->drv.bus = &acpi_bus_type;
794 driver->drv.owner = driver->owner;
796 ret = driver_register(&driver->drv);
800 EXPORT_SYMBOL(acpi_bus_register_driver);
803 * acpi_bus_unregister_driver - unregisters a driver with the APIC bus
804 * @driver: driver to unregister
806 * Unregisters a driver with the ACPI bus. Searches the namespace for all
807 * devices that match the driver's criteria and unbinds.
809 void acpi_bus_unregister_driver(struct acpi_driver *driver)
811 driver_unregister(&driver->drv);
814 EXPORT_SYMBOL(acpi_bus_unregister_driver);
816 /* --------------------------------------------------------------------------
818 -------------------------------------------------------------------------- */
819 static struct acpi_device *acpi_bus_get_parent(acpi_handle handle)
823 struct acpi_device *device;
826 * Fixed hardware devices do not appear in the namespace and do not
827 * have handles, but we fabricate acpi_devices for them, so we have
828 * to deal with them specially.
834 status = acpi_get_parent(handle, &handle);
835 if (status == AE_NULL_ENTRY)
837 if (ACPI_FAILURE(status))
840 ret = acpi_bus_get_device(handle, &device);
847 acpi_bus_get_ejd(acpi_handle handle, acpi_handle *ejd)
851 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
852 union acpi_object *obj;
854 status = acpi_get_handle(handle, "_EJD", &tmp);
855 if (ACPI_FAILURE(status))
858 status = acpi_evaluate_object(handle, "_EJD", NULL, &buffer);
859 if (ACPI_SUCCESS(status)) {
860 obj = buffer.pointer;
861 status = acpi_get_handle(ACPI_ROOT_OBJECT, obj->string.pointer,
863 kfree(buffer.pointer);
867 EXPORT_SYMBOL_GPL(acpi_bus_get_ejd);
869 void acpi_bus_data_handler(acpi_handle handle, void *context)
878 acpi_bus_extract_wakeup_device_power_package(acpi_handle handle,
879 struct acpi_device_wakeup *wakeup)
881 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
882 union acpi_object *package = NULL;
883 union acpi_object *element = NULL;
888 return AE_BAD_PARAMETER;
891 status = acpi_evaluate_object(handle, "_PRW", NULL, &buffer);
892 if (ACPI_FAILURE(status)) {
893 ACPI_EXCEPTION((AE_INFO, status, "Evaluating _PRW"));
897 package = (union acpi_object *)buffer.pointer;
899 if (!package || (package->package.count < 2)) {
900 status = AE_BAD_DATA;
904 element = &(package->package.elements[0]);
906 status = AE_BAD_DATA;
909 if (element->type == ACPI_TYPE_PACKAGE) {
910 if ((element->package.count < 2) ||
911 (element->package.elements[0].type !=
912 ACPI_TYPE_LOCAL_REFERENCE)
913 || (element->package.elements[1].type != ACPI_TYPE_INTEGER)) {
914 status = AE_BAD_DATA;
918 element->package.elements[0].reference.handle;
920 (u32) element->package.elements[1].integer.value;
921 } else if (element->type == ACPI_TYPE_INTEGER) {
922 wakeup->gpe_device = NULL;
923 wakeup->gpe_number = element->integer.value;
925 status = AE_BAD_DATA;
929 element = &(package->package.elements[1]);
930 if (element->type != ACPI_TYPE_INTEGER) {
931 status = AE_BAD_DATA;
934 wakeup->sleep_state = element->integer.value;
936 if ((package->package.count - 2) > ACPI_MAX_HANDLES) {
937 status = AE_NO_MEMORY;
940 wakeup->resources.count = package->package.count - 2;
941 for (i = 0; i < wakeup->resources.count; i++) {
942 element = &(package->package.elements[i + 2]);
943 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
944 status = AE_BAD_DATA;
948 wakeup->resources.handles[i] = element->reference.handle;
951 acpi_setup_gpe_for_wake(handle, wakeup->gpe_device, wakeup->gpe_number);
954 kfree(buffer.pointer);
959 static void acpi_bus_set_run_wake_flags(struct acpi_device *device)
961 struct acpi_device_id button_device_ids[] = {
968 acpi_event_status event_status;
970 device->wakeup.flags.notifier_present = 0;
972 /* Power button, Lid switch always enable wakeup */
973 if (!acpi_match_device_ids(device, button_device_ids)) {
974 device->wakeup.flags.run_wake = 1;
975 if (!acpi_match_device_ids(device, &button_device_ids[1])) {
976 /* Do not use Lid/sleep button for S5 wakeup */
977 if (device->wakeup.sleep_state == ACPI_STATE_S5)
978 device->wakeup.sleep_state = ACPI_STATE_S4;
980 device_set_wakeup_capable(&device->dev, true);
984 status = acpi_get_gpe_status(device->wakeup.gpe_device,
985 device->wakeup.gpe_number,
988 device->wakeup.flags.run_wake =
989 !!(event_status & ACPI_EVENT_FLAG_HANDLE);
992 static void acpi_bus_get_wakeup_device_flags(struct acpi_device *device)
995 acpi_status status = 0;
998 /* Presence of _PRW indicates wake capable */
999 status = acpi_get_handle(device->handle, "_PRW", &temp);
1000 if (ACPI_FAILURE(status))
1003 status = acpi_bus_extract_wakeup_device_power_package(device->handle,
1005 if (ACPI_FAILURE(status)) {
1006 ACPI_EXCEPTION((AE_INFO, status, "Extracting _PRW package"));
1010 device->wakeup.flags.valid = 1;
1011 device->wakeup.prepare_count = 0;
1012 acpi_bus_set_run_wake_flags(device);
1013 /* Call _PSW/_DSW object to disable its ability to wake the sleeping
1014 * system for the ACPI device with the _PRW object.
1015 * The _PSW object is depreciated in ACPI 3.0 and is replaced by _DSW.
1016 * So it is necessary to call _DSW object first. Only when it is not
1017 * present will the _PSW object used.
1019 psw_error = acpi_device_sleep_wake(device, 0, 0, 0);
1021 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1022 "error in _DSW or _PSW evaluation\n"));
1025 static void acpi_bus_add_power_resource(acpi_handle handle);
1027 static void acpi_bus_get_power_flags(struct acpi_device *device)
1029 acpi_status status = 0;
1030 acpi_handle handle = NULL;
1033 /* Power resources cannot be power manageable. */
1034 if (device->device_type == ACPI_BUS_TYPE_POWER)
1037 /* Presence of _PS0|_PR0 indicates 'power manageable' */
1038 status = acpi_get_handle(device->handle, "_PS0", &handle);
1039 if (ACPI_FAILURE(status)) {
1040 status = acpi_get_handle(device->handle, "_PR0", &handle);
1041 if (ACPI_FAILURE(status))
1045 device->flags.power_manageable = 1;
1048 * Power Management Flags
1050 status = acpi_get_handle(device->handle, "_PSC", &handle);
1051 if (ACPI_SUCCESS(status))
1052 device->power.flags.explicit_get = 1;
1053 status = acpi_get_handle(device->handle, "_IRC", &handle);
1054 if (ACPI_SUCCESS(status))
1055 device->power.flags.inrush_current = 1;
1058 * Enumerate supported power management states
1060 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
1061 struct acpi_device_power_state *ps = &device->power.states[i];
1062 char object_name[5] = { '_', 'P', 'R', '0' + i, '\0' };
1064 /* Evaluate "_PRx" to se if power resources are referenced */
1065 acpi_evaluate_reference(device->handle, object_name, NULL,
1067 if (ps->resources.count) {
1070 device->power.flags.power_resources = 1;
1071 for (j = 0; j < ps->resources.count; j++)
1072 acpi_bus_add_power_resource(ps->resources.handles[j]);
1075 /* Evaluate "_PSx" to see if we can do explicit sets */
1076 object_name[2] = 'S';
1077 status = acpi_get_handle(device->handle, object_name, &handle);
1078 if (ACPI_SUCCESS(status))
1079 ps->flags.explicit_set = 1;
1082 * State is valid if there are means to put the device into it.
1083 * D3hot is only valid if _PR3 present.
1085 if (ps->resources.count ||
1086 (ps->flags.explicit_set && i < ACPI_STATE_D3_HOT)) {
1087 ps->flags.valid = 1;
1088 ps->flags.os_accessible = 1;
1091 ps->power = -1; /* Unknown - driver assigned */
1092 ps->latency = -1; /* Unknown - driver assigned */
1095 /* Set defaults for D0 and D3 states (always valid) */
1096 device->power.states[ACPI_STATE_D0].flags.valid = 1;
1097 device->power.states[ACPI_STATE_D0].power = 100;
1098 device->power.states[ACPI_STATE_D3].flags.valid = 1;
1099 device->power.states[ACPI_STATE_D3].power = 0;
1101 /* Set D3cold's explicit_set flag if _PS3 exists. */
1102 if (device->power.states[ACPI_STATE_D3_HOT].flags.explicit_set)
1103 device->power.states[ACPI_STATE_D3_COLD].flags.explicit_set = 1;
1105 /* Presence of _PS3 or _PRx means we can put the device into D3 cold */
1106 if (device->power.states[ACPI_STATE_D3_HOT].flags.explicit_set ||
1107 device->power.flags.power_resources)
1108 device->power.states[ACPI_STATE_D3_COLD].flags.os_accessible = 1;
1110 acpi_bus_init_power(device);
1113 static void acpi_bus_get_flags(struct acpi_device *device)
1115 acpi_status status = AE_OK;
1116 acpi_handle temp = NULL;
1118 /* Presence of _STA indicates 'dynamic_status' */
1119 status = acpi_get_handle(device->handle, "_STA", &temp);
1120 if (ACPI_SUCCESS(status))
1121 device->flags.dynamic_status = 1;
1123 /* Presence of _RMV indicates 'removable' */
1124 status = acpi_get_handle(device->handle, "_RMV", &temp);
1125 if (ACPI_SUCCESS(status))
1126 device->flags.removable = 1;
1128 /* Presence of _EJD|_EJ0 indicates 'ejectable' */
1129 status = acpi_get_handle(device->handle, "_EJD", &temp);
1130 if (ACPI_SUCCESS(status))
1131 device->flags.ejectable = 1;
1133 status = acpi_get_handle(device->handle, "_EJ0", &temp);
1134 if (ACPI_SUCCESS(status))
1135 device->flags.ejectable = 1;
1139 static void acpi_device_get_busid(struct acpi_device *device)
1141 char bus_id[5] = { '?', 0 };
1142 struct acpi_buffer buffer = { sizeof(bus_id), bus_id };
1148 * The device's Bus ID is simply the object name.
1149 * TBD: Shouldn't this value be unique (within the ACPI namespace)?
1151 if (ACPI_IS_ROOT_DEVICE(device)) {
1152 strcpy(device->pnp.bus_id, "ACPI");
1156 switch (device->device_type) {
1157 case ACPI_BUS_TYPE_POWER_BUTTON:
1158 strcpy(device->pnp.bus_id, "PWRF");
1160 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1161 strcpy(device->pnp.bus_id, "SLPF");
1164 acpi_get_name(device->handle, ACPI_SINGLE_NAME, &buffer);
1165 /* Clean up trailing underscores (if any) */
1166 for (i = 3; i > 1; i--) {
1167 if (bus_id[i] == '_')
1172 strcpy(device->pnp.bus_id, bus_id);
1178 * acpi_bay_match - see if a device is an ejectable driver bay
1180 * If an acpi object is ejectable and has one of the ACPI ATA methods defined,
1181 * then we can safely call it an ejectable drive bay
1183 static int acpi_bay_match(struct acpi_device *device){
1187 acpi_handle phandle;
1189 handle = device->handle;
1191 status = acpi_get_handle(handle, "_EJ0", &tmp);
1192 if (ACPI_FAILURE(status))
1195 if ((ACPI_SUCCESS(acpi_get_handle(handle, "_GTF", &tmp))) ||
1196 (ACPI_SUCCESS(acpi_get_handle(handle, "_GTM", &tmp))) ||
1197 (ACPI_SUCCESS(acpi_get_handle(handle, "_STM", &tmp))) ||
1198 (ACPI_SUCCESS(acpi_get_handle(handle, "_SDD", &tmp))))
1201 if (acpi_get_parent(handle, &phandle))
1204 if ((ACPI_SUCCESS(acpi_get_handle(phandle, "_GTF", &tmp))) ||
1205 (ACPI_SUCCESS(acpi_get_handle(phandle, "_GTM", &tmp))) ||
1206 (ACPI_SUCCESS(acpi_get_handle(phandle, "_STM", &tmp))) ||
1207 (ACPI_SUCCESS(acpi_get_handle(phandle, "_SDD", &tmp))))
1214 * acpi_dock_match - see if a device has a _DCK method
1216 static int acpi_dock_match(struct acpi_device *device)
1219 return acpi_get_handle(device->handle, "_DCK", &tmp);
1222 const char *acpi_device_hid(struct acpi_device *device)
1224 struct acpi_hardware_id *hid;
1226 if (list_empty(&device->pnp.ids))
1229 hid = list_first_entry(&device->pnp.ids, struct acpi_hardware_id, list);
1232 EXPORT_SYMBOL(acpi_device_hid);
1234 static void acpi_add_id(struct acpi_device *device, const char *dev_id)
1236 struct acpi_hardware_id *id;
1238 id = kmalloc(sizeof(*id), GFP_KERNEL);
1242 id->id = kstrdup(dev_id, GFP_KERNEL);
1248 list_add_tail(&id->list, &device->pnp.ids);
1252 * Old IBM workstations have a DSDT bug wherein the SMBus object
1253 * lacks the SMBUS01 HID and the methods do not have the necessary "_"
1254 * prefix. Work around this.
1256 static int acpi_ibm_smbus_match(struct acpi_device *device)
1258 acpi_handle h_dummy;
1259 struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
1262 if (!dmi_name_in_vendors("IBM"))
1265 /* Look for SMBS object */
1266 result = acpi_get_name(device->handle, ACPI_SINGLE_NAME, &path);
1270 if (strcmp("SMBS", path.pointer)) {
1275 /* Does it have the necessary (but misnamed) methods? */
1277 if (ACPI_SUCCESS(acpi_get_handle(device->handle, "SBI", &h_dummy)) &&
1278 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBR", &h_dummy)) &&
1279 ACPI_SUCCESS(acpi_get_handle(device->handle, "SBW", &h_dummy)))
1282 kfree(path.pointer);
1286 static void acpi_device_set_id(struct acpi_device *device)
1289 struct acpi_device_info *info;
1290 struct acpi_pnp_device_id_list *cid_list;
1293 switch (device->device_type) {
1294 case ACPI_BUS_TYPE_DEVICE:
1295 if (ACPI_IS_ROOT_DEVICE(device)) {
1296 acpi_add_id(device, ACPI_SYSTEM_HID);
1300 status = acpi_get_object_info(device->handle, &info);
1301 if (ACPI_FAILURE(status)) {
1302 printk(KERN_ERR PREFIX "%s: Error reading device info\n", __func__);
1306 if (info->valid & ACPI_VALID_HID)
1307 acpi_add_id(device, info->hardware_id.string);
1308 if (info->valid & ACPI_VALID_CID) {
1309 cid_list = &info->compatible_id_list;
1310 for (i = 0; i < cid_list->count; i++)
1311 acpi_add_id(device, cid_list->ids[i].string);
1313 if (info->valid & ACPI_VALID_ADR) {
1314 device->pnp.bus_address = info->address;
1315 device->flags.bus_address = 1;
1317 if (info->valid & ACPI_VALID_UID)
1318 device->pnp.unique_id = kstrdup(info->unique_id.string,
1324 * Some devices don't reliably have _HIDs & _CIDs, so add
1325 * synthetic HIDs to make sure drivers can find them.
1327 if (acpi_is_video_device(device))
1328 acpi_add_id(device, ACPI_VIDEO_HID);
1329 else if (ACPI_SUCCESS(acpi_bay_match(device)))
1330 acpi_add_id(device, ACPI_BAY_HID);
1331 else if (ACPI_SUCCESS(acpi_dock_match(device)))
1332 acpi_add_id(device, ACPI_DOCK_HID);
1333 else if (!acpi_ibm_smbus_match(device))
1334 acpi_add_id(device, ACPI_SMBUS_IBM_HID);
1335 else if (list_empty(&device->pnp.ids) &&
1336 ACPI_IS_ROOT_DEVICE(device->parent)) {
1337 acpi_add_id(device, ACPI_BUS_HID); /* \_SB, LNXSYBUS */
1338 strcpy(device->pnp.device_name, ACPI_BUS_DEVICE_NAME);
1339 strcpy(device->pnp.device_class, ACPI_BUS_CLASS);
1343 case ACPI_BUS_TYPE_POWER:
1344 acpi_add_id(device, ACPI_POWER_HID);
1346 case ACPI_BUS_TYPE_PROCESSOR:
1347 acpi_add_id(device, ACPI_PROCESSOR_OBJECT_HID);
1349 case ACPI_BUS_TYPE_THERMAL:
1350 acpi_add_id(device, ACPI_THERMAL_HID);
1352 case ACPI_BUS_TYPE_POWER_BUTTON:
1353 acpi_add_id(device, ACPI_BUTTON_HID_POWERF);
1355 case ACPI_BUS_TYPE_SLEEP_BUTTON:
1356 acpi_add_id(device, ACPI_BUTTON_HID_SLEEPF);
1361 static void acpi_init_device_object(struct acpi_device *device,
1363 int type, unsigned long long sta)
1365 INIT_LIST_HEAD(&device->pnp.ids);
1366 device->device_type = type;
1367 device->handle = handle;
1368 device->parent = acpi_bus_get_parent(handle);
1369 STRUCT_TO_INT(device->status) = sta;
1370 acpi_device_get_busid(device);
1371 acpi_device_set_id(device);
1372 acpi_bus_get_flags(device);
1375 static int acpi_add_single_object(struct acpi_device **child,
1376 acpi_handle handle, int type,
1377 unsigned long long sta, bool match_driver)
1380 struct acpi_device *device;
1381 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1383 device = kzalloc(sizeof(struct acpi_device), GFP_KERNEL);
1385 printk(KERN_ERR PREFIX "Memory allocation error\n");
1389 acpi_init_device_object(device, handle, type, sta);
1390 acpi_bus_get_power_flags(device);
1391 acpi_bus_get_wakeup_device_flags(device);
1393 device->flags.match_driver = match_driver;
1394 result = acpi_device_register(device);
1396 acpi_device_release(&device->dev);
1400 acpi_power_add_remove_device(device, true);
1401 acpi_get_name(handle, ACPI_FULL_PATHNAME, &buffer);
1402 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Added %s [%s] parent %s\n",
1403 dev_name(&device->dev), (char *) buffer.pointer,
1404 device->parent ? dev_name(&device->parent->dev) : "(null)"));
1405 kfree(buffer.pointer);
1410 #define ACPI_STA_DEFAULT (ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED | \
1411 ACPI_STA_DEVICE_UI | ACPI_STA_DEVICE_FUNCTIONING)
1413 static void acpi_bus_add_power_resource(acpi_handle handle)
1415 struct acpi_device *device = NULL;
1417 acpi_bus_get_device(handle, &device);
1419 acpi_add_single_object(&device, handle, ACPI_BUS_TYPE_POWER,
1420 ACPI_STA_DEFAULT, true);
1423 static int acpi_bus_type_and_status(acpi_handle handle, int *type,
1424 unsigned long long *sta)
1427 acpi_object_type acpi_type;
1429 status = acpi_get_type(handle, &acpi_type);
1430 if (ACPI_FAILURE(status))
1433 switch (acpi_type) {
1434 case ACPI_TYPE_ANY: /* for ACPI_ROOT_OBJECT */
1435 case ACPI_TYPE_DEVICE:
1436 *type = ACPI_BUS_TYPE_DEVICE;
1437 status = acpi_bus_get_status_handle(handle, sta);
1438 if (ACPI_FAILURE(status))
1441 case ACPI_TYPE_PROCESSOR:
1442 *type = ACPI_BUS_TYPE_PROCESSOR;
1443 status = acpi_bus_get_status_handle(handle, sta);
1444 if (ACPI_FAILURE(status))
1447 case ACPI_TYPE_THERMAL:
1448 *type = ACPI_BUS_TYPE_THERMAL;
1449 *sta = ACPI_STA_DEFAULT;
1451 case ACPI_TYPE_POWER:
1452 *type = ACPI_BUS_TYPE_POWER;
1453 *sta = ACPI_STA_DEFAULT;
1462 static acpi_status acpi_bus_check_add(acpi_handle handle, u32 lvl_not_used,
1463 void *not_used, void **return_value)
1465 struct acpi_device *device = NULL;
1467 unsigned long long sta;
1471 acpi_bus_get_device(handle, &device);
1475 result = acpi_bus_type_and_status(handle, &type, &sta);
1479 if (!(sta & ACPI_STA_DEVICE_PRESENT) &&
1480 !(sta & ACPI_STA_DEVICE_FUNCTIONING)) {
1481 struct acpi_device_wakeup wakeup;
1484 status = acpi_get_handle(handle, "_PRW", &temp);
1485 if (ACPI_SUCCESS(status))
1486 acpi_bus_extract_wakeup_device_power_package(handle,
1488 return AE_CTRL_DEPTH;
1491 acpi_add_single_object(&device, handle, type, sta,
1492 type == ACPI_BUS_TYPE_POWER);
1494 return AE_CTRL_DEPTH;
1496 device->flags.match_driver = true;
1500 *return_value = device;
1505 static acpi_status acpi_bus_device_attach(acpi_handle handle, u32 lvl_not_used,
1506 void *not_used, void **ret_not_used)
1508 acpi_status status = AE_OK;
1509 struct acpi_device *device;
1510 unsigned long long sta_not_used;
1514 * Ignore errors ignored by acpi_bus_check_add() to avoid terminating
1515 * namespace walks prematurely.
1517 if (acpi_bus_type_and_status(handle, &type_not_used, &sta_not_used))
1520 if (acpi_bus_get_device(handle, &device))
1521 return AE_CTRL_DEPTH;
1523 if (!acpi_match_device_ids(device, acpi_platform_device_ids)) {
1524 /* This is a known good platform device. */
1525 acpi_create_platform_device(device);
1526 } else if (device_attach(&device->dev) < 0) {
1527 status = AE_CTRL_DEPTH;
1532 static int acpi_bus_scan(acpi_handle handle)
1534 void *device = NULL;
1536 if (ACPI_SUCCESS(acpi_bus_check_add(handle, 0, NULL, &device)))
1537 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
1538 acpi_bus_check_add, NULL, NULL, &device);
1543 if (ACPI_SUCCESS(acpi_bus_device_attach(handle, 0, NULL, NULL)))
1544 acpi_walk_namespace(ACPI_TYPE_ANY, handle, ACPI_UINT32_MAX,
1545 acpi_bus_device_attach, NULL, NULL, NULL);
1551 * acpi_bus_add - Add ACPI device node objects in a given namespace scope.
1552 * @handle: Root of the namespace scope to scan.
1554 * Scan a given ACPI tree (probably recently hot-plugged) and create and add
1557 * If no devices were found, -ENODEV is returned, but it does not mean that
1558 * there has been a real error. There just have been no suitable ACPI objects
1559 * in the table trunk from which the kernel could create a device and add an
1560 * appropriate driver.
1562 int acpi_bus_add(acpi_handle handle)
1566 err = acpi_bus_scan(handle);
1570 acpi_update_all_gpes();
1573 EXPORT_SYMBOL(acpi_bus_add);
1575 static acpi_status acpi_bus_device_detach(acpi_handle handle, u32 lvl_not_used,
1576 void *not_used, void **ret_not_used)
1578 struct acpi_device *device = NULL;
1580 if (!acpi_bus_get_device(handle, &device)) {
1581 device->removal_type = ACPI_BUS_REMOVAL_EJECT;
1582 device_release_driver(&device->dev);
1587 static acpi_status acpi_bus_remove(acpi_handle handle, u32 lvl_not_used,
1588 void *not_used, void **ret_not_used)
1590 struct acpi_device *device = NULL;
1592 if (!acpi_bus_get_device(handle, &device))
1593 acpi_device_unregister(device);
1598 int acpi_bus_trim(struct acpi_device *start)
1601 * Execute acpi_bus_device_detach() as a post-order callback to detach
1602 * all ACPI drivers from the device nodes being removed.
1604 acpi_walk_namespace(ACPI_TYPE_ANY, start->handle, ACPI_UINT32_MAX, NULL,
1605 acpi_bus_device_detach, NULL, NULL);
1606 acpi_bus_device_detach(start->handle, 0, NULL, NULL);
1608 * Execute acpi_bus_remove() as a post-order callback to remove device
1609 * nodes in the given namespace scope.
1611 acpi_walk_namespace(ACPI_TYPE_ANY, start->handle, ACPI_UINT32_MAX, NULL,
1612 acpi_bus_remove, NULL, NULL);
1613 acpi_bus_remove(start->handle, 0, NULL, NULL);
1616 EXPORT_SYMBOL_GPL(acpi_bus_trim);
1618 static int acpi_bus_scan_fixed(void)
1621 struct acpi_device *device = NULL;
1624 * Enumerate all fixed-feature devices.
1626 if ((acpi_gbl_FADT.flags & ACPI_FADT_POWER_BUTTON) == 0) {
1627 result = acpi_add_single_object(&device, NULL,
1628 ACPI_BUS_TYPE_POWER_BUTTON,
1629 ACPI_STA_DEFAULT, true);
1630 device_init_wakeup(&device->dev, true);
1633 if ((acpi_gbl_FADT.flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
1634 result = acpi_add_single_object(&device, NULL,
1635 ACPI_BUS_TYPE_SLEEP_BUTTON,
1636 ACPI_STA_DEFAULT, true);
1642 int __init acpi_scan_init(void)
1646 result = bus_register(&acpi_bus_type);
1648 /* We don't want to quit even if we failed to add suspend/resume */
1649 printk(KERN_ERR PREFIX "Could not register bus type\n");
1653 acpi_pci_root_init();
1656 * Enumerate devices in the ACPI namespace.
1658 result = acpi_bus_scan(ACPI_ROOT_OBJECT);
1662 result = acpi_bus_get_device(ACPI_ROOT_OBJECT, &acpi_root);
1664 result = acpi_bus_scan_fixed();
1667 acpi_device_unregister(acpi_root);
1669 acpi_update_all_gpes();