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