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+
19 #include <asm/byteorder.h>
20 #include <asm/unaligned.h>
24 #ifdef CONFIG_USB_STORAGE
25 static int usb_stor_curr_dev = -1; /* current device */
27 #if defined(CONFIG_USB_HOST_ETHER) && !defined(CONFIG_DM_ETH)
28 static int __maybe_unused usb_ether_curr_dev = -1; /* current ethernet device */
31 /* some display routines (info command) */
32 static char *usb_get_class_desc(unsigned char dclass)
35 case USB_CLASS_PER_INTERFACE:
36 return "See Interface";
40 return "Communication";
42 return "Human Interface";
43 case USB_CLASS_PRINTER:
45 case USB_CLASS_MASS_STORAGE:
46 return "Mass Storage";
51 case USB_CLASS_VENDOR_SPEC:
52 return "Vendor specific";
58 static void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
62 case USB_CLASS_PER_INTERFACE:
63 printf("See Interface");
66 printf("Human Interface, Subclass: ");
68 case USB_SUB_HID_NONE:
71 case USB_SUB_HID_BOOT:
74 case USB_PROT_HID_NONE:
77 case USB_PROT_HID_KEYBOARD:
80 case USB_PROT_HID_MOUSE:
93 case USB_CLASS_MASS_STORAGE:
94 printf("Mass Storage, ");
100 printf("SFF-8020i (ATAPI)");
103 printf("QIC-157 (Tape)");
112 printf("Transp. SCSI");
121 printf("Command/Bulk");
124 printf("Command/Bulk/Int");
135 printf("%s", usb_get_class_desc(dclass));
140 static void usb_display_string(struct usb_device *dev, int index)
142 ALLOC_CACHE_ALIGN_BUFFER(char, buffer, 256);
145 if (usb_string(dev, index, &buffer[0], 256) > 0)
146 printf("String: \"%s\"", buffer);
150 static void usb_display_desc(struct usb_device *dev)
152 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
153 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
154 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
155 (dev->descriptor.bcdUSB>>8) & 0xff,
156 dev->descriptor.bcdUSB & 0xff);
158 if (strlen(dev->mf) || strlen(dev->prod) ||
160 printf(" - %s %s %s\n", dev->mf, dev->prod,
162 if (dev->descriptor.bDeviceClass) {
163 printf(" - Class: ");
164 usb_display_class_sub(dev->descriptor.bDeviceClass,
165 dev->descriptor.bDeviceSubClass,
166 dev->descriptor.bDeviceProtocol);
169 printf(" - Class: (from Interface) %s\n",
171 dev->config.if_desc[0].desc.bInterfaceClass));
173 printf(" - PacketSize: %d Configurations: %d\n",
174 dev->descriptor.bMaxPacketSize0,
175 dev->descriptor.bNumConfigurations);
176 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
177 dev->descriptor.idVendor, dev->descriptor.idProduct,
178 (dev->descriptor.bcdDevice>>8) & 0xff,
179 dev->descriptor.bcdDevice & 0xff);
184 static void usb_display_conf_desc(struct usb_config_descriptor *config,
185 struct usb_device *dev)
187 printf(" Configuration: %d\n", config->bConfigurationValue);
188 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
189 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
190 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
191 config->bMaxPower*2);
192 if (config->iConfiguration) {
194 usb_display_string(dev, config->iConfiguration);
199 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
200 struct usb_device *dev)
202 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
203 printf(" - Alternate Setting %d, Endpoints: %d\n",
204 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
206 usb_display_class_sub(ifdesc->bInterfaceClass,
207 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
209 if (ifdesc->iInterface) {
211 usb_display_string(dev, ifdesc->iInterface);
216 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
218 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
219 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
220 switch ((epdesc->bmAttributes & 0x03)) {
225 printf("Isochronous");
234 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
235 if ((epdesc->bmAttributes & 0x03) == 0x3)
236 printf(" Interval %dms", epdesc->bInterval);
240 /* main routine to diasplay the configs, interfaces and endpoints */
241 static void usb_display_config(struct usb_device *dev)
243 struct usb_config *config;
244 struct usb_interface *ifdesc;
245 struct usb_endpoint_descriptor *epdesc;
248 config = &dev->config;
249 usb_display_conf_desc(&config->desc, dev);
250 for (i = 0; i < config->no_of_if; i++) {
251 ifdesc = &config->if_desc[i];
252 usb_display_if_desc(&ifdesc->desc, dev);
253 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
254 epdesc = &ifdesc->ep_desc[ii];
255 usb_display_ep_desc(epdesc);
262 * With driver model this isn't right since we can have multiple controllers
263 * and the device numbering starts at 1 on each bus.
264 * TODO(sjg@chromium.org): Add a way to specify the controller/bus.
266 static struct usb_device *usb_find_device(int devnum)
269 struct usb_device *udev;
274 /* Device addresses start at 1 */
276 ret = uclass_get(UCLASS_USB_HUB, &uc);
280 uclass_foreach_dev(hub, uc) {
283 if (!device_active(hub))
285 udev = dev_get_parent_priv(hub);
286 if (udev->devnum == devnum)
289 for (device_find_first_child(hub, &dev);
291 device_find_next_child(&dev)) {
292 if (!device_active(hub))
295 udev = dev_get_parent_priv(dev);
296 if (udev->devnum == devnum)
301 struct usb_device *udev;
304 for (d = 0; d < USB_MAX_DEVICE; d++) {
305 udev = usb_get_dev_index(d);
308 if (udev->devnum == devnum)
316 static inline char *portspeed(int speed)
321 case USB_SPEED_SUPER:
322 speed_str = "5 Gb/s";
325 speed_str = "480 Mb/s";
328 speed_str = "1.5 Mb/s";
331 speed_str = "12 Mb/s";
338 /* shows the device tree recursively */
339 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
342 int has_child, last_child;
347 has_child = device_has_active_children(dev->dev);
349 /* check if the device has connected children */
353 for (i = 0; i < dev->maxchild; i++) {
354 if (dev->children[i] != NULL)
358 /* check if we are the last one */
360 /* Not the root of the usb tree? */
361 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
362 last_child = device_is_last_sibling(dev->dev);
364 if (dev->parent != NULL) { /* not root? */
366 for (i = 0; i < dev->parent->maxchild; i++) {
367 /* search for children */
368 if (dev->parent->children[i] == dev) {
369 /* found our pointer, see if we have a
372 while (i++ < dev->parent->maxchild) {
373 if (dev->parent->children[i] != NULL) {
380 } /* for all children of the parent */
383 /* correct last child */
384 if (last_child && index)
386 } /* if not root hub */
389 printf("%d ", dev->devnum);
391 pre[index++] = has_child ? '|' : ' ';
393 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
394 dev->config.if_desc[0].desc.bInterfaceClass),
395 portspeed(dev->speed),
396 dev->config.desc.bMaxPower * 2);
397 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
398 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
399 printf(" %s\n", pre);
401 struct udevice *child;
403 for (device_find_first_child(dev->dev, &child);
405 device_find_next_child(&child)) {
406 struct usb_device *udev;
408 if (!device_active(child))
411 udev = dev_get_parent_priv(child);
413 /* Ignore emulators, we only want real devices */
414 if (device_get_uclass_id(child) != UCLASS_USB_EMUL) {
415 usb_show_tree_graph(udev, pre);
420 if (dev->maxchild > 0) {
421 for (i = 0; i < dev->maxchild; i++) {
422 if (dev->children[i] != NULL) {
423 usb_show_tree_graph(dev->children[i], pre);
431 /* main routine for the tree command */
432 static void usb_show_subtree(struct usb_device *dev)
436 memset(preamble, '\0', sizeof(preamble));
437 usb_show_tree_graph(dev, &preamble[0]);
440 void usb_show_tree(void)
445 for (uclass_first_device(UCLASS_USB, &bus);
447 uclass_next_device(&bus)) {
448 struct usb_device *udev;
451 device_find_first_child(bus, &dev);
452 if (dev && device_active(dev)) {
453 udev = dev_get_parent_priv(dev);
454 usb_show_subtree(udev);
458 struct usb_device *udev;
461 for (i = 0; i < USB_MAX_DEVICE; i++) {
462 udev = usb_get_dev_index(i);
465 if (udev->parent == NULL)
466 usb_show_subtree(udev);
471 static int usb_test(struct usb_device *dev, int port, char* arg)
475 if (port > dev->maxchild) {
476 printf("Device is no hub or does not have %d ports.\n", port);
483 printf("Setting Test_J mode");
484 mode = USB_TEST_MODE_J;
488 printf("Setting Test_K mode");
489 mode = USB_TEST_MODE_K;
493 printf("Setting Test_SE0_NAK mode");
494 mode = USB_TEST_MODE_SE0_NAK;
498 printf("Setting Test_Packet mode");
499 mode = USB_TEST_MODE_PACKET;
503 printf("Setting Test_Force_Enable mode");
504 mode = USB_TEST_MODE_FORCE_ENABLE;
507 printf("Unrecognized test mode: %s\nAvailable modes: "
508 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
513 printf(" on downstream facing port %d...\n", port);
515 printf(" on upstream facing port...\n");
517 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
518 port ? USB_RT_PORT : USB_RECIP_DEVICE,
519 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
521 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
522 printf("Error during SET_FEATURE.\n");
525 printf("Test mode successfully set. Use 'usb start' "
526 "to return to normal operation.\n");
532 /******************************************************************************
533 * usb boot command intepreter. Derived from diskboot
535 #ifdef CONFIG_USB_STORAGE
536 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
538 return common_diskboot(cmdtp, "usb", argc, argv);
540 #endif /* CONFIG_USB_STORAGE */
542 static int do_usb_stop_keyboard(int force)
544 #ifdef CONFIG_USB_KEYBOARD
545 if (usb_kbd_deregister(force) != 0) {
546 printf("USB not stopped: usbkbd still using USB\n");
553 static void do_usb_start(void)
555 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
560 /* Driver model will probe the devices as they are found */
561 #ifndef CONFIG_DM_USB
562 # ifdef CONFIG_USB_STORAGE
563 /* try to recognize storage devices immediately */
564 usb_stor_curr_dev = usb_stor_scan(1);
566 # ifdef CONFIG_USB_KEYBOARD
569 #endif /* !CONFIG_DM_USB */
570 #ifdef CONFIG_USB_HOST_ETHER
571 # ifdef CONFIG_DM_ETH
572 # ifndef CONFIG_DM_USB
573 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
576 /* try to recognize ethernet devices immediately */
577 usb_ether_curr_dev = usb_host_eth_scan(1);
583 static void show_info(struct udevice *dev)
585 struct udevice *child;
586 struct usb_device *udev;
588 udev = dev_get_parent_priv(dev);
589 usb_display_desc(udev);
590 usb_display_config(udev);
591 for (device_find_first_child(dev, &child);
593 device_find_next_child(&child)) {
594 if (device_active(child))
599 static int usb_device_info(void)
603 for (uclass_first_device(UCLASS_USB, &bus);
605 uclass_next_device(&bus)) {
608 device_find_first_child(bus, &hub);
609 if (device_get_uclass_id(hub) == UCLASS_USB_HUB &&
610 device_active(hub)) {
619 /******************************************************************************
620 * usb command intepreter
622 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
624 struct usb_device *udev = NULL;
626 extern char usb_started;
627 #ifdef CONFIG_USB_STORAGE
628 block_dev_desc_t *stor_dev;
632 return CMD_RET_USAGE;
634 if (strncmp(argv[1], "start", 5) == 0) {
636 return 0; /* Already started */
637 printf("starting USB...\n");
642 if (strncmp(argv[1], "reset", 5) == 0) {
643 printf("resetting USB...\n");
644 if (do_usb_stop_keyboard(1) != 0)
650 if (strncmp(argv[1], "stop", 4) == 0) {
652 console_assign(stdin, "serial");
653 if (do_usb_stop_keyboard(0) != 0)
655 printf("stopping USB..\n");
660 printf("USB is stopped. Please issue 'usb start' first.\n");
663 if (strncmp(argv[1], "tree", 4) == 0) {
664 puts("USB device tree:\n");
668 if (strncmp(argv[1], "inf", 3) == 0) {
674 for (d = 0; d < USB_MAX_DEVICE; d++) {
675 udev = usb_get_dev_index(d);
678 usb_display_desc(udev);
679 usb_display_config(udev);
685 * With driver model this isn't right since we can
686 * have multiple controllers and the device numbering
687 * starts at 1 on each bus.
689 i = simple_strtoul(argv[2], NULL, 10);
690 printf("config for device %d\n", i);
691 udev = usb_find_device(i);
693 printf("*** No device available ***\n");
696 usb_display_desc(udev);
697 usb_display_config(udev);
702 if (strncmp(argv[1], "test", 4) == 0) {
704 return CMD_RET_USAGE;
705 i = simple_strtoul(argv[2], NULL, 10);
706 udev = usb_find_device(i);
708 printf("Device %d does not exist.\n", i);
711 i = simple_strtoul(argv[3], NULL, 10);
712 return usb_test(udev, i, argv[4]);
714 #ifdef CONFIG_USB_STORAGE
715 if (strncmp(argv[1], "stor", 4) == 0)
716 return usb_stor_info();
718 if (strncmp(argv[1], "part", 4) == 0) {
721 for (devno = 0; ; ++devno) {
722 stor_dev = usb_stor_get_dev(devno);
723 if (stor_dev == NULL)
725 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
729 debug("print_part of %x\n", devno);
730 print_part(stor_dev);
734 devno = simple_strtoul(argv[2], NULL, 16);
735 stor_dev = usb_stor_get_dev(devno);
736 if (stor_dev != NULL &&
737 stor_dev->type != DEV_TYPE_UNKNOWN) {
739 debug("print_part of %x\n", devno);
740 print_part(stor_dev);
744 printf("\nno USB devices available\n");
749 if (strcmp(argv[1], "read") == 0) {
750 if (usb_stor_curr_dev < 0) {
751 printf("no current device selected\n");
755 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
756 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
757 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
759 printf("\nUSB read: device %d block # %ld, count %ld"
760 " ... ", usb_stor_curr_dev, blk, cnt);
761 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
762 n = stor_dev->block_read(stor_dev, blk, cnt,
764 printf("%ld blocks read: %s\n", n,
765 (n == cnt) ? "OK" : "ERROR");
771 if (strcmp(argv[1], "write") == 0) {
772 if (usb_stor_curr_dev < 0) {
773 printf("no current device selected\n");
777 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
778 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
779 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
781 printf("\nUSB write: device %d block # %ld, count %ld"
782 " ... ", usb_stor_curr_dev, blk, cnt);
783 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
784 n = stor_dev->block_write(stor_dev, blk, cnt,
786 printf("%ld blocks write: %s\n", n,
787 (n == cnt) ? "OK" : "ERROR");
793 if (strncmp(argv[1], "dev", 3) == 0) {
795 int dev = (int)simple_strtoul(argv[2], NULL, 10);
796 printf("\nUSB device %d: ", dev);
797 stor_dev = usb_stor_get_dev(dev);
798 if (stor_dev == NULL) {
799 printf("unknown device\n");
802 printf("\n Device %d: ", dev);
804 if (stor_dev->type == DEV_TYPE_UNKNOWN)
806 usb_stor_curr_dev = dev;
807 printf("... is now current device\n");
810 printf("\nUSB device %d: ", usb_stor_curr_dev);
811 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
813 if (stor_dev->type == DEV_TYPE_UNKNOWN)
819 #endif /* CONFIG_USB_STORAGE */
820 return CMD_RET_USAGE;
826 "start - start (scan) USB controller\n"
827 "usb reset - reset (rescan) USB controller\n"
828 "usb stop [f] - stop USB [f]=force stop\n"
829 "usb tree - show USB device tree\n"
830 "usb info [dev] - show available USB devices\n"
831 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
832 " (specify port 0 to indicate the device's upstream port)\n"
833 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
834 #ifdef CONFIG_USB_STORAGE
835 "usb storage - show details of USB storage devices\n"
836 "usb dev [dev] - show or set current USB storage device\n"
837 "usb part [dev] - print partition table of one or all USB storage"
839 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
840 " to memory address `addr'\n"
841 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
842 " from memory address `addr'"
843 #endif /* CONFIG_USB_STORAGE */
847 #ifdef CONFIG_USB_STORAGE
849 usbboot, 3, 1, do_usbboot,
850 "boot from USB device",
853 #endif /* CONFIG_USB_STORAGE */