xref: /linux/drivers/base/core.c (revision 8b4a40809e5330c9da5d20107d693d92d73b31dc)
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 
22 #include <asm/semaphore.h>
23 
24 #include "base.h"
25 #include "power/power.h"
26 
27 int (*platform_notify)(struct device * dev) = NULL;
28 int (*platform_notify_remove)(struct device * dev) = NULL;
29 
30 /*
31  * sysfs bindings for devices.
32  */
33 
34 /**
35  * dev_driver_string - Return a device's driver name, if at all possible
36  * @dev: struct device to get the name of
37  *
38  * Will return the device's driver's name if it is bound to a device.  If
39  * the device is not bound to a device, it will return the name of the bus
40  * it is attached to.  If it is not attached to a bus either, an empty
41  * string will be returned.
42  */
43 const char *dev_driver_string(struct device *dev)
44 {
45 	return dev->driver ? dev->driver->name :
46 			(dev->bus ? dev->bus->name :
47 			(dev->class ? dev->class->name : ""));
48 }
49 EXPORT_SYMBOL(dev_driver_string);
50 
51 #define to_dev(obj) container_of(obj, struct device, kobj)
52 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
53 
54 static ssize_t
55 dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
56 {
57 	struct device_attribute * dev_attr = to_dev_attr(attr);
58 	struct device * dev = to_dev(kobj);
59 	ssize_t ret = -EIO;
60 
61 	if (dev_attr->show)
62 		ret = dev_attr->show(dev, dev_attr, buf);
63 	return ret;
64 }
65 
66 static ssize_t
67 dev_attr_store(struct kobject * kobj, struct attribute * attr,
68 	       const char * buf, size_t count)
69 {
70 	struct device_attribute * dev_attr = to_dev_attr(attr);
71 	struct device * dev = to_dev(kobj);
72 	ssize_t ret = -EIO;
73 
74 	if (dev_attr->store)
75 		ret = dev_attr->store(dev, dev_attr, buf, count);
76 	return ret;
77 }
78 
79 static struct sysfs_ops dev_sysfs_ops = {
80 	.show	= dev_attr_show,
81 	.store	= dev_attr_store,
82 };
83 
84 
85 /**
86  *	device_release - free device structure.
87  *	@kobj:	device's kobject.
88  *
89  *	This is called once the reference count for the object
90  *	reaches 0. We forward the call to the device's release
91  *	method, which should handle actually freeing the structure.
92  */
93 static void device_release(struct kobject * kobj)
94 {
95 	struct device * dev = to_dev(kobj);
96 
97 	if (dev->release)
98 		dev->release(dev);
99 	else if (dev->type && dev->type->release)
100 		dev->type->release(dev);
101 	else if (dev->class && dev->class->dev_release)
102 		dev->class->dev_release(dev);
103 	else {
104 		printk(KERN_ERR "Device '%s' does not have a release() function, "
105 			"it is broken and must be fixed.\n",
106 			dev->bus_id);
107 		WARN_ON(1);
108 	}
109 }
110 
111 static struct kobj_type ktype_device = {
112 	.release	= device_release,
113 	.sysfs_ops	= &dev_sysfs_ops,
114 };
115 
116 
117 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
118 {
119 	struct kobj_type *ktype = get_ktype(kobj);
120 
121 	if (ktype == &ktype_device) {
122 		struct device *dev = to_dev(kobj);
123 		if (dev->uevent_suppress)
124 			return 0;
125 		if (dev->bus)
126 			return 1;
127 		if (dev->class)
128 			return 1;
129 	}
130 	return 0;
131 }
132 
133 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
134 {
135 	struct device *dev = to_dev(kobj);
136 
137 	if (dev->bus)
138 		return dev->bus->name;
139 	if (dev->class)
140 		return dev->class->name;
141 	return NULL;
142 }
143 
144 static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
145 			int num_envp, char *buffer, int buffer_size)
146 {
147 	struct device *dev = to_dev(kobj);
148 	int i = 0;
149 	int length = 0;
150 	int retval = 0;
151 
152 	/* add the major/minor if present */
153 	if (MAJOR(dev->devt)) {
154 		add_uevent_var(envp, num_envp, &i,
155 			       buffer, buffer_size, &length,
156 			       "MAJOR=%u", MAJOR(dev->devt));
157 		add_uevent_var(envp, num_envp, &i,
158 			       buffer, buffer_size, &length,
159 			       "MINOR=%u", MINOR(dev->devt));
160 	}
161 
162 	if (dev->type && dev->type->name)
163 		add_uevent_var(envp, num_envp, &i,
164 			       buffer, buffer_size, &length,
165 			       "DEVTYPE=%s", dev->type->name);
166 
167 	if (dev->driver)
168 		add_uevent_var(envp, num_envp, &i,
169 			       buffer, buffer_size, &length,
170 			       "DRIVER=%s", dev->driver->name);
171 
172 #ifdef CONFIG_SYSFS_DEPRECATED
173 	if (dev->class) {
174 		struct device *parent = dev->parent;
175 
176 		/* find first bus device in parent chain */
177 		while (parent && !parent->bus)
178 			parent = parent->parent;
179 		if (parent && parent->bus) {
180 			const char *path;
181 
182 			path = kobject_get_path(&parent->kobj, GFP_KERNEL);
183 			if (path) {
184 				add_uevent_var(envp, num_envp, &i,
185 					       buffer, buffer_size, &length,
186 					       "PHYSDEVPATH=%s", path);
187 				kfree(path);
188 			}
189 
190 			add_uevent_var(envp, num_envp, &i,
191 				       buffer, buffer_size, &length,
192 				       "PHYSDEVBUS=%s", parent->bus->name);
193 
194 			if (parent->driver)
195 				add_uevent_var(envp, num_envp, &i,
196 					       buffer, buffer_size, &length,
197 					       "PHYSDEVDRIVER=%s", parent->driver->name);
198 		}
199 	} else if (dev->bus) {
200 		add_uevent_var(envp, num_envp, &i,
201 			       buffer, buffer_size, &length,
202 			       "PHYSDEVBUS=%s", dev->bus->name);
203 
204 		if (dev->driver)
205 			add_uevent_var(envp, num_envp, &i,
206 				       buffer, buffer_size, &length,
207 				       "PHYSDEVDRIVER=%s", dev->driver->name);
208 	}
209 #endif
210 
211 	/* terminate, set to next free slot, shrink available space */
212 	envp[i] = NULL;
213 	envp = &envp[i];
214 	num_envp -= i;
215 	buffer = &buffer[length];
216 	buffer_size -= length;
217 
218 	if (dev->bus && dev->bus->uevent) {
219 		/* have the bus specific function add its stuff */
220 		retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
221 		if (retval)
222 			pr_debug ("%s: bus uevent() returned %d\n",
223 				  __FUNCTION__, retval);
224 	}
225 
226 	if (dev->class && dev->class->dev_uevent) {
227 		/* have the class specific function add its stuff */
228 		retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
229 		if (retval)
230 			pr_debug("%s: class uevent() returned %d\n",
231 				 __FUNCTION__, retval);
232 	}
233 
234 	if (dev->type && dev->type->uevent) {
235 		/* have the device type specific fuction add its stuff */
236 		retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
237 		if (retval)
238 			pr_debug("%s: dev_type uevent() returned %d\n",
239 				 __FUNCTION__, retval);
240 	}
241 
242 	return retval;
243 }
244 
245 static struct kset_uevent_ops device_uevent_ops = {
246 	.filter =	dev_uevent_filter,
247 	.name =		dev_uevent_name,
248 	.uevent =	dev_uevent,
249 };
250 
251 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
252 			   char *buf)
253 {
254 	struct kobject *top_kobj;
255 	struct kset *kset;
256 	char *envp[32];
257 	char *data = NULL;
258 	char *pos;
259 	int i;
260 	size_t count = 0;
261 	int retval;
262 
263 	/* search the kset, the device belongs to */
264 	top_kobj = &dev->kobj;
265 	if (!top_kobj->kset && top_kobj->parent) {
266 		do {
267 			top_kobj = top_kobj->parent;
268 		} while (!top_kobj->kset && top_kobj->parent);
269 	}
270 	if (!top_kobj->kset)
271 		goto out;
272 	kset = top_kobj->kset;
273 	if (!kset->uevent_ops || !kset->uevent_ops->uevent)
274 		goto out;
275 
276 	/* respect filter */
277 	if (kset->uevent_ops && kset->uevent_ops->filter)
278 		if (!kset->uevent_ops->filter(kset, &dev->kobj))
279 			goto out;
280 
281 	data = (char *)get_zeroed_page(GFP_KERNEL);
282 	if (!data)
283 		return -ENOMEM;
284 
285 	/* let the kset specific function add its keys */
286 	pos = data;
287 	retval = kset->uevent_ops->uevent(kset, &dev->kobj,
288 					  envp, ARRAY_SIZE(envp),
289 					  pos, PAGE_SIZE);
290 	if (retval)
291 		goto out;
292 
293 	/* copy keys to file */
294 	for (i = 0; envp[i]; i++) {
295 		pos = &buf[count];
296 		count += sprintf(pos, "%s\n", envp[i]);
297 	}
298 out:
299 	free_page((unsigned long)data);
300 	return count;
301 }
302 
303 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
304 			    const char *buf, size_t count)
305 {
306 	if (memcmp(buf, "add", 3) != 0)
307 		dev_err(dev, "uevent: unsupported action-string; this will "
308 			"be ignored in a future kernel version");
309 	kobject_uevent(&dev->kobj, KOBJ_ADD);
310 	return count;
311 }
312 
313 static struct device_attribute uevent_attr =
314 	__ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
315 
316 static int device_add_attributes(struct device *dev,
317 				 struct device_attribute *attrs)
318 {
319 	int error = 0;
320 	int i;
321 
322 	if (attrs) {
323 		for (i = 0; attr_name(attrs[i]); i++) {
324 			error = device_create_file(dev, &attrs[i]);
325 			if (error)
326 				break;
327 		}
328 		if (error)
329 			while (--i >= 0)
330 				device_remove_file(dev, &attrs[i]);
331 	}
332 	return error;
333 }
334 
335 static void device_remove_attributes(struct device *dev,
336 				     struct device_attribute *attrs)
337 {
338 	int i;
339 
340 	if (attrs)
341 		for (i = 0; attr_name(attrs[i]); i++)
342 			device_remove_file(dev, &attrs[i]);
343 }
344 
345 static int device_add_groups(struct device *dev,
346 			     struct attribute_group **groups)
347 {
348 	int error = 0;
349 	int i;
350 
351 	if (groups) {
352 		for (i = 0; groups[i]; i++) {
353 			error = sysfs_create_group(&dev->kobj, groups[i]);
354 			if (error) {
355 				while (--i >= 0)
356 					sysfs_remove_group(&dev->kobj, groups[i]);
357 				break;
358 			}
359 		}
360 	}
361 	return error;
362 }
363 
364 static void device_remove_groups(struct device *dev,
365 				 struct attribute_group **groups)
366 {
367 	int i;
368 
369 	if (groups)
370 		for (i = 0; groups[i]; i++)
371 			sysfs_remove_group(&dev->kobj, groups[i]);
372 }
373 
374 static int device_add_attrs(struct device *dev)
375 {
376 	struct class *class = dev->class;
377 	struct device_type *type = dev->type;
378 	int error;
379 
380 	if (class) {
381 		error = device_add_attributes(dev, class->dev_attrs);
382 		if (error)
383 			return error;
384 	}
385 
386 	if (type) {
387 		error = device_add_groups(dev, type->groups);
388 		if (error)
389 			goto err_remove_class_attrs;
390 	}
391 
392 	error = device_add_groups(dev, dev->groups);
393 	if (error)
394 		goto err_remove_type_groups;
395 
396 	return 0;
397 
398  err_remove_type_groups:
399 	if (type)
400 		device_remove_groups(dev, type->groups);
401  err_remove_class_attrs:
402 	if (class)
403 		device_remove_attributes(dev, class->dev_attrs);
404 
405 	return error;
406 }
407 
408 static void device_remove_attrs(struct device *dev)
409 {
410 	struct class *class = dev->class;
411 	struct device_type *type = dev->type;
412 
413 	device_remove_groups(dev, dev->groups);
414 
415 	if (type)
416 		device_remove_groups(dev, type->groups);
417 
418 	if (class)
419 		device_remove_attributes(dev, class->dev_attrs);
420 }
421 
422 
423 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
424 			char *buf)
425 {
426 	return print_dev_t(buf, dev->devt);
427 }
428 
429 static struct device_attribute devt_attr =
430 	__ATTR(dev, S_IRUGO, show_dev, NULL);
431 
432 /*
433  *	devices_subsys - structure to be registered with kobject core.
434  */
435 
436 decl_subsys(devices, &ktype_device, &device_uevent_ops);
437 
438 
439 /**
440  *	device_create_file - create sysfs attribute file for device.
441  *	@dev:	device.
442  *	@attr:	device attribute descriptor.
443  */
444 
445 int device_create_file(struct device * dev, struct device_attribute * attr)
446 {
447 	int error = 0;
448 	if (get_device(dev)) {
449 		error = sysfs_create_file(&dev->kobj, &attr->attr);
450 		put_device(dev);
451 	}
452 	return error;
453 }
454 
455 /**
456  *	device_remove_file - remove sysfs attribute file.
457  *	@dev:	device.
458  *	@attr:	device attribute descriptor.
459  */
460 
461 void device_remove_file(struct device * dev, struct device_attribute * attr)
462 {
463 	if (get_device(dev)) {
464 		sysfs_remove_file(&dev->kobj, &attr->attr);
465 		put_device(dev);
466 	}
467 }
468 
469 /**
470  * device_create_bin_file - create sysfs binary attribute file for device.
471  * @dev: device.
472  * @attr: device binary attribute descriptor.
473  */
474 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
475 {
476 	int error = -EINVAL;
477 	if (dev)
478 		error = sysfs_create_bin_file(&dev->kobj, attr);
479 	return error;
480 }
481 EXPORT_SYMBOL_GPL(device_create_bin_file);
482 
483 /**
484  * device_remove_bin_file - remove sysfs binary attribute file
485  * @dev: device.
486  * @attr: device binary attribute descriptor.
487  */
488 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
489 {
490 	if (dev)
491 		sysfs_remove_bin_file(&dev->kobj, attr);
492 }
493 EXPORT_SYMBOL_GPL(device_remove_bin_file);
494 
495 /**
496  * device_schedule_callback_owner - helper to schedule a callback for a device
497  * @dev: device.
498  * @func: callback function to invoke later.
499  * @owner: module owning the callback routine
500  *
501  * Attribute methods must not unregister themselves or their parent device
502  * (which would amount to the same thing).  Attempts to do so will deadlock,
503  * since unregistration is mutually exclusive with driver callbacks.
504  *
505  * Instead methods can call this routine, which will attempt to allocate
506  * and schedule a workqueue request to call back @func with @dev as its
507  * argument in the workqueue's process context.  @dev will be pinned until
508  * @func returns.
509  *
510  * This routine is usually called via the inline device_schedule_callback(),
511  * which automatically sets @owner to THIS_MODULE.
512  *
513  * Returns 0 if the request was submitted, -ENOMEM if storage could not
514  * be allocated, -ENODEV if a reference to @owner isn't available.
515  *
516  * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
517  * underlying sysfs routine (since it is intended for use by attribute
518  * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
519  */
520 int device_schedule_callback_owner(struct device *dev,
521 		void (*func)(struct device *), struct module *owner)
522 {
523 	return sysfs_schedule_callback(&dev->kobj,
524 			(void (*)(void *)) func, dev, owner);
525 }
526 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
527 
528 static void klist_children_get(struct klist_node *n)
529 {
530 	struct device *dev = container_of(n, struct device, knode_parent);
531 
532 	get_device(dev);
533 }
534 
535 static void klist_children_put(struct klist_node *n)
536 {
537 	struct device *dev = container_of(n, struct device, knode_parent);
538 
539 	put_device(dev);
540 }
541 
542 
543 /**
544  *	device_initialize - init device structure.
545  *	@dev:	device.
546  *
547  *	This prepares the device for use by other layers,
548  *	including adding it to the device hierarchy.
549  *	It is the first half of device_register(), if called by
550  *	that, though it can also be called separately, so one
551  *	may use @dev's fields (e.g. the refcount).
552  */
553 
554 void device_initialize(struct device *dev)
555 {
556 	kobj_set_kset_s(dev, devices_subsys);
557 	kobject_init(&dev->kobj);
558 	klist_init(&dev->klist_children, klist_children_get,
559 		   klist_children_put);
560 	INIT_LIST_HEAD(&dev->dma_pools);
561 	INIT_LIST_HEAD(&dev->node);
562 	init_MUTEX(&dev->sem);
563 	spin_lock_init(&dev->devres_lock);
564 	INIT_LIST_HEAD(&dev->devres_head);
565 	device_init_wakeup(dev, 0);
566 	set_dev_node(dev, -1);
567 }
568 
569 #ifdef CONFIG_SYSFS_DEPRECATED
570 static struct kobject * get_device_parent(struct device *dev,
571 					  struct device *parent)
572 {
573 	/* Set the parent to the class, not the parent device */
574 	/* this keeps sysfs from having a symlink to make old udevs happy */
575 	if (dev->class)
576 		return &dev->class->subsys.kobj;
577 	else if (parent)
578 		return &parent->kobj;
579 
580 	return NULL;
581 }
582 #else
583 static struct kobject *virtual_device_parent(struct device *dev)
584 {
585 	static struct kobject *virtual_dir = NULL;
586 
587 	if (!virtual_dir)
588 		virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
589 
590 	return virtual_dir;
591 }
592 
593 static struct kobject * get_device_parent(struct device *dev,
594 					  struct device *parent)
595 {
596 	if (dev->class) {
597 		struct kobject *kobj = NULL;
598 		struct kobject *parent_kobj;
599 		struct kobject *k;
600 
601 		/*
602 		 * If we have no parent, we live in "virtual".
603 		 * Class-devices with a bus-device as parent, live
604 		 * in a class-directory to prevent namespace collisions.
605 		 */
606 		if (parent == NULL)
607 			parent_kobj = virtual_device_parent(dev);
608 		else if (parent->class)
609 			return &parent->kobj;
610 		else
611 			parent_kobj = &parent->kobj;
612 
613 		/* find our class-directory at the parent and reference it */
614 		spin_lock(&dev->class->class_dirs.list_lock);
615 		list_for_each_entry(k, &dev->class->class_dirs.list, entry)
616 			if (k->parent == parent_kobj) {
617 				kobj = kobject_get(k);
618 				break;
619 			}
620 		spin_unlock(&dev->class->class_dirs.list_lock);
621 		if (kobj)
622 			return kobj;
623 
624 		/* or create a new class-directory at the parent device */
625 		return kobject_kset_add_dir(&dev->class->class_dirs,
626 					    parent_kobj, dev->class->name);
627 	}
628 
629 	if (parent)
630 		return &parent->kobj;
631 	return NULL;
632 }
633 #endif
634 
635 static int setup_parent(struct device *dev, struct device *parent)
636 {
637 	struct kobject *kobj;
638 	kobj = get_device_parent(dev, parent);
639 	if (IS_ERR(kobj))
640 		return PTR_ERR(kobj);
641 	if (kobj)
642 		dev->kobj.parent = kobj;
643 	return 0;
644 }
645 
646 /**
647  *	device_add - add device to device hierarchy.
648  *	@dev:	device.
649  *
650  *	This is part 2 of device_register(), though may be called
651  *	separately _iff_ device_initialize() has been called separately.
652  *
653  *	This adds it to the kobject hierarchy via kobject_add(), adds it
654  *	to the global and sibling lists for the device, then
655  *	adds it to the other relevant subsystems of the driver model.
656  */
657 int device_add(struct device *dev)
658 {
659 	struct device *parent = NULL;
660 	char *class_name = NULL;
661 	struct class_interface *class_intf;
662 	int error = -EINVAL;
663 
664 	dev = get_device(dev);
665 	if (!dev || !strlen(dev->bus_id))
666 		goto Error;
667 
668 	pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
669 
670 	parent = get_device(dev->parent);
671 	error = setup_parent(dev, parent);
672 	if (error)
673 		goto Error;
674 
675 	/* first, register with generic layer. */
676 	kobject_set_name(&dev->kobj, "%s", dev->bus_id);
677 	error = kobject_add(&dev->kobj);
678 	if (error)
679 		goto Error;
680 
681 	/* notify platform of device entry */
682 	if (platform_notify)
683 		platform_notify(dev);
684 
685 	/* notify clients of device entry (new way) */
686 	if (dev->bus)
687 		blocking_notifier_call_chain(&dev->bus->bus_notifier,
688 					     BUS_NOTIFY_ADD_DEVICE, dev);
689 
690 	error = device_create_file(dev, &uevent_attr);
691 	if (error)
692 		goto attrError;
693 
694 	if (MAJOR(dev->devt)) {
695 		error = device_create_file(dev, &devt_attr);
696 		if (error)
697 			goto ueventattrError;
698 	}
699 
700 	if (dev->class) {
701 		sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
702 				  "subsystem");
703 		/* If this is not a "fake" compatible device, then create the
704 		 * symlink from the class to the device. */
705 		if (dev->kobj.parent != &dev->class->subsys.kobj)
706 			sysfs_create_link(&dev->class->subsys.kobj,
707 					  &dev->kobj, dev->bus_id);
708 		if (parent) {
709 			sysfs_create_link(&dev->kobj, &dev->parent->kobj,
710 							"device");
711 #ifdef CONFIG_SYSFS_DEPRECATED
712 			class_name = make_class_name(dev->class->name,
713 							&dev->kobj);
714 			if (class_name)
715 				sysfs_create_link(&dev->parent->kobj,
716 						  &dev->kobj, class_name);
717 #endif
718 		}
719 	}
720 
721 	error = device_add_attrs(dev);
722 	if (error)
723 		goto AttrsError;
724 	error = device_pm_add(dev);
725 	if (error)
726 		goto PMError;
727 	error = bus_add_device(dev);
728 	if (error)
729 		goto BusError;
730 	kobject_uevent(&dev->kobj, KOBJ_ADD);
731 	bus_attach_device(dev);
732 	if (parent)
733 		klist_add_tail(&dev->knode_parent, &parent->klist_children);
734 
735 	if (dev->class) {
736 		down(&dev->class->sem);
737 		/* tie the class to the device */
738 		list_add_tail(&dev->node, &dev->class->devices);
739 
740 		/* notify any interfaces that the device is here */
741 		list_for_each_entry(class_intf, &dev->class->interfaces, node)
742 			if (class_intf->add_dev)
743 				class_intf->add_dev(dev, class_intf);
744 		up(&dev->class->sem);
745 	}
746  Done:
747 	kfree(class_name);
748 	put_device(dev);
749 	return error;
750  BusError:
751 	device_pm_remove(dev);
752  PMError:
753 	if (dev->bus)
754 		blocking_notifier_call_chain(&dev->bus->bus_notifier,
755 					     BUS_NOTIFY_DEL_DEVICE, dev);
756 	device_remove_attrs(dev);
757  AttrsError:
758 	if (MAJOR(dev->devt))
759 		device_remove_file(dev, &devt_attr);
760 
761 	if (dev->class) {
762 		sysfs_remove_link(&dev->kobj, "subsystem");
763 		/* If this is not a "fake" compatible device, remove the
764 		 * symlink from the class to the device. */
765 		if (dev->kobj.parent != &dev->class->subsys.kobj)
766 			sysfs_remove_link(&dev->class->subsys.kobj,
767 					  dev->bus_id);
768 		if (parent) {
769 #ifdef CONFIG_SYSFS_DEPRECATED
770 			char *class_name = make_class_name(dev->class->name,
771 							   &dev->kobj);
772 			if (class_name)
773 				sysfs_remove_link(&dev->parent->kobj,
774 						  class_name);
775 			kfree(class_name);
776 #endif
777 			sysfs_remove_link(&dev->kobj, "device");
778 		}
779 	}
780  ueventattrError:
781 	device_remove_file(dev, &uevent_attr);
782  attrError:
783 	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
784 	kobject_del(&dev->kobj);
785  Error:
786 	if (parent)
787 		put_device(parent);
788 	goto Done;
789 }
790 
791 
792 /**
793  *	device_register - register a device with the system.
794  *	@dev:	pointer to the device structure
795  *
796  *	This happens in two clean steps - initialize the device
797  *	and add it to the system. The two steps can be called
798  *	separately, but this is the easiest and most common.
799  *	I.e. you should only call the two helpers separately if
800  *	have a clearly defined need to use and refcount the device
801  *	before it is added to the hierarchy.
802  */
803 
804 int device_register(struct device *dev)
805 {
806 	device_initialize(dev);
807 	return device_add(dev);
808 }
809 
810 
811 /**
812  *	get_device - increment reference count for device.
813  *	@dev:	device.
814  *
815  *	This simply forwards the call to kobject_get(), though
816  *	we do take care to provide for the case that we get a NULL
817  *	pointer passed in.
818  */
819 
820 struct device * get_device(struct device * dev)
821 {
822 	return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
823 }
824 
825 
826 /**
827  *	put_device - decrement reference count.
828  *	@dev:	device in question.
829  */
830 void put_device(struct device * dev)
831 {
832 	if (dev)
833 		kobject_put(&dev->kobj);
834 }
835 
836 
837 /**
838  *	device_del - delete device from system.
839  *	@dev:	device.
840  *
841  *	This is the first part of the device unregistration
842  *	sequence. This removes the device from the lists we control
843  *	from here, has it removed from the other driver model
844  *	subsystems it was added to in device_add(), and removes it
845  *	from the kobject hierarchy.
846  *
847  *	NOTE: this should be called manually _iff_ device_add() was
848  *	also called manually.
849  */
850 
851 void device_del(struct device * dev)
852 {
853 	struct device * parent = dev->parent;
854 	struct class_interface *class_intf;
855 
856 	if (parent)
857 		klist_del(&dev->knode_parent);
858 	if (MAJOR(dev->devt))
859 		device_remove_file(dev, &devt_attr);
860 	if (dev->class) {
861 		sysfs_remove_link(&dev->kobj, "subsystem");
862 		/* If this is not a "fake" compatible device, remove the
863 		 * symlink from the class to the device. */
864 		if (dev->kobj.parent != &dev->class->subsys.kobj)
865 			sysfs_remove_link(&dev->class->subsys.kobj,
866 					  dev->bus_id);
867 		if (parent) {
868 #ifdef CONFIG_SYSFS_DEPRECATED
869 			char *class_name = make_class_name(dev->class->name,
870 							   &dev->kobj);
871 			if (class_name)
872 				sysfs_remove_link(&dev->parent->kobj,
873 						  class_name);
874 			kfree(class_name);
875 #endif
876 			sysfs_remove_link(&dev->kobj, "device");
877 		}
878 
879 		down(&dev->class->sem);
880 		/* notify any interfaces that the device is now gone */
881 		list_for_each_entry(class_intf, &dev->class->interfaces, node)
882 			if (class_intf->remove_dev)
883 				class_intf->remove_dev(dev, class_intf);
884 		/* remove the device from the class list */
885 		list_del_init(&dev->node);
886 		up(&dev->class->sem);
887 
888 		/* If we live in a parent class-directory, unreference it */
889 		if (dev->kobj.parent->kset == &dev->class->class_dirs) {
890 			struct device *d;
891 			int other = 0;
892 
893 			/*
894 			 * if we are the last child of our class, delete
895 			 * our class-directory at this parent
896 			 */
897 			down(&dev->class->sem);
898 			list_for_each_entry(d, &dev->class->devices, node) {
899 				if (d == dev)
900 					continue;
901 				if (d->kobj.parent == dev->kobj.parent) {
902 					other = 1;
903 					break;
904 				}
905 			}
906 			if (!other)
907 				kobject_del(dev->kobj.parent);
908 
909 			kobject_put(dev->kobj.parent);
910 			up(&dev->class->sem);
911 		}
912 	}
913 	device_remove_file(dev, &uevent_attr);
914 	device_remove_attrs(dev);
915 	bus_remove_device(dev);
916 
917 	/*
918 	 * Some platform devices are driven without driver attached
919 	 * and managed resources may have been acquired.  Make sure
920 	 * all resources are released.
921 	 */
922 	devres_release_all(dev);
923 
924 	/* Notify the platform of the removal, in case they
925 	 * need to do anything...
926 	 */
927 	if (platform_notify_remove)
928 		platform_notify_remove(dev);
929 	if (dev->bus)
930 		blocking_notifier_call_chain(&dev->bus->bus_notifier,
931 					     BUS_NOTIFY_DEL_DEVICE, dev);
932 	device_pm_remove(dev);
933 	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
934 	kobject_del(&dev->kobj);
935 	if (parent)
936 		put_device(parent);
937 }
938 
939 /**
940  *	device_unregister - unregister device from system.
941  *	@dev:	device going away.
942  *
943  *	We do this in two parts, like we do device_register(). First,
944  *	we remove it from all the subsystems with device_del(), then
945  *	we decrement the reference count via put_device(). If that
946  *	is the final reference count, the device will be cleaned up
947  *	via device_release() above. Otherwise, the structure will
948  *	stick around until the final reference to the device is dropped.
949  */
950 void device_unregister(struct device * dev)
951 {
952 	pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
953 	device_del(dev);
954 	put_device(dev);
955 }
956 
957 
958 static struct device * next_device(struct klist_iter * i)
959 {
960 	struct klist_node * n = klist_next(i);
961 	return n ? container_of(n, struct device, knode_parent) : NULL;
962 }
963 
964 /**
965  *	device_for_each_child - device child iterator.
966  *	@parent: parent struct device.
967  *	@data:	data for the callback.
968  *	@fn:	function to be called for each device.
969  *
970  *	Iterate over @parent's child devices, and call @fn for each,
971  *	passing it @data.
972  *
973  *	We check the return of @fn each time. If it returns anything
974  *	other than 0, we break out and return that value.
975  */
976 int device_for_each_child(struct device * parent, void * data,
977 		     int (*fn)(struct device *, void *))
978 {
979 	struct klist_iter i;
980 	struct device * child;
981 	int error = 0;
982 
983 	klist_iter_init(&parent->klist_children, &i);
984 	while ((child = next_device(&i)) && !error)
985 		error = fn(child, data);
986 	klist_iter_exit(&i);
987 	return error;
988 }
989 
990 /**
991  * device_find_child - device iterator for locating a particular device.
992  * @parent: parent struct device
993  * @data: Data to pass to match function
994  * @match: Callback function to check device
995  *
996  * This is similar to the device_for_each_child() function above, but it
997  * returns a reference to a device that is 'found' for later use, as
998  * determined by the @match callback.
999  *
1000  * The callback should return 0 if the device doesn't match and non-zero
1001  * if it does.  If the callback returns non-zero and a reference to the
1002  * current device can be obtained, this function will return to the caller
1003  * and not iterate over any more devices.
1004  */
1005 struct device * device_find_child(struct device *parent, void *data,
1006 				  int (*match)(struct device *, void *))
1007 {
1008 	struct klist_iter i;
1009 	struct device *child;
1010 
1011 	if (!parent)
1012 		return NULL;
1013 
1014 	klist_iter_init(&parent->klist_children, &i);
1015 	while ((child = next_device(&i)))
1016 		if (match(child, data) && get_device(child))
1017 			break;
1018 	klist_iter_exit(&i);
1019 	return child;
1020 }
1021 
1022 int __init devices_init(void)
1023 {
1024 	return subsystem_register(&devices_subsys);
1025 }
1026 
1027 EXPORT_SYMBOL_GPL(device_for_each_child);
1028 EXPORT_SYMBOL_GPL(device_find_child);
1029 
1030 EXPORT_SYMBOL_GPL(device_initialize);
1031 EXPORT_SYMBOL_GPL(device_add);
1032 EXPORT_SYMBOL_GPL(device_register);
1033 
1034 EXPORT_SYMBOL_GPL(device_del);
1035 EXPORT_SYMBOL_GPL(device_unregister);
1036 EXPORT_SYMBOL_GPL(get_device);
1037 EXPORT_SYMBOL_GPL(put_device);
1038 
1039 EXPORT_SYMBOL_GPL(device_create_file);
1040 EXPORT_SYMBOL_GPL(device_remove_file);
1041 
1042 
1043 static void device_create_release(struct device *dev)
1044 {
1045 	pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1046 	kfree(dev);
1047 }
1048 
1049 /**
1050  * device_create - creates a device and registers it with sysfs
1051  * @class: pointer to the struct class that this device should be registered to
1052  * @parent: pointer to the parent struct device of this new device, if any
1053  * @devt: the dev_t for the char device to be added
1054  * @fmt: string for the device's name
1055  *
1056  * This function can be used by char device classes.  A struct device
1057  * will be created in sysfs, registered to the specified class.
1058  *
1059  * A "dev" file will be created, showing the dev_t for the device, if
1060  * the dev_t is not 0,0.
1061  * If a pointer to a parent struct device is passed in, the newly created
1062  * struct device will be a child of that device in sysfs.
1063  * The pointer to the struct device will be returned from the call.
1064  * Any further sysfs files that might be required can be created using this
1065  * pointer.
1066  *
1067  * Note: the struct class passed to this function must have previously
1068  * been created with a call to class_create().
1069  */
1070 struct device *device_create(struct class *class, struct device *parent,
1071 			     dev_t devt, const char *fmt, ...)
1072 {
1073 	va_list args;
1074 	struct device *dev = NULL;
1075 	int retval = -ENODEV;
1076 
1077 	if (class == NULL || IS_ERR(class))
1078 		goto error;
1079 
1080 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1081 	if (!dev) {
1082 		retval = -ENOMEM;
1083 		goto error;
1084 	}
1085 
1086 	dev->devt = devt;
1087 	dev->class = class;
1088 	dev->parent = parent;
1089 	dev->release = device_create_release;
1090 
1091 	va_start(args, fmt);
1092 	vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1093 	va_end(args);
1094 	retval = device_register(dev);
1095 	if (retval)
1096 		goto error;
1097 
1098 	return dev;
1099 
1100 error:
1101 	kfree(dev);
1102 	return ERR_PTR(retval);
1103 }
1104 EXPORT_SYMBOL_GPL(device_create);
1105 
1106 /**
1107  * device_destroy - removes a device that was created with device_create()
1108  * @class: pointer to the struct class that this device was registered with
1109  * @devt: the dev_t of the device that was previously registered
1110  *
1111  * This call unregisters and cleans up a device that was created with a
1112  * call to device_create().
1113  */
1114 void device_destroy(struct class *class, dev_t devt)
1115 {
1116 	struct device *dev = NULL;
1117 	struct device *dev_tmp;
1118 
1119 	down(&class->sem);
1120 	list_for_each_entry(dev_tmp, &class->devices, node) {
1121 		if (dev_tmp->devt == devt) {
1122 			dev = dev_tmp;
1123 			break;
1124 		}
1125 	}
1126 	up(&class->sem);
1127 
1128 	if (dev)
1129 		device_unregister(dev);
1130 }
1131 EXPORT_SYMBOL_GPL(device_destroy);
1132 
1133 /**
1134  * device_rename - renames a device
1135  * @dev: the pointer to the struct device to be renamed
1136  * @new_name: the new name of the device
1137  */
1138 int device_rename(struct device *dev, char *new_name)
1139 {
1140 	char *old_class_name = NULL;
1141 	char *new_class_name = NULL;
1142 	char *old_symlink_name = NULL;
1143 	int error;
1144 
1145 	dev = get_device(dev);
1146 	if (!dev)
1147 		return -EINVAL;
1148 
1149 	pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1150 
1151 #ifdef CONFIG_SYSFS_DEPRECATED
1152 	if ((dev->class) && (dev->parent))
1153 		old_class_name = make_class_name(dev->class->name, &dev->kobj);
1154 #endif
1155 
1156 	if (dev->class) {
1157 		old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1158 		if (!old_symlink_name) {
1159 			error = -ENOMEM;
1160 			goto out_free_old_class;
1161 		}
1162 		strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1163 	}
1164 
1165 	strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1166 
1167 	error = kobject_rename(&dev->kobj, new_name);
1168 
1169 #ifdef CONFIG_SYSFS_DEPRECATED
1170 	if (old_class_name) {
1171 		new_class_name = make_class_name(dev->class->name, &dev->kobj);
1172 		if (new_class_name) {
1173 			sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1174 					  new_class_name);
1175 			sysfs_remove_link(&dev->parent->kobj, old_class_name);
1176 		}
1177 	}
1178 #endif
1179 
1180 	if (dev->class) {
1181 		sysfs_remove_link(&dev->class->subsys.kobj,
1182 				  old_symlink_name);
1183 		sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1184 				  dev->bus_id);
1185 	}
1186 	put_device(dev);
1187 
1188 	kfree(new_class_name);
1189 	kfree(old_symlink_name);
1190  out_free_old_class:
1191 	kfree(old_class_name);
1192 
1193 	return error;
1194 }
1195 EXPORT_SYMBOL_GPL(device_rename);
1196 
1197 static int device_move_class_links(struct device *dev,
1198 				   struct device *old_parent,
1199 				   struct device *new_parent)
1200 {
1201 	int error = 0;
1202 #ifdef CONFIG_SYSFS_DEPRECATED
1203 	char *class_name;
1204 
1205 	class_name = make_class_name(dev->class->name, &dev->kobj);
1206 	if (!class_name) {
1207 		error = -ENOMEM;
1208 		goto out;
1209 	}
1210 	if (old_parent) {
1211 		sysfs_remove_link(&dev->kobj, "device");
1212 		sysfs_remove_link(&old_parent->kobj, class_name);
1213 	}
1214 	if (new_parent) {
1215 		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1216 					  "device");
1217 		if (error)
1218 			goto out;
1219 		error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1220 					  class_name);
1221 		if (error)
1222 			sysfs_remove_link(&dev->kobj, "device");
1223 	}
1224 	else
1225 		error = 0;
1226 out:
1227 	kfree(class_name);
1228 	return error;
1229 #else
1230 	if (old_parent)
1231 		sysfs_remove_link(&dev->kobj, "device");
1232 	if (new_parent)
1233 		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1234 					  "device");
1235 	return error;
1236 #endif
1237 }
1238 
1239 /**
1240  * device_move - moves a device to a new parent
1241  * @dev: the pointer to the struct device to be moved
1242  * @new_parent: the new parent of the device (can by NULL)
1243  */
1244 int device_move(struct device *dev, struct device *new_parent)
1245 {
1246 	int error;
1247 	struct device *old_parent;
1248 	struct kobject *new_parent_kobj;
1249 
1250 	dev = get_device(dev);
1251 	if (!dev)
1252 		return -EINVAL;
1253 
1254 	new_parent = get_device(new_parent);
1255 	new_parent_kobj = get_device_parent (dev, new_parent);
1256 	if (IS_ERR(new_parent_kobj)) {
1257 		error = PTR_ERR(new_parent_kobj);
1258 		put_device(new_parent);
1259 		goto out;
1260 	}
1261 	pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1262 		 new_parent ? new_parent->bus_id : "<NULL>");
1263 	error = kobject_move(&dev->kobj, new_parent_kobj);
1264 	if (error) {
1265 		put_device(new_parent);
1266 		goto out;
1267 	}
1268 	old_parent = dev->parent;
1269 	dev->parent = new_parent;
1270 	if (old_parent)
1271 		klist_remove(&dev->knode_parent);
1272 	if (new_parent)
1273 		klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1274 	if (!dev->class)
1275 		goto out_put;
1276 	error = device_move_class_links(dev, old_parent, new_parent);
1277 	if (error) {
1278 		/* We ignore errors on cleanup since we're hosed anyway... */
1279 		device_move_class_links(dev, new_parent, old_parent);
1280 		if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1281 			if (new_parent)
1282 				klist_remove(&dev->knode_parent);
1283 			if (old_parent)
1284 				klist_add_tail(&dev->knode_parent,
1285 					       &old_parent->klist_children);
1286 		}
1287 		put_device(new_parent);
1288 		goto out;
1289 	}
1290 out_put:
1291 	put_device(old_parent);
1292 out:
1293 	put_device(dev);
1294 	return error;
1295 }
1296 
1297 EXPORT_SYMBOL_GPL(device_move);
1298