core.c 41.0 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/semaphore.h>
24
#include <linux/mutex.h>
L
Linus Torvalds 已提交
25 26 27 28

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

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

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

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

L
Linus Torvalds 已提交
64 65 66
#define to_dev(obj) container_of(obj, struct device, kobj)
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

67 68
static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
			     char *buf)
L
Linus Torvalds 已提交
69
{
70 71
	struct device_attribute *dev_attr = to_dev_attr(attr);
	struct device *dev = to_dev(kobj);
72
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
73 74

	if (dev_attr->show)
75
		ret = dev_attr->show(dev, dev_attr, buf);
76 77 78 79
	if (ret >= (ssize_t)PAGE_SIZE) {
		print_symbol("dev_attr_show: %s returned bad count\n",
				(unsigned long)dev_attr->show);
	}
L
Linus Torvalds 已提交
80 81 82
	return ret;
}

83 84
static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
			      const char *buf, size_t count)
L
Linus Torvalds 已提交
85
{
86 87
	struct device_attribute *dev_attr = to_dev_attr(attr);
	struct device *dev = to_dev(kobj);
88
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
89 90

	if (dev_attr->store)
91
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
	return ret;
}

static struct sysfs_ops dev_sysfs_ops = {
	.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.
 */
109
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
110
{
111
	struct device *dev = to_dev(kobj);
L
Linus Torvalds 已提交
112 113 114

	if (dev->release)
		dev->release(dev);
115 116
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
117 118
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
119 120
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
121
			"function, it is broken and must be fixed.\n",
122
			dev_name(dev));
L
Linus Torvalds 已提交
123 124
}

125
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
126 127 128 129 130
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
};


131
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
132 133 134
{
	struct kobj_type *ktype = get_ktype(kobj);

135
	if (ktype == &device_ktype) {
L
Linus Torvalds 已提交
136
		struct device *dev = to_dev(kobj);
137 138
		if (dev->uevent_suppress)
			return 0;
L
Linus Torvalds 已提交
139 140
		if (dev->bus)
			return 1;
141 142
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
143 144 145 146
	}
	return 0;
}

147
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
148 149 150
{
	struct device *dev = to_dev(kobj);

151 152 153 154 155
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
156 157
}

158 159
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
160 161 162 163
{
	struct device *dev = to_dev(kobj);
	int retval = 0;

164 165
	/* add the major/minor if present */
	if (MAJOR(dev->devt)) {
166 167
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
168 169
	}

170
	if (dev->type && dev->type->name)
171
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
172

173
	if (dev->driver)
174
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
175

176
#ifdef CONFIG_SYSFS_DEPRECATED
177 178 179 180 181 182 183 184 185 186
	if (dev->class) {
		struct device *parent = dev->parent;

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

			path = kobject_get_path(&parent->kobj, GFP_KERNEL);
187
			if (path) {
188
				add_uevent_var(env, "PHYSDEVPATH=%s", path);
189 190
				kfree(path);
			}
191

192
			add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
193 194

			if (parent->driver)
195 196
				add_uevent_var(env, "PHYSDEVDRIVER=%s",
					       parent->driver->name);
197 198
		}
	} else if (dev->bus) {
199
		add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
200 201

		if (dev->driver)
202 203
			add_uevent_var(env, "PHYSDEVDRIVER=%s",
				       dev->driver->name);
K
Kay Sievers 已提交
204
	}
205
#endif
L
Linus Torvalds 已提交
206

207
	/* have the bus specific function add its stuff */
208
	if (dev->bus && dev->bus->uevent) {
209
		retval = dev->bus->uevent(dev, env);
210
		if (retval)
211
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
212
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
213 214
	}

215
	/* have the class specific function add its stuff */
216
	if (dev->class && dev->class->dev_uevent) {
217
		retval = dev->class->dev_uevent(dev, env);
218
		if (retval)
219
			pr_debug("device: '%s': %s: class uevent() "
220
				 "returned %d\n", dev_name(dev),
221
				 __func__, retval);
222 223
	}

224
	/* have the device type specific fuction add its stuff */
225
	if (dev->type && dev->type->uevent) {
226
		retval = dev->type->uevent(dev, env);
227
		if (retval)
228
			pr_debug("device: '%s': %s: dev_type uevent() "
229
				 "returned %d\n", dev_name(dev),
230
				 __func__, retval);
231 232
	}

L
Linus Torvalds 已提交
233 234 235
	return retval;
}

236 237 238 239
static struct kset_uevent_ops device_uevent_ops = {
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
240 241
};

242 243 244 245 246
static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
247
	struct kobj_uevent_env *env = NULL;
248 249 250 251 252 253
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
254 255
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
256 257
	if (!top_kobj->kset)
		goto out;
258

259 260 261 262 263 264 265 266 267
	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;

268 269
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
270 271
		return -ENOMEM;

272
	/* let the kset specific function add its keys */
273
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
274 275 276 277
	if (retval)
		goto out;

	/* copy keys to file */
278 279
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
280
out:
281
	kfree(env);
282 283 284
	return count;
}

285 286 287
static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
288 289
	enum kobject_action action;

290
	if (kobject_action_type(buf, count, &action) == 0) {
291 292 293 294 295 296
		kobject_uevent(&dev->kobj, action);
		goto out;
	}

	dev_err(dev, "uevent: unsupported action-string; this will "
		     "be ignored in a future kernel version\n");
297
	kobject_uevent(&dev->kobj, KOBJ_ADD);
298
out:
299 300 301
	return count;
}

302 303 304
static struct device_attribute uevent_attr =
	__ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);

305 306
static int device_add_attributes(struct device *dev,
				 struct device_attribute *attrs)
307
{
308
	int error = 0;
309
	int i;
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336

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

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

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

static int device_add_groups(struct device *dev,
			     struct attribute_group **groups)
{
337
	int error = 0;
338
	int i;
339

340 341 342
	if (groups) {
		for (i = 0; groups[i]; i++) {
			error = sysfs_create_group(&dev->kobj, groups[i]);
343 344
			if (error) {
				while (--i >= 0)
345 346
					sysfs_remove_group(&dev->kobj,
							   groups[i]);
347
				break;
348 349 350 351 352 353
			}
		}
	}
	return error;
}

354 355
static void device_remove_groups(struct device *dev,
				 struct attribute_group **groups)
356 357
{
	int i;
358 359 360 361

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

364 365 366
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
367
	struct device_type *type = dev->type;
368
	int error;
369

370 371
	if (class) {
		error = device_add_attributes(dev, class->dev_attrs);
372
		if (error)
373
			return error;
374
	}
375

376 377
	if (type) {
		error = device_add_groups(dev, type->groups);
378
		if (error)
379
			goto err_remove_class_attrs;
380 381
	}

382 383 384 385 386 387 388 389 390 391 392 393 394
	error = device_add_groups(dev, dev->groups);
	if (error)
		goto err_remove_type_groups;

	return 0;

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

395 396 397 398 399 400
	return error;
}

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

403
	device_remove_groups(dev, dev->groups);
404

405 406 407 408 409
	if (type)
		device_remove_groups(dev, type->groups);

	if (class)
		device_remove_attributes(dev, class->dev_attrs);
410 411 412
}


413 414 415 416 417 418
static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}

419 420 421
static struct device_attribute devt_attr =
	__ATTR(dev, S_IRUGO, show_dev, NULL);

422 423
/* kset to create /sys/devices/  */
struct kset *devices_kset;
L
Linus Torvalds 已提交
424 425

/**
426 427 428
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
429
 */
430
int device_create_file(struct device *dev, struct device_attribute *attr)
L
Linus Torvalds 已提交
431 432
{
	int error = 0;
433
	if (dev)
L
Linus Torvalds 已提交
434 435 436 437 438
		error = sysfs_create_file(&dev->kobj, &attr->attr);
	return error;
}

/**
439 440 441
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
442
 */
443
void device_remove_file(struct device *dev, struct device_attribute *attr)
L
Linus Torvalds 已提交
444
{
445
	if (dev)
L
Linus Torvalds 已提交
446 447 448
		sysfs_remove_file(&dev->kobj, &attr->attr);
}

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
{
	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.
 */
void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

475
/**
476
 * device_schedule_callback_owner - helper to schedule a callback for a device
477 478
 * @dev: device.
 * @func: callback function to invoke later.
479
 * @owner: module owning the callback routine
480 481 482 483 484 485 486 487 488 489
 *
 * 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.
 *
490 491 492
 * This routine is usually called via the inline device_schedule_callback(),
 * which automatically sets @owner to THIS_MODULE.
 *
493
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
494
 * be allocated, -ENODEV if a reference to @owner isn't available.
495 496 497 498 499
 *
 * 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.
 */
500 501
int device_schedule_callback_owner(struct device *dev,
		void (*func)(struct device *), struct module *owner)
502 503
{
	return sysfs_schedule_callback(&dev->kobj,
504
			(void (*)(void *)) func, dev, owner);
505
}
506
EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
507

508 509
static void klist_children_get(struct klist_node *n)
{
510
	struct device *dev = container_of(n, struct device, knode_parent);
511 512 513 514 515 516

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
517
	struct device *dev = container_of(n, struct device, knode_parent);
518 519 520 521

	put_device(dev);
}

L
Linus Torvalds 已提交
522
/**
523 524
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
525
 *
526 527
 * This prepares the device for use by other layers by initializing
 * its fields.
528
 * It is the first half of device_register(), if called by
529 530 531 532 533 534 535
 * 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 已提交
536 537 538
 */
void device_initialize(struct device *dev)
{
539
	dev->kobj.kset = devices_kset;
540
	kobject_init(&dev->kobj, &device_ktype);
541
	klist_init(&dev->klist_children, klist_children_get,
542
		   klist_children_put);
L
Linus Torvalds 已提交
543
	INIT_LIST_HEAD(&dev->dma_pools);
544
	init_MUTEX(&dev->sem);
T
Tejun Heo 已提交
545 546
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
D
David Brownell 已提交
547
	device_init_wakeup(dev, 0);
548
	device_pm_init(dev);
549
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
550 551
}

552
#ifdef CONFIG_SYSFS_DEPRECATED
553 554
static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
555
{
556
	/* class devices without a parent live in /sys/class/<classname>/ */
557
	if (dev->class && (!parent || parent->class != dev->class))
558
		return &dev->class->p->class_subsys.kobj;
559
	/* all other devices keep their parent */
560
	else if (parent)
561
		return &parent->kobj;
562

563
	return NULL;
564
}
565 566

static inline void cleanup_device_parent(struct device *dev) {}
567 568
static inline void cleanup_glue_dir(struct device *dev,
				    struct kobject *glue_dir) {}
569
#else
570
static struct kobject *virtual_device_parent(struct device *dev)
571
{
572
	static struct kobject *virtual_dir = NULL;
573

574
	if (!virtual_dir)
575
		virtual_dir = kobject_create_and_add("virtual",
576
						     &devices_kset->kobj);
577

578
	return virtual_dir;
579 580
}

581 582
static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
583
{
584 585
	int retval;

586 587 588 589 590 591 592
	if (dev->class) {
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

		/*
		 * If we have no parent, we live in "virtual".
593 594
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
595 596 597 598 599 600 601 602 603
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
		else if (parent->class)
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

		/* find our class-directory at the parent and reference it */
604 605
		spin_lock(&dev->class->p->class_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
606 607 608 609
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
610
		spin_unlock(&dev->class->p->class_dirs.list_lock);
611 612 613 614
		if (kobj)
			return kobj;

		/* or create a new class-directory at the parent device */
615 616 617
		k = kobject_create();
		if (!k)
			return NULL;
618
		k->kset = &dev->class->p->class_dirs;
619
		retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
620 621 622 623
		if (retval < 0) {
			kobject_put(k);
			return NULL;
		}
624
		/* do not emit an uevent for this simple "glue" directory */
625
		return k;
626 627 628
	}

	if (parent)
629 630 631
		return &parent->kobj;
	return NULL;
}
632

633
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
634
{
635
	/* see if we live in a "glue" directory */
636
	if (!glue_dir || !dev->class ||
637
	    glue_dir->kset != &dev->class->p->class_dirs)
638 639
		return;

640
	kobject_put(glue_dir);
641
}
642 643 644 645 646

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

649
static void setup_parent(struct device *dev, struct device *parent)
650 651 652 653 654
{
	struct kobject *kobj;
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
655 656
}

657 658 659 660 661 662
static int device_add_class_symlinks(struct device *dev)
{
	int error;

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

664 665
	error = sysfs_create_link(&dev->kobj,
				  &dev->class->p->class_subsys.kobj,
666 667 668
				  "subsystem");
	if (error)
		goto out;
669 670 671

#ifdef CONFIG_SYSFS_DEPRECATED
	/* stacked class devices need a symlink in the class directory */
672
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
673
	    device_is_not_partition(dev)) {
674
		error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
675
					  &dev->kobj, dev_name(dev));
676 677 678
		if (error)
			goto out_subsys;
	}
679

680
	if (dev->parent && device_is_not_partition(dev)) {
681 682
		struct device *parent = dev->parent;
		char *class_name;
683

684 685 686 687 688 689 690 691 692
		/*
		 * stacked class devices have the 'device' link
		 * pointing to the bus device instead of the parent
		 */
		while (parent->class && !parent->bus && parent->parent)
			parent = parent->parent;

		error = sysfs_create_link(&dev->kobj,
					  &parent->kobj,
693 694 695
					  "device");
		if (error)
			goto out_busid;
696 697 698 699 700 701 702 703 704

		class_name = make_class_name(dev->class->name,
						&dev->kobj);
		if (class_name)
			error = sysfs_create_link(&dev->parent->kobj,
						&dev->kobj, class_name);
		kfree(class_name);
		if (error)
			goto out_device;
705 706 707 708
	}
	return 0;

out_device:
709
	if (dev->parent && device_is_not_partition(dev))
710 711
		sysfs_remove_link(&dev->kobj, "device");
out_busid:
712
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
713
	    device_is_not_partition(dev))
714
		sysfs_remove_link(&dev->class->p->class_subsys.kobj,
715
				  dev_name(dev));
716 717
#else
	/* link in the class directory pointing to the device */
718
	error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
719
				  &dev->kobj, dev_name(dev));
720 721 722
	if (error)
		goto out_subsys;

723
	if (dev->parent && device_is_not_partition(dev)) {
724 725 726 727 728 729 730 731
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
					  "device");
		if (error)
			goto out_busid;
	}
	return 0;

out_busid:
732
	sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
733 734
#endif

735 736 737 738 739 740 741 742 743 744
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
out:
	return error;
}

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

746
#ifdef CONFIG_SYSFS_DEPRECATED
747
	if (dev->parent && device_is_not_partition(dev)) {
748 749 750 751 752 753 754 755 756
		char *class_name;

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

758
	if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
759
	    device_is_not_partition(dev))
760
		sysfs_remove_link(&dev->class->p->class_subsys.kobj,
761
				  dev_name(dev));
762
#else
763
	if (dev->parent && device_is_not_partition(dev))
764 765
		sysfs_remove_link(&dev->kobj, "device");

766
	sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
767 768
#endif

769 770 771
	sysfs_remove_link(&dev->kobj, "subsystem");
}

772 773 774
/**
 * dev_set_name - set a device name
 * @dev: device
775
 * @fmt: format string for the device's name
776 777 778 779 780 781 782 783 784 785 786 787
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;

	va_start(vargs, fmt);
	vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
	va_end(vargs);
	return 0;
}
EXPORT_SYMBOL_GPL(dev_set_name);

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
/**
 * 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);
	}
}

L
Linus Torvalds 已提交
836
/**
837 838
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
839
 *
840 841
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
842
 *
843
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
844 845
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
846 847 848 849
 *
 * 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 已提交
850 851 852 853
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
854
	struct class_interface *class_intf;
855
	int error = -EINVAL;
856

L
Linus Torvalds 已提交
857
	dev = get_device(dev);
858 859 860 861 862 863 864 865 866 867
	if (!dev)
		goto done;

	/* Temporarily support init_name if it is set.
	 * It will override bus_id for now */
	if (dev->init_name)
		dev_set_name(dev, "%s", dev->init_name);

	if (!strlen(dev->bus_id))
		goto done;
L
Linus Torvalds 已提交
868

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

L
Linus Torvalds 已提交
871
	parent = get_device(dev->parent);
872
	setup_parent(dev, parent);
L
Linus Torvalds 已提交
873

874 875 876 877
	/* use parent numa_node */
	if (parent)
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
878
	/* first, register with generic layer. */
879
	error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev_name(dev));
880
	if (error)
L
Linus Torvalds 已提交
881
		goto Error;
882

883 884 885 886
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

887
	error = device_create_file(dev, &uevent_attr);
888 889
	if (error)
		goto attrError;
890

891
	if (MAJOR(dev->devt)) {
892 893
		error = device_create_file(dev, &devt_attr);
		if (error)
894
			goto ueventattrError;
895 896 897 898

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto devtattrError;
899 900
	}

901 902 903
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
904 905
	error = device_add_attrs(dev);
	if (error)
906
		goto AttrsError;
907 908
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
909
		goto BusError;
910
	error = dpm_sysfs_add(dev);
911
	if (error)
912 913
		goto DPMError;
	device_pm_add(dev);
914 915 916 917 918 919 920 921

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

922
	kobject_uevent(&dev->kobj, KOBJ_ADD);
923
	bus_attach_device(dev);
L
Linus Torvalds 已提交
924
	if (parent)
925
		klist_add_tail(&dev->knode_parent, &parent->klist_children);
L
Linus Torvalds 已提交
926

927
	if (dev->class) {
928
		mutex_lock(&dev->class->p->class_mutex);
929
		/* tie the class to the device */
930 931
		klist_add_tail(&dev->knode_class,
			       &dev->class->p->class_devices);
932 933

		/* notify any interfaces that the device is here */
934 935
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
936 937
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
938
		mutex_unlock(&dev->class->p->class_mutex);
939
	}
940
done:
L
Linus Torvalds 已提交
941 942
	put_device(dev);
	return error;
943
 DPMError:
944 945
	bus_remove_device(dev);
 BusError:
946
	device_remove_attrs(dev);
947
 AttrsError:
948 949
	device_remove_class_symlinks(dev);
 SymlinkError:
950 951 952
	if (MAJOR(dev->devt))
		device_remove_sys_dev_entry(dev);
 devtattrError:
953 954
	if (MAJOR(dev->devt))
		device_remove_file(dev, &devt_attr);
955
 ueventattrError:
956
	device_remove_file(dev, &uevent_attr);
957
 attrError:
958
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
959 960
	kobject_del(&dev->kobj);
 Error:
961
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
962 963
	if (parent)
		put_device(parent);
964
	goto done;
L
Linus Torvalds 已提交
965 966 967
}

/**
968 969
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
970
 *
971 972 973 974 975 976
 * 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.
977 978 979 980
 *
 * 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 已提交
981 982 983 984 985 986 987 988
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}

/**
989 990
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
991
 *
992 993 994
 * 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 已提交
995
 */
996
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
997 998 999 1000 1001
{
	return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
}

/**
1002 1003
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1004
 */
1005
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1006
{
1007
	/* might_sleep(); */
L
Linus Torvalds 已提交
1008 1009 1010 1011 1012
	if (dev)
		kobject_put(&dev->kobj);
}

/**
1013 1014
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1015
 *
1016 1017 1018 1019 1020
 * 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 已提交
1021
 *
1022 1023
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1024
 */
1025
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1026
{
1027
	struct device *parent = dev->parent;
1028
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1029

1030 1031 1032 1033 1034 1035
	/* 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);
1036
	device_pm_remove(dev);
1037
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1038
	if (parent)
1039
		klist_del(&dev->knode_parent);
1040 1041
	if (MAJOR(dev->devt)) {
		device_remove_sys_dev_entry(dev);
1042
		device_remove_file(dev, &devt_attr);
1043
	}
1044
	if (dev->class) {
1045
		device_remove_class_symlinks(dev);
1046

1047
		mutex_lock(&dev->class->p->class_mutex);
1048
		/* notify any interfaces that the device is now gone */
1049 1050
		list_for_each_entry(class_intf,
				    &dev->class->p->class_interfaces, node)
1051 1052 1053
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1054
		klist_del(&dev->knode_class);
1055
		mutex_unlock(&dev->class->p->class_mutex);
1056
	}
1057
	device_remove_file(dev, &uevent_attr);
1058
	device_remove_attrs(dev);
1059
	bus_remove_device(dev);
L
Linus Torvalds 已提交
1060

1061 1062 1063 1064 1065 1066 1067
	/*
	 * 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 已提交
1068 1069 1070 1071 1072
	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1073
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1074
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1075
	kobject_del(&dev->kobj);
1076
	put_device(parent);
L
Linus Torvalds 已提交
1077 1078 1079
}

/**
1080 1081
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1082
 *
1083 1084 1085 1086 1087 1088
 * 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 已提交
1089
 */
1090
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1091
{
1092
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1093 1094 1095 1096
	device_del(dev);
	put_device(dev);
}

1097
static struct device *next_device(struct klist_iter *i)
1098
{
1099
	struct klist_node *n = klist_next(i);
1100
	return n ? container_of(n, struct device, knode_parent) : NULL;
1101 1102
}

L
Linus Torvalds 已提交
1103
/**
1104 1105 1106 1107
 * 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 已提交
1108
 *
1109 1110
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1111
 *
1112 1113
 * 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 已提交
1114
 */
1115 1116
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1117
{
1118
	struct klist_iter i;
1119
	struct device *child;
L
Linus Torvalds 已提交
1120 1121
	int error = 0;

1122
	klist_iter_init(&parent->klist_children, &i);
1123 1124 1125
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1126 1127 1128
	return error;
}

1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
/**
 * 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.
 */
1144 1145
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
1146 1147 1148 1149 1150 1151 1152
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

1153
	klist_iter_init(&parent->klist_children, &i);
1154 1155 1156 1157 1158 1159 1160
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}

L
Linus Torvalds 已提交
1161 1162
int __init devices_init(void)
{
1163 1164 1165
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
	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;

1176
	return 0;
1177 1178 1179 1180 1181 1182 1183 1184

 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 已提交
1185 1186 1187
}

EXPORT_SYMBOL_GPL(device_for_each_child);
1188
EXPORT_SYMBOL_GPL(device_find_child);
L
Linus Torvalds 已提交
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200

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

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
struct root_device
{
	struct device dev;
	struct module *owner;
};

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

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

/**
 * __root_device_register - allocate and register a root device
 * @name: root device name
 * @owner: owner module of the root device, usually THIS_MODULE
 *
 * This function allocates a root device and registers it
 * using device_register(). In order to free the returned
 * device, use root_device_unregister().
 *
 * Root devices are dummy devices which allow other devices
 * to be grouped under /sys/devices. Use this function to
 * allocate a root device and then use it as the parent of
 * any device which should appear under /sys/devices/{name}
 *
 * The /sys/devices/{name} directory will also contain a
 * 'module' symlink which points to the @owner directory
 * in sysfs.
 *
 * 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);

	err = dev_set_name(&root->dev, name);
	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);
	}

#ifdef CONFIG_MODULE	/* gotta find a "cleaner" way to do this */
	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
 * @root: device going away.
 *
 * 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);

1293 1294 1295

static void device_create_release(struct device *dev)
{
1296
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1297 1298 1299 1300
	kfree(dev);
}

/**
1301
 * device_create_vargs - creates a device and registers it with sysfs
1302 1303 1304
 * @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
1305
 * @drvdata: the data to be added to the device for callbacks
1306
 * @fmt: string for the device's name
1307
 * @args: va_list for the device's name
1308 1309 1310
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
1311 1312 1313
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
1314 1315 1316 1317
 * 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
1318 1319 1320 1321 1322
 * pointer.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1323 1324 1325
struct device *device_create_vargs(struct class *class, struct device *parent,
				   dev_t devt, void *drvdata, const char *fmt,
				   va_list args)
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
{
	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;
1343
	dev_set_drvdata(dev, drvdata);
1344 1345 1346 1347 1348 1349 1350 1351 1352

	vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
	retval = device_register(dev);
	if (retval)
		goto error;

	return dev;

error:
1353
	put_device(dev);
1354 1355
	return ERR_PTR(retval);
}
1356 1357 1358
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
1359
 * device_create - creates a device and registers it with sysfs
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
 * @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.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1380 1381
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
1382 1383 1384 1385 1386 1387 1388 1389 1390
{
	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;
}
1391
EXPORT_SYMBOL_GPL(device_create);
1392

1393
static int __match_devt(struct device *dev, void *data)
1394
{
1395
	dev_t *devt = data;
1396

1397
	return dev->devt == *devt;
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
}

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

1412
	dev = class_find_device(class, NULL, &devt, __match_devt);
1413 1414
	if (dev) {
		put_device(dev);
1415
		device_unregister(dev);
1416
	}
1417 1418
}
EXPORT_SYMBOL_GPL(device_destroy);
1419 1420 1421 1422 1423

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
1424 1425 1426 1427 1428
 *
 * 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.
1429 1430 1431 1432 1433
 */
int device_rename(struct device *dev, char *new_name)
{
	char *old_class_name = NULL;
	char *new_class_name = NULL;
1434
	char *old_device_name = NULL;
1435 1436 1437 1438 1439 1440
	int error;

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

1441
	pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1442
		 __func__, new_name);
1443

1444
#ifdef CONFIG_SYSFS_DEPRECATED
1445 1446
	if ((dev->class) && (dev->parent))
		old_class_name = make_class_name(dev->class->name, &dev->kobj);
1447
#endif
1448

1449 1450 1451 1452
	old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
1453
	}
1454
	strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1455 1456 1457
	strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);

	error = kobject_rename(&dev->kobj, new_name);
1458 1459 1460 1461
	if (error) {
		strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
		goto out;
	}
1462

1463
#ifdef CONFIG_SYSFS_DEPRECATED
1464 1465 1466
	if (old_class_name) {
		new_class_name = make_class_name(dev->class->name, &dev->kobj);
		if (new_class_name) {
1467 1468 1469
			error = sysfs_create_link_nowarn(&dev->parent->kobj,
							 &dev->kobj,
							 new_class_name);
1470 1471
			if (error)
				goto out;
1472 1473 1474
			sysfs_remove_link(&dev->parent->kobj, old_class_name);
		}
	}
1475
#else
1476
	if (dev->class) {
1477
		error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
1478
						 &dev->kobj, dev_name(dev));
1479 1480
		if (error)
			goto out;
1481
		sysfs_remove_link(&dev->class->p->class_subsys.kobj,
1482
				  old_device_name);
1483
	}
1484 1485
#endif

1486
out:
1487 1488 1489
	put_device(dev);

	kfree(new_class_name);
1490
	kfree(old_class_name);
1491
	kfree(old_device_name);
1492 1493 1494

	return error;
}
1495
EXPORT_SYMBOL_GPL(device_rename);
1496 1497 1498 1499 1500

static int device_move_class_links(struct device *dev,
				   struct device *old_parent,
				   struct device *new_parent)
{
1501
	int error = 0;
1502 1503 1504 1505 1506
#ifdef CONFIG_SYSFS_DEPRECATED
	char *class_name;

	class_name = make_class_name(dev->class->name, &dev->kobj);
	if (!class_name) {
1507
		error = -ENOMEM;
1508 1509 1510 1511 1512 1513
		goto out;
	}
	if (old_parent) {
		sysfs_remove_link(&dev->kobj, "device");
		sysfs_remove_link(&old_parent->kobj, class_name);
	}
1514 1515 1516 1517 1518 1519 1520 1521 1522
	if (new_parent) {
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
		if (error)
			goto out;
		error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
					  class_name);
		if (error)
			sysfs_remove_link(&dev->kobj, "device");
1523
	} else
1524
		error = 0;
1525 1526 1527 1528
out:
	kfree(class_name);
	return error;
#else
1529 1530 1531 1532 1533 1534
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
1535 1536 1537 1538 1539 1540
#endif
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1541
 * @new_parent: the new parent of the device (can by NULL)
1542 1543 1544 1545 1546
 */
int device_move(struct device *dev, struct device *new_parent)
{
	int error;
	struct device *old_parent;
1547
	struct kobject *new_parent_kobj;
1548 1549 1550 1551 1552 1553

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

	new_parent = get_device(new_parent);
1554
	new_parent_kobj = get_device_parent(dev, new_parent);
1555

1556 1557
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1558
	error = kobject_move(&dev->kobj, new_parent_kobj);
1559
	if (error) {
1560
		cleanup_glue_dir(dev, new_parent_kobj);
1561 1562 1563 1564 1565 1566
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1567
		klist_remove(&dev->knode_parent);
1568
	if (new_parent) {
1569
		klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1570 1571 1572
		set_dev_node(dev, dev_to_node(new_parent));
	}

1573 1574 1575 1576 1577 1578 1579
	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)) {
1580
			if (new_parent)
1581
				klist_remove(&dev->knode_parent);
1582 1583
			dev->parent = old_parent;
			if (old_parent) {
1584 1585
				klist_add_tail(&dev->knode_parent,
					       &old_parent->klist_children);
1586 1587
				set_dev_node(dev, dev_to_node(old_parent));
			}
1588
		}
1589
		cleanup_glue_dir(dev, new_parent_kobj);
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
		put_device(new_parent);
		goto out;
	}
out_put:
	put_device(old_parent);
out:
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
1600 1601 1602 1603 1604 1605

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
1606
	struct device *dev, *devn;
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617

	list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
				kobj.entry) {
		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);
		}
	}
1618 1619 1620
	kobject_put(sysfs_dev_char_kobj);
	kobject_put(sysfs_dev_block_kobj);
	kobject_put(dev_kobj);
1621
}