[IPV4/IPV6/DECNET]: Small cleanup for fib rules.
[linux-2.6/linux-loongson.git] / drivers / base / core.c
blobec86d6fc2360bbb3fa6286a1972a7f82f36c3699
1 /*
2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
22 #include <asm/semaphore.h>
24 #include "base.h"
25 #include "power/power.h"
27 int (*platform_notify)(struct device * dev) = NULL;
28 int (*platform_notify_remove)(struct device * dev) = NULL;
31 * sysfs bindings for devices.
34 /**
35 * dev_driver_string - Return a device's driver name, if at all possible
36 * @dev: struct device to get the name of
38 * Will return the device's driver's name if it is bound to a device. If
39 * the device is not bound to a device, it will return the name of the bus
40 * it is attached to. If it is not attached to a bus either, an empty
41 * string will be returned.
43 const char *dev_driver_string(struct device *dev)
45 return dev->driver ? dev->driver->name :
46 (dev->bus ? dev->bus->name :
47 (dev->class ? dev->class->name : ""));
49 EXPORT_SYMBOL(dev_driver_string);
51 #define to_dev(obj) container_of(obj, struct device, kobj)
52 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
54 static ssize_t
55 dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
57 struct device_attribute * dev_attr = to_dev_attr(attr);
58 struct device * dev = to_dev(kobj);
59 ssize_t ret = -EIO;
61 if (dev_attr->show)
62 ret = dev_attr->show(dev, dev_attr, buf);
63 return ret;
66 static ssize_t
67 dev_attr_store(struct kobject * kobj, struct attribute * attr,
68 const char * buf, size_t count)
70 struct device_attribute * dev_attr = to_dev_attr(attr);
71 struct device * dev = to_dev(kobj);
72 ssize_t ret = -EIO;
74 if (dev_attr->store)
75 ret = dev_attr->store(dev, dev_attr, buf, count);
76 return ret;
79 static struct sysfs_ops dev_sysfs_ops = {
80 .show = dev_attr_show,
81 .store = dev_attr_store,
85 /**
86 * device_release - free device structure.
87 * @kobj: device's kobject.
89 * This is called once the reference count for the object
90 * reaches 0. We forward the call to the device's release
91 * method, which should handle actually freeing the structure.
93 static void device_release(struct kobject * kobj)
95 struct device * dev = to_dev(kobj);
97 if (dev->release)
98 dev->release(dev);
99 else if (dev->type && dev->type->release)
100 dev->type->release(dev);
101 else if (dev->class && dev->class->dev_release)
102 dev->class->dev_release(dev);
103 else {
104 printk(KERN_ERR "Device '%s' does not have a release() function, "
105 "it is broken and must be fixed.\n",
106 dev->bus_id);
107 WARN_ON(1);
111 static struct kobj_type ktype_device = {
112 .release = device_release,
113 .sysfs_ops = &dev_sysfs_ops,
117 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
119 struct kobj_type *ktype = get_ktype(kobj);
121 if (ktype == &ktype_device) {
122 struct device *dev = to_dev(kobj);
123 if (dev->uevent_suppress)
124 return 0;
125 if (dev->bus)
126 return 1;
127 if (dev->class)
128 return 1;
130 return 0;
133 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
135 struct device *dev = to_dev(kobj);
137 if (dev->bus)
138 return dev->bus->name;
139 if (dev->class)
140 return dev->class->name;
141 return NULL;
144 static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
145 int num_envp, char *buffer, int buffer_size)
147 struct device *dev = to_dev(kobj);
148 int i = 0;
149 int length = 0;
150 int retval = 0;
152 /* add the major/minor if present */
153 if (MAJOR(dev->devt)) {
154 add_uevent_var(envp, num_envp, &i,
155 buffer, buffer_size, &length,
156 "MAJOR=%u", MAJOR(dev->devt));
157 add_uevent_var(envp, num_envp, &i,
158 buffer, buffer_size, &length,
159 "MINOR=%u", MINOR(dev->devt));
162 if (dev->type && dev->type->name)
163 add_uevent_var(envp, num_envp, &i,
164 buffer, buffer_size, &length,
165 "DEVTYPE=%s", dev->type->name);
167 if (dev->driver)
168 add_uevent_var(envp, num_envp, &i,
169 buffer, buffer_size, &length,
170 "DRIVER=%s", dev->driver->name);
172 #ifdef CONFIG_SYSFS_DEPRECATED
173 if (dev->class) {
174 struct device *parent = dev->parent;
176 /* find first bus device in parent chain */
177 while (parent && !parent->bus)
178 parent = parent->parent;
179 if (parent && parent->bus) {
180 const char *path;
182 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
183 if (path) {
184 add_uevent_var(envp, num_envp, &i,
185 buffer, buffer_size, &length,
186 "PHYSDEVPATH=%s", path);
187 kfree(path);
190 add_uevent_var(envp, num_envp, &i,
191 buffer, buffer_size, &length,
192 "PHYSDEVBUS=%s", parent->bus->name);
194 if (parent->driver)
195 add_uevent_var(envp, num_envp, &i,
196 buffer, buffer_size, &length,
197 "PHYSDEVDRIVER=%s", parent->driver->name);
199 } else if (dev->bus) {
200 add_uevent_var(envp, num_envp, &i,
201 buffer, buffer_size, &length,
202 "PHYSDEVBUS=%s", dev->bus->name);
204 if (dev->driver)
205 add_uevent_var(envp, num_envp, &i,
206 buffer, buffer_size, &length,
207 "PHYSDEVDRIVER=%s", dev->driver->name);
209 #endif
211 /* terminate, set to next free slot, shrink available space */
212 envp[i] = NULL;
213 envp = &envp[i];
214 num_envp -= i;
215 buffer = &buffer[length];
216 buffer_size -= length;
218 if (dev->bus && dev->bus->uevent) {
219 /* have the bus specific function add its stuff */
220 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
221 if (retval)
222 pr_debug ("%s: bus uevent() returned %d\n",
223 __FUNCTION__, retval);
226 if (dev->class && dev->class->dev_uevent) {
227 /* have the class specific function add its stuff */
228 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
229 if (retval)
230 pr_debug("%s: class uevent() returned %d\n",
231 __FUNCTION__, retval);
234 if (dev->type && dev->type->uevent) {
235 /* have the device type specific fuction add its stuff */
236 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
237 if (retval)
238 pr_debug("%s: dev_type uevent() returned %d\n",
239 __FUNCTION__, retval);
242 return retval;
245 static struct kset_uevent_ops device_uevent_ops = {
246 .filter = dev_uevent_filter,
247 .name = dev_uevent_name,
248 .uevent = dev_uevent,
251 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
252 char *buf)
254 struct kobject *top_kobj;
255 struct kset *kset;
256 char *envp[32];
257 char *data = NULL;
258 char *pos;
259 int i;
260 size_t count = 0;
261 int retval;
263 /* search the kset, the device belongs to */
264 top_kobj = &dev->kobj;
265 if (!top_kobj->kset && top_kobj->parent) {
266 do {
267 top_kobj = top_kobj->parent;
268 } while (!top_kobj->kset && top_kobj->parent);
270 if (!top_kobj->kset)
271 goto out;
272 kset = top_kobj->kset;
273 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
274 goto out;
276 /* respect filter */
277 if (kset->uevent_ops && kset->uevent_ops->filter)
278 if (!kset->uevent_ops->filter(kset, &dev->kobj))
279 goto out;
281 data = (char *)get_zeroed_page(GFP_KERNEL);
282 if (!data)
283 return -ENOMEM;
285 /* let the kset specific function add its keys */
286 pos = data;
287 memset(envp, 0, sizeof(envp));
288 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
289 envp, ARRAY_SIZE(envp),
290 pos, PAGE_SIZE);
291 if (retval)
292 goto out;
294 /* copy keys to file */
295 for (i = 0; envp[i]; i++) {
296 pos = &buf[count];
297 count += sprintf(pos, "%s\n", envp[i]);
299 out:
300 free_page((unsigned long)data);
301 return count;
304 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
305 const char *buf, size_t count)
307 size_t len = count;
308 enum kobject_action action;
310 if (len && buf[len-1] == '\n')
311 len--;
313 for (action = 0; action < KOBJ_MAX; action++) {
314 if (strncmp(kobject_actions[action], buf, len) != 0)
315 continue;
316 if (kobject_actions[action][len] != '\0')
317 continue;
318 kobject_uevent(&dev->kobj, action);
319 goto out;
322 dev_err(dev, "uevent: unsupported action-string; this will "
323 "be ignored in a future kernel version\n");
324 kobject_uevent(&dev->kobj, KOBJ_ADD);
325 out:
326 return count;
329 static struct device_attribute uevent_attr =
330 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
332 static int device_add_attributes(struct device *dev,
333 struct device_attribute *attrs)
335 int error = 0;
336 int i;
338 if (attrs) {
339 for (i = 0; attr_name(attrs[i]); i++) {
340 error = device_create_file(dev, &attrs[i]);
341 if (error)
342 break;
344 if (error)
345 while (--i >= 0)
346 device_remove_file(dev, &attrs[i]);
348 return error;
351 static void device_remove_attributes(struct device *dev,
352 struct device_attribute *attrs)
354 int i;
356 if (attrs)
357 for (i = 0; attr_name(attrs[i]); i++)
358 device_remove_file(dev, &attrs[i]);
361 static int device_add_groups(struct device *dev,
362 struct attribute_group **groups)
364 int error = 0;
365 int i;
367 if (groups) {
368 for (i = 0; groups[i]; i++) {
369 error = sysfs_create_group(&dev->kobj, groups[i]);
370 if (error) {
371 while (--i >= 0)
372 sysfs_remove_group(&dev->kobj, groups[i]);
373 break;
377 return error;
380 static void device_remove_groups(struct device *dev,
381 struct attribute_group **groups)
383 int i;
385 if (groups)
386 for (i = 0; groups[i]; i++)
387 sysfs_remove_group(&dev->kobj, groups[i]);
390 static int device_add_attrs(struct device *dev)
392 struct class *class = dev->class;
393 struct device_type *type = dev->type;
394 int error;
396 if (class) {
397 error = device_add_attributes(dev, class->dev_attrs);
398 if (error)
399 return error;
402 if (type) {
403 error = device_add_groups(dev, type->groups);
404 if (error)
405 goto err_remove_class_attrs;
408 error = device_add_groups(dev, dev->groups);
409 if (error)
410 goto err_remove_type_groups;
412 return 0;
414 err_remove_type_groups:
415 if (type)
416 device_remove_groups(dev, type->groups);
417 err_remove_class_attrs:
418 if (class)
419 device_remove_attributes(dev, class->dev_attrs);
421 return error;
424 static void device_remove_attrs(struct device *dev)
426 struct class *class = dev->class;
427 struct device_type *type = dev->type;
429 device_remove_groups(dev, dev->groups);
431 if (type)
432 device_remove_groups(dev, type->groups);
434 if (class)
435 device_remove_attributes(dev, class->dev_attrs);
439 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
440 char *buf)
442 return print_dev_t(buf, dev->devt);
445 static struct device_attribute devt_attr =
446 __ATTR(dev, S_IRUGO, show_dev, NULL);
449 * devices_subsys - structure to be registered with kobject core.
452 decl_subsys(devices, &ktype_device, &device_uevent_ops);
456 * device_create_file - create sysfs attribute file for device.
457 * @dev: device.
458 * @attr: device attribute descriptor.
461 int device_create_file(struct device * dev, struct device_attribute * attr)
463 int error = 0;
464 if (get_device(dev)) {
465 error = sysfs_create_file(&dev->kobj, &attr->attr);
466 put_device(dev);
468 return error;
472 * device_remove_file - remove sysfs attribute file.
473 * @dev: device.
474 * @attr: device attribute descriptor.
477 void device_remove_file(struct device * dev, struct device_attribute * attr)
479 if (get_device(dev)) {
480 sysfs_remove_file(&dev->kobj, &attr->attr);
481 put_device(dev);
486 * device_create_bin_file - create sysfs binary attribute file for device.
487 * @dev: device.
488 * @attr: device binary attribute descriptor.
490 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
492 int error = -EINVAL;
493 if (dev)
494 error = sysfs_create_bin_file(&dev->kobj, attr);
495 return error;
497 EXPORT_SYMBOL_GPL(device_create_bin_file);
500 * device_remove_bin_file - remove sysfs binary attribute file
501 * @dev: device.
502 * @attr: device binary attribute descriptor.
504 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
506 if (dev)
507 sysfs_remove_bin_file(&dev->kobj, attr);
509 EXPORT_SYMBOL_GPL(device_remove_bin_file);
512 * device_schedule_callback_owner - helper to schedule a callback for a device
513 * @dev: device.
514 * @func: callback function to invoke later.
515 * @owner: module owning the callback routine
517 * Attribute methods must not unregister themselves or their parent device
518 * (which would amount to the same thing). Attempts to do so will deadlock,
519 * since unregistration is mutually exclusive with driver callbacks.
521 * Instead methods can call this routine, which will attempt to allocate
522 * and schedule a workqueue request to call back @func with @dev as its
523 * argument in the workqueue's process context. @dev will be pinned until
524 * @func returns.
526 * This routine is usually called via the inline device_schedule_callback(),
527 * which automatically sets @owner to THIS_MODULE.
529 * Returns 0 if the request was submitted, -ENOMEM if storage could not
530 * be allocated, -ENODEV if a reference to @owner isn't available.
532 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
533 * underlying sysfs routine (since it is intended for use by attribute
534 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
536 int device_schedule_callback_owner(struct device *dev,
537 void (*func)(struct device *), struct module *owner)
539 return sysfs_schedule_callback(&dev->kobj,
540 (void (*)(void *)) func, dev, owner);
542 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
544 static void klist_children_get(struct klist_node *n)
546 struct device *dev = container_of(n, struct device, knode_parent);
548 get_device(dev);
551 static void klist_children_put(struct klist_node *n)
553 struct device *dev = container_of(n, struct device, knode_parent);
555 put_device(dev);
560 * device_initialize - init device structure.
561 * @dev: device.
563 * This prepares the device for use by other layers,
564 * including adding it to the device hierarchy.
565 * It is the first half of device_register(), if called by
566 * that, though it can also be called separately, so one
567 * may use @dev's fields (e.g. the refcount).
570 void device_initialize(struct device *dev)
572 kobj_set_kset_s(dev, devices_subsys);
573 kobject_init(&dev->kobj);
574 klist_init(&dev->klist_children, klist_children_get,
575 klist_children_put);
576 INIT_LIST_HEAD(&dev->dma_pools);
577 INIT_LIST_HEAD(&dev->node);
578 init_MUTEX(&dev->sem);
579 spin_lock_init(&dev->devres_lock);
580 INIT_LIST_HEAD(&dev->devres_head);
581 device_init_wakeup(dev, 0);
582 set_dev_node(dev, -1);
585 #ifdef CONFIG_SYSFS_DEPRECATED
586 static struct kobject * get_device_parent(struct device *dev,
587 struct device *parent)
590 * Set the parent to the class, not the parent device
591 * for topmost devices in class hierarchy.
592 * This keeps sysfs from having a symlink to make old
593 * udevs happy
595 if (dev->class && (!parent || parent->class != dev->class))
596 return &dev->class->subsys.kobj;
597 else if (parent)
598 return &parent->kobj;
600 return NULL;
602 #else
603 static struct kobject *virtual_device_parent(struct device *dev)
605 static struct kobject *virtual_dir = NULL;
607 if (!virtual_dir)
608 virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
610 return virtual_dir;
613 static struct kobject * get_device_parent(struct device *dev,
614 struct device *parent)
616 if (dev->class) {
617 struct kobject *kobj = NULL;
618 struct kobject *parent_kobj;
619 struct kobject *k;
622 * If we have no parent, we live in "virtual".
623 * Class-devices with a bus-device as parent, live
624 * in a class-directory to prevent namespace collisions.
626 if (parent == NULL)
627 parent_kobj = virtual_device_parent(dev);
628 else if (parent->class)
629 return &parent->kobj;
630 else
631 parent_kobj = &parent->kobj;
633 /* find our class-directory at the parent and reference it */
634 spin_lock(&dev->class->class_dirs.list_lock);
635 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
636 if (k->parent == parent_kobj) {
637 kobj = kobject_get(k);
638 break;
640 spin_unlock(&dev->class->class_dirs.list_lock);
641 if (kobj)
642 return kobj;
644 /* or create a new class-directory at the parent device */
645 return kobject_kset_add_dir(&dev->class->class_dirs,
646 parent_kobj, dev->class->name);
649 if (parent)
650 return &parent->kobj;
651 return NULL;
653 #endif
655 static int setup_parent(struct device *dev, struct device *parent)
657 struct kobject *kobj;
658 kobj = get_device_parent(dev, parent);
659 if (IS_ERR(kobj))
660 return PTR_ERR(kobj);
661 if (kobj)
662 dev->kobj.parent = kobj;
663 return 0;
666 static int device_add_class_symlinks(struct device *dev)
668 int error;
670 if (!dev->class)
671 return 0;
672 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
673 "subsystem");
674 if (error)
675 goto out;
677 * If this is not a "fake" compatible device, then create the
678 * symlink from the class to the device.
680 if (dev->kobj.parent != &dev->class->subsys.kobj) {
681 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
682 dev->bus_id);
683 if (error)
684 goto out_subsys;
686 if (dev->parent) {
687 #ifdef CONFIG_SYSFS_DEPRECATED
689 struct device *parent = dev->parent;
690 char *class_name;
693 * In old sysfs stacked class devices had 'device'
694 * link pointing to real device instead of parent
696 while (parent->class && !parent->bus && parent->parent)
697 parent = parent->parent;
699 error = sysfs_create_link(&dev->kobj,
700 &parent->kobj,
701 "device");
702 if (error)
703 goto out_busid;
705 class_name = make_class_name(dev->class->name,
706 &dev->kobj);
707 if (class_name)
708 error = sysfs_create_link(&dev->parent->kobj,
709 &dev->kobj, class_name);
710 kfree(class_name);
711 if (error)
712 goto out_device;
714 #else
715 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
716 "device");
717 if (error)
718 goto out_busid;
719 #endif
721 return 0;
723 #ifdef CONFIG_SYSFS_DEPRECATED
724 out_device:
725 if (dev->parent)
726 sysfs_remove_link(&dev->kobj, "device");
727 #endif
728 out_busid:
729 if (dev->kobj.parent != &dev->class->subsys.kobj)
730 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
731 out_subsys:
732 sysfs_remove_link(&dev->kobj, "subsystem");
733 out:
734 return error;
737 static void device_remove_class_symlinks(struct device *dev)
739 if (!dev->class)
740 return;
741 if (dev->parent) {
742 #ifdef CONFIG_SYSFS_DEPRECATED
743 char *class_name;
745 class_name = make_class_name(dev->class->name, &dev->kobj);
746 if (class_name) {
747 sysfs_remove_link(&dev->parent->kobj, class_name);
748 kfree(class_name);
750 #endif
751 sysfs_remove_link(&dev->kobj, "device");
753 if (dev->kobj.parent != &dev->class->subsys.kobj)
754 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
755 sysfs_remove_link(&dev->kobj, "subsystem");
759 * device_add - add device to device hierarchy.
760 * @dev: device.
762 * This is part 2 of device_register(), though may be called
763 * separately _iff_ device_initialize() has been called separately.
765 * This adds it to the kobject hierarchy via kobject_add(), adds it
766 * to the global and sibling lists for the device, then
767 * adds it to the other relevant subsystems of the driver model.
769 int device_add(struct device *dev)
771 struct device *parent = NULL;
772 struct class_interface *class_intf;
773 int error = -EINVAL;
775 dev = get_device(dev);
776 if (!dev || !strlen(dev->bus_id))
777 goto Error;
779 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
781 parent = get_device(dev->parent);
782 error = setup_parent(dev, parent);
783 if (error)
784 goto Error;
786 /* first, register with generic layer. */
787 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
788 error = kobject_add(&dev->kobj);
789 if (error)
790 goto Error;
792 /* notify platform of device entry */
793 if (platform_notify)
794 platform_notify(dev);
796 /* notify clients of device entry (new way) */
797 if (dev->bus)
798 blocking_notifier_call_chain(&dev->bus->bus_notifier,
799 BUS_NOTIFY_ADD_DEVICE, dev);
801 error = device_create_file(dev, &uevent_attr);
802 if (error)
803 goto attrError;
805 if (MAJOR(dev->devt)) {
806 error = device_create_file(dev, &devt_attr);
807 if (error)
808 goto ueventattrError;
811 error = device_add_class_symlinks(dev);
812 if (error)
813 goto SymlinkError;
814 error = device_add_attrs(dev);
815 if (error)
816 goto AttrsError;
817 error = device_pm_add(dev);
818 if (error)
819 goto PMError;
820 error = bus_add_device(dev);
821 if (error)
822 goto BusError;
823 kobject_uevent(&dev->kobj, KOBJ_ADD);
824 bus_attach_device(dev);
825 if (parent)
826 klist_add_tail(&dev->knode_parent, &parent->klist_children);
828 if (dev->class) {
829 down(&dev->class->sem);
830 /* tie the class to the device */
831 list_add_tail(&dev->node, &dev->class->devices);
833 /* notify any interfaces that the device is here */
834 list_for_each_entry(class_intf, &dev->class->interfaces, node)
835 if (class_intf->add_dev)
836 class_intf->add_dev(dev, class_intf);
837 up(&dev->class->sem);
839 Done:
840 put_device(dev);
841 return error;
842 BusError:
843 device_pm_remove(dev);
844 PMError:
845 if (dev->bus)
846 blocking_notifier_call_chain(&dev->bus->bus_notifier,
847 BUS_NOTIFY_DEL_DEVICE, dev);
848 device_remove_attrs(dev);
849 AttrsError:
850 device_remove_class_symlinks(dev);
851 SymlinkError:
852 if (MAJOR(dev->devt))
853 device_remove_file(dev, &devt_attr);
855 if (dev->class) {
856 sysfs_remove_link(&dev->kobj, "subsystem");
857 /* If this is not a "fake" compatible device, remove the
858 * symlink from the class to the device. */
859 if (dev->kobj.parent != &dev->class->subsys.kobj)
860 sysfs_remove_link(&dev->class->subsys.kobj,
861 dev->bus_id);
862 if (parent) {
863 #ifdef CONFIG_SYSFS_DEPRECATED
864 char *class_name = make_class_name(dev->class->name,
865 &dev->kobj);
866 if (class_name)
867 sysfs_remove_link(&dev->parent->kobj,
868 class_name);
869 kfree(class_name);
870 #endif
871 sysfs_remove_link(&dev->kobj, "device");
874 ueventattrError:
875 device_remove_file(dev, &uevent_attr);
876 attrError:
877 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
878 kobject_del(&dev->kobj);
879 Error:
880 if (parent)
881 put_device(parent);
882 goto Done;
887 * device_register - register a device with the system.
888 * @dev: pointer to the device structure
890 * This happens in two clean steps - initialize the device
891 * and add it to the system. The two steps can be called
892 * separately, but this is the easiest and most common.
893 * I.e. you should only call the two helpers separately if
894 * have a clearly defined need to use and refcount the device
895 * before it is added to the hierarchy.
898 int device_register(struct device *dev)
900 device_initialize(dev);
901 return device_add(dev);
906 * get_device - increment reference count for device.
907 * @dev: device.
909 * This simply forwards the call to kobject_get(), though
910 * we do take care to provide for the case that we get a NULL
911 * pointer passed in.
914 struct device * get_device(struct device * dev)
916 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
921 * put_device - decrement reference count.
922 * @dev: device in question.
924 void put_device(struct device * dev)
926 if (dev)
927 kobject_put(&dev->kobj);
932 * device_del - delete device from system.
933 * @dev: device.
935 * This is the first part of the device unregistration
936 * sequence. This removes the device from the lists we control
937 * from here, has it removed from the other driver model
938 * subsystems it was added to in device_add(), and removes it
939 * from the kobject hierarchy.
941 * NOTE: this should be called manually _iff_ device_add() was
942 * also called manually.
945 void device_del(struct device * dev)
947 struct device * parent = dev->parent;
948 struct class_interface *class_intf;
950 if (parent)
951 klist_del(&dev->knode_parent);
952 if (MAJOR(dev->devt))
953 device_remove_file(dev, &devt_attr);
954 if (dev->class) {
955 sysfs_remove_link(&dev->kobj, "subsystem");
956 /* If this is not a "fake" compatible device, remove the
957 * symlink from the class to the device. */
958 if (dev->kobj.parent != &dev->class->subsys.kobj)
959 sysfs_remove_link(&dev->class->subsys.kobj,
960 dev->bus_id);
961 if (parent) {
962 #ifdef CONFIG_SYSFS_DEPRECATED
963 char *class_name = make_class_name(dev->class->name,
964 &dev->kobj);
965 if (class_name)
966 sysfs_remove_link(&dev->parent->kobj,
967 class_name);
968 kfree(class_name);
969 #endif
970 sysfs_remove_link(&dev->kobj, "device");
973 down(&dev->class->sem);
974 /* notify any interfaces that the device is now gone */
975 list_for_each_entry(class_intf, &dev->class->interfaces, node)
976 if (class_intf->remove_dev)
977 class_intf->remove_dev(dev, class_intf);
978 /* remove the device from the class list */
979 list_del_init(&dev->node);
980 up(&dev->class->sem);
982 /* If we live in a parent class-directory, unreference it */
983 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
984 struct device *d;
985 int other = 0;
988 * if we are the last child of our class, delete
989 * our class-directory at this parent
991 down(&dev->class->sem);
992 list_for_each_entry(d, &dev->class->devices, node) {
993 if (d == dev)
994 continue;
995 if (d->kobj.parent == dev->kobj.parent) {
996 other = 1;
997 break;
1000 if (!other)
1001 kobject_del(dev->kobj.parent);
1003 kobject_put(dev->kobj.parent);
1004 up(&dev->class->sem);
1007 device_remove_file(dev, &uevent_attr);
1008 device_remove_attrs(dev);
1009 bus_remove_device(dev);
1012 * Some platform devices are driven without driver attached
1013 * and managed resources may have been acquired. Make sure
1014 * all resources are released.
1016 devres_release_all(dev);
1018 /* Notify the platform of the removal, in case they
1019 * need to do anything...
1021 if (platform_notify_remove)
1022 platform_notify_remove(dev);
1023 if (dev->bus)
1024 blocking_notifier_call_chain(&dev->bus->bus_notifier,
1025 BUS_NOTIFY_DEL_DEVICE, dev);
1026 device_pm_remove(dev);
1027 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1028 kobject_del(&dev->kobj);
1029 if (parent)
1030 put_device(parent);
1034 * device_unregister - unregister device from system.
1035 * @dev: device going away.
1037 * We do this in two parts, like we do device_register(). First,
1038 * we remove it from all the subsystems with device_del(), then
1039 * we decrement the reference count via put_device(). If that
1040 * is the final reference count, the device will be cleaned up
1041 * via device_release() above. Otherwise, the structure will
1042 * stick around until the final reference to the device is dropped.
1044 void device_unregister(struct device * dev)
1046 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
1047 device_del(dev);
1048 put_device(dev);
1052 static struct device * next_device(struct klist_iter * i)
1054 struct klist_node * n = klist_next(i);
1055 return n ? container_of(n, struct device, knode_parent) : NULL;
1059 * device_for_each_child - device child iterator.
1060 * @parent: parent struct device.
1061 * @data: data for the callback.
1062 * @fn: function to be called for each device.
1064 * Iterate over @parent's child devices, and call @fn for each,
1065 * passing it @data.
1067 * We check the return of @fn each time. If it returns anything
1068 * other than 0, we break out and return that value.
1070 int device_for_each_child(struct device * parent, void * data,
1071 int (*fn)(struct device *, void *))
1073 struct klist_iter i;
1074 struct device * child;
1075 int error = 0;
1077 klist_iter_init(&parent->klist_children, &i);
1078 while ((child = next_device(&i)) && !error)
1079 error = fn(child, data);
1080 klist_iter_exit(&i);
1081 return error;
1085 * device_find_child - device iterator for locating a particular device.
1086 * @parent: parent struct device
1087 * @data: Data to pass to match function
1088 * @match: Callback function to check device
1090 * This is similar to the device_for_each_child() function above, but it
1091 * returns a reference to a device that is 'found' for later use, as
1092 * determined by the @match callback.
1094 * The callback should return 0 if the device doesn't match and non-zero
1095 * if it does. If the callback returns non-zero and a reference to the
1096 * current device can be obtained, this function will return to the caller
1097 * and not iterate over any more devices.
1099 struct device * device_find_child(struct device *parent, void *data,
1100 int (*match)(struct device *, void *))
1102 struct klist_iter i;
1103 struct device *child;
1105 if (!parent)
1106 return NULL;
1108 klist_iter_init(&parent->klist_children, &i);
1109 while ((child = next_device(&i)))
1110 if (match(child, data) && get_device(child))
1111 break;
1112 klist_iter_exit(&i);
1113 return child;
1116 int __init devices_init(void)
1118 return subsystem_register(&devices_subsys);
1121 EXPORT_SYMBOL_GPL(device_for_each_child);
1122 EXPORT_SYMBOL_GPL(device_find_child);
1124 EXPORT_SYMBOL_GPL(device_initialize);
1125 EXPORT_SYMBOL_GPL(device_add);
1126 EXPORT_SYMBOL_GPL(device_register);
1128 EXPORT_SYMBOL_GPL(device_del);
1129 EXPORT_SYMBOL_GPL(device_unregister);
1130 EXPORT_SYMBOL_GPL(get_device);
1131 EXPORT_SYMBOL_GPL(put_device);
1133 EXPORT_SYMBOL_GPL(device_create_file);
1134 EXPORT_SYMBOL_GPL(device_remove_file);
1137 static void device_create_release(struct device *dev)
1139 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1140 kfree(dev);
1144 * device_create - creates a device and registers it with sysfs
1145 * @class: pointer to the struct class that this device should be registered to
1146 * @parent: pointer to the parent struct device of this new device, if any
1147 * @devt: the dev_t for the char device to be added
1148 * @fmt: string for the device's name
1150 * This function can be used by char device classes. A struct device
1151 * will be created in sysfs, registered to the specified class.
1153 * A "dev" file will be created, showing the dev_t for the device, if
1154 * the dev_t is not 0,0.
1155 * If a pointer to a parent struct device is passed in, the newly created
1156 * struct device will be a child of that device in sysfs.
1157 * The pointer to the struct device will be returned from the call.
1158 * Any further sysfs files that might be required can be created using this
1159 * pointer.
1161 * Note: the struct class passed to this function must have previously
1162 * been created with a call to class_create().
1164 struct device *device_create(struct class *class, struct device *parent,
1165 dev_t devt, const char *fmt, ...)
1167 va_list args;
1168 struct device *dev = NULL;
1169 int retval = -ENODEV;
1171 if (class == NULL || IS_ERR(class))
1172 goto error;
1174 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1175 if (!dev) {
1176 retval = -ENOMEM;
1177 goto error;
1180 dev->devt = devt;
1181 dev->class = class;
1182 dev->parent = parent;
1183 dev->release = device_create_release;
1185 va_start(args, fmt);
1186 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1187 va_end(args);
1188 retval = device_register(dev);
1189 if (retval)
1190 goto error;
1192 return dev;
1194 error:
1195 kfree(dev);
1196 return ERR_PTR(retval);
1198 EXPORT_SYMBOL_GPL(device_create);
1201 * device_destroy - removes a device that was created with device_create()
1202 * @class: pointer to the struct class that this device was registered with
1203 * @devt: the dev_t of the device that was previously registered
1205 * This call unregisters and cleans up a device that was created with a
1206 * call to device_create().
1208 void device_destroy(struct class *class, dev_t devt)
1210 struct device *dev = NULL;
1211 struct device *dev_tmp;
1213 down(&class->sem);
1214 list_for_each_entry(dev_tmp, &class->devices, node) {
1215 if (dev_tmp->devt == devt) {
1216 dev = dev_tmp;
1217 break;
1220 up(&class->sem);
1222 if (dev)
1223 device_unregister(dev);
1225 EXPORT_SYMBOL_GPL(device_destroy);
1228 * device_rename - renames a device
1229 * @dev: the pointer to the struct device to be renamed
1230 * @new_name: the new name of the device
1232 int device_rename(struct device *dev, char *new_name)
1234 char *old_class_name = NULL;
1235 char *new_class_name = NULL;
1236 char *old_device_name = NULL;
1237 int error;
1239 dev = get_device(dev);
1240 if (!dev)
1241 return -EINVAL;
1243 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1245 #ifdef CONFIG_SYSFS_DEPRECATED
1246 if ((dev->class) && (dev->parent))
1247 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1248 #endif
1250 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1251 if (!old_device_name) {
1252 error = -ENOMEM;
1253 goto out;
1255 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1256 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1258 error = kobject_rename(&dev->kobj, new_name);
1259 if (error) {
1260 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1261 goto out;
1264 #ifdef CONFIG_SYSFS_DEPRECATED
1265 if (old_class_name) {
1266 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1267 if (new_class_name) {
1268 error = sysfs_create_link(&dev->parent->kobj,
1269 &dev->kobj, new_class_name);
1270 if (error)
1271 goto out;
1272 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1275 #endif
1277 if (dev->class) {
1278 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1279 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1280 dev->bus_id);
1281 if (error) {
1282 /* Uh... how to unravel this if restoring can fail? */
1283 dev_err(dev, "%s: sysfs_create_symlink failed (%d)\n",
1284 __FUNCTION__, error);
1287 out:
1288 put_device(dev);
1290 kfree(new_class_name);
1291 kfree(old_class_name);
1292 kfree(old_device_name);
1294 return error;
1296 EXPORT_SYMBOL_GPL(device_rename);
1298 static int device_move_class_links(struct device *dev,
1299 struct device *old_parent,
1300 struct device *new_parent)
1302 int error = 0;
1303 #ifdef CONFIG_SYSFS_DEPRECATED
1304 char *class_name;
1306 class_name = make_class_name(dev->class->name, &dev->kobj);
1307 if (!class_name) {
1308 error = -ENOMEM;
1309 goto out;
1311 if (old_parent) {
1312 sysfs_remove_link(&dev->kobj, "device");
1313 sysfs_remove_link(&old_parent->kobj, class_name);
1315 if (new_parent) {
1316 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1317 "device");
1318 if (error)
1319 goto out;
1320 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1321 class_name);
1322 if (error)
1323 sysfs_remove_link(&dev->kobj, "device");
1325 else
1326 error = 0;
1327 out:
1328 kfree(class_name);
1329 return error;
1330 #else
1331 if (old_parent)
1332 sysfs_remove_link(&dev->kobj, "device");
1333 if (new_parent)
1334 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1335 "device");
1336 return error;
1337 #endif
1341 * device_move - moves a device to a new parent
1342 * @dev: the pointer to the struct device to be moved
1343 * @new_parent: the new parent of the device (can by NULL)
1345 int device_move(struct device *dev, struct device *new_parent)
1347 int error;
1348 struct device *old_parent;
1349 struct kobject *new_parent_kobj;
1351 dev = get_device(dev);
1352 if (!dev)
1353 return -EINVAL;
1355 new_parent = get_device(new_parent);
1356 new_parent_kobj = get_device_parent (dev, new_parent);
1357 if (IS_ERR(new_parent_kobj)) {
1358 error = PTR_ERR(new_parent_kobj);
1359 put_device(new_parent);
1360 goto out;
1362 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1363 new_parent ? new_parent->bus_id : "<NULL>");
1364 error = kobject_move(&dev->kobj, new_parent_kobj);
1365 if (error) {
1366 put_device(new_parent);
1367 goto out;
1369 old_parent = dev->parent;
1370 dev->parent = new_parent;
1371 if (old_parent)
1372 klist_remove(&dev->knode_parent);
1373 if (new_parent)
1374 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1375 if (!dev->class)
1376 goto out_put;
1377 error = device_move_class_links(dev, old_parent, new_parent);
1378 if (error) {
1379 /* We ignore errors on cleanup since we're hosed anyway... */
1380 device_move_class_links(dev, new_parent, old_parent);
1381 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1382 if (new_parent)
1383 klist_remove(&dev->knode_parent);
1384 if (old_parent)
1385 klist_add_tail(&dev->knode_parent,
1386 &old_parent->klist_children);
1388 put_device(new_parent);
1389 goto out;
1391 out_put:
1392 put_device(old_parent);
1393 out:
1394 put_device(dev);
1395 return error;
1398 EXPORT_SYMBOL_GPL(device_move);