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