git.oblomov.eu Git - linux-2.6/blob - drivers/base/core.c

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