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