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