blob: 4d0de4d87e83a1bfd5f15ea171472de4260a59d2 [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>
Simon Glass95fbfe42015-03-25 12:22:08 -060031#include <dm.h>
Simon Glasscf92e052015-09-02 17:24:58 -060032#include <memalign.h>
wdenkaffae2b2002-08-17 09:36:01 +000033#include <asm/processor.h>
Mike Frysinger66cf6412012-04-04 18:44:53 +000034#include <linux/compiler.h>
Wolfgang Denk9c998aa2005-07-21 11:57:57 +020035#include <linux/ctype.h>
Christian Eggersc9182612008-05-21 22:12:00 +020036#include <asm/byteorder.h>
Tom Rinib2fb47f2011-12-15 08:40:51 -070037#include <asm/unaligned.h>
Marek Vasut97b9eb92014-08-01 03:09:53 +020038#include <errno.h>
wdenkaffae2b2002-08-17 09:36:01 +000039#include <usb.h>
40#ifdef CONFIG_4xx
Stefan Roese3048bcb2007-10-03 15:01:02 +020041#include <asm/4xx_pci.h>
wdenkaffae2b2002-08-17 09:36:01 +000042#endif
43
wdenkcd0a9de2004-02-23 20:48:38 +000044#define USB_BUFSIZ 512
45
Simon Glass95fbfe42015-03-25 12:22:08 -060046static int asynch_allowed;
47char usb_started; /* flag for the started/stopped USB status */
48
49#ifndef CONFIG_DM_USB
wdenkaffae2b2002-08-17 09:36:01 +000050static struct usb_device usb_dev[USB_MAX_DEVICE];
51static int dev_index;
Bartlomiej Siekae51aae32006-08-03 23:20:13 +020052
Lucas Stach93c25822012-09-26 00:14:36 +020053#ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
54#define CONFIG_USB_MAX_CONTROLLER_COUNT 1
55#endif
wdenkaffae2b2002-08-17 09:36:01 +000056
wdenkaffae2b2002-08-17 09:36:01 +000057/***************************************************************************
58 * Init USB Device
59 */
wdenkaffae2b2002-08-17 09:36:01 +000060int usb_init(void)
61{
Lucas Stach93c25822012-09-26 00:14:36 +020062 void *ctrl;
63 struct usb_device *dev;
64 int i, start_index = 0;
Hans de Goeded906bbc2015-01-11 20:34:46 +010065 int controllers_initialized = 0;
Marek Vasut97b9eb92014-08-01 03:09:53 +020066 int ret;
wdenkaffae2b2002-08-17 09:36:01 +000067
Remy Bohmer6f5794a2008-09-16 14:55:43 +020068 dev_index = 0;
69 asynch_allowed = 1;
wdenkaffae2b2002-08-17 09:36:01 +000070 usb_hub_reset();
Lucas Stach93c25822012-09-26 00:14:36 +020071
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
wdenkaffae2b2002-08-17 09:36:01 +000078 /* init low_level USB */
Lucas Stach93c25822012-09-26 00:14:36 +020079 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
80 /* init low_level USB */
81 printf("USB%d: ", i);
Marek Vasut97b9eb92014-08-01 03:09:53 +020082 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
83 if (ret == -ENODEV) { /* No such device. */
84 puts("Port not available.\n");
Hans de Goeded906bbc2015-01-11 20:34:46 +010085 controllers_initialized++;
Marek Vasut97b9eb92014-08-01 03:09:53 +020086 continue;
87 }
88
89 if (ret) { /* Other error. */
Lucas Stach93c25822012-09-26 00:14:36 +020090 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 */
Hans de Goeded906bbc2015-01-11 20:34:46 +010097 controllers_initialized++;
Lucas Stach93c25822012-09-26 00:14:36 +020098 start_index = dev_index;
99 printf("scanning bus %d for devices... ", i);
Simon Glass79b58882015-03-25 12:22:01 -0600100 ret = usb_alloc_new_device(ctrl, &dev);
101 if (ret)
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200102 break;
103
Lucas Stach93c25822012-09-26 00:14:36 +0200104 /*
105 * device 0 is always present
106 * (root hub, so let it analyze)
107 */
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200108 ret = usb_new_device(dev);
109 if (ret)
Simon Glass79b58882015-03-25 12:22:01 -0600110 usb_free_device(dev->controller);
Lucas Stach93c25822012-09-26 00:14:36 +0200111
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200112 if (start_index == dev_index) {
Lucas Stach93c25822012-09-26 00:14:36 +0200113 puts("No USB Device found\n");
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200114 continue;
115 } else {
Lucas Stach93c25822012-09-26 00:14:36 +0200116 printf("%d USB Device(s) found\n",
117 dev_index - start_index);
Paul Kocialkowski8879be82015-04-04 15:12:28 +0200118 }
Lucas Stach93c25822012-09-26 00:14:36 +0200119
Bartlomiej Siekae51aae32006-08-03 23:20:13 +0200120 usb_started = 1;
Lucas Stach93c25822012-09-26 00:14:36 +0200121 }
122
Vivek Gautamceb49722013-04-12 16:34:33 +0530123 debug("scan end\n");
Lucas Stach93c25822012-09-26 00:14:36 +0200124 /* if we were not able to find at least one working bus, bail out */
Hans de Goeded906bbc2015-01-11 20:34:46 +0100125 if (controllers_initialized == 0)
Lucas Stach93c25822012-09-26 00:14:36 +0200126 puts("USB error: all controllers failed lowlevel init\n");
Lucas Stach93c25822012-09-26 00:14:36 +0200127
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200128 return usb_started ? 0 : -ENODEV;
wdenkaffae2b2002-08-17 09:36:01 +0000129}
130
131/******************************************************************************
132 * Stop USB this stops the LowLevel Part and deregisters USB devices.
133 */
134int usb_stop(void)
135{
Lucas Stach93c25822012-09-26 00:14:36 +0200136 int i;
Remy Bohmereba1f2f2008-08-20 11:22:02 +0200137
138 if (usb_started) {
139 asynch_allowed = 1;
140 usb_started = 0;
141 usb_hub_reset();
Lucas Stach93c25822012-09-26 00:14:36 +0200142
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 }
Remy Bohmereba1f2f2008-08-20 11:22:02 +0200147 }
Lucas Stach93c25822012-09-26 00:14:36 +0200148
149 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000150}
151
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600152/******************************************************************************
153 * Detect if a USB device has been plugged or unplugged.
154 */
155int 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
wdenkaffae2b2002-08-17 09:36:01 +0000178/*
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.
Simon Glass89d48362011-02-16 11:14:33 -0800181 * Returns the old value so it can be restored later.
wdenkaffae2b2002-08-17 09:36:01 +0000182 */
Simon Glass89d48362011-02-16 11:14:33 -0800183int usb_disable_asynch(int disable)
wdenkaffae2b2002-08-17 09:36:01 +0000184{
Simon Glass89d48362011-02-16 11:14:33 -0800185 int old_value = asynch_allowed;
186
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200187 asynch_allowed = !disable;
Simon Glass89d48362011-02-16 11:14:33 -0800188 return old_value;
wdenkaffae2b2002-08-17 09:36:01 +0000189}
Simon Glass95fbfe42015-03-25 12:22:08 -0600190#endif /* !CONFIG_DM_USB */
wdenkaffae2b2002-08-17 09:36:01 +0000191
192
193/*-------------------------------------------------------------------
194 * Message wrappers.
195 *
196 */
197
198/*
199 * submits an Interrupt Message
200 */
201int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200202 void *buffer, int transfer_len, int interval)
wdenkaffae2b2002-08-17 09:36:01 +0000203{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200204 return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
wdenkaffae2b2002-08-17 09:36:01 +0000205}
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)).
Vagrant Cascadiana6f70a32016-03-15 12:16:39 -0700213 * returns the transferred length if OK or -1 if error. The transferred length
wdenkaffae2b2002-08-17 09:36:01 +0000214 * and the current status are stored in the dev->act_len and dev->status.
215 */
216int 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{
Puneet Saxenaf5766132012-04-03 14:56:06 +0530221 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
Hans de Goede651d95c2015-05-10 14:10:14 +0200222 int err;
Marek Vasute159e482012-02-13 18:58:18 +0000223
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200224 if ((timeout == 0) && (!asynch_allowed)) {
225 /* request for a asynch control pipe is not allowed */
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200226 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200227 }
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200228
wdenkaffae2b2002-08-17 09:36:01 +0000229 /* set setup command */
Puneet Saxenaf5766132012-04-03 14:56:06 +0530230 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);
Vivek Gautamceb49722013-04-12 16:34:33 +0530235 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);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200238 dev->status = USB_ST_NOT_PROC; /*not yet processed */
wdenkaffae2b2002-08-17 09:36:01 +0000239
Hans de Goede651d95c2015-05-10 14:10:14 +0200240 err = submit_control_msg(dev, pipe, data, size, setup_packet);
241 if (err < 0)
242 return err;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200243 if (timeout == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000244 return (int)size;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200245
Remy Bohmer84d36b32010-02-01 19:40:47 +0100246 /*
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;
Mike Frysinger5b84dd62012-03-05 13:47:00 +0000254 mdelay(1);
Remy Bohmer48867202008-10-10 10:23:21 +0200255 }
Remy Bohmer84d36b32010-02-01 19:40:47 +0100256 if (dev->status)
257 return -1;
Remy Bohmer48867202008-10-10 10:23:21 +0200258
259 return dev->act_len;
Remy Bohmer84d36b32010-02-01 19:40:47 +0100260
wdenkaffae2b2002-08-17 09:36:01 +0000261}
262
263/*-------------------------------------------------------------------
264 * submits bulk message, and waits for completion. returns 0 if Ok or
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200265 * negative if Error.
wdenkaffae2b2002-08-17 09:36:01 +0000266 * synchronous behavior
267 */
268int 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)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200272 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200273 dev->status = USB_ST_NOT_PROC; /*not yet processed */
Ilya Yanokfd060282012-07-15 04:43:51 +0000274 if (submit_bulk_msg(dev, pipe, data, len) < 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200275 return -EIO;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200276 while (timeout--) {
277 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
wdenkaffae2b2002-08-17 09:36:01 +0000278 break;
Mike Frysinger5b84dd62012-03-05 13:47:00 +0000279 mdelay(1);
wdenkaffae2b2002-08-17 09:36:01 +0000280 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200281 *actual_length = dev->act_len;
282 if (dev->status == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000283 return 0;
284 else
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200285 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000286}
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 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200297int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
wdenkaffae2b2002-08-17 09:36:01 +0000298{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200299 /* direction is out -> use emaxpacket out */
300 if ((pipe & USB_DIR_IN) == 0)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100301 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000302 else
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100303 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000304}
305
Marek Vasut5e8baf82011-11-05 23:35:12 +0100306/*
307 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
Remy Bohmerbe19d322008-09-16 14:55:42 +0200308 * 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)
Marek Vasut5e8baf82011-11-05 23:35:12 +0100314 *
315 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
Remy Bohmerbe19d322008-09-16 14:55:42 +0200316 */
Mike Frysinger66cf6412012-04-04 18:44:53 +0000317static void noinline
Marek Vasut5e8baf82011-11-05 23:35:12 +0100318usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
Remy Bohmerbe19d322008-09-16 14:55:42 +0200319{
320 int b;
Marek Vasut5e8baf82011-11-05 23:35:12 +0100321 struct usb_endpoint_descriptor *ep;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700322 u16 ep_wMaxPacketSize;
Marek Vasut5e8baf82011-11-05 23:35:12 +0100323
324 ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
Remy Bohmerbe19d322008-09-16 14:55:42 +0200325
326 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700327 ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200328
329 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
330 USB_ENDPOINT_XFER_CONTROL) {
331 /* Control => bidirectional */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700332 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
333 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530334 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
335 b, dev->epmaxpacketin[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200336 } else {
337 if ((ep->bEndpointAddress & 0x80) == 0) {
338 /* OUT Endpoint */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700339 if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) {
340 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530341 debug("##EP epmaxpacketout[%d] = %d\n",
342 b, dev->epmaxpacketout[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200343 }
344 } else {
345 /* IN Endpoint */
Tom Rinib2fb47f2011-12-15 08:40:51 -0700346 if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) {
347 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamceb49722013-04-12 16:34:33 +0530348 debug("##EP epmaxpacketin[%d] = %d\n",
349 b, dev->epmaxpacketin[b]);
Remy Bohmerbe19d322008-09-16 14:55:42 +0200350 }
351 } /* if out */
352 } /* if control */
353}
354
wdenkaffae2b2002-08-17 09:36:01 +0000355/*
356 * set the max packed value of all endpoints in the given configuration
357 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000358static int usb_set_maxpacket(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000359{
Remy Bohmerbe19d322008-09-16 14:55:42 +0200360 int i, ii;
wdenkaffae2b2002-08-17 09:36:01 +0000361
Tom Rix8f8bd562009-10-31 12:37:38 -0500362 for (i = 0; i < dev->config.desc.bNumInterfaces; i++)
363 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++)
Marek Vasut5e8baf82011-11-05 23:35:12 +0100364 usb_set_maxpacket_ep(dev, i, ii);
wdenkaffae2b2002-08-17 09:36:01 +0000365
wdenkaffae2b2002-08-17 09:36:01 +0000366 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.
Julius Wernereaf3e612013-07-19 13:12:08 -0700372 * (wTotalLength has already been swapped and sanitized when it was read.)
wdenkaffae2b2002-08-17 09:36:01 +0000373 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000374static int usb_parse_config(struct usb_device *dev,
375 unsigned char *buffer, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000376{
377 struct usb_descriptor_header *head;
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200378 int index, ifno, epno, curr_if_num;
Tom Rinib2fb47f2011-12-15 08:40:51 -0700379 u16 ep_wMaxPacketSize;
Vivek Gautam605bd752013-04-12 16:34:34 +0530380 struct usb_interface *if_desc = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000381
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200382 ifno = -1;
383 epno = -1;
384 curr_if_num = -1;
385
386 dev->configno = cfgno;
387 head = (struct usb_descriptor_header *) &buffer[0];
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200388 if (head->bDescriptorType != USB_DT_CONFIG) {
389 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
390 head->bDescriptorType);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200391 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000392 }
Julius Wernereaf3e612013-07-19 13:12:08 -0700393 if (head->bLength != USB_DT_CONFIG_SIZE) {
394 printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200395 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700396 }
397 memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200398 dev->config.no_of_if = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000399
Tom Rix8f8bd562009-10-31 12:37:38 -0500400 index = dev->config.desc.bLength;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200401 /* Ok the first entry must be a configuration entry,
402 * now process the others */
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200403 head = (struct usb_descriptor_header *) &buffer[index];
Julius Wernereaf3e612013-07-19 13:12:08 -0700404 while (index + 1 < dev->config.desc.wTotalLength && head->bLength) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200405 switch (head->bDescriptorType) {
406 case USB_DT_INTERFACE:
Julius Wernereaf3e612013-07-19 13:12:08 -0700407 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 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200417 if (((struct usb_interface_descriptor *) \
Julius Wernereaf3e612013-07-19 13:12:08 -0700418 head)->bInterfaceNumber != curr_if_num) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200419 /* this is a new interface, copy new desc */
420 ifno = dev->config.no_of_if;
Julius Wernereaf3e612013-07-19 13:12:08 -0700421 if (ifno >= USB_MAXINTERFACES) {
422 puts("Too many USB interfaces!\n");
423 /* try to go on with what we have */
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200424 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700425 }
Vivek Gautam605bd752013-04-12 16:34:34 +0530426 if_desc = &dev->config.if_desc[ifno];
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200427 dev->config.no_of_if++;
Julius Wernereaf3e612013-07-19 13:12:08 -0700428 memcpy(if_desc, head,
429 USB_DT_INTERFACE_SIZE);
Vivek Gautam605bd752013-04-12 16:34:34 +0530430 if_desc->no_of_ep = 0;
431 if_desc->num_altsetting = 1;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200432 curr_if_num =
Vivek Gautam605bd752013-04-12 16:34:34 +0530433 if_desc->desc.bInterfaceNumber;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200434 } else {
435 /* found alternate setting for the interface */
Vivek Gautam605bd752013-04-12 16:34:34 +0530436 if (ifno >= 0) {
437 if_desc = &dev->config.if_desc[ifno];
438 if_desc->num_altsetting++;
439 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200440 }
441 break;
442 case USB_DT_ENDPOINT:
Julius Wernereaf3e612013-07-19 13:12:08 -0700443 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 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200457 epno = dev->config.if_desc[ifno].no_of_ep;
Vivek Gautam605bd752013-04-12 16:34:34 +0530458 if_desc = &dev->config.if_desc[ifno];
Peng Fan447b9cd2016-01-12 15:57:01 +0800459 if (epno >= USB_MAXENDPOINTS) {
Julius Wernereaf3e612013-07-19 13:12:08 -0700460 printf("Interface %d has too many endpoints!\n",
461 if_desc->desc.bInterfaceNumber);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200462 return -EINVAL;
Julius Wernereaf3e612013-07-19 13:12:08 -0700463 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200464 /* found an endpoint */
Vivek Gautam605bd752013-04-12 16:34:34 +0530465 if_desc->no_of_ep++;
Julius Wernereaf3e612013-07-19 13:12:08 -0700466 memcpy(&if_desc->ep_desc[epno], head,
467 USB_DT_ENDPOINT_SIZE);
Tom Rinib2fb47f2011-12-15 08:40:51 -0700468 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);
Vivek Gautamceb49722013-04-12 16:34:33 +0530477 debug("if %d, ep %d\n", ifno, epno);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200478 break;
Vivek Gautam6497c662013-04-12 16:34:38 +0530479 case USB_DT_SS_ENDPOINT_COMP:
Julius Wernereaf3e612013-07-19 13:12:08 -0700480 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 }
Vivek Gautam6497c662013-04-12 16:34:38 +0530494 if_desc = &dev->config.if_desc[ifno];
Julius Wernereaf3e612013-07-19 13:12:08 -0700495 memcpy(&if_desc->ss_ep_comp_desc[epno], head,
496 USB_DT_SS_EP_COMP_SIZE);
Vivek Gautam6497c662013-04-12 16:34:38 +0530497 break;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200498 default:
499 if (head->bLength == 0)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200500 return -EINVAL;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200501
Vivek Gautamceb49722013-04-12 16:34:33 +0530502 debug("unknown Description Type : %x\n",
503 head->bDescriptorType);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200504
Vivek Gautamceb49722013-04-12 16:34:33 +0530505#ifdef DEBUG
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200506 {
Wolfgang Denkfad2e1b2011-10-05 23:11:19 +0200507 unsigned char *ch = (unsigned char *)head;
Vivek Gautamceb49722013-04-12 16:34:33 +0530508 int i;
509
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200510 for (i = 0; i < head->bLength; i++)
Vivek Gautamceb49722013-04-12 16:34:33 +0530511 debug("%02X ", *ch++);
512 debug("\n\n\n");
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200513 }
Vivek Gautamceb49722013-04-12 16:34:33 +0530514#endif
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200515 break;
wdenkaffae2b2002-08-17 09:36:01 +0000516 }
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200517 index += head->bLength;
518 head = (struct usb_descriptor_header *)&buffer[index];
wdenkaffae2b2002-08-17 09:36:01 +0000519 }
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200520 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000521}
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 */
528int usb_clear_halt(struct usb_device *dev, int pipe)
529{
530 int result;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200531 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
wdenkaffae2b2002-08-17 09:36:01 +0000532
533 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200534 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
535 endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
wdenkaffae2b2002-08-17 09:36:01 +0000536
537 /* don't clear if failed */
538 if (result < 0)
539 return result;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200540
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200541 /*
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200542 * 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
wdenkaffae2b2002-08-17 09:36:01 +0000546 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200547
wdenkaffae2b2002-08-17 09:36:01 +0000548 /* 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 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000557static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200558 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000559{
560 int res;
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200561 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
wdenkaffae2b2002-08-17 09:36:01 +0000562 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
563 (type << 8) + index, 0,
564 buf, size, USB_CNTL_TIMEOUT);
565 return res;
566}
567
568/**********************************************************************
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100569 * gets len of configuration cfgno
wdenkaffae2b2002-08-17 09:36:01 +0000570 */
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100571int usb_get_configuration_len(struct usb_device *dev, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000572{
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200573 int result;
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100574 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, 9);
Ilya Yanokc60795f2012-11-06 13:48:20 +0000575 struct usb_config_descriptor *config;
wdenkaffae2b2002-08-17 09:36:01 +0000576
Ilya Yanokc60795f2012-11-06 13:48:20 +0000577 config = (struct usb_config_descriptor *)&buffer[0];
Remy Bohmer48867202008-10-10 10:23:21 +0200578 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
579 if (result < 9) {
wdenkaffae2b2002-08-17 09:36:01 +0000580 if (result < 0)
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200581 printf("unable to get descriptor, error %lX\n",
582 dev->status);
wdenkaffae2b2002-08-17 09:36:01 +0000583 else
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200584 printf("config descriptor too short " \
Remy Bohmer48867202008-10-10 10:23:21 +0200585 "(expected %i, got %i)\n", 9, result);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200586 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000587 }
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100588 return le16_to_cpu(config->wTotalLength);
589}
wdenkaffae2b2002-08-17 09:36:01 +0000590
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100591/**********************************************************************
592 * gets configuration cfgno and store it in the buffer
593 */
594int usb_get_configuration_no(struct usb_device *dev, int cfgno,
595 unsigned char *buffer, int length)
596{
597 int result;
598 struct usb_config_descriptor *config;
wdenkcd0a9de2004-02-23 20:48:38 +0000599
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100600 config = (struct usb_config_descriptor *)&buffer[0];
Julius Wernereaf3e612013-07-19 13:12:08 -0700601 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100602 debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result,
603 le16_to_cpu(config->wTotalLength));
604 config->wTotalLength = result; /* validated, with CPU byte order */
Julius Wernereaf3e612013-07-19 13:12:08 -0700605
wdenkaffae2b2002-08-17 09:36:01 +0000606 return result;
607}
608
609/********************************************************************
610 * set address of a device to the value in dev->devnum.
611 * This can only be done by addressing the device via the default address (0)
612 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000613static int usb_set_address(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000614{
615 int res;
616
Vivek Gautamceb49722013-04-12 16:34:33 +0530617 debug("set address %d\n", dev->devnum);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200618 res = usb_control_msg(dev, usb_snddefctrl(dev),
619 USB_REQ_SET_ADDRESS, 0,
620 (dev->devnum), 0,
621 NULL, 0, USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000622 return res;
623}
624
625/********************************************************************
626 * set interface number to interface
627 */
628int usb_set_interface(struct usb_device *dev, int interface, int alternate)
629{
Tom Rix8f8bd562009-10-31 12:37:38 -0500630 struct usb_interface *if_face = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000631 int ret, i;
632
Tom Rix8f8bd562009-10-31 12:37:38 -0500633 for (i = 0; i < dev->config.desc.bNumInterfaces; i++) {
634 if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) {
wdenkaffae2b2002-08-17 09:36:01 +0000635 if_face = &dev->config.if_desc[i];
636 break;
637 }
638 }
639 if (!if_face) {
640 printf("selecting invalid interface %d", interface);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200641 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000642 }
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200643 /*
644 * We should return now for devices with only one alternate setting.
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200645 * According to 9.4.10 of the Universal Serial Bus Specification
646 * Revision 2.0 such devices can return with a STALL. This results in
647 * some USB sticks timeouting during initialization and then being
648 * unusable in U-Boot.
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200649 */
650 if (if_face->num_altsetting == 1)
651 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000652
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200653 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
654 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
655 alternate, interface, NULL, 0,
656 USB_CNTL_TIMEOUT * 5);
657 if (ret < 0)
wdenkaffae2b2002-08-17 09:36:01 +0000658 return ret;
659
wdenkaffae2b2002-08-17 09:36:01 +0000660 return 0;
661}
662
663/********************************************************************
664 * set configuration number to configuration
665 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000666static int usb_set_configuration(struct usb_device *dev, int configuration)
wdenkaffae2b2002-08-17 09:36:01 +0000667{
668 int res;
Vivek Gautamceb49722013-04-12 16:34:33 +0530669 debug("set configuration %d\n", configuration);
wdenkaffae2b2002-08-17 09:36:01 +0000670 /* set setup command */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200671 res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
672 USB_REQ_SET_CONFIGURATION, 0,
673 configuration, 0,
674 NULL, 0, USB_CNTL_TIMEOUT);
675 if (res == 0) {
wdenkaffae2b2002-08-17 09:36:01 +0000676 dev->toggle[0] = 0;
677 dev->toggle[1] = 0;
678 return 0;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200679 } else
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200680 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000681}
682
683/********************************************************************
684 * set protocol to protocol
685 */
686int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol)
687{
688 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
689 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
690 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
691}
692
693/********************************************************************
694 * set idle
695 */
696int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id)
697{
698 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
699 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
700 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT);
701}
702
703/********************************************************************
704 * get report
705 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200706int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
707 unsigned char id, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000708{
709 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200710 USB_REQ_GET_REPORT,
711 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
712 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000713}
714
715/********************************************************************
716 * get class descriptor
717 */
718int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
719 unsigned char type, unsigned char id, void *buf, int size)
720{
721 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
722 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN,
723 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT);
724}
725
726/********************************************************************
727 * get string index in buffer
728 */
Marek Vasutc08b1b22012-02-13 18:58:16 +0000729static int usb_get_string(struct usb_device *dev, unsigned short langid,
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200730 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000731{
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200732 int i;
733 int result;
734
735 for (i = 0; i < 3; ++i) {
736 /* some devices are flaky */
737 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
738 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200739 (USB_DT_STRING << 8) + index, langid, buf, size,
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200740 USB_CNTL_TIMEOUT);
741
742 if (result > 0)
743 break;
Wolfgang Denk095b8a32005-08-02 17:06:17 +0200744 }
745
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200746 return result;
wdenkaffae2b2002-08-17 09:36:01 +0000747}
748
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200749
750static void usb_try_string_workarounds(unsigned char *buf, int *length)
751{
752 int newlength, oldlength = *length;
753
754 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
755 if (!isprint(buf[newlength]) || buf[newlength + 1])
756 break;
757
758 if (newlength > 2) {
759 buf[0] = newlength;
760 *length = newlength;
761 }
762}
763
764
765static int usb_string_sub(struct usb_device *dev, unsigned int langid,
766 unsigned int index, unsigned char *buf)
767{
768 int rc;
769
770 /* Try to read the string descriptor by asking for the maximum
771 * possible number of bytes */
772 rc = usb_get_string(dev, langid, index, buf, 255);
773
774 /* If that failed try to read the descriptor length, then
775 * ask for just that many bytes */
776 if (rc < 2) {
777 rc = usb_get_string(dev, langid, index, buf, 2);
778 if (rc == 2)
779 rc = usb_get_string(dev, langid, index, buf, buf[0]);
780 }
781
782 if (rc >= 2) {
783 if (!buf[0] && !buf[1])
784 usb_try_string_workarounds(buf, &rc);
785
786 /* There might be extra junk at the end of the descriptor */
787 if (buf[0] < rc)
788 rc = buf[0];
789
790 rc = rc - (rc & 1); /* force a multiple of two */
791 }
792
793 if (rc < 2)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200794 rc = -EINVAL;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200795
796 return rc;
797}
798
799
wdenkaffae2b2002-08-17 09:36:01 +0000800/********************************************************************
801 * usb_string:
802 * Get string index and translate it to ascii.
803 * returns string length (> 0) or error (< 0)
804 */
805int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
806{
Puneet Saxenaf5766132012-04-03 14:56:06 +0530807 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ);
wdenkaffae2b2002-08-17 09:36:01 +0000808 unsigned char *tbuf;
809 int err;
810 unsigned int u, idx;
811
812 if (size <= 0 || !buf || !index)
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200813 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000814 buf[0] = 0;
Wolfgang Denkd0ff51b2008-07-14 15:19:07 +0200815 tbuf = &mybuf[0];
wdenkaffae2b2002-08-17 09:36:01 +0000816
817 /* get langid for strings if it's not yet known */
818 if (!dev->have_langid) {
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200819 err = usb_string_sub(dev, 0, 0, tbuf);
wdenkaffae2b2002-08-17 09:36:01 +0000820 if (err < 0) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530821 debug("error getting string descriptor 0 " \
822 "(error=%lx)\n", dev->status);
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200823 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000824 } else if (tbuf[0] < 4) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530825 debug("string descriptor 0 too short\n");
Paul Kocialkowski5a80b342015-04-04 15:12:27 +0200826 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000827 } else {
828 dev->have_langid = -1;
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200829 dev->string_langid = tbuf[2] | (tbuf[3] << 8);
wdenkaffae2b2002-08-17 09:36:01 +0000830 /* always use the first langid listed */
Vivek Gautamceb49722013-04-12 16:34:33 +0530831 debug("USB device number %d default " \
832 "language ID 0x%x\n",
833 dev->devnum, dev->string_langid);
wdenkaffae2b2002-08-17 09:36:01 +0000834 }
835 }
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200836
837 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
wdenkaffae2b2002-08-17 09:36:01 +0000838 if (err < 0)
839 return err;
wdenkcd0a9de2004-02-23 20:48:38 +0000840
wdenkaffae2b2002-08-17 09:36:01 +0000841 size--; /* leave room for trailing NULL char in output buffer */
842 for (idx = 0, u = 2; u < err; u += 2) {
843 if (idx >= size)
844 break;
845 if (tbuf[u+1]) /* high byte */
846 buf[idx++] = '?'; /* non-ASCII character */
847 else
848 buf[idx++] = tbuf[u];
849 }
850 buf[idx] = 0;
851 err = idx;
852 return err;
853}
854
855
856/********************************************************************
857 * USB device handling:
858 * the USB device are static allocated [USB_MAX_DEVICE].
859 */
860
Simon Glass95fbfe42015-03-25 12:22:08 -0600861#ifndef CONFIG_DM_USB
wdenkaffae2b2002-08-17 09:36:01 +0000862
863/* returns a pointer to the device with the index [index].
864 * if the device is not assigned (dev->devnum==-1) returns NULL
865 */
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200866struct usb_device *usb_get_dev_index(int index)
wdenkaffae2b2002-08-17 09:36:01 +0000867{
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200868 if (usb_dev[index].devnum == -1)
wdenkaffae2b2002-08-17 09:36:01 +0000869 return NULL;
870 else
871 return &usb_dev[index];
872}
873
Simon Glass79b58882015-03-25 12:22:01 -0600874int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp)
wdenkaffae2b2002-08-17 09:36:01 +0000875{
876 int i;
Vivek Gautamceb49722013-04-12 16:34:33 +0530877 debug("New Device %d\n", dev_index);
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200878 if (dev_index == USB_MAX_DEVICE) {
879 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
Simon Glass79b58882015-03-25 12:22:01 -0600880 return -ENOSPC;
wdenkaffae2b2002-08-17 09:36:01 +0000881 }
Remy Bohmer6f5794a2008-09-16 14:55:43 +0200882 /* default Address is 0, real addresses start with 1 */
883 usb_dev[dev_index].devnum = dev_index + 1;
884 usb_dev[dev_index].maxchild = 0;
885 for (i = 0; i < USB_MAXCHILDREN; i++)
886 usb_dev[dev_index].children[i] = NULL;
887 usb_dev[dev_index].parent = NULL;
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200888 usb_dev[dev_index].controller = controller;
wdenkaffae2b2002-08-17 09:36:01 +0000889 dev_index++;
Simon Glass79b58882015-03-25 12:22:01 -0600890 *devp = &usb_dev[dev_index - 1];
891
892 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000893}
894
Milind Choudhary359439d2012-12-12 17:55:28 -0800895/*
896 * Free the newly created device node.
897 * Called in error cases where configuring a newly attached
898 * device fails for some reason.
899 */
Simon Glass79b58882015-03-25 12:22:01 -0600900void usb_free_device(struct udevice *controller)
Milind Choudhary359439d2012-12-12 17:55:28 -0800901{
902 dev_index--;
Vivek Gautamceb49722013-04-12 16:34:33 +0530903 debug("Freeing device node: %d\n", dev_index);
Milind Choudhary359439d2012-12-12 17:55:28 -0800904 memset(&usb_dev[dev_index], 0, sizeof(struct usb_device));
905 usb_dev[dev_index].devnum = -1;
906}
wdenkaffae2b2002-08-17 09:36:01 +0000907
908/*
Vivek Gautam5853e132013-09-14 14:02:45 +0530909 * XHCI issues Enable Slot command and thereafter
910 * allocates device contexts. Provide a weak alias
911 * function for the purpose, so that XHCI overrides it
912 * and EHCI/OHCI just work out of the box.
913 */
914__weak int usb_alloc_device(struct usb_device *udev)
915{
916 return 0;
917}
Simon Glass95fbfe42015-03-25 12:22:08 -0600918#endif /* !CONFIG_DM_USB */
Simon Glass862e75c2015-03-25 12:22:04 -0600919
Hans de Goede682c9f82015-06-17 21:33:47 +0200920static int usb_hub_port_reset(struct usb_device *dev, struct usb_device *hub)
Simon Glass862e75c2015-03-25 12:22:04 -0600921{
Stefan Roese3ed9eb92016-03-15 13:59:14 +0100922 if (!hub)
Hans de Goede8802f562015-06-17 21:33:48 +0200923 usb_reset_root_port(dev);
Simon Glass862e75c2015-03-25 12:22:04 -0600924
925 return 0;
926}
927
Simon Glass0ed27902015-03-25 12:22:07 -0600928static int get_descriptor_len(struct usb_device *dev, int len, int expect_len)
wdenkaffae2b2002-08-17 09:36:01 +0000929{
Simon Glass128fcac2015-03-25 12:22:05 -0600930 __maybe_unused struct usb_device_descriptor *desc;
Puneet Saxenaf5766132012-04-03 14:56:06 +0530931 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
Simon Glass0ed27902015-03-25 12:22:07 -0600932 int err;
933
934 desc = (struct usb_device_descriptor *)tmpbuf;
935
936 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, len);
937 if (err < expect_len) {
938 if (err < 0) {
939 printf("unable to get device descriptor (error=%d)\n",
940 err);
941 return err;
942 } else {
943 printf("USB device descriptor short read (expected %i, got %i)\n",
944 expect_len, err);
945 return -EIO;
946 }
947 }
948 memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
949
950 return 0;
951}
952
953static int usb_setup_descriptor(struct usb_device *dev, bool do_read)
954{
Vivek Gautam5853e132013-09-14 14:02:45 +0530955 /*
Simon Glass53d8aa02015-03-25 12:22:03 -0600956 * This is a Windows scheme of initialization sequence, with double
Remy Bohmer48867202008-10-10 10:23:21 +0200957 * reset of the device (Linux uses the same sequence)
Remy Bohmerc9e84362008-09-16 14:55:44 +0200958 * Some equipment is said to work only with such init sequence; this
959 * patch is based on the work by Alan Stern:
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100960 * http://sourceforge.net/mailarchive/forum.php?
961 * thread_id=5729457&forum_id=5398
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200962 */
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200963
Simon Glass53d8aa02015-03-25 12:22:03 -0600964 /*
965 * send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200966 * only 18 bytes long, this will terminate with a short packet. But if
967 * the maxpacket size is 8 or 16 the device may be waiting to transmit
Hans de Goede2b338ef2015-05-05 23:56:04 +0200968 * some more, or keeps on retransmitting the 8 byte header.
969 */
Wolfgang Denk9c998aa2005-07-21 11:57:57 +0200970
Hans de Goede2b338ef2015-05-05 23:56:04 +0200971 if (dev->speed == USB_SPEED_LOW) {
972 dev->descriptor.bMaxPacketSize0 = 8;
973 dev->maxpacketsize = PACKET_SIZE_8;
974 } else {
975 dev->descriptor.bMaxPacketSize0 = 64;
976 dev->maxpacketsize = PACKET_SIZE_64;
977 }
978 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
979 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
Remy Bohmer48867202008-10-10 10:23:21 +0200980
Simon Glass128fcac2015-03-25 12:22:05 -0600981 if (do_read) {
982 int err;
Simon Glass862e75c2015-03-25 12:22:04 -0600983
Simon Glass128fcac2015-03-25 12:22:05 -0600984 /*
985 * Validate we've received only at least 8 bytes, not that we've
986 * received the entire descriptor. The reasoning is:
987 * - The code only uses fields in the first 8 bytes, so that's all we
988 * need to have fetched at this stage.
989 * - The smallest maxpacket size is 8 bytes. Before we know the actual
990 * maxpacket the device uses, the USB controller may only accept a
991 * single packet. Consequently we are only guaranteed to receive 1
992 * packet (at least 8 bytes) even in a non-error case.
993 *
994 * At least the DWC2 controller needs to be programmed with the number
995 * of packets in addition to the number of bytes. A request for 64
996 * bytes of data with the maxpacket guessed as 64 (above) yields a
997 * request for 1 packet.
998 */
Simon Glass0ed27902015-03-25 12:22:07 -0600999 err = get_descriptor_len(dev, 64, 8);
1000 if (err)
1001 return err;
Wolfgang Denk9c998aa2005-07-21 11:57:57 +02001002 }
Remy Bohmer48867202008-10-10 10:23:21 +02001003
Michael Trimarchide39f8c2008-11-26 17:41:34 +01001004 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
wdenkaffae2b2002-08-17 09:36:01 +00001005 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
1006 switch (dev->descriptor.bMaxPacketSize0) {
Michael Trimarchide39f8c2008-11-26 17:41:34 +01001007 case 8:
1008 dev->maxpacketsize = PACKET_SIZE_8;
1009 break;
1010 case 16:
1011 dev->maxpacketsize = PACKET_SIZE_16;
1012 break;
1013 case 32:
1014 dev->maxpacketsize = PACKET_SIZE_32;
1015 break;
1016 case 64:
1017 dev->maxpacketsize = PACKET_SIZE_64;
1018 break;
Paul Kocialkowski04ee6ee2015-04-04 15:12:29 +02001019 default:
1020 printf("usb_new_device: invalid max packet size\n");
1021 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001022 }
Simon Glass128fcac2015-03-25 12:22:05 -06001023
1024 return 0;
1025}
1026
Simon Glass91398f92015-03-25 12:22:06 -06001027static int usb_prepare_device(struct usb_device *dev, int addr, bool do_read,
Hans de Goede9eb72dd2015-06-17 21:33:46 +02001028 struct usb_device *parent)
Simon Glass91398f92015-03-25 12:22:06 -06001029{
1030 int err;
1031
1032 /*
1033 * Allocate usb 3.0 device context.
1034 * USB 3.0 (xHCI) protocol tries to allocate device slot
1035 * and related data structures first. This call does that.
1036 * Refer to sec 4.3.2 in xHCI spec rev1.0
1037 */
1038 err = usb_alloc_device(dev);
1039 if (err) {
1040 printf("Cannot allocate device context to get SLOT_ID\n");
1041 return err;
1042 }
1043 err = usb_setup_descriptor(dev, do_read);
1044 if (err)
1045 return err;
Hans de Goede682c9f82015-06-17 21:33:47 +02001046 err = usb_hub_port_reset(dev, parent);
Simon Glass91398f92015-03-25 12:22:06 -06001047 if (err)
1048 return err;
1049
1050 dev->devnum = addr;
1051
1052 err = usb_set_address(dev); /* set address */
1053
1054 if (err < 0) {
1055 printf("\n USB device not accepting new address " \
1056 "(error=%lX)\n", dev->status);
1057 return err;
1058 }
1059
1060 mdelay(10); /* Let the SET_ADDRESS settle */
1061
1062 return 0;
1063}
1064
Simon Glass95fbfe42015-03-25 12:22:08 -06001065int usb_select_config(struct usb_device *dev)
Simon Glass128fcac2015-03-25 12:22:05 -06001066{
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +01001067 unsigned char *tmpbuf = 0;
Simon Glass0ed27902015-03-25 12:22:07 -06001068 int err;
Simon Glass128fcac2015-03-25 12:22:05 -06001069
Simon Glass0ed27902015-03-25 12:22:07 -06001070 err = get_descriptor_len(dev, USB_DT_DEVICE_SIZE, USB_DT_DEVICE_SIZE);
1071 if (err)
1072 return err;
Simon Glass128fcac2015-03-25 12:22:05 -06001073
wdenkaffae2b2002-08-17 09:36:01 +00001074 /* correct le values */
Christian Eggersc9182612008-05-21 22:12:00 +02001075 le16_to_cpus(&dev->descriptor.bcdUSB);
1076 le16_to_cpus(&dev->descriptor.idVendor);
1077 le16_to_cpus(&dev->descriptor.idProduct);
1078 le16_to_cpus(&dev->descriptor.bcdDevice);
Simon Glass0ed27902015-03-25 12:22:07 -06001079
wdenkaffae2b2002-08-17 09:36:01 +00001080 /* only support for one config for now */
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +01001081 err = usb_get_configuration_len(dev, 0);
1082 if (err >= 0) {
1083 tmpbuf = (unsigned char *)malloc_cache_aligned(err);
1084 if (!tmpbuf)
1085 err = -ENOMEM;
1086 else
1087 err = usb_get_configuration_no(dev, 0, tmpbuf, err);
1088 }
Vincent Palatin8b8d7792012-07-24 07:12:02 +00001089 if (err < 0) {
1090 printf("usb_new_device: Cannot read configuration, " \
1091 "skipping device %04x:%04x\n",
1092 dev->descriptor.idVendor, dev->descriptor.idProduct);
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +01001093 free(tmpbuf);
Simon Glass0ed27902015-03-25 12:22:07 -06001094 return err;
Vincent Palatin8b8d7792012-07-24 07:12:02 +00001095 }
Puneet Saxenaf5766132012-04-03 14:56:06 +05301096 usb_parse_config(dev, tmpbuf, 0);
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +01001097 free(tmpbuf);
wdenkaffae2b2002-08-17 09:36:01 +00001098 usb_set_maxpacket(dev);
Simon Glass0ed27902015-03-25 12:22:07 -06001099 /*
1100 * we set the default configuration here
1101 * This seems premature. If the driver wants a different configuration
1102 * it will need to select itself.
1103 */
1104 err = usb_set_configuration(dev, dev->config.desc.bConfigurationValue);
1105 if (err < 0) {
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001106 printf("failed to set default configuration " \
1107 "len %d, status %lX\n", dev->act_len, dev->status);
Simon Glass0ed27902015-03-25 12:22:07 -06001108 return err;
wdenkaffae2b2002-08-17 09:36:01 +00001109 }
Vivek Gautamceb49722013-04-12 16:34:33 +05301110 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1111 dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1112 dev->descriptor.iSerialNumber);
wdenkaffae2b2002-08-17 09:36:01 +00001113 memset(dev->mf, 0, sizeof(dev->mf));
1114 memset(dev->prod, 0, sizeof(dev->prod));
1115 memset(dev->serial, 0, sizeof(dev->serial));
1116 if (dev->descriptor.iManufacturer)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001117 usb_string(dev, dev->descriptor.iManufacturer,
1118 dev->mf, sizeof(dev->mf));
wdenkaffae2b2002-08-17 09:36:01 +00001119 if (dev->descriptor.iProduct)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001120 usb_string(dev, dev->descriptor.iProduct,
1121 dev->prod, sizeof(dev->prod));
wdenkaffae2b2002-08-17 09:36:01 +00001122 if (dev->descriptor.iSerialNumber)
Remy Bohmer6f5794a2008-09-16 14:55:43 +02001123 usb_string(dev, dev->descriptor.iSerialNumber,
1124 dev->serial, sizeof(dev->serial));
Vivek Gautamceb49722013-04-12 16:34:33 +05301125 debug("Manufacturer %s\n", dev->mf);
1126 debug("Product %s\n", dev->prod);
1127 debug("SerialNumber %s\n", dev->serial);
Simon Glass0ed27902015-03-25 12:22:07 -06001128
1129 return 0;
1130}
1131
Simon Glass95fbfe42015-03-25 12:22:08 -06001132int usb_setup_device(struct usb_device *dev, bool do_read,
Hans de Goede9eb72dd2015-06-17 21:33:46 +02001133 struct usb_device *parent)
Simon Glass0ed27902015-03-25 12:22:07 -06001134{
1135 int addr;
1136 int ret;
1137
1138 /* We still haven't set the Address yet */
1139 addr = dev->devnum;
1140 dev->devnum = 0;
1141
Hans de Goede9eb72dd2015-06-17 21:33:46 +02001142 ret = usb_prepare_device(dev, addr, do_read, parent);
Simon Glass0ed27902015-03-25 12:22:07 -06001143 if (ret)
1144 return ret;
1145 ret = usb_select_config(dev);
1146
1147 return ret;
1148}
1149
Simon Glass95fbfe42015-03-25 12:22:08 -06001150#ifndef CONFIG_DM_USB
Simon Glass0ed27902015-03-25 12:22:07 -06001151/*
1152 * By the time we get here, the device has gotten a new device ID
1153 * and is in the default state. We need to identify the thing and
1154 * get the ball rolling..
1155 *
1156 * Returns 0 for success, != 0 for error.
1157 */
1158int usb_new_device(struct usb_device *dev)
1159{
1160 bool do_read = true;
1161 int err;
1162
1163 /*
1164 * XHCI needs to issue a Address device command to setup
1165 * proper device context structures, before it can interact
1166 * with the device. So a get_descriptor will fail before any
1167 * of that is done for XHCI unlike EHCI.
1168 */
1169#ifdef CONFIG_USB_XHCI
1170 do_read = false;
1171#endif
Hans de Goede9eb72dd2015-06-17 21:33:46 +02001172 err = usb_setup_device(dev, do_read, dev->parent);
Simon Glass0ed27902015-03-25 12:22:07 -06001173 if (err)
1174 return err;
1175
1176 /* Now probe if the device is a hub */
1177 err = usb_hub_probe(dev, 0);
1178 if (err < 0)
1179 return err;
1180
wdenkaffae2b2002-08-17 09:36:01 +00001181 return 0;
1182}
Simon Glass95fbfe42015-03-25 12:22:08 -06001183#endif
wdenkaffae2b2002-08-17 09:36:01 +00001184
Mateusz Zalega16297cf2013-10-04 19:22:26 +02001185__weak
Troy Kiskybba67912013-10-10 15:27:55 -07001186int board_usb_init(int index, enum usb_init_type init)
Mateusz Zalega16297cf2013-10-04 19:22:26 +02001187{
1188 return 0;
1189}
Kishon Vijay Abraham Idb378d72015-02-23 18:40:18 +05301190
1191__weak
1192int board_usb_cleanup(int index, enum usb_init_type init)
1193{
1194 return 0;
1195}
Simon Glass95fbfe42015-03-25 12:22:08 -06001196
1197bool usb_device_has_child_on_port(struct usb_device *parent, int port)
1198{
1199#ifdef CONFIG_DM_USB
1200 return false;
1201#else
1202 return parent->children[port] != NULL;
1203#endif
1204}
1205
Stefan BrĂ¼nsfaa7db22015-12-22 01:21:03 +01001206#ifdef CONFIG_DM_USB
1207void usb_find_usb2_hub_address_port(struct usb_device *udev,
1208 uint8_t *hub_address, uint8_t *hub_port)
1209{
1210 struct udevice *parent;
1211 struct usb_device *uparent, *ttdev;
1212
1213 /*
1214 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1215 * to the parent udevice, not the actual udevice belonging to the
1216 * udev as the device is not instantiated yet. So when searching
1217 * for the first usb-2 parent start with udev->dev not
1218 * udev->dev->parent .
1219 */
1220 ttdev = udev;
1221 parent = udev->dev;
1222 uparent = dev_get_parent_priv(parent);
1223
1224 while (uparent->speed != USB_SPEED_HIGH) {
1225 struct udevice *dev = parent;
1226
1227 if (device_get_uclass_id(dev->parent) != UCLASS_USB_HUB) {
1228 printf("Error: Cannot find high speed parent of usb-1 device\n");
1229 *hub_address = 0;
1230 *hub_port = 0;
1231 return;
1232 }
1233
1234 ttdev = dev_get_parent_priv(dev);
1235 parent = dev->parent;
1236 uparent = dev_get_parent_priv(parent);
1237 }
1238 *hub_address = uparent->devnum;
1239 *hub_port = ttdev->portnr;
1240}
1241#else
1242void usb_find_usb2_hub_address_port(struct usb_device *udev,
1243 uint8_t *hub_address, uint8_t *hub_port)
1244{
1245 /* Find out the nearest parent which is high speed */
1246 while (udev->parent->parent != NULL)
1247 if (udev->parent->speed != USB_SPEED_HIGH) {
1248 udev = udev->parent;
1249 } else {
1250 *hub_address = udev->parent->devnum;
1251 *hub_port = udev->portnr;
1252 return;
1253 }
1254
1255 printf("Error: Cannot find high speed parent of usb-1 device\n");
1256 *hub_address = 0;
1257 *hub_port = 0;
1258}
1259#endif
1260
1261
wdenkaffae2b2002-08-17 09:36:01 +00001262/* EOF */