kobject: get rid of kobject_add_dir
[safe/jmp/linux-2.6] / drivers / base / core.c
1 /*
2  * drivers/base/core.c - core driver model code (device registration, etc)
3  *
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.
8  *
9  * This file is released under the GPLv2
10  *
11  */
12
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>
21
22 #include <asm/semaphore.h>
23
24 #include "base.h"
25 #include "power/power.h"
26
27 int (*platform_notify)(struct device * dev) = NULL;
28 int (*platform_notify_remove)(struct device * dev) = NULL;
29
30 /*
31  * sysfs bindings for devices.
32  */
33
34 /**
35  * dev_driver_string - Return a device's driver name, if at all possible
36  * @dev: struct device to get the name of
37  *
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.
42  */
43 const char *dev_driver_string(struct device *dev)
44 {
45         return dev->driver ? dev->driver->name :
46                         (dev->bus ? dev->bus->name :
47                         (dev->class ? dev->class->name : ""));
48 }
49 EXPORT_SYMBOL(dev_driver_string);
50
51 #define to_dev(obj) container_of(obj, struct device, kobj)
52 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
53
54 static ssize_t
55 dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
56 {
57         struct device_attribute * dev_attr = to_dev_attr(attr);
58         struct device * dev = to_dev(kobj);
59         ssize_t ret = -EIO;
60
61         if (dev_attr->show)
62                 ret = dev_attr->show(dev, dev_attr, buf);
63         return ret;
64 }
65
66 static ssize_t
67 dev_attr_store(struct kobject * kobj, struct attribute * attr,
68                const char * buf, size_t count)
69 {
70         struct device_attribute * dev_attr = to_dev_attr(attr);
71         struct device * dev = to_dev(kobj);
72         ssize_t ret = -EIO;
73
74         if (dev_attr->store)
75                 ret = dev_attr->store(dev, dev_attr, buf, count);
76         return ret;
77 }
78
79 static struct sysfs_ops dev_sysfs_ops = {
80         .show   = dev_attr_show,
81         .store  = dev_attr_store,
82 };
83
84
85 /**
86  *      device_release - free device structure.
87  *      @kobj:  device's kobject.
88  *
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.
92  */
93 static void device_release(struct kobject * kobj)
94 {
95         struct device * dev = to_dev(kobj);
96
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);
108         }
109 }
110
111 static struct kobj_type device_ktype = {
112         .release        = device_release,
113         .sysfs_ops      = &dev_sysfs_ops,
114 };
115
116
117 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
118 {
119         struct kobj_type *ktype = get_ktype(kobj);
120
121         if (ktype == &device_ktype) {
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;
129         }
130         return 0;
131 }
132
133 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
134 {
135         struct device *dev = to_dev(kobj);
136
137         if (dev->bus)
138                 return dev->bus->name;
139         if (dev->class)
140                 return dev->class->name;
141         return NULL;
142 }
143
144 static int dev_uevent(struct kset *kset, struct kobject *kobj,
145                       struct kobj_uevent_env *env)
146 {
147         struct device *dev = to_dev(kobj);
148         int retval = 0;
149
150         /* add the major/minor if present */
151         if (MAJOR(dev->devt)) {
152                 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
153                 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
154         }
155
156         if (dev->type && dev->type->name)
157                 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
158
159         if (dev->driver)
160                 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
161
162 #ifdef CONFIG_SYSFS_DEPRECATED
163         if (dev->class) {
164                 struct device *parent = dev->parent;
165
166                 /* find first bus device in parent chain */
167                 while (parent && !parent->bus)
168                         parent = parent->parent;
169                 if (parent && parent->bus) {
170                         const char *path;
171
172                         path = kobject_get_path(&parent->kobj, GFP_KERNEL);
173                         if (path) {
174                                 add_uevent_var(env, "PHYSDEVPATH=%s", path);
175                                 kfree(path);
176                         }
177
178                         add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
179
180                         if (parent->driver)
181                                 add_uevent_var(env, "PHYSDEVDRIVER=%s",
182                                                parent->driver->name);
183                 }
184         } else if (dev->bus) {
185                 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
186
187                 if (dev->driver)
188                         add_uevent_var(env, "PHYSDEVDRIVER=%s", dev->driver->name);
189         }
190 #endif
191
192         /* have the bus specific function add its stuff */
193         if (dev->bus && dev->bus->uevent) {
194                 retval = dev->bus->uevent(dev, env);
195                 if (retval)
196                         pr_debug ("%s: bus uevent() returned %d\n",
197                                   __FUNCTION__, retval);
198         }
199
200         /* have the class specific function add its stuff */
201         if (dev->class && dev->class->dev_uevent) {
202                 retval = dev->class->dev_uevent(dev, env);
203                 if (retval)
204                         pr_debug("%s: class uevent() returned %d\n",
205                                  __FUNCTION__, retval);
206         }
207
208         /* have the device type specific fuction add its stuff */
209         if (dev->type && dev->type->uevent) {
210                 retval = dev->type->uevent(dev, env);
211                 if (retval)
212                         pr_debug("%s: dev_type uevent() returned %d\n",
213                                  __FUNCTION__, retval);
214         }
215
216         return retval;
217 }
218
219 static struct kset_uevent_ops device_uevent_ops = {
220         .filter =       dev_uevent_filter,
221         .name =         dev_uevent_name,
222         .uevent =       dev_uevent,
223 };
224
225 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
226                            char *buf)
227 {
228         struct kobject *top_kobj;
229         struct kset *kset;
230         struct kobj_uevent_env *env = NULL;
231         int i;
232         size_t count = 0;
233         int retval;
234
235         /* search the kset, the device belongs to */
236         top_kobj = &dev->kobj;
237         while (!top_kobj->kset && top_kobj->parent)
238                 top_kobj = top_kobj->parent;
239         if (!top_kobj->kset)
240                 goto out;
241
242         kset = top_kobj->kset;
243         if (!kset->uevent_ops || !kset->uevent_ops->uevent)
244                 goto out;
245
246         /* respect filter */
247         if (kset->uevent_ops && kset->uevent_ops->filter)
248                 if (!kset->uevent_ops->filter(kset, &dev->kobj))
249                         goto out;
250
251         env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
252         if (!env)
253                 return -ENOMEM;
254
255         /* let the kset specific function add its keys */
256         retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
257         if (retval)
258                 goto out;
259
260         /* copy keys to file */
261         for (i = 0; i < env->envp_idx; i++)
262                 count += sprintf(&buf[count], "%s\n", env->envp[i]);
263 out:
264         kfree(env);
265         return count;
266 }
267
268 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
269                             const char *buf, size_t count)
270 {
271         enum kobject_action action;
272
273         if (kobject_action_type(buf, count, &action) == 0) {
274                 kobject_uevent(&dev->kobj, action);
275                 goto out;
276         }
277
278         dev_err(dev, "uevent: unsupported action-string; this will "
279                      "be ignored in a future kernel version\n");
280         kobject_uevent(&dev->kobj, KOBJ_ADD);
281 out:
282         return count;
283 }
284
285 static struct device_attribute uevent_attr =
286         __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
287
288 static int device_add_attributes(struct device *dev,
289                                  struct device_attribute *attrs)
290 {
291         int error = 0;
292         int i;
293
294         if (attrs) {
295                 for (i = 0; attr_name(attrs[i]); i++) {
296                         error = device_create_file(dev, &attrs[i]);
297                         if (error)
298                                 break;
299                 }
300                 if (error)
301                         while (--i >= 0)
302                                 device_remove_file(dev, &attrs[i]);
303         }
304         return error;
305 }
306
307 static void device_remove_attributes(struct device *dev,
308                                      struct device_attribute *attrs)
309 {
310         int i;
311
312         if (attrs)
313                 for (i = 0; attr_name(attrs[i]); i++)
314                         device_remove_file(dev, &attrs[i]);
315 }
316
317 static int device_add_groups(struct device *dev,
318                              struct attribute_group **groups)
319 {
320         int error = 0;
321         int i;
322
323         if (groups) {
324                 for (i = 0; groups[i]; i++) {
325                         error = sysfs_create_group(&dev->kobj, groups[i]);
326                         if (error) {
327                                 while (--i >= 0)
328                                         sysfs_remove_group(&dev->kobj, groups[i]);
329                                 break;
330                         }
331                 }
332         }
333         return error;
334 }
335
336 static void device_remove_groups(struct device *dev,
337                                  struct attribute_group **groups)
338 {
339         int i;
340
341         if (groups)
342                 for (i = 0; groups[i]; i++)
343                         sysfs_remove_group(&dev->kobj, groups[i]);
344 }
345
346 static int device_add_attrs(struct device *dev)
347 {
348         struct class *class = dev->class;
349         struct device_type *type = dev->type;
350         int error;
351
352         if (class) {
353                 error = device_add_attributes(dev, class->dev_attrs);
354                 if (error)
355                         return error;
356         }
357
358         if (type) {
359                 error = device_add_groups(dev, type->groups);
360                 if (error)
361                         goto err_remove_class_attrs;
362         }
363
364         error = device_add_groups(dev, dev->groups);
365         if (error)
366                 goto err_remove_type_groups;
367
368         return 0;
369
370  err_remove_type_groups:
371         if (type)
372                 device_remove_groups(dev, type->groups);
373  err_remove_class_attrs:
374         if (class)
375                 device_remove_attributes(dev, class->dev_attrs);
376
377         return error;
378 }
379
380 static void device_remove_attrs(struct device *dev)
381 {
382         struct class *class = dev->class;
383         struct device_type *type = dev->type;
384
385         device_remove_groups(dev, dev->groups);
386
387         if (type)
388                 device_remove_groups(dev, type->groups);
389
390         if (class)
391                 device_remove_attributes(dev, class->dev_attrs);
392 }
393
394
395 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
396                         char *buf)
397 {
398         return print_dev_t(buf, dev->devt);
399 }
400
401 static struct device_attribute devt_attr =
402         __ATTR(dev, S_IRUGO, show_dev, NULL);
403
404 /*
405  *      devices_subsys - structure to be registered with kobject core.
406  */
407
408 decl_subsys(devices, &device_uevent_ops);
409
410
411 /**
412  *      device_create_file - create sysfs attribute file for device.
413  *      @dev:   device.
414  *      @attr:  device attribute descriptor.
415  */
416
417 int device_create_file(struct device * dev, struct device_attribute * attr)
418 {
419         int error = 0;
420         if (get_device(dev)) {
421                 error = sysfs_create_file(&dev->kobj, &attr->attr);
422                 put_device(dev);
423         }
424         return error;
425 }
426
427 /**
428  *      device_remove_file - remove sysfs attribute file.
429  *      @dev:   device.
430  *      @attr:  device attribute descriptor.
431  */
432
433 void device_remove_file(struct device * dev, struct device_attribute * attr)
434 {
435         if (get_device(dev)) {
436                 sysfs_remove_file(&dev->kobj, &attr->attr);
437                 put_device(dev);
438         }
439 }
440
441 /**
442  * device_create_bin_file - create sysfs binary attribute file for device.
443  * @dev: device.
444  * @attr: device binary attribute descriptor.
445  */
446 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
447 {
448         int error = -EINVAL;
449         if (dev)
450                 error = sysfs_create_bin_file(&dev->kobj, attr);
451         return error;
452 }
453 EXPORT_SYMBOL_GPL(device_create_bin_file);
454
455 /**
456  * device_remove_bin_file - remove sysfs binary attribute file
457  * @dev: device.
458  * @attr: device binary attribute descriptor.
459  */
460 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
461 {
462         if (dev)
463                 sysfs_remove_bin_file(&dev->kobj, attr);
464 }
465 EXPORT_SYMBOL_GPL(device_remove_bin_file);
466
467 /**
468  * device_schedule_callback_owner - helper to schedule a callback for a device
469  * @dev: device.
470  * @func: callback function to invoke later.
471  * @owner: module owning the callback routine
472  *
473  * Attribute methods must not unregister themselves or their parent device
474  * (which would amount to the same thing).  Attempts to do so will deadlock,
475  * since unregistration is mutually exclusive with driver callbacks.
476  *
477  * Instead methods can call this routine, which will attempt to allocate
478  * and schedule a workqueue request to call back @func with @dev as its
479  * argument in the workqueue's process context.  @dev will be pinned until
480  * @func returns.
481  *
482  * This routine is usually called via the inline device_schedule_callback(),
483  * which automatically sets @owner to THIS_MODULE.
484  *
485  * Returns 0 if the request was submitted, -ENOMEM if storage could not
486  * be allocated, -ENODEV if a reference to @owner isn't available.
487  *
488  * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
489  * underlying sysfs routine (since it is intended for use by attribute
490  * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
491  */
492 int device_schedule_callback_owner(struct device *dev,
493                 void (*func)(struct device *), struct module *owner)
494 {
495         return sysfs_schedule_callback(&dev->kobj,
496                         (void (*)(void *)) func, dev, owner);
497 }
498 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
499
500 static void klist_children_get(struct klist_node *n)
501 {
502         struct device *dev = container_of(n, struct device, knode_parent);
503
504         get_device(dev);
505 }
506
507 static void klist_children_put(struct klist_node *n)
508 {
509         struct device *dev = container_of(n, struct device, knode_parent);
510
511         put_device(dev);
512 }
513
514
515 /**
516  *      device_initialize - init device structure.
517  *      @dev:   device.
518  *
519  *      This prepares the device for use by other layers,
520  *      including adding it to the device hierarchy.
521  *      It is the first half of device_register(), if called by
522  *      that, though it can also be called separately, so one
523  *      may use @dev's fields (e.g. the refcount).
524  */
525
526 void device_initialize(struct device *dev)
527 {
528         dev->kobj.kset = &devices_subsys;
529         dev->kobj.ktype = &device_ktype;
530         kobject_init(&dev->kobj);
531         klist_init(&dev->klist_children, klist_children_get,
532                    klist_children_put);
533         INIT_LIST_HEAD(&dev->dma_pools);
534         INIT_LIST_HEAD(&dev->node);
535         init_MUTEX(&dev->sem);
536         spin_lock_init(&dev->devres_lock);
537         INIT_LIST_HEAD(&dev->devres_head);
538         device_init_wakeup(dev, 0);
539         set_dev_node(dev, -1);
540 }
541
542 #ifdef CONFIG_SYSFS_DEPRECATED
543 static struct kobject * get_device_parent(struct device *dev,
544                                           struct device *parent)
545 {
546         /*
547          * Set the parent to the class, not the parent device
548          * for topmost devices in class hierarchy.
549          * This keeps sysfs from having a symlink to make old
550          * udevs happy
551          */
552         if (dev->class && (!parent || parent->class != dev->class))
553                 return &dev->class->subsys.kobj;
554         else if (parent)
555                 return &parent->kobj;
556
557         return NULL;
558 }
559 #else
560 static struct kobject *virtual_device_parent(struct device *dev)
561 {
562         static struct kobject *virtual_dir = NULL;
563
564         if (!virtual_dir)
565                 virtual_dir = kobject_create_and_add("virtual",
566                                                      &devices_subsys.kobj);
567
568         return virtual_dir;
569 }
570
571 static struct kobject * get_device_parent(struct device *dev,
572                                           struct device *parent)
573 {
574         if (dev->class) {
575                 struct kobject *kobj = NULL;
576                 struct kobject *parent_kobj;
577                 struct kobject *k;
578
579                 /*
580                  * If we have no parent, we live in "virtual".
581                  * Class-devices with a bus-device as parent, live
582                  * in a class-directory to prevent namespace collisions.
583                  */
584                 if (parent == NULL)
585                         parent_kobj = virtual_device_parent(dev);
586                 else if (parent->class)
587                         return &parent->kobj;
588                 else
589                         parent_kobj = &parent->kobj;
590
591                 /* find our class-directory at the parent and reference it */
592                 spin_lock(&dev->class->class_dirs.list_lock);
593                 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
594                         if (k->parent == parent_kobj) {
595                                 kobj = kobject_get(k);
596                                 break;
597                         }
598                 spin_unlock(&dev->class->class_dirs.list_lock);
599                 if (kobj)
600                         return kobj;
601
602                 /* or create a new class-directory at the parent device */
603                 return kobject_kset_add_dir(&dev->class->class_dirs,
604                                             parent_kobj, dev->class->name);
605         }
606
607         if (parent)
608                 return &parent->kobj;
609         return NULL;
610 }
611 #endif
612
613 static int setup_parent(struct device *dev, struct device *parent)
614 {
615         struct kobject *kobj;
616         kobj = get_device_parent(dev, parent);
617         if (IS_ERR(kobj))
618                 return PTR_ERR(kobj);
619         if (kobj)
620                 dev->kobj.parent = kobj;
621         return 0;
622 }
623
624 static int device_add_class_symlinks(struct device *dev)
625 {
626         int error;
627
628         if (!dev->class)
629                 return 0;
630         error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
631                                   "subsystem");
632         if (error)
633                 goto out;
634         /*
635          * If this is not a "fake" compatible device, then create the
636          * symlink from the class to the device.
637          */
638         if (dev->kobj.parent != &dev->class->subsys.kobj) {
639                 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
640                                           dev->bus_id);
641                 if (error)
642                         goto out_subsys;
643         }
644         if (dev->parent) {
645 #ifdef CONFIG_SYSFS_DEPRECATED
646                 {
647                         struct device *parent = dev->parent;
648                         char *class_name;
649
650                         /*
651                          * In old sysfs stacked class devices had 'device'
652                          * link pointing to real device instead of parent
653                          */
654                         while (parent->class && !parent->bus && parent->parent)
655                                 parent = parent->parent;
656
657                         error = sysfs_create_link(&dev->kobj,
658                                                   &parent->kobj,
659                                                   "device");
660                         if (error)
661                                 goto out_busid;
662
663                         class_name = make_class_name(dev->class->name,
664                                                         &dev->kobj);
665                         if (class_name)
666                                 error = sysfs_create_link(&dev->parent->kobj,
667                                                         &dev->kobj, class_name);
668                         kfree(class_name);
669                         if (error)
670                                 goto out_device;
671                 }
672 #else
673                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
674                                           "device");
675                 if (error)
676                         goto out_busid;
677 #endif
678         }
679         return 0;
680
681 #ifdef CONFIG_SYSFS_DEPRECATED
682 out_device:
683         if (dev->parent)
684                 sysfs_remove_link(&dev->kobj, "device");
685 #endif
686 out_busid:
687         if (dev->kobj.parent != &dev->class->subsys.kobj)
688                 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
689 out_subsys:
690         sysfs_remove_link(&dev->kobj, "subsystem");
691 out:
692         return error;
693 }
694
695 static void device_remove_class_symlinks(struct device *dev)
696 {
697         if (!dev->class)
698                 return;
699         if (dev->parent) {
700 #ifdef CONFIG_SYSFS_DEPRECATED
701                 char *class_name;
702
703                 class_name = make_class_name(dev->class->name, &dev->kobj);
704                 if (class_name) {
705                         sysfs_remove_link(&dev->parent->kobj, class_name);
706                         kfree(class_name);
707                 }
708 #endif
709                 sysfs_remove_link(&dev->kobj, "device");
710         }
711         if (dev->kobj.parent != &dev->class->subsys.kobj)
712                 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
713         sysfs_remove_link(&dev->kobj, "subsystem");
714 }
715
716 /**
717  *      device_add - add device to device hierarchy.
718  *      @dev:   device.
719  *
720  *      This is part 2 of device_register(), though may be called
721  *      separately _iff_ device_initialize() has been called separately.
722  *
723  *      This adds it to the kobject hierarchy via kobject_add(), adds it
724  *      to the global and sibling lists for the device, then
725  *      adds it to the other relevant subsystems of the driver model.
726  */
727 int device_add(struct device *dev)
728 {
729         struct device *parent = NULL;
730         struct class_interface *class_intf;
731         int error;
732
733         error = pm_sleep_lock();
734         if (error) {
735                 dev_warn(dev, "Suspicious %s during suspend\n", __FUNCTION__);
736                 dump_stack();
737                 return error;
738         }
739
740         dev = get_device(dev);
741         if (!dev || !strlen(dev->bus_id)) {
742                 error = -EINVAL;
743                 goto Error;
744         }
745
746         pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
747
748         parent = get_device(dev->parent);
749         error = setup_parent(dev, parent);
750         if (error)
751                 goto Error;
752
753         /* first, register with generic layer. */
754         kobject_set_name(&dev->kobj, "%s", dev->bus_id);
755         error = kobject_add(&dev->kobj);
756         if (error)
757                 goto Error;
758
759         /* notify platform of device entry */
760         if (platform_notify)
761                 platform_notify(dev);
762
763         /* notify clients of device entry (new way) */
764         if (dev->bus)
765                 blocking_notifier_call_chain(&dev->bus->bus_notifier,
766                                              BUS_NOTIFY_ADD_DEVICE, dev);
767
768         error = device_create_file(dev, &uevent_attr);
769         if (error)
770                 goto attrError;
771
772         if (MAJOR(dev->devt)) {
773                 error = device_create_file(dev, &devt_attr);
774                 if (error)
775                         goto ueventattrError;
776         }
777
778         error = device_add_class_symlinks(dev);
779         if (error)
780                 goto SymlinkError;
781         error = device_add_attrs(dev);
782         if (error)
783                 goto AttrsError;
784         error = dpm_sysfs_add(dev);
785         if (error)
786                 goto PMError;
787         device_pm_add(dev);
788         error = bus_add_device(dev);
789         if (error)
790                 goto BusError;
791         kobject_uevent(&dev->kobj, KOBJ_ADD);
792         bus_attach_device(dev);
793         if (parent)
794                 klist_add_tail(&dev->knode_parent, &parent->klist_children);
795
796         if (dev->class) {
797                 down(&dev->class->sem);
798                 /* tie the class to the device */
799                 list_add_tail(&dev->node, &dev->class->devices);
800
801                 /* notify any interfaces that the device is here */
802                 list_for_each_entry(class_intf, &dev->class->interfaces, node)
803                         if (class_intf->add_dev)
804                                 class_intf->add_dev(dev, class_intf);
805                 up(&dev->class->sem);
806         }
807  Done:
808         put_device(dev);
809         pm_sleep_unlock();
810         return error;
811  BusError:
812         device_pm_remove(dev);
813         dpm_sysfs_remove(dev);
814  PMError:
815         if (dev->bus)
816                 blocking_notifier_call_chain(&dev->bus->bus_notifier,
817                                              BUS_NOTIFY_DEL_DEVICE, dev);
818         device_remove_attrs(dev);
819  AttrsError:
820         device_remove_class_symlinks(dev);
821  SymlinkError:
822         if (MAJOR(dev->devt))
823                 device_remove_file(dev, &devt_attr);
824
825         if (dev->class) {
826                 sysfs_remove_link(&dev->kobj, "subsystem");
827                 /* If this is not a "fake" compatible device, remove the
828                  * symlink from the class to the device. */
829                 if (dev->kobj.parent != &dev->class->subsys.kobj)
830                         sysfs_remove_link(&dev->class->subsys.kobj,
831                                           dev->bus_id);
832                 if (parent) {
833 #ifdef CONFIG_SYSFS_DEPRECATED
834                         char *class_name = make_class_name(dev->class->name,
835                                                            &dev->kobj);
836                         if (class_name)
837                                 sysfs_remove_link(&dev->parent->kobj,
838                                                   class_name);
839                         kfree(class_name);
840 #endif
841                         sysfs_remove_link(&dev->kobj, "device");
842                 }
843         }
844  ueventattrError:
845         device_remove_file(dev, &uevent_attr);
846  attrError:
847         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
848         kobject_del(&dev->kobj);
849  Error:
850         if (parent)
851                 put_device(parent);
852         goto Done;
853 }
854
855
856 /**
857  *      device_register - register a device with the system.
858  *      @dev:   pointer to the device structure
859  *
860  *      This happens in two clean steps - initialize the device
861  *      and add it to the system. The two steps can be called
862  *      separately, but this is the easiest and most common.
863  *      I.e. you should only call the two helpers separately if
864  *      have a clearly defined need to use and refcount the device
865  *      before it is added to the hierarchy.
866  */
867
868 int device_register(struct device *dev)
869 {
870         device_initialize(dev);
871         return device_add(dev);
872 }
873
874
875 /**
876  *      get_device - increment reference count for device.
877  *      @dev:   device.
878  *
879  *      This simply forwards the call to kobject_get(), though
880  *      we do take care to provide for the case that we get a NULL
881  *      pointer passed in.
882  */
883
884 struct device * get_device(struct device * dev)
885 {
886         return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
887 }
888
889
890 /**
891  *      put_device - decrement reference count.
892  *      @dev:   device in question.
893  */
894 void put_device(struct device * dev)
895 {
896         if (dev)
897                 kobject_put(&dev->kobj);
898 }
899
900
901 /**
902  *      device_del - delete device from system.
903  *      @dev:   device.
904  *
905  *      This is the first part of the device unregistration
906  *      sequence. This removes the device from the lists we control
907  *      from here, has it removed from the other driver model
908  *      subsystems it was added to in device_add(), and removes it
909  *      from the kobject hierarchy.
910  *
911  *      NOTE: this should be called manually _iff_ device_add() was
912  *      also called manually.
913  */
914
915 void device_del(struct device * dev)
916 {
917         struct device * parent = dev->parent;
918         struct class_interface *class_intf;
919
920         device_pm_remove(dev);
921         if (parent)
922                 klist_del(&dev->knode_parent);
923         if (MAJOR(dev->devt))
924                 device_remove_file(dev, &devt_attr);
925         if (dev->class) {
926                 sysfs_remove_link(&dev->kobj, "subsystem");
927                 /* If this is not a "fake" compatible device, remove the
928                  * symlink from the class to the device. */
929                 if (dev->kobj.parent != &dev->class->subsys.kobj)
930                         sysfs_remove_link(&dev->class->subsys.kobj,
931                                           dev->bus_id);
932                 if (parent) {
933 #ifdef CONFIG_SYSFS_DEPRECATED
934                         char *class_name = make_class_name(dev->class->name,
935                                                            &dev->kobj);
936                         if (class_name)
937                                 sysfs_remove_link(&dev->parent->kobj,
938                                                   class_name);
939                         kfree(class_name);
940 #endif
941                         sysfs_remove_link(&dev->kobj, "device");
942                 }
943
944                 down(&dev->class->sem);
945                 /* notify any interfaces that the device is now gone */
946                 list_for_each_entry(class_intf, &dev->class->interfaces, node)
947                         if (class_intf->remove_dev)
948                                 class_intf->remove_dev(dev, class_intf);
949                 /* remove the device from the class list */
950                 list_del_init(&dev->node);
951                 up(&dev->class->sem);
952
953                 /* If we live in a parent class-directory, unreference it */
954                 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
955                         struct device *d;
956                         int other = 0;
957
958                         /*
959                          * if we are the last child of our class, delete
960                          * our class-directory at this parent
961                          */
962                         down(&dev->class->sem);
963                         list_for_each_entry(d, &dev->class->devices, node) {
964                                 if (d == dev)
965                                         continue;
966                                 if (d->kobj.parent == dev->kobj.parent) {
967                                         other = 1;
968                                         break;
969                                 }
970                         }
971                         if (!other)
972                                 kobject_del(dev->kobj.parent);
973
974                         kobject_put(dev->kobj.parent);
975                         up(&dev->class->sem);
976                 }
977         }
978         device_remove_file(dev, &uevent_attr);
979         device_remove_attrs(dev);
980         bus_remove_device(dev);
981
982         /*
983          * Some platform devices are driven without driver attached
984          * and managed resources may have been acquired.  Make sure
985          * all resources are released.
986          */
987         devres_release_all(dev);
988
989         /* Notify the platform of the removal, in case they
990          * need to do anything...
991          */
992         if (platform_notify_remove)
993                 platform_notify_remove(dev);
994         if (dev->bus)
995                 blocking_notifier_call_chain(&dev->bus->bus_notifier,
996                                              BUS_NOTIFY_DEL_DEVICE, dev);
997         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
998         kobject_del(&dev->kobj);
999         if (parent)
1000                 put_device(parent);
1001 }
1002
1003 /**
1004  *      device_unregister - unregister device from system.
1005  *      @dev:   device going away.
1006  *
1007  *      We do this in two parts, like we do device_register(). First,
1008  *      we remove it from all the subsystems with device_del(), then
1009  *      we decrement the reference count via put_device(). If that
1010  *      is the final reference count, the device will be cleaned up
1011  *      via device_release() above. Otherwise, the structure will
1012  *      stick around until the final reference to the device is dropped.
1013  */
1014 void device_unregister(struct device * dev)
1015 {
1016         pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
1017         device_del(dev);
1018         put_device(dev);
1019 }
1020
1021
1022 static struct device * next_device(struct klist_iter * i)
1023 {
1024         struct klist_node * n = klist_next(i);
1025         return n ? container_of(n, struct device, knode_parent) : NULL;
1026 }
1027
1028 /**
1029  *      device_for_each_child - device child iterator.
1030  *      @parent: parent struct device.
1031  *      @data:  data for the callback.
1032  *      @fn:    function to be called for each device.
1033  *
1034  *      Iterate over @parent's child devices, and call @fn for each,
1035  *      passing it @data.
1036  *
1037  *      We check the return of @fn each time. If it returns anything
1038  *      other than 0, we break out and return that value.
1039  */
1040 int device_for_each_child(struct device * parent, void * data,
1041                      int (*fn)(struct device *, void *))
1042 {
1043         struct klist_iter i;
1044         struct device * child;
1045         int error = 0;
1046
1047         klist_iter_init(&parent->klist_children, &i);
1048         while ((child = next_device(&i)) && !error)
1049                 error = fn(child, data);
1050         klist_iter_exit(&i);
1051         return error;
1052 }
1053
1054 /**
1055  * device_find_child - device iterator for locating a particular device.
1056  * @parent: parent struct device
1057  * @data: Data to pass to match function
1058  * @match: Callback function to check device
1059  *
1060  * This is similar to the device_for_each_child() function above, but it
1061  * returns a reference to a device that is 'found' for later use, as
1062  * determined by the @match callback.
1063  *
1064  * The callback should return 0 if the device doesn't match and non-zero
1065  * if it does.  If the callback returns non-zero and a reference to the
1066  * current device can be obtained, this function will return to the caller
1067  * and not iterate over any more devices.
1068  */
1069 struct device * device_find_child(struct device *parent, void *data,
1070                                   int (*match)(struct device *, void *))
1071 {
1072         struct klist_iter i;
1073         struct device *child;
1074
1075         if (!parent)
1076                 return NULL;
1077
1078         klist_iter_init(&parent->klist_children, &i);
1079         while ((child = next_device(&i)))
1080                 if (match(child, data) && get_device(child))
1081                         break;
1082         klist_iter_exit(&i);
1083         return child;
1084 }
1085
1086 int __init devices_init(void)
1087 {
1088         return subsystem_register(&devices_subsys);
1089 }
1090
1091 EXPORT_SYMBOL_GPL(device_for_each_child);
1092 EXPORT_SYMBOL_GPL(device_find_child);
1093
1094 EXPORT_SYMBOL_GPL(device_initialize);
1095 EXPORT_SYMBOL_GPL(device_add);
1096 EXPORT_SYMBOL_GPL(device_register);
1097
1098 EXPORT_SYMBOL_GPL(device_del);
1099 EXPORT_SYMBOL_GPL(device_unregister);
1100 EXPORT_SYMBOL_GPL(get_device);
1101 EXPORT_SYMBOL_GPL(put_device);
1102
1103 EXPORT_SYMBOL_GPL(device_create_file);
1104 EXPORT_SYMBOL_GPL(device_remove_file);
1105
1106
1107 static void device_create_release(struct device *dev)
1108 {
1109         pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1110         kfree(dev);
1111 }
1112
1113 /**
1114  * device_create - creates a device and registers it with sysfs
1115  * @class: pointer to the struct class that this device should be registered to
1116  * @parent: pointer to the parent struct device of this new device, if any
1117  * @devt: the dev_t for the char device to be added
1118  * @fmt: string for the device's name
1119  *
1120  * This function can be used by char device classes.  A struct device
1121  * will be created in sysfs, registered to the specified class.
1122  *
1123  * A "dev" file will be created, showing the dev_t for the device, if
1124  * the dev_t is not 0,0.
1125  * If a pointer to a parent struct device is passed in, the newly created
1126  * struct device will be a child of that device in sysfs.
1127  * The pointer to the struct device will be returned from the call.
1128  * Any further sysfs files that might be required can be created using this
1129  * pointer.
1130  *
1131  * Note: the struct class passed to this function must have previously
1132  * been created with a call to class_create().
1133  */
1134 struct device *device_create(struct class *class, struct device *parent,
1135                              dev_t devt, const char *fmt, ...)
1136 {
1137         va_list args;
1138         struct device *dev = NULL;
1139         int retval = -ENODEV;
1140
1141         if (class == NULL || IS_ERR(class))
1142                 goto error;
1143
1144         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1145         if (!dev) {
1146                 retval = -ENOMEM;
1147                 goto error;
1148         }
1149
1150         dev->devt = devt;
1151         dev->class = class;
1152         dev->parent = parent;
1153         dev->release = device_create_release;
1154
1155         va_start(args, fmt);
1156         vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1157         va_end(args);
1158         retval = device_register(dev);
1159         if (retval)
1160                 goto error;
1161
1162         return dev;
1163
1164 error:
1165         kfree(dev);
1166         return ERR_PTR(retval);
1167 }
1168 EXPORT_SYMBOL_GPL(device_create);
1169
1170 /**
1171  * find_device - finds a device that was created with device_create()
1172  * @class: pointer to the struct class that this device was registered with
1173  * @devt: the dev_t of the device that was previously registered
1174  */
1175 static struct device *find_device(struct class *class, dev_t devt)
1176 {
1177         struct device *dev = NULL;
1178         struct device *dev_tmp;
1179
1180         down(&class->sem);
1181         list_for_each_entry(dev_tmp, &class->devices, node) {
1182                 if (dev_tmp->devt == devt) {
1183                         dev = dev_tmp;
1184                         break;
1185                 }
1186         }
1187         up(&class->sem);
1188         return dev;
1189 }
1190
1191 /**
1192  * device_destroy - removes a device that was created with device_create()
1193  * @class: pointer to the struct class that this device was registered with
1194  * @devt: the dev_t of the device that was previously registered
1195  *
1196  * This call unregisters and cleans up a device that was created with a
1197  * call to device_create().
1198  */
1199 void device_destroy(struct class *class, dev_t devt)
1200 {
1201         struct device *dev;
1202
1203         dev = find_device(class, devt);
1204         if (dev)
1205                 device_unregister(dev);
1206 }
1207 EXPORT_SYMBOL_GPL(device_destroy);
1208
1209 #ifdef CONFIG_PM_SLEEP
1210 /**
1211  * destroy_suspended_device - asks the PM core to remove a suspended device
1212  * @class: pointer to the struct class that this device was registered with
1213  * @devt: the dev_t of the device that was previously registered
1214  *
1215  * This call notifies the PM core of the necessity to unregister a suspended
1216  * device created with a call to device_create() (devices cannot be
1217  * unregistered directly while suspended, since the PM core holds their
1218  * semaphores at that time).
1219  *
1220  * It can only be called within the scope of a system sleep transition.  In
1221  * practice this means it has to be directly or indirectly invoked either by
1222  * a suspend or resume method, or by the PM core (e.g. via
1223  * disable_nonboot_cpus() or enable_nonboot_cpus()).
1224  */
1225 void destroy_suspended_device(struct class *class, dev_t devt)
1226 {
1227         struct device *dev;
1228
1229         dev = find_device(class, devt);
1230         if (dev)
1231                 device_pm_schedule_removal(dev);
1232 }
1233 EXPORT_SYMBOL_GPL(destroy_suspended_device);
1234 #endif /* CONFIG_PM_SLEEP */
1235
1236 /**
1237  * device_rename - renames a device
1238  * @dev: the pointer to the struct device to be renamed
1239  * @new_name: the new name of the device
1240  */
1241 int device_rename(struct device *dev, char *new_name)
1242 {
1243         char *old_class_name = NULL;
1244         char *new_class_name = NULL;
1245         char *old_device_name = NULL;
1246         int error;
1247
1248         dev = get_device(dev);
1249         if (!dev)
1250                 return -EINVAL;
1251
1252         pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1253
1254 #ifdef CONFIG_SYSFS_DEPRECATED
1255         if ((dev->class) && (dev->parent))
1256                 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1257 #endif
1258
1259         old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1260         if (!old_device_name) {
1261                 error = -ENOMEM;
1262                 goto out;
1263         }
1264         strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1265         strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1266
1267         error = kobject_rename(&dev->kobj, new_name);
1268         if (error) {
1269                 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1270                 goto out;
1271         }
1272
1273 #ifdef CONFIG_SYSFS_DEPRECATED
1274         if (old_class_name) {
1275                 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1276                 if (new_class_name) {
1277                         error = sysfs_create_link(&dev->parent->kobj,
1278                                                   &dev->kobj, new_class_name);
1279                         if (error)
1280                                 goto out;
1281                         sysfs_remove_link(&dev->parent->kobj, old_class_name);
1282                 }
1283         }
1284 #else
1285         if (dev->class) {
1286                 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1287                 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1288                                           dev->bus_id);
1289                 if (error) {
1290                         dev_err(dev, "%s: sysfs_create_symlink failed (%d)\n",
1291                                 __FUNCTION__, error);
1292                 }
1293         }
1294 #endif
1295
1296 out:
1297         put_device(dev);
1298
1299         kfree(new_class_name);
1300         kfree(old_class_name);
1301         kfree(old_device_name);
1302
1303         return error;
1304 }
1305 EXPORT_SYMBOL_GPL(device_rename);
1306
1307 static int device_move_class_links(struct device *dev,
1308                                    struct device *old_parent,
1309                                    struct device *new_parent)
1310 {
1311         int error = 0;
1312 #ifdef CONFIG_SYSFS_DEPRECATED
1313         char *class_name;
1314
1315         class_name = make_class_name(dev->class->name, &dev->kobj);
1316         if (!class_name) {
1317                 error = -ENOMEM;
1318                 goto out;
1319         }
1320         if (old_parent) {
1321                 sysfs_remove_link(&dev->kobj, "device");
1322                 sysfs_remove_link(&old_parent->kobj, class_name);
1323         }
1324         if (new_parent) {
1325                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1326                                           "device");
1327                 if (error)
1328                         goto out;
1329                 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1330                                           class_name);
1331                 if (error)
1332                         sysfs_remove_link(&dev->kobj, "device");
1333         }
1334         else
1335                 error = 0;
1336 out:
1337         kfree(class_name);
1338         return error;
1339 #else
1340         if (old_parent)
1341                 sysfs_remove_link(&dev->kobj, "device");
1342         if (new_parent)
1343                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1344                                           "device");
1345         return error;
1346 #endif
1347 }
1348
1349 /**
1350  * device_move - moves a device to a new parent
1351  * @dev: the pointer to the struct device to be moved
1352  * @new_parent: the new parent of the device (can by NULL)
1353  */
1354 int device_move(struct device *dev, struct device *new_parent)
1355 {
1356         int error;
1357         struct device *old_parent;
1358         struct kobject *new_parent_kobj;
1359
1360         dev = get_device(dev);
1361         if (!dev)
1362                 return -EINVAL;
1363
1364         new_parent = get_device(new_parent);
1365         new_parent_kobj = get_device_parent (dev, new_parent);
1366         if (IS_ERR(new_parent_kobj)) {
1367                 error = PTR_ERR(new_parent_kobj);
1368                 put_device(new_parent);
1369                 goto out;
1370         }
1371         pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1372                  new_parent ? new_parent->bus_id : "<NULL>");
1373         error = kobject_move(&dev->kobj, new_parent_kobj);
1374         if (error) {
1375                 put_device(new_parent);
1376                 goto out;
1377         }
1378         old_parent = dev->parent;
1379         dev->parent = new_parent;
1380         if (old_parent)
1381                 klist_remove(&dev->knode_parent);
1382         if (new_parent)
1383                 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1384         if (!dev->class)
1385                 goto out_put;
1386         error = device_move_class_links(dev, old_parent, new_parent);
1387         if (error) {
1388                 /* We ignore errors on cleanup since we're hosed anyway... */
1389                 device_move_class_links(dev, new_parent, old_parent);
1390                 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1391                         if (new_parent)
1392                                 klist_remove(&dev->knode_parent);
1393                         if (old_parent)
1394                                 klist_add_tail(&dev->knode_parent,
1395                                                &old_parent->klist_children);
1396                 }
1397                 put_device(new_parent);
1398                 goto out;
1399         }
1400 out_put:
1401         put_device(old_parent);
1402 out:
1403         put_device(dev);
1404         return error;
1405 }
1406
1407 EXPORT_SYMBOL_GPL(device_move);