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