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 #ifdef CONFIG_SANDBOX
200 /* Reset all enulation devices */
201 ret = uclass_get(UCLASS_USB_EMUL, &uc);
205 uclass_foreach_dev(dev, uc)
208 #ifdef CONFIG_USB_STORAGE
211 uc_priv->companion_device_count = 0;
217 static void usb_scan_bus(struct udevice *bus, bool recurse)
219 struct usb_bus_priv *priv;
223 priv = dev_get_uclass_priv(bus);
225 assert(recurse); /* TODO: Support non-recusive */
227 printf("scanning bus %d for devices... ", bus->seq);
229 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
231 printf("failed, error %d\n", ret);
232 else if (priv->next_addr == 0)
233 printf("No USB Device found\n");
235 printf("%d USB Device(s) found\n", priv->next_addr);
238 static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
240 uclass_foreach_dev(bus, uc) {
241 struct udevice *dev, *next;
243 if (!device_active(bus))
245 device_foreach_child_safe(dev, next, bus) {
246 if (!device_active(dev))
254 int controllers_initialized = 0;
255 struct usb_uclass_priv *uc_priv;
256 struct usb_bus_priv *priv;
264 ret = uclass_get(UCLASS_USB, &uc);
270 uclass_foreach_dev(bus, uc) {
271 /* init low_level USB */
272 printf("USB%d: ", count);
275 #ifdef CONFIG_SANDBOX
277 * For Sandbox, we need scan the device tree each time when we
278 * start the USB stack, in order to re-create the emulated USB
279 * devices and bind drivers for them before we actually do the
282 ret = dm_scan_fdt_dev(bus);
284 printf("Sandbox USB device scan failed (%d)\n", ret);
289 ret = device_probe(bus);
290 if (ret == -ENODEV) { /* No such device. */
291 puts("Port not available.\n");
292 controllers_initialized++;
296 if (ret) { /* Other error. */
297 printf("probe failed, error %d\n", ret);
300 controllers_initialized++;
305 * lowlevel init done, now scan the bus for devices i.e. search HUBs
306 * and configure them, first scan primary controllers.
308 uclass_foreach_dev(bus, uc) {
309 if (!device_active(bus))
312 priv = dev_get_uclass_priv(bus);
313 if (!priv->companion)
314 usb_scan_bus(bus, true);
318 * Now that the primary controllers have been scanned and have handed
319 * over any devices they do not understand to their companions, scan
320 * the companions if necessary.
322 if (uc_priv->companion_device_count) {
323 uclass_foreach_dev(bus, uc) {
324 if (!device_active(bus))
327 priv = dev_get_uclass_priv(bus);
329 usb_scan_bus(bus, true);
335 /* Remove any devices that were not found on this scan */
336 remove_inactive_children(uc, bus);
338 ret = uclass_get(UCLASS_USB_HUB, &uc);
341 remove_inactive_children(uc, bus);
343 /* if we were not able to find at least one working bus, bail out */
345 printf("No controllers found\n");
346 else if (controllers_initialized == 0)
347 printf("USB error: all controllers failed lowlevel init\n");
349 return usb_started ? 0 : -1;
353 * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed
354 * to support boards which use driver model for USB but not Ethernet, and want
355 * to use USB Ethernet.
357 * The #if clause is here to ensure that remains the only case.
359 #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER)
360 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
362 struct usb_device *udev;
365 if (!device_active(parent))
367 udev = dev_get_parent_priv(parent);
368 if (udev->devnum == devnum)
371 for (device_find_first_child(parent, &dev);
373 device_find_next_child(&dev)) {
374 udev = find_child_devnum(dev, devnum);
382 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
385 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
387 device_find_first_child(bus, &dev);
391 return find_child_devnum(dev, devnum);
395 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
397 struct usb_platdata *plat;
401 /* Find the old device and remove it */
402 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
405 ret = device_remove(dev, DM_REMOVE_NORMAL);
409 plat = dev_get_platdata(dev);
410 plat->init_type = USB_INIT_DEVICE;
411 ret = device_probe(dev);
414 *ctlrp = dev_get_priv(dev);
419 /* returns 0 if no match, 1 if match */
420 static int usb_match_device(const struct usb_device_descriptor *desc,
421 const struct usb_device_id *id)
423 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
424 id->idVendor != le16_to_cpu(desc->idVendor))
427 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
428 id->idProduct != le16_to_cpu(desc->idProduct))
431 /* No need to test id->bcdDevice_lo != 0, since 0 is never
432 greater than any unsigned number. */
433 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
434 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
437 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
438 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
442 (id->bDeviceClass != desc->bDeviceClass))
445 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
446 (id->bDeviceSubClass != desc->bDeviceSubClass))
449 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
450 (id->bDeviceProtocol != desc->bDeviceProtocol))
456 /* returns 0 if no match, 1 if match */
457 static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
458 const struct usb_interface_descriptor *int_desc,
459 const struct usb_device_id *id)
461 /* The interface class, subclass, protocol and number should never be
462 * checked for a match if the device class is Vendor Specific,
463 * unless the match record specifies the Vendor ID. */
464 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
465 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
466 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
467 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
468 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
469 USB_DEVICE_ID_MATCH_INT_NUMBER)))
472 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
473 (id->bInterfaceClass != int_desc->bInterfaceClass))
476 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
477 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
480 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
481 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
484 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
485 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
491 /* returns 0 if no match, 1 if match */
492 static int usb_match_one_id(struct usb_device_descriptor *desc,
493 struct usb_interface_descriptor *int_desc,
494 const struct usb_device_id *id)
496 if (!usb_match_device(desc, id))
499 return usb_match_one_id_intf(desc, int_desc, id);
503 * usb_find_and_bind_driver() - Find and bind the right USB driver
505 * This only looks at certain fields in the descriptor.
507 static int usb_find_and_bind_driver(struct udevice *parent,
508 struct usb_device_descriptor *desc,
509 struct usb_interface_descriptor *iface,
510 int bus_seq, int devnum,
511 struct udevice **devp)
513 struct usb_driver_entry *start, *entry;
519 debug("%s: Searching for driver\n", __func__);
520 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
521 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
522 for (entry = start; entry != start + n_ents; entry++) {
523 const struct usb_device_id *id;
525 const struct driver *drv;
526 struct usb_dev_platdata *plat;
528 for (id = entry->match; id->match_flags; id++) {
529 if (!usb_match_one_id(desc, iface, id))
534 * We could pass the descriptor to the driver as
535 * platdata (instead of NULL) and allow its bind()
536 * method to return -ENOENT if it doesn't support this
537 * device. That way we could continue the search to
538 * find another driver. For now this doesn't seem
539 * necesssary, so just bind the first match.
541 ret = device_bind(parent, drv, drv->name, NULL, -1,
545 debug("%s: Match found: %s\n", __func__, drv->name);
546 dev->driver_data = id->driver_info;
547 plat = dev_get_parent_platdata(dev);
554 /* Bind a generic driver so that the device can be used */
555 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
559 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
562 debug("%s: No match found: %d\n", __func__, ret);
567 * usb_find_child() - Find an existing device which matches our needs
571 static int usb_find_child(struct udevice *parent,
572 struct usb_device_descriptor *desc,
573 struct usb_interface_descriptor *iface,
574 struct udevice **devp)
579 for (device_find_first_child(parent, &dev);
581 device_find_next_child(&dev)) {
582 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
584 /* If this device is already in use, skip it */
585 if (device_active(dev))
587 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
588 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
589 if (usb_match_one_id(desc, iface, &plat->id)) {
598 int usb_scan_device(struct udevice *parent, int port,
599 enum usb_device_speed speed, struct udevice **devp)
602 bool created = false;
603 struct usb_dev_platdata *plat;
604 struct usb_bus_priv *priv;
605 struct usb_device *parent_udev;
607 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
608 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
611 memset(udev, '\0', sizeof(*udev));
612 udev->controller_dev = usb_get_bus(parent);
613 priv = dev_get_uclass_priv(udev->controller_dev);
616 * Somewhat nasty, this. We create a local device and use the normal
617 * USB stack to read its descriptor. Then we know what type of device
618 * to create for real.
620 * udev->dev is set to the parent, since we don't have a real device
621 * yet. The USB stack should not access udev.dev anyway, except perhaps
622 * to find the controller, and the controller will either be @parent,
623 * or some parent of @parent.
625 * Another option might be to create the device as a generic USB
626 * device, then morph it into the correct one when we know what it
627 * should be. This means that a generic USB device would morph into
628 * a network controller, or a USB flash stick, for example. However,
629 * we don't support such morphing and it isn't clear that it would
632 * Yet another option is to split out the USB stack parts of udev
633 * into something like a 'struct urb' (as Linux does) which can exist
634 * independently of any device. This feels cleaner, but calls for quite
635 * a big change to the USB stack.
637 * For now, the approach is to set up an empty udev, read its
638 * descriptor and assign it an address, then bind a real device and
639 * stash the resulting information into the device's parent
640 * platform data. Then when we probe it, usb_child_pre_probe() is called
641 * and it will pull the information out of the stash.
645 udev->devnum = priv->next_addr + 1;
647 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
648 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
649 dev_get_parent_priv(parent) : NULL;
650 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
651 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
654 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
655 debug("** usb_find_child returns %d\n", ret);
659 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
660 udev->controller_dev->seq,
666 plat = dev_get_parent_platdata(dev);
667 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
668 plat->devnum = udev->devnum;
671 ret = device_probe(dev);
673 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
685 * Detect if a USB device has been plugged or unplugged.
687 int usb_detect_change(void)
694 ret = uclass_get(UCLASS_USB_HUB, &uc);
698 uclass_foreach_dev(hub, uc) {
699 struct usb_device *udev;
702 if (!device_active(hub))
704 for (device_find_first_child(hub, &dev);
706 device_find_next_child(&dev)) {
707 struct usb_port_status status;
709 if (!device_active(dev))
712 udev = dev_get_parent_priv(dev);
713 if (usb_get_port_status(udev, udev->portnr, &status)
715 /* USB request failed */
718 if (le16_to_cpu(status.wPortChange) &
719 USB_PORT_STAT_C_CONNECTION)
727 static int usb_child_post_bind(struct udevice *dev)
729 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
732 if (!dev_of_valid(dev))
735 /* We only support matching a few things */
736 val = dev_read_u32_default(dev, "usb,device-class", -1);
738 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
739 plat->id.bDeviceClass = val;
741 val = dev_read_u32_default(dev, "usb,interface-class", -1);
743 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
744 plat->id.bInterfaceClass = val;
750 struct udevice *usb_get_bus(struct udevice *dev)
754 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
757 /* By design this cannot happen */
759 debug("USB HUB '%s' does not have a controller\n", dev->name);
765 int usb_child_pre_probe(struct udevice *dev)
767 struct usb_device *udev = dev_get_parent_priv(dev);
768 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
773 * Copy over all the values set in the on stack struct
774 * usb_device in usb_scan_device() to our final struct
775 * usb_device for this dev.
777 *udev = *(plat->udev);
778 /* And clear plat->udev as it will not be valid for long */
783 * This happens with devices which are explicitly bound
784 * instead of being discovered through usb_scan_device()
785 * such as sandbox emul devices.
788 udev->controller_dev = usb_get_bus(dev);
789 udev->devnum = plat->devnum;
792 * udev did not go through usb_scan_device(), so we need to
793 * select the config and read the config descriptors.
795 ret = usb_select_config(udev);
803 UCLASS_DRIVER(usb) = {
806 .flags = DM_UC_FLAG_SEQ_ALIAS,
807 .post_bind = dm_scan_fdt_dev,
808 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
809 .per_child_auto_alloc_size = sizeof(struct usb_device),
810 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
811 .child_post_bind = usb_child_post_bind,
812 .child_pre_probe = usb_child_pre_probe,
813 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
816 UCLASS_DRIVER(usb_dev_generic) = {
817 .id = UCLASS_USB_DEV_GENERIC,
818 .name = "usb_dev_generic",
821 U_BOOT_DRIVER(usb_dev_generic_drv) = {
822 .id = UCLASS_USB_DEV_GENERIC,
823 .name = "usb_dev_generic_drv",