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