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