usb.c 37.4 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4
/*
 * drivers/usb/usb.c
 *
 * (C) Copyright Linus Torvalds 1999
Linus Torvalds's avatar
Linus Torvalds committed
5
 * (C) Copyright Johannes Erdfelt 1999-2001
Linus Torvalds's avatar
Linus Torvalds committed
6 7 8 9
 * (C) Copyright Andreas Gal 1999
 * (C) Copyright Gregory P. Smith 1999
 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
 * (C) Copyright Randy Dunlap 2000
Linus Torvalds's avatar
Linus Torvalds committed
10 11
 * (C) Copyright David Brownell 2000-2001 (kernel hotplug, usb_device_id,
 	more docs, etc)
Linus Torvalds's avatar
Linus Torvalds committed
12 13
 * (C) Copyright Yggdrasil Computing, Inc. 2000
 *     (usb_device_id matching changes by Adam J. Richter)
14
 * (C) Copyright Greg Kroah-Hartman 2002
Linus Torvalds's avatar
Linus Torvalds committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * NOTE! This is not actually a driver at all, rather this is
 * just a collection of helper routines that implement the
 * generic USB things that the real drivers can use..
 *
 * Think of this as a "USB library" rather than anything else.
 * It should be considered a slave, with no callbacks. Callbacks
 * are evil.
 */

#include <linux/config.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/bitops.h>
Linus Torvalds's avatar
Linus Torvalds committed
29
#include <linux/slab.h>
Linus Torvalds's avatar
Linus Torvalds committed
30 31 32
#include <linux/interrupt.h>  /* for in_interrupt() */
#include <linux/kmod.h>
#include <linux/init.h>
Linus Torvalds's avatar
Linus Torvalds committed
33
#include <linux/spinlock.h>
34
#include <linux/errno.h>
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38 39 40 41 42

#ifdef CONFIG_USB_DEBUG
	#define DEBUG
#else
	#undef DEBUG
#endif
#include <linux/usb.h>

43
#include "hcd.h"
Linus Torvalds's avatar
Linus Torvalds committed
44 45 46

extern int  usb_hub_init(void);
extern void usb_hub_cleanup(void);
47 48
extern int usb_major_init(void);
extern void usb_major_cleanup(void);
Linus Torvalds's avatar
Linus Torvalds committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

/*
 * Prototypes for the device driver probing/loading functions
 */
static void usb_find_drivers(struct usb_device *);
static int  usb_find_interface_driver(struct usb_device *, unsigned int);
static void usb_check_support(struct usb_device *);

/*
 * We have a per-interface "registered driver" list.
 */
LIST_HEAD(usb_driver_list);


/**
64 65
 * usb_register - register a USB driver
 * @new_driver: USB operations for the driver
Linus Torvalds's avatar
Linus Torvalds committed
66
 *
67 68 69 70 71 72 73 74
 * Registers a USB 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 devices.
 * Returns a negative error code on failure and 0 on success.
 * 
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
75 76 77
 */
int usb_register(struct usb_driver *new_driver)
{
78
	int retval = 0;
Linus Torvalds's avatar
Linus Torvalds committed
79 80 81 82 83 84 85 86 87 88

	info("registered new driver %s", new_driver->name);

	init_MUTEX(&new_driver->serialize);

	/* Add it to the list of known drivers */
	list_add_tail(&new_driver->driver_list, &usb_driver_list);

	usb_scan_devices();

Linus Torvalds's avatar
Linus Torvalds committed
89 90
	usbfs_update_special();

91 92 93 94
	return retval;
}


Linus Torvalds's avatar
Linus Torvalds committed
95 96
/**
 *	usb_scan_devices - scans all unclaimed USB interfaces
97
 *	Context: !in_interrupt ()
Linus Torvalds's avatar
Linus Torvalds committed
98 99 100 101
 *
 *	Goes through all unclaimed USB interfaces, and offers them to all
 *	registered USB drivers through the 'probe' function.
 *	This will automatically be called after usb_register is called.
Linus Torvalds's avatar
Linus Torvalds committed
102 103
 *	It is called by some of the subsystems layered over USB
 *	after one of their subdrivers are registered.
Linus Torvalds's avatar
Linus Torvalds committed
104 105 106 107 108
 */
void usb_scan_devices(void)
{
	struct list_head *tmp;

Linus Torvalds's avatar
Linus Torvalds committed
109
	down (&usb_bus_list_lock);
Linus Torvalds's avatar
Linus Torvalds committed
110 111 112 113 114 115 116
	tmp = usb_bus_list.next;
	while (tmp != &usb_bus_list) {
		struct usb_bus *bus = list_entry(tmp,struct usb_bus, bus_list);

		tmp = tmp->next;
		usb_check_support(bus->root_hub);
	}
Linus Torvalds's avatar
Linus Torvalds committed
117
	up (&usb_bus_list_lock);
Linus Torvalds's avatar
Linus Torvalds committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
}

/*
 * This function is part of a depth-first search down the device tree,
 * removing any instances of a device driver.
 */
static void usb_drivers_purge(struct usb_driver *driver,struct usb_device *dev)
{
	int i;

	if (!dev) {
		err("null device being purged!!!");
		return;
	}

	for (i=0; i<USB_MAXCHILDREN; i++)
		if (dev->children[i])
			usb_drivers_purge(driver, dev->children[i]);

	if (!dev->actconfig)
		return;
			
	for (i = 0; i < dev->actconfig->bNumInterfaces; i++) {
		struct usb_interface *interface = &dev->actconfig->interface[i];
		
		if (interface->driver == driver) {
Linus Torvalds's avatar
Linus Torvalds committed
144 145
			if (driver->owner)
				__MOD_INC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
146 147 148
			down(&driver->serialize);
			driver->disconnect(dev, interface->private_data);
			up(&driver->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
149 150
			if (driver->owner)
				__MOD_DEC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
151 152 153
			/* if driver->disconnect didn't release the interface */
			if (interface->driver)
				usb_driver_release_interface(driver, interface);
Linus Torvalds's avatar
Linus Torvalds committed
154 155 156 157 158 159 160 161 162 163
			/*
			 * This will go through the list looking for another
			 * driver that can handle the device
			 */
			usb_find_interface_driver(dev, i);
		}
	}
}

/**
164 165 166
 * usb_deregister - unregister a USB driver
 * @driver: USB operations of the driver to unregister
 * Context: !in_interrupt ()
Linus Torvalds's avatar
Linus Torvalds committed
167
 *
168 169 170 171 172
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
173 174 175 176 177 178
 */
void usb_deregister(struct usb_driver *driver)
{
	struct list_head *tmp;

	info("deregistering driver %s", driver->name);
179

Linus Torvalds's avatar
Linus Torvalds committed
180 181 182 183 184 185
	/*
	 * first we remove the driver, to be sure it doesn't get used by
	 * another thread while we are stepping through removing entries
	 */
	list_del(&driver->driver_list);

Linus Torvalds's avatar
Linus Torvalds committed
186
	down (&usb_bus_list_lock);
Linus Torvalds's avatar
Linus Torvalds committed
187 188 189 190 191 192 193
	tmp = usb_bus_list.next;
	while (tmp != &usb_bus_list) {
		struct usb_bus *bus = list_entry(tmp,struct usb_bus,bus_list);

		tmp = tmp->next;
		usb_drivers_purge(driver, bus->root_hub);
	}
Linus Torvalds's avatar
Linus Torvalds committed
194
	up (&usb_bus_list_lock);
Linus Torvalds's avatar
Linus Torvalds committed
195 196

	usbfs_update_special();
Linus Torvalds's avatar
Linus Torvalds committed
197 198
}

Greg Kroah-Hartman's avatar
USB  
Greg Kroah-Hartman committed
199 200
/**
 * usb_ifnum_to_ifpos - convert the interface number to the interface position
Dan Streetman's avatar
Dan Streetman committed
201 202 203
 * @dev: the device to use
 * @ifnum: the interface number (bInterfaceNumber); not interface position
 *
Greg Kroah-Hartman's avatar
USB  
Greg Kroah-Hartman committed
204 205 206 207 208
 * This is used to convert the interface _number_ (as in
 * interface.bInterfaceNumber) to the interface _position_ (as in
 * dev->actconfig->interface + position).  Note that the number is the same as
 * the position for all interfaces _except_ devices with interfaces not
 * sequentially numbered (e.g., 0, 2, 3, etc).
Dan Streetman's avatar
Dan Streetman committed
209 210 211 212 213 214 215 216 217 218 219 220
 */
int usb_ifnum_to_ifpos(struct usb_device *dev, unsigned ifnum)
{
	int i;

	for (i = 0; i < dev->actconfig->bNumInterfaces; i++)
		if (dev->actconfig->interface[i].altsetting[0].bInterfaceNumber == ifnum)
			return i;

	return -EINVAL;
}

Linus Torvalds's avatar
Linus Torvalds committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/**
 * usb_ifnum_to_if - get the interface object with a given interface number
 * @dev: the device whose current configuration is considered
 * @ifnum: the desired interface
 *
 * This walks the device descriptor for the currently active configuration
 * and returns a pointer to the interface with that particular interface
 * number, or null.
 *
 * Note that configuration descriptors are not required to assign interface
 * numbers sequentially, so that it would be incorrect to assume that
 * the first interface in that descriptor corresponds to interface zero.
 * This routine helps device drivers avoid such mistakes.
 * However, you should make sure that you do the right thing with any
 * alternate settings available for this interfaces.
 */
Linus Torvalds's avatar
Linus Torvalds committed
237 238 239 240 241 242 243 244 245 246 247
struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum)
{
	int i;

	for (i = 0; i < dev->actconfig->bNumInterfaces; i++)
		if (dev->actconfig->interface[i].altsetting[0].bInterfaceNumber == ifnum)
			return &dev->actconfig->interface[i];

	return NULL;
}

Linus Torvalds's avatar
Linus Torvalds committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * usb_epnum_to_ep_desc - get the endpoint object with a given endpoint number
 * @dev: the device whose current configuration is considered
 * @epnum: the desired endpoint
 *
 * This walks the device descriptor for the currently active configuration,
 * and returns a pointer to the endpoint with that particular endpoint
 * number, or null.
 *
 * Note that interface descriptors are not required to assign endpont
 * numbers sequentially, so that it would be incorrect to assume that
 * the first endpoint in that descriptor corresponds to interface zero.
 * This routine helps device drivers avoid such mistakes.
 */
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
struct usb_endpoint_descriptor *usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum)
{
	int i, j, k;

	for (i = 0; i < dev->actconfig->bNumInterfaces; i++)
		for (j = 0; j < dev->actconfig->interface[i].num_altsetting; j++)
			for (k = 0; k < dev->actconfig->interface[i].altsetting[j].bNumEndpoints; k++)
				if (epnum == dev->actconfig->interface[i].altsetting[j].endpoint[k].bEndpointAddress)
					return &dev->actconfig->interface[i].altsetting[j].endpoint[k];

	return NULL;
}

/*
 * This function is for doing a depth-first search for devices which
 * have support, for dynamic loading of driver modules.
 */
static void usb_check_support(struct usb_device *dev)
{
	int i;

	if (!dev) {
		err("null device being checked!!!");
		return;
	}

	for (i=0; i<USB_MAXCHILDREN; i++)
		if (dev->children[i])
			usb_check_support(dev->children[i]);

	if (!dev->actconfig)
		return;

	/* now we check this device */
	if (dev->devnum > 0)
		for (i = 0; i < dev->actconfig->bNumInterfaces; i++)
			usb_find_interface_driver(dev, i);
}


Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * 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
 * @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.  Any driver that does use this must
 * first be sure that no other driver has claimed the interface, by
 * checking with usb_interface_claimed().
Linus Torvalds's avatar
Linus Torvalds committed
318 319 320 321 322 323
 */
void usb_driver_claim_interface(struct usb_driver *driver, struct usb_interface *iface, void* priv)
{
	if (!iface || !driver)
		return;

Linus Torvalds's avatar
Linus Torvalds committed
324 325 326 327 328 329
	// FIXME change API to report an error in this case
	if (iface->driver)
	    err ("%s driver booted %s off interface %p",
	    	driver->name, iface->driver->name, iface);
	else
	    dbg("%s driver claimed interface %p", driver->name, iface);
Linus Torvalds's avatar
Linus Torvalds committed
330 331 332 333 334

	iface->driver = driver;
	iface->private_data = priv;
} /* usb_driver_claim_interface() */

Linus Torvalds's avatar
Linus Torvalds committed
335 336 337 338
/**
 * usb_interface_claimed - returns true iff an interface is claimed
 * @iface: the interface being checked
 *
Linus Torvalds's avatar
Linus Torvalds committed
339
 * This should be used by drivers to check other interfaces to see if
Linus Torvalds's avatar
Linus Torvalds committed
340 341 342 343 344
 * they are available or not.  If another driver has claimed the interface,
 * they may not claim it.  Otherwise it's OK to claim it using
 * usb_driver_claim_interface().
 *
 * Returns true (nonzero) iff the interface is claimed, else false (zero).
Linus Torvalds's avatar
Linus Torvalds committed
345 346 347 348 349 350 351 352 353
 */
int usb_interface_claimed(struct usb_interface *iface)
{
	if (!iface)
		return 0;

	return (iface->driver != NULL);
} /* usb_interface_claimed() */

Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357 358 359 360 361 362 363 364 365 366
/**
 * 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 should be used by drivers to release their claimed interfaces.
 * It is normally called in their disconnect() methods, and only for
 * drivers that bound to more than one interface in their probe().
 *
 * When the USB subsystem disconnect()s a driver from some interface,
 * it automatically invokes this method for that interface.  That
 * means that even drivers that used usb_driver_claim_interface()
 * usually won't need to call this.
Linus Torvalds's avatar
Linus Torvalds committed
367 368 369 370 371 372 373 374 375 376 377 378
 */
void usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface)
{
	/* this should never happen, don't release something that's not ours */
	if (!iface || iface->driver != driver)
		return;

	iface->driver = NULL;
	iface->private_data = NULL;
}


Linus Torvalds's avatar
Linus Torvalds committed
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
/**
 * usb_match_id - find first usb_device_id matching device or interface
 * @dev: the device whose descriptors are considered when matching
 * @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 and "modules.usbmap", to support the driver loading
 * functionality of USB hotplugging.
 *
 * 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,
Linus Torvalds's avatar
Linus Torvalds committed
421
 * and you can also match against ranges of product revisions.
Linus Torvalds's avatar
Linus Torvalds committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
 * 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 
 * devices (as recorded in bDeviceClass).
 *  
 * 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.
 */   
Linus Torvalds's avatar
Linus Torvalds committed
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
const struct usb_device_id *
usb_match_id(struct usb_device *dev, struct usb_interface *interface,
	     const struct usb_device_id *id)
{
	struct usb_interface_descriptor	*intf = 0;

	/* 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. */
	for (; id->idVendor || id->bDeviceClass || id->bInterfaceClass ||
	       id->driver_info; id++) {

		if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
		    id->idVendor != dev->descriptor.idVendor)
			continue;

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

		/* 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 > dev->descriptor.bcdDevice))
			continue;

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

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

		if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
		    (id->bDeviceSubClass!= dev->descriptor.bDeviceSubClass))
			continue;

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

		intf = &interface->altsetting [interface->act_altsetting];

		if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
		    (id->bInterfaceClass != intf->bInterfaceClass))
			continue;

		if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
		    (id->bInterfaceSubClass != intf->bInterfaceSubClass))
		    continue;

		if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
		    (id->bInterfaceProtocol != intf->bInterfaceProtocol))
		    continue;

		return id;
	}

	return NULL;
}

/*
 * This entrypoint gets called for each new device.
 *
 * We now walk the list of registered USB drivers,
 * looking for one that will accept this interface.
 *
 * "New Style" drivers use a table describing the devices and interfaces
 * they handle.  Those tables are available to user mode tools deciding
 * whether to load driver modules for a new device.
 *
 * The probe return value is changed to be a private pointer.  This way
 * the drivers don't have to dig around in our structures to set the
 * private pointer if they only need one interface. 
 *
 * Returns: 0 if a driver accepted the interface, -1 otherwise
 */
static int usb_find_interface_driver(struct usb_device *dev, unsigned ifnum)
{
	struct list_head *tmp;
	struct usb_interface *interface;
	void *private;
	const struct usb_device_id *id;
	struct usb_driver *driver;
	int i;
	
	if ((!dev) || (ifnum >= dev->actconfig->bNumInterfaces)) {
		err("bad find_interface_driver params");
		return -1;
	}

Linus Torvalds's avatar
Linus Torvalds committed
540 541
	down(&dev->serialize);

Linus Torvalds's avatar
Linus Torvalds committed
542 543 544
	interface = dev->actconfig->interface + ifnum;

	if (usb_interface_claimed(interface))
Linus Torvalds's avatar
Linus Torvalds committed
545
		goto out_err;
Linus Torvalds's avatar
Linus Torvalds committed
546 547 548 549 550 551

	private = NULL;
	for (tmp = usb_driver_list.next; tmp != &usb_driver_list;) {
		driver = list_entry(tmp, struct usb_driver, driver_list);
		tmp = tmp->next;

Linus Torvalds's avatar
Linus Torvalds committed
552 553
		if (driver->owner)
			__MOD_INC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
554 555 556 557 558 559 560
		id = driver->id_table;
		/* new style driver? */
		if (id) {
			for (i = 0; i < interface->num_altsetting; i++) {
			  	interface->act_altsetting = i;
				id = usb_match_id(dev, interface, id);
				if (id) {
Linus Torvalds's avatar
Linus Torvalds committed
561
					down(&driver->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
562
					private = driver->probe(dev,ifnum,id);
Linus Torvalds's avatar
Linus Torvalds committed
563
					up(&driver->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
564 565 566 567
					if (private != NULL)
						break;
				}
			}
Linus Torvalds's avatar
Linus Torvalds committed
568

Linus Torvalds's avatar
Linus Torvalds committed
569 570 571
			/* if driver not bound, leave defaults unchanged */
			if (private == NULL)
				interface->act_altsetting = 0;
Linus Torvalds's avatar
Linus Torvalds committed
572
		} else { /* "old style" driver */
Linus Torvalds's avatar
Linus Torvalds committed
573
			down(&driver->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
574
			private = driver->probe(dev, ifnum, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
575 576
			up(&driver->serialize);
		}
Linus Torvalds's avatar
Linus Torvalds committed
577 578
		if (driver->owner)
			__MOD_DEC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
579

Linus Torvalds's avatar
Linus Torvalds committed
580 581 582
		/* probe() may have changed the config on us */
		interface = dev->actconfig->interface + ifnum;

Linus Torvalds's avatar
Linus Torvalds committed
583 584
		if (private) {
			usb_driver_claim_interface(driver, interface, private);
Linus Torvalds's avatar
Linus Torvalds committed
585
			up(&dev->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
586 587 588 589
			return 0;
		}
	}

Linus Torvalds's avatar
Linus Torvalds committed
590 591
out_err:
	up(&dev->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
592 593 594
	return -1;
}

Greg Kroah-Hartman's avatar
USB  
Greg Kroah-Hartman committed
595 596
/**
 * usb_find_interface_driver_for_ifnum - finds a usb interface driver for the specified ifnum
Dan Streetman's avatar
Dan Streetman committed
597 598 599
 * @dev: the device to use
 * @ifnum: the interface number (bInterfaceNumber); not interface position!
 *
Greg Kroah-Hartman's avatar
USB  
Greg Kroah-Hartman committed
600 601 602
 * This converts a ifnum to ifpos via a call to usb_ifnum_to_ifpos and then
 * calls usb_find_interface_driver() with the found ifpos.  Note
 * usb_find_interface_driver's ifnum parameter is actually interface position.
Dan Streetman's avatar
Dan Streetman committed
603 604 605 606 607 608 609 610 611 612
 */
int usb_find_interface_driver_for_ifnum(struct usb_device *dev, unsigned ifnum)
{
	int ifpos = usb_ifnum_to_ifpos(dev, ifnum);

	if (0 > ifpos)
		return -EINVAL;

	return usb_find_interface_driver(dev, ifpos);
}
Linus Torvalds's avatar
Linus Torvalds committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718

#ifdef	CONFIG_HOTPLUG

/*
 * USB hotplugging invokes what /proc/sys/kernel/hotplug says
 * (normally /sbin/hotplug) when USB devices get added or removed.
 *
 * This invokes a user mode policy agent, typically helping to load driver
 * or other modules, configure the device, and more.  Drivers can provide
 * a MODULE_DEVICE_TABLE to help with module loading subtasks.
 *
 * Some synchronization is important: removes can't start processing
 * before the add-device processing completes, and vice versa.  That keeps
 * a stack of USB-related identifiers stable while they're in use.  If we
 * know that agents won't complete after they return (such as by forking
 * a process that completes later), it's enough to just waitpid() for the
 * agent -- as is currently done.
 *
 * The reason: we know we're called either from khubd (the typical case)
 * or from root hub initialization (init, kapmd, modprobe, etc).  In both
 * cases, we know no other thread can recycle our address, since we must
 * already have been serialized enough to prevent that.
 */
static void call_policy (char *verb, struct usb_device *dev)
{
	char *argv [3], **envp, *buf, *scratch;
	int i = 0, value;

	if (!hotplug_path [0])
		return;
	if (in_interrupt ()) {
		dbg ("In_interrupt");
		return;
	}
	if (!current->fs->root) {
		/* statically linked USB is initted rather early */
		dbg ("call_policy %s, num %d -- no FS yet", verb, dev->devnum);
		return;
	}
	if (dev->devnum < 0) {
		dbg ("device already deleted ??");
		return;
	}
	if (!(envp = (char **) kmalloc (20 * sizeof (char *), GFP_KERNEL))) {
		dbg ("enomem");
		return;
	}
	if (!(buf = kmalloc (256, GFP_KERNEL))) {
		kfree (envp);
		dbg ("enomem2");
		return;
	}

	/* only one standardized param to hotplug command: type */
	argv [0] = hotplug_path;
	argv [1] = "usb";
	argv [2] = 0;

	/* minimal command environment */
	envp [i++] = "HOME=/";
	envp [i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";

#ifdef	DEBUG
	/* hint that policy agent should enter no-stdout debug mode */
	envp [i++] = "DEBUG=kernel";
#endif
	/* extensible set of named bus-specific parameters,
	 * supporting multiple driver selection algorithms.
	 */
	scratch = buf;

	/* action:  add, remove */
	envp [i++] = scratch;
	scratch += sprintf (scratch, "ACTION=%s", verb) + 1;

#ifdef	CONFIG_USB_DEVICEFS
	/* If this is available, userspace programs can directly read
	 * all the device descriptors we don't tell them about.  Or
	 * even act as usermode drivers.
	 *
	 * FIXME reduce hardwired intelligence here
	 */
	envp [i++] = "DEVFS=/proc/bus/usb";
	envp [i++] = scratch;
	scratch += sprintf (scratch, "DEVICE=/proc/bus/usb/%03d/%03d",
		dev->bus->busnum, dev->devnum) + 1;
#endif

	/* per-device configuration hacks are common */
	envp [i++] = scratch;
	scratch += sprintf (scratch, "PRODUCT=%x/%x/%x",
		dev->descriptor.idVendor,
		dev->descriptor.idProduct,
		dev->descriptor.bcdDevice) + 1;

	/* class-based driver binding models */
	envp [i++] = scratch;
	scratch += sprintf (scratch, "TYPE=%d/%d/%d",
			    dev->descriptor.bDeviceClass,
			    dev->descriptor.bDeviceSubClass,
			    dev->descriptor.bDeviceProtocol) + 1;
	if (dev->descriptor.bDeviceClass == 0) {
		int alt = dev->actconfig->interface [0].act_altsetting;

		/* a simple/common case: one config, one interface, one driver
		 * with current altsetting being a reasonable setting.
Linus Torvalds's avatar
Linus Torvalds committed
719
		 * everything needs a smart agent and usbfs; or can rely on
Linus Torvalds's avatar
Linus Torvalds committed
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
		 * device-specific binding policies.
		 */
		envp [i++] = scratch;
		scratch += sprintf (scratch, "INTERFACE=%d/%d/%d",
			dev->actconfig->interface [0].altsetting [alt].bInterfaceClass,
			dev->actconfig->interface [0].altsetting [alt].bInterfaceSubClass,
			dev->actconfig->interface [0].altsetting [alt].bInterfaceProtocol)
			+ 1;
		/* INTERFACE-0, INTERFACE-1, ... ? */
	}
	envp [i++] = 0;
	/* assert: (scratch - buf) < sizeof buf */

	/* NOTE: user mode daemons can call the agents too */

	dbg ("kusbd: %s %s %d", argv [0], verb, dev->devnum);
	value = call_usermodehelper (argv [0], argv, envp);
	kfree (buf);
	kfree (envp);
	if (value != 0)
		dbg ("kusbd policy returned 0x%x", value);
}

#else

static inline void
call_policy (char *verb, struct usb_device *dev)
{ } 

Linus Torvalds's avatar
Linus Torvalds committed
749
#endif	/* CONFIG_HOTPLUG */
Linus Torvalds's avatar
Linus Torvalds committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763


/*
 * This entrypoint gets called for each new device.
 *
 * All interfaces are scanned for matching drivers.
 */
static void usb_find_drivers(struct usb_device *dev)
{
	unsigned ifnum;
	unsigned rejected = 0;
	unsigned claimed = 0;

	for (ifnum = 0; ifnum < dev->actconfig->bNumInterfaces; ifnum++) {
764 765 766 767
		struct usb_interface *interface = &dev->actconfig->interface[ifnum];
		
		/* register this interface with driverfs */
		interface->dev.parent = &dev->dev;
Patrick Mochel's avatar
USB:  
Patrick Mochel committed
768 769
		interface->dev.bus = &usb_bus_type;
		sprintf (&interface->dev.bus_id[0], "%03d%03d", dev->devnum,ifnum);
770 771 772
		sprintf (&interface->dev.name[0], "figure out some name...");
		device_register (&interface->dev);

Linus Torvalds's avatar
Linus Torvalds committed
773
		/* if this interface hasn't already been claimed */
774
		if (!usb_interface_claimed(interface)) {
Linus Torvalds's avatar
Linus Torvalds committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
			if (usb_find_interface_driver(dev, ifnum))
				rejected++;
			else
				claimed++;
		}
	}
 
	if (rejected)
		dbg("unhandled interfaces on device");

	if (!claimed) {
		warn("USB device %d (vend/prod 0x%x/0x%x) is not claimed by any active driver.",
			dev->devnum,
			dev->descriptor.idVendor,
			dev->descriptor.idProduct);
#ifdef DEBUG
		usb_show_device(dev);
#endif
	}
}

Linus Torvalds's avatar
Linus Torvalds committed
796 797 798 799
/**
 * usb_alloc_dev - allocate a usb device structure (usbcore-internal)
 * @parent: hub to which device is connected
 * @bus: bus used to access the device
800
 * Context: !in_interrupt ()
Linus Torvalds's avatar
Linus Torvalds committed
801 802 803 804 805
 *
 * Only hub drivers (including virtual root hub drivers for host
 * controllers) should ever call this.
 *
 * This call is synchronous, and may not be used in an interrupt context.
Linus Torvalds's avatar
Linus Torvalds committed
806 807 808 809 810 811 812 813 814 815 816
 */
struct usb_device *usb_alloc_dev(struct usb_device *parent, struct usb_bus *bus)
{
	struct usb_device *dev;

	dev = kmalloc(sizeof(*dev), GFP_KERNEL);
	if (!dev)
		return NULL;

	memset(dev, 0, sizeof(*dev));

Linus Torvalds's avatar
Linus Torvalds committed
817 818
	usb_bus_get(bus);

Linus Torvalds's avatar
Linus Torvalds committed
819 820
	if (!parent)
		dev->devpath [0] = '/';
Linus Torvalds's avatar
Linus Torvalds committed
821 822 823 824 825
	dev->bus = bus;
	dev->parent = parent;
	atomic_set(&dev->refcnt, 1);
	INIT_LIST_HEAD(&dev->filelist);

Linus Torvalds's avatar
Linus Torvalds committed
826 827
	init_MUTEX(&dev->serialize);

828 829
	if (dev->bus->op->allocate)
		dev->bus->op->allocate(dev);
Linus Torvalds's avatar
Linus Torvalds committed
830 831 832 833

	return dev;
}

834
/**
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
 * usb_get_dev - increments the reference count of the device
 * @dev: the device being referenced
 *
 * Each live reference to a device should be refcounted.
 *
 * Drivers for USB interfaces should normally record such references in
 * their probe() methods, when they bind to an interface, and release
 * them by calling usb_put_dev(), in their disconnect() methods.
 *
 * A pointer to the device with the incremented reference counter is returned.
 */
struct usb_device *usb_get_dev (struct usb_device *dev)
{
	if (dev) {
		atomic_inc (&dev->refcnt);
		return dev;
	}
	return NULL;
}

/**
 * usb_free_dev - free a usb device structure when all users of it are finished.
857 858 859
 * @dev: device that's been disconnected
 * Context: !in_interrupt ()
 *
860 861 862
 * Must be called when a user of a device is finished with it.  When the last
 * user of the device calls this function, the memory of the device is freed.
 *
863 864 865 866
 * Used by hub and virtual root hub drivers.  The device is completely
 * gone, everything is cleaned up, so it's time to get rid of these last
 * records of this device.
 */
Linus Torvalds's avatar
Linus Torvalds committed
867 868
void usb_free_dev(struct usb_device *dev)
{
869 870 871 872 873 874 875
	if (atomic_dec_and_test(&dev->refcnt)) {
		if (dev->bus->op->deallocate)
			dev->bus->op->deallocate(dev);
		usb_destroy_configuration (dev);
		usb_bus_put (dev->bus);
		kfree (dev);
	}
Linus Torvalds's avatar
Linus Torvalds committed
876 877 878
}


Linus Torvalds's avatar
Linus Torvalds committed
879 880 881
/**
 * usb_get_current_frame_number - return current bus frame number
 * @dev: the device whose bus is being queried
Linus Torvalds's avatar
Linus Torvalds committed
882
 *
Linus Torvalds's avatar
Linus Torvalds committed
883 884 885
 * Returns the current frame number for the USB host controller
 * used with the given USB device.  This can be used when scheduling
 * isochronous requests.
886 887 888 889 890
 *
 * Note that different kinds of host controller have different
 * "scheduling horizons".  While one type might support scheduling only
 * 32 frames into the future, others could support scheduling up to
 * 1024 frames into the future.
Linus Torvalds's avatar
Linus Torvalds committed
891
 */
Linus Torvalds's avatar
Linus Torvalds committed
892
int usb_get_current_frame_number(struct usb_device *dev)
Linus Torvalds's avatar
Linus Torvalds committed
893
{
Linus Torvalds's avatar
Linus Torvalds committed
894
	return dev->bus->op->get_frame_number (dev);
Linus Torvalds's avatar
Linus Torvalds committed
895
}
Linus Torvalds's avatar
Linus Torvalds committed
896

Linus Torvalds's avatar
Linus Torvalds committed
897 898 899 900 901 902 903 904 905 906 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 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
/*-------------------------------------------------------------------*/


/* for returning string descriptors in UTF-16LE */
static int ascii2utf (char *ascii, __u8 *utf, int utfmax)
{
	int retval;

	for (retval = 0; *ascii && utfmax > 1; utfmax -= 2, retval += 2) {
		*utf++ = *ascii++ & 0x7f;
		*utf++ = 0;
	}
	return retval;
}

/*
 * root_hub_string is used by each host controller's root hub code,
 * so that they're identified consistently throughout the system.
 */
int usb_root_hub_string (int id, int serial, char *type, __u8 *data, int len)
{
	char buf [30];

	// assert (len > (2 * (sizeof (buf) + 1)));
	// assert (strlen (type) <= 8);

	// language ids
	if (id == 0) {
		*data++ = 4; *data++ = 3;	/* 4 bytes data */
		*data++ = 0; *data++ = 0;	/* some language id */
		return 4;

	// serial number
	} else if (id == 1) {
		sprintf (buf, "%x", serial);

	// product description
	} else if (id == 2) {
		sprintf (buf, "USB %s Root Hub", type);

	// id 3 == vendor description

	// unsupported IDs --> "stall"
	} else
	    return 0;

	data [0] = 2 + ascii2utf (buf, data + 2, len - 2);
	data [1] = 3;
	return data [0];
}

/*
 * __usb_get_extra_descriptor() finds a descriptor of specific type in the
 * extra field of the interface and endpoint descriptor structs.
 */

int __usb_get_extra_descriptor(char *buffer, unsigned size, unsigned char type, void **ptr)
{
	struct usb_descriptor_header *header;

	while (size >= sizeof(struct usb_descriptor_header)) {
		header = (struct usb_descriptor_header *)buffer;

		if (header->bLength < 2) {
			err("invalid descriptor length of %d", header->bLength);
			return -1;
		}

		if (header->bDescriptorType == type) {
			*ptr = header;
			return 0;
		}

		buffer += header->bLength;
		size -= header->bLength;
	}
	return -1;
}

Linus Torvalds's avatar
Linus Torvalds committed
976 977 978
/**
 * usb_disconnect - disconnect a device (usbcore-internal)
 * @pdev: pointer to device being disconnected
979
 * Context: !in_interrupt ()
Linus Torvalds's avatar
Linus Torvalds committed
980
 *
Linus Torvalds's avatar
Linus Torvalds committed
981
 * Something got disconnected. Get rid of it, and all of its children.
Linus Torvalds's avatar
Linus Torvalds committed
982 983 984 985 986
 *
 * Only hub drivers (including virtual root hub drivers for host
 * controllers) should ever call this.
 *
 * This call is synchronous, and may not be used in an interrupt context.
Linus Torvalds's avatar
Linus Torvalds committed
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
 */
void usb_disconnect(struct usb_device **pdev)
{
	struct usb_device * dev = *pdev;
	int i;

	if (!dev)
		return;

	*pdev = NULL;

	info("USB disconnect on device %d", dev->devnum);

	if (dev->actconfig) {
		for (i = 0; i < dev->actconfig->bNumInterfaces; i++) {
			struct usb_interface *interface = &dev->actconfig->interface[i];
			struct usb_driver *driver = interface->driver;
			if (driver) {
Linus Torvalds's avatar
Linus Torvalds committed
1005 1006
				if (driver->owner)
					__MOD_INC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
1007 1008 1009
				down(&driver->serialize);
				driver->disconnect(dev, interface->private_data);
				up(&driver->serialize);
Linus Torvalds's avatar
Linus Torvalds committed
1010
				/* if driver->disconnect didn't release the interface */
Greg Kroah-Hartman's avatar
Greg Kroah-Hartman committed
1011
				if (interface->driver)
Linus Torvalds's avatar
Linus Torvalds committed
1012
					usb_driver_release_interface(driver, interface);
1013 1014 1015
				/* we don't need the driver any longer */
				if (driver->owner)
					__MOD_DEC_USE_COUNT(driver->owner);
Linus Torvalds's avatar
Linus Torvalds committed
1016
			}
Greg Kroah-Hartman's avatar
Greg Kroah-Hartman committed
1017 1018
			/* remove our device node for this interface */
			put_device(&interface->dev);
Linus Torvalds's avatar
Linus Torvalds committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
		}
	}

	/* Free up all the children.. */
	for (i = 0; i < USB_MAXCHILDREN; i++) {
		struct usb_device **child = dev->children + i;
		if (*child)
			usb_disconnect(child);
	}

	/* Let policy agent unload modules etc */
	call_policy ("remove", dev);

	/* Free the device number and remove the /proc/bus/usb entry */
	if (dev->devnum > 0) {
1034
		clear_bit(dev->devnum, dev->bus->devmap.devicemap);
Linus Torvalds's avatar
Linus Torvalds committed
1035
		usbfs_remove_device(dev);
1036
		put_device(&dev->dev);
Linus Torvalds's avatar
Linus Torvalds committed
1037 1038
	}

1039 1040
	/* Decrement the reference count, it'll auto free everything when */
	/* it hits 0 which could very well be now */
1041
	usb_put_dev(dev);
Linus Torvalds's avatar
Linus Torvalds committed
1042 1043
}

Linus Torvalds's avatar
Linus Torvalds committed
1044 1045 1046 1047
/**
 * usb_connect - connects a new device during enumeration (usbcore-internal)
 * @dev: partially enumerated device
 *
Linus Torvalds's avatar
Linus Torvalds committed
1048 1049 1050 1051
 * Connect a new USB device. This basically just initializes
 * the USB device information and sets up the topology - it's
 * up to the low-level driver to reset the port and actually
 * do the setup (the upper levels don't know how to do that).
Linus Torvalds's avatar
Linus Torvalds committed
1052 1053 1054
 *
 * Only hub drivers (including virtual root hub drivers for host
 * controllers) should ever call this.
Linus Torvalds's avatar
Linus Torvalds committed
1055 1056 1057 1058 1059 1060 1061
 */
void usb_connect(struct usb_device *dev)
{
	int devnum;
	// FIXME needs locking for SMP!!
	/* why? this is called only from the hub thread, 
	 * which hopefully doesn't run on multiple CPU's simultaneously 8-)
Linus Torvalds's avatar
Linus Torvalds committed
1062 1063 1064
	 * ... it's also called from modprobe/rmmod/apmd threads as part
	 * of virtual root hub init/reinit.  In the init case, the hub code 
	 * won't have seen this, but not so for reinit ... 
Linus Torvalds's avatar
Linus Torvalds committed
1065 1066 1067 1068 1069
	 */
	dev->descriptor.bMaxPacketSize0 = 8;  /* Start off at 8 bytes  */
#ifndef DEVNUM_ROUND_ROBIN
	devnum = find_next_zero_bit(dev->bus->devmap.devicemap, 128, 1);
#else	/* round_robin alloc of devnums */
Linus Torvalds's avatar
Linus Torvalds committed
1070 1071
	/* Try to allocate the next devnum beginning at bus->devnum_next. */
	devnum = find_next_zero_bit(dev->bus->devmap.devicemap, 128, dev->bus->devnum_next);
Linus Torvalds's avatar
Linus Torvalds committed
1072 1073 1074
	if (devnum >= 128)
		devnum = find_next_zero_bit(dev->bus->devmap.devicemap, 128, 1);

Linus Torvalds's avatar
Linus Torvalds committed
1075
	dev->bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
Linus Torvalds's avatar
Linus Torvalds committed
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
#endif	/* round_robin alloc of devnums */

	if (devnum < 128) {
		set_bit(devnum, dev->bus->devmap.devicemap);
		dev->devnum = devnum;
	}
}

/*
 * These are the actual routines to send
 * and receive control messages.
 */

Linus Torvalds's avatar
Linus Torvalds committed
1089 1090
// hub-only!! ... and only exported for reset/reinit path.
// otherwise used internally, for usb_new_device()
Linus Torvalds's avatar
Linus Torvalds committed
1091 1092 1093
int usb_set_address(struct usb_device *dev)
{
	return usb_control_msg(dev, usb_snddefctrl(dev), USB_REQ_SET_ADDRESS,
Linus Torvalds's avatar
Linus Torvalds committed
1094 1095
		// FIXME USB_CTRL_SET_TIMEOUT
		0, dev->devnum, 0, NULL, 0, HZ * USB_CTRL_GET_TIMEOUT);
Linus Torvalds's avatar
Linus Torvalds committed
1096 1097 1098 1099 1100 1101 1102 1103 1104
}


/*
 * By the time we get here, the device has gotten a new device ID
 * and is in the default state. We need to identify the thing and
 * get the ball rolling..
 *
 * Returns 0 for success, != 0 for error.
Linus Torvalds's avatar
Linus Torvalds committed
1105 1106 1107 1108 1109
 *
 * This call is synchronous, and may not be used in an interrupt context.
 *
 * Only hub drivers (including virtual root hub drivers for host
 * controllers) should ever call this.
Linus Torvalds's avatar
Linus Torvalds committed
1110
 */
1111 1112
#define NEW_DEVICE_RETRYS	2
#define SET_ADDRESS_RETRYS	2
Linus Torvalds's avatar
Linus Torvalds committed
1113 1114
int usb_new_device(struct usb_device *dev)
{
1115
	int err = 0;
1116 1117
	int i;
	int j;
Linus Torvalds's avatar
Linus Torvalds committed
1118 1119 1120 1121 1122 1123 1124 1125

	/* USB v1.1 5.5.3 */
	/* We read the first 8 bytes from the device descriptor to get to */
	/*  the bMaxPacketSize0 field. Then we set the maximum packet size */
	/*  for the control pipe, and retrieve the rest */
	dev->epmaxpacketin [0] = 8;
	dev->epmaxpacketout[0] = 8;

1126
	for (i = 0; i < NEW_DEVICE_RETRYS; ++i) {
Linus Torvalds's avatar
Linus Torvalds committed
1127

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
		for (j = 0; j < SET_ADDRESS_RETRYS; ++j) {
			err = usb_set_address(dev);
			if (err >= 0)
				break;
			wait_ms(200);
		}
		if (err < 0) {
			err("USB device not accepting new address=%d (error=%d)",
				dev->devnum, err);
			clear_bit(dev->devnum, dev->bus->devmap.devicemap);
			dev->devnum = -1;
			return 1;
		}

		wait_ms(10);	/* Let the SET_ADDRESS settle */

		err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
		if (err >= 8)
			break;
		wait_ms(100);
	}
Linus Torvalds's avatar
Linus Torvalds committed
1149 1150 1151 1152 1153 1154

	if (err < 8) {
		if (err < 0)
			err("USB device not responding, giving up (error=%d)", err);
		else
			err("USB device descriptor short read (expected %i, got %i)", 8, err);
1155
		clear_bit(dev->devnum, dev->bus->devmap.devicemap);
Linus Torvalds's avatar
Linus Torvalds committed
1156 1157 1158 1159 1160 1161 1162
		dev->devnum = -1;
		return 1;
	}
	dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
	dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;

	err = usb_get_device_descriptor(dev);
Linus Torvalds's avatar
Linus Torvalds committed
1163
	if (err < (signed)sizeof(dev->descriptor)) {
Linus Torvalds's avatar
Linus Torvalds committed
1164 1165 1166
		if (err < 0)
			err("unable to get device descriptor (error=%d)", err);
		else
Linus Torvalds's avatar
Linus Torvalds committed
1167
			err("USB device descriptor short read (expected %Zi, got %i)",
Linus Torvalds's avatar
Linus Torvalds committed
1168 1169
				sizeof(dev->descriptor), err);
	
1170
		clear_bit(dev->devnum, dev->bus->devmap.devicemap);
Linus Torvalds's avatar
Linus Torvalds committed
1171 1172 1173 1174 1175 1176 1177 1178
		dev->devnum = -1;
		return 1;
	}

	err = usb_get_configuration(dev);
	if (err < 0) {
		err("unable to get device %d configuration (error=%d)",
			dev->devnum, err);
1179
		clear_bit(dev->devnum, dev->bus->devmap.devicemap);
Linus Torvalds's avatar
Linus Torvalds committed
1180 1181 1182 1183 1184 1185 1186 1187 1188
		dev->devnum = -1;
		return 1;
	}

	/* we set the default configuration here */
	err = usb_set_configuration(dev, dev->config[0].bConfigurationValue);
	if (err) {
		err("failed to set device %d default configuration (error=%d)",
			dev->devnum, err);
1189
		clear_bit(dev->devnum, dev->bus->devmap.devicemap);
Linus Torvalds's avatar
Linus Torvalds committed
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
		dev->devnum = -1;
		return 1;
	}

	dbg("new device strings: Mfr=%d, Product=%d, SerialNumber=%d",
		dev->descriptor.iManufacturer, dev->descriptor.iProduct, dev->descriptor.iSerialNumber);
#ifdef DEBUG
	if (dev->descriptor.iManufacturer)
		usb_show_string(dev, "Manufacturer", dev->descriptor.iManufacturer);
	if (dev->descriptor.iProduct)
		usb_show_string(dev, "Product", dev->descriptor.iProduct);
	if (dev->descriptor.iSerialNumber)
		usb_show_string(dev, "SerialNumber", dev->descriptor.iSerialNumber);
#endif

1205 1206 1207 1208 1209
	/* register this device in the driverfs tree */
	err = device_register (&dev->dev);
	if (err)
		return err;

Linus Torvalds's avatar
Linus Torvalds committed
1210
	/* now that the basic setup is over, add a /proc/bus/usb entry */
Linus Torvalds's avatar
Linus Torvalds committed
1211
	usbfs_add_device(dev);
Linus Torvalds's avatar
Linus Torvalds committed
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

	/* find drivers willing to handle this device */
	usb_find_drivers(dev);

	/* userspace may load modules and/or configure further */
	call_policy ("add", dev);

	return 0;
}


#ifdef CONFIG_PROC_FS
struct list_head *usb_driver_get_list(void)
{
	return &usb_driver_list;
}

struct list_head *usb_bus_get_list(void)
{
	return &usb_bus_list;
}
#endif

1235 1236 1237
struct bus_type usb_bus_type = {
	name:	"usb",
};
Linus Torvalds's avatar
Linus Torvalds committed
1238 1239 1240 1241 1242 1243

/*
 * Init
 */
static int __init usb_init(void)
{
1244
	bus_register(&usb_bus_type);
Linus Torvalds's avatar
Linus Torvalds committed
1245
	usb_major_init();
Linus Torvalds's avatar
Linus Torvalds committed
1246
	usbfs_init();
Linus Torvalds's avatar
Linus Torvalds committed
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
	usb_hub_init();

	return 0;
}

/*
 * Cleanup
 */
static void __exit usb_exit(void)
{
1257
	put_bus(&usb_bus_type);
Linus Torvalds's avatar
Linus Torvalds committed
1258
	usb_major_cleanup();
Linus Torvalds's avatar
Linus Torvalds committed
1259
	usbfs_cleanup();
Linus Torvalds's avatar
Linus Torvalds committed
1260 1261 1262
	usb_hub_cleanup();
}

1263
subsys_initcall(usb_init);
Linus Torvalds's avatar
Linus Torvalds committed
1264 1265 1266 1267
module_exit(usb_exit);

/*
 * USB may be built into the kernel or be built as modules.
1268 1269
 * These symbols are exported for device (or host controller)
 * driver modules to use.
Linus Torvalds's avatar
Linus Torvalds committed
1270
 */
Dan Streetman's avatar
Dan Streetman committed
1271
EXPORT_SYMBOL(usb_ifnum_to_ifpos);
Linus Torvalds's avatar
Linus Torvalds committed
1272 1273 1274 1275 1276 1277
EXPORT_SYMBOL(usb_ifnum_to_if);
EXPORT_SYMBOL(usb_epnum_to_ep_desc);

EXPORT_SYMBOL(usb_register);
EXPORT_SYMBOL(usb_deregister);
EXPORT_SYMBOL(usb_scan_devices);
1278

Linus Torvalds's avatar
Linus Torvalds committed
1279 1280
EXPORT_SYMBOL(usb_alloc_dev);
EXPORT_SYMBOL(usb_free_dev);
1281
EXPORT_SYMBOL(usb_get_dev);
1282
EXPORT_SYMBOL(usb_hub_tt_clear_buffer);
Linus Torvalds's avatar
Linus Torvalds committed
1283

Dan Streetman's avatar
Dan Streetman committed
1284
EXPORT_SYMBOL(usb_find_interface_driver_for_ifnum);
Linus Torvalds's avatar
Linus Torvalds committed
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
EXPORT_SYMBOL(usb_driver_claim_interface);
EXPORT_SYMBOL(usb_interface_claimed);
EXPORT_SYMBOL(usb_driver_release_interface);
EXPORT_SYMBOL(usb_match_id);

EXPORT_SYMBOL(usb_root_hub_string);
EXPORT_SYMBOL(usb_new_device);
EXPORT_SYMBOL(usb_reset_device);
EXPORT_SYMBOL(usb_connect);
EXPORT_SYMBOL(usb_disconnect);

EXPORT_SYMBOL(__usb_get_extra_descriptor);

EXPORT_SYMBOL(usb_get_current_frame_number);

Linus Torvalds's avatar
Linus Torvalds committed
1300
MODULE_LICENSE("GPL");