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_port_reset(struct usb_device
*parent
, int portnr
)
315 unsigned short portstatus
;
318 debug("%s: start\n", __func__
);
321 /* reset the port for the second time */
323 debug("%s: reset %d\n", __func__
, portnr
- 1);
324 ret
= legacy_hub_port_reset(parent
, portnr
- 1, &portstatus
);
326 printf("\n Couldn't reset port %i\n", portnr
);
330 debug("%s: reset root\n", __func__
);
331 usb_reset_root_port();
337 int usb_legacy_port_reset(struct usb_device
*parent
, int portnr
)
339 return usb_port_reset(parent
, portnr
);
342 int usb_setup_ehci_gadget(struct ehci_ctrl
**ctlrp
)
344 struct usb_platdata
*plat
;
348 /* Find the old device and remove it */
349 ret
= uclass_find_device_by_seq(UCLASS_USB
, 0, true, &dev
);
352 ret
= device_remove(dev
);
356 plat
= dev_get_platdata(dev
);
357 plat
->init_type
= USB_INIT_DEVICE
;
358 ret
= device_probe(dev
);
361 *ctlrp
= dev_get_priv(dev
);
366 /* returns 0 if no match, 1 if match */
367 int usb_match_device(const struct usb_device_descriptor
*desc
,
368 const struct usb_device_id
*id
)
370 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
371 id
->idVendor
!= le16_to_cpu(desc
->idVendor
))
374 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
375 id
->idProduct
!= le16_to_cpu(desc
->idProduct
))
378 /* No need to test id->bcdDevice_lo != 0, since 0 is never
379 greater than any unsigned number. */
380 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
381 (id
->bcdDevice_lo
> le16_to_cpu(desc
->bcdDevice
)))
384 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
385 (id
->bcdDevice_hi
< le16_to_cpu(desc
->bcdDevice
)))
388 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
389 (id
->bDeviceClass
!= desc
->bDeviceClass
))
392 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
393 (id
->bDeviceSubClass
!= desc
->bDeviceSubClass
))
396 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
397 (id
->bDeviceProtocol
!= desc
->bDeviceProtocol
))
403 /* returns 0 if no match, 1 if match */
404 int usb_match_one_id_intf(const struct usb_device_descriptor
*desc
,
405 const struct usb_interface_descriptor
*int_desc
,
406 const struct usb_device_id
*id
)
408 /* The interface class, subclass, protocol and number should never be
409 * checked for a match if the device class is Vendor Specific,
410 * unless the match record specifies the Vendor ID. */
411 if (desc
->bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
412 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
413 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
414 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
415 USB_DEVICE_ID_MATCH_INT_PROTOCOL
|
416 USB_DEVICE_ID_MATCH_INT_NUMBER
)))
419 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
420 (id
->bInterfaceClass
!= int_desc
->bInterfaceClass
))
423 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
424 (id
->bInterfaceSubClass
!= int_desc
->bInterfaceSubClass
))
427 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
428 (id
->bInterfaceProtocol
!= int_desc
->bInterfaceProtocol
))
431 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_NUMBER
) &&
432 (id
->bInterfaceNumber
!= int_desc
->bInterfaceNumber
))
438 /* returns 0 if no match, 1 if match */
439 int usb_match_one_id(struct usb_device_descriptor
*desc
,
440 struct usb_interface_descriptor
*int_desc
,
441 const struct usb_device_id
*id
)
443 if (!usb_match_device(desc
, id
))
446 return usb_match_one_id_intf(desc
, int_desc
, id
);
450 * usb_find_and_bind_driver() - Find and bind the right USB driver
452 * This only looks at certain fields in the descriptor.
454 static int usb_find_and_bind_driver(struct udevice
*parent
,
455 struct usb_device_descriptor
*desc
,
456 struct usb_interface_descriptor
*iface
,
457 int bus_seq
, int devnum
,
458 struct udevice
**devp
)
460 struct usb_driver_entry
*start
, *entry
;
466 debug("%s: Searching for driver\n", __func__
);
467 start
= ll_entry_start(struct usb_driver_entry
, usb_driver_entry
);
468 n_ents
= ll_entry_count(struct usb_driver_entry
, usb_driver_entry
);
469 for (entry
= start
; entry
!= start
+ n_ents
; entry
++) {
470 const struct usb_device_id
*id
;
472 const struct driver
*drv
;
473 struct usb_dev_platdata
*plat
;
475 for (id
= entry
->match
; id
->match_flags
; id
++) {
476 if (!usb_match_one_id(desc
, iface
, id
))
481 * We could pass the descriptor to the driver as
482 * platdata (instead of NULL) and allow its bind()
483 * method to return -ENOENT if it doesn't support this
484 * device. That way we could continue the search to
485 * find another driver. For now this doesn't seem
486 * necesssary, so just bind the first match.
488 ret
= device_bind(parent
, drv
, drv
->name
, NULL
, -1,
492 debug("%s: Match found: %s\n", __func__
, drv
->name
);
493 dev
->driver_data
= id
->driver_info
;
494 plat
= dev_get_parent_platdata(dev
);
501 /* Bind a generic driver so that the device can be used */
502 snprintf(name
, sizeof(name
), "generic_bus_%x_dev_%x", bus_seq
, devnum
);
506 ret
= device_bind_driver(parent
, "usb_dev_generic_drv", str
, devp
);
509 debug("%s: No match found: %d\n", __func__
, ret
);
514 * usb_find_child() - Find an existing device which matches our needs
518 static int usb_find_child(struct udevice
*parent
,
519 struct usb_device_descriptor
*desc
,
520 struct usb_interface_descriptor
*iface
,
521 struct udevice
**devp
)
526 for (device_find_first_child(parent
, &dev
);
528 device_find_next_child(&dev
)) {
529 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
531 /* If this device is already in use, skip it */
532 if (device_active(dev
))
534 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__
,
535 dev
->name
, plat
->id
.bDeviceClass
, desc
->bDeviceClass
);
536 if (usb_match_one_id(desc
, iface
, &plat
->id
)) {
545 int usb_scan_device(struct udevice
*parent
, int port
,
546 enum usb_device_speed speed
, struct udevice
**devp
)
549 bool created
= false;
550 struct usb_dev_platdata
*plat
;
551 struct usb_bus_priv
*priv
;
552 struct usb_device
*parent_udev
;
554 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device
, udev
, 1);
555 struct usb_interface_descriptor
*iface
= &udev
->config
.if_desc
[0].desc
;
558 memset(udev
, '\0', sizeof(*udev
));
559 udev
->controller_dev
= usb_get_bus(parent
);
560 priv
= dev_get_uclass_priv(udev
->controller_dev
);
563 * Somewhat nasty, this. We create a local device and use the normal
564 * USB stack to read its descriptor. Then we know what type of device
565 * to create for real.
567 * udev->dev is set to the parent, since we don't have a real device
568 * yet. The USB stack should not access udev.dev anyway, except perhaps
569 * to find the controller, and the controller will either be @parent,
570 * or some parent of @parent.
572 * Another option might be to create the device as a generic USB
573 * device, then morph it into the correct one when we know what it
574 * should be. This means that a generic USB device would morph into
575 * a network controller, or a USB flash stick, for example. However,
576 * we don't support such morphing and it isn't clear that it would
579 * Yet another option is to split out the USB stack parts of udev
580 * into something like a 'struct urb' (as Linux does) which can exist
581 * independently of any device. This feels cleaner, but calls for quite
582 * a big change to the USB stack.
584 * For now, the approach is to set up an empty udev, read its
585 * descriptor and assign it an address, then bind a real device and
586 * stash the resulting information into the device's parent
587 * platform data. Then when we probe it, usb_child_pre_probe() is called
588 * and it will pull the information out of the stash.
592 udev
->devnum
= priv
->next_addr
+ 1;
594 debug("Calling usb_setup_device(), portnr=%d\n", udev
->portnr
);
595 parent_udev
= device_get_uclass_id(parent
) == UCLASS_USB_HUB
?
596 dev_get_parentdata(parent
) : NULL
;
597 ret
= usb_setup_device(udev
, priv
->desc_before_addr
, parent_udev
, port
);
598 debug("read_descriptor for '%s': ret=%d\n", parent
->name
, ret
);
601 ret
= usb_find_child(parent
, &udev
->descriptor
, iface
, &dev
);
602 debug("** usb_find_child returns %d\n", ret
);
606 ret
= usb_find_and_bind_driver(parent
, &udev
->descriptor
, iface
,
607 udev
->controller_dev
->seq
,
613 plat
= dev_get_parent_platdata(dev
);
614 debug("%s: Probing '%s', plat=%p\n", __func__
, dev
->name
, plat
);
615 plat
->devnum
= udev
->devnum
;
618 ret
= device_probe(dev
);
620 debug("%s: Device '%s' probe failed\n", __func__
, dev
->name
);
632 * Detect if a USB device has been plugged or unplugged.
634 int usb_detect_change(void)
641 ret
= uclass_get(UCLASS_USB_HUB
, &uc
);
645 uclass_foreach_dev(hub
, uc
) {
646 struct usb_device
*udev
;
649 if (!device_active(hub
))
651 for (device_find_first_child(hub
, &dev
);
653 device_find_next_child(&dev
)) {
654 struct usb_port_status status
;
656 if (!device_active(dev
))
659 udev
= dev_get_parentdata(dev
);
660 if (usb_get_port_status(udev
, udev
->portnr
, &status
)
662 /* USB request failed */
665 if (le16_to_cpu(status
.wPortChange
) &
666 USB_PORT_STAT_C_CONNECTION
)
674 int usb_child_post_bind(struct udevice
*dev
)
676 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
677 const void *blob
= gd
->fdt_blob
;
680 if (dev
->of_offset
== -1)
683 /* We only support matching a few things */
684 val
= fdtdec_get_int(blob
, dev
->of_offset
, "usb,device-class", -1);
686 plat
->id
.match_flags
|= USB_DEVICE_ID_MATCH_DEV_CLASS
;
687 plat
->id
.bDeviceClass
= val
;
689 val
= fdtdec_get_int(blob
, dev
->of_offset
, "usb,interface-class", -1);
691 plat
->id
.match_flags
|= USB_DEVICE_ID_MATCH_INT_CLASS
;
692 plat
->id
.bInterfaceClass
= val
;
698 struct udevice
*usb_get_bus(struct udevice
*dev
)
702 for (bus
= dev
; bus
&& device_get_uclass_id(bus
) != UCLASS_USB
; )
705 /* By design this cannot happen */
707 debug("USB HUB '%s' does not have a controller\n", dev
->name
);
713 int usb_child_pre_probe(struct udevice
*dev
)
715 struct usb_device
*udev
= dev_get_parentdata(dev
);
716 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
721 * Copy over all the values set in the on stack struct
722 * usb_device in usb_scan_device() to our final struct
723 * usb_device for this dev.
725 *udev
= *(plat
->udev
);
726 /* And clear plat->udev as it will not be valid for long */
731 * This happens with devices which are explicitly bound
732 * instead of being discovered through usb_scan_device()
733 * such as sandbox emul devices.
736 udev
->controller_dev
= usb_get_bus(dev
);
737 udev
->devnum
= plat
->devnum
;
740 * udev did not go through usb_scan_device(), so we need to
741 * select the config and read the config descriptors.
743 ret
= usb_select_config(udev
);
751 UCLASS_DRIVER(usb
) = {
754 .flags
= DM_UC_FLAG_SEQ_ALIAS
,
755 .post_bind
= usb_post_bind
,
756 .priv_auto_alloc_size
= sizeof(struct usb_uclass_priv
),
757 .per_child_auto_alloc_size
= sizeof(struct usb_device
),
758 .per_device_auto_alloc_size
= sizeof(struct usb_bus_priv
),
759 .child_post_bind
= usb_child_post_bind
,
760 .child_pre_probe
= usb_child_pre_probe
,
761 .per_child_platdata_auto_alloc_size
= sizeof(struct usb_dev_platdata
),
764 UCLASS_DRIVER(usb_dev_generic
) = {
765 .id
= UCLASS_USB_DEV_GENERIC
,
766 .name
= "usb_dev_generic",
769 U_BOOT_DRIVER(usb_dev_generic_drv
) = {
770 .id
= UCLASS_USB_DEV_GENERIC
,
771 .name
= "usb_dev_generic_drv",