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