drivers/usb/core/hub.c

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