device_schedule_callback() needs a module reference
[deliverable/linux.git] / drivers / base / core.c
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
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
8 *
9 * This file is released under the GPLv2
10 *
11 */
12
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>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
21
22 #include <asm/semaphore.h>
23
24 #include "base.h"
25 #include "power/power.h"
26
27 int (*platform_notify)(struct device * dev) = NULL;
28 int (*platform_notify_remove)(struct device * dev) = NULL;
29
30 /*
31 * sysfs bindings for devices.
32 */
33
34 /**
35 * dev_driver_string - Return a device's driver name, if at all possible
36 * @dev: struct device to get the name of
37 *
38 * Will return the device's driver's name if it is bound to a device. If
39 * the device is not bound to a device, it will return the name of the bus
40 * it is attached to. If it is not attached to a bus either, an empty
41 * string will be returned.
42 */
43 const char *dev_driver_string(struct device *dev)
44 {
45 return dev->driver ? dev->driver->name :
46 (dev->bus ? dev->bus->name :
47 (dev->class ? dev->class->name : ""));
48 }
49 EXPORT_SYMBOL(dev_driver_string);
50
51 #define to_dev(obj) container_of(obj, struct device, kobj)
52 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
53
54 static ssize_t
55 dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
56 {
57 struct device_attribute * dev_attr = to_dev_attr(attr);
58 struct device * dev = to_dev(kobj);
59 ssize_t ret = -EIO;
60
61 if (dev_attr->show)
62 ret = dev_attr->show(dev, dev_attr, buf);
63 return ret;
64 }
65
66 static ssize_t
67 dev_attr_store(struct kobject * kobj, struct attribute * attr,
68 const char * buf, size_t count)
69 {
70 struct device_attribute * dev_attr = to_dev_attr(attr);
71 struct device * dev = to_dev(kobj);
72 ssize_t ret = -EIO;
73
74 if (dev_attr->store)
75 ret = dev_attr->store(dev, dev_attr, buf, count);
76 return ret;
77 }
78
79 static struct sysfs_ops dev_sysfs_ops = {
80 .show = dev_attr_show,
81 .store = dev_attr_store,
82 };
83
84
85 /**
86 * device_release - free device structure.
87 * @kobj: device's kobject.
88 *
89 * This is called once the reference count for the object
90 * reaches 0. We forward the call to the device's release
91 * method, which should handle actually freeing the structure.
92 */
93 static void device_release(struct kobject * kobj)
94 {
95 struct device * dev = to_dev(kobj);
96
97 if (dev->release)
98 dev->release(dev);
99 else if (dev->type && dev->type->release)
100 dev->type->release(dev);
101 else if (dev->class && dev->class->dev_release)
102 dev->class->dev_release(dev);
103 else {
104 printk(KERN_ERR "Device '%s' does not have a release() function, "
105 "it is broken and must be fixed.\n",
106 dev->bus_id);
107 WARN_ON(1);
108 }
109 }
110
111 static struct kobj_type ktype_device = {
112 .release = device_release,
113 .sysfs_ops = &dev_sysfs_ops,
114 };
115
116
117 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
118 {
119 struct kobj_type *ktype = get_ktype(kobj);
120
121 if (ktype == &ktype_device) {
122 struct device *dev = to_dev(kobj);
123 if (dev->uevent_suppress)
124 return 0;
125 if (dev->bus)
126 return 1;
127 if (dev->class)
128 return 1;
129 }
130 return 0;
131 }
132
133 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
134 {
135 struct device *dev = to_dev(kobj);
136
137 if (dev->bus)
138 return dev->bus->name;
139 if (dev->class)
140 return dev->class->name;
141 return NULL;
142 }
143
144 static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
145 int num_envp, char *buffer, int buffer_size)
146 {
147 struct device *dev = to_dev(kobj);
148 int i = 0;
149 int length = 0;
150 int retval = 0;
151
152 /* add the major/minor if present */
153 if (MAJOR(dev->devt)) {
154 add_uevent_var(envp, num_envp, &i,
155 buffer, buffer_size, &length,
156 "MAJOR=%u", MAJOR(dev->devt));
157 add_uevent_var(envp, num_envp, &i,
158 buffer, buffer_size, &length,
159 "MINOR=%u", MINOR(dev->devt));
160 }
161
162 if (dev->type && dev->type->name)
163 add_uevent_var(envp, num_envp, &i,
164 buffer, buffer_size, &length,
165 "DEVTYPE=%s", dev->type->name);
166
167 if (dev->driver)
168 add_uevent_var(envp, num_envp, &i,
169 buffer, buffer_size, &length,
170 "DRIVER=%s", dev->driver->name);
171
172 #ifdef CONFIG_SYSFS_DEPRECATED
173 if (dev->class) {
174 struct device *parent = dev->parent;
175
176 /* find first bus device in parent chain */
177 while (parent && !parent->bus)
178 parent = parent->parent;
179 if (parent && parent->bus) {
180 const char *path;
181
182 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
183 add_uevent_var(envp, num_envp, &i,
184 buffer, buffer_size, &length,
185 "PHYSDEVPATH=%s", path);
186 kfree(path);
187
188 add_uevent_var(envp, num_envp, &i,
189 buffer, buffer_size, &length,
190 "PHYSDEVBUS=%s", parent->bus->name);
191
192 if (parent->driver)
193 add_uevent_var(envp, num_envp, &i,
194 buffer, buffer_size, &length,
195 "PHYSDEVDRIVER=%s", parent->driver->name);
196 }
197 } else if (dev->bus) {
198 add_uevent_var(envp, num_envp, &i,
199 buffer, buffer_size, &length,
200 "PHYSDEVBUS=%s", dev->bus->name);
201
202 if (dev->driver)
203 add_uevent_var(envp, num_envp, &i,
204 buffer, buffer_size, &length,
205 "PHYSDEVDRIVER=%s", dev->driver->name);
206 }
207 #endif
208
209 /* terminate, set to next free slot, shrink available space */
210 envp[i] = NULL;
211 envp = &envp[i];
212 num_envp -= i;
213 buffer = &buffer[length];
214 buffer_size -= length;
215
216 if (dev->bus && dev->bus->uevent) {
217 /* have the bus specific function add its stuff */
218 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
219 if (retval)
220 pr_debug ("%s: bus uevent() returned %d\n",
221 __FUNCTION__, retval);
222 }
223
224 if (dev->class && dev->class->dev_uevent) {
225 /* have the class specific function add its stuff */
226 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
227 if (retval)
228 pr_debug("%s: class uevent() returned %d\n",
229 __FUNCTION__, retval);
230 }
231
232 if (dev->type && dev->type->uevent) {
233 /* have the device type specific fuction add its stuff */
234 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
235 if (retval)
236 pr_debug("%s: dev_type uevent() returned %d\n",
237 __FUNCTION__, retval);
238 }
239
240 return retval;
241 }
242
243 static struct kset_uevent_ops device_uevent_ops = {
244 .filter = dev_uevent_filter,
245 .name = dev_uevent_name,
246 .uevent = dev_uevent,
247 };
248
249 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
250 char *buf)
251 {
252 struct kobject *top_kobj;
253 struct kset *kset;
254 char *envp[32];
255 char data[PAGE_SIZE];
256 char *pos;
257 int i;
258 size_t count = 0;
259 int retval;
260
261 /* search the kset, the device belongs to */
262 top_kobj = &dev->kobj;
263 if (!top_kobj->kset && top_kobj->parent) {
264 do {
265 top_kobj = top_kobj->parent;
266 } while (!top_kobj->kset && top_kobj->parent);
267 }
268 if (!top_kobj->kset)
269 goto out;
270 kset = top_kobj->kset;
271 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
272 goto out;
273
274 /* respect filter */
275 if (kset->uevent_ops && kset->uevent_ops->filter)
276 if (!kset->uevent_ops->filter(kset, &dev->kobj))
277 goto out;
278
279 /* let the kset specific function add its keys */
280 pos = data;
281 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
282 envp, ARRAY_SIZE(envp),
283 pos, PAGE_SIZE);
284 if (retval)
285 goto out;
286
287 /* copy keys to file */
288 for (i = 0; envp[i]; i++) {
289 pos = &buf[count];
290 count += sprintf(pos, "%s\n", envp[i]);
291 }
292 out:
293 return count;
294 }
295
296 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
297 const char *buf, size_t count)
298 {
299 if (memcmp(buf, "add", 3) != 0)
300 dev_err(dev, "uevent: unsupported action-string; this will "
301 "be ignored in a future kernel version");
302 kobject_uevent(&dev->kobj, KOBJ_ADD);
303 return count;
304 }
305
306 static int device_add_attributes(struct device *dev,
307 struct device_attribute *attrs)
308 {
309 int error = 0;
310 int i;
311
312 if (attrs) {
313 for (i = 0; attr_name(attrs[i]); i++) {
314 error = device_create_file(dev, &attrs[i]);
315 if (error)
316 break;
317 }
318 if (error)
319 while (--i >= 0)
320 device_remove_file(dev, &attrs[i]);
321 }
322 return error;
323 }
324
325 static void device_remove_attributes(struct device *dev,
326 struct device_attribute *attrs)
327 {
328 int i;
329
330 if (attrs)
331 for (i = 0; attr_name(attrs[i]); i++)
332 device_remove_file(dev, &attrs[i]);
333 }
334
335 static int device_add_groups(struct device *dev,
336 struct attribute_group **groups)
337 {
338 int error = 0;
339 int i;
340
341 if (groups) {
342 for (i = 0; groups[i]; i++) {
343 error = sysfs_create_group(&dev->kobj, groups[i]);
344 if (error) {
345 while (--i >= 0)
346 sysfs_remove_group(&dev->kobj, groups[i]);
347 break;
348 }
349 }
350 }
351 return error;
352 }
353
354 static void device_remove_groups(struct device *dev,
355 struct attribute_group **groups)
356 {
357 int i;
358
359 if (groups)
360 for (i = 0; groups[i]; i++)
361 sysfs_remove_group(&dev->kobj, groups[i]);
362 }
363
364 static int device_add_attrs(struct device *dev)
365 {
366 struct class *class = dev->class;
367 struct device_type *type = dev->type;
368 int error;
369
370 if (class) {
371 error = device_add_attributes(dev, class->dev_attrs);
372 if (error)
373 return error;
374 }
375
376 if (type) {
377 error = device_add_groups(dev, type->groups);
378 if (error)
379 goto err_remove_class_attrs;
380 }
381
382 error = device_add_groups(dev, dev->groups);
383 if (error)
384 goto err_remove_type_groups;
385
386 return 0;
387
388 err_remove_type_groups:
389 if (type)
390 device_remove_groups(dev, type->groups);
391 err_remove_class_attrs:
392 if (class)
393 device_remove_attributes(dev, class->dev_attrs);
394
395 return error;
396 }
397
398 static void device_remove_attrs(struct device *dev)
399 {
400 struct class *class = dev->class;
401 struct device_type *type = dev->type;
402
403 device_remove_groups(dev, dev->groups);
404
405 if (type)
406 device_remove_groups(dev, type->groups);
407
408 if (class)
409 device_remove_attributes(dev, class->dev_attrs);
410 }
411
412
413 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
414 char *buf)
415 {
416 return print_dev_t(buf, dev->devt);
417 }
418
419 /*
420 * devices_subsys - structure to be registered with kobject core.
421 */
422
423 decl_subsys(devices, &ktype_device, &device_uevent_ops);
424
425
426 /**
427 * device_create_file - create sysfs attribute file for device.
428 * @dev: device.
429 * @attr: device attribute descriptor.
430 */
431
432 int device_create_file(struct device * dev, struct device_attribute * attr)
433 {
434 int error = 0;
435 if (get_device(dev)) {
436 error = sysfs_create_file(&dev->kobj, &attr->attr);
437 put_device(dev);
438 }
439 return error;
440 }
441
442 /**
443 * device_remove_file - remove sysfs attribute file.
444 * @dev: device.
445 * @attr: device attribute descriptor.
446 */
447
448 void device_remove_file(struct device * dev, struct device_attribute * attr)
449 {
450 if (get_device(dev)) {
451 sysfs_remove_file(&dev->kobj, &attr->attr);
452 put_device(dev);
453 }
454 }
455
456 /**
457 * device_create_bin_file - create sysfs binary attribute file for device.
458 * @dev: device.
459 * @attr: device binary attribute descriptor.
460 */
461 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
462 {
463 int error = -EINVAL;
464 if (dev)
465 error = sysfs_create_bin_file(&dev->kobj, attr);
466 return error;
467 }
468 EXPORT_SYMBOL_GPL(device_create_bin_file);
469
470 /**
471 * device_remove_bin_file - remove sysfs binary attribute file
472 * @dev: device.
473 * @attr: device binary attribute descriptor.
474 */
475 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
476 {
477 if (dev)
478 sysfs_remove_bin_file(&dev->kobj, attr);
479 }
480 EXPORT_SYMBOL_GPL(device_remove_bin_file);
481
482 /**
483 * device_schedule_callback_owner - helper to schedule a callback for a device
484 * @dev: device.
485 * @func: callback function to invoke later.
486 * @owner: module owning the callback routine
487 *
488 * Attribute methods must not unregister themselves or their parent device
489 * (which would amount to the same thing). Attempts to do so will deadlock,
490 * since unregistration is mutually exclusive with driver callbacks.
491 *
492 * Instead methods can call this routine, which will attempt to allocate
493 * and schedule a workqueue request to call back @func with @dev as its
494 * argument in the workqueue's process context. @dev will be pinned until
495 * @func returns.
496 *
497 * This routine is usually called via the inline device_schedule_callback(),
498 * which automatically sets @owner to THIS_MODULE.
499 *
500 * Returns 0 if the request was submitted, -ENOMEM if storage could not
501 * be allocated, -ENODEV if a reference to @owner isn't available.
502 *
503 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
504 * underlying sysfs routine (since it is intended for use by attribute
505 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
506 */
507 int device_schedule_callback_owner(struct device *dev,
508 void (*func)(struct device *), struct module *owner)
509 {
510 return sysfs_schedule_callback(&dev->kobj,
511 (void (*)(void *)) func, dev, owner);
512 }
513 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
514
515 static void klist_children_get(struct klist_node *n)
516 {
517 struct device *dev = container_of(n, struct device, knode_parent);
518
519 get_device(dev);
520 }
521
522 static void klist_children_put(struct klist_node *n)
523 {
524 struct device *dev = container_of(n, struct device, knode_parent);
525
526 put_device(dev);
527 }
528
529
530 /**
531 * device_initialize - init device structure.
532 * @dev: device.
533 *
534 * This prepares the device for use by other layers,
535 * including adding it to the device hierarchy.
536 * It is the first half of device_register(), if called by
537 * that, though it can also be called separately, so one
538 * may use @dev's fields (e.g. the refcount).
539 */
540
541 void device_initialize(struct device *dev)
542 {
543 kobj_set_kset_s(dev, devices_subsys);
544 kobject_init(&dev->kobj);
545 klist_init(&dev->klist_children, klist_children_get,
546 klist_children_put);
547 INIT_LIST_HEAD(&dev->dma_pools);
548 INIT_LIST_HEAD(&dev->node);
549 init_MUTEX(&dev->sem);
550 spin_lock_init(&dev->devres_lock);
551 INIT_LIST_HEAD(&dev->devres_head);
552 device_init_wakeup(dev, 0);
553 set_dev_node(dev, -1);
554 }
555
556 #ifdef CONFIG_SYSFS_DEPRECATED
557 static struct kobject * get_device_parent(struct device *dev,
558 struct device *parent)
559 {
560 /* Set the parent to the class, not the parent device */
561 /* this keeps sysfs from having a symlink to make old udevs happy */
562 if (dev->class)
563 return &dev->class->subsys.kset.kobj;
564 else if (parent)
565 return &parent->kobj;
566
567 return NULL;
568 }
569 #else
570 static struct kobject *virtual_device_parent(struct device *dev)
571 {
572 static struct kobject *virtual_dir = NULL;
573
574 if (!virtual_dir)
575 virtual_dir = kobject_add_dir(&devices_subsys.kset.kobj, "virtual");
576
577 return virtual_dir;
578 }
579
580 static struct kobject * get_device_parent(struct device *dev,
581 struct device *parent)
582 {
583 if (dev->class) {
584 struct kobject *kobj = NULL;
585 struct kobject *parent_kobj;
586 struct kobject *k;
587
588 /*
589 * If we have no parent, we live in "virtual".
590 * Class-devices with a bus-device as parent, live
591 * in a class-directory to prevent namespace collisions.
592 */
593 if (parent == NULL)
594 parent_kobj = virtual_device_parent(dev);
595 else if (parent->class)
596 return &parent->kobj;
597 else
598 parent_kobj = &parent->kobj;
599
600 /* find our class-directory at the parent and reference it */
601 spin_lock(&dev->class->class_dirs.list_lock);
602 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
603 if (k->parent == parent_kobj) {
604 kobj = kobject_get(k);
605 break;
606 }
607 spin_unlock(&dev->class->class_dirs.list_lock);
608 if (kobj)
609 return kobj;
610
611 /* or create a new class-directory at the parent device */
612 return kobject_kset_add_dir(&dev->class->class_dirs,
613 parent_kobj, dev->class->name);
614 }
615
616 if (parent)
617 return &parent->kobj;
618 return NULL;
619 }
620 #endif
621
622 static int setup_parent(struct device *dev, struct device *parent)
623 {
624 struct kobject *kobj;
625 kobj = get_device_parent(dev, parent);
626 if (IS_ERR(kobj))
627 return PTR_ERR(kobj);
628 if (kobj)
629 dev->kobj.parent = kobj;
630 return 0;
631 }
632
633 /**
634 * device_add - add device to device hierarchy.
635 * @dev: device.
636 *
637 * This is part 2 of device_register(), though may be called
638 * separately _iff_ device_initialize() has been called separately.
639 *
640 * This adds it to the kobject hierarchy via kobject_add(), adds it
641 * to the global and sibling lists for the device, then
642 * adds it to the other relevant subsystems of the driver model.
643 */
644 int device_add(struct device *dev)
645 {
646 struct device *parent = NULL;
647 char *class_name = NULL;
648 struct class_interface *class_intf;
649 int error = -EINVAL;
650
651 dev = get_device(dev);
652 if (!dev || !strlen(dev->bus_id))
653 goto Error;
654
655 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
656
657 parent = get_device(dev->parent);
658 error = setup_parent(dev, parent);
659 if (error)
660 goto Error;
661
662 /* first, register with generic layer. */
663 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
664 error = kobject_add(&dev->kobj);
665 if (error)
666 goto Error;
667
668 /* notify platform of device entry */
669 if (platform_notify)
670 platform_notify(dev);
671
672 /* notify clients of device entry (new way) */
673 if (dev->bus)
674 blocking_notifier_call_chain(&dev->bus->bus_notifier,
675 BUS_NOTIFY_ADD_DEVICE, dev);
676
677 dev->uevent_attr.attr.name = "uevent";
678 dev->uevent_attr.attr.mode = S_IRUGO | S_IWUSR;
679 if (dev->driver)
680 dev->uevent_attr.attr.owner = dev->driver->owner;
681 dev->uevent_attr.store = store_uevent;
682 dev->uevent_attr.show = show_uevent;
683 error = device_create_file(dev, &dev->uevent_attr);
684 if (error)
685 goto attrError;
686
687 if (MAJOR(dev->devt)) {
688 struct device_attribute *attr;
689 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
690 if (!attr) {
691 error = -ENOMEM;
692 goto ueventattrError;
693 }
694 attr->attr.name = "dev";
695 attr->attr.mode = S_IRUGO;
696 if (dev->driver)
697 attr->attr.owner = dev->driver->owner;
698 attr->show = show_dev;
699 error = device_create_file(dev, attr);
700 if (error) {
701 kfree(attr);
702 goto ueventattrError;
703 }
704
705 dev->devt_attr = attr;
706 }
707
708 if (dev->class) {
709 sysfs_create_link(&dev->kobj, &dev->class->subsys.kset.kobj,
710 "subsystem");
711 /* If this is not a "fake" compatible device, then create the
712 * symlink from the class to the device. */
713 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
714 sysfs_create_link(&dev->class->subsys.kset.kobj,
715 &dev->kobj, dev->bus_id);
716 if (parent) {
717 sysfs_create_link(&dev->kobj, &dev->parent->kobj,
718 "device");
719 #ifdef CONFIG_SYSFS_DEPRECATED
720 class_name = make_class_name(dev->class->name,
721 &dev->kobj);
722 if (class_name)
723 sysfs_create_link(&dev->parent->kobj,
724 &dev->kobj, class_name);
725 #endif
726 }
727 }
728
729 if ((error = device_add_attrs(dev)))
730 goto AttrsError;
731 if ((error = device_pm_add(dev)))
732 goto PMError;
733 if ((error = bus_add_device(dev)))
734 goto BusError;
735 kobject_uevent(&dev->kobj, KOBJ_ADD);
736 bus_attach_device(dev);
737 if (parent)
738 klist_add_tail(&dev->knode_parent, &parent->klist_children);
739
740 if (dev->class) {
741 down(&dev->class->sem);
742 /* tie the class to the device */
743 list_add_tail(&dev->node, &dev->class->devices);
744
745 /* notify any interfaces that the device is here */
746 list_for_each_entry(class_intf, &dev->class->interfaces, node)
747 if (class_intf->add_dev)
748 class_intf->add_dev(dev, class_intf);
749 up(&dev->class->sem);
750 }
751 Done:
752 kfree(class_name);
753 put_device(dev);
754 return error;
755 BusError:
756 device_pm_remove(dev);
757 PMError:
758 if (dev->bus)
759 blocking_notifier_call_chain(&dev->bus->bus_notifier,
760 BUS_NOTIFY_DEL_DEVICE, dev);
761 device_remove_attrs(dev);
762 AttrsError:
763 if (dev->devt_attr) {
764 device_remove_file(dev, dev->devt_attr);
765 kfree(dev->devt_attr);
766 }
767
768 if (dev->class) {
769 sysfs_remove_link(&dev->kobj, "subsystem");
770 /* If this is not a "fake" compatible device, remove the
771 * symlink from the class to the device. */
772 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
773 sysfs_remove_link(&dev->class->subsys.kset.kobj,
774 dev->bus_id);
775 if (parent) {
776 #ifdef CONFIG_SYSFS_DEPRECATED
777 char *class_name = make_class_name(dev->class->name,
778 &dev->kobj);
779 if (class_name)
780 sysfs_remove_link(&dev->parent->kobj,
781 class_name);
782 kfree(class_name);
783 #endif
784 sysfs_remove_link(&dev->kobj, "device");
785 }
786 }
787 ueventattrError:
788 device_remove_file(dev, &dev->uevent_attr);
789 attrError:
790 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
791 kobject_del(&dev->kobj);
792 Error:
793 if (parent)
794 put_device(parent);
795 goto Done;
796 }
797
798
799 /**
800 * device_register - register a device with the system.
801 * @dev: pointer to the device structure
802 *
803 * This happens in two clean steps - initialize the device
804 * and add it to the system. The two steps can be called
805 * separately, but this is the easiest and most common.
806 * I.e. you should only call the two helpers separately if
807 * have a clearly defined need to use and refcount the device
808 * before it is added to the hierarchy.
809 */
810
811 int device_register(struct device *dev)
812 {
813 device_initialize(dev);
814 return device_add(dev);
815 }
816
817
818 /**
819 * get_device - increment reference count for device.
820 * @dev: device.
821 *
822 * This simply forwards the call to kobject_get(), though
823 * we do take care to provide for the case that we get a NULL
824 * pointer passed in.
825 */
826
827 struct device * get_device(struct device * dev)
828 {
829 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
830 }
831
832
833 /**
834 * put_device - decrement reference count.
835 * @dev: device in question.
836 */
837 void put_device(struct device * dev)
838 {
839 if (dev)
840 kobject_put(&dev->kobj);
841 }
842
843
844 /**
845 * device_del - delete device from system.
846 * @dev: device.
847 *
848 * This is the first part of the device unregistration
849 * sequence. This removes the device from the lists we control
850 * from here, has it removed from the other driver model
851 * subsystems it was added to in device_add(), and removes it
852 * from the kobject hierarchy.
853 *
854 * NOTE: this should be called manually _iff_ device_add() was
855 * also called manually.
856 */
857
858 void device_del(struct device * dev)
859 {
860 struct device * parent = dev->parent;
861 struct class_interface *class_intf;
862
863 if (parent)
864 klist_del(&dev->knode_parent);
865 if (dev->devt_attr) {
866 device_remove_file(dev, dev->devt_attr);
867 kfree(dev->devt_attr);
868 }
869 if (dev->class) {
870 sysfs_remove_link(&dev->kobj, "subsystem");
871 /* If this is not a "fake" compatible device, remove the
872 * symlink from the class to the device. */
873 if (dev->kobj.parent != &dev->class->subsys.kset.kobj)
874 sysfs_remove_link(&dev->class->subsys.kset.kobj,
875 dev->bus_id);
876 if (parent) {
877 #ifdef CONFIG_SYSFS_DEPRECATED
878 char *class_name = make_class_name(dev->class->name,
879 &dev->kobj);
880 if (class_name)
881 sysfs_remove_link(&dev->parent->kobj,
882 class_name);
883 kfree(class_name);
884 #endif
885 sysfs_remove_link(&dev->kobj, "device");
886 }
887
888 down(&dev->class->sem);
889 /* notify any interfaces that the device is now gone */
890 list_for_each_entry(class_intf, &dev->class->interfaces, node)
891 if (class_intf->remove_dev)
892 class_intf->remove_dev(dev, class_intf);
893 /* remove the device from the class list */
894 list_del_init(&dev->node);
895 up(&dev->class->sem);
896
897 /* If we live in a parent class-directory, unreference it */
898 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
899 struct device *d;
900 int other = 0;
901
902 /*
903 * if we are the last child of our class, delete
904 * our class-directory at this parent
905 */
906 down(&dev->class->sem);
907 list_for_each_entry(d, &dev->class->devices, node) {
908 if (d == dev)
909 continue;
910 if (d->kobj.parent == dev->kobj.parent) {
911 other = 1;
912 break;
913 }
914 }
915 if (!other)
916 kobject_del(dev->kobj.parent);
917
918 kobject_put(dev->kobj.parent);
919 up(&dev->class->sem);
920 }
921 }
922 device_remove_file(dev, &dev->uevent_attr);
923 device_remove_attrs(dev);
924 bus_remove_device(dev);
925
926 /*
927 * Some platform devices are driven without driver attached
928 * and managed resources may have been acquired. Make sure
929 * all resources are released.
930 */
931 devres_release_all(dev);
932
933 /* Notify the platform of the removal, in case they
934 * need to do anything...
935 */
936 if (platform_notify_remove)
937 platform_notify_remove(dev);
938 if (dev->bus)
939 blocking_notifier_call_chain(&dev->bus->bus_notifier,
940 BUS_NOTIFY_DEL_DEVICE, dev);
941 device_pm_remove(dev);
942 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
943 kobject_del(&dev->kobj);
944 if (parent)
945 put_device(parent);
946 }
947
948 /**
949 * device_unregister - unregister device from system.
950 * @dev: device going away.
951 *
952 * We do this in two parts, like we do device_register(). First,
953 * we remove it from all the subsystems with device_del(), then
954 * we decrement the reference count via put_device(). If that
955 * is the final reference count, the device will be cleaned up
956 * via device_release() above. Otherwise, the structure will
957 * stick around until the final reference to the device is dropped.
958 */
959 void device_unregister(struct device * dev)
960 {
961 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
962 device_del(dev);
963 put_device(dev);
964 }
965
966
967 static struct device * next_device(struct klist_iter * i)
968 {
969 struct klist_node * n = klist_next(i);
970 return n ? container_of(n, struct device, knode_parent) : NULL;
971 }
972
973 /**
974 * device_for_each_child - device child iterator.
975 * @parent: parent struct device.
976 * @data: data for the callback.
977 * @fn: function to be called for each device.
978 *
979 * Iterate over @parent's child devices, and call @fn for each,
980 * passing it @data.
981 *
982 * We check the return of @fn each time. If it returns anything
983 * other than 0, we break out and return that value.
984 */
985 int device_for_each_child(struct device * parent, void * data,
986 int (*fn)(struct device *, void *))
987 {
988 struct klist_iter i;
989 struct device * child;
990 int error = 0;
991
992 klist_iter_init(&parent->klist_children, &i);
993 while ((child = next_device(&i)) && !error)
994 error = fn(child, data);
995 klist_iter_exit(&i);
996 return error;
997 }
998
999 /**
1000 * device_find_child - device iterator for locating a particular device.
1001 * @parent: parent struct device
1002 * @data: Data to pass to match function
1003 * @match: Callback function to check device
1004 *
1005 * This is similar to the device_for_each_child() function above, but it
1006 * returns a reference to a device that is 'found' for later use, as
1007 * determined by the @match callback.
1008 *
1009 * The callback should return 0 if the device doesn't match and non-zero
1010 * if it does. If the callback returns non-zero and a reference to the
1011 * current device can be obtained, this function will return to the caller
1012 * and not iterate over any more devices.
1013 */
1014 struct device * device_find_child(struct device *parent, void *data,
1015 int (*match)(struct device *, void *))
1016 {
1017 struct klist_iter i;
1018 struct device *child;
1019
1020 if (!parent)
1021 return NULL;
1022
1023 klist_iter_init(&parent->klist_children, &i);
1024 while ((child = next_device(&i)))
1025 if (match(child, data) && get_device(child))
1026 break;
1027 klist_iter_exit(&i);
1028 return child;
1029 }
1030
1031 int __init devices_init(void)
1032 {
1033 return subsystem_register(&devices_subsys);
1034 }
1035
1036 EXPORT_SYMBOL_GPL(device_for_each_child);
1037 EXPORT_SYMBOL_GPL(device_find_child);
1038
1039 EXPORT_SYMBOL_GPL(device_initialize);
1040 EXPORT_SYMBOL_GPL(device_add);
1041 EXPORT_SYMBOL_GPL(device_register);
1042
1043 EXPORT_SYMBOL_GPL(device_del);
1044 EXPORT_SYMBOL_GPL(device_unregister);
1045 EXPORT_SYMBOL_GPL(get_device);
1046 EXPORT_SYMBOL_GPL(put_device);
1047
1048 EXPORT_SYMBOL_GPL(device_create_file);
1049 EXPORT_SYMBOL_GPL(device_remove_file);
1050
1051
1052 static void device_create_release(struct device *dev)
1053 {
1054 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1055 kfree(dev);
1056 }
1057
1058 /**
1059 * device_create - creates a device and registers it with sysfs
1060 * @class: pointer to the struct class that this device should be registered to
1061 * @parent: pointer to the parent struct device of this new device, if any
1062 * @devt: the dev_t for the char device to be added
1063 * @fmt: string for the device's name
1064 *
1065 * This function can be used by char device classes. A struct device
1066 * will be created in sysfs, registered to the specified class.
1067 *
1068 * A "dev" file will be created, showing the dev_t for the device, if
1069 * the dev_t is not 0,0.
1070 * If a pointer to a parent struct device is passed in, the newly created
1071 * struct device will be a child of that device in sysfs.
1072 * The pointer to the struct device will be returned from the call.
1073 * Any further sysfs files that might be required can be created using this
1074 * pointer.
1075 *
1076 * Note: the struct class passed to this function must have previously
1077 * been created with a call to class_create().
1078 */
1079 struct device *device_create(struct class *class, struct device *parent,
1080 dev_t devt, const char *fmt, ...)
1081 {
1082 va_list args;
1083 struct device *dev = NULL;
1084 int retval = -ENODEV;
1085
1086 if (class == NULL || IS_ERR(class))
1087 goto error;
1088
1089 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1090 if (!dev) {
1091 retval = -ENOMEM;
1092 goto error;
1093 }
1094
1095 dev->devt = devt;
1096 dev->class = class;
1097 dev->parent = parent;
1098 dev->release = device_create_release;
1099
1100 va_start(args, fmt);
1101 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1102 va_end(args);
1103 retval = device_register(dev);
1104 if (retval)
1105 goto error;
1106
1107 return dev;
1108
1109 error:
1110 kfree(dev);
1111 return ERR_PTR(retval);
1112 }
1113 EXPORT_SYMBOL_GPL(device_create);
1114
1115 /**
1116 * device_destroy - removes a device that was created with device_create()
1117 * @class: pointer to the struct class that this device was registered with
1118 * @devt: the dev_t of the device that was previously registered
1119 *
1120 * This call unregisters and cleans up a device that was created with a
1121 * call to device_create().
1122 */
1123 void device_destroy(struct class *class, dev_t devt)
1124 {
1125 struct device *dev = NULL;
1126 struct device *dev_tmp;
1127
1128 down(&class->sem);
1129 list_for_each_entry(dev_tmp, &class->devices, node) {
1130 if (dev_tmp->devt == devt) {
1131 dev = dev_tmp;
1132 break;
1133 }
1134 }
1135 up(&class->sem);
1136
1137 if (dev)
1138 device_unregister(dev);
1139 }
1140 EXPORT_SYMBOL_GPL(device_destroy);
1141
1142 /**
1143 * device_rename - renames a device
1144 * @dev: the pointer to the struct device to be renamed
1145 * @new_name: the new name of the device
1146 */
1147 int device_rename(struct device *dev, char *new_name)
1148 {
1149 char *old_class_name = NULL;
1150 char *new_class_name = NULL;
1151 char *old_symlink_name = NULL;
1152 int error;
1153
1154 dev = get_device(dev);
1155 if (!dev)
1156 return -EINVAL;
1157
1158 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1159
1160 #ifdef CONFIG_SYSFS_DEPRECATED
1161 if ((dev->class) && (dev->parent))
1162 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1163 #endif
1164
1165 if (dev->class) {
1166 old_symlink_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1167 if (!old_symlink_name) {
1168 error = -ENOMEM;
1169 goto out_free_old_class;
1170 }
1171 strlcpy(old_symlink_name, dev->bus_id, BUS_ID_SIZE);
1172 }
1173
1174 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1175
1176 error = kobject_rename(&dev->kobj, new_name);
1177
1178 #ifdef CONFIG_SYSFS_DEPRECATED
1179 if (old_class_name) {
1180 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1181 if (new_class_name) {
1182 sysfs_create_link(&dev->parent->kobj, &dev->kobj,
1183 new_class_name);
1184 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1185 }
1186 }
1187 #endif
1188
1189 if (dev->class) {
1190 sysfs_remove_link(&dev->class->subsys.kset.kobj,
1191 old_symlink_name);
1192 sysfs_create_link(&dev->class->subsys.kset.kobj, &dev->kobj,
1193 dev->bus_id);
1194 }
1195 put_device(dev);
1196
1197 kfree(new_class_name);
1198 kfree(old_symlink_name);
1199 out_free_old_class:
1200 kfree(old_class_name);
1201
1202 return error;
1203 }
1204 EXPORT_SYMBOL_GPL(device_rename);
1205
1206 static int device_move_class_links(struct device *dev,
1207 struct device *old_parent,
1208 struct device *new_parent)
1209 {
1210 int error = 0;
1211 #ifdef CONFIG_SYSFS_DEPRECATED
1212 char *class_name;
1213
1214 class_name = make_class_name(dev->class->name, &dev->kobj);
1215 if (!class_name) {
1216 error = -ENOMEM;
1217 goto out;
1218 }
1219 if (old_parent) {
1220 sysfs_remove_link(&dev->kobj, "device");
1221 sysfs_remove_link(&old_parent->kobj, class_name);
1222 }
1223 if (new_parent) {
1224 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1225 "device");
1226 if (error)
1227 goto out;
1228 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1229 class_name);
1230 if (error)
1231 sysfs_remove_link(&dev->kobj, "device");
1232 }
1233 else
1234 error = 0;
1235 out:
1236 kfree(class_name);
1237 return error;
1238 #else
1239 if (old_parent)
1240 sysfs_remove_link(&dev->kobj, "device");
1241 if (new_parent)
1242 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1243 "device");
1244 return error;
1245 #endif
1246 }
1247
1248 /**
1249 * device_move - moves a device to a new parent
1250 * @dev: the pointer to the struct device to be moved
1251 * @new_parent: the new parent of the device (can by NULL)
1252 */
1253 int device_move(struct device *dev, struct device *new_parent)
1254 {
1255 int error;
1256 struct device *old_parent;
1257 struct kobject *new_parent_kobj;
1258
1259 dev = get_device(dev);
1260 if (!dev)
1261 return -EINVAL;
1262
1263 new_parent = get_device(new_parent);
1264 new_parent_kobj = get_device_parent (dev, new_parent);
1265 if (IS_ERR(new_parent_kobj)) {
1266 error = PTR_ERR(new_parent_kobj);
1267 put_device(new_parent);
1268 goto out;
1269 }
1270 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1271 new_parent ? new_parent->bus_id : "<NULL>");
1272 error = kobject_move(&dev->kobj, new_parent_kobj);
1273 if (error) {
1274 put_device(new_parent);
1275 goto out;
1276 }
1277 old_parent = dev->parent;
1278 dev->parent = new_parent;
1279 if (old_parent)
1280 klist_remove(&dev->knode_parent);
1281 if (new_parent)
1282 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1283 if (!dev->class)
1284 goto out_put;
1285 error = device_move_class_links(dev, old_parent, new_parent);
1286 if (error) {
1287 /* We ignore errors on cleanup since we're hosed anyway... */
1288 device_move_class_links(dev, new_parent, old_parent);
1289 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1290 if (new_parent)
1291 klist_remove(&dev->knode_parent);
1292 if (old_parent)
1293 klist_add_tail(&dev->knode_parent,
1294 &old_parent->klist_children);
1295 }
1296 put_device(new_parent);
1297 goto out;
1298 }
1299 out_put:
1300 put_device(old_parent);
1301 out:
1302 put_device(dev);
1303 return error;
1304 }
1305
1306 EXPORT_SYMBOL_GPL(device_move);
This page took 0.055804 seconds and 5 git commands to generate.