3 * Denis Peter, MPL AG Switzerland
5 * Most of this source has been derived from the Linux USB
8 * See file CREDITS for list of people who contributed to this
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31 * Since this is a bootloader, the devices will not be automatic
32 * (re)configured on hotplug, but after a restart of the USB the
35 * For each transfer (except "Interrupt") we wait for completion.
39 #include <asm/processor.h>
40 #include <linux/ctype.h>
42 #if (CONFIG_COMMANDS & CFG_CMD_USB)
46 #include <405gp_pci.h>
52 #define USB_PRINTF(fmt,args...) printf (fmt ,##args)
54 #define USB_PRINTF(fmt,args...)
57 #define USB_BUFSIZ 512
59 static struct usb_device usb_dev[USB_MAX_DEVICE];
62 static int asynch_allowed;
63 static struct devrequest setup_packet;
65 /**********************************************************************
66 * some forward declerations...
68 void usb_scan_devices(void);
70 int usb_hub_probe(struct usb_device *dev, int ifnum);
71 void usb_hub_reset(void);
74 /***********************************************************************
78 void __inline__ wait_ms(unsigned long ms)
83 /***************************************************************************
95 /* init low_level USB */
97 result = usb_lowlevel_init();
98 /* if lowlevel init is OK, scan the bus for devices i.e. search HUBs and configure them */
100 printf("scanning bus for devices... ");
106 printf("Error, couldn't init Lowlevel part\n");
111 /******************************************************************************
112 * Stop USB this stops the LowLevel Part and deregisters USB devices.
118 return usb_lowlevel_stop();
122 * disables the asynch behaviour of the control message. This is used for data
123 * transfers that uses the exclusiv access to the control and bulk messages.
125 void usb_disable_asynch(int disable)
127 asynch_allowed=!disable;
131 /*-------------------------------------------------------------------
137 * submits an Interrupt Message
139 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
140 void *buffer,int transfer_len, int interval)
142 return submit_int_msg(dev,pipe,buffer,transfer_len,interval);
146 * submits a control message and waits for comletion (at least timeout * 1ms)
147 * If timeout is 0, we don't wait for completion (used as example to set and
148 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
149 * allow control messages with 0 timeout, by previousely resetting the flag
150 * asynch_allowed (usb_disable_asynch(1)).
151 * returns the transfered length if OK or -1 if error. The transfered length
152 * and the current status are stored in the dev->act_len and dev->status.
154 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
155 unsigned char request, unsigned char requesttype,
156 unsigned short value, unsigned short index,
157 void *data, unsigned short size, int timeout)
159 if((timeout==0)&&(!asynch_allowed)) /* request for a asynch control pipe is not allowed */
162 /* set setup command */
163 setup_packet.requesttype = requesttype;
164 setup_packet.request = request;
165 setup_packet.value = swap_16(value);
166 setup_packet.index = swap_16(index);
167 setup_packet.length = swap_16(size);
168 USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X\nvalue 0x%X index 0x%X length 0x%X\n",
169 request,requesttype,value,index,size);
170 dev->status=USB_ST_NOT_PROC; /*not yet processed */
172 submit_control_msg(dev,pipe,data,size,&setup_packet);
177 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
188 /*-------------------------------------------------------------------
189 * submits bulk message, and waits for completion. returns 0 if Ok or
191 * synchronous behavior
193 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
194 void *data, int len, int *actual_length, int timeout)
198 dev->status=USB_ST_NOT_PROC; /*not yet processed */
199 submit_bulk_msg(dev,pipe,data,len);
201 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
205 *actual_length=dev->act_len;
213 /*-------------------------------------------------------------------
218 * returns the max packet size, depending on the pipe direction and
219 * the configurations values
221 int usb_maxpacket(struct usb_device *dev,unsigned long pipe)
223 if((pipe & USB_DIR_IN)==0) /* direction is out -> use emaxpacket out */
224 return(dev->epmaxpacketout[((pipe>>15) & 0xf)]);
226 return(dev->epmaxpacketin[((pipe>>15) & 0xf)]);
230 * set the max packed value of all endpoints in the given configuration
232 int usb_set_maxpacket(struct usb_device *dev)
235 struct usb_endpoint_descriptor *ep;
237 for(i=0; i<dev->config.bNumInterfaces;i++) {
238 for(ii=0; ii<dev->config.if_desc[i].bNumEndpoints; ii++) {
239 ep=&dev->config.if_desc[i].ep_desc[ii];
240 b=ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
242 if((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)==USB_ENDPOINT_XFER_CONTROL) { /* Control => bidirectional */
243 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
244 dev->epmaxpacketin [b] = ep->wMaxPacketSize;
245 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",b,dev->epmaxpacketin[b]);
248 if ((ep->bEndpointAddress & 0x80)==0) { /* OUT Endpoint */
249 if(ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
250 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
251 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",b,dev->epmaxpacketout[b]);
254 else { /* IN Endpoint */
255 if(ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
256 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
257 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",b,dev->epmaxpacketin[b]);
261 } /* for each endpoint */
266 /*******************************************************************************
267 * Parse the config, located in buffer, and fills the dev->config structure.
268 * Note that all little/big endian swapping are done automatically.
270 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
272 struct usb_descriptor_header *head;
278 head =(struct usb_descriptor_header *)&buffer[0];
279 if(head->bDescriptorType!=USB_DT_CONFIG) {
280 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",head->bDescriptorType);
283 memcpy(&dev->config,buffer,buffer[0]);
284 dev->config.wTotalLength=swap_16(dev->config.wTotalLength);
285 dev->config.no_of_if=0;
287 index=dev->config.bLength;
288 /* Ok the first entry must be a configuration entry, now process the others */
289 head=(struct usb_descriptor_header *)&buffer[index];
290 while(index+1 < dev->config.wTotalLength) {
291 switch(head->bDescriptorType) {
292 case USB_DT_INTERFACE:
293 ifno=dev->config.no_of_if;
294 dev->config.no_of_if++; /* found an interface desc, increase numbers */
295 memcpy(&dev->config.if_desc[ifno],&buffer[index],buffer[index]); /* copy new desc */
296 dev->config.if_desc[ifno].no_of_ep=0;
299 case USB_DT_ENDPOINT:
300 epno=dev->config.if_desc[ifno].no_of_ep;
301 dev->config.if_desc[ifno].no_of_ep++; /* found an endpoint */
302 memcpy(&dev->config.if_desc[ifno].ep_desc[epno],&buffer[index],buffer[index]);
303 dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize
304 =swap_16(dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize);
305 USB_PRINTF("if %d, ep %d\n",ifno,epno);
310 USB_PRINTF("unknown Description Type : %x\n",head->bDescriptorType);
314 ch=(unsigned char *)head;
315 for(i=0;i<head->bLength; i++)
316 USB_PRINTF("%02X ",*ch++);
317 USB_PRINTF("\n\n\n");
321 index+=head->bLength;
322 head=(struct usb_descriptor_header *)&buffer[index];
327 /***********************************************************************
329 * endp: endpoint number in bits 0-3;
330 * direction flag in bit 7 (1 = IN, 0 = OUT)
332 int usb_clear_halt(struct usb_device *dev, int pipe)
335 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
337 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
338 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
340 /* don't clear if failed */
345 * NOTE: we do not get status and verify reset was successful
346 * as some devices are reported to lock up upon this check..
349 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
351 /* toggle is reset on clear */
352 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
357 /**********************************************************************
358 * get_descriptor type
360 int usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)
363 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
364 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
365 (type << 8) + index, 0,
366 buf, size, USB_CNTL_TIMEOUT);
370 /**********************************************************************
371 * gets configuration cfgno and store it in the buffer
373 int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno)
377 struct usb_config_descriptor *config;
380 config=(struct usb_config_descriptor *)&buffer[0];
381 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 8);
384 printf("unable to get descriptor, error %lX\n",dev->status);
386 printf("config descriptor too short (expected %i, got %i)\n",8,result);
389 tmp=swap_16(config->wTotalLength);
391 if (tmp > USB_BUFSIZ) {
392 USB_PRINTF("usb_get_configuration_no: failed to get descriptor - too long: %d\n",
397 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
398 USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",cfgno,result,tmp);
402 /********************************************************************
403 * set address of a device to the value in dev->devnum.
404 * This can only be done by addressing the device via the default address (0)
406 int usb_set_address(struct usb_device *dev)
410 USB_PRINTF("set address %d\n",dev->devnum);
411 res=usb_control_msg(dev, usb_snddefctrl(dev),
412 USB_REQ_SET_ADDRESS, 0,
414 NULL,0, USB_CNTL_TIMEOUT);
418 /********************************************************************
419 * set interface number to interface
421 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
423 struct usb_interface_descriptor *if_face = NULL;
426 for (i = 0; i < dev->config.bNumInterfaces; i++) {
427 if (dev->config.if_desc[i].bInterfaceNumber == interface) {
428 if_face = &dev->config.if_desc[i];
433 printf("selecting invalid interface %d", interface);
437 if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
438 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, alternate,
439 interface, NULL, 0, USB_CNTL_TIMEOUT * 5)) < 0)
445 /********************************************************************
446 * set configuration number to configuration
448 int usb_set_configuration(struct usb_device *dev, int configuration)
451 USB_PRINTF("set configuration %d\n",configuration);
452 /* set setup command */
453 res=usb_control_msg(dev, usb_sndctrlpipe(dev,0),
454 USB_REQ_SET_CONFIGURATION, 0,
456 NULL,0, USB_CNTL_TIMEOUT);
466 /********************************************************************
467 * set protocol to protocol
469 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
471 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
472 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
473 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
476 /********************************************************************
479 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
481 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
482 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
483 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
486 /********************************************************************
489 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size)
491 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
492 USB_REQ_GET_REPORT, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
493 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
496 /********************************************************************
497 * get class descriptor
499 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
500 unsigned char type, unsigned char id, void *buf, int size)
502 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
503 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
504 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
507 /********************************************************************
508 * get string index in buffer
510 int usb_get_string(struct usb_device *dev, unsigned short langid, unsigned char index, void *buf, int size)
515 for (i = 0; i < 3; ++i) {
516 /* some devices are flaky */
517 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
518 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
519 (USB_DT_STRING << 8) + index, langid, buf, size,
530 static void usb_try_string_workarounds(unsigned char *buf, int *length)
532 int newlength, oldlength = *length;
534 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
535 if (!isprint(buf[newlength]) || buf[newlength + 1])
545 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
546 unsigned int index, unsigned char *buf)
550 /* Try to read the string descriptor by asking for the maximum
551 * possible number of bytes */
552 rc = usb_get_string(dev, langid, index, buf, 255);
554 /* If that failed try to read the descriptor length, then
555 * ask for just that many bytes */
557 rc = usb_get_string(dev, langid, index, buf, 2);
559 rc = usb_get_string(dev, langid, index, buf, buf[0]);
563 if (!buf[0] && !buf[1])
564 usb_try_string_workarounds(buf, &rc);
566 /* There might be extra junk at the end of the descriptor */
570 rc = rc - (rc & 1); /* force a multiple of two */
580 /********************************************************************
582 * Get string index and translate it to ascii.
583 * returns string length (> 0) or error (< 0)
585 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
587 unsigned char mybuf[USB_BUFSIZ];
592 if (size <= 0 || !buf || !index)
597 /* get langid for strings if it's not yet known */
598 if (!dev->have_langid) {
599 err = usb_string_sub(dev, 0, 0, tbuf);
601 USB_PRINTF("error getting string descriptor 0 (error=%x)\n",dev->status);
603 } else if (tbuf[0] < 4) {
604 USB_PRINTF("string descriptor 0 too short\n");
607 dev->have_langid = -1;
608 dev->string_langid = tbuf[2] | (tbuf[3]<< 8);
609 /* always use the first langid listed */
610 USB_PRINTF("USB device number %d default language ID 0x%x\n",
611 dev->devnum, dev->string_langid);
615 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
619 size--; /* leave room for trailing NULL char in output buffer */
620 for (idx = 0, u = 2; u < err; u += 2) {
623 if (tbuf[u+1]) /* high byte */
624 buf[idx++] = '?'; /* non-ASCII character */
626 buf[idx++] = tbuf[u];
634 /********************************************************************
635 * USB device handling:
636 * the USB device are static allocated [USB_MAX_DEVICE].
640 /* returns a pointer to the device with the index [index].
641 * if the device is not assigned (dev->devnum==-1) returns NULL
643 struct usb_device * usb_get_dev_index(int index)
645 if(usb_dev[index].devnum==-1)
648 return &usb_dev[index];
652 /* returns a pointer of a new device structure or NULL, if
653 * no device struct is available
655 struct usb_device * usb_alloc_new_device(void)
658 USB_PRINTF("New Device %d\n",dev_index);
659 if(dev_index==USB_MAX_DEVICE) {
660 printf("ERROR, too many USB Devices, max=%d\n",USB_MAX_DEVICE);
663 usb_dev[dev_index].devnum=dev_index+1; /* default Address is 0, real addresses start with 1 */
664 usb_dev[dev_index].maxchild=0;
665 for(i=0;i<USB_MAXCHILDREN;i++)
666 usb_dev[dev_index].children[i]=NULL;
667 usb_dev[dev_index].parent=NULL;
669 return &usb_dev[dev_index-1];
674 * By the time we get here, the device has gotten a new device ID
675 * and is in the default state. We need to identify the thing and
676 * get the ball rolling..
678 * Returns 0 for success, != 0 for error.
680 int usb_new_device(struct usb_device *dev)
684 unsigned char tmpbuf[USB_BUFSIZ];
686 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
687 dev->maxpacketsize = 0; /* Default to 8 byte max packet size */
688 dev->epmaxpacketin [0] = 8;
689 dev->epmaxpacketout[0] = 8;
691 /* We still haven't set the Address yet */
697 /* this is a Windows scheme of initialization sequence, with double
698 * reset of the device. Some equipment is said to work only with such
699 * init sequence; this patch is based on the work by Alan Stern:
700 * http://sourceforge.net/mailarchive/forum.php?thread_id=5729457&forum_id=5398
703 struct usb_device_descriptor *desc;
705 struct usb_device *parent = dev->parent;
706 unsigned short portstatus;
708 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
709 * only 18 bytes long, this will terminate with a short packet. But if
710 * the maxpacket size is 8 or 16 the device may be waiting to transmit
713 desc = (struct usb_device_descriptor *)tmpbuf;
714 desc->bMaxPacketSize0 = 0;
715 for (j = 0; j < 3; ++j) {
716 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
718 USB_PRINTF("usb_new_device: 64 byte descr\n");
722 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
724 /* find the port number we're at */
727 for (j = 0; j < parent->maxchild; j++) {
728 if (parent->children[j] == dev) {
734 printf("usb_new_device: cannot locate device's port..\n");
738 /* reset the port for the second time */
739 err = hub_port_reset(dev->parent, port, &portstatus);
741 printf("\n Couldn't reset port %i\n", port);
746 /* and this is the old and known way of initializing devices */
747 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
749 printf("\n USB device not responding, giving up (status=%lX)\n",dev->status);
754 dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
755 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
756 switch (dev->descriptor.bMaxPacketSize0) {
757 case 8: dev->maxpacketsize = 0; break;
758 case 16: dev->maxpacketsize = 1; break;
759 case 32: dev->maxpacketsize = 2; break;
760 case 64: dev->maxpacketsize = 3; break;
764 err = usb_set_address(dev); /* set address */
767 printf("\n USB device not accepting new address (error=%lX)\n", dev->status);
771 wait_ms(10); /* Let the SET_ADDRESS settle */
773 tmp = sizeof(dev->descriptor);
775 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, sizeof(dev->descriptor));
778 printf("unable to get device descriptor (error=%d)\n",err);
780 printf("USB device descriptor short read (expected %i, got %i)\n",tmp,err);
783 /* correct le values */
784 dev->descriptor.bcdUSB=swap_16(dev->descriptor.bcdUSB);
785 dev->descriptor.idVendor=swap_16(dev->descriptor.idVendor);
786 dev->descriptor.idProduct=swap_16(dev->descriptor.idProduct);
787 dev->descriptor.bcdDevice=swap_16(dev->descriptor.bcdDevice);
788 /* only support for one config for now */
789 usb_get_configuration_no(dev,&tmpbuf[0],0);
790 usb_parse_config(dev,&tmpbuf[0],0);
791 usb_set_maxpacket(dev);
792 /* we set the default configuration here */
793 if (usb_set_configuration(dev, dev->config.bConfigurationValue)) {
794 printf("failed to set default configuration len %d, status %lX\n",dev->act_len,dev->status);
797 USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
798 dev->descriptor.iManufacturer, dev->descriptor.iProduct, dev->descriptor.iSerialNumber);
799 memset(dev->mf, 0, sizeof(dev->mf));
800 memset(dev->prod, 0, sizeof(dev->prod));
801 memset(dev->serial, 0, sizeof(dev->serial));
802 if (dev->descriptor.iManufacturer)
803 usb_string(dev, dev->descriptor.iManufacturer, dev->mf, sizeof(dev->mf));
804 if (dev->descriptor.iProduct)
805 usb_string(dev, dev->descriptor.iProduct, dev->prod, sizeof(dev->prod));
806 if (dev->descriptor.iSerialNumber)
807 usb_string(dev, dev->descriptor.iSerialNumber, dev->serial, sizeof(dev->serial));
808 USB_PRINTF("Manufacturer %s\n", dev->mf);
809 USB_PRINTF("Product %s\n", dev->prod);
810 USB_PRINTF("SerialNumber %s\n", dev->serial);
811 /* now prode if the device is a hub */
812 usb_hub_probe(dev,0);
816 /* build device Tree */
817 void usb_scan_devices(void)
820 struct usb_device *dev;
822 /* first make all devices unknown */
823 for(i=0;i<USB_MAX_DEVICE;i++) {
824 memset(&usb_dev[i],0,sizeof(struct usb_device));
825 usb_dev[i].devnum=-1;
828 /* device 0 is always present (root hub, so let it analyze) */
829 dev=usb_alloc_new_device();
831 printf("%d USB Device(s) found\n",dev_index);
832 /* insert "driver" if possible */
833 #ifdef CONFIG_USB_KEYBOARD
835 USB_PRINTF("scan end\n");
840 /****************************************************************************
842 * Probes device for being a hub and configurate it
848 #define USB_HUB_PRINTF(fmt,args...) printf (fmt ,##args)
850 #define USB_HUB_PRINTF(fmt,args...)
854 static struct usb_hub_device hub_dev[USB_MAX_HUB];
855 static int usb_hub_index;
858 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
860 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
861 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
862 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
865 int usb_clear_hub_feature(struct usb_device *dev, int feature)
867 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
868 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, USB_CNTL_TIMEOUT);
871 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
873 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
874 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
877 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
879 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
880 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
883 int usb_get_hub_status(struct usb_device *dev, void *data)
885 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
886 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
887 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
890 int usb_get_port_status(struct usb_device *dev, int port, void *data)
892 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
893 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
894 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
898 static void usb_hub_power_on(struct usb_hub_device *hub)
901 struct usb_device *dev;
904 /* Enable power to the ports */
905 USB_HUB_PRINTF("enabling power on all ports\n");
906 for (i = 0; i < dev->maxchild; i++) {
907 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
908 USB_HUB_PRINTF("port %d returns %lX\n",i+1,dev->status);
909 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
913 void usb_hub_reset(void)
918 struct usb_hub_device *usb_hub_allocate(void)
920 if(usb_hub_index<USB_MAX_HUB) {
921 return &hub_dev[usb_hub_index++];
923 printf("ERROR: USB_MAX_HUB (%d) reached\n",USB_MAX_HUB);
929 static int hub_port_reset(struct usb_device *dev, int port,
930 unsigned short *portstat)
933 struct usb_port_status portsts;
934 unsigned short portstatus, portchange;
937 USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
938 for(tries=0;tries<MAX_TRIES;tries++) {
940 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
943 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
944 USB_HUB_PRINTF("get_port_status failed status %lX\n",dev->status);
947 portstatus = swap_16(portsts.wPortStatus);
948 portchange = swap_16(portsts.wPortChange);
949 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus ,portchange,
950 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
951 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d USB_PORT_STAT_ENABLE %d\n",
952 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
953 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
954 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
955 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
956 !(portstatus & USB_PORT_STAT_CONNECTION))
959 if (portstatus & USB_PORT_STAT_ENABLE) {
967 if (tries==MAX_TRIES) {
968 USB_HUB_PRINTF("Cannot enable port %i after %i retries, disabling port.\n", port+1, MAX_TRIES);
969 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
973 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
974 *portstat = portstatus;
980 void usb_hub_port_connect_change(struct usb_device *dev, int port)
982 struct usb_device *usb;
983 struct usb_port_status portsts;
984 unsigned short portstatus, portchange;
987 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
988 USB_HUB_PRINTF("get_port_status failed\n");
992 portstatus = swap_16(portsts.wPortStatus);
993 portchange = swap_16(portsts.wPortChange);
994 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus, portchange,
995 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
997 /* Clear the connection change status */
998 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
1000 /* Disconnect any existing devices under this port */
1001 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
1002 (!(portstatus & USB_PORT_STAT_ENABLE)))|| (dev->children[port])) {
1003 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
1004 /* Return now if nothing is connected */
1005 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1010 /* Reset the port */
1011 if (hub_port_reset(dev, port, &portstatus) < 0) {
1012 printf("cannot reset port %i!?\n", port + 1);
1018 /* Allocate a new device struct for it */
1019 usb=usb_alloc_new_device();
1020 usb->slow = (portstatus & USB_PORT_STAT_LOW_SPEED) ? 1 : 0;
1022 dev->children[port] = usb;
1024 /* Run it through the hoops (find a driver, etc) */
1025 if (usb_new_device(usb)) {
1026 /* Woops, disable the port */
1027 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
1028 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
1033 int usb_hub_configure(struct usb_device *dev)
1035 unsigned char buffer[USB_BUFSIZ], *bitmap;
1036 struct usb_hub_descriptor *descriptor;
1037 struct usb_hub_status *hubsts;
1039 struct usb_hub_device *hub;
1041 /* "allocate" Hub device */
1042 hub=usb_hub_allocate();
1046 /* Get the the hub descriptor */
1047 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
1048 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor, giving up %lX\n",dev->status);
1051 descriptor = (struct usb_hub_descriptor *)buffer;
1053 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
1054 i = descriptor->bLength;
1055 if (i > USB_BUFSIZ) {
1056 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor - too long: %d\N",
1057 descriptor->bLength);
1061 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
1062 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor 2nd giving up %lX\n",dev->status);
1065 memcpy((unsigned char *)&hub->desc,buffer,descriptor->bLength);
1066 /* adjust 16bit values */
1067 hub->desc.wHubCharacteristics=swap_16(descriptor->wHubCharacteristics);
1068 /* set the bitmap */
1069 bitmap=(unsigned char *)&hub->desc.DeviceRemovable[0];
1070 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* devices not removable by default */
1071 bitmap=(unsigned char *)&hub->desc.PortPowerCtrlMask[0];
1072 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
1073 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1074 hub->desc.DeviceRemovable[i]=descriptor->DeviceRemovable[i];
1076 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
1077 hub->desc.DeviceRemovable[i]=descriptor->PortPowerCtrlMask[i];
1079 dev->maxchild = descriptor->bNbrPorts;
1080 USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
1082 switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
1084 USB_HUB_PRINTF("ganged power switching\n");
1087 USB_HUB_PRINTF("individual port power switching\n");
1091 USB_HUB_PRINTF("unknown reserved power switching mode\n");
1095 if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
1096 USB_HUB_PRINTF("part of a compound device\n");
1098 USB_HUB_PRINTF("standalone hub\n");
1100 switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
1102 USB_HUB_PRINTF("global over-current protection\n");
1105 USB_HUB_PRINTF("individual port over-current protection\n");
1109 USB_HUB_PRINTF("no over-current protection\n");
1112 USB_HUB_PRINTF("power on to power good time: %dms\n", descriptor->bPwrOn2PwrGood * 2);
1113 USB_HUB_PRINTF("hub controller current requirement: %dmA\n", descriptor->bHubContrCurrent);
1114 for (i = 0; i < dev->maxchild; i++)
1115 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
1116 hub->desc.DeviceRemovable[(i + 1)/8] & (1 << ((i + 1)%8)) ? " not" : "");
1117 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
1118 USB_HUB_PRINTF("usb_hub_configure: failed to get Status - too long: %d\n",
1119 descriptor->bLength);
1123 if (usb_get_hub_status(dev, buffer) < 0) {
1124 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",dev->status);
1127 hubsts = (struct usb_hub_status *)buffer;
1128 USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
1129 swap_16(hubsts->wHubStatus),swap_16(hubsts->wHubChange));
1130 USB_HUB_PRINTF("local power source is %s\n",
1131 (swap_16(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? "lost (inactive)" : "good");
1132 USB_HUB_PRINTF("%sover-current condition exists\n",
1133 (swap_16(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1134 usb_hub_power_on(hub);
1135 for (i = 0; i < dev->maxchild; i++) {
1136 struct usb_port_status portsts;
1137 unsigned short portstatus, portchange;
1139 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
1140 USB_HUB_PRINTF("get_port_status failed\n");
1143 portstatus = swap_16(portsts.wPortStatus);
1144 portchange = swap_16(portsts.wPortChange);
1145 USB_HUB_PRINTF("Port %d Status %X Change %X\n",i+1,portstatus,portchange);
1146 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1147 USB_HUB_PRINTF("port %d connection change\n", i + 1);
1148 usb_hub_port_connect_change(dev, i);
1150 if (portchange & USB_PORT_STAT_C_ENABLE) {
1151 USB_HUB_PRINTF("port %d enable change, status %x\n", i + 1, portstatus);
1152 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
1154 /* EM interference sometimes causes bad shielded USB devices to
1155 * be shutdown by the hub, this hack enables them again.
1156 * Works at least with mouse driver */
1157 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1158 (portstatus & USB_PORT_STAT_CONNECTION) && (dev->children[i])) {
1159 USB_HUB_PRINTF("already running port %i disabled by hub (EMI?), re-enabling...\n",
1161 usb_hub_port_connect_change(dev, i);
1164 if (portstatus & USB_PORT_STAT_SUSPEND) {
1165 USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1166 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
1169 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1170 USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1171 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_OVER_CURRENT);
1172 usb_hub_power_on(hub);
1175 if (portchange & USB_PORT_STAT_C_RESET) {
1176 USB_HUB_PRINTF("port %d reset change\n", i + 1);
1177 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
1179 } /* end for i all ports */
1184 int usb_hub_probe(struct usb_device *dev, int ifnum)
1186 struct usb_interface_descriptor *iface;
1187 struct usb_endpoint_descriptor *ep;
1190 iface = &dev->config.if_desc[ifnum];
1192 if (iface->bInterfaceClass != USB_CLASS_HUB)
1194 /* Some hubs have a subclass of 1, which AFAICT according to the */
1195 /* specs is not defined, but it works */
1196 if ((iface->bInterfaceSubClass != 0) &&
1197 (iface->bInterfaceSubClass != 1))
1199 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1200 if (iface->bNumEndpoints != 1)
1202 ep = &iface->ep_desc[0];
1203 /* Output endpoint? Curiousier and curiousier.. */
1204 if (!(ep->bEndpointAddress & USB_DIR_IN))
1206 /* If it's not an interrupt endpoint, we'd better punt! */
1207 if ((ep->bmAttributes & 3) != 3)
1209 /* We found a hub */
1210 USB_HUB_PRINTF("USB hub found\n");
1211 ret=usb_hub_configure(dev);
1215 #endif /* (CONFIG_COMMANDS & CFG_CMD_USB) */