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