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