blob: 61800f77dac80f0064cd7184f858241a35e2fc8c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * (C) Copyright Linus Torvalds 1999
3 * (C) Copyright Johannes Erdfelt 1999-2001
4 * (C) Copyright Andreas Gal 1999
5 * (C) Copyright Gregory P. Smith 1999
6 * (C) Copyright Deti Fliegl 1999
7 * (C) Copyright Randy Dunlap 2000
8 * (C) Copyright David Brownell 2000-2002
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 */
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/module.h>
26#include <linux/version.h>
27#include <linux/kernel.h>
28#include <linux/slab.h>
29#include <linux/completion.h>
30#include <linux/utsname.h>
31#include <linux/mm.h>
32#include <asm/io.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/device.h>
34#include <linux/dma-mapping.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010035#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/irq.h>
37#include <asm/byteorder.h>
Magnus Dammb3476672008-01-23 15:58:35 +090038#include <asm/unaligned.h>
Aleksey Gorelov64a21d02006-08-08 17:24:08 -070039#include <linux/platform_device.h>
Alan Stern6b157c92007-03-13 16:37:30 -040040#include <linux/workqueue.h>
Alan Stern9bbdf1e2010-01-08 12:57:28 -050041#include <linux/pm_runtime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43#include <linux/usb.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020044#include <linux/usb/hcd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#include "usb.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*-------------------------------------------------------------------------*/
50
51/*
52 * USB Host Controller Driver framework
53 *
54 * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing
55 * HCD-specific behaviors/bugs.
56 *
57 * This does error checks, tracks devices and urbs, and delegates to a
58 * "hc_driver" only for code (and data) that really needs to know about
59 * hardware differences. That includes root hub registers, i/o queues,
60 * and so on ... but as little else as possible.
61 *
62 * Shared code includes most of the "root hub" code (these are emulated,
63 * though each HC's hardware works differently) and PCI glue, plus request
64 * tracking overhead. The HCD code should only block on spinlocks or on
65 * hardware handshaking; blocking on software events (such as other kernel
66 * threads releasing resources, or completing actions) is all generic.
67 *
68 * Happens the USB 2.0 spec says this would be invisible inside the "USBD",
69 * and includes mostly a "HCDI" (HCD Interface) along with some APIs used
70 * only by the hub driver ... and that neither should be seen or used by
71 * usb client device drivers.
72 *
73 * Contributors of ideas or unattributed patches include: David Brownell,
74 * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ...
75 *
76 * HISTORY:
77 * 2002-02-21 Pull in most of the usb_bus support from usb.c; some
78 * associated cleanup. "usb_hcd" still != "usb_bus".
79 * 2001-12-12 Initial patch version for Linux 2.5.1 kernel.
80 */
81
82/*-------------------------------------------------------------------------*/
83
Alan Stern9beeee62008-10-02 11:48:13 -040084/* Keep track of which host controller drivers are loaded */
85unsigned long usb_hcds_loaded;
86EXPORT_SYMBOL_GPL(usb_hcds_loaded);
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/* host controllers we manage */
89LIST_HEAD (usb_bus_list);
90EXPORT_SYMBOL_GPL (usb_bus_list);
91
92/* used when allocating bus numbers */
93#define USB_MAXBUS 64
94struct usb_busmap {
95 unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))];
96};
97static struct usb_busmap busmap;
98
99/* used when updating list of hcds */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100100DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101EXPORT_SYMBOL_GPL (usb_bus_list_lock);
102
103/* used for controlling access to virtual root hubs */
104static DEFINE_SPINLOCK(hcd_root_hub_lock);
105
Alan Stern809a58b2007-07-18 12:14:24 -0400106/* used when updating an endpoint's URB list */
107static DEFINE_SPINLOCK(hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Alan Sterncde217a2008-10-21 15:28:46 -0400109/* used to protect against unlinking URBs after the device is gone */
110static DEFINE_SPINLOCK(hcd_urb_unlink_lock);
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112/* wait queue for synchronous unlinks */
113DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue);
114
Alan Stern809a58b2007-07-18 12:14:24 -0400115static inline int is_root_hub(struct usb_device *udev)
116{
117 return (udev->parent == NULL);
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*-------------------------------------------------------------------------*/
121
122/*
123 * Sharable chunks of root hub code.
124 */
125
126/*-------------------------------------------------------------------------*/
127
128#define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff)
129#define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff)
130
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700131/* usb 3.0 root hub device descriptor */
132static const u8 usb3_rh_dev_descriptor[18] = {
133 0x12, /* __u8 bLength; */
134 0x01, /* __u8 bDescriptorType; Device */
135 0x00, 0x03, /* __le16 bcdUSB; v3.0 */
136
137 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
138 0x00, /* __u8 bDeviceSubClass; */
139 0x03, /* __u8 bDeviceProtocol; USB 3.0 hub */
140 0x09, /* __u8 bMaxPacketSize0; 2^9 = 512 Bytes */
141
142 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
Alan Sterncd780692010-02-25 13:19:37 -0500143 0x03, 0x00, /* __le16 idProduct; device 0x0003 */
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700144 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
145
146 0x03, /* __u8 iManufacturer; */
147 0x02, /* __u8 iProduct; */
148 0x01, /* __u8 iSerialNumber; */
149 0x01 /* __u8 bNumConfigurations; */
150};
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152/* usb 2.0 root hub device descriptor */
153static const u8 usb2_rh_dev_descriptor [18] = {
154 0x12, /* __u8 bLength; */
155 0x01, /* __u8 bDescriptorType; Device */
156 0x00, 0x02, /* __le16 bcdUSB; v2.0 */
157
158 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
159 0x00, /* __u8 bDeviceSubClass; */
Alan Stern7329e212008-04-03 18:02:56 -0400160 0x00, /* __u8 bDeviceProtocol; [ usb 2.0 no TT ] */
Alan Stern16f16d12005-10-24 15:41:19 -0400161 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Greg Kroah-Hartman667d6912008-01-28 09:50:12 -0800163 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
164 0x02, 0x00, /* __le16 idProduct; device 0x0002 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
166
167 0x03, /* __u8 iManufacturer; */
168 0x02, /* __u8 iProduct; */
169 0x01, /* __u8 iSerialNumber; */
170 0x01 /* __u8 bNumConfigurations; */
171};
172
173/* no usb 2.0 root hub "device qualifier" descriptor: one speed only */
174
175/* usb 1.1 root hub device descriptor */
176static const u8 usb11_rh_dev_descriptor [18] = {
177 0x12, /* __u8 bLength; */
178 0x01, /* __u8 bDescriptorType; Device */
179 0x10, 0x01, /* __le16 bcdUSB; v1.1 */
180
181 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */
182 0x00, /* __u8 bDeviceSubClass; */
183 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */
Alan Stern16f16d12005-10-24 15:41:19 -0400184 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Greg Kroah-Hartman667d6912008-01-28 09:50:12 -0800186 0x6b, 0x1d, /* __le16 idVendor; Linux Foundation */
187 0x01, 0x00, /* __le16 idProduct; device 0x0001 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */
189
190 0x03, /* __u8 iManufacturer; */
191 0x02, /* __u8 iProduct; */
192 0x01, /* __u8 iSerialNumber; */
193 0x01 /* __u8 bNumConfigurations; */
194};
195
196
197/*-------------------------------------------------------------------------*/
198
199/* Configuration descriptors for our root hubs */
200
201static const u8 fs_rh_config_descriptor [] = {
202
203 /* one configuration */
204 0x09, /* __u8 bLength; */
205 0x02, /* __u8 bDescriptorType; Configuration */
206 0x19, 0x00, /* __le16 wTotalLength; */
207 0x01, /* __u8 bNumInterfaces; (1) */
208 0x01, /* __u8 bConfigurationValue; */
209 0x00, /* __u8 iConfiguration; */
210 0xc0, /* __u8 bmAttributes;
211 Bit 7: must be set,
212 6: Self-powered,
213 5: Remote wakeup,
214 4..0: resvd */
215 0x00, /* __u8 MaxPower; */
216
217 /* USB 1.1:
218 * USB 2.0, single TT organization (mandatory):
219 * one interface, protocol 0
220 *
221 * USB 2.0, multiple TT organization (optional):
222 * two interfaces, protocols 1 (like single TT)
223 * and 2 (multiple TT mode) ... config is
224 * sometimes settable
225 * NOT IMPLEMENTED
226 */
227
228 /* one interface */
229 0x09, /* __u8 if_bLength; */
230 0x04, /* __u8 if_bDescriptorType; Interface */
231 0x00, /* __u8 if_bInterfaceNumber; */
232 0x00, /* __u8 if_bAlternateSetting; */
233 0x01, /* __u8 if_bNumEndpoints; */
234 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
235 0x00, /* __u8 if_bInterfaceSubClass; */
236 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
237 0x00, /* __u8 if_iInterface; */
238
239 /* one endpoint (status change endpoint) */
240 0x07, /* __u8 ep_bLength; */
241 0x05, /* __u8 ep_bDescriptorType; Endpoint */
242 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
243 0x03, /* __u8 ep_bmAttributes; Interrupt */
244 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */
245 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */
246};
247
248static const u8 hs_rh_config_descriptor [] = {
249
250 /* one configuration */
251 0x09, /* __u8 bLength; */
252 0x02, /* __u8 bDescriptorType; Configuration */
253 0x19, 0x00, /* __le16 wTotalLength; */
254 0x01, /* __u8 bNumInterfaces; (1) */
255 0x01, /* __u8 bConfigurationValue; */
256 0x00, /* __u8 iConfiguration; */
257 0xc0, /* __u8 bmAttributes;
258 Bit 7: must be set,
259 6: Self-powered,
260 5: Remote wakeup,
261 4..0: resvd */
262 0x00, /* __u8 MaxPower; */
263
264 /* USB 1.1:
265 * USB 2.0, single TT organization (mandatory):
266 * one interface, protocol 0
267 *
268 * USB 2.0, multiple TT organization (optional):
269 * two interfaces, protocols 1 (like single TT)
270 * and 2 (multiple TT mode) ... config is
271 * sometimes settable
272 * NOT IMPLEMENTED
273 */
274
275 /* one interface */
276 0x09, /* __u8 if_bLength; */
277 0x04, /* __u8 if_bDescriptorType; Interface */
278 0x00, /* __u8 if_bInterfaceNumber; */
279 0x00, /* __u8 if_bAlternateSetting; */
280 0x01, /* __u8 if_bNumEndpoints; */
281 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
282 0x00, /* __u8 if_bInterfaceSubClass; */
283 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */
284 0x00, /* __u8 if_iInterface; */
285
286 /* one endpoint (status change endpoint) */
287 0x07, /* __u8 ep_bLength; */
288 0x05, /* __u8 ep_bDescriptorType; Endpoint */
289 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
290 0x03, /* __u8 ep_bmAttributes; Interrupt */
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700291 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
292 * see hub.c:hub_configure() for details. */
293 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
295};
296
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700297static const u8 ss_rh_config_descriptor[] = {
298 /* one configuration */
299 0x09, /* __u8 bLength; */
300 0x02, /* __u8 bDescriptorType; Configuration */
301 0x19, 0x00, /* __le16 wTotalLength; FIXME */
302 0x01, /* __u8 bNumInterfaces; (1) */
303 0x01, /* __u8 bConfigurationValue; */
304 0x00, /* __u8 iConfiguration; */
305 0xc0, /* __u8 bmAttributes;
306 Bit 7: must be set,
307 6: Self-powered,
308 5: Remote wakeup,
309 4..0: resvd */
310 0x00, /* __u8 MaxPower; */
311
312 /* one interface */
313 0x09, /* __u8 if_bLength; */
314 0x04, /* __u8 if_bDescriptorType; Interface */
315 0x00, /* __u8 if_bInterfaceNumber; */
316 0x00, /* __u8 if_bAlternateSetting; */
317 0x01, /* __u8 if_bNumEndpoints; */
318 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */
319 0x00, /* __u8 if_bInterfaceSubClass; */
320 0x00, /* __u8 if_bInterfaceProtocol; */
321 0x00, /* __u8 if_iInterface; */
322
323 /* one endpoint (status change endpoint) */
324 0x07, /* __u8 ep_bLength; */
325 0x05, /* __u8 ep_bDescriptorType; Endpoint */
326 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */
327 0x03, /* __u8 ep_bmAttributes; Interrupt */
328 /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8)
329 * see hub.c:hub_configure() for details. */
330 (USB_MAXCHILDREN + 1 + 7) / 8, 0x00,
331 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */
332 /*
333 * All 3.0 hubs should have an endpoint companion descriptor,
334 * but we're ignoring that for now. FIXME?
335 */
336};
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338/*-------------------------------------------------------------------------*/
339
George Spelvin392ca682009-08-24 22:06:41 -0400340/**
341 * ascii2desc() - Helper routine for producing UTF-16LE string descriptors
342 * @s: Null-terminated ASCII (actually ISO-8859-1) string
343 * @buf: Buffer for USB string descriptor (header + UTF-16LE)
344 * @len: Length (in bytes; may be odd) of descriptor buffer.
345 *
346 * The return value is the number of bytes filled in: 2 + 2*strlen(s) or
347 * buflen, whichever is less.
348 *
349 * USB String descriptors can contain at most 126 characters; input
350 * strings longer than that are truncated.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 */
George Spelvin392ca682009-08-24 22:06:41 -0400352static unsigned
353ascii2desc(char const *s, u8 *buf, unsigned len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
George Spelvin392ca682009-08-24 22:06:41 -0400355 unsigned n, t = 2 + 2*strlen(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
George Spelvin392ca682009-08-24 22:06:41 -0400357 if (t > 254)
358 t = 254; /* Longest possible UTF string descriptor */
359 if (len > t)
360 len = t;
361
362 t += USB_DT_STRING << 8; /* Now t is first 16 bits to store */
363
364 n = len;
365 while (n--) {
366 *buf++ = t;
367 if (!n--)
368 break;
369 *buf++ = t >> 8;
370 t = (unsigned char)*s++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 }
George Spelvin392ca682009-08-24 22:06:41 -0400372 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373}
374
George Spelvin392ca682009-08-24 22:06:41 -0400375/**
376 * rh_string() - provides string descriptors for root hub
377 * @id: the string ID number (0: langids, 1: serial #, 2: product, 3: vendor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 * @hcd: the host controller for this root hub
George Spelvin392ca682009-08-24 22:06:41 -0400379 * @data: buffer for output packet
380 * @len: length of the provided buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *
382 * Produces either a manufacturer, product or serial number string for the
383 * virtual root hub device.
George Spelvin392ca682009-08-24 22:06:41 -0400384 * Returns the number of bytes filled in: the length of the descriptor or
385 * of the provided buffer, whichever is less.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
George Spelvin392ca682009-08-24 22:06:41 -0400387static unsigned
388rh_string(int id, struct usb_hcd const *hcd, u8 *data, unsigned len)
Roel Kluin71d27182009-03-13 12:19:18 +0100389{
George Spelvin392ca682009-08-24 22:06:41 -0400390 char buf[100];
391 char const *s;
392 static char const langids[4] = {4, USB_DT_STRING, 0x09, 0x04};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 // language ids
George Spelvin392ca682009-08-24 22:06:41 -0400395 switch (id) {
396 case 0:
397 /* Array of LANGID codes (0x0409 is MSFT-speak for "en-us") */
398 /* See http://www.usb.org/developers/docs/USB_LANGIDs.pdf */
399 if (len > 4)
400 len = 4;
401 memcpy(data, langids, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 return len;
George Spelvin392ca682009-08-24 22:06:41 -0400403 case 1:
404 /* Serial number */
405 s = hcd->self.bus_name;
406 break;
407 case 2:
408 /* Product name */
409 s = hcd->product_desc;
410 break;
411 case 3:
412 /* Manufacturer */
Serge E. Hallyn96b644b2006-10-02 02:18:13 -0700413 snprintf (buf, sizeof buf, "%s %s %s", init_utsname()->sysname,
414 init_utsname()->release, hcd->driver->description);
George Spelvin392ca682009-08-24 22:06:41 -0400415 s = buf;
416 break;
417 default:
418 /* Can't happen; caller guarantees it */
419 return 0;
Roel Kluin71d27182009-03-13 12:19:18 +0100420 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
George Spelvin392ca682009-08-24 22:06:41 -0400422 return ascii2desc(s, data, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423}
424
425
426/* Root hub control transfers execute synchronously */
427static int rh_call_control (struct usb_hcd *hcd, struct urb *urb)
428{
429 struct usb_ctrlrequest *cmd;
430 u16 typeReq, wValue, wIndex, wLength;
431 u8 *ubuf = urb->transfer_buffer;
Mikael Pettersson54bee6e2006-09-23 17:05:31 -0700432 u8 tbuf [sizeof (struct usb_hub_descriptor)]
433 __attribute__((aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 const u8 *bufp = tbuf;
Roel Kluin71d27182009-03-13 12:19:18 +0100435 unsigned len = 0;
Alan Sterne9df41c2007-08-08 11:48:02 -0400436 int status;
Alan Stern7329e212008-04-03 18:02:56 -0400437 u8 patch_wakeup = 0;
438 u8 patch_protocol = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Alan Stern9439eb92007-08-02 15:05:45 -0400440 might_sleep();
441
Alan Sterne9df41c2007-08-08 11:48:02 -0400442 spin_lock_irq(&hcd_root_hub_lock);
443 status = usb_hcd_link_urb_to_ep(hcd, urb);
444 spin_unlock_irq(&hcd_root_hub_lock);
445 if (status)
446 return status;
Alan Sternb0d9efb2007-08-21 15:39:21 -0400447 urb->hcpriv = hcd; /* Indicate it's queued */
Alan Sterne9df41c2007-08-08 11:48:02 -0400448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 cmd = (struct usb_ctrlrequest *) urb->setup_packet;
450 typeReq = (cmd->bRequestType << 8) | cmd->bRequest;
451 wValue = le16_to_cpu (cmd->wValue);
452 wIndex = le16_to_cpu (cmd->wIndex);
453 wLength = le16_to_cpu (cmd->wLength);
454
455 if (wLength > urb->transfer_buffer_length)
456 goto error;
457
458 urb->actual_length = 0;
459 switch (typeReq) {
460
461 /* DEVICE REQUESTS */
462
David Brownellfb669cc2006-01-24 08:40:27 -0800463 /* The root hub's remote wakeup enable bit is implemented using
464 * driver model wakeup flags. If this system supports wakeup
465 * through USB, userspace may change the default "allow wakeup"
466 * policy through sysfs or these calls.
467 *
468 * Most root hubs support wakeup from downstream devices, for
469 * runtime power management (disabling USB clocks and reducing
470 * VBUS power usage). However, not all of them do so; silicon,
471 * board, and BIOS bugs here are not uncommon, so these can't
472 * be treated quite like external hubs.
473 *
474 * Likewise, not all root hubs will pass wakeup events upstream,
475 * to wake up the whole system. So don't assume root hub and
476 * controller capabilities are identical.
477 */
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 case DeviceRequest | USB_REQ_GET_STATUS:
David Brownellfb669cc2006-01-24 08:40:27 -0800480 tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev)
481 << USB_DEVICE_REMOTE_WAKEUP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 | (1 << USB_DEVICE_SELF_POWERED);
483 tbuf [1] = 0;
484 len = 2;
485 break;
486 case DeviceOutRequest | USB_REQ_CLEAR_FEATURE:
487 if (wValue == USB_DEVICE_REMOTE_WAKEUP)
David Brownellfb669cc2006-01-24 08:40:27 -0800488 device_set_wakeup_enable(&hcd->self.root_hub->dev, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 else
490 goto error;
491 break;
492 case DeviceOutRequest | USB_REQ_SET_FEATURE:
David Brownellfb669cc2006-01-24 08:40:27 -0800493 if (device_can_wakeup(&hcd->self.root_hub->dev)
494 && wValue == USB_DEVICE_REMOTE_WAKEUP)
495 device_set_wakeup_enable(&hcd->self.root_hub->dev, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 else
497 goto error;
498 break;
499 case DeviceRequest | USB_REQ_GET_CONFIGURATION:
500 tbuf [0] = 1;
501 len = 1;
502 /* FALLTHROUGH */
503 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
504 break;
505 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
506 switch (wValue & 0xff00) {
507 case USB_DT_DEVICE << 8:
Viral Mehta7dd19e62009-05-05 15:54:23 +0530508 switch (hcd->driver->flags & HCD_MASK) {
509 case HCD_USB3:
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700510 bufp = usb3_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530511 break;
512 case HCD_USB2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 bufp = usb2_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530514 break;
515 case HCD_USB11:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 bufp = usb11_rh_dev_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530517 break;
518 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 goto error;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530520 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 len = 18;
Alan Stern7329e212008-04-03 18:02:56 -0400522 if (hcd->has_tt)
523 patch_protocol = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 break;
525 case USB_DT_CONFIG << 8:
Viral Mehta7dd19e62009-05-05 15:54:23 +0530526 switch (hcd->driver->flags & HCD_MASK) {
527 case HCD_USB3:
Sarah Sharpd2e9b4d2009-04-27 19:55:01 -0700528 bufp = ss_rh_config_descriptor;
529 len = sizeof ss_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530530 break;
531 case HCD_USB2:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 bufp = hs_rh_config_descriptor;
533 len = sizeof hs_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530534 break;
535 case HCD_USB11:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 bufp = fs_rh_config_descriptor;
537 len = sizeof fs_rh_config_descriptor;
Viral Mehta7dd19e62009-05-05 15:54:23 +0530538 break;
539 default:
540 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 }
David Brownellfb669cc2006-01-24 08:40:27 -0800542 if (device_can_wakeup(&hcd->self.root_hub->dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 patch_wakeup = 1;
544 break;
545 case USB_DT_STRING << 8:
Roel Kluin71d27182009-03-13 12:19:18 +0100546 if ((wValue & 0xff) < 4)
547 urb->actual_length = rh_string(wValue & 0xff,
548 hcd, ubuf, wLength);
549 else /* unsupported IDs --> "protocol stall" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 break;
552 default:
553 goto error;
554 }
555 break;
556 case DeviceRequest | USB_REQ_GET_INTERFACE:
557 tbuf [0] = 0;
558 len = 1;
559 /* FALLTHROUGH */
560 case DeviceOutRequest | USB_REQ_SET_INTERFACE:
561 break;
562 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
563 // wValue == urb->dev->devaddr
564 dev_dbg (hcd->self.controller, "root hub device address %d\n",
565 wValue);
566 break;
567
568 /* INTERFACE REQUESTS (no defined feature/status flags) */
569
570 /* ENDPOINT REQUESTS */
571
572 case EndpointRequest | USB_REQ_GET_STATUS:
573 // ENDPOINT_HALT flag
574 tbuf [0] = 0;
575 tbuf [1] = 0;
576 len = 2;
577 /* FALLTHROUGH */
578 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
579 case EndpointOutRequest | USB_REQ_SET_FEATURE:
580 dev_dbg (hcd->self.controller, "no endpoint features yet\n");
581 break;
582
583 /* CLASS REQUESTS (and errors) */
584
585 default:
586 /* non-generic request */
David Brownellb13296c2005-09-27 10:38:54 -0700587 switch (typeReq) {
588 case GetHubStatus:
589 case GetPortStatus:
590 len = 4;
591 break;
592 case GetHubDescriptor:
593 len = sizeof (struct usb_hub_descriptor);
594 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 }
David Brownellb13296c2005-09-27 10:38:54 -0700596 status = hcd->driver->hub_control (hcd,
597 typeReq, wValue, wIndex,
598 tbuf, wLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 break;
600error:
601 /* "protocol stall" on error */
602 status = -EPIPE;
603 }
604
605 if (status) {
606 len = 0;
607 if (status != -EPIPE) {
608 dev_dbg (hcd->self.controller,
609 "CTRL: TypeReq=0x%x val=0x%x "
610 "idx=0x%x len=%d ==> %d\n",
611 typeReq, wValue, wIndex,
David Brownellb13296c2005-09-27 10:38:54 -0700612 wLength, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 }
614 }
615 if (len) {
616 if (urb->transfer_buffer_length < len)
617 len = urb->transfer_buffer_length;
618 urb->actual_length = len;
619 // always USB_DIR_IN, toward host
620 memcpy (ubuf, bufp, len);
621
622 /* report whether RH hardware supports remote wakeup */
623 if (patch_wakeup &&
624 len > offsetof (struct usb_config_descriptor,
625 bmAttributes))
626 ((struct usb_config_descriptor *)ubuf)->bmAttributes
627 |= USB_CONFIG_ATT_WAKEUP;
Alan Stern7329e212008-04-03 18:02:56 -0400628
629 /* report whether RH hardware has an integrated TT */
630 if (patch_protocol &&
631 len > offsetof(struct usb_device_descriptor,
632 bDeviceProtocol))
633 ((struct usb_device_descriptor *) ubuf)->
634 bDeviceProtocol = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 }
636
637 /* any errors get returned through the urb completion */
Alan Stern9439eb92007-08-02 15:05:45 -0400638 spin_lock_irq(&hcd_root_hub_lock);
Alan Sterne9df41c2007-08-08 11:48:02 -0400639 usb_hcd_unlink_urb_from_ep(hcd, urb);
Alan Stern9439eb92007-08-02 15:05:45 -0400640
641 /* This peculiar use of spinlocks echoes what real HC drivers do.
642 * Avoiding calls to local_irq_disable/enable makes the code
643 * RT-friendly.
644 */
645 spin_unlock(&hcd_root_hub_lock);
Alan Stern4a000272007-08-24 15:42:24 -0400646 usb_hcd_giveback_urb(hcd, urb, status);
Alan Stern9439eb92007-08-02 15:05:45 -0400647 spin_lock(&hcd_root_hub_lock);
648
649 spin_unlock_irq(&hcd_root_hub_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return 0;
651}
652
653/*-------------------------------------------------------------------------*/
654
655/*
Alan Sternd5926ae72005-04-21 15:56:37 -0400656 * Root Hub interrupt transfers are polled using a timer if the
657 * driver requests it; otherwise the driver is responsible for
658 * calling usb_hcd_poll_rh_status() when an event occurs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 *
Alan Sternd5926ae72005-04-21 15:56:37 -0400660 * Completions are called in_interrupt(), but they may or may not
661 * be in_irq().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 */
Alan Sternd5926ae72005-04-21 15:56:37 -0400663void usb_hcd_poll_rh_status(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
665 struct urb *urb;
Alan Sternd5926ae72005-04-21 15:56:37 -0400666 int length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 unsigned long flags;
Joe Perchesad361c92009-07-06 13:05:40 -0700668 char buffer[6]; /* Any root hubs with > 31 ports? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Alan Stern6d88e672010-06-09 17:34:17 -0400670 if (unlikely(!hcd->rh_pollable))
Alan Stern1b42ae62007-03-13 11:10:52 -0400671 return;
Alan Sternd5926ae72005-04-21 15:56:37 -0400672 if (!hcd->uses_new_polling && !hcd->status_urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Alan Sternd5926ae72005-04-21 15:56:37 -0400675 length = hcd->driver->hub_status_data(hcd, buffer);
676 if (length > 0) {
677
678 /* try to complete the status urb */
Alan Stern9439eb92007-08-02 15:05:45 -0400679 spin_lock_irqsave(&hcd_root_hub_lock, flags);
Alan Sternd5926ae72005-04-21 15:56:37 -0400680 urb = hcd->status_urb;
681 if (urb) {
Alan Stern541c7d42010-06-22 16:39:10 -0400682 clear_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400683 hcd->status_urb = NULL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400684 urb->actual_length = length;
685 memcpy(urb->transfer_buffer, buffer, length);
Alan Stern9439eb92007-08-02 15:05:45 -0400686
Alan Sterne9df41c2007-08-08 11:48:02 -0400687 usb_hcd_unlink_urb_from_ep(hcd, urb);
Alan Stern9439eb92007-08-02 15:05:45 -0400688 spin_unlock(&hcd_root_hub_lock);
Alan Stern4a000272007-08-24 15:42:24 -0400689 usb_hcd_giveback_urb(hcd, urb, 0);
Alan Stern9439eb92007-08-02 15:05:45 -0400690 spin_lock(&hcd_root_hub_lock);
Alan Sterne9df41c2007-08-08 11:48:02 -0400691 } else {
Alan Sternd5926ae72005-04-21 15:56:37 -0400692 length = 0;
Alan Stern541c7d42010-06-22 16:39:10 -0400693 set_bit(HCD_FLAG_POLL_PENDING, &hcd->flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400694 }
Alan Stern9439eb92007-08-02 15:05:45 -0400695 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
Alan Sternd5926ae72005-04-21 15:56:37 -0400696 }
697
698 /* The USB 2.0 spec says 256 ms. This is close enough and won't
Arjan van de Ven01cd0812007-05-22 12:42:56 -0700699 * exceed that limit if HZ is 100. The math is more clunky than
700 * maybe expected, this is to make sure that all timers for USB devices
701 * fire at the same time to give the CPU a break inbetween */
Alan Stern541c7d42010-06-22 16:39:10 -0400702 if (hcd->uses_new_polling ? HCD_POLL_RH(hcd) :
Alan Sternd5926ae72005-04-21 15:56:37 -0400703 (length == 0 && hcd->status_urb != NULL))
Arjan van de Ven01cd0812007-05-22 12:42:56 -0700704 mod_timer (&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
Alan Sternd5926ae72005-04-21 15:56:37 -0400705}
706EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status);
707
708/* timer callback */
709static void rh_timer_func (unsigned long _hcd)
710{
711 usb_hcd_poll_rh_status((struct usb_hcd *) _hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
713
714/*-------------------------------------------------------------------------*/
715
Alan Sternd5926ae72005-04-21 15:56:37 -0400716static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb)
717{
718 int retval;
719 unsigned long flags;
Roel Kluin71d27182009-03-13 12:19:18 +0100720 unsigned len = 1 + (urb->dev->maxchild / 8);
Alan Sternd5926ae72005-04-21 15:56:37 -0400721
722 spin_lock_irqsave (&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400723 if (hcd->status_urb || urb->transfer_buffer_length < len) {
Alan Sternd5926ae72005-04-21 15:56:37 -0400724 dev_dbg (hcd->self.controller, "not queuing rh status urb\n");
725 retval = -EINVAL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400726 goto done;
Alan Sternd5926ae72005-04-21 15:56:37 -0400727 }
Alan Sterne9df41c2007-08-08 11:48:02 -0400728
729 retval = usb_hcd_link_urb_to_ep(hcd, urb);
730 if (retval)
731 goto done;
732
733 hcd->status_urb = urb;
734 urb->hcpriv = hcd; /* indicate it's queued */
735 if (!hcd->uses_new_polling)
736 mod_timer(&hcd->rh_timer, (jiffies/(HZ/4) + 1) * (HZ/4));
737
738 /* If a status change has already occurred, report it ASAP */
Alan Stern541c7d42010-06-22 16:39:10 -0400739 else if (HCD_POLL_PENDING(hcd))
Alan Sterne9df41c2007-08-08 11:48:02 -0400740 mod_timer(&hcd->rh_timer, jiffies);
741 retval = 0;
742 done:
Alan Sternd5926ae72005-04-21 15:56:37 -0400743 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
744 return retval;
745}
746
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb)
748{
Alan Stern5e60a162007-07-30 17:07:21 -0400749 if (usb_endpoint_xfer_int(&urb->ep->desc))
Alan Sternd5926ae72005-04-21 15:56:37 -0400750 return rh_queue_status (hcd, urb);
Alan Stern5e60a162007-07-30 17:07:21 -0400751 if (usb_endpoint_xfer_control(&urb->ep->desc))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 return rh_call_control (hcd, urb);
Alan Sternd5926ae72005-04-21 15:56:37 -0400753 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754}
755
756/*-------------------------------------------------------------------------*/
757
Alan Stern455b25f2006-08-11 16:01:45 -0400758/* Unlinks of root-hub control URBs are legal, but they don't do anything
759 * since these URBs always execute synchronously.
Alan Sternd5926ae72005-04-21 15:56:37 -0400760 */
Alan Sterne9df41c2007-08-08 11:48:02 -0400761static int usb_rh_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
Alan Stern455b25f2006-08-11 16:01:45 -0400763 unsigned long flags;
Alan Sterne9df41c2007-08-08 11:48:02 -0400764 int rc;
Alan Stern455b25f2006-08-11 16:01:45 -0400765
Alan Stern9439eb92007-08-02 15:05:45 -0400766 spin_lock_irqsave(&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400767 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
768 if (rc)
769 goto done;
770
Alan Stern5e60a162007-07-30 17:07:21 -0400771 if (usb_endpoint_num(&urb->ep->desc) == 0) { /* Control URB */
Alan Stern455b25f2006-08-11 16:01:45 -0400772 ; /* Do nothing */
Alan Sternd5926ae72005-04-21 15:56:37 -0400773
774 } else { /* Status URB */
775 if (!hcd->uses_new_polling)
Alan Stern455b25f2006-08-11 16:01:45 -0400776 del_timer (&hcd->rh_timer);
Alan Sternd5926ae72005-04-21 15:56:37 -0400777 if (urb == hcd->status_urb) {
778 hcd->status_urb = NULL;
Alan Sterne9df41c2007-08-08 11:48:02 -0400779 usb_hcd_unlink_urb_from_ep(hcd, urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Alan Stern9439eb92007-08-02 15:05:45 -0400781 spin_unlock(&hcd_root_hub_lock);
Alan Stern4a000272007-08-24 15:42:24 -0400782 usb_hcd_giveback_urb(hcd, urb, status);
Alan Stern9439eb92007-08-02 15:05:45 -0400783 spin_lock(&hcd_root_hub_lock);
784 }
785 }
Alan Sterne9df41c2007-08-08 11:48:02 -0400786 done:
Alan Stern9439eb92007-08-02 15:05:45 -0400787 spin_unlock_irqrestore(&hcd_root_hub_lock, flags);
Alan Sterne9df41c2007-08-08 11:48:02 -0400788 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}
790
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -0700791
792
793/*
794 * Show & store the current value of authorized_default
795 */
796static ssize_t usb_host_authorized_default_show(struct device *dev,
797 struct device_attribute *attr,
798 char *buf)
799{
800 struct usb_device *rh_usb_dev = to_usb_device(dev);
801 struct usb_bus *usb_bus = rh_usb_dev->bus;
802 struct usb_hcd *usb_hcd;
803
804 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
805 return -ENODEV;
806 usb_hcd = bus_to_hcd(usb_bus);
807 return snprintf(buf, PAGE_SIZE, "%u\n", usb_hcd->authorized_default);
808}
809
810static ssize_t usb_host_authorized_default_store(struct device *dev,
811 struct device_attribute *attr,
812 const char *buf, size_t size)
813{
814 ssize_t result;
815 unsigned val;
816 struct usb_device *rh_usb_dev = to_usb_device(dev);
817 struct usb_bus *usb_bus = rh_usb_dev->bus;
818 struct usb_hcd *usb_hcd;
819
820 if (usb_bus == NULL) /* FIXME: not sure if this case is possible */
821 return -ENODEV;
822 usb_hcd = bus_to_hcd(usb_bus);
823 result = sscanf(buf, "%u\n", &val);
824 if (result == 1) {
825 usb_hcd->authorized_default = val? 1 : 0;
826 result = size;
827 }
828 else
829 result = -EINVAL;
830 return result;
831}
832
833static DEVICE_ATTR(authorized_default, 0644,
834 usb_host_authorized_default_show,
835 usb_host_authorized_default_store);
836
837
838/* Group all the USB bus attributes */
839static struct attribute *usb_bus_attrs[] = {
840 &dev_attr_authorized_default.attr,
841 NULL,
842};
843
844static struct attribute_group usb_bus_attr_group = {
845 .name = NULL, /* we want them in the same directory */
846 .attrs = usb_bus_attrs,
847};
848
849
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851/*-------------------------------------------------------------------------*/
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853/**
854 * usb_bus_init - shared initialization code
855 * @bus: the bus structure being initialized
856 *
857 * This code is used to initialize a usb_bus structure, memory for which is
858 * separately managed.
859 */
860static void usb_bus_init (struct usb_bus *bus)
861{
862 memset (&bus->devmap, 0, sizeof(struct usb_devmap));
863
864 bus->devnum_next = 1;
865
866 bus->root_hub = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 bus->busnum = -1;
868 bus->bandwidth_allocated = 0;
869 bus->bandwidth_int_reqs = 0;
870 bus->bandwidth_isoc_reqs = 0;
871
872 INIT_LIST_HEAD (&bus->bus_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873}
874
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875/*-------------------------------------------------------------------------*/
876
877/**
878 * usb_register_bus - registers the USB host controller with the usb core
879 * @bus: pointer to the bus to register
880 * Context: !in_interrupt()
881 *
882 * Assigns a bus number, and links the controller into usbcore data
883 * structures so that it can be seen by scanning the bus list.
884 */
885static int usb_register_bus(struct usb_bus *bus)
886{
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700887 int result = -E2BIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 int busnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100890 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1);
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700892 if (busnum >= USB_MAXBUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 printk (KERN_ERR "%s: too many buses\n", usbcore_name);
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700894 goto error_find_busnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 }
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700896 set_bit (busnum, busmap.busmap);
897 bus->busnum = busnum;
Tony Jones5a3201b2007-09-11 14:07:31 -0700898
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 /* Add it to the local list of buses */
900 list_add (&bus->bus_list, &usb_bus_list);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100901 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -0700903 usb_notify_add_bus(bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700905 dev_info (bus->controller, "new USB bus registered, assigned bus "
906 "number %d\n", bus->busnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 return 0;
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700908
Inaky Perez-Gonzalezeb579f52007-07-31 20:33:59 -0700909error_find_busnum:
910 mutex_unlock(&usb_bus_list_lock);
911 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912}
913
914/**
915 * usb_deregister_bus - deregisters the USB host controller
916 * @bus: pointer to the bus to deregister
917 * Context: !in_interrupt()
918 *
919 * Recycles the bus number, and unlinks the controller from usbcore data
920 * structures so that it won't be seen by scanning the bus list.
921 */
922static void usb_deregister_bus (struct usb_bus *bus)
923{
924 dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum);
925
926 /*
927 * NOTE: make sure that all the devices are removed by the
928 * controller code, as well as having it call this when cleaning
929 * itself up
930 */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100931 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 list_del (&bus->bus_list);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100933 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -0700935 usb_notify_remove_bus(bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
937 clear_bit (bus->busnum, busmap.busmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938}
939
940/**
Alan Stern8ec8d202005-04-25 11:25:17 -0400941 * register_root_hub - called by usb_add_hcd() to register a root hub
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 * @hcd: host controller for this root hub
943 *
Alan Stern8ec8d202005-04-25 11:25:17 -0400944 * This function registers the root hub with the USB subsystem. It sets up
David Brownellb1e8f0a2006-01-23 15:25:40 -0800945 * the device properly in the device tree and then calls usb_new_device()
946 * to register the usb device. It also assigns the root hub's USB address
947 * (always 1).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 */
David Brownellb1e8f0a2006-01-23 15:25:40 -0800949static int register_root_hub(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950{
951 struct device *parent_dev = hcd->self.controller;
David Brownellb1e8f0a2006-01-23 15:25:40 -0800952 struct usb_device *usb_dev = hcd->self.root_hub;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 const int devnum = 1;
954 int retval;
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 usb_dev->devnum = devnum;
957 usb_dev->bus->devnum_next = devnum + 1;
958 memset (&usb_dev->bus->devmap.devicemap, 0,
959 sizeof usb_dev->bus->devmap.devicemap);
960 set_bit (devnum, usb_dev->bus->devmap.devicemap);
961 usb_set_device_state(usb_dev, USB_STATE_ADDRESS);
962
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100963 mutex_lock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Harvey Harrison551509d2009-02-11 14:11:36 -0800965 usb_dev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE);
967 if (retval != sizeof usb_dev->descriptor) {
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100968 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 dev_dbg (parent_dev, "can't read %s device descriptor %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +0200970 dev_name(&usb_dev->dev), retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 return (retval < 0) ? retval : -EMSGSIZE;
972 }
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 retval = usb_new_device (usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 dev_err (parent_dev, "can't register root hub for %s, %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +0200977 dev_name(&usb_dev->dev), retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 }
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100979 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
981 if (retval == 0) {
982 spin_lock_irq (&hcd_root_hub_lock);
983 hcd->rh_registered = 1;
984 spin_unlock_irq (&hcd_root_hub_lock);
985
986 /* Did the HC die before the root hub was registered? */
987 if (hcd->state == HC_STATE_HALT)
988 usb_hc_died (hcd); /* This time clean up */
989 }
990
991 return retval;
992}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
994
995/*-------------------------------------------------------------------------*/
996
997/**
998 * usb_calc_bus_time - approximate periodic transaction time in nanoseconds
999 * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH}
1000 * @is_input: true iff the transaction sends data to the host
1001 * @isoc: true for isochronous transactions, false for interrupt ones
1002 * @bytecount: how many bytes in the transaction.
1003 *
1004 * Returns approximate bus time in nanoseconds for a periodic transaction.
1005 * See USB 2.0 spec section 5.11.3; only periodic transfers need to be
1006 * scheduled in software, this function is only used for such scheduling.
1007 */
1008long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)
1009{
1010 unsigned long tmp;
1011
1012 switch (speed) {
1013 case USB_SPEED_LOW: /* INTR only */
1014 if (is_input) {
1015 tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L;
1016 return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1017 } else {
1018 tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L;
1019 return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp);
1020 }
1021 case USB_SPEED_FULL: /* ISOC or INTR */
1022 if (isoc) {
1023 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1024 return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp);
1025 } else {
1026 tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L;
1027 return (9107L + BW_HOST_DELAY + tmp);
1028 }
1029 case USB_SPEED_HIGH: /* ISOC or INTR */
1030 // FIXME adjust for input vs output
1031 if (isoc)
Dan Streetman498f78e2005-07-29 12:18:28 -07001032 tmp = HS_NSECS_ISO (bytecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 else
Dan Streetman498f78e2005-07-29 12:18:28 -07001034 tmp = HS_NSECS (bytecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 return tmp;
1036 default:
1037 pr_debug ("%s: bogus device speed!\n", usbcore_name);
1038 return -1;
1039 }
1040}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001041EXPORT_SYMBOL_GPL(usb_calc_bus_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044/*-------------------------------------------------------------------------*/
1045
1046/*
1047 * Generic HC operations.
1048 */
1049
1050/*-------------------------------------------------------------------------*/
1051
Alan Sterne9df41c2007-08-08 11:48:02 -04001052/**
1053 * usb_hcd_link_urb_to_ep - add an URB to its endpoint queue
1054 * @hcd: host controller to which @urb was submitted
1055 * @urb: URB being submitted
1056 *
1057 * Host controller drivers should call this routine in their enqueue()
1058 * method. The HCD's private spinlock must be held and interrupts must
1059 * be disabled. The actions carried out here are required for URB
1060 * submission, as well as for endpoint shutdown and for usb_kill_urb.
1061 *
1062 * Returns 0 for no error, otherwise a negative error code (in which case
1063 * the enqueue() method must fail). If no error occurs but enqueue() fails
1064 * anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing
1065 * the private spinlock and returning.
1066 */
1067int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)
Alan Stern9a9bf402007-08-02 15:06:54 -04001068{
Alan Stern9a9bf402007-08-02 15:06:54 -04001069 int rc = 0;
1070
Alan Sterne9df41c2007-08-08 11:48:02 -04001071 spin_lock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001072
1073 /* Check that the URB isn't being killed */
Ming Lei49367d82008-12-12 21:38:45 +08001074 if (unlikely(atomic_read(&urb->reject))) {
Alan Stern9a9bf402007-08-02 15:06:54 -04001075 rc = -EPERM;
1076 goto done;
1077 }
1078
1079 if (unlikely(!urb->ep->enabled)) {
1080 rc = -ENOENT;
1081 goto done;
1082 }
1083
Alan Stern6840d252007-09-10 11:34:26 -04001084 if (unlikely(!urb->dev->can_submit)) {
1085 rc = -EHOSTUNREACH;
1086 goto done;
1087 }
1088
Alan Stern9a9bf402007-08-02 15:06:54 -04001089 /*
1090 * Check the host controller's state and add the URB to the
1091 * endpoint's queue.
1092 */
1093 switch (hcd->state) {
1094 case HC_STATE_RUNNING:
1095 case HC_STATE_RESUMING:
Alan Sterneb231052007-08-21 15:40:36 -04001096 urb->unlinked = 0;
Alan Stern9a9bf402007-08-02 15:06:54 -04001097 list_add_tail(&urb->urb_list, &urb->ep->urb_list);
1098 break;
1099 default:
1100 rc = -ESHUTDOWN;
1101 goto done;
1102 }
1103 done:
Alan Sterne9df41c2007-08-08 11:48:02 -04001104 spin_unlock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001105 return rc;
1106}
Alan Sterne9df41c2007-08-08 11:48:02 -04001107EXPORT_SYMBOL_GPL(usb_hcd_link_urb_to_ep);
Alan Stern9a9bf402007-08-02 15:06:54 -04001108
Alan Sterne9df41c2007-08-08 11:48:02 -04001109/**
1110 * usb_hcd_check_unlink_urb - check whether an URB may be unlinked
1111 * @hcd: host controller to which @urb was submitted
1112 * @urb: URB being checked for unlinkability
1113 * @status: error code to store in @urb if the unlink succeeds
1114 *
1115 * Host controller drivers should call this routine in their dequeue()
1116 * method. The HCD's private spinlock must be held and interrupts must
1117 * be disabled. The actions carried out here are required for making
1118 * sure than an unlink is valid.
1119 *
1120 * Returns 0 for no error, otherwise a negative error code (in which case
1121 * the dequeue() method must fail). The possible error codes are:
1122 *
1123 * -EIDRM: @urb was not submitted or has already completed.
1124 * The completion function may not have been called yet.
1125 *
1126 * -EBUSY: @urb has already been unlinked.
1127 */
1128int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
Alan Stern9a9bf402007-08-02 15:06:54 -04001129 int status)
1130{
Alan Stern9a9bf402007-08-02 15:06:54 -04001131 struct list_head *tmp;
Alan Stern9a9bf402007-08-02 15:06:54 -04001132
1133 /* insist the urb is still queued */
1134 list_for_each(tmp, &urb->ep->urb_list) {
1135 if (tmp == &urb->urb_list)
1136 break;
1137 }
Alan Sterne9df41c2007-08-08 11:48:02 -04001138 if (tmp != &urb->urb_list)
1139 return -EIDRM;
Alan Stern9a9bf402007-08-02 15:06:54 -04001140
1141 /* Any status except -EINPROGRESS means something already started to
1142 * unlink this URB from the hardware. So there's no more work to do.
1143 */
Alan Sterneb231052007-08-21 15:40:36 -04001144 if (urb->unlinked)
Alan Sterne9df41c2007-08-08 11:48:02 -04001145 return -EBUSY;
Alan Sterneb231052007-08-21 15:40:36 -04001146 urb->unlinked = status;
Alan Stern9a9bf402007-08-02 15:06:54 -04001147
1148 /* IRQ setup can easily be broken so that USB controllers
1149 * never get completion IRQs ... maybe even the ones we need to
1150 * finish unlinking the initial failed usb_set_address()
1151 * or device descriptor fetch.
1152 */
Alan Stern541c7d42010-06-22 16:39:10 -04001153 if (!HCD_SAW_IRQ(hcd) && !is_root_hub(urb->dev)) {
Alan Stern9a9bf402007-08-02 15:06:54 -04001154 dev_warn(hcd->self.controller, "Unlink after no-IRQ? "
1155 "Controller is probably using the wrong IRQ.\n");
1156 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1157 }
1158
Alan Sterne9df41c2007-08-08 11:48:02 -04001159 return 0;
Alan Stern9a9bf402007-08-02 15:06:54 -04001160}
Alan Sterne9df41c2007-08-08 11:48:02 -04001161EXPORT_SYMBOL_GPL(usb_hcd_check_unlink_urb);
Alan Stern9a9bf402007-08-02 15:06:54 -04001162
Alan Sterne9df41c2007-08-08 11:48:02 -04001163/**
1164 * usb_hcd_unlink_urb_from_ep - remove an URB from its endpoint queue
1165 * @hcd: host controller to which @urb was submitted
1166 * @urb: URB being unlinked
1167 *
1168 * Host controller drivers should call this routine before calling
1169 * usb_hcd_giveback_urb(). The HCD's private spinlock must be held and
1170 * interrupts must be disabled. The actions carried out here are required
1171 * for URB completion.
1172 */
1173void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 /* clear all state linking urb to this dev (and hcd) */
Alan Sterne9df41c2007-08-08 11:48:02 -04001176 spin_lock(&hcd_urb_list_lock);
Alan Stern9a9bf402007-08-02 15:06:54 -04001177 list_del_init(&urb->urb_list);
Alan Sterne9df41c2007-08-08 11:48:02 -04001178 spin_unlock(&hcd_urb_list_lock);
Pete Zaitcev9f6a93f2007-06-08 13:37:49 -07001179}
Alan Sterne9df41c2007-08-08 11:48:02 -04001180EXPORT_SYMBOL_GPL(usb_hcd_unlink_urb_from_ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181
Magnus Dammb3476672008-01-23 15:58:35 +09001182/*
1183 * Some usb host controllers can only perform dma using a small SRAM area.
1184 * The usb core itself is however optimized for host controllers that can dma
1185 * using regular system memory - like pci devices doing bus mastering.
1186 *
1187 * To support host controllers with limited dma capabilites we provide dma
1188 * bounce buffers. This feature can be enabled using the HCD_LOCAL_MEM flag.
1189 * For this to work properly the host controller code must first use the
1190 * function dma_declare_coherent_memory() to point out which memory area
1191 * that should be used for dma allocations.
1192 *
1193 * The HCD_LOCAL_MEM flag then tells the usb code to allocate all data for
1194 * dma using dma_alloc_coherent() which in turn allocates from the memory
1195 * area pointed out with dma_declare_coherent_memory().
1196 *
1197 * So, to summarize...
1198 *
1199 * - We need "local" memory, canonical example being
1200 * a small SRAM on a discrete controller being the
1201 * only memory that the controller can read ...
1202 * (a) "normal" kernel memory is no good, and
1203 * (b) there's not enough to share
1204 *
1205 * - The only *portable* hook for such stuff in the
1206 * DMA framework is dma_declare_coherent_memory()
1207 *
1208 * - So we use that, even though the primary requirement
1209 * is that the memory be "local" (hence addressible
1210 * by that device), not "coherent".
1211 *
1212 */
1213
1214static int hcd_alloc_coherent(struct usb_bus *bus,
1215 gfp_t mem_flags, dma_addr_t *dma_handle,
1216 void **vaddr_handle, size_t size,
1217 enum dma_data_direction dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218{
Magnus Dammb3476672008-01-23 15:58:35 +09001219 unsigned char *vaddr;
1220
Andrea Righi4307a282010-06-28 16:56:45 +02001221 if (*vaddr_handle == NULL) {
1222 WARN_ON_ONCE(1);
1223 return -EFAULT;
1224 }
1225
Magnus Dammb3476672008-01-23 15:58:35 +09001226 vaddr = hcd_buffer_alloc(bus, size + sizeof(vaddr),
1227 mem_flags, dma_handle);
1228 if (!vaddr)
1229 return -ENOMEM;
1230
1231 /*
1232 * Store the virtual address of the buffer at the end
1233 * of the allocated dma buffer. The size of the buffer
1234 * may be uneven so use unaligned functions instead
1235 * of just rounding up. It makes sense to optimize for
1236 * memory footprint over access speed since the amount
1237 * of memory available for dma may be limited.
1238 */
1239 put_unaligned((unsigned long)*vaddr_handle,
1240 (unsigned long *)(vaddr + size));
1241
1242 if (dir == DMA_TO_DEVICE)
1243 memcpy(vaddr, *vaddr_handle, size);
1244
1245 *vaddr_handle = vaddr;
1246 return 0;
1247}
1248
1249static void hcd_free_coherent(struct usb_bus *bus, dma_addr_t *dma_handle,
1250 void **vaddr_handle, size_t size,
1251 enum dma_data_direction dir)
1252{
1253 unsigned char *vaddr = *vaddr_handle;
1254
1255 vaddr = (void *)get_unaligned((unsigned long *)(vaddr + size));
1256
1257 if (dir == DMA_FROM_DEVICE)
1258 memcpy(vaddr, *vaddr_handle, size);
1259
1260 hcd_buffer_free(bus, size + sizeof(vaddr), *vaddr_handle, *dma_handle);
1261
1262 *vaddr_handle = vaddr;
1263 *dma_handle = 0;
1264}
1265
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001266void unmap_urb_setup_for_dma(struct usb_hcd *hcd, struct urb *urb)
Alan Sternff9c8952010-04-02 13:27:28 -04001267{
Alan Sternff9c8952010-04-02 13:27:28 -04001268 if (urb->transfer_flags & URB_SETUP_MAP_SINGLE)
1269 dma_unmap_single(hcd->self.controller,
1270 urb->setup_dma,
1271 sizeof(struct usb_ctrlrequest),
1272 DMA_TO_DEVICE);
1273 else if (urb->transfer_flags & URB_SETUP_MAP_LOCAL)
1274 hcd_free_coherent(urb->dev->bus,
1275 &urb->setup_dma,
1276 (void **) &urb->setup_packet,
1277 sizeof(struct usb_ctrlrequest),
1278 DMA_TO_DEVICE);
1279
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001280 /* Make it safe to call this routine more than once */
1281 urb->transfer_flags &= ~(URB_SETUP_MAP_SINGLE | URB_SETUP_MAP_LOCAL);
1282}
1283EXPORT_SYMBOL_GPL(unmap_urb_setup_for_dma);
1284
1285void unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
1286{
1287 enum dma_data_direction dir;
1288
1289 unmap_urb_setup_for_dma(hcd, urb);
1290
Alan Sternff9c8952010-04-02 13:27:28 -04001291 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
1292 if (urb->transfer_flags & URB_DMA_MAP_SG)
1293 dma_unmap_sg(hcd->self.controller,
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001294 urb->sg,
Alan Sternff9c8952010-04-02 13:27:28 -04001295 urb->num_sgs,
1296 dir);
1297 else if (urb->transfer_flags & URB_DMA_MAP_PAGE)
1298 dma_unmap_page(hcd->self.controller,
1299 urb->transfer_dma,
1300 urb->transfer_buffer_length,
1301 dir);
1302 else if (urb->transfer_flags & URB_DMA_MAP_SINGLE)
1303 dma_unmap_single(hcd->self.controller,
1304 urb->transfer_dma,
1305 urb->transfer_buffer_length,
1306 dir);
1307 else if (urb->transfer_flags & URB_MAP_LOCAL)
1308 hcd_free_coherent(urb->dev->bus,
1309 &urb->transfer_dma,
1310 &urb->transfer_buffer,
1311 urb->transfer_buffer_length,
1312 dir);
1313
1314 /* Make it safe to call this routine more than once */
Martin Fuzzey1dae4232010-10-01 00:21:55 +02001315 urb->transfer_flags &= ~(URB_DMA_MAP_SG | URB_DMA_MAP_PAGE |
Alan Sternff9c8952010-04-02 13:27:28 -04001316 URB_DMA_MAP_SINGLE | URB_MAP_LOCAL);
1317}
Maulik Mankad496dda72010-09-24 13:44:06 +03001318EXPORT_SYMBOL_GPL(unmap_urb_for_dma);
Alan Sternff9c8952010-04-02 13:27:28 -04001319
Magnus Dammb3476672008-01-23 15:58:35 +09001320static int map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
1321 gfp_t mem_flags)
1322{
1323 enum dma_data_direction dir;
1324 int ret = 0;
1325
Alan Stern9a9bf402007-08-02 15:06:54 -04001326 /* Map the URB's buffers for DMA access.
1327 * Lower level HCD code should use *_dma exclusively,
Sarah Sharpe04748e2009-04-27 19:59:01 -07001328 * unless it uses pio or talks to another transport,
1329 * or uses the provided scatter gather list for bulk.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 */
Magnus Dammb3476672008-01-23 15:58:35 +09001331
Alan Stern85bcb5e2010-04-30 16:35:37 -04001332 if (usb_endpoint_xfer_control(&urb->ep->desc)) {
Larry Finger85e034f2009-11-05 10:37:03 -06001333 if (hcd->self.uses_dma) {
Magnus Dammb3476672008-01-23 15:58:35 +09001334 urb->setup_dma = dma_map_single(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 hcd->self.controller,
1336 urb->setup_packet,
Magnus Dammb3476672008-01-23 15:58:35 +09001337 sizeof(struct usb_ctrlrequest),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 DMA_TO_DEVICE);
Larry Finger85e034f2009-11-05 10:37:03 -06001339 if (dma_mapping_error(hcd->self.controller,
1340 urb->setup_dma))
1341 return -EAGAIN;
Alan Sternff9c8952010-04-02 13:27:28 -04001342 urb->transfer_flags |= URB_SETUP_MAP_SINGLE;
Ming Leif537da62010-05-12 23:38:12 +08001343 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
Magnus Dammb3476672008-01-23 15:58:35 +09001344 ret = hcd_alloc_coherent(
1345 urb->dev->bus, mem_flags,
1346 &urb->setup_dma,
1347 (void **)&urb->setup_packet,
1348 sizeof(struct usb_ctrlrequest),
1349 DMA_TO_DEVICE);
Alan Sternff9c8952010-04-02 13:27:28 -04001350 if (ret)
1351 return ret;
1352 urb->transfer_flags |= URB_SETUP_MAP_LOCAL;
Ming Leif537da62010-05-12 23:38:12 +08001353 }
Magnus Dammb3476672008-01-23 15:58:35 +09001354 }
1355
1356 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
Alan Sternff9c8952010-04-02 13:27:28 -04001357 if (urb->transfer_buffer_length != 0
Magnus Dammb3476672008-01-23 15:58:35 +09001358 && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) {
Larry Finger85e034f2009-11-05 10:37:03 -06001359 if (hcd->self.uses_dma) {
Alan Sternff9c8952010-04-02 13:27:28 -04001360 if (urb->num_sgs) {
1361 int n = dma_map_sg(
1362 hcd->self.controller,
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001363 urb->sg,
Alan Sternff9c8952010-04-02 13:27:28 -04001364 urb->num_sgs,
1365 dir);
1366 if (n <= 0)
1367 ret = -EAGAIN;
1368 else
1369 urb->transfer_flags |= URB_DMA_MAP_SG;
1370 if (n != urb->num_sgs) {
1371 urb->num_sgs = n;
1372 urb->transfer_flags |=
1373 URB_DMA_SG_COMBINED;
1374 }
1375 } else if (urb->sg) {
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001376 struct scatterlist *sg = urb->sg;
Alan Sternff9c8952010-04-02 13:27:28 -04001377 urb->transfer_dma = dma_map_page(
1378 hcd->self.controller,
1379 sg_page(sg),
1380 sg->offset,
1381 urb->transfer_buffer_length,
1382 dir);
1383 if (dma_mapping_error(hcd->self.controller,
Larry Finger85e034f2009-11-05 10:37:03 -06001384 urb->transfer_dma))
Alan Sternff9c8952010-04-02 13:27:28 -04001385 ret = -EAGAIN;
1386 else
1387 urb->transfer_flags |= URB_DMA_MAP_PAGE;
1388 } else {
1389 urb->transfer_dma = dma_map_single(
1390 hcd->self.controller,
1391 urb->transfer_buffer,
1392 urb->transfer_buffer_length,
1393 dir);
1394 if (dma_mapping_error(hcd->self.controller,
1395 urb->transfer_dma))
1396 ret = -EAGAIN;
1397 else
1398 urb->transfer_flags |= URB_DMA_MAP_SINGLE;
1399 }
Larry Finger85e034f2009-11-05 10:37:03 -06001400 } else if (hcd->driver->flags & HCD_LOCAL_MEM) {
Magnus Dammb3476672008-01-23 15:58:35 +09001401 ret = hcd_alloc_coherent(
1402 urb->dev->bus, mem_flags,
1403 &urb->transfer_dma,
1404 &urb->transfer_buffer,
1405 urb->transfer_buffer_length,
1406 dir);
Alan Sternff9c8952010-04-02 13:27:28 -04001407 if (ret == 0)
1408 urb->transfer_flags |= URB_MAP_LOCAL;
Magnus Dammb3476672008-01-23 15:58:35 +09001409 }
Alan Sternff9c8952010-04-02 13:27:28 -04001410 if (ret && (urb->transfer_flags & (URB_SETUP_MAP_SINGLE |
1411 URB_SETUP_MAP_LOCAL)))
1412 unmap_urb_for_dma(hcd, urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 }
Magnus Dammb3476672008-01-23 15:58:35 +09001414 return ret;
Alan Stern9a9bf402007-08-02 15:06:54 -04001415}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Alan Stern9a9bf402007-08-02 15:06:54 -04001417/*-------------------------------------------------------------------------*/
1418
1419/* may be called in any context with a valid urb->dev usecount
1420 * caller surrenders "ownership" of urb
1421 * expects usb_submit_urb() to have sanity checked and conditioned all
1422 * inputs in the urb
1423 */
1424int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags)
1425{
1426 int status;
1427 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
1428
1429 /* increment urb's reference count as part of giving it to the HCD
1430 * (which will control it). HCD guarantees that it either returns
1431 * an error or calls giveback(), but not both.
1432 */
1433 usb_get_urb(urb);
1434 atomic_inc(&urb->use_count);
Sarah Sharp4d59d8a2007-10-03 14:56:03 -07001435 atomic_inc(&urb->dev->urbnum);
Alan Stern9a9bf402007-08-02 15:06:54 -04001436 usbmon_urb_submit(&hcd->self, urb);
1437
1438 /* NOTE requirements on root-hub callers (usbfs and the hub
1439 * driver, for now): URBs' urb->transfer_buffer must be
1440 * valid and usb_buffer_{sync,unmap}() not be needed, since
1441 * they could clobber root hub response data. Also, control
1442 * URBs must be submitted in process context with interrupts
1443 * enabled.
1444 */
Alan Sternff9c8952010-04-02 13:27:28 -04001445
1446 if (is_root_hub(urb->dev)) {
1447 status = rh_urb_enqueue(hcd, urb);
1448 } else {
1449 status = map_urb_for_dma(hcd, urb, mem_flags);
1450 if (likely(status == 0)) {
1451 status = hcd->driver->urb_enqueue(hcd, urb, mem_flags);
1452 if (unlikely(status))
1453 unmap_urb_for_dma(hcd, urb);
1454 }
Magnus Dammb3476672008-01-23 15:58:35 +09001455 }
1456
Alan Stern9a9bf402007-08-02 15:06:54 -04001457 if (unlikely(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 usbmon_urb_submit_error(&hcd->self, urb, status);
Alan Sternb0d9efb2007-08-21 15:39:21 -04001459 urb->hcpriv = NULL;
Alan Stern9a9bf402007-08-02 15:06:54 -04001460 INIT_LIST_HEAD(&urb->urb_list);
1461 atomic_dec(&urb->use_count);
Sarah Sharp4d59d8a2007-10-03 14:56:03 -07001462 atomic_dec(&urb->dev->urbnum);
Ming Lei49367d82008-12-12 21:38:45 +08001463 if (atomic_read(&urb->reject))
Alan Stern9a9bf402007-08-02 15:06:54 -04001464 wake_up(&usb_kill_urb_queue);
1465 usb_put_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 }
1467 return status;
1468}
1469
1470/*-------------------------------------------------------------------------*/
1471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472/* this makes the hcd giveback() the urb more quickly, by kicking it
1473 * off hardware queues (which may take a while) and returning it as
1474 * soon as practical. we've already set up the urb's return status,
1475 * but we can't know if the callback completed already.
1476 */
Alan Sterne9df41c2007-08-08 11:48:02 -04001477static int unlink1(struct usb_hcd *hcd, struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478{
1479 int value;
1480
Alan Stern809a58b2007-07-18 12:14:24 -04001481 if (is_root_hub(urb->dev))
Alan Sterne9df41c2007-08-08 11:48:02 -04001482 value = usb_rh_urb_dequeue(hcd, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 else {
1484
1485 /* The only reason an HCD might fail this call is if
1486 * it has not yet fully queued the urb to begin with.
1487 * Such failures should be harmless. */
Alan Sterne9df41c2007-08-08 11:48:02 -04001488 value = hcd->driver->urb_dequeue(hcd, urb, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 return value;
1491}
1492
1493/*
1494 * called in any context
1495 *
1496 * caller guarantees urb won't be recycled till both unlink()
1497 * and the urb's completion function return
1498 */
Alan Sterna6d2bb92006-08-30 11:27:36 -04001499int usb_hcd_unlink_urb (struct urb *urb, int status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500{
Alan Stern9a9bf402007-08-02 15:06:54 -04001501 struct usb_hcd *hcd;
Alan Sterncde217a2008-10-21 15:28:46 -04001502 int retval = -EIDRM;
1503 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Alan Sterncde217a2008-10-21 15:28:46 -04001505 /* Prevent the device and bus from going away while
1506 * the unlink is carried out. If they are already gone
1507 * then urb->use_count must be 0, since disconnected
1508 * devices can't have any active URBs.
1509 */
1510 spin_lock_irqsave(&hcd_urb_unlink_lock, flags);
1511 if (atomic_read(&urb->use_count) > 0) {
1512 retval = 0;
1513 usb_get_dev(urb->dev);
1514 }
1515 spin_unlock_irqrestore(&hcd_urb_unlink_lock, flags);
1516 if (retval == 0) {
1517 hcd = bus_to_hcd(urb->dev->bus);
1518 retval = unlink1(hcd, urb, status);
1519 usb_put_dev(urb->dev);
1520 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 if (retval == 0)
1523 retval = -EINPROGRESS;
Alan Sterne9df41c2007-08-08 11:48:02 -04001524 else if (retval != -EIDRM && retval != -EBUSY)
Alan Stern9a9bf402007-08-02 15:06:54 -04001525 dev_dbg(&urb->dev->dev, "hcd_unlink_urb %p fail %d\n",
1526 urb, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 return retval;
1528}
1529
1530/*-------------------------------------------------------------------------*/
1531
Alan Stern32aca562007-07-18 12:08:02 -04001532/**
1533 * usb_hcd_giveback_urb - return URB from HCD to device driver
1534 * @hcd: host controller returning the URB
1535 * @urb: urb being returned to the USB device driver.
Alan Stern4a000272007-08-24 15:42:24 -04001536 * @status: completion status code for the URB.
Alan Stern32aca562007-07-18 12:08:02 -04001537 * Context: in_interrupt()
1538 *
1539 * This hands the URB from HCD to its USB device driver, using its
1540 * completion function. The HCD has freed all per-urb resources
1541 * (and is done using urb->hcpriv). It also released all HCD locks;
1542 * the device driver won't cause problems if it frees, modifies,
1543 * or resubmits this URB.
Alan Sterneb231052007-08-21 15:40:36 -04001544 *
Alan Stern4a000272007-08-24 15:42:24 -04001545 * If @urb was unlinked, the value of @status will be overridden by
Alan Sterneb231052007-08-21 15:40:36 -04001546 * @urb->unlinked. Erroneous short transfers are detected in case
1547 * the HCD hasn't checked for them.
Alan Stern32aca562007-07-18 12:08:02 -04001548 */
Alan Stern4a000272007-08-24 15:42:24 -04001549void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)
Alan Stern32aca562007-07-18 12:08:02 -04001550{
Alan Sternb0d9efb2007-08-21 15:39:21 -04001551 urb->hcpriv = NULL;
Alan Sterneb231052007-08-21 15:40:36 -04001552 if (unlikely(urb->unlinked))
Alan Stern4a000272007-08-24 15:42:24 -04001553 status = urb->unlinked;
Alan Sterneb231052007-08-21 15:40:36 -04001554 else if (unlikely((urb->transfer_flags & URB_SHORT_NOT_OK) &&
Alan Sternb0d9efb2007-08-21 15:39:21 -04001555 urb->actual_length < urb->transfer_buffer_length &&
Alan Stern4a000272007-08-24 15:42:24 -04001556 !status))
1557 status = -EREMOTEIO;
Alan Stern32aca562007-07-18 12:08:02 -04001558
Alan Stern1f5a3d02007-08-22 13:06:53 -04001559 unmap_urb_for_dma(hcd, urb);
Alan Stern4a000272007-08-24 15:42:24 -04001560 usbmon_urb_complete(&hcd->self, urb, status);
Alan Stern1f5a3d02007-08-22 13:06:53 -04001561 usb_unanchor_urb(urb);
1562
Alan Stern32aca562007-07-18 12:08:02 -04001563 /* pass ownership to the completion handler */
Alan Stern4a000272007-08-24 15:42:24 -04001564 urb->status = status;
Alan Stern32aca562007-07-18 12:08:02 -04001565 urb->complete (urb);
1566 atomic_dec (&urb->use_count);
Ming Lei49367d82008-12-12 21:38:45 +08001567 if (unlikely(atomic_read(&urb->reject)))
Alan Stern32aca562007-07-18 12:08:02 -04001568 wake_up (&usb_kill_urb_queue);
1569 usb_put_urb (urb);
1570}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001571EXPORT_SYMBOL_GPL(usb_hcd_giveback_urb);
Alan Stern32aca562007-07-18 12:08:02 -04001572
1573/*-------------------------------------------------------------------------*/
1574
Alan Stern95cf82f2007-09-10 11:33:05 -04001575/* Cancel all URBs pending on this endpoint and wait for the endpoint's
1576 * queue to drain completely. The caller must first insure that no more
1577 * URBs can be submitted for this endpoint.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 */
Alan Stern95cf82f2007-09-10 11:33:05 -04001579void usb_hcd_flush_endpoint(struct usb_device *udev,
Alan Sterna6d2bb92006-08-30 11:27:36 -04001580 struct usb_host_endpoint *ep)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581{
1582 struct usb_hcd *hcd;
1583 struct urb *urb;
1584
Alan Stern95cf82f2007-09-10 11:33:05 -04001585 if (!ep)
1586 return;
Alan Stern9a9bf402007-08-02 15:06:54 -04001587 might_sleep();
Alan Stern17200582006-08-30 11:32:52 -04001588 hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Alan Stern95cf82f2007-09-10 11:33:05 -04001590 /* No more submits can occur */
Alan Stern9a9bf402007-08-02 15:06:54 -04001591 spin_lock_irq(&hcd_urb_list_lock);
Alan Sternddc1fd62007-11-21 15:13:10 -08001592rescan:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 list_for_each_entry (urb, &ep->urb_list, urb_list) {
Alan Stern5e60a162007-07-30 17:07:21 -04001594 int is_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Alan Sterneb231052007-08-21 15:40:36 -04001596 if (urb->unlinked)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 continue;
1598 usb_get_urb (urb);
Alan Stern5e60a162007-07-30 17:07:21 -04001599 is_in = usb_urb_dir_in(urb);
Alan Stern809a58b2007-07-18 12:14:24 -04001600 spin_unlock(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Alan Sterne9df41c2007-08-08 11:48:02 -04001602 /* kick hcd */
1603 unlink1(hcd, urb, -ESHUTDOWN);
1604 dev_dbg (hcd->self.controller,
1605 "shutdown urb %p ep%d%s%s\n",
1606 urb, usb_endpoint_num(&ep->desc),
1607 is_in ? "in" : "out",
1608 ({ char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Alan Sterne9df41c2007-08-08 11:48:02 -04001610 switch (usb_endpoint_type(&ep->desc)) {
1611 case USB_ENDPOINT_XFER_CONTROL:
1612 s = ""; break;
1613 case USB_ENDPOINT_XFER_BULK:
1614 s = "-bulk"; break;
1615 case USB_ENDPOINT_XFER_INT:
1616 s = "-intr"; break;
1617 default:
1618 s = "-iso"; break;
1619 };
1620 s;
1621 }));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 usb_put_urb (urb);
1623
1624 /* list contents may have changed */
Alan Sternddc1fd62007-11-21 15:13:10 -08001625 spin_lock(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 goto rescan;
1627 }
Alan Stern9a9bf402007-08-02 15:06:54 -04001628 spin_unlock_irq(&hcd_urb_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Alan Stern95cf82f2007-09-10 11:33:05 -04001630 /* Wait until the endpoint queue is completely empty */
Alan Stern455b25f2006-08-11 16:01:45 -04001631 while (!list_empty (&ep->urb_list)) {
Alan Stern809a58b2007-07-18 12:14:24 -04001632 spin_lock_irq(&hcd_urb_list_lock);
Alan Stern455b25f2006-08-11 16:01:45 -04001633
1634 /* The list may have changed while we acquired the spinlock */
1635 urb = NULL;
1636 if (!list_empty (&ep->urb_list)) {
1637 urb = list_entry (ep->urb_list.prev, struct urb,
1638 urb_list);
1639 usb_get_urb (urb);
1640 }
Alan Stern809a58b2007-07-18 12:14:24 -04001641 spin_unlock_irq(&hcd_urb_list_lock);
Alan Stern455b25f2006-08-11 16:01:45 -04001642
1643 if (urb) {
1644 usb_kill_urb (urb);
1645 usb_put_urb (urb);
1646 }
1647 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648}
1649
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001650/**
Randy Dunlap70445ae2009-12-13 10:17:16 -08001651 * usb_hcd_alloc_bandwidth - check whether a new bandwidth setting exceeds
1652 * the bus bandwidth
1653 * @udev: target &usb_device
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001654 * @new_config: new configuration to install
1655 * @cur_alt: the current alternate interface setting
1656 * @new_alt: alternate interface setting that is being installed
1657 *
1658 * To change configurations, pass in the new configuration in new_config,
1659 * and pass NULL for cur_alt and new_alt.
1660 *
1661 * To reset a device's configuration (put the device in the ADDRESSED state),
1662 * pass in NULL for new_config, cur_alt, and new_alt.
1663 *
1664 * To change alternate interface settings, pass in NULL for new_config,
1665 * pass in the current alternate interface setting in cur_alt,
1666 * and pass in the new alternate interface setting in new_alt.
1667 *
1668 * Returns an error if the requested bandwidth change exceeds the
1669 * bus bandwidth or host controller internal resources.
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001670 */
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001671int usb_hcd_alloc_bandwidth(struct usb_device *udev,
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001672 struct usb_host_config *new_config,
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001673 struct usb_host_interface *cur_alt,
1674 struct usb_host_interface *new_alt)
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001675{
1676 int num_intfs, i, j;
H Hartley Sweeten576a3622009-11-17 14:53:41 -08001677 struct usb_host_interface *alt = NULL;
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001678 int ret = 0;
1679 struct usb_hcd *hcd;
1680 struct usb_host_endpoint *ep;
1681
1682 hcd = bus_to_hcd(udev->bus);
1683 if (!hcd->driver->check_bandwidth)
1684 return 0;
1685
1686 /* Configuration is being removed - set configuration 0 */
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001687 if (!new_config && !cur_alt) {
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001688 for (i = 1; i < 16; ++i) {
1689 ep = udev->ep_out[i];
1690 if (ep)
1691 hcd->driver->drop_endpoint(hcd, udev, ep);
1692 ep = udev->ep_in[i];
1693 if (ep)
1694 hcd->driver->drop_endpoint(hcd, udev, ep);
1695 }
1696 hcd->driver->check_bandwidth(hcd, udev);
1697 return 0;
1698 }
1699 /* Check if the HCD says there's enough bandwidth. Enable all endpoints
1700 * each interface's alt setting 0 and ask the HCD to check the bandwidth
1701 * of the bus. There will always be bandwidth for endpoint 0, so it's
1702 * ok to exclude it.
1703 */
1704 if (new_config) {
1705 num_intfs = new_config->desc.bNumInterfaces;
1706 /* Remove endpoints (except endpoint 0, which is always on the
1707 * schedule) from the old config from the schedule
1708 */
1709 for (i = 1; i < 16; ++i) {
1710 ep = udev->ep_out[i];
1711 if (ep) {
1712 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1713 if (ret < 0)
1714 goto reset;
1715 }
1716 ep = udev->ep_in[i];
1717 if (ep) {
1718 ret = hcd->driver->drop_endpoint(hcd, udev, ep);
1719 if (ret < 0)
1720 goto reset;
1721 }
1722 }
1723 for (i = 0; i < num_intfs; ++i) {
Sarah Sharpd837e212010-01-05 14:33:29 -08001724 struct usb_host_interface *first_alt;
1725 int iface_num;
1726
1727 first_alt = &new_config->intf_cache[i]->altsetting[0];
1728 iface_num = first_alt->desc.bInterfaceNumber;
Sarah Sharp91017f92009-12-03 09:44:34 -08001729 /* Set up endpoints for alternate interface setting 0 */
Sarah Sharpd837e212010-01-05 14:33:29 -08001730 alt = usb_find_alt_setting(new_config, iface_num, 0);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001731 if (!alt)
1732 /* No alt setting 0? Pick the first setting. */
Sarah Sharpd837e212010-01-05 14:33:29 -08001733 alt = first_alt;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001734
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001735 for (j = 0; j < alt->desc.bNumEndpoints; j++) {
1736 ret = hcd->driver->add_endpoint(hcd, udev, &alt->endpoint[j]);
1737 if (ret < 0)
1738 goto reset;
1739 }
1740 }
1741 }
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001742 if (cur_alt && new_alt) {
Sarah Sharp04a723e2010-01-06 10:16:51 -08001743 struct usb_interface *iface = usb_ifnum_to_if(udev,
1744 cur_alt->desc.bInterfaceNumber);
1745
1746 if (iface->resetting_device) {
1747 /*
1748 * The USB core just reset the device, so the xHCI host
1749 * and the device will think alt setting 0 is installed.
1750 * However, the USB core will pass in the alternate
1751 * setting installed before the reset as cur_alt. Dig
1752 * out the alternate setting 0 structure, or the first
1753 * alternate setting if a broken device doesn't have alt
1754 * setting 0.
1755 */
1756 cur_alt = usb_altnum_to_altsetting(iface, 0);
1757 if (!cur_alt)
1758 cur_alt = &iface->altsetting[0];
1759 }
1760
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001761 /* Drop all the endpoints in the current alt setting */
1762 for (i = 0; i < cur_alt->desc.bNumEndpoints; i++) {
1763 ret = hcd->driver->drop_endpoint(hcd, udev,
1764 &cur_alt->endpoint[i]);
1765 if (ret < 0)
1766 goto reset;
1767 }
1768 /* Add all the endpoints in the new alt setting */
1769 for (i = 0; i < new_alt->desc.bNumEndpoints; i++) {
1770 ret = hcd->driver->add_endpoint(hcd, udev,
1771 &new_alt->endpoint[i]);
1772 if (ret < 0)
1773 goto reset;
1774 }
1775 }
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001776 ret = hcd->driver->check_bandwidth(hcd, udev);
1777reset:
1778 if (ret < 0)
1779 hcd->driver->reset_bandwidth(hcd, udev);
1780 return ret;
1781}
1782
Alan Stern95cf82f2007-09-10 11:33:05 -04001783/* Disables the endpoint: synchronizes with the hcd to make sure all
1784 * endpoint state is gone from hardware. usb_hcd_flush_endpoint() must
1785 * have been called previously. Use for set_configuration, set_interface,
1786 * driver removal, physical disconnect.
1787 *
1788 * example: a qh stored in ep->hcpriv, holding state related to endpoint
1789 * type, maxpacket size, toggle, halt status, and scheduling.
1790 */
1791void usb_hcd_disable_endpoint(struct usb_device *udev,
1792 struct usb_host_endpoint *ep)
1793{
1794 struct usb_hcd *hcd;
1795
1796 might_sleep();
1797 hcd = bus_to_hcd(udev->bus);
1798 if (hcd->driver->endpoint_disable)
1799 hcd->driver->endpoint_disable(hcd, ep);
1800}
1801
David Vrabel3444b262009-04-08 17:36:28 +00001802/**
1803 * usb_hcd_reset_endpoint - reset host endpoint state
1804 * @udev: USB device.
1805 * @ep: the endpoint to reset.
1806 *
1807 * Resets any host endpoint state such as the toggle bit, sequence
1808 * number and current window.
1809 */
1810void usb_hcd_reset_endpoint(struct usb_device *udev,
1811 struct usb_host_endpoint *ep)
1812{
1813 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1814
1815 if (hcd->driver->endpoint_reset)
1816 hcd->driver->endpoint_reset(hcd, ep);
1817 else {
1818 int epnum = usb_endpoint_num(&ep->desc);
1819 int is_out = usb_endpoint_dir_out(&ep->desc);
1820 int is_control = usb_endpoint_xfer_control(&ep->desc);
1821
1822 usb_settoggle(udev, epnum, is_out, 0);
1823 if (is_control)
1824 usb_settoggle(udev, epnum, !is_out, 0);
1825 }
1826}
1827
Sarah Sharpeab1caf2010-04-05 10:55:58 -07001828/**
1829 * usb_alloc_streams - allocate bulk endpoint stream IDs.
1830 * @interface: alternate setting that includes all endpoints.
1831 * @eps: array of endpoints that need streams.
1832 * @num_eps: number of endpoints in the array.
1833 * @num_streams: number of streams to allocate.
1834 * @mem_flags: flags hcd should use to allocate memory.
1835 *
1836 * Sets up a group of bulk endpoints to have num_streams stream IDs available.
1837 * Drivers may queue multiple transfers to different stream IDs, which may
1838 * complete in a different order than they were queued.
1839 */
1840int usb_alloc_streams(struct usb_interface *interface,
1841 struct usb_host_endpoint **eps, unsigned int num_eps,
1842 unsigned int num_streams, gfp_t mem_flags)
1843{
1844 struct usb_hcd *hcd;
1845 struct usb_device *dev;
1846 int i;
1847
1848 dev = interface_to_usbdev(interface);
1849 hcd = bus_to_hcd(dev->bus);
1850 if (!hcd->driver->alloc_streams || !hcd->driver->free_streams)
1851 return -EINVAL;
1852 if (dev->speed != USB_SPEED_SUPER)
1853 return -EINVAL;
1854
1855 /* Streams only apply to bulk endpoints. */
1856 for (i = 0; i < num_eps; i++)
1857 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1858 return -EINVAL;
1859
1860 return hcd->driver->alloc_streams(hcd, dev, eps, num_eps,
1861 num_streams, mem_flags);
1862}
1863EXPORT_SYMBOL_GPL(usb_alloc_streams);
1864
1865/**
1866 * usb_free_streams - free bulk endpoint stream IDs.
1867 * @interface: alternate setting that includes all endpoints.
1868 * @eps: array of endpoints to remove streams from.
1869 * @num_eps: number of endpoints in the array.
1870 * @mem_flags: flags hcd should use to allocate memory.
1871 *
1872 * Reverts a group of bulk endpoints back to not using stream IDs.
1873 * Can fail if we are given bad arguments, or HCD is broken.
1874 */
1875void usb_free_streams(struct usb_interface *interface,
1876 struct usb_host_endpoint **eps, unsigned int num_eps,
1877 gfp_t mem_flags)
1878{
1879 struct usb_hcd *hcd;
1880 struct usb_device *dev;
1881 int i;
1882
1883 dev = interface_to_usbdev(interface);
1884 hcd = bus_to_hcd(dev->bus);
1885 if (dev->speed != USB_SPEED_SUPER)
1886 return;
1887
1888 /* Streams only apply to bulk endpoints. */
1889 for (i = 0; i < num_eps; i++)
1890 if (!usb_endpoint_xfer_bulk(&eps[i]->desc))
1891 return;
1892
1893 hcd->driver->free_streams(hcd, dev, eps, num_eps, mem_flags);
1894}
1895EXPORT_SYMBOL_GPL(usb_free_streams);
1896
Alan Sterncde217a2008-10-21 15:28:46 -04001897/* Protect against drivers that try to unlink URBs after the device
1898 * is gone, by waiting until all unlinks for @udev are finished.
1899 * Since we don't currently track URBs by device, simply wait until
1900 * nothing is running in the locked region of usb_hcd_unlink_urb().
1901 */
1902void usb_hcd_synchronize_unlinks(struct usb_device *udev)
1903{
1904 spin_lock_irq(&hcd_urb_unlink_lock);
1905 spin_unlock_irq(&hcd_urb_unlink_lock);
1906}
1907
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908/*-------------------------------------------------------------------------*/
1909
Alan Stern32aca562007-07-18 12:08:02 -04001910/* called in any context */
1911int usb_hcd_get_frame_number (struct usb_device *udev)
1912{
1913 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1914
1915 if (!HC_IS_RUNNING (hcd->state))
1916 return -ESHUTDOWN;
1917 return hcd->driver->get_frame_number (hcd);
1918}
1919
1920/*-------------------------------------------------------------------------*/
1921
David Brownell92936772005-09-22 22:32:11 -07001922#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923
Alan Stern65bfd292008-11-25 16:39:18 -05001924int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925{
Alan Stern686314c2007-05-30 15:34:36 -04001926 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1927 int status;
1928 int old_state = hcd->state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
Alan Stern686314c2007-05-30 15:34:36 -04001930 dev_dbg(&rhdev->dev, "bus %s%s\n",
Alan Stern65bfd292008-11-25 16:39:18 -05001931 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "suspend");
Alan Stern686314c2007-05-30 15:34:36 -04001932 if (!hcd->driver->bus_suspend) {
1933 status = -ENOENT;
1934 } else {
1935 hcd->state = HC_STATE_QUIESCING;
1936 status = hcd->driver->bus_suspend(hcd);
1937 }
1938 if (status == 0) {
1939 usb_set_device_state(rhdev, USB_STATE_SUSPENDED);
David Brownell92936772005-09-22 22:32:11 -07001940 hcd->state = HC_STATE_SUSPENDED;
Alan Stern686314c2007-05-30 15:34:36 -04001941 } else {
1942 hcd->state = old_state;
1943 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
David Brownell92936772005-09-22 22:32:11 -07001944 "suspend", status);
Alan Stern686314c2007-05-30 15:34:36 -04001945 }
David Brownell92936772005-09-22 22:32:11 -07001946 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947}
1948
Alan Stern65bfd292008-11-25 16:39:18 -05001949int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950{
Alan Stern686314c2007-05-30 15:34:36 -04001951 struct usb_hcd *hcd = container_of(rhdev->bus, struct usb_hcd, self);
1952 int status;
Alan Sterncfa59da2007-06-21 16:25:35 -04001953 int old_state = hcd->state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954
Alan Stern686314c2007-05-30 15:34:36 -04001955 dev_dbg(&rhdev->dev, "usb %s%s\n",
Alan Stern65bfd292008-11-25 16:39:18 -05001956 (msg.event & PM_EVENT_AUTO ? "auto-" : ""), "resume");
Alan Sternff2f0782010-06-25 14:02:35 -04001957 clear_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
Alan Stern0c0382e2005-10-13 17:08:02 -04001958 if (!hcd->driver->bus_resume)
David Brownell92936772005-09-22 22:32:11 -07001959 return -ENOENT;
David Brownell979d5192005-09-22 22:32:24 -07001960 if (hcd->state == HC_STATE_RUNNING)
1961 return 0;
Alan Stern686314c2007-05-30 15:34:36 -04001962
David Brownell92936772005-09-22 22:32:11 -07001963 hcd->state = HC_STATE_RESUMING;
Alan Stern686314c2007-05-30 15:34:36 -04001964 status = hcd->driver->bus_resume(hcd);
1965 if (status == 0) {
1966 /* TRSMRCY = 10 msec */
1967 msleep(10);
1968 usb_set_device_state(rhdev, rhdev->actconfig
1969 ? USB_STATE_CONFIGURED
1970 : USB_STATE_ADDRESS);
David Brownell92936772005-09-22 22:32:11 -07001971 hcd->state = HC_STATE_RUNNING;
Alan Stern686314c2007-05-30 15:34:36 -04001972 } else {
Alan Sterncfa59da2007-06-21 16:25:35 -04001973 hcd->state = old_state;
Alan Stern686314c2007-05-30 15:34:36 -04001974 dev_dbg(&rhdev->dev, "bus %s fail, err %d\n",
David Brownell92936772005-09-22 22:32:11 -07001975 "resume", status);
Alan Sterncfa59da2007-06-21 16:25:35 -04001976 if (status != -ESHUTDOWN)
1977 usb_hc_died(hcd);
David Brownell92936772005-09-22 22:32:11 -07001978 }
1979 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980}
1981
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001982#endif /* CONFIG_PM */
1983
1984#ifdef CONFIG_USB_SUSPEND
1985
Alan Stern6b157c92007-03-13 16:37:30 -04001986/* Workqueue routine for root-hub remote wakeup */
1987static void hcd_resume_work(struct work_struct *work)
1988{
1989 struct usb_hcd *hcd = container_of(work, struct usb_hcd, wakeup_work);
1990 struct usb_device *udev = hcd->self.root_hub;
1991
1992 usb_lock_device(udev);
Alan Stern0534d462010-01-08 12:56:30 -05001993 usb_remote_wakeup(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04001994 usb_unlock_device(udev);
1995}
1996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997/**
1998 * usb_hcd_resume_root_hub - called by HCD to resume its root hub
1999 * @hcd: host controller for this root hub
2000 *
2001 * The USB host controller calls this function when its root hub is
2002 * suspended (with the remote wakeup feature enabled) and a remote
Alan Stern6b157c92007-03-13 16:37:30 -04002003 * wakeup request is received. The routine submits a workqueue request
2004 * to resume the root hub (that is, manage its downstream ports again).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 */
2006void usb_hcd_resume_root_hub (struct usb_hcd *hcd)
2007{
2008 unsigned long flags;
2009
2010 spin_lock_irqsave (&hcd_root_hub_lock, flags);
Alan Sternff2f0782010-06-25 14:02:35 -04002011 if (hcd->rh_registered) {
2012 set_bit(HCD_FLAG_WAKEUP_PENDING, &hcd->flags);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002013 queue_work(pm_wq, &hcd->wakeup_work);
Alan Sternff2f0782010-06-25 14:02:35 -04002014 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2016}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub);
2018
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002019#endif /* CONFIG_USB_SUSPEND */
David Brownell92936772005-09-22 22:32:11 -07002020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021/*-------------------------------------------------------------------------*/
2022
2023#ifdef CONFIG_USB_OTG
2024
2025/**
2026 * usb_bus_start_enum - start immediate enumeration (for OTG)
2027 * @bus: the bus (must use hcd framework)
2028 * @port_num: 1-based number of port; usually bus->otg_port
2029 * Context: in_interrupt()
2030 *
2031 * Starts enumeration, with an immediate reset followed later by
2032 * khubd identifying and possibly configuring the device.
2033 * This is needed by OTG controller drivers, where it helps meet
2034 * HNP protocol timing requirements for starting a port reset.
2035 */
2036int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)
2037{
2038 struct usb_hcd *hcd;
2039 int status = -EOPNOTSUPP;
2040
2041 /* NOTE: since HNP can't start by grabbing the bus's address0_sem,
2042 * boards with root hubs hooked up to internal devices (instead of
2043 * just the OTG port) may need more attention to resetting...
2044 */
2045 hcd = container_of (bus, struct usb_hcd, self);
2046 if (port_num && hcd->driver->start_port_reset)
2047 status = hcd->driver->start_port_reset(hcd, port_num);
2048
2049 /* run khubd shortly after (first) root port reset finishes;
2050 * it may issue others, until at least 50 msecs have passed.
2051 */
2052 if (status == 0)
2053 mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10));
2054 return status;
2055}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002056EXPORT_SYMBOL_GPL(usb_bus_start_enum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057
2058#endif
2059
2060/*-------------------------------------------------------------------------*/
2061
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 * usb_hcd_irq - hook IRQs to HCD framework (bus glue)
2064 * @irq: the IRQ being raised
2065 * @__hcd: pointer to the HCD whose IRQ is being signaled
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 *
2067 * If the controller isn't HALTed, calls the driver's irq handler.
2068 * Checks whether the controller is now dead.
2069 */
David Howells7d12e782006-10-05 14:55:46 +01002070irqreturn_t usb_hcd_irq (int irq, void *__hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
2072 struct usb_hcd *hcd = __hcd;
Stefan Beckerde854222008-07-01 19:19:22 +03002073 unsigned long flags;
2074 irqreturn_t rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
Stefan Beckerde854222008-07-01 19:19:22 +03002076 /* IRQF_DISABLED doesn't work correctly with shared IRQs
2077 * when the first handler doesn't use it. So let's just
2078 * assume it's never used.
2079 */
2080 local_irq_save(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081
Alan Stern541c7d42010-06-22 16:39:10 -04002082 if (unlikely(hcd->state == HC_STATE_HALT || !HCD_HW_ACCESSIBLE(hcd))) {
Stefan Beckerde854222008-07-01 19:19:22 +03002083 rc = IRQ_NONE;
2084 } else if (hcd->driver->irq(hcd) == IRQ_NONE) {
2085 rc = IRQ_NONE;
2086 } else {
2087 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +11002088
Stefan Beckerde854222008-07-01 19:19:22 +03002089 if (unlikely(hcd->state == HC_STATE_HALT))
2090 usb_hc_died(hcd);
2091 rc = IRQ_HANDLED;
2092 }
2093
2094 local_irq_restore(flags);
2095 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096}
Dong Nguyen43b86af2010-07-21 16:56:08 -07002097EXPORT_SYMBOL_GPL(usb_hcd_irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
2099/*-------------------------------------------------------------------------*/
2100
2101/**
2102 * usb_hc_died - report abnormal shutdown of a host controller (bus glue)
2103 * @hcd: pointer to the HCD representing the controller
2104 *
2105 * This is called by bus glue to report a USB host controller that died
2106 * while operations may still have been pending. It's called automatically
2107 * by the PCI glue, so only glue for non-PCI busses should need to call it.
2108 */
2109void usb_hc_died (struct usb_hcd *hcd)
2110{
2111 unsigned long flags;
2112
2113 dev_err (hcd->self.controller, "HC died; cleaning up\n");
2114
2115 spin_lock_irqsave (&hcd_root_hub_lock, flags);
2116 if (hcd->rh_registered) {
Alan Stern541c7d42010-06-22 16:39:10 -04002117 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118
2119 /* make khubd clean up old urbs and devices */
2120 usb_set_device_state (hcd->self.root_hub,
2121 USB_STATE_NOTATTACHED);
2122 usb_kick_khubd (hcd->self.root_hub);
2123 }
2124 spin_unlock_irqrestore (&hcd_root_hub_lock, flags);
2125}
2126EXPORT_SYMBOL_GPL (usb_hc_died);
2127
2128/*-------------------------------------------------------------------------*/
2129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130/**
2131 * usb_create_hcd - create and initialize an HCD structure
2132 * @driver: HC driver that will use this hcd
2133 * @dev: device for this HC, stored in hcd->self.controller
2134 * @bus_name: value to store in hcd->self.bus_name
2135 * Context: !in_interrupt()
2136 *
2137 * Allocate a struct usb_hcd, with extra space at the end for the
2138 * HC driver's private data. Initialize the generic members of the
2139 * hcd structure.
2140 *
2141 * If memory is unavailable, returns NULL.
2142 */
2143struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
Greg Kroah-Hartman1b26da12008-07-02 12:46:22 -07002144 struct device *dev, const char *bus_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145{
2146 struct usb_hcd *hcd;
2147
Pekka Enberg7b842b62005-09-06 15:18:34 -07002148 hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 if (!hcd) {
2150 dev_dbg (dev, "hcd alloc failed\n");
2151 return NULL;
2152 }
2153 dev_set_drvdata(dev, hcd);
Alan Stern17200582006-08-30 11:32:52 -04002154 kref_init(&hcd->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
2156 usb_bus_init(&hcd->self);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 hcd->self.controller = dev;
2158 hcd->self.bus_name = bus_name;
Alan Sterndd990f12006-08-30 11:29:56 -04002159 hcd->self.uses_dma = (dev->dma_mask != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161 init_timer(&hcd->rh_timer);
Alan Sternd5926ae72005-04-21 15:56:37 -04002162 hcd->rh_timer.function = rh_timer_func;
2163 hcd->rh_timer.data = (unsigned long) hcd;
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002164#ifdef CONFIG_USB_SUSPEND
Alan Stern6b157c92007-03-13 16:37:30 -04002165 INIT_WORK(&hcd->wakeup_work, hcd_resume_work);
2166#endif
Sarah Sharp3f0479e2009-12-03 09:44:36 -08002167 mutex_init(&hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168
2169 hcd->driver = driver;
2170 hcd->product_desc = (driver->product_desc) ? driver->product_desc :
2171 "USB Host Controller";
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 return hcd;
2173}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002174EXPORT_SYMBOL_GPL(usb_create_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
Alan Stern17200582006-08-30 11:32:52 -04002176static void hcd_release (struct kref *kref)
2177{
2178 struct usb_hcd *hcd = container_of (kref, struct usb_hcd, kref);
2179
2180 kfree(hcd);
2181}
2182
2183struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd)
2184{
2185 if (hcd)
2186 kref_get (&hcd->kref);
2187 return hcd;
2188}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002189EXPORT_SYMBOL_GPL(usb_get_hcd);
Alan Stern17200582006-08-30 11:32:52 -04002190
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191void usb_put_hcd (struct usb_hcd *hcd)
2192{
Alan Stern17200582006-08-30 11:32:52 -04002193 if (hcd)
2194 kref_put (&hcd->kref, hcd_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002196EXPORT_SYMBOL_GPL(usb_put_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197
2198/**
2199 * usb_add_hcd - finish generic HCD structure initialization and register
2200 * @hcd: the usb_hcd structure to initialize
2201 * @irqnum: Interrupt line to allocate
2202 * @irqflags: Interrupt type flags
2203 *
2204 * Finish the remaining parts of generic HCD initialization: allocate the
2205 * buffers of consistent memory, register the bus, request the IRQ line,
2206 * and call the driver's reset() and start() routines.
2207 */
2208int usb_add_hcd(struct usb_hcd *hcd,
2209 unsigned int irqnum, unsigned long irqflags)
2210{
Alan Stern8ec8d202005-04-25 11:25:17 -04002211 int retval;
2212 struct usb_device *rhdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213
2214 dev_info(hcd->self.controller, "%s\n", hcd->product_desc);
2215
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002216 hcd->authorized_default = hcd->wireless? 0 : 1;
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +11002217 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2218
David Brownellb1e8f0a2006-01-23 15:25:40 -08002219 /* HC is in reset state, but accessible. Now do the one-time init,
2220 * bottom up so that hcds can customize the root hubs before khubd
2221 * starts talking to them. (Note, bus id is assigned early too.)
2222 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 if ((retval = hcd_buffer_create(hcd)) != 0) {
2224 dev_dbg(hcd->self.controller, "pool alloc failed\n");
2225 return retval;
2226 }
2227
2228 if ((retval = usb_register_bus(&hcd->self)) < 0)
Alan Stern8ec8d202005-04-25 11:25:17 -04002229 goto err_register_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230
David Brownellb1e8f0a2006-01-23 15:25:40 -08002231 if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) {
2232 dev_err(hcd->self.controller, "unable to allocate root hub\n");
2233 retval = -ENOMEM;
2234 goto err_allocate_root_hub;
2235 }
Alan Stern6d88e672010-06-09 17:34:17 -04002236 hcd->self.root_hub = rhdev;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002237
2238 switch (hcd->driver->flags & HCD_MASK) {
2239 case HCD_USB11:
2240 rhdev->speed = USB_SPEED_FULL;
2241 break;
2242 case HCD_USB2:
2243 rhdev->speed = USB_SPEED_HIGH;
2244 break;
2245 case HCD_USB3:
2246 rhdev->speed = USB_SPEED_SUPER;
2247 break;
2248 default:
Alan Stern96e077a2010-06-09 17:34:05 -04002249 goto err_set_rh_speed;
Sarah Sharp6b403b02009-04-27 19:54:10 -07002250 }
David Brownellb1e8f0a2006-01-23 15:25:40 -08002251
David Brownelldb4cefa2006-05-01 22:07:13 -07002252 /* wakeup flag init defaults to "everything works" for root hubs,
2253 * but drivers can override it in reset() if needed, along with
2254 * recording the overall controller's system wakeup capability.
2255 */
2256 device_init_wakeup(&rhdev->dev, 1);
2257
David Brownellb1e8f0a2006-01-23 15:25:40 -08002258 /* "reset" is misnamed; its role is now one-time init. the controller
2259 * should already have been reset (and boot firmware kicked off etc).
2260 */
2261 if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) {
2262 dev_err(hcd->self.controller, "can't setup\n");
2263 goto err_hcd_driver_setup;
2264 }
Alan Stern6d88e672010-06-09 17:34:17 -04002265 hcd->rh_pollable = 1;
David Brownellb1e8f0a2006-01-23 15:25:40 -08002266
David Brownellfb669cc2006-01-24 08:40:27 -08002267 /* NOTE: root hub and controller capabilities may not be the same */
2268 if (device_can_wakeup(hcd->self.controller)
2269 && device_can_wakeup(&hcd->self.root_hub->dev))
David Brownellb1e8f0a2006-01-23 15:25:40 -08002270 dev_dbg(hcd->self.controller, "supports USB remote wakeup\n");
David Brownellb1e8f0a2006-01-23 15:25:40 -08002271
2272 /* enable irqs just before we start the controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 if (hcd->driver->irq) {
Stefan Beckerde854222008-07-01 19:19:22 +03002274
2275 /* IRQF_DISABLED doesn't work as advertised when used together
2276 * with IRQF_SHARED. As usb_hcd_irq() will always disable
2277 * interrupts we can remove it here.
2278 */
Geoff Levand83a79822008-08-22 14:13:00 -07002279 if (irqflags & IRQF_SHARED)
2280 irqflags &= ~IRQF_DISABLED;
Stefan Beckerde854222008-07-01 19:19:22 +03002281
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d",
2283 hcd->driver->description, hcd->self.busnum);
2284 if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags,
2285 hcd->irq_descr, hcd)) != 0) {
2286 dev_err(hcd->self.controller,
David S. Millerc6387a42006-06-20 01:21:29 -07002287 "request interrupt %d failed\n", irqnum);
Alan Stern8ec8d202005-04-25 11:25:17 -04002288 goto err_request_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 }
2290 hcd->irq = irqnum;
David S. Millerc6387a42006-06-20 01:21:29 -07002291 dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 (hcd->driver->flags & HCD_MEMORY) ?
2293 "io mem" : "io base",
2294 (unsigned long long)hcd->rsrc_start);
2295 } else {
2296 hcd->irq = -1;
2297 if (hcd->rsrc_start)
2298 dev_info(hcd->self.controller, "%s 0x%08llx\n",
2299 (hcd->driver->flags & HCD_MEMORY) ?
2300 "io mem" : "io base",
2301 (unsigned long long)hcd->rsrc_start);
2302 }
2303
2304 if ((retval = hcd->driver->start(hcd)) < 0) {
2305 dev_err(hcd->self.controller, "startup error %d\n", retval);
Alan Stern8ec8d202005-04-25 11:25:17 -04002306 goto err_hcd_driver_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 }
2308
David Brownellb1e8f0a2006-01-23 15:25:40 -08002309 /* starting here, usbcore will pay attention to this root hub */
Alan Stern55c52712005-11-23 12:03:12 -05002310 rhdev->bus_mA = min(500u, hcd->power_budget);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002311 if ((retval = register_root_hub(hcd)) != 0)
Alan Stern8ec8d202005-04-25 11:25:17 -04002312 goto err_register_root_hub;
2313
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002314 retval = sysfs_create_group(&rhdev->dev.kobj, &usb_bus_attr_group);
2315 if (retval < 0) {
2316 printk(KERN_ERR "Cannot register USB bus sysfs attributes: %d\n",
2317 retval);
2318 goto error_create_attr_group;
2319 }
Alan Stern541c7d42010-06-22 16:39:10 -04002320 if (hcd->uses_new_polling && HCD_POLL_RH(hcd))
Alan Sternd5926ae72005-04-21 15:56:37 -04002321 usb_hcd_poll_rh_status(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 return retval;
2323
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002324error_create_attr_group:
Alan Stern96e077a2010-06-09 17:34:05 -04002325 if (HC_IS_RUNNING(hcd->state))
2326 hcd->state = HC_STATE_QUIESCING;
2327 spin_lock_irq(&hcd_root_hub_lock);
2328 hcd->rh_registered = 0;
2329 spin_unlock_irq(&hcd_root_hub_lock);
2330
2331#ifdef CONFIG_USB_SUSPEND
2332 cancel_work_sync(&hcd->wakeup_work);
2333#endif
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002334 mutex_lock(&usb_bus_list_lock);
Alan Stern6d88e672010-06-09 17:34:17 -04002335 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
Inaky Perez-Gonzalez5234ce12007-07-31 20:33:58 -07002336 mutex_unlock(&usb_bus_list_lock);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002337err_register_root_hub:
Alan Stern6d88e672010-06-09 17:34:17 -04002338 hcd->rh_pollable = 0;
Alan Stern541c7d42010-06-22 16:39:10 -04002339 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern6d88e672010-06-09 17:34:17 -04002340 del_timer_sync(&hcd->rh_timer);
Alan Stern8ec8d202005-04-25 11:25:17 -04002341 hcd->driver->stop(hcd);
Alan Stern96e077a2010-06-09 17:34:05 -04002342 hcd->state = HC_STATE_HALT;
Alan Stern541c7d42010-06-22 16:39:10 -04002343 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern96e077a2010-06-09 17:34:05 -04002344 del_timer_sync(&hcd->rh_timer);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002345err_hcd_driver_start:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 if (hcd->irq >= 0)
2347 free_irq(irqnum, hcd);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002348err_request_irq:
2349err_hcd_driver_setup:
Alan Stern96e077a2010-06-09 17:34:05 -04002350err_set_rh_speed:
Alan Stern6d88e672010-06-09 17:34:17 -04002351 usb_put_dev(hcd->self.root_hub);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002352err_allocate_root_hub:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 usb_deregister_bus(&hcd->self);
David Brownellb1e8f0a2006-01-23 15:25:40 -08002354err_register_bus:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 hcd_buffer_destroy(hcd);
2356 return retval;
2357}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002358EXPORT_SYMBOL_GPL(usb_add_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
2360/**
2361 * usb_remove_hcd - shutdown processing for generic HCDs
2362 * @hcd: the usb_hcd structure to remove
2363 * Context: !in_interrupt()
2364 *
2365 * Disconnects the root hub, then reverses the effects of usb_add_hcd(),
2366 * invoking the HCD's stop() method.
2367 */
2368void usb_remove_hcd(struct usb_hcd *hcd)
2369{
Alan Stern6d88e672010-06-09 17:34:17 -04002370 struct usb_device *rhdev = hcd->self.root_hub;
2371
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 dev_info(hcd->self.controller, "remove, state %x\n", hcd->state);
2373
Alan Stern6d88e672010-06-09 17:34:17 -04002374 usb_get_dev(rhdev);
2375 sysfs_remove_group(&rhdev->dev.kobj, &usb_bus_attr_group);
Alan Stern96e077a2010-06-09 17:34:05 -04002376
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 if (HC_IS_RUNNING (hcd->state))
2378 hcd->state = HC_STATE_QUIESCING;
2379
2380 dev_dbg(hcd->self.controller, "roothub graceful disconnect\n");
2381 spin_lock_irq (&hcd_root_hub_lock);
2382 hcd->rh_registered = 0;
2383 spin_unlock_irq (&hcd_root_hub_lock);
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002384
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002385#ifdef CONFIG_USB_SUSPEND
Alan Sternd5d4db72007-05-29 16:34:52 -04002386 cancel_work_sync(&hcd->wakeup_work);
Alan Stern6b157c92007-03-13 16:37:30 -04002387#endif
2388
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002389 mutex_lock(&usb_bus_list_lock);
Alan Stern6d88e672010-06-09 17:34:17 -04002390 usb_disconnect(&rhdev); /* Sets rhdev to NULL */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002391 mutex_unlock(&usb_bus_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392
Alan Stern6d88e672010-06-09 17:34:17 -04002393 /* Prevent any more root-hub status calls from the timer.
2394 * The HCD might still restart the timer (if a port status change
2395 * interrupt occurs), but usb_hcd_poll_rh_status() won't invoke
2396 * the hub_status_data() callback.
2397 */
2398 hcd->rh_pollable = 0;
Alan Stern541c7d42010-06-22 16:39:10 -04002399 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern6d88e672010-06-09 17:34:17 -04002400 del_timer_sync(&hcd->rh_timer);
2401
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 hcd->driver->stop(hcd);
2403 hcd->state = HC_STATE_HALT;
2404
Alan Stern6d88e672010-06-09 17:34:17 -04002405 /* In case the HCD restarted the timer, stop it again. */
Alan Stern541c7d42010-06-22 16:39:10 -04002406 clear_bit(HCD_FLAG_POLL_RH, &hcd->flags);
Alan Stern1b42ae62007-03-13 11:10:52 -04002407 del_timer_sync(&hcd->rh_timer);
2408
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 if (hcd->irq >= 0)
2410 free_irq(hcd->irq, hcd);
Alan Stern6d88e672010-06-09 17:34:17 -04002411
2412 usb_put_dev(hcd->self.root_hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 usb_deregister_bus(&hcd->self);
2414 hcd_buffer_destroy(hcd);
2415}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002416EXPORT_SYMBOL_GPL(usb_remove_hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
Aleksey Gorelov64a21d02006-08-08 17:24:08 -07002418void
2419usb_hcd_platform_shutdown(struct platform_device* dev)
2420{
2421 struct usb_hcd *hcd = platform_get_drvdata(dev);
2422
2423 if (hcd->driver->shutdown)
2424 hcd->driver->shutdown(hcd);
2425}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06002426EXPORT_SYMBOL_GPL(usb_hcd_platform_shutdown);
Aleksey Gorelov64a21d02006-08-08 17:24:08 -07002427
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428/*-------------------------------------------------------------------------*/
2429
Pete Zaitcevf150fa12008-11-13 21:31:21 -07002430#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431
2432struct usb_mon_operations *mon_ops;
2433
2434/*
2435 * The registration is unlocked.
2436 * We do it this way because we do not want to lock in hot paths.
2437 *
2438 * Notice that the code is minimally error-proof. Because usbmon needs
2439 * symbols from usbcore, usbcore gets referenced and cannot be unloaded first.
2440 */
2441
2442int usb_mon_register (struct usb_mon_operations *ops)
2443{
2444
2445 if (mon_ops)
2446 return -EBUSY;
2447
2448 mon_ops = ops;
2449 mb();
2450 return 0;
2451}
2452EXPORT_SYMBOL_GPL (usb_mon_register);
2453
2454void usb_mon_deregister (void)
2455{
2456
2457 if (mon_ops == NULL) {
2458 printk(KERN_ERR "USB: monitor was not registered\n");
2459 return;
2460 }
2461 mon_ops = NULL;
2462 mb();
2463}
2464EXPORT_SYMBOL_GPL (usb_mon_deregister);
2465
Pete Zaitcevf150fa12008-11-13 21:31:21 -07002466#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */