drivers/base/bus.c

   1 /*
   2  * bus.c - bus driver management
   3  *
   4  * Copyright (c) 2002-3 Patrick Mochel
   5  * Copyright (c) 2002-3 Open Source Development Labs
   6  * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de>
   7  * Copyright (c) 2007 Novell Inc.
   8  *
   9  * This file is released under the GPLv2
  10  *
  11  */
  12
  13 #include <linux/async.h>
  14 #include <linux/device.h>
  15 #include <linux/module.h>
  16 #include <linux/errno.h>
  17 #include <linux/slab.h>
  18 #include <linux/init.h>
  19 #include <linux/string.h>
  20 #include <linux/mutex.h>
  21 #include <linux/sysfs.h>
  22 #include "base.h"
  23 #include "power/power.h"
  24
  25 /* /sys/devices/system */
  26 static struct kset *system_kset;
  27
  28 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
  29
  30 /*
  31  * sysfs bindings for drivers
  32  */
  33
  34 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
  35
  36 #define DRIVER_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
  37         struct driver_attribute driver_attr_##_name =           \
  38                 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
  39
  40 static int __must_check bus_rescan_devices_helper(struct device *dev,
  41                                                 void *data);
  42
  43 static struct bus_type *bus_get(struct bus_type *bus)
  44 {
  45         if (bus) {
  46                 kset_get(&bus->p->subsys);
  47                 return bus;
  48         }
  49         return NULL;
  50 }
  51
  52 static void bus_put(struct bus_type *bus)
  53 {
  54         if (bus)
  55                 kset_put(&bus->p->subsys);
  56 }
  57
  58 static ssize_t drv_attr_show(struct kobject *kobj, struct attribute *attr,
  59                              char *buf)
  60 {
  61         struct driver_attribute *drv_attr = to_drv_attr(attr);
  62         struct driver_private *drv_priv = to_driver(kobj);
  63         ssize_t ret = -EIO;
  64
  65         if (drv_attr->show)
  66                 ret = drv_attr->show(drv_priv->driver, buf);
  67         return ret;
  68 }
  69
  70 static ssize_t drv_attr_store(struct kobject *kobj, struct attribute *attr,
  71                               const char *buf, size_t count)
  72 {
  73         struct driver_attribute *drv_attr = to_drv_attr(attr);
  74         struct driver_private *drv_priv = to_driver(kobj);
  75         ssize_t ret = -EIO;
  76
  77         if (drv_attr->store)
  78                 ret = drv_attr->store(drv_priv->driver, buf, count);
  79         return ret;
  80 }
  81
  82 static const struct sysfs_ops driver_sysfs_ops = {
  83         .show   = drv_attr_show,
  84         .store  = drv_attr_store,
  85 };
  86
  87 static void driver_release(struct kobject *kobj)
  88 {
  89         struct driver_private *drv_priv = to_driver(kobj);
  90
  91         pr_debug("driver: '%s': %s\n", kobject_name(kobj), __func__);
  92         kfree(drv_priv);
  93 }
  94
  95 static struct kobj_type driver_ktype = {
  96         .sysfs_ops      = &driver_sysfs_ops,
  97         .release        = driver_release,
  98 };
  99
 100 /*
 101  * sysfs bindings for buses
 102  */
 103 static ssize_t bus_attr_show(struct kobject *kobj, struct attribute *attr,
 104                              char *buf)
 105 {
 106         struct bus_attribute *bus_attr = to_bus_attr(attr);
 107         struct subsys_private *subsys_priv = to_subsys_private(kobj);
 108         ssize_t ret = 0;
 109
 110         if (bus_attr->show)
 111                 ret = bus_attr->show(subsys_priv->bus, buf);
 112         return ret;
 113 }
 114
 115 static ssize_t bus_attr_store(struct kobject *kobj, struct attribute *attr,
 116                               const char *buf, size_t count)
 117 {
 118         struct bus_attribute *bus_attr = to_bus_attr(attr);
 119         struct subsys_private *subsys_priv = to_subsys_private(kobj);
 120         ssize_t ret = 0;
 121
 122         if (bus_attr->store)
 123                 ret = bus_attr->store(subsys_priv->bus, buf, count);
 124         return ret;
 125 }
 126
 127 static const struct sysfs_ops bus_sysfs_ops = {
 128         .show   = bus_attr_show,
 129         .store  = bus_attr_store,
 130 };
 131
 132 int bus_create_file(struct bus_type *bus, struct bus_attribute *attr)
 133 {
 134         int error;
 135         if (bus_get(bus)) {
 136                 error = sysfs_create_file(&bus->p->subsys.kobj, &attr->attr);
 137                 bus_put(bus);
 138         } else
 139                 error = -EINVAL;
 140         return error;
 141 }
 142 EXPORT_SYMBOL_GPL(bus_create_file);
 143
 144 void bus_remove_file(struct bus_type *bus, struct bus_attribute *attr)
 145 {
 146         if (bus_get(bus)) {
 147                 sysfs_remove_file(&bus->p->subsys.kobj, &attr->attr);
 148                 bus_put(bus);
 149         }
 150 }
 151 EXPORT_SYMBOL_GPL(bus_remove_file);
 152
 153 static void bus_release(struct kobject *kobj)
 154 {
 155         struct subsys_private *priv = to_subsys_private(kobj);
 156         struct bus_type *bus = priv->bus;
 157
 158         kfree(priv);
 159         bus->p = NULL;
 160 }
 161
 162 static struct kobj_type bus_ktype = {
 163         .sysfs_ops      = &bus_sysfs_ops,
 164         .release        = bus_release,
 165 };
 166
 167 static int bus_uevent_filter(struct kset *kset, struct kobject *kobj)
 168 {
 169         struct kobj_type *ktype = get_ktype(kobj);
 170
 171         if (ktype == &bus_ktype)
 172                 return 1;
 173         return 0;
 174 }
 175
 176 static const struct kset_uevent_ops bus_uevent_ops = {
 177         .filter = bus_uevent_filter,
 178 };
 179
 180 static struct kset *bus_kset;
 181
 182 /* Manually detach a device from its associated driver. */
 183 static ssize_t unbind_store(struct device_driver *drv, const char *buf,
 184                             size_t count)
 185 {
 186         struct bus_type *bus = bus_get(drv->bus);
 187         struct device *dev;
 188         int err = -ENODEV;
 189
 190         dev = bus_find_device_by_name(bus, NULL, buf);
 191         if (dev && dev->driver == drv) {
 192                 if (dev->parent)        /* Needed for USB */
 193                         device_lock(dev->parent);
 194                 device_release_driver(dev);
 195                 if (dev->parent)
 196                         device_unlock(dev->parent);
 197                 err = count;
 198         }
 199         put_device(dev);
 200         bus_put(bus);
 201         return err;
 202 }
 203 static DRIVER_ATTR_IGNORE_LOCKDEP(unbind, S_IWUSR, NULL, unbind_store);
 204
 205 /*
 206  * Manually attach a device to a driver.
 207  * Note: the driver must want to bind to the device,
 208  * it is not possible to override the driver's id table.
 209  */
 210 static ssize_t bind_store(struct device_driver *drv, const char *buf,
 211                           size_t count)
 212 {
 213         struct bus_type *bus = bus_get(drv->bus);
 214         struct device *dev;
 215         int err = -ENODEV;
 216
 217         dev = bus_find_device_by_name(bus, NULL, buf);
 218         if (dev && dev->driver == NULL && driver_match_device(drv, dev)) {
 219                 if (dev->parent)        /* Needed for USB */
 220                         device_lock(dev->parent);
 221                 device_lock(dev);
 222                 err = driver_probe_device(drv, dev);
 223                 device_unlock(dev);
 224                 if (dev->parent)
 225                         device_unlock(dev->parent);
 226
 227                 if (err > 0) {
 228                         /* success */
 229                         err = count;
 230                 } else if (err == 0) {
 231                         /* driver didn't accept device */
 232                         err = -ENODEV;
 233                 }
 234         }
 235         put_device(dev);
 236         bus_put(bus);
 237         return err;
 238 }
 239 static DRIVER_ATTR_IGNORE_LOCKDEP(bind, S_IWUSR, NULL, bind_store);
 240
 241 static ssize_t show_drivers_autoprobe(struct bus_type *bus, char *buf)
 242 {
 243         return sprintf(buf, "%d\n", bus->p->drivers_autoprobe);
 244 }
 245
 246 static ssize_t store_drivers_autoprobe(struct bus_type *bus,
 247                                        const char *buf, size_t count)
 248 {
 249         if (buf[0] == '0')
 250                 bus->p->drivers_autoprobe = 0;
 251         else
 252                 bus->p->drivers_autoprobe = 1;
 253         return count;
 254 }
 255
 256 static ssize_t store_drivers_probe(struct bus_type *bus,
 257                                    const char *buf, size_t count)
 258 {
 259         struct device *dev;
 260         int err = -EINVAL;
 261
 262         dev = bus_find_device_by_name(bus, NULL, buf);
 263         if (!dev)
 264                 return -ENODEV;
 265         if (bus_rescan_devices_helper(dev, NULL) == 0)
 266                 err = count;
 267         put_device(dev);
 268         return err;
 269 }
 270
 271 static struct device *next_device(struct klist_iter *i)
 272 {
 273         struct klist_node *n = klist_next(i);
 274         struct device *dev = NULL;
 275         struct device_private *dev_prv;
 276
 277         if (n) {
 278                 dev_prv = to_device_private_bus(n);
 279                 dev = dev_prv->device;
 280         }
 281         return dev;
 282 }
 283
 284 /**
 285  * bus_for_each_dev - device iterator.
 286  * @bus: bus type.
 287  * @start: device to start iterating from.
 288  * @data: data for the callback.
 289  * @fn: function to be called for each device.
 290  *
 291  * Iterate over @bus's list of devices, and call @fn for each,
 292  * passing it @data. If @start is not NULL, we use that device to
 293  * begin iterating from.
 294  *
 295  * We check the return of @fn each time. If it returns anything
 296  * other than 0, we break out and return that value.
 297  *
 298  * NOTE: The device that returns a non-zero value is not retained
 299  * in any way, nor is its refcount incremented. If the caller needs
 300  * to retain this data, it should do so, and increment the reference
 301  * count in the supplied callback.
 302  */
 303 int bus_for_each_dev(struct bus_type *bus, struct device *start,
 304                      void *data, int (*fn)(struct device *, void *))
 305 {
 306         struct klist_iter i;
 307         struct device *dev;
 308         int error = 0;
 309
 310         if (!bus || !bus->p)
 311                 return -EINVAL;
 312
 313         klist_iter_init_node(&bus->p->klist_devices, &i,
 314                              (start ? &start->p->knode_bus : NULL));
 315         while ((dev = next_device(&i)) && !error)
 316                 error = fn(dev, data);
 317         klist_iter_exit(&i);
 318         return error;
 319 }
 320 EXPORT_SYMBOL_GPL(bus_for_each_dev);
 321
 322 /**
 323  * bus_find_device - device iterator for locating a particular device.
 324  * @bus: bus type
 325  * @start: Device to begin with
 326  * @data: Data to pass to match function
 327  * @match: Callback function to check device
 328  *
 329  * This is similar to the bus_for_each_dev() function above, but it
 330  * returns a reference to a device that is 'found' for later use, as
 331  * determined by the @match callback.
 332  *
 333  * The callback should return 0 if the device doesn't match and non-zero
 334  * if it does.  If the callback returns non-zero, this function will
 335  * return to the caller and not iterate over any more devices.
 336  */
 337 struct device *bus_find_device(struct bus_type *bus,
 338                                struct device *start, void *data,
 339                                int (*match)(struct device *dev, void *data))
 340 {
 341         struct klist_iter i;
 342         struct device *dev;
 343
 344         if (!bus || !bus->p)
 345                 return NULL;
 346
 347         klist_iter_init_node(&bus->p->klist_devices, &i,
 348                              (start ? &start->p->knode_bus : NULL));
 349         while ((dev = next_device(&i)))
 350                 if (match(dev, data) && get_device(dev))
 351                         break;
 352         klist_iter_exit(&i);
 353         return dev;
 354 }
 355 EXPORT_SYMBOL_GPL(bus_find_device);
 356
 357 static int match_name(struct device *dev, void *data)
 358 {
 359         const char *name = data;
 360
 361         return sysfs_streq(name, dev_name(dev));
 362 }
 363
 364 /**
 365  * bus_find_device_by_name - device iterator for locating a particular device of a specific name
 366  * @bus: bus type
 367  * @start: Device to begin with
 368  * @name: name of the device to match
 369  *
 370  * This is similar to the bus_find_device() function above, but it handles
 371  * searching by a name automatically, no need to write another strcmp matching
 372  * function.
 373  */
 374 struct device *bus_find_device_by_name(struct bus_type *bus,
 375                                        struct device *start, const char *name)
 376 {
 377         return bus_find_device(bus, start, (void *)name, match_name);
 378 }
 379 EXPORT_SYMBOL_GPL(bus_find_device_by_name);
 380
 381 /**
 382  * subsys_find_device_by_id - find a device with a specific enumeration number
 383  * @subsys: subsystem
 384  * @id: index 'id' in struct device
 385  * @hint: device to check first
 386  *
 387  * Check the hint's next object and if it is a match return it directly,
 388  * otherwise, fall back to a full list search. Either way a reference for
 389  * the returned object is taken.
 390  */
 391 struct device *subsys_find_device_by_id(struct bus_type *subsys, unsigned int id,
 392                                         struct device *hint)
 393 {
 394         struct klist_iter i;
 395         struct device *dev;
 396
 397         if (!subsys)
 398                 return NULL;
 399
 400         if (hint) {
 401                 klist_iter_init_node(&subsys->p->klist_devices, &i, &hint->p->knode_bus);
 402                 dev = next_device(&i);
 403                 if (dev && dev->id == id && get_device(dev)) {
 404                         klist_iter_exit(&i);
 405                         return dev;
 406                 }
 407                 klist_iter_exit(&i);
 408         }
 409
 410         klist_iter_init_node(&subsys->p->klist_devices, &i, NULL);
 411         while ((dev = next_device(&i))) {
 412                 if (dev->id == id && get_device(dev)) {
 413                         klist_iter_exit(&i);
 414                         return dev;
 415                 }
 416         }
 417         klist_iter_exit(&i);
 418         return NULL;
 419 }
 420 EXPORT_SYMBOL_GPL(subsys_find_device_by_id);
 421
 422 static struct device_driver *next_driver(struct klist_iter *i)
 423 {
 424         struct klist_node *n = klist_next(i);
 425         struct driver_private *drv_priv;
 426
 427         if (n) {
 428                 drv_priv = container_of(n, struct driver_private, knode_bus);
 429                 return drv_priv->driver;
 430         }
 431         return NULL;
 432 }
 433
 434 /**
 435  * bus_for_each_drv - driver iterator
 436  * @bus: bus we're dealing with.
 437  * @start: driver to start iterating on.
 438  * @data: data to pass to the callback.
 439  * @fn: function to call for each driver.
 440  *
 441  * This is nearly identical to the device iterator above.
 442  * We iterate over each driver that belongs to @bus, and call
 443  * @fn for each. If @fn returns anything but 0, we break out
 444  * and return it. If @start is not NULL, we use it as the head
 445  * of the list.
 446  *
 447  * NOTE: we don't return the driver that returns a non-zero
 448  * value, nor do we leave the reference count incremented for that
 449  * driver. If the caller needs to know that info, it must set it
 450  * in the callback. It must also be sure to increment the refcount
 451  * so it doesn't disappear before returning to the caller.
 452  */
 453 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
 454                      void *data, int (*fn)(struct device_driver *, void *))
 455 {
 456         struct klist_iter i;
 457         struct device_driver *drv;
 458         int error = 0;
 459
 460         if (!bus)
 461                 return -EINVAL;
 462
 463         klist_iter_init_node(&bus->p->klist_drivers, &i,
 464                              start ? &start->p->knode_bus : NULL);
 465         while ((drv = next_driver(&i)) && !error)
 466                 error = fn(drv, data);
 467         klist_iter_exit(&i);
 468         return error;
 469 }
 470 EXPORT_SYMBOL_GPL(bus_for_each_drv);
 471
 472 static int device_add_attrs(struct bus_type *bus, struct device *dev)
 473 {
 474         int error = 0;
 475         int i;
 476
 477         if (!bus->dev_attrs)
 478                 return 0;
 479
 480         for (i = 0; bus->dev_attrs[i].attr.name; i++) {
 481                 error = device_create_file(dev, &bus->dev_attrs[i]);
 482                 if (error) {
 483                         while (--i >= 0)
 484                                 device_remove_file(dev, &bus->dev_attrs[i]);
 485                         break;
 486                 }
 487         }
 488         return error;
 489 }
 490
 491 static void device_remove_attrs(struct bus_type *bus, struct device *dev)
 492 {
 493         int i;
 494
 495         if (bus->dev_attrs) {
 496                 for (i = 0; bus->dev_attrs[i].attr.name; i++)
 497                         device_remove_file(dev, &bus->dev_attrs[i]);
 498         }
 499 }
 500
 501 /**
 502  * bus_add_device - add device to bus
 503  * @dev: device being added
 504  *
 505  * - Add device's bus attributes.
 506  * - Create links to device's bus.
 507  * - Add the device to its bus's list of devices.
 508  */
 509 int bus_add_device(struct device *dev)
 510 {
 511         struct bus_type *bus = bus_get(dev->bus);
 512         int error = 0;
 513
 514         if (bus) {
 515                 pr_debug("bus: '%s': add device %s\n", bus->name, dev_name(dev));
 516                 error = device_add_attrs(bus, dev);
 517                 if (error)
 518                         goto out_put;
 519                 error = device_add_groups(dev, bus->dev_groups);
 520                 if (error)
 521                         goto out_id;
 522                 error = sysfs_create_link(&bus->p->devices_kset->kobj,
 523                                                 &dev->kobj, dev_name(dev));
 524                 if (error)
 525                         goto out_groups;
 526                 error = sysfs_create_link(&dev->kobj,
 527                                 &dev->bus->p->subsys.kobj, "subsystem");
 528                 if (error)
 529                         goto out_subsys;
 530                 klist_add_tail(&dev->p->knode_bus, &bus->p->klist_devices);
 531         }
 532         return 0;
 533
 534 out_subsys:
 535         sysfs_remove_link(&bus->p->devices_kset->kobj, dev_name(dev));
 536 out_groups:
 537         device_remove_groups(dev, bus->dev_groups);
 538 out_id:
 539         device_remove_attrs(bus, dev);
 540 out_put:
 541         bus_put(dev->bus);
 542         return error;
 543 }
 544
 545 /**
 546  * bus_probe_device - probe drivers for a new device
 547  * @dev: device to probe
 548  *
 549  * - Automatically probe for a driver if the bus allows it.
 550  */
 551 void bus_probe_device(struct device *dev)
 552 {
 553         struct bus_type *bus = dev->bus;
 554         struct subsys_interface *sif;
 555
 556         if (!bus)
 557                 return;
 558
 559         if (bus->p->drivers_autoprobe)
 560                 device_initial_probe(dev);
 561
 562         mutex_lock(&bus->p->mutex);
 563         list_for_each_entry(sif, &bus->p->interfaces, node)
 564                 if (sif->add_dev)
 565                         sif->add_dev(dev, sif);
 566         mutex_unlock(&bus->p->mutex);
 567 }
 568
 569 /**
 570  * bus_remove_device - remove device from bus
 571  * @dev: device to be removed
 572  *
 573  * - Remove device from all interfaces.
 574  * - Remove symlink from bus' directory.
 575  * - Delete device from bus's list.
 576  * - Detach from its driver.
 577  * - Drop reference taken in bus_add_device().
 578  */
 579 void bus_remove_device(struct device *dev)
 580 {
 581         struct bus_type *bus = dev->bus;
 582         struct subsys_interface *sif;
 583
 584         if (!bus)
 585                 return;
 586
 587         mutex_lock(&bus->p->mutex);
 588         list_for_each_entry(sif, &bus->p->interfaces, node)
 589                 if (sif->remove_dev)
 590                         sif->remove_dev(dev, sif);
 591         mutex_unlock(&bus->p->mutex);
 592
 593         sysfs_remove_link(&dev->kobj, "subsystem");
 594         sysfs_remove_link(&dev->bus->p->devices_kset->kobj,
 595                           dev_name(dev));
 596         device_remove_attrs(dev->bus, dev);
 597         device_remove_groups(dev, dev->bus->dev_groups);
 598         if (klist_node_attached(&dev->p->knode_bus))
 599                 klist_del(&dev->p->knode_bus);
 600
 601         pr_debug("bus: '%s': remove device %s\n",
 602                  dev->bus->name, dev_name(dev));
 603         device_release_driver(dev);
 604         bus_put(dev->bus);
 605 }
 606
 607 static int __must_check add_bind_files(struct device_driver *drv)
 608 {
 609         int ret;
 610
 611         ret = driver_create_file(drv, &driver_attr_unbind);
 612         if (ret == 0) {
 613                 ret = driver_create_file(drv, &driver_attr_bind);
 614                 if (ret)
 615                         driver_remove_file(drv, &driver_attr_unbind);
 616         }
 617         return ret;
 618 }
 619
 620 static void remove_bind_files(struct device_driver *drv)
 621 {
 622         driver_remove_file(drv, &driver_attr_bind);
 623         driver_remove_file(drv, &driver_attr_unbind);
 624 }
 625
 626 static BUS_ATTR(drivers_probe, S_IWUSR, NULL, store_drivers_probe);
 627 static BUS_ATTR(drivers_autoprobe, S_IWUSR | S_IRUGO,
 628                 show_drivers_autoprobe, store_drivers_autoprobe);
 629
 630 static int add_probe_files(struct bus_type *bus)
 631 {
 632         int retval;
 633
 634         retval = bus_create_file(bus, &bus_attr_drivers_probe);
 635         if (retval)
 636                 goto out;
 637
 638         retval = bus_create_file(bus, &bus_attr_drivers_autoprobe);
 639         if (retval)
 640                 bus_remove_file(bus, &bus_attr_drivers_probe);
 641 out:
 642         return retval;
 643 }
 644
 645 static void remove_probe_files(struct bus_type *bus)
 646 {
 647         bus_remove_file(bus, &bus_attr_drivers_autoprobe);
 648         bus_remove_file(bus, &bus_attr_drivers_probe);
 649 }
 650
 651 static ssize_t uevent_store(struct device_driver *drv, const char *buf,
 652                             size_t count)
 653 {
 654         enum kobject_action action;
 655
 656         if (kobject_action_type(buf, count, &action) == 0)
 657                 kobject_uevent(&drv->p->kobj, action);
 658         return count;
 659 }
 660 static DRIVER_ATTR_WO(uevent);
 661
 662 static void driver_attach_async(void *_drv, async_cookie_t cookie)
 663 {
 664         struct device_driver *drv = _drv;
 665         int ret;
 666
 667         ret = driver_attach(drv);
 668
 669         pr_debug("bus: '%s': driver %s async attach completed: %d\n",
 670                  drv->bus->name, drv->name, ret);
 671 }
 672
 673 /**
 674  * bus_add_driver - Add a driver to the bus.
 675  * @drv: driver.
 676  */
 677 int bus_add_driver(struct device_driver *drv)
 678 {
 679         struct bus_type *bus;
 680         struct driver_private *priv;
 681         int error = 0;
 682
 683         bus = bus_get(drv->bus);
 684         if (!bus)
 685                 return -EINVAL;
 686
 687         pr_debug("bus: '%s': add driver %s\n", bus->name, drv->name);
 688
 689         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 690         if (!priv) {
 691                 error = -ENOMEM;
 692                 goto out_put_bus;
 693         }
 694         klist_init(&priv->klist_devices, NULL, NULL);
 695         priv->driver = drv;
 696         drv->p = priv;
 697         priv->kobj.kset = bus->p->drivers_kset;
 698         error = kobject_init_and_add(&priv->kobj, &driver_ktype, NULL,
 699                                      "%s", drv->name);
 700         if (error)
 701                 goto out_unregister;
 702
 703         klist_add_tail(&priv->knode_bus, &bus->p->klist_drivers);
 704         if (drv->bus->p->drivers_autoprobe) {
 705                 if (driver_allows_async_probing(drv)) {
 706                         pr_debug("bus: '%s': probing driver %s asynchronously\n",
 707                                 drv->bus->name, drv->name);
 708                         async_schedule(driver_attach_async, drv);
 709                 } else {
 710                         error = driver_attach(drv);
 711                         if (error)
 712                                 goto out_unregister;
 713                 }
 714         }
 715         module_add_driver(drv->owner, drv);
 716
 717         error = driver_create_file(drv, &driver_attr_uevent);
 718         if (error) {
 719                 printk(KERN_ERR "%s: uevent attr (%s) failed\n",
 720                         __func__, drv->name);
 721         }
 722         error = driver_add_groups(drv, bus->drv_groups);
 723         if (error) {
 724                 /* How the hell do we get out of this pickle? Give up */
 725                 printk(KERN_ERR "%s: driver_create_groups(%s) failed\n",
 726                         __func__, drv->name);
 727         }
 728
 729         if (!drv->suppress_bind_attrs) {
 730                 error = add_bind_files(drv);
 731                 if (error) {
 732                         /* Ditto */
 733                         printk(KERN_ERR "%s: add_bind_files(%s) failed\n",
 734                                 __func__, drv->name);
 735                 }
 736         }
 737
 738         return 0;
 739
 740 out_unregister:
 741         kobject_put(&priv->kobj);
 742         /* drv->p is freed in driver_release()  */
 743         drv->p = NULL;
 744 out_put_bus:
 745         bus_put(bus);
 746         return error;
 747 }
 748
 749 /**
 750  * bus_remove_driver - delete driver from bus's knowledge.
 751  * @drv: driver.
 752  *
 753  * Detach the driver from the devices it controls, and remove
 754  * it from its bus's list of drivers. Finally, we drop the reference
 755  * to the bus we took in bus_add_driver().
 756  */
 757 void bus_remove_driver(struct device_driver *drv)
 758 {
 759         if (!drv->bus)
 760                 return;
 761
 762         if (!drv->suppress_bind_attrs)
 763                 remove_bind_files(drv);
 764         driver_remove_groups(drv, drv->bus->drv_groups);
 765         driver_remove_file(drv, &driver_attr_uevent);
 766         klist_remove(&drv->p->knode_bus);
 767         pr_debug("bus: '%s': remove driver %s\n", drv->bus->name, drv->name);
 768         driver_detach(drv);
 769         module_remove_driver(drv);
 770         kobject_put(&drv->p->kobj);
 771         bus_put(drv->bus);
 772 }
 773
 774 /* Helper for bus_rescan_devices's iter */
 775 static int __must_check bus_rescan_devices_helper(struct device *dev,
 776                                                   void *data)
 777 {
 778         int ret = 0;
 779
 780         if (!dev->driver) {
 781                 if (dev->parent)        /* Needed for USB */
 782                         device_lock(dev->parent);
 783                 ret = device_attach(dev);
 784                 if (dev->parent)
 785                         device_unlock(dev->parent);
 786         }
 787         return ret < 0 ? ret : 0;
 788 }
 789
 790 /**
 791  * bus_rescan_devices - rescan devices on the bus for possible drivers
 792  * @bus: the bus to scan.
 793  *
 794  * This function will look for devices on the bus with no driver
 795  * attached and rescan it against existing drivers to see if it matches
 796  * any by calling device_attach() for the unbound devices.
 797  */
 798 int bus_rescan_devices(struct bus_type *bus)
 799 {
 800         return bus_for_each_dev(bus, NULL, NULL, bus_rescan_devices_helper);
 801 }
 802 EXPORT_SYMBOL_GPL(bus_rescan_devices);
 803
 804 /**
 805  * device_reprobe - remove driver for a device and probe for a new driver
 806  * @dev: the device to reprobe
 807  *
 808  * This function detaches the attached driver (if any) for the given
 809  * device and restarts the driver probing process.  It is intended
 810  * to use if probing criteria changed during a devices lifetime and
 811  * driver attachment should change accordingly.
 812  */
 813 int device_reprobe(struct device *dev)
 814 {
 815         if (dev->driver) {
 816                 if (dev->parent)        /* Needed for USB */
 817                         device_lock(dev->parent);
 818                 device_release_driver(dev);
 819                 if (dev->parent)
 820                         device_unlock(dev->parent);
 821         }
 822         return bus_rescan_devices_helper(dev, NULL);
 823 }
 824 EXPORT_SYMBOL_GPL(device_reprobe);
 825
 826 /**
 827  * find_bus - locate bus by name.
 828  * @name: name of bus.
 829  *
 830  * Call kset_find_obj() to iterate over list of buses to
 831  * find a bus by name. Return bus if found.
 832  *
 833  * Note that kset_find_obj increments bus' reference count.
 834  */
 835 #if 0
 836 struct bus_type *find_bus(char *name)
 837 {
 838         struct kobject *k = kset_find_obj(bus_kset, name);
 839         return k ? to_bus(k) : NULL;
 840 }
 841 #endif  /*  0  */
 842
 843 static int bus_add_groups(struct bus_type *bus,
 844                           const struct attribute_group **groups)
 845 {
 846         return sysfs_create_groups(&bus->p->subsys.kobj, groups);
 847 }
 848
 849 static void bus_remove_groups(struct bus_type *bus,
 850                               const struct attribute_group **groups)
 851 {
 852         sysfs_remove_groups(&bus->p->subsys.kobj, groups);
 853 }
 854
 855 static void klist_devices_get(struct klist_node *n)
 856 {
 857         struct device_private *dev_prv = to_device_private_bus(n);
 858         struct device *dev = dev_prv->device;
 859
 860         get_device(dev);
 861 }
 862
 863 static void klist_devices_put(struct klist_node *n)
 864 {
 865         struct device_private *dev_prv = to_device_private_bus(n);
 866         struct device *dev = dev_prv->device;
 867
 868         put_device(dev);
 869 }
 870
 871 static ssize_t bus_uevent_store(struct bus_type *bus,
 872                                 const char *buf, size_t count)
 873 {
 874         enum kobject_action action;
 875
 876         if (kobject_action_type(buf, count, &action) == 0)
 877                 kobject_uevent(&bus->p->subsys.kobj, action);
 878         return count;
 879 }
 880 static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store);
 881
 882 /**
 883  * bus_register - register a driver-core subsystem
 884  * @bus: bus to register
 885  *
 886  * Once we have that, we register the bus with the kobject
 887  * infrastructure, then register the children subsystems it has:
 888  * the devices and drivers that belong to the subsystem.
 889  */
 890 int bus_register(struct bus_type *bus)
 891 {
 892         int retval;
 893         struct subsys_private *priv;
 894         struct lock_class_key *key = &bus->lock_key;
 895
 896         priv = kzalloc(sizeof(struct subsys_private), GFP_KERNEL);
 897         if (!priv)
 898                 return -ENOMEM;
 899
 900         priv->bus = bus;
 901         bus->p = priv;
 902
 903         BLOCKING_INIT_NOTIFIER_HEAD(&priv->bus_notifier);
 904
 905         retval = kobject_set_name(&priv->subsys.kobj, "%s", bus->name);
 906         if (retval)
 907                 goto out;
 908
 909         priv->subsys.kobj.kset = bus_kset;
 910         priv->subsys.kobj.ktype = &bus_ktype;
 911         priv->drivers_autoprobe = 1;
 912
 913         retval = kset_register(&priv->subsys);
 914         if (retval)
 915                 goto out;
 916
 917         retval = bus_create_file(bus, &bus_attr_uevent);
 918         if (retval)
 919                 goto bus_uevent_fail;
 920
 921         priv->devices_kset = kset_create_and_add("devices", NULL,
 922                                                  &priv->subsys.kobj);
 923         if (!priv->devices_kset) {
 924                 retval = -ENOMEM;
 925                 goto bus_devices_fail;
 926         }
 927
 928         priv->drivers_kset = kset_create_and_add("drivers", NULL,
 929                                                  &priv->subsys.kobj);
 930         if (!priv->drivers_kset) {
 931                 retval = -ENOMEM;
 932                 goto bus_drivers_fail;
 933         }
 934
 935         INIT_LIST_HEAD(&priv->interfaces);
 936         __mutex_init(&priv->mutex, "subsys mutex", key);
 937         klist_init(&priv->klist_devices, klist_devices_get, klist_devices_put);
 938         klist_init(&priv->klist_drivers, NULL, NULL);
 939
 940         retval = add_probe_files(bus);
 941         if (retval)
 942                 goto bus_probe_files_fail;
 943
 944         retval = bus_add_groups(bus, bus->bus_groups);
 945         if (retval)
 946                 goto bus_groups_fail;
 947
 948         pr_debug("bus: '%s': registered\n", bus->name);
 949         return 0;
 950
 951 bus_groups_fail:
 952         remove_probe_files(bus);
 953 bus_probe_files_fail:
 954         kset_unregister(bus->p->drivers_kset);
 955 bus_drivers_fail:
 956         kset_unregister(bus->p->devices_kset);
 957 bus_devices_fail:
 958         bus_remove_file(bus, &bus_attr_uevent);
 959 bus_uevent_fail:
 960         kset_unregister(&bus->p->subsys);
 961 out:
 962         kfree(bus->p);
 963         bus->p = NULL;
 964         return retval;
 965 }
 966 EXPORT_SYMBOL_GPL(bus_register);
 967
 968 /**
 969  * bus_unregister - remove a bus from the system
 970  * @bus: bus.
 971  *
 972  * Unregister the child subsystems and the bus itself.
 973  * Finally, we call bus_put() to release the refcount
 974  */
 975 void bus_unregister(struct bus_type *bus)
 976 {
 977         pr_debug("bus: '%s': unregistering\n", bus->name);
 978         if (bus->dev_root)
 979                 device_unregister(bus->dev_root);
 980         bus_remove_groups(bus, bus->bus_groups);
 981         remove_probe_files(bus);
 982         kset_unregister(bus->p->drivers_kset);
 983         kset_unregister(bus->p->devices_kset);
 984         bus_remove_file(bus, &bus_attr_uevent);
 985         kset_unregister(&bus->p->subsys);
 986 }
 987 EXPORT_SYMBOL_GPL(bus_unregister);
 988
 989 int bus_register_notifier(struct bus_type *bus, struct notifier_block *nb)
 990 {
 991         return blocking_notifier_chain_register(&bus->p->bus_notifier, nb);
 992 }
 993 EXPORT_SYMBOL_GPL(bus_register_notifier);
 994
 995 int bus_unregister_notifier(struct bus_type *bus, struct notifier_block *nb)
 996 {
 997         return blocking_notifier_chain_unregister(&bus->p->bus_notifier, nb);
 998 }
 999 EXPORT_SYMBOL_GPL(bus_unregister_notifier);
1000
1001 struct kset *bus_get_kset(struct bus_type *bus)
1002 {
1003         return &bus->p->subsys;
1004 }
1005 EXPORT_SYMBOL_GPL(bus_get_kset);
1006
1007 struct klist *bus_get_device_klist(struct bus_type *bus)
1008 {
1009         return &bus->p->klist_devices;
1010 }
1011 EXPORT_SYMBOL_GPL(bus_get_device_klist);
1012
1013 /*
1014  * Yes, this forcibly breaks the klist abstraction temporarily.  It
1015  * just wants to sort the klist, not change reference counts and
1016  * take/drop locks rapidly in the process.  It does all this while
1017  * holding the lock for the list, so objects can't otherwise be
1018  * added/removed while we're swizzling.
1019  */
1020 static void device_insertion_sort_klist(struct device *a, struct list_head *list,
1021                                         int (*compare)(const struct device *a,
1022                                                         const struct device *b))
1023 {
1024         struct klist_node *n;
1025         struct device_private *dev_prv;
1026         struct device *b;
1027
1028         list_for_each_entry(n, list, n_node) {
1029                 dev_prv = to_device_private_bus(n);
1030                 b = dev_prv->device;
1031                 if (compare(a, b) <= 0) {
1032                         list_move_tail(&a->p->knode_bus.n_node,
1033                                        &b->p->knode_bus.n_node);
1034                         return;
1035                 }
1036         }
1037         list_move_tail(&a->p->knode_bus.n_node, list);
1038 }
1039
1040 void bus_sort_breadthfirst(struct bus_type *bus,
1041                            int (*compare)(const struct device *a,
1042                                           const struct device *b))
1043 {
1044         LIST_HEAD(sorted_devices);
1045         struct klist_node *n, *tmp;
1046         struct device_private *dev_prv;
1047         struct device *dev;
1048         struct klist *device_klist;
1049
1050         device_klist = bus_get_device_klist(bus);
1051
1052         spin_lock(&device_klist->k_lock);
1053         list_for_each_entry_safe(n, tmp, &device_klist->k_list, n_node) {
1054                 dev_prv = to_device_private_bus(n);
1055                 dev = dev_prv->device;
1056                 device_insertion_sort_klist(dev, &sorted_devices, compare);
1057         }
1058         list_splice(&sorted_devices, &device_klist->k_list);
1059         spin_unlock(&device_klist->k_lock);
1060 }
1061 EXPORT_SYMBOL_GPL(bus_sort_breadthfirst);
1062
1063 /**
1064  * subsys_dev_iter_init - initialize subsys device iterator
1065  * @iter: subsys iterator to initialize
1066  * @subsys: the subsys we wanna iterate over
1067  * @start: the device to start iterating from, if any
1068  * @type: device_type of the devices to iterate over, NULL for all
1069  *
1070  * Initialize subsys iterator @iter such that it iterates over devices
1071  * of @subsys.  If @start is set, the list iteration will start there,
1072  * otherwise if it is NULL, the iteration starts at the beginning of
1073  * the list.
1074  */
1075 void subsys_dev_iter_init(struct subsys_dev_iter *iter, struct bus_type *subsys,
1076                           struct device *start, const struct device_type *type)
1077 {
1078         struct klist_node *start_knode = NULL;
1079
1080         if (start)
1081                 start_knode = &start->p->knode_bus;
1082         klist_iter_init_node(&subsys->p->klist_devices, &iter->ki, start_knode);
1083         iter->type = type;
1084 }
1085 EXPORT_SYMBOL_GPL(subsys_dev_iter_init);
1086
1087 /**
1088  * subsys_dev_iter_next - iterate to the next device
1089  * @iter: subsys iterator to proceed
1090  *
1091  * Proceed @iter to the next device and return it.  Returns NULL if
1092  * iteration is complete.
1093  *
1094  * The returned device is referenced and won't be released till
1095  * iterator is proceed to the next device or exited.  The caller is
1096  * free to do whatever it wants to do with the device including
1097  * calling back into subsys code.
1098  */
1099 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter)
1100 {
1101         struct klist_node *knode;
1102         struct device *dev;
1103
1104         for (;;) {
1105                 knode = klist_next(&iter->ki);
1106                 if (!knode)
1107                         return NULL;
1108                 dev = to_device_private_bus(knode)->device;
1109                 if (!iter->type || iter->type == dev->type)
1110                         return dev;
1111         }
1112 }
1113 EXPORT_SYMBOL_GPL(subsys_dev_iter_next);
1114
1115 /**
1116  * subsys_dev_iter_exit - finish iteration
1117  * @iter: subsys iterator to finish
1118  *
1119  * Finish an iteration.  Always call this function after iteration is
1120  * complete whether the iteration ran till the end or not.
1121  */
1122 void subsys_dev_iter_exit(struct subsys_dev_iter *iter)
1123 {
1124         klist_iter_exit(&iter->ki);
1125 }
1126 EXPORT_SYMBOL_GPL(subsys_dev_iter_exit);
1127
1128 int subsys_interface_register(struct subsys_interface *sif)
1129 {
1130         struct bus_type *subsys;
1131         struct subsys_dev_iter iter;
1132         struct device *dev;
1133
1134         if (!sif || !sif->subsys)
1135                 return -ENODEV;
1136
1137         subsys = bus_get(sif->subsys);
1138         if (!subsys)
1139                 return -EINVAL;
1140
1141         mutex_lock(&subsys->p->mutex);
1142         list_add_tail(&sif->node, &subsys->p->interfaces);
1143         if (sif->add_dev) {
1144                 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1145                 while ((dev = subsys_dev_iter_next(&iter)))
1146                         sif->add_dev(dev, sif);
1147                 subsys_dev_iter_exit(&iter);
1148         }
1149         mutex_unlock(&subsys->p->mutex);
1150
1151         return 0;
1152 }
1153 EXPORT_SYMBOL_GPL(subsys_interface_register);
1154
1155 void subsys_interface_unregister(struct subsys_interface *sif)
1156 {
1157         struct bus_type *subsys;
1158         struct subsys_dev_iter iter;
1159         struct device *dev;
1160
1161         if (!sif || !sif->subsys)
1162                 return;
1163
1164         subsys = sif->subsys;
1165
1166         mutex_lock(&subsys->p->mutex);
1167         list_del_init(&sif->node);
1168         if (sif->remove_dev) {
1169                 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1170                 while ((dev = subsys_dev_iter_next(&iter)))
1171                         sif->remove_dev(dev, sif);
1172                 subsys_dev_iter_exit(&iter);
1173         }
1174         mutex_unlock(&subsys->p->mutex);
1175
1176         bus_put(subsys);
1177 }
1178 EXPORT_SYMBOL_GPL(subsys_interface_unregister);
1179
1180 static void system_root_device_release(struct device *dev)
1181 {
1182         kfree(dev);
1183 }
1184
1185 static int subsys_register(struct bus_type *subsys,
1186                            const struct attribute_group **groups,
1187                            struct kobject *parent_of_root)
1188 {
1189         struct device *dev;
1190         int err;
1191
1192         err = bus_register(subsys);
1193         if (err < 0)
1194                 return err;
1195
1196         dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1197         if (!dev) {
1198                 err = -ENOMEM;
1199                 goto err_dev;
1200         }
1201
1202         err = dev_set_name(dev, "%s", subsys->name);
1203         if (err < 0)
1204                 goto err_name;
1205
1206         dev->kobj.parent = parent_of_root;
1207         dev->groups = groups;
1208         dev->release = system_root_device_release;
1209
1210         err = device_register(dev);
1211         if (err < 0)
1212                 goto err_dev_reg;
1213
1214         subsys->dev_root = dev;
1215         return 0;
1216
1217 err_dev_reg:
1218         put_device(dev);
1219         dev = NULL;
1220 err_name:
1221         kfree(dev);
1222 err_dev:
1223         bus_unregister(subsys);
1224         return err;
1225 }
1226
1227 /**
1228  * subsys_system_register - register a subsystem at /sys/devices/system/
1229  * @subsys: system subsystem
1230  * @groups: default attributes for the root device
1231  *
1232  * All 'system' subsystems have a /sys/devices/system/<name> root device
1233  * with the name of the subsystem. The root device can carry subsystem-
1234  * wide attributes. All registered devices are below this single root
1235  * device and are named after the subsystem with a simple enumeration
1236  * number appended. The registered devices are not explicitly named;
1237  * only 'id' in the device needs to be set.
1238  *
1239  * Do not use this interface for anything new, it exists for compatibility
1240  * with bad ideas only. New subsystems should use plain subsystems; and
1241  * add the subsystem-wide attributes should be added to the subsystem
1242  * directory itself and not some create fake root-device placed in
1243  * /sys/devices/system/<name>.
1244  */
1245 int subsys_system_register(struct bus_type *subsys,
1246                            const struct attribute_group **groups)
1247 {
1248         return subsys_register(subsys, groups, &system_kset->kobj);
1249 }
1250 EXPORT_SYMBOL_GPL(subsys_system_register);
1251
1252 /**
1253  * subsys_virtual_register - register a subsystem at /sys/devices/virtual/
1254  * @subsys: virtual subsystem
1255  * @groups: default attributes for the root device
1256  *
1257  * All 'virtual' subsystems have a /sys/devices/system/<name> root device
1258  * with the name of the subystem.  The root device can carry subsystem-wide
1259  * attributes.  All registered devices are below this single root device.
1260  * There's no restriction on device naming.  This is for kernel software
1261  * constructs which need sysfs interface.
1262  */
1263 int subsys_virtual_register(struct bus_type *subsys,
1264                             const struct attribute_group **groups)
1265 {
1266         struct kobject *virtual_dir;
1267
1268         virtual_dir = virtual_device_parent(NULL);
1269         if (!virtual_dir)
1270                 return -ENOMEM;
1271
1272         return subsys_register(subsys, groups, virtual_dir);
1273 }
1274 EXPORT_SYMBOL_GPL(subsys_virtual_register);
1275
1276 int __init buses_init(void)
1277 {
1278         bus_kset = kset_create_and_add("bus", &bus_uevent_ops, NULL);
1279         if (!bus_kset)
1280                 return -ENOMEM;
1281
1282         system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
1283         if (!system_kset)
1284                 return -ENOMEM;
1285
1286         return 0;
1287 }