1 // SPDX-License-Identifier: GPL-2.0+
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
22 * Since this is a bootloader, the devices will not be automatic
23 * (re)configured on hotplug, but after a restart of the USB the
26 * For each transfer (except "Interrupt") we wait for completion.
34 #include <asm/processor.h>
35 #include <linux/compiler.h>
36 #include <linux/ctype.h>
37 #include <asm/byteorder.h>
38 #include <asm/unaligned.h>
41 #include <linux/delay.h>
43 #define USB_BUFSIZ 512
45 static int asynch_allowed
;
46 char usb_started
; /* flag for the started/stopped USB status */
48 #if !CONFIG_IS_ENABLED(DM_USB)
49 static struct usb_device usb_dev
[USB_MAX_DEVICE
];
52 /***************************************************************************
58 struct usb_device
*dev
;
59 int i
, start_index
= 0;
60 int controllers_initialized
= 0;
67 /* first make all devices unknown */
68 for (i
= 0; i
< USB_MAX_DEVICE
; i
++) {
69 memset(&usb_dev
[i
], 0, sizeof(struct usb_device
));
70 usb_dev
[i
].devnum
= -1;
73 /* init low_level USB */
74 for (i
= 0; i
< CONFIG_USB_MAX_CONTROLLER_COUNT
; i
++) {
75 /* init low_level USB */
77 ret
= usb_lowlevel_init(i
, USB_INIT_HOST
, &ctrl
);
78 if (ret
== -ENODEV
) { /* No such device. */
79 puts("Port not available.\n");
80 controllers_initialized
++;
84 if (ret
) { /* Other error. */
85 puts("lowlevel init failed\n");
89 * lowlevel init is OK, now scan the bus for devices
90 * i.e. search HUBs and configure them
92 controllers_initialized
++;
93 start_index
= dev_index
;
94 printf("scanning bus %d for devices... ", i
);
95 ret
= usb_alloc_new_device(ctrl
, &dev
);
100 * device 0 is always present
101 * (root hub, so let it analyze)
103 ret
= usb_new_device(dev
);
105 usb_free_device(dev
->controller
);
107 if (start_index
== dev_index
) {
108 puts("No USB Device found\n");
111 printf("%d USB Device(s) found\n",
112 dev_index
- start_index
);
119 /* if we were not able to find at least one working bus, bail out */
120 if (controllers_initialized
== 0)
121 puts("USB error: all controllers failed lowlevel init\n");
123 return usb_started
? 0 : -ENODEV
;
126 /******************************************************************************
127 * Stop USB this stops the LowLevel Part and deregisters USB devices.
138 for (i
= 0; i
< CONFIG_USB_MAX_CONTROLLER_COUNT
; i
++) {
139 if (usb_lowlevel_stop(i
))
140 printf("failed to stop USB controller %d\n", i
);
147 /******************************************************************************
148 * Detect if a USB device has been plugged or unplugged.
150 int usb_detect_change(void)
155 for (j
= 0; j
< USB_MAX_DEVICE
; j
++) {
156 for (i
= 0; i
< usb_dev
[j
].maxchild
; i
++) {
157 struct usb_port_status status
;
159 if (usb_get_port_status(&usb_dev
[j
], i
+ 1,
161 /* USB request failed */
164 if (le16_to_cpu(status
.wPortChange
) &
165 USB_PORT_STAT_C_CONNECTION
)
173 /* Lock or unlock async schedule on the controller */
174 __weak
int usb_lock_async(struct usb_device
*dev
, int lock
)
180 * disables the asynch behaviour of the control message. This is used for data
181 * transfers that uses the exclusiv access to the control and bulk messages.
182 * Returns the old value so it can be restored later.
184 int usb_disable_asynch(int disable
)
186 int old_value
= asynch_allowed
;
188 asynch_allowed
= !disable
;
191 #endif /* !CONFIG_IS_ENABLED(DM_USB) */
194 /*-------------------------------------------------------------------
200 * submits an Interrupt Message. Some drivers may implement non-blocking
201 * polling: when non-block is true and the device is not responding return
202 * -EAGAIN instead of waiting for device to respond.
204 int usb_int_msg(struct usb_device
*dev
, unsigned long pipe
,
205 void *buffer
, int transfer_len
, int interval
, bool nonblock
)
207 return submit_int_msg(dev
, pipe
, buffer
, transfer_len
, interval
,
212 * submits a control message and waits for comletion (at least timeout * 1ms)
213 * If timeout is 0, we don't wait for completion (used as example to set and
214 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
215 * allow control messages with 0 timeout, by previousely resetting the flag
216 * asynch_allowed (usb_disable_asynch(1)).
217 * returns the transferred length if OK or -1 if error. The transferred length
218 * and the current status are stored in the dev->act_len and dev->status.
220 int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
221 unsigned char request
, unsigned char requesttype
,
222 unsigned short value
, unsigned short index
,
223 void *data
, unsigned short size
, int timeout
)
225 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest
, setup_packet
, 1);
228 if ((timeout
== 0) && (!asynch_allowed
)) {
229 /* request for a asynch control pipe is not allowed */
233 /* set setup command */
234 setup_packet
->requesttype
= requesttype
;
235 setup_packet
->request
= request
;
236 setup_packet
->value
= cpu_to_le16(value
);
237 setup_packet
->index
= cpu_to_le16(index
);
238 setup_packet
->length
= cpu_to_le16(size
);
239 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
240 "value 0x%X index 0x%X length 0x%X\n",
241 request
, requesttype
, value
, index
, size
);
242 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
244 err
= submit_control_msg(dev
, pipe
, data
, size
, setup_packet
);
251 * Wait for status to update until timeout expires, USB driver
252 * interrupt handler may set the status when the USB operation has
256 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
267 /*-------------------------------------------------------------------
268 * submits bulk message, and waits for completion. returns 0 if Ok or
270 * synchronous behavior
272 int usb_bulk_msg(struct usb_device
*dev
, unsigned int pipe
,
273 void *data
, int len
, int *actual_length
, int timeout
)
277 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
278 if (submit_bulk_msg(dev
, pipe
, data
, len
) < 0)
281 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
285 *actual_length
= dev
->act_len
;
286 if (dev
->status
== 0)
293 /*-------------------------------------------------------------------
298 * returns the max packet size, depending on the pipe direction and
299 * the configurations values
301 int usb_maxpacket(struct usb_device
*dev
, unsigned long pipe
)
303 /* direction is out -> use emaxpacket out */
304 if ((pipe
& USB_DIR_IN
) == 0)
305 return dev
->epmaxpacketout
[((pipe
>>15) & 0xf)];
307 return dev
->epmaxpacketin
[((pipe
>>15) & 0xf)];
311 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
312 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
313 * when it is inlined in 1 single routine. What happens is that the register r3
314 * is used as loop-count 'i', but gets overwritten later on.
315 * This is clearly a compiler bug, but it is easier to workaround it here than
316 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
317 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
319 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
322 usb_set_maxpacket_ep(struct usb_device
*dev
, int if_idx
, int ep_idx
)
325 struct usb_endpoint_descriptor
*ep
;
326 u16 ep_wMaxPacketSize
;
328 ep
= &dev
->config
.if_desc
[if_idx
].ep_desc
[ep_idx
];
330 b
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
331 ep_wMaxPacketSize
= get_unaligned(&ep
->wMaxPacketSize
);
333 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
334 USB_ENDPOINT_XFER_CONTROL
) {
335 /* Control => bidirectional */
336 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
337 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
338 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
339 b
, dev
->epmaxpacketin
[b
]);
341 if ((ep
->bEndpointAddress
& 0x80) == 0) {
343 if (ep_wMaxPacketSize
> dev
->epmaxpacketout
[b
]) {
344 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
345 debug("##EP epmaxpacketout[%d] = %d\n",
346 b
, dev
->epmaxpacketout
[b
]);
350 if (ep_wMaxPacketSize
> dev
->epmaxpacketin
[b
]) {
351 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
352 debug("##EP epmaxpacketin[%d] = %d\n",
353 b
, dev
->epmaxpacketin
[b
]);
360 * set the max packed value of all endpoints in the given configuration
362 static int usb_set_maxpacket(struct usb_device
*dev
)
366 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++)
367 for (ii
= 0; ii
< dev
->config
.if_desc
[i
].desc
.bNumEndpoints
; ii
++)
368 usb_set_maxpacket_ep(dev
, i
, ii
);
373 /*******************************************************************************
374 * Parse the config, located in buffer, and fills the dev->config structure.
375 * Note that all little/big endian swapping are done automatically.
376 * (wTotalLength has already been swapped and sanitized when it was read.)
378 static int usb_parse_config(struct usb_device
*dev
,
379 unsigned char *buffer
, int cfgno
)
381 struct usb_descriptor_header
*head
;
382 int index
, ifno
, epno
, curr_if_num
;
383 u16 ep_wMaxPacketSize
;
384 struct usb_interface
*if_desc
= NULL
;
390 dev
->configno
= cfgno
;
391 head
= (struct usb_descriptor_header
*) &buffer
[0];
392 if (head
->bDescriptorType
!= USB_DT_CONFIG
) {
393 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
394 head
->bDescriptorType
);
397 if (head
->bLength
!= USB_DT_CONFIG_SIZE
) {
398 printf("ERROR: Invalid USB CFG length (%d)\n", head
->bLength
);
401 memcpy(&dev
->config
, head
, USB_DT_CONFIG_SIZE
);
402 dev
->config
.no_of_if
= 0;
404 index
= dev
->config
.desc
.bLength
;
405 /* Ok the first entry must be a configuration entry,
406 * now process the others */
407 head
= (struct usb_descriptor_header
*) &buffer
[index
];
408 while (index
+ 1 < dev
->config
.desc
.wTotalLength
&& head
->bLength
) {
409 switch (head
->bDescriptorType
) {
410 case USB_DT_INTERFACE
:
411 if (head
->bLength
!= USB_DT_INTERFACE_SIZE
) {
412 printf("ERROR: Invalid USB IF length (%d)\n",
416 if (index
+ USB_DT_INTERFACE_SIZE
>
417 dev
->config
.desc
.wTotalLength
) {
418 puts("USB IF descriptor overflowed buffer!\n");
421 if (((struct usb_interface_descriptor
*) \
422 head
)->bInterfaceNumber
!= curr_if_num
) {
423 /* this is a new interface, copy new desc */
424 ifno
= dev
->config
.no_of_if
;
425 if (ifno
>= USB_MAXINTERFACES
) {
426 puts("Too many USB interfaces!\n");
427 /* try to go on with what we have */
430 if_desc
= &dev
->config
.if_desc
[ifno
];
431 dev
->config
.no_of_if
++;
432 memcpy(if_desc
, head
,
433 USB_DT_INTERFACE_SIZE
);
434 if_desc
->no_of_ep
= 0;
435 if_desc
->num_altsetting
= 1;
437 if_desc
->desc
.bInterfaceNumber
;
439 /* found alternate setting for the interface */
441 if_desc
= &dev
->config
.if_desc
[ifno
];
442 if_desc
->num_altsetting
++;
446 case USB_DT_ENDPOINT
:
447 if (head
->bLength
!= USB_DT_ENDPOINT_SIZE
&&
448 head
->bLength
!= USB_DT_ENDPOINT_AUDIO_SIZE
) {
449 printf("ERROR: Invalid USB EP length (%d)\n",
453 if (index
+ head
->bLength
>
454 dev
->config
.desc
.wTotalLength
) {
455 puts("USB EP descriptor overflowed buffer!\n");
459 puts("Endpoint descriptor out of order!\n");
462 epno
= dev
->config
.if_desc
[ifno
].no_of_ep
;
463 if_desc
= &dev
->config
.if_desc
[ifno
];
464 if (epno
>= USB_MAXENDPOINTS
) {
465 printf("Interface %d has too many endpoints!\n",
466 if_desc
->desc
.bInterfaceNumber
);
469 /* found an endpoint */
471 memcpy(&if_desc
->ep_desc
[epno
], head
,
472 USB_DT_ENDPOINT_SIZE
);
473 ep_wMaxPacketSize
= get_unaligned(&dev
->config
.\
477 put_unaligned(le16_to_cpu(ep_wMaxPacketSize
),
482 debug("if %d, ep %d\n", ifno
, epno
);
484 case USB_DT_SS_ENDPOINT_COMP
:
485 if (head
->bLength
!= USB_DT_SS_EP_COMP_SIZE
) {
486 printf("ERROR: Invalid USB EPC length (%d)\n",
490 if (index
+ USB_DT_SS_EP_COMP_SIZE
>
491 dev
->config
.desc
.wTotalLength
) {
492 puts("USB EPC descriptor overflowed buffer!\n");
495 if (ifno
< 0 || epno
< 0) {
496 puts("EPC descriptor out of order!\n");
499 if_desc
= &dev
->config
.if_desc
[ifno
];
500 memcpy(&if_desc
->ss_ep_comp_desc
[epno
], head
,
501 USB_DT_SS_EP_COMP_SIZE
);
504 if (head
->bLength
== 0)
507 debug("unknown Description Type : %x\n",
508 head
->bDescriptorType
);
512 unsigned char *ch
= (unsigned char *)head
;
515 for (i
= 0; i
< head
->bLength
; i
++)
516 debug("%02X ", *ch
++);
522 index
+= head
->bLength
;
523 head
= (struct usb_descriptor_header
*)&buffer
[index
];
528 /***********************************************************************
530 * endp: endpoint number in bits 0-3;
531 * direction flag in bit 7 (1 = IN, 0 = OUT)
533 int usb_clear_halt(struct usb_device
*dev
, int pipe
)
536 int endp
= usb_pipeendpoint(pipe
)|(usb_pipein(pipe
)<<7);
538 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
539 USB_REQ_CLEAR_FEATURE
, USB_RECIP_ENDPOINT
, 0,
540 endp
, NULL
, 0, USB_CNTL_TIMEOUT
* 3);
542 /* don't clear if failed */
547 * NOTE: we do not get status and verify reset was successful
548 * as some devices are reported to lock up upon this check..
551 usb_endpoint_running(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
));
553 /* toggle is reset on clear */
554 usb_settoggle(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
), 0);
559 /**********************************************************************
560 * get_descriptor type
562 static int usb_get_descriptor(struct usb_device
*dev
, unsigned char type
,
563 unsigned char index
, void *buf
, int size
)
565 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
566 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
567 (type
<< 8) + index
, 0, buf
, size
,
571 /**********************************************************************
572 * gets len of configuration cfgno
574 int usb_get_configuration_len(struct usb_device
*dev
, int cfgno
)
577 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, 9);
578 struct usb_config_descriptor
*config
;
580 config
= (struct usb_config_descriptor
*)&buffer
[0];
581 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, 9);
584 printf("unable to get descriptor, error %lX\n",
587 printf("config descriptor too short " \
588 "(expected %i, got %i)\n", 9, result
);
591 return le16_to_cpu(config
->wTotalLength
);
594 /**********************************************************************
595 * gets configuration cfgno and store it in the buffer
597 int usb_get_configuration_no(struct usb_device
*dev
, int cfgno
,
598 unsigned char *buffer
, int length
)
601 struct usb_config_descriptor
*config
;
603 config
= (struct usb_config_descriptor
*)&buffer
[0];
604 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, length
);
605 debug("get_conf_no %d Result %d, wLength %d\n", cfgno
, result
,
606 le16_to_cpu(config
->wTotalLength
));
607 config
->wTotalLength
= result
; /* validated, with CPU byte order */
612 /********************************************************************
613 * set address of a device to the value in dev->devnum.
614 * This can only be done by addressing the device via the default address (0)
616 static int usb_set_address(struct usb_device
*dev
)
618 debug("set address %d\n", dev
->devnum
);
620 return usb_control_msg(dev
, usb_snddefctrl(dev
), USB_REQ_SET_ADDRESS
,
621 0, (dev
->devnum
), 0, NULL
, 0, USB_CNTL_TIMEOUT
);
624 /********************************************************************
625 * set interface number to interface
627 int usb_set_interface(struct usb_device
*dev
, int interface
, int alternate
)
629 struct usb_interface
*if_face
= NULL
;
632 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++) {
633 if (dev
->config
.if_desc
[i
].desc
.bInterfaceNumber
== interface
) {
634 if_face
= &dev
->config
.if_desc
[i
];
639 printf("selecting invalid interface %d", interface
);
643 * We should return now for devices with only one alternate setting.
644 * According to 9.4.10 of the Universal Serial Bus Specification
645 * Revision 2.0 such devices can return with a STALL. This results in
646 * some USB sticks timeouting during initialization and then being
647 * unusable in U-Boot.
649 if (if_face
->num_altsetting
== 1)
652 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
653 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
654 alternate
, interface
, NULL
, 0,
655 USB_CNTL_TIMEOUT
* 5);
662 /********************************************************************
663 * set configuration number to configuration
665 static int usb_set_configuration(struct usb_device
*dev
, int configuration
)
668 debug("set configuration %d\n", configuration
);
669 /* set setup command */
670 res
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
671 USB_REQ_SET_CONFIGURATION
, 0,
673 NULL
, 0, USB_CNTL_TIMEOUT
);
682 /********************************************************************
683 * set protocol to protocol
685 int usb_set_protocol(struct usb_device
*dev
, int ifnum
, int protocol
)
687 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
688 USB_REQ_SET_PROTOCOL
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
689 protocol
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
692 /********************************************************************
695 int usb_set_idle(struct usb_device
*dev
, int ifnum
, int duration
, int report_id
)
697 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
698 USB_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
699 (duration
<< 8) | report_id
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
702 /********************************************************************
705 int usb_get_report(struct usb_device
*dev
, int ifnum
, unsigned char type
,
706 unsigned char id
, void *buf
, int size
)
708 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
710 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
711 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
714 /********************************************************************
715 * get class descriptor
717 int usb_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
718 unsigned char type
, unsigned char id
, void *buf
, int size
)
720 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
721 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
722 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
725 /********************************************************************
726 * get string index in buffer
728 static int usb_get_string(struct usb_device
*dev
, unsigned short langid
,
729 unsigned char index
, void *buf
, int size
)
734 for (i
= 0; i
< 3; ++i
) {
735 /* some devices are flaky */
736 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
737 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
738 (USB_DT_STRING
<< 8) + index
, langid
, buf
, size
,
749 static void usb_try_string_workarounds(unsigned char *buf
, int *length
)
751 int newlength
, oldlength
= *length
;
753 for (newlength
= 2; newlength
+ 1 < oldlength
; newlength
+= 2)
754 if (!isprint(buf
[newlength
]) || buf
[newlength
+ 1])
764 static int usb_string_sub(struct usb_device
*dev
, unsigned int langid
,
765 unsigned int index
, unsigned char *buf
)
769 /* Try to read the string descriptor by asking for the maximum
770 * possible number of bytes */
771 rc
= usb_get_string(dev
, langid
, index
, buf
, 255);
773 /* If that failed try to read the descriptor length, then
774 * ask for just that many bytes */
776 rc
= usb_get_string(dev
, langid
, index
, buf
, 2);
778 rc
= usb_get_string(dev
, langid
, index
, buf
, buf
[0]);
782 if (!buf
[0] && !buf
[1])
783 usb_try_string_workarounds(buf
, &rc
);
785 /* There might be extra junk at the end of the descriptor */
789 rc
= rc
- (rc
& 1); /* force a multiple of two */
799 /********************************************************************
801 * Get string index and translate it to ascii.
802 * returns string length (> 0) or error (< 0)
804 int usb_string(struct usb_device
*dev
, int index
, char *buf
, size_t size
)
806 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf
, USB_BUFSIZ
);
811 if (size
<= 0 || !buf
|| !index
)
816 /* get langid for strings if it's not yet known */
817 if (!dev
->have_langid
) {
818 err
= usb_string_sub(dev
, 0, 0, tbuf
);
820 debug("error getting string descriptor 0 " \
821 "(error=%lx)\n", dev
->status
);
823 } else if (tbuf
[0] < 4) {
824 debug("string descriptor 0 too short\n");
827 dev
->have_langid
= -1;
828 dev
->string_langid
= tbuf
[2] | (tbuf
[3] << 8);
829 /* always use the first langid listed */
830 debug("USB device number %d default " \
831 "language ID 0x%x\n",
832 dev
->devnum
, dev
->string_langid
);
836 err
= usb_string_sub(dev
, dev
->string_langid
, index
, tbuf
);
840 size
--; /* leave room for trailing NULL char in output buffer */
841 for (idx
= 0, u
= 2; u
< err
; u
+= 2) {
844 if (tbuf
[u
+1]) /* high byte */
845 buf
[idx
++] = '?'; /* non-ASCII character */
847 buf
[idx
++] = tbuf
[u
];
855 /********************************************************************
856 * USB device handling:
857 * the USB device are static allocated [USB_MAX_DEVICE].
860 #if !CONFIG_IS_ENABLED(DM_USB)
862 /* returns a pointer to the device with the index [index].
863 * if the device is not assigned (dev->devnum==-1) returns NULL
865 struct usb_device
*usb_get_dev_index(int index
)
867 if (usb_dev
[index
].devnum
== -1)
870 return &usb_dev
[index
];
873 int usb_alloc_new_device(struct udevice
*controller
, struct usb_device
**devp
)
876 debug("New Device %d\n", dev_index
);
877 if (dev_index
== USB_MAX_DEVICE
) {
878 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE
);
881 /* default Address is 0, real addresses start with 1 */
882 usb_dev
[dev_index
].devnum
= dev_index
+ 1;
883 usb_dev
[dev_index
].maxchild
= 0;
884 for (i
= 0; i
< USB_MAXCHILDREN
; i
++)
885 usb_dev
[dev_index
].children
[i
] = NULL
;
886 usb_dev
[dev_index
].parent
= NULL
;
887 usb_dev
[dev_index
].controller
= controller
;
889 *devp
= &usb_dev
[dev_index
- 1];
895 * Free the newly created device node.
896 * Called in error cases where configuring a newly attached
897 * device fails for some reason.
899 void usb_free_device(struct udevice
*controller
)
902 debug("Freeing device node: %d\n", dev_index
);
903 memset(&usb_dev
[dev_index
], 0, sizeof(struct usb_device
));
904 usb_dev
[dev_index
].devnum
= -1;
908 * XHCI issues Enable Slot command and thereafter
909 * allocates device contexts. Provide a weak alias
910 * function for the purpose, so that XHCI overrides it
911 * and EHCI/OHCI just work out of the box.
913 __weak
int usb_alloc_device(struct usb_device
*udev
)
917 #endif /* !CONFIG_IS_ENABLED(DM_USB) */
919 static int usb_hub_port_reset(struct usb_device
*dev
, struct usb_device
*hub
)
922 usb_reset_root_port(dev
);
927 static int get_descriptor_len(struct usb_device
*dev
, int len
, int expect_len
)
929 __maybe_unused
struct usb_device_descriptor
*desc
;
930 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf
, USB_BUFSIZ
);
933 desc
= (struct usb_device_descriptor
*)tmpbuf
;
935 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0, desc
, len
);
936 if (err
< expect_len
) {
938 printf("unable to get device descriptor (error=%d)\n",
942 printf("USB device descriptor short read (expected %i, got %i)\n",
947 memcpy(&dev
->descriptor
, tmpbuf
, sizeof(dev
->descriptor
));
952 static int usb_setup_descriptor(struct usb_device
*dev
, bool do_read
)
955 * This is a Windows scheme of initialization sequence, with double
956 * reset of the device (Linux uses the same sequence)
957 * Some equipment is said to work only with such init sequence; this
958 * patch is based on the work by Alan Stern:
959 * http://sourceforge.net/mailarchive/forum.php?
960 * thread_id=5729457&forum_id=5398
964 * send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
965 * only 18 bytes long, this will terminate with a short packet. But if
966 * the maxpacket size is 8 or 16 the device may be waiting to transmit
967 * some more, or keeps on retransmitting the 8 byte header.
970 if (dev
->speed
== USB_SPEED_LOW
) {
971 dev
->descriptor
.bMaxPacketSize0
= 8;
972 dev
->maxpacketsize
= PACKET_SIZE_8
;
974 dev
->descriptor
.bMaxPacketSize0
= 64;
975 dev
->maxpacketsize
= PACKET_SIZE_64
;
977 dev
->epmaxpacketin
[0] = dev
->descriptor
.bMaxPacketSize0
;
978 dev
->epmaxpacketout
[0] = dev
->descriptor
.bMaxPacketSize0
;
980 if (do_read
&& dev
->speed
== USB_SPEED_FULL
) {
984 * Validate we've received only at least 8 bytes, not that
985 * we've received the entire descriptor. The reasoning is:
986 * - The code only uses fields in the first 8 bytes, so
987 * that's all we need to have fetched at this stage.
988 * - The smallest maxpacket size is 8 bytes. Before we know
989 * the actual maxpacket the device uses, the USB controller
990 * may only accept a single packet. Consequently we are only
991 * guaranteed to receive 1 packet (at least 8 bytes) even in
994 * At least the DWC2 controller needs to be programmed with
995 * the number of packets in addition to the number of bytes.
996 * A request for 64 bytes of data with the maxpacket guessed
997 * as 64 (above) yields a request for 1 packet.
999 err
= get_descriptor_len(dev
, 64, 8);
1004 * Logitech Unifying Receiver 046d:c52b bcdDevice 12.10 seems
1005 * sensitive about the first Get Descriptor request. If there
1006 * are any other requests in the same microframe, the device
1007 * reports bogus data, first of the descriptor parts is not
1008 * sent to the host. Wait over one microframe duration here
1009 * (1mS for USB 1.x , 125uS for USB 2.0) to avoid triggering
1015 dev
->epmaxpacketin
[0] = dev
->descriptor
.bMaxPacketSize0
;
1016 dev
->epmaxpacketout
[0] = dev
->descriptor
.bMaxPacketSize0
;
1017 switch (dev
->descriptor
.bMaxPacketSize0
) {
1019 dev
->maxpacketsize
= PACKET_SIZE_8
;
1022 dev
->maxpacketsize
= PACKET_SIZE_16
;
1025 dev
->maxpacketsize
= PACKET_SIZE_32
;
1028 dev
->maxpacketsize
= PACKET_SIZE_64
;
1031 printf("%s: invalid max packet size\n", __func__
);
1038 static int usb_prepare_device(struct usb_device
*dev
, int addr
, bool do_read
,
1039 struct usb_device
*parent
)
1044 * Allocate usb 3.0 device context.
1045 * USB 3.0 (xHCI) protocol tries to allocate device slot
1046 * and related data structures first. This call does that.
1047 * Refer to sec 4.3.2 in xHCI spec rev1.0
1049 err
= usb_alloc_device(dev
);
1051 printf("Cannot allocate device context to get SLOT_ID\n");
1054 err
= usb_setup_descriptor(dev
, do_read
);
1057 err
= usb_hub_port_reset(dev
, parent
);
1063 err
= usb_set_address(dev
); /* set address */
1066 printf("\n USB device not accepting new address " \
1067 "(error=%lX)\n", dev
->status
);
1071 mdelay(10); /* Let the SET_ADDRESS settle */
1074 * If we haven't read device descriptor before, read it here
1075 * after device is assigned an address. This is only applicable
1079 err
= usb_setup_descriptor(dev
, true);
1087 int usb_select_config(struct usb_device
*dev
)
1089 unsigned char *tmpbuf
= NULL
;
1092 err
= get_descriptor_len(dev
, USB_DT_DEVICE_SIZE
, USB_DT_DEVICE_SIZE
);
1096 /* correct le values */
1097 le16_to_cpus(&dev
->descriptor
.bcdUSB
);
1098 le16_to_cpus(&dev
->descriptor
.idVendor
);
1099 le16_to_cpus(&dev
->descriptor
.idProduct
);
1100 le16_to_cpus(&dev
->descriptor
.bcdDevice
);
1103 * Kingston DT Ultimate 32GB USB 3.0 seems to be extremely sensitive
1104 * about this first Get Descriptor request. If there are any other
1105 * requests in the first microframe, the stick crashes. Wait about
1106 * one microframe duration here (1mS for USB 1.x , 125uS for USB 2.0).
1110 /* only support for one config for now */
1111 err
= usb_get_configuration_len(dev
, 0);
1113 tmpbuf
= (unsigned char *)malloc_cache_aligned(err
);
1117 err
= usb_get_configuration_no(dev
, 0, tmpbuf
, err
);
1120 printf("usb_new_device: Cannot read configuration, " \
1121 "skipping device %04x:%04x\n",
1122 dev
->descriptor
.idVendor
, dev
->descriptor
.idProduct
);
1126 usb_parse_config(dev
, tmpbuf
, 0);
1128 usb_set_maxpacket(dev
);
1130 * we set the default configuration here
1131 * This seems premature. If the driver wants a different configuration
1132 * it will need to select itself.
1134 err
= usb_set_configuration(dev
, dev
->config
.desc
.bConfigurationValue
);
1136 printf("failed to set default configuration " \
1137 "len %d, status %lX\n", dev
->act_len
, dev
->status
);
1142 * Wait until the Set Configuration request gets processed by the
1143 * device. This is required by at least SanDisk Cruzer Pop USB 2.0
1144 * and Kingston DT Ultimate 32GB USB 3.0 on DWC2 OTG controller.
1148 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1149 dev
->descriptor
.iManufacturer
, dev
->descriptor
.iProduct
,
1150 dev
->descriptor
.iSerialNumber
);
1151 memset(dev
->mf
, 0, sizeof(dev
->mf
));
1152 memset(dev
->prod
, 0, sizeof(dev
->prod
));
1153 memset(dev
->serial
, 0, sizeof(dev
->serial
));
1154 if (dev
->descriptor
.iManufacturer
)
1155 usb_string(dev
, dev
->descriptor
.iManufacturer
,
1156 dev
->mf
, sizeof(dev
->mf
));
1157 if (dev
->descriptor
.iProduct
)
1158 usb_string(dev
, dev
->descriptor
.iProduct
,
1159 dev
->prod
, sizeof(dev
->prod
));
1160 if (dev
->descriptor
.iSerialNumber
)
1161 usb_string(dev
, dev
->descriptor
.iSerialNumber
,
1162 dev
->serial
, sizeof(dev
->serial
));
1163 debug("Manufacturer %s\n", dev
->mf
);
1164 debug("Product %s\n", dev
->prod
);
1165 debug("SerialNumber %s\n", dev
->serial
);
1170 int usb_setup_device(struct usb_device
*dev
, bool do_read
,
1171 struct usb_device
*parent
)
1176 /* We still haven't set the Address yet */
1180 ret
= usb_prepare_device(dev
, addr
, do_read
, parent
);
1183 ret
= usb_select_config(dev
);
1188 #if !CONFIG_IS_ENABLED(DM_USB)
1190 * By the time we get here, the device has gotten a new device ID
1191 * and is in the default state. We need to identify the thing and
1192 * get the ball rolling..
1194 * Returns 0 for success, != 0 for error.
1196 int usb_new_device(struct usb_device
*dev
)
1198 bool do_read
= true;
1202 * XHCI needs to issue a Address device command to setup
1203 * proper device context structures, before it can interact
1204 * with the device. So a get_descriptor will fail before any
1205 * of that is done for XHCI unlike EHCI.
1207 #ifdef CONFIG_USB_XHCI_HCD
1210 err
= usb_setup_device(dev
, do_read
, dev
->parent
);
1214 /* Now probe if the device is a hub */
1215 err
= usb_hub_probe(dev
, 0);
1224 int board_usb_init(int index
, enum usb_init_type init
)
1230 int board_usb_cleanup(int index
, enum usb_init_type init
)
1235 bool usb_device_has_child_on_port(struct usb_device
*parent
, int port
)
1237 #if CONFIG_IS_ENABLED(DM_USB)
1240 return parent
->children
[port
] != NULL
;
1244 #if CONFIG_IS_ENABLED(DM_USB)
1245 void usb_find_usb2_hub_address_port(struct usb_device
*udev
,
1246 uint8_t *hub_address
, uint8_t *hub_port
)
1248 struct udevice
*parent
;
1249 struct usb_device
*uparent
, *ttdev
;
1252 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1253 * to the parent udevice, not the actual udevice belonging to the
1254 * udev as the device is not instantiated yet. So when searching
1255 * for the first usb-2 parent start with udev->dev not
1256 * udev->dev->parent .
1260 uparent
= dev_get_parent_priv(parent
);
1262 while (uparent
->speed
!= USB_SPEED_HIGH
) {
1263 struct udevice
*dev
= parent
;
1265 if (device_get_uclass_id(dev
->parent
) != UCLASS_USB_HUB
) {
1266 printf("Error: Cannot find high speed parent of usb-1 device\n");
1272 ttdev
= dev_get_parent_priv(dev
);
1273 parent
= dev
->parent
;
1274 uparent
= dev_get_parent_priv(parent
);
1276 *hub_address
= uparent
->devnum
;
1277 *hub_port
= ttdev
->portnr
;
1280 void usb_find_usb2_hub_address_port(struct usb_device
*udev
,
1281 uint8_t *hub_address
, uint8_t *hub_port
)
1283 /* Find out the nearest parent which is high speed */
1284 while (udev
->parent
->parent
!= NULL
)
1285 if (udev
->parent
->speed
!= USB_SPEED_HIGH
) {
1286 udev
= udev
->parent
;
1288 *hub_address
= udev
->parent
->devnum
;
1289 *hub_port
= udev
->portnr
;
1293 printf("Error: Cannot find high speed parent of usb-1 device\n");