drivers/base/bus.c

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