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