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.
31 #include <asm/processor.h>
32 #include <linux/compiler.h>
33 #include <linux/ctype.h>
34 #include <asm/byteorder.h>
35 #include <asm/unaligned.h>
39 #include <asm/4xx_pci.h>
42 #define USB_BUFSIZ 512
44 static struct usb_device usb_dev
[USB_MAX_DEVICE
];
46 static int asynch_allowed
;
48 char usb_started
; /* flag for the started/stopped USB status */
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 dev
= usb_alloc_new_device(ctrl
);
99 * device 0 is always present
100 * (root hub, so let it analyze)
105 if (start_index
== dev_index
)
106 puts("No USB Device found\n");
108 printf("%d USB Device(s) found\n",
109 dev_index
- start_index
);
115 /* if we were not able to find at least one working bus, bail out */
116 if (controllers_initialized
== 0)
117 puts("USB error: all controllers failed lowlevel init\n");
119 return usb_started
? 0 : -1;
122 /******************************************************************************
123 * Stop USB this stops the LowLevel Part and deregisters USB devices.
134 for (i
= 0; i
< CONFIG_USB_MAX_CONTROLLER_COUNT
; i
++) {
135 if (usb_lowlevel_stop(i
))
136 printf("failed to stop USB controller %d\n", i
);
144 * disables the asynch behaviour of the control message. This is used for data
145 * transfers that uses the exclusiv access to the control and bulk messages.
146 * Returns the old value so it can be restored later.
148 int usb_disable_asynch(int disable
)
150 int old_value
= asynch_allowed
;
152 asynch_allowed
= !disable
;
157 /*-------------------------------------------------------------------
163 * submits an Interrupt Message
165 int usb_submit_int_msg(struct usb_device
*dev
, unsigned long pipe
,
166 void *buffer
, int transfer_len
, int interval
)
168 return submit_int_msg(dev
, pipe
, buffer
, transfer_len
, interval
);
172 * submits a control message and waits for comletion (at least timeout * 1ms)
173 * If timeout is 0, we don't wait for completion (used as example to set and
174 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
175 * allow control messages with 0 timeout, by previousely resetting the flag
176 * asynch_allowed (usb_disable_asynch(1)).
177 * returns the transfered length if OK or -1 if error. The transfered length
178 * and the current status are stored in the dev->act_len and dev->status.
180 int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
181 unsigned char request
, unsigned char requesttype
,
182 unsigned short value
, unsigned short index
,
183 void *data
, unsigned short size
, int timeout
)
185 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest
, setup_packet
, 1);
187 if ((timeout
== 0) && (!asynch_allowed
)) {
188 /* request for a asynch control pipe is not allowed */
192 /* set setup command */
193 setup_packet
->requesttype
= requesttype
;
194 setup_packet
->request
= request
;
195 setup_packet
->value
= cpu_to_le16(value
);
196 setup_packet
->index
= cpu_to_le16(index
);
197 setup_packet
->length
= cpu_to_le16(size
);
198 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
199 "value 0x%X index 0x%X length 0x%X\n",
200 request
, requesttype
, value
, index
, size
);
201 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
203 if (submit_control_msg(dev
, pipe
, data
, size
, setup_packet
) < 0)
209 * Wait for status to update until timeout expires, USB driver
210 * interrupt handler may set the status when the USB operation has
214 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
225 /*-------------------------------------------------------------------
226 * submits bulk message, and waits for completion. returns 0 if Ok or
228 * synchronous behavior
230 int usb_bulk_msg(struct usb_device
*dev
, unsigned int pipe
,
231 void *data
, int len
, int *actual_length
, int timeout
)
235 dev
->status
= USB_ST_NOT_PROC
; /*not yet processed */
236 if (submit_bulk_msg(dev
, pipe
, data
, len
) < 0)
239 if (!((volatile unsigned long)dev
->status
& USB_ST_NOT_PROC
))
243 *actual_length
= dev
->act_len
;
244 if (dev
->status
== 0)
251 /*-------------------------------------------------------------------
256 * returns the max packet size, depending on the pipe direction and
257 * the configurations values
259 int usb_maxpacket(struct usb_device
*dev
, unsigned long pipe
)
261 /* direction is out -> use emaxpacket out */
262 if ((pipe
& USB_DIR_IN
) == 0)
263 return dev
->epmaxpacketout
[((pipe
>>15) & 0xf)];
265 return dev
->epmaxpacketin
[((pipe
>>15) & 0xf)];
269 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
270 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
271 * when it is inlined in 1 single routine. What happens is that the register r3
272 * is used as loop-count 'i', but gets overwritten later on.
273 * This is clearly a compiler bug, but it is easier to workaround it here than
274 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
275 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
277 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
280 usb_set_maxpacket_ep(struct usb_device
*dev
, int if_idx
, int ep_idx
)
283 struct usb_endpoint_descriptor
*ep
;
284 u16 ep_wMaxPacketSize
;
286 ep
= &dev
->config
.if_desc
[if_idx
].ep_desc
[ep_idx
];
288 b
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
289 ep_wMaxPacketSize
= get_unaligned(&ep
->wMaxPacketSize
);
291 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
292 USB_ENDPOINT_XFER_CONTROL
) {
293 /* Control => bidirectional */
294 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
295 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
296 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
297 b
, dev
->epmaxpacketin
[b
]);
299 if ((ep
->bEndpointAddress
& 0x80) == 0) {
301 if (ep_wMaxPacketSize
> dev
->epmaxpacketout
[b
]) {
302 dev
->epmaxpacketout
[b
] = ep_wMaxPacketSize
;
303 debug("##EP epmaxpacketout[%d] = %d\n",
304 b
, dev
->epmaxpacketout
[b
]);
308 if (ep_wMaxPacketSize
> dev
->epmaxpacketin
[b
]) {
309 dev
->epmaxpacketin
[b
] = ep_wMaxPacketSize
;
310 debug("##EP epmaxpacketin[%d] = %d\n",
311 b
, dev
->epmaxpacketin
[b
]);
318 * set the max packed value of all endpoints in the given configuration
320 static int usb_set_maxpacket(struct usb_device
*dev
)
324 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++)
325 for (ii
= 0; ii
< dev
->config
.if_desc
[i
].desc
.bNumEndpoints
; ii
++)
326 usb_set_maxpacket_ep(dev
, i
, ii
);
331 /*******************************************************************************
332 * Parse the config, located in buffer, and fills the dev->config structure.
333 * Note that all little/big endian swapping are done automatically.
334 * (wTotalLength has already been swapped and sanitized when it was read.)
336 static int usb_parse_config(struct usb_device
*dev
,
337 unsigned char *buffer
, int cfgno
)
339 struct usb_descriptor_header
*head
;
340 int index
, ifno
, epno
, curr_if_num
;
341 u16 ep_wMaxPacketSize
;
342 struct usb_interface
*if_desc
= NULL
;
348 dev
->configno
= cfgno
;
349 head
= (struct usb_descriptor_header
*) &buffer
[0];
350 if (head
->bDescriptorType
!= USB_DT_CONFIG
) {
351 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
352 head
->bDescriptorType
);
355 if (head
->bLength
!= USB_DT_CONFIG_SIZE
) {
356 printf("ERROR: Invalid USB CFG length (%d)\n", head
->bLength
);
359 memcpy(&dev
->config
, head
, USB_DT_CONFIG_SIZE
);
360 dev
->config
.no_of_if
= 0;
362 index
= dev
->config
.desc
.bLength
;
363 /* Ok the first entry must be a configuration entry,
364 * now process the others */
365 head
= (struct usb_descriptor_header
*) &buffer
[index
];
366 while (index
+ 1 < dev
->config
.desc
.wTotalLength
&& head
->bLength
) {
367 switch (head
->bDescriptorType
) {
368 case USB_DT_INTERFACE
:
369 if (head
->bLength
!= USB_DT_INTERFACE_SIZE
) {
370 printf("ERROR: Invalid USB IF length (%d)\n",
374 if (index
+ USB_DT_INTERFACE_SIZE
>
375 dev
->config
.desc
.wTotalLength
) {
376 puts("USB IF descriptor overflowed buffer!\n");
379 if (((struct usb_interface_descriptor
*) \
380 head
)->bInterfaceNumber
!= curr_if_num
) {
381 /* this is a new interface, copy new desc */
382 ifno
= dev
->config
.no_of_if
;
383 if (ifno
>= USB_MAXINTERFACES
) {
384 puts("Too many USB interfaces!\n");
385 /* try to go on with what we have */
388 if_desc
= &dev
->config
.if_desc
[ifno
];
389 dev
->config
.no_of_if
++;
390 memcpy(if_desc
, head
,
391 USB_DT_INTERFACE_SIZE
);
392 if_desc
->no_of_ep
= 0;
393 if_desc
->num_altsetting
= 1;
395 if_desc
->desc
.bInterfaceNumber
;
397 /* found alternate setting for the interface */
399 if_desc
= &dev
->config
.if_desc
[ifno
];
400 if_desc
->num_altsetting
++;
404 case USB_DT_ENDPOINT
:
405 if (head
->bLength
!= USB_DT_ENDPOINT_SIZE
) {
406 printf("ERROR: Invalid USB EP length (%d)\n",
410 if (index
+ USB_DT_ENDPOINT_SIZE
>
411 dev
->config
.desc
.wTotalLength
) {
412 puts("USB EP descriptor overflowed buffer!\n");
416 puts("Endpoint descriptor out of order!\n");
419 epno
= dev
->config
.if_desc
[ifno
].no_of_ep
;
420 if_desc
= &dev
->config
.if_desc
[ifno
];
421 if (epno
> USB_MAXENDPOINTS
) {
422 printf("Interface %d has too many endpoints!\n",
423 if_desc
->desc
.bInterfaceNumber
);
426 /* found an endpoint */
428 memcpy(&if_desc
->ep_desc
[epno
], head
,
429 USB_DT_ENDPOINT_SIZE
);
430 ep_wMaxPacketSize
= get_unaligned(&dev
->config
.\
434 put_unaligned(le16_to_cpu(ep_wMaxPacketSize
),
439 debug("if %d, ep %d\n", ifno
, epno
);
441 case USB_DT_SS_ENDPOINT_COMP
:
442 if (head
->bLength
!= USB_DT_SS_EP_COMP_SIZE
) {
443 printf("ERROR: Invalid USB EPC length (%d)\n",
447 if (index
+ USB_DT_SS_EP_COMP_SIZE
>
448 dev
->config
.desc
.wTotalLength
) {
449 puts("USB EPC descriptor overflowed buffer!\n");
452 if (ifno
< 0 || epno
< 0) {
453 puts("EPC descriptor out of order!\n");
456 if_desc
= &dev
->config
.if_desc
[ifno
];
457 memcpy(&if_desc
->ss_ep_comp_desc
[epno
], head
,
458 USB_DT_SS_EP_COMP_SIZE
);
461 if (head
->bLength
== 0)
464 debug("unknown Description Type : %x\n",
465 head
->bDescriptorType
);
469 unsigned char *ch
= (unsigned char *)head
;
472 for (i
= 0; i
< head
->bLength
; i
++)
473 debug("%02X ", *ch
++);
479 index
+= head
->bLength
;
480 head
= (struct usb_descriptor_header
*)&buffer
[index
];
485 /***********************************************************************
487 * endp: endpoint number in bits 0-3;
488 * direction flag in bit 7 (1 = IN, 0 = OUT)
490 int usb_clear_halt(struct usb_device
*dev
, int pipe
)
493 int endp
= usb_pipeendpoint(pipe
)|(usb_pipein(pipe
)<<7);
495 result
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
496 USB_REQ_CLEAR_FEATURE
, USB_RECIP_ENDPOINT
, 0,
497 endp
, NULL
, 0, USB_CNTL_TIMEOUT
* 3);
499 /* don't clear if failed */
504 * NOTE: we do not get status and verify reset was successful
505 * as some devices are reported to lock up upon this check..
508 usb_endpoint_running(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
));
510 /* toggle is reset on clear */
511 usb_settoggle(dev
, usb_pipeendpoint(pipe
), usb_pipeout(pipe
), 0);
516 /**********************************************************************
517 * get_descriptor type
519 static int usb_get_descriptor(struct usb_device
*dev
, unsigned char type
,
520 unsigned char index
, void *buf
, int size
)
523 res
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
524 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
525 (type
<< 8) + index
, 0,
526 buf
, size
, USB_CNTL_TIMEOUT
);
530 /**********************************************************************
531 * gets configuration cfgno and store it in the buffer
533 int usb_get_configuration_no(struct usb_device
*dev
,
534 unsigned char *buffer
, int cfgno
)
538 struct usb_config_descriptor
*config
;
540 config
= (struct usb_config_descriptor
*)&buffer
[0];
541 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, 9);
544 printf("unable to get descriptor, error %lX\n",
547 printf("config descriptor too short " \
548 "(expected %i, got %i)\n", 9, result
);
551 length
= le16_to_cpu(config
->wTotalLength
);
553 if (length
> USB_BUFSIZ
) {
554 printf("%s: failed to get descriptor - too long: %d\n",
559 result
= usb_get_descriptor(dev
, USB_DT_CONFIG
, cfgno
, buffer
, length
);
560 debug("get_conf_no %d Result %d, wLength %d\n", cfgno
, result
, length
);
561 config
->wTotalLength
= length
; /* validated, with CPU byte order */
566 /********************************************************************
567 * set address of a device to the value in dev->devnum.
568 * This can only be done by addressing the device via the default address (0)
570 static int usb_set_address(struct usb_device
*dev
)
574 debug("set address %d\n", dev
->devnum
);
575 res
= usb_control_msg(dev
, usb_snddefctrl(dev
),
576 USB_REQ_SET_ADDRESS
, 0,
578 NULL
, 0, USB_CNTL_TIMEOUT
);
582 /********************************************************************
583 * set interface number to interface
585 int usb_set_interface(struct usb_device
*dev
, int interface
, int alternate
)
587 struct usb_interface
*if_face
= NULL
;
590 for (i
= 0; i
< dev
->config
.desc
.bNumInterfaces
; i
++) {
591 if (dev
->config
.if_desc
[i
].desc
.bInterfaceNumber
== interface
) {
592 if_face
= &dev
->config
.if_desc
[i
];
597 printf("selecting invalid interface %d", interface
);
601 * We should return now for devices with only one alternate setting.
602 * According to 9.4.10 of the Universal Serial Bus Specification
603 * Revision 2.0 such devices can return with a STALL. This results in
604 * some USB sticks timeouting during initialization and then being
605 * unusable in U-Boot.
607 if (if_face
->num_altsetting
== 1)
610 ret
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
611 USB_REQ_SET_INTERFACE
, USB_RECIP_INTERFACE
,
612 alternate
, interface
, NULL
, 0,
613 USB_CNTL_TIMEOUT
* 5);
620 /********************************************************************
621 * set configuration number to configuration
623 static int usb_set_configuration(struct usb_device
*dev
, int configuration
)
626 debug("set configuration %d\n", configuration
);
627 /* set setup command */
628 res
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
629 USB_REQ_SET_CONFIGURATION
, 0,
631 NULL
, 0, USB_CNTL_TIMEOUT
);
640 /********************************************************************
641 * set protocol to protocol
643 int usb_set_protocol(struct usb_device
*dev
, int ifnum
, int protocol
)
645 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
646 USB_REQ_SET_PROTOCOL
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
647 protocol
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
650 /********************************************************************
653 int usb_set_idle(struct usb_device
*dev
, int ifnum
, int duration
, int report_id
)
655 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
656 USB_REQ_SET_IDLE
, USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
657 (duration
<< 8) | report_id
, ifnum
, NULL
, 0, USB_CNTL_TIMEOUT
);
660 /********************************************************************
663 int usb_get_report(struct usb_device
*dev
, int ifnum
, unsigned char type
,
664 unsigned char id
, void *buf
, int size
)
666 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
668 USB_DIR_IN
| USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
669 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
672 /********************************************************************
673 * get class descriptor
675 int usb_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
676 unsigned char type
, unsigned char id
, void *buf
, int size
)
678 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
679 USB_REQ_GET_DESCRIPTOR
, USB_RECIP_INTERFACE
| USB_DIR_IN
,
680 (type
<< 8) + id
, ifnum
, buf
, size
, USB_CNTL_TIMEOUT
);
683 /********************************************************************
684 * get string index in buffer
686 static int usb_get_string(struct usb_device
*dev
, unsigned short langid
,
687 unsigned char index
, void *buf
, int size
)
692 for (i
= 0; i
< 3; ++i
) {
693 /* some devices are flaky */
694 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
695 USB_REQ_GET_DESCRIPTOR
, USB_DIR_IN
,
696 (USB_DT_STRING
<< 8) + index
, langid
, buf
, size
,
707 static void usb_try_string_workarounds(unsigned char *buf
, int *length
)
709 int newlength
, oldlength
= *length
;
711 for (newlength
= 2; newlength
+ 1 < oldlength
; newlength
+= 2)
712 if (!isprint(buf
[newlength
]) || buf
[newlength
+ 1])
722 static int usb_string_sub(struct usb_device
*dev
, unsigned int langid
,
723 unsigned int index
, unsigned char *buf
)
727 /* Try to read the string descriptor by asking for the maximum
728 * possible number of bytes */
729 rc
= usb_get_string(dev
, langid
, index
, buf
, 255);
731 /* If that failed try to read the descriptor length, then
732 * ask for just that many bytes */
734 rc
= usb_get_string(dev
, langid
, index
, buf
, 2);
736 rc
= usb_get_string(dev
, langid
, index
, buf
, buf
[0]);
740 if (!buf
[0] && !buf
[1])
741 usb_try_string_workarounds(buf
, &rc
);
743 /* There might be extra junk at the end of the descriptor */
747 rc
= rc
- (rc
& 1); /* force a multiple of two */
757 /********************************************************************
759 * Get string index and translate it to ascii.
760 * returns string length (> 0) or error (< 0)
762 int usb_string(struct usb_device
*dev
, int index
, char *buf
, size_t size
)
764 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf
, USB_BUFSIZ
);
769 if (size
<= 0 || !buf
|| !index
)
774 /* get langid for strings if it's not yet known */
775 if (!dev
->have_langid
) {
776 err
= usb_string_sub(dev
, 0, 0, tbuf
);
778 debug("error getting string descriptor 0 " \
779 "(error=%lx)\n", dev
->status
);
781 } else if (tbuf
[0] < 4) {
782 debug("string descriptor 0 too short\n");
785 dev
->have_langid
= -1;
786 dev
->string_langid
= tbuf
[2] | (tbuf
[3] << 8);
787 /* always use the first langid listed */
788 debug("USB device number %d default " \
789 "language ID 0x%x\n",
790 dev
->devnum
, dev
->string_langid
);
794 err
= usb_string_sub(dev
, dev
->string_langid
, index
, tbuf
);
798 size
--; /* leave room for trailing NULL char in output buffer */
799 for (idx
= 0, u
= 2; u
< err
; u
+= 2) {
802 if (tbuf
[u
+1]) /* high byte */
803 buf
[idx
++] = '?'; /* non-ASCII character */
805 buf
[idx
++] = tbuf
[u
];
813 /********************************************************************
814 * USB device handling:
815 * the USB device are static allocated [USB_MAX_DEVICE].
819 /* returns a pointer to the device with the index [index].
820 * if the device is not assigned (dev->devnum==-1) returns NULL
822 struct usb_device
*usb_get_dev_index(int index
)
824 if (usb_dev
[index
].devnum
== -1)
827 return &usb_dev
[index
];
830 /* returns a pointer of a new device structure or NULL, if
831 * no device struct is available
833 struct usb_device
*usb_alloc_new_device(void *controller
)
836 debug("New Device %d\n", dev_index
);
837 if (dev_index
== USB_MAX_DEVICE
) {
838 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE
);
841 /* default Address is 0, real addresses start with 1 */
842 usb_dev
[dev_index
].devnum
= dev_index
+ 1;
843 usb_dev
[dev_index
].maxchild
= 0;
844 for (i
= 0; i
< USB_MAXCHILDREN
; i
++)
845 usb_dev
[dev_index
].children
[i
] = NULL
;
846 usb_dev
[dev_index
].parent
= NULL
;
847 usb_dev
[dev_index
].controller
= controller
;
849 return &usb_dev
[dev_index
- 1];
853 * Free the newly created device node.
854 * Called in error cases where configuring a newly attached
855 * device fails for some reason.
857 void usb_free_device(void)
860 debug("Freeing device node: %d\n", dev_index
);
861 memset(&usb_dev
[dev_index
], 0, sizeof(struct usb_device
));
862 usb_dev
[dev_index
].devnum
= -1;
866 * XHCI issues Enable Slot command and thereafter
867 * allocates device contexts. Provide a weak alias
868 * function for the purpose, so that XHCI overrides it
869 * and EHCI/OHCI just work out of the box.
871 __weak
int usb_alloc_device(struct usb_device
*udev
)
876 * By the time we get here, the device has gotten a new device ID
877 * and is in the default state. We need to identify the thing and
878 * get the ball rolling..
880 * Returns 0 for success, != 0 for error.
882 int usb_new_device(struct usb_device
*dev
)
886 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf
, USB_BUFSIZ
);
889 * Allocate usb 3.0 device context.
890 * USB 3.0 (xHCI) protocol tries to allocate device slot
891 * and related data structures first. This call does that.
892 * Refer to sec 4.3.2 in xHCI spec rev1.0
894 if (usb_alloc_device(dev
)) {
895 printf("Cannot allocate device context to get SLOT_ID\n");
899 /* We still haven't set the Address yet */
903 #ifdef CONFIG_LEGACY_USB_INIT_SEQ
904 /* this is the old and known way of initializing devices, it is
905 * different than what Windows and Linux are doing. Windows and Linux
906 * both retrieve 64 bytes while reading the device descriptor
907 * Several USB stick devices report ERR: CTL_TIMEOUT, caused by an
908 * invalid header while reading 8 bytes as device descriptor. */
909 dev
->descriptor
.bMaxPacketSize0
= 8; /* Start off at 8 bytes */
910 dev
->maxpacketsize
= PACKET_SIZE_8
;
911 dev
->epmaxpacketin
[0] = 8;
912 dev
->epmaxpacketout
[0] = 8;
914 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0, tmpbuf
, 8);
916 printf("\n USB device not responding, " \
917 "giving up (status=%lX)\n", dev
->status
);
920 memcpy(&dev
->descriptor
, tmpbuf
, 8);
922 /* This is a Windows scheme of initialization sequence, with double
923 * reset of the device (Linux uses the same sequence)
924 * Some equipment is said to work only with such init sequence; this
925 * patch is based on the work by Alan Stern:
926 * http://sourceforge.net/mailarchive/forum.php?
927 * thread_id=5729457&forum_id=5398
929 __maybe_unused
struct usb_device_descriptor
*desc
;
930 struct usb_device
*parent
= dev
->parent
;
931 unsigned short portstatus
;
933 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
934 * only 18 bytes long, this will terminate with a short packet. But if
935 * the maxpacket size is 8 or 16 the device may be waiting to transmit
936 * some more, or keeps on retransmitting the 8 byte header. */
938 desc
= (struct usb_device_descriptor
*)tmpbuf
;
939 dev
->descriptor
.bMaxPacketSize0
= 64; /* Start off at 64 bytes */
940 /* Default to 64 byte max packet size */
941 dev
->maxpacketsize
= PACKET_SIZE_64
;
942 dev
->epmaxpacketin
[0] = 64;
943 dev
->epmaxpacketout
[0] = 64;
946 * XHCI needs to issue a Address device command to setup
947 * proper device context structures, before it can interact
948 * with the device. So a get_descriptor will fail before any
949 * of that is done for XHCI unlike EHCI.
951 #ifndef CONFIG_USB_XHCI
952 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0, desc
, 64);
954 debug("usb_new_device: usb_get_descriptor() failed\n");
958 dev
->descriptor
.bMaxPacketSize0
= desc
->bMaxPacketSize0
;
960 * Fetch the device class, driver can use this info
961 * to differentiate between HUB and DEVICE.
963 dev
->descriptor
.bDeviceClass
= desc
->bDeviceClass
;
967 /* reset the port for the second time */
968 err
= hub_port_reset(dev
->parent
, dev
->portnr
- 1, &portstatus
);
970 printf("\n Couldn't reset port %i\n", dev
->portnr
);
974 usb_reset_root_port();
978 dev
->epmaxpacketin
[0] = dev
->descriptor
.bMaxPacketSize0
;
979 dev
->epmaxpacketout
[0] = dev
->descriptor
.bMaxPacketSize0
;
980 switch (dev
->descriptor
.bMaxPacketSize0
) {
982 dev
->maxpacketsize
= PACKET_SIZE_8
;
985 dev
->maxpacketsize
= PACKET_SIZE_16
;
988 dev
->maxpacketsize
= PACKET_SIZE_32
;
991 dev
->maxpacketsize
= PACKET_SIZE_64
;
996 err
= usb_set_address(dev
); /* set address */
999 printf("\n USB device not accepting new address " \
1000 "(error=%lX)\n", dev
->status
);
1004 mdelay(10); /* Let the SET_ADDRESS settle */
1006 tmp
= sizeof(dev
->descriptor
);
1008 err
= usb_get_descriptor(dev
, USB_DT_DEVICE
, 0,
1009 tmpbuf
, sizeof(dev
->descriptor
));
1012 printf("unable to get device descriptor (error=%d)\n",
1015 printf("USB device descriptor short read " \
1016 "(expected %i, got %i)\n", tmp
, err
);
1019 memcpy(&dev
->descriptor
, tmpbuf
, sizeof(dev
->descriptor
));
1020 /* correct le values */
1021 le16_to_cpus(&dev
->descriptor
.bcdUSB
);
1022 le16_to_cpus(&dev
->descriptor
.idVendor
);
1023 le16_to_cpus(&dev
->descriptor
.idProduct
);
1024 le16_to_cpus(&dev
->descriptor
.bcdDevice
);
1025 /* only support for one config for now */
1026 err
= usb_get_configuration_no(dev
, tmpbuf
, 0);
1028 printf("usb_new_device: Cannot read configuration, " \
1029 "skipping device %04x:%04x\n",
1030 dev
->descriptor
.idVendor
, dev
->descriptor
.idProduct
);
1033 usb_parse_config(dev
, tmpbuf
, 0);
1034 usb_set_maxpacket(dev
);
1035 /* we set the default configuration here */
1036 if (usb_set_configuration(dev
, dev
->config
.desc
.bConfigurationValue
)) {
1037 printf("failed to set default configuration " \
1038 "len %d, status %lX\n", dev
->act_len
, dev
->status
);
1041 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1042 dev
->descriptor
.iManufacturer
, dev
->descriptor
.iProduct
,
1043 dev
->descriptor
.iSerialNumber
);
1044 memset(dev
->mf
, 0, sizeof(dev
->mf
));
1045 memset(dev
->prod
, 0, sizeof(dev
->prod
));
1046 memset(dev
->serial
, 0, sizeof(dev
->serial
));
1047 if (dev
->descriptor
.iManufacturer
)
1048 usb_string(dev
, dev
->descriptor
.iManufacturer
,
1049 dev
->mf
, sizeof(dev
->mf
));
1050 if (dev
->descriptor
.iProduct
)
1051 usb_string(dev
, dev
->descriptor
.iProduct
,
1052 dev
->prod
, sizeof(dev
->prod
));
1053 if (dev
->descriptor
.iSerialNumber
)
1054 usb_string(dev
, dev
->descriptor
.iSerialNumber
,
1055 dev
->serial
, sizeof(dev
->serial
));
1056 debug("Manufacturer %s\n", dev
->mf
);
1057 debug("Product %s\n", dev
->prod
);
1058 debug("SerialNumber %s\n", dev
->serial
);
1059 /* now prode if the device is a hub */
1060 usb_hub_probe(dev
, 0);
1065 int board_usb_init(int index
, enum usb_init_type init
)