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