core.c 26.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>
L
Linus Torvalds 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33

#include <asm/semaphore.h>

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

int (*platform_notify)(struct device * dev) = NULL;
int (*platform_notify_remove)(struct device * dev) = NULL;

/*
 * sysfs bindings for devices.
 */

34 35 36 37 38 39 40 41 42 43 44 45 46 47
/**
 * 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.
 */
const char *dev_driver_string(struct device *dev)
{
	return dev->driver ? dev->driver->name :
			(dev->bus ? dev->bus->name : "");
}
M
Matthew Wilcox 已提交
48
EXPORT_SYMBOL(dev_driver_string);
49

L
Linus Torvalds 已提交
50 51 52 53 54 55 56 57
#define to_dev(obj) container_of(obj, struct device, kobj)
#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)

static ssize_t
dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
{
	struct device_attribute * dev_attr = to_dev_attr(attr);
	struct device * dev = to_dev(kobj);
58
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
59 60

	if (dev_attr->show)
61
		ret = dev_attr->show(dev, dev_attr, buf);
L
Linus Torvalds 已提交
62 63 64 65 66 67 68 69 70
	return ret;
}

static ssize_t
dev_attr_store(struct kobject * kobj, struct attribute * attr,
	       const char * buf, size_t count)
{
	struct device_attribute * dev_attr = to_dev_attr(attr);
	struct device * dev = to_dev(kobj);
71
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
72 73

	if (dev_attr->store)
74
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
	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.
 */
static void device_release(struct kobject * kobj)
{
	struct device * dev = to_dev(kobj);

	if (dev->release)
		dev->release(dev);
98 99
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
L
Linus Torvalds 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113
	else {
		printk(KERN_ERR "Device '%s' does not have a release() function, "
			"it is broken and must be fixed.\n",
			dev->bus_id);
		WARN_ON(1);
	}
}

static struct kobj_type ktype_device = {
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
};


114
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
115 116 117 118 119 120 121
{
	struct kobj_type *ktype = get_ktype(kobj);

	if (ktype == &ktype_device) {
		struct device *dev = to_dev(kobj);
		if (dev->bus)
			return 1;
122 123
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
124 125 126 127
	}
	return 0;
}

128
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
129 130 131
{
	struct device *dev = to_dev(kobj);

132 133 134 135 136
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
137 138
}

139
static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
L
Linus Torvalds 已提交
140 141 142 143 144 145 146
			int num_envp, char *buffer, int buffer_size)
{
	struct device *dev = to_dev(kobj);
	int i = 0;
	int length = 0;
	int retval = 0;

147 148 149 150 151 152 153 154 155 156
	/* add the major/minor if present */
	if (MAJOR(dev->devt)) {
		add_uevent_var(envp, num_envp, &i,
			       buffer, buffer_size, &length,
			       "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(envp, num_envp, &i,
			       buffer, buffer_size, &length,
			       "MINOR=%u", MINOR(dev->devt));
	}

157
#ifdef CONFIG_SYSFS_DEPRECATED
K
Kay Sievers 已提交
158
	/* add bus name (same as SUBSYSTEM, deprecated) */
L
Linus Torvalds 已提交
159
	if (dev->bus)
160 161 162
		add_uevent_var(envp, num_envp, &i,
			       buffer, buffer_size, &length,
			       "PHYSDEVBUS=%s", dev->bus->name);
163
#endif
L
Linus Torvalds 已提交
164

K
Kay Sievers 已提交
165 166 167 168 169
	/* add driver name (PHYSDEV* values are deprecated)*/
	if (dev->driver) {
		add_uevent_var(envp, num_envp, &i,
			       buffer, buffer_size, &length,
			       "DRIVER=%s", dev->driver->name);
170
#ifdef CONFIG_SYSFS_DEPRECATED
171 172 173
		add_uevent_var(envp, num_envp, &i,
			       buffer, buffer_size, &length,
			       "PHYSDEVDRIVER=%s", dev->driver->name);
174
#endif
K
Kay Sievers 已提交
175
	}
L
Linus Torvalds 已提交
176 177 178 179 180 181 182 183

	/* terminate, set to next free slot, shrink available space */
	envp[i] = NULL;
	envp = &envp[i];
	num_envp -= i;
	buffer = &buffer[length];
	buffer_size -= length;

184
	if (dev->bus && dev->bus->uevent) {
L
Linus Torvalds 已提交
185
		/* have the bus specific function add its stuff */
186
		retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
L
Linus Torvalds 已提交
187
			if (retval) {
188
			pr_debug ("%s - uevent() returned %d\n",
L
Linus Torvalds 已提交
189 190 191 192
				  __FUNCTION__, retval);
		}
	}

193 194 195 196 197 198 199 200 201
	if (dev->class && dev->class->dev_uevent) {
		/* have the class specific function add its stuff */
		retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
			if (retval) {
				pr_debug("%s - dev_uevent() returned %d\n",
					 __FUNCTION__, retval);
		}
	}

L
Linus Torvalds 已提交
202 203 204
	return retval;
}

205 206 207 208
static struct kset_uevent_ops device_uevent_ops = {
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
209 210
};

211 212 213
static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
214
	kobject_uevent(&dev->kobj, KOBJ_ADD);
215 216 217
	return count;
}

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
static int device_add_groups(struct device *dev)
{
	int i;
	int error = 0;

	if (dev->groups) {
		for (i = 0; dev->groups[i]; i++) {
			error = sysfs_create_group(&dev->kobj, dev->groups[i]);
			if (error) {
				while (--i >= 0)
					sysfs_remove_group(&dev->kobj, dev->groups[i]);
				goto out;
			}
		}
	}
out:
	return error;
}

static void device_remove_groups(struct device *dev)
{
	int i;
	if (dev->groups) {
		for (i = 0; dev->groups[i]; i++) {
			sysfs_remove_group(&dev->kobj, dev->groups[i]);
		}
	}
}

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
	int error = 0;
	int i;

	if (!class)
		return 0;

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

static void device_remove_attrs(struct device *dev)
{
	struct class *class = dev->class;
	int i;

	if (!class)
		return;

	if (class->dev_attrs) {
		for (i = 0; attr_name(class->dev_attrs[i]); i++)
			device_remove_file(dev, &class->dev_attrs[i]);
	}
}


284 285 286 287 288 289
static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}

290 291
/*
 *	devices_subsys - structure to be registered with kobject core.
L
Linus Torvalds 已提交
292 293
 */

294
decl_subsys(devices, &ktype_device, &device_uevent_ops);
L
Linus Torvalds 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326


/**
 *	device_create_file - create sysfs attribute file for device.
 *	@dev:	device.
 *	@attr:	device attribute descriptor.
 */

int device_create_file(struct device * dev, struct device_attribute * attr)
{
	int error = 0;
	if (get_device(dev)) {
		error = sysfs_create_file(&dev->kobj, &attr->attr);
		put_device(dev);
	}
	return error;
}

/**
 *	device_remove_file - remove sysfs attribute file.
 *	@dev:	device.
 *	@attr:	device attribute descriptor.
 */

void device_remove_file(struct device * dev, struct device_attribute * attr)
{
	if (get_device(dev)) {
		sysfs_remove_file(&dev->kobj, &attr->attr);
		put_device(dev);
	}
}

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
/**
 * 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);

353 354 355 356 357 358 359 360 361 362 363 364 365 366
static void klist_children_get(struct klist_node *n)
{
	struct device *dev = container_of(n, struct device, knode_parent);

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
	struct device *dev = container_of(n, struct device, knode_parent);

	put_device(dev);
}

L
Linus Torvalds 已提交
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

/**
 *	device_initialize - init device structure.
 *	@dev:	device.
 *
 *	This prepares the device for use by other layers,
 *	including adding it to the device hierarchy.
 *	It is the first half of device_register(), if called by
 *	that, though it can also be called separately, so one
 *	may use @dev's fields (e.g. the refcount).
 */

void device_initialize(struct device *dev)
{
	kobj_set_kset_s(dev, devices_subsys);
	kobject_init(&dev->kobj);
383 384
	klist_init(&dev->klist_children, klist_children_get,
		   klist_children_put);
L
Linus Torvalds 已提交
385
	INIT_LIST_HEAD(&dev->dma_pools);
386
	INIT_LIST_HEAD(&dev->node);
387
	init_MUTEX(&dev->sem);
D
David Brownell 已提交
388
	device_init_wakeup(dev, 0);
389
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
390 391
}

392
#ifdef CONFIG_SYSFS_DEPRECATED
393 394
static struct kobject * get_device_parent(struct device *dev,
					  struct device *parent)
395 396 397 398
{
	/* Set the parent to the class, not the parent device */
	/* this keeps sysfs from having a symlink to make old udevs happy */
	if (dev->class)
399
		return &dev->class->subsys.kset.kobj;
400
	else if (parent)
401
		return &parent->kobj;
402

403
	return NULL;
404 405
}
#else
406
static struct kobject * virtual_device_parent(struct device *dev)
407 408
{
	if (!dev->class)
409
		return ERR_PTR(-ENODEV);
410 411 412 413 414 415 416 417 418

	if (!dev->class->virtual_dir) {
		static struct kobject *virtual_dir = NULL;

		if (!virtual_dir)
			virtual_dir = kobject_add_dir(&devices_subsys.kset.kobj, "virtual");
		dev->class->virtual_dir = kobject_add_dir(virtual_dir, dev->class->name);
	}

419
	return dev->class->virtual_dir;
420 421
}

422 423
static struct kobject * get_device_parent(struct device *dev,
					  struct device *parent)
424 425 426
{
	/* if this is a class device, and has no parent, create one */
	if ((dev->class) && (parent == NULL)) {
427
		return virtual_device_parent(dev);
428
	} else if (parent)
429 430 431
		return &parent->kobj;
	return NULL;
}
432

433 434 435 436 437 438 439 440 441
#endif
static int setup_parent(struct device *dev, struct device *parent)
{
	struct kobject *kobj;
	kobj = get_device_parent(dev, parent);
	if (IS_ERR(kobj))
		return PTR_ERR(kobj);
	if (kobj)
		dev->kobj.parent = kobj;
442 443 444
	return 0;
}

L
Linus Torvalds 已提交
445 446 447 448 449 450 451 452 453 454 455 456 457 458
/**
 *	device_add - add device to device hierarchy.
 *	@dev:	device.
 *
 *	This is part 2 of device_register(), though may be called
 *	separately _iff_ device_initialize() has been called separately.
 *
 *	This adds it to the kobject hierarchy via kobject_add(), adds it
 *	to the global and sibling lists for the device, then
 *	adds it to the other relevant subsystems of the driver model.
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
459
	char *class_name = NULL;
460
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
461 462 463 464 465 466
	int error = -EINVAL;

	dev = get_device(dev);
	if (!dev || !strlen(dev->bus_id))
		goto Error;

467
	pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
468

L
Linus Torvalds 已提交
469 470
	parent = get_device(dev->parent);

471 472 473
	error = setup_parent(dev, parent);
	if (error)
		goto Error;
L
Linus Torvalds 已提交
474 475 476

	/* first, register with generic layer. */
	kobject_set_name(&dev->kobj, "%s", dev->bus_id);
477 478
	error = kobject_add(&dev->kobj);
	if (error)
L
Linus Torvalds 已提交
479
		goto Error;
480

481 482 483 484
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

485 486 487 488 489
	/* notify clients of device entry (new way) */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->bus_notifier,
					     BUS_NOTIFY_ADD_DEVICE, dev);

490 491 492 493 494
	dev->uevent_attr.attr.name = "uevent";
	dev->uevent_attr.attr.mode = S_IWUSR;
	if (dev->driver)
		dev->uevent_attr.attr.owner = dev->driver->owner;
	dev->uevent_attr.store = store_uevent;
495 496 497
	error = device_create_file(dev, &dev->uevent_attr);
	if (error)
		goto attrError;
498

499 500 501 502 503
	if (MAJOR(dev->devt)) {
		struct device_attribute *attr;
		attr = kzalloc(sizeof(*attr), GFP_KERNEL);
		if (!attr) {
			error = -ENOMEM;
504
			goto ueventattrError;
505 506 507 508 509 510 511 512 513
		}
		attr->attr.name = "dev";
		attr->attr.mode = S_IRUGO;
		if (dev->driver)
			attr->attr.owner = dev->driver->owner;
		attr->show = show_dev;
		error = device_create_file(dev, attr);
		if (error) {
			kfree(attr);
514
			goto ueventattrError;
515 516 517 518 519
		}

		dev->devt_attr = attr;
	}

520 521 522
	if (dev->class) {
		sysfs_create_link(&dev->kobj, &dev->class->subsys.kset.kobj,
				  "subsystem");
523 524 525 526 527
		/* If this is not a "fake" compatible device, then create the
		 * symlink from the class to the device. */
		if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
			sysfs_create_link(&dev->class->subsys.kset.kobj,
					  &dev->kobj, dev->bus_id);
528
#ifdef CONFIG_SYSFS_DEPRECATED
529 530 531 532 533
		if (parent) {
			sysfs_create_link(&dev->kobj, &dev->parent->kobj, "device");
			class_name = make_class_name(dev->class->name, &dev->kobj);
			sysfs_create_link(&dev->parent->kobj, &dev->kobj, class_name);
		}
534
#endif
535
	}
536

537 538
	if ((error = device_add_attrs(dev)))
		goto AttrsError;
539 540
	if ((error = device_add_groups(dev)))
		goto GroupError;
L
Linus Torvalds 已提交
541 542 543 544
	if ((error = device_pm_add(dev)))
		goto PMError;
	if ((error = bus_add_device(dev)))
		goto BusError;
545
	kobject_uevent(&dev->kobj, KOBJ_ADD);
546 547
	if ((error = bus_attach_device(dev)))
		goto AttachError;
L
Linus Torvalds 已提交
548
	if (parent)
549
		klist_add_tail(&dev->knode_parent, &parent->klist_children);
L
Linus Torvalds 已提交
550

551 552
	if (dev->class) {
		down(&dev->class->sem);
553
		/* tie the class to the device */
554
		list_add_tail(&dev->node, &dev->class->devices);
555 556 557 558 559

		/* notify any interfaces that the device is here */
		list_for_each_entry(class_intf, &dev->class->interfaces, node)
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
560 561
		up(&dev->class->sem);
	}
L
Linus Torvalds 已提交
562
 Done:
563
 	kfree(class_name);
L
Linus Torvalds 已提交
564 565
	put_device(dev);
	return error;
566 567
 AttachError:
	bus_remove_device(dev);
L
Linus Torvalds 已提交
568 569 570
 BusError:
	device_pm_remove(dev);
 PMError:
571 572 573
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->bus_notifier,
					     BUS_NOTIFY_DEL_DEVICE, dev);
574 575
	device_remove_groups(dev);
 GroupError:
576 577
 	device_remove_attrs(dev);
 AttrsError:
578 579 580 581
	if (dev->devt_attr) {
		device_remove_file(dev, dev->devt_attr);
		kfree(dev->devt_attr);
	}
582 583
 ueventattrError:
	device_remove_file(dev, &dev->uevent_attr);
584
 attrError:
585
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
	kobject_del(&dev->kobj);
 Error:
	if (parent)
		put_device(parent);
	goto Done;
}


/**
 *	device_register - register a device with the system.
 *	@dev:	pointer to the device structure
 *
 *	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.
 */

int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}


/**
 *	get_device - increment reference count for device.
 *	@dev:	device.
 *
 *	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.
 */

struct device * get_device(struct device * dev)
{
	return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
}


/**
 *	put_device - decrement reference count.
 *	@dev:	device in question.
 */
void put_device(struct device * dev)
{
	if (dev)
		kobject_put(&dev->kobj);
}


/**
 *	device_del - delete device from system.
 *	@dev:	device.
 *
 *	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.
 *
 *	NOTE: this should be called manually _iff_ device_add() was
 *	also called manually.
 */

void device_del(struct device * dev)
{
	struct device * parent = dev->parent;
656
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
657 658

	if (parent)
659
		klist_del(&dev->knode_parent);
660
	if (dev->devt_attr) {
661
		device_remove_file(dev, dev->devt_attr);
662 663
		kfree(dev->devt_attr);
	}
664 665
	if (dev->class) {
		sysfs_remove_link(&dev->kobj, "subsystem");
666 667 668 669 670
		/* If this is not a "fake" compatible device, remove the
		 * symlink from the class to the device. */
		if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
			sysfs_remove_link(&dev->class->subsys.kset.kobj,
					  dev->bus_id);
671
#ifdef CONFIG_SYSFS_DEPRECATED
672
		if (parent) {
673 674
			char *class_name = make_class_name(dev->class->name,
							   &dev->kobj);
675
			sysfs_remove_link(&dev->parent->kobj, class_name);
676 677
			kfree(class_name);
			sysfs_remove_link(&dev->kobj, "device");
678
		}
679 680
#endif

681
		down(&dev->class->sem);
682 683 684 685 686
		/* notify any interfaces that the device is now gone */
		list_for_each_entry(class_intf, &dev->class->interfaces, node)
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
687 688
		list_del_init(&dev->node);
		up(&dev->class->sem);
689
	}
690
	device_remove_file(dev, &dev->uevent_attr);
691
	device_remove_groups(dev);
692
	device_remove_attrs(dev);
693
	bus_remove_device(dev);
L
Linus Torvalds 已提交
694 695 696 697 698 699

	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
700 701 702
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->bus_notifier,
					     BUS_NOTIFY_DEL_DEVICE, dev);
L
Linus Torvalds 已提交
703
	device_pm_remove(dev);
704
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
	kobject_del(&dev->kobj);
	if (parent)
		put_device(parent);
}

/**
 *	device_unregister - unregister device from system.
 *	@dev:	device going away.
 *
 *	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.
 */
void device_unregister(struct device * dev)
{
	pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
	device_del(dev);
	put_device(dev);
}


729 730 731 732 733 734
static struct device * next_device(struct klist_iter * i)
{
	struct klist_node * n = klist_next(i);
	return n ? container_of(n, struct device, knode_parent) : NULL;
}

L
Linus Torvalds 已提交
735 736
/**
 *	device_for_each_child - device child iterator.
737
 *	@parent: parent struct device.
L
Linus Torvalds 已提交
738 739 740
 *	@data:	data for the callback.
 *	@fn:	function to be called for each device.
 *
741
 *	Iterate over @parent's child devices, and call @fn for each,
L
Linus Torvalds 已提交
742 743 744 745 746
 *	passing it @data.
 *
 *	We check the return of @fn each time. If it returns anything
 *	other than 0, we break out and return that value.
 */
747
int device_for_each_child(struct device * parent, void * data,
L
Linus Torvalds 已提交
748 749
		     int (*fn)(struct device *, void *))
{
750
	struct klist_iter i;
L
Linus Torvalds 已提交
751 752 753
	struct device * child;
	int error = 0;

754 755 756 757
	klist_iter_init(&parent->klist_children, &i);
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
758 759 760
	return error;
}

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
/**
 * 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.
 */
struct device * device_find_child(struct device *parent, void *data,
				  int (*match)(struct device *, void *))
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

	klist_iter_init(&parent->klist_children, &i);
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}

L
Linus Torvalds 已提交
793 794 795 796 797 798
int __init devices_init(void)
{
	return subsystem_register(&devices_subsys);
}

EXPORT_SYMBOL_GPL(device_for_each_child);
799
EXPORT_SYMBOL_GPL(device_find_child);
L
Linus Torvalds 已提交
800 801 802 803 804 805 806 807 808 809 810 811

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);
812 813 814 815 816 817 818 819 820 821


static void device_create_release(struct device *dev)
{
	pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
	kfree(dev);
}

/**
 * device_create - creates a device and registers it with sysfs
822 823 824 825 826 827 828
 * @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
 * @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.
829 830 831
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
832 833 834 835
 * 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
836 837 838 839 840 841
 * pointer.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
struct device *device_create(struct class *class, struct device *parent,
842
			     dev_t devt, const char *fmt, ...)
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
{
	va_list args;
	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;

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

	return dev;

error:
	kfree(dev);
	return ERR_PTR(retval);
}
EXPORT_SYMBOL_GPL(device_create);

/**
 * device_destroy - removes a device that was created with device_create()
879 880
 * @class: pointer to the struct class that this device was registered with
 * @devt: the dev_t of the device that was previously registered
881
 *
882 883
 * This call unregisters and cleans up a device that was created with a
 * call to device_create().
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
 */
void device_destroy(struct class *class, dev_t devt)
{
	struct device *dev = NULL;
	struct device *dev_tmp;

	down(&class->sem);
	list_for_each_entry(dev_tmp, &class->devices, node) {
		if (dev_tmp->devt == devt) {
			dev = dev_tmp;
			break;
		}
	}
	up(&class->sem);

899
	if (dev)
900 901 902
		device_unregister(dev);
}
EXPORT_SYMBOL_GPL(device_destroy);
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
 */
int device_rename(struct device *dev, char *new_name)
{
	char *old_class_name = NULL;
	char *new_class_name = NULL;
	char *old_symlink_name = NULL;
	int error;

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

	pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);

922
#ifdef CONFIG_SYSFS_DEPRECATED
923 924
	if ((dev->class) && (dev->parent))
		old_class_name = make_class_name(dev->class->name, &dev->kobj);
925
#endif
926 927 928

	if (dev->class) {
		old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
929 930 931 932
		if (!old_symlink_name) {
			error = -ENOMEM;
			goto out_free_old_class;
		}
933 934 935 936 937 938 939
		strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
	}

	strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);

	error = kobject_rename(&dev->kobj, new_name);

940
#ifdef CONFIG_SYSFS_DEPRECATED
941 942 943 944 945 946 947 948
	if (old_class_name) {
		new_class_name = make_class_name(dev->class->name, &dev->kobj);
		if (new_class_name) {
			sysfs_create_link(&dev->parent->kobj, &dev->kobj,
					  new_class_name);
			sysfs_remove_link(&dev->parent->kobj, old_class_name);
		}
	}
949 950
#endif

951 952 953 954 955 956 957 958 959 960
	if (dev->class) {
		sysfs_remove_link(&dev->class->subsys.kset.kobj,
				  old_symlink_name);
		sysfs_create_link(&dev->class->subsys.kset.kobj, &dev->kobj,
				  dev->bus_id);
	}
	put_device(dev);

	kfree(new_class_name);
	kfree(old_symlink_name);
961 962
 out_free_old_class:
	kfree(old_class_name);
963 964 965

	return error;
}
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985


static int device_move_class_links(struct device *dev,
				   struct device *old_parent,
				   struct device *new_parent)
{
#ifdef CONFIG_SYSFS_DEPRECATED
	int error;
	char *class_name;

	class_name = make_class_name(dev->class->name, &dev->kobj);
	if (!class_name) {
		error = PTR_ERR(class_name);
		class_name = NULL;
		goto out;
	}
	if (old_parent) {
		sysfs_remove_link(&dev->kobj, "device");
		sysfs_remove_link(&old_parent->kobj, class_name);
	}
986 987 988 989 990 991 992 993 994 995 996 997
	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");
	}
	else
		error = 0;
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
out:
	kfree(class_name);
	return error;
#else
	return 0;
#endif
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1009
 * @new_parent: the new parent of the device (can by NULL)
1010 1011 1012 1013 1014
 */
int device_move(struct device *dev, struct device *new_parent)
{
	int error;
	struct device *old_parent;
1015
	struct kobject *new_parent_kobj;
1016 1017 1018 1019 1020 1021

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

	new_parent = get_device(new_parent);
1022 1023 1024 1025
	new_parent_kobj = get_device_parent (dev, new_parent);
	if (IS_ERR(new_parent_kobj)) {
		error = PTR_ERR(new_parent_kobj);
		put_device(new_parent);
1026 1027 1028
		goto out;
	}
	pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1029 1030
		 new_parent ? new_parent->bus_id : "<NULL>");
	error = kobject_move(&dev->kobj, new_parent_kobj);
1031 1032 1033 1034 1035 1036 1037
	if (error) {
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1038
		klist_remove(&dev->knode_parent);
1039 1040
	if (new_parent)
		klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1041 1042 1043 1044 1045 1046 1047
	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)) {
1048 1049
			if (new_parent)
				klist_remove(&dev->knode_parent);
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
			if (old_parent)
				klist_add_tail(&dev->knode_parent,
					       &old_parent->klist_children);
		}
		put_device(new_parent);
		goto out;
	}
out_put:
	put_device(old_parent);
out:
	put_device(dev);
	return error;
}

EXPORT_SYMBOL_GPL(device_move);