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