1 // SPDX-License-Identifier: GPL-2.0+
4 * Denis Peter, MPL AG Switzerland
6 * Adapted for U-Boot driver model
7 * (C) Copyright 2015 Google, Inc
9 * Most of this source has been derived from the Linux USB
17 #include <dm/uclass-internal.h>
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 uint packet_size = dev->descriptor.bMaxPacketSize0;
154 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
155 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
156 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
157 (dev->descriptor.bcdUSB>>8) & 0xff,
158 dev->descriptor.bcdUSB & 0xff);
160 if (strlen(dev->mf) || strlen(dev->prod) ||
162 printf(" - %s %s %s\n", dev->mf, dev->prod,
164 if (dev->descriptor.bDeviceClass) {
165 printf(" - Class: ");
166 usb_display_class_sub(dev->descriptor.bDeviceClass,
167 dev->descriptor.bDeviceSubClass,
168 dev->descriptor.bDeviceProtocol);
171 printf(" - Class: (from Interface) %s\n",
173 dev->config.if_desc[0].desc.bInterfaceClass));
175 if (dev->descriptor.bcdUSB >= cpu_to_le16(0x0300))
176 packet_size = 1 << packet_size;
177 printf(" - PacketSize: %d Configurations: %d\n",
178 packet_size, dev->descriptor.bNumConfigurations);
179 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
180 dev->descriptor.idVendor, dev->descriptor.idProduct,
181 (dev->descriptor.bcdDevice>>8) & 0xff,
182 dev->descriptor.bcdDevice & 0xff);
187 static void usb_display_conf_desc(struct usb_config_descriptor *config,
188 struct usb_device *dev)
190 printf(" Configuration: %d\n", config->bConfigurationValue);
191 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
192 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
193 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
194 config->bMaxPower*2);
195 if (config->iConfiguration) {
197 usb_display_string(dev, config->iConfiguration);
202 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
203 struct usb_device *dev)
205 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
206 printf(" - Alternate Setting %d, Endpoints: %d\n",
207 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
209 usb_display_class_sub(ifdesc->bInterfaceClass,
210 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
212 if (ifdesc->iInterface) {
214 usb_display_string(dev, ifdesc->iInterface);
219 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
221 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
222 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
223 switch ((epdesc->bmAttributes & 0x03)) {
228 printf("Isochronous");
237 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
238 if ((epdesc->bmAttributes & 0x03) == 0x3)
239 printf(" Interval %dms", epdesc->bInterval);
243 /* main routine to diasplay the configs, interfaces and endpoints */
244 static void usb_display_config(struct usb_device *dev)
246 struct usb_config *config;
247 struct usb_interface *ifdesc;
248 struct usb_endpoint_descriptor *epdesc;
251 config = &dev->config;
252 usb_display_conf_desc(&config->desc, dev);
253 for (i = 0; i < config->no_of_if; i++) {
254 ifdesc = &config->if_desc[i];
255 usb_display_if_desc(&ifdesc->desc, dev);
256 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
257 epdesc = &ifdesc->ep_desc[ii];
258 usb_display_ep_desc(epdesc);
265 * With driver model this isn't right since we can have multiple controllers
266 * and the device numbering starts at 1 on each bus.
267 * TODO(sjg@chromium.org): Add a way to specify the controller/bus.
269 static struct usb_device *usb_find_device(int devnum)
272 struct usb_device *udev;
277 /* Device addresses start at 1 */
279 ret = uclass_get(UCLASS_USB_HUB, &uc);
283 uclass_foreach_dev(hub, uc) {
286 if (!device_active(hub))
288 udev = dev_get_parent_priv(hub);
289 if (udev->devnum == devnum)
292 for (device_find_first_child(hub, &dev);
294 device_find_next_child(&dev)) {
295 if (!device_active(hub))
298 udev = dev_get_parent_priv(dev);
299 if (udev->devnum == devnum)
304 struct usb_device *udev;
307 for (d = 0; d < USB_MAX_DEVICE; d++) {
308 udev = usb_get_dev_index(d);
311 if (udev->devnum == devnum)
319 static inline char *portspeed(int speed)
324 case USB_SPEED_SUPER:
325 speed_str = "5 Gb/s";
328 speed_str = "480 Mb/s";
331 speed_str = "1.5 Mb/s";
334 speed_str = "12 Mb/s";
341 /* shows the device tree recursively */
342 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
345 int has_child, last_child;
350 has_child = device_has_active_children(dev->dev);
351 if (device_get_uclass_id(dev->dev) == UCLASS_MASS_STORAGE) {
352 struct udevice *child;
354 for (device_find_first_child(dev->dev, &child);
356 device_find_next_child(&child)) {
357 if (device_get_uclass_id(child) == UCLASS_BLK)
362 /* check if the device has connected children */
366 for (i = 0; i < dev->maxchild; i++) {
367 if (dev->children[i] != NULL)
371 /* check if we are the last one */
373 /* Not the root of the usb tree? */
374 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
375 last_child = device_is_last_sibling(dev->dev);
377 if (dev->parent != NULL) { /* not root? */
379 for (i = 0; i < dev->parent->maxchild; i++) {
380 /* search for children */
381 if (dev->parent->children[i] == dev) {
382 /* found our pointer, see if we have a
385 while (i++ < dev->parent->maxchild) {
386 if (dev->parent->children[i] != NULL) {
393 } /* for all children of the parent */
396 /* correct last child */
397 if (last_child && index)
399 } /* if not root hub */
402 printf("%d ", dev->devnum);
404 pre[index++] = has_child ? '|' : ' ';
406 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
407 dev->config.if_desc[0].desc.bInterfaceClass),
408 portspeed(dev->speed),
409 dev->config.desc.bMaxPower * 2);
410 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
411 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
412 printf(" %s\n", pre);
414 struct udevice *child;
416 for (device_find_first_child(dev->dev, &child);
418 device_find_next_child(&child)) {
419 struct usb_device *udev;
421 if (!device_active(child))
424 udev = dev_get_parent_priv(child);
427 * Ignore emulators and block child devices, we only want
430 if ((device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
431 (device_get_uclass_id(child) != UCLASS_BLK)) {
432 usb_show_tree_graph(udev, pre);
437 if (dev->maxchild > 0) {
438 for (i = 0; i < dev->maxchild; i++) {
439 if (dev->children[i] != NULL) {
440 usb_show_tree_graph(dev->children[i], pre);
448 /* main routine for the tree command */
449 static void usb_show_subtree(struct usb_device *dev)
453 memset(preamble, '\0', sizeof(preamble));
454 usb_show_tree_graph(dev, &preamble[0]);
458 typedef void (*usb_dev_func_t)(struct usb_device *udev);
460 static void usb_for_each_root_dev(usb_dev_func_t func)
464 for (uclass_find_first_device(UCLASS_USB, &bus);
466 uclass_find_next_device(&bus)) {
467 struct usb_device *udev;
470 if (!device_active(bus))
473 device_find_first_child(bus, &dev);
474 if (dev && device_active(dev)) {
475 udev = dev_get_parent_priv(dev);
482 void usb_show_tree(void)
485 usb_for_each_root_dev(usb_show_subtree);
487 struct usb_device *udev;
490 for (i = 0; i < USB_MAX_DEVICE; i++) {
491 udev = usb_get_dev_index(i);
494 if (udev->parent == NULL)
495 usb_show_subtree(udev);
500 static int usb_test(struct usb_device *dev, int port, char* arg)
504 if (port > dev->maxchild) {
505 printf("Device is no hub or does not have %d ports.\n", port);
512 printf("Setting Test_J mode");
513 mode = USB_TEST_MODE_J;
517 printf("Setting Test_K mode");
518 mode = USB_TEST_MODE_K;
522 printf("Setting Test_SE0_NAK mode");
523 mode = USB_TEST_MODE_SE0_NAK;
527 printf("Setting Test_Packet mode");
528 mode = USB_TEST_MODE_PACKET;
532 printf("Setting Test_Force_Enable mode");
533 mode = USB_TEST_MODE_FORCE_ENABLE;
536 printf("Unrecognized test mode: %s\nAvailable modes: "
537 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
542 printf(" on downstream facing port %d...\n", port);
544 printf(" on upstream facing port...\n");
546 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
547 port ? USB_RT_PORT : USB_RECIP_DEVICE,
548 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
550 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
551 printf("Error during SET_FEATURE.\n");
554 printf("Test mode successfully set. Use 'usb start' "
555 "to return to normal operation.\n");
561 /******************************************************************************
562 * usb boot command intepreter. Derived from diskboot
564 #ifdef CONFIG_USB_STORAGE
565 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
567 return common_diskboot(cmdtp, "usb", argc, argv);
569 #endif /* CONFIG_USB_STORAGE */
571 static int do_usb_stop_keyboard(int force)
573 #if !defined CONFIG_DM_USB && defined CONFIG_USB_KEYBOARD
574 if (usb_kbd_deregister(force) != 0) {
575 printf("USB not stopped: usbkbd still using USB\n");
582 static void do_usb_start(void)
584 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
589 /* Driver model will probe the devices as they are found */
590 # ifdef CONFIG_USB_STORAGE
591 /* try to recognize storage devices immediately */
592 usb_stor_curr_dev = usb_stor_scan(1);
594 #ifndef CONFIG_DM_USB
595 # ifdef CONFIG_USB_KEYBOARD
598 #endif /* !CONFIG_DM_USB */
599 #ifdef CONFIG_USB_HOST_ETHER
600 # ifdef CONFIG_DM_ETH
601 # ifndef CONFIG_DM_USB
602 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
605 /* try to recognize ethernet devices immediately */
606 usb_ether_curr_dev = usb_host_eth_scan(1);
612 static void usb_show_info(struct usb_device *udev)
614 struct udevice *child;
616 usb_display_desc(udev);
617 usb_display_config(udev);
618 for (device_find_first_child(udev->dev, &child);
620 device_find_next_child(&child)) {
621 if (device_active(child) &&
622 (device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
623 (device_get_uclass_id(child) != UCLASS_BLK)) {
624 udev = dev_get_parent_priv(child);
631 /******************************************************************************
632 * usb command intepreter
634 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
636 struct usb_device *udev = NULL;
638 extern char usb_started;
641 return CMD_RET_USAGE;
643 if (strncmp(argv[1], "start", 5) == 0) {
645 return 0; /* Already started */
646 printf("starting USB...\n");
651 if (strncmp(argv[1], "reset", 5) == 0) {
652 printf("resetting USB...\n");
653 if (do_usb_stop_keyboard(1) != 0)
659 if (strncmp(argv[1], "stop", 4) == 0) {
661 console_assign(stdin, "serial");
662 if (do_usb_stop_keyboard(0) != 0)
664 printf("stopping USB..\n");
669 printf("USB is stopped. Please issue 'usb start' first.\n");
672 if (strncmp(argv[1], "tree", 4) == 0) {
673 puts("USB device tree:\n");
677 if (strncmp(argv[1], "inf", 3) == 0) {
680 usb_for_each_root_dev(usb_show_info);
683 for (d = 0; d < USB_MAX_DEVICE; d++) {
684 udev = usb_get_dev_index(d);
687 usb_display_desc(udev);
688 usb_display_config(udev);
694 * With driver model this isn't right since we can
695 * have multiple controllers and the device numbering
696 * starts at 1 on each bus.
698 i = simple_strtoul(argv[2], NULL, 10);
699 printf("config for device %d\n", i);
700 udev = usb_find_device(i);
702 printf("*** No device available ***\n");
705 usb_display_desc(udev);
706 usb_display_config(udev);
711 if (strncmp(argv[1], "test", 4) == 0) {
713 return CMD_RET_USAGE;
714 i = simple_strtoul(argv[2], NULL, 10);
715 udev = usb_find_device(i);
717 printf("Device %d does not exist.\n", i);
720 i = simple_strtoul(argv[3], NULL, 10);
721 return usb_test(udev, i, argv[4]);
723 #ifdef CONFIG_USB_STORAGE
724 if (strncmp(argv[1], "stor", 4) == 0)
725 return usb_stor_info();
727 return blk_common_cmd(argc, argv, IF_TYPE_USB, &usb_stor_curr_dev);
729 return CMD_RET_USAGE;
730 #endif /* CONFIG_USB_STORAGE */
736 "start - start (scan) USB controller\n"
737 "usb reset - reset (rescan) USB controller\n"
738 "usb stop [f] - stop USB [f]=force stop\n"
739 "usb tree - show USB device tree\n"
740 "usb info [dev] - show available USB devices\n"
741 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
742 " (specify port 0 to indicate the device's upstream port)\n"
743 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
744 #ifdef CONFIG_USB_STORAGE
745 "usb storage - show details of USB storage devices\n"
746 "usb dev [dev] - show or set current USB storage device\n"
747 "usb part [dev] - print partition table of one or all USB storage"
749 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
750 " to memory address `addr'\n"
751 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
752 " from memory address `addr'"
753 #endif /* CONFIG_USB_STORAGE */
757 #ifdef CONFIG_USB_STORAGE
759 usbboot, 3, 1, do_usbboot,
760 "boot from USB device",
763 #endif /* CONFIG_USB_STORAGE */