3 * Denis Peter, MPL AG Switzerland
5 * Adapted for U-Boot driver model
6 * (C) Copyright 2015 Google, Inc
8 * Most of this source has been derived from the Linux USB
11 * SPDX-License-Identifier: GPL-2.0+
18 #include <dm/uclass-internal.h>
20 #include <asm/byteorder.h>
21 #include <asm/unaligned.h>
25 #ifdef CONFIG_USB_STORAGE
26 static int usb_stor_curr_dev = -1; /* current device */
28 #if defined(CONFIG_USB_HOST_ETHER) && !defined(CONFIG_DM_ETH)
29 static int __maybe_unused usb_ether_curr_dev = -1; /* current ethernet device */
32 /* some display routines (info command) */
33 static char *usb_get_class_desc(unsigned char dclass)
36 case USB_CLASS_PER_INTERFACE:
37 return "See Interface";
41 return "Communication";
43 return "Human Interface";
44 case USB_CLASS_PRINTER:
46 case USB_CLASS_MASS_STORAGE:
47 return "Mass Storage";
52 case USB_CLASS_VENDOR_SPEC:
53 return "Vendor specific";
59 static void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
63 case USB_CLASS_PER_INTERFACE:
64 printf("See Interface");
67 printf("Human Interface, Subclass: ");
69 case USB_SUB_HID_NONE:
72 case USB_SUB_HID_BOOT:
75 case USB_PROT_HID_NONE:
78 case USB_PROT_HID_KEYBOARD:
81 case USB_PROT_HID_MOUSE:
94 case USB_CLASS_MASS_STORAGE:
95 printf("Mass Storage, ");
101 printf("SFF-8020i (ATAPI)");
104 printf("QIC-157 (Tape)");
113 printf("Transp. SCSI");
122 printf("Command/Bulk");
125 printf("Command/Bulk/Int");
136 printf("%s", usb_get_class_desc(dclass));
141 static void usb_display_string(struct usb_device *dev, int index)
143 ALLOC_CACHE_ALIGN_BUFFER(char, buffer, 256);
146 if (usb_string(dev, index, &buffer[0], 256) > 0)
147 printf("String: \"%s\"", buffer);
151 static void usb_display_desc(struct usb_device *dev)
153 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
154 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
155 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
156 (dev->descriptor.bcdUSB>>8) & 0xff,
157 dev->descriptor.bcdUSB & 0xff);
159 if (strlen(dev->mf) || strlen(dev->prod) ||
161 printf(" - %s %s %s\n", dev->mf, dev->prod,
163 if (dev->descriptor.bDeviceClass) {
164 printf(" - Class: ");
165 usb_display_class_sub(dev->descriptor.bDeviceClass,
166 dev->descriptor.bDeviceSubClass,
167 dev->descriptor.bDeviceProtocol);
170 printf(" - Class: (from Interface) %s\n",
172 dev->config.if_desc[0].desc.bInterfaceClass));
174 printf(" - PacketSize: %d Configurations: %d\n",
175 dev->descriptor.bMaxPacketSize0,
176 dev->descriptor.bNumConfigurations);
177 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
178 dev->descriptor.idVendor, dev->descriptor.idProduct,
179 (dev->descriptor.bcdDevice>>8) & 0xff,
180 dev->descriptor.bcdDevice & 0xff);
185 static void usb_display_conf_desc(struct usb_config_descriptor *config,
186 struct usb_device *dev)
188 printf(" Configuration: %d\n", config->bConfigurationValue);
189 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
190 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
191 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
192 config->bMaxPower*2);
193 if (config->iConfiguration) {
195 usb_display_string(dev, config->iConfiguration);
200 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
201 struct usb_device *dev)
203 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
204 printf(" - Alternate Setting %d, Endpoints: %d\n",
205 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
207 usb_display_class_sub(ifdesc->bInterfaceClass,
208 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
210 if (ifdesc->iInterface) {
212 usb_display_string(dev, ifdesc->iInterface);
217 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
219 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
220 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
221 switch ((epdesc->bmAttributes & 0x03)) {
226 printf("Isochronous");
235 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
236 if ((epdesc->bmAttributes & 0x03) == 0x3)
237 printf(" Interval %dms", epdesc->bInterval);
241 /* main routine to diasplay the configs, interfaces and endpoints */
242 static void usb_display_config(struct usb_device *dev)
244 struct usb_config *config;
245 struct usb_interface *ifdesc;
246 struct usb_endpoint_descriptor *epdesc;
249 config = &dev->config;
250 usb_display_conf_desc(&config->desc, dev);
251 for (i = 0; i < config->no_of_if; i++) {
252 ifdesc = &config->if_desc[i];
253 usb_display_if_desc(&ifdesc->desc, dev);
254 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
255 epdesc = &ifdesc->ep_desc[ii];
256 usb_display_ep_desc(epdesc);
263 * With driver model this isn't right since we can have multiple controllers
264 * and the device numbering starts at 1 on each bus.
265 * TODO(sjg@chromium.org): Add a way to specify the controller/bus.
267 static struct usb_device *usb_find_device(int devnum)
270 struct usb_device *udev;
275 /* Device addresses start at 1 */
277 ret = uclass_get(UCLASS_USB_HUB, &uc);
281 uclass_foreach_dev(hub, uc) {
284 if (!device_active(hub))
286 udev = dev_get_parent_priv(hub);
287 if (udev->devnum == devnum)
290 for (device_find_first_child(hub, &dev);
292 device_find_next_child(&dev)) {
293 if (!device_active(hub))
296 udev = dev_get_parent_priv(dev);
297 if (udev->devnum == devnum)
302 struct usb_device *udev;
305 for (d = 0; d < USB_MAX_DEVICE; d++) {
306 udev = usb_get_dev_index(d);
309 if (udev->devnum == devnum)
317 static inline char *portspeed(int speed)
322 case USB_SPEED_SUPER:
323 speed_str = "5 Gb/s";
326 speed_str = "480 Mb/s";
329 speed_str = "1.5 Mb/s";
332 speed_str = "12 Mb/s";
339 /* shows the device tree recursively */
340 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
343 int has_child, last_child;
348 has_child = device_has_active_children(dev->dev);
350 /* check if the device has connected children */
354 for (i = 0; i < dev->maxchild; i++) {
355 if (dev->children[i] != NULL)
359 /* check if we are the last one */
361 /* Not the root of the usb tree? */
362 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
363 last_child = device_is_last_sibling(dev->dev);
365 if (dev->parent != NULL) { /* not root? */
367 for (i = 0; i < dev->parent->maxchild; i++) {
368 /* search for children */
369 if (dev->parent->children[i] == dev) {
370 /* found our pointer, see if we have a
373 while (i++ < dev->parent->maxchild) {
374 if (dev->parent->children[i] != NULL) {
381 } /* for all children of the parent */
384 /* correct last child */
385 if (last_child && index)
387 } /* if not root hub */
390 printf("%d ", dev->devnum);
392 pre[index++] = has_child ? '|' : ' ';
394 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
395 dev->config.if_desc[0].desc.bInterfaceClass),
396 portspeed(dev->speed),
397 dev->config.desc.bMaxPower * 2);
398 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
399 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
400 printf(" %s\n", pre);
402 struct udevice *child;
404 for (device_find_first_child(dev->dev, &child);
406 device_find_next_child(&child)) {
407 struct usb_device *udev;
409 if (!device_active(child))
412 udev = dev_get_parent_priv(child);
414 /* Ignore emulators, we only want real devices */
415 if (device_get_uclass_id(child) != UCLASS_USB_EMUL) {
416 usb_show_tree_graph(udev, pre);
421 if (dev->maxchild > 0) {
422 for (i = 0; i < dev->maxchild; i++) {
423 if (dev->children[i] != NULL) {
424 usb_show_tree_graph(dev->children[i], pre);
432 /* main routine for the tree command */
433 static void usb_show_subtree(struct usb_device *dev)
437 memset(preamble, '\0', sizeof(preamble));
438 usb_show_tree_graph(dev, &preamble[0]);
442 typedef void (*usb_dev_func_t)(struct usb_device *udev);
444 static void usb_for_each_root_dev(usb_dev_func_t func)
448 for (uclass_find_first_device(UCLASS_USB, &bus);
450 uclass_find_next_device(&bus)) {
451 struct usb_device *udev;
454 if (!device_active(bus))
457 device_find_first_child(bus, &dev);
458 if (dev && device_active(dev)) {
459 udev = dev_get_parent_priv(dev);
466 void usb_show_tree(void)
469 usb_for_each_root_dev(usb_show_subtree);
471 struct usb_device *udev;
474 for (i = 0; i < USB_MAX_DEVICE; i++) {
475 udev = usb_get_dev_index(i);
478 if (udev->parent == NULL)
479 usb_show_subtree(udev);
484 static int usb_test(struct usb_device *dev, int port, char* arg)
488 if (port > dev->maxchild) {
489 printf("Device is no hub or does not have %d ports.\n", port);
496 printf("Setting Test_J mode");
497 mode = USB_TEST_MODE_J;
501 printf("Setting Test_K mode");
502 mode = USB_TEST_MODE_K;
506 printf("Setting Test_SE0_NAK mode");
507 mode = USB_TEST_MODE_SE0_NAK;
511 printf("Setting Test_Packet mode");
512 mode = USB_TEST_MODE_PACKET;
516 printf("Setting Test_Force_Enable mode");
517 mode = USB_TEST_MODE_FORCE_ENABLE;
520 printf("Unrecognized test mode: %s\nAvailable modes: "
521 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
526 printf(" on downstream facing port %d...\n", port);
528 printf(" on upstream facing port...\n");
530 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
531 port ? USB_RT_PORT : USB_RECIP_DEVICE,
532 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
534 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
535 printf("Error during SET_FEATURE.\n");
538 printf("Test mode successfully set. Use 'usb start' "
539 "to return to normal operation.\n");
545 /******************************************************************************
546 * usb boot command intepreter. Derived from diskboot
548 #ifdef CONFIG_USB_STORAGE
549 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
551 return common_diskboot(cmdtp, "usb", argc, argv);
553 #endif /* CONFIG_USB_STORAGE */
555 static int do_usb_stop_keyboard(int force)
557 #if !defined CONFIG_DM_USB && defined CONFIG_USB_KEYBOARD
558 if (usb_kbd_deregister(force) != 0) {
559 printf("USB not stopped: usbkbd still using USB\n");
566 static void do_usb_start(void)
568 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
573 /* Driver model will probe the devices as they are found */
574 # ifdef CONFIG_USB_STORAGE
575 /* try to recognize storage devices immediately */
576 usb_stor_curr_dev = usb_stor_scan(1);
578 #ifndef CONFIG_DM_USB
579 # ifdef CONFIG_USB_KEYBOARD
582 #endif /* !CONFIG_DM_USB */
583 #ifdef CONFIG_USB_HOST_ETHER
584 # ifdef CONFIG_DM_ETH
585 # ifndef CONFIG_DM_USB
586 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
589 /* try to recognize ethernet devices immediately */
590 usb_ether_curr_dev = usb_host_eth_scan(1);
596 static void usb_show_info(struct usb_device *udev)
598 struct udevice *child;
600 usb_display_desc(udev);
601 usb_display_config(udev);
602 for (device_find_first_child(udev->dev, &child);
604 device_find_next_child(&child)) {
605 if (device_active(child)) {
606 udev = dev_get_parent_priv(child);
613 /******************************************************************************
614 * usb command intepreter
616 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
618 struct usb_device *udev = NULL;
620 extern char usb_started;
621 #ifdef CONFIG_USB_STORAGE
622 struct blk_desc *stor_dev;
626 return CMD_RET_USAGE;
628 if (strncmp(argv[1], "start", 5) == 0) {
630 return 0; /* Already started */
631 printf("starting USB...\n");
636 if (strncmp(argv[1], "reset", 5) == 0) {
637 printf("resetting USB...\n");
638 if (do_usb_stop_keyboard(1) != 0)
644 if (strncmp(argv[1], "stop", 4) == 0) {
646 console_assign(stdin, "serial");
647 if (do_usb_stop_keyboard(0) != 0)
649 printf("stopping USB..\n");
654 printf("USB is stopped. Please issue 'usb start' first.\n");
657 if (strncmp(argv[1], "tree", 4) == 0) {
658 puts("USB device tree:\n");
662 if (strncmp(argv[1], "inf", 3) == 0) {
665 usb_for_each_root_dev(usb_show_info);
668 for (d = 0; d < USB_MAX_DEVICE; d++) {
669 udev = usb_get_dev_index(d);
672 usb_display_desc(udev);
673 usb_display_config(udev);
679 * With driver model this isn't right since we can
680 * have multiple controllers and the device numbering
681 * starts at 1 on each bus.
683 i = simple_strtoul(argv[2], NULL, 10);
684 printf("config for device %d\n", i);
685 udev = usb_find_device(i);
687 printf("*** No device available ***\n");
690 usb_display_desc(udev);
691 usb_display_config(udev);
696 if (strncmp(argv[1], "test", 4) == 0) {
698 return CMD_RET_USAGE;
699 i = simple_strtoul(argv[2], NULL, 10);
700 udev = usb_find_device(i);
702 printf("Device %d does not exist.\n", i);
705 i = simple_strtoul(argv[3], NULL, 10);
706 return usb_test(udev, i, argv[4]);
708 #ifdef CONFIG_USB_STORAGE
709 if (strncmp(argv[1], "stor", 4) == 0)
710 return usb_stor_info();
712 if (strncmp(argv[1], "part", 4) == 0) {
715 for (devno = 0; ; ++devno) {
716 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB,
718 if (stor_dev == NULL)
720 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
724 debug("print_part of %x\n", devno);
725 part_print(stor_dev);
729 devno = simple_strtoul(argv[2], NULL, 16);
730 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB, devno);
731 if (stor_dev != NULL &&
732 stor_dev->type != DEV_TYPE_UNKNOWN) {
734 debug("print_part of %x\n", devno);
735 part_print(stor_dev);
739 printf("\nno USB devices available\n");
744 if (strcmp(argv[1], "read") == 0) {
745 if (usb_stor_curr_dev < 0) {
746 printf("no current device selected\n");
750 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
751 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
752 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
754 printf("\nUSB read: device %d block # %ld, count %ld"
755 " ... ", usb_stor_curr_dev, blk, cnt);
756 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB,
758 n = blk_dread(stor_dev, blk, cnt, (ulong *)addr);
759 printf("%ld blocks read: %s\n", n,
760 (n == cnt) ? "OK" : "ERROR");
766 if (strcmp(argv[1], "write") == 0) {
767 if (usb_stor_curr_dev < 0) {
768 printf("no current device selected\n");
772 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
773 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
774 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
776 printf("\nUSB write: device %d block # %ld, count %ld"
777 " ... ", usb_stor_curr_dev, blk, cnt);
778 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB,
780 n = blk_dwrite(stor_dev, blk, cnt, (ulong *)addr);
781 printf("%ld blocks write: %s\n", n,
782 (n == cnt) ? "OK" : "ERROR");
788 if (strncmp(argv[1], "dev", 3) == 0) {
790 int dev = (int)simple_strtoul(argv[2], NULL, 10);
791 printf("\nUSB device %d: ", dev);
792 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB, dev);
793 if ((stor_dev == NULL) ||
794 (stor_dev->if_type == IF_TYPE_UNKNOWN)) {
795 printf("unknown device\n");
798 printf("\n Device %d: ", dev);
800 if (stor_dev->type == DEV_TYPE_UNKNOWN)
802 usb_stor_curr_dev = dev;
803 printf("... is now current device\n");
806 printf("\nUSB device %d: ", usb_stor_curr_dev);
807 stor_dev = blk_get_devnum_by_type(IF_TYPE_USB,
810 if (stor_dev->type == DEV_TYPE_UNKNOWN)
816 #endif /* CONFIG_USB_STORAGE */
817 return CMD_RET_USAGE;
823 "start - start (scan) USB controller\n"
824 "usb reset - reset (rescan) USB controller\n"
825 "usb stop [f] - stop USB [f]=force stop\n"
826 "usb tree - show USB device tree\n"
827 "usb info [dev] - show available USB devices\n"
828 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
829 " (specify port 0 to indicate the device's upstream port)\n"
830 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
831 #ifdef CONFIG_USB_STORAGE
832 "usb storage - show details of USB storage devices\n"
833 "usb dev [dev] - show or set current USB storage device\n"
834 "usb part [dev] - print partition table of one or all USB storage"
836 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
837 " to memory address `addr'\n"
838 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
839 " from memory address `addr'"
840 #endif /* CONFIG_USB_STORAGE */
844 #ifdef CONFIG_USB_STORAGE
846 usbboot, 3, 1, do_usbboot,
847 "boot from USB device",
850 #endif /* CONFIG_USB_STORAGE */