drivers/base/core.c

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