core.c 46.1 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>
25
#include <linux/pm_runtime.h>
L
Linus Torvalds 已提交
26 27 28 29

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

30 31 32 33 34 35 36 37 38 39 40 41 42
#ifdef CONFIG_SYSFS_DEPRECATED
#ifdef CONFIG_SYSFS_DEPRECATED_V2
long sysfs_deprecated = 1;
#else
long sysfs_deprecated = 0;
#endif
static __init int sysfs_deprecated_setup(char *arg)
{
	return strict_strtol(arg, 10, &sysfs_deprecated);
}
early_param("sysfs.deprecated", sysfs_deprecated_setup);
#endif

43 44
int (*platform_notify)(struct device *dev) = NULL;
int (*platform_notify_remove)(struct device *dev) = NULL;
45 46 47
static struct kobject *dev_kobj;
struct kobject *sysfs_dev_char_kobj;
struct kobject *sysfs_dev_block_kobj;
L
Linus Torvalds 已提交
48

49 50 51 52 53 54 55 56 57 58 59
#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 已提交
60

61 62 63 64 65 66 67 68 69
/**
 * 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.
 */
70
const char *dev_driver_string(const struct device *dev)
71
{
72 73 74 75 76 77 78 79
	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 :
80 81
			(dev->bus ? dev->bus->name :
			(dev->class ? dev->class->name : ""));
82
}
M
Matthew Wilcox 已提交
83
EXPORT_SYMBOL(dev_driver_string);
84

L
Linus Torvalds 已提交
85 86 87
#define to_dev(obj) container_of(obj, struct device, kobj)
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

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

	if (dev_attr->show)
96
		ret = dev_attr->show(dev, dev_attr, buf);
97 98 99 100
	if (ret >= (ssize_t)PAGE_SIZE) {
		print_symbol("dev_attr_show: %s returned bad count\n",
				(unsigned long)dev_attr->show);
	}
L
Linus Torvalds 已提交
101 102 103
	return ret;
}

104 105
static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
			      const char *buf, size_t count)
L
Linus Torvalds 已提交
106
{
107 108
	struct device_attribute *dev_attr = to_dev_attr(attr);
	struct device *dev = to_dev(kobj);
109
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
110 111

	if (dev_attr->store)
112
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
113 114 115
	return ret;
}

116
static const struct sysfs_ops dev_sysfs_ops = {
L
Linus Torvalds 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129
	.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.
 */
130
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
131
{
132
	struct device *dev = to_dev(kobj);
133
	struct device_private *p = dev->p;
L
Linus Torvalds 已提交
134 135 136

	if (dev->release)
		dev->release(dev);
137 138
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
139 140
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
141 142
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
143
			"function, it is broken and must be fixed.\n",
144
			dev_name(dev));
145
	kfree(p);
L
Linus Torvalds 已提交
146 147
}

148 149 150 151 152 153 154 155 156 157 158
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;
}

159
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
160 161
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
162
	.namespace	= device_namespace,
L
Linus Torvalds 已提交
163 164 165
};


166
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
167 168 169
{
	struct kobj_type *ktype = get_ktype(kobj);

170
	if (ktype == &device_ktype) {
L
Linus Torvalds 已提交
171 172 173
		struct device *dev = to_dev(kobj);
		if (dev->bus)
			return 1;
174 175
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
176 177 178 179
	}
	return 0;
}

180
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
181 182 183
{
	struct device *dev = to_dev(kobj);

184 185 186 187 188
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
189 190
}

191 192
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
193 194 195 196
{
	struct device *dev = to_dev(kobj);
	int retval = 0;

197
	/* add device node properties if present */
198
	if (MAJOR(dev->devt)) {
199 200
		const char *tmp;
		const char *name;
201
		mode_t mode = 0;
202

203 204
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
205
		name = device_get_devnode(dev, &mode, &tmp);
206 207 208
		if (name) {
			add_uevent_var(env, "DEVNAME=%s", name);
			kfree(tmp);
209 210
			if (mode)
				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
211
		}
212 213
	}

214
	if (dev->type && dev->type->name)
215
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
216

217
	if (dev->driver)
218
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
219

220
	/* have the bus specific function add its stuff */
221
	if (dev->bus && dev->bus->uevent) {
222
		retval = dev->bus->uevent(dev, env);
223
		if (retval)
224
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
225
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
226 227
	}

228
	/* have the class specific function add its stuff */
229
	if (dev->class && dev->class->dev_uevent) {
230
		retval = dev->class->dev_uevent(dev, env);
231
		if (retval)
232
			pr_debug("device: '%s': %s: class uevent() "
233
				 "returned %d\n", dev_name(dev),
234
				 __func__, retval);
235 236
	}

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

L
Linus Torvalds 已提交
246 247 248
	return retval;
}

249
static const struct kset_uevent_ops device_uevent_ops = {
250 251 252
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
253 254
};

255 256 257 258 259
static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
260
	struct kobj_uevent_env *env = NULL;
261 262 263 264 265 266
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
267 268
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
269 270
	if (!top_kobj->kset)
		goto out;
271

272 273 274 275 276 277 278 279 280
	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;

281 282
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
283 284
		return -ENOMEM;

285
	/* let the kset specific function add its keys */
286
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
287 288 289 290
	if (retval)
		goto out;

	/* copy keys to file */
291 292
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
293
out:
294
	kfree(env);
295 296 297
	return count;
}

298 299 300
static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
301 302
	enum kobject_action action;

303
	if (kobject_action_type(buf, count, &action) == 0)
304
		kobject_uevent(&dev->kobj, action);
305 306
	else
		dev_err(dev, "uevent: unknown action-string\n");
307 308 309
	return count;
}

310 311 312
static struct device_attribute uevent_attr =
	__ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);

313 314
static int device_add_attributes(struct device *dev,
				 struct device_attribute *attrs)
315
{
316
	int error = 0;
317
	int i;
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341

	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]);
}

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
static int device_add_bin_attributes(struct device *dev,
				     struct bin_attribute *attrs)
{
	int error = 0;
	int i;

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

static void device_remove_bin_attributes(struct device *dev,
					 struct bin_attribute *attrs)
{
	int i;

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

371
static int device_add_groups(struct device *dev,
372
			     const struct attribute_group **groups)
373
{
374
	int error = 0;
375
	int i;
376

377 378 379
	if (groups) {
		for (i = 0; groups[i]; i++) {
			error = sysfs_create_group(&dev->kobj, groups[i]);
380 381
			if (error) {
				while (--i >= 0)
382 383
					sysfs_remove_group(&dev->kobj,
							   groups[i]);
384
				break;
385 386 387 388 389 390
			}
		}
	}
	return error;
}

391
static void device_remove_groups(struct device *dev,
392
				 const struct attribute_group **groups)
393 394
{
	int i;
395 396 397 398

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

401 402 403
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
404
	const struct device_type *type = dev->type;
405
	int error;
406

407 408
	if (class) {
		error = device_add_attributes(dev, class->dev_attrs);
409
		if (error)
410
			return error;
411 412 413
		error = device_add_bin_attributes(dev, class->dev_bin_attrs);
		if (error)
			goto err_remove_class_attrs;
414
	}
415

416 417
	if (type) {
		error = device_add_groups(dev, type->groups);
418
		if (error)
419
			goto err_remove_class_bin_attrs;
420 421
	}

422 423 424 425 426 427 428 429 430
	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);
431 432 433
 err_remove_class_bin_attrs:
	if (class)
		device_remove_bin_attributes(dev, class->dev_bin_attrs);
434 435 436 437
 err_remove_class_attrs:
	if (class)
		device_remove_attributes(dev, class->dev_attrs);

438 439 440 441 442 443
	return error;
}

static void device_remove_attrs(struct device *dev)
{
	struct class *class = dev->class;
444
	const struct device_type *type = dev->type;
445

446
	device_remove_groups(dev, dev->groups);
447

448 449 450
	if (type)
		device_remove_groups(dev, type->groups);

451
	if (class) {
452
		device_remove_attributes(dev, class->dev_attrs);
453 454
		device_remove_bin_attributes(dev, class->dev_bin_attrs);
	}
455 456 457
}


458 459 460 461 462 463
static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}

464 465 466
static struct device_attribute devt_attr =
	__ATTR(dev, S_IRUGO, show_dev, NULL);

467 468
/* kset to create /sys/devices/  */
struct kset *devices_kset;
L
Linus Torvalds 已提交
469 470

/**
471 472 473
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
474
 */
475 476
int device_create_file(struct device *dev,
		       const struct device_attribute *attr)
L
Linus Torvalds 已提交
477 478
{
	int error = 0;
479
	if (dev)
L
Linus Torvalds 已提交
480 481 482 483 484
		error = sysfs_create_file(&dev->kobj, &attr->attr);
	return error;
}

/**
485 486 487
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
488
 */
489 490
void device_remove_file(struct device *dev,
			const struct device_attribute *attr)
L
Linus Torvalds 已提交
491
{
492
	if (dev)
L
Linus Torvalds 已提交
493 494 495
		sysfs_remove_file(&dev->kobj, &attr->attr);
}

496 497 498 499 500
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
501 502
int device_create_bin_file(struct device *dev,
			   const struct bin_attribute *attr)
503 504 505 506 507 508 509 510 511 512 513 514 515
{
	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.
 */
516 517
void device_remove_bin_file(struct device *dev,
			    const struct bin_attribute *attr)
518 519 520 521 522 523
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

524
/**
525
 * device_schedule_callback_owner - helper to schedule a callback for a device
526 527
 * @dev: device.
 * @func: callback function to invoke later.
528
 * @owner: module owning the callback routine
529 530 531 532 533 534 535 536 537 538
 *
 * 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.
 *
539 540 541
 * This routine is usually called via the inline device_schedule_callback(),
 * which automatically sets @owner to THIS_MODULE.
 *
542
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
543
 * be allocated, -ENODEV if a reference to @owner isn't available.
544 545 546 547 548
 *
 * 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.
 */
549 550
int device_schedule_callback_owner(struct device *dev,
		void (*func)(struct device *), struct module *owner)
551 552
{
	return sysfs_schedule_callback(&dev->kobj,
553
			(void (*)(void *)) func, dev, owner);
554
}
555
EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
556

557 558
static void klist_children_get(struct klist_node *n)
{
559 560
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
561 562 563 564 565 566

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
567 568
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
569 570 571 572

	put_device(dev);
}

L
Linus Torvalds 已提交
573
/**
574 575
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
576
 *
577 578
 * This prepares the device for use by other layers by initializing
 * its fields.
579
 * It is the first half of device_register(), if called by
580 581 582 583 584 585 586
 * 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 已提交
587 588 589
 */
void device_initialize(struct device *dev)
{
590
	dev->kobj.kset = devices_kset;
591
	kobject_init(&dev->kobj, &device_ktype);
L
Linus Torvalds 已提交
592
	INIT_LIST_HEAD(&dev->dma_pools);
593
	mutex_init(&dev->mutex);
594
	lockdep_set_novalidate_class(&dev->mutex);
T
Tejun Heo 已提交
595 596
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
597
	device_pm_init(dev);
598
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
599 600
}

601
static struct kobject *virtual_device_parent(struct device *dev)
602
{
603
	static struct kobject *virtual_dir = NULL;
604

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

609
	return virtual_dir;
610 611
}

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
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)
627
{
628 629 630 631 632 633 634 635 636 637 638 639 640 641
	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;
642 643
	int retval;

644 645 646 647 648 649 650
	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
	if (!dir)
		return NULL;

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

651
	dir->kobj.kset = &class->p->glue_dirs;
652 653 654 655 656 657 658 659 660 661 662 663 664

	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)
{
665
	if (dev->class) {
666
		static DEFINE_MUTEX(gdp_mutex);
667 668 669 670
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

671
#ifdef CONFIG_BLOCK
672
		/* block disks show up in /sys/block */
673
		if (sysfs_deprecated && dev->class == &block_class) {
674 675
			if (parent && parent->class == &block_class)
				return &parent->kobj;
676
			return &block_class.p->subsys.kobj;
677
		}
678
#endif
679

680 681
		/*
		 * If we have no parent, we live in "virtual".
682 683
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
684 685 686
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
687
		else if (parent->class && !dev->class->ns_type)
688 689 690 691
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

692 693
		mutex_lock(&gdp_mutex);

694
		/* find our class-directory at the parent and reference it */
695 696
		spin_lock(&dev->class->p->glue_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
697 698 699 700
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
701
		spin_unlock(&dev->class->p->glue_dirs.list_lock);
702 703
		if (kobj) {
			mutex_unlock(&gdp_mutex);
704
			return kobj;
705
		}
706 707

		/* or create a new class-directory at the parent device */
708
		k = class_dir_create_and_add(dev->class, parent_kobj);
709
		/* do not emit an uevent for this simple "glue" directory */
710
		mutex_unlock(&gdp_mutex);
711
		return k;
712 713 714
	}

	if (parent)
715 716 717
		return &parent->kobj;
	return NULL;
}
718

719
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
720
{
721
	/* see if we live in a "glue" directory */
722
	if (!glue_dir || !dev->class ||
723
	    glue_dir->kset != &dev->class->p->glue_dirs)
724 725
		return;

726
	kobject_put(glue_dir);
727
}
728 729 730 731 732

static void cleanup_device_parent(struct device *dev)
{
	cleanup_glue_dir(dev, dev->kobj.parent);
}
733

734
static void setup_parent(struct device *dev, struct device *parent)
735 736 737 738 739
{
	struct kobject *kobj;
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
740 741
}

742 743 744 745 746 747
static int device_add_class_symlinks(struct device *dev)
{
	int error;

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

749
	error = sysfs_create_link(&dev->kobj,
750
				  &dev->class->p->subsys.kobj,
751 752 753
				  "subsystem");
	if (error)
		goto out;
754

755
	if (dev->parent && device_is_not_partition(dev)) {
756
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
757 758
					  "device");
		if (error)
759
			goto out_subsys;
760 761
	}

762
#ifdef CONFIG_BLOCK
763
	/* /sys/block has directories and does not need symlinks */
764
	if (sysfs_deprecated && dev->class == &block_class)
765
		return 0;
766
#endif
767

768
	/* link in the class directory pointing to the device */
769
	error = sysfs_create_link(&dev->class->p->subsys.kobj,
770
				  &dev->kobj, dev_name(dev));
771
	if (error)
772
		goto out_device;
773 774 775

	return 0;

776 777
out_device:
	sysfs_remove_link(&dev->kobj, "device");
778

779 780 781 782 783 784 785 786 787 788
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
out:
	return error;
}

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

790
	if (dev->parent && device_is_not_partition(dev))
791
		sysfs_remove_link(&dev->kobj, "device");
792
	sysfs_remove_link(&dev->kobj, "subsystem");
793
#ifdef CONFIG_BLOCK
794
	if (sysfs_deprecated && dev->class == &block_class)
795
		return;
796
#endif
797
	sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
798 799
}

800 801 802
/**
 * dev_set_name - set a device name
 * @dev: device
803
 * @fmt: format string for the device's name
804 805 806 807
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;
808
	int err;
809 810

	va_start(vargs, fmt);
811
	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
812
	va_end(vargs);
813
	return err;
814 815 816
}
EXPORT_SYMBOL_GPL(dev_set_name);

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
/**
 * 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);
	}
}

865 866 867 868 869 870 871 872 873 874 875
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 已提交
876
/**
877 878
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
879
 *
880 881
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
882
 *
883
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
884 885
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
886 887 888 889
 *
 * 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 已提交
890 891 892 893
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
894
	struct class_interface *class_intf;
895
	int error = -EINVAL;
896

L
Linus Torvalds 已提交
897
	dev = get_device(dev);
898 899 900
	if (!dev)
		goto done;

901
	if (!dev->p) {
902 903 904
		error = device_private_init(dev);
		if (error)
			goto done;
905 906
	}

907 908 909 910 911 912
	/*
	 * 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) {
913
		dev_set_name(dev, "%s", dev->init_name);
914 915
		dev->init_name = NULL;
	}
916

917 918
	if (!dev_name(dev)) {
		error = -EINVAL;
919
		goto name_error;
920
	}
L
Linus Torvalds 已提交
921

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

L
Linus Torvalds 已提交
924
	parent = get_device(dev->parent);
925
	setup_parent(dev, parent);
L
Linus Torvalds 已提交
926

927 928 929 930
	/* use parent numa_node */
	if (parent)
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
931
	/* first, register with generic layer. */
932 933
	/* we require the name to be set before, and pass NULL */
	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
934
	if (error)
L
Linus Torvalds 已提交
935
		goto Error;
936

937 938 939 940
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

941
	error = device_create_file(dev, &uevent_attr);
942 943
	if (error)
		goto attrError;
944

945
	if (MAJOR(dev->devt)) {
946 947
		error = device_create_file(dev, &devt_attr);
		if (error)
948
			goto ueventattrError;
949 950 951 952

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto devtattrError;
953 954

		devtmpfs_create_node(dev);
955 956
	}

957 958 959
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
960 961
	error = device_add_attrs(dev);
	if (error)
962
		goto AttrsError;
963 964
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
965
		goto BusError;
966
	error = dpm_sysfs_add(dev);
967
	if (error)
968 969
		goto DPMError;
	device_pm_add(dev);
970 971 972 973 974 975 976 977

	/* 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);

978
	kobject_uevent(&dev->kobj, KOBJ_ADD);
979
	bus_probe_device(dev);
L
Linus Torvalds 已提交
980
	if (parent)
981 982
		klist_add_tail(&dev->p->knode_parent,
			       &parent->p->klist_children);
L
Linus Torvalds 已提交
983

984
	if (dev->class) {
985
		mutex_lock(&dev->class->p->class_mutex);
986
		/* tie the class to the device */
987
		klist_add_tail(&dev->knode_class,
988
			       &dev->class->p->klist_devices);
989 990

		/* notify any interfaces that the device is here */
991 992
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
993 994
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
995
		mutex_unlock(&dev->class->p->class_mutex);
996
	}
997
done:
L
Linus Torvalds 已提交
998 999
	put_device(dev);
	return error;
1000
 DPMError:
1001 1002
	bus_remove_device(dev);
 BusError:
1003
	device_remove_attrs(dev);
1004
 AttrsError:
1005 1006
	device_remove_class_symlinks(dev);
 SymlinkError:
1007 1008
	if (MAJOR(dev->devt))
		devtmpfs_delete_node(dev);
1009 1010 1011
	if (MAJOR(dev->devt))
		device_remove_sys_dev_entry(dev);
 devtattrError:
1012 1013
	if (MAJOR(dev->devt))
		device_remove_file(dev, &devt_attr);
1014
 ueventattrError:
1015
	device_remove_file(dev, &uevent_attr);
1016
 attrError:
1017
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
1018 1019
	kobject_del(&dev->kobj);
 Error:
1020
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1021 1022
	if (parent)
		put_device(parent);
1023 1024 1025
name_error:
	kfree(dev->p);
	dev->p = NULL;
1026
	goto done;
L
Linus Torvalds 已提交
1027 1028 1029
}

/**
1030 1031
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
1032
 *
1033 1034 1035 1036 1037 1038
 * 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.
1039 1040 1041 1042
 *
 * 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 已提交
1043 1044 1045 1046 1047 1048 1049 1050
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}

/**
1051 1052
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
1053
 *
1054 1055 1056
 * 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 已提交
1057
 */
1058
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
1059 1060 1061 1062 1063
{
	return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
}

/**
1064 1065
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1066
 */
1067
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1068
{
1069
	/* might_sleep(); */
L
Linus Torvalds 已提交
1070 1071 1072 1073 1074
	if (dev)
		kobject_put(&dev->kobj);
}

/**
1075 1076
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1077
 *
1078 1079 1080 1081 1082
 * 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 已提交
1083
 *
1084 1085
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1086
 */
1087
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1088
{
1089
	struct device *parent = dev->parent;
1090
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1091

1092 1093 1094 1095 1096 1097
	/* 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);
1098
	device_pm_remove(dev);
1099
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1100
	if (parent)
1101
		klist_del(&dev->p->knode_parent);
1102
	if (MAJOR(dev->devt)) {
1103
		devtmpfs_delete_node(dev);
1104
		device_remove_sys_dev_entry(dev);
1105
		device_remove_file(dev, &devt_attr);
1106
	}
1107
	if (dev->class) {
1108
		device_remove_class_symlinks(dev);
1109

1110
		mutex_lock(&dev->class->p->class_mutex);
1111
		/* notify any interfaces that the device is now gone */
1112 1113
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
1114 1115 1116
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1117
		klist_del(&dev->knode_class);
1118
		mutex_unlock(&dev->class->p->class_mutex);
1119
	}
1120
	device_remove_file(dev, &uevent_attr);
1121
	device_remove_attrs(dev);
1122
	bus_remove_device(dev);
L
Linus Torvalds 已提交
1123

1124 1125 1126 1127 1128 1129 1130
	/*
	 * 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 已提交
1131 1132 1133 1134 1135
	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1136
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1137
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1138
	kobject_del(&dev->kobj);
1139
	put_device(parent);
L
Linus Torvalds 已提交
1140 1141 1142
}

/**
1143 1144
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1145
 *
1146 1147 1148 1149 1150 1151
 * 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 已提交
1152
 */
1153
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1154
{
1155
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1156 1157 1158 1159
	device_del(dev);
	put_device(dev);
}

1160
static struct device *next_device(struct klist_iter *i)
1161
{
1162
	struct klist_node *n = klist_next(i);
1163 1164 1165 1166 1167 1168 1169 1170
	struct device *dev = NULL;
	struct device_private *p;

	if (n) {
		p = to_device_private_parent(n);
		dev = p->device;
	}
	return dev;
1171 1172
}

1173
/**
1174
 * device_get_devnode - path of device node file
1175
 * @dev: device
1176
 * @mode: returned file access mode
1177 1178 1179 1180 1181 1182 1183
 * @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.
 */
1184 1185
const char *device_get_devnode(struct device *dev,
			       mode_t *mode, const char **tmp)
1186 1187 1188 1189 1190 1191
{
	char *s;

	*tmp = NULL;

	/* the device type may provide a specific name */
1192 1193
	if (dev->type && dev->type->devnode)
		*tmp = dev->type->devnode(dev, mode);
1194 1195 1196 1197
	if (*tmp)
		return *tmp;

	/* the class may provide a specific name */
1198 1199
	if (dev->class && dev->class->devnode)
		*tmp = dev->class->devnode(dev, mode);
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
	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 已提交
1216
/**
1217 1218 1219 1220
 * 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 已提交
1221
 *
1222 1223
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1224
 *
1225 1226
 * 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 已提交
1227
 */
1228 1229
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1230
{
1231
	struct klist_iter i;
1232
	struct device *child;
L
Linus Torvalds 已提交
1233 1234
	int error = 0;

1235 1236 1237
	if (!parent->p)
		return 0;

1238
	klist_iter_init(&parent->p->klist_children, &i);
1239 1240 1241
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1242 1243 1244
	return error;
}

1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
/**
 * 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.
 */
1260 1261
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
1262 1263 1264 1265 1266 1267 1268
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

1269
	klist_iter_init(&parent->p->klist_children, &i);
1270 1271 1272 1273 1274 1275 1276
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}

L
Linus Torvalds 已提交
1277 1278
int __init devices_init(void)
{
1279 1280 1281
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
	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;

1292
	return 0;
1293 1294 1295 1296 1297 1298 1299 1300

 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 已提交
1301 1302 1303
}

EXPORT_SYMBOL_GPL(device_for_each_child);
1304
EXPORT_SYMBOL_GPL(device_find_child);
L
Linus Torvalds 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316

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);
1317

1318
struct root_device {
1319 1320 1321 1322
	struct device dev;
	struct module *owner;
};

1323 1324 1325 1326
inline struct root_device *to_root_device(struct device *d)
{
	return container_of(d, struct root_device, dev);
}
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350

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.
 *
1351 1352
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
 * 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);

1364
	err = dev_set_name(&root->dev, "%s", name);
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
	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);
	}

1378
#ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
	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
1397
 * @dev: device going away
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
 *
 * 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);

1413 1414 1415

static void device_create_release(struct device *dev)
{
1416
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1417 1418 1419 1420
	kfree(dev);
}

/**
1421
 * device_create_vargs - creates a device and registers it with sysfs
1422 1423 1424
 * @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
1425
 * @drvdata: the data to be added to the device for callbacks
1426
 * @fmt: string for the device's name
1427
 * @args: va_list for the device's name
1428 1429 1430
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
1431 1432 1433
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
1434 1435 1436 1437
 * 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
1438 1439
 * pointer.
 *
1440 1441
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1442 1443 1444
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1445 1446 1447
struct device *device_create_vargs(struct class *class, struct device *parent,
				   dev_t devt, void *drvdata, const char *fmt,
				   va_list args)
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
{
	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;
1465
	dev_set_drvdata(dev, drvdata);
1466

1467 1468 1469 1470
	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
	if (retval)
		goto error;

1471 1472 1473 1474 1475 1476 1477
	retval = device_register(dev);
	if (retval)
		goto error;

	return dev;

error:
1478
	put_device(dev);
1479 1480
	return ERR_PTR(retval);
}
1481 1482 1483
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
1484
 * device_create - creates a device and registers it with sysfs
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
 * @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.
 *
1502 1503
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1504 1505 1506
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1507 1508
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
1509 1510 1511 1512 1513 1514 1515 1516 1517
{
	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;
}
1518
EXPORT_SYMBOL_GPL(device_create);
1519

1520
static int __match_devt(struct device *dev, void *data)
1521
{
1522
	dev_t *devt = data;
1523

1524
	return dev->devt == *devt;
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
}

/**
 * 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;
1538

1539
	dev = class_find_device(class, NULL, &devt, __match_devt);
1540 1541
	if (dev) {
		put_device(dev);
1542
		device_unregister(dev);
1543
	}
1544 1545
}
EXPORT_SYMBOL_GPL(device_destroy);
1546 1547 1548 1549 1550

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
1551 1552 1553 1554 1555
 *
 * 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.
1556
 *
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
 * Note: Don't call this function.  Currently, the networking layer calls this
 * function, but that will change.  The following text from Kay Sievers offers
 * some insight:
 *
 * Renaming devices is racy at many levels, symlinks and other stuff are not
 * replaced atomically, and you get a "move" uevent, but it's not easy to
 * connect the event to the old and new device. Device nodes are not renamed at
 * all, there isn't even support for that in the kernel now.
 *
 * In the meantime, during renaming, your target name might be taken by another
 * driver, creating conflicts. Or the old name is taken directly after you
 * renamed it -- then you get events for the same DEVPATH, before you even see
 * the "move" event. It's just a mess, and nothing new should ever rely on
 * kernel device renaming. Besides that, it's not even implemented now for
 * other things than (driver-core wise very simple) network devices.
 *
 * We are currently about to change network renaming in udev to completely
 * disallow renaming of devices in the same namespace as the kernel uses,
 * because we can't solve the problems properly, that arise with swapping names
 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
 * be allowed to some other name than eth[0-9]*, for the aforementioned
 * reasons.
 *
 * Make up a "real" name in the driver before you register anything, or add
 * some other attributes for userspace to find the device, or use udev to add
 * symlinks -- but never rename kernel devices later, it's a complete mess. We
 * don't even want to get into that and try to implement the missing pieces in
 * the core. We really have other pieces to fix in the driver core mess. :)
1585
 */
1586
int device_rename(struct device *dev, const char *new_name)
1587 1588 1589
{
	char *old_class_name = NULL;
	char *new_class_name = NULL;
1590
	char *old_device_name = NULL;
1591 1592 1593 1594 1595 1596
	int error;

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

1597
	pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1598
		 __func__, new_name);
1599

1600
	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1601 1602 1603
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
1604 1605
	}

1606
	if (dev->class) {
1607
		error = sysfs_rename_link(&dev->class->p->subsys.kobj,
1608 1609 1610 1611
			&dev->kobj, old_device_name, new_name);
		if (error)
			goto out;
	}
1612

1613
	error = kobject_rename(&dev->kobj, new_name);
1614
	if (error)
1615
		goto out;
1616

1617
out:
1618 1619 1620
	put_device(dev);

	kfree(new_class_name);
1621
	kfree(old_class_name);
1622
	kfree(old_device_name);
1623 1624 1625

	return error;
}
1626
EXPORT_SYMBOL_GPL(device_rename);
1627 1628 1629 1630 1631

static int device_move_class_links(struct device *dev,
				   struct device *old_parent,
				   struct device *new_parent)
{
1632
	int error = 0;
1633

1634 1635 1636 1637 1638 1639
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
1640 1641 1642 1643 1644
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1645
 * @new_parent: the new parent of the device (can by NULL)
1646
 * @dpm_order: how to reorder the dpm_list
1647
 */
1648 1649
int device_move(struct device *dev, struct device *new_parent,
		enum dpm_order dpm_order)
1650 1651 1652
{
	int error;
	struct device *old_parent;
1653
	struct kobject *new_parent_kobj;
1654 1655 1656 1657 1658

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

1659
	device_pm_lock();
1660
	new_parent = get_device(new_parent);
1661
	new_parent_kobj = get_device_parent(dev, new_parent);
1662

1663 1664
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1665
	error = kobject_move(&dev->kobj, new_parent_kobj);
1666
	if (error) {
1667
		cleanup_glue_dir(dev, new_parent_kobj);
1668 1669 1670 1671 1672 1673
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1674
		klist_remove(&dev->p->knode_parent);
1675
	if (new_parent) {
1676 1677
		klist_add_tail(&dev->p->knode_parent,
			       &new_parent->p->klist_children);
1678 1679 1680
		set_dev_node(dev, dev_to_node(new_parent));
	}

1681 1682 1683 1684 1685 1686 1687
	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)) {
1688
			if (new_parent)
1689
				klist_remove(&dev->p->knode_parent);
1690 1691
			dev->parent = old_parent;
			if (old_parent) {
1692 1693
				klist_add_tail(&dev->p->knode_parent,
					       &old_parent->p->klist_children);
1694 1695
				set_dev_node(dev, dev_to_node(old_parent));
			}
1696
		}
1697
		cleanup_glue_dir(dev, new_parent_kobj);
1698 1699 1700
		put_device(new_parent);
		goto out;
	}
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
	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;
	}
1714 1715 1716
out_put:
	put_device(old_parent);
out:
1717
	device_pm_unlock();
1718 1719 1720 1721
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
1722 1723 1724 1725 1726 1727

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
	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);
1746 1747 1748 1749

		/* Don't allow any more runtime suspends */
		pm_runtime_get_noresume(dev);
		pm_runtime_barrier(dev);
1750 1751 1752 1753 1754 1755 1756 1757

		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);
		}
1758 1759 1760
		put_device(dev);

		spin_lock(&devices_kset->list_lock);
1761
	}
1762
	spin_unlock(&devices_kset->list_lock);
1763
	async_synchronize_full();
1764
}
1765 1766 1767 1768 1769 1770 1771

/*
 * Device logging functions
 */

#ifdef CONFIG_PRINTK

1772 1773
int __dev_printk(const char *level, const struct device *dev,
		 struct va_format *vaf)
1774 1775 1776 1777 1778 1779 1780
{
	if (!dev)
		return printk("%s(NULL device *): %pV", level, vaf);

	return printk("%s%s %s: %pV",
		      level, dev_driver_string(dev), dev_name(dev), vaf);
}
1781
EXPORT_SYMBOL(__dev_printk);
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829

int dev_printk(const char *level, const struct device *dev,
	       const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;
	int r;

	va_start(args, fmt);

	vaf.fmt = fmt;
	vaf.va = &args;

	r = __dev_printk(level, dev, &vaf);
	va_end(args);

	return r;
}
EXPORT_SYMBOL(dev_printk);

#define define_dev_printk_level(func, kern_level)		\
int func(const struct device *dev, const char *fmt, ...)	\
{								\
	struct va_format vaf;					\
	va_list args;						\
	int r;							\
								\
	va_start(args, fmt);					\
								\
	vaf.fmt = fmt;						\
	vaf.va = &args;						\
								\
	r = __dev_printk(kern_level, dev, &vaf);		\
	va_end(args);						\
								\
	return r;						\
}								\
EXPORT_SYMBOL(func);

define_dev_printk_level(dev_emerg, KERN_EMERG);
define_dev_printk_level(dev_alert, KERN_ALERT);
define_dev_printk_level(dev_crit, KERN_CRIT);
define_dev_printk_level(dev_err, KERN_ERR);
define_dev_printk_level(dev_warn, KERN_WARNING);
define_dev_printk_level(dev_notice, KERN_NOTICE);
define_dev_printk_level(_dev_info, KERN_INFO);

#endif