Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
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 | ||
1da177e4 LT |
25 | #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> | |
33 | #include <asm/scatterlist.h> | |
34 | #include <linux/device.h> | |
35 | #include <linux/dma-mapping.h> | |
4186ecf8 | 36 | #include <linux/mutex.h> |
1da177e4 LT |
37 | #include <asm/irq.h> |
38 | #include <asm/byteorder.h> | |
64a21d02 | 39 | #include <linux/platform_device.h> |
1da177e4 LT |
40 | |
41 | #include <linux/usb.h> | |
42 | ||
43 | #include "usb.h" | |
44 | #include "hcd.h" | |
45 | #include "hub.h" | |
46 | ||
47 | ||
48 | // #define USB_BANDWIDTH_MESSAGES | |
49 | ||
50 | /*-------------------------------------------------------------------------*/ | |
51 | ||
52 | /* | |
53 | * USB Host Controller Driver framework | |
54 | * | |
55 | * Plugs into usbcore (usb_bus) and lets HCDs share code, minimizing | |
56 | * HCD-specific behaviors/bugs. | |
57 | * | |
58 | * This does error checks, tracks devices and urbs, and delegates to a | |
59 | * "hc_driver" only for code (and data) that really needs to know about | |
60 | * hardware differences. That includes root hub registers, i/o queues, | |
61 | * and so on ... but as little else as possible. | |
62 | * | |
63 | * Shared code includes most of the "root hub" code (these are emulated, | |
64 | * though each HC's hardware works differently) and PCI glue, plus request | |
65 | * tracking overhead. The HCD code should only block on spinlocks or on | |
66 | * hardware handshaking; blocking on software events (such as other kernel | |
67 | * threads releasing resources, or completing actions) is all generic. | |
68 | * | |
69 | * Happens the USB 2.0 spec says this would be invisible inside the "USBD", | |
70 | * and includes mostly a "HCDI" (HCD Interface) along with some APIs used | |
71 | * only by the hub driver ... and that neither should be seen or used by | |
72 | * usb client device drivers. | |
73 | * | |
74 | * Contributors of ideas or unattributed patches include: David Brownell, | |
75 | * Roman Weissgaerber, Rory Bolt, Greg Kroah-Hartman, ... | |
76 | * | |
77 | * HISTORY: | |
78 | * 2002-02-21 Pull in most of the usb_bus support from usb.c; some | |
79 | * associated cleanup. "usb_hcd" still != "usb_bus". | |
80 | * 2001-12-12 Initial patch version for Linux 2.5.1 kernel. | |
81 | */ | |
82 | ||
83 | /*-------------------------------------------------------------------------*/ | |
84 | ||
85 | /* host controllers we manage */ | |
86 | LIST_HEAD (usb_bus_list); | |
87 | EXPORT_SYMBOL_GPL (usb_bus_list); | |
88 | ||
89 | /* used when allocating bus numbers */ | |
90 | #define USB_MAXBUS 64 | |
91 | struct usb_busmap { | |
92 | unsigned long busmap [USB_MAXBUS / (8*sizeof (unsigned long))]; | |
93 | }; | |
94 | static struct usb_busmap busmap; | |
95 | ||
96 | /* used when updating list of hcds */ | |
4186ecf8 | 97 | DEFINE_MUTEX(usb_bus_list_lock); /* exported only for usbfs */ |
1da177e4 LT |
98 | EXPORT_SYMBOL_GPL (usb_bus_list_lock); |
99 | ||
100 | /* used for controlling access to virtual root hubs */ | |
101 | static DEFINE_SPINLOCK(hcd_root_hub_lock); | |
102 | ||
103 | /* used when updating hcd data */ | |
104 | static DEFINE_SPINLOCK(hcd_data_lock); | |
105 | ||
106 | /* wait queue for synchronous unlinks */ | |
107 | DECLARE_WAIT_QUEUE_HEAD(usb_kill_urb_queue); | |
108 | ||
109 | /*-------------------------------------------------------------------------*/ | |
110 | ||
111 | /* | |
112 | * Sharable chunks of root hub code. | |
113 | */ | |
114 | ||
115 | /*-------------------------------------------------------------------------*/ | |
116 | ||
117 | #define KERNEL_REL ((LINUX_VERSION_CODE >> 16) & 0x0ff) | |
118 | #define KERNEL_VER ((LINUX_VERSION_CODE >> 8) & 0x0ff) | |
119 | ||
120 | /* usb 2.0 root hub device descriptor */ | |
121 | static const u8 usb2_rh_dev_descriptor [18] = { | |
122 | 0x12, /* __u8 bLength; */ | |
123 | 0x01, /* __u8 bDescriptorType; Device */ | |
124 | 0x00, 0x02, /* __le16 bcdUSB; v2.0 */ | |
125 | ||
126 | 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */ | |
127 | 0x00, /* __u8 bDeviceSubClass; */ | |
128 | 0x01, /* __u8 bDeviceProtocol; [ usb 2.0 single TT ]*/ | |
16f16d11 | 129 | 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */ |
1da177e4 LT |
130 | |
131 | 0x00, 0x00, /* __le16 idVendor; */ | |
132 | 0x00, 0x00, /* __le16 idProduct; */ | |
133 | KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */ | |
134 | ||
135 | 0x03, /* __u8 iManufacturer; */ | |
136 | 0x02, /* __u8 iProduct; */ | |
137 | 0x01, /* __u8 iSerialNumber; */ | |
138 | 0x01 /* __u8 bNumConfigurations; */ | |
139 | }; | |
140 | ||
141 | /* no usb 2.0 root hub "device qualifier" descriptor: one speed only */ | |
142 | ||
143 | /* usb 1.1 root hub device descriptor */ | |
144 | static const u8 usb11_rh_dev_descriptor [18] = { | |
145 | 0x12, /* __u8 bLength; */ | |
146 | 0x01, /* __u8 bDescriptorType; Device */ | |
147 | 0x10, 0x01, /* __le16 bcdUSB; v1.1 */ | |
148 | ||
149 | 0x09, /* __u8 bDeviceClass; HUB_CLASSCODE */ | |
150 | 0x00, /* __u8 bDeviceSubClass; */ | |
151 | 0x00, /* __u8 bDeviceProtocol; [ low/full speeds only ] */ | |
16f16d11 | 152 | 0x40, /* __u8 bMaxPacketSize0; 64 Bytes */ |
1da177e4 LT |
153 | |
154 | 0x00, 0x00, /* __le16 idVendor; */ | |
155 | 0x00, 0x00, /* __le16 idProduct; */ | |
156 | KERNEL_VER, KERNEL_REL, /* __le16 bcdDevice */ | |
157 | ||
158 | 0x03, /* __u8 iManufacturer; */ | |
159 | 0x02, /* __u8 iProduct; */ | |
160 | 0x01, /* __u8 iSerialNumber; */ | |
161 | 0x01 /* __u8 bNumConfigurations; */ | |
162 | }; | |
163 | ||
164 | ||
165 | /*-------------------------------------------------------------------------*/ | |
166 | ||
167 | /* Configuration descriptors for our root hubs */ | |
168 | ||
169 | static const u8 fs_rh_config_descriptor [] = { | |
170 | ||
171 | /* one configuration */ | |
172 | 0x09, /* __u8 bLength; */ | |
173 | 0x02, /* __u8 bDescriptorType; Configuration */ | |
174 | 0x19, 0x00, /* __le16 wTotalLength; */ | |
175 | 0x01, /* __u8 bNumInterfaces; (1) */ | |
176 | 0x01, /* __u8 bConfigurationValue; */ | |
177 | 0x00, /* __u8 iConfiguration; */ | |
178 | 0xc0, /* __u8 bmAttributes; | |
179 | Bit 7: must be set, | |
180 | 6: Self-powered, | |
181 | 5: Remote wakeup, | |
182 | 4..0: resvd */ | |
183 | 0x00, /* __u8 MaxPower; */ | |
184 | ||
185 | /* USB 1.1: | |
186 | * USB 2.0, single TT organization (mandatory): | |
187 | * one interface, protocol 0 | |
188 | * | |
189 | * USB 2.0, multiple TT organization (optional): | |
190 | * two interfaces, protocols 1 (like single TT) | |
191 | * and 2 (multiple TT mode) ... config is | |
192 | * sometimes settable | |
193 | * NOT IMPLEMENTED | |
194 | */ | |
195 | ||
196 | /* one interface */ | |
197 | 0x09, /* __u8 if_bLength; */ | |
198 | 0x04, /* __u8 if_bDescriptorType; Interface */ | |
199 | 0x00, /* __u8 if_bInterfaceNumber; */ | |
200 | 0x00, /* __u8 if_bAlternateSetting; */ | |
201 | 0x01, /* __u8 if_bNumEndpoints; */ | |
202 | 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */ | |
203 | 0x00, /* __u8 if_bInterfaceSubClass; */ | |
204 | 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */ | |
205 | 0x00, /* __u8 if_iInterface; */ | |
206 | ||
207 | /* one endpoint (status change endpoint) */ | |
208 | 0x07, /* __u8 ep_bLength; */ | |
209 | 0x05, /* __u8 ep_bDescriptorType; Endpoint */ | |
210 | 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */ | |
211 | 0x03, /* __u8 ep_bmAttributes; Interrupt */ | |
212 | 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */ | |
213 | 0xff /* __u8 ep_bInterval; (255ms -- usb 2.0 spec) */ | |
214 | }; | |
215 | ||
216 | static const u8 hs_rh_config_descriptor [] = { | |
217 | ||
218 | /* one configuration */ | |
219 | 0x09, /* __u8 bLength; */ | |
220 | 0x02, /* __u8 bDescriptorType; Configuration */ | |
221 | 0x19, 0x00, /* __le16 wTotalLength; */ | |
222 | 0x01, /* __u8 bNumInterfaces; (1) */ | |
223 | 0x01, /* __u8 bConfigurationValue; */ | |
224 | 0x00, /* __u8 iConfiguration; */ | |
225 | 0xc0, /* __u8 bmAttributes; | |
226 | Bit 7: must be set, | |
227 | 6: Self-powered, | |
228 | 5: Remote wakeup, | |
229 | 4..0: resvd */ | |
230 | 0x00, /* __u8 MaxPower; */ | |
231 | ||
232 | /* USB 1.1: | |
233 | * USB 2.0, single TT organization (mandatory): | |
234 | * one interface, protocol 0 | |
235 | * | |
236 | * USB 2.0, multiple TT organization (optional): | |
237 | * two interfaces, protocols 1 (like single TT) | |
238 | * and 2 (multiple TT mode) ... config is | |
239 | * sometimes settable | |
240 | * NOT IMPLEMENTED | |
241 | */ | |
242 | ||
243 | /* one interface */ | |
244 | 0x09, /* __u8 if_bLength; */ | |
245 | 0x04, /* __u8 if_bDescriptorType; Interface */ | |
246 | 0x00, /* __u8 if_bInterfaceNumber; */ | |
247 | 0x00, /* __u8 if_bAlternateSetting; */ | |
248 | 0x01, /* __u8 if_bNumEndpoints; */ | |
249 | 0x09, /* __u8 if_bInterfaceClass; HUB_CLASSCODE */ | |
250 | 0x00, /* __u8 if_bInterfaceSubClass; */ | |
251 | 0x00, /* __u8 if_bInterfaceProtocol; [usb1.1 or single tt] */ | |
252 | 0x00, /* __u8 if_iInterface; */ | |
253 | ||
254 | /* one endpoint (status change endpoint) */ | |
255 | 0x07, /* __u8 ep_bLength; */ | |
256 | 0x05, /* __u8 ep_bDescriptorType; Endpoint */ | |
257 | 0x81, /* __u8 ep_bEndpointAddress; IN Endpoint 1 */ | |
258 | 0x03, /* __u8 ep_bmAttributes; Interrupt */ | |
259 | 0x02, 0x00, /* __le16 ep_wMaxPacketSize; 1 + (MAX_ROOT_PORTS / 8) */ | |
260 | 0x0c /* __u8 ep_bInterval; (256ms -- usb 2.0 spec) */ | |
261 | }; | |
262 | ||
263 | /*-------------------------------------------------------------------------*/ | |
264 | ||
265 | /* | |
266 | * helper routine for returning string descriptors in UTF-16LE | |
267 | * input can actually be ISO-8859-1; ASCII is its 7-bit subset | |
268 | */ | |
269 | static int ascii2utf (char *s, u8 *utf, int utfmax) | |
270 | { | |
271 | int retval; | |
272 | ||
273 | for (retval = 0; *s && utfmax > 1; utfmax -= 2, retval += 2) { | |
274 | *utf++ = *s++; | |
275 | *utf++ = 0; | |
276 | } | |
277 | if (utfmax > 0) { | |
278 | *utf = *s; | |
279 | ++retval; | |
280 | } | |
281 | return retval; | |
282 | } | |
283 | ||
284 | /* | |
285 | * rh_string - provides manufacturer, product and serial strings for root hub | |
286 | * @id: the string ID number (1: serial number, 2: product, 3: vendor) | |
287 | * @hcd: the host controller for this root hub | |
288 | * @type: string describing our driver | |
289 | * @data: return packet in UTF-16 LE | |
290 | * @len: length of the return packet | |
291 | * | |
292 | * Produces either a manufacturer, product or serial number string for the | |
293 | * virtual root hub device. | |
294 | */ | |
295 | static int rh_string ( | |
296 | int id, | |
297 | struct usb_hcd *hcd, | |
298 | u8 *data, | |
299 | int len | |
300 | ) { | |
301 | char buf [100]; | |
302 | ||
303 | // language ids | |
304 | if (id == 0) { | |
305 | buf[0] = 4; buf[1] = 3; /* 4 bytes string data */ | |
306 | buf[2] = 0x09; buf[3] = 0x04; /* MSFT-speak for "en-us" */ | |
307 | len = min (len, 4); | |
308 | memcpy (data, buf, len); | |
309 | return len; | |
310 | ||
311 | // serial number | |
312 | } else if (id == 1) { | |
313 | strlcpy (buf, hcd->self.bus_name, sizeof buf); | |
314 | ||
315 | // product description | |
316 | } else if (id == 2) { | |
317 | strlcpy (buf, hcd->product_desc, sizeof buf); | |
318 | ||
319 | // id 3 == vendor description | |
320 | } else if (id == 3) { | |
321 | snprintf (buf, sizeof buf, "%s %s %s", system_utsname.sysname, | |
322 | system_utsname.release, hcd->driver->description); | |
323 | ||
324 | // unsupported IDs --> "protocol stall" | |
325 | } else | |
326 | return -EPIPE; | |
327 | ||
328 | switch (len) { /* All cases fall through */ | |
329 | default: | |
330 | len = 2 + ascii2utf (buf, data + 2, len - 2); | |
331 | case 2: | |
332 | data [1] = 3; /* type == string */ | |
333 | case 1: | |
334 | data [0] = 2 * (strlen (buf) + 1); | |
335 | case 0: | |
336 | ; /* Compiler wants a statement here */ | |
337 | } | |
338 | return len; | |
339 | } | |
340 | ||
341 | ||
342 | /* Root hub control transfers execute synchronously */ | |
343 | static int rh_call_control (struct usb_hcd *hcd, struct urb *urb) | |
344 | { | |
345 | struct usb_ctrlrequest *cmd; | |
346 | u16 typeReq, wValue, wIndex, wLength; | |
347 | u8 *ubuf = urb->transfer_buffer; | |
348 | u8 tbuf [sizeof (struct usb_hub_descriptor)]; | |
349 | const u8 *bufp = tbuf; | |
350 | int len = 0; | |
351 | int patch_wakeup = 0; | |
352 | unsigned long flags; | |
353 | int status = 0; | |
354 | int n; | |
355 | ||
356 | cmd = (struct usb_ctrlrequest *) urb->setup_packet; | |
357 | typeReq = (cmd->bRequestType << 8) | cmd->bRequest; | |
358 | wValue = le16_to_cpu (cmd->wValue); | |
359 | wIndex = le16_to_cpu (cmd->wIndex); | |
360 | wLength = le16_to_cpu (cmd->wLength); | |
361 | ||
362 | if (wLength > urb->transfer_buffer_length) | |
363 | goto error; | |
364 | ||
365 | urb->actual_length = 0; | |
366 | switch (typeReq) { | |
367 | ||
368 | /* DEVICE REQUESTS */ | |
369 | ||
fb669cc0 DB |
370 | /* The root hub's remote wakeup enable bit is implemented using |
371 | * driver model wakeup flags. If this system supports wakeup | |
372 | * through USB, userspace may change the default "allow wakeup" | |
373 | * policy through sysfs or these calls. | |
374 | * | |
375 | * Most root hubs support wakeup from downstream devices, for | |
376 | * runtime power management (disabling USB clocks and reducing | |
377 | * VBUS power usage). However, not all of them do so; silicon, | |
378 | * board, and BIOS bugs here are not uncommon, so these can't | |
379 | * be treated quite like external hubs. | |
380 | * | |
381 | * Likewise, not all root hubs will pass wakeup events upstream, | |
382 | * to wake up the whole system. So don't assume root hub and | |
383 | * controller capabilities are identical. | |
384 | */ | |
385 | ||
1da177e4 | 386 | case DeviceRequest | USB_REQ_GET_STATUS: |
fb669cc0 DB |
387 | tbuf [0] = (device_may_wakeup(&hcd->self.root_hub->dev) |
388 | << USB_DEVICE_REMOTE_WAKEUP) | |
1da177e4 LT |
389 | | (1 << USB_DEVICE_SELF_POWERED); |
390 | tbuf [1] = 0; | |
391 | len = 2; | |
392 | break; | |
393 | case DeviceOutRequest | USB_REQ_CLEAR_FEATURE: | |
394 | if (wValue == USB_DEVICE_REMOTE_WAKEUP) | |
fb669cc0 | 395 | device_set_wakeup_enable(&hcd->self.root_hub->dev, 0); |
1da177e4 LT |
396 | else |
397 | goto error; | |
398 | break; | |
399 | case DeviceOutRequest | USB_REQ_SET_FEATURE: | |
fb669cc0 DB |
400 | if (device_can_wakeup(&hcd->self.root_hub->dev) |
401 | && wValue == USB_DEVICE_REMOTE_WAKEUP) | |
402 | device_set_wakeup_enable(&hcd->self.root_hub->dev, 1); | |
1da177e4 LT |
403 | else |
404 | goto error; | |
405 | break; | |
406 | case DeviceRequest | USB_REQ_GET_CONFIGURATION: | |
407 | tbuf [0] = 1; | |
408 | len = 1; | |
409 | /* FALLTHROUGH */ | |
410 | case DeviceOutRequest | USB_REQ_SET_CONFIGURATION: | |
411 | break; | |
412 | case DeviceRequest | USB_REQ_GET_DESCRIPTOR: | |
413 | switch (wValue & 0xff00) { | |
414 | case USB_DT_DEVICE << 8: | |
415 | if (hcd->driver->flags & HCD_USB2) | |
416 | bufp = usb2_rh_dev_descriptor; | |
417 | else if (hcd->driver->flags & HCD_USB11) | |
418 | bufp = usb11_rh_dev_descriptor; | |
419 | else | |
420 | goto error; | |
421 | len = 18; | |
422 | break; | |
423 | case USB_DT_CONFIG << 8: | |
424 | if (hcd->driver->flags & HCD_USB2) { | |
425 | bufp = hs_rh_config_descriptor; | |
426 | len = sizeof hs_rh_config_descriptor; | |
427 | } else { | |
428 | bufp = fs_rh_config_descriptor; | |
429 | len = sizeof fs_rh_config_descriptor; | |
430 | } | |
fb669cc0 | 431 | if (device_can_wakeup(&hcd->self.root_hub->dev)) |
1da177e4 LT |
432 | patch_wakeup = 1; |
433 | break; | |
434 | case USB_DT_STRING << 8: | |
435 | n = rh_string (wValue & 0xff, hcd, ubuf, wLength); | |
436 | if (n < 0) | |
437 | goto error; | |
438 | urb->actual_length = n; | |
439 | break; | |
440 | default: | |
441 | goto error; | |
442 | } | |
443 | break; | |
444 | case DeviceRequest | USB_REQ_GET_INTERFACE: | |
445 | tbuf [0] = 0; | |
446 | len = 1; | |
447 | /* FALLTHROUGH */ | |
448 | case DeviceOutRequest | USB_REQ_SET_INTERFACE: | |
449 | break; | |
450 | case DeviceOutRequest | USB_REQ_SET_ADDRESS: | |
451 | // wValue == urb->dev->devaddr | |
452 | dev_dbg (hcd->self.controller, "root hub device address %d\n", | |
453 | wValue); | |
454 | break; | |
455 | ||
456 | /* INTERFACE REQUESTS (no defined feature/status flags) */ | |
457 | ||
458 | /* ENDPOINT REQUESTS */ | |
459 | ||
460 | case EndpointRequest | USB_REQ_GET_STATUS: | |
461 | // ENDPOINT_HALT flag | |
462 | tbuf [0] = 0; | |
463 | tbuf [1] = 0; | |
464 | len = 2; | |
465 | /* FALLTHROUGH */ | |
466 | case EndpointOutRequest | USB_REQ_CLEAR_FEATURE: | |
467 | case EndpointOutRequest | USB_REQ_SET_FEATURE: | |
468 | dev_dbg (hcd->self.controller, "no endpoint features yet\n"); | |
469 | break; | |
470 | ||
471 | /* CLASS REQUESTS (and errors) */ | |
472 | ||
473 | default: | |
474 | /* non-generic request */ | |
b13296c6 DB |
475 | switch (typeReq) { |
476 | case GetHubStatus: | |
477 | case GetPortStatus: | |
478 | len = 4; | |
479 | break; | |
480 | case GetHubDescriptor: | |
481 | len = sizeof (struct usb_hub_descriptor); | |
482 | break; | |
1da177e4 | 483 | } |
b13296c6 DB |
484 | status = hcd->driver->hub_control (hcd, |
485 | typeReq, wValue, wIndex, | |
486 | tbuf, wLength); | |
1da177e4 LT |
487 | break; |
488 | error: | |
489 | /* "protocol stall" on error */ | |
490 | status = -EPIPE; | |
491 | } | |
492 | ||
493 | if (status) { | |
494 | len = 0; | |
495 | if (status != -EPIPE) { | |
496 | dev_dbg (hcd->self.controller, | |
497 | "CTRL: TypeReq=0x%x val=0x%x " | |
498 | "idx=0x%x len=%d ==> %d\n", | |
499 | typeReq, wValue, wIndex, | |
b13296c6 | 500 | wLength, status); |
1da177e4 LT |
501 | } |
502 | } | |
503 | if (len) { | |
504 | if (urb->transfer_buffer_length < len) | |
505 | len = urb->transfer_buffer_length; | |
506 | urb->actual_length = len; | |
507 | // always USB_DIR_IN, toward host | |
508 | memcpy (ubuf, bufp, len); | |
509 | ||
510 | /* report whether RH hardware supports remote wakeup */ | |
511 | if (patch_wakeup && | |
512 | len > offsetof (struct usb_config_descriptor, | |
513 | bmAttributes)) | |
514 | ((struct usb_config_descriptor *)ubuf)->bmAttributes | |
515 | |= USB_CONFIG_ATT_WAKEUP; | |
516 | } | |
517 | ||
518 | /* any errors get returned through the urb completion */ | |
519 | local_irq_save (flags); | |
520 | spin_lock (&urb->lock); | |
521 | if (urb->status == -EINPROGRESS) | |
522 | urb->status = status; | |
523 | spin_unlock (&urb->lock); | |
524 | usb_hcd_giveback_urb (hcd, urb, NULL); | |
525 | local_irq_restore (flags); | |
526 | return 0; | |
527 | } | |
528 | ||
529 | /*-------------------------------------------------------------------------*/ | |
530 | ||
531 | /* | |
d5926ae7 AS |
532 | * Root Hub interrupt transfers are polled using a timer if the |
533 | * driver requests it; otherwise the driver is responsible for | |
534 | * calling usb_hcd_poll_rh_status() when an event occurs. | |
1da177e4 | 535 | * |
d5926ae7 AS |
536 | * Completions are called in_interrupt(), but they may or may not |
537 | * be in_irq(). | |
1da177e4 | 538 | */ |
d5926ae7 AS |
539 | void usb_hcd_poll_rh_status(struct usb_hcd *hcd) |
540 | { | |
541 | struct urb *urb; | |
542 | int length; | |
543 | unsigned long flags; | |
544 | char buffer[4]; /* Any root hubs with > 31 ports? */ | |
1da177e4 | 545 | |
d5926ae7 AS |
546 | if (!hcd->uses_new_polling && !hcd->status_urb) |
547 | return; | |
1da177e4 | 548 | |
d5926ae7 AS |
549 | length = hcd->driver->hub_status_data(hcd, buffer); |
550 | if (length > 0) { | |
1da177e4 | 551 | |
d5926ae7 AS |
552 | /* try to complete the status urb */ |
553 | local_irq_save (flags); | |
554 | spin_lock(&hcd_root_hub_lock); | |
555 | urb = hcd->status_urb; | |
556 | if (urb) { | |
557 | spin_lock(&urb->lock); | |
558 | if (urb->status == -EINPROGRESS) { | |
559 | hcd->poll_pending = 0; | |
560 | hcd->status_urb = NULL; | |
561 | urb->status = 0; | |
562 | urb->hcpriv = NULL; | |
563 | urb->actual_length = length; | |
564 | memcpy(urb->transfer_buffer, buffer, length); | |
565 | } else /* urb has been unlinked */ | |
566 | length = 0; | |
567 | spin_unlock(&urb->lock); | |
568 | } else | |
569 | length = 0; | |
570 | spin_unlock(&hcd_root_hub_lock); | |
571 | ||
572 | /* local irqs are always blocked in completions */ | |
573 | if (length > 0) | |
574 | usb_hcd_giveback_urb (hcd, urb, NULL); | |
575 | else | |
576 | hcd->poll_pending = 1; | |
577 | local_irq_restore (flags); | |
1da177e4 LT |
578 | } |
579 | ||
d5926ae7 AS |
580 | /* The USB 2.0 spec says 256 ms. This is close enough and won't |
581 | * exceed that limit if HZ is 100. */ | |
582 | if (hcd->uses_new_polling ? hcd->poll_rh : | |
583 | (length == 0 && hcd->status_urb != NULL)) | |
584 | mod_timer (&hcd->rh_timer, jiffies + msecs_to_jiffies(250)); | |
1da177e4 | 585 | } |
d5926ae7 | 586 | EXPORT_SYMBOL_GPL(usb_hcd_poll_rh_status); |
1da177e4 LT |
587 | |
588 | /* timer callback */ | |
d5926ae7 AS |
589 | static void rh_timer_func (unsigned long _hcd) |
590 | { | |
591 | usb_hcd_poll_rh_status((struct usb_hcd *) _hcd); | |
592 | } | |
593 | ||
594 | /*-------------------------------------------------------------------------*/ | |
1da177e4 | 595 | |
d5926ae7 | 596 | static int rh_queue_status (struct usb_hcd *hcd, struct urb *urb) |
1da177e4 | 597 | { |
d5926ae7 | 598 | int retval; |
1da177e4 | 599 | unsigned long flags; |
d5926ae7 | 600 | int len = 1 + (urb->dev->maxchild / 8); |
1da177e4 | 601 | |
d5926ae7 AS |
602 | spin_lock_irqsave (&hcd_root_hub_lock, flags); |
603 | if (urb->status != -EINPROGRESS) /* already unlinked */ | |
604 | retval = urb->status; | |
605 | else if (hcd->status_urb || urb->transfer_buffer_length < len) { | |
606 | dev_dbg (hcd->self.controller, "not queuing rh status urb\n"); | |
607 | retval = -EINVAL; | |
608 | } else { | |
609 | hcd->status_urb = urb; | |
610 | urb->hcpriv = hcd; /* indicate it's queued */ | |
1da177e4 | 611 | |
d5926ae7 AS |
612 | if (!hcd->uses_new_polling) |
613 | mod_timer (&hcd->rh_timer, jiffies + | |
614 | msecs_to_jiffies(250)); | |
1da177e4 | 615 | |
d5926ae7 AS |
616 | /* If a status change has already occurred, report it ASAP */ |
617 | else if (hcd->poll_pending) | |
618 | mod_timer (&hcd->rh_timer, jiffies); | |
619 | retval = 0; | |
1da177e4 | 620 | } |
d5926ae7 AS |
621 | spin_unlock_irqrestore (&hcd_root_hub_lock, flags); |
622 | return retval; | |
1da177e4 LT |
623 | } |
624 | ||
1da177e4 LT |
625 | static int rh_urb_enqueue (struct usb_hcd *hcd, struct urb *urb) |
626 | { | |
d5926ae7 AS |
627 | if (usb_pipeint (urb->pipe)) |
628 | return rh_queue_status (hcd, urb); | |
1da177e4 LT |
629 | if (usb_pipecontrol (urb->pipe)) |
630 | return rh_call_control (hcd, urb); | |
d5926ae7 | 631 | return -EINVAL; |
1da177e4 LT |
632 | } |
633 | ||
634 | /*-------------------------------------------------------------------------*/ | |
635 | ||
455b25fb AS |
636 | /* Unlinks of root-hub control URBs are legal, but they don't do anything |
637 | * since these URBs always execute synchronously. | |
d5926ae7 | 638 | */ |
1da177e4 LT |
639 | static int usb_rh_urb_dequeue (struct usb_hcd *hcd, struct urb *urb) |
640 | { | |
455b25fb | 641 | unsigned long flags; |
1da177e4 | 642 | |
455b25fb AS |
643 | if (usb_pipeendpoint(urb->pipe) == 0) { /* Control URB */ |
644 | ; /* Do nothing */ | |
d5926ae7 AS |
645 | |
646 | } else { /* Status URB */ | |
647 | if (!hcd->uses_new_polling) | |
455b25fb AS |
648 | del_timer (&hcd->rh_timer); |
649 | local_irq_save (flags); | |
d5926ae7 AS |
650 | spin_lock (&hcd_root_hub_lock); |
651 | if (urb == hcd->status_urb) { | |
652 | hcd->status_urb = NULL; | |
653 | urb->hcpriv = NULL; | |
654 | } else | |
655 | urb = NULL; /* wasn't fully queued */ | |
656 | spin_unlock (&hcd_root_hub_lock); | |
657 | if (urb) | |
658 | usb_hcd_giveback_urb (hcd, urb, NULL); | |
455b25fb | 659 | local_irq_restore (flags); |
d5926ae7 | 660 | } |
1da177e4 LT |
661 | |
662 | return 0; | |
663 | } | |
664 | ||
665 | /*-------------------------------------------------------------------------*/ | |
666 | ||
667 | /* exported only within usbcore */ | |
8561b10f | 668 | struct usb_bus *usb_bus_get(struct usb_bus *bus) |
1da177e4 | 669 | { |
8561b10f GKH |
670 | if (bus) |
671 | kref_get(&bus->kref); | |
672 | return bus; | |
673 | } | |
1da177e4 | 674 | |
8561b10f GKH |
675 | static void usb_host_release(struct kref *kref) |
676 | { | |
677 | struct usb_bus *bus = container_of(kref, struct usb_bus, kref); | |
1da177e4 | 678 | |
8561b10f GKH |
679 | if (bus->release) |
680 | bus->release(bus); | |
1da177e4 LT |
681 | } |
682 | ||
683 | /* exported only within usbcore */ | |
8561b10f | 684 | void usb_bus_put(struct usb_bus *bus) |
1da177e4 LT |
685 | { |
686 | if (bus) | |
8561b10f | 687 | kref_put(&bus->kref, usb_host_release); |
1da177e4 LT |
688 | } |
689 | ||
690 | /*-------------------------------------------------------------------------*/ | |
691 | ||
8561b10f | 692 | static struct class *usb_host_class; |
1da177e4 LT |
693 | |
694 | int usb_host_init(void) | |
695 | { | |
8561b10f GKH |
696 | int retval = 0; |
697 | ||
698 | usb_host_class = class_create(THIS_MODULE, "usb_host"); | |
699 | if (IS_ERR(usb_host_class)) | |
700 | retval = PTR_ERR(usb_host_class); | |
701 | return retval; | |
1da177e4 LT |
702 | } |
703 | ||
704 | void usb_host_cleanup(void) | |
705 | { | |
8561b10f | 706 | class_destroy(usb_host_class); |
1da177e4 LT |
707 | } |
708 | ||
709 | /** | |
710 | * usb_bus_init - shared initialization code | |
711 | * @bus: the bus structure being initialized | |
712 | * | |
713 | * This code is used to initialize a usb_bus structure, memory for which is | |
714 | * separately managed. | |
715 | */ | |
716 | static void usb_bus_init (struct usb_bus *bus) | |
717 | { | |
718 | memset (&bus->devmap, 0, sizeof(struct usb_devmap)); | |
719 | ||
720 | bus->devnum_next = 1; | |
721 | ||
722 | bus->root_hub = NULL; | |
723 | bus->hcpriv = NULL; | |
724 | bus->busnum = -1; | |
725 | bus->bandwidth_allocated = 0; | |
726 | bus->bandwidth_int_reqs = 0; | |
727 | bus->bandwidth_isoc_reqs = 0; | |
728 | ||
729 | INIT_LIST_HEAD (&bus->bus_list); | |
730 | ||
8561b10f | 731 | kref_init(&bus->kref); |
1da177e4 LT |
732 | } |
733 | ||
1da177e4 LT |
734 | /*-------------------------------------------------------------------------*/ |
735 | ||
736 | /** | |
737 | * usb_register_bus - registers the USB host controller with the usb core | |
738 | * @bus: pointer to the bus to register | |
739 | * Context: !in_interrupt() | |
740 | * | |
741 | * Assigns a bus number, and links the controller into usbcore data | |
742 | * structures so that it can be seen by scanning the bus list. | |
743 | */ | |
744 | static int usb_register_bus(struct usb_bus *bus) | |
745 | { | |
746 | int busnum; | |
1da177e4 | 747 | |
4186ecf8 | 748 | mutex_lock(&usb_bus_list_lock); |
1da177e4 LT |
749 | busnum = find_next_zero_bit (busmap.busmap, USB_MAXBUS, 1); |
750 | if (busnum < USB_MAXBUS) { | |
751 | set_bit (busnum, busmap.busmap); | |
752 | bus->busnum = busnum; | |
753 | } else { | |
754 | printk (KERN_ERR "%s: too many buses\n", usbcore_name); | |
4186ecf8 | 755 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 LT |
756 | return -E2BIG; |
757 | } | |
758 | ||
53f46542 GKH |
759 | bus->class_dev = class_device_create(usb_host_class, NULL, MKDEV(0,0), |
760 | bus->controller, "usb_host%d", busnum); | |
8561b10f | 761 | if (IS_ERR(bus->class_dev)) { |
1da177e4 | 762 | clear_bit(busnum, busmap.busmap); |
4186ecf8 | 763 | mutex_unlock(&usb_bus_list_lock); |
8561b10f | 764 | return PTR_ERR(bus->class_dev); |
1da177e4 LT |
765 | } |
766 | ||
8561b10f GKH |
767 | class_set_devdata(bus->class_dev, bus); |
768 | ||
1da177e4 LT |
769 | /* Add it to the local list of buses */ |
770 | list_add (&bus->bus_list, &usb_bus_list); | |
4186ecf8 | 771 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 | 772 | |
3099e75a | 773 | usb_notify_add_bus(bus); |
1da177e4 LT |
774 | |
775 | dev_info (bus->controller, "new USB bus registered, assigned bus number %d\n", bus->busnum); | |
776 | return 0; | |
777 | } | |
778 | ||
779 | /** | |
780 | * usb_deregister_bus - deregisters the USB host controller | |
781 | * @bus: pointer to the bus to deregister | |
782 | * Context: !in_interrupt() | |
783 | * | |
784 | * Recycles the bus number, and unlinks the controller from usbcore data | |
785 | * structures so that it won't be seen by scanning the bus list. | |
786 | */ | |
787 | static void usb_deregister_bus (struct usb_bus *bus) | |
788 | { | |
789 | dev_info (bus->controller, "USB bus %d deregistered\n", bus->busnum); | |
790 | ||
791 | /* | |
792 | * NOTE: make sure that all the devices are removed by the | |
793 | * controller code, as well as having it call this when cleaning | |
794 | * itself up | |
795 | */ | |
4186ecf8 | 796 | mutex_lock(&usb_bus_list_lock); |
1da177e4 | 797 | list_del (&bus->bus_list); |
4186ecf8 | 798 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 | 799 | |
3099e75a | 800 | usb_notify_remove_bus(bus); |
1da177e4 LT |
801 | |
802 | clear_bit (bus->busnum, busmap.busmap); | |
803 | ||
8561b10f | 804 | class_device_unregister(bus->class_dev); |
1da177e4 LT |
805 | } |
806 | ||
807 | /** | |
8ec8d20b | 808 | * register_root_hub - called by usb_add_hcd() to register a root hub |
1da177e4 LT |
809 | * @hcd: host controller for this root hub |
810 | * | |
8ec8d20b | 811 | * This function registers the root hub with the USB subsystem. It sets up |
b1e8f0a6 DB |
812 | * the device properly in the device tree and then calls usb_new_device() |
813 | * to register the usb device. It also assigns the root hub's USB address | |
814 | * (always 1). | |
1da177e4 | 815 | */ |
b1e8f0a6 | 816 | static int register_root_hub(struct usb_hcd *hcd) |
1da177e4 LT |
817 | { |
818 | struct device *parent_dev = hcd->self.controller; | |
b1e8f0a6 | 819 | struct usb_device *usb_dev = hcd->self.root_hub; |
1da177e4 LT |
820 | const int devnum = 1; |
821 | int retval; | |
822 | ||
1da177e4 LT |
823 | usb_dev->devnum = devnum; |
824 | usb_dev->bus->devnum_next = devnum + 1; | |
825 | memset (&usb_dev->bus->devmap.devicemap, 0, | |
826 | sizeof usb_dev->bus->devmap.devicemap); | |
827 | set_bit (devnum, usb_dev->bus->devmap.devicemap); | |
828 | usb_set_device_state(usb_dev, USB_STATE_ADDRESS); | |
829 | ||
4186ecf8 | 830 | mutex_lock(&usb_bus_list_lock); |
1da177e4 LT |
831 | |
832 | usb_dev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64); | |
833 | retval = usb_get_device_descriptor(usb_dev, USB_DT_DEVICE_SIZE); | |
834 | if (retval != sizeof usb_dev->descriptor) { | |
4186ecf8 | 835 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 LT |
836 | dev_dbg (parent_dev, "can't read %s device descriptor %d\n", |
837 | usb_dev->dev.bus_id, retval); | |
838 | return (retval < 0) ? retval : -EMSGSIZE; | |
839 | } | |
840 | ||
1da177e4 | 841 | retval = usb_new_device (usb_dev); |
1da177e4 | 842 | if (retval) { |
1da177e4 LT |
843 | dev_err (parent_dev, "can't register root hub for %s, %d\n", |
844 | usb_dev->dev.bus_id, retval); | |
845 | } | |
4186ecf8 | 846 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 LT |
847 | |
848 | if (retval == 0) { | |
849 | spin_lock_irq (&hcd_root_hub_lock); | |
850 | hcd->rh_registered = 1; | |
851 | spin_unlock_irq (&hcd_root_hub_lock); | |
852 | ||
853 | /* Did the HC die before the root hub was registered? */ | |
854 | if (hcd->state == HC_STATE_HALT) | |
855 | usb_hc_died (hcd); /* This time clean up */ | |
856 | } | |
857 | ||
858 | return retval; | |
859 | } | |
1da177e4 | 860 | |
d5926ae7 AS |
861 | void usb_enable_root_hub_irq (struct usb_bus *bus) |
862 | { | |
863 | struct usb_hcd *hcd; | |
864 | ||
865 | hcd = container_of (bus, struct usb_hcd, self); | |
866 | if (hcd->driver->hub_irq_enable && !hcd->poll_rh && | |
867 | hcd->state != HC_STATE_HALT) | |
868 | hcd->driver->hub_irq_enable (hcd); | |
869 | } | |
870 | ||
1da177e4 LT |
871 | |
872 | /*-------------------------------------------------------------------------*/ | |
873 | ||
874 | /** | |
875 | * usb_calc_bus_time - approximate periodic transaction time in nanoseconds | |
876 | * @speed: from dev->speed; USB_SPEED_{LOW,FULL,HIGH} | |
877 | * @is_input: true iff the transaction sends data to the host | |
878 | * @isoc: true for isochronous transactions, false for interrupt ones | |
879 | * @bytecount: how many bytes in the transaction. | |
880 | * | |
881 | * Returns approximate bus time in nanoseconds for a periodic transaction. | |
882 | * See USB 2.0 spec section 5.11.3; only periodic transfers need to be | |
883 | * scheduled in software, this function is only used for such scheduling. | |
884 | */ | |
885 | long usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount) | |
886 | { | |
887 | unsigned long tmp; | |
888 | ||
889 | switch (speed) { | |
890 | case USB_SPEED_LOW: /* INTR only */ | |
891 | if (is_input) { | |
892 | tmp = (67667L * (31L + 10L * BitTime (bytecount))) / 1000L; | |
893 | return (64060L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp); | |
894 | } else { | |
895 | tmp = (66700L * (31L + 10L * BitTime (bytecount))) / 1000L; | |
896 | return (64107L + (2 * BW_HUB_LS_SETUP) + BW_HOST_DELAY + tmp); | |
897 | } | |
898 | case USB_SPEED_FULL: /* ISOC or INTR */ | |
899 | if (isoc) { | |
900 | tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L; | |
901 | return (((is_input) ? 7268L : 6265L) + BW_HOST_DELAY + tmp); | |
902 | } else { | |
903 | tmp = (8354L * (31L + 10L * BitTime (bytecount))) / 1000L; | |
904 | return (9107L + BW_HOST_DELAY + tmp); | |
905 | } | |
906 | case USB_SPEED_HIGH: /* ISOC or INTR */ | |
907 | // FIXME adjust for input vs output | |
908 | if (isoc) | |
498f78e6 | 909 | tmp = HS_NSECS_ISO (bytecount); |
1da177e4 | 910 | else |
498f78e6 | 911 | tmp = HS_NSECS (bytecount); |
1da177e4 LT |
912 | return tmp; |
913 | default: | |
914 | pr_debug ("%s: bogus device speed!\n", usbcore_name); | |
915 | return -1; | |
916 | } | |
917 | } | |
918 | EXPORT_SYMBOL (usb_calc_bus_time); | |
919 | ||
920 | /* | |
921 | * usb_check_bandwidth(): | |
922 | * | |
923 | * old_alloc is from host_controller->bandwidth_allocated in microseconds; | |
924 | * bustime is from calc_bus_time(), but converted to microseconds. | |
925 | * | |
926 | * returns <bustime in us> if successful, | |
927 | * or -ENOSPC if bandwidth request fails. | |
928 | * | |
929 | * FIXME: | |
930 | * This initial implementation does not use Endpoint.bInterval | |
931 | * in managing bandwidth allocation. | |
932 | * It probably needs to be expanded to use Endpoint.bInterval. | |
933 | * This can be done as a later enhancement (correction). | |
934 | * | |
935 | * This will also probably require some kind of | |
936 | * frame allocation tracking...meaning, for example, | |
937 | * that if multiple drivers request interrupts every 10 USB frames, | |
938 | * they don't all have to be allocated at | |
939 | * frame numbers N, N+10, N+20, etc. Some of them could be at | |
940 | * N+11, N+21, N+31, etc., and others at | |
941 | * N+12, N+22, N+32, etc. | |
942 | * | |
943 | * Similarly for isochronous transfers... | |
944 | * | |
945 | * Individual HCDs can schedule more directly ... this logic | |
946 | * is not correct for high speed transfers. | |
947 | */ | |
948 | int usb_check_bandwidth (struct usb_device *dev, struct urb *urb) | |
949 | { | |
950 | unsigned int pipe = urb->pipe; | |
951 | long bustime; | |
952 | int is_in = usb_pipein (pipe); | |
953 | int is_iso = usb_pipeisoc (pipe); | |
954 | int old_alloc = dev->bus->bandwidth_allocated; | |
955 | int new_alloc; | |
956 | ||
957 | ||
958 | bustime = NS_TO_US (usb_calc_bus_time (dev->speed, is_in, is_iso, | |
959 | usb_maxpacket (dev, pipe, !is_in))); | |
960 | if (is_iso) | |
961 | bustime /= urb->number_of_packets; | |
962 | ||
963 | new_alloc = old_alloc + (int) bustime; | |
964 | if (new_alloc > FRAME_TIME_MAX_USECS_ALLOC) { | |
965 | #ifdef DEBUG | |
966 | char *mode = | |
967 | #ifdef CONFIG_USB_BANDWIDTH | |
968 | ""; | |
969 | #else | |
970 | "would have "; | |
971 | #endif | |
972 | dev_dbg (&dev->dev, "usb_check_bandwidth %sFAILED: %d + %ld = %d usec\n", | |
973 | mode, old_alloc, bustime, new_alloc); | |
974 | #endif | |
975 | #ifdef CONFIG_USB_BANDWIDTH | |
976 | bustime = -ENOSPC; /* report error */ | |
977 | #endif | |
978 | } | |
979 | ||
980 | return bustime; | |
981 | } | |
982 | EXPORT_SYMBOL (usb_check_bandwidth); | |
983 | ||
984 | ||
985 | /** | |
986 | * usb_claim_bandwidth - records bandwidth for a periodic transfer | |
987 | * @dev: source/target of request | |
988 | * @urb: request (urb->dev == dev) | |
989 | * @bustime: bandwidth consumed, in (average) microseconds per frame | |
990 | * @isoc: true iff the request is isochronous | |
991 | * | |
992 | * Bus bandwidth reservations are recorded purely for diagnostic purposes. | |
993 | * HCDs are expected not to overcommit periodic bandwidth, and to record such | |
994 | * reservations whenever endpoints are added to the periodic schedule. | |
995 | * | |
996 | * FIXME averaging per-frame is suboptimal. Better to sum over the HCD's | |
997 | * entire periodic schedule ... 32 frames for OHCI, 1024 for UHCI, settable | |
998 | * for EHCI (256/512/1024 frames, default 1024) and have the bus expose how | |
999 | * large its periodic schedule is. | |
1000 | */ | |
1001 | void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc) | |
1002 | { | |
1003 | dev->bus->bandwidth_allocated += bustime; | |
1004 | if (isoc) | |
1005 | dev->bus->bandwidth_isoc_reqs++; | |
1006 | else | |
1007 | dev->bus->bandwidth_int_reqs++; | |
1008 | urb->bandwidth = bustime; | |
1009 | ||
1010 | #ifdef USB_BANDWIDTH_MESSAGES | |
1011 | dev_dbg (&dev->dev, "bandwidth alloc increased by %d (%s) to %d for %d requesters\n", | |
1012 | bustime, | |
1013 | isoc ? "ISOC" : "INTR", | |
1014 | dev->bus->bandwidth_allocated, | |
1015 | dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs); | |
1016 | #endif | |
1017 | } | |
1018 | EXPORT_SYMBOL (usb_claim_bandwidth); | |
1019 | ||
1020 | ||
1021 | /** | |
1022 | * usb_release_bandwidth - reverses effect of usb_claim_bandwidth() | |
1023 | * @dev: source/target of request | |
1024 | * @urb: request (urb->dev == dev) | |
1025 | * @isoc: true iff the request is isochronous | |
1026 | * | |
1027 | * This records that previously allocated bandwidth has been released. | |
1028 | * Bandwidth is released when endpoints are removed from the host controller's | |
1029 | * periodic schedule. | |
1030 | */ | |
1031 | void usb_release_bandwidth (struct usb_device *dev, struct urb *urb, int isoc) | |
1032 | { | |
1033 | dev->bus->bandwidth_allocated -= urb->bandwidth; | |
1034 | if (isoc) | |
1035 | dev->bus->bandwidth_isoc_reqs--; | |
1036 | else | |
1037 | dev->bus->bandwidth_int_reqs--; | |
1038 | ||
1039 | #ifdef USB_BANDWIDTH_MESSAGES | |
1040 | dev_dbg (&dev->dev, "bandwidth alloc reduced by %d (%s) to %d for %d requesters\n", | |
1041 | urb->bandwidth, | |
1042 | isoc ? "ISOC" : "INTR", | |
1043 | dev->bus->bandwidth_allocated, | |
1044 | dev->bus->bandwidth_int_reqs + dev->bus->bandwidth_isoc_reqs); | |
1045 | #endif | |
1046 | urb->bandwidth = 0; | |
1047 | } | |
1048 | EXPORT_SYMBOL (usb_release_bandwidth); | |
1049 | ||
1050 | ||
1051 | /*-------------------------------------------------------------------------*/ | |
1052 | ||
1053 | /* | |
1054 | * Generic HC operations. | |
1055 | */ | |
1056 | ||
1057 | /*-------------------------------------------------------------------------*/ | |
1058 | ||
1059 | static void urb_unlink (struct urb *urb) | |
1060 | { | |
1061 | unsigned long flags; | |
1062 | ||
1063 | /* Release any periodic transfer bandwidth */ | |
1064 | if (urb->bandwidth) | |
1065 | usb_release_bandwidth (urb->dev, urb, | |
1066 | usb_pipeisoc (urb->pipe)); | |
1067 | ||
1068 | /* clear all state linking urb to this dev (and hcd) */ | |
1069 | ||
1070 | spin_lock_irqsave (&hcd_data_lock, flags); | |
1071 | list_del_init (&urb->urb_list); | |
1072 | spin_unlock_irqrestore (&hcd_data_lock, flags); | |
1da177e4 LT |
1073 | } |
1074 | ||
1075 | ||
1076 | /* may be called in any context with a valid urb->dev usecount | |
1077 | * caller surrenders "ownership" of urb | |
1078 | * expects usb_submit_urb() to have sanity checked and conditioned all | |
1079 | * inputs in the urb | |
1080 | */ | |
a6d2bb9f | 1081 | int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags) |
1da177e4 LT |
1082 | { |
1083 | int status; | |
1084 | struct usb_hcd *hcd = urb->dev->bus->hcpriv; | |
1085 | struct usb_host_endpoint *ep; | |
1086 | unsigned long flags; | |
1087 | ||
1088 | if (!hcd) | |
1089 | return -ENODEV; | |
1090 | ||
1091 | usbmon_urb_submit(&hcd->self, urb); | |
1092 | ||
1093 | /* | |
1094 | * Atomically queue the urb, first to our records, then to the HCD. | |
1095 | * Access to urb->status is controlled by urb->lock ... changes on | |
1096 | * i/o completion (normal or fault) or unlinking. | |
1097 | */ | |
1098 | ||
1099 | // FIXME: verify that quiescing hc works right (RH cleans up) | |
1100 | ||
1101 | spin_lock_irqsave (&hcd_data_lock, flags); | |
1102 | ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out) | |
1103 | [usb_pipeendpoint(urb->pipe)]; | |
1104 | if (unlikely (!ep)) | |
1105 | status = -ENOENT; | |
1106 | else if (unlikely (urb->reject)) | |
1107 | status = -EPERM; | |
1108 | else switch (hcd->state) { | |
1109 | case HC_STATE_RUNNING: | |
1110 | case HC_STATE_RESUMING: | |
979d5199 | 1111 | doit: |
1da177e4 LT |
1112 | list_add_tail (&urb->urb_list, &ep->urb_list); |
1113 | status = 0; | |
1114 | break; | |
979d5199 DB |
1115 | case HC_STATE_SUSPENDED: |
1116 | /* HC upstream links (register access, wakeup signaling) can work | |
1117 | * even when the downstream links (and DMA etc) are quiesced; let | |
1118 | * usbcore talk to the root hub. | |
1119 | */ | |
1120 | if (hcd->self.controller->power.power_state.event == PM_EVENT_ON | |
1121 | && urb->dev->parent == NULL) | |
1122 | goto doit; | |
1123 | /* FALL THROUGH */ | |
1da177e4 LT |
1124 | default: |
1125 | status = -ESHUTDOWN; | |
1126 | break; | |
1127 | } | |
1128 | spin_unlock_irqrestore (&hcd_data_lock, flags); | |
1129 | if (status) { | |
1130 | INIT_LIST_HEAD (&urb->urb_list); | |
1131 | usbmon_urb_submit_error(&hcd->self, urb, status); | |
1132 | return status; | |
1133 | } | |
1134 | ||
1135 | /* increment urb's reference count as part of giving it to the HCD | |
1136 | * (which now controls it). HCD guarantees that it either returns | |
1137 | * an error or calls giveback(), but not both. | |
1138 | */ | |
1139 | urb = usb_get_urb (urb); | |
1140 | atomic_inc (&urb->use_count); | |
1141 | ||
1142 | if (urb->dev == hcd->self.root_hub) { | |
1143 | /* NOTE: requirement on hub callers (usbfs and the hub | |
1144 | * driver, for now) that URBs' urb->transfer_buffer be | |
1145 | * valid and usb_buffer_{sync,unmap}() not be needed, since | |
1146 | * they could clobber root hub response data. | |
1147 | */ | |
1148 | status = rh_urb_enqueue (hcd, urb); | |
1149 | goto done; | |
1150 | } | |
1151 | ||
1152 | /* lower level hcd code should use *_dma exclusively, | |
1153 | * unless it uses pio or talks to another transport. | |
1154 | */ | |
dd990f16 | 1155 | if (hcd->self.uses_dma) { |
1da177e4 LT |
1156 | if (usb_pipecontrol (urb->pipe) |
1157 | && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) | |
1158 | urb->setup_dma = dma_map_single ( | |
1159 | hcd->self.controller, | |
1160 | urb->setup_packet, | |
1161 | sizeof (struct usb_ctrlrequest), | |
1162 | DMA_TO_DEVICE); | |
1163 | if (urb->transfer_buffer_length != 0 | |
1164 | && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) | |
1165 | urb->transfer_dma = dma_map_single ( | |
1166 | hcd->self.controller, | |
1167 | urb->transfer_buffer, | |
1168 | urb->transfer_buffer_length, | |
1169 | usb_pipein (urb->pipe) | |
1170 | ? DMA_FROM_DEVICE | |
1171 | : DMA_TO_DEVICE); | |
1172 | } | |
1173 | ||
1174 | status = hcd->driver->urb_enqueue (hcd, ep, urb, mem_flags); | |
1175 | done: | |
1176 | if (unlikely (status)) { | |
1177 | urb_unlink (urb); | |
1178 | atomic_dec (&urb->use_count); | |
1179 | if (urb->reject) | |
1180 | wake_up (&usb_kill_urb_queue); | |
1181 | usb_put_urb (urb); | |
1182 | usbmon_urb_submit_error(&hcd->self, urb, status); | |
1183 | } | |
1184 | return status; | |
1185 | } | |
1186 | ||
1187 | /*-------------------------------------------------------------------------*/ | |
1188 | ||
1189 | /* called in any context */ | |
a6d2bb9f | 1190 | int usb_hcd_get_frame_number (struct usb_device *udev) |
1da177e4 LT |
1191 | { |
1192 | struct usb_hcd *hcd = (struct usb_hcd *)udev->bus->hcpriv; | |
1193 | if (!HC_IS_RUNNING (hcd->state)) | |
1194 | return -ESHUTDOWN; | |
1195 | return hcd->driver->get_frame_number (hcd); | |
1196 | } | |
1197 | ||
1198 | /*-------------------------------------------------------------------------*/ | |
1199 | ||
1200 | /* this makes the hcd giveback() the urb more quickly, by kicking it | |
1201 | * off hardware queues (which may take a while) and returning it as | |
1202 | * soon as practical. we've already set up the urb's return status, | |
1203 | * but we can't know if the callback completed already. | |
1204 | */ | |
1205 | static int | |
1206 | unlink1 (struct usb_hcd *hcd, struct urb *urb) | |
1207 | { | |
1208 | int value; | |
1209 | ||
1210 | if (urb->dev == hcd->self.root_hub) | |
1211 | value = usb_rh_urb_dequeue (hcd, urb); | |
1212 | else { | |
1213 | ||
1214 | /* The only reason an HCD might fail this call is if | |
1215 | * it has not yet fully queued the urb to begin with. | |
1216 | * Such failures should be harmless. */ | |
1217 | value = hcd->driver->urb_dequeue (hcd, urb); | |
1218 | } | |
1219 | ||
1220 | if (value != 0) | |
1221 | dev_dbg (hcd->self.controller, "dequeue %p --> %d\n", | |
1222 | urb, value); | |
1223 | return value; | |
1224 | } | |
1225 | ||
1226 | /* | |
1227 | * called in any context | |
1228 | * | |
1229 | * caller guarantees urb won't be recycled till both unlink() | |
1230 | * and the urb's completion function return | |
1231 | */ | |
a6d2bb9f | 1232 | int usb_hcd_unlink_urb (struct urb *urb, int status) |
1da177e4 LT |
1233 | { |
1234 | struct usb_host_endpoint *ep; | |
1235 | struct usb_hcd *hcd = NULL; | |
1236 | struct device *sys = NULL; | |
1237 | unsigned long flags; | |
1238 | struct list_head *tmp; | |
1239 | int retval; | |
1240 | ||
1241 | if (!urb) | |
1242 | return -EINVAL; | |
1243 | if (!urb->dev || !urb->dev->bus) | |
1244 | return -ENODEV; | |
1245 | ep = (usb_pipein(urb->pipe) ? urb->dev->ep_in : urb->dev->ep_out) | |
1246 | [usb_pipeendpoint(urb->pipe)]; | |
1247 | if (!ep) | |
1248 | return -ENODEV; | |
1249 | ||
1250 | /* | |
1251 | * we contend for urb->status with the hcd core, | |
1252 | * which changes it while returning the urb. | |
1253 | * | |
1254 | * Caller guaranteed that the urb pointer hasn't been freed, and | |
1255 | * that it was submitted. But as a rule it can't know whether or | |
1256 | * not it's already been unlinked ... so we respect the reversed | |
1257 | * lock sequence needed for the usb_hcd_giveback_urb() code paths | |
1258 | * (urb lock, then hcd_data_lock) in case some other CPU is now | |
1259 | * unlinking it. | |
1260 | */ | |
1261 | spin_lock_irqsave (&urb->lock, flags); | |
1262 | spin_lock (&hcd_data_lock); | |
1263 | ||
1264 | sys = &urb->dev->dev; | |
1265 | hcd = urb->dev->bus->hcpriv; | |
1266 | if (hcd == NULL) { | |
1267 | retval = -ENODEV; | |
1268 | goto done; | |
1269 | } | |
1270 | ||
1da177e4 LT |
1271 | /* insist the urb is still queued */ |
1272 | list_for_each(tmp, &ep->urb_list) { | |
1273 | if (tmp == &urb->urb_list) | |
1274 | break; | |
1275 | } | |
1276 | if (tmp != &urb->urb_list) { | |
1277 | retval = -EIDRM; | |
1278 | goto done; | |
1279 | } | |
1280 | ||
1281 | /* Any status except -EINPROGRESS means something already started to | |
1282 | * unlink this URB from the hardware. So there's no more work to do. | |
1283 | */ | |
1284 | if (urb->status != -EINPROGRESS) { | |
1285 | retval = -EBUSY; | |
1286 | goto done; | |
1287 | } | |
1288 | ||
1289 | /* IRQ setup can easily be broken so that USB controllers | |
1290 | * never get completion IRQs ... maybe even the ones we need to | |
1291 | * finish unlinking the initial failed usb_set_address() | |
1292 | * or device descriptor fetch. | |
1293 | */ | |
8de98402 BH |
1294 | if (!test_bit(HCD_FLAG_SAW_IRQ, &hcd->flags) |
1295 | && hcd->self.root_hub != urb->dev) { | |
1da177e4 LT |
1296 | dev_warn (hcd->self.controller, "Unlink after no-IRQ? " |
1297 | "Controller is probably using the wrong IRQ." | |
1298 | "\n"); | |
8de98402 | 1299 | set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags); |
1da177e4 LT |
1300 | } |
1301 | ||
1302 | urb->status = status; | |
1303 | ||
1304 | spin_unlock (&hcd_data_lock); | |
1305 | spin_unlock_irqrestore (&urb->lock, flags); | |
1306 | ||
1307 | retval = unlink1 (hcd, urb); | |
1308 | if (retval == 0) | |
1309 | retval = -EINPROGRESS; | |
1310 | return retval; | |
1311 | ||
1312 | done: | |
1313 | spin_unlock (&hcd_data_lock); | |
1314 | spin_unlock_irqrestore (&urb->lock, flags); | |
1315 | if (retval != -EIDRM && sys && sys->driver) | |
1316 | dev_dbg (sys, "hcd_unlink_urb %p fail %d\n", urb, retval); | |
1317 | return retval; | |
1318 | } | |
1319 | ||
1320 | /*-------------------------------------------------------------------------*/ | |
1321 | ||
1322 | /* disables the endpoint: cancels any pending urbs, then synchronizes with | |
455b25fb AS |
1323 | * the hcd to make sure all endpoint state is gone from hardware, and then |
1324 | * waits until the endpoint's queue is completely drained. use for | |
1da177e4 LT |
1325 | * set_configuration, set_interface, driver removal, physical disconnect. |
1326 | * | |
1327 | * example: a qh stored in ep->hcpriv, holding state related to endpoint | |
1328 | * type, maxpacket size, toggle, halt status, and scheduling. | |
1329 | */ | |
a6d2bb9f AS |
1330 | void usb_hcd_endpoint_disable (struct usb_device *udev, |
1331 | struct usb_host_endpoint *ep) | |
1da177e4 LT |
1332 | { |
1333 | struct usb_hcd *hcd; | |
1334 | struct urb *urb; | |
1335 | ||
1336 | hcd = udev->bus->hcpriv; | |
1337 | ||
d5926ae7 AS |
1338 | WARN_ON (!HC_IS_RUNNING (hcd->state) && hcd->state != HC_STATE_HALT && |
1339 | udev->state != USB_STATE_NOTATTACHED); | |
1da177e4 LT |
1340 | |
1341 | local_irq_disable (); | |
1342 | ||
1da177e4 LT |
1343 | /* ep is already gone from udev->ep_{in,out}[]; no more submits */ |
1344 | rescan: | |
1345 | spin_lock (&hcd_data_lock); | |
1346 | list_for_each_entry (urb, &ep->urb_list, urb_list) { | |
1347 | int tmp; | |
1348 | ||
455b25fb | 1349 | /* the urb may already have been unlinked */ |
1da177e4 LT |
1350 | if (urb->status != -EINPROGRESS) |
1351 | continue; | |
1352 | usb_get_urb (urb); | |
1353 | spin_unlock (&hcd_data_lock); | |
1354 | ||
1355 | spin_lock (&urb->lock); | |
1356 | tmp = urb->status; | |
1357 | if (tmp == -EINPROGRESS) | |
1358 | urb->status = -ESHUTDOWN; | |
1359 | spin_unlock (&urb->lock); | |
1360 | ||
1361 | /* kick hcd unless it's already returning this */ | |
1362 | if (tmp == -EINPROGRESS) { | |
1363 | tmp = urb->pipe; | |
1364 | unlink1 (hcd, urb); | |
1365 | dev_dbg (hcd->self.controller, | |
1366 | "shutdown urb %p pipe %08x ep%d%s%s\n", | |
1367 | urb, tmp, usb_pipeendpoint (tmp), | |
1368 | (tmp & USB_DIR_IN) ? "in" : "out", | |
1369 | ({ char *s; \ | |
1370 | switch (usb_pipetype (tmp)) { \ | |
1371 | case PIPE_CONTROL: s = ""; break; \ | |
1372 | case PIPE_BULK: s = "-bulk"; break; \ | |
1373 | case PIPE_INTERRUPT: s = "-intr"; break; \ | |
1374 | default: s = "-iso"; break; \ | |
1375 | }; s;})); | |
1376 | } | |
1377 | usb_put_urb (urb); | |
1378 | ||
1379 | /* list contents may have changed */ | |
1380 | goto rescan; | |
1381 | } | |
1382 | spin_unlock (&hcd_data_lock); | |
1383 | local_irq_enable (); | |
1384 | ||
1385 | /* synchronize with the hardware, so old configuration state | |
1386 | * clears out immediately (and will be freed). | |
1387 | */ | |
1388 | might_sleep (); | |
1389 | if (hcd->driver->endpoint_disable) | |
1390 | hcd->driver->endpoint_disable (hcd, ep); | |
455b25fb AS |
1391 | |
1392 | /* Wait until the endpoint queue is completely empty. Most HCDs | |
1393 | * will have done this already in their endpoint_disable method, | |
1394 | * but some might not. And there could be root-hub control URBs | |
1395 | * still pending since they aren't affected by the HCDs' | |
1396 | * endpoint_disable methods. | |
1397 | */ | |
1398 | while (!list_empty (&ep->urb_list)) { | |
1399 | spin_lock_irq (&hcd_data_lock); | |
1400 | ||
1401 | /* The list may have changed while we acquired the spinlock */ | |
1402 | urb = NULL; | |
1403 | if (!list_empty (&ep->urb_list)) { | |
1404 | urb = list_entry (ep->urb_list.prev, struct urb, | |
1405 | urb_list); | |
1406 | usb_get_urb (urb); | |
1407 | } | |
1408 | spin_unlock_irq (&hcd_data_lock); | |
1409 | ||
1410 | if (urb) { | |
1411 | usb_kill_urb (urb); | |
1412 | usb_put_urb (urb); | |
1413 | } | |
1414 | } | |
1da177e4 LT |
1415 | } |
1416 | ||
1417 | /*-------------------------------------------------------------------------*/ | |
1418 | ||
9293677a | 1419 | #ifdef CONFIG_PM |
1da177e4 | 1420 | |
0c0382e3 | 1421 | int hcd_bus_suspend (struct usb_bus *bus) |
1da177e4 LT |
1422 | { |
1423 | struct usb_hcd *hcd; | |
9293677a | 1424 | int status; |
1da177e4 LT |
1425 | |
1426 | hcd = container_of (bus, struct usb_hcd, self); | |
0c0382e3 | 1427 | if (!hcd->driver->bus_suspend) |
9293677a DB |
1428 | return -ENOENT; |
1429 | hcd->state = HC_STATE_QUIESCING; | |
0c0382e3 | 1430 | status = hcd->driver->bus_suspend (hcd); |
9293677a DB |
1431 | if (status == 0) |
1432 | hcd->state = HC_STATE_SUSPENDED; | |
1433 | else | |
1434 | dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n", | |
1435 | "suspend", status); | |
1436 | return status; | |
1da177e4 LT |
1437 | } |
1438 | ||
0c0382e3 | 1439 | int hcd_bus_resume (struct usb_bus *bus) |
1da177e4 LT |
1440 | { |
1441 | struct usb_hcd *hcd; | |
9293677a | 1442 | int status; |
1da177e4 LT |
1443 | |
1444 | hcd = container_of (bus, struct usb_hcd, self); | |
0c0382e3 | 1445 | if (!hcd->driver->bus_resume) |
9293677a | 1446 | return -ENOENT; |
979d5199 DB |
1447 | if (hcd->state == HC_STATE_RUNNING) |
1448 | return 0; | |
9293677a | 1449 | hcd->state = HC_STATE_RESUMING; |
0c0382e3 | 1450 | status = hcd->driver->bus_resume (hcd); |
9293677a DB |
1451 | if (status == 0) |
1452 | hcd->state = HC_STATE_RUNNING; | |
1453 | else { | |
1454 | dev_dbg(&bus->root_hub->dev, "%s fail, err %d\n", | |
1455 | "resume", status); | |
1456 | usb_hc_died(hcd); | |
1457 | } | |
1458 | return status; | |
1da177e4 LT |
1459 | } |
1460 | ||
979d5199 DB |
1461 | /* |
1462 | * usb_hcd_suspend_root_hub - HCD autosuspends downstream ports | |
1463 | * @hcd: host controller for this root hub | |
1464 | * | |
1465 | * This call arranges that usb_hcd_resume_root_hub() is safe to call later; | |
1466 | * that the HCD's root hub polling is deactivated; and that the root's hub | |
1467 | * driver is suspended. HCDs may call this to autosuspend when their root | |
1468 | * hub's downstream ports are all inactive: unpowered, disconnected, | |
1469 | * disabled, or suspended. | |
1470 | * | |
1471 | * The HCD will autoresume on device connect change detection (using SRP | |
1472 | * or a D+/D- pullup). The HCD also autoresumes on remote wakeup signaling | |
1473 | * from any ports that are suspended (if that is enabled). In most cases, | |
1474 | * overcurrent signaling (on powered ports) will also start autoresume. | |
1475 | * | |
1476 | * Always called with IRQs blocked. | |
1477 | */ | |
1478 | void usb_hcd_suspend_root_hub (struct usb_hcd *hcd) | |
1479 | { | |
1480 | struct urb *urb; | |
1481 | ||
1482 | spin_lock (&hcd_root_hub_lock); | |
1483 | usb_suspend_root_hub (hcd->self.root_hub); | |
1484 | ||
1485 | /* force status urb to complete/unlink while suspended */ | |
1486 | if (hcd->status_urb) { | |
1487 | urb = hcd->status_urb; | |
1488 | urb->status = -ECONNRESET; | |
1489 | urb->hcpriv = NULL; | |
1490 | urb->actual_length = 0; | |
1491 | ||
1492 | del_timer (&hcd->rh_timer); | |
1493 | hcd->poll_pending = 0; | |
1494 | hcd->status_urb = NULL; | |
1495 | } else | |
1496 | urb = NULL; | |
1497 | spin_unlock (&hcd_root_hub_lock); | |
1498 | hcd->state = HC_STATE_SUSPENDED; | |
1499 | ||
1500 | if (urb) | |
1501 | usb_hcd_giveback_urb (hcd, urb, NULL); | |
1502 | } | |
1503 | EXPORT_SYMBOL_GPL(usb_hcd_suspend_root_hub); | |
1504 | ||
1da177e4 LT |
1505 | /** |
1506 | * usb_hcd_resume_root_hub - called by HCD to resume its root hub | |
1507 | * @hcd: host controller for this root hub | |
1508 | * | |
1509 | * The USB host controller calls this function when its root hub is | |
1510 | * suspended (with the remote wakeup feature enabled) and a remote | |
1511 | * wakeup request is received. It queues a request for khubd to | |
979d5199 | 1512 | * resume the root hub (that is, manage its downstream ports again). |
1da177e4 LT |
1513 | */ |
1514 | void usb_hcd_resume_root_hub (struct usb_hcd *hcd) | |
1515 | { | |
1516 | unsigned long flags; | |
1517 | ||
1518 | spin_lock_irqsave (&hcd_root_hub_lock, flags); | |
1519 | if (hcd->rh_registered) | |
1520 | usb_resume_root_hub (hcd->self.root_hub); | |
1521 | spin_unlock_irqrestore (&hcd_root_hub_lock, flags); | |
1522 | } | |
9293677a | 1523 | EXPORT_SYMBOL_GPL(usb_hcd_resume_root_hub); |
1da177e4 | 1524 | |
1da177e4 | 1525 | #endif |
1da177e4 LT |
1526 | |
1527 | /*-------------------------------------------------------------------------*/ | |
1528 | ||
1529 | #ifdef CONFIG_USB_OTG | |
1530 | ||
1531 | /** | |
1532 | * usb_bus_start_enum - start immediate enumeration (for OTG) | |
1533 | * @bus: the bus (must use hcd framework) | |
1534 | * @port_num: 1-based number of port; usually bus->otg_port | |
1535 | * Context: in_interrupt() | |
1536 | * | |
1537 | * Starts enumeration, with an immediate reset followed later by | |
1538 | * khubd identifying and possibly configuring the device. | |
1539 | * This is needed by OTG controller drivers, where it helps meet | |
1540 | * HNP protocol timing requirements for starting a port reset. | |
1541 | */ | |
1542 | int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num) | |
1543 | { | |
1544 | struct usb_hcd *hcd; | |
1545 | int status = -EOPNOTSUPP; | |
1546 | ||
1547 | /* NOTE: since HNP can't start by grabbing the bus's address0_sem, | |
1548 | * boards with root hubs hooked up to internal devices (instead of | |
1549 | * just the OTG port) may need more attention to resetting... | |
1550 | */ | |
1551 | hcd = container_of (bus, struct usb_hcd, self); | |
1552 | if (port_num && hcd->driver->start_port_reset) | |
1553 | status = hcd->driver->start_port_reset(hcd, port_num); | |
1554 | ||
1555 | /* run khubd shortly after (first) root port reset finishes; | |
1556 | * it may issue others, until at least 50 msecs have passed. | |
1557 | */ | |
1558 | if (status == 0) | |
1559 | mod_timer(&hcd->rh_timer, jiffies + msecs_to_jiffies(10)); | |
1560 | return status; | |
1561 | } | |
1562 | EXPORT_SYMBOL (usb_bus_start_enum); | |
1563 | ||
1564 | #endif | |
1565 | ||
1566 | /*-------------------------------------------------------------------------*/ | |
1567 | ||
1da177e4 LT |
1568 | /** |
1569 | * usb_hcd_giveback_urb - return URB from HCD to device driver | |
1570 | * @hcd: host controller returning the URB | |
1571 | * @urb: urb being returned to the USB device driver. | |
1572 | * @regs: pt_regs, passed down to the URB completion handler | |
1573 | * Context: in_interrupt() | |
1574 | * | |
1575 | * This hands the URB from HCD to its USB device driver, using its | |
1576 | * completion function. The HCD has freed all per-urb resources | |
1577 | * (and is done using urb->hcpriv). It also released all HCD locks; | |
1578 | * the device driver won't cause problems if it frees, modifies, | |
1579 | * or resubmits this URB. | |
1580 | */ | |
1581 | void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs) | |
1582 | { | |
1583 | int at_root_hub; | |
1584 | ||
1585 | at_root_hub = (urb->dev == hcd->self.root_hub); | |
1586 | urb_unlink (urb); | |
1587 | ||
dd990f16 AS |
1588 | /* lower level hcd code should use *_dma exclusively if the |
1589 | * host controller does DMA */ | |
1590 | if (hcd->self.uses_dma && !at_root_hub) { | |
1da177e4 LT |
1591 | if (usb_pipecontrol (urb->pipe) |
1592 | && !(urb->transfer_flags & URB_NO_SETUP_DMA_MAP)) | |
1593 | dma_unmap_single (hcd->self.controller, urb->setup_dma, | |
1594 | sizeof (struct usb_ctrlrequest), | |
1595 | DMA_TO_DEVICE); | |
1596 | if (urb->transfer_buffer_length != 0 | |
1597 | && !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)) | |
1598 | dma_unmap_single (hcd->self.controller, | |
1599 | urb->transfer_dma, | |
1600 | urb->transfer_buffer_length, | |
1601 | usb_pipein (urb->pipe) | |
1602 | ? DMA_FROM_DEVICE | |
1603 | : DMA_TO_DEVICE); | |
1604 | } | |
1605 | ||
1606 | usbmon_urb_complete (&hcd->self, urb); | |
1607 | /* pass ownership to the completion handler */ | |
1608 | urb->complete (urb, regs); | |
1609 | atomic_dec (&urb->use_count); | |
1610 | if (unlikely (urb->reject)) | |
1611 | wake_up (&usb_kill_urb_queue); | |
1612 | usb_put_urb (urb); | |
1613 | } | |
1614 | EXPORT_SYMBOL (usb_hcd_giveback_urb); | |
1615 | ||
1616 | /*-------------------------------------------------------------------------*/ | |
1617 | ||
1618 | /** | |
1619 | * usb_hcd_irq - hook IRQs to HCD framework (bus glue) | |
1620 | * @irq: the IRQ being raised | |
1621 | * @__hcd: pointer to the HCD whose IRQ is being signaled | |
1622 | * @r: saved hardware registers | |
1623 | * | |
1624 | * If the controller isn't HALTed, calls the driver's irq handler. | |
1625 | * Checks whether the controller is now dead. | |
1626 | */ | |
1627 | irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs * r) | |
1628 | { | |
1629 | struct usb_hcd *hcd = __hcd; | |
1630 | int start = hcd->state; | |
1631 | ||
8de98402 BH |
1632 | if (unlikely(start == HC_STATE_HALT || |
1633 | !test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))) | |
1da177e4 LT |
1634 | return IRQ_NONE; |
1635 | if (hcd->driver->irq (hcd, r) == IRQ_NONE) | |
1636 | return IRQ_NONE; | |
1637 | ||
8de98402 BH |
1638 | set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags); |
1639 | ||
1640 | if (unlikely(hcd->state == HC_STATE_HALT)) | |
1da177e4 LT |
1641 | usb_hc_died (hcd); |
1642 | return IRQ_HANDLED; | |
1643 | } | |
1644 | ||
1645 | /*-------------------------------------------------------------------------*/ | |
1646 | ||
1647 | /** | |
1648 | * usb_hc_died - report abnormal shutdown of a host controller (bus glue) | |
1649 | * @hcd: pointer to the HCD representing the controller | |
1650 | * | |
1651 | * This is called by bus glue to report a USB host controller that died | |
1652 | * while operations may still have been pending. It's called automatically | |
1653 | * by the PCI glue, so only glue for non-PCI busses should need to call it. | |
1654 | */ | |
1655 | void usb_hc_died (struct usb_hcd *hcd) | |
1656 | { | |
1657 | unsigned long flags; | |
1658 | ||
1659 | dev_err (hcd->self.controller, "HC died; cleaning up\n"); | |
1660 | ||
1661 | spin_lock_irqsave (&hcd_root_hub_lock, flags); | |
1662 | if (hcd->rh_registered) { | |
d5926ae7 | 1663 | hcd->poll_rh = 0; |
1da177e4 LT |
1664 | |
1665 | /* make khubd clean up old urbs and devices */ | |
1666 | usb_set_device_state (hcd->self.root_hub, | |
1667 | USB_STATE_NOTATTACHED); | |
1668 | usb_kick_khubd (hcd->self.root_hub); | |
1669 | } | |
1670 | spin_unlock_irqrestore (&hcd_root_hub_lock, flags); | |
1671 | } | |
1672 | EXPORT_SYMBOL_GPL (usb_hc_died); | |
1673 | ||
1674 | /*-------------------------------------------------------------------------*/ | |
1675 | ||
1676 | static void hcd_release (struct usb_bus *bus) | |
1677 | { | |
1678 | struct usb_hcd *hcd; | |
1679 | ||
1680 | hcd = container_of(bus, struct usb_hcd, self); | |
1681 | kfree(hcd); | |
1682 | } | |
1683 | ||
1684 | /** | |
1685 | * usb_create_hcd - create and initialize an HCD structure | |
1686 | * @driver: HC driver that will use this hcd | |
1687 | * @dev: device for this HC, stored in hcd->self.controller | |
1688 | * @bus_name: value to store in hcd->self.bus_name | |
1689 | * Context: !in_interrupt() | |
1690 | * | |
1691 | * Allocate a struct usb_hcd, with extra space at the end for the | |
1692 | * HC driver's private data. Initialize the generic members of the | |
1693 | * hcd structure. | |
1694 | * | |
1695 | * If memory is unavailable, returns NULL. | |
1696 | */ | |
1697 | struct usb_hcd *usb_create_hcd (const struct hc_driver *driver, | |
1698 | struct device *dev, char *bus_name) | |
1699 | { | |
1700 | struct usb_hcd *hcd; | |
1701 | ||
7b842b6e | 1702 | hcd = kzalloc(sizeof(*hcd) + driver->hcd_priv_size, GFP_KERNEL); |
1da177e4 LT |
1703 | if (!hcd) { |
1704 | dev_dbg (dev, "hcd alloc failed\n"); | |
1705 | return NULL; | |
1706 | } | |
1707 | dev_set_drvdata(dev, hcd); | |
1708 | ||
1709 | usb_bus_init(&hcd->self); | |
1da177e4 LT |
1710 | hcd->self.hcpriv = hcd; |
1711 | hcd->self.release = &hcd_release; | |
1712 | hcd->self.controller = dev; | |
1713 | hcd->self.bus_name = bus_name; | |
dd990f16 | 1714 | hcd->self.uses_dma = (dev->dma_mask != NULL); |
1da177e4 LT |
1715 | |
1716 | init_timer(&hcd->rh_timer); | |
d5926ae7 AS |
1717 | hcd->rh_timer.function = rh_timer_func; |
1718 | hcd->rh_timer.data = (unsigned long) hcd; | |
1da177e4 LT |
1719 | |
1720 | hcd->driver = driver; | |
1721 | hcd->product_desc = (driver->product_desc) ? driver->product_desc : | |
1722 | "USB Host Controller"; | |
1723 | ||
1724 | return hcd; | |
1725 | } | |
1726 | EXPORT_SYMBOL (usb_create_hcd); | |
1727 | ||
1728 | void usb_put_hcd (struct usb_hcd *hcd) | |
1729 | { | |
1730 | dev_set_drvdata(hcd->self.controller, NULL); | |
1731 | usb_bus_put(&hcd->self); | |
1732 | } | |
1733 | EXPORT_SYMBOL (usb_put_hcd); | |
1734 | ||
1735 | /** | |
1736 | * usb_add_hcd - finish generic HCD structure initialization and register | |
1737 | * @hcd: the usb_hcd structure to initialize | |
1738 | * @irqnum: Interrupt line to allocate | |
1739 | * @irqflags: Interrupt type flags | |
1740 | * | |
1741 | * Finish the remaining parts of generic HCD initialization: allocate the | |
1742 | * buffers of consistent memory, register the bus, request the IRQ line, | |
1743 | * and call the driver's reset() and start() routines. | |
1744 | */ | |
1745 | int usb_add_hcd(struct usb_hcd *hcd, | |
1746 | unsigned int irqnum, unsigned long irqflags) | |
1747 | { | |
8ec8d20b AS |
1748 | int retval; |
1749 | struct usb_device *rhdev; | |
1da177e4 LT |
1750 | |
1751 | dev_info(hcd->self.controller, "%s\n", hcd->product_desc); | |
1752 | ||
8de98402 BH |
1753 | set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); |
1754 | ||
b1e8f0a6 DB |
1755 | /* HC is in reset state, but accessible. Now do the one-time init, |
1756 | * bottom up so that hcds can customize the root hubs before khubd | |
1757 | * starts talking to them. (Note, bus id is assigned early too.) | |
1758 | */ | |
1da177e4 LT |
1759 | if ((retval = hcd_buffer_create(hcd)) != 0) { |
1760 | dev_dbg(hcd->self.controller, "pool alloc failed\n"); | |
1761 | return retval; | |
1762 | } | |
1763 | ||
1764 | if ((retval = usb_register_bus(&hcd->self)) < 0) | |
8ec8d20b | 1765 | goto err_register_bus; |
1da177e4 | 1766 | |
b1e8f0a6 DB |
1767 | if ((rhdev = usb_alloc_dev(NULL, &hcd->self, 0)) == NULL) { |
1768 | dev_err(hcd->self.controller, "unable to allocate root hub\n"); | |
1769 | retval = -ENOMEM; | |
1770 | goto err_allocate_root_hub; | |
1771 | } | |
1772 | rhdev->speed = (hcd->driver->flags & HCD_USB2) ? USB_SPEED_HIGH : | |
1773 | USB_SPEED_FULL; | |
1774 | hcd->self.root_hub = rhdev; | |
1775 | ||
db4cefaa DB |
1776 | /* wakeup flag init defaults to "everything works" for root hubs, |
1777 | * but drivers can override it in reset() if needed, along with | |
1778 | * recording the overall controller's system wakeup capability. | |
1779 | */ | |
1780 | device_init_wakeup(&rhdev->dev, 1); | |
1781 | ||
b1e8f0a6 DB |
1782 | /* "reset" is misnamed; its role is now one-time init. the controller |
1783 | * should already have been reset (and boot firmware kicked off etc). | |
1784 | */ | |
1785 | if (hcd->driver->reset && (retval = hcd->driver->reset(hcd)) < 0) { | |
1786 | dev_err(hcd->self.controller, "can't setup\n"); | |
1787 | goto err_hcd_driver_setup; | |
1788 | } | |
1789 | ||
fb669cc0 DB |
1790 | /* NOTE: root hub and controller capabilities may not be the same */ |
1791 | if (device_can_wakeup(hcd->self.controller) | |
1792 | && device_can_wakeup(&hcd->self.root_hub->dev)) | |
b1e8f0a6 | 1793 | dev_dbg(hcd->self.controller, "supports USB remote wakeup\n"); |
b1e8f0a6 DB |
1794 | |
1795 | /* enable irqs just before we start the controller */ | |
1da177e4 | 1796 | if (hcd->driver->irq) { |
1da177e4 LT |
1797 | snprintf(hcd->irq_descr, sizeof(hcd->irq_descr), "%s:usb%d", |
1798 | hcd->driver->description, hcd->self.busnum); | |
1799 | if ((retval = request_irq(irqnum, &usb_hcd_irq, irqflags, | |
1800 | hcd->irq_descr, hcd)) != 0) { | |
1801 | dev_err(hcd->self.controller, | |
c6387a48 | 1802 | "request interrupt %d failed\n", irqnum); |
8ec8d20b | 1803 | goto err_request_irq; |
1da177e4 LT |
1804 | } |
1805 | hcd->irq = irqnum; | |
c6387a48 | 1806 | dev_info(hcd->self.controller, "irq %d, %s 0x%08llx\n", irqnum, |
1da177e4 LT |
1807 | (hcd->driver->flags & HCD_MEMORY) ? |
1808 | "io mem" : "io base", | |
1809 | (unsigned long long)hcd->rsrc_start); | |
1810 | } else { | |
1811 | hcd->irq = -1; | |
1812 | if (hcd->rsrc_start) | |
1813 | dev_info(hcd->self.controller, "%s 0x%08llx\n", | |
1814 | (hcd->driver->flags & HCD_MEMORY) ? | |
1815 | "io mem" : "io base", | |
1816 | (unsigned long long)hcd->rsrc_start); | |
1817 | } | |
1818 | ||
1819 | if ((retval = hcd->driver->start(hcd)) < 0) { | |
1820 | dev_err(hcd->self.controller, "startup error %d\n", retval); | |
8ec8d20b | 1821 | goto err_hcd_driver_start; |
1da177e4 LT |
1822 | } |
1823 | ||
b1e8f0a6 | 1824 | /* starting here, usbcore will pay attention to this root hub */ |
55c52718 | 1825 | rhdev->bus_mA = min(500u, hcd->power_budget); |
b1e8f0a6 | 1826 | if ((retval = register_root_hub(hcd)) != 0) |
8ec8d20b AS |
1827 | goto err_register_root_hub; |
1828 | ||
d5926ae7 AS |
1829 | if (hcd->uses_new_polling && hcd->poll_rh) |
1830 | usb_hcd_poll_rh_status(hcd); | |
1da177e4 LT |
1831 | return retval; |
1832 | ||
b1e8f0a6 | 1833 | err_register_root_hub: |
8ec8d20b | 1834 | hcd->driver->stop(hcd); |
b1e8f0a6 | 1835 | err_hcd_driver_start: |
1da177e4 LT |
1836 | if (hcd->irq >= 0) |
1837 | free_irq(irqnum, hcd); | |
b1e8f0a6 DB |
1838 | err_request_irq: |
1839 | err_hcd_driver_setup: | |
1840 | hcd->self.root_hub = NULL; | |
1841 | usb_put_dev(rhdev); | |
1842 | err_allocate_root_hub: | |
1da177e4 | 1843 | usb_deregister_bus(&hcd->self); |
b1e8f0a6 | 1844 | err_register_bus: |
1da177e4 LT |
1845 | hcd_buffer_destroy(hcd); |
1846 | return retval; | |
1847 | } | |
1848 | EXPORT_SYMBOL (usb_add_hcd); | |
1849 | ||
1850 | /** | |
1851 | * usb_remove_hcd - shutdown processing for generic HCDs | |
1852 | * @hcd: the usb_hcd structure to remove | |
1853 | * Context: !in_interrupt() | |
1854 | * | |
1855 | * Disconnects the root hub, then reverses the effects of usb_add_hcd(), | |
1856 | * invoking the HCD's stop() method. | |
1857 | */ | |
1858 | void usb_remove_hcd(struct usb_hcd *hcd) | |
1859 | { | |
1860 | dev_info(hcd->self.controller, "remove, state %x\n", hcd->state); | |
1861 | ||
1862 | if (HC_IS_RUNNING (hcd->state)) | |
1863 | hcd->state = HC_STATE_QUIESCING; | |
1864 | ||
1865 | dev_dbg(hcd->self.controller, "roothub graceful disconnect\n"); | |
1866 | spin_lock_irq (&hcd_root_hub_lock); | |
1867 | hcd->rh_registered = 0; | |
1868 | spin_unlock_irq (&hcd_root_hub_lock); | |
9ad3d6cc | 1869 | |
4186ecf8 | 1870 | mutex_lock(&usb_bus_list_lock); |
1da177e4 | 1871 | usb_disconnect(&hcd->self.root_hub); |
4186ecf8 | 1872 | mutex_unlock(&usb_bus_list_lock); |
1da177e4 | 1873 | |
d5926ae7 AS |
1874 | hcd->poll_rh = 0; |
1875 | del_timer_sync(&hcd->rh_timer); | |
1876 | ||
1da177e4 LT |
1877 | hcd->driver->stop(hcd); |
1878 | hcd->state = HC_STATE_HALT; | |
1879 | ||
1880 | if (hcd->irq >= 0) | |
1881 | free_irq(hcd->irq, hcd); | |
1882 | usb_deregister_bus(&hcd->self); | |
1883 | hcd_buffer_destroy(hcd); | |
1884 | } | |
1885 | EXPORT_SYMBOL (usb_remove_hcd); | |
1886 | ||
64a21d02 AG |
1887 | void |
1888 | usb_hcd_platform_shutdown(struct platform_device* dev) | |
1889 | { | |
1890 | struct usb_hcd *hcd = platform_get_drvdata(dev); | |
1891 | ||
1892 | if (hcd->driver->shutdown) | |
1893 | hcd->driver->shutdown(hcd); | |
1894 | } | |
1895 | EXPORT_SYMBOL (usb_hcd_platform_shutdown); | |
1896 | ||
1da177e4 LT |
1897 | /*-------------------------------------------------------------------------*/ |
1898 | ||
4749f32d | 1899 | #if defined(CONFIG_USB_MON) |
1da177e4 LT |
1900 | |
1901 | struct usb_mon_operations *mon_ops; | |
1902 | ||
1903 | /* | |
1904 | * The registration is unlocked. | |
1905 | * We do it this way because we do not want to lock in hot paths. | |
1906 | * | |
1907 | * Notice that the code is minimally error-proof. Because usbmon needs | |
1908 | * symbols from usbcore, usbcore gets referenced and cannot be unloaded first. | |
1909 | */ | |
1910 | ||
1911 | int usb_mon_register (struct usb_mon_operations *ops) | |
1912 | { | |
1913 | ||
1914 | if (mon_ops) | |
1915 | return -EBUSY; | |
1916 | ||
1917 | mon_ops = ops; | |
1918 | mb(); | |
1919 | return 0; | |
1920 | } | |
1921 | EXPORT_SYMBOL_GPL (usb_mon_register); | |
1922 | ||
1923 | void usb_mon_deregister (void) | |
1924 | { | |
1925 | ||
1926 | if (mon_ops == NULL) { | |
1927 | printk(KERN_ERR "USB: monitor was not registered\n"); | |
1928 | return; | |
1929 | } | |
1930 | mon_ops = NULL; | |
1931 | mb(); | |
1932 | } | |
1933 | EXPORT_SYMBOL_GPL (usb_mon_deregister); | |
1934 | ||
1935 | #endif /* CONFIG_USB_MON */ |