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