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