core.c 45.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5
/*
 * drivers/base/core.c - core driver model code (device registration, etc)
 *
 * Copyright (c) 2002-3 Patrick Mochel
 * Copyright (c) 2002-3 Open Source Development Labs
6 7
 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
 * Copyright (c) 2006 Novell, Inc.
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18
 *
 * This file is released under the GPLv2
 *
 */

#include <linux/device.h>
#include <linux/err.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#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>
L
Linus Torvalds 已提交
25 26 27 28

#include "base.h"
#include "power/power.h"

29 30
int (*platform_notify)(struct device *dev) = NULL;
int (*platform_notify_remove)(struct device *dev) = NULL;
31 32 33
static struct kobject *dev_kobj;
struct kobject *sysfs_dev_char_kobj;
struct kobject *sysfs_dev_block_kobj;
L
Linus Torvalds 已提交
34

35 36 37 38 39 40 41 42 43 44 45
#ifdef CONFIG_BLOCK
static inline int device_is_not_partition(struct device *dev)
{
	return !(dev->type == &part_type);
}
#else
static inline int device_is_not_partition(struct device *dev)
{
	return 1;
}
#endif
L
Linus Torvalds 已提交
46

47 48 49 50 51 52 53 54 55
/**
 * dev_driver_string - Return a device's driver name, if at all possible
 * @dev: struct device to get the name of
 *
 * Will return the device's driver's name if it is bound to a device.  If
 * the device is not bound to a device, it will return the name of the bus
 * it is attached to.  If it is not attached to a bus either, an empty
 * string will be returned.
 */
56
const char *dev_driver_string(const struct device *dev)
57
{
58 59 60 61 62 63 64 65
	struct device_driver *drv;

	/* dev->driver can change to NULL underneath us because of unbinding,
	 * so be careful about accessing it.  dev->bus and dev->class should
	 * never change once they are set, so they don't need special care.
	 */
	drv = ACCESS_ONCE(dev->driver);
	return drv ? drv->name :
66 67
			(dev->bus ? dev->bus->name :
			(dev->class ? dev->class->name : ""));
68
}
M
Matthew Wilcox 已提交
69
EXPORT_SYMBOL(dev_driver_string);
70

L
Linus Torvalds 已提交
71 72 73
#define to_dev(obj) container_of(obj, struct device, kobj)
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

74 75
static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
			     char *buf)
L
Linus Torvalds 已提交
76
{
77 78
	struct device_attribute *dev_attr = to_dev_attr(attr);
	struct device *dev = to_dev(kobj);
79
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
80 81

	if (dev_attr->show)
82
		ret = dev_attr->show(dev, dev_attr, buf);
83 84 85 86
	if (ret >= (ssize_t)PAGE_SIZE) {
		print_symbol("dev_attr_show: %s returned bad count\n",
				(unsigned long)dev_attr->show);
	}
L
Linus Torvalds 已提交
87 88 89
	return ret;
}

90 91
static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
			      const char *buf, size_t count)
L
Linus Torvalds 已提交
92
{
93 94
	struct device_attribute *dev_attr = to_dev_attr(attr);
	struct device *dev = to_dev(kobj);
95
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
96 97

	if (dev_attr->store)
98
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
99 100 101
	return ret;
}

102
static const struct sysfs_ops dev_sysfs_ops = {
L
Linus Torvalds 已提交
103 104 105 106 107 108 109 110 111 112 113 114 115
	.show	= dev_attr_show,
	.store	= dev_attr_store,
};


/**
 *	device_release - free device structure.
 *	@kobj:	device's kobject.
 *
 *	This is called once the reference count for the object
 *	reaches 0. We forward the call to the device's release
 *	method, which should handle actually freeing the structure.
 */
116
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
117
{
118
	struct device *dev = to_dev(kobj);
119
	struct device_private *p = dev->p;
L
Linus Torvalds 已提交
120 121 122

	if (dev->release)
		dev->release(dev);
123 124
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
125 126
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
127 128
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
129
			"function, it is broken and must be fixed.\n",
130
			dev_name(dev));
131
	kfree(p);
L
Linus Torvalds 已提交
132 133
}

134 135 136 137 138 139 140 141 142 143 144
static const void *device_namespace(struct kobject *kobj)
{
	struct device *dev = to_dev(kobj);
	const void *ns = NULL;

	if (dev->class && dev->class->ns_type)
		ns = dev->class->namespace(dev);

	return ns;
}

145
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
146 147
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
148
	.namespace	= device_namespace,
L
Linus Torvalds 已提交
149 150 151
};


152
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
153 154 155
{
	struct kobj_type *ktype = get_ktype(kobj);

156
	if (ktype == &device_ktype) {
L
Linus Torvalds 已提交
157 158 159
		struct device *dev = to_dev(kobj);
		if (dev->bus)
			return 1;
160 161
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
162 163 164 165
	}
	return 0;
}

166
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
167 168 169
{
	struct device *dev = to_dev(kobj);

170 171 172 173 174
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
175 176
}

177 178
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
179 180 181 182
{
	struct device *dev = to_dev(kobj);
	int retval = 0;

183
	/* add device node properties if present */
184
	if (MAJOR(dev->devt)) {
185 186
		const char *tmp;
		const char *name;
187
		mode_t mode = 0;
188

189 190
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
191
		name = device_get_devnode(dev, &mode, &tmp);
192 193 194
		if (name) {
			add_uevent_var(env, "DEVNAME=%s", name);
			kfree(tmp);
195 196
			if (mode)
				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
197
		}
198 199
	}

200
	if (dev->type && dev->type->name)
201
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
202

203
	if (dev->driver)
204
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
205

206
#ifdef CONFIG_SYSFS_DEPRECATED
207 208 209 210 211 212 213 214 215 216
	if (dev->class) {
		struct device *parent = dev->parent;

		/* find first bus device in parent chain */
		while (parent && !parent->bus)
			parent = parent->parent;
		if (parent && parent->bus) {
			const char *path;

			path = kobject_get_path(&parent->kobj, GFP_KERNEL);
217
			if (path) {
218
				add_uevent_var(env, "PHYSDEVPATH=%s", path);
219 220
				kfree(path);
			}
221

222
			add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
223 224

			if (parent->driver)
225 226
				add_uevent_var(env, "PHYSDEVDRIVER=%s",
					       parent->driver->name);
227 228
		}
	} else if (dev->bus) {
229
		add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
230 231

		if (dev->driver)
232 233
			add_uevent_var(env, "PHYSDEVDRIVER=%s",
				       dev->driver->name);
K
Kay Sievers 已提交
234
	}
235
#endif
L
Linus Torvalds 已提交
236

237
	/* have the bus specific function add its stuff */
238
	if (dev->bus && dev->bus->uevent) {
239
		retval = dev->bus->uevent(dev, env);
240
		if (retval)
241
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
242
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
243 244
	}

245
	/* have the class specific function add its stuff */
246
	if (dev->class && dev->class->dev_uevent) {
247
		retval = dev->class->dev_uevent(dev, env);
248
		if (retval)
249
			pr_debug("device: '%s': %s: class uevent() "
250
				 "returned %d\n", dev_name(dev),
251
				 __func__, retval);
252 253
	}

254
	/* have the device type specific fuction add its stuff */
255
	if (dev->type && dev->type->uevent) {
256
		retval = dev->type->uevent(dev, env);
257
		if (retval)
258
			pr_debug("device: '%s': %s: dev_type uevent() "
259
				 "returned %d\n", dev_name(dev),
260
				 __func__, retval);
261 262
	}

L
Linus Torvalds 已提交
263 264 265
	return retval;
}

266
static const struct kset_uevent_ops device_uevent_ops = {
267 268 269
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
270 271
};

272 273 274 275 276
static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
277
	struct kobj_uevent_env *env = NULL;
278 279 280 281 282 283
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
284 285
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
286 287
	if (!top_kobj->kset)
		goto out;
288

289 290 291 292 293 294 295 296 297
	kset = top_kobj->kset;
	if (!kset->uevent_ops || !kset->uevent_ops->uevent)
		goto out;

	/* respect filter */
	if (kset->uevent_ops && kset->uevent_ops->filter)
		if (!kset->uevent_ops->filter(kset, &dev->kobj))
			goto out;

298 299
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
300 301
		return -ENOMEM;

302
	/* let the kset specific function add its keys */
303
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
304 305 306 307
	if (retval)
		goto out;

	/* copy keys to file */
308 309
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
310
out:
311
	kfree(env);
312 313 314
	return count;
}

315 316 317
static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
318 319
	enum kobject_action action;

320
	if (kobject_action_type(buf, count, &action) == 0)
321
		kobject_uevent(&dev->kobj, action);
322 323
	else
		dev_err(dev, "uevent: unknown action-string\n");
324 325 326
	return count;
}

327 328 329
static struct device_attribute uevent_attr =
	__ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);

330 331
static int device_add_attributes(struct device *dev,
				 struct device_attribute *attrs)
332
{
333
	int error = 0;
334
	int i;
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

	if (attrs) {
		for (i = 0; attr_name(attrs[i]); i++) {
			error = device_create_file(dev, &attrs[i]);
			if (error)
				break;
		}
		if (error)
			while (--i >= 0)
				device_remove_file(dev, &attrs[i]);
	}
	return error;
}

static void device_remove_attributes(struct device *dev,
				     struct device_attribute *attrs)
{
	int i;

	if (attrs)
		for (i = 0; attr_name(attrs[i]); i++)
			device_remove_file(dev, &attrs[i]);
}

static int device_add_groups(struct device *dev,
360
			     const struct attribute_group **groups)
361
{
362
	int error = 0;
363
	int i;
364

365 366 367
	if (groups) {
		for (i = 0; groups[i]; i++) {
			error = sysfs_create_group(&dev->kobj, groups[i]);
368 369
			if (error) {
				while (--i >= 0)
370 371
					sysfs_remove_group(&dev->kobj,
							   groups[i]);
372
				break;
373 374 375 376 377 378
			}
		}
	}
	return error;
}

379
static void device_remove_groups(struct device *dev,
380
				 const struct attribute_group **groups)
381 382
{
	int i;
383 384 385 386

	if (groups)
		for (i = 0; groups[i]; i++)
			sysfs_remove_group(&dev->kobj, groups[i]);
387 388
}

389 390 391
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
392
	struct device_type *type = dev->type;
393
	int error;
394

395 396
	if (class) {
		error = device_add_attributes(dev, class->dev_attrs);
397
		if (error)
398
			return error;
399
	}
400

401 402
	if (type) {
		error = device_add_groups(dev, type->groups);
403
		if (error)
404
			goto err_remove_class_attrs;
405 406
	}

407 408 409 410 411 412 413 414 415 416 417 418 419
	error = device_add_groups(dev, dev->groups);
	if (error)
		goto err_remove_type_groups;

	return 0;

 err_remove_type_groups:
	if (type)
		device_remove_groups(dev, type->groups);
 err_remove_class_attrs:
	if (class)
		device_remove_attributes(dev, class->dev_attrs);

420 421 422 423 424 425
	return error;
}

static void device_remove_attrs(struct device *dev)
{
	struct class *class = dev->class;
426
	struct device_type *type = dev->type;
427

428
	device_remove_groups(dev, dev->groups);
429

430 431 432 433 434
	if (type)
		device_remove_groups(dev, type->groups);

	if (class)
		device_remove_attributes(dev, class->dev_attrs);
435 436 437
}


438 439 440 441 442 443
static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}

444 445 446
static struct device_attribute devt_attr =
	__ATTR(dev, S_IRUGO, show_dev, NULL);

447 448
/* kset to create /sys/devices/  */
struct kset *devices_kset;
L
Linus Torvalds 已提交
449 450

/**
451 452 453
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
454
 */
455 456
int device_create_file(struct device *dev,
		       const struct device_attribute *attr)
L
Linus Torvalds 已提交
457 458
{
	int error = 0;
459
	if (dev)
L
Linus Torvalds 已提交
460 461 462 463 464
		error = sysfs_create_file(&dev->kobj, &attr->attr);
	return error;
}

/**
465 466 467
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
468
 */
469 470
void device_remove_file(struct device *dev,
			const struct device_attribute *attr)
L
Linus Torvalds 已提交
471
{
472
	if (dev)
L
Linus Torvalds 已提交
473 474 475
		sysfs_remove_file(&dev->kobj, &attr->attr);
}

476 477 478 479 480
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
481 482
int device_create_bin_file(struct device *dev,
			   const struct bin_attribute *attr)
483 484 485 486 487 488 489 490 491 492 493 494 495
{
	int error = -EINVAL;
	if (dev)
		error = sysfs_create_bin_file(&dev->kobj, attr);
	return error;
}
EXPORT_SYMBOL_GPL(device_create_bin_file);

/**
 * device_remove_bin_file - remove sysfs binary attribute file
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
496 497
void device_remove_bin_file(struct device *dev,
			    const struct bin_attribute *attr)
498 499 500 501 502 503
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

504
/**
505
 * device_schedule_callback_owner - helper to schedule a callback for a device
506 507
 * @dev: device.
 * @func: callback function to invoke later.
508
 * @owner: module owning the callback routine
509 510 511 512 513 514 515 516 517 518
 *
 * Attribute methods must not unregister themselves or their parent device
 * (which would amount to the same thing).  Attempts to do so will deadlock,
 * since unregistration is mutually exclusive with driver callbacks.
 *
 * Instead methods can call this routine, which will attempt to allocate
 * and schedule a workqueue request to call back @func with @dev as its
 * argument in the workqueue's process context.  @dev will be pinned until
 * @func returns.
 *
519 520 521
 * This routine is usually called via the inline device_schedule_callback(),
 * which automatically sets @owner to THIS_MODULE.
 *
522
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
523
 * be allocated, -ENODEV if a reference to @owner isn't available.
524 525 526 527 528
 *
 * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
 * underlying sysfs routine (since it is intended for use by attribute
 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
 */
529 530
int device_schedule_callback_owner(struct device *dev,
		void (*func)(struct device *), struct module *owner)
531 532
{
	return sysfs_schedule_callback(&dev->kobj,
533
			(void (*)(void *)) func, dev, owner);
534
}
535
EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
536

537 538
static void klist_children_get(struct klist_node *n)
{
539 540
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
541 542 543 544 545 546

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
547 548
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
549 550 551 552

	put_device(dev);
}

L
Linus Torvalds 已提交
553
/**
554 555
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
556
 *
557 558
 * This prepares the device for use by other layers by initializing
 * its fields.
559
 * It is the first half of device_register(), if called by
560 561 562 563 564 565 566
 * that function, though it can also be called separately, so one
 * may use @dev's fields. In particular, get_device()/put_device()
 * may be used for reference counting of @dev after calling this
 * function.
 *
 * NOTE: Use put_device() to give up your reference instead of freeing
 * @dev directly once you have called this function.
L
Linus Torvalds 已提交
567 568 569
 */
void device_initialize(struct device *dev)
{
570
	dev->kobj.kset = devices_kset;
571
	kobject_init(&dev->kobj, &device_ktype);
L
Linus Torvalds 已提交
572
	INIT_LIST_HEAD(&dev->dma_pools);
573
	mutex_init(&dev->mutex);
574
	lockdep_set_novalidate_class(&dev->mutex);
T
Tejun Heo 已提交
575 576
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
577
	device_pm_init(dev);
578
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
579 580
}

581
#ifdef CONFIG_SYSFS_DEPRECATED
582 583
static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
584
{
585
	/* class devices without a parent live in /sys/class/<classname>/ */
586
	if (dev->class && (!parent || parent->class != dev->class))
587
		return &dev->class->p->class_subsys.kobj;
588
	/* all other devices keep their parent */
589
	else if (parent)
590
		return &parent->kobj;
591

592
	return NULL;
593
}
594 595

static inline void cleanup_device_parent(struct device *dev) {}
596 597
static inline void cleanup_glue_dir(struct device *dev,
				    struct kobject *glue_dir) {}
598
#else
599
static struct kobject *virtual_device_parent(struct device *dev)
600
{
601
	static struct kobject *virtual_dir = NULL;
602

603
	if (!virtual_dir)
604
		virtual_dir = kobject_create_and_add("virtual",
605
						     &devices_kset->kobj);
606

607
	return virtual_dir;
608 609
}

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
struct class_dir {
	struct kobject kobj;
	struct class *class;
};

#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)

static void class_dir_release(struct kobject *kobj)
{
	struct class_dir *dir = to_class_dir(kobj);
	kfree(dir);
}

static const
struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
625
{
626 627 628 629 630 631 632 633 634 635 636 637 638 639
	struct class_dir *dir = to_class_dir(kobj);
	return dir->class->ns_type;
}

static struct kobj_type class_dir_ktype = {
	.release	= class_dir_release,
	.sysfs_ops	= &kobj_sysfs_ops,
	.child_ns_type	= class_dir_child_ns_type
};

static struct kobject *
class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
{
	struct class_dir *dir;
640 641
	int retval;

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
	if (!dir)
		return NULL;

	dir->class = class;
	kobject_init(&dir->kobj, &class_dir_ktype);

	dir->kobj.kset = &class->p->class_dirs;

	retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
	if (retval < 0) {
		kobject_put(&dir->kobj);
		return NULL;
	}
	return &dir->kobj;
}


static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
{
663
	if (dev->class) {
664
		static DEFINE_MUTEX(gdp_mutex);
665 666 667 668 669 670
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

		/*
		 * If we have no parent, we live in "virtual".
671 672
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
673 674 675 676 677 678 679 680
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
		else if (parent->class)
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

681 682
		mutex_lock(&gdp_mutex);

683
		/* find our class-directory at the parent and reference it */
684 685
		spin_lock(&dev->class->p->class_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
686 687 688 689
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
690
		spin_unlock(&dev->class->p->class_dirs.list_lock);
691 692
		if (kobj) {
			mutex_unlock(&gdp_mutex);
693
			return kobj;
694
		}
695 696

		/* or create a new class-directory at the parent device */
697
		k = class_dir_create_and_add(dev->class, parent_kobj);
698
		/* do not emit an uevent for this simple "glue" directory */
699
		mutex_unlock(&gdp_mutex);
700
		return k;
701 702 703
	}

	if (parent)
704 705 706
		return &parent->kobj;
	return NULL;
}
707

708
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
709
{
710
	/* see if we live in a "glue" directory */
711
	if (!glue_dir || !dev->class ||
712
	    glue_dir->kset != &dev->class->p->class_dirs)
713 714
		return;

715
	kobject_put(glue_dir);
716
}
717 718 719 720 721

static void cleanup_device_parent(struct device *dev)
{
	cleanup_glue_dir(dev, dev->kobj.parent);
}
722
#endif
723

724
static void setup_parent(struct device *dev, struct device *parent)
725 726 727 728 729
{
	struct kobject *kobj;
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
730 731
}

732 733 734 735 736 737
static int device_add_class_symlinks(struct device *dev)
{
	int error;

	if (!dev->class)
		return 0;
738

739 740
	error = sysfs_create_link(&dev->kobj,
				  &dev->class->p->class_subsys.kobj,
741 742 743
				  "subsystem");
	if (error)
		goto out;
744 745 746

#ifdef CONFIG_SYSFS_DEPRECATED
	/* stacked class devices need a symlink in the class directory */
747
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
748
	    device_is_not_partition(dev)) {
749
		error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
750
					  &dev->kobj, dev_name(dev));
751 752 753
		if (error)
			goto out_subsys;
	}
754

755
	if (dev->parent && device_is_not_partition(dev)) {
756 757
		struct device *parent = dev->parent;
		char *class_name;
758

759 760 761 762 763 764 765 766 767
		/*
		 * stacked class devices have the 'device' link
		 * pointing to the bus device instead of the parent
		 */
		while (parent->class && !parent->bus && parent->parent)
			parent = parent->parent;

		error = sysfs_create_link(&dev->kobj,
					  &parent->kobj,
768 769 770
					  "device");
		if (error)
			goto out_busid;
771 772 773 774 775 776 777 778 779

		class_name = make_class_name(dev->class->name,
						&dev->kobj);
		if (class_name)
			error = sysfs_create_link(&dev->parent->kobj,
						&dev->kobj, class_name);
		kfree(class_name);
		if (error)
			goto out_device;
780 781 782 783
	}
	return 0;

out_device:
784
	if (dev->parent && device_is_not_partition(dev))
785 786
		sysfs_remove_link(&dev->kobj, "device");
out_busid:
787
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
788
	    device_is_not_partition(dev))
789
		sysfs_delete_link(&dev->class->p->class_subsys.kobj, &dev->kobj,
790
				  dev_name(dev));
791 792
#else
	/* link in the class directory pointing to the device */
793
	error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
794
				  &dev->kobj, dev_name(dev));
795 796 797
	if (error)
		goto out_subsys;

798
	if (dev->parent && device_is_not_partition(dev)) {
799 800 801 802 803 804 805 806
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
					  "device");
		if (error)
			goto out_busid;
	}
	return 0;

out_busid:
807
	sysfs_delete_link(&dev->class->p->class_subsys.kobj, &dev->kobj, dev_name(dev));
808 809
#endif

810 811 812 813 814 815 816 817 818 819
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
out:
	return error;
}

static void device_remove_class_symlinks(struct device *dev)
{
	if (!dev->class)
		return;
820

821
#ifdef CONFIG_SYSFS_DEPRECATED
822
	if (dev->parent && device_is_not_partition(dev)) {
823 824 825 826 827 828 829 830 831
		char *class_name;

		class_name = make_class_name(dev->class->name, &dev->kobj);
		if (class_name) {
			sysfs_remove_link(&dev->parent->kobj, class_name);
			kfree(class_name);
		}
		sysfs_remove_link(&dev->kobj, "device");
	}
832

833
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
834
	    device_is_not_partition(dev))
835
		sysfs_delete_link(&dev->class->p->class_subsys.kobj, &dev->kobj,
836
				  dev_name(dev));
837
#else
838
	if (dev->parent && device_is_not_partition(dev))
839 840
		sysfs_remove_link(&dev->kobj, "device");

841
	sysfs_delete_link(&dev->class->p->class_subsys.kobj, &dev->kobj, dev_name(dev));
842 843
#endif

844 845 846
	sysfs_remove_link(&dev->kobj, "subsystem");
}

847 848 849
/**
 * dev_set_name - set a device name
 * @dev: device
850
 * @fmt: format string for the device's name
851 852 853 854
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;
855
	int err;
856 857

	va_start(vargs, fmt);
858
	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
859
	va_end(vargs);
860
	return err;
861 862 863
}
EXPORT_SYMBOL_GPL(dev_set_name);

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
/**
 * device_to_dev_kobj - select a /sys/dev/ directory for the device
 * @dev: device
 *
 * By default we select char/ for new entries.  Setting class->dev_obj
 * to NULL prevents an entry from being created.  class->dev_kobj must
 * be set (or cleared) before any devices are registered to the class
 * otherwise device_create_sys_dev_entry() and
 * device_remove_sys_dev_entry() will disagree about the the presence
 * of the link.
 */
static struct kobject *device_to_dev_kobj(struct device *dev)
{
	struct kobject *kobj;

	if (dev->class)
		kobj = dev->class->dev_kobj;
	else
		kobj = sysfs_dev_char_kobj;

	return kobj;
}

static int device_create_sys_dev_entry(struct device *dev)
{
	struct kobject *kobj = device_to_dev_kobj(dev);
	int error = 0;
	char devt_str[15];

	if (kobj) {
		format_dev_t(devt_str, dev->devt);
		error = sysfs_create_link(kobj, &dev->kobj, devt_str);
	}

	return error;
}

static void device_remove_sys_dev_entry(struct device *dev)
{
	struct kobject *kobj = device_to_dev_kobj(dev);
	char devt_str[15];

	if (kobj) {
		format_dev_t(devt_str, dev->devt);
		sysfs_remove_link(kobj, devt_str);
	}
}

912 913 914 915 916 917 918 919 920 921 922
int device_private_init(struct device *dev)
{
	dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
	if (!dev->p)
		return -ENOMEM;
	dev->p->device = dev;
	klist_init(&dev->p->klist_children, klist_children_get,
		   klist_children_put);
	return 0;
}

L
Linus Torvalds 已提交
923
/**
924 925
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
926
 *
927 928
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
929
 *
930
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
931 932
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
933 934 935 936
 *
 * NOTE: _Never_ directly free @dev after calling this function, even
 * if it returned an error! Always use put_device() to give up your
 * reference instead.
L
Linus Torvalds 已提交
937 938 939 940
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
941
	struct class_interface *class_intf;
942
	int error = -EINVAL;
943

L
Linus Torvalds 已提交
944
	dev = get_device(dev);
945 946 947
	if (!dev)
		goto done;

948
	if (!dev->p) {
949 950 951
		error = device_private_init(dev);
		if (error)
			goto done;
952 953
	}

954 955 956 957 958 959
	/*
	 * for statically allocated devices, which should all be converted
	 * some day, we need to initialize the name. We prevent reading back
	 * the name, and force the use of dev_name()
	 */
	if (dev->init_name) {
960
		dev_set_name(dev, "%s", dev->init_name);
961 962
		dev->init_name = NULL;
	}
963

964 965
	if (!dev_name(dev)) {
		error = -EINVAL;
966
		goto name_error;
967
	}
L
Linus Torvalds 已提交
968

969
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
970

L
Linus Torvalds 已提交
971
	parent = get_device(dev->parent);
972
	setup_parent(dev, parent);
L
Linus Torvalds 已提交
973

974 975 976 977
	/* use parent numa_node */
	if (parent)
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
978
	/* first, register with generic layer. */
979 980
	/* we require the name to be set before, and pass NULL */
	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
981
	if (error)
L
Linus Torvalds 已提交
982
		goto Error;
983

984 985 986 987
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

988
	error = device_create_file(dev, &uevent_attr);
989 990
	if (error)
		goto attrError;
991

992
	if (MAJOR(dev->devt)) {
993 994
		error = device_create_file(dev, &devt_attr);
		if (error)
995
			goto ueventattrError;
996 997 998 999

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto devtattrError;
1000 1001

		devtmpfs_create_node(dev);
1002 1003
	}

1004 1005 1006
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
1007 1008
	error = device_add_attrs(dev);
	if (error)
1009
		goto AttrsError;
1010 1011
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
1012
		goto BusError;
1013
	error = dpm_sysfs_add(dev);
1014
	if (error)
1015 1016
		goto DPMError;
	device_pm_add(dev);
1017 1018 1019 1020 1021 1022 1023 1024

	/* Notify clients of device addition.  This call must come
	 * after dpm_sysf_add() and before kobject_uevent().
	 */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_ADD_DEVICE, dev);

1025
	kobject_uevent(&dev->kobj, KOBJ_ADD);
1026
	bus_probe_device(dev);
L
Linus Torvalds 已提交
1027
	if (parent)
1028 1029
		klist_add_tail(&dev->p->knode_parent,
			       &parent->p->klist_children);
L
Linus Torvalds 已提交
1030

1031
	if (dev->class) {
1032
		mutex_lock(&dev->class->p->class_mutex);
1033
		/* tie the class to the device */
1034 1035
		klist_add_tail(&dev->knode_class,
			       &dev->class->p->class_devices);
1036 1037

		/* notify any interfaces that the device is here */
1038 1039
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
1040 1041
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
1042
		mutex_unlock(&dev->class->p->class_mutex);
1043
	}
1044
done:
L
Linus Torvalds 已提交
1045 1046
	put_device(dev);
	return error;
1047
 DPMError:
1048 1049
	bus_remove_device(dev);
 BusError:
1050
	device_remove_attrs(dev);
1051
 AttrsError:
1052 1053
	device_remove_class_symlinks(dev);
 SymlinkError:
1054 1055
	if (MAJOR(dev->devt))
		devtmpfs_delete_node(dev);
1056 1057 1058
	if (MAJOR(dev->devt))
		device_remove_sys_dev_entry(dev);
 devtattrError:
1059 1060
	if (MAJOR(dev->devt))
		device_remove_file(dev, &devt_attr);
1061
 ueventattrError:
1062
	device_remove_file(dev, &uevent_attr);
1063
 attrError:
1064
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
1065 1066
	kobject_del(&dev->kobj);
 Error:
1067
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1068 1069
	if (parent)
		put_device(parent);
1070 1071 1072
name_error:
	kfree(dev->p);
	dev->p = NULL;
1073
	goto done;
L
Linus Torvalds 已提交
1074 1075 1076
}

/**
1077 1078
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
1079
 *
1080 1081 1082 1083 1084 1085
 * This happens in two clean steps - initialize the device
 * and add it to the system. The two steps can be called
 * separately, but this is the easiest and most common.
 * I.e. you should only call the two helpers separately if
 * have a clearly defined need to use and refcount the device
 * before it is added to the hierarchy.
1086 1087 1088 1089
 *
 * NOTE: _Never_ directly free @dev after calling this function, even
 * if it returned an error! Always use put_device() to give up the
 * reference initialized in this function instead.
L
Linus Torvalds 已提交
1090 1091 1092 1093 1094 1095 1096 1097
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}

/**
1098 1099
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
1100
 *
1101 1102 1103
 * This simply forwards the call to kobject_get(), though
 * we do take care to provide for the case that we get a NULL
 * pointer passed in.
L
Linus Torvalds 已提交
1104
 */
1105
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
1106 1107 1108 1109 1110
{
	return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
}

/**
1111 1112
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1113
 */
1114
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1115
{
1116
	/* might_sleep(); */
L
Linus Torvalds 已提交
1117 1118 1119 1120 1121
	if (dev)
		kobject_put(&dev->kobj);
}

/**
1122 1123
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1124
 *
1125 1126 1127 1128 1129
 * This is the first part of the device unregistration
 * sequence. This removes the device from the lists we control
 * from here, has it removed from the other driver model
 * subsystems it was added to in device_add(), and removes it
 * from the kobject hierarchy.
L
Linus Torvalds 已提交
1130
 *
1131 1132
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1133
 */
1134
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1135
{
1136
	struct device *parent = dev->parent;
1137
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1138

1139 1140 1141 1142 1143 1144
	/* Notify clients of device removal.  This call must come
	 * before dpm_sysfs_remove().
	 */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_DEL_DEVICE, dev);
1145
	device_pm_remove(dev);
1146
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1147
	if (parent)
1148
		klist_del(&dev->p->knode_parent);
1149
	if (MAJOR(dev->devt)) {
1150
		devtmpfs_delete_node(dev);
1151
		device_remove_sys_dev_entry(dev);
1152
		device_remove_file(dev, &devt_attr);
1153
	}
1154
	if (dev->class) {
1155
		device_remove_class_symlinks(dev);
1156

1157
		mutex_lock(&dev->class->p->class_mutex);
1158
		/* notify any interfaces that the device is now gone */
1159 1160
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
1161 1162 1163
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1164
		klist_del(&dev->knode_class);
1165
		mutex_unlock(&dev->class->p->class_mutex);
1166
	}
1167
	device_remove_file(dev, &uevent_attr);
1168
	device_remove_attrs(dev);
1169
	bus_remove_device(dev);
L
Linus Torvalds 已提交
1170

1171 1172 1173 1174 1175 1176 1177
	/*
	 * Some platform devices are driven without driver attached
	 * and managed resources may have been acquired.  Make sure
	 * all resources are released.
	 */
	devres_release_all(dev);

L
Linus Torvalds 已提交
1178 1179 1180 1181 1182
	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1183
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1184
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1185
	kobject_del(&dev->kobj);
1186
	put_device(parent);
L
Linus Torvalds 已提交
1187 1188 1189
}

/**
1190 1191
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1192
 *
1193 1194 1195 1196 1197 1198
 * We do this in two parts, like we do device_register(). First,
 * we remove it from all the subsystems with device_del(), then
 * we decrement the reference count via put_device(). If that
 * is the final reference count, the device will be cleaned up
 * via device_release() above. Otherwise, the structure will
 * stick around until the final reference to the device is dropped.
L
Linus Torvalds 已提交
1199
 */
1200
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1201
{
1202
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1203 1204 1205 1206
	device_del(dev);
	put_device(dev);
}

1207
static struct device *next_device(struct klist_iter *i)
1208
{
1209
	struct klist_node *n = klist_next(i);
1210 1211 1212 1213 1214 1215 1216 1217
	struct device *dev = NULL;
	struct device_private *p;

	if (n) {
		p = to_device_private_parent(n);
		dev = p->device;
	}
	return dev;
1218 1219
}

1220
/**
1221
 * device_get_devnode - path of device node file
1222
 * @dev: device
1223
 * @mode: returned file access mode
1224 1225 1226 1227 1228 1229 1230
 * @tmp: possibly allocated string
 *
 * Return the relative path of a possible device node.
 * Non-default names may need to allocate a memory to compose
 * a name. This memory is returned in tmp and needs to be
 * freed by the caller.
 */
1231 1232
const char *device_get_devnode(struct device *dev,
			       mode_t *mode, const char **tmp)
1233 1234 1235 1236 1237 1238
{
	char *s;

	*tmp = NULL;

	/* the device type may provide a specific name */
1239 1240
	if (dev->type && dev->type->devnode)
		*tmp = dev->type->devnode(dev, mode);
1241 1242 1243 1244
	if (*tmp)
		return *tmp;

	/* the class may provide a specific name */
1245 1246
	if (dev->class && dev->class->devnode)
		*tmp = dev->class->devnode(dev, mode);
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
	if (*tmp)
		return *tmp;

	/* return name without allocation, tmp == NULL */
	if (strchr(dev_name(dev), '!') == NULL)
		return dev_name(dev);

	/* replace '!' in the name with '/' */
	*tmp = kstrdup(dev_name(dev), GFP_KERNEL);
	if (!*tmp)
		return NULL;
	while ((s = strchr(*tmp, '!')))
		s[0] = '/';
	return *tmp;
}

L
Linus Torvalds 已提交
1263
/**
1264 1265 1266 1267
 * device_for_each_child - device child iterator.
 * @parent: parent struct device.
 * @data: data for the callback.
 * @fn: function to be called for each device.
L
Linus Torvalds 已提交
1268
 *
1269 1270
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1271
 *
1272 1273
 * We check the return of @fn each time. If it returns anything
 * other than 0, we break out and return that value.
L
Linus Torvalds 已提交
1274
 */
1275 1276
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1277
{
1278
	struct klist_iter i;
1279
	struct device *child;
L
Linus Torvalds 已提交
1280 1281
	int error = 0;

1282 1283 1284
	if (!parent->p)
		return 0;

1285
	klist_iter_init(&parent->p->klist_children, &i);
1286 1287 1288
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1289 1290 1291
	return error;
}

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
/**
 * device_find_child - device iterator for locating a particular device.
 * @parent: parent struct device
 * @data: Data to pass to match function
 * @match: Callback function to check device
 *
 * This is similar to the device_for_each_child() function above, but it
 * returns a reference to a device that is 'found' for later use, as
 * determined by the @match callback.
 *
 * The callback should return 0 if the device doesn't match and non-zero
 * if it does.  If the callback returns non-zero and a reference to the
 * current device can be obtained, this function will return to the caller
 * and not iterate over any more devices.
 */
1307 1308
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
1309 1310 1311 1312 1313 1314 1315
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

1316
	klist_iter_init(&parent->p->klist_children, &i);
1317 1318 1319 1320 1321 1322 1323
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}

L
Linus Torvalds 已提交
1324 1325
int __init devices_init(void)
{
1326 1327 1328
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
	dev_kobj = kobject_create_and_add("dev", NULL);
	if (!dev_kobj)
		goto dev_kobj_err;
	sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
	if (!sysfs_dev_block_kobj)
		goto block_kobj_err;
	sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
	if (!sysfs_dev_char_kobj)
		goto char_kobj_err;

1339
	return 0;
1340 1341 1342 1343 1344 1345 1346 1347

 char_kobj_err:
	kobject_put(sysfs_dev_block_kobj);
 block_kobj_err:
	kobject_put(dev_kobj);
 dev_kobj_err:
	kset_unregister(devices_kset);
	return -ENOMEM;
L
Linus Torvalds 已提交
1348 1349 1350
}

EXPORT_SYMBOL_GPL(device_for_each_child);
1351
EXPORT_SYMBOL_GPL(device_find_child);
L
Linus Torvalds 已提交
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363

EXPORT_SYMBOL_GPL(device_initialize);
EXPORT_SYMBOL_GPL(device_add);
EXPORT_SYMBOL_GPL(device_register);

EXPORT_SYMBOL_GPL(device_del);
EXPORT_SYMBOL_GPL(device_unregister);
EXPORT_SYMBOL_GPL(get_device);
EXPORT_SYMBOL_GPL(put_device);

EXPORT_SYMBOL_GPL(device_create_file);
EXPORT_SYMBOL_GPL(device_remove_file);
1364

1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
struct root_device
{
	struct device dev;
	struct module *owner;
};

#define to_root_device(dev) container_of(dev, struct root_device, dev)

static void root_device_release(struct device *dev)
{
	kfree(to_root_device(dev));
}

/**
 * __root_device_register - allocate and register a root device
 * @name: root device name
 * @owner: owner module of the root device, usually THIS_MODULE
 *
 * This function allocates a root device and registers it
 * using device_register(). In order to free the returned
 * device, use root_device_unregister().
 *
 * Root devices are dummy devices which allow other devices
 * to be grouped under /sys/devices. Use this function to
 * allocate a root device and then use it as the parent of
 * any device which should appear under /sys/devices/{name}
 *
 * The /sys/devices/{name} directory will also contain a
 * 'module' symlink which points to the @owner directory
 * in sysfs.
 *
1396 1397
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
 * Note: You probably want to use root_device_register().
 */
struct device *__root_device_register(const char *name, struct module *owner)
{
	struct root_device *root;
	int err = -ENOMEM;

	root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
	if (!root)
		return ERR_PTR(err);

1409
	err = dev_set_name(&root->dev, "%s", name);
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
	if (err) {
		kfree(root);
		return ERR_PTR(err);
	}

	root->dev.release = root_device_release;

	err = device_register(&root->dev);
	if (err) {
		put_device(&root->dev);
		return ERR_PTR(err);
	}

1423
#ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
	if (owner) {
		struct module_kobject *mk = &owner->mkobj;

		err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
		if (err) {
			device_unregister(&root->dev);
			return ERR_PTR(err);
		}
		root->owner = owner;
	}
#endif

	return &root->dev;
}
EXPORT_SYMBOL_GPL(__root_device_register);

/**
 * root_device_unregister - unregister and free a root device
1442
 * @dev: device going away
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
 *
 * This function unregisters and cleans up a device that was created by
 * root_device_register().
 */
void root_device_unregister(struct device *dev)
{
	struct root_device *root = to_root_device(dev);

	if (root->owner)
		sysfs_remove_link(&root->dev.kobj, "module");

	device_unregister(dev);
}
EXPORT_SYMBOL_GPL(root_device_unregister);

1458 1459 1460

static void device_create_release(struct device *dev)
{
1461
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1462 1463 1464 1465
	kfree(dev);
}

/**
1466
 * device_create_vargs - creates a device and registers it with sysfs
1467 1468 1469
 * @class: pointer to the struct class that this device should be registered to
 * @parent: pointer to the parent struct device of this new device, if any
 * @devt: the dev_t for the char device to be added
1470
 * @drvdata: the data to be added to the device for callbacks
1471
 * @fmt: string for the device's name
1472
 * @args: va_list for the device's name
1473 1474 1475
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
1476 1477 1478
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
1479 1480 1481 1482
 * If a pointer to a parent struct device is passed in, the newly created
 * struct device will be a child of that device in sysfs.
 * The pointer to the struct device will be returned from the call.
 * Any further sysfs files that might be required can be created using this
1483 1484
 * pointer.
 *
1485 1486
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1487 1488 1489
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1490 1491 1492
struct device *device_create_vargs(struct class *class, struct device *parent,
				   dev_t devt, void *drvdata, const char *fmt,
				   va_list args)
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
{
	struct device *dev = NULL;
	int retval = -ENODEV;

	if (class == NULL || IS_ERR(class))
		goto error;

	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
	if (!dev) {
		retval = -ENOMEM;
		goto error;
	}

	dev->devt = devt;
	dev->class = class;
	dev->parent = parent;
	dev->release = device_create_release;
1510
	dev_set_drvdata(dev, drvdata);
1511

1512 1513 1514 1515
	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
	if (retval)
		goto error;

1516 1517 1518 1519 1520 1521 1522
	retval = device_register(dev);
	if (retval)
		goto error;

	return dev;

error:
1523
	put_device(dev);
1524 1525
	return ERR_PTR(retval);
}
1526 1527 1528
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
1529
 * device_create - creates a device and registers it with sysfs
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
 * @class: pointer to the struct class that this device should be registered to
 * @parent: pointer to the parent struct device of this new device, if any
 * @devt: the dev_t for the char device to be added
 * @drvdata: the data to be added to the device for callbacks
 * @fmt: string for the device's name
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
 * If a pointer to a parent struct device is passed in, the newly created
 * struct device will be a child of that device in sysfs.
 * The pointer to the struct device will be returned from the call.
 * Any further sysfs files that might be required can be created using this
 * pointer.
 *
1547 1548
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1549 1550 1551
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1552 1553
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
1554 1555 1556 1557 1558 1559 1560 1561 1562
{
	va_list vargs;
	struct device *dev;

	va_start(vargs, fmt);
	dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
	va_end(vargs);
	return dev;
}
1563
EXPORT_SYMBOL_GPL(device_create);
1564

1565
static int __match_devt(struct device *dev, void *data)
1566
{
1567
	dev_t *devt = data;
1568

1569
	return dev->devt == *devt;
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
}

/**
 * device_destroy - removes a device that was created with device_create()
 * @class: pointer to the struct class that this device was registered with
 * @devt: the dev_t of the device that was previously registered
 *
 * This call unregisters and cleans up a device that was created with a
 * call to device_create().
 */
void device_destroy(struct class *class, dev_t devt)
{
	struct device *dev;
1583

1584
	dev = class_find_device(class, NULL, &devt, __match_devt);
1585 1586
	if (dev) {
		put_device(dev);
1587
		device_unregister(dev);
1588
	}
1589 1590
}
EXPORT_SYMBOL_GPL(device_destroy);
1591 1592 1593 1594 1595

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
1596 1597 1598 1599 1600
 *
 * It is the responsibility of the caller to provide mutual
 * exclusion between two different calls of device_rename
 * on the same device to ensure that new_name is valid and
 * won't conflict with other devices.
1601 1602 1603 1604 1605
 */
int device_rename(struct device *dev, char *new_name)
{
	char *old_class_name = NULL;
	char *new_class_name = NULL;
1606
	char *old_device_name = NULL;
1607 1608 1609 1610 1611 1612
	int error;

	dev = get_device(dev);
	if (!dev)
		return -EINVAL;

1613
	pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1614
		 __func__, new_name);
1615

1616
#ifdef CONFIG_SYSFS_DEPRECATED
1617 1618
	if ((dev->class) && (dev->parent))
		old_class_name = make_class_name(dev->class->name, &dev->kobj);
1619
#endif
1620

1621
	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1622 1623 1624
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
1625 1626
	}

1627 1628 1629 1630 1631 1632 1633 1634
#ifndef CONFIG_SYSFS_DEPRECATED
	if (dev->class) {
		error = sysfs_rename_link(&dev->class->p->class_subsys.kobj,
			&dev->kobj, old_device_name, new_name);
		if (error)
			goto out;
	}
#endif
1635
	error = kobject_rename(&dev->kobj, new_name);
1636
	if (error)
1637
		goto out;
1638

1639
#ifdef CONFIG_SYSFS_DEPRECATED
1640 1641 1642
	if (old_class_name) {
		new_class_name = make_class_name(dev->class->name, &dev->kobj);
		if (new_class_name) {
1643 1644 1645 1646
			error = sysfs_rename_link(&dev->parent->kobj,
						  &dev->kobj,
						  old_class_name,
						  new_class_name);
1647 1648
		}
	}
1649 1650
#endif

1651
out:
1652 1653 1654
	put_device(dev);

	kfree(new_class_name);
1655
	kfree(old_class_name);
1656
	kfree(old_device_name);
1657 1658 1659

	return error;
}
1660
EXPORT_SYMBOL_GPL(device_rename);
1661 1662 1663 1664 1665

static int device_move_class_links(struct device *dev,
				   struct device *old_parent,
				   struct device *new_parent)
{
1666
	int error = 0;
1667 1668 1669 1670 1671
#ifdef CONFIG_SYSFS_DEPRECATED
	char *class_name;

	class_name = make_class_name(dev->class->name, &dev->kobj);
	if (!class_name) {
1672
		error = -ENOMEM;
1673 1674 1675 1676 1677 1678
		goto out;
	}
	if (old_parent) {
		sysfs_remove_link(&dev->kobj, "device");
		sysfs_remove_link(&old_parent->kobj, class_name);
	}
1679 1680 1681 1682 1683 1684 1685 1686 1687
	if (new_parent) {
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
		if (error)
			goto out;
		error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
					  class_name);
		if (error)
			sysfs_remove_link(&dev->kobj, "device");
1688
	} else
1689
		error = 0;
1690 1691 1692 1693
out:
	kfree(class_name);
	return error;
#else
1694 1695 1696 1697 1698 1699
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
1700 1701 1702 1703 1704 1705
#endif
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1706
 * @new_parent: the new parent of the device (can by NULL)
1707
 * @dpm_order: how to reorder the dpm_list
1708
 */
1709 1710
int device_move(struct device *dev, struct device *new_parent,
		enum dpm_order dpm_order)
1711 1712 1713
{
	int error;
	struct device *old_parent;
1714
	struct kobject *new_parent_kobj;
1715 1716 1717 1718 1719

	dev = get_device(dev);
	if (!dev)
		return -EINVAL;

1720
	device_pm_lock();
1721
	new_parent = get_device(new_parent);
1722
	new_parent_kobj = get_device_parent(dev, new_parent);
1723

1724 1725
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1726
	error = kobject_move(&dev->kobj, new_parent_kobj);
1727
	if (error) {
1728
		cleanup_glue_dir(dev, new_parent_kobj);
1729 1730 1731 1732 1733 1734
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1735
		klist_remove(&dev->p->knode_parent);
1736
	if (new_parent) {
1737 1738
		klist_add_tail(&dev->p->knode_parent,
			       &new_parent->p->klist_children);
1739 1740 1741
		set_dev_node(dev, dev_to_node(new_parent));
	}

1742 1743 1744 1745 1746 1747 1748
	if (!dev->class)
		goto out_put;
	error = device_move_class_links(dev, old_parent, new_parent);
	if (error) {
		/* We ignore errors on cleanup since we're hosed anyway... */
		device_move_class_links(dev, new_parent, old_parent);
		if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1749
			if (new_parent)
1750
				klist_remove(&dev->p->knode_parent);
1751 1752
			dev->parent = old_parent;
			if (old_parent) {
1753 1754
				klist_add_tail(&dev->p->knode_parent,
					       &old_parent->p->klist_children);
1755 1756
				set_dev_node(dev, dev_to_node(old_parent));
			}
1757
		}
1758
		cleanup_glue_dir(dev, new_parent_kobj);
1759 1760 1761
		put_device(new_parent);
		goto out;
	}
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
	switch (dpm_order) {
	case DPM_ORDER_NONE:
		break;
	case DPM_ORDER_DEV_AFTER_PARENT:
		device_pm_move_after(dev, new_parent);
		break;
	case DPM_ORDER_PARENT_BEFORE_DEV:
		device_pm_move_before(new_parent, dev);
		break;
	case DPM_ORDER_DEV_LAST:
		device_pm_move_last(dev);
		break;
	}
1775 1776 1777
out_put:
	put_device(old_parent);
out:
1778
	device_pm_unlock();
1779 1780 1781 1782
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
1783 1784 1785 1786 1787 1788

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
	struct device *dev;

	spin_lock(&devices_kset->list_lock);
	/*
	 * Walk the devices list backward, shutting down each in turn.
	 * Beware that device unplug events may also start pulling
	 * devices offline, even as the system is shutting down.
	 */
	while (!list_empty(&devices_kset->list)) {
		dev = list_entry(devices_kset->list.prev, struct device,
				kobj.entry);
		get_device(dev);
		/*
		 * Make sure the device is off the kset list, in the
		 * event that dev->*->shutdown() doesn't remove it.
		 */
		list_del_init(&dev->kobj.entry);
		spin_unlock(&devices_kset->list_lock);
1807 1808 1809 1810 1811 1812 1813 1814

		if (dev->bus && dev->bus->shutdown) {
			dev_dbg(dev, "shutdown\n");
			dev->bus->shutdown(dev);
		} else if (dev->driver && dev->driver->shutdown) {
			dev_dbg(dev, "shutdown\n");
			dev->driver->shutdown(dev);
		}
1815 1816 1817
		put_device(dev);

		spin_lock(&devices_kset->list_lock);
1818
	}
1819
	spin_unlock(&devices_kset->list_lock);
1820
	async_synchronize_full();
1821
}