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