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