common/usb.c

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