core.c 74.4 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
 *
 * This file is released under the GPLv2
 *
 */

#include <linux/device.h>
#include <linux/err.h>
15
#include <linux/fwnode.h>
L
Linus Torvalds 已提交
16 17 18 19
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/string.h>
20
#include <linux/kdev_t.h>
21
#include <linux/notifier.h>
22 23
#include <linux/of.h>
#include <linux/of_device.h>
24
#include <linux/genhd.h>
25
#include <linux/kallsyms.h>
26
#include <linux/mutex.h>
27
#include <linux/pm_runtime.h>
28
#include <linux/netdevice.h>
29
#include <linux/sched/signal.h>
30
#include <linux/sysfs.h>
L
Linus Torvalds 已提交
31 32 33 34

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

35 36 37 38 39 40
#ifdef CONFIG_SYSFS_DEPRECATED
#ifdef CONFIG_SYSFS_DEPRECATED_V2
long sysfs_deprecated = 1;
#else
long sysfs_deprecated = 0;
#endif
41
static int __init sysfs_deprecated_setup(char *arg)
42
{
43
	return kstrtol(arg, 10, &sysfs_deprecated);
44 45 46 47
}
early_param("sysfs.deprecated", sysfs_deprecated_setup);
#endif

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 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
/* Device links support. */

#ifdef CONFIG_SRCU
static DEFINE_MUTEX(device_links_lock);
DEFINE_STATIC_SRCU(device_links_srcu);

static inline void device_links_write_lock(void)
{
	mutex_lock(&device_links_lock);
}

static inline void device_links_write_unlock(void)
{
	mutex_unlock(&device_links_lock);
}

int device_links_read_lock(void)
{
	return srcu_read_lock(&device_links_srcu);
}

void device_links_read_unlock(int idx)
{
	srcu_read_unlock(&device_links_srcu, idx);
}
#else /* !CONFIG_SRCU */
static DECLARE_RWSEM(device_links_lock);

static inline void device_links_write_lock(void)
{
	down_write(&device_links_lock);
}

static inline void device_links_write_unlock(void)
{
	up_write(&device_links_lock);
}

int device_links_read_lock(void)
{
	down_read(&device_links_lock);
	return 0;
}

void device_links_read_unlock(int not_used)
{
	up_read(&device_links_lock);
}
#endif /* !CONFIG_SRCU */

/**
 * device_is_dependent - Check if one device depends on another one
 * @dev: Device to check dependencies for.
 * @target: Device to check against.
 *
 * Check if @target depends on @dev or any device dependent on it (its child or
 * its consumer etc).  Return 1 if that is the case or 0 otherwise.
 */
static int device_is_dependent(struct device *dev, void *target)
{
	struct device_link *link;
	int ret;

	if (WARN_ON(dev == target))
		return 1;

	ret = device_for_each_child(dev, target, device_is_dependent);
	if (ret)
		return ret;

	list_for_each_entry(link, &dev->links.consumers, s_node) {
		if (WARN_ON(link->consumer == target))
			return 1;

		ret = device_is_dependent(link->consumer, target);
		if (ret)
			break;
	}
	return ret;
}

static int device_reorder_to_tail(struct device *dev, void *not_used)
{
	struct device_link *link;

	/*
	 * Devices that have not been registered yet will be put to the ends
	 * of the lists during the registration, so skip them here.
	 */
	if (device_is_registered(dev))
		devices_kset_move_last(dev);

	if (device_pm_initialized(dev))
		device_pm_move_last(dev);

	device_for_each_child(dev, NULL, device_reorder_to_tail);
	list_for_each_entry(link, &dev->links.consumers, s_node)
		device_reorder_to_tail(link->consumer, NULL);

	return 0;
}

/**
 * device_link_add - Create a link between two devices.
 * @consumer: Consumer end of the link.
 * @supplier: Supplier end of the link.
 * @flags: Link flags.
 *
R
Rafael J. Wysocki 已提交
156 157 158 159 160 161 162 163
 * The caller is responsible for the proper synchronization of the link creation
 * with runtime PM.  First, setting the DL_FLAG_PM_RUNTIME flag will cause the
 * runtime PM framework to take the link into account.  Second, if the
 * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will
 * be forced into the active metastate and reference-counted upon the creation
 * of the link.  If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be
 * ignored.
 *
164 165 166 167 168 169 170 171 172 173 174 175
 * If the DL_FLAG_AUTOREMOVE is set, the link will be removed automatically
 * when the consumer device driver unbinds from it.  The combination of both
 * DL_FLAG_AUTOREMOVE and DL_FLAG_STATELESS set is invalid and will cause NULL
 * to be returned.
 *
 * A side effect of the link creation is re-ordering of dpm_list and the
 * devices_kset list by moving the consumer device and all devices depending
 * on it to the ends of these lists (that does not happen to devices that have
 * not been registered when this function is called).
 *
 * The supplier device is required to be registered when this function is called
 * and NULL will be returned if that is not the case.  The consumer device need
176
 * not be registered, however.
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
 */
struct device_link *device_link_add(struct device *consumer,
				    struct device *supplier, u32 flags)
{
	struct device_link *link;

	if (!consumer || !supplier ||
	    ((flags & DL_FLAG_STATELESS) && (flags & DL_FLAG_AUTOREMOVE)))
		return NULL;

	device_links_write_lock();
	device_pm_lock();

	/*
	 * If the supplier has not been fully registered yet or there is a
	 * reverse dependency between the consumer and the supplier already in
	 * the graph, return NULL.
	 */
	if (!device_pm_initialized(supplier)
	    || device_is_dependent(consumer, supplier)) {
		link = NULL;
		goto out;
	}

	list_for_each_entry(link, &supplier->links.consumers, s_node)
		if (link->consumer == consumer)
			goto out;

R
Rafael J. Wysocki 已提交
205
	link = kzalloc(sizeof(*link), GFP_KERNEL);
206 207 208
	if (!link)
		goto out;

209 210 211 212 213 214 215 216 217
	if (flags & DL_FLAG_PM_RUNTIME) {
		if (flags & DL_FLAG_RPM_ACTIVE) {
			if (pm_runtime_get_sync(supplier) < 0) {
				pm_runtime_put_noidle(supplier);
				kfree(link);
				link = NULL;
				goto out;
			}
			link->rpm_active = true;
R
Rafael J. Wysocki 已提交
218
		}
219
		pm_runtime_new_link(consumer);
R
Rafael J. Wysocki 已提交
220
	}
221 222 223 224 225 226 227 228
	get_device(supplier);
	link->supplier = supplier;
	INIT_LIST_HEAD(&link->s_node);
	get_device(consumer);
	link->consumer = consumer;
	INIT_LIST_HEAD(&link->c_node);
	link->flags = flags;

229
	/* Determine the initial link state. */
230 231 232 233 234 235 236
	if (flags & DL_FLAG_STATELESS) {
		link->status = DL_STATE_NONE;
	} else {
		switch (supplier->links.status) {
		case DL_DEV_DRIVER_BOUND:
			switch (consumer->links.status) {
			case DL_DEV_PROBING:
R
Rafael J. Wysocki 已提交
237 238 239 240 241 242 243 244
				/*
				 * Balance the decrementation of the supplier's
				 * runtime PM usage counter after consumer probe
				 * in driver_probe_device().
				 */
				if (flags & DL_FLAG_PM_RUNTIME)
					pm_runtime_get_sync(supplier);

245 246 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 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
				link->status = DL_STATE_CONSUMER_PROBE;
				break;
			case DL_DEV_DRIVER_BOUND:
				link->status = DL_STATE_ACTIVE;
				break;
			default:
				link->status = DL_STATE_AVAILABLE;
				break;
			}
			break;
		case DL_DEV_UNBINDING:
			link->status = DL_STATE_SUPPLIER_UNBIND;
			break;
		default:
			link->status = DL_STATE_DORMANT;
			break;
		}
	}

	/*
	 * Move the consumer and all of the devices depending on it to the end
	 * of dpm_list and the devices_kset list.
	 *
	 * It is necessary to hold dpm_list locked throughout all that or else
	 * we may end up suspending with a wrong ordering of it.
	 */
	device_reorder_to_tail(consumer, NULL);

	list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
	list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);

	dev_info(consumer, "Linked as a consumer to %s\n", dev_name(supplier));

 out:
	device_pm_unlock();
	device_links_write_unlock();
	return link;
}
EXPORT_SYMBOL_GPL(device_link_add);

static void device_link_free(struct device_link *link)
{
	put_device(link->consumer);
	put_device(link->supplier);
	kfree(link);
}

#ifdef CONFIG_SRCU
static void __device_link_free_srcu(struct rcu_head *rhead)
{
	device_link_free(container_of(rhead, struct device_link, rcu_head));
}

static void __device_link_del(struct device_link *link)
{
	dev_info(link->consumer, "Dropping the link to %s\n",
		 dev_name(link->supplier));

303 304 305
	if (link->flags & DL_FLAG_PM_RUNTIME)
		pm_runtime_drop_link(link->consumer);

306 307 308 309 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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 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 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 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
	list_del_rcu(&link->s_node);
	list_del_rcu(&link->c_node);
	call_srcu(&device_links_srcu, &link->rcu_head, __device_link_free_srcu);
}
#else /* !CONFIG_SRCU */
static void __device_link_del(struct device_link *link)
{
	dev_info(link->consumer, "Dropping the link to %s\n",
		 dev_name(link->supplier));

	list_del(&link->s_node);
	list_del(&link->c_node);
	device_link_free(link);
}
#endif /* !CONFIG_SRCU */

/**
 * device_link_del - Delete a link between two devices.
 * @link: Device link to delete.
 *
 * The caller must ensure proper synchronization of this function with runtime
 * PM.
 */
void device_link_del(struct device_link *link)
{
	device_links_write_lock();
	device_pm_lock();
	__device_link_del(link);
	device_pm_unlock();
	device_links_write_unlock();
}
EXPORT_SYMBOL_GPL(device_link_del);

static void device_links_missing_supplier(struct device *dev)
{
	struct device_link *link;

	list_for_each_entry(link, &dev->links.suppliers, c_node)
		if (link->status == DL_STATE_CONSUMER_PROBE)
			WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
}

/**
 * device_links_check_suppliers - Check presence of supplier drivers.
 * @dev: Consumer device.
 *
 * Check links from this device to any suppliers.  Walk the list of the device's
 * links to suppliers and see if all of them are available.  If not, simply
 * return -EPROBE_DEFER.
 *
 * We need to guarantee that the supplier will not go away after the check has
 * been positive here.  It only can go away in __device_release_driver() and
 * that function  checks the device's links to consumers.  This means we need to
 * mark the link as "consumer probe in progress" to make the supplier removal
 * wait for us to complete (or bad things may happen).
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
int device_links_check_suppliers(struct device *dev)
{
	struct device_link *link;
	int ret = 0;

	device_links_write_lock();

	list_for_each_entry(link, &dev->links.suppliers, c_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		if (link->status != DL_STATE_AVAILABLE) {
			device_links_missing_supplier(dev);
			ret = -EPROBE_DEFER;
			break;
		}
		WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
	}
	dev->links.status = DL_DEV_PROBING;

	device_links_write_unlock();
	return ret;
}

/**
 * device_links_driver_bound - Update device links after probing its driver.
 * @dev: Device to update the links for.
 *
 * The probe has been successful, so update links from this device to any
 * consumers by changing their status to "available".
 *
 * Also change the status of @dev's links to suppliers to "active".
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
void device_links_driver_bound(struct device *dev)
{
	struct device_link *link;

	device_links_write_lock();

	list_for_each_entry(link, &dev->links.consumers, s_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		WARN_ON(link->status != DL_STATE_DORMANT);
		WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
	}

	list_for_each_entry(link, &dev->links.suppliers, c_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
		WRITE_ONCE(link->status, DL_STATE_ACTIVE);
	}

	dev->links.status = DL_DEV_DRIVER_BOUND;

	device_links_write_unlock();
}

/**
 * __device_links_no_driver - Update links of a device without a driver.
 * @dev: Device without a drvier.
 *
 * Delete all non-persistent links from this device to any suppliers.
 *
 * Persistent links stay around, but their status is changed to "available",
 * unless they already are in the "supplier unbind in progress" state in which
 * case they need not be updated.
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
static void __device_links_no_driver(struct device *dev)
{
	struct device_link *link, *ln;

	list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		if (link->flags & DL_FLAG_AUTOREMOVE)
			__device_link_del(link);
		else if (link->status != DL_STATE_SUPPLIER_UNBIND)
			WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
	}

	dev->links.status = DL_DEV_NO_DRIVER;
}

void device_links_no_driver(struct device *dev)
{
	device_links_write_lock();
	__device_links_no_driver(dev);
	device_links_write_unlock();
}

/**
 * device_links_driver_cleanup - Update links after driver removal.
 * @dev: Device whose driver has just gone away.
 *
 * Update links to consumers for @dev by changing their status to "dormant" and
 * invoke %__device_links_no_driver() to update links to suppliers for it as
 * appropriate.
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
void device_links_driver_cleanup(struct device *dev)
{
	struct device_link *link;

	device_links_write_lock();

	list_for_each_entry(link, &dev->links.consumers, s_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		WARN_ON(link->flags & DL_FLAG_AUTOREMOVE);
		WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
		WRITE_ONCE(link->status, DL_STATE_DORMANT);
	}

	__device_links_no_driver(dev);

	device_links_write_unlock();
}

/**
 * device_links_busy - Check if there are any busy links to consumers.
 * @dev: Device to check.
 *
 * Check each consumer of the device and return 'true' if its link's status
 * is one of "consumer probe" or "active" (meaning that the given consumer is
 * probing right now or its driver is present).  Otherwise, change the link
 * state to "supplier unbind" to prevent the consumer from being probed
 * successfully going forward.
 *
 * Return 'false' if there are no probing or active consumers.
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
bool device_links_busy(struct device *dev)
{
	struct device_link *link;
	bool ret = false;

	device_links_write_lock();

	list_for_each_entry(link, &dev->links.consumers, s_node) {
		if (link->flags & DL_FLAG_STATELESS)
			continue;

		if (link->status == DL_STATE_CONSUMER_PROBE
		    || link->status == DL_STATE_ACTIVE) {
			ret = true;
			break;
		}
		WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
	}

	dev->links.status = DL_DEV_UNBINDING;

	device_links_write_unlock();
	return ret;
}

/**
 * device_links_unbind_consumers - Force unbind consumers of the given device.
 * @dev: Device to unbind the consumers of.
 *
 * Walk the list of links to consumers for @dev and if any of them is in the
 * "consumer probe" state, wait for all device probes in progress to complete
 * and start over.
 *
 * If that's not the case, change the status of the link to "supplier unbind"
 * and check if the link was in the "active" state.  If so, force the consumer
 * driver to unbind and start over (the consumer will not re-probe as we have
 * changed the state of the link already).
 *
 * Links with the DL_FLAG_STATELESS flag set are ignored.
 */
void device_links_unbind_consumers(struct device *dev)
{
	struct device_link *link;

 start:
	device_links_write_lock();

	list_for_each_entry(link, &dev->links.consumers, s_node) {
		enum device_link_state status;

		if (link->flags & DL_FLAG_STATELESS)
			continue;

		status = link->status;
		if (status == DL_STATE_CONSUMER_PROBE) {
			device_links_write_unlock();

			wait_for_device_probe();
			goto start;
		}
		WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
		if (status == DL_STATE_ACTIVE) {
			struct device *consumer = link->consumer;

			get_device(consumer);

			device_links_write_unlock();

			device_release_driver_internal(consumer, NULL,
						       consumer->parent);
			put_device(consumer);
			goto start;
		}
	}

	device_links_write_unlock();
}

/**
 * device_links_purge - Delete existing links to other devices.
 * @dev: Target device.
 */
static void device_links_purge(struct device *dev)
{
	struct device_link *link, *ln;

	/*
	 * Delete all of the remaining links from this device to any other
	 * devices (either consumers or suppliers).
	 */
	device_links_write_lock();

	list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
		WARN_ON(link->status == DL_STATE_ACTIVE);
		__device_link_del(link);
	}

	list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
		WARN_ON(link->status != DL_STATE_DORMANT &&
			link->status != DL_STATE_NONE);
		__device_link_del(link);
	}

	device_links_write_unlock();
}

/* Device links support end. */

614 615
int (*platform_notify)(struct device *dev) = NULL;
int (*platform_notify_remove)(struct device *dev) = NULL;
616 617 618
static struct kobject *dev_kobj;
struct kobject *sysfs_dev_char_kobj;
struct kobject *sysfs_dev_block_kobj;
L
Linus Torvalds 已提交
619

620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
static DEFINE_MUTEX(device_hotplug_lock);

void lock_device_hotplug(void)
{
	mutex_lock(&device_hotplug_lock);
}

void unlock_device_hotplug(void)
{
	mutex_unlock(&device_hotplug_lock);
}

int lock_device_hotplug_sysfs(void)
{
	if (mutex_trylock(&device_hotplug_lock))
		return 0;

	/* Avoid busy looping (5 ms of sleep should do). */
	msleep(5);
	return restart_syscall();
}

642 643 644 645 646 647 648 649 650 651 652
#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 已提交
653

654 655 656 657 658
/**
 * 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 已提交
659
 * the device is not bound to a driver, it will return the name of the bus
660 661 662
 * it is attached to.  If it is not attached to a bus either, an empty
 * string will be returned.
 */
663
const char *dev_driver_string(const struct device *dev)
664
{
665 666 667 668 669 670 671 672
	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 :
673 674
			(dev->bus ? dev->bus->name :
			(dev->class ? dev->class->name : ""));
675
}
M
Matthew Wilcox 已提交
676
EXPORT_SYMBOL(dev_driver_string);
677

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

680 681
static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
			     char *buf)
L
Linus Torvalds 已提交
682
{
683
	struct device_attribute *dev_attr = to_dev_attr(attr);
684
	struct device *dev = kobj_to_dev(kobj);
685
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
686 687

	if (dev_attr->show)
688
		ret = dev_attr->show(dev, dev_attr, buf);
689
	if (ret >= (ssize_t)PAGE_SIZE) {
690 691
		print_symbol("dev_attr_show: %s returned bad count\n",
				(unsigned long)dev_attr->show);
692
	}
L
Linus Torvalds 已提交
693 694 695
	return ret;
}

696 697
static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
			      const char *buf, size_t count)
L
Linus Torvalds 已提交
698
{
699
	struct device_attribute *dev_attr = to_dev_attr(attr);
700
	struct device *dev = kobj_to_dev(kobj);
701
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
702 703

	if (dev_attr->store)
704
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
705 706 707
	return ret;
}

708
static const struct sysfs_ops dev_sysfs_ops = {
L
Linus Torvalds 已提交
709 710 711 712
	.show	= dev_attr_show,
	.store	= dev_attr_store,
};

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
#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 已提交
763

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t size)
{
	struct dev_ext_attribute *ea = to_ext_attr(attr);

	if (strtobool(buf, ea->var) < 0)
		return -EINVAL;

	return size;
}
EXPORT_SYMBOL_GPL(device_store_bool);

ssize_t device_show_bool(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", *(bool *)(ea->var));
}
EXPORT_SYMBOL_GPL(device_show_bool);

L
Linus Torvalds 已提交
785
/**
786 787
 * device_release - free device structure.
 * @kobj: device's kobject.
L
Linus Torvalds 已提交
788
 *
789 790 791
 * 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.
L
Linus Torvalds 已提交
792
 */
793
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
794
{
795
	struct device *dev = kobj_to_dev(kobj);
796
	struct device_private *p = dev->p;
L
Linus Torvalds 已提交
797

798 799 800 801 802 803 804 805 806 807 808
	/*
	 * Some platform devices are driven without driver attached
	 * and managed resources may have been acquired.  Make sure
	 * all resources are released.
	 *
	 * Drivers still can add resources into device after device
	 * is deleted but alive, so release devres here to avoid
	 * possible memory leak.
	 */
	devres_release_all(dev);

L
Linus Torvalds 已提交
809 810
	if (dev->release)
		dev->release(dev);
811 812
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
813 814
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
815 816
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
817
			"function, it is broken and must be fixed.\n",
818
			dev_name(dev));
819
	kfree(p);
L
Linus Torvalds 已提交
820 821
}

822 823
static const void *device_namespace(struct kobject *kobj)
{
824
	struct device *dev = kobj_to_dev(kobj);
825 826 827 828 829 830 831 832
	const void *ns = NULL;

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

	return ns;
}

833
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
834 835
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
836
	.namespace	= device_namespace,
L
Linus Torvalds 已提交
837 838 839
};


840
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
841 842 843
{
	struct kobj_type *ktype = get_ktype(kobj);

844
	if (ktype == &device_ktype) {
845
		struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
846 847
		if (dev->bus)
			return 1;
848 849
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
850 851 852 853
	}
	return 0;
}

854
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
855
{
856
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
857

858 859 860 861 862
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
863 864
}

865 866
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
867
{
868
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
869 870
	int retval = 0;

871
	/* add device node properties if present */
872
	if (MAJOR(dev->devt)) {
873 874
		const char *tmp;
		const char *name;
875
		umode_t mode = 0;
876 877
		kuid_t uid = GLOBAL_ROOT_UID;
		kgid_t gid = GLOBAL_ROOT_GID;
878

879 880
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
881
		name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
882 883
		if (name) {
			add_uevent_var(env, "DEVNAME=%s", name);
884 885
			if (mode)
				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
886 887 888 889
			if (!uid_eq(uid, GLOBAL_ROOT_UID))
				add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
			if (!gid_eq(gid, GLOBAL_ROOT_GID))
				add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
890
			kfree(tmp);
891
		}
892 893
	}

894
	if (dev->type && dev->type->name)
895
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
896

897
	if (dev->driver)
898
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
899

900 901 902
	/* Add common DT information about the device */
	of_device_uevent(dev, env);

903
	/* have the bus specific function add its stuff */
904
	if (dev->bus && dev->bus->uevent) {
905
		retval = dev->bus->uevent(dev, env);
906
		if (retval)
907
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
908
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
909 910
	}

911
	/* have the class specific function add its stuff */
912
	if (dev->class && dev->class->dev_uevent) {
913
		retval = dev->class->dev_uevent(dev, env);
914
		if (retval)
915
			pr_debug("device: '%s': %s: class uevent() "
916
				 "returned %d\n", dev_name(dev),
917
				 __func__, retval);
918 919
	}

920
	/* have the device type specific function add its stuff */
921
	if (dev->type && dev->type->uevent) {
922
		retval = dev->type->uevent(dev, env);
923
		if (retval)
924
			pr_debug("device: '%s': %s: dev_type uevent() "
925
				 "returned %d\n", dev_name(dev),
926
				 __func__, retval);
927 928
	}

L
Linus Torvalds 已提交
929 930 931
	return retval;
}

932
static const struct kset_uevent_ops device_uevent_ops = {
933 934 935
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
936 937
};

938
static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
939 940 941 942
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
943
	struct kobj_uevent_env *env = NULL;
944 945 946 947 948 949
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
950 951
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
952 953
	if (!top_kobj->kset)
		goto out;
954

955 956 957 958 959 960 961 962 963
	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;

964 965
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
966 967
		return -ENOMEM;

968
	/* let the kset specific function add its keys */
969
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
970 971 972 973
	if (retval)
		goto out;

	/* copy keys to file */
974 975
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
976
out:
977
	kfree(env);
978 979 980
	return count;
}

981
static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
982 983
			    const char *buf, size_t count)
{
984 985
	if (kobject_synth_uevent(&dev->kobj, buf, count))
		dev_err(dev, "uevent: failed to send synthetic uevent\n");
986

987 988
	return count;
}
989
static DEVICE_ATTR_RW(uevent);
990

991
static ssize_t online_show(struct device *dev, struct device_attribute *attr,
992 993 994 995
			   char *buf)
{
	bool val;

996
	device_lock(dev);
997
	val = !dev->offline;
998
	device_unlock(dev);
999 1000 1001
	return sprintf(buf, "%u\n", val);
}

1002
static ssize_t online_store(struct device *dev, struct device_attribute *attr,
1003 1004 1005 1006 1007 1008 1009 1010 1011
			    const char *buf, size_t count)
{
	bool val;
	int ret;

	ret = strtobool(buf, &val);
	if (ret < 0)
		return ret;

1012 1013 1014 1015
	ret = lock_device_hotplug_sysfs();
	if (ret)
		return ret;

1016 1017 1018 1019
	ret = val ? device_online(dev) : device_offline(dev);
	unlock_device_hotplug();
	return ret < 0 ? ret : count;
}
1020
static DEVICE_ATTR_RW(online);
1021

1022
int device_add_groups(struct device *dev, const struct attribute_group **groups)
1023
{
1024
	return sysfs_create_groups(&dev->kobj, groups);
1025 1026
}

1027 1028
void device_remove_groups(struct device *dev,
			  const struct attribute_group **groups)
1029
{
1030
	sysfs_remove_groups(&dev->kobj, groups);
1031 1032
}

1033 1034 1035
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
1036
	const struct device_type *type = dev->type;
1037
	int error;
1038

1039
	if (class) {
1040
		error = device_add_groups(dev, class->dev_groups);
1041
		if (error)
1042
			return error;
1043
	}
1044

1045 1046
	if (type) {
		error = device_add_groups(dev, type->groups);
1047
		if (error)
1048
			goto err_remove_class_groups;
1049 1050
	}

1051 1052 1053 1054
	error = device_add_groups(dev, dev->groups);
	if (error)
		goto err_remove_type_groups;

1055
	if (device_supports_offline(dev) && !dev->offline_disabled) {
1056
		error = device_create_file(dev, &dev_attr_online);
1057
		if (error)
1058
			goto err_remove_dev_groups;
1059 1060
	}

1061 1062
	return 0;

1063 1064
 err_remove_dev_groups:
	device_remove_groups(dev, dev->groups);
1065 1066 1067
 err_remove_type_groups:
	if (type)
		device_remove_groups(dev, type->groups);
1068 1069 1070
 err_remove_class_groups:
	if (class)
		device_remove_groups(dev, class->dev_groups);
1071

1072 1073 1074 1075 1076 1077
	return error;
}

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

1080
	device_remove_file(dev, &dev_attr_online);
1081
	device_remove_groups(dev, dev->groups);
1082

1083 1084 1085
	if (type)
		device_remove_groups(dev, type->groups);

1086
	if (class)
1087
		device_remove_groups(dev, class->dev_groups);
1088 1089
}

1090
static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
1091 1092 1093 1094
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}
1095
static DEVICE_ATTR_RO(dev);
1096

1097
/* /sys/devices/ */
1098
struct kset *devices_kset;
L
Linus Torvalds 已提交
1099

1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
/**
 * devices_kset_move_before - Move device in the devices_kset's list.
 * @deva: Device to move.
 * @devb: Device @deva should come before.
 */
static void devices_kset_move_before(struct device *deva, struct device *devb)
{
	if (!devices_kset)
		return;
	pr_debug("devices_kset: Moving %s before %s\n",
		 dev_name(deva), dev_name(devb));
	spin_lock(&devices_kset->list_lock);
	list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
	spin_unlock(&devices_kset->list_lock);
}

/**
 * devices_kset_move_after - Move device in the devices_kset's list.
 * @deva: Device to move
 * @devb: Device @deva should come after.
 */
static void devices_kset_move_after(struct device *deva, struct device *devb)
{
	if (!devices_kset)
		return;
	pr_debug("devices_kset: Moving %s after %s\n",
		 dev_name(deva), dev_name(devb));
	spin_lock(&devices_kset->list_lock);
	list_move(&deva->kobj.entry, &devb->kobj.entry);
	spin_unlock(&devices_kset->list_lock);
}

/**
 * devices_kset_move_last - move the device to the end of devices_kset's list.
 * @dev: device to move
 */
void devices_kset_move_last(struct device *dev)
{
	if (!devices_kset)
		return;
	pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
	spin_lock(&devices_kset->list_lock);
	list_move_tail(&dev->kobj.entry, &devices_kset->list);
	spin_unlock(&devices_kset->list_lock);
}

L
Linus Torvalds 已提交
1146
/**
1147 1148 1149
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
1150
 */
1151 1152
int device_create_file(struct device *dev,
		       const struct device_attribute *attr)
L
Linus Torvalds 已提交
1153 1154
{
	int error = 0;
1155 1156 1157

	if (dev) {
		WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
1158 1159
			"Attribute %s: write permission without 'store'\n",
			attr->attr.name);
1160
		WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
1161 1162
			"Attribute %s: read permission without 'show'\n",
			attr->attr.name);
L
Linus Torvalds 已提交
1163
		error = sysfs_create_file(&dev->kobj, &attr->attr);
1164 1165
	}

L
Linus Torvalds 已提交
1166 1167
	return error;
}
1168
EXPORT_SYMBOL_GPL(device_create_file);
L
Linus Torvalds 已提交
1169 1170

/**
1171 1172 1173
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
1174
 */
1175 1176
void device_remove_file(struct device *dev,
			const struct device_attribute *attr)
L
Linus Torvalds 已提交
1177
{
1178
	if (dev)
L
Linus Torvalds 已提交
1179 1180
		sysfs_remove_file(&dev->kobj, &attr->attr);
}
1181
EXPORT_SYMBOL_GPL(device_remove_file);
L
Linus Torvalds 已提交
1182

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
/**
 * device_remove_file_self - remove sysfs attribute file from its own method.
 * @dev: device.
 * @attr: device attribute descriptor.
 *
 * See kernfs_remove_self() for details.
 */
bool device_remove_file_self(struct device *dev,
			     const struct device_attribute *attr)
{
	if (dev)
		return sysfs_remove_file_self(&dev->kobj, &attr->attr);
	else
		return false;
}
EXPORT_SYMBOL_GPL(device_remove_file_self);

1200 1201 1202 1203 1204
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
1205 1206
int device_create_bin_file(struct device *dev,
			   const struct bin_attribute *attr)
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
{
	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.
 */
1220 1221
void device_remove_bin_file(struct device *dev,
			    const struct bin_attribute *attr)
1222 1223 1224 1225 1226 1227
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

1228 1229
static void klist_children_get(struct klist_node *n)
{
1230 1231
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
1232 1233 1234 1235 1236 1237

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
1238 1239
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
1240 1241 1242 1243

	put_device(dev);
}

L
Linus Torvalds 已提交
1244
/**
1245 1246
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
1247
 *
1248 1249
 * This prepares the device for use by other layers by initializing
 * its fields.
1250
 * It is the first half of device_register(), if called by
1251 1252 1253 1254 1255
 * 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.
 *
1256 1257 1258 1259 1260
 * 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.
 *
1261 1262
 * NOTE: Use put_device() to give up your reference instead of freeing
 * @dev directly once you have called this function.
L
Linus Torvalds 已提交
1263 1264 1265
 */
void device_initialize(struct device *dev)
{
1266
	dev->kobj.kset = devices_kset;
1267
	kobject_init(&dev->kobj, &device_ktype);
L
Linus Torvalds 已提交
1268
	INIT_LIST_HEAD(&dev->dma_pools);
1269
	mutex_init(&dev->mutex);
1270
	lockdep_set_novalidate_class(&dev->mutex);
T
Tejun Heo 已提交
1271 1272
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
1273
	device_pm_init(dev);
1274
	set_dev_node(dev, -1);
1275 1276 1277
#ifdef CONFIG_GENERIC_MSI_IRQ
	INIT_LIST_HEAD(&dev->msi_list);
#endif
1278 1279 1280
	INIT_LIST_HEAD(&dev->links.consumers);
	INIT_LIST_HEAD(&dev->links.suppliers);
	dev->links.status = DL_DEV_NO_DRIVER;
L
Linus Torvalds 已提交
1281
}
1282
EXPORT_SYMBOL_GPL(device_initialize);
L
Linus Torvalds 已提交
1283

1284
struct kobject *virtual_device_parent(struct device *dev)
1285
{
1286
	static struct kobject *virtual_dir = NULL;
1287

1288
	if (!virtual_dir)
1289
		virtual_dir = kobject_create_and_add("virtual",
1290
						     &devices_kset->kobj);
1291

1292
	return virtual_dir;
1293 1294
}

1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
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)
1310
{
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
	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;
1325 1326
	int retval;

1327 1328 1329 1330 1331 1332 1333
	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
	if (!dir)
		return NULL;

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

1334
	dir->kobj.kset = &class->p->glue_dirs;
1335 1336 1337 1338 1339 1340 1341 1342 1343

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

1344
static DEFINE_MUTEX(gdp_mutex);
1345 1346 1347 1348

static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
{
1349 1350 1351 1352 1353
	if (dev->class) {
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

1354
#ifdef CONFIG_BLOCK
1355
		/* block disks show up in /sys/block */
1356
		if (sysfs_deprecated && dev->class == &block_class) {
1357 1358
			if (parent && parent->class == &block_class)
				return &parent->kobj;
1359
			return &block_class.p->subsys.kobj;
1360
		}
1361
#endif
1362

1363 1364
		/*
		 * If we have no parent, we live in "virtual".
1365 1366
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
1367 1368 1369
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
1370
		else if (parent->class && !dev->class->ns_type)
1371 1372 1373 1374
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

1375 1376
		mutex_lock(&gdp_mutex);

1377
		/* find our class-directory at the parent and reference it */
1378 1379
		spin_lock(&dev->class->p->glue_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
1380 1381 1382 1383
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
1384
		spin_unlock(&dev->class->p->glue_dirs.list_lock);
1385 1386
		if (kobj) {
			mutex_unlock(&gdp_mutex);
1387
			return kobj;
1388
		}
1389 1390

		/* or create a new class-directory at the parent device */
1391
		k = class_dir_create_and_add(dev->class, parent_kobj);
1392
		/* do not emit an uevent for this simple "glue" directory */
1393
		mutex_unlock(&gdp_mutex);
1394
		return k;
1395 1396
	}

1397 1398 1399 1400
	/* subsystems can specify a default root directory for their devices */
	if (!parent && dev->bus && dev->bus->dev_root)
		return &dev->bus->dev_root->kobj;

1401
	if (parent)
1402 1403 1404
		return &parent->kobj;
	return NULL;
}
1405

1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
static inline bool live_in_glue_dir(struct kobject *kobj,
				    struct device *dev)
{
	if (!kobj || !dev->class ||
	    kobj->kset != &dev->class->p->glue_dirs)
		return false;
	return true;
}

static inline struct kobject *get_glue_dir(struct device *dev)
{
	return dev->kobj.parent;
}

/*
 * make sure cleaning up dir as the last step, we need to make
 * sure .release handler of kobject is run with holding the
 * global lock
 */
1425
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
1426
{
1427
	/* see if we live in a "glue" directory */
1428
	if (!live_in_glue_dir(glue_dir, dev))
1429 1430
		return;

1431
	mutex_lock(&gdp_mutex);
1432
	kobject_put(glue_dir);
1433
	mutex_unlock(&gdp_mutex);
1434
}
1435

1436 1437
static int device_add_class_symlinks(struct device *dev)
{
1438
	struct device_node *of_node = dev_of_node(dev);
1439 1440
	int error;

1441 1442 1443 1444 1445 1446 1447
	if (of_node) {
		error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
		if (error)
			dev_warn(dev, "Error %d creating of_node link\n",error);
		/* An error here doesn't warrant bringing down the device */
	}

1448 1449
	if (!dev->class)
		return 0;
1450

1451
	error = sysfs_create_link(&dev->kobj,
1452
				  &dev->class->p->subsys.kobj,
1453 1454
				  "subsystem");
	if (error)
1455
		goto out_devnode;
1456

1457
	if (dev->parent && device_is_not_partition(dev)) {
1458
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
1459 1460
					  "device");
		if (error)
1461
			goto out_subsys;
1462 1463
	}

1464
#ifdef CONFIG_BLOCK
1465
	/* /sys/block has directories and does not need symlinks */
1466
	if (sysfs_deprecated && dev->class == &block_class)
1467
		return 0;
1468
#endif
1469

1470
	/* link in the class directory pointing to the device */
1471
	error = sysfs_create_link(&dev->class->p->subsys.kobj,
1472
				  &dev->kobj, dev_name(dev));
1473
	if (error)
1474
		goto out_device;
1475 1476 1477

	return 0;

1478 1479
out_device:
	sysfs_remove_link(&dev->kobj, "device");
1480

1481 1482
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
1483 1484
out_devnode:
	sysfs_remove_link(&dev->kobj, "of_node");
1485 1486 1487 1488 1489
	return error;
}

static void device_remove_class_symlinks(struct device *dev)
{
1490 1491 1492
	if (dev_of_node(dev))
		sysfs_remove_link(&dev->kobj, "of_node");

1493 1494
	if (!dev->class)
		return;
1495

1496
	if (dev->parent && device_is_not_partition(dev))
1497
		sysfs_remove_link(&dev->kobj, "device");
1498
	sysfs_remove_link(&dev->kobj, "subsystem");
1499
#ifdef CONFIG_BLOCK
1500
	if (sysfs_deprecated && dev->class == &block_class)
1501
		return;
1502
#endif
1503
	sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
1504 1505
}

1506 1507 1508
/**
 * dev_set_name - set a device name
 * @dev: device
1509
 * @fmt: format string for the device's name
1510 1511 1512 1513
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;
1514
	int err;
1515 1516

	va_start(vargs, fmt);
1517
	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
1518
	va_end(vargs);
1519
	return err;
1520 1521 1522
}
EXPORT_SYMBOL_GPL(dev_set_name);

1523 1524 1525 1526 1527 1528 1529 1530
/**
 * 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 已提交
1531 1532
 * device_remove_sys_dev_entry() will disagree about the presence of
 * the link.
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
 */
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);
	}
}

1571 1572 1573 1574 1575 1576 1577 1578
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);
1579
	INIT_LIST_HEAD(&dev->p->deferred_probe);
1580 1581 1582
	return 0;
}

L
Linus Torvalds 已提交
1583
/**
1584 1585
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
1586
 *
1587 1588
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
1589
 *
1590
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
1591 1592
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
1593
 *
1594 1595 1596 1597 1598 1599 1600
 * 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.
 *
1601 1602 1603
 * 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 已提交
1604 1605 1606
 */
int device_add(struct device *dev)
{
1607
	struct device *parent;
1608
	struct kobject *kobj;
1609
	struct class_interface *class_intf;
1610
	int error = -EINVAL;
1611
	struct kobject *glue_dir = NULL;
1612

L
Linus Torvalds 已提交
1613
	dev = get_device(dev);
1614 1615 1616
	if (!dev)
		goto done;

1617
	if (!dev->p) {
1618 1619 1620
		error = device_private_init(dev);
		if (error)
			goto done;
1621 1622
	}

1623 1624 1625 1626 1627 1628
	/*
	 * 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) {
1629
		dev_set_name(dev, "%s", dev->init_name);
1630 1631
		dev->init_name = NULL;
	}
1632

1633 1634 1635 1636
	/* 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);

1637 1638
	if (!dev_name(dev)) {
		error = -EINVAL;
1639
		goto name_error;
1640
	}
L
Linus Torvalds 已提交
1641

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

L
Linus Torvalds 已提交
1644
	parent = get_device(dev->parent);
1645 1646 1647
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
L
Linus Torvalds 已提交
1648

1649
	/* use parent numa_node */
1650
	if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
1651 1652
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
1653
	/* first, register with generic layer. */
1654 1655
	/* we require the name to be set before, and pass NULL */
	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1656 1657
	if (error) {
		glue_dir = get_glue_dir(dev);
L
Linus Torvalds 已提交
1658
		goto Error;
1659
	}
1660

1661 1662 1663 1664
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

1665
	error = device_create_file(dev, &dev_attr_uevent);
1666 1667
	if (error)
		goto attrError;
1668

1669 1670 1671
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
1672 1673
	error = device_add_attrs(dev);
	if (error)
1674
		goto AttrsError;
1675 1676
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
1677
		goto BusError;
1678
	error = dpm_sysfs_add(dev);
1679
	if (error)
1680 1681
		goto DPMError;
	device_pm_add(dev);
1682

1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
	if (MAJOR(dev->devt)) {
		error = device_create_file(dev, &dev_attr_dev);
		if (error)
			goto DevAttrError;

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto SysEntryError;

		devtmpfs_create_node(dev);
	}

1695
	/* Notify clients of device addition.  This call must come
1696
	 * after dpm_sysfs_add() and before kobject_uevent().
1697 1698 1699 1700 1701
	 */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_ADD_DEVICE, dev);

1702
	kobject_uevent(&dev->kobj, KOBJ_ADD);
1703
	bus_probe_device(dev);
L
Linus Torvalds 已提交
1704
	if (parent)
1705 1706
		klist_add_tail(&dev->p->knode_parent,
			       &parent->p->klist_children);
L
Linus Torvalds 已提交
1707

1708
	if (dev->class) {
1709
		mutex_lock(&dev->class->p->mutex);
1710
		/* tie the class to the device */
1711
		klist_add_tail(&dev->knode_class,
1712
			       &dev->class->p->klist_devices);
1713 1714

		/* notify any interfaces that the device is here */
1715
		list_for_each_entry(class_intf,
1716
				    &dev->class->p->interfaces, node)
1717 1718
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
1719
		mutex_unlock(&dev->class->p->mutex);
1720
	}
1721
done:
L
Linus Torvalds 已提交
1722 1723
	put_device(dev);
	return error;
1724 1725 1726 1727 1728 1729
 SysEntryError:
	if (MAJOR(dev->devt))
		device_remove_file(dev, &dev_attr_dev);
 DevAttrError:
	device_pm_remove(dev);
	dpm_sysfs_remove(dev);
1730
 DPMError:
1731 1732
	bus_remove_device(dev);
 BusError:
1733
	device_remove_attrs(dev);
1734
 AttrsError:
1735 1736
	device_remove_class_symlinks(dev);
 SymlinkError:
1737
	device_remove_file(dev, &dev_attr_uevent);
1738
 attrError:
1739
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1740
	glue_dir = get_glue_dir(dev);
L
Linus Torvalds 已提交
1741 1742
	kobject_del(&dev->kobj);
 Error:
1743
	cleanup_glue_dir(dev, glue_dir);
1744
	put_device(parent);
1745 1746 1747
name_error:
	kfree(dev->p);
	dev->p = NULL;
1748
	goto done;
L
Linus Torvalds 已提交
1749
}
1750
EXPORT_SYMBOL_GPL(device_add);
L
Linus Torvalds 已提交
1751 1752

/**
1753 1754
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
1755
 *
1756 1757 1758 1759 1760 1761
 * 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.
1762
 *
1763 1764 1765
 * For more information, see the kerneldoc for device_initialize()
 * and device_add().
 *
1766 1767 1768
 * 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 已提交
1769 1770 1771 1772 1773 1774
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}
1775
EXPORT_SYMBOL_GPL(device_register);
L
Linus Torvalds 已提交
1776 1777

/**
1778 1779
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
1780
 *
1781 1782 1783
 * 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 已提交
1784
 */
1785
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
1786
{
1787
	return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
L
Linus Torvalds 已提交
1788
}
1789
EXPORT_SYMBOL_GPL(get_device);
L
Linus Torvalds 已提交
1790 1791

/**
1792 1793
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1794
 */
1795
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1796
{
1797
	/* might_sleep(); */
L
Linus Torvalds 已提交
1798 1799 1800
	if (dev)
		kobject_put(&dev->kobj);
}
1801
EXPORT_SYMBOL_GPL(put_device);
L
Linus Torvalds 已提交
1802 1803

/**
1804 1805
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1806
 *
1807 1808 1809 1810 1811
 * 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 已提交
1812
 *
1813 1814
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1815
 */
1816
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1817
{
1818
	struct device *parent = dev->parent;
1819
	struct kobject *glue_dir = NULL;
1820
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1821

1822 1823 1824 1825 1826 1827
	/* 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);
1828 1829

	device_links_purge(dev);
1830
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1831
	if (parent)
1832
		klist_del(&dev->p->knode_parent);
1833
	if (MAJOR(dev->devt)) {
1834
		devtmpfs_delete_node(dev);
1835
		device_remove_sys_dev_entry(dev);
1836
		device_remove_file(dev, &dev_attr_dev);
1837
	}
1838
	if (dev->class) {
1839
		device_remove_class_symlinks(dev);
1840

1841
		mutex_lock(&dev->class->p->mutex);
1842
		/* notify any interfaces that the device is now gone */
1843
		list_for_each_entry(class_intf,
1844
				    &dev->class->p->interfaces, node)
1845 1846 1847
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1848
		klist_del(&dev->knode_class);
1849
		mutex_unlock(&dev->class->p->mutex);
1850
	}
1851
	device_remove_file(dev, &dev_attr_uevent);
1852
	device_remove_attrs(dev);
1853
	bus_remove_device(dev);
1854
	device_pm_remove(dev);
1855
	driver_deferred_probe_del(dev);
1856
	device_remove_properties(dev);
L
Linus Torvalds 已提交
1857 1858 1859 1860 1861 1862

	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1863 1864 1865
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_REMOVED_DEVICE, dev);
1866
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1867
	glue_dir = get_glue_dir(dev);
L
Linus Torvalds 已提交
1868
	kobject_del(&dev->kobj);
1869
	cleanup_glue_dir(dev, glue_dir);
1870
	put_device(parent);
L
Linus Torvalds 已提交
1871
}
1872
EXPORT_SYMBOL_GPL(device_del);
L
Linus Torvalds 已提交
1873 1874

/**
1875 1876
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1877
 *
1878 1879 1880 1881 1882 1883
 * 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 已提交
1884
 */
1885
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1886
{
1887
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1888 1889 1890
	device_del(dev);
	put_device(dev);
}
1891
EXPORT_SYMBOL_GPL(device_unregister);
L
Linus Torvalds 已提交
1892

1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
static struct device *prev_device(struct klist_iter *i)
{
	struct klist_node *n = klist_prev(i);
	struct device *dev = NULL;
	struct device_private *p;

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

1906
static struct device *next_device(struct klist_iter *i)
1907
{
1908
	struct klist_node *n = klist_next(i);
1909 1910 1911 1912 1913 1914 1915 1916
	struct device *dev = NULL;
	struct device_private *p;

	if (n) {
		p = to_device_private_parent(n);
		dev = p->device;
	}
	return dev;
1917 1918
}

1919
/**
1920
 * device_get_devnode - path of device node file
1921
 * @dev: device
1922
 * @mode: returned file access mode
1923 1924
 * @uid: returned file owner
 * @gid: returned file group
1925 1926 1927 1928 1929 1930 1931
 * @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.
 */
1932
const char *device_get_devnode(struct device *dev,
1933
			       umode_t *mode, kuid_t *uid, kgid_t *gid,
1934
			       const char **tmp)
1935 1936 1937 1938 1939 1940
{
	char *s;

	*tmp = NULL;

	/* the device type may provide a specific name */
1941
	if (dev->type && dev->type->devnode)
1942
		*tmp = dev->type->devnode(dev, mode, uid, gid);
1943 1944 1945 1946
	if (*tmp)
		return *tmp;

	/* the class may provide a specific name */
1947 1948
	if (dev->class && dev->class->devnode)
		*tmp = dev->class->devnode(dev, mode);
1949 1950 1951 1952 1953 1954 1955 1956
	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 '/' */
1957 1958
	s = kstrdup(dev_name(dev), GFP_KERNEL);
	if (!s)
1959
		return NULL;
1960 1961
	strreplace(s, '!', '/');
	return *tmp = s;
1962 1963
}

L
Linus Torvalds 已提交
1964
/**
1965 1966 1967
 * device_for_each_child - device child iterator.
 * @parent: parent struct device.
 * @fn: function to be called for each device.
1968
 * @data: data for the callback.
L
Linus Torvalds 已提交
1969
 *
1970 1971
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1972
 *
1973 1974
 * 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 已提交
1975
 */
1976 1977
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1978
{
1979
	struct klist_iter i;
1980
	struct device *child;
L
Linus Torvalds 已提交
1981 1982
	int error = 0;

1983 1984 1985
	if (!parent->p)
		return 0;

1986
	klist_iter_init(&parent->p->klist_children, &i);
1987 1988 1989
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1990 1991
	return error;
}
1992
EXPORT_SYMBOL_GPL(device_for_each_child);
L
Linus Torvalds 已提交
1993

1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
/**
 * device_for_each_child_reverse - device child iterator in reversed order.
 * @parent: parent struct device.
 * @fn: function to be called for each device.
 * @data: data for the callback.
 *
 * Iterate over @parent's child devices, and call @fn for each,
 * 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.
 */
int device_for_each_child_reverse(struct device *parent, void *data,
				  int (*fn)(struct device *dev, void *data))
{
	struct klist_iter i;
	struct device *child;
	int error = 0;

	if (!parent->p)
		return 0;

	klist_iter_init(&parent->p->klist_children, &i);
	while ((child = prev_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
	return error;
}
EXPORT_SYMBOL_GPL(device_for_each_child_reverse);

2024 2025 2026 2027
/**
 * device_find_child - device iterator for locating a particular device.
 * @parent: parent struct device
 * @match: Callback function to check device
2028
 * @data: Data to pass to match function
2029 2030 2031 2032 2033 2034 2035 2036 2037
 *
 * 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.
2038 2039
 *
 * NOTE: you will need to drop the reference with put_device() after use.
2040
 */
2041 2042
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
2043 2044 2045 2046 2047 2048 2049
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

2050
	klist_iter_init(&parent->p->klist_children, &i);
2051 2052 2053 2054 2055 2056
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}
2057
EXPORT_SYMBOL_GPL(device_find_child);
2058

L
Linus Torvalds 已提交
2059 2060
int __init devices_init(void)
{
2061 2062 2063
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
	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;

2074
	return 0;
2075 2076 2077 2078 2079 2080 2081 2082

 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 已提交
2083 2084
}

2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165
static int device_check_offline(struct device *dev, void *not_used)
{
	int ret;

	ret = device_for_each_child(dev, NULL, device_check_offline);
	if (ret)
		return ret;

	return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
}

/**
 * device_offline - Prepare the device for hot-removal.
 * @dev: Device to be put offline.
 *
 * Execute the device bus type's .offline() callback, if present, to prepare
 * the device for a subsequent hot-removal.  If that succeeds, the device must
 * not be used until either it is removed or its bus type's .online() callback
 * is executed.
 *
 * Call under device_hotplug_lock.
 */
int device_offline(struct device *dev)
{
	int ret;

	if (dev->offline_disabled)
		return -EPERM;

	ret = device_for_each_child(dev, NULL, device_check_offline);
	if (ret)
		return ret;

	device_lock(dev);
	if (device_supports_offline(dev)) {
		if (dev->offline) {
			ret = 1;
		} else {
			ret = dev->bus->offline(dev);
			if (!ret) {
				kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
				dev->offline = true;
			}
		}
	}
	device_unlock(dev);

	return ret;
}

/**
 * device_online - Put the device back online after successful device_offline().
 * @dev: Device to be put back online.
 *
 * If device_offline() has been successfully executed for @dev, but the device
 * has not been removed subsequently, execute its bus type's .online() callback
 * to indicate that the device can be used again.
 *
 * Call under device_hotplug_lock.
 */
int device_online(struct device *dev)
{
	int ret = 0;

	device_lock(dev);
	if (device_supports_offline(dev)) {
		if (dev->offline) {
			ret = dev->bus->online(dev);
			if (!ret) {
				kobject_uevent(&dev->kobj, KOBJ_ONLINE);
				dev->offline = false;
			}
		} else {
			ret = 1;
		}
	}
	device_unlock(dev);

	return ret;
}

2166
struct root_device {
2167 2168 2169 2170
	struct device dev;
	struct module *owner;
};

2171
static inline struct root_device *to_root_device(struct device *d)
2172 2173 2174
{
	return container_of(d, struct root_device, dev);
}
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198

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.
 *
2199 2200
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211
 * 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);

2212
	err = dev_set_name(&root->dev, "%s", name);
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225
	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);
	}

2226
#ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
	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
2245
 * @dev: device going away
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
 *
 * 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);

2261 2262 2263

static void device_create_release(struct device *dev)
{
2264
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
2265 2266 2267
	kfree(dev);
}

2268 2269 2270 2271 2272
static struct device *
device_create_groups_vargs(struct class *class, struct device *parent,
			   dev_t devt, void *drvdata,
			   const struct attribute_group **groups,
			   const char *fmt, va_list args)
2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
{
	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;
	}

2286
	device_initialize(dev);
2287 2288 2289
	dev->devt = devt;
	dev->class = class;
	dev->parent = parent;
2290
	dev->groups = groups;
2291
	dev->release = device_create_release;
2292
	dev_set_drvdata(dev, drvdata);
2293

2294 2295 2296 2297
	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
	if (retval)
		goto error;

2298
	retval = device_add(dev);
2299 2300 2301 2302 2303 2304
	if (retval)
		goto error;

	return dev;

error:
2305
	put_device(dev);
2306 2307
	return ERR_PTR(retval);
}
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340

/**
 * device_create_vargs - creates a device and registers it with sysfs
 * @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
 * @args: va_list 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.
 *
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
struct device *device_create_vargs(struct class *class, struct device *parent,
				   dev_t devt, void *drvdata, const char *fmt,
				   va_list args)
{
	return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
					  fmt, args);
}
2341 2342 2343
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
2344
 * device_create - creates a device and registers it with sysfs
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
 * @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.
 *
2362 2363
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
2364 2365 2366
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
2367 2368
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
2369 2370 2371 2372 2373 2374 2375 2376 2377
{
	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;
}
2378
EXPORT_SYMBOL_GPL(device_create);
2379

2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423
/**
 * device_create_with_groups - creates a device and registers it with sysfs
 * @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
 * @groups: NULL-terminated list of attribute groups to be created
 * @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.
 * Additional attributes specified in the groups parameter will also
 * be created automatically.
 *
 * 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.
 *
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
struct device *device_create_with_groups(struct class *class,
					 struct device *parent, dev_t devt,
					 void *drvdata,
					 const struct attribute_group **groups,
					 const char *fmt, ...)
{
	va_list vargs;
	struct device *dev;

	va_start(vargs, fmt);
	dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
					 fmt, vargs);
	va_end(vargs);
	return dev;
}
EXPORT_SYMBOL_GPL(device_create_with_groups);

2424
static int __match_devt(struct device *dev, const void *data)
2425
{
2426
	const dev_t *devt = data;
2427

2428
	return dev->devt == *devt;
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
}

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

2443
	dev = class_find_device(class, NULL, &devt, __match_devt);
2444 2445
	if (dev) {
		put_device(dev);
2446
		device_unregister(dev);
2447
	}
2448 2449
}
EXPORT_SYMBOL_GPL(device_destroy);
2450 2451 2452 2453 2454

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
2455 2456 2457 2458 2459
 *
 * 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.
2460
 *
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488
 * 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. :)
2489
 */
2490
int device_rename(struct device *dev, const char *new_name)
2491
{
2492
	struct kobject *kobj = &dev->kobj;
2493
	char *old_device_name = NULL;
2494 2495 2496 2497 2498 2499
	int error;

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

2500
	dev_dbg(dev, "renaming to %s\n", new_name);
2501

2502
	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
2503 2504 2505
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
2506 2507
	}

2508
	if (dev->class) {
2509 2510 2511
		error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
					     kobj, old_device_name,
					     new_name, kobject_namespace(kobj));
2512 2513 2514
		if (error)
			goto out;
	}
2515

2516
	error = kobject_rename(kobj, new_name);
2517
	if (error)
2518
		goto out;
2519

2520
out:
2521 2522
	put_device(dev);

2523
	kfree(old_device_name);
2524 2525 2526

	return error;
}
2527
EXPORT_SYMBOL_GPL(device_rename);
2528 2529 2530 2531 2532

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

2535 2536 2537 2538 2539 2540
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
2541 2542 2543 2544 2545
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
2546
 * @new_parent: the new parent of the device (can by NULL)
2547
 * @dpm_order: how to reorder the dpm_list
2548
 */
2549 2550
int device_move(struct device *dev, struct device *new_parent,
		enum dpm_order dpm_order)
2551 2552 2553
{
	int error;
	struct device *old_parent;
2554
	struct kobject *new_parent_kobj;
2555 2556 2557 2558 2559

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

2560
	device_pm_lock();
2561
	new_parent = get_device(new_parent);
2562
	new_parent_kobj = get_device_parent(dev, new_parent);
2563

2564 2565
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
2566
	error = kobject_move(&dev->kobj, new_parent_kobj);
2567
	if (error) {
2568
		cleanup_glue_dir(dev, new_parent_kobj);
2569 2570 2571 2572 2573 2574
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
2575
		klist_remove(&dev->p->knode_parent);
2576
	if (new_parent) {
2577 2578
		klist_add_tail(&dev->p->knode_parent,
			       &new_parent->p->klist_children);
2579 2580 2581
		set_dev_node(dev, dev_to_node(new_parent));
	}

2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
	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));
				}
2596
			}
2597 2598 2599
			cleanup_glue_dir(dev, new_parent_kobj);
			put_device(new_parent);
			goto out;
2600 2601
		}
	}
2602 2603 2604 2605 2606
	switch (dpm_order) {
	case DPM_ORDER_NONE:
		break;
	case DPM_ORDER_DEV_AFTER_PARENT:
		device_pm_move_after(dev, new_parent);
2607
		devices_kset_move_after(dev, new_parent);
2608 2609 2610
		break;
	case DPM_ORDER_PARENT_BEFORE_DEV:
		device_pm_move_before(new_parent, dev);
2611
		devices_kset_move_before(new_parent, dev);
2612 2613 2614
		break;
	case DPM_ORDER_DEV_LAST:
		device_pm_move_last(dev);
2615
		devices_kset_move_last(dev);
2616 2617
		break;
	}
2618

2619 2620
	put_device(old_parent);
out:
2621
	device_pm_unlock();
2622 2623 2624 2625
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
2626 2627 2628 2629 2630 2631

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
2632
	struct device *dev, *parent;
2633 2634 2635 2636 2637 2638 2639 2640 2641 2642

	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);
2643 2644 2645 2646 2647 2648

		/*
		 * hold reference count of device's parent to
		 * prevent it from being freed because parent's
		 * lock is to be held
		 */
2649
		parent = get_device(dev->parent);
2650 2651 2652 2653 2654 2655 2656
		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);
2657

2658
		/* hold lock to avoid race with probe/release */
2659 2660
		if (parent)
			device_lock(parent);
2661 2662
		device_lock(dev);

2663 2664 2665
		/* Don't allow any more runtime suspends */
		pm_runtime_get_noresume(dev);
		pm_runtime_barrier(dev);
2666 2667

		if (dev->bus && dev->bus->shutdown) {
2668 2669
			if (initcall_debug)
				dev_info(dev, "shutdown\n");
2670 2671
			dev->bus->shutdown(dev);
		} else if (dev->driver && dev->driver->shutdown) {
2672 2673
			if (initcall_debug)
				dev_info(dev, "shutdown\n");
2674 2675
			dev->driver->shutdown(dev);
		}
2676 2677

		device_unlock(dev);
2678 2679
		if (parent)
			device_unlock(parent);
2680

2681
		put_device(dev);
2682
		put_device(parent);
2683 2684

		spin_lock(&devices_kset->list_lock);
2685
	}
2686
	spin_unlock(&devices_kset->list_lock);
2687
}
2688 2689 2690 2691 2692 2693

/*
 * Device logging functions
 */

#ifdef CONFIG_PRINTK
2694 2695
static int
create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2696
{
2697
	const char *subsys;
2698
	size_t pos = 0;
2699

2700 2701 2702 2703 2704
	if (dev->class)
		subsys = dev->class->name;
	else if (dev->bus)
		subsys = dev->bus->name;
	else
2705
		return 0;
2706

2707
	pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2708 2709
	if (pos >= hdrlen)
		goto overflow;
2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724

	/*
	 * 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';
2725 2726 2727 2728
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=%c%u:%u",
				c, MAJOR(dev->devt), MINOR(dev->devt));
2729 2730 2731
	} else if (strcmp(subsys, "net") == 0) {
		struct net_device *net = to_net_dev(dev);

2732 2733 2734
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=n%u", net->ifindex);
2735
	} else {
2736 2737 2738
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=+%s:%s", subsys, dev_name(dev));
2739
	}
2740

2741 2742 2743
	if (pos >= hdrlen)
		goto overflow;

2744
	return pos;
2745 2746 2747 2748

overflow:
	dev_WARN(dev, "device/subsystem name too long");
	return 0;
2749 2750
}

2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
int dev_vprintk_emit(int level, const struct device *dev,
		     const char *fmt, va_list args)
{
	char hdr[128];
	size_t hdrlen;

	hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));

	return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
}
EXPORT_SYMBOL(dev_vprintk_emit);

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

	va_start(args, fmt);

	r = dev_vprintk_emit(level, dev, fmt, args);

	va_end(args);

	return r;
}
EXPORT_SYMBOL(dev_printk_emit);

2778
static void __dev_printk(const char *level, const struct device *dev,
2779 2780
			struct va_format *vaf)
{
2781 2782 2783 2784 2785
	if (dev)
		dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
				dev_driver_string(dev), dev_name(dev), vaf);
	else
		printk("%s(NULL device *): %pV", level, vaf);
2786 2787
}

2788 2789
void dev_printk(const char *level, const struct device *dev,
		const char *fmt, ...)
2790 2791 2792 2793 2794 2795 2796 2797 2798
{
	struct va_format vaf;
	va_list args;

	va_start(args, fmt);

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

2799
	__dev_printk(level, dev, &vaf);
2800

2801 2802 2803 2804 2805
	va_end(args);
}
EXPORT_SYMBOL(dev_printk);

#define define_dev_printk_level(func, kern_level)		\
2806
void func(const struct device *dev, const char *fmt, ...)	\
2807 2808 2809 2810 2811 2812 2813 2814 2815
{								\
	struct va_format vaf;					\
	va_list args;						\
								\
	va_start(args, fmt);					\
								\
	vaf.fmt = fmt;						\
	vaf.va = &args;						\
								\
2816
	__dev_printk(kern_level, dev, &vaf);			\
2817
								\
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
	va_end(args);						\
}								\
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
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852

static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
{
	return fwnode && !IS_ERR(fwnode->secondary);
}

/**
 * set_primary_fwnode - Change the primary firmware node of a given device.
 * @dev: Device to handle.
 * @fwnode: New primary firmware node of the device.
 *
 * Set the device's firmware node pointer to @fwnode, but if a secondary
 * firmware node of the device is present, preserve it.
 */
void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
{
	if (fwnode) {
		struct fwnode_handle *fn = dev->fwnode;

		if (fwnode_is_primary(fn))
			fn = fn->secondary;

2853 2854 2855 2856
		if (fn) {
			WARN_ON(fwnode->secondary);
			fwnode->secondary = fn;
		}
2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
		dev->fwnode = fwnode;
	} else {
		dev->fwnode = fwnode_is_primary(dev->fwnode) ?
			dev->fwnode->secondary : NULL;
	}
}
EXPORT_SYMBOL_GPL(set_primary_fwnode);

/**
 * set_secondary_fwnode - Change the secondary firmware node of a given device.
 * @dev: Device to handle.
 * @fwnode: New secondary firmware node of the device.
 *
 * If a primary firmware node of the device is present, set its secondary
 * pointer to @fwnode.  Otherwise, set the device's firmware node pointer to
 * @fwnode.
 */
void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
{
	if (fwnode)
		fwnode->secondary = ERR_PTR(-ENODEV);

	if (fwnode_is_primary(dev->fwnode))
		dev->fwnode->secondary = fwnode;
	else
		dev->fwnode = fwnode;
}
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899

/**
 * device_set_of_node_from_dev - reuse device-tree node of another device
 * @dev: device whose device-tree node is being set
 * @dev2: device whose device-tree node is being reused
 *
 * Takes another reference to the new device-tree node after first dropping
 * any reference held to the old node.
 */
void device_set_of_node_from_dev(struct device *dev, const struct device *dev2)
{
	of_node_put(dev->of_node);
	dev->of_node = of_node_get(dev2->of_node);
	dev->of_node_reused = true;
}
EXPORT_SYMBOL_GPL(device_set_of_node_from_dev);