blob: 4f3713d92f3532adda085edebcfb016fa7ebe8e8 [file] [log] [blame]
wdenkaffae2b2002-08-17 09:36:01 +00001/*
wdenkaffae2b2002-08-17 09:36:01 +00002 * Most of this source has been derived from the Linux USB
Wolfgang Denk460c3222005-08-04 01:14:12 +02003 * 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
wdenkaffae2b2002-08-17 09:36:01 +000016 *
Wolfgang Denk1a459662013-07-08 09:37:19 +020017 * SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +000018 */
19
wdenkaffae2b2002-08-17 09:36:01 +000020/*
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>
Mike Frysinger66cf6412012-04-04 18:44:53 +000032#include <linux/compiler.h>
Wolfgang Denk9c998aa2005-07-21 11:57:57 +020033#include <linux/ctype.h>
Christian Eggersc9182612008-05-21 22:12:00 +020034#include <asm/byteorder.h>
Tom Rinib2fb47f2011-12-15 08:40:51 -070035#include <asm/unaligned.h>
Marek Vasut97b9eb92014-08-01 03:09:53 +020036#include <errno.h>
wdenkaffae2b2002-08-17 09:36:01 +000037#include <usb.h>
38#ifdef CONFIG_4xx
Stefan Roese3048bcb2007-10-03 15:01:02 +020039#include <asm/4xx_pci.h>
wdenkaffae2b2002-08-17 09:36:01 +000040#endif
41
wdenkcd0a9de2004-02-23 20:48:38 +000042#define USB_BUFSIZ 512
43
wdenkaffae2b2002-08-17 09:36:01 +000044static struct usb_device usb_dev[USB_MAX_DEVICE];
45static int dev_index;
wdenkaffae2b2002-08-17 09:36:01 +000046static int asynch_allowed;
wdenkaffae2b2002-08-17 09:36:01 +000047
Bartlomiej Siekae51aae32006-08-03 23:20:13 +020048char usb_started; /* flag for the started/stopped USB status */
49
Lucas Stach93c25822012-09-26 00:14:36 +020050#ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
51#define CONFIG_USB_MAX_CONTROLLER_COUNT 1
52#endif
wdenkaffae2b2002-08-17 09:36:01 +000053
wdenkaffae2b2002-08-17 09:36:01 +000054/***************************************************************************
55 * Init USB Device
56 */
wdenkaffae2b2002-08-17 09:36:01 +000057int usb_init(void)
58{
Lucas Stach93c25822012-09-26 00:14:36 +020059 void *ctrl;
60 struct usb_device *dev;
61 int i, start_index = 0;
Hans de Goeded906bbc2015-01-11 20:34:46 +010062 int controllers_initialized = 0;
Marek Vasut97b9eb92014-08-01 03:09:53 +020063 int ret;
wdenkaffae2b2002-08-17 09:36:01 +000064
Remy Bohmer6f5794a2008-09-16 14:55:43 +020065 dev_index = 0;
66 asynch_allowed = 1;
wdenkaffae2b2002-08-17 09:36:01 +000067 usb_hub_reset();
Lucas Stach93c25822012-09-26 00:14:36 +020068
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
wdenkaffae2b2002-08-17 09:36:01 +000075 /* init low_level USB */
Lucas Stach93c25822012-09-26 00:14:36 +020076 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
77 /* init low_level USB */
78 printf("USB%d: ", i);
Marek Vasut97b9eb92014-08-01 03:09:53 +020079 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
80 if (ret == -ENODEV) { /* No such device. */
81 puts("Port not available.\n");
Hans de Goeded906bbc2015-01-11 20:34:46 +010082 controllers_initialized++;
Marek Vasut97b9eb92014-08-01 03:09:53 +020083 continue;
84 }
85
86 if (ret) { /* Other error. */
Lucas Stach93c25822012-09-26 00:14:36 +020087 puts("lowlevel init failed\n");
88 continue;
89 }
90 /*
91 * lowlevel init is OK, now scan the bus for devices
92 * i.e. search HUBs and configure them
93 */
Hans de Goeded906bbc2015-01-11 20:34:46 +010094 controllers_initialized++;
Lucas Stach93c25822012-09-26 00:14:36 +020095 start_index = dev_index;
96 printf("scanning bus %d for devices... ", i);
Simon Glass79b58882015-03-25 12:22:01 -060097 ret = usb_alloc_new_device(ctrl, &dev);
98 if (ret)
Paul Kocialkowski8879be82015-04-04 15:12:28 +020099 break;
100
Lucas Stach93c25822012-09-26 00:14:36 +0200101 /*
102 * device 0 is always present
103 * (root hub, so let it analyze)
104 */
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200105 ret = usb_new_device(dev);
106 if (ret)
Simon Glass79b58882015-03-25 12:22:01 -0600107 usb_free_device(dev->controller);
Lucas Stach93c25822012-09-26 00:14:36 +0200108
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200109 if (start_index == dev_index) {
Lucas Stach93c25822012-09-26 00:14:36 +0200110 puts("No USB Device found\n");
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200111 continue;
112 } else {
Lucas Stach93c25822012-09-26 00:14:36 +0200113 printf("%d USB Device(s) found\n",
114 dev_index - start_index);
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200115 }
Lucas Stach93c25822012-09-26 00:14:36 +0200116
Bartlomiej Siekae51aae32006-08-03 23:20:13 +0200117 usb_started = 1;
Lucas Stach93c25822012-09-26 00:14:36 +0200118 }
119
Vivek Gautamceb49722013-04-12 16:34:33 +0530120 debug("scan end\n");
Lucas Stach93c25822012-09-26 00:14:36 +0200121 /* if we were not able to find at least one working bus, bail out */
Hans de Goeded906bbc2015-01-11 20:34:46 +0100122 if (controllers_initialized == 0)
Lucas Stach93c25822012-09-26 00:14:36 +0200123 puts("USB error: all controllers failed lowlevel init\n");
Lucas Stach93c25822012-09-26 00:14:36 +0200124
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200125 return usb_started ? 0 : -ENODEV;
wdenkaffae2b2002-08-17 09:36:01 +0000126}
127
128/******************************************************************************
129 * Stop USB this stops the LowLevel Part and deregisters USB devices.
130 */
131int usb_stop(void)
132{
Lucas Stach93c25822012-09-26 00:14:36 +0200133 int i;
Remy Bohmereba1f2f2008-08-20 11:22:02 +0200134
135 if (usb_started) {
136 asynch_allowed = 1;
137 usb_started = 0;
138 usb_hub_reset();
Lucas Stach93c25822012-09-26 00:14:36 +0200139
140 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
141 if (usb_lowlevel_stop(i))
142 printf("failed to stop USB controller %d\n", i);
143 }
Remy Bohmereba1f2f2008-08-20 11:22:02 +0200144 }
Lucas Stach93c25822012-09-26 00:14:36 +0200145
146 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000147}
148
149/*
150 * disables the asynch behaviour of the control message. This is used for data
151 * transfers that uses the exclusiv access to the control and bulk messages.
Simon Glass89d48362011-02-16 11:14:33 -0800152 * Returns the old value so it can be restored later.
wdenkaffae2b2002-08-17 09:36:01 +0000153 */
Simon Glass89d48362011-02-16 11:14:33 -0800154int usb_disable_asynch(int disable)
wdenkaffae2b2002-08-17 09:36:01 +0000155{
Simon Glass89d48362011-02-16 11:14:33 -0800156 int old_value = asynch_allowed;
157
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200158 asynch_allowed = !disable;
Simon Glass89d48362011-02-16 11:14:33 -0800159 return old_value;
wdenkaffae2b2002-08-17 09:36:01 +0000160}
161
162
163/*-------------------------------------------------------------------
164 * Message wrappers.
165 *
166 */
167
168/*
169 * submits an Interrupt Message
170 */
171int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200172 void *buffer, int transfer_len, int interval)
wdenkaffae2b2002-08-17 09:36:01 +0000173{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200174 return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
wdenkaffae2b2002-08-17 09:36:01 +0000175}
176
177/*
178 * submits a control message and waits for comletion (at least timeout * 1ms)
179 * If timeout is 0, we don't wait for completion (used as example to set and
180 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
181 * allow control messages with 0 timeout, by previousely resetting the flag
182 * asynch_allowed (usb_disable_asynch(1)).
183 * returns the transfered length if OK or -1 if error. The transfered length
184 * and the current status are stored in the dev->act_len and dev->status.
185 */
186int usb_control_msg(struct usb_device *dev, unsigned int pipe,
187 unsigned char request, unsigned char requesttype,
188 unsigned short value, unsigned short index,
189 void *data, unsigned short size, int timeout)
190{
Puneet Saxenaf5766132012-04-03 14:56:06 +0530191 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
Marek Vasute159e482012-02-13 18:58:18 +0000192
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200193 if ((timeout == 0) && (!asynch_allowed)) {
194 /* request for a asynch control pipe is not allowed */
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200195 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200196 }
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200197
wdenkaffae2b2002-08-17 09:36:01 +0000198 /* set setup command */
Puneet Saxenaf5766132012-04-03 14:56:06 +0530199 setup_packet->requesttype = requesttype;
200 setup_packet->request = request;
201 setup_packet->value = cpu_to_le16(value);
202 setup_packet->index = cpu_to_le16(index);
203 setup_packet->length = cpu_to_le16(size);
Vivek Gautamceb49722013-04-12 16:34:33 +0530204 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
205 "value 0x%X index 0x%X length 0x%X\n",
206 request, requesttype, value, index, size);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200207 dev->status = USB_ST_NOT_PROC; /*not yet processed */
wdenkaffae2b2002-08-17 09:36:01 +0000208
Ilya Yanokfd060282012-07-15 04:43:51 +0000209 if (submit_control_msg(dev, pipe, data, size, setup_packet) < 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200210 return -EIO;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200211 if (timeout == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000212 return (int)size;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200213
Remy Bohmer84d36b32010-02-01 19:40:47 +0100214 /*
215 * Wait for status to update until timeout expires, USB driver
216 * interrupt handler may set the status when the USB operation has
217 * been completed.
218 */
219 while (timeout--) {
220 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
221 break;
Mike Frysinger5b84dd62012-03-05 13:47:00 +0000222 mdelay(1);
Remy Bohmer48867202008-10-10 10:23:21 +0200223 }
Remy Bohmer84d36b32010-02-01 19:40:47 +0100224 if (dev->status)
225 return -1;
Remy Bohmer48867202008-10-10 10:23:21 +0200226
227 return dev->act_len;
Remy Bohmer84d36b32010-02-01 19:40:47 +0100228
wdenkaffae2b2002-08-17 09:36:01 +0000229}
230
231/*-------------------------------------------------------------------
232 * submits bulk message, and waits for completion. returns 0 if Ok or
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200233 * negative if Error.
wdenkaffae2b2002-08-17 09:36:01 +0000234 * synchronous behavior
235 */
236int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
237 void *data, int len, int *actual_length, int timeout)
238{
239 if (len < 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200240 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200241 dev->status = USB_ST_NOT_PROC; /*not yet processed */
Ilya Yanokfd060282012-07-15 04:43:51 +0000242 if (submit_bulk_msg(dev, pipe, data, len) < 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200243 return -EIO;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200244 while (timeout--) {
245 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
wdenkaffae2b2002-08-17 09:36:01 +0000246 break;
Mike Frysinger5b84dd62012-03-05 13:47:00 +0000247 mdelay(1);
wdenkaffae2b2002-08-17 09:36:01 +0000248 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200249 *actual_length = dev->act_len;
250 if (dev->status == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000251 return 0;
252 else
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200253 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000254}
255
256
257/*-------------------------------------------------------------------
258 * Max Packet stuff
259 */
260
261/*
262 * returns the max packet size, depending on the pipe direction and
263 * the configurations values
264 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200265int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
wdenkaffae2b2002-08-17 09:36:01 +0000266{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200267 /* direction is out -> use emaxpacket out */
268 if ((pipe & USB_DIR_IN) == 0)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100269 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000270 else
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100271 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000272}
273
Marek Vasut5e8baf82011-11-05 23:35:12 +0100274/*
275 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
Remy Bohmerbe19d322008-09-16 14:55:42 +0200276 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
277 * when it is inlined in 1 single routine. What happens is that the register r3
278 * is used as loop-count 'i', but gets overwritten later on.
279 * This is clearly a compiler bug, but it is easier to workaround it here than
280 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
281 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
Marek Vasut5e8baf82011-11-05 23:35:12 +0100282 *
283 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
Remy Bohmerbe19d322008-09-16 14:55:42 +0200284 */
Mike Frysinger66cf6412012-04-04 18:44:53 +0000285static void noinline
Marek Vasut5e8baf82011-11-05 23:35:12 +0100286usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
Remy Bohmerbe19d322008-09-16 14:55:42 +0200287{
288 int b;
Marek Vasut5e8baf82011-11-05 23:35:12 +0100289 struct usb_endpoint_descriptor *ep;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700290 u16 ep_wMaxPacketSize;
Marek Vasut5e8baf82011-11-05 23:35:12 +0100291
292 ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
Remy Bohmerbe19d322008-09-16 14:55:42 +0200293
294 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700295 ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200296
297 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
298 USB_ENDPOINT_XFER_CONTROL) {
299 /* Control => bidirectional */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700300 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
301 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530302 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
303 b, dev->epmaxpacketin[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200304 } else {
305 if ((ep->bEndpointAddress & 0x80) == 0) {
306 /* OUT Endpoint */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700307 if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) {
308 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530309 debug("##EP epmaxpacketout[%d] = %d\n",
310 b, dev->epmaxpacketout[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200311 }
312 } else {
313 /* IN Endpoint */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700314 if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) {
315 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530316 debug("##EP epmaxpacketin[%d] = %d\n",
317 b, dev->epmaxpacketin[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200318 }
319 } /* if out */
320 } /* if control */
321}
322
wdenkaffae2b2002-08-17 09:36:01 +0000323/*
324 * set the max packed value of all endpoints in the given configuration
325 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000326static int usb_set_maxpacket(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000327{
Remy Bohmerbe19d322008-09-16 14:55:42 +0200328 int i, ii;
wdenkaffae2b2002-08-17 09:36:01 +0000329
Tom Rix8f8bd562009-10-31 12:37:38 -0500330 for (i = 0; i < dev->config.desc.bNumInterfaces; i++)
331 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++)
Marek Vasut5e8baf82011-11-05 23:35:12 +0100332 usb_set_maxpacket_ep(dev, i, ii);
wdenkaffae2b2002-08-17 09:36:01 +0000333
wdenkaffae2b2002-08-17 09:36:01 +0000334 return 0;
335}
336
337/*******************************************************************************
338 * Parse the config, located in buffer, and fills the dev->config structure.
339 * Note that all little/big endian swapping are done automatically.
Julius Wernereaf3e612013-07-19 13:12:08 -0700340 * (wTotalLength has already been swapped and sanitized when it was read.)
wdenkaffae2b2002-08-17 09:36:01 +0000341 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000342static int usb_parse_config(struct usb_device *dev,
343 unsigned char *buffer, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000344{
345 struct usb_descriptor_header *head;
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200346 int index, ifno, epno, curr_if_num;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700347 u16 ep_wMaxPacketSize;
Vivek Gautam605bd752013-04-12 16:34:34 +0530348 struct usb_interface *if_desc = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000349
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200350 ifno = -1;
351 epno = -1;
352 curr_if_num = -1;
353
354 dev->configno = cfgno;
355 head = (struct usb_descriptor_header *) &buffer[0];
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200356 if (head->bDescriptorType != USB_DT_CONFIG) {
357 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
358 head->bDescriptorType);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200359 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000360 }
Julius Wernereaf3e612013-07-19 13:12:08 -0700361 if (head->bLength != USB_DT_CONFIG_SIZE) {
362 printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200363 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700364 }
365 memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200366 dev->config.no_of_if = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000367
Tom Rix8f8bd562009-10-31 12:37:38 -0500368 index = dev->config.desc.bLength;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200369 /* Ok the first entry must be a configuration entry,
370 * now process the others */
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200371 head = (struct usb_descriptor_header *) &buffer[index];
Julius Wernereaf3e612013-07-19 13:12:08 -0700372 while (index + 1 < dev->config.desc.wTotalLength && head->bLength) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200373 switch (head->bDescriptorType) {
374 case USB_DT_INTERFACE:
Julius Wernereaf3e612013-07-19 13:12:08 -0700375 if (head->bLength != USB_DT_INTERFACE_SIZE) {
376 printf("ERROR: Invalid USB IF length (%d)\n",
377 head->bLength);
378 break;
379 }
380 if (index + USB_DT_INTERFACE_SIZE >
381 dev->config.desc.wTotalLength) {
382 puts("USB IF descriptor overflowed buffer!\n");
383 break;
384 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200385 if (((struct usb_interface_descriptor *) \
Julius Wernereaf3e612013-07-19 13:12:08 -0700386 head)->bInterfaceNumber != curr_if_num) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200387 /* this is a new interface, copy new desc */
388 ifno = dev->config.no_of_if;
Julius Wernereaf3e612013-07-19 13:12:08 -0700389 if (ifno >= USB_MAXINTERFACES) {
390 puts("Too many USB interfaces!\n");
391 /* try to go on with what we have */
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200392 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700393 }
Vivek Gautam605bd752013-04-12 16:34:34 +0530394 if_desc = &dev->config.if_desc[ifno];
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200395 dev->config.no_of_if++;
Julius Wernereaf3e612013-07-19 13:12:08 -0700396 memcpy(if_desc, head,
397 USB_DT_INTERFACE_SIZE);
Vivek Gautam605bd752013-04-12 16:34:34 +0530398 if_desc->no_of_ep = 0;
399 if_desc->num_altsetting = 1;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200400 curr_if_num =
Vivek Gautam605bd752013-04-12 16:34:34 +0530401 if_desc->desc.bInterfaceNumber;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200402 } else {
403 /* found alternate setting for the interface */
Vivek Gautam605bd752013-04-12 16:34:34 +0530404 if (ifno >= 0) {
405 if_desc = &dev->config.if_desc[ifno];
406 if_desc->num_altsetting++;
407 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200408 }
409 break;
410 case USB_DT_ENDPOINT:
Julius Wernereaf3e612013-07-19 13:12:08 -0700411 if (head->bLength != USB_DT_ENDPOINT_SIZE) {
412 printf("ERROR: Invalid USB EP length (%d)\n",
413 head->bLength);
414 break;
415 }
416 if (index + USB_DT_ENDPOINT_SIZE >
417 dev->config.desc.wTotalLength) {
418 puts("USB EP descriptor overflowed buffer!\n");
419 break;
420 }
421 if (ifno < 0) {
422 puts("Endpoint descriptor out of order!\n");
423 break;
424 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200425 epno = dev->config.if_desc[ifno].no_of_ep;
Vivek Gautam605bd752013-04-12 16:34:34 +0530426 if_desc = &dev->config.if_desc[ifno];
Julius Wernereaf3e612013-07-19 13:12:08 -0700427 if (epno > USB_MAXENDPOINTS) {
428 printf("Interface %d has too many endpoints!\n",
429 if_desc->desc.bInterfaceNumber);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200430 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700431 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200432 /* found an endpoint */
Vivek Gautam605bd752013-04-12 16:34:34 +0530433 if_desc->no_of_ep++;
Julius Wernereaf3e612013-07-19 13:12:08 -0700434 memcpy(&if_desc->ep_desc[epno], head,
435 USB_DT_ENDPOINT_SIZE);
Tom Rinib2fb47f2011-12-15 08:40:51 -0700436 ep_wMaxPacketSize = get_unaligned(&dev->config.\
437 if_desc[ifno].\
438 ep_desc[epno].\
439 wMaxPacketSize);
440 put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
441 &dev->config.\
442 if_desc[ifno].\
443 ep_desc[epno].\
444 wMaxPacketSize);
Vivek Gautamceb49722013-04-12 16:34:33 +0530445 debug("if %d, ep %d\n", ifno, epno);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200446 break;
Vivek Gautam6497c662013-04-12 16:34:38 +0530447 case USB_DT_SS_ENDPOINT_COMP:
Julius Wernereaf3e612013-07-19 13:12:08 -0700448 if (head->bLength != USB_DT_SS_EP_COMP_SIZE) {
449 printf("ERROR: Invalid USB EPC length (%d)\n",
450 head->bLength);
451 break;
452 }
453 if (index + USB_DT_SS_EP_COMP_SIZE >
454 dev->config.desc.wTotalLength) {
455 puts("USB EPC descriptor overflowed buffer!\n");
456 break;
457 }
458 if (ifno < 0 || epno < 0) {
459 puts("EPC descriptor out of order!\n");
460 break;
461 }
Vivek Gautam6497c662013-04-12 16:34:38 +0530462 if_desc = &dev->config.if_desc[ifno];
Julius Wernereaf3e612013-07-19 13:12:08 -0700463 memcpy(&if_desc->ss_ep_comp_desc[epno], head,
464 USB_DT_SS_EP_COMP_SIZE);
Vivek Gautam6497c662013-04-12 16:34:38 +0530465 break;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200466 default:
467 if (head->bLength == 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200468 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200469
Vivek Gautamceb49722013-04-12 16:34:33 +0530470 debug("unknown Description Type : %x\n",
471 head->bDescriptorType);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200472
Vivek Gautamceb49722013-04-12 16:34:33 +0530473#ifdef DEBUG
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200474 {
Wolfgang Denkfad2e1b2011-10-05 23:11:19 +0200475 unsigned char *ch = (unsigned char *)head;
Vivek Gautamceb49722013-04-12 16:34:33 +0530476 int i;
477
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200478 for (i = 0; i < head->bLength; i++)
Vivek Gautamceb49722013-04-12 16:34:33 +0530479 debug("%02X ", *ch++);
480 debug("\n\n\n");
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200481 }
Vivek Gautamceb49722013-04-12 16:34:33 +0530482#endif
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200483 break;
wdenkaffae2b2002-08-17 09:36:01 +0000484 }
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200485 index += head->bLength;
486 head = (struct usb_descriptor_header *)&buffer[index];
wdenkaffae2b2002-08-17 09:36:01 +0000487 }
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200488 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000489}
490
491/***********************************************************************
492 * Clears an endpoint
493 * endp: endpoint number in bits 0-3;
494 * direction flag in bit 7 (1 = IN, 0 = OUT)
495 */
496int usb_clear_halt(struct usb_device *dev, int pipe)
497{
498 int result;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200499 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
wdenkaffae2b2002-08-17 09:36:01 +0000500
501 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200502 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
503 endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
wdenkaffae2b2002-08-17 09:36:01 +0000504
505 /* don't clear if failed */
506 if (result < 0)
507 return result;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200508
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200509 /*
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200510 * NOTE: we do not get status and verify reset was successful
511 * as some devices are reported to lock up upon this check..
512 */
513
wdenkaffae2b2002-08-17 09:36:01 +0000514 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200515
wdenkaffae2b2002-08-17 09:36:01 +0000516 /* toggle is reset on clear */
517 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
518 return 0;
519}
520
521
522/**********************************************************************
523 * get_descriptor type
524 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000525static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200526 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000527{
528 int res;
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200529 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
wdenkaffae2b2002-08-17 09:36:01 +0000530 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
531 (type << 8) + index, 0,
532 buf, size, USB_CNTL_TIMEOUT);
533 return res;
534}
535
536/**********************************************************************
537 * gets configuration cfgno and store it in the buffer
538 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200539int usb_get_configuration_no(struct usb_device *dev,
540 unsigned char *buffer, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000541{
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200542 int result;
Julius Wernereaf3e612013-07-19 13:12:08 -0700543 unsigned int length;
Ilya Yanokc60795f2012-11-06 13:48:20 +0000544 struct usb_config_descriptor *config;
wdenkaffae2b2002-08-17 09:36:01 +0000545
Ilya Yanokc60795f2012-11-06 13:48:20 +0000546 config = (struct usb_config_descriptor *)&buffer[0];
Remy Bohmer48867202008-10-10 10:23:21 +0200547 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
548 if (result < 9) {
wdenkaffae2b2002-08-17 09:36:01 +0000549 if (result < 0)
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200550 printf("unable to get descriptor, error %lX\n",
551 dev->status);
wdenkaffae2b2002-08-17 09:36:01 +0000552 else
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200553 printf("config descriptor too short " \
Remy Bohmer48867202008-10-10 10:23:21 +0200554 "(expected %i, got %i)\n", 9, result);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200555 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000556 }
Julius Wernereaf3e612013-07-19 13:12:08 -0700557 length = le16_to_cpu(config->wTotalLength);
wdenkaffae2b2002-08-17 09:36:01 +0000558
Julius Wernereaf3e612013-07-19 13:12:08 -0700559 if (length > USB_BUFSIZ) {
560 printf("%s: failed to get descriptor - too long: %d\n",
561 __func__, length);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200562 return -EIO;
wdenkcd0a9de2004-02-23 20:48:38 +0000563 }
564
Julius Wernereaf3e612013-07-19 13:12:08 -0700565 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
566 debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result, length);
567 config->wTotalLength = length; /* validated, with CPU byte order */
568
wdenkaffae2b2002-08-17 09:36:01 +0000569 return result;
570}
571
572/********************************************************************
573 * set address of a device to the value in dev->devnum.
574 * This can only be done by addressing the device via the default address (0)
575 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000576static int usb_set_address(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000577{
578 int res;
579
Vivek Gautamceb49722013-04-12 16:34:33 +0530580 debug("set address %d\n", dev->devnum);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200581 res = usb_control_msg(dev, usb_snddefctrl(dev),
582 USB_REQ_SET_ADDRESS, 0,
583 (dev->devnum), 0,
584 NULL, 0, USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000585 return res;
586}
587
588/********************************************************************
589 * set interface number to interface
590 */
591int usb_set_interface(struct usb_device *dev, int interface, int alternate)
592{
Tom Rix8f8bd562009-10-31 12:37:38 -0500593 struct usb_interface *if_face = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000594 int ret, i;
595
Tom Rix8f8bd562009-10-31 12:37:38 -0500596 for (i = 0; i < dev->config.desc.bNumInterfaces; i++) {
597 if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) {
wdenkaffae2b2002-08-17 09:36:01 +0000598 if_face = &dev->config.if_desc[i];
599 break;
600 }
601 }
602 if (!if_face) {
603 printf("selecting invalid interface %d", interface);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200604 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000605 }
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200606 /*
607 * We should return now for devices with only one alternate setting.
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200608 * According to 9.4.10 of the Universal Serial Bus Specification
609 * Revision 2.0 such devices can return with a STALL. This results in
610 * some USB sticks timeouting during initialization and then being
611 * unusable in U-Boot.
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200612 */
613 if (if_face->num_altsetting == 1)
614 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000615
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200616 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
617 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
618 alternate, interface, NULL, 0,
619 USB_CNTL_TIMEOUT * 5);
620 if (ret < 0)
wdenkaffae2b2002-08-17 09:36:01 +0000621 return ret;
622
wdenkaffae2b2002-08-17 09:36:01 +0000623 return 0;
624}
625
626/********************************************************************
627 * set configuration number to configuration
628 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000629static int usb_set_configuration(struct usb_device *dev, int configuration)
wdenkaffae2b2002-08-17 09:36:01 +0000630{
631 int res;
Vivek Gautamceb49722013-04-12 16:34:33 +0530632 debug("set configuration %d\n", configuration);
wdenkaffae2b2002-08-17 09:36:01 +0000633 /* set setup command */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200634 res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
635 USB_REQ_SET_CONFIGURATION, 0,
636 configuration, 0,
637 NULL, 0, USB_CNTL_TIMEOUT);
638 if (res == 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000639 dev->toggle[0] = 0;
640 dev->toggle[1] = 0;
641 return 0;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200642 } else
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200643 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000644}
645
646/********************************************************************
647 * set protocol to protocol
648 */
649int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
650{
651 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
652 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
653 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
654}
655
656/********************************************************************
657 * set idle
658 */
659int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
660{
661 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
662 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
663 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
664}
665
666/********************************************************************
667 * get report
668 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200669int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
670 unsigned char id, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000671{
672 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200673 USB_REQ_GET_REPORT,
674 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
675 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000676}
677
678/********************************************************************
679 * get class descriptor
680 */
681int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
682 unsigned char type, unsigned char id, void *buf, int size)
683{
684 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
685 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
686 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
687}
688
689/********************************************************************
690 * get string index in buffer
691 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000692static int usb_get_string(struct usb_device *dev, unsigned short langid,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200693 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000694{
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200695 int i;
696 int result;
697
698 for (i = 0; i < 3; ++i) {
699 /* some devices are flaky */
700 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
701 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200702 (USB_DT_STRING << 8) + index, langid, buf, size,
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200703 USB_CNTL_TIMEOUT);
704
705 if (result > 0)
706 break;
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200707 }
708
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200709 return result;
wdenkaffae2b2002-08-17 09:36:01 +0000710}
711
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200712
713static void usb_try_string_workarounds(unsigned char *buf, int *length)
714{
715 int newlength, oldlength = *length;
716
717 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
718 if (!isprint(buf[newlength]) || buf[newlength + 1])
719 break;
720
721 if (newlength > 2) {
722 buf[0] = newlength;
723 *length = newlength;
724 }
725}
726
727
728static int usb_string_sub(struct usb_device *dev, unsigned int langid,
729 unsigned int index, unsigned char *buf)
730{
731 int rc;
732
733 /* Try to read the string descriptor by asking for the maximum
734 * possible number of bytes */
735 rc = usb_get_string(dev, langid, index, buf, 255);
736
737 /* If that failed try to read the descriptor length, then
738 * ask for just that many bytes */
739 if (rc < 2) {
740 rc = usb_get_string(dev, langid, index, buf, 2);
741 if (rc == 2)
742 rc = usb_get_string(dev, langid, index, buf, buf[0]);
743 }
744
745 if (rc >= 2) {
746 if (!buf[0] && !buf[1])
747 usb_try_string_workarounds(buf, &rc);
748
749 /* There might be extra junk at the end of the descriptor */
750 if (buf[0] < rc)
751 rc = buf[0];
752
753 rc = rc - (rc & 1); /* force a multiple of two */
754 }
755
756 if (rc < 2)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200757 rc = -EINVAL;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200758
759 return rc;
760}
761
762
wdenkaffae2b2002-08-17 09:36:01 +0000763/********************************************************************
764 * usb_string:
765 * Get string index and translate it to ascii.
766 * returns string length (> 0) or error (< 0)
767 */
768int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
769{
Puneet Saxenaf5766132012-04-03 14:56:06 +0530770 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ);
wdenkaffae2b2002-08-17 09:36:01 +0000771 unsigned char *tbuf;
772 int err;
773 unsigned int u, idx;
774
775 if (size <= 0 || !buf || !index)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200776 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000777 buf[0] = 0;
Wolfgang Denkd0ff51b2008-07-14 15:19:07 +0200778 tbuf = &mybuf[0];
wdenkaffae2b2002-08-17 09:36:01 +0000779
780 /* get langid for strings if it's not yet known */
781 if (!dev->have_langid) {
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200782 err = usb_string_sub(dev, 0, 0, tbuf);
wdenkaffae2b2002-08-17 09:36:01 +0000783 if (err < 0) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530784 debug("error getting string descriptor 0 " \
785 "(error=%lx)\n", dev->status);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200786 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000787 } else if (tbuf[0] < 4) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530788 debug("string descriptor 0 too short\n");
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200789 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000790 } else {
791 dev->have_langid = -1;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200792 dev->string_langid = tbuf[2] | (tbuf[3] << 8);
wdenkaffae2b2002-08-17 09:36:01 +0000793 /* always use the first langid listed */
Vivek Gautamceb49722013-04-12 16:34:33 +0530794 debug("USB device number %d default " \
795 "language ID 0x%x\n",
796 dev->devnum, dev->string_langid);
wdenkaffae2b2002-08-17 09:36:01 +0000797 }
798 }
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200799
800 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
wdenkaffae2b2002-08-17 09:36:01 +0000801 if (err < 0)
802 return err;
wdenkcd0a9de2004-02-23 20:48:38 +0000803
wdenkaffae2b2002-08-17 09:36:01 +0000804 size--; /* leave room for trailing NULL char in output buffer */
805 for (idx = 0, u = 2; u < err; u += 2) {
806 if (idx >= size)
807 break;
808 if (tbuf[u+1]) /* high byte */
809 buf[idx++] = '?'; /* non-ASCII character */
810 else
811 buf[idx++] = tbuf[u];
812 }
813 buf[idx] = 0;
814 err = idx;
815 return err;
816}
817
818
819/********************************************************************
820 * USB device handling:
821 * the USB device are static allocated [USB_MAX_DEVICE].
822 */
823
824
825/* returns a pointer to the device with the index [index].
826 * if the device is not assigned (dev->devnum==-1) returns NULL
827 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200828struct usb_device *usb_get_dev_index(int index)
wdenkaffae2b2002-08-17 09:36:01 +0000829{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200830 if (usb_dev[index].devnum == -1)
wdenkaffae2b2002-08-17 09:36:01 +0000831 return NULL;
832 else
833 return &usb_dev[index];
834}
835
Simon Glass79b58882015-03-25 12:22:01 -0600836int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp)
wdenkaffae2b2002-08-17 09:36:01 +0000837{
838 int i;
Vivek Gautamceb49722013-04-12 16:34:33 +0530839 debug("New Device %d\n", dev_index);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200840 if (dev_index == USB_MAX_DEVICE) {
841 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
Simon Glass79b58882015-03-25 12:22:01 -0600842 return -ENOSPC;
wdenkaffae2b2002-08-17 09:36:01 +0000843 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200844 /* default Address is 0, real addresses start with 1 */
845 usb_dev[dev_index].devnum = dev_index + 1;
846 usb_dev[dev_index].maxchild = 0;
847 for (i = 0; i < USB_MAXCHILDREN; i++)
848 usb_dev[dev_index].children[i] = NULL;
849 usb_dev[dev_index].parent = NULL;
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200850 usb_dev[dev_index].controller = controller;
wdenkaffae2b2002-08-17 09:36:01 +0000851 dev_index++;
Simon Glass79b58882015-03-25 12:22:01 -0600852 *devp = &usb_dev[dev_index - 1];
853
854 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000855}
856
Milind Choudhary359439d2012-12-12 17:55:28 -0800857/*
858 * Free the newly created device node.
859 * Called in error cases where configuring a newly attached
860 * device fails for some reason.
861 */
Simon Glass79b58882015-03-25 12:22:01 -0600862void usb_free_device(struct udevice *controller)
Milind Choudhary359439d2012-12-12 17:55:28 -0800863{
864 dev_index--;
Vivek Gautamceb49722013-04-12 16:34:33 +0530865 debug("Freeing device node: %d\n", dev_index);
Milind Choudhary359439d2012-12-12 17:55:28 -0800866 memset(&usb_dev[dev_index], 0, sizeof(struct usb_device));
867 usb_dev[dev_index].devnum = -1;
868}
wdenkaffae2b2002-08-17 09:36:01 +0000869
870/*
Vivek Gautam5853e132013-09-14 14:02:45 +0530871 * XHCI issues Enable Slot command and thereafter
872 * allocates device contexts. Provide a weak alias
873 * function for the purpose, so that XHCI overrides it
874 * and EHCI/OHCI just work out of the box.
875 */
876__weak int usb_alloc_device(struct usb_device *udev)
877{
878 return 0;
879}
880/*
wdenkaffae2b2002-08-17 09:36:01 +0000881 * By the time we get here, the device has gotten a new device ID
882 * and is in the default state. We need to identify the thing and
883 * get the ball rolling..
884 *
885 * Returns 0 for success, != 0 for error.
886 */
Marek Vasut23faf2b2012-02-13 18:58:17 +0000887int usb_new_device(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000888{
889 int addr, err;
890 int tmp;
Puneet Saxenaf5766132012-04-03 14:56:06 +0530891 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
wdenkaffae2b2002-08-17 09:36:01 +0000892
Vivek Gautam5853e132013-09-14 14:02:45 +0530893 /*
894 * Allocate usb 3.0 device context.
895 * USB 3.0 (xHCI) protocol tries to allocate device slot
896 * and related data structures first. This call does that.
897 * Refer to sec 4.3.2 in xHCI spec rev1.0
898 */
899 if (usb_alloc_device(dev)) {
900 printf("Cannot allocate device context to get SLOT_ID\n");
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200901 return -EINVAL;
Vivek Gautam5853e132013-09-14 14:02:45 +0530902 }
903
wdenkaffae2b2002-08-17 09:36:01 +0000904 /* We still haven't set the Address yet */
905 addr = dev->devnum;
906 dev->devnum = 0;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200907
Remy Bohmerc9e84362008-09-16 14:55:44 +0200908#ifdef CONFIG_LEGACY_USB_INIT_SEQ
909 /* this is the old and known way of initializing devices, it is
910 * different than what Windows and Linux are doing. Windows and Linux
911 * both retrieve 64 bytes while reading the device descriptor
912 * Several USB stick devices report ERR: CTL_TIMEOUT, caused by an
913 * invalid header while reading 8 bytes as device descriptor. */
914 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */
Remy Bohmer48867202008-10-10 10:23:21 +0200915 dev->maxpacketsize = PACKET_SIZE_8;
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100916 dev->epmaxpacketin[0] = 8;
Remy Bohmerc9e84362008-09-16 14:55:44 +0200917 dev->epmaxpacketout[0] = 8;
918
Ilya Yanok80ab4142012-07-15 04:43:50 +0000919 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, tmpbuf, 8);
Remy Bohmerc9e84362008-09-16 14:55:44 +0200920 if (err < 8) {
921 printf("\n USB device not responding, " \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100922 "giving up (status=%lX)\n", dev->status);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200923 return -EIO;
Remy Bohmerc9e84362008-09-16 14:55:44 +0200924 }
Ilya Yanok80ab4142012-07-15 04:43:50 +0000925 memcpy(&dev->descriptor, tmpbuf, 8);
Remy Bohmerc9e84362008-09-16 14:55:44 +0200926#else
Remy Bohmer48867202008-10-10 10:23:21 +0200927 /* This is a Windows scheme of initialization sequence, with double
928 * reset of the device (Linux uses the same sequence)
Remy Bohmerc9e84362008-09-16 14:55:44 +0200929 * Some equipment is said to work only with such init sequence; this
930 * patch is based on the work by Alan Stern:
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100931 * http://sourceforge.net/mailarchive/forum.php?
932 * thread_id=5729457&forum_id=5398
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200933 */
Vivek Gautam5853e132013-09-14 14:02:45 +0530934 __maybe_unused struct usb_device_descriptor *desc;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200935 struct usb_device *parent = dev->parent;
936 unsigned short portstatus;
937
938 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
939 * only 18 bytes long, this will terminate with a short packet. But if
940 * the maxpacket size is 8 or 16 the device may be waiting to transmit
Remy Bohmerc9e84362008-09-16 14:55:44 +0200941 * some more, or keeps on retransmitting the 8 byte header. */
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200942
943 desc = (struct usb_device_descriptor *)tmpbuf;
Remy Bohmerc9e84362008-09-16 14:55:44 +0200944 dev->descriptor.bMaxPacketSize0 = 64; /* Start off at 64 bytes */
Remy Bohmer48867202008-10-10 10:23:21 +0200945 /* Default to 64 byte max packet size */
946 dev->maxpacketsize = PACKET_SIZE_64;
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100947 dev->epmaxpacketin[0] = 64;
Remy Bohmerc9e84362008-09-16 14:55:44 +0200948 dev->epmaxpacketout[0] = 64;
Remy Bohmer48867202008-10-10 10:23:21 +0200949
Vivek Gautam5853e132013-09-14 14:02:45 +0530950 /*
951 * XHCI needs to issue a Address device command to setup
952 * proper device context structures, before it can interact
953 * with the device. So a get_descriptor will fail before any
954 * of that is done for XHCI unlike EHCI.
955 */
956#ifndef CONFIG_USB_XHCI
Remy Bohmer48867202008-10-10 10:23:21 +0200957 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
Stephen Warren25c06732015-04-08 21:27:49 -0600958 /*
959 * Validate we've received only at least 8 bytes, not that we've
960 * received the entire descriptor. The reasoning is:
961 * - The code only uses fields in the first 8 bytes, so that's all we
962 * need to have fetched at this stage.
963 * - The smallest maxpacket size is 8 bytes. Before we know the actual
964 * maxpacket the device uses, the USB controller may only accept a
965 * single packet. Consequently we are only guaranteed to receive 1
966 * packet (at least 8 bytes) even in a non-error case.
967 *
968 * At least the DWC2 controller needs to be programmed with the number
969 * of packets in addition to the number of bytes. A request for 64
970 * bytes of data with the maxpacket guessed as 64 (above) yields a
971 * request for 1 packet.
972 */
973 if (err < 8) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530974 debug("usb_new_device: usb_get_descriptor() failed\n");
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200975 return -EIO;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200976 }
Remy Bohmer48867202008-10-10 10:23:21 +0200977
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200978 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
Vivek Gautam99c34912013-04-12 16:34:36 +0530979 /*
980 * Fetch the device class, driver can use this info
981 * to differentiate between HUB and DEVICE.
982 */
983 dev->descriptor.bDeviceClass = desc->bDeviceClass;
Vivek Gautam5853e132013-09-14 14:02:45 +0530984#endif
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200985
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200986 if (parent) {
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200987 /* reset the port for the second time */
Hans de Goedef7b9baf2014-09-20 17:03:52 +0200988 err = hub_port_reset(dev->parent, dev->portnr - 1, &portstatus);
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200989 if (err < 0) {
Hans de Goedef7b9baf2014-09-20 17:03:52 +0200990 printf("\n Couldn't reset port %i\n", dev->portnr);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200991 return -EIO;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200992 }
Hans de Goede90cdc102015-01-11 20:34:51 +0100993 } else {
994 usb_reset_root_port();
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200995 }
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200996#endif
997
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100998 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
wdenkaffae2b2002-08-17 09:36:01 +0000999 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
1000 switch (dev->descriptor.bMaxPacketSize0) {
Michael Trimarchide39f8c2008-11-26 17:41:34 +01001001 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;
Paul Kocialkowski04ee6ee2015-04-04 15:12:29 +02001013 default:
1014 printf("usb_new_device: invalid max packet size\n");
1015 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001016 }
1017 dev->devnum = addr;
1018
1019 err = usb_set_address(dev); /* set address */
1020
1021 if (err < 0) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001022 printf("\n USB device not accepting new address " \
1023 "(error=%lX)\n", dev->status);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +02001024 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001025 }
1026
Mike Frysinger5b84dd62012-03-05 13:47:00 +00001027 mdelay(10); /* Let the SET_ADDRESS settle */
wdenkaffae2b2002-08-17 09:36:01 +00001028
1029 tmp = sizeof(dev->descriptor);
1030
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001031 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0,
Ilya Yanok80ab4142012-07-15 04:43:50 +00001032 tmpbuf, sizeof(dev->descriptor));
wdenkaffae2b2002-08-17 09:36:01 +00001033 if (err < tmp) {
1034 if (err < 0)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001035 printf("unable to get device descriptor (error=%d)\n",
1036 err);
wdenkaffae2b2002-08-17 09:36:01 +00001037 else
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001038 printf("USB device descriptor short read " \
1039 "(expected %i, got %i)\n", tmp, err);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +02001040 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001041 }
Ilya Yanok80ab4142012-07-15 04:43:50 +00001042 memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
wdenkaffae2b2002-08-17 09:36:01 +00001043 /* correct le values */
Christian Eggersc9182612008-05-21 22:12:00 +02001044 le16_to_cpus(&dev->descriptor.bcdUSB);
1045 le16_to_cpus(&dev->descriptor.idVendor);
1046 le16_to_cpus(&dev->descriptor.idProduct);
1047 le16_to_cpus(&dev->descriptor.bcdDevice);
wdenkaffae2b2002-08-17 09:36:01 +00001048 /* only support for one config for now */
Vincent Palatin8b8d7792012-07-24 07:12:02 +00001049 err = usb_get_configuration_no(dev, tmpbuf, 0);
1050 if (err < 0) {
1051 printf("usb_new_device: Cannot read configuration, " \
1052 "skipping device %04x:%04x\n",
1053 dev->descriptor.idVendor, dev->descriptor.idProduct);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +02001054 return -EIO;
Vincent Palatin8b8d7792012-07-24 07:12:02 +00001055 }
Puneet Saxenaf5766132012-04-03 14:56:06 +05301056 usb_parse_config(dev, tmpbuf, 0);
wdenkaffae2b2002-08-17 09:36:01 +00001057 usb_set_maxpacket(dev);
1058 /* we set the default configuration here */
Tom Rix8f8bd562009-10-31 12:37:38 -05001059 if (usb_set_configuration(dev, dev->config.desc.bConfigurationValue)) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001060 printf("failed to set default configuration " \
1061 "len %d, status %lX\n", dev->act_len, dev->status);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +02001062 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001063 }
Vivek Gautamceb49722013-04-12 16:34:33 +05301064 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1065 dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1066 dev->descriptor.iSerialNumber);
wdenkaffae2b2002-08-17 09:36:01 +00001067 memset(dev->mf, 0, sizeof(dev->mf));
1068 memset(dev->prod, 0, sizeof(dev->prod));
1069 memset(dev->serial, 0, sizeof(dev->serial));
1070 if (dev->descriptor.iManufacturer)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001071 usb_string(dev, dev->descriptor.iManufacturer,
1072 dev->mf, sizeof(dev->mf));
wdenkaffae2b2002-08-17 09:36:01 +00001073 if (dev->descriptor.iProduct)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001074 usb_string(dev, dev->descriptor.iProduct,
1075 dev->prod, sizeof(dev->prod));
wdenkaffae2b2002-08-17 09:36:01 +00001076 if (dev->descriptor.iSerialNumber)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001077 usb_string(dev, dev->descriptor.iSerialNumber,
1078 dev->serial, sizeof(dev->serial));
Vivek Gautamceb49722013-04-12 16:34:33 +05301079 debug("Manufacturer %s\n", dev->mf);
1080 debug("Product %s\n", dev->prod);
1081 debug("SerialNumber %s\n", dev->serial);
wdenkaffae2b2002-08-17 09:36:01 +00001082 /* now prode if the device is a hub */
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001083 usb_hub_probe(dev, 0);
wdenkaffae2b2002-08-17 09:36:01 +00001084 return 0;
1085}
1086
Mateusz Zalega16297cf2013-10-04 19:22:26 +02001087__weak
Troy Kiskybba67912013-10-10 15:27:55 -07001088int board_usb_init(int index, enum usb_init_type init)
Mateusz Zalega16297cf2013-10-04 19:22:26 +02001089{
1090 return 0;
1091}
Kishon Vijay Abraham Idb378d72015-02-23 18:40:18 +05301092
1093__weak
1094int board_usb_cleanup(int index, enum usb_init_type init)
1095{
1096 return 0;
1097}
wdenkaffae2b2002-08-17 09:36:01 +00001098/* EOF */