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