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