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_ng(&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 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                 k = kobject_create();
 602                 if (!k)
 603                         return NULL;
 604                 k->kset = &dev->class->class_dirs;
 605                 retval = kobject_add_ng(k, parent_kobj, "%s", dev->class->name);
 606                 if (retval < 0) {
 607                         kobject_put(k);
 608                         return NULL;
 609                 }
 610                 /* Do not emit a uevent, as it's not needed for this
 611                  * "class glue" directory. */
 612                 return k;
 613         }
 614
 615         if (parent)
 616                 return &parent->kobj;
 617         return NULL;
 618 }
 619
 620 static void cleanup_device_parent(struct device *dev)
 621 {
 622         struct device *d;
 623         int other = 0;
 624
 625         if (!dev->class)
 626                 return;
 627
 628         /* see if we live in a parent class directory */
 629         if (dev->kobj.parent->kset != &dev->class->class_dirs)
 630                 return;
 631
 632         /* if we are the last child of our class, delete the directory */
 633         down(&dev->class->sem);
 634         list_for_each_entry(d, &dev->class->devices, node) {
 635                 if (d == dev)
 636                         continue;
 637                 if (d->kobj.parent == dev->kobj.parent) {
 638                         other = 1;
 639                         break;
 640                 }
 641         }
 642         if (!other)
 643                 kobject_del(dev->kobj.parent);
 644         kobject_put(dev->kobj.parent);
 645         up(&dev->class->sem);
 646 }
 647 #endif
 648
 649 static int setup_parent(struct device *dev, struct device *parent)
 650 {
 651         struct kobject *kobj;
 652         kobj = get_device_parent(dev, parent);
 653         if (IS_ERR(kobj))
 654                 return PTR_ERR(kobj);
 655         if (kobj)
 656                 dev->kobj.parent = kobj;
 657         return 0;
 658 }
 659
 660 static int device_add_class_symlinks(struct device *dev)
 661 {
 662         int error;
 663
 664         if (!dev->class)
 665                 return 0;
 666
 667         error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
 668                                   "subsystem");
 669         if (error)
 670                 goto out;
 671
 672 #ifdef CONFIG_SYSFS_DEPRECATED
 673         /* stacked class devices need a symlink in the class directory */
 674         if (dev->kobj.parent != &dev->class->subsys.kobj) {
 675                 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
 676                                           dev->bus_id);
 677                 if (error)
 678                         goto out_subsys;
 679         }
 680
 681         if (dev->parent) {
 682                 struct device *parent = dev->parent;
 683                 char *class_name;
 684
 685                 /*
 686                  * stacked class devices have the 'device' link
 687                  * pointing to the bus device instead of the parent
 688                  */
 689                 while (parent->class && !parent->bus && parent->parent)
 690                         parent = parent->parent;
 691
 692                 error = sysfs_create_link(&dev->kobj,
 693                                           &parent->kobj,
 694                                           "device");
 695                 if (error)
 696                         goto out_busid;
 697
 698                 class_name = make_class_name(dev->class->name,
 699                                                 &dev->kobj);
 700                 if (class_name)
 701                         error = sysfs_create_link(&dev->parent->kobj,
 702                                                 &dev->kobj, class_name);
 703                 kfree(class_name);
 704                 if (error)
 705                         goto out_device;
 706         }
 707         return 0;
 708
 709 out_device:
 710         if (dev->parent)
 711                 sysfs_remove_link(&dev->kobj, "device");
 712 out_busid:
 713         if (dev->kobj.parent != &dev->class->subsys.kobj)
 714                 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
 715 #else
 716         /* link in the class directory pointing to the device */
 717         error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
 718                                   dev->bus_id);
 719         if (error)
 720                 goto out_subsys;
 721
 722         if (dev->parent) {
 723                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
 724                                           "device");
 725                 if (error)
 726                         goto out_busid;
 727         }
 728         return 0;
 729
 730 out_busid:
 731         sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
 732 #endif
 733
 734 out_subsys:
 735         sysfs_remove_link(&dev->kobj, "subsystem");
 736 out:
 737         return error;
 738 }
 739
 740 static void device_remove_class_symlinks(struct device *dev)
 741 {
 742         if (!dev->class)
 743                 return;
 744
 745 #ifdef CONFIG_SYSFS_DEPRECATED
 746         if (dev->parent) {
 747                 char *class_name;
 748
 749                 class_name = make_class_name(dev->class->name, &dev->kobj);
 750                 if (class_name) {
 751                         sysfs_remove_link(&dev->parent->kobj, class_name);
 752                         kfree(class_name);
 753                 }
 754                 sysfs_remove_link(&dev->kobj, "device");
 755         }
 756
 757         if (dev->kobj.parent != &dev->class->subsys.kobj)
 758                 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
 759 #else
 760         if (dev->parent)
 761                 sysfs_remove_link(&dev->kobj, "device");
 762
 763         sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
 764 #endif
 765
 766         sysfs_remove_link(&dev->kobj, "subsystem");
 767 }
 768
 769 /**
 770  *      device_add - add device to device hierarchy.
 771  *      @dev:   device.
 772  *
 773  *      This is part 2 of device_register(), though may be called
 774  *      separately _iff_ device_initialize() has been called separately.
 775  *
 776  *      This adds it to the kobject hierarchy via kobject_add_ng(), adds it
 777  *      to the global and sibling lists for the device, then
 778  *      adds it to the other relevant subsystems of the driver model.
 779  */
 780 int device_add(struct device *dev)
 781 {
 782         struct device *parent = NULL;
 783         struct class_interface *class_intf;
 784         int error;
 785
 786         error = pm_sleep_lock();
 787         if (error) {
 788                 dev_warn(dev, "Suspicious %s during suspend\n", __FUNCTION__);
 789                 dump_stack();
 790                 return error;
 791         }
 792
 793         dev = get_device(dev);
 794         if (!dev || !strlen(dev->bus_id)) {
 795                 error = -EINVAL;
 796                 goto Error;
 797         }
 798
 799         pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
 800
 801         parent = get_device(dev->parent);
 802         error = setup_parent(dev, parent);
 803         if (error)
 804                 goto Error;
 805
 806         /* first, register with generic layer. */
 807         error = kobject_add_ng(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
 808         if (error)
 809                 goto Error;
 810
 811         /* notify platform of device entry */
 812         if (platform_notify)
 813                 platform_notify(dev);
 814
 815         /* notify clients of device entry (new way) */
 816         if (dev->bus)
 817                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 818                                              BUS_NOTIFY_ADD_DEVICE, dev);
 819
 820         error = device_create_file(dev, &uevent_attr);
 821         if (error)
 822                 goto attrError;
 823
 824         if (MAJOR(dev->devt)) {
 825                 error = device_create_file(dev, &devt_attr);
 826                 if (error)
 827                         goto ueventattrError;
 828         }
 829
 830         error = device_add_class_symlinks(dev);
 831         if (error)
 832                 goto SymlinkError;
 833         error = device_add_attrs(dev);
 834         if (error)
 835                 goto AttrsError;
 836         error = dpm_sysfs_add(dev);
 837         if (error)
 838                 goto PMError;
 839         device_pm_add(dev);
 840         error = bus_add_device(dev);
 841         if (error)
 842                 goto BusError;
 843         kobject_uevent(&dev->kobj, KOBJ_ADD);
 844         bus_attach_device(dev);
 845         if (parent)
 846                 klist_add_tail(&dev->knode_parent, &parent->klist_children);
 847
 848         if (dev->class) {
 849                 down(&dev->class->sem);
 850                 /* tie the class to the device */
 851                 list_add_tail(&dev->node, &dev->class->devices);
 852
 853                 /* notify any interfaces that the device is here */
 854                 list_for_each_entry(class_intf, &dev->class->interfaces, node)
 855                         if (class_intf->add_dev)
 856                                 class_intf->add_dev(dev, class_intf);
 857                 up(&dev->class->sem);
 858         }
 859  Done:
 860         put_device(dev);
 861         pm_sleep_unlock();
 862         return error;
 863  BusError:
 864         device_pm_remove(dev);
 865         dpm_sysfs_remove(dev);
 866  PMError:
 867         if (dev->bus)
 868                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 869                                              BUS_NOTIFY_DEL_DEVICE, dev);
 870         device_remove_attrs(dev);
 871  AttrsError:
 872         device_remove_class_symlinks(dev);
 873  SymlinkError:
 874         if (MAJOR(dev->devt))
 875                 device_remove_file(dev, &devt_attr);
 876  ueventattrError:
 877         device_remove_file(dev, &uevent_attr);
 878  attrError:
 879         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
 880         kobject_del(&dev->kobj);
 881  Error:
 882         if (parent)
 883                 put_device(parent);
 884         goto Done;
 885 }
 886
 887
 888 /**
 889  *      device_register - register a device with the system.
 890  *      @dev:   pointer to the device structure
 891  *
 892  *      This happens in two clean steps - initialize the device
 893  *      and add it to the system. The two steps can be called
 894  *      separately, but this is the easiest and most common.
 895  *      I.e. you should only call the two helpers separately if
 896  *      have a clearly defined need to use and refcount the device
 897  *      before it is added to the hierarchy.
 898  */
 899
 900 int device_register(struct device *dev)
 901 {
 902         device_initialize(dev);
 903         return device_add(dev);
 904 }
 905
 906
 907 /**
 908  *      get_device - increment reference count for device.
 909  *      @dev:   device.
 910  *
 911  *      This simply forwards the call to kobject_get(), though
 912  *      we do take care to provide for the case that we get a NULL
 913  *      pointer passed in.
 914  */
 915
 916 struct device * get_device(struct device * dev)
 917 {
 918         return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
 919 }
 920
 921
 922 /**
 923  *      put_device - decrement reference count.
 924  *      @dev:   device in question.
 925  */
 926 void put_device(struct device * dev)
 927 {
 928         if (dev)
 929                 kobject_put(&dev->kobj);
 930 }
 931
 932
 933 /**
 934  *      device_del - delete device from system.
 935  *      @dev:   device.
 936  *
 937  *      This is the first part of the device unregistration
 938  *      sequence. This removes the device from the lists we control
 939  *      from here, has it removed from the other driver model
 940  *      subsystems it was added to in device_add(), and removes it
 941  *      from the kobject hierarchy.
 942  *
 943  *      NOTE: this should be called manually _iff_ device_add() was
 944  *      also called manually.
 945  */
 946
 947 void device_del(struct device * dev)
 948 {
 949         struct device * parent = dev->parent;
 950         struct class_interface *class_intf;
 951
 952         device_pm_remove(dev);
 953         if (parent)
 954                 klist_del(&dev->knode_parent);
 955         if (MAJOR(dev->devt))
 956                 device_remove_file(dev, &devt_attr);
 957         if (dev->class) {
 958                 device_remove_class_symlinks(dev);
 959
 960                 down(&dev->class->sem);
 961                 /* notify any interfaces that the device is now gone */
 962                 list_for_each_entry(class_intf, &dev->class->interfaces, node)
 963                         if (class_intf->remove_dev)
 964                                 class_intf->remove_dev(dev, class_intf);
 965                 /* remove the device from the class list */
 966                 list_del_init(&dev->node);
 967                 up(&dev->class->sem);
 968         }
 969         device_remove_file(dev, &uevent_attr);
 970         device_remove_attrs(dev);
 971         bus_remove_device(dev);
 972
 973         /*
 974          * Some platform devices are driven without driver attached
 975          * and managed resources may have been acquired.  Make sure
 976          * all resources are released.
 977          */
 978         devres_release_all(dev);
 979
 980         /* Notify the platform of the removal, in case they
 981          * need to do anything...
 982          */
 983         if (platform_notify_remove)
 984                 platform_notify_remove(dev);
 985         if (dev->bus)
 986                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 987                                              BUS_NOTIFY_DEL_DEVICE, dev);
 988         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
 989         cleanup_device_parent(dev);
 990         kobject_del(&dev->kobj);
 991         put_device(parent);
 992 }
 993
 994 /**
 995  *      device_unregister - unregister device from system.
 996  *      @dev:   device going away.
 997  *
 998  *      We do this in two parts, like we do device_register(). First,
 999  *      we remove it from all the subsystems with device_del(), then
1000  *      we decrement the reference count via put_device(). If that
1001  *      is the final reference count, the device will be cleaned up
1002  *      via device_release() above. Otherwise, the structure will
1003  *      stick around until the final reference to the device is dropped.
1004  */
1005 void device_unregister(struct device * dev)
1006 {
1007         pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
1008         device_del(dev);
1009         put_device(dev);
1010 }
1011
1012
1013 static struct device * next_device(struct klist_iter * i)
1014 {
1015         struct klist_node * n = klist_next(i);
1016         return n ? container_of(n, struct device, knode_parent) : NULL;
1017 }
1018
1019 /**
1020  *      device_for_each_child - device child iterator.
1021  *      @parent: parent struct device.
1022  *      @data:  data for the callback.
1023  *      @fn:    function to be called for each device.
1024  *
1025  *      Iterate over @parent's child devices, and call @fn for each,
1026  *      passing it @data.
1027  *
1028  *      We check the return of @fn each time. If it returns anything
1029  *      other than 0, we break out and return that value.
1030  */
1031 int device_for_each_child(struct device * parent, void * data,
1032                      int (*fn)(struct device *, void *))
1033 {
1034         struct klist_iter i;
1035         struct device * child;
1036         int error = 0;
1037
1038         klist_iter_init(&parent->klist_children, &i);
1039         while ((child = next_device(&i)) && !error)
1040                 error = fn(child, data);
1041         klist_iter_exit(&i);
1042         return error;
1043 }
1044
1045 /**
1046  * device_find_child - device iterator for locating a particular device.
1047  * @parent: parent struct device
1048  * @data: Data to pass to match function
1049  * @match: Callback function to check device
1050  *
1051  * This is similar to the device_for_each_child() function above, but it
1052  * returns a reference to a device that is 'found' for later use, as
1053  * determined by the @match callback.
1054  *
1055  * The callback should return 0 if the device doesn't match and non-zero
1056  * if it does.  If the callback returns non-zero and a reference to the
1057  * current device can be obtained, this function will return to the caller
1058  * and not iterate over any more devices.
1059  */
1060 struct device * device_find_child(struct device *parent, void *data,
1061                                   int (*match)(struct device *, void *))
1062 {
1063         struct klist_iter i;
1064         struct device *child;
1065
1066         if (!parent)
1067                 return NULL;
1068
1069         klist_iter_init(&parent->klist_children, &i);
1070         while ((child = next_device(&i)))
1071                 if (match(child, data) && get_device(child))
1072                         break;
1073         klist_iter_exit(&i);
1074         return child;
1075 }
1076
1077 int __init devices_init(void)
1078 {
1079         devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1080         if (!devices_kset)
1081                 return -ENOMEM;
1082         return 0;
1083 }
1084
1085 EXPORT_SYMBOL_GPL(device_for_each_child);
1086 EXPORT_SYMBOL_GPL(device_find_child);
1087
1088 EXPORT_SYMBOL_GPL(device_initialize);
1089 EXPORT_SYMBOL_GPL(device_add);
1090 EXPORT_SYMBOL_GPL(device_register);
1091
1092 EXPORT_SYMBOL_GPL(device_del);
1093 EXPORT_SYMBOL_GPL(device_unregister);
1094 EXPORT_SYMBOL_GPL(get_device);
1095 EXPORT_SYMBOL_GPL(put_device);
1096
1097 EXPORT_SYMBOL_GPL(device_create_file);
1098 EXPORT_SYMBOL_GPL(device_remove_file);
1099
1100
1101 static void device_create_release(struct device *dev)
1102 {
1103         pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
1104         kfree(dev);
1105 }
1106
1107 /**
1108  * device_create - creates a device and registers it with sysfs
1109  * @class: pointer to the struct class that this device should be registered to
1110  * @parent: pointer to the parent struct device of this new device, if any
1111  * @devt: the dev_t for the char device to be added
1112  * @fmt: string for the device's name
1113  *
1114  * This function can be used by char device classes.  A struct device
1115  * will be created in sysfs, registered to the specified class.
1116  *
1117  * A "dev" file will be created, showing the dev_t for the device, if
1118  * the dev_t is not 0,0.
1119  * If a pointer to a parent struct device is passed in, the newly created
1120  * struct device will be a child of that device in sysfs.
1121  * The pointer to the struct device will be returned from the call.
1122  * Any further sysfs files that might be required can be created using this
1123  * pointer.
1124  *
1125  * Note: the struct class passed to this function must have previously
1126  * been created with a call to class_create().
1127  */
1128 struct device *device_create(struct class *class, struct device *parent,
1129                              dev_t devt, const char *fmt, ...)
1130 {
1131         va_list args;
1132         struct device *dev = NULL;
1133         int retval = -ENODEV;
1134
1135         if (class == NULL || IS_ERR(class))
1136                 goto error;
1137
1138         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1139         if (!dev) {
1140                 retval = -ENOMEM;
1141                 goto error;
1142         }
1143
1144         dev->devt = devt;
1145         dev->class = class;
1146         dev->parent = parent;
1147         dev->release = device_create_release;
1148
1149         va_start(args, fmt);
1150         vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1151         va_end(args);
1152         retval = device_register(dev);
1153         if (retval)
1154                 goto error;
1155
1156         return dev;
1157
1158 error:
1159         kfree(dev);
1160         return ERR_PTR(retval);
1161 }
1162 EXPORT_SYMBOL_GPL(device_create);
1163
1164 /**
1165  * find_device - finds a device that was created with device_create()
1166  * @class: pointer to the struct class that this device was registered with
1167  * @devt: the dev_t of the device that was previously registered
1168  */
1169 static struct device *find_device(struct class *class, dev_t devt)
1170 {
1171         struct device *dev = NULL;
1172         struct device *dev_tmp;
1173
1174         down(&class->sem);
1175         list_for_each_entry(dev_tmp, &class->devices, node) {
1176                 if (dev_tmp->devt == devt) {
1177                         dev = dev_tmp;
1178                         break;
1179                 }
1180         }
1181         up(&class->sem);
1182         return dev;
1183 }
1184
1185 /**
1186  * device_destroy - removes a device that was created with device_create()
1187  * @class: pointer to the struct class that this device was registered with
1188  * @devt: the dev_t of the device that was previously registered
1189  *
1190  * This call unregisters and cleans up a device that was created with a
1191  * call to device_create().
1192  */
1193 void device_destroy(struct class *class, dev_t devt)
1194 {
1195         struct device *dev;
1196
1197         dev = find_device(class, devt);
1198         if (dev)
1199                 device_unregister(dev);
1200 }
1201 EXPORT_SYMBOL_GPL(device_destroy);
1202
1203 #ifdef CONFIG_PM_SLEEP
1204 /**
1205  * destroy_suspended_device - asks the PM core to remove a suspended device
1206  * @class: pointer to the struct class that this device was registered with
1207  * @devt: the dev_t of the device that was previously registered
1208  *
1209  * This call notifies the PM core of the necessity to unregister a suspended
1210  * device created with a call to device_create() (devices cannot be
1211  * unregistered directly while suspended, since the PM core holds their
1212  * semaphores at that time).
1213  *
1214  * It can only be called within the scope of a system sleep transition.  In
1215  * practice this means it has to be directly or indirectly invoked either by
1216  * a suspend or resume method, or by the PM core (e.g. via
1217  * disable_nonboot_cpus() or enable_nonboot_cpus()).
1218  */
1219 void destroy_suspended_device(struct class *class, dev_t devt)
1220 {
1221         struct device *dev;
1222
1223         dev = find_device(class, devt);
1224         if (dev)
1225                 device_pm_schedule_removal(dev);
1226 }
1227 EXPORT_SYMBOL_GPL(destroy_suspended_device);
1228 #endif /* CONFIG_PM_SLEEP */
1229
1230 /**
1231  * device_rename - renames a device
1232  * @dev: the pointer to the struct device to be renamed
1233  * @new_name: the new name of the device
1234  */
1235 int device_rename(struct device *dev, char *new_name)
1236 {
1237         char *old_class_name = NULL;
1238         char *new_class_name = NULL;
1239         char *old_device_name = NULL;
1240         int error;
1241
1242         dev = get_device(dev);
1243         if (!dev)
1244                 return -EINVAL;
1245
1246         pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
1247                  __FUNCTION__, new_name);
1248
1249 #ifdef CONFIG_SYSFS_DEPRECATED
1250         if ((dev->class) && (dev->parent))
1251                 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1252 #endif
1253
1254         old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1255         if (!old_device_name) {
1256                 error = -ENOMEM;
1257                 goto out;
1258         }
1259         strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1260         strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1261
1262         error = kobject_rename(&dev->kobj, new_name);
1263         if (error) {
1264                 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1265                 goto out;
1266         }
1267
1268 #ifdef CONFIG_SYSFS_DEPRECATED
1269         if (old_class_name) {
1270                 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1271                 if (new_class_name) {
1272                         error = sysfs_create_link(&dev->parent->kobj,
1273                                                   &dev->kobj, new_class_name);
1274                         if (error)
1275                                 goto out;
1276                         sysfs_remove_link(&dev->parent->kobj, old_class_name);
1277                 }
1278         }
1279 #else
1280         if (dev->class) {
1281                 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1282                 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1283                                           dev->bus_id);
1284                 if (error) {
1285                         dev_err(dev, "%s: sysfs_create_symlink failed (%d)\n",
1286                                 __FUNCTION__, error);
1287                 }
1288         }
1289 #endif
1290
1291 out:
1292         put_device(dev);
1293
1294         kfree(new_class_name);
1295         kfree(old_class_name);
1296         kfree(old_device_name);
1297
1298         return error;
1299 }
1300 EXPORT_SYMBOL_GPL(device_rename);
1301
1302 static int device_move_class_links(struct device *dev,
1303                                    struct device *old_parent,
1304                                    struct device *new_parent)
1305 {
1306         int error = 0;
1307 #ifdef CONFIG_SYSFS_DEPRECATED
1308         char *class_name;
1309
1310         class_name = make_class_name(dev->class->name, &dev->kobj);
1311         if (!class_name) {
1312                 error = -ENOMEM;
1313                 goto out;
1314         }
1315         if (old_parent) {
1316                 sysfs_remove_link(&dev->kobj, "device");
1317                 sysfs_remove_link(&old_parent->kobj, class_name);
1318         }
1319         if (new_parent) {
1320                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1321                                           "device");
1322                 if (error)
1323                         goto out;
1324                 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1325                                           class_name);
1326                 if (error)
1327                         sysfs_remove_link(&dev->kobj, "device");
1328         }
1329         else
1330                 error = 0;
1331 out:
1332         kfree(class_name);
1333         return error;
1334 #else
1335         if (old_parent)
1336                 sysfs_remove_link(&dev->kobj, "device");
1337         if (new_parent)
1338                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1339                                           "device");
1340         return error;
1341 #endif
1342 }
1343
1344 /**
1345  * device_move - moves a device to a new parent
1346  * @dev: the pointer to the struct device to be moved
1347  * @new_parent: the new parent of the device (can by NULL)
1348  */
1349 int device_move(struct device *dev, struct device *new_parent)
1350 {
1351         int error;
1352         struct device *old_parent;
1353         struct kobject *new_parent_kobj;
1354
1355         dev = get_device(dev);
1356         if (!dev)
1357                 return -EINVAL;
1358
1359         new_parent = get_device(new_parent);
1360         new_parent_kobj = get_device_parent (dev, new_parent);
1361         if (IS_ERR(new_parent_kobj)) {
1362                 error = PTR_ERR(new_parent_kobj);
1363                 put_device(new_parent);
1364                 goto out;
1365         }
1366         pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
1367                  __FUNCTION__, new_parent ? new_parent->bus_id : "<NULL>");
1368         error = kobject_move(&dev->kobj, new_parent_kobj);
1369         if (error) {
1370                 put_device(new_parent);
1371                 goto out;
1372         }
1373         old_parent = dev->parent;
1374         dev->parent = new_parent;
1375         if (old_parent)
1376                 klist_remove(&dev->knode_parent);
1377         if (new_parent)
1378                 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1379         if (!dev->class)
1380                 goto out_put;
1381         error = device_move_class_links(dev, old_parent, new_parent);
1382         if (error) {
1383                 /* We ignore errors on cleanup since we're hosed anyway... */
1384                 device_move_class_links(dev, new_parent, old_parent);
1385                 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1386                         if (new_parent)
1387                                 klist_remove(&dev->knode_parent);
1388                         if (old_parent)
1389                                 klist_add_tail(&dev->knode_parent,
1390                                                &old_parent->klist_children);
1391                 }
1392                 put_device(new_parent);
1393                 goto out;
1394         }
1395 out_put:
1396         put_device(old_parent);
1397 out:
1398         put_device(dev);
1399         return error;
1400 }
1401 EXPORT_SYMBOL_GPL(device_move);
1402
1403 /**
1404  * device_shutdown - call ->shutdown() on each device to shutdown.
1405  */
1406 void device_shutdown(void)
1407 {
1408         struct device * dev, *devn;
1409
1410         list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1411                                 kobj.entry) {
1412                 if (dev->bus && dev->bus->shutdown) {
1413                         dev_dbg(dev, "shutdown\n");
1414                         dev->bus->shutdown(dev);
1415                 } else if (dev->driver && dev->driver->shutdown) {
1416                         dev_dbg(dev, "shutdown\n");
1417                         dev->driver->shutdown(dev);
1418                 }
1419         }
1420 }