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 uint packet_size = dev->descriptor.bMaxPacketSize0;
155 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
156 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
157 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
158 (dev->descriptor.bcdUSB>>8) & 0xff,
159 dev->descriptor.bcdUSB & 0xff);
161 if (strlen(dev->mf) || strlen(dev->prod) ||
163 printf(" - %s %s %s\n", dev->mf, dev->prod,
165 if (dev->descriptor.bDeviceClass) {
166 printf(" - Class: ");
167 usb_display_class_sub(dev->descriptor.bDeviceClass,
168 dev->descriptor.bDeviceSubClass,
169 dev->descriptor.bDeviceProtocol);
172 printf(" - Class: (from Interface) %s\n",
174 dev->config.if_desc[0].desc.bInterfaceClass));
176 if (dev->descriptor.bcdUSB >= cpu_to_le16(0x0300))
177 packet_size = 1 << packet_size;
178 printf(" - PacketSize: %d Configurations: %d\n",
179 packet_size, dev->descriptor.bNumConfigurations);
180 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
181 dev->descriptor.idVendor, dev->descriptor.idProduct,
182 (dev->descriptor.bcdDevice>>8) & 0xff,
183 dev->descriptor.bcdDevice & 0xff);
188 static void usb_display_conf_desc(struct usb_config_descriptor *config,
189 struct usb_device *dev)
191 printf(" Configuration: %d\n", config->bConfigurationValue);
192 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
193 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
194 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
195 config->bMaxPower*2);
196 if (config->iConfiguration) {
198 usb_display_string(dev, config->iConfiguration);
203 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
204 struct usb_device *dev)
206 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
207 printf(" - Alternate Setting %d, Endpoints: %d\n",
208 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
210 usb_display_class_sub(ifdesc->bInterfaceClass,
211 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
213 if (ifdesc->iInterface) {
215 usb_display_string(dev, ifdesc->iInterface);
220 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
222 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
223 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
224 switch ((epdesc->bmAttributes & 0x03)) {
229 printf("Isochronous");
238 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
239 if ((epdesc->bmAttributes & 0x03) == 0x3)
240 printf(" Interval %dms", epdesc->bInterval);
244 /* main routine to diasplay the configs, interfaces and endpoints */
245 static void usb_display_config(struct usb_device *dev)
247 struct usb_config *config;
248 struct usb_interface *ifdesc;
249 struct usb_endpoint_descriptor *epdesc;
252 config = &dev->config;
253 usb_display_conf_desc(&config->desc, dev);
254 for (i = 0; i < config->no_of_if; i++) {
255 ifdesc = &config->if_desc[i];
256 usb_display_if_desc(&ifdesc->desc, dev);
257 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
258 epdesc = &ifdesc->ep_desc[ii];
259 usb_display_ep_desc(epdesc);
266 * With driver model this isn't right since we can have multiple controllers
267 * and the device numbering starts at 1 on each bus.
268 * TODO(sjg@chromium.org): Add a way to specify the controller/bus.
270 static struct usb_device *usb_find_device(int devnum)
273 struct usb_device *udev;
278 /* Device addresses start at 1 */
280 ret = uclass_get(UCLASS_USB_HUB, &uc);
284 uclass_foreach_dev(hub, uc) {
287 if (!device_active(hub))
289 udev = dev_get_parent_priv(hub);
290 if (udev->devnum == devnum)
293 for (device_find_first_child(hub, &dev);
295 device_find_next_child(&dev)) {
296 if (!device_active(hub))
299 udev = dev_get_parent_priv(dev);
300 if (udev->devnum == devnum)
305 struct usb_device *udev;
308 for (d = 0; d < USB_MAX_DEVICE; d++) {
309 udev = usb_get_dev_index(d);
312 if (udev->devnum == devnum)
320 static inline char *portspeed(int speed)
325 case USB_SPEED_SUPER:
326 speed_str = "5 Gb/s";
329 speed_str = "480 Mb/s";
332 speed_str = "1.5 Mb/s";
335 speed_str = "12 Mb/s";
342 /* shows the device tree recursively */
343 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
346 int has_child, last_child;
351 has_child = device_has_active_children(dev->dev);
352 if (device_get_uclass_id(dev->dev) == UCLASS_MASS_STORAGE) {
353 struct udevice *child;
355 for (device_find_first_child(dev->dev, &child);
357 device_find_next_child(&child)) {
358 if (device_get_uclass_id(child) == UCLASS_BLK)
363 /* check if the device has connected children */
367 for (i = 0; i < dev->maxchild; i++) {
368 if (dev->children[i] != NULL)
372 /* check if we are the last one */
374 /* Not the root of the usb tree? */
375 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
376 last_child = device_is_last_sibling(dev->dev);
378 if (dev->parent != NULL) { /* not root? */
380 for (i = 0; i < dev->parent->maxchild; i++) {
381 /* search for children */
382 if (dev->parent->children[i] == dev) {
383 /* found our pointer, see if we have a
386 while (i++ < dev->parent->maxchild) {
387 if (dev->parent->children[i] != NULL) {
394 } /* for all children of the parent */
397 /* correct last child */
398 if (last_child && index)
400 } /* if not root hub */
403 printf("%d ", dev->devnum);
405 pre[index++] = has_child ? '|' : ' ';
407 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
408 dev->config.if_desc[0].desc.bInterfaceClass),
409 portspeed(dev->speed),
410 dev->config.desc.bMaxPower * 2);
411 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
412 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
413 printf(" %s\n", pre);
415 struct udevice *child;
417 for (device_find_first_child(dev->dev, &child);
419 device_find_next_child(&child)) {
420 struct usb_device *udev;
422 if (!device_active(child))
425 udev = dev_get_parent_priv(child);
428 * Ignore emulators and block child devices, we only want
431 if ((device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
432 (device_get_uclass_id(child) != UCLASS_BLK)) {
433 usb_show_tree_graph(udev, pre);
438 if (dev->maxchild > 0) {
439 for (i = 0; i < dev->maxchild; i++) {
440 if (dev->children[i] != NULL) {
441 usb_show_tree_graph(dev->children[i], pre);
449 /* main routine for the tree command */
450 static void usb_show_subtree(struct usb_device *dev)
454 memset(preamble, '\0', sizeof(preamble));
455 usb_show_tree_graph(dev, &preamble[0]);
459 typedef void (*usb_dev_func_t)(struct usb_device *udev);
461 static void usb_for_each_root_dev(usb_dev_func_t func)
465 for (uclass_find_first_device(UCLASS_USB, &bus);
467 uclass_find_next_device(&bus)) {
468 struct usb_device *udev;
471 if (!device_active(bus))
474 device_find_first_child(bus, &dev);
475 if (dev && device_active(dev)) {
476 udev = dev_get_parent_priv(dev);
483 void usb_show_tree(void)
486 usb_for_each_root_dev(usb_show_subtree);
488 struct usb_device *udev;
491 for (i = 0; i < USB_MAX_DEVICE; i++) {
492 udev = usb_get_dev_index(i);
495 if (udev->parent == NULL)
496 usb_show_subtree(udev);
501 static int usb_test(struct usb_device *dev, int port, char* arg)
505 if (port > dev->maxchild) {
506 printf("Device is no hub or does not have %d ports.\n", port);
513 printf("Setting Test_J mode");
514 mode = USB_TEST_MODE_J;
518 printf("Setting Test_K mode");
519 mode = USB_TEST_MODE_K;
523 printf("Setting Test_SE0_NAK mode");
524 mode = USB_TEST_MODE_SE0_NAK;
528 printf("Setting Test_Packet mode");
529 mode = USB_TEST_MODE_PACKET;
533 printf("Setting Test_Force_Enable mode");
534 mode = USB_TEST_MODE_FORCE_ENABLE;
537 printf("Unrecognized test mode: %s\nAvailable modes: "
538 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
543 printf(" on downstream facing port %d...\n", port);
545 printf(" on upstream facing port...\n");
547 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
548 port ? USB_RT_PORT : USB_RECIP_DEVICE,
549 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
551 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
552 printf("Error during SET_FEATURE.\n");
555 printf("Test mode successfully set. Use 'usb start' "
556 "to return to normal operation.\n");
562 /******************************************************************************
563 * usb boot command intepreter. Derived from diskboot
565 #ifdef CONFIG_USB_STORAGE
566 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
568 return common_diskboot(cmdtp, "usb", argc, argv);
570 #endif /* CONFIG_USB_STORAGE */
572 static int do_usb_stop_keyboard(int force)
574 #if !defined CONFIG_DM_USB && defined CONFIG_USB_KEYBOARD
575 if (usb_kbd_deregister(force) != 0) {
576 printf("USB not stopped: usbkbd still using USB\n");
583 static void do_usb_start(void)
585 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
590 /* Driver model will probe the devices as they are found */
591 # ifdef CONFIG_USB_STORAGE
592 /* try to recognize storage devices immediately */
593 usb_stor_curr_dev = usb_stor_scan(1);
595 #ifndef CONFIG_DM_USB
596 # ifdef CONFIG_USB_KEYBOARD
599 #endif /* !CONFIG_DM_USB */
600 #ifdef CONFIG_USB_HOST_ETHER
601 # ifdef CONFIG_DM_ETH
602 # ifndef CONFIG_DM_USB
603 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
606 /* try to recognize ethernet devices immediately */
607 usb_ether_curr_dev = usb_host_eth_scan(1);
613 static void usb_show_info(struct usb_device *udev)
615 struct udevice *child;
617 usb_display_desc(udev);
618 usb_display_config(udev);
619 for (device_find_first_child(udev->dev, &child);
621 device_find_next_child(&child)) {
622 if (device_active(child) &&
623 (device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
624 (device_get_uclass_id(child) != UCLASS_BLK)) {
625 udev = dev_get_parent_priv(child);
632 /******************************************************************************
633 * usb command intepreter
635 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
637 struct usb_device *udev = NULL;
639 extern char usb_started;
642 return CMD_RET_USAGE;
644 if (strncmp(argv[1], "start", 5) == 0) {
646 return 0; /* Already started */
647 printf("starting USB...\n");
652 if (strncmp(argv[1], "reset", 5) == 0) {
653 printf("resetting USB...\n");
654 if (do_usb_stop_keyboard(1) != 0)
660 if (strncmp(argv[1], "stop", 4) == 0) {
662 console_assign(stdin, "serial");
663 if (do_usb_stop_keyboard(0) != 0)
665 printf("stopping USB..\n");
670 printf("USB is stopped. Please issue 'usb start' first.\n");
673 if (strncmp(argv[1], "tree", 4) == 0) {
674 puts("USB device tree:\n");
678 if (strncmp(argv[1], "inf", 3) == 0) {
681 usb_for_each_root_dev(usb_show_info);
684 for (d = 0; d < USB_MAX_DEVICE; d++) {
685 udev = usb_get_dev_index(d);
688 usb_display_desc(udev);
689 usb_display_config(udev);
695 * With driver model this isn't right since we can
696 * have multiple controllers and the device numbering
697 * starts at 1 on each bus.
699 i = simple_strtoul(argv[2], NULL, 10);
700 printf("config for device %d\n", i);
701 udev = usb_find_device(i);
703 printf("*** No device available ***\n");
706 usb_display_desc(udev);
707 usb_display_config(udev);
712 if (strncmp(argv[1], "test", 4) == 0) {
714 return CMD_RET_USAGE;
715 i = simple_strtoul(argv[2], NULL, 10);
716 udev = usb_find_device(i);
718 printf("Device %d does not exist.\n", i);
721 i = simple_strtoul(argv[3], NULL, 10);
722 return usb_test(udev, i, argv[4]);
724 #ifdef CONFIG_USB_STORAGE
725 if (strncmp(argv[1], "stor", 4) == 0)
726 return usb_stor_info();
728 return blk_common_cmd(argc, argv, IF_TYPE_USB, &usb_stor_curr_dev);
730 return CMD_RET_USAGE;
731 #endif /* CONFIG_USB_STORAGE */
737 "start - start (scan) USB controller\n"
738 "usb reset - reset (rescan) USB controller\n"
739 "usb stop [f] - stop USB [f]=force stop\n"
740 "usb tree - show USB device tree\n"
741 "usb info [dev] - show available USB devices\n"
742 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
743 " (specify port 0 to indicate the device's upstream port)\n"
744 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
745 #ifdef CONFIG_USB_STORAGE
746 "usb storage - show details of USB storage devices\n"
747 "usb dev [dev] - show or set current USB storage device\n"
748 "usb part [dev] - print partition table of one or all USB storage"
750 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
751 " to memory address `addr'\n"
752 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
753 " from memory address `addr'"
754 #endif /* CONFIG_USB_STORAGE */
758 #ifdef CONFIG_USB_STORAGE
760 usbboot, 3, 1, do_usbboot,
761 "boot from USB device",
764 #endif /* CONFIG_USB_STORAGE */