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