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