core.c 50.2 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 22
#include <linux/of.h>
#include <linux/of_device.h>
23
#include <linux/genhd.h>
24
#include <linux/kallsyms.h>
25
#include <linux/mutex.h>
26
#include <linux/async.h>
27
#include <linux/pm_runtime.h>
28
#include <linux/netdevice.h>
L
Linus Torvalds 已提交
29 30 31 32

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

33 34 35 36 37 38 39 40 41 42 43 44 45
#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

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

52 53 54 55 56 57 58 59 60 61 62
#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 已提交
63

64 65 66 67 68
/**
 * 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
Y
yan 已提交
69
 * the device is not bound to a driver, it will return the name of the bus
70 71 72
 * it is attached to.  If it is not attached to a bus either, an empty
 * string will be returned.
 */
73
const char *dev_driver_string(const struct device *dev)
74
{
75 76 77 78 79 80 81 82
	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 :
83 84
			(dev->bus ? dev->bus->name :
			(dev->class ? dev->class->name : ""));
85
}
M
Matthew Wilcox 已提交
86
EXPORT_SYMBOL(dev_driver_string);
87

L
Linus Torvalds 已提交
88 89
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

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

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

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

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

118
static const struct sysfs_ops dev_sysfs_ops = {
L
Linus Torvalds 已提交
119 120 121 122
	.show	= dev_attr_show,
	.store	= dev_attr_store,
};

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)

ssize_t device_store_ulong(struct device *dev,
			   struct device_attribute *attr,
			   const char *buf, size_t size)
{
	struct dev_ext_attribute *ea = to_ext_attr(attr);
	char *end;
	unsigned long new = simple_strtoul(buf, &end, 0);
	if (end == buf)
		return -EINVAL;
	*(unsigned long *)(ea->var) = new;
	/* Always return full write size even if we didn't consume all */
	return size;
}
EXPORT_SYMBOL_GPL(device_store_ulong);

ssize_t device_show_ulong(struct device *dev,
			  struct device_attribute *attr,
			  char *buf)
{
	struct dev_ext_attribute *ea = to_ext_attr(attr);
	return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
}
EXPORT_SYMBOL_GPL(device_show_ulong);

ssize_t device_store_int(struct device *dev,
			 struct device_attribute *attr,
			 const char *buf, size_t size)
{
	struct dev_ext_attribute *ea = to_ext_attr(attr);
	char *end;
	long new = simple_strtol(buf, &end, 0);
	if (end == buf || new > INT_MAX || new < INT_MIN)
		return -EINVAL;
	*(int *)(ea->var) = new;
	/* Always return full write size even if we didn't consume all */
	return size;
}
EXPORT_SYMBOL_GPL(device_store_int);

ssize_t device_show_int(struct device *dev,
			struct device_attribute *attr,
			char *buf)
{
	struct dev_ext_attribute *ea = to_ext_attr(attr);

	return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
}
EXPORT_SYMBOL_GPL(device_show_int);
L
Linus Torvalds 已提交
173 174 175 176 177 178 179 180 181

/**
 *	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.
 */
182
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
183
{
184
	struct device *dev = kobj_to_dev(kobj);
185
	struct device_private *p = dev->p;
L
Linus Torvalds 已提交
186 187 188

	if (dev->release)
		dev->release(dev);
189 190
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
191 192
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
193 194
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
195
			"function, it is broken and must be fixed.\n",
196
			dev_name(dev));
197
	kfree(p);
L
Linus Torvalds 已提交
198 199
}

200 201
static const void *device_namespace(struct kobject *kobj)
{
202
	struct device *dev = kobj_to_dev(kobj);
203 204 205 206 207 208 209 210
	const void *ns = NULL;

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

	return ns;
}

211
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
212 213
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
214
	.namespace	= device_namespace,
L
Linus Torvalds 已提交
215 216 217
};


218
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
219 220 221
{
	struct kobj_type *ktype = get_ktype(kobj);

222
	if (ktype == &device_ktype) {
223
		struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
224 225
		if (dev->bus)
			return 1;
226 227
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
228 229 230 231
	}
	return 0;
}

232
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
233
{
234
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
235

236 237 238 239 240
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
241 242
}

243 244
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
245
{
246
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
247 248
	int retval = 0;

249
	/* add device node properties if present */
250
	if (MAJOR(dev->devt)) {
251 252
		const char *tmp;
		const char *name;
253
		umode_t mode = 0;
254

255 256
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
257
		name = device_get_devnode(dev, &mode, &tmp);
258 259 260
		if (name) {
			add_uevent_var(env, "DEVNAME=%s", name);
			kfree(tmp);
261 262
			if (mode)
				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
263
		}
264 265
	}

266
	if (dev->type && dev->type->name)
267
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
268

269
	if (dev->driver)
270
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
271

272 273 274
	/* Add common DT information about the device */
	of_device_uevent(dev, env);

275
	/* have the bus specific function add its stuff */
276
	if (dev->bus && dev->bus->uevent) {
277
		retval = dev->bus->uevent(dev, env);
278
		if (retval)
279
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
280
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
281 282
	}

283
	/* have the class specific function add its stuff */
284
	if (dev->class && dev->class->dev_uevent) {
285
		retval = dev->class->dev_uevent(dev, env);
286
		if (retval)
287
			pr_debug("device: '%s': %s: class uevent() "
288
				 "returned %d\n", dev_name(dev),
289
				 __func__, retval);
290 291
	}

292
	/* have the device type specific function add its stuff */
293
	if (dev->type && dev->type->uevent) {
294
		retval = dev->type->uevent(dev, env);
295
		if (retval)
296
			pr_debug("device: '%s': %s: dev_type uevent() "
297
				 "returned %d\n", dev_name(dev),
298
				 __func__, retval);
299 300
	}

L
Linus Torvalds 已提交
301 302 303
	return retval;
}

304
static const struct kset_uevent_ops device_uevent_ops = {
305 306 307
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
308 309
};

310 311 312 313 314
static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
315
	struct kobj_uevent_env *env = NULL;
316 317 318 319 320 321
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
322 323
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
324 325
	if (!top_kobj->kset)
		goto out;
326

327 328 329 330 331 332 333 334 335
	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;

336 337
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
338 339
		return -ENOMEM;

340
	/* let the kset specific function add its keys */
341
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
342 343 344 345
	if (retval)
		goto out;

	/* copy keys to file */
346 347
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
348
out:
349
	kfree(env);
350 351 352
	return count;
}

353 354 355
static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
356 357
	enum kobject_action action;

358
	if (kobject_action_type(buf, count, &action) == 0)
359
		kobject_uevent(&dev->kobj, action);
360 361
	else
		dev_err(dev, "uevent: unknown action-string\n");
362 363 364
	return count;
}

365 366 367
static struct device_attribute uevent_attr =
	__ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);

368 369
static int device_add_attributes(struct device *dev,
				 struct device_attribute *attrs)
370
{
371
	int error = 0;
372
	int i;
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

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

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
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]);
}

426
static int device_add_groups(struct device *dev,
427
			     const struct attribute_group **groups)
428
{
429
	int error = 0;
430
	int i;
431

432 433 434
	if (groups) {
		for (i = 0; groups[i]; i++) {
			error = sysfs_create_group(&dev->kobj, groups[i]);
435 436
			if (error) {
				while (--i >= 0)
437 438
					sysfs_remove_group(&dev->kobj,
							   groups[i]);
439
				break;
440 441 442 443 444 445
			}
		}
	}
	return error;
}

446
static void device_remove_groups(struct device *dev,
447
				 const struct attribute_group **groups)
448 449
{
	int i;
450 451 452 453

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

456 457 458
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
459
	const struct device_type *type = dev->type;
460
	int error;
461

462 463
	if (class) {
		error = device_add_attributes(dev, class->dev_attrs);
464
		if (error)
465
			return error;
466 467 468
		error = device_add_bin_attributes(dev, class->dev_bin_attrs);
		if (error)
			goto err_remove_class_attrs;
469
	}
470

471 472
	if (type) {
		error = device_add_groups(dev, type->groups);
473
		if (error)
474
			goto err_remove_class_bin_attrs;
475 476
	}

477 478 479 480 481 482 483 484 485
	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);
486 487 488
 err_remove_class_bin_attrs:
	if (class)
		device_remove_bin_attributes(dev, class->dev_bin_attrs);
489 490 491 492
 err_remove_class_attrs:
	if (class)
		device_remove_attributes(dev, class->dev_attrs);

493 494 495 496 497 498
	return error;
}

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

501
	device_remove_groups(dev, dev->groups);
502

503 504 505
	if (type)
		device_remove_groups(dev, type->groups);

506
	if (class) {
507
		device_remove_attributes(dev, class->dev_attrs);
508 509
		device_remove_bin_attributes(dev, class->dev_bin_attrs);
	}
510 511 512
}


513 514 515 516 517 518
static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}

519 520 521
static struct device_attribute devt_attr =
	__ATTR(dev, S_IRUGO, show_dev, NULL);

522
/* /sys/devices/ */
523
struct kset *devices_kset;
L
Linus Torvalds 已提交
524 525

/**
526 527 528
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
529
 */
530 531
int device_create_file(struct device *dev,
		       const struct device_attribute *attr)
L
Linus Torvalds 已提交
532 533
{
	int error = 0;
534
	if (dev)
L
Linus Torvalds 已提交
535 536 537 538 539
		error = sysfs_create_file(&dev->kobj, &attr->attr);
	return error;
}

/**
540 541 542
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
543
 */
544 545
void device_remove_file(struct device *dev,
			const struct device_attribute *attr)
L
Linus Torvalds 已提交
546
{
547
	if (dev)
L
Linus Torvalds 已提交
548 549 550
		sysfs_remove_file(&dev->kobj, &attr->attr);
}

551 552 553 554 555
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
556 557
int device_create_bin_file(struct device *dev,
			   const struct bin_attribute *attr)
558 559 560 561 562 563 564 565 566 567 568 569 570
{
	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.
 */
571 572
void device_remove_bin_file(struct device *dev,
			    const struct bin_attribute *attr)
573 574 575 576 577 578
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

579
/**
580
 * device_schedule_callback_owner - helper to schedule a callback for a device
581 582
 * @dev: device.
 * @func: callback function to invoke later.
583
 * @owner: module owning the callback routine
584 585 586 587 588 589 590 591 592 593
 *
 * 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.
 *
594 595 596
 * This routine is usually called via the inline device_schedule_callback(),
 * which automatically sets @owner to THIS_MODULE.
 *
597
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
598
 * be allocated, -ENODEV if a reference to @owner isn't available.
599 600 601 602 603
 *
 * 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.
 */
604 605
int device_schedule_callback_owner(struct device *dev,
		void (*func)(struct device *), struct module *owner)
606 607
{
	return sysfs_schedule_callback(&dev->kobj,
608
			(void (*)(void *)) func, dev, owner);
609
}
610
EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
611

612 613
static void klist_children_get(struct klist_node *n)
{
614 615
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
616 617 618 619 620 621

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
622 623
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
624 625 626 627

	put_device(dev);
}

L
Linus Torvalds 已提交
628
/**
629 630
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
631
 *
632 633
 * This prepares the device for use by other layers by initializing
 * its fields.
634
 * It is the first half of device_register(), if called by
635 636 637 638 639
 * 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.
 *
640 641 642 643 644
 * All fields in @dev must be initialized by the caller to 0, except
 * for those explicitly set to some other value.  The simplest
 * approach is to use kzalloc() to allocate the structure containing
 * @dev.
 *
645 646
 * NOTE: Use put_device() to give up your reference instead of freeing
 * @dev directly once you have called this function.
L
Linus Torvalds 已提交
647 648 649
 */
void device_initialize(struct device *dev)
{
650
	dev->kobj.kset = devices_kset;
651
	kobject_init(&dev->kobj, &device_ktype);
L
Linus Torvalds 已提交
652
	INIT_LIST_HEAD(&dev->dma_pools);
653
	mutex_init(&dev->mutex);
654
	lockdep_set_novalidate_class(&dev->mutex);
T
Tejun Heo 已提交
655 656
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
657
	device_pm_init(dev);
658
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
659 660
}

661
static struct kobject *virtual_device_parent(struct device *dev)
662
{
663
	static struct kobject *virtual_dir = NULL;
664

665
	if (!virtual_dir)
666
		virtual_dir = kobject_create_and_add("virtual",
667
						     &devices_kset->kobj);
668

669
	return virtual_dir;
670 671
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
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)
687
{
688 689 690 691 692 693 694 695 696 697 698 699 700 701
	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;
702 703
	int retval;

704 705 706 707 708 709 710
	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
	if (!dir)
		return NULL;

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

711
	dir->kobj.kset = &class->p->glue_dirs;
712 713 714 715 716 717 718 719 720 721 722 723 724

	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)
{
725
	if (dev->class) {
726
		static DEFINE_MUTEX(gdp_mutex);
727 728 729 730
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

731
#ifdef CONFIG_BLOCK
732
		/* block disks show up in /sys/block */
733
		if (sysfs_deprecated && dev->class == &block_class) {
734 735
			if (parent && parent->class == &block_class)
				return &parent->kobj;
736
			return &block_class.p->subsys.kobj;
737
		}
738
#endif
739

740 741
		/*
		 * If we have no parent, we live in "virtual".
742 743
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
744 745 746
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
747
		else if (parent->class && !dev->class->ns_type)
748 749 750 751
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

752 753
		mutex_lock(&gdp_mutex);

754
		/* find our class-directory at the parent and reference it */
755 756
		spin_lock(&dev->class->p->glue_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
757 758 759 760
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
761
		spin_unlock(&dev->class->p->glue_dirs.list_lock);
762 763
		if (kobj) {
			mutex_unlock(&gdp_mutex);
764
			return kobj;
765
		}
766 767

		/* or create a new class-directory at the parent device */
768
		k = class_dir_create_and_add(dev->class, parent_kobj);
769
		/* do not emit an uevent for this simple "glue" directory */
770
		mutex_unlock(&gdp_mutex);
771
		return k;
772 773
	}

774 775 776 777
	/* subsystems can specify a default root directory for their devices */
	if (!parent && dev->bus && dev->bus->dev_root)
		return &dev->bus->dev_root->kobj;

778
	if (parent)
779 780 781
		return &parent->kobj;
	return NULL;
}
782

783
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
784
{
785
	/* see if we live in a "glue" directory */
786
	if (!glue_dir || !dev->class ||
787
	    glue_dir->kset != &dev->class->p->glue_dirs)
788 789
		return;

790
	kobject_put(glue_dir);
791
}
792 793 794 795 796

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

798 799 800 801 802 803
static int device_add_class_symlinks(struct device *dev)
{
	int error;

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

805
	error = sysfs_create_link(&dev->kobj,
806
				  &dev->class->p->subsys.kobj,
807 808 809
				  "subsystem");
	if (error)
		goto out;
810

811
	if (dev->parent && device_is_not_partition(dev)) {
812
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
813 814
					  "device");
		if (error)
815
			goto out_subsys;
816 817
	}

818
#ifdef CONFIG_BLOCK
819
	/* /sys/block has directories and does not need symlinks */
820
	if (sysfs_deprecated && dev->class == &block_class)
821
		return 0;
822
#endif
823

824
	/* link in the class directory pointing to the device */
825
	error = sysfs_create_link(&dev->class->p->subsys.kobj,
826
				  &dev->kobj, dev_name(dev));
827
	if (error)
828
		goto out_device;
829 830 831

	return 0;

832 833
out_device:
	sysfs_remove_link(&dev->kobj, "device");
834

835 836 837 838 839 840 841 842 843 844
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
out:
	return error;
}

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

846
	if (dev->parent && device_is_not_partition(dev))
847
		sysfs_remove_link(&dev->kobj, "device");
848
	sysfs_remove_link(&dev->kobj, "subsystem");
849
#ifdef CONFIG_BLOCK
850
	if (sysfs_deprecated && dev->class == &block_class)
851
		return;
852
#endif
853
	sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
854 855
}

856 857 858
/**
 * dev_set_name - set a device name
 * @dev: device
859
 * @fmt: format string for the device's name
860 861 862 863
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;
864
	int err;
865 866

	va_start(vargs, fmt);
867
	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
868
	va_end(vargs);
869
	return err;
870 871 872
}
EXPORT_SYMBOL_GPL(dev_set_name);

873 874 875 876 877 878 879 880
/**
 * 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
P
Peter Korsgaard 已提交
881 882
 * device_remove_sys_dev_entry() will disagree about the presence of
 * the link.
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 912 913 914 915 916 917 918 919 920
 */
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);
	}
}

921 922 923 924 925 926 927 928
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);
929
	INIT_LIST_HEAD(&dev->p->deferred_probe);
930 931 932
	return 0;
}

L
Linus Torvalds 已提交
933
/**
934 935
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
936
 *
937 938
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
939
 *
940
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
941 942
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
943
 *
944 945 946 947 948 949 950
 * Do not call this routine or device_register() more than once for
 * any device structure.  The driver model core is not designed to work
 * with devices that get unregistered and then spring back to life.
 * (Among other things, it's very hard to guarantee that all references
 * to the previous incarnation of @dev have been dropped.)  Allocate
 * and register a fresh new struct device instead.
 *
951 952 953
 * 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 已提交
954 955 956 957
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
958
	struct kobject *kobj;
959
	struct class_interface *class_intf;
960
	int error = -EINVAL;
961

L
Linus Torvalds 已提交
962
	dev = get_device(dev);
963 964 965
	if (!dev)
		goto done;

966
	if (!dev->p) {
967 968 969
		error = device_private_init(dev);
		if (error)
			goto done;
970 971
	}

972 973 974 975 976 977
	/*
	 * 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) {
978
		dev_set_name(dev, "%s", dev->init_name);
979 980
		dev->init_name = NULL;
	}
981

982 983 984 985
	/* subsystems can specify simple device enumeration */
	if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
		dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);

986 987
	if (!dev_name(dev)) {
		error = -EINVAL;
988
		goto name_error;
989
	}
L
Linus Torvalds 已提交
990

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

L
Linus Torvalds 已提交
993
	parent = get_device(dev->parent);
994 995 996
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
L
Linus Torvalds 已提交
997

998 999 1000 1001
	/* use parent numa_node */
	if (parent)
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
1002
	/* first, register with generic layer. */
1003 1004
	/* we require the name to be set before, and pass NULL */
	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1005
	if (error)
L
Linus Torvalds 已提交
1006
		goto Error;
1007

1008 1009 1010 1011
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

1012
	error = device_create_file(dev, &uevent_attr);
1013 1014
	if (error)
		goto attrError;
1015

1016
	if (MAJOR(dev->devt)) {
1017 1018
		error = device_create_file(dev, &devt_attr);
		if (error)
1019
			goto ueventattrError;
1020 1021 1022 1023

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto devtattrError;
1024 1025

		devtmpfs_create_node(dev);
1026 1027
	}

1028 1029 1030
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
1031 1032
	error = device_add_attrs(dev);
	if (error)
1033
		goto AttrsError;
1034 1035
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
1036
		goto BusError;
1037
	error = dpm_sysfs_add(dev);
1038
	if (error)
1039 1040
		goto DPMError;
	device_pm_add(dev);
1041 1042

	/* Notify clients of device addition.  This call must come
1043
	 * after dpm_sysfs_add() and before kobject_uevent().
1044 1045 1046 1047 1048
	 */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_ADD_DEVICE, dev);

1049
	kobject_uevent(&dev->kobj, KOBJ_ADD);
1050
	bus_probe_device(dev);
L
Linus Torvalds 已提交
1051
	if (parent)
1052 1053
		klist_add_tail(&dev->p->knode_parent,
			       &parent->p->klist_children);
L
Linus Torvalds 已提交
1054

1055
	if (dev->class) {
1056
		mutex_lock(&dev->class->p->mutex);
1057
		/* tie the class to the device */
1058
		klist_add_tail(&dev->knode_class,
1059
			       &dev->class->p->klist_devices);
1060 1061

		/* notify any interfaces that the device is here */
1062
		list_for_each_entry(class_intf,
1063
				    &dev->class->p->interfaces, node)
1064 1065
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
1066
		mutex_unlock(&dev->class->p->mutex);
1067
	}
1068
done:
L
Linus Torvalds 已提交
1069 1070
	put_device(dev);
	return error;
1071
 DPMError:
1072 1073
	bus_remove_device(dev);
 BusError:
1074
	device_remove_attrs(dev);
1075
 AttrsError:
1076 1077
	device_remove_class_symlinks(dev);
 SymlinkError:
1078 1079
	if (MAJOR(dev->devt))
		devtmpfs_delete_node(dev);
1080 1081 1082
	if (MAJOR(dev->devt))
		device_remove_sys_dev_entry(dev);
 devtattrError:
1083 1084
	if (MAJOR(dev->devt))
		device_remove_file(dev, &devt_attr);
1085
 ueventattrError:
1086
	device_remove_file(dev, &uevent_attr);
1087
 attrError:
1088
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
1089 1090
	kobject_del(&dev->kobj);
 Error:
1091
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1092 1093
	if (parent)
		put_device(parent);
1094 1095 1096
name_error:
	kfree(dev->p);
	dev->p = NULL;
1097
	goto done;
L
Linus Torvalds 已提交
1098 1099 1100
}

/**
1101 1102
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
1103
 *
1104 1105 1106 1107 1108 1109
 * 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.
1110
 *
1111 1112 1113
 * For more information, see the kerneldoc for device_initialize()
 * and device_add().
 *
1114 1115 1116
 * 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 已提交
1117 1118 1119 1120 1121 1122 1123 1124
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}

/**
1125 1126
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
1127
 *
1128 1129 1130
 * 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 已提交
1131
 */
1132
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
1133
{
1134
	return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
L
Linus Torvalds 已提交
1135 1136 1137
}

/**
1138 1139
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1140
 */
1141
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1142
{
1143
	/* might_sleep(); */
L
Linus Torvalds 已提交
1144 1145 1146 1147 1148
	if (dev)
		kobject_put(&dev->kobj);
}

/**
1149 1150
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1151
 *
1152 1153 1154 1155 1156
 * 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 已提交
1157
 *
1158 1159
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1160
 */
1161
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1162
{
1163
	struct device *parent = dev->parent;
1164
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1165

1166 1167 1168 1169 1170 1171
	/* 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);
1172
	device_pm_remove(dev);
1173
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1174
	if (parent)
1175
		klist_del(&dev->p->knode_parent);
1176
	if (MAJOR(dev->devt)) {
1177
		devtmpfs_delete_node(dev);
1178
		device_remove_sys_dev_entry(dev);
1179
		device_remove_file(dev, &devt_attr);
1180
	}
1181
	if (dev->class) {
1182
		device_remove_class_symlinks(dev);
1183

1184
		mutex_lock(&dev->class->p->mutex);
1185
		/* notify any interfaces that the device is now gone */
1186
		list_for_each_entry(class_intf,
1187
				    &dev->class->p->interfaces, node)
1188 1189 1190
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1191
		klist_del(&dev->knode_class);
1192
		mutex_unlock(&dev->class->p->mutex);
1193
	}
1194
	device_remove_file(dev, &uevent_attr);
1195
	device_remove_attrs(dev);
1196
	bus_remove_device(dev);
1197
	driver_deferred_probe_del(dev);
L
Linus Torvalds 已提交
1198

1199 1200 1201 1202 1203 1204 1205
	/*
	 * 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 已提交
1206 1207 1208 1209 1210
	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1211
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1212
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1213
	kobject_del(&dev->kobj);
1214
	put_device(parent);
L
Linus Torvalds 已提交
1215 1216 1217
}

/**
1218 1219
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1220
 *
1221 1222 1223 1224 1225 1226
 * 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 已提交
1227
 */
1228
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1229
{
1230
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1231 1232 1233 1234
	device_del(dev);
	put_device(dev);
}

1235
static struct device *next_device(struct klist_iter *i)
1236
{
1237
	struct klist_node *n = klist_next(i);
1238 1239 1240 1241 1242 1243 1244 1245
	struct device *dev = NULL;
	struct device_private *p;

	if (n) {
		p = to_device_private_parent(n);
		dev = p->device;
	}
	return dev;
1246 1247
}

1248
/**
1249
 * device_get_devnode - path of device node file
1250
 * @dev: device
1251
 * @mode: returned file access mode
1252 1253 1254 1255 1256 1257 1258
 * @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.
 */
1259
const char *device_get_devnode(struct device *dev,
1260
			       umode_t *mode, const char **tmp)
1261 1262 1263 1264 1265 1266
{
	char *s;

	*tmp = NULL;

	/* the device type may provide a specific name */
1267 1268
	if (dev->type && dev->type->devnode)
		*tmp = dev->type->devnode(dev, mode);
1269 1270 1271 1272
	if (*tmp)
		return *tmp;

	/* the class may provide a specific name */
1273 1274
	if (dev->class && dev->class->devnode)
		*tmp = dev->class->devnode(dev, mode);
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
	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 已提交
1291
/**
1292 1293 1294 1295
 * 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 已提交
1296
 *
1297 1298
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1299
 *
1300 1301
 * 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 已提交
1302
 */
1303 1304
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1305
{
1306
	struct klist_iter i;
1307
	struct device *child;
L
Linus Torvalds 已提交
1308 1309
	int error = 0;

1310 1311 1312
	if (!parent->p)
		return 0;

1313
	klist_iter_init(&parent->p->klist_children, &i);
1314 1315 1316
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1317 1318 1319
	return error;
}

1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
/**
 * 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.
 */
1335 1336
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
1337 1338 1339 1340 1341 1342 1343
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

1344
	klist_iter_init(&parent->p->klist_children, &i);
1345 1346 1347 1348 1349 1350 1351
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}

L
Linus Torvalds 已提交
1352 1353
int __init devices_init(void)
{
1354 1355 1356
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
	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;

1367
	return 0;
1368 1369 1370 1371 1372 1373 1374 1375

 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 已提交
1376 1377 1378
}

EXPORT_SYMBOL_GPL(device_for_each_child);
1379
EXPORT_SYMBOL_GPL(device_find_child);
L
Linus Torvalds 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

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

1393
struct root_device {
1394 1395 1396 1397
	struct device dev;
	struct module *owner;
};

1398 1399 1400 1401
inline struct root_device *to_root_device(struct device *d)
{
	return container_of(d, struct root_device, dev);
}
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425

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.
 *
1426 1427
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
 * 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);

1439
	err = dev_set_name(&root->dev, "%s", name);
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
	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);
	}

1453
#ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
	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
1472
 * @dev: device going away
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
 *
 * 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);

1488 1489 1490

static void device_create_release(struct device *dev)
{
1491
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1492 1493 1494 1495
	kfree(dev);
}

/**
1496
 * device_create_vargs - creates a device and registers it with sysfs
1497 1498 1499
 * @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
1500
 * @drvdata: the data to be added to the device for callbacks
1501
 * @fmt: string for the device's name
1502
 * @args: va_list for the device's name
1503 1504 1505
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
1506 1507 1508
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
1509 1510 1511 1512
 * 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
1513 1514
 * pointer.
 *
1515 1516
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1517 1518 1519
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1520 1521 1522
struct device *device_create_vargs(struct class *class, struct device *parent,
				   dev_t devt, void *drvdata, const char *fmt,
				   va_list args)
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
{
	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;
1540
	dev_set_drvdata(dev, drvdata);
1541

1542 1543 1544 1545
	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
	if (retval)
		goto error;

1546 1547 1548 1549 1550 1551 1552
	retval = device_register(dev);
	if (retval)
		goto error;

	return dev;

error:
1553
	put_device(dev);
1554 1555
	return ERR_PTR(retval);
}
1556 1557 1558
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
1559
 * device_create - creates a device and registers it with sysfs
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
 * @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.
 *
1577 1578
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1579 1580 1581
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1582 1583
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
1584 1585 1586 1587 1588 1589 1590 1591 1592
{
	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;
}
1593
EXPORT_SYMBOL_GPL(device_create);
1594

1595
static int __match_devt(struct device *dev, void *data)
1596
{
1597
	dev_t *devt = data;
1598

1599
	return dev->devt == *devt;
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
}

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

1614
	dev = class_find_device(class, NULL, &devt, __match_devt);
1615 1616
	if (dev) {
		put_device(dev);
1617
		device_unregister(dev);
1618
	}
1619 1620
}
EXPORT_SYMBOL_GPL(device_destroy);
1621 1622 1623 1624 1625

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
1626 1627 1628 1629 1630
 *
 * 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.
1631
 *
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
 * 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. :)
1660
 */
1661
int device_rename(struct device *dev, const char *new_name)
1662 1663 1664
{
	char *old_class_name = NULL;
	char *new_class_name = NULL;
1665
	char *old_device_name = NULL;
1666 1667 1668 1669 1670 1671
	int error;

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

1672
	pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1673
		 __func__, new_name);
1674

1675
	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1676 1677 1678
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
1679 1680
	}

1681
	if (dev->class) {
1682
		error = sysfs_rename_link(&dev->class->p->subsys.kobj,
1683 1684 1685 1686
			&dev->kobj, old_device_name, new_name);
		if (error)
			goto out;
	}
1687

1688
	error = kobject_rename(&dev->kobj, new_name);
1689
	if (error)
1690
		goto out;
1691

1692
out:
1693 1694 1695
	put_device(dev);

	kfree(new_class_name);
1696
	kfree(old_class_name);
1697
	kfree(old_device_name);
1698 1699 1700

	return error;
}
1701
EXPORT_SYMBOL_GPL(device_rename);
1702 1703 1704 1705 1706

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

1709 1710 1711 1712 1713 1714
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
1715 1716 1717 1718 1719
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1720
 * @new_parent: the new parent of the device (can by NULL)
1721
 * @dpm_order: how to reorder the dpm_list
1722
 */
1723 1724
int device_move(struct device *dev, struct device *new_parent,
		enum dpm_order dpm_order)
1725 1726 1727
{
	int error;
	struct device *old_parent;
1728
	struct kobject *new_parent_kobj;
1729 1730 1731 1732 1733

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

1734
	device_pm_lock();
1735
	new_parent = get_device(new_parent);
1736
	new_parent_kobj = get_device_parent(dev, new_parent);
1737

1738 1739
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1740
	error = kobject_move(&dev->kobj, new_parent_kobj);
1741
	if (error) {
1742
		cleanup_glue_dir(dev, new_parent_kobj);
1743 1744 1745 1746 1747 1748
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1749
		klist_remove(&dev->p->knode_parent);
1750
	if (new_parent) {
1751 1752
		klist_add_tail(&dev->p->knode_parent,
			       &new_parent->p->klist_children);
1753 1754 1755
		set_dev_node(dev, dev_to_node(new_parent));
	}

1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
	if (dev->class) {
		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)) {
				if (new_parent)
					klist_remove(&dev->p->knode_parent);
				dev->parent = old_parent;
				if (old_parent) {
					klist_add_tail(&dev->p->knode_parent,
						       &old_parent->p->klist_children);
					set_dev_node(dev, dev_to_node(old_parent));
				}
1770
			}
1771 1772 1773
			cleanup_glue_dir(dev, new_parent_kobj);
			put_device(new_parent);
			goto out;
1774 1775
		}
	}
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
	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;
	}
1789

1790 1791
	put_device(old_parent);
out:
1792
	device_pm_unlock();
1793 1794 1795 1796
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
1797 1798 1799 1800 1801 1802

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
	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);
1814 1815 1816 1817 1818 1819 1820

		/*
		 * hold reference count of device's parent to
		 * prevent it from being freed because parent's
		 * lock is to be held
		 */
		get_device(dev->parent);
1821 1822 1823 1824 1825 1826 1827
		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);
1828

1829 1830 1831 1832 1833
		/* hold lock to avoid race with probe/release */
		if (dev->parent)
			device_lock(dev->parent);
		device_lock(dev);

1834 1835 1836
		/* Don't allow any more runtime suspends */
		pm_runtime_get_noresume(dev);
		pm_runtime_barrier(dev);
1837 1838 1839 1840 1841 1842 1843 1844

		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);
		}
1845 1846 1847 1848 1849

		device_unlock(dev);
		if (dev->parent)
			device_unlock(dev->parent);

1850
		put_device(dev);
1851
		put_device(dev->parent);
1852 1853

		spin_lock(&devices_kset->list_lock);
1854
	}
1855
	spin_unlock(&devices_kset->list_lock);
1856
	async_synchronize_full();
1857
}
1858 1859 1860 1861 1862 1863

/*
 * Device logging functions
 */

#ifdef CONFIG_PRINTK
1864 1865
int __dev_printk(const char *level, const struct device *dev,
		 struct va_format *vaf)
1866
{
1867
	char dict[128];
1868
	const char *level_extra = "";
1869 1870 1871
	size_t dictlen = 0;
	const char *subsys;

1872 1873 1874
	if (!dev)
		return printk("%s(NULL device *): %pV", level, vaf);

1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
	if (dev->class)
		subsys = dev->class->name;
	else if (dev->bus)
		subsys = dev->bus->name;
	else
		goto skip;

	dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
			    "SUBSYSTEM=%s", subsys);

	/*
	 * Add device identifier DEVICE=:
	 *   b12:8         block dev_t
	 *   c127:3        char dev_t
	 *   n8            netdev ifindex
	 *   +sound:card0  subsystem:devname
	 */
	if (MAJOR(dev->devt)) {
		char c;

		if (strcmp(subsys, "block") == 0)
			c = 'b';
		else
			c = 'c';
		dictlen++;
		dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
				   "DEVICE=%c%u:%u",
				   c, MAJOR(dev->devt), MINOR(dev->devt));
	} else if (strcmp(subsys, "net") == 0) {
		struct net_device *net = to_net_dev(dev);

		dictlen++;
		dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
				    "DEVICE=n%u", net->ifindex);
	} else {
		dictlen++;
		dictlen += snprintf(dict + dictlen, sizeof(dict) - dictlen,
				    "DEVICE=+%s:%s", subsys, dev_name(dev));
	}
skip:
1915 1916 1917
	if (level[3])
		level_extra = &level[3]; /* skip past "<L>" */

1918 1919
	return printk_emit(0, level[1] - '0',
			   dictlen ? dict : NULL, dictlen,
1920 1921 1922
			   "%s %s: %s%pV",
			   dev_driver_string(dev), dev_name(dev),
			   level_extra, vaf);
1923
}
1924
EXPORT_SYMBOL(__dev_printk);
1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972

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