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