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+
17 #include <asm/byteorder.h>
18 #include <asm/unaligned.h>
22 #ifdef CONFIG_USB_STORAGE
23 static int usb_stor_curr_dev = -1; /* current device */
25 #if defined(CONFIG_USB_HOST_ETHER) && !defined(CONFIG_DM_ETH)
26 static int __maybe_unused usb_ether_curr_dev = -1; /* current ethernet device */
29 /* some display routines (info command) */
30 static char *usb_get_class_desc(unsigned char dclass)
33 case USB_CLASS_PER_INTERFACE:
34 return "See Interface";
38 return "Communication";
40 return "Human Interface";
41 case USB_CLASS_PRINTER:
43 case USB_CLASS_MASS_STORAGE:
44 return "Mass Storage";
49 case USB_CLASS_VENDOR_SPEC:
50 return "Vendor specific";
56 static void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
60 case USB_CLASS_PER_INTERFACE:
61 printf("See Interface");
64 printf("Human Interface, Subclass: ");
66 case USB_SUB_HID_NONE:
69 case USB_SUB_HID_BOOT:
72 case USB_PROT_HID_NONE:
75 case USB_PROT_HID_KEYBOARD:
78 case USB_PROT_HID_MOUSE:
91 case USB_CLASS_MASS_STORAGE:
92 printf("Mass Storage, ");
98 printf("SFF-8020i (ATAPI)");
101 printf("QIC-157 (Tape)");
110 printf("Transp. SCSI");
119 printf("Command/Bulk");
122 printf("Command/Bulk/Int");
133 printf("%s", usb_get_class_desc(dclass));
138 static void usb_display_string(struct usb_device *dev, int index)
140 ALLOC_CACHE_ALIGN_BUFFER(char, buffer, 256);
143 if (usb_string(dev, index, &buffer[0], 256) > 0)
144 printf("String: \"%s\"", buffer);
148 static void usb_display_desc(struct usb_device *dev)
150 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
151 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
152 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
153 (dev->descriptor.bcdUSB>>8) & 0xff,
154 dev->descriptor.bcdUSB & 0xff);
156 if (strlen(dev->mf) || strlen(dev->prod) ||
158 printf(" - %s %s %s\n", dev->mf, dev->prod,
160 if (dev->descriptor.bDeviceClass) {
161 printf(" - Class: ");
162 usb_display_class_sub(dev->descriptor.bDeviceClass,
163 dev->descriptor.bDeviceSubClass,
164 dev->descriptor.bDeviceProtocol);
167 printf(" - Class: (from Interface) %s\n",
169 dev->config.if_desc[0].desc.bInterfaceClass));
171 printf(" - PacketSize: %d Configurations: %d\n",
172 dev->descriptor.bMaxPacketSize0,
173 dev->descriptor.bNumConfigurations);
174 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
175 dev->descriptor.idVendor, dev->descriptor.idProduct,
176 (dev->descriptor.bcdDevice>>8) & 0xff,
177 dev->descriptor.bcdDevice & 0xff);
182 static void usb_display_conf_desc(struct usb_config_descriptor *config,
183 struct usb_device *dev)
185 printf(" Configuration: %d\n", config->bConfigurationValue);
186 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
187 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
188 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
189 config->bMaxPower*2);
190 if (config->iConfiguration) {
192 usb_display_string(dev, config->iConfiguration);
197 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
198 struct usb_device *dev)
200 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
201 printf(" - Alternate Setting %d, Endpoints: %d\n",
202 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
204 usb_display_class_sub(ifdesc->bInterfaceClass,
205 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
207 if (ifdesc->iInterface) {
209 usb_display_string(dev, ifdesc->iInterface);
214 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
216 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
217 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
218 switch ((epdesc->bmAttributes & 0x03)) {
223 printf("Isochronous");
232 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
233 if ((epdesc->bmAttributes & 0x03) == 0x3)
234 printf(" Interval %dms", epdesc->bInterval);
238 /* main routine to diasplay the configs, interfaces and endpoints */
239 static void usb_display_config(struct usb_device *dev)
241 struct usb_config *config;
242 struct usb_interface *ifdesc;
243 struct usb_endpoint_descriptor *epdesc;
246 config = &dev->config;
247 usb_display_conf_desc(&config->desc, dev);
248 for (i = 0; i < config->no_of_if; i++) {
249 ifdesc = &config->if_desc[i];
250 usb_display_if_desc(&ifdesc->desc, dev);
251 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
252 epdesc = &ifdesc->ep_desc[ii];
253 usb_display_ep_desc(epdesc);
260 * With driver model this isn't right since we can have multiple controllers
261 * and the device numbering starts at 1 on each bus.
262 * TODO(sjg@chromium.org): Add a way to specify the controller/bus.
264 static struct usb_device *usb_find_device(int devnum)
267 struct usb_device *udev;
272 /* Device addresses start at 1 */
274 ret = uclass_get(UCLASS_USB_HUB, &uc);
278 uclass_foreach_dev(hub, uc) {
281 if (!device_active(hub))
283 udev = dev_get_parentdata(hub);
284 if (udev->devnum == devnum)
287 for (device_find_first_child(hub, &dev);
289 device_find_next_child(&dev)) {
290 if (!device_active(hub))
293 udev = dev_get_parentdata(dev);
294 if (udev->devnum == devnum)
299 struct usb_device *udev;
302 for (d = 0; d < USB_MAX_DEVICE; d++) {
303 udev = usb_get_dev_index(d);
306 if (udev->devnum == devnum)
314 static inline char *portspeed(int speed)
319 case USB_SPEED_SUPER:
320 speed_str = "5 Gb/s";
323 speed_str = "480 Mb/s";
326 speed_str = "1.5 Mb/s";
329 speed_str = "12 Mb/s";
336 /* shows the device tree recursively */
337 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
340 int has_child, last_child;
345 has_child = device_has_active_children(dev->dev);
347 /* check if the device has connected children */
351 for (i = 0; i < dev->maxchild; i++) {
352 if (dev->children[i] != NULL)
356 /* check if we are the last one */
358 /* Not the root of the usb tree? */
359 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
360 last_child = device_is_last_sibling(dev->dev);
362 if (dev->parent != NULL) { /* not root? */
364 for (i = 0; i < dev->parent->maxchild; i++) {
365 /* search for children */
366 if (dev->parent->children[i] == dev) {
367 /* found our pointer, see if we have a
370 while (i++ < dev->parent->maxchild) {
371 if (dev->parent->children[i] != NULL) {
378 } /* for all children of the parent */
381 /* correct last child */
382 if (last_child && index)
384 } /* if not root hub */
387 printf("%d ", dev->devnum);
389 pre[index++] = has_child ? '|' : ' ';
391 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
392 dev->config.if_desc[0].desc.bInterfaceClass),
393 portspeed(dev->speed),
394 dev->config.desc.bMaxPower * 2);
395 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
396 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
397 printf(" %s\n", pre);
399 struct udevice *child;
401 for (device_find_first_child(dev->dev, &child);
403 device_find_next_child(&child)) {
404 struct usb_device *udev;
406 if (!device_active(child))
409 udev = dev_get_parentdata(child);
411 /* Ignore emulators, we only want real devices */
412 if (device_get_uclass_id(child) != UCLASS_USB_EMUL) {
413 usb_show_tree_graph(udev, pre);
418 if (dev->maxchild > 0) {
419 for (i = 0; i < dev->maxchild; i++) {
420 if (dev->children[i] != NULL) {
421 usb_show_tree_graph(dev->children[i], pre);
429 /* main routine for the tree command */
430 static void usb_show_tree(struct usb_device *dev)
434 memset(preamble, '\0', sizeof(preamble));
435 usb_show_tree_graph(dev, &preamble[0]);
438 static int usb_test(struct usb_device *dev, int port, char* arg)
442 if (port > dev->maxchild) {
443 printf("Device is no hub or does not have %d ports.\n", port);
450 printf("Setting Test_J mode");
451 mode = USB_TEST_MODE_J;
455 printf("Setting Test_K mode");
456 mode = USB_TEST_MODE_K;
460 printf("Setting Test_SE0_NAK mode");
461 mode = USB_TEST_MODE_SE0_NAK;
465 printf("Setting Test_Packet mode");
466 mode = USB_TEST_MODE_PACKET;
470 printf("Setting Test_Force_Enable mode");
471 mode = USB_TEST_MODE_FORCE_ENABLE;
474 printf("Unrecognized test mode: %s\nAvailable modes: "
475 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
480 printf(" on downstream facing port %d...\n", port);
482 printf(" on upstream facing port...\n");
484 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
485 port ? USB_RT_PORT : USB_RECIP_DEVICE,
486 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
488 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
489 printf("Error during SET_FEATURE.\n");
492 printf("Test mode successfully set. Use 'usb start' "
493 "to return to normal operation.\n");
499 /******************************************************************************
500 * usb boot command intepreter. Derived from diskboot
502 #ifdef CONFIG_USB_STORAGE
503 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
505 return common_diskboot(cmdtp, "usb", argc, argv);
507 #endif /* CONFIG_USB_STORAGE */
509 static int do_usb_stop_keyboard(int force)
511 #ifdef CONFIG_USB_KEYBOARD
512 if (usb_kbd_deregister(force) != 0) {
513 printf("USB not stopped: usbkbd still using USB\n");
520 static void do_usb_start(void)
522 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
527 /* Driver model will probe the devices as they are found */
528 #ifndef CONFIG_DM_USB
529 #ifdef CONFIG_USB_STORAGE
530 /* try to recognize storage devices immediately */
531 usb_stor_curr_dev = usb_stor_scan(1);
534 #ifdef CONFIG_USB_HOST_ETHER
535 # ifdef CONFIG_DM_ETH
536 # ifndef CONFIG_DM_USB
537 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
540 /* try to recognize ethernet devices immediately */
541 usb_ether_curr_dev = usb_host_eth_scan(1);
544 #ifdef CONFIG_USB_KEYBOARD
550 static void show_info(struct udevice *dev)
552 struct udevice *child;
553 struct usb_device *udev;
555 udev = dev_get_parentdata(dev);
556 usb_display_desc(udev);
557 usb_display_config(udev);
558 for (device_find_first_child(dev, &child);
560 device_find_next_child(&child)) {
561 if (device_active(child))
566 static int usb_device_info(void)
570 for (uclass_first_device(UCLASS_USB, &bus);
572 uclass_next_device(&bus)) {
575 device_find_first_child(bus, &hub);
576 if (device_get_uclass_id(hub) == UCLASS_USB_HUB &&
577 device_active(hub)) {
586 /******************************************************************************
587 * usb command intepreter
589 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
591 struct usb_device *udev = NULL;
593 extern char usb_started;
594 #ifdef CONFIG_USB_STORAGE
595 block_dev_desc_t *stor_dev;
599 return CMD_RET_USAGE;
601 if (strncmp(argv[1], "start", 5) == 0) {
603 return 0; /* Already started */
604 printf("starting USB...\n");
609 if (strncmp(argv[1], "reset", 5) == 0) {
610 printf("resetting USB...\n");
611 if (do_usb_stop_keyboard(1) != 0)
617 if (strncmp(argv[1], "stop", 4) == 0) {
619 console_assign(stdin, "serial");
620 if (do_usb_stop_keyboard(0) != 0)
622 printf("stopping USB..\n");
627 printf("USB is stopped. Please issue 'usb start' first.\n");
630 if (strncmp(argv[1], "tree", 4) == 0) {
631 puts("USB device tree:\n");
635 for (uclass_first_device(UCLASS_USB, &bus);
637 uclass_next_device(&bus)) {
638 struct usb_device *udev;
641 device_find_first_child(bus, &dev);
642 if (dev && device_active(dev)) {
643 udev = dev_get_parentdata(dev);
648 for (i = 0; i < USB_MAX_DEVICE; i++) {
649 udev = usb_get_dev_index(i);
652 if (udev->parent == NULL)
658 if (strncmp(argv[1], "inf", 3) == 0) {
664 for (d = 0; d < USB_MAX_DEVICE; d++) {
665 udev = usb_get_dev_index(d);
668 usb_display_desc(udev);
669 usb_display_config(udev);
675 * With driver model this isn't right since we can
676 * have multiple controllers and the device numbering
677 * starts at 1 on each bus.
679 i = simple_strtoul(argv[2], NULL, 10);
680 printf("config for device %d\n", i);
681 udev = usb_find_device(i);
683 printf("*** No device available ***\n");
686 usb_display_desc(udev);
687 usb_display_config(udev);
692 if (strncmp(argv[1], "test", 4) == 0) {
694 return CMD_RET_USAGE;
695 i = simple_strtoul(argv[2], NULL, 10);
696 udev = usb_find_device(i);
698 printf("Device %d does not exist.\n", i);
701 i = simple_strtoul(argv[3], NULL, 10);
702 return usb_test(udev, i, argv[4]);
704 #ifdef CONFIG_USB_STORAGE
705 if (strncmp(argv[1], "stor", 4) == 0)
706 return usb_stor_info();
708 if (strncmp(argv[1], "part", 4) == 0) {
711 for (devno = 0; ; ++devno) {
712 stor_dev = usb_stor_get_dev(devno);
713 if (stor_dev == NULL)
715 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
719 debug("print_part of %x\n", devno);
720 print_part(stor_dev);
724 devno = simple_strtoul(argv[2], NULL, 16);
725 stor_dev = usb_stor_get_dev(devno);
726 if (stor_dev != NULL &&
727 stor_dev->type != DEV_TYPE_UNKNOWN) {
729 debug("print_part of %x\n", devno);
730 print_part(stor_dev);
734 printf("\nno USB devices available\n");
739 if (strcmp(argv[1], "read") == 0) {
740 if (usb_stor_curr_dev < 0) {
741 printf("no current device selected\n");
745 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
746 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
747 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
749 printf("\nUSB read: device %d block # %ld, count %ld"
750 " ... ", usb_stor_curr_dev, blk, cnt);
751 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
752 n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
754 printf("%ld blocks read: %s\n", n,
755 (n == cnt) ? "OK" : "ERROR");
761 if (strcmp(argv[1], "write") == 0) {
762 if (usb_stor_curr_dev < 0) {
763 printf("no current device selected\n");
767 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
768 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
769 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
771 printf("\nUSB write: device %d block # %ld, count %ld"
772 " ... ", usb_stor_curr_dev, blk, cnt);
773 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
774 n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
776 printf("%ld blocks write: %s\n", n,
777 (n == cnt) ? "OK" : "ERROR");
783 if (strncmp(argv[1], "dev", 3) == 0) {
785 int dev = (int)simple_strtoul(argv[2], NULL, 10);
786 printf("\nUSB device %d: ", dev);
787 stor_dev = usb_stor_get_dev(dev);
788 if (stor_dev == NULL) {
789 printf("unknown device\n");
792 printf("\n Device %d: ", dev);
794 if (stor_dev->type == DEV_TYPE_UNKNOWN)
796 usb_stor_curr_dev = dev;
797 printf("... is now current device\n");
800 printf("\nUSB device %d: ", usb_stor_curr_dev);
801 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
803 if (stor_dev->type == DEV_TYPE_UNKNOWN)
809 #endif /* CONFIG_USB_STORAGE */
810 return CMD_RET_USAGE;
816 "start - start (scan) USB controller\n"
817 "usb reset - reset (rescan) USB controller\n"
818 "usb stop [f] - stop USB [f]=force stop\n"
819 "usb tree - show USB device tree\n"
820 "usb info [dev] - show available USB devices\n"
821 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
822 " (specify port 0 to indicate the device's upstream port)\n"
823 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
824 #ifdef CONFIG_USB_STORAGE
825 "usb storage - show details of USB storage devices\n"
826 "usb dev [dev] - show or set current USB storage device\n"
827 "usb part [dev] - print partition table of one or all USB storage"
829 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
830 " to memory address `addr'\n"
831 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
832 " from memory address `addr'"
833 #endif /* CONFIG_USB_STORAGE */
837 #ifdef CONFIG_USB_STORAGE
839 usbboot, 3, 1, do_usbboot,
840 "boot from USB device",
843 #endif /* CONFIG_USB_STORAGE */