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