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>
52 #if (CONFIG_COMMANDS & CFG_CMD_USB)
56 #include <405gp_pci.h>
62 #define USB_PRINTF(fmt,args...) printf (fmt ,##args)
64 #define USB_PRINTF(fmt,args...)
67 #define USB_BUFSIZ 512
69 static struct usb_device usb_dev[USB_MAX_DEVICE];
72 static int asynch_allowed;
73 static struct devrequest setup_packet;
75 /**********************************************************************
76 * some forward declerations...
78 void usb_scan_devices(void);
80 int usb_hub_probe(struct usb_device *dev, int ifnum);
81 void usb_hub_reset(void);
84 /***********************************************************************
88 void __inline__ wait_ms(unsigned long ms)
93 /***************************************************************************
105 /* init low_level USB */
107 result = usb_lowlevel_init();
108 /* if lowlevel init is OK, scan the bus for devices i.e. search HUBs and configure them */
110 printf("scanning bus for devices... ");
116 printf("Error, couldn't init Lowlevel part\n");
121 /******************************************************************************
122 * Stop USB this stops the LowLevel Part and deregisters USB devices.
128 return usb_lowlevel_stop();
132 * disables the asynch behaviour of the control message. This is used for data
133 * transfers that uses the exclusiv access to the control and bulk messages.
135 void usb_disable_asynch(int disable)
137 asynch_allowed=!disable;
141 /*-------------------------------------------------------------------
147 * submits an Interrupt Message
149 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
150 void *buffer,int transfer_len, int interval)
152 return submit_int_msg(dev,pipe,buffer,transfer_len,interval);
156 * submits a control message and waits for comletion (at least timeout * 1ms)
157 * If timeout is 0, we don't wait for completion (used as example to set and
158 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
159 * allow control messages with 0 timeout, by previousely resetting the flag
160 * asynch_allowed (usb_disable_asynch(1)).
161 * returns the transfered length if OK or -1 if error. The transfered length
162 * and the current status are stored in the dev->act_len and dev->status.
164 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
165 unsigned char request, unsigned char requesttype,
166 unsigned short value, unsigned short index,
167 void *data, unsigned short size, int timeout)
169 if((timeout==0)&&(!asynch_allowed)) /* request for a asynch control pipe is not allowed */
172 /* set setup command */
173 setup_packet.requesttype = requesttype;
174 setup_packet.request = request;
175 setup_packet.value = swap_16(value);
176 setup_packet.index = swap_16(index);
177 setup_packet.length = swap_16(size);
178 USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X\nvalue 0x%X index 0x%X length 0x%X\n",
179 request,requesttype,value,index,size);
180 dev->status=USB_ST_NOT_PROC; /*not yet processed */
182 submit_control_msg(dev,pipe,data,size,&setup_packet);
187 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
198 /*-------------------------------------------------------------------
199 * submits bulk message, and waits for completion. returns 0 if Ok or
201 * synchronous behavior
203 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
204 void *data, int len, int *actual_length, int timeout)
208 dev->status=USB_ST_NOT_PROC; /*not yet processed */
209 submit_bulk_msg(dev,pipe,data,len);
211 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
215 *actual_length=dev->act_len;
223 /*-------------------------------------------------------------------
228 * returns the max packet size, depending on the pipe direction and
229 * the configurations values
231 int usb_maxpacket(struct usb_device *dev,unsigned long pipe)
233 if((pipe & USB_DIR_IN)==0) /* direction is out -> use emaxpacket out */
234 return(dev->epmaxpacketout[((pipe>>15) & 0xf)]);
236 return(dev->epmaxpacketin[((pipe>>15) & 0xf)]);
240 * set the max packed value of all endpoints in the given configuration
242 int usb_set_maxpacket(struct usb_device *dev)
245 struct usb_endpoint_descriptor *ep;
247 for(i=0; i<dev->config.bNumInterfaces;i++) {
248 for(ii=0; ii<dev->config.if_desc[i].bNumEndpoints; ii++) {
249 ep=&dev->config.if_desc[i].ep_desc[ii];
250 b=ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
252 if((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)==USB_ENDPOINT_XFER_CONTROL) { /* Control => bidirectional */
253 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
254 dev->epmaxpacketin [b] = ep->wMaxPacketSize;
255 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",b,dev->epmaxpacketin[b]);
258 if ((ep->bEndpointAddress & 0x80)==0) { /* OUT Endpoint */
259 if(ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
260 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
261 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",b,dev->epmaxpacketout[b]);
264 else { /* IN Endpoint */
265 if(ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
266 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
267 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",b,dev->epmaxpacketin[b]);
271 } /* for each endpoint */
276 /*******************************************************************************
277 * Parse the config, located in buffer, and fills the dev->config structure.
278 * Note that all little/big endian swapping are done automatically.
280 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
282 struct usb_descriptor_header *head;
283 int index, ifno, epno, curr_if_num;
291 dev->configno = cfgno;
292 head = (struct usb_descriptor_header *) &buffer[0];
293 if(head->bDescriptorType != USB_DT_CONFIG) {
294 printf(" ERROR: NOT USB_CONFIG_DESC %x\n", head->bDescriptorType);
297 memcpy(&dev->config, buffer, buffer[0]);
298 dev->config.wTotalLength = swap_16(dev->config.wTotalLength);
299 dev->config.no_of_if = 0;
301 index = dev->config.bLength;
302 /* Ok the first entry must be a configuration entry, now process the others */
303 head = (struct usb_descriptor_header *) &buffer[index];
304 while(index + 1 < dev->config.wTotalLength) {
305 switch(head->bDescriptorType) {
306 case USB_DT_INTERFACE:
307 if(((struct usb_interface_descriptor *) &buffer[index])->
308 bInterfaceNumber != curr_if_num) {
309 /* this is a new interface, copy new desc */
310 ifno = dev->config.no_of_if;
311 dev->config.no_of_if++;
312 memcpy(&dev->config.if_desc[ifno],
313 &buffer[index], buffer[index]);
314 dev->config.if_desc[ifno].no_of_ep = 0;
315 dev->config.if_desc[ifno].num_altsetting = 1;
316 curr_if_num = dev->config.if_desc[ifno].bInterfaceNumber;
318 /* found alternate setting for the interface */
319 dev->config.if_desc[ifno].num_altsetting++;
322 case USB_DT_ENDPOINT:
323 epno = dev->config.if_desc[ifno].no_of_ep;
324 dev->config.if_desc[ifno].no_of_ep++; /* found an endpoint */
325 memcpy(&dev->config.if_desc[ifno].ep_desc[epno],
326 &buffer[index], buffer[index]);
327 dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize =
328 swap_16(dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize);
329 USB_PRINTF("if %d, ep %d\n", ifno, epno);
332 if(head->bLength == 0)
334 USB_PRINTF("unknown Description Type : %x\n", head->bDescriptorType);
336 ch = (unsigned char *)head;
337 for(i = 0; i < head->bLength; i++)
338 USB_PRINTF("%02X ", *ch++);
339 USB_PRINTF("\n\n\n");
343 index += head->bLength;
344 head = (struct usb_descriptor_header *)&buffer[index];
349 /***********************************************************************
351 * endp: endpoint number in bits 0-3;
352 * direction flag in bit 7 (1 = IN, 0 = OUT)
354 int usb_clear_halt(struct usb_device *dev, int pipe)
357 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
359 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
360 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
362 /* don't clear if failed */
367 * NOTE: we do not get status and verify reset was successful
368 * as some devices are reported to lock up upon this check..
371 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
373 /* toggle is reset on clear */
374 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
379 /**********************************************************************
380 * get_descriptor type
382 int usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)
385 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
386 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
387 (type << 8) + index, 0,
388 buf, size, USB_CNTL_TIMEOUT);
392 /**********************************************************************
393 * gets configuration cfgno and store it in the buffer
395 int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno)
399 struct usb_config_descriptor *config;
402 config=(struct usb_config_descriptor *)&buffer[0];
403 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 8);
406 printf("unable to get descriptor, error %lX\n",dev->status);
408 printf("config descriptor too short (expected %i, got %i)\n",8,result);
411 tmp=swap_16(config->wTotalLength);
413 if (tmp > USB_BUFSIZ) {
414 USB_PRINTF("usb_get_configuration_no: failed to get descriptor - too long: %d\n",
419 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
420 USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",cfgno,result,tmp);
424 /********************************************************************
425 * set address of a device to the value in dev->devnum.
426 * This can only be done by addressing the device via the default address (0)
428 int usb_set_address(struct usb_device *dev)
432 USB_PRINTF("set address %d\n",dev->devnum);
433 res=usb_control_msg(dev, usb_snddefctrl(dev),
434 USB_REQ_SET_ADDRESS, 0,
436 NULL,0, USB_CNTL_TIMEOUT);
440 /********************************************************************
441 * set interface number to interface
443 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
445 struct usb_interface_descriptor *if_face = NULL;
448 for (i = 0; i < dev->config.bNumInterfaces; i++) {
449 if (dev->config.if_desc[i].bInterfaceNumber == interface) {
450 if_face = &dev->config.if_desc[i];
455 printf("selecting invalid interface %d", interface);
459 * We should return now for devices with only one alternate setting.
460 * According to 9.4.10 of the Universal Serial Bus Specification Revision 2.0
461 * such devices can return with a STALL. This results in some USB sticks
462 * timeouting during initialization and then being unusable in U-Boot.
464 if (if_face->num_altsetting == 1)
467 if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
468 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, alternate,
469 interface, NULL, 0, USB_CNTL_TIMEOUT * 5)) < 0)
475 /********************************************************************
476 * set configuration number to configuration
478 int usb_set_configuration(struct usb_device *dev, int configuration)
481 USB_PRINTF("set configuration %d\n",configuration);
482 /* set setup command */
483 res=usb_control_msg(dev, usb_sndctrlpipe(dev,0),
484 USB_REQ_SET_CONFIGURATION, 0,
486 NULL,0, USB_CNTL_TIMEOUT);
496 /********************************************************************
497 * set protocol to protocol
499 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
501 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
502 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
503 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
506 /********************************************************************
509 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
511 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
512 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
513 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
516 /********************************************************************
519 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size)
521 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
522 USB_REQ_GET_REPORT, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
523 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
526 /********************************************************************
527 * get class descriptor
529 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
530 unsigned char type, unsigned char id, void *buf, int size)
532 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
533 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
534 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
537 /********************************************************************
538 * get string index in buffer
540 int usb_get_string(struct usb_device *dev, unsigned short langid, unsigned char index, void *buf, int size)
545 for (i = 0; i < 3; ++i) {
546 /* some devices are flaky */
547 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
548 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
549 (USB_DT_STRING << 8) + index, langid, buf, size,
560 static void usb_try_string_workarounds(unsigned char *buf, int *length)
562 int newlength, oldlength = *length;
564 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
565 if (!isprint(buf[newlength]) || buf[newlength + 1])
575 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
576 unsigned int index, unsigned char *buf)
580 /* Try to read the string descriptor by asking for the maximum
581 * possible number of bytes */
582 rc = usb_get_string(dev, langid, index, buf, 255);
584 /* If that failed try to read the descriptor length, then
585 * ask for just that many bytes */
587 rc = usb_get_string(dev, langid, index, buf, 2);
589 rc = usb_get_string(dev, langid, index, buf, buf[0]);
593 if (!buf[0] && !buf[1])
594 usb_try_string_workarounds(buf, &rc);
596 /* There might be extra junk at the end of the descriptor */
600 rc = rc - (rc & 1); /* force a multiple of two */
610 /********************************************************************
612 * Get string index and translate it to ascii.
613 * returns string length (> 0) or error (< 0)
615 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
617 unsigned char mybuf[USB_BUFSIZ];
622 if (size <= 0 || !buf || !index)
627 /* get langid for strings if it's not yet known */
628 if (!dev->have_langid) {
629 err = usb_string_sub(dev, 0, 0, tbuf);
631 USB_PRINTF("error getting string descriptor 0 (error=%x)\n",dev->status);
633 } else if (tbuf[0] < 4) {
634 USB_PRINTF("string descriptor 0 too short\n");
637 dev->have_langid = -1;
638 dev->string_langid = tbuf[2] | (tbuf[3]<< 8);
639 /* always use the first langid listed */
640 USB_PRINTF("USB device number %d default language ID 0x%x\n",
641 dev->devnum, dev->string_langid);
645 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
649 size--; /* leave room for trailing NULL char in output buffer */
650 for (idx = 0, u = 2; u < err; u += 2) {
653 if (tbuf[u+1]) /* high byte */
654 buf[idx++] = '?'; /* non-ASCII character */
656 buf[idx++] = tbuf[u];
664 /********************************************************************
665 * USB device handling:
666 * the USB device are static allocated [USB_MAX_DEVICE].
670 /* returns a pointer to the device with the index [index].
671 * if the device is not assigned (dev->devnum==-1) returns NULL
673 struct usb_device * usb_get_dev_index(int index)
675 if(usb_dev[index].devnum==-1)
678 return &usb_dev[index];
682 /* returns a pointer of a new device structure or NULL, if
683 * no device struct is available
685 struct usb_device * usb_alloc_new_device(void)
688 USB_PRINTF("New Device %d\n",dev_index);
689 if(dev_index==USB_MAX_DEVICE) {
690 printf("ERROR, too many USB Devices, max=%d\n",USB_MAX_DEVICE);
693 usb_dev[dev_index].devnum=dev_index+1; /* default Address is 0, real addresses start with 1 */
694 usb_dev[dev_index].maxchild=0;
695 for(i=0;i<USB_MAXCHILDREN;i++)
696 usb_dev[dev_index].children[i]=NULL;
697 usb_dev[dev_index].parent=NULL;
699 return &usb_dev[dev_index-1];
704 * By the time we get here, the device has gotten a new device ID
705 * and is in the default state. We need to identify the thing and
706 * get the ball rolling..
708 * Returns 0 for success, != 0 for error.
710 int usb_new_device(struct usb_device *dev)
714 unsigned char tmpbuf[USB_BUFSIZ];
716 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
717 dev->maxpacketsize = 0; /* Default to 8 byte max packet size */
718 dev->epmaxpacketin [0] = 8;
719 dev->epmaxpacketout[0] = 8;
721 /* We still haven't set the Address yet */
727 /* this is a Windows scheme of initialization sequence, with double
728 * reset of the device. Some equipment is said to work only with such
729 * init sequence; this patch is based on the work by Alan Stern:
730 * http://sourceforge.net/mailarchive/forum.php?thread_id=5729457&forum_id=5398
733 struct usb_device_descriptor *desc;
735 struct usb_device *parent = dev->parent;
736 unsigned short portstatus;
738 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
739 * only 18 bytes long, this will terminate with a short packet. But if
740 * the maxpacket size is 8 or 16 the device may be waiting to transmit
743 desc = (struct usb_device_descriptor *)tmpbuf;
744 desc->bMaxPacketSize0 = 0;
745 for (j = 0; j < 3; ++j) {
746 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
748 USB_PRINTF("usb_new_device: 64 byte descr\n");
752 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
754 /* find the port number we're at */
757 for (j = 0; j < parent->maxchild; j++) {
758 if (parent->children[j] == dev) {
764 printf("usb_new_device: cannot locate device's port..\n");
768 /* reset the port for the second time */
769 err = hub_port_reset(dev->parent, port, &portstatus);
771 printf("\n Couldn't reset port %i\n", port);
776 /* and this is the old and known way of initializing devices */
777 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
779 printf("\n USB device not responding, giving up (status=%lX)\n",dev->status);
784 dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
785 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
786 switch (dev->descriptor.bMaxPacketSize0) {
787 case 8: dev->maxpacketsize = 0; break;
788 case 16: dev->maxpacketsize = 1; break;
789 case 32: dev->maxpacketsize = 2; break;
790 case 64: dev->maxpacketsize = 3; break;
794 err = usb_set_address(dev); /* set address */
797 printf("\n USB device not accepting new address (error=%lX)\n", dev->status);
801 wait_ms(10); /* Let the SET_ADDRESS settle */
803 tmp = sizeof(dev->descriptor);
805 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, sizeof(dev->descriptor));
808 printf("unable to get device descriptor (error=%d)\n",err);
810 printf("USB device descriptor short read (expected %i, got %i)\n",tmp,err);
813 /* correct le values */
814 dev->descriptor.bcdUSB=swap_16(dev->descriptor.bcdUSB);
815 dev->descriptor.idVendor=swap_16(dev->descriptor.idVendor);
816 dev->descriptor.idProduct=swap_16(dev->descriptor.idProduct);
817 dev->descriptor.bcdDevice=swap_16(dev->descriptor.bcdDevice);
818 /* only support for one config for now */
819 usb_get_configuration_no(dev,&tmpbuf[0],0);
820 usb_parse_config(dev,&tmpbuf[0],0);
821 usb_set_maxpacket(dev);
822 /* we set the default configuration here */
823 if (usb_set_configuration(dev, dev->config.bConfigurationValue)) {
824 printf("failed to set default configuration len %d, status %lX\n",dev->act_len,dev->status);
827 USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
828 dev->descriptor.iManufacturer, dev->descriptor.iProduct, dev->descriptor.iSerialNumber);
829 memset(dev->mf, 0, sizeof(dev->mf));
830 memset(dev->prod, 0, sizeof(dev->prod));
831 memset(dev->serial, 0, sizeof(dev->serial));
832 if (dev->descriptor.iManufacturer)
833 usb_string(dev, dev->descriptor.iManufacturer, dev->mf, sizeof(dev->mf));
834 if (dev->descriptor.iProduct)
835 usb_string(dev, dev->descriptor.iProduct, dev->prod, sizeof(dev->prod));
836 if (dev->descriptor.iSerialNumber)
837 usb_string(dev, dev->descriptor.iSerialNumber, dev->serial, sizeof(dev->serial));
838 USB_PRINTF("Manufacturer %s\n", dev->mf);
839 USB_PRINTF("Product %s\n", dev->prod);
840 USB_PRINTF("SerialNumber %s\n", dev->serial);
841 /* now prode if the device is a hub */
842 usb_hub_probe(dev,0);
846 /* build device Tree */
847 void usb_scan_devices(void)
850 struct usb_device *dev;
852 /* first make all devices unknown */
853 for(i=0;i<USB_MAX_DEVICE;i++) {
854 memset(&usb_dev[i],0,sizeof(struct usb_device));
855 usb_dev[i].devnum=-1;
858 /* device 0 is always present (root hub, so let it analyze) */
859 dev=usb_alloc_new_device();
861 printf("%d USB Device(s) found\n",dev_index);
862 /* insert "driver" if possible */
863 #ifdef CONFIG_USB_KEYBOARD
865 USB_PRINTF("scan end\n");
870 /****************************************************************************
872 * Probes device for being a hub and configurate it
878 #define USB_HUB_PRINTF(fmt,args...) printf (fmt ,##args)
880 #define USB_HUB_PRINTF(fmt,args...)
884 static struct usb_hub_device hub_dev[USB_MAX_HUB];
885 static int usb_hub_index;
888 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
890 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
891 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
892 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
895 int usb_clear_hub_feature(struct usb_device *dev, int feature)
897 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
898 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, USB_CNTL_TIMEOUT);
901 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
903 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
904 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
907 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
909 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
910 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
913 int usb_get_hub_status(struct usb_device *dev, void *data)
915 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
916 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
917 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
920 int usb_get_port_status(struct usb_device *dev, int port, void *data)
922 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
923 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
924 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
928 static void usb_hub_power_on(struct usb_hub_device *hub)
931 struct usb_device *dev;
934 /* Enable power to the ports */
935 USB_HUB_PRINTF("enabling power on all ports\n");
936 for (i = 0; i < dev->maxchild; i++) {
937 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
938 USB_HUB_PRINTF("port %d returns %lX\n",i+1,dev->status);
939 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
943 void usb_hub_reset(void)
948 struct usb_hub_device *usb_hub_allocate(void)
950 if(usb_hub_index<USB_MAX_HUB) {
951 return &hub_dev[usb_hub_index++];
953 printf("ERROR: USB_MAX_HUB (%d) reached\n",USB_MAX_HUB);
959 static int hub_port_reset(struct usb_device *dev, int port,
960 unsigned short *portstat)
963 struct usb_port_status portsts;
964 unsigned short portstatus, portchange;
967 USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
968 for(tries=0;tries<MAX_TRIES;tries++) {
970 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
973 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
974 USB_HUB_PRINTF("get_port_status failed status %lX\n",dev->status);
977 portstatus = swap_16(portsts.wPortStatus);
978 portchange = swap_16(portsts.wPortChange);
979 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus ,portchange,
980 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
981 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d USB_PORT_STAT_ENABLE %d\n",
982 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
983 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
984 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
985 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
986 !(portstatus & USB_PORT_STAT_CONNECTION))
989 if (portstatus & USB_PORT_STAT_ENABLE) {
997 if (tries==MAX_TRIES) {
998 USB_HUB_PRINTF("Cannot enable port %i after %i retries, disabling port.\n", port+1, MAX_TRIES);
999 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
1003 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
1004 *portstat = portstatus;
1010 void usb_hub_port_connect_change(struct usb_device *dev, int port)
1012 struct usb_device *usb;
1013 struct usb_port_status portsts;
1014 unsigned short portstatus, portchange;
1017 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
1018 USB_HUB_PRINTF("get_port_status failed\n");
1022 portstatus = swap_16(portsts.wPortStatus);
1023 portchange = swap_16(portsts.wPortChange);
1024 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus, portchange,
1025 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
1027 /* Clear the connection change status */
1028 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
1030 /* Disconnect any existing devices under this port */
1031 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
1032 (!(portstatus & USB_PORT_STAT_ENABLE)))|| (dev->children[port])) {
1033 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
1034 /* Return now if nothing is connected */
1035 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1040 /* Reset the port */
1041 if (hub_port_reset(dev, port, &portstatus) < 0) {
1042 printf("cannot reset port %i!?\n", port + 1);
1048 /* Allocate a new device struct for it */
1049 usb=usb_alloc_new_device();
1050 usb->slow = (portstatus & USB_PORT_STAT_LOW_SPEED) ? 1 : 0;
1052 dev->children[port] = usb;
1054 /* Run it through the hoops (find a driver, etc) */
1055 if (usb_new_device(usb)) {
1056 /* Woops, disable the port */
1057 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
1058 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
1063 int usb_hub_configure(struct usb_device *dev)
1065 unsigned char buffer[USB_BUFSIZ], *bitmap;
1066 struct usb_hub_descriptor *descriptor;
1067 struct usb_hub_status *hubsts;
1069 struct usb_hub_device *hub;
1071 /* "allocate" Hub device */
1072 hub=usb_hub_allocate();
1076 /* Get the the hub descriptor */
1077 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
1078 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor, giving up %lX\n",dev->status);
1081 descriptor = (struct usb_hub_descriptor *)buffer;
1083 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
1084 i = descriptor->bLength;
1085 if (i > USB_BUFSIZ) {
1086 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor - too long: %d\N",
1087 descriptor->bLength);
1091 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
1092 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor 2nd giving up %lX\n",dev->status);
1095 memcpy((unsigned char *)&hub->desc,buffer,descriptor->bLength);
1096 /* adjust 16bit values */
1097 hub->desc.wHubCharacteristics=swap_16(descriptor->wHubCharacteristics);
1098 /* set the bitmap */
1099 bitmap=(unsigned char *)&hub->desc.DeviceRemovable[0];
1100 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* devices not removable by default */
1101 bitmap=(unsigned char *)&hub->desc.PortPowerCtrlMask[0];
1102 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
1103 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1104 hub->desc.DeviceRemovable[i]=descriptor->DeviceRemovable[i];
1106 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1107 hub->desc.DeviceRemovable[i]=descriptor->PortPowerCtrlMask[i];
1109 dev->maxchild = descriptor->bNbrPorts;
1110 USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
1112 switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
1114 USB_HUB_PRINTF("ganged power switching\n");
1117 USB_HUB_PRINTF("individual port power switching\n");
1121 USB_HUB_PRINTF("unknown reserved power switching mode\n");
1125 if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
1126 USB_HUB_PRINTF("part of a compound device\n");
1128 USB_HUB_PRINTF("standalone hub\n");
1130 switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
1132 USB_HUB_PRINTF("global over-current protection\n");
1135 USB_HUB_PRINTF("individual port over-current protection\n");
1139 USB_HUB_PRINTF("no over-current protection\n");
1142 USB_HUB_PRINTF("power on to power good time: %dms\n", descriptor->bPwrOn2PwrGood * 2);
1143 USB_HUB_PRINTF("hub controller current requirement: %dmA\n", descriptor->bHubContrCurrent);
1144 for (i = 0; i < dev->maxchild; i++)
1145 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
1146 hub->desc.DeviceRemovable[(i + 1)/8] & (1 << ((i + 1)%8)) ? " not" : "");
1147 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
1148 USB_HUB_PRINTF("usb_hub_configure: failed to get Status - too long: %d\n",
1149 descriptor->bLength);
1153 if (usb_get_hub_status(dev, buffer) < 0) {
1154 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",dev->status);
1157 hubsts = (struct usb_hub_status *)buffer;
1158 USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
1159 swap_16(hubsts->wHubStatus),swap_16(hubsts->wHubChange));
1160 USB_HUB_PRINTF("local power source is %s\n",
1161 (swap_16(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? "lost (inactive)" : "good");
1162 USB_HUB_PRINTF("%sover-current condition exists\n",
1163 (swap_16(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1164 usb_hub_power_on(hub);
1165 for (i = 0; i < dev->maxchild; i++) {
1166 struct usb_port_status portsts;
1167 unsigned short portstatus, portchange;
1169 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
1170 USB_HUB_PRINTF("get_port_status failed\n");
1173 portstatus = swap_16(portsts.wPortStatus);
1174 portchange = swap_16(portsts.wPortChange);
1175 USB_HUB_PRINTF("Port %d Status %X Change %X\n",i+1,portstatus,portchange);
1176 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1177 USB_HUB_PRINTF("port %d connection change\n", i + 1);
1178 usb_hub_port_connect_change(dev, i);
1180 if (portchange & USB_PORT_STAT_C_ENABLE) {
1181 USB_HUB_PRINTF("port %d enable change, status %x\n", i + 1, portstatus);
1182 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
1184 /* EM interference sometimes causes bad shielded USB devices to
1185 * be shutdown by the hub, this hack enables them again.
1186 * Works at least with mouse driver */
1187 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1188 (portstatus & USB_PORT_STAT_CONNECTION) && (dev->children[i])) {
1189 USB_HUB_PRINTF("already running port %i disabled by hub (EMI?), re-enabling...\n",
1191 usb_hub_port_connect_change(dev, i);
1194 if (portstatus & USB_PORT_STAT_SUSPEND) {
1195 USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1196 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
1199 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1200 USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1201 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_OVER_CURRENT);
1202 usb_hub_power_on(hub);
1205 if (portchange & USB_PORT_STAT_C_RESET) {
1206 USB_HUB_PRINTF("port %d reset change\n", i + 1);
1207 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
1209 } /* end for i all ports */
1214 int usb_hub_probe(struct usb_device *dev, int ifnum)
1216 struct usb_interface_descriptor *iface;
1217 struct usb_endpoint_descriptor *ep;
1220 iface = &dev->config.if_desc[ifnum];
1222 if (iface->bInterfaceClass != USB_CLASS_HUB)
1224 /* Some hubs have a subclass of 1, which AFAICT according to the */
1225 /* specs is not defined, but it works */
1226 if ((iface->bInterfaceSubClass != 0) &&
1227 (iface->bInterfaceSubClass != 1))
1229 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1230 if (iface->bNumEndpoints != 1)
1232 ep = &iface->ep_desc[0];
1233 /* Output endpoint? Curiousier and curiousier.. */
1234 if (!(ep->bEndpointAddress & USB_DIR_IN))
1236 /* If it's not an interrupt endpoint, we'd better punt! */
1237 if ((ep->bmAttributes & 3) != 3)
1239 /* We found a hub */
1240 USB_HUB_PRINTF("USB hub found\n");
1241 ret=usb_hub_configure(dev);
1245 #endif /* (CONFIG_COMMANDS & CFG_CMD_USB) */