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