]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/usb/core/hub.c
projects / mirror_ubuntu-jammy-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[PATCH] usbcore: Wrap lines before column 80
[mirror_ubuntu-jammy-kernel.git] / drivers / usb / core / hub.c
CommitLineData
1da177e4
LT		 1/*
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
11#include <linux/config.h>
12#ifdef CONFIG_USB_DEBUG
13 #define DEBUG
14#else
15 #undef DEBUG
16#endif
17#include <linux/kernel.h>
18#include <linux/errno.h>
19#include <linux/module.h>
20#include <linux/moduleparam.h>
21#include <linux/completion.h>
22#include <linux/sched.h>
23#include <linux/list.h>
24#include <linux/slab.h>
25#include <linux/smp_lock.h>
26#include <linux/ioctl.h>
27#include <linux/usb.h>
28#include <linux/usbdevice_fs.h>
9c8d6178 29#include <linux/kthread.h>
1da177e4
LT		 30
31#include <asm/semaphore.h>
32#include <asm/uaccess.h>
33#include <asm/byteorder.h>
34
35#include "usb.h"
36#include "hcd.h"
37#include "hub.h"
38
39/* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->serialize, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42static DEFINE_SPINLOCK(device_state_lock);
43
44/* khubd's worklist and its lock */
45static DEFINE_SPINLOCK(hub_event_lock);
46static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
47
48/* Wakes up khubd */
49static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
50
9c8d6178 51static struct task_struct *khubd_task;
1da177e4
LT		 52
53/* cycle leds on hubs that aren't blinking for attention */
54static int blinkenlights = 0;
55module_param (blinkenlights, bool, S_IRUGO);
56MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
57
58/*
59 * As of 2.6.10 we introduce a new USB device initialization scheme which
60 * closely resembles the way Windows works. Hopefully it will be compatible
61 * with a wider range of devices than the old scheme. However some previously
62 * working devices may start giving rise to "device not accepting address"
63 * errors; if that happens the user can try the old scheme by adjusting the
64 * following module parameters.
65 *
66 * For maximum flexibility there are two boolean parameters to control the
67 * hub driver's behavior. On the first initialization attempt, if the
68 * "old_scheme_first" parameter is set then the old scheme will be used,
69 * otherwise the new scheme is used. If that fails and "use_both_schemes"
70 * is set, then the driver will make another attempt, using the other scheme.
71 */
72static int old_scheme_first = 0;
73module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
74MODULE_PARM_DESC(old_scheme_first,
75 "start with the old device initialization scheme");
76
77static int use_both_schemes = 1;
78module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
79MODULE_PARM_DESC(use_both_schemes,
80 "try the other device initialization scheme if the "
81 "first one fails");
82
83
84#ifdef DEBUG
85static inline char *portspeed (int portstatus)
86{
87 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
88 return "480 Mb/s";
89 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
90 return "1.5 Mb/s";
91 else
92 return "12 Mb/s";
93}
94#endif
95
96/* Note that hdev or one of its children must be locked! */
97static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
98{
99 return usb_get_intfdata(hdev->actconfig->interface[0]);
100}
101
102/* USB 2.0 spec Section 11.24.4.5 */
103static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
104{
105 int i, ret;
106
107 for (i = 0; i < 3; i++) {
108 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
109 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
110 USB_DT_HUB << 8, 0, data, size,
111 USB_CTRL_GET_TIMEOUT);
112 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
113 return ret;
114 }
115 return -EINVAL;
116}
117
118/*
119 * USB 2.0 spec Section 11.24.2.1
120 */
121static int clear_hub_feature(struct usb_device *hdev, int feature)
122{
123 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
124 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
125}
126
127/*
128 * USB 2.0 spec Section 11.24.2.2
129 */
130static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
131{
132 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
133 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
134 NULL, 0, 1000);
135}
136
137/*
138 * USB 2.0 spec Section 11.24.2.13
139 */
140static int set_port_feature(struct usb_device *hdev, int port1, int feature)
141{
142 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
143 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
144 NULL, 0, 1000);
145}
146
147/*
148 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
149 * for info about using port indicators
150 */
151static void set_port_led(
152 struct usb_hub *hub,
153 int port1,
154 int selector
155)
156{
157 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
158 USB_PORT_FEAT_INDICATOR);
159 if (status < 0)
160 dev_dbg (hub->intfdev,
161 "port %d indicator %s status %d\n",
162 port1,
163 ({ char *s; switch (selector) {
164 case HUB_LED_AMBER: s = "amber"; break;
165 case HUB_LED_GREEN: s = "green"; break;
166 case HUB_LED_OFF: s = "off"; break;
167 case HUB_LED_AUTO: s = "auto"; break;
168 default: s = "??"; break;
169 }; s; }),
170 status);
171}
172
173#define LED_CYCLE_PERIOD ((2*HZ)/3)
174
175static void led_work (void *__hub)
176{
177 struct usb_hub *hub = __hub;
178 struct usb_device *hdev = hub->hdev;
179 unsigned i;
180 unsigned changed = 0;
181 int cursor = -1;
182
183 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
184 return;
185
186 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
187 unsigned selector, mode;
188
189 /* 30%-50% duty cycle */
190
191 switch (hub->indicator[i]) {
192 /* cycle marker */
193 case INDICATOR_CYCLE:
194 cursor = i;
195 selector = HUB_LED_AUTO;
196 mode = INDICATOR_AUTO;
197 break;
198 /* blinking green = sw attention */
199 case INDICATOR_GREEN_BLINK:
200 selector = HUB_LED_GREEN;
201 mode = INDICATOR_GREEN_BLINK_OFF;
202 break;
203 case INDICATOR_GREEN_BLINK_OFF:
204 selector = HUB_LED_OFF;
205 mode = INDICATOR_GREEN_BLINK;
206 break;
207 /* blinking amber = hw attention */
208 case INDICATOR_AMBER_BLINK:
209 selector = HUB_LED_AMBER;
210 mode = INDICATOR_AMBER_BLINK_OFF;
211 break;
212 case INDICATOR_AMBER_BLINK_OFF:
213 selector = HUB_LED_OFF;
214 mode = INDICATOR_AMBER_BLINK;
215 break;
216 /* blink green/amber = reserved */
217 case INDICATOR_ALT_BLINK:
218 selector = HUB_LED_GREEN;
219 mode = INDICATOR_ALT_BLINK_OFF;
220 break;
221 case INDICATOR_ALT_BLINK_OFF:
222 selector = HUB_LED_AMBER;
223 mode = INDICATOR_ALT_BLINK;
224 break;
225 default:
226 continue;
227 }
228 if (selector != HUB_LED_AUTO)
229 changed = 1;
230 set_port_led(hub, i + 1, selector);
231 hub->indicator[i] = mode;
232 }
233 if (!changed && blinkenlights) {
234 cursor++;
235 cursor %= hub->descriptor->bNbrPorts;
236 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
237 hub->indicator[cursor] = INDICATOR_CYCLE;
238 changed++;
239 }
240 if (changed)
241 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
242}
243
244/* use a short timeout for hub/port status fetches */
245#define USB_STS_TIMEOUT 1000
246#define USB_STS_RETRIES 5
247
248/*
249 * USB 2.0 spec Section 11.24.2.6
250 */
251static int get_hub_status(struct usb_device *hdev,
252 struct usb_hub_status *data)
253{
254 int i, status = -ETIMEDOUT;
255
256 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
257 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
258 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
259 data, sizeof(*data), USB_STS_TIMEOUT);
260 }
261 return status;
262}
263
264/*
265 * USB 2.0 spec Section 11.24.2.7
266 */
267static int get_port_status(struct usb_device *hdev, int port1,
268 struct usb_port_status *data)
269{
270 int i, status = -ETIMEDOUT;
271
272 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
273 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
274 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
275 data, sizeof(*data), USB_STS_TIMEOUT);
276 }
277 return status;
278}
279
280static void kick_khubd(struct usb_hub *hub)
281{
282 unsigned long flags;
283
284 spin_lock_irqsave(&hub_event_lock, flags);
285 if (list_empty(&hub->event_list)) {
286 list_add_tail(&hub->event_list, &hub_event_list);
287 wake_up(&khubd_wait);
288 }
289 spin_unlock_irqrestore(&hub_event_lock, flags);
290}
291
292void usb_kick_khubd(struct usb_device *hdev)
293{
294 kick_khubd(hdev_to_hub(hdev));
295}
296
297
298/* completion function, fires on port status changes and various faults */
299static void hub_irq(struct urb *urb, struct pt_regs *regs)
300{
301 struct usb_hub *hub = (struct usb_hub *)urb->context;
302 int status;
303 int i;
304 unsigned long bits;
305
306 switch (urb->status) {
307 case -ENOENT: /* synchronous unlink */
308 case -ECONNRESET: /* async unlink */
309 case -ESHUTDOWN: /* hardware going away */
310 return;
311
312 default: /* presumably an error */
313 /* Cause a hub reset after 10 consecutive errors */
314 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
315 if ((++hub->nerrors < 10) || hub->error)
316 goto resubmit;
317 hub->error = urb->status;
318 /* FALL THROUGH */
319
320 /* let khubd handle things */
321 case 0: /* we got data: port status changed */
322 bits = 0;
323 for (i = 0; i < urb->actual_length; ++i)
324 bits |= ((unsigned long) ((*hub->buffer)[i]))
325 << (i*8);
326 hub->event_bits[0] = bits;
327 break;
328 }
329
330 hub->nerrors = 0;
331
332 /* Something happened, let khubd figure it out */
333 kick_khubd(hub);
334
335resubmit:
336 if (hub->quiescing)
337 return;
338
339 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
340 && status != -ENODEV && status != -EPERM)
341 dev_err (hub->intfdev, "resubmit --> %d\n", status);
342}
343
344/* USB 2.0 spec Section 11.24.2.3 */
345static inline int
346hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
347{
348 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
349 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
350 tt, NULL, 0, 1000);
351}
352
353/*
354 * enumeration blocks khubd for a long time. we use keventd instead, since
355 * long blocking there is the exception, not the rule. accordingly, HCDs
356 * talking to TTs must queue control transfers (not just bulk and iso), so
357 * both can talk to the same hub concurrently.
358 */
359static void hub_tt_kevent (void *arg)
360{
361 struct usb_hub *hub = arg;
362 unsigned long flags;
363
364 spin_lock_irqsave (&hub->tt.lock, flags);
365 while (!list_empty (&hub->tt.clear_list)) {
366 struct list_head *temp;
367 struct usb_tt_clear *clear;
368 struct usb_device *hdev = hub->hdev;
369 int status;
370
371 temp = hub->tt.clear_list.next;
372 clear = list_entry (temp, struct usb_tt_clear, clear_list);
373 list_del (&clear->clear_list);
374
375 /* drop lock so HCD can concurrently report other TT errors */
376 spin_unlock_irqrestore (&hub->tt.lock, flags);
377 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
378 spin_lock_irqsave (&hub->tt.lock, flags);
379
380 if (status)
381 dev_err (&hdev->dev,
382 "clear tt %d (%04x) error %d\n",
383 clear->tt, clear->devinfo, status);
1bc3c9e1 384 kfree(clear);
1da177e4
LT		 385 }
386 spin_unlock_irqrestore (&hub->tt.lock, flags);
387}
388
389/**
390 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
391 * @udev: the device whose split transaction failed
392 * @pipe: identifies the endpoint of the failed transaction
393 *
394 * High speed HCDs use this to tell the hub driver that some split control or
395 * bulk transaction failed in a way that requires clearing internal state of
396 * a transaction translator. This is normally detected (and reported) from
397 * interrupt context.
398 *
399 * It may not be possible for that hub to handle additional full (or low)
400 * speed transactions until that state is fully cleared out.
401 */
402void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
403{
404 struct usb_tt *tt = udev->tt;
405 unsigned long flags;
406 struct usb_tt_clear *clear;
407
408 /* we've got to cope with an arbitrary number of pending TT clears,
409 * since each TT has "at least two" buffers that can need it (and
410 * there can be many TTs per hub). even if they're uncommon.
411 */
412 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
413 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
414 /* FIXME recover somehow ... RESET_TT? */
415 return;
416 }
417
418 /* info that CLEAR_TT_BUFFER needs */
419 clear->tt = tt->multi ? udev->ttport : 1;
420 clear->devinfo = usb_pipeendpoint (pipe);
421 clear->devinfo |= udev->devnum << 4;
422 clear->devinfo |= usb_pipecontrol (pipe)
423 ? (USB_ENDPOINT_XFER_CONTROL << 11)
424 : (USB_ENDPOINT_XFER_BULK << 11);
425 if (usb_pipein (pipe))
426 clear->devinfo |= 1 << 15;
427
428 /* tell keventd to clear state for this TT */
429 spin_lock_irqsave (&tt->lock, flags);
430 list_add_tail (&clear->clear_list, &tt->clear_list);
431 schedule_work (&tt->kevent);
432 spin_unlock_irqrestore (&tt->lock, flags);
433}
434
435static void hub_power_on(struct usb_hub *hub)
436{
437 int port1;
b789696a 438 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
74ad9bd2 439 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1da177e4
LT		 440
441 /* if hub supports power switching, enable power on each port */
74ad9bd2 442 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
1da177e4
LT		 443 dev_dbg(hub->intfdev, "enabling power on all ports\n");
444 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
445 set_port_feature(hub->hdev, port1,
446 USB_PORT_FEAT_POWER);
447 }
448
b789696a
DB		 449 /* Wait at least 100 msec for power to become stable */
450 msleep(max(pgood_delay, (unsigned) 100));
1da177e4
LT		 451}
452
979d5199 453static inline void __hub_quiesce(struct usb_hub *hub)
1da177e4 454{
979d5199 455 /* (nonblocking) khubd and related activity won't re-trigger */
1da177e4 456 hub->quiescing = 1;
c9f89fa4 457 hub->activating = 0;
979d5199
DB		 458 hub->resume_root_hub = 0;
459}
460
461static void hub_quiesce(struct usb_hub *hub)
462{
463 /* (blocking) stop khubd and related activity */
464 __hub_quiesce(hub);
1da177e4
LT		 465 usb_kill_urb(hub->urb);
466 if (hub->has_indicators)
467 cancel_delayed_work(&hub->leds);
468 if (hub->has_indicators || hub->tt.hub)
469 flush_scheduled_work();
470}
471
472static void hub_activate(struct usb_hub *hub)
473{
474 int status;
475
476 hub->quiescing = 0;
477 hub->activating = 1;
979d5199 478 hub->resume_root_hub = 0;
1da177e4
LT		 479 status = usb_submit_urb(hub->urb, GFP_NOIO);
480 if (status < 0)
481 dev_err(hub->intfdev, "activate --> %d\n", status);
482 if (hub->has_indicators && blinkenlights)
483 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
484
485 /* scan all ports ASAP */
486 kick_khubd(hub);
487}
488
489static int hub_hub_status(struct usb_hub *hub,
490 u16 *status, u16 *change)
491{
492 int ret;
493
494 ret = get_hub_status(hub->hdev, &hub->status->hub);
495 if (ret < 0)
496 dev_err (hub->intfdev,
497 "%s failed (err = %d)\n", __FUNCTION__, ret);
498 else {
499 *status = le16_to_cpu(hub->status->hub.wHubStatus);
500 *change = le16_to_cpu(hub->status->hub.wHubChange);
501 ret = 0;
502 }
503 return ret;
504}
505
8b28c752
AS		 506static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
507{
508 struct usb_device *hdev = hub->hdev;
509 int ret;
510
511 if (hdev->children[port1-1] && set_state) {
512 usb_set_device_state(hdev->children[port1-1],
513 USB_STATE_NOTATTACHED);
514 }
515 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
516 if (ret)
517 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
518 port1, ret);
519
520 return ret;
521}
522
1da177e4
LT		 523static int hub_configure(struct usb_hub *hub,
524 struct usb_endpoint_descriptor *endpoint)
525{
526 struct usb_device *hdev = hub->hdev;
527 struct device *hub_dev = hub->intfdev;
528 u16 hubstatus, hubchange;
74ad9bd2 529 u16 wHubCharacteristics;
1da177e4
LT		 530 unsigned int pipe;
531 int maxp, ret;
532 char *message;
533
534 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
535 &hub->buffer_dma);
536 if (!hub->buffer) {
537 message = "can't allocate hub irq buffer";
538 ret = -ENOMEM;
539 goto fail;
540 }
541
542 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
543 if (!hub->status) {
544 message = "can't kmalloc hub status buffer";
545 ret = -ENOMEM;
546 goto fail;
547 }
548
549 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
550 if (!hub->descriptor) {
551 message = "can't kmalloc hub descriptor";
552 ret = -ENOMEM;
553 goto fail;
554 }
555
556 /* Request the entire hub descriptor.
557 * hub->descriptor can handle USB_MAXCHILDREN ports,
558 * but the hub can/will return fewer bytes here.
559 */
560 ret = get_hub_descriptor(hdev, hub->descriptor,
561 sizeof(*hub->descriptor));
562 if (ret < 0) {
563 message = "can't read hub descriptor";
564 goto fail;
565 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
566 message = "hub has too many ports!";
567 ret = -ENODEV;
568 goto fail;
569 }
570
571 hdev->maxchild = hub->descriptor->bNbrPorts;
572 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
573 (hdev->maxchild == 1) ? "" : "s");
574
74ad9bd2 575 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1da177e4 576
74ad9bd2 577 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
1da177e4
LT		 578 int i;
579 char portstr [USB_MAXCHILDREN + 1];
580
581 for (i = 0; i < hdev->maxchild; i++)
582 portstr[i] = hub->descriptor->DeviceRemovable
583 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
584 ? 'F' : 'R';
585 portstr[hdev->maxchild] = 0;
586 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
587 } else
588 dev_dbg(hub_dev, "standalone hub\n");
589
74ad9bd2 590 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1da177e4
LT		 591 case 0x00:
592 dev_dbg(hub_dev, "ganged power switching\n");
593 break;
594 case 0x01:
595 dev_dbg(hub_dev, "individual port power switching\n");
596 break;
597 case 0x02:
598 case 0x03:
599 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
600 break;
601 }
602
74ad9bd2 603 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1da177e4
LT		 604 case 0x00:
605 dev_dbg(hub_dev, "global over-current protection\n");
606 break;
607 case 0x08:
608 dev_dbg(hub_dev, "individual port over-current protection\n");
609 break;
610 case 0x10:
611 case 0x18:
612 dev_dbg(hub_dev, "no over-current protection\n");
613 break;
614 }
615
616 spin_lock_init (&hub->tt.lock);
617 INIT_LIST_HEAD (&hub->tt.clear_list);
618 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
619 switch (hdev->descriptor.bDeviceProtocol) {
620 case 0:
621 break;
622 case 1:
623 dev_dbg(hub_dev, "Single TT\n");
624 hub->tt.hub = hdev;
625 break;
626 case 2:
627 ret = usb_set_interface(hdev, 0, 1);
628 if (ret == 0) {
629 dev_dbg(hub_dev, "TT per port\n");
630 hub->tt.multi = 1;
631 } else
632 dev_err(hub_dev, "Using single TT (err %d)\n",
633 ret);
634 hub->tt.hub = hdev;
635 break;
636 default:
637 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
638 hdev->descriptor.bDeviceProtocol);
639 break;
640 }
641
e09711ae 642 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
74ad9bd2 643 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
e09711ae
DB		 644 case HUB_TTTT_8_BITS:
645 if (hdev->descriptor.bDeviceProtocol != 0) {
646 hub->tt.think_time = 666;
647 dev_dbg(hub_dev, "TT requires at most %d "
648 "FS bit times (%d ns)\n",
649 8, hub->tt.think_time);
650 }
1da177e4 651 break;
e09711ae
DB		 652 case HUB_TTTT_16_BITS:
653 hub->tt.think_time = 666 * 2;
654 dev_dbg(hub_dev, "TT requires at most %d "
655 "FS bit times (%d ns)\n",
656 16, hub->tt.think_time);
1da177e4 657 break;
e09711ae
DB		 658 case HUB_TTTT_24_BITS:
659 hub->tt.think_time = 666 * 3;
660 dev_dbg(hub_dev, "TT requires at most %d "
661 "FS bit times (%d ns)\n",
662 24, hub->tt.think_time);
1da177e4 663 break;
e09711ae
DB		 664 case HUB_TTTT_32_BITS:
665 hub->tt.think_time = 666 * 4;
666 dev_dbg(hub_dev, "TT requires at most %d "
667 "FS bit times (%d ns)\n",
668 32, hub->tt.think_time);
1da177e4
LT		 669 break;
670 }
671
672 /* probe() zeroes hub->indicator[] */
74ad9bd2 673 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1da177e4
LT		 674 hub->has_indicators = 1;
675 dev_dbg(hub_dev, "Port indicators are supported\n");
676 }
677
678 dev_dbg(hub_dev, "power on to power good time: %dms\n",
679 hub->descriptor->bPwrOn2PwrGood * 2);
680
681 /* power budgeting mostly matters with bus-powered hubs,
682 * and battery-powered root hubs (may provide just 8 mA).
683 */
684 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
685 if (ret < 0) {
686 message = "can't get hub status";
687 goto fail;
688 }
7d35b929
AS		 689 le16_to_cpus(&hubstatus);
690 if (hdev == hdev->bus->root_hub) {
691 struct usb_hcd *hcd =
692 container_of(hdev->bus, struct usb_hcd, self);
693
694 hub->power_budget = min(500u, hcd->power_budget) / 2;
695 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1da177e4
LT		 696 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
697 hub->descriptor->bHubContrCurrent);
698 hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
699 / 2;
7d35b929
AS		 700 }
701 if (hub->power_budget)
1da177e4
LT		 702 dev_dbg(hub_dev, "%dmA bus power budget for children\n",
703 hub->power_budget * 2);
1da177e4
LT		 704
705
706 ret = hub_hub_status(hub, &hubstatus, &hubchange);
707 if (ret < 0) {
708 message = "can't get hub status";
709 goto fail;
710 }
711
712 /* local power status reports aren't always correct */
713 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
714 dev_dbg(hub_dev, "local power source is %s\n",
715 (hubstatus & HUB_STATUS_LOCAL_POWER)
716 ? "lost (inactive)" : "good");
717
74ad9bd2 718 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1da177e4
LT		 719 dev_dbg(hub_dev, "%sover-current condition exists\n",
720 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
721
722 /* set up the interrupt endpoint */
723 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
724 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
725
726 if (maxp > sizeof(*hub->buffer))
727 maxp = sizeof(*hub->buffer);
728
729 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
730 if (!hub->urb) {
731 message = "couldn't allocate interrupt urb";
732 ret = -ENOMEM;
733 goto fail;
734 }
735
736 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
737 hub, endpoint->bInterval);
738 hub->urb->transfer_dma = hub->buffer_dma;
739 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
740
741 /* maybe cycle the hub leds */
742 if (hub->has_indicators && blinkenlights)
743 hub->indicator [0] = INDICATOR_CYCLE;
744
745 hub_power_on(hub);
746 hub_activate(hub);
747 return 0;
748
749fail:
750 dev_err (hub_dev, "config failed, %s (err %d)\n",
751 message, ret);
752 /* hub_disconnect() frees urb and descriptor */
753 return ret;
754}
755
756static unsigned highspeed_hubs;
757
bf193d3c
AS		 758/* Called after the hub driver is unbound from a hub with children */
759static void hub_remove_children_work(void *__hub)
760{
761 struct usb_hub *hub = __hub;
762 struct usb_device *hdev = hub->hdev;
763 int i;
764
765 kfree(hub);
766
767 usb_lock_device(hdev);
768 for (i = 0; i < hdev->maxchild; ++i) {
769 if (hdev->children[i])
770 usb_disconnect(&hdev->children[i]);
771 }
772 usb_unlock_device(hdev);
773 usb_put_dev(hdev);
774}
775
1da177e4
LT		 776static void hub_disconnect(struct usb_interface *intf)
777{
778 struct usb_hub *hub = usb_get_intfdata (intf);
779 struct usb_device *hdev;
bf193d3c 780 int n, port1;
1da177e4 781
8b28c752 782 usb_set_intfdata (intf, NULL);
1da177e4
LT		 783 hdev = hub->hdev;
784
785 if (hdev->speed == USB_SPEED_HIGH)
786 highspeed_hubs--;
787
1da177e4
LT		 788 hub_quiesce(hub);
789 usb_free_urb(hub->urb);
790 hub->urb = NULL;
791
792 spin_lock_irq(&hub_event_lock);
793 list_del_init(&hub->event_list);
794 spin_unlock_irq(&hub_event_lock);
795
1bc3c9e1
JJ		 796 kfree(hub->descriptor);
797 hub->descriptor = NULL;
1da177e4 798
1bc3c9e1
JJ		 799 kfree(hub->status);
800 hub->status = NULL;
1da177e4
LT		 801
802 if (hub->buffer) {
803 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
804 hub->buffer_dma);
805 hub->buffer = NULL;
806 }
807
bf193d3c
AS		 808 /* If there are any children then this is an unbind only, not a
809 * physical disconnection. The active ports must be disabled
810 * and later on we must call usb_disconnect(). We can't call
811 * it now because we may not hold the hub's device lock.
812 */
813 n = 0;
814 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
815 if (hdev->children[port1 - 1]) {
816 ++n;
817 hub_port_disable(hub, port1, 1);
818 }
819 }
820
821 if (n == 0)
822 kfree(hub);
823 else {
824 /* Reuse the hub->leds work_struct for our own purposes */
825 INIT_WORK(&hub->leds, hub_remove_children_work, hub);
826 schedule_work(&hub->leds);
827 usb_get_dev(hdev);
828 }
1da177e4
LT		 829}
830
831static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
832{
833 struct usb_host_interface *desc;
834 struct usb_endpoint_descriptor *endpoint;
835 struct usb_device *hdev;
836 struct usb_hub *hub;
837
838 desc = intf->cur_altsetting;
839 hdev = interface_to_usbdev(intf);
840
841 /* Some hubs have a subclass of 1, which AFAICT according to the */
842 /* specs is not defined, but it works */
843 if ((desc->desc.bInterfaceSubClass != 0) &&
844 (desc->desc.bInterfaceSubClass != 1)) {
845descriptor_error:
846 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
847 return -EIO;
848 }
849
850 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
851 if (desc->desc.bNumEndpoints != 1)
852 goto descriptor_error;
853
854 endpoint = &desc->endpoint[0].desc;
855
856 /* Output endpoint? Curiouser and curiouser.. */
857 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
858 goto descriptor_error;
859
860 /* If it's not an interrupt endpoint, we'd better punt! */
861 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
862 != USB_ENDPOINT_XFER_INT)
863 goto descriptor_error;
864
865 /* We found a hub */
866 dev_info (&intf->dev, "USB hub found\n");
867
868 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
869 if (!hub) {
870 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
871 return -ENOMEM;
872 }
873
874 memset(hub, 0, sizeof(*hub));
875
876 INIT_LIST_HEAD(&hub->event_list);
877 hub->intfdev = &intf->dev;
878 hub->hdev = hdev;
879 INIT_WORK(&hub->leds, led_work, hub);
880
881 usb_set_intfdata (intf, hub);
882
883 if (hdev->speed == USB_SPEED_HIGH)
884 highspeed_hubs++;
885
886 if (hub_configure(hub, endpoint) >= 0)
887 return 0;
888
889 hub_disconnect (intf);
890 return -ENODEV;
891}
892
893static int
894hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
895{
896 struct usb_device *hdev = interface_to_usbdev (intf);
897
898 /* assert ifno == 0 (part of hub spec) */
899 switch (code) {
900 case USBDEVFS_HUB_PORTINFO: {
901 struct usbdevfs_hub_portinfo *info = user_data;
902 int i;
903
904 spin_lock_irq(&device_state_lock);
905 if (hdev->devnum <= 0)
906 info->nports = 0;
907 else {
908 info->nports = hdev->maxchild;
909 for (i = 0; i < info->nports; i++) {
910 if (hdev->children[i] == NULL)
911 info->port[i] = 0;
912 else
913 info->port[i] =
914 hdev->children[i]->devnum;
915 }
916 }
917 spin_unlock_irq(&device_state_lock);
918
919 return info->nports + 1;
920 }
921
922 default:
923 return -ENOSYS;
924 }
925}
926
927/* caller has locked the hub device */
928static void hub_pre_reset(struct usb_hub *hub)
929{
930 struct usb_device *hdev = hub->hdev;
931 int i;
932
933 for (i = 0; i < hdev->maxchild; ++i) {
934 if (hdev->children[i])
935 usb_disconnect(&hdev->children[i]);
936 }
937 hub_quiesce(hub);
938}
939
940/* caller has locked the hub device */
941static void hub_post_reset(struct usb_hub *hub)
942{
943 hub_activate(hub);
944 hub_power_on(hub);
945}
946
947
948/* grab device/port lock, returning index of that port (zero based).
949 * protects the upstream link used by this device from concurrent
950 * tree operations like suspend, resume, reset, and disconnect, which
951 * apply to everything downstream of a given port.
952 */
953static int locktree(struct usb_device *udev)
954{
955 int t;
956 struct usb_device *hdev;
957
958 if (!udev)
959 return -ENODEV;
960
961 /* root hub is always the first lock in the series */
962 hdev = udev->parent;
963 if (!hdev) {
964 usb_lock_device(udev);
965 return 0;
966 }
967
968 /* on the path from root to us, lock everything from
969 * top down, dropping parent locks when not needed
970 */
971 t = locktree(hdev);
972 if (t < 0)
973 return t;
974 for (t = 0; t < hdev->maxchild; t++) {
975 if (hdev->children[t] == udev) {
976 /* everything is fail-fast once disconnect
977 * processing starts
978 */
979 if (udev->state == USB_STATE_NOTATTACHED)
980 break;
981
982 /* when everyone grabs locks top->bottom,
983 * non-overlapping work may be concurrent
984 */
985 down(&udev->serialize);
986 up(&hdev->serialize);
987 return t + 1;
988 }
989 }
990 usb_unlock_device(hdev);
991 return -ENODEV;
992}
993
994static void recursively_mark_NOTATTACHED(struct usb_device *udev)
995{
996 int i;
997
998 for (i = 0; i < udev->maxchild; ++i) {
999 if (udev->children[i])
1000 recursively_mark_NOTATTACHED(udev->children[i]);
1001 }
1002 udev->state = USB_STATE_NOTATTACHED;
1003}
1004
1005/**
1006 * usb_set_device_state - change a device's current state (usbcore, hcds)
1007 * @udev: pointer to device whose state should be changed
1008 * @new_state: new state value to be stored
1009 *
1010 * udev->state is _not_ fully protected by the device lock. Although
1011 * most transitions are made only while holding the lock, the state can
1012 * can change to USB_STATE_NOTATTACHED at almost any time. This
1013 * is so that devices can be marked as disconnected as soon as possible,
1014 * without having to wait for any semaphores to be released. As a result,
1015 * all changes to any device's state must be protected by the
1016 * device_state_lock spinlock.
1017 *
1018 * Once a device has been added to the device tree, all changes to its state
1019 * should be made using this routine. The state should _not_ be set directly.
1020 *
1021 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1022 * Otherwise udev->state is set to new_state, and if new_state is
1023 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1024 * to USB_STATE_NOTATTACHED.
1025 */
1026void usb_set_device_state(struct usb_device *udev,
1027 enum usb_device_state new_state)
1028{
1029 unsigned long flags;
1030
1031 spin_lock_irqsave(&device_state_lock, flags);
1032 if (udev->state == USB_STATE_NOTATTACHED)
1033 ; /* do nothing */
b94dc6b5 1034 else if (new_state != USB_STATE_NOTATTACHED) {
1da177e4 1035 udev->state = new_state;
b94dc6b5
DB		 1036 if (new_state == USB_STATE_CONFIGURED)
1037 device_init_wakeup(&udev->dev,
1038 (udev->actconfig->desc.bmAttributes
1039 & USB_CONFIG_ATT_WAKEUP));
1040 else if (new_state != USB_STATE_SUSPENDED)
1041 device_init_wakeup(&udev->dev, 0);
1042 } else
1da177e4
LT		 1043 recursively_mark_NOTATTACHED(udev);
1044 spin_unlock_irqrestore(&device_state_lock, flags);
1045}
1046EXPORT_SYMBOL(usb_set_device_state);
1047
1048
1049static void choose_address(struct usb_device *udev)
1050{
1051 int devnum;
1052 struct usb_bus *bus = udev->bus;
1053
1054 /* If khubd ever becomes multithreaded, this will need a lock */
1055
1056 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1057 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1058 bus->devnum_next);
1059 if (devnum >= 128)
1060 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1061
1062 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1063
1064 if (devnum < 128) {
1065 set_bit(devnum, bus->devmap.devicemap);
1066 udev->devnum = devnum;
1067 }
1068}
1069
1070static void release_address(struct usb_device *udev)
1071{
1072 if (udev->devnum > 0) {
1073 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1074 udev->devnum = -1;
1075 }
1076}
1077
1078/**
1079 * usb_disconnect - disconnect a device (usbcore-internal)
1080 * @pdev: pointer to device being disconnected
1081 * Context: !in_interrupt ()
1082 *
1083 * Something got disconnected. Get rid of it and all of its children.
1084 *
1085 * If *pdev is a normal device then the parent hub must already be locked.
1086 * If *pdev is a root hub then this routine will acquire the
1087 * usb_bus_list_lock on behalf of the caller.
1088 *
1089 * Only hub drivers (including virtual root hub drivers for host
1090 * controllers) should ever call this.
1091 *
1092 * This call is synchronous, and may not be used in an interrupt context.
1093 */
1094void usb_disconnect(struct usb_device **pdev)
1095{
1096 struct usb_device *udev = *pdev;
1097 int i;
1098
1099 if (!udev) {
1100 pr_debug ("%s nodev\n", __FUNCTION__);
1101 return;
1102 }
1103
1104 /* mark the device as inactive, so any further urb submissions for
1105 * this device (and any of its children) will fail immediately.
1106 * this quiesces everyting except pending urbs.
1107 */
1108 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1109
1110 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1111 if (!udev->parent) {
1112 down(&usb_bus_list_lock);
1113 usb_lock_device(udev);
1114 } else
1115 down(&udev->serialize);
1116
1117 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1118
1119 /* Free up all the children before we remove this device */
1120 for (i = 0; i < USB_MAXCHILDREN; i++) {
1121 if (udev->children[i])
1122 usb_disconnect(&udev->children[i]);
1123 }
1124
1125 /* deallocate hcd/hardware state ... nuking all pending urbs and
1126 * cleaning up all state associated with the current configuration
1127 * so that the hardware is now fully quiesced.
1128 */
1129 usb_disable_device(udev, 0);
1130
3099e75a
GKH		 1131 usb_notify_remove_device(udev);
1132
1da177e4
LT		 1133 /* Free the device number, remove the /proc/bus/usb entry and
1134 * the sysfs attributes, and delete the parent's children[]
1135 * (or root_hub) pointer.
1136 */
1137 dev_dbg (&udev->dev, "unregistering device\n");
1138 release_address(udev);
1da177e4
LT		 1139 usb_remove_sysfs_dev_files(udev);
1140
1141 /* Avoid races with recursively_mark_NOTATTACHED() */
1142 spin_lock_irq(&device_state_lock);
1143 *pdev = NULL;
1144 spin_unlock_irq(&device_state_lock);
1145
1146 if (!udev->parent) {
1147 usb_unlock_device(udev);
1148 up(&usb_bus_list_lock);
1149 } else
1150 up(&udev->serialize);
1151
1152 device_unregister(&udev->dev);
1153}
1154
1155static int choose_configuration(struct usb_device *udev)
1156{
1157 int c, i;
1158
1159 /* NOTE: this should interact with hub power budgeting */
1160
1161 c = udev->config[0].desc.bConfigurationValue;
1162 if (udev->descriptor.bNumConfigurations != 1) {
1163 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1164 struct usb_interface_descriptor *desc;
1165
1166 /* heuristic: Linux is more likely to have class
1167 * drivers, so avoid vendor-specific interfaces.
1168 */
1169 desc = &udev->config[i].intf_cache[0]
1170 ->altsetting->desc;
1171 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1172 continue;
1173 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1174 * MSFT needs this to be the first config; never use
1175 * it as the default unless Linux has host-side RNDIS.
1176 * A second config would ideally be CDC-Ethernet, but
1177 * may instead be the "vendor specific" CDC subset
1178 * long used by ARM Linux for sa1100 or pxa255.
1179 */
1180 if (desc->bInterfaceClass == USB_CLASS_COMM
1181 && desc->bInterfaceSubClass == 2
1182 && desc->bInterfaceProtocol == 0xff) {
1183 c = udev->config[1].desc.bConfigurationValue;
1184 continue;
1185 }
1186 c = udev->config[i].desc.bConfigurationValue;
1187 break;
1188 }
1189 dev_info(&udev->dev,
1190 "configuration #%d chosen from %d choices\n",
1191 c, udev->descriptor.bNumConfigurations);
1192 }
1193 return c;
1194}
1195
1196#ifdef DEBUG
1197static void show_string(struct usb_device *udev, char *id, char *string)
1198{
1199 if (!string)
1200 return;
1201 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1202}
1203
1204#else
1205static inline void show_string(struct usb_device *udev, char *id, char *string)
1206{}
1207#endif
1208
1209static void get_string(struct usb_device *udev, char **string, int index)
1210{
1211 char *buf;
1212
1213 if (!index)
1214 return;
1215 buf = kmalloc(256, GFP_KERNEL);
1216 if (!buf)
1217 return;
1218 if (usb_string(udev, index, buf, 256) > 0)
1219 *string = buf;
1220 else
1221 kfree(buf);
1222}
1223
1224
1225#ifdef CONFIG_USB_OTG
1226#include "otg_whitelist.h"
1227#endif
1228
1229/**
1230 * usb_new_device - perform initial device setup (usbcore-internal)
1231 * @udev: newly addressed device (in ADDRESS state)
1232 *
1233 * This is called with devices which have been enumerated, but not yet
1234 * configured. The device descriptor is available, but not descriptors
1235 * for any device configuration. The caller must have locked udev and
1236 * either the parent hub (if udev is a normal device) or else the
1237 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1238 * udev has already been installed, but udev is not yet visible through
1239 * sysfs or other filesystem code.
1240 *
1241 * Returns 0 for success (device is configured and listed, with its
1242 * interfaces, in sysfs); else a negative errno value.
1243 *
1244 * This call is synchronous, and may not be used in an interrupt context.
1245 *
1246 * Only the hub driver should ever call this; root hub registration
1247 * uses it indirectly.
1248 */
1249int usb_new_device(struct usb_device *udev)
1250{
1251 int err;
1252 int c;
1253
1254 err = usb_get_configuration(udev);
1255 if (err < 0) {
1256 dev_err(&udev->dev, "can't read configurations, error %d\n",
1257 err);
1258 goto fail;
1259 }
1260
1261 /* read the standard strings and cache them if present */
1262 get_string(udev, &udev->product, udev->descriptor.iProduct);
1263 get_string(udev, &udev->manufacturer, udev->descriptor.iManufacturer);
1264 get_string(udev, &udev->serial, udev->descriptor.iSerialNumber);
1265
1266 /* Tell the world! */
1267 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1268 "SerialNumber=%d\n",
1269 udev->descriptor.iManufacturer,
1270 udev->descriptor.iProduct,
1271 udev->descriptor.iSerialNumber);
1272 show_string(udev, "Product", udev->product);
1273 show_string(udev, "Manufacturer", udev->manufacturer);
1274 show_string(udev, "SerialNumber", udev->serial);
1275
1276#ifdef CONFIG_USB_OTG
1277 /*
1278 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1279 * to wake us after we've powered off VBUS; and HNP, switching roles
1280 * "host" to "peripheral". The OTG descriptor helps figure this out.
1281 */
1282 if (!udev->bus->is_b_host
1283 && udev->config
1284 && udev->parent == udev->bus->root_hub) {
1285 struct usb_otg_descriptor *desc = 0;
1286 struct usb_bus *bus = udev->bus;
1287
1288 /* descriptor may appear anywhere in config */
1289 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1290 le16_to_cpu(udev->config[0].desc.wTotalLength),
1291 USB_DT_OTG, (void **) &desc) == 0) {
1292 if (desc->bmAttributes & USB_OTG_HNP) {
1293 unsigned port1;
1294 struct usb_device *root = udev->parent;
1295
1296 for (port1 = 1; port1 <= root->maxchild;
1297 port1++) {
1298 if (root->children[port1-1] == udev)
1299 break;
1300 }
1301
1302 dev_info(&udev->dev,
1303 "Dual-Role OTG device on %sHNP port\n",
1304 (port1 == bus->otg_port)
1305 ? "" : "non-");
1306
1307 /* enable HNP before suspend, it's simpler */
1308 if (port1 == bus->otg_port)
1309 bus->b_hnp_enable = 1;
1310 err = usb_control_msg(udev,
1311 usb_sndctrlpipe(udev, 0),
1312 USB_REQ_SET_FEATURE, 0,
1313 bus->b_hnp_enable
1314 ? USB_DEVICE_B_HNP_ENABLE
1315 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1316 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1317 if (err < 0) {
1318 /* OTG MESSAGE: report errors here,
1319 * customize to match your product.
1320 */
1321 dev_info(&udev->dev,
1322 "can't set HNP mode; %d\n",
1323 err);
1324 bus->b_hnp_enable = 0;
1325 }
1326 }
1327 }
1328 }
1329
1330 if (!is_targeted(udev)) {
1331
1332 /* Maybe it can talk to us, though we can't talk to it.
1333 * (Includes HNP test device.)
1334 */
1335 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
390a8c34
DB		 1336 static int __usb_suspend_device(struct usb_device *,
1337 int port1);
1338 err = __usb_suspend_device(udev, udev->bus->otg_port);
1da177e4
LT		 1339 if (err < 0)
1340 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1341 }
1342 err = -ENODEV;
1343 goto fail;
1344 }
1345#endif
1346
1347 /* put device-specific files into sysfs */
1348 err = device_add (&udev->dev);
1349 if (err) {
1350 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1351 goto fail;
1352 }
1353 usb_create_sysfs_dev_files (udev);
1354
1355 /* choose and set the configuration. that registers the interfaces
1356 * with the driver core, and lets usb device drivers bind to them.
1357 */
1358 c = choose_configuration(udev);
1359 if (c < 0)
1360 dev_warn(&udev->dev,
1361 "can't choose an initial configuration\n");
1362 else {
1363 err = usb_set_configuration(udev, c);
1364 if (err) {
1365 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1366 c, err);
1367 usb_remove_sysfs_dev_files(udev);
1368 device_del(&udev->dev);
1369 goto fail;
1370 }
1371 }
1372
1373 /* USB device state == configured ... usable */
3099e75a 1374 usb_notify_add_device(udev);
1da177e4 1375
1da177e4
LT		 1376 return 0;
1377
1378fail:
1379 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1380 return err;
1381}
1382
1383
1384static int hub_port_status(struct usb_hub *hub, int port1,
1385 u16 *status, u16 *change)
1386{
1387 int ret;
1388
1389 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1390 if (ret < 0)
1391 dev_err (hub->intfdev,
1392 "%s failed (err = %d)\n", __FUNCTION__, ret);
1393 else {
1394 *status = le16_to_cpu(hub->status->port.wPortStatus);
1395 *change = le16_to_cpu(hub->status->port.wPortChange);
1396 ret = 0;
1397 }
1398 return ret;
1399}
1400
1401#define PORT_RESET_TRIES 5
1402#define SET_ADDRESS_TRIES 2
1403#define GET_DESCRIPTOR_TRIES 2
1404#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1405#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1406
1407#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1408#define HUB_SHORT_RESET_TIME 10
1409#define HUB_LONG_RESET_TIME 200
1410#define HUB_RESET_TIMEOUT 500
1411
1412static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1413 struct usb_device *udev, unsigned int delay)
1414{
1415 int delay_time, ret;
1416 u16 portstatus;
1417 u16 portchange;
1418
1419 for (delay_time = 0;
1420 delay_time < HUB_RESET_TIMEOUT;
1421 delay_time += delay) {
1422 /* wait to give the device a chance to reset */
1423 msleep(delay);
1424
1425 /* read and decode port status */
1426 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1427 if (ret < 0)
1428 return ret;
1429
1430 /* Device went away? */
1431 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1432 return -ENOTCONN;
1433
1434 /* bomb out completely if something weird happened */
1435 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1436 return -EINVAL;
1437
1438 /* if we`ve finished resetting, then break out of the loop */
1439 if (!(portstatus & USB_PORT_STAT_RESET) &&
1440 (portstatus & USB_PORT_STAT_ENABLE)) {
1441 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1442 udev->speed = USB_SPEED_HIGH;
1443 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1444 udev->speed = USB_SPEED_LOW;
1445 else
1446 udev->speed = USB_SPEED_FULL;
1447 return 0;
1448 }
1449
1450 /* switch to the long delay after two short delay failures */
1451 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1452 delay = HUB_LONG_RESET_TIME;
1453
1454 dev_dbg (hub->intfdev,
1455 "port %d not reset yet, waiting %dms\n",
1456 port1, delay);
1457 }
1458
1459 return -EBUSY;
1460}
1461
1462static int hub_port_reset(struct usb_hub *hub, int port1,
1463 struct usb_device *udev, unsigned int delay)
1464{
1465 int i, status;
1466
1467 /* Reset the port */
1468 for (i = 0; i < PORT_RESET_TRIES; i++) {
1469 status = set_port_feature(hub->hdev,
1470 port1, USB_PORT_FEAT_RESET);
1471 if (status)
1472 dev_err(hub->intfdev,
1473 "cannot reset port %d (err = %d)\n",
1474 port1, status);
1475 else {
1476 status = hub_port_wait_reset(hub, port1, udev, delay);
dd16525b 1477 if (status && status != -ENOTCONN)
1da177e4
LT		 1478 dev_dbg(hub->intfdev,
1479 "port_wait_reset: err = %d\n",
1480 status);
1481 }
1482
1483 /* return on disconnect or reset */
1484 switch (status) {
1485 case 0:
b789696a
DB		 1486 /* TRSTRCY = 10 ms; plus some extra */
1487 msleep(10 + 40);
1da177e4
LT		 1488 /* FALL THROUGH */
1489 case -ENOTCONN:
1490 case -ENODEV:
1491 clear_port_feature(hub->hdev,
1492 port1, USB_PORT_FEAT_C_RESET);
1493 /* FIXME need disconnect() for NOTATTACHED device */
1494 usb_set_device_state(udev, status
1495 ? USB_STATE_NOTATTACHED
1496 : USB_STATE_DEFAULT);
1497 return status;
1498 }
1499
1500 dev_dbg (hub->intfdev,
1501 "port %d not enabled, trying reset again...\n",
1502 port1);
1503 delay = HUB_LONG_RESET_TIME;
1504 }
1505
1506 dev_err (hub->intfdev,
1507 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1508 port1);
1509
1510 return status;
1511}
1512
1da177e4
LT		 1513/*
1514 * Disable a port and mark a logical connnect-change event, so that some
1515 * time later khubd will disconnect() any existing usb_device on the port
1516 * and will re-enumerate if there actually is a device attached.
1517 */
1518static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1519{
1520 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1521 hub_port_disable(hub, port1, 1);
1522
1523 /* FIXME let caller ask to power down the port:
1524 * - some devices won't enumerate without a VBUS power cycle
1525 * - SRP saves power that way
390a8c34 1526 * - ... new call, TBD ...
1da177e4
LT		 1527 * That's easy if this hub can switch power per-port, and
1528 * khubd reactivates the port later (timer, SRP, etc).
1529 * Powerdown must be optional, because of reset/DFU.
1530 */
1531
1532 set_bit(port1, hub->change_bits);
1533 kick_khubd(hub);
1534}
1535
1536
1537#ifdef CONFIG_USB_SUSPEND
1538
1539/*
1540 * Selective port suspend reduces power; most suspended devices draw
1541 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1542 * All devices below the suspended port are also suspended.
1543 *
1544 * Devices leave suspend state when the host wakes them up. Some devices
1545 * also support "remote wakeup", where the device can activate the USB
1546 * tree above them to deliver data, such as a keypress or packet. In
1547 * some cases, this wakes the USB host.
1548 */
1549static int hub_port_suspend(struct usb_hub *hub, int port1,
1550 struct usb_device *udev)
1551{
1552 int status;
1553
1554 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1555
1556 /* enable remote wakeup when appropriate; this lets the device
1557 * wake up the upstream hub (including maybe the root hub).
1558 *
1559 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1560 * we don't explicitly enable it here.
1561 */
b94dc6b5 1562 if (device_may_wakeup(&udev->dev)) {
1da177e4
LT		 1563 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1564 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1565 USB_DEVICE_REMOTE_WAKEUP, 0,
1566 NULL, 0,
1567 USB_CTRL_SET_TIMEOUT);
1568 if (status)
1569 dev_dbg(&udev->dev,
1570 "won't remote wakeup, status %d\n",
1571 status);
1572 }
1573
1574 /* see 7.1.7.6 */
1575 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1576 if (status) {
1577 dev_dbg(hub->intfdev,
1578 "can't suspend port %d, status %d\n",
1579 port1, status);
1580 /* paranoia: "should not happen" */
1581 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1582 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1583 USB_DEVICE_REMOTE_WAKEUP, 0,
1584 NULL, 0,
1585 USB_CTRL_SET_TIMEOUT);
1586 } else {
1587 /* device has up to 10 msec to fully suspend */
1588 dev_dbg(&udev->dev, "usb suspend\n");
1589 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1590 msleep(10);
1591 }
1592 return status;
1593}
1594
1595/*
1596 * Devices on USB hub ports have only one "suspend" state, corresponding
ba9d35fb 1597 * to ACPI D2, "may cause the device to lose some context".
1da177e4
LT		 1598 * State transitions include:
1599 *
1600 * - suspend, resume ... when the VBUS power link stays live
1601 * - suspend, disconnect ... VBUS lost
1602 *
1603 * Once VBUS drop breaks the circuit, the port it's using has to go through
1604 * normal re-enumeration procedures, starting with enabling VBUS power.
1605 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1606 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1607 * timer, no SRP, no requests through sysfs.
390a8c34
DB		 1608 *
1609 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1610 * the root hub for their bus goes into global suspend ... so we don't
1611 * (falsely) update the device power state to say it suspended.
1da177e4 1612 */
390a8c34 1613static int __usb_suspend_device (struct usb_device *udev, int port1)
1da177e4 1614{
f3f3253d 1615 int status = 0;
1da177e4
LT		 1616
1617 /* caller owns the udev device lock */
1618 if (port1 < 0)
1619 return port1;
1620
1621 if (udev->state == USB_STATE_SUSPENDED
1622 || udev->state == USB_STATE_NOTATTACHED) {
1623 return 0;
1624 }
1625
c9f89fa4 1626 /* all interfaces must already be suspended */
1da177e4
LT		 1627 if (udev->actconfig) {
1628 int i;
1629
1630 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1631 struct usb_interface *intf;
1da177e4
LT		 1632
1633 intf = udev->actconfig->interface[i];
c9f89fa4
DB		 1634 if (is_active(intf)) {
1635 dev_dbg(&intf->dev, "nyet suspended\n");
1636 return -EBUSY;
1da177e4
LT		 1637 }
1638 }
1639 }
1640
f3f3253d
DB		 1641 /* we only change a device's upstream USB link.
1642 * root hubs have no upstream USB link.
1da177e4 1643 */
f3f3253d 1644 if (udev->parent)
1da177e4
LT		 1645 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1646 udev);
1647
1648 if (status == 0)
390a8c34 1649 udev->dev.power.power_state = PMSG_SUSPEND;
1da177e4
LT		 1650 return status;
1651}
1652
f3f3253d
DB		 1653#endif
1654
5edbfb7c 1655/*
1da177e4
LT		 1656 * usb_suspend_device - suspend a usb device
1657 * @udev: device that's no longer in active use
5edbfb7c 1658 * Context: must be able to sleep; device not locked; pm locks held
1da177e4
LT		 1659 *
1660 * Suspends a USB device that isn't in active use, conserving power.
1661 * Devices may wake out of a suspend, if anything important happens,
1662 * using the remote wakeup mechanism. They may also be taken out of
1663 * suspend by the host, using usb_resume_device(). It's also routine
1664 * to disconnect devices while they are suspended.
1665 *
390a8c34
DB		 1666 * This only affects the USB hardware for a device; its interfaces
1667 * (and, for hubs, child devices) must already have been suspended.
1668 *
1da177e4
LT		 1669 * Suspending OTG devices may trigger HNP, if that's been enabled
1670 * between a pair of dual-role devices. That will change roles, such
1671 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1672 *
1673 * Returns 0 on success, else negative errno.
1674 */
390a8c34 1675int usb_suspend_device(struct usb_device *udev)
1da177e4 1676{
f3f3253d 1677#ifdef CONFIG_USB_SUSPEND
1da177e4
LT		 1678 int port1, status;
1679
1680 port1 = locktree(udev);
1681 if (port1 < 0)
1682 return port1;
1683
390a8c34 1684 status = __usb_suspend_device(udev, port1);
1da177e4
LT		 1685 usb_unlock_device(udev);
1686 return status;
f3f3253d
DB		 1687#else
1688 /* NOTE: udev->state unchanged, it's not lying ... */
1689 udev->dev.power.power_state = PMSG_SUSPEND;
1690 return 0;
1691#endif
1da177e4
LT		 1692}
1693
f3f3253d 1694
1da177e4 1695/*
390a8c34
DB		 1696 * If the USB "suspend" state is in use (rather than "global suspend"),
1697 * many devices will be individually taken out of suspend state using
1698 * special" resume" signaling. These routines kick in shortly after
1da177e4
LT		 1699 * hardware resume signaling is finished, either because of selective
1700 * resume (by host) or remote wakeup (by device) ... now see what changed
1701 * in the tree that's rooted at this device.
1702 */
f3f3253d 1703static int finish_device_resume(struct usb_device *udev)
1da177e4
LT		 1704{
1705 int status;
1706 u16 devstatus;
1707
1708 /* caller owns the udev device lock */
f3f3253d 1709 dev_dbg(&udev->dev, "finish resume\n");
1da177e4
LT		 1710
1711 /* usb ch9 identifies four variants of SUSPENDED, based on what
1712 * state the device resumes to. Linux currently won't see the
1713 * first two on the host side; they'd be inside hub_port_init()
1714 * during many timeouts, but khubd can't suspend until later.
1715 */
1716 usb_set_device_state(udev, udev->actconfig
1717 ? USB_STATE_CONFIGURED
1718 : USB_STATE_ADDRESS);
1da177e4
LT		 1719
1720 /* 10.5.4.5 says be sure devices in the tree are still there.
1721 * For now let's assume the device didn't go crazy on resume,
1722 * and device drivers will know about any resume quirks.
1723 */
1724 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1725 if (status < 0)
1726 dev_dbg(&udev->dev,
1727 "gone after usb resume? status %d\n",
1728 status);
1729 else if (udev->actconfig) {
1730 unsigned i;
dbc3887e 1731 int (*resume)(struct device *);
1da177e4
LT		 1732
1733 le16_to_cpus(&devstatus);
f3f3253d
DB		 1734 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)
1735 && udev->parent) {
1da177e4
LT		 1736 status = usb_control_msg(udev,
1737 usb_sndctrlpipe(udev, 0),
1738 USB_REQ_CLEAR_FEATURE,
1739 USB_RECIP_DEVICE,
1740 USB_DEVICE_REMOTE_WAKEUP, 0,
1741 NULL, 0,
1742 USB_CTRL_SET_TIMEOUT);
1743 if (status) {
1744 dev_dbg(&udev->dev, "disable remote "
1745 "wakeup, status %d\n", status);
1746 status = 0;
1747 }
1748 }
1749
1750 /* resume interface drivers; if this is a hub, it
dbc3887e 1751 * may have a child resume event to deal with soon
1da177e4 1752 */
dbc3887e
DB		 1753 resume = udev->dev.bus->resume;
1754 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++)
1755 (void) resume(&udev->actconfig->interface[i]->dev);
1da177e4
LT		 1756 status = 0;
1757
1758 } else if (udev->devnum <= 0) {
1759 dev_dbg(&udev->dev, "bogus resume!\n");
1760 status = -EINVAL;
1761 }
1762 return status;
1763}
1764
f3f3253d
DB		 1765#ifdef CONFIG_USB_SUSPEND
1766
1da177e4
LT		 1767static int
1768hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1769{
1770 int status;
1771
1772 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1773
1774 /* see 7.1.7.7; affects power usage, but not budgeting */
1775 status = clear_port_feature(hub->hdev,
1776 port1, USB_PORT_FEAT_SUSPEND);
1777 if (status) {
1778 dev_dbg(hub->intfdev,
1779 "can't resume port %d, status %d\n",
1780 port1, status);
1781 } else {
1782 u16 devstatus;
1783 u16 portchange;
1784
1785 /* drive resume for at least 20 msec */
1786 if (udev)
1787 dev_dbg(&udev->dev, "RESUME\n");
1788 msleep(25);
1789
1790#define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1791 | USB_PORT_STAT_ENABLE \
1792 | USB_PORT_STAT_CONNECTION)
1793
1794 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1795 * stop resume signaling. Then finish the resume
1796 * sequence.
1797 */
1798 devstatus = portchange = 0;
1799 status = hub_port_status(hub, port1,
1800 &devstatus, &portchange);
1801 if (status < 0
1802 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1803 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1804 ) {
1805 dev_dbg(hub->intfdev,
1806 "port %d status %04x.%04x after resume, %d\n",
1807 port1, portchange, devstatus, status);
1808 } else {
1809 /* TRSMRCY = 10 msec */
1810 msleep(10);
1811 if (udev)
f3f3253d 1812 status = finish_device_resume(udev);
1da177e4
LT		 1813 }
1814 }
1815 if (status < 0)
1816 hub_port_logical_disconnect(hub, port1);
1817
1818 return status;
1819}
1820
f3f3253d 1821#endif
1da177e4 1822
5edbfb7c 1823/*
1da177e4
LT		 1824 * usb_resume_device - re-activate a suspended usb device
1825 * @udev: device to re-activate
5edbfb7c 1826 * Context: must be able to sleep; device not locked; pm locks held
1da177e4
LT		 1827 *
1828 * This will re-activate the suspended device, increasing power usage
1829 * while letting drivers communicate again with its endpoints.
1830 * USB resume explicitly guarantees that the power session between
1831 * the host and the device is the same as it was when the device
1832 * suspended.
1833 *
1834 * Returns 0 on success, else negative errno.
1835 */
1836int usb_resume_device(struct usb_device *udev)
1837{
1838 int port1, status;
1839
1840 port1 = locktree(udev);
1841 if (port1 < 0)
1842 return port1;
1843
f3f3253d
DB		 1844#ifdef CONFIG_USB_SUSPEND
1845 /* selective resume of one downstream hub-to-device port */
1846 if (udev->parent) {
1847 if (udev->state == USB_STATE_SUSPENDED) {
1848 // NOTE swsusp may bork us, device state being wrong...
1849 // NOTE this fails if parent is also suspended...
1850 status = hub_port_resume(hdev_to_hub(udev->parent),
1851 port1, udev);
1da177e4 1852 } else
f3f3253d
DB		 1853 status = 0;
1854 } else
1855#endif
1856 status = finish_device_resume(udev);
1857 if (status < 0)
1da177e4
LT		 1858 dev_dbg(&udev->dev, "can't resume, status %d\n",
1859 status);
1da177e4
LT		 1860
1861 usb_unlock_device(udev);
1862
1863 /* rebind drivers that had no suspend() */
1864 if (status == 0) {
1865 usb_lock_all_devices();
1866 bus_rescan_devices(&usb_bus_type);
1867 usb_unlock_all_devices();
1868 }
1869 return status;
1870}
1871
1872static int remote_wakeup(struct usb_device *udev)
1873{
1874 int status = 0;
1875
f3f3253d
DB		 1876#ifdef CONFIG_USB_SUSPEND
1877
1da177e4
LT		 1878 /* don't repeat RESUME sequence if this device
1879 * was already woken up by some other task
1880 */
1881 down(&udev->serialize);
1882 if (udev->state == USB_STATE_SUSPENDED) {
1883 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1884 /* TRSMRCY = 10 msec */
1885 msleep(10);
f3f3253d 1886 status = finish_device_resume(udev);
1da177e4
LT		 1887 }
1888 up(&udev->serialize);
f3f3253d 1889#endif
1da177e4
LT		 1890 return status;
1891}
1892
db690874 1893static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1da177e4
LT		 1894{
1895 struct usb_hub *hub = usb_get_intfdata (intf);
1896 struct usb_device *hdev = hub->hdev;
1897 unsigned port1;
1da177e4 1898
c9f89fa4 1899 /* fail if children aren't already suspended */
1da177e4
LT		 1900 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1901 struct usb_device *udev;
1902
1903 udev = hdev->children [port1-1];
f3f3253d
DB		 1904 if (udev && (udev->dev.power.power_state.event
1905 == PM_EVENT_ON
1906#ifdef CONFIG_USB_SUSPEND
1907 || udev->state != USB_STATE_SUSPENDED
1908#endif
1909 )) {
c9f89fa4
DB		 1910 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1911 return -EBUSY;
1912 }
1da177e4
LT		 1913 }
1914
f3f3253d
DB		 1915 /* "global suspend" of the downstream HC-to-USB interface */
1916 if (!hdev->parent) {
1917 struct usb_bus *bus = hdev->bus;
0c0382e3
AS		 1918 if (bus) {
1919 int status = hcd_bus_suspend (bus);
f3f3253d
DB		 1920
1921 if (status != 0) {
1922 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1923 status);
1924 return status;
1925 }
1926 } else
1927 return -EOPNOTSUPP;
1928 }
1929
c9f89fa4
DB		 1930 /* stop khubd and related activity */
1931 hub_quiesce(hub);
1da177e4
LT		 1932 return 0;
1933}
1934
1935static int hub_resume(struct usb_interface *intf)
1936{
1937 struct usb_device *hdev = interface_to_usbdev(intf);
1938 struct usb_hub *hub = usb_get_intfdata (intf);
1da177e4
LT		 1939 int status;
1940
f3f3253d
DB		 1941 /* "global resume" of the downstream HC-to-USB interface */
1942 if (!hdev->parent) {
1943 struct usb_bus *bus = hdev->bus;
0c0382e3
AS		 1944 if (bus) {
1945 status = hcd_bus_resume (bus);
f3f3253d
DB		 1946 if (status) {
1947 dev_dbg(&intf->dev, "'global' resume %d\n",
1948 status);
1949 return status;
1950 }
1951 } else
1952 return -EOPNOTSUPP;
1953 if (status == 0) {
1954 /* TRSMRCY = 10 msec */
1955 msleep(10);
1956 }
1957 }
1958
1959 hub_activate(hub);
1960
1961 /* REVISIT: this recursion probably shouldn't exist. Remove
1962 * this code sometime, after retesting with different root and
1963 * external hubs.
1964 */
1965#ifdef CONFIG_USB_SUSPEND
1966 {
1967 unsigned port1;
1968
1da177e4
LT		 1969 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1970 struct usb_device *udev;
1971 u16 portstat, portchange;
1972
1973 udev = hdev->children [port1-1];
1974 status = hub_port_status(hub, port1, &portstat, &portchange);
1975 if (status == 0) {
1976 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1977 clear_port_feature(hdev, port1,
1978 USB_PORT_FEAT_C_SUSPEND);
1979 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1980 }
1981
1982 /* let khubd handle disconnects etc */
1983 if (portchange)
1984 continue;
1985 }
1986
1987 if (!udev || status < 0)
1988 continue;
1989 down (&udev->serialize);
1990 if (portstat & USB_PORT_STAT_SUSPEND)
1991 status = hub_port_resume(hub, port1, udev);
1992 else {
f3f3253d 1993 status = finish_device_resume(udev);
1da177e4
LT		 1994 if (status < 0) {
1995 dev_dbg(&intf->dev, "resume port %d --> %d\n",
1996 port1, status);
1997 hub_port_logical_disconnect(hub, port1);
1998 }
1999 }
2000 up(&udev->serialize);
2001 }
f3f3253d
DB		 2002 }
2003#endif
1da177e4
LT		 2004 return 0;
2005}
2006
979d5199
DB		 2007void usb_suspend_root_hub(struct usb_device *hdev)
2008{
2009 struct usb_hub *hub = hdev_to_hub(hdev);
2010
2011 /* This also makes any led blinker stop retriggering. We're called
2012 * from irq, so the blinker might still be scheduled. Caller promises
2013 * that the root hub status URB will be canceled.
2014 */
2015 __hub_quiesce(hub);
2016 mark_quiesced(to_usb_interface(hub->intfdev));
2017}
2018
1da177e4
LT		 2019void usb_resume_root_hub(struct usb_device *hdev)
2020{
2021 struct usb_hub *hub = hdev_to_hub(hdev);
2022
2023 hub->resume_root_hub = 1;
2024 kick_khubd(hub);
2025}
2026
1da177e4
LT		 2027
2028/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2029 *
2030 * Between connect detection and reset signaling there must be a delay
2031 * of 100ms at least for debounce and power-settling. The corresponding
2032 * timer shall restart whenever the downstream port detects a disconnect.
2033 *
2034 * Apparently there are some bluetooth and irda-dongles and a number of
2035 * low-speed devices for which this debounce period may last over a second.
2036 * Not covered by the spec - but easy to deal with.
2037 *
2038 * This implementation uses a 1500ms total debounce timeout; if the
2039 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2040 * every 25ms for transient disconnects. When the port status has been
2041 * unchanged for 100ms it returns the port status.
2042 */
2043
2044#define HUB_DEBOUNCE_TIMEOUT 1500
2045#define HUB_DEBOUNCE_STEP 25
2046#define HUB_DEBOUNCE_STABLE 100
2047
2048static int hub_port_debounce(struct usb_hub *hub, int port1)
2049{
2050 int ret;
2051 int total_time, stable_time = 0;
2052 u16 portchange, portstatus;
2053 unsigned connection = 0xffff;
2054
2055 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2056 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2057 if (ret < 0)
2058 return ret;
2059
2060 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2061 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2062 stable_time += HUB_DEBOUNCE_STEP;
2063 if (stable_time >= HUB_DEBOUNCE_STABLE)
2064 break;
2065 } else {
2066 stable_time = 0;
2067 connection = portstatus & USB_PORT_STAT_CONNECTION;
2068 }
2069
2070 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2071 clear_port_feature(hub->hdev, port1,
2072 USB_PORT_FEAT_C_CONNECTION);
2073 }
2074
2075 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2076 break;
2077 msleep(HUB_DEBOUNCE_STEP);
2078 }
2079
2080 dev_dbg (hub->intfdev,
2081 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2082 port1, total_time, stable_time, portstatus);
2083
2084 if (stable_time < HUB_DEBOUNCE_STABLE)
2085 return -ETIMEDOUT;
2086 return portstatus;
2087}
2088
2089static void ep0_reinit(struct usb_device *udev)
2090{
2091 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2092 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2093 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2094}
2095
2096#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2097#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2098
2099static int hub_set_address(struct usb_device *udev)
2100{
2101 int retval;
2102
2103 if (udev->devnum == 0)
2104 return -EINVAL;
2105 if (udev->state == USB_STATE_ADDRESS)
2106 return 0;
2107 if (udev->state != USB_STATE_DEFAULT)
2108 return -EINVAL;
2109 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2110 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2111 NULL, 0, USB_CTRL_SET_TIMEOUT);
2112 if (retval == 0) {
2113 usb_set_device_state(udev, USB_STATE_ADDRESS);
2114 ep0_reinit(udev);
2115 }
2116 return retval;
2117}
2118
2119/* Reset device, (re)assign address, get device descriptor.
2120 * Device connection must be stable, no more debouncing needed.
2121 * Returns device in USB_STATE_ADDRESS, except on error.
2122 *
2123 * If this is called for an already-existing device (as part of
2124 * usb_reset_device), the caller must own the device lock. For a
2125 * newly detected device that is not accessible through any global
2126 * pointers, it's not necessary to lock the device.
2127 */
2128static int
2129hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2130 int retry_counter)
2131{
2132 static DECLARE_MUTEX(usb_address0_sem);
2133
2134 struct usb_device *hdev = hub->hdev;
2135 int i, j, retval;
2136 unsigned delay = HUB_SHORT_RESET_TIME;
2137 enum usb_device_speed oldspeed = udev->speed;
2138
2139 /* root hub ports have a slightly longer reset period
2140 * (from USB 2.0 spec, section 7.1.7.5)
2141 */
2142 if (!hdev->parent) {
2143 delay = HUB_ROOT_RESET_TIME;
2144 if (port1 == hdev->bus->otg_port)
2145 hdev->bus->b_hnp_enable = 0;
2146 }
2147
2148 /* Some low speed devices have problems with the quick delay, so */
2149 /* be a bit pessimistic with those devices. RHbug #23670 */
2150 if (oldspeed == USB_SPEED_LOW)
2151 delay = HUB_LONG_RESET_TIME;
2152
2153 down(&usb_address0_sem);
2154
2155 /* Reset the device; full speed may morph to high speed */
2156 retval = hub_port_reset(hub, port1, udev, delay);
2157 if (retval < 0) /* error or disconnect */
2158 goto fail;
2159 /* success, speed is known */
2160 retval = -ENODEV;
2161
2162 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2163 dev_dbg(&udev->dev, "device reset changed speed!\n");
2164 goto fail;
2165 }
2166 oldspeed = udev->speed;
2167
2168 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2169 * it's fixed size except for full speed devices.
2170 */
2171 switch (udev->speed) {
2172 case USB_SPEED_HIGH: /* fixed at 64 */
2173 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2174 break;
2175 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2176 /* to determine the ep0 maxpacket size, try to read
2177 * the device descriptor to get bMaxPacketSize0 and
2178 * then correct our initial guess.
2179 */
2180 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2181 break;
2182 case USB_SPEED_LOW: /* fixed at 8 */
2183 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2184 break;
2185 default:
2186 goto fail;
2187 }
2188
2189 dev_info (&udev->dev,
2190 "%s %s speed USB device using %s and address %d\n",
2191 (udev->config) ? "reset" : "new",
2192 ({ char *speed; switch (udev->speed) {
2193 case USB_SPEED_LOW: speed = "low"; break;
2194 case USB_SPEED_FULL: speed = "full"; break;
2195 case USB_SPEED_HIGH: speed = "high"; break;
2196 default: speed = "?"; break;
2197 }; speed;}),
2198 udev->bus->controller->driver->name,
2199 udev->devnum);
2200
2201 /* Set up TT records, if needed */
2202 if (hdev->tt) {
2203 udev->tt = hdev->tt;
2204 udev->ttport = hdev->ttport;
2205 } else if (udev->speed != USB_SPEED_HIGH
2206 && hdev->speed == USB_SPEED_HIGH) {
2207 udev->tt = &hub->tt;
2208 udev->ttport = port1;
2209 }
2210
2211 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2212 * Because device hardware and firmware is sometimes buggy in
2213 * this area, and this is how Linux has done it for ages.
2214 * Change it cautiously.
2215 *
2216 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2217 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2218 * so it may help with some non-standards-compliant devices.
2219 * Otherwise we start with SET_ADDRESS and then try to read the
2220 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2221 * value.
2222 */
2223 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2224 if (USE_NEW_SCHEME(retry_counter)) {
2225 struct usb_device_descriptor *buf;
2226 int r = 0;
2227
2228#define GET_DESCRIPTOR_BUFSIZE 64
2229 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2230 if (!buf) {
2231 retval = -ENOMEM;
2232 continue;
2233 }
2234
2235 /* Use a short timeout the first time through,
2236 * so that recalcitrant full-speed devices with
2237 * 8- or 16-byte ep0-maxpackets won't slow things
2238 * down tremendously by NAKing the unexpectedly
2239 * early status stage. Also, retry on all errors;
2240 * some devices are flakey.
2241 */
2242 for (j = 0; j < 3; ++j) {
2243 buf->bMaxPacketSize0 = 0;
2244 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2245 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2246 USB_DT_DEVICE << 8, 0,
2247 buf, GET_DESCRIPTOR_BUFSIZE,
2248 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2249 switch (buf->bMaxPacketSize0) {
2250 case 8: case 16: case 32: case 64:
2251 if (buf->bDescriptorType ==
2252 USB_DT_DEVICE) {
2253 r = 0;
2254 break;
2255 }
2256 /* FALL THROUGH */
2257 default:
2258 if (r == 0)
2259 r = -EPROTO;
2260 break;
2261 }
2262 if (r == 0)
2263 break;
2264 }
2265 udev->descriptor.bMaxPacketSize0 =
2266 buf->bMaxPacketSize0;
2267 kfree(buf);
2268
2269 retval = hub_port_reset(hub, port1, udev, delay);
2270 if (retval < 0) /* error or disconnect */
2271 goto fail;
2272 if (oldspeed != udev->speed) {
2273 dev_dbg(&udev->dev,
2274 "device reset changed speed!\n");
2275 retval = -ENODEV;
2276 goto fail;
2277 }
2278 if (r) {
2279 dev_err(&udev->dev, "device descriptor "
2280 "read/%s, error %d\n",
2281 "64", r);
2282 retval = -EMSGSIZE;
2283 continue;
2284 }
2285#undef GET_DESCRIPTOR_BUFSIZE
2286 }
2287
2288 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2289 retval = hub_set_address(udev);
2290 if (retval >= 0)
2291 break;
2292 msleep(200);
2293 }
2294 if (retval < 0) {
2295 dev_err(&udev->dev,
2296 "device not accepting address %d, error %d\n",
2297 udev->devnum, retval);
2298 goto fail;
2299 }
2300
2301 /* cope with hardware quirkiness:
2302 * - let SET_ADDRESS settle, some device hardware wants it
2303 * - read ep0 maxpacket even for high and low speed,
2304 */
2305 msleep(10);
2306 if (USE_NEW_SCHEME(retry_counter))
2307 break;
2308
2309 retval = usb_get_device_descriptor(udev, 8);
2310 if (retval < 8) {
2311 dev_err(&udev->dev, "device descriptor "
2312 "read/%s, error %d\n",
2313 "8", retval);
2314 if (retval >= 0)
2315 retval = -EMSGSIZE;
2316 } else {
2317 retval = 0;
2318 break;
2319 }
2320 }
2321 if (retval)
2322 goto fail;
2323
2324 i = udev->descriptor.bMaxPacketSize0;
2325 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2326 if (udev->speed != USB_SPEED_FULL ||
2327 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2328 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2329 retval = -EMSGSIZE;
2330 goto fail;
2331 }
2332 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2333 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2334 ep0_reinit(udev);
2335 }
2336
2337 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2338 if (retval < (signed)sizeof(udev->descriptor)) {
2339 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2340 "all", retval);
2341 if (retval >= 0)
2342 retval = -ENOMSG;
2343 goto fail;
2344 }
2345
2346 retval = 0;
2347
2348fail:
2349 if (retval)
2350 hub_port_disable(hub, port1, 0);
2351 up(&usb_address0_sem);
2352 return retval;
2353}
2354
2355static void
2356check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2357{
2358 struct usb_qualifier_descriptor *qual;
2359 int status;
2360
2361 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2362 if (qual == NULL)
2363 return;
2364
2365 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2366 qual, sizeof *qual);
2367 if (status == sizeof *qual) {
2368 dev_info(&udev->dev, "not running at top speed; "
2369 "connect to a high speed hub\n");
2370 /* hub LEDs are probably harder to miss than syslog */
2371 if (hub->has_indicators) {
2372 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2373 schedule_work (&hub->leds);
2374 }
2375 }
1bc3c9e1 2376 kfree(qual);
1da177e4
LT		 2377}
2378
2379static unsigned
2380hub_power_remaining (struct usb_hub *hub)
2381{
2382 struct usb_device *hdev = hub->hdev;
2383 int remaining;
2384 unsigned i;
2385
2386 remaining = hub->power_budget;
2387 if (!remaining) /* self-powered */
2388 return 0;
2389
2390 for (i = 0; i < hdev->maxchild; i++) {
2391 struct usb_device *udev = hdev->children[i];
2392 int delta, ceiling;
2393
2394 if (!udev)
2395 continue;
2396
2397 /* 100mA per-port ceiling, or 8mA for OTG ports */
2398 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2399 ceiling = 50;
2400 else
2401 ceiling = 4;
2402
2403 if (udev->actconfig)
2404 delta = udev->actconfig->desc.bMaxPower;
2405 else
2406 delta = ceiling;
2407 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2408 if (delta > ceiling)
2409 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2410 2 * (delta - ceiling), 2 * ceiling);
2411 remaining -= delta;
2412 }
2413 if (remaining < 0) {
2414 dev_warn(hub->intfdev,
2415 "%dmA over power budget!\n",
2416 -2 * remaining);
2417 remaining = 0;
2418 }
2419 return remaining;
2420}
2421
2422/* Handle physical or logical connection change events.
2423 * This routine is called when:
2424 * a port connection-change occurs;
2425 * a port enable-change occurs (often caused by EMI);
2426 * usb_reset_device() encounters changed descriptors (as from
2427 * a firmware download)
2428 * caller already locked the hub
2429 */
2430static void hub_port_connect_change(struct usb_hub *hub, int port1,
2431 u16 portstatus, u16 portchange)
2432{
2433 struct usb_device *hdev = hub->hdev;
2434 struct device *hub_dev = hub->intfdev;
74ad9bd2 2435 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1da177e4
LT		 2436 int status, i;
2437
2438 dev_dbg (hub_dev,
2439 "port %d, status %04x, change %04x, %s\n",
2440 port1, portstatus, portchange, portspeed (portstatus));
2441
2442 if (hub->has_indicators) {
2443 set_port_led(hub, port1, HUB_LED_AUTO);
2444 hub->indicator[port1-1] = INDICATOR_AUTO;
2445 }
2446
2447 /* Disconnect any existing devices under this port */
2448 if (hdev->children[port1-1])
2449 usb_disconnect(&hdev->children[port1-1]);
2450 clear_bit(port1, hub->change_bits);
2451
2452#ifdef CONFIG_USB_OTG
2453 /* during HNP, don't repeat the debounce */
2454 if (hdev->bus->is_b_host)
2455 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2456#endif
2457
2458 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2459 status = hub_port_debounce(hub, port1);
2460 if (status < 0) {
2461 dev_err (hub_dev,
2462 "connect-debounce failed, port %d disabled\n",
2463 port1);
2464 goto done;
2465 }
2466 portstatus = status;
2467 }
2468
2469 /* Return now if nothing is connected */
2470 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2471
2472 /* maybe switch power back on (e.g. root hub was reset) */
74ad9bd2 2473 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
1da177e4
LT		 2474 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2475 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2476
2477 if (portstatus & USB_PORT_STAT_ENABLE)
2478 goto done;
2479 return;
2480 }
2481
2482#ifdef CONFIG_USB_SUSPEND
2483 /* If something is connected, but the port is suspended, wake it up. */
2484 if (portstatus & USB_PORT_STAT_SUSPEND) {
2485 status = hub_port_resume(hub, port1, NULL);
2486 if (status < 0) {
2487 dev_dbg(hub_dev,
2488 "can't clear suspend on port %d; %d\n",
2489 port1, status);
2490 goto done;
2491 }
2492 }
2493#endif
2494
2495 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2496 struct usb_device *udev;
2497
2498 /* reallocate for each attempt, since references
2499 * to the previous one can escape in various ways
2500 */
2501 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2502 if (!udev) {
2503 dev_err (hub_dev,
2504 "couldn't allocate port %d usb_device\n",
2505 port1);
2506 goto done;
2507 }
2508
2509 usb_set_device_state(udev, USB_STATE_POWERED);
2510 udev->speed = USB_SPEED_UNKNOWN;
2511
2512 /* set the address */
2513 choose_address(udev);
2514 if (udev->devnum <= 0) {
2515 status = -ENOTCONN; /* Don't retry */
2516 goto loop;
2517 }
2518
2519 /* reset and get descriptor */
2520 status = hub_port_init(hub, udev, port1, i);
2521 if (status < 0)
2522 goto loop;
2523
2524 /* consecutive bus-powered hubs aren't reliable; they can
2525 * violate the voltage drop budget. if the new child has
2526 * a "powered" LED, users should notice we didn't enable it
2527 * (without reading syslog), even without per-port LEDs
2528 * on the parent.
2529 */
2530 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2531 && hub->power_budget) {
2532 u16 devstat;
2533
2534 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2535 &devstat);
2536 if (status < 0) {
2537 dev_dbg(&udev->dev, "get status %d ?\n", status);
2538 goto loop_disable;
2539 }
2540 cpu_to_le16s(&devstat);
2541 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2542 dev_err(&udev->dev,
2543 "can't connect bus-powered hub "
2544 "to this port\n");
2545 if (hub->has_indicators) {
2546 hub->indicator[port1-1] =
2547 INDICATOR_AMBER_BLINK;
2548 schedule_work (&hub->leds);
2549 }
2550 status = -ENOTCONN; /* Don't retry */
2551 goto loop_disable;
2552 }
2553 }
2554
2555 /* check for devices running slower than they could */
2556 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2557 && udev->speed == USB_SPEED_FULL
2558 && highspeed_hubs != 0)
2559 check_highspeed (hub, udev, port1);
2560
2561 /* Store the parent's children[] pointer. At this point
2562 * udev becomes globally accessible, although presumably
2563 * no one will look at it until hdev is unlocked.
2564 */
2565 down (&udev->serialize);
2566 status = 0;
2567
2568 /* We mustn't add new devices if the parent hub has
2569 * been disconnected; we would race with the
2570 * recursively_mark_NOTATTACHED() routine.
2571 */
2572 spin_lock_irq(&device_state_lock);
2573 if (hdev->state == USB_STATE_NOTATTACHED)
2574 status = -ENOTCONN;
2575 else
2576 hdev->children[port1-1] = udev;
2577 spin_unlock_irq(&device_state_lock);
2578
2579 /* Run it through the hoops (find a driver, etc) */
2580 if (!status) {
2581 status = usb_new_device(udev);
2582 if (status) {
2583 spin_lock_irq(&device_state_lock);
2584 hdev->children[port1-1] = NULL;
2585 spin_unlock_irq(&device_state_lock);
2586 }
2587 }
2588
2589 up (&udev->serialize);
2590 if (status)
2591 goto loop_disable;
2592
2593 status = hub_power_remaining(hub);
2594 if (status)
2595 dev_dbg(hub_dev,
2596 "%dmA power budget left\n",
2597 2 * status);
2598
2599 return;
2600
2601loop_disable:
2602 hub_port_disable(hub, port1, 1);
2603loop:
2604 ep0_reinit(udev);
2605 release_address(udev);
2606 usb_put_dev(udev);
2607 if (status == -ENOTCONN)
2608 break;
2609 }
2610
2611done:
2612 hub_port_disable(hub, port1, 1);
2613}
2614
2615static void hub_events(void)
2616{
2617 struct list_head *tmp;
2618 struct usb_device *hdev;
2619 struct usb_interface *intf;
2620 struct usb_hub *hub;
2621 struct device *hub_dev;
2622 u16 hubstatus;
2623 u16 hubchange;
2624 u16 portstatus;
2625 u16 portchange;
2626 int i, ret;
2627 int connect_change;
2628
2629 /*
2630 * We restart the list every time to avoid a deadlock with
2631 * deleting hubs downstream from this one. This should be
2632 * safe since we delete the hub from the event list.
2633 * Not the most efficient, but avoids deadlocks.
2634 */
2635 while (1) {
2636
2637 /* Grab the first entry at the beginning of the list */
2638 spin_lock_irq(&hub_event_lock);
2639 if (list_empty(&hub_event_list)) {
2640 spin_unlock_irq(&hub_event_lock);
2641 break;
2642 }
2643
2644 tmp = hub_event_list.next;
2645 list_del_init(tmp);
2646
2647 hub = list_entry(tmp, struct usb_hub, event_list);
2648 hdev = hub->hdev;
2649 intf = to_usb_interface(hub->intfdev);
2650 hub_dev = &intf->dev;
2651
979d5199
DB		 2652 i = hub->resume_root_hub;
2653
2654 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
1da177e4
LT		 2655 hdev->state, hub->descriptor
2656 ? hub->descriptor->bNbrPorts
2657 : 0,
2658 /* NOTE: expects max 15 ports... */
2659 (u16) hub->change_bits[0],
979d5199
DB		 2660 (u16) hub->event_bits[0],
2661 i ? ", resume root" : "");
1da177e4
LT		 2662
2663 usb_get_intf(intf);
1da177e4
LT		 2664 spin_unlock_irq(&hub_event_lock);
2665
979d5199
DB		 2666 /* Is this is a root hub wanting to reactivate the downstream
2667 * ports? If so, be sure the interface resumes even if its
2668 * stub "device" node was never suspended.
2669 */
2670 if (i) {
2671 extern void dpm_runtime_resume(struct device *);
2672
2673 dpm_runtime_resume(&hdev->dev);
2674 dpm_runtime_resume(&intf->dev);
2675 }
1da177e4
LT		 2676
2677 /* Lock the device, then check to see if we were
2678 * disconnected while waiting for the lock to succeed. */
2679 if (locktree(hdev) < 0) {
2680 usb_put_intf(intf);
2681 continue;
2682 }
2683 if (hub != usb_get_intfdata(intf))
2684 goto loop;
2685
2686 /* If the hub has died, clean up after it */
2687 if (hdev->state == USB_STATE_NOTATTACHED) {
2688 hub_pre_reset(hub);
2689 goto loop;
2690 }
2691
2692 /* If this is an inactive or suspended hub, do nothing */
2693 if (hub->quiescing)
2694 goto loop;
2695
2696 if (hub->error) {
2697 dev_dbg (hub_dev, "resetting for error %d\n",
2698 hub->error);
2699
2700 ret = usb_reset_device(hdev);
2701 if (ret) {
2702 dev_dbg (hub_dev,
2703 "error resetting hub: %d\n", ret);
2704 goto loop;
2705 }
2706
2707 hub->nerrors = 0;
2708 hub->error = 0;
2709 }
2710
2711 /* deal with port status changes */
2712 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2713 if (test_bit(i, hub->busy_bits))
2714 continue;
2715 connect_change = test_bit(i, hub->change_bits);
2716 if (!test_and_clear_bit(i, hub->event_bits) &&
2717 !connect_change && !hub->activating)
2718 continue;
2719
2720 ret = hub_port_status(hub, i,
2721 &portstatus, &portchange);
2722 if (ret < 0)
2723 continue;
2724
2725 if (hub->activating && !hdev->children[i-1] &&
2726 (portstatus &
2727 USB_PORT_STAT_CONNECTION))
2728 connect_change = 1;
2729
2730 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2731 clear_port_feature(hdev, i,
2732 USB_PORT_FEAT_C_CONNECTION);
2733 connect_change = 1;
2734 }
2735
2736 if (portchange & USB_PORT_STAT_C_ENABLE) {
2737 if (!connect_change)
2738 dev_dbg (hub_dev,
2739 "port %d enable change, "
2740 "status %08x\n",
2741 i, portstatus);
2742 clear_port_feature(hdev, i,
2743 USB_PORT_FEAT_C_ENABLE);
2744
2745 /*
2746 * EM interference sometimes causes badly
2747 * shielded USB devices to be shutdown by
2748 * the hub, this hack enables them again.
2749 * Works at least with mouse driver.
2750 */
2751 if (!(portstatus & USB_PORT_STAT_ENABLE)
2752 && !connect_change
2753 && hdev->children[i-1]) {
2754 dev_err (hub_dev,
2755 "port %i "
2756 "disabled by hub (EMI?), "
2757 "re-enabling...\n",
2758 i);
2759 connect_change = 1;
2760 }
2761 }
2762
2763 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2764 clear_port_feature(hdev, i,
2765 USB_PORT_FEAT_C_SUSPEND);
2766 if (hdev->children[i-1]) {
2767 ret = remote_wakeup(hdev->
2768 children[i-1]);
2769 if (ret < 0)
2770 connect_change = 1;
2771 } else {
2772 ret = -ENODEV;
2773 hub_port_disable(hub, i, 1);
2774 }
2775 dev_dbg (hub_dev,
2776 "resume on port %d, status %d\n",
2777 i, ret);
2778 }
2779
2780 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2781 dev_err (hub_dev,
2782 "over-current change on port %d\n",
2783 i);
2784 clear_port_feature(hdev, i,
2785 USB_PORT_FEAT_C_OVER_CURRENT);
2786 hub_power_on(hub);
2787 }
2788
2789 if (portchange & USB_PORT_STAT_C_RESET) {
2790 dev_dbg (hub_dev,
2791 "reset change on port %d\n",
2792 i);
2793 clear_port_feature(hdev, i,
2794 USB_PORT_FEAT_C_RESET);
2795 }
2796
2797 if (connect_change)
2798 hub_port_connect_change(hub, i,
2799 portstatus, portchange);
2800 } /* end for i */
2801
2802 /* deal with hub status changes */
2803 if (test_and_clear_bit(0, hub->event_bits) == 0)
2804 ; /* do nothing */
2805 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2806 dev_err (hub_dev, "get_hub_status failed\n");
2807 else {
2808 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2809 dev_dbg (hub_dev, "power change\n");
2810 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2811 }
2812 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2813 dev_dbg (hub_dev, "overcurrent change\n");
2814 msleep(500); /* Cool down */
2815 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2816 hub_power_on(hub);
2817 }
2818 }
2819
2820 hub->activating = 0;
2821
d5926ae7
AS		 2822 /* If this is a root hub, tell the HCD it's okay to
2823 * re-enable port-change interrupts now. */
2824 if (!hdev->parent)
2825 usb_enable_root_hub_irq(hdev->bus);
2826
1da177e4
LT		 2827loop:
2828 usb_unlock_device(hdev);
2829 usb_put_intf(intf);
2830
2831 } /* end while (1) */
2832}
2833
2834static int hub_thread(void *__unused)
2835{
1da177e4
LT		 2836 do {
2837 hub_events();
9c8d6178 2838 wait_event_interruptible(khubd_wait,
2839 !list_empty(&hub_event_list) ||
2840 kthread_should_stop());
3e1d1d28 2841 try_to_freeze();
9c8d6178 2842 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
1da177e4 2843
9c8d6178 2844 pr_debug("%s: khubd exiting\n", usbcore_name);
2845 return 0;
1da177e4
LT		 2846}
2847
2848static struct usb_device_id hub_id_table [] = {
2849 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2850 .bDeviceClass = USB_CLASS_HUB},
2851 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2852 .bInterfaceClass = USB_CLASS_HUB},
2853 { } /* Terminating entry */
2854};
2855
2856MODULE_DEVICE_TABLE (usb, hub_id_table);
2857
2858static struct usb_driver hub_driver = {
2859 .owner = THIS_MODULE,
2860 .name = "hub",
2861 .probe = hub_probe,
2862 .disconnect = hub_disconnect,
2863 .suspend = hub_suspend,
2864 .resume = hub_resume,
2865 .ioctl = hub_ioctl,
2866 .id_table = hub_id_table,
2867};
2868
2869int usb_hub_init(void)
2870{
1da177e4
LT		 2871 if (usb_register(&hub_driver) < 0) {
2872 printk(KERN_ERR "%s: can't register hub driver\n",
2873 usbcore_name);
2874 return -1;
2875 }
2876
9c8d6178 2877 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2878 if (!IS_ERR(khubd_task))
1da177e4 2879 return 0;
1da177e4
LT		 2880
2881 /* Fall through if kernel_thread failed */
2882 usb_deregister(&hub_driver);
2883 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2884
2885 return -1;
2886}
2887
2888void usb_hub_cleanup(void)
2889{
9c8d6178 2890 kthread_stop(khubd_task);
1da177e4
LT		 2891
2892 /*
2893 * Hub resources are freed for us by usb_deregister. It calls
2894 * usb_driver_purge on every device which in turn calls that
2895 * devices disconnect function if it is using this driver.
2896 * The hub_disconnect function takes care of releasing the
2897 * individual hub resources. -greg
2898 */
2899 usb_deregister(&hub_driver);
2900} /* usb_hub_cleanup() */
2901
1da177e4
LT		 2902static int config_descriptors_changed(struct usb_device *udev)
2903{
2904 unsigned index;
2905 unsigned len = 0;
2906 struct usb_config_descriptor *buf;
2907
2908 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2909 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2910 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2911 }
2912 buf = kmalloc (len, SLAB_KERNEL);
2913 if (buf == NULL) {
2914 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2915 /* assume the worst */
2916 return 1;
2917 }
2918 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2919 int length;
2920 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2921
2922 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2923 old_length);
2924 if (length < old_length) {
2925 dev_dbg(&udev->dev, "config index %d, error %d\n",
2926 index, length);
2927 break;
2928 }
2929 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2930 != 0) {
2931 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2932 index, buf->bConfigurationValue);
2933 break;
2934 }
2935 }
2936 kfree(buf);
2937 return index != udev->descriptor.bNumConfigurations;
2938}
2939
2940/**
2941 * usb_reset_device - perform a USB port reset to reinitialize a device
2942 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2943 *
2944 * WARNING - don't reset any device unless drivers for all of its
2945 * interfaces are expecting that reset! Maybe some driver->reset()
2946 * method should eventually help ensure sufficient cooperation.
2947 *
2948 * Do a port reset, reassign the device's address, and establish its
2949 * former operating configuration. If the reset fails, or the device's
2950 * descriptors change from their values before the reset, or the original
2951 * configuration and altsettings cannot be restored, a flag will be set
2952 * telling khubd to pretend the device has been disconnected and then
2953 * re-connected. All drivers will be unbound, and the device will be
2954 * re-enumerated and probed all over again.
2955 *
2956 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2957 * flagged for logical disconnection, or some other negative error code
2958 * if the reset wasn't even attempted.
2959 *
2960 * The caller must own the device lock. For example, it's safe to use
2961 * this from a driver probe() routine after downloading new firmware.
2962 * For calls that might not occur during probe(), drivers should lock
2963 * the device using usb_lock_device_for_reset().
2964 */
2965int usb_reset_device(struct usb_device *udev)
2966{
2967 struct usb_device *parent_hdev = udev->parent;
2968 struct usb_hub *parent_hub;
2969 struct usb_device_descriptor descriptor = udev->descriptor;
2970 struct usb_hub *hub = NULL;
2971 int i, ret = 0, port1 = -1;
2972
2973 if (udev->state == USB_STATE_NOTATTACHED ||
2974 udev->state == USB_STATE_SUSPENDED) {
2975 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2976 udev->state);
2977 return -EINVAL;
2978 }
2979
2980 if (!parent_hdev) {
2981 /* this requires hcd-specific logic; see OHCI hc_restart() */
2982 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2983 return -EISDIR;
2984 }
2985
2986 for (i = 0; i < parent_hdev->maxchild; i++)
2987 if (parent_hdev->children[i] == udev) {
2988 port1 = i + 1;
2989 break;
2990 }
2991
2992 if (port1 < 0) {
2993 /* If this ever happens, it's very bad */
2994 dev_err(&udev->dev, "Can't locate device's port!\n");
2995 return -ENOENT;
2996 }
2997 parent_hub = hdev_to_hub(parent_hdev);
2998
2999 /* If we're resetting an active hub, take some special actions */
3000 if (udev->actconfig &&
3001 udev->actconfig->interface[0]->dev.driver ==
3002 &hub_driver.driver &&
3003 (hub = hdev_to_hub(udev)) != NULL) {
3004 hub_pre_reset(hub);
3005 }
3006
3007 set_bit(port1, parent_hub->busy_bits);
3008 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3009
3010 /* ep0 maxpacket size may change; let the HCD know about it.
3011 * Other endpoints will be handled by re-enumeration. */
3012 ep0_reinit(udev);
3013 ret = hub_port_init(parent_hub, udev, port1, i);
3014 if (ret >= 0)
3015 break;
3016 }
3017 clear_bit(port1, parent_hub->busy_bits);
3018 if (ret < 0)
3019 goto re_enumerate;
3020
3021 /* Device might have changed firmware (DFU or similar) */
3022 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3023 || config_descriptors_changed (udev)) {
3024 dev_info(&udev->dev, "device firmware changed\n");
3025 udev->descriptor = descriptor; /* for disconnect() calls */
3026 goto re_enumerate;
3027 }
3028
3029 if (!udev->actconfig)
3030 goto done;
3031
3032 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3033 USB_REQ_SET_CONFIGURATION, 0,
3034 udev->actconfig->desc.bConfigurationValue, 0,
3035 NULL, 0, USB_CTRL_SET_TIMEOUT);
3036 if (ret < 0) {
3037 dev_err(&udev->dev,
3038 "can't restore configuration #%d (error=%d)\n",
3039 udev->actconfig->desc.bConfigurationValue, ret);
3040 goto re_enumerate;
3041 }
3042 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3043
3044 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3045 struct usb_interface *intf = udev->actconfig->interface[i];
3046 struct usb_interface_descriptor *desc;
3047
3048 /* set_interface resets host side toggle even
3049 * for altsetting zero. the interface may have no driver.
3050 */
3051 desc = &intf->cur_altsetting->desc;
3052 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3053 desc->bAlternateSetting);
3054 if (ret < 0) {
3055 dev_err(&udev->dev, "failed to restore interface %d "
3056 "altsetting %d (error=%d)\n",
3057 desc->bInterfaceNumber,
3058 desc->bAlternateSetting,
3059 ret);
3060 goto re_enumerate;
3061 }
3062 }
3063
3064done:
3065 if (hub)
3066 hub_post_reset(hub);
3067 return 0;
3068
3069re_enumerate:
3070 hub_port_logical_disconnect(parent_hub, port1);
3071 return -ENODEV;
3072}
Ubuntu Jammy Linux kernel mirror