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);
157 struct usb_uclass_priv *uc_priv;
160 /* De-activate any devices that have been activated */
161 ret = uclass_get(UCLASS_USB, &uc);
167 uclass_foreach_dev(bus, uc) {
168 ret = device_remove(bus, DM_REMOVE_NORMAL);
173 ret = blk_unbind_all(IF_TYPE_USB);
177 #ifdef CONFIG_SANDBOX
180 /* Reset all enulation devices */
181 ret = uclass_get(UCLASS_USB_EMUL, &uc);
185 uclass_foreach_dev(dev, uc)
188 #ifdef CONFIG_USB_STORAGE
191 uc_priv->companion_device_count = 0;
197 static void usb_scan_bus(struct udevice *bus, bool recurse)
199 struct usb_bus_priv *priv;
203 priv = dev_get_uclass_priv(bus);
205 assert(recurse); /* TODO: Support non-recusive */
207 printf("scanning bus %d for devices... ", bus->seq);
209 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
211 printf("failed, error %d\n", ret);
212 else if (priv->next_addr == 0)
213 printf("No USB Device found\n");
215 printf("%d USB Device(s) found\n", priv->next_addr);
218 static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
220 uclass_foreach_dev(bus, uc) {
221 struct udevice *dev, *next;
223 if (!device_active(bus))
225 device_foreach_child_safe(dev, next, bus) {
226 if (!device_active(dev))
234 int controllers_initialized = 0;
235 struct usb_uclass_priv *uc_priv;
236 struct usb_bus_priv *priv;
244 ret = uclass_get(UCLASS_USB, &uc);
250 uclass_foreach_dev(bus, uc) {
251 /* init low_level USB */
252 printf("USB%d: ", count);
254 ret = device_probe(bus);
255 if (ret == -ENODEV) { /* No such device. */
256 puts("Port not available.\n");
257 controllers_initialized++;
261 if (ret) { /* Other error. */
262 printf("probe failed, error %d\n", ret);
265 controllers_initialized++;
270 * lowlevel init done, now scan the bus for devices i.e. search HUBs
271 * and configure them, first scan primary controllers.
273 uclass_foreach_dev(bus, uc) {
274 if (!device_active(bus))
277 priv = dev_get_uclass_priv(bus);
278 if (!priv->companion)
279 usb_scan_bus(bus, true);
283 * Now that the primary controllers have been scanned and have handed
284 * over any devices they do not understand to their companions, scan
285 * the companions if necessary.
287 if (uc_priv->companion_device_count) {
288 uclass_foreach_dev(bus, uc) {
289 if (!device_active(bus))
292 priv = dev_get_uclass_priv(bus);
294 usb_scan_bus(bus, true);
300 /* Remove any devices that were not found on this scan */
301 remove_inactive_children(uc, bus);
303 ret = uclass_get(UCLASS_USB_HUB, &uc);
306 remove_inactive_children(uc, bus);
308 /* if we were not able to find at least one working bus, bail out */
310 printf("No controllers found\n");
311 else if (controllers_initialized == 0)
312 printf("USB error: all controllers failed lowlevel init\n");
314 return usb_started ? 0 : -1;
318 * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed
319 * to support boards which use driver model for USB but not Ethernet, and want
320 * to use USB Ethernet.
322 * The #if clause is here to ensure that remains the only case.
324 #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER)
325 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
327 struct usb_device *udev;
330 if (!device_active(parent))
332 udev = dev_get_parent_priv(parent);
333 if (udev->devnum == devnum)
336 for (device_find_first_child(parent, &dev);
338 device_find_next_child(&dev)) {
339 udev = find_child_devnum(dev, devnum);
347 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
350 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
352 device_find_first_child(bus, &dev);
356 return find_child_devnum(dev, devnum);
360 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
362 struct usb_platdata *plat;
366 /* Find the old device and remove it */
367 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
370 ret = device_remove(dev, DM_REMOVE_NORMAL);
374 plat = dev_get_platdata(dev);
375 plat->init_type = USB_INIT_DEVICE;
376 ret = device_probe(dev);
379 *ctlrp = dev_get_priv(dev);
384 /* returns 0 if no match, 1 if match */
385 static int usb_match_device(const struct usb_device_descriptor *desc,
386 const struct usb_device_id *id)
388 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
389 id->idVendor != le16_to_cpu(desc->idVendor))
392 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
393 id->idProduct != le16_to_cpu(desc->idProduct))
396 /* No need to test id->bcdDevice_lo != 0, since 0 is never
397 greater than any unsigned number. */
398 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
399 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
402 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
403 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
406 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
407 (id->bDeviceClass != desc->bDeviceClass))
410 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
411 (id->bDeviceSubClass != desc->bDeviceSubClass))
414 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
415 (id->bDeviceProtocol != desc->bDeviceProtocol))
421 /* returns 0 if no match, 1 if match */
422 static int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
423 const struct usb_interface_descriptor *int_desc,
424 const struct usb_device_id *id)
426 /* The interface class, subclass, protocol and number should never be
427 * checked for a match if the device class is Vendor Specific,
428 * unless the match record specifies the Vendor ID. */
429 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
430 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
431 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
432 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
433 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
434 USB_DEVICE_ID_MATCH_INT_NUMBER)))
437 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
438 (id->bInterfaceClass != int_desc->bInterfaceClass))
441 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
442 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
445 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
446 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
449 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
450 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
456 /* returns 0 if no match, 1 if match */
457 static int usb_match_one_id(struct usb_device_descriptor *desc,
458 struct usb_interface_descriptor *int_desc,
459 const struct usb_device_id *id)
461 if (!usb_match_device(desc, id))
464 return usb_match_one_id_intf(desc, int_desc, id);
468 * usb_find_and_bind_driver() - Find and bind the right USB driver
470 * This only looks at certain fields in the descriptor.
472 static int usb_find_and_bind_driver(struct udevice *parent,
473 struct usb_device_descriptor *desc,
474 struct usb_interface_descriptor *iface,
475 int bus_seq, int devnum,
476 struct udevice **devp)
478 struct usb_driver_entry *start, *entry;
484 debug("%s: Searching for driver\n", __func__);
485 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
486 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
487 for (entry = start; entry != start + n_ents; entry++) {
488 const struct usb_device_id *id;
490 const struct driver *drv;
491 struct usb_dev_platdata *plat;
493 for (id = entry->match; id->match_flags; id++) {
494 if (!usb_match_one_id(desc, iface, id))
499 * We could pass the descriptor to the driver as
500 * platdata (instead of NULL) and allow its bind()
501 * method to return -ENOENT if it doesn't support this
502 * device. That way we could continue the search to
503 * find another driver. For now this doesn't seem
504 * necesssary, so just bind the first match.
506 ret = device_bind(parent, drv, drv->name, NULL, -1,
510 debug("%s: Match found: %s\n", __func__, drv->name);
511 dev->driver_data = id->driver_info;
512 plat = dev_get_parent_platdata(dev);
519 /* Bind a generic driver so that the device can be used */
520 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
524 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
527 debug("%s: No match found: %d\n", __func__, ret);
532 * usb_find_child() - Find an existing device which matches our needs
536 static int usb_find_child(struct udevice *parent,
537 struct usb_device_descriptor *desc,
538 struct usb_interface_descriptor *iface,
539 struct udevice **devp)
544 for (device_find_first_child(parent, &dev);
546 device_find_next_child(&dev)) {
547 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
549 /* If this device is already in use, skip it */
550 if (device_active(dev))
552 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
553 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
554 if (usb_match_one_id(desc, iface, &plat->id)) {
563 int usb_scan_device(struct udevice *parent, int port,
564 enum usb_device_speed speed, struct udevice **devp)
567 bool created = false;
568 struct usb_dev_platdata *plat;
569 struct usb_bus_priv *priv;
570 struct usb_device *parent_udev;
572 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
573 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
576 memset(udev, '\0', sizeof(*udev));
577 udev->controller_dev = usb_get_bus(parent);
578 priv = dev_get_uclass_priv(udev->controller_dev);
581 * Somewhat nasty, this. We create a local device and use the normal
582 * USB stack to read its descriptor. Then we know what type of device
583 * to create for real.
585 * udev->dev is set to the parent, since we don't have a real device
586 * yet. The USB stack should not access udev.dev anyway, except perhaps
587 * to find the controller, and the controller will either be @parent,
588 * or some parent of @parent.
590 * Another option might be to create the device as a generic USB
591 * device, then morph it into the correct one when we know what it
592 * should be. This means that a generic USB device would morph into
593 * a network controller, or a USB flash stick, for example. However,
594 * we don't support such morphing and it isn't clear that it would
597 * Yet another option is to split out the USB stack parts of udev
598 * into something like a 'struct urb' (as Linux does) which can exist
599 * independently of any device. This feels cleaner, but calls for quite
600 * a big change to the USB stack.
602 * For now, the approach is to set up an empty udev, read its
603 * descriptor and assign it an address, then bind a real device and
604 * stash the resulting information into the device's parent
605 * platform data. Then when we probe it, usb_child_pre_probe() is called
606 * and it will pull the information out of the stash.
610 udev->devnum = priv->next_addr + 1;
612 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
613 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
614 dev_get_parent_priv(parent) : NULL;
615 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
616 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
619 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
620 debug("** usb_find_child returns %d\n", ret);
624 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
625 udev->controller_dev->seq,
631 plat = dev_get_parent_platdata(dev);
632 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
633 plat->devnum = udev->devnum;
636 ret = device_probe(dev);
638 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
650 * Detect if a USB device has been plugged or unplugged.
652 int usb_detect_change(void)
659 ret = uclass_get(UCLASS_USB_HUB, &uc);
663 uclass_foreach_dev(hub, uc) {
664 struct usb_device *udev;
667 if (!device_active(hub))
669 for (device_find_first_child(hub, &dev);
671 device_find_next_child(&dev)) {
672 struct usb_port_status status;
674 if (!device_active(dev))
677 udev = dev_get_parent_priv(dev);
678 if (usb_get_port_status(udev, udev->portnr, &status)
680 /* USB request failed */
683 if (le16_to_cpu(status.wPortChange) &
684 USB_PORT_STAT_C_CONNECTION)
692 static int usb_child_post_bind(struct udevice *dev)
694 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
697 if (!dev_of_valid(dev))
700 /* We only support matching a few things */
701 val = dev_read_u32_default(dev, "usb,device-class", -1);
703 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
704 plat->id.bDeviceClass = val;
706 val = dev_read_u32_default(dev, "usb,interface-class", -1);
708 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
709 plat->id.bInterfaceClass = val;
715 struct udevice *usb_get_bus(struct udevice *dev)
719 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
722 /* By design this cannot happen */
724 debug("USB HUB '%s' does not have a controller\n", dev->name);
730 int usb_child_pre_probe(struct udevice *dev)
732 struct usb_device *udev = dev_get_parent_priv(dev);
733 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
738 * Copy over all the values set in the on stack struct
739 * usb_device in usb_scan_device() to our final struct
740 * usb_device for this dev.
742 *udev = *(plat->udev);
743 /* And clear plat->udev as it will not be valid for long */
748 * This happens with devices which are explicitly bound
749 * instead of being discovered through usb_scan_device()
750 * such as sandbox emul devices.
753 udev->controller_dev = usb_get_bus(dev);
754 udev->devnum = plat->devnum;
757 * udev did not go through usb_scan_device(), so we need to
758 * select the config and read the config descriptors.
760 ret = usb_select_config(udev);
768 UCLASS_DRIVER(usb) = {
771 .flags = DM_UC_FLAG_SEQ_ALIAS,
772 .post_bind = dm_scan_fdt_dev,
773 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
774 .per_child_auto_alloc_size = sizeof(struct usb_device),
775 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
776 .child_post_bind = usb_child_post_bind,
777 .child_pre_probe = usb_child_pre_probe,
778 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
781 UCLASS_DRIVER(usb_dev_generic) = {
782 .id = UCLASS_USB_DEV_GENERIC,
783 .name = "usb_dev_generic",
786 U_BOOT_DRIVER(usb_dev_generic_drv) = {
787 .id = UCLASS_USB_DEV_GENERIC,
788 .name = "usb_dev_generic_drv",