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
);
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
);
146 struct usb_uclass_priv
*uc_priv
;
149 /* De-activate any devices that have been activated */
150 ret
= uclass_get(UCLASS_USB
, &uc
);
156 uclass_foreach_dev(bus
, uc
) {
157 ret
= device_remove(bus
);
160 ret
= device_unbind_children(bus
);
165 #ifdef CONFIG_SANDBOX
168 /* Reset all enulation devices */
169 ret
= uclass_get(UCLASS_USB_EMUL
, &uc
);
173 uclass_foreach_dev(dev
, uc
)
176 #ifdef CONFIG_USB_STORAGE
180 uc_priv
->companion_device_count
= 0;
186 static void usb_scan_bus(struct udevice
*bus
, bool recurse
)
188 struct usb_bus_priv
*priv
;
192 priv
= dev_get_uclass_priv(bus
);
194 assert(recurse
); /* TODO: Support non-recusive */
196 printf("scanning bus %d for devices... ", bus
->seq
);
198 ret
= usb_scan_device(bus
, 0, USB_SPEED_FULL
, &dev
);
200 printf("failed, error %d\n", ret
);
201 else if (priv
->next_addr
== 0)
202 printf("No USB Device found\n");
204 printf("%d USB Device(s) found\n", priv
->next_addr
);
209 int controllers_initialized
= 0;
210 struct usb_uclass_priv
*uc_priv
;
211 struct usb_bus_priv
*priv
;
220 ret
= uclass_get(UCLASS_USB
, &uc
);
226 uclass_foreach_dev(bus
, uc
) {
227 /* init low_level USB */
228 printf("USB%d: ", count
);
230 ret
= device_probe(bus
);
231 if (ret
== -ENODEV
) { /* No such device. */
232 puts("Port not available.\n");
233 controllers_initialized
++;
237 if (ret
) { /* Other error. */
238 printf("probe failed, error %d\n", ret
);
241 controllers_initialized
++;
246 * lowlevel init done, now scan the bus for devices i.e. search HUBs
247 * and configure them, first scan primary controllers.
249 uclass_foreach_dev(bus
, uc
) {
250 if (!device_active(bus
))
253 priv
= dev_get_uclass_priv(bus
);
254 if (!priv
->companion
)
255 usb_scan_bus(bus
, true);
259 * Now that the primary controllers have been scanned and have handed
260 * over any devices they do not understand to their companions, scan
261 * the companions if necessary.
263 if (uc_priv
->companion_device_count
) {
264 uclass_foreach_dev(bus
, uc
) {
265 if (!device_active(bus
))
268 priv
= dev_get_uclass_priv(bus
);
270 usb_scan_bus(bus
, true);
275 /* if we were not able to find at least one working bus, bail out */
277 printf("No controllers found\n");
278 else if (controllers_initialized
== 0)
279 printf("USB error: all controllers failed lowlevel init\n");
281 return usb_started
? 0 : -1;
284 static struct usb_device
*find_child_devnum(struct udevice
*parent
, int devnum
)
286 struct usb_device
*udev
;
289 if (!device_active(parent
))
291 udev
= dev_get_parentdata(parent
);
292 if (udev
->devnum
== devnum
)
295 for (device_find_first_child(parent
, &dev
);
297 device_find_next_child(&dev
)) {
298 udev
= find_child_devnum(dev
, devnum
);
306 struct usb_device
*usb_get_dev_index(struct udevice
*bus
, int index
)
309 int devnum
= index
+ 1; /* Addresses are allocated from 1 on USB */
311 device_find_first_child(bus
, &dev
);
315 return find_child_devnum(dev
, devnum
);
318 int usb_post_bind(struct udevice
*dev
)
320 /* Scan the bus for devices */
321 return dm_scan_fdt_node(dev
, gd
->fdt_blob
, dev
->of_offset
, false);
324 int usb_setup_ehci_gadget(struct ehci_ctrl
**ctlrp
)
326 struct usb_platdata
*plat
;
330 /* Find the old device and remove it */
331 ret
= uclass_find_device_by_seq(UCLASS_USB
, 0, true, &dev
);
334 ret
= device_remove(dev
);
338 plat
= dev_get_platdata(dev
);
339 plat
->init_type
= USB_INIT_DEVICE
;
340 ret
= device_probe(dev
);
343 *ctlrp
= dev_get_priv(dev
);
348 /* returns 0 if no match, 1 if match */
349 int usb_match_device(const struct usb_device_descriptor
*desc
,
350 const struct usb_device_id
*id
)
352 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
353 id
->idVendor
!= le16_to_cpu(desc
->idVendor
))
356 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_PRODUCT
) &&
357 id
->idProduct
!= le16_to_cpu(desc
->idProduct
))
360 /* No need to test id->bcdDevice_lo != 0, since 0 is never
361 greater than any unsigned number. */
362 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_LO
) &&
363 (id
->bcdDevice_lo
> le16_to_cpu(desc
->bcdDevice
)))
366 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_HI
) &&
367 (id
->bcdDevice_hi
< le16_to_cpu(desc
->bcdDevice
)))
370 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_CLASS
) &&
371 (id
->bDeviceClass
!= desc
->bDeviceClass
))
374 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_SUBCLASS
) &&
375 (id
->bDeviceSubClass
!= desc
->bDeviceSubClass
))
378 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_DEV_PROTOCOL
) &&
379 (id
->bDeviceProtocol
!= desc
->bDeviceProtocol
))
385 /* returns 0 if no match, 1 if match */
386 int usb_match_one_id_intf(const struct usb_device_descriptor
*desc
,
387 const struct usb_interface_descriptor
*int_desc
,
388 const struct usb_device_id
*id
)
390 /* The interface class, subclass, protocol and number should never be
391 * checked for a match if the device class is Vendor Specific,
392 * unless the match record specifies the Vendor ID. */
393 if (desc
->bDeviceClass
== USB_CLASS_VENDOR_SPEC
&&
394 !(id
->match_flags
& USB_DEVICE_ID_MATCH_VENDOR
) &&
395 (id
->match_flags
& (USB_DEVICE_ID_MATCH_INT_CLASS
|
396 USB_DEVICE_ID_MATCH_INT_SUBCLASS
|
397 USB_DEVICE_ID_MATCH_INT_PROTOCOL
|
398 USB_DEVICE_ID_MATCH_INT_NUMBER
)))
401 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_CLASS
) &&
402 (id
->bInterfaceClass
!= int_desc
->bInterfaceClass
))
405 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_SUBCLASS
) &&
406 (id
->bInterfaceSubClass
!= int_desc
->bInterfaceSubClass
))
409 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_PROTOCOL
) &&
410 (id
->bInterfaceProtocol
!= int_desc
->bInterfaceProtocol
))
413 if ((id
->match_flags
& USB_DEVICE_ID_MATCH_INT_NUMBER
) &&
414 (id
->bInterfaceNumber
!= int_desc
->bInterfaceNumber
))
420 /* returns 0 if no match, 1 if match */
421 int usb_match_one_id(struct usb_device_descriptor
*desc
,
422 struct usb_interface_descriptor
*int_desc
,
423 const struct usb_device_id
*id
)
425 if (!usb_match_device(desc
, id
))
428 return usb_match_one_id_intf(desc
, int_desc
, id
);
432 * usb_find_and_bind_driver() - Find and bind the right USB driver
434 * This only looks at certain fields in the descriptor.
436 static int usb_find_and_bind_driver(struct udevice
*parent
,
437 struct usb_device_descriptor
*desc
,
438 struct usb_interface_descriptor
*iface
,
439 int bus_seq
, int devnum
,
440 struct udevice
**devp
)
442 struct usb_driver_entry
*start
, *entry
;
448 debug("%s: Searching for driver\n", __func__
);
449 start
= ll_entry_start(struct usb_driver_entry
, usb_driver_entry
);
450 n_ents
= ll_entry_count(struct usb_driver_entry
, usb_driver_entry
);
451 for (entry
= start
; entry
!= start
+ n_ents
; entry
++) {
452 const struct usb_device_id
*id
;
454 const struct driver
*drv
;
455 struct usb_dev_platdata
*plat
;
457 for (id
= entry
->match
; id
->match_flags
; id
++) {
458 if (!usb_match_one_id(desc
, iface
, id
))
463 * We could pass the descriptor to the driver as
464 * platdata (instead of NULL) and allow its bind()
465 * method to return -ENOENT if it doesn't support this
466 * device. That way we could continue the search to
467 * find another driver. For now this doesn't seem
468 * necesssary, so just bind the first match.
470 ret
= device_bind(parent
, drv
, drv
->name
, NULL
, -1,
474 debug("%s: Match found: %s\n", __func__
, drv
->name
);
475 dev
->driver_data
= id
->driver_info
;
476 plat
= dev_get_parent_platdata(dev
);
483 /* Bind a generic driver so that the device can be used */
484 snprintf(name
, sizeof(name
), "generic_bus_%x_dev_%x", bus_seq
, devnum
);
488 ret
= device_bind_driver(parent
, "usb_dev_generic_drv", str
, devp
);
491 debug("%s: No match found: %d\n", __func__
, ret
);
496 * usb_find_emul_child() - Find an existing device for emulated devices
498 static int usb_find_emul_child(struct udevice
*parent
,
499 struct usb_device_descriptor
*desc
,
500 struct usb_interface_descriptor
*iface
,
501 struct udevice
**devp
)
503 #ifdef CONFIG_SANDBOX
507 for (device_find_first_child(parent
, &dev
);
509 device_find_next_child(&dev
)) {
510 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
512 /* If this device is already in use, skip it */
513 if (device_active(dev
))
515 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__
,
516 dev
->name
, plat
->id
.bDeviceClass
, desc
->bDeviceClass
);
517 if (usb_match_one_id(desc
, iface
, &plat
->id
)) {
526 int usb_scan_device(struct udevice
*parent
, int port
,
527 enum usb_device_speed speed
, struct udevice
**devp
)
530 bool created
= false;
531 struct usb_dev_platdata
*plat
;
532 struct usb_bus_priv
*priv
;
533 struct usb_device
*parent_udev
;
535 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device
, udev
, 1);
536 struct usb_interface_descriptor
*iface
= &udev
->config
.if_desc
[0].desc
;
539 memset(udev
, '\0', sizeof(*udev
));
540 udev
->controller_dev
= usb_get_bus(parent
);
541 priv
= dev_get_uclass_priv(udev
->controller_dev
);
544 * Somewhat nasty, this. We create a local device and use the normal
545 * USB stack to read its descriptor. Then we know what type of device
546 * to create for real.
548 * udev->dev is set to the parent, since we don't have a real device
549 * yet. The USB stack should not access udev.dev anyway, except perhaps
550 * to find the controller, and the controller will either be @parent,
551 * or some parent of @parent.
553 * Another option might be to create the device as a generic USB
554 * device, then morph it into the correct one when we know what it
555 * should be. This means that a generic USB device would morph into
556 * a network controller, or a USB flash stick, for example. However,
557 * we don't support such morphing and it isn't clear that it would
560 * Yet another option is to split out the USB stack parts of udev
561 * into something like a 'struct urb' (as Linux does) which can exist
562 * independently of any device. This feels cleaner, but calls for quite
563 * a big change to the USB stack.
565 * For now, the approach is to set up an empty udev, read its
566 * descriptor and assign it an address, then bind a real device and
567 * stash the resulting information into the device's parent
568 * platform data. Then when we probe it, usb_child_pre_probe() is called
569 * and it will pull the information out of the stash.
573 udev
->devnum
= priv
->next_addr
+ 1;
575 debug("Calling usb_setup_device(), portnr=%d\n", udev
->portnr
);
576 parent_udev
= device_get_uclass_id(parent
) == UCLASS_USB_HUB
?
577 dev_get_parentdata(parent
) : NULL
;
578 ret
= usb_setup_device(udev
, priv
->desc_before_addr
, parent_udev
);
579 debug("read_descriptor for '%s': ret=%d\n", parent
->name
, ret
);
582 ret
= usb_find_emul_child(parent
, &udev
->descriptor
, iface
, &dev
);
583 debug("** usb_find_emul_child returns %d\n", ret
);
587 ret
= usb_find_and_bind_driver(parent
, &udev
->descriptor
, iface
,
588 udev
->controller_dev
->seq
,
594 plat
= dev_get_parent_platdata(dev
);
595 debug("%s: Probing '%s', plat=%p\n", __func__
, dev
->name
, plat
);
596 plat
->devnum
= udev
->devnum
;
599 ret
= device_probe(dev
);
601 debug("%s: Device '%s' probe failed\n", __func__
, dev
->name
);
613 * Detect if a USB device has been plugged or unplugged.
615 int usb_detect_change(void)
622 ret
= uclass_get(UCLASS_USB_HUB
, &uc
);
626 uclass_foreach_dev(hub
, uc
) {
627 struct usb_device
*udev
;
630 if (!device_active(hub
))
632 for (device_find_first_child(hub
, &dev
);
634 device_find_next_child(&dev
)) {
635 struct usb_port_status status
;
637 if (!device_active(dev
))
640 udev
= dev_get_parentdata(dev
);
641 if (usb_get_port_status(udev
, udev
->portnr
, &status
)
643 /* USB request failed */
646 if (le16_to_cpu(status
.wPortChange
) &
647 USB_PORT_STAT_C_CONNECTION
)
655 int usb_child_post_bind(struct udevice
*dev
)
657 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
658 const void *blob
= gd
->fdt_blob
;
661 if (dev
->of_offset
== -1)
664 /* We only support matching a few things */
665 val
= fdtdec_get_int(blob
, dev
->of_offset
, "usb,device-class", -1);
667 plat
->id
.match_flags
|= USB_DEVICE_ID_MATCH_DEV_CLASS
;
668 plat
->id
.bDeviceClass
= val
;
670 val
= fdtdec_get_int(blob
, dev
->of_offset
, "usb,interface-class", -1);
672 plat
->id
.match_flags
|= USB_DEVICE_ID_MATCH_INT_CLASS
;
673 plat
->id
.bInterfaceClass
= val
;
679 struct udevice
*usb_get_bus(struct udevice
*dev
)
683 for (bus
= dev
; bus
&& device_get_uclass_id(bus
) != UCLASS_USB
; )
686 /* By design this cannot happen */
688 debug("USB HUB '%s' does not have a controller\n", dev
->name
);
694 int usb_child_pre_probe(struct udevice
*dev
)
696 struct usb_device
*udev
= dev_get_parentdata(dev
);
697 struct usb_dev_platdata
*plat
= dev_get_parent_platdata(dev
);
702 * Copy over all the values set in the on stack struct
703 * usb_device in usb_scan_device() to our final struct
704 * usb_device for this dev.
706 *udev
= *(plat
->udev
);
707 /* And clear plat->udev as it will not be valid for long */
712 * This happens with devices which are explicitly bound
713 * instead of being discovered through usb_scan_device()
714 * such as sandbox emul devices.
717 udev
->controller_dev
= usb_get_bus(dev
);
718 udev
->devnum
= plat
->devnum
;
721 * udev did not go through usb_scan_device(), so we need to
722 * select the config and read the config descriptors.
724 ret
= usb_select_config(udev
);
732 UCLASS_DRIVER(usb
) = {
735 .flags
= DM_UC_FLAG_SEQ_ALIAS
,
736 .post_bind
= usb_post_bind
,
737 .priv_auto_alloc_size
= sizeof(struct usb_uclass_priv
),
738 .per_child_auto_alloc_size
= sizeof(struct usb_device
),
739 .per_device_auto_alloc_size
= sizeof(struct usb_bus_priv
),
740 .child_post_bind
= usb_child_post_bind
,
741 .child_pre_probe
= usb_child_pre_probe
,
742 .per_child_platdata_auto_alloc_size
= sizeof(struct usb_dev_platdata
),
745 UCLASS_DRIVER(usb_dev_generic
) = {
746 .id
= UCLASS_USB_DEV_GENERIC
,
747 .name
= "usb_dev_generic",
750 U_BOOT_DRIVER(usb_dev_generic_drv
) = {
751 .id
= UCLASS_USB_DEV_GENERIC
,
752 .name
= "usb_dev_generic_drv",