sh_eth: fix EESIPR values for SH77{34|63}
[linux/fpc-iii.git] / drivers / base / bus.c
blob6470eb8088f4f4da92215f5009c3b63a2a492876
1 /*
2 * bus.c - bus driver management
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.
9 * This file is released under the GPLv2
13 #include <linux/async.h>
14 #include <linux/device.h>
15 #include <linux/module.h>
16 #include <linux/errno.h>
17 #include <linux/slab.h>
18 #include <linux/init.h>
19 #include <linux/string.h>
20 #include <linux/mutex.h>
21 #include <linux/sysfs.h>
22 #include "base.h"
23 #include "power/power.h"
25 /* /sys/devices/system */
26 static struct kset *system_kset;
28 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
31 * sysfs bindings for drivers
34 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
37 static int __must_check bus_rescan_devices_helper(struct device *dev,
38 void *data);
40 static struct bus_type *bus_get(struct bus_type *bus)
42 if (bus) {
43 kset_get(&bus->p->subsys);
44 return bus;
46 return NULL;
49 static void bus_put(struct bus_type *bus)
51 if (bus)
52 kset_put(&bus->p->subsys);
55 static ssize_t drv_attr_show(struct kobject *kobj, struct attribute *attr,
56 char *buf)
58 struct driver_attribute *drv_attr = to_drv_attr(attr);
59 struct driver_private *drv_priv = to_driver(kobj);
60 ssize_t ret = -EIO;
62 if (drv_attr->show)
63 ret = drv_attr->show(drv_priv->driver, buf);
64 return ret;
67 static ssize_t drv_attr_store(struct kobject *kobj, struct attribute *attr,
68 const char *buf, size_t count)
70 struct driver_attribute *drv_attr = to_drv_attr(attr);
71 struct driver_private *drv_priv = to_driver(kobj);
72 ssize_t ret = -EIO;
74 if (drv_attr->store)
75 ret = drv_attr->store(drv_priv->driver, buf, count);
76 return ret;
79 static const struct sysfs_ops driver_sysfs_ops = {
80 .show = drv_attr_show,
81 .store = drv_attr_store,
84 static void driver_release(struct kobject *kobj)
86 struct driver_private *drv_priv = to_driver(kobj);
88 pr_debug("driver: '%s': %s\n", kobject_name(kobj), __func__);
89 kfree(drv_priv);
92 static struct kobj_type driver_ktype = {
93 .sysfs_ops = &driver_sysfs_ops,
94 .release = driver_release,
98 * sysfs bindings for buses
100 static ssize_t bus_attr_show(struct kobject *kobj, struct attribute *attr,
101 char *buf)
103 struct bus_attribute *bus_attr = to_bus_attr(attr);
104 struct subsys_private *subsys_priv = to_subsys_private(kobj);
105 ssize_t ret = 0;
107 if (bus_attr->show)
108 ret = bus_attr->show(subsys_priv->bus, buf);
109 return ret;
112 static ssize_t bus_attr_store(struct kobject *kobj, struct attribute *attr,
113 const char *buf, size_t count)
115 struct bus_attribute *bus_attr = to_bus_attr(attr);
116 struct subsys_private *subsys_priv = to_subsys_private(kobj);
117 ssize_t ret = 0;
119 if (bus_attr->store)
120 ret = bus_attr->store(subsys_priv->bus, buf, count);
121 return ret;
124 static const struct sysfs_ops bus_sysfs_ops = {
125 .show = bus_attr_show,
126 .store = bus_attr_store,
129 int bus_create_file(struct bus_type *bus, struct bus_attribute *attr)
131 int error;
132 if (bus_get(bus)) {
133 error = sysfs_create_file(&bus->p->subsys.kobj, &attr->attr);
134 bus_put(bus);
135 } else
136 error = -EINVAL;
137 return error;
139 EXPORT_SYMBOL_GPL(bus_create_file);
141 void bus_remove_file(struct bus_type *bus, struct bus_attribute *attr)
143 if (bus_get(bus)) {
144 sysfs_remove_file(&bus->p->subsys.kobj, &attr->attr);
145 bus_put(bus);
148 EXPORT_SYMBOL_GPL(bus_remove_file);
150 static void bus_release(struct kobject *kobj)
152 struct subsys_private *priv = to_subsys_private(kobj);
153 struct bus_type *bus = priv->bus;
155 kfree(priv);
156 bus->p = NULL;
159 static struct kobj_type bus_ktype = {
160 .sysfs_ops = &bus_sysfs_ops,
161 .release = bus_release,
164 static int bus_uevent_filter(struct kset *kset, struct kobject *kobj)
166 struct kobj_type *ktype = get_ktype(kobj);
168 if (ktype == &bus_ktype)
169 return 1;
170 return 0;
173 static const struct kset_uevent_ops bus_uevent_ops = {
174 .filter = bus_uevent_filter,
177 static struct kset *bus_kset;
179 /* Manually detach a device from its associated driver. */
180 static ssize_t unbind_store(struct device_driver *drv, const char *buf,
181 size_t count)
183 struct bus_type *bus = bus_get(drv->bus);
184 struct device *dev;
185 int err = -ENODEV;
187 dev = bus_find_device_by_name(bus, NULL, buf);
188 if (dev && dev->driver == drv) {
189 if (dev->parent) /* Needed for USB */
190 device_lock(dev->parent);
191 device_release_driver(dev);
192 if (dev->parent)
193 device_unlock(dev->parent);
194 err = count;
196 put_device(dev);
197 bus_put(bus);
198 return err;
200 static DRIVER_ATTR_WO(unbind);
203 * Manually attach a device to a driver.
204 * Note: the driver must want to bind to the device,
205 * it is not possible to override the driver's id table.
207 static ssize_t bind_store(struct device_driver *drv, const char *buf,
208 size_t count)
210 struct bus_type *bus = bus_get(drv->bus);
211 struct device *dev;
212 int err = -ENODEV;
214 dev = bus_find_device_by_name(bus, NULL, buf);
215 if (dev && dev->driver == NULL && driver_match_device(drv, dev)) {
216 if (dev->parent) /* Needed for USB */
217 device_lock(dev->parent);
218 device_lock(dev);
219 err = driver_probe_device(drv, dev);
220 device_unlock(dev);
221 if (dev->parent)
222 device_unlock(dev->parent);
224 if (err > 0) {
225 /* success */
226 err = count;
227 } else if (err == 0) {
228 /* driver didn't accept device */
229 err = -ENODEV;
232 put_device(dev);
233 bus_put(bus);
234 return err;
236 static DRIVER_ATTR_WO(bind);
238 static ssize_t show_drivers_autoprobe(struct bus_type *bus, char *buf)
240 return sprintf(buf, "%d\n", bus->p->drivers_autoprobe);
243 static ssize_t store_drivers_autoprobe(struct bus_type *bus,
244 const char *buf, size_t count)
246 if (buf[0] == '0')
247 bus->p->drivers_autoprobe = 0;
248 else
249 bus->p->drivers_autoprobe = 1;
250 return count;
253 static ssize_t store_drivers_probe(struct bus_type *bus,
254 const char *buf, size_t count)
256 struct device *dev;
257 int err = -EINVAL;
259 dev = bus_find_device_by_name(bus, NULL, buf);
260 if (!dev)
261 return -ENODEV;
262 if (bus_rescan_devices_helper(dev, NULL) == 0)
263 err = count;
264 put_device(dev);
265 return err;
268 static struct device *next_device(struct klist_iter *i)
270 struct klist_node *n = klist_next(i);
271 struct device *dev = NULL;
272 struct device_private *dev_prv;
274 if (n) {
275 dev_prv = to_device_private_bus(n);
276 dev = dev_prv->device;
278 return dev;
282 * bus_for_each_dev - device iterator.
283 * @bus: bus type.
284 * @start: device to start iterating from.
285 * @data: data for the callback.
286 * @fn: function to be called for each device.
288 * Iterate over @bus's list of devices, and call @fn for each,
289 * passing it @data. If @start is not NULL, we use that device to
290 * begin iterating from.
292 * We check the return of @fn each time. If it returns anything
293 * other than 0, we break out and return that value.
295 * NOTE: The device that returns a non-zero value is not retained
296 * in any way, nor is its refcount incremented. If the caller needs
297 * to retain this data, it should do so, and increment the reference
298 * count in the supplied callback.
300 int bus_for_each_dev(struct bus_type *bus, struct device *start,
301 void *data, int (*fn)(struct device *, void *))
303 struct klist_iter i;
304 struct device *dev;
305 int error = 0;
307 if (!bus || !bus->p)
308 return -EINVAL;
310 klist_iter_init_node(&bus->p->klist_devices, &i,
311 (start ? &start->p->knode_bus : NULL));
312 while ((dev = next_device(&i)) && !error)
313 error = fn(dev, data);
314 klist_iter_exit(&i);
315 return error;
317 EXPORT_SYMBOL_GPL(bus_for_each_dev);
320 * bus_find_device - device iterator for locating a particular device.
321 * @bus: bus type
322 * @start: Device to begin with
323 * @data: Data to pass to match function
324 * @match: Callback function to check device
326 * This is similar to the bus_for_each_dev() function above, but it
327 * returns a reference to a device that is 'found' for later use, as
328 * determined by the @match callback.
330 * The callback should return 0 if the device doesn't match and non-zero
331 * if it does. If the callback returns non-zero, this function will
332 * return to the caller and not iterate over any more devices.
334 struct device *bus_find_device(struct bus_type *bus,
335 struct device *start, void *data,
336 int (*match)(struct device *dev, void *data))
338 struct klist_iter i;
339 struct device *dev;
341 if (!bus || !bus->p)
342 return NULL;
344 klist_iter_init_node(&bus->p->klist_devices, &i,
345 (start ? &start->p->knode_bus : NULL));
346 while ((dev = next_device(&i)))
347 if (match(dev, data) && get_device(dev))
348 break;
349 klist_iter_exit(&i);
350 return dev;
352 EXPORT_SYMBOL_GPL(bus_find_device);
354 static int match_name(struct device *dev, void *data)
356 const char *name = data;
358 return sysfs_streq(name, dev_name(dev));
362 * bus_find_device_by_name - device iterator for locating a particular device of a specific name
363 * @bus: bus type
364 * @start: Device to begin with
365 * @name: name of the device to match
367 * This is similar to the bus_find_device() function above, but it handles
368 * searching by a name automatically, no need to write another strcmp matching
369 * function.
371 struct device *bus_find_device_by_name(struct bus_type *bus,
372 struct device *start, const char *name)
374 return bus_find_device(bus, start, (void *)name, match_name);
376 EXPORT_SYMBOL_GPL(bus_find_device_by_name);
379 * subsys_find_device_by_id - find a device with a specific enumeration number
380 * @subsys: subsystem
381 * @id: index 'id' in struct device
382 * @hint: device to check first
384 * Check the hint's next object and if it is a match return it directly,
385 * otherwise, fall back to a full list search. Either way a reference for
386 * the returned object is taken.
388 struct device *subsys_find_device_by_id(struct bus_type *subsys, unsigned int id,
389 struct device *hint)
391 struct klist_iter i;
392 struct device *dev;
394 if (!subsys)
395 return NULL;
397 if (hint) {
398 klist_iter_init_node(&subsys->p->klist_devices, &i, &hint->p->knode_bus);
399 dev = next_device(&i);
400 if (dev && dev->id == id && get_device(dev)) {
401 klist_iter_exit(&i);
402 return dev;
404 klist_iter_exit(&i);
407 klist_iter_init_node(&subsys->p->klist_devices, &i, NULL);
408 while ((dev = next_device(&i))) {
409 if (dev->id == id && get_device(dev)) {
410 klist_iter_exit(&i);
411 return dev;
414 klist_iter_exit(&i);
415 return NULL;
417 EXPORT_SYMBOL_GPL(subsys_find_device_by_id);
419 static struct device_driver *next_driver(struct klist_iter *i)
421 struct klist_node *n = klist_next(i);
422 struct driver_private *drv_priv;
424 if (n) {
425 drv_priv = container_of(n, struct driver_private, knode_bus);
426 return drv_priv->driver;
428 return NULL;
432 * bus_for_each_drv - driver iterator
433 * @bus: bus we're dealing with.
434 * @start: driver to start iterating on.
435 * @data: data to pass to the callback.
436 * @fn: function to call for each driver.
438 * This is nearly identical to the device iterator above.
439 * We iterate over each driver that belongs to @bus, and call
440 * @fn for each. If @fn returns anything but 0, we break out
441 * and return it. If @start is not NULL, we use it as the head
442 * of the list.
444 * NOTE: we don't return the driver that returns a non-zero
445 * value, nor do we leave the reference count incremented for that
446 * driver. If the caller needs to know that info, it must set it
447 * in the callback. It must also be sure to increment the refcount
448 * so it doesn't disappear before returning to the caller.
450 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
451 void *data, int (*fn)(struct device_driver *, void *))
453 struct klist_iter i;
454 struct device_driver *drv;
455 int error = 0;
457 if (!bus)
458 return -EINVAL;
460 klist_iter_init_node(&bus->p->klist_drivers, &i,
461 start ? &start->p->knode_bus : NULL);
462 while ((drv = next_driver(&i)) && !error)
463 error = fn(drv, data);
464 klist_iter_exit(&i);
465 return error;
467 EXPORT_SYMBOL_GPL(bus_for_each_drv);
469 static int device_add_attrs(struct bus_type *bus, struct device *dev)
471 int error = 0;
472 int i;
474 if (!bus->dev_attrs)
475 return 0;
477 for (i = 0; bus->dev_attrs[i].attr.name; i++) {
478 error = device_create_file(dev, &bus->dev_attrs[i]);
479 if (error) {
480 while (--i >= 0)
481 device_remove_file(dev, &bus->dev_attrs[i]);
482 break;
485 return error;
488 static void device_remove_attrs(struct bus_type *bus, struct device *dev)
490 int i;
492 if (bus->dev_attrs) {
493 for (i = 0; bus->dev_attrs[i].attr.name; i++)
494 device_remove_file(dev, &bus->dev_attrs[i]);
499 * bus_add_device - add device to bus
500 * @dev: device being added
502 * - Add device's bus attributes.
503 * - Create links to device's bus.
504 * - Add the device to its bus's list of devices.
506 int bus_add_device(struct device *dev)
508 struct bus_type *bus = bus_get(dev->bus);
509 int error = 0;
511 if (bus) {
512 pr_debug("bus: '%s': add device %s\n", bus->name, dev_name(dev));
513 error = device_add_attrs(bus, dev);
514 if (error)
515 goto out_put;
516 error = device_add_groups(dev, bus->dev_groups);
517 if (error)
518 goto out_id;
519 error = sysfs_create_link(&bus->p->devices_kset->kobj,
520 &dev->kobj, dev_name(dev));
521 if (error)
522 goto out_groups;
523 error = sysfs_create_link(&dev->kobj,
524 &dev->bus->p->subsys.kobj, "subsystem");
525 if (error)
526 goto out_subsys;
527 klist_add_tail(&dev->p->knode_bus, &bus->p->klist_devices);
529 return 0;
531 out_subsys:
532 sysfs_remove_link(&bus->p->devices_kset->kobj, dev_name(dev));
533 out_groups:
534 device_remove_groups(dev, bus->dev_groups);
535 out_id:
536 device_remove_attrs(bus, dev);
537 out_put:
538 bus_put(dev->bus);
539 return error;
543 * bus_probe_device - probe drivers for a new device
544 * @dev: device to probe
546 * - Automatically probe for a driver if the bus allows it.
548 void bus_probe_device(struct device *dev)
550 struct bus_type *bus = dev->bus;
551 struct subsys_interface *sif;
553 if (!bus)
554 return;
556 if (bus->p->drivers_autoprobe)
557 device_initial_probe(dev);
559 mutex_lock(&bus->p->mutex);
560 list_for_each_entry(sif, &bus->p->interfaces, node)
561 if (sif->add_dev)
562 sif->add_dev(dev, sif);
563 mutex_unlock(&bus->p->mutex);
567 * bus_remove_device - remove device from bus
568 * @dev: device to be removed
570 * - Remove device from all interfaces.
571 * - Remove symlink from bus' directory.
572 * - Delete device from bus's list.
573 * - Detach from its driver.
574 * - Drop reference taken in bus_add_device().
576 void bus_remove_device(struct device *dev)
578 struct bus_type *bus = dev->bus;
579 struct subsys_interface *sif;
581 if (!bus)
582 return;
584 mutex_lock(&bus->p->mutex);
585 list_for_each_entry(sif, &bus->p->interfaces, node)
586 if (sif->remove_dev)
587 sif->remove_dev(dev, sif);
588 mutex_unlock(&bus->p->mutex);
590 sysfs_remove_link(&dev->kobj, "subsystem");
591 sysfs_remove_link(&dev->bus->p->devices_kset->kobj,
592 dev_name(dev));
593 device_remove_attrs(dev->bus, dev);
594 device_remove_groups(dev, dev->bus->dev_groups);
595 if (klist_node_attached(&dev->p->knode_bus))
596 klist_del(&dev->p->knode_bus);
598 pr_debug("bus: '%s': remove device %s\n",
599 dev->bus->name, dev_name(dev));
600 device_release_driver(dev);
601 bus_put(dev->bus);
604 static int __must_check add_bind_files(struct device_driver *drv)
606 int ret;
608 ret = driver_create_file(drv, &driver_attr_unbind);
609 if (ret == 0) {
610 ret = driver_create_file(drv, &driver_attr_bind);
611 if (ret)
612 driver_remove_file(drv, &driver_attr_unbind);
614 return ret;
617 static void remove_bind_files(struct device_driver *drv)
619 driver_remove_file(drv, &driver_attr_bind);
620 driver_remove_file(drv, &driver_attr_unbind);
623 static BUS_ATTR(drivers_probe, S_IWUSR, NULL, store_drivers_probe);
624 static BUS_ATTR(drivers_autoprobe, S_IWUSR | S_IRUGO,
625 show_drivers_autoprobe, store_drivers_autoprobe);
627 static int add_probe_files(struct bus_type *bus)
629 int retval;
631 retval = bus_create_file(bus, &bus_attr_drivers_probe);
632 if (retval)
633 goto out;
635 retval = bus_create_file(bus, &bus_attr_drivers_autoprobe);
636 if (retval)
637 bus_remove_file(bus, &bus_attr_drivers_probe);
638 out:
639 return retval;
642 static void remove_probe_files(struct bus_type *bus)
644 bus_remove_file(bus, &bus_attr_drivers_autoprobe);
645 bus_remove_file(bus, &bus_attr_drivers_probe);
648 static ssize_t uevent_store(struct device_driver *drv, const char *buf,
649 size_t count)
651 enum kobject_action action;
653 if (kobject_action_type(buf, count, &action) == 0)
654 kobject_uevent(&drv->p->kobj, action);
655 return count;
657 static DRIVER_ATTR_WO(uevent);
659 static void driver_attach_async(void *_drv, async_cookie_t cookie)
661 struct device_driver *drv = _drv;
662 int ret;
664 ret = driver_attach(drv);
666 pr_debug("bus: '%s': driver %s async attach completed: %d\n",
667 drv->bus->name, drv->name, ret);
671 * bus_add_driver - Add a driver to the bus.
672 * @drv: driver.
674 int bus_add_driver(struct device_driver *drv)
676 struct bus_type *bus;
677 struct driver_private *priv;
678 int error = 0;
680 bus = bus_get(drv->bus);
681 if (!bus)
682 return -EINVAL;
684 pr_debug("bus: '%s': add driver %s\n", bus->name, drv->name);
686 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
687 if (!priv) {
688 error = -ENOMEM;
689 goto out_put_bus;
691 klist_init(&priv->klist_devices, NULL, NULL);
692 priv->driver = drv;
693 drv->p = priv;
694 priv->kobj.kset = bus->p->drivers_kset;
695 error = kobject_init_and_add(&priv->kobj, &driver_ktype, NULL,
696 "%s", drv->name);
697 if (error)
698 goto out_unregister;
700 klist_add_tail(&priv->knode_bus, &bus->p->klist_drivers);
701 if (drv->bus->p->drivers_autoprobe) {
702 if (driver_allows_async_probing(drv)) {
703 pr_debug("bus: '%s': probing driver %s asynchronously\n",
704 drv->bus->name, drv->name);
705 async_schedule(driver_attach_async, drv);
706 } else {
707 error = driver_attach(drv);
708 if (error)
709 goto out_unregister;
712 module_add_driver(drv->owner, drv);
714 error = driver_create_file(drv, &driver_attr_uevent);
715 if (error) {
716 printk(KERN_ERR "%s: uevent attr (%s) failed\n",
717 __func__, drv->name);
719 error = driver_add_groups(drv, bus->drv_groups);
720 if (error) {
721 /* How the hell do we get out of this pickle? Give up */
722 printk(KERN_ERR "%s: driver_create_groups(%s) failed\n",
723 __func__, drv->name);
726 if (!drv->suppress_bind_attrs) {
727 error = add_bind_files(drv);
728 if (error) {
729 /* Ditto */
730 printk(KERN_ERR "%s: add_bind_files(%s) failed\n",
731 __func__, drv->name);
735 return 0;
737 out_unregister:
738 kobject_put(&priv->kobj);
739 kfree(drv->p);
740 drv->p = NULL;
741 out_put_bus:
742 bus_put(bus);
743 return error;
747 * bus_remove_driver - delete driver from bus's knowledge.
748 * @drv: driver.
750 * Detach the driver from the devices it controls, and remove
751 * it from its bus's list of drivers. Finally, we drop the reference
752 * to the bus we took in bus_add_driver().
754 void bus_remove_driver(struct device_driver *drv)
756 if (!drv->bus)
757 return;
759 if (!drv->suppress_bind_attrs)
760 remove_bind_files(drv);
761 driver_remove_groups(drv, drv->bus->drv_groups);
762 driver_remove_file(drv, &driver_attr_uevent);
763 klist_remove(&drv->p->knode_bus);
764 pr_debug("bus: '%s': remove driver %s\n", drv->bus->name, drv->name);
765 driver_detach(drv);
766 module_remove_driver(drv);
767 kobject_put(&drv->p->kobj);
768 bus_put(drv->bus);
771 /* Helper for bus_rescan_devices's iter */
772 static int __must_check bus_rescan_devices_helper(struct device *dev,
773 void *data)
775 int ret = 0;
777 if (!dev->driver) {
778 if (dev->parent) /* Needed for USB */
779 device_lock(dev->parent);
780 ret = device_attach(dev);
781 if (dev->parent)
782 device_unlock(dev->parent);
784 return ret < 0 ? ret : 0;
788 * bus_rescan_devices - rescan devices on the bus for possible drivers
789 * @bus: the bus to scan.
791 * This function will look for devices on the bus with no driver
792 * attached and rescan it against existing drivers to see if it matches
793 * any by calling device_attach() for the unbound devices.
795 int bus_rescan_devices(struct bus_type *bus)
797 return bus_for_each_dev(bus, NULL, NULL, bus_rescan_devices_helper);
799 EXPORT_SYMBOL_GPL(bus_rescan_devices);
802 * device_reprobe - remove driver for a device and probe for a new driver
803 * @dev: the device to reprobe
805 * This function detaches the attached driver (if any) for the given
806 * device and restarts the driver probing process. It is intended
807 * to use if probing criteria changed during a devices lifetime and
808 * driver attachment should change accordingly.
810 int device_reprobe(struct device *dev)
812 if (dev->driver) {
813 if (dev->parent) /* Needed for USB */
814 device_lock(dev->parent);
815 device_release_driver(dev);
816 if (dev->parent)
817 device_unlock(dev->parent);
819 return bus_rescan_devices_helper(dev, NULL);
821 EXPORT_SYMBOL_GPL(device_reprobe);
824 * find_bus - locate bus by name.
825 * @name: name of bus.
827 * Call kset_find_obj() to iterate over list of buses to
828 * find a bus by name. Return bus if found.
830 * Note that kset_find_obj increments bus' reference count.
832 #if 0
833 struct bus_type *find_bus(char *name)
835 struct kobject *k = kset_find_obj(bus_kset, name);
836 return k ? to_bus(k) : NULL;
838 #endif /* 0 */
840 static int bus_add_groups(struct bus_type *bus,
841 const struct attribute_group **groups)
843 return sysfs_create_groups(&bus->p->subsys.kobj, groups);
846 static void bus_remove_groups(struct bus_type *bus,
847 const struct attribute_group **groups)
849 sysfs_remove_groups(&bus->p->subsys.kobj, groups);
852 static void klist_devices_get(struct klist_node *n)
854 struct device_private *dev_prv = to_device_private_bus(n);
855 struct device *dev = dev_prv->device;
857 get_device(dev);
860 static void klist_devices_put(struct klist_node *n)
862 struct device_private *dev_prv = to_device_private_bus(n);
863 struct device *dev = dev_prv->device;
865 put_device(dev);
868 static ssize_t bus_uevent_store(struct bus_type *bus,
869 const char *buf, size_t count)
871 enum kobject_action action;
873 if (kobject_action_type(buf, count, &action) == 0)
874 kobject_uevent(&bus->p->subsys.kobj, action);
875 return count;
877 static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store);
880 * bus_register - register a driver-core subsystem
881 * @bus: bus to register
883 * Once we have that, we register the bus with the kobject
884 * infrastructure, then register the children subsystems it has:
885 * the devices and drivers that belong to the subsystem.
887 int bus_register(struct bus_type *bus)
889 int retval;
890 struct subsys_private *priv;
891 struct lock_class_key *key = &bus->lock_key;
893 priv = kzalloc(sizeof(struct subsys_private), GFP_KERNEL);
894 if (!priv)
895 return -ENOMEM;
897 priv->bus = bus;
898 bus->p = priv;
900 BLOCKING_INIT_NOTIFIER_HEAD(&priv->bus_notifier);
902 retval = kobject_set_name(&priv->subsys.kobj, "%s", bus->name);
903 if (retval)
904 goto out;
906 priv->subsys.kobj.kset = bus_kset;
907 priv->subsys.kobj.ktype = &bus_ktype;
908 priv->drivers_autoprobe = 1;
910 retval = kset_register(&priv->subsys);
911 if (retval)
912 goto out;
914 retval = bus_create_file(bus, &bus_attr_uevent);
915 if (retval)
916 goto bus_uevent_fail;
918 priv->devices_kset = kset_create_and_add("devices", NULL,
919 &priv->subsys.kobj);
920 if (!priv->devices_kset) {
921 retval = -ENOMEM;
922 goto bus_devices_fail;
925 priv->drivers_kset = kset_create_and_add("drivers", NULL,
926 &priv->subsys.kobj);
927 if (!priv->drivers_kset) {
928 retval = -ENOMEM;
929 goto bus_drivers_fail;
932 INIT_LIST_HEAD(&priv->interfaces);
933 __mutex_init(&priv->mutex, "subsys mutex", key);
934 klist_init(&priv->klist_devices, klist_devices_get, klist_devices_put);
935 klist_init(&priv->klist_drivers, NULL, NULL);
937 retval = add_probe_files(bus);
938 if (retval)
939 goto bus_probe_files_fail;
941 retval = bus_add_groups(bus, bus->bus_groups);
942 if (retval)
943 goto bus_groups_fail;
945 pr_debug("bus: '%s': registered\n", bus->name);
946 return 0;
948 bus_groups_fail:
949 remove_probe_files(bus);
950 bus_probe_files_fail:
951 kset_unregister(bus->p->drivers_kset);
952 bus_drivers_fail:
953 kset_unregister(bus->p->devices_kset);
954 bus_devices_fail:
955 bus_remove_file(bus, &bus_attr_uevent);
956 bus_uevent_fail:
957 kset_unregister(&bus->p->subsys);
958 out:
959 kfree(bus->p);
960 bus->p = NULL;
961 return retval;
963 EXPORT_SYMBOL_GPL(bus_register);
966 * bus_unregister - remove a bus from the system
967 * @bus: bus.
969 * Unregister the child subsystems and the bus itself.
970 * Finally, we call bus_put() to release the refcount
972 void bus_unregister(struct bus_type *bus)
974 pr_debug("bus: '%s': unregistering\n", bus->name);
975 if (bus->dev_root)
976 device_unregister(bus->dev_root);
977 bus_remove_groups(bus, bus->bus_groups);
978 remove_probe_files(bus);
979 kset_unregister(bus->p->drivers_kset);
980 kset_unregister(bus->p->devices_kset);
981 bus_remove_file(bus, &bus_attr_uevent);
982 kset_unregister(&bus->p->subsys);
984 EXPORT_SYMBOL_GPL(bus_unregister);
986 int bus_register_notifier(struct bus_type *bus, struct notifier_block *nb)
988 return blocking_notifier_chain_register(&bus->p->bus_notifier, nb);
990 EXPORT_SYMBOL_GPL(bus_register_notifier);
992 int bus_unregister_notifier(struct bus_type *bus, struct notifier_block *nb)
994 return blocking_notifier_chain_unregister(&bus->p->bus_notifier, nb);
996 EXPORT_SYMBOL_GPL(bus_unregister_notifier);
998 struct kset *bus_get_kset(struct bus_type *bus)
1000 return &bus->p->subsys;
1002 EXPORT_SYMBOL_GPL(bus_get_kset);
1004 struct klist *bus_get_device_klist(struct bus_type *bus)
1006 return &bus->p->klist_devices;
1008 EXPORT_SYMBOL_GPL(bus_get_device_klist);
1011 * Yes, this forcibly breaks the klist abstraction temporarily. It
1012 * just wants to sort the klist, not change reference counts and
1013 * take/drop locks rapidly in the process. It does all this while
1014 * holding the lock for the list, so objects can't otherwise be
1015 * added/removed while we're swizzling.
1017 static void device_insertion_sort_klist(struct device *a, struct list_head *list,
1018 int (*compare)(const struct device *a,
1019 const struct device *b))
1021 struct klist_node *n;
1022 struct device_private *dev_prv;
1023 struct device *b;
1025 list_for_each_entry(n, list, n_node) {
1026 dev_prv = to_device_private_bus(n);
1027 b = dev_prv->device;
1028 if (compare(a, b) <= 0) {
1029 list_move_tail(&a->p->knode_bus.n_node,
1030 &b->p->knode_bus.n_node);
1031 return;
1034 list_move_tail(&a->p->knode_bus.n_node, list);
1037 void bus_sort_breadthfirst(struct bus_type *bus,
1038 int (*compare)(const struct device *a,
1039 const struct device *b))
1041 LIST_HEAD(sorted_devices);
1042 struct klist_node *n, *tmp;
1043 struct device_private *dev_prv;
1044 struct device *dev;
1045 struct klist *device_klist;
1047 device_klist = bus_get_device_klist(bus);
1049 spin_lock(&device_klist->k_lock);
1050 list_for_each_entry_safe(n, tmp, &device_klist->k_list, n_node) {
1051 dev_prv = to_device_private_bus(n);
1052 dev = dev_prv->device;
1053 device_insertion_sort_klist(dev, &sorted_devices, compare);
1055 list_splice(&sorted_devices, &device_klist->k_list);
1056 spin_unlock(&device_klist->k_lock);
1058 EXPORT_SYMBOL_GPL(bus_sort_breadthfirst);
1061 * subsys_dev_iter_init - initialize subsys device iterator
1062 * @iter: subsys iterator to initialize
1063 * @subsys: the subsys we wanna iterate over
1064 * @start: the device to start iterating from, if any
1065 * @type: device_type of the devices to iterate over, NULL for all
1067 * Initialize subsys iterator @iter such that it iterates over devices
1068 * of @subsys. If @start is set, the list iteration will start there,
1069 * otherwise if it is NULL, the iteration starts at the beginning of
1070 * the list.
1072 void subsys_dev_iter_init(struct subsys_dev_iter *iter, struct bus_type *subsys,
1073 struct device *start, const struct device_type *type)
1075 struct klist_node *start_knode = NULL;
1077 if (start)
1078 start_knode = &start->p->knode_bus;
1079 klist_iter_init_node(&subsys->p->klist_devices, &iter->ki, start_knode);
1080 iter->type = type;
1082 EXPORT_SYMBOL_GPL(subsys_dev_iter_init);
1085 * subsys_dev_iter_next - iterate to the next device
1086 * @iter: subsys iterator to proceed
1088 * Proceed @iter to the next device and return it. Returns NULL if
1089 * iteration is complete.
1091 * The returned device is referenced and won't be released till
1092 * iterator is proceed to the next device or exited. The caller is
1093 * free to do whatever it wants to do with the device including
1094 * calling back into subsys code.
1096 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter)
1098 struct klist_node *knode;
1099 struct device *dev;
1101 for (;;) {
1102 knode = klist_next(&iter->ki);
1103 if (!knode)
1104 return NULL;
1105 dev = to_device_private_bus(knode)->device;
1106 if (!iter->type || iter->type == dev->type)
1107 return dev;
1110 EXPORT_SYMBOL_GPL(subsys_dev_iter_next);
1113 * subsys_dev_iter_exit - finish iteration
1114 * @iter: subsys iterator to finish
1116 * Finish an iteration. Always call this function after iteration is
1117 * complete whether the iteration ran till the end or not.
1119 void subsys_dev_iter_exit(struct subsys_dev_iter *iter)
1121 klist_iter_exit(&iter->ki);
1123 EXPORT_SYMBOL_GPL(subsys_dev_iter_exit);
1125 int subsys_interface_register(struct subsys_interface *sif)
1127 struct bus_type *subsys;
1128 struct subsys_dev_iter iter;
1129 struct device *dev;
1131 if (!sif || !sif->subsys)
1132 return -ENODEV;
1134 subsys = bus_get(sif->subsys);
1135 if (!subsys)
1136 return -EINVAL;
1138 mutex_lock(&subsys->p->mutex);
1139 list_add_tail(&sif->node, &subsys->p->interfaces);
1140 if (sif->add_dev) {
1141 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1142 while ((dev = subsys_dev_iter_next(&iter)))
1143 sif->add_dev(dev, sif);
1144 subsys_dev_iter_exit(&iter);
1146 mutex_unlock(&subsys->p->mutex);
1148 return 0;
1150 EXPORT_SYMBOL_GPL(subsys_interface_register);
1152 void subsys_interface_unregister(struct subsys_interface *sif)
1154 struct bus_type *subsys;
1155 struct subsys_dev_iter iter;
1156 struct device *dev;
1158 if (!sif || !sif->subsys)
1159 return;
1161 subsys = sif->subsys;
1163 mutex_lock(&subsys->p->mutex);
1164 list_del_init(&sif->node);
1165 if (sif->remove_dev) {
1166 subsys_dev_iter_init(&iter, subsys, NULL, NULL);
1167 while ((dev = subsys_dev_iter_next(&iter)))
1168 sif->remove_dev(dev, sif);
1169 subsys_dev_iter_exit(&iter);
1171 mutex_unlock(&subsys->p->mutex);
1173 bus_put(subsys);
1175 EXPORT_SYMBOL_GPL(subsys_interface_unregister);
1177 static void system_root_device_release(struct device *dev)
1179 kfree(dev);
1182 static int subsys_register(struct bus_type *subsys,
1183 const struct attribute_group **groups,
1184 struct kobject *parent_of_root)
1186 struct device *dev;
1187 int err;
1189 err = bus_register(subsys);
1190 if (err < 0)
1191 return err;
1193 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1194 if (!dev) {
1195 err = -ENOMEM;
1196 goto err_dev;
1199 err = dev_set_name(dev, "%s", subsys->name);
1200 if (err < 0)
1201 goto err_name;
1203 dev->kobj.parent = parent_of_root;
1204 dev->groups = groups;
1205 dev->release = system_root_device_release;
1207 err = device_register(dev);
1208 if (err < 0)
1209 goto err_dev_reg;
1211 subsys->dev_root = dev;
1212 return 0;
1214 err_dev_reg:
1215 put_device(dev);
1216 dev = NULL;
1217 err_name:
1218 kfree(dev);
1219 err_dev:
1220 bus_unregister(subsys);
1221 return err;
1225 * subsys_system_register - register a subsystem at /sys/devices/system/
1226 * @subsys: system subsystem
1227 * @groups: default attributes for the root device
1229 * All 'system' subsystems have a /sys/devices/system/<name> root device
1230 * with the name of the subsystem. The root device can carry subsystem-
1231 * wide attributes. All registered devices are below this single root
1232 * device and are named after the subsystem with a simple enumeration
1233 * number appended. The registered devices are not explicitly named;
1234 * only 'id' in the device needs to be set.
1236 * Do not use this interface for anything new, it exists for compatibility
1237 * with bad ideas only. New subsystems should use plain subsystems; and
1238 * add the subsystem-wide attributes should be added to the subsystem
1239 * directory itself and not some create fake root-device placed in
1240 * /sys/devices/system/<name>.
1242 int subsys_system_register(struct bus_type *subsys,
1243 const struct attribute_group **groups)
1245 return subsys_register(subsys, groups, &system_kset->kobj);
1247 EXPORT_SYMBOL_GPL(subsys_system_register);
1250 * subsys_virtual_register - register a subsystem at /sys/devices/virtual/
1251 * @subsys: virtual subsystem
1252 * @groups: default attributes for the root device
1254 * All 'virtual' subsystems have a /sys/devices/system/<name> root device
1255 * with the name of the subystem. The root device can carry subsystem-wide
1256 * attributes. All registered devices are below this single root device.
1257 * There's no restriction on device naming. This is for kernel software
1258 * constructs which need sysfs interface.
1260 int subsys_virtual_register(struct bus_type *subsys,
1261 const struct attribute_group **groups)
1263 struct kobject *virtual_dir;
1265 virtual_dir = virtual_device_parent(NULL);
1266 if (!virtual_dir)
1267 return -ENOMEM;
1269 return subsys_register(subsys, groups, virtual_dir);
1271 EXPORT_SYMBOL_GPL(subsys_virtual_register);
1273 int __init buses_init(void)
1275 bus_kset = kset_create_and_add("bus", &bus_uevent_ops, NULL);
1276 if (!bus_kset)
1277 return -ENOMEM;
1279 system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
1280 if (!system_kset)
1281 return -ENOMEM;
1283 return 0;