driver core: Move device_links_purge() after bus_remove_device()
[platform/kernel/linux-exynos.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/sched/signal.h>
30 #include <linux/sysfs.h>
31
32 #include "base.h"
33 #include "power/power.h"
34
35 #ifdef CONFIG_SYSFS_DEPRECATED
36 #ifdef CONFIG_SYSFS_DEPRECATED_V2
37 long sysfs_deprecated = 1;
38 #else
39 long sysfs_deprecated = 0;
40 #endif
41 static int __init sysfs_deprecated_setup(char *arg)
42 {
43         return kstrtol(arg, 10, &sysfs_deprecated);
44 }
45 early_param("sysfs.deprecated", sysfs_deprecated_setup);
46 #endif
47
48 /* Device links support. */
49
50 #ifdef CONFIG_SRCU
51 static DEFINE_MUTEX(device_links_lock);
52 DEFINE_STATIC_SRCU(device_links_srcu);
53
54 static inline void device_links_write_lock(void)
55 {
56         mutex_lock(&device_links_lock);
57 }
58
59 static inline void device_links_write_unlock(void)
60 {
61         mutex_unlock(&device_links_lock);
62 }
63
64 int device_links_read_lock(void)
65 {
66         return srcu_read_lock(&device_links_srcu);
67 }
68
69 void device_links_read_unlock(int idx)
70 {
71         srcu_read_unlock(&device_links_srcu, idx);
72 }
73 #else /* !CONFIG_SRCU */
74 static DECLARE_RWSEM(device_links_lock);
75
76 static inline void device_links_write_lock(void)
77 {
78         down_write(&device_links_lock);
79 }
80
81 static inline void device_links_write_unlock(void)
82 {
83         up_write(&device_links_lock);
84 }
85
86 int device_links_read_lock(void)
87 {
88         down_read(&device_links_lock);
89         return 0;
90 }
91
92 void device_links_read_unlock(int not_used)
93 {
94         up_read(&device_links_lock);
95 }
96 #endif /* !CONFIG_SRCU */
97
98 /**
99  * device_is_dependent - Check if one device depends on another one
100  * @dev: Device to check dependencies for.
101  * @target: Device to check against.
102  *
103  * Check if @target depends on @dev or any device dependent on it (its child or
104  * its consumer etc).  Return 1 if that is the case or 0 otherwise.
105  */
106 static int device_is_dependent(struct device *dev, void *target)
107 {
108         struct device_link *link;
109         int ret;
110
111         if (WARN_ON(dev == target))
112                 return 1;
113
114         ret = device_for_each_child(dev, target, device_is_dependent);
115         if (ret)
116                 return ret;
117
118         list_for_each_entry(link, &dev->links.consumers, s_node) {
119                 if (WARN_ON(link->consumer == target))
120                         return 1;
121
122                 ret = device_is_dependent(link->consumer, target);
123                 if (ret)
124                         break;
125         }
126         return ret;
127 }
128
129 static int device_reorder_to_tail(struct device *dev, void *not_used)
130 {
131         struct device_link *link;
132
133         /*
134          * Devices that have not been registered yet will be put to the ends
135          * of the lists during the registration, so skip them here.
136          */
137         if (device_is_registered(dev))
138                 devices_kset_move_last(dev);
139
140         if (device_pm_initialized(dev))
141                 device_pm_move_last(dev);
142
143         device_for_each_child(dev, NULL, device_reorder_to_tail);
144         list_for_each_entry(link, &dev->links.consumers, s_node)
145                 device_reorder_to_tail(link->consumer, NULL);
146
147         return 0;
148 }
149
150 /**
151  * device_link_add - Create a link between two devices.
152  * @consumer: Consumer end of the link.
153  * @supplier: Supplier end of the link.
154  * @flags: Link flags.
155  *
156  * The caller is responsible for the proper synchronization of the link creation
157  * with runtime PM.  First, setting the DL_FLAG_PM_RUNTIME flag will cause the
158  * runtime PM framework to take the link into account.  Second, if the
159  * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will
160  * be forced into the active metastate and reference-counted upon the creation
161  * of the link.  If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be
162  * ignored.
163  *
164  * If the DL_FLAG_AUTOREMOVE is set, the link will be removed automatically
165  * when the consumer device driver unbinds from it.  The combination of both
166  * DL_FLAG_AUTOREMOVE and DL_FLAG_STATELESS set is invalid and will cause NULL
167  * to be returned.
168  *
169  * A side effect of the link creation is re-ordering of dpm_list and the
170  * devices_kset list by moving the consumer device and all devices depending
171  * on it to the ends of these lists (that does not happen to devices that have
172  * not been registered when this function is called).
173  *
174  * The supplier device is required to be registered when this function is called
175  * and NULL will be returned if that is not the case.  The consumer device need
176  * not be registered, however.
177  */
178 struct device_link *device_link_add(struct device *consumer,
179                                     struct device *supplier, u32 flags)
180 {
181         struct device_link *link;
182
183         if (!consumer || !supplier ||
184             ((flags & DL_FLAG_STATELESS) && (flags & DL_FLAG_AUTOREMOVE)))
185                 return NULL;
186
187         device_links_write_lock();
188         device_pm_lock();
189
190         /*
191          * If the supplier has not been fully registered yet or there is a
192          * reverse dependency between the consumer and the supplier already in
193          * the graph, return NULL.
194          */
195         if (!device_pm_initialized(supplier)
196             || device_is_dependent(consumer, supplier)) {
197                 link = NULL;
198                 goto out;
199         }
200
201         list_for_each_entry(link, &supplier->links.consumers, s_node)
202                 if (link->consumer == consumer)
203                         goto out;
204
205         link = kzalloc(sizeof(*link), GFP_KERNEL);
206         if (!link)
207                 goto out;
208
209         if (flags & DL_FLAG_PM_RUNTIME) {
210                 if (flags & DL_FLAG_RPM_ACTIVE) {
211                         if (pm_runtime_get_sync(supplier) < 0) {
212                                 pm_runtime_put_noidle(supplier);
213                                 kfree(link);
214                                 link = NULL;
215                                 goto out;
216                         }
217                         link->rpm_active = true;
218                 }
219                 pm_runtime_new_link(consumer);
220                 /*
221                  * If the link is being added by the consumer driver at probe
222                  * time, balance the decrementation of the supplier's runtime PM
223                  * usage counter after consumer probe in driver_probe_device().
224                  */
225                 if (consumer->links.status == DL_DEV_PROBING)
226                         pm_runtime_get_noresume(supplier);
227         }
228         get_device(supplier);
229         link->supplier = supplier;
230         INIT_LIST_HEAD(&link->s_node);
231         get_device(consumer);
232         link->consumer = consumer;
233         INIT_LIST_HEAD(&link->c_node);
234         link->flags = flags;
235
236         /* Determine the initial link state. */
237         if (flags & DL_FLAG_STATELESS) {
238                 link->status = DL_STATE_NONE;
239         } else {
240                 switch (supplier->links.status) {
241                 case DL_DEV_DRIVER_BOUND:
242                         switch (consumer->links.status) {
243                         case DL_DEV_PROBING:
244                                 /*
245                                  * Some callers expect the link creation during
246                                  * consumer driver probe to resume the supplier
247                                  * even without DL_FLAG_RPM_ACTIVE.
248                                  */
249                                 if (flags & DL_FLAG_PM_RUNTIME)
250                                         pm_runtime_resume(supplier);
251
252                                 link->status = DL_STATE_CONSUMER_PROBE;
253                                 break;
254                         case DL_DEV_DRIVER_BOUND:
255                                 link->status = DL_STATE_ACTIVE;
256                                 break;
257                         default:
258                                 link->status = DL_STATE_AVAILABLE;
259                                 break;
260                         }
261                         break;
262                 case DL_DEV_UNBINDING:
263                         link->status = DL_STATE_SUPPLIER_UNBIND;
264                         break;
265                 default:
266                         link->status = DL_STATE_DORMANT;
267                         break;
268                 }
269         }
270
271         /*
272          * Move the consumer and all of the devices depending on it to the end
273          * of dpm_list and the devices_kset list.
274          *
275          * It is necessary to hold dpm_list locked throughout all that or else
276          * we may end up suspending with a wrong ordering of it.
277          */
278         device_reorder_to_tail(consumer, NULL);
279
280         list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
281         list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);
282
283         dev_info(consumer, "Linked as a consumer to %s\n", dev_name(supplier));
284
285  out:
286         device_pm_unlock();
287         device_links_write_unlock();
288         return link;
289 }
290 EXPORT_SYMBOL_GPL(device_link_add);
291
292 static void device_link_free(struct device_link *link)
293 {
294         put_device(link->consumer);
295         put_device(link->supplier);
296         kfree(link);
297 }
298
299 #ifdef CONFIG_SRCU
300 static void __device_link_free_srcu(struct rcu_head *rhead)
301 {
302         device_link_free(container_of(rhead, struct device_link, rcu_head));
303 }
304
305 static void __device_link_del(struct device_link *link)
306 {
307         dev_info(link->consumer, "Dropping the link to %s\n",
308                  dev_name(link->supplier));
309
310         if (link->flags & DL_FLAG_PM_RUNTIME)
311                 pm_runtime_drop_link(link->consumer);
312
313         list_del_rcu(&link->s_node);
314         list_del_rcu(&link->c_node);
315         call_srcu(&device_links_srcu, &link->rcu_head, __device_link_free_srcu);
316 }
317 #else /* !CONFIG_SRCU */
318 static void __device_link_del(struct device_link *link)
319 {
320         dev_info(link->consumer, "Dropping the link to %s\n",
321                  dev_name(link->supplier));
322
323         if (link->flags & DL_FLAG_PM_RUNTIME)
324                 pm_runtime_drop_link(link->consumer);
325
326         list_del(&link->s_node);
327         list_del(&link->c_node);
328         device_link_free(link);
329 }
330 #endif /* !CONFIG_SRCU */
331
332 /**
333  * device_link_del - Delete a link between two devices.
334  * @link: Device link to delete.
335  *
336  * The caller must ensure proper synchronization of this function with runtime
337  * PM.
338  */
339 void device_link_del(struct device_link *link)
340 {
341         device_links_write_lock();
342         device_pm_lock();
343         __device_link_del(link);
344         device_pm_unlock();
345         device_links_write_unlock();
346 }
347 EXPORT_SYMBOL_GPL(device_link_del);
348
349 static void device_links_missing_supplier(struct device *dev)
350 {
351         struct device_link *link;
352
353         list_for_each_entry(link, &dev->links.suppliers, c_node)
354                 if (link->status == DL_STATE_CONSUMER_PROBE)
355                         WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
356 }
357
358 /**
359  * device_links_check_suppliers - Check presence of supplier drivers.
360  * @dev: Consumer device.
361  *
362  * Check links from this device to any suppliers.  Walk the list of the device's
363  * links to suppliers and see if all of them are available.  If not, simply
364  * return -EPROBE_DEFER.
365  *
366  * We need to guarantee that the supplier will not go away after the check has
367  * been positive here.  It only can go away in __device_release_driver() and
368  * that function  checks the device's links to consumers.  This means we need to
369  * mark the link as "consumer probe in progress" to make the supplier removal
370  * wait for us to complete (or bad things may happen).
371  *
372  * Links with the DL_FLAG_STATELESS flag set are ignored.
373  */
374 int device_links_check_suppliers(struct device *dev)
375 {
376         struct device_link *link;
377         int ret = 0;
378
379         device_links_write_lock();
380
381         list_for_each_entry(link, &dev->links.suppliers, c_node) {
382                 if (link->flags & DL_FLAG_STATELESS)
383                         continue;
384
385                 if (link->status != DL_STATE_AVAILABLE) {
386                         device_links_missing_supplier(dev);
387                         ret = -EPROBE_DEFER;
388                         break;
389                 }
390                 WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
391         }
392         dev->links.status = DL_DEV_PROBING;
393
394         device_links_write_unlock();
395         return ret;
396 }
397
398 /**
399  * device_links_driver_bound - Update device links after probing its driver.
400  * @dev: Device to update the links for.
401  *
402  * The probe has been successful, so update links from this device to any
403  * consumers by changing their status to "available".
404  *
405  * Also change the status of @dev's links to suppliers to "active".
406  *
407  * Links with the DL_FLAG_STATELESS flag set are ignored.
408  */
409 void device_links_driver_bound(struct device *dev)
410 {
411         struct device_link *link;
412
413         device_links_write_lock();
414
415         list_for_each_entry(link, &dev->links.consumers, s_node) {
416                 if (link->flags & DL_FLAG_STATELESS)
417                         continue;
418
419                 WARN_ON(link->status != DL_STATE_DORMANT);
420                 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
421         }
422
423         list_for_each_entry(link, &dev->links.suppliers, c_node) {
424                 if (link->flags & DL_FLAG_STATELESS)
425                         continue;
426
427                 WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
428                 WRITE_ONCE(link->status, DL_STATE_ACTIVE);
429         }
430
431         dev->links.status = DL_DEV_DRIVER_BOUND;
432
433         device_links_write_unlock();
434 }
435
436 /**
437  * __device_links_no_driver - Update links of a device without a driver.
438  * @dev: Device without a drvier.
439  *
440  * Delete all non-persistent links from this device to any suppliers.
441  *
442  * Persistent links stay around, but their status is changed to "available",
443  * unless they already are in the "supplier unbind in progress" state in which
444  * case they need not be updated.
445  *
446  * Links with the DL_FLAG_STATELESS flag set are ignored.
447  */
448 static void __device_links_no_driver(struct device *dev)
449 {
450         struct device_link *link, *ln;
451
452         list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
453                 if (link->flags & DL_FLAG_STATELESS)
454                         continue;
455
456                 if (link->flags & DL_FLAG_AUTOREMOVE)
457                         __device_link_del(link);
458                 else if (link->status != DL_STATE_SUPPLIER_UNBIND)
459                         WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
460         }
461
462         dev->links.status = DL_DEV_NO_DRIVER;
463 }
464
465 void device_links_no_driver(struct device *dev)
466 {
467         device_links_write_lock();
468         __device_links_no_driver(dev);
469         device_links_write_unlock();
470 }
471
472 /**
473  * device_links_driver_cleanup - Update links after driver removal.
474  * @dev: Device whose driver has just gone away.
475  *
476  * Update links to consumers for @dev by changing their status to "dormant" and
477  * invoke %__device_links_no_driver() to update links to suppliers for it as
478  * appropriate.
479  *
480  * Links with the DL_FLAG_STATELESS flag set are ignored.
481  */
482 void device_links_driver_cleanup(struct device *dev)
483 {
484         struct device_link *link;
485
486         device_links_write_lock();
487
488         list_for_each_entry(link, &dev->links.consumers, s_node) {
489                 if (link->flags & DL_FLAG_STATELESS)
490                         continue;
491
492                 WARN_ON(link->flags & DL_FLAG_AUTOREMOVE);
493                 WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
494                 WRITE_ONCE(link->status, DL_STATE_DORMANT);
495         }
496
497         __device_links_no_driver(dev);
498
499         device_links_write_unlock();
500 }
501
502 /**
503  * device_links_busy - Check if there are any busy links to consumers.
504  * @dev: Device to check.
505  *
506  * Check each consumer of the device and return 'true' if its link's status
507  * is one of "consumer probe" or "active" (meaning that the given consumer is
508  * probing right now or its driver is present).  Otherwise, change the link
509  * state to "supplier unbind" to prevent the consumer from being probed
510  * successfully going forward.
511  *
512  * Return 'false' if there are no probing or active consumers.
513  *
514  * Links with the DL_FLAG_STATELESS flag set are ignored.
515  */
516 bool device_links_busy(struct device *dev)
517 {
518         struct device_link *link;
519         bool ret = false;
520
521         device_links_write_lock();
522
523         list_for_each_entry(link, &dev->links.consumers, s_node) {
524                 if (link->flags & DL_FLAG_STATELESS)
525                         continue;
526
527                 if (link->status == DL_STATE_CONSUMER_PROBE
528                     || link->status == DL_STATE_ACTIVE) {
529                         ret = true;
530                         break;
531                 }
532                 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
533         }
534
535         dev->links.status = DL_DEV_UNBINDING;
536
537         device_links_write_unlock();
538         return ret;
539 }
540
541 /**
542  * device_links_unbind_consumers - Force unbind consumers of the given device.
543  * @dev: Device to unbind the consumers of.
544  *
545  * Walk the list of links to consumers for @dev and if any of them is in the
546  * "consumer probe" state, wait for all device probes in progress to complete
547  * and start over.
548  *
549  * If that's not the case, change the status of the link to "supplier unbind"
550  * and check if the link was in the "active" state.  If so, force the consumer
551  * driver to unbind and start over (the consumer will not re-probe as we have
552  * changed the state of the link already).
553  *
554  * Links with the DL_FLAG_STATELESS flag set are ignored.
555  */
556 void device_links_unbind_consumers(struct device *dev)
557 {
558         struct device_link *link;
559
560  start:
561         device_links_write_lock();
562
563         list_for_each_entry(link, &dev->links.consumers, s_node) {
564                 enum device_link_state status;
565
566                 if (link->flags & DL_FLAG_STATELESS)
567                         continue;
568
569                 status = link->status;
570                 if (status == DL_STATE_CONSUMER_PROBE) {
571                         device_links_write_unlock();
572
573                         wait_for_device_probe();
574                         goto start;
575                 }
576                 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
577                 if (status == DL_STATE_ACTIVE) {
578                         struct device *consumer = link->consumer;
579
580                         get_device(consumer);
581
582                         device_links_write_unlock();
583
584                         device_release_driver_internal(consumer, NULL,
585                                                        consumer->parent);
586                         put_device(consumer);
587                         goto start;
588                 }
589         }
590
591         device_links_write_unlock();
592 }
593
594 /**
595  * device_links_purge - Delete existing links to other devices.
596  * @dev: Target device.
597  */
598 static void device_links_purge(struct device *dev)
599 {
600         struct device_link *link, *ln;
601
602         /*
603          * Delete all of the remaining links from this device to any other
604          * devices (either consumers or suppliers).
605          */
606         device_links_write_lock();
607
608         list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
609                 WARN_ON(link->status == DL_STATE_ACTIVE);
610                 __device_link_del(link);
611         }
612
613         list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
614                 WARN_ON(link->status != DL_STATE_DORMANT &&
615                         link->status != DL_STATE_NONE);
616                 __device_link_del(link);
617         }
618
619         device_links_write_unlock();
620 }
621
622 /* Device links support end. */
623
624 int (*platform_notify)(struct device *dev) = NULL;
625 int (*platform_notify_remove)(struct device *dev) = NULL;
626 static struct kobject *dev_kobj;
627 struct kobject *sysfs_dev_char_kobj;
628 struct kobject *sysfs_dev_block_kobj;
629
630 static DEFINE_MUTEX(device_hotplug_lock);
631
632 void lock_device_hotplug(void)
633 {
634         mutex_lock(&device_hotplug_lock);
635 }
636
637 void unlock_device_hotplug(void)
638 {
639         mutex_unlock(&device_hotplug_lock);
640 }
641
642 int lock_device_hotplug_sysfs(void)
643 {
644         if (mutex_trylock(&device_hotplug_lock))
645                 return 0;
646
647         /* Avoid busy looping (5 ms of sleep should do). */
648         msleep(5);
649         return restart_syscall();
650 }
651
652 #ifdef CONFIG_BLOCK
653 static inline int device_is_not_partition(struct device *dev)
654 {
655         return !(dev->type == &part_type);
656 }
657 #else
658 static inline int device_is_not_partition(struct device *dev)
659 {
660         return 1;
661 }
662 #endif
663
664 /**
665  * dev_driver_string - Return a device's driver name, if at all possible
666  * @dev: struct device to get the name of
667  *
668  * Will return the device's driver's name if it is bound to a device.  If
669  * the device is not bound to a driver, it will return the name of the bus
670  * it is attached to.  If it is not attached to a bus either, an empty
671  * string will be returned.
672  */
673 const char *dev_driver_string(const struct device *dev)
674 {
675         struct device_driver *drv;
676
677         /* dev->driver can change to NULL underneath us because of unbinding,
678          * so be careful about accessing it.  dev->bus and dev->class should
679          * never change once they are set, so they don't need special care.
680          */
681         drv = ACCESS_ONCE(dev->driver);
682         return drv ? drv->name :
683                         (dev->bus ? dev->bus->name :
684                         (dev->class ? dev->class->name : ""));
685 }
686 EXPORT_SYMBOL(dev_driver_string);
687
688 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
689
690 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
691                              char *buf)
692 {
693         struct device_attribute *dev_attr = to_dev_attr(attr);
694         struct device *dev = kobj_to_dev(kobj);
695         ssize_t ret = -EIO;
696
697         if (dev_attr->show)
698                 ret = dev_attr->show(dev, dev_attr, buf);
699         if (ret >= (ssize_t)PAGE_SIZE) {
700                 print_symbol("dev_attr_show: %s returned bad count\n",
701                                 (unsigned long)dev_attr->show);
702         }
703         return ret;
704 }
705
706 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
707                               const char *buf, size_t count)
708 {
709         struct device_attribute *dev_attr = to_dev_attr(attr);
710         struct device *dev = kobj_to_dev(kobj);
711         ssize_t ret = -EIO;
712
713         if (dev_attr->store)
714                 ret = dev_attr->store(dev, dev_attr, buf, count);
715         return ret;
716 }
717
718 static const struct sysfs_ops dev_sysfs_ops = {
719         .show   = dev_attr_show,
720         .store  = dev_attr_store,
721 };
722
723 #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
724
725 ssize_t device_store_ulong(struct device *dev,
726                            struct device_attribute *attr,
727                            const char *buf, size_t size)
728 {
729         struct dev_ext_attribute *ea = to_ext_attr(attr);
730         char *end;
731         unsigned long new = simple_strtoul(buf, &end, 0);
732         if (end == buf)
733                 return -EINVAL;
734         *(unsigned long *)(ea->var) = new;
735         /* Always return full write size even if we didn't consume all */
736         return size;
737 }
738 EXPORT_SYMBOL_GPL(device_store_ulong);
739
740 ssize_t device_show_ulong(struct device *dev,
741                           struct device_attribute *attr,
742                           char *buf)
743 {
744         struct dev_ext_attribute *ea = to_ext_attr(attr);
745         return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
746 }
747 EXPORT_SYMBOL_GPL(device_show_ulong);
748
749 ssize_t device_store_int(struct device *dev,
750                          struct device_attribute *attr,
751                          const char *buf, size_t size)
752 {
753         struct dev_ext_attribute *ea = to_ext_attr(attr);
754         char *end;
755         long new = simple_strtol(buf, &end, 0);
756         if (end == buf || new > INT_MAX || new < INT_MIN)
757                 return -EINVAL;
758         *(int *)(ea->var) = new;
759         /* Always return full write size even if we didn't consume all */
760         return size;
761 }
762 EXPORT_SYMBOL_GPL(device_store_int);
763
764 ssize_t device_show_int(struct device *dev,
765                         struct device_attribute *attr,
766                         char *buf)
767 {
768         struct dev_ext_attribute *ea = to_ext_attr(attr);
769
770         return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
771 }
772 EXPORT_SYMBOL_GPL(device_show_int);
773
774 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
775                           const char *buf, size_t size)
776 {
777         struct dev_ext_attribute *ea = to_ext_attr(attr);
778
779         if (strtobool(buf, ea->var) < 0)
780                 return -EINVAL;
781
782         return size;
783 }
784 EXPORT_SYMBOL_GPL(device_store_bool);
785
786 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
787                          char *buf)
788 {
789         struct dev_ext_attribute *ea = to_ext_attr(attr);
790
791         return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
792 }
793 EXPORT_SYMBOL_GPL(device_show_bool);
794
795 /**
796  * device_release - free device structure.
797  * @kobj: device's kobject.
798  *
799  * This is called once the reference count for the object
800  * reaches 0. We forward the call to the device's release
801  * method, which should handle actually freeing the structure.
802  */
803 static void device_release(struct kobject *kobj)
804 {
805         struct device *dev = kobj_to_dev(kobj);
806         struct device_private *p = dev->p;
807
808         /*
809          * Some platform devices are driven without driver attached
810          * and managed resources may have been acquired.  Make sure
811          * all resources are released.
812          *
813          * Drivers still can add resources into device after device
814          * is deleted but alive, so release devres here to avoid
815          * possible memory leak.
816          */
817         devres_release_all(dev);
818
819         if (dev->release)
820                 dev->release(dev);
821         else if (dev->type && dev->type->release)
822                 dev->type->release(dev);
823         else if (dev->class && dev->class->dev_release)
824                 dev->class->dev_release(dev);
825         else
826                 WARN(1, KERN_ERR "Device '%s' does not have a release() "
827                         "function, it is broken and must be fixed.\n",
828                         dev_name(dev));
829         kfree(p);
830 }
831
832 static const void *device_namespace(struct kobject *kobj)
833 {
834         struct device *dev = kobj_to_dev(kobj);
835         const void *ns = NULL;
836
837         if (dev->class && dev->class->ns_type)
838                 ns = dev->class->namespace(dev);
839
840         return ns;
841 }
842
843 static struct kobj_type device_ktype = {
844         .release        = device_release,
845         .sysfs_ops      = &dev_sysfs_ops,
846         .namespace      = device_namespace,
847 };
848
849
850 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
851 {
852         struct kobj_type *ktype = get_ktype(kobj);
853
854         if (ktype == &device_ktype) {
855                 struct device *dev = kobj_to_dev(kobj);
856                 if (dev->bus)
857                         return 1;
858                 if (dev->class)
859                         return 1;
860         }
861         return 0;
862 }
863
864 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
865 {
866         struct device *dev = kobj_to_dev(kobj);
867
868         if (dev->bus)
869                 return dev->bus->name;
870         if (dev->class)
871                 return dev->class->name;
872         return NULL;
873 }
874
875 static int dev_uevent(struct kset *kset, struct kobject *kobj,
876                       struct kobj_uevent_env *env)
877 {
878         struct device *dev = kobj_to_dev(kobj);
879         int retval = 0;
880
881         /* add device node properties if present */
882         if (MAJOR(dev->devt)) {
883                 const char *tmp;
884                 const char *name;
885                 umode_t mode = 0;
886                 kuid_t uid = GLOBAL_ROOT_UID;
887                 kgid_t gid = GLOBAL_ROOT_GID;
888
889                 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
890                 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
891                 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
892                 if (name) {
893                         add_uevent_var(env, "DEVNAME=%s", name);
894                         if (mode)
895                                 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
896                         if (!uid_eq(uid, GLOBAL_ROOT_UID))
897                                 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
898                         if (!gid_eq(gid, GLOBAL_ROOT_GID))
899                                 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
900                         kfree(tmp);
901                 }
902         }
903
904         if (dev->type && dev->type->name)
905                 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
906
907         if (dev->driver)
908                 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
909
910         /* Add common DT information about the device */
911         of_device_uevent(dev, env);
912
913         /* have the bus specific function add its stuff */
914         if (dev->bus && dev->bus->uevent) {
915                 retval = dev->bus->uevent(dev, env);
916                 if (retval)
917                         pr_debug("device: '%s': %s: bus uevent() returned %d\n",
918                                  dev_name(dev), __func__, retval);
919         }
920
921         /* have the class specific function add its stuff */
922         if (dev->class && dev->class->dev_uevent) {
923                 retval = dev->class->dev_uevent(dev, env);
924                 if (retval)
925                         pr_debug("device: '%s': %s: class uevent() "
926                                  "returned %d\n", dev_name(dev),
927                                  __func__, retval);
928         }
929
930         /* have the device type specific function add its stuff */
931         if (dev->type && dev->type->uevent) {
932                 retval = dev->type->uevent(dev, env);
933                 if (retval)
934                         pr_debug("device: '%s': %s: dev_type uevent() "
935                                  "returned %d\n", dev_name(dev),
936                                  __func__, retval);
937         }
938
939         return retval;
940 }
941
942 static const struct kset_uevent_ops device_uevent_ops = {
943         .filter =       dev_uevent_filter,
944         .name =         dev_uevent_name,
945         .uevent =       dev_uevent,
946 };
947
948 static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
949                            char *buf)
950 {
951         struct kobject *top_kobj;
952         struct kset *kset;
953         struct kobj_uevent_env *env = NULL;
954         int i;
955         size_t count = 0;
956         int retval;
957
958         /* search the kset, the device belongs to */
959         top_kobj = &dev->kobj;
960         while (!top_kobj->kset && top_kobj->parent)
961                 top_kobj = top_kobj->parent;
962         if (!top_kobj->kset)
963                 goto out;
964
965         kset = top_kobj->kset;
966         if (!kset->uevent_ops || !kset->uevent_ops->uevent)
967                 goto out;
968
969         /* respect filter */
970         if (kset->uevent_ops && kset->uevent_ops->filter)
971                 if (!kset->uevent_ops->filter(kset, &dev->kobj))
972                         goto out;
973
974         env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
975         if (!env)
976                 return -ENOMEM;
977
978         /* let the kset specific function add its keys */
979         retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
980         if (retval)
981                 goto out;
982
983         /* copy keys to file */
984         for (i = 0; i < env->envp_idx; i++)
985                 count += sprintf(&buf[count], "%s\n", env->envp[i]);
986 out:
987         kfree(env);
988         return count;
989 }
990
991 static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
992                             const char *buf, size_t count)
993 {
994         if (kobject_synth_uevent(&dev->kobj, buf, count))
995                 dev_err(dev, "uevent: failed to send synthetic uevent\n");
996
997         return count;
998 }
999 static DEVICE_ATTR_RW(uevent);
1000
1001 static ssize_t online_show(struct device *dev, struct device_attribute *attr,
1002                            char *buf)
1003 {
1004         bool val;
1005
1006         device_lock(dev);
1007         val = !dev->offline;
1008         device_unlock(dev);
1009         return sprintf(buf, "%u\n", val);
1010 }
1011
1012 static ssize_t online_store(struct device *dev, struct device_attribute *attr,
1013                             const char *buf, size_t count)
1014 {
1015         bool val;
1016         int ret;
1017
1018         ret = strtobool(buf, &val);
1019         if (ret < 0)
1020                 return ret;
1021
1022         ret = lock_device_hotplug_sysfs();
1023         if (ret)
1024                 return ret;
1025
1026         ret = val ? device_online(dev) : device_offline(dev);
1027         unlock_device_hotplug();
1028         return ret < 0 ? ret : count;
1029 }
1030 static DEVICE_ATTR_RW(online);
1031
1032 int device_add_groups(struct device *dev, const struct attribute_group **groups)
1033 {
1034         return sysfs_create_groups(&dev->kobj, groups);
1035 }
1036 EXPORT_SYMBOL_GPL(device_add_groups);
1037
1038 void device_remove_groups(struct device *dev,
1039                           const struct attribute_group **groups)
1040 {
1041         sysfs_remove_groups(&dev->kobj, groups);
1042 }
1043 EXPORT_SYMBOL_GPL(device_remove_groups);
1044
1045 union device_attr_group_devres {
1046         const struct attribute_group *group;
1047         const struct attribute_group **groups;
1048 };
1049
1050 static int devm_attr_group_match(struct device *dev, void *res, void *data)
1051 {
1052         return ((union device_attr_group_devres *)res)->group == data;
1053 }
1054
1055 static void devm_attr_group_remove(struct device *dev, void *res)
1056 {
1057         union device_attr_group_devres *devres = res;
1058         const struct attribute_group *group = devres->group;
1059
1060         dev_dbg(dev, "%s: removing group %p\n", __func__, group);
1061         sysfs_remove_group(&dev->kobj, group);
1062 }
1063
1064 static void devm_attr_groups_remove(struct device *dev, void *res)
1065 {
1066         union device_attr_group_devres *devres = res;
1067         const struct attribute_group **groups = devres->groups;
1068
1069         dev_dbg(dev, "%s: removing groups %p\n", __func__, groups);
1070         sysfs_remove_groups(&dev->kobj, groups);
1071 }
1072
1073 /**
1074  * devm_device_add_group - given a device, create a managed attribute group
1075  * @dev:        The device to create the group for
1076  * @grp:        The attribute group to create
1077  *
1078  * This function creates a group for the first time.  It will explicitly
1079  * warn and error if any of the attribute files being created already exist.
1080  *
1081  * Returns 0 on success or error code on failure.
1082  */
1083 int devm_device_add_group(struct device *dev, const struct attribute_group *grp)
1084 {
1085         union device_attr_group_devres *devres;
1086         int error;
1087
1088         devres = devres_alloc(devm_attr_group_remove,
1089                               sizeof(*devres), GFP_KERNEL);
1090         if (!devres)
1091                 return -ENOMEM;
1092
1093         error = sysfs_create_group(&dev->kobj, grp);
1094         if (error) {
1095                 devres_free(devres);
1096                 return error;
1097         }
1098
1099         devres->group = grp;
1100         devres_add(dev, devres);
1101         return 0;
1102 }
1103 EXPORT_SYMBOL_GPL(devm_device_add_group);
1104
1105 /**
1106  * devm_device_remove_group: remove a managed group from a device
1107  * @dev:        device to remove the group from
1108  * @grp:        group to remove
1109  *
1110  * This function removes a group of attributes from a device. The attributes
1111  * previously have to have been created for this group, otherwise it will fail.
1112  */
1113 void devm_device_remove_group(struct device *dev,
1114                               const struct attribute_group *grp)
1115 {
1116         WARN_ON(devres_release(dev, devm_attr_group_remove,
1117                                devm_attr_group_match,
1118                                /* cast away const */ (void *)grp));
1119 }
1120 EXPORT_SYMBOL_GPL(devm_device_remove_group);
1121
1122 /**
1123  * devm_device_add_groups - create a bunch of managed attribute groups
1124  * @dev:        The device to create the group for
1125  * @groups:     The attribute groups to create, NULL terminated
1126  *
1127  * This function creates a bunch of managed attribute groups.  If an error
1128  * occurs when creating a group, all previously created groups will be
1129  * removed, unwinding everything back to the original state when this
1130  * function was called.  It will explicitly warn and error if any of the
1131  * attribute files being created already exist.
1132  *
1133  * Returns 0 on success or error code from sysfs_create_group on failure.
1134  */
1135 int devm_device_add_groups(struct device *dev,
1136                            const struct attribute_group **groups)
1137 {
1138         union device_attr_group_devres *devres;
1139         int error;
1140
1141         devres = devres_alloc(devm_attr_groups_remove,
1142                               sizeof(*devres), GFP_KERNEL);
1143         if (!devres)
1144                 return -ENOMEM;
1145
1146         error = sysfs_create_groups(&dev->kobj, groups);
1147         if (error) {
1148                 devres_free(devres);
1149                 return error;
1150         }
1151
1152         devres->groups = groups;
1153         devres_add(dev, devres);
1154         return 0;
1155 }
1156 EXPORT_SYMBOL_GPL(devm_device_add_groups);
1157
1158 /**
1159  * devm_device_remove_groups - remove a list of managed groups
1160  *
1161  * @dev:        The device for the groups to be removed from
1162  * @groups:     NULL terminated list of groups to be removed
1163  *
1164  * If groups is not NULL, remove the specified groups from the device.
1165  */
1166 void devm_device_remove_groups(struct device *dev,
1167                                const struct attribute_group **groups)
1168 {
1169         WARN_ON(devres_release(dev, devm_attr_groups_remove,
1170                                devm_attr_group_match,
1171                                /* cast away const */ (void *)groups));
1172 }
1173 EXPORT_SYMBOL_GPL(devm_device_remove_groups);
1174
1175 static int device_add_attrs(struct device *dev)
1176 {
1177         struct class *class = dev->class;
1178         const struct device_type *type = dev->type;
1179         int error;
1180
1181         if (class) {
1182                 error = device_add_groups(dev, class->dev_groups);
1183                 if (error)
1184                         return error;
1185         }
1186
1187         if (type) {
1188                 error = device_add_groups(dev, type->groups);
1189                 if (error)
1190                         goto err_remove_class_groups;
1191         }
1192
1193         error = device_add_groups(dev, dev->groups);
1194         if (error)
1195                 goto err_remove_type_groups;
1196
1197         if (device_supports_offline(dev) && !dev->offline_disabled) {
1198                 error = device_create_file(dev, &dev_attr_online);
1199                 if (error)
1200                         goto err_remove_dev_groups;
1201         }
1202
1203         return 0;
1204
1205  err_remove_dev_groups:
1206         device_remove_groups(dev, dev->groups);
1207  err_remove_type_groups:
1208         if (type)
1209                 device_remove_groups(dev, type->groups);
1210  err_remove_class_groups:
1211         if (class)
1212                 device_remove_groups(dev, class->dev_groups);
1213
1214         return error;
1215 }
1216
1217 static void device_remove_attrs(struct device *dev)
1218 {
1219         struct class *class = dev->class;
1220         const struct device_type *type = dev->type;
1221
1222         device_remove_file(dev, &dev_attr_online);
1223         device_remove_groups(dev, dev->groups);
1224
1225         if (type)
1226                 device_remove_groups(dev, type->groups);
1227
1228         if (class)
1229                 device_remove_groups(dev, class->dev_groups);
1230 }
1231
1232 static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
1233                         char *buf)
1234 {
1235         return print_dev_t(buf, dev->devt);
1236 }
1237 static DEVICE_ATTR_RO(dev);
1238
1239 /* /sys/devices/ */
1240 struct kset *devices_kset;
1241
1242 /**
1243  * devices_kset_move_before - Move device in the devices_kset's list.
1244  * @deva: Device to move.
1245  * @devb: Device @deva should come before.
1246  */
1247 static void devices_kset_move_before(struct device *deva, struct device *devb)
1248 {
1249         if (!devices_kset)
1250                 return;
1251         pr_debug("devices_kset: Moving %s before %s\n",
1252                  dev_name(deva), dev_name(devb));
1253         spin_lock(&devices_kset->list_lock);
1254         list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
1255         spin_unlock(&devices_kset->list_lock);
1256 }
1257
1258 /**
1259  * devices_kset_move_after - Move device in the devices_kset's list.
1260  * @deva: Device to move
1261  * @devb: Device @deva should come after.
1262  */
1263 static void devices_kset_move_after(struct device *deva, struct device *devb)
1264 {
1265         if (!devices_kset)
1266                 return;
1267         pr_debug("devices_kset: Moving %s after %s\n",
1268                  dev_name(deva), dev_name(devb));
1269         spin_lock(&devices_kset->list_lock);
1270         list_move(&deva->kobj.entry, &devb->kobj.entry);
1271         spin_unlock(&devices_kset->list_lock);
1272 }
1273
1274 /**
1275  * devices_kset_move_last - move the device to the end of devices_kset's list.
1276  * @dev: device to move
1277  */
1278 void devices_kset_move_last(struct device *dev)
1279 {
1280         if (!devices_kset)
1281                 return;
1282         pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
1283         spin_lock(&devices_kset->list_lock);
1284         list_move_tail(&dev->kobj.entry, &devices_kset->list);
1285         spin_unlock(&devices_kset->list_lock);
1286 }
1287
1288 /**
1289  * device_create_file - create sysfs attribute file for device.
1290  * @dev: device.
1291  * @attr: device attribute descriptor.
1292  */
1293 int device_create_file(struct device *dev,
1294                        const struct device_attribute *attr)
1295 {
1296         int error = 0;
1297
1298         if (dev) {
1299                 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
1300                         "Attribute %s: write permission without 'store'\n",
1301                         attr->attr.name);
1302                 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
1303                         "Attribute %s: read permission without 'show'\n",
1304                         attr->attr.name);
1305                 error = sysfs_create_file(&dev->kobj, &attr->attr);
1306         }
1307
1308         return error;
1309 }
1310 EXPORT_SYMBOL_GPL(device_create_file);
1311
1312 /**
1313  * device_remove_file - remove sysfs attribute file.
1314  * @dev: device.
1315  * @attr: device attribute descriptor.
1316  */
1317 void device_remove_file(struct device *dev,
1318                         const struct device_attribute *attr)
1319 {
1320         if (dev)
1321                 sysfs_remove_file(&dev->kobj, &attr->attr);
1322 }
1323 EXPORT_SYMBOL_GPL(device_remove_file);
1324
1325 /**
1326  * device_remove_file_self - remove sysfs attribute file from its own method.
1327  * @dev: device.
1328  * @attr: device attribute descriptor.
1329  *
1330  * See kernfs_remove_self() for details.
1331  */
1332 bool device_remove_file_self(struct device *dev,
1333                              const struct device_attribute *attr)
1334 {
1335         if (dev)
1336                 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
1337         else
1338                 return false;
1339 }
1340 EXPORT_SYMBOL_GPL(device_remove_file_self);
1341
1342 /**
1343  * device_create_bin_file - create sysfs binary attribute file for device.
1344  * @dev: device.
1345  * @attr: device binary attribute descriptor.
1346  */
1347 int device_create_bin_file(struct device *dev,
1348                            const struct bin_attribute *attr)
1349 {
1350         int error = -EINVAL;
1351         if (dev)
1352                 error = sysfs_create_bin_file(&dev->kobj, attr);
1353         return error;
1354 }
1355 EXPORT_SYMBOL_GPL(device_create_bin_file);
1356
1357 /**
1358  * device_remove_bin_file - remove sysfs binary attribute file
1359  * @dev: device.
1360  * @attr: device binary attribute descriptor.
1361  */
1362 void device_remove_bin_file(struct device *dev,
1363                             const struct bin_attribute *attr)
1364 {
1365         if (dev)
1366                 sysfs_remove_bin_file(&dev->kobj, attr);
1367 }
1368 EXPORT_SYMBOL_GPL(device_remove_bin_file);
1369
1370 static void klist_children_get(struct klist_node *n)
1371 {
1372         struct device_private *p = to_device_private_parent(n);
1373         struct device *dev = p->device;
1374
1375         get_device(dev);
1376 }
1377
1378 static void klist_children_put(struct klist_node *n)
1379 {
1380         struct device_private *p = to_device_private_parent(n);
1381         struct device *dev = p->device;
1382
1383         put_device(dev);
1384 }
1385
1386 /**
1387  * device_initialize - init device structure.
1388  * @dev: device.
1389  *
1390  * This prepares the device for use by other layers by initializing
1391  * its fields.
1392  * It is the first half of device_register(), if called by
1393  * that function, though it can also be called separately, so one
1394  * may use @dev's fields. In particular, get_device()/put_device()
1395  * may be used for reference counting of @dev after calling this
1396  * function.
1397  *
1398  * All fields in @dev must be initialized by the caller to 0, except
1399  * for those explicitly set to some other value.  The simplest
1400  * approach is to use kzalloc() to allocate the structure containing
1401  * @dev.
1402  *
1403  * NOTE: Use put_device() to give up your reference instead of freeing
1404  * @dev directly once you have called this function.
1405  */
1406 void device_initialize(struct device *dev)
1407 {
1408         dev->kobj.kset = devices_kset;
1409         kobject_init(&dev->kobj, &device_ktype);
1410         INIT_LIST_HEAD(&dev->dma_pools);
1411         mutex_init(&dev->mutex);
1412         lockdep_set_novalidate_class(&dev->mutex);
1413         spin_lock_init(&dev->devres_lock);
1414         INIT_LIST_HEAD(&dev->devres_head);
1415         device_pm_init(dev);
1416         set_dev_node(dev, -1);
1417 #ifdef CONFIG_GENERIC_MSI_IRQ
1418         INIT_LIST_HEAD(&dev->msi_list);
1419 #endif
1420         INIT_LIST_HEAD(&dev->links.consumers);
1421         INIT_LIST_HEAD(&dev->links.suppliers);
1422         dev->links.status = DL_DEV_NO_DRIVER;
1423 }
1424 EXPORT_SYMBOL_GPL(device_initialize);
1425
1426 struct kobject *virtual_device_parent(struct device *dev)
1427 {
1428         static struct kobject *virtual_dir = NULL;
1429
1430         if (!virtual_dir)
1431                 virtual_dir = kobject_create_and_add("virtual",
1432                                                      &devices_kset->kobj);
1433
1434         return virtual_dir;
1435 }
1436
1437 struct class_dir {
1438         struct kobject kobj;
1439         struct class *class;
1440 };
1441
1442 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
1443
1444 static void class_dir_release(struct kobject *kobj)
1445 {
1446         struct class_dir *dir = to_class_dir(kobj);
1447         kfree(dir);
1448 }
1449
1450 static const
1451 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
1452 {
1453         struct class_dir *dir = to_class_dir(kobj);
1454         return dir->class->ns_type;
1455 }
1456
1457 static struct kobj_type class_dir_ktype = {
1458         .release        = class_dir_release,
1459         .sysfs_ops      = &kobj_sysfs_ops,
1460         .child_ns_type  = class_dir_child_ns_type
1461 };
1462
1463 static struct kobject *
1464 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
1465 {
1466         struct class_dir *dir;
1467         int retval;
1468
1469         dir = kzalloc(sizeof(*dir), GFP_KERNEL);
1470         if (!dir)
1471                 return ERR_PTR(-ENOMEM);
1472
1473         dir->class = class;
1474         kobject_init(&dir->kobj, &class_dir_ktype);
1475
1476         dir->kobj.kset = &class->p->glue_dirs;
1477
1478         retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
1479         if (retval < 0) {
1480                 kobject_put(&dir->kobj);
1481                 return ERR_PTR(retval);
1482         }
1483         return &dir->kobj;
1484 }
1485
1486 static DEFINE_MUTEX(gdp_mutex);
1487
1488 static struct kobject *get_device_parent(struct device *dev,
1489                                          struct device *parent)
1490 {
1491         if (dev->class) {
1492                 struct kobject *kobj = NULL;
1493                 struct kobject *parent_kobj;
1494                 struct kobject *k;
1495
1496 #ifdef CONFIG_BLOCK
1497                 /* block disks show up in /sys/block */
1498                 if (sysfs_deprecated && dev->class == &block_class) {
1499                         if (parent && parent->class == &block_class)
1500                                 return &parent->kobj;
1501                         return &block_class.p->subsys.kobj;
1502                 }
1503 #endif
1504
1505                 /*
1506                  * If we have no parent, we live in "virtual".
1507                  * Class-devices with a non class-device as parent, live
1508                  * in a "glue" directory to prevent namespace collisions.
1509                  */
1510                 if (parent == NULL)
1511                         parent_kobj = virtual_device_parent(dev);
1512                 else if (parent->class && !dev->class->ns_type)
1513                         return &parent->kobj;
1514                 else
1515                         parent_kobj = &parent->kobj;
1516
1517                 mutex_lock(&gdp_mutex);
1518
1519                 /* find our class-directory at the parent and reference it */
1520                 spin_lock(&dev->class->p->glue_dirs.list_lock);
1521                 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
1522                         if (k->parent == parent_kobj) {
1523                                 kobj = kobject_get(k);
1524                                 break;
1525                         }
1526                 spin_unlock(&dev->class->p->glue_dirs.list_lock);
1527                 if (kobj) {
1528                         mutex_unlock(&gdp_mutex);
1529                         return kobj;
1530                 }
1531
1532                 /* or create a new class-directory at the parent device */
1533                 k = class_dir_create_and_add(dev->class, parent_kobj);
1534                 /* do not emit an uevent for this simple "glue" directory */
1535                 mutex_unlock(&gdp_mutex);
1536                 return k;
1537         }
1538
1539         /* subsystems can specify a default root directory for their devices */
1540         if (!parent && dev->bus && dev->bus->dev_root)
1541                 return &dev->bus->dev_root->kobj;
1542
1543         if (parent)
1544                 return &parent->kobj;
1545         return NULL;
1546 }
1547
1548 static inline bool live_in_glue_dir(struct kobject *kobj,
1549                                     struct device *dev)
1550 {
1551         if (!kobj || !dev->class ||
1552             kobj->kset != &dev->class->p->glue_dirs)
1553                 return false;
1554         return true;
1555 }
1556
1557 static inline struct kobject *get_glue_dir(struct device *dev)
1558 {
1559         return dev->kobj.parent;
1560 }
1561
1562 /*
1563  * make sure cleaning up dir as the last step, we need to make
1564  * sure .release handler of kobject is run with holding the
1565  * global lock
1566  */
1567 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
1568 {
1569         /* see if we live in a "glue" directory */
1570         if (!live_in_glue_dir(glue_dir, dev))
1571                 return;
1572
1573         mutex_lock(&gdp_mutex);
1574         kobject_put(glue_dir);
1575         mutex_unlock(&gdp_mutex);
1576 }
1577
1578 static int device_add_class_symlinks(struct device *dev)
1579 {
1580         struct device_node *of_node = dev_of_node(dev);
1581         int error;
1582
1583         if (of_node) {
1584                 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
1585                 if (error)
1586                         dev_warn(dev, "Error %d creating of_node link\n",error);
1587                 /* An error here doesn't warrant bringing down the device */
1588         }
1589
1590         if (!dev->class)
1591                 return 0;
1592
1593         error = sysfs_create_link(&dev->kobj,
1594                                   &dev->class->p->subsys.kobj,
1595                                   "subsystem");
1596         if (error)
1597                 goto out_devnode;
1598
1599         if (dev->parent && device_is_not_partition(dev)) {
1600                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
1601                                           "device");
1602                 if (error)
1603                         goto out_subsys;
1604         }
1605
1606 #ifdef CONFIG_BLOCK
1607         /* /sys/block has directories and does not need symlinks */
1608         if (sysfs_deprecated && dev->class == &block_class)
1609                 return 0;
1610 #endif
1611
1612         /* link in the class directory pointing to the device */
1613         error = sysfs_create_link(&dev->class->p->subsys.kobj,
1614                                   &dev->kobj, dev_name(dev));
1615         if (error)
1616                 goto out_device;
1617
1618         return 0;
1619
1620 out_device:
1621         sysfs_remove_link(&dev->kobj, "device");
1622
1623 out_subsys:
1624         sysfs_remove_link(&dev->kobj, "subsystem");
1625 out_devnode:
1626         sysfs_remove_link(&dev->kobj, "of_node");
1627         return error;
1628 }
1629
1630 static void device_remove_class_symlinks(struct device *dev)
1631 {
1632         if (dev_of_node(dev))
1633                 sysfs_remove_link(&dev->kobj, "of_node");
1634
1635         if (!dev->class)
1636                 return;
1637
1638         if (dev->parent && device_is_not_partition(dev))
1639                 sysfs_remove_link(&dev->kobj, "device");
1640         sysfs_remove_link(&dev->kobj, "subsystem");
1641 #ifdef CONFIG_BLOCK
1642         if (sysfs_deprecated && dev->class == &block_class)
1643                 return;
1644 #endif
1645         sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
1646 }
1647
1648 /**
1649  * dev_set_name - set a device name
1650  * @dev: device
1651  * @fmt: format string for the device's name
1652  */
1653 int dev_set_name(struct device *dev, const char *fmt, ...)
1654 {
1655         va_list vargs;
1656         int err;
1657
1658         va_start(vargs, fmt);
1659         err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
1660         va_end(vargs);
1661         return err;
1662 }
1663 EXPORT_SYMBOL_GPL(dev_set_name);
1664
1665 /**
1666  * device_to_dev_kobj - select a /sys/dev/ directory for the device
1667  * @dev: device
1668  *
1669  * By default we select char/ for new entries.  Setting class->dev_obj
1670  * to NULL prevents an entry from being created.  class->dev_kobj must
1671  * be set (or cleared) before any devices are registered to the class
1672  * otherwise device_create_sys_dev_entry() and
1673  * device_remove_sys_dev_entry() will disagree about the presence of
1674  * the link.
1675  */
1676 static struct kobject *device_to_dev_kobj(struct device *dev)
1677 {
1678         struct kobject *kobj;
1679
1680         if (dev->class)
1681                 kobj = dev->class->dev_kobj;
1682         else
1683                 kobj = sysfs_dev_char_kobj;
1684
1685         return kobj;
1686 }
1687
1688 static int device_create_sys_dev_entry(struct device *dev)
1689 {
1690         struct kobject *kobj = device_to_dev_kobj(dev);
1691         int error = 0;
1692         char devt_str[15];
1693
1694         if (kobj) {
1695                 format_dev_t(devt_str, dev->devt);
1696                 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
1697         }
1698
1699         return error;
1700 }
1701
1702 static void device_remove_sys_dev_entry(struct device *dev)
1703 {
1704         struct kobject *kobj = device_to_dev_kobj(dev);
1705         char devt_str[15];
1706
1707         if (kobj) {
1708                 format_dev_t(devt_str, dev->devt);
1709                 sysfs_remove_link(kobj, devt_str);
1710         }
1711 }
1712
1713 int device_private_init(struct device *dev)
1714 {
1715         dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
1716         if (!dev->p)
1717                 return -ENOMEM;
1718         dev->p->device = dev;
1719         klist_init(&dev->p->klist_children, klist_children_get,
1720                    klist_children_put);
1721         INIT_LIST_HEAD(&dev->p->deferred_probe);
1722         return 0;
1723 }
1724
1725 /**
1726  * device_add - add device to device hierarchy.
1727  * @dev: device.
1728  *
1729  * This is part 2 of device_register(), though may be called
1730  * separately _iff_ device_initialize() has been called separately.
1731  *
1732  * This adds @dev to the kobject hierarchy via kobject_add(), adds it
1733  * to the global and sibling lists for the device, then
1734  * adds it to the other relevant subsystems of the driver model.
1735  *
1736  * Do not call this routine or device_register() more than once for
1737  * any device structure.  The driver model core is not designed to work
1738  * with devices that get unregistered and then spring back to life.
1739  * (Among other things, it's very hard to guarantee that all references
1740  * to the previous incarnation of @dev have been dropped.)  Allocate
1741  * and register a fresh new struct device instead.
1742  *
1743  * NOTE: _Never_ directly free @dev after calling this function, even
1744  * if it returned an error! Always use put_device() to give up your
1745  * reference instead.
1746  */
1747 int device_add(struct device *dev)
1748 {
1749         struct device *parent;
1750         struct kobject *kobj;
1751         struct class_interface *class_intf;
1752         int error = -EINVAL;
1753         struct kobject *glue_dir = NULL;
1754
1755         dev = get_device(dev);
1756         if (!dev)
1757                 goto done;
1758
1759         if (!dev->p) {
1760                 error = device_private_init(dev);
1761                 if (error)
1762                         goto done;
1763         }
1764
1765         /*
1766          * for statically allocated devices, which should all be converted
1767          * some day, we need to initialize the name. We prevent reading back
1768          * the name, and force the use of dev_name()
1769          */
1770         if (dev->init_name) {
1771                 dev_set_name(dev, "%s", dev->init_name);
1772                 dev->init_name = NULL;
1773         }
1774
1775         /* subsystems can specify simple device enumeration */
1776         if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1777                 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1778
1779         if (!dev_name(dev)) {
1780                 error = -EINVAL;
1781                 goto name_error;
1782         }
1783
1784         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1785
1786         parent = get_device(dev->parent);
1787         kobj = get_device_parent(dev, parent);
1788         if (IS_ERR(kobj)) {
1789                 error = PTR_ERR(kobj);
1790                 goto parent_error;
1791         }
1792         if (kobj)
1793                 dev->kobj.parent = kobj;
1794
1795         /* use parent numa_node */
1796         if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
1797                 set_dev_node(dev, dev_to_node(parent));
1798
1799         /* first, register with generic layer. */
1800         /* we require the name to be set before, and pass NULL */
1801         error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1802         if (error) {
1803                 glue_dir = get_glue_dir(dev);
1804                 goto Error;
1805         }
1806
1807         /* notify platform of device entry */
1808         if (platform_notify)
1809                 platform_notify(dev);
1810
1811         error = device_create_file(dev, &dev_attr_uevent);
1812         if (error)
1813                 goto attrError;
1814
1815         error = device_add_class_symlinks(dev);
1816         if (error)
1817                 goto SymlinkError;
1818         error = device_add_attrs(dev);
1819         if (error)
1820                 goto AttrsError;
1821         error = bus_add_device(dev);
1822         if (error)
1823                 goto BusError;
1824         error = dpm_sysfs_add(dev);
1825         if (error)
1826                 goto DPMError;
1827         device_pm_add(dev);
1828
1829         if (MAJOR(dev->devt)) {
1830                 error = device_create_file(dev, &dev_attr_dev);
1831                 if (error)
1832                         goto DevAttrError;
1833
1834                 error = device_create_sys_dev_entry(dev);
1835                 if (error)
1836                         goto SysEntryError;
1837
1838                 devtmpfs_create_node(dev);
1839         }
1840
1841         /* Notify clients of device addition.  This call must come
1842          * after dpm_sysfs_add() and before kobject_uevent().
1843          */
1844         if (dev->bus)
1845                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1846                                              BUS_NOTIFY_ADD_DEVICE, dev);
1847
1848         kobject_uevent(&dev->kobj, KOBJ_ADD);
1849         bus_probe_device(dev);
1850         if (parent)
1851                 klist_add_tail(&dev->p->knode_parent,
1852                                &parent->p->klist_children);
1853
1854         if (dev->class) {
1855                 mutex_lock(&dev->class->p->mutex);
1856                 /* tie the class to the device */
1857                 klist_add_tail(&dev->knode_class,
1858                                &dev->class->p->klist_devices);
1859
1860                 /* notify any interfaces that the device is here */
1861                 list_for_each_entry(class_intf,
1862                                     &dev->class->p->interfaces, node)
1863                         if (class_intf->add_dev)
1864                                 class_intf->add_dev(dev, class_intf);
1865                 mutex_unlock(&dev->class->p->mutex);
1866         }
1867 done:
1868         put_device(dev);
1869         return error;
1870  SysEntryError:
1871         if (MAJOR(dev->devt))
1872                 device_remove_file(dev, &dev_attr_dev);
1873  DevAttrError:
1874         device_pm_remove(dev);
1875         dpm_sysfs_remove(dev);
1876  DPMError:
1877         bus_remove_device(dev);
1878  BusError:
1879         device_remove_attrs(dev);
1880  AttrsError:
1881         device_remove_class_symlinks(dev);
1882  SymlinkError:
1883         device_remove_file(dev, &dev_attr_uevent);
1884  attrError:
1885         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1886         glue_dir = get_glue_dir(dev);
1887         kobject_del(&dev->kobj);
1888  Error:
1889         cleanup_glue_dir(dev, glue_dir);
1890 parent_error:
1891         put_device(parent);
1892 name_error:
1893         kfree(dev->p);
1894         dev->p = NULL;
1895         goto done;
1896 }
1897 EXPORT_SYMBOL_GPL(device_add);
1898
1899 /**
1900  * device_register - register a device with the system.
1901  * @dev: pointer to the device structure
1902  *
1903  * This happens in two clean steps - initialize the device
1904  * and add it to the system. The two steps can be called
1905  * separately, but this is the easiest and most common.
1906  * I.e. you should only call the two helpers separately if
1907  * have a clearly defined need to use and refcount the device
1908  * before it is added to the hierarchy.
1909  *
1910  * For more information, see the kerneldoc for device_initialize()
1911  * and device_add().
1912  *
1913  * NOTE: _Never_ directly free @dev after calling this function, even
1914  * if it returned an error! Always use put_device() to give up the
1915  * reference initialized in this function instead.
1916  */
1917 int device_register(struct device *dev)
1918 {
1919         device_initialize(dev);
1920         return device_add(dev);
1921 }
1922 EXPORT_SYMBOL_GPL(device_register);
1923
1924 /**
1925  * get_device - increment reference count for device.
1926  * @dev: device.
1927  *
1928  * This simply forwards the call to kobject_get(), though
1929  * we do take care to provide for the case that we get a NULL
1930  * pointer passed in.
1931  */
1932 struct device *get_device(struct device *dev)
1933 {
1934         return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1935 }
1936 EXPORT_SYMBOL_GPL(get_device);
1937
1938 /**
1939  * put_device - decrement reference count.
1940  * @dev: device in question.
1941  */
1942 void put_device(struct device *dev)
1943 {
1944         /* might_sleep(); */
1945         if (dev)
1946                 kobject_put(&dev->kobj);
1947 }
1948 EXPORT_SYMBOL_GPL(put_device);
1949
1950 /**
1951  * device_del - delete device from system.
1952  * @dev: device.
1953  *
1954  * This is the first part of the device unregistration
1955  * sequence. This removes the device from the lists we control
1956  * from here, has it removed from the other driver model
1957  * subsystems it was added to in device_add(), and removes it
1958  * from the kobject hierarchy.
1959  *
1960  * NOTE: this should be called manually _iff_ device_add() was
1961  * also called manually.
1962  */
1963 void device_del(struct device *dev)
1964 {
1965         struct device *parent = dev->parent;
1966         struct kobject *glue_dir = NULL;
1967         struct class_interface *class_intf;
1968
1969         /* Notify clients of device removal.  This call must come
1970          * before dpm_sysfs_remove().
1971          */
1972         if (dev->bus)
1973                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1974                                              BUS_NOTIFY_DEL_DEVICE, dev);
1975
1976         dpm_sysfs_remove(dev);
1977         if (parent)
1978                 klist_del(&dev->p->knode_parent);
1979         if (MAJOR(dev->devt)) {
1980                 devtmpfs_delete_node(dev);
1981                 device_remove_sys_dev_entry(dev);
1982                 device_remove_file(dev, &dev_attr_dev);
1983         }
1984         if (dev->class) {
1985                 device_remove_class_symlinks(dev);
1986
1987                 mutex_lock(&dev->class->p->mutex);
1988                 /* notify any interfaces that the device is now gone */
1989                 list_for_each_entry(class_intf,
1990                                     &dev->class->p->interfaces, node)
1991                         if (class_intf->remove_dev)
1992                                 class_intf->remove_dev(dev, class_intf);
1993                 /* remove the device from the class list */
1994                 klist_del(&dev->knode_class);
1995                 mutex_unlock(&dev->class->p->mutex);
1996         }
1997         device_remove_file(dev, &dev_attr_uevent);
1998         device_remove_attrs(dev);
1999         bus_remove_device(dev);
2000         device_pm_remove(dev);
2001         driver_deferred_probe_del(dev);
2002         device_remove_properties(dev);
2003         device_links_purge(dev);
2004
2005         /* Notify the platform of the removal, in case they
2006          * need to do anything...
2007          */
2008         if (platform_notify_remove)
2009                 platform_notify_remove(dev);
2010         if (dev->bus)
2011                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
2012                                              BUS_NOTIFY_REMOVED_DEVICE, dev);
2013         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
2014         glue_dir = get_glue_dir(dev);
2015         kobject_del(&dev->kobj);
2016         cleanup_glue_dir(dev, glue_dir);
2017         put_device(parent);
2018 }
2019 EXPORT_SYMBOL_GPL(device_del);
2020
2021 /**
2022  * device_unregister - unregister device from system.
2023  * @dev: device going away.
2024  *
2025  * We do this in two parts, like we do device_register(). First,
2026  * we remove it from all the subsystems with device_del(), then
2027  * we decrement the reference count via put_device(). If that
2028  * is the final reference count, the device will be cleaned up
2029  * via device_release() above. Otherwise, the structure will
2030  * stick around until the final reference to the device is dropped.
2031  */
2032 void device_unregister(struct device *dev)
2033 {
2034         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
2035         device_del(dev);
2036         put_device(dev);
2037 }
2038 EXPORT_SYMBOL_GPL(device_unregister);
2039
2040 static struct device *prev_device(struct klist_iter *i)
2041 {
2042         struct klist_node *n = klist_prev(i);
2043         struct device *dev = NULL;
2044         struct device_private *p;
2045
2046         if (n) {
2047                 p = to_device_private_parent(n);
2048                 dev = p->device;
2049         }
2050         return dev;
2051 }
2052
2053 static struct device *next_device(struct klist_iter *i)
2054 {
2055         struct klist_node *n = klist_next(i);
2056         struct device *dev = NULL;
2057         struct device_private *p;
2058
2059         if (n) {
2060                 p = to_device_private_parent(n);
2061                 dev = p->device;
2062         }
2063         return dev;
2064 }
2065
2066 /**
2067  * device_get_devnode - path of device node file
2068  * @dev: device
2069  * @mode: returned file access mode
2070  * @uid: returned file owner
2071  * @gid: returned file group
2072  * @tmp: possibly allocated string
2073  *
2074  * Return the relative path of a possible device node.
2075  * Non-default names may need to allocate a memory to compose
2076  * a name. This memory is returned in tmp and needs to be
2077  * freed by the caller.
2078  */
2079 const char *device_get_devnode(struct device *dev,
2080                                umode_t *mode, kuid_t *uid, kgid_t *gid,
2081                                const char **tmp)
2082 {
2083         char *s;
2084
2085         *tmp = NULL;
2086
2087         /* the device type may provide a specific name */
2088         if (dev->type && dev->type->devnode)
2089                 *tmp = dev->type->devnode(dev, mode, uid, gid);
2090         if (*tmp)
2091                 return *tmp;
2092
2093         /* the class may provide a specific name */
2094         if (dev->class && dev->class->devnode)
2095                 *tmp = dev->class->devnode(dev, mode);
2096         if (*tmp)
2097                 return *tmp;
2098
2099         /* return name without allocation, tmp == NULL */
2100         if (strchr(dev_name(dev), '!') == NULL)
2101                 return dev_name(dev);
2102
2103         /* replace '!' in the name with '/' */
2104         s = kstrdup(dev_name(dev), GFP_KERNEL);
2105         if (!s)
2106                 return NULL;
2107         strreplace(s, '!', '/');
2108         return *tmp = s;
2109 }
2110
2111 /**
2112  * device_for_each_child - device child iterator.
2113  * @parent: parent struct device.
2114  * @fn: function to be called for each device.
2115  * @data: data for the callback.
2116  *
2117  * Iterate over @parent's child devices, and call @fn for each,
2118  * passing it @data.
2119  *
2120  * We check the return of @fn each time. If it returns anything
2121  * other than 0, we break out and return that value.
2122  */
2123 int device_for_each_child(struct device *parent, void *data,
2124                           int (*fn)(struct device *dev, void *data))
2125 {
2126         struct klist_iter i;
2127         struct device *child;
2128         int error = 0;
2129
2130         if (!parent->p)
2131                 return 0;
2132
2133         klist_iter_init(&parent->p->klist_children, &i);
2134         while ((child = next_device(&i)) && !error)
2135                 error = fn(child, data);
2136         klist_iter_exit(&i);
2137         return error;
2138 }
2139 EXPORT_SYMBOL_GPL(device_for_each_child);
2140
2141 /**
2142  * device_for_each_child_reverse - device child iterator in reversed order.
2143  * @parent: parent struct device.
2144  * @fn: function to be called for each device.
2145  * @data: data for the callback.
2146  *
2147  * Iterate over @parent's child devices, and call @fn for each,
2148  * passing it @data.
2149  *
2150  * We check the return of @fn each time. If it returns anything
2151  * other than 0, we break out and return that value.
2152  */
2153 int device_for_each_child_reverse(struct device *parent, void *data,
2154                                   int (*fn)(struct device *dev, void *data))
2155 {
2156         struct klist_iter i;
2157         struct device *child;
2158         int error = 0;
2159
2160         if (!parent->p)
2161                 return 0;
2162
2163         klist_iter_init(&parent->p->klist_children, &i);
2164         while ((child = prev_device(&i)) && !error)
2165                 error = fn(child, data);
2166         klist_iter_exit(&i);
2167         return error;
2168 }
2169 EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
2170
2171 /**
2172  * device_find_child - device iterator for locating a particular device.
2173  * @parent: parent struct device
2174  * @match: Callback function to check device
2175  * @data: Data to pass to match function
2176  *
2177  * This is similar to the device_for_each_child() function above, but it
2178  * returns a reference to a device that is 'found' for later use, as
2179  * determined by the @match callback.
2180  *
2181  * The callback should return 0 if the device doesn't match and non-zero
2182  * if it does.  If the callback returns non-zero and a reference to the
2183  * current device can be obtained, this function will return to the caller
2184  * and not iterate over any more devices.
2185  *
2186  * NOTE: you will need to drop the reference with put_device() after use.
2187  */
2188 struct device *device_find_child(struct device *parent, void *data,
2189                                  int (*match)(struct device *dev, void *data))
2190 {
2191         struct klist_iter i;
2192         struct device *child;
2193
2194         if (!parent)
2195                 return NULL;
2196
2197         klist_iter_init(&parent->p->klist_children, &i);
2198         while ((child = next_device(&i)))
2199                 if (match(child, data) && get_device(child))
2200                         break;
2201         klist_iter_exit(&i);
2202         return child;
2203 }
2204 EXPORT_SYMBOL_GPL(device_find_child);
2205
2206 int __init devices_init(void)
2207 {
2208         devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
2209         if (!devices_kset)
2210                 return -ENOMEM;
2211         dev_kobj = kobject_create_and_add("dev", NULL);
2212         if (!dev_kobj)
2213                 goto dev_kobj_err;
2214         sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
2215         if (!sysfs_dev_block_kobj)
2216                 goto block_kobj_err;
2217         sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
2218         if (!sysfs_dev_char_kobj)
2219                 goto char_kobj_err;
2220
2221         return 0;
2222
2223  char_kobj_err:
2224         kobject_put(sysfs_dev_block_kobj);
2225  block_kobj_err:
2226         kobject_put(dev_kobj);
2227  dev_kobj_err:
2228         kset_unregister(devices_kset);
2229         return -ENOMEM;
2230 }
2231
2232 static int device_check_offline(struct device *dev, void *not_used)
2233 {
2234         int ret;
2235
2236         ret = device_for_each_child(dev, NULL, device_check_offline);
2237         if (ret)
2238                 return ret;
2239
2240         return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
2241 }
2242
2243 /**
2244  * device_offline - Prepare the device for hot-removal.
2245  * @dev: Device to be put offline.
2246  *
2247  * Execute the device bus type's .offline() callback, if present, to prepare
2248  * the device for a subsequent hot-removal.  If that succeeds, the device must
2249  * not be used until either it is removed or its bus type's .online() callback
2250  * is executed.
2251  *
2252  * Call under device_hotplug_lock.
2253  */
2254 int device_offline(struct device *dev)
2255 {
2256         int ret;
2257
2258         if (dev->offline_disabled)
2259                 return -EPERM;
2260
2261         ret = device_for_each_child(dev, NULL, device_check_offline);
2262         if (ret)
2263                 return ret;
2264
2265         device_lock(dev);
2266         if (device_supports_offline(dev)) {
2267                 if (dev->offline) {
2268                         ret = 1;
2269                 } else {
2270                         ret = dev->bus->offline(dev);
2271                         if (!ret) {
2272                                 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
2273                                 dev->offline = true;
2274                         }
2275                 }
2276         }
2277         device_unlock(dev);
2278
2279         return ret;
2280 }
2281
2282 /**
2283  * device_online - Put the device back online after successful device_offline().
2284  * @dev: Device to be put back online.
2285  *
2286  * If device_offline() has been successfully executed for @dev, but the device
2287  * has not been removed subsequently, execute its bus type's .online() callback
2288  * to indicate that the device can be used again.
2289  *
2290  * Call under device_hotplug_lock.
2291  */
2292 int device_online(struct device *dev)
2293 {
2294         int ret = 0;
2295
2296         device_lock(dev);
2297         if (device_supports_offline(dev)) {
2298                 if (dev->offline) {
2299                         ret = dev->bus->online(dev);
2300                         if (!ret) {
2301                                 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
2302                                 dev->offline = false;
2303                         }
2304                 } else {
2305                         ret = 1;
2306                 }
2307         }
2308         device_unlock(dev);
2309
2310         return ret;
2311 }
2312
2313 struct root_device {
2314         struct device dev;
2315         struct module *owner;
2316 };
2317
2318 static inline struct root_device *to_root_device(struct device *d)
2319 {
2320         return container_of(d, struct root_device, dev);
2321 }
2322
2323 static void root_device_release(struct device *dev)
2324 {
2325         kfree(to_root_device(dev));
2326 }
2327
2328 /**
2329  * __root_device_register - allocate and register a root device
2330  * @name: root device name
2331  * @owner: owner module of the root device, usually THIS_MODULE
2332  *
2333  * This function allocates a root device and registers it
2334  * using device_register(). In order to free the returned
2335  * device, use root_device_unregister().
2336  *
2337  * Root devices are dummy devices which allow other devices
2338  * to be grouped under /sys/devices. Use this function to
2339  * allocate a root device and then use it as the parent of
2340  * any device which should appear under /sys/devices/{name}
2341  *
2342  * The /sys/devices/{name} directory will also contain a
2343  * 'module' symlink which points to the @owner directory
2344  * in sysfs.
2345  *
2346  * Returns &struct device pointer on success, or ERR_PTR() on error.
2347  *
2348  * Note: You probably want to use root_device_register().
2349  */
2350 struct device *__root_device_register(const char *name, struct module *owner)
2351 {
2352         struct root_device *root;
2353         int err = -ENOMEM;
2354
2355         root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
2356         if (!root)
2357                 return ERR_PTR(err);
2358
2359         err = dev_set_name(&root->dev, "%s", name);
2360         if (err) {
2361                 kfree(root);
2362                 return ERR_PTR(err);
2363         }
2364
2365         root->dev.release = root_device_release;
2366
2367         err = device_register(&root->dev);
2368         if (err) {
2369                 put_device(&root->dev);
2370                 return ERR_PTR(err);
2371         }
2372
2373 #ifdef CONFIG_MODULES   /* gotta find a "cleaner" way to do this */
2374         if (owner) {
2375                 struct module_kobject *mk = &owner->mkobj;
2376
2377                 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
2378                 if (err) {
2379                         device_unregister(&root->dev);
2380                         return ERR_PTR(err);
2381                 }
2382                 root->owner = owner;
2383         }
2384 #endif
2385
2386         return &root->dev;
2387 }
2388 EXPORT_SYMBOL_GPL(__root_device_register);
2389
2390 /**
2391  * root_device_unregister - unregister and free a root device
2392  * @dev: device going away
2393  *
2394  * This function unregisters and cleans up a device that was created by
2395  * root_device_register().
2396  */
2397 void root_device_unregister(struct device *dev)
2398 {
2399         struct root_device *root = to_root_device(dev);
2400
2401         if (root->owner)
2402                 sysfs_remove_link(&root->dev.kobj, "module");
2403
2404         device_unregister(dev);
2405 }
2406 EXPORT_SYMBOL_GPL(root_device_unregister);
2407
2408
2409 static void device_create_release(struct device *dev)
2410 {
2411         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
2412         kfree(dev);
2413 }
2414
2415 static struct device *
2416 device_create_groups_vargs(struct class *class, struct device *parent,
2417                            dev_t devt, void *drvdata,
2418                            const struct attribute_group **groups,
2419                            const char *fmt, va_list args)
2420 {
2421         struct device *dev = NULL;
2422         int retval = -ENODEV;
2423
2424         if (class == NULL || IS_ERR(class))
2425                 goto error;
2426
2427         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2428         if (!dev) {
2429                 retval = -ENOMEM;
2430                 goto error;
2431         }
2432
2433         device_initialize(dev);
2434         dev->devt = devt;
2435         dev->class = class;
2436         dev->parent = parent;
2437         dev->groups = groups;
2438         dev->release = device_create_release;
2439         dev_set_drvdata(dev, drvdata);
2440
2441         retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
2442         if (retval)
2443                 goto error;
2444
2445         retval = device_add(dev);
2446         if (retval)
2447                 goto error;
2448
2449         return dev;
2450
2451 error:
2452         put_device(dev);
2453         return ERR_PTR(retval);
2454 }
2455
2456 /**
2457  * device_create_vargs - creates a device and registers it with sysfs
2458  * @class: pointer to the struct class that this device should be registered to
2459  * @parent: pointer to the parent struct device of this new device, if any
2460  * @devt: the dev_t for the char device to be added
2461  * @drvdata: the data to be added to the device for callbacks
2462  * @fmt: string for the device's name
2463  * @args: va_list for the device's name
2464  *
2465  * This function can be used by char device classes.  A struct device
2466  * will be created in sysfs, registered to the specified class.
2467  *
2468  * A "dev" file will be created, showing the dev_t for the device, if
2469  * the dev_t is not 0,0.
2470  * If a pointer to a parent struct device is passed in, the newly created
2471  * struct device will be a child of that device in sysfs.
2472  * The pointer to the struct device will be returned from the call.
2473  * Any further sysfs files that might be required can be created using this
2474  * pointer.
2475  *
2476  * Returns &struct device pointer on success, or ERR_PTR() on error.
2477  *
2478  * Note: the struct class passed to this function must have previously
2479  * been created with a call to class_create().
2480  */
2481 struct device *device_create_vargs(struct class *class, struct device *parent,
2482                                    dev_t devt, void *drvdata, const char *fmt,
2483                                    va_list args)
2484 {
2485         return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
2486                                           fmt, args);
2487 }
2488 EXPORT_SYMBOL_GPL(device_create_vargs);
2489
2490 /**
2491  * device_create - creates a device and registers it with sysfs
2492  * @class: pointer to the struct class that this device should be registered to
2493  * @parent: pointer to the parent struct device of this new device, if any
2494  * @devt: the dev_t for the char device to be added
2495  * @drvdata: the data to be added to the device for callbacks
2496  * @fmt: string for the device's name
2497  *
2498  * This function can be used by char device classes.  A struct device
2499  * will be created in sysfs, registered to the specified class.
2500  *
2501  * A "dev" file will be created, showing the dev_t for the device, if
2502  * the dev_t is not 0,0.
2503  * If a pointer to a parent struct device is passed in, the newly created
2504  * struct device will be a child of that device in sysfs.
2505  * The pointer to the struct device will be returned from the call.
2506  * Any further sysfs files that might be required can be created using this
2507  * pointer.
2508  *
2509  * Returns &struct device pointer on success, or ERR_PTR() on error.
2510  *
2511  * Note: the struct class passed to this function must have previously
2512  * been created with a call to class_create().
2513  */
2514 struct device *device_create(struct class *class, struct device *parent,
2515                              dev_t devt, void *drvdata, const char *fmt, ...)
2516 {
2517         va_list vargs;
2518         struct device *dev;
2519
2520         va_start(vargs, fmt);
2521         dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
2522         va_end(vargs);
2523         return dev;
2524 }
2525 EXPORT_SYMBOL_GPL(device_create);
2526
2527 /**
2528  * device_create_with_groups - creates a device and registers it with sysfs
2529  * @class: pointer to the struct class that this device should be registered to
2530  * @parent: pointer to the parent struct device of this new device, if any
2531  * @devt: the dev_t for the char device to be added
2532  * @drvdata: the data to be added to the device for callbacks
2533  * @groups: NULL-terminated list of attribute groups to be created
2534  * @fmt: string for the device's name
2535  *
2536  * This function can be used by char device classes.  A struct device
2537  * will be created in sysfs, registered to the specified class.
2538  * Additional attributes specified in the groups parameter will also
2539  * be created automatically.
2540  *
2541  * A "dev" file will be created, showing the dev_t for the device, if
2542  * the dev_t is not 0,0.
2543  * If a pointer to a parent struct device is passed in, the newly created
2544  * struct device will be a child of that device in sysfs.
2545  * The pointer to the struct device will be returned from the call.
2546  * Any further sysfs files that might be required can be created using this
2547  * pointer.
2548  *
2549  * Returns &struct device pointer on success, or ERR_PTR() on error.
2550  *
2551  * Note: the struct class passed to this function must have previously
2552  * been created with a call to class_create().
2553  */
2554 struct device *device_create_with_groups(struct class *class,
2555                                          struct device *parent, dev_t devt,
2556                                          void *drvdata,
2557                                          const struct attribute_group **groups,
2558                                          const char *fmt, ...)
2559 {
2560         va_list vargs;
2561         struct device *dev;
2562
2563         va_start(vargs, fmt);
2564         dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
2565                                          fmt, vargs);
2566         va_end(vargs);
2567         return dev;
2568 }
2569 EXPORT_SYMBOL_GPL(device_create_with_groups);
2570
2571 static int __match_devt(struct device *dev, const void *data)
2572 {
2573         const dev_t *devt = data;
2574
2575         return dev->devt == *devt;
2576 }
2577
2578 /**
2579  * device_destroy - removes a device that was created with device_create()
2580  * @class: pointer to the struct class that this device was registered with
2581  * @devt: the dev_t of the device that was previously registered
2582  *
2583  * This call unregisters and cleans up a device that was created with a
2584  * call to device_create().
2585  */
2586 void device_destroy(struct class *class, dev_t devt)
2587 {
2588         struct device *dev;
2589
2590         dev = class_find_device(class, NULL, &devt, __match_devt);
2591         if (dev) {
2592                 put_device(dev);
2593                 device_unregister(dev);
2594         }
2595 }
2596 EXPORT_SYMBOL_GPL(device_destroy);
2597
2598 /**
2599  * device_rename - renames a device
2600  * @dev: the pointer to the struct device to be renamed
2601  * @new_name: the new name of the device
2602  *
2603  * It is the responsibility of the caller to provide mutual
2604  * exclusion between two different calls of device_rename
2605  * on the same device to ensure that new_name is valid and
2606  * won't conflict with other devices.
2607  *
2608  * Note: Don't call this function.  Currently, the networking layer calls this
2609  * function, but that will change.  The following text from Kay Sievers offers
2610  * some insight:
2611  *
2612  * Renaming devices is racy at many levels, symlinks and other stuff are not
2613  * replaced atomically, and you get a "move" uevent, but it's not easy to
2614  * connect the event to the old and new device. Device nodes are not renamed at
2615  * all, there isn't even support for that in the kernel now.
2616  *
2617  * In the meantime, during renaming, your target name might be taken by another
2618  * driver, creating conflicts. Or the old name is taken directly after you
2619  * renamed it -- then you get events for the same DEVPATH, before you even see
2620  * the "move" event. It's just a mess, and nothing new should ever rely on
2621  * kernel device renaming. Besides that, it's not even implemented now for
2622  * other things than (driver-core wise very simple) network devices.
2623  *
2624  * We are currently about to change network renaming in udev to completely
2625  * disallow renaming of devices in the same namespace as the kernel uses,
2626  * because we can't solve the problems properly, that arise with swapping names
2627  * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
2628  * be allowed to some other name than eth[0-9]*, for the aforementioned
2629  * reasons.
2630  *
2631  * Make up a "real" name in the driver before you register anything, or add
2632  * some other attributes for userspace to find the device, or use udev to add
2633  * symlinks -- but never rename kernel devices later, it's a complete mess. We
2634  * don't even want to get into that and try to implement the missing pieces in
2635  * the core. We really have other pieces to fix in the driver core mess. :)
2636  */
2637 int device_rename(struct device *dev, const char *new_name)
2638 {
2639         struct kobject *kobj = &dev->kobj;
2640         char *old_device_name = NULL;
2641         int error;
2642
2643         dev = get_device(dev);
2644         if (!dev)
2645                 return -EINVAL;
2646
2647         dev_dbg(dev, "renaming to %s\n", new_name);
2648
2649         old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
2650         if (!old_device_name) {
2651                 error = -ENOMEM;
2652                 goto out;
2653         }
2654
2655         if (dev->class) {
2656                 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
2657                                              kobj, old_device_name,
2658                                              new_name, kobject_namespace(kobj));
2659                 if (error)
2660                         goto out;
2661         }
2662
2663         error = kobject_rename(kobj, new_name);
2664         if (error)
2665                 goto out;
2666
2667 out:
2668         put_device(dev);
2669
2670         kfree(old_device_name);
2671
2672         return error;
2673 }
2674 EXPORT_SYMBOL_GPL(device_rename);
2675
2676 static int device_move_class_links(struct device *dev,
2677                                    struct device *old_parent,
2678                                    struct device *new_parent)
2679 {
2680         int error = 0;
2681
2682         if (old_parent)
2683                 sysfs_remove_link(&dev->kobj, "device");
2684         if (new_parent)
2685                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
2686                                           "device");
2687         return error;
2688 }
2689
2690 /**
2691  * device_move - moves a device to a new parent
2692  * @dev: the pointer to the struct device to be moved
2693  * @new_parent: the new parent of the device (can by NULL)
2694  * @dpm_order: how to reorder the dpm_list
2695  */
2696 int device_move(struct device *dev, struct device *new_parent,
2697                 enum dpm_order dpm_order)
2698 {
2699         int error;
2700         struct device *old_parent;
2701         struct kobject *new_parent_kobj;
2702
2703         dev = get_device(dev);
2704         if (!dev)
2705                 return -EINVAL;
2706
2707         device_pm_lock();
2708         new_parent = get_device(new_parent);
2709         new_parent_kobj = get_device_parent(dev, new_parent);
2710         if (IS_ERR(new_parent_kobj)) {
2711                 error = PTR_ERR(new_parent_kobj);
2712                 put_device(new_parent);
2713                 goto out;
2714         }
2715
2716         pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
2717                  __func__, new_parent ? dev_name(new_parent) : "<NULL>");
2718         error = kobject_move(&dev->kobj, new_parent_kobj);
2719         if (error) {
2720                 cleanup_glue_dir(dev, new_parent_kobj);
2721                 put_device(new_parent);
2722                 goto out;
2723         }
2724         old_parent = dev->parent;
2725         dev->parent = new_parent;
2726         if (old_parent)
2727                 klist_remove(&dev->p->knode_parent);
2728         if (new_parent) {
2729                 klist_add_tail(&dev->p->knode_parent,
2730                                &new_parent->p->klist_children);
2731                 set_dev_node(dev, dev_to_node(new_parent));
2732         }
2733
2734         if (dev->class) {
2735                 error = device_move_class_links(dev, old_parent, new_parent);
2736                 if (error) {
2737                         /* We ignore errors on cleanup since we're hosed anyway... */
2738                         device_move_class_links(dev, new_parent, old_parent);
2739                         if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
2740                                 if (new_parent)
2741                                         klist_remove(&dev->p->knode_parent);
2742                                 dev->parent = old_parent;
2743                                 if (old_parent) {
2744                                         klist_add_tail(&dev->p->knode_parent,
2745                                                        &old_parent->p->klist_children);
2746                                         set_dev_node(dev, dev_to_node(old_parent));
2747                                 }
2748                         }
2749                         cleanup_glue_dir(dev, new_parent_kobj);
2750                         put_device(new_parent);
2751                         goto out;
2752                 }
2753         }
2754         switch (dpm_order) {
2755         case DPM_ORDER_NONE:
2756                 break;
2757         case DPM_ORDER_DEV_AFTER_PARENT:
2758                 device_pm_move_after(dev, new_parent);
2759                 devices_kset_move_after(dev, new_parent);
2760                 break;
2761         case DPM_ORDER_PARENT_BEFORE_DEV:
2762                 device_pm_move_before(new_parent, dev);
2763                 devices_kset_move_before(new_parent, dev);
2764                 break;
2765         case DPM_ORDER_DEV_LAST:
2766                 device_pm_move_last(dev);
2767                 devices_kset_move_last(dev);
2768                 break;
2769         }
2770
2771         put_device(old_parent);
2772 out:
2773         device_pm_unlock();
2774         put_device(dev);
2775         return error;
2776 }
2777 EXPORT_SYMBOL_GPL(device_move);
2778
2779 /**
2780  * device_shutdown - call ->shutdown() on each device to shutdown.
2781  */
2782 void device_shutdown(void)
2783 {
2784         struct device *dev, *parent;
2785
2786         wait_for_device_probe();
2787         device_block_probing();
2788
2789         spin_lock(&devices_kset->list_lock);
2790         /*
2791          * Walk the devices list backward, shutting down each in turn.
2792          * Beware that device unplug events may also start pulling
2793          * devices offline, even as the system is shutting down.
2794          */
2795         while (!list_empty(&devices_kset->list)) {
2796                 dev = list_entry(devices_kset->list.prev, struct device,
2797                                 kobj.entry);
2798
2799                 /*
2800                  * hold reference count of device's parent to
2801                  * prevent it from being freed because parent's
2802                  * lock is to be held
2803                  */
2804                 parent = get_device(dev->parent);
2805                 get_device(dev);
2806                 /*
2807                  * Make sure the device is off the kset list, in the
2808                  * event that dev->*->shutdown() doesn't remove it.
2809                  */
2810                 list_del_init(&dev->kobj.entry);
2811                 spin_unlock(&devices_kset->list_lock);
2812
2813                 /* hold lock to avoid race with probe/release */
2814                 if (parent)
2815                         device_lock(parent);
2816                 device_lock(dev);
2817
2818                 /* Don't allow any more runtime suspends */
2819                 pm_runtime_get_noresume(dev);
2820                 pm_runtime_barrier(dev);
2821
2822                 if (dev->class && dev->class->shutdown_pre) {
2823                         if (initcall_debug)
2824                                 dev_info(dev, "shutdown_pre\n");
2825                         dev->class->shutdown_pre(dev);
2826                 }
2827                 if (dev->bus && dev->bus->shutdown) {
2828                         if (initcall_debug)
2829                                 dev_info(dev, "shutdown\n");
2830                         dev->bus->shutdown(dev);
2831                 } else if (dev->driver && dev->driver->shutdown) {
2832                         if (initcall_debug)
2833                                 dev_info(dev, "shutdown\n");
2834                         dev->driver->shutdown(dev);
2835                 }
2836
2837                 device_unlock(dev);
2838                 if (parent)
2839                         device_unlock(parent);
2840
2841                 put_device(dev);
2842                 put_device(parent);
2843
2844                 spin_lock(&devices_kset->list_lock);
2845         }
2846         spin_unlock(&devices_kset->list_lock);
2847 }
2848
2849 /*
2850  * Device logging functions
2851  */
2852
2853 #ifdef CONFIG_PRINTK
2854 static int
2855 create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2856 {
2857         const char *subsys;
2858         size_t pos = 0;
2859
2860         if (dev->class)
2861                 subsys = dev->class->name;
2862         else if (dev->bus)
2863                 subsys = dev->bus->name;
2864         else
2865                 return 0;
2866
2867         pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2868         if (pos >= hdrlen)
2869                 goto overflow;
2870
2871         /*
2872          * Add device identifier DEVICE=:
2873          *   b12:8         block dev_t
2874          *   c127:3        char dev_t
2875          *   n8            netdev ifindex
2876          *   +sound:card0  subsystem:devname
2877          */
2878         if (MAJOR(dev->devt)) {
2879                 char c;
2880
2881                 if (strcmp(subsys, "block") == 0)
2882                         c = 'b';
2883                 else
2884                         c = 'c';
2885                 pos++;
2886                 pos += snprintf(hdr + pos, hdrlen - pos,
2887                                 "DEVICE=%c%u:%u",
2888                                 c, MAJOR(dev->devt), MINOR(dev->devt));
2889         } else if (strcmp(subsys, "net") == 0) {
2890                 struct net_device *net = to_net_dev(dev);
2891
2892                 pos++;
2893                 pos += snprintf(hdr + pos, hdrlen - pos,
2894                                 "DEVICE=n%u", net->ifindex);
2895         } else {
2896                 pos++;
2897                 pos += snprintf(hdr + pos, hdrlen - pos,
2898                                 "DEVICE=+%s:%s", subsys, dev_name(dev));
2899         }
2900
2901         if (pos >= hdrlen)
2902                 goto overflow;
2903
2904         return pos;
2905
2906 overflow:
2907         dev_WARN(dev, "device/subsystem name too long");
2908         return 0;
2909 }
2910
2911 int dev_vprintk_emit(int level, const struct device *dev,
2912                      const char *fmt, va_list args)
2913 {
2914         char hdr[128];
2915         size_t hdrlen;
2916
2917         hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2918
2919         return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2920 }
2921 EXPORT_SYMBOL(dev_vprintk_emit);
2922
2923 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2924 {
2925         va_list args;
2926         int r;
2927
2928         va_start(args, fmt);
2929
2930         r = dev_vprintk_emit(level, dev, fmt, args);
2931
2932         va_end(args);
2933
2934         return r;
2935 }
2936 EXPORT_SYMBOL(dev_printk_emit);
2937
2938 static void __dev_printk(const char *level, const struct device *dev,
2939                         struct va_format *vaf)
2940 {
2941         if (dev)
2942                 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2943                                 dev_driver_string(dev), dev_name(dev), vaf);
2944         else
2945                 printk("%s(NULL device *): %pV", level, vaf);
2946 }
2947
2948 void dev_printk(const char *level, const struct device *dev,
2949                 const char *fmt, ...)
2950 {
2951         struct va_format vaf;
2952         va_list args;
2953
2954         va_start(args, fmt);
2955
2956         vaf.fmt = fmt;
2957         vaf.va = &args;
2958
2959         __dev_printk(level, dev, &vaf);
2960
2961         va_end(args);
2962 }
2963 EXPORT_SYMBOL(dev_printk);
2964
2965 #define define_dev_printk_level(func, kern_level)               \
2966 void func(const struct device *dev, const char *fmt, ...)       \
2967 {                                                               \
2968         struct va_format vaf;                                   \
2969         va_list args;                                           \
2970                                                                 \
2971         va_start(args, fmt);                                    \
2972                                                                 \
2973         vaf.fmt = fmt;                                          \
2974         vaf.va = &args;                                         \
2975                                                                 \
2976         __dev_printk(kern_level, dev, &vaf);                    \
2977                                                                 \
2978         va_end(args);                                           \
2979 }                                                               \
2980 EXPORT_SYMBOL(func);
2981
2982 define_dev_printk_level(dev_emerg, KERN_EMERG);
2983 define_dev_printk_level(dev_alert, KERN_ALERT);
2984 define_dev_printk_level(dev_crit, KERN_CRIT);
2985 define_dev_printk_level(dev_err, KERN_ERR);
2986 define_dev_printk_level(dev_warn, KERN_WARNING);
2987 define_dev_printk_level(dev_notice, KERN_NOTICE);
2988 define_dev_printk_level(_dev_info, KERN_INFO);
2989
2990 #endif
2991
2992 static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2993 {
2994         return fwnode && !IS_ERR(fwnode->secondary);
2995 }
2996
2997 /**
2998  * set_primary_fwnode - Change the primary firmware node of a given device.
2999  * @dev: Device to handle.
3000  * @fwnode: New primary firmware node of the device.
3001  *
3002  * Set the device's firmware node pointer to @fwnode, but if a secondary
3003  * firmware node of the device is present, preserve it.
3004  */
3005 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
3006 {
3007         if (fwnode) {
3008                 struct fwnode_handle *fn = dev->fwnode;
3009
3010                 if (fwnode_is_primary(fn))
3011                         fn = fn->secondary;
3012
3013                 if (fn) {
3014                         WARN_ON(fwnode->secondary);
3015                         fwnode->secondary = fn;
3016                 }
3017                 dev->fwnode = fwnode;
3018         } else {
3019                 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
3020                         dev->fwnode->secondary : NULL;
3021         }
3022 }
3023 EXPORT_SYMBOL_GPL(set_primary_fwnode);
3024
3025 /**
3026  * set_secondary_fwnode - Change the secondary firmware node of a given device.
3027  * @dev: Device to handle.
3028  * @fwnode: New secondary firmware node of the device.
3029  *
3030  * If a primary firmware node of the device is present, set its secondary
3031  * pointer to @fwnode.  Otherwise, set the device's firmware node pointer to
3032  * @fwnode.
3033  */
3034 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
3035 {
3036         if (fwnode)
3037                 fwnode->secondary = ERR_PTR(-ENODEV);
3038
3039         if (fwnode_is_primary(dev->fwnode))
3040                 dev->fwnode->secondary = fwnode;
3041         else
3042                 dev->fwnode = fwnode;
3043 }
3044
3045 /**
3046  * device_set_of_node_from_dev - reuse device-tree node of another device
3047  * @dev: device whose device-tree node is being set
3048  * @dev2: device whose device-tree node is being reused
3049  *
3050  * Takes another reference to the new device-tree node after first dropping
3051  * any reference held to the old node.
3052  */
3053 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2)
3054 {
3055         of_node_put(dev->of_node);
3056         dev->of_node = of_node_get(dev2->of_node);
3057         dev->of_node_reused = true;
3058 }
3059 EXPORT_SYMBOL_GPL(device_set_of_node_from_dev);