3 * Most of this source has been derived from the Linux USB
5 * (C) Copyright Linus Torvalds 1999
6 * (C) Copyright Johannes Erdfelt 1999-2001
7 * (C) Copyright Andreas Gal 1999
8 * (C) Copyright Gregory P. Smith 1999
9 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
10 * (C) Copyright Randy Dunlap 2000
11 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
12 * (C) Copyright Yggdrasil Computing, Inc. 2000
13 * (usb_device_id matching changes by Adam J. Richter)
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
18 * See file CREDITS for list of people who contributed to this
21 * This program is free software; you can redistribute it and/or
22 * modify it under the terms of the GNU General Public License as
23 * published by the Free Software Foundation; either version 2 of
24 * the License, or (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program; if not, write to the Free Software
33 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
41 * Since this is a bootloader, the devices will not be automatic
42 * (re)configured on hotplug, but after a restart of the USB the
45 * For each transfer (except "Interrupt") we wait for completion.
49 #include <asm/processor.h>
50 #include <linux/ctype.h>
51 #include <asm/byteorder.h>
55 #include <asm/4xx_pci.h>
61 #define USB_PRINTF(fmt, args...) printf (fmt , ##args)
63 #define USB_PRINTF(fmt, args...)
66 #define USB_BUFSIZ 512
68 static struct usb_device usb_dev[USB_MAX_DEVICE];
71 static int asynch_allowed;
72 static struct devrequest setup_packet;
74 char usb_started; /* flag for the started/stopped USB status */
76 /**********************************************************************
77 * some forward declerations...
79 void usb_scan_devices(void);
81 int usb_hub_probe(struct usb_device *dev, int ifnum);
82 void usb_hub_reset(void);
83 static int hub_port_reset(struct usb_device *dev, int port,
84 unsigned short *portstat);
86 /***********************************************************************
90 void __inline__ wait_ms(unsigned long ms)
95 /***************************************************************************
107 /* init low_level USB */
109 result = usb_lowlevel_init();
110 /* if lowlevel init is OK, scan the bus for devices
111 * i.e. search HUBs and configure them */
113 printf("scanning bus for devices... ");
119 printf("Error, couldn't init Lowlevel part\n");
125 /******************************************************************************
126 * Stop USB this stops the LowLevel Part and deregisters USB devices.
136 res = usb_lowlevel_stop();
142 * disables the asynch behaviour of the control message. This is used for data
143 * transfers that uses the exclusiv access to the control and bulk messages.
145 void usb_disable_asynch(int disable)
147 asynch_allowed = !disable;
151 /*-------------------------------------------------------------------
157 * submits an Interrupt Message
159 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
160 void *buffer, int transfer_len, int interval)
162 return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
166 * submits a control message and waits for comletion (at least timeout * 1ms)
167 * If timeout is 0, we don't wait for completion (used as example to set and
168 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
169 * allow control messages with 0 timeout, by previousely resetting the flag
170 * asynch_allowed (usb_disable_asynch(1)).
171 * returns the transfered length if OK or -1 if error. The transfered length
172 * and the current status are stored in the dev->act_len and dev->status.
174 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
175 unsigned char request, unsigned char requesttype,
176 unsigned short value, unsigned short index,
177 void *data, unsigned short size, int timeout)
179 if ((timeout == 0) && (!asynch_allowed)) {
180 /* request for a asynch control pipe is not allowed */
184 /* set setup command */
185 setup_packet.requesttype = requesttype;
186 setup_packet.request = request;
187 setup_packet.value = cpu_to_le16(value);
188 setup_packet.index = cpu_to_le16(index);
189 setup_packet.length = cpu_to_le16(size);
190 USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
191 "value 0x%X index 0x%X length 0x%X\n",
192 request, requesttype, value, index, size);
193 dev->status = USB_ST_NOT_PROC; /*not yet processed */
195 submit_control_msg(dev, pipe, data, size, &setup_packet);
199 if (dev->status != 0) {
201 * Let's wait a while for the timeout to elapse.
202 * It has no real use, but it keeps the interface happy.
211 /*-------------------------------------------------------------------
212 * submits bulk message, and waits for completion. returns 0 if Ok or
214 * synchronous behavior
216 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
217 void *data, int len, int *actual_length, int timeout)
221 dev->status = USB_ST_NOT_PROC; /*not yet processed */
222 submit_bulk_msg(dev, pipe, data, len);
224 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
228 *actual_length = dev->act_len;
229 if (dev->status == 0)
236 /*-------------------------------------------------------------------
241 * returns the max packet size, depending on the pipe direction and
242 * the configurations values
244 int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
246 /* direction is out -> use emaxpacket out */
247 if ((pipe & USB_DIR_IN) == 0)
248 return(dev->epmaxpacketout[((pipe>>15) & 0xf)]);
250 return(dev->epmaxpacketin[((pipe>>15) & 0xf)]);
253 /* The routine usb_set_maxpacket_ep() is extracted from the loop of routine
254 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
255 * when it is inlined in 1 single routine. What happens is that the register r3
256 * is used as loop-count 'i', but gets overwritten later on.
257 * This is clearly a compiler bug, but it is easier to workaround it here than
258 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
259 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
261 static void __attribute__((noinline))
262 usb_set_maxpacket_ep(struct usb_device *dev, struct usb_endpoint_descriptor *ep)
266 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
268 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
269 USB_ENDPOINT_XFER_CONTROL) {
270 /* Control => bidirectional */
271 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
272 dev->epmaxpacketin [b] = ep->wMaxPacketSize;
273 USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",
274 b, dev->epmaxpacketin[b]);
276 if ((ep->bEndpointAddress & 0x80) == 0) {
278 if (ep->wMaxPacketSize > dev->epmaxpacketout[b]) {
279 dev->epmaxpacketout[b] = ep->wMaxPacketSize;
280 USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",
281 b, dev->epmaxpacketout[b]);
285 if (ep->wMaxPacketSize > dev->epmaxpacketin[b]) {
286 dev->epmaxpacketin[b] = ep->wMaxPacketSize;
287 USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",
288 b, dev->epmaxpacketin[b]);
295 * set the max packed value of all endpoints in the given configuration
297 int usb_set_maxpacket(struct usb_device *dev)
301 for (i = 0; i < dev->config.bNumInterfaces; i++)
302 for (ii = 0; ii < dev->config.if_desc[i].bNumEndpoints; ii++)
303 usb_set_maxpacket_ep(dev,
304 &dev->config.if_desc[i].ep_desc[ii]);
309 /*******************************************************************************
310 * Parse the config, located in buffer, and fills the dev->config structure.
311 * Note that all little/big endian swapping are done automatically.
313 int usb_parse_config(struct usb_device *dev, unsigned char *buffer, int cfgno)
315 struct usb_descriptor_header *head;
316 int index, ifno, epno, curr_if_num;
324 dev->configno = cfgno;
325 head = (struct usb_descriptor_header *) &buffer[0];
326 if (head->bDescriptorType != USB_DT_CONFIG) {
327 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
328 head->bDescriptorType);
331 memcpy(&dev->config, buffer, buffer[0]);
332 le16_to_cpus(&(dev->config.wTotalLength));
333 dev->config.no_of_if = 0;
335 index = dev->config.bLength;
336 /* Ok the first entry must be a configuration entry,
337 * now process the others */
338 head = (struct usb_descriptor_header *) &buffer[index];
339 while (index + 1 < dev->config.wTotalLength) {
340 switch (head->bDescriptorType) {
341 case USB_DT_INTERFACE:
342 if (((struct usb_interface_descriptor *) \
343 &buffer[index])->bInterfaceNumber != curr_if_num) {
344 /* this is a new interface, copy new desc */
345 ifno = dev->config.no_of_if;
346 dev->config.no_of_if++;
347 memcpy(&dev->config.if_desc[ifno],
348 &buffer[index], buffer[index]);
349 dev->config.if_desc[ifno].no_of_ep = 0;
350 dev->config.if_desc[ifno].num_altsetting = 1;
352 dev->config.if_desc[ifno].bInterfaceNumber;
354 /* found alternate setting for the interface */
355 dev->config.if_desc[ifno].num_altsetting++;
358 case USB_DT_ENDPOINT:
359 epno = dev->config.if_desc[ifno].no_of_ep;
360 /* found an endpoint */
361 dev->config.if_desc[ifno].no_of_ep++;
362 memcpy(&dev->config.if_desc[ifno].ep_desc[epno],
363 &buffer[index], buffer[index]);
364 le16_to_cpus(&(dev->config.if_desc[ifno].ep_desc[epno].\
366 USB_PRINTF("if %d, ep %d\n", ifno, epno);
369 if (head->bLength == 0)
372 USB_PRINTF("unknown Description Type : %x\n",
373 head->bDescriptorType);
376 ch = (unsigned char *)head;
377 for (i = 0; i < head->bLength; i++)
378 USB_PRINTF("%02X ", *ch++);
379 USB_PRINTF("\n\n\n");
383 index += head->bLength;
384 head = (struct usb_descriptor_header *)&buffer[index];
389 /***********************************************************************
391 * endp: endpoint number in bits 0-3;
392 * direction flag in bit 7 (1 = IN, 0 = OUT)
394 int usb_clear_halt(struct usb_device *dev, int pipe)
397 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
399 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
400 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
401 endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
403 /* don't clear if failed */
408 * NOTE: we do not get status and verify reset was successful
409 * as some devices are reported to lock up upon this check..
412 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
414 /* toggle is reset on clear */
415 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
420 /**********************************************************************
421 * get_descriptor type
423 int usb_get_descriptor(struct usb_device *dev, unsigned char type,
424 unsigned char index, void *buf, int size)
427 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
428 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
429 (type << 8) + index, 0,
430 buf, size, USB_CNTL_TIMEOUT);
434 /**********************************************************************
435 * gets configuration cfgno and store it in the buffer
437 int usb_get_configuration_no(struct usb_device *dev,
438 unsigned char *buffer, int cfgno)
442 struct usb_config_descriptor *config;
445 config = (struct usb_config_descriptor *)&buffer[0];
446 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
449 printf("unable to get descriptor, error %lX\n",
452 printf("config descriptor too short " \
453 "(expected %i, got %i)\n", 9, result);
456 tmp = le16_to_cpu(config->wTotalLength);
458 if (tmp > USB_BUFSIZ) {
459 USB_PRINTF("usb_get_configuration_no: failed to get " \
460 "descriptor - too long: %d\n", tmp);
464 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
465 USB_PRINTF("get_conf_no %d Result %d, wLength %d\n",
470 /********************************************************************
471 * set address of a device to the value in dev->devnum.
472 * This can only be done by addressing the device via the default address (0)
474 int usb_set_address(struct usb_device *dev)
478 USB_PRINTF("set address %d\n", dev->devnum);
479 res = usb_control_msg(dev, usb_snddefctrl(dev),
480 USB_REQ_SET_ADDRESS, 0,
482 NULL, 0, USB_CNTL_TIMEOUT);
486 /********************************************************************
487 * set interface number to interface
489 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
491 struct usb_interface_descriptor *if_face = NULL;
494 for (i = 0; i < dev->config.bNumInterfaces; i++) {
495 if (dev->config.if_desc[i].bInterfaceNumber == interface) {
496 if_face = &dev->config.if_desc[i];
501 printf("selecting invalid interface %d", interface);
505 * We should return now for devices with only one alternate setting.
506 * According to 9.4.10 of the Universal Serial Bus Specification
507 * Revision 2.0 such devices can return with a STALL. This results in
508 * some USB sticks timeouting during initialization and then being
509 * unusable in U-Boot.
511 if (if_face->num_altsetting == 1)
514 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
515 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
516 alternate, interface, NULL, 0,
517 USB_CNTL_TIMEOUT * 5);
524 /********************************************************************
525 * set configuration number to configuration
527 int usb_set_configuration(struct usb_device *dev, int configuration)
530 USB_PRINTF("set configuration %d\n", configuration);
531 /* set setup command */
532 res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
533 USB_REQ_SET_CONFIGURATION, 0,
535 NULL, 0, USB_CNTL_TIMEOUT);
544 /********************************************************************
545 * set protocol to protocol
547 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
549 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
550 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
551 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
554 /********************************************************************
557 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
559 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
560 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
561 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
564 /********************************************************************
567 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
568 unsigned char id, void *buf, int size)
570 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
572 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
573 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
576 /********************************************************************
577 * get class descriptor
579 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
580 unsigned char type, unsigned char id, void *buf, int size)
582 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
583 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
584 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
587 /********************************************************************
588 * get string index in buffer
590 int usb_get_string(struct usb_device *dev, unsigned short langid,
591 unsigned char index, void *buf, int size)
596 for (i = 0; i < 3; ++i) {
597 /* some devices are flaky */
598 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
599 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
600 (USB_DT_STRING << 8) + index, langid, buf, size,
611 static void usb_try_string_workarounds(unsigned char *buf, int *length)
613 int newlength, oldlength = *length;
615 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
616 if (!isprint(buf[newlength]) || buf[newlength + 1])
626 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
627 unsigned int index, unsigned char *buf)
631 /* Try to read the string descriptor by asking for the maximum
632 * possible number of bytes */
633 rc = usb_get_string(dev, langid, index, buf, 255);
635 /* If that failed try to read the descriptor length, then
636 * ask for just that many bytes */
638 rc = usb_get_string(dev, langid, index, buf, 2);
640 rc = usb_get_string(dev, langid, index, buf, buf[0]);
644 if (!buf[0] && !buf[1])
645 usb_try_string_workarounds(buf, &rc);
647 /* There might be extra junk at the end of the descriptor */
651 rc = rc - (rc & 1); /* force a multiple of two */
661 /********************************************************************
663 * Get string index and translate it to ascii.
664 * returns string length (> 0) or error (< 0)
666 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
668 unsigned char mybuf[USB_BUFSIZ];
673 if (size <= 0 || !buf || !index)
678 /* get langid for strings if it's not yet known */
679 if (!dev->have_langid) {
680 err = usb_string_sub(dev, 0, 0, tbuf);
682 USB_PRINTF("error getting string descriptor 0 " \
683 "(error=%x)\n", dev->status);
685 } else if (tbuf[0] < 4) {
686 USB_PRINTF("string descriptor 0 too short\n");
689 dev->have_langid = -1;
690 dev->string_langid = tbuf[2] | (tbuf[3] << 8);
691 /* always use the first langid listed */
692 USB_PRINTF("USB device number %d default " \
693 "language ID 0x%x\n",
694 dev->devnum, dev->string_langid);
698 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
702 size--; /* leave room for trailing NULL char in output buffer */
703 for (idx = 0, u = 2; u < err; u += 2) {
706 if (tbuf[u+1]) /* high byte */
707 buf[idx++] = '?'; /* non-ASCII character */
709 buf[idx++] = tbuf[u];
717 /********************************************************************
718 * USB device handling:
719 * the USB device are static allocated [USB_MAX_DEVICE].
723 /* returns a pointer to the device with the index [index].
724 * if the device is not assigned (dev->devnum==-1) returns NULL
726 struct usb_device *usb_get_dev_index(int index)
728 if (usb_dev[index].devnum == -1)
731 return &usb_dev[index];
735 /* returns a pointer of a new device structure or NULL, if
736 * no device struct is available
738 struct usb_device *usb_alloc_new_device(void)
741 USB_PRINTF("New Device %d\n", dev_index);
742 if (dev_index == USB_MAX_DEVICE) {
743 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
746 /* default Address is 0, real addresses start with 1 */
747 usb_dev[dev_index].devnum = dev_index + 1;
748 usb_dev[dev_index].maxchild = 0;
749 for (i = 0; i < USB_MAXCHILDREN; i++)
750 usb_dev[dev_index].children[i] = NULL;
751 usb_dev[dev_index].parent = NULL;
753 return &usb_dev[dev_index - 1];
758 * By the time we get here, the device has gotten a new device ID
759 * and is in the default state. We need to identify the thing and
760 * get the ball rolling..
762 * Returns 0 for success, != 0 for error.
764 int usb_new_device(struct usb_device *dev)
768 unsigned char tmpbuf[USB_BUFSIZ];
770 /* We still haven't set the Address yet */
774 #ifdef CONFIG_LEGACY_USB_INIT_SEQ
775 /* this is the old and known way of initializing devices, it is
776 * different than what Windows and Linux are doing. Windows and Linux
777 * both retrieve 64 bytes while reading the device descriptor
778 * Several USB stick devices report ERR: CTL_TIMEOUT, caused by an
779 * invalid header while reading 8 bytes as device descriptor. */
780 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
781 dev->maxpacketsize = PACKET_SIZE_8;
782 dev->epmaxpacketin [0] = 8;
783 dev->epmaxpacketout[0] = 8;
785 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, &dev->descriptor, 8);
787 printf("\n USB device not responding, " \
788 "giving up (status=%lX)\n",dev->status);
792 /* This is a Windows scheme of initialization sequence, with double
793 * reset of the device (Linux uses the same sequence)
794 * Some equipment is said to work only with such init sequence; this
795 * patch is based on the work by Alan Stern:
796 * http://sourceforge.net/mailarchive/forum.php?thread_id=5729457&forum_id=5398
798 struct usb_device_descriptor *desc;
800 struct usb_device *parent = dev->parent;
801 unsigned short portstatus;
803 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
804 * only 18 bytes long, this will terminate with a short packet. But if
805 * the maxpacket size is 8 or 16 the device may be waiting to transmit
806 * some more, or keeps on retransmitting the 8 byte header. */
808 desc = (struct usb_device_descriptor *)tmpbuf;
809 dev->descriptor.bMaxPacketSize0 = 64; /* Start off at 64 bytes */
810 /* Default to 64 byte max packet size */
811 dev->maxpacketsize = PACKET_SIZE_64;
812 dev->epmaxpacketin [0] = 64;
813 dev->epmaxpacketout[0] = 64;
815 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
817 USB_PRINTF("usb_new_device: usb_get_descriptor() failed\n");
821 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
823 /* find the port number we're at */
827 for (j = 0; j < parent->maxchild; j++) {
828 if (parent->children[j] == dev) {
834 printf("usb_new_device:cannot locate device's port.\n");
838 /* reset the port for the second time */
839 err = hub_port_reset(dev->parent, port, &portstatus);
841 printf("\n Couldn't reset port %i\n", port);
847 dev->epmaxpacketin [0] = dev->descriptor.bMaxPacketSize0;
848 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
849 switch (dev->descriptor.bMaxPacketSize0) {
850 case 8: dev->maxpacketsize = PACKET_SIZE_8; break;
851 case 16: dev->maxpacketsize = PACKET_SIZE_16; break;
852 case 32: dev->maxpacketsize = PACKET_SIZE_32; break;
853 case 64: dev->maxpacketsize = PACKET_SIZE_64; break;
857 err = usb_set_address(dev); /* set address */
860 printf("\n USB device not accepting new address " \
861 "(error=%lX)\n", dev->status);
865 wait_ms(10); /* Let the SET_ADDRESS settle */
867 tmp = sizeof(dev->descriptor);
869 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
870 &dev->descriptor, sizeof(dev->descriptor));
873 printf("unable to get device descriptor (error=%d)\n",
876 printf("USB device descriptor short read " \
877 "(expected %i, got %i)\n", tmp, err);
880 /* correct le values */
881 le16_to_cpus(&dev->descriptor.bcdUSB);
882 le16_to_cpus(&dev->descriptor.idVendor);
883 le16_to_cpus(&dev->descriptor.idProduct);
884 le16_to_cpus(&dev->descriptor.bcdDevice);
885 /* only support for one config for now */
886 usb_get_configuration_no(dev, &tmpbuf[0], 0);
887 usb_parse_config(dev, &tmpbuf[0], 0);
888 usb_set_maxpacket(dev);
889 /* we set the default configuration here */
890 if (usb_set_configuration(dev, dev->config.bConfigurationValue)) {
891 printf("failed to set default configuration " \
892 "len %d, status %lX\n", dev->act_len, dev->status);
895 USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
896 dev->descriptor.iManufacturer, dev->descriptor.iProduct,
897 dev->descriptor.iSerialNumber);
898 memset(dev->mf, 0, sizeof(dev->mf));
899 memset(dev->prod, 0, sizeof(dev->prod));
900 memset(dev->serial, 0, sizeof(dev->serial));
901 if (dev->descriptor.iManufacturer)
902 usb_string(dev, dev->descriptor.iManufacturer,
903 dev->mf, sizeof(dev->mf));
904 if (dev->descriptor.iProduct)
905 usb_string(dev, dev->descriptor.iProduct,
906 dev->prod, sizeof(dev->prod));
907 if (dev->descriptor.iSerialNumber)
908 usb_string(dev, dev->descriptor.iSerialNumber,
909 dev->serial, sizeof(dev->serial));
910 USB_PRINTF("Manufacturer %s\n", dev->mf);
911 USB_PRINTF("Product %s\n", dev->prod);
912 USB_PRINTF("SerialNumber %s\n", dev->serial);
913 /* now prode if the device is a hub */
914 usb_hub_probe(dev, 0);
918 /* build device Tree */
919 void usb_scan_devices(void)
922 struct usb_device *dev;
924 /* first make all devices unknown */
925 for (i = 0; i < USB_MAX_DEVICE; i++) {
926 memset(&usb_dev[i], 0, sizeof(struct usb_device));
927 usb_dev[i].devnum = -1;
930 /* device 0 is always present (root hub, so let it analyze) */
931 dev = usb_alloc_new_device();
933 printf("%d USB Device(s) found\n", dev_index);
934 /* insert "driver" if possible */
935 #ifdef CONFIG_USB_KEYBOARD
937 USB_PRINTF("scan end\n");
942 /****************************************************************************
944 * Probes device for being a hub and configurate it
950 #define USB_HUB_PRINTF(fmt, args...) printf (fmt , ##args)
952 #define USB_HUB_PRINTF(fmt, args...)
956 static struct usb_hub_device hub_dev[USB_MAX_HUB];
957 static int usb_hub_index;
960 int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
962 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
963 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
964 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
967 int usb_clear_hub_feature(struct usb_device *dev, int feature)
969 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
970 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature,
971 0, NULL, 0, USB_CNTL_TIMEOUT);
974 int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
976 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
977 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
978 port, NULL, 0, USB_CNTL_TIMEOUT);
981 int usb_set_port_feature(struct usb_device *dev, int port, int feature)
983 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
984 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
985 port, NULL, 0, USB_CNTL_TIMEOUT);
988 int usb_get_hub_status(struct usb_device *dev, void *data)
990 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
991 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
992 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
995 int usb_get_port_status(struct usb_device *dev, int port, void *data)
997 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
998 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
999 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
1003 static void usb_hub_power_on(struct usb_hub_device *hub)
1006 struct usb_device *dev;
1008 dev = hub->pusb_dev;
1009 /* Enable power to the ports */
1010 USB_HUB_PRINTF("enabling power on all ports\n");
1011 for (i = 0; i < dev->maxchild; i++) {
1012 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
1013 USB_HUB_PRINTF("port %d returns %lX\n", i + 1, dev->status);
1014 wait_ms(hub->desc.bPwrOn2PwrGood * 2);
1018 void usb_hub_reset(void)
1023 struct usb_hub_device *usb_hub_allocate(void)
1025 if (usb_hub_index < USB_MAX_HUB)
1026 return &hub_dev[usb_hub_index++];
1028 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
1034 static int hub_port_reset(struct usb_device *dev, int port,
1035 unsigned short *portstat)
1038 struct usb_port_status portsts;
1039 unsigned short portstatus, portchange;
1041 USB_HUB_PRINTF("hub_port_reset: resetting port %d...\n", port);
1042 for (tries = 0; tries < MAX_TRIES; tries++) {
1044 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
1047 if (usb_get_port_status(dev, port + 1, &portsts) < 0) {
1048 USB_HUB_PRINTF("get_port_status failed status %lX\n",
1052 portstatus = le16_to_cpu(portsts.wPortStatus);
1053 portchange = le16_to_cpu(portsts.wPortChange);
1054 USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
1055 portstatus, portchange,
1056 portstatus&(1<<USB_PORT_FEAT_LOWSPEED) ? \
1057 "Low Speed" : "High Speed");
1058 USB_HUB_PRINTF("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
1059 " USB_PORT_STAT_ENABLE %d\n",
1060 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
1061 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
1062 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
1064 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
1065 !(portstatus & USB_PORT_STAT_CONNECTION))
1068 if (portstatus & USB_PORT_STAT_ENABLE)
1074 if (tries == MAX_TRIES) {
1075 USB_HUB_PRINTF("Cannot enable port %i after %i retries, " \
1076 "disabling port.\n", port + 1, MAX_TRIES);
1077 USB_HUB_PRINTF("Maybe the USB cable is bad?\n");
1081 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
1082 *portstat = portstatus;
1087 void usb_hub_port_connect_change(struct usb_device *dev, int port)
1089 struct usb_device *usb;
1090 struct usb_port_status portsts;
1091 unsigned short portstatus, portchange;
1094 if (usb_get_port_status(dev, port + 1, &portsts) < 0) {
1095 USB_HUB_PRINTF("get_port_status failed\n");
1099 portstatus = le16_to_cpu(portsts.wPortStatus);
1100 portchange = le16_to_cpu(portsts.wPortChange);
1101 USB_HUB_PRINTF("portstatus %x, change %x, %s\n",
1102 portstatus, portchange,
1103 portstatus&(1 << USB_PORT_FEAT_LOWSPEED) ? \
1104 "Low Speed" : "High Speed");
1106 /* Clear the connection change status */
1107 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
1109 /* Disconnect any existing devices under this port */
1110 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
1111 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
1112 USB_HUB_PRINTF("usb_disconnect(&hub->children[port]);\n");
1113 /* Return now if nothing is connected */
1114 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1119 /* Reset the port */
1120 if (hub_port_reset(dev, port, &portstatus) < 0) {
1121 printf("cannot reset port %i!?\n", port + 1);
1127 /* Allocate a new device struct for it */
1128 usb = usb_alloc_new_device();
1129 usb->slow = (portstatus & USB_PORT_STAT_LOW_SPEED) ? 1 : 0;
1131 dev->children[port] = usb;
1133 /* Run it through the hoops (find a driver, etc) */
1134 if (usb_new_device(usb)) {
1135 /* Woops, disable the port */
1136 USB_HUB_PRINTF("hub: disabling port %d\n", port + 1);
1137 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
1142 int usb_hub_configure(struct usb_device *dev)
1144 unsigned char buffer[USB_BUFSIZ], *bitmap;
1145 struct usb_hub_descriptor *descriptor;
1146 struct usb_hub_status *hubsts;
1148 struct usb_hub_device *hub;
1150 /* "allocate" Hub device */
1151 hub = usb_hub_allocate();
1154 hub->pusb_dev = dev;
1155 /* Get the the hub descriptor */
1156 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
1157 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1158 "descriptor, giving up %lX\n", dev->status);
1161 descriptor = (struct usb_hub_descriptor *)buffer;
1163 /* silence compiler warning if USB_BUFSIZ is > 256 [= sizeof(char)] */
1164 i = descriptor->bLength;
1165 if (i > USB_BUFSIZ) {
1166 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1167 "descriptor - too long: %d\n",
1168 descriptor->bLength);
1172 if (usb_get_hub_descriptor(dev, buffer, descriptor->bLength) < 0) {
1173 USB_HUB_PRINTF("usb_hub_configure: failed to get hub " \
1174 "descriptor 2nd giving up %lX\n", dev->status);
1177 memcpy((unsigned char *)&hub->desc, buffer, descriptor->bLength);
1178 /* adjust 16bit values */
1179 hub->desc.wHubCharacteristics =
1180 le16_to_cpu(descriptor->wHubCharacteristics);
1181 /* set the bitmap */
1182 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
1183 /* devices not removable by default */
1184 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
1185 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
1186 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
1188 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
1189 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
1191 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
1192 hub->desc.DeviceRemovable[i] = descriptor->PortPowerCtrlMask[i];
1194 dev->maxchild = descriptor->bNbrPorts;
1195 USB_HUB_PRINTF("%d ports detected\n", dev->maxchild);
1197 switch (hub->desc.wHubCharacteristics & HUB_CHAR_LPSM) {
1199 USB_HUB_PRINTF("ganged power switching\n");
1202 USB_HUB_PRINTF("individual port power switching\n");
1206 USB_HUB_PRINTF("unknown reserved power switching mode\n");
1210 if (hub->desc.wHubCharacteristics & HUB_CHAR_COMPOUND)
1211 USB_HUB_PRINTF("part of a compound device\n");
1213 USB_HUB_PRINTF("standalone hub\n");
1215 switch (hub->desc.wHubCharacteristics & HUB_CHAR_OCPM) {
1217 USB_HUB_PRINTF("global over-current protection\n");
1220 USB_HUB_PRINTF("individual port over-current protection\n");
1224 USB_HUB_PRINTF("no over-current protection\n");
1228 USB_HUB_PRINTF("power on to power good time: %dms\n",
1229 descriptor->bPwrOn2PwrGood * 2);
1230 USB_HUB_PRINTF("hub controller current requirement: %dmA\n",
1231 descriptor->bHubContrCurrent);
1233 for (i = 0; i < dev->maxchild; i++)
1234 USB_HUB_PRINTF("port %d is%s removable\n", i + 1,
1235 hub->desc.DeviceRemovable[(i + 1) / 8] & \
1236 (1 << ((i + 1) % 8)) ? " not" : "");
1238 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
1239 USB_HUB_PRINTF("usb_hub_configure: failed to get Status - " \
1240 "too long: %d\n", descriptor->bLength);
1244 if (usb_get_hub_status(dev, buffer) < 0) {
1245 USB_HUB_PRINTF("usb_hub_configure: failed to get Status %lX\n",
1250 hubsts = (struct usb_hub_status *)buffer;
1251 USB_HUB_PRINTF("get_hub_status returned status %X, change %X\n",
1252 le16_to_cpu(hubsts->wHubStatus),
1253 le16_to_cpu(hubsts->wHubChange));
1254 USB_HUB_PRINTF("local power source is %s\n",
1255 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
1256 "lost (inactive)" : "good");
1257 USB_HUB_PRINTF("%sover-current condition exists\n",
1258 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
1260 usb_hub_power_on(hub);
1262 for (i = 0; i < dev->maxchild; i++) {
1263 struct usb_port_status portsts;
1264 unsigned short portstatus, portchange;
1266 if (usb_get_port_status(dev, i + 1, &portsts) < 0) {
1267 USB_HUB_PRINTF("get_port_status failed\n");
1271 portstatus = le16_to_cpu(portsts.wPortStatus);
1272 portchange = le16_to_cpu(portsts.wPortChange);
1273 USB_HUB_PRINTF("Port %d Status %X Change %X\n",
1274 i + 1, portstatus, portchange);
1276 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1277 USB_HUB_PRINTF("port %d connection change\n", i + 1);
1278 usb_hub_port_connect_change(dev, i);
1280 if (portchange & USB_PORT_STAT_C_ENABLE) {
1281 USB_HUB_PRINTF("port %d enable change, status %x\n",
1283 usb_clear_port_feature(dev, i + 1,
1284 USB_PORT_FEAT_C_ENABLE);
1286 /* EM interference sometimes causes bad shielded USB
1287 * devices to be shutdown by the hub, this hack enables
1288 * them again. Works at least with mouse driver */
1289 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
1290 (portstatus & USB_PORT_STAT_CONNECTION) &&
1291 ((dev->children[i]))) {
1292 USB_HUB_PRINTF("already running port %i " \
1293 "disabled by hub (EMI?), " \
1294 "re-enabling...\n", i + 1);
1295 usb_hub_port_connect_change(dev, i);
1298 if (portstatus & USB_PORT_STAT_SUSPEND) {
1299 USB_HUB_PRINTF("port %d suspend change\n", i + 1);
1300 usb_clear_port_feature(dev, i + 1,
1301 USB_PORT_FEAT_SUSPEND);
1304 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
1305 USB_HUB_PRINTF("port %d over-current change\n", i + 1);
1306 usb_clear_port_feature(dev, i + 1,
1307 USB_PORT_FEAT_C_OVER_CURRENT);
1308 usb_hub_power_on(hub);
1311 if (portchange & USB_PORT_STAT_C_RESET) {
1312 USB_HUB_PRINTF("port %d reset change\n", i + 1);
1313 usb_clear_port_feature(dev, i + 1,
1314 USB_PORT_FEAT_C_RESET);
1316 } /* end for i all ports */
1321 int usb_hub_probe(struct usb_device *dev, int ifnum)
1323 struct usb_interface_descriptor *iface;
1324 struct usb_endpoint_descriptor *ep;
1327 iface = &dev->config.if_desc[ifnum];
1329 if (iface->bInterfaceClass != USB_CLASS_HUB)
1331 /* Some hubs have a subclass of 1, which AFAICT according to the */
1332 /* specs is not defined, but it works */
1333 if ((iface->bInterfaceSubClass != 0) &&
1334 (iface->bInterfaceSubClass != 1))
1336 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1337 if (iface->bNumEndpoints != 1)
1339 ep = &iface->ep_desc[0];
1340 /* Output endpoint? Curiousier and curiousier.. */
1341 if (!(ep->bEndpointAddress & USB_DIR_IN))
1343 /* If it's not an interrupt endpoint, we'd better punt! */
1344 if ((ep->bmAttributes & 3) != 3)
1346 /* We found a hub */
1347 USB_HUB_PRINTF("USB hub found\n");
1348 ret = usb_hub_configure(dev);