kernfs, sysfs, driver-core: implement kernfs_remove_self() and its wrappers
[deliverable/linux.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>
15#include <linux/init.h>
16#include <linux/module.h>
17#include <linux/slab.h>
18#include <linux/string.h>
23681e47 19#include <linux/kdev_t.h>
116af378 20#include <linux/notifier.h>
07d57a32
GL
21#include <linux/of.h>
22#include <linux/of_device.h>
da231fd5 23#include <linux/genhd.h>
815d2d50 24#include <linux/kallsyms.h>
f75b1c60 25#include <linux/mutex.h>
401097ea 26#include <linux/async.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
a30f82b7
GKH
618/**
619 * device_schedule_callback_owner - helper to schedule a callback for a device
620 * @dev: device.
621 * @func: callback function to invoke later.
622 * @owner: module owning the callback routine
623 *
624 * Attribute methods must not unregister themselves or their parent device
625 * (which would amount to the same thing). Attempts to do so will deadlock,
626 * since unregistration is mutually exclusive with driver callbacks.
627 *
628 * Instead methods can call this routine, which will attempt to allocate
629 * and schedule a workqueue request to call back @func with @dev as its
630 * argument in the workqueue's process context. @dev will be pinned until
631 * @func returns.
632 *
633 * This routine is usually called via the inline device_schedule_callback(),
634 * which automatically sets @owner to THIS_MODULE.
635 *
636 * Returns 0 if the request was submitted, -ENOMEM if storage could not
637 * be allocated, -ENODEV if a reference to @owner isn't available.
638 *
639 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
640 * underlying sysfs routine (since it is intended for use by attribute
641 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
642 */
643int device_schedule_callback_owner(struct device *dev,
644 void (*func)(struct device *), struct module *owner)
645{
646 return sysfs_schedule_callback(&dev->kobj,
647 (void (*)(void *)) func, dev, owner);
648}
649EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
650
34bb61f9
JB
651static void klist_children_get(struct klist_node *n)
652{
f791b8c8
GKH
653 struct device_private *p = to_device_private_parent(n);
654 struct device *dev = p->device;
34bb61f9
JB
655
656 get_device(dev);
657}
658
659static void klist_children_put(struct klist_node *n)
660{
f791b8c8
GKH
661 struct device_private *p = to_device_private_parent(n);
662 struct device *dev = p->device;
34bb61f9
JB
663
664 put_device(dev);
665}
666
1da177e4 667/**
4a3ad20c
GKH
668 * device_initialize - init device structure.
669 * @dev: device.
1da177e4 670 *
5739411a
CH
671 * This prepares the device for use by other layers by initializing
672 * its fields.
4a3ad20c 673 * It is the first half of device_register(), if called by
5739411a
CH
674 * that function, though it can also be called separately, so one
675 * may use @dev's fields. In particular, get_device()/put_device()
676 * may be used for reference counting of @dev after calling this
677 * function.
678 *
b10d5efd
AS
679 * All fields in @dev must be initialized by the caller to 0, except
680 * for those explicitly set to some other value. The simplest
681 * approach is to use kzalloc() to allocate the structure containing
682 * @dev.
683 *
5739411a
CH
684 * NOTE: Use put_device() to give up your reference instead of freeing
685 * @dev directly once you have called this function.
1da177e4 686 */
1da177e4
LT
687void device_initialize(struct device *dev)
688{
881c6cfd 689 dev->kobj.kset = devices_kset;
f9cb074b 690 kobject_init(&dev->kobj, &device_ktype);
1da177e4 691 INIT_LIST_HEAD(&dev->dma_pools);
3142788b 692 mutex_init(&dev->mutex);
1704f47b 693 lockdep_set_novalidate_class(&dev->mutex);
9ac7849e
TH
694 spin_lock_init(&dev->devres_lock);
695 INIT_LIST_HEAD(&dev->devres_head);
3b98aeaf 696 device_pm_init(dev);
87348136 697 set_dev_node(dev, -1);
1da177e4 698}
86df2687 699EXPORT_SYMBOL_GPL(device_initialize);
1da177e4 700
d73ce004 701struct kobject *virtual_device_parent(struct device *dev)
f0ee61a6 702{
86406245 703 static struct kobject *virtual_dir = NULL;
f0ee61a6 704
86406245 705 if (!virtual_dir)
4ff6abff 706 virtual_dir = kobject_create_and_add("virtual",
881c6cfd 707 &devices_kset->kobj);
f0ee61a6 708
86406245 709 return virtual_dir;
f0ee61a6
GKH
710}
711
bc451f20
EB
712struct class_dir {
713 struct kobject kobj;
714 struct class *class;
715};
716
717#define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
718
719static void class_dir_release(struct kobject *kobj)
720{
721 struct class_dir *dir = to_class_dir(kobj);
722 kfree(dir);
723}
724
725static const
726struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
40fa5422 727{
bc451f20
EB
728 struct class_dir *dir = to_class_dir(kobj);
729 return dir->class->ns_type;
730}
731
732static struct kobj_type class_dir_ktype = {
733 .release = class_dir_release,
734 .sysfs_ops = &kobj_sysfs_ops,
735 .child_ns_type = class_dir_child_ns_type
736};
737
738static struct kobject *
739class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
740{
741 struct class_dir *dir;
43968d2f
GKH
742 int retval;
743
bc451f20
EB
744 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
745 if (!dir)
746 return NULL;
747
748 dir->class = class;
749 kobject_init(&dir->kobj, &class_dir_ktype);
750
6b6e39a6 751 dir->kobj.kset = &class->p->glue_dirs;
bc451f20
EB
752
753 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
754 if (retval < 0) {
755 kobject_put(&dir->kobj);
756 return NULL;
757 }
758 return &dir->kobj;
759}
760
761
762static struct kobject *get_device_parent(struct device *dev,
763 struct device *parent)
764{
86406245 765 if (dev->class) {
77d3d7c1 766 static DEFINE_MUTEX(gdp_mutex);
86406245
KS
767 struct kobject *kobj = NULL;
768 struct kobject *parent_kobj;
769 struct kobject *k;
770
ead454fe 771#ifdef CONFIG_BLOCK
39aba963 772 /* block disks show up in /sys/block */
e52eec13 773 if (sysfs_deprecated && dev->class == &block_class) {
39aba963
KS
774 if (parent && parent->class == &block_class)
775 return &parent->kobj;
6b6e39a6 776 return &block_class.p->subsys.kobj;
39aba963 777 }
ead454fe 778#endif
e52eec13 779
86406245
KS
780 /*
781 * If we have no parent, we live in "virtual".
0f4dafc0
KS
782 * Class-devices with a non class-device as parent, live
783 * in a "glue" directory to prevent namespace collisions.
86406245
KS
784 */
785 if (parent == NULL)
786 parent_kobj = virtual_device_parent(dev);
24b1442d 787 else if (parent->class && !dev->class->ns_type)
86406245
KS
788 return &parent->kobj;
789 else
790 parent_kobj = &parent->kobj;
791
77d3d7c1
TH
792 mutex_lock(&gdp_mutex);
793
86406245 794 /* find our class-directory at the parent and reference it */
6b6e39a6
KS
795 spin_lock(&dev->class->p->glue_dirs.list_lock);
796 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
86406245
KS
797 if (k->parent == parent_kobj) {
798 kobj = kobject_get(k);
799 break;
800 }
6b6e39a6 801 spin_unlock(&dev->class->p->glue_dirs.list_lock);
77d3d7c1
TH
802 if (kobj) {
803 mutex_unlock(&gdp_mutex);
86406245 804 return kobj;
77d3d7c1 805 }
86406245
KS
806
807 /* or create a new class-directory at the parent device */
bc451f20 808 k = class_dir_create_and_add(dev->class, parent_kobj);
0f4dafc0 809 /* do not emit an uevent for this simple "glue" directory */
77d3d7c1 810 mutex_unlock(&gdp_mutex);
43968d2f 811 return k;
86406245
KS
812 }
813
ca22e56d
KS
814 /* subsystems can specify a default root directory for their devices */
815 if (!parent && dev->bus && dev->bus->dev_root)
816 return &dev->bus->dev_root->kobj;
817
86406245 818 if (parent)
c744aeae
CH
819 return &parent->kobj;
820 return NULL;
821}
da231fd5 822
63b6971a 823static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
da231fd5 824{
0f4dafc0 825 /* see if we live in a "glue" directory */
c1fe539a 826 if (!glue_dir || !dev->class ||
6b6e39a6 827 glue_dir->kset != &dev->class->p->glue_dirs)
da231fd5
KS
828 return;
829
0f4dafc0 830 kobject_put(glue_dir);
da231fd5 831}
63b6971a
CH
832
833static void cleanup_device_parent(struct device *dev)
834{
835 cleanup_glue_dir(dev, dev->kobj.parent);
836}
86406245 837
2ee97caf
CH
838static int device_add_class_symlinks(struct device *dev)
839{
840 int error;
841
842 if (!dev->class)
843 return 0;
da231fd5 844
1fbfee6c 845 error = sysfs_create_link(&dev->kobj,
6b6e39a6 846 &dev->class->p->subsys.kobj,
2ee97caf
CH
847 "subsystem");
848 if (error)
849 goto out;
da231fd5 850
4e886c29 851 if (dev->parent && device_is_not_partition(dev)) {
39aba963 852 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
4f01a757
DT
853 "device");
854 if (error)
39aba963 855 goto out_subsys;
2ee97caf 856 }
2ee97caf 857
ead454fe 858#ifdef CONFIG_BLOCK
39aba963 859 /* /sys/block has directories and does not need symlinks */
e52eec13 860 if (sysfs_deprecated && dev->class == &block_class)
39aba963 861 return 0;
ead454fe 862#endif
39aba963 863
da231fd5 864 /* link in the class directory pointing to the device */
6b6e39a6 865 error = sysfs_create_link(&dev->class->p->subsys.kobj,
1e0b2cf9 866 &dev->kobj, dev_name(dev));
da231fd5 867 if (error)
39aba963 868 goto out_device;
da231fd5 869
da231fd5
KS
870 return 0;
871
39aba963
KS
872out_device:
873 sysfs_remove_link(&dev->kobj, "device");
da231fd5 874
2ee97caf
CH
875out_subsys:
876 sysfs_remove_link(&dev->kobj, "subsystem");
877out:
878 return error;
879}
880
881static void device_remove_class_symlinks(struct device *dev)
882{
883 if (!dev->class)
884 return;
da231fd5 885
4e886c29 886 if (dev->parent && device_is_not_partition(dev))
da231fd5 887 sysfs_remove_link(&dev->kobj, "device");
2ee97caf 888 sysfs_remove_link(&dev->kobj, "subsystem");
ead454fe 889#ifdef CONFIG_BLOCK
e52eec13 890 if (sysfs_deprecated && dev->class == &block_class)
39aba963 891 return;
ead454fe 892#endif
6b6e39a6 893 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
2ee97caf
CH
894}
895
413c239f
SR
896/**
897 * dev_set_name - set a device name
898 * @dev: device
46232366 899 * @fmt: format string for the device's name
413c239f
SR
900 */
901int dev_set_name(struct device *dev, const char *fmt, ...)
902{
903 va_list vargs;
1fa5ae85 904 int err;
413c239f
SR
905
906 va_start(vargs, fmt);
1fa5ae85 907 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
413c239f 908 va_end(vargs);
1fa5ae85 909 return err;
413c239f
SR
910}
911EXPORT_SYMBOL_GPL(dev_set_name);
912
e105b8bf
DW
913/**
914 * device_to_dev_kobj - select a /sys/dev/ directory for the device
915 * @dev: device
916 *
917 * By default we select char/ for new entries. Setting class->dev_obj
918 * to NULL prevents an entry from being created. class->dev_kobj must
919 * be set (or cleared) before any devices are registered to the class
920 * otherwise device_create_sys_dev_entry() and
0d4e293c
PK
921 * device_remove_sys_dev_entry() will disagree about the presence of
922 * the link.
e105b8bf
DW
923 */
924static struct kobject *device_to_dev_kobj(struct device *dev)
925{
926 struct kobject *kobj;
927
928 if (dev->class)
929 kobj = dev->class->dev_kobj;
930 else
931 kobj = sysfs_dev_char_kobj;
932
933 return kobj;
934}
935
936static int device_create_sys_dev_entry(struct device *dev)
937{
938 struct kobject *kobj = device_to_dev_kobj(dev);
939 int error = 0;
940 char devt_str[15];
941
942 if (kobj) {
943 format_dev_t(devt_str, dev->devt);
944 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
945 }
946
947 return error;
948}
949
950static void device_remove_sys_dev_entry(struct device *dev)
951{
952 struct kobject *kobj = device_to_dev_kobj(dev);
953 char devt_str[15];
954
955 if (kobj) {
956 format_dev_t(devt_str, dev->devt);
957 sysfs_remove_link(kobj, devt_str);
958 }
959}
960
b4028437
GKH
961int device_private_init(struct device *dev)
962{
963 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
964 if (!dev->p)
965 return -ENOMEM;
966 dev->p->device = dev;
967 klist_init(&dev->p->klist_children, klist_children_get,
968 klist_children_put);
ef8a3fd6 969 INIT_LIST_HEAD(&dev->p->deferred_probe);
b4028437
GKH
970 return 0;
971}
972
1da177e4 973/**
4a3ad20c
GKH
974 * device_add - add device to device hierarchy.
975 * @dev: device.
1da177e4 976 *
4a3ad20c
GKH
977 * This is part 2 of device_register(), though may be called
978 * separately _iff_ device_initialize() has been called separately.
1da177e4 979 *
5739411a 980 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
4a3ad20c
GKH
981 * to the global and sibling lists for the device, then
982 * adds it to the other relevant subsystems of the driver model.
5739411a 983 *
b10d5efd
AS
984 * Do not call this routine or device_register() more than once for
985 * any device structure. The driver model core is not designed to work
986 * with devices that get unregistered and then spring back to life.
987 * (Among other things, it's very hard to guarantee that all references
988 * to the previous incarnation of @dev have been dropped.) Allocate
989 * and register a fresh new struct device instead.
990 *
5739411a
CH
991 * NOTE: _Never_ directly free @dev after calling this function, even
992 * if it returned an error! Always use put_device() to give up your
993 * reference instead.
1da177e4
LT
994 */
995int device_add(struct device *dev)
996{
997 struct device *parent = NULL;
ca22e56d 998 struct kobject *kobj;
c47ed219 999 struct class_interface *class_intf;
c906a48a 1000 int error = -EINVAL;
775b64d2 1001
1da177e4 1002 dev = get_device(dev);
c906a48a
GKH
1003 if (!dev)
1004 goto done;
1005
fb069a5d 1006 if (!dev->p) {
b4028437
GKH
1007 error = device_private_init(dev);
1008 if (error)
1009 goto done;
fb069a5d 1010 }
fb069a5d 1011
1fa5ae85
KS
1012 /*
1013 * for statically allocated devices, which should all be converted
1014 * some day, we need to initialize the name. We prevent reading back
1015 * the name, and force the use of dev_name()
1016 */
1017 if (dev->init_name) {
acc0e90f 1018 dev_set_name(dev, "%s", dev->init_name);
1fa5ae85
KS
1019 dev->init_name = NULL;
1020 }
c906a48a 1021
ca22e56d
KS
1022 /* subsystems can specify simple device enumeration */
1023 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1024 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1025
e6309e75
TG
1026 if (!dev_name(dev)) {
1027 error = -EINVAL;
5c8563d7 1028 goto name_error;
e6309e75 1029 }
1da177e4 1030
1e0b2cf9 1031 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
c205ef48 1032
1da177e4 1033 parent = get_device(dev->parent);
ca22e56d
KS
1034 kobj = get_device_parent(dev, parent);
1035 if (kobj)
1036 dev->kobj.parent = kobj;
1da177e4 1037
0d358f22
YL
1038 /* use parent numa_node */
1039 if (parent)
1040 set_dev_node(dev, dev_to_node(parent));
1041
1da177e4 1042 /* first, register with generic layer. */
8a577ffc
KS
1043 /* we require the name to be set before, and pass NULL */
1044 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
40fa5422 1045 if (error)
1da177e4 1046 goto Error;
a7fd6706 1047
37022644
BW
1048 /* notify platform of device entry */
1049 if (platform_notify)
1050 platform_notify(dev);
1051
c5e064a6 1052 error = device_create_file(dev, &dev_attr_uevent);
a306eea4
CH
1053 if (error)
1054 goto attrError;
a7fd6706 1055
23681e47 1056 if (MAJOR(dev->devt)) {
c5e064a6 1057 error = device_create_file(dev, &dev_attr_dev);
ad6a1e1c 1058 if (error)
a306eea4 1059 goto ueventattrError;
e105b8bf
DW
1060
1061 error = device_create_sys_dev_entry(dev);
1062 if (error)
1063 goto devtattrError;
2b2af54a
KS
1064
1065 devtmpfs_create_node(dev);
23681e47
GKH
1066 }
1067
2ee97caf
CH
1068 error = device_add_class_symlinks(dev);
1069 if (error)
1070 goto SymlinkError;
dc0afa83
CH
1071 error = device_add_attrs(dev);
1072 if (error)
2620efef 1073 goto AttrsError;
dc0afa83
CH
1074 error = bus_add_device(dev);
1075 if (error)
1da177e4 1076 goto BusError;
3b98aeaf 1077 error = dpm_sysfs_add(dev);
57eee3d2 1078 if (error)
3b98aeaf
AS
1079 goto DPMError;
1080 device_pm_add(dev);
ec0676ee
AS
1081
1082 /* Notify clients of device addition. This call must come
268863f4 1083 * after dpm_sysfs_add() and before kobject_uevent().
ec0676ee
AS
1084 */
1085 if (dev->bus)
1086 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1087 BUS_NOTIFY_ADD_DEVICE, dev);
1088
83b5fb4c 1089 kobject_uevent(&dev->kobj, KOBJ_ADD);
2023c610 1090 bus_probe_device(dev);
1da177e4 1091 if (parent)
f791b8c8
GKH
1092 klist_add_tail(&dev->p->knode_parent,
1093 &parent->p->klist_children);
1da177e4 1094
5d9fd169 1095 if (dev->class) {
ca22e56d 1096 mutex_lock(&dev->class->p->mutex);
c47ed219 1097 /* tie the class to the device */
5a3ceb86 1098 klist_add_tail(&dev->knode_class,
6b6e39a6 1099 &dev->class->p->klist_devices);
c47ed219
GKH
1100
1101 /* notify any interfaces that the device is here */
184f1f77 1102 list_for_each_entry(class_intf,
ca22e56d 1103 &dev->class->p->interfaces, node)
c47ed219
GKH
1104 if (class_intf->add_dev)
1105 class_intf->add_dev(dev, class_intf);
ca22e56d 1106 mutex_unlock(&dev->class->p->mutex);
5d9fd169 1107 }
c906a48a 1108done:
1da177e4
LT
1109 put_device(dev);
1110 return error;
3b98aeaf 1111 DPMError:
57eee3d2
RW
1112 bus_remove_device(dev);
1113 BusError:
82f0cf9b 1114 device_remove_attrs(dev);
2620efef 1115 AttrsError:
2ee97caf
CH
1116 device_remove_class_symlinks(dev);
1117 SymlinkError:
ad72956d
KS
1118 if (MAJOR(dev->devt))
1119 devtmpfs_delete_node(dev);
e105b8bf
DW
1120 if (MAJOR(dev->devt))
1121 device_remove_sys_dev_entry(dev);
1122 devtattrError:
ad6a1e1c 1123 if (MAJOR(dev->devt))
c5e064a6 1124 device_remove_file(dev, &dev_attr_dev);
a306eea4 1125 ueventattrError:
c5e064a6 1126 device_remove_file(dev, &dev_attr_uevent);
23681e47 1127 attrError:
312c004d 1128 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1da177e4
LT
1129 kobject_del(&dev->kobj);
1130 Error:
63b6971a 1131 cleanup_device_parent(dev);
1da177e4
LT
1132 if (parent)
1133 put_device(parent);
5c8563d7
KS
1134name_error:
1135 kfree(dev->p);
1136 dev->p = NULL;
c906a48a 1137 goto done;
1da177e4 1138}
86df2687 1139EXPORT_SYMBOL_GPL(device_add);
1da177e4 1140
1da177e4 1141/**
4a3ad20c
GKH
1142 * device_register - register a device with the system.
1143 * @dev: pointer to the device structure
1da177e4 1144 *
4a3ad20c
GKH
1145 * This happens in two clean steps - initialize the device
1146 * and add it to the system. The two steps can be called
1147 * separately, but this is the easiest and most common.
1148 * I.e. you should only call the two helpers separately if
1149 * have a clearly defined need to use and refcount the device
1150 * before it is added to the hierarchy.
5739411a 1151 *
b10d5efd
AS
1152 * For more information, see the kerneldoc for device_initialize()
1153 * and device_add().
1154 *
5739411a
CH
1155 * NOTE: _Never_ directly free @dev after calling this function, even
1156 * if it returned an error! Always use put_device() to give up the
1157 * reference initialized in this function instead.
1da177e4 1158 */
1da177e4
LT
1159int device_register(struct device *dev)
1160{
1161 device_initialize(dev);
1162 return device_add(dev);
1163}
86df2687 1164EXPORT_SYMBOL_GPL(device_register);
1da177e4 1165
1da177e4 1166/**
4a3ad20c
GKH
1167 * get_device - increment reference count for device.
1168 * @dev: device.
1da177e4 1169 *
4a3ad20c
GKH
1170 * This simply forwards the call to kobject_get(), though
1171 * we do take care to provide for the case that we get a NULL
1172 * pointer passed in.
1da177e4 1173 */
4a3ad20c 1174struct device *get_device(struct device *dev)
1da177e4 1175{
b0d1f807 1176 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1da177e4 1177}
86df2687 1178EXPORT_SYMBOL_GPL(get_device);
1da177e4 1179
1da177e4 1180/**
4a3ad20c
GKH
1181 * put_device - decrement reference count.
1182 * @dev: device in question.
1da177e4 1183 */
4a3ad20c 1184void put_device(struct device *dev)
1da177e4 1185{
edfaa7c3 1186 /* might_sleep(); */
1da177e4
LT
1187 if (dev)
1188 kobject_put(&dev->kobj);
1189}
86df2687 1190EXPORT_SYMBOL_GPL(put_device);
1da177e4 1191
1da177e4 1192/**
4a3ad20c
GKH
1193 * device_del - delete device from system.
1194 * @dev: device.
1da177e4 1195 *
4a3ad20c
GKH
1196 * This is the first part of the device unregistration
1197 * sequence. This removes the device from the lists we control
1198 * from here, has it removed from the other driver model
1199 * subsystems it was added to in device_add(), and removes it
1200 * from the kobject hierarchy.
1da177e4 1201 *
4a3ad20c
GKH
1202 * NOTE: this should be called manually _iff_ device_add() was
1203 * also called manually.
1da177e4 1204 */
4a3ad20c 1205void device_del(struct device *dev)
1da177e4 1206{
4a3ad20c 1207 struct device *parent = dev->parent;
c47ed219 1208 struct class_interface *class_intf;
1da177e4 1209
ec0676ee
AS
1210 /* Notify clients of device removal. This call must come
1211 * before dpm_sysfs_remove().
1212 */
1213 if (dev->bus)
1214 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1215 BUS_NOTIFY_DEL_DEVICE, dev);
3b98aeaf 1216 dpm_sysfs_remove(dev);
1da177e4 1217 if (parent)
f791b8c8 1218 klist_del(&dev->p->knode_parent);
e105b8bf 1219 if (MAJOR(dev->devt)) {
2b2af54a 1220 devtmpfs_delete_node(dev);
e105b8bf 1221 device_remove_sys_dev_entry(dev);
c5e064a6 1222 device_remove_file(dev, &dev_attr_dev);
e105b8bf 1223 }
b9d9c82b 1224 if (dev->class) {
da231fd5 1225 device_remove_class_symlinks(dev);
99ef3ef8 1226
ca22e56d 1227 mutex_lock(&dev->class->p->mutex);
c47ed219 1228 /* notify any interfaces that the device is now gone */
184f1f77 1229 list_for_each_entry(class_intf,
ca22e56d 1230 &dev->class->p->interfaces, node)
c47ed219
GKH
1231 if (class_intf->remove_dev)
1232 class_intf->remove_dev(dev, class_intf);
1233 /* remove the device from the class list */
5a3ceb86 1234 klist_del(&dev->knode_class);
ca22e56d 1235 mutex_unlock(&dev->class->p->mutex);
b9d9c82b 1236 }
c5e064a6 1237 device_remove_file(dev, &dev_attr_uevent);
2620efef 1238 device_remove_attrs(dev);
28953533 1239 bus_remove_device(dev);
4b6d1f12 1240 device_pm_remove(dev);
d1c3414c 1241 driver_deferred_probe_del(dev);
1da177e4
LT
1242
1243 /* Notify the platform of the removal, in case they
1244 * need to do anything...
1245 */
1246 if (platform_notify_remove)
1247 platform_notify_remove(dev);
312c004d 1248 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
da231fd5 1249 cleanup_device_parent(dev);
1da177e4 1250 kobject_del(&dev->kobj);
da231fd5 1251 put_device(parent);
1da177e4 1252}
86df2687 1253EXPORT_SYMBOL_GPL(device_del);
1da177e4
LT
1254
1255/**
4a3ad20c
GKH
1256 * device_unregister - unregister device from system.
1257 * @dev: device going away.
1da177e4 1258 *
4a3ad20c
GKH
1259 * We do this in two parts, like we do device_register(). First,
1260 * we remove it from all the subsystems with device_del(), then
1261 * we decrement the reference count via put_device(). If that
1262 * is the final reference count, the device will be cleaned up
1263 * via device_release() above. Otherwise, the structure will
1264 * stick around until the final reference to the device is dropped.
1da177e4 1265 */
4a3ad20c 1266void device_unregister(struct device *dev)
1da177e4 1267{
1e0b2cf9 1268 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1da177e4
LT
1269 device_del(dev);
1270 put_device(dev);
1271}
86df2687 1272EXPORT_SYMBOL_GPL(device_unregister);
1da177e4 1273
4a3ad20c 1274static struct device *next_device(struct klist_iter *i)
36239577 1275{
4a3ad20c 1276 struct klist_node *n = klist_next(i);
f791b8c8
GKH
1277 struct device *dev = NULL;
1278 struct device_private *p;
1279
1280 if (n) {
1281 p = to_device_private_parent(n);
1282 dev = p->device;
1283 }
1284 return dev;
36239577 1285}
1286
6fcf53ac 1287/**
e454cea2 1288 * device_get_devnode - path of device node file
6fcf53ac 1289 * @dev: device
e454cea2 1290 * @mode: returned file access mode
3c2670e6
KS
1291 * @uid: returned file owner
1292 * @gid: returned file group
6fcf53ac
KS
1293 * @tmp: possibly allocated string
1294 *
1295 * Return the relative path of a possible device node.
1296 * Non-default names may need to allocate a memory to compose
1297 * a name. This memory is returned in tmp and needs to be
1298 * freed by the caller.
1299 */
e454cea2 1300const char *device_get_devnode(struct device *dev,
4e4098a3 1301 umode_t *mode, kuid_t *uid, kgid_t *gid,
3c2670e6 1302 const char **tmp)
6fcf53ac
KS
1303{
1304 char *s;
1305
1306 *tmp = NULL;
1307
1308 /* the device type may provide a specific name */
e454cea2 1309 if (dev->type && dev->type->devnode)
3c2670e6 1310 *tmp = dev->type->devnode(dev, mode, uid, gid);
6fcf53ac
KS
1311 if (*tmp)
1312 return *tmp;
1313
1314 /* the class may provide a specific name */
e454cea2
KS
1315 if (dev->class && dev->class->devnode)
1316 *tmp = dev->class->devnode(dev, mode);
6fcf53ac
KS
1317 if (*tmp)
1318 return *tmp;
1319
1320 /* return name without allocation, tmp == NULL */
1321 if (strchr(dev_name(dev), '!') == NULL)
1322 return dev_name(dev);
1323
1324 /* replace '!' in the name with '/' */
1325 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1326 if (!*tmp)
1327 return NULL;
1328 while ((s = strchr(*tmp, '!')))
1329 s[0] = '/';
1330 return *tmp;
1331}
1332
1da177e4 1333/**
4a3ad20c
GKH
1334 * device_for_each_child - device child iterator.
1335 * @parent: parent struct device.
4a3ad20c 1336 * @fn: function to be called for each device.
f8878dcb 1337 * @data: data for the callback.
1da177e4 1338 *
4a3ad20c
GKH
1339 * Iterate over @parent's child devices, and call @fn for each,
1340 * passing it @data.
1da177e4 1341 *
4a3ad20c
GKH
1342 * We check the return of @fn each time. If it returns anything
1343 * other than 0, we break out and return that value.
1da177e4 1344 */
4a3ad20c
GKH
1345int device_for_each_child(struct device *parent, void *data,
1346 int (*fn)(struct device *dev, void *data))
1da177e4 1347{
36239577 1348 struct klist_iter i;
4a3ad20c 1349 struct device *child;
1da177e4
LT
1350 int error = 0;
1351
014c90db
GKH
1352 if (!parent->p)
1353 return 0;
1354
f791b8c8 1355 klist_iter_init(&parent->p->klist_children, &i);
36239577 1356 while ((child = next_device(&i)) && !error)
1357 error = fn(child, data);
1358 klist_iter_exit(&i);
1da177e4
LT
1359 return error;
1360}
86df2687 1361EXPORT_SYMBOL_GPL(device_for_each_child);
1da177e4 1362
5ab69981
CH
1363/**
1364 * device_find_child - device iterator for locating a particular device.
1365 * @parent: parent struct device
5ab69981 1366 * @match: Callback function to check device
f8878dcb 1367 * @data: Data to pass to match function
5ab69981
CH
1368 *
1369 * This is similar to the device_for_each_child() function above, but it
1370 * returns a reference to a device that is 'found' for later use, as
1371 * determined by the @match callback.
1372 *
1373 * The callback should return 0 if the device doesn't match and non-zero
1374 * if it does. If the callback returns non-zero and a reference to the
1375 * current device can be obtained, this function will return to the caller
1376 * and not iterate over any more devices.
a4e2400a
FV
1377 *
1378 * NOTE: you will need to drop the reference with put_device() after use.
5ab69981 1379 */
4a3ad20c
GKH
1380struct device *device_find_child(struct device *parent, void *data,
1381 int (*match)(struct device *dev, void *data))
5ab69981
CH
1382{
1383 struct klist_iter i;
1384 struct device *child;
1385
1386 if (!parent)
1387 return NULL;
1388
f791b8c8 1389 klist_iter_init(&parent->p->klist_children, &i);
5ab69981
CH
1390 while ((child = next_device(&i)))
1391 if (match(child, data) && get_device(child))
1392 break;
1393 klist_iter_exit(&i);
1394 return child;
1395}
86df2687 1396EXPORT_SYMBOL_GPL(device_find_child);
5ab69981 1397
1da177e4
LT
1398int __init devices_init(void)
1399{
881c6cfd
GKH
1400 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1401 if (!devices_kset)
1402 return -ENOMEM;
e105b8bf
DW
1403 dev_kobj = kobject_create_and_add("dev", NULL);
1404 if (!dev_kobj)
1405 goto dev_kobj_err;
1406 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1407 if (!sysfs_dev_block_kobj)
1408 goto block_kobj_err;
1409 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1410 if (!sysfs_dev_char_kobj)
1411 goto char_kobj_err;
1412
881c6cfd 1413 return 0;
e105b8bf
DW
1414
1415 char_kobj_err:
1416 kobject_put(sysfs_dev_block_kobj);
1417 block_kobj_err:
1418 kobject_put(dev_kobj);
1419 dev_kobj_err:
1420 kset_unregister(devices_kset);
1421 return -ENOMEM;
1da177e4
LT
1422}
1423
4f3549d7
RW
1424static int device_check_offline(struct device *dev, void *not_used)
1425{
1426 int ret;
1427
1428 ret = device_for_each_child(dev, NULL, device_check_offline);
1429 if (ret)
1430 return ret;
1431
1432 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1433}
1434
1435/**
1436 * device_offline - Prepare the device for hot-removal.
1437 * @dev: Device to be put offline.
1438 *
1439 * Execute the device bus type's .offline() callback, if present, to prepare
1440 * the device for a subsequent hot-removal. If that succeeds, the device must
1441 * not be used until either it is removed or its bus type's .online() callback
1442 * is executed.
1443 *
1444 * Call under device_hotplug_lock.
1445 */
1446int device_offline(struct device *dev)
1447{
1448 int ret;
1449
1450 if (dev->offline_disabled)
1451 return -EPERM;
1452
1453 ret = device_for_each_child(dev, NULL, device_check_offline);
1454 if (ret)
1455 return ret;
1456
1457 device_lock(dev);
1458 if (device_supports_offline(dev)) {
1459 if (dev->offline) {
1460 ret = 1;
1461 } else {
1462 ret = dev->bus->offline(dev);
1463 if (!ret) {
1464 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1465 dev->offline = true;
1466 }
1467 }
1468 }
1469 device_unlock(dev);
1470
1471 return ret;
1472}
1473
1474/**
1475 * device_online - Put the device back online after successful device_offline().
1476 * @dev: Device to be put back online.
1477 *
1478 * If device_offline() has been successfully executed for @dev, but the device
1479 * has not been removed subsequently, execute its bus type's .online() callback
1480 * to indicate that the device can be used again.
1481 *
1482 * Call under device_hotplug_lock.
1483 */
1484int device_online(struct device *dev)
1485{
1486 int ret = 0;
1487
1488 device_lock(dev);
1489 if (device_supports_offline(dev)) {
1490 if (dev->offline) {
1491 ret = dev->bus->online(dev);
1492 if (!ret) {
1493 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1494 dev->offline = false;
1495 }
1496 } else {
1497 ret = 1;
1498 }
1499 }
1500 device_unlock(dev);
1501
1502 return ret;
1503}
1504
7f100d15 1505struct root_device {
0aa0dc41
MM
1506 struct device dev;
1507 struct module *owner;
1508};
1509
93058424 1510static inline struct root_device *to_root_device(struct device *d)
481e2079
FW
1511{
1512 return container_of(d, struct root_device, dev);
1513}
0aa0dc41
MM
1514
1515static void root_device_release(struct device *dev)
1516{
1517 kfree(to_root_device(dev));
1518}
1519
1520/**
1521 * __root_device_register - allocate and register a root device
1522 * @name: root device name
1523 * @owner: owner module of the root device, usually THIS_MODULE
1524 *
1525 * This function allocates a root device and registers it
1526 * using device_register(). In order to free the returned
1527 * device, use root_device_unregister().
1528 *
1529 * Root devices are dummy devices which allow other devices
1530 * to be grouped under /sys/devices. Use this function to
1531 * allocate a root device and then use it as the parent of
1532 * any device which should appear under /sys/devices/{name}
1533 *
1534 * The /sys/devices/{name} directory will also contain a
1535 * 'module' symlink which points to the @owner directory
1536 * in sysfs.
1537 *
f0eae0ed
JN
1538 * Returns &struct device pointer on success, or ERR_PTR() on error.
1539 *
0aa0dc41
MM
1540 * Note: You probably want to use root_device_register().
1541 */
1542struct device *__root_device_register(const char *name, struct module *owner)
1543{
1544 struct root_device *root;
1545 int err = -ENOMEM;
1546
1547 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1548 if (!root)
1549 return ERR_PTR(err);
1550
acc0e90f 1551 err = dev_set_name(&root->dev, "%s", name);
0aa0dc41
MM
1552 if (err) {
1553 kfree(root);
1554 return ERR_PTR(err);
1555 }
1556
1557 root->dev.release = root_device_release;
1558
1559 err = device_register(&root->dev);
1560 if (err) {
1561 put_device(&root->dev);
1562 return ERR_PTR(err);
1563 }
1564
1d9e882b 1565#ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
0aa0dc41
MM
1566 if (owner) {
1567 struct module_kobject *mk = &owner->mkobj;
1568
1569 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1570 if (err) {
1571 device_unregister(&root->dev);
1572 return ERR_PTR(err);
1573 }
1574 root->owner = owner;
1575 }
1576#endif
1577
1578 return &root->dev;
1579}
1580EXPORT_SYMBOL_GPL(__root_device_register);
1581
1582/**
1583 * root_device_unregister - unregister and free a root device
7cbcf225 1584 * @dev: device going away
0aa0dc41
MM
1585 *
1586 * This function unregisters and cleans up a device that was created by
1587 * root_device_register().
1588 */
1589void root_device_unregister(struct device *dev)
1590{
1591 struct root_device *root = to_root_device(dev);
1592
1593 if (root->owner)
1594 sysfs_remove_link(&root->dev.kobj, "module");
1595
1596 device_unregister(dev);
1597}
1598EXPORT_SYMBOL_GPL(root_device_unregister);
1599
23681e47
GKH
1600
1601static void device_create_release(struct device *dev)
1602{
1e0b2cf9 1603 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
23681e47
GKH
1604 kfree(dev);
1605}
1606
39ef3112
GR
1607static struct device *
1608device_create_groups_vargs(struct class *class, struct device *parent,
1609 dev_t devt, void *drvdata,
1610 const struct attribute_group **groups,
1611 const char *fmt, va_list args)
23681e47 1612{
23681e47
GKH
1613 struct device *dev = NULL;
1614 int retval = -ENODEV;
1615
1616 if (class == NULL || IS_ERR(class))
1617 goto error;
23681e47
GKH
1618
1619 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1620 if (!dev) {
1621 retval = -ENOMEM;
1622 goto error;
1623 }
1624
bbc780f8 1625 device_initialize(dev);
23681e47
GKH
1626 dev->devt = devt;
1627 dev->class = class;
1628 dev->parent = parent;
39ef3112 1629 dev->groups = groups;
23681e47 1630 dev->release = device_create_release;
8882b394 1631 dev_set_drvdata(dev, drvdata);
23681e47 1632
1fa5ae85
KS
1633 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1634 if (retval)
1635 goto error;
1636
bbc780f8 1637 retval = device_add(dev);
23681e47
GKH
1638 if (retval)
1639 goto error;
1640
23681e47
GKH
1641 return dev;
1642
1643error:
286661b3 1644 put_device(dev);
23681e47
GKH
1645 return ERR_PTR(retval);
1646}
39ef3112
GR
1647
1648/**
1649 * device_create_vargs - creates a device and registers it with sysfs
1650 * @class: pointer to the struct class that this device should be registered to
1651 * @parent: pointer to the parent struct device of this new device, if any
1652 * @devt: the dev_t for the char device to be added
1653 * @drvdata: the data to be added to the device for callbacks
1654 * @fmt: string for the device's name
1655 * @args: va_list for the device's name
1656 *
1657 * This function can be used by char device classes. A struct device
1658 * will be created in sysfs, registered to the specified class.
1659 *
1660 * A "dev" file will be created, showing the dev_t for the device, if
1661 * the dev_t is not 0,0.
1662 * If a pointer to a parent struct device is passed in, the newly created
1663 * struct device will be a child of that device in sysfs.
1664 * The pointer to the struct device will be returned from the call.
1665 * Any further sysfs files that might be required can be created using this
1666 * pointer.
1667 *
1668 * Returns &struct device pointer on success, or ERR_PTR() on error.
1669 *
1670 * Note: the struct class passed to this function must have previously
1671 * been created with a call to class_create().
1672 */
1673struct device *device_create_vargs(struct class *class, struct device *parent,
1674 dev_t devt, void *drvdata, const char *fmt,
1675 va_list args)
1676{
1677 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1678 fmt, args);
1679}
8882b394
GKH
1680EXPORT_SYMBOL_GPL(device_create_vargs);
1681
1682/**
4e106739 1683 * device_create - creates a device and registers it with sysfs
8882b394
GKH
1684 * @class: pointer to the struct class that this device should be registered to
1685 * @parent: pointer to the parent struct device of this new device, if any
1686 * @devt: the dev_t for the char device to be added
1687 * @drvdata: the data to be added to the device for callbacks
1688 * @fmt: string for the device's name
1689 *
1690 * This function can be used by char device classes. A struct device
1691 * will be created in sysfs, registered to the specified class.
1692 *
1693 * A "dev" file will be created, showing the dev_t for the device, if
1694 * the dev_t is not 0,0.
1695 * If a pointer to a parent struct device is passed in, the newly created
1696 * struct device will be a child of that device in sysfs.
1697 * The pointer to the struct device will be returned from the call.
1698 * Any further sysfs files that might be required can be created using this
1699 * pointer.
1700 *
f0eae0ed
JN
1701 * Returns &struct device pointer on success, or ERR_PTR() on error.
1702 *
8882b394
GKH
1703 * Note: the struct class passed to this function must have previously
1704 * been created with a call to class_create().
1705 */
4e106739
GKH
1706struct device *device_create(struct class *class, struct device *parent,
1707 dev_t devt, void *drvdata, const char *fmt, ...)
8882b394
GKH
1708{
1709 va_list vargs;
1710 struct device *dev;
1711
1712 va_start(vargs, fmt);
1713 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1714 va_end(vargs);
1715 return dev;
1716}
4e106739 1717EXPORT_SYMBOL_GPL(device_create);
8882b394 1718
39ef3112
GR
1719/**
1720 * device_create_with_groups - creates a device and registers it with sysfs
1721 * @class: pointer to the struct class that this device should be registered to
1722 * @parent: pointer to the parent struct device of this new device, if any
1723 * @devt: the dev_t for the char device to be added
1724 * @drvdata: the data to be added to the device for callbacks
1725 * @groups: NULL-terminated list of attribute groups to be created
1726 * @fmt: string for the device's name
1727 *
1728 * This function can be used by char device classes. A struct device
1729 * will be created in sysfs, registered to the specified class.
1730 * Additional attributes specified in the groups parameter will also
1731 * be created automatically.
1732 *
1733 * A "dev" file will be created, showing the dev_t for the device, if
1734 * the dev_t is not 0,0.
1735 * If a pointer to a parent struct device is passed in, the newly created
1736 * struct device will be a child of that device in sysfs.
1737 * The pointer to the struct device will be returned from the call.
1738 * Any further sysfs files that might be required can be created using this
1739 * pointer.
1740 *
1741 * Returns &struct device pointer on success, or ERR_PTR() on error.
1742 *
1743 * Note: the struct class passed to this function must have previously
1744 * been created with a call to class_create().
1745 */
1746struct device *device_create_with_groups(struct class *class,
1747 struct device *parent, dev_t devt,
1748 void *drvdata,
1749 const struct attribute_group **groups,
1750 const char *fmt, ...)
1751{
1752 va_list vargs;
1753 struct device *dev;
1754
1755 va_start(vargs, fmt);
1756 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1757 fmt, vargs);
1758 va_end(vargs);
1759 return dev;
1760}
1761EXPORT_SYMBOL_GPL(device_create_with_groups);
1762
9f3b795a 1763static int __match_devt(struct device *dev, const void *data)
23681e47 1764{
9f3b795a 1765 const dev_t *devt = data;
23681e47 1766
cd35449b 1767 return dev->devt == *devt;
775b64d2
RW
1768}
1769
1770/**
1771 * device_destroy - removes a device that was created with device_create()
1772 * @class: pointer to the struct class that this device was registered with
1773 * @devt: the dev_t of the device that was previously registered
1774 *
1775 * This call unregisters and cleans up a device that was created with a
1776 * call to device_create().
1777 */
1778void device_destroy(struct class *class, dev_t devt)
1779{
1780 struct device *dev;
23681e47 1781
695794ae 1782 dev = class_find_device(class, NULL, &devt, __match_devt);
cd35449b
DY
1783 if (dev) {
1784 put_device(dev);
23681e47 1785 device_unregister(dev);
cd35449b 1786 }
23681e47
GKH
1787}
1788EXPORT_SYMBOL_GPL(device_destroy);
a2de48ca
GKH
1789
1790/**
1791 * device_rename - renames a device
1792 * @dev: the pointer to the struct device to be renamed
1793 * @new_name: the new name of the device
030c1d2b
EB
1794 *
1795 * It is the responsibility of the caller to provide mutual
1796 * exclusion between two different calls of device_rename
1797 * on the same device to ensure that new_name is valid and
1798 * won't conflict with other devices.
c6c0ac66 1799 *
a5462516
TT
1800 * Note: Don't call this function. Currently, the networking layer calls this
1801 * function, but that will change. The following text from Kay Sievers offers
1802 * some insight:
1803 *
1804 * Renaming devices is racy at many levels, symlinks and other stuff are not
1805 * replaced atomically, and you get a "move" uevent, but it's not easy to
1806 * connect the event to the old and new device. Device nodes are not renamed at
1807 * all, there isn't even support for that in the kernel now.
1808 *
1809 * In the meantime, during renaming, your target name might be taken by another
1810 * driver, creating conflicts. Or the old name is taken directly after you
1811 * renamed it -- then you get events for the same DEVPATH, before you even see
1812 * the "move" event. It's just a mess, and nothing new should ever rely on
1813 * kernel device renaming. Besides that, it's not even implemented now for
1814 * other things than (driver-core wise very simple) network devices.
1815 *
1816 * We are currently about to change network renaming in udev to completely
1817 * disallow renaming of devices in the same namespace as the kernel uses,
1818 * because we can't solve the problems properly, that arise with swapping names
1819 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1820 * be allowed to some other name than eth[0-9]*, for the aforementioned
1821 * reasons.
1822 *
1823 * Make up a "real" name in the driver before you register anything, or add
1824 * some other attributes for userspace to find the device, or use udev to add
1825 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1826 * don't even want to get into that and try to implement the missing pieces in
1827 * the core. We really have other pieces to fix in the driver core mess. :)
a2de48ca 1828 */
6937e8f8 1829int device_rename(struct device *dev, const char *new_name)
a2de48ca 1830{
4b30ee58 1831 struct kobject *kobj = &dev->kobj;
2ee97caf 1832 char *old_device_name = NULL;
a2de48ca
GKH
1833 int error;
1834
1835 dev = get_device(dev);
1836 if (!dev)
1837 return -EINVAL;
1838
69df7533 1839 dev_dbg(dev, "renaming to %s\n", new_name);
a2de48ca 1840
1fa5ae85 1841 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
2ee97caf
CH
1842 if (!old_device_name) {
1843 error = -ENOMEM;
1844 goto out;
a2de48ca 1845 }
a2de48ca 1846
f349cf34 1847 if (dev->class) {
4b30ee58
TH
1848 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1849 kobj, old_device_name,
1850 new_name, kobject_namespace(kobj));
f349cf34
EB
1851 if (error)
1852 goto out;
1853 }
39aba963 1854
4b30ee58 1855 error = kobject_rename(kobj, new_name);
1fa5ae85 1856 if (error)
2ee97caf 1857 goto out;
a2de48ca 1858
2ee97caf 1859out:
a2de48ca
GKH
1860 put_device(dev);
1861
2ee97caf 1862 kfree(old_device_name);
a2de48ca
GKH
1863
1864 return error;
1865}
a2807dbc 1866EXPORT_SYMBOL_GPL(device_rename);
8a82472f
CH
1867
1868static int device_move_class_links(struct device *dev,
1869 struct device *old_parent,
1870 struct device *new_parent)
1871{
f7f3461d 1872 int error = 0;
8a82472f 1873
f7f3461d
GKH
1874 if (old_parent)
1875 sysfs_remove_link(&dev->kobj, "device");
1876 if (new_parent)
1877 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1878 "device");
1879 return error;
8a82472f
CH
1880}
1881
1882/**
1883 * device_move - moves a device to a new parent
1884 * @dev: the pointer to the struct device to be moved
c744aeae 1885 * @new_parent: the new parent of the device (can by NULL)
ffa6a705 1886 * @dpm_order: how to reorder the dpm_list
8a82472f 1887 */
ffa6a705
CH
1888int device_move(struct device *dev, struct device *new_parent,
1889 enum dpm_order dpm_order)
8a82472f
CH
1890{
1891 int error;
1892 struct device *old_parent;
c744aeae 1893 struct kobject *new_parent_kobj;
8a82472f
CH
1894
1895 dev = get_device(dev);
1896 if (!dev)
1897 return -EINVAL;
1898
ffa6a705 1899 device_pm_lock();
8a82472f 1900 new_parent = get_device(new_parent);
4a3ad20c 1901 new_parent_kobj = get_device_parent(dev, new_parent);
63b6971a 1902
1e0b2cf9
KS
1903 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1904 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
c744aeae 1905 error = kobject_move(&dev->kobj, new_parent_kobj);
8a82472f 1906 if (error) {
63b6971a 1907 cleanup_glue_dir(dev, new_parent_kobj);
8a82472f
CH
1908 put_device(new_parent);
1909 goto out;
1910 }
1911 old_parent = dev->parent;
1912 dev->parent = new_parent;
1913 if (old_parent)
f791b8c8 1914 klist_remove(&dev->p->knode_parent);
0d358f22 1915 if (new_parent) {
f791b8c8
GKH
1916 klist_add_tail(&dev->p->knode_parent,
1917 &new_parent->p->klist_children);
0d358f22
YL
1918 set_dev_node(dev, dev_to_node(new_parent));
1919 }
1920
bdd4034d
RV
1921 if (dev->class) {
1922 error = device_move_class_links(dev, old_parent, new_parent);
1923 if (error) {
1924 /* We ignore errors on cleanup since we're hosed anyway... */
1925 device_move_class_links(dev, new_parent, old_parent);
1926 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1927 if (new_parent)
1928 klist_remove(&dev->p->knode_parent);
1929 dev->parent = old_parent;
1930 if (old_parent) {
1931 klist_add_tail(&dev->p->knode_parent,
1932 &old_parent->p->klist_children);
1933 set_dev_node(dev, dev_to_node(old_parent));
1934 }
0d358f22 1935 }
bdd4034d
RV
1936 cleanup_glue_dir(dev, new_parent_kobj);
1937 put_device(new_parent);
1938 goto out;
8a82472f 1939 }
8a82472f 1940 }
ffa6a705
CH
1941 switch (dpm_order) {
1942 case DPM_ORDER_NONE:
1943 break;
1944 case DPM_ORDER_DEV_AFTER_PARENT:
1945 device_pm_move_after(dev, new_parent);
1946 break;
1947 case DPM_ORDER_PARENT_BEFORE_DEV:
1948 device_pm_move_before(new_parent, dev);
1949 break;
1950 case DPM_ORDER_DEV_LAST:
1951 device_pm_move_last(dev);
1952 break;
1953 }
bdd4034d 1954
8a82472f
CH
1955 put_device(old_parent);
1956out:
ffa6a705 1957 device_pm_unlock();
8a82472f
CH
1958 put_device(dev);
1959 return error;
1960}
8a82472f 1961EXPORT_SYMBOL_GPL(device_move);
37b0c020
GKH
1962
1963/**
1964 * device_shutdown - call ->shutdown() on each device to shutdown.
1965 */
1966void device_shutdown(void)
1967{
f123db8e 1968 struct device *dev, *parent;
6245838f
HD
1969
1970 spin_lock(&devices_kset->list_lock);
1971 /*
1972 * Walk the devices list backward, shutting down each in turn.
1973 * Beware that device unplug events may also start pulling
1974 * devices offline, even as the system is shutting down.
1975 */
1976 while (!list_empty(&devices_kset->list)) {
1977 dev = list_entry(devices_kset->list.prev, struct device,
1978 kobj.entry);
d1c6c030
ML
1979
1980 /*
1981 * hold reference count of device's parent to
1982 * prevent it from being freed because parent's
1983 * lock is to be held
1984 */
f123db8e 1985 parent = get_device(dev->parent);
6245838f
HD
1986 get_device(dev);
1987 /*
1988 * Make sure the device is off the kset list, in the
1989 * event that dev->*->shutdown() doesn't remove it.
1990 */
1991 list_del_init(&dev->kobj.entry);
1992 spin_unlock(&devices_kset->list_lock);
fe6b91f4 1993
d1c6c030 1994 /* hold lock to avoid race with probe/release */
f123db8e
BL
1995 if (parent)
1996 device_lock(parent);
d1c6c030
ML
1997 device_lock(dev);
1998
fe6b91f4
AS
1999 /* Don't allow any more runtime suspends */
2000 pm_runtime_get_noresume(dev);
2001 pm_runtime_barrier(dev);
37b0c020 2002
37b0c020 2003 if (dev->bus && dev->bus->shutdown) {
0246c4fa
SL
2004 if (initcall_debug)
2005 dev_info(dev, "shutdown\n");
37b0c020
GKH
2006 dev->bus->shutdown(dev);
2007 } else if (dev->driver && dev->driver->shutdown) {
0246c4fa
SL
2008 if (initcall_debug)
2009 dev_info(dev, "shutdown\n");
37b0c020
GKH
2010 dev->driver->shutdown(dev);
2011 }
d1c6c030
ML
2012
2013 device_unlock(dev);
f123db8e
BL
2014 if (parent)
2015 device_unlock(parent);
d1c6c030 2016
6245838f 2017 put_device(dev);
f123db8e 2018 put_device(parent);
6245838f
HD
2019
2020 spin_lock(&devices_kset->list_lock);
37b0c020 2021 }
6245838f 2022 spin_unlock(&devices_kset->list_lock);
401097ea 2023 async_synchronize_full();
37b0c020 2024}
99bcf217
JP
2025
2026/*
2027 * Device logging functions
2028 */
2029
2030#ifdef CONFIG_PRINTK
666f355f
JP
2031static int
2032create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
99bcf217 2033{
c4e00daa 2034 const char *subsys;
798efc60 2035 size_t pos = 0;
99bcf217 2036
c4e00daa
KS
2037 if (dev->class)
2038 subsys = dev->class->name;
2039 else if (dev->bus)
2040 subsys = dev->bus->name;
2041 else
798efc60 2042 return 0;
c4e00daa 2043
798efc60 2044 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
c4e00daa
KS
2045
2046 /*
2047 * Add device identifier DEVICE=:
2048 * b12:8 block dev_t
2049 * c127:3 char dev_t
2050 * n8 netdev ifindex
2051 * +sound:card0 subsystem:devname
2052 */
2053 if (MAJOR(dev->devt)) {
2054 char c;
2055
2056 if (strcmp(subsys, "block") == 0)
2057 c = 'b';
2058 else
2059 c = 'c';
798efc60
JP
2060 pos++;
2061 pos += snprintf(hdr + pos, hdrlen - pos,
2062 "DEVICE=%c%u:%u",
2063 c, MAJOR(dev->devt), MINOR(dev->devt));
c4e00daa
KS
2064 } else if (strcmp(subsys, "net") == 0) {
2065 struct net_device *net = to_net_dev(dev);
2066
798efc60
JP
2067 pos++;
2068 pos += snprintf(hdr + pos, hdrlen - pos,
2069 "DEVICE=n%u", net->ifindex);
c4e00daa 2070 } else {
798efc60
JP
2071 pos++;
2072 pos += snprintf(hdr + pos, hdrlen - pos,
2073 "DEVICE=+%s:%s", subsys, dev_name(dev));
c4e00daa 2074 }
af7f2158 2075
798efc60
JP
2076 return pos;
2077}
2078EXPORT_SYMBOL(create_syslog_header);
2079
05e4e5b8
JP
2080int dev_vprintk_emit(int level, const struct device *dev,
2081 const char *fmt, va_list args)
2082{
2083 char hdr[128];
2084 size_t hdrlen;
2085
2086 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2087
2088 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2089}
2090EXPORT_SYMBOL(dev_vprintk_emit);
2091
2092int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2093{
2094 va_list args;
2095 int r;
2096
2097 va_start(args, fmt);
2098
2099 r = dev_vprintk_emit(level, dev, fmt, args);
2100
2101 va_end(args);
2102
2103 return r;
2104}
2105EXPORT_SYMBOL(dev_printk_emit);
2106
798efc60
JP
2107static int __dev_printk(const char *level, const struct device *dev,
2108 struct va_format *vaf)
2109{
798efc60
JP
2110 if (!dev)
2111 return printk("%s(NULL device *): %pV", level, vaf);
2112
666f355f
JP
2113 return dev_printk_emit(level[1] - '0', dev,
2114 "%s %s: %pV",
2115 dev_driver_string(dev), dev_name(dev), vaf);
99bcf217
JP
2116}
2117
2118int dev_printk(const char *level, const struct device *dev,
2119 const char *fmt, ...)
2120{
2121 struct va_format vaf;
2122 va_list args;
2123 int r;
2124
2125 va_start(args, fmt);
2126
2127 vaf.fmt = fmt;
2128 vaf.va = &args;
2129
2130 r = __dev_printk(level, dev, &vaf);
798efc60 2131
99bcf217
JP
2132 va_end(args);
2133
2134 return r;
2135}
2136EXPORT_SYMBOL(dev_printk);
2137
2138#define define_dev_printk_level(func, kern_level) \
2139int func(const struct device *dev, const char *fmt, ...) \
2140{ \
2141 struct va_format vaf; \
2142 va_list args; \
2143 int r; \
2144 \
2145 va_start(args, fmt); \
2146 \
2147 vaf.fmt = fmt; \
2148 vaf.va = &args; \
2149 \
2150 r = __dev_printk(kern_level, dev, &vaf); \
798efc60 2151 \
99bcf217
JP
2152 va_end(args); \
2153 \
2154 return r; \
2155} \
2156EXPORT_SYMBOL(func);
2157
2158define_dev_printk_level(dev_emerg, KERN_EMERG);
2159define_dev_printk_level(dev_alert, KERN_ALERT);
2160define_dev_printk_level(dev_crit, KERN_CRIT);
2161define_dev_printk_level(dev_err, KERN_ERR);
2162define_dev_printk_level(dev_warn, KERN_WARNING);
2163define_dev_printk_level(dev_notice, KERN_NOTICE);
2164define_dev_printk_level(_dev_info, KERN_INFO);
2165
2166#endif
This page took 0.862653 seconds and 5 git commands to generate.