git.sur5r.net Git - u-boot/blob - common/usb.c

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