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