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