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