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