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