]> git.sur5r.net Git - u-boot/blob - common/usb.c
Revert "ARM: SPL: do not set gd again"
[u-boot] / common / usb.c
1 /*
2  * Most of this source has been derived from the Linux USB
3  * project:
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)
13  *
14  * Adapted for U-Boot:
15  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
16  *
17  * SPDX-License-Identifier:     GPL-2.0+
18  */
19
20 /*
21  * How it works:
22  *
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
25  * device should work.
26  *
27  * For each transfer (except "Interrupt") we wait for completion.
28  */
29 #include <common.h>
30 #include <command.h>
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>
36 #include <compiler.h>
37 #include <errno.h>
38 #include <usb.h>
39 #ifdef CONFIG_4xx
40 #include <asm/4xx_pci.h>
41 #endif
42
43 #define USB_BUFSIZ      512
44
45 static struct usb_device usb_dev[USB_MAX_DEVICE];
46 static int dev_index;
47 static int asynch_allowed;
48
49 char usb_started; /* flag for the started/stopped USB status */
50
51 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
52 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
53 #endif
54
55 /***************************************************************************
56  * Init USB Device
57  */
58 int usb_init(void)
59 {
60         void *ctrl;
61         struct usb_device *dev;
62         int i, start_index = 0;
63         int ret;
64
65         dev_index = 0;
66         asynch_allowed = 1;
67         usb_hub_reset();
68
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;
73         }
74
75         /* init low_level USB */
76         for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
77                 /* init low_level USB */
78                 printf("USB%d:   ", i);
79                 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
80                 if (ret == -ENODEV) {   /* No such device. */
81                         puts("Port not available.\n");
82                         continue;
83                 }
84
85                 if (ret) {              /* Other error. */
86                         puts("lowlevel init failed\n");
87                         continue;
88                 }
89                 /*
90                  * lowlevel init is OK, now scan the bus for devices
91                  * i.e. search HUBs and configure them
92                  */
93                 start_index = dev_index;
94                 printf("scanning bus %d for devices... ", i);
95                 dev = usb_alloc_new_device(ctrl);
96                 /*
97                  * device 0 is always present
98                  * (root hub, so let it analyze)
99                  */
100                 if (dev)
101                         usb_new_device(dev);
102
103                 if (start_index == dev_index)
104                         puts("No USB Device found\n");
105                 else
106                         printf("%d USB Device(s) found\n",
107                                 dev_index - start_index);
108
109                 usb_started = 1;
110         }
111
112         debug("scan end\n");
113         /* if we were not able to find at least one working bus, bail out */
114         if (!usb_started) {
115                 puts("USB error: all controllers failed lowlevel init\n");
116                 return -1;
117         }
118
119         return 0;
120 }
121
122 /******************************************************************************
123  * Stop USB this stops the LowLevel Part and deregisters USB devices.
124  */
125 int usb_stop(void)
126 {
127         int i;
128
129         if (usb_started) {
130                 asynch_allowed = 1;
131                 usb_started = 0;
132                 usb_hub_reset();
133
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);
137                 }
138         }
139
140         return 0;
141 }
142
143 /*
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.
147  */
148 int usb_disable_asynch(int disable)
149 {
150         int old_value = asynch_allowed;
151
152         asynch_allowed = !disable;
153         return old_value;
154 }
155
156
157 /*-------------------------------------------------------------------
158  * Message wrappers.
159  *
160  */
161
162 /*
163  * submits an Interrupt Message
164  */
165 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
166                         void *buffer, int transfer_len, int interval)
167 {
168         return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
169 }
170
171 /*
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.
179  */
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)
184 {
185         ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
186
187         if ((timeout == 0) && (!asynch_allowed)) {
188                 /* request for a asynch control pipe is not allowed */
189                 return -1;
190         }
191
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 */
202
203         if (submit_control_msg(dev, pipe, data, size, setup_packet) < 0)
204                 return -1;
205         if (timeout == 0)
206                 return (int)size;
207
208         /*
209          * Wait for status to update until timeout expires, USB driver
210          * interrupt handler may set the status when the USB operation has
211          * been completed.
212          */
213         while (timeout--) {
214                 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
215                         break;
216                 mdelay(1);
217         }
218         if (dev->status)
219                 return -1;
220
221         return dev->act_len;
222
223 }
224
225 /*-------------------------------------------------------------------
226  * submits bulk message, and waits for completion. returns 0 if Ok or
227  * -1 if Error.
228  * synchronous behavior
229  */
230 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
231                         void *data, int len, int *actual_length, int timeout)
232 {
233         if (len < 0)
234                 return -1;
235         dev->status = USB_ST_NOT_PROC; /*not yet processed */
236         if (submit_bulk_msg(dev, pipe, data, len) < 0)
237                 return -1;
238         while (timeout--) {
239                 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
240                         break;
241                 mdelay(1);
242         }
243         *actual_length = dev->act_len;
244         if (dev->status == 0)
245                 return 0;
246         else
247                 return -1;
248 }
249
250
251 /*-------------------------------------------------------------------
252  * Max Packet stuff
253  */
254
255 /*
256  * returns the max packet size, depending on the pipe direction and
257  * the configurations values
258  */
259 int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
260 {
261         /* direction is out -> use emaxpacket out */
262         if ((pipe & USB_DIR_IN) == 0)
263                 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
264         else
265                 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
266 }
267
268 /*
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)
276  *
277  * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
278  */
279 static void noinline
280 usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
281 {
282         int b;
283         struct usb_endpoint_descriptor *ep;
284         u16 ep_wMaxPacketSize;
285
286         ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
287
288         b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
289         ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
290
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]);
298         } else {
299                 if ((ep->bEndpointAddress & 0x80) == 0) {
300                         /* OUT Endpoint */
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]);
305                         }
306                 } else {
307                         /* IN Endpoint */
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]);
312                         }
313                 } /* if out */
314         } /* if control */
315 }
316
317 /*
318  * set the max packed value of all endpoints in the given configuration
319  */
320 static int usb_set_maxpacket(struct usb_device *dev)
321 {
322         int i, ii;
323
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);
327
328         return 0;
329 }
330
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.)
335  */
336 static int usb_parse_config(struct usb_device *dev,
337                         unsigned char *buffer, int cfgno)
338 {
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;
343
344         ifno = -1;
345         epno = -1;
346         curr_if_num = -1;
347
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);
353                 return -1;
354         }
355         if (head->bLength != USB_DT_CONFIG_SIZE) {
356                 printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
357                 return -1;
358         }
359         memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
360         dev->config.no_of_if = 0;
361
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",
371                                         head->bLength);
372                                 break;
373                         }
374                         if (index + USB_DT_INTERFACE_SIZE >
375                             dev->config.desc.wTotalLength) {
376                                 puts("USB IF descriptor overflowed buffer!\n");
377                                 break;
378                         }
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 */
386                                         return 1;
387                                 }
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;
394                                 curr_if_num =
395                                      if_desc->desc.bInterfaceNumber;
396                         } else {
397                                 /* found alternate setting for the interface */
398                                 if (ifno >= 0) {
399                                         if_desc = &dev->config.if_desc[ifno];
400                                         if_desc->num_altsetting++;
401                                 }
402                         }
403                         break;
404                 case USB_DT_ENDPOINT:
405                         if (head->bLength != USB_DT_ENDPOINT_SIZE) {
406                                 printf("ERROR: Invalid USB EP length (%d)\n",
407                                         head->bLength);
408                                 break;
409                         }
410                         if (index + USB_DT_ENDPOINT_SIZE >
411                             dev->config.desc.wTotalLength) {
412                                 puts("USB EP descriptor overflowed buffer!\n");
413                                 break;
414                         }
415                         if (ifno < 0) {
416                                 puts("Endpoint descriptor out of order!\n");
417                                 break;
418                         }
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);
424                                 return 1;
425                         }
426                         /* found an endpoint */
427                         if_desc->no_of_ep++;
428                         memcpy(&if_desc->ep_desc[epno], head,
429                                 USB_DT_ENDPOINT_SIZE);
430                         ep_wMaxPacketSize = get_unaligned(&dev->config.\
431                                                         if_desc[ifno].\
432                                                         ep_desc[epno].\
433                                                         wMaxPacketSize);
434                         put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
435                                         &dev->config.\
436                                         if_desc[ifno].\
437                                         ep_desc[epno].\
438                                         wMaxPacketSize);
439                         debug("if %d, ep %d\n", ifno, epno);
440                         break;
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",
444                                         head->bLength);
445                                 break;
446                         }
447                         if (index + USB_DT_SS_EP_COMP_SIZE >
448                             dev->config.desc.wTotalLength) {
449                                 puts("USB EPC descriptor overflowed buffer!\n");
450                                 break;
451                         }
452                         if (ifno < 0 || epno < 0) {
453                                 puts("EPC descriptor out of order!\n");
454                                 break;
455                         }
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);
459                         break;
460                 default:
461                         if (head->bLength == 0)
462                                 return 1;
463
464                         debug("unknown Description Type : %x\n",
465                               head->bDescriptorType);
466
467 #ifdef DEBUG
468                         {
469                                 unsigned char *ch = (unsigned char *)head;
470                                 int i;
471
472                                 for (i = 0; i < head->bLength; i++)
473                                         debug("%02X ", *ch++);
474                                 debug("\n\n\n");
475                         }
476 #endif
477                         break;
478                 }
479                 index += head->bLength;
480                 head = (struct usb_descriptor_header *)&buffer[index];
481         }
482         return 1;
483 }
484
485 /***********************************************************************
486  * Clears an endpoint
487  * endp: endpoint number in bits 0-3;
488  * direction flag in bit 7 (1 = IN, 0 = OUT)
489  */
490 int usb_clear_halt(struct usb_device *dev, int pipe)
491 {
492         int result;
493         int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
494
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);
498
499         /* don't clear if failed */
500         if (result < 0)
501                 return result;
502
503         /*
504          * NOTE: we do not get status and verify reset was successful
505          * as some devices are reported to lock up upon this check..
506          */
507
508         usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
509
510         /* toggle is reset on clear */
511         usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
512         return 0;
513 }
514
515
516 /**********************************************************************
517  * get_descriptor type
518  */
519 static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
520                         unsigned char index, void *buf, int size)
521 {
522         int res;
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);
527         return res;
528 }
529
530 /**********************************************************************
531  * gets configuration cfgno and store it in the buffer
532  */
533 int usb_get_configuration_no(struct usb_device *dev,
534                              unsigned char *buffer, int cfgno)
535 {
536         int result;
537         unsigned int length;
538         struct usb_config_descriptor *config;
539
540         config = (struct usb_config_descriptor *)&buffer[0];
541         result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
542         if (result < 9) {
543                 if (result < 0)
544                         printf("unable to get descriptor, error %lX\n",
545                                 dev->status);
546                 else
547                         printf("config descriptor too short " \
548                                 "(expected %i, got %i)\n", 9, result);
549                 return -1;
550         }
551         length = le16_to_cpu(config->wTotalLength);
552
553         if (length > USB_BUFSIZ) {
554                 printf("%s: failed to get descriptor - too long: %d\n",
555                         __func__, length);
556                 return -1;
557         }
558
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 */
562
563         return result;
564 }
565
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)
569  */
570 static int usb_set_address(struct usb_device *dev)
571 {
572         int res;
573
574         debug("set address %d\n", dev->devnum);
575         res = usb_control_msg(dev, usb_snddefctrl(dev),
576                                 USB_REQ_SET_ADDRESS, 0,
577                                 (dev->devnum), 0,
578                                 NULL, 0, USB_CNTL_TIMEOUT);
579         return res;
580 }
581
582 /********************************************************************
583  * set interface number to interface
584  */
585 int usb_set_interface(struct usb_device *dev, int interface, int alternate)
586 {
587         struct usb_interface *if_face = NULL;
588         int ret, i;
589
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];
593                         break;
594                 }
595         }
596         if (!if_face) {
597                 printf("selecting invalid interface %d", interface);
598                 return -1;
599         }
600         /*
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.
606          */
607         if (if_face->num_altsetting == 1)
608                 return 0;
609
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);
614         if (ret < 0)
615                 return ret;
616
617         return 0;
618 }
619
620 /********************************************************************
621  * set configuration number to configuration
622  */
623 static int usb_set_configuration(struct usb_device *dev, int configuration)
624 {
625         int res;
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,
630                                 configuration, 0,
631                                 NULL, 0, USB_CNTL_TIMEOUT);
632         if (res == 0) {
633                 dev->toggle[0] = 0;
634                 dev->toggle[1] = 0;
635                 return 0;
636         } else
637                 return -1;
638 }
639
640 /********************************************************************
641  * set protocol to protocol
642  */
643 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
644 {
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);
648 }
649
650 /********************************************************************
651  * set idle
652  */
653 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
654 {
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);
658 }
659
660 /********************************************************************
661  * get report
662  */
663 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
664                    unsigned char id, void *buf, int size)
665 {
666         return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
667                         USB_REQ_GET_REPORT,
668                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
669                         (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
670 }
671
672 /********************************************************************
673  * get class descriptor
674  */
675 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
676                 unsigned char type, unsigned char id, void *buf, int size)
677 {
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);
681 }
682
683 /********************************************************************
684  * get string index in buffer
685  */
686 static int usb_get_string(struct usb_device *dev, unsigned short langid,
687                    unsigned char index, void *buf, int size)
688 {
689         int i;
690         int result;
691
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,
697                         USB_CNTL_TIMEOUT);
698
699                 if (result > 0)
700                         break;
701         }
702
703         return result;
704 }
705
706
707 static void usb_try_string_workarounds(unsigned char *buf, int *length)
708 {
709         int newlength, oldlength = *length;
710
711         for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
712                 if (!isprint(buf[newlength]) || buf[newlength + 1])
713                         break;
714
715         if (newlength > 2) {
716                 buf[0] = newlength;
717                 *length = newlength;
718         }
719 }
720
721
722 static int usb_string_sub(struct usb_device *dev, unsigned int langid,
723                 unsigned int index, unsigned char *buf)
724 {
725         int rc;
726
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);
730
731         /* If that failed try to read the descriptor length, then
732          * ask for just that many bytes */
733         if (rc < 2) {
734                 rc = usb_get_string(dev, langid, index, buf, 2);
735                 if (rc == 2)
736                         rc = usb_get_string(dev, langid, index, buf, buf[0]);
737         }
738
739         if (rc >= 2) {
740                 if (!buf[0] && !buf[1])
741                         usb_try_string_workarounds(buf, &rc);
742
743                 /* There might be extra junk at the end of the descriptor */
744                 if (buf[0] < rc)
745                         rc = buf[0];
746
747                 rc = rc - (rc & 1); /* force a multiple of two */
748         }
749
750         if (rc < 2)
751                 rc = -1;
752
753         return rc;
754 }
755
756
757 /********************************************************************
758  * usb_string:
759  * Get string index and translate it to ascii.
760  * returns string length (> 0) or error (< 0)
761  */
762 int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
763 {
764         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ);
765         unsigned char *tbuf;
766         int err;
767         unsigned int u, idx;
768
769         if (size <= 0 || !buf || !index)
770                 return -1;
771         buf[0] = 0;
772         tbuf = &mybuf[0];
773
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);
777                 if (err < 0) {
778                         debug("error getting string descriptor 0 " \
779                               "(error=%lx)\n", dev->status);
780                         return -1;
781                 } else if (tbuf[0] < 4) {
782                         debug("string descriptor 0 too short\n");
783                         return -1;
784                 } else {
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);
791                 }
792         }
793
794         err = usb_string_sub(dev, dev->string_langid, index, tbuf);
795         if (err < 0)
796                 return err;
797
798         size--;         /* leave room for trailing NULL char in output buffer */
799         for (idx = 0, u = 2; u < err; u += 2) {
800                 if (idx >= size)
801                         break;
802                 if (tbuf[u+1])                  /* high byte */
803                         buf[idx++] = '?';  /* non-ASCII character */
804                 else
805                         buf[idx++] = tbuf[u];
806         }
807         buf[idx] = 0;
808         err = idx;
809         return err;
810 }
811
812
813 /********************************************************************
814  * USB device handling:
815  * the USB device are static allocated [USB_MAX_DEVICE].
816  */
817
818
819 /* returns a pointer to the device with the index [index].
820  * if the device is not assigned (dev->devnum==-1) returns NULL
821  */
822 struct usb_device *usb_get_dev_index(int index)
823 {
824         if (usb_dev[index].devnum == -1)
825                 return NULL;
826         else
827                 return &usb_dev[index];
828 }
829
830 /* returns a pointer of a new device structure or NULL, if
831  * no device struct is available
832  */
833 struct usb_device *usb_alloc_new_device(void *controller)
834 {
835         int i;
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);
839                 return NULL;
840         }
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;
848         dev_index++;
849         return &usb_dev[dev_index - 1];
850 }
851
852 /*
853  * Free the newly created device node.
854  * Called in error cases where configuring a newly attached
855  * device fails for some reason.
856  */
857 void usb_free_device(void)
858 {
859         dev_index--;
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;
863 }
864
865 /*
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.
870  */
871 __weak int usb_alloc_device(struct usb_device *udev)
872 {
873         return 0;
874 }
875 /*
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..
879  *
880  * Returns 0 for success, != 0 for error.
881  */
882 int usb_new_device(struct usb_device *dev)
883 {
884         int addr, err;
885         int tmp;
886         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
887
888         /*
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
893          */
894         if (usb_alloc_device(dev)) {
895                 printf("Cannot allocate device context to get SLOT_ID\n");
896                 return -1;
897         }
898
899         /* We still haven't set the Address yet */
900         addr = dev->devnum;
901         dev->devnum = 0;
902
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;
913
914         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, tmpbuf, 8);
915         if (err < 8) {
916                 printf("\n      USB device not responding, " \
917                        "giving up (status=%lX)\n", dev->status);
918                 return 1;
919         }
920         memcpy(&dev->descriptor, tmpbuf, 8);
921 #else
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
928          */
929         __maybe_unused struct usb_device_descriptor *desc;
930         int port = -1;
931         struct usb_device *parent = dev->parent;
932         unsigned short portstatus;
933
934         /* send 64-byte GET-DEVICE-DESCRIPTOR request.  Since the descriptor is
935          * only 18 bytes long, this will terminate with a short packet.  But if
936          * the maxpacket size is 8 or 16 the device may be waiting to transmit
937          * some more, or keeps on retransmitting the 8 byte header. */
938
939         desc = (struct usb_device_descriptor *)tmpbuf;
940         dev->descriptor.bMaxPacketSize0 = 64;       /* Start off at 64 bytes  */
941         /* Default to 64 byte max packet size */
942         dev->maxpacketsize = PACKET_SIZE_64;
943         dev->epmaxpacketin[0] = 64;
944         dev->epmaxpacketout[0] = 64;
945
946         /*
947          * XHCI needs to issue a Address device command to setup
948          * proper device context structures, before it can interact
949          * with the device. So a get_descriptor will fail before any
950          * of that is done for XHCI unlike EHCI.
951          */
952 #ifndef CONFIG_USB_XHCI
953         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
954         if (err < 0) {
955                 debug("usb_new_device: usb_get_descriptor() failed\n");
956                 return 1;
957         }
958
959         dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
960         /*
961          * Fetch the device class, driver can use this info
962          * to differentiate between HUB and DEVICE.
963          */
964         dev->descriptor.bDeviceClass = desc->bDeviceClass;
965 #endif
966
967         if (parent) {
968                 int j;
969
970                 /* find the port number we're at */
971                 for (j = 0; j < parent->maxchild; j++) {
972                         if (parent->children[j] == dev) {
973                                 port = j;
974                                 break;
975                         }
976                 }
977                 if (port < 0) {
978                         printf("usb_new_device:cannot locate device's port.\n");
979                         return 1;
980                 }
981
982                 /* reset the port for the second time */
983                 err = hub_port_reset(dev->parent, port, &portstatus);
984                 if (err < 0) {
985                         printf("\n     Couldn't reset port %i\n", port);
986                         return 1;
987                 }
988         }
989 #endif
990
991         dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
992         dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
993         switch (dev->descriptor.bMaxPacketSize0) {
994         case 8:
995                 dev->maxpacketsize  = PACKET_SIZE_8;
996                 break;
997         case 16:
998                 dev->maxpacketsize = PACKET_SIZE_16;
999                 break;
1000         case 32:
1001                 dev->maxpacketsize = PACKET_SIZE_32;
1002                 break;
1003         case 64:
1004                 dev->maxpacketsize = PACKET_SIZE_64;
1005                 break;
1006         }
1007         dev->devnum = addr;
1008
1009         err = usb_set_address(dev); /* set address */
1010
1011         if (err < 0) {
1012                 printf("\n      USB device not accepting new address " \
1013                         "(error=%lX)\n", dev->status);
1014                 return 1;
1015         }
1016
1017         mdelay(10);     /* Let the SET_ADDRESS settle */
1018
1019         tmp = sizeof(dev->descriptor);
1020
1021         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
1022                                  tmpbuf, sizeof(dev->descriptor));
1023         if (err < tmp) {
1024                 if (err < 0)
1025                         printf("unable to get device descriptor (error=%d)\n",
1026                                err);
1027                 else
1028                         printf("USB device descriptor short read " \
1029                                 "(expected %i, got %i)\n", tmp, err);
1030                 return 1;
1031         }
1032         memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
1033         /* correct le values */
1034         le16_to_cpus(&dev->descriptor.bcdUSB);
1035         le16_to_cpus(&dev->descriptor.idVendor);
1036         le16_to_cpus(&dev->descriptor.idProduct);
1037         le16_to_cpus(&dev->descriptor.bcdDevice);
1038         /* only support for one config for now */
1039         err = usb_get_configuration_no(dev, tmpbuf, 0);
1040         if (err < 0) {
1041                 printf("usb_new_device: Cannot read configuration, " \
1042                        "skipping device %04x:%04x\n",
1043                        dev->descriptor.idVendor, dev->descriptor.idProduct);
1044                 return -1;
1045         }
1046         usb_parse_config(dev, tmpbuf, 0);
1047         usb_set_maxpacket(dev);
1048         /* we set the default configuration here */
1049         if (usb_set_configuration(dev, dev->config.desc.bConfigurationValue)) {
1050                 printf("failed to set default configuration " \
1051                         "len %d, status %lX\n", dev->act_len, dev->status);
1052                 return -1;
1053         }
1054         debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1055               dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1056               dev->descriptor.iSerialNumber);
1057         memset(dev->mf, 0, sizeof(dev->mf));
1058         memset(dev->prod, 0, sizeof(dev->prod));
1059         memset(dev->serial, 0, sizeof(dev->serial));
1060         if (dev->descriptor.iManufacturer)
1061                 usb_string(dev, dev->descriptor.iManufacturer,
1062                            dev->mf, sizeof(dev->mf));
1063         if (dev->descriptor.iProduct)
1064                 usb_string(dev, dev->descriptor.iProduct,
1065                            dev->prod, sizeof(dev->prod));
1066         if (dev->descriptor.iSerialNumber)
1067                 usb_string(dev, dev->descriptor.iSerialNumber,
1068                            dev->serial, sizeof(dev->serial));
1069         debug("Manufacturer %s\n", dev->mf);
1070         debug("Product      %s\n", dev->prod);
1071         debug("SerialNumber %s\n", dev->serial);
1072         /* now prode if the device is a hub */
1073         usb_hub_probe(dev, 0);
1074         return 0;
1075 }
1076
1077 __weak
1078 int board_usb_init(int index, enum usb_init_type init)
1079 {
1080         return 0;
1081 }
1082 /* EOF */