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  *
   7  * This file is released under the GPLv2
   8  *
   9  */
  10
  11 #include <linux/config.h>
  12 #include <linux/device.h>
  13 #include <linux/module.h>
  14 #include <linux/errno.h>
  15 #include <linux/init.h>
  16 #include <linux/string.h>
  17 #include "base.h"
  18 #include "power/power.h"
  19
  20 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
  21 #define to_bus(obj) container_of(obj, struct bus_type, subsys.kset.kobj)
  22
  23 /*
  24  * sysfs bindings for drivers
  25  */
  26
  27 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
  28 #define to_driver(obj) container_of(obj, struct device_driver, kobj)
  29
  30
  31 static ssize_t
  32 drv_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
  33 {
  34         struct driver_attribute * drv_attr = to_drv_attr(attr);
  35         struct device_driver * drv = to_driver(kobj);
  36         ssize_t ret = -EIO;
  37
  38         if (drv_attr->show)
  39                 ret = drv_attr->show(drv, buf);
  40         return ret;
  41 }
  42
  43 static ssize_t
  44 drv_attr_store(struct kobject * kobj, struct attribute * attr,
  45                const char * buf, size_t count)
  46 {
  47         struct driver_attribute * drv_attr = to_drv_attr(attr);
  48         struct device_driver * drv = to_driver(kobj);
  49         ssize_t ret = -EIO;
  50
  51         if (drv_attr->store)
  52                 ret = drv_attr->store(drv, buf, count);
  53         return ret;
  54 }
  55
  56 static struct sysfs_ops driver_sysfs_ops = {
  57         .show   = drv_attr_show,
  58         .store  = drv_attr_store,
  59 };
  60
  61
  62 static void driver_release(struct kobject * kobj)
  63 {
  64         struct device_driver * drv = to_driver(kobj);
  65         complete(&drv->unloaded);
  66 }
  67
  68 static struct kobj_type ktype_driver = {
  69         .sysfs_ops      = &driver_sysfs_ops,
  70         .release        = driver_release,
  71 };
  72
  73
  74 /*
  75  * sysfs bindings for buses
  76  */
  77
  78
  79 static ssize_t
  80 bus_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
  81 {
  82         struct bus_attribute * bus_attr = to_bus_attr(attr);
  83         struct bus_type * bus = to_bus(kobj);
  84         ssize_t ret = 0;
  85
  86         if (bus_attr->show)
  87                 ret = bus_attr->show(bus, buf);
  88         return ret;
  89 }
  90
  91 static ssize_t
  92 bus_attr_store(struct kobject * kobj, struct attribute * attr,
  93                const char * buf, size_t count)
  94 {
  95         struct bus_attribute * bus_attr = to_bus_attr(attr);
  96         struct bus_type * bus = to_bus(kobj);
  97         ssize_t ret = 0;
  98
  99         if (bus_attr->store)
 100                 ret = bus_attr->store(bus, buf, count);
 101         return ret;
 102 }
 103
 104 static struct sysfs_ops bus_sysfs_ops = {
 105         .show   = bus_attr_show,
 106         .store  = bus_attr_store,
 107 };
 108
 109 int bus_create_file(struct bus_type * bus, struct bus_attribute * attr)
 110 {
 111         int error;
 112         if (get_bus(bus)) {
 113                 error = sysfs_create_file(&bus->subsys.kset.kobj, &attr->attr);
 114                 put_bus(bus);
 115         } else
 116                 error = -EINVAL;
 117         return error;
 118 }
 119
 120 void bus_remove_file(struct bus_type * bus, struct bus_attribute * attr)
 121 {
 122         if (get_bus(bus)) {
 123                 sysfs_remove_file(&bus->subsys.kset.kobj, &attr->attr);
 124                 put_bus(bus);
 125         }
 126 }
 127
 128 static struct kobj_type ktype_bus = {
 129         .sysfs_ops      = &bus_sysfs_ops,
 130
 131 };
 132
 133 decl_subsys(bus, &ktype_bus, NULL);
 134
 135
 136 static struct device * next_device(struct klist_iter * i)
 137 {
 138         struct klist_node * n = klist_next(i);
 139         return n ? container_of(n, struct device, knode_bus) : NULL;
 140 }
 141
 142 /**
 143  *      bus_for_each_dev - device iterator.
 144  *      @bus:   bus type.
 145  *      @start: device to start iterating from.
 146  *      @data:  data for the callback.
 147  *      @fn:    function to be called for each device.
 148  *
 149  *      Iterate over @bus's list of devices, and call @fn for each,
 150  *      passing it @data. If @start is not NULL, we use that device to
 151  *      begin iterating from.
 152  *
 153  *      We check the return of @fn each time. If it returns anything
 154  *      other than 0, we break out and return that value.
 155  *
 156  *      NOTE: The device that returns a non-zero value is not retained
 157  *      in any way, nor is its refcount incremented. If the caller needs
 158  *      to retain this data, it should do, and increment the reference
 159  *      count in the supplied callback.
 160  */
 161
 162 int bus_for_each_dev(struct bus_type * bus, struct device * start,
 163                      void * data, int (*fn)(struct device *, void *))
 164 {
 165         struct klist_iter i;
 166         struct device * dev;
 167         int error = 0;
 168
 169         if (!bus)
 170                 return -EINVAL;
 171
 172         klist_iter_init_node(&bus->klist_devices, &i,
 173                              (start ? &start->knode_bus : NULL));
 174         while ((dev = next_device(&i)) && !error)
 175                 error = fn(dev, data);
 176         klist_iter_exit(&i);
 177         return error;
 178 }
 179
 180
 181
 182 static struct device_driver * next_driver(struct klist_iter * i)
 183 {
 184         struct klist_node * n = klist_next(i);
 185         return n ? container_of(n, struct device_driver, knode_bus) : NULL;
 186 }
 187
 188 /**
 189  *      bus_for_each_drv - driver iterator
 190  *      @bus:   bus we're dealing with.
 191  *      @start: driver to start iterating on.
 192  *      @data:  data to pass to the callback.
 193  *      @fn:    function to call for each driver.
 194  *
 195  *      This is nearly identical to the device iterator above.
 196  *      We iterate over each driver that belongs to @bus, and call
 197  *      @fn for each. If @fn returns anything but 0, we break out
 198  *      and return it. If @start is not NULL, we use it as the head
 199  *      of the list.
 200  *
 201  *      NOTE: we don't return the driver that returns a non-zero
 202  *      value, nor do we leave the reference count incremented for that
 203  *      driver. If the caller needs to know that info, it must set it
 204  *      in the callback. It must also be sure to increment the refcount
 205  *      so it doesn't disappear before returning to the caller.
 206  */
 207
 208 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
 209                      void * data, int (*fn)(struct device_driver *, void *))
 210 {
 211         struct klist_iter i;
 212         struct device_driver * drv;
 213         int error = 0;
 214
 215         if (!bus)
 216                 return -EINVAL;
 217
 218         klist_iter_init_node(&bus->klist_drivers, &i,
 219                              start ? &start->knode_bus : NULL);
 220         while ((drv = next_driver(&i)) && !error)
 221                 error = fn(drv, data);
 222         klist_iter_exit(&i);
 223         return error;
 224 }
 225
 226 static int device_add_attrs(struct bus_type * bus, struct device * dev)
 227 {
 228         int error = 0;
 229         int i;
 230
 231         if (bus->dev_attrs) {
 232                 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
 233                         error = device_create_file(dev,&bus->dev_attrs[i]);
 234                         if (error)
 235                                 goto Err;
 236                 }
 237         }
 238  Done:
 239         return error;
 240  Err:
 241         while (--i >= 0)
 242                 device_remove_file(dev,&bus->dev_attrs[i]);
 243         goto Done;
 244 }
 245
 246
 247 static void device_remove_attrs(struct bus_type * bus, struct device * dev)
 248 {
 249         int i;
 250
 251         if (bus->dev_attrs) {
 252                 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
 253                         device_remove_file(dev,&bus->dev_attrs[i]);
 254         }
 255 }
 256
 257
 258 /**
 259  *      bus_add_device - add device to bus
 260  *      @dev:   device being added
 261  *
 262  *      - Add the device to its bus's list of devices.
 263  *      - Try to attach to driver.
 264  *      - Create link to device's physical location.
 265  */
 266 int bus_add_device(struct device * dev)
 267 {
 268         struct bus_type * bus = get_bus(dev->bus);
 269         int error = 0;
 270
 271         if (bus) {
 272                 pr_debug("bus %s: add device %s\n", bus->name, dev->bus_id);
 273                 error = device_attach(dev);
 274                 klist_add_tail(&bus->klist_devices, &dev->knode_bus);
 275                 if (error >= 0)
 276                         error = device_add_attrs(bus, dev);
 277                 if (!error) {
 278                         sysfs_create_link(&bus->devices.kobj, &dev->kobj, dev->bus_id);
 279                         sysfs_create_link(&dev->kobj, &dev->bus->subsys.kset.kobj, "bus");
 280                 }
 281         }
 282         return error;
 283 }
 284
 285 /**
 286  *      bus_remove_device - remove device from bus
 287  *      @dev:   device to be removed
 288  *
 289  *      - Remove symlink from bus's directory.
 290  *      - Delete device from bus's list.
 291  *      - Detach from its driver.
 292  *      - Drop reference taken in bus_add_device().
 293  */
 294 void bus_remove_device(struct device * dev)
 295 {
 296         if (dev->bus) {
 297                 sysfs_remove_link(&dev->kobj, "bus");
 298                 sysfs_remove_link(&dev->bus->devices.kobj, dev->bus_id);
 299                 device_remove_attrs(dev->bus, dev);
 300                 klist_remove(&dev->knode_bus);
 301                 pr_debug("bus %s: remove device %s\n", dev->bus->name, dev->bus_id);
 302                 device_release_driver(dev);
 303                 put_bus(dev->bus);
 304         }
 305 }
 306
 307 static int driver_add_attrs(struct bus_type * bus, struct device_driver * drv)
 308 {
 309         int error = 0;
 310         int i;
 311
 312         if (bus->drv_attrs) {
 313                 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
 314                         error = driver_create_file(drv, &bus->drv_attrs[i]);
 315                         if (error)
 316                                 goto Err;
 317                 }
 318         }
 319  Done:
 320         return error;
 321  Err:
 322         while (--i >= 0)
 323                 driver_remove_file(drv, &bus->drv_attrs[i]);
 324         goto Done;
 325 }
 326
 327
 328 static void driver_remove_attrs(struct bus_type * bus, struct device_driver * drv)
 329 {
 330         int i;
 331
 332         if (bus->drv_attrs) {
 333                 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
 334                         driver_remove_file(drv, &bus->drv_attrs[i]);
 335         }
 336 }
 337
 338
 339 /**
 340  *      bus_add_driver - Add a driver to the bus.
 341  *      @drv:   driver.
 342  *
 343  */
 344 int bus_add_driver(struct device_driver * drv)
 345 {
 346         struct bus_type * bus = get_bus(drv->bus);
 347         int error = 0;
 348
 349         if (bus) {
 350                 pr_debug("bus %s: add driver %s\n", bus->name, drv->name);
 351                 error = kobject_set_name(&drv->kobj, "%s", drv->name);
 352                 if (error) {
 353                         put_bus(bus);
 354                         return error;
 355                 }
 356                 drv->kobj.kset = &bus->drivers;
 357                 if ((error = kobject_register(&drv->kobj))) {
 358                         put_bus(bus);
 359                         return error;
 360                 }
 361
 362                 driver_attach(drv);
 363                 klist_add_tail(&bus->klist_drivers, &drv->knode_bus);
 364                 module_add_driver(drv->owner, drv);
 365
 366                 driver_add_attrs(bus, drv);
 367         }
 368         return error;
 369 }
 370
 371
 372 /**
 373  *      bus_remove_driver - delete driver from bus's knowledge.
 374  *      @drv:   driver.
 375  *
 376  *      Detach the driver from the devices it controls, and remove
 377  *      it from its bus's list of drivers. Finally, we drop the reference
 378  *      to the bus we took in bus_add_driver().
 379  */
 380
 381 void bus_remove_driver(struct device_driver * drv)
 382 {
 383         if (drv->bus) {
 384                 driver_remove_attrs(drv->bus, drv);
 385                 klist_remove(&drv->knode_bus);
 386                 pr_debug("bus %s: remove driver %s\n", drv->bus->name, drv->name);
 387                 driver_detach(drv);
 388                 module_remove_driver(drv);
 389                 kobject_unregister(&drv->kobj);
 390                 put_bus(drv->bus);
 391         }
 392 }
 393
 394
 395 /* Helper for bus_rescan_devices's iter */
 396 static int bus_rescan_devices_helper(struct device *dev, void *data)
 397 {
 398         int *count = data;
 399
 400         if (!dev->driver && (device_attach(dev) > 0))
 401                 (*count)++;
 402
 403         return 0;
 404 }
 405
 406
 407 /**
 408  *      bus_rescan_devices - rescan devices on the bus for possible drivers
 409  *      @bus:   the bus to scan.
 410  *
 411  *      This function will look for devices on the bus with no driver
 412  *      attached and rescan it against existing drivers to see if it
 413  *      matches any. Calls device_attach(). Returns the number of devices
 414  *      that were sucessfully bound to a driver.
 415  */
 416 int bus_rescan_devices(struct bus_type * bus)
 417 {
 418         int count = 0;
 419
 420         bus_for_each_dev(bus, NULL, &count, bus_rescan_devices_helper);
 421
 422         return count;
 423 }
 424
 425
 426 struct bus_type * get_bus(struct bus_type * bus)
 427 {
 428         return bus ? container_of(subsys_get(&bus->subsys), struct bus_type, subsys) : NULL;
 429 }
 430
 431 void put_bus(struct bus_type * bus)
 432 {
 433         subsys_put(&bus->subsys);
 434 }
 435
 436
 437 /**
 438  *      find_bus - locate bus by name.
 439  *      @name:  name of bus.
 440  *
 441  *      Call kset_find_obj() to iterate over list of buses to
 442  *      find a bus by name. Return bus if found.
 443  *
 444  *      Note that kset_find_obj increments bus' reference count.
 445  */
 446
 447 struct bus_type * find_bus(char * name)
 448 {
 449         struct kobject * k = kset_find_obj(&bus_subsys.kset, name);
 450         return k ? to_bus(k) : NULL;
 451 }
 452
 453
 454 /**
 455  *      bus_add_attrs - Add default attributes for this bus.
 456  *      @bus:   Bus that has just been registered.
 457  */
 458
 459 static int bus_add_attrs(struct bus_type * bus)
 460 {
 461         int error = 0;
 462         int i;
 463
 464         if (bus->bus_attrs) {
 465                 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
 466                         if ((error = bus_create_file(bus,&bus->bus_attrs[i])))
 467                                 goto Err;
 468                 }
 469         }
 470  Done:
 471         return error;
 472  Err:
 473         while (--i >= 0)
 474                 bus_remove_file(bus,&bus->bus_attrs[i]);
 475         goto Done;
 476 }
 477
 478 static void bus_remove_attrs(struct bus_type * bus)
 479 {
 480         int i;
 481
 482         if (bus->bus_attrs) {
 483                 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
 484                         bus_remove_file(bus,&bus->bus_attrs[i]);
 485         }
 486 }
 487
 488 /**
 489  *      bus_register - register a bus with the system.
 490  *      @bus:   bus.
 491  *
 492  *      Once we have that, we registered the bus with the kobject
 493  *      infrastructure, then register the children subsystems it has:
 494  *      the devices and drivers that belong to the bus.
 495  */
 496 int bus_register(struct bus_type * bus)
 497 {
 498         int retval;
 499
 500         retval = kobject_set_name(&bus->subsys.kset.kobj, "%s", bus->name);
 501         if (retval)
 502                 goto out;
 503
 504         subsys_set_kset(bus, bus_subsys);
 505         retval = subsystem_register(&bus->subsys);
 506         if (retval)
 507                 goto out;
 508
 509         kobject_set_name(&bus->devices.kobj, "devices");
 510         bus->devices.subsys = &bus->subsys;
 511         retval = kset_register(&bus->devices);
 512         if (retval)
 513                 goto bus_devices_fail;
 514
 515         kobject_set_name(&bus->drivers.kobj, "drivers");
 516         bus->drivers.subsys = &bus->subsys;
 517         bus->drivers.ktype = &ktype_driver;
 518         retval = kset_register(&bus->drivers);
 519         if (retval)
 520                 goto bus_drivers_fail;
 521
 522         klist_init(&bus->klist_devices);
 523         klist_init(&bus->klist_drivers);
 524         bus_add_attrs(bus);
 525
 526         pr_debug("bus type '%s' registered\n", bus->name);
 527         return 0;
 528
 529 bus_drivers_fail:
 530         kset_unregister(&bus->devices);
 531 bus_devices_fail:
 532         subsystem_unregister(&bus->subsys);
 533 out:
 534         return retval;
 535 }
 536
 537
 538 /**
 539  *      bus_unregister - remove a bus from the system
 540  *      @bus:   bus.
 541  *
 542  *      Unregister the child subsystems and the bus itself.
 543  *      Finally, we call put_bus() to release the refcount
 544  */
 545 void bus_unregister(struct bus_type * bus)
 546 {
 547         pr_debug("bus %s: unregistering\n", bus->name);
 548         bus_remove_attrs(bus);
 549         kset_unregister(&bus->drivers);
 550         kset_unregister(&bus->devices);
 551         subsystem_unregister(&bus->subsys);
 552 }
 553
 554 int __init buses_init(void)
 555 {
 556         return subsystem_register(&bus_subsys);
 557 }
 558
 559
 560 EXPORT_SYMBOL_GPL(bus_for_each_dev);
 561 EXPORT_SYMBOL_GPL(bus_for_each_drv);
 562
 563 EXPORT_SYMBOL_GPL(bus_add_device);
 564 EXPORT_SYMBOL_GPL(bus_remove_device);
 565 EXPORT_SYMBOL_GPL(bus_register);
 566 EXPORT_SYMBOL_GPL(bus_unregister);
 567 EXPORT_SYMBOL_GPL(bus_rescan_devices);
 568 EXPORT_SYMBOL_GPL(get_bus);
 569 EXPORT_SYMBOL_GPL(put_bus);
 570 EXPORT_SYMBOL_GPL(find_bus);
 571
 572 EXPORT_SYMBOL_GPL(bus_create_file);
 573 EXPORT_SYMBOL_GPL(bus_remove_file);