blob: a1cd0ad2d669b7c2fa04148cec104fcbe8aa99ea [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 Glass9b82eeb2015-03-25 12:21:59 -060011#include <common.h>
Simon Glass62b03cc2023-09-20 07:29:49 -060012#include <bootdev.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060013#include <dm.h>
14#include <errno.h>
Simon Glass0f2af882020-05-10 11:40:05 -060015#include <log.h>
Simon Glass2dd337a2015-09-02 17:24:58 -060016#include <memalign.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060017#include <usb.h>
18#include <dm/device-internal.h>
19#include <dm/lists.h>
Simon Glass9b82eeb2015-03-25 12:21:59 -060020#include <dm/uclass-internal.h>
21
Simon Glass9b82eeb2015-03-25 12:21:59 -060022static bool asynch_allowed;
23
Hans de Goedecebc5b72015-05-10 14:10:21 +020024struct usb_uclass_priv {
25 int companion_device_count;
26};
27
Marek Vasut118a9032020-04-06 14:29:44 +020028int usb_lock_async(struct usb_device *udev, int lock)
29{
30 struct udevice *bus = udev->controller_dev;
31 struct dm_usb_ops *ops = usb_get_ops(bus);
32
33 if (!ops->lock_async)
34 return -ENOSYS;
35
36 return ops->lock_async(bus, lock);
37}
38
Simon Glass9b82eeb2015-03-25 12:21:59 -060039int usb_disable_asynch(int disable)
40{
41 int old_value = asynch_allowed;
42
43 asynch_allowed = !disable;
44 return old_value;
45}
46
47int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
Michal Suchanek1c95b9f2019-08-18 10:55:27 +020048 int length, int interval, bool nonblock)
Simon Glass9b82eeb2015-03-25 12:21:59 -060049{
50 struct udevice *bus = udev->controller_dev;
51 struct dm_usb_ops *ops = usb_get_ops(bus);
52
53 if (!ops->interrupt)
54 return -ENOSYS;
55
Michal Suchanek1c95b9f2019-08-18 10:55:27 +020056 return ops->interrupt(bus, udev, pipe, buffer, length, interval,
57 nonblock);
Simon Glass9b82eeb2015-03-25 12:21:59 -060058}
59
60int submit_control_msg(struct usb_device *udev, unsigned long pipe,
61 void *buffer, int length, struct devrequest *setup)
62{
63 struct udevice *bus = udev->controller_dev;
64 struct dm_usb_ops *ops = usb_get_ops(bus);
Simon Glass95588622020-12-22 19:30:28 -070065 struct usb_uclass_priv *uc_priv = uclass_get_priv(bus->uclass);
Hans de Goedecebc5b72015-05-10 14:10:21 +020066 int err;
Simon Glass9b82eeb2015-03-25 12:21:59 -060067
68 if (!ops->control)
69 return -ENOSYS;
70
Hans de Goedecebc5b72015-05-10 14:10:21 +020071 err = ops->control(bus, udev, pipe, buffer, length, setup);
72 if (setup->request == USB_REQ_SET_FEATURE &&
73 setup->requesttype == USB_RT_PORT &&
74 setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) &&
75 err == -ENXIO) {
76 /* Device handed over to companion after port reset */
77 uc_priv->companion_device_count++;
78 }
79
80 return err;
Simon Glass9b82eeb2015-03-25 12:21:59 -060081}
82
83int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
84 int length)
85{
86 struct udevice *bus = udev->controller_dev;
87 struct dm_usb_ops *ops = usb_get_ops(bus);
88
89 if (!ops->bulk)
90 return -ENOSYS;
91
92 return ops->bulk(bus, udev, pipe, buffer, length);
93}
94
Hans de Goede0a7fa272015-05-10 14:10:18 +020095struct int_queue *create_int_queue(struct usb_device *udev,
96 unsigned long pipe, int queuesize, int elementsize,
97 void *buffer, int interval)
98{
99 struct udevice *bus = udev->controller_dev;
100 struct dm_usb_ops *ops = usb_get_ops(bus);
101
102 if (!ops->create_int_queue)
103 return NULL;
104
105 return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize,
106 buffer, interval);
107}
108
109void *poll_int_queue(struct usb_device *udev, struct int_queue *queue)
110{
111 struct udevice *bus = udev->controller_dev;
112 struct dm_usb_ops *ops = usb_get_ops(bus);
113
114 if (!ops->poll_int_queue)
115 return NULL;
116
117 return ops->poll_int_queue(bus, udev, queue);
118}
119
120int destroy_int_queue(struct usb_device *udev, struct int_queue *queue)
121{
122 struct udevice *bus = udev->controller_dev;
123 struct dm_usb_ops *ops = usb_get_ops(bus);
124
125 if (!ops->destroy_int_queue)
126 return -ENOSYS;
127
128 return ops->destroy_int_queue(bus, udev, queue);
129}
130
Simon Glass9b82eeb2015-03-25 12:21:59 -0600131int usb_alloc_device(struct usb_device *udev)
132{
133 struct udevice *bus = udev->controller_dev;
134 struct dm_usb_ops *ops = usb_get_ops(bus);
135
136 /* This is only requird by some controllers - current XHCI */
137 if (!ops->alloc_device)
138 return 0;
139
140 return ops->alloc_device(bus, udev);
141}
142
Hans de Goedea9e41f82015-06-17 21:33:52 +0200143int usb_reset_root_port(struct usb_device *udev)
144{
145 struct udevice *bus = udev->controller_dev;
146 struct dm_usb_ops *ops = usb_get_ops(bus);
147
148 if (!ops->reset_root_port)
149 return -ENOSYS;
150
151 return ops->reset_root_port(bus, udev);
152}
153
Bin Meng1f31f5a2017-07-19 21:51:17 +0800154int usb_update_hub_device(struct usb_device *udev)
155{
156 struct udevice *bus = udev->controller_dev;
157 struct dm_usb_ops *ops = usb_get_ops(bus);
158
159 if (!ops->update_hub_device)
160 return -ENOSYS;
161
162 return ops->update_hub_device(bus, udev);
163}
164
Bin Meng6840a342017-09-07 06:13:17 -0700165int usb_get_max_xfer_size(struct usb_device *udev, size_t *size)
166{
167 struct udevice *bus = udev->controller_dev;
168 struct dm_usb_ops *ops = usb_get_ops(bus);
169
170 if (!ops->get_max_xfer_size)
171 return -ENOSYS;
172
173 return ops->get_max_xfer_size(bus, size);
174}
175
Simon Glass9b82eeb2015-03-25 12:21:59 -0600176int usb_stop(void)
177{
178 struct udevice *bus;
Bin Meng669ad842017-10-01 06:19:42 -0700179 struct udevice *rh;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600180 struct uclass *uc;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200181 struct usb_uclass_priv *uc_priv;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600182 int err = 0, ret;
183
184 /* De-activate any devices that have been activated */
185 ret = uclass_get(UCLASS_USB, &uc);
186 if (ret)
187 return ret;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200188
Simon Glass95588622020-12-22 19:30:28 -0700189 uc_priv = uclass_get_priv(uc);
Hans de Goedecebc5b72015-05-10 14:10:21 +0200190
Simon Glass9b82eeb2015-03-25 12:21:59 -0600191 uclass_foreach_dev(bus, uc) {
Stefan Roese80b5bc92017-03-20 12:51:48 +0100192 ret = device_remove(bus, DM_REMOVE_NORMAL);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600193 if (ret && !err)
194 err = ret;
Bin Meng669ad842017-10-01 06:19:42 -0700195
196 /* Locate root hub device */
197 device_find_first_child(bus, &rh);
198 if (rh) {
199 /*
200 * All USB devices are children of root hub.
201 * Unbinding root hub will unbind all of its children.
202 */
203 ret = device_unbind(rh);
204 if (ret && !err)
205 err = ret;
206 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600207 }
Bin Mengdadc4c02017-10-01 06:19:43 -0700208
Paul Kocialkowskid449dd32015-08-04 17:04:12 +0200209#ifdef CONFIG_USB_STORAGE
Simon Glass9b82eeb2015-03-25 12:21:59 -0600210 usb_stor_reset();
Paul Kocialkowskid449dd32015-08-04 17:04:12 +0200211#endif
Simon Glass62b03cc2023-09-20 07:29:49 -0600212 if (CONFIG_IS_ENABLED(BOOTSTD)) {
213 int ret;
214
215 ret = bootdev_unhunt(UCLASS_USB);
216 if (IS_ENABLED(CONFIG_BOOTSTD_FULL) && ret && ret != -EALREADY)
217 printf("failed to unhunt USB (err=%dE)\n", ret);
218 }
Hans de Goedecebc5b72015-05-10 14:10:21 +0200219 uc_priv->companion_device_count = 0;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600220 usb_started = 0;
221
222 return err;
223}
224
Hans de Goedef8762f92015-05-10 14:10:19 +0200225static void usb_scan_bus(struct udevice *bus, bool recurse)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600226{
227 struct usb_bus_priv *priv;
228 struct udevice *dev;
229 int ret;
230
231 priv = dev_get_uclass_priv(bus);
232
233 assert(recurse); /* TODO: Support non-recusive */
234
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000235 printf("scanning bus %s for devices... ", bus->name);
Hans de Goedef8762f92015-05-10 14:10:19 +0200236 debug("\n");
Simon Glass9b82eeb2015-03-25 12:21:59 -0600237 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
238 if (ret)
Hans de Goedef8762f92015-05-10 14:10:19 +0200239 printf("failed, error %d\n", ret);
240 else if (priv->next_addr == 0)
241 printf("No USB Device found\n");
242 else
243 printf("%d USB Device(s) found\n", priv->next_addr);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600244}
245
Simon Glass35787d22015-11-08 23:48:00 -0700246static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
247{
248 uclass_foreach_dev(bus, uc) {
249 struct udevice *dev, *next;
250
251 if (!device_active(bus))
252 continue;
253 device_foreach_child_safe(dev, next, bus) {
254 if (!device_active(dev))
255 device_unbind(dev);
256 }
257 }
258}
259
Fabrice Gasnier7785aee2023-09-01 11:52:01 +0200260static int usb_probe_companion(struct udevice *bus)
261{
262 struct udevice *companion_dev;
263 int ret;
264
265 /*
266 * Enforce optional companion controller is marked as such in order to
267 * 1st scan the primary controller, before the companion controller
268 * (ownership is given to companion when low or full speed devices
269 * have been detected).
270 */
271 ret = uclass_get_device_by_phandle(UCLASS_USB, bus, "companion", &companion_dev);
272 if (!ret) {
273 struct usb_bus_priv *companion_bus_priv;
274
275 debug("%s is the companion of %s\n", companion_dev->name, bus->name);
276 companion_bus_priv = dev_get_uclass_priv(companion_dev);
277 companion_bus_priv->companion = true;
278 } else if (ret && ret != -ENOENT && ret != -ENODEV) {
279 /*
280 * Treat everything else than no companion or disabled
281 * companion as an error. (It may not be enabled on boards
282 * that have a High-Speed HUB to handle FS and LS traffic).
283 */
284 printf("Failed to get companion (ret=%d)\n", ret);
285 return ret;
286 }
287
288 return 0;
289}
290
Simon Glass9b82eeb2015-03-25 12:21:59 -0600291int usb_init(void)
292{
293 int controllers_initialized = 0;
Hans de Goedecebc5b72015-05-10 14:10:21 +0200294 struct usb_uclass_priv *uc_priv;
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200295 struct usb_bus_priv *priv;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600296 struct udevice *bus;
297 struct uclass *uc;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600298 int ret;
299
300 asynch_allowed = 1;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600301
302 ret = uclass_get(UCLASS_USB, &uc);
303 if (ret)
304 return ret;
305
Simon Glass95588622020-12-22 19:30:28 -0700306 uc_priv = uclass_get_priv(uc);
Hans de Goedecebc5b72015-05-10 14:10:21 +0200307
Simon Glass9b82eeb2015-03-25 12:21:59 -0600308 uclass_foreach_dev(bus, uc) {
309 /* init low_level USB */
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000310 printf("Bus %s: ", bus->name);
Bin Meng669ad842017-10-01 06:19:42 -0700311
Bin Meng669ad842017-10-01 06:19:42 -0700312 /*
313 * For Sandbox, we need scan the device tree each time when we
314 * start the USB stack, in order to re-create the emulated USB
315 * devices and bind drivers for them before we actually do the
316 * driver probe.
Fabrice Gasniercd809b12022-12-12 11:44:35 +0100317 *
318 * For USB onboard HUB, we need to do some non-trivial init
319 * like enabling a power regulator, before enumeration.
Bin Meng669ad842017-10-01 06:19:42 -0700320 */
Fabrice Gasniercd809b12022-12-12 11:44:35 +0100321 if (IS_ENABLED(CONFIG_SANDBOX) ||
322 IS_ENABLED(CONFIG_USB_ONBOARD_HUB)) {
323 ret = dm_scan_fdt_dev(bus);
324 if (ret) {
325 printf("USB device scan from fdt failed (%d)", ret);
326 continue;
327 }
Bin Meng669ad842017-10-01 06:19:42 -0700328 }
Bin Meng669ad842017-10-01 06:19:42 -0700329
Simon Glass9b82eeb2015-03-25 12:21:59 -0600330 ret = device_probe(bus);
331 if (ret == -ENODEV) { /* No such device. */
332 puts("Port not available.\n");
333 controllers_initialized++;
334 continue;
335 }
336
337 if (ret) { /* Other error. */
338 printf("probe failed, error %d\n", ret);
339 continue;
340 }
Fabrice Gasnier7785aee2023-09-01 11:52:01 +0200341
342 ret = usb_probe_companion(bus);
343 if (ret)
344 continue;
345
Simon Glass9b82eeb2015-03-25 12:21:59 -0600346 controllers_initialized++;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600347 usb_started = true;
348 }
349
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200350 /*
351 * lowlevel init done, now scan the bus for devices i.e. search HUBs
352 * and configure them, first scan primary controllers.
353 */
354 uclass_foreach_dev(bus, uc) {
355 if (!device_active(bus))
356 continue;
357
358 priv = dev_get_uclass_priv(bus);
359 if (!priv->companion)
360 usb_scan_bus(bus, true);
361 }
362
363 /*
364 * Now that the primary controllers have been scanned and have handed
365 * over any devices they do not understand to their companions, scan
Hans de Goedecebc5b72015-05-10 14:10:21 +0200366 * the companions if necessary.
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200367 */
Hans de Goedecebc5b72015-05-10 14:10:21 +0200368 if (uc_priv->companion_device_count) {
369 uclass_foreach_dev(bus, uc) {
370 if (!device_active(bus))
371 continue;
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200372
Hans de Goedecebc5b72015-05-10 14:10:21 +0200373 priv = dev_get_uclass_priv(bus);
374 if (priv->companion)
375 usb_scan_bus(bus, true);
376 }
Hans de Goede59a0dfc2015-05-10 14:10:20 +0200377 }
378
Simon Glass9b82eeb2015-03-25 12:21:59 -0600379 debug("scan end\n");
Simon Glass35787d22015-11-08 23:48:00 -0700380
381 /* Remove any devices that were not found on this scan */
382 remove_inactive_children(uc, bus);
383
384 ret = uclass_get(UCLASS_USB_HUB, &uc);
385 if (ret)
386 return ret;
387 remove_inactive_children(uc, bus);
388
Simon Glass9b82eeb2015-03-25 12:21:59 -0600389 /* if we were not able to find at least one working bus, bail out */
Ismael Luceno Cortesf58affe2019-03-19 09:19:44 +0000390 if (controllers_initialized == 0)
391 printf("No working controllers found\n");
Simon Glass9b82eeb2015-03-25 12:21:59 -0600392
Simon Glassac746082023-07-30 11:15:12 -0600393 return usb_started ? 0 : -ENOENT;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600394}
395
Simon Glass444b1e02015-03-25 12:22:32 -0600396int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
397{
Simon Glassb75b15b2020-12-03 16:55:23 -0700398 struct usb_plat *plat;
Simon Glass444b1e02015-03-25 12:22:32 -0600399 struct udevice *dev;
400 int ret;
401
402 /* Find the old device and remove it */
Sean Andersone7665702021-11-05 12:52:55 -0400403 ret = uclass_find_first_device(UCLASS_USB, &dev);
Simon Glass444b1e02015-03-25 12:22:32 -0600404 if (ret)
405 return ret;
Stefan Roese80b5bc92017-03-20 12:51:48 +0100406 ret = device_remove(dev, DM_REMOVE_NORMAL);
Simon Glass444b1e02015-03-25 12:22:32 -0600407 if (ret)
408 return ret;
409
Simon Glassfa20e932020-12-03 16:55:20 -0700410 plat = dev_get_plat(dev);
Simon Glass444b1e02015-03-25 12:22:32 -0600411 plat->init_type = USB_INIT_DEVICE;
412 ret = device_probe(dev);
413 if (ret)
414 return ret;
415 *ctlrp = dev_get_priv(dev);
416
417 return 0;
418}
419
Ye Li68801eb2020-06-29 10:12:59 +0800420int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp)
421{
422 struct udevice *dev;
423 int ret;
424
425 /* Find the old device and remove it */
Sean Andersone7665702021-11-05 12:52:55 -0400426 ret = uclass_find_first_device(UCLASS_USB, &dev);
Ye Li68801eb2020-06-29 10:12:59 +0800427 if (ret)
428 return ret;
429 ret = device_remove(dev, DM_REMOVE_NORMAL);
430 if (ret)
431 return ret;
432
433 *ctlrp = NULL;
434
435 return 0;
436}
437
Simon Glassfc03a552015-03-25 12:22:30 -0600438/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900439static int usb_match_device(const struct usb_device_descriptor *desc,
440 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600441{
442 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200443 id->idVendor != desc->idVendor)
Simon Glassfc03a552015-03-25 12:22:30 -0600444 return 0;
445
446 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200447 id->idProduct != desc->idProduct)
Simon Glassfc03a552015-03-25 12:22:30 -0600448 return 0;
449
450 /* No need to test id->bcdDevice_lo != 0, since 0 is never
451 greater than any unsigned number. */
452 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200453 (id->bcdDevice_lo > desc->bcdDevice))
Simon Glassfc03a552015-03-25 12:22:30 -0600454 return 0;
455
456 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
Stefan Roese77c83ac2020-07-21 10:46:04 +0200457 (id->bcdDevice_hi < desc->bcdDevice))
Simon Glassfc03a552015-03-25 12:22:30 -0600458 return 0;
459
460 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
461 (id->bDeviceClass != desc->bDeviceClass))
462 return 0;
463
464 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
465 (id->bDeviceSubClass != desc->bDeviceSubClass))
466 return 0;
467
468 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
469 (id->bDeviceProtocol != desc->bDeviceProtocol))
470 return 0;
471
472 return 1;
473}
474
475/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900476static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
477 const struct usb_interface_descriptor *int_desc,
478 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600479{
480 /* The interface class, subclass, protocol and number should never be
481 * checked for a match if the device class is Vendor Specific,
482 * unless the match record specifies the Vendor ID. */
483 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
484 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
485 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
486 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
487 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
488 USB_DEVICE_ID_MATCH_INT_NUMBER)))
489 return 0;
490
491 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
492 (id->bInterfaceClass != int_desc->bInterfaceClass))
493 return 0;
494
495 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
496 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
497 return 0;
498
499 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
500 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
501 return 0;
502
503 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
504 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
505 return 0;
506
507 return 1;
508}
509
510/* returns 0 if no match, 1 if match */
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900511static int usb_match_one_id(struct usb_device_descriptor *desc,
512 struct usb_interface_descriptor *int_desc,
513 const struct usb_device_id *id)
Simon Glassfc03a552015-03-25 12:22:30 -0600514{
515 if (!usb_match_device(desc, id))
516 return 0;
517
518 return usb_match_one_id_intf(desc, int_desc, id);
519}
520
Michael Walle7c961322020-06-02 01:47:07 +0200521static ofnode usb_get_ofnode(struct udevice *hub, int port)
522{
523 ofnode node;
524 u32 reg;
525
Simon Glass07c17772020-12-19 10:40:12 -0700526 if (!dev_has_ofnode(hub))
Michael Walle7c961322020-06-02 01:47:07 +0200527 return ofnode_null();
528
529 /*
530 * The USB controller and its USB hub are two different udevices,
531 * but the device tree has only one node for both. Thus we are
532 * assigning this node to both udevices.
533 * If port is zero, the controller scans its root hub, thus we
534 * are using the same ofnode as the controller here.
535 */
536 if (!port)
537 return dev_ofnode(hub);
538
539 ofnode_for_each_subnode(node, dev_ofnode(hub)) {
540 if (ofnode_read_u32(node, "reg", &reg))
541 continue;
542
543 if (reg == port)
544 return node;
545 }
546
547 return ofnode_null();
548}
549
Simon Glassfc03a552015-03-25 12:22:30 -0600550/**
551 * usb_find_and_bind_driver() - Find and bind the right USB driver
552 *
553 * This only looks at certain fields in the descriptor.
554 */
555static int usb_find_and_bind_driver(struct udevice *parent,
556 struct usb_device_descriptor *desc,
557 struct usb_interface_descriptor *iface,
Michael Walle7c961322020-06-02 01:47:07 +0200558 int bus_seq, int devnum, int port,
Simon Glassfc03a552015-03-25 12:22:30 -0600559 struct udevice **devp)
560{
561 struct usb_driver_entry *start, *entry;
562 int n_ents;
563 int ret;
Marek Vasut6e76b0f2022-11-26 13:57:53 +0100564 char name[34], *str;
Michael Walle7c961322020-06-02 01:47:07 +0200565 ofnode node = usb_get_ofnode(parent, port);
Simon Glassfc03a552015-03-25 12:22:30 -0600566
567 *devp = NULL;
568 debug("%s: Searching for driver\n", __func__);
569 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
570 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
571 for (entry = start; entry != start + n_ents; entry++) {
572 const struct usb_device_id *id;
573 struct udevice *dev;
574 const struct driver *drv;
Simon Glassb75b15b2020-12-03 16:55:23 -0700575 struct usb_dev_plat *plat;
Simon Glassfc03a552015-03-25 12:22:30 -0600576
577 for (id = entry->match; id->match_flags; id++) {
578 if (!usb_match_one_id(desc, iface, id))
579 continue;
580
581 drv = entry->driver;
582 /*
583 * We could pass the descriptor to the driver as
Simon Glass71fa5b42020-12-03 16:55:18 -0700584 * plat (instead of NULL) and allow its bind()
Simon Glassfc03a552015-03-25 12:22:30 -0600585 * method to return -ENOENT if it doesn't support this
586 * device. That way we could continue the search to
587 * find another driver. For now this doesn't seem
588 * necesssary, so just bind the first match.
589 */
Simon Glass884870f2020-11-28 17:50:01 -0700590 ret = device_bind(parent, drv, drv->name, NULL, node,
591 &dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600592 if (ret)
593 goto error;
594 debug("%s: Match found: %s\n", __func__, drv->name);
595 dev->driver_data = id->driver_info;
Simon Glass71fa5b42020-12-03 16:55:18 -0700596 plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600597 plat->id = *id;
598 *devp = dev;
599 return 0;
600 }
601 }
602
Simon Glassc79173e2015-03-25 12:22:31 -0600603 /* Bind a generic driver so that the device can be used */
604 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
605 str = strdup(name);
606 if (!str)
607 return -ENOMEM;
608 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
Simon Glass4d2c3592023-01-17 10:47:35 -0700609 if (!ret)
610 device_set_name_alloced(*devp);
Simon Glassc79173e2015-03-25 12:22:31 -0600611
Simon Glassfc03a552015-03-25 12:22:30 -0600612error:
613 debug("%s: No match found: %d\n", __func__, ret);
614 return ret;
615}
616
617/**
Simon Glassd43d7e92015-11-08 23:47:56 -0700618 * usb_find_child() - Find an existing device which matches our needs
619 *
620 *
Simon Glassfc03a552015-03-25 12:22:30 -0600621 */
Simon Glassd43d7e92015-11-08 23:47:56 -0700622static int usb_find_child(struct udevice *parent,
623 struct usb_device_descriptor *desc,
624 struct usb_interface_descriptor *iface,
625 struct udevice **devp)
Simon Glassfc03a552015-03-25 12:22:30 -0600626{
627 struct udevice *dev;
628
629 *devp = NULL;
630 for (device_find_first_child(parent, &dev);
631 dev;
632 device_find_next_child(&dev)) {
Simon Glassb75b15b2020-12-03 16:55:23 -0700633 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600634
635 /* If this device is already in use, skip it */
636 if (device_active(dev))
637 continue;
638 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
639 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
640 if (usb_match_one_id(desc, iface, &plat->id)) {
641 *devp = dev;
642 return 0;
643 }
644 }
Simon Glassd43d7e92015-11-08 23:47:56 -0700645
Simon Glassfc03a552015-03-25 12:22:30 -0600646 return -ENOENT;
647}
648
Simon Glass9b82eeb2015-03-25 12:21:59 -0600649int usb_scan_device(struct udevice *parent, int port,
650 enum usb_device_speed speed, struct udevice **devp)
651{
652 struct udevice *dev;
653 bool created = false;
Simon Glassb75b15b2020-12-03 16:55:23 -0700654 struct usb_dev_plat *plat;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600655 struct usb_bus_priv *priv;
656 struct usb_device *parent_udev;
657 int ret;
658 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
659 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
660
661 *devp = NULL;
662 memset(udev, '\0', sizeof(*udev));
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200663 udev->controller_dev = usb_get_bus(parent);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600664 priv = dev_get_uclass_priv(udev->controller_dev);
665
666 /*
667 * Somewhat nasty, this. We create a local device and use the normal
668 * USB stack to read its descriptor. Then we know what type of device
669 * to create for real.
670 *
671 * udev->dev is set to the parent, since we don't have a real device
672 * yet. The USB stack should not access udev.dev anyway, except perhaps
673 * to find the controller, and the controller will either be @parent,
674 * or some parent of @parent.
675 *
676 * Another option might be to create the device as a generic USB
677 * device, then morph it into the correct one when we know what it
678 * should be. This means that a generic USB device would morph into
679 * a network controller, or a USB flash stick, for example. However,
680 * we don't support such morphing and it isn't clear that it would
681 * be easy to do.
682 *
683 * Yet another option is to split out the USB stack parts of udev
684 * into something like a 'struct urb' (as Linux does) which can exist
685 * independently of any device. This feels cleaner, but calls for quite
686 * a big change to the USB stack.
687 *
688 * For now, the approach is to set up an empty udev, read its
689 * descriptor and assign it an address, then bind a real device and
690 * stash the resulting information into the device's parent
691 * platform data. Then when we probe it, usb_child_pre_probe() is called
692 * and it will pull the information out of the stash.
693 */
694 udev->dev = parent;
695 udev->speed = speed;
696 udev->devnum = priv->next_addr + 1;
697 udev->portnr = port;
698 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
699 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
Simon Glassde44acf2015-09-28 23:32:01 -0600700 dev_get_parent_priv(parent) : NULL;
Hans de Goede778dc1c2015-06-17 21:33:46 +0200701 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600702 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
703 if (ret)
704 return ret;
Simon Glassd43d7e92015-11-08 23:47:56 -0700705 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
706 debug("** usb_find_child returns %d\n", ret);
Simon Glassfc03a552015-03-25 12:22:30 -0600707 if (ret) {
708 if (ret != -ENOENT)
709 return ret;
Michael Walle7c961322020-06-02 01:47:07 +0200710 ret = usb_find_and_bind_driver(parent, &udev->descriptor,
711 iface,
Simon Glass75e534b2020-12-16 21:20:07 -0700712 dev_seq(udev->controller_dev),
Michael Walle7c961322020-06-02 01:47:07 +0200713 udev->devnum, port, &dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600714 if (ret)
715 return ret;
716 created = true;
717 }
Simon Glass71fa5b42020-12-03 16:55:18 -0700718 plat = dev_get_parent_plat(dev);
Simon Glassfc03a552015-03-25 12:22:30 -0600719 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
720 plat->devnum = udev->devnum;
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200721 plat->udev = udev;
Simon Glassfc03a552015-03-25 12:22:30 -0600722 priv->next_addr++;
723 ret = device_probe(dev);
724 if (ret) {
725 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
726 priv->next_addr--;
727 if (created)
728 device_unbind(dev);
729 return ret;
730 }
731 *devp = dev;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600732
Simon Glassfc03a552015-03-25 12:22:30 -0600733 return 0;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600734}
735
Simon Glassfbb14942015-05-13 07:02:23 -0600736/*
737 * Detect if a USB device has been plugged or unplugged.
738 */
739int usb_detect_change(void)
740{
741 struct udevice *hub;
742 struct uclass *uc;
743 int change = 0;
744 int ret;
745
746 ret = uclass_get(UCLASS_USB_HUB, &uc);
747 if (ret)
748 return ret;
749
750 uclass_foreach_dev(hub, uc) {
751 struct usb_device *udev;
752 struct udevice *dev;
753
754 if (!device_active(hub))
755 continue;
756 for (device_find_first_child(hub, &dev);
757 dev;
758 device_find_next_child(&dev)) {
759 struct usb_port_status status;
760
761 if (!device_active(dev))
762 continue;
763
Simon Glassde44acf2015-09-28 23:32:01 -0600764 udev = dev_get_parent_priv(dev);
Simon Glassfbb14942015-05-13 07:02:23 -0600765 if (usb_get_port_status(udev, udev->portnr, &status)
766 < 0)
767 /* USB request failed */
768 continue;
769
770 if (le16_to_cpu(status.wPortChange) &
771 USB_PORT_STAT_C_CONNECTION)
772 change++;
773 }
774 }
775
776 return change;
777}
778
Masahiro Yamada6d8e4332017-06-22 16:35:14 +0900779static int usb_child_post_bind(struct udevice *dev)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600780{
Simon Glassb75b15b2020-12-03 16:55:23 -0700781 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600782 int val;
783
Simon Glassf1d50f72020-12-19 10:40:13 -0700784 if (!dev_has_ofnode(dev))
Simon Glass9b82eeb2015-03-25 12:21:59 -0600785 return 0;
786
787 /* We only support matching a few things */
Simon Glass6deb8e22017-05-18 20:09:38 -0600788 val = dev_read_u32_default(dev, "usb,device-class", -1);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600789 if (val != -1) {
790 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
791 plat->id.bDeviceClass = val;
792 }
Simon Glass6deb8e22017-05-18 20:09:38 -0600793 val = dev_read_u32_default(dev, "usb,interface-class", -1);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600794 if (val != -1) {
795 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
796 plat->id.bInterfaceClass = val;
797 }
798
799 return 0;
800}
801
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200802struct udevice *usb_get_bus(struct udevice *dev)
Simon Glass9b82eeb2015-03-25 12:21:59 -0600803{
804 struct udevice *bus;
805
Simon Glass9b82eeb2015-03-25 12:21:59 -0600806 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
807 bus = bus->parent;
808 if (!bus) {
809 /* By design this cannot happen */
810 assert(bus);
811 debug("USB HUB '%s' does not have a controller\n", dev->name);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600812 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600813
Hans de Goede3b5ddd32015-05-05 11:54:31 +0200814 return bus;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600815}
816
817int usb_child_pre_probe(struct udevice *dev)
818{
Simon Glassde44acf2015-09-28 23:32:01 -0600819 struct usb_device *udev = dev_get_parent_priv(dev);
Simon Glassb75b15b2020-12-03 16:55:23 -0700820 struct usb_dev_plat *plat = dev_get_parent_plat(dev);
Simon Glass9b82eeb2015-03-25 12:21:59 -0600821 int ret;
822
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200823 if (plat->udev) {
824 /*
825 * Copy over all the values set in the on stack struct
826 * usb_device in usb_scan_device() to our final struct
827 * usb_device for this dev.
828 */
829 *udev = *(plat->udev);
830 /* And clear plat->udev as it will not be valid for long */
831 plat->udev = NULL;
832 udev->dev = dev;
833 } else {
834 /*
835 * This happens with devices which are explicitly bound
836 * instead of being discovered through usb_scan_device()
837 * such as sandbox emul devices.
838 */
839 udev->dev = dev;
840 udev->controller_dev = usb_get_bus(dev);
841 udev->devnum = plat->devnum;
Simon Glass9b82eeb2015-03-25 12:21:59 -0600842
Hans de Goede8a0b4c22015-05-05 11:54:32 +0200843 /*
844 * udev did not go through usb_scan_device(), so we need to
845 * select the config and read the config descriptors.
846 */
847 ret = usb_select_config(udev);
848 if (ret)
849 return ret;
850 }
Simon Glass9b82eeb2015-03-25 12:21:59 -0600851
852 return 0;
853}
854
855UCLASS_DRIVER(usb) = {
856 .id = UCLASS_USB,
857 .name = "usb",
858 .flags = DM_UC_FLAG_SEQ_ALIAS,
Simon Glass18230342016-07-05 17:10:10 -0600859 .post_bind = dm_scan_fdt_dev,
Simon Glass8a2b47f2020-12-03 16:55:17 -0700860 .priv_auto = sizeof(struct usb_uclass_priv),
861 .per_child_auto = sizeof(struct usb_device),
862 .per_device_auto = sizeof(struct usb_bus_priv),
Simon Glass9b82eeb2015-03-25 12:21:59 -0600863 .child_post_bind = usb_child_post_bind,
864 .child_pre_probe = usb_child_pre_probe,
Simon Glassb75b15b2020-12-03 16:55:23 -0700865 .per_child_plat_auto = sizeof(struct usb_dev_plat),
Simon Glass9b82eeb2015-03-25 12:21:59 -0600866};
Simon Glassc79173e2015-03-25 12:22:31 -0600867
868UCLASS_DRIVER(usb_dev_generic) = {
869 .id = UCLASS_USB_DEV_GENERIC,
870 .name = "usb_dev_generic",
871};
872
873U_BOOT_DRIVER(usb_dev_generic_drv) = {
874 .id = UCLASS_USB_DEV_GENERIC,
875 .name = "usb_dev_generic_drv",
876};