xref: /openbmc/u-boot/common/usb.c (revision 6828e602b722d1137d17ca0d25a451c7743c2770)
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 <dm.h>
32  #include <memalign.h>
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>
38  #include <errno.h>
39  #include <usb.h>
40  #ifdef CONFIG_4xx
41  #include <asm/4xx_pci.h>
42  #endif
43  
44  #define USB_BUFSIZ	512
45  
46  static int asynch_allowed;
47  char usb_started; /* flag for the started/stopped USB status */
48  
49  #ifndef CONFIG_DM_USB
50  static struct usb_device usb_dev[USB_MAX_DEVICE];
51  static int dev_index;
52  
53  #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
54  #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
55  #endif
56  
57  /***************************************************************************
58   * Init USB Device
59   */
60  int usb_init(void)
61  {
62  	void *ctrl;
63  	struct usb_device *dev;
64  	int i, start_index = 0;
65  	int controllers_initialized = 0;
66  	int ret;
67  
68  	dev_index = 0;
69  	asynch_allowed = 1;
70  	usb_hub_reset();
71  
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;
76  	}
77  
78  	/* init low_level USB */
79  	for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
80  		/* init low_level USB */
81  		printf("USB%d:   ", i);
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++;
86  			continue;
87  		}
88  
89  		if (ret) {		/* Other error. */
90  			puts("lowlevel init failed\n");
91  			continue;
92  		}
93  		/*
94  		 * lowlevel init is OK, now scan the bus for devices
95  		 * i.e. search HUBs and configure them
96  		 */
97  		controllers_initialized++;
98  		start_index = dev_index;
99  		printf("scanning bus %d for devices... ", i);
100  		ret = usb_alloc_new_device(ctrl, &dev);
101  		if (ret)
102  			break;
103  
104  		/*
105  		 * device 0 is always present
106  		 * (root hub, so let it analyze)
107  		 */
108  		ret = usb_new_device(dev);
109  		if (ret)
110  			usb_free_device(dev->controller);
111  
112  		if (start_index == dev_index) {
113  			puts("No USB Device found\n");
114  			continue;
115  		} else {
116  			printf("%d USB Device(s) found\n",
117  				dev_index - start_index);
118  		}
119  
120  		usb_started = 1;
121  	}
122  
123  	debug("scan end\n");
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");
127  
128  	return usb_started ? 0 : -ENODEV;
129  }
130  
131  /******************************************************************************
132   * Stop USB this stops the LowLevel Part and deregisters USB devices.
133   */
134  int usb_stop(void)
135  {
136  	int i;
137  
138  	if (usb_started) {
139  		asynch_allowed = 1;
140  		usb_started = 0;
141  		usb_hub_reset();
142  
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);
146  		}
147  	}
148  
149  	return 0;
150  }
151  
152  /******************************************************************************
153   * Detect if a USB device has been plugged or unplugged.
154   */
155  int usb_detect_change(void)
156  {
157  	int i, j;
158  	int change = 0;
159  
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;
163  
164  			if (usb_get_port_status(&usb_dev[j], i + 1,
165  						&status) < 0)
166  				/* USB request failed */
167  				continue;
168  
169  			if (le16_to_cpu(status.wPortChange) &
170  			    USB_PORT_STAT_C_CONNECTION)
171  				change++;
172  		}
173  	}
174  
175  	return change;
176  }
177  
178  /*
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.
182   */
183  int usb_disable_asynch(int disable)
184  {
185  	int old_value = asynch_allowed;
186  
187  	asynch_allowed = !disable;
188  	return old_value;
189  }
190  #endif /* !CONFIG_DM_USB */
191  
192  
193  /*-------------------------------------------------------------------
194   * Message wrappers.
195   *
196   */
197  
198  /*
199   * submits an Interrupt Message
200   */
201  int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
202  			void *buffer, int transfer_len, int interval)
203  {
204  	return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
205  }
206  
207  /*
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.
215   */
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)
220  {
221  	ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
222  	int err;
223  
224  	if ((timeout == 0) && (!asynch_allowed)) {
225  		/* request for a asynch control pipe is not allowed */
226  		return -EINVAL;
227  	}
228  
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 */
239  
240  	err = submit_control_msg(dev, pipe, data, size, setup_packet);
241  	if (err < 0)
242  		return err;
243  	if (timeout == 0)
244  		return (int)size;
245  
246  	/*
247  	 * Wait for status to update until timeout expires, USB driver
248  	 * interrupt handler may set the status when the USB operation has
249  	 * been completed.
250  	 */
251  	while (timeout--) {
252  		if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
253  			break;
254  		mdelay(1);
255  	}
256  	if (dev->status)
257  		return -1;
258  
259  	return dev->act_len;
260  
261  }
262  
263  /*-------------------------------------------------------------------
264   * submits bulk message, and waits for completion. returns 0 if Ok or
265   * negative if Error.
266   * synchronous behavior
267   */
268  int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
269  			void *data, int len, int *actual_length, int timeout)
270  {
271  	if (len < 0)
272  		return -EINVAL;
273  	dev->status = USB_ST_NOT_PROC; /*not yet processed */
274  	if (submit_bulk_msg(dev, pipe, data, len) < 0)
275  		return -EIO;
276  	while (timeout--) {
277  		if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
278  			break;
279  		mdelay(1);
280  	}
281  	*actual_length = dev->act_len;
282  	if (dev->status == 0)
283  		return 0;
284  	else
285  		return -EIO;
286  }
287  
288  
289  /*-------------------------------------------------------------------
290   * Max Packet stuff
291   */
292  
293  /*
294   * returns the max packet size, depending on the pipe direction and
295   * the configurations values
296   */
297  int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
298  {
299  	/* direction is out -> use emaxpacket out */
300  	if ((pipe & USB_DIR_IN) == 0)
301  		return dev->epmaxpacketout[((pipe>>15) & 0xf)];
302  	else
303  		return dev->epmaxpacketin[((pipe>>15) & 0xf)];
304  }
305  
306  /*
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)
314   *
315   * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
316   */
317  static void noinline
318  usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
319  {
320  	int b;
321  	struct usb_endpoint_descriptor *ep;
322  	u16 ep_wMaxPacketSize;
323  
324  	ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
325  
326  	b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
327  	ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
328  
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]);
336  	} else {
337  		if ((ep->bEndpointAddress & 0x80) == 0) {
338  			/* OUT Endpoint */
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]);
343  			}
344  		} else {
345  			/* IN Endpoint */
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]);
350  			}
351  		} /* if out */
352  	} /* if control */
353  }
354  
355  /*
356   * set the max packed value of all endpoints in the given configuration
357   */
358  static int usb_set_maxpacket(struct usb_device *dev)
359  {
360  	int i, ii;
361  
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);
365  
366  	return 0;
367  }
368  
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.)
373   */
374  static int usb_parse_config(struct usb_device *dev,
375  			unsigned char *buffer, int cfgno)
376  {
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;
381  
382  	ifno = -1;
383  	epno = -1;
384  	curr_if_num = -1;
385  
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);
391  		return -EINVAL;
392  	}
393  	if (head->bLength != USB_DT_CONFIG_SIZE) {
394  		printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
395  		return -EINVAL;
396  	}
397  	memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
398  	dev->config.no_of_if = 0;
399  
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",
409  					head->bLength);
410  				break;
411  			}
412  			if (index + USB_DT_INTERFACE_SIZE >
413  			    dev->config.desc.wTotalLength) {
414  				puts("USB IF descriptor overflowed buffer!\n");
415  				break;
416  			}
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 */
424  					return -EINVAL;
425  				}
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;
432  				curr_if_num =
433  				     if_desc->desc.bInterfaceNumber;
434  			} else {
435  				/* found alternate setting for the interface */
436  				if (ifno >= 0) {
437  					if_desc = &dev->config.if_desc[ifno];
438  					if_desc->num_altsetting++;
439  				}
440  			}
441  			break;
442  		case USB_DT_ENDPOINT:
443  			if (head->bLength != USB_DT_ENDPOINT_SIZE) {
444  				printf("ERROR: Invalid USB EP length (%d)\n",
445  					head->bLength);
446  				break;
447  			}
448  			if (index + USB_DT_ENDPOINT_SIZE >
449  			    dev->config.desc.wTotalLength) {
450  				puts("USB EP descriptor overflowed buffer!\n");
451  				break;
452  			}
453  			if (ifno < 0) {
454  				puts("Endpoint descriptor out of order!\n");
455  				break;
456  			}
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);
462  				return -EINVAL;
463  			}
464  			/* found an endpoint */
465  			if_desc->no_of_ep++;
466  			memcpy(&if_desc->ep_desc[epno], head,
467  				USB_DT_ENDPOINT_SIZE);
468  			ep_wMaxPacketSize = get_unaligned(&dev->config.\
469  							if_desc[ifno].\
470  							ep_desc[epno].\
471  							wMaxPacketSize);
472  			put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
473  					&dev->config.\
474  					if_desc[ifno].\
475  					ep_desc[epno].\
476  					wMaxPacketSize);
477  			debug("if %d, ep %d\n", ifno, epno);
478  			break;
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",
482  					head->bLength);
483  				break;
484  			}
485  			if (index + USB_DT_SS_EP_COMP_SIZE >
486  			    dev->config.desc.wTotalLength) {
487  				puts("USB EPC descriptor overflowed buffer!\n");
488  				break;
489  			}
490  			if (ifno < 0 || epno < 0) {
491  				puts("EPC descriptor out of order!\n");
492  				break;
493  			}
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);
497  			break;
498  		default:
499  			if (head->bLength == 0)
500  				return -EINVAL;
501  
502  			debug("unknown Description Type : %x\n",
503  			      head->bDescriptorType);
504  
505  #ifdef DEBUG
506  			{
507  				unsigned char *ch = (unsigned char *)head;
508  				int i;
509  
510  				for (i = 0; i < head->bLength; i++)
511  					debug("%02X ", *ch++);
512  				debug("\n\n\n");
513  			}
514  #endif
515  			break;
516  		}
517  		index += head->bLength;
518  		head = (struct usb_descriptor_header *)&buffer[index];
519  	}
520  	return 0;
521  }
522  
523  /***********************************************************************
524   * Clears an endpoint
525   * endp: endpoint number in bits 0-3;
526   * direction flag in bit 7 (1 = IN, 0 = OUT)
527   */
528  int usb_clear_halt(struct usb_device *dev, int pipe)
529  {
530  	int result;
531  	int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
532  
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);
536  
537  	/* don't clear if failed */
538  	if (result < 0)
539  		return result;
540  
541  	/*
542  	 * NOTE: we do not get status and verify reset was successful
543  	 * as some devices are reported to lock up upon this check..
544  	 */
545  
546  	usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
547  
548  	/* toggle is reset on clear */
549  	usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
550  	return 0;
551  }
552  
553  
554  /**********************************************************************
555   * get_descriptor type
556   */
557  static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
558  			unsigned char index, void *buf, int size)
559  {
560  	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
561  			       USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
562  			       (type << 8) + index, 0, buf, size,
563  			       USB_CNTL_TIMEOUT);
564  }
565  
566  /**********************************************************************
567   * gets len of configuration cfgno
568   */
569  int usb_get_configuration_len(struct usb_device *dev, int cfgno)
570  {
571  	int result;
572  	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, 9);
573  	struct usb_config_descriptor *config;
574  
575  	config = (struct usb_config_descriptor *)&buffer[0];
576  	result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
577  	if (result < 9) {
578  		if (result < 0)
579  			printf("unable to get descriptor, error %lX\n",
580  				dev->status);
581  		else
582  			printf("config descriptor too short " \
583  				"(expected %i, got %i)\n", 9, result);
584  		return -EIO;
585  	}
586  	return le16_to_cpu(config->wTotalLength);
587  }
588  
589  /**********************************************************************
590   * gets configuration cfgno and store it in the buffer
591   */
592  int usb_get_configuration_no(struct usb_device *dev, int cfgno,
593  			     unsigned char *buffer, int length)
594  {
595  	int result;
596  	struct usb_config_descriptor *config;
597  
598  	config = (struct usb_config_descriptor *)&buffer[0];
599  	result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
600  	debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result,
601  	      le16_to_cpu(config->wTotalLength));
602  	config->wTotalLength = result; /* validated, with CPU byte order */
603  
604  	return result;
605  }
606  
607  /********************************************************************
608   * set address of a device to the value in dev->devnum.
609   * This can only be done by addressing the device via the default address (0)
610   */
611  static int usb_set_address(struct usb_device *dev)
612  {
613  	debug("set address %d\n", dev->devnum);
614  
615  	return usb_control_msg(dev, usb_snddefctrl(dev), USB_REQ_SET_ADDRESS,
616  			       0, (dev->devnum), 0, NULL, 0, USB_CNTL_TIMEOUT);
617  }
618  
619  /********************************************************************
620   * set interface number to interface
621   */
622  int usb_set_interface(struct usb_device *dev, int interface, int alternate)
623  {
624  	struct usb_interface *if_face = NULL;
625  	int ret, i;
626  
627  	for (i = 0; i < dev->config.desc.bNumInterfaces; i++) {
628  		if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) {
629  			if_face = &dev->config.if_desc[i];
630  			break;
631  		}
632  	}
633  	if (!if_face) {
634  		printf("selecting invalid interface %d", interface);
635  		return -EINVAL;
636  	}
637  	/*
638  	 * We should return now for devices with only one alternate setting.
639  	 * According to 9.4.10 of the Universal Serial Bus Specification
640  	 * Revision 2.0 such devices can return with a STALL. This results in
641  	 * some USB sticks timeouting during initialization and then being
642  	 * unusable in U-Boot.
643  	 */
644  	if (if_face->num_altsetting == 1)
645  		return 0;
646  
647  	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
648  				USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
649  				alternate, interface, NULL, 0,
650  				USB_CNTL_TIMEOUT * 5);
651  	if (ret < 0)
652  		return ret;
653  
654  	return 0;
655  }
656  
657  /********************************************************************
658   * set configuration number to configuration
659   */
660  static int usb_set_configuration(struct usb_device *dev, int configuration)
661  {
662  	int res;
663  	debug("set configuration %d\n", configuration);
664  	/* set setup command */
665  	res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
666  				USB_REQ_SET_CONFIGURATION, 0,
667  				configuration, 0,
668  				NULL, 0, USB_CNTL_TIMEOUT);
669  	if (res == 0) {
670  		dev->toggle[0] = 0;
671  		dev->toggle[1] = 0;
672  		return 0;
673  	} else
674  		return -EIO;
675  }
676  
677  /********************************************************************
678   * set protocol to protocol
679   */
680  int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
681  {
682  	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
683  		USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
684  		protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
685  }
686  
687  /********************************************************************
688   * set idle
689   */
690  int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
691  {
692  	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
693  		USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
694  		(duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
695  }
696  
697  /********************************************************************
698   * get report
699   */
700  int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
701  		   unsigned char id, void *buf, int size)
702  {
703  	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
704  			USB_REQ_GET_REPORT,
705  			USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
706  			(type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
707  }
708  
709  /********************************************************************
710   * get class descriptor
711   */
712  int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
713  		unsigned char type, unsigned char id, void *buf, int size)
714  {
715  	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
716  		USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
717  		(type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
718  }
719  
720  /********************************************************************
721   * get string index in buffer
722   */
723  static int usb_get_string(struct usb_device *dev, unsigned short langid,
724  		   unsigned char index, void *buf, int size)
725  {
726  	int i;
727  	int result;
728  
729  	for (i = 0; i < 3; ++i) {
730  		/* some devices are flaky */
731  		result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
732  			USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
733  			(USB_DT_STRING << 8) + index, langid, buf, size,
734  			USB_CNTL_TIMEOUT);
735  
736  		if (result > 0)
737  			break;
738  	}
739  
740  	return result;
741  }
742  
743  
744  static void usb_try_string_workarounds(unsigned char *buf, int *length)
745  {
746  	int newlength, oldlength = *length;
747  
748  	for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
749  		if (!isprint(buf[newlength]) || buf[newlength + 1])
750  			break;
751  
752  	if (newlength > 2) {
753  		buf[0] = newlength;
754  		*length = newlength;
755  	}
756  }
757  
758  
759  static int usb_string_sub(struct usb_device *dev, unsigned int langid,
760  		unsigned int index, unsigned char *buf)
761  {
762  	int rc;
763  
764  	/* Try to read the string descriptor by asking for the maximum
765  	 * possible number of bytes */
766  	rc = usb_get_string(dev, langid, index, buf, 255);
767  
768  	/* If that failed try to read the descriptor length, then
769  	 * ask for just that many bytes */
770  	if (rc < 2) {
771  		rc = usb_get_string(dev, langid, index, buf, 2);
772  		if (rc == 2)
773  			rc = usb_get_string(dev, langid, index, buf, buf[0]);
774  	}
775  
776  	if (rc >= 2) {
777  		if (!buf[0] && !buf[1])
778  			usb_try_string_workarounds(buf, &rc);
779  
780  		/* There might be extra junk at the end of the descriptor */
781  		if (buf[0] < rc)
782  			rc = buf[0];
783  
784  		rc = rc - (rc & 1); /* force a multiple of two */
785  	}
786  
787  	if (rc < 2)
788  		rc = -EINVAL;
789  
790  	return rc;
791  }
792  
793  
794  /********************************************************************
795   * usb_string:
796   * Get string index and translate it to ascii.
797   * returns string length (> 0) or error (< 0)
798   */
799  int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
800  {
801  	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ);
802  	unsigned char *tbuf;
803  	int err;
804  	unsigned int u, idx;
805  
806  	if (size <= 0 || !buf || !index)
807  		return -EINVAL;
808  	buf[0] = 0;
809  	tbuf = &mybuf[0];
810  
811  	/* get langid for strings if it's not yet known */
812  	if (!dev->have_langid) {
813  		err = usb_string_sub(dev, 0, 0, tbuf);
814  		if (err < 0) {
815  			debug("error getting string descriptor 0 " \
816  			      "(error=%lx)\n", dev->status);
817  			return -EIO;
818  		} else if (tbuf[0] < 4) {
819  			debug("string descriptor 0 too short\n");
820  			return -EIO;
821  		} else {
822  			dev->have_langid = -1;
823  			dev->string_langid = tbuf[2] | (tbuf[3] << 8);
824  				/* always use the first langid listed */
825  			debug("USB device number %d default " \
826  			      "language ID 0x%x\n",
827  			      dev->devnum, dev->string_langid);
828  		}
829  	}
830  
831  	err = usb_string_sub(dev, dev->string_langid, index, tbuf);
832  	if (err < 0)
833  		return err;
834  
835  	size--;		/* leave room for trailing NULL char in output buffer */
836  	for (idx = 0, u = 2; u < err; u += 2) {
837  		if (idx >= size)
838  			break;
839  		if (tbuf[u+1])			/* high byte */
840  			buf[idx++] = '?';  /* non-ASCII character */
841  		else
842  			buf[idx++] = tbuf[u];
843  	}
844  	buf[idx] = 0;
845  	err = idx;
846  	return err;
847  }
848  
849  
850  /********************************************************************
851   * USB device handling:
852   * the USB device are static allocated [USB_MAX_DEVICE].
853   */
854  
855  #ifndef CONFIG_DM_USB
856  
857  /* returns a pointer to the device with the index [index].
858   * if the device is not assigned (dev->devnum==-1) returns NULL
859   */
860  struct usb_device *usb_get_dev_index(int index)
861  {
862  	if (usb_dev[index].devnum == -1)
863  		return NULL;
864  	else
865  		return &usb_dev[index];
866  }
867  
868  int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp)
869  {
870  	int i;
871  	debug("New Device %d\n", dev_index);
872  	if (dev_index == USB_MAX_DEVICE) {
873  		printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
874  		return -ENOSPC;
875  	}
876  	/* default Address is 0, real addresses start with 1 */
877  	usb_dev[dev_index].devnum = dev_index + 1;
878  	usb_dev[dev_index].maxchild = 0;
879  	for (i = 0; i < USB_MAXCHILDREN; i++)
880  		usb_dev[dev_index].children[i] = NULL;
881  	usb_dev[dev_index].parent = NULL;
882  	usb_dev[dev_index].controller = controller;
883  	dev_index++;
884  	*devp = &usb_dev[dev_index - 1];
885  
886  	return 0;
887  }
888  
889  /*
890   * Free the newly created device node.
891   * Called in error cases where configuring a newly attached
892   * device fails for some reason.
893   */
894  void usb_free_device(struct udevice *controller)
895  {
896  	dev_index--;
897  	debug("Freeing device node: %d\n", dev_index);
898  	memset(&usb_dev[dev_index], 0, sizeof(struct usb_device));
899  	usb_dev[dev_index].devnum = -1;
900  }
901  
902  /*
903   * XHCI issues Enable Slot command and thereafter
904   * allocates device contexts. Provide a weak alias
905   * function for the purpose, so that XHCI overrides it
906   * and EHCI/OHCI just work out of the box.
907   */
908  __weak int usb_alloc_device(struct usb_device *udev)
909  {
910  	return 0;
911  }
912  #endif /* !CONFIG_DM_USB */
913  
914  static int usb_hub_port_reset(struct usb_device *dev, struct usb_device *hub)
915  {
916  	if (!hub)
917  		usb_reset_root_port(dev);
918  
919  	return 0;
920  }
921  
922  static int get_descriptor_len(struct usb_device *dev, int len, int expect_len)
923  {
924  	__maybe_unused struct usb_device_descriptor *desc;
925  	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
926  	int err;
927  
928  	desc = (struct usb_device_descriptor *)tmpbuf;
929  
930  	err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, len);
931  	if (err < expect_len) {
932  		if (err < 0) {
933  			printf("unable to get device descriptor (error=%d)\n",
934  				err);
935  			return err;
936  		} else {
937  			printf("USB device descriptor short read (expected %i, got %i)\n",
938  				expect_len, err);
939  			return -EIO;
940  		}
941  	}
942  	memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
943  
944  	return 0;
945  }
946  
947  static int usb_setup_descriptor(struct usb_device *dev, bool do_read)
948  {
949  	/*
950  	 * This is a Windows scheme of initialization sequence, with double
951  	 * reset of the device (Linux uses the same sequence)
952  	 * Some equipment is said to work only with such init sequence; this
953  	 * patch is based on the work by Alan Stern:
954  	 * http://sourceforge.net/mailarchive/forum.php?
955  	 * thread_id=5729457&forum_id=5398
956  	 */
957  
958  	/*
959  	 * send 64-byte GET-DEVICE-DESCRIPTOR request.  Since the descriptor is
960  	 * only 18 bytes long, this will terminate with a short packet.  But if
961  	 * the maxpacket size is 8 or 16 the device may be waiting to transmit
962  	 * some more, or keeps on retransmitting the 8 byte header.
963  	 */
964  
965  	if (dev->speed == USB_SPEED_LOW) {
966  		dev->descriptor.bMaxPacketSize0 = 8;
967  		dev->maxpacketsize = PACKET_SIZE_8;
968  	} else {
969  		dev->descriptor.bMaxPacketSize0 = 64;
970  		dev->maxpacketsize = PACKET_SIZE_64;
971  	}
972  	dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
973  	dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
974  
975  	if (do_read) {
976  		int err;
977  
978  		/*
979  		 * Validate we've received only at least 8 bytes, not that we've
980  		 * received the entire descriptor. The reasoning is:
981  		 * - The code only uses fields in the first 8 bytes, so that's all we
982  		 *   need to have fetched at this stage.
983  		 * - The smallest maxpacket size is 8 bytes. Before we know the actual
984  		 *   maxpacket the device uses, the USB controller may only accept a
985  		 *   single packet. Consequently we are only guaranteed to receive 1
986  		 *   packet (at least 8 bytes) even in a non-error case.
987  		 *
988  		 * At least the DWC2 controller needs to be programmed with the number
989  		 * of packets in addition to the number of bytes. A request for 64
990  		 * bytes of data with the maxpacket guessed as 64 (above) yields a
991  		 * request for 1 packet.
992  		 */
993  		err = get_descriptor_len(dev, 64, 8);
994  		if (err)
995  			return err;
996  	}
997  
998  	dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
999  	dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
1000  	switch (dev->descriptor.bMaxPacketSize0) {
1001  	case 8:
1002  		dev->maxpacketsize  = PACKET_SIZE_8;
1003  		break;
1004  	case 16:
1005  		dev->maxpacketsize = PACKET_SIZE_16;
1006  		break;
1007  	case 32:
1008  		dev->maxpacketsize = PACKET_SIZE_32;
1009  		break;
1010  	case 64:
1011  		dev->maxpacketsize = PACKET_SIZE_64;
1012  		break;
1013  	default:
1014  		printf("usb_new_device: invalid max packet size\n");
1015  		return -EIO;
1016  	}
1017  
1018  	return 0;
1019  }
1020  
1021  static int usb_prepare_device(struct usb_device *dev, int addr, bool do_read,
1022  			      struct usb_device *parent)
1023  {
1024  	int err;
1025  
1026  	/*
1027  	 * Allocate usb 3.0 device context.
1028  	 * USB 3.0 (xHCI) protocol tries to allocate device slot
1029  	 * and related data structures first. This call does that.
1030  	 * Refer to sec 4.3.2 in xHCI spec rev1.0
1031  	 */
1032  	err = usb_alloc_device(dev);
1033  	if (err) {
1034  		printf("Cannot allocate device context to get SLOT_ID\n");
1035  		return err;
1036  	}
1037  	err = usb_setup_descriptor(dev, do_read);
1038  	if (err)
1039  		return err;
1040  	err = usb_hub_port_reset(dev, parent);
1041  	if (err)
1042  		return err;
1043  
1044  	dev->devnum = addr;
1045  
1046  	err = usb_set_address(dev); /* set address */
1047  
1048  	if (err < 0) {
1049  		printf("\n      USB device not accepting new address " \
1050  			"(error=%lX)\n", dev->status);
1051  		return err;
1052  	}
1053  
1054  	mdelay(10);	/* Let the SET_ADDRESS settle */
1055  
1056  	return 0;
1057  }
1058  
1059  int usb_select_config(struct usb_device *dev)
1060  {
1061  	unsigned char *tmpbuf = NULL;
1062  	int err;
1063  
1064  	err = get_descriptor_len(dev, USB_DT_DEVICE_SIZE, USB_DT_DEVICE_SIZE);
1065  	if (err)
1066  		return err;
1067  
1068  	/* correct le values */
1069  	le16_to_cpus(&dev->descriptor.bcdUSB);
1070  	le16_to_cpus(&dev->descriptor.idVendor);
1071  	le16_to_cpus(&dev->descriptor.idProduct);
1072  	le16_to_cpus(&dev->descriptor.bcdDevice);
1073  
1074  	/*
1075  	 * Kingston DT Ultimate 32GB USB 3.0 seems to be extremely sensitive
1076  	 * about this first Get Descriptor request. If there are any other
1077  	 * requests in the first microframe, the stick crashes. Wait about
1078  	 * one microframe duration here (1mS for USB 1.x , 125uS for USB 2.0).
1079  	 */
1080  	mdelay(1);
1081  
1082  	/* only support for one config for now */
1083  	err = usb_get_configuration_len(dev, 0);
1084  	if (err >= 0) {
1085  		tmpbuf = (unsigned char *)malloc_cache_aligned(err);
1086  		if (!tmpbuf)
1087  			err = -ENOMEM;
1088  		else
1089  			err = usb_get_configuration_no(dev, 0, tmpbuf, err);
1090  	}
1091  	if (err < 0) {
1092  		printf("usb_new_device: Cannot read configuration, " \
1093  		       "skipping device %04x:%04x\n",
1094  		       dev->descriptor.idVendor, dev->descriptor.idProduct);
1095  		free(tmpbuf);
1096  		return err;
1097  	}
1098  	usb_parse_config(dev, tmpbuf, 0);
1099  	free(tmpbuf);
1100  	usb_set_maxpacket(dev);
1101  	/*
1102  	 * we set the default configuration here
1103  	 * This seems premature. If the driver wants a different configuration
1104  	 * it will need to select itself.
1105  	 */
1106  	err = usb_set_configuration(dev, dev->config.desc.bConfigurationValue);
1107  	if (err < 0) {
1108  		printf("failed to set default configuration " \
1109  			"len %d, status %lX\n", dev->act_len, dev->status);
1110  		return err;
1111  	}
1112  
1113  	/*
1114  	 * Wait until the Set Configuration request gets processed by the
1115  	 * device. This is required by at least SanDisk Cruzer Pop USB 2.0
1116  	 * and Kingston DT Ultimate 32GB USB 3.0 on DWC2 OTG controller.
1117  	 */
1118  	mdelay(10);
1119  
1120  	debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1121  	      dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1122  	      dev->descriptor.iSerialNumber);
1123  	memset(dev->mf, 0, sizeof(dev->mf));
1124  	memset(dev->prod, 0, sizeof(dev->prod));
1125  	memset(dev->serial, 0, sizeof(dev->serial));
1126  	if (dev->descriptor.iManufacturer)
1127  		usb_string(dev, dev->descriptor.iManufacturer,
1128  			   dev->mf, sizeof(dev->mf));
1129  	if (dev->descriptor.iProduct)
1130  		usb_string(dev, dev->descriptor.iProduct,
1131  			   dev->prod, sizeof(dev->prod));
1132  	if (dev->descriptor.iSerialNumber)
1133  		usb_string(dev, dev->descriptor.iSerialNumber,
1134  			   dev->serial, sizeof(dev->serial));
1135  	debug("Manufacturer %s\n", dev->mf);
1136  	debug("Product      %s\n", dev->prod);
1137  	debug("SerialNumber %s\n", dev->serial);
1138  
1139  	return 0;
1140  }
1141  
1142  int usb_setup_device(struct usb_device *dev, bool do_read,
1143  		     struct usb_device *parent)
1144  {
1145  	int addr;
1146  	int ret;
1147  
1148  	/* We still haven't set the Address yet */
1149  	addr = dev->devnum;
1150  	dev->devnum = 0;
1151  
1152  	ret = usb_prepare_device(dev, addr, do_read, parent);
1153  	if (ret)
1154  		return ret;
1155  	ret = usb_select_config(dev);
1156  
1157  	return ret;
1158  }
1159  
1160  #ifndef CONFIG_DM_USB
1161  /*
1162   * By the time we get here, the device has gotten a new device ID
1163   * and is in the default state. We need to identify the thing and
1164   * get the ball rolling..
1165   *
1166   * Returns 0 for success, != 0 for error.
1167   */
1168  int usb_new_device(struct usb_device *dev)
1169  {
1170  	bool do_read = true;
1171  	int err;
1172  
1173  	/*
1174  	 * XHCI needs to issue a Address device command to setup
1175  	 * proper device context structures, before it can interact
1176  	 * with the device. So a get_descriptor will fail before any
1177  	 * of that is done for XHCI unlike EHCI.
1178  	 */
1179  #ifdef CONFIG_USB_XHCI_HCD
1180  	do_read = false;
1181  #endif
1182  	err = usb_setup_device(dev, do_read, dev->parent);
1183  	if (err)
1184  		return err;
1185  
1186  	/* Now probe if the device is a hub */
1187  	err = usb_hub_probe(dev, 0);
1188  	if (err < 0)
1189  		return err;
1190  
1191  	return 0;
1192  }
1193  #endif
1194  
1195  __weak
1196  int board_usb_init(int index, enum usb_init_type init)
1197  {
1198  	return 0;
1199  }
1200  
1201  __weak
1202  int board_usb_cleanup(int index, enum usb_init_type init)
1203  {
1204  	return 0;
1205  }
1206  
1207  bool usb_device_has_child_on_port(struct usb_device *parent, int port)
1208  {
1209  #ifdef CONFIG_DM_USB
1210  	return false;
1211  #else
1212  	return parent->children[port] != NULL;
1213  #endif
1214  }
1215  
1216  #ifdef CONFIG_DM_USB
1217  void usb_find_usb2_hub_address_port(struct usb_device *udev,
1218  			       uint8_t *hub_address, uint8_t *hub_port)
1219  {
1220  	struct udevice *parent;
1221  	struct usb_device *uparent, *ttdev;
1222  
1223  	/*
1224  	 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1225  	 * to the parent udevice, not the actual udevice belonging to the
1226  	 * udev as the device is not instantiated yet. So when searching
1227  	 * for the first usb-2 parent start with udev->dev not
1228  	 * udev->dev->parent .
1229  	 */
1230  	ttdev = udev;
1231  	parent = udev->dev;
1232  	uparent = dev_get_parent_priv(parent);
1233  
1234  	while (uparent->speed != USB_SPEED_HIGH) {
1235  		struct udevice *dev = parent;
1236  
1237  		if (device_get_uclass_id(dev->parent) != UCLASS_USB_HUB) {
1238  			printf("Error: Cannot find high speed parent of usb-1 device\n");
1239  			*hub_address = 0;
1240  			*hub_port = 0;
1241  			return;
1242  		}
1243  
1244  		ttdev = dev_get_parent_priv(dev);
1245  		parent = dev->parent;
1246  		uparent = dev_get_parent_priv(parent);
1247  	}
1248  	*hub_address = uparent->devnum;
1249  	*hub_port = ttdev->portnr;
1250  }
1251  #else
1252  void usb_find_usb2_hub_address_port(struct usb_device *udev,
1253  			       uint8_t *hub_address, uint8_t *hub_port)
1254  {
1255  	/* Find out the nearest parent which is high speed */
1256  	while (udev->parent->parent != NULL)
1257  		if (udev->parent->speed != USB_SPEED_HIGH) {
1258  			udev = udev->parent;
1259  		} else {
1260  			*hub_address = udev->parent->devnum;
1261  			*hub_port = udev->portnr;
1262  			return;
1263  		}
1264  
1265  	printf("Error: Cannot find high speed parent of usb-1 device\n");
1266  	*hub_address = 0;
1267  	*hub_port = 0;
1268  }
1269  #endif
1270  
1271  
1272  /* EOF */
1273