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 #include <asm/4xx_pci.h>
44 #define USB_BUFSIZ 512
46 static int asynch_allowed
;
47 char usb_started
; /* flag for the started/stopped USB status */
50 static struct usb_device usb_dev
[USB_MAX_DEVICE
];
53 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
54 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
57 /***************************************************************************
63 struct usb_device
*dev
;
64 int i
, start_index
= 0;
65 int controllers_initialized
= 0;
72 /* first make all devices unknown */
73 for (i
= 0; i
< USB_MAX_DEVICE
; i
++) {
74 memset(&usb_dev
[i
], 0, sizeof(struct usb_device
));
75 usb_dev
[i
].devnum
= -1;
78 /* init low_level USB */
79 for (i
= 0; i
< CONFIG_USB_MAX_CONTROLLER_COUNT
; i
++) {
80 /* init low_level USB */
82 ret
= usb_lowlevel_init(i
, USB_INIT_HOST
, &ctrl
);
83 if (ret
== -ENODEV
) { /* No such device. */
84 puts("Port not available.\n");
85 controllers_initialized
++;
89 if (ret
) { /* Other error. */
90 puts("lowlevel init failed\n");
94 * lowlevel init is OK, now scan the bus for devices
95 * i.e. search HUBs and configure them
97 controllers_initialized
++;
98 start_index
= dev_index
;
99 printf("scanning bus %d for devices... ", i
);
100 ret
= usb_alloc_new_device(ctrl
, &dev
);
105 * device 0 is always present
106 * (root hub, so let it analyze)
108 ret
= usb_new_device(dev
);
110 usb_free_device(dev
->controller
);
112 if (start_index
== dev_index
) {
113 puts("No USB Device found\n");
116 printf("%d USB Device(s) found\n",
117 dev_index
- start_index
);
124 /* if we were not able to find at least one working bus, bail out */
125 if (controllers_initialized
== 0)
126 puts("USB error: all controllers failed lowlevel init\n");
128 return usb_started
? 0 : -ENODEV
;
131 /******************************************************************************
132 * Stop USB this stops the LowLevel Part and deregisters USB devices.
143 for (i
= 0; i
< CONFIG_USB_MAX_CONTROLLER_COUNT
; i
++) {
144 if (usb_lowlevel_stop(i
))
145 printf("failed to stop USB controller %d\n", i
);
152 /******************************************************************************
153 * Detect if a USB device has been plugged or unplugged.
155 int usb_detect_change(void)
160 for (j
= 0; j
< USB_MAX_DEVICE
; j
++) {
161 for (i
= 0; i
< usb_dev
[j
].maxchild
; i
++) {
162 struct usb_port_status status
;
164 if (usb_get_port_status(&usb_dev
[j
], i
+ 1,
166 /* USB request failed */
169 if (le16_to_cpu(status
.wPortChange
) &
170 USB_PORT_STAT_C_CONNECTION
)
179 * disables the asynch behaviour of the control message. This is used for data
180 * transfers that uses the exclusiv access to the control and bulk messages.
181 * Returns the old value so it can be restored later.
183 int usb_disable_asynch(int disable
)
185 int old_value
= asynch_allowed
;
187 asynch_allowed
= !disable
;
190 #endif /* !CONFIG_DM_USB */
193 /*-------------------------------------------------------------------
199 * submits an Interrupt Message
201 int usb_submit_int_msg(struct usb_device
*dev
, unsigned long pipe
,
202 void *buffer
, int transfer_len
, int interval
)
204 return submit_int_msg(dev
, pipe
, buffer
, transfer_len
, interval
);
208 * submits a control message and waits for comletion (at least timeout * 1ms)
209 * If timeout is 0, we don't wait for completion (used as example to set and
210 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
211 * allow control messages with 0 timeout, by previousely resetting the flag
212 * asynch_allowed (usb_disable_asynch(1)).
213 * returns the transferred length if OK or -1 if error. The transferred length
214 * and the current status are stored in the dev->act_len and dev->status.
216 int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
217 unsigned char request
, unsigned char requesttype
,
218 unsigned short value
, unsigned short index
,
219 void *data
, unsigned short size
, int timeout
)
221 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest
, setup_packet
, 1);
224 if ((timeout
== 0) && (!asynch_allowed
)) {
225 /* request for a asynch control pipe is not allowed */
229 /* set setup command */
230 setup_packet
->requesttype
= requesttype
;
231 setup_packet
->request
= request
;
232 setup_packet
->value
= cpu_to_le16(value
);
233 setup_packet
->index
= cpu_to_le16(index
);
234 setup_packet
->length
= cpu_to_le16(size
);
235 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
236 "value 0x%X index 0x%X length 0x%X\n",
237 request
, requesttype
, value
, index
, size
);
238 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
240 err
= submit_control_msg(dev
, pipe
, data
, size
, setup_packet
);
247 * Wait for status to update until timeout expires, USB driver
248 * interrupt handler may set the status when the USB operation has
252 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
263 /*-------------------------------------------------------------------
264 * submits bulk message, and waits for completion. returns 0 if Ok or
266 * synchronous behavior
268 int usb_bulk_msg(struct usb_device
*dev
, unsigned int pipe
,
269 void *data
, int len
, int *actual_length
, int timeout
)
273 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
274 if (submit_bulk_msg(dev
, pipe
, data
, len
) < 0)
277 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
281 *actual_length
= dev
->act_len
;
282 if (dev
->status
== 0)
289 /*-------------------------------------------------------------------
294 * returns the max packet size, depending on the pipe direction and
295 * the configurations values
297 int usb_maxpacket(struct usb_device
*dev
, unsigned long pipe
)
299 /* direction is out -> use emaxpacket out */
300 if ((pipe
& USB_DIR_IN
) == 0)
301 return dev
->epmaxpacketout
[((pipe
>>15) & 0xf)];
303 return dev
->epmaxpacketin
[((pipe
>>15) & 0xf)];
307 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
308 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
309 * when it is inlined in 1 single routine. What happens is that the register r3
310 * is used as loop-count 'i', but gets overwritten later on.
311 * This is clearly a compiler bug, but it is easier to workaround it here than
312 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
313 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
315 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
318 usb_set_maxpacket_ep(struct usb_device
*dev
, int if_idx
, int ep_idx
)
321 struct usb_endpoint_descriptor
*ep
;
322 u16 ep_wMaxPacketSize
;
324 ep
= &dev
->config
.if_desc
[if_idx
].ep_desc
[ep_idx
];
326 b
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
327 ep_wMaxPacketSize
= get_unaligned(&ep
->wMaxPacketSize
);
329 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
330 USB_ENDPOINT_XFER_CONTROL
) {
331 /* Control => bidirectional */
332 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
333 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
334 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
335 b
, dev
->epmaxpacketin
[b
]);
337 if ((ep
->bEndpointAddress
& 0x80) == 0) {
339 if (ep_wMaxPacketSize
> dev
->epmaxpacketout
[b
]) {
340 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
341 debug("##EP epmaxpacketout[%d] = %d\n",
342 b
, dev
->epmaxpacketout
[b
]);
346 if (ep_wMaxPacketSize
> dev
->epmaxpacketin
[b
]) {
347 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
348 debug("##EP epmaxpacketin[%d] = %d\n",
349 b
, dev
->epmaxpacketin
[b
]);
356 * set the max packed value of all endpoints in the given configuration
358 static int usb_set_maxpacket(struct usb_device
*dev
)
362 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++)
363 for (ii
= 0; ii
< dev
->config
.if_desc
[i
].desc
.bNumEndpoints
; ii
++)
364 usb_set_maxpacket_ep(dev
, i
, ii
);
369 /*******************************************************************************
370 * Parse the config, located in buffer, and fills the dev->config structure.
371 * Note that all little/big endian swapping are done automatically.
372 * (wTotalLength has already been swapped and sanitized when it was read.)
374 static int usb_parse_config(struct usb_device
*dev
,
375 unsigned char *buffer
, int cfgno
)
377 struct usb_descriptor_header
*head
;
378 int index
, ifno
, epno
, curr_if_num
;
379 u16 ep_wMaxPacketSize
;
380 struct usb_interface
*if_desc
= NULL
;
386 dev
->configno
= cfgno
;
387 head
= (struct usb_descriptor_header
*) &buffer
[0];
388 if (head
->bDescriptorType
!= USB_DT_CONFIG
) {
389 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
390 head
->bDescriptorType
);
393 if (head
->bLength
!= USB_DT_CONFIG_SIZE
) {
394 printf("ERROR: Invalid USB CFG length (%d)\n", head
->bLength
);
397 memcpy(&dev
->config
, head
, USB_DT_CONFIG_SIZE
);
398 dev
->config
.no_of_if
= 0;
400 index
= dev
->config
.desc
.bLength
;
401 /* Ok the first entry must be a configuration entry,
402 * now process the others */
403 head
= (struct usb_descriptor_header
*) &buffer
[index
];
404 while (index
+ 1 < dev
->config
.desc
.wTotalLength
&& head
->bLength
) {
405 switch (head
->bDescriptorType
) {
406 case USB_DT_INTERFACE
:
407 if (head
->bLength
!= USB_DT_INTERFACE_SIZE
) {
408 printf("ERROR: Invalid USB IF length (%d)\n",
412 if (index
+ USB_DT_INTERFACE_SIZE
>
413 dev
->config
.desc
.wTotalLength
) {
414 puts("USB IF descriptor overflowed buffer!\n");
417 if (((struct usb_interface_descriptor
*) \
418 head
)->bInterfaceNumber
!= curr_if_num
) {
419 /* this is a new interface, copy new desc */
420 ifno
= dev
->config
.no_of_if
;
421 if (ifno
>= USB_MAXINTERFACES
) {
422 puts("Too many USB interfaces!\n");
423 /* try to go on with what we have */
426 if_desc
= &dev
->config
.if_desc
[ifno
];
427 dev
->config
.no_of_if
++;
428 memcpy(if_desc
, head
,
429 USB_DT_INTERFACE_SIZE
);
430 if_desc
->no_of_ep
= 0;
431 if_desc
->num_altsetting
= 1;
433 if_desc
->desc
.bInterfaceNumber
;
435 /* found alternate setting for the interface */
437 if_desc
= &dev
->config
.if_desc
[ifno
];
438 if_desc
->num_altsetting
++;
442 case USB_DT_ENDPOINT
:
443 if (head
->bLength
!= USB_DT_ENDPOINT_SIZE
) {
444 printf("ERROR: Invalid USB EP length (%d)\n",
448 if (index
+ USB_DT_ENDPOINT_SIZE
>
449 dev
->config
.desc
.wTotalLength
) {
450 puts("USB EP descriptor overflowed buffer!\n");
454 puts("Endpoint descriptor out of order!\n");
457 epno
= dev
->config
.if_desc
[ifno
].no_of_ep
;
458 if_desc
= &dev
->config
.if_desc
[ifno
];
459 if (epno
>= USB_MAXENDPOINTS
) {
460 printf("Interface %d has too many endpoints!\n",
461 if_desc
->desc
.bInterfaceNumber
);
464 /* found an endpoint */
466 memcpy(&if_desc
->ep_desc
[epno
], head
,
467 USB_DT_ENDPOINT_SIZE
);
468 ep_wMaxPacketSize
= get_unaligned(&dev
->config
.\
472 put_unaligned(le16_to_cpu(ep_wMaxPacketSize
),
477 debug("if %d, ep %d\n", ifno
, epno
);
479 case USB_DT_SS_ENDPOINT_COMP
:
480 if (head
->bLength
!= USB_DT_SS_EP_COMP_SIZE
) {
481 printf("ERROR: Invalid USB EPC length (%d)\n",
485 if (index
+ USB_DT_SS_EP_COMP_SIZE
>
486 dev
->config
.desc
.wTotalLength
) {
487 puts("USB EPC descriptor overflowed buffer!\n");
490 if (ifno
< 0 || epno
< 0) {
491 puts("EPC descriptor out of order!\n");
494 if_desc
= &dev
->config
.if_desc
[ifno
];
495 memcpy(&if_desc
->ss_ep_comp_desc
[epno
], head
,
496 USB_DT_SS_EP_COMP_SIZE
);
499 if (head
->bLength
== 0)
502 debug("unknown Description Type : %x\n",
503 head
->bDescriptorType
);
507 unsigned char *ch
= (unsigned char *)head
;
510 for (i
= 0; i
< head
->bLength
; i
++)
511 debug("%02X ", *ch
++);
517 index
+= head
->bLength
;
518 head
= (struct usb_descriptor_header
*)&buffer
[index
];
523 /***********************************************************************
525 * endp: endpoint number in bits 0-3;
526 * direction flag in bit 7 (1 = IN, 0 = OUT)
528 int usb_clear_halt(struct usb_device
*dev
, int pipe
)
531 int endp
= usb_pipeendpoint(pipe
)|(usb_pipein(pipe
)<<7);
533 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
534 USB_REQ_CLEAR_FEATURE
, USB_RECIP_ENDPOINT
, 0,
535 endp
, NULL
, 0, USB_CNTL_TIMEOUT
* 3);
537 /* don't clear if failed */
542 * NOTE: we do not get status and verify reset was successful
543 * as some devices are reported to lock up upon this check..
546 usb_endpoint_running(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
));
548 /* toggle is reset on clear */
549 usb_settoggle(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
), 0);
554 /**********************************************************************
555 * get_descriptor type
557 static int usb_get_descriptor(struct usb_device
*dev
, unsigned char type
,
558 unsigned char index
, void *buf
, int size
)
561 res
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
562 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
563 (type
<< 8) + index
, 0,
564 buf
, size
, USB_CNTL_TIMEOUT
);
568 /**********************************************************************
569 * gets len of configuration cfgno
571 int usb_get_configuration_len(struct usb_device
*dev
, int cfgno
)
574 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer
, 9);
575 struct usb_config_descriptor
*config
;
577 config
= (struct usb_config_descriptor
*)&buffer
[0];
578 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, 9);
581 printf("unable to get descriptor, error %lX\n",
584 printf("config descriptor too short " \
585 "(expected %i, got %i)\n", 9, result
);
588 return le16_to_cpu(config
->wTotalLength
);
591 /**********************************************************************
592 * gets configuration cfgno and store it in the buffer
594 int usb_get_configuration_no(struct usb_device
*dev
, int cfgno
,
595 unsigned char *buffer
, int length
)
598 struct usb_config_descriptor
*config
;
600 config
= (struct usb_config_descriptor
*)&buffer
[0];
601 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, length
);
602 debug("get_conf_no %d Result %d, wLength %d\n", cfgno
, result
,
603 le16_to_cpu(config
->wTotalLength
));
604 config
->wTotalLength
= result
; /* validated, with CPU byte order */
609 /********************************************************************
610 * set address of a device to the value in dev->devnum.
611 * This can only be done by addressing the device via the default address (0)
613 static int usb_set_address(struct usb_device
*dev
)
617 debug("set address %d\n", dev
->devnum
);
618 res
= usb_control_msg(dev
, usb_snddefctrl(dev
),
619 USB_REQ_SET_ADDRESS
, 0,
621 NULL
, 0, USB_CNTL_TIMEOUT
);
625 /********************************************************************
626 * set interface number to interface
628 int usb_set_interface(struct usb_device
*dev
, int interface
, int alternate
)
630 struct usb_interface
*if_face
= NULL
;
633 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++) {
634 if (dev
->config
.if_desc
[i
].desc
.bInterfaceNumber
== interface
) {
635 if_face
= &dev
->config
.if_desc
[i
];
640 printf("selecting invalid interface %d", interface
);
644 * We should return now for devices with only one alternate setting.
645 * According to 9.4.10 of the Universal Serial Bus Specification
646 * Revision 2.0 such devices can return with a STALL. This results in
647 * some USB sticks timeouting during initialization and then being
648 * unusable in U-Boot.
650 if (if_face
->num_altsetting
== 1)
653 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
654 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
655 alternate
, interface
, NULL
, 0,
656 USB_CNTL_TIMEOUT
* 5);
663 /********************************************************************
664 * set configuration number to configuration
666 static int usb_set_configuration(struct usb_device
*dev
, int configuration
)
669 debug("set configuration %d\n", configuration
);
670 /* set setup command */
671 res
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
672 USB_REQ_SET_CONFIGURATION
, 0,
674 NULL
, 0, USB_CNTL_TIMEOUT
);
683 /********************************************************************
684 * set protocol to protocol
686 int usb_set_protocol(struct usb_device
*dev
, int ifnum
, int protocol
)
688 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
689 USB_REQ_SET_PROTOCOL
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
690 protocol
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
693 /********************************************************************
696 int usb_set_idle(struct usb_device
*dev
, int ifnum
, int duration
, int report_id
)
698 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
699 USB_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
700 (duration
<< 8) | report_id
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
703 /********************************************************************
706 int usb_get_report(struct usb_device
*dev
, int ifnum
, unsigned char type
,
707 unsigned char id
, void *buf
, int size
)
709 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
711 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
712 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
715 /********************************************************************
716 * get class descriptor
718 int usb_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
719 unsigned char type
, unsigned char id
, void *buf
, int size
)
721 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
722 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
723 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
726 /********************************************************************
727 * get string index in buffer
729 static int usb_get_string(struct usb_device
*dev
, unsigned short langid
,
730 unsigned char index
, void *buf
, int size
)
735 for (i
= 0; i
< 3; ++i
) {
736 /* some devices are flaky */
737 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
738 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
739 (USB_DT_STRING
<< 8) + index
, langid
, buf
, size
,
750 static void usb_try_string_workarounds(unsigned char *buf
, int *length
)
752 int newlength
, oldlength
= *length
;
754 for (newlength
= 2; newlength
+ 1 < oldlength
; newlength
+= 2)
755 if (!isprint(buf
[newlength
]) || buf
[newlength
+ 1])
765 static int usb_string_sub(struct usb_device
*dev
, unsigned int langid
,
766 unsigned int index
, unsigned char *buf
)
770 /* Try to read the string descriptor by asking for the maximum
771 * possible number of bytes */
772 rc
= usb_get_string(dev
, langid
, index
, buf
, 255);
774 /* If that failed try to read the descriptor length, then
775 * ask for just that many bytes */
777 rc
= usb_get_string(dev
, langid
, index
, buf
, 2);
779 rc
= usb_get_string(dev
, langid
, index
, buf
, buf
[0]);
783 if (!buf
[0] && !buf
[1])
784 usb_try_string_workarounds(buf
, &rc
);
786 /* There might be extra junk at the end of the descriptor */
790 rc
= rc
- (rc
& 1); /* force a multiple of two */
800 /********************************************************************
802 * Get string index and translate it to ascii.
803 * returns string length (> 0) or error (< 0)
805 int usb_string(struct usb_device
*dev
, int index
, char *buf
, size_t size
)
807 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf
, USB_BUFSIZ
);
812 if (size
<= 0 || !buf
|| !index
)
817 /* get langid for strings if it's not yet known */
818 if (!dev
->have_langid
) {
819 err
= usb_string_sub(dev
, 0, 0, tbuf
);
821 debug("error getting string descriptor 0 " \
822 "(error=%lx)\n", dev
->status
);
824 } else if (tbuf
[0] < 4) {
825 debug("string descriptor 0 too short\n");
828 dev
->have_langid
= -1;
829 dev
->string_langid
= tbuf
[2] | (tbuf
[3] << 8);
830 /* always use the first langid listed */
831 debug("USB device number %d default " \
832 "language ID 0x%x\n",
833 dev
->devnum
, dev
->string_langid
);
837 err
= usb_string_sub(dev
, dev
->string_langid
, index
, tbuf
);
841 size
--; /* leave room for trailing NULL char in output buffer */
842 for (idx
= 0, u
= 2; u
< err
; u
+= 2) {
845 if (tbuf
[u
+1]) /* high byte */
846 buf
[idx
++] = '?'; /* non-ASCII character */
848 buf
[idx
++] = tbuf
[u
];
856 /********************************************************************
857 * USB device handling:
858 * the USB device are static allocated [USB_MAX_DEVICE].
861 #ifndef CONFIG_DM_USB
863 /* returns a pointer to the device with the index [index].
864 * if the device is not assigned (dev->devnum==-1) returns NULL
866 struct usb_device
*usb_get_dev_index(int index
)
868 if (usb_dev
[index
].devnum
== -1)
871 return &usb_dev
[index
];
874 int usb_alloc_new_device(struct udevice
*controller
, struct usb_device
**devp
)
877 debug("New Device %d\n", dev_index
);
878 if (dev_index
== USB_MAX_DEVICE
) {
879 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE
);
882 /* default Address is 0, real addresses start with 1 */
883 usb_dev
[dev_index
].devnum
= dev_index
+ 1;
884 usb_dev
[dev_index
].maxchild
= 0;
885 for (i
= 0; i
< USB_MAXCHILDREN
; i
++)
886 usb_dev
[dev_index
].children
[i
] = NULL
;
887 usb_dev
[dev_index
].parent
= NULL
;
888 usb_dev
[dev_index
].controller
= controller
;
890 *devp
= &usb_dev
[dev_index
- 1];
896 * Free the newly created device node.
897 * Called in error cases where configuring a newly attached
898 * device fails for some reason.
900 void usb_free_device(struct udevice
*controller
)
903 debug("Freeing device node: %d\n", dev_index
);
904 memset(&usb_dev
[dev_index
], 0, sizeof(struct usb_device
));
905 usb_dev
[dev_index
].devnum
= -1;
909 * XHCI issues Enable Slot command and thereafter
910 * allocates device contexts. Provide a weak alias
911 * function for the purpose, so that XHCI overrides it
912 * and EHCI/OHCI just work out of the box.
914 __weak
int usb_alloc_device(struct usb_device
*udev
)
918 #endif /* !CONFIG_DM_USB */
920 static int usb_hub_port_reset(struct usb_device
*dev
, struct usb_device
*hub
)
923 usb_reset_root_port(dev
);
928 static int get_descriptor_len(struct usb_device
*dev
, int len
, int expect_len
)
930 __maybe_unused
struct usb_device_descriptor
*desc
;
931 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf
, USB_BUFSIZ
);
934 desc
= (struct usb_device_descriptor
*)tmpbuf
;
936 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0, desc
, len
);
937 if (err
< expect_len
) {
939 printf("unable to get device descriptor (error=%d)\n",
943 printf("USB device descriptor short read (expected %i, got %i)\n",
948 memcpy(&dev
->descriptor
, tmpbuf
, sizeof(dev
->descriptor
));
953 static int usb_setup_descriptor(struct usb_device
*dev
, bool do_read
)
956 * This is a Windows scheme of initialization sequence, with double
957 * reset of the device (Linux uses the same sequence)
958 * Some equipment is said to work only with such init sequence; this
959 * patch is based on the work by Alan Stern:
960 * http://sourceforge.net/mailarchive/forum.php?
961 * thread_id=5729457&forum_id=5398
965 * send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
966 * only 18 bytes long, this will terminate with a short packet. But if
967 * the maxpacket size is 8 or 16 the device may be waiting to transmit
968 * some more, or keeps on retransmitting the 8 byte header.
971 if (dev
->speed
== USB_SPEED_LOW
) {
972 dev
->descriptor
.bMaxPacketSize0
= 8;
973 dev
->maxpacketsize
= PACKET_SIZE_8
;
975 dev
->descriptor
.bMaxPacketSize0
= 64;
976 dev
->maxpacketsize
= PACKET_SIZE_64
;
978 dev
->epmaxpacketin
[0] = dev
->descriptor
.bMaxPacketSize0
;
979 dev
->epmaxpacketout
[0] = dev
->descriptor
.bMaxPacketSize0
;
985 * Validate we've received only at least 8 bytes, not that we've
986 * received the entire descriptor. The reasoning is:
987 * - The code only uses fields in the first 8 bytes, so that's all we
988 * need to have fetched at this stage.
989 * - The smallest maxpacket size is 8 bytes. Before we know the actual
990 * maxpacket the device uses, the USB controller may only accept a
991 * single packet. Consequently we are only guaranteed to receive 1
992 * packet (at least 8 bytes) even in a non-error case.
994 * At least the DWC2 controller needs to be programmed with the number
995 * of packets in addition to the number of bytes. A request for 64
996 * bytes of data with the maxpacket guessed as 64 (above) yields a
997 * request for 1 packet.
999 err
= get_descriptor_len(dev
, 64, 8);
1004 dev
->epmaxpacketin
[0] = dev
->descriptor
.bMaxPacketSize0
;
1005 dev
->epmaxpacketout
[0] = dev
->descriptor
.bMaxPacketSize0
;
1006 switch (dev
->descriptor
.bMaxPacketSize0
) {
1008 dev
->maxpacketsize
= PACKET_SIZE_8
;
1011 dev
->maxpacketsize
= PACKET_SIZE_16
;
1014 dev
->maxpacketsize
= PACKET_SIZE_32
;
1017 dev
->maxpacketsize
= PACKET_SIZE_64
;
1020 printf("usb_new_device: invalid max packet size\n");
1027 static int usb_prepare_device(struct usb_device
*dev
, int addr
, bool do_read
,
1028 struct usb_device
*parent
)
1033 * Allocate usb 3.0 device context.
1034 * USB 3.0 (xHCI) protocol tries to allocate device slot
1035 * and related data structures first. This call does that.
1036 * Refer to sec 4.3.2 in xHCI spec rev1.0
1038 err
= usb_alloc_device(dev
);
1040 printf("Cannot allocate device context to get SLOT_ID\n");
1043 err
= usb_setup_descriptor(dev
, do_read
);
1046 err
= usb_hub_port_reset(dev
, parent
);
1052 err
= usb_set_address(dev
); /* set address */
1055 printf("\n USB device not accepting new address " \
1056 "(error=%lX)\n", dev
->status
);
1060 mdelay(10); /* Let the SET_ADDRESS settle */
1065 int usb_select_config(struct usb_device
*dev
)
1067 unsigned char *tmpbuf
= NULL
;
1070 err
= get_descriptor_len(dev
, USB_DT_DEVICE_SIZE
, USB_DT_DEVICE_SIZE
);
1074 /* correct le values */
1075 le16_to_cpus(&dev
->descriptor
.bcdUSB
);
1076 le16_to_cpus(&dev
->descriptor
.idVendor
);
1077 le16_to_cpus(&dev
->descriptor
.idProduct
);
1078 le16_to_cpus(&dev
->descriptor
.bcdDevice
);
1081 * Kingston DT Ultimate 32GB USB 3.0 seems to be extremely sensitive
1082 * about this first Get Descriptor request. If there are any other
1083 * requests in the first microframe, the stick crashes. Wait about
1084 * one microframe duration here (1mS for USB 1.x , 125uS for USB 2.0).
1088 /* only support for one config for now */
1089 err
= usb_get_configuration_len(dev
, 0);
1091 tmpbuf
= (unsigned char *)malloc_cache_aligned(err
);
1095 err
= usb_get_configuration_no(dev
, 0, tmpbuf
, err
);
1098 printf("usb_new_device: Cannot read configuration, " \
1099 "skipping device %04x:%04x\n",
1100 dev
->descriptor
.idVendor
, dev
->descriptor
.idProduct
);
1104 usb_parse_config(dev
, tmpbuf
, 0);
1106 usb_set_maxpacket(dev
);
1108 * we set the default configuration here
1109 * This seems premature. If the driver wants a different configuration
1110 * it will need to select itself.
1112 err
= usb_set_configuration(dev
, dev
->config
.desc
.bConfigurationValue
);
1114 printf("failed to set default configuration " \
1115 "len %d, status %lX\n", dev
->act_len
, dev
->status
);
1120 * Wait until the Set Configuration request gets processed by the
1121 * device. This is required by at least SanDisk Cruzer Pop USB 2.0
1122 * and Kingston DT Ultimate 32GB USB 3.0 on DWC2 OTG controller.
1126 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1127 dev
->descriptor
.iManufacturer
, dev
->descriptor
.iProduct
,
1128 dev
->descriptor
.iSerialNumber
);
1129 memset(dev
->mf
, 0, sizeof(dev
->mf
));
1130 memset(dev
->prod
, 0, sizeof(dev
->prod
));
1131 memset(dev
->serial
, 0, sizeof(dev
->serial
));
1132 if (dev
->descriptor
.iManufacturer
)
1133 usb_string(dev
, dev
->descriptor
.iManufacturer
,
1134 dev
->mf
, sizeof(dev
->mf
));
1135 if (dev
->descriptor
.iProduct
)
1136 usb_string(dev
, dev
->descriptor
.iProduct
,
1137 dev
->prod
, sizeof(dev
->prod
));
1138 if (dev
->descriptor
.iSerialNumber
)
1139 usb_string(dev
, dev
->descriptor
.iSerialNumber
,
1140 dev
->serial
, sizeof(dev
->serial
));
1141 debug("Manufacturer %s\n", dev
->mf
);
1142 debug("Product %s\n", dev
->prod
);
1143 debug("SerialNumber %s\n", dev
->serial
);
1148 int usb_setup_device(struct usb_device
*dev
, bool do_read
,
1149 struct usb_device
*parent
)
1154 /* We still haven't set the Address yet */
1158 ret
= usb_prepare_device(dev
, addr
, do_read
, parent
);
1161 ret
= usb_select_config(dev
);
1166 #ifndef CONFIG_DM_USB
1168 * By the time we get here, the device has gotten a new device ID
1169 * and is in the default state. We need to identify the thing and
1170 * get the ball rolling..
1172 * Returns 0 for success, != 0 for error.
1174 int usb_new_device(struct usb_device
*dev
)
1176 bool do_read
= true;
1180 * XHCI needs to issue a Address device command to setup
1181 * proper device context structures, before it can interact
1182 * with the device. So a get_descriptor will fail before any
1183 * of that is done for XHCI unlike EHCI.
1185 #ifdef CONFIG_USB_XHCI
1188 err
= usb_setup_device(dev
, do_read
, dev
->parent
);
1192 /* Now probe if the device is a hub */
1193 err
= usb_hub_probe(dev
, 0);
1202 int board_usb_init(int index
, enum usb_init_type init
)
1208 int board_usb_cleanup(int index
, enum usb_init_type init
)
1213 bool usb_device_has_child_on_port(struct usb_device
*parent
, int port
)
1215 #ifdef CONFIG_DM_USB
1218 return parent
->children
[port
] != NULL
;
1222 #ifdef CONFIG_DM_USB
1223 void usb_find_usb2_hub_address_port(struct usb_device
*udev
,
1224 uint8_t *hub_address
, uint8_t *hub_port
)
1226 struct udevice
*parent
;
1227 struct usb_device
*uparent
, *ttdev
;
1230 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1231 * to the parent udevice, not the actual udevice belonging to the
1232 * udev as the device is not instantiated yet. So when searching
1233 * for the first usb-2 parent start with udev->dev not
1234 * udev->dev->parent .
1238 uparent
= dev_get_parent_priv(parent
);
1240 while (uparent
->speed
!= USB_SPEED_HIGH
) {
1241 struct udevice
*dev
= parent
;
1243 if (device_get_uclass_id(dev
->parent
) != UCLASS_USB_HUB
) {
1244 printf("Error: Cannot find high speed parent of usb-1 device\n");
1250 ttdev
= dev_get_parent_priv(dev
);
1251 parent
= dev
->parent
;
1252 uparent
= dev_get_parent_priv(parent
);
1254 *hub_address
= uparent
->devnum
;
1255 *hub_port
= ttdev
->portnr
;
1258 void usb_find_usb2_hub_address_port(struct usb_device
*udev
,
1259 uint8_t *hub_address
, uint8_t *hub_port
)
1261 /* Find out the nearest parent which is high speed */
1262 while (udev
->parent
->parent
!= NULL
)
1263 if (udev
->parent
->speed
!= USB_SPEED_HIGH
) {
1264 udev
= udev
->parent
;
1266 *hub_address
= udev
->parent
->devnum
;
1267 *hub_port
= udev
->portnr
;
1271 printf("Error: Cannot find high speed parent of usb-1 device\n");