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