common/usb.c

   1 /*
   2  *
   3  * Most of this source has been derived from the Linux USB
   4  * project:
   5  * (C) Copyright Linus Torvalds 1999
   6  * (C) Copyright Johannes Erdfelt 1999-2001
   7  * (C) Copyright Andreas Gal 1999
   8  * (C) Copyright Gregory P. Smith 1999
   9  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
  10  * (C) Copyright Randy Dunlap 2000
  11  * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
  12  * (C) Copyright Yggdrasil Computing, Inc. 2000
  13  *     (usb_device_id matching changes by Adam J. Richter)
  14  *
  15  * Adapted for U-Boot:
  16  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  17  *
  18  * See file CREDITS for list of people who contributed to this
  19  * project.
  20  *
  21  * This program is free software; you can redistribute it and/or
  22  * modify it under the terms of the GNU General Public License as
  23  * published by the Free Software Foundation; either version 2 of
  24  * the License, or (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  34  * MA 02111-1307 USA
  35  *
  36  */
  37
  38 /*
  39  * How it works:
  40  *
  41  * Since this is a bootloader, the devices will not be automatic
  42  * (re)configured on hotplug, but after a restart of the USB the
  43  * device should work.
  44  *
  45  * For each transfer (except "Interrupt") we wait for completion.
  46  */
  47 #include <common.h>
  48 #include <command.h>
  49 #include <asm/processor.h>
  50 #include <linux/ctype.h>
  51 #include <asm/byteorder.h>
  52
  53 #include <usb.h>
  54 #ifdef CONFIG_4xx
  55 #include <asm/4xx_pci.h>
  56 #endif
  57
  58 #ifdef DEBUG
  59 #define USB_DEBUG
  60 #define USB_HUB_DEBUG
  61 #endif
  62
  63 #ifdef  USB_DEBUG
  64 #define USB_PRINTF(fmt, args...)        printf(fmt , ##args)
  65 #else
  66 #define USB_PRINTF(fmt, args...)
  67 #endif
  68
  69 #define USB_BUFSIZ      512
  70
  71 static struct usb_device usb_dev[USB_MAX_DEVICE];
  72 static int dev_index;
  73 static int running;
  74 static int asynch_allowed;
  75 static struct devrequest setup_packet;
  76
  77 char usb_started; /* flag for the started/stopped USB status */
  78
  79 /**********************************************************************
  80  * some forward declerations...
  81  */
  82 void usb_scan_devices(void);
  83
  84 int usb_hub_probe(struct usb_device *dev, int ifnum);
  85 void usb_hub_reset(void);
  86 static int hub_port_reset(struct usb_device *dev, int port,
  87                           unsigned short *portstat);
  88
  89 /***********************************************************************
  90  * wait_ms
  91  */
  92
  93 inline void wait_ms(unsigned long ms)
  94 {
  95         while (ms-- > 0)
  96                 udelay(1000);
  97 }
  98
  99 /***************************************************************************
 100  * Init USB Device
 101  */
 102
 103 int usb_init(void)
 104 {
 105         int result;
 106
 107         running = 0;
 108         dev_index = 0;
 109         asynch_allowed = 1;
 110         usb_hub_reset();
 111         /* init low_level USB */
 112         printf("USB:   ");
 113         result = usb_lowlevel_init();
 114         /* if lowlevel init is OK, scan the bus for devices
 115          * i.e. search HUBs and configure them */
 116         if (result == 0) {
 117                 printf("scanning bus for devices... ");
 118                 running = 1;
 119                 usb_scan_devices();
 120                 usb_started = 1;
 121                 return 0;
 122         } else {
 123                 printf("Error, couldn't init Lowlevel part\n");
 124                 usb_started = 0;
 125                 return -1;
 126         }
 127 }
 128
 129 /******************************************************************************
 130  * Stop USB this stops the LowLevel Part and deregisters USB devices.
 131  */
 132 int usb_stop(void)
 133 {
 134         int res = 0;
 135
 136         if (usb_started) {
 137                 asynch_allowed = 1;
 138                 usb_started = 0;
 139                 usb_hub_reset();
 140                 res = usb_lowlevel_stop();
 141         }
 142         return res;
 143 }
 144
 145 /*
 146  * disables the asynch behaviour of the control message. This is used for data
 147  * transfers that uses the exclusiv access to the control and bulk messages.
 148  * Returns the old value so it can be restored later.
 149  */
 150 int usb_disable_asynch(int disable)
 151 {
 152         int old_value = asynch_allowed;
 153
 154         asynch_allowed = !disable;
 155         return old_value;
 156 }
 157
 158
 159 /*-------------------------------------------------------------------
 160  * Message wrappers.
 161  *
 162  */
 163
 164 /*
 165  * submits an Interrupt Message
 166  */
 167 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
 168                         void *buffer, int transfer_len, int interval)
 169 {
 170         return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
 171 }
 172
 173 /*
 174  * submits a control message and waits for comletion (at least timeout * 1ms)
 175  * If timeout is 0, we don't wait for completion (used as example to set and
 176  * clear keyboards LEDs). For data transfers, (storage transfers) we don't
 177  * allow control messages with 0 timeout, by previousely resetting the flag
 178  * asynch_allowed (usb_disable_asynch(1)).
 179  * returns the transfered length if OK or -1 if error. The transfered length
 180  * and the current status are stored in the dev->act_len and dev->status.
 181  */
 182 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 183                         unsigned char request, unsigned char requesttype,
 184                         unsigned short value, unsigned short index,
 185                         void *data, unsigned short size, int timeout)
 186 {
 187         if ((timeout == 0) && (!asynch_allowed)) {
 188                 /* request for a asynch control pipe is not allowed */
 189                 return -1;
 190         }
 191
 192         /* set setup command */
 193         setup_packet.requesttype = requesttype;
 194         setup_packet.request = request;
 195         setup_packet.value = cpu_to_le16(value);
 196         setup_packet.index = cpu_to_le16(index);
 197         setup_packet.length = cpu_to_le16(size);
 198         USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
 199                    "value 0x%X index 0x%X length 0x%X\n",
 200                    request, requesttype, value, index, size);
 201         dev->status = USB_ST_NOT_PROC; /*not yet processed */
 202
 203         submit_control_msg(dev, pipe, data, size, &setup_packet);
 204         if (timeout == 0)
 205                 return (int)size;
 206
 207         /*
 208          * Wait for status to update until timeout expires, USB driver
 209          * interrupt handler may set the status when the USB operation has
 210          * been completed.
 211          */
 212         while (timeout--) {
 213                 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
 214                         break;
 215                 wait_ms(1);
 216         }
 217         if (dev->status)
 218                 return -1;
 219
 220         return dev->act_len;
 221
 222 }
 223
 224 /*-------------------------------------------------------------------
 225  * submits bulk message, and waits for completion. returns 0 if Ok or
 226  * -1 if Error.
 227  * synchronous behavior
 228  */
 229 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
 230                         void *data, int len, int *actual_length, int timeout)
 231 {
 232         if (len < 0)
 233                 return -1;
 234         dev->status = USB_ST_NOT_PROC; /*not yet processed */
 235         submit_bulk_msg(dev, pipe, data, len);
 236         while (timeout--) {
 237                 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
 238                         break;
 239                 wait_ms(1);
 240         }
 241         *actual_length = dev->act_len;
 242         if (dev->status == 0)
 243                 return 0;
 244         else
 245                 return -1;
 246 }
 247
 248
 249 /*-------------------------------------------------------------------
 250  * Max Packet stuff
 251  */
 252
 253 /*
 254  * returns the max packet size, depending on the pipe direction and
 255  * the configurations values
 256  */
 257 int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
 258 {
 259         /* direction is out -> use emaxpacket out */
 260         if ((pipe & USB_DIR_IN) == 0)
 261                 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
 262         else
 263                 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
 264 }
 265
 266 /* The routine usb_set_maxpacket_ep() is extracted from the loop of routine
 267  * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
 268  * when it is inlined in 1 single routine. What happens is that the register r3
 269  * is used as loop-count 'i', but gets overwritten later on.
 270  * This is clearly a compiler bug, but it is easier to workaround it here than
 271  * to update the compiler (Occurs with at least several GCC 4.{1,2},x
 272  * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
 273  */
 274 static void  __attribute__((noinline))
 275 usb_set_maxpacket_ep(struct usb_device *dev, struct usb_endpoint_descriptor *ep)
 276 {
 277         int b;
 278
 279         b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 280
 281         if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 282                                                 USB_ENDPOINT_XFER_CONTROL) {
 283                 /* Control => bidirectional */
 284                 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
 285                 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
 286                 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",
 287                            b, dev->epmaxpacketin[b]);
 288         } else {
 289                 if ((ep->bEndpointAddress & 0x80) == 0) {
 290                         /* OUT Endpoint */
 291                         if (ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
 292                                 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
 293                                 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",
 294                                            b, dev->epmaxpacketout[b]);
 295                         }
 296                 } else {
 297                         /* IN Endpoint */
 298                         if (ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
 299                                 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
 300                                 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",
 301                                            b, dev->epmaxpacketin[b]);
 302                         }
 303                 } /* if out */
 304         } /* if control */
 305 }
 306
 307 /*
 308  * set the max packed value of all endpoints in the given configuration
 309  */
 310 int usb_set_maxpacket(struct usb_device *dev)
 311 {
 312         int i, ii;
 313
 314         for (i = 0; i < dev->config.desc.bNumInterfaces; i++)
 315                 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++)
 316                         usb_set_maxpacket_ep(dev,
 317                                           &dev->config.if_desc[i].ep_desc[ii]);
 318
 319         return 0;
 320 }
 321
 322 /*******************************************************************************
 323  * Parse the config, located in buffer, and fills the dev->config structure.
 324  * Note that all little/big endian swapping are done automatically.
 325  */
 326 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
 327 {
 328         struct usb_descriptor_header *head;
 329         int index, ifno, epno, curr_if_num;
 330         int i;
 331         unsigned char *ch;
 332
 333         ifno = -1;
 334         epno = -1;
 335         curr_if_num = -1;
 336
 337         dev->configno = cfgno;
 338         head = (struct usb_descriptor_header *) &buffer[0];
 339         if (head->bDescriptorType != USB_DT_CONFIG) {
 340                 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
 341                         head->bDescriptorType);
 342                 return -1;
 343         }
 344         memcpy(&dev->config, buffer, buffer[0]);
 345         le16_to_cpus(&(dev->config.desc.wTotalLength));
 346         dev->config.no_of_if = 0;
 347
 348         index = dev->config.desc.bLength;
 349         /* Ok the first entry must be a configuration entry,
 350          * now process the others */
 351         head = (struct usb_descriptor_header *) &buffer[index];
 352         while (index + 1 < dev->config.desc.wTotalLength) {
 353                 switch (head->bDescriptorType) {
 354                 case USB_DT_INTERFACE:
 355                         if (((struct usb_interface_descriptor *) \
 356                              &buffer[index])->bInterfaceNumber != curr_if_num) {
 357                                 /* this is a new interface, copy new desc */
 358                                 ifno = dev->config.no_of_if;
 359                                 dev->config.no_of_if++;
 360                                 memcpy(&dev->config.if_desc[ifno],
 361                                         &buffer[index], buffer[index]);
 362                                 dev->config.if_desc[ifno].no_of_ep = 0;
 363                                 dev->config.if_desc[ifno].num_altsetting = 1;
 364                                 curr_if_num =
 365                                      dev->config.if_desc[ifno].desc.bInterfaceNumber;
 366                         } else {
 367                                 /* found alternate setting for the interface */
 368                                 dev->config.if_desc[ifno].num_altsetting++;
 369                         }
 370                         break;
 371                 case USB_DT_ENDPOINT:
 372                         epno = dev->config.if_desc[ifno].no_of_ep;
 373                         /* found an endpoint */
 374                         dev->config.if_desc[ifno].no_of_ep++;
 375                         memcpy(&dev->config.if_desc[ifno].ep_desc[epno],
 376                                 &buffer[index], buffer[index]);
 377                         le16_to_cpus(&(dev->config.if_desc[ifno].ep_desc[epno].\
 378                                                                wMaxPacketSize));
 379                         USB_PRINTF("if %d, ep %d\n", ifno, epno);
 380                         break;
 381                 default:
 382                         if (head->bLength == 0)
 383                                 return 1;
 384
 385                         USB_PRINTF("unknown Description Type : %x\n",
 386                                    head->bDescriptorType);
 387
 388                         {
 389                                 ch = (unsigned char *)head;
 390                                 for (i = 0; i < head->bLength; i++)
 391                                         USB_PRINTF("%02X ", *ch++);
 392                                 USB_PRINTF("\n\n\n");
 393                         }
 394                         break;
 395                 }
 396                 index += head->bLength;
 397                 head = (struct usb_descriptor_header *)&buffer[index];
 398         }
 399         return 1;
 400 }
 401
 402 /***********************************************************************
 403  * Clears an endpoint
 404  * endp: endpoint number in bits 0-3;
 405  * direction flag in bit 7 (1 = IN, 0 = OUT)
 406  */
 407 int usb_clear_halt(struct usb_device *dev, int pipe)
 408 {
 409         int result;
 410         int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
 411
 412         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 413                                  USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
 414                                  endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
 415
 416         /* don't clear if failed */
 417         if (result < 0)
 418                 return result;
 419
 420         /*
 421          * NOTE: we do not get status and verify reset was successful
 422          * as some devices are reported to lock up upon this check..
 423          */
 424
 425         usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
 426
 427         /* toggle is reset on clear */
 428         usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
 429         return 0;
 430 }
 431
 432
 433 /**********************************************************************
 434  * get_descriptor type
 435  */
 436 int usb_get_descriptor(struct usb_device *dev, unsigned char type,
 437                         unsigned char index, void *buf, int size)
 438 {
 439         int res;
 440         res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 441                         USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
 442                         (type << 8) + index, 0,
 443                         buf, size, USB_CNTL_TIMEOUT);
 444         return res;
 445 }
 446
 447 /**********************************************************************
 448  * gets configuration cfgno and store it in the buffer
 449  */
 450 int usb_get_configuration_no(struct usb_device *dev,
 451                              unsigned char *buffer, int cfgno)
 452 {
 453         int result;
 454         unsigned int tmp;
 455         struct usb_configuration_descriptor *config;
 456
 457         config = (struct usb_configuration_descriptor *)&buffer[0];
 458         result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
 459         if (result < 9) {
 460                 if (result < 0)
 461                         printf("unable to get descriptor, error %lX\n",
 462                                 dev->status);
 463                 else
 464                         printf("config descriptor too short " \
 465                                 "(expected %i, got %i)\n", 9, result);
 466                 return -1;
 467         }
 468         tmp = le16_to_cpu(config->wTotalLength);
 469
 470         if (tmp > USB_BUFSIZ) {
 471                 USB_PRINTF("usb_get_configuration_no: failed to get " \
 472                            "descriptor - too long: %d\n", tmp);
 473                 return -1;
 474         }
 475
 476         result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
 477         USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",
 478                    cfgno, result, tmp);
 479         return result;
 480 }
 481
 482 /********************************************************************
 483  * set address of a device to the value in dev->devnum.
 484  * This can only be done by addressing the device via the default address (0)
 485  */
 486 int usb_set_address(struct usb_device *dev)
 487 {
 488         int res;
 489
 490         USB_PRINTF("set address %d\n", dev->devnum);
 491         res = usb_control_msg(dev, usb_snddefctrl(dev),
 492                                 USB_REQ_SET_ADDRESS, 0,
 493                                 (dev->devnum), 0,
 494                                 NULL, 0, USB_CNTL_TIMEOUT);
 495         return res;
 496 }
 497
 498 /********************************************************************
 499  * set interface number to interface
 500  */
 501 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
 502 {
 503         struct usb_interface *if_face = NULL;
 504         int ret, i;
 505
 506         for (i = 0; i < dev->config.desc.bNumInterfaces; i++) {
 507                 if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) {
 508                         if_face = &dev->config.if_desc[i];
 509                         break;
 510                 }
 511         }
 512         if (!if_face) {
 513                 printf("selecting invalid interface %d", interface);
 514                 return -1;
 515         }
 516         /*
 517          * We should return now for devices with only one alternate setting.
 518          * According to 9.4.10 of the Universal Serial Bus Specification
 519          * Revision 2.0 such devices can return with a STALL. This results in
 520          * some USB sticks timeouting during initialization and then being
 521          * unusable in U-Boot.
 522          */
 523         if (if_face->num_altsetting == 1)
 524                 return 0;
 525
 526         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 527                                 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
 528                                 alternate, interface, NULL, 0,
 529                                 USB_CNTL_TIMEOUT * 5);
 530         if (ret < 0)
 531                 return ret;
 532
 533         return 0;
 534 }
 535
 536 /********************************************************************
 537  * set configuration number to configuration
 538  */
 539 int usb_set_configuration(struct usb_device *dev, int configuration)
 540 {
 541         int res;
 542         USB_PRINTF("set configuration %d\n", configuration);
 543         /* set setup command */
 544         res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 545                                 USB_REQ_SET_CONFIGURATION, 0,
 546                                 configuration, 0,
 547                                 NULL, 0, USB_CNTL_TIMEOUT);
 548         if (res == 0) {
 549                 dev->toggle[0] = 0;
 550                 dev->toggle[1] = 0;
 551                 return 0;
 552         } else
 553                 return -1;
 554 }
 555
 556 /********************************************************************
 557  * set protocol to protocol
 558  */
 559 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
 560 {
 561         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 562                 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 563                 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
 564 }
 565
 566 /********************************************************************
 567  * set idle
 568  */
 569 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
 570 {
 571         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 572                 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 573                 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
 574 }
 575
 576 /********************************************************************
 577  * get report
 578  */
 579 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 580                    unsigned char id, void *buf, int size)
 581 {
 582         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 583                         USB_REQ_GET_REPORT,
 584                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 585                         (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
 586 }
 587
 588 /********************************************************************
 589  * get class descriptor
 590  */
 591 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
 592                 unsigned char type, unsigned char id, void *buf, int size)
 593 {
 594         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 595                 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
 596                 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
 597 }
 598
 599 /********************************************************************
 600  * get string index in buffer
 601  */
 602 int usb_get_string(struct usb_device *dev, unsigned short langid,
 603                    unsigned char index, void *buf, int size)
 604 {
 605         int i;
 606         int result;
 607
 608         for (i = 0; i < 3; ++i) {
 609                 /* some devices are flaky */
 610                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 611                         USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
 612                         (USB_DT_STRING << 8) + index, langid, buf, size,
 613                         USB_CNTL_TIMEOUT);
 614
 615                 if (result > 0)
 616                         break;
 617         }
 618
 619         return result;
 620 }
 621
 622
 623 static void usb_try_string_workarounds(unsigned char *buf, int *length)
 624 {
 625         int newlength, oldlength = *length;
 626
 627         for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
 628                 if (!isprint(buf[newlength]) || buf[newlength + 1])
 629                         break;
 630
 631         if (newlength > 2) {
 632                 buf[0] = newlength;
 633                 *length = newlength;
 634         }
 635 }
 636
 637
 638 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
 639                 unsigned int index, unsigned char *buf)
 640 {
 641         int rc;
 642
 643         /* Try to read the string descriptor by asking for the maximum
 644          * possible number of bytes */
 645         rc = usb_get_string(dev, langid, index, buf, 255);
 646
 647         /* If that failed try to read the descriptor length, then
 648          * ask for just that many bytes */
 649         if (rc < 2) {
 650                 rc = usb_get_string(dev, langid, index, buf, 2);
 651                 if (rc == 2)
 652                         rc = usb_get_string(dev, langid, index, buf, buf[0]);
 653         }
 654
 655         if (rc >= 2) {
 656                 if (!buf[0] && !buf[1])
 657                         usb_try_string_workarounds(buf, &rc);
 658
 659                 /* There might be extra junk at the end of the descriptor */
 660                 if (buf[0] < rc)
 661                         rc = buf[0];
 662
 663                 rc = rc - (rc & 1); /* force a multiple of two */
 664         }
 665
 666         if (rc < 2)
 667                 rc = -1;
 668
 669         return rc;
 670 }
 671
 672
 673 /********************************************************************
 674  * usb_string:
 675  * Get string index and translate it to ascii.
 676  * returns string length (> 0) or error (< 0)
 677  */
 678 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
 679 {
 680         unsigned char mybuf[USB_BUFSIZ];
 681         unsigned char *tbuf;
 682         int err;
 683         unsigned int u, idx;
 684
 685         if (size <= 0 || !buf || !index)
 686                 return -1;
 687         buf[0] = 0;
 688         tbuf = &mybuf[0];
 689
 690         /* get langid for strings if it's not yet known */
 691         if (!dev->have_langid) {
 692                 err = usb_string_sub(dev, 0, 0, tbuf);
 693                 if (err < 0) {
 694                         USB_PRINTF("error getting string descriptor 0 " \
 695                                    "(error=%lx)\n", dev->status);
 696                         return -1;
 697                 } else if (tbuf[0] < 4) {
 698                         USB_PRINTF("string descriptor 0 too short\n");
 699                         return -1;
 700                 } else {
 701                         dev->have_langid = -1;
 702                         dev->string_langid = tbuf[2] | (tbuf[3] << 8);
 703                                 /* always use the first langid listed */
 704                         USB_PRINTF("USB device number %d default " \
 705                                    "language ID 0x%x\n",
 706                                    dev->devnum, dev->string_langid);
 707                 }
 708         }
 709
 710         err = usb_string_sub(dev, dev->string_langid, index, tbuf);
 711         if (err < 0)
 712                 return err;
 713
 714         size--;         /* leave room for trailing NULL char in output buffer */
 715         for (idx = 0, u = 2; u < err; u += 2) {
 716                 if (idx >= size)
 717                         break;
 718                 if (tbuf[u+1])                  /* high byte */
 719                         buf[idx++] = '?';  /* non-ASCII character */
 720                 else
 721                         buf[idx++] = tbuf[u];
 722         }
 723         buf[idx] = 0;
 724         err = idx;
 725         return err;
 726 }
 727
 728
 729 /********************************************************************
 730  * USB device handling:
 731  * the USB device are static allocated [USB_MAX_DEVICE].
 732  */
 733
 734
 735 /* returns a pointer to the device with the index [index].
 736  * if the device is not assigned (dev->devnum==-1) returns NULL
 737  */
 738 struct usb_device *usb_get_dev_index(int index)
 739 {
 740         if (usb_dev[index].devnum == -1)
 741                 return NULL;
 742         else
 743                 return &usb_dev[index];
 744 }
 745
 746
 747 /* returns a pointer of a new device structure or NULL, if
 748  * no device struct is available
 749  */
 750 struct usb_device *usb_alloc_new_device(void)
 751 {
 752         int i;
 753         USB_PRINTF("New Device %d\n", dev_index);
 754         if (dev_index == USB_MAX_DEVICE) {
 755                 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
 756                 return NULL;
 757         }
 758         /* default Address is 0, real addresses start with 1 */
 759         usb_dev[dev_index].devnum = dev_index + 1;
 760         usb_dev[dev_index].maxchild = 0;
 761         for (i = 0; i < USB_MAXCHILDREN; i++)
 762                 usb_dev[dev_index].children[i] = NULL;
 763         usb_dev[dev_index].parent = NULL;
 764         dev_index++;
 765         return &usb_dev[dev_index - 1];
 766 }
 767
 768
 769 /*
 770  * By the time we get here, the device has gotten a new device ID
 771  * and is in the default state. We need to identify the thing and
 772  * get the ball rolling..
 773  *
 774  * Returns 0 for success, != 0 for error.
 775  */
 776 int usb_new_device(struct usb_device *dev)
 777 {
 778         int addr, err;
 779         int tmp;
 780         unsigned char tmpbuf[USB_BUFSIZ];
 781
 782         /* We still haven't set the Address yet */
 783         addr = dev->devnum;
 784         dev->devnum = 0;
 785
 786 #ifdef CONFIG_LEGACY_USB_INIT_SEQ
 787         /* this is the old and known way of initializing devices, it is
 788          * different than what Windows and Linux are doing. Windows and Linux
 789          * both retrieve 64 bytes while reading the device descriptor
 790          * Several USB stick devices report ERR: CTL_TIMEOUT, caused by an
 791          * invalid header while reading 8 bytes as device descriptor. */
 792         dev->descriptor.bMaxPacketSize0 = 8;        /* Start off at 8 bytes  */
 793         dev->maxpacketsize = PACKET_SIZE_8;
 794         dev->epmaxpacketin[0] = 8;
 795         dev->epmaxpacketout[0] = 8;
 796
 797         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
 798         if (err < 8) {
 799                 printf("\n      USB device not responding, " \
 800                        "giving up (status=%lX)\n", dev->status);
 801                 return 1;
 802         }
 803 #else
 804         /* This is a Windows scheme of initialization sequence, with double
 805          * reset of the device (Linux uses the same sequence)
 806          * Some equipment is said to work only with such init sequence; this
 807          * patch is based on the work by Alan Stern:
 808          * http://sourceforge.net/mailarchive/forum.php?
 809          * thread_id=5729457&forum_id=5398
 810          */
 811         struct usb_device_descriptor *desc;
 812         int port = -1;
 813         struct usb_device *parent = dev->parent;
 814         unsigned short portstatus;
 815
 816         /* send 64-byte GET-DEVICE-DESCRIPTOR request.  Since the descriptor is
 817          * only 18 bytes long, this will terminate with a short packet.  But if
 818          * the maxpacket size is 8 or 16 the device may be waiting to transmit
 819          * some more, or keeps on retransmitting the 8 byte header. */
 820
 821         desc = (struct usb_device_descriptor *)tmpbuf;
 822         dev->descriptor.bMaxPacketSize0 = 64;       /* Start off at 64 bytes  */
 823         /* Default to 64 byte max packet size */
 824         dev->maxpacketsize = PACKET_SIZE_64;
 825         dev->epmaxpacketin[0] = 64;
 826         dev->epmaxpacketout[0] = 64;
 827
 828         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
 829         if (err < 0) {
 830                 USB_PRINTF("usb_new_device: usb_get_descriptor() failed\n");
 831                 return 1;
 832         }
 833
 834         dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
 835
 836         /* find the port number we're at */
 837         if (parent) {
 838                 int j;
 839
 840                 for (j = 0; j < parent->maxchild; j++) {
 841                         if (parent->children[j] == dev) {
 842                                 port = j;
 843                                 break;
 844                         }
 845                 }
 846                 if (port < 0) {
 847                         printf("usb_new_device:cannot locate device's port.\n");
 848                         return 1;
 849                 }
 850
 851                 /* reset the port for the second time */
 852                 err = hub_port_reset(dev->parent, port, &portstatus);
 853                 if (err < 0) {
 854                         printf("\n     Couldn't reset port %i\n", port);
 855                         return 1;
 856                 }
 857         }
 858 #endif
 859
 860         dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
 861         dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
 862         switch (dev->descriptor.bMaxPacketSize0) {
 863         case 8:
 864                 dev->maxpacketsize  = PACKET_SIZE_8;
 865                 break;
 866         case 16:
 867                 dev->maxpacketsize = PACKET_SIZE_16;
 868                 break;
 869         case 32:
 870                 dev->maxpacketsize = PACKET_SIZE_32;
 871                 break;
 872         case 64:
 873                 dev->maxpacketsize = PACKET_SIZE_64;
 874                 break;
 875         }
 876         dev->devnum = addr;
 877
 878         err = usb_set_address(dev); /* set address */
 879
 880         if (err < 0) {
 881                 printf("\n      USB device not accepting new address " \
 882                         "(error=%lX)\n", dev->status);
 883                 return 1;
 884         }
 885
 886         wait_ms(10);    /* Let the SET_ADDRESS settle */
 887
 888         tmp = sizeof(dev->descriptor);
 889
 890         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
 891                                  &dev->descriptor, sizeof(dev->descriptor));
 892         if (err < tmp) {
 893                 if (err < 0)
 894                         printf("unable to get device descriptor (error=%d)\n",
 895                                err);
 896                 else
 897                         printf("USB device descriptor short read " \
 898                                 "(expected %i, got %i)\n", tmp, err);
 899                 return 1;
 900         }
 901         /* correct le values */
 902         le16_to_cpus(&dev->descriptor.bcdUSB);
 903         le16_to_cpus(&dev->descriptor.idVendor);
 904         le16_to_cpus(&dev->descriptor.idProduct);
 905         le16_to_cpus(&dev->descriptor.bcdDevice);
 906         /* only support for one config for now */
 907         usb_get_configuration_no(dev, &tmpbuf[0], 0);
 908         usb_parse_config(dev, &tmpbuf[0], 0);
 909         usb_set_maxpacket(dev);
 910         /* we set the default configuration here */
 911         if (usb_set_configuration(dev, dev->config.desc.bConfigurationValue)) {
 912                 printf("failed to set default configuration " \
 913                         "len %d, status %lX\n", dev->act_len, dev->status);
 914                 return -1;
 915         }
 916         USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
 917                    dev->descriptor.iManufacturer, dev->descriptor.iProduct,
 918                    dev->descriptor.iSerialNumber);
 919         memset(dev->mf, 0, sizeof(dev->mf));
 920         memset(dev->prod, 0, sizeof(dev->prod));
 921         memset(dev->serial, 0, sizeof(dev->serial));
 922         if (dev->descriptor.iManufacturer)
 923                 usb_string(dev, dev->descriptor.iManufacturer,
 924                            dev->mf, sizeof(dev->mf));
 925         if (dev->descriptor.iProduct)
 926                 usb_string(dev, dev->descriptor.iProduct,
 927                            dev->prod, sizeof(dev->prod));
 928         if (dev->descriptor.iSerialNumber)
 929                 usb_string(dev, dev->descriptor.iSerialNumber,
 930                            dev->serial, sizeof(dev->serial));
 931         USB_PRINTF("Manufacturer %s\n", dev->mf);
 932         USB_PRINTF("Product      %s\n", dev->prod);
 933         USB_PRINTF("SerialNumber %s\n", dev->serial);
 934         /* now prode if the device is a hub */
 935         usb_hub_probe(dev, 0);
 936         return 0;
 937 }
 938
 939 /* build device Tree  */
 940 void usb_scan_devices(void)
 941 {
 942         int i;
 943         struct usb_device *dev;
 944
 945         /* first make all devices unknown */
 946         for (i = 0; i < USB_MAX_DEVICE; i++) {
 947                 memset(&usb_dev[i], 0, sizeof(struct usb_device));
 948                 usb_dev[i].devnum = -1;
 949         }
 950         dev_index = 0;
 951         /* device 0 is always present (root hub, so let it analyze) */
 952         dev = usb_alloc_new_device();
 953         if (usb_new_device(dev))
 954                 printf("No USB Device found\n");
 955         else
 956                 printf("%d USB Device(s) found\n", dev_index);
 957         /* insert "driver" if possible */
 958 #ifdef CONFIG_USB_KEYBOARD
 959         drv_usb_kbd_init();
 960 #endif
 961         USB_PRINTF("scan end\n");
 962 }
 963
 964
 965 /****************************************************************************
 966  * HUB "Driver"
 967  * Probes device for being a hub and configurate it
 968  */
 969
 970 #ifdef  USB_HUB_DEBUG
 971 #define USB_HUB_PRINTF(fmt, args...)    printf(fmt , ##args)
 972 #else
 973 #define USB_HUB_PRINTF(fmt, args...)
 974 #endif
 975
 976
 977 static struct usb_hub_device hub_dev[USB_MAX_HUB];
 978 static int usb_hub_index;
 979
 980
 981 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
 982 {
 983         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 984                 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
 985                 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
 986 }
 987
 988 int usb_clear_hub_feature(struct usb_device *dev, int feature)
 989 {
 990         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 991                                 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature,
 992                                 0, NULL, 0, USB_CNTL_TIMEOUT);
 993 }
 994
 995 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
 996 {
 997         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 998                                 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
 999                                 port, NULL, 0, USB_CNTL_TIMEOUT);
1000 }
1001
1002 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
1003 {
1004         return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1005                                 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
1006                                 port, NULL, 0, USB_CNTL_TIMEOUT);
1007 }
1008
1009 int usb_get_hub_status(struct usb_device *dev, void *data)
1010 {
1011         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1012                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
1013                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
1014 }
1015
1016 int usb_get_port_status(struct usb_device *dev, int port, void *data)
1017 {
1018         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
1019                         USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
1020                         data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
1021 }
1022
1023
1024 static void usb_hub_power_on(struct usb_hub_device *hub)
1025 {
1026         int i;
1027         struct usb_device *dev;
1028
1029         dev = hub->pusb_dev;
1030         /* Enable power to the ports */
1031         USB_HUB_PRINTF("enabling power on all ports\n");
1032         for (i = 0; i < dev->maxchild; i++) {
1033                 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
1034                 USB_HUB_PRINTF("port %d returns %lX\n", i + 1, dev->status);
1035                 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
1036         }
1037 }
1038
1039 void usb_hub_reset(void)
1040 {
1041         usb_hub_index = 0;
1042 }
1043
1044 struct usb_hub_device *usb_hub_allocate(void)
1045 {
1046         if (usb_hub_index < USB_MAX_HUB)
1047                 return &hub_dev[usb_hub_index++];
1048
1049         printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
1050         return NULL;
1051 }
1052
1053 #define MAX_TRIES 5
1054
1055 static inline char *portspeed(int portstatus)
1056 {
1057         if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
1058                 return "480 Mb/s";
1059         else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
1060                 return "1.5 Mb/s";
1061         else
1062                 return "12 Mb/s";
1063 }
1064
1065 static int hub_port_reset(struct usb_device *dev, int port,
1066                         unsigned short *portstat)
1067 {
1068         int tries;
1069         struct usb_port_status portsts;
1070         unsigned short portstatus, portchange;
1071
1072         USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
1073         for (tries = 0; tries < MAX_TRIES; tries++) {
1074
1075                 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
1076                 wait_ms(200);
1077
1078                 if (usb_get_port_status(dev, port + 1, &portsts) < 0) {
1079                         USB_HUB_PRINTF("get_port_status failed status %lX\n",
1080                                         dev->status);
1081                         return -1;
1082                 }
1083                 portstatus = le16_to_cpu(portsts.wPortStatus);
1084                 portchange = le16_to_cpu(portsts.wPortChange);
1085
1086                 USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
1087                                 portstatus, portchange,
1088                                 portspeed(portstatus));
1089
1090                 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
1091                                "  USB_PORT_STAT_ENABLE %d\n",
1092                         (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
1093                         (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
1094                         (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
1095
1096                 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
1097                     !(portstatus & USB_PORT_STAT_CONNECTION))
1098                         return -1;
1099
1100                 if (portstatus & USB_PORT_STAT_ENABLE)
1101                         break;
1102
1103                 wait_ms(200);
1104         }
1105
1106         if (tries == MAX_TRIES) {
1107                 USB_HUB_PRINTF("Cannot enable port %i after %i retries, " \
1108                                 "disabling port.\n", port + 1, MAX_TRIES);
1109                 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
1110                 return -1;
1111         }
1112
1113         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
1114         *portstat = portstatus;
1115         return 0;
1116 }
1117
1118
1119 void usb_hub_port_connect_change(struct usb_device *dev, int port)
1120 {
1121         struct usb_device *usb;
1122         struct usb_port_status portsts;
1123         unsigned short portstatus, portchange;
1124
1125         /* Check status */
1126         if (usb_get_port_status(dev, port + 1, &portsts) < 0) {
1127                 USB_HUB_PRINTF("get_port_status failed\n");
1128                 return;
1129         }
1130
1131         portstatus = le16_to_cpu(portsts.wPortStatus);
1132         portchange = le16_to_cpu(portsts.wPortChange);
1133         USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
1134                         portstatus, portchange, portspeed(portstatus));
1135
1136         /* Clear the connection change status */
1137         usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
1138
1139         /* Disconnect any existing devices under this port */
1140         if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
1141              (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
1142                 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
1143                 /* Return now if nothing is connected */
1144                 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1145                         return;
1146         }
1147         wait_ms(200);
1148
1149         /* Reset the port */
1150         if (hub_port_reset(dev, port, &portstatus) < 0) {
1151                 printf("cannot reset port %i!?\n", port + 1);
1152                 return;
1153         }
1154
1155         wait_ms(200);
1156
1157         /* Allocate a new device struct for it */
1158         usb = usb_alloc_new_device();
1159
1160         if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1161                 usb->speed = USB_SPEED_HIGH;
1162         else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1163                 usb->speed = USB_SPEED_LOW;
1164         else
1165                 usb->speed = USB_SPEED_FULL;
1166
1167         dev->children[port] = usb;
1168         usb->parent = dev;
1169         usb->portnr = port + 1;
1170         /* Run it through the hoops (find a driver, etc) */
1171         if (usb_new_device(usb)) {
1172                 /* Woops, disable the port */
1173                 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
1174                 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
1175         }
1176 }
1177
1178
1179 int usb_hub_configure(struct usb_device *dev)
1180 {
1181         unsigned char buffer[USB_BUFSIZ], *bitmap;
1182         struct usb_hub_descriptor *descriptor;
1183         struct usb_hub_status *hubsts;
1184         int i;
1185         struct usb_hub_device *hub;
1186
1187         /* "allocate" Hub device */
1188         hub = usb_hub_allocate();
1189         if (hub == NULL)
1190                 return -1;
1191         hub->pusb_dev = dev;
1192         /* Get the the hub descriptor */
1193         if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
1194                 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1195                                    "descriptor, giving up %lX\n", dev->status);
1196                 return -1;
1197         }
1198         descriptor = (struct usb_hub_descriptor *)buffer;
1199
1200         /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
1201         i = descriptor->bLength;
1202         if (i > USB_BUFSIZ) {
1203                 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1204                                 "descriptor - too long: %d\n",
1205                                 descriptor->bLength);
1206                 return -1;
1207         }
1208
1209         if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
1210                 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1211                                 "descriptor 2nd giving up %lX\n", dev->status);
1212                 return -1;
1213         }
1214         memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
1215         /* adjust 16bit values */
1216         hub->desc.wHubCharacteristics =
1217                                 le16_to_cpu(descriptor->wHubCharacteristics);
1218         /* set the bitmap */
1219         bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
1220         /* devices not removable by default */
1221         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
1222         bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
1223         memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
1224
1225         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
1226                 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
1227
1228         for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
1229                 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
1230
1231         dev->maxchild = descriptor->bNbrPorts;
1232         USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
1233
1234         switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
1235         case 0x00:
1236                 USB_HUB_PRINTF("ganged power switching\n");
1237                 break;
1238         case 0x01:
1239                 USB_HUB_PRINTF("individual port power switching\n");
1240                 break;
1241         case 0x02:
1242         case 0x03:
1243                 USB_HUB_PRINTF("unknown reserved power switching mode\n");
1244                 break;
1245         }
1246
1247         if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
1248                 USB_HUB_PRINTF("part of a compound device\n");
1249         else
1250                 USB_HUB_PRINTF("standalone hub\n");
1251
1252         switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
1253         case 0x00:
1254                 USB_HUB_PRINTF("global over-current protection\n");
1255                 break;
1256         case 0x08:
1257                 USB_HUB_PRINTF("individual port over-current protection\n");
1258                 break;
1259         case 0x10:
1260         case 0x18:
1261                 USB_HUB_PRINTF("no over-current protection\n");
1262                 break;
1263         }
1264
1265         USB_HUB_PRINTF("power on to power good time: %dms\n",
1266                         descriptor->bPwrOn2PwrGood * 2);
1267         USB_HUB_PRINTF("hub controller current requirement: %dmA\n",
1268                         descriptor->bHubContrCurrent);
1269
1270         for (i = 0; i < dev->maxchild; i++)
1271                 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
1272                         hub->desc.DeviceRemovable[(i + 1) / 8] & \
1273                                            (1 << ((i + 1) % 8)) ? " not" : "");
1274
1275         if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
1276                 USB_HUB_PRINTF("usb_hub_configure: failed to get Status - " \
1277                                 "too long: %d\n", descriptor->bLength);
1278                 return -1;
1279         }
1280
1281         if (usb_get_hub_status(dev, buffer) < 0) {
1282                 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",
1283                                 dev->status);
1284                 return -1;
1285         }
1286
1287         hubsts = (struct usb_hub_status *)buffer;
1288         USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
1289                         le16_to_cpu(hubsts->wHubStatus),
1290                         le16_to_cpu(hubsts->wHubChange));
1291         USB_HUB_PRINTF("local power source is %s\n",
1292                 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
1293                 "lost (inactive)" : "good");
1294         USB_HUB_PRINTF("%sover-current condition exists\n",
1295                 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
1296                 "" : "no ");
1297         usb_hub_power_on(hub);
1298
1299         for (i = 0; i < dev->maxchild; i++) {
1300                 struct usb_port_status portsts;
1301                 unsigned short portstatus, portchange;
1302
1303                 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
1304                         USB_HUB_PRINTF("get_port_status failed\n");
1305                         continue;
1306                 }
1307
1308                 portstatus = le16_to_cpu(portsts.wPortStatus);
1309                 portchange = le16_to_cpu(portsts.wPortChange);
1310                 USB_HUB_PRINTF("Port %d Status %X Change %X\n",
1311                                 i + 1, portstatus, portchange);
1312
1313                 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1314                         USB_HUB_PRINTF("port %d connection change\n", i + 1);
1315                         usb_hub_port_connect_change(dev, i);
1316                 }
1317                 if (portchange & USB_PORT_STAT_C_ENABLE) {
1318                         USB_HUB_PRINTF("port %d enable change, status %x\n",
1319                                         i + 1, portstatus);
1320                         usb_clear_port_feature(dev, i + 1,
1321                                                 USB_PORT_FEAT_C_ENABLE);
1322
1323                         /* EM interference sometimes causes bad shielded USB
1324                          * devices to be shutdown by the hub, this hack enables
1325                          * them again. Works at least with mouse driver */
1326                         if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1327                              (portstatus & USB_PORT_STAT_CONNECTION) &&
1328                              ((dev->children[i]))) {
1329                                 USB_HUB_PRINTF("already running port %i "  \
1330                                                 "disabled by hub (EMI?), " \
1331                                                 "re-enabling...\n", i + 1);
1332                                         usb_hub_port_connect_change(dev, i);
1333                         }
1334                 }
1335                 if (portstatus & USB_PORT_STAT_SUSPEND) {
1336                         USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1337                         usb_clear_port_feature(dev, i + 1,
1338                                                 USB_PORT_FEAT_SUSPEND);
1339                 }
1340
1341                 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1342                         USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1343                         usb_clear_port_feature(dev, i + 1,
1344                                                 USB_PORT_FEAT_C_OVER_CURRENT);
1345                         usb_hub_power_on(hub);
1346                 }
1347
1348                 if (portchange & USB_PORT_STAT_C_RESET) {
1349                         USB_HUB_PRINTF("port %d reset change\n", i + 1);
1350                         usb_clear_port_feature(dev, i + 1,
1351                                                 USB_PORT_FEAT_C_RESET);
1352                 }
1353         } /* end for i all ports */
1354
1355         return 0;
1356 }
1357
1358 int usb_hub_probe(struct usb_device *dev, int ifnum)
1359 {
1360         struct usb_interface *iface;
1361         struct usb_endpoint_descriptor *ep;
1362         int ret;
1363
1364         iface = &dev->config.if_desc[ifnum];
1365         /* Is it a hub? */
1366         if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
1367                 return 0;
1368         /* Some hubs have a subclass of 1, which AFAICT according to the */
1369         /*  specs is not defined, but it works */
1370         if ((iface->desc.bInterfaceSubClass != 0) &&
1371             (iface->desc.bInterfaceSubClass != 1))
1372                 return 0;
1373         /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1374         if (iface->desc.bNumEndpoints != 1)
1375                 return 0;
1376         ep = &iface->ep_desc[0];
1377         /* Output endpoint? Curiousier and curiousier.. */
1378         if (!(ep->bEndpointAddress & USB_DIR_IN))
1379                 return 0;
1380         /* If it's not an interrupt endpoint, we'd better punt! */
1381         if ((ep->bmAttributes & 3) != 3)
1382                 return 0;
1383         /* We found a hub */
1384         USB_HUB_PRINTF("USB hub found\n");
1385         ret = usb_hub_configure(dev);
1386         return ret;
1387 }
1388
1389 /* EOF */