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);
161 ret = device_unbind_children(bus);
166 #ifdef CONFIG_SANDBOX
169 /* Reset all enulation devices */
170 ret = uclass_get(UCLASS_USB_EMUL, &uc);
174 uclass_foreach_dev(dev, uc)
177 #ifdef CONFIG_USB_STORAGE
181 uc_priv->companion_device_count = 0;
187 static void usb_scan_bus(struct udevice *bus, bool recurse)
189 struct usb_bus_priv *priv;
193 priv = dev_get_uclass_priv(bus);
195 assert(recurse); /* TODO: Support non-recusive */
197 printf("scanning bus %d for devices... ", bus->seq);
199 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
201 printf("failed, error %d\n", ret);
202 else if (priv->next_addr == 0)
203 printf("No USB Device found\n");
205 printf("%d USB Device(s) found\n", priv->next_addr);
210 int controllers_initialized = 0;
211 struct usb_uclass_priv *uc_priv;
212 struct usb_bus_priv *priv;
221 ret = uclass_get(UCLASS_USB, &uc);
227 uclass_foreach_dev(bus, uc) {
228 /* init low_level USB */
229 printf("USB%d: ", count);
231 ret = device_probe(bus);
232 if (ret == -ENODEV) { /* No such device. */
233 puts("Port not available.\n");
234 controllers_initialized++;
238 if (ret) { /* Other error. */
239 printf("probe failed, error %d\n", ret);
242 controllers_initialized++;
247 * lowlevel init done, now scan the bus for devices i.e. search HUBs
248 * and configure them, first scan primary controllers.
250 uclass_foreach_dev(bus, uc) {
251 if (!device_active(bus))
254 priv = dev_get_uclass_priv(bus);
255 if (!priv->companion)
256 usb_scan_bus(bus, true);
260 * Now that the primary controllers have been scanned and have handed
261 * over any devices they do not understand to their companions, scan
262 * the companions if necessary.
264 if (uc_priv->companion_device_count) {
265 uclass_foreach_dev(bus, uc) {
266 if (!device_active(bus))
269 priv = dev_get_uclass_priv(bus);
271 usb_scan_bus(bus, true);
276 /* if we were not able to find at least one working bus, bail out */
278 printf("No controllers found\n");
279 else if (controllers_initialized == 0)
280 printf("USB error: all controllers failed lowlevel init\n");
282 return usb_started ? 0 : -1;
285 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
287 struct usb_device *udev;
290 if (!device_active(parent))
292 udev = dev_get_parent_priv(parent);
293 if (udev->devnum == devnum)
296 for (device_find_first_child(parent, &dev);
298 device_find_next_child(&dev)) {
299 udev = find_child_devnum(dev, devnum);
307 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
310 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
312 device_find_first_child(bus, &dev);
316 return find_child_devnum(dev, devnum);
319 int usb_post_bind(struct udevice *dev)
321 /* Scan the bus for devices */
322 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
325 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
327 struct usb_platdata *plat;
331 /* Find the old device and remove it */
332 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
335 ret = device_remove(dev);
339 plat = dev_get_platdata(dev);
340 plat->init_type = USB_INIT_DEVICE;
341 ret = device_probe(dev);
344 *ctlrp = dev_get_priv(dev);
349 /* returns 0 if no match, 1 if match */
350 int usb_match_device(const struct usb_device_descriptor *desc,
351 const struct usb_device_id *id)
353 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
354 id->idVendor != le16_to_cpu(desc->idVendor))
357 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
358 id->idProduct != le16_to_cpu(desc->idProduct))
361 /* No need to test id->bcdDevice_lo != 0, since 0 is never
362 greater than any unsigned number. */
363 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
364 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
367 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
368 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
371 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
372 (id->bDeviceClass != desc->bDeviceClass))
375 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
376 (id->bDeviceSubClass != desc->bDeviceSubClass))
379 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
380 (id->bDeviceProtocol != desc->bDeviceProtocol))
386 /* returns 0 if no match, 1 if match */
387 int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
388 const struct usb_interface_descriptor *int_desc,
389 const struct usb_device_id *id)
391 /* The interface class, subclass, protocol and number should never be
392 * checked for a match if the device class is Vendor Specific,
393 * unless the match record specifies the Vendor ID. */
394 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
395 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
396 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
397 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
398 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
399 USB_DEVICE_ID_MATCH_INT_NUMBER)))
402 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
403 (id->bInterfaceClass != int_desc->bInterfaceClass))
406 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
407 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
410 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
411 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
414 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
415 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
421 /* returns 0 if no match, 1 if match */
422 int usb_match_one_id(struct usb_device_descriptor *desc,
423 struct usb_interface_descriptor *int_desc,
424 const struct usb_device_id *id)
426 if (!usb_match_device(desc, id))
429 return usb_match_one_id_intf(desc, int_desc, id);
433 * usb_find_and_bind_driver() - Find and bind the right USB driver
435 * This only looks at certain fields in the descriptor.
437 static int usb_find_and_bind_driver(struct udevice *parent,
438 struct usb_device_descriptor *desc,
439 struct usb_interface_descriptor *iface,
440 int bus_seq, int devnum,
441 struct udevice **devp)
443 struct usb_driver_entry *start, *entry;
449 debug("%s: Searching for driver\n", __func__);
450 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
451 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
452 for (entry = start; entry != start + n_ents; entry++) {
453 const struct usb_device_id *id;
455 const struct driver *drv;
456 struct usb_dev_platdata *plat;
458 for (id = entry->match; id->match_flags; id++) {
459 if (!usb_match_one_id(desc, iface, id))
464 * We could pass the descriptor to the driver as
465 * platdata (instead of NULL) and allow its bind()
466 * method to return -ENOENT if it doesn't support this
467 * device. That way we could continue the search to
468 * find another driver. For now this doesn't seem
469 * necesssary, so just bind the first match.
471 ret = device_bind(parent, drv, drv->name, NULL, -1,
475 debug("%s: Match found: %s\n", __func__, drv->name);
476 dev->driver_data = id->driver_info;
477 plat = dev_get_parent_platdata(dev);
484 /* Bind a generic driver so that the device can be used */
485 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
489 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
492 debug("%s: No match found: %d\n", __func__, ret);
497 * usb_find_child() - Find an existing device which matches our needs
501 static int usb_find_child(struct udevice *parent,
502 struct usb_device_descriptor *desc,
503 struct usb_interface_descriptor *iface,
504 struct udevice **devp)
509 for (device_find_first_child(parent, &dev);
511 device_find_next_child(&dev)) {
512 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
514 /* If this device is already in use, skip it */
515 if (device_active(dev))
517 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
518 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
519 if (usb_match_one_id(desc, iface, &plat->id)) {
528 int usb_scan_device(struct udevice *parent, int port,
529 enum usb_device_speed speed, struct udevice **devp)
532 bool created = false;
533 struct usb_dev_platdata *plat;
534 struct usb_bus_priv *priv;
535 struct usb_device *parent_udev;
537 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
538 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
541 memset(udev, '\0', sizeof(*udev));
542 udev->controller_dev = usb_get_bus(parent);
543 priv = dev_get_uclass_priv(udev->controller_dev);
546 * Somewhat nasty, this. We create a local device and use the normal
547 * USB stack to read its descriptor. Then we know what type of device
548 * to create for real.
550 * udev->dev is set to the parent, since we don't have a real device
551 * yet. The USB stack should not access udev.dev anyway, except perhaps
552 * to find the controller, and the controller will either be @parent,
553 * or some parent of @parent.
555 * Another option might be to create the device as a generic USB
556 * device, then morph it into the correct one when we know what it
557 * should be. This means that a generic USB device would morph into
558 * a network controller, or a USB flash stick, for example. However,
559 * we don't support such morphing and it isn't clear that it would
562 * Yet another option is to split out the USB stack parts of udev
563 * into something like a 'struct urb' (as Linux does) which can exist
564 * independently of any device. This feels cleaner, but calls for quite
565 * a big change to the USB stack.
567 * For now, the approach is to set up an empty udev, read its
568 * descriptor and assign it an address, then bind a real device and
569 * stash the resulting information into the device's parent
570 * platform data. Then when we probe it, usb_child_pre_probe() is called
571 * and it will pull the information out of the stash.
575 udev->devnum = priv->next_addr + 1;
577 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
578 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
579 dev_get_parent_priv(parent) : NULL;
580 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev);
581 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
584 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
585 debug("** usb_find_child returns %d\n", ret);
589 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
590 udev->controller_dev->seq,
596 plat = dev_get_parent_platdata(dev);
597 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
598 plat->devnum = udev->devnum;
601 ret = device_probe(dev);
603 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
615 * Detect if a USB device has been plugged or unplugged.
617 int usb_detect_change(void)
624 ret = uclass_get(UCLASS_USB_HUB, &uc);
628 uclass_foreach_dev(hub, uc) {
629 struct usb_device *udev;
632 if (!device_active(hub))
634 for (device_find_first_child(hub, &dev);
636 device_find_next_child(&dev)) {
637 struct usb_port_status status;
639 if (!device_active(dev))
642 udev = dev_get_parent_priv(dev);
643 if (usb_get_port_status(udev, udev->portnr, &status)
645 /* USB request failed */
648 if (le16_to_cpu(status.wPortChange) &
649 USB_PORT_STAT_C_CONNECTION)
657 int usb_child_post_bind(struct udevice *dev)
659 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
660 const void *blob = gd->fdt_blob;
663 if (dev->of_offset == -1)
666 /* We only support matching a few things */
667 val = fdtdec_get_int(blob, dev->of_offset, "usb,device-class", -1);
669 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
670 plat->id.bDeviceClass = val;
672 val = fdtdec_get_int(blob, dev->of_offset, "usb,interface-class", -1);
674 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
675 plat->id.bInterfaceClass = val;
681 struct udevice *usb_get_bus(struct udevice *dev)
685 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
688 /* By design this cannot happen */
690 debug("USB HUB '%s' does not have a controller\n", dev->name);
696 int usb_child_pre_probe(struct udevice *dev)
698 struct usb_device *udev = dev_get_parent_priv(dev);
699 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
704 * Copy over all the values set in the on stack struct
705 * usb_device in usb_scan_device() to our final struct
706 * usb_device for this dev.
708 *udev = *(plat->udev);
709 /* And clear plat->udev as it will not be valid for long */
714 * This happens with devices which are explicitly bound
715 * instead of being discovered through usb_scan_device()
716 * such as sandbox emul devices.
719 udev->controller_dev = usb_get_bus(dev);
720 udev->devnum = plat->devnum;
723 * udev did not go through usb_scan_device(), so we need to
724 * select the config and read the config descriptors.
726 ret = usb_select_config(udev);
734 UCLASS_DRIVER(usb) = {
737 .flags = DM_UC_FLAG_SEQ_ALIAS,
738 .post_bind = usb_post_bind,
739 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
740 .per_child_auto_alloc_size = sizeof(struct usb_device),
741 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
742 .child_post_bind = usb_child_post_bind,
743 .child_pre_probe = usb_child_pre_probe,
744 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
747 UCLASS_DRIVER(usb_dev_generic) = {
748 .id = UCLASS_USB_DEV_GENERIC,
749 .name = "usb_dev_generic",
752 U_BOOT_DRIVER(usb_dev_generic_drv) = {
753 .id = UCLASS_USB_DEV_GENERIC,
754 .name = "usb_dev_generic_drv",