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