2 * (C) Copyright 2015 Google, Inc
3 * Written by Simon Glass <sjg@chromium.org>
5 * usb_match_device() modified from Linux kernel v4.0.
7 * SPDX-License-Identifier: GPL-2.0+
15 #include <dm/device-internal.h>
17 #include <dm/uclass-internal.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 extern bool usb_started; /* flag for the started/stopped USB status */
22 static bool asynch_allowed;
24 struct usb_uclass_priv {
25 int companion_device_count;
28 int usb_disable_asynch(int disable)
30 int old_value = asynch_allowed;
32 asynch_allowed = !disable;
36 int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
37 int length, int interval)
39 struct udevice *bus = udev->controller_dev;
40 struct dm_usb_ops *ops = usb_get_ops(bus);
45 return ops->interrupt(bus, udev, pipe, buffer, length, interval);
48 int submit_control_msg(struct usb_device *udev, unsigned long pipe,
49 void *buffer, int length, struct devrequest *setup)
51 struct udevice *bus = udev->controller_dev;
52 struct dm_usb_ops *ops = usb_get_ops(bus);
53 struct usb_uclass_priv *uc_priv = bus->uclass->priv;
59 err = ops->control(bus, udev, pipe, buffer, length, setup);
60 if (setup->request == USB_REQ_SET_FEATURE &&
61 setup->requesttype == USB_RT_PORT &&
62 setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) &&
64 /* Device handed over to companion after port reset */
65 uc_priv->companion_device_count++;
71 int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
74 struct udevice *bus = udev->controller_dev;
75 struct dm_usb_ops *ops = usb_get_ops(bus);
80 return ops->bulk(bus, udev, pipe, buffer, length);
83 struct int_queue *create_int_queue(struct usb_device *udev,
84 unsigned long pipe, int queuesize, int elementsize,
85 void *buffer, int interval)
87 struct udevice *bus = udev->controller_dev;
88 struct dm_usb_ops *ops = usb_get_ops(bus);
90 if (!ops->create_int_queue)
93 return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize,
97 void *poll_int_queue(struct usb_device *udev, struct int_queue *queue)
99 struct udevice *bus = udev->controller_dev;
100 struct dm_usb_ops *ops = usb_get_ops(bus);
102 if (!ops->poll_int_queue)
105 return ops->poll_int_queue(bus, udev, queue);
108 int destroy_int_queue(struct usb_device *udev, struct int_queue *queue)
110 struct udevice *bus = udev->controller_dev;
111 struct dm_usb_ops *ops = usb_get_ops(bus);
113 if (!ops->destroy_int_queue)
116 return ops->destroy_int_queue(bus, udev, queue);
119 int usb_alloc_device(struct usb_device *udev)
121 struct udevice *bus = udev->controller_dev;
122 struct dm_usb_ops *ops = usb_get_ops(bus);
124 /* This is only requird by some controllers - current XHCI */
125 if (!ops->alloc_device)
128 return ops->alloc_device(bus, udev);
131 int usb_reset_root_port(struct usb_device *udev)
133 struct udevice *bus = udev->controller_dev;
134 struct dm_usb_ops *ops = usb_get_ops(bus);
136 if (!ops->reset_root_port)
139 return ops->reset_root_port(bus, udev);
142 int usb_update_hub_device(struct usb_device *udev)
144 struct udevice *bus = udev->controller_dev;
145 struct dm_usb_ops *ops = usb_get_ops(bus);
147 if (!ops->update_hub_device)
150 return ops->update_hub_device(bus, udev);
153 int usb_get_max_xfer_size(struct usb_device *udev, size_t *size)
155 struct udevice *bus = udev->controller_dev;
156 struct dm_usb_ops *ops = usb_get_ops(bus);
158 if (!ops->get_max_xfer_size)
161 return ops->get_max_xfer_size(bus, size);
169 struct usb_uclass_priv *uc_priv;
172 /* De-activate any devices that have been activated */
173 ret = uclass_get(UCLASS_USB, &uc);
179 uclass_foreach_dev(bus, uc) {
180 ret = device_remove(bus, DM_REMOVE_NORMAL);
184 /* Locate root hub device */
185 device_find_first_child(bus, &rh);
188 * All USB devices are children of root hub.
189 * Unbinding root hub will unbind all of its children.
191 ret = device_unbind(rh);
197 ret = blk_unbind_all(IF_TYPE_USB);
201 #ifdef CONFIG_SANDBOX
204 /* Reset all enulation devices */
205 ret = uclass_get(UCLASS_USB_EMUL, &uc);
209 uclass_foreach_dev(dev, uc)
212 #ifdef CONFIG_USB_STORAGE
215 uc_priv->companion_device_count = 0;
221 static void usb_scan_bus(struct udevice *bus, bool recurse)
223 struct usb_bus_priv *priv;
227 priv = dev_get_uclass_priv(bus);
229 assert(recurse); /* TODO: Support non-recusive */
231 printf("scanning bus %d for devices... ", bus->seq);
233 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
235 printf("failed, error %d\n", ret);
236 else if (priv->next_addr == 0)
237 printf("No USB Device found\n");
239 printf("%d USB Device(s) found\n", priv->next_addr);
242 static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
244 uclass_foreach_dev(bus, uc) {
245 struct udevice *dev, *next;
247 if (!device_active(bus))
249 device_foreach_child_safe(dev, next, bus) {
250 if (!device_active(dev))
258 int controllers_initialized = 0;
259 struct usb_uclass_priv *uc_priv;
260 struct usb_bus_priv *priv;
268 ret = uclass_get(UCLASS_USB, &uc);
274 uclass_foreach_dev(bus, uc) {
275 /* init low_level USB */
276 printf("USB%d: ", count);
279 #ifdef CONFIG_SANDBOX
281 * For Sandbox, we need scan the device tree each time when we
282 * start the USB stack, in order to re-create the emulated USB
283 * devices and bind drivers for them before we actually do the
286 ret = dm_scan_fdt_dev(bus);
288 printf("Sandbox USB device scan failed (%d)\n", ret);
293 ret = device_probe(bus);
294 if (ret == -ENODEV) { /* No such device. */
295 puts("Port not available.\n");
296 controllers_initialized++;
300 if (ret) { /* Other error. */
301 printf("probe failed, error %d\n", ret);
304 controllers_initialized++;
309 * lowlevel init done, now scan the bus for devices i.e. search HUBs
310 * and configure them, first scan primary controllers.
312 uclass_foreach_dev(bus, uc) {
313 if (!device_active(bus))
316 priv = dev_get_uclass_priv(bus);
317 if (!priv->companion)
318 usb_scan_bus(bus, true);
322 * Now that the primary controllers have been scanned and have handed
323 * over any devices they do not understand to their companions, scan
324 * the companions if necessary.
326 if (uc_priv->companion_device_count) {
327 uclass_foreach_dev(bus, uc) {
328 if (!device_active(bus))
331 priv = dev_get_uclass_priv(bus);
333 usb_scan_bus(bus, true);
339 /* Remove any devices that were not found on this scan */
340 remove_inactive_children(uc, bus);
342 ret = uclass_get(UCLASS_USB_HUB, &uc);
345 remove_inactive_children(uc, bus);
347 /* if we were not able to find at least one working bus, bail out */
349 printf("No controllers found\n");
350 else if (controllers_initialized == 0)
351 printf("USB error: all controllers failed lowlevel init\n");
353 return usb_started ? 0 : -1;
357 * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed
358 * to support boards which use driver model for USB but not Ethernet, and want
359 * to use USB Ethernet.
361 * The #if clause is here to ensure that remains the only case.
363 #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER)
364 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
366 struct usb_device *udev;
369 if (!device_active(parent))
371 udev = dev_get_parent_priv(parent);
372 if (udev->devnum == devnum)
375 for (device_find_first_child(parent, &dev);
377 device_find_next_child(&dev)) {
378 udev = find_child_devnum(dev, devnum);
386 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
389 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
391 device_find_first_child(bus, &dev);
395 return find_child_devnum(dev, devnum);
399 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
401 struct usb_platdata *plat;
405 /* Find the old device and remove it */
406 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
409 ret = device_remove(dev, DM_REMOVE_NORMAL);
413 plat = dev_get_platdata(dev);
414 plat->init_type = USB_INIT_DEVICE;
415 ret = device_probe(dev);
418 *ctlrp = dev_get_priv(dev);
423 /* returns 0 if no match, 1 if match */
424 static int usb_match_device(const struct usb_device_descriptor *desc,
425 const struct usb_device_id *id)
427 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
428 id->idVendor != le16_to_cpu(desc->idVendor))
431 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
432 id->idProduct != le16_to_cpu(desc->idProduct))
435 /* No need to test id->bcdDevice_lo != 0, since 0 is never
436 greater than any unsigned number. */
437 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
438 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
442 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
445 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
446 (id->bDeviceClass != desc->bDeviceClass))
449 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
450 (id->bDeviceSubClass != desc->bDeviceSubClass))
453 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
454 (id->bDeviceProtocol != desc->bDeviceProtocol))
460 /* returns 0 if no match, 1 if match */
461 static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
462 const struct usb_interface_descriptor *int_desc,
463 const struct usb_device_id *id)
465 /* The interface class, subclass, protocol and number should never be
466 * checked for a match if the device class is Vendor Specific,
467 * unless the match record specifies the Vendor ID. */
468 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
469 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
470 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
471 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
472 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
473 USB_DEVICE_ID_MATCH_INT_NUMBER)))
476 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
477 (id->bInterfaceClass != int_desc->bInterfaceClass))
480 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
481 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
484 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
485 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
488 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
489 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
495 /* returns 0 if no match, 1 if match */
496 static int usb_match_one_id(struct usb_device_descriptor *desc,
497 struct usb_interface_descriptor *int_desc,
498 const struct usb_device_id *id)
500 if (!usb_match_device(desc, id))
503 return usb_match_one_id_intf(desc, int_desc, id);
507 * usb_find_and_bind_driver() - Find and bind the right USB driver
509 * This only looks at certain fields in the descriptor.
511 static int usb_find_and_bind_driver(struct udevice *parent,
512 struct usb_device_descriptor *desc,
513 struct usb_interface_descriptor *iface,
514 int bus_seq, int devnum,
515 struct udevice **devp)
517 struct usb_driver_entry *start, *entry;
523 debug("%s: Searching for driver\n", __func__);
524 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
525 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
526 for (entry = start; entry != start + n_ents; entry++) {
527 const struct usb_device_id *id;
529 const struct driver *drv;
530 struct usb_dev_platdata *plat;
532 for (id = entry->match; id->match_flags; id++) {
533 if (!usb_match_one_id(desc, iface, id))
538 * We could pass the descriptor to the driver as
539 * platdata (instead of NULL) and allow its bind()
540 * method to return -ENOENT if it doesn't support this
541 * device. That way we could continue the search to
542 * find another driver. For now this doesn't seem
543 * necesssary, so just bind the first match.
545 ret = device_bind(parent, drv, drv->name, NULL, -1,
549 debug("%s: Match found: %s\n", __func__, drv->name);
550 dev->driver_data = id->driver_info;
551 plat = dev_get_parent_platdata(dev);
558 /* Bind a generic driver so that the device can be used */
559 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
563 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
566 debug("%s: No match found: %d\n", __func__, ret);
571 * usb_find_child() - Find an existing device which matches our needs
575 static int usb_find_child(struct udevice *parent,
576 struct usb_device_descriptor *desc,
577 struct usb_interface_descriptor *iface,
578 struct udevice **devp)
583 for (device_find_first_child(parent, &dev);
585 device_find_next_child(&dev)) {
586 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
588 /* If this device is already in use, skip it */
589 if (device_active(dev))
591 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
592 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
593 if (usb_match_one_id(desc, iface, &plat->id)) {
602 int usb_scan_device(struct udevice *parent, int port,
603 enum usb_device_speed speed, struct udevice **devp)
606 bool created = false;
607 struct usb_dev_platdata *plat;
608 struct usb_bus_priv *priv;
609 struct usb_device *parent_udev;
611 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
612 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
615 memset(udev, '\0', sizeof(*udev));
616 udev->controller_dev = usb_get_bus(parent);
617 priv = dev_get_uclass_priv(udev->controller_dev);
620 * Somewhat nasty, this. We create a local device and use the normal
621 * USB stack to read its descriptor. Then we know what type of device
622 * to create for real.
624 * udev->dev is set to the parent, since we don't have a real device
625 * yet. The USB stack should not access udev.dev anyway, except perhaps
626 * to find the controller, and the controller will either be @parent,
627 * or some parent of @parent.
629 * Another option might be to create the device as a generic USB
630 * device, then morph it into the correct one when we know what it
631 * should be. This means that a generic USB device would morph into
632 * a network controller, or a USB flash stick, for example. However,
633 * we don't support such morphing and it isn't clear that it would
636 * Yet another option is to split out the USB stack parts of udev
637 * into something like a 'struct urb' (as Linux does) which can exist
638 * independently of any device. This feels cleaner, but calls for quite
639 * a big change to the USB stack.
641 * For now, the approach is to set up an empty udev, read its
642 * descriptor and assign it an address, then bind a real device and
643 * stash the resulting information into the device's parent
644 * platform data. Then when we probe it, usb_child_pre_probe() is called
645 * and it will pull the information out of the stash.
649 udev->devnum = priv->next_addr + 1;
651 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
652 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
653 dev_get_parent_priv(parent) : NULL;
654 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
655 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
658 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
659 debug("** usb_find_child returns %d\n", ret);
663 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
664 udev->controller_dev->seq,
670 plat = dev_get_parent_platdata(dev);
671 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
672 plat->devnum = udev->devnum;
675 ret = device_probe(dev);
677 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
689 * Detect if a USB device has been plugged or unplugged.
691 int usb_detect_change(void)
698 ret = uclass_get(UCLASS_USB_HUB, &uc);
702 uclass_foreach_dev(hub, uc) {
703 struct usb_device *udev;
706 if (!device_active(hub))
708 for (device_find_first_child(hub, &dev);
710 device_find_next_child(&dev)) {
711 struct usb_port_status status;
713 if (!device_active(dev))
716 udev = dev_get_parent_priv(dev);
717 if (usb_get_port_status(udev, udev->portnr, &status)
719 /* USB request failed */
722 if (le16_to_cpu(status.wPortChange) &
723 USB_PORT_STAT_C_CONNECTION)
731 static int usb_child_post_bind(struct udevice *dev)
733 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
736 if (!dev_of_valid(dev))
739 /* We only support matching a few things */
740 val = dev_read_u32_default(dev, "usb,device-class", -1);
742 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
743 plat->id.bDeviceClass = val;
745 val = dev_read_u32_default(dev, "usb,interface-class", -1);
747 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
748 plat->id.bInterfaceClass = val;
754 struct udevice *usb_get_bus(struct udevice *dev)
758 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
761 /* By design this cannot happen */
763 debug("USB HUB '%s' does not have a controller\n", dev->name);
769 int usb_child_pre_probe(struct udevice *dev)
771 struct usb_device *udev = dev_get_parent_priv(dev);
772 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
777 * Copy over all the values set in the on stack struct
778 * usb_device in usb_scan_device() to our final struct
779 * usb_device for this dev.
781 *udev = *(plat->udev);
782 /* And clear plat->udev as it will not be valid for long */
787 * This happens with devices which are explicitly bound
788 * instead of being discovered through usb_scan_device()
789 * such as sandbox emul devices.
792 udev->controller_dev = usb_get_bus(dev);
793 udev->devnum = plat->devnum;
796 * udev did not go through usb_scan_device(), so we need to
797 * select the config and read the config descriptors.
799 ret = usb_select_config(udev);
807 UCLASS_DRIVER(usb) = {
810 .flags = DM_UC_FLAG_SEQ_ALIAS,
811 .post_bind = dm_scan_fdt_dev,
812 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
813 .per_child_auto_alloc_size = sizeof(struct usb_device),
814 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
815 .child_post_bind = usb_child_post_bind,
816 .child_pre_probe = usb_child_pre_probe,
817 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
820 UCLASS_DRIVER(usb_dev_generic) = {
821 .id = UCLASS_USB_DEV_GENERIC,
822 .name = "usb_dev_generic",
825 U_BOOT_DRIVER(usb_dev_generic_drv) = {
826 .id = UCLASS_USB_DEV_GENERIC,
827 .name = "usb_dev_generic_drv",