Merge branch 'drm-fixes' of git://people.freedesktop.org/~airlied/linux
[linux-2.6-block.git] / drivers / base / core.c
CommitLineData
1da177e4
LT
1/*
2 * drivers/base/core.c - core driver model code (device registration, etc)
3 *
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
64bb5d2c
GKH
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
1da177e4
LT
8 *
9 * This file is released under the GPLv2
10 *
11 */
12
1da177e4
LT
13#include <linux/device.h>
14#include <linux/err.h>
97badf87 15#include <linux/fwnode.h>
1da177e4
LT
16#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/slab.h>
19#include <linux/string.h>
23681e47 20#include <linux/kdev_t.h>
116af378 21#include <linux/notifier.h>
07d57a32
GL
22#include <linux/of.h>
23#include <linux/of_device.h>
da231fd5 24#include <linux/genhd.h>
815d2d50 25#include <linux/kallsyms.h>
f75b1c60 26#include <linux/mutex.h>
af8db150 27#include <linux/pm_runtime.h>
c4e00daa 28#include <linux/netdevice.h>
63967685 29#include <linux/sysfs.h>
1da177e4
LT
30
31#include "base.h"
32#include "power/power.h"
33
e52eec13
AK
34#ifdef CONFIG_SYSFS_DEPRECATED
35#ifdef CONFIG_SYSFS_DEPRECATED_V2
36long sysfs_deprecated = 1;
37#else
38long sysfs_deprecated = 0;
39#endif
3454bf96 40static int __init sysfs_deprecated_setup(char *arg)
e52eec13 41{
34da5e67 42 return kstrtol(arg, 10, &sysfs_deprecated);
e52eec13
AK
43}
44early_param("sysfs.deprecated", sysfs_deprecated_setup);
45#endif
46
4a3ad20c
GKH
47int (*platform_notify)(struct device *dev) = NULL;
48int (*platform_notify_remove)(struct device *dev) = NULL;
e105b8bf
DW
49static struct kobject *dev_kobj;
50struct kobject *sysfs_dev_char_kobj;
51struct kobject *sysfs_dev_block_kobj;
1da177e4 52
5e33bc41
RW
53static DEFINE_MUTEX(device_hotplug_lock);
54
55void lock_device_hotplug(void)
56{
57 mutex_lock(&device_hotplug_lock);
58}
59
60void unlock_device_hotplug(void)
61{
62 mutex_unlock(&device_hotplug_lock);
63}
64
65int lock_device_hotplug_sysfs(void)
66{
67 if (mutex_trylock(&device_hotplug_lock))
68 return 0;
69
70 /* Avoid busy looping (5 ms of sleep should do). */
71 msleep(5);
72 return restart_syscall();
73}
74
4e886c29
GKH
75#ifdef CONFIG_BLOCK
76static inline int device_is_not_partition(struct device *dev)
77{
78 return !(dev->type == &part_type);
79}
80#else
81static inline int device_is_not_partition(struct device *dev)
82{
83 return 1;
84}
85#endif
1da177e4 86
3e95637a
AS
87/**
88 * dev_driver_string - Return a device's driver name, if at all possible
89 * @dev: struct device to get the name of
90 *
91 * Will return the device's driver's name if it is bound to a device. If
9169c012 92 * the device is not bound to a driver, it will return the name of the bus
3e95637a
AS
93 * it is attached to. If it is not attached to a bus either, an empty
94 * string will be returned.
95 */
bf9ca69f 96const char *dev_driver_string(const struct device *dev)
3e95637a 97{
3589972e
AS
98 struct device_driver *drv;
99
100 /* dev->driver can change to NULL underneath us because of unbinding,
101 * so be careful about accessing it. dev->bus and dev->class should
102 * never change once they are set, so they don't need special care.
103 */
104 drv = ACCESS_ONCE(dev->driver);
105 return drv ? drv->name :
a456b702
JD
106 (dev->bus ? dev->bus->name :
107 (dev->class ? dev->class->name : ""));
3e95637a 108}
310a922d 109EXPORT_SYMBOL(dev_driver_string);
3e95637a 110
1da177e4
LT
111#define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
112
4a3ad20c
GKH
113static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
114 char *buf)
1da177e4 115{
4a3ad20c 116 struct device_attribute *dev_attr = to_dev_attr(attr);
b0d1f807 117 struct device *dev = kobj_to_dev(kobj);
4a0c20bf 118 ssize_t ret = -EIO;
1da177e4
LT
119
120 if (dev_attr->show)
54b6f35c 121 ret = dev_attr->show(dev, dev_attr, buf);
815d2d50 122 if (ret >= (ssize_t)PAGE_SIZE) {
53a9c87e
GKH
123 print_symbol("dev_attr_show: %s returned bad count\n",
124 (unsigned long)dev_attr->show);
815d2d50 125 }
1da177e4
LT
126 return ret;
127}
128
4a3ad20c
GKH
129static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
130 const char *buf, size_t count)
1da177e4 131{
4a3ad20c 132 struct device_attribute *dev_attr = to_dev_attr(attr);
b0d1f807 133 struct device *dev = kobj_to_dev(kobj);
4a0c20bf 134 ssize_t ret = -EIO;
1da177e4
LT
135
136 if (dev_attr->store)
54b6f35c 137 ret = dev_attr->store(dev, dev_attr, buf, count);
1da177e4
LT
138 return ret;
139}
140
52cf25d0 141static const struct sysfs_ops dev_sysfs_ops = {
1da177e4
LT
142 .show = dev_attr_show,
143 .store = dev_attr_store,
144};
145
ca22e56d
KS
146#define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
147
148ssize_t device_store_ulong(struct device *dev,
149 struct device_attribute *attr,
150 const char *buf, size_t size)
151{
152 struct dev_ext_attribute *ea = to_ext_attr(attr);
153 char *end;
154 unsigned long new = simple_strtoul(buf, &end, 0);
155 if (end == buf)
156 return -EINVAL;
157 *(unsigned long *)(ea->var) = new;
158 /* Always return full write size even if we didn't consume all */
159 return size;
160}
161EXPORT_SYMBOL_GPL(device_store_ulong);
162
163ssize_t device_show_ulong(struct device *dev,
164 struct device_attribute *attr,
165 char *buf)
166{
167 struct dev_ext_attribute *ea = to_ext_attr(attr);
168 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
169}
170EXPORT_SYMBOL_GPL(device_show_ulong);
171
172ssize_t device_store_int(struct device *dev,
173 struct device_attribute *attr,
174 const char *buf, size_t size)
175{
176 struct dev_ext_attribute *ea = to_ext_attr(attr);
177 char *end;
178 long new = simple_strtol(buf, &end, 0);
179 if (end == buf || new > INT_MAX || new < INT_MIN)
180 return -EINVAL;
181 *(int *)(ea->var) = new;
182 /* Always return full write size even if we didn't consume all */
183 return size;
184}
185EXPORT_SYMBOL_GPL(device_store_int);
186
187ssize_t device_show_int(struct device *dev,
188 struct device_attribute *attr,
189 char *buf)
190{
191 struct dev_ext_attribute *ea = to_ext_attr(attr);
192
193 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
194}
195EXPORT_SYMBOL_GPL(device_show_int);
1da177e4 196
91872392
BP
197ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t size)
199{
200 struct dev_ext_attribute *ea = to_ext_attr(attr);
201
202 if (strtobool(buf, ea->var) < 0)
203 return -EINVAL;
204
205 return size;
206}
207EXPORT_SYMBOL_GPL(device_store_bool);
208
209ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
210 char *buf)
211{
212 struct dev_ext_attribute *ea = to_ext_attr(attr);
213
214 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
215}
216EXPORT_SYMBOL_GPL(device_show_bool);
217
1da177e4 218/**
f8878dcb
RD
219 * device_release - free device structure.
220 * @kobj: device's kobject.
1da177e4 221 *
f8878dcb
RD
222 * This is called once the reference count for the object
223 * reaches 0. We forward the call to the device's release
224 * method, which should handle actually freeing the structure.
1da177e4 225 */
4a3ad20c 226static void device_release(struct kobject *kobj)
1da177e4 227{
b0d1f807 228 struct device *dev = kobj_to_dev(kobj);
fb069a5d 229 struct device_private *p = dev->p;
1da177e4 230
a525a3dd
ML
231 /*
232 * Some platform devices are driven without driver attached
233 * and managed resources may have been acquired. Make sure
234 * all resources are released.
235 *
236 * Drivers still can add resources into device after device
237 * is deleted but alive, so release devres here to avoid
238 * possible memory leak.
239 */
240 devres_release_all(dev);
241
1da177e4
LT
242 if (dev->release)
243 dev->release(dev);
f9f852df
KS
244 else if (dev->type && dev->type->release)
245 dev->type->release(dev);
2620efef
GKH
246 else if (dev->class && dev->class->dev_release)
247 dev->class->dev_release(dev);
f810a5cf
AV
248 else
249 WARN(1, KERN_ERR "Device '%s' does not have a release() "
4a3ad20c 250 "function, it is broken and must be fixed.\n",
1e0b2cf9 251 dev_name(dev));
fb069a5d 252 kfree(p);
1da177e4
LT
253}
254
bc451f20
EB
255static const void *device_namespace(struct kobject *kobj)
256{
b0d1f807 257 struct device *dev = kobj_to_dev(kobj);
bc451f20
EB
258 const void *ns = NULL;
259
260 if (dev->class && dev->class->ns_type)
261 ns = dev->class->namespace(dev);
262
263 return ns;
264}
265
8f4afc41 266static struct kobj_type device_ktype = {
1da177e4
LT
267 .release = device_release,
268 .sysfs_ops = &dev_sysfs_ops,
bc451f20 269 .namespace = device_namespace,
1da177e4
LT
270};
271
272
312c004d 273static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
1da177e4
LT
274{
275 struct kobj_type *ktype = get_ktype(kobj);
276
8f4afc41 277 if (ktype == &device_ktype) {
b0d1f807 278 struct device *dev = kobj_to_dev(kobj);
1da177e4
LT
279 if (dev->bus)
280 return 1;
23681e47
GKH
281 if (dev->class)
282 return 1;
1da177e4
LT
283 }
284 return 0;
285}
286
312c004d 287static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
1da177e4 288{
b0d1f807 289 struct device *dev = kobj_to_dev(kobj);
1da177e4 290
23681e47
GKH
291 if (dev->bus)
292 return dev->bus->name;
293 if (dev->class)
294 return dev->class->name;
295 return NULL;
1da177e4
LT
296}
297
7eff2e7a
KS
298static int dev_uevent(struct kset *kset, struct kobject *kobj,
299 struct kobj_uevent_env *env)
1da177e4 300{
b0d1f807 301 struct device *dev = kobj_to_dev(kobj);
1da177e4
LT
302 int retval = 0;
303
6fcf53ac 304 /* add device node properties if present */
23681e47 305 if (MAJOR(dev->devt)) {
6fcf53ac
KS
306 const char *tmp;
307 const char *name;
2c9ede55 308 umode_t mode = 0;
4e4098a3
GKH
309 kuid_t uid = GLOBAL_ROOT_UID;
310 kgid_t gid = GLOBAL_ROOT_GID;
6fcf53ac 311
7eff2e7a
KS
312 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
313 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
3c2670e6 314 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
6fcf53ac
KS
315 if (name) {
316 add_uevent_var(env, "DEVNAME=%s", name);
e454cea2
KS
317 if (mode)
318 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
4e4098a3
GKH
319 if (!uid_eq(uid, GLOBAL_ROOT_UID))
320 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
321 if (!gid_eq(gid, GLOBAL_ROOT_GID))
322 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
3c2670e6 323 kfree(tmp);
6fcf53ac 324 }
23681e47
GKH
325 }
326
414264f9 327 if (dev->type && dev->type->name)
7eff2e7a 328 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
414264f9 329
239378f1 330 if (dev->driver)
7eff2e7a 331 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
239378f1 332
07d57a32
GL
333 /* Add common DT information about the device */
334 of_device_uevent(dev, env);
335
7eff2e7a 336 /* have the bus specific function add its stuff */
312c004d 337 if (dev->bus && dev->bus->uevent) {
7eff2e7a 338 retval = dev->bus->uevent(dev, env);
f9f852df 339 if (retval)
7dc72b28 340 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
1e0b2cf9 341 dev_name(dev), __func__, retval);
1da177e4
LT
342 }
343
7eff2e7a 344 /* have the class specific function add its stuff */
2620efef 345 if (dev->class && dev->class->dev_uevent) {
7eff2e7a 346 retval = dev->class->dev_uevent(dev, env);
f9f852df 347 if (retval)
7dc72b28 348 pr_debug("device: '%s': %s: class uevent() "
1e0b2cf9 349 "returned %d\n", dev_name(dev),
2b3a302a 350 __func__, retval);
f9f852df
KS
351 }
352
eef35c2d 353 /* have the device type specific function add its stuff */
f9f852df 354 if (dev->type && dev->type->uevent) {
7eff2e7a 355 retval = dev->type->uevent(dev, env);
f9f852df 356 if (retval)
7dc72b28 357 pr_debug("device: '%s': %s: dev_type uevent() "
1e0b2cf9 358 "returned %d\n", dev_name(dev),
2b3a302a 359 __func__, retval);
2620efef
GKH
360 }
361
1da177e4
LT
362 return retval;
363}
364
9cd43611 365static const struct kset_uevent_ops device_uevent_ops = {
312c004d
KS
366 .filter = dev_uevent_filter,
367 .name = dev_uevent_name,
368 .uevent = dev_uevent,
1da177e4
LT
369};
370
c5e064a6 371static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
16574dcc
KS
372 char *buf)
373{
374 struct kobject *top_kobj;
375 struct kset *kset;
7eff2e7a 376 struct kobj_uevent_env *env = NULL;
16574dcc
KS
377 int i;
378 size_t count = 0;
379 int retval;
380
381 /* search the kset, the device belongs to */
382 top_kobj = &dev->kobj;
5c5daf65
KS
383 while (!top_kobj->kset && top_kobj->parent)
384 top_kobj = top_kobj->parent;
16574dcc
KS
385 if (!top_kobj->kset)
386 goto out;
5c5daf65 387
16574dcc
KS
388 kset = top_kobj->kset;
389 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
390 goto out;
391
392 /* respect filter */
393 if (kset->uevent_ops && kset->uevent_ops->filter)
394 if (!kset->uevent_ops->filter(kset, &dev->kobj))
395 goto out;
396
7eff2e7a
KS
397 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
398 if (!env)
c7308c81
GKH
399 return -ENOMEM;
400
16574dcc 401 /* let the kset specific function add its keys */
7eff2e7a 402 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
16574dcc
KS
403 if (retval)
404 goto out;
405
406 /* copy keys to file */
7eff2e7a
KS
407 for (i = 0; i < env->envp_idx; i++)
408 count += sprintf(&buf[count], "%s\n", env->envp[i]);
16574dcc 409out:
7eff2e7a 410 kfree(env);
16574dcc
KS
411 return count;
412}
413
c5e064a6 414static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
a7fd6706
KS
415 const char *buf, size_t count)
416{
60a96a59
KS
417 enum kobject_action action;
418
3f5468c9 419 if (kobject_action_type(buf, count, &action) == 0)
60a96a59 420 kobject_uevent(&dev->kobj, action);
3f5468c9
KS
421 else
422 dev_err(dev, "uevent: unknown action-string\n");
a7fd6706
KS
423 return count;
424}
c5e064a6 425static DEVICE_ATTR_RW(uevent);
a7fd6706 426
c5e064a6 427static ssize_t online_show(struct device *dev, struct device_attribute *attr,
4f3549d7
RW
428 char *buf)
429{
430 bool val;
431
5e33bc41 432 device_lock(dev);
4f3549d7 433 val = !dev->offline;
5e33bc41 434 device_unlock(dev);
4f3549d7
RW
435 return sprintf(buf, "%u\n", val);
436}
437
c5e064a6 438static ssize_t online_store(struct device *dev, struct device_attribute *attr,
4f3549d7
RW
439 const char *buf, size_t count)
440{
441 bool val;
442 int ret;
443
444 ret = strtobool(buf, &val);
445 if (ret < 0)
446 return ret;
447
5e33bc41
RW
448 ret = lock_device_hotplug_sysfs();
449 if (ret)
450 return ret;
451
4f3549d7
RW
452 ret = val ? device_online(dev) : device_offline(dev);
453 unlock_device_hotplug();
454 return ret < 0 ? ret : count;
455}
c5e064a6 456static DEVICE_ATTR_RW(online);
4f3549d7 457
fa6fdb33 458int device_add_groups(struct device *dev, const struct attribute_group **groups)
621a1672 459{
3e9b2bae 460 return sysfs_create_groups(&dev->kobj, groups);
de0ff00d
GKH
461}
462
fa6fdb33
GKH
463void device_remove_groups(struct device *dev,
464 const struct attribute_group **groups)
de0ff00d 465{
3e9b2bae 466 sysfs_remove_groups(&dev->kobj, groups);
de0ff00d
GKH
467}
468
2620efef
GKH
469static int device_add_attrs(struct device *dev)
470{
471 struct class *class = dev->class;
aed65af1 472 const struct device_type *type = dev->type;
621a1672 473 int error;
2620efef 474
621a1672 475 if (class) {
d05a6f96 476 error = device_add_groups(dev, class->dev_groups);
f9f852df 477 if (error)
621a1672 478 return error;
2620efef 479 }
f9f852df 480
621a1672
DT
481 if (type) {
482 error = device_add_groups(dev, type->groups);
f9f852df 483 if (error)
a6b01ded 484 goto err_remove_class_groups;
f9f852df
KS
485 }
486
621a1672
DT
487 error = device_add_groups(dev, dev->groups);
488 if (error)
489 goto err_remove_type_groups;
490
4f3549d7 491 if (device_supports_offline(dev) && !dev->offline_disabled) {
c5e064a6 492 error = device_create_file(dev, &dev_attr_online);
4f3549d7 493 if (error)
ecfbf6fd 494 goto err_remove_dev_groups;
4f3549d7
RW
495 }
496
621a1672
DT
497 return 0;
498
ecfbf6fd
RW
499 err_remove_dev_groups:
500 device_remove_groups(dev, dev->groups);
621a1672
DT
501 err_remove_type_groups:
502 if (type)
503 device_remove_groups(dev, type->groups);
d05a6f96
GKH
504 err_remove_class_groups:
505 if (class)
506 device_remove_groups(dev, class->dev_groups);
621a1672 507
2620efef
GKH
508 return error;
509}
510
511static void device_remove_attrs(struct device *dev)
512{
513 struct class *class = dev->class;
aed65af1 514 const struct device_type *type = dev->type;
2620efef 515
c5e064a6 516 device_remove_file(dev, &dev_attr_online);
621a1672 517 device_remove_groups(dev, dev->groups);
f9f852df 518
621a1672
DT
519 if (type)
520 device_remove_groups(dev, type->groups);
521
a6b01ded 522 if (class)
d05a6f96 523 device_remove_groups(dev, class->dev_groups);
2620efef
GKH
524}
525
c5e064a6 526static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
23681e47
GKH
527 char *buf)
528{
529 return print_dev_t(buf, dev->devt);
530}
c5e064a6 531static DEVICE_ATTR_RO(dev);
ad6a1e1c 532
ca22e56d 533/* /sys/devices/ */
881c6cfd 534struct kset *devices_kset;
1da177e4 535
1da177e4 536/**
4a3ad20c
GKH
537 * device_create_file - create sysfs attribute file for device.
538 * @dev: device.
539 * @attr: device attribute descriptor.
1da177e4 540 */
26579ab7
PC
541int device_create_file(struct device *dev,
542 const struct device_attribute *attr)
1da177e4
LT
543{
544 int error = 0;
8f46baaa
FB
545
546 if (dev) {
547 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
97521978 548 "Attribute %s: write permission without 'store'\n",
549 attr->attr.name);
8f46baaa 550 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
97521978 551 "Attribute %s: read permission without 'show'\n",
552 attr->attr.name);
1da177e4 553 error = sysfs_create_file(&dev->kobj, &attr->attr);
8f46baaa
FB
554 }
555
1da177e4
LT
556 return error;
557}
86df2687 558EXPORT_SYMBOL_GPL(device_create_file);
1da177e4
LT
559
560/**
4a3ad20c
GKH
561 * device_remove_file - remove sysfs attribute file.
562 * @dev: device.
563 * @attr: device attribute descriptor.
1da177e4 564 */
26579ab7
PC
565void device_remove_file(struct device *dev,
566 const struct device_attribute *attr)
1da177e4 567{
0c98b19f 568 if (dev)
1da177e4 569 sysfs_remove_file(&dev->kobj, &attr->attr);
1da177e4 570}
86df2687 571EXPORT_SYMBOL_GPL(device_remove_file);
1da177e4 572
6b0afc2a
TH
573/**
574 * device_remove_file_self - remove sysfs attribute file from its own method.
575 * @dev: device.
576 * @attr: device attribute descriptor.
577 *
578 * See kernfs_remove_self() for details.
579 */
580bool device_remove_file_self(struct device *dev,
581 const struct device_attribute *attr)
582{
583 if (dev)
584 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
585 else
586 return false;
587}
588EXPORT_SYMBOL_GPL(device_remove_file_self);
589
2589f188
GKH
590/**
591 * device_create_bin_file - create sysfs binary attribute file for device.
592 * @dev: device.
593 * @attr: device binary attribute descriptor.
594 */
66ecb92b
PC
595int device_create_bin_file(struct device *dev,
596 const struct bin_attribute *attr)
2589f188
GKH
597{
598 int error = -EINVAL;
599 if (dev)
600 error = sysfs_create_bin_file(&dev->kobj, attr);
601 return error;
602}
603EXPORT_SYMBOL_GPL(device_create_bin_file);
604
605/**
606 * device_remove_bin_file - remove sysfs binary attribute file
607 * @dev: device.
608 * @attr: device binary attribute descriptor.
609 */
66ecb92b
PC
610void device_remove_bin_file(struct device *dev,
611 const struct bin_attribute *attr)
2589f188
GKH
612{
613 if (dev)
614 sysfs_remove_bin_file(&dev->kobj, attr);
615}
616EXPORT_SYMBOL_GPL(device_remove_bin_file);
617
34bb61f9
JB
618static void klist_children_get(struct klist_node *n)
619{
f791b8c8
GKH
620 struct device_private *p = to_device_private_parent(n);
621 struct device *dev = p->device;
34bb61f9
JB
622
623 get_device(dev);
624}
625
626static void klist_children_put(struct klist_node *n)
627{
f791b8c8
GKH
628 struct device_private *p = to_device_private_parent(n);
629 struct device *dev = p->device;
34bb61f9
JB
630
631 put_device(dev);
632}
633
1da177e4 634/**
4a3ad20c
GKH
635 * device_initialize - init device structure.
636 * @dev: device.
1da177e4 637 *
5739411a
CH
638 * This prepares the device for use by other layers by initializing
639 * its fields.
4a3ad20c 640 * It is the first half of device_register(), if called by
5739411a
CH
641 * that function, though it can also be called separately, so one
642 * may use @dev's fields. In particular, get_device()/put_device()
643 * may be used for reference counting of @dev after calling this
644 * function.
645 *
b10d5efd
AS
646 * All fields in @dev must be initialized by the caller to 0, except
647 * for those explicitly set to some other value. The simplest
648 * approach is to use kzalloc() to allocate the structure containing
649 * @dev.
650 *
5739411a
CH
651 * NOTE: Use put_device() to give up your reference instead of freeing
652 * @dev directly once you have called this function.
1da177e4 653 */
1da177e4
LT
654void device_initialize(struct device *dev)
655{
881c6cfd 656 dev->kobj.kset = devices_kset;
f9cb074b 657 kobject_init(&dev->kobj, &device_ktype);
1da177e4 658 INIT_LIST_HEAD(&dev->dma_pools);
3142788b 659 mutex_init(&dev->mutex);
1704f47b 660 lockdep_set_novalidate_class(&dev->mutex);
9ac7849e
TH
661 spin_lock_init(&dev->devres_lock);
662 INIT_LIST_HEAD(&dev->devres_head);
3b98aeaf 663 device_pm_init(dev);
87348136 664 set_dev_node(dev, -1);
1da177e4 665}
86df2687 666EXPORT_SYMBOL_GPL(device_initialize);
1da177e4 667
d73ce004 668struct kobject *virtual_device_parent(struct device *dev)
f0ee61a6 669{
86406245 670 static struct kobject *virtual_dir = NULL;
f0ee61a6 671
86406245 672 if (!virtual_dir)
4ff6abff 673 virtual_dir = kobject_create_and_add("virtual",
881c6cfd 674 &devices_kset->kobj);
f0ee61a6 675
86406245 676 return virtual_dir;
f0ee61a6
GKH
677}
678
bc451f20
EB
679struct class_dir {
680 struct kobject kobj;
681 struct class *class;
682};
683
684#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
685
686static void class_dir_release(struct kobject *kobj)
687{
688 struct class_dir *dir = to_class_dir(kobj);
689 kfree(dir);
690}
691
692static const
693struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
40fa5422 694{
bc451f20
EB
695 struct class_dir *dir = to_class_dir(kobj);
696 return dir->class->ns_type;
697}
698
699static struct kobj_type class_dir_ktype = {
700 .release = class_dir_release,
701 .sysfs_ops = &kobj_sysfs_ops,
702 .child_ns_type = class_dir_child_ns_type
703};
704
705static struct kobject *
706class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
707{
708 struct class_dir *dir;
43968d2f
GKH
709 int retval;
710
bc451f20
EB
711 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
712 if (!dir)
713 return NULL;
714
715 dir->class = class;
716 kobject_init(&dir->kobj, &class_dir_ktype);
717
6b6e39a6 718 dir->kobj.kset = &class->p->glue_dirs;
bc451f20
EB
719
720 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
721 if (retval < 0) {
722 kobject_put(&dir->kobj);
723 return NULL;
724 }
725 return &dir->kobj;
726}
727
e4a60d13 728static DEFINE_MUTEX(gdp_mutex);
bc451f20
EB
729
730static struct kobject *get_device_parent(struct device *dev,
731 struct device *parent)
732{
86406245
KS
733 if (dev->class) {
734 struct kobject *kobj = NULL;
735 struct kobject *parent_kobj;
736 struct kobject *k;
737
ead454fe 738#ifdef CONFIG_BLOCK
39aba963 739 /* block disks show up in /sys/block */
e52eec13 740 if (sysfs_deprecated && dev->class == &block_class) {
39aba963
KS
741 if (parent && parent->class == &block_class)
742 return &parent->kobj;
6b6e39a6 743 return &block_class.p->subsys.kobj;
39aba963 744 }
ead454fe 745#endif
e52eec13 746
86406245
KS
747 /*
748 * If we have no parent, we live in "virtual".
0f4dafc0
KS
749 * Class-devices with a non class-device as parent, live
750 * in a "glue" directory to prevent namespace collisions.
86406245
KS
751 */
752 if (parent == NULL)
753 parent_kobj = virtual_device_parent(dev);
24b1442d 754 else if (parent->class && !dev->class->ns_type)
86406245
KS
755 return &parent->kobj;
756 else
757 parent_kobj = &parent->kobj;
758
77d3d7c1
TH
759 mutex_lock(&gdp_mutex);
760
86406245 761 /* find our class-directory at the parent and reference it */
6b6e39a6
KS
762 spin_lock(&dev->class->p->glue_dirs.list_lock);
763 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
86406245
KS
764 if (k->parent == parent_kobj) {
765 kobj = kobject_get(k);
766 break;
767 }
6b6e39a6 768 spin_unlock(&dev->class->p->glue_dirs.list_lock);
77d3d7c1
TH
769 if (kobj) {
770 mutex_unlock(&gdp_mutex);
86406245 771 return kobj;
77d3d7c1 772 }
86406245
KS
773
774 /* or create a new class-directory at the parent device */
bc451f20 775 k = class_dir_create_and_add(dev->class, parent_kobj);
0f4dafc0 776 /* do not emit an uevent for this simple "glue" directory */
77d3d7c1 777 mutex_unlock(&gdp_mutex);
43968d2f 778 return k;
86406245
KS
779 }
780
ca22e56d
KS
781 /* subsystems can specify a default root directory for their devices */
782 if (!parent && dev->bus && dev->bus->dev_root)
783 return &dev->bus->dev_root->kobj;
784
86406245 785 if (parent)
c744aeae
CH
786 return &parent->kobj;
787 return NULL;
788}
da231fd5 789
63b6971a 790static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
da231fd5 791{
0f4dafc0 792 /* see if we live in a "glue" directory */
c1fe539a 793 if (!glue_dir || !dev->class ||
6b6e39a6 794 glue_dir->kset != &dev->class->p->glue_dirs)
da231fd5
KS
795 return;
796
e4a60d13 797 mutex_lock(&gdp_mutex);
0f4dafc0 798 kobject_put(glue_dir);
e4a60d13 799 mutex_unlock(&gdp_mutex);
da231fd5 800}
63b6971a
CH
801
802static void cleanup_device_parent(struct device *dev)
803{
804 cleanup_glue_dir(dev, dev->kobj.parent);
805}
86406245 806
2ee97caf
CH
807static int device_add_class_symlinks(struct device *dev)
808{
5590f319 809 struct device_node *of_node = dev_of_node(dev);
2ee97caf
CH
810 int error;
811
5590f319
BH
812 if (of_node) {
813 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
814 if (error)
815 dev_warn(dev, "Error %d creating of_node link\n",error);
816 /* An error here doesn't warrant bringing down the device */
817 }
818
2ee97caf
CH
819 if (!dev->class)
820 return 0;
da231fd5 821
1fbfee6c 822 error = sysfs_create_link(&dev->kobj,
6b6e39a6 823 &dev->class->p->subsys.kobj,
2ee97caf
CH
824 "subsystem");
825 if (error)
5590f319 826 goto out_devnode;
da231fd5 827
4e886c29 828 if (dev->parent && device_is_not_partition(dev)) {
39aba963 829 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
4f01a757
DT
830 "device");
831 if (error)
39aba963 832 goto out_subsys;
2ee97caf 833 }
2ee97caf 834
ead454fe 835#ifdef CONFIG_BLOCK
39aba963 836 /* /sys/block has directories and does not need symlinks */
e52eec13 837 if (sysfs_deprecated && dev->class == &block_class)
39aba963 838 return 0;
ead454fe 839#endif
39aba963 840
da231fd5 841 /* link in the class directory pointing to the device */
6b6e39a6 842 error = sysfs_create_link(&dev->class->p->subsys.kobj,
1e0b2cf9 843 &dev->kobj, dev_name(dev));
da231fd5 844 if (error)
39aba963 845 goto out_device;
da231fd5 846
da231fd5
KS
847 return 0;
848
39aba963
KS
849out_device:
850 sysfs_remove_link(&dev->kobj, "device");
da231fd5 851
2ee97caf
CH
852out_subsys:
853 sysfs_remove_link(&dev->kobj, "subsystem");
5590f319
BH
854out_devnode:
855 sysfs_remove_link(&dev->kobj, "of_node");
2ee97caf
CH
856 return error;
857}
858
859static void device_remove_class_symlinks(struct device *dev)
860{
5590f319
BH
861 if (dev_of_node(dev))
862 sysfs_remove_link(&dev->kobj, "of_node");
863
2ee97caf
CH
864 if (!dev->class)
865 return;
da231fd5 866
4e886c29 867 if (dev->parent && device_is_not_partition(dev))
da231fd5 868 sysfs_remove_link(&dev->kobj, "device");
2ee97caf 869 sysfs_remove_link(&dev->kobj, "subsystem");
ead454fe 870#ifdef CONFIG_BLOCK
e52eec13 871 if (sysfs_deprecated && dev->class == &block_class)
39aba963 872 return;
ead454fe 873#endif
6b6e39a6 874 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
2ee97caf
CH
875}
876
413c239f
SR
877/**
878 * dev_set_name - set a device name
879 * @dev: device
46232366 880 * @fmt: format string for the device's name
413c239f
SR
881 */
882int dev_set_name(struct device *dev, const char *fmt, ...)
883{
884 va_list vargs;
1fa5ae85 885 int err;
413c239f
SR
886
887 va_start(vargs, fmt);
1fa5ae85 888 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
413c239f 889 va_end(vargs);
1fa5ae85 890 return err;
413c239f
SR
891}
892EXPORT_SYMBOL_GPL(dev_set_name);
893
e105b8bf
DW
894/**
895 * device_to_dev_kobj - select a /sys/dev/ directory for the device
896 * @dev: device
897 *
898 * By default we select char/ for new entries. Setting class->dev_obj
899 * to NULL prevents an entry from being created. class->dev_kobj must
900 * be set (or cleared) before any devices are registered to the class
901 * otherwise device_create_sys_dev_entry() and
0d4e293c
PK
902 * device_remove_sys_dev_entry() will disagree about the presence of
903 * the link.
e105b8bf
DW
904 */
905static struct kobject *device_to_dev_kobj(struct device *dev)
906{
907 struct kobject *kobj;
908
909 if (dev->class)
910 kobj = dev->class->dev_kobj;
911 else
912 kobj = sysfs_dev_char_kobj;
913
914 return kobj;
915}
916
917static int device_create_sys_dev_entry(struct device *dev)
918{
919 struct kobject *kobj = device_to_dev_kobj(dev);
920 int error = 0;
921 char devt_str[15];
922
923 if (kobj) {
924 format_dev_t(devt_str, dev->devt);
925 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
926 }
927
928 return error;
929}
930
931static void device_remove_sys_dev_entry(struct device *dev)
932{
933 struct kobject *kobj = device_to_dev_kobj(dev);
934 char devt_str[15];
935
936 if (kobj) {
937 format_dev_t(devt_str, dev->devt);
938 sysfs_remove_link(kobj, devt_str);
939 }
940}
941
b4028437
GKH
942int device_private_init(struct device *dev)
943{
944 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
945 if (!dev->p)
946 return -ENOMEM;
947 dev->p->device = dev;
948 klist_init(&dev->p->klist_children, klist_children_get,
949 klist_children_put);
ef8a3fd6 950 INIT_LIST_HEAD(&dev->p->deferred_probe);
b4028437
GKH
951 return 0;
952}
953
1da177e4 954/**
4a3ad20c
GKH
955 * device_add - add device to device hierarchy.
956 * @dev: device.
1da177e4 957 *
4a3ad20c
GKH
958 * This is part 2 of device_register(), though may be called
959 * separately _iff_ device_initialize() has been called separately.
1da177e4 960 *
5739411a 961 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
4a3ad20c
GKH
962 * to the global and sibling lists for the device, then
963 * adds it to the other relevant subsystems of the driver model.
5739411a 964 *
b10d5efd
AS
965 * Do not call this routine or device_register() more than once for
966 * any device structure. The driver model core is not designed to work
967 * with devices that get unregistered and then spring back to life.
968 * (Among other things, it's very hard to guarantee that all references
969 * to the previous incarnation of @dev have been dropped.) Allocate
970 * and register a fresh new struct device instead.
971 *
5739411a
CH
972 * NOTE: _Never_ directly free @dev after calling this function, even
973 * if it returned an error! Always use put_device() to give up your
974 * reference instead.
1da177e4
LT
975 */
976int device_add(struct device *dev)
977{
978 struct device *parent = NULL;
ca22e56d 979 struct kobject *kobj;
c47ed219 980 struct class_interface *class_intf;
c906a48a 981 int error = -EINVAL;
775b64d2 982
1da177e4 983 dev = get_device(dev);
c906a48a
GKH
984 if (!dev)
985 goto done;
986
fb069a5d 987 if (!dev->p) {
b4028437
GKH
988 error = device_private_init(dev);
989 if (error)
990 goto done;
fb069a5d 991 }
fb069a5d 992
1fa5ae85
KS
993 /*
994 * for statically allocated devices, which should all be converted
995 * some day, we need to initialize the name. We prevent reading back
996 * the name, and force the use of dev_name()
997 */
998 if (dev->init_name) {
acc0e90f 999 dev_set_name(dev, "%s", dev->init_name);
1fa5ae85
KS
1000 dev->init_name = NULL;
1001 }
c906a48a 1002
ca22e56d
KS
1003 /* subsystems can specify simple device enumeration */
1004 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1005 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1006
e6309e75
TG
1007 if (!dev_name(dev)) {
1008 error = -EINVAL;
5c8563d7 1009 goto name_error;
e6309e75 1010 }
1da177e4 1011
1e0b2cf9 1012 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
c205ef48 1013
1da177e4 1014 parent = get_device(dev->parent);
ca22e56d
KS
1015 kobj = get_device_parent(dev, parent);
1016 if (kobj)
1017 dev->kobj.parent = kobj;
1da177e4 1018
0d358f22
YL
1019 /* use parent numa_node */
1020 if (parent)
1021 set_dev_node(dev, dev_to_node(parent));
1022
1da177e4 1023 /* first, register with generic layer. */
8a577ffc
KS
1024 /* we require the name to be set before, and pass NULL */
1025 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
40fa5422 1026 if (error)
1da177e4 1027 goto Error;
a7fd6706 1028
37022644
BW
1029 /* notify platform of device entry */
1030 if (platform_notify)
1031 platform_notify(dev);
1032
c5e064a6 1033 error = device_create_file(dev, &dev_attr_uevent);
a306eea4
CH
1034 if (error)
1035 goto attrError;
a7fd6706 1036
2ee97caf
CH
1037 error = device_add_class_symlinks(dev);
1038 if (error)
1039 goto SymlinkError;
dc0afa83
CH
1040 error = device_add_attrs(dev);
1041 if (error)
2620efef 1042 goto AttrsError;
dc0afa83
CH
1043 error = bus_add_device(dev);
1044 if (error)
1da177e4 1045 goto BusError;
3b98aeaf 1046 error = dpm_sysfs_add(dev);
57eee3d2 1047 if (error)
3b98aeaf
AS
1048 goto DPMError;
1049 device_pm_add(dev);
ec0676ee 1050
0cd75047
SK
1051 if (MAJOR(dev->devt)) {
1052 error = device_create_file(dev, &dev_attr_dev);
1053 if (error)
1054 goto DevAttrError;
1055
1056 error = device_create_sys_dev_entry(dev);
1057 if (error)
1058 goto SysEntryError;
1059
1060 devtmpfs_create_node(dev);
1061 }
1062
ec0676ee 1063 /* Notify clients of device addition. This call must come
268863f4 1064 * after dpm_sysfs_add() and before kobject_uevent().
ec0676ee
AS
1065 */
1066 if (dev->bus)
1067 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1068 BUS_NOTIFY_ADD_DEVICE, dev);
1069
83b5fb4c 1070 kobject_uevent(&dev->kobj, KOBJ_ADD);
2023c610 1071 bus_probe_device(dev);
1da177e4 1072 if (parent)
f791b8c8
GKH
1073 klist_add_tail(&dev->p->knode_parent,
1074 &parent->p->klist_children);
1da177e4 1075
5d9fd169 1076 if (dev->class) {
ca22e56d 1077 mutex_lock(&dev->class->p->mutex);
c47ed219 1078 /* tie the class to the device */
5a3ceb86 1079 klist_add_tail(&dev->knode_class,
6b6e39a6 1080 &dev->class->p->klist_devices);
c47ed219
GKH
1081
1082 /* notify any interfaces that the device is here */
184f1f77 1083 list_for_each_entry(class_intf,
ca22e56d 1084 &dev->class->p->interfaces, node)
c47ed219
GKH
1085 if (class_intf->add_dev)
1086 class_intf->add_dev(dev, class_intf);
ca22e56d 1087 mutex_unlock(&dev->class->p->mutex);
5d9fd169 1088 }
c906a48a 1089done:
1da177e4
LT
1090 put_device(dev);
1091 return error;
0cd75047
SK
1092 SysEntryError:
1093 if (MAJOR(dev->devt))
1094 device_remove_file(dev, &dev_attr_dev);
1095 DevAttrError:
1096 device_pm_remove(dev);
1097 dpm_sysfs_remove(dev);
3b98aeaf 1098 DPMError:
57eee3d2
RW
1099 bus_remove_device(dev);
1100 BusError:
82f0cf9b 1101 device_remove_attrs(dev);
2620efef 1102 AttrsError:
2ee97caf
CH
1103 device_remove_class_symlinks(dev);
1104 SymlinkError:
c5e064a6 1105 device_remove_file(dev, &dev_attr_uevent);
23681e47 1106 attrError:
312c004d 1107 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1da177e4
LT
1108 kobject_del(&dev->kobj);
1109 Error:
63b6971a 1110 cleanup_device_parent(dev);
5f0163a5 1111 put_device(parent);
5c8563d7
KS
1112name_error:
1113 kfree(dev->p);
1114 dev->p = NULL;
c906a48a 1115 goto done;
1da177e4 1116}
86df2687 1117EXPORT_SYMBOL_GPL(device_add);
1da177e4 1118
1da177e4 1119/**
4a3ad20c
GKH
1120 * device_register - register a device with the system.
1121 * @dev: pointer to the device structure
1da177e4 1122 *
4a3ad20c
GKH
1123 * This happens in two clean steps - initialize the device
1124 * and add it to the system. The two steps can be called
1125 * separately, but this is the easiest and most common.
1126 * I.e. you should only call the two helpers separately if
1127 * have a clearly defined need to use and refcount the device
1128 * before it is added to the hierarchy.
5739411a 1129 *
b10d5efd
AS
1130 * For more information, see the kerneldoc for device_initialize()
1131 * and device_add().
1132 *
5739411a
CH
1133 * NOTE: _Never_ directly free @dev after calling this function, even
1134 * if it returned an error! Always use put_device() to give up the
1135 * reference initialized in this function instead.
1da177e4 1136 */
1da177e4
LT
1137int device_register(struct device *dev)
1138{
1139 device_initialize(dev);
1140 return device_add(dev);
1141}
86df2687 1142EXPORT_SYMBOL_GPL(device_register);
1da177e4 1143
1da177e4 1144/**
4a3ad20c
GKH
1145 * get_device - increment reference count for device.
1146 * @dev: device.
1da177e4 1147 *
4a3ad20c
GKH
1148 * This simply forwards the call to kobject_get(), though
1149 * we do take care to provide for the case that we get a NULL
1150 * pointer passed in.
1da177e4 1151 */
4a3ad20c 1152struct device *get_device(struct device *dev)
1da177e4 1153{
b0d1f807 1154 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1da177e4 1155}
86df2687 1156EXPORT_SYMBOL_GPL(get_device);
1da177e4 1157
1da177e4 1158/**
4a3ad20c
GKH
1159 * put_device - decrement reference count.
1160 * @dev: device in question.
1da177e4 1161 */
4a3ad20c 1162void put_device(struct device *dev)
1da177e4 1163{
edfaa7c3 1164 /* might_sleep(); */
1da177e4
LT
1165 if (dev)
1166 kobject_put(&dev->kobj);
1167}
86df2687 1168EXPORT_SYMBOL_GPL(put_device);
1da177e4 1169
1da177e4 1170/**
4a3ad20c
GKH
1171 * device_del - delete device from system.
1172 * @dev: device.
1da177e4 1173 *
4a3ad20c
GKH
1174 * This is the first part of the device unregistration
1175 * sequence. This removes the device from the lists we control
1176 * from here, has it removed from the other driver model
1177 * subsystems it was added to in device_add(), and removes it
1178 * from the kobject hierarchy.
1da177e4 1179 *
4a3ad20c
GKH
1180 * NOTE: this should be called manually _iff_ device_add() was
1181 * also called manually.
1da177e4 1182 */
4a3ad20c 1183void device_del(struct device *dev)
1da177e4 1184{
4a3ad20c 1185 struct device *parent = dev->parent;
c47ed219 1186 struct class_interface *class_intf;
1da177e4 1187
ec0676ee
AS
1188 /* Notify clients of device removal. This call must come
1189 * before dpm_sysfs_remove().
1190 */
1191 if (dev->bus)
1192 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1193 BUS_NOTIFY_DEL_DEVICE, dev);
3b98aeaf 1194 dpm_sysfs_remove(dev);
1da177e4 1195 if (parent)
f791b8c8 1196 klist_del(&dev->p->knode_parent);
e105b8bf 1197 if (MAJOR(dev->devt)) {
2b2af54a 1198 devtmpfs_delete_node(dev);
e105b8bf 1199 device_remove_sys_dev_entry(dev);
c5e064a6 1200 device_remove_file(dev, &dev_attr_dev);
e105b8bf 1201 }
b9d9c82b 1202 if (dev->class) {
da231fd5 1203 device_remove_class_symlinks(dev);
99ef3ef8 1204
ca22e56d 1205 mutex_lock(&dev->class->p->mutex);
c47ed219 1206 /* notify any interfaces that the device is now gone */
184f1f77 1207 list_for_each_entry(class_intf,
ca22e56d 1208 &dev->class->p->interfaces, node)
c47ed219
GKH
1209 if (class_intf->remove_dev)
1210 class_intf->remove_dev(dev, class_intf);
1211 /* remove the device from the class list */
5a3ceb86 1212 klist_del(&dev->knode_class);
ca22e56d 1213 mutex_unlock(&dev->class->p->mutex);
b9d9c82b 1214 }
c5e064a6 1215 device_remove_file(dev, &dev_attr_uevent);
2620efef 1216 device_remove_attrs(dev);
28953533 1217 bus_remove_device(dev);
4b6d1f12 1218 device_pm_remove(dev);
d1c3414c 1219 driver_deferred_probe_del(dev);
1da177e4
LT
1220
1221 /* Notify the platform of the removal, in case they
1222 * need to do anything...
1223 */
1224 if (platform_notify_remove)
1225 platform_notify_remove(dev);
599bad38
JR
1226 if (dev->bus)
1227 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1228 BUS_NOTIFY_REMOVED_DEVICE, dev);
312c004d 1229 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
da231fd5 1230 cleanup_device_parent(dev);
1da177e4 1231 kobject_del(&dev->kobj);
da231fd5 1232 put_device(parent);
1da177e4 1233}
86df2687 1234EXPORT_SYMBOL_GPL(device_del);
1da177e4
LT
1235
1236/**
4a3ad20c
GKH
1237 * device_unregister - unregister device from system.
1238 * @dev: device going away.
1da177e4 1239 *
4a3ad20c
GKH
1240 * We do this in two parts, like we do device_register(). First,
1241 * we remove it from all the subsystems with device_del(), then
1242 * we decrement the reference count via put_device(). If that
1243 * is the final reference count, the device will be cleaned up
1244 * via device_release() above. Otherwise, the structure will
1245 * stick around until the final reference to the device is dropped.
1da177e4 1246 */
4a3ad20c 1247void device_unregister(struct device *dev)
1da177e4 1248{
1e0b2cf9 1249 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1da177e4
LT
1250 device_del(dev);
1251 put_device(dev);
1252}
86df2687 1253EXPORT_SYMBOL_GPL(device_unregister);
1da177e4 1254
4a3ad20c 1255static struct device *next_device(struct klist_iter *i)
36239577 1256{
4a3ad20c 1257 struct klist_node *n = klist_next(i);
f791b8c8
GKH
1258 struct device *dev = NULL;
1259 struct device_private *p;
1260
1261 if (n) {
1262 p = to_device_private_parent(n);
1263 dev = p->device;
1264 }
1265 return dev;
36239577 1266}
1267
6fcf53ac 1268/**
e454cea2 1269 * device_get_devnode - path of device node file
6fcf53ac 1270 * @dev: device
e454cea2 1271 * @mode: returned file access mode
3c2670e6
KS
1272 * @uid: returned file owner
1273 * @gid: returned file group
6fcf53ac
KS
1274 * @tmp: possibly allocated string
1275 *
1276 * Return the relative path of a possible device node.
1277 * Non-default names may need to allocate a memory to compose
1278 * a name. This memory is returned in tmp and needs to be
1279 * freed by the caller.
1280 */
e454cea2 1281const char *device_get_devnode(struct device *dev,
4e4098a3 1282 umode_t *mode, kuid_t *uid, kgid_t *gid,
3c2670e6 1283 const char **tmp)
6fcf53ac
KS
1284{
1285 char *s;
1286
1287 *tmp = NULL;
1288
1289 /* the device type may provide a specific name */
e454cea2 1290 if (dev->type && dev->type->devnode)
3c2670e6 1291 *tmp = dev->type->devnode(dev, mode, uid, gid);
6fcf53ac
KS
1292 if (*tmp)
1293 return *tmp;
1294
1295 /* the class may provide a specific name */
e454cea2
KS
1296 if (dev->class && dev->class->devnode)
1297 *tmp = dev->class->devnode(dev, mode);
6fcf53ac
KS
1298 if (*tmp)
1299 return *tmp;
1300
1301 /* return name without allocation, tmp == NULL */
1302 if (strchr(dev_name(dev), '!') == NULL)
1303 return dev_name(dev);
1304
1305 /* replace '!' in the name with '/' */
a29fd614
RV
1306 s = kstrdup(dev_name(dev), GFP_KERNEL);
1307 if (!s)
6fcf53ac 1308 return NULL;
a29fd614
RV
1309 strreplace(s, '!', '/');
1310 return *tmp = s;
6fcf53ac
KS
1311}
1312
1da177e4 1313/**
4a3ad20c
GKH
1314 * device_for_each_child - device child iterator.
1315 * @parent: parent struct device.
4a3ad20c 1316 * @fn: function to be called for each device.
f8878dcb 1317 * @data: data for the callback.
1da177e4 1318 *
4a3ad20c
GKH
1319 * Iterate over @parent's child devices, and call @fn for each,
1320 * passing it @data.
1da177e4 1321 *
4a3ad20c
GKH
1322 * We check the return of @fn each time. If it returns anything
1323 * other than 0, we break out and return that value.
1da177e4 1324 */
4a3ad20c
GKH
1325int device_for_each_child(struct device *parent, void *data,
1326 int (*fn)(struct device *dev, void *data))
1da177e4 1327{
36239577 1328 struct klist_iter i;
4a3ad20c 1329 struct device *child;
1da177e4
LT
1330 int error = 0;
1331
014c90db
GKH
1332 if (!parent->p)
1333 return 0;
1334
f791b8c8 1335 klist_iter_init(&parent->p->klist_children, &i);
36239577 1336 while ((child = next_device(&i)) && !error)
1337 error = fn(child, data);
1338 klist_iter_exit(&i);
1da177e4
LT
1339 return error;
1340}
86df2687 1341EXPORT_SYMBOL_GPL(device_for_each_child);
1da177e4 1342
5ab69981
CH
1343/**
1344 * device_find_child - device iterator for locating a particular device.
1345 * @parent: parent struct device
5ab69981 1346 * @match: Callback function to check device
f8878dcb 1347 * @data: Data to pass to match function
5ab69981
CH
1348 *
1349 * This is similar to the device_for_each_child() function above, but it
1350 * returns a reference to a device that is 'found' for later use, as
1351 * determined by the @match callback.
1352 *
1353 * The callback should return 0 if the device doesn't match and non-zero
1354 * if it does. If the callback returns non-zero and a reference to the
1355 * current device can be obtained, this function will return to the caller
1356 * and not iterate over any more devices.
a4e2400a
FV
1357 *
1358 * NOTE: you will need to drop the reference with put_device() after use.
5ab69981 1359 */
4a3ad20c
GKH
1360struct device *device_find_child(struct device *parent, void *data,
1361 int (*match)(struct device *dev, void *data))
5ab69981
CH
1362{
1363 struct klist_iter i;
1364 struct device *child;
1365
1366 if (!parent)
1367 return NULL;
1368
f791b8c8 1369 klist_iter_init(&parent->p->klist_children, &i);
5ab69981
CH
1370 while ((child = next_device(&i)))
1371 if (match(child, data) && get_device(child))
1372 break;
1373 klist_iter_exit(&i);
1374 return child;
1375}
86df2687 1376EXPORT_SYMBOL_GPL(device_find_child);
5ab69981 1377
1da177e4
LT
1378int __init devices_init(void)
1379{
881c6cfd
GKH
1380 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1381 if (!devices_kset)
1382 return -ENOMEM;
e105b8bf
DW
1383 dev_kobj = kobject_create_and_add("dev", NULL);
1384 if (!dev_kobj)
1385 goto dev_kobj_err;
1386 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1387 if (!sysfs_dev_block_kobj)
1388 goto block_kobj_err;
1389 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1390 if (!sysfs_dev_char_kobj)
1391 goto char_kobj_err;
1392
881c6cfd 1393 return 0;
e105b8bf
DW
1394
1395 char_kobj_err:
1396 kobject_put(sysfs_dev_block_kobj);
1397 block_kobj_err:
1398 kobject_put(dev_kobj);
1399 dev_kobj_err:
1400 kset_unregister(devices_kset);
1401 return -ENOMEM;
1da177e4
LT
1402}
1403
4f3549d7
RW
1404static int device_check_offline(struct device *dev, void *not_used)
1405{
1406 int ret;
1407
1408 ret = device_for_each_child(dev, NULL, device_check_offline);
1409 if (ret)
1410 return ret;
1411
1412 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1413}
1414
1415/**
1416 * device_offline - Prepare the device for hot-removal.
1417 * @dev: Device to be put offline.
1418 *
1419 * Execute the device bus type's .offline() callback, if present, to prepare
1420 * the device for a subsequent hot-removal. If that succeeds, the device must
1421 * not be used until either it is removed or its bus type's .online() callback
1422 * is executed.
1423 *
1424 * Call under device_hotplug_lock.
1425 */
1426int device_offline(struct device *dev)
1427{
1428 int ret;
1429
1430 if (dev->offline_disabled)
1431 return -EPERM;
1432
1433 ret = device_for_each_child(dev, NULL, device_check_offline);
1434 if (ret)
1435 return ret;
1436
1437 device_lock(dev);
1438 if (device_supports_offline(dev)) {
1439 if (dev->offline) {
1440 ret = 1;
1441 } else {
1442 ret = dev->bus->offline(dev);
1443 if (!ret) {
1444 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1445 dev->offline = true;
1446 }
1447 }
1448 }
1449 device_unlock(dev);
1450
1451 return ret;
1452}
1453
1454/**
1455 * device_online - Put the device back online after successful device_offline().
1456 * @dev: Device to be put back online.
1457 *
1458 * If device_offline() has been successfully executed for @dev, but the device
1459 * has not been removed subsequently, execute its bus type's .online() callback
1460 * to indicate that the device can be used again.
1461 *
1462 * Call under device_hotplug_lock.
1463 */
1464int device_online(struct device *dev)
1465{
1466 int ret = 0;
1467
1468 device_lock(dev);
1469 if (device_supports_offline(dev)) {
1470 if (dev->offline) {
1471 ret = dev->bus->online(dev);
1472 if (!ret) {
1473 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1474 dev->offline = false;
1475 }
1476 } else {
1477 ret = 1;
1478 }
1479 }
1480 device_unlock(dev);
1481
1482 return ret;
1483}
1484
7f100d15 1485struct root_device {
0aa0dc41
MM
1486 struct device dev;
1487 struct module *owner;
1488};
1489
93058424 1490static inline struct root_device *to_root_device(struct device *d)
481e2079
FW
1491{
1492 return container_of(d, struct root_device, dev);
1493}
0aa0dc41
MM
1494
1495static void root_device_release(struct device *dev)
1496{
1497 kfree(to_root_device(dev));
1498}
1499
1500/**
1501 * __root_device_register - allocate and register a root device
1502 * @name: root device name
1503 * @owner: owner module of the root device, usually THIS_MODULE
1504 *
1505 * This function allocates a root device and registers it
1506 * using device_register(). In order to free the returned
1507 * device, use root_device_unregister().
1508 *
1509 * Root devices are dummy devices which allow other devices
1510 * to be grouped under /sys/devices. Use this function to
1511 * allocate a root device and then use it as the parent of
1512 * any device which should appear under /sys/devices/{name}
1513 *
1514 * The /sys/devices/{name} directory will also contain a
1515 * 'module' symlink which points to the @owner directory
1516 * in sysfs.
1517 *
f0eae0ed
JN
1518 * Returns &struct device pointer on success, or ERR_PTR() on error.
1519 *
0aa0dc41
MM
1520 * Note: You probably want to use root_device_register().
1521 */
1522struct device *__root_device_register(const char *name, struct module *owner)
1523{
1524 struct root_device *root;
1525 int err = -ENOMEM;
1526
1527 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1528 if (!root)
1529 return ERR_PTR(err);
1530
acc0e90f 1531 err = dev_set_name(&root->dev, "%s", name);
0aa0dc41
MM
1532 if (err) {
1533 kfree(root);
1534 return ERR_PTR(err);
1535 }
1536
1537 root->dev.release = root_device_release;
1538
1539 err = device_register(&root->dev);
1540 if (err) {
1541 put_device(&root->dev);
1542 return ERR_PTR(err);
1543 }
1544
1d9e882b 1545#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
0aa0dc41
MM
1546 if (owner) {
1547 struct module_kobject *mk = &owner->mkobj;
1548
1549 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1550 if (err) {
1551 device_unregister(&root->dev);
1552 return ERR_PTR(err);
1553 }
1554 root->owner = owner;
1555 }
1556#endif
1557
1558 return &root->dev;
1559}
1560EXPORT_SYMBOL_GPL(__root_device_register);
1561
1562/**
1563 * root_device_unregister - unregister and free a root device
7cbcf225 1564 * @dev: device going away
0aa0dc41
MM
1565 *
1566 * This function unregisters and cleans up a device that was created by
1567 * root_device_register().
1568 */
1569void root_device_unregister(struct device *dev)
1570{
1571 struct root_device *root = to_root_device(dev);
1572
1573 if (root->owner)
1574 sysfs_remove_link(&root->dev.kobj, "module");
1575
1576 device_unregister(dev);
1577}
1578EXPORT_SYMBOL_GPL(root_device_unregister);
1579
23681e47
GKH
1580
1581static void device_create_release(struct device *dev)
1582{
1e0b2cf9 1583 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
23681e47
GKH
1584 kfree(dev);
1585}
1586
39ef3112
GR
1587static struct device *
1588device_create_groups_vargs(struct class *class, struct device *parent,
1589 dev_t devt, void *drvdata,
1590 const struct attribute_group **groups,
1591 const char *fmt, va_list args)
23681e47 1592{
23681e47
GKH
1593 struct device *dev = NULL;
1594 int retval = -ENODEV;
1595
1596 if (class == NULL || IS_ERR(class))
1597 goto error;
23681e47
GKH
1598
1599 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1600 if (!dev) {
1601 retval = -ENOMEM;
1602 goto error;
1603 }
1604
bbc780f8 1605 device_initialize(dev);
23681e47
GKH
1606 dev->devt = devt;
1607 dev->class = class;
1608 dev->parent = parent;
39ef3112 1609 dev->groups = groups;
23681e47 1610 dev->release = device_create_release;
8882b394 1611 dev_set_drvdata(dev, drvdata);
23681e47 1612
1fa5ae85
KS
1613 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1614 if (retval)
1615 goto error;
1616
bbc780f8 1617 retval = device_add(dev);
23681e47
GKH
1618 if (retval)
1619 goto error;
1620
23681e47
GKH
1621 return dev;
1622
1623error:
286661b3 1624 put_device(dev);
23681e47
GKH
1625 return ERR_PTR(retval);
1626}
39ef3112
GR
1627
1628/**
1629 * device_create_vargs - creates a device and registers it with sysfs
1630 * @class: pointer to the struct class that this device should be registered to
1631 * @parent: pointer to the parent struct device of this new device, if any
1632 * @devt: the dev_t for the char device to be added
1633 * @drvdata: the data to be added to the device for callbacks
1634 * @fmt: string for the device's name
1635 * @args: va_list for the device's name
1636 *
1637 * This function can be used by char device classes. A struct device
1638 * will be created in sysfs, registered to the specified class.
1639 *
1640 * A "dev" file will be created, showing the dev_t for the device, if
1641 * the dev_t is not 0,0.
1642 * If a pointer to a parent struct device is passed in, the newly created
1643 * struct device will be a child of that device in sysfs.
1644 * The pointer to the struct device will be returned from the call.
1645 * Any further sysfs files that might be required can be created using this
1646 * pointer.
1647 *
1648 * Returns &struct device pointer on success, or ERR_PTR() on error.
1649 *
1650 * Note: the struct class passed to this function must have previously
1651 * been created with a call to class_create().
1652 */
1653struct device *device_create_vargs(struct class *class, struct device *parent,
1654 dev_t devt, void *drvdata, const char *fmt,
1655 va_list args)
1656{
1657 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1658 fmt, args);
1659}
8882b394
GKH
1660EXPORT_SYMBOL_GPL(device_create_vargs);
1661
1662/**
4e106739 1663 * device_create - creates a device and registers it with sysfs
8882b394
GKH
1664 * @class: pointer to the struct class that this device should be registered to
1665 * @parent: pointer to the parent struct device of this new device, if any
1666 * @devt: the dev_t for the char device to be added
1667 * @drvdata: the data to be added to the device for callbacks
1668 * @fmt: string for the device's name
1669 *
1670 * This function can be used by char device classes. A struct device
1671 * will be created in sysfs, registered to the specified class.
1672 *
1673 * A "dev" file will be created, showing the dev_t for the device, if
1674 * the dev_t is not 0,0.
1675 * If a pointer to a parent struct device is passed in, the newly created
1676 * struct device will be a child of that device in sysfs.
1677 * The pointer to the struct device will be returned from the call.
1678 * Any further sysfs files that might be required can be created using this
1679 * pointer.
1680 *
f0eae0ed
JN
1681 * Returns &struct device pointer on success, or ERR_PTR() on error.
1682 *
8882b394
GKH
1683 * Note: the struct class passed to this function must have previously
1684 * been created with a call to class_create().
1685 */
4e106739
GKH
1686struct device *device_create(struct class *class, struct device *parent,
1687 dev_t devt, void *drvdata, const char *fmt, ...)
8882b394
GKH
1688{
1689 va_list vargs;
1690 struct device *dev;
1691
1692 va_start(vargs, fmt);
1693 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1694 va_end(vargs);
1695 return dev;
1696}
4e106739 1697EXPORT_SYMBOL_GPL(device_create);
8882b394 1698
39ef3112
GR
1699/**
1700 * device_create_with_groups - creates a device and registers it with sysfs
1701 * @class: pointer to the struct class that this device should be registered to
1702 * @parent: pointer to the parent struct device of this new device, if any
1703 * @devt: the dev_t for the char device to be added
1704 * @drvdata: the data to be added to the device for callbacks
1705 * @groups: NULL-terminated list of attribute groups to be created
1706 * @fmt: string for the device's name
1707 *
1708 * This function can be used by char device classes. A struct device
1709 * will be created in sysfs, registered to the specified class.
1710 * Additional attributes specified in the groups parameter will also
1711 * be created automatically.
1712 *
1713 * A "dev" file will be created, showing the dev_t for the device, if
1714 * the dev_t is not 0,0.
1715 * If a pointer to a parent struct device is passed in, the newly created
1716 * struct device will be a child of that device in sysfs.
1717 * The pointer to the struct device will be returned from the call.
1718 * Any further sysfs files that might be required can be created using this
1719 * pointer.
1720 *
1721 * Returns &struct device pointer on success, or ERR_PTR() on error.
1722 *
1723 * Note: the struct class passed to this function must have previously
1724 * been created with a call to class_create().
1725 */
1726struct device *device_create_with_groups(struct class *class,
1727 struct device *parent, dev_t devt,
1728 void *drvdata,
1729 const struct attribute_group **groups,
1730 const char *fmt, ...)
1731{
1732 va_list vargs;
1733 struct device *dev;
1734
1735 va_start(vargs, fmt);
1736 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1737 fmt, vargs);
1738 va_end(vargs);
1739 return dev;
1740}
1741EXPORT_SYMBOL_GPL(device_create_with_groups);
1742
9f3b795a 1743static int __match_devt(struct device *dev, const void *data)
23681e47 1744{
9f3b795a 1745 const dev_t *devt = data;
23681e47 1746
cd35449b 1747 return dev->devt == *devt;
775b64d2
RW
1748}
1749
1750/**
1751 * device_destroy - removes a device that was created with device_create()
1752 * @class: pointer to the struct class that this device was registered with
1753 * @devt: the dev_t of the device that was previously registered
1754 *
1755 * This call unregisters and cleans up a device that was created with a
1756 * call to device_create().
1757 */
1758void device_destroy(struct class *class, dev_t devt)
1759{
1760 struct device *dev;
23681e47 1761
695794ae 1762 dev = class_find_device(class, NULL, &devt, __match_devt);
cd35449b
DY
1763 if (dev) {
1764 put_device(dev);
23681e47 1765 device_unregister(dev);
cd35449b 1766 }
23681e47
GKH
1767}
1768EXPORT_SYMBOL_GPL(device_destroy);
a2de48ca
GKH
1769
1770/**
1771 * device_rename - renames a device
1772 * @dev: the pointer to the struct device to be renamed
1773 * @new_name: the new name of the device
030c1d2b
EB
1774 *
1775 * It is the responsibility of the caller to provide mutual
1776 * exclusion between two different calls of device_rename
1777 * on the same device to ensure that new_name is valid and
1778 * won't conflict with other devices.
c6c0ac66 1779 *
a5462516
TT
1780 * Note: Don't call this function. Currently, the networking layer calls this
1781 * function, but that will change. The following text from Kay Sievers offers
1782 * some insight:
1783 *
1784 * Renaming devices is racy at many levels, symlinks and other stuff are not
1785 * replaced atomically, and you get a "move" uevent, but it's not easy to
1786 * connect the event to the old and new device. Device nodes are not renamed at
1787 * all, there isn't even support for that in the kernel now.
1788 *
1789 * In the meantime, during renaming, your target name might be taken by another
1790 * driver, creating conflicts. Or the old name is taken directly after you
1791 * renamed it -- then you get events for the same DEVPATH, before you even see
1792 * the "move" event. It's just a mess, and nothing new should ever rely on
1793 * kernel device renaming. Besides that, it's not even implemented now for
1794 * other things than (driver-core wise very simple) network devices.
1795 *
1796 * We are currently about to change network renaming in udev to completely
1797 * disallow renaming of devices in the same namespace as the kernel uses,
1798 * because we can't solve the problems properly, that arise with swapping names
1799 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1800 * be allowed to some other name than eth[0-9]*, for the aforementioned
1801 * reasons.
1802 *
1803 * Make up a "real" name in the driver before you register anything, or add
1804 * some other attributes for userspace to find the device, or use udev to add
1805 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1806 * don't even want to get into that and try to implement the missing pieces in
1807 * the core. We really have other pieces to fix in the driver core mess. :)
a2de48ca 1808 */
6937e8f8 1809int device_rename(struct device *dev, const char *new_name)
a2de48ca 1810{
4b30ee58 1811 struct kobject *kobj = &dev->kobj;
2ee97caf 1812 char *old_device_name = NULL;
a2de48ca
GKH
1813 int error;
1814
1815 dev = get_device(dev);
1816 if (!dev)
1817 return -EINVAL;
1818
69df7533 1819 dev_dbg(dev, "renaming to %s\n", new_name);
a2de48ca 1820
1fa5ae85 1821 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
2ee97caf
CH
1822 if (!old_device_name) {
1823 error = -ENOMEM;
1824 goto out;
a2de48ca 1825 }
a2de48ca 1826
f349cf34 1827 if (dev->class) {
4b30ee58
TH
1828 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1829 kobj, old_device_name,
1830 new_name, kobject_namespace(kobj));
f349cf34
EB
1831 if (error)
1832 goto out;
1833 }
39aba963 1834
4b30ee58 1835 error = kobject_rename(kobj, new_name);
1fa5ae85 1836 if (error)
2ee97caf 1837 goto out;
a2de48ca 1838
2ee97caf 1839out:
a2de48ca
GKH
1840 put_device(dev);
1841
2ee97caf 1842 kfree(old_device_name);
a2de48ca
GKH
1843
1844 return error;
1845}
a2807dbc 1846EXPORT_SYMBOL_GPL(device_rename);
8a82472f
CH
1847
1848static int device_move_class_links(struct device *dev,
1849 struct device *old_parent,
1850 struct device *new_parent)
1851{
f7f3461d 1852 int error = 0;
8a82472f 1853
f7f3461d
GKH
1854 if (old_parent)
1855 sysfs_remove_link(&dev->kobj, "device");
1856 if (new_parent)
1857 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1858 "device");
1859 return error;
8a82472f
CH
1860}
1861
1862/**
1863 * device_move - moves a device to a new parent
1864 * @dev: the pointer to the struct device to be moved
c744aeae 1865 * @new_parent: the new parent of the device (can by NULL)
ffa6a705 1866 * @dpm_order: how to reorder the dpm_list
8a82472f 1867 */
ffa6a705
CH
1868int device_move(struct device *dev, struct device *new_parent,
1869 enum dpm_order dpm_order)
8a82472f
CH
1870{
1871 int error;
1872 struct device *old_parent;
c744aeae 1873 struct kobject *new_parent_kobj;
8a82472f
CH
1874
1875 dev = get_device(dev);
1876 if (!dev)
1877 return -EINVAL;
1878
ffa6a705 1879 device_pm_lock();
8a82472f 1880 new_parent = get_device(new_parent);
4a3ad20c 1881 new_parent_kobj = get_device_parent(dev, new_parent);
63b6971a 1882
1e0b2cf9
KS
1883 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1884 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
c744aeae 1885 error = kobject_move(&dev->kobj, new_parent_kobj);
8a82472f 1886 if (error) {
63b6971a 1887 cleanup_glue_dir(dev, new_parent_kobj);
8a82472f
CH
1888 put_device(new_parent);
1889 goto out;
1890 }
1891 old_parent = dev->parent;
1892 dev->parent = new_parent;
1893 if (old_parent)
f791b8c8 1894 klist_remove(&dev->p->knode_parent);
0d358f22 1895 if (new_parent) {
f791b8c8
GKH
1896 klist_add_tail(&dev->p->knode_parent,
1897 &new_parent->p->klist_children);
0d358f22
YL
1898 set_dev_node(dev, dev_to_node(new_parent));
1899 }
1900
bdd4034d
RV
1901 if (dev->class) {
1902 error = device_move_class_links(dev, old_parent, new_parent);
1903 if (error) {
1904 /* We ignore errors on cleanup since we're hosed anyway... */
1905 device_move_class_links(dev, new_parent, old_parent);
1906 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1907 if (new_parent)
1908 klist_remove(&dev->p->knode_parent);
1909 dev->parent = old_parent;
1910 if (old_parent) {
1911 klist_add_tail(&dev->p->knode_parent,
1912 &old_parent->p->klist_children);
1913 set_dev_node(dev, dev_to_node(old_parent));
1914 }
0d358f22 1915 }
bdd4034d
RV
1916 cleanup_glue_dir(dev, new_parent_kobj);
1917 put_device(new_parent);
1918 goto out;
8a82472f 1919 }
8a82472f 1920 }
ffa6a705
CH
1921 switch (dpm_order) {
1922 case DPM_ORDER_NONE:
1923 break;
1924 case DPM_ORDER_DEV_AFTER_PARENT:
1925 device_pm_move_after(dev, new_parent);
1926 break;
1927 case DPM_ORDER_PARENT_BEFORE_DEV:
1928 device_pm_move_before(new_parent, dev);
1929 break;
1930 case DPM_ORDER_DEV_LAST:
1931 device_pm_move_last(dev);
1932 break;
1933 }
bdd4034d 1934
8a82472f
CH
1935 put_device(old_parent);
1936out:
ffa6a705 1937 device_pm_unlock();
8a82472f
CH
1938 put_device(dev);
1939 return error;
1940}
8a82472f 1941EXPORT_SYMBOL_GPL(device_move);
37b0c020
GKH
1942
1943/**
1944 * device_shutdown - call ->shutdown() on each device to shutdown.
1945 */
1946void device_shutdown(void)
1947{
f123db8e 1948 struct device *dev, *parent;
6245838f
HD
1949
1950 spin_lock(&devices_kset->list_lock);
1951 /*
1952 * Walk the devices list backward, shutting down each in turn.
1953 * Beware that device unplug events may also start pulling
1954 * devices offline, even as the system is shutting down.
1955 */
1956 while (!list_empty(&devices_kset->list)) {
1957 dev = list_entry(devices_kset->list.prev, struct device,
1958 kobj.entry);
d1c6c030
ML
1959
1960 /*
1961 * hold reference count of device's parent to
1962 * prevent it from being freed because parent's
1963 * lock is to be held
1964 */
f123db8e 1965 parent = get_device(dev->parent);
6245838f
HD
1966 get_device(dev);
1967 /*
1968 * Make sure the device is off the kset list, in the
1969 * event that dev->*->shutdown() doesn't remove it.
1970 */
1971 list_del_init(&dev->kobj.entry);
1972 spin_unlock(&devices_kset->list_lock);
fe6b91f4 1973
d1c6c030 1974 /* hold lock to avoid race with probe/release */
f123db8e
BL
1975 if (parent)
1976 device_lock(parent);
d1c6c030
ML
1977 device_lock(dev);
1978
fe6b91f4
AS
1979 /* Don't allow any more runtime suspends */
1980 pm_runtime_get_noresume(dev);
1981 pm_runtime_barrier(dev);
37b0c020 1982
37b0c020 1983 if (dev->bus && dev->bus->shutdown) {
0246c4fa
SL
1984 if (initcall_debug)
1985 dev_info(dev, "shutdown\n");
37b0c020
GKH
1986 dev->bus->shutdown(dev);
1987 } else if (dev->driver && dev->driver->shutdown) {
0246c4fa
SL
1988 if (initcall_debug)
1989 dev_info(dev, "shutdown\n");
37b0c020
GKH
1990 dev->driver->shutdown(dev);
1991 }
d1c6c030
ML
1992
1993 device_unlock(dev);
f123db8e
BL
1994 if (parent)
1995 device_unlock(parent);
d1c6c030 1996
6245838f 1997 put_device(dev);
f123db8e 1998 put_device(parent);
6245838f
HD
1999
2000 spin_lock(&devices_kset->list_lock);
37b0c020 2001 }
6245838f 2002 spin_unlock(&devices_kset->list_lock);
37b0c020 2003}
99bcf217
JP
2004
2005/*
2006 * Device logging functions
2007 */
2008
2009#ifdef CONFIG_PRINTK
666f355f
JP
2010static int
2011create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
99bcf217 2012{
c4e00daa 2013 const char *subsys;
798efc60 2014 size_t pos = 0;
99bcf217 2015
c4e00daa
KS
2016 if (dev->class)
2017 subsys = dev->class->name;
2018 else if (dev->bus)
2019 subsys = dev->bus->name;
2020 else
798efc60 2021 return 0;
c4e00daa 2022
798efc60 2023 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
655e5b7c
BH
2024 if (pos >= hdrlen)
2025 goto overflow;
c4e00daa
KS
2026
2027 /*
2028 * Add device identifier DEVICE=:
2029 * b12:8 block dev_t
2030 * c127:3 char dev_t
2031 * n8 netdev ifindex
2032 * +sound:card0 subsystem:devname
2033 */
2034 if (MAJOR(dev->devt)) {
2035 char c;
2036
2037 if (strcmp(subsys, "block") == 0)
2038 c = 'b';
2039 else
2040 c = 'c';
798efc60
JP
2041 pos++;
2042 pos += snprintf(hdr + pos, hdrlen - pos,
2043 "DEVICE=%c%u:%u",
2044 c, MAJOR(dev->devt), MINOR(dev->devt));
c4e00daa
KS
2045 } else if (strcmp(subsys, "net") == 0) {
2046 struct net_device *net = to_net_dev(dev);
2047
798efc60
JP
2048 pos++;
2049 pos += snprintf(hdr + pos, hdrlen - pos,
2050 "DEVICE=n%u", net->ifindex);
c4e00daa 2051 } else {
798efc60
JP
2052 pos++;
2053 pos += snprintf(hdr + pos, hdrlen - pos,
2054 "DEVICE=+%s:%s", subsys, dev_name(dev));
c4e00daa 2055 }
af7f2158 2056
655e5b7c
BH
2057 if (pos >= hdrlen)
2058 goto overflow;
2059
798efc60 2060 return pos;
655e5b7c
BH
2061
2062overflow:
2063 dev_WARN(dev, "device/subsystem name too long");
2064 return 0;
798efc60 2065}
798efc60 2066
05e4e5b8
JP
2067int dev_vprintk_emit(int level, const struct device *dev,
2068 const char *fmt, va_list args)
2069{
2070 char hdr[128];
2071 size_t hdrlen;
2072
2073 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2074
2075 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2076}
2077EXPORT_SYMBOL(dev_vprintk_emit);
2078
2079int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2080{
2081 va_list args;
2082 int r;
2083
2084 va_start(args, fmt);
2085
2086 r = dev_vprintk_emit(level, dev, fmt, args);
2087
2088 va_end(args);
2089
2090 return r;
2091}
2092EXPORT_SYMBOL(dev_printk_emit);
2093
d1f1052c 2094static void __dev_printk(const char *level, const struct device *dev,
798efc60
JP
2095 struct va_format *vaf)
2096{
d1f1052c
JP
2097 if (dev)
2098 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2099 dev_driver_string(dev), dev_name(dev), vaf);
2100 else
2101 printk("%s(NULL device *): %pV", level, vaf);
99bcf217
JP
2102}
2103
d1f1052c
JP
2104void dev_printk(const char *level, const struct device *dev,
2105 const char *fmt, ...)
99bcf217
JP
2106{
2107 struct va_format vaf;
2108 va_list args;
99bcf217
JP
2109
2110 va_start(args, fmt);
2111
2112 vaf.fmt = fmt;
2113 vaf.va = &args;
2114
d1f1052c 2115 __dev_printk(level, dev, &vaf);
798efc60 2116
99bcf217 2117 va_end(args);
99bcf217
JP
2118}
2119EXPORT_SYMBOL(dev_printk);
2120
2121#define define_dev_printk_level(func, kern_level) \
d1f1052c 2122void func(const struct device *dev, const char *fmt, ...) \
99bcf217
JP
2123{ \
2124 struct va_format vaf; \
2125 va_list args; \
99bcf217
JP
2126 \
2127 va_start(args, fmt); \
2128 \
2129 vaf.fmt = fmt; \
2130 vaf.va = &args; \
2131 \
d1f1052c 2132 __dev_printk(kern_level, dev, &vaf); \
798efc60 2133 \
99bcf217 2134 va_end(args); \
99bcf217
JP
2135} \
2136EXPORT_SYMBOL(func);
2137
2138define_dev_printk_level(dev_emerg, KERN_EMERG);
2139define_dev_printk_level(dev_alert, KERN_ALERT);
2140define_dev_printk_level(dev_crit, KERN_CRIT);
2141define_dev_printk_level(dev_err, KERN_ERR);
2142define_dev_printk_level(dev_warn, KERN_WARNING);
2143define_dev_printk_level(dev_notice, KERN_NOTICE);
2144define_dev_printk_level(_dev_info, KERN_INFO);
2145
2146#endif
97badf87
RW
2147
2148static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2149{
2150 return fwnode && !IS_ERR(fwnode->secondary);
2151}
2152
2153/**
2154 * set_primary_fwnode - Change the primary firmware node of a given device.
2155 * @dev: Device to handle.
2156 * @fwnode: New primary firmware node of the device.
2157 *
2158 * Set the device's firmware node pointer to @fwnode, but if a secondary
2159 * firmware node of the device is present, preserve it.
2160 */
2161void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2162{
2163 if (fwnode) {
2164 struct fwnode_handle *fn = dev->fwnode;
2165
2166 if (fwnode_is_primary(fn))
2167 fn = fn->secondary;
2168
2169 fwnode->secondary = fn;
2170 dev->fwnode = fwnode;
2171 } else {
2172 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2173 dev->fwnode->secondary : NULL;
2174 }
2175}
2176EXPORT_SYMBOL_GPL(set_primary_fwnode);
2177
2178/**
2179 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2180 * @dev: Device to handle.
2181 * @fwnode: New secondary firmware node of the device.
2182 *
2183 * If a primary firmware node of the device is present, set its secondary
2184 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2185 * @fwnode.
2186 */
2187void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2188{
2189 if (fwnode)
2190 fwnode->secondary = ERR_PTR(-ENODEV);
2191
2192 if (fwnode_is_primary(dev->fwnode))
2193 dev->fwnode->secondary = fwnode;
2194 else
2195 dev->fwnode = fwnode;
2196}