blob: bfec303e7af61ef4cdc792a6bd9015969e4c4e6b [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glass9b82eeb2015-03-25 12:21:59 -06002/*
3 * (C) Copyright 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
5 *
Simon Glassfc03a552015-03-25 12:22:30 -06006 * usb_match_device() modified from Linux kernel v4.0.
Simon Glass9b82eeb2015-03-25 12:21:59 -06007 */
8
Patrick Delaunay81313352021-04-27 11:02:19 +02009#define LOG_CATEGORY UCLASS_USB
10
Simon Glass62b03cc2023-09-20 07:29:49 -060011#include <bootdev.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060012#include <dm.h>
13#include <errno.h>
Simon Glass0f2af882020-05-10 11:40:05 -060014#include <log.h>
Simon Glass2dd337a2015-09-02 17:24:58 -060015#include <memalign.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060016#include <usb.h>
17#include <dm/device-internal.h>
18#include <dm/lists.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060019#include <dm/uclass-internal.h>
20
Simon Glass9b82eeb2015-03-25 12:21:59 -060021static bool asynch_allowed;
22
Hans de Goedecebc5b72015-05-10 14:10:21 +020023struct usb_uclass_priv {
24 int companion_device_count;
25};
26
Marek Vasut118a9032020-04-06 14:29:44 +020027int usb_lock_async(struct usb_device *udev, int lock)
28{
29 struct udevice *bus = udev->controller_dev;
30 struct dm_usb_ops *ops = usb_get_ops(bus);
31
32 if (!ops->lock_async)
33 return -ENOSYS;
34
35 return ops->lock_async(bus, lock);
36}
37
Simon Glass9b82eeb2015-03-25 12:21:59 -060038int usb_disable_asynch(int disable)
39{
40 int old_value = asynch_allowed;
41
42 asynch_allowed = !disable;
43 return old_value;
44}
45
46int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
Michal Suchanek1c95b9f2019-08-18 10:55:27 +020047 int length, int interval, bool nonblock)
Simon Glass9b82eeb2015-03-25 12:21:59 -060048{
49 struct udevice *bus = udev->controller_dev;
50 struct dm_usb_ops *ops = usb_get_ops(bus);
51
52 if (!ops->interrupt)
53 return -ENOSYS;
54
Michal Suchanek1c95b9f2019-08-18 10:55:27 +020055 return ops->interrupt(bus, udev, pipe, buffer, length, interval,
56 nonblock);
Simon Glass9b82eeb2015-03-25 12:21:59 -060057}
58
59int submit_control_msg(struct usb_device *udev, unsigned long pipe,
60 void *buffer, int length, struct devrequest *setup)
61{
62 struct udevice *bus = udev->controller_dev;
63 struct dm_usb_ops *ops = usb_get_ops(bus);
Simon Glass95588622020-12-22 19:30:28 -070064 struct usb_uclass_priv *uc_priv = uclass_get_priv(bus->uclass);
Hans de Goedecebc5b72015-05-10 14:10:21 +020065 int err;
Simon Glass9b82eeb2015-03-25 12:21:59 -060066
67 if (!ops->control)
68 return -ENOSYS;
69
Hans de Goedecebc5b72015-05-10 14:10:21 +020070 err = ops->control(bus, udev, pipe, buffer, length, setup);
71 if (setup->request == USB_REQ_SET_FEATURE &&
72 setup->requesttype == USB_RT_PORT &&
73 setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) &&
74 err == -ENXIO) {
75 /* Device handed over to companion after port reset */
76 uc_priv->companion_device_count++;
77 }
78
79 return err;
Simon Glass9b82eeb2015-03-25 12:21:59 -060080}
81
82int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
83 int length)
84{
85 struct udevice *bus = udev->controller_dev;
86 struct dm_usb_ops *ops = usb_get_ops(bus);
87
88 if (!ops->bulk)
89 return -ENOSYS;
90
91 return ops->bulk(bus, udev, pipe, buffer, length);
92}
93
Hans de Goede0a7fa272015-05-10 14:10:18 +020094struct int_queue *create_int_queue(struct usb_device *udev,
95 unsigned long pipe, int queuesize, int elementsize,
96 void *buffer, int interval)
97{
98 struct udevice *bus = udev->controller_dev;
99 struct dm_usb_ops *ops = usb_get_ops(bus);
100
101 if (!ops->create_int_queue)
102 return NULL;
103
104 return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize,
105 buffer, interval);
106}
107
108void *poll_int_queue(struct usb_device *udev, struct int_queue *queue)
109{
110 struct udevice *bus = udev->controller_dev;
111 struct dm_usb_ops *ops = usb_get_ops(bus);
112
113 if (!ops->poll_int_queue)
114 return NULL;
115
116 return ops->poll_int_queue(bus, udev, queue);
117}
118
119int destroy_int_queue(struct usb_device *udev, struct int_queue *queue)
120{
121 struct udevice *bus = udev->controller_dev;
122 struct dm_usb_ops *ops = usb_get_ops(bus);
123
124 if (!ops->destroy_int_queue)
125 return -ENOSYS;
126
127 return ops->destroy_int_queue(bus, udev, queue);
128}
129
Simon Glass9b82eeb2015-03-25 12:21:59 -0600130int usb_alloc_device(struct usb_device *udev)
131{
132 struct udevice *bus = udev->controller_dev;
133 struct dm_usb_ops *ops = usb_get_ops(bus);
134
135 /* This is only requird by some controllers - current XHCI */
136 if (!ops->alloc_device)
137 return 0;
138
139 return ops->alloc_device(bus, udev);
140}
141
Hans de Goedea9e41f82015-06-17 21:33:52 +0200142int usb_reset_root_port(struct usb_device *udev)
143{
144 struct udevice *bus = udev->controller_dev;
145 struct dm_usb_ops *ops = usb_get_ops(bus);
146
147 if (!ops->reset_root_port)
148 return -ENOSYS;
149
150 return ops->reset_root_port(bus, udev);
151}
152
Bin Meng1f31f5a2017-07-19 21:51:17 +0800153int usb_update_hub_device(struct usb_device *udev)
154{
155 struct udevice *bus = udev->controller_dev;
156 struct dm_usb_ops *ops = usb_get_ops(bus);
157
158 if (!ops->update_hub_device)
159 return -ENOSYS;
160
161 return ops->update_hub_device(bus, udev);
162}
163
Bin Meng6840a342017-09-07 06:13:17 -0700164int usb_get_max_xfer_size(struct usb_device *udev, size_t *size)
165{
166 struct udevice *bus = udev->controller_dev;
167 struct dm_usb_ops *ops = usb_get_ops(bus);
168
169 if (!ops->get_max_xfer_size)
170 return -ENOSYS;
171
172 return ops->get_max_xfer_size(bus, size);
173}
174
Simon Glass9b82eeb2015-03-25 12:21:59 -0600175int usb_stop(void)
176{
177 struct udevice *bus;
Bin Meng669ad842017-10-01 06:19:42 -0700178 struct udevice *rh;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600179 struct uclass *uc;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200180 struct usb_uclass_priv *uc_priv;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600181 int err = 0, ret;
182
183 /* De-activate any devices that have been activated */
184 ret = uclass_get(UCLASS_USB, &uc);
185 if (ret)
186 return ret;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200187
Simon Glass95588622020-12-22 19:30:28 -0700188 uc_priv = uclass_get_priv(uc);
Hans de Goedecebc5b72015-05-10 14:10:21 +0200189
Simon Glass9b82eeb2015-03-25 12:21:59 -0600190 uclass_foreach_dev(bus, uc) {
Stefan Roese80b5bc92017-03-20 12:51:48 +0100191 ret = device_remove(bus, DM_REMOVE_NORMAL);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600192 if (ret && !err)
193 err = ret;
Bin Meng669ad842017-10-01 06:19:42 -0700194
195 /* Locate root hub device */
196 device_find_first_child(bus, &rh);
197 if (rh) {
198 /*
199 * All USB devices are children of root hub.
200 * Unbinding root hub will unbind all of its children.
201 */
202 ret = device_unbind(rh);
203 if (ret && !err)
204 err = ret;
205 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600206 }
Bin Mengdadc4c02017-10-01 06:19:43 -0700207
Paul Kocialkowskid449dd32015-08-04 17:04:12 +0200208#ifdef CONFIG_USB_STORAGE
Simon Glass9b82eeb2015-03-25 12:21:59 -0600209 usb_stor_reset();
Paul Kocialkowskid449dd32015-08-04 17:04:12 +0200210#endif
Simon Glass62b03cc2023-09-20 07:29:49 -0600211 if (CONFIG_IS_ENABLED(BOOTSTD)) {
212 int ret;
213
214 ret = bootdev_unhunt(UCLASS_USB);
215 if (IS_ENABLED(CONFIG_BOOTSTD_FULL) && ret && ret != -EALREADY)
216 printf("failed to unhunt USB (err=%dE)\n", ret);
217 }
Hans de Goedecebc5b72015-05-10 14:10:21 +0200218 uc_priv->companion_device_count = 0;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600219 usb_started = 0;
220
221 return err;
222}
223
Hans de Goedef8762f92015-05-10 14:10:19 +0200224static void usb_scan_bus(struct udevice *bus, bool recurse)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600225{
226 struct usb_bus_priv *priv;
227 struct udevice *dev;
228 int ret;
229
230 priv = dev_get_uclass_priv(bus);
231
232 assert(recurse); /* TODO: Support non-recusive */
233
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000234 printf("scanning bus %s for devices... ", bus->name);
Hans de Goedef8762f92015-05-10 14:10:19 +0200235 debug("\n");
Simon Glass9b82eeb2015-03-25 12:21:59 -0600236 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
237 if (ret)
Hans de Goedef8762f92015-05-10 14:10:19 +0200238 printf("failed, error %d\n", ret);
239 else if (priv->next_addr == 0)
240 printf("No USB Device found\n");
241 else
242 printf("%d USB Device(s) found\n", priv->next_addr);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600243}
244
Simon Glass35787d22015-11-08 23:48:00 -0700245static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
246{
247 uclass_foreach_dev(bus, uc) {
248 struct udevice *dev, *next;
249
250 if (!device_active(bus))
251 continue;
252 device_foreach_child_safe(dev, next, bus) {
253 if (!device_active(dev))
254 device_unbind(dev);
255 }
256 }
257}
258
Fabrice Gasnier7785aee2023-09-01 11:52:01 +0200259static int usb_probe_companion(struct udevice *bus)
260{
261 struct udevice *companion_dev;
262 int ret;
263
264 /*
265 * Enforce optional companion controller is marked as such in order to
266 * 1st scan the primary controller, before the companion controller
267 * (ownership is given to companion when low or full speed devices
268 * have been detected).
269 */
270 ret = uclass_get_device_by_phandle(UCLASS_USB, bus, "companion", &companion_dev);
271 if (!ret) {
272 struct usb_bus_priv *companion_bus_priv;
273
274 debug("%s is the companion of %s\n", companion_dev->name, bus->name);
275 companion_bus_priv = dev_get_uclass_priv(companion_dev);
276 companion_bus_priv->companion = true;
277 } else if (ret && ret != -ENOENT && ret != -ENODEV) {
278 /*
279 * Treat everything else than no companion or disabled
280 * companion as an error. (It may not be enabled on boards
281 * that have a High-Speed HUB to handle FS and LS traffic).
282 */
283 printf("Failed to get companion (ret=%d)\n", ret);
284 return ret;
285 }
286
287 return 0;
288}
289
Simon Glass9b82eeb2015-03-25 12:21:59 -0600290int usb_init(void)
291{
292 int controllers_initialized = 0;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200293 struct usb_uclass_priv *uc_priv;
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200294 struct usb_bus_priv *priv;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600295 struct udevice *bus;
296 struct uclass *uc;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600297 int ret;
298
299 asynch_allowed = 1;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600300
301 ret = uclass_get(UCLASS_USB, &uc);
302 if (ret)
303 return ret;
304
Simon Glass95588622020-12-22 19:30:28 -0700305 uc_priv = uclass_get_priv(uc);
Hans de Goedecebc5b72015-05-10 14:10:21 +0200306
Simon Glass9b82eeb2015-03-25 12:21:59 -0600307 uclass_foreach_dev(bus, uc) {
308 /* init low_level USB */
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000309 printf("Bus %s: ", bus->name);
Bin Meng669ad842017-10-01 06:19:42 -0700310
Bin Meng669ad842017-10-01 06:19:42 -0700311 /*
312 * For Sandbox, we need scan the device tree each time when we
313 * start the USB stack, in order to re-create the emulated USB
314 * devices and bind drivers for them before we actually do the
315 * driver probe.
Fabrice Gasniercd809b12022-12-12 11:44:35 +0100316 *
317 * For USB onboard HUB, we need to do some non-trivial init
318 * like enabling a power regulator, before enumeration.
Bin Meng669ad842017-10-01 06:19:42 -0700319 */
Fabrice Gasniercd809b12022-12-12 11:44:35 +0100320 if (IS_ENABLED(CONFIG_SANDBOX) ||
321 IS_ENABLED(CONFIG_USB_ONBOARD_HUB)) {
322 ret = dm_scan_fdt_dev(bus);
323 if (ret) {
324 printf("USB device scan from fdt failed (%d)", ret);
325 continue;
326 }
Bin Meng669ad842017-10-01 06:19:42 -0700327 }
Bin Meng669ad842017-10-01 06:19:42 -0700328
Simon Glass9b82eeb2015-03-25 12:21:59 -0600329 ret = device_probe(bus);
330 if (ret == -ENODEV) { /* No such device. */
331 puts("Port not available.\n");
332 controllers_initialized++;
333 continue;
334 }
335
336 if (ret) { /* Other error. */
337 printf("probe failed, error %d\n", ret);
338 continue;
339 }
Fabrice Gasnier7785aee2023-09-01 11:52:01 +0200340
341 ret = usb_probe_companion(bus);
342 if (ret)
343 continue;
344
Simon Glass9b82eeb2015-03-25 12:21:59 -0600345 controllers_initialized++;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600346 usb_started = true;
347 }
348
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200349 /*
350 * lowlevel init done, now scan the bus for devices i.e. search HUBs
351 * and configure them, first scan primary controllers.
352 */
353 uclass_foreach_dev(bus, uc) {
354 if (!device_active(bus))
355 continue;
356
357 priv = dev_get_uclass_priv(bus);
358 if (!priv->companion)
359 usb_scan_bus(bus, true);
360 }
361
362 /*
363 * Now that the primary controllers have been scanned and have handed
364 * over any devices they do not understand to their companions, scan
Hans de Goedecebc5b72015-05-10 14:10:21 +0200365 * the companions if necessary.
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200366 */
Hans de Goedecebc5b72015-05-10 14:10:21 +0200367 if (uc_priv->companion_device_count) {
368 uclass_foreach_dev(bus, uc) {
369 if (!device_active(bus))
370 continue;
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200371
Hans de Goedecebc5b72015-05-10 14:10:21 +0200372 priv = dev_get_uclass_priv(bus);
373 if (priv->companion)
374 usb_scan_bus(bus, true);
375 }
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200376 }
377
Simon Glass9b82eeb2015-03-25 12:21:59 -0600378 debug("scan end\n");
Simon Glass35787d22015-11-08 23:48:00 -0700379
380 /* Remove any devices that were not found on this scan */
381 remove_inactive_children(uc, bus);
382
383 ret = uclass_get(UCLASS_USB_HUB, &uc);
384 if (ret)
385 return ret;
386 remove_inactive_children(uc, bus);
387
Simon Glass9b82eeb2015-03-25 12:21:59 -0600388 /* if we were not able to find at least one working bus, bail out */
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000389 if (controllers_initialized == 0)
Heinrich Schuchardtbf2d56e2024-06-18 21:07:29 +0200390 printf("No USB controllers found\n");
Simon Glass9b82eeb2015-03-25 12:21:59 -0600391
Simon Glassac746082023-07-30 11:15:12 -0600392 return usb_started ? 0 : -ENOENT;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600393}
394
Simon Glass444b1e02015-03-25 12:22:32 -0600395int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
396{
Simon Glassb75b15b2020-12-03 16:55:23 -0700397 struct usb_plat *plat;
Simon Glass444b1e02015-03-25 12:22:32 -0600398 struct udevice *dev;
399 int ret;
400
401 /* Find the old device and remove it */
Sean Andersone7665702021-11-05 12:52:55 -0400402 ret = uclass_find_first_device(UCLASS_USB, &dev);
Simon Glass444b1e02015-03-25 12:22:32 -0600403 if (ret)
404 return ret;
Stefan Roese80b5bc92017-03-20 12:51:48 +0100405 ret = device_remove(dev, DM_REMOVE_NORMAL);
Simon Glass444b1e02015-03-25 12:22:32 -0600406 if (ret)
407 return ret;
408
Simon Glassfa20e932020-12-03 16:55:20 -0700409 plat = dev_get_plat(dev);
Simon Glass444b1e02015-03-25 12:22:32 -0600410 plat->init_type = USB_INIT_DEVICE;
411 ret = device_probe(dev);
412 if (ret)
413 return ret;
414 *ctlrp = dev_get_priv(dev);
415
416 return 0;
417}
418
Ye Li68801eb2020-06-29 10:12:59 +0800419int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp)
420{
421 struct udevice *dev;
422 int ret;
423
424 /* Find the old device and remove it */
Sean Andersone7665702021-11-05 12:52:55 -0400425 ret = uclass_find_first_device(UCLASS_USB, &dev);
Ye Li68801eb2020-06-29 10:12:59 +0800426 if (ret)
427 return ret;
428 ret = device_remove(dev, DM_REMOVE_NORMAL);
429 if (ret)
430 return ret;
431
432 *ctlrp = NULL;
433
434 return 0;
435}
436
Simon Glassfc03a552015-03-25 12:22:30 -0600437/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900438static int usb_match_device(const struct usb_device_descriptor *desc,
439 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600440{
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200442 id->idVendor != desc->idVendor)
Simon Glassfc03a552015-03-25 12:22:30 -0600443 return 0;
444
445 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200446 id->idProduct != desc->idProduct)
Simon Glassfc03a552015-03-25 12:22:30 -0600447 return 0;
448
449 /* No need to test id->bcdDevice_lo != 0, since 0 is never
450 greater than any unsigned number. */
451 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200452 (id->bcdDevice_lo > desc->bcdDevice))
Simon Glassfc03a552015-03-25 12:22:30 -0600453 return 0;
454
455 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200456 (id->bcdDevice_hi < desc->bcdDevice))
Simon Glassfc03a552015-03-25 12:22:30 -0600457 return 0;
458
459 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
460 (id->bDeviceClass != desc->bDeviceClass))
461 return 0;
462
463 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
464 (id->bDeviceSubClass != desc->bDeviceSubClass))
465 return 0;
466
467 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
468 (id->bDeviceProtocol != desc->bDeviceProtocol))
469 return 0;
470
471 return 1;
472}
473
474/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900475static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
476 const struct usb_interface_descriptor *int_desc,
477 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600478{
479 /* The interface class, subclass, protocol and number should never be
480 * checked for a match if the device class is Vendor Specific,
481 * unless the match record specifies the Vendor ID. */
482 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
483 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
484 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
485 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
486 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
487 USB_DEVICE_ID_MATCH_INT_NUMBER)))
488 return 0;
489
490 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
491 (id->bInterfaceClass != int_desc->bInterfaceClass))
492 return 0;
493
494 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
495 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
496 return 0;
497
498 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
499 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
500 return 0;
501
502 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
503 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
504 return 0;
505
506 return 1;
507}
508
509/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900510static int usb_match_one_id(struct usb_device_descriptor *desc,
511 struct usb_interface_descriptor *int_desc,
512 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600513{
514 if (!usb_match_device(desc, id))
515 return 0;
516
517 return usb_match_one_id_intf(desc, int_desc, id);
518}
519
Michael Walle7c961322020-06-02 01:47:07 +0200520static ofnode usb_get_ofnode(struct udevice *hub, int port)
521{
522 ofnode node;
523 u32 reg;
524
Simon Glass07c17772020-12-19 10:40:12 -0700525 if (!dev_has_ofnode(hub))
Michael Walle7c961322020-06-02 01:47:07 +0200526 return ofnode_null();
527
528 /*
529 * The USB controller and its USB hub are two different udevices,
530 * but the device tree has only one node for both. Thus we are
531 * assigning this node to both udevices.
532 * If port is zero, the controller scans its root hub, thus we
533 * are using the same ofnode as the controller here.
534 */
535 if (!port)
536 return dev_ofnode(hub);
537
538 ofnode_for_each_subnode(node, dev_ofnode(hub)) {
539 if (ofnode_read_u32(node, "reg", &reg))
540 continue;
541
542 if (reg == port)
543 return node;
544 }
545
546 return ofnode_null();
547}
548
Simon Glassfc03a552015-03-25 12:22:30 -0600549/**
550 * usb_find_and_bind_driver() - Find and bind the right USB driver
551 *
552 * This only looks at certain fields in the descriptor.
553 */
554static int usb_find_and_bind_driver(struct udevice *parent,
555 struct usb_device_descriptor *desc,
556 struct usb_interface_descriptor *iface,
Michael Walle7c961322020-06-02 01:47:07 +0200557 int bus_seq, int devnum, int port,
Simon Glassfc03a552015-03-25 12:22:30 -0600558 struct udevice **devp)
559{
560 struct usb_driver_entry *start, *entry;
561 int n_ents;
562 int ret;
Marek Vasut6e76b0f2022-11-26 13:57:53 +0100563 char name[34], *str;
Michael Walle7c961322020-06-02 01:47:07 +0200564 ofnode node = usb_get_ofnode(parent, port);
Simon Glassfc03a552015-03-25 12:22:30 -0600565
566 *devp = NULL;
567 debug("%s: Searching for driver\n", __func__);
568 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
569 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
570 for (entry = start; entry != start + n_ents; entry++) {
571 const struct usb_device_id *id;
572 struct udevice *dev;
573 const struct driver *drv;
Simon Glassb75b15b2020-12-03 16:55:23 -0700574 struct usb_dev_plat *plat;
Simon Glassfc03a552015-03-25 12:22:30 -0600575
576 for (id = entry->match; id->match_flags; id++) {
577 if (!usb_match_one_id(desc, iface, id))
578 continue;
579
580 drv = entry->driver;
581 /*
582 * We could pass the descriptor to the driver as
Simon Glass71fa5b42020-12-03 16:55:18 -0700583 * plat (instead of NULL) and allow its bind()
Simon Glassfc03a552015-03-25 12:22:30 -0600584 * method to return -ENOENT if it doesn't support this
585 * device. That way we could continue the search to
586 * find another driver. For now this doesn't seem
587 * necesssary, so just bind the first match.
588 */
Simon Glass884870f2020-11-28 17:50:01 -0700589 ret = device_bind(parent, drv, drv->name, NULL, node,
590 &dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600591 if (ret)
592 goto error;
593 debug("%s: Match found: %s\n", __func__, drv->name);
594 dev->driver_data = id->driver_info;
Simon Glass71fa5b42020-12-03 16:55:18 -0700595 plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600596 plat->id = *id;
597 *devp = dev;
598 return 0;
599 }
600 }
601
Simon Glassc79173e2015-03-25 12:22:31 -0600602 /* Bind a generic driver so that the device can be used */
603 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
604 str = strdup(name);
605 if (!str)
606 return -ENOMEM;
607 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
Simon Glass4d2c3592023-01-17 10:47:35 -0700608 if (!ret)
609 device_set_name_alloced(*devp);
Simon Glassc79173e2015-03-25 12:22:31 -0600610
Simon Glassfc03a552015-03-25 12:22:30 -0600611error:
612 debug("%s: No match found: %d\n", __func__, ret);
613 return ret;
614}
615
616/**
Simon Glassd43d7e92015-11-08 23:47:56 -0700617 * usb_find_child() - Find an existing device which matches our needs
618 *
619 *
Simon Glassfc03a552015-03-25 12:22:30 -0600620 */
Simon Glassd43d7e92015-11-08 23:47:56 -0700621static int usb_find_child(struct udevice *parent,
622 struct usb_device_descriptor *desc,
623 struct usb_interface_descriptor *iface,
624 struct udevice **devp)
Simon Glassfc03a552015-03-25 12:22:30 -0600625{
626 struct udevice *dev;
627
628 *devp = NULL;
629 for (device_find_first_child(parent, &dev);
630 dev;
631 device_find_next_child(&dev)) {
Simon Glassb75b15b2020-12-03 16:55:23 -0700632 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600633
634 /* If this device is already in use, skip it */
635 if (device_active(dev))
636 continue;
637 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
638 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
639 if (usb_match_one_id(desc, iface, &plat->id)) {
640 *devp = dev;
641 return 0;
642 }
643 }
Simon Glassd43d7e92015-11-08 23:47:56 -0700644
Simon Glassfc03a552015-03-25 12:22:30 -0600645 return -ENOENT;
646}
647
Simon Glass9b82eeb2015-03-25 12:21:59 -0600648int usb_scan_device(struct udevice *parent, int port,
649 enum usb_device_speed speed, struct udevice **devp)
650{
651 struct udevice *dev;
652 bool created = false;
Simon Glassb75b15b2020-12-03 16:55:23 -0700653 struct usb_dev_plat *plat;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600654 struct usb_bus_priv *priv;
655 struct usb_device *parent_udev;
656 int ret;
657 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
658 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
659
660 *devp = NULL;
661 memset(udev, '\0', sizeof(*udev));
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200662 udev->controller_dev = usb_get_bus(parent);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600663 priv = dev_get_uclass_priv(udev->controller_dev);
664
665 /*
666 * Somewhat nasty, this. We create a local device and use the normal
667 * USB stack to read its descriptor. Then we know what type of device
668 * to create for real.
669 *
670 * udev->dev is set to the parent, since we don't have a real device
671 * yet. The USB stack should not access udev.dev anyway, except perhaps
672 * to find the controller, and the controller will either be @parent,
673 * or some parent of @parent.
674 *
675 * Another option might be to create the device as a generic USB
676 * device, then morph it into the correct one when we know what it
677 * should be. This means that a generic USB device would morph into
678 * a network controller, or a USB flash stick, for example. However,
679 * we don't support such morphing and it isn't clear that it would
680 * be easy to do.
681 *
682 * Yet another option is to split out the USB stack parts of udev
683 * into something like a 'struct urb' (as Linux does) which can exist
684 * independently of any device. This feels cleaner, but calls for quite
685 * a big change to the USB stack.
686 *
687 * For now, the approach is to set up an empty udev, read its
688 * descriptor and assign it an address, then bind a real device and
689 * stash the resulting information into the device's parent
690 * platform data. Then when we probe it, usb_child_pre_probe() is called
691 * and it will pull the information out of the stash.
692 */
693 udev->dev = parent;
694 udev->speed = speed;
695 udev->devnum = priv->next_addr + 1;
696 udev->portnr = port;
697 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
698 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
Simon Glassde44acf2015-09-28 23:32:01 -0600699 dev_get_parent_priv(parent) : NULL;
Hans de Goede778dc1c2015-06-17 21:33:46 +0200700 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600701 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
702 if (ret)
703 return ret;
Simon Glassd43d7e92015-11-08 23:47:56 -0700704 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
705 debug("** usb_find_child returns %d\n", ret);
Simon Glassfc03a552015-03-25 12:22:30 -0600706 if (ret) {
707 if (ret != -ENOENT)
708 return ret;
Michael Walle7c961322020-06-02 01:47:07 +0200709 ret = usb_find_and_bind_driver(parent, &udev->descriptor,
710 iface,
Simon Glass75e534b2020-12-16 21:20:07 -0700711 dev_seq(udev->controller_dev),
Michael Walle7c961322020-06-02 01:47:07 +0200712 udev->devnum, port, &dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600713 if (ret)
714 return ret;
715 created = true;
716 }
Simon Glass71fa5b42020-12-03 16:55:18 -0700717 plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600718 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
719 plat->devnum = udev->devnum;
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200720 plat->udev = udev;
Simon Glassfc03a552015-03-25 12:22:30 -0600721 priv->next_addr++;
722 ret = device_probe(dev);
723 if (ret) {
724 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
725 priv->next_addr--;
726 if (created)
727 device_unbind(dev);
728 return ret;
729 }
730 *devp = dev;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600731
Simon Glassfc03a552015-03-25 12:22:30 -0600732 return 0;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600733}
734
Simon Glassfbb14942015-05-13 07:02:23 -0600735/*
736 * Detect if a USB device has been plugged or unplugged.
737 */
738int usb_detect_change(void)
739{
740 struct udevice *hub;
741 struct uclass *uc;
742 int change = 0;
743 int ret;
744
745 ret = uclass_get(UCLASS_USB_HUB, &uc);
746 if (ret)
747 return ret;
748
749 uclass_foreach_dev(hub, uc) {
750 struct usb_device *udev;
751 struct udevice *dev;
752
753 if (!device_active(hub))
754 continue;
755 for (device_find_first_child(hub, &dev);
756 dev;
757 device_find_next_child(&dev)) {
758 struct usb_port_status status;
759
760 if (!device_active(dev))
761 continue;
762
Simon Glassde44acf2015-09-28 23:32:01 -0600763 udev = dev_get_parent_priv(dev);
Simon Glassfbb14942015-05-13 07:02:23 -0600764 if (usb_get_port_status(udev, udev->portnr, &status)
765 < 0)
766 /* USB request failed */
767 continue;
768
769 if (le16_to_cpu(status.wPortChange) &
770 USB_PORT_STAT_C_CONNECTION)
771 change++;
772 }
773 }
774
775 return change;
776}
777
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900778static int usb_child_post_bind(struct udevice *dev)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600779{
Simon Glassb75b15b2020-12-03 16:55:23 -0700780 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600781 int val;
782
Simon Glassf1d50f72020-12-19 10:40:13 -0700783 if (!dev_has_ofnode(dev))
Simon Glass9b82eeb2015-03-25 12:21:59 -0600784 return 0;
785
786 /* We only support matching a few things */
Simon Glass6deb8e22017-05-18 20:09:38 -0600787 val = dev_read_u32_default(dev, "usb,device-class", -1);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600788 if (val != -1) {
789 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
790 plat->id.bDeviceClass = val;
791 }
Simon Glass6deb8e22017-05-18 20:09:38 -0600792 val = dev_read_u32_default(dev, "usb,interface-class", -1);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600793 if (val != -1) {
794 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
795 plat->id.bInterfaceClass = val;
796 }
797
798 return 0;
799}
800
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200801struct udevice *usb_get_bus(struct udevice *dev)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600802{
803 struct udevice *bus;
804
Simon Glass9b82eeb2015-03-25 12:21:59 -0600805 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
806 bus = bus->parent;
807 if (!bus) {
808 /* By design this cannot happen */
809 assert(bus);
810 debug("USB HUB '%s' does not have a controller\n", dev->name);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600811 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600812
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200813 return bus;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600814}
815
816int usb_child_pre_probe(struct udevice *dev)
817{
Simon Glassde44acf2015-09-28 23:32:01 -0600818 struct usb_device *udev = dev_get_parent_priv(dev);
Simon Glassb75b15b2020-12-03 16:55:23 -0700819 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600820 int ret;
821
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200822 if (plat->udev) {
823 /*
824 * Copy over all the values set in the on stack struct
825 * usb_device in usb_scan_device() to our final struct
826 * usb_device for this dev.
827 */
828 *udev = *(plat->udev);
829 /* And clear plat->udev as it will not be valid for long */
830 plat->udev = NULL;
831 udev->dev = dev;
832 } else {
833 /*
834 * This happens with devices which are explicitly bound
835 * instead of being discovered through usb_scan_device()
836 * such as sandbox emul devices.
837 */
838 udev->dev = dev;
839 udev->controller_dev = usb_get_bus(dev);
840 udev->devnum = plat->devnum;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600841
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200842 /*
843 * udev did not go through usb_scan_device(), so we need to
844 * select the config and read the config descriptors.
845 */
846 ret = usb_select_config(udev);
847 if (ret)
848 return ret;
849 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600850
851 return 0;
852}
853
854UCLASS_DRIVER(usb) = {
855 .id = UCLASS_USB,
856 .name = "usb",
857 .flags = DM_UC_FLAG_SEQ_ALIAS,
Simon Glass18230342016-07-05 17:10:10 -0600858 .post_bind = dm_scan_fdt_dev,
Simon Glass8a2b47f2020-12-03 16:55:17 -0700859 .priv_auto = sizeof(struct usb_uclass_priv),
860 .per_child_auto = sizeof(struct usb_device),
861 .per_device_auto = sizeof(struct usb_bus_priv),
Simon Glass9b82eeb2015-03-25 12:21:59 -0600862 .child_post_bind = usb_child_post_bind,
863 .child_pre_probe = usb_child_pre_probe,
Simon Glassb75b15b2020-12-03 16:55:23 -0700864 .per_child_plat_auto = sizeof(struct usb_dev_plat),
Simon Glass9b82eeb2015-03-25 12:21:59 -0600865};
Simon Glassc79173e2015-03-25 12:22:31 -0600866
867UCLASS_DRIVER(usb_dev_generic) = {
868 .id = UCLASS_USB_DEV_GENERIC,
869 .name = "usb_dev_generic",
870};
871
872U_BOOT_DRIVER(usb_dev_generic_drv) = {
873 .id = UCLASS_USB_DEV_GENERIC,
874 .name = "usb_dev_generic_drv",
875};