blob: d20cb545a6e4fd0bbc67634251f666d4a0eedfe9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB hub driver.
3 *
4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
8 *
9 */
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/completion.h>
16#include <linux/sched.h>
17#include <linux/list.h>
18#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/ioctl.h>
20#include <linux/usb.h>
21#include <linux/usbdevice_fs.h>
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070022#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010023#include <linux/mutex.h>
Nigel Cunningham7dfb7102006-12-06 20:34:23 -080024#include <linux/freezer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#include <asm/semaphore.h>
27#include <asm/uaccess.h>
28#include <asm/byteorder.h>
29
30#include "usb.h"
31#include "hcd.h"
32#include "hub.h"
33
Alan Stern54515fe2007-05-30 15:38:58 -040034#ifdef CONFIG_USB_PERSIST
35#define USB_PERSIST 1
36#else
37#define USB_PERSIST 0
38#endif
39
Alan Stern1bb5f662006-11-06 11:56:13 -050040struct usb_hub {
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
Alan Sterne8054852007-05-04 11:55:11 -040043 struct kref kref;
Alan Stern1bb5f662006-11-06 11:56:13 -050044 struct urb *urb; /* for interrupt polling pipe */
45
46 /* buffer for urb ... with extra space in case of babble */
47 char (*buffer)[8];
48 dma_addr_t buffer_dma; /* DMA address for buffer */
49 union {
50 struct usb_hub_status hub;
51 struct usb_port_status port;
52 } *status; /* buffer for status reports */
Alan Sterndb90e7a2007-02-05 09:56:15 -050053 struct mutex status_mutex; /* for the status buffer */
Alan Stern1bb5f662006-11-06 11:56:13 -050054
55 int error; /* last reported error */
56 int nerrors; /* track consecutive errors */
57
58 struct list_head event_list; /* hubs w/data or errs ready */
59 unsigned long event_bits[1]; /* status change bitmask */
60 unsigned long change_bits[1]; /* ports with logical connect
61 status change */
62 unsigned long busy_bits[1]; /* ports being reset or
63 resumed */
64#if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65#error event_bits[] is too short!
66#endif
67
68 struct usb_hub_descriptor *descriptor; /* class descriptor */
69 struct usb_tt tt; /* Transaction Translator */
70
71 unsigned mA_per_port; /* current for each child */
72
73 unsigned limited_power:1;
74 unsigned quiescing:1;
75 unsigned activating:1;
Alan Sterne8054852007-05-04 11:55:11 -040076 unsigned disconnected:1;
Alan Stern1bb5f662006-11-06 11:56:13 -050077
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
David Howells6d5aefb2006-12-05 19:36:26 +000080 struct delayed_work leds;
Alan Stern1bb5f662006-11-06 11:56:13 -050081};
82
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050085 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
87static DEFINE_SPINLOCK(device_state_lock);
88
89/* khubd's worklist and its lock */
90static DEFINE_SPINLOCK(hub_event_lock);
91static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
92
93/* Wakes up khubd */
94static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
95
akpm@osdl.org9c8d6172005-06-20 14:29:58 -070096static struct task_struct *khubd_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98/* cycle leds on hubs that aren't blinking for attention */
99static int blinkenlights = 0;
100module_param (blinkenlights, bool, S_IRUGO);
101MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
102
103/*
104 * As of 2.6.10 we introduce a new USB device initialization scheme which
105 * closely resembles the way Windows works. Hopefully it will be compatible
106 * with a wider range of devices than the old scheme. However some previously
107 * working devices may start giving rise to "device not accepting address"
108 * errors; if that happens the user can try the old scheme by adjusting the
109 * following module parameters.
110 *
111 * For maximum flexibility there are two boolean parameters to control the
112 * hub driver's behavior. On the first initialization attempt, if the
113 * "old_scheme_first" parameter is set then the old scheme will be used,
114 * otherwise the new scheme is used. If that fails and "use_both_schemes"
115 * is set, then the driver will make another attempt, using the other scheme.
116 */
117static int old_scheme_first = 0;
118module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
119MODULE_PARM_DESC(old_scheme_first,
120 "start with the old device initialization scheme");
121
122static int use_both_schemes = 1;
123module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
124MODULE_PARM_DESC(use_both_schemes,
125 "try the other device initialization scheme if the "
126 "first one fails");
127
Alan Stern32fe0192007-10-10 16:27:07 -0400128/* Mutual exclusion for EHCI CF initialization. This interferes with
129 * port reset on some companion controllers.
130 */
131DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
132EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Dan Williams404d5b12007-04-26 00:12:10 -0700135static inline char *portspeed(int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136{
137 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
138 return "480 Mb/s";
139 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
140 return "1.5 Mb/s";
141 else
142 return "12 Mb/s";
143}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145/* Note that hdev or one of its children must be locked! */
146static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
147{
148 return usb_get_intfdata(hdev->actconfig->interface[0]);
149}
150
151/* USB 2.0 spec Section 11.24.4.5 */
152static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
153{
154 int i, ret;
155
156 for (i = 0; i < 3; i++) {
157 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
158 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
159 USB_DT_HUB << 8, 0, data, size,
160 USB_CTRL_GET_TIMEOUT);
161 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
162 return ret;
163 }
164 return -EINVAL;
165}
166
167/*
168 * USB 2.0 spec Section 11.24.2.1
169 */
170static int clear_hub_feature(struct usb_device *hdev, int feature)
171{
172 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
173 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
174}
175
176/*
177 * USB 2.0 spec Section 11.24.2.2
178 */
179static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
180{
181 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
182 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
183 NULL, 0, 1000);
184}
185
186/*
187 * USB 2.0 spec Section 11.24.2.13
188 */
189static int set_port_feature(struct usb_device *hdev, int port1, int feature)
190{
191 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
192 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
193 NULL, 0, 1000);
194}
195
196/*
197 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
198 * for info about using port indicators
199 */
200static void set_port_led(
201 struct usb_hub *hub,
202 int port1,
203 int selector
204)
205{
206 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
207 USB_PORT_FEAT_INDICATOR);
208 if (status < 0)
209 dev_dbg (hub->intfdev,
210 "port %d indicator %s status %d\n",
211 port1,
212 ({ char *s; switch (selector) {
213 case HUB_LED_AMBER: s = "amber"; break;
214 case HUB_LED_GREEN: s = "green"; break;
215 case HUB_LED_OFF: s = "off"; break;
216 case HUB_LED_AUTO: s = "auto"; break;
217 default: s = "??"; break;
218 }; s; }),
219 status);
220}
221
222#define LED_CYCLE_PERIOD ((2*HZ)/3)
223
David Howellsc4028952006-11-22 14:57:56 +0000224static void led_work (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
David Howellsc4028952006-11-22 14:57:56 +0000226 struct usb_hub *hub =
227 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 struct usb_device *hdev = hub->hdev;
229 unsigned i;
230 unsigned changed = 0;
231 int cursor = -1;
232
233 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
234 return;
235
236 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
237 unsigned selector, mode;
238
239 /* 30%-50% duty cycle */
240
241 switch (hub->indicator[i]) {
242 /* cycle marker */
243 case INDICATOR_CYCLE:
244 cursor = i;
245 selector = HUB_LED_AUTO;
246 mode = INDICATOR_AUTO;
247 break;
248 /* blinking green = sw attention */
249 case INDICATOR_GREEN_BLINK:
250 selector = HUB_LED_GREEN;
251 mode = INDICATOR_GREEN_BLINK_OFF;
252 break;
253 case INDICATOR_GREEN_BLINK_OFF:
254 selector = HUB_LED_OFF;
255 mode = INDICATOR_GREEN_BLINK;
256 break;
257 /* blinking amber = hw attention */
258 case INDICATOR_AMBER_BLINK:
259 selector = HUB_LED_AMBER;
260 mode = INDICATOR_AMBER_BLINK_OFF;
261 break;
262 case INDICATOR_AMBER_BLINK_OFF:
263 selector = HUB_LED_OFF;
264 mode = INDICATOR_AMBER_BLINK;
265 break;
266 /* blink green/amber = reserved */
267 case INDICATOR_ALT_BLINK:
268 selector = HUB_LED_GREEN;
269 mode = INDICATOR_ALT_BLINK_OFF;
270 break;
271 case INDICATOR_ALT_BLINK_OFF:
272 selector = HUB_LED_AMBER;
273 mode = INDICATOR_ALT_BLINK;
274 break;
275 default:
276 continue;
277 }
278 if (selector != HUB_LED_AUTO)
279 changed = 1;
280 set_port_led(hub, i + 1, selector);
281 hub->indicator[i] = mode;
282 }
283 if (!changed && blinkenlights) {
284 cursor++;
285 cursor %= hub->descriptor->bNbrPorts;
286 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
287 hub->indicator[cursor] = INDICATOR_CYCLE;
288 changed++;
289 }
290 if (changed)
291 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
292}
293
294/* use a short timeout for hub/port status fetches */
295#define USB_STS_TIMEOUT 1000
296#define USB_STS_RETRIES 5
297
298/*
299 * USB 2.0 spec Section 11.24.2.6
300 */
301static int get_hub_status(struct usb_device *hdev,
302 struct usb_hub_status *data)
303{
304 int i, status = -ETIMEDOUT;
305
306 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
307 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
308 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
309 data, sizeof(*data), USB_STS_TIMEOUT);
310 }
311 return status;
312}
313
314/*
315 * USB 2.0 spec Section 11.24.2.7
316 */
317static int get_port_status(struct usb_device *hdev, int port1,
318 struct usb_port_status *data)
319{
320 int i, status = -ETIMEDOUT;
321
322 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
323 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
324 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
325 data, sizeof(*data), USB_STS_TIMEOUT);
326 }
327 return status;
328}
329
330static void kick_khubd(struct usb_hub *hub)
331{
332 unsigned long flags;
333
Alan Stern40f122f2006-11-09 14:44:33 -0500334 /* Suppress autosuspend until khubd runs */
335 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 spin_lock_irqsave(&hub_event_lock, flags);
Alan Sterne8054852007-05-04 11:55:11 -0400338 if (!hub->disconnected & list_empty(&hub->event_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 list_add_tail(&hub->event_list, &hub_event_list);
340 wake_up(&khubd_wait);
341 }
342 spin_unlock_irqrestore(&hub_event_lock, flags);
343}
344
345void usb_kick_khubd(struct usb_device *hdev)
346{
Alan Sterne8054852007-05-04 11:55:11 -0400347 /* FIXME: What if hdev isn't bound to the hub driver? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 kick_khubd(hdev_to_hub(hdev));
349}
350
351
352/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100353static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200355 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400356 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 int i;
358 unsigned long bits;
359
Alan Sterne0152682007-08-24 15:42:52 -0400360 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 case -ENOENT: /* synchronous unlink */
362 case -ECONNRESET: /* async unlink */
363 case -ESHUTDOWN: /* hardware going away */
364 return;
365
366 default: /* presumably an error */
367 /* Cause a hub reset after 10 consecutive errors */
Alan Sterne0152682007-08-24 15:42:52 -0400368 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 if ((++hub->nerrors < 10) || hub->error)
370 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400371 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200373
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 /* let khubd handle things */
375 case 0: /* we got data: port status changed */
376 bits = 0;
377 for (i = 0; i < urb->actual_length; ++i)
378 bits |= ((unsigned long) ((*hub->buffer)[i]))
379 << (i*8);
380 hub->event_bits[0] = bits;
381 break;
382 }
383
384 hub->nerrors = 0;
385
386 /* Something happened, let khubd figure it out */
387 kick_khubd(hub);
388
389resubmit:
390 if (hub->quiescing)
391 return;
392
393 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
394 && status != -ENODEV && status != -EPERM)
395 dev_err (hub->intfdev, "resubmit --> %d\n", status);
396}
397
398/* USB 2.0 spec Section 11.24.2.3 */
399static inline int
400hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
401{
402 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
403 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
404 tt, NULL, 0, 1000);
405}
406
407/*
408 * enumeration blocks khubd for a long time. we use keventd instead, since
409 * long blocking there is the exception, not the rule. accordingly, HCDs
410 * talking to TTs must queue control transfers (not just bulk and iso), so
411 * both can talk to the same hub concurrently.
412 */
David Howellsc4028952006-11-22 14:57:56 +0000413static void hub_tt_kevent (struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
David Howellsc4028952006-11-22 14:57:56 +0000415 struct usb_hub *hub =
416 container_of(work, struct usb_hub, tt.kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 unsigned long flags;
Mark Lord55e5fdf2007-05-14 19:48:02 -0400418 int limit = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420 spin_lock_irqsave (&hub->tt.lock, flags);
Mark Lord55e5fdf2007-05-14 19:48:02 -0400421 while (--limit && !list_empty (&hub->tt.clear_list)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 struct list_head *temp;
423 struct usb_tt_clear *clear;
424 struct usb_device *hdev = hub->hdev;
425 int status;
426
427 temp = hub->tt.clear_list.next;
428 clear = list_entry (temp, struct usb_tt_clear, clear_list);
429 list_del (&clear->clear_list);
430
431 /* drop lock so HCD can concurrently report other TT errors */
432 spin_unlock_irqrestore (&hub->tt.lock, flags);
433 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
434 spin_lock_irqsave (&hub->tt.lock, flags);
435
436 if (status)
437 dev_err (&hdev->dev,
438 "clear tt %d (%04x) error %d\n",
439 clear->tt, clear->devinfo, status);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700440 kfree(clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
442 spin_unlock_irqrestore (&hub->tt.lock, flags);
443}
444
445/**
446 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
447 * @udev: the device whose split transaction failed
448 * @pipe: identifies the endpoint of the failed transaction
449 *
450 * High speed HCDs use this to tell the hub driver that some split control or
451 * bulk transaction failed in a way that requires clearing internal state of
452 * a transaction translator. This is normally detected (and reported) from
453 * interrupt context.
454 *
455 * It may not be possible for that hub to handle additional full (or low)
456 * speed transactions until that state is fully cleared out.
457 */
458void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
459{
460 struct usb_tt *tt = udev->tt;
461 unsigned long flags;
462 struct usb_tt_clear *clear;
463
464 /* we've got to cope with an arbitrary number of pending TT clears,
465 * since each TT has "at least two" buffers that can need it (and
466 * there can be many TTs per hub). even if they're uncommon.
467 */
Christoph Lameter54e6ecb2006-12-06 20:33:16 -0800468 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
470 /* FIXME recover somehow ... RESET_TT? */
471 return;
472 }
473
474 /* info that CLEAR_TT_BUFFER needs */
475 clear->tt = tt->multi ? udev->ttport : 1;
476 clear->devinfo = usb_pipeendpoint (pipe);
477 clear->devinfo |= udev->devnum << 4;
478 clear->devinfo |= usb_pipecontrol (pipe)
479 ? (USB_ENDPOINT_XFER_CONTROL << 11)
480 : (USB_ENDPOINT_XFER_BULK << 11);
481 if (usb_pipein (pipe))
482 clear->devinfo |= 1 << 15;
483
484 /* tell keventd to clear state for this TT */
485 spin_lock_irqsave (&tt->lock, flags);
486 list_add_tail (&clear->clear_list, &tt->clear_list);
487 schedule_work (&tt->kevent);
488 spin_unlock_irqrestore (&tt->lock, flags);
489}
490
491static void hub_power_on(struct usb_hub *hub)
492{
493 int port1;
David Brownellb7896962005-08-31 10:41:44 -0700494 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
Alan Stern4489a572006-04-27 15:54:22 -0400495 u16 wHubCharacteristics =
496 le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Alan Stern4489a572006-04-27 15:54:22 -0400498 /* Enable power on each port. Some hubs have reserved values
499 * of LPSM (> 2) in their descriptors, even though they are
500 * USB 2.0 hubs. Some hubs do not implement port-power switching
501 * but only emulate it. In all cases, the ports won't work
502 * unless we send these messages to the hub.
503 */
504 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400506 else
507 dev_dbg(hub->intfdev, "trying to enable port power on "
508 "non-switchable hub\n");
509 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
510 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
David Brownellb7896962005-08-31 10:41:44 -0700512 /* Wait at least 100 msec for power to become stable */
513 msleep(max(pgood_delay, (unsigned) 100));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514}
515
Alan Stern02c399e2006-08-30 15:47:11 -0400516static void hub_quiesce(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517{
David Brownell979d5192005-09-22 22:32:24 -0700518 /* (nonblocking) khubd and related activity won't re-trigger */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 hub->quiescing = 1;
David Brownellc9f89fa2005-09-13 19:57:04 -0700520 hub->activating = 0;
David Brownell979d5192005-09-22 22:32:24 -0700521
David Brownell979d5192005-09-22 22:32:24 -0700522 /* (blocking) stop khubd and related activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 usb_kill_urb(hub->urb);
524 if (hub->has_indicators)
525 cancel_delayed_work(&hub->leds);
526 if (hub->has_indicators || hub->tt.hub)
527 flush_scheduled_work();
528}
529
530static void hub_activate(struct usb_hub *hub)
531{
532 int status;
533
534 hub->quiescing = 0;
535 hub->activating = 1;
Alan Stern40f122f2006-11-09 14:44:33 -0500536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 status = usb_submit_urb(hub->urb, GFP_NOIO);
538 if (status < 0)
539 dev_err(hub->intfdev, "activate --> %d\n", status);
540 if (hub->has_indicators && blinkenlights)
541 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
542
543 /* scan all ports ASAP */
544 kick_khubd(hub);
545}
546
547static int hub_hub_status(struct usb_hub *hub,
548 u16 *status, u16 *change)
549{
550 int ret;
551
Alan Sterndb90e7a2007-02-05 09:56:15 -0500552 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 ret = get_hub_status(hub->hdev, &hub->status->hub);
554 if (ret < 0)
555 dev_err (hub->intfdev,
556 "%s failed (err = %d)\n", __FUNCTION__, ret);
557 else {
558 *status = le16_to_cpu(hub->status->hub.wHubStatus);
559 *change = le16_to_cpu(hub->status->hub.wHubChange);
560 ret = 0;
561 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500562 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 return ret;
564}
565
Alan Stern8b28c752005-08-10 17:04:13 -0400566static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
567{
568 struct usb_device *hdev = hub->hdev;
Alan Stern0458d5b2007-05-04 11:52:20 -0400569 int ret = 0;
Alan Stern8b28c752005-08-10 17:04:13 -0400570
Alan Stern0458d5b2007-05-04 11:52:20 -0400571 if (hdev->children[port1-1] && set_state)
Alan Stern8b28c752005-08-10 17:04:13 -0400572 usb_set_device_state(hdev->children[port1-1],
573 USB_STATE_NOTATTACHED);
Alan Stern0458d5b2007-05-04 11:52:20 -0400574 if (!hub->error)
575 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
Alan Stern8b28c752005-08-10 17:04:13 -0400576 if (ret)
577 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
Alan Stern0458d5b2007-05-04 11:52:20 -0400578 port1, ret);
Alan Stern8b28c752005-08-10 17:04:13 -0400579 return ret;
580}
581
Alan Stern0458d5b2007-05-04 11:52:20 -0400582/*
583 * Disable a port and mark a logical connnect-change event, so that some
584 * time later khubd will disconnect() any existing usb_device on the port
585 * and will re-enumerate if there actually is a device attached.
586 */
587static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
588{
589 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
590 hub_port_disable(hub, port1, 1);
591
592 /* FIXME let caller ask to power down the port:
593 * - some devices won't enumerate without a VBUS power cycle
594 * - SRP saves power that way
595 * - ... new call, TBD ...
596 * That's easy if this hub can switch power per-port, and
597 * khubd reactivates the port later (timer, SRP, etc).
598 * Powerdown must be optional, because of reset/DFU.
599 */
600
601 set_bit(port1, hub->change_bits);
602 kick_khubd(hub);
603}
604
Alan Stern7d069b72005-11-18 12:06:34 -0500605/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -0400606static int hub_pre_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500607{
Alan Stern7de18d82006-06-01 13:37:24 -0400608 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternb41a60e2007-05-30 15:39:33 -0400609 struct usb_device *hdev = hub->hdev;
610 int i;
Alan Stern7d069b72005-11-18 12:06:34 -0500611
Alan Sternb41a60e2007-05-30 15:39:33 -0400612 /* Disconnect all the children */
613 for (i = 0; i < hdev->maxchild; ++i) {
614 if (hdev->children[i])
615 usb_disconnect(&hdev->children[i]);
616 }
Alan Stern7d069b72005-11-18 12:06:34 -0500617 hub_quiesce(hub);
Alan Sternf07600c2007-05-30 15:38:16 -0400618 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500619}
620
621/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -0400622static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -0500623{
Alan Stern7de18d82006-06-01 13:37:24 -0400624 struct usb_hub *hub = usb_get_intfdata(intf);
625
Alan Stern7d069b72005-11-18 12:06:34 -0500626 hub_power_on(hub);
Alan Stern0458d5b2007-05-04 11:52:20 -0400627 hub_activate(hub);
Alan Sternf07600c2007-05-30 15:38:16 -0400628 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -0500629}
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631static int hub_configure(struct usb_hub *hub,
632 struct usb_endpoint_descriptor *endpoint)
633{
634 struct usb_device *hdev = hub->hdev;
635 struct device *hub_dev = hub->intfdev;
636 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700637 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 unsigned int pipe;
639 int maxp, ret;
640 char *message;
641
642 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
643 &hub->buffer_dma);
644 if (!hub->buffer) {
645 message = "can't allocate hub irq buffer";
646 ret = -ENOMEM;
647 goto fail;
648 }
649
650 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
651 if (!hub->status) {
652 message = "can't kmalloc hub status buffer";
653 ret = -ENOMEM;
654 goto fail;
655 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500656 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
658 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
659 if (!hub->descriptor) {
660 message = "can't kmalloc hub descriptor";
661 ret = -ENOMEM;
662 goto fail;
663 }
664
665 /* Request the entire hub descriptor.
666 * hub->descriptor can handle USB_MAXCHILDREN ports,
667 * but the hub can/will return fewer bytes here.
668 */
669 ret = get_hub_descriptor(hdev, hub->descriptor,
670 sizeof(*hub->descriptor));
671 if (ret < 0) {
672 message = "can't read hub descriptor";
673 goto fail;
674 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
675 message = "hub has too many ports!";
676 ret = -ENODEV;
677 goto fail;
678 }
679
680 hdev->maxchild = hub->descriptor->bNbrPorts;
681 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
682 (hdev->maxchild == 1) ? "" : "s");
683
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700684 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700686 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 int i;
688 char portstr [USB_MAXCHILDREN + 1];
689
690 for (i = 0; i < hdev->maxchild; i++)
691 portstr[i] = hub->descriptor->DeviceRemovable
692 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
693 ? 'F' : 'R';
694 portstr[hdev->maxchild] = 0;
695 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
696 } else
697 dev_dbg(hub_dev, "standalone hub\n");
698
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700699 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 case 0x00:
701 dev_dbg(hub_dev, "ganged power switching\n");
702 break;
703 case 0x01:
704 dev_dbg(hub_dev, "individual port power switching\n");
705 break;
706 case 0x02:
707 case 0x03:
708 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
709 break;
710 }
711
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700712 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 case 0x00:
714 dev_dbg(hub_dev, "global over-current protection\n");
715 break;
716 case 0x08:
717 dev_dbg(hub_dev, "individual port over-current protection\n");
718 break;
719 case 0x10:
720 case 0x18:
721 dev_dbg(hub_dev, "no over-current protection\n");
722 break;
723 }
724
725 spin_lock_init (&hub->tt.lock);
726 INIT_LIST_HEAD (&hub->tt.clear_list);
David Howellsc4028952006-11-22 14:57:56 +0000727 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 switch (hdev->descriptor.bDeviceProtocol) {
729 case 0:
730 break;
731 case 1:
732 dev_dbg(hub_dev, "Single TT\n");
733 hub->tt.hub = hdev;
734 break;
735 case 2:
736 ret = usb_set_interface(hdev, 0, 1);
737 if (ret == 0) {
738 dev_dbg(hub_dev, "TT per port\n");
739 hub->tt.multi = 1;
740 } else
741 dev_err(hub_dev, "Using single TT (err %d)\n",
742 ret);
743 hub->tt.hub = hdev;
744 break;
745 default:
746 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
747 hdev->descriptor.bDeviceProtocol);
748 break;
749 }
750
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700751 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700752 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700753 case HUB_TTTT_8_BITS:
754 if (hdev->descriptor.bDeviceProtocol != 0) {
755 hub->tt.think_time = 666;
756 dev_dbg(hub_dev, "TT requires at most %d "
757 "FS bit times (%d ns)\n",
758 8, hub->tt.think_time);
759 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700761 case HUB_TTTT_16_BITS:
762 hub->tt.think_time = 666 * 2;
763 dev_dbg(hub_dev, "TT requires at most %d "
764 "FS bit times (%d ns)\n",
765 16, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700767 case HUB_TTTT_24_BITS:
768 hub->tt.think_time = 666 * 3;
769 dev_dbg(hub_dev, "TT requires at most %d "
770 "FS bit times (%d ns)\n",
771 24, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 break;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -0700773 case HUB_TTTT_32_BITS:
774 hub->tt.think_time = 666 * 4;
775 dev_dbg(hub_dev, "TT requires at most %d "
776 "FS bit times (%d ns)\n",
777 32, hub->tt.think_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 break;
779 }
780
781 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700782 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 hub->has_indicators = 1;
784 dev_dbg(hub_dev, "Port indicators are supported\n");
785 }
786
787 dev_dbg(hub_dev, "power on to power good time: %dms\n",
788 hub->descriptor->bPwrOn2PwrGood * 2);
789
790 /* power budgeting mostly matters with bus-powered hubs,
791 * and battery-powered root hubs (may provide just 8 mA).
792 */
793 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern55c52712005-11-23 12:03:12 -0500794 if (ret < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 message = "can't get hub status";
796 goto fail;
797 }
Alan Stern7d35b922005-04-25 11:18:32 -0400798 le16_to_cpus(&hubstatus);
799 if (hdev == hdev->bus->root_hub) {
Alan Stern55c52712005-11-23 12:03:12 -0500800 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
801 hub->mA_per_port = 500;
802 else {
803 hub->mA_per_port = hdev->bus_mA;
804 hub->limited_power = 1;
805 }
Alan Stern7d35b922005-04-25 11:18:32 -0400806 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
808 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -0500809 hub->limited_power = 1;
810 if (hdev->maxchild > 0) {
811 int remaining = hdev->bus_mA -
812 hub->descriptor->bHubContrCurrent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Alan Stern55c52712005-11-23 12:03:12 -0500814 if (remaining < hdev->maxchild * 100)
815 dev_warn(hub_dev,
816 "insufficient power available "
817 "to use all downstream ports\n");
818 hub->mA_per_port = 100; /* 7.2.1.1 */
819 }
820 } else { /* Self-powered external hub */
821 /* FIXME: What about battery-powered external hubs that
822 * provide less current per port? */
823 hub->mA_per_port = 500;
824 }
825 if (hub->mA_per_port < 500)
826 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
827 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
829 ret = hub_hub_status(hub, &hubstatus, &hubchange);
830 if (ret < 0) {
831 message = "can't get hub status";
832 goto fail;
833 }
834
835 /* local power status reports aren't always correct */
836 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
837 dev_dbg(hub_dev, "local power source is %s\n",
838 (hubstatus & HUB_STATUS_LOCAL_POWER)
839 ? "lost (inactive)" : "good");
840
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -0700841 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 dev_dbg(hub_dev, "%sover-current condition exists\n",
843 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
844
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -0700845 /* set up the interrupt endpoint
846 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
847 * bytes as USB2.0[11.12.3] says because some hubs are known
848 * to send more data (and thus cause overflow). For root hubs,
849 * maxpktsize is defined in hcd.c's fake endpoint descriptors
850 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
852 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
853
854 if (maxp > sizeof(*hub->buffer))
855 maxp = sizeof(*hub->buffer);
856
857 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
858 if (!hub->urb) {
859 message = "couldn't allocate interrupt urb";
860 ret = -ENOMEM;
861 goto fail;
862 }
863
864 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
865 hub, endpoint->bInterval);
866 hub->urb->transfer_dma = hub->buffer_dma;
867 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
868
869 /* maybe cycle the hub leds */
870 if (hub->has_indicators && blinkenlights)
871 hub->indicator [0] = INDICATOR_CYCLE;
872
873 hub_power_on(hub);
874 hub_activate(hub);
875 return 0;
876
877fail:
878 dev_err (hub_dev, "config failed, %s (err %d)\n",
879 message, ret);
880 /* hub_disconnect() frees urb and descriptor */
881 return ret;
882}
883
Alan Sterne8054852007-05-04 11:55:11 -0400884static void hub_release(struct kref *kref)
885{
886 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
887
888 usb_put_intf(to_usb_interface(hub->intfdev));
889 kfree(hub);
890}
891
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892static unsigned highspeed_hubs;
893
894static void hub_disconnect(struct usb_interface *intf)
895{
896 struct usb_hub *hub = usb_get_intfdata (intf);
Alan Sterne8054852007-05-04 11:55:11 -0400897
898 /* Take the hub off the event list and don't let it be added again */
899 spin_lock_irq(&hub_event_lock);
900 list_del_init(&hub->event_list);
901 hub->disconnected = 1;
902 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Alan Stern7de18d82006-06-01 13:37:24 -0400904 /* Disconnect all children and quiesce the hub */
905 hub->error = 0;
906 hub_pre_reset(intf);
907
Alan Stern8b28c752005-08-10 17:04:13 -0400908 usb_set_intfdata (intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Alan Sterne8054852007-05-04 11:55:11 -0400910 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 highspeed_hubs--;
912
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 usb_free_urb(hub->urb);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700914 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700915 kfree(hub->status);
Alan Sterne8054852007-05-04 11:55:11 -0400916 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
917 hub->buffer_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Alan Sterne8054852007-05-04 11:55:11 -0400919 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920}
921
922static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
923{
924 struct usb_host_interface *desc;
925 struct usb_endpoint_descriptor *endpoint;
926 struct usb_device *hdev;
927 struct usb_hub *hub;
928
929 desc = intf->cur_altsetting;
930 hdev = interface_to_usbdev(intf);
931
David Brownell89ccbdc2006-04-02 10:18:09 -0800932#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
933 if (hdev->parent) {
934 dev_warn(&intf->dev, "ignoring external hub\n");
935 return -ENODEV;
936 }
937#endif
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* Some hubs have a subclass of 1, which AFAICT according to the */
940 /* specs is not defined, but it works */
941 if ((desc->desc.bInterfaceSubClass != 0) &&
942 (desc->desc.bInterfaceSubClass != 1)) {
943descriptor_error:
944 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
945 return -EIO;
946 }
947
948 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
949 if (desc->desc.bNumEndpoints != 1)
950 goto descriptor_error;
951
952 endpoint = &desc->endpoint[0].desc;
953
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -0700954 /* If it's not an interrupt in endpoint, we'd better punt! */
955 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 goto descriptor_error;
957
958 /* We found a hub */
959 dev_info (&intf->dev, "USB hub found\n");
960
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400961 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 if (!hub) {
963 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
964 return -ENOMEM;
965 }
966
Alan Sterne8054852007-05-04 11:55:11 -0400967 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 INIT_LIST_HEAD(&hub->event_list);
969 hub->intfdev = &intf->dev;
970 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +0000971 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Sterne8054852007-05-04 11:55:11 -0400972 usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
974 usb_set_intfdata (intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -0500975 intf->needs_remote_wakeup = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
977 if (hdev->speed == USB_SPEED_HIGH)
978 highspeed_hubs++;
979
980 if (hub_configure(hub, endpoint) >= 0)
981 return 0;
982
983 hub_disconnect (intf);
984 return -ENODEV;
985}
986
987static int
988hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
989{
990 struct usb_device *hdev = interface_to_usbdev (intf);
991
992 /* assert ifno == 0 (part of hub spec) */
993 switch (code) {
994 case USBDEVFS_HUB_PORTINFO: {
995 struct usbdevfs_hub_portinfo *info = user_data;
996 int i;
997
998 spin_lock_irq(&device_state_lock);
999 if (hdev->devnum <= 0)
1000 info->nports = 0;
1001 else {
1002 info->nports = hdev->maxchild;
1003 for (i = 0; i < info->nports; i++) {
1004 if (hdev->children[i] == NULL)
1005 info->port[i] = 0;
1006 else
1007 info->port[i] =
1008 hdev->children[i]->devnum;
1009 }
1010 }
1011 spin_unlock_irq(&device_state_lock);
1012
1013 return info->nports + 1;
1014 }
1015
1016 default:
1017 return -ENOSYS;
1018 }
1019}
1020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1023{
1024 int i;
1025
1026 for (i = 0; i < udev->maxchild; ++i) {
1027 if (udev->children[i])
1028 recursively_mark_NOTATTACHED(udev->children[i]);
1029 }
Alan Sternee49fb52006-11-22 16:55:54 -05001030 if (udev->state == USB_STATE_SUSPENDED)
1031 udev->discon_suspended = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 udev->state = USB_STATE_NOTATTACHED;
1033}
1034
1035/**
1036 * usb_set_device_state - change a device's current state (usbcore, hcds)
1037 * @udev: pointer to device whose state should be changed
1038 * @new_state: new state value to be stored
1039 *
1040 * udev->state is _not_ fully protected by the device lock. Although
1041 * most transitions are made only while holding the lock, the state can
1042 * can change to USB_STATE_NOTATTACHED at almost any time. This
1043 * is so that devices can be marked as disconnected as soon as possible,
1044 * without having to wait for any semaphores to be released. As a result,
1045 * all changes to any device's state must be protected by the
1046 * device_state_lock spinlock.
1047 *
1048 * Once a device has been added to the device tree, all changes to its state
1049 * should be made using this routine. The state should _not_ be set directly.
1050 *
1051 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1052 * Otherwise udev->state is set to new_state, and if new_state is
1053 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1054 * to USB_STATE_NOTATTACHED.
1055 */
1056void usb_set_device_state(struct usb_device *udev,
1057 enum usb_device_state new_state)
1058{
1059 unsigned long flags;
1060
1061 spin_lock_irqsave(&device_state_lock, flags);
1062 if (udev->state == USB_STATE_NOTATTACHED)
1063 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001064 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001065
1066 /* root hub wakeup capabilities are managed out-of-band
1067 * and may involve silicon errata ... ignore them here.
1068 */
1069 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001070 if (udev->state == USB_STATE_SUSPENDED
1071 || new_state == USB_STATE_SUSPENDED)
1072 ; /* No change to wakeup settings */
1073 else if (new_state == USB_STATE_CONFIGURED)
David Brownellfb669cc2006-01-24 08:40:27 -08001074 device_init_wakeup(&udev->dev,
1075 (udev->actconfig->desc.bmAttributes
1076 & USB_CONFIG_ATT_WAKEUP));
Alan Stern645daaa2006-08-30 15:47:02 -04001077 else
David Brownellfb669cc2006-01-24 08:40:27 -08001078 device_init_wakeup(&udev->dev, 0);
1079 }
Alan Stern645daaa2006-08-30 15:47:02 -04001080 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001081 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 recursively_mark_NOTATTACHED(udev);
1083 spin_unlock_irqrestore(&device_state_lock, flags);
1084}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086static void choose_address(struct usb_device *udev)
1087{
1088 int devnum;
1089 struct usb_bus *bus = udev->bus;
1090
1091 /* If khubd ever becomes multithreaded, this will need a lock */
1092
1093 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1094 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1095 bus->devnum_next);
1096 if (devnum >= 128)
1097 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1098
1099 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1100
1101 if (devnum < 128) {
1102 set_bit(devnum, bus->devmap.devicemap);
1103 udev->devnum = devnum;
1104 }
1105}
1106
1107static void release_address(struct usb_device *udev)
1108{
1109 if (udev->devnum > 0) {
1110 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1111 udev->devnum = -1;
1112 }
1113}
1114
Alan Sternd5d4db72007-05-29 16:34:52 -04001115#ifdef CONFIG_USB_SUSPEND
1116
1117static void usb_stop_pm(struct usb_device *udev)
1118{
1119 /* Synchronize with the ksuspend thread to prevent any more
1120 * autosuspend requests from being submitted, and decrement
1121 * the parent's count of unsuspended children.
1122 */
1123 usb_pm_lock(udev);
1124 if (udev->parent && !udev->discon_suspended)
1125 usb_autosuspend_device(udev->parent);
1126 usb_pm_unlock(udev);
1127
1128 /* Stop any autosuspend requests already submitted */
1129 cancel_rearming_delayed_work(&udev->autosuspend);
1130}
1131
1132#else
1133
1134static inline void usb_stop_pm(struct usb_device *udev)
1135{ }
1136
1137#endif
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139/**
1140 * usb_disconnect - disconnect a device (usbcore-internal)
1141 * @pdev: pointer to device being disconnected
1142 * Context: !in_interrupt ()
1143 *
1144 * Something got disconnected. Get rid of it and all of its children.
1145 *
1146 * If *pdev is a normal device then the parent hub must already be locked.
1147 * If *pdev is a root hub then this routine will acquire the
1148 * usb_bus_list_lock on behalf of the caller.
1149 *
1150 * Only hub drivers (including virtual root hub drivers for host
1151 * controllers) should ever call this.
1152 *
1153 * This call is synchronous, and may not be used in an interrupt context.
1154 */
1155void usb_disconnect(struct usb_device **pdev)
1156{
1157 struct usb_device *udev = *pdev;
1158 int i;
1159
1160 if (!udev) {
1161 pr_debug ("%s nodev\n", __FUNCTION__);
1162 return;
1163 }
1164
1165 /* mark the device as inactive, so any further urb submissions for
1166 * this device (and any of its children) will fail immediately.
1167 * this quiesces everyting except pending urbs.
1168 */
1169 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1171
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001172 usb_lock_device(udev);
1173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 /* Free up all the children before we remove this device */
1175 for (i = 0; i < USB_MAXCHILDREN; i++) {
1176 if (udev->children[i])
1177 usb_disconnect(&udev->children[i]);
1178 }
1179
1180 /* deallocate hcd/hardware state ... nuking all pending urbs and
1181 * cleaning up all state associated with the current configuration
1182 * so that the hardware is now fully quiesced.
1183 */
Alan Stern782da722006-07-01 22:09:35 -04001184 dev_dbg (&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 usb_disable_device(udev, 0);
1186
Alan Stern782da722006-07-01 22:09:35 -04001187 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001188
Alan Stern782da722006-07-01 22:09:35 -04001189 /* Unregister the device. The device driver is responsible
1190 * for removing the device files from usbfs and sysfs and for
1191 * de-configuring the device.
1192 */
1193 device_del(&udev->dev);
1194
1195 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 * (or root_hub) pointer.
1197 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 release_address(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
1200 /* Avoid races with recursively_mark_NOTATTACHED() */
1201 spin_lock_irq(&device_state_lock);
1202 *pdev = NULL;
1203 spin_unlock_irq(&device_state_lock);
1204
Alan Sternd5d4db72007-05-29 16:34:52 -04001205 usb_stop_pm(udev);
Alan Sternee49fb52006-11-22 16:55:54 -05001206
Alan Stern782da722006-07-01 22:09:35 -04001207 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208}
1209
1210#ifdef DEBUG
1211static void show_string(struct usb_device *udev, char *id, char *string)
1212{
1213 if (!string)
1214 return;
1215 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1216}
1217
1218#else
1219static inline void show_string(struct usb_device *udev, char *id, char *string)
1220{}
1221#endif
1222
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
1224#ifdef CONFIG_USB_OTG
1225#include "otg_whitelist.h"
1226#endif
1227
Oliver Neukum3ede7602007-01-11 14:35:50 +01001228/**
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001229 * usb_configure_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01001230 * @udev: newly addressed device (in ADDRESS state)
1231 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001232 * Do configuration for On-The-Go devices
Oliver Neukum3ede7602007-01-11 14:35:50 +01001233 */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001234static int usb_configure_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001236 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238#ifdef CONFIG_USB_OTG
1239 /*
1240 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1241 * to wake us after we've powered off VBUS; and HNP, switching roles
1242 * "host" to "peripheral". The OTG descriptor helps figure this out.
1243 */
1244 if (!udev->bus->is_b_host
1245 && udev->config
1246 && udev->parent == udev->bus->root_hub) {
1247 struct usb_otg_descriptor *desc = 0;
1248 struct usb_bus *bus = udev->bus;
1249
1250 /* descriptor may appear anywhere in config */
1251 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1252 le16_to_cpu(udev->config[0].desc.wTotalLength),
1253 USB_DT_OTG, (void **) &desc) == 0) {
1254 if (desc->bmAttributes & USB_OTG_HNP) {
Alan Stern12c3da32005-11-23 12:09:52 -05001255 unsigned port1 = udev->portnum;
David Brownellfc849b82006-09-18 16:53:26 -07001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 dev_info(&udev->dev,
1258 "Dual-Role OTG device on %sHNP port\n",
1259 (port1 == bus->otg_port)
1260 ? "" : "non-");
1261
1262 /* enable HNP before suspend, it's simpler */
1263 if (port1 == bus->otg_port)
1264 bus->b_hnp_enable = 1;
1265 err = usb_control_msg(udev,
1266 usb_sndctrlpipe(udev, 0),
1267 USB_REQ_SET_FEATURE, 0,
1268 bus->b_hnp_enable
1269 ? USB_DEVICE_B_HNP_ENABLE
1270 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1271 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1272 if (err < 0) {
1273 /* OTG MESSAGE: report errors here,
1274 * customize to match your product.
1275 */
1276 dev_info(&udev->dev,
1277 "can't set HNP mode; %d\n",
1278 err);
1279 bus->b_hnp_enable = 0;
1280 }
1281 }
1282 }
1283 }
1284
1285 if (!is_targeted(udev)) {
1286
1287 /* Maybe it can talk to us, though we can't talk to it.
1288 * (Includes HNP test device.)
1289 */
1290 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
Alan Stern4956ecc2007-05-30 16:51:28 -04001291 err = usb_port_suspend(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 if (err < 0)
1293 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1294 }
Vikram Panditaffcdc182007-05-25 21:31:07 -07001295 err = -ENOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 goto fail;
1297 }
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001298fail:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001300 return err;
1301}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001303
1304/**
1305 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1306 * @udev: newly addressed device (in ADDRESS state)
1307 *
1308 * This is only called by usb_new_device() and usb_authorize_device()
1309 * and FIXME -- all comments that apply to them apply here wrt to
1310 * environment.
1311 *
1312 * If the device is WUSB and not authorized, we don't attempt to read
1313 * the string descriptors, as they will be errored out by the device
1314 * until it has been authorized.
1315 */
1316static int usb_configure_device(struct usb_device *udev)
1317{
1318 int err;
1319
1320 if (udev->config == NULL) {
1321 err = usb_get_configuration(udev);
1322 if (err < 0) {
1323 dev_err(&udev->dev, "can't read configurations, error %d\n",
1324 err);
1325 goto fail;
1326 }
1327 }
1328 if (udev->wusb == 1 && udev->authorized == 0) {
1329 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1330 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1331 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1332 }
1333 else {
1334 /* read the standard strings and cache them if present */
1335 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1336 udev->manufacturer = usb_cache_string(udev,
1337 udev->descriptor.iManufacturer);
1338 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1339 }
1340 err = usb_configure_device_otg(udev);
1341fail:
1342 return err;
1343}
1344
1345
1346/**
1347 * usb_new_device - perform initial device setup (usbcore-internal)
1348 * @udev: newly addressed device (in ADDRESS state)
1349 *
1350 * This is called with devices which have been enumerated, but not yet
1351 * configured. The device descriptor is available, but not descriptors
1352 * for any device configuration. The caller must have locked either
1353 * the parent hub (if udev is a normal device) or else the
1354 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1355 * udev has already been installed, but udev is not yet visible through
1356 * sysfs or other filesystem code.
1357 *
1358 * It will return if the device is configured properly or not. Zero if
1359 * the interface was registered with the driver core; else a negative
1360 * errno value.
1361 *
1362 * This call is synchronous, and may not be used in an interrupt context.
1363 *
1364 * Only the hub driver or root-hub registrar should ever call this.
1365 */
1366int usb_new_device(struct usb_device *udev)
1367{
1368 int err;
1369
1370 usb_detect_quirks(udev); /* Determine quirks */
1371 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1372 if (err < 0)
1373 goto fail;
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001374 /* export the usbdev device-node for libusb */
1375 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1376 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1377
Alan Stern195af2c2007-07-16 15:28:19 -04001378 /* Increment the parent's count of unsuspended children */
1379 if (udev->parent)
1380 usb_autoresume_device(udev->parent);
1381
Alan Stern782da722006-07-01 22:09:35 -04001382 /* Register the device. The device driver is responsible
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001383 * for adding the device files to sysfs and for configuring
1384 * the device.
Alan Stern782da722006-07-01 22:09:35 -04001385 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001386 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 if (err) {
1388 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1389 goto fail;
1390 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001391
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001392 /* Tell the world! */
1393 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1394 "SerialNumber=%d\n",
1395 udev->descriptor.iManufacturer,
1396 udev->descriptor.iProduct,
1397 udev->descriptor.iSerialNumber);
1398 show_string(udev, "Product", udev->product);
1399 show_string(udev, "Manufacturer", udev->manufacturer);
1400 show_string(udev, "SerialNumber", udev->serial);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07001401 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403fail:
1404 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07001405 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406}
1407
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001408
1409/**
1410 * Similar to usb_disconnect()
1411 *
1412 * We share a lock (that we have) with device_del(), so we need to
1413 * defer its call.
1414 */
1415int usb_deauthorize_device(struct usb_device *usb_dev)
1416{
1417 unsigned cnt;
1418 usb_lock_device(usb_dev);
1419 if (usb_dev->authorized == 0)
1420 goto out_unauthorized;
1421 usb_dev->authorized = 0;
1422 usb_set_configuration(usb_dev, -1);
1423 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1424 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1425 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1426 kfree(usb_dev->config);
1427 usb_dev->config = NULL;
1428 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1429 kfree(usb_dev->rawdescriptors[cnt]);
1430 usb_dev->descriptor.bNumConfigurations = 0;
1431 kfree(usb_dev->rawdescriptors);
1432out_unauthorized:
1433 usb_unlock_device(usb_dev);
1434 return 0;
1435}
1436
1437
1438int usb_authorize_device(struct usb_device *usb_dev)
1439{
1440 int result = 0, c;
1441 usb_lock_device(usb_dev);
1442 if (usb_dev->authorized == 1)
1443 goto out_authorized;
1444 kfree(usb_dev->product);
1445 usb_dev->product = NULL;
1446 kfree(usb_dev->manufacturer);
1447 usb_dev->manufacturer = NULL;
1448 kfree(usb_dev->serial);
1449 usb_dev->serial = NULL;
1450 result = usb_autoresume_device(usb_dev);
1451 if (result < 0) {
1452 dev_err(&usb_dev->dev,
1453 "can't autoresume for authorization: %d\n", result);
1454 goto error_autoresume;
1455 }
1456 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1457 if (result < 0) {
1458 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1459 "authorization: %d\n", result);
1460 goto error_device_descriptor;
1461 }
1462 usb_dev->authorized = 1;
1463 result = usb_configure_device(usb_dev);
1464 if (result < 0)
1465 goto error_configure;
1466 /* Choose and set the configuration. This registers the interfaces
1467 * with the driver core and lets interface drivers bind to them.
1468 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06001469 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07001470 if (c >= 0) {
1471 result = usb_set_configuration(usb_dev, c);
1472 if (result) {
1473 dev_err(&usb_dev->dev,
1474 "can't set config #%d, error %d\n", c, result);
1475 /* This need not be fatal. The user can try to
1476 * set other configurations. */
1477 }
1478 }
1479 dev_info(&usb_dev->dev, "authorized to connect\n");
1480error_configure:
1481error_device_descriptor:
1482error_autoresume:
1483out_authorized:
1484 usb_unlock_device(usb_dev); // complements locktree
1485 return result;
1486}
1487
1488
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489static int hub_port_status(struct usb_hub *hub, int port1,
1490 u16 *status, u16 *change)
1491{
1492 int ret;
1493
Alan Sterndb90e7a2007-02-05 09:56:15 -05001494 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 ret = get_port_status(hub->hdev, port1, &hub->status->port);
Alan Sternd25450c2006-11-20 11:14:30 -05001496 if (ret < 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 dev_err (hub->intfdev,
1498 "%s failed (err = %d)\n", __FUNCTION__, ret);
Alan Sternd25450c2006-11-20 11:14:30 -05001499 if (ret >= 0)
1500 ret = -EIO;
1501 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 *status = le16_to_cpu(hub->status->port.wPortStatus);
1503 *change = le16_to_cpu(hub->status->port.wPortChange);
1504 ret = 0;
1505 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001506 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 return ret;
1508}
1509
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001510
1511/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1512static unsigned hub_is_wusb(struct usb_hub *hub)
1513{
1514 struct usb_hcd *hcd;
1515 if (hub->hdev->parent != NULL) /* not a root hub? */
1516 return 0;
1517 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1518 return hcd->wireless;
1519}
1520
1521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522#define PORT_RESET_TRIES 5
1523#define SET_ADDRESS_TRIES 2
1524#define GET_DESCRIPTOR_TRIES 2
1525#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1526#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1527
1528#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1529#define HUB_SHORT_RESET_TIME 10
1530#define HUB_LONG_RESET_TIME 200
1531#define HUB_RESET_TIMEOUT 500
1532
1533static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1534 struct usb_device *udev, unsigned int delay)
1535{
1536 int delay_time, ret;
1537 u16 portstatus;
1538 u16 portchange;
1539
1540 for (delay_time = 0;
1541 delay_time < HUB_RESET_TIMEOUT;
1542 delay_time += delay) {
1543 /* wait to give the device a chance to reset */
1544 msleep(delay);
1545
1546 /* read and decode port status */
1547 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1548 if (ret < 0)
1549 return ret;
1550
1551 /* Device went away? */
1552 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1553 return -ENOTCONN;
1554
Alan Sterndd4dd192007-05-04 11:55:54 -04001555 /* bomb out completely if the connection bounced */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 if ((portchange & USB_PORT_STAT_C_CONNECTION))
Alan Sterndd4dd192007-05-04 11:55:54 -04001557 return -ENOTCONN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 /* if we`ve finished resetting, then break out of the loop */
1560 if (!(portstatus & USB_PORT_STAT_RESET) &&
1561 (portstatus & USB_PORT_STAT_ENABLE)) {
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07001562 if (hub_is_wusb(hub))
1563 udev->speed = USB_SPEED_VARIABLE;
1564 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 udev->speed = USB_SPEED_HIGH;
1566 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1567 udev->speed = USB_SPEED_LOW;
1568 else
1569 udev->speed = USB_SPEED_FULL;
1570 return 0;
1571 }
1572
1573 /* switch to the long delay after two short delay failures */
1574 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1575 delay = HUB_LONG_RESET_TIME;
1576
1577 dev_dbg (hub->intfdev,
1578 "port %d not reset yet, waiting %dms\n",
1579 port1, delay);
1580 }
1581
1582 return -EBUSY;
1583}
1584
1585static int hub_port_reset(struct usb_hub *hub, int port1,
1586 struct usb_device *udev, unsigned int delay)
1587{
1588 int i, status;
1589
Alan Stern32fe0192007-10-10 16:27:07 -04001590 /* Block EHCI CF initialization during the port reset.
1591 * Some companion controllers don't like it when they mix.
1592 */
1593 down_read(&ehci_cf_port_reset_rwsem);
1594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 /* Reset the port */
1596 for (i = 0; i < PORT_RESET_TRIES; i++) {
1597 status = set_port_feature(hub->hdev,
1598 port1, USB_PORT_FEAT_RESET);
1599 if (status)
1600 dev_err(hub->intfdev,
1601 "cannot reset port %d (err = %d)\n",
1602 port1, status);
1603 else {
1604 status = hub_port_wait_reset(hub, port1, udev, delay);
David Brownelldd165252005-08-31 10:45:25 -07001605 if (status && status != -ENOTCONN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 dev_dbg(hub->intfdev,
1607 "port_wait_reset: err = %d\n",
1608 status);
1609 }
1610
1611 /* return on disconnect or reset */
1612 switch (status) {
1613 case 0:
David Brownellb7896962005-08-31 10:41:44 -07001614 /* TRSTRCY = 10 ms; plus some extra */
1615 msleep(10 + 40);
Alan Stern4326ed02007-07-30 17:08:43 -04001616 udev->devnum = 0; /* Device now at address 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 /* FALL THROUGH */
1618 case -ENOTCONN:
1619 case -ENODEV:
1620 clear_port_feature(hub->hdev,
1621 port1, USB_PORT_FEAT_C_RESET);
1622 /* FIXME need disconnect() for NOTATTACHED device */
1623 usb_set_device_state(udev, status
1624 ? USB_STATE_NOTATTACHED
1625 : USB_STATE_DEFAULT);
Alan Stern32fe0192007-10-10 16:27:07 -04001626 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 }
1628
1629 dev_dbg (hub->intfdev,
1630 "port %d not enabled, trying reset again...\n",
1631 port1);
1632 delay = HUB_LONG_RESET_TIME;
1633 }
1634
1635 dev_err (hub->intfdev,
1636 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1637 port1);
1638
Alan Stern32fe0192007-10-10 16:27:07 -04001639 done:
1640 up_read(&ehci_cf_port_reset_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 return status;
1642}
1643
Alan Sternd388dab2006-07-01 22:14:24 -04001644#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
1646#ifdef CONFIG_USB_SUSPEND
1647
1648/*
Alan Stern140d8f62006-07-01 22:07:21 -04001649 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04001650 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07001651 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 *
1653 * Suspends a USB device that isn't in active use, conserving power.
1654 * Devices may wake out of a suspend, if anything important happens,
1655 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04001656 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 * to disconnect devices while they are suspended.
1658 *
David Brownell390a8c32005-09-13 19:57:27 -07001659 * This only affects the USB hardware for a device; its interfaces
1660 * (and, for hubs, child devices) must already have been suspended.
1661 *
Alan Stern624d6c02007-05-30 15:35:16 -04001662 * Selective port suspend reduces power; most suspended devices draw
1663 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1664 * All devices below the suspended port are also suspended.
1665 *
1666 * Devices leave suspend state when the host wakes them up. Some devices
1667 * also support "remote wakeup", where the device can activate the USB
1668 * tree above them to deliver data, such as a keypress or packet. In
1669 * some cases, this wakes the USB host.
1670 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 * Suspending OTG devices may trigger HNP, if that's been enabled
1672 * between a pair of dual-role devices. That will change roles, such
1673 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1674 *
Alan Stern4956ecc2007-05-30 16:51:28 -04001675 * Devices on USB hub ports have only one "suspend" state, corresponding
1676 * to ACPI D2, "may cause the device to lose some context".
1677 * State transitions include:
1678 *
1679 * - suspend, resume ... when the VBUS power link stays live
1680 * - suspend, disconnect ... VBUS lost
1681 *
1682 * Once VBUS drop breaks the circuit, the port it's using has to go through
1683 * normal re-enumeration procedures, starting with enabling VBUS power.
1684 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1685 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1686 * timer, no SRP, no requests through sysfs.
1687 *
1688 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1689 * the root hub for their bus goes into global suspend ... so we don't
1690 * (falsely) update the device power state to say it suspended.
1691 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 * Returns 0 on success, else negative errno.
1693 */
Alan Stern140d8f62006-07-01 22:07:21 -04001694int usb_port_suspend(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695{
Alan Stern624d6c02007-05-30 15:35:16 -04001696 struct usb_hub *hub = hdev_to_hub(udev->parent);
1697 int port1 = udev->portnum;
1698 int status;
Alan Stern4956ecc2007-05-30 16:51:28 -04001699
Alan Stern624d6c02007-05-30 15:35:16 -04001700 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1701
1702 /* enable remote wakeup when appropriate; this lets the device
1703 * wake up the upstream hub (including maybe the root hub).
1704 *
1705 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1706 * we don't explicitly enable it here.
1707 */
1708 if (udev->do_remote_wakeup) {
1709 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1710 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1711 USB_DEVICE_REMOTE_WAKEUP, 0,
1712 NULL, 0,
1713 USB_CTRL_SET_TIMEOUT);
1714 if (status)
1715 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
1716 status);
1717 }
1718
1719 /* see 7.1.7.6 */
1720 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1721 if (status) {
1722 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
1723 port1, status);
1724 /* paranoia: "should not happen" */
1725 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1726 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1727 USB_DEVICE_REMOTE_WAKEUP, 0,
1728 NULL, 0,
1729 USB_CTRL_SET_TIMEOUT);
1730 } else {
1731 /* device has up to 10 msec to fully suspend */
1732 dev_dbg(&udev->dev, "usb %ssuspend\n",
1733 udev->auto_pm ? "auto-" : "");
1734 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1735 msleep(10);
1736 }
Alan Stern4956ecc2007-05-30 16:51:28 -04001737 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738}
David Brownellf3f32532005-09-22 22:37:29 -07001739
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740/*
David Brownell390a8c32005-09-13 19:57:27 -07001741 * If the USB "suspend" state is in use (rather than "global suspend"),
1742 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04001743 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 * hardware resume signaling is finished, either because of selective
1745 * resume (by host) or remote wakeup (by device) ... now see what changed
1746 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04001747 *
1748 * If @udev->reset_resume is set then the device is reset before the
1749 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 */
Alan Stern140d8f62006-07-01 22:07:21 -04001751static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752{
Alan Stern54515fe2007-05-30 15:38:58 -04001753 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 u16 devstatus;
1755
1756 /* caller owns the udev device lock */
Alan Stern54515fe2007-05-30 15:38:58 -04001757 dev_dbg(&udev->dev, "finish %sresume\n",
1758 udev->reset_resume ? "reset-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
1760 /* usb ch9 identifies four variants of SUSPENDED, based on what
1761 * state the device resumes to. Linux currently won't see the
1762 * first two on the host side; they'd be inside hub_port_init()
1763 * during many timeouts, but khubd can't suspend until later.
1764 */
1765 usb_set_device_state(udev, udev->actconfig
1766 ? USB_STATE_CONFIGURED
1767 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
Alan Stern54515fe2007-05-30 15:38:58 -04001769 /* 10.5.4.5 says not to reset a suspended port if the attached
1770 * device is enabled for remote wakeup. Hence the reset
1771 * operation is carried out here, after the port has been
1772 * resumed.
1773 */
1774 if (udev->reset_resume)
1775 status = usb_reset_device(udev);
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 /* 10.5.4.5 says be sure devices in the tree are still there.
1778 * For now let's assume the device didn't go crazy on resume,
1779 * and device drivers will know about any resume quirks.
1780 */
Alan Stern54515fe2007-05-30 15:38:58 -04001781 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04001782 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04001783 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1784 if (status >= 0)
Alan Stern46dede42007-08-14 10:56:10 -04001785 status = (status > 0 ? 0 : -ENODEV);
Alan Stern54515fe2007-05-30 15:38:58 -04001786 }
Alan Sternb40b7a92006-06-19 15:12:38 -04001787
Alan Stern624d6c02007-05-30 15:35:16 -04001788 if (status) {
1789 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
1790 status);
1791 } else if (udev->actconfig) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 le16_to_cpus(&devstatus);
Alan Stern686314c2007-05-30 15:34:36 -04001793 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 status = usb_control_msg(udev,
1795 usb_sndctrlpipe(udev, 0),
1796 USB_REQ_CLEAR_FEATURE,
1797 USB_RECIP_DEVICE,
1798 USB_DEVICE_REMOTE_WAKEUP, 0,
1799 NULL, 0,
1800 USB_CTRL_SET_TIMEOUT);
Alan Sterna8e7c562006-07-01 22:11:02 -04001801 if (status)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 dev_dbg(&udev->dev, "disable remote "
1803 "wakeup, status %d\n", status);
Alan Stern4bf0ba82005-11-21 11:58:07 -05001804 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
1807 return status;
1808}
1809
Alan Stern624d6c02007-05-30 15:35:16 -04001810/*
1811 * usb_port_resume - re-activate a suspended usb device's upstream port
1812 * @udev: device to re-activate, not a root hub
1813 * Context: must be able to sleep; device not locked; pm locks held
1814 *
1815 * This will re-activate the suspended device, increasing power usage
1816 * while letting drivers communicate again with its endpoints.
1817 * USB resume explicitly guarantees that the power session between
1818 * the host and the device is the same as it was when the device
1819 * suspended.
1820 *
Alan Stern54515fe2007-05-30 15:38:58 -04001821 * If CONFIG_USB_PERSIST and @udev->reset_resume are both set then this
1822 * routine won't check that the port is still enabled. Furthermore,
1823 * if @udev->reset_resume is set then finish_port_resume() above will
1824 * reset @udev. The end result is that a broken power session can be
1825 * recovered and @udev will appear to persist across a loss of VBUS power.
1826 *
1827 * For example, if a host controller doesn't maintain VBUS suspend current
1828 * during a system sleep or is reset when the system wakes up, all the USB
1829 * power sessions below it will be broken. This is especially troublesome
1830 * for mass-storage devices containing mounted filesystems, since the
1831 * device will appear to have disconnected and all the memory mappings
1832 * to it will be lost. Using the USB_PERSIST facility, the device can be
1833 * made to appear as if it had not disconnected.
1834 *
1835 * This facility is inherently dangerous. Although usb_reset_device()
1836 * makes every effort to insure that the same device is present after the
1837 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1838 * quite possible for a device to remain unaltered but its media to be
1839 * changed. If the user replaces a flash memory card while the system is
1840 * asleep, he will have only himself to blame when the filesystem on the
1841 * new card is corrupted and the system crashes.
1842 *
Alan Stern624d6c02007-05-30 15:35:16 -04001843 * Returns 0 on success, else negative errno.
1844 */
1845int usb_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846{
Alan Stern624d6c02007-05-30 15:35:16 -04001847 struct usb_hub *hub = hdev_to_hub(udev->parent);
1848 int port1 = udev->portnum;
1849 int status;
1850 u16 portchange, portstatus;
Alan Stern54515fe2007-05-30 15:38:58 -04001851 unsigned mask_flags, want_flags;
Alan Sternd25450c2006-11-20 11:14:30 -05001852
1853 /* Skip the initial Clear-Suspend step for a remote wakeup */
1854 status = hub_port_status(hub, port1, &portstatus, &portchange);
1855 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1856 goto SuspendCleared;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
1858 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1859
Alan Sternd5cbad42006-08-11 16:52:39 -04001860 set_bit(port1, hub->busy_bits);
1861
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 /* see 7.1.7.7; affects power usage, but not budgeting */
1863 status = clear_port_feature(hub->hdev,
1864 port1, USB_PORT_FEAT_SUSPEND);
1865 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04001866 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
1867 port1, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 /* drive resume for at least 20 msec */
Alan Stern686314c2007-05-30 15:34:36 -04001870 dev_dbg(&udev->dev, "usb %sresume\n",
1871 udev->auto_pm ? "auto-" : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 msleep(25);
1873
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1875 * stop resume signaling. Then finish the resume
1876 * sequence.
1877 */
Alan Sternd25450c2006-11-20 11:14:30 -05001878 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04001879
1880 SuspendCleared:
1881 if (USB_PERSIST && udev->reset_resume)
1882 want_flags = USB_PORT_STAT_POWER
1883 | USB_PORT_STAT_CONNECTION;
1884 else
1885 want_flags = USB_PORT_STAT_POWER
1886 | USB_PORT_STAT_CONNECTION
1887 | USB_PORT_STAT_ENABLE;
1888 mask_flags = want_flags | USB_PORT_STAT_SUSPEND;
1889
1890 if (status < 0 || (portstatus & mask_flags) != want_flags) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 dev_dbg(hub->intfdev,
1892 "port %d status %04x.%04x after resume, %d\n",
Alan Sternd25450c2006-11-20 11:14:30 -05001893 port1, portchange, portstatus, status);
Alan Stern20307942006-06-28 11:20:41 -04001894 if (status >= 0)
1895 status = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 } else {
Alan Stern20307942006-06-28 11:20:41 -04001897 if (portchange & USB_PORT_STAT_C_SUSPEND)
1898 clear_port_feature(hub->hdev, port1,
1899 USB_PORT_FEAT_C_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 /* TRSMRCY = 10 msec */
1901 msleep(10);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 }
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Alan Sternd5cbad42006-08-11 16:52:39 -04001905 clear_bit(port1, hub->busy_bits);
1906 if (!hub->hdev->parent && !hub->busy_bits[0])
1907 usb_enable_root_hub_irq(hub->hdev->bus);
1908
Alan Stern54515fe2007-05-30 15:38:58 -04001909 if (status == 0)
1910 status = finish_port_resume(udev);
1911 if (status < 0) {
1912 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1913 hub_port_logical_disconnect(hub, port1);
1914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 return status;
1916}
1917
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918static int remote_wakeup(struct usb_device *udev)
1919{
1920 int status = 0;
1921
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001922 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04001924 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern19410442007-03-27 13:33:59 -04001925 usb_mark_last_busy(udev);
Alan Stern6b157c92007-03-13 16:37:30 -04001926 status = usb_external_resume_device(udev);
Alan Sternd25450c2006-11-20 11:14:30 -05001927 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05001928 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 return status;
1930}
1931
Alan Sternd388dab2006-07-01 22:14:24 -04001932#else /* CONFIG_USB_SUSPEND */
1933
1934/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1935
1936int usb_port_suspend(struct usb_device *udev)
1937{
1938 return 0;
1939}
1940
Alan Sternd388dab2006-07-01 22:14:24 -04001941int usb_port_resume(struct usb_device *udev)
1942{
Alan Stern54515fe2007-05-30 15:38:58 -04001943 int status = 0;
1944
1945 /* However we may need to do a reset-resume */
1946 if (udev->reset_resume) {
1947 dev_dbg(&udev->dev, "reset-resume\n");
1948 status = usb_reset_device(udev);
1949 }
1950 return status;
Alan Sternd388dab2006-07-01 22:14:24 -04001951}
1952
1953static inline int remote_wakeup(struct usb_device *udev)
1954{
1955 return 0;
1956}
1957
1958#endif
1959
David Brownelldb690872005-09-13 19:56:33 -07001960static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961{
1962 struct usb_hub *hub = usb_get_intfdata (intf);
1963 struct usb_device *hdev = hub->hdev;
1964 unsigned port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
David Brownellc9f89fa2005-09-13 19:57:04 -07001966 /* fail if children aren't already suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1968 struct usb_device *udev;
1969
1970 udev = hdev->children [port1-1];
Alan Stern6840d252007-09-10 11:34:26 -04001971 if (udev && udev->can_submit) {
Alan Stern645daaa2006-08-30 15:47:02 -04001972 if (!hdev->auto_pm)
1973 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1974 port1);
David Brownellc9f89fa2005-09-13 19:57:04 -07001975 return -EBUSY;
1976 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 }
1978
Alan Stern40f122f2006-11-09 14:44:33 -05001979 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1980
David Brownellc9f89fa2005-09-13 19:57:04 -07001981 /* stop khubd and related activity */
1982 hub_quiesce(hub);
Alan Sternb6f64362007-05-04 11:51:54 -04001983 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984}
1985
1986static int hub_resume(struct usb_interface *intf)
1987{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 struct usb_hub *hub = usb_get_intfdata (intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Alan Stern40f122f2006-11-09 14:44:33 -05001990 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1991
Alan Sterna8e7c562006-07-01 22:11:02 -04001992 /* tell khubd to look for changes on this hub */
David Brownellf3f32532005-09-22 22:37:29 -07001993 hub_activate(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 return 0;
1995}
1996
Alan Sternb41a60e2007-05-30 15:39:33 -04001997static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04001998{
Alan Sternb41a60e2007-05-30 15:39:33 -04001999 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04002000 struct usb_device *hdev = hub->hdev;
2001 int port1;
2002
Alan Sternb41a60e2007-05-30 15:39:33 -04002003 hub_power_on(hub);
2004
Alan Sternf07600c2007-05-30 15:38:16 -04002005 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2006 struct usb_device *child = hdev->children[port1-1];
2007
2008 if (child) {
Alan Sternb41a60e2007-05-30 15:39:33 -04002009
2010 /* For "USB_PERSIST"-enabled children we must
2011 * mark the child device for reset-resume and
2012 * turn off the connect-change status to prevent
2013 * khubd from disconnecting it later.
2014 */
2015 if (USB_PERSIST && child->persist_enabled) {
2016 child->reset_resume = 1;
2017 clear_port_feature(hdev, port1,
2018 USB_PORT_FEAT_C_CONNECTION);
2019
2020 /* Otherwise we must disconnect the child,
2021 * but as we may not lock the child device here
2022 * we have to do a "logical" disconnect.
2023 */
2024 } else {
2025 hub_port_logical_disconnect(hub, port1);
2026 }
Alan Sternf07600c2007-05-30 15:38:16 -04002027 }
2028 }
Alan Sternf07600c2007-05-30 15:38:16 -04002029
Alan Sternf07600c2007-05-30 15:38:16 -04002030 hub_activate(hub);
2031 return 0;
2032}
2033
Alan Stern54515fe2007-05-30 15:38:58 -04002034/**
2035 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2036 * @rhdev: struct usb_device for the root hub
2037 *
2038 * The USB host controller driver calls this function when its root hub
2039 * is resumed and Vbus power has been interrupted or the controller
2040 * has been reset. The routine marks @rhdev as having lost power. When
2041 * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
2042 * is enabled then it will carry out power-session recovery, otherwise
2043 * it will disconnect all the child devices.
2044 */
2045void usb_root_hub_lost_power(struct usb_device *rhdev)
2046{
2047 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2048 rhdev->reset_resume = 1;
2049}
2050EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2051
Alan Sternd388dab2006-07-01 22:14:24 -04002052#else /* CONFIG_PM */
2053
2054static inline int remote_wakeup(struct usb_device *udev)
2055{
2056 return 0;
2057}
2058
Alan Sternf07600c2007-05-30 15:38:16 -04002059#define hub_suspend NULL
2060#define hub_resume NULL
2061#define hub_reset_resume NULL
Alan Sternd388dab2006-07-01 22:14:24 -04002062#endif
2063
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064
2065/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2066 *
2067 * Between connect detection and reset signaling there must be a delay
2068 * of 100ms at least for debounce and power-settling. The corresponding
2069 * timer shall restart whenever the downstream port detects a disconnect.
2070 *
2071 * Apparently there are some bluetooth and irda-dongles and a number of
2072 * low-speed devices for which this debounce period may last over a second.
2073 * Not covered by the spec - but easy to deal with.
2074 *
2075 * This implementation uses a 1500ms total debounce timeout; if the
2076 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2077 * every 25ms for transient disconnects. When the port status has been
2078 * unchanged for 100ms it returns the port status.
2079 */
2080
2081#define HUB_DEBOUNCE_TIMEOUT 1500
2082#define HUB_DEBOUNCE_STEP 25
2083#define HUB_DEBOUNCE_STABLE 100
2084
2085static int hub_port_debounce(struct usb_hub *hub, int port1)
2086{
2087 int ret;
2088 int total_time, stable_time = 0;
2089 u16 portchange, portstatus;
2090 unsigned connection = 0xffff;
2091
2092 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2093 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2094 if (ret < 0)
2095 return ret;
2096
2097 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2098 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2099 stable_time += HUB_DEBOUNCE_STEP;
2100 if (stable_time >= HUB_DEBOUNCE_STABLE)
2101 break;
2102 } else {
2103 stable_time = 0;
2104 connection = portstatus & USB_PORT_STAT_CONNECTION;
2105 }
2106
2107 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2108 clear_port_feature(hub->hdev, port1,
2109 USB_PORT_FEAT_C_CONNECTION);
2110 }
2111
2112 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2113 break;
2114 msleep(HUB_DEBOUNCE_STEP);
2115 }
2116
2117 dev_dbg (hub->intfdev,
2118 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2119 port1, total_time, stable_time, portstatus);
2120
2121 if (stable_time < HUB_DEBOUNCE_STABLE)
2122 return -ETIMEDOUT;
2123 return portstatus;
2124}
2125
2126static void ep0_reinit(struct usb_device *udev)
2127{
2128 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2129 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
Alan Sternbdd016b2007-07-30 17:05:22 -04002130 usb_enable_endpoint(udev, &udev->ep0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
2132
2133#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2134#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2135
Alan Stern4326ed02007-07-30 17:08:43 -04002136static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137{
2138 int retval;
2139
Alan Stern4326ed02007-07-30 17:08:43 -04002140 if (devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 return -EINVAL;
2142 if (udev->state == USB_STATE_ADDRESS)
2143 return 0;
2144 if (udev->state != USB_STATE_DEFAULT)
2145 return -EINVAL;
2146 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
Alan Stern4326ed02007-07-30 17:08:43 -04002147 USB_REQ_SET_ADDRESS, 0, devnum, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 NULL, 0, USB_CTRL_SET_TIMEOUT);
2149 if (retval == 0) {
Alan Stern4326ed02007-07-30 17:08:43 -04002150 udev->devnum = devnum; /* Device now using proper address */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 usb_set_device_state(udev, USB_STATE_ADDRESS);
2152 ep0_reinit(udev);
2153 }
2154 return retval;
2155}
2156
2157/* Reset device, (re)assign address, get device descriptor.
2158 * Device connection must be stable, no more debouncing needed.
2159 * Returns device in USB_STATE_ADDRESS, except on error.
2160 *
2161 * If this is called for an already-existing device (as part of
2162 * usb_reset_device), the caller must own the device lock. For a
2163 * newly detected device that is not accessible through any global
2164 * pointers, it's not necessary to lock the device.
2165 */
2166static int
2167hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2168 int retry_counter)
2169{
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002170 static DEFINE_MUTEX(usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171
2172 struct usb_device *hdev = hub->hdev;
2173 int i, j, retval;
2174 unsigned delay = HUB_SHORT_RESET_TIME;
2175 enum usb_device_speed oldspeed = udev->speed;
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002176 char *speed, *type;
Alan Stern4326ed02007-07-30 17:08:43 -04002177 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178
2179 /* root hub ports have a slightly longer reset period
2180 * (from USB 2.0 spec, section 7.1.7.5)
2181 */
2182 if (!hdev->parent) {
2183 delay = HUB_ROOT_RESET_TIME;
2184 if (port1 == hdev->bus->otg_port)
2185 hdev->bus->b_hnp_enable = 0;
2186 }
2187
2188 /* Some low speed devices have problems with the quick delay, so */
2189 /* be a bit pessimistic with those devices. RHbug #23670 */
2190 if (oldspeed == USB_SPEED_LOW)
2191 delay = HUB_LONG_RESET_TIME;
2192
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002193 mutex_lock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
2195 /* Reset the device; full speed may morph to high speed */
2196 retval = hub_port_reset(hub, port1, udev, delay);
2197 if (retval < 0) /* error or disconnect */
2198 goto fail;
2199 /* success, speed is known */
2200 retval = -ENODEV;
2201
2202 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2203 dev_dbg(&udev->dev, "device reset changed speed!\n");
2204 goto fail;
2205 }
2206 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04002207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2209 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002210 * For Wireless USB devices, ep0 max packet is always 512 (tho
2211 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 */
2213 switch (udev->speed) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002214 case USB_SPEED_VARIABLE: /* fixed at 512 */
2215 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2216 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 case USB_SPEED_HIGH: /* fixed at 64 */
2218 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2219 break;
2220 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2221 /* to determine the ep0 maxpacket size, try to read
2222 * the device descriptor to get bMaxPacketSize0 and
2223 * then correct our initial guess.
2224 */
2225 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2226 break;
2227 case USB_SPEED_LOW: /* fixed at 8 */
2228 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2229 break;
2230 default:
2231 goto fail;
2232 }
2233
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002234 type = "";
2235 switch (udev->speed) {
2236 case USB_SPEED_LOW: speed = "low"; break;
2237 case USB_SPEED_FULL: speed = "full"; break;
2238 case USB_SPEED_HIGH: speed = "high"; break;
2239 case USB_SPEED_VARIABLE:
2240 speed = "variable";
2241 type = "Wireless ";
2242 break;
2243 default: speed = "?"; break;
2244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 dev_info (&udev->dev,
Inaky Perez-Gonzalez83a07192006-08-25 19:35:31 -07002246 "%s %s speed %sUSB device using %s and address %d\n",
2247 (udev->config) ? "reset" : "new", speed, type,
Alan Stern4326ed02007-07-30 17:08:43 -04002248 udev->bus->controller->driver->name, devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
2250 /* Set up TT records, if needed */
2251 if (hdev->tt) {
2252 udev->tt = hdev->tt;
2253 udev->ttport = hdev->ttport;
2254 } else if (udev->speed != USB_SPEED_HIGH
2255 && hdev->speed == USB_SPEED_HIGH) {
2256 udev->tt = &hub->tt;
2257 udev->ttport = port1;
2258 }
2259
2260 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2261 * Because device hardware and firmware is sometimes buggy in
2262 * this area, and this is how Linux has done it for ages.
2263 * Change it cautiously.
2264 *
2265 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2266 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2267 * so it may help with some non-standards-compliant devices.
2268 * Otherwise we start with SET_ADDRESS and then try to read the
2269 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2270 * value.
2271 */
2272 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2273 if (USE_NEW_SCHEME(retry_counter)) {
2274 struct usb_device_descriptor *buf;
2275 int r = 0;
2276
2277#define GET_DESCRIPTOR_BUFSIZE 64
2278 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2279 if (!buf) {
2280 retval = -ENOMEM;
2281 continue;
2282 }
2283
Alan Sternb89ee192007-05-11 10:19:04 -04002284 /* Retry on all errors; some devices are flakey.
2285 * 255 is for WUSB devices, we actually need to use
2286 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 */
2288 for (j = 0; j < 3; ++j) {
2289 buf->bMaxPacketSize0 = 0;
2290 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2291 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2292 USB_DT_DEVICE << 8, 0,
2293 buf, GET_DESCRIPTOR_BUFSIZE,
Alan Sternb89ee192007-05-11 10:19:04 -04002294 USB_CTRL_GET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002296 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 if (buf->bDescriptorType ==
2298 USB_DT_DEVICE) {
2299 r = 0;
2300 break;
2301 }
2302 /* FALL THROUGH */
2303 default:
2304 if (r == 0)
2305 r = -EPROTO;
2306 break;
2307 }
2308 if (r == 0)
2309 break;
2310 }
2311 udev->descriptor.bMaxPacketSize0 =
2312 buf->bMaxPacketSize0;
2313 kfree(buf);
2314
2315 retval = hub_port_reset(hub, port1, udev, delay);
2316 if (retval < 0) /* error or disconnect */
2317 goto fail;
2318 if (oldspeed != udev->speed) {
2319 dev_dbg(&udev->dev,
2320 "device reset changed speed!\n");
2321 retval = -ENODEV;
2322 goto fail;
2323 }
2324 if (r) {
2325 dev_err(&udev->dev, "device descriptor "
2326 "read/%s, error %d\n",
2327 "64", r);
2328 retval = -EMSGSIZE;
2329 continue;
2330 }
2331#undef GET_DESCRIPTOR_BUFSIZE
2332 }
2333
2334 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
Alan Stern4326ed02007-07-30 17:08:43 -04002335 retval = hub_set_address(udev, devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 if (retval >= 0)
2337 break;
2338 msleep(200);
2339 }
2340 if (retval < 0) {
2341 dev_err(&udev->dev,
2342 "device not accepting address %d, error %d\n",
Alan Stern4326ed02007-07-30 17:08:43 -04002343 devnum, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 goto fail;
2345 }
2346
2347 /* cope with hardware quirkiness:
2348 * - let SET_ADDRESS settle, some device hardware wants it
2349 * - read ep0 maxpacket even for high and low speed,
2350 */
2351 msleep(10);
2352 if (USE_NEW_SCHEME(retry_counter))
2353 break;
2354
2355 retval = usb_get_device_descriptor(udev, 8);
2356 if (retval < 8) {
2357 dev_err(&udev->dev, "device descriptor "
2358 "read/%s, error %d\n",
2359 "8", retval);
2360 if (retval >= 0)
2361 retval = -EMSGSIZE;
2362 } else {
2363 retval = 0;
2364 break;
2365 }
2366 }
2367 if (retval)
2368 goto fail;
2369
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07002370 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2371 512 : udev->descriptor.bMaxPacketSize0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2373 if (udev->speed != USB_SPEED_FULL ||
2374 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2375 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2376 retval = -EMSGSIZE;
2377 goto fail;
2378 }
2379 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2380 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2381 ep0_reinit(udev);
2382 }
2383
2384 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2385 if (retval < (signed)sizeof(udev->descriptor)) {
2386 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2387 "all", retval);
2388 if (retval >= 0)
2389 retval = -ENOMSG;
2390 goto fail;
2391 }
2392
2393 retval = 0;
2394
2395fail:
Alan Stern4326ed02007-07-30 17:08:43 -04002396 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 hub_port_disable(hub, port1, 0);
Alan Stern4326ed02007-07-30 17:08:43 -04002398 udev->devnum = devnum; /* for disconnect processing */
2399 }
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01002400 mutex_unlock(&usb_address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 return retval;
2402}
2403
2404static void
2405check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2406{
2407 struct usb_qualifier_descriptor *qual;
2408 int status;
2409
Christoph Lametere94b1762006-12-06 20:33:17 -08002410 qual = kmalloc (sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 if (qual == NULL)
2412 return;
2413
2414 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2415 qual, sizeof *qual);
2416 if (status == sizeof *qual) {
2417 dev_info(&udev->dev, "not running at top speed; "
2418 "connect to a high speed hub\n");
2419 /* hub LEDs are probably harder to miss than syslog */
2420 if (hub->has_indicators) {
2421 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002422 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 }
2424 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07002425 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426}
2427
2428static unsigned
2429hub_power_remaining (struct usb_hub *hub)
2430{
2431 struct usb_device *hdev = hub->hdev;
2432 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05002433 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434
Alan Stern55c52712005-11-23 12:03:12 -05002435 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 return 0;
2437
Alan Stern55c52712005-11-23 12:03:12 -05002438 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2439 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2440 struct usb_device *udev = hdev->children[port1 - 1];
2441 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
2443 if (!udev)
2444 continue;
2445
Alan Stern55c52712005-11-23 12:03:12 -05002446 /* Unconfigured devices may not use more than 100mA,
2447 * or 8mA for OTG ports */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 if (udev->actconfig)
Alan Stern55c52712005-11-23 12:03:12 -05002449 delta = udev->actconfig->desc.bMaxPower * 2;
2450 else if (port1 != udev->bus->otg_port || hdev->parent)
2451 delta = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 else
Alan Stern55c52712005-11-23 12:03:12 -05002453 delta = 8;
2454 if (delta > hub->mA_per_port)
2455 dev_warn(&udev->dev, "%dmA is over %umA budget "
2456 "for port %d!\n",
2457 delta, hub->mA_per_port, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 remaining -= delta;
2459 }
2460 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05002461 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2462 - remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 remaining = 0;
2464 }
2465 return remaining;
2466}
2467
2468/* Handle physical or logical connection change events.
2469 * This routine is called when:
2470 * a port connection-change occurs;
2471 * a port enable-change occurs (often caused by EMI);
2472 * usb_reset_device() encounters changed descriptors (as from
2473 * a firmware download)
2474 * caller already locked the hub
2475 */
2476static void hub_port_connect_change(struct usb_hub *hub, int port1,
2477 u16 portstatus, u16 portchange)
2478{
2479 struct usb_device *hdev = hub->hdev;
2480 struct device *hub_dev = hub->intfdev;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002481 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 int status, i;
2483
2484 dev_dbg (hub_dev,
2485 "port %d, status %04x, change %04x, %s\n",
2486 port1, portstatus, portchange, portspeed (portstatus));
2487
2488 if (hub->has_indicators) {
2489 set_port_led(hub, port1, HUB_LED_AUTO);
2490 hub->indicator[port1-1] = INDICATOR_AUTO;
2491 }
2492
2493 /* Disconnect any existing devices under this port */
2494 if (hdev->children[port1-1])
2495 usb_disconnect(&hdev->children[port1-1]);
2496 clear_bit(port1, hub->change_bits);
2497
2498#ifdef CONFIG_USB_OTG
2499 /* during HNP, don't repeat the debounce */
2500 if (hdev->bus->is_b_host)
2501 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2502#endif
2503
2504 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2505 status = hub_port_debounce(hub, port1);
Alan Sternd4b7d8e2007-05-22 11:48:17 -04002506 if (status < 0) {
2507 if (printk_ratelimit())
2508 dev_err (hub_dev, "connect-debounce failed, "
2509 "port %d disabled\n", port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 goto done;
2511 }
2512 portstatus = status;
2513 }
2514
2515 /* Return now if nothing is connected */
2516 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2517
2518 /* maybe switch power back on (e.g. root hub was reset) */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07002519 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2521 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2522
2523 if (portstatus & USB_PORT_STAT_ENABLE)
2524 goto done;
2525 return;
2526 }
2527
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2529 struct usb_device *udev;
2530
2531 /* reallocate for each attempt, since references
2532 * to the previous one can escape in various ways
2533 */
2534 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2535 if (!udev) {
2536 dev_err (hub_dev,
2537 "couldn't allocate port %d usb_device\n",
2538 port1);
2539 goto done;
2540 }
2541
2542 usb_set_device_state(udev, USB_STATE_POWERED);
2543 udev->speed = USB_SPEED_UNKNOWN;
Alan Stern55c52712005-11-23 12:03:12 -05002544 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04002545 udev->level = hdev->level + 1;
Alan Stern55c52712005-11-23 12:03:12 -05002546
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 /* set the address */
2548 choose_address(udev);
2549 if (udev->devnum <= 0) {
2550 status = -ENOTCONN; /* Don't retry */
2551 goto loop;
2552 }
2553
2554 /* reset and get descriptor */
2555 status = hub_port_init(hub, udev, port1, i);
2556 if (status < 0)
2557 goto loop;
2558
2559 /* consecutive bus-powered hubs aren't reliable; they can
2560 * violate the voltage drop budget. if the new child has
2561 * a "powered" LED, users should notice we didn't enable it
2562 * (without reading syslog), even without per-port LEDs
2563 * on the parent.
2564 */
2565 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Alan Stern55c52712005-11-23 12:03:12 -05002566 && udev->bus_mA <= 100) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 u16 devstat;
2568
2569 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2570 &devstat);
Alan Stern55c52712005-11-23 12:03:12 -05002571 if (status < 2) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 dev_dbg(&udev->dev, "get status %d ?\n", status);
2573 goto loop_disable;
2574 }
Alan Stern55c52712005-11-23 12:03:12 -05002575 le16_to_cpus(&devstat);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2577 dev_err(&udev->dev,
2578 "can't connect bus-powered hub "
2579 "to this port\n");
2580 if (hub->has_indicators) {
2581 hub->indicator[port1-1] =
2582 INDICATOR_AMBER_BLINK;
David Howellsc4028952006-11-22 14:57:56 +00002583 schedule_delayed_work (&hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 }
2585 status = -ENOTCONN; /* Don't retry */
2586 goto loop_disable;
2587 }
2588 }
2589
2590 /* check for devices running slower than they could */
2591 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2592 && udev->speed == USB_SPEED_FULL
2593 && highspeed_hubs != 0)
2594 check_highspeed (hub, udev, port1);
2595
2596 /* Store the parent's children[] pointer. At this point
2597 * udev becomes globally accessible, although presumably
2598 * no one will look at it until hdev is unlocked.
2599 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 status = 0;
2601
2602 /* We mustn't add new devices if the parent hub has
2603 * been disconnected; we would race with the
2604 * recursively_mark_NOTATTACHED() routine.
2605 */
2606 spin_lock_irq(&device_state_lock);
2607 if (hdev->state == USB_STATE_NOTATTACHED)
2608 status = -ENOTCONN;
2609 else
2610 hdev->children[port1-1] = udev;
2611 spin_unlock_irq(&device_state_lock);
2612
2613 /* Run it through the hoops (find a driver, etc) */
2614 if (!status) {
2615 status = usb_new_device(udev);
2616 if (status) {
2617 spin_lock_irq(&device_state_lock);
2618 hdev->children[port1-1] = NULL;
2619 spin_unlock_irq(&device_state_lock);
2620 }
2621 }
2622
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 if (status)
2624 goto loop_disable;
2625
2626 status = hub_power_remaining(hub);
2627 if (status)
Alan Stern55c52712005-11-23 12:03:12 -05002628 dev_dbg(hub_dev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629
2630 return;
2631
2632loop_disable:
2633 hub_port_disable(hub, port1, 1);
2634loop:
2635 ep0_reinit(udev);
2636 release_address(udev);
2637 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07002638 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 break;
2640 }
2641
2642done:
2643 hub_port_disable(hub, port1, 1);
2644}
2645
2646static void hub_events(void)
2647{
2648 struct list_head *tmp;
2649 struct usb_device *hdev;
2650 struct usb_interface *intf;
2651 struct usb_hub *hub;
2652 struct device *hub_dev;
2653 u16 hubstatus;
2654 u16 hubchange;
2655 u16 portstatus;
2656 u16 portchange;
2657 int i, ret;
2658 int connect_change;
2659
2660 /*
2661 * We restart the list every time to avoid a deadlock with
2662 * deleting hubs downstream from this one. This should be
2663 * safe since we delete the hub from the event list.
2664 * Not the most efficient, but avoids deadlocks.
2665 */
2666 while (1) {
2667
2668 /* Grab the first entry at the beginning of the list */
2669 spin_lock_irq(&hub_event_lock);
2670 if (list_empty(&hub_event_list)) {
2671 spin_unlock_irq(&hub_event_lock);
2672 break;
2673 }
2674
2675 tmp = hub_event_list.next;
2676 list_del_init(tmp);
2677
2678 hub = list_entry(tmp, struct usb_hub, event_list);
Alan Sterne8054852007-05-04 11:55:11 -04002679 kref_get(&hub->kref);
2680 spin_unlock_irq(&hub_event_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681
Alan Sterne8054852007-05-04 11:55:11 -04002682 hdev = hub->hdev;
2683 hub_dev = hub->intfdev;
2684 intf = to_usb_interface(hub_dev);
Alan Stern40f122f2006-11-09 14:44:33 -05002685 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 hdev->state, hub->descriptor
2687 ? hub->descriptor->bNbrPorts
2688 : 0,
2689 /* NOTE: expects max 15 ports... */
2690 (u16) hub->change_bits[0],
Alan Stern40f122f2006-11-09 14:44:33 -05002691 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 /* Lock the device, then check to see if we were
2694 * disconnected while waiting for the lock to succeed. */
Alan Stern06b84e82007-05-04 11:54:50 -04002695 usb_lock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04002696 if (unlikely(hub->disconnected))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 goto loop;
2698
2699 /* If the hub has died, clean up after it */
2700 if (hdev->state == USB_STATE_NOTATTACHED) {
Alan Stern7de18d82006-06-01 13:37:24 -04002701 hub->error = -ENODEV;
2702 hub_pre_reset(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703 goto loop;
2704 }
2705
Alan Stern40f122f2006-11-09 14:44:33 -05002706 /* Autoresume */
2707 ret = usb_autopm_get_interface(intf);
2708 if (ret) {
2709 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710 goto loop;
Alan Stern40f122f2006-11-09 14:44:33 -05002711 }
2712
2713 /* If this is an inactive hub, do nothing */
2714 if (hub->quiescing)
2715 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716
2717 if (hub->error) {
2718 dev_dbg (hub_dev, "resetting for error %d\n",
2719 hub->error);
2720
Alan Stern7de18d82006-06-01 13:37:24 -04002721 ret = usb_reset_composite_device(hdev, intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 if (ret) {
2723 dev_dbg (hub_dev,
2724 "error resetting hub: %d\n", ret);
Alan Stern40f122f2006-11-09 14:44:33 -05002725 goto loop_autopm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726 }
2727
2728 hub->nerrors = 0;
2729 hub->error = 0;
2730 }
2731
2732 /* deal with port status changes */
2733 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2734 if (test_bit(i, hub->busy_bits))
2735 continue;
2736 connect_change = test_bit(i, hub->change_bits);
2737 if (!test_and_clear_bit(i, hub->event_bits) &&
2738 !connect_change && !hub->activating)
2739 continue;
2740
2741 ret = hub_port_status(hub, i,
2742 &portstatus, &portchange);
2743 if (ret < 0)
2744 continue;
2745
2746 if (hub->activating && !hdev->children[i-1] &&
2747 (portstatus &
2748 USB_PORT_STAT_CONNECTION))
2749 connect_change = 1;
2750
2751 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2752 clear_port_feature(hdev, i,
2753 USB_PORT_FEAT_C_CONNECTION);
2754 connect_change = 1;
2755 }
2756
2757 if (portchange & USB_PORT_STAT_C_ENABLE) {
2758 if (!connect_change)
2759 dev_dbg (hub_dev,
2760 "port %d enable change, "
2761 "status %08x\n",
2762 i, portstatus);
2763 clear_port_feature(hdev, i,
2764 USB_PORT_FEAT_C_ENABLE);
2765
2766 /*
2767 * EM interference sometimes causes badly
2768 * shielded USB devices to be shutdown by
2769 * the hub, this hack enables them again.
2770 * Works at least with mouse driver.
2771 */
2772 if (!(portstatus & USB_PORT_STAT_ENABLE)
2773 && !connect_change
2774 && hdev->children[i-1]) {
2775 dev_err (hub_dev,
2776 "port %i "
2777 "disabled by hub (EMI?), "
2778 "re-enabling...\n",
2779 i);
2780 connect_change = 1;
2781 }
2782 }
2783
2784 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2785 clear_port_feature(hdev, i,
2786 USB_PORT_FEAT_C_SUSPEND);
2787 if (hdev->children[i-1]) {
2788 ret = remote_wakeup(hdev->
2789 children[i-1]);
2790 if (ret < 0)
2791 connect_change = 1;
2792 } else {
2793 ret = -ENODEV;
2794 hub_port_disable(hub, i, 1);
2795 }
2796 dev_dbg (hub_dev,
2797 "resume on port %d, status %d\n",
2798 i, ret);
2799 }
2800
2801 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2802 dev_err (hub_dev,
2803 "over-current change on port %d\n",
2804 i);
2805 clear_port_feature(hdev, i,
2806 USB_PORT_FEAT_C_OVER_CURRENT);
2807 hub_power_on(hub);
2808 }
2809
2810 if (portchange & USB_PORT_STAT_C_RESET) {
2811 dev_dbg (hub_dev,
2812 "reset change on port %d\n",
2813 i);
2814 clear_port_feature(hdev, i,
2815 USB_PORT_FEAT_C_RESET);
2816 }
2817
2818 if (connect_change)
2819 hub_port_connect_change(hub, i,
2820 portstatus, portchange);
2821 } /* end for i */
2822
2823 /* deal with hub status changes */
2824 if (test_and_clear_bit(0, hub->event_bits) == 0)
2825 ; /* do nothing */
2826 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2827 dev_err (hub_dev, "get_hub_status failed\n");
2828 else {
2829 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2830 dev_dbg (hub_dev, "power change\n");
2831 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
Alan Stern55c52712005-11-23 12:03:12 -05002832 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2833 /* FIXME: Is this always true? */
Alan Stern55c52712005-11-23 12:03:12 -05002834 hub->limited_power = 1;
jidong xiao403fae72007-09-14 00:08:51 +08002835 else
2836 hub->limited_power = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837 }
2838 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2839 dev_dbg (hub_dev, "overcurrent change\n");
2840 msleep(500); /* Cool down */
2841 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2842 hub_power_on(hub);
2843 }
2844 }
2845
2846 hub->activating = 0;
2847
Alan Sternd5926ae72005-04-21 15:56:37 -04002848 /* If this is a root hub, tell the HCD it's okay to
2849 * re-enable port-change interrupts now. */
Alan Sternd5cbad42006-08-11 16:52:39 -04002850 if (!hdev->parent && !hub->busy_bits[0])
Alan Sternd5926ae72005-04-21 15:56:37 -04002851 usb_enable_root_hub_irq(hdev->bus);
2852
Alan Stern40f122f2006-11-09 14:44:33 -05002853loop_autopm:
2854 /* Allow autosuspend if we're not going to run again */
2855 if (list_empty(&hub->event_list))
2856 usb_autopm_enable(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857loop:
2858 usb_unlock_device(hdev);
Alan Sterne8054852007-05-04 11:55:11 -04002859 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860
2861 } /* end while (1) */
2862}
2863
2864static int hub_thread(void *__unused)
2865{
Rafael J. Wysocki83144182007-07-17 04:03:35 -07002866 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867 do {
2868 hub_events();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002869 wait_event_interruptible(khubd_wait,
2870 !list_empty(&hub_event_list) ||
2871 kthread_should_stop());
Christoph Lameter3e1d1d22005-06-24 23:13:50 -07002872 try_to_freeze();
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002873 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002875 pr_debug("%s: khubd exiting\n", usbcore_name);
2876 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877}
2878
2879static struct usb_device_id hub_id_table [] = {
2880 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2881 .bDeviceClass = USB_CLASS_HUB},
2882 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2883 .bInterfaceClass = USB_CLASS_HUB},
2884 { } /* Terminating entry */
2885};
2886
2887MODULE_DEVICE_TABLE (usb, hub_id_table);
2888
2889static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 .name = "hub",
2891 .probe = hub_probe,
2892 .disconnect = hub_disconnect,
2893 .suspend = hub_suspend,
2894 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04002895 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04002896 .pre_reset = hub_pre_reset,
2897 .post_reset = hub_post_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 .ioctl = hub_ioctl,
2899 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05002900 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901};
2902
2903int usb_hub_init(void)
2904{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 if (usb_register(&hub_driver) < 0) {
2906 printk(KERN_ERR "%s: can't register hub driver\n",
2907 usbcore_name);
2908 return -1;
2909 }
2910
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002911 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2912 if (!IS_ERR(khubd_task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002914
2915 /* Fall through if kernel_thread failed */
2916 usb_deregister(&hub_driver);
2917 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2918
2919 return -1;
2920}
2921
2922void usb_hub_cleanup(void)
2923{
akpm@osdl.org9c8d6172005-06-20 14:29:58 -07002924 kthread_stop(khubd_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925
2926 /*
2927 * Hub resources are freed for us by usb_deregister. It calls
2928 * usb_driver_purge on every device which in turn calls that
2929 * devices disconnect function if it is using this driver.
2930 * The hub_disconnect function takes care of releasing the
2931 * individual hub resources. -greg
2932 */
2933 usb_deregister(&hub_driver);
2934} /* usb_hub_cleanup() */
2935
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936static int config_descriptors_changed(struct usb_device *udev)
2937{
2938 unsigned index;
2939 unsigned len = 0;
2940 struct usb_config_descriptor *buf;
2941
2942 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2943 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2944 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2945 }
Christoph Lametere94b1762006-12-06 20:33:17 -08002946 buf = kmalloc (len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947 if (buf == NULL) {
2948 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2949 /* assume the worst */
2950 return 1;
2951 }
2952 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2953 int length;
2954 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2955
2956 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2957 old_length);
2958 if (length < old_length) {
2959 dev_dbg(&udev->dev, "config index %d, error %d\n",
2960 index, length);
2961 break;
2962 }
2963 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2964 != 0) {
2965 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2966 index, buf->bConfigurationValue);
2967 break;
2968 }
2969 }
2970 kfree(buf);
2971 return index != udev->descriptor.bNumConfigurations;
2972}
2973
2974/**
2975 * usb_reset_device - perform a USB port reset to reinitialize a device
2976 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2977 *
Alan Stern79efa092006-06-01 13:33:42 -04002978 * WARNING - don't use this routine to reset a composite device
2979 * (one with multiple interfaces owned by separate drivers)!
2980 * Use usb_reset_composite_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981 *
2982 * Do a port reset, reassign the device's address, and establish its
2983 * former operating configuration. If the reset fails, or the device's
2984 * descriptors change from their values before the reset, or the original
2985 * configuration and altsettings cannot be restored, a flag will be set
2986 * telling khubd to pretend the device has been disconnected and then
2987 * re-connected. All drivers will be unbound, and the device will be
2988 * re-enumerated and probed all over again.
2989 *
2990 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2991 * flagged for logical disconnection, or some other negative error code
2992 * if the reset wasn't even attempted.
2993 *
2994 * The caller must own the device lock. For example, it's safe to use
2995 * this from a driver probe() routine after downloading new firmware.
2996 * For calls that might not occur during probe(), drivers should lock
2997 * the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04002998 *
2999 * Locking exception: This routine may also be called from within an
3000 * autoresume handler. Such usage won't conflict with other tasks
3001 * holding the device lock because these tasks should always call
3002 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003003 */
3004int usb_reset_device(struct usb_device *udev)
3005{
3006 struct usb_device *parent_hdev = udev->parent;
3007 struct usb_hub *parent_hub;
3008 struct usb_device_descriptor descriptor = udev->descriptor;
Alan Stern12c3da32005-11-23 12:09:52 -05003009 int i, ret = 0;
3010 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
3012 if (udev->state == USB_STATE_NOTATTACHED ||
3013 udev->state == USB_STATE_SUSPENDED) {
3014 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3015 udev->state);
3016 return -EINVAL;
3017 }
3018
3019 if (!parent_hdev) {
3020 /* this requires hcd-specific logic; see OHCI hc_restart() */
3021 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3022 return -EISDIR;
3023 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024 parent_hub = hdev_to_hub(parent_hdev);
3025
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026 set_bit(port1, parent_hub->busy_bits);
3027 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3028
3029 /* ep0 maxpacket size may change; let the HCD know about it.
3030 * Other endpoints will be handled by re-enumeration. */
3031 ep0_reinit(udev);
3032 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04003033 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034 break;
3035 }
3036 clear_bit(port1, parent_hub->busy_bits);
Alan Sternd5cbad42006-08-11 16:52:39 -04003037 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3038 usb_enable_root_hub_irq(parent_hdev->bus);
3039
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040 if (ret < 0)
3041 goto re_enumerate;
3042
3043 /* Device might have changed firmware (DFU or similar) */
3044 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3045 || config_descriptors_changed (udev)) {
3046 dev_info(&udev->dev, "device firmware changed\n");
3047 udev->descriptor = descriptor; /* for disconnect() calls */
3048 goto re_enumerate;
3049 }
3050
3051 if (!udev->actconfig)
3052 goto done;
3053
3054 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3055 USB_REQ_SET_CONFIGURATION, 0,
3056 udev->actconfig->desc.bConfigurationValue, 0,
3057 NULL, 0, USB_CTRL_SET_TIMEOUT);
3058 if (ret < 0) {
3059 dev_err(&udev->dev,
3060 "can't restore configuration #%d (error=%d)\n",
3061 udev->actconfig->desc.bConfigurationValue, ret);
3062 goto re_enumerate;
3063 }
3064 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3065
3066 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3067 struct usb_interface *intf = udev->actconfig->interface[i];
3068 struct usb_interface_descriptor *desc;
3069
3070 /* set_interface resets host side toggle even
3071 * for altsetting zero. the interface may have no driver.
3072 */
3073 desc = &intf->cur_altsetting->desc;
3074 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3075 desc->bAlternateSetting);
3076 if (ret < 0) {
3077 dev_err(&udev->dev, "failed to restore interface %d "
3078 "altsetting %d (error=%d)\n",
3079 desc->bInterfaceNumber,
3080 desc->bAlternateSetting,
3081 ret);
3082 goto re_enumerate;
3083 }
3084 }
3085
3086done:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087 return 0;
3088
3089re_enumerate:
3090 hub_port_logical_disconnect(parent_hub, port1);
3091 return -ENODEV;
3092}
Alan Stern140d8f62006-07-01 22:07:21 -04003093EXPORT_SYMBOL(usb_reset_device);
Alan Stern79efa092006-06-01 13:33:42 -04003094
3095/**
3096 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3097 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3098 * @iface: interface bound to the driver making the request (optional)
3099 *
3100 * Warns all drivers bound to registered interfaces (using their pre_reset
3101 * method), performs the port reset, and then lets the drivers know that
3102 * the reset is over (using their post_reset method).
3103 *
3104 * Return value is the same as for usb_reset_device().
3105 *
3106 * The caller must own the device lock. For example, it's safe to use
3107 * this from a driver probe() routine after downloading new firmware.
3108 * For calls that might not occur during probe(), drivers should lock
3109 * the device using usb_lock_device_for_reset().
3110 *
3111 * The interface locks are acquired during the pre_reset stage and released
3112 * during the post_reset stage. However if iface is not NULL and is
3113 * currently being probed, we assume that the caller already owns its
3114 * lock.
3115 */
3116int usb_reset_composite_device(struct usb_device *udev,
3117 struct usb_interface *iface)
3118{
3119 int ret;
3120 struct usb_host_config *config = udev->actconfig;
3121
3122 if (udev->state == USB_STATE_NOTATTACHED ||
3123 udev->state == USB_STATE_SUSPENDED) {
3124 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3125 udev->state);
3126 return -EINVAL;
3127 }
3128
Alan Stern645daaa2006-08-30 15:47:02 -04003129 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05003130 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04003131
Alan Stern79efa092006-06-01 13:33:42 -04003132 if (iface && iface->condition != USB_INTERFACE_BINDING)
3133 iface = NULL;
3134
3135 if (config) {
3136 int i;
3137 struct usb_interface *cintf;
3138 struct usb_driver *drv;
3139
3140 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3141 cintf = config->interface[i];
3142 if (cintf != iface)
3143 down(&cintf->dev.sem);
3144 if (device_is_registered(&cintf->dev) &&
3145 cintf->dev.driver) {
3146 drv = to_usb_driver(cintf->dev.driver);
3147 if (drv->pre_reset)
3148 (drv->pre_reset)(cintf);
Alan Sternf07600c2007-05-30 15:38:16 -04003149 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
Alan Stern79efa092006-06-01 13:33:42 -04003150 }
3151 }
3152 }
3153
3154 ret = usb_reset_device(udev);
3155
3156 if (config) {
3157 int i;
3158 struct usb_interface *cintf;
3159 struct usb_driver *drv;
3160
3161 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3162 cintf = config->interface[i];
3163 if (device_is_registered(&cintf->dev) &&
3164 cintf->dev.driver) {
3165 drv = to_usb_driver(cintf->dev.driver);
3166 if (drv->post_reset)
Alan Sternf07600c2007-05-30 15:38:16 -04003167 (drv->post_reset)(cintf);
3168 /* FIXME: Unbind if post_reset returns an error or isn't defined */
Alan Stern79efa092006-06-01 13:33:42 -04003169 }
3170 if (cintf != iface)
3171 up(&cintf->dev.sem);
3172 }
3173 }
3174
Alan Stern94fcda12006-11-20 11:38:46 -05003175 usb_autosuspend_device(udev);
Alan Stern79efa092006-06-01 13:33:42 -04003176 return ret;
3177}
Alan Stern140d8f62006-07-01 22:07:21 -04003178EXPORT_SYMBOL(usb_reset_composite_device);