3 * Most of this source has been derived from the Linux USB
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)
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
18 * See file CREDITS for list of people who contributed to this
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.
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.
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,
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
45 * For each transfer (except "Interrupt") we wait for completion.
49 #include <asm/processor.h>
50 #include <linux/ctype.h>
51 #include <asm/byteorder.h>
55 #include <asm/4xx_pci.h>
61 #define USB_PRINTF(fmt,args...) printf (fmt ,##args)
63 #define USB_PRINTF(fmt,args...)
66 #define USB_BUFSIZ 512
68 static struct usb_device usb_dev[USB_MAX_DEVICE];
71 static int asynch_allowed;
72 static struct devrequest setup_packet;
74 char usb_started; /* flag for the started/stopped USB status */
76 /**********************************************************************
77 * some forward declerations...
79 void usb_scan_devices(void);
81 int usb_hub_probe(struct usb_device *dev, int ifnum);
82 void usb_hub_reset(void);
85 /***********************************************************************
89 void __inline__ wait_ms(unsigned long ms)
94 /***************************************************************************
106 /* init low_level USB */
108 result = usb_lowlevel_init();
109 /* if lowlevel init is OK, scan the bus for devices i.e. search HUBs and configure them */
111 printf("scanning bus for devices... ");
118 printf("Error, couldn't init Lowlevel part\n");
124 /******************************************************************************
125 * Stop USB this stops the LowLevel Part and deregisters USB devices.
135 res = usb_lowlevel_stop();
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.
144 void usb_disable_asynch(int disable)
146 asynch_allowed=!disable;
150 /*-------------------------------------------------------------------
156 * submits an Interrupt Message
158 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
159 void *buffer,int transfer_len, int interval)
161 return submit_int_msg(dev,pipe,buffer,transfer_len,interval);
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.
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)
178 if((timeout==0)&&(!asynch_allowed)) /* request for a asynch control pipe is not allowed */
181 /* set setup command */
182 setup_packet.requesttype = requesttype;
183 setup_packet.request = request;
184 setup_packet.value = cpu_to_le16(value);
185 setup_packet.index = cpu_to_le16(index);
186 setup_packet.length = cpu_to_le16(size);
187 USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X, value 0x%X index 0x%X length 0x%X\n",
188 request,requesttype,value,index,size);
189 dev->status=USB_ST_NOT_PROC; /*not yet processed */
191 submit_control_msg(dev,pipe,data,size,&setup_packet);
196 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
207 /*-------------------------------------------------------------------
208 * submits bulk message, and waits for completion. returns 0 if Ok or
210 * synchronous behavior
212 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
213 void *data, int len, int *actual_length, int timeout)
217 dev->status=USB_ST_NOT_PROC; /*not yet processed */
218 submit_bulk_msg(dev,pipe,data,len);
220 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
224 *actual_length=dev->act_len;
232 /*-------------------------------------------------------------------
237 * returns the max packet size, depending on the pipe direction and
238 * the configurations values
240 int usb_maxpacket(struct usb_device *dev,unsigned long pipe)
242 if((pipe & USB_DIR_IN)==0) /* direction is out -> use emaxpacket out */
243 return(dev->epmaxpacketout[((pipe>>15) & 0xf)]);
245 return(dev->epmaxpacketin[((pipe>>15) & 0xf)]);
249 * set the max packed value of all endpoints in the given configuration
251 int usb_set_maxpacket(struct usb_device *dev)
254 struct usb_endpoint_descriptor *ep;
256 for(i=0; i<dev->config.bNumInterfaces;i++) {
257 for(ii=0; ii<dev->config.if_desc[i].bNumEndpoints; ii++) {
258 ep = &dev->config.if_desc[i].ep_desc[ii];
259 b=ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
261 if((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)==USB_ENDPOINT_XFER_CONTROL) { /* Control => bidirectional */
262 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
263 dev->epmaxpacketin [b] = ep->wMaxPacketSize;
264 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",b,dev->epmaxpacketin[b]);
267 if ((ep->bEndpointAddress & 0x80)==0) { /* OUT Endpoint */
268 if(ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
269 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
270 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",b,dev->epmaxpacketout[b]);
273 else { /* IN Endpoint */
274 if(ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
275 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
276 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",b,dev->epmaxpacketin[b]);
280 } /* for each endpoint */
285 /*******************************************************************************
286 * Parse the config, located in buffer, and fills the dev->config structure.
287 * Note that all little/big endian swapping are done automatically.
289 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
291 struct usb_descriptor_header *head;
292 int index, ifno, epno, curr_if_num;
300 dev->configno = cfgno;
301 head = (struct usb_descriptor_header *) &buffer[0];
302 if(head->bDescriptorType != USB_DT_CONFIG) {
303 printf(" ERROR: NOT USB_CONFIG_DESC %x\n", head->bDescriptorType);
306 memcpy(&dev->config, buffer, buffer[0]);
307 le16_to_cpus(&(dev->config.wTotalLength));
308 dev->config.no_of_if = 0;
310 index = dev->config.bLength;
311 /* Ok the first entry must be a configuration entry, now process the others */
312 head = (struct usb_descriptor_header *) &buffer[index];
313 while(index + 1 < dev->config.wTotalLength) {
314 switch(head->bDescriptorType) {
315 case USB_DT_INTERFACE:
316 if(((struct usb_interface_descriptor *) &buffer[index])->
317 bInterfaceNumber != curr_if_num) {
318 /* this is a new interface, copy new desc */
319 ifno = dev->config.no_of_if;
320 dev->config.no_of_if++;
321 memcpy(&dev->config.if_desc[ifno],
322 &buffer[index], buffer[index]);
323 dev->config.if_desc[ifno].no_of_ep = 0;
324 dev->config.if_desc[ifno].num_altsetting = 1;
325 curr_if_num = dev->config.if_desc[ifno].bInterfaceNumber;
327 /* found alternate setting for the interface */
328 dev->config.if_desc[ifno].num_altsetting++;
331 case USB_DT_ENDPOINT:
332 epno = dev->config.if_desc[ifno].no_of_ep;
333 dev->config.if_desc[ifno].no_of_ep++; /* found an endpoint */
334 memcpy(&dev->config.if_desc[ifno].ep_desc[epno],
335 &buffer[index], buffer[index]);
336 le16_to_cpus(&(dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize));
337 USB_PRINTF("if %d, ep %d\n", ifno, epno);
340 if(head->bLength == 0)
342 USB_PRINTF("unknown Description Type : %x\n", head->bDescriptorType);
344 ch = (unsigned char *)head;
345 for(i = 0; i < head->bLength; i++)
346 USB_PRINTF("%02X ", *ch++);
347 USB_PRINTF("\n\n\n");
351 index += head->bLength;
352 head = (struct usb_descriptor_header *)&buffer[index];
357 /***********************************************************************
359 * endp: endpoint number in bits 0-3;
360 * direction flag in bit 7 (1 = IN, 0 = OUT)
362 int usb_clear_halt(struct usb_device *dev, int pipe)
365 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
367 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
368 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
370 /* don't clear if failed */
375 * NOTE: we do not get status and verify reset was successful
376 * as some devices are reported to lock up upon this check..
379 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
381 /* toggle is reset on clear */
382 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
387 /**********************************************************************
388 * get_descriptor type
390 int usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)
393 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
394 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
395 (type << 8) + index, 0,
396 buf, size, USB_CNTL_TIMEOUT);
400 /**********************************************************************
401 * gets configuration cfgno and store it in the buffer
403 int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno)
407 struct usb_config_descriptor *config;
410 config=(struct usb_config_descriptor *)&buffer[0];
411 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 8);
414 printf("unable to get descriptor, error %lX\n",dev->status);
416 printf("config descriptor too short (expected %i, got %i)\n",8,result);
419 tmp = le16_to_cpu(config->wTotalLength);
421 if (tmp > USB_BUFSIZ) {
422 USB_PRINTF("usb_get_configuration_no: failed to get descriptor - too long: %d\n",
427 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
428 USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",cfgno,result,tmp);
432 /********************************************************************
433 * set address of a device to the value in dev->devnum.
434 * This can only be done by addressing the device via the default address (0)
436 int usb_set_address(struct usb_device *dev)
440 USB_PRINTF("set address %d\n",dev->devnum);
441 res=usb_control_msg(dev, usb_snddefctrl(dev),
442 USB_REQ_SET_ADDRESS, 0,
444 NULL,0, USB_CNTL_TIMEOUT);
448 /********************************************************************
449 * set interface number to interface
451 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
453 struct usb_interface_descriptor *if_face = NULL;
456 for (i = 0; i < dev->config.bNumInterfaces; i++) {
457 if (dev->config.if_desc[i].bInterfaceNumber == interface) {
458 if_face = &dev->config.if_desc[i];
463 printf("selecting invalid interface %d", interface);
467 * We should return now for devices with only one alternate setting.
468 * According to 9.4.10 of the Universal Serial Bus Specification Revision 2.0
469 * such devices can return with a STALL. This results in some USB sticks
470 * timeouting during initialization and then being unusable in U-Boot.
472 if (if_face->num_altsetting == 1)
475 if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
476 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, alternate,
477 interface, NULL, 0, USB_CNTL_TIMEOUT * 5)) < 0)
483 /********************************************************************
484 * set configuration number to configuration
486 int usb_set_configuration(struct usb_device *dev, int configuration)
489 USB_PRINTF("set configuration %d\n",configuration);
490 /* set setup command */
491 res=usb_control_msg(dev, usb_sndctrlpipe(dev,0),
492 USB_REQ_SET_CONFIGURATION, 0,
494 NULL,0, USB_CNTL_TIMEOUT);
504 /********************************************************************
505 * set protocol to protocol
507 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
509 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
510 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
511 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
514 /********************************************************************
517 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
519 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
520 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
521 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
524 /********************************************************************
527 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size)
529 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
530 USB_REQ_GET_REPORT, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
531 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
534 /********************************************************************
535 * get class descriptor
537 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
538 unsigned char type, unsigned char id, void *buf, int size)
540 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
541 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
542 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
545 /********************************************************************
546 * get string index in buffer
548 int usb_get_string(struct usb_device *dev, unsigned short langid, unsigned char index, void *buf, int size)
553 for (i = 0; i < 3; ++i) {
554 /* some devices are flaky */
555 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
556 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
557 (USB_DT_STRING << 8) + index, langid, buf, size,
568 static void usb_try_string_workarounds(unsigned char *buf, int *length)
570 int newlength, oldlength = *length;
572 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
573 if (!isprint(buf[newlength]) || buf[newlength + 1])
583 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
584 unsigned int index, unsigned char *buf)
588 /* Try to read the string descriptor by asking for the maximum
589 * possible number of bytes */
590 rc = usb_get_string(dev, langid, index, buf, 255);
592 /* If that failed try to read the descriptor length, then
593 * ask for just that many bytes */
595 rc = usb_get_string(dev, langid, index, buf, 2);
597 rc = usb_get_string(dev, langid, index, buf, buf[0]);
601 if (!buf[0] && !buf[1])
602 usb_try_string_workarounds(buf, &rc);
604 /* There might be extra junk at the end of the descriptor */
608 rc = rc - (rc & 1); /* force a multiple of two */
618 /********************************************************************
620 * Get string index and translate it to ascii.
621 * returns string length (> 0) or error (< 0)
623 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
625 unsigned char mybuf[USB_BUFSIZ];
630 if (size <= 0 || !buf || !index)
635 /* get langid for strings if it's not yet known */
636 if (!dev->have_langid) {
637 err = usb_string_sub(dev, 0, 0, tbuf);
639 USB_PRINTF("error getting string descriptor 0 (error=%x)\n",dev->status);
641 } else if (tbuf[0] < 4) {
642 USB_PRINTF("string descriptor 0 too short\n");
645 dev->have_langid = -1;
646 dev->string_langid = tbuf[2] | (tbuf[3]<< 8);
647 /* always use the first langid listed */
648 USB_PRINTF("USB device number %d default language ID 0x%x\n",
649 dev->devnum, dev->string_langid);
653 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
657 size--; /* leave room for trailing NULL char in output buffer */
658 for (idx = 0, u = 2; u < err; u += 2) {
661 if (tbuf[u+1]) /* high byte */
662 buf[idx++] = '?'; /* non-ASCII character */
664 buf[idx++] = tbuf[u];
672 /********************************************************************
673 * USB device handling:
674 * the USB device are static allocated [USB_MAX_DEVICE].
678 /* returns a pointer to the device with the index [index].
679 * if the device is not assigned (dev->devnum==-1) returns NULL
681 struct usb_device * usb_get_dev_index(int index)
683 if(usb_dev[index].devnum==-1)
686 return &usb_dev[index];
690 /* returns a pointer of a new device structure or NULL, if
691 * no device struct is available
693 struct usb_device * usb_alloc_new_device(void)
696 USB_PRINTF("New Device %d\n",dev_index);
697 if(dev_index==USB_MAX_DEVICE) {
698 printf("ERROR, too many USB Devices, max=%d\n",USB_MAX_DEVICE);
701 usb_dev[dev_index].devnum=dev_index+1; /* default Address is 0, real addresses start with 1 */
702 usb_dev[dev_index].maxchild=0;
703 for(i=0;i<USB_MAXCHILDREN;i++)
704 usb_dev[dev_index].children[i]=NULL;
705 usb_dev[dev_index].parent=NULL;
707 return &usb_dev[dev_index-1];
712 * By the time we get here, the device has gotten a new device ID
713 * and is in the default state. We need to identify the thing and
714 * get the ball rolling..
716 * Returns 0 for success, != 0 for error.
718 int usb_new_device(struct usb_device *dev)
722 unsigned char tmpbuf[USB_BUFSIZ];
724 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
725 dev->maxpacketsize = 0; /* Default to 8 byte max packet size */
726 dev->epmaxpacketin [0] = 8;
727 dev->epmaxpacketout[0] = 8;
729 /* We still haven't set the Address yet */
735 /* this is a Windows scheme of initialization sequence, with double
736 * reset of the device. Some equipment is said to work only with such
737 * init sequence; this patch is based on the work by Alan Stern:
738 * http://sourceforge.net/mailarchive/forum.php?thread_id=5729457&forum_id=5398
741 struct usb_device_descriptor *desc;
743 struct usb_device *parent = dev->parent;
744 unsigned short portstatus;
746 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
747 * only 18 bytes long, this will terminate with a short packet. But if
748 * the maxpacket size is 8 or 16 the device may be waiting to transmit
751 desc = (struct usb_device_descriptor *)tmpbuf;
752 desc->bMaxPacketSize0 = 0;
753 for (j = 0; j < 3; ++j) {
754 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
756 USB_PRINTF("usb_new_device: 64 byte descr\n");
760 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
762 /* find the port number we're at */
765 for (j = 0; j < parent->maxchild; j++) {
766 if (parent->children[j] == dev) {
772 printf("usb_new_device: cannot locate device's port..\n");
776 /* reset the port for the second time */
777 err = hub_port_reset(dev->parent, port, &portstatus);
779 printf("\n Couldn't reset port %i\n", port);
784 /* and this is the old and known way of initializing devices */
785 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
787 printf("\n USB device not responding, giving up (status=%lX)\n",dev->status);
792 dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
793 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
794 switch (dev->descriptor.bMaxPacketSize0) {
795 case 8: dev->maxpacketsize = 0; break;
796 case 16: dev->maxpacketsize = 1; break;
797 case 32: dev->maxpacketsize = 2; break;
798 case 64: dev->maxpacketsize = 3; break;
802 err = usb_set_address(dev); /* set address */
805 printf("\n USB device not accepting new address (error=%lX)\n", dev->status);
809 wait_ms(10); /* Let the SET_ADDRESS settle */
811 tmp = sizeof(dev->descriptor);
813 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, sizeof(dev->descriptor));
816 printf("unable to get device descriptor (error=%d)\n",err);
818 printf("USB device descriptor short read (expected %i, got %i)\n",tmp,err);
821 /* correct le values */
822 le16_to_cpus(&dev->descriptor.bcdUSB);
823 le16_to_cpus(&dev->descriptor.idVendor);
824 le16_to_cpus(&dev->descriptor.idProduct);
825 le16_to_cpus(&dev->descriptor.bcdDevice);
826 /* only support for one config for now */
827 usb_get_configuration_no(dev,&tmpbuf[0],0);
828 usb_parse_config(dev,&tmpbuf[0],0);
829 usb_set_maxpacket(dev);
830 /* we set the default configuration here */
831 if (usb_set_configuration(dev, dev->config.bConfigurationValue)) {
832 printf("failed to set default configuration len %d, status %lX\n",dev->act_len,dev->status);
835 USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
836 dev->descriptor.iManufacturer, dev->descriptor.iProduct, dev->descriptor.iSerialNumber);
837 memset(dev->mf, 0, sizeof(dev->mf));
838 memset(dev->prod, 0, sizeof(dev->prod));
839 memset(dev->serial, 0, sizeof(dev->serial));
840 if (dev->descriptor.iManufacturer)
841 usb_string(dev, dev->descriptor.iManufacturer, dev->mf, sizeof(dev->mf));
842 if (dev->descriptor.iProduct)
843 usb_string(dev, dev->descriptor.iProduct, dev->prod, sizeof(dev->prod));
844 if (dev->descriptor.iSerialNumber)
845 usb_string(dev, dev->descriptor.iSerialNumber, dev->serial, sizeof(dev->serial));
846 USB_PRINTF("Manufacturer %s\n", dev->mf);
847 USB_PRINTF("Product %s\n", dev->prod);
848 USB_PRINTF("SerialNumber %s\n", dev->serial);
849 /* now prode if the device is a hub */
850 usb_hub_probe(dev,0);
854 /* build device Tree */
855 void usb_scan_devices(void)
858 struct usb_device *dev;
860 /* first make all devices unknown */
861 for(i=0;i<USB_MAX_DEVICE;i++) {
862 memset(&usb_dev[i],0,sizeof(struct usb_device));
863 usb_dev[i].devnum = -1;
866 /* device 0 is always present (root hub, so let it analyze) */
867 dev=usb_alloc_new_device();
869 printf("%d USB Device(s) found\n",dev_index);
870 /* insert "driver" if possible */
871 #ifdef CONFIG_USB_KEYBOARD
873 USB_PRINTF("scan end\n");
878 /****************************************************************************
880 * Probes device for being a hub and configurate it
886 #define USB_HUB_PRINTF(fmt,args...) printf (fmt ,##args)
888 #define USB_HUB_PRINTF(fmt,args...)
892 static struct usb_hub_device hub_dev[USB_MAX_HUB];
893 static int usb_hub_index;
896 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
898 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
899 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
900 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
903 int usb_clear_hub_feature(struct usb_device *dev, int feature)
905 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
906 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, USB_CNTL_TIMEOUT);
909 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
911 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
912 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
915 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
917 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
918 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
921 int usb_get_hub_status(struct usb_device *dev, void *data)
923 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
924 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
925 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
928 int usb_get_port_status(struct usb_device *dev, int port, void *data)
930 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
931 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
932 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
936 static void usb_hub_power_on(struct usb_hub_device *hub)
939 struct usb_device *dev;
942 /* Enable power to the ports */
943 USB_HUB_PRINTF("enabling power on all ports\n");
944 for (i = 0; i < dev->maxchild; i++) {
945 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
946 USB_HUB_PRINTF("port %d returns %lX\n",i+1,dev->status);
947 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
951 void usb_hub_reset(void)
956 struct usb_hub_device *usb_hub_allocate(void)
958 if(usb_hub_index<USB_MAX_HUB) {
959 return &hub_dev[usb_hub_index++];
961 printf("ERROR: USB_MAX_HUB (%d) reached\n",USB_MAX_HUB);
967 static int hub_port_reset(struct usb_device *dev, int port,
968 unsigned short *portstat)
971 struct usb_port_status portsts;
972 unsigned short portstatus, portchange;
975 USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
976 for(tries=0;tries<MAX_TRIES;tries++) {
978 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
981 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
982 USB_HUB_PRINTF("get_port_status failed status %lX\n",dev->status);
985 portstatus = le16_to_cpu(portsts.wPortStatus);
986 portchange = le16_to_cpu(portsts.wPortChange);
987 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus ,portchange,
988 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
989 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d USB_PORT_STAT_ENABLE %d\n",
990 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
991 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
992 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
993 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
994 !(portstatus & USB_PORT_STAT_CONNECTION))
997 if (portstatus & USB_PORT_STAT_ENABLE) {
1005 if (tries==MAX_TRIES) {
1006 USB_HUB_PRINTF("Cannot enable port %i after %i retries, disabling port.\n", port+1, MAX_TRIES);
1007 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
1011 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
1012 *portstat = portstatus;
1018 void usb_hub_port_connect_change(struct usb_device *dev, int port)
1020 struct usb_device *usb;
1021 struct usb_port_status portsts;
1022 unsigned short portstatus, portchange;
1025 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
1026 USB_HUB_PRINTF("get_port_status failed\n");
1030 portstatus = le16_to_cpu(portsts.wPortStatus);
1031 portchange = le16_to_cpu(portsts.wPortChange);
1032 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus, portchange,
1033 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
1035 /* Clear the connection change status */
1036 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
1038 /* Disconnect any existing devices under this port */
1039 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
1040 (!(portstatus & USB_PORT_STAT_ENABLE)))|| (dev->children[port])) {
1041 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
1042 /* Return now if nothing is connected */
1043 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1048 /* Reset the port */
1049 if (hub_port_reset(dev, port, &portstatus) < 0) {
1050 printf("cannot reset port %i!?\n", port + 1);
1056 /* Allocate a new device struct for it */
1057 usb=usb_alloc_new_device();
1058 usb->slow = (portstatus & USB_PORT_STAT_LOW_SPEED) ? 1 : 0;
1060 dev->children[port] = usb;
1062 /* Run it through the hoops (find a driver, etc) */
1063 if (usb_new_device(usb)) {
1064 /* Woops, disable the port */
1065 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
1066 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
1071 int usb_hub_configure(struct usb_device *dev)
1073 unsigned char buffer[USB_BUFSIZ], *bitmap;
1074 struct usb_hub_descriptor *descriptor;
1075 struct usb_hub_status *hubsts;
1077 struct usb_hub_device *hub;
1079 /* "allocate" Hub device */
1080 hub=usb_hub_allocate();
1084 /* Get the the hub descriptor */
1085 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
1086 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor, giving up %lX\n",dev->status);
1089 descriptor = (struct usb_hub_descriptor *)buffer;
1091 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
1092 i = descriptor->bLength;
1093 if (i > USB_BUFSIZ) {
1094 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor - too long: %d\n",
1095 descriptor->bLength);
1099 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
1100 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor 2nd giving up %lX\n",dev->status);
1103 memcpy((unsigned char *)&hub->desc,buffer,descriptor->bLength);
1104 /* adjust 16bit values */
1105 hub->desc.wHubCharacteristics = le16_to_cpu(descriptor->wHubCharacteristics);
1106 /* set the bitmap */
1107 bitmap=(unsigned char *)&hub->desc.DeviceRemovable[0];
1108 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* devices not removable by default */
1109 bitmap=(unsigned char *)&hub->desc.PortPowerCtrlMask[0];
1110 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
1111 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1112 hub->desc.DeviceRemovable[i]=descriptor->DeviceRemovable[i];
1114 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1115 hub->desc.DeviceRemovable[i]=descriptor->PortPowerCtrlMask[i];
1117 dev->maxchild = descriptor->bNbrPorts;
1118 USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
1120 switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
1122 USB_HUB_PRINTF("ganged power switching\n");
1125 USB_HUB_PRINTF("individual port power switching\n");
1129 USB_HUB_PRINTF("unknown reserved power switching mode\n");
1133 if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
1134 USB_HUB_PRINTF("part of a compound device\n");
1136 USB_HUB_PRINTF("standalone hub\n");
1138 switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
1140 USB_HUB_PRINTF("global over-current protection\n");
1143 USB_HUB_PRINTF("individual port over-current protection\n");
1147 USB_HUB_PRINTF("no over-current protection\n");
1150 USB_HUB_PRINTF("power on to power good time: %dms\n", descriptor->bPwrOn2PwrGood * 2);
1151 USB_HUB_PRINTF("hub controller current requirement: %dmA\n", descriptor->bHubContrCurrent);
1152 for (i = 0; i < dev->maxchild; i++)
1153 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
1154 hub->desc.DeviceRemovable[(i + 1)/8] & (1 << ((i + 1)%8)) ? " not" : "");
1155 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
1156 USB_HUB_PRINTF("usb_hub_configure: failed to get Status - too long: %d\n",
1157 descriptor->bLength);
1161 if (usb_get_hub_status(dev, buffer) < 0) {
1162 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",dev->status);
1165 hubsts = (struct usb_hub_status *)buffer;
1166 USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
1167 le16_to_cpu(hubsts->wHubStatus),le16_to_cpu(hubsts->wHubChange));
1168 USB_HUB_PRINTF("local power source is %s\n",
1169 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? "lost (inactive)" : "good");
1170 USB_HUB_PRINTF("%sover-current condition exists\n",
1171 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1172 usb_hub_power_on(hub);
1173 for (i = 0; i < dev->maxchild; i++) {
1174 struct usb_port_status portsts;
1175 unsigned short portstatus, portchange;
1177 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
1178 USB_HUB_PRINTF("get_port_status failed\n");
1181 portstatus = le16_to_cpu(portsts.wPortStatus);
1182 portchange = le16_to_cpu(portsts.wPortChange);
1183 USB_HUB_PRINTF("Port %d Status %X Change %X\n",i+1,portstatus,portchange);
1184 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1185 USB_HUB_PRINTF("port %d connection change\n", i + 1);
1186 usb_hub_port_connect_change(dev, i);
1188 if (portchange & USB_PORT_STAT_C_ENABLE) {
1189 USB_HUB_PRINTF("port %d enable change, status %x\n", i + 1, portstatus);
1190 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
1192 /* EM interference sometimes causes bad shielded USB devices to
1193 * be shutdown by the hub, this hack enables them again.
1194 * Works at least with mouse driver */
1195 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1196 (portstatus & USB_PORT_STAT_CONNECTION) && (dev->children[i])) {
1197 USB_HUB_PRINTF("already running port %i disabled by hub (EMI?), re-enabling...\n",
1199 usb_hub_port_connect_change(dev, i);
1202 if (portstatus & USB_PORT_STAT_SUSPEND) {
1203 USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1204 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
1207 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1208 USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1209 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_OVER_CURRENT);
1210 usb_hub_power_on(hub);
1213 if (portchange & USB_PORT_STAT_C_RESET) {
1214 USB_HUB_PRINTF("port %d reset change\n", i + 1);
1215 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
1217 } /* end for i all ports */
1222 int usb_hub_probe(struct usb_device *dev, int ifnum)
1224 struct usb_interface_descriptor *iface;
1225 struct usb_endpoint_descriptor *ep;
1228 iface = &dev->config.if_desc[ifnum];
1230 if (iface->bInterfaceClass != USB_CLASS_HUB)
1232 /* Some hubs have a subclass of 1, which AFAICT according to the */
1233 /* specs is not defined, but it works */
1234 if ((iface->bInterfaceSubClass != 0) &&
1235 (iface->bInterfaceSubClass != 1))
1237 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1238 if (iface->bNumEndpoints != 1)
1240 ep = &iface->ep_desc[0];
1241 /* Output endpoint? Curiousier and curiousier.. */
1242 if (!(ep->bEndpointAddress & USB_DIR_IN))
1244 /* If it's not an interrupt endpoint, we'd better punt! */
1245 if ((ep->bmAttributes & 3) != 3)
1247 /* We found a hub */
1248 USB_HUB_PRINTF("USB hub found\n");
1249 ret=usb_hub_configure(dev);