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