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+
14 #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);
135 struct usb_uclass_priv *uc_priv;
138 /* De-activate any devices that have been activated */
139 ret = uclass_get(UCLASS_USB, &uc);
145 uclass_foreach_dev(bus, uc) {
146 ret = device_remove(bus);
151 #ifdef CONFIG_SANDBOX
154 /* Reset all enulation devices */
155 ret = uclass_get(UCLASS_USB_EMUL, &uc);
159 uclass_foreach_dev(dev, uc)
164 uc_priv->companion_device_count = 0;
170 static void usb_scan_bus(struct udevice *bus, bool recurse)
172 struct usb_bus_priv *priv;
176 priv = dev_get_uclass_priv(bus);
178 assert(recurse); /* TODO: Support non-recusive */
180 printf("scanning bus %d for devices... ", bus->seq);
182 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev);
184 printf("failed, error %d\n", ret);
185 else if (priv->next_addr == 0)
186 printf("No USB Device found\n");
188 printf("%d USB Device(s) found\n", priv->next_addr);
193 int controllers_initialized = 0;
194 struct usb_uclass_priv *uc_priv;
195 struct usb_bus_priv *priv;
204 ret = uclass_get(UCLASS_USB, &uc);
210 uclass_foreach_dev(bus, uc) {
211 /* init low_level USB */
212 printf("USB%d: ", count);
214 ret = device_probe(bus);
215 if (ret == -ENODEV) { /* No such device. */
216 puts("Port not available.\n");
217 controllers_initialized++;
221 if (ret) { /* Other error. */
222 printf("probe failed, error %d\n", ret);
225 controllers_initialized++;
230 * lowlevel init done, now scan the bus for devices i.e. search HUBs
231 * and configure them, first scan primary controllers.
233 uclass_foreach_dev(bus, uc) {
234 if (!device_active(bus))
237 priv = dev_get_uclass_priv(bus);
238 if (!priv->companion)
239 usb_scan_bus(bus, true);
243 * Now that the primary controllers have been scanned and have handed
244 * over any devices they do not understand to their companions, scan
245 * the companions if necessary.
247 if (uc_priv->companion_device_count) {
248 uclass_foreach_dev(bus, uc) {
249 if (!device_active(bus))
252 priv = dev_get_uclass_priv(bus);
254 usb_scan_bus(bus, true);
259 /* if we were not able to find at least one working bus, bail out */
261 printf("No controllers found\n");
262 else if (controllers_initialized == 0)
263 printf("USB error: all controllers failed lowlevel init\n");
265 return usb_started ? 0 : -1;
268 int usb_reset_root_port(void)
273 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum)
275 struct usb_device *udev;
278 if (!device_active(parent))
280 udev = dev_get_parentdata(parent);
281 if (udev->devnum == devnum)
284 for (device_find_first_child(parent, &dev);
286 device_find_next_child(&dev)) {
287 udev = find_child_devnum(dev, devnum);
295 struct usb_device *usb_get_dev_index(struct udevice *bus, int index)
298 int devnum = index + 1; /* Addresses are allocated from 1 on USB */
300 device_find_first_child(bus, &hub);
301 if (device_get_uclass_id(hub) == UCLASS_USB_HUB)
302 return find_child_devnum(hub, devnum);
307 int usb_post_bind(struct udevice *dev)
309 /* Scan the bus for devices */
310 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
313 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp)
315 struct usb_platdata *plat;
319 /* Find the old device and remove it */
320 ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev);
323 ret = device_remove(dev);
327 plat = dev_get_platdata(dev);
328 plat->init_type = USB_INIT_DEVICE;
329 ret = device_probe(dev);
332 *ctlrp = dev_get_priv(dev);
337 /* returns 0 if no match, 1 if match */
338 int usb_match_device(const struct usb_device_descriptor *desc,
339 const struct usb_device_id *id)
341 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
342 id->idVendor != le16_to_cpu(desc->idVendor))
345 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
346 id->idProduct != le16_to_cpu(desc->idProduct))
349 /* No need to test id->bcdDevice_lo != 0, since 0 is never
350 greater than any unsigned number. */
351 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
352 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice)))
355 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
356 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice)))
359 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
360 (id->bDeviceClass != desc->bDeviceClass))
363 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
364 (id->bDeviceSubClass != desc->bDeviceSubClass))
367 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
368 (id->bDeviceProtocol != desc->bDeviceProtocol))
374 /* returns 0 if no match, 1 if match */
375 int usb_match_one_id_intf(const struct usb_device_descriptor *desc,
376 const struct usb_interface_descriptor *int_desc,
377 const struct usb_device_id *id)
379 /* The interface class, subclass, protocol and number should never be
380 * checked for a match if the device class is Vendor Specific,
381 * unless the match record specifies the Vendor ID. */
382 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC &&
383 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
384 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
385 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
386 USB_DEVICE_ID_MATCH_INT_PROTOCOL |
387 USB_DEVICE_ID_MATCH_INT_NUMBER)))
390 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
391 (id->bInterfaceClass != int_desc->bInterfaceClass))
394 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
395 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass))
398 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
399 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol))
402 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) &&
403 (id->bInterfaceNumber != int_desc->bInterfaceNumber))
409 /* returns 0 if no match, 1 if match */
410 int usb_match_one_id(struct usb_device_descriptor *desc,
411 struct usb_interface_descriptor *int_desc,
412 const struct usb_device_id *id)
414 if (!usb_match_device(desc, id))
417 return usb_match_one_id_intf(desc, int_desc, id);
421 * usb_find_and_bind_driver() - Find and bind the right USB driver
423 * This only looks at certain fields in the descriptor.
425 static int usb_find_and_bind_driver(struct udevice *parent,
426 struct usb_device_descriptor *desc,
427 struct usb_interface_descriptor *iface,
428 int bus_seq, int devnum,
429 struct udevice **devp)
431 struct usb_driver_entry *start, *entry;
437 debug("%s: Searching for driver\n", __func__);
438 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry);
439 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry);
440 for (entry = start; entry != start + n_ents; entry++) {
441 const struct usb_device_id *id;
443 const struct driver *drv;
444 struct usb_dev_platdata *plat;
446 for (id = entry->match; id->match_flags; id++) {
447 if (!usb_match_one_id(desc, iface, id))
452 * We could pass the descriptor to the driver as
453 * platdata (instead of NULL) and allow its bind()
454 * method to return -ENOENT if it doesn't support this
455 * device. That way we could continue the search to
456 * find another driver. For now this doesn't seem
457 * necesssary, so just bind the first match.
459 ret = device_bind(parent, drv, drv->name, NULL, -1,
463 debug("%s: Match found: %s\n", __func__, drv->name);
464 dev->driver_data = id->driver_info;
465 plat = dev_get_parent_platdata(dev);
472 /* Bind a generic driver so that the device can be used */
473 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum);
477 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp);
480 debug("%s: No match found: %d\n", __func__, ret);
485 * usb_find_child() - Find an existing device which matches our needs
489 static int usb_find_child(struct udevice *parent,
490 struct usb_device_descriptor *desc,
491 struct usb_interface_descriptor *iface,
492 struct udevice **devp)
497 for (device_find_first_child(parent, &dev);
499 device_find_next_child(&dev)) {
500 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
502 /* If this device is already in use, skip it */
503 if (device_active(dev))
505 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__,
506 dev->name, plat->id.bDeviceClass, desc->bDeviceClass);
507 if (usb_match_one_id(desc, iface, &plat->id)) {
516 int usb_scan_device(struct udevice *parent, int port,
517 enum usb_device_speed speed, struct udevice **devp)
520 bool created = false;
521 struct usb_dev_platdata *plat;
522 struct usb_bus_priv *priv;
523 struct usb_device *parent_udev;
525 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1);
526 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc;
529 memset(udev, '\0', sizeof(*udev));
530 udev->controller_dev = usb_get_bus(parent);
531 priv = dev_get_uclass_priv(udev->controller_dev);
534 * Somewhat nasty, this. We create a local device and use the normal
535 * USB stack to read its descriptor. Then we know what type of device
536 * to create for real.
538 * udev->dev is set to the parent, since we don't have a real device
539 * yet. The USB stack should not access udev.dev anyway, except perhaps
540 * to find the controller, and the controller will either be @parent,
541 * or some parent of @parent.
543 * Another option might be to create the device as a generic USB
544 * device, then morph it into the correct one when we know what it
545 * should be. This means that a generic USB device would morph into
546 * a network controller, or a USB flash stick, for example. However,
547 * we don't support such morphing and it isn't clear that it would
550 * Yet another option is to split out the USB stack parts of udev
551 * into something like a 'struct urb' (as Linux does) which can exist
552 * independently of any device. This feels cleaner, but calls for quite
553 * a big change to the USB stack.
555 * For now, the approach is to set up an empty udev, read its
556 * descriptor and assign it an address, then bind a real device and
557 * stash the resulting information into the device's parent
558 * platform data. Then when we probe it, usb_child_pre_probe() is called
559 * and it will pull the information out of the stash.
563 udev->devnum = priv->next_addr + 1;
565 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr);
566 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ?
567 dev_get_parentdata(parent) : NULL;
568 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev, port);
569 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret);
572 ret = usb_find_child(parent, &udev->descriptor, iface, &dev);
573 debug("** usb_find_child returns %d\n", ret);
577 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface,
578 udev->controller_dev->seq,
584 plat = dev_get_parent_platdata(dev);
585 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat);
586 plat->devnum = udev->devnum;
589 ret = device_probe(dev);
591 debug("%s: Device '%s' probe failed\n", __func__, dev->name);
603 * Detect if a USB device has been plugged or unplugged.
605 int usb_detect_change(void)
612 ret = uclass_get(UCLASS_USB_HUB, &uc);
616 uclass_foreach_dev(hub, uc) {
617 struct usb_device *udev;
620 if (!device_active(hub))
622 for (device_find_first_child(hub, &dev);
624 device_find_next_child(&dev)) {
625 struct usb_port_status status;
627 if (!device_active(dev))
630 udev = dev_get_parentdata(dev);
631 if (usb_get_port_status(udev, udev->portnr, &status)
633 /* USB request failed */
636 if (le16_to_cpu(status.wPortChange) &
637 USB_PORT_STAT_C_CONNECTION)
645 int usb_child_post_bind(struct udevice *dev)
647 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
648 const void *blob = gd->fdt_blob;
651 if (dev->of_offset == -1)
654 /* We only support matching a few things */
655 val = fdtdec_get_int(blob, dev->of_offset, "usb,device-class", -1);
657 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS;
658 plat->id.bDeviceClass = val;
660 val = fdtdec_get_int(blob, dev->of_offset, "usb,interface-class", -1);
662 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS;
663 plat->id.bInterfaceClass = val;
669 struct udevice *usb_get_bus(struct udevice *dev)
673 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; )
676 /* By design this cannot happen */
678 debug("USB HUB '%s' does not have a controller\n", dev->name);
684 int usb_child_pre_probe(struct udevice *dev)
686 struct usb_device *udev = dev_get_parentdata(dev);
687 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev);
692 * Copy over all the values set in the on stack struct
693 * usb_device in usb_scan_device() to our final struct
694 * usb_device for this dev.
696 *udev = *(plat->udev);
697 /* And clear plat->udev as it will not be valid for long */
702 * This happens with devices which are explicitly bound
703 * instead of being discovered through usb_scan_device()
704 * such as sandbox emul devices.
707 udev->controller_dev = usb_get_bus(dev);
708 udev->devnum = plat->devnum;
711 * udev did not go through usb_scan_device(), so we need to
712 * select the config and read the config descriptors.
714 ret = usb_select_config(udev);
722 UCLASS_DRIVER(usb) = {
725 .flags = DM_UC_FLAG_SEQ_ALIAS,
726 .post_bind = usb_post_bind,
727 .priv_auto_alloc_size = sizeof(struct usb_uclass_priv),
728 .per_child_auto_alloc_size = sizeof(struct usb_device),
729 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv),
730 .child_post_bind = usb_child_post_bind,
731 .child_pre_probe = usb_child_pre_probe,
732 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
735 UCLASS_DRIVER(usb_dev_generic) = {
736 .id = UCLASS_USB_DEV_GENERIC,
737 .name = "usb_dev_generic",
740 U_BOOT_DRIVER(usb_dev_generic_drv) = {
741 .id = UCLASS_USB_DEV_GENERIC,
742 .name = "usb_dev_generic_drv",