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