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