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