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