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>
18 #include <dm/uclass-internal.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 extern bool usb_started; /* flag for the started/stopped USB status */
23 static bool asynch_allowed;
25 struct usb_uclass_priv {
26 int companion_device_count;
29 int usb_disable_asynch(int disable)
31 int old_value = asynch_allowed;
33 asynch_allowed = !disable;
37 int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
38 int length, int interval)
40 struct udevice *bus = udev->controller_dev;
41 struct dm_usb_ops *ops = usb_get_ops(bus);
46 return ops->interrupt(bus, udev, pipe, buffer, length, interval);
49 int submit_control_msg(struct usb_device *udev, unsigned long pipe,
50 void *buffer, int length, struct devrequest *setup)
52 struct udevice *bus = udev->controller_dev;
53 struct dm_usb_ops *ops = usb_get_ops(bus);
54 struct usb_uclass_priv *uc_priv = bus->uclass->priv;
60 err = ops->control(bus, udev, pipe, buffer, length, setup);
61 if (setup->request == USB_REQ_SET_FEATURE &&
62 setup->requesttype == USB_RT_PORT &&
63 setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) &&
65 /* Device handed over to companion after port reset */
66 uc_priv->companion_device_count++;
72 int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer,
75 struct udevice *bus = udev->controller_dev;
76 struct dm_usb_ops *ops = usb_get_ops(bus);
81 return ops->bulk(bus, udev, pipe, buffer, length);
84 struct int_queue *create_int_queue(struct usb_device *udev,
85 unsigned long pipe, int queuesize, int elementsize,
86 void *buffer, int interval)
88 struct udevice *bus = udev->controller_dev;
89 struct dm_usb_ops *ops = usb_get_ops(bus);
91 if (!ops->create_int_queue)
94 return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize,
98 void *poll_int_queue(struct usb_device *udev, struct int_queue *queue)
100 struct udevice *bus = udev->controller_dev;
101 struct dm_usb_ops *ops = usb_get_ops(bus);
103 if (!ops->poll_int_queue)
106 return ops->poll_int_queue(bus, udev, queue);
109 int destroy_int_queue(struct usb_device *udev, struct int_queue *queue)
111 struct udevice *bus = udev->controller_dev;
112 struct dm_usb_ops *ops = usb_get_ops(bus);
114 if (!ops->destroy_int_queue)
117 return ops->destroy_int_queue(bus, udev, queue);
120 int usb_alloc_device(struct usb_device *udev)
122 struct udevice *bus = udev->controller_dev;
123 struct dm_usb_ops *ops = usb_get_ops(bus);
125 /* This is only requird by some controllers - current XHCI */
126 if (!ops->alloc_device)
129 return ops->alloc_device(bus, udev);
132 int usb_reset_root_port(struct usb_device *udev)
134 struct udevice *bus = udev->controller_dev;
135 struct dm_usb_ops *ops = usb_get_ops(bus);
137 if (!ops->reset_root_port)
140 return ops->reset_root_port(bus, udev);
147 struct usb_uclass_priv *uc_priv;
150 /* De-activate any devices that have been activated */
151 ret = uclass_get(UCLASS_USB, &uc);
157 uclass_foreach_dev(bus, uc) {
158 ret = device_remove(bus);
163 ret = blk_unbind_all(IF_TYPE_USB);
167 #ifdef CONFIG_SANDBOX
170 /* Reset all enulation devices */
171 ret = uclass_get(UCLASS_USB_EMUL, &uc);
175 uclass_foreach_dev(dev, uc)
178 #ifdef CONFIG_USB_STORAGE
182 uc_priv->companion_device_count = 0;
188 static void usb_scan_bus(struct udevice *bus, bool recurse)
190 struct usb_bus_priv *priv;
194 priv = dev_get_uclass_priv(bus);
196 assert(recurse); /* TODO: Support non-recusive */
198 printf("scanning bus %d for devices... ", bus->seq);
200 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
202 printf("failed, error %d\n", ret);
203 else if (priv->next_addr == 0)
204 printf("No USB Device found\n");
206 printf("%d USB Device(s) found\n", priv->next_addr);
209 static void remove_inactive_children(struct uclass *uc, struct udevice *bus)
211 uclass_foreach_dev(bus, uc) {
212 struct udevice *dev, *next;
214 if (!device_active(bus))
216 device_foreach_child_safe(dev, next, bus) {
217 if (!device_active(dev))
225 int controllers_initialized = 0;
226 struct usb_uclass_priv *uc_priv;
227 struct usb_bus_priv *priv;
236 ret = uclass_get(UCLASS_USB, &uc);
242 uclass_foreach_dev(bus, uc) {
243 /* init low_level USB */
244 printf("USB%d: ", count);
246 ret = device_probe(bus);
247 if (ret == -ENODEV) { /* No such device. */
248 puts("Port not available.\n");
249 controllers_initialized++;
253 if (ret) { /* Other error. */
254 printf("probe failed, error %d\n", ret);
257 controllers_initialized++;
262 * lowlevel init done, now scan the bus for devices i.e. search HUBs
263 * and configure them, first scan primary controllers.
265 uclass_foreach_dev(bus, uc) {
266 if (!device_active(bus))
269 priv = dev_get_uclass_priv(bus);
270 if (!priv->companion)
271 usb_scan_bus(bus, true);
275 * Now that the primary controllers have been scanned and have handed
276 * over any devices they do not understand to their companions, scan
277 * the companions if necessary.
279 if (uc_priv->companion_device_count) {
280 uclass_foreach_dev(bus, uc) {
281 if (!device_active(bus))
284 priv = dev_get_uclass_priv(bus);
286 usb_scan_bus(bus, true);
292 /* Remove any devices that were not found on this scan */
293 remove_inactive_children(uc, bus);
295 ret = uclass_get(UCLASS_USB_HUB, &uc);
298 remove_inactive_children(uc, bus);
300 /* if we were not able to find at least one working bus, bail out */
302 printf("No controllers found\n");
303 else if (controllers_initialized == 0)
304 printf("USB error: all controllers failed lowlevel init\n");
306 return usb_started ? 0 : -1;
310 * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed
311 * to support boards which use driver model for USB but not Ethernet, and want
312 * to use USB Ethernet.
314 * The #if clause is here to ensure that remains the only case.
316 #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER)
317 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
319 struct usb_device *udev;
322 if (!device_active(parent))
324 udev = dev_get_parent_priv(parent);
325 if (udev->devnum == devnum)
328 for (device_find_first_child(parent, &dev);
330 device_find_next_child(&dev)) {
331 udev = find_child_devnum(dev, devnum);
339 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
342 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
344 device_find_first_child(bus, &dev);
348 return find_child_devnum(dev, devnum);
352 int usb_post_bind(struct udevice *dev)
354 /* Scan the bus for devices */
355 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
358 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
360 struct usb_platdata *plat;
364 /* Find the old device and remove it */
365 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
368 ret = device_remove(dev);
372 plat = dev_get_platdata(dev);
373 plat->init_type = USB_INIT_DEVICE;
374 ret = device_probe(dev);
377 *ctlrp = dev_get_priv(dev);
382 /* returns 0 if no match, 1 if match */
383 int usb_match_device(const struct usb_device_descriptor *desc,
384 const struct usb_device_id *id)
386 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
387 id->idVendor != le16_to_cpu(desc->idVendor))
390 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
391 id->idProduct != le16_to_cpu(desc->idProduct))
394 /* No need to test id->bcdDevice_lo != 0, since 0 is never
395 greater than any unsigned number. */
396 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
397 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
400 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
401 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
404 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
405 (id->bDeviceClass != desc->bDeviceClass))
408 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
409 (id->bDeviceSubClass != desc->bDeviceSubClass))
412 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
413 (id->bDeviceProtocol != desc->bDeviceProtocol))
419 /* returns 0 if no match, 1 if match */
420 int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
421 const struct usb_interface_descriptor *int_desc,
422 const struct usb_device_id *id)
424 /* The interface class, subclass, protocol and number should never be
425 * checked for a match if the device class is Vendor Specific,
426 * unless the match record specifies the Vendor ID. */
427 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
428 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
429 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
430 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
431 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
432 USB_DEVICE_ID_MATCH_INT_NUMBER)))
435 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
436 (id->bInterfaceClass != int_desc->bInterfaceClass))
439 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
440 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
443 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
444 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
447 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
448 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
454 /* returns 0 if no match, 1 if match */
455 int usb_match_one_id(struct usb_device_descriptor *desc,
456 struct usb_interface_descriptor *int_desc,
457 const struct usb_device_id *id)
459 if (!usb_match_device(desc, id))
462 return usb_match_one_id_intf(desc, int_desc, id);
466 * usb_find_and_bind_driver() - Find and bind the right USB driver
468 * This only looks at certain fields in the descriptor.
470 static int usb_find_and_bind_driver(struct udevice *parent,
471 struct usb_device_descriptor *desc,
472 struct usb_interface_descriptor *iface,
473 int bus_seq, int devnum,
474 struct udevice **devp)
476 struct usb_driver_entry *start, *entry;
482 debug("%s: Searching for driver\n", __func__);
483 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
484 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
485 for (entry = start; entry != start + n_ents; entry++) {
486 const struct usb_device_id *id;
488 const struct driver *drv;
489 struct usb_dev_platdata *plat;
491 for (id = entry->match; id->match_flags; id++) {
492 if (!usb_match_one_id(desc, iface, id))
497 * We could pass the descriptor to the driver as
498 * platdata (instead of NULL) and allow its bind()
499 * method to return -ENOENT if it doesn't support this
500 * device. That way we could continue the search to
501 * find another driver. For now this doesn't seem
502 * necesssary, so just bind the first match.
504 ret = device_bind(parent, drv, drv->name, NULL, -1,
508 debug("%s: Match found: %s\n", __func__, drv->name);
509 dev->driver_data = id->driver_info;
510 plat = dev_get_parent_platdata(dev);
517 /* Bind a generic driver so that the device can be used */
518 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
522 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
525 debug("%s: No match found: %d\n", __func__, ret);
530 * usb_find_child() - Find an existing device which matches our needs
534 static int usb_find_child(struct udevice *parent,
535 struct usb_device_descriptor *desc,
536 struct usb_interface_descriptor *iface,
537 struct udevice **devp)
542 for (device_find_first_child(parent, &dev);
544 device_find_next_child(&dev)) {
545 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
547 /* If this device is already in use, skip it */
548 if (device_active(dev))
550 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
551 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
552 if (usb_match_one_id(desc, iface, &plat->id)) {
561 int usb_scan_device(struct udevice *parent, int port,
562 enum usb_device_speed speed, struct udevice **devp)
565 bool created = false;
566 struct usb_dev_platdata *plat;
567 struct usb_bus_priv *priv;
568 struct usb_device *parent_udev;
570 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
571 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
574 memset(udev, '\0', sizeof(*udev));
575 udev->controller_dev = usb_get_bus(parent);
576 priv = dev_get_uclass_priv(udev->controller_dev);
579 * Somewhat nasty, this. We create a local device and use the normal
580 * USB stack to read its descriptor. Then we know what type of device
581 * to create for real.
583 * udev->dev is set to the parent, since we don't have a real device
584 * yet. The USB stack should not access udev.dev anyway, except perhaps
585 * to find the controller, and the controller will either be @parent,
586 * or some parent of @parent.
588 * Another option might be to create the device as a generic USB
589 * device, then morph it into the correct one when we know what it
590 * should be. This means that a generic USB device would morph into
591 * a network controller, or a USB flash stick, for example. However,
592 * we don't support such morphing and it isn't clear that it would
595 * Yet another option is to split out the USB stack parts of udev
596 * into something like a 'struct urb' (as Linux does) which can exist
597 * independently of any device. This feels cleaner, but calls for quite
598 * a big change to the USB stack.
600 * For now, the approach is to set up an empty udev, read its
601 * descriptor and assign it an address, then bind a real device and
602 * stash the resulting information into the device's parent
603 * platform data. Then when we probe it, usb_child_pre_probe() is called
604 * and it will pull the information out of the stash.
608 udev->devnum = priv->next_addr + 1;
610 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
611 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
612 dev_get_parent_priv(parent) : NULL;
613 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
614 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
617 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
618 debug("** usb_find_child returns %d\n", ret);
622 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
623 udev->controller_dev->seq,
629 plat = dev_get_parent_platdata(dev);
630 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
631 plat->devnum = udev->devnum;
634 ret = device_probe(dev);
636 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
648 * Detect if a USB device has been plugged or unplugged.
650 int usb_detect_change(void)
657 ret = uclass_get(UCLASS_USB_HUB, &uc);
661 uclass_foreach_dev(hub, uc) {
662 struct usb_device *udev;
665 if (!device_active(hub))
667 for (device_find_first_child(hub, &dev);
669 device_find_next_child(&dev)) {
670 struct usb_port_status status;
672 if (!device_active(dev))
675 udev = dev_get_parent_priv(dev);
676 if (usb_get_port_status(udev, udev->portnr, &status)
678 /* USB request failed */
681 if (le16_to_cpu(status.wPortChange) &
682 USB_PORT_STAT_C_CONNECTION)
690 int usb_child_post_bind(struct udevice *dev)
692 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
693 const void *blob = gd->fdt_blob;
696 if (dev->of_offset == -1)
699 /* We only support matching a few things */
700 val = fdtdec_get_int(blob, dev->of_offset, "usb,device-class", -1);
702 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
703 plat->id.bDeviceClass = val;
705 val = fdtdec_get_int(blob, dev->of_offset, "usb,interface-class", -1);
707 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
708 plat->id.bInterfaceClass = val;
714 struct udevice *usb_get_bus(struct udevice *dev)
718 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
721 /* By design this cannot happen */
723 debug("USB HUB '%s' does not have a controller\n", dev->name);
729 int usb_child_pre_probe(struct udevice *dev)
731 struct usb_device *udev = dev_get_parent_priv(dev);
732 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
737 * Copy over all the values set in the on stack struct
738 * usb_device in usb_scan_device() to our final struct
739 * usb_device for this dev.
741 *udev = *(plat->udev);
742 /* And clear plat->udev as it will not be valid for long */
747 * This happens with devices which are explicitly bound
748 * instead of being discovered through usb_scan_device()
749 * such as sandbox emul devices.
752 udev->controller_dev = usb_get_bus(dev);
753 udev->devnum = plat->devnum;
756 * udev did not go through usb_scan_device(), so we need to
757 * select the config and read the config descriptors.
759 ret = usb_select_config(udev);
767 UCLASS_DRIVER(usb) = {
770 .flags = DM_UC_FLAG_SEQ_ALIAS,
771 .post_bind = usb_post_bind,
772 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
773 .per_child_auto_alloc_size = sizeof(struct usb_device),
774 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
775 .child_post_bind = usb_child_post_bind,
776 .child_pre_probe = usb_child_pre_probe,
777 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
780 UCLASS_DRIVER(usb_dev_generic) = {
781 .id = UCLASS_USB_DEV_GENERIC,
782 .name = "usb_dev_generic",
785 U_BOOT_DRIVER(usb_dev_generic_drv) = {
786 .id = UCLASS_USB_DEV_GENERIC,
787 .name = "usb_dev_generic_drv",