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/device.h>
  14 #include <linux/module.h>
  15 #include <linux/errno.h>
  16 #include <linux/slab.h>
  17 #include <linux/init.h>
  18 #include <linux/string.h>
  19 #include <linux/mutex.h>
  20 #include <linux/sysfs.h>
  21 #include "base.h"
  22 #include "power/power.h"
  23
  24 /* /sys/devices/system */
  25 static struct kset *system_kset;
  26
  27 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
  28
  29 /*
  30  * sysfs bindings for drivers
  31  */
  32
  33 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
  34
  35
  36 static int __must_check bus_rescan_devices_helper(struct device *dev,
  37                                                 void *data);
  38
  39 static struct bus_type *bus_get(struct bus_type *bus)
  40 {
  41         if (bus) {
  42                 kset_get(&bus->p->subsys);
  43                 return bus;
  44         }
  45         return NULL;
  46 }
  47
  48 static void bus_put(struct bus_type *bus)
  49 {
  50         if (bus)
  51                 kset_put(&bus->p->subsys);
  52 }
  53
  54 static ssize_t drv_attr_show(struct kobject *kobj, struct attribute *attr,
  55                              char *buf)
  56 {
  57         struct driver_attribute *drv_attr = to_drv_attr(attr);
  58         struct driver_private *drv_priv = to_driver(kobj);
  59         ssize_t ret = -EIO;
  60
  61         if (drv_attr->show)
  62                 ret = drv_attr->show(drv_priv->driver, buf);
  63         return ret;
  64 }
  65
  66 static ssize_t drv_attr_store(struct kobject *kobj, struct attribute *attr,
  67                               const char *buf, size_t count)
  68 {
  69         struct driver_attribute *drv_attr = to_drv_attr(attr);
  70         struct driver_private *drv_priv = to_driver(kobj);
  71         ssize_t ret = -EIO;
  72
  73         if (drv_attr->store)
  74                 ret = drv_attr->store(drv_priv->driver, buf, count);
  75         return ret;
  76 }
  77
  78 static const struct sysfs_ops driver_sysfs_ops = {
  79         .show   = drv_attr_show,
  80         .store  = drv_attr_store,
  81 };
  82
  83 static void driver_release(struct kobject *kobj)
  84 {
  85         struct driver_private *drv_priv = to_driver(kobj);
  86
  87         pr_debug("driver: '%s': %s\n", kobject_name(kobj), __func__);
  88         kfree(drv_priv);
  89 }
  90
  91 static struct kobj_type driver_ktype = {
  92         .sysfs_ops      = &driver_sysfs_ops,
  93         .release        = driver_release,
  94 };
  95
  96 /*
  97  * sysfs bindings for buses
  98  */
  99 static ssize_t bus_attr_show(struct kobject *kobj, struct attribute *attr,
 100                              char *buf)
 101 {
 102         struct bus_attribute *bus_attr = to_bus_attr(attr);
 103         struct subsys_private *subsys_priv = to_subsys_private(kobj);
 104         ssize_t ret = 0;
 105
 106         if (bus_attr->show)
 107                 ret = bus_attr->show(subsys_priv->bus, buf);
 108         return ret;
 109 }
 110
 111 static ssize_t bus_attr_store(struct kobject *kobj, struct attribute *attr,
 112                               const char *buf, size_t count)
 113 {
 114         struct bus_attribute *bus_attr = to_bus_attr(attr);
 115         struct subsys_private *subsys_priv = to_subsys_private(kobj);
 116         ssize_t ret = 0;
 117
 118         if (bus_attr->store)
 119                 ret = bus_attr->store(subsys_priv->bus, buf, count);
 120         return ret;
 121 }
 122
 123 static const struct sysfs_ops bus_sysfs_ops = {
 124         .show   = bus_attr_show,
 125         .store  = bus_attr_store,
 126 };
 127
 128 int bus_create_file(struct bus_type *bus, struct bus_attribute *attr)
 129 {
 130         int error;
 131         if (bus_get(bus)) {
 132                 error = sysfs_create_file(&bus->p->subsys.kobj, &attr->attr);
 133                 bus_put(bus);
 134         } else
 135                 error = -EINVAL;
 136         return error;
 137 }
 138 EXPORT_SYMBOL_GPL(bus_create_file);
 139
 140 void bus_remove_file(struct bus_type *bus, struct bus_attribute *attr)
 141 {
 142         if (bus_get(bus)) {
 143                 sysfs_remove_file(&bus->p->subsys.kobj, &attr->attr);
 144                 bus_put(bus);
 145         }
 146 }
 147 EXPORT_SYMBOL_GPL(bus_remove_file);
 148
 149 static void bus_release(struct kobject *kobj)
 150 {
 151         struct subsys_private *priv =
 152                 container_of(kobj, typeof(*priv), subsys.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 static int device_add_attrs(struct bus_type *bus, struct device *dev)
 470 {
 471         int error = 0;
 472         int i;
 473
 474         if (!bus->dev_attrs)
 475                 return 0;
 476
 477         for (i = 0; bus->dev_attrs[i].attr.name; i++) {
 478                 error = device_create_file(dev, &bus->dev_attrs[i]);
 479                 if (error) {
 480                         while (--i >= 0)
 481                                 device_remove_file(dev, &bus->dev_attrs[i]);
 482                         break;
 483                 }
 484         }
 485         return error;
 486 }
 487
 488 static void device_remove_attrs(struct bus_type *bus, struct device *dev)
 489 {
 490         int i;
 491
 492         if (bus->dev_attrs) {
 493                 for (i = 0; bus->dev_attrs[i].attr.name; i++)
 494                         device_remove_file(dev, &bus->dev_attrs[i]);
 495         }
 496 }
 497
 498 /**
 499  * bus_add_device - add device to bus
 500  * @dev: device being added
 501  *
 502  * - Add device's bus attributes.
 503  * - Create links to device's bus.
 504  * - Add the device to its bus's list of devices.
 505  */
 506 int bus_add_device(struct device *dev)
 507 {
 508         struct bus_type *bus = bus_get(dev->bus);
 509         int error = 0;
 510
 511         if (bus) {
 512                 pr_debug("bus: '%s': add device %s\n", bus->name, dev_name(dev));
 513                 error = device_add_attrs(bus, dev);
 514                 if (error)
 515                         goto out_put;
 516                 error = device_add_groups(dev, bus->dev_groups);
 517                 if (error)
 518                         goto out_groups;
 519                 error = sysfs_create_link(&bus->p->devices_kset->kobj,
 520                                                 &dev->kobj, dev_name(dev));
 521                 if (error)
 522                         goto out_id;
 523                 error = sysfs_create_link(&dev->kobj,
 524                                 &dev->bus->p->subsys.kobj, "subsystem");
 525                 if (error)
 526                         goto out_subsys;
 527                 klist_add_tail(&dev->p->knode_bus, &bus->p->klist_devices);
 528         }
 529         return 0;
 530
 531 out_subsys:
 532         sysfs_remove_link(&bus->p->devices_kset->kobj, dev_name(dev));
 533 out_groups:
 534         device_remove_groups(dev, bus->dev_groups);
 535 out_id:
 536         device_remove_attrs(bus, dev);
 537 out_put:
 538         bus_put(dev->bus);
 539         return error;
 540 }
 541
 542 /**
 543  * bus_probe_device - probe drivers for a new device
 544  * @dev: device to probe
 545  *
 546  * - Automatically probe for a driver if the bus allows it.
 547  */
 548 void bus_probe_device(struct device *dev)
 549 {
 550         struct bus_type *bus = dev->bus;
 551         struct subsys_interface *sif;
 552         int ret;
 553
 554         if (!bus)
 555                 return;
 556
 557         if (bus->p->drivers_autoprobe) {
 558                 ret = device_attach(dev);
 559                 WARN_ON(ret < 0);
 560         }
 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 /**
 663  * bus_add_driver - Add a driver to the bus.
 664  * @drv: driver.
 665  */
 666 int bus_add_driver(struct device_driver *drv)
 667 {
 668         struct bus_type *bus;
 669         struct driver_private *priv;
 670         int error = 0;
 671
 672         bus = bus_get(drv->bus);
 673         if (!bus)
 674                 return -EINVAL;
 675
 676         pr_debug("bus: '%s': add driver %s\n", bus->name, drv->name);
 677
 678         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 679         if (!priv) {
 680                 error = -ENOMEM;
 681                 goto out_put_bus;
 682         }
 683         klist_init(&priv->klist_devices, NULL, NULL);
 684         priv->driver = drv;
 685         drv->p = priv;
 686         priv->kobj.kset = bus->p->drivers_kset;
 687         error = kobject_init_and_add(&priv->kobj, &driver_ktype, NULL,
 688                                      "%s", drv->name);
 689         if (error)
 690                 goto out_unregister;
 691
 692         klist_add_tail(&priv->knode_bus, &bus->p->klist_drivers);
 693         if (drv->bus->p->drivers_autoprobe) {
 694                 error = driver_attach(drv);
 695                 if (error)
 696                         goto out_unregister;
 697         }
 698         module_add_driver(drv->owner, drv);
 699
 700         error = driver_create_file(drv, &driver_attr_uevent);
 701         if (error) {
 702                 printk(KERN_ERR "%s: uevent attr (%s) failed\n",
 703                         __func__, drv->name);
 704         }
 705         error = driver_add_groups(drv, bus->drv_groups);
 706         if (error) {
 707                 /* How the hell do we get out of this pickle? Give up */
 708                 printk(KERN_ERR "%s: driver_create_groups(%s) failed\n",
 709                         __func__, drv->name);
 710         }
 711
 712         if (!drv->suppress_bind_attrs) {
 713                 error = add_bind_files(drv);
 714                 if (error) {
 715                         /* Ditto */
 716                         printk(KERN_ERR "%s: add_bind_files(%s) failed\n",
 717                                 __func__, drv->name);
 718                 }
 719         }
 720
 721         return 0;
 722
 723 out_unregister:
 724         kobject_put(&priv->kobj);
 725         kfree(drv->p);
 726         drv->p = NULL;
 727 out_put_bus:
 728         bus_put(bus);
 729         return error;
 730 }
 731
 732 /**
 733  * bus_remove_driver - delete driver from bus's knowledge.
 734  * @drv: driver.
 735  *
 736  * Detach the driver from the devices it controls, and remove
 737  * it from its bus's list of drivers. Finally, we drop the reference
 738  * to the bus we took in bus_add_driver().
 739  */
 740 void bus_remove_driver(struct device_driver *drv)
 741 {
 742         if (!drv->bus)
 743                 return;
 744
 745         if (!drv->suppress_bind_attrs)
 746                 remove_bind_files(drv);
 747         driver_remove_groups(drv, drv->bus->drv_groups);
 748         driver_remove_file(drv, &driver_attr_uevent);
 749         klist_remove(&drv->p->knode_bus);
 750         pr_debug("bus: '%s': remove driver %s\n", drv->bus->name, drv->name);
 751         driver_detach(drv);
 752         module_remove_driver(drv);
 753         kobject_put(&drv->p->kobj);
 754         bus_put(drv->bus);
 755 }
 756
 757 /* Helper for bus_rescan_devices's iter */
 758 static int __must_check bus_rescan_devices_helper(struct device *dev,
 759                                                   void *data)
 760 {
 761         int ret = 0;
 762
 763         if (!dev->driver) {
 764                 if (dev->parent)        /* Needed for USB */
 765                         device_lock(dev->parent);
 766                 ret = device_attach(dev);
 767                 if (dev->parent)
 768                         device_unlock(dev->parent);
 769         }
 770         return ret < 0 ? ret : 0;
 771 }
 772
 773 /**
 774  * bus_rescan_devices - rescan devices on the bus for possible drivers
 775  * @bus: the bus to scan.
 776  *
 777  * This function will look for devices on the bus with no driver
 778  * attached and rescan it against existing drivers to see if it matches
 779  * any by calling device_attach() for the unbound devices.
 780  */
 781 int bus_rescan_devices(struct bus_type *bus)
 782 {
 783         return bus_for_each_dev(bus, NULL, NULL, bus_rescan_devices_helper);
 784 }
 785 EXPORT_SYMBOL_GPL(bus_rescan_devices);
 786
 787 /**
 788  * device_reprobe - remove driver for a device and probe for a new driver
 789  * @dev: the device to reprobe
 790  *
 791  * This function detaches the attached driver (if any) for the given
 792  * device and restarts the driver probing process.  It is intended
 793  * to use if probing criteria changed during a devices lifetime and
 794  * driver attachment should change accordingly.
 795  */
 796 int device_reprobe(struct device *dev)
 797 {
 798         if (dev->driver) {
 799                 if (dev->parent)        /* Needed for USB */
 800                         device_lock(dev->parent);
 801                 device_release_driver(dev);
 802                 if (dev->parent)
 803                         device_unlock(dev->parent);
 804         }
 805         return bus_rescan_devices_helper(dev, NULL);
 806 }
 807 EXPORT_SYMBOL_GPL(device_reprobe);
 808
 809 /**
 810  * find_bus - locate bus by name.
 811  * @name: name of bus.
 812  *
 813  * Call kset_find_obj() to iterate over list of buses to
 814  * find a bus by name. Return bus if found.
 815  *
 816  * Note that kset_find_obj increments bus' reference count.
 817  */
 818 #if 0
 819 struct bus_type *find_bus(char *name)
 820 {
 821         struct kobject *k = kset_find_obj(bus_kset, name);
 822         return k ? to_bus(k) : NULL;
 823 }
 824 #endif  /*  0  */
 825
 826 static int bus_add_groups(struct bus_type *bus,
 827                           const struct attribute_group **groups)
 828 {
 829         return sysfs_create_groups(&bus->p->subsys.kobj, groups);
 830 }
 831
 832 static void bus_remove_groups(struct bus_type *bus,
 833                               const struct attribute_group **groups)
 834 {
 835         sysfs_remove_groups(&bus->p->subsys.kobj, groups);
 836 }
 837
 838 static void klist_devices_get(struct klist_node *n)
 839 {
 840         struct device_private *dev_prv = to_device_private_bus(n);
 841         struct device *dev = dev_prv->device;
 842
 843         get_device(dev);
 844 }
 845
 846 static void klist_devices_put(struct klist_node *n)
 847 {
 848         struct device_private *dev_prv = to_device_private_bus(n);
 849         struct device *dev = dev_prv->device;
 850
 851         put_device(dev);
 852 }
 853
 854 static ssize_t bus_uevent_store(struct bus_type *bus,
 855                                 const char *buf, size_t count)
 856 {
 857         enum kobject_action action;
 858
 859         if (kobject_action_type(buf, count, &action) == 0)
 860                 kobject_uevent(&bus->p->subsys.kobj, action);
 861         return count;
 862 }
 863 static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store);
 864
 865 /**
 866  * bus_register - register a driver-core subsystem
 867  * @bus: bus to register
 868  *
 869  * Once we have that, we register the bus with the kobject
 870  * infrastructure, then register the children subsystems it has:
 871  * the devices and drivers that belong to the subsystem.
 872  */
 873 int bus_register(struct bus_type *bus)
 874 {
 875         int retval;
 876         struct subsys_private *priv;
 877         struct lock_class_key *key = &bus->lock_key;
 878
 879         priv = kzalloc(sizeof(struct subsys_private), GFP_KERNEL);
 880         if (!priv)
 881                 return -ENOMEM;
 882
 883         priv->bus = bus;
 884         bus->p = priv;
 885
 886         BLOCKING_INIT_NOTIFIER_HEAD(&priv->bus_notifier);
 887
 888         retval = kobject_set_name(&priv->subsys.kobj, "%s", bus->name);
 889         if (retval)
 890                 goto out;
 891
 892         priv->subsys.kobj.kset = bus_kset;
 893         priv->subsys.kobj.ktype = &bus_ktype;
 894         priv->drivers_autoprobe = 1;
 895
 896         retval = kset_register(&priv->subsys);
 897         if (retval)
 898                 goto out;
 899
 900         retval = bus_create_file(bus, &bus_attr_uevent);
 901         if (retval)
 902                 goto bus_uevent_fail;
 903
 904         priv->devices_kset = kset_create_and_add("devices", NULL,
 905                                                  &priv->subsys.kobj);
 906         if (!priv->devices_kset) {
 907                 retval = -ENOMEM;
 908                 goto bus_devices_fail;
 909         }
 910
 911         priv->drivers_kset = kset_create_and_add("drivers", NULL,
 912                                                  &priv->subsys.kobj);
 913         if (!priv->drivers_kset) {
 914                 retval = -ENOMEM;
 915                 goto bus_drivers_fail;
 916         }
 917
 918         INIT_LIST_HEAD(&priv->interfaces);
 919         __mutex_init(&priv->mutex, "subsys mutex", key);
 920         klist_init(&priv->klist_devices, klist_devices_get, klist_devices_put);
 921         klist_init(&priv->klist_drivers, NULL, NULL);
 922
 923         retval = add_probe_files(bus);
 924         if (retval)
 925                 goto bus_probe_files_fail;
 926
 927         retval = bus_add_groups(bus, bus->bus_groups);
 928         if (retval)
 929                 goto bus_groups_fail;
 930
 931         pr_debug("bus: '%s': registered\n", bus->name);
 932         return 0;
 933
 934 bus_groups_fail:
 935         remove_probe_files(bus);
 936 bus_probe_files_fail:
 937         kset_unregister(bus->p->drivers_kset);
 938 bus_drivers_fail:
 939         kset_unregister(bus->p->devices_kset);
 940 bus_devices_fail:
 941         bus_remove_file(bus, &bus_attr_uevent);
 942 bus_uevent_fail:
 943         kset_unregister(&bus->p->subsys);
 944 out:
 945         kfree(bus->p);
 946         bus->p = NULL;
 947         return retval;
 948 }
 949 EXPORT_SYMBOL_GPL(bus_register);
 950
 951 /**
 952  * bus_unregister - remove a bus from the system
 953  * @bus: bus.
 954  *
 955  * Unregister the child subsystems and the bus itself.
 956  * Finally, we call bus_put() to release the refcount
 957  */
 958 void bus_unregister(struct bus_type *bus)
 959 {
 960         pr_debug("bus: '%s': unregistering\n", bus->name);
 961         if (bus->dev_root)
 962                 device_unregister(bus->dev_root);
 963         bus_remove_groups(bus, bus->bus_groups);
 964         remove_probe_files(bus);
 965         kset_unregister(bus->p->drivers_kset);
 966         kset_unregister(bus->p->devices_kset);
 967         bus_remove_file(bus, &bus_attr_uevent);
 968         kset_unregister(&bus->p->subsys);
 969 }
 970 EXPORT_SYMBOL_GPL(bus_unregister);
 971
 972 int bus_register_notifier(struct bus_type *bus, struct notifier_block *nb)
 973 {
 974         return blocking_notifier_chain_register(&bus->p->bus_notifier, nb);
 975 }
 976 EXPORT_SYMBOL_GPL(bus_register_notifier);
 977
 978 int bus_unregister_notifier(struct bus_type *bus, struct notifier_block *nb)
 979 {
 980         return blocking_notifier_chain_unregister(&bus->p->bus_notifier, nb);
 981 }
 982 EXPORT_SYMBOL_GPL(bus_unregister_notifier);
 983
 984 struct kset *bus_get_kset(struct bus_type *bus)
 985 {
 986         return &bus->p->subsys;
 987 }
 988 EXPORT_SYMBOL_GPL(bus_get_kset);
 989
 990 struct klist *bus_get_device_klist(struct bus_type *bus)
 991 {
 992         return &bus->p->klist_devices;
 993 }
 994 EXPORT_SYMBOL_GPL(bus_get_device_klist);
 995
 996 /*
 997  * Yes, this forcibly breaks the klist abstraction temporarily.  It
 998  * just wants to sort the klist, not change reference counts and
 999  * take/drop locks rapidly in the process.  It does all this while
1000  * holding the lock for the list, so objects can't otherwise be
1001  * added/removed while we're swizzling.
1002  */
1003 static void device_insertion_sort_klist(struct device *a, struct list_head *list,
1004                                         int (*compare)(const struct device *a,
1005                                                         const struct device *b))
1006 {
1007         struct list_head *pos;
1008         struct klist_node *n;
1009         struct device_private *dev_prv;
1010         struct device *b;
1011
1012         list_for_each(pos, list) {
1013                 n = container_of(pos, struct klist_node, n_node);
1014                 dev_prv = to_device_private_bus(n);
1015                 b = dev_prv->device;
1016                 if (compare(a, b) <= 0) {
1017                         list_move_tail(&a->p->knode_bus.n_node,
1018                                        &b->p->knode_bus.n_node);
1019                         return;
1020                 }
1021         }
1022         list_move_tail(&a->p->knode_bus.n_node, list);
1023 }
1024
1025 void bus_sort_breadthfirst(struct bus_type *bus,
1026                            int (*compare)(const struct device *a,
1027                                           const struct device *b))
1028 {
1029         LIST_HEAD(sorted_devices);
1030         struct list_head *pos, *tmp;
1031         struct klist_node *n;
1032         struct device_private *dev_prv;
1033         struct device *dev;
1034         struct klist *device_klist;
1035
1036         device_klist = bus_get_device_klist(bus);
1037
1038         spin_lock(&device_klist->k_lock);
1039         list_for_each_safe(pos, tmp, &device_klist->k_list) {
1040                 n = container_of(pos, struct klist_node, n_node);
1041                 dev_prv = to_device_private_bus(n);
1042                 dev = dev_prv->device;
1043                 device_insertion_sort_klist(dev, &sorted_devices, compare);
1044         }
1045         list_splice(&sorted_devices, &device_klist->k_list);
1046         spin_unlock(&device_klist->k_lock);
1047 }
1048 EXPORT_SYMBOL_GPL(bus_sort_breadthfirst);
1049
1050 /**
1051  * subsys_dev_iter_init - initialize subsys device iterator
1052  * @iter: subsys iterator to initialize
1053  * @subsys: the subsys we wanna iterate over
1054  * @start: the device to start iterating from, if any
1055  * @type: device_type of the devices to iterate over, NULL for all
1056  *
1057  * Initialize subsys iterator @iter such that it iterates over devices
1058  * of @subsys.  If @start is set, the list iteration will start there,
1059  * otherwise if it is NULL, the iteration starts at the beginning of
1060  * the list.
1061  */
1062 void subsys_dev_iter_init(struct subsys_dev_iter *iter, struct bus_type *subsys,
1063                           struct device *start, const struct device_type *type)
1064 {
1065         struct klist_node *start_knode = NULL;
1066
1067         if (start)
1068                 start_knode = &start->p->knode_bus;
1069         klist_iter_init_node(&subsys->p->klist_devices, &iter->ki, start_knode);
1070         iter->type = type;
1071 }
1072 EXPORT_SYMBOL_GPL(subsys_dev_iter_init);
1073
1074 /**
1075  * subsys_dev_iter_next - iterate to the next device
1076  * @iter: subsys iterator to proceed
1077  *
1078  * Proceed @iter to the next device and return it.  Returns NULL if
1079  * iteration is complete.
1080  *
1081  * The returned device is referenced and won't be released till
1082  * iterator is proceed to the next device or exited.  The caller is
1083  * free to do whatever it wants to do with the device including
1084  * calling back into subsys code.
1085  */
1086 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter)
1087 {
1088         struct klist_node *knode;
1089         struct device *dev;
1090
1091         for (;;) {
1092                 knode = klist_next(&iter->ki);
1093                 if (!knode)
1094                         return NULL;
1095                 dev = container_of(knode, struct device_private, knode_bus)->device;
1096                 if (!iter->type || iter->type == dev->type)
1097                         return dev;
1098         }
1099 }
1100 EXPORT_SYMBOL_GPL(subsys_dev_iter_next);
1101
1102 /**
1103  * subsys_dev_iter_exit - finish iteration
1104  * @iter: subsys iterator to finish
1105  *
1106  * Finish an iteration.  Always call this function after iteration is
1107  * complete whether the iteration ran till the end or not.
1108  */
1109 void subsys_dev_iter_exit(struct subsys_dev_iter *iter)
1110 {
1111         klist_iter_exit(&iter->ki);
1112 }
1113 EXPORT_SYMBOL_GPL(subsys_dev_iter_exit);
1114
1115 int subsys_interface_register(struct subsys_interface *sif)
1116 {
1117         struct bus_type *subsys;
1118         struct subsys_dev_iter iter;
1119         struct device *dev;
1120
1121         if (!sif || !sif->subsys)
1122                 return -ENODEV;
1123
1124         subsys = bus_get(sif->subsys);
1125         if (!subsys)
1126                 return -EINVAL;
1127
1128         mutex_lock(&subsys->p->mutex);
1129         list_add_tail(&sif->node, &subsys->p->interfaces);
1130         if (sif->add_dev) {
1131                 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1132                 while ((dev = subsys_dev_iter_next(&iter)))
1133                         sif->add_dev(dev, sif);
1134                 subsys_dev_iter_exit(&iter);
1135         }
1136         mutex_unlock(&subsys->p->mutex);
1137
1138         return 0;
1139 }
1140 EXPORT_SYMBOL_GPL(subsys_interface_register);
1141
1142 void subsys_interface_unregister(struct subsys_interface *sif)
1143 {
1144         struct bus_type *subsys;
1145         struct subsys_dev_iter iter;
1146         struct device *dev;
1147
1148         if (!sif || !sif->subsys)
1149                 return;
1150
1151         subsys = sif->subsys;
1152
1153         mutex_lock(&subsys->p->mutex);
1154         list_del_init(&sif->node);
1155         if (sif->remove_dev) {
1156                 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1157                 while ((dev = subsys_dev_iter_next(&iter)))
1158                         sif->remove_dev(dev, sif);
1159                 subsys_dev_iter_exit(&iter);
1160         }
1161         mutex_unlock(&subsys->p->mutex);
1162
1163         bus_put(subsys);
1164 }
1165 EXPORT_SYMBOL_GPL(subsys_interface_unregister);
1166
1167 static void system_root_device_release(struct device *dev)
1168 {
1169         kfree(dev);
1170 }
1171
1172 static int subsys_register(struct bus_type *subsys,
1173                            const struct attribute_group **groups,
1174                            struct kobject *parent_of_root)
1175 {
1176         struct device *dev;
1177         int err;
1178
1179         err = bus_register(subsys);
1180         if (err < 0)
1181                 return err;
1182
1183         dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1184         if (!dev) {
1185                 err = -ENOMEM;
1186                 goto err_dev;
1187         }
1188
1189         err = dev_set_name(dev, "%s", subsys->name);
1190         if (err < 0)
1191                 goto err_name;
1192
1193         dev->kobj.parent = parent_of_root;
1194         dev->groups = groups;
1195         dev->release = system_root_device_release;
1196
1197         err = device_register(dev);
1198         if (err < 0)
1199                 goto err_dev_reg;
1200
1201         subsys->dev_root = dev;
1202         return 0;
1203
1204 err_dev_reg:
1205         put_device(dev);
1206         dev = NULL;
1207 err_name:
1208         kfree(dev);
1209 err_dev:
1210         bus_unregister(subsys);
1211         return err;
1212 }
1213
1214 /**
1215  * subsys_system_register - register a subsystem at /sys/devices/system/
1216  * @subsys: system subsystem
1217  * @groups: default attributes for the root device
1218  *
1219  * All 'system' subsystems have a /sys/devices/system/<name> root device
1220  * with the name of the subsystem. The root device can carry subsystem-
1221  * wide attributes. All registered devices are below this single root
1222  * device and are named after the subsystem with a simple enumeration
1223  * number appended. The registered devices are not explicitly named;
1224  * only 'id' in the device needs to be set.
1225  *
1226  * Do not use this interface for anything new, it exists for compatibility
1227  * with bad ideas only. New subsystems should use plain subsystems; and
1228  * add the subsystem-wide attributes should be added to the subsystem
1229  * directory itself and not some create fake root-device placed in
1230  * /sys/devices/system/<name>.
1231  */
1232 int subsys_system_register(struct bus_type *subsys,
1233                            const struct attribute_group **groups)
1234 {
1235         return subsys_register(subsys, groups, &system_kset->kobj);
1236 }
1237 EXPORT_SYMBOL_GPL(subsys_system_register);
1238
1239 /**
1240  * subsys_virtual_register - register a subsystem at /sys/devices/virtual/
1241  * @subsys: virtual subsystem
1242  * @groups: default attributes for the root device
1243  *
1244  * All 'virtual' subsystems have a /sys/devices/system/<name> root device
1245  * with the name of the subystem.  The root device can carry subsystem-wide
1246  * attributes.  All registered devices are below this single root device.
1247  * There's no restriction on device naming.  This is for kernel software
1248  * constructs which need sysfs interface.
1249  */
1250 int subsys_virtual_register(struct bus_type *subsys,
1251                             const struct attribute_group **groups)
1252 {
1253         struct kobject *virtual_dir;
1254
1255         virtual_dir = virtual_device_parent(NULL);
1256         if (!virtual_dir)
1257                 return -ENOMEM;
1258
1259         return subsys_register(subsys, groups, virtual_dir);
1260 }
1261 EXPORT_SYMBOL_GPL(subsys_virtual_register);
1262
1263 int __init buses_init(void)
1264 {
1265         bus_kset = kset_create_and_add("bus", &bus_uevent_ops, NULL);
1266         if (!bus_kset)
1267                 return -ENOMEM;
1268
1269         system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
1270         if (!system_kset)
1271                 return -ENOMEM;
1272
1273         return 0;
1274 }