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