blob: d0c9df5cdd9ed5f2098500dabb8a6b7b16cfb244 [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>
Greg Kroah-Hartman63967682013-08-27 10:24:15 -070029#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#include "base.h"
32#include "power/power.h"
33
Andi Kleene52eec12010-09-08 16:54:17 +020034#ifdef CONFIG_SYSFS_DEPRECATED
35#ifdef CONFIG_SYSFS_DEPRECATED_V2
36long sysfs_deprecated = 1;
37#else
38long sysfs_deprecated = 0;
39#endif
Hanjun Guo3454bf92013-08-17 20:42:24 +080040static int __init sysfs_deprecated_setup(char *arg)
Andi Kleene52eec12010-09-08 16:54:17 +020041{
Jingoo Han34da5e62013-07-26 13:10:22 +090042 return kstrtol(arg, 10, &sysfs_deprecated);
Andi Kleene52eec12010-09-08 16:54:17 +020043}
44early_param("sysfs.deprecated", sysfs_deprecated_setup);
45#endif
46
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +010047/* Device links support. */
48
49#ifdef CONFIG_SRCU
50static DEFINE_MUTEX(device_links_lock);
51DEFINE_STATIC_SRCU(device_links_srcu);
52
53static inline void device_links_write_lock(void)
54{
55 mutex_lock(&device_links_lock);
56}
57
58static inline void device_links_write_unlock(void)
59{
60 mutex_unlock(&device_links_lock);
61}
62
63int device_links_read_lock(void)
64{
65 return srcu_read_lock(&device_links_srcu);
66}
67
68void device_links_read_unlock(int idx)
69{
70 srcu_read_unlock(&device_links_srcu, idx);
71}
72#else /* !CONFIG_SRCU */
73static DECLARE_RWSEM(device_links_lock);
74
75static inline void device_links_write_lock(void)
76{
77 down_write(&device_links_lock);
78}
79
80static inline void device_links_write_unlock(void)
81{
82 up_write(&device_links_lock);
83}
84
85int device_links_read_lock(void)
86{
87 down_read(&device_links_lock);
88 return 0;
89}
90
91void device_links_read_unlock(int not_used)
92{
93 up_read(&device_links_lock);
94}
95#endif /* !CONFIG_SRCU */
96
97/**
98 * device_is_dependent - Check if one device depends on another one
99 * @dev: Device to check dependencies for.
100 * @target: Device to check against.
101 *
102 * Check if @target depends on @dev or any device dependent on it (its child or
103 * its consumer etc). Return 1 if that is the case or 0 otherwise.
104 */
105static int device_is_dependent(struct device *dev, void *target)
106{
107 struct device_link *link;
108 int ret;
109
110 if (WARN_ON(dev == target))
111 return 1;
112
113 ret = device_for_each_child(dev, target, device_is_dependent);
114 if (ret)
115 return ret;
116
117 list_for_each_entry(link, &dev->links.consumers, s_node) {
118 if (WARN_ON(link->consumer == target))
119 return 1;
120
121 ret = device_is_dependent(link->consumer, target);
122 if (ret)
123 break;
124 }
125 return ret;
126}
127
128static int device_reorder_to_tail(struct device *dev, void *not_used)
129{
130 struct device_link *link;
131
132 /*
133 * Devices that have not been registered yet will be put to the ends
134 * of the lists during the registration, so skip them here.
135 */
136 if (device_is_registered(dev))
137 devices_kset_move_last(dev);
138
139 if (device_pm_initialized(dev))
140 device_pm_move_last(dev);
141
142 device_for_each_child(dev, NULL, device_reorder_to_tail);
143 list_for_each_entry(link, &dev->links.consumers, s_node)
144 device_reorder_to_tail(link->consumer, NULL);
145
146 return 0;
147}
148
149/**
150 * device_link_add - Create a link between two devices.
151 * @consumer: Consumer end of the link.
152 * @supplier: Supplier end of the link.
153 * @flags: Link flags.
154 *
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100155 * The caller is responsible for the proper synchronization of the link creation
156 * with runtime PM. First, setting the DL_FLAG_PM_RUNTIME flag will cause the
157 * runtime PM framework to take the link into account. Second, if the
158 * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will
159 * be forced into the active metastate and reference-counted upon the creation
160 * of the link. If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be
161 * ignored.
162 *
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100163 * If the DL_FLAG_AUTOREMOVE is set, the link will be removed automatically
164 * when the consumer device driver unbinds from it. The combination of both
165 * DL_FLAG_AUTOREMOVE and DL_FLAG_STATELESS set is invalid and will cause NULL
166 * to be returned.
167 *
168 * A side effect of the link creation is re-ordering of dpm_list and the
169 * devices_kset list by moving the consumer device and all devices depending
170 * on it to the ends of these lists (that does not happen to devices that have
171 * not been registered when this function is called).
172 *
173 * The supplier device is required to be registered when this function is called
174 * and NULL will be returned if that is not the case. The consumer device need
175 * not be registerd, however.
176 */
177struct device_link *device_link_add(struct device *consumer,
178 struct device *supplier, u32 flags)
179{
180 struct device_link *link;
181
182 if (!consumer || !supplier ||
183 ((flags & DL_FLAG_STATELESS) && (flags & DL_FLAG_AUTOREMOVE)))
184 return NULL;
185
186 device_links_write_lock();
187 device_pm_lock();
188
189 /*
190 * If the supplier has not been fully registered yet or there is a
191 * reverse dependency between the consumer and the supplier already in
192 * the graph, return NULL.
193 */
194 if (!device_pm_initialized(supplier)
195 || device_is_dependent(consumer, supplier)) {
196 link = NULL;
197 goto out;
198 }
199
200 list_for_each_entry(link, &supplier->links.consumers, s_node)
201 if (link->consumer == consumer)
202 goto out;
203
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100204 link = kzalloc(sizeof(*link), GFP_KERNEL);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100205 if (!link)
206 goto out;
207
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100208 if (flags & DL_FLAG_PM_RUNTIME) {
209 if (flags & DL_FLAG_RPM_ACTIVE) {
210 if (pm_runtime_get_sync(supplier) < 0) {
211 pm_runtime_put_noidle(supplier);
212 kfree(link);
213 link = NULL;
214 goto out;
215 }
216 link->rpm_active = true;
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100217 }
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100218 pm_runtime_new_link(consumer);
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100219 }
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100220 get_device(supplier);
221 link->supplier = supplier;
222 INIT_LIST_HEAD(&link->s_node);
223 get_device(consumer);
224 link->consumer = consumer;
225 INIT_LIST_HEAD(&link->c_node);
226 link->flags = flags;
227
228 /* Deterine the initial link state. */
229 if (flags & DL_FLAG_STATELESS) {
230 link->status = DL_STATE_NONE;
231 } else {
232 switch (supplier->links.status) {
233 case DL_DEV_DRIVER_BOUND:
234 switch (consumer->links.status) {
235 case DL_DEV_PROBING:
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100236 /*
237 * Balance the decrementation of the supplier's
238 * runtime PM usage counter after consumer probe
239 * in driver_probe_device().
240 */
241 if (flags & DL_FLAG_PM_RUNTIME)
242 pm_runtime_get_sync(supplier);
243
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100244 link->status = DL_STATE_CONSUMER_PROBE;
245 break;
246 case DL_DEV_DRIVER_BOUND:
247 link->status = DL_STATE_ACTIVE;
248 break;
249 default:
250 link->status = DL_STATE_AVAILABLE;
251 break;
252 }
253 break;
254 case DL_DEV_UNBINDING:
255 link->status = DL_STATE_SUPPLIER_UNBIND;
256 break;
257 default:
258 link->status = DL_STATE_DORMANT;
259 break;
260 }
261 }
262
263 /*
264 * Move the consumer and all of the devices depending on it to the end
265 * of dpm_list and the devices_kset list.
266 *
267 * It is necessary to hold dpm_list locked throughout all that or else
268 * we may end up suspending with a wrong ordering of it.
269 */
270 device_reorder_to_tail(consumer, NULL);
271
272 list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
273 list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);
274
275 dev_info(consumer, "Linked as a consumer to %s\n", dev_name(supplier));
276
277 out:
278 device_pm_unlock();
279 device_links_write_unlock();
280 return link;
281}
282EXPORT_SYMBOL_GPL(device_link_add);
283
284static void device_link_free(struct device_link *link)
285{
286 put_device(link->consumer);
287 put_device(link->supplier);
288 kfree(link);
289}
290
291#ifdef CONFIG_SRCU
292static void __device_link_free_srcu(struct rcu_head *rhead)
293{
294 device_link_free(container_of(rhead, struct device_link, rcu_head));
295}
296
297static void __device_link_del(struct device_link *link)
298{
299 dev_info(link->consumer, "Dropping the link to %s\n",
300 dev_name(link->supplier));
301
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100302 if (link->flags & DL_FLAG_PM_RUNTIME)
303 pm_runtime_drop_link(link->consumer);
304
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100305 list_del_rcu(&link->s_node);
306 list_del_rcu(&link->c_node);
307 call_srcu(&device_links_srcu, &link->rcu_head, __device_link_free_srcu);
308}
309#else /* !CONFIG_SRCU */
310static void __device_link_del(struct device_link *link)
311{
312 dev_info(link->consumer, "Dropping the link to %s\n",
313 dev_name(link->supplier));
314
315 list_del(&link->s_node);
316 list_del(&link->c_node);
317 device_link_free(link);
318}
319#endif /* !CONFIG_SRCU */
320
321/**
322 * device_link_del - Delete a link between two devices.
323 * @link: Device link to delete.
324 *
325 * The caller must ensure proper synchronization of this function with runtime
326 * PM.
327 */
328void device_link_del(struct device_link *link)
329{
330 device_links_write_lock();
331 device_pm_lock();
332 __device_link_del(link);
333 device_pm_unlock();
334 device_links_write_unlock();
335}
336EXPORT_SYMBOL_GPL(device_link_del);
337
338static void device_links_missing_supplier(struct device *dev)
339{
340 struct device_link *link;
341
342 list_for_each_entry(link, &dev->links.suppliers, c_node)
343 if (link->status == DL_STATE_CONSUMER_PROBE)
344 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
345}
346
347/**
348 * device_links_check_suppliers - Check presence of supplier drivers.
349 * @dev: Consumer device.
350 *
351 * Check links from this device to any suppliers. Walk the list of the device's
352 * links to suppliers and see if all of them are available. If not, simply
353 * return -EPROBE_DEFER.
354 *
355 * We need to guarantee that the supplier will not go away after the check has
356 * been positive here. It only can go away in __device_release_driver() and
357 * that function checks the device's links to consumers. This means we need to
358 * mark the link as "consumer probe in progress" to make the supplier removal
359 * wait for us to complete (or bad things may happen).
360 *
361 * Links with the DL_FLAG_STATELESS flag set are ignored.
362 */
363int device_links_check_suppliers(struct device *dev)
364{
365 struct device_link *link;
366 int ret = 0;
367
368 device_links_write_lock();
369
370 list_for_each_entry(link, &dev->links.suppliers, c_node) {
371 if (link->flags & DL_FLAG_STATELESS)
372 continue;
373
374 if (link->status != DL_STATE_AVAILABLE) {
375 device_links_missing_supplier(dev);
376 ret = -EPROBE_DEFER;
377 break;
378 }
379 WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
380 }
381 dev->links.status = DL_DEV_PROBING;
382
383 device_links_write_unlock();
384 return ret;
385}
386
387/**
388 * device_links_driver_bound - Update device links after probing its driver.
389 * @dev: Device to update the links for.
390 *
391 * The probe has been successful, so update links from this device to any
392 * consumers by changing their status to "available".
393 *
394 * Also change the status of @dev's links to suppliers to "active".
395 *
396 * Links with the DL_FLAG_STATELESS flag set are ignored.
397 */
398void device_links_driver_bound(struct device *dev)
399{
400 struct device_link *link;
401
402 device_links_write_lock();
403
404 list_for_each_entry(link, &dev->links.consumers, s_node) {
405 if (link->flags & DL_FLAG_STATELESS)
406 continue;
407
408 WARN_ON(link->status != DL_STATE_DORMANT);
409 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
410 }
411
412 list_for_each_entry(link, &dev->links.suppliers, c_node) {
413 if (link->flags & DL_FLAG_STATELESS)
414 continue;
415
416 WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
417 WRITE_ONCE(link->status, DL_STATE_ACTIVE);
418 }
419
420 dev->links.status = DL_DEV_DRIVER_BOUND;
421
422 device_links_write_unlock();
423}
424
425/**
426 * __device_links_no_driver - Update links of a device without a driver.
427 * @dev: Device without a drvier.
428 *
429 * Delete all non-persistent links from this device to any suppliers.
430 *
431 * Persistent links stay around, but their status is changed to "available",
432 * unless they already are in the "supplier unbind in progress" state in which
433 * case they need not be updated.
434 *
435 * Links with the DL_FLAG_STATELESS flag set are ignored.
436 */
437static void __device_links_no_driver(struct device *dev)
438{
439 struct device_link *link, *ln;
440
441 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
442 if (link->flags & DL_FLAG_STATELESS)
443 continue;
444
445 if (link->flags & DL_FLAG_AUTOREMOVE)
446 __device_link_del(link);
447 else if (link->status != DL_STATE_SUPPLIER_UNBIND)
448 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
449 }
450
451 dev->links.status = DL_DEV_NO_DRIVER;
452}
453
454void device_links_no_driver(struct device *dev)
455{
456 device_links_write_lock();
457 __device_links_no_driver(dev);
458 device_links_write_unlock();
459}
460
461/**
462 * device_links_driver_cleanup - Update links after driver removal.
463 * @dev: Device whose driver has just gone away.
464 *
465 * Update links to consumers for @dev by changing their status to "dormant" and
466 * invoke %__device_links_no_driver() to update links to suppliers for it as
467 * appropriate.
468 *
469 * Links with the DL_FLAG_STATELESS flag set are ignored.
470 */
471void device_links_driver_cleanup(struct device *dev)
472{
473 struct device_link *link;
474
475 device_links_write_lock();
476
477 list_for_each_entry(link, &dev->links.consumers, s_node) {
478 if (link->flags & DL_FLAG_STATELESS)
479 continue;
480
481 WARN_ON(link->flags & DL_FLAG_AUTOREMOVE);
482 WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
483 WRITE_ONCE(link->status, DL_STATE_DORMANT);
484 }
485
486 __device_links_no_driver(dev);
487
488 device_links_write_unlock();
489}
490
491/**
492 * device_links_busy - Check if there are any busy links to consumers.
493 * @dev: Device to check.
494 *
495 * Check each consumer of the device and return 'true' if its link's status
496 * is one of "consumer probe" or "active" (meaning that the given consumer is
497 * probing right now or its driver is present). Otherwise, change the link
498 * state to "supplier unbind" to prevent the consumer from being probed
499 * successfully going forward.
500 *
501 * Return 'false' if there are no probing or active consumers.
502 *
503 * Links with the DL_FLAG_STATELESS flag set are ignored.
504 */
505bool device_links_busy(struct device *dev)
506{
507 struct device_link *link;
508 bool ret = false;
509
510 device_links_write_lock();
511
512 list_for_each_entry(link, &dev->links.consumers, s_node) {
513 if (link->flags & DL_FLAG_STATELESS)
514 continue;
515
516 if (link->status == DL_STATE_CONSUMER_PROBE
517 || link->status == DL_STATE_ACTIVE) {
518 ret = true;
519 break;
520 }
521 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
522 }
523
524 dev->links.status = DL_DEV_UNBINDING;
525
526 device_links_write_unlock();
527 return ret;
528}
529
530/**
531 * device_links_unbind_consumers - Force unbind consumers of the given device.
532 * @dev: Device to unbind the consumers of.
533 *
534 * Walk the list of links to consumers for @dev and if any of them is in the
535 * "consumer probe" state, wait for all device probes in progress to complete
536 * and start over.
537 *
538 * If that's not the case, change the status of the link to "supplier unbind"
539 * and check if the link was in the "active" state. If so, force the consumer
540 * driver to unbind and start over (the consumer will not re-probe as we have
541 * changed the state of the link already).
542 *
543 * Links with the DL_FLAG_STATELESS flag set are ignored.
544 */
545void device_links_unbind_consumers(struct device *dev)
546{
547 struct device_link *link;
548
549 start:
550 device_links_write_lock();
551
552 list_for_each_entry(link, &dev->links.consumers, s_node) {
553 enum device_link_state status;
554
555 if (link->flags & DL_FLAG_STATELESS)
556 continue;
557
558 status = link->status;
559 if (status == DL_STATE_CONSUMER_PROBE) {
560 device_links_write_unlock();
561
562 wait_for_device_probe();
563 goto start;
564 }
565 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
566 if (status == DL_STATE_ACTIVE) {
567 struct device *consumer = link->consumer;
568
569 get_device(consumer);
570
571 device_links_write_unlock();
572
573 device_release_driver_internal(consumer, NULL,
574 consumer->parent);
575 put_device(consumer);
576 goto start;
577 }
578 }
579
580 device_links_write_unlock();
581}
582
583/**
584 * device_links_purge - Delete existing links to other devices.
585 * @dev: Target device.
586 */
587static void device_links_purge(struct device *dev)
588{
589 struct device_link *link, *ln;
590
591 /*
592 * Delete all of the remaining links from this device to any other
593 * devices (either consumers or suppliers).
594 */
595 device_links_write_lock();
596
597 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
598 WARN_ON(link->status == DL_STATE_ACTIVE);
599 __device_link_del(link);
600 }
601
602 list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
603 WARN_ON(link->status != DL_STATE_DORMANT &&
604 link->status != DL_STATE_NONE);
605 __device_link_del(link);
606 }
607
608 device_links_write_unlock();
609}
610
611/* Device links support end. */
612
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800613int (*platform_notify)(struct device *dev) = NULL;
614int (*platform_notify_remove)(struct device *dev) = NULL;
Dan Williamse105b8b2008-04-21 10:51:07 -0700615static struct kobject *dev_kobj;
616struct kobject *sysfs_dev_char_kobj;
617struct kobject *sysfs_dev_block_kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200619static DEFINE_MUTEX(device_hotplug_lock);
620
621void lock_device_hotplug(void)
622{
623 mutex_lock(&device_hotplug_lock);
624}
625
626void unlock_device_hotplug(void)
627{
628 mutex_unlock(&device_hotplug_lock);
629}
630
631int lock_device_hotplug_sysfs(void)
632{
633 if (mutex_trylock(&device_hotplug_lock))
634 return 0;
635
636 /* Avoid busy looping (5 ms of sleep should do). */
637 msleep(5);
638 return restart_syscall();
639}
640
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -0800641#ifdef CONFIG_BLOCK
642static inline int device_is_not_partition(struct device *dev)
643{
644 return !(dev->type == &part_type);
645}
646#else
647static inline int device_is_not_partition(struct device *dev)
648{
649 return 1;
650}
651#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Alan Stern3e956372006-06-16 17:10:48 -0400653/**
654 * dev_driver_string - Return a device's driver name, if at all possible
655 * @dev: struct device to get the name of
656 *
657 * Will return the device's driver's name if it is bound to a device. If
yan9169c012012-04-20 21:08:45 +0800658 * the device is not bound to a driver, it will return the name of the bus
Alan Stern3e956372006-06-16 17:10:48 -0400659 * it is attached to. If it is not attached to a bus either, an empty
660 * string will be returned.
661 */
Jean Delvarebf9ca692008-07-30 12:29:21 -0700662const char *dev_driver_string(const struct device *dev)
Alan Stern3e956372006-06-16 17:10:48 -0400663{
Alan Stern35899722009-12-04 11:06:57 -0500664 struct device_driver *drv;
665
666 /* dev->driver can change to NULL underneath us because of unbinding,
667 * so be careful about accessing it. dev->bus and dev->class should
668 * never change once they are set, so they don't need special care.
669 */
670 drv = ACCESS_ONCE(dev->driver);
671 return drv ? drv->name :
Jean Delvarea456b702007-03-09 16:33:10 +0100672 (dev->bus ? dev->bus->name :
673 (dev->class ? dev->class->name : ""));
Alan Stern3e956372006-06-16 17:10:48 -0400674}
Matthew Wilcox310a9222006-09-23 23:35:04 -0600675EXPORT_SYMBOL(dev_driver_string);
Alan Stern3e956372006-06-16 17:10:48 -0400676
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
678
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800679static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
680 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800682 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200683 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500684 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686 if (dev_attr->show)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400687 ret = dev_attr->show(dev, dev_attr, buf);
Andrew Morton815d2d52008-03-04 15:09:07 -0800688 if (ret >= (ssize_t)PAGE_SIZE) {
Greg Kroah-Hartman53a9c872013-01-17 13:10:23 -0800689 print_symbol("dev_attr_show: %s returned bad count\n",
690 (unsigned long)dev_attr->show);
Andrew Morton815d2d52008-03-04 15:09:07 -0800691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 return ret;
693}
694
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800695static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
696 const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800698 struct device_attribute *dev_attr = to_dev_attr(attr);
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200699 struct device *dev = kobj_to_dev(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -0500700 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702 if (dev_attr->store)
Yani Ioannou54b6f352005-05-17 06:39:34 -0400703 ret = dev_attr->store(dev, dev_attr, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 return ret;
705}
706
Emese Revfy52cf25d2010-01-19 02:58:23 +0100707static const struct sysfs_ops dev_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 .show = dev_attr_show,
709 .store = dev_attr_store,
710};
711
Kay Sieversca22e562011-12-14 14:29:38 -0800712#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
713
714ssize_t device_store_ulong(struct device *dev,
715 struct device_attribute *attr,
716 const char *buf, size_t size)
717{
718 struct dev_ext_attribute *ea = to_ext_attr(attr);
719 char *end;
720 unsigned long new = simple_strtoul(buf, &end, 0);
721 if (end == buf)
722 return -EINVAL;
723 *(unsigned long *)(ea->var) = new;
724 /* Always return full write size even if we didn't consume all */
725 return size;
726}
727EXPORT_SYMBOL_GPL(device_store_ulong);
728
729ssize_t device_show_ulong(struct device *dev,
730 struct device_attribute *attr,
731 char *buf)
732{
733 struct dev_ext_attribute *ea = to_ext_attr(attr);
734 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
735}
736EXPORT_SYMBOL_GPL(device_show_ulong);
737
738ssize_t device_store_int(struct device *dev,
739 struct device_attribute *attr,
740 const char *buf, size_t size)
741{
742 struct dev_ext_attribute *ea = to_ext_attr(attr);
743 char *end;
744 long new = simple_strtol(buf, &end, 0);
745 if (end == buf || new > INT_MAX || new < INT_MIN)
746 return -EINVAL;
747 *(int *)(ea->var) = new;
748 /* Always return full write size even if we didn't consume all */
749 return size;
750}
751EXPORT_SYMBOL_GPL(device_store_int);
752
753ssize_t device_show_int(struct device *dev,
754 struct device_attribute *attr,
755 char *buf)
756{
757 struct dev_ext_attribute *ea = to_ext_attr(attr);
758
759 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
760}
761EXPORT_SYMBOL_GPL(device_show_int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Borislav Petkov91872392012-10-09 19:52:05 +0200763ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
764 const char *buf, size_t size)
765{
766 struct dev_ext_attribute *ea = to_ext_attr(attr);
767
768 if (strtobool(buf, ea->var) < 0)
769 return -EINVAL;
770
771 return size;
772}
773EXPORT_SYMBOL_GPL(device_store_bool);
774
775ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
776 char *buf)
777{
778 struct dev_ext_attribute *ea = to_ext_attr(attr);
779
780 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
781}
782EXPORT_SYMBOL_GPL(device_show_bool);
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784/**
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400785 * device_release - free device structure.
786 * @kobj: device's kobject.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 *
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -0400788 * This is called once the reference count for the object
789 * reaches 0. We forward the call to the device's release
790 * method, which should handle actually freeing the structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800792static void device_release(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200794 struct device *dev = kobj_to_dev(kobj);
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800795 struct device_private *p = dev->p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Ming Leia525a3d2012-07-25 01:42:29 +0800797 /*
798 * Some platform devices are driven without driver attached
799 * and managed resources may have been acquired. Make sure
800 * all resources are released.
801 *
802 * Drivers still can add resources into device after device
803 * is deleted but alive, so release devres here to avoid
804 * possible memory leak.
805 */
806 devres_release_all(dev);
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (dev->release)
809 dev->release(dev);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200810 else if (dev->type && dev->type->release)
811 dev->type->release(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700812 else if (dev->class && dev->class->dev_release)
813 dev->class->dev_release(dev);
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700814 else
815 WARN(1, KERN_ERR "Device '%s' does not have a release() "
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800816 "function, it is broken and must be fixed.\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100817 dev_name(dev));
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -0800818 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
820
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700821static const void *device_namespace(struct kobject *kobj)
822{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200823 struct device *dev = kobj_to_dev(kobj);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700824 const void *ns = NULL;
825
826 if (dev->class && dev->class->ns_type)
827 ns = dev->class->namespace(dev);
828
829 return ns;
830}
831
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600832static struct kobj_type device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 .release = device_release,
834 .sysfs_ops = &dev_sysfs_ops,
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700835 .namespace = device_namespace,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836};
837
838
Kay Sievers312c0042005-11-16 09:00:00 +0100839static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
841 struct kobj_type *ktype = get_ktype(kobj);
842
Greg Kroah-Hartman8f4afc42007-10-11 10:47:49 -0600843 if (ktype == &device_ktype) {
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200844 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 if (dev->bus)
846 return 1;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700847 if (dev->class)
848 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 }
850 return 0;
851}
852
Kay Sievers312c0042005-11-16 09:00:00 +0100853static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200855 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700857 if (dev->bus)
858 return dev->bus->name;
859 if (dev->class)
860 return dev->class->name;
861 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862}
863
Kay Sievers7eff2e72007-08-14 15:15:12 +0200864static int dev_uevent(struct kset *kset, struct kobject *kobj,
865 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +0200867 struct device *dev = kobj_to_dev(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 int retval = 0;
869
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200870 /* add device node properties if present */
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700871 if (MAJOR(dev->devt)) {
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200872 const char *tmp;
873 const char *name;
Al Viro2c9ede52011-07-23 20:24:48 -0400874 umode_t mode = 0;
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700875 kuid_t uid = GLOBAL_ROOT_UID;
876 kgid_t gid = GLOBAL_ROOT_GID;
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200877
Kay Sievers7eff2e72007-08-14 15:15:12 +0200878 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
879 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700880 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200881 if (name) {
882 add_uevent_var(env, "DEVNAME=%s", name);
Kay Sieverse454cea2009-09-18 23:01:12 +0200883 if (mode)
884 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -0700885 if (!uid_eq(uid, GLOBAL_ROOT_UID))
886 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
887 if (!gid_eq(gid, GLOBAL_ROOT_GID))
888 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
Kay Sievers3c2670e2013-04-06 09:56:00 -0700889 kfree(tmp);
Kay Sievers6fcf53a2009-04-30 15:23:42 +0200890 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700891 }
892
Kay Sievers414264f2007-03-12 21:08:57 +0100893 if (dev->type && dev->type->name)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200894 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
Kay Sievers414264f2007-03-12 21:08:57 +0100895
Kay Sievers239378f2006-10-07 21:54:55 +0200896 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200897 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
Kay Sievers239378f2006-10-07 21:54:55 +0200898
Grant Likely07d57a32012-02-01 11:22:22 -0700899 /* Add common DT information about the device */
900 of_device_uevent(dev, env);
901
Kay Sievers7eff2e72007-08-14 15:15:12 +0200902 /* have the bus specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100903 if (dev->bus && dev->bus->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200904 retval = dev->bus->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200905 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800906 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100907 dev_name(dev), __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 }
909
Kay Sievers7eff2e72007-08-14 15:15:12 +0200910 /* have the class specific function add its stuff */
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700911 if (dev->class && dev->class->dev_uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200912 retval = dev->class->dev_uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200913 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800914 pr_debug("device: '%s': %s: class uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100915 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800916 __func__, retval);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200917 }
918
Stefan Weileef35c22010-08-06 21:11:15 +0200919 /* have the device type specific function add its stuff */
Kay Sieversf9f852d2006-10-07 21:54:55 +0200920 if (dev->type && dev->type->uevent) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200921 retval = dev->type->uevent(dev, env);
Kay Sieversf9f852d2006-10-07 21:54:55 +0200922 if (retval)
Greg Kroah-Hartman7dc72b22007-11-28 23:49:41 -0800923 pr_debug("device: '%s': %s: dev_type uevent() "
Kay Sievers1e0b2cf2008-10-30 01:36:48 +0100924 "returned %d\n", dev_name(dev),
Harvey Harrison2b3a3022008-03-04 16:41:05 -0800925 __func__, retval);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -0700926 }
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 return retval;
929}
930
Emese Revfy9cd43612009-12-31 14:52:51 +0100931static const struct kset_uevent_ops device_uevent_ops = {
Kay Sievers312c0042005-11-16 09:00:00 +0100932 .filter = dev_uevent_filter,
933 .name = dev_uevent_name,
934 .uevent = dev_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935};
936
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700937static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
Kay Sievers16574dc2007-04-06 01:40:38 +0200938 char *buf)
939{
940 struct kobject *top_kobj;
941 struct kset *kset;
Kay Sievers7eff2e72007-08-14 15:15:12 +0200942 struct kobj_uevent_env *env = NULL;
Kay Sievers16574dc2007-04-06 01:40:38 +0200943 int i;
944 size_t count = 0;
945 int retval;
946
947 /* search the kset, the device belongs to */
948 top_kobj = &dev->kobj;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200949 while (!top_kobj->kset && top_kobj->parent)
950 top_kobj = top_kobj->parent;
Kay Sievers16574dc2007-04-06 01:40:38 +0200951 if (!top_kobj->kset)
952 goto out;
Kay Sievers5c5daf62007-08-12 20:43:55 +0200953
Kay Sievers16574dc2007-04-06 01:40:38 +0200954 kset = top_kobj->kset;
955 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
956 goto out;
957
958 /* respect filter */
959 if (kset->uevent_ops && kset->uevent_ops->filter)
960 if (!kset->uevent_ops->filter(kset, &dev->kobj))
961 goto out;
962
Kay Sievers7eff2e72007-08-14 15:15:12 +0200963 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
964 if (!env)
Greg Kroah-Hartmanc7308c82007-05-02 14:14:11 +0200965 return -ENOMEM;
966
Kay Sievers16574dc2007-04-06 01:40:38 +0200967 /* let the kset specific function add its keys */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200968 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200969 if (retval)
970 goto out;
971
972 /* copy keys to file */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200973 for (i = 0; i < env->envp_idx; i++)
974 count += sprintf(&buf[count], "%s\n", env->envp[i]);
Kay Sievers16574dc2007-04-06 01:40:38 +0200975out:
Kay Sievers7eff2e72007-08-14 15:15:12 +0200976 kfree(env);
Kay Sievers16574dc2007-04-06 01:40:38 +0200977 return count;
978}
979
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700980static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
Kay Sieversa7fd6702005-10-01 14:49:43 +0200981 const char *buf, size_t count)
982{
Kay Sievers60a96a52007-07-08 22:29:26 +0200983 enum kobject_action action;
984
Kay Sievers3f5468c2010-01-14 22:54:37 +0100985 if (kobject_action_type(buf, count, &action) == 0)
Kay Sievers60a96a52007-07-08 22:29:26 +0200986 kobject_uevent(&dev->kobj, action);
Kay Sievers3f5468c2010-01-14 22:54:37 +0100987 else
988 dev_err(dev, "uevent: unknown action-string\n");
Kay Sieversa7fd6702005-10-01 14:49:43 +0200989 return count;
990}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700991static DEVICE_ATTR_RW(uevent);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200992
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -0700993static ssize_t online_show(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200994 char *buf)
995{
996 bool val;
997
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +0200998 device_lock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +0200999 val = !dev->offline;
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001000 device_unlock(dev);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001001 return sprintf(buf, "%u\n", val);
1002}
1003
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001004static ssize_t online_store(struct device *dev, struct device_attribute *attr,
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001005 const char *buf, size_t count)
1006{
1007 bool val;
1008 int ret;
1009
1010 ret = strtobool(buf, &val);
1011 if (ret < 0)
1012 return ret;
1013
Rafael J. Wysocki5e33bc42013-08-28 21:41:01 +02001014 ret = lock_device_hotplug_sysfs();
1015 if (ret)
1016 return ret;
1017
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001018 ret = val ? device_online(dev) : device_offline(dev);
1019 unlock_device_hotplug();
1020 return ret < 0 ? ret : count;
1021}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001022static DEVICE_ATTR_RW(online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001023
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -07001024int device_add_groups(struct device *dev, const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001025{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -07001026 return sysfs_create_groups(&dev->kobj, groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001027}
1028
Greg Kroah-Hartmanfa6fdb32013-08-08 15:22:55 -07001029void device_remove_groups(struct device *dev,
1030 const struct attribute_group **groups)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001031{
Greg Kroah-Hartman3e9b2ba2013-08-21 13:47:50 -07001032 sysfs_remove_groups(&dev->kobj, groups);
Greg Kroah-Hartmande0ff002006-06-27 00:06:09 -07001033}
1034
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001035static int device_add_attrs(struct device *dev)
1036{
1037 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -07001038 const struct device_type *type = dev->type;
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001039 int error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001040
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001041 if (class) {
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001042 error = device_add_groups(dev, class->dev_groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001043 if (error)
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001044 return error;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001045 }
Kay Sieversf9f852d2006-10-07 21:54:55 +02001046
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001047 if (type) {
1048 error = device_add_groups(dev, type->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001049 if (error)
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -07001050 goto err_remove_class_groups;
Kay Sieversf9f852d2006-10-07 21:54:55 +02001051 }
1052
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001053 error = device_add_groups(dev, dev->groups);
1054 if (error)
1055 goto err_remove_type_groups;
1056
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001057 if (device_supports_offline(dev) && !dev->offline_disabled) {
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001058 error = device_create_file(dev, &dev_attr_online);
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001059 if (error)
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +01001060 goto err_remove_dev_groups;
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02001061 }
1062
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001063 return 0;
1064
Rafael J. Wysockiecfbf6f2013-12-12 06:11:02 +01001065 err_remove_dev_groups:
1066 device_remove_groups(dev, dev->groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001067 err_remove_type_groups:
1068 if (type)
1069 device_remove_groups(dev, type->groups);
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001070 err_remove_class_groups:
1071 if (class)
1072 device_remove_groups(dev, class->dev_groups);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001073
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001074 return error;
1075}
1076
1077static void device_remove_attrs(struct device *dev)
1078{
1079 struct class *class = dev->class;
Stephen Hemmingeraed65af2011-03-28 09:12:52 -07001080 const struct device_type *type = dev->type;
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001081
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001082 device_remove_file(dev, &dev_attr_online);
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001083 device_remove_groups(dev, dev->groups);
Kay Sieversf9f852d2006-10-07 21:54:55 +02001084
Dmitry Torokhov621a1672007-03-10 01:37:34 -05001085 if (type)
1086 device_remove_groups(dev, type->groups);
1087
Greg Kroah-Hartmana6b01de2013-10-05 18:19:30 -07001088 if (class)
Greg Kroah-Hartmand05a6f92013-07-14 16:05:58 -07001089 device_remove_groups(dev, class->dev_groups);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001090}
1091
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001092static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001093 char *buf)
1094{
1095 return print_dev_t(buf, dev->devt);
1096}
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001097static DEVICE_ATTR_RO(dev);
Tejun Heoad6a1e12007-06-14 03:45:17 +09001098
Kay Sieversca22e562011-12-14 14:29:38 -08001099/* /sys/devices/ */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001100struct kset *devices_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102/**
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03001103 * devices_kset_move_before - Move device in the devices_kset's list.
1104 * @deva: Device to move.
1105 * @devb: Device @deva should come before.
1106 */
1107static void devices_kset_move_before(struct device *deva, struct device *devb)
1108{
1109 if (!devices_kset)
1110 return;
1111 pr_debug("devices_kset: Moving %s before %s\n",
1112 dev_name(deva), dev_name(devb));
1113 spin_lock(&devices_kset->list_lock);
1114 list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
1115 spin_unlock(&devices_kset->list_lock);
1116}
1117
1118/**
1119 * devices_kset_move_after - Move device in the devices_kset's list.
1120 * @deva: Device to move
1121 * @devb: Device @deva should come after.
1122 */
1123static void devices_kset_move_after(struct device *deva, struct device *devb)
1124{
1125 if (!devices_kset)
1126 return;
1127 pr_debug("devices_kset: Moving %s after %s\n",
1128 dev_name(deva), dev_name(devb));
1129 spin_lock(&devices_kset->list_lock);
1130 list_move(&deva->kobj.entry, &devb->kobj.entry);
1131 spin_unlock(&devices_kset->list_lock);
1132}
1133
1134/**
1135 * devices_kset_move_last - move the device to the end of devices_kset's list.
1136 * @dev: device to move
1137 */
1138void devices_kset_move_last(struct device *dev)
1139{
1140 if (!devices_kset)
1141 return;
1142 pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
1143 spin_lock(&devices_kset->list_lock);
1144 list_move_tail(&dev->kobj.entry, &devices_kset->list);
1145 spin_unlock(&devices_kset->list_lock);
1146}
1147
1148/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001149 * device_create_file - create sysfs attribute file for device.
1150 * @dev: device.
1151 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 */
Phil Carmody26579ab2009-12-18 15:34:19 +02001153int device_create_file(struct device *dev,
1154 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155{
1156 int error = 0;
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001157
1158 if (dev) {
1159 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
dyoung@redhat.com97521972013-05-16 14:31:30 +08001160 "Attribute %s: write permission without 'store'\n",
1161 attr->attr.name);
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001162 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
dyoung@redhat.com97521972013-05-16 14:31:30 +08001163 "Attribute %s: read permission without 'show'\n",
1164 attr->attr.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 error = sysfs_create_file(&dev->kobj, &attr->attr);
Felipe Balbi8f46baa2013-02-20 10:31:42 +02001166 }
1167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 return error;
1169}
David Graham White86df2682013-07-21 20:41:14 -04001170EXPORT_SYMBOL_GPL(device_create_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
1172/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001173 * device_remove_file - remove sysfs attribute file.
1174 * @dev: device.
1175 * @attr: device attribute descriptor.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 */
Phil Carmody26579ab2009-12-18 15:34:19 +02001177void device_remove_file(struct device *dev,
1178 const struct device_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179{
Cornelia Huck0c98b192008-01-31 10:39:38 +01001180 if (dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 sysfs_remove_file(&dev->kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182}
David Graham White86df2682013-07-21 20:41:14 -04001183EXPORT_SYMBOL_GPL(device_remove_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001185/**
Tejun Heo6b0afc22014-02-03 14:03:01 -05001186 * device_remove_file_self - remove sysfs attribute file from its own method.
1187 * @dev: device.
1188 * @attr: device attribute descriptor.
1189 *
1190 * See kernfs_remove_self() for details.
1191 */
1192bool device_remove_file_self(struct device *dev,
1193 const struct device_attribute *attr)
1194{
1195 if (dev)
1196 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
1197 else
1198 return false;
1199}
1200EXPORT_SYMBOL_GPL(device_remove_file_self);
1201
1202/**
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001203 * device_create_bin_file - create sysfs binary attribute file for device.
1204 * @dev: device.
1205 * @attr: device binary attribute descriptor.
1206 */
Phil Carmody66ecb922009-12-18 15:34:20 +02001207int device_create_bin_file(struct device *dev,
1208 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001209{
1210 int error = -EINVAL;
1211 if (dev)
1212 error = sysfs_create_bin_file(&dev->kobj, attr);
1213 return error;
1214}
1215EXPORT_SYMBOL_GPL(device_create_bin_file);
1216
1217/**
1218 * device_remove_bin_file - remove sysfs binary attribute file
1219 * @dev: device.
1220 * @attr: device binary attribute descriptor.
1221 */
Phil Carmody66ecb922009-12-18 15:34:20 +02001222void device_remove_bin_file(struct device *dev,
1223 const struct bin_attribute *attr)
Greg Kroah-Hartman2589f1882006-09-19 09:39:19 -07001224{
1225 if (dev)
1226 sysfs_remove_bin_file(&dev->kobj, attr);
1227}
1228EXPORT_SYMBOL_GPL(device_remove_bin_file);
1229
James Bottomley34bb61f2005-09-06 16:56:51 -07001230static void klist_children_get(struct klist_node *n)
1231{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001232 struct device_private *p = to_device_private_parent(n);
1233 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -07001234
1235 get_device(dev);
1236}
1237
1238static void klist_children_put(struct klist_node *n)
1239{
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001240 struct device_private *p = to_device_private_parent(n);
1241 struct device *dev = p->device;
James Bottomley34bb61f2005-09-06 16:56:51 -07001242
1243 put_device(dev);
1244}
1245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001247 * device_initialize - init device structure.
1248 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 *
Cornelia Huck57394112008-09-03 18:26:40 +02001250 * This prepares the device for use by other layers by initializing
1251 * its fields.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001252 * It is the first half of device_register(), if called by
Cornelia Huck57394112008-09-03 18:26:40 +02001253 * that function, though it can also be called separately, so one
1254 * may use @dev's fields. In particular, get_device()/put_device()
1255 * may be used for reference counting of @dev after calling this
1256 * function.
1257 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001258 * All fields in @dev must be initialized by the caller to 0, except
1259 * for those explicitly set to some other value. The simplest
1260 * approach is to use kzalloc() to allocate the structure containing
1261 * @dev.
1262 *
Cornelia Huck57394112008-09-03 18:26:40 +02001263 * NOTE: Use put_device() to give up your reference instead of freeing
1264 * @dev directly once you have called this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266void device_initialize(struct device *dev)
1267{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001268 dev->kobj.kset = devices_kset;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -07001269 kobject_init(&dev->kobj, &device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 INIT_LIST_HEAD(&dev->dma_pools);
Thomas Gleixner31427882010-01-29 20:39:02 +00001271 mutex_init(&dev->mutex);
Peter Zijlstra1704f472010-03-19 01:37:42 +01001272 lockdep_set_novalidate_class(&dev->mutex);
Tejun Heo9ac78492007-01-20 16:00:26 +09001273 spin_lock_init(&dev->devres_lock);
1274 INIT_LIST_HEAD(&dev->devres_head);
Alan Stern3b98aea2008-08-07 13:06:12 -04001275 device_pm_init(dev);
Christoph Hellwig87348132006-12-06 20:32:33 -08001276 set_dev_node(dev, -1);
Jiang Liu4a7cc832015-07-09 16:00:44 +08001277#ifdef CONFIG_GENERIC_MSI_IRQ
1278 INIT_LIST_HEAD(&dev->msi_list);
1279#endif
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +01001280 INIT_LIST_HEAD(&dev->links.consumers);
1281 INIT_LIST_HEAD(&dev->links.suppliers);
1282 dev->links.status = DL_DEV_NO_DRIVER;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283}
David Graham White86df2682013-07-21 20:41:14 -04001284EXPORT_SYMBOL_GPL(device_initialize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285
Tejun Heod73ce002013-03-12 11:30:05 -07001286struct kobject *virtual_device_parent(struct device *dev)
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001287{
Kay Sievers86406242007-03-14 03:25:56 +01001288 static struct kobject *virtual_dir = NULL;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001289
Kay Sievers86406242007-03-14 03:25:56 +01001290 if (!virtual_dir)
Greg Kroah-Hartman4ff6abf2007-11-05 22:24:43 -08001291 virtual_dir = kobject_create_and_add("virtual",
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06001292 &devices_kset->kobj);
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001293
Kay Sievers86406242007-03-14 03:25:56 +01001294 return virtual_dir;
Greg Kroah-Hartmanf0ee61a2006-10-23 10:40:54 -07001295}
1296
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001297struct class_dir {
1298 struct kobject kobj;
1299 struct class *class;
1300};
1301
1302#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
1303
1304static void class_dir_release(struct kobject *kobj)
1305{
1306 struct class_dir *dir = to_class_dir(kobj);
1307 kfree(dir);
1308}
1309
1310static const
1311struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
1312{
1313 struct class_dir *dir = to_class_dir(kobj);
1314 return dir->class->ns_type;
1315}
1316
1317static struct kobj_type class_dir_ktype = {
1318 .release = class_dir_release,
1319 .sysfs_ops = &kobj_sysfs_ops,
1320 .child_ns_type = class_dir_child_ns_type
1321};
1322
1323static struct kobject *
1324class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
1325{
1326 struct class_dir *dir;
1327 int retval;
1328
1329 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
1330 if (!dir)
1331 return NULL;
1332
1333 dir->class = class;
1334 kobject_init(&dir->kobj, &class_dir_ktype);
1335
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001336 dir->kobj.kset = &class->p->glue_dirs;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001337
1338 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
1339 if (retval < 0) {
1340 kobject_put(&dir->kobj);
1341 return NULL;
1342 }
1343 return &dir->kobj;
1344}
1345
Yijing Wange4a60d12014-11-07 12:05:49 +08001346static DEFINE_MUTEX(gdp_mutex);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001347
Kay Sieversda231fd2007-11-21 17:29:15 +01001348static struct kobject *get_device_parent(struct device *dev,
1349 struct device *parent)
Greg Kroah-Hartman40fa5422006-10-24 00:37:58 +01001350{
Kay Sievers86406242007-03-14 03:25:56 +01001351 if (dev->class) {
1352 struct kobject *kobj = NULL;
1353 struct kobject *parent_kobj;
1354 struct kobject *k;
1355
Randy Dunlapead454f2010-09-24 14:36:49 -07001356#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -07001357 /* block disks show up in /sys/block */
Andi Kleene52eec12010-09-08 16:54:17 +02001358 if (sysfs_deprecated && dev->class == &block_class) {
Kay Sievers39aba962010-09-04 22:33:14 -07001359 if (parent && parent->class == &block_class)
1360 return &parent->kobj;
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001361 return &block_class.p->subsys.kobj;
Kay Sievers39aba962010-09-04 22:33:14 -07001362 }
Randy Dunlapead454f2010-09-24 14:36:49 -07001363#endif
Andi Kleene52eec12010-09-08 16:54:17 +02001364
Kay Sievers86406242007-03-14 03:25:56 +01001365 /*
1366 * If we have no parent, we live in "virtual".
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001367 * Class-devices with a non class-device as parent, live
1368 * in a "glue" directory to prevent namespace collisions.
Kay Sievers86406242007-03-14 03:25:56 +01001369 */
1370 if (parent == NULL)
1371 parent_kobj = virtual_device_parent(dev);
Eric W. Biederman24b14422010-07-24 22:43:35 -07001372 else if (parent->class && !dev->class->ns_type)
Kay Sievers86406242007-03-14 03:25:56 +01001373 return &parent->kobj;
1374 else
1375 parent_kobj = &parent->kobj;
1376
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001377 mutex_lock(&gdp_mutex);
1378
Kay Sievers86406242007-03-14 03:25:56 +01001379 /* find our class-directory at the parent and reference it */
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001380 spin_lock(&dev->class->p->glue_dirs.list_lock);
1381 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
Kay Sievers86406242007-03-14 03:25:56 +01001382 if (k->parent == parent_kobj) {
1383 kobj = kobject_get(k);
1384 break;
1385 }
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001386 spin_unlock(&dev->class->p->glue_dirs.list_lock);
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001387 if (kobj) {
1388 mutex_unlock(&gdp_mutex);
Kay Sievers86406242007-03-14 03:25:56 +01001389 return kobj;
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001390 }
Kay Sievers86406242007-03-14 03:25:56 +01001391
1392 /* or create a new class-directory at the parent device */
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001393 k = class_dir_create_and_add(dev->class, parent_kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001394 /* do not emit an uevent for this simple "glue" directory */
Tejun Heo77d3d7c2010-02-05 17:57:02 +09001395 mutex_unlock(&gdp_mutex);
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -08001396 return k;
Kay Sievers86406242007-03-14 03:25:56 +01001397 }
1398
Kay Sieversca22e562011-12-14 14:29:38 -08001399 /* subsystems can specify a default root directory for their devices */
1400 if (!parent && dev->bus && dev->bus->dev_root)
1401 return &dev->bus->dev_root->kobj;
1402
Kay Sievers86406242007-03-14 03:25:56 +01001403 if (parent)
Cornelia Huckc744aeae2007-01-08 20:16:44 +01001404 return &parent->kobj;
1405 return NULL;
1406}
Kay Sieversda231fd2007-11-21 17:29:15 +01001407
Ming Leicebf8fd2016-07-10 19:27:36 +08001408static inline bool live_in_glue_dir(struct kobject *kobj,
1409 struct device *dev)
1410{
1411 if (!kobj || !dev->class ||
1412 kobj->kset != &dev->class->p->glue_dirs)
1413 return false;
1414 return true;
1415}
1416
1417static inline struct kobject *get_glue_dir(struct device *dev)
1418{
1419 return dev->kobj.parent;
1420}
1421
1422/*
1423 * make sure cleaning up dir as the last step, we need to make
1424 * sure .release handler of kobject is run with holding the
1425 * global lock
1426 */
Cornelia Huck63b69712008-01-21 16:09:44 +01001427static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
Kay Sieversda231fd2007-11-21 17:29:15 +01001428{
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001429 /* see if we live in a "glue" directory */
Ming Leicebf8fd2016-07-10 19:27:36 +08001430 if (!live_in_glue_dir(glue_dir, dev))
Kay Sieversda231fd2007-11-21 17:29:15 +01001431 return;
1432
Yijing Wange4a60d12014-11-07 12:05:49 +08001433 mutex_lock(&gdp_mutex);
Kay Sievers0f4dafc2007-12-19 01:40:42 +01001434 kobject_put(glue_dir);
Yijing Wange4a60d12014-11-07 12:05:49 +08001435 mutex_unlock(&gdp_mutex);
Kay Sieversda231fd2007-11-21 17:29:15 +01001436}
Cornelia Huck63b69712008-01-21 16:09:44 +01001437
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001438static int device_add_class_symlinks(struct device *dev)
1439{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001440 struct device_node *of_node = dev_of_node(dev);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001441 int error;
1442
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001443 if (of_node) {
1444 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
1445 if (error)
1446 dev_warn(dev, "Error %d creating of_node link\n",error);
1447 /* An error here doesn't warrant bringing down the device */
1448 }
1449
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001450 if (!dev->class)
1451 return 0;
Kay Sieversda231fd2007-11-21 17:29:15 +01001452
Greg Kroah-Hartman1fbfee62008-05-28 09:28:39 -07001453 error = sysfs_create_link(&dev->kobj,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001454 &dev->class->p->subsys.kobj,
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001455 "subsystem");
1456 if (error)
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001457 goto out_devnode;
Kay Sieversda231fd2007-11-21 17:29:15 +01001458
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -08001459 if (dev->parent && device_is_not_partition(dev)) {
Dmitry Torokhov4f01a752007-09-18 22:46:50 -07001460 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
1461 "device");
1462 if (error)
Kay Sievers39aba962010-09-04 22:33:14 -07001463 goto out_subsys;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001464 }
Kay Sievers39aba962010-09-04 22:33:14 -07001465
Randy Dunlapead454f2010-09-24 14:36:49 -07001466#ifdef CONFIG_BLOCK
Kay Sievers39aba962010-09-04 22:33:14 -07001467 /* /sys/block has directories and does not need symlinks */
Andi Kleene52eec12010-09-08 16:54:17 +02001468 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -07001469 return 0;
Randy Dunlapead454f2010-09-24 14:36:49 -07001470#endif
Kay Sievers39aba962010-09-04 22:33:14 -07001471
1472 /* link in the class directory pointing to the device */
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001473 error = sysfs_create_link(&dev->class->p->subsys.kobj,
Kay Sievers39aba962010-09-04 22:33:14 -07001474 &dev->kobj, dev_name(dev));
1475 if (error)
1476 goto out_device;
1477
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001478 return 0;
1479
Kay Sievers39aba962010-09-04 22:33:14 -07001480out_device:
1481 sysfs_remove_link(&dev->kobj, "device");
Kay Sieversda231fd2007-11-21 17:29:15 +01001482
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001483out_subsys:
1484 sysfs_remove_link(&dev->kobj, "subsystem");
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001485out_devnode:
1486 sysfs_remove_link(&dev->kobj, "of_node");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001487 return error;
1488}
1489
1490static void device_remove_class_symlinks(struct device *dev)
1491{
Benjamin Herrenschmidt5590f312015-02-18 11:25:18 +11001492 if (dev_of_node(dev))
1493 sysfs_remove_link(&dev->kobj, "of_node");
1494
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001495 if (!dev->class)
1496 return;
Kay Sieversda231fd2007-11-21 17:29:15 +01001497
Greg Kroah-Hartman4e886c22008-01-27 12:12:43 -08001498 if (dev->parent && device_is_not_partition(dev))
Kay Sieversda231fd2007-11-21 17:29:15 +01001499 sysfs_remove_link(&dev->kobj, "device");
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001500 sysfs_remove_link(&dev->kobj, "subsystem");
Randy Dunlapead454f2010-09-24 14:36:49 -07001501#ifdef CONFIG_BLOCK
Andi Kleene52eec12010-09-08 16:54:17 +02001502 if (sysfs_deprecated && dev->class == &block_class)
Kay Sievers39aba962010-09-04 22:33:14 -07001503 return;
Randy Dunlapead454f2010-09-24 14:36:49 -07001504#endif
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001505 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001506}
1507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508/**
Stephen Rothwell413c2392008-05-30 10:16:40 +10001509 * dev_set_name - set a device name
1510 * @dev: device
Randy Dunlap46232362008-06-04 21:40:43 -07001511 * @fmt: format string for the device's name
Stephen Rothwell413c2392008-05-30 10:16:40 +10001512 */
1513int dev_set_name(struct device *dev, const char *fmt, ...)
1514{
1515 va_list vargs;
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001516 int err;
Stephen Rothwell413c2392008-05-30 10:16:40 +10001517
1518 va_start(vargs, fmt);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001519 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
Stephen Rothwell413c2392008-05-30 10:16:40 +10001520 va_end(vargs);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001521 return err;
Stephen Rothwell413c2392008-05-30 10:16:40 +10001522}
1523EXPORT_SYMBOL_GPL(dev_set_name);
1524
1525/**
Dan Williamse105b8b2008-04-21 10:51:07 -07001526 * device_to_dev_kobj - select a /sys/dev/ directory for the device
1527 * @dev: device
1528 *
1529 * By default we select char/ for new entries. Setting class->dev_obj
1530 * to NULL prevents an entry from being created. class->dev_kobj must
1531 * be set (or cleared) before any devices are registered to the class
1532 * otherwise device_create_sys_dev_entry() and
Peter Korsgaard0d4e293c2012-04-17 12:12:57 +02001533 * device_remove_sys_dev_entry() will disagree about the presence of
1534 * the link.
Dan Williamse105b8b2008-04-21 10:51:07 -07001535 */
1536static struct kobject *device_to_dev_kobj(struct device *dev)
1537{
1538 struct kobject *kobj;
1539
1540 if (dev->class)
1541 kobj = dev->class->dev_kobj;
1542 else
1543 kobj = sysfs_dev_char_kobj;
1544
1545 return kobj;
1546}
1547
1548static int device_create_sys_dev_entry(struct device *dev)
1549{
1550 struct kobject *kobj = device_to_dev_kobj(dev);
1551 int error = 0;
1552 char devt_str[15];
1553
1554 if (kobj) {
1555 format_dev_t(devt_str, dev->devt);
1556 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
1557 }
1558
1559 return error;
1560}
1561
1562static void device_remove_sys_dev_entry(struct device *dev)
1563{
1564 struct kobject *kobj = device_to_dev_kobj(dev);
1565 char devt_str[15];
1566
1567 if (kobj) {
1568 format_dev_t(devt_str, dev->devt);
1569 sysfs_remove_link(kobj, devt_str);
1570 }
1571}
1572
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001573int device_private_init(struct device *dev)
1574{
1575 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
1576 if (!dev->p)
1577 return -ENOMEM;
1578 dev->p->device = dev;
1579 klist_init(&dev->p->klist_children, klist_children_get,
1580 klist_children_put);
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -08001581 INIT_LIST_HEAD(&dev->p->deferred_probe);
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001582 return 0;
1583}
1584
Dan Williamse105b8b2008-04-21 10:51:07 -07001585/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001586 * device_add - add device to device hierarchy.
1587 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001589 * This is part 2 of device_register(), though may be called
1590 * separately _iff_ device_initialize() has been called separately.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 *
Cornelia Huck57394112008-09-03 18:26:40 +02001592 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001593 * to the global and sibling lists for the device, then
1594 * adds it to the other relevant subsystems of the driver model.
Cornelia Huck57394112008-09-03 18:26:40 +02001595 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001596 * Do not call this routine or device_register() more than once for
1597 * any device structure. The driver model core is not designed to work
1598 * with devices that get unregistered and then spring back to life.
1599 * (Among other things, it's very hard to guarantee that all references
1600 * to the previous incarnation of @dev have been dropped.) Allocate
1601 * and register a fresh new struct device instead.
1602 *
Cornelia Huck57394112008-09-03 18:26:40 +02001603 * NOTE: _Never_ directly free @dev after calling this function, even
1604 * if it returned an error! Always use put_device() to give up your
1605 * reference instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 */
1607int device_add(struct device *dev)
1608{
1609 struct device *parent = NULL;
Kay Sieversca22e562011-12-14 14:29:38 -08001610 struct kobject *kobj;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001611 struct class_interface *class_intf;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001612 int error = -EINVAL;
Ming Leicebf8fd2016-07-10 19:27:36 +08001613 struct kobject *glue_dir = NULL;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01001614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 dev = get_device(dev);
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001616 if (!dev)
1617 goto done;
1618
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001619 if (!dev->p) {
Greg Kroah-Hartmanb4028432009-05-11 14:16:57 -07001620 error = device_private_init(dev);
1621 if (error)
1622 goto done;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001623 }
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -08001624
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001625 /*
1626 * for statically allocated devices, which should all be converted
1627 * some day, we need to initialize the name. We prevent reading back
1628 * the name, and force the use of dev_name()
1629 */
1630 if (dev->init_name) {
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07001631 dev_set_name(dev, "%s", dev->init_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01001632 dev->init_name = NULL;
1633 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001634
Kay Sieversca22e562011-12-14 14:29:38 -08001635 /* subsystems can specify simple device enumeration */
1636 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1637 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1638
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001639 if (!dev_name(dev)) {
1640 error = -EINVAL;
Kay Sievers5c8563d2009-05-28 14:24:07 -07001641 goto name_error;
Thomas Gleixnere6309e72009-12-10 19:32:49 +00001642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001644 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartmanc205ef42006-08-07 22:19:37 -07001645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 parent = get_device(dev->parent);
Kay Sieversca22e562011-12-14 14:29:38 -08001647 kobj = get_device_parent(dev, parent);
1648 if (kobj)
1649 dev->kobj.parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Yinghai Lu0d358f22008-02-19 03:20:41 -08001651 /* use parent numa_node */
Zhen Lei56f2de82015-08-25 12:08:22 +08001652 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
Yinghai Lu0d358f22008-02-19 03:20:41 -08001653 set_dev_node(dev, dev_to_node(parent));
1654
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 /* first, register with generic layer. */
Kay Sievers8a577ff2009-04-18 15:05:45 -07001656 /* we require the name to be set before, and pass NULL */
1657 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
Ming Leicebf8fd2016-07-10 19:27:36 +08001658 if (error) {
1659 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 goto Error;
Ming Leicebf8fd2016-07-10 19:27:36 +08001661 }
Kay Sieversa7fd6702005-10-01 14:49:43 +02001662
Brian Walsh37022642006-08-14 22:43:19 -07001663 /* notify platform of device entry */
1664 if (platform_notify)
1665 platform_notify(dev);
1666
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001667 error = device_create_file(dev, &dev_attr_uevent);
Cornelia Hucka306eea2006-09-22 11:37:13 +02001668 if (error)
1669 goto attrError;
Kay Sieversa7fd6702005-10-01 14:49:43 +02001670
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001671 error = device_add_class_symlinks(dev);
1672 if (error)
1673 goto SymlinkError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001674 error = device_add_attrs(dev);
1675 if (error)
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001676 goto AttrsError;
Cornelia Huckdc0afa82007-07-09 11:39:18 -07001677 error = bus_add_device(dev);
1678 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 goto BusError;
Alan Stern3b98aea2008-08-07 13:06:12 -04001680 error = dpm_sysfs_add(dev);
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001681 if (error)
Alan Stern3b98aea2008-08-07 13:06:12 -04001682 goto DPMError;
1683 device_pm_add(dev);
Alan Sternec0676ee2008-12-05 14:10:31 -05001684
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001685 if (MAJOR(dev->devt)) {
1686 error = device_create_file(dev, &dev_attr_dev);
1687 if (error)
1688 goto DevAttrError;
1689
1690 error = device_create_sys_dev_entry(dev);
1691 if (error)
1692 goto SysEntryError;
1693
1694 devtmpfs_create_node(dev);
1695 }
1696
Alan Sternec0676ee2008-12-05 14:10:31 -05001697 /* Notify clients of device addition. This call must come
majianpeng268863f2012-01-11 15:12:06 +00001698 * after dpm_sysfs_add() and before kobject_uevent().
Alan Sternec0676ee2008-12-05 14:10:31 -05001699 */
1700 if (dev->bus)
1701 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1702 BUS_NOTIFY_ADD_DEVICE, dev);
1703
Cornelia Huck83b5fb4c2007-03-29 11:12:11 +02001704 kobject_uevent(&dev->kobj, KOBJ_ADD);
Alan Stern2023c612009-07-30 15:27:18 -04001705 bus_probe_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001707 klist_add_tail(&dev->p->knode_parent,
1708 &parent->p->klist_children);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001710 if (dev->class) {
Kay Sieversca22e562011-12-14 14:29:38 -08001711 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001712 /* tie the class to the device */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001713 klist_add_tail(&dev->knode_class,
Kay Sievers6b6e39a2010-11-15 23:13:18 +01001714 &dev->class->p->klist_devices);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001715
1716 /* notify any interfaces that the device is here */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001717 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001718 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001719 if (class_intf->add_dev)
1720 class_intf->add_dev(dev, class_intf);
Kay Sieversca22e562011-12-14 14:29:38 -08001721 mutex_unlock(&dev->class->p->mutex);
Greg Kroah-Hartman5d9fd162006-06-22 17:17:32 -07001722 }
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001723done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 put_device(dev);
1725 return error;
Sergey Klyaus0cd75042014-10-08 11:31:54 +04001726 SysEntryError:
1727 if (MAJOR(dev->devt))
1728 device_remove_file(dev, &dev_attr_dev);
1729 DevAttrError:
1730 device_pm_remove(dev);
1731 dpm_sysfs_remove(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001732 DPMError:
Rafael J. Wysocki57eee3d2008-03-12 00:59:38 +01001733 bus_remove_device(dev);
1734 BusError:
James Simmons82f0cf92007-02-21 17:44:51 +00001735 device_remove_attrs(dev);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001736 AttrsError:
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07001737 device_remove_class_symlinks(dev);
1738 SymlinkError:
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001739 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07001740 attrError:
Kay Sievers312c0042005-11-16 09:00:00 +01001741 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001742 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 kobject_del(&dev->kobj);
1744 Error:
Ming Leicebf8fd2016-07-10 19:27:36 +08001745 cleanup_glue_dir(dev, glue_dir);
Markus Elfring5f0163a2015-02-05 11:48:26 +01001746 put_device(parent);
Kay Sievers5c8563d2009-05-28 14:24:07 -07001747name_error:
1748 kfree(dev->p);
1749 dev->p = NULL;
Greg Kroah-Hartmanc906a482008-05-30 10:45:12 -07001750 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751}
David Graham White86df2682013-07-21 20:41:14 -04001752EXPORT_SYMBOL_GPL(device_add);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001755 * device_register - register a device with the system.
1756 * @dev: pointer to the device structure
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001758 * This happens in two clean steps - initialize the device
1759 * and add it to the system. The two steps can be called
1760 * separately, but this is the easiest and most common.
1761 * I.e. you should only call the two helpers separately if
1762 * have a clearly defined need to use and refcount the device
1763 * before it is added to the hierarchy.
Cornelia Huck57394112008-09-03 18:26:40 +02001764 *
Alan Sternb10d5ef2012-01-17 11:39:00 -05001765 * For more information, see the kerneldoc for device_initialize()
1766 * and device_add().
1767 *
Cornelia Huck57394112008-09-03 18:26:40 +02001768 * NOTE: _Never_ directly free @dev after calling this function, even
1769 * if it returned an error! Always use put_device() to give up the
1770 * reference initialized in this function instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772int device_register(struct device *dev)
1773{
1774 device_initialize(dev);
1775 return device_add(dev);
1776}
David Graham White86df2682013-07-21 20:41:14 -04001777EXPORT_SYMBOL_GPL(device_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001780 * get_device - increment reference count for device.
1781 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001783 * This simply forwards the call to kobject_get(), though
1784 * we do take care to provide for the case that we get a NULL
1785 * pointer passed in.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001787struct device *get_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788{
Lars-Peter Clausenb0d1f802012-07-03 18:49:36 +02001789 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790}
David Graham White86df2682013-07-21 20:41:14 -04001791EXPORT_SYMBOL_GPL(get_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001794 * put_device - decrement reference count.
1795 * @dev: device in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001797void put_device(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001799 /* might_sleep(); */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 if (dev)
1801 kobject_put(&dev->kobj);
1802}
David Graham White86df2682013-07-21 20:41:14 -04001803EXPORT_SYMBOL_GPL(put_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001806 * device_del - delete device from system.
1807 * @dev: device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001809 * This is the first part of the device unregistration
1810 * sequence. This removes the device from the lists we control
1811 * from here, has it removed from the other driver model
1812 * subsystems it was added to in device_add(), and removes it
1813 * from the kobject hierarchy.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001815 * NOTE: this should be called manually _iff_ device_add() was
1816 * also called manually.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001818void device_del(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001820 struct device *parent = dev->parent;
Ming Leicebf8fd2016-07-10 19:27:36 +08001821 struct kobject *glue_dir = NULL;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001822 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823
Alan Sternec0676ee2008-12-05 14:10:31 -05001824 /* Notify clients of device removal. This call must come
1825 * before dpm_sysfs_remove().
1826 */
1827 if (dev->bus)
1828 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1829 BUS_NOTIFY_DEL_DEVICE, dev);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +01001830
1831 device_links_purge(dev);
Alan Stern3b98aea2008-08-07 13:06:12 -04001832 dpm_sysfs_remove(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 if (parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001834 klist_del(&dev->p->knode_parent);
Dan Williamse105b8b2008-04-21 10:51:07 -07001835 if (MAJOR(dev->devt)) {
Kay Sievers2b2af542009-04-30 15:23:42 +02001836 devtmpfs_delete_node(dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001837 device_remove_sys_dev_entry(dev);
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001838 device_remove_file(dev, &dev_attr_dev);
Dan Williamse105b8b2008-04-21 10:51:07 -07001839 }
Kay Sieversb9d9c822006-06-15 15:31:56 +02001840 if (dev->class) {
Kay Sieversda231fd2007-11-21 17:29:15 +01001841 device_remove_class_symlinks(dev);
Kay Sievers99ef3ef2006-09-14 11:23:28 +02001842
Kay Sieversca22e562011-12-14 14:29:38 -08001843 mutex_lock(&dev->class->p->mutex);
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001844 /* notify any interfaces that the device is now gone */
Greg Kroah-Hartman184f1f72008-05-28 09:28:39 -07001845 list_for_each_entry(class_intf,
Kay Sieversca22e562011-12-14 14:29:38 -08001846 &dev->class->p->interfaces, node)
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +02001847 if (class_intf->remove_dev)
1848 class_intf->remove_dev(dev, class_intf);
1849 /* remove the device from the class list */
Tejun Heo5a3ceb82008-08-25 19:50:19 +02001850 klist_del(&dev->knode_class);
Kay Sieversca22e562011-12-14 14:29:38 -08001851 mutex_unlock(&dev->class->p->mutex);
Kay Sieversb9d9c822006-06-15 15:31:56 +02001852 }
Greg Kroah-Hartmanc5e064a2013-08-23 17:07:26 -07001853 device_remove_file(dev, &dev_attr_uevent);
Greg Kroah-Hartman2620efe2006-06-28 16:19:58 -07001854 device_remove_attrs(dev);
Benjamin Herrenschmidt28953532006-11-08 19:46:14 -08001855 bus_remove_device(dev);
LongX Zhang4b6d1f122012-10-25 00:21:28 +02001856 device_pm_remove(dev);
Grant Likelyd1c34142012-03-05 08:47:41 -07001857 driver_deferred_probe_del(dev);
Lukas Wunner478573c2016-07-28 02:25:41 +02001858 device_remove_properties(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
1860 /* Notify the platform of the removal, in case they
1861 * need to do anything...
1862 */
1863 if (platform_notify_remove)
1864 platform_notify_remove(dev);
Joerg Roedel599bad32014-09-30 13:02:02 +02001865 if (dev->bus)
1866 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1867 BUS_NOTIFY_REMOVED_DEVICE, dev);
Kay Sievers312c0042005-11-16 09:00:00 +01001868 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
Ming Leicebf8fd2016-07-10 19:27:36 +08001869 glue_dir = get_glue_dir(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 kobject_del(&dev->kobj);
Ming Leicebf8fd2016-07-10 19:27:36 +08001871 cleanup_glue_dir(dev, glue_dir);
Kay Sieversda231fd2007-11-21 17:29:15 +01001872 put_device(parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873}
David Graham White86df2682013-07-21 20:41:14 -04001874EXPORT_SYMBOL_GPL(device_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
1876/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001877 * device_unregister - unregister device from system.
1878 * @dev: device going away.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001880 * We do this in two parts, like we do device_register(). First,
1881 * we remove it from all the subsystems with device_del(), then
1882 * we decrement the reference count via put_device(). If that
1883 * is the final reference count, the device will be cleaned up
1884 * via device_release() above. Otherwise, the structure will
1885 * stick around until the final reference to the device is dropped.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001887void device_unregister(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01001889 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 device_del(dev);
1891 put_device(dev);
1892}
David Graham White86df2682013-07-21 20:41:14 -04001893EXPORT_SYMBOL_GPL(device_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001895static struct device *prev_device(struct klist_iter *i)
1896{
1897 struct klist_node *n = klist_prev(i);
1898 struct device *dev = NULL;
1899 struct device_private *p;
1900
1901 if (n) {
1902 p = to_device_private_parent(n);
1903 dev = p->device;
1904 }
1905 return dev;
1906}
1907
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001908static struct device *next_device(struct klist_iter *i)
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001909{
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001910 struct klist_node *n = klist_next(i);
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001911 struct device *dev = NULL;
1912 struct device_private *p;
1913
1914 if (n) {
1915 p = to_device_private_parent(n);
1916 dev = p->device;
1917 }
1918 return dev;
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001919}
1920
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921/**
Kay Sieverse454cea2009-09-18 23:01:12 +02001922 * device_get_devnode - path of device node file
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001923 * @dev: device
Kay Sieverse454cea2009-09-18 23:01:12 +02001924 * @mode: returned file access mode
Kay Sievers3c2670e2013-04-06 09:56:00 -07001925 * @uid: returned file owner
1926 * @gid: returned file group
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001927 * @tmp: possibly allocated string
1928 *
1929 * Return the relative path of a possible device node.
1930 * Non-default names may need to allocate a memory to compose
1931 * a name. This memory is returned in tmp and needs to be
1932 * freed by the caller.
1933 */
Kay Sieverse454cea2009-09-18 23:01:12 +02001934const char *device_get_devnode(struct device *dev,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001935 umode_t *mode, kuid_t *uid, kgid_t *gid,
Kay Sievers3c2670e2013-04-06 09:56:00 -07001936 const char **tmp)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001937{
1938 char *s;
1939
1940 *tmp = NULL;
1941
1942 /* the device type may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001943 if (dev->type && dev->type->devnode)
Kay Sievers3c2670e2013-04-06 09:56:00 -07001944 *tmp = dev->type->devnode(dev, mode, uid, gid);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001945 if (*tmp)
1946 return *tmp;
1947
1948 /* the class may provide a specific name */
Kay Sieverse454cea2009-09-18 23:01:12 +02001949 if (dev->class && dev->class->devnode)
1950 *tmp = dev->class->devnode(dev, mode);
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001951 if (*tmp)
1952 return *tmp;
1953
1954 /* return name without allocation, tmp == NULL */
1955 if (strchr(dev_name(dev), '!') == NULL)
1956 return dev_name(dev);
1957
1958 /* replace '!' in the name with '/' */
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001959 s = kstrdup(dev_name(dev), GFP_KERNEL);
1960 if (!s)
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001961 return NULL;
Rasmus Villemoesa29fd612015-06-25 15:02:33 -07001962 strreplace(s, '!', '/');
1963 return *tmp = s;
Kay Sievers6fcf53a2009-04-30 15:23:42 +02001964}
1965
1966/**
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001967 * device_for_each_child - device child iterator.
1968 * @parent: parent struct device.
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001969 * @fn: function to be called for each device.
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04001970 * @data: data for the callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001972 * Iterate over @parent's child devices, and call @fn for each,
1973 * passing it @data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 *
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001975 * We check the return of @fn each time. If it returns anything
1976 * other than 0, we break out and return that value.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001978int device_for_each_child(struct device *parent, void *data,
1979 int (*fn)(struct device *dev, void *data))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980{
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001981 struct klist_iter i;
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08001982 struct device *child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 int error = 0;
1984
Greg Kroah-Hartman014c90db2009-04-15 16:00:12 -07001985 if (!parent->p)
1986 return 0;
1987
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08001988 klist_iter_init(&parent->p->klist_children, &i);
mochel@digitalimplant.org36239572005-03-24 19:08:30 -08001989 while ((child = next_device(&i)) && !error)
1990 error = fn(child, data);
1991 klist_iter_exit(&i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 return error;
1993}
David Graham White86df2682013-07-21 20:41:14 -04001994EXPORT_SYMBOL_GPL(device_for_each_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995
Cornelia Huck5ab69982006-11-16 15:42:07 +01001996/**
Andy Shevchenko3d060ae2015-07-27 18:04:00 +03001997 * device_for_each_child_reverse - device child iterator in reversed order.
1998 * @parent: parent struct device.
1999 * @fn: function to be called for each device.
2000 * @data: data for the callback.
2001 *
2002 * Iterate over @parent's child devices, and call @fn for each,
2003 * passing it @data.
2004 *
2005 * We check the return of @fn each time. If it returns anything
2006 * other than 0, we break out and return that value.
2007 */
2008int device_for_each_child_reverse(struct device *parent, void *data,
2009 int (*fn)(struct device *dev, void *data))
2010{
2011 struct klist_iter i;
2012 struct device *child;
2013 int error = 0;
2014
2015 if (!parent->p)
2016 return 0;
2017
2018 klist_iter_init(&parent->p->klist_children, &i);
2019 while ((child = prev_device(&i)) && !error)
2020 error = fn(child, data);
2021 klist_iter_exit(&i);
2022 return error;
2023}
2024EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
2025
2026/**
Cornelia Huck5ab69982006-11-16 15:42:07 +01002027 * device_find_child - device iterator for locating a particular device.
2028 * @parent: parent struct device
Cornelia Huck5ab69982006-11-16 15:42:07 +01002029 * @match: Callback function to check device
Robert P. J. Dayf8878dc2013-06-01 20:17:34 -04002030 * @data: Data to pass to match function
Cornelia Huck5ab69982006-11-16 15:42:07 +01002031 *
2032 * This is similar to the device_for_each_child() function above, but it
2033 * returns a reference to a device that is 'found' for later use, as
2034 * determined by the @match callback.
2035 *
2036 * The callback should return 0 if the device doesn't match and non-zero
2037 * if it does. If the callback returns non-zero and a reference to the
2038 * current device can be obtained, this function will return to the caller
2039 * and not iterate over any more devices.
Federico Vagaa4e24002013-04-15 11:18:11 +02002040 *
2041 * NOTE: you will need to drop the reference with put_device() after use.
Cornelia Huck5ab69982006-11-16 15:42:07 +01002042 */
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08002043struct device *device_find_child(struct device *parent, void *data,
2044 int (*match)(struct device *dev, void *data))
Cornelia Huck5ab69982006-11-16 15:42:07 +01002045{
2046 struct klist_iter i;
2047 struct device *child;
2048
2049 if (!parent)
2050 return NULL;
2051
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002052 klist_iter_init(&parent->p->klist_children, &i);
Cornelia Huck5ab69982006-11-16 15:42:07 +01002053 while ((child = next_device(&i)))
2054 if (match(child, data) && get_device(child))
2055 break;
2056 klist_iter_exit(&i);
2057 return child;
2058}
David Graham White86df2682013-07-21 20:41:14 -04002059EXPORT_SYMBOL_GPL(device_find_child);
Cornelia Huck5ab69982006-11-16 15:42:07 +01002060
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061int __init devices_init(void)
2062{
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06002063 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
2064 if (!devices_kset)
2065 return -ENOMEM;
Dan Williamse105b8b2008-04-21 10:51:07 -07002066 dev_kobj = kobject_create_and_add("dev", NULL);
2067 if (!dev_kobj)
2068 goto dev_kobj_err;
2069 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
2070 if (!sysfs_dev_block_kobj)
2071 goto block_kobj_err;
2072 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
2073 if (!sysfs_dev_char_kobj)
2074 goto char_kobj_err;
2075
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -06002076 return 0;
Dan Williamse105b8b2008-04-21 10:51:07 -07002077
2078 char_kobj_err:
2079 kobject_put(sysfs_dev_block_kobj);
2080 block_kobj_err:
2081 kobject_put(dev_kobj);
2082 dev_kobj_err:
2083 kset_unregister(devices_kset);
2084 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085}
2086
Rafael J. Wysocki4f3549d2013-05-02 22:15:29 +02002087static int device_check_offline(struct device *dev, void *not_used)
2088{
2089 int ret;
2090
2091 ret = device_for_each_child(dev, NULL, device_check_offline);
2092 if (ret)
2093 return ret;
2094
2095 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
2096}
2097
2098/**
2099 * device_offline - Prepare the device for hot-removal.
2100 * @dev: Device to be put offline.
2101 *
2102 * Execute the device bus type's .offline() callback, if present, to prepare
2103 * the device for a subsequent hot-removal. If that succeeds, the device must
2104 * not be used until either it is removed or its bus type's .online() callback
2105 * is executed.
2106 *
2107 * Call under device_hotplug_lock.
2108 */
2109int device_offline(struct device *dev)
2110{
2111 int ret;
2112
2113 if (dev->offline_disabled)
2114 return -EPERM;
2115
2116 ret = device_for_each_child(dev, NULL, device_check_offline);
2117 if (ret)
2118 return ret;
2119
2120 device_lock(dev);
2121 if (device_supports_offline(dev)) {
2122 if (dev->offline) {
2123 ret = 1;
2124 } else {
2125 ret = dev->bus->offline(dev);
2126 if (!ret) {
2127 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
2128 dev->offline = true;
2129 }
2130 }
2131 }
2132 device_unlock(dev);
2133
2134 return ret;
2135}
2136
2137/**
2138 * device_online - Put the device back online after successful device_offline().
2139 * @dev: Device to be put back online.
2140 *
2141 * If device_offline() has been successfully executed for @dev, but the device
2142 * has not been removed subsequently, execute its bus type's .online() callback
2143 * to indicate that the device can be used again.
2144 *
2145 * Call under device_hotplug_lock.
2146 */
2147int device_online(struct device *dev)
2148{
2149 int ret = 0;
2150
2151 device_lock(dev);
2152 if (device_supports_offline(dev)) {
2153 if (dev->offline) {
2154 ret = dev->bus->online(dev);
2155 if (!ret) {
2156 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
2157 dev->offline = false;
2158 }
2159 } else {
2160 ret = 1;
2161 }
2162 }
2163 device_unlock(dev);
2164
2165 return ret;
2166}
2167
Karthigan Srinivasan7f100d12011-04-18 16:16:52 -05002168struct root_device {
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002169 struct device dev;
2170 struct module *owner;
2171};
2172
Josh Triplett93058422012-11-18 21:27:55 -08002173static inline struct root_device *to_root_device(struct device *d)
Ferenc Wagner481e2072011-01-07 15:17:47 +01002174{
2175 return container_of(d, struct root_device, dev);
2176}
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002177
2178static void root_device_release(struct device *dev)
2179{
2180 kfree(to_root_device(dev));
2181}
2182
2183/**
2184 * __root_device_register - allocate and register a root device
2185 * @name: root device name
2186 * @owner: owner module of the root device, usually THIS_MODULE
2187 *
2188 * This function allocates a root device and registers it
2189 * using device_register(). In order to free the returned
2190 * device, use root_device_unregister().
2191 *
2192 * Root devices are dummy devices which allow other devices
2193 * to be grouped under /sys/devices. Use this function to
2194 * allocate a root device and then use it as the parent of
2195 * any device which should appear under /sys/devices/{name}
2196 *
2197 * The /sys/devices/{name} directory will also contain a
2198 * 'module' symlink which points to the @owner directory
2199 * in sysfs.
2200 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002201 * Returns &struct device pointer on success, or ERR_PTR() on error.
2202 *
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002203 * Note: You probably want to use root_device_register().
2204 */
2205struct device *__root_device_register(const char *name, struct module *owner)
2206{
2207 struct root_device *root;
2208 int err = -ENOMEM;
2209
2210 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
2211 if (!root)
2212 return ERR_PTR(err);
2213
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -07002214 err = dev_set_name(&root->dev, "%s", name);
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002215 if (err) {
2216 kfree(root);
2217 return ERR_PTR(err);
2218 }
2219
2220 root->dev.release = root_device_release;
2221
2222 err = device_register(&root->dev);
2223 if (err) {
2224 put_device(&root->dev);
2225 return ERR_PTR(err);
2226 }
2227
Christoph Egger1d9e8822010-05-17 16:57:58 +02002228#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002229 if (owner) {
2230 struct module_kobject *mk = &owner->mkobj;
2231
2232 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
2233 if (err) {
2234 device_unregister(&root->dev);
2235 return ERR_PTR(err);
2236 }
2237 root->owner = owner;
2238 }
2239#endif
2240
2241 return &root->dev;
2242}
2243EXPORT_SYMBOL_GPL(__root_device_register);
2244
2245/**
2246 * root_device_unregister - unregister and free a root device
Randy Dunlap7cbcf222009-01-20 16:29:13 -08002247 * @dev: device going away
Mark McLoughlin0aa0dc42008-12-15 12:58:26 +00002248 *
2249 * This function unregisters and cleans up a device that was created by
2250 * root_device_register().
2251 */
2252void root_device_unregister(struct device *dev)
2253{
2254 struct root_device *root = to_root_device(dev);
2255
2256 if (root->owner)
2257 sysfs_remove_link(&root->dev.kobj, "module");
2258
2259 device_unregister(dev);
2260}
2261EXPORT_SYMBOL_GPL(root_device_unregister);
2262
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002263
2264static void device_create_release(struct device *dev)
2265{
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01002266 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002267 kfree(dev);
2268}
2269
Guenter Roeck39ef3112013-07-14 16:05:57 -07002270static struct device *
2271device_create_groups_vargs(struct class *class, struct device *parent,
2272 dev_t devt, void *drvdata,
2273 const struct attribute_group **groups,
2274 const char *fmt, va_list args)
2275{
2276 struct device *dev = NULL;
2277 int retval = -ENODEV;
2278
2279 if (class == NULL || IS_ERR(class))
2280 goto error;
2281
2282 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2283 if (!dev) {
2284 retval = -ENOMEM;
2285 goto error;
2286 }
2287
David Herrmannbbc780f2013-11-21 20:15:48 +01002288 device_initialize(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07002289 dev->devt = devt;
2290 dev->class = class;
2291 dev->parent = parent;
2292 dev->groups = groups;
2293 dev->release = device_create_release;
2294 dev_set_drvdata(dev, drvdata);
2295
2296 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
2297 if (retval)
2298 goto error;
2299
David Herrmannbbc780f2013-11-21 20:15:48 +01002300 retval = device_add(dev);
Guenter Roeck39ef3112013-07-14 16:05:57 -07002301 if (retval)
2302 goto error;
2303
2304 return dev;
2305
2306error:
2307 put_device(dev);
2308 return ERR_PTR(retval);
2309}
2310
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002311/**
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002312 * device_create_vargs - creates a device and registers it with sysfs
2313 * @class: pointer to the struct class that this device should be registered to
2314 * @parent: pointer to the parent struct device of this new device, if any
2315 * @devt: the dev_t for the char device to be added
2316 * @drvdata: the data to be added to the device for callbacks
2317 * @fmt: string for the device's name
2318 * @args: va_list for the device's name
2319 *
2320 * This function can be used by char device classes. A struct device
2321 * will be created in sysfs, registered to the specified class.
2322 *
2323 * A "dev" file will be created, showing the dev_t for the device, if
2324 * the dev_t is not 0,0.
2325 * If a pointer to a parent struct device is passed in, the newly created
2326 * struct device will be a child of that device in sysfs.
2327 * The pointer to the struct device will be returned from the call.
2328 * Any further sysfs files that might be required can be created using this
2329 * pointer.
2330 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002331 * Returns &struct device pointer on success, or ERR_PTR() on error.
2332 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002333 * Note: the struct class passed to this function must have previously
2334 * been created with a call to class_create().
2335 */
2336struct device *device_create_vargs(struct class *class, struct device *parent,
2337 dev_t devt, void *drvdata, const char *fmt,
2338 va_list args)
2339{
Guenter Roeck39ef3112013-07-14 16:05:57 -07002340 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
2341 fmt, args);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002342}
2343EXPORT_SYMBOL_GPL(device_create_vargs);
2344
2345/**
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002346 * device_create - creates a device and registers it with sysfs
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002347 * @class: pointer to the struct class that this device should be registered to
2348 * @parent: pointer to the parent struct device of this new device, if any
2349 * @devt: the dev_t for the char device to be added
2350 * @drvdata: the data to be added to the device for callbacks
2351 * @fmt: string for the device's name
2352 *
2353 * This function can be used by char device classes. A struct device
2354 * will be created in sysfs, registered to the specified class.
2355 *
2356 * A "dev" file will be created, showing the dev_t for the device, if
2357 * the dev_t is not 0,0.
2358 * If a pointer to a parent struct device is passed in, the newly created
2359 * struct device will be a child of that device in sysfs.
2360 * The pointer to the struct device will be returned from the call.
2361 * Any further sysfs files that might be required can be created using this
2362 * pointer.
2363 *
Jani Nikulaf0eae0e2010-03-11 18:11:45 +02002364 * Returns &struct device pointer on success, or ERR_PTR() on error.
2365 *
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002366 * Note: the struct class passed to this function must have previously
2367 * been created with a call to class_create().
2368 */
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002369struct device *device_create(struct class *class, struct device *parent,
2370 dev_t devt, void *drvdata, const char *fmt, ...)
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002371{
2372 va_list vargs;
2373 struct device *dev;
2374
2375 va_start(vargs, fmt);
2376 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
2377 va_end(vargs);
2378 return dev;
2379}
Greg Kroah-Hartman4e106732008-07-21 20:03:34 -07002380EXPORT_SYMBOL_GPL(device_create);
Greg Kroah-Hartman8882b392008-05-15 13:44:08 -07002381
Guenter Roeck39ef3112013-07-14 16:05:57 -07002382/**
2383 * device_create_with_groups - creates a device and registers it with sysfs
2384 * @class: pointer to the struct class that this device should be registered to
2385 * @parent: pointer to the parent struct device of this new device, if any
2386 * @devt: the dev_t for the char device to be added
2387 * @drvdata: the data to be added to the device for callbacks
2388 * @groups: NULL-terminated list of attribute groups to be created
2389 * @fmt: string for the device's name
2390 *
2391 * This function can be used by char device classes. A struct device
2392 * will be created in sysfs, registered to the specified class.
2393 * Additional attributes specified in the groups parameter will also
2394 * be created automatically.
2395 *
2396 * A "dev" file will be created, showing the dev_t for the device, if
2397 * the dev_t is not 0,0.
2398 * If a pointer to a parent struct device is passed in, the newly created
2399 * struct device will be a child of that device in sysfs.
2400 * The pointer to the struct device will be returned from the call.
2401 * Any further sysfs files that might be required can be created using this
2402 * pointer.
2403 *
2404 * Returns &struct device pointer on success, or ERR_PTR() on error.
2405 *
2406 * Note: the struct class passed to this function must have previously
2407 * been created with a call to class_create().
2408 */
2409struct device *device_create_with_groups(struct class *class,
2410 struct device *parent, dev_t devt,
2411 void *drvdata,
2412 const struct attribute_group **groups,
2413 const char *fmt, ...)
2414{
2415 va_list vargs;
2416 struct device *dev;
2417
2418 va_start(vargs, fmt);
2419 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
2420 fmt, vargs);
2421 va_end(vargs);
2422 return dev;
2423}
2424EXPORT_SYMBOL_GPL(device_create_with_groups);
2425
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002426static int __match_devt(struct device *dev, const void *data)
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002427{
Michał Mirosław9f3b7952013-02-01 20:40:17 +01002428 const dev_t *devt = data;
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002429
Dave Youngcd354492008-01-28 16:56:11 +08002430 return dev->devt == *devt;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01002431}
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002432
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +01002433/**
2434 * device_destroy - removes a device that was created with device_create()
2435 * @class: pointer to the struct class that this device was registered with
2436 * @devt: the dev_t of the device that was previously registered
2437 *
2438 * This call unregisters and cleans up a device that was created with a
2439 * call to device_create().
2440 */
2441void device_destroy(struct class *class, dev_t devt)
2442{
2443 struct device *dev;
2444
Greg Kroah-Hartman695794a2008-05-22 17:21:08 -04002445 dev = class_find_device(class, NULL, &devt, __match_devt);
Dave Youngcd354492008-01-28 16:56:11 +08002446 if (dev) {
2447 put_device(dev);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002448 device_unregister(dev);
Dave Youngcd354492008-01-28 16:56:11 +08002449 }
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -07002450}
2451EXPORT_SYMBOL_GPL(device_destroy);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002452
2453/**
2454 * device_rename - renames a device
2455 * @dev: the pointer to the struct device to be renamed
2456 * @new_name: the new name of the device
Eric W. Biederman030c1d22008-05-08 14:41:00 -07002457 *
2458 * It is the responsibility of the caller to provide mutual
2459 * exclusion between two different calls of device_rename
2460 * on the same device to ensure that new_name is valid and
2461 * won't conflict with other devices.
Michael Ellermanc6c0ac62010-11-25 09:44:07 +11002462 *
Timur Tabia5462512010-12-13 14:08:52 -06002463 * Note: Don't call this function. Currently, the networking layer calls this
2464 * function, but that will change. The following text from Kay Sievers offers
2465 * some insight:
2466 *
2467 * Renaming devices is racy at many levels, symlinks and other stuff are not
2468 * replaced atomically, and you get a "move" uevent, but it's not easy to
2469 * connect the event to the old and new device. Device nodes are not renamed at
2470 * all, there isn't even support for that in the kernel now.
2471 *
2472 * In the meantime, during renaming, your target name might be taken by another
2473 * driver, creating conflicts. Or the old name is taken directly after you
2474 * renamed it -- then you get events for the same DEVPATH, before you even see
2475 * the "move" event. It's just a mess, and nothing new should ever rely on
2476 * kernel device renaming. Besides that, it's not even implemented now for
2477 * other things than (driver-core wise very simple) network devices.
2478 *
2479 * We are currently about to change network renaming in udev to completely
2480 * disallow renaming of devices in the same namespace as the kernel uses,
2481 * because we can't solve the problems properly, that arise with swapping names
2482 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
2483 * be allowed to some other name than eth[0-9]*, for the aforementioned
2484 * reasons.
2485 *
2486 * Make up a "real" name in the driver before you register anything, or add
2487 * some other attributes for userspace to find the device, or use udev to add
2488 * symlinks -- but never rename kernel devices later, it's a complete mess. We
2489 * don't even want to get into that and try to implement the missing pieces in
2490 * the core. We really have other pieces to fix in the driver core mess. :)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002491 */
Johannes Berg6937e8f2010-08-05 17:38:18 +02002492int device_rename(struct device *dev, const char *new_name)
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002493{
Tejun Heo4b30ee52013-09-11 22:29:06 -04002494 struct kobject *kobj = &dev->kobj;
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002495 char *old_device_name = NULL;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002496 int error;
2497
2498 dev = get_device(dev);
2499 if (!dev)
2500 return -EINVAL;
2501
ethan.zhao69df7532013-10-13 22:12:35 +08002502 dev_dbg(dev, "renaming to %s\n", new_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002503
Kay Sievers1fa5ae82009-01-25 15:17:37 +01002504 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002505 if (!old_device_name) {
2506 error = -ENOMEM;
2507 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002508 }
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002509
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07002510 if (dev->class) {
Tejun Heo4b30ee52013-09-11 22:29:06 -04002511 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
2512 kobj, old_device_name,
2513 new_name, kobject_namespace(kobj));
Eric W. Biedermanf349cf32010-03-30 11:31:29 -07002514 if (error)
2515 goto out;
2516 }
Kay Sievers39aba962010-09-04 22:33:14 -07002517
Tejun Heo4b30ee52013-09-11 22:29:06 -04002518 error = kobject_rename(kobj, new_name);
Kay Sievers1fa5ae82009-01-25 15:17:37 +01002519 if (error)
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002520 goto out;
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002521
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002522out:
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002523 put_device(dev);
2524
Cornelia Huck2ee97ca2007-07-18 01:43:47 -07002525 kfree(old_device_name);
Greg Kroah-Hartmana2de48c2006-07-03 14:31:12 -07002526
2527 return error;
2528}
Johannes Berga2807db2007-02-28 12:38:31 +01002529EXPORT_SYMBOL_GPL(device_rename);
Cornelia Huck8a824722006-11-20 17:07:51 +01002530
2531static int device_move_class_links(struct device *dev,
2532 struct device *old_parent,
2533 struct device *new_parent)
2534{
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08002535 int error = 0;
Cornelia Huck8a824722006-11-20 17:07:51 +01002536
Greg Kroah-Hartmanf7f34612007-03-06 12:55:53 -08002537 if (old_parent)
2538 sysfs_remove_link(&dev->kobj, "device");
2539 if (new_parent)
2540 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
2541 "device");
2542 return error;
Cornelia Huck8a824722006-11-20 17:07:51 +01002543}
2544
2545/**
2546 * device_move - moves a device to a new parent
2547 * @dev: the pointer to the struct device to be moved
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002548 * @new_parent: the new parent of the device (can by NULL)
Cornelia Huckffa6a702009-03-04 12:44:00 +01002549 * @dpm_order: how to reorder the dpm_list
Cornelia Huck8a824722006-11-20 17:07:51 +01002550 */
Cornelia Huckffa6a702009-03-04 12:44:00 +01002551int device_move(struct device *dev, struct device *new_parent,
2552 enum dpm_order dpm_order)
Cornelia Huck8a824722006-11-20 17:07:51 +01002553{
2554 int error;
2555 struct device *old_parent;
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002556 struct kobject *new_parent_kobj;
Cornelia Huck8a824722006-11-20 17:07:51 +01002557
2558 dev = get_device(dev);
2559 if (!dev)
2560 return -EINVAL;
2561
Cornelia Huckffa6a702009-03-04 12:44:00 +01002562 device_pm_lock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002563 new_parent = get_device(new_parent);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -08002564 new_parent_kobj = get_device_parent(dev, new_parent);
Cornelia Huck63b69712008-01-21 16:09:44 +01002565
Kay Sievers1e0b2cf2008-10-30 01:36:48 +01002566 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
2567 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
Cornelia Huckc744aeae2007-01-08 20:16:44 +01002568 error = kobject_move(&dev->kobj, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01002569 if (error) {
Cornelia Huck63b69712008-01-21 16:09:44 +01002570 cleanup_glue_dir(dev, new_parent_kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +01002571 put_device(new_parent);
2572 goto out;
2573 }
2574 old_parent = dev->parent;
2575 dev->parent = new_parent;
2576 if (old_parent)
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002577 klist_remove(&dev->p->knode_parent);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002578 if (new_parent) {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -08002579 klist_add_tail(&dev->p->knode_parent,
2580 &new_parent->p->klist_children);
Yinghai Lu0d358f22008-02-19 03:20:41 -08002581 set_dev_node(dev, dev_to_node(new_parent));
2582 }
2583
Rabin Vincentbdd40342012-04-23 09:16:36 +02002584 if (dev->class) {
2585 error = device_move_class_links(dev, old_parent, new_parent);
2586 if (error) {
2587 /* We ignore errors on cleanup since we're hosed anyway... */
2588 device_move_class_links(dev, new_parent, old_parent);
2589 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
2590 if (new_parent)
2591 klist_remove(&dev->p->knode_parent);
2592 dev->parent = old_parent;
2593 if (old_parent) {
2594 klist_add_tail(&dev->p->knode_parent,
2595 &old_parent->p->klist_children);
2596 set_dev_node(dev, dev_to_node(old_parent));
2597 }
Yinghai Lu0d358f22008-02-19 03:20:41 -08002598 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002599 cleanup_glue_dir(dev, new_parent_kobj);
2600 put_device(new_parent);
2601 goto out;
Cornelia Huck8a824722006-11-20 17:07:51 +01002602 }
Cornelia Huck8a824722006-11-20 17:07:51 +01002603 }
Cornelia Huckffa6a702009-03-04 12:44:00 +01002604 switch (dpm_order) {
2605 case DPM_ORDER_NONE:
2606 break;
2607 case DPM_ORDER_DEV_AFTER_PARENT:
2608 device_pm_move_after(dev, new_parent);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002609 devices_kset_move_after(dev, new_parent);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002610 break;
2611 case DPM_ORDER_PARENT_BEFORE_DEV:
2612 device_pm_move_before(new_parent, dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002613 devices_kset_move_before(new_parent, dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002614 break;
2615 case DPM_ORDER_DEV_LAST:
2616 device_pm_move_last(dev);
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +03002617 devices_kset_move_last(dev);
Cornelia Huckffa6a702009-03-04 12:44:00 +01002618 break;
2619 }
Rabin Vincentbdd40342012-04-23 09:16:36 +02002620
Cornelia Huck8a824722006-11-20 17:07:51 +01002621 put_device(old_parent);
2622out:
Cornelia Huckffa6a702009-03-04 12:44:00 +01002623 device_pm_unlock();
Cornelia Huck8a824722006-11-20 17:07:51 +01002624 put_device(dev);
2625 return error;
2626}
Cornelia Huck8a824722006-11-20 17:07:51 +01002627EXPORT_SYMBOL_GPL(device_move);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002628
2629/**
2630 * device_shutdown - call ->shutdown() on each device to shutdown.
2631 */
2632void device_shutdown(void)
2633{
Benson Leungf123db82013-09-24 20:05:11 -07002634 struct device *dev, *parent;
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002635
Hugh Daschbach62458382010-03-22 10:36:37 -07002636 spin_lock(&devices_kset->list_lock);
2637 /*
2638 * Walk the devices list backward, shutting down each in turn.
2639 * Beware that device unplug events may also start pulling
2640 * devices offline, even as the system is shutting down.
2641 */
2642 while (!list_empty(&devices_kset->list)) {
2643 dev = list_entry(devices_kset->list.prev, struct device,
2644 kobj.entry);
Ming Leid1c6c032012-06-22 18:01:40 +08002645
2646 /*
2647 * hold reference count of device's parent to
2648 * prevent it from being freed because parent's
2649 * lock is to be held
2650 */
Benson Leungf123db82013-09-24 20:05:11 -07002651 parent = get_device(dev->parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002652 get_device(dev);
2653 /*
2654 * Make sure the device is off the kset list, in the
2655 * event that dev->*->shutdown() doesn't remove it.
2656 */
2657 list_del_init(&dev->kobj.entry);
2658 spin_unlock(&devices_kset->list_lock);
Alan Sternfe6b91f2011-12-06 23:24:52 +01002659
Ming Leid1c6c032012-06-22 18:01:40 +08002660 /* hold lock to avoid race with probe/release */
Benson Leungf123db82013-09-24 20:05:11 -07002661 if (parent)
2662 device_lock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002663 device_lock(dev);
2664
Alan Sternfe6b91f2011-12-06 23:24:52 +01002665 /* Don't allow any more runtime suspends */
2666 pm_runtime_get_noresume(dev);
2667 pm_runtime_barrier(dev);
Hugh Daschbach62458382010-03-22 10:36:37 -07002668
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002669 if (dev->bus && dev->bus->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002670 if (initcall_debug)
2671 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002672 dev->bus->shutdown(dev);
2673 } else if (dev->driver && dev->driver->shutdown) {
ShuoX Liu0246c4f2012-11-23 15:14:12 +08002674 if (initcall_debug)
2675 dev_info(dev, "shutdown\n");
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002676 dev->driver->shutdown(dev);
2677 }
Ming Leid1c6c032012-06-22 18:01:40 +08002678
2679 device_unlock(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002680 if (parent)
2681 device_unlock(parent);
Ming Leid1c6c032012-06-22 18:01:40 +08002682
Hugh Daschbach62458382010-03-22 10:36:37 -07002683 put_device(dev);
Benson Leungf123db82013-09-24 20:05:11 -07002684 put_device(parent);
Hugh Daschbach62458382010-03-22 10:36:37 -07002685
2686 spin_lock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002687 }
Hugh Daschbach62458382010-03-22 10:36:37 -07002688 spin_unlock(&devices_kset->list_lock);
Greg Kroah-Hartman37b0c022007-11-26 22:11:55 -08002689}
Joe Perches99bcf212010-06-27 01:02:34 +00002690
2691/*
2692 * Device logging functions
2693 */
2694
2695#ifdef CONFIG_PRINTK
Joe Perches666f3552012-09-12 20:14:11 -07002696static int
2697create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
Joe Perches99bcf212010-06-27 01:02:34 +00002698{
Kay Sieversc4e00da2012-05-03 02:29:59 +02002699 const char *subsys;
Joe Perches798efc62012-09-12 20:11:29 -07002700 size_t pos = 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002701
Kay Sieversc4e00da2012-05-03 02:29:59 +02002702 if (dev->class)
2703 subsys = dev->class->name;
2704 else if (dev->bus)
2705 subsys = dev->bus->name;
2706 else
Joe Perches798efc62012-09-12 20:11:29 -07002707 return 0;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002708
Joe Perches798efc62012-09-12 20:11:29 -07002709 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
Ben Hutchings655e5b72014-08-26 00:34:44 -07002710 if (pos >= hdrlen)
2711 goto overflow;
Kay Sieversc4e00da2012-05-03 02:29:59 +02002712
2713 /*
2714 * Add device identifier DEVICE=:
2715 * b12:8 block dev_t
2716 * c127:3 char dev_t
2717 * n8 netdev ifindex
2718 * +sound:card0 subsystem:devname
2719 */
2720 if (MAJOR(dev->devt)) {
2721 char c;
2722
2723 if (strcmp(subsys, "block") == 0)
2724 c = 'b';
2725 else
2726 c = 'c';
Joe Perches798efc62012-09-12 20:11:29 -07002727 pos++;
2728 pos += snprintf(hdr + pos, hdrlen - pos,
2729 "DEVICE=%c%u:%u",
2730 c, MAJOR(dev->devt), MINOR(dev->devt));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002731 } else if (strcmp(subsys, "net") == 0) {
2732 struct net_device *net = to_net_dev(dev);
2733
Joe Perches798efc62012-09-12 20:11:29 -07002734 pos++;
2735 pos += snprintf(hdr + pos, hdrlen - pos,
2736 "DEVICE=n%u", net->ifindex);
Kay Sieversc4e00da2012-05-03 02:29:59 +02002737 } else {
Joe Perches798efc62012-09-12 20:11:29 -07002738 pos++;
2739 pos += snprintf(hdr + pos, hdrlen - pos,
2740 "DEVICE=+%s:%s", subsys, dev_name(dev));
Kay Sieversc4e00da2012-05-03 02:29:59 +02002741 }
Jim Cromieaf7f2152012-07-19 13:46:21 -06002742
Ben Hutchings655e5b72014-08-26 00:34:44 -07002743 if (pos >= hdrlen)
2744 goto overflow;
2745
Joe Perches798efc62012-09-12 20:11:29 -07002746 return pos;
Ben Hutchings655e5b72014-08-26 00:34:44 -07002747
2748overflow:
2749 dev_WARN(dev, "device/subsystem name too long");
2750 return 0;
Joe Perches99bcf212010-06-27 01:02:34 +00002751}
Joe Perches798efc62012-09-12 20:11:29 -07002752
Joe Perches05e4e5b2012-09-12 20:13:37 -07002753int dev_vprintk_emit(int level, const struct device *dev,
2754 const char *fmt, va_list args)
2755{
2756 char hdr[128];
2757 size_t hdrlen;
2758
2759 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2760
2761 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2762}
2763EXPORT_SYMBOL(dev_vprintk_emit);
2764
2765int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2766{
2767 va_list args;
2768 int r;
2769
2770 va_start(args, fmt);
2771
2772 r = dev_vprintk_emit(level, dev, fmt, args);
2773
2774 va_end(args);
2775
2776 return r;
2777}
2778EXPORT_SYMBOL(dev_printk_emit);
2779
Joe Perchesd1f10522014-12-25 15:07:04 -08002780static void __dev_printk(const char *level, const struct device *dev,
Joe Perches798efc62012-09-12 20:11:29 -07002781 struct va_format *vaf)
2782{
Joe Perchesd1f10522014-12-25 15:07:04 -08002783 if (dev)
2784 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2785 dev_driver_string(dev), dev_name(dev), vaf);
2786 else
2787 printk("%s(NULL device *): %pV", level, vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002788}
Joe Perches99bcf212010-06-27 01:02:34 +00002789
Joe Perchesd1f10522014-12-25 15:07:04 -08002790void dev_printk(const char *level, const struct device *dev,
2791 const char *fmt, ...)
Joe Perches99bcf212010-06-27 01:02:34 +00002792{
2793 struct va_format vaf;
2794 va_list args;
Joe Perches99bcf212010-06-27 01:02:34 +00002795
2796 va_start(args, fmt);
2797
2798 vaf.fmt = fmt;
2799 vaf.va = &args;
2800
Joe Perchesd1f10522014-12-25 15:07:04 -08002801 __dev_printk(level, dev, &vaf);
Joe Perches798efc62012-09-12 20:11:29 -07002802
Joe Perches99bcf212010-06-27 01:02:34 +00002803 va_end(args);
Joe Perches99bcf212010-06-27 01:02:34 +00002804}
2805EXPORT_SYMBOL(dev_printk);
2806
2807#define define_dev_printk_level(func, kern_level) \
Joe Perchesd1f10522014-12-25 15:07:04 -08002808void func(const struct device *dev, const char *fmt, ...) \
Joe Perches99bcf212010-06-27 01:02:34 +00002809{ \
2810 struct va_format vaf; \
2811 va_list args; \
Joe Perches99bcf212010-06-27 01:02:34 +00002812 \
2813 va_start(args, fmt); \
2814 \
2815 vaf.fmt = fmt; \
2816 vaf.va = &args; \
2817 \
Joe Perchesd1f10522014-12-25 15:07:04 -08002818 __dev_printk(kern_level, dev, &vaf); \
Joe Perches798efc62012-09-12 20:11:29 -07002819 \
Joe Perches99bcf212010-06-27 01:02:34 +00002820 va_end(args); \
Joe Perches99bcf212010-06-27 01:02:34 +00002821} \
2822EXPORT_SYMBOL(func);
2823
2824define_dev_printk_level(dev_emerg, KERN_EMERG);
2825define_dev_printk_level(dev_alert, KERN_ALERT);
2826define_dev_printk_level(dev_crit, KERN_CRIT);
2827define_dev_printk_level(dev_err, KERN_ERR);
2828define_dev_printk_level(dev_warn, KERN_WARNING);
2829define_dev_printk_level(dev_notice, KERN_NOTICE);
2830define_dev_printk_level(_dev_info, KERN_INFO);
2831
2832#endif
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002833
2834static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2835{
2836 return fwnode && !IS_ERR(fwnode->secondary);
2837}
2838
2839/**
2840 * set_primary_fwnode - Change the primary firmware node of a given device.
2841 * @dev: Device to handle.
2842 * @fwnode: New primary firmware node of the device.
2843 *
2844 * Set the device's firmware node pointer to @fwnode, but if a secondary
2845 * firmware node of the device is present, preserve it.
2846 */
2847void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2848{
2849 if (fwnode) {
2850 struct fwnode_handle *fn = dev->fwnode;
2851
2852 if (fwnode_is_primary(fn))
2853 fn = fn->secondary;
2854
Mika Westerberg55f89a82015-11-30 17:11:39 +02002855 if (fn) {
2856 WARN_ON(fwnode->secondary);
2857 fwnode->secondary = fn;
2858 }
Rafael J. Wysocki97badf82015-04-03 23:23:37 +02002859 dev->fwnode = fwnode;
2860 } else {
2861 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2862 dev->fwnode->secondary : NULL;
2863 }
2864}
2865EXPORT_SYMBOL_GPL(set_primary_fwnode);
2866
2867/**
2868 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2869 * @dev: Device to handle.
2870 * @fwnode: New secondary firmware node of the device.
2871 *
2872 * If a primary firmware node of the device is present, set its secondary
2873 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2874 * @fwnode.
2875 */
2876void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2877{
2878 if (fwnode)
2879 fwnode->secondary = ERR_PTR(-ENODEV);
2880
2881 if (fwnode_is_primary(dev->fwnode))
2882 dev->fwnode->secondary = fwnode;
2883 else
2884 dev->fwnode = fwnode;
2885}