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 <linux/kallsyms.h>
  23 #include <linux/semaphore.h>
  24 #include <linux/mutex.h>
  25 #include <linux/async.h>
  26
  27 #include "base.h"
  28 #include "power/power.h"
  29
  30 int (*platform_notify)(struct device *dev) = NULL;
  31 int (*platform_notify_remove)(struct device *dev) = NULL;
  32 static struct kobject *dev_kobj;
  33 struct kobject *sysfs_dev_char_kobj;
  34 struct kobject *sysfs_dev_block_kobj;
  35
  36 #ifdef CONFIG_BLOCK
  37 static inline int device_is_not_partition(struct device *dev)
  38 {
  39         return !(dev->type == &part_type);
  40 }
  41 #else
  42 static inline int device_is_not_partition(struct device *dev)
  43 {
  44         return 1;
  45 }
  46 #endif
  47
  48 /**
  49  * dev_driver_string - Return a device's driver name, if at all possible
  50  * @dev: struct device to get the name of
  51  *
  52  * Will return the device's driver's name if it is bound to a device.  If
  53  * the device is not bound to a device, it will return the name of the bus
  54  * it is attached to.  If it is not attached to a bus either, an empty
  55  * string will be returned.
  56  */
  57 const char *dev_driver_string(const struct device *dev)
  58 {
  59         struct device_driver *drv;
  60
  61         /* dev->driver can change to NULL underneath us because of unbinding,
  62          * so be careful about accessing it.  dev->bus and dev->class should
  63          * never change once they are set, so they don't need special care.
  64          */
  65         drv = ACCESS_ONCE(dev->driver);
  66         return drv ? drv->name :
  67                         (dev->bus ? dev->bus->name :
  68                         (dev->class ? dev->class->name : ""));
  69 }
  70 EXPORT_SYMBOL(dev_driver_string);
  71
  72 #define to_dev(obj) container_of(obj, struct device, kobj)
  73 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
  74
  75 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
  76                              char *buf)
  77 {
  78         struct device_attribute *dev_attr = to_dev_attr(attr);
  79         struct device *dev = to_dev(kobj);
  80         ssize_t ret = -EIO;
  81
  82         if (dev_attr->show)
  83                 ret = dev_attr->show(dev, dev_attr, buf);
  84         if (ret >= (ssize_t)PAGE_SIZE) {
  85                 print_symbol("dev_attr_show: %s returned bad count\n",
  86                                 (unsigned long)dev_attr->show);
  87         }
  88         return ret;
  89 }
  90
  91 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
  92                               const char *buf, size_t count)
  93 {
  94         struct device_attribute *dev_attr = to_dev_attr(attr);
  95         struct device *dev = to_dev(kobj);
  96         ssize_t ret = -EIO;
  97
  98         if (dev_attr->store)
  99                 ret = dev_attr->store(dev, dev_attr, buf, count);
 100         return ret;
 101 }
 102
 103 static struct sysfs_ops dev_sysfs_ops = {
 104         .show   = dev_attr_show,
 105         .store  = dev_attr_store,
 106 };
 107
 108
 109 /**
 110  *      device_release - free device structure.
 111  *      @kobj:  device's kobject.
 112  *
 113  *      This is called once the reference count for the object
 114  *      reaches 0. We forward the call to the device's release
 115  *      method, which should handle actually freeing the structure.
 116  */
 117 static void device_release(struct kobject *kobj)
 118 {
 119         struct device *dev = to_dev(kobj);
 120         struct device_private *p = dev->p;
 121
 122         if (dev->release)
 123                 dev->release(dev);
 124         else if (dev->type && dev->type->release)
 125                 dev->type->release(dev);
 126         else if (dev->class && dev->class->dev_release)
 127                 dev->class->dev_release(dev);
 128         else
 129                 WARN(1, KERN_ERR "Device '%s' does not have a release() "
 130                         "function, it is broken and must be fixed.\n",
 131                         dev_name(dev));
 132         kfree(p);
 133 }
 134
 135 static struct kobj_type device_ktype = {
 136         .release        = device_release,
 137         .sysfs_ops      = &dev_sysfs_ops,
 138 };
 139
 140
 141 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
 142 {
 143         struct kobj_type *ktype = get_ktype(kobj);
 144
 145         if (ktype == &device_ktype) {
 146                 struct device *dev = to_dev(kobj);
 147                 if (dev->bus)
 148                         return 1;
 149                 if (dev->class)
 150                         return 1;
 151         }
 152         return 0;
 153 }
 154
 155 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
 156 {
 157         struct device *dev = to_dev(kobj);
 158
 159         if (dev->bus)
 160                 return dev->bus->name;
 161         if (dev->class)
 162                 return dev->class->name;
 163         return NULL;
 164 }
 165
 166 static int dev_uevent(struct kset *kset, struct kobject *kobj,
 167                       struct kobj_uevent_env *env)
 168 {
 169         struct device *dev = to_dev(kobj);
 170         int retval = 0;
 171
 172         /* add device node properties if present */
 173         if (MAJOR(dev->devt)) {
 174                 const char *tmp;
 175                 const char *name;
 176                 mode_t mode = 0;
 177
 178                 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
 179                 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
 180                 name = device_get_devnode(dev, &mode, &tmp);
 181                 if (name) {
 182                         add_uevent_var(env, "DEVNAME=%s", name);
 183                         kfree(tmp);
 184                         if (mode)
 185                                 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
 186                 }
 187         }
 188
 189         if (dev->type && dev->type->name)
 190                 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
 191
 192         if (dev->driver)
 193                 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
 194
 195 #ifdef CONFIG_SYSFS_DEPRECATED
 196         if (dev->class) {
 197                 struct device *parent = dev->parent;
 198
 199                 /* find first bus device in parent chain */
 200                 while (parent && !parent->bus)
 201                         parent = parent->parent;
 202                 if (parent && parent->bus) {
 203                         const char *path;
 204
 205                         path = kobject_get_path(&parent->kobj, GFP_KERNEL);
 206                         if (path) {
 207                                 add_uevent_var(env, "PHYSDEVPATH=%s", path);
 208                                 kfree(path);
 209                         }
 210
 211                         add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
 212
 213                         if (parent->driver)
 214                                 add_uevent_var(env, "PHYSDEVDRIVER=%s",
 215                                                parent->driver->name);
 216                 }
 217         } else if (dev->bus) {
 218                 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
 219
 220                 if (dev->driver)
 221                         add_uevent_var(env, "PHYSDEVDRIVER=%s",
 222                                        dev->driver->name);
 223         }
 224 #endif
 225
 226         /* have the bus specific function add its stuff */
 227         if (dev->bus && dev->bus->uevent) {
 228                 retval = dev->bus->uevent(dev, env);
 229                 if (retval)
 230                         pr_debug("device: '%s': %s: bus uevent() returned %d\n",
 231                                  dev_name(dev), __func__, retval);
 232         }
 233
 234         /* have the class specific function add its stuff */
 235         if (dev->class && dev->class->dev_uevent) {
 236                 retval = dev->class->dev_uevent(dev, env);
 237                 if (retval)
 238                         pr_debug("device: '%s': %s: class uevent() "
 239                                  "returned %d\n", dev_name(dev),
 240                                  __func__, retval);
 241         }
 242
 243         /* have the device type specific fuction add its stuff */
 244         if (dev->type && dev->type->uevent) {
 245                 retval = dev->type->uevent(dev, env);
 246                 if (retval)
 247                         pr_debug("device: '%s': %s: dev_type uevent() "
 248                                  "returned %d\n", dev_name(dev),
 249                                  __func__, retval);
 250         }
 251
 252         return retval;
 253 }
 254
 255 static struct kset_uevent_ops device_uevent_ops = {
 256         .filter =       dev_uevent_filter,
 257         .name =         dev_uevent_name,
 258         .uevent =       dev_uevent,
 259 };
 260
 261 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
 262                            char *buf)
 263 {
 264         struct kobject *top_kobj;
 265         struct kset *kset;
 266         struct kobj_uevent_env *env = NULL;
 267         int i;
 268         size_t count = 0;
 269         int retval;
 270
 271         /* search the kset, the device belongs to */
 272         top_kobj = &dev->kobj;
 273         while (!top_kobj->kset && top_kobj->parent)
 274                 top_kobj = top_kobj->parent;
 275         if (!top_kobj->kset)
 276                 goto out;
 277
 278         kset = top_kobj->kset;
 279         if (!kset->uevent_ops || !kset->uevent_ops->uevent)
 280                 goto out;
 281
 282         /* respect filter */
 283         if (kset->uevent_ops && kset->uevent_ops->filter)
 284                 if (!kset->uevent_ops->filter(kset, &dev->kobj))
 285                         goto out;
 286
 287         env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
 288         if (!env)
 289                 return -ENOMEM;
 290
 291         /* let the kset specific function add its keys */
 292         retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
 293         if (retval)
 294                 goto out;
 295
 296         /* copy keys to file */
 297         for (i = 0; i < env->envp_idx; i++)
 298                 count += sprintf(&buf[count], "%s\n", env->envp[i]);
 299 out:
 300         kfree(env);
 301         return count;
 302 }
 303
 304 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
 305                             const char *buf, size_t count)
 306 {
 307         enum kobject_action action;
 308
 309         if (kobject_action_type(buf, count, &action) == 0) {
 310                 kobject_uevent(&dev->kobj, action);
 311                 goto out;
 312         }
 313
 314         dev_err(dev, "uevent: unsupported action-string; this will "
 315                      "be ignored in a future kernel version\n");
 316         kobject_uevent(&dev->kobj, KOBJ_ADD);
 317 out:
 318         return count;
 319 }
 320
 321 static struct device_attribute uevent_attr =
 322         __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
 323
 324 static int device_add_attributes(struct device *dev,
 325                                  struct device_attribute *attrs)
 326 {
 327         int error = 0;
 328         int i;
 329
 330         if (attrs) {
 331                 for (i = 0; attr_name(attrs[i]); i++) {
 332                         error = device_create_file(dev, &attrs[i]);
 333                         if (error)
 334                                 break;
 335                 }
 336                 if (error)
 337                         while (--i >= 0)
 338                                 device_remove_file(dev, &attrs[i]);
 339         }
 340         return error;
 341 }
 342
 343 static void device_remove_attributes(struct device *dev,
 344                                      struct device_attribute *attrs)
 345 {
 346         int i;
 347
 348         if (attrs)
 349                 for (i = 0; attr_name(attrs[i]); i++)
 350                         device_remove_file(dev, &attrs[i]);
 351 }
 352
 353 static int device_add_groups(struct device *dev,
 354                              const struct attribute_group **groups)
 355 {
 356         int error = 0;
 357         int i;
 358
 359         if (groups) {
 360                 for (i = 0; groups[i]; i++) {
 361                         error = sysfs_create_group(&dev->kobj, groups[i]);
 362                         if (error) {
 363                                 while (--i >= 0)
 364                                         sysfs_remove_group(&dev->kobj,
 365                                                            groups[i]);
 366                                 break;
 367                         }
 368                 }
 369         }
 370         return error;
 371 }
 372
 373 static void device_remove_groups(struct device *dev,
 374                                  const struct attribute_group **groups)
 375 {
 376         int i;
 377
 378         if (groups)
 379                 for (i = 0; groups[i]; i++)
 380                         sysfs_remove_group(&dev->kobj, groups[i]);
 381 }
 382
 383 static int device_add_attrs(struct device *dev)
 384 {
 385         struct class *class = dev->class;
 386         struct device_type *type = dev->type;
 387         int error;
 388
 389         if (class) {
 390                 error = device_add_attributes(dev, class->dev_attrs);
 391                 if (error)
 392                         return error;
 393         }
 394
 395         if (type) {
 396                 error = device_add_groups(dev, type->groups);
 397                 if (error)
 398                         goto err_remove_class_attrs;
 399         }
 400
 401         error = device_add_groups(dev, dev->groups);
 402         if (error)
 403                 goto err_remove_type_groups;
 404
 405         return 0;
 406
 407  err_remove_type_groups:
 408         if (type)
 409                 device_remove_groups(dev, type->groups);
 410  err_remove_class_attrs:
 411         if (class)
 412                 device_remove_attributes(dev, class->dev_attrs);
 413
 414         return error;
 415 }
 416
 417 static void device_remove_attrs(struct device *dev)
 418 {
 419         struct class *class = dev->class;
 420         struct device_type *type = dev->type;
 421
 422         device_remove_groups(dev, dev->groups);
 423
 424         if (type)
 425                 device_remove_groups(dev, type->groups);
 426
 427         if (class)
 428                 device_remove_attributes(dev, class->dev_attrs);
 429 }
 430
 431
 432 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
 433                         char *buf)
 434 {
 435         return print_dev_t(buf, dev->devt);
 436 }
 437
 438 static struct device_attribute devt_attr =
 439         __ATTR(dev, S_IRUGO, show_dev, NULL);
 440
 441 /* kset to create /sys/devices/  */
 442 struct kset *devices_kset;
 443
 444 /**
 445  * device_create_file - create sysfs attribute file for device.
 446  * @dev: device.
 447  * @attr: device attribute descriptor.
 448  */
 449 int device_create_file(struct device *dev, struct device_attribute *attr)
 450 {
 451         int error = 0;
 452         if (dev)
 453                 error = sysfs_create_file(&dev->kobj, &attr->attr);
 454         return error;
 455 }
 456
 457 /**
 458  * device_remove_file - remove sysfs attribute file.
 459  * @dev: device.
 460  * @attr: device attribute descriptor.
 461  */
 462 void device_remove_file(struct device *dev, struct device_attribute *attr)
 463 {
 464         if (dev)
 465                 sysfs_remove_file(&dev->kobj, &attr->attr);
 466 }
 467
 468 /**
 469  * device_create_bin_file - create sysfs binary attribute file for device.
 470  * @dev: device.
 471  * @attr: device binary attribute descriptor.
 472  */
 473 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
 474 {
 475         int error = -EINVAL;
 476         if (dev)
 477                 error = sysfs_create_bin_file(&dev->kobj, attr);
 478         return error;
 479 }
 480 EXPORT_SYMBOL_GPL(device_create_bin_file);
 481
 482 /**
 483  * device_remove_bin_file - remove sysfs binary attribute file
 484  * @dev: device.
 485  * @attr: device binary attribute descriptor.
 486  */
 487 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
 488 {
 489         if (dev)
 490                 sysfs_remove_bin_file(&dev->kobj, attr);
 491 }
 492 EXPORT_SYMBOL_GPL(device_remove_bin_file);
 493
 494 /**
 495  * device_schedule_callback_owner - helper to schedule a callback for a device
 496  * @dev: device.
 497  * @func: callback function to invoke later.
 498  * @owner: module owning the callback routine
 499  *
 500  * Attribute methods must not unregister themselves or their parent device
 501  * (which would amount to the same thing).  Attempts to do so will deadlock,
 502  * since unregistration is mutually exclusive with driver callbacks.
 503  *
 504  * Instead methods can call this routine, which will attempt to allocate
 505  * and schedule a workqueue request to call back @func with @dev as its
 506  * argument in the workqueue's process context.  @dev will be pinned until
 507  * @func returns.
 508  *
 509  * This routine is usually called via the inline device_schedule_callback(),
 510  * which automatically sets @owner to THIS_MODULE.
 511  *
 512  * Returns 0 if the request was submitted, -ENOMEM if storage could not
 513  * be allocated, -ENODEV if a reference to @owner isn't available.
 514  *
 515  * NOTE: This routine won't work if CONFIG_SYSFS isn't set!  It uses an
 516  * underlying sysfs routine (since it is intended for use by attribute
 517  * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
 518  */
 519 int device_schedule_callback_owner(struct device *dev,
 520                 void (*func)(struct device *), struct module *owner)
 521 {
 522         return sysfs_schedule_callback(&dev->kobj,
 523                         (void (*)(void *)) func, dev, owner);
 524 }
 525 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
 526
 527 static void klist_children_get(struct klist_node *n)
 528 {
 529         struct device_private *p = to_device_private_parent(n);
 530         struct device *dev = p->device;
 531
 532         get_device(dev);
 533 }
 534
 535 static void klist_children_put(struct klist_node *n)
 536 {
 537         struct device_private *p = to_device_private_parent(n);
 538         struct device *dev = p->device;
 539
 540         put_device(dev);
 541 }
 542
 543 /**
 544  * device_initialize - init device structure.
 545  * @dev: device.
 546  *
 547  * This prepares the device for use by other layers by initializing
 548  * its fields.
 549  * It is the first half of device_register(), if called by
 550  * that function, though it can also be called separately, so one
 551  * may use @dev's fields. In particular, get_device()/put_device()
 552  * may be used for reference counting of @dev after calling this
 553  * function.
 554  *
 555  * NOTE: Use put_device() to give up your reference instead of freeing
 556  * @dev directly once you have called this function.
 557  */
 558 void device_initialize(struct device *dev)
 559 {
 560         dev->kobj.kset = devices_kset;
 561         kobject_init(&dev->kobj, &device_ktype);
 562         INIT_LIST_HEAD(&dev->dma_pools);
 563         init_MUTEX(&dev->sem);
 564         spin_lock_init(&dev->devres_lock);
 565         INIT_LIST_HEAD(&dev->devres_head);
 566         device_init_wakeup(dev, 0);
 567         device_pm_init(dev);
 568         set_dev_node(dev, -1);
 569 }
 570
 571 #ifdef CONFIG_SYSFS_DEPRECATED
 572 static struct kobject *get_device_parent(struct device *dev,
 573                                          struct device *parent)
 574 {
 575         /* class devices without a parent live in /sys/class/<classname>/ */
 576         if (dev->class && (!parent || parent->class != dev->class))
 577                 return &dev->class->p->class_subsys.kobj;
 578         /* all other devices keep their parent */
 579         else if (parent)
 580                 return &parent->kobj;
 581
 582         return NULL;
 583 }
 584
 585 static inline void cleanup_device_parent(struct device *dev) {}
 586 static inline void cleanup_glue_dir(struct device *dev,
 587                                     struct kobject *glue_dir) {}
 588 #else
 589 static struct kobject *virtual_device_parent(struct device *dev)
 590 {
 591         static struct kobject *virtual_dir = NULL;
 592
 593         if (!virtual_dir)
 594                 virtual_dir = kobject_create_and_add("virtual",
 595                                                      &devices_kset->kobj);
 596
 597         return virtual_dir;
 598 }
 599
 600 static struct kobject *get_device_parent(struct device *dev,
 601                                          struct device *parent)
 602 {
 603         int retval;
 604
 605         if (dev->class) {
 606                 struct kobject *kobj = NULL;
 607                 struct kobject *parent_kobj;
 608                 struct kobject *k;
 609
 610                 /*
 611                  * If we have no parent, we live in "virtual".
 612                  * Class-devices with a non class-device as parent, live
 613                  * in a "glue" directory to prevent namespace collisions.
 614                  */
 615                 if (parent == NULL)
 616                         parent_kobj = virtual_device_parent(dev);
 617                 else if (parent->class)
 618                         return &parent->kobj;
 619                 else
 620                         parent_kobj = &parent->kobj;
 621
 622                 /* find our class-directory at the parent and reference it */
 623                 spin_lock(&dev->class->p->class_dirs.list_lock);
 624                 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
 625                         if (k->parent == parent_kobj) {
 626                                 kobj = kobject_get(k);
 627                                 break;
 628                         }
 629                 spin_unlock(&dev->class->p->class_dirs.list_lock);
 630                 if (kobj)
 631                         return kobj;
 632
 633                 /* or create a new class-directory at the parent device */
 634                 k = kobject_create();
 635                 if (!k)
 636                         return NULL;
 637                 k->kset = &dev->class->p->class_dirs;
 638                 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
 639                 if (retval < 0) {
 640                         kobject_put(k);
 641                         return NULL;
 642                 }
 643                 /* do not emit an uevent for this simple "glue" directory */
 644                 return k;
 645         }
 646
 647         if (parent)
 648                 return &parent->kobj;
 649         return NULL;
 650 }
 651
 652 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
 653 {
 654         /* see if we live in a "glue" directory */
 655         if (!glue_dir || !dev->class ||
 656             glue_dir->kset != &dev->class->p->class_dirs)
 657                 return;
 658
 659         kobject_put(glue_dir);
 660 }
 661
 662 static void cleanup_device_parent(struct device *dev)
 663 {
 664         cleanup_glue_dir(dev, dev->kobj.parent);
 665 }
 666 #endif
 667
 668 static void setup_parent(struct device *dev, struct device *parent)
 669 {
 670         struct kobject *kobj;
 671         kobj = get_device_parent(dev, parent);
 672         if (kobj)
 673                 dev->kobj.parent = kobj;
 674 }
 675
 676 static int device_add_class_symlinks(struct device *dev)
 677 {
 678         int error;
 679
 680         if (!dev->class)
 681                 return 0;
 682
 683         error = sysfs_create_link(&dev->kobj,
 684                                   &dev->class->p->class_subsys.kobj,
 685                                   "subsystem");
 686         if (error)
 687                 goto out;
 688
 689 #ifdef CONFIG_SYSFS_DEPRECATED
 690         /* stacked class devices need a symlink in the class directory */
 691         if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
 692             device_is_not_partition(dev)) {
 693                 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
 694                                           &dev->kobj, dev_name(dev));
 695                 if (error)
 696                         goto out_subsys;
 697         }
 698
 699         if (dev->parent && device_is_not_partition(dev)) {
 700                 struct device *parent = dev->parent;
 701                 char *class_name;
 702
 703                 /*
 704                  * stacked class devices have the 'device' link
 705                  * pointing to the bus device instead of the parent
 706                  */
 707                 while (parent->class && !parent->bus && parent->parent)
 708                         parent = parent->parent;
 709
 710                 error = sysfs_create_link(&dev->kobj,
 711                                           &parent->kobj,
 712                                           "device");
 713                 if (error)
 714                         goto out_busid;
 715
 716                 class_name = make_class_name(dev->class->name,
 717                                                 &dev->kobj);
 718                 if (class_name)
 719                         error = sysfs_create_link(&dev->parent->kobj,
 720                                                 &dev->kobj, class_name);
 721                 kfree(class_name);
 722                 if (error)
 723                         goto out_device;
 724         }
 725         return 0;
 726
 727 out_device:
 728         if (dev->parent && device_is_not_partition(dev))
 729                 sysfs_remove_link(&dev->kobj, "device");
 730 out_busid:
 731         if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
 732             device_is_not_partition(dev))
 733                 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
 734                                   dev_name(dev));
 735 #else
 736         /* link in the class directory pointing to the device */
 737         error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
 738                                   &dev->kobj, dev_name(dev));
 739         if (error)
 740                 goto out_subsys;
 741
 742         if (dev->parent && device_is_not_partition(dev)) {
 743                 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
 744                                           "device");
 745                 if (error)
 746                         goto out_busid;
 747         }
 748         return 0;
 749
 750 out_busid:
 751         sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
 752 #endif
 753
 754 out_subsys:
 755         sysfs_remove_link(&dev->kobj, "subsystem");
 756 out:
 757         return error;
 758 }
 759
 760 static void device_remove_class_symlinks(struct device *dev)
 761 {
 762         if (!dev->class)
 763                 return;
 764
 765 #ifdef CONFIG_SYSFS_DEPRECATED
 766         if (dev->parent && device_is_not_partition(dev)) {
 767                 char *class_name;
 768
 769                 class_name = make_class_name(dev->class->name, &dev->kobj);
 770                 if (class_name) {
 771                         sysfs_remove_link(&dev->parent->kobj, class_name);
 772                         kfree(class_name);
 773                 }
 774                 sysfs_remove_link(&dev->kobj, "device");
 775         }
 776
 777         if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
 778             device_is_not_partition(dev))
 779                 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
 780                                   dev_name(dev));
 781 #else
 782         if (dev->parent && device_is_not_partition(dev))
 783                 sysfs_remove_link(&dev->kobj, "device");
 784
 785         sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
 786 #endif
 787
 788         sysfs_remove_link(&dev->kobj, "subsystem");
 789 }
 790
 791 /**
 792  * dev_set_name - set a device name
 793  * @dev: device
 794  * @fmt: format string for the device's name
 795  */
 796 int dev_set_name(struct device *dev, const char *fmt, ...)
 797 {
 798         va_list vargs;
 799         int err;
 800
 801         va_start(vargs, fmt);
 802         err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
 803         va_end(vargs);
 804         return err;
 805 }
 806 EXPORT_SYMBOL_GPL(dev_set_name);
 807
 808 /**
 809  * device_to_dev_kobj - select a /sys/dev/ directory for the device
 810  * @dev: device
 811  *
 812  * By default we select char/ for new entries.  Setting class->dev_obj
 813  * to NULL prevents an entry from being created.  class->dev_kobj must
 814  * be set (or cleared) before any devices are registered to the class
 815  * otherwise device_create_sys_dev_entry() and
 816  * device_remove_sys_dev_entry() will disagree about the the presence
 817  * of the link.
 818  */
 819 static struct kobject *device_to_dev_kobj(struct device *dev)
 820 {
 821         struct kobject *kobj;
 822
 823         if (dev->class)
 824                 kobj = dev->class->dev_kobj;
 825         else
 826                 kobj = sysfs_dev_char_kobj;
 827
 828         return kobj;
 829 }
 830
 831 static int device_create_sys_dev_entry(struct device *dev)
 832 {
 833         struct kobject *kobj = device_to_dev_kobj(dev);
 834         int error = 0;
 835         char devt_str[15];
 836
 837         if (kobj) {
 838                 format_dev_t(devt_str, dev->devt);
 839                 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
 840         }
 841
 842         return error;
 843 }
 844
 845 static void device_remove_sys_dev_entry(struct device *dev)
 846 {
 847         struct kobject *kobj = device_to_dev_kobj(dev);
 848         char devt_str[15];
 849
 850         if (kobj) {
 851                 format_dev_t(devt_str, dev->devt);
 852                 sysfs_remove_link(kobj, devt_str);
 853         }
 854 }
 855
 856 int device_private_init(struct device *dev)
 857 {
 858         dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
 859         if (!dev->p)
 860                 return -ENOMEM;
 861         dev->p->device = dev;
 862         klist_init(&dev->p->klist_children, klist_children_get,
 863                    klist_children_put);
 864         return 0;
 865 }
 866
 867 /**
 868  * device_add - add device to device hierarchy.
 869  * @dev: device.
 870  *
 871  * This is part 2 of device_register(), though may be called
 872  * separately _iff_ device_initialize() has been called separately.
 873  *
 874  * This adds @dev to the kobject hierarchy via kobject_add(), adds it
 875  * to the global and sibling lists for the device, then
 876  * adds it to the other relevant subsystems of the driver model.
 877  *
 878  * NOTE: _Never_ directly free @dev after calling this function, even
 879  * if it returned an error! Always use put_device() to give up your
 880  * reference instead.
 881  */
 882 int device_add(struct device *dev)
 883 {
 884         struct device *parent = NULL;
 885         struct class_interface *class_intf;
 886         int error = -EINVAL;
 887
 888         dev = get_device(dev);
 889         if (!dev)
 890                 goto done;
 891
 892         if (!dev->p) {
 893                 error = device_private_init(dev);
 894                 if (error)
 895                         goto done;
 896         }
 897
 898         /*
 899          * for statically allocated devices, which should all be converted
 900          * some day, we need to initialize the name. We prevent reading back
 901          * the name, and force the use of dev_name()
 902          */
 903         if (dev->init_name) {
 904                 dev_set_name(dev, "%s", dev->init_name);
 905                 dev->init_name = NULL;
 906         }
 907
 908         if (!dev_name(dev))
 909                 goto name_error;
 910
 911         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
 912
 913         parent = get_device(dev->parent);
 914         setup_parent(dev, parent);
 915
 916         /* use parent numa_node */
 917         if (parent)
 918                 set_dev_node(dev, dev_to_node(parent));
 919
 920         /* first, register with generic layer. */
 921         /* we require the name to be set before, and pass NULL */
 922         error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
 923         if (error)
 924                 goto Error;
 925
 926         /* notify platform of device entry */
 927         if (platform_notify)
 928                 platform_notify(dev);
 929
 930         error = device_create_file(dev, &uevent_attr);
 931         if (error)
 932                 goto attrError;
 933
 934         if (MAJOR(dev->devt)) {
 935                 error = device_create_file(dev, &devt_attr);
 936                 if (error)
 937                         goto ueventattrError;
 938
 939                 error = device_create_sys_dev_entry(dev);
 940                 if (error)
 941                         goto devtattrError;
 942
 943                 devtmpfs_create_node(dev);
 944         }
 945
 946         error = device_add_class_symlinks(dev);
 947         if (error)
 948                 goto SymlinkError;
 949         error = device_add_attrs(dev);
 950         if (error)
 951                 goto AttrsError;
 952         error = bus_add_device(dev);
 953         if (error)
 954                 goto BusError;
 955         error = dpm_sysfs_add(dev);
 956         if (error)
 957                 goto DPMError;
 958         device_pm_add(dev);
 959
 960         /* Notify clients of device addition.  This call must come
 961          * after dpm_sysf_add() and before kobject_uevent().
 962          */
 963         if (dev->bus)
 964                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
 965                                              BUS_NOTIFY_ADD_DEVICE, dev);
 966
 967         kobject_uevent(&dev->kobj, KOBJ_ADD);
 968         bus_probe_device(dev);
 969         if (parent)
 970                 klist_add_tail(&dev->p->knode_parent,
 971                                &parent->p->klist_children);
 972
 973         if (dev->class) {
 974                 mutex_lock(&dev->class->p->class_mutex);
 975                 /* tie the class to the device */
 976                 klist_add_tail(&dev->knode_class,
 977                                &dev->class->p->class_devices);
 978
 979                 /* notify any interfaces that the device is here */
 980                 list_for_each_entry(class_intf,
 981                                     &dev->class->p->class_interfaces, node)
 982                         if (class_intf->add_dev)
 983                                 class_intf->add_dev(dev, class_intf);
 984                 mutex_unlock(&dev->class->p->class_mutex);
 985         }
 986 done:
 987         put_device(dev);
 988         return error;
 989  DPMError:
 990         bus_remove_device(dev);
 991  BusError:
 992         device_remove_attrs(dev);
 993  AttrsError:
 994         device_remove_class_symlinks(dev);
 995  SymlinkError:
 996         if (MAJOR(dev->devt))
 997                 devtmpfs_delete_node(dev);
 998         if (MAJOR(dev->devt))
 999                 device_remove_sys_dev_entry(dev);
1000  devtattrError:
1001         if (MAJOR(dev->devt))
1002                 device_remove_file(dev, &devt_attr);
1003  ueventattrError:
1004         device_remove_file(dev, &uevent_attr);
1005  attrError:
1006         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1007         kobject_del(&dev->kobj);
1008  Error:
1009         cleanup_device_parent(dev);
1010         if (parent)
1011                 put_device(parent);
1012 name_error:
1013         kfree(dev->p);
1014         dev->p = NULL;
1015         goto done;
1016 }
1017
1018 /**
1019  * device_register - register a device with the system.
1020  * @dev: pointer to the device structure
1021  *
1022  * This happens in two clean steps - initialize the device
1023  * and add it to the system. The two steps can be called
1024  * separately, but this is the easiest and most common.
1025  * I.e. you should only call the two helpers separately if
1026  * have a clearly defined need to use and refcount the device
1027  * before it is added to the hierarchy.
1028  *
1029  * NOTE: _Never_ directly free @dev after calling this function, even
1030  * if it returned an error! Always use put_device() to give up the
1031  * reference initialized in this function instead.
1032  */
1033 int device_register(struct device *dev)
1034 {
1035         device_initialize(dev);
1036         return device_add(dev);
1037 }
1038
1039 /**
1040  * get_device - increment reference count for device.
1041  * @dev: device.
1042  *
1043  * This simply forwards the call to kobject_get(), though
1044  * we do take care to provide for the case that we get a NULL
1045  * pointer passed in.
1046  */
1047 struct device *get_device(struct device *dev)
1048 {
1049         return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1050 }
1051
1052 /**
1053  * put_device - decrement reference count.
1054  * @dev: device in question.
1055  */
1056 void put_device(struct device *dev)
1057 {
1058         /* might_sleep(); */
1059         if (dev)
1060                 kobject_put(&dev->kobj);
1061 }
1062
1063 /**
1064  * device_del - delete device from system.
1065  * @dev: device.
1066  *
1067  * This is the first part of the device unregistration
1068  * sequence. This removes the device from the lists we control
1069  * from here, has it removed from the other driver model
1070  * subsystems it was added to in device_add(), and removes it
1071  * from the kobject hierarchy.
1072  *
1073  * NOTE: this should be called manually _iff_ device_add() was
1074  * also called manually.
1075  */
1076 void device_del(struct device *dev)
1077 {
1078         struct device *parent = dev->parent;
1079         struct class_interface *class_intf;
1080
1081         /* Notify clients of device removal.  This call must come
1082          * before dpm_sysfs_remove().
1083          */
1084         if (dev->bus)
1085                 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1086                                              BUS_NOTIFY_DEL_DEVICE, dev);
1087         device_pm_remove(dev);
1088         dpm_sysfs_remove(dev);
1089         if (parent)
1090                 klist_del(&dev->p->knode_parent);
1091         if (MAJOR(dev->devt)) {
1092                 devtmpfs_delete_node(dev);
1093                 device_remove_sys_dev_entry(dev);
1094                 device_remove_file(dev, &devt_attr);
1095         }
1096         if (dev->class) {
1097                 device_remove_class_symlinks(dev);
1098
1099                 mutex_lock(&dev->class->p->class_mutex);
1100                 /* notify any interfaces that the device is now gone */
1101                 list_for_each_entry(class_intf,
1102                                     &dev->class->p->class_interfaces, node)
1103                         if (class_intf->remove_dev)
1104                                 class_intf->remove_dev(dev, class_intf);
1105                 /* remove the device from the class list */
1106                 klist_del(&dev->knode_class);
1107                 mutex_unlock(&dev->class->p->class_mutex);
1108         }
1109         device_remove_file(dev, &uevent_attr);
1110         device_remove_attrs(dev);
1111         bus_remove_device(dev);
1112
1113         /*
1114          * Some platform devices are driven without driver attached
1115          * and managed resources may have been acquired.  Make sure
1116          * all resources are released.
1117          */
1118         devres_release_all(dev);
1119
1120         /* Notify the platform of the removal, in case they
1121          * need to do anything...
1122          */
1123         if (platform_notify_remove)
1124                 platform_notify_remove(dev);
1125         kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1126         cleanup_device_parent(dev);
1127         kobject_del(&dev->kobj);
1128         put_device(parent);
1129 }
1130
1131 /**
1132  * device_unregister - unregister device from system.
1133  * @dev: device going away.
1134  *
1135  * We do this in two parts, like we do device_register(). First,
1136  * we remove it from all the subsystems with device_del(), then
1137  * we decrement the reference count via put_device(). If that
1138  * is the final reference count, the device will be cleaned up
1139  * via device_release() above. Otherwise, the structure will
1140  * stick around until the final reference to the device is dropped.
1141  */
1142 void device_unregister(struct device *dev)
1143 {
1144         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1145         device_del(dev);
1146         put_device(dev);
1147 }
1148
1149 static struct device *next_device(struct klist_iter *i)
1150 {
1151         struct klist_node *n = klist_next(i);
1152         struct device *dev = NULL;
1153         struct device_private *p;
1154
1155         if (n) {
1156                 p = to_device_private_parent(n);
1157                 dev = p->device;
1158         }
1159         return dev;
1160 }
1161
1162 /**
1163  * device_get_devnode - path of device node file
1164  * @dev: device
1165  * @mode: returned file access mode
1166  * @tmp: possibly allocated string
1167  *
1168  * Return the relative path of a possible device node.
1169  * Non-default names may need to allocate a memory to compose
1170  * a name. This memory is returned in tmp and needs to be
1171  * freed by the caller.
1172  */
1173 const char *device_get_devnode(struct device *dev,
1174                                mode_t *mode, const char **tmp)
1175 {
1176         char *s;
1177
1178         *tmp = NULL;
1179
1180         /* the device type may provide a specific name */
1181         if (dev->type && dev->type->devnode)
1182                 *tmp = dev->type->devnode(dev, mode);
1183         if (*tmp)
1184                 return *tmp;
1185
1186         /* the class may provide a specific name */
1187         if (dev->class && dev->class->devnode)
1188                 *tmp = dev->class->devnode(dev, mode);
1189         if (*tmp)
1190                 return *tmp;
1191
1192         /* return name without allocation, tmp == NULL */
1193         if (strchr(dev_name(dev), '!') == NULL)
1194                 return dev_name(dev);
1195
1196         /* replace '!' in the name with '/' */
1197         *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1198         if (!*tmp)
1199                 return NULL;
1200         while ((s = strchr(*tmp, '!')))
1201                 s[0] = '/';
1202         return *tmp;
1203 }
1204
1205 /**
1206  * device_for_each_child - device child iterator.
1207  * @parent: parent struct device.
1208  * @data: data for the callback.
1209  * @fn: function to be called for each device.
1210  *
1211  * Iterate over @parent's child devices, and call @fn for each,
1212  * passing it @data.
1213  *
1214  * We check the return of @fn each time. If it returns anything
1215  * other than 0, we break out and return that value.
1216  */
1217 int device_for_each_child(struct device *parent, void *data,
1218                           int (*fn)(struct device *dev, void *data))
1219 {
1220         struct klist_iter i;
1221         struct device *child;
1222         int error = 0;
1223
1224         if (!parent->p)
1225                 return 0;
1226
1227         klist_iter_init(&parent->p->klist_children, &i);
1228         while ((child = next_device(&i)) && !error)
1229                 error = fn(child, data);
1230         klist_iter_exit(&i);
1231         return error;
1232 }
1233
1234 /**
1235  * device_find_child - device iterator for locating a particular device.
1236  * @parent: parent struct device
1237  * @data: Data to pass to match function
1238  * @match: Callback function to check device
1239  *
1240  * This is similar to the device_for_each_child() function above, but it
1241  * returns a reference to a device that is 'found' for later use, as
1242  * determined by the @match callback.
1243  *
1244  * The callback should return 0 if the device doesn't match and non-zero
1245  * if it does.  If the callback returns non-zero and a reference to the
1246  * current device can be obtained, this function will return to the caller
1247  * and not iterate over any more devices.
1248  */
1249 struct device *device_find_child(struct device *parent, void *data,
1250                                  int (*match)(struct device *dev, void *data))
1251 {
1252         struct klist_iter i;
1253         struct device *child;
1254
1255         if (!parent)
1256                 return NULL;
1257
1258         klist_iter_init(&parent->p->klist_children, &i);
1259         while ((child = next_device(&i)))
1260                 if (match(child, data) && get_device(child))
1261                         break;
1262         klist_iter_exit(&i);
1263         return child;
1264 }
1265
1266 int __init devices_init(void)
1267 {
1268         devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1269         if (!devices_kset)
1270                 return -ENOMEM;
1271         dev_kobj = kobject_create_and_add("dev", NULL);
1272         if (!dev_kobj)
1273                 goto dev_kobj_err;
1274         sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1275         if (!sysfs_dev_block_kobj)
1276                 goto block_kobj_err;
1277         sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1278         if (!sysfs_dev_char_kobj)
1279                 goto char_kobj_err;
1280
1281         return 0;
1282
1283  char_kobj_err:
1284         kobject_put(sysfs_dev_block_kobj);
1285  block_kobj_err:
1286         kobject_put(dev_kobj);
1287  dev_kobj_err:
1288         kset_unregister(devices_kset);
1289         return -ENOMEM;
1290 }
1291
1292 EXPORT_SYMBOL_GPL(device_for_each_child);
1293 EXPORT_SYMBOL_GPL(device_find_child);
1294
1295 EXPORT_SYMBOL_GPL(device_initialize);
1296 EXPORT_SYMBOL_GPL(device_add);
1297 EXPORT_SYMBOL_GPL(device_register);
1298
1299 EXPORT_SYMBOL_GPL(device_del);
1300 EXPORT_SYMBOL_GPL(device_unregister);
1301 EXPORT_SYMBOL_GPL(get_device);
1302 EXPORT_SYMBOL_GPL(put_device);
1303
1304 EXPORT_SYMBOL_GPL(device_create_file);
1305 EXPORT_SYMBOL_GPL(device_remove_file);
1306
1307 struct root_device
1308 {
1309         struct device dev;
1310         struct module *owner;
1311 };
1312
1313 #define to_root_device(dev) container_of(dev, struct root_device, dev)
1314
1315 static void root_device_release(struct device *dev)
1316 {
1317         kfree(to_root_device(dev));
1318 }
1319
1320 /**
1321  * __root_device_register - allocate and register a root device
1322  * @name: root device name
1323  * @owner: owner module of the root device, usually THIS_MODULE
1324  *
1325  * This function allocates a root device and registers it
1326  * using device_register(). In order to free the returned
1327  * device, use root_device_unregister().
1328  *
1329  * Root devices are dummy devices which allow other devices
1330  * to be grouped under /sys/devices. Use this function to
1331  * allocate a root device and then use it as the parent of
1332  * any device which should appear under /sys/devices/{name}
1333  *
1334  * The /sys/devices/{name} directory will also contain a
1335  * 'module' symlink which points to the @owner directory
1336  * in sysfs.
1337  *
1338  * Note: You probably want to use root_device_register().
1339  */
1340 struct device *__root_device_register(const char *name, struct module *owner)
1341 {
1342         struct root_device *root;
1343         int err = -ENOMEM;
1344
1345         root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1346         if (!root)
1347                 return ERR_PTR(err);
1348
1349         err = dev_set_name(&root->dev, "%s", name);
1350         if (err) {
1351                 kfree(root);
1352                 return ERR_PTR(err);
1353         }
1354
1355         root->dev.release = root_device_release;
1356
1357         err = device_register(&root->dev);
1358         if (err) {
1359                 put_device(&root->dev);
1360                 return ERR_PTR(err);
1361         }
1362
1363 #ifdef CONFIG_MODULE    /* gotta find a "cleaner" way to do this */
1364         if (owner) {
1365                 struct module_kobject *mk = &owner->mkobj;
1366
1367                 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1368                 if (err) {
1369                         device_unregister(&root->dev);
1370                         return ERR_PTR(err);
1371                 }
1372                 root->owner = owner;
1373         }
1374 #endif
1375
1376         return &root->dev;
1377 }
1378 EXPORT_SYMBOL_GPL(__root_device_register);
1379
1380 /**
1381  * root_device_unregister - unregister and free a root device
1382  * @dev: device going away
1383  *
1384  * This function unregisters and cleans up a device that was created by
1385  * root_device_register().
1386  */
1387 void root_device_unregister(struct device *dev)
1388 {
1389         struct root_device *root = to_root_device(dev);
1390
1391         if (root->owner)
1392                 sysfs_remove_link(&root->dev.kobj, "module");
1393
1394         device_unregister(dev);
1395 }
1396 EXPORT_SYMBOL_GPL(root_device_unregister);
1397
1398
1399 static void device_create_release(struct device *dev)
1400 {
1401         pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1402         kfree(dev);
1403 }
1404
1405 /**
1406  * device_create_vargs - creates a device and registers it with sysfs
1407  * @class: pointer to the struct class that this device should be registered to
1408  * @parent: pointer to the parent struct device of this new device, if any
1409  * @devt: the dev_t for the char device to be added
1410  * @drvdata: the data to be added to the device for callbacks
1411  * @fmt: string for the device's name
1412  * @args: va_list for the device's name
1413  *
1414  * This function can be used by char device classes.  A struct device
1415  * will be created in sysfs, registered to the specified class.
1416  *
1417  * A "dev" file will be created, showing the dev_t for the device, if
1418  * the dev_t is not 0,0.
1419  * If a pointer to a parent struct device is passed in, the newly created
1420  * struct device will be a child of that device in sysfs.
1421  * The pointer to the struct device will be returned from the call.
1422  * Any further sysfs files that might be required can be created using this
1423  * pointer.
1424  *
1425  * Note: the struct class passed to this function must have previously
1426  * been created with a call to class_create().
1427  */
1428 struct device *device_create_vargs(struct class *class, struct device *parent,
1429                                    dev_t devt, void *drvdata, const char *fmt,
1430                                    va_list args)
1431 {
1432         struct device *dev = NULL;
1433         int retval = -ENODEV;
1434
1435         if (class == NULL || IS_ERR(class))
1436                 goto error;
1437
1438         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1439         if (!dev) {
1440                 retval = -ENOMEM;
1441                 goto error;
1442         }
1443
1444         dev->devt = devt;
1445         dev->class = class;
1446         dev->parent = parent;
1447         dev->release = device_create_release;
1448         dev_set_drvdata(dev, drvdata);
1449
1450         retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1451         if (retval)
1452                 goto error;
1453
1454         retval = device_register(dev);
1455         if (retval)
1456                 goto error;
1457
1458         return dev;
1459
1460 error:
1461         put_device(dev);
1462         return ERR_PTR(retval);
1463 }
1464 EXPORT_SYMBOL_GPL(device_create_vargs);
1465
1466 /**
1467  * device_create - creates a device and registers it with sysfs
1468  * @class: pointer to the struct class that this device should be registered to
1469  * @parent: pointer to the parent struct device of this new device, if any
1470  * @devt: the dev_t for the char device to be added
1471  * @drvdata: the data to be added to the device for callbacks
1472  * @fmt: string for the device's name
1473  *
1474  * This function can be used by char device classes.  A struct device
1475  * will be created in sysfs, registered to the specified class.
1476  *
1477  * A "dev" file will be created, showing the dev_t for the device, if
1478  * the dev_t is not 0,0.
1479  * If a pointer to a parent struct device is passed in, the newly created
1480  * struct device will be a child of that device in sysfs.
1481  * The pointer to the struct device will be returned from the call.
1482  * Any further sysfs files that might be required can be created using this
1483  * pointer.
1484  *
1485  * Note: the struct class passed to this function must have previously
1486  * been created with a call to class_create().
1487  */
1488 struct device *device_create(struct class *class, struct device *parent,
1489                              dev_t devt, void *drvdata, const char *fmt, ...)
1490 {
1491         va_list vargs;
1492         struct device *dev;
1493
1494         va_start(vargs, fmt);
1495         dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1496         va_end(vargs);
1497         return dev;
1498 }
1499 EXPORT_SYMBOL_GPL(device_create);
1500
1501 static int __match_devt(struct device *dev, void *data)
1502 {
1503         dev_t *devt = data;
1504
1505         return dev->devt == *devt;
1506 }
1507
1508 /**
1509  * device_destroy - removes a device that was created with device_create()
1510  * @class: pointer to the struct class that this device was registered with
1511  * @devt: the dev_t of the device that was previously registered
1512  *
1513  * This call unregisters and cleans up a device that was created with a
1514  * call to device_create().
1515  */
1516 void device_destroy(struct class *class, dev_t devt)
1517 {
1518         struct device *dev;
1519
1520         dev = class_find_device(class, NULL, &devt, __match_devt);
1521         if (dev) {
1522                 put_device(dev);
1523                 device_unregister(dev);
1524         }
1525 }
1526 EXPORT_SYMBOL_GPL(device_destroy);
1527
1528 /**
1529  * device_rename - renames a device
1530  * @dev: the pointer to the struct device to be renamed
1531  * @new_name: the new name of the device
1532  *
1533  * It is the responsibility of the caller to provide mutual
1534  * exclusion between two different calls of device_rename
1535  * on the same device to ensure that new_name is valid and
1536  * won't conflict with other devices.
1537  */
1538 int device_rename(struct device *dev, char *new_name)
1539 {
1540         char *old_class_name = NULL;
1541         char *new_class_name = NULL;
1542         char *old_device_name = NULL;
1543         int error;
1544
1545         dev = get_device(dev);
1546         if (!dev)
1547                 return -EINVAL;
1548
1549         pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1550                  __func__, new_name);
1551
1552 #ifdef CONFIG_SYSFS_DEPRECATED
1553         if ((dev->class) && (dev->parent))
1554                 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1555 #endif
1556
1557         old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1558         if (!old_device_name) {
1559                 error = -ENOMEM;
1560                 goto out;
1561         }
1562
1563         error = kobject_rename(&dev->kobj, new_name);
1564         if (error)
1565                 goto out;
1566
1567 #ifdef CONFIG_SYSFS_DEPRECATED
1568         if (old_class_name) {
1569                 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1570                 if (new_class_name) {
1571                         error = sysfs_create_link_nowarn(&dev->parent->kobj,
1572                                                          &dev->kobj,
1573                                                          new_class_name);
1574                         if (error)
1575                                 goto out;
1576                         sysfs_remove_link(&dev->parent->kobj, old_class_name);
1577                 }
1578         }
1579 #else
1580         if (dev->class) {
1581                 error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
1582                                                  &dev->kobj, dev_name(dev));
1583                 if (error)
1584                         goto out;
1585                 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
1586                                   old_device_name);
1587         }
1588 #endif
1589
1590 out:
1591         put_device(dev);
1592
1593         kfree(new_class_name);
1594         kfree(old_class_name);
1595         kfree(old_device_name);
1596
1597         return error;
1598 }
1599 EXPORT_SYMBOL_GPL(device_rename);
1600
1601 static int device_move_class_links(struct device *dev,
1602                                    struct device *old_parent,
1603                                    struct device *new_parent)
1604 {
1605         int error = 0;
1606 #ifdef CONFIG_SYSFS_DEPRECATED
1607         char *class_name;
1608
1609         class_name = make_class_name(dev->class->name, &dev->kobj);
1610         if (!class_name) {
1611                 error = -ENOMEM;
1612                 goto out;
1613         }
1614         if (old_parent) {
1615                 sysfs_remove_link(&dev->kobj, "device");
1616                 sysfs_remove_link(&old_parent->kobj, class_name);
1617         }
1618         if (new_parent) {
1619                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1620                                           "device");
1621                 if (error)
1622                         goto out;
1623                 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1624                                           class_name);
1625                 if (error)
1626                         sysfs_remove_link(&dev->kobj, "device");
1627         } else
1628                 error = 0;
1629 out:
1630         kfree(class_name);
1631         return error;
1632 #else
1633         if (old_parent)
1634                 sysfs_remove_link(&dev->kobj, "device");
1635         if (new_parent)
1636                 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1637                                           "device");
1638         return error;
1639 #endif
1640 }
1641
1642 /**
1643  * device_move - moves a device to a new parent
1644  * @dev: the pointer to the struct device to be moved
1645  * @new_parent: the new parent of the device (can by NULL)
1646  * @dpm_order: how to reorder the dpm_list
1647  */
1648 int device_move(struct device *dev, struct device *new_parent,
1649                 enum dpm_order dpm_order)
1650 {
1651         int error;
1652         struct device *old_parent;
1653         struct kobject *new_parent_kobj;
1654
1655         dev = get_device(dev);
1656         if (!dev)
1657                 return -EINVAL;
1658
1659         device_pm_lock();
1660         new_parent = get_device(new_parent);
1661         new_parent_kobj = get_device_parent(dev, new_parent);
1662
1663         pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1664                  __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1665         error = kobject_move(&dev->kobj, new_parent_kobj);
1666         if (error) {
1667                 cleanup_glue_dir(dev, new_parent_kobj);
1668                 put_device(new_parent);
1669                 goto out;
1670         }
1671         old_parent = dev->parent;
1672         dev->parent = new_parent;
1673         if (old_parent)
1674                 klist_remove(&dev->p->knode_parent);
1675         if (new_parent) {
1676                 klist_add_tail(&dev->p->knode_parent,
1677                                &new_parent->p->klist_children);
1678                 set_dev_node(dev, dev_to_node(new_parent));
1679         }
1680
1681         if (!dev->class)
1682                 goto out_put;
1683         error = device_move_class_links(dev, old_parent, new_parent);
1684         if (error) {
1685                 /* We ignore errors on cleanup since we're hosed anyway... */
1686                 device_move_class_links(dev, new_parent, old_parent);
1687                 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1688                         if (new_parent)
1689                                 klist_remove(&dev->p->knode_parent);
1690                         dev->parent = old_parent;
1691                         if (old_parent) {
1692                                 klist_add_tail(&dev->p->knode_parent,
1693                                                &old_parent->p->klist_children);
1694                                 set_dev_node(dev, dev_to_node(old_parent));
1695                         }
1696                 }
1697                 cleanup_glue_dir(dev, new_parent_kobj);
1698                 put_device(new_parent);
1699                 goto out;
1700         }
1701         switch (dpm_order) {
1702         case DPM_ORDER_NONE:
1703                 break;
1704         case DPM_ORDER_DEV_AFTER_PARENT:
1705                 device_pm_move_after(dev, new_parent);
1706                 break;
1707         case DPM_ORDER_PARENT_BEFORE_DEV:
1708                 device_pm_move_before(new_parent, dev);
1709                 break;
1710         case DPM_ORDER_DEV_LAST:
1711                 device_pm_move_last(dev);
1712                 break;
1713         }
1714 out_put:
1715         put_device(old_parent);
1716 out:
1717         device_pm_unlock();
1718         put_device(dev);
1719         return error;
1720 }
1721 EXPORT_SYMBOL_GPL(device_move);
1722
1723 /**
1724  * device_shutdown - call ->shutdown() on each device to shutdown.
1725  */
1726 void device_shutdown(void)
1727 {
1728         struct device *dev, *devn;
1729
1730         list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1731                                 kobj.entry) {
1732                 if (dev->bus && dev->bus->shutdown) {
1733                         dev_dbg(dev, "shutdown\n");
1734                         dev->bus->shutdown(dev);
1735                 } else if (dev->driver && dev->driver->shutdown) {
1736                         dev_dbg(dev, "shutdown\n");
1737                         dev->driver->shutdown(dev);
1738                 }
1739         }
1740         async_synchronize_full();
1741 }