Commit | Line | Data |
---|---|---|
07e4a3e2 | 1 | /* |
4a3ad20c | 2 | * drivers/base/dd.c - The core device/driver interactions. |
07e4a3e2 | 3 | * |
4a3ad20c GKH |
4 | * This file contains the (sometimes tricky) code that controls the |
5 | * interactions between devices and drivers, which primarily includes | |
6 | * driver binding and unbinding. | |
07e4a3e2 | 7 | * |
4a3ad20c GKH |
8 | * All of this code used to exist in drivers/base/bus.c, but was |
9 | * relocated to here in the name of compartmentalization (since it wasn't | |
10 | * strictly code just for the 'struct bus_type'. | |
07e4a3e2 | 11 | * |
4a3ad20c GKH |
12 | * Copyright (c) 2002-5 Patrick Mochel |
13 | * Copyright (c) 2002-3 Open Source Development Labs | |
14 | * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de> | |
15 | * Copyright (c) 2007 Novell Inc. | |
07e4a3e2 | 16 | * |
4a3ad20c | 17 | * This file is released under the GPLv2 |
07e4a3e2 | 18 | */ |
19 | ||
20 | #include <linux/device.h> | |
216773a7 | 21 | #include <linux/delay.h> |
07e4a3e2 | 22 | #include <linux/module.h> |
d779249e | 23 | #include <linux/kthread.h> |
735a7ffb | 24 | #include <linux/wait.h> |
216773a7 | 25 | #include <linux/async.h> |
07e4a3e2 | 26 | |
27 | #include "base.h" | |
28 | #include "power/power.h" | |
29 | ||
07e4a3e2 | 30 | |
1901fb26 | 31 | static void driver_bound(struct device *dev) |
07e4a3e2 | 32 | { |
cda5e83f | 33 | if (klist_node_attached(&dev->knode_driver)) { |
f86db396 | 34 | printk(KERN_WARNING "%s: device %s already bound\n", |
2b3a302a | 35 | __func__, kobject_name(&dev->kobj)); |
1901fb26 | 36 | return; |
f86db396 | 37 | } |
4c898c7f | 38 | |
1e0b2cf9 | 39 | pr_debug("driver: '%s': %s: bound to device '%s'\n", dev_name(dev), |
2b3a302a | 40 | __func__, dev->driver->name); |
116af378 BH |
41 | |
42 | if (dev->bus) | |
c6f7e72a | 43 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 BH |
44 | BUS_NOTIFY_BOUND_DRIVER, dev); |
45 | ||
cda5e83f | 46 | klist_add_tail(&dev->knode_driver, &dev->driver->p->klist_devices); |
1901fb26 KS |
47 | } |
48 | ||
49 | static int driver_sysfs_add(struct device *dev) | |
50 | { | |
51 | int ret; | |
52 | ||
e5dd1278 | 53 | ret = sysfs_create_link(&dev->driver->p->kobj, &dev->kobj, |
07e4a3e2 | 54 | kobject_name(&dev->kobj)); |
f86db396 | 55 | if (ret == 0) { |
e5dd1278 | 56 | ret = sysfs_create_link(&dev->kobj, &dev->driver->p->kobj, |
f86db396 AM |
57 | "driver"); |
58 | if (ret) | |
e5dd1278 | 59 | sysfs_remove_link(&dev->driver->p->kobj, |
f86db396 AM |
60 | kobject_name(&dev->kobj)); |
61 | } | |
62 | return ret; | |
07e4a3e2 | 63 | } |
64 | ||
1901fb26 KS |
65 | static void driver_sysfs_remove(struct device *dev) |
66 | { | |
67 | struct device_driver *drv = dev->driver; | |
68 | ||
69 | if (drv) { | |
e5dd1278 | 70 | sysfs_remove_link(&drv->p->kobj, kobject_name(&dev->kobj)); |
1901fb26 KS |
71 | sysfs_remove_link(&dev->kobj, "driver"); |
72 | } | |
73 | } | |
74 | ||
75 | /** | |
4a3ad20c GKH |
76 | * device_bind_driver - bind a driver to one device. |
77 | * @dev: device. | |
1901fb26 | 78 | * |
4a3ad20c GKH |
79 | * Allow manual attachment of a driver to a device. |
80 | * Caller must have already set @dev->driver. | |
1901fb26 | 81 | * |
4a3ad20c GKH |
82 | * Note that this does not modify the bus reference count |
83 | * nor take the bus's rwsem. Please verify those are accounted | |
84 | * for before calling this. (It is ok to call with no other effort | |
85 | * from a driver's probe() method.) | |
1901fb26 | 86 | * |
4a3ad20c | 87 | * This function must be called with @dev->sem held. |
1901fb26 KS |
88 | */ |
89 | int device_bind_driver(struct device *dev) | |
90 | { | |
cb986b74 CH |
91 | int ret; |
92 | ||
93 | ret = driver_sysfs_add(dev); | |
94 | if (!ret) | |
95 | driver_bound(dev); | |
96 | return ret; | |
1901fb26 | 97 | } |
4a3ad20c | 98 | EXPORT_SYMBOL_GPL(device_bind_driver); |
1901fb26 | 99 | |
d779249e | 100 | static atomic_t probe_count = ATOMIC_INIT(0); |
735a7ffb AM |
101 | static DECLARE_WAIT_QUEUE_HEAD(probe_waitqueue); |
102 | ||
21c7f30b | 103 | static int really_probe(struct device *dev, struct device_driver *drv) |
07e4a3e2 | 104 | { |
0d3e5a2e | 105 | int ret = 0; |
07e4a3e2 | 106 | |
d779249e | 107 | atomic_inc(&probe_count); |
7dc72b28 | 108 | pr_debug("bus: '%s': %s: probing driver %s with device %s\n", |
1e0b2cf9 | 109 | drv->bus->name, __func__, drv->name, dev_name(dev)); |
9ac7849e | 110 | WARN_ON(!list_empty(&dev->devres_head)); |
07e4a3e2 | 111 | |
07e4a3e2 | 112 | dev->driver = drv; |
1901fb26 KS |
113 | if (driver_sysfs_add(dev)) { |
114 | printk(KERN_ERR "%s: driver_sysfs_add(%s) failed\n", | |
1e0b2cf9 | 115 | __func__, dev_name(dev)); |
1901fb26 KS |
116 | goto probe_failed; |
117 | } | |
118 | ||
594c8281 RK |
119 | if (dev->bus->probe) { |
120 | ret = dev->bus->probe(dev); | |
1901fb26 | 121 | if (ret) |
d779249e | 122 | goto probe_failed; |
594c8281 | 123 | } else if (drv->probe) { |
0d3e5a2e | 124 | ret = drv->probe(dev); |
1901fb26 | 125 | if (ret) |
d779249e | 126 | goto probe_failed; |
f86db396 | 127 | } |
1901fb26 KS |
128 | |
129 | driver_bound(dev); | |
0d3e5a2e | 130 | ret = 1; |
7dc72b28 | 131 | pr_debug("bus: '%s': %s: bound device %s to driver %s\n", |
1e0b2cf9 | 132 | drv->bus->name, __func__, dev_name(dev), drv->name); |
d779249e | 133 | goto done; |
0d3e5a2e | 134 | |
d779249e | 135 | probe_failed: |
9ac7849e | 136 | devres_release_all(dev); |
1901fb26 KS |
137 | driver_sysfs_remove(dev); |
138 | dev->driver = NULL; | |
139 | ||
c578abbc | 140 | if (ret != -ENODEV && ret != -ENXIO) { |
0d3e5a2e PM |
141 | /* driver matched but the probe failed */ |
142 | printk(KERN_WARNING | |
143 | "%s: probe of %s failed with error %d\n", | |
1e0b2cf9 | 144 | drv->name, dev_name(dev), ret); |
0d3e5a2e | 145 | } |
c578abbc CH |
146 | /* |
147 | * Ignore errors returned by ->probe so that the next driver can try | |
148 | * its luck. | |
149 | */ | |
150 | ret = 0; | |
d779249e | 151 | done: |
d779249e | 152 | atomic_dec(&probe_count); |
735a7ffb | 153 | wake_up(&probe_waitqueue); |
d779249e GKH |
154 | return ret; |
155 | } | |
156 | ||
157 | /** | |
158 | * driver_probe_done | |
159 | * Determine if the probe sequence is finished or not. | |
160 | * | |
161 | * Should somehow figure out how to use a semaphore, not an atomic variable... | |
162 | */ | |
163 | int driver_probe_done(void) | |
164 | { | |
2b3a302a | 165 | pr_debug("%s: probe_count = %d\n", __func__, |
d779249e GKH |
166 | atomic_read(&probe_count)); |
167 | if (atomic_read(&probe_count)) | |
168 | return -EBUSY; | |
169 | return 0; | |
170 | } | |
171 | ||
216773a7 AV |
172 | /** |
173 | * wait_for_device_probe | |
174 | * Wait for device probing to be completed. | |
216773a7 | 175 | */ |
b23530eb | 176 | void wait_for_device_probe(void) |
216773a7 AV |
177 | { |
178 | /* wait for the known devices to complete their probing */ | |
b23530eb | 179 | wait_event(probe_waitqueue, atomic_read(&probe_count) == 0); |
216773a7 | 180 | async_synchronize_full(); |
216773a7 AV |
181 | } |
182 | ||
d779249e GKH |
183 | /** |
184 | * driver_probe_device - attempt to bind device & driver together | |
185 | * @drv: driver to bind a device to | |
186 | * @dev: device to try to bind to the driver | |
187 | * | |
49b420a1 ML |
188 | * This function returns -ENODEV if the device is not registered, |
189 | * 1 if the device is bound sucessfully and 0 otherwise. | |
d779249e GKH |
190 | * |
191 | * This function must be called with @dev->sem held. When called for a | |
192 | * USB interface, @dev->parent->sem must be held as well. | |
193 | */ | |
4a3ad20c | 194 | int driver_probe_device(struct device_driver *drv, struct device *dev) |
d779249e | 195 | { |
d779249e GKH |
196 | int ret = 0; |
197 | ||
f2eaae19 AS |
198 | if (!device_is_registered(dev)) |
199 | return -ENODEV; | |
d779249e | 200 | |
7dc72b28 | 201 | pr_debug("bus: '%s': %s: matched device %s with driver %s\n", |
1e0b2cf9 | 202 | drv->bus->name, __func__, dev_name(dev), drv->name); |
d779249e | 203 | |
21c7f30b | 204 | ret = really_probe(dev, drv); |
d779249e | 205 | |
0d3e5a2e | 206 | return ret; |
07e4a3e2 | 207 | } |
208 | ||
4a3ad20c | 209 | static int __device_attach(struct device_driver *drv, void *data) |
2287c322 | 210 | { |
4a3ad20c | 211 | struct device *dev = data; |
49b420a1 ML |
212 | |
213 | if (!driver_match_device(drv, dev)) | |
214 | return 0; | |
215 | ||
0d3e5a2e | 216 | return driver_probe_device(drv, dev); |
2287c322 | 217 | } |
218 | ||
07e4a3e2 | 219 | /** |
4a3ad20c GKH |
220 | * device_attach - try to attach device to a driver. |
221 | * @dev: device. | |
07e4a3e2 | 222 | * |
4a3ad20c GKH |
223 | * Walk the list of drivers that the bus has and call |
224 | * driver_probe_device() for each pair. If a compatible | |
225 | * pair is found, break out and return. | |
0d3e5a2e | 226 | * |
4a3ad20c GKH |
227 | * Returns 1 if the device was bound to a driver; |
228 | * 0 if no matching device was found; | |
229 | * -ENODEV if the device is not registered. | |
bf74ad5b | 230 | * |
4a3ad20c | 231 | * When called for a USB interface, @dev->parent->sem must be held. |
07e4a3e2 | 232 | */ |
4a3ad20c | 233 | int device_attach(struct device *dev) |
07e4a3e2 | 234 | { |
0d3e5a2e PM |
235 | int ret = 0; |
236 | ||
237 | down(&dev->sem); | |
07e4a3e2 | 238 | if (dev->driver) { |
f86db396 AM |
239 | ret = device_bind_driver(dev); |
240 | if (ret == 0) | |
241 | ret = 1; | |
c6a46696 CH |
242 | else { |
243 | dev->driver = NULL; | |
244 | ret = 0; | |
245 | } | |
21c7f30b | 246 | } else { |
5adc55da | 247 | ret = bus_for_each_drv(dev->bus, NULL, dev, __device_attach); |
21c7f30b | 248 | } |
0d3e5a2e PM |
249 | up(&dev->sem); |
250 | return ret; | |
2287c322 | 251 | } |
4a3ad20c | 252 | EXPORT_SYMBOL_GPL(device_attach); |
2287c322 | 253 | |
4a3ad20c | 254 | static int __driver_attach(struct device *dev, void *data) |
2287c322 | 255 | { |
4a3ad20c | 256 | struct device_driver *drv = data; |
0d3e5a2e PM |
257 | |
258 | /* | |
259 | * Lock device and try to bind to it. We drop the error | |
260 | * here and always return 0, because we need to keep trying | |
261 | * to bind to devices and some drivers will return an error | |
262 | * simply if it didn't support the device. | |
263 | * | |
264 | * driver_probe_device() will spit a warning if there | |
265 | * is an error. | |
266 | */ | |
267 | ||
49b420a1 | 268 | if (!driver_match_device(drv, dev)) |
6cd49586 AV |
269 | return 0; |
270 | ||
bf74ad5b AS |
271 | if (dev->parent) /* Needed for USB */ |
272 | down(&dev->parent->sem); | |
0d3e5a2e PM |
273 | down(&dev->sem); |
274 | if (!dev->driver) | |
275 | driver_probe_device(drv, dev); | |
276 | up(&dev->sem); | |
bf74ad5b AS |
277 | if (dev->parent) |
278 | up(&dev->parent->sem); | |
0d3e5a2e | 279 | |
07e4a3e2 | 280 | return 0; |
281 | } | |
282 | ||
283 | /** | |
4a3ad20c GKH |
284 | * driver_attach - try to bind driver to devices. |
285 | * @drv: driver. | |
07e4a3e2 | 286 | * |
4a3ad20c GKH |
287 | * Walk the list of devices that the bus has on it and try to |
288 | * match the driver with each one. If driver_probe_device() | |
289 | * returns 0 and the @dev->driver is set, we've found a | |
290 | * compatible pair. | |
07e4a3e2 | 291 | */ |
4a3ad20c | 292 | int driver_attach(struct device_driver *drv) |
07e4a3e2 | 293 | { |
f86db396 | 294 | return bus_for_each_dev(drv->bus, NULL, drv, __driver_attach); |
07e4a3e2 | 295 | } |
4a3ad20c | 296 | EXPORT_SYMBOL_GPL(driver_attach); |
07e4a3e2 | 297 | |
ab71c6f0 | 298 | /* |
4a3ad20c GKH |
299 | * __device_release_driver() must be called with @dev->sem held. |
300 | * When called for a USB interface, @dev->parent->sem must be held as well. | |
07e4a3e2 | 301 | */ |
4a3ad20c | 302 | static void __device_release_driver(struct device *dev) |
07e4a3e2 | 303 | { |
4a3ad20c | 304 | struct device_driver *drv; |
07e4a3e2 | 305 | |
ef2c5174 | 306 | drv = dev->driver; |
c95a6b05 | 307 | if (drv) { |
1901fb26 | 308 | driver_sysfs_remove(dev); |
0d3e5a2e | 309 | |
116af378 | 310 | if (dev->bus) |
c6f7e72a | 311 | blocking_notifier_call_chain(&dev->bus->p->bus_notifier, |
116af378 BH |
312 | BUS_NOTIFY_UNBIND_DRIVER, |
313 | dev); | |
314 | ||
0f836ca4 | 315 | if (dev->bus && dev->bus->remove) |
594c8281 RK |
316 | dev->bus->remove(dev); |
317 | else if (drv->remove) | |
0d3e5a2e | 318 | drv->remove(dev); |
9ac7849e | 319 | devres_release_all(dev); |
0d3e5a2e | 320 | dev->driver = NULL; |
cda5e83f | 321 | klist_remove(&dev->knode_driver); |
0d3e5a2e | 322 | } |
07e4a3e2 | 323 | } |
324 | ||
ab71c6f0 | 325 | /** |
4a3ad20c GKH |
326 | * device_release_driver - manually detach device from driver. |
327 | * @dev: device. | |
ab71c6f0 | 328 | * |
4a3ad20c GKH |
329 | * Manually detach device from driver. |
330 | * When called for a USB interface, @dev->parent->sem must be held. | |
ab71c6f0 | 331 | */ |
4a3ad20c | 332 | void device_release_driver(struct device *dev) |
94e7b1c5 | 333 | { |
c95a6b05 AS |
334 | /* |
335 | * If anyone calls device_release_driver() recursively from | |
336 | * within their ->remove callback for the same device, they | |
337 | * will deadlock right here. | |
338 | */ | |
339 | down(&dev->sem); | |
340 | __device_release_driver(dev); | |
341 | up(&dev->sem); | |
94e7b1c5 | 342 | } |
4a3ad20c | 343 | EXPORT_SYMBOL_GPL(device_release_driver); |
c95a6b05 | 344 | |
07e4a3e2 | 345 | /** |
346 | * driver_detach - detach driver from all devices it controls. | |
347 | * @drv: driver. | |
348 | */ | |
4a3ad20c | 349 | void driver_detach(struct device_driver *drv) |
07e4a3e2 | 350 | { |
4a3ad20c | 351 | struct device *dev; |
c95a6b05 AS |
352 | |
353 | for (;;) { | |
e5dd1278 GKH |
354 | spin_lock(&drv->p->klist_devices.k_lock); |
355 | if (list_empty(&drv->p->klist_devices.k_list)) { | |
356 | spin_unlock(&drv->p->klist_devices.k_lock); | |
c95a6b05 AS |
357 | break; |
358 | } | |
cda5e83f GKH |
359 | dev = list_entry(drv->p->klist_devices.k_list.prev, |
360 | struct device, knode_driver.n_node); | |
c95a6b05 | 361 | get_device(dev); |
e5dd1278 | 362 | spin_unlock(&drv->p->klist_devices.k_lock); |
c95a6b05 | 363 | |
bf74ad5b AS |
364 | if (dev->parent) /* Needed for USB */ |
365 | down(&dev->parent->sem); | |
c95a6b05 AS |
366 | down(&dev->sem); |
367 | if (dev->driver == drv) | |
368 | __device_release_driver(dev); | |
369 | up(&dev->sem); | |
bf74ad5b AS |
370 | if (dev->parent) |
371 | up(&dev->parent->sem); | |
c95a6b05 AS |
372 | put_device(dev); |
373 | } | |
07e4a3e2 | 374 | } |