1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2015 Google, Inc
6 * usb_match_device() modified from Linux kernel v4.0.
15 #include <dm/device-internal.h>
17 #include <dm/uclass-internal.h>
19 extern bool usb_started; /* flag for the started/stopped USB status */
20 static bool asynch_allowed;
22 struct usb_uclass_priv {
23 int companion_device_count;
26 int usb_lock_async(struct usb_device *udev, int lock)
28 struct udevice *bus = udev->controller_dev;
29 struct dm_usb_ops *ops = usb_get_ops(bus);
34 return ops->lock_async(bus, lock);
37 int usb_disable_asynch(int disable)
39 int old_value = asynch_allowed;
41 asynch_allowed = !disable;
45 int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
46 int length, int interval, bool nonblock)
48 struct udevice *bus = udev->controller_dev;
49 struct dm_usb_ops *ops = usb_get_ops(bus);
54 return ops->interrupt(bus, udev, pipe, buffer, length, interval,
58 int submit_control_msg(struct usb_device *udev, unsigned long pipe,
59 void *buffer, int length, struct devrequest *setup)
61 struct udevice *bus = udev->controller_dev;
62 struct dm_usb_ops *ops = usb_get_ops(bus);
63 struct usb_uclass_priv *uc_priv = bus->uclass->priv;
69 err = ops->control(bus, udev, pipe, buffer, length, setup);
70 if (setup->request == USB_REQ_SET_FEATURE &&
71 setup->requesttype == USB_RT_PORT &&
72 setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) &&
74 /* Device handed over to companion after port reset */
75 uc_priv->companion_device_count++;
81 int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
84 struct udevice *bus = udev->controller_dev;
85 struct dm_usb_ops *ops = usb_get_ops(bus);
90 return ops->bulk(bus, udev, pipe, buffer, length);
93 struct int_queue *create_int_queue(struct usb_device *udev,
94 unsigned long pipe, int queuesize, int elementsize,
95 void *buffer, int interval)
97 struct udevice *bus = udev->controller_dev;
98 struct dm_usb_ops *ops = usb_get_ops(bus);
100 if (!ops->create_int_queue)
103 return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize,
107 void *poll_int_queue(struct usb_device *udev, struct int_queue *queue)
109 struct udevice *bus = udev->controller_dev;
110 struct dm_usb_ops *ops = usb_get_ops(bus);
112 if (!ops->poll_int_queue)
115 return ops->poll_int_queue(bus, udev, queue);
118 int destroy_int_queue(struct usb_device *udev, struct int_queue *queue)
120 struct udevice *bus = udev->controller_dev;
121 struct dm_usb_ops *ops = usb_get_ops(bus);
123 if (!ops->destroy_int_queue)
126 return ops->destroy_int_queue(bus, udev, queue);
129 int usb_alloc_device(struct usb_device *udev)
131 struct udevice *bus = udev->controller_dev;
132 struct dm_usb_ops *ops = usb_get_ops(bus);
134 /* This is only requird by some controllers - current XHCI */
135 if (!ops->alloc_device)
138 return ops->alloc_device(bus, udev);
141 int usb_reset_root_port(struct usb_device *udev)
143 struct udevice *bus = udev->controller_dev;
144 struct dm_usb_ops *ops = usb_get_ops(bus);
146 if (!ops->reset_root_port)
149 return ops->reset_root_port(bus, udev);
152 int usb_update_hub_device(struct usb_device *udev)
154 struct udevice *bus = udev->controller_dev;
155 struct dm_usb_ops *ops = usb_get_ops(bus);
157 if (!ops->update_hub_device)
160 return ops->update_hub_device(bus, udev);
163 int usb_get_max_xfer_size(struct usb_device *udev, size_t *size)
165 struct udevice *bus = udev->controller_dev;
166 struct dm_usb_ops *ops = usb_get_ops(bus);
168 if (!ops->get_max_xfer_size)
171 return ops->get_max_xfer_size(bus, size);
179 struct usb_uclass_priv *uc_priv;
182 /* De-activate any devices that have been activated */
183 ret = uclass_get(UCLASS_USB, &uc);
189 uclass_foreach_dev(bus, uc) {
190 ret = device_remove(bus, DM_REMOVE_NORMAL);
194 /* Locate root hub device */
195 device_find_first_child(bus, &rh);
198 * All USB devices are children of root hub.
199 * Unbinding root hub will unbind all of its children.
201 ret = device_unbind(rh);
207 #ifdef CONFIG_USB_STORAGE
210 uc_priv->companion_device_count = 0;
216 static void usb_scan_bus(struct udevice *bus, bool recurse)
218 struct usb_bus_priv *priv;
222 priv = dev_get_uclass_priv(bus);
224 assert(recurse); /* TODO: Support non-recusive */
226 printf("scanning bus %s for devices... ", bus->name);
228 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
230 printf("failed, error %d\n", ret);
231 else if (priv->next_addr == 0)
232 printf("No USB Device found\n");
234 printf("%d USB Device(s) found\n", priv->next_addr);
237 static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
239 uclass_foreach_dev(bus, uc) {
240 struct udevice *dev, *next;
242 if (!device_active(bus))
244 device_foreach_child_safe(dev, next, bus) {
245 if (!device_active(dev))
253 int controllers_initialized = 0;
254 struct usb_uclass_priv *uc_priv;
255 struct usb_bus_priv *priv;
262 ret = uclass_get(UCLASS_USB, &uc);
268 uclass_foreach_dev(bus, uc) {
269 /* init low_level USB */
270 printf("Bus %s: ", bus->name);
272 #ifdef CONFIG_SANDBOX
274 * For Sandbox, we need scan the device tree each time when we
275 * start the USB stack, in order to re-create the emulated USB
276 * devices and bind drivers for them before we actually do the
279 ret = dm_scan_fdt_dev(bus);
281 printf("Sandbox USB device scan failed (%d)\n", ret);
286 ret = device_probe(bus);
287 if (ret == -ENODEV) { /* No such device. */
288 puts("Port not available.\n");
289 controllers_initialized++;
293 if (ret) { /* Other error. */
294 printf("probe failed, error %d\n", ret);
297 controllers_initialized++;
302 * lowlevel init done, now scan the bus for devices i.e. search HUBs
303 * and configure them, first scan primary controllers.
305 uclass_foreach_dev(bus, uc) {
306 if (!device_active(bus))
309 priv = dev_get_uclass_priv(bus);
310 if (!priv->companion)
311 usb_scan_bus(bus, true);
315 * Now that the primary controllers have been scanned and have handed
316 * over any devices they do not understand to their companions, scan
317 * the companions if necessary.
319 if (uc_priv->companion_device_count) {
320 uclass_foreach_dev(bus, uc) {
321 if (!device_active(bus))
324 priv = dev_get_uclass_priv(bus);
326 usb_scan_bus(bus, true);
332 /* Remove any devices that were not found on this scan */
333 remove_inactive_children(uc, bus);
335 ret = uclass_get(UCLASS_USB_HUB, &uc);
338 remove_inactive_children(uc, bus);
340 /* if we were not able to find at least one working bus, bail out */
341 if (controllers_initialized == 0)
342 printf("No working controllers found\n");
344 return usb_started ? 0 : -1;
349 * to support boards which use driver model for USB but not Ethernet, and want
350 * to use USB Ethernet.
352 * The #if clause is here to ensure that remains the only case.
354 #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER)
355 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
357 struct usb_device *udev;
360 if (!device_active(parent))
362 udev = dev_get_parent_priv(parent);
363 if (udev->devnum == devnum)
366 for (device_find_first_child(parent, &dev);
368 device_find_next_child(&dev)) {
369 udev = find_child_devnum(dev, devnum);
377 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
380 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
382 device_find_first_child(bus, &dev);
386 return find_child_devnum(dev, devnum);
390 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
392 struct usb_platdata *plat;
396 /* Find the old device and remove it */
397 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
400 ret = device_remove(dev, DM_REMOVE_NORMAL);
404 plat = dev_get_platdata(dev);
405 plat->init_type = USB_INIT_DEVICE;
406 ret = device_probe(dev);
409 *ctlrp = dev_get_priv(dev);
414 /* returns 0 if no match, 1 if match */
415 static int usb_match_device(const struct usb_device_descriptor *desc,
416 const struct usb_device_id *id)
418 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
419 id->idVendor != le16_to_cpu(desc->idVendor))
422 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
423 id->idProduct != le16_to_cpu(desc->idProduct))
426 /* No need to test id->bcdDevice_lo != 0, since 0 is never
427 greater than any unsigned number. */
428 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
429 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
432 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
433 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
436 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
437 (id->bDeviceClass != desc->bDeviceClass))
440 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
441 (id->bDeviceSubClass != desc->bDeviceSubClass))
444 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
445 (id->bDeviceProtocol != desc->bDeviceProtocol))
451 /* returns 0 if no match, 1 if match */
452 static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
453 const struct usb_interface_descriptor *int_desc,
454 const struct usb_device_id *id)
456 /* The interface class, subclass, protocol and number should never be
457 * checked for a match if the device class is Vendor Specific,
458 * unless the match record specifies the Vendor ID. */
459 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
460 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
461 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
462 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
463 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
464 USB_DEVICE_ID_MATCH_INT_NUMBER)))
467 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
468 (id->bInterfaceClass != int_desc->bInterfaceClass))
471 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
472 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
475 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
476 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
479 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
480 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
486 /* returns 0 if no match, 1 if match */
487 static int usb_match_one_id(struct usb_device_descriptor *desc,
488 struct usb_interface_descriptor *int_desc,
489 const struct usb_device_id *id)
491 if (!usb_match_device(desc, id))
494 return usb_match_one_id_intf(desc, int_desc, id);
497 static ofnode usb_get_ofnode(struct udevice *hub, int port)
502 if (!dev_has_of_node(hub))
503 return ofnode_null();
506 * The USB controller and its USB hub are two different udevices,
507 * but the device tree has only one node for both. Thus we are
508 * assigning this node to both udevices.
509 * If port is zero, the controller scans its root hub, thus we
510 * are using the same ofnode as the controller here.
513 return dev_ofnode(hub);
515 ofnode_for_each_subnode(node, dev_ofnode(hub)) {
516 if (ofnode_read_u32(node, "reg", ®))
523 return ofnode_null();
527 * usb_find_and_bind_driver() - Find and bind the right USB driver
529 * This only looks at certain fields in the descriptor.
531 static int usb_find_and_bind_driver(struct udevice *parent,
532 struct usb_device_descriptor *desc,
533 struct usb_interface_descriptor *iface,
534 int bus_seq, int devnum, int port,
535 struct udevice **devp)
537 struct usb_driver_entry *start, *entry;
541 ofnode node = usb_get_ofnode(parent, port);
544 debug("%s: Searching for driver\n", __func__);
545 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
546 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
547 for (entry = start; entry != start + n_ents; entry++) {
548 const struct usb_device_id *id;
550 const struct driver *drv;
551 struct usb_dev_platdata *plat;
553 for (id = entry->match; id->match_flags; id++) {
554 if (!usb_match_one_id(desc, iface, id))
559 * We could pass the descriptor to the driver as
560 * platdata (instead of NULL) and allow its bind()
561 * method to return -ENOENT if it doesn't support this
562 * device. That way we could continue the search to
563 * find another driver. For now this doesn't seem
564 * necesssary, so just bind the first match.
566 ret = device_bind_ofnode(parent, drv, drv->name, NULL,
570 debug("%s: Match found: %s\n", __func__, drv->name);
571 dev->driver_data = id->driver_info;
572 plat = dev_get_parent_platdata(dev);
579 /* Bind a generic driver so that the device can be used */
580 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
584 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
587 debug("%s: No match found: %d\n", __func__, ret);
592 * usb_find_child() - Find an existing device which matches our needs
596 static int usb_find_child(struct udevice *parent,
597 struct usb_device_descriptor *desc,
598 struct usb_interface_descriptor *iface,
599 struct udevice **devp)
604 for (device_find_first_child(parent, &dev);
606 device_find_next_child(&dev)) {
607 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
609 /* If this device is already in use, skip it */
610 if (device_active(dev))
612 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
613 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
614 if (usb_match_one_id(desc, iface, &plat->id)) {
623 int usb_scan_device(struct udevice *parent, int port,
624 enum usb_device_speed speed, struct udevice **devp)
627 bool created = false;
628 struct usb_dev_platdata *plat;
629 struct usb_bus_priv *priv;
630 struct usb_device *parent_udev;
632 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
633 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
636 memset(udev, '\0', sizeof(*udev));
637 udev->controller_dev = usb_get_bus(parent);
638 priv = dev_get_uclass_priv(udev->controller_dev);
641 * Somewhat nasty, this. We create a local device and use the normal
642 * USB stack to read its descriptor. Then we know what type of device
643 * to create for real.
645 * udev->dev is set to the parent, since we don't have a real device
646 * yet. The USB stack should not access udev.dev anyway, except perhaps
647 * to find the controller, and the controller will either be @parent,
648 * or some parent of @parent.
650 * Another option might be to create the device as a generic USB
651 * device, then morph it into the correct one when we know what it
652 * should be. This means that a generic USB device would morph into
653 * a network controller, or a USB flash stick, for example. However,
654 * we don't support such morphing and it isn't clear that it would
657 * Yet another option is to split out the USB stack parts of udev
658 * into something like a 'struct urb' (as Linux does) which can exist
659 * independently of any device. This feels cleaner, but calls for quite
660 * a big change to the USB stack.
662 * For now, the approach is to set up an empty udev, read its
663 * descriptor and assign it an address, then bind a real device and
664 * stash the resulting information into the device's parent
665 * platform data. Then when we probe it, usb_child_pre_probe() is called
666 * and it will pull the information out of the stash.
670 udev->devnum = priv->next_addr + 1;
672 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
673 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
674 dev_get_parent_priv(parent) : NULL;
675 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
676 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
679 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
680 debug("** usb_find_child returns %d\n", ret);
684 ret = usb_find_and_bind_driver(parent, &udev->descriptor,
686 udev->controller_dev->seq,
687 udev->devnum, port, &dev);
692 plat = dev_get_parent_platdata(dev);
693 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
694 plat->devnum = udev->devnum;
697 ret = device_probe(dev);
699 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
711 * Detect if a USB device has been plugged or unplugged.
713 int usb_detect_change(void)
720 ret = uclass_get(UCLASS_USB_HUB, &uc);
724 uclass_foreach_dev(hub, uc) {
725 struct usb_device *udev;
728 if (!device_active(hub))
730 for (device_find_first_child(hub, &dev);
732 device_find_next_child(&dev)) {
733 struct usb_port_status status;
735 if (!device_active(dev))
738 udev = dev_get_parent_priv(dev);
739 if (usb_get_port_status(udev, udev->portnr, &status)
741 /* USB request failed */
744 if (le16_to_cpu(status.wPortChange) &
745 USB_PORT_STAT_C_CONNECTION)
753 static int usb_child_post_bind(struct udevice *dev)
755 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
758 if (!dev_of_valid(dev))
761 /* We only support matching a few things */
762 val = dev_read_u32_default(dev, "usb,device-class", -1);
764 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
765 plat->id.bDeviceClass = val;
767 val = dev_read_u32_default(dev, "usb,interface-class", -1);
769 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
770 plat->id.bInterfaceClass = val;
776 struct udevice *usb_get_bus(struct udevice *dev)
780 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
783 /* By design this cannot happen */
785 debug("USB HUB '%s' does not have a controller\n", dev->name);
791 int usb_child_pre_probe(struct udevice *dev)
793 struct usb_device *udev = dev_get_parent_priv(dev);
794 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
799 * Copy over all the values set in the on stack struct
800 * usb_device in usb_scan_device() to our final struct
801 * usb_device for this dev.
803 *udev = *(plat->udev);
804 /* And clear plat->udev as it will not be valid for long */
809 * This happens with devices which are explicitly bound
810 * instead of being discovered through usb_scan_device()
811 * such as sandbox emul devices.
814 udev->controller_dev = usb_get_bus(dev);
815 udev->devnum = plat->devnum;
818 * udev did not go through usb_scan_device(), so we need to
819 * select the config and read the config descriptors.
821 ret = usb_select_config(udev);
829 UCLASS_DRIVER(usb) = {
832 .flags = DM_UC_FLAG_SEQ_ALIAS,
833 .post_bind = dm_scan_fdt_dev,
834 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
835 .per_child_auto_alloc_size = sizeof(struct usb_device),
836 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
837 .child_post_bind = usb_child_post_bind,
838 .child_pre_probe = usb_child_pre_probe,
839 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
842 UCLASS_DRIVER(usb_dev_generic) = {
843 .id = UCLASS_USB_DEV_GENERIC,
844 .name = "usb_dev_generic",
847 U_BOOT_DRIVER(usb_dev_generic_drv) = {
848 .id = UCLASS_USB_DEV_GENERIC,
849 .name = "usb_dev_generic_drv",