blob: 99e6b857c74ce281431995f2fd41a4328ed9e6b4 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +00002/*
wdenkaffae2b2002-08-17 09:36:01 +00003 * Most of this source has been derived from the Linux USB
Wolfgang Denk6a3d6b02005-08-04 01:14:12 +02004 * project:
5 * (C) Copyright Linus Torvalds 1999
6 * (C) Copyright Johannes Erdfelt 1999-2001
7 * (C) Copyright Andreas Gal 1999
8 * (C) Copyright Gregory P. Smith 1999
9 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
10 * (C) Copyright Randy Dunlap 2000
11 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
12 * (C) Copyright Yggdrasil Computing, Inc. 2000
13 * (usb_device_id matching changes by Adam J. Richter)
14 *
15 * Adapted for U-Boot:
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
wdenkaffae2b2002-08-17 09:36:01 +000017 */
18
wdenkaffae2b2002-08-17 09:36:01 +000019/*
20 * How it works:
21 *
22 * Since this is a bootloader, the devices will not be automatic
23 * (re)configured on hotplug, but after a restart of the USB the
24 * device should work.
25 *
26 * For each transfer (except "Interrupt") we wait for completion.
27 */
Tom Riniabb9a042024-05-18 20:20:43 -060028#include <common.h>
wdenkaffae2b2002-08-17 09:36:01 +000029#include <command.h>
Simon Glass2674e262015-03-25 12:22:08 -060030#include <dm.h>
Janne Grunau176e8f02024-04-04 08:25:52 +020031#include <dm/device_compat.h>
Simon Glass0f2af882020-05-10 11:40:05 -060032#include <log.h>
Simon Glass9bc15642020-02-03 07:36:16 -070033#include <malloc.h>
Simon Glass2dd337a2015-09-02 17:24:58 -060034#include <memalign.h>
wdenkaffae2b2002-08-17 09:36:01 +000035#include <asm/processor.h>
Mike Frysinger6d311142012-04-04 18:44:53 +000036#include <linux/compiler.h>
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +020037#include <linux/ctype.h>
Christian Eggers4e0e8d02008-05-21 22:12:00 +020038#include <asm/byteorder.h>
Tom Rini73424522011-12-15 08:40:51 -070039#include <asm/unaligned.h>
Marek Vasut149471b2014-08-01 03:09:53 +020040#include <errno.h>
wdenkaffae2b2002-08-17 09:36:01 +000041#include <usb.h>
Simon Glassdbd79542020-05-10 11:40:11 -060042#include <linux/delay.h>
wdenkaffae2b2002-08-17 09:36:01 +000043
wdenkf70cbb22004-02-23 20:48:38 +000044#define USB_BUFSIZ 512
45
wdenkaffae2b2002-08-17 09:36:01 +000046static int asynch_allowed;
Simon Glass2510aab2023-05-05 20:03:03 -060047bool usb_started; /* flag for the started/stopped USB status */
Bartlomiej Siekae39589f2006-08-03 23:20:13 +020048
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +010049#if !CONFIG_IS_ENABLED(DM_USB)
Simon Glass2674e262015-03-25 12:22:08 -060050static struct usb_device usb_dev[USB_MAX_DEVICE];
51static int dev_index;
52
wdenkaffae2b2002-08-17 09:36:01 +000053/***************************************************************************
54 * Init USB Device
55 */
wdenkaffae2b2002-08-17 09:36:01 +000056int usb_init(void)
57{
Lucas Stache6d33452012-09-26 00:14:36 +020058 void *ctrl;
59 struct usb_device *dev;
60 int i, start_index = 0;
Hans de Goedec601ed72015-01-11 20:34:46 +010061 int controllers_initialized = 0;
Marek Vasut149471b2014-08-01 03:09:53 +020062 int ret;
wdenkaffae2b2002-08-17 09:36:01 +000063
Remy Bohmer172a1132008-09-16 14:55:43 +020064 dev_index = 0;
65 asynch_allowed = 1;
wdenkaffae2b2002-08-17 09:36:01 +000066 usb_hub_reset();
Lucas Stache6d33452012-09-26 00:14:36 +020067
68 /* first make all devices unknown */
69 for (i = 0; i < USB_MAX_DEVICE; i++) {
70 memset(&usb_dev[i], 0, sizeof(struct usb_device));
71 usb_dev[i].devnum = -1;
72 }
73
wdenkaffae2b2002-08-17 09:36:01 +000074 /* init low_level USB */
Lucas Stache6d33452012-09-26 00:14:36 +020075 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
76 /* init low_level USB */
77 printf("USB%d: ", i);
Marek Vasut149471b2014-08-01 03:09:53 +020078 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
79 if (ret == -ENODEV) { /* No such device. */
80 puts("Port not available.\n");
Hans de Goedec601ed72015-01-11 20:34:46 +010081 controllers_initialized++;
Marek Vasut149471b2014-08-01 03:09:53 +020082 continue;
83 }
84
85 if (ret) { /* Other error. */
Lucas Stache6d33452012-09-26 00:14:36 +020086 puts("lowlevel init failed\n");
87 continue;
88 }
89 /*
90 * lowlevel init is OK, now scan the bus for devices
91 * i.e. search HUBs and configure them
92 */
Hans de Goedec601ed72015-01-11 20:34:46 +010093 controllers_initialized++;
Lucas Stache6d33452012-09-26 00:14:36 +020094 start_index = dev_index;
95 printf("scanning bus %d for devices... ", i);
Simon Glassd1461132015-03-25 12:22:01 -060096 ret = usb_alloc_new_device(ctrl, &dev);
97 if (ret)
Paul Kocialkowski8f8114d2015-04-04 15:12:28 +020098 break;
99
Lucas Stache6d33452012-09-26 00:14:36 +0200100 /*
101 * device 0 is always present
102 * (root hub, so let it analyze)
103 */
Paul Kocialkowski8f8114d2015-04-04 15:12:28 +0200104 ret = usb_new_device(dev);
105 if (ret)
Simon Glassd1461132015-03-25 12:22:01 -0600106 usb_free_device(dev->controller);
Lucas Stache6d33452012-09-26 00:14:36 +0200107
Paul Kocialkowski8f8114d2015-04-04 15:12:28 +0200108 if (start_index == dev_index) {
Lucas Stache6d33452012-09-26 00:14:36 +0200109 puts("No USB Device found\n");
Paul Kocialkowski8f8114d2015-04-04 15:12:28 +0200110 continue;
111 } else {
Lucas Stache6d33452012-09-26 00:14:36 +0200112 printf("%d USB Device(s) found\n",
113 dev_index - start_index);
Paul Kocialkowski8f8114d2015-04-04 15:12:28 +0200114 }
Lucas Stache6d33452012-09-26 00:14:36 +0200115
Bartlomiej Siekae39589f2006-08-03 23:20:13 +0200116 usb_started = 1;
Lucas Stache6d33452012-09-26 00:14:36 +0200117 }
118
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530119 debug("scan end\n");
Lucas Stache6d33452012-09-26 00:14:36 +0200120 /* if we were not able to find at least one working bus, bail out */
Hans de Goedec601ed72015-01-11 20:34:46 +0100121 if (controllers_initialized == 0)
Lucas Stache6d33452012-09-26 00:14:36 +0200122 puts("USB error: all controllers failed lowlevel init\n");
Lucas Stache6d33452012-09-26 00:14:36 +0200123
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200124 return usb_started ? 0 : -ENODEV;
wdenkaffae2b2002-08-17 09:36:01 +0000125}
126
127/******************************************************************************
128 * Stop USB this stops the LowLevel Part and deregisters USB devices.
129 */
130int usb_stop(void)
131{
Lucas Stache6d33452012-09-26 00:14:36 +0200132 int i;
Remy Bohmer743dd492008-08-20 11:22:02 +0200133
134 if (usb_started) {
135 asynch_allowed = 1;
136 usb_started = 0;
137 usb_hub_reset();
Lucas Stache6d33452012-09-26 00:14:36 +0200138
139 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
140 if (usb_lowlevel_stop(i))
141 printf("failed to stop USB controller %d\n", i);
142 }
Remy Bohmer743dd492008-08-20 11:22:02 +0200143 }
Lucas Stache6d33452012-09-26 00:14:36 +0200144
145 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000146}
147
Vincent Palatin0489ee32015-05-04 11:30:54 -0600148/******************************************************************************
149 * Detect if a USB device has been plugged or unplugged.
150 */
151int usb_detect_change(void)
152{
153 int i, j;
154 int change = 0;
155
156 for (j = 0; j < USB_MAX_DEVICE; j++) {
157 for (i = 0; i < usb_dev[j].maxchild; i++) {
158 struct usb_port_status status;
159
160 if (usb_get_port_status(&usb_dev[j], i + 1,
161 &status) < 0)
162 /* USB request failed */
163 continue;
164
165 if (le16_to_cpu(status.wPortChange) &
166 USB_PORT_STAT_C_CONNECTION)
167 change++;
168 }
169 }
170
171 return change;
172}
173
Marek Vasut118a9032020-04-06 14:29:44 +0200174/* Lock or unlock async schedule on the controller */
175__weak int usb_lock_async(struct usb_device *dev, int lock)
176{
177 return 0;
178}
179
wdenkaffae2b2002-08-17 09:36:01 +0000180/*
181 * disables the asynch behaviour of the control message. This is used for data
182 * transfers that uses the exclusiv access to the control and bulk messages.
Simon Glass1e9961d2011-02-16 11:14:33 -0800183 * Returns the old value so it can be restored later.
wdenkaffae2b2002-08-17 09:36:01 +0000184 */
Simon Glass1e9961d2011-02-16 11:14:33 -0800185int usb_disable_asynch(int disable)
wdenkaffae2b2002-08-17 09:36:01 +0000186{
Simon Glass1e9961d2011-02-16 11:14:33 -0800187 int old_value = asynch_allowed;
188
Remy Bohmer172a1132008-09-16 14:55:43 +0200189 asynch_allowed = !disable;
Simon Glass1e9961d2011-02-16 11:14:33 -0800190 return old_value;
wdenkaffae2b2002-08-17 09:36:01 +0000191}
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100192#endif /* !CONFIG_IS_ENABLED(DM_USB) */
wdenkaffae2b2002-08-17 09:36:01 +0000193
194
195/*-------------------------------------------------------------------
196 * Message wrappers.
197 *
198 */
199
200/*
Michal Suchanek1c95b9f2019-08-18 10:55:27 +0200201 * submits an Interrupt Message. Some drivers may implement non-blocking
202 * polling: when non-block is true and the device is not responding return
203 * -EAGAIN instead of waiting for device to respond.
wdenkaffae2b2002-08-17 09:36:01 +0000204 */
Michal Suchanekf5d5af42019-08-18 10:55:25 +0200205int usb_int_msg(struct usb_device *dev, unsigned long pipe,
Michal Suchanek1c95b9f2019-08-18 10:55:27 +0200206 void *buffer, int transfer_len, int interval, bool nonblock)
wdenkaffae2b2002-08-17 09:36:01 +0000207{
Michal Suchanek1c95b9f2019-08-18 10:55:27 +0200208 return submit_int_msg(dev, pipe, buffer, transfer_len, interval,
209 nonblock);
wdenkaffae2b2002-08-17 09:36:01 +0000210}
211
212/*
213 * submits a control message and waits for comletion (at least timeout * 1ms)
214 * If timeout is 0, we don't wait for completion (used as example to set and
215 * clear keyboards LEDs). For data transfers, (storage transfers) we don't
216 * allow control messages with 0 timeout, by previousely resetting the flag
217 * asynch_allowed (usb_disable_asynch(1)).
Vagrant Cascadian53d41e62016-03-15 12:16:39 -0700218 * returns the transferred length if OK or -1 if error. The transferred length
wdenkaffae2b2002-08-17 09:36:01 +0000219 * and the current status are stored in the dev->act_len and dev->status.
220 */
221int usb_control_msg(struct usb_device *dev, unsigned int pipe,
222 unsigned char request, unsigned char requesttype,
223 unsigned short value, unsigned short index,
224 void *data, unsigned short size, int timeout)
225{
Puneet Saxena6c9bb602012-04-03 14:56:06 +0530226 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1);
Hans de Goedee82cd9f2015-05-10 14:10:14 +0200227 int err;
Marek Vasutf16090f2012-02-13 18:58:18 +0000228
Remy Bohmer172a1132008-09-16 14:55:43 +0200229 if ((timeout == 0) && (!asynch_allowed)) {
230 /* request for a asynch control pipe is not allowed */
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200231 return -EINVAL;
Remy Bohmer172a1132008-09-16 14:55:43 +0200232 }
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200233
wdenkaffae2b2002-08-17 09:36:01 +0000234 /* set setup command */
Puneet Saxena6c9bb602012-04-03 14:56:06 +0530235 setup_packet->requesttype = requesttype;
236 setup_packet->request = request;
237 setup_packet->value = cpu_to_le16(value);
238 setup_packet->index = cpu_to_le16(index);
239 setup_packet->length = cpu_to_le16(size);
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530240 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
241 "value 0x%X index 0x%X length 0x%X\n",
242 request, requesttype, value, index, size);
Remy Bohmer172a1132008-09-16 14:55:43 +0200243 dev->status = USB_ST_NOT_PROC; /*not yet processed */
wdenkaffae2b2002-08-17 09:36:01 +0000244
Hans de Goedee82cd9f2015-05-10 14:10:14 +0200245 err = submit_control_msg(dev, pipe, data, size, setup_packet);
246 if (err < 0)
247 return err;
Remy Bohmer172a1132008-09-16 14:55:43 +0200248 if (timeout == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000249 return (int)size;
Remy Bohmer172a1132008-09-16 14:55:43 +0200250
Remy Bohmer93cf0932010-02-01 19:40:47 +0100251 /*
252 * Wait for status to update until timeout expires, USB driver
253 * interrupt handler may set the status when the USB operation has
254 * been completed.
255 */
256 while (timeout--) {
257 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
258 break;
Mike Frysinger60ce19a2012-03-05 13:47:00 +0000259 mdelay(1);
Remy Bohmer47e72082008-10-10 10:23:21 +0200260 }
Remy Bohmer93cf0932010-02-01 19:40:47 +0100261 if (dev->status)
262 return -1;
Remy Bohmer47e72082008-10-10 10:23:21 +0200263
264 return dev->act_len;
Remy Bohmer93cf0932010-02-01 19:40:47 +0100265
wdenkaffae2b2002-08-17 09:36:01 +0000266}
267
268/*-------------------------------------------------------------------
269 * submits bulk message, and waits for completion. returns 0 if Ok or
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200270 * negative if Error.
wdenkaffae2b2002-08-17 09:36:01 +0000271 * synchronous behavior
272 */
273int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
274 void *data, int len, int *actual_length, int timeout)
275{
276 if (len < 0)
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200277 return -EINVAL;
Remy Bohmer172a1132008-09-16 14:55:43 +0200278 dev->status = USB_ST_NOT_PROC; /*not yet processed */
Ilya Yanokb7161dd2012-07-15 04:43:51 +0000279 if (submit_bulk_msg(dev, pipe, data, len) < 0)
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200280 return -EIO;
Remy Bohmer172a1132008-09-16 14:55:43 +0200281 while (timeout--) {
282 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
wdenkaffae2b2002-08-17 09:36:01 +0000283 break;
Mike Frysinger60ce19a2012-03-05 13:47:00 +0000284 mdelay(1);
wdenkaffae2b2002-08-17 09:36:01 +0000285 }
Remy Bohmer172a1132008-09-16 14:55:43 +0200286 *actual_length = dev->act_len;
287 if (dev->status == 0)
wdenkaffae2b2002-08-17 09:36:01 +0000288 return 0;
289 else
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200290 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000291}
292
293
294/*-------------------------------------------------------------------
295 * Max Packet stuff
296 */
297
298/*
299 * returns the max packet size, depending on the pipe direction and
300 * the configurations values
301 */
Remy Bohmer172a1132008-09-16 14:55:43 +0200302int usb_maxpacket(struct usb_device *dev, unsigned long pipe)
wdenkaffae2b2002-08-17 09:36:01 +0000303{
Remy Bohmer172a1132008-09-16 14:55:43 +0200304 /* direction is out -> use emaxpacket out */
305 if ((pipe & USB_DIR_IN) == 0)
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100306 return dev->epmaxpacketout[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000307 else
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100308 return dev->epmaxpacketin[((pipe>>15) & 0xf)];
wdenkaffae2b2002-08-17 09:36:01 +0000309}
310
Marek Vasutd38ad252011-11-05 23:35:12 +0100311/*
312 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine
Remy Bohmercb2df642008-09-16 14:55:42 +0200313 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine
314 * when it is inlined in 1 single routine. What happens is that the register r3
315 * is used as loop-count 'i', but gets overwritten later on.
316 * This is clearly a compiler bug, but it is easier to workaround it here than
317 * to update the compiler (Occurs with at least several GCC 4.{1,2},x
318 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM)
Marek Vasutd38ad252011-11-05 23:35:12 +0100319 *
320 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5.
Remy Bohmercb2df642008-09-16 14:55:42 +0200321 */
Mike Frysinger6d311142012-04-04 18:44:53 +0000322static void noinline
Marek Vasutd38ad252011-11-05 23:35:12 +0100323usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
Remy Bohmercb2df642008-09-16 14:55:42 +0200324{
325 int b;
Marek Vasutd38ad252011-11-05 23:35:12 +0100326 struct usb_endpoint_descriptor *ep;
Tom Rini73424522011-12-15 08:40:51 -0700327 u16 ep_wMaxPacketSize;
Marek Vasutd38ad252011-11-05 23:35:12 +0100328
329 ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx];
Remy Bohmercb2df642008-09-16 14:55:42 +0200330
331 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
Tom Rini73424522011-12-15 08:40:51 -0700332 ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize);
Remy Bohmercb2df642008-09-16 14:55:42 +0200333
334 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
335 USB_ENDPOINT_XFER_CONTROL) {
336 /* Control => bidirectional */
Tom Rini73424522011-12-15 08:40:51 -0700337 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
338 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530339 debug("##Control EP epmaxpacketout/in[%d] = %d\n",
340 b, dev->epmaxpacketin[b]);
Remy Bohmercb2df642008-09-16 14:55:42 +0200341 } else {
342 if ((ep->bEndpointAddress & 0x80) == 0) {
343 /* OUT Endpoint */
Tom Rini73424522011-12-15 08:40:51 -0700344 if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) {
345 dev->epmaxpacketout[b] = ep_wMaxPacketSize;
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530346 debug("##EP epmaxpacketout[%d] = %d\n",
347 b, dev->epmaxpacketout[b]);
Remy Bohmercb2df642008-09-16 14:55:42 +0200348 }
349 } else {
350 /* IN Endpoint */
Tom Rini73424522011-12-15 08:40:51 -0700351 if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) {
352 dev->epmaxpacketin[b] = ep_wMaxPacketSize;
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530353 debug("##EP epmaxpacketin[%d] = %d\n",
354 b, dev->epmaxpacketin[b]);
Remy Bohmercb2df642008-09-16 14:55:42 +0200355 }
356 } /* if out */
357 } /* if control */
358}
359
wdenkaffae2b2002-08-17 09:36:01 +0000360/*
361 * set the max packed value of all endpoints in the given configuration
362 */
Marek Vasut3a16a6a2012-02-13 18:58:16 +0000363static int usb_set_maxpacket(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000364{
Remy Bohmercb2df642008-09-16 14:55:42 +0200365 int i, ii;
wdenkaffae2b2002-08-17 09:36:01 +0000366
Tom Rix83b9e1d2009-10-31 12:37:38 -0500367 for (i = 0; i < dev->config.desc.bNumInterfaces; i++)
368 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++)
Marek Vasutd38ad252011-11-05 23:35:12 +0100369 usb_set_maxpacket_ep(dev, i, ii);
wdenkaffae2b2002-08-17 09:36:01 +0000370
wdenkaffae2b2002-08-17 09:36:01 +0000371 return 0;
372}
373
374/*******************************************************************************
375 * Parse the config, located in buffer, and fills the dev->config structure.
376 * Note that all little/big endian swapping are done automatically.
Julius Wernerfc4ec492013-07-19 13:12:08 -0700377 * (wTotalLength has already been swapped and sanitized when it was read.)
wdenkaffae2b2002-08-17 09:36:01 +0000378 */
Marek Vasut3a16a6a2012-02-13 18:58:16 +0000379static int usb_parse_config(struct usb_device *dev,
380 unsigned char *buffer, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000381{
382 struct usb_descriptor_header *head;
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200383 int index, ifno, epno, curr_if_num;
Tom Rini73424522011-12-15 08:40:51 -0700384 u16 ep_wMaxPacketSize;
Vivek Gautam23cbd292013-04-12 16:34:34 +0530385 struct usb_interface *if_desc = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000386
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200387 ifno = -1;
388 epno = -1;
389 curr_if_num = -1;
390
391 dev->configno = cfgno;
392 head = (struct usb_descriptor_header *) &buffer[0];
Remy Bohmer172a1132008-09-16 14:55:43 +0200393 if (head->bDescriptorType != USB_DT_CONFIG) {
394 printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
395 head->bDescriptorType);
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200396 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000397 }
Julius Wernerfc4ec492013-07-19 13:12:08 -0700398 if (head->bLength != USB_DT_CONFIG_SIZE) {
399 printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200400 return -EINVAL;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700401 }
402 memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200403 dev->config.no_of_if = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000404
Tom Rix83b9e1d2009-10-31 12:37:38 -0500405 index = dev->config.desc.bLength;
Remy Bohmer172a1132008-09-16 14:55:43 +0200406 /* Ok the first entry must be a configuration entry,
407 * now process the others */
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200408 head = (struct usb_descriptor_header *) &buffer[index];
Julius Wernerfc4ec492013-07-19 13:12:08 -0700409 while (index + 1 < dev->config.desc.wTotalLength && head->bLength) {
Remy Bohmer172a1132008-09-16 14:55:43 +0200410 switch (head->bDescriptorType) {
411 case USB_DT_INTERFACE:
Julius Wernerfc4ec492013-07-19 13:12:08 -0700412 if (head->bLength != USB_DT_INTERFACE_SIZE) {
413 printf("ERROR: Invalid USB IF length (%d)\n",
414 head->bLength);
415 break;
416 }
417 if (index + USB_DT_INTERFACE_SIZE >
418 dev->config.desc.wTotalLength) {
419 puts("USB IF descriptor overflowed buffer!\n");
420 break;
421 }
Remy Bohmer172a1132008-09-16 14:55:43 +0200422 if (((struct usb_interface_descriptor *) \
Julius Wernerfc4ec492013-07-19 13:12:08 -0700423 head)->bInterfaceNumber != curr_if_num) {
Remy Bohmer172a1132008-09-16 14:55:43 +0200424 /* this is a new interface, copy new desc */
425 ifno = dev->config.no_of_if;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700426 if (ifno >= USB_MAXINTERFACES) {
427 puts("Too many USB interfaces!\n");
428 /* try to go on with what we have */
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200429 return -EINVAL;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700430 }
Vivek Gautam23cbd292013-04-12 16:34:34 +0530431 if_desc = &dev->config.if_desc[ifno];
Remy Bohmer172a1132008-09-16 14:55:43 +0200432 dev->config.no_of_if++;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700433 memcpy(if_desc, head,
434 USB_DT_INTERFACE_SIZE);
Vivek Gautam23cbd292013-04-12 16:34:34 +0530435 if_desc->no_of_ep = 0;
436 if_desc->num_altsetting = 1;
Remy Bohmer172a1132008-09-16 14:55:43 +0200437 curr_if_num =
Vivek Gautam23cbd292013-04-12 16:34:34 +0530438 if_desc->desc.bInterfaceNumber;
Remy Bohmer172a1132008-09-16 14:55:43 +0200439 } else {
440 /* found alternate setting for the interface */
Vivek Gautam23cbd292013-04-12 16:34:34 +0530441 if (ifno >= 0) {
442 if_desc = &dev->config.if_desc[ifno];
443 if_desc->num_altsetting++;
444 }
Remy Bohmer172a1132008-09-16 14:55:43 +0200445 }
446 break;
447 case USB_DT_ENDPOINT:
Bin Meng94e0e752017-09-18 06:40:40 -0700448 if (head->bLength != USB_DT_ENDPOINT_SIZE &&
449 head->bLength != USB_DT_ENDPOINT_AUDIO_SIZE) {
Julius Wernerfc4ec492013-07-19 13:12:08 -0700450 printf("ERROR: Invalid USB EP length (%d)\n",
451 head->bLength);
452 break;
453 }
Bin Meng94e0e752017-09-18 06:40:40 -0700454 if (index + head->bLength >
Julius Wernerfc4ec492013-07-19 13:12:08 -0700455 dev->config.desc.wTotalLength) {
456 puts("USB EP descriptor overflowed buffer!\n");
457 break;
458 }
459 if (ifno < 0) {
460 puts("Endpoint descriptor out of order!\n");
461 break;
462 }
Remy Bohmer172a1132008-09-16 14:55:43 +0200463 epno = dev->config.if_desc[ifno].no_of_ep;
Vivek Gautam23cbd292013-04-12 16:34:34 +0530464 if_desc = &dev->config.if_desc[ifno];
Peng Fan45f4b5c2016-01-12 15:57:01 +0800465 if (epno >= USB_MAXENDPOINTS) {
Julius Wernerfc4ec492013-07-19 13:12:08 -0700466 printf("Interface %d has too many endpoints!\n",
467 if_desc->desc.bInterfaceNumber);
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200468 return -EINVAL;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700469 }
Remy Bohmer172a1132008-09-16 14:55:43 +0200470 /* found an endpoint */
Vivek Gautam23cbd292013-04-12 16:34:34 +0530471 if_desc->no_of_ep++;
Julius Wernerfc4ec492013-07-19 13:12:08 -0700472 memcpy(&if_desc->ep_desc[epno], head,
473 USB_DT_ENDPOINT_SIZE);
Tom Rini73424522011-12-15 08:40:51 -0700474 ep_wMaxPacketSize = get_unaligned(&dev->config.\
475 if_desc[ifno].\
476 ep_desc[epno].\
477 wMaxPacketSize);
478 put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
479 &dev->config.\
480 if_desc[ifno].\
481 ep_desc[epno].\
482 wMaxPacketSize);
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530483 debug("if %d, ep %d\n", ifno, epno);
Remy Bohmer172a1132008-09-16 14:55:43 +0200484 break;
Vivek Gautamdf3f2212013-04-12 16:34:38 +0530485 case USB_DT_SS_ENDPOINT_COMP:
Julius Wernerfc4ec492013-07-19 13:12:08 -0700486 if (head->bLength != USB_DT_SS_EP_COMP_SIZE) {
487 printf("ERROR: Invalid USB EPC length (%d)\n",
488 head->bLength);
489 break;
490 }
491 if (index + USB_DT_SS_EP_COMP_SIZE >
492 dev->config.desc.wTotalLength) {
493 puts("USB EPC descriptor overflowed buffer!\n");
494 break;
495 }
496 if (ifno < 0 || epno < 0) {
497 puts("EPC descriptor out of order!\n");
498 break;
499 }
Vivek Gautamdf3f2212013-04-12 16:34:38 +0530500 if_desc = &dev->config.if_desc[ifno];
Julius Wernerfc4ec492013-07-19 13:12:08 -0700501 memcpy(&if_desc->ss_ep_comp_desc[epno], head,
502 USB_DT_SS_EP_COMP_SIZE);
Vivek Gautamdf3f2212013-04-12 16:34:38 +0530503 break;
Remy Bohmer172a1132008-09-16 14:55:43 +0200504 default:
505 if (head->bLength == 0)
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200506 return -EINVAL;
Remy Bohmer172a1132008-09-16 14:55:43 +0200507
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530508 debug("unknown Description Type : %x\n",
509 head->bDescriptorType);
Remy Bohmer172a1132008-09-16 14:55:43 +0200510
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530511#ifdef DEBUG
Remy Bohmer172a1132008-09-16 14:55:43 +0200512 {
Wolfgang Denk24103482011-10-05 23:11:19 +0200513 unsigned char *ch = (unsigned char *)head;
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530514 int i;
515
Remy Bohmer172a1132008-09-16 14:55:43 +0200516 for (i = 0; i < head->bLength; i++)
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530517 debug("%02X ", *ch++);
518 debug("\n\n\n");
Remy Bohmer172a1132008-09-16 14:55:43 +0200519 }
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530520#endif
Remy Bohmer172a1132008-09-16 14:55:43 +0200521 break;
wdenkaffae2b2002-08-17 09:36:01 +0000522 }
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200523 index += head->bLength;
524 head = (struct usb_descriptor_header *)&buffer[index];
wdenkaffae2b2002-08-17 09:36:01 +0000525 }
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200526 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000527}
528
529/***********************************************************************
530 * Clears an endpoint
531 * endp: endpoint number in bits 0-3;
532 * direction flag in bit 7 (1 = IN, 0 = OUT)
533 */
534int usb_clear_halt(struct usb_device *dev, int pipe)
535{
536 int result;
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200537 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
wdenkaffae2b2002-08-17 09:36:01 +0000538
539 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Remy Bohmer172a1132008-09-16 14:55:43 +0200540 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
541 endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
wdenkaffae2b2002-08-17 09:36:01 +0000542
543 /* don't clear if failed */
544 if (result < 0)
545 return result;
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200546
Wolfgang Denkd06ce5d2005-08-02 17:06:17 +0200547 /*
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200548 * NOTE: we do not get status and verify reset was successful
549 * as some devices are reported to lock up upon this check..
550 */
551
wdenkaffae2b2002-08-17 09:36:01 +0000552 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200553
wdenkaffae2b2002-08-17 09:36:01 +0000554 /* toggle is reset on clear */
555 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
556 return 0;
557}
558
559
560/**********************************************************************
561 * get_descriptor type
562 */
Marek Vasut3a16a6a2012-02-13 18:58:16 +0000563static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
Remy Bohmer172a1132008-09-16 14:55:43 +0200564 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000565{
Masahiro Yamada9b70df52016-09-06 22:17:35 +0900566 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
567 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
568 (type << 8) + index, 0, buf, size,
569 USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000570}
571
572/**********************************************************************
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100573 * gets len of configuration cfgno
wdenkaffae2b2002-08-17 09:36:01 +0000574 */
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100575int usb_get_configuration_len(struct usb_device *dev, int cfgno)
wdenkaffae2b2002-08-17 09:36:01 +0000576{
Wolfgang Denka1be4762008-05-20 16:00:29 +0200577 int result;
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100578 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, 9);
Ilya Yanoka1cf10f2012-11-06 13:48:20 +0000579 struct usb_config_descriptor *config;
wdenkaffae2b2002-08-17 09:36:01 +0000580
Ilya Yanoka1cf10f2012-11-06 13:48:20 +0000581 config = (struct usb_config_descriptor *)&buffer[0];
Remy Bohmer47e72082008-10-10 10:23:21 +0200582 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
583 if (result < 9) {
wdenkaffae2b2002-08-17 09:36:01 +0000584 if (result < 0)
Remy Bohmer172a1132008-09-16 14:55:43 +0200585 printf("unable to get descriptor, error %lX\n",
586 dev->status);
wdenkaffae2b2002-08-17 09:36:01 +0000587 else
Remy Bohmer172a1132008-09-16 14:55:43 +0200588 printf("config descriptor too short " \
Remy Bohmer47e72082008-10-10 10:23:21 +0200589 "(expected %i, got %i)\n", 9, result);
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200590 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000591 }
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100592 return le16_to_cpu(config->wTotalLength);
593}
wdenkaffae2b2002-08-17 09:36:01 +0000594
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100595/**********************************************************************
596 * gets configuration cfgno and store it in the buffer
597 */
598int usb_get_configuration_no(struct usb_device *dev, int cfgno,
599 unsigned char *buffer, int length)
600{
601 int result;
602 struct usb_config_descriptor *config;
wdenkf70cbb22004-02-23 20:48:38 +0000603
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100604 config = (struct usb_config_descriptor *)&buffer[0];
Julius Wernerfc4ec492013-07-19 13:12:08 -0700605 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +0100606 debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result,
607 le16_to_cpu(config->wTotalLength));
608 config->wTotalLength = result; /* validated, with CPU byte order */
Julius Wernerfc4ec492013-07-19 13:12:08 -0700609
wdenkaffae2b2002-08-17 09:36:01 +0000610 return result;
611}
612
613/********************************************************************
614 * set address of a device to the value in dev->devnum.
615 * This can only be done by addressing the device via the default address (0)
616 */
Marek Vasut3a16a6a2012-02-13 18:58:16 +0000617static int usb_set_address(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000618{
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530619 debug("set address %d\n", dev->devnum);
Masahiro Yamada9b70df52016-09-06 22:17:35 +0900620
621 return usb_control_msg(dev, usb_snddefctrl(dev), USB_REQ_SET_ADDRESS,
622 0, (dev->devnum), 0, NULL, 0, USB_CNTL_TIMEOUT);
wdenkaffae2b2002-08-17 09:36:01 +0000623}
624
625/********************************************************************
626 * set interface number to interface
627 */
628int usb_set_interface(struct usb_device *dev, int interface, int alternate)
629{
Tom Rix83b9e1d2009-10-31 12:37:38 -0500630 struct usb_interface *if_face = NULL;
wdenkaffae2b2002-08-17 09:36:01 +0000631 int ret, i;
632
Tom Rix83b9e1d2009-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 Kocialkowski8c261762015-04-04 15:12:27 +0200641 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000642 }
Bartlomiej Sieka978333a2006-08-02 00:54:18 +0200643 /*
644 * We should return now for devices with only one alternate setting.
Remy Bohmer172a1132008-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 Sieka978333a2006-08-02 00:54:18 +0200649 */
650 if (if_face->num_altsetting == 1)
651 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000652
Remy Bohmer172a1132008-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 Vasut3a16a6a2012-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 Gautamf94c95d2013-04-12 16:34:33 +0530669 debug("set configuration %d\n", configuration);
wdenkaffae2b2002-08-17 09:36:01 +0000670 /* set setup command */
Remy Bohmer172a1132008-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 Bohmer172a1132008-09-16 14:55:43 +0200679 } else
Paul Kocialkowski8c261762015-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 Bohmer172a1132008-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 Bohmer172a1132008-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 Vasut3a16a6a2012-02-13 18:58:16 +0000729static int usb_get_string(struct usb_device *dev, unsigned short langid,
Remy Bohmer172a1132008-09-16 14:55:43 +0200730 unsigned char index, void *buf, int size)
wdenkaffae2b2002-08-17 09:36:01 +0000731{
Wolfgang Denkc7a4f7d2005-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 Denkd06ce5d2005-08-02 17:06:17 +0200739 (USB_DT_STRING << 8) + index, langid, buf, size,
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200740 USB_CNTL_TIMEOUT);
741
742 if (result > 0)
743 break;
Wolfgang Denkd06ce5d2005-08-02 17:06:17 +0200744 }
745
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200746 return result;
wdenkaffae2b2002-08-17 09:36:01 +0000747}
748
Wolfgang Denkc7a4f7d2005-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 Kocialkowski8c261762015-04-04 15:12:27 +0200794 rc = -EINVAL;
Wolfgang Denkc7a4f7d2005-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 Saxena6c9bb602012-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 Kocialkowski8c261762015-04-04 15:12:27 +0200813 return -EINVAL;
wdenkaffae2b2002-08-17 09:36:01 +0000814 buf[0] = 0;
Wolfgang Denkdc770c72008-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 Denkc7a4f7d2005-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 Gautamf94c95d2013-04-12 16:34:33 +0530821 debug("error getting string descriptor 0 " \
822 "(error=%lx)\n", dev->status);
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200823 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000824 } else if (tbuf[0] < 4) {
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530825 debug("string descriptor 0 too short\n");
Paul Kocialkowski8c261762015-04-04 15:12:27 +0200826 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +0000827 } else {
828 dev->have_langid = -1;
Remy Bohmer172a1132008-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 Gautamf94c95d2013-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 }
wdenkf70cbb22004-02-23 20:48:38 +0000836
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200837 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
wdenkaffae2b2002-08-17 09:36:01 +0000838 if (err < 0)
839 return err;
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200840
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
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100861#if !CONFIG_IS_ENABLED(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 Bohmer172a1132008-09-16 14:55:43 +0200866struct usb_device *usb_get_dev_index(int index)
wdenkaffae2b2002-08-17 09:36:01 +0000867{
Remy Bohmer172a1132008-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 Glassd1461132015-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 Gautamf94c95d2013-04-12 16:34:33 +0530877 debug("New Device %d\n", dev_index);
Remy Bohmer172a1132008-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 Glassd1461132015-03-25 12:22:01 -0600880 return -ENOSPC;
wdenkaffae2b2002-08-17 09:36:01 +0000881 }
Remy Bohmer172a1132008-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 Stacha3231282012-09-26 00:14:34 +0200888 usb_dev[dev_index].controller = controller;
wdenkaffae2b2002-08-17 09:36:01 +0000889 dev_index++;
Simon Glassd1461132015-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 Choudharyebb24782012-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 Glassd1461132015-03-25 12:22:01 -0600900void usb_free_device(struct udevice *controller)
Milind Choudharyebb24782012-12-12 17:55:28 -0800901{
902 dev_index--;
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530903 debug("Freeing device node: %d\n", dev_index);
Milind Choudharyebb24782012-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 Gautam4912dcc2013-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}
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +0100918#endif /* !CONFIG_IS_ENABLED(DM_USB) */
Simon Glassc093d6d2015-03-25 12:22:04 -0600919
Hans de Goede25293e42015-06-17 21:33:47 +0200920static int usb_hub_port_reset(struct usb_device *dev, struct usb_device *hub)
Simon Glassc093d6d2015-03-25 12:22:04 -0600921{
Stefan Roesec41294e2016-03-15 13:59:14 +0100922 if (!hub)
Hans de Goedeb8695742015-06-17 21:33:48 +0200923 usb_reset_root_port(dev);
Simon Glassc093d6d2015-03-25 12:22:04 -0600924
925 return 0;
926}
927
Simon Glass668c53f2015-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 Glassbbca4912015-03-25 12:22:05 -0600930 __maybe_unused struct usb_device_descriptor *desc;
Puneet Saxena6c9bb602012-04-03 14:56:06 +0530931 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
Simon Glass668c53f2015-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 Gautam4912dcc2013-09-14 14:02:45 +0530955 /*
Simon Glassf4cdfeb2015-03-25 12:22:03 -0600956 * This is a Windows scheme of initialization sequence, with double
Remy Bohmer47e72082008-10-10 10:23:21 +0200957 * reset of the device (Linux uses the same sequence)
Remy Bohmeraca9b6e2008-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 Trimarchi5f2e7fc2008-11-26 17:41:34 +0100960 * http://sourceforge.net/mailarchive/forum.php?
961 * thread_id=5729457&forum_id=5398
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200962 */
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200963
Simon Glassf4cdfeb2015-03-25 12:22:03 -0600964 /*
965 * send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is
Wolfgang Denkc7a4f7d2005-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 Goede09a9ae82015-05-05 23:56:04 +0200968 * some more, or keeps on retransmitting the 8 byte header.
969 */
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +0200970
Hans de Goede09a9ae82015-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 Bohmer47e72082008-10-10 10:23:21 +0200980
Bin Mengae6d0cf2017-09-18 06:40:42 -0700981 if (do_read && dev->speed == USB_SPEED_FULL) {
Simon Glassbbca4912015-03-25 12:22:05 -0600982 int err;
Simon Glassc093d6d2015-03-25 12:22:04 -0600983
Simon Glassbbca4912015-03-25 12:22:05 -0600984 /*
Bin Mengae6d0cf2017-09-18 06:40:42 -0700985 * Validate we've received only at least 8 bytes, not that
986 * we've received the entire descriptor. The reasoning is:
987 * - The code only uses fields in the first 8 bytes, so
988 * that's all we need to have fetched at this stage.
989 * - The smallest maxpacket size is 8 bytes. Before we know
990 * the actual maxpacket the device uses, the USB controller
991 * may only accept a single packet. Consequently we are only
992 * guaranteed to receive 1 packet (at least 8 bytes) even in
993 * a non-error case.
Simon Glassbbca4912015-03-25 12:22:05 -0600994 *
Bin Mengae6d0cf2017-09-18 06:40:42 -0700995 * At least the DWC2 controller needs to be programmed with
996 * the number of packets in addition to the number of bytes.
997 * A request for 64 bytes of data with the maxpacket guessed
998 * as 64 (above) yields a request for 1 packet.
Simon Glassbbca4912015-03-25 12:22:05 -0600999 */
Simon Glass668c53f2015-03-25 12:22:07 -06001000 err = get_descriptor_len(dev, 64, 8);
1001 if (err)
1002 return err;
Marek Vasut2a45fd92022-10-30 23:38:35 +01001003
1004 /*
1005 * Logitech Unifying Receiver 046d:c52b bcdDevice 12.10 seems
1006 * sensitive about the first Get Descriptor request. If there
1007 * are any other requests in the same microframe, the device
1008 * reports bogus data, first of the descriptor parts is not
1009 * sent to the host. Wait over one microframe duration here
1010 * (1mS for USB 1.x , 125uS for USB 2.0) to avoid triggering
1011 * the issue.
1012 */
1013 mdelay(1);
Wolfgang Denkc7a4f7d2005-07-21 11:57:57 +02001014 }
Remy Bohmer47e72082008-10-10 10:23:21 +02001015
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +01001016 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
wdenkaffae2b2002-08-17 09:36:01 +00001017 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
1018 switch (dev->descriptor.bMaxPacketSize0) {
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +01001019 case 8:
1020 dev->maxpacketsize = PACKET_SIZE_8;
1021 break;
1022 case 16:
1023 dev->maxpacketsize = PACKET_SIZE_16;
1024 break;
1025 case 32:
1026 dev->maxpacketsize = PACKET_SIZE_32;
1027 break;
1028 case 64:
1029 dev->maxpacketsize = PACKET_SIZE_64;
1030 break;
Paul Kocialkowski1b412002015-04-04 15:12:29 +02001031 default:
Bin Mengae6d0cf2017-09-18 06:40:42 -07001032 printf("%s: invalid max packet size\n", __func__);
Paul Kocialkowski1b412002015-04-04 15:12:29 +02001033 return -EIO;
wdenkaffae2b2002-08-17 09:36:01 +00001034 }
Simon Glassbbca4912015-03-25 12:22:05 -06001035
1036 return 0;
1037}
1038
Simon Glassaad719f2015-03-25 12:22:06 -06001039static int usb_prepare_device(struct usb_device *dev, int addr, bool do_read,
Hans de Goede778dc1c2015-06-17 21:33:46 +02001040 struct usb_device *parent)
Simon Glassbbca4912015-03-25 12:22:05 -06001041{
Simon Glassaad719f2015-03-25 12:22:06 -06001042 int err;
Simon Glassbbca4912015-03-25 12:22:05 -06001043
1044 /*
1045 * Allocate usb 3.0 device context.
1046 * USB 3.0 (xHCI) protocol tries to allocate device slot
1047 * and related data structures first. This call does that.
1048 * Refer to sec 4.3.2 in xHCI spec rev1.0
1049 */
Simon Glassaad719f2015-03-25 12:22:06 -06001050 err = usb_alloc_device(dev);
1051 if (err) {
Simon Glassbbca4912015-03-25 12:22:05 -06001052 printf("Cannot allocate device context to get SLOT_ID\n");
Simon Glassaad719f2015-03-25 12:22:06 -06001053 return err;
Simon Glassbbca4912015-03-25 12:22:05 -06001054 }
Simon Glassbbca4912015-03-25 12:22:05 -06001055 err = usb_setup_descriptor(dev, do_read);
1056 if (err)
1057 return err;
Hans de Goede25293e42015-06-17 21:33:47 +02001058 err = usb_hub_port_reset(dev, parent);
Simon Glassbbca4912015-03-25 12:22:05 -06001059 if (err)
1060 return err;
1061
wdenkaffae2b2002-08-17 09:36:01 +00001062 dev->devnum = addr;
1063
1064 err = usb_set_address(dev); /* set address */
1065
1066 if (err < 0) {
Remy Bohmer172a1132008-09-16 14:55:43 +02001067 printf("\n USB device not accepting new address " \
1068 "(error=%lX)\n", dev->status);
Simon Glassaad719f2015-03-25 12:22:06 -06001069 return err;
wdenkaffae2b2002-08-17 09:36:01 +00001070 }
1071
Mike Frysinger60ce19a2012-03-05 13:47:00 +00001072 mdelay(10); /* Let the SET_ADDRESS settle */
wdenkaffae2b2002-08-17 09:36:01 +00001073
Bin Mengd21e8ba2017-09-18 06:40:43 -07001074 /*
1075 * If we haven't read device descriptor before, read it here
1076 * after device is assigned an address. This is only applicable
1077 * to xHCI so far.
1078 */
1079 if (!do_read) {
1080 err = usb_setup_descriptor(dev, true);
1081 if (err)
1082 return err;
1083 }
1084
Simon Glassaad719f2015-03-25 12:22:06 -06001085 return 0;
1086}
1087
Janne Grunau176e8f02024-04-04 08:25:52 +02001088static int usb_device_is_ignored(u16 id_vendor, u16 id_product)
1089{
1090 ulong vid, pid;
1091 char *end;
1092 const char *cur = NULL;
1093
1094 /* ignore list depends on env support */
1095 if (!CONFIG_IS_ENABLED(ENV_SUPPORT))
1096 return 0;
1097
1098 cur = env_get("usb_ignorelist");
1099
1100 /* parse "usb_ignorelist" strictly */
1101 while (cur && cur[0] != '\0') {
1102 vid = simple_strtoul(cur, &end, 0);
1103 /*
1104 * If strtoul did not parse a single digit or the next char is
1105 * not ':' the ignore list is malformed.
1106 */
1107 if (cur == end || end[0] != ':')
1108 return -EINVAL;
1109
1110 cur = end + 1;
1111 pid = simple_strtoul(cur, &end, 0);
1112 /* Consider '*' as wildcard for the product ID */
1113 if (cur == end && end[0] == '*') {
1114 pid = U16_MAX + 1;
1115 end++;
1116 }
1117 /*
1118 * The ignore list is malformed if no product ID / wildcard was
1119 * parsed or entries are not separated by ',' or terminated with
1120 * '\0'.
1121 */
1122 if (cur == end || (end[0] != ',' && end[0] != '\0'))
1123 return -EINVAL;
1124
1125 if (id_vendor == vid && (pid > U16_MAX || id_product == pid))
1126 return -ENODEV;
1127
1128 if (end[0] == '\0')
1129 break;
1130 cur = end + 1;
1131 }
1132
1133 return 0;
1134}
1135
Simon Glass2674e262015-03-25 12:22:08 -06001136int usb_select_config(struct usb_device *dev)
Simon Glassaad719f2015-03-25 12:22:06 -06001137{
Marek Vasut82daad62016-04-27 01:55:10 +02001138 unsigned char *tmpbuf = NULL;
Simon Glass668c53f2015-03-25 12:22:07 -06001139 int err;
Simon Glassaad719f2015-03-25 12:22:06 -06001140
Simon Glass668c53f2015-03-25 12:22:07 -06001141 err = get_descriptor_len(dev, USB_DT_DEVICE_SIZE, USB_DT_DEVICE_SIZE);
1142 if (err)
1143 return err;
wdenkaffae2b2002-08-17 09:36:01 +00001144
wdenkaffae2b2002-08-17 09:36:01 +00001145 /* correct le values */
Christian Eggers4e0e8d02008-05-21 22:12:00 +02001146 le16_to_cpus(&dev->descriptor.bcdUSB);
1147 le16_to_cpus(&dev->descriptor.idVendor);
1148 le16_to_cpus(&dev->descriptor.idProduct);
1149 le16_to_cpus(&dev->descriptor.bcdDevice);
Simon Glass668c53f2015-03-25 12:22:07 -06001150
Janne Grunau176e8f02024-04-04 08:25:52 +02001151 /* ignore devices from usb_ignorelist */
1152 err = usb_device_is_ignored(dev->descriptor.idVendor,
1153 dev->descriptor.idProduct);
1154 if (err == -ENODEV) {
1155 debug("Ignoring USB device 0x%x:0x%x\n",
1156 dev->descriptor.idVendor, dev->descriptor.idProduct);
1157 return err;
1158 } else if (err == -EINVAL) {
1159 /*
1160 * Continue on "usb_ignorelist" parsing errors. The list is
1161 * parsed for each device returning the error would result in
1162 * ignoring all USB devices.
1163 * Since the parsing error is independent of the probed device
1164 * report errors with printf instead of dev_err.
1165 */
1166 printf("usb_ignorelist parse error in \"%s\"\n",
1167 env_get("usb_ignorelist"));
1168 } else if (err < 0) {
1169 return err;
1170 }
1171
Marek Vasut84b76622016-04-27 03:32:56 +02001172 /*
1173 * Kingston DT Ultimate 32GB USB 3.0 seems to be extremely sensitive
1174 * about this first Get Descriptor request. If there are any other
1175 * requests in the first microframe, the stick crashes. Wait about
1176 * one microframe duration here (1mS for USB 1.x , 125uS for USB 2.0).
1177 */
1178 mdelay(1);
1179
wdenkaffae2b2002-08-17 09:36:01 +00001180 /* only support for one config for now */
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +01001181 err = usb_get_configuration_len(dev, 0);
1182 if (err >= 0) {
1183 tmpbuf = (unsigned char *)malloc_cache_aligned(err);
1184 if (!tmpbuf)
1185 err = -ENOMEM;
1186 else
1187 err = usb_get_configuration_no(dev, 0, tmpbuf, err);
1188 }
Vincent Palatin6a238662012-07-24 07:12:02 +00001189 if (err < 0) {
1190 printf("usb_new_device: Cannot read configuration, " \
1191 "skipping device %04x:%04x\n",
1192 dev->descriptor.idVendor, dev->descriptor.idProduct);
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +01001193 free(tmpbuf);
Simon Glass668c53f2015-03-25 12:22:07 -06001194 return err;
Vincent Palatin6a238662012-07-24 07:12:02 +00001195 }
Puneet Saxena6c9bb602012-04-03 14:56:06 +05301196 usb_parse_config(dev, tmpbuf, 0);
Stefan BrĂ¼ns4aa36272015-12-22 01:18:13 +01001197 free(tmpbuf);
wdenkaffae2b2002-08-17 09:36:01 +00001198 usb_set_maxpacket(dev);
Simon Glass668c53f2015-03-25 12:22:07 -06001199 /*
1200 * we set the default configuration here
1201 * This seems premature. If the driver wants a different configuration
1202 * it will need to select itself.
1203 */
1204 err = usb_set_configuration(dev, dev->config.desc.bConfigurationValue);
1205 if (err < 0) {
Remy Bohmer172a1132008-09-16 14:55:43 +02001206 printf("failed to set default configuration " \
1207 "len %d, status %lX\n", dev->act_len, dev->status);
Simon Glass668c53f2015-03-25 12:22:07 -06001208 return err;
wdenkaffae2b2002-08-17 09:36:01 +00001209 }
Marek Vasut847ddc22016-04-27 03:08:12 +02001210
1211 /*
1212 * Wait until the Set Configuration request gets processed by the
1213 * device. This is required by at least SanDisk Cruzer Pop USB 2.0
1214 * and Kingston DT Ultimate 32GB USB 3.0 on DWC2 OTG controller.
1215 */
1216 mdelay(10);
1217
Vivek Gautamf94c95d2013-04-12 16:34:33 +05301218 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1219 dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1220 dev->descriptor.iSerialNumber);
wdenkaffae2b2002-08-17 09:36:01 +00001221 memset(dev->mf, 0, sizeof(dev->mf));
1222 memset(dev->prod, 0, sizeof(dev->prod));
1223 memset(dev->serial, 0, sizeof(dev->serial));
1224 if (dev->descriptor.iManufacturer)
Remy Bohmer172a1132008-09-16 14:55:43 +02001225 usb_string(dev, dev->descriptor.iManufacturer,
1226 dev->mf, sizeof(dev->mf));
wdenkaffae2b2002-08-17 09:36:01 +00001227 if (dev->descriptor.iProduct)
Remy Bohmer172a1132008-09-16 14:55:43 +02001228 usb_string(dev, dev->descriptor.iProduct,
1229 dev->prod, sizeof(dev->prod));
wdenkaffae2b2002-08-17 09:36:01 +00001230 if (dev->descriptor.iSerialNumber)
Remy Bohmer172a1132008-09-16 14:55:43 +02001231 usb_string(dev, dev->descriptor.iSerialNumber,
1232 dev->serial, sizeof(dev->serial));
Vivek Gautamf94c95d2013-04-12 16:34:33 +05301233 debug("Manufacturer %s\n", dev->mf);
1234 debug("Product %s\n", dev->prod);
1235 debug("SerialNumber %s\n", dev->serial);
Simon Glass668c53f2015-03-25 12:22:07 -06001236
1237 return 0;
1238}
1239
Simon Glass2674e262015-03-25 12:22:08 -06001240int usb_setup_device(struct usb_device *dev, bool do_read,
Hans de Goede778dc1c2015-06-17 21:33:46 +02001241 struct usb_device *parent)
Simon Glass668c53f2015-03-25 12:22:07 -06001242{
1243 int addr;
1244 int ret;
1245
1246 /* We still haven't set the Address yet */
1247 addr = dev->devnum;
1248 dev->devnum = 0;
1249
Hans de Goede778dc1c2015-06-17 21:33:46 +02001250 ret = usb_prepare_device(dev, addr, do_read, parent);
Simon Glass668c53f2015-03-25 12:22:07 -06001251 if (ret)
1252 return ret;
1253 ret = usb_select_config(dev);
1254
1255 return ret;
1256}
1257
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +01001258#if !CONFIG_IS_ENABLED(DM_USB)
Simon Glass668c53f2015-03-25 12:22:07 -06001259/*
1260 * By the time we get here, the device has gotten a new device ID
1261 * and is in the default state. We need to identify the thing and
1262 * get the ball rolling..
1263 *
1264 * Returns 0 for success, != 0 for error.
1265 */
1266int usb_new_device(struct usb_device *dev)
1267{
1268 bool do_read = true;
1269 int err;
1270
1271 /*
1272 * XHCI needs to issue a Address device command to setup
1273 * proper device context structures, before it can interact
1274 * with the device. So a get_descriptor will fail before any
1275 * of that is done for XHCI unlike EHCI.
1276 */
Masahiro Yamada58d00232016-06-04 07:35:03 +09001277#ifdef CONFIG_USB_XHCI_HCD
Simon Glass668c53f2015-03-25 12:22:07 -06001278 do_read = false;
1279#endif
Hans de Goede778dc1c2015-06-17 21:33:46 +02001280 err = usb_setup_device(dev, do_read, dev->parent);
Simon Glass668c53f2015-03-25 12:22:07 -06001281 if (err)
1282 return err;
1283
1284 /* Now probe if the device is a hub */
1285 err = usb_hub_probe(dev, 0);
1286 if (err < 0)
1287 return err;
1288
wdenkaffae2b2002-08-17 09:36:01 +00001289 return 0;
1290}
Simon Glass2674e262015-03-25 12:22:08 -06001291#endif
wdenkaffae2b2002-08-17 09:36:01 +00001292
Mateusz Zalegad862f892013-10-04 19:22:26 +02001293__weak
Troy Kiskyde8ae7b2013-10-10 15:27:55 -07001294int board_usb_init(int index, enum usb_init_type init)
Mateusz Zalegad862f892013-10-04 19:22:26 +02001295{
1296 return 0;
1297}
Kishon Vijay Abraham Iae07a842015-02-23 18:40:18 +05301298
1299__weak
1300int board_usb_cleanup(int index, enum usb_init_type init)
1301{
1302 return 0;
1303}
Simon Glass2674e262015-03-25 12:22:08 -06001304
1305bool usb_device_has_child_on_port(struct usb_device *parent, int port)
1306{
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +01001307#if CONFIG_IS_ENABLED(DM_USB)
Simon Glass2674e262015-03-25 12:22:08 -06001308 return false;
1309#else
1310 return parent->children[port] != NULL;
1311#endif
1312}
1313
Sven Schwermer8a3cb9f12018-11-21 08:43:56 +01001314#if CONFIG_IS_ENABLED(DM_USB)
Stefan BrĂ¼nsa0105682015-12-22 01:21:03 +01001315void usb_find_usb2_hub_address_port(struct usb_device *udev,
1316 uint8_t *hub_address, uint8_t *hub_port)
1317{
1318 struct udevice *parent;
1319 struct usb_device *uparent, *ttdev;
1320
1321 /*
1322 * When called from usb-uclass.c: usb_scan_device() udev->dev points
1323 * to the parent udevice, not the actual udevice belonging to the
1324 * udev as the device is not instantiated yet. So when searching
1325 * for the first usb-2 parent start with udev->dev not
1326 * udev->dev->parent .
1327 */
1328 ttdev = udev;
1329 parent = udev->dev;
1330 uparent = dev_get_parent_priv(parent);
1331
1332 while (uparent->speed != USB_SPEED_HIGH) {
1333 struct udevice *dev = parent;
1334
1335 if (device_get_uclass_id(dev->parent) != UCLASS_USB_HUB) {
1336 printf("Error: Cannot find high speed parent of usb-1 device\n");
1337 *hub_address = 0;
1338 *hub_port = 0;
1339 return;
1340 }
1341
1342 ttdev = dev_get_parent_priv(dev);
1343 parent = dev->parent;
1344 uparent = dev_get_parent_priv(parent);
1345 }
1346 *hub_address = uparent->devnum;
1347 *hub_port = ttdev->portnr;
1348}
1349#else
1350void usb_find_usb2_hub_address_port(struct usb_device *udev,
1351 uint8_t *hub_address, uint8_t *hub_port)
1352{
1353 /* Find out the nearest parent which is high speed */
1354 while (udev->parent->parent != NULL)
1355 if (udev->parent->speed != USB_SPEED_HIGH) {
1356 udev = udev->parent;
1357 } else {
1358 *hub_address = udev->parent->devnum;
1359 *hub_port = udev->portnr;
1360 return;
1361 }
1362
1363 printf("Error: Cannot find high speed parent of usb-1 device\n");
1364 *hub_address = 0;
1365 *hub_port = 0;
1366}
1367#endif
1368
1369
wdenkaffae2b2002-08-17 09:36:01 +00001370/* EOF */