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