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