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