driver.c 54.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * drivers/usb/driver.c - most of the driver model stuff for usb
 *
 * (C) Copyright 2005 Greg Kroah-Hartman <gregkh@suse.de>
 *
 * based on drivers/usb/usb.c which had the following copyrights:
 *	(C) Copyright Linus Torvalds 1999
 *	(C) Copyright Johannes Erdfelt 1999-2001
 *	(C) Copyright Andreas Gal 1999
 *	(C) Copyright Gregory P. Smith 1999
 *	(C) Copyright Deti Fliegl 1999 (new USB architecture)
 *	(C) Copyright Randy Dunlap 2000
 *	(C) Copyright David Brownell 2000-2004
 *	(C) Copyright Yggdrasil Computing, Inc. 2000
 *		(usb_device_id matching changes by Adam J. Richter)
 *	(C) Copyright Greg Kroah-Hartman 2002-2003
 *
 * NOTE! This is not actually a driver at all, rather this is
 * just a collection of helper routines that implement the
20
21
 * matching, probing, releasing, suspending and resuming for
 * real drivers.
22
23
24
25
 *
 */

#include <linux/device.h>
26
#include <linux/slab.h>
27
#include <linux/export.h>
28
#include <linux/usb.h>
29
#include <linux/usb/quirks.h>
30
31
#include <linux/usb/hcd.h>

32
33
#include "usb.h"

Alan Stern's avatar
Alan Stern committed
34

35
36
37
38
/*
 * Adds a new dynamic USBdevice ID to this driver,
 * and cause the driver to probe for all devices again.
 */
39
ssize_t usb_store_new_id(struct usb_dynids *dynids,
40
			 const struct usb_device_id *id_table,
41
42
			 struct device_driver *driver,
			 const char *buf, size_t count)
43
44
45
46
{
	struct usb_dynid *dynid;
	u32 idVendor = 0;
	u32 idProduct = 0;
47
	unsigned int bInterfaceClass = 0;
48
	u32 refVendor, refProduct;
49
	int fields = 0;
50
	int retval = 0;
51

52
53
	fields = sscanf(buf, "%x %x %x %x %x", &idVendor, &idProduct,
			&bInterfaceClass, &refVendor, &refProduct);
54
55
56
57
58
59
60
61
62
63
64
	if (fields < 2)
		return -EINVAL;

	dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
	if (!dynid)
		return -ENOMEM;

	INIT_LIST_HEAD(&dynid->node);
	dynid->id.idVendor = idVendor;
	dynid->id.idProduct = idProduct;
	dynid->id.match_flags = USB_DEVICE_ID_MATCH_DEVICE;
65
	if (fields > 2 && bInterfaceClass) {
66
67
68
69
		if (bInterfaceClass > 255) {
			retval = -EINVAL;
			goto fail;
		}
70

71
72
73
		dynid->id.bInterfaceClass = (u8)bInterfaceClass;
		dynid->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
	}
74

75
76
77
	if (fields > 4) {
		const struct usb_device_id *id = id_table;

78
79
80
81
		if (!id) {
			retval = -ENODEV;
			goto fail;
		}
82

83
		for (; id->match_flags; id++)
84
			if (id->idVendor == refVendor && id->idProduct == refProduct)
85
				break;
86

87
		if (id->match_flags) {
88
			dynid->id.driver_info = id->driver_info;
89
90
91
92
		} else {
			retval = -ENODEV;
			goto fail;
		}
93
94
	}

95
	spin_lock(&dynids->lock);
96
	list_add_tail(&dynid->node, &dynids->list);
97
	spin_unlock(&dynids->lock);
98

99
	retval = driver_attach(driver);
100

101
102
	if (retval)
		return retval;
103
	return count;
104
105
106
107

fail:
	kfree(dynid);
	return retval;
108
}
109
110
EXPORT_SYMBOL_GPL(usb_store_new_id);

111
ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf)
112
113
114
115
{
	struct usb_dynid *dynid;
	size_t count = 0;

116
	list_for_each_entry(dynid, &dynids->list, node)
117
118
119
120
121
122
123
124
125
		if (dynid->id.bInterfaceClass != 0)
			count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x %02x\n",
					   dynid->id.idVendor, dynid->id.idProduct,
					   dynid->id.bInterfaceClass);
		else
			count += scnprintf(&buf[count], PAGE_SIZE - count, "%04x %04x\n",
					   dynid->id.idVendor, dynid->id.idProduct);
	return count;
}
126
127
EXPORT_SYMBOL_GPL(usb_show_dynids);

128
static ssize_t new_id_show(struct device_driver *driver, char *buf)
129
130
131
132
133
{
	struct usb_driver *usb_drv = to_usb_driver(driver);

	return usb_show_dynids(&usb_drv->dynids, buf);
}
134

135
static ssize_t new_id_store(struct device_driver *driver,
136
137
138
139
			    const char *buf, size_t count)
{
	struct usb_driver *usb_drv = to_usb_driver(driver);

140
	return usb_store_new_id(&usb_drv->dynids, usb_drv->id_table, driver, buf, count);
141
}
142
static DRIVER_ATTR_RW(new_id);
143

144
145
/*
 * Remove a USB device ID from this driver
146
 */
147
148
static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
			       size_t count)
149
150
151
{
	struct usb_dynid *dynid, *n;
	struct usb_driver *usb_driver = to_usb_driver(driver);
152
153
154
	u32 idVendor;
	u32 idProduct;
	int fields;
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

	fields = sscanf(buf, "%x %x", &idVendor, &idProduct);
	if (fields < 2)
		return -EINVAL;

	spin_lock(&usb_driver->dynids.lock);
	list_for_each_entry_safe(dynid, n, &usb_driver->dynids.list, node) {
		struct usb_device_id *id = &dynid->id;
		if ((id->idVendor == idVendor) &&
		    (id->idProduct == idProduct)) {
			list_del(&dynid->node);
			kfree(dynid);
			break;
		}
	}
	spin_unlock(&usb_driver->dynids.lock);
	return count;
}
173
174
175
176
177
178

static ssize_t remove_id_show(struct device_driver *driver, char *buf)
{
	return new_id_show(driver, buf);
}
static DRIVER_ATTR_RW(remove_id);
179

180
static int usb_create_newid_files(struct usb_driver *usb_drv)
181
182
183
{
	int error = 0;

184
185
186
	if (usb_drv->no_dynamic_id)
		goto exit;

187
	if (usb_drv->probe != NULL) {
188
189
		error = driver_create_file(&usb_drv->drvwrap.driver,
					   &driver_attr_new_id);
190
191
192
193
194
195
196
197
		if (error == 0) {
			error = driver_create_file(&usb_drv->drvwrap.driver,
					&driver_attr_remove_id);
			if (error)
				driver_remove_file(&usb_drv->drvwrap.driver,
						&driver_attr_new_id);
		}
	}
198
exit:
199
200
201
	return error;
}

202
static void usb_remove_newid_files(struct usb_driver *usb_drv)
203
204
205
206
{
	if (usb_drv->no_dynamic_id)
		return;

207
	if (usb_drv->probe != NULL) {
208
		driver_remove_file(&usb_drv->drvwrap.driver,
209
				&driver_attr_remove_id);
210
211
212
		driver_remove_file(&usb_drv->drvwrap.driver,
				   &driver_attr_new_id);
	}
213
214
}

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
static void usb_free_dynids(struct usb_driver *usb_drv)
{
	struct usb_dynid *dynid, *n;

	spin_lock(&usb_drv->dynids.lock);
	list_for_each_entry_safe(dynid, n, &usb_drv->dynids.list, node) {
		list_del(&dynid->node);
		kfree(dynid);
	}
	spin_unlock(&usb_drv->dynids.lock);
}

static const struct usb_device_id *usb_match_dynamic_id(struct usb_interface *intf,
							struct usb_driver *drv)
{
	struct usb_dynid *dynid;

	spin_lock(&drv->dynids.lock);
	list_for_each_entry(dynid, &drv->dynids.list, node) {
		if (usb_match_one_id(intf, &dynid->id)) {
			spin_unlock(&drv->dynids.lock);
			return &dynid->id;
		}
	}
	spin_unlock(&drv->dynids.lock);
	return NULL;
}


244
245
246
247
/* called from driver core with dev locked */
static int usb_probe_device(struct device *dev)
{
	struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);
248
	struct usb_device *udev = to_usb_device(dev);
249
	int error = 0;
250

251
	dev_dbg(dev, "%s\n", __func__);
252
253
254

	/* TODO: Add real matching code */

255
	/* The device should always appear to be in use
256
	 * unless the driver supports autosuspend.
257
	 */
258
259
	if (!udriver->supports_autosuspend)
		error = usb_autoresume_device(udev);
260

261
262
	if (!error)
		error = udriver->probe(udev);
263
264
265
266
267
268
	return error;
}

/* called from driver core with dev locked */
static int usb_unbind_device(struct device *dev)
{
269
	struct usb_device *udev = to_usb_device(dev);
270
271
	struct usb_device_driver *udriver = to_usb_device_driver(dev->driver);

272
273
274
	udriver->disconnect(udev);
	if (!udriver->supports_autosuspend)
		usb_autosuspend_device(udev);
275
276
277
	return 0;
}

278
279
280
281
282
283
284
285
286
287
288
289
290
291
/*
 * Cancel any pending scheduled resets
 *
 * [see usb_queue_reset_device()]
 *
 * Called after unconfiguring / when releasing interfaces. See
 * comments in __usb_queue_reset_device() regarding
 * udev->reset_running.
 */
static void usb_cancel_queued_reset(struct usb_interface *iface)
{
	if (iface->reset_running == 0)
		cancel_work_sync(&iface->reset_ws);
}
292
293

/* called from driver core with dev locked */
294
295
static int usb_probe_interface(struct device *dev)
{
296
	struct usb_driver *driver = to_usb_driver(dev->driver);
297
298
	struct usb_interface *intf = to_usb_interface(dev);
	struct usb_device *udev = interface_to_usbdev(intf);
299
300
	const struct usb_device_id *id;
	int error = -ENODEV;
301
	int lpm_disable_error;
302

303
	dev_dbg(dev, "%s\n", __func__);
304

305
	intf->needs_binding = 0;
306

307
	if (usb_device_is_owned(udev))
308
		return error;
309

310
311
	if (udev->authorized == 0) {
		dev_err(&intf->dev, "Device is not authorized for usage\n");
312
		return error;
313
	}
314

315
	id = usb_match_dynamic_id(intf, driver);
316
	if (!id)
317
		id = usb_match_id(intf, driver->id_table);
318
319
	if (!id)
		return error;
320

321
322
323
324
325
326
327
	dev_dbg(dev, "%s - got id\n", __func__);

	error = usb_autoresume_device(udev);
	if (error)
		return error;

	intf->condition = USB_INTERFACE_BINDING;
328

329
	/* Probed interfaces are initially active.  They are
330
331
	 * runtime-PM-enabled only if the driver has autosuspend support.
	 * They are sensitive to their children's power states.
332
	 */
333
334
335
336
	pm_runtime_set_active(dev);
	pm_suspend_ignore_children(dev, false);
	if (driver->supports_autosuspend)
		pm_runtime_enable(dev);
337

338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
	/* If the new driver doesn't allow hub-initiated LPM, and we can't
	 * disable hub-initiated LPM, then fail the probe.
	 *
	 * Otherwise, leaving LPM enabled should be harmless, because the
	 * endpoint intervals should remain the same, and the U1/U2 timeouts
	 * should remain the same.
	 *
	 * If we need to install alt setting 0 before probe, or another alt
	 * setting during probe, that should also be fine.  usb_set_interface()
	 * will attempt to disable LPM, and fail if it can't disable it.
	 */
	lpm_disable_error = usb_unlocked_disable_lpm(udev);
	if (lpm_disable_error && driver->disable_hub_initiated_lpm) {
		dev_err(&intf->dev, "%s Failed to disable LPM for driver %s\n.",
				__func__, driver->name);
		error = lpm_disable_error;
		goto err;
	}

357
358
359
360
361
362
363
	/* Carry out a deferred switch to altsetting 0 */
	if (intf->needs_altsetting0) {
		error = usb_set_interface(udev, intf->altsetting[0].
				desc.bInterfaceNumber, 0);
		if (error < 0)
			goto err;
		intf->needs_altsetting0 = 0;
364
365
	}

366
367
368
369
370
	error = driver->probe(intf, id);
	if (error)
		goto err;

	intf->condition = USB_INTERFACE_BOUND;
371
372
373
374
375

	/* If the LPM disable succeeded, balance the ref counts. */
	if (!lpm_disable_error)
		usb_unlocked_enable_lpm(udev);

376
	usb_autosuspend_device(udev);
377
	return error;
378

379
 err:
380
	usb_set_intfdata(intf, NULL);
381
382
383
	intf->needs_remote_wakeup = 0;
	intf->condition = USB_INTERFACE_UNBOUND;
	usb_cancel_queued_reset(intf);
384

385
386
387
388
	/* If the LPM disable succeeded, balance the ref counts. */
	if (!lpm_disable_error)
		usb_unlocked_enable_lpm(udev);

389
	/* Unbound interfaces are always runtime-PM-disabled and -suspended */
390
391
	if (driver->supports_autosuspend)
		pm_runtime_disable(dev);
392
393
	pm_runtime_set_suspended(dev);

394
395
	usb_autosuspend_device(udev);
	return error;
396
397
}

398
/* called from driver core with dev locked */
399
400
static int usb_unbind_interface(struct device *dev)
{
401
	struct usb_driver *driver = to_usb_driver(dev->driver);
402
	struct usb_interface *intf = to_usb_interface(dev);
403
	struct usb_host_endpoint *ep, **eps = NULL;
404
	struct usb_device *udev;
405
	int i, j, error, r, lpm_disable_error;
406
407
408

	intf->condition = USB_INTERFACE_UNBINDING;

409
410
	/* Autoresume for set_interface call below */
	udev = interface_to_usbdev(intf);
411
	error = usb_autoresume_device(udev);
412

413
414
415
416
417
418
419
	/* Hub-initiated LPM policy may change, so attempt to disable LPM until
	 * the driver is unbound.  If LPM isn't disabled, that's fine because it
	 * wouldn't be enabled unless all the bound interfaces supported
	 * hub-initiated LPM.
	 */
	lpm_disable_error = usb_unlocked_disable_lpm(udev);

420
421
422
	/*
	 * Terminate all URBs for this interface unless the driver
	 * supports "soft" unbinding and the device is still present.
Alan Stern's avatar
Alan Stern committed
423
	 */
424
	if (!driver->soft_unbind || udev->state == USB_STATE_NOTATTACHED)
425
		usb_disable_interface(udev, intf, false);
426

427
	driver->disconnect(intf);
428
	usb_cancel_queued_reset(intf);
429

430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
	/* Free streams */
	for (i = 0, j = 0; i < intf->cur_altsetting->desc.bNumEndpoints; i++) {
		ep = &intf->cur_altsetting->endpoint[i];
		if (ep->streams == 0)
			continue;
		if (j == 0) {
			eps = kmalloc(USB_MAXENDPOINTS * sizeof(void *),
				      GFP_KERNEL);
			if (!eps) {
				dev_warn(dev, "oom, leaking streams\n");
				break;
			}
		}
		eps[j++] = ep;
	}
	if (j) {
		usb_free_streams(intf, eps, j, GFP_KERNEL);
		kfree(eps);
	}

450
451
452
453
454
455
	/* Reset other interface state.
	 * We cannot do a Set-Interface if the device is suspended or
	 * if it is prepared for a system sleep (since installing a new
	 * altsetting means creating new endpoint device entries).
	 * When either of these happens, defer the Set-Interface.
	 */
456
457
458
459
460
	if (intf->cur_altsetting->desc.bAlternateSetting == 0) {
		/* Already in altsetting 0 so skip Set-Interface.
		 * Just re-enable it without affecting the endpoint toggles.
		 */
		usb_enable_interface(udev, intf, false);
461
	} else if (!error && !intf->dev.power.is_prepared) {
462
		r = usb_set_interface(udev, intf->altsetting[0].
463
				desc.bInterfaceNumber, 0);
464
465
466
		if (r < 0)
			intf->needs_altsetting0 = 1;
	} else {
467
		intf->needs_altsetting0 = 1;
468
	}
469
	usb_set_intfdata(intf, NULL);
470

471
	intf->condition = USB_INTERFACE_UNBOUND;
472
473
	intf->needs_remote_wakeup = 0;

474
475
476
477
	/* Attempt to re-enable USB3 LPM, if the disable succeeded. */
	if (!lpm_disable_error)
		usb_unlocked_enable_lpm(udev);

478
	/* Unbound interfaces are always runtime-PM-disabled and -suspended */
479
480
	if (driver->supports_autosuspend)
		pm_runtime_disable(dev);
481
482
483
484
485
486
487
	pm_runtime_set_suspended(dev);

	/* Undo any residual pm_autopm_get_interface_* calls */
	for (r = atomic_read(&intf->pm_usage_cnt); r > 0; --r)
		usb_autopm_put_interface_no_suspend(intf);
	atomic_set(&intf->pm_usage_cnt, 0);

488
	if (!error)
489
		usb_autosuspend_device(udev);
490
491
492
493

	return 0;
}

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/**
 * usb_driver_claim_interface - bind a driver to an interface
 * @driver: the driver to be bound
 * @iface: the interface to which it will be bound; must be in the
 *	usb device's active configuration
 * @priv: driver data associated with that interface
 *
 * This is used by usb device drivers that need to claim more than one
 * interface on a device when probing (audio and acm are current examples).
 * No device driver should directly modify internal usb_interface or
 * usb_device structure members.
 *
 * Few drivers should need to use this routine, since the most natural
 * way to bind to an interface is to return the private data from
 * the driver's probe() method.
 *
510
511
512
 * Callers must own the device lock, so driver probe() entries don't need
 * extra locking, but other call contexts may need to explicitly claim that
 * lock.
513
514
 *
 * Return: 0 on success.
515
516
 */
int usb_driver_claim_interface(struct usb_driver *driver,
517
				struct usb_interface *iface, void *priv)
518
519
{
	struct device *dev = &iface->dev;
520
	struct usb_device *udev;
521
	int retval = 0;
522
	int lpm_disable_error;
523
524
525
526

	if (dev->driver)
		return -EBUSY;

527
528
	udev = interface_to_usbdev(iface);

529
	dev->driver = &driver->drvwrap.driver;
530
	usb_set_intfdata(iface, priv);
531
	iface->needs_binding = 0;
532

533
	iface->condition = USB_INTERFACE_BOUND;
534

535
536
537
538
539
540
541
542
	/* Disable LPM until this driver is bound. */
	lpm_disable_error = usb_unlocked_disable_lpm(udev);
	if (lpm_disable_error && driver->disable_hub_initiated_lpm) {
		dev_err(&iface->dev, "%s Failed to disable LPM for driver %s\n.",
				__func__, driver->name);
		return -ENOMEM;
	}

543
544
545
546
547
	/* Claimed interfaces are initially inactive (suspended) and
	 * runtime-PM-enabled, but only if the driver has autosuspend
	 * support.  Otherwise they are marked active, to prevent the
	 * device from being autosuspended, but left disabled.  In either
	 * case they are sensitive to their children's power states.
548
549
550
551
	 */
	pm_suspend_ignore_children(dev, false);
	if (driver->supports_autosuspend)
		pm_runtime_enable(dev);
552
553
	else
		pm_runtime_set_active(dev);
554
555
556
557
558

	/* if interface was already added, bind now; else let
	 * the future device_add() bind it, bypassing probe()
	 */
	if (device_is_registered(dev))
559
		retval = device_bind_driver(dev);
560

561
562
563
564
	/* Attempt to re-enable USB3 LPM, if the disable was successful. */
	if (!lpm_disable_error)
		usb_unlocked_enable_lpm(udev);

565
	return retval;
566
}
567
EXPORT_SYMBOL_GPL(usb_driver_claim_interface);
568
569
570
571
572
573
574
575
576
577
578

/**
 * usb_driver_release_interface - unbind a driver from an interface
 * @driver: the driver to be unbound
 * @iface: the interface from which it will be unbound
 *
 * This can be used by drivers to release an interface without waiting
 * for their disconnect() methods to be called.  In typical cases this
 * also causes the driver disconnect() method to be called.
 *
 * This call is synchronous, and may not be used in an interrupt context.
579
580
581
 * Callers must own the device lock, so driver disconnect() entries don't
 * need extra locking, but other call contexts may need to explicitly claim
 * that lock.
582
583
584
585
586
587
588
 */
void usb_driver_release_interface(struct usb_driver *driver,
					struct usb_interface *iface)
{
	struct device *dev = &iface->dev;

	/* this should never happen, don't release something that's not ours */
589
	if (!dev->driver || dev->driver != &driver->drvwrap.driver)
590
591
592
593
594
		return;

	/* don't release from within disconnect() */
	if (iface->condition != USB_INTERFACE_BOUND)
		return;
595
	iface->condition = USB_INTERFACE_UNBINDING;
596

597
598
599
	/* Release via the driver core only if the interface
	 * has already been registered
	 */
600
601
	if (device_is_registered(dev)) {
		device_release_driver(dev);
602
	} else {
603
		device_lock(dev);
604
605
		usb_unbind_interface(dev);
		dev->driver = NULL;
606
		device_unlock(dev);
607
608
	}
}
609
EXPORT_SYMBOL_GPL(usb_driver_release_interface);
610

611
/* returns 0 if no match, 1 if match */
612
int usb_match_device(struct usb_device *dev, const struct usb_device_id *id)
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
{
	if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
	    id->idVendor != le16_to_cpu(dev->descriptor.idVendor))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
	    id->idProduct != le16_to_cpu(dev->descriptor.idProduct))
		return 0;

	/* No need to test id->bcdDevice_lo != 0, since 0 is never
	   greater than any unsigned number. */
	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
	    (id->bcdDevice_lo > le16_to_cpu(dev->descriptor.bcdDevice)))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
	    (id->bcdDevice_hi < le16_to_cpu(dev->descriptor.bcdDevice)))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
	    (id->bDeviceClass != dev->descriptor.bDeviceClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
637
	    (id->bDeviceSubClass != dev->descriptor.bDeviceSubClass))
638
639
640
641
642
643
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
	    (id->bDeviceProtocol != dev->descriptor.bDeviceProtocol))
		return 0;

644
645
646
647
	return 1;
}

/* returns 0 if no match, 1 if match */
648
649
650
int usb_match_one_id_intf(struct usb_device *dev,
			  struct usb_host_interface *intf,
			  const struct usb_device_id *id)
651
{
652
	/* The interface class, subclass, protocol and number should never be
653
654
655
656
657
658
	 * checked for a match if the device class is Vendor Specific,
	 * unless the match record specifies the Vendor ID. */
	if (dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC &&
			!(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
			(id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
				USB_DEVICE_ID_MATCH_INT_SUBCLASS |
659
660
				USB_DEVICE_ID_MATCH_INT_PROTOCOL |
				USB_DEVICE_ID_MATCH_INT_NUMBER)))
661
662
		return 0;

663
664
665
666
667
668
669
670
671
672
673
674
	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
	    (id->bInterfaceClass != intf->desc.bInterfaceClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
	    (id->bInterfaceSubClass != intf->desc.bInterfaceSubClass))
		return 0;

	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
	    (id->bInterfaceProtocol != intf->desc.bInterfaceProtocol))
		return 0;

675
676
677
678
	if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
	    (id->bInterfaceNumber != intf->desc.bInterfaceNumber))
		return 0;

679
680
	return 1;
}
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700

/* returns 0 if no match, 1 if match */
int usb_match_one_id(struct usb_interface *interface,
		     const struct usb_device_id *id)
{
	struct usb_host_interface *intf;
	struct usb_device *dev;

	/* proc_connectinfo in devio.c may call us with id == NULL. */
	if (id == NULL)
		return 0;

	intf = interface->cur_altsetting;
	dev = interface_to_usbdev(interface);

	if (!usb_match_device(dev, id))
		return 0;

	return usb_match_one_id_intf(dev, intf, id);
}
701
702
EXPORT_SYMBOL_GPL(usb_match_one_id);

703
704
705
706
707
708
709
710
711
712
713
714
715
/**
 * usb_match_id - find first usb_device_id matching device or interface
 * @interface: the interface of interest
 * @id: array of usb_device_id structures, terminated by zero entry
 *
 * usb_match_id searches an array of usb_device_id's and returns
 * the first one matching the device or interface, or null.
 * This is used when binding (or rebinding) a driver to an interface.
 * Most USB device drivers will use this indirectly, through the usb core,
 * but some layered driver frameworks use it directly.
 * These device tables are exported with MODULE_DEVICE_TABLE, through
 * modutils, to support the driver loading functionality of USB hotplugging.
 *
716
717
 * Return: The first matching usb_device_id, or %NULL.
 *
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 * What Matches:
 *
 * The "match_flags" element in a usb_device_id controls which
 * members are used.  If the corresponding bit is set, the
 * value in the device_id must match its corresponding member
 * in the device or interface descriptor, or else the device_id
 * does not match.
 *
 * "driver_info" is normally used only by device drivers,
 * but you can create a wildcard "matches anything" usb_device_id
 * as a driver's "modules.usbmap" entry if you provide an id with
 * only a nonzero "driver_info" field.  If you do this, the USB device
 * driver's probe() routine should use additional intelligence to
 * decide whether to bind to the specified interface.
 *
 * What Makes Good usb_device_id Tables:
 *
 * The match algorithm is very simple, so that intelligence in
 * driver selection must come from smart driver id records.
 * Unless you have good reasons to use another selection policy,
 * provide match elements only in related groups, and order match
 * specifiers from specific to general.  Use the macros provided
 * for that purpose if you can.
 *
 * The most specific match specifiers use device descriptor
 * data.  These are commonly used with product-specific matches;
 * the USB_DEVICE macro lets you provide vendor and product IDs,
 * and you can also match against ranges of product revisions.
 * These are widely used for devices with application or vendor
 * specific bDeviceClass values.
 *
 * Matches based on device class/subclass/protocol specifications
 * are slightly more general; use the USB_DEVICE_INFO macro, or
 * its siblings.  These are used with single-function devices
 * where bDeviceClass doesn't specify that each interface has
 * its own class.
 *
 * Matches based on interface class/subclass/protocol are the
 * most general; they let drivers bind to any interface on a
 * multiple-function device.  Use the USB_INTERFACE_INFO
 * macro, or its siblings, to match class-per-interface style
759
760
761
762
763
764
765
766
767
768
769
 * devices (as recorded in bInterfaceClass).
 *
 * Note that an entry created by USB_INTERFACE_INFO won't match
 * any interface if the device class is set to Vendor-Specific.
 * This is deliberate; according to the USB spec the meanings of
 * the interface class/subclass/protocol for these devices are also
 * vendor-specific, and hence matching against a standard product
 * class wouldn't work anyway.  If you really want to use an
 * interface-based match for such a device, create a match record
 * that also specifies the vendor ID.  (Unforunately there isn't a
 * standard macro for creating records like this.)
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 *
 * Within those groups, remember that not all combinations are
 * meaningful.  For example, don't give a product version range
 * without vendor and product IDs; or specify a protocol without
 * its associated class and subclass.
 */
const struct usb_device_id *usb_match_id(struct usb_interface *interface,
					 const struct usb_device_id *id)
{
	/* proc_connectinfo in devio.c may call us with id == NULL. */
	if (id == NULL)
		return NULL;

	/* It is important to check that id->driver_info is nonzero,
	   since an entry that is all zeroes except for a nonzero
	   id->driver_info is the way to create an entry that
	   indicates that the driver want to examine every
	   device and interface. */
788
789
	for (; id->idVendor || id->idProduct || id->bDeviceClass ||
	       id->bInterfaceClass || id->driver_info; id++) {
790
791
		if (usb_match_one_id(interface, id))
			return id;
792
793
794
795
	}

	return NULL;
}
796
EXPORT_SYMBOL_GPL(usb_match_id);
797

798
static int usb_device_match(struct device *dev, struct device_driver *drv)
799
{
800
801
	/* devices and interfaces are handled separately */
	if (is_usb_device(dev)) {
802

803
804
805
		/* interface drivers never match devices */
		if (!is_usb_device_driver(drv))
			return 0;
806

807
		/* TODO: Add real matching code */
808
809
		return 1;

810
	} else if (is_usb_interface(dev)) {
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
		struct usb_interface *intf;
		struct usb_driver *usb_drv;
		const struct usb_device_id *id;

		/* device drivers never match interfaces */
		if (is_usb_device_driver(drv))
			return 0;

		intf = to_usb_interface(dev);
		usb_drv = to_usb_driver(drv);

		id = usb_match_id(intf, usb_drv->id_table);
		if (id)
			return 1;

		id = usb_match_dynamic_id(intf, usb_drv);
		if (id)
			return 1;
	}

831
832
833
	return 0;
}

834
static int usb_uevent(struct device *dev, struct kobj_uevent_env *env)
835
836
837
{
	struct usb_device *usb_dev;

838
	if (is_usb_device(dev)) {
839
		usb_dev = to_usb_device(dev);
840
	} else if (is_usb_interface(dev)) {
841
		struct usb_interface *intf = to_usb_interface(dev);
842

843
		usb_dev = interface_to_usbdev(intf);
844
845
	} else {
		return 0;
846
	}
847
848

	if (usb_dev->devnum < 0) {
849
		/* driver is often null here; dev_dbg() would oops */
850
		pr_debug("usb %s: already deleted?\n", dev_name(dev));
851
852
853
		return -ENODEV;
	}
	if (!usb_dev->bus) {
854
		pr_debug("usb %s: bus removed?\n", dev_name(dev));
855
856
857
858
		return -ENODEV;
	}

	/* per-device configurations are common */
859
	if (add_uevent_var(env, "PRODUCT=%x/%x/%x",
860
861
862
863
864
865
			   le16_to_cpu(usb_dev->descriptor.idVendor),
			   le16_to_cpu(usb_dev->descriptor.idProduct),
			   le16_to_cpu(usb_dev->descriptor.bcdDevice)))
		return -ENOMEM;

	/* class-based driver binding models */
866
	if (add_uevent_var(env, "TYPE=%d/%d/%d",
867
868
869
870
871
872
873
874
			   usb_dev->descriptor.bDeviceClass,
			   usb_dev->descriptor.bDeviceSubClass,
			   usb_dev->descriptor.bDeviceProtocol))
		return -ENOMEM;

	return 0;
}

875
/**
876
877
 * usb_register_device_driver - register a USB device (not interface) driver
 * @new_udriver: USB operations for the device driver
878
 * @owner: module owner of this driver.
879
 *
880
881
882
 * Registers a USB device driver with the USB core.  The list of
 * unattached devices will be rescanned whenever a new driver is
 * added, allowing the new driver to attach to any recognized devices.
883
884
 *
 * Return: A negative error code on failure and 0 on success.
885
886
887
888
889
890
891
892
893
894
 */
int usb_register_device_driver(struct usb_device_driver *new_udriver,
		struct module *owner)
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

	new_udriver->drvwrap.for_devices = 1;
895
	new_udriver->drvwrap.driver.name = new_udriver->name;
896
897
898
899
900
901
902
	new_udriver->drvwrap.driver.bus = &usb_bus_type;
	new_udriver->drvwrap.driver.probe = usb_probe_device;
	new_udriver->drvwrap.driver.remove = usb_unbind_device;
	new_udriver->drvwrap.driver.owner = owner;

	retval = driver_register(&new_udriver->drvwrap.driver);

903
	if (!retval)
904
905
		pr_info("%s: registered new device driver %s\n",
			usbcore_name, new_udriver->name);
906
	else
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
		printk(KERN_ERR "%s: error %d registering device "
			"	driver %s\n",
			usbcore_name, retval, new_udriver->name);

	return retval;
}
EXPORT_SYMBOL_GPL(usb_register_device_driver);

/**
 * usb_deregister_device_driver - unregister a USB device (not interface) driver
 * @udriver: USB operations of the device driver to unregister
 * Context: must be able to sleep
 *
 * Unlinks the specified driver from the internal USB driver list.
 */
void usb_deregister_device_driver(struct usb_device_driver *udriver)
{
	pr_info("%s: deregistering device driver %s\n",
			usbcore_name, udriver->name);

	driver_unregister(&udriver->drvwrap.driver);
}
EXPORT_SYMBOL_GPL(usb_deregister_device_driver);

/**
 * usb_register_driver - register a USB interface driver
 * @new_driver: USB operations for the interface driver
 * @owner: module owner of this driver.
Randy Dunlap's avatar
Randy Dunlap committed
935
 * @mod_name: module name string
936
937
938
939
 *
 * Registers a USB interface driver with the USB core.  The list of
 * unattached interfaces will be rescanned whenever a new driver is
 * added, allowing the new driver to attach to any recognized interfaces.
940
941
 *
 * Return: A negative error code on failure and 0 on success.
942
943
944
945
946
 *
 * NOTE: if you want your driver to use the USB major number, you must call
 * usb_register_dev() to enable that functionality.  This function no longer
 * takes care of that.
 */
947
948
int usb_register_driver(struct usb_driver *new_driver, struct module *owner,
			const char *mod_name)
949
950
951
952
953
954
{
	int retval = 0;

	if (usb_disabled())
		return -ENODEV;

955
	new_driver->drvwrap.for_devices = 0;
956
	new_driver->drvwrap.driver.name = new_driver->name;
957
958
959
960
	new_driver->drvwrap.driver.bus = &usb_bus_type;
	new_driver->drvwrap.driver.probe = usb_probe_interface;
	new_driver->drvwrap.driver.remove = usb_unbind_interface;
	new_driver->drvwrap.driver.owner = owner;
961
	new_driver->drvwrap.driver.mod_name = mod_name;
962
963
	spin_lock_init(&new_driver->dynids.lock);
	INIT_LIST_HEAD(&new_driver->dynids.list);
964

965
	retval = driver_register(&new_driver->drvwrap.driver);
966
967
	if (retval)
		goto out;
968

969
	retval = usb_create_newid_files(new_driver);
970
971
972
973
	if (retval)
		goto out_newid;

	pr_info("%s: registered new interface driver %s\n",
974
975
			usbcore_name, new_driver->name);

976
out:
977
	return retval;
978
979
980
981
982
983
984
985

out_newid:
	driver_unregister(&new_driver->drvwrap.driver);

	printk(KERN_ERR "%s: error %d registering interface "
			"	driver %s\n",
			usbcore_name, retval, new_driver->name);
	goto out;
986
}
987
EXPORT_SYMBOL_GPL(usb_register_driver);
988
989

/**
990
991
 * usb_deregister - unregister a USB interface driver
 * @driver: USB operations of the interface driver to unregister
992
993
994
995
996
997
998
999
1000
1001
 * Context: must be able to sleep
 *
 * Unlinks the specified driver from the internal USB driver list.
 *
 * NOTE: If you called usb_register_dev(), you still need to call
 * usb_deregister_dev() to clean up your driver's allocated minor numbers,
 * this * call will no longer do it for you.
 */
void usb_deregister(struct usb_driver *driver)
{
1002
1003
	pr_info("%s: deregistering interface driver %s\n",
			usbcore_name, driver->name);
1004

1005
	usb_remove_newid_files(driver);
1006
	driver_unregister(&driver->drvwrap.driver);
1007
	usb_free_dynids(driver);
1008
}
1009
EXPORT_SYMBOL_GPL(usb_deregister);
1010

1011
1012
1013
1014
/* Forced unbinding of a USB interface driver, either because
 * it doesn't support pre_reset/post_reset/reset_resume or
 * because it doesn't support suspend/resume.
 *
1015
 * The caller must hold @intf's device's lock, but not @intf's lock.
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 */
void usb_forced_unbind_intf(struct usb_interface *intf)
{
	struct usb_driver *driver = to_usb_driver(intf->dev.driver);

	dev_dbg(&intf->dev, "forced unbind\n");
	usb_driver_release_interface(driver, intf);

	/* Mark the interface for later rebinding */
	intf->needs_binding = 1;
}

1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
/*
 * Unbind drivers for @udev's marked interfaces.  These interfaces have
 * the needs_binding flag set, for example by usb_resume_interface().
 *
 * The caller must hold @udev's device lock.
 */
static void unbind_marked_interfaces(struct usb_device *udev)
{
	struct usb_host_config	*config;
	int			i;
	struct usb_interface	*intf;

	config = udev->actconfig;
	if (config) {
		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
			intf = config->interface[i];
			if (intf->dev.driver && intf->needs_binding)
				usb_forced_unbind_intf(intf);
		}
	}
}

1050
1051
1052
/* Delayed forced unbinding of a USB interface driver and scan
 * for rebinding.
 *
1053
 * The caller must hold @intf's device's lock, but not @intf's lock.
1054
 *
1055
1056
 * Note: Rebinds will be skipped if a system sleep transition is in
 * progress and the PM "complete" callback hasn't occurred yet.
1057
 */
1058
static void usb_rebind_intf(struct usb_interface *intf)
1059
1060
1061
1062
{
	int rc;

	/* Delayed unbind of an existing driver */
1063
1064
	if (intf->dev.driver)
		usb_forced_unbind_intf(intf);
1065
1066

	/* Try to rebind the interface */
1067
	if (!intf->dev.power.is_prepared) {
1068
1069
1070
1071
1072
		intf->needs_binding = 0;
		rc = device_attach(&intf->dev);
		if (rc < 0)
			dev_warn(&intf->dev, "rebind failed: %d\n", rc);
	}
1073
1074
}

1075
1076
1077
/*
 * Rebind drivers to @udev's marked interfaces.  These interfaces have
 * the needs_binding flag set.
1078
1079
1080
 *
 * The caller must hold @udev's device lock.
 */
1081
static void rebind_marked_interfaces(struct usb_device *udev)
1082
1083
1084
1085
1086
1087
1088
1089
1090
{
	struct usb_host_config	*config;
	int			i;
	struct usb_interface	*intf;

	config = udev->actconfig;
	if (config) {
		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
			intf = config->interface[i];
1091
1092
			if (intf->needs_binding)
				usb_rebind_intf(intf);
1093
1094
1095
1096
		}
	}
}

1097
1098
1099
1100
/*
 * Unbind all of @udev's marked interfaces and then rebind all of them.
 * This ordering is necessary because some drivers claim several interfaces
 * when they are first probed.
1101
1102
1103
 *
 * The caller must hold @udev's device lock.
 */
1104
void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev)
1105
{
1106
1107
	unbind_marked_interfaces(udev);
	rebind_marked_interfaces(udev);
1108
1109
}

1110
1111
1112
1113
1114
1115
1116
1117
1118
#ifdef CONFIG_PM

/* Unbind drivers for @udev's interfaces that don't support suspend/resume
 * There is no check for reset_resume here because it can be determined
 * only during resume whether reset_resume is needed.
 *
 * The caller must hold @udev's device lock.
 */
static void unbind_no_pm_drivers_interfaces(struct usb_device *udev)
1119
1120
1121
1122
{
	struct usb_host_config	*config;
	int			i;
	struct usb_interface	*intf;
1123
	struct usb_driver	*drv;
1124
1125
1126
1127
1128

	config = udev->actconfig;
	if (config) {
		for (i = 0; i < config->desc.bNumInterfaces; ++i) {
			intf = config->interface[i];
1129
1130
1131
1132
1133
1134

			if (intf->dev.driver) {
				drv = to_usb_driver(intf->dev.driver);
				if (!drv->suspend || !drv->resume)
					usb_forced_unbind_intf(intf);
			}
1135
1136
1137
1138
		}
	}
}

1139
static int usb_suspend_device(struct usb_device *udev, pm_message_t msg)
1140
{
1141
	struct usb_device_driver	*udriver;
1142
	int				status = 0;
1143

1144
1145
1146
1147
	if (udev->state == USB_STATE_NOTATTACHED ||
			udev->state == USB_STATE_SUSPENDED)
		goto done;

1148
1149
1150
1151
	/* For devices that don't have a driver, we do a generic suspend. */
	if (udev->dev.driver)
		udriver = to_usb_device_driver(udev->dev.driver);
	else {
1152
		udev->do_remote_wakeup = 0;
1153
		udriver = &usb_generic_driver;
1154
	}
1155
1156
	status = udriver->suspend(udev, msg);

Alan Stern's avatar
Alan Stern committed
1157
 done:
1158
	dev_vdbg(&udev->dev, "%s: status %d\n", __func__, status);
1159
	return status;
1160
1161
}

1162
static int usb_resume_device(struct usb_device *udev, pm_message_t msg)
1163
1164
{
	struct usb_device_driver	*udriver;
1165
	int				status = 0;
1166

Alan Stern's avatar
Alan Stern committed
1167
1168
	if (udev->state == USB_STATE_NOTATTACHED)
		goto done;
1169

1170
1171
1172
	/* Can't resume it if it doesn't have a driver. */
	if (udev->dev.driver == NULL) {
		status = -ENOTCONN;
1173
		goto done;
1174
1175
	}

1176
1177
1178
	/* Non-root devices on a full/low-speed bus must wait for their
	 * companion high-speed root hub, in case a handoff is needed.
	 */
1179
	if (!PMSG_IS_AUTO(msg) && udev->parent && udev->bus->hs_companion)
1180
1181
1182
		device_pm_wait_for_dev(&udev->dev,
				&udev->bus->hs_companion->root_hub->dev);

1183
1184
1185
	if (udev->quirks & USB_QUIRK_RESET_RESUME)
		udev->reset_resume = 1;

1186
	udriver = to_usb_device_driver(udev->dev.driver);
1187
	status = udriver->resume(udev, msg);
1188

Alan Stern's avatar
Alan Stern committed
1189
 done: