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/usb/hcd.h> 23 #include <linux/usb/quirks.h> 24 #include <linux/kthread.h> 25 #include <linux/mutex.h> 26 #include <linux/freezer.h> 27 28 #include <asm/uaccess.h> 29 #include <asm/byteorder.h> 30 31 #include "usb.h" 32 33 /* if we are in debug mode, always announce new devices */ 34 #ifdef DEBUG 35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES 36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES 37 #endif 38 #endif 39 40 struct usb_hub { 41 struct device *intfdev; /* the "interface" device */ 42 struct usb_device *hdev; 43 struct kref kref; 44 struct urb *urb; /* for interrupt polling pipe */ 45 46 /* buffer for urb ... with extra space in case of babble */ 47 char (*buffer)[8]; 48 union { 49 struct usb_hub_status hub; 50 struct usb_port_status port; 51 } *status; /* buffer for status reports */ 52 struct mutex status_mutex; /* for the status buffer */ 53 54 int error; /* last reported error */ 55 int nerrors; /* track consecutive errors */ 56 57 struct list_head event_list; /* hubs w/data or errs ready */ 58 unsigned long event_bits[1]; /* status change bitmask */ 59 unsigned long change_bits[1]; /* ports with logical connect 60 status change */ 61 unsigned long busy_bits[1]; /* ports being reset or 62 resumed */ 63 unsigned long removed_bits[1]; /* ports with a "removed" 64 device present */ 65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */ 66 #error event_bits[] is too short! 67 #endif 68 69 struct usb_hub_descriptor *descriptor; /* class descriptor */ 70 struct usb_tt tt; /* Transaction Translator */ 71 72 unsigned mA_per_port; /* current for each child */ 73 74 unsigned limited_power:1; 75 unsigned quiescing:1; 76 unsigned disconnected:1; 77 78 unsigned has_indicators:1; 79 u8 indicator[USB_MAXCHILDREN]; 80 struct delayed_work leds; 81 struct delayed_work init_work; 82 void **port_owners; 83 }; 84 85 86 /* Protect struct usb_device->state and ->children members 87 * Note: Both are also protected by ->dev.sem, except that ->state can 88 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */ 89 static DEFINE_SPINLOCK(device_state_lock); 90 91 /* khubd's worklist and its lock */ 92 static DEFINE_SPINLOCK(hub_event_lock); 93 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */ 94 95 /* Wakes up khubd */ 96 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait); 97 98 static struct task_struct *khubd_task; 99 100 /* cycle leds on hubs that aren't blinking for attention */ 101 static int blinkenlights = 0; 102 module_param (blinkenlights, bool, S_IRUGO); 103 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs"); 104 105 /* 106 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about 107 * 10 seconds to send reply for the initial 64-byte descriptor request. 108 */ 109 /* define initial 64-byte descriptor request timeout in milliseconds */ 110 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT; 111 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR); 112 MODULE_PARM_DESC(initial_descriptor_timeout, 113 "initial 64-byte descriptor request timeout in milliseconds " 114 "(default 5000 - 5.0 seconds)"); 115 116 /* 117 * As of 2.6.10 we introduce a new USB device initialization scheme which 118 * closely resembles the way Windows works. Hopefully it will be compatible 119 * with a wider range of devices than the old scheme. However some previously 120 * working devices may start giving rise to "device not accepting address" 121 * errors; if that happens the user can try the old scheme by adjusting the 122 * following module parameters. 123 * 124 * For maximum flexibility there are two boolean parameters to control the 125 * hub driver's behavior. On the first initialization attempt, if the 126 * "old_scheme_first" parameter is set then the old scheme will be used, 127 * otherwise the new scheme is used. If that fails and "use_both_schemes" 128 * is set, then the driver will make another attempt, using the other scheme. 129 */ 130 static int old_scheme_first = 0; 131 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR); 132 MODULE_PARM_DESC(old_scheme_first, 133 "start with the old device initialization scheme"); 134 135 static int use_both_schemes = 1; 136 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR); 137 MODULE_PARM_DESC(use_both_schemes, 138 "try the other device initialization scheme if the " 139 "first one fails"); 140 141 /* Mutual exclusion for EHCI CF initialization. This interferes with 142 * port reset on some companion controllers. 143 */ 144 DECLARE_RWSEM(ehci_cf_port_reset_rwsem); 145 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem); 146 147 #define HUB_DEBOUNCE_TIMEOUT 1500 148 #define HUB_DEBOUNCE_STEP 25 149 #define HUB_DEBOUNCE_STABLE 100 150 151 152 static int usb_reset_and_verify_device(struct usb_device *udev); 153 154 static inline char *portspeed(int portstatus) 155 { 156 if (portstatus & USB_PORT_STAT_HIGH_SPEED) 157 return "480 Mb/s"; 158 else if (portstatus & USB_PORT_STAT_LOW_SPEED) 159 return "1.5 Mb/s"; 160 else if (portstatus & USB_PORT_STAT_SUPER_SPEED) 161 return "5.0 Gb/s"; 162 else 163 return "12 Mb/s"; 164 } 165 166 /* Note that hdev or one of its children must be locked! */ 167 static struct usb_hub *hdev_to_hub(struct usb_device *hdev) 168 { 169 if (!hdev || !hdev->actconfig) 170 return NULL; 171 return usb_get_intfdata(hdev->actconfig->interface[0]); 172 } 173 174 /* USB 2.0 spec Section 11.24.4.5 */ 175 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size) 176 { 177 int i, ret; 178 179 for (i = 0; i < 3; i++) { 180 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), 181 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB, 182 USB_DT_HUB << 8, 0, data, size, 183 USB_CTRL_GET_TIMEOUT); 184 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2)) 185 return ret; 186 } 187 return -EINVAL; 188 } 189 190 /* 191 * USB 2.0 spec Section 11.24.2.1 192 */ 193 static int clear_hub_feature(struct usb_device *hdev, int feature) 194 { 195 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), 196 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000); 197 } 198 199 /* 200 * USB 2.0 spec Section 11.24.2.2 201 */ 202 static int clear_port_feature(struct usb_device *hdev, int port1, int feature) 203 { 204 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), 205 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1, 206 NULL, 0, 1000); 207 } 208 209 /* 210 * USB 2.0 spec Section 11.24.2.13 211 */ 212 static int set_port_feature(struct usb_device *hdev, int port1, int feature) 213 { 214 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), 215 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1, 216 NULL, 0, 1000); 217 } 218 219 /* 220 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7 221 * for info about using port indicators 222 */ 223 static void set_port_led( 224 struct usb_hub *hub, 225 int port1, 226 int selector 227 ) 228 { 229 int status = set_port_feature(hub->hdev, (selector << 8) | port1, 230 USB_PORT_FEAT_INDICATOR); 231 if (status < 0) 232 dev_dbg (hub->intfdev, 233 "port %d indicator %s status %d\n", 234 port1, 235 ({ char *s; switch (selector) { 236 case HUB_LED_AMBER: s = "amber"; break; 237 case HUB_LED_GREEN: s = "green"; break; 238 case HUB_LED_OFF: s = "off"; break; 239 case HUB_LED_AUTO: s = "auto"; break; 240 default: s = "??"; break; 241 }; s; }), 242 status); 243 } 244 245 #define LED_CYCLE_PERIOD ((2*HZ)/3) 246 247 static void led_work (struct work_struct *work) 248 { 249 struct usb_hub *hub = 250 container_of(work, struct usb_hub, leds.work); 251 struct usb_device *hdev = hub->hdev; 252 unsigned i; 253 unsigned changed = 0; 254 int cursor = -1; 255 256 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing) 257 return; 258 259 for (i = 0; i < hub->descriptor->bNbrPorts; i++) { 260 unsigned selector, mode; 261 262 /* 30%-50% duty cycle */ 263 264 switch (hub->indicator[i]) { 265 /* cycle marker */ 266 case INDICATOR_CYCLE: 267 cursor = i; 268 selector = HUB_LED_AUTO; 269 mode = INDICATOR_AUTO; 270 break; 271 /* blinking green = sw attention */ 272 case INDICATOR_GREEN_BLINK: 273 selector = HUB_LED_GREEN; 274 mode = INDICATOR_GREEN_BLINK_OFF; 275 break; 276 case INDICATOR_GREEN_BLINK_OFF: 277 selector = HUB_LED_OFF; 278 mode = INDICATOR_GREEN_BLINK; 279 break; 280 /* blinking amber = hw attention */ 281 case INDICATOR_AMBER_BLINK: 282 selector = HUB_LED_AMBER; 283 mode = INDICATOR_AMBER_BLINK_OFF; 284 break; 285 case INDICATOR_AMBER_BLINK_OFF: 286 selector = HUB_LED_OFF; 287 mode = INDICATOR_AMBER_BLINK; 288 break; 289 /* blink green/amber = reserved */ 290 case INDICATOR_ALT_BLINK: 291 selector = HUB_LED_GREEN; 292 mode = INDICATOR_ALT_BLINK_OFF; 293 break; 294 case INDICATOR_ALT_BLINK_OFF: 295 selector = HUB_LED_AMBER; 296 mode = INDICATOR_ALT_BLINK; 297 break; 298 default: 299 continue; 300 } 301 if (selector != HUB_LED_AUTO) 302 changed = 1; 303 set_port_led(hub, i + 1, selector); 304 hub->indicator[i] = mode; 305 } 306 if (!changed && blinkenlights) { 307 cursor++; 308 cursor %= hub->descriptor->bNbrPorts; 309 set_port_led(hub, cursor + 1, HUB_LED_GREEN); 310 hub->indicator[cursor] = INDICATOR_CYCLE; 311 changed++; 312 } 313 if (changed) 314 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD); 315 } 316 317 /* use a short timeout for hub/port status fetches */ 318 #define USB_STS_TIMEOUT 1000 319 #define USB_STS_RETRIES 5 320 321 /* 322 * USB 2.0 spec Section 11.24.2.6 323 */ 324 static int get_hub_status(struct usb_device *hdev, 325 struct usb_hub_status *data) 326 { 327 int i, status = -ETIMEDOUT; 328 329 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) { 330 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), 331 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0, 332 data, sizeof(*data), USB_STS_TIMEOUT); 333 } 334 return status; 335 } 336 337 /* 338 * USB 2.0 spec Section 11.24.2.7 339 */ 340 static int get_port_status(struct usb_device *hdev, int port1, 341 struct usb_port_status *data) 342 { 343 int i, status = -ETIMEDOUT; 344 345 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) { 346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0), 347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1, 348 data, sizeof(*data), USB_STS_TIMEOUT); 349 } 350 return status; 351 } 352 353 static int hub_port_status(struct usb_hub *hub, int port1, 354 u16 *status, u16 *change) 355 { 356 int ret; 357 358 mutex_lock(&hub->status_mutex); 359 ret = get_port_status(hub->hdev, port1, &hub->status->port); 360 if (ret < 4) { 361 dev_err(hub->intfdev, 362 "%s failed (err = %d)\n", __func__, ret); 363 if (ret >= 0) 364 ret = -EIO; 365 } else { 366 *status = le16_to_cpu(hub->status->port.wPortStatus); 367 *change = le16_to_cpu(hub->status->port.wPortChange); 368 ret = 0; 369 } 370 mutex_unlock(&hub->status_mutex); 371 return ret; 372 } 373 374 static void kick_khubd(struct usb_hub *hub) 375 { 376 unsigned long flags; 377 378 spin_lock_irqsave(&hub_event_lock, flags); 379 if (!hub->disconnected && list_empty(&hub->event_list)) { 380 list_add_tail(&hub->event_list, &hub_event_list); 381 382 /* Suppress autosuspend until khubd runs */ 383 usb_autopm_get_interface_no_resume( 384 to_usb_interface(hub->intfdev)); 385 wake_up(&khubd_wait); 386 } 387 spin_unlock_irqrestore(&hub_event_lock, flags); 388 } 389 390 void usb_kick_khubd(struct usb_device *hdev) 391 { 392 struct usb_hub *hub = hdev_to_hub(hdev); 393 394 if (hub) 395 kick_khubd(hub); 396 } 397 398 399 /* completion function, fires on port status changes and various faults */ 400 static void hub_irq(struct urb *urb) 401 { 402 struct usb_hub *hub = urb->context; 403 int status = urb->status; 404 unsigned i; 405 unsigned long bits; 406 407 switch (status) { 408 case -ENOENT: /* synchronous unlink */ 409 case -ECONNRESET: /* async unlink */ 410 case -ESHUTDOWN: /* hardware going away */ 411 return; 412 413 default: /* presumably an error */ 414 /* Cause a hub reset after 10 consecutive errors */ 415 dev_dbg (hub->intfdev, "transfer --> %d\n", status); 416 if ((++hub->nerrors < 10) || hub->error) 417 goto resubmit; 418 hub->error = status; 419 /* FALL THROUGH */ 420 421 /* let khubd handle things */ 422 case 0: /* we got data: port status changed */ 423 bits = 0; 424 for (i = 0; i < urb->actual_length; ++i) 425 bits |= ((unsigned long) ((*hub->buffer)[i])) 426 << (i*8); 427 hub->event_bits[0] = bits; 428 break; 429 } 430 431 hub->nerrors = 0; 432 433 /* Something happened, let khubd figure it out */ 434 kick_khubd(hub); 435 436 resubmit: 437 if (hub->quiescing) 438 return; 439 440 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0 441 && status != -ENODEV && status != -EPERM) 442 dev_err (hub->intfdev, "resubmit --> %d\n", status); 443 } 444 445 /* USB 2.0 spec Section 11.24.2.3 */ 446 static inline int 447 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt) 448 { 449 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0), 450 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo, 451 tt, NULL, 0, 1000); 452 } 453 454 /* 455 * enumeration blocks khubd for a long time. we use keventd instead, since 456 * long blocking there is the exception, not the rule. accordingly, HCDs 457 * talking to TTs must queue control transfers (not just bulk and iso), so 458 * both can talk to the same hub concurrently. 459 */ 460 static void hub_tt_work(struct work_struct *work) 461 { 462 struct usb_hub *hub = 463 container_of(work, struct usb_hub, tt.clear_work); 464 unsigned long flags; 465 int limit = 100; 466 467 spin_lock_irqsave (&hub->tt.lock, flags); 468 while (--limit && !list_empty (&hub->tt.clear_list)) { 469 struct list_head *next; 470 struct usb_tt_clear *clear; 471 struct usb_device *hdev = hub->hdev; 472 const struct hc_driver *drv; 473 int status; 474 475 next = hub->tt.clear_list.next; 476 clear = list_entry (next, struct usb_tt_clear, clear_list); 477 list_del (&clear->clear_list); 478 479 /* drop lock so HCD can concurrently report other TT errors */ 480 spin_unlock_irqrestore (&hub->tt.lock, flags); 481 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt); 482 if (status) 483 dev_err (&hdev->dev, 484 "clear tt %d (%04x) error %d\n", 485 clear->tt, clear->devinfo, status); 486 487 /* Tell the HCD, even if the operation failed */ 488 drv = clear->hcd->driver; 489 if (drv->clear_tt_buffer_complete) 490 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep); 491 492 kfree(clear); 493 spin_lock_irqsave(&hub->tt.lock, flags); 494 } 495 spin_unlock_irqrestore (&hub->tt.lock, flags); 496 } 497 498 /** 499 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub 500 * @urb: an URB associated with the failed or incomplete split transaction 501 * 502 * High speed HCDs use this to tell the hub driver that some split control or 503 * bulk transaction failed in a way that requires clearing internal state of 504 * a transaction translator. This is normally detected (and reported) from 505 * interrupt context. 506 * 507 * It may not be possible for that hub to handle additional full (or low) 508 * speed transactions until that state is fully cleared out. 509 */ 510 int usb_hub_clear_tt_buffer(struct urb *urb) 511 { 512 struct usb_device *udev = urb->dev; 513 int pipe = urb->pipe; 514 struct usb_tt *tt = udev->tt; 515 unsigned long flags; 516 struct usb_tt_clear *clear; 517 518 /* we've got to cope with an arbitrary number of pending TT clears, 519 * since each TT has "at least two" buffers that can need it (and 520 * there can be many TTs per hub). even if they're uncommon. 521 */ 522 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) { 523 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n"); 524 /* FIXME recover somehow ... RESET_TT? */ 525 return -ENOMEM; 526 } 527 528 /* info that CLEAR_TT_BUFFER needs */ 529 clear->tt = tt->multi ? udev->ttport : 1; 530 clear->devinfo = usb_pipeendpoint (pipe); 531 clear->devinfo |= udev->devnum << 4; 532 clear->devinfo |= usb_pipecontrol (pipe) 533 ? (USB_ENDPOINT_XFER_CONTROL << 11) 534 : (USB_ENDPOINT_XFER_BULK << 11); 535 if (usb_pipein (pipe)) 536 clear->devinfo |= 1 << 15; 537 538 /* info for completion callback */ 539 clear->hcd = bus_to_hcd(udev->bus); 540 clear->ep = urb->ep; 541 542 /* tell keventd to clear state for this TT */ 543 spin_lock_irqsave (&tt->lock, flags); 544 list_add_tail (&clear->clear_list, &tt->clear_list); 545 schedule_work(&tt->clear_work); 546 spin_unlock_irqrestore (&tt->lock, flags); 547 return 0; 548 } 549 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer); 550 551 /* If do_delay is false, return the number of milliseconds the caller 552 * needs to delay. 553 */ 554 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay) 555 { 556 int port1; 557 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2; 558 unsigned delay; 559 u16 wHubCharacteristics = 560 le16_to_cpu(hub->descriptor->wHubCharacteristics); 561 562 /* Enable power on each port. Some hubs have reserved values 563 * of LPSM (> 2) in their descriptors, even though they are 564 * USB 2.0 hubs. Some hubs do not implement port-power switching 565 * but only emulate it. In all cases, the ports won't work 566 * unless we send these messages to the hub. 567 */ 568 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) 569 dev_dbg(hub->intfdev, "enabling power on all ports\n"); 570 else 571 dev_dbg(hub->intfdev, "trying to enable port power on " 572 "non-switchable hub\n"); 573 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++) 574 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER); 575 576 /* Wait at least 100 msec for power to become stable */ 577 delay = max(pgood_delay, (unsigned) 100); 578 if (do_delay) 579 msleep(delay); 580 return delay; 581 } 582 583 static int hub_hub_status(struct usb_hub *hub, 584 u16 *status, u16 *change) 585 { 586 int ret; 587 588 mutex_lock(&hub->status_mutex); 589 ret = get_hub_status(hub->hdev, &hub->status->hub); 590 if (ret < 0) 591 dev_err (hub->intfdev, 592 "%s failed (err = %d)\n", __func__, ret); 593 else { 594 *status = le16_to_cpu(hub->status->hub.wHubStatus); 595 *change = le16_to_cpu(hub->status->hub.wHubChange); 596 ret = 0; 597 } 598 mutex_unlock(&hub->status_mutex); 599 return ret; 600 } 601 602 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state) 603 { 604 struct usb_device *hdev = hub->hdev; 605 int ret = 0; 606 607 if (hdev->children[port1-1] && set_state) 608 usb_set_device_state(hdev->children[port1-1], 609 USB_STATE_NOTATTACHED); 610 if (!hub->error) 611 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE); 612 if (ret) 613 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n", 614 port1, ret); 615 return ret; 616 } 617 618 /* 619 * Disable a port and mark a logical connnect-change event, so that some 620 * time later khubd will disconnect() any existing usb_device on the port 621 * and will re-enumerate if there actually is a device attached. 622 */ 623 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1) 624 { 625 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1); 626 hub_port_disable(hub, port1, 1); 627 628 /* FIXME let caller ask to power down the port: 629 * - some devices won't enumerate without a VBUS power cycle 630 * - SRP saves power that way 631 * - ... new call, TBD ... 632 * That's easy if this hub can switch power per-port, and 633 * khubd reactivates the port later (timer, SRP, etc). 634 * Powerdown must be optional, because of reset/DFU. 635 */ 636 637 set_bit(port1, hub->change_bits); 638 kick_khubd(hub); 639 } 640 641 /** 642 * usb_remove_device - disable a device's port on its parent hub 643 * @udev: device to be disabled and removed 644 * Context: @udev locked, must be able to sleep. 645 * 646 * After @udev's port has been disabled, khubd is notified and it will 647 * see that the device has been disconnected. When the device is 648 * physically unplugged and something is plugged in, the events will 649 * be received and processed normally. 650 */ 651 int usb_remove_device(struct usb_device *udev) 652 { 653 struct usb_hub *hub; 654 struct usb_interface *intf; 655 656 if (!udev->parent) /* Can't remove a root hub */ 657 return -EINVAL; 658 hub = hdev_to_hub(udev->parent); 659 intf = to_usb_interface(hub->intfdev); 660 661 usb_autopm_get_interface(intf); 662 set_bit(udev->portnum, hub->removed_bits); 663 hub_port_logical_disconnect(hub, udev->portnum); 664 usb_autopm_put_interface(intf); 665 return 0; 666 } 667 668 enum hub_activation_type { 669 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */ 670 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME, 671 }; 672 673 static void hub_init_func2(struct work_struct *ws); 674 static void hub_init_func3(struct work_struct *ws); 675 676 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type) 677 { 678 struct usb_device *hdev = hub->hdev; 679 int port1; 680 int status; 681 bool need_debounce_delay = false; 682 unsigned delay; 683 684 /* Continue a partial initialization */ 685 if (type == HUB_INIT2) 686 goto init2; 687 if (type == HUB_INIT3) 688 goto init3; 689 690 /* After a resume, port power should still be on. 691 * For any other type of activation, turn it on. 692 */ 693 if (type != HUB_RESUME) { 694 695 /* Speed up system boot by using a delayed_work for the 696 * hub's initial power-up delays. This is pretty awkward 697 * and the implementation looks like a home-brewed sort of 698 * setjmp/longjmp, but it saves at least 100 ms for each 699 * root hub (assuming usbcore is compiled into the kernel 700 * rather than as a module). It adds up. 701 * 702 * This can't be done for HUB_RESUME or HUB_RESET_RESUME 703 * because for those activation types the ports have to be 704 * operational when we return. In theory this could be done 705 * for HUB_POST_RESET, but it's easier not to. 706 */ 707 if (type == HUB_INIT) { 708 delay = hub_power_on(hub, false); 709 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2); 710 schedule_delayed_work(&hub->init_work, 711 msecs_to_jiffies(delay)); 712 713 /* Suppress autosuspend until init is done */ 714 usb_autopm_get_interface_no_resume( 715 to_usb_interface(hub->intfdev)); 716 return; /* Continues at init2: below */ 717 } else { 718 hub_power_on(hub, true); 719 } 720 } 721 init2: 722 723 /* Check each port and set hub->change_bits to let khubd know 724 * which ports need attention. 725 */ 726 for (port1 = 1; port1 <= hdev->maxchild; ++port1) { 727 struct usb_device *udev = hdev->children[port1-1]; 728 u16 portstatus, portchange; 729 730 portstatus = portchange = 0; 731 status = hub_port_status(hub, port1, &portstatus, &portchange); 732 if (udev || (portstatus & USB_PORT_STAT_CONNECTION)) 733 dev_dbg(hub->intfdev, 734 "port %d: status %04x change %04x\n", 735 port1, portstatus, portchange); 736 737 /* After anything other than HUB_RESUME (i.e., initialization 738 * or any sort of reset), every port should be disabled. 739 * Unconnected ports should likewise be disabled (paranoia), 740 * and so should ports for which we have no usb_device. 741 */ 742 if ((portstatus & USB_PORT_STAT_ENABLE) && ( 743 type != HUB_RESUME || 744 !(portstatus & USB_PORT_STAT_CONNECTION) || 745 !udev || 746 udev->state == USB_STATE_NOTATTACHED)) { 747 /* 748 * USB3 protocol ports will automatically transition 749 * to Enabled state when detect an USB3.0 device attach. 750 * Do not disable USB3 protocol ports. 751 * FIXME: USB3 root hub and external hubs are treated 752 * differently here. 753 */ 754 if (hdev->descriptor.bDeviceProtocol != 3 || 755 (!hdev->parent && 756 !(portstatus & USB_PORT_STAT_SUPER_SPEED))) { 757 clear_port_feature(hdev, port1, 758 USB_PORT_FEAT_ENABLE); 759 portstatus &= ~USB_PORT_STAT_ENABLE; 760 } else { 761 /* Pretend that power was lost for USB3 devs */ 762 portstatus &= ~USB_PORT_STAT_ENABLE; 763 } 764 } 765 766 /* Clear status-change flags; we'll debounce later */ 767 if (portchange & USB_PORT_STAT_C_CONNECTION) { 768 need_debounce_delay = true; 769 clear_port_feature(hub->hdev, port1, 770 USB_PORT_FEAT_C_CONNECTION); 771 } 772 if (portchange & USB_PORT_STAT_C_ENABLE) { 773 need_debounce_delay = true; 774 clear_port_feature(hub->hdev, port1, 775 USB_PORT_FEAT_C_ENABLE); 776 } 777 778 /* We can forget about a "removed" device when there's a 779 * physical disconnect or the connect status changes. 780 */ 781 if (!(portstatus & USB_PORT_STAT_CONNECTION) || 782 (portchange & USB_PORT_STAT_C_CONNECTION)) 783 clear_bit(port1, hub->removed_bits); 784 785 if (!udev || udev->state == USB_STATE_NOTATTACHED) { 786 /* Tell khubd to disconnect the device or 787 * check for a new connection 788 */ 789 if (udev || (portstatus & USB_PORT_STAT_CONNECTION)) 790 set_bit(port1, hub->change_bits); 791 792 } else if (portstatus & USB_PORT_STAT_ENABLE) { 793 /* The power session apparently survived the resume. 794 * If there was an overcurrent or suspend change 795 * (i.e., remote wakeup request), have khubd 796 * take care of it. 797 */ 798 if (portchange) 799 set_bit(port1, hub->change_bits); 800 801 } else if (udev->persist_enabled) { 802 #ifdef CONFIG_PM 803 udev->reset_resume = 1; 804 #endif 805 set_bit(port1, hub->change_bits); 806 807 } else { 808 /* The power session is gone; tell khubd */ 809 usb_set_device_state(udev, USB_STATE_NOTATTACHED); 810 set_bit(port1, hub->change_bits); 811 } 812 } 813 814 /* If no port-status-change flags were set, we don't need any 815 * debouncing. If flags were set we can try to debounce the 816 * ports all at once right now, instead of letting khubd do them 817 * one at a time later on. 818 * 819 * If any port-status changes do occur during this delay, khubd 820 * will see them later and handle them normally. 821 */ 822 if (need_debounce_delay) { 823 delay = HUB_DEBOUNCE_STABLE; 824 825 /* Don't do a long sleep inside a workqueue routine */ 826 if (type == HUB_INIT2) { 827 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3); 828 schedule_delayed_work(&hub->init_work, 829 msecs_to_jiffies(delay)); 830 return; /* Continues at init3: below */ 831 } else { 832 msleep(delay); 833 } 834 } 835 init3: 836 hub->quiescing = 0; 837 838 status = usb_submit_urb(hub->urb, GFP_NOIO); 839 if (status < 0) 840 dev_err(hub->intfdev, "activate --> %d\n", status); 841 if (hub->has_indicators && blinkenlights) 842 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD); 843 844 /* Scan all ports that need attention */ 845 kick_khubd(hub); 846 847 /* Allow autosuspend if it was suppressed */ 848 if (type <= HUB_INIT3) 849 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev)); 850 } 851 852 /* Implement the continuations for the delays above */ 853 static void hub_init_func2(struct work_struct *ws) 854 { 855 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work); 856 857 hub_activate(hub, HUB_INIT2); 858 } 859 860 static void hub_init_func3(struct work_struct *ws) 861 { 862 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work); 863 864 hub_activate(hub, HUB_INIT3); 865 } 866 867 enum hub_quiescing_type { 868 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND 869 }; 870 871 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type) 872 { 873 struct usb_device *hdev = hub->hdev; 874 int i; 875 876 cancel_delayed_work_sync(&hub->init_work); 877 878 /* khubd and related activity won't re-trigger */ 879 hub->quiescing = 1; 880 881 if (type != HUB_SUSPEND) { 882 /* Disconnect all the children */ 883 for (i = 0; i < hdev->maxchild; ++i) { 884 if (hdev->children[i]) 885 usb_disconnect(&hdev->children[i]); 886 } 887 } 888 889 /* Stop khubd and related activity */ 890 usb_kill_urb(hub->urb); 891 if (hub->has_indicators) 892 cancel_delayed_work_sync(&hub->leds); 893 if (hub->tt.hub) 894 cancel_work_sync(&hub->tt.clear_work); 895 } 896 897 /* caller has locked the hub device */ 898 static int hub_pre_reset(struct usb_interface *intf) 899 { 900 struct usb_hub *hub = usb_get_intfdata(intf); 901 902 hub_quiesce(hub, HUB_PRE_RESET); 903 return 0; 904 } 905 906 /* caller has locked the hub device */ 907 static int hub_post_reset(struct usb_interface *intf) 908 { 909 struct usb_hub *hub = usb_get_intfdata(intf); 910 911 hub_activate(hub, HUB_POST_RESET); 912 return 0; 913 } 914 915 static int hub_configure(struct usb_hub *hub, 916 struct usb_endpoint_descriptor *endpoint) 917 { 918 struct usb_hcd *hcd; 919 struct usb_device *hdev = hub->hdev; 920 struct device *hub_dev = hub->intfdev; 921 u16 hubstatus, hubchange; 922 u16 wHubCharacteristics; 923 unsigned int pipe; 924 int maxp, ret; 925 char *message = "out of memory"; 926 927 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL); 928 if (!hub->buffer) { 929 ret = -ENOMEM; 930 goto fail; 931 } 932 933 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL); 934 if (!hub->status) { 935 ret = -ENOMEM; 936 goto fail; 937 } 938 mutex_init(&hub->status_mutex); 939 940 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL); 941 if (!hub->descriptor) { 942 ret = -ENOMEM; 943 goto fail; 944 } 945 946 /* Request the entire hub descriptor. 947 * hub->descriptor can handle USB_MAXCHILDREN ports, 948 * but the hub can/will return fewer bytes here. 949 */ 950 ret = get_hub_descriptor(hdev, hub->descriptor, 951 sizeof(*hub->descriptor)); 952 if (ret < 0) { 953 message = "can't read hub descriptor"; 954 goto fail; 955 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) { 956 message = "hub has too many ports!"; 957 ret = -ENODEV; 958 goto fail; 959 } 960 961 hdev->maxchild = hub->descriptor->bNbrPorts; 962 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild, 963 (hdev->maxchild == 1) ? "" : "s"); 964 965 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL); 966 if (!hub->port_owners) { 967 ret = -ENOMEM; 968 goto fail; 969 } 970 971 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics); 972 973 if (wHubCharacteristics & HUB_CHAR_COMPOUND) { 974 int i; 975 char portstr [USB_MAXCHILDREN + 1]; 976 977 for (i = 0; i < hdev->maxchild; i++) 978 portstr[i] = hub->descriptor->DeviceRemovable 979 [((i + 1) / 8)] & (1 << ((i + 1) % 8)) 980 ? 'F' : 'R'; 981 portstr[hdev->maxchild] = 0; 982 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr); 983 } else 984 dev_dbg(hub_dev, "standalone hub\n"); 985 986 switch (wHubCharacteristics & HUB_CHAR_LPSM) { 987 case 0x00: 988 dev_dbg(hub_dev, "ganged power switching\n"); 989 break; 990 case 0x01: 991 dev_dbg(hub_dev, "individual port power switching\n"); 992 break; 993 case 0x02: 994 case 0x03: 995 dev_dbg(hub_dev, "no power switching (usb 1.0)\n"); 996 break; 997 } 998 999 switch (wHubCharacteristics & HUB_CHAR_OCPM) { 1000 case 0x00: 1001 dev_dbg(hub_dev, "global over-current protection\n"); 1002 break; 1003 case 0x08: 1004 dev_dbg(hub_dev, "individual port over-current protection\n"); 1005 break; 1006 case 0x10: 1007 case 0x18: 1008 dev_dbg(hub_dev, "no over-current protection\n"); 1009 break; 1010 } 1011 1012 spin_lock_init (&hub->tt.lock); 1013 INIT_LIST_HEAD (&hub->tt.clear_list); 1014 INIT_WORK(&hub->tt.clear_work, hub_tt_work); 1015 switch (hdev->descriptor.bDeviceProtocol) { 1016 case 0: 1017 break; 1018 case 1: 1019 dev_dbg(hub_dev, "Single TT\n"); 1020 hub->tt.hub = hdev; 1021 break; 1022 case 2: 1023 ret = usb_set_interface(hdev, 0, 1); 1024 if (ret == 0) { 1025 dev_dbg(hub_dev, "TT per port\n"); 1026 hub->tt.multi = 1; 1027 } else 1028 dev_err(hub_dev, "Using single TT (err %d)\n", 1029 ret); 1030 hub->tt.hub = hdev; 1031 break; 1032 case 3: 1033 /* USB 3.0 hubs don't have a TT */ 1034 break; 1035 default: 1036 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n", 1037 hdev->descriptor.bDeviceProtocol); 1038 break; 1039 } 1040 1041 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */ 1042 switch (wHubCharacteristics & HUB_CHAR_TTTT) { 1043 case HUB_TTTT_8_BITS: 1044 if (hdev->descriptor.bDeviceProtocol != 0) { 1045 hub->tt.think_time = 666; 1046 dev_dbg(hub_dev, "TT requires at most %d " 1047 "FS bit times (%d ns)\n", 1048 8, hub->tt.think_time); 1049 } 1050 break; 1051 case HUB_TTTT_16_BITS: 1052 hub->tt.think_time = 666 * 2; 1053 dev_dbg(hub_dev, "TT requires at most %d " 1054 "FS bit times (%d ns)\n", 1055 16, hub->tt.think_time); 1056 break; 1057 case HUB_TTTT_24_BITS: 1058 hub->tt.think_time = 666 * 3; 1059 dev_dbg(hub_dev, "TT requires at most %d " 1060 "FS bit times (%d ns)\n", 1061 24, hub->tt.think_time); 1062 break; 1063 case HUB_TTTT_32_BITS: 1064 hub->tt.think_time = 666 * 4; 1065 dev_dbg(hub_dev, "TT requires at most %d " 1066 "FS bit times (%d ns)\n", 1067 32, hub->tt.think_time); 1068 break; 1069 } 1070 1071 /* probe() zeroes hub->indicator[] */ 1072 if (wHubCharacteristics & HUB_CHAR_PORTIND) { 1073 hub->has_indicators = 1; 1074 dev_dbg(hub_dev, "Port indicators are supported\n"); 1075 } 1076 1077 dev_dbg(hub_dev, "power on to power good time: %dms\n", 1078 hub->descriptor->bPwrOn2PwrGood * 2); 1079 1080 /* power budgeting mostly matters with bus-powered hubs, 1081 * and battery-powered root hubs (may provide just 8 mA). 1082 */ 1083 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus); 1084 if (ret < 2) { 1085 message = "can't get hub status"; 1086 goto fail; 1087 } 1088 le16_to_cpus(&hubstatus); 1089 if (hdev == hdev->bus->root_hub) { 1090 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500) 1091 hub->mA_per_port = 500; 1092 else { 1093 hub->mA_per_port = hdev->bus_mA; 1094 hub->limited_power = 1; 1095 } 1096 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) { 1097 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n", 1098 hub->descriptor->bHubContrCurrent); 1099 hub->limited_power = 1; 1100 if (hdev->maxchild > 0) { 1101 int remaining = hdev->bus_mA - 1102 hub->descriptor->bHubContrCurrent; 1103 1104 if (remaining < hdev->maxchild * 100) 1105 dev_warn(hub_dev, 1106 "insufficient power available " 1107 "to use all downstream ports\n"); 1108 hub->mA_per_port = 100; /* 7.2.1.1 */ 1109 } 1110 } else { /* Self-powered external hub */ 1111 /* FIXME: What about battery-powered external hubs that 1112 * provide less current per port? */ 1113 hub->mA_per_port = 500; 1114 } 1115 if (hub->mA_per_port < 500) 1116 dev_dbg(hub_dev, "%umA bus power budget for each child\n", 1117 hub->mA_per_port); 1118 1119 /* Update the HCD's internal representation of this hub before khubd 1120 * starts getting port status changes for devices under the hub. 1121 */ 1122 hcd = bus_to_hcd(hdev->bus); 1123 if (hcd->driver->update_hub_device) { 1124 ret = hcd->driver->update_hub_device(hcd, hdev, 1125 &hub->tt, GFP_KERNEL); 1126 if (ret < 0) { 1127 message = "can't update HCD hub info"; 1128 goto fail; 1129 } 1130 } 1131 1132 ret = hub_hub_status(hub, &hubstatus, &hubchange); 1133 if (ret < 0) { 1134 message = "can't get hub status"; 1135 goto fail; 1136 } 1137 1138 /* local power status reports aren't always correct */ 1139 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER) 1140 dev_dbg(hub_dev, "local power source is %s\n", 1141 (hubstatus & HUB_STATUS_LOCAL_POWER) 1142 ? "lost (inactive)" : "good"); 1143 1144 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0) 1145 dev_dbg(hub_dev, "%sover-current condition exists\n", 1146 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no "); 1147 1148 /* set up the interrupt endpoint 1149 * We use the EP's maxpacket size instead of (PORTS+1+7)/8 1150 * bytes as USB2.0[11.12.3] says because some hubs are known 1151 * to send more data (and thus cause overflow). For root hubs, 1152 * maxpktsize is defined in hcd.c's fake endpoint descriptors 1153 * to be big enough for at least USB_MAXCHILDREN ports. */ 1154 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress); 1155 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe)); 1156 1157 if (maxp > sizeof(*hub->buffer)) 1158 maxp = sizeof(*hub->buffer); 1159 1160 hub->urb = usb_alloc_urb(0, GFP_KERNEL); 1161 if (!hub->urb) { 1162 ret = -ENOMEM; 1163 goto fail; 1164 } 1165 1166 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq, 1167 hub, endpoint->bInterval); 1168 1169 /* maybe cycle the hub leds */ 1170 if (hub->has_indicators && blinkenlights) 1171 hub->indicator [0] = INDICATOR_CYCLE; 1172 1173 hub_activate(hub, HUB_INIT); 1174 return 0; 1175 1176 fail: 1177 dev_err (hub_dev, "config failed, %s (err %d)\n", 1178 message, ret); 1179 /* hub_disconnect() frees urb and descriptor */ 1180 return ret; 1181 } 1182 1183 static void hub_release(struct kref *kref) 1184 { 1185 struct usb_hub *hub = container_of(kref, struct usb_hub, kref); 1186 1187 usb_put_intf(to_usb_interface(hub->intfdev)); 1188 kfree(hub); 1189 } 1190 1191 static unsigned highspeed_hubs; 1192 1193 static void hub_disconnect(struct usb_interface *intf) 1194 { 1195 struct usb_hub *hub = usb_get_intfdata (intf); 1196 1197 /* Take the hub off the event list and don't let it be added again */ 1198 spin_lock_irq(&hub_event_lock); 1199 if (!list_empty(&hub->event_list)) { 1200 list_del_init(&hub->event_list); 1201 usb_autopm_put_interface_no_suspend(intf); 1202 } 1203 hub->disconnected = 1; 1204 spin_unlock_irq(&hub_event_lock); 1205 1206 /* Disconnect all children and quiesce the hub */ 1207 hub->error = 0; 1208 hub_quiesce(hub, HUB_DISCONNECT); 1209 1210 usb_set_intfdata (intf, NULL); 1211 hub->hdev->maxchild = 0; 1212 1213 if (hub->hdev->speed == USB_SPEED_HIGH) 1214 highspeed_hubs--; 1215 1216 usb_free_urb(hub->urb); 1217 kfree(hub->port_owners); 1218 kfree(hub->descriptor); 1219 kfree(hub->status); 1220 kfree(hub->buffer); 1221 1222 kref_put(&hub->kref, hub_release); 1223 } 1224 1225 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id) 1226 { 1227 struct usb_host_interface *desc; 1228 struct usb_endpoint_descriptor *endpoint; 1229 struct usb_device *hdev; 1230 struct usb_hub *hub; 1231 1232 desc = intf->cur_altsetting; 1233 hdev = interface_to_usbdev(intf); 1234 1235 /* Hubs have proper suspend/resume support */ 1236 usb_enable_autosuspend(hdev); 1237 1238 if (hdev->level == MAX_TOPO_LEVEL) { 1239 dev_err(&intf->dev, 1240 "Unsupported bus topology: hub nested too deep\n"); 1241 return -E2BIG; 1242 } 1243 1244 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB 1245 if (hdev->parent) { 1246 dev_warn(&intf->dev, "ignoring external hub\n"); 1247 return -ENODEV; 1248 } 1249 #endif 1250 1251 /* Some hubs have a subclass of 1, which AFAICT according to the */ 1252 /* specs is not defined, but it works */ 1253 if ((desc->desc.bInterfaceSubClass != 0) && 1254 (desc->desc.bInterfaceSubClass != 1)) { 1255 descriptor_error: 1256 dev_err (&intf->dev, "bad descriptor, ignoring hub\n"); 1257 return -EIO; 1258 } 1259 1260 /* Multiple endpoints? What kind of mutant ninja-hub is this? */ 1261 if (desc->desc.bNumEndpoints != 1) 1262 goto descriptor_error; 1263 1264 endpoint = &desc->endpoint[0].desc; 1265 1266 /* If it's not an interrupt in endpoint, we'd better punt! */ 1267 if (!usb_endpoint_is_int_in(endpoint)) 1268 goto descriptor_error; 1269 1270 /* We found a hub */ 1271 dev_info (&intf->dev, "USB hub found\n"); 1272 1273 hub = kzalloc(sizeof(*hub), GFP_KERNEL); 1274 if (!hub) { 1275 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n"); 1276 return -ENOMEM; 1277 } 1278 1279 kref_init(&hub->kref); 1280 INIT_LIST_HEAD(&hub->event_list); 1281 hub->intfdev = &intf->dev; 1282 hub->hdev = hdev; 1283 INIT_DELAYED_WORK(&hub->leds, led_work); 1284 INIT_DELAYED_WORK(&hub->init_work, NULL); 1285 usb_get_intf(intf); 1286 1287 usb_set_intfdata (intf, hub); 1288 intf->needs_remote_wakeup = 1; 1289 1290 if (hdev->speed == USB_SPEED_HIGH) 1291 highspeed_hubs++; 1292 1293 if (hub_configure(hub, endpoint) >= 0) 1294 return 0; 1295 1296 hub_disconnect (intf); 1297 return -ENODEV; 1298 } 1299 1300 /* No BKL needed */ 1301 static int 1302 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data) 1303 { 1304 struct usb_device *hdev = interface_to_usbdev (intf); 1305 1306 /* assert ifno == 0 (part of hub spec) */ 1307 switch (code) { 1308 case USBDEVFS_HUB_PORTINFO: { 1309 struct usbdevfs_hub_portinfo *info = user_data; 1310 int i; 1311 1312 spin_lock_irq(&device_state_lock); 1313 if (hdev->devnum <= 0) 1314 info->nports = 0; 1315 else { 1316 info->nports = hdev->maxchild; 1317 for (i = 0; i < info->nports; i++) { 1318 if (hdev->children[i] == NULL) 1319 info->port[i] = 0; 1320 else 1321 info->port[i] = 1322 hdev->children[i]->devnum; 1323 } 1324 } 1325 spin_unlock_irq(&device_state_lock); 1326 1327 return info->nports + 1; 1328 } 1329 1330 default: 1331 return -ENOSYS; 1332 } 1333 } 1334 1335 /* 1336 * Allow user programs to claim ports on a hub. When a device is attached 1337 * to one of these "claimed" ports, the program will "own" the device. 1338 */ 1339 static int find_port_owner(struct usb_device *hdev, unsigned port1, 1340 void ***ppowner) 1341 { 1342 if (hdev->state == USB_STATE_NOTATTACHED) 1343 return -ENODEV; 1344 if (port1 == 0 || port1 > hdev->maxchild) 1345 return -EINVAL; 1346 1347 /* This assumes that devices not managed by the hub driver 1348 * will always have maxchild equal to 0. 1349 */ 1350 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]); 1351 return 0; 1352 } 1353 1354 /* In the following three functions, the caller must hold hdev's lock */ 1355 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner) 1356 { 1357 int rc; 1358 void **powner; 1359 1360 rc = find_port_owner(hdev, port1, &powner); 1361 if (rc) 1362 return rc; 1363 if (*powner) 1364 return -EBUSY; 1365 *powner = owner; 1366 return rc; 1367 } 1368 1369 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner) 1370 { 1371 int rc; 1372 void **powner; 1373 1374 rc = find_port_owner(hdev, port1, &powner); 1375 if (rc) 1376 return rc; 1377 if (*powner != owner) 1378 return -ENOENT; 1379 *powner = NULL; 1380 return rc; 1381 } 1382 1383 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner) 1384 { 1385 int n; 1386 void **powner; 1387 1388 n = find_port_owner(hdev, 1, &powner); 1389 if (n == 0) { 1390 for (; n < hdev->maxchild; (++n, ++powner)) { 1391 if (*powner == owner) 1392 *powner = NULL; 1393 } 1394 } 1395 } 1396 1397 /* The caller must hold udev's lock */ 1398 bool usb_device_is_owned(struct usb_device *udev) 1399 { 1400 struct usb_hub *hub; 1401 1402 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent) 1403 return false; 1404 hub = hdev_to_hub(udev->parent); 1405 return !!hub->port_owners[udev->portnum - 1]; 1406 } 1407 1408 1409 static void recursively_mark_NOTATTACHED(struct usb_device *udev) 1410 { 1411 int i; 1412 1413 for (i = 0; i < udev->maxchild; ++i) { 1414 if (udev->children[i]) 1415 recursively_mark_NOTATTACHED(udev->children[i]); 1416 } 1417 if (udev->state == USB_STATE_SUSPENDED) 1418 udev->active_duration -= jiffies; 1419 udev->state = USB_STATE_NOTATTACHED; 1420 } 1421 1422 /** 1423 * usb_set_device_state - change a device's current state (usbcore, hcds) 1424 * @udev: pointer to device whose state should be changed 1425 * @new_state: new state value to be stored 1426 * 1427 * udev->state is _not_ fully protected by the device lock. Although 1428 * most transitions are made only while holding the lock, the state can 1429 * can change to USB_STATE_NOTATTACHED at almost any time. This 1430 * is so that devices can be marked as disconnected as soon as possible, 1431 * without having to wait for any semaphores to be released. As a result, 1432 * all changes to any device's state must be protected by the 1433 * device_state_lock spinlock. 1434 * 1435 * Once a device has been added to the device tree, all changes to its state 1436 * should be made using this routine. The state should _not_ be set directly. 1437 * 1438 * If udev->state is already USB_STATE_NOTATTACHED then no change is made. 1439 * Otherwise udev->state is set to new_state, and if new_state is 1440 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set 1441 * to USB_STATE_NOTATTACHED. 1442 */ 1443 void usb_set_device_state(struct usb_device *udev, 1444 enum usb_device_state new_state) 1445 { 1446 unsigned long flags; 1447 1448 spin_lock_irqsave(&device_state_lock, flags); 1449 if (udev->state == USB_STATE_NOTATTACHED) 1450 ; /* do nothing */ 1451 else if (new_state != USB_STATE_NOTATTACHED) { 1452 1453 /* root hub wakeup capabilities are managed out-of-band 1454 * and may involve silicon errata ... ignore them here. 1455 */ 1456 if (udev->parent) { 1457 if (udev->state == USB_STATE_SUSPENDED 1458 || new_state == USB_STATE_SUSPENDED) 1459 ; /* No change to wakeup settings */ 1460 else if (new_state == USB_STATE_CONFIGURED) 1461 device_set_wakeup_capable(&udev->dev, 1462 (udev->actconfig->desc.bmAttributes 1463 & USB_CONFIG_ATT_WAKEUP)); 1464 else 1465 device_set_wakeup_capable(&udev->dev, 0); 1466 } 1467 if (udev->state == USB_STATE_SUSPENDED && 1468 new_state != USB_STATE_SUSPENDED) 1469 udev->active_duration -= jiffies; 1470 else if (new_state == USB_STATE_SUSPENDED && 1471 udev->state != USB_STATE_SUSPENDED) 1472 udev->active_duration += jiffies; 1473 udev->state = new_state; 1474 } else 1475 recursively_mark_NOTATTACHED(udev); 1476 spin_unlock_irqrestore(&device_state_lock, flags); 1477 } 1478 EXPORT_SYMBOL_GPL(usb_set_device_state); 1479 1480 /* 1481 * WUSB devices are simple: they have no hubs behind, so the mapping 1482 * device <-> virtual port number becomes 1:1. Why? to simplify the 1483 * life of the device connection logic in 1484 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret 1485 * handshake we need to assign a temporary address in the unauthorized 1486 * space. For simplicity we use the first virtual port number found to 1487 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()] 1488 * and that becomes it's address [X < 128] or its unauthorized address 1489 * [X | 0x80]. 1490 * 1491 * We add 1 as an offset to the one-based USB-stack port number 1492 * (zero-based wusb virtual port index) for two reasons: (a) dev addr 1493 * 0 is reserved by USB for default address; (b) Linux's USB stack 1494 * uses always #1 for the root hub of the controller. So USB stack's 1495 * port #1, which is wusb virtual-port #0 has address #2. 1496 * 1497 * Devices connected under xHCI are not as simple. The host controller 1498 * supports virtualization, so the hardware assigns device addresses and 1499 * the HCD must setup data structures before issuing a set address 1500 * command to the hardware. 1501 */ 1502 static void choose_address(struct usb_device *udev) 1503 { 1504 int devnum; 1505 struct usb_bus *bus = udev->bus; 1506 1507 /* If khubd ever becomes multithreaded, this will need a lock */ 1508 if (udev->wusb) { 1509 devnum = udev->portnum + 1; 1510 BUG_ON(test_bit(devnum, bus->devmap.devicemap)); 1511 } else { 1512 /* Try to allocate the next devnum beginning at 1513 * bus->devnum_next. */ 1514 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1515 bus->devnum_next); 1516 if (devnum >= 128) 1517 devnum = find_next_zero_bit(bus->devmap.devicemap, 1518 128, 1); 1519 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1); 1520 } 1521 if (devnum < 128) { 1522 set_bit(devnum, bus->devmap.devicemap); 1523 udev->devnum = devnum; 1524 } 1525 } 1526 1527 static void release_address(struct usb_device *udev) 1528 { 1529 if (udev->devnum > 0) { 1530 clear_bit(udev->devnum, udev->bus->devmap.devicemap); 1531 udev->devnum = -1; 1532 } 1533 } 1534 1535 static void update_address(struct usb_device *udev, int devnum) 1536 { 1537 /* The address for a WUSB device is managed by wusbcore. */ 1538 if (!udev->wusb) 1539 udev->devnum = devnum; 1540 } 1541 1542 static void hub_free_dev(struct usb_device *udev) 1543 { 1544 struct usb_hcd *hcd = bus_to_hcd(udev->bus); 1545 1546 /* Root hubs aren't real devices, so don't free HCD resources */ 1547 if (hcd->driver->free_dev && udev->parent) 1548 hcd->driver->free_dev(hcd, udev); 1549 } 1550 1551 /** 1552 * usb_disconnect - disconnect a device (usbcore-internal) 1553 * @pdev: pointer to device being disconnected 1554 * Context: !in_interrupt () 1555 * 1556 * Something got disconnected. Get rid of it and all of its children. 1557 * 1558 * If *pdev is a normal device then the parent hub must already be locked. 1559 * If *pdev is a root hub then this routine will acquire the 1560 * usb_bus_list_lock on behalf of the caller. 1561 * 1562 * Only hub drivers (including virtual root hub drivers for host 1563 * controllers) should ever call this. 1564 * 1565 * This call is synchronous, and may not be used in an interrupt context. 1566 */ 1567 void usb_disconnect(struct usb_device **pdev) 1568 { 1569 struct usb_device *udev = *pdev; 1570 int i; 1571 1572 if (!udev) { 1573 pr_debug ("%s nodev\n", __func__); 1574 return; 1575 } 1576 1577 /* mark the device as inactive, so any further urb submissions for 1578 * this device (and any of its children) will fail immediately. 1579 * this quiesces everyting except pending urbs. 1580 */ 1581 usb_set_device_state(udev, USB_STATE_NOTATTACHED); 1582 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum); 1583 1584 usb_lock_device(udev); 1585 1586 /* Free up all the children before we remove this device */ 1587 for (i = 0; i < USB_MAXCHILDREN; i++) { 1588 if (udev->children[i]) 1589 usb_disconnect(&udev->children[i]); 1590 } 1591 1592 /* deallocate hcd/hardware state ... nuking all pending urbs and 1593 * cleaning up all state associated with the current configuration 1594 * so that the hardware is now fully quiesced. 1595 */ 1596 dev_dbg (&udev->dev, "unregistering device\n"); 1597 usb_disable_device(udev, 0); 1598 usb_hcd_synchronize_unlinks(udev); 1599 1600 usb_remove_ep_devs(&udev->ep0); 1601 usb_unlock_device(udev); 1602 1603 /* Unregister the device. The device driver is responsible 1604 * for de-configuring the device and invoking the remove-device 1605 * notifier chain (used by usbfs and possibly others). 1606 */ 1607 device_del(&udev->dev); 1608 1609 /* Free the device number and delete the parent's children[] 1610 * (or root_hub) pointer. 1611 */ 1612 release_address(udev); 1613 1614 /* Avoid races with recursively_mark_NOTATTACHED() */ 1615 spin_lock_irq(&device_state_lock); 1616 *pdev = NULL; 1617 spin_unlock_irq(&device_state_lock); 1618 1619 hub_free_dev(udev); 1620 1621 put_device(&udev->dev); 1622 } 1623 1624 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES 1625 static void show_string(struct usb_device *udev, char *id, char *string) 1626 { 1627 if (!string) 1628 return; 1629 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string); 1630 } 1631 1632 static void announce_device(struct usb_device *udev) 1633 { 1634 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n", 1635 le16_to_cpu(udev->descriptor.idVendor), 1636 le16_to_cpu(udev->descriptor.idProduct)); 1637 dev_info(&udev->dev, 1638 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n", 1639 udev->descriptor.iManufacturer, 1640 udev->descriptor.iProduct, 1641 udev->descriptor.iSerialNumber); 1642 show_string(udev, "Product", udev->product); 1643 show_string(udev, "Manufacturer", udev->manufacturer); 1644 show_string(udev, "SerialNumber", udev->serial); 1645 } 1646 #else 1647 static inline void announce_device(struct usb_device *udev) { } 1648 #endif 1649 1650 #ifdef CONFIG_USB_OTG 1651 #include "otg_whitelist.h" 1652 #endif 1653 1654 /** 1655 * usb_enumerate_device_otg - FIXME (usbcore-internal) 1656 * @udev: newly addressed device (in ADDRESS state) 1657 * 1658 * Finish enumeration for On-The-Go devices 1659 */ 1660 static int usb_enumerate_device_otg(struct usb_device *udev) 1661 { 1662 int err = 0; 1663 1664 #ifdef CONFIG_USB_OTG 1665 /* 1666 * OTG-aware devices on OTG-capable root hubs may be able to use SRP, 1667 * to wake us after we've powered off VBUS; and HNP, switching roles 1668 * "host" to "peripheral". The OTG descriptor helps figure this out. 1669 */ 1670 if (!udev->bus->is_b_host 1671 && udev->config 1672 && udev->parent == udev->bus->root_hub) { 1673 struct usb_otg_descriptor *desc = NULL; 1674 struct usb_bus *bus = udev->bus; 1675 1676 /* descriptor may appear anywhere in config */ 1677 if (__usb_get_extra_descriptor (udev->rawdescriptors[0], 1678 le16_to_cpu(udev->config[0].desc.wTotalLength), 1679 USB_DT_OTG, (void **) &desc) == 0) { 1680 if (desc->bmAttributes & USB_OTG_HNP) { 1681 unsigned port1 = udev->portnum; 1682 1683 dev_info(&udev->dev, 1684 "Dual-Role OTG device on %sHNP port\n", 1685 (port1 == bus->otg_port) 1686 ? "" : "non-"); 1687 1688 /* enable HNP before suspend, it's simpler */ 1689 if (port1 == bus->otg_port) 1690 bus->b_hnp_enable = 1; 1691 err = usb_control_msg(udev, 1692 usb_sndctrlpipe(udev, 0), 1693 USB_REQ_SET_FEATURE, 0, 1694 bus->b_hnp_enable 1695 ? USB_DEVICE_B_HNP_ENABLE 1696 : USB_DEVICE_A_ALT_HNP_SUPPORT, 1697 0, NULL, 0, USB_CTRL_SET_TIMEOUT); 1698 if (err < 0) { 1699 /* OTG MESSAGE: report errors here, 1700 * customize to match your product. 1701 */ 1702 dev_info(&udev->dev, 1703 "can't set HNP mode: %d\n", 1704 err); 1705 bus->b_hnp_enable = 0; 1706 } 1707 } 1708 } 1709 } 1710 1711 if (!is_targeted(udev)) { 1712 1713 /* Maybe it can talk to us, though we can't talk to it. 1714 * (Includes HNP test device.) 1715 */ 1716 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) { 1717 err = usb_port_suspend(udev, PMSG_SUSPEND); 1718 if (err < 0) 1719 dev_dbg(&udev->dev, "HNP fail, %d\n", err); 1720 } 1721 err = -ENOTSUPP; 1722 goto fail; 1723 } 1724 fail: 1725 #endif 1726 return err; 1727 } 1728 1729 1730 /** 1731 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal) 1732 * @udev: newly addressed device (in ADDRESS state) 1733 * 1734 * This is only called by usb_new_device() and usb_authorize_device() 1735 * and FIXME -- all comments that apply to them apply here wrt to 1736 * environment. 1737 * 1738 * If the device is WUSB and not authorized, we don't attempt to read 1739 * the string descriptors, as they will be errored out by the device 1740 * until it has been authorized. 1741 */ 1742 static int usb_enumerate_device(struct usb_device *udev) 1743 { 1744 int err; 1745 1746 if (udev->config == NULL) { 1747 err = usb_get_configuration(udev); 1748 if (err < 0) { 1749 dev_err(&udev->dev, "can't read configurations, error %d\n", 1750 err); 1751 goto fail; 1752 } 1753 } 1754 if (udev->wusb == 1 && udev->authorized == 0) { 1755 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1756 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1757 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1758 } 1759 else { 1760 /* read the standard strings and cache them if present */ 1761 udev->product = usb_cache_string(udev, udev->descriptor.iProduct); 1762 udev->manufacturer = usb_cache_string(udev, 1763 udev->descriptor.iManufacturer); 1764 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber); 1765 } 1766 err = usb_enumerate_device_otg(udev); 1767 fail: 1768 return err; 1769 } 1770 1771 1772 /** 1773 * usb_new_device - perform initial device setup (usbcore-internal) 1774 * @udev: newly addressed device (in ADDRESS state) 1775 * 1776 * This is called with devices which have been detected but not fully 1777 * enumerated. The device descriptor is available, but not descriptors 1778 * for any device configuration. The caller must have locked either 1779 * the parent hub (if udev is a normal device) or else the 1780 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to 1781 * udev has already been installed, but udev is not yet visible through 1782 * sysfs or other filesystem code. 1783 * 1784 * It will return if the device is configured properly or not. Zero if 1785 * the interface was registered with the driver core; else a negative 1786 * errno value. 1787 * 1788 * This call is synchronous, and may not be used in an interrupt context. 1789 * 1790 * Only the hub driver or root-hub registrar should ever call this. 1791 */ 1792 int usb_new_device(struct usb_device *udev) 1793 { 1794 int err; 1795 1796 if (udev->parent) { 1797 /* Initialize non-root-hub device wakeup to disabled; 1798 * device (un)configuration controls wakeup capable 1799 * sysfs power/wakeup controls wakeup enabled/disabled 1800 */ 1801 device_init_wakeup(&udev->dev, 0); 1802 } 1803 1804 /* Tell the runtime-PM framework the device is active */ 1805 pm_runtime_set_active(&udev->dev); 1806 pm_runtime_get_noresume(&udev->dev); 1807 pm_runtime_use_autosuspend(&udev->dev); 1808 pm_runtime_enable(&udev->dev); 1809 1810 /* By default, forbid autosuspend for all devices. It will be 1811 * allowed for hubs during binding. 1812 */ 1813 usb_disable_autosuspend(udev); 1814 1815 err = usb_enumerate_device(udev); /* Read descriptors */ 1816 if (err < 0) 1817 goto fail; 1818 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n", 1819 udev->devnum, udev->bus->busnum, 1820 (((udev->bus->busnum-1) * 128) + (udev->devnum-1))); 1821 /* export the usbdev device-node for libusb */ 1822 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR, 1823 (((udev->bus->busnum-1) * 128) + (udev->devnum-1))); 1824 1825 /* Tell the world! */ 1826 announce_device(udev); 1827 1828 device_enable_async_suspend(&udev->dev); 1829 /* Register the device. The device driver is responsible 1830 * for configuring the device and invoking the add-device 1831 * notifier chain (used by usbfs and possibly others). 1832 */ 1833 err = device_add(&udev->dev); 1834 if (err) { 1835 dev_err(&udev->dev, "can't device_add, error %d\n", err); 1836 goto fail; 1837 } 1838 1839 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev); 1840 usb_mark_last_busy(udev); 1841 pm_runtime_put_sync_autosuspend(&udev->dev); 1842 return err; 1843 1844 fail: 1845 usb_set_device_state(udev, USB_STATE_NOTATTACHED); 1846 pm_runtime_disable(&udev->dev); 1847 pm_runtime_set_suspended(&udev->dev); 1848 return err; 1849 } 1850 1851 1852 /** 1853 * usb_deauthorize_device - deauthorize a device (usbcore-internal) 1854 * @usb_dev: USB device 1855 * 1856 * Move the USB device to a very basic state where interfaces are disabled 1857 * and the device is in fact unconfigured and unusable. 1858 * 1859 * We share a lock (that we have) with device_del(), so we need to 1860 * defer its call. 1861 */ 1862 int usb_deauthorize_device(struct usb_device *usb_dev) 1863 { 1864 usb_lock_device(usb_dev); 1865 if (usb_dev->authorized == 0) 1866 goto out_unauthorized; 1867 1868 usb_dev->authorized = 0; 1869 usb_set_configuration(usb_dev, -1); 1870 1871 kfree(usb_dev->product); 1872 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1873 kfree(usb_dev->manufacturer); 1874 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1875 kfree(usb_dev->serial); 1876 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL); 1877 1878 usb_destroy_configuration(usb_dev); 1879 usb_dev->descriptor.bNumConfigurations = 0; 1880 1881 out_unauthorized: 1882 usb_unlock_device(usb_dev); 1883 return 0; 1884 } 1885 1886 1887 int usb_authorize_device(struct usb_device *usb_dev) 1888 { 1889 int result = 0, c; 1890 1891 usb_lock_device(usb_dev); 1892 if (usb_dev->authorized == 1) 1893 goto out_authorized; 1894 1895 result = usb_autoresume_device(usb_dev); 1896 if (result < 0) { 1897 dev_err(&usb_dev->dev, 1898 "can't autoresume for authorization: %d\n", result); 1899 goto error_autoresume; 1900 } 1901 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor)); 1902 if (result < 0) { 1903 dev_err(&usb_dev->dev, "can't re-read device descriptor for " 1904 "authorization: %d\n", result); 1905 goto error_device_descriptor; 1906 } 1907 1908 kfree(usb_dev->product); 1909 usb_dev->product = NULL; 1910 kfree(usb_dev->manufacturer); 1911 usb_dev->manufacturer = NULL; 1912 kfree(usb_dev->serial); 1913 usb_dev->serial = NULL; 1914 1915 usb_dev->authorized = 1; 1916 result = usb_enumerate_device(usb_dev); 1917 if (result < 0) 1918 goto error_enumerate; 1919 /* Choose and set the configuration. This registers the interfaces 1920 * with the driver core and lets interface drivers bind to them. 1921 */ 1922 c = usb_choose_configuration(usb_dev); 1923 if (c >= 0) { 1924 result = usb_set_configuration(usb_dev, c); 1925 if (result) { 1926 dev_err(&usb_dev->dev, 1927 "can't set config #%d, error %d\n", c, result); 1928 /* This need not be fatal. The user can try to 1929 * set other configurations. */ 1930 } 1931 } 1932 dev_info(&usb_dev->dev, "authorized to connect\n"); 1933 1934 error_enumerate: 1935 error_device_descriptor: 1936 usb_autosuspend_device(usb_dev); 1937 error_autoresume: 1938 out_authorized: 1939 usb_unlock_device(usb_dev); // complements locktree 1940 return result; 1941 } 1942 1943 1944 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */ 1945 static unsigned hub_is_wusb(struct usb_hub *hub) 1946 { 1947 struct usb_hcd *hcd; 1948 if (hub->hdev->parent != NULL) /* not a root hub? */ 1949 return 0; 1950 hcd = container_of(hub->hdev->bus, struct usb_hcd, self); 1951 return hcd->wireless; 1952 } 1953 1954 1955 #define PORT_RESET_TRIES 5 1956 #define SET_ADDRESS_TRIES 2 1957 #define GET_DESCRIPTOR_TRIES 2 1958 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1)) 1959 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first) 1960 1961 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */ 1962 #define HUB_SHORT_RESET_TIME 10 1963 #define HUB_LONG_RESET_TIME 200 1964 #define HUB_RESET_TIMEOUT 500 1965 1966 static int hub_port_wait_reset(struct usb_hub *hub, int port1, 1967 struct usb_device *udev, unsigned int delay) 1968 { 1969 int delay_time, ret; 1970 u16 portstatus; 1971 u16 portchange; 1972 1973 for (delay_time = 0; 1974 delay_time < HUB_RESET_TIMEOUT; 1975 delay_time += delay) { 1976 /* wait to give the device a chance to reset */ 1977 msleep(delay); 1978 1979 /* read and decode port status */ 1980 ret = hub_port_status(hub, port1, &portstatus, &portchange); 1981 if (ret < 0) 1982 return ret; 1983 1984 /* Device went away? */ 1985 if (!(portstatus & USB_PORT_STAT_CONNECTION)) 1986 return -ENOTCONN; 1987 1988 /* bomb out completely if the connection bounced */ 1989 if ((portchange & USB_PORT_STAT_C_CONNECTION)) 1990 return -ENOTCONN; 1991 1992 /* if we`ve finished resetting, then break out of the loop */ 1993 if (!(portstatus & USB_PORT_STAT_RESET) && 1994 (portstatus & USB_PORT_STAT_ENABLE)) { 1995 if (hub_is_wusb(hub)) 1996 udev->speed = USB_SPEED_WIRELESS; 1997 else if (portstatus & USB_PORT_STAT_SUPER_SPEED) 1998 udev->speed = USB_SPEED_SUPER; 1999 else if (portstatus & USB_PORT_STAT_HIGH_SPEED) 2000 udev->speed = USB_SPEED_HIGH; 2001 else if (portstatus & USB_PORT_STAT_LOW_SPEED) 2002 udev->speed = USB_SPEED_LOW; 2003 else 2004 udev->speed = USB_SPEED_FULL; 2005 return 0; 2006 } 2007 2008 /* switch to the long delay after two short delay failures */ 2009 if (delay_time >= 2 * HUB_SHORT_RESET_TIME) 2010 delay = HUB_LONG_RESET_TIME; 2011 2012 dev_dbg (hub->intfdev, 2013 "port %d not reset yet, waiting %dms\n", 2014 port1, delay); 2015 } 2016 2017 return -EBUSY; 2018 } 2019 2020 static int hub_port_reset(struct usb_hub *hub, int port1, 2021 struct usb_device *udev, unsigned int delay) 2022 { 2023 int i, status; 2024 struct usb_hcd *hcd; 2025 2026 hcd = bus_to_hcd(udev->bus); 2027 /* Block EHCI CF initialization during the port reset. 2028 * Some companion controllers don't like it when they mix. 2029 */ 2030 down_read(&ehci_cf_port_reset_rwsem); 2031 2032 /* Reset the port */ 2033 for (i = 0; i < PORT_RESET_TRIES; i++) { 2034 status = set_port_feature(hub->hdev, 2035 port1, USB_PORT_FEAT_RESET); 2036 if (status) 2037 dev_err(hub->intfdev, 2038 "cannot reset port %d (err = %d)\n", 2039 port1, status); 2040 else { 2041 status = hub_port_wait_reset(hub, port1, udev, delay); 2042 if (status && status != -ENOTCONN) 2043 dev_dbg(hub->intfdev, 2044 "port_wait_reset: err = %d\n", 2045 status); 2046 } 2047 2048 /* return on disconnect or reset */ 2049 switch (status) { 2050 case 0: 2051 /* TRSTRCY = 10 ms; plus some extra */ 2052 msleep(10 + 40); 2053 update_address(udev, 0); 2054 if (hcd->driver->reset_device) { 2055 status = hcd->driver->reset_device(hcd, udev); 2056 if (status < 0) { 2057 dev_err(&udev->dev, "Cannot reset " 2058 "HCD device state\n"); 2059 break; 2060 } 2061 } 2062 /* FALL THROUGH */ 2063 case -ENOTCONN: 2064 case -ENODEV: 2065 clear_port_feature(hub->hdev, 2066 port1, USB_PORT_FEAT_C_RESET); 2067 /* FIXME need disconnect() for NOTATTACHED device */ 2068 usb_set_device_state(udev, status 2069 ? USB_STATE_NOTATTACHED 2070 : USB_STATE_DEFAULT); 2071 goto done; 2072 } 2073 2074 dev_dbg (hub->intfdev, 2075 "port %d not enabled, trying reset again...\n", 2076 port1); 2077 delay = HUB_LONG_RESET_TIME; 2078 } 2079 2080 dev_err (hub->intfdev, 2081 "Cannot enable port %i. Maybe the USB cable is bad?\n", 2082 port1); 2083 2084 done: 2085 up_read(&ehci_cf_port_reset_rwsem); 2086 return status; 2087 } 2088 2089 #ifdef CONFIG_PM 2090 2091 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \ 2092 USB_PORT_STAT_SUSPEND) 2093 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION) 2094 2095 /* Determine whether the device on a port is ready for a normal resume, 2096 * is ready for a reset-resume, or should be disconnected. 2097 */ 2098 static int check_port_resume_type(struct usb_device *udev, 2099 struct usb_hub *hub, int port1, 2100 int status, unsigned portchange, unsigned portstatus) 2101 { 2102 /* Is the device still present? */ 2103 if (status || (portstatus & MASK_BITS) != WANT_BITS) { 2104 if (status >= 0) 2105 status = -ENODEV; 2106 } 2107 2108 /* Can't do a normal resume if the port isn't enabled, 2109 * so try a reset-resume instead. 2110 */ 2111 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) { 2112 if (udev->persist_enabled) 2113 udev->reset_resume = 1; 2114 else 2115 status = -ENODEV; 2116 } 2117 2118 if (status) { 2119 dev_dbg(hub->intfdev, 2120 "port %d status %04x.%04x after resume, %d\n", 2121 port1, portchange, portstatus, status); 2122 } else if (udev->reset_resume) { 2123 2124 /* Late port handoff can set status-change bits */ 2125 if (portchange & USB_PORT_STAT_C_CONNECTION) 2126 clear_port_feature(hub->hdev, port1, 2127 USB_PORT_FEAT_C_CONNECTION); 2128 if (portchange & USB_PORT_STAT_C_ENABLE) 2129 clear_port_feature(hub->hdev, port1, 2130 USB_PORT_FEAT_C_ENABLE); 2131 } 2132 2133 return status; 2134 } 2135 2136 #ifdef CONFIG_USB_SUSPEND 2137 2138 /* 2139 * usb_port_suspend - suspend a usb device's upstream port 2140 * @udev: device that's no longer in active use, not a root hub 2141 * Context: must be able to sleep; device not locked; pm locks held 2142 * 2143 * Suspends a USB device that isn't in active use, conserving power. 2144 * Devices may wake out of a suspend, if anything important happens, 2145 * using the remote wakeup mechanism. They may also be taken out of 2146 * suspend by the host, using usb_port_resume(). It's also routine 2147 * to disconnect devices while they are suspended. 2148 * 2149 * This only affects the USB hardware for a device; its interfaces 2150 * (and, for hubs, child devices) must already have been suspended. 2151 * 2152 * Selective port suspend reduces power; most suspended devices draw 2153 * less than 500 uA. It's also used in OTG, along with remote wakeup. 2154 * All devices below the suspended port are also suspended. 2155 * 2156 * Devices leave suspend state when the host wakes them up. Some devices 2157 * also support "remote wakeup", where the device can activate the USB 2158 * tree above them to deliver data, such as a keypress or packet. In 2159 * some cases, this wakes the USB host. 2160 * 2161 * Suspending OTG devices may trigger HNP, if that's been enabled 2162 * between a pair of dual-role devices. That will change roles, such 2163 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral. 2164 * 2165 * Devices on USB hub ports have only one "suspend" state, corresponding 2166 * to ACPI D2, "may cause the device to lose some context". 2167 * State transitions include: 2168 * 2169 * - suspend, resume ... when the VBUS power link stays live 2170 * - suspend, disconnect ... VBUS lost 2171 * 2172 * Once VBUS drop breaks the circuit, the port it's using has to go through 2173 * normal re-enumeration procedures, starting with enabling VBUS power. 2174 * Other than re-initializing the hub (plug/unplug, except for root hubs), 2175 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd 2176 * timer, no SRP, no requests through sysfs. 2177 * 2178 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when 2179 * the root hub for their bus goes into global suspend ... so we don't 2180 * (falsely) update the device power state to say it suspended. 2181 * 2182 * Returns 0 on success, else negative errno. 2183 */ 2184 int usb_port_suspend(struct usb_device *udev, pm_message_t msg) 2185 { 2186 struct usb_hub *hub = hdev_to_hub(udev->parent); 2187 int port1 = udev->portnum; 2188 int status; 2189 2190 // dev_dbg(hub->intfdev, "suspend port %d\n", port1); 2191 2192 /* enable remote wakeup when appropriate; this lets the device 2193 * wake up the upstream hub (including maybe the root hub). 2194 * 2195 * NOTE: OTG devices may issue remote wakeup (or SRP) even when 2196 * we don't explicitly enable it here. 2197 */ 2198 if (udev->do_remote_wakeup) { 2199 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 2200 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE, 2201 USB_DEVICE_REMOTE_WAKEUP, 0, 2202 NULL, 0, 2203 USB_CTRL_SET_TIMEOUT); 2204 if (status) { 2205 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n", 2206 status); 2207 /* bail if autosuspend is requested */ 2208 if (msg.event & PM_EVENT_AUTO) 2209 return status; 2210 } 2211 } 2212 2213 /* see 7.1.7.6 */ 2214 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND); 2215 if (status) { 2216 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n", 2217 port1, status); 2218 /* paranoia: "should not happen" */ 2219 if (udev->do_remote_wakeup) 2220 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 2221 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE, 2222 USB_DEVICE_REMOTE_WAKEUP, 0, 2223 NULL, 0, 2224 USB_CTRL_SET_TIMEOUT); 2225 } else { 2226 /* device has up to 10 msec to fully suspend */ 2227 dev_dbg(&udev->dev, "usb %ssuspend\n", 2228 (msg.event & PM_EVENT_AUTO ? "auto-" : "")); 2229 usb_set_device_state(udev, USB_STATE_SUSPENDED); 2230 msleep(10); 2231 } 2232 usb_mark_last_busy(hub->hdev); 2233 return status; 2234 } 2235 2236 /* 2237 * If the USB "suspend" state is in use (rather than "global suspend"), 2238 * many devices will be individually taken out of suspend state using 2239 * special "resume" signaling. This routine kicks in shortly after 2240 * hardware resume signaling is finished, either because of selective 2241 * resume (by host) or remote wakeup (by device) ... now see what changed 2242 * in the tree that's rooted at this device. 2243 * 2244 * If @udev->reset_resume is set then the device is reset before the 2245 * status check is done. 2246 */ 2247 static int finish_port_resume(struct usb_device *udev) 2248 { 2249 int status = 0; 2250 u16 devstatus; 2251 2252 /* caller owns the udev device lock */ 2253 dev_dbg(&udev->dev, "%s\n", 2254 udev->reset_resume ? "finish reset-resume" : "finish resume"); 2255 2256 /* usb ch9 identifies four variants of SUSPENDED, based on what 2257 * state the device resumes to. Linux currently won't see the 2258 * first two on the host side; they'd be inside hub_port_init() 2259 * during many timeouts, but khubd can't suspend until later. 2260 */ 2261 usb_set_device_state(udev, udev->actconfig 2262 ? USB_STATE_CONFIGURED 2263 : USB_STATE_ADDRESS); 2264 2265 /* 10.5.4.5 says not to reset a suspended port if the attached 2266 * device is enabled for remote wakeup. Hence the reset 2267 * operation is carried out here, after the port has been 2268 * resumed. 2269 */ 2270 if (udev->reset_resume) 2271 retry_reset_resume: 2272 status = usb_reset_and_verify_device(udev); 2273 2274 /* 10.5.4.5 says be sure devices in the tree are still there. 2275 * For now let's assume the device didn't go crazy on resume, 2276 * and device drivers will know about any resume quirks. 2277 */ 2278 if (status == 0) { 2279 devstatus = 0; 2280 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus); 2281 if (status >= 0) 2282 status = (status > 0 ? 0 : -ENODEV); 2283 2284 /* If a normal resume failed, try doing a reset-resume */ 2285 if (status && !udev->reset_resume && udev->persist_enabled) { 2286 dev_dbg(&udev->dev, "retry with reset-resume\n"); 2287 udev->reset_resume = 1; 2288 goto retry_reset_resume; 2289 } 2290 } 2291 2292 if (status) { 2293 dev_dbg(&udev->dev, "gone after usb resume? status %d\n", 2294 status); 2295 } else if (udev->actconfig) { 2296 le16_to_cpus(&devstatus); 2297 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) { 2298 status = usb_control_msg(udev, 2299 usb_sndctrlpipe(udev, 0), 2300 USB_REQ_CLEAR_FEATURE, 2301 USB_RECIP_DEVICE, 2302 USB_DEVICE_REMOTE_WAKEUP, 0, 2303 NULL, 0, 2304 USB_CTRL_SET_TIMEOUT); 2305 if (status) 2306 dev_dbg(&udev->dev, 2307 "disable remote wakeup, status %d\n", 2308 status); 2309 } 2310 status = 0; 2311 } 2312 return status; 2313 } 2314 2315 /* 2316 * usb_port_resume - re-activate a suspended usb device's upstream port 2317 * @udev: device to re-activate, not a root hub 2318 * Context: must be able to sleep; device not locked; pm locks held 2319 * 2320 * This will re-activate the suspended device, increasing power usage 2321 * while letting drivers communicate again with its endpoints. 2322 * USB resume explicitly guarantees that the power session between 2323 * the host and the device is the same as it was when the device 2324 * suspended. 2325 * 2326 * If @udev->reset_resume is set then this routine won't check that the 2327 * port is still enabled. Furthermore, finish_port_resume() above will 2328 * reset @udev. The end result is that a broken power session can be 2329 * recovered and @udev will appear to persist across a loss of VBUS power. 2330 * 2331 * For example, if a host controller doesn't maintain VBUS suspend current 2332 * during a system sleep or is reset when the system wakes up, all the USB 2333 * power sessions below it will be broken. This is especially troublesome 2334 * for mass-storage devices containing mounted filesystems, since the 2335 * device will appear to have disconnected and all the memory mappings 2336 * to it will be lost. Using the USB_PERSIST facility, the device can be 2337 * made to appear as if it had not disconnected. 2338 * 2339 * This facility can be dangerous. Although usb_reset_and_verify_device() makes 2340 * every effort to insure that the same device is present after the 2341 * reset as before, it cannot provide a 100% guarantee. Furthermore it's 2342 * quite possible for a device to remain unaltered but its media to be 2343 * changed. If the user replaces a flash memory card while the system is 2344 * asleep, he will have only himself to blame when the filesystem on the 2345 * new card is corrupted and the system crashes. 2346 * 2347 * Returns 0 on success, else negative errno. 2348 */ 2349 int usb_port_resume(struct usb_device *udev, pm_message_t msg) 2350 { 2351 struct usb_hub *hub = hdev_to_hub(udev->parent); 2352 int port1 = udev->portnum; 2353 int status; 2354 u16 portchange, portstatus; 2355 2356 /* Skip the initial Clear-Suspend step for a remote wakeup */ 2357 status = hub_port_status(hub, port1, &portstatus, &portchange); 2358 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND)) 2359 goto SuspendCleared; 2360 2361 // dev_dbg(hub->intfdev, "resume port %d\n", port1); 2362 2363 set_bit(port1, hub->busy_bits); 2364 2365 /* see 7.1.7.7; affects power usage, but not budgeting */ 2366 status = clear_port_feature(hub->hdev, 2367 port1, USB_PORT_FEAT_SUSPEND); 2368 if (status) { 2369 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n", 2370 port1, status); 2371 } else { 2372 /* drive resume for at least 20 msec */ 2373 dev_dbg(&udev->dev, "usb %sresume\n", 2374 (msg.event & PM_EVENT_AUTO ? "auto-" : "")); 2375 msleep(25); 2376 2377 /* Virtual root hubs can trigger on GET_PORT_STATUS to 2378 * stop resume signaling. Then finish the resume 2379 * sequence. 2380 */ 2381 status = hub_port_status(hub, port1, &portstatus, &portchange); 2382 2383 /* TRSMRCY = 10 msec */ 2384 msleep(10); 2385 } 2386 2387 SuspendCleared: 2388 if (status == 0) { 2389 if (portchange & USB_PORT_STAT_C_SUSPEND) 2390 clear_port_feature(hub->hdev, port1, 2391 USB_PORT_FEAT_C_SUSPEND); 2392 } 2393 2394 clear_bit(port1, hub->busy_bits); 2395 2396 status = check_port_resume_type(udev, 2397 hub, port1, status, portchange, portstatus); 2398 if (status == 0) 2399 status = finish_port_resume(udev); 2400 if (status < 0) { 2401 dev_dbg(&udev->dev, "can't resume, status %d\n", status); 2402 hub_port_logical_disconnect(hub, port1); 2403 } 2404 return status; 2405 } 2406 2407 /* caller has locked udev */ 2408 int usb_remote_wakeup(struct usb_device *udev) 2409 { 2410 int status = 0; 2411 2412 if (udev->state == USB_STATE_SUSPENDED) { 2413 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-"); 2414 status = usb_autoresume_device(udev); 2415 if (status == 0) { 2416 /* Let the drivers do their thing, then... */ 2417 usb_autosuspend_device(udev); 2418 } 2419 } 2420 return status; 2421 } 2422 2423 #else /* CONFIG_USB_SUSPEND */ 2424 2425 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */ 2426 2427 int usb_port_suspend(struct usb_device *udev, pm_message_t msg) 2428 { 2429 return 0; 2430 } 2431 2432 /* However we may need to do a reset-resume */ 2433 2434 int usb_port_resume(struct usb_device *udev, pm_message_t msg) 2435 { 2436 struct usb_hub *hub = hdev_to_hub(udev->parent); 2437 int port1 = udev->portnum; 2438 int status; 2439 u16 portchange, portstatus; 2440 2441 status = hub_port_status(hub, port1, &portstatus, &portchange); 2442 status = check_port_resume_type(udev, 2443 hub, port1, status, portchange, portstatus); 2444 2445 if (status) { 2446 dev_dbg(&udev->dev, "can't resume, status %d\n", status); 2447 hub_port_logical_disconnect(hub, port1); 2448 } else if (udev->reset_resume) { 2449 dev_dbg(&udev->dev, "reset-resume\n"); 2450 status = usb_reset_and_verify_device(udev); 2451 } 2452 return status; 2453 } 2454 2455 #endif 2456 2457 static int hub_suspend(struct usb_interface *intf, pm_message_t msg) 2458 { 2459 struct usb_hub *hub = usb_get_intfdata (intf); 2460 struct usb_device *hdev = hub->hdev; 2461 unsigned port1; 2462 2463 /* fail if children aren't already suspended */ 2464 for (port1 = 1; port1 <= hdev->maxchild; port1++) { 2465 struct usb_device *udev; 2466 2467 udev = hdev->children [port1-1]; 2468 if (udev && udev->can_submit) { 2469 if (!(msg.event & PM_EVENT_AUTO)) 2470 dev_dbg(&intf->dev, "port %d nyet suspended\n", 2471 port1); 2472 return -EBUSY; 2473 } 2474 } 2475 2476 dev_dbg(&intf->dev, "%s\n", __func__); 2477 2478 /* stop khubd and related activity */ 2479 hub_quiesce(hub, HUB_SUSPEND); 2480 return 0; 2481 } 2482 2483 static int hub_resume(struct usb_interface *intf) 2484 { 2485 struct usb_hub *hub = usb_get_intfdata(intf); 2486 2487 dev_dbg(&intf->dev, "%s\n", __func__); 2488 hub_activate(hub, HUB_RESUME); 2489 return 0; 2490 } 2491 2492 static int hub_reset_resume(struct usb_interface *intf) 2493 { 2494 struct usb_hub *hub = usb_get_intfdata(intf); 2495 2496 dev_dbg(&intf->dev, "%s\n", __func__); 2497 hub_activate(hub, HUB_RESET_RESUME); 2498 return 0; 2499 } 2500 2501 /** 2502 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power 2503 * @rhdev: struct usb_device for the root hub 2504 * 2505 * The USB host controller driver calls this function when its root hub 2506 * is resumed and Vbus power has been interrupted or the controller 2507 * has been reset. The routine marks @rhdev as having lost power. 2508 * When the hub driver is resumed it will take notice and carry out 2509 * power-session recovery for all the "USB-PERSIST"-enabled child devices; 2510 * the others will be disconnected. 2511 */ 2512 void usb_root_hub_lost_power(struct usb_device *rhdev) 2513 { 2514 dev_warn(&rhdev->dev, "root hub lost power or was reset\n"); 2515 rhdev->reset_resume = 1; 2516 } 2517 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power); 2518 2519 #else /* CONFIG_PM */ 2520 2521 #define hub_suspend NULL 2522 #define hub_resume NULL 2523 #define hub_reset_resume NULL 2524 #endif 2525 2526 2527 /* USB 2.0 spec, 7.1.7.3 / fig 7-29: 2528 * 2529 * Between connect detection and reset signaling there must be a delay 2530 * of 100ms at least for debounce and power-settling. The corresponding 2531 * timer shall restart whenever the downstream port detects a disconnect. 2532 * 2533 * Apparently there are some bluetooth and irda-dongles and a number of 2534 * low-speed devices for which this debounce period may last over a second. 2535 * Not covered by the spec - but easy to deal with. 2536 * 2537 * This implementation uses a 1500ms total debounce timeout; if the 2538 * connection isn't stable by then it returns -ETIMEDOUT. It checks 2539 * every 25ms for transient disconnects. When the port status has been 2540 * unchanged for 100ms it returns the port status. 2541 */ 2542 static int hub_port_debounce(struct usb_hub *hub, int port1) 2543 { 2544 int ret; 2545 int total_time, stable_time = 0; 2546 u16 portchange, portstatus; 2547 unsigned connection = 0xffff; 2548 2549 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) { 2550 ret = hub_port_status(hub, port1, &portstatus, &portchange); 2551 if (ret < 0) 2552 return ret; 2553 2554 if (!(portchange & USB_PORT_STAT_C_CONNECTION) && 2555 (portstatus & USB_PORT_STAT_CONNECTION) == connection) { 2556 stable_time += HUB_DEBOUNCE_STEP; 2557 if (stable_time >= HUB_DEBOUNCE_STABLE) 2558 break; 2559 } else { 2560 stable_time = 0; 2561 connection = portstatus & USB_PORT_STAT_CONNECTION; 2562 } 2563 2564 if (portchange & USB_PORT_STAT_C_CONNECTION) { 2565 clear_port_feature(hub->hdev, port1, 2566 USB_PORT_FEAT_C_CONNECTION); 2567 } 2568 2569 if (total_time >= HUB_DEBOUNCE_TIMEOUT) 2570 break; 2571 msleep(HUB_DEBOUNCE_STEP); 2572 } 2573 2574 dev_dbg (hub->intfdev, 2575 "debounce: port %d: total %dms stable %dms status 0x%x\n", 2576 port1, total_time, stable_time, portstatus); 2577 2578 if (stable_time < HUB_DEBOUNCE_STABLE) 2579 return -ETIMEDOUT; 2580 return portstatus; 2581 } 2582 2583 void usb_ep0_reinit(struct usb_device *udev) 2584 { 2585 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true); 2586 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true); 2587 usb_enable_endpoint(udev, &udev->ep0, true); 2588 } 2589 EXPORT_SYMBOL_GPL(usb_ep0_reinit); 2590 2591 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30) 2592 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN) 2593 2594 static int hub_set_address(struct usb_device *udev, int devnum) 2595 { 2596 int retval; 2597 struct usb_hcd *hcd = bus_to_hcd(udev->bus); 2598 2599 /* 2600 * The host controller will choose the device address, 2601 * instead of the core having chosen it earlier 2602 */ 2603 if (!hcd->driver->address_device && devnum <= 1) 2604 return -EINVAL; 2605 if (udev->state == USB_STATE_ADDRESS) 2606 return 0; 2607 if (udev->state != USB_STATE_DEFAULT) 2608 return -EINVAL; 2609 if (hcd->driver->address_device) 2610 retval = hcd->driver->address_device(hcd, udev); 2611 else 2612 retval = usb_control_msg(udev, usb_sndaddr0pipe(), 2613 USB_REQ_SET_ADDRESS, 0, devnum, 0, 2614 NULL, 0, USB_CTRL_SET_TIMEOUT); 2615 if (retval == 0) { 2616 update_address(udev, devnum); 2617 /* Device now using proper address. */ 2618 usb_set_device_state(udev, USB_STATE_ADDRESS); 2619 usb_ep0_reinit(udev); 2620 } 2621 return retval; 2622 } 2623 2624 /* Reset device, (re)assign address, get device descriptor. 2625 * Device connection must be stable, no more debouncing needed. 2626 * Returns device in USB_STATE_ADDRESS, except on error. 2627 * 2628 * If this is called for an already-existing device (as part of 2629 * usb_reset_and_verify_device), the caller must own the device lock. For a 2630 * newly detected device that is not accessible through any global 2631 * pointers, it's not necessary to lock the device. 2632 */ 2633 static int 2634 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1, 2635 int retry_counter) 2636 { 2637 static DEFINE_MUTEX(usb_address0_mutex); 2638 2639 struct usb_device *hdev = hub->hdev; 2640 struct usb_hcd *hcd = bus_to_hcd(hdev->bus); 2641 int i, j, retval; 2642 unsigned delay = HUB_SHORT_RESET_TIME; 2643 enum usb_device_speed oldspeed = udev->speed; 2644 char *speed, *type; 2645 int devnum = udev->devnum; 2646 2647 /* root hub ports have a slightly longer reset period 2648 * (from USB 2.0 spec, section 7.1.7.5) 2649 */ 2650 if (!hdev->parent) { 2651 delay = HUB_ROOT_RESET_TIME; 2652 if (port1 == hdev->bus->otg_port) 2653 hdev->bus->b_hnp_enable = 0; 2654 } 2655 2656 /* Some low speed devices have problems with the quick delay, so */ 2657 /* be a bit pessimistic with those devices. RHbug #23670 */ 2658 if (oldspeed == USB_SPEED_LOW) 2659 delay = HUB_LONG_RESET_TIME; 2660 2661 mutex_lock(&usb_address0_mutex); 2662 2663 if (!udev->config && oldspeed == USB_SPEED_SUPER) { 2664 /* Don't reset USB 3.0 devices during an initial setup */ 2665 usb_set_device_state(udev, USB_STATE_DEFAULT); 2666 } else { 2667 /* Reset the device; full speed may morph to high speed */ 2668 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */ 2669 retval = hub_port_reset(hub, port1, udev, delay); 2670 if (retval < 0) /* error or disconnect */ 2671 goto fail; 2672 /* success, speed is known */ 2673 } 2674 retval = -ENODEV; 2675 2676 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) { 2677 dev_dbg(&udev->dev, "device reset changed speed!\n"); 2678 goto fail; 2679 } 2680 oldspeed = udev->speed; 2681 2682 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ... 2683 * it's fixed size except for full speed devices. 2684 * For Wireless USB devices, ep0 max packet is always 512 (tho 2685 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1]. 2686 */ 2687 switch (udev->speed) { 2688 case USB_SPEED_SUPER: 2689 case USB_SPEED_WIRELESS: /* fixed at 512 */ 2690 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512); 2691 break; 2692 case USB_SPEED_HIGH: /* fixed at 64 */ 2693 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64); 2694 break; 2695 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */ 2696 /* to determine the ep0 maxpacket size, try to read 2697 * the device descriptor to get bMaxPacketSize0 and 2698 * then correct our initial guess. 2699 */ 2700 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64); 2701 break; 2702 case USB_SPEED_LOW: /* fixed at 8 */ 2703 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8); 2704 break; 2705 default: 2706 goto fail; 2707 } 2708 2709 type = ""; 2710 switch (udev->speed) { 2711 case USB_SPEED_LOW: speed = "low"; break; 2712 case USB_SPEED_FULL: speed = "full"; break; 2713 case USB_SPEED_HIGH: speed = "high"; break; 2714 case USB_SPEED_SUPER: 2715 speed = "super"; 2716 break; 2717 case USB_SPEED_WIRELESS: 2718 speed = "variable"; 2719 type = "Wireless "; 2720 break; 2721 default: speed = "?"; break; 2722 } 2723 if (udev->speed != USB_SPEED_SUPER) 2724 dev_info(&udev->dev, 2725 "%s %s speed %sUSB device using %s and address %d\n", 2726 (udev->config) ? "reset" : "new", speed, type, 2727 udev->bus->controller->driver->name, devnum); 2728 2729 /* Set up TT records, if needed */ 2730 if (hdev->tt) { 2731 udev->tt = hdev->tt; 2732 udev->ttport = hdev->ttport; 2733 } else if (udev->speed != USB_SPEED_HIGH 2734 && hdev->speed == USB_SPEED_HIGH) { 2735 udev->tt = &hub->tt; 2736 udev->ttport = port1; 2737 } 2738 2739 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way? 2740 * Because device hardware and firmware is sometimes buggy in 2741 * this area, and this is how Linux has done it for ages. 2742 * Change it cautiously. 2743 * 2744 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing 2745 * a 64-byte GET_DESCRIPTOR request. This is what Windows does, 2746 * so it may help with some non-standards-compliant devices. 2747 * Otherwise we start with SET_ADDRESS and then try to read the 2748 * first 8 bytes of the device descriptor to get the ep0 maxpacket 2749 * value. 2750 */ 2751 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) { 2752 /* 2753 * An xHCI controller cannot send any packets to a device until 2754 * a set address command successfully completes. 2755 */ 2756 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) { 2757 struct usb_device_descriptor *buf; 2758 int r = 0; 2759 2760 #define GET_DESCRIPTOR_BUFSIZE 64 2761 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO); 2762 if (!buf) { 2763 retval = -ENOMEM; 2764 continue; 2765 } 2766 2767 /* Retry on all errors; some devices are flakey. 2768 * 255 is for WUSB devices, we actually need to use 2769 * 512 (WUSB1.0[4.8.1]). 2770 */ 2771 for (j = 0; j < 3; ++j) { 2772 buf->bMaxPacketSize0 = 0; 2773 r = usb_control_msg(udev, usb_rcvaddr0pipe(), 2774 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, 2775 USB_DT_DEVICE << 8, 0, 2776 buf, GET_DESCRIPTOR_BUFSIZE, 2777 initial_descriptor_timeout); 2778 switch (buf->bMaxPacketSize0) { 2779 case 8: case 16: case 32: case 64: case 255: 2780 if (buf->bDescriptorType == 2781 USB_DT_DEVICE) { 2782 r = 0; 2783 break; 2784 } 2785 /* FALL THROUGH */ 2786 default: 2787 if (r == 0) 2788 r = -EPROTO; 2789 break; 2790 } 2791 if (r == 0) 2792 break; 2793 } 2794 udev->descriptor.bMaxPacketSize0 = 2795 buf->bMaxPacketSize0; 2796 kfree(buf); 2797 2798 retval = hub_port_reset(hub, port1, udev, delay); 2799 if (retval < 0) /* error or disconnect */ 2800 goto fail; 2801 if (oldspeed != udev->speed) { 2802 dev_dbg(&udev->dev, 2803 "device reset changed speed!\n"); 2804 retval = -ENODEV; 2805 goto fail; 2806 } 2807 if (r) { 2808 dev_err(&udev->dev, 2809 "device descriptor read/64, error %d\n", 2810 r); 2811 retval = -EMSGSIZE; 2812 continue; 2813 } 2814 #undef GET_DESCRIPTOR_BUFSIZE 2815 } 2816 2817 /* 2818 * If device is WUSB, we already assigned an 2819 * unauthorized address in the Connect Ack sequence; 2820 * authorization will assign the final address. 2821 */ 2822 if (udev->wusb == 0) { 2823 for (j = 0; j < SET_ADDRESS_TRIES; ++j) { 2824 retval = hub_set_address(udev, devnum); 2825 if (retval >= 0) 2826 break; 2827 msleep(200); 2828 } 2829 if (retval < 0) { 2830 dev_err(&udev->dev, 2831 "device not accepting address %d, error %d\n", 2832 devnum, retval); 2833 goto fail; 2834 } 2835 if (udev->speed == USB_SPEED_SUPER) { 2836 devnum = udev->devnum; 2837 dev_info(&udev->dev, 2838 "%s SuperSpeed USB device using %s and address %d\n", 2839 (udev->config) ? "reset" : "new", 2840 udev->bus->controller->driver->name, devnum); 2841 } 2842 2843 /* cope with hardware quirkiness: 2844 * - let SET_ADDRESS settle, some device hardware wants it 2845 * - read ep0 maxpacket even for high and low speed, 2846 */ 2847 msleep(10); 2848 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) 2849 break; 2850 } 2851 2852 retval = usb_get_device_descriptor(udev, 8); 2853 if (retval < 8) { 2854 dev_err(&udev->dev, 2855 "device descriptor read/8, error %d\n", 2856 retval); 2857 if (retval >= 0) 2858 retval = -EMSGSIZE; 2859 } else { 2860 retval = 0; 2861 break; 2862 } 2863 } 2864 if (retval) 2865 goto fail; 2866 2867 if (udev->descriptor.bMaxPacketSize0 == 0xff || 2868 udev->speed == USB_SPEED_SUPER) 2869 i = 512; 2870 else 2871 i = udev->descriptor.bMaxPacketSize0; 2872 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) { 2873 if (udev->speed == USB_SPEED_LOW || 2874 !(i == 8 || i == 16 || i == 32 || i == 64)) { 2875 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i); 2876 retval = -EMSGSIZE; 2877 goto fail; 2878 } 2879 if (udev->speed == USB_SPEED_FULL) 2880 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i); 2881 else 2882 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i); 2883 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i); 2884 usb_ep0_reinit(udev); 2885 } 2886 2887 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE); 2888 if (retval < (signed)sizeof(udev->descriptor)) { 2889 dev_err(&udev->dev, "device descriptor read/all, error %d\n", 2890 retval); 2891 if (retval >= 0) 2892 retval = -ENOMSG; 2893 goto fail; 2894 } 2895 2896 retval = 0; 2897 /* notify HCD that we have a device connected and addressed */ 2898 if (hcd->driver->update_device) 2899 hcd->driver->update_device(hcd, udev); 2900 fail: 2901 if (retval) { 2902 hub_port_disable(hub, port1, 0); 2903 update_address(udev, devnum); /* for disconnect processing */ 2904 } 2905 mutex_unlock(&usb_address0_mutex); 2906 return retval; 2907 } 2908 2909 static void 2910 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1) 2911 { 2912 struct usb_qualifier_descriptor *qual; 2913 int status; 2914 2915 qual = kmalloc (sizeof *qual, GFP_KERNEL); 2916 if (qual == NULL) 2917 return; 2918 2919 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0, 2920 qual, sizeof *qual); 2921 if (status == sizeof *qual) { 2922 dev_info(&udev->dev, "not running at top speed; " 2923 "connect to a high speed hub\n"); 2924 /* hub LEDs are probably harder to miss than syslog */ 2925 if (hub->has_indicators) { 2926 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK; 2927 schedule_delayed_work (&hub->leds, 0); 2928 } 2929 } 2930 kfree(qual); 2931 } 2932 2933 static unsigned 2934 hub_power_remaining (struct usb_hub *hub) 2935 { 2936 struct usb_device *hdev = hub->hdev; 2937 int remaining; 2938 int port1; 2939 2940 if (!hub->limited_power) 2941 return 0; 2942 2943 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent; 2944 for (port1 = 1; port1 <= hdev->maxchild; ++port1) { 2945 struct usb_device *udev = hdev->children[port1 - 1]; 2946 int delta; 2947 2948 if (!udev) 2949 continue; 2950 2951 /* Unconfigured devices may not use more than 100mA, 2952 * or 8mA for OTG ports */ 2953 if (udev->actconfig) 2954 delta = udev->actconfig->desc.bMaxPower * 2; 2955 else if (port1 != udev->bus->otg_port || hdev->parent) 2956 delta = 100; 2957 else 2958 delta = 8; 2959 if (delta > hub->mA_per_port) 2960 dev_warn(&udev->dev, 2961 "%dmA is over %umA budget for port %d!\n", 2962 delta, hub->mA_per_port, port1); 2963 remaining -= delta; 2964 } 2965 if (remaining < 0) { 2966 dev_warn(hub->intfdev, "%dmA over power budget!\n", 2967 - remaining); 2968 remaining = 0; 2969 } 2970 return remaining; 2971 } 2972 2973 /* Handle physical or logical connection change events. 2974 * This routine is called when: 2975 * a port connection-change occurs; 2976 * a port enable-change occurs (often caused by EMI); 2977 * usb_reset_and_verify_device() encounters changed descriptors (as from 2978 * a firmware download) 2979 * caller already locked the hub 2980 */ 2981 static void hub_port_connect_change(struct usb_hub *hub, int port1, 2982 u16 portstatus, u16 portchange) 2983 { 2984 struct usb_device *hdev = hub->hdev; 2985 struct device *hub_dev = hub->intfdev; 2986 struct usb_hcd *hcd = bus_to_hcd(hdev->bus); 2987 unsigned wHubCharacteristics = 2988 le16_to_cpu(hub->descriptor->wHubCharacteristics); 2989 struct usb_device *udev; 2990 int status, i; 2991 2992 dev_dbg (hub_dev, 2993 "port %d, status %04x, change %04x, %s\n", 2994 port1, portstatus, portchange, portspeed (portstatus)); 2995 2996 if (hub->has_indicators) { 2997 set_port_led(hub, port1, HUB_LED_AUTO); 2998 hub->indicator[port1-1] = INDICATOR_AUTO; 2999 } 3000 3001 #ifdef CONFIG_USB_OTG 3002 /* during HNP, don't repeat the debounce */ 3003 if (hdev->bus->is_b_host) 3004 portchange &= ~(USB_PORT_STAT_C_CONNECTION | 3005 USB_PORT_STAT_C_ENABLE); 3006 #endif 3007 3008 /* Try to resuscitate an existing device */ 3009 udev = hdev->children[port1-1]; 3010 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev && 3011 udev->state != USB_STATE_NOTATTACHED) { 3012 usb_lock_device(udev); 3013 if (portstatus & USB_PORT_STAT_ENABLE) { 3014 status = 0; /* Nothing to do */ 3015 3016 #ifdef CONFIG_USB_SUSPEND 3017 } else if (udev->state == USB_STATE_SUSPENDED && 3018 udev->persist_enabled) { 3019 /* For a suspended device, treat this as a 3020 * remote wakeup event. 3021 */ 3022 status = usb_remote_wakeup(udev); 3023 #endif 3024 3025 } else { 3026 status = -ENODEV; /* Don't resuscitate */ 3027 } 3028 usb_unlock_device(udev); 3029 3030 if (status == 0) { 3031 clear_bit(port1, hub->change_bits); 3032 return; 3033 } 3034 } 3035 3036 /* Disconnect any existing devices under this port */ 3037 if (udev) 3038 usb_disconnect(&hdev->children[port1-1]); 3039 clear_bit(port1, hub->change_bits); 3040 3041 /* We can forget about a "removed" device when there's a physical 3042 * disconnect or the connect status changes. 3043 */ 3044 if (!(portstatus & USB_PORT_STAT_CONNECTION) || 3045 (portchange & USB_PORT_STAT_C_CONNECTION)) 3046 clear_bit(port1, hub->removed_bits); 3047 3048 if (portchange & (USB_PORT_STAT_C_CONNECTION | 3049 USB_PORT_STAT_C_ENABLE)) { 3050 status = hub_port_debounce(hub, port1); 3051 if (status < 0) { 3052 if (printk_ratelimit()) 3053 dev_err(hub_dev, "connect-debounce failed, " 3054 "port %d disabled\n", port1); 3055 portstatus &= ~USB_PORT_STAT_CONNECTION; 3056 } else { 3057 portstatus = status; 3058 } 3059 } 3060 3061 /* Return now if debouncing failed or nothing is connected or 3062 * the device was "removed". 3063 */ 3064 if (!(portstatus & USB_PORT_STAT_CONNECTION) || 3065 test_bit(port1, hub->removed_bits)) { 3066 3067 /* maybe switch power back on (e.g. root hub was reset) */ 3068 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2 3069 && !(portstatus & USB_PORT_STAT_POWER)) 3070 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER); 3071 3072 if (portstatus & USB_PORT_STAT_ENABLE) 3073 goto done; 3074 return; 3075 } 3076 3077 for (i = 0; i < SET_CONFIG_TRIES; i++) { 3078 3079 /* reallocate for each attempt, since references 3080 * to the previous one can escape in various ways 3081 */ 3082 udev = usb_alloc_dev(hdev, hdev->bus, port1); 3083 if (!udev) { 3084 dev_err (hub_dev, 3085 "couldn't allocate port %d usb_device\n", 3086 port1); 3087 goto done; 3088 } 3089 3090 usb_set_device_state(udev, USB_STATE_POWERED); 3091 udev->bus_mA = hub->mA_per_port; 3092 udev->level = hdev->level + 1; 3093 udev->wusb = hub_is_wusb(hub); 3094 3095 /* 3096 * USB 3.0 devices are reset automatically before the connect 3097 * port status change appears, and the root hub port status 3098 * shows the correct speed. We also get port change 3099 * notifications for USB 3.0 devices from the USB 3.0 portion of 3100 * an external USB 3.0 hub, but this isn't handled correctly yet 3101 * FIXME. 3102 */ 3103 3104 if (!(hcd->driver->flags & HCD_USB3)) 3105 udev->speed = USB_SPEED_UNKNOWN; 3106 else if ((hdev->parent == NULL) && 3107 (portstatus & USB_PORT_STAT_SUPER_SPEED)) 3108 udev->speed = USB_SPEED_SUPER; 3109 else 3110 udev->speed = USB_SPEED_UNKNOWN; 3111 3112 /* 3113 * Set the address. 3114 * Note xHCI needs to issue an address device command later 3115 * in the hub_port_init sequence for SS/HS/FS/LS devices, 3116 * and xHC will assign an address to the device. But use 3117 * kernel assigned address here, to avoid any address conflict 3118 * issue. 3119 */ 3120 choose_address(udev); 3121 if (udev->devnum <= 0) { 3122 status = -ENOTCONN; /* Don't retry */ 3123 goto loop; 3124 } 3125 3126 /* reset (non-USB 3.0 devices) and get descriptor */ 3127 status = hub_port_init(hub, udev, port1, i); 3128 if (status < 0) 3129 goto loop; 3130 3131 usb_detect_quirks(udev); 3132 if (udev->quirks & USB_QUIRK_DELAY_INIT) 3133 msleep(1000); 3134 3135 /* consecutive bus-powered hubs aren't reliable; they can 3136 * violate the voltage drop budget. if the new child has 3137 * a "powered" LED, users should notice we didn't enable it 3138 * (without reading syslog), even without per-port LEDs 3139 * on the parent. 3140 */ 3141 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB 3142 && udev->bus_mA <= 100) { 3143 u16 devstat; 3144 3145 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, 3146 &devstat); 3147 if (status < 2) { 3148 dev_dbg(&udev->dev, "get status %d ?\n", status); 3149 goto loop_disable; 3150 } 3151 le16_to_cpus(&devstat); 3152 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) { 3153 dev_err(&udev->dev, 3154 "can't connect bus-powered hub " 3155 "to this port\n"); 3156 if (hub->has_indicators) { 3157 hub->indicator[port1-1] = 3158 INDICATOR_AMBER_BLINK; 3159 schedule_delayed_work (&hub->leds, 0); 3160 } 3161 status = -ENOTCONN; /* Don't retry */ 3162 goto loop_disable; 3163 } 3164 } 3165 3166 /* check for devices running slower than they could */ 3167 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200 3168 && udev->speed == USB_SPEED_FULL 3169 && highspeed_hubs != 0) 3170 check_highspeed (hub, udev, port1); 3171 3172 /* Store the parent's children[] pointer. At this point 3173 * udev becomes globally accessible, although presumably 3174 * no one will look at it until hdev is unlocked. 3175 */ 3176 status = 0; 3177 3178 /* We mustn't add new devices if the parent hub has 3179 * been disconnected; we would race with the 3180 * recursively_mark_NOTATTACHED() routine. 3181 */ 3182 spin_lock_irq(&device_state_lock); 3183 if (hdev->state == USB_STATE_NOTATTACHED) 3184 status = -ENOTCONN; 3185 else 3186 hdev->children[port1-1] = udev; 3187 spin_unlock_irq(&device_state_lock); 3188 3189 /* Run it through the hoops (find a driver, etc) */ 3190 if (!status) { 3191 status = usb_new_device(udev); 3192 if (status) { 3193 spin_lock_irq(&device_state_lock); 3194 hdev->children[port1-1] = NULL; 3195 spin_unlock_irq(&device_state_lock); 3196 } 3197 } 3198 3199 if (status) 3200 goto loop_disable; 3201 3202 status = hub_power_remaining(hub); 3203 if (status) 3204 dev_dbg(hub_dev, "%dmA power budget left\n", status); 3205 3206 return; 3207 3208 loop_disable: 3209 hub_port_disable(hub, port1, 1); 3210 loop: 3211 usb_ep0_reinit(udev); 3212 release_address(udev); 3213 hub_free_dev(udev); 3214 usb_put_dev(udev); 3215 if ((status == -ENOTCONN) || (status == -ENOTSUPP)) 3216 break; 3217 } 3218 if (hub->hdev->parent || 3219 !hcd->driver->port_handed_over || 3220 !(hcd->driver->port_handed_over)(hcd, port1)) 3221 dev_err(hub_dev, "unable to enumerate USB device on port %d\n", 3222 port1); 3223 3224 done: 3225 hub_port_disable(hub, port1, 1); 3226 if (hcd->driver->relinquish_port && !hub->hdev->parent) 3227 hcd->driver->relinquish_port(hcd, port1); 3228 } 3229 3230 static void hub_events(void) 3231 { 3232 struct list_head *tmp; 3233 struct usb_device *hdev; 3234 struct usb_interface *intf; 3235 struct usb_hub *hub; 3236 struct device *hub_dev; 3237 u16 hubstatus; 3238 u16 hubchange; 3239 u16 portstatus; 3240 u16 portchange; 3241 int i, ret; 3242 int connect_change; 3243 3244 /* 3245 * We restart the list every time to avoid a deadlock with 3246 * deleting hubs downstream from this one. This should be 3247 * safe since we delete the hub from the event list. 3248 * Not the most efficient, but avoids deadlocks. 3249 */ 3250 while (1) { 3251 3252 /* Grab the first entry at the beginning of the list */ 3253 spin_lock_irq(&hub_event_lock); 3254 if (list_empty(&hub_event_list)) { 3255 spin_unlock_irq(&hub_event_lock); 3256 break; 3257 } 3258 3259 tmp = hub_event_list.next; 3260 list_del_init(tmp); 3261 3262 hub = list_entry(tmp, struct usb_hub, event_list); 3263 kref_get(&hub->kref); 3264 spin_unlock_irq(&hub_event_lock); 3265 3266 hdev = hub->hdev; 3267 hub_dev = hub->intfdev; 3268 intf = to_usb_interface(hub_dev); 3269 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n", 3270 hdev->state, hub->descriptor 3271 ? hub->descriptor->bNbrPorts 3272 : 0, 3273 /* NOTE: expects max 15 ports... */ 3274 (u16) hub->change_bits[0], 3275 (u16) hub->event_bits[0]); 3276 3277 /* Lock the device, then check to see if we were 3278 * disconnected while waiting for the lock to succeed. */ 3279 usb_lock_device(hdev); 3280 if (unlikely(hub->disconnected)) 3281 goto loop_disconnected; 3282 3283 /* If the hub has died, clean up after it */ 3284 if (hdev->state == USB_STATE_NOTATTACHED) { 3285 hub->error = -ENODEV; 3286 hub_quiesce(hub, HUB_DISCONNECT); 3287 goto loop; 3288 } 3289 3290 /* Autoresume */ 3291 ret = usb_autopm_get_interface(intf); 3292 if (ret) { 3293 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret); 3294 goto loop; 3295 } 3296 3297 /* If this is an inactive hub, do nothing */ 3298 if (hub->quiescing) 3299 goto loop_autopm; 3300 3301 if (hub->error) { 3302 dev_dbg (hub_dev, "resetting for error %d\n", 3303 hub->error); 3304 3305 ret = usb_reset_device(hdev); 3306 if (ret) { 3307 dev_dbg (hub_dev, 3308 "error resetting hub: %d\n", ret); 3309 goto loop_autopm; 3310 } 3311 3312 hub->nerrors = 0; 3313 hub->error = 0; 3314 } 3315 3316 /* deal with port status changes */ 3317 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) { 3318 if (test_bit(i, hub->busy_bits)) 3319 continue; 3320 connect_change = test_bit(i, hub->change_bits); 3321 if (!test_and_clear_bit(i, hub->event_bits) && 3322 !connect_change) 3323 continue; 3324 3325 ret = hub_port_status(hub, i, 3326 &portstatus, &portchange); 3327 if (ret < 0) 3328 continue; 3329 3330 if (portchange & USB_PORT_STAT_C_CONNECTION) { 3331 clear_port_feature(hdev, i, 3332 USB_PORT_FEAT_C_CONNECTION); 3333 connect_change = 1; 3334 } 3335 3336 if (portchange & USB_PORT_STAT_C_ENABLE) { 3337 if (!connect_change) 3338 dev_dbg (hub_dev, 3339 "port %d enable change, " 3340 "status %08x\n", 3341 i, portstatus); 3342 clear_port_feature(hdev, i, 3343 USB_PORT_FEAT_C_ENABLE); 3344 3345 /* 3346 * EM interference sometimes causes badly 3347 * shielded USB devices to be shutdown by 3348 * the hub, this hack enables them again. 3349 * Works at least with mouse driver. 3350 */ 3351 if (!(portstatus & USB_PORT_STAT_ENABLE) 3352 && !connect_change 3353 && hdev->children[i-1]) { 3354 dev_err (hub_dev, 3355 "port %i " 3356 "disabled by hub (EMI?), " 3357 "re-enabling...\n", 3358 i); 3359 connect_change = 1; 3360 } 3361 } 3362 3363 if (portchange & USB_PORT_STAT_C_SUSPEND) { 3364 struct usb_device *udev; 3365 3366 clear_port_feature(hdev, i, 3367 USB_PORT_FEAT_C_SUSPEND); 3368 udev = hdev->children[i-1]; 3369 if (udev) { 3370 /* TRSMRCY = 10 msec */ 3371 msleep(10); 3372 3373 usb_lock_device(udev); 3374 ret = usb_remote_wakeup(hdev-> 3375 children[i-1]); 3376 usb_unlock_device(udev); 3377 if (ret < 0) 3378 connect_change = 1; 3379 } else { 3380 ret = -ENODEV; 3381 hub_port_disable(hub, i, 1); 3382 } 3383 dev_dbg (hub_dev, 3384 "resume on port %d, status %d\n", 3385 i, ret); 3386 } 3387 3388 if (portchange & USB_PORT_STAT_C_OVERCURRENT) { 3389 dev_err (hub_dev, 3390 "over-current change on port %d\n", 3391 i); 3392 clear_port_feature(hdev, i, 3393 USB_PORT_FEAT_C_OVER_CURRENT); 3394 hub_power_on(hub, true); 3395 } 3396 3397 if (portchange & USB_PORT_STAT_C_RESET) { 3398 dev_dbg (hub_dev, 3399 "reset change on port %d\n", 3400 i); 3401 clear_port_feature(hdev, i, 3402 USB_PORT_FEAT_C_RESET); 3403 } 3404 3405 if (connect_change) 3406 hub_port_connect_change(hub, i, 3407 portstatus, portchange); 3408 } /* end for i */ 3409 3410 /* deal with hub status changes */ 3411 if (test_and_clear_bit(0, hub->event_bits) == 0) 3412 ; /* do nothing */ 3413 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0) 3414 dev_err (hub_dev, "get_hub_status failed\n"); 3415 else { 3416 if (hubchange & HUB_CHANGE_LOCAL_POWER) { 3417 dev_dbg (hub_dev, "power change\n"); 3418 clear_hub_feature(hdev, C_HUB_LOCAL_POWER); 3419 if (hubstatus & HUB_STATUS_LOCAL_POWER) 3420 /* FIXME: Is this always true? */ 3421 hub->limited_power = 1; 3422 else 3423 hub->limited_power = 0; 3424 } 3425 if (hubchange & HUB_CHANGE_OVERCURRENT) { 3426 dev_dbg (hub_dev, "overcurrent change\n"); 3427 msleep(500); /* Cool down */ 3428 clear_hub_feature(hdev, C_HUB_OVER_CURRENT); 3429 hub_power_on(hub, true); 3430 } 3431 } 3432 3433 loop_autopm: 3434 /* Balance the usb_autopm_get_interface() above */ 3435 usb_autopm_put_interface_no_suspend(intf); 3436 loop: 3437 /* Balance the usb_autopm_get_interface_no_resume() in 3438 * kick_khubd() and allow autosuspend. 3439 */ 3440 usb_autopm_put_interface(intf); 3441 loop_disconnected: 3442 usb_unlock_device(hdev); 3443 kref_put(&hub->kref, hub_release); 3444 3445 } /* end while (1) */ 3446 } 3447 3448 static int hub_thread(void *__unused) 3449 { 3450 /* khubd needs to be freezable to avoid intefering with USB-PERSIST 3451 * port handover. Otherwise it might see that a full-speed device 3452 * was gone before the EHCI controller had handed its port over to 3453 * the companion full-speed controller. 3454 */ 3455 set_freezable(); 3456 3457 do { 3458 hub_events(); 3459 wait_event_freezable(khubd_wait, 3460 !list_empty(&hub_event_list) || 3461 kthread_should_stop()); 3462 } while (!kthread_should_stop() || !list_empty(&hub_event_list)); 3463 3464 pr_debug("%s: khubd exiting\n", usbcore_name); 3465 return 0; 3466 } 3467 3468 static const struct usb_device_id hub_id_table[] = { 3469 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS, 3470 .bDeviceClass = USB_CLASS_HUB}, 3471 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS, 3472 .bInterfaceClass = USB_CLASS_HUB}, 3473 { } /* Terminating entry */ 3474 }; 3475 3476 MODULE_DEVICE_TABLE (usb, hub_id_table); 3477 3478 static struct usb_driver hub_driver = { 3479 .name = "hub", 3480 .probe = hub_probe, 3481 .disconnect = hub_disconnect, 3482 .suspend = hub_suspend, 3483 .resume = hub_resume, 3484 .reset_resume = hub_reset_resume, 3485 .pre_reset = hub_pre_reset, 3486 .post_reset = hub_post_reset, 3487 .unlocked_ioctl = hub_ioctl, 3488 .id_table = hub_id_table, 3489 .supports_autosuspend = 1, 3490 }; 3491 3492 int usb_hub_init(void) 3493 { 3494 if (usb_register(&hub_driver) < 0) { 3495 printk(KERN_ERR "%s: can't register hub driver\n", 3496 usbcore_name); 3497 return -1; 3498 } 3499 3500 khubd_task = kthread_run(hub_thread, NULL, "khubd"); 3501 if (!IS_ERR(khubd_task)) 3502 return 0; 3503 3504 /* Fall through if kernel_thread failed */ 3505 usb_deregister(&hub_driver); 3506 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name); 3507 3508 return -1; 3509 } 3510 3511 void usb_hub_cleanup(void) 3512 { 3513 kthread_stop(khubd_task); 3514 3515 /* 3516 * Hub resources are freed for us by usb_deregister. It calls 3517 * usb_driver_purge on every device which in turn calls that 3518 * devices disconnect function if it is using this driver. 3519 * The hub_disconnect function takes care of releasing the 3520 * individual hub resources. -greg 3521 */ 3522 usb_deregister(&hub_driver); 3523 } /* usb_hub_cleanup() */ 3524 3525 static int descriptors_changed(struct usb_device *udev, 3526 struct usb_device_descriptor *old_device_descriptor) 3527 { 3528 int changed = 0; 3529 unsigned index; 3530 unsigned serial_len = 0; 3531 unsigned len; 3532 unsigned old_length; 3533 int length; 3534 char *buf; 3535 3536 if (memcmp(&udev->descriptor, old_device_descriptor, 3537 sizeof(*old_device_descriptor)) != 0) 3538 return 1; 3539 3540 /* Since the idVendor, idProduct, and bcdDevice values in the 3541 * device descriptor haven't changed, we will assume the 3542 * Manufacturer and Product strings haven't changed either. 3543 * But the SerialNumber string could be different (e.g., a 3544 * different flash card of the same brand). 3545 */ 3546 if (udev->serial) 3547 serial_len = strlen(udev->serial) + 1; 3548 3549 len = serial_len; 3550 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) { 3551 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength); 3552 len = max(len, old_length); 3553 } 3554 3555 buf = kmalloc(len, GFP_NOIO); 3556 if (buf == NULL) { 3557 dev_err(&udev->dev, "no mem to re-read configs after reset\n"); 3558 /* assume the worst */ 3559 return 1; 3560 } 3561 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) { 3562 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength); 3563 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf, 3564 old_length); 3565 if (length != old_length) { 3566 dev_dbg(&udev->dev, "config index %d, error %d\n", 3567 index, length); 3568 changed = 1; 3569 break; 3570 } 3571 if (memcmp (buf, udev->rawdescriptors[index], old_length) 3572 != 0) { 3573 dev_dbg(&udev->dev, "config index %d changed (#%d)\n", 3574 index, 3575 ((struct usb_config_descriptor *) buf)-> 3576 bConfigurationValue); 3577 changed = 1; 3578 break; 3579 } 3580 } 3581 3582 if (!changed && serial_len) { 3583 length = usb_string(udev, udev->descriptor.iSerialNumber, 3584 buf, serial_len); 3585 if (length + 1 != serial_len) { 3586 dev_dbg(&udev->dev, "serial string error %d\n", 3587 length); 3588 changed = 1; 3589 } else if (memcmp(buf, udev->serial, length) != 0) { 3590 dev_dbg(&udev->dev, "serial string changed\n"); 3591 changed = 1; 3592 } 3593 } 3594 3595 kfree(buf); 3596 return changed; 3597 } 3598 3599 /** 3600 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device 3601 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state) 3602 * 3603 * WARNING - don't use this routine to reset a composite device 3604 * (one with multiple interfaces owned by separate drivers)! 3605 * Use usb_reset_device() instead. 3606 * 3607 * Do a port reset, reassign the device's address, and establish its 3608 * former operating configuration. If the reset fails, or the device's 3609 * descriptors change from their values before the reset, or the original 3610 * configuration and altsettings cannot be restored, a flag will be set 3611 * telling khubd to pretend the device has been disconnected and then 3612 * re-connected. All drivers will be unbound, and the device will be 3613 * re-enumerated and probed all over again. 3614 * 3615 * Returns 0 if the reset succeeded, -ENODEV if the device has been 3616 * flagged for logical disconnection, or some other negative error code 3617 * if the reset wasn't even attempted. 3618 * 3619 * The caller must own the device lock. For example, it's safe to use 3620 * this from a driver probe() routine after downloading new firmware. 3621 * For calls that might not occur during probe(), drivers should lock 3622 * the device using usb_lock_device_for_reset(). 3623 * 3624 * Locking exception: This routine may also be called from within an 3625 * autoresume handler. Such usage won't conflict with other tasks 3626 * holding the device lock because these tasks should always call 3627 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume. 3628 */ 3629 static int usb_reset_and_verify_device(struct usb_device *udev) 3630 { 3631 struct usb_device *parent_hdev = udev->parent; 3632 struct usb_hub *parent_hub; 3633 struct usb_hcd *hcd = bus_to_hcd(udev->bus); 3634 struct usb_device_descriptor descriptor = udev->descriptor; 3635 int i, ret = 0; 3636 int port1 = udev->portnum; 3637 3638 if (udev->state == USB_STATE_NOTATTACHED || 3639 udev->state == USB_STATE_SUSPENDED) { 3640 dev_dbg(&udev->dev, "device reset not allowed in state %d\n", 3641 udev->state); 3642 return -EINVAL; 3643 } 3644 3645 if (!parent_hdev) { 3646 /* this requires hcd-specific logic; see ohci_restart() */ 3647 dev_dbg(&udev->dev, "%s for root hub!\n", __func__); 3648 return -EISDIR; 3649 } 3650 parent_hub = hdev_to_hub(parent_hdev); 3651 3652 set_bit(port1, parent_hub->busy_bits); 3653 for (i = 0; i < SET_CONFIG_TRIES; ++i) { 3654 3655 /* ep0 maxpacket size may change; let the HCD know about it. 3656 * Other endpoints will be handled by re-enumeration. */ 3657 usb_ep0_reinit(udev); 3658 ret = hub_port_init(parent_hub, udev, port1, i); 3659 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV) 3660 break; 3661 } 3662 clear_bit(port1, parent_hub->busy_bits); 3663 3664 if (ret < 0) 3665 goto re_enumerate; 3666 3667 /* Device might have changed firmware (DFU or similar) */ 3668 if (descriptors_changed(udev, &descriptor)) { 3669 dev_info(&udev->dev, "device firmware changed\n"); 3670 udev->descriptor = descriptor; /* for disconnect() calls */ 3671 goto re_enumerate; 3672 } 3673 3674 /* Restore the device's previous configuration */ 3675 if (!udev->actconfig) 3676 goto done; 3677 3678 mutex_lock(&hcd->bandwidth_mutex); 3679 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL); 3680 if (ret < 0) { 3681 dev_warn(&udev->dev, 3682 "Busted HC? Not enough HCD resources for " 3683 "old configuration.\n"); 3684 mutex_unlock(&hcd->bandwidth_mutex); 3685 goto re_enumerate; 3686 } 3687 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 3688 USB_REQ_SET_CONFIGURATION, 0, 3689 udev->actconfig->desc.bConfigurationValue, 0, 3690 NULL, 0, USB_CTRL_SET_TIMEOUT); 3691 if (ret < 0) { 3692 dev_err(&udev->dev, 3693 "can't restore configuration #%d (error=%d)\n", 3694 udev->actconfig->desc.bConfigurationValue, ret); 3695 mutex_unlock(&hcd->bandwidth_mutex); 3696 goto re_enumerate; 3697 } 3698 mutex_unlock(&hcd->bandwidth_mutex); 3699 usb_set_device_state(udev, USB_STATE_CONFIGURED); 3700 3701 /* Put interfaces back into the same altsettings as before. 3702 * Don't bother to send the Set-Interface request for interfaces 3703 * that were already in altsetting 0; besides being unnecessary, 3704 * many devices can't handle it. Instead just reset the host-side 3705 * endpoint state. 3706 */ 3707 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) { 3708 struct usb_host_config *config = udev->actconfig; 3709 struct usb_interface *intf = config->interface[i]; 3710 struct usb_interface_descriptor *desc; 3711 3712 desc = &intf->cur_altsetting->desc; 3713 if (desc->bAlternateSetting == 0) { 3714 usb_disable_interface(udev, intf, true); 3715 usb_enable_interface(udev, intf, true); 3716 ret = 0; 3717 } else { 3718 /* Let the bandwidth allocation function know that this 3719 * device has been reset, and it will have to use 3720 * alternate setting 0 as the current alternate setting. 3721 */ 3722 intf->resetting_device = 1; 3723 ret = usb_set_interface(udev, desc->bInterfaceNumber, 3724 desc->bAlternateSetting); 3725 intf->resetting_device = 0; 3726 } 3727 if (ret < 0) { 3728 dev_err(&udev->dev, "failed to restore interface %d " 3729 "altsetting %d (error=%d)\n", 3730 desc->bInterfaceNumber, 3731 desc->bAlternateSetting, 3732 ret); 3733 goto re_enumerate; 3734 } 3735 } 3736 3737 done: 3738 return 0; 3739 3740 re_enumerate: 3741 hub_port_logical_disconnect(parent_hub, port1); 3742 return -ENODEV; 3743 } 3744 3745 /** 3746 * usb_reset_device - warn interface drivers and perform a USB port reset 3747 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state) 3748 * 3749 * Warns all drivers bound to registered interfaces (using their pre_reset 3750 * method), performs the port reset, and then lets the drivers know that 3751 * the reset is over (using their post_reset method). 3752 * 3753 * Return value is the same as for usb_reset_and_verify_device(). 3754 * 3755 * The caller must own the device lock. For example, it's safe to use 3756 * this from a driver probe() routine after downloading new firmware. 3757 * For calls that might not occur during probe(), drivers should lock 3758 * the device using usb_lock_device_for_reset(). 3759 * 3760 * If an interface is currently being probed or disconnected, we assume 3761 * its driver knows how to handle resets. For all other interfaces, 3762 * if the driver doesn't have pre_reset and post_reset methods then 3763 * we attempt to unbind it and rebind afterward. 3764 */ 3765 int usb_reset_device(struct usb_device *udev) 3766 { 3767 int ret; 3768 int i; 3769 struct usb_host_config *config = udev->actconfig; 3770 3771 if (udev->state == USB_STATE_NOTATTACHED || 3772 udev->state == USB_STATE_SUSPENDED) { 3773 dev_dbg(&udev->dev, "device reset not allowed in state %d\n", 3774 udev->state); 3775 return -EINVAL; 3776 } 3777 3778 /* Prevent autosuspend during the reset */ 3779 usb_autoresume_device(udev); 3780 3781 if (config) { 3782 for (i = 0; i < config->desc.bNumInterfaces; ++i) { 3783 struct usb_interface *cintf = config->interface[i]; 3784 struct usb_driver *drv; 3785 int unbind = 0; 3786 3787 if (cintf->dev.driver) { 3788 drv = to_usb_driver(cintf->dev.driver); 3789 if (drv->pre_reset && drv->post_reset) 3790 unbind = (drv->pre_reset)(cintf); 3791 else if (cintf->condition == 3792 USB_INTERFACE_BOUND) 3793 unbind = 1; 3794 if (unbind) 3795 usb_forced_unbind_intf(cintf); 3796 } 3797 } 3798 } 3799 3800 ret = usb_reset_and_verify_device(udev); 3801 3802 if (config) { 3803 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) { 3804 struct usb_interface *cintf = config->interface[i]; 3805 struct usb_driver *drv; 3806 int rebind = cintf->needs_binding; 3807 3808 if (!rebind && cintf->dev.driver) { 3809 drv = to_usb_driver(cintf->dev.driver); 3810 if (drv->post_reset) 3811 rebind = (drv->post_reset)(cintf); 3812 else if (cintf->condition == 3813 USB_INTERFACE_BOUND) 3814 rebind = 1; 3815 } 3816 if (ret == 0 && rebind) 3817 usb_rebind_intf(cintf); 3818 } 3819 } 3820 3821 usb_autosuspend_device(udev); 3822 return ret; 3823 } 3824 EXPORT_SYMBOL_GPL(usb_reset_device); 3825 3826 3827 /** 3828 * usb_queue_reset_device - Reset a USB device from an atomic context 3829 * @iface: USB interface belonging to the device to reset 3830 * 3831 * This function can be used to reset a USB device from an atomic 3832 * context, where usb_reset_device() won't work (as it blocks). 3833 * 3834 * Doing a reset via this method is functionally equivalent to calling 3835 * usb_reset_device(), except for the fact that it is delayed to a 3836 * workqueue. This means that any drivers bound to other interfaces 3837 * might be unbound, as well as users from usbfs in user space. 3838 * 3839 * Corner cases: 3840 * 3841 * - Scheduling two resets at the same time from two different drivers 3842 * attached to two different interfaces of the same device is 3843 * possible; depending on how the driver attached to each interface 3844 * handles ->pre_reset(), the second reset might happen or not. 3845 * 3846 * - If a driver is unbound and it had a pending reset, the reset will 3847 * be cancelled. 3848 * 3849 * - This function can be called during .probe() or .disconnect() 3850 * times. On return from .disconnect(), any pending resets will be 3851 * cancelled. 3852 * 3853 * There is no no need to lock/unlock the @reset_ws as schedule_work() 3854 * does its own. 3855 * 3856 * NOTE: We don't do any reference count tracking because it is not 3857 * needed. The lifecycle of the work_struct is tied to the 3858 * usb_interface. Before destroying the interface we cancel the 3859 * work_struct, so the fact that work_struct is queued and or 3860 * running means the interface (and thus, the device) exist and 3861 * are referenced. 3862 */ 3863 void usb_queue_reset_device(struct usb_interface *iface) 3864 { 3865 schedule_work(&iface->reset_ws); 3866 } 3867 EXPORT_SYMBOL_GPL(usb_queue_reset_device); 3868