core.c 55.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5
/*
 * drivers/base/core.c - core driver model code (device registration, etc)
 *
 * Copyright (c) 2002-3 Patrick Mochel
 * Copyright (c) 2002-3 Open Source Development Labs
6 7
 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
 * Copyright (c) 2006 Novell, Inc.
L
Linus Torvalds 已提交
8 9 10 11 12 13 14 15 16 17 18
 *
 * This file is released under the GPLv2
 *
 */

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

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

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

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

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
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();
}

75 76 77 78 79 80 81 82 83 84 85
#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 已提交
86

87 88 89 90 91
/**
 * 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 已提交
92
 * the device is not bound to a driver, it will return the name of the bus
93 94 95
 * it is attached to.  If it is not attached to a bus either, an empty
 * string will be returned.
 */
96
const char *dev_driver_string(const struct device *dev)
97
{
98 99 100 101 102 103 104 105
	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 :
106 107
			(dev->bus ? dev->bus->name :
			(dev->class ? dev->class->name : ""));
108
}
M
Matthew Wilcox 已提交
109
EXPORT_SYMBOL(dev_driver_string);
110

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

113 114
static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
			     char *buf)
L
Linus Torvalds 已提交
115
{
116
	struct device_attribute *dev_attr = to_dev_attr(attr);
117
	struct device *dev = kobj_to_dev(kobj);
118
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
119 120

	if (dev_attr->show)
121
		ret = dev_attr->show(dev, dev_attr, buf);
122
	if (ret >= (ssize_t)PAGE_SIZE) {
123 124
		print_symbol("dev_attr_show: %s returned bad count\n",
				(unsigned long)dev_attr->show);
125
	}
L
Linus Torvalds 已提交
126 127 128
	return ret;
}

129 130
static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
			      const char *buf, size_t count)
L
Linus Torvalds 已提交
131
{
132
	struct device_attribute *dev_attr = to_dev_attr(attr);
133
	struct device *dev = kobj_to_dev(kobj);
134
	ssize_t ret = -EIO;
L
Linus Torvalds 已提交
135 136

	if (dev_attr->store)
137
		ret = dev_attr->store(dev, dev_attr, buf, count);
L
Linus Torvalds 已提交
138 139 140
	return ret;
}

141
static const struct sysfs_ops dev_sysfs_ops = {
L
Linus Torvalds 已提交
142 143 144 145
	.show	= dev_attr_show,
	.store	= dev_attr_store,
};

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
#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 已提交
196

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
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 已提交
218
/**
219 220
 * device_release - free device structure.
 * @kobj: device's kobject.
L
Linus Torvalds 已提交
221
 *
222 223 224
 * 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 已提交
225
 */
226
static void device_release(struct kobject *kobj)
L
Linus Torvalds 已提交
227
{
228
	struct device *dev = kobj_to_dev(kobj);
229
	struct device_private *p = dev->p;
L
Linus Torvalds 已提交
230

231 232 233 234 235 236 237 238 239 240 241
	/*
	 * 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 已提交
242 243
	if (dev->release)
		dev->release(dev);
244 245
	else if (dev->type && dev->type->release)
		dev->type->release(dev);
246 247
	else if (dev->class && dev->class->dev_release)
		dev->class->dev_release(dev);
A
Arjan van de Ven 已提交
248 249
	else
		WARN(1, KERN_ERR "Device '%s' does not have a release() "
250
			"function, it is broken and must be fixed.\n",
251
			dev_name(dev));
252
	kfree(p);
L
Linus Torvalds 已提交
253 254
}

255 256
static const void *device_namespace(struct kobject *kobj)
{
257
	struct device *dev = kobj_to_dev(kobj);
258 259 260 261 262 263 264 265
	const void *ns = NULL;

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

	return ns;
}

266
static struct kobj_type device_ktype = {
L
Linus Torvalds 已提交
267 268
	.release	= device_release,
	.sysfs_ops	= &dev_sysfs_ops,
269
	.namespace	= device_namespace,
L
Linus Torvalds 已提交
270 271 272
};


273
static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
274 275 276
{
	struct kobj_type *ktype = get_ktype(kobj);

277
	if (ktype == &device_ktype) {
278
		struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
279 280
		if (dev->bus)
			return 1;
281 282
		if (dev->class)
			return 1;
L
Linus Torvalds 已提交
283 284 285 286
	}
	return 0;
}

287
static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
L
Linus Torvalds 已提交
288
{
289
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
290

291 292 293 294 295
	if (dev->bus)
		return dev->bus->name;
	if (dev->class)
		return dev->class->name;
	return NULL;
L
Linus Torvalds 已提交
296 297
}

298 299
static int dev_uevent(struct kset *kset, struct kobject *kobj,
		      struct kobj_uevent_env *env)
L
Linus Torvalds 已提交
300
{
301
	struct device *dev = kobj_to_dev(kobj);
L
Linus Torvalds 已提交
302 303
	int retval = 0;

304
	/* add device node properties if present */
305
	if (MAJOR(dev->devt)) {
306 307
		const char *tmp;
		const char *name;
308
		umode_t mode = 0;
309 310
		kuid_t uid = GLOBAL_ROOT_UID;
		kgid_t gid = GLOBAL_ROOT_GID;
311

312 313
		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
314
		name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
315 316
		if (name) {
			add_uevent_var(env, "DEVNAME=%s", name);
317 318
			if (mode)
				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
319 320 321 322
			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));
323
			kfree(tmp);
324
		}
325 326
	}

327
	if (dev->type && dev->type->name)
328
		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
329

330
	if (dev->driver)
331
		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
332

333 334 335
	/* Add common DT information about the device */
	of_device_uevent(dev, env);

336
	/* have the bus specific function add its stuff */
337
	if (dev->bus && dev->bus->uevent) {
338
		retval = dev->bus->uevent(dev, env);
339
		if (retval)
340
			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
341
				 dev_name(dev), __func__, retval);
L
Linus Torvalds 已提交
342 343
	}

344
	/* have the class specific function add its stuff */
345
	if (dev->class && dev->class->dev_uevent) {
346
		retval = dev->class->dev_uevent(dev, env);
347
		if (retval)
348
			pr_debug("device: '%s': %s: class uevent() "
349
				 "returned %d\n", dev_name(dev),
350
				 __func__, retval);
351 352
	}

353
	/* have the device type specific function add its stuff */
354
	if (dev->type && dev->type->uevent) {
355
		retval = dev->type->uevent(dev, env);
356
		if (retval)
357
			pr_debug("device: '%s': %s: dev_type uevent() "
358
				 "returned %d\n", dev_name(dev),
359
				 __func__, retval);
360 361
	}

L
Linus Torvalds 已提交
362 363 364
	return retval;
}

365
static const struct kset_uevent_ops device_uevent_ops = {
366 367 368
	.filter =	dev_uevent_filter,
	.name =		dev_uevent_name,
	.uevent =	dev_uevent,
L
Linus Torvalds 已提交
369 370
};

371
static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
372 373 374 375
			   char *buf)
{
	struct kobject *top_kobj;
	struct kset *kset;
376
	struct kobj_uevent_env *env = NULL;
377 378 379 380 381 382
	int i;
	size_t count = 0;
	int retval;

	/* search the kset, the device belongs to */
	top_kobj = &dev->kobj;
383 384
	while (!top_kobj->kset && top_kobj->parent)
		top_kobj = top_kobj->parent;
385 386
	if (!top_kobj->kset)
		goto out;
387

388 389 390 391 392 393 394 395 396
	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;

397 398
	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
	if (!env)
399 400
		return -ENOMEM;

401
	/* let the kset specific function add its keys */
402
	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
403 404 405 406
	if (retval)
		goto out;

	/* copy keys to file */
407 408
	for (i = 0; i < env->envp_idx; i++)
		count += sprintf(&buf[count], "%s\n", env->envp[i]);
409
out:
410
	kfree(env);
411 412 413
	return count;
}

414
static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
415 416
			    const char *buf, size_t count)
{
417 418
	enum kobject_action action;

419
	if (kobject_action_type(buf, count, &action) == 0)
420
		kobject_uevent(&dev->kobj, action);
421 422
	else
		dev_err(dev, "uevent: unknown action-string\n");
423 424
	return count;
}
425
static DEVICE_ATTR_RW(uevent);
426

427
static ssize_t online_show(struct device *dev, struct device_attribute *attr,
428 429 430 431
			   char *buf)
{
	bool val;

432
	device_lock(dev);
433
	val = !dev->offline;
434
	device_unlock(dev);
435 436 437
	return sprintf(buf, "%u\n", val);
}

438
static ssize_t online_store(struct device *dev, struct device_attribute *attr,
439 440 441 442 443 444 445 446 447
			    const char *buf, size_t count)
{
	bool val;
	int ret;

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

448 449 450 451
	ret = lock_device_hotplug_sysfs();
	if (ret)
		return ret;

452 453 454 455
	ret = val ? device_online(dev) : device_offline(dev);
	unlock_device_hotplug();
	return ret < 0 ? ret : count;
}
456
static DEVICE_ATTR_RW(online);
457

458
int device_add_groups(struct device *dev, const struct attribute_group **groups)
459
{
460
	return sysfs_create_groups(&dev->kobj, groups);
461 462
}

463 464
void device_remove_groups(struct device *dev,
			  const struct attribute_group **groups)
465
{
466
	sysfs_remove_groups(&dev->kobj, groups);
467 468
}

469 470 471
static int device_add_attrs(struct device *dev)
{
	struct class *class = dev->class;
472
	const struct device_type *type = dev->type;
473
	int error;
474

475
	if (class) {
476
		error = device_add_groups(dev, class->dev_groups);
477
		if (error)
478
			return error;
479
	}
480

481 482
	if (type) {
		error = device_add_groups(dev, type->groups);
483
		if (error)
484
			goto err_remove_class_groups;
485 486
	}

487 488 489 490
	error = device_add_groups(dev, dev->groups);
	if (error)
		goto err_remove_type_groups;

491
	if (device_supports_offline(dev) && !dev->offline_disabled) {
492
		error = device_create_file(dev, &dev_attr_online);
493
		if (error)
494
			goto err_remove_dev_groups;
495 496
	}

497 498
	return 0;

499 500
 err_remove_dev_groups:
	device_remove_groups(dev, dev->groups);
501 502 503
 err_remove_type_groups:
	if (type)
		device_remove_groups(dev, type->groups);
504 505 506
 err_remove_class_groups:
	if (class)
		device_remove_groups(dev, class->dev_groups);
507

508 509 510 511 512 513
	return error;
}

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

516
	device_remove_file(dev, &dev_attr_online);
517
	device_remove_groups(dev, dev->groups);
518

519 520 521
	if (type)
		device_remove_groups(dev, type->groups);

522
	if (class)
523
		device_remove_groups(dev, class->dev_groups);
524 525
}

526
static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
527 528 529 530
			char *buf)
{
	return print_dev_t(buf, dev->devt);
}
531
static DEVICE_ATTR_RO(dev);
532

533
/* /sys/devices/ */
534
struct kset *devices_kset;
L
Linus Torvalds 已提交
535 536

/**
537 538 539
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
540
 */
541 542
int device_create_file(struct device *dev,
		       const struct device_attribute *attr)
L
Linus Torvalds 已提交
543 544
{
	int error = 0;
545 546 547

	if (dev) {
		WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
548 549
			"Attribute %s: write permission without 'store'\n",
			attr->attr.name);
550
		WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
551 552
			"Attribute %s: read permission without 'show'\n",
			attr->attr.name);
L
Linus Torvalds 已提交
553
		error = sysfs_create_file(&dev->kobj, &attr->attr);
554 555
	}

L
Linus Torvalds 已提交
556 557
	return error;
}
558
EXPORT_SYMBOL_GPL(device_create_file);
L
Linus Torvalds 已提交
559 560

/**
561 562 563
 * device_remove_file - remove sysfs attribute file.
 * @dev: device.
 * @attr: device attribute descriptor.
L
Linus Torvalds 已提交
564
 */
565 566
void device_remove_file(struct device *dev,
			const struct device_attribute *attr)
L
Linus Torvalds 已提交
567
{
568
	if (dev)
L
Linus Torvalds 已提交
569 570
		sysfs_remove_file(&dev->kobj, &attr->attr);
}
571
EXPORT_SYMBOL_GPL(device_remove_file);
L
Linus Torvalds 已提交
572

573 574 575 576 577
/**
 * device_create_bin_file - create sysfs binary attribute file for device.
 * @dev: device.
 * @attr: device binary attribute descriptor.
 */
578 579
int device_create_bin_file(struct device *dev,
			   const struct bin_attribute *attr)
580 581 582 583 584 585 586 587 588 589 590 591 592
{
	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.
 */
593 594
void device_remove_bin_file(struct device *dev,
			    const struct bin_attribute *attr)
595 596 597 598 599 600
{
	if (dev)
		sysfs_remove_bin_file(&dev->kobj, attr);
}
EXPORT_SYMBOL_GPL(device_remove_bin_file);

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
/**
 * device_schedule_callback_owner - helper to schedule a callback for a device
 * @dev: device.
 * @func: callback function to invoke later.
 * @owner: module owning the callback routine
 *
 * Attribute methods must not unregister themselves or their parent device
 * (which would amount to the same thing).  Attempts to do so will deadlock,
 * since unregistration is mutually exclusive with driver callbacks.
 *
 * Instead methods can call this routine, which will attempt to allocate
 * and schedule a workqueue request to call back @func with @dev as its
 * argument in the workqueue's process context.  @dev will be pinned until
 * @func returns.
 *
 * This routine is usually called via the inline device_schedule_callback(),
 * which automatically sets @owner to THIS_MODULE.
 *
 * Returns 0 if the request was submitted, -ENOMEM if storage could not
 * be allocated, -ENODEV if a reference to @owner isn't available.
 *
 * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
 * underlying sysfs routine (since it is intended for use by attribute
 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
 */
int device_schedule_callback_owner(struct device *dev,
		void (*func)(struct device *), struct module *owner)
{
	return sysfs_schedule_callback(&dev->kobj,
			(void (*)(void *)) func, dev, owner);
}
EXPORT_SYMBOL_GPL(device_schedule_callback_owner);

634 635
static void klist_children_get(struct klist_node *n)
{
636 637
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
638 639 640 641 642 643

	get_device(dev);
}

static void klist_children_put(struct klist_node *n)
{
644 645
	struct device_private *p = to_device_private_parent(n);
	struct device *dev = p->device;
646 647 648 649

	put_device(dev);
}

L
Linus Torvalds 已提交
650
/**
651 652
 * device_initialize - init device structure.
 * @dev: device.
L
Linus Torvalds 已提交
653
 *
654 655
 * This prepares the device for use by other layers by initializing
 * its fields.
656
 * It is the first half of device_register(), if called by
657 658 659 660 661
 * 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.
 *
662 663 664 665 666
 * 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.
 *
667 668
 * NOTE: Use put_device() to give up your reference instead of freeing
 * @dev directly once you have called this function.
L
Linus Torvalds 已提交
669 670 671
 */
void device_initialize(struct device *dev)
{
672
	dev->kobj.kset = devices_kset;
673
	kobject_init(&dev->kobj, &device_ktype);
L
Linus Torvalds 已提交
674
	INIT_LIST_HEAD(&dev->dma_pools);
675
	mutex_init(&dev->mutex);
676
	lockdep_set_novalidate_class(&dev->mutex);
T
Tejun Heo 已提交
677 678
	spin_lock_init(&dev->devres_lock);
	INIT_LIST_HEAD(&dev->devres_head);
679
	device_pm_init(dev);
680
	set_dev_node(dev, -1);
L
Linus Torvalds 已提交
681
}
682
EXPORT_SYMBOL_GPL(device_initialize);
L
Linus Torvalds 已提交
683

684
struct kobject *virtual_device_parent(struct device *dev)
685
{
686
	static struct kobject *virtual_dir = NULL;
687

688
	if (!virtual_dir)
689
		virtual_dir = kobject_create_and_add("virtual",
690
						     &devices_kset->kobj);
691

692
	return virtual_dir;
693 694
}

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
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)
710
{
711 712 713 714 715 716 717 718 719 720 721 722 723 724
	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;
725 726
	int retval;

727 728 729 730 731 732 733
	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
	if (!dir)
		return NULL;

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

734
	dir->kobj.kset = &class->p->glue_dirs;
735 736 737 738 739 740 741 742 743 744 745 746 747

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


static struct kobject *get_device_parent(struct device *dev,
					 struct device *parent)
{
748
	if (dev->class) {
749
		static DEFINE_MUTEX(gdp_mutex);
750 751 752 753
		struct kobject *kobj = NULL;
		struct kobject *parent_kobj;
		struct kobject *k;

754
#ifdef CONFIG_BLOCK
755
		/* block disks show up in /sys/block */
756
		if (sysfs_deprecated && dev->class == &block_class) {
757 758
			if (parent && parent->class == &block_class)
				return &parent->kobj;
759
			return &block_class.p->subsys.kobj;
760
		}
761
#endif
762

763 764
		/*
		 * If we have no parent, we live in "virtual".
765 766
		 * Class-devices with a non class-device as parent, live
		 * in a "glue" directory to prevent namespace collisions.
767 768 769
		 */
		if (parent == NULL)
			parent_kobj = virtual_device_parent(dev);
770
		else if (parent->class && !dev->class->ns_type)
771 772 773 774
			return &parent->kobj;
		else
			parent_kobj = &parent->kobj;

775 776
		mutex_lock(&gdp_mutex);

777
		/* find our class-directory at the parent and reference it */
778 779
		spin_lock(&dev->class->p->glue_dirs.list_lock);
		list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
780 781 782 783
			if (k->parent == parent_kobj) {
				kobj = kobject_get(k);
				break;
			}
784
		spin_unlock(&dev->class->p->glue_dirs.list_lock);
785 786
		if (kobj) {
			mutex_unlock(&gdp_mutex);
787
			return kobj;
788
		}
789 790

		/* or create a new class-directory at the parent device */
791
		k = class_dir_create_and_add(dev->class, parent_kobj);
792
		/* do not emit an uevent for this simple "glue" directory */
793
		mutex_unlock(&gdp_mutex);
794
		return k;
795 796
	}

797 798 799 800
	/* subsystems can specify a default root directory for their devices */
	if (!parent && dev->bus && dev->bus->dev_root)
		return &dev->bus->dev_root->kobj;

801
	if (parent)
802 803 804
		return &parent->kobj;
	return NULL;
}
805

806
static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
807
{
808
	/* see if we live in a "glue" directory */
809
	if (!glue_dir || !dev->class ||
810
	    glue_dir->kset != &dev->class->p->glue_dirs)
811 812
		return;

813
	kobject_put(glue_dir);
814
}
815 816 817 818 819

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

821 822 823 824 825 826
static int device_add_class_symlinks(struct device *dev)
{
	int error;

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

828
	error = sysfs_create_link(&dev->kobj,
829
				  &dev->class->p->subsys.kobj,
830 831 832
				  "subsystem");
	if (error)
		goto out;
833

834
	if (dev->parent && device_is_not_partition(dev)) {
835
		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
836 837
					  "device");
		if (error)
838
			goto out_subsys;
839 840
	}

841
#ifdef CONFIG_BLOCK
842
	/* /sys/block has directories and does not need symlinks */
843
	if (sysfs_deprecated && dev->class == &block_class)
844
		return 0;
845
#endif
846

847
	/* link in the class directory pointing to the device */
848
	error = sysfs_create_link(&dev->class->p->subsys.kobj,
849
				  &dev->kobj, dev_name(dev));
850
	if (error)
851
		goto out_device;
852 853 854

	return 0;

855 856
out_device:
	sysfs_remove_link(&dev->kobj, "device");
857

858 859 860 861 862 863 864 865 866 867
out_subsys:
	sysfs_remove_link(&dev->kobj, "subsystem");
out:
	return error;
}

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

869
	if (dev->parent && device_is_not_partition(dev))
870
		sysfs_remove_link(&dev->kobj, "device");
871
	sysfs_remove_link(&dev->kobj, "subsystem");
872
#ifdef CONFIG_BLOCK
873
	if (sysfs_deprecated && dev->class == &block_class)
874
		return;
875
#endif
876
	sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
877 878
}

879 880 881
/**
 * dev_set_name - set a device name
 * @dev: device
882
 * @fmt: format string for the device's name
883 884 885 886
 */
int dev_set_name(struct device *dev, const char *fmt, ...)
{
	va_list vargs;
887
	int err;
888 889

	va_start(vargs, fmt);
890
	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
891
	va_end(vargs);
892
	return err;
893 894 895
}
EXPORT_SYMBOL_GPL(dev_set_name);

896 897 898 899 900 901 902 903
/**
 * 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 已提交
904 905
 * device_remove_sys_dev_entry() will disagree about the presence of
 * the link.
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
 */
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);
	}
}

944 945 946 947 948 949 950 951
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);
952
	INIT_LIST_HEAD(&dev->p->deferred_probe);
953 954 955
	return 0;
}

L
Linus Torvalds 已提交
956
/**
957 958
 * device_add - add device to device hierarchy.
 * @dev: device.
L
Linus Torvalds 已提交
959
 *
960 961
 * This is part 2 of device_register(), though may be called
 * separately _iff_ device_initialize() has been called separately.
L
Linus Torvalds 已提交
962
 *
963
 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
964 965
 * to the global and sibling lists for the device, then
 * adds it to the other relevant subsystems of the driver model.
966
 *
967 968 969 970 971 972 973
 * 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.
 *
974 975 976
 * 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 已提交
977 978 979 980
 */
int device_add(struct device *dev)
{
	struct device *parent = NULL;
981
	struct kobject *kobj;
982
	struct class_interface *class_intf;
983
	int error = -EINVAL;
984

L
Linus Torvalds 已提交
985
	dev = get_device(dev);
986 987 988
	if (!dev)
		goto done;

989
	if (!dev->p) {
990 991 992
		error = device_private_init(dev);
		if (error)
			goto done;
993 994
	}

995 996 997 998 999 1000
	/*
	 * 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) {
1001
		dev_set_name(dev, "%s", dev->init_name);
1002 1003
		dev->init_name = NULL;
	}
1004

1005 1006 1007 1008
	/* 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);

1009 1010
	if (!dev_name(dev)) {
		error = -EINVAL;
1011
		goto name_error;
1012
	}
L
Linus Torvalds 已提交
1013

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

L
Linus Torvalds 已提交
1016
	parent = get_device(dev->parent);
1017 1018 1019
	kobj = get_device_parent(dev, parent);
	if (kobj)
		dev->kobj.parent = kobj;
L
Linus Torvalds 已提交
1020

1021 1022 1023 1024
	/* use parent numa_node */
	if (parent)
		set_dev_node(dev, dev_to_node(parent));

L
Linus Torvalds 已提交
1025
	/* first, register with generic layer. */
1026 1027
	/* we require the name to be set before, and pass NULL */
	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1028
	if (error)
L
Linus Torvalds 已提交
1029
		goto Error;
1030

1031 1032 1033 1034
	/* notify platform of device entry */
	if (platform_notify)
		platform_notify(dev);

1035
	error = device_create_file(dev, &dev_attr_uevent);
1036 1037
	if (error)
		goto attrError;
1038

1039
	if (MAJOR(dev->devt)) {
1040
		error = device_create_file(dev, &dev_attr_dev);
1041
		if (error)
1042
			goto ueventattrError;
1043 1044 1045 1046

		error = device_create_sys_dev_entry(dev);
		if (error)
			goto devtattrError;
1047 1048

		devtmpfs_create_node(dev);
1049 1050
	}

1051 1052 1053
	error = device_add_class_symlinks(dev);
	if (error)
		goto SymlinkError;
1054 1055
	error = device_add_attrs(dev);
	if (error)
1056
		goto AttrsError;
1057 1058
	error = bus_add_device(dev);
	if (error)
L
Linus Torvalds 已提交
1059
		goto BusError;
1060
	error = dpm_sysfs_add(dev);
1061
	if (error)
1062 1063
		goto DPMError;
	device_pm_add(dev);
1064 1065

	/* Notify clients of device addition.  This call must come
1066
	 * after dpm_sysfs_add() and before kobject_uevent().
1067 1068 1069 1070 1071
	 */
	if (dev->bus)
		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
					     BUS_NOTIFY_ADD_DEVICE, dev);

1072
	kobject_uevent(&dev->kobj, KOBJ_ADD);
1073
	bus_probe_device(dev);
L
Linus Torvalds 已提交
1074
	if (parent)
1075 1076
		klist_add_tail(&dev->p->knode_parent,
			       &parent->p->klist_children);
L
Linus Torvalds 已提交
1077

1078
	if (dev->class) {
1079
		mutex_lock(&dev->class->p->mutex);
1080
		/* tie the class to the device */
1081
		klist_add_tail(&dev->knode_class,
1082
			       &dev->class->p->klist_devices);
1083 1084

		/* notify any interfaces that the device is here */
1085
		list_for_each_entry(class_intf,
1086
				    &dev->class->p->interfaces, node)
1087 1088
			if (class_intf->add_dev)
				class_intf->add_dev(dev, class_intf);
1089
		mutex_unlock(&dev->class->p->mutex);
1090
	}
1091
done:
L
Linus Torvalds 已提交
1092 1093
	put_device(dev);
	return error;
1094
 DPMError:
1095 1096
	bus_remove_device(dev);
 BusError:
1097
	device_remove_attrs(dev);
1098
 AttrsError:
1099 1100
	device_remove_class_symlinks(dev);
 SymlinkError:
1101 1102
	if (MAJOR(dev->devt))
		devtmpfs_delete_node(dev);
1103 1104 1105
	if (MAJOR(dev->devt))
		device_remove_sys_dev_entry(dev);
 devtattrError:
1106
	if (MAJOR(dev->devt))
1107
		device_remove_file(dev, &dev_attr_dev);
1108
 ueventattrError:
1109
	device_remove_file(dev, &dev_attr_uevent);
1110
 attrError:
1111
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
L
Linus Torvalds 已提交
1112 1113
	kobject_del(&dev->kobj);
 Error:
1114
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1115 1116
	if (parent)
		put_device(parent);
1117 1118 1119
name_error:
	kfree(dev->p);
	dev->p = NULL;
1120
	goto done;
L
Linus Torvalds 已提交
1121
}
1122
EXPORT_SYMBOL_GPL(device_add);
L
Linus Torvalds 已提交
1123 1124

/**
1125 1126
 * device_register - register a device with the system.
 * @dev: pointer to the device structure
L
Linus Torvalds 已提交
1127
 *
1128 1129 1130 1131 1132 1133
 * 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.
1134
 *
1135 1136 1137
 * For more information, see the kerneldoc for device_initialize()
 * and device_add().
 *
1138 1139 1140
 * 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 已提交
1141 1142 1143 1144 1145 1146
 */
int device_register(struct device *dev)
{
	device_initialize(dev);
	return device_add(dev);
}
1147
EXPORT_SYMBOL_GPL(device_register);
L
Linus Torvalds 已提交
1148 1149

/**
1150 1151
 * get_device - increment reference count for device.
 * @dev: device.
L
Linus Torvalds 已提交
1152
 *
1153 1154 1155
 * 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 已提交
1156
 */
1157
struct device *get_device(struct device *dev)
L
Linus Torvalds 已提交
1158
{
1159
	return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
L
Linus Torvalds 已提交
1160
}
1161
EXPORT_SYMBOL_GPL(get_device);
L
Linus Torvalds 已提交
1162 1163

/**
1164 1165
 * put_device - decrement reference count.
 * @dev: device in question.
L
Linus Torvalds 已提交
1166
 */
1167
void put_device(struct device *dev)
L
Linus Torvalds 已提交
1168
{
1169
	/* might_sleep(); */
L
Linus Torvalds 已提交
1170 1171 1172
	if (dev)
		kobject_put(&dev->kobj);
}
1173
EXPORT_SYMBOL_GPL(put_device);
L
Linus Torvalds 已提交
1174 1175

/**
1176 1177
 * device_del - delete device from system.
 * @dev: device.
L
Linus Torvalds 已提交
1178
 *
1179 1180 1181 1182 1183
 * 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 已提交
1184
 *
1185 1186
 * NOTE: this should be called manually _iff_ device_add() was
 * also called manually.
L
Linus Torvalds 已提交
1187
 */
1188
void device_del(struct device *dev)
L
Linus Torvalds 已提交
1189
{
1190
	struct device *parent = dev->parent;
1191
	struct class_interface *class_intf;
L
Linus Torvalds 已提交
1192

1193 1194 1195 1196 1197 1198
	/* 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);
1199
	dpm_sysfs_remove(dev);
L
Linus Torvalds 已提交
1200
	if (parent)
1201
		klist_del(&dev->p->knode_parent);
1202
	if (MAJOR(dev->devt)) {
1203
		devtmpfs_delete_node(dev);
1204
		device_remove_sys_dev_entry(dev);
1205
		device_remove_file(dev, &dev_attr_dev);
1206
	}
1207
	if (dev->class) {
1208
		device_remove_class_symlinks(dev);
1209

1210
		mutex_lock(&dev->class->p->mutex);
1211
		/* notify any interfaces that the device is now gone */
1212
		list_for_each_entry(class_intf,
1213
				    &dev->class->p->interfaces, node)
1214 1215 1216
			if (class_intf->remove_dev)
				class_intf->remove_dev(dev, class_intf);
		/* remove the device from the class list */
1217
		klist_del(&dev->knode_class);
1218
		mutex_unlock(&dev->class->p->mutex);
1219
	}
1220
	device_remove_file(dev, &dev_attr_uevent);
1221
	device_remove_attrs(dev);
1222
	bus_remove_device(dev);
1223
	device_pm_remove(dev);
1224
	driver_deferred_probe_del(dev);
L
Linus Torvalds 已提交
1225 1226 1227 1228 1229 1230

	/* Notify the platform of the removal, in case they
	 * need to do anything...
	 */
	if (platform_notify_remove)
		platform_notify_remove(dev);
1231
	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1232
	cleanup_device_parent(dev);
L
Linus Torvalds 已提交
1233
	kobject_del(&dev->kobj);
1234
	put_device(parent);
L
Linus Torvalds 已提交
1235
}
1236
EXPORT_SYMBOL_GPL(device_del);
L
Linus Torvalds 已提交
1237 1238

/**
1239 1240
 * device_unregister - unregister device from system.
 * @dev: device going away.
L
Linus Torvalds 已提交
1241
 *
1242 1243 1244 1245 1246 1247
 * 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 已提交
1248
 */
1249
void device_unregister(struct device *dev)
L
Linus Torvalds 已提交
1250
{
1251
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
L
Linus Torvalds 已提交
1252 1253 1254
	device_del(dev);
	put_device(dev);
}
1255
EXPORT_SYMBOL_GPL(device_unregister);
L
Linus Torvalds 已提交
1256

1257
static struct device *next_device(struct klist_iter *i)
1258
{
1259
	struct klist_node *n = klist_next(i);
1260 1261 1262 1263 1264 1265 1266 1267
	struct device *dev = NULL;
	struct device_private *p;

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

1270
/**
1271
 * device_get_devnode - path of device node file
1272
 * @dev: device
1273
 * @mode: returned file access mode
1274 1275
 * @uid: returned file owner
 * @gid: returned file group
1276 1277 1278 1279 1280 1281 1282
 * @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.
 */
1283
const char *device_get_devnode(struct device *dev,
1284
			       umode_t *mode, kuid_t *uid, kgid_t *gid,
1285
			       const char **tmp)
1286 1287 1288 1289 1290 1291
{
	char *s;

	*tmp = NULL;

	/* the device type may provide a specific name */
1292
	if (dev->type && dev->type->devnode)
1293
		*tmp = dev->type->devnode(dev, mode, uid, gid);
1294 1295 1296 1297
	if (*tmp)
		return *tmp;

	/* the class may provide a specific name */
1298 1299
	if (dev->class && dev->class->devnode)
		*tmp = dev->class->devnode(dev, mode);
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
	if (*tmp)
		return *tmp;

	/* return name without allocation, tmp == NULL */
	if (strchr(dev_name(dev), '!') == NULL)
		return dev_name(dev);

	/* replace '!' in the name with '/' */
	*tmp = kstrdup(dev_name(dev), GFP_KERNEL);
	if (!*tmp)
		return NULL;
	while ((s = strchr(*tmp, '!')))
		s[0] = '/';
	return *tmp;
}

L
Linus Torvalds 已提交
1316
/**
1317 1318 1319
 * device_for_each_child - device child iterator.
 * @parent: parent struct device.
 * @fn: function to be called for each device.
1320
 * @data: data for the callback.
L
Linus Torvalds 已提交
1321
 *
1322 1323
 * Iterate over @parent's child devices, and call @fn for each,
 * passing it @data.
L
Linus Torvalds 已提交
1324
 *
1325 1326
 * 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 已提交
1327
 */
1328 1329
int device_for_each_child(struct device *parent, void *data,
			  int (*fn)(struct device *dev, void *data))
L
Linus Torvalds 已提交
1330
{
1331
	struct klist_iter i;
1332
	struct device *child;
L
Linus Torvalds 已提交
1333 1334
	int error = 0;

1335 1336 1337
	if (!parent->p)
		return 0;

1338
	klist_iter_init(&parent->p->klist_children, &i);
1339 1340 1341
	while ((child = next_device(&i)) && !error)
		error = fn(child, data);
	klist_iter_exit(&i);
L
Linus Torvalds 已提交
1342 1343
	return error;
}
1344
EXPORT_SYMBOL_GPL(device_for_each_child);
L
Linus Torvalds 已提交
1345

1346 1347 1348 1349
/**
 * device_find_child - device iterator for locating a particular device.
 * @parent: parent struct device
 * @match: Callback function to check device
1350
 * @data: Data to pass to match function
1351 1352 1353 1354 1355 1356 1357 1358 1359
 *
 * 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.
1360 1361
 *
 * NOTE: you will need to drop the reference with put_device() after use.
1362
 */
1363 1364
struct device *device_find_child(struct device *parent, void *data,
				 int (*match)(struct device *dev, void *data))
1365 1366 1367 1368 1369 1370 1371
{
	struct klist_iter i;
	struct device *child;

	if (!parent)
		return NULL;

1372
	klist_iter_init(&parent->p->klist_children, &i);
1373 1374 1375 1376 1377 1378
	while ((child = next_device(&i)))
		if (match(child, data) && get_device(child))
			break;
	klist_iter_exit(&i);
	return child;
}
1379
EXPORT_SYMBOL_GPL(device_find_child);
1380

L
Linus Torvalds 已提交
1381 1382
int __init devices_init(void)
{
1383 1384 1385
	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
	if (!devices_kset)
		return -ENOMEM;
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
	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;

1396
	return 0;
1397 1398 1399 1400 1401 1402 1403 1404

 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 已提交
1405 1406
}

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
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;
}

1488
struct root_device {
1489 1490 1491 1492
	struct device dev;
	struct module *owner;
};

1493
static inline struct root_device *to_root_device(struct device *d)
1494 1495 1496
{
	return container_of(d, struct root_device, dev);
}
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520

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.
 *
1521 1522
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
 * 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);

1534
	err = dev_set_name(&root->dev, "%s", name);
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
	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);
	}

1548
#ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
	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
1567
 * @dev: device going away
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
 *
 * 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);

1583 1584 1585

static void device_create_release(struct device *dev)
{
1586
	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1587 1588 1589
	kfree(dev);
}

1590 1591 1592 1593 1594
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)
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
{
	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;
	}

1608
	device_initialize(dev);
1609 1610 1611
	dev->devt = devt;
	dev->class = class;
	dev->parent = parent;
1612
	dev->groups = groups;
1613
	dev->release = device_create_release;
1614
	dev_set_drvdata(dev, drvdata);
1615

1616 1617 1618 1619
	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
	if (retval)
		goto error;

1620
	retval = device_add(dev);
1621 1622 1623 1624 1625 1626
	if (retval)
		goto error;

	return dev;

error:
1627
	put_device(dev);
1628 1629
	return ERR_PTR(retval);
}
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662

/**
 * 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);
}
1663 1664 1665
EXPORT_SYMBOL_GPL(device_create_vargs);

/**
1666
 * device_create - creates a device and registers it with sysfs
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
 * @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.
 *
1684 1685
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
1686 1687 1688
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
1689 1690
struct device *device_create(struct class *class, struct device *parent,
			     dev_t devt, void *drvdata, const char *fmt, ...)
1691 1692 1693 1694 1695 1696 1697 1698 1699
{
	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;
}
1700
EXPORT_SYMBOL_GPL(device_create);
1701

1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
/**
 * 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);

1746
static int __match_devt(struct device *dev, const void *data)
1747
{
1748
	const dev_t *devt = data;
1749

1750
	return dev->devt == *devt;
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
}

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

1765
	dev = class_find_device(class, NULL, &devt, __match_devt);
1766 1767
	if (dev) {
		put_device(dev);
1768
		device_unregister(dev);
1769
	}
1770 1771
}
EXPORT_SYMBOL_GPL(device_destroy);
1772 1773 1774 1775 1776

/**
 * device_rename - renames a device
 * @dev: the pointer to the struct device to be renamed
 * @new_name: the new name of the device
1777 1778 1779 1780 1781
 *
 * 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.
1782
 *
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
 * 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. :)
1811
 */
1812
int device_rename(struct device *dev, const char *new_name)
1813
{
1814
	struct kobject *kobj = &dev->kobj;
1815
	char *old_device_name = NULL;
1816 1817 1818 1819 1820 1821
	int error;

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

1822
	dev_dbg(dev, "renaming to %s\n", new_name);
1823

1824
	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1825 1826 1827
	if (!old_device_name) {
		error = -ENOMEM;
		goto out;
1828 1829
	}

1830
	if (dev->class) {
1831 1832 1833
		error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
					     kobj, old_device_name,
					     new_name, kobject_namespace(kobj));
1834 1835 1836
		if (error)
			goto out;
	}
1837

1838
	error = kobject_rename(kobj, new_name);
1839
	if (error)
1840
		goto out;
1841

1842
out:
1843 1844
	put_device(dev);

1845
	kfree(old_device_name);
1846 1847 1848

	return error;
}
1849
EXPORT_SYMBOL_GPL(device_rename);
1850 1851 1852 1853 1854

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

1857 1858 1859 1860 1861 1862
	if (old_parent)
		sysfs_remove_link(&dev->kobj, "device");
	if (new_parent)
		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
					  "device");
	return error;
1863 1864 1865 1866 1867
}

/**
 * device_move - moves a device to a new parent
 * @dev: the pointer to the struct device to be moved
1868
 * @new_parent: the new parent of the device (can by NULL)
1869
 * @dpm_order: how to reorder the dpm_list
1870
 */
1871 1872
int device_move(struct device *dev, struct device *new_parent,
		enum dpm_order dpm_order)
1873 1874 1875
{
	int error;
	struct device *old_parent;
1876
	struct kobject *new_parent_kobj;
1877 1878 1879 1880 1881

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

1882
	device_pm_lock();
1883
	new_parent = get_device(new_parent);
1884
	new_parent_kobj = get_device_parent(dev, new_parent);
1885

1886 1887
	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1888
	error = kobject_move(&dev->kobj, new_parent_kobj);
1889
	if (error) {
1890
		cleanup_glue_dir(dev, new_parent_kobj);
1891 1892 1893 1894 1895 1896
		put_device(new_parent);
		goto out;
	}
	old_parent = dev->parent;
	dev->parent = new_parent;
	if (old_parent)
1897
		klist_remove(&dev->p->knode_parent);
1898
	if (new_parent) {
1899 1900
		klist_add_tail(&dev->p->knode_parent,
			       &new_parent->p->klist_children);
1901 1902 1903
		set_dev_node(dev, dev_to_node(new_parent));
	}

1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
	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));
				}
1918
			}
1919 1920 1921
			cleanup_glue_dir(dev, new_parent_kobj);
			put_device(new_parent);
			goto out;
1922 1923
		}
	}
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
	switch (dpm_order) {
	case DPM_ORDER_NONE:
		break;
	case DPM_ORDER_DEV_AFTER_PARENT:
		device_pm_move_after(dev, new_parent);
		break;
	case DPM_ORDER_PARENT_BEFORE_DEV:
		device_pm_move_before(new_parent, dev);
		break;
	case DPM_ORDER_DEV_LAST:
		device_pm_move_last(dev);
		break;
	}
1937

1938 1939
	put_device(old_parent);
out:
1940
	device_pm_unlock();
1941 1942 1943 1944
	put_device(dev);
	return error;
}
EXPORT_SYMBOL_GPL(device_move);
1945 1946 1947 1948 1949 1950

/**
 * device_shutdown - call ->shutdown() on each device to shutdown.
 */
void device_shutdown(void)
{
1951
	struct device *dev, *parent;
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961

	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);
1962 1963 1964 1965 1966 1967

		/*
		 * hold reference count of device's parent to
		 * prevent it from being freed because parent's
		 * lock is to be held
		 */
1968
		parent = get_device(dev->parent);
1969 1970 1971 1972 1973 1974 1975
		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);
1976

1977
		/* hold lock to avoid race with probe/release */
1978 1979
		if (parent)
			device_lock(parent);
1980 1981
		device_lock(dev);

1982 1983 1984
		/* Don't allow any more runtime suspends */
		pm_runtime_get_noresume(dev);
		pm_runtime_barrier(dev);
1985 1986

		if (dev->bus && dev->bus->shutdown) {
1987 1988
			if (initcall_debug)
				dev_info(dev, "shutdown\n");
1989 1990
			dev->bus->shutdown(dev);
		} else if (dev->driver && dev->driver->shutdown) {
1991 1992
			if (initcall_debug)
				dev_info(dev, "shutdown\n");
1993 1994
			dev->driver->shutdown(dev);
		}
1995 1996

		device_unlock(dev);
1997 1998
		if (parent)
			device_unlock(parent);
1999

2000
		put_device(dev);
2001
		put_device(parent);
2002 2003

		spin_lock(&devices_kset->list_lock);
2004
	}
2005
	spin_unlock(&devices_kset->list_lock);
2006
	async_synchronize_full();
2007
}
2008 2009 2010 2011 2012 2013

/*
 * Device logging functions
 */

#ifdef CONFIG_PRINTK
2014 2015
static int
create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2016
{
2017
	const char *subsys;
2018
	size_t pos = 0;
2019

2020 2021 2022 2023 2024
	if (dev->class)
		subsys = dev->class->name;
	else if (dev->bus)
		subsys = dev->bus->name;
	else
2025
		return 0;
2026

2027
	pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042

	/*
	 * 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';
2043 2044 2045 2046
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=%c%u:%u",
				c, MAJOR(dev->devt), MINOR(dev->devt));
2047 2048 2049
	} else if (strcmp(subsys, "net") == 0) {
		struct net_device *net = to_net_dev(dev);

2050 2051 2052
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=n%u", net->ifindex);
2053
	} else {
2054 2055 2056
		pos++;
		pos += snprintf(hdr + pos, hdrlen - pos,
				"DEVICE=+%s:%s", subsys, dev_name(dev));
2057
	}
2058

2059 2060 2061 2062
	return pos;
}
EXPORT_SYMBOL(create_syslog_header);

2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
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);

2090 2091 2092 2093 2094 2095
static int __dev_printk(const char *level, const struct device *dev,
			struct va_format *vaf)
{
	if (!dev)
		return printk("%s(NULL device *): %pV", level, vaf);

2096 2097 2098
	return dev_printk_emit(level[1] - '0', dev,
			       "%s %s: %pV",
			       dev_driver_string(dev), dev_name(dev), vaf);
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
}

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

	va_start(args, fmt);

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

	r = __dev_printk(level, dev, &vaf);
2114

2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
	va_end(args);

	return r;
}
EXPORT_SYMBOL(dev_printk);

#define define_dev_printk_level(func, kern_level)		\
int func(const struct device *dev, const char *fmt, ...)	\
{								\
	struct va_format vaf;					\
	va_list args;						\
	int r;							\
								\
	va_start(args, fmt);					\
								\
	vaf.fmt = fmt;						\
	vaf.va = &args;						\
								\
	r = __dev_printk(kern_level, dev, &vaf);		\
2134
								\
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
	va_end(args);						\
								\
	return r;						\
}								\
EXPORT_SYMBOL(func);

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

#endif