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,
32 * Since this is a bootloader, the devices will not be automatic
33 * (re)configured on hotplug, but after a restart of the USB the
36 * For each transfer (except "Interrupt") we wait for completion.
40 #include <asm/processor.h>
42 #if (CONFIG_COMMANDS & CFG_CMD_USB)
46 #include <405gp_pci.h>
53 #define USB_PRINTF(fmt,args...) printf (fmt ,##args)
55 #define USB_PRINTF(fmt,args...)
58 static struct usb_device usb_dev[USB_MAX_DEVICE];
61 static int asynch_allowed;
62 static struct devrequest setup_packet;
64 /**********************************************************************
65 * some forward declerations...
67 void usb_scan_devices(void);
69 int usb_hub_probe(struct usb_device *dev, int ifnum);
70 void usb_hub_reset(void);
72 /***********************************************************************
76 void __inline__ wait_ms(unsigned long ms)
81 /***************************************************************************
93 /* init low_level USB */
95 result = usb_lowlevel_init();
96 /* if lowlevel init is OK, scan the bus for devices i.e. search HUBs and configure them */
98 printf("scanning bus for devices... ");
104 printf("Error, couldn't init Lowlevel part\n");
109 /******************************************************************************
110 * Stop USB this stops the LowLevel Part and deregisters USB devices.
116 return usb_lowlevel_stop();
120 * disables the asynch behaviour of the control message. This is used for data
121 * transfers that uses the exclusiv access to the control and bulk messages.
123 void usb_disable_asynch(int disable)
125 asynch_allowed=!disable;
129 /*-------------------------------------------------------------------
135 * submits an Interrupt Message
137 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
138 void *buffer,int transfer_len, int interval)
140 return submit_int_msg(dev,pipe,buffer,transfer_len,interval);
144 * submits a control message and waits for comletion (at least timeout * 1ms)
145 * If timeout is 0, we don't wait for completion (used as example to set and
146 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
147 * allow control messages with 0 timeout, by previousely resetting the flag
148 * asynch_allowed (usb_disable_asynch(1)).
149 * returns the transfered length if OK or -1 if error. The transfered length
150 * and the current status are stored in the dev->act_len and dev->status.
152 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
153 unsigned char request, unsigned char requesttype,
154 unsigned short value, unsigned short index,
155 void *data, unsigned short size, int timeout)
157 if((timeout==0)&&(!asynch_allowed)) /* request for a asynch control pipe is not allowed */
159 /* set setup command */
160 setup_packet.requesttype = requesttype;
161 setup_packet.request = request;
162 setup_packet.value = swap_16(value);
163 setup_packet.index = swap_16(index);
164 setup_packet.length = swap_16(size);
165 USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X\nvalue 0x%X index 0x%X length 0x%X\n",
166 request,requesttype,value,index,size);
167 dev->status=USB_ST_NOT_PROC; /*not yet processed */
169 submit_control_msg(dev,pipe,data,size,&setup_packet);
174 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
185 /*-------------------------------------------------------------------
186 * submits bulk message, and waits for completion. returns 0 if Ok or
188 * synchronous behavior
190 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
191 void *data, int len, int *actual_length, int timeout)
195 dev->status=USB_ST_NOT_PROC; /*not yet processed */
196 submit_bulk_msg(dev,pipe,data,len);
198 if(!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
202 *actual_length=dev->act_len;
210 /*-------------------------------------------------------------------
215 * returns the max packet size, depending on the pipe direction and
216 * the configurations values
218 int usb_maxpacket(struct usb_device *dev,unsigned long pipe)
220 if((pipe & USB_DIR_IN)==0) /* direction is out -> use emaxpacket out */
221 return(dev->epmaxpacketout[((pipe>>15) & 0xf)]);
223 return(dev->epmaxpacketin[((pipe>>15) & 0xf)]);
227 * set the max packed value of all endpoints in the given configuration
229 int usb_set_maxpacket(struct usb_device *dev)
232 struct usb_endpoint_descriptor *ep;
234 for(i=0; i<dev->config.bNumInterfaces;i++) {
235 for(ii=0; ii<dev->config.if_desc[i].bNumEndpoints; ii++) {
236 ep=&dev->config.if_desc[i].ep_desc[ii];
237 b=ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
239 if((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)==USB_ENDPOINT_XFER_CONTROL) { /* Control => bidirectional */
240 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
241 dev->epmaxpacketin [b] = ep->wMaxPacketSize;
242 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",b,dev->epmaxpacketin[b]);
245 if ((ep->bEndpointAddress & 0x80)==0) { /* OUT Endpoint */
246 if(ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
247 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
248 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",b,dev->epmaxpacketout[b]);
251 else { /* IN Endpoint */
252 if(ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
253 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
254 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",b,dev->epmaxpacketin[b]);
258 } /* for each endpoint */
263 /*******************************************************************************
264 * Parse the config, located in buffer, and fills the dev->config structure.
265 * Note that all little/big endian swapping are done automatically.
267 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
269 struct usb_descriptor_header *head;
275 head =(struct usb_descriptor_header *)&buffer[0];
276 if(head->bDescriptorType!=USB_DT_CONFIG) {
277 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",head->bDescriptorType);
280 memcpy(&dev->config,buffer,buffer[0]);
281 dev->config.wTotalLength=swap_16(dev->config.wTotalLength);
282 dev->config.no_of_if=0;
284 index=dev->config.bLength;
285 /* Ok the first entry must be a configuration entry, now process the others */
286 head=(struct usb_descriptor_header *)&buffer[index];
287 while(index+1 < dev->config.wTotalLength) {
288 switch(head->bDescriptorType) {
289 case USB_DT_INTERFACE:
290 ifno=dev->config.no_of_if;
291 dev->config.no_of_if++; /* found an interface desc, increase numbers */
292 memcpy(&dev->config.if_desc[ifno],&buffer[index],buffer[index]); /* copy new desc */
293 dev->config.if_desc[ifno].no_of_ep=0;
296 case USB_DT_ENDPOINT:
297 epno=dev->config.if_desc[ifno].no_of_ep;
298 dev->config.if_desc[ifno].no_of_ep++; /* found an endpoint */
299 memcpy(&dev->config.if_desc[ifno].ep_desc[epno],&buffer[index],buffer[index]);
300 dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize
301 =swap_16(dev->config.if_desc[ifno].ep_desc[epno].wMaxPacketSize);
302 USB_PRINTF("if %d, ep %d\n",ifno,epno);
307 USB_PRINTF("unknown Description Type : %x\n",head->bDescriptorType);
311 ch=(unsigned char *)head;
312 for(i=0;i<head->bLength; i++)
313 USB_PRINTF("%02X ",*ch++);
314 USB_PRINTF("\n\n\n");
318 index+=head->bLength;
319 head=(struct usb_descriptor_header *)&buffer[index];
324 /***********************************************************************
326 * endp: endpoint number in bits 0-3;
327 * direction flag in bit 7 (1 = IN, 0 = OUT)
329 int usb_clear_halt(struct usb_device *dev, int pipe)
332 unsigned short status;
333 int endp=usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
335 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
336 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
338 /* don't clear if failed */
341 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
342 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RECIP_ENDPOINT, 0, endp,
343 &status, sizeof(status), USB_CNTL_TIMEOUT * 3);
346 USB_PRINTF("usb_clear_halt: status 0x%x\n",status);
348 return -1; /* still halted */
349 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
350 /* toggle is reset on clear */
351 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
356 /**********************************************************************
357 * get_descriptor type
359 int usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)
362 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
363 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
364 (type << 8) + index, 0,
365 buf, size, USB_CNTL_TIMEOUT);
369 /**********************************************************************
370 * gets configuration cfgno and store it in the buffer
372 int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno)
376 struct usb_config_descriptor *config;
379 config=(struct usb_config_descriptor *)&buffer[0];
380 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 8);
383 printf("unable to get descriptor, error %lX\n",dev->status);
385 printf("config descriptor too short (expected %i, got %i)\n",8,result);
388 tmp=swap_16(config->wTotalLength);
390 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
391 USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",cfgno,result,tmp);
395 /********************************************************************
396 * set address of a device to the value in dev->devnum.
397 * This can only be done by addressing the device via the default address (0)
399 int usb_set_address(struct usb_device *dev)
403 USB_PRINTF("set address %d\n",dev->devnum);
404 res=usb_control_msg(dev, usb_snddefctrl(dev),
405 USB_REQ_SET_ADDRESS, 0,
407 NULL,0, USB_CNTL_TIMEOUT);
411 /********************************************************************
412 * set interface number to interface
414 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
416 struct usb_interface_descriptor *if_face = NULL;
419 for (i=0; i<dev->config.bNumInterfaces; i++) {
420 if (dev->config.if_desc[i].bInterfaceNumber == interface) {
421 if_face = &dev->config.if_desc[i];
426 printf("selecting invalid interface %d", interface);
430 if ((ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
431 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, alternate,
432 interface, NULL, 0, USB_CNTL_TIMEOUT * 5)) < 0)
435 if_face->act_altsetting = (unsigned char)alternate;
436 usb_set_maxpacket(dev);
440 /********************************************************************
441 * set configuration number to configuration
443 int usb_set_configuration(struct usb_device *dev, int configuration)
446 USB_PRINTF("set configuration %d\n",configuration);
447 /* set setup command */
448 res=usb_control_msg(dev, usb_sndctrlpipe(dev,0),
449 USB_REQ_SET_CONFIGURATION, 0,
451 NULL,0, USB_CNTL_TIMEOUT);
461 /********************************************************************
462 * set protocol to protocol
464 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
466 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
467 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
468 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
471 /********************************************************************
474 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
476 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
477 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
478 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
481 /********************************************************************
484 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size)
486 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
487 USB_REQ_GET_REPORT, USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
488 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
491 /********************************************************************
492 * get class descriptor
494 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
495 unsigned char type, unsigned char id, void *buf, int size)
497 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
498 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
499 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
502 /********************************************************************
503 * get string index in buffer
505 int usb_get_string(struct usb_device *dev, unsigned short langid, unsigned char index, void *buf, int size)
507 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
508 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
509 (USB_DT_STRING << 8) + index, langid, buf, size, USB_CNTL_TIMEOUT);
512 /********************************************************************
514 * Get string index and translate it to ascii.
515 * returns string length (> 0) or error (< 0)
517 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
520 unsigned char mybuf[256];
525 if (size <= 0 || !buf || !index)
530 /* get langid for strings if it's not yet known */
531 if (!dev->have_langid) {
532 err = usb_get_string(dev, 0, 0, tbuf, 4);
534 USB_PRINTF("error getting string descriptor 0 (error=%x)\n",dev->status);
536 } else if (tbuf[0] < 4) {
537 USB_PRINTF("string descriptor 0 too short\n");
540 dev->have_langid = -1;
541 dev->string_langid = tbuf[2] | (tbuf[3]<< 8);
542 /* always use the first langid listed */
543 USB_PRINTF("USB device number %d default language ID 0x%x\n",
544 dev->devnum, dev->string_langid);
547 /* Just ask for a maximum length string and then take the length
548 * that was returned. */
549 err = usb_get_string(dev, dev->string_langid, index, tbuf, 4);
553 USB_PRINTF("Strn Len %d, index %d\n",u,index);
554 err = usb_get_string(dev, dev->string_langid, index, tbuf, u);
557 size--; /* leave room for trailing NULL char in output buffer */
558 for (idx = 0, u = 2; u < err; u += 2) {
561 if (tbuf[u+1]) /* high byte */
562 buf[idx++] = '?'; /* non-ASCII character */
564 buf[idx++] = tbuf[u];
572 /********************************************************************
573 * USB device handling:
574 * the USB device are static allocated [USB_MAX_DEVICE].
578 /* returns a pointer to the device with the index [index].
579 * if the device is not assigned (dev->devnum==-1) returns NULL
581 struct usb_device * usb_get_dev_index(int index)
583 if(usb_dev[index].devnum==-1)
586 return &usb_dev[index];
590 /* returns a pointer of a new device structure or NULL, if
591 * no device struct is available
593 struct usb_device * usb_alloc_new_device(void)
596 USB_PRINTF("New Device %d\n",dev_index);
597 if(dev_index==USB_MAX_DEVICE) {
598 printf("ERROR, too many USB Devices, max=%d\n",USB_MAX_DEVICE);
601 usb_dev[dev_index].devnum=dev_index+1; /* default Address is 0, real addresses start with 1 */
602 usb_dev[dev_index].maxchild=0;
603 for(i=0;i<USB_MAXCHILDREN;i++)
604 usb_dev[dev_index].children[i]=NULL;
605 usb_dev[dev_index].parent=NULL;
607 return &usb_dev[dev_index-1];
612 * By the time we get here, the device has gotten a new device ID
613 * and is in the default state. We need to identify the thing and
614 * get the ball rolling..
616 * Returns 0 for success, != 0 for error.
618 int usb_new_device(struct usb_device *dev)
622 unsigned char tmpbuf[256];
624 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
625 dev->maxpacketsize = 0; /* Default to 8 byte max packet size */
626 dev->epmaxpacketin [0] = 8;
627 dev->epmaxpacketout[0] = 8;
629 /* We still haven't set the Address yet */
632 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
634 printf("\n USB device not responding, giving up (status=%lX)\n",dev->status);
637 dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
638 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
639 switch (dev->descriptor.bMaxPacketSize0) {
640 case 8: dev->maxpacketsize = 0; break;
641 case 16: dev->maxpacketsize = 1; break;
642 case 32: dev->maxpacketsize = 2; break;
643 case 64: dev->maxpacketsize = 3; break;
647 err = usb_set_address(dev); /* set address */
650 printf("\n USB device not accepting new address (error=%lX)\n", dev->status);
654 wait_ms(10); /* Let the SET_ADDRESS settle */
656 tmp = sizeof(dev->descriptor);
658 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, sizeof(dev->descriptor));
661 printf("unable to get device descriptor (error=%d)\n",err);
663 printf("USB device descriptor short read (expected %i, got %i)\n",tmp,err);
666 /* correct le values */
667 dev->descriptor.bcdUSB=swap_16(dev->descriptor.bcdUSB);
668 dev->descriptor.idVendor=swap_16(dev->descriptor.idVendor);
669 dev->descriptor.idProduct=swap_16(dev->descriptor.idProduct);
670 dev->descriptor.bcdDevice=swap_16(dev->descriptor.bcdDevice);
671 /* only support for one config for now */
672 usb_get_configuration_no(dev,&tmpbuf[0],0);
673 usb_parse_config(dev,&tmpbuf[0],0);
674 usb_set_maxpacket(dev);
675 /* we set the default configuration here */
676 if (usb_set_configuration(dev, dev->config.bConfigurationValue)) {
677 printf("failed to set default configuration len %d, status %lX\n",dev->act_len,dev->status);
680 USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
681 dev->descriptor.iManufacturer, dev->descriptor.iProduct, dev->descriptor.iSerialNumber);
682 memset(dev->mf, 0, sizeof(dev->mf));
683 memset(dev->prod, 0, sizeof(dev->prod));
684 memset(dev->serial, 0, sizeof(dev->serial));
685 if (dev->descriptor.iManufacturer)
686 usb_string(dev, dev->descriptor.iManufacturer, dev->mf, sizeof(dev->mf));
687 if (dev->descriptor.iProduct)
688 usb_string(dev, dev->descriptor.iProduct, dev->prod, sizeof(dev->prod));
689 if (dev->descriptor.iSerialNumber)
690 usb_string(dev, dev->descriptor.iSerialNumber, dev->serial, sizeof(dev->serial));
691 USB_PRINTF("Manufacturer %s\n", dev->mf);
692 USB_PRINTF("Product %s\n", dev->prod);
693 USB_PRINTF("SerialNumber %s\n", dev->serial);
694 /* now prode if the device is a hub */
695 usb_hub_probe(dev,0);
699 /* build device Tree */
700 void usb_scan_devices(void)
703 struct usb_device *dev;
705 /* first make all devices unknown */
706 for(i=0;i<USB_MAX_DEVICE;i++) {
707 memset(&usb_dev[i],0,sizeof(struct usb_device));
708 usb_dev[i].devnum=-1;
711 /* device 0 is always present (root hub, so let it analyze) */
712 dev=usb_alloc_new_device();
714 printf("%d USB Devices found\n",dev_index);
715 /* insert "driver" if possible */
716 #ifdef CONFIG_USB_KEYBOARD
718 USB_PRINTF("scan end\n");
723 /****************************************************************************
725 * Probes device for being a hub and configurate it
731 #define USB_HUB_PRINTF(fmt,args...) printf (fmt ,##args)
733 #define USB_HUB_PRINTF(fmt,args...)
737 static struct usb_hub_device hub_dev[USB_MAX_HUB];
738 static int usb_hub_index;
741 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
743 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
744 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
745 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
748 int usb_clear_hub_feature(struct usb_device *dev, int feature)
750 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
751 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, USB_CNTL_TIMEOUT);
754 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
756 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
757 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
760 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
762 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
763 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port, NULL, 0, USB_CNTL_TIMEOUT);
766 int usb_get_hub_status(struct usb_device *dev, void *data)
768 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
769 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
770 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
773 int usb_get_port_status(struct usb_device *dev, int port, void *data)
775 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
776 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
777 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
781 static void usb_hub_power_on(struct usb_hub_device *hub)
784 struct usb_device *dev;
787 /* Enable power to the ports */
788 USB_HUB_PRINTF("enabling power on all ports\n");
789 for (i = 0; i < dev->maxchild; i++) {
790 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
791 USB_HUB_PRINTF("port %d returns %lX\n",i+1,dev->status);
792 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
796 void usb_hub_reset(void)
801 struct usb_hub_device *usb_hub_allocate(void)
803 if(usb_hub_index<USB_MAX_HUB) {
804 return &hub_dev[usb_hub_index++];
806 printf("ERROR: USB_MAX_HUB (%d) reached\n",USB_MAX_HUB);
812 void usb_hub_port_connect_change(struct usb_device *dev, int port)
814 struct usb_device *usb;
815 struct usb_port_status portsts;
816 unsigned short portstatus, portchange;
820 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
821 USB_HUB_PRINTF("get_port_status failed\n");
825 portstatus = swap_16(portsts.wPortStatus);
826 portchange = swap_16(portsts.wPortChange);
827 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus, portchange,
828 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
830 /* Clear the connection change status */
831 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
833 /* Disconnect any existing devices under this port */
834 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
835 (!(portstatus & USB_PORT_STAT_ENABLE)))|| (dev->children[port])) {
836 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
837 /* Return now if nothing is connected */
838 if (!(portstatus & USB_PORT_STAT_CONNECTION))
845 for(tries=0;tries<MAX_TRIES;tries++) {
847 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
850 if (usb_get_port_status(dev, port + 1, &portsts)<0) {
851 USB_HUB_PRINTF("get_port_status failed status %lX\n",dev->status);
854 portstatus = swap_16(portsts.wPortStatus);
855 portchange = swap_16(portsts.wPortChange);
856 USB_HUB_PRINTF("portstatus %x, change %x, %s\n", portstatus ,portchange,
857 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? "Low Speed" : "High Speed");
858 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d USB_PORT_STAT_ENABLE %d\n",
859 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
860 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
861 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
862 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
863 !(portstatus & USB_PORT_STAT_CONNECTION))
866 if (portstatus & USB_PORT_STAT_ENABLE)
872 if (tries==MAX_TRIES) {
873 USB_HUB_PRINTF("Cannot enable port %i after %i retries, disabling port.\n", port+1, MAX_TRIES);
874 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
878 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
881 /* Allocate a new device struct for it */
882 usb=usb_alloc_new_device();
883 usb->slow = (portstatus & USB_PORT_STAT_LOW_SPEED) ? 1 : 0;
885 dev->children[port] = usb;
887 /* Run it through the hoops (find a driver, etc) */
888 if (usb_new_device(usb)) {
889 /* Woops, disable the port */
890 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
891 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
896 int usb_hub_configure(struct usb_device *dev)
898 unsigned char buffer[256], *bitmap;
899 struct usb_hub_descriptor *descriptor;
900 struct usb_hub_status *hubsts;
902 struct usb_hub_device *hub;
904 /* "allocate" Hub device */
905 hub=usb_hub_allocate();
909 /* Get the the hub descriptor */
910 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
911 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor, giving up %lX\n",dev->status);
914 descriptor = (struct usb_hub_descriptor *)buffer;
915 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
916 USB_HUB_PRINTF("usb_hub_configure: failed to get hub descriptor 2nd giving up %lX\n",dev->status);
919 memcpy((unsigned char *)&hub->desc,buffer,descriptor->bLength);
920 /* adjust 16bit values */
921 hub->desc.wHubCharacteristics=swap_16(descriptor->wHubCharacteristics);
923 bitmap=(unsigned char *)&hub->desc.DeviceRemovable[0];
924 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* devices not removable by default */
925 bitmap=(unsigned char *)&hub->desc.PortPowerCtrlMask[0];
926 memset(bitmap,0xff,(USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
927 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
928 hub->desc.DeviceRemovable[i]=descriptor->DeviceRemovable[i];
930 for(i=0;i<((hub->desc.bNbrPorts + 1 + 7)/8);i++) {
931 hub->desc.DeviceRemovable[i]=descriptor->PortPowerCtrlMask[i];
933 dev->maxchild = descriptor->bNbrPorts;
934 USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
936 switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
938 USB_HUB_PRINTF("ganged power switching\n");
941 USB_HUB_PRINTF("individual port power switching\n");
945 USB_HUB_PRINTF("unknown reserved power switching mode\n");
949 if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
950 USB_HUB_PRINTF("part of a compound device\n");
952 USB_HUB_PRINTF("standalone hub\n");
954 switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
956 USB_HUB_PRINTF("global over-current protection\n");
959 USB_HUB_PRINTF("individual port over-current protection\n");
963 USB_HUB_PRINTF("no over-current protection\n");
966 USB_HUB_PRINTF("power on to power good time: %dms\n", descriptor->bPwrOn2PwrGood * 2);
967 USB_HUB_PRINTF("hub controller current requirement: %dmA\n", descriptor->bHubContrCurrent);
968 for (i = 0; i < dev->maxchild; i++)
969 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
970 hub->desc.DeviceRemovable[(i + 1)/8] & (1 << ((i + 1)%8)) ? " not" : "");
971 if (usb_get_hub_status(dev, buffer) < 0) {
972 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",dev->status);
975 hubsts = (struct usb_hub_status *)buffer;
976 USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
977 swap_16(hubsts->wHubStatus),swap_16(hubsts->wHubChange));
978 USB_HUB_PRINTF("local power source is %s\n",
979 (swap_16(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? "lost (inactive)" : "good");
980 USB_HUB_PRINTF("%sover-current condition exists\n",
981 (swap_16(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? "" : "no ");
982 usb_hub_power_on(hub);
983 for (i = 0; i < dev->maxchild; i++) {
984 struct usb_port_status portsts;
985 unsigned short portstatus, portchange;
987 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
988 USB_HUB_PRINTF("get_port_status failed\n");
991 portstatus = swap_16(portsts.wPortStatus);
992 portchange = swap_16(portsts.wPortChange);
993 USB_HUB_PRINTF("Port %d Status %X Change %X\n",i+1,portstatus,portchange);
994 if (portchange & USB_PORT_STAT_C_CONNECTION) {
995 USB_HUB_PRINTF("port %d connection change\n", i + 1);
996 usb_hub_port_connect_change(dev, i);
998 if (portchange & USB_PORT_STAT_C_ENABLE) {
999 USB_HUB_PRINTF("port %d enable change, status %x\n", i + 1, portstatus);
1000 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
1002 /* EM interference sometimes causes bad shielded USB devices to
1003 * be shutdown by the hub, this hack enables them again.
1004 * Works at least with mouse driver */
1005 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1006 (portstatus & USB_PORT_STAT_CONNECTION) && (dev->children[i])) {
1007 USB_HUB_PRINTF("already running port %i disabled by hub (EMI?), re-enabling...\n",
1009 usb_hub_port_connect_change(dev, i);
1012 if (portstatus & USB_PORT_STAT_SUSPEND) {
1013 USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1014 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
1017 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1018 USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1019 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_OVER_CURRENT);
1020 usb_hub_power_on(hub);
1023 if (portchange & USB_PORT_STAT_C_RESET) {
1024 USB_HUB_PRINTF("port %d reset change\n", i + 1);
1025 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
1027 } /* end for i all ports */
1032 int usb_hub_probe(struct usb_device *dev, int ifnum)
1034 struct usb_interface_descriptor *iface;
1035 struct usb_endpoint_descriptor *ep;
1038 iface = &dev->config.if_desc[ifnum];
1040 if (iface->bInterfaceClass != USB_CLASS_HUB)
1042 /* Some hubs have a subclass of 1, which AFAICT according to the */
1043 /* specs is not defined, but it works */
1044 if ((iface->bInterfaceSubClass != 0) &&
1045 (iface->bInterfaceSubClass != 1))
1047 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1048 if (iface->bNumEndpoints != 1)
1050 ep = &iface->ep_desc[0];
1051 /* Output endpoint? Curiousier and curiousier.. */
1052 if (!(ep->bEndpointAddress & USB_DIR_IN))
1054 /* If it's not an interrupt endpoint, we'd better punt! */
1055 if ((ep->bmAttributes & 3) != 3)
1057 /* We found a hub */
1058 USB_HUB_PRINTF("USB hub found\n");
1059 ret=usb_hub_configure(dev);
1063 #endif /* (CONFIG_COMMANDS & CFG_CMD_USB) */