blob: 8dde934f8d15a2906a99a0835a76e5fb0c2c92bc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Greg Kroah-Hartman64bb5d22006-06-28 16:19:58 -07006 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * This file is released under the GPLv2
10 *
11 */
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/device.h>
14#include <linux/err.h>
Rafael J. Wysocki97badf82015-04-03 23:23:37 +020015#include <linux/fwnode.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/slab.h>
19#include <linux/string.h>
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -070020#include <linux/kdev_t.h>
Benjamin Herrenschmidt116af372006-10-25 13:44:59 +100021#include <linux/notifier.h>
Grant Likely07d57a32012-02-01 11:22:22 -070022#include <linux/of.h>
23#include <linux/of_device.h>
Kay Sieversda231fd2007-11-21 17:29:15 +010024#include <linux/genhd.h>
Andrew Morton815d2d52008-03-04 15:09:07 -080025#include <linux/kallsyms.h>
Dave Youngf75b1c62008-05-28 09:28:39 -070026#include <linux/mutex.h>
Peter Chenaf8db152011-11-15 21:52:29 +010027#include <linux/pm_runtime.h>
Kay Sieversc4e00da2012-05-03 02:29:59 +020028#include <linux/netdevice.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010029#include <linux/sched/signal.h>
Greg Kroah-Hartman63967682013-08-27 10:24:15 -070030#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#include "base.h"
33#include "power/power.h"
34
Andi Kleene52eec12010-09-08 16:54:17 +020035#ifdef CONFIG_SYSFS_DEPRECATED
36#ifdef CONFIG_SYSFS_DEPRECATED_V2
37long sysfs_deprecated = 1;
38#else
39long sysfs_deprecated = 0;
40#endif
Hanjun Guo3454bf92013-08-17 20:42:24 +080041static int __init sysfs_deprecated_setup(char *arg)
Andi Kleene52eec12010-09-08 16:54:17 +020042{
Jingoo Han34da5e62013-07-26 13:10:22 +090043 return kstrtol(arg, 10, &sysfs_deprecated);
Andi Kleene52eec12010-09-08 16:54:17 +020044}
45early_param("sysfs.deprecated", sysfs_deprecated_setup);
46#endif
47
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +010048/* Device links support. */
49
50#ifdef CONFIG_SRCU
51static DEFINE_MUTEX(device_links_lock);
52DEFINE_STATIC_SRCU(device_links_srcu);
53
54static inline void device_links_write_lock(void)
55{
56 mutex_lock(&device_links_lock);
57}
58
59static inline void device_links_write_unlock(void)
60{
61 mutex_unlock(&device_links_lock);
62}
63
64int device_links_read_lock(void)
65{
66 return srcu_read_lock(&device_links_srcu);
67}
68
69void device_links_read_unlock(int idx)
70{
71 srcu_read_unlock(&device_links_srcu, idx);
72}
73#else /* !CONFIG_SRCU */
74static DECLARE_RWSEM(device_links_lock);
75
76static inline void device_links_write_lock(void)
77{
78 down_write(&device_links_lock);
79}
80
81static inline void device_links_write_unlock(void)
82{
83 up_write(&device_links_lock);
84}
85
86int device_links_read_lock(void)
87{
88 down_read(&device_links_lock);
89 return 0;
90}
91
92void 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 */
106static 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
129static 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 *
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100156 * 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 *
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100164 * 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
Lukas Wunner64df1142016-12-04 13:10:04 +0100176 * not be registered, however.
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100177 */
178struct 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
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100205 link = kzalloc(sizeof(*link), GFP_KERNEL);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100206 if (!link)
207 goto out;
208
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100209 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;
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100218 }
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100219 pm_runtime_new_link(consumer);
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100220 }
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100221 get_device(supplier);
222 link->supplier = supplier;
223 INIT_LIST_HEAD(&link->s_node);
224 get_device(consumer);
225 link->consumer = consumer;
226 INIT_LIST_HEAD(&link->c_node);
227 link->flags = flags;
228
Lukas Wunner64df1142016-12-04 13:10:04 +0100229 /* Determine the initial link state. */
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100230 if (flags & DL_FLAG_STATELESS) {
231 link->status = DL_STATE_NONE;
232 } else {
233 switch (supplier->links.status) {
234 case DL_DEV_DRIVER_BOUND:
235 switch (consumer->links.status) {
236 case DL_DEV_PROBING:
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100237 /*
238 * Balance the decrementation of the supplier's
239 * runtime PM usage counter after consumer probe
240 * in driver_probe_device().
241 */
242 if (flags & DL_FLAG_PM_RUNTIME)
243 pm_runtime_get_sync(supplier);
244
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100245 link->status = DL_STATE_CONSUMER_PROBE;
246 break;
247 case DL_DEV_DRIVER_BOUND:
248 link->status = DL_STATE_ACTIVE;
249 break;
250 default:
251 link->status = DL_STATE_AVAILABLE;
252 break;
253 }
254 break;
255 case DL_DEV_UNBINDING:
256 link->status = DL_STATE_SUPPLIER_UNBIND;
257 break;
258 default:
259 link->status = DL_STATE_DORMANT;
260 break;
261 }
262 }
263
264 /*
265 * Move the consumer and all of the devices depending on it to the end
266 * of dpm_list and the devices_kset list.
267 *
268 * It is necessary to hold dpm_list locked throughout all that or else
269 * we may end up suspending with a wrong ordering of it.
270 */
271 device_reorder_to_tail(consumer, NULL);
272
273 list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
274 list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);
275
276 dev_info(consumer, "Linked as a consumer to %s\n", dev_name(supplier));
277
278 out:
279 device_pm_unlock();
280 device_links_write_unlock();
281 return link;
282}
283EXPORT_SYMBOL_GPL(device_link_add);
284
285static void device_link_free(struct device_link *link)
286{
287 put_device(link->consumer);
288 put_device(link->supplier);
289 kfree(link);
290}
291
292#ifdef CONFIG_SRCU
293static void __device_link_free_srcu(struct rcu_head *rhead)
294{
295 device_link_free(container_of(rhead, struct device_link, rcu_head));
296}
297
298static void __device_link_del(struct device_link *link)
299{
300 dev_info(link->consumer, "Dropping the link to %s\n",
301 dev_name(link->supplier));
302
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100303 if (link->flags & DL_FLAG_PM_RUNTIME)
304 pm_runtime_drop_link(link->consumer);
305
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100306 list_del_rcu(&link->s_node);
307 list_del_rcu(&link->c_node);
308 call_srcu(&device_links_srcu, &link->rcu_head, __device_link_free_srcu);
309}
310#else /* !CONFIG_SRCU */
311static void __device_link_del(struct device_link *link)
312{
313 dev_info(link->consumer, "Dropping the link to %s\n",
314 dev_name(link->supplier));
315
316 list_del(&link->s_node);
317 list_del(&link->c_node);
318 device_link_free(link);
319}
320#endif /* !CONFIG_SRCU */
321
322/**
323 * device_link_del - Delete a link between two devices.
324 * @link: Device link to delete.
325 *
326 * The caller must ensure proper synchronization of this function with runtime
327 * PM.
328 */
329void device_link_del(struct device_link *link)
330{
331 device_links_write_lock();
332 device_pm_lock();
333 __device_link_del(link);
334 device_pm_unlock();
335 device_links_write_unlock();
336}
337EXPORT_SYMBOL_GPL(device_link_del);
338
339static void device_links_missing_supplier(struct device *dev)
340{
341 struct device_link *link;
342
343 list_for_each_entry(link, &dev->links.suppliers, c_node)
344 if (link->status == DL_STATE_CONSUMER_PROBE)
345 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
346}
347
348/**
349 * device_links_check_suppliers - Check presence of supplier drivers.
350 * @dev: Consumer device.
351 *
352 * Check links from this device to any suppliers. Walk the list of the device's
353 * links to suppliers and see if all of them are available. If not, simply
354 * return -EPROBE_DEFER.
355 *
356 * We need to guarantee that the supplier will not go away after the check has
357 * been positive here. It only can go away in __device_release_driver() and
358 * that function checks the device's links to consumers. This means we need to
359 * mark the link as "consumer probe in progress" to make the supplier removal
360 * wait for us to complete (or bad things may happen).
361 *
362 * Links with the DL_FLAG_STATELESS flag set are ignored.
363 */
364int device_links_check_suppliers(struct device *dev)
365{
366 struct device_link *link;
367 int ret = 0;
368
369 device_links_write_lock();
370
371 list_for_each_entry(link, &dev->links.suppliers, c_node) {
372 if (link->flags & DL_FLAG_STATELESS)
373 continue;
374
375 if (link->status != DL_STATE_AVAILABLE) {
376 device_links_missing_supplier(dev);
377 ret = -EPROBE_DEFER;
378 break;
379 }
380 WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
381 }
382 dev->links.status = DL_DEV_PROBING;
383
384 device_links_write_unlock();
385 return ret;
386}
387
388/**
389 * device_links_driver_bound - Update device links after probing its driver.
390 * @dev: Device to update the links for.
391 *
392 * The probe has been successful, so update links from this device to any
393 * consumers by changing their status to "available".
394 *
395 * Also change the status of @dev's links to suppliers to "active".
396 *
397 * Links with the DL_FLAG_STATELESS flag set are ignored.
398 */
399void device_links_driver_bound(struct device *dev)
400{
401 struct device_link *link;
402
403 device_links_write_lock();
404
405 list_for_each_entry(link, &dev->links.consumers, s_node) {
406 if (link->flags & DL_FLAG_STATELESS)
407 continue;
408
409 WARN_ON(link->status != DL_STATE_DORMANT);
410 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
411 }
412
413 list_for_each_entry(link, &dev->links.suppliers, c_node) {
414 if (link->flags & DL_FLAG_STATELESS)
415 continue;
416
417 WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
418 WRITE_ONCE(link->status, DL_STATE_ACTIVE);
419 }
420
421 dev->links.status = DL_DEV_DRIVER_BOUND;
422
423 device_links_write_unlock();
424}
425
426/**
427 * __device_links_no_driver - Update links of a device without a driver.
428 * @dev: Device without a drvier.
429 *
430 * Delete all non-persistent links from this device to any suppliers.
431 *
432 * Persistent links stay around, but their status is changed to "available",
433 * unless they already are in the "supplier unbind in progress" state in which
434 * case they need not be updated.
435 *
436 * Links with the DL_FLAG_STATELESS flag set are ignored.
437 */
438static void __device_links_no_driver(struct device *dev)
439{
440 struct device_link *link, *ln;
441
442 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
443 if (link->flags & DL_FLAG_STATELESS)
444 continue;
445
446 if (link->flags & DL_FLAG_AUTOREMOVE)
447 __device_link_del(link);
448 else if (link->status != DL_STATE_SUPPLIER_UNBIND)
449 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
450 }
451
452 dev->links.status = DL_DEV_NO_DRIVER;
453}
454
455void device_links_no_driver(struct device *dev)
456{
457 device_links_write_lock();
458 __device_links_no_driver(dev);
459 device_links_write_unlock();
460}
461
462/**
463 * device_links_driver_cleanup - Update links after driver removal.
464 * @dev: Device whose driver has just gone away.
465 *
466 * Update links to consumers for @dev by changing their status to "dormant" and
467 * invoke %__device_links_no_driver() to update links to suppliers for it as
468 * appropriate.
469 *
470 * Links with the DL_FLAG_STATELESS flag set are ignored.
471 */
472void device_links_driver_cleanup(struct device *dev)
473{
474 struct device_link *link;
475
476 device_links_write_lock();
477
478 list_for_each_entry(link, &dev->links.consumers, s_node) {
479 if (link->flags & DL_FLAG_STATELESS)
480 continue;
481
482 WARN_ON(link->flags & DL_FLAG_AUTOREMOVE);
483 WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
484 WRITE_ONCE(link->status, DL_STATE_DORMANT);
485 }
486
487 __device_links_no_driver(dev);
488
489 device_links_write_unlock();
490}
491
492/**
493 * device_links_busy - Check if there are any busy links to consumers.
494 * @dev: Device to check.
495 *
496 * Check each consumer of the device and return 'true' if its link's status
497 * is one of "consumer probe" or "active" (meaning that the given consumer is
498 * probing right now or its driver is present). Otherwise, change the link
499 * state to "supplier unbind" to prevent the consumer from being probed
500 * successfully going forward.
501 *
502 * Return 'false' if there are no probing or active consumers.
503 *
504 * Links with the DL_FLAG_STATELESS flag set are ignored.
505 */
506bool device_links_busy(struct device *dev)
507{
508 struct device_link *link;
509 bool ret = false;
510
511 device_links_write_lock();
512
513 list_for_each_entry(link, &dev->links.consumers, s_node) {
514 if (link->flags & DL_FLAG_STATELESS)
515 continue;
516
517 if (link->status == DL_STATE_CONSUMER_PROBE
518 || link->status == DL_STATE_ACTIVE) {
519 ret = true;
520 break;
521 }
522 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
523 }
524
525 dev->links.status = DL_DEV_UNBINDING;
526
527 device_links_write_unlock();
528 return ret;
529}
530
531/**
532 * device_links_unbind_consumers - Force unbind consumers of the given device.
533 * @dev: Device to unbind the consumers of.
534 *
535 * Walk the list of links to consumers for @dev and if any of them is in the
536 * "consumer probe" state, wait for all device probes in progress to complete
537 * and start over.
538 *
539 * If that's not the case, change the status of the link to "supplier unbind"
540 * and check if the link was in the "active" state. If so, force the consumer
541 * driver to unbind and start over (the consumer will not re-probe as we have
542 * changed the state of the link already).
543 *
544 * Links with the DL_FLAG_STATELESS flag set are ignored.
545 */
546void device_links_unbind_consumers(struct device *dev)
547{
548 struct device_link *link;
549
550 start:
551 device_links_write_lock();
552
553 list_for_each_entry(link, &dev->links.consumers, s_node) {
554 enum device_link_state status;
555
556 if (link->flags & DL_FLAG_STATELESS)
557 continue;
558
559 status = link->status;
560 if (status == DL_STATE_CONSUMER_PROBE) {
561 device_links_write_unlock();
562
563 wait_for_device_probe();
564 goto start;
565 }
566 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
567 if (status == DL_STATE_ACTIVE) {
568 struct device *consumer = link->consumer;
569
570 get_device(consumer);
571
572 device_links_write_unlock();
573
574 device_release_driver_internal(consumer, NULL,
575 consumer->parent);
576 put_device(consumer);
577 goto start;
578 }
579 }
580
581 device_links_write_unlock();
582}
583
584/**
585 * device_links_purge - Delete existing links to other devices.
586 * @dev: Target device.
587 */
588static void device_links_purge(struct device *dev)
589{
590 struct device_link *link, *ln;
591
592 /*
593 * Delete all of the remaining links from this device to any other
594 * devices (either consumers or suppliers).
595 */
596 device_links_write_lock();
597
598 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
599 WARN_ON(link->status == DL_STATE_ACTIVE);
600 __device_link_del(link);
601 }
602
603 list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
604 WARN_ON(link->status != DL_STATE_DORMANT &&
605 link->status != DL_STATE_NONE);
606 __device_link_del(link);
607 }
608
609 device_links_write_unlock();
610}
611
612/* Device links support end. */
613
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800614int (*platform_notify)(struct device *dev) = NULL;
615int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -0700616static struct kobject *dev_kobj;
617struct kobject *sysfs_dev_char_kobj;
618struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200620static DEFINE_MUTEX(device_hotplug_lock);
621
622void lock_device_hotplug(void)
623{
624 mutex_lock(&device_hotplug_lock);
625}
626
627void unlock_device_hotplug(void)
628{
629 mutex_unlock(&device_hotplug_lock);
630}
631
632int lock_device_hotplug_sysfs(void)
633{
634 if (mutex_trylock(&device_hotplug_lock))
635 return 0;
636
637 /* Avoid busy looping (5 ms of sleep should do). */
638 msleep(5);
639 return restart_syscall();
640}
641
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800642#ifdef CONFIG_BLOCK
643static inline int device_is_not_partition(struct device *dev)
644{
645 return !(dev->type == &part_type);
646}
647#else
648static inline int device_is_not_partition(struct device *dev)
649{
650 return 1;
651}
652#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Alan Stern3e956372006-06-16 17:10:48 -0400654/**
655 * dev_driver_string - Return a device's driver name, if at all possible
656 * @dev: struct device to get the name of
657 *
658 * Will return the device's driver's name if it is bound to a device. If
yan9169c012012-04-20 21:08:45 +0800659 * the device is not bound to a driver, it will return the name of the bus
Alan Stern3e956372006-06-16 17:10:48 -0400660 * it is attached to. If it is not attached to a bus either, an empty
661 * string will be returned.
662 */
Jean Delvarebf9ca692008-07-30 12:29:21 -0700663const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -0400664{
Alan Stern35899722009-12-04 11:06:57 -0500665 struct device_driver *drv;
666
667 /* dev->driver can change to NULL underneath us because of unbinding,
668 * so be careful about accessing it. dev->bus and dev->class should
669 * never change once they are set, so they don't need special care.
670 */
671 drv = ACCESS_ONCE(dev->driver);
672 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +0100673 (dev->bus ? dev->bus->name :
674 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -0400675}
Matthew Wilcox310a9222006-09-23 23:35:04 -0600676EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -0400677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
679
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800680static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
681 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800683 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200684 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500685 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400688 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -0800689 if (ret >= (ssize_t)PAGE_SIZE) {
Greg Kroah-Hartman53a9c872013-01-17 13:10:23 -0800690 print_symbol("dev_attr_show: %s returned bad count\n",
691 (unsigned long)dev_attr->show);
Andrew Morton815d2d52008-03-04 15:09:07 -0800692 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 return ret;
694}
695
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800696static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
697 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800699 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200700 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500701 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
703 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400704 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 return ret;
706}
707
Emese Revfy52cf25d2010-01-19 02:58:23 +0100708static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 .show = dev_attr_show,
710 .store = dev_attr_store,
711};
712
Kay Sieversca22e562011-12-14 14:29:38 -0800713#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
714
715ssize_t device_store_ulong(struct device *dev,
716 struct device_attribute *attr,
717 const char *buf, size_t size)
718{
719 struct dev_ext_attribute *ea = to_ext_attr(attr);
720 char *end;
721 unsigned long new = simple_strtoul(buf, &end, 0);
722 if (end == buf)
723 return -EINVAL;
724 *(unsigned long *)(ea->var) = new;
725 /* Always return full write size even if we didn't consume all */
726 return size;
727}
728EXPORT_SYMBOL_GPL(device_store_ulong);
729
730ssize_t device_show_ulong(struct device *dev,
731 struct device_attribute *attr,
732 char *buf)
733{
734 struct dev_ext_attribute *ea = to_ext_attr(attr);
735 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
736}
737EXPORT_SYMBOL_GPL(device_show_ulong);
738
739ssize_t device_store_int(struct device *dev,
740 struct device_attribute *attr,
741 const char *buf, size_t size)
742{
743 struct dev_ext_attribute *ea = to_ext_attr(attr);
744 char *end;
745 long new = simple_strtol(buf, &end, 0);
746 if (end == buf || new > INT_MAX || new < INT_MIN)
747 return -EINVAL;
748 *(int *)(ea->var) = new;
749 /* Always return full write size even if we didn't consume all */
750 return size;
751}
752EXPORT_SYMBOL_GPL(device_store_int);
753
754ssize_t device_show_int(struct device *dev,
755 struct device_attribute *attr,
756 char *buf)
757{
758 struct dev_ext_attribute *ea = to_ext_attr(attr);
759
760 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
761}
762EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
Borislav Petkov91872392012-10-09 19:52:05 +0200764ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
765 const char *buf, size_t size)
766{
767 struct dev_ext_attribute *ea = to_ext_attr(attr);
768
769 if (strtobool(buf, ea->var) < 0)
770 return -EINVAL;
771
772 return size;
773}
774EXPORT_SYMBOL_GPL(device_store_bool);
775
776ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
777 char *buf)
778{
779 struct dev_ext_attribute *ea = to_ext_attr(attr);
780
781 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
782}
783EXPORT_SYMBOL_GPL(device_show_bool);
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785/**
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400786 * device_release - free device structure.
787 * @kobj: device's kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 *
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400789 * This is called once the reference count for the object
790 * reaches 0. We forward the call to the device's release
791 * method, which should handle actually freeing the structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800793static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200795 struct device *dev = kobj_to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800796 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Ming Leia525a3d2012-07-25 01:42:29 +0800798 /*
799 * Some platform devices are driven without driver attached
800 * and managed resources may have been acquired. Make sure
801 * all resources are released.
802 *
803 * Drivers still can add resources into device after device
804 * is deleted but alive, so release devres here to avoid
805 * possible memory leak.
806 */
807 devres_release_all(dev);
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 if (dev->release)
810 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200811 else if (dev->type && dev->type->release)
812 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700813 else if (dev->class && dev->class->dev_release)
814 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700815 else
816 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800817 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100818 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800819 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820}
821
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700822static const void *device_namespace(struct kobject *kobj)
823{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200824 struct device *dev = kobj_to_dev(kobj);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700825 const void *ns = NULL;
826
827 if (dev->class && dev->class->ns_type)
828 ns = dev->class->namespace(dev);
829
830 return ns;
831}
832
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600833static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 .release = device_release,
835 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700836 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837};
838
839
Kay Sievers312c0042005-11-16 09:00:00 +0100840static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
842 struct kobj_type *ktype = get_ktype(kobj);
843
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600844 if (ktype == &device_ktype) {
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200845 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 if (dev->bus)
847 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700848 if (dev->class)
849 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 }
851 return 0;
852}
853
Kay Sievers312c0042005-11-16 09:00:00 +0100854static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200856 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700858 if (dev->bus)
859 return dev->bus->name;
860 if (dev->class)
861 return dev->class->name;
862 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
864
Kay Sievers7eff2e72007-08-14 15:15:12 +0200865static int dev_uevent(struct kset *kset, struct kobject *kobj,
866 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200868 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 int retval = 0;
870
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200871 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700872 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200873 const char *tmp;
874 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400875 umode_t mode = 0;
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700876 kuid_t uid = GLOBAL_ROOT_UID;
877 kgid_t gid = GLOBAL_ROOT_GID;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200878
Kay Sievers7eff2e72007-08-14 15:15:12 +0200879 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
880 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700881 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200882 if (name) {
883 add_uevent_var(env, "DEVNAME=%s", name);
Kay Sieverse454cea2009-09-18 23:01:12 +0200884 if (mode)
885 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700886 if (!uid_eq(uid, GLOBAL_ROOT_UID))
887 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
888 if (!gid_eq(gid, GLOBAL_ROOT_GID))
889 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700890 kfree(tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200891 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700892 }
893
Kay Sievers414264f2007-03-12 21:08:57 +0100894 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200895 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100896
Kay Sievers239378f2006-10-07 21:54:55 +0200897 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200898 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200899
Grant Likely07d57a32012-02-01 11:22:22 -0700900 /* Add common DT information about the device */
901 of_device_uevent(dev, env);
902
Kay Sievers7eff2e72007-08-14 15:15:12 +0200903 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100904 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200905 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200906 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800907 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100908 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 }
910
Kay Sievers7eff2e72007-08-14 15:15:12 +0200911 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700912 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200913 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200914 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800915 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100916 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800917 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200918 }
919
Stefan Weileef35c22010-08-06 21:11:15 +0200920 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200921 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200922 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200923 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800924 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100925 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800926 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700927 }
928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 return retval;
930}
931
Emese Revfy9cd43612009-12-31 14:52:51 +0100932static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100933 .filter = dev_uevent_filter,
934 .name = dev_uevent_name,
935 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936};
937
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700938static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
Kay Sievers16574dc2007-04-06 01:40:38 +0200939 char *buf)
940{
941 struct kobject *top_kobj;
942 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200943 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200944 int i;
945 size_t count = 0;
946 int retval;
947
948 /* search the kset, the device belongs to */
949 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200950 while (!top_kobj->kset && top_kobj->parent)
951 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200952 if (!top_kobj->kset)
953 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200954
Kay Sievers16574dc2007-04-06 01:40:38 +0200955 kset = top_kobj->kset;
956 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
957 goto out;
958
959 /* respect filter */
960 if (kset->uevent_ops && kset->uevent_ops->filter)
961 if (!kset->uevent_ops->filter(kset, &dev->kobj))
962 goto out;
963
Kay Sievers7eff2e72007-08-14 15:15:12 +0200964 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
965 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200966 return -ENOMEM;
967
Kay Sievers16574dc2007-04-06 01:40:38 +0200968 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200969 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200970 if (retval)
971 goto out;
972
973 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200974 for (i = 0; i < env->envp_idx; i++)
975 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200976out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200977 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200978 return count;
979}
980
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700981static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
Kay Sieversa7fd6702005-10-01 14:49:43 +0200982 const char *buf, size_t count)
983{
Peter Rajnohaf36776f2017-05-09 15:22:30 +0200984 if (kobject_synth_uevent(&dev->kobj, buf, count))
985 dev_err(dev, "uevent: failed to send synthetic uevent\n");
Kay Sievers60a96a52007-07-08 22:29:26 +0200986
Kay Sieversa7fd6702005-10-01 14:49:43 +0200987 return count;
988}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700989static DEVICE_ATTR_RW(uevent);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200990
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700991static ssize_t online_show(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200992 char *buf)
993{
994 bool val;
995
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200996 device_lock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200997 val = !dev->offline;
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200998 device_unlock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200999 return sprintf(buf, "%u\n", val);
1000}
1001
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001002static ssize_t online_store(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001003 const char *buf, size_t count)
1004{
1005 bool val;
1006 int ret;
1007
1008 ret = strtobool(buf, &val);
1009 if (ret < 0)
1010 return ret;
1011
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001012 ret = lock_device_hotplug_sysfs();
1013 if (ret)
1014 return ret;
1015
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001016 ret = val ? device_online(dev) : device_offline(dev);
1017 unlock_device_hotplug();
1018 return ret < 0 ? ret : count;
1019}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001020static DEVICE_ATTR_RW(online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001021
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -07001022int device_add_groups(struct device *dev, const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001023{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -07001024 return sysfs_create_groups(&dev->kobj, groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001025}
1026
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -07001027void device_remove_groups(struct device *dev,
1028 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001029{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -07001030 sysfs_remove_groups(&dev->kobj, groups);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -07001031}
1032
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001033static int device_add_attrs(struct device *dev)
1034{
1035 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -07001036 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001037 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001038
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001039 if (class) {
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001040 error = device_add_groups(dev, class->dev_groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001041 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001042 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001043 }
Kay Sieversf9f852d2006-10-07 21:54:55 +02001044
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001045 if (type) {
1046 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001047 if (error)
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -07001048 goto err_remove_class_groups;
Kay Sieversf9f852d2006-10-07 21:54:55 +02001049 }
1050
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001051 error = device_add_groups(dev, dev->groups);
1052 if (error)
1053 goto err_remove_type_groups;
1054
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001055 if (device_supports_offline(dev) && !dev->offline_disabled) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001056 error = device_create_file(dev, &dev_attr_online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001057 if (error)
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +01001058 goto err_remove_dev_groups;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001059 }
1060
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001061 return 0;
1062
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +01001063 err_remove_dev_groups:
1064 device_remove_groups(dev, dev->groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001065 err_remove_type_groups:
1066 if (type)
1067 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001068 err_remove_class_groups:
1069 if (class)
1070 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001071
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001072 return error;
1073}
1074
1075static void device_remove_attrs(struct device *dev)
1076{
1077 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -07001078 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001079
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001080 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001081 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001082
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001083 if (type)
1084 device_remove_groups(dev, type->groups);
1085
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -07001086 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001087 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001088}
1089
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001090static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001091 char *buf)
1092{
1093 return print_dev_t(buf, dev->devt);
1094}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001095static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001096
Kay Sieversca22e562011-12-14 14:29:38 -08001097/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001098struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100/**
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03001101 * devices_kset_move_before - Move device in the devices_kset's list.
1102 * @deva: Device to move.
1103 * @devb: Device @deva should come before.
1104 */
1105static void devices_kset_move_before(struct device *deva, struct device *devb)
1106{
1107 if (!devices_kset)
1108 return;
1109 pr_debug("devices_kset: Moving %s before %s\n",
1110 dev_name(deva), dev_name(devb));
1111 spin_lock(&devices_kset->list_lock);
1112 list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
1113 spin_unlock(&devices_kset->list_lock);
1114}
1115
1116/**
1117 * devices_kset_move_after - Move device in the devices_kset's list.
1118 * @deva: Device to move
1119 * @devb: Device @deva should come after.
1120 */
1121static void devices_kset_move_after(struct device *deva, struct device *devb)
1122{
1123 if (!devices_kset)
1124 return;
1125 pr_debug("devices_kset: Moving %s after %s\n",
1126 dev_name(deva), dev_name(devb));
1127 spin_lock(&devices_kset->list_lock);
1128 list_move(&deva->kobj.entry, &devb->kobj.entry);
1129 spin_unlock(&devices_kset->list_lock);
1130}
1131
1132/**
1133 * devices_kset_move_last - move the device to the end of devices_kset's list.
1134 * @dev: device to move
1135 */
1136void devices_kset_move_last(struct device *dev)
1137{
1138 if (!devices_kset)
1139 return;
1140 pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
1141 spin_lock(&devices_kset->list_lock);
1142 list_move_tail(&dev->kobj.entry, &devices_kset->list);
1143 spin_unlock(&devices_kset->list_lock);
1144}
1145
1146/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001147 * device_create_file - create sysfs attribute file for device.
1148 * @dev: device.
1149 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
Phil Carmody26579ab2009-12-18 15:34:19 +02001151int device_create_file(struct device *dev,
1152 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153{
1154 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001155
1156 if (dev) {
1157 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +08001158 "Attribute %s: write permission without 'store'\n",
1159 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001160 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +08001161 "Attribute %s: read permission without 'show'\n",
1162 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001164 }
1165
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 return error;
1167}
David Graham White86df2682013-07-21 20:41:14 -04001168EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001171 * device_remove_file - remove sysfs attribute file.
1172 * @dev: device.
1173 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 */
Phil Carmody26579ab2009-12-18 15:34:19 +02001175void device_remove_file(struct device *dev,
1176 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
Cornelia Huck0c98b192008-01-31 10:39:38 +01001178 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180}
David Graham White86df2682013-07-21 20:41:14 -04001181EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001183/**
Tejun Heo6b0afc22014-02-03 14:03:01 -05001184 * device_remove_file_self - remove sysfs attribute file from its own method.
1185 * @dev: device.
1186 * @attr: device attribute descriptor.
1187 *
1188 * See kernfs_remove_self() for details.
1189 */
1190bool device_remove_file_self(struct device *dev,
1191 const struct device_attribute *attr)
1192{
1193 if (dev)
1194 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
1195 else
1196 return false;
1197}
1198EXPORT_SYMBOL_GPL(device_remove_file_self);
1199
1200/**
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001201 * device_create_bin_file - create sysfs binary attribute file for device.
1202 * @dev: device.
1203 * @attr: device binary attribute descriptor.
1204 */
Phil Carmody66ecb922009-12-18 15:34:20 +02001205int device_create_bin_file(struct device *dev,
1206 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001207{
1208 int error = -EINVAL;
1209 if (dev)
1210 error = sysfs_create_bin_file(&dev->kobj, attr);
1211 return error;
1212}
1213EXPORT_SYMBOL_GPL(device_create_bin_file);
1214
1215/**
1216 * device_remove_bin_file - remove sysfs binary attribute file
1217 * @dev: device.
1218 * @attr: device binary attribute descriptor.
1219 */
Phil Carmody66ecb922009-12-18 15:34:20 +02001220void device_remove_bin_file(struct device *dev,
1221 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001222{
1223 if (dev)
1224 sysfs_remove_bin_file(&dev->kobj, attr);
1225}
1226EXPORT_SYMBOL_GPL(device_remove_bin_file);
1227
James Bottomley34bb61f2005-09-06 16:56:51 -07001228static void klist_children_get(struct klist_node *n)
1229{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001230 struct device_private *p = to_device_private_parent(n);
1231 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -07001232
1233 get_device(dev);
1234}
1235
1236static void klist_children_put(struct klist_node *n)
1237{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001238 struct device_private *p = to_device_private_parent(n);
1239 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -07001240
1241 put_device(dev);
1242}
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001245 * device_initialize - init device structure.
1246 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 *
Cornelia Huck57394112008-09-03 18:26:40 +02001248 * This prepares the device for use by other layers by initializing
1249 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001250 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +02001251 * that function, though it can also be called separately, so one
1252 * may use @dev's fields. In particular, get_device()/put_device()
1253 * may be used for reference counting of @dev after calling this
1254 * function.
1255 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001256 * All fields in @dev must be initialized by the caller to 0, except
1257 * for those explicitly set to some other value. The simplest
1258 * approach is to use kzalloc() to allocate the structure containing
1259 * @dev.
1260 *
Cornelia Huck57394112008-09-03 18:26:40 +02001261 * NOTE: Use put_device() to give up your reference instead of freeing
1262 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264void device_initialize(struct device *dev)
1265{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001266 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -07001267 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +00001269 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +01001270 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +09001271 spin_lock_init(&dev->devres_lock);
1272 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -04001273 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -08001274 set_dev_node(dev, -1);
Jiang Liu4a7cc832015-07-09 16:00:44 +08001275#ifdef CONFIG_GENERIC_MSI_IRQ
1276 INIT_LIST_HEAD(&dev->msi_list);
1277#endif
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +01001278 INIT_LIST_HEAD(&dev->links.consumers);
1279 INIT_LIST_HEAD(&dev->links.suppliers);
1280 dev->links.status = DL_DEV_NO_DRIVER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
David Graham White86df2682013-07-21 20:41:14 -04001282EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Tejun Heod73ce002013-03-12 11:30:05 -07001284struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001285{
Kay Sievers86406242007-03-14 03:25:56 +01001286 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001287
Kay Sievers86406242007-03-14 03:25:56 +01001288 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -08001289 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001290 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001291
Kay Sievers86406242007-03-14 03:25:56 +01001292 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001293}
1294
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001295struct class_dir {
1296 struct kobject kobj;
1297 struct class *class;
1298};
1299
1300#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
1301
1302static void class_dir_release(struct kobject *kobj)
1303{
1304 struct class_dir *dir = to_class_dir(kobj);
1305 kfree(dir);
1306}
1307
1308static const
1309struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
1310{
1311 struct class_dir *dir = to_class_dir(kobj);
1312 return dir->class->ns_type;
1313}
1314
1315static struct kobj_type class_dir_ktype = {
1316 .release = class_dir_release,
1317 .sysfs_ops = &kobj_sysfs_ops,
1318 .child_ns_type = class_dir_child_ns_type
1319};
1320
1321static struct kobject *
1322class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
1323{
1324 struct class_dir *dir;
1325 int retval;
1326
1327 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
1328 if (!dir)
1329 return NULL;
1330
1331 dir->class = class;
1332 kobject_init(&dir->kobj, &class_dir_ktype);
1333
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001334 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001335
1336 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
1337 if (retval < 0) {
1338 kobject_put(&dir->kobj);
1339 return NULL;
1340 }
1341 return &dir->kobj;
1342}
1343
Yijing Wange4a60d12014-11-07 12:05:49 +08001344static DEFINE_MUTEX(gdp_mutex);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001345
Kay Sieversda231fd2007-11-21 17:29:15 +01001346static struct kobject *get_device_parent(struct device *dev,
1347 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001348{
Kay Sievers86406242007-03-14 03:25:56 +01001349 if (dev->class) {
1350 struct kobject *kobj = NULL;
1351 struct kobject *parent_kobj;
1352 struct kobject *k;
1353
Randy Dunlapead454f2010-09-24 14:36:49 -07001354#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -07001355 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +02001356 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -07001357 if (parent && parent->class == &block_class)
1358 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001359 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -07001360 }
Randy Dunlapead454f2010-09-24 14:36:49 -07001361#endif
Andi Kleene52eec12010-09-08 16:54:17 +02001362
Kay Sievers86406242007-03-14 03:25:56 +01001363 /*
1364 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001365 * Class-devices with a non class-device as parent, live
1366 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +01001367 */
1368 if (parent == NULL)
1369 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -07001370 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +01001371 return &parent->kobj;
1372 else
1373 parent_kobj = &parent->kobj;
1374
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001375 mutex_lock(&gdp_mutex);
1376
Kay Sievers86406242007-03-14 03:25:56 +01001377 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001378 spin_lock(&dev->class->p->glue_dirs.list_lock);
1379 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +01001380 if (k->parent == parent_kobj) {
1381 kobj = kobject_get(k);
1382 break;
1383 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001384 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001385 if (kobj) {
1386 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +01001387 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001388 }
Kay Sievers86406242007-03-14 03:25:56 +01001389
1390 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001391 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001392 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001393 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -08001394 return k;
Kay Sievers86406242007-03-14 03:25:56 +01001395 }
1396
Kay Sieversca22e562011-12-14 14:29:38 -08001397 /* subsystems can specify a default root directory for their devices */
1398 if (!parent && dev->bus && dev->bus->dev_root)
1399 return &dev->bus->dev_root->kobj;
1400
Kay Sievers86406242007-03-14 03:25:56 +01001401 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001402 return &parent->kobj;
1403 return NULL;
1404}
Kay Sieversda231fd2007-11-21 17:29:15 +01001405
Ming Leicebf8fd2016-07-10 19:27:36 +08001406static inline bool live_in_glue_dir(struct kobject *kobj,
1407 struct device *dev)
1408{
1409 if (!kobj || !dev->class ||
1410 kobj->kset != &dev->class->p->glue_dirs)
1411 return false;
1412 return true;
1413}
1414
1415static inline struct kobject *get_glue_dir(struct device *dev)
1416{
1417 return dev->kobj.parent;
1418}
1419
1420/*
1421 * make sure cleaning up dir as the last step, we need to make
1422 * sure .release handler of kobject is run with holding the
1423 * global lock
1424 */
Cornelia Huck63b69712008-01-21 16:09:44 +01001425static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +01001426{
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001427 /* see if we live in a "glue" directory */
Ming Leicebf8fd2016-07-10 19:27:36 +08001428 if (!live_in_glue_dir(glue_dir, dev))
Kay Sieversda231fd2007-11-21 17:29:15 +01001429 return;
1430
Yijing Wange4a60d12014-11-07 12:05:49 +08001431 mutex_lock(&gdp_mutex);
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001432 kobject_put(glue_dir);
Yijing Wange4a60d12014-11-07 12:05:49 +08001433 mutex_unlock(&gdp_mutex);
Kay Sieversda231fd2007-11-21 17:29:15 +01001434}
Cornelia Huck63b69712008-01-21 16:09:44 +01001435
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001436static int device_add_class_symlinks(struct device *dev)
1437{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001438 struct device_node *of_node = dev_of_node(dev);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001439 int error;
1440
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001441 if (of_node) {
1442 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
1443 if (error)
1444 dev_warn(dev, "Error %d creating of_node link\n",error);
1445 /* An error here doesn't warrant bringing down the device */
1446 }
1447
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001448 if (!dev->class)
1449 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +01001450
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001451 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001452 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001453 "subsystem");
1454 if (error)
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001455 goto out_devnode;
Kay Sieversda231fd2007-11-21 17:29:15 +01001456
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -08001457 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -07001458 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
1459 "device");
1460 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -07001461 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001462 }
Kay Sievers39aba962010-09-04 22:33:14 -07001463
Randy Dunlapead454f2010-09-24 14:36:49 -07001464#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -07001465 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +02001466 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -07001467 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -07001468#endif
Kay Sievers39aba962010-09-04 22:33:14 -07001469
1470 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001471 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -07001472 &dev->kobj, dev_name(dev));
1473 if (error)
1474 goto out_device;
1475
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001476 return 0;
1477
Kay Sievers39aba962010-09-04 22:33:14 -07001478out_device:
1479 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +01001480
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001481out_subsys:
1482 sysfs_remove_link(&dev->kobj, "subsystem");
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001483out_devnode:
1484 sysfs_remove_link(&dev->kobj, "of_node");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001485 return error;
1486}
1487
1488static void device_remove_class_symlinks(struct device *dev)
1489{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001490 if (dev_of_node(dev))
1491 sysfs_remove_link(&dev->kobj, "of_node");
1492
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001493 if (!dev->class)
1494 return;
Kay Sieversda231fd2007-11-21 17:29:15 +01001495
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -08001496 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +01001497 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001498 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -07001499#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +02001500 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -07001501 return;
Randy Dunlapead454f2010-09-24 14:36:49 -07001502#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001503 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001504}
1505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506/**
Stephen Rothwell413c2392008-05-30 10:16:40 +10001507 * dev_set_name - set a device name
1508 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -07001509 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +10001510 */
1511int dev_set_name(struct device *dev, const char *fmt, ...)
1512{
1513 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001514 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +10001515
1516 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001517 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +10001518 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001519 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +10001520}
1521EXPORT_SYMBOL_GPL(dev_set_name);
1522
1523/**
Dan Williamse105b8b2008-04-21 10:51:07 -07001524 * device_to_dev_kobj - select a /sys/dev/ directory for the device
1525 * @dev: device
1526 *
1527 * By default we select char/ for new entries. Setting class->dev_obj
1528 * to NULL prevents an entry from being created. class->dev_kobj must
1529 * be set (or cleared) before any devices are registered to the class
1530 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +02001531 * device_remove_sys_dev_entry() will disagree about the presence of
1532 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -07001533 */
1534static struct kobject *device_to_dev_kobj(struct device *dev)
1535{
1536 struct kobject *kobj;
1537
1538 if (dev->class)
1539 kobj = dev->class->dev_kobj;
1540 else
1541 kobj = sysfs_dev_char_kobj;
1542
1543 return kobj;
1544}
1545
1546static int device_create_sys_dev_entry(struct device *dev)
1547{
1548 struct kobject *kobj = device_to_dev_kobj(dev);
1549 int error = 0;
1550 char devt_str[15];
1551
1552 if (kobj) {
1553 format_dev_t(devt_str, dev->devt);
1554 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
1555 }
1556
1557 return error;
1558}
1559
1560static void device_remove_sys_dev_entry(struct device *dev)
1561{
1562 struct kobject *kobj = device_to_dev_kobj(dev);
1563 char devt_str[15];
1564
1565 if (kobj) {
1566 format_dev_t(devt_str, dev->devt);
1567 sysfs_remove_link(kobj, devt_str);
1568 }
1569}
1570
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001571int device_private_init(struct device *dev)
1572{
1573 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
1574 if (!dev->p)
1575 return -ENOMEM;
1576 dev->p->device = dev;
1577 klist_init(&dev->p->klist_children, klist_children_get,
1578 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -08001579 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001580 return 0;
1581}
1582
Dan Williamse105b8b2008-04-21 10:51:07 -07001583/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001584 * device_add - add device to device hierarchy.
1585 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001587 * This is part 2 of device_register(), though may be called
1588 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 *
Cornelia Huck57394112008-09-03 18:26:40 +02001590 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001591 * to the global and sibling lists for the device, then
1592 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +02001593 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001594 * Do not call this routine or device_register() more than once for
1595 * any device structure. The driver model core is not designed to work
1596 * with devices that get unregistered and then spring back to life.
1597 * (Among other things, it's very hard to guarantee that all references
1598 * to the previous incarnation of @dev have been dropped.) Allocate
1599 * and register a fresh new struct device instead.
1600 *
Cornelia Huck57394112008-09-03 18:26:40 +02001601 * NOTE: _Never_ directly free @dev after calling this function, even
1602 * if it returned an error! Always use put_device() to give up your
1603 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 */
1605int device_add(struct device *dev)
1606{
Viresh Kumar35dbf4e2017-03-17 12:24:22 +05301607 struct device *parent;
Kay Sieversca22e562011-12-14 14:29:38 -08001608 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001609 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001610 int error = -EINVAL;
Ming Leicebf8fd2016-07-10 19:27:36 +08001611 struct kobject *glue_dir = NULL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001614 if (!dev)
1615 goto done;
1616
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001617 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001618 error = device_private_init(dev);
1619 if (error)
1620 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001621 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001622
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001623 /*
1624 * for statically allocated devices, which should all be converted
1625 * some day, we need to initialize the name. We prevent reading back
1626 * the name, and force the use of dev_name()
1627 */
1628 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001629 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001630 dev->init_name = NULL;
1631 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001632
Kay Sieversca22e562011-12-14 14:29:38 -08001633 /* subsystems can specify simple device enumeration */
1634 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1635 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1636
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001637 if (!dev_name(dev)) {
1638 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001639 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001640 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001642 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001645 kobj = get_device_parent(dev, parent);
1646 if (kobj)
1647 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Yinghai Lu0d358f22008-02-19 03:20:41 -08001649 /* use parent numa_node */
Zhen Lei56f2de82015-08-25 12:08:22 +08001650 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
Yinghai Lu0d358f22008-02-19 03:20:41 -08001651 set_dev_node(dev, dev_to_node(parent));
1652
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001654 /* we require the name to be set before, and pass NULL */
1655 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Ming Leicebf8fd2016-07-10 19:27:36 +08001656 if (error) {
1657 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 goto Error;
Ming Leicebf8fd2016-07-10 19:27:36 +08001659 }
Kay Sieversa7fd6702005-10-01 14:49:43 +02001660
Brian Walsh37022642006-08-14 22:43:19 -07001661 /* notify platform of device entry */
1662 if (platform_notify)
1663 platform_notify(dev);
1664
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001665 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001666 if (error)
1667 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001668
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001669 error = device_add_class_symlinks(dev);
1670 if (error)
1671 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001672 error = device_add_attrs(dev);
1673 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001674 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001675 error = bus_add_device(dev);
1676 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001678 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001679 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001680 goto DPMError;
1681 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001682
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001683 if (MAJOR(dev->devt)) {
1684 error = device_create_file(dev, &dev_attr_dev);
1685 if (error)
1686 goto DevAttrError;
1687
1688 error = device_create_sys_dev_entry(dev);
1689 if (error)
1690 goto SysEntryError;
1691
1692 devtmpfs_create_node(dev);
1693 }
1694
Alan Sternec0676ee2008-12-05 14:10:31 -05001695 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001696 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001697 */
1698 if (dev->bus)
1699 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1700 BUS_NOTIFY_ADD_DEVICE, dev);
1701
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001702 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001703 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001705 klist_add_tail(&dev->p->knode_parent,
1706 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001708 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001709 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001710 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001711 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001712 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001713
1714 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001715 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001716 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001717 if (class_intf->add_dev)
1718 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001719 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001720 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001721done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 put_device(dev);
1723 return error;
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001724 SysEntryError:
1725 if (MAJOR(dev->devt))
1726 device_remove_file(dev, &dev_attr_dev);
1727 DevAttrError:
1728 device_pm_remove(dev);
1729 dpm_sysfs_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001730 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001731 bus_remove_device(dev);
1732 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001733 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001734 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001735 device_remove_class_symlinks(dev);
1736 SymlinkError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001737 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001738 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001739 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001740 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 kobject_del(&dev->kobj);
1742 Error:
Ming Leicebf8fd2016-07-10 19:27:36 +08001743 cleanup_glue_dir(dev, glue_dir);
Markus Elfring5f0163a2015-02-05 11:48:26 +01001744 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001745name_error:
1746 kfree(dev->p);
1747 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001748 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749}
David Graham White86df2682013-07-21 20:41:14 -04001750EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001753 * device_register - register a device with the system.
1754 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001756 * This happens in two clean steps - initialize the device
1757 * and add it to the system. The two steps can be called
1758 * separately, but this is the easiest and most common.
1759 * I.e. you should only call the two helpers separately if
1760 * have a clearly defined need to use and refcount the device
1761 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001762 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001763 * For more information, see the kerneldoc for device_initialize()
1764 * and device_add().
1765 *
Cornelia Huck57394112008-09-03 18:26:40 +02001766 * NOTE: _Never_ directly free @dev after calling this function, even
1767 * if it returned an error! Always use put_device() to give up the
1768 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770int device_register(struct device *dev)
1771{
1772 device_initialize(dev);
1773 return device_add(dev);
1774}
David Graham White86df2682013-07-21 20:41:14 -04001775EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001778 * get_device - increment reference count for device.
1779 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001781 * This simply forwards the call to kobject_get(), though
1782 * we do take care to provide for the case that we get a NULL
1783 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001785struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001787 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
David Graham White86df2682013-07-21 20:41:14 -04001789EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001792 * put_device - decrement reference count.
1793 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001795void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001797 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 if (dev)
1799 kobject_put(&dev->kobj);
1800}
David Graham White86df2682013-07-21 20:41:14 -04001801EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001804 * device_del - delete device from system.
1805 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001807 * This is the first part of the device unregistration
1808 * sequence. This removes the device from the lists we control
1809 * from here, has it removed from the other driver model
1810 * subsystems it was added to in device_add(), and removes it
1811 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001813 * NOTE: this should be called manually _iff_ device_add() was
1814 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001816void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001818 struct device *parent = dev->parent;
Ming Leicebf8fd2016-07-10 19:27:36 +08001819 struct kobject *glue_dir = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001820 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Alan Sternec0676ee2008-12-05 14:10:31 -05001822 /* Notify clients of device removal. This call must come
1823 * before dpm_sysfs_remove().
1824 */
1825 if (dev->bus)
1826 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1827 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +01001828
1829 device_links_purge(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001830 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001832 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001833 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001834 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001835 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001836 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001837 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001838 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001839 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001840
Kay Sieversca22e562011-12-14 14:29:38 -08001841 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001842 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001843 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001844 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001845 if (class_intf->remove_dev)
1846 class_intf->remove_dev(dev, class_intf);
1847 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001848 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001849 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001850 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001851 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001852 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001853 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001854 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001855 driver_deferred_probe_del(dev);
Lukas Wunner478573c2016-07-28 02:25:41 +02001856 device_remove_properties(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
1858 /* Notify the platform of the removal, in case they
1859 * need to do anything...
1860 */
1861 if (platform_notify_remove)
1862 platform_notify_remove(dev);
Joerg Roedel599bad32014-09-30 13:02:02 +02001863 if (dev->bus)
1864 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1865 BUS_NOTIFY_REMOVED_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001866 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001867 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 kobject_del(&dev->kobj);
Ming Leicebf8fd2016-07-10 19:27:36 +08001869 cleanup_glue_dir(dev, glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +01001870 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871}
David Graham White86df2682013-07-21 20:41:14 -04001872EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
1874/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001875 * device_unregister - unregister device from system.
1876 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001878 * We do this in two parts, like we do device_register(). First,
1879 * we remove it from all the subsystems with device_del(), then
1880 * we decrement the reference count via put_device(). If that
1881 * is the final reference count, the device will be cleaned up
1882 * via device_release() above. Otherwise, the structure will
1883 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001885void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001887 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 device_del(dev);
1889 put_device(dev);
1890}
David Graham White86df2682013-07-21 20:41:14 -04001891EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001893static struct device *prev_device(struct klist_iter *i)
1894{
1895 struct klist_node *n = klist_prev(i);
1896 struct device *dev = NULL;
1897 struct device_private *p;
1898
1899 if (n) {
1900 p = to_device_private_parent(n);
1901 dev = p->device;
1902 }
1903 return dev;
1904}
1905
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001906static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001907{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001908 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001909 struct device *dev = NULL;
1910 struct device_private *p;
1911
1912 if (n) {
1913 p = to_device_private_parent(n);
1914 dev = p->device;
1915 }
1916 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001917}
1918
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001920 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001921 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001922 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001923 * @uid: returned file owner
1924 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001925 * @tmp: possibly allocated string
1926 *
1927 * Return the relative path of a possible device node.
1928 * Non-default names may need to allocate a memory to compose
1929 * a name. This memory is returned in tmp and needs to be
1930 * freed by the caller.
1931 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001932const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001933 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001934 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001935{
1936 char *s;
1937
1938 *tmp = NULL;
1939
1940 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001941 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001942 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001943 if (*tmp)
1944 return *tmp;
1945
1946 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001947 if (dev->class && dev->class->devnode)
1948 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001949 if (*tmp)
1950 return *tmp;
1951
1952 /* return name without allocation, tmp == NULL */
1953 if (strchr(dev_name(dev), '!') == NULL)
1954 return dev_name(dev);
1955
1956 /* replace '!' in the name with '/' */
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001957 s = kstrdup(dev_name(dev), GFP_KERNEL);
1958 if (!s)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001959 return NULL;
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001960 strreplace(s, '!', '/');
1961 return *tmp = s;
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001962}
1963
1964/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001965 * device_for_each_child - device child iterator.
1966 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001967 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001968 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001970 * Iterate over @parent's child devices, and call @fn for each,
1971 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001973 * We check the return of @fn each time. If it returns anything
1974 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001976int device_for_each_child(struct device *parent, void *data,
1977 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001979 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001980 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 int error = 0;
1982
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001983 if (!parent->p)
1984 return 0;
1985
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001986 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001987 while ((child = next_device(&i)) && !error)
1988 error = fn(child, data);
1989 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 return error;
1991}
David Graham White86df2682013-07-21 20:41:14 -04001992EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Cornelia Huck5ab69982006-11-16 15:42:07 +01001994/**
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001995 * device_for_each_child_reverse - device child iterator in reversed order.
1996 * @parent: parent struct device.
1997 * @fn: function to be called for each device.
1998 * @data: data for the callback.
1999 *
2000 * Iterate over @parent's child devices, and call @fn for each,
2001 * passing it @data.
2002 *
2003 * We check the return of @fn each time. If it returns anything
2004 * other than 0, we break out and return that value.
2005 */
2006int device_for_each_child_reverse(struct device *parent, void *data,
2007 int (*fn)(struct device *dev, void *data))
2008{
2009 struct klist_iter i;
2010 struct device *child;
2011 int error = 0;
2012
2013 if (!parent->p)
2014 return 0;
2015
2016 klist_iter_init(&parent->p->klist_children, &i);
2017 while ((child = prev_device(&i)) && !error)
2018 error = fn(child, data);
2019 klist_iter_exit(&i);
2020 return error;
2021}
2022EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
2023
2024/**
Cornelia Huck5ab69982006-11-16 15:42:07 +01002025 * device_find_child - device iterator for locating a particular device.
2026 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01002027 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04002028 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01002029 *
2030 * This is similar to the device_for_each_child() function above, but it
2031 * returns a reference to a device that is 'found' for later use, as
2032 * determined by the @match callback.
2033 *
2034 * The callback should return 0 if the device doesn't match and non-zero
2035 * if it does. If the callback returns non-zero and a reference to the
2036 * current device can be obtained, this function will return to the caller
2037 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02002038 *
2039 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01002040 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08002041struct device *device_find_child(struct device *parent, void *data,
2042 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01002043{
2044 struct klist_iter i;
2045 struct device *child;
2046
2047 if (!parent)
2048 return NULL;
2049
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002050 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01002051 while ((child = next_device(&i)))
2052 if (match(child, data) && get_device(child))
2053 break;
2054 klist_iter_exit(&i);
2055 return child;
2056}
David Graham White86df2682013-07-21 20:41:14 -04002057EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01002058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059int __init devices_init(void)
2060{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06002061 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
2062 if (!devices_kset)
2063 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07002064 dev_kobj = kobject_create_and_add("dev", NULL);
2065 if (!dev_kobj)
2066 goto dev_kobj_err;
2067 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
2068 if (!sysfs_dev_block_kobj)
2069 goto block_kobj_err;
2070 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
2071 if (!sysfs_dev_char_kobj)
2072 goto char_kobj_err;
2073
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06002074 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07002075
2076 char_kobj_err:
2077 kobject_put(sysfs_dev_block_kobj);
2078 block_kobj_err:
2079 kobject_put(dev_kobj);
2080 dev_kobj_err:
2081 kset_unregister(devices_kset);
2082 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083}
2084
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02002085static int device_check_offline(struct device *dev, void *not_used)
2086{
2087 int ret;
2088
2089 ret = device_for_each_child(dev, NULL, device_check_offline);
2090 if (ret)
2091 return ret;
2092
2093 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
2094}
2095
2096/**
2097 * device_offline - Prepare the device for hot-removal.
2098 * @dev: Device to be put offline.
2099 *
2100 * Execute the device bus type's .offline() callback, if present, to prepare
2101 * the device for a subsequent hot-removal. If that succeeds, the device must
2102 * not be used until either it is removed or its bus type's .online() callback
2103 * is executed.
2104 *
2105 * Call under device_hotplug_lock.
2106 */
2107int device_offline(struct device *dev)
2108{
2109 int ret;
2110
2111 if (dev->offline_disabled)
2112 return -EPERM;
2113
2114 ret = device_for_each_child(dev, NULL, device_check_offline);
2115 if (ret)
2116 return ret;
2117
2118 device_lock(dev);
2119 if (device_supports_offline(dev)) {
2120 if (dev->offline) {
2121 ret = 1;
2122 } else {
2123 ret = dev->bus->offline(dev);
2124 if (!ret) {
2125 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
2126 dev->offline = true;
2127 }
2128 }
2129 }
2130 device_unlock(dev);
2131
2132 return ret;
2133}
2134
2135/**
2136 * device_online - Put the device back online after successful device_offline().
2137 * @dev: Device to be put back online.
2138 *
2139 * If device_offline() has been successfully executed for @dev, but the device
2140 * has not been removed subsequently, execute its bus type's .online() callback
2141 * to indicate that the device can be used again.
2142 *
2143 * Call under device_hotplug_lock.
2144 */
2145int device_online(struct device *dev)
2146{
2147 int ret = 0;
2148
2149 device_lock(dev);
2150 if (device_supports_offline(dev)) {
2151 if (dev->offline) {
2152 ret = dev->bus->online(dev);
2153 if (!ret) {
2154 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
2155 dev->offline = false;
2156 }
2157 } else {
2158 ret = 1;
2159 }
2160 }
2161 device_unlock(dev);
2162
2163 return ret;
2164}
2165
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05002166struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002167 struct device dev;
2168 struct module *owner;
2169};
2170
Josh Triplett93058422012-11-18 21:27:55 -08002171static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01002172{
2173 return container_of(d, struct root_device, dev);
2174}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002175
2176static void root_device_release(struct device *dev)
2177{
2178 kfree(to_root_device(dev));
2179}
2180
2181/**
2182 * __root_device_register - allocate and register a root device
2183 * @name: root device name
2184 * @owner: owner module of the root device, usually THIS_MODULE
2185 *
2186 * This function allocates a root device and registers it
2187 * using device_register(). In order to free the returned
2188 * device, use root_device_unregister().
2189 *
2190 * Root devices are dummy devices which allow other devices
2191 * to be grouped under /sys/devices. Use this function to
2192 * allocate a root device and then use it as the parent of
2193 * any device which should appear under /sys/devices/{name}
2194 *
2195 * The /sys/devices/{name} directory will also contain a
2196 * 'module' symlink which points to the @owner directory
2197 * in sysfs.
2198 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002199 * Returns &struct device pointer on success, or ERR_PTR() on error.
2200 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002201 * Note: You probably want to use root_device_register().
2202 */
2203struct device *__root_device_register(const char *name, struct module *owner)
2204{
2205 struct root_device *root;
2206 int err = -ENOMEM;
2207
2208 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
2209 if (!root)
2210 return ERR_PTR(err);
2211
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07002212 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002213 if (err) {
2214 kfree(root);
2215 return ERR_PTR(err);
2216 }
2217
2218 root->dev.release = root_device_release;
2219
2220 err = device_register(&root->dev);
2221 if (err) {
2222 put_device(&root->dev);
2223 return ERR_PTR(err);
2224 }
2225
Christoph Egger1d9e8822010-05-17 16:57:58 +02002226#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002227 if (owner) {
2228 struct module_kobject *mk = &owner->mkobj;
2229
2230 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
2231 if (err) {
2232 device_unregister(&root->dev);
2233 return ERR_PTR(err);
2234 }
2235 root->owner = owner;
2236 }
2237#endif
2238
2239 return &root->dev;
2240}
2241EXPORT_SYMBOL_GPL(__root_device_register);
2242
2243/**
2244 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08002245 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002246 *
2247 * This function unregisters and cleans up a device that was created by
2248 * root_device_register().
2249 */
2250void root_device_unregister(struct device *dev)
2251{
2252 struct root_device *root = to_root_device(dev);
2253
2254 if (root->owner)
2255 sysfs_remove_link(&root->dev.kobj, "module");
2256
2257 device_unregister(dev);
2258}
2259EXPORT_SYMBOL_GPL(root_device_unregister);
2260
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002261
2262static void device_create_release(struct device *dev)
2263{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01002264 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002265 kfree(dev);
2266}
2267
Guenter Roeck39ef3112013-07-14 16:05:57 -07002268static struct device *
2269device_create_groups_vargs(struct class *class, struct device *parent,
2270 dev_t devt, void *drvdata,
2271 const struct attribute_group **groups,
2272 const char *fmt, va_list args)
2273{
2274 struct device *dev = NULL;
2275 int retval = -ENODEV;
2276
2277 if (class == NULL || IS_ERR(class))
2278 goto error;
2279
2280 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2281 if (!dev) {
2282 retval = -ENOMEM;
2283 goto error;
2284 }
2285
David Herrmannbbc780f2013-11-21 20:15:48 +01002286 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07002287 dev->devt = devt;
2288 dev->class = class;
2289 dev->parent = parent;
2290 dev->groups = groups;
2291 dev->release = device_create_release;
2292 dev_set_drvdata(dev, drvdata);
2293
2294 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
2295 if (retval)
2296 goto error;
2297
David Herrmannbbc780f2013-11-21 20:15:48 +01002298 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07002299 if (retval)
2300 goto error;
2301
2302 return dev;
2303
2304error:
2305 put_device(dev);
2306 return ERR_PTR(retval);
2307}
2308
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002309/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002310 * device_create_vargs - creates a device and registers it with sysfs
2311 * @class: pointer to the struct class that this device should be registered to
2312 * @parent: pointer to the parent struct device of this new device, if any
2313 * @devt: the dev_t for the char device to be added
2314 * @drvdata: the data to be added to the device for callbacks
2315 * @fmt: string for the device's name
2316 * @args: va_list for the device's name
2317 *
2318 * This function can be used by char device classes. A struct device
2319 * will be created in sysfs, registered to the specified class.
2320 *
2321 * A "dev" file will be created, showing the dev_t for the device, if
2322 * the dev_t is not 0,0.
2323 * If a pointer to a parent struct device is passed in, the newly created
2324 * struct device will be a child of that device in sysfs.
2325 * The pointer to the struct device will be returned from the call.
2326 * Any further sysfs files that might be required can be created using this
2327 * pointer.
2328 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002329 * Returns &struct device pointer on success, or ERR_PTR() on error.
2330 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002331 * Note: the struct class passed to this function must have previously
2332 * been created with a call to class_create().
2333 */
2334struct device *device_create_vargs(struct class *class, struct device *parent,
2335 dev_t devt, void *drvdata, const char *fmt,
2336 va_list args)
2337{
Guenter Roeck39ef3112013-07-14 16:05:57 -07002338 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
2339 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002340}
2341EXPORT_SYMBOL_GPL(device_create_vargs);
2342
2343/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002344 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002345 * @class: pointer to the struct class that this device should be registered to
2346 * @parent: pointer to the parent struct device of this new device, if any
2347 * @devt: the dev_t for the char device to be added
2348 * @drvdata: the data to be added to the device for callbacks
2349 * @fmt: string for the device's name
2350 *
2351 * This function can be used by char device classes. A struct device
2352 * will be created in sysfs, registered to the specified class.
2353 *
2354 * A "dev" file will be created, showing the dev_t for the device, if
2355 * the dev_t is not 0,0.
2356 * If a pointer to a parent struct device is passed in, the newly created
2357 * struct device will be a child of that device in sysfs.
2358 * The pointer to the struct device will be returned from the call.
2359 * Any further sysfs files that might be required can be created using this
2360 * pointer.
2361 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002362 * Returns &struct device pointer on success, or ERR_PTR() on error.
2363 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002364 * Note: the struct class passed to this function must have previously
2365 * been created with a call to class_create().
2366 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002367struct device *device_create(struct class *class, struct device *parent,
2368 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002369{
2370 va_list vargs;
2371 struct device *dev;
2372
2373 va_start(vargs, fmt);
2374 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
2375 va_end(vargs);
2376 return dev;
2377}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002378EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002379
Guenter Roeck39ef3112013-07-14 16:05:57 -07002380/**
2381 * device_create_with_groups - creates a device and registers it with sysfs
2382 * @class: pointer to the struct class that this device should be registered to
2383 * @parent: pointer to the parent struct device of this new device, if any
2384 * @devt: the dev_t for the char device to be added
2385 * @drvdata: the data to be added to the device for callbacks
2386 * @groups: NULL-terminated list of attribute groups to be created
2387 * @fmt: string for the device's name
2388 *
2389 * This function can be used by char device classes. A struct device
2390 * will be created in sysfs, registered to the specified class.
2391 * Additional attributes specified in the groups parameter will also
2392 * be created automatically.
2393 *
2394 * A "dev" file will be created, showing the dev_t for the device, if
2395 * the dev_t is not 0,0.
2396 * If a pointer to a parent struct device is passed in, the newly created
2397 * struct device will be a child of that device in sysfs.
2398 * The pointer to the struct device will be returned from the call.
2399 * Any further sysfs files that might be required can be created using this
2400 * pointer.
2401 *
2402 * Returns &struct device pointer on success, or ERR_PTR() on error.
2403 *
2404 * Note: the struct class passed to this function must have previously
2405 * been created with a call to class_create().
2406 */
2407struct device *device_create_with_groups(struct class *class,
2408 struct device *parent, dev_t devt,
2409 void *drvdata,
2410 const struct attribute_group **groups,
2411 const char *fmt, ...)
2412{
2413 va_list vargs;
2414 struct device *dev;
2415
2416 va_start(vargs, fmt);
2417 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
2418 fmt, vargs);
2419 va_end(vargs);
2420 return dev;
2421}
2422EXPORT_SYMBOL_GPL(device_create_with_groups);
2423
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002424static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002425{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002426 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002427
Dave Youngcd354492008-01-28 16:56:11 +08002428 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01002429}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002430
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01002431/**
2432 * device_destroy - removes a device that was created with device_create()
2433 * @class: pointer to the struct class that this device was registered with
2434 * @devt: the dev_t of the device that was previously registered
2435 *
2436 * This call unregisters and cleans up a device that was created with a
2437 * call to device_create().
2438 */
2439void device_destroy(struct class *class, dev_t devt)
2440{
2441 struct device *dev;
2442
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04002443 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08002444 if (dev) {
2445 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002446 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08002447 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002448}
2449EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002450
2451/**
2452 * device_rename - renames a device
2453 * @dev: the pointer to the struct device to be renamed
2454 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07002455 *
2456 * It is the responsibility of the caller to provide mutual
2457 * exclusion between two different calls of device_rename
2458 * on the same device to ensure that new_name is valid and
2459 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11002460 *
Timur Tabia5462512010-12-13 14:08:52 -06002461 * Note: Don't call this function. Currently, the networking layer calls this
2462 * function, but that will change. The following text from Kay Sievers offers
2463 * some insight:
2464 *
2465 * Renaming devices is racy at many levels, symlinks and other stuff are not
2466 * replaced atomically, and you get a "move" uevent, but it's not easy to
2467 * connect the event to the old and new device. Device nodes are not renamed at
2468 * all, there isn't even support for that in the kernel now.
2469 *
2470 * In the meantime, during renaming, your target name might be taken by another
2471 * driver, creating conflicts. Or the old name is taken directly after you
2472 * renamed it -- then you get events for the same DEVPATH, before you even see
2473 * the "move" event. It's just a mess, and nothing new should ever rely on
2474 * kernel device renaming. Besides that, it's not even implemented now for
2475 * other things than (driver-core wise very simple) network devices.
2476 *
2477 * We are currently about to change network renaming in udev to completely
2478 * disallow renaming of devices in the same namespace as the kernel uses,
2479 * because we can't solve the problems properly, that arise with swapping names
2480 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
2481 * be allowed to some other name than eth[0-9]*, for the aforementioned
2482 * reasons.
2483 *
2484 * Make up a "real" name in the driver before you register anything, or add
2485 * some other attributes for userspace to find the device, or use udev to add
2486 * symlinks -- but never rename kernel devices later, it's a complete mess. We
2487 * don't even want to get into that and try to implement the missing pieces in
2488 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002489 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02002490int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002491{
Tejun Heo4b30ee52013-09-11 22:29:06 -04002492 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002493 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002494 int error;
2495
2496 dev = get_device(dev);
2497 if (!dev)
2498 return -EINVAL;
2499
ethan.zhao69df7532013-10-13 22:12:35 +08002500 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002501
Kay Sievers1fa5ae82009-01-25 15:17:37 +01002502 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002503 if (!old_device_name) {
2504 error = -ENOMEM;
2505 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002506 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002507
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07002508 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04002509 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
2510 kobj, old_device_name,
2511 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07002512 if (error)
2513 goto out;
2514 }
Kay Sievers39aba962010-09-04 22:33:14 -07002515
Tejun Heo4b30ee52013-09-11 22:29:06 -04002516 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01002517 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002518 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002519
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002520out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002521 put_device(dev);
2522
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002523 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002524
2525 return error;
2526}
Johannes Berga2807db2007-02-28 12:38:31 +01002527EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01002528
2529static int device_move_class_links(struct device *dev,
2530 struct device *old_parent,
2531 struct device *new_parent)
2532{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08002533 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01002534
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08002535 if (old_parent)
2536 sysfs_remove_link(&dev->kobj, "device");
2537 if (new_parent)
2538 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
2539 "device");
2540 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01002541}
2542
2543/**
2544 * device_move - moves a device to a new parent
2545 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002546 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01002547 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01002548 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01002549int device_move(struct device *dev, struct device *new_parent,
2550 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01002551{
2552 int error;
2553 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002554 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01002555
2556 dev = get_device(dev);
2557 if (!dev)
2558 return -EINVAL;
2559
Cornelia Huckffa6a702009-03-04 12:44:00 +01002560 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002561 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08002562 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01002563
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01002564 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
2565 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002566 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01002567 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01002568 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01002569 put_device(new_parent);
2570 goto out;
2571 }
2572 old_parent = dev->parent;
2573 dev->parent = new_parent;
2574 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002575 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002576 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002577 klist_add_tail(&dev->p->knode_parent,
2578 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002579 set_dev_node(dev, dev_to_node(new_parent));
2580 }
2581
Rabin Vincentbdd40342012-04-23 09:16:36 +02002582 if (dev->class) {
2583 error = device_move_class_links(dev, old_parent, new_parent);
2584 if (error) {
2585 /* We ignore errors on cleanup since we're hosed anyway... */
2586 device_move_class_links(dev, new_parent, old_parent);
2587 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
2588 if (new_parent)
2589 klist_remove(&dev->p->knode_parent);
2590 dev->parent = old_parent;
2591 if (old_parent) {
2592 klist_add_tail(&dev->p->knode_parent,
2593 &old_parent->p->klist_children);
2594 set_dev_node(dev, dev_to_node(old_parent));
2595 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08002596 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002597 cleanup_glue_dir(dev, new_parent_kobj);
2598 put_device(new_parent);
2599 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01002600 }
Cornelia Huck8a824722006-11-20 17:07:51 +01002601 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01002602 switch (dpm_order) {
2603 case DPM_ORDER_NONE:
2604 break;
2605 case DPM_ORDER_DEV_AFTER_PARENT:
2606 device_pm_move_after(dev, new_parent);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002607 devices_kset_move_after(dev, new_parent);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002608 break;
2609 case DPM_ORDER_PARENT_BEFORE_DEV:
2610 device_pm_move_before(new_parent, dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002611 devices_kset_move_before(new_parent, dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002612 break;
2613 case DPM_ORDER_DEV_LAST:
2614 device_pm_move_last(dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002615 devices_kset_move_last(dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002616 break;
2617 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002618
Cornelia Huck8a824722006-11-20 17:07:51 +01002619 put_device(old_parent);
2620out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01002621 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002622 put_device(dev);
2623 return error;
2624}
Cornelia Huck8a824722006-11-20 17:07:51 +01002625EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002626
2627/**
2628 * device_shutdown - call ->shutdown() on each device to shutdown.
2629 */
2630void device_shutdown(void)
2631{
Benson Leungf123db82013-09-24 20:05:11 -07002632 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002633
Hugh Daschbach62458382010-03-22 10:36:37 -07002634 spin_lock(&devices_kset->list_lock);
2635 /*
2636 * Walk the devices list backward, shutting down each in turn.
2637 * Beware that device unplug events may also start pulling
2638 * devices offline, even as the system is shutting down.
2639 */
2640 while (!list_empty(&devices_kset->list)) {
2641 dev = list_entry(devices_kset->list.prev, struct device,
2642 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08002643
2644 /*
2645 * hold reference count of device's parent to
2646 * prevent it from being freed because parent's
2647 * lock is to be held
2648 */
Benson Leungf123db82013-09-24 20:05:11 -07002649 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002650 get_device(dev);
2651 /*
2652 * Make sure the device is off the kset list, in the
2653 * event that dev->*->shutdown() doesn't remove it.
2654 */
2655 list_del_init(&dev->kobj.entry);
2656 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01002657
Ming Leid1c6c032012-06-22 18:01:40 +08002658 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07002659 if (parent)
2660 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002661 device_lock(dev);
2662
Alan Sternfe6b91f2011-12-06 23:24:52 +01002663 /* Don't allow any more runtime suspends */
2664 pm_runtime_get_noresume(dev);
2665 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07002666
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002667 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002668 if (initcall_debug)
2669 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002670 dev->bus->shutdown(dev);
2671 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002672 if (initcall_debug)
2673 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002674 dev->driver->shutdown(dev);
2675 }
Ming Leid1c6c032012-06-22 18:01:40 +08002676
2677 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002678 if (parent)
2679 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002680
Hugh Daschbach62458382010-03-22 10:36:37 -07002681 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002682 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002683
2684 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002685 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002686 spin_unlock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002687}
Joe Perches99bcf212010-06-27 01:02:34 +00002688
2689/*
2690 * Device logging functions
2691 */
2692
2693#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002694static int
2695create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002696{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002697 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002698 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002699
Kay Sieversc4e00da2012-05-03 02:29:59 +02002700 if (dev->class)
2701 subsys = dev->class->name;
2702 else if (dev->bus)
2703 subsys = dev->bus->name;
2704 else
Joe Perches798efc62012-09-12 20:11:29 -07002705 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002706
Joe Perches798efc62012-09-12 20:11:29 -07002707 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Ben Hutchings655e5b72014-08-26 00:34:44 -07002708 if (pos >= hdrlen)
2709 goto overflow;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002710
2711 /*
2712 * Add device identifier DEVICE=:
2713 * b12:8 block dev_t
2714 * c127:3 char dev_t
2715 * n8 netdev ifindex
2716 * +sound:card0 subsystem:devname
2717 */
2718 if (MAJOR(dev->devt)) {
2719 char c;
2720
2721 if (strcmp(subsys, "block") == 0)
2722 c = 'b';
2723 else
2724 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002725 pos++;
2726 pos += snprintf(hdr + pos, hdrlen - pos,
2727 "DEVICE=%c%u:%u",
2728 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002729 } else if (strcmp(subsys, "net") == 0) {
2730 struct net_device *net = to_net_dev(dev);
2731
Joe Perches798efc62012-09-12 20:11:29 -07002732 pos++;
2733 pos += snprintf(hdr + pos, hdrlen - pos,
2734 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002735 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002736 pos++;
2737 pos += snprintf(hdr + pos, hdrlen - pos,
2738 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002739 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002740
Ben Hutchings655e5b72014-08-26 00:34:44 -07002741 if (pos >= hdrlen)
2742 goto overflow;
2743
Joe Perches798efc62012-09-12 20:11:29 -07002744 return pos;
Ben Hutchings655e5b72014-08-26 00:34:44 -07002745
2746overflow:
2747 dev_WARN(dev, "device/subsystem name too long");
2748 return 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002749}
Joe Perches798efc62012-09-12 20:11:29 -07002750
Joe Perches05e4e5b2012-09-12 20:13:37 -07002751int dev_vprintk_emit(int level, const struct device *dev,
2752 const char *fmt, va_list args)
2753{
2754 char hdr[128];
2755 size_t hdrlen;
2756
2757 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2758
2759 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2760}
2761EXPORT_SYMBOL(dev_vprintk_emit);
2762
2763int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2764{
2765 va_list args;
2766 int r;
2767
2768 va_start(args, fmt);
2769
2770 r = dev_vprintk_emit(level, dev, fmt, args);
2771
2772 va_end(args);
2773
2774 return r;
2775}
2776EXPORT_SYMBOL(dev_printk_emit);
2777
Joe Perchesd1f10522014-12-25 15:07:04 -08002778static void __dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -07002779 struct va_format *vaf)
2780{
Joe Perchesd1f10522014-12-25 15:07:04 -08002781 if (dev)
2782 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2783 dev_driver_string(dev), dev_name(dev), vaf);
2784 else
2785 printk("%s(NULL device *): %pV", level, vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002786}
Joe Perches99bcf212010-06-27 01:02:34 +00002787
Joe Perchesd1f10522014-12-25 15:07:04 -08002788void dev_printk(const char *level, const struct device *dev,
2789 const char *fmt, ...)
Joe Perches99bcf212010-06-27 01:02:34 +00002790{
2791 struct va_format vaf;
2792 va_list args;
Joe Perches99bcf212010-06-27 01:02:34 +00002793
2794 va_start(args, fmt);
2795
2796 vaf.fmt = fmt;
2797 vaf.va = &args;
2798
Joe Perchesd1f10522014-12-25 15:07:04 -08002799 __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002800
Joe Perches99bcf212010-06-27 01:02:34 +00002801 va_end(args);
Joe Perches99bcf212010-06-27 01:02:34 +00002802}
2803EXPORT_SYMBOL(dev_printk);
2804
2805#define define_dev_printk_level(func, kern_level) \
Joe Perchesd1f10522014-12-25 15:07:04 -08002806void func(const struct device *dev, const char *fmt, ...) \
Joe Perches99bcf212010-06-27 01:02:34 +00002807{ \
2808 struct va_format vaf; \
2809 va_list args; \
Joe Perches99bcf212010-06-27 01:02:34 +00002810 \
2811 va_start(args, fmt); \
2812 \
2813 vaf.fmt = fmt; \
2814 vaf.va = &args; \
2815 \
Joe Perchesd1f10522014-12-25 15:07:04 -08002816 __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002817 \
Joe Perches99bcf212010-06-27 01:02:34 +00002818 va_end(args); \
Joe Perches99bcf212010-06-27 01:02:34 +00002819} \
2820EXPORT_SYMBOL(func);
2821
2822define_dev_printk_level(dev_emerg, KERN_EMERG);
2823define_dev_printk_level(dev_alert, KERN_ALERT);
2824define_dev_printk_level(dev_crit, KERN_CRIT);
2825define_dev_printk_level(dev_err, KERN_ERR);
2826define_dev_printk_level(dev_warn, KERN_WARNING);
2827define_dev_printk_level(dev_notice, KERN_NOTICE);
2828define_dev_printk_level(_dev_info, KERN_INFO);
2829
2830#endif
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002831
2832static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2833{
2834 return fwnode && !IS_ERR(fwnode->secondary);
2835}
2836
2837/**
2838 * set_primary_fwnode - Change the primary firmware node of a given device.
2839 * @dev: Device to handle.
2840 * @fwnode: New primary firmware node of the device.
2841 *
2842 * Set the device's firmware node pointer to @fwnode, but if a secondary
2843 * firmware node of the device is present, preserve it.
2844 */
2845void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2846{
2847 if (fwnode) {
2848 struct fwnode_handle *fn = dev->fwnode;
2849
2850 if (fwnode_is_primary(fn))
2851 fn = fn->secondary;
2852
Mika Westerberg55f89a82015-11-30 17:11:39 +02002853 if (fn) {
2854 WARN_ON(fwnode->secondary);
2855 fwnode->secondary = fn;
2856 }
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002857 dev->fwnode = fwnode;
2858 } else {
2859 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2860 dev->fwnode->secondary : NULL;
2861 }
2862}
2863EXPORT_SYMBOL_GPL(set_primary_fwnode);
2864
2865/**
2866 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2867 * @dev: Device to handle.
2868 * @fwnode: New secondary firmware node of the device.
2869 *
2870 * If a primary firmware node of the device is present, set its secondary
2871 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2872 * @fwnode.
2873 */
2874void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2875{
2876 if (fwnode)
2877 fwnode->secondary = ERR_PTR(-ENODEV);
2878
2879 if (fwnode_is_primary(dev->fwnode))
2880 dev->fwnode->secondary = fwnode;
2881 else
2882 dev->fwnode = fwnode;
2883}
Johan Hovold4e75e1d2017-06-06 17:59:00 +02002884
2885/**
2886 * device_set_of_node_from_dev - reuse device-tree node of another device
2887 * @dev: device whose device-tree node is being set
2888 * @dev2: device whose device-tree node is being reused
2889 *
2890 * Takes another reference to the new device-tree node after first dropping
2891 * any reference held to the old node.
2892 */
2893void device_set_of_node_from_dev(struct device *dev, const struct device *dev2)
2894{
2895 of_node_put(dev->of_node);
2896 dev->of_node = of_node_get(dev2->of_node);
2897 dev->of_node_reused = true;
2898}
2899EXPORT_SYMBOL_GPL(device_set_of_node_from_dev);