2 * Most of this source has been derived from the Linux USB
4 * (C) Copyright Linus Torvalds 1999
5 * (C) Copyright Johannes Erdfelt 1999-2001
6 * (C) Copyright Andreas Gal 1999
7 * (C) Copyright Gregory P. Smith 1999
8 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
9 * (C) Copyright Randy Dunlap 2000
10 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
11 * (C) Copyright Yggdrasil Computing, Inc. 2000
12 * (usb_device_id matching changes by Adam J. Richter)
15 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
17 * SPDX-License-Identifier: GPL-2.0+
23 * Since this is a bootloader, the devices will not be automatic
24 * (re)configured on hotplug, but after a restart of the USB the
27 * For each transfer (except "Interrupt") we wait for completion.
33 #include <asm/processor.h>
34 #include <linux/compiler.h>
35 #include <linux/ctype.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
41 #define USB_BUFSIZ 512
43 static int asynch_allowed;
44 char usb_started; /* flag for the started/stopped USB status */
47 static struct usb_device usb_dev[USB_MAX_DEVICE];
50 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
51 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
54 /***************************************************************************
60 struct usb_device *dev;
61 int i, start_index = 0;
62 int controllers_initialized = 0;
69 /* first make all devices unknown */
70 for (i = 0; i < USB_MAX_DEVICE; i++) {
71 memset(&usb_dev[i], 0, sizeof(struct usb_device));
72 usb_dev[i].devnum = -1;
75 /* init low_level USB */
76 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
77 /* init low_level USB */
79 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
80 if (ret == -ENODEV) { /* No such device. */
81 puts("Port not available.\n");
82 controllers_initialized++;
86 if (ret) { /* Other error. */
87 puts("lowlevel init failed\n");
91 * lowlevel init is OK, now scan the bus for devices
92 * i.e. search HUBs and configure them
94 controllers_initialized++;
95 start_index = dev_index;
96 printf("scanning bus %d for devices... ", i);
97 ret = usb_alloc_new_device(ctrl, &dev);
102 * device 0 is always present
103 * (root hub, so let it analyze)
105 ret = usb_new_device(dev);
107 usb_free_device(dev->controller);
109 if (start_index == dev_index) {
110 puts("No USB Device found\n");
113 printf("%d USB Device(s) found\n",
114 dev_index - start_index);
121 /* if we were not able to find at least one working bus, bail out */
122 if (controllers_initialized == 0)
123 puts("USB error: all controllers failed lowlevel init\n");
125 return usb_started ? 0 : -ENODEV;
128 /******************************************************************************
129 * Stop USB this stops the LowLevel Part and deregisters USB devices.
140 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
141 if (usb_lowlevel_stop(i))
142 printf("failed to stop USB controller %d\n", i);
149 /******************************************************************************
150 * Detect if a USB device has been plugged or unplugged.
152 int usb_detect_change(void)
157 for (j = 0; j < USB_MAX_DEVICE; j++) {
158 for (i = 0; i < usb_dev[j].maxchild; i++) {
159 struct usb_port_status status;
161 if (usb_get_port_status(&usb_dev[j], i + 1,
163 /* USB request failed */
166 if (le16_to_cpu(status.wPortChange) &
167 USB_PORT_STAT_C_CONNECTION)
176 * disables the asynch behaviour of the control message. This is used for data
177 * transfers that uses the exclusiv access to the control and bulk messages.
178 * Returns the old value so it can be restored later.
180 int usb_disable_asynch(int disable)
182 int old_value = asynch_allowed;
184 asynch_allowed = !disable;
187 #endif /* !CONFIG_DM_USB */
190 /*-------------------------------------------------------------------
196 * submits an Interrupt Message
198 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
199 void *buffer, int transfer_len, int interval)
201 return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
205 * submits a control message and waits for comletion (at least timeout * 1ms)
206 * If timeout is 0, we don't wait for completion (used as example to set and
207 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
208 * allow control messages with 0 timeout, by previousely resetting the flag
209 * asynch_allowed (usb_disable_asynch(1)).
210 * returns the transferred length if OK or -1 if error. The transferred length
211 * and the current status are stored in the dev->act_len and dev->status.
213 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
214 unsigned char request, unsigned char requesttype,
215 unsigned short value, unsigned short index,
216 void *data, unsigned short size, int timeout)
218 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
221 if ((timeout == 0) && (!asynch_allowed)) {
222 /* request for a asynch control pipe is not allowed */
226 /* set setup command */
227 setup_packet->requesttype = requesttype;
228 setup_packet->request = request;
229 setup_packet->value = cpu_to_le16(value);
230 setup_packet->index = cpu_to_le16(index);
231 setup_packet->length = cpu_to_le16(size);
232 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
233 "value 0x%X index 0x%X length 0x%X\n",
234 request, requesttype, value, index, size);
235 dev->status = USB_ST_NOT_PROC; /*not yet processed */
237 err = submit_control_msg(dev, pipe, data, size, setup_packet);
244 * Wait for status to update until timeout expires, USB driver
245 * interrupt handler may set the status when the USB operation has
249 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
260 /*-------------------------------------------------------------------
261 * submits bulk message, and waits for completion. returns 0 if Ok or
263 * synchronous behavior
265 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
266 void *data, int len, int *actual_length, int timeout)
270 dev->status = USB_ST_NOT_PROC; /*not yet processed */
271 if (submit_bulk_msg(dev, pipe, data, len) < 0)
274 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
278 *actual_length = dev->act_len;
279 if (dev->status == 0)
286 /*-------------------------------------------------------------------
291 * returns the max packet size, depending on the pipe direction and
292 * the configurations values
294 int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
296 /* direction is out -> use emaxpacket out */
297 if ((pipe & USB_DIR_IN) == 0)
298 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
300 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
304 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
305 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
306 * when it is inlined in 1 single routine. What happens is that the register r3
307 * is used as loop-count 'i', but gets overwritten later on.
308 * This is clearly a compiler bug, but it is easier to workaround it here than
309 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
310 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
312 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
315 usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
318 struct usb_endpoint_descriptor *ep;
319 u16 ep_wMaxPacketSize;
321 ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
323 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
324 ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
326 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
327 USB_ENDPOINT_XFER_CONTROL) {
328 /* Control => bidirectional */
329 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
330 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
331 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
332 b, dev->epmaxpacketin[b]);
334 if ((ep->bEndpointAddress & 0x80) == 0) {
336 if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) {
337 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
338 debug("##EP epmaxpacketout[%d] = %d\n",
339 b, dev->epmaxpacketout[b]);
343 if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) {
344 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
345 debug("##EP epmaxpacketin[%d] = %d\n",
346 b, dev->epmaxpacketin[b]);
353 * set the max packed value of all endpoints in the given configuration
355 static int usb_set_maxpacket(struct usb_device *dev)
359 for (i = 0; i < dev->config.desc.bNumInterfaces; i++)
360 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++)
361 usb_set_maxpacket_ep(dev, i, ii);
366 /*******************************************************************************
367 * Parse the config, located in buffer, and fills the dev->config structure.
368 * Note that all little/big endian swapping are done automatically.
369 * (wTotalLength has already been swapped and sanitized when it was read.)
371 static int usb_parse_config(struct usb_device *dev,
372 unsigned char *buffer, int cfgno)
374 struct usb_descriptor_header *head;
375 int index, ifno, epno, curr_if_num;
376 u16 ep_wMaxPacketSize;
377 struct usb_interface *if_desc = NULL;
383 dev->configno = cfgno;
384 head = (struct usb_descriptor_header *) &buffer[0];
385 if (head->bDescriptorType != USB_DT_CONFIG) {
386 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
387 head->bDescriptorType);
390 if (head->bLength != USB_DT_CONFIG_SIZE) {
391 printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
394 memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
395 dev->config.no_of_if = 0;
397 index = dev->config.desc.bLength;
398 /* Ok the first entry must be a configuration entry,
399 * now process the others */
400 head = (struct usb_descriptor_header *) &buffer[index];
401 while (index + 1 < dev->config.desc.wTotalLength && head->bLength) {
402 switch (head->bDescriptorType) {
403 case USB_DT_INTERFACE:
404 if (head->bLength != USB_DT_INTERFACE_SIZE) {
405 printf("ERROR: Invalid USB IF length (%d)\n",
409 if (index + USB_DT_INTERFACE_SIZE >
410 dev->config.desc.wTotalLength) {
411 puts("USB IF descriptor overflowed buffer!\n");
414 if (((struct usb_interface_descriptor *) \
415 head)->bInterfaceNumber != curr_if_num) {
416 /* this is a new interface, copy new desc */
417 ifno = dev->config.no_of_if;
418 if (ifno >= USB_MAXINTERFACES) {
419 puts("Too many USB interfaces!\n");
420 /* try to go on with what we have */
423 if_desc = &dev->config.if_desc[ifno];
424 dev->config.no_of_if++;
425 memcpy(if_desc, head,
426 USB_DT_INTERFACE_SIZE);
427 if_desc->no_of_ep = 0;
428 if_desc->num_altsetting = 1;
430 if_desc->desc.bInterfaceNumber;
432 /* found alternate setting for the interface */
434 if_desc = &dev->config.if_desc[ifno];
435 if_desc->num_altsetting++;
439 case USB_DT_ENDPOINT:
440 if (head->bLength != USB_DT_ENDPOINT_SIZE &&
441 head->bLength != USB_DT_ENDPOINT_AUDIO_SIZE) {
442 printf("ERROR: Invalid USB EP length (%d)\n",
446 if (index + head->bLength >
447 dev->config.desc.wTotalLength) {
448 puts("USB EP descriptor overflowed buffer!\n");
452 puts("Endpoint descriptor out of order!\n");
455 epno = dev->config.if_desc[ifno].no_of_ep;
456 if_desc = &dev->config.if_desc[ifno];
457 if (epno >= USB_MAXENDPOINTS) {
458 printf("Interface %d has too many endpoints!\n",
459 if_desc->desc.bInterfaceNumber);
462 /* found an endpoint */
464 memcpy(&if_desc->ep_desc[epno], head,
465 USB_DT_ENDPOINT_SIZE);
466 ep_wMaxPacketSize = get_unaligned(&dev->config.\
470 put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
475 debug("if %d, ep %d\n", ifno, epno);
477 case USB_DT_SS_ENDPOINT_COMP:
478 if (head->bLength != USB_DT_SS_EP_COMP_SIZE) {
479 printf("ERROR: Invalid USB EPC length (%d)\n",
483 if (index + USB_DT_SS_EP_COMP_SIZE >
484 dev->config.desc.wTotalLength) {
485 puts("USB EPC descriptor overflowed buffer!\n");
488 if (ifno < 0 || epno < 0) {
489 puts("EPC descriptor out of order!\n");
492 if_desc = &dev->config.if_desc[ifno];
493 memcpy(&if_desc->ss_ep_comp_desc[epno], head,
494 USB_DT_SS_EP_COMP_SIZE);
497 if (head->bLength == 0)
500 debug("unknown Description Type : %x\n",
501 head->bDescriptorType);
505 unsigned char *ch = (unsigned char *)head;
508 for (i = 0; i < head->bLength; i++)
509 debug("%02X ", *ch++);
515 index += head->bLength;
516 head = (struct usb_descriptor_header *)&buffer[index];
521 /***********************************************************************
523 * endp: endpoint number in bits 0-3;
524 * direction flag in bit 7 (1 = IN, 0 = OUT)
526 int usb_clear_halt(struct usb_device *dev, int pipe)
529 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
531 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
532 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
533 endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
535 /* don't clear if failed */
540 * NOTE: we do not get status and verify reset was successful
541 * as some devices are reported to lock up upon this check..
544 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
546 /* toggle is reset on clear */
547 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
552 /**********************************************************************
553 * get_descriptor type
555 static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
556 unsigned char index, void *buf, int size)
558 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
559 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
560 (type << 8) + index, 0, buf, size,
564 /**********************************************************************
565 * gets len of configuration cfgno
567 int usb_get_configuration_len(struct usb_device *dev, int cfgno)
570 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, 9);
571 struct usb_config_descriptor *config;
573 config = (struct usb_config_descriptor *)&buffer[0];
574 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
577 printf("unable to get descriptor, error %lX\n",
580 printf("config descriptor too short " \
581 "(expected %i, got %i)\n", 9, result);
584 return le16_to_cpu(config->wTotalLength);
587 /**********************************************************************
588 * gets configuration cfgno and store it in the buffer
590 int usb_get_configuration_no(struct usb_device *dev, int cfgno,
591 unsigned char *buffer, int length)
594 struct usb_config_descriptor *config;
596 config = (struct usb_config_descriptor *)&buffer[0];
597 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
598 debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result,
599 le16_to_cpu(config->wTotalLength));
600 config->wTotalLength = result; /* validated, with CPU byte order */
605 /********************************************************************
606 * set address of a device to the value in dev->devnum.
607 * This can only be done by addressing the device via the default address (0)
609 static int usb_set_address(struct usb_device *dev)
611 debug("set address %d\n", dev->devnum);
613 return usb_control_msg(dev, usb_snddefctrl(dev), USB_REQ_SET_ADDRESS,
614 0, (dev->devnum), 0, NULL, 0, USB_CNTL_TIMEOUT);
617 /********************************************************************
618 * set interface number to interface
620 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
622 struct usb_interface *if_face = NULL;
625 for (i = 0; i < dev->config.desc.bNumInterfaces; i++) {
626 if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) {
627 if_face = &dev->config.if_desc[i];
632 printf("selecting invalid interface %d", interface);
636 * We should return now for devices with only one alternate setting.
637 * According to 9.4.10 of the Universal Serial Bus Specification
638 * Revision 2.0 such devices can return with a STALL. This results in
639 * some USB sticks timeouting during initialization and then being
640 * unusable in U-Boot.
642 if (if_face->num_altsetting == 1)
645 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
646 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
647 alternate, interface, NULL, 0,
648 USB_CNTL_TIMEOUT * 5);
655 /********************************************************************
656 * set configuration number to configuration
658 static int usb_set_configuration(struct usb_device *dev, int configuration)
661 debug("set configuration %d\n", configuration);
662 /* set setup command */
663 res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
664 USB_REQ_SET_CONFIGURATION, 0,
666 NULL, 0, USB_CNTL_TIMEOUT);
675 /********************************************************************
676 * set protocol to protocol
678 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
680 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
681 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
682 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
685 /********************************************************************
688 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
690 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
691 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
692 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
695 /********************************************************************
698 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
699 unsigned char id, void *buf, int size)
701 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
703 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
704 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
707 /********************************************************************
708 * get class descriptor
710 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
711 unsigned char type, unsigned char id, void *buf, int size)
713 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
714 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
715 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
718 /********************************************************************
719 * get string index in buffer
721 static int usb_get_string(struct usb_device *dev, unsigned short langid,
722 unsigned char index, void *buf, int size)
727 for (i = 0; i < 3; ++i) {
728 /* some devices are flaky */
729 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
730 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
731 (USB_DT_STRING << 8) + index, langid, buf, size,
742 static void usb_try_string_workarounds(unsigned char *buf, int *length)
744 int newlength, oldlength = *length;
746 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
747 if (!isprint(buf[newlength]) || buf[newlength + 1])
757 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
758 unsigned int index, unsigned char *buf)
762 /* Try to read the string descriptor by asking for the maximum
763 * possible number of bytes */
764 rc = usb_get_string(dev, langid, index, buf, 255);
766 /* If that failed try to read the descriptor length, then
767 * ask for just that many bytes */
769 rc = usb_get_string(dev, langid, index, buf, 2);
771 rc = usb_get_string(dev, langid, index, buf, buf[0]);
775 if (!buf[0] && !buf[1])
776 usb_try_string_workarounds(buf, &rc);
778 /* There might be extra junk at the end of the descriptor */
782 rc = rc - (rc & 1); /* force a multiple of two */
792 /********************************************************************
794 * Get string index and translate it to ascii.
795 * returns string length (> 0) or error (< 0)
797 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
799 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ);
804 if (size <= 0 || !buf || !index)
809 /* get langid for strings if it's not yet known */
810 if (!dev->have_langid) {
811 err = usb_string_sub(dev, 0, 0, tbuf);
813 debug("error getting string descriptor 0 " \
814 "(error=%lx)\n", dev->status);
816 } else if (tbuf[0] < 4) {
817 debug("string descriptor 0 too short\n");
820 dev->have_langid = -1;
821 dev->string_langid = tbuf[2] | (tbuf[3] << 8);
822 /* always use the first langid listed */
823 debug("USB device number %d default " \
824 "language ID 0x%x\n",
825 dev->devnum, dev->string_langid);
829 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
833 size--; /* leave room for trailing NULL char in output buffer */
834 for (idx = 0, u = 2; u < err; u += 2) {
837 if (tbuf[u+1]) /* high byte */
838 buf[idx++] = '?'; /* non-ASCII character */
840 buf[idx++] = tbuf[u];
848 /********************************************************************
849 * USB device handling:
850 * the USB device are static allocated [USB_MAX_DEVICE].
853 #ifndef CONFIG_DM_USB
855 /* returns a pointer to the device with the index [index].
856 * if the device is not assigned (dev->devnum==-1) returns NULL
858 struct usb_device *usb_get_dev_index(int index)
860 if (usb_dev[index].devnum == -1)
863 return &usb_dev[index];
866 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp)
869 debug("New Device %d\n", dev_index);
870 if (dev_index == USB_MAX_DEVICE) {
871 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
874 /* default Address is 0, real addresses start with 1 */
875 usb_dev[dev_index].devnum = dev_index + 1;
876 usb_dev[dev_index].maxchild = 0;
877 for (i = 0; i < USB_MAXCHILDREN; i++)
878 usb_dev[dev_index].children[i] = NULL;
879 usb_dev[dev_index].parent = NULL;
880 usb_dev[dev_index].controller = controller;
882 *devp = &usb_dev[dev_index - 1];
888 * Free the newly created device node.
889 * Called in error cases where configuring a newly attached
890 * device fails for some reason.
892 void usb_free_device(struct udevice *controller)
895 debug("Freeing device node: %d\n", dev_index);
896 memset(&usb_dev[dev_index], 0, sizeof(struct usb_device));
897 usb_dev[dev_index].devnum = -1;
901 * XHCI issues Enable Slot command and thereafter
902 * allocates device contexts. Provide a weak alias
903 * function for the purpose, so that XHCI overrides it
904 * and EHCI/OHCI just work out of the box.
906 __weak int usb_alloc_device(struct usb_device *udev)
910 #endif /* !CONFIG_DM_USB */
912 static int usb_hub_port_reset(struct usb_device *dev, struct usb_device *hub)
915 usb_reset_root_port(dev);
920 static int get_descriptor_len(struct usb_device *dev, int len, int expect_len)
922 __maybe_unused struct usb_device_descriptor *desc;
923 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
926 desc = (struct usb_device_descriptor *)tmpbuf;
928 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, len);
929 if (err < expect_len) {
931 printf("unable to get device descriptor (error=%d)\n",
935 printf("USB device descriptor short read (expected %i, got %i)\n",
940 memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
945 static int usb_setup_descriptor(struct usb_device *dev, bool do_read)
948 * This is a Windows scheme of initialization sequence, with double
949 * reset of the device (Linux uses the same sequence)
950 * Some equipment is said to work only with such init sequence; this
951 * patch is based on the work by Alan Stern:
952 * http://sourceforge.net/mailarchive/forum.php?
953 * thread_id=5729457&forum_id=5398
957 * send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
958 * only 18 bytes long, this will terminate with a short packet. But if
959 * the maxpacket size is 8 or 16 the device may be waiting to transmit
960 * some more, or keeps on retransmitting the 8 byte header.
963 if (dev->speed == USB_SPEED_LOW) {
964 dev->descriptor.bMaxPacketSize0 = 8;
965 dev->maxpacketsize = PACKET_SIZE_8;
967 dev->descriptor.bMaxPacketSize0 = 64;
968 dev->maxpacketsize = PACKET_SIZE_64;
970 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
971 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
973 if (do_read && dev->speed == USB_SPEED_FULL) {
977 * Validate we've received only at least 8 bytes, not that
978 * we've received the entire descriptor. The reasoning is:
979 * - The code only uses fields in the first 8 bytes, so
980 * that's all we need to have fetched at this stage.
981 * - The smallest maxpacket size is 8 bytes. Before we know
982 * the actual maxpacket the device uses, the USB controller
983 * may only accept a single packet. Consequently we are only
984 * guaranteed to receive 1 packet (at least 8 bytes) even in
987 * At least the DWC2 controller needs to be programmed with
988 * the number of packets in addition to the number of bytes.
989 * A request for 64 bytes of data with the maxpacket guessed
990 * as 64 (above) yields a request for 1 packet.
992 err = get_descriptor_len(dev, 64, 8);
997 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
998 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
999 switch (dev->descriptor.bMaxPacketSize0) {
1001 dev->maxpacketsize = PACKET_SIZE_8;
1004 dev->maxpacketsize = PACKET_SIZE_16;
1007 dev->maxpacketsize = PACKET_SIZE_32;
1010 dev->maxpacketsize = PACKET_SIZE_64;
1013 printf("%s: invalid max packet size\n", __func__);
1020 static int usb_prepare_device(struct usb_device *dev, int addr, bool do_read,
1021 struct usb_device *parent)
1026 * Allocate usb 3.0 device context.
1027 * USB 3.0 (xHCI) protocol tries to allocate device slot
1028 * and related data structures first. This call does that.
1029 * Refer to sec 4.3.2 in xHCI spec rev1.0
1031 err = usb_alloc_device(dev);
1033 printf("Cannot allocate device context to get SLOT_ID\n");
1036 err = usb_setup_descriptor(dev, do_read);
1039 err = usb_hub_port_reset(dev, parent);
1045 err = usb_set_address(dev); /* set address */
1048 printf("\n USB device not accepting new address " \
1049 "(error=%lX)\n", dev->status);
1053 mdelay(10); /* Let the SET_ADDRESS settle */
1056 * If we haven't read device descriptor before, read it here
1057 * after device is assigned an address. This is only applicable
1061 err = usb_setup_descriptor(dev, true);
1069 int usb_select_config(struct usb_device *dev)
1071 unsigned char *tmpbuf = NULL;
1074 err = get_descriptor_len(dev, USB_DT_DEVICE_SIZE, USB_DT_DEVICE_SIZE);
1078 /* correct le values */
1079 le16_to_cpus(&dev->descriptor.bcdUSB);
1080 le16_to_cpus(&dev->descriptor.idVendor);
1081 le16_to_cpus(&dev->descriptor.idProduct);
1082 le16_to_cpus(&dev->descriptor.bcdDevice);
1085 * Kingston DT Ultimate 32GB USB 3.0 seems to be extremely sensitive
1086 * about this first Get Descriptor request. If there are any other
1087 * requests in the first microframe, the stick crashes. Wait about
1088 * one microframe duration here (1mS for USB 1.x , 125uS for USB 2.0).
1092 /* only support for one config for now */
1093 err = usb_get_configuration_len(dev, 0);
1095 tmpbuf = (unsigned char *)malloc_cache_aligned(err);
1099 err = usb_get_configuration_no(dev, 0, tmpbuf, err);
1102 printf("usb_new_device: Cannot read configuration, " \
1103 "skipping device %04x:%04x\n",
1104 dev->descriptor.idVendor, dev->descriptor.idProduct);
1108 usb_parse_config(dev, tmpbuf, 0);
1110 usb_set_maxpacket(dev);
1112 * we set the default configuration here
1113 * This seems premature. If the driver wants a different configuration
1114 * it will need to select itself.
1116 err = usb_set_configuration(dev, dev->config.desc.bConfigurationValue);
1118 printf("failed to set default configuration " \
1119 "len %d, status %lX\n", dev->act_len, dev->status);
1124 * Wait until the Set Configuration request gets processed by the
1125 * device. This is required by at least SanDisk Cruzer Pop USB 2.0
1126 * and Kingston DT Ultimate 32GB USB 3.0 on DWC2 OTG controller.
1130 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1131 dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1132 dev->descriptor.iSerialNumber);
1133 memset(dev->mf, 0, sizeof(dev->mf));
1134 memset(dev->prod, 0, sizeof(dev->prod));
1135 memset(dev->serial, 0, sizeof(dev->serial));
1136 if (dev->descriptor.iManufacturer)
1137 usb_string(dev, dev->descriptor.iManufacturer,
1138 dev->mf, sizeof(dev->mf));
1139 if (dev->descriptor.iProduct)
1140 usb_string(dev, dev->descriptor.iProduct,
1141 dev->prod, sizeof(dev->prod));
1142 if (dev->descriptor.iSerialNumber)
1143 usb_string(dev, dev->descriptor.iSerialNumber,
1144 dev->serial, sizeof(dev->serial));
1145 debug("Manufacturer %s\n", dev->mf);
1146 debug("Product %s\n", dev->prod);
1147 debug("SerialNumber %s\n", dev->serial);
1152 int usb_setup_device(struct usb_device *dev, bool do_read,
1153 struct usb_device *parent)
1158 /* We still haven't set the Address yet */
1162 ret = usb_prepare_device(dev, addr, do_read, parent);
1165 ret = usb_select_config(dev);
1170 #ifndef CONFIG_DM_USB
1172 * By the time we get here, the device has gotten a new device ID
1173 * and is in the default state. We need to identify the thing and
1174 * get the ball rolling..
1176 * Returns 0 for success, != 0 for error.
1178 int usb_new_device(struct usb_device *dev)
1180 bool do_read = true;
1184 * XHCI needs to issue a Address device command to setup
1185 * proper device context structures, before it can interact
1186 * with the device. So a get_descriptor will fail before any
1187 * of that is done for XHCI unlike EHCI.
1189 #ifdef CONFIG_USB_XHCI_HCD
1192 err = usb_setup_device(dev, do_read, dev->parent);
1196 /* Now probe if the device is a hub */
1197 err = usb_hub_probe(dev, 0);
1206 int board_usb_init(int index, enum usb_init_type init)
1212 int board_usb_cleanup(int index, enum usb_init_type init)
1217 bool usb_device_has_child_on_port(struct usb_device *parent, int port)
1219 #ifdef CONFIG_DM_USB
1222 return parent->children[port] != NULL;
1226 #ifdef CONFIG_DM_USB
1227 void usb_find_usb2_hub_address_port(struct usb_device *udev,
1228 uint8_t *hub_address, uint8_t *hub_port)
1230 struct udevice *parent;
1231 struct usb_device *uparent, *ttdev;
1234 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1235 * to the parent udevice, not the actual udevice belonging to the
1236 * udev as the device is not instantiated yet. So when searching
1237 * for the first usb-2 parent start with udev->dev not
1238 * udev->dev->parent .
1242 uparent = dev_get_parent_priv(parent);
1244 while (uparent->speed != USB_SPEED_HIGH) {
1245 struct udevice *dev = parent;
1247 if (device_get_uclass_id(dev->parent) != UCLASS_USB_HUB) {
1248 printf("Error: Cannot find high speed parent of usb-1 device\n");
1254 ttdev = dev_get_parent_priv(dev);
1255 parent = dev->parent;
1256 uparent = dev_get_parent_priv(parent);
1258 *hub_address = uparent->devnum;
1259 *hub_port = ttdev->portnr;
1262 void usb_find_usb2_hub_address_port(struct usb_device *udev,
1263 uint8_t *hub_address, uint8_t *hub_port)
1265 /* Find out the nearest parent which is high speed */
1266 while (udev->parent->parent != NULL)
1267 if (udev->parent->speed != USB_SPEED_HIGH) {
1268 udev = udev->parent;
1270 *hub_address = udev->parent->devnum;
1271 *hub_port = udev->portnr;
1275 printf("Error: Cannot find high speed parent of usb-1 device\n");