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 const char *portspeed(int speed)
322 case USB_SPEED_SUPER:
333 /* shows the device tree recursively */
334 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
337 int has_child, last_child;
342 has_child = device_has_active_children(dev->dev);
343 if (device_get_uclass_id(dev->dev) == UCLASS_MASS_STORAGE) {
344 struct udevice *child;
346 for (device_find_first_child(dev->dev, &child);
348 device_find_next_child(&child)) {
349 if (device_get_uclass_id(child) == UCLASS_BLK)
354 /* check if the device has connected children */
358 for (i = 0; i < dev->maxchild; i++) {
359 if (dev->children[i] != NULL)
363 /* check if we are the last one */
365 /* Not the root of the usb tree? */
366 if (device_get_uclass_id(dev->dev->parent) != UCLASS_USB) {
367 last_child = device_is_last_sibling(dev->dev);
369 if (dev->parent != NULL) { /* not root? */
371 for (i = 0; i < dev->parent->maxchild; i++) {
372 /* search for children */
373 if (dev->parent->children[i] == dev) {
374 /* found our pointer, see if we have a
377 while (i++ < dev->parent->maxchild) {
378 if (dev->parent->children[i] != NULL) {
385 } /* for all children of the parent */
388 /* correct last child */
389 if (last_child && index)
391 } /* if not root hub */
394 printf("%d ", dev->devnum);
396 pre[index++] = has_child ? '|' : ' ';
398 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
399 dev->config.if_desc[0].desc.bInterfaceClass),
400 portspeed(dev->speed),
401 dev->config.desc.bMaxPower * 2);
402 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
403 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
404 printf(" %s\n", pre);
406 struct udevice *child;
408 for (device_find_first_child(dev->dev, &child);
410 device_find_next_child(&child)) {
411 struct usb_device *udev;
413 if (!device_active(child))
416 udev = dev_get_parent_priv(child);
419 * Ignore emulators and block child devices, we only want
422 if ((device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
423 (device_get_uclass_id(child) != UCLASS_BLK)) {
424 usb_show_tree_graph(udev, pre);
429 if (dev->maxchild > 0) {
430 for (i = 0; i < dev->maxchild; i++) {
431 if (dev->children[i] != NULL) {
432 usb_show_tree_graph(dev->children[i], pre);
440 /* main routine for the tree command */
441 static void usb_show_subtree(struct usb_device *dev)
445 memset(preamble, '\0', sizeof(preamble));
446 usb_show_tree_graph(dev, &preamble[0]);
450 typedef void (*usb_dev_func_t)(struct usb_device *udev);
452 static void usb_for_each_root_dev(usb_dev_func_t func)
456 for (uclass_find_first_device(UCLASS_USB, &bus);
458 uclass_find_next_device(&bus)) {
459 struct usb_device *udev;
462 if (!device_active(bus))
465 device_find_first_child(bus, &dev);
466 if (dev && device_active(dev)) {
467 udev = dev_get_parent_priv(dev);
474 void usb_show_tree(void)
477 usb_for_each_root_dev(usb_show_subtree);
479 struct usb_device *udev;
482 for (i = 0; i < USB_MAX_DEVICE; i++) {
483 udev = usb_get_dev_index(i);
486 if (udev->parent == NULL)
487 usb_show_subtree(udev);
492 static int usb_test(struct usb_device *dev, int port, char* arg)
496 if (port > dev->maxchild) {
497 printf("Device is no hub or does not have %d ports.\n", port);
504 printf("Setting Test_J mode");
505 mode = USB_TEST_MODE_J;
509 printf("Setting Test_K mode");
510 mode = USB_TEST_MODE_K;
514 printf("Setting Test_SE0_NAK mode");
515 mode = USB_TEST_MODE_SE0_NAK;
519 printf("Setting Test_Packet mode");
520 mode = USB_TEST_MODE_PACKET;
524 printf("Setting Test_Force_Enable mode");
525 mode = USB_TEST_MODE_FORCE_ENABLE;
528 printf("Unrecognized test mode: %s\nAvailable modes: "
529 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
534 printf(" on downstream facing port %d...\n", port);
536 printf(" on upstream facing port...\n");
538 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
539 port ? USB_RT_PORT : USB_RECIP_DEVICE,
540 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
542 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
543 printf("Error during SET_FEATURE.\n");
546 printf("Test mode successfully set. Use 'usb start' "
547 "to return to normal operation.\n");
553 /******************************************************************************
554 * usb boot command intepreter. Derived from diskboot
556 #ifdef CONFIG_USB_STORAGE
557 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
559 return common_diskboot(cmdtp, "usb", argc, argv);
561 #endif /* CONFIG_USB_STORAGE */
563 static int do_usb_stop_keyboard(int force)
565 #if !defined CONFIG_DM_USB && defined CONFIG_USB_KEYBOARD
566 if (usb_kbd_deregister(force) != 0) {
567 printf("USB not stopped: usbkbd still using USB\n");
574 static void do_usb_start(void)
576 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
581 /* Driver model will probe the devices as they are found */
582 # ifdef CONFIG_USB_STORAGE
583 /* try to recognize storage devices immediately */
584 usb_stor_curr_dev = usb_stor_scan(1);
586 #ifndef CONFIG_DM_USB
587 # ifdef CONFIG_USB_KEYBOARD
590 #endif /* !CONFIG_DM_USB */
591 #ifdef CONFIG_USB_HOST_ETHER
592 # ifdef CONFIG_DM_ETH
593 # ifndef CONFIG_DM_USB
594 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
597 /* try to recognize ethernet devices immediately */
598 usb_ether_curr_dev = usb_host_eth_scan(1);
604 static void usb_show_info(struct usb_device *udev)
606 struct udevice *child;
608 usb_display_desc(udev);
609 usb_display_config(udev);
610 for (device_find_first_child(udev->dev, &child);
612 device_find_next_child(&child)) {
613 if (device_active(child) &&
614 (device_get_uclass_id(child) != UCLASS_USB_EMUL) &&
615 (device_get_uclass_id(child) != UCLASS_BLK)) {
616 udev = dev_get_parent_priv(child);
623 /******************************************************************************
624 * usb command intepreter
626 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
628 struct usb_device *udev = NULL;
630 extern char usb_started;
633 return CMD_RET_USAGE;
635 if (strncmp(argv[1], "start", 5) == 0) {
637 return 0; /* Already started */
638 printf("starting USB...\n");
643 if (strncmp(argv[1], "reset", 5) == 0) {
644 printf("resetting USB...\n");
645 if (do_usb_stop_keyboard(1) != 0)
651 if (strncmp(argv[1], "stop", 4) == 0) {
653 console_assign(stdin, "serial");
654 if (do_usb_stop_keyboard(0) != 0)
656 printf("stopping USB..\n");
661 printf("USB is stopped. Please issue 'usb start' first.\n");
664 if (strncmp(argv[1], "tree", 4) == 0) {
665 puts("USB device tree:\n");
669 if (strncmp(argv[1], "inf", 3) == 0) {
672 usb_for_each_root_dev(usb_show_info);
675 for (d = 0; d < USB_MAX_DEVICE; d++) {
676 udev = usb_get_dev_index(d);
679 usb_display_desc(udev);
680 usb_display_config(udev);
686 * With driver model this isn't right since we can
687 * have multiple controllers and the device numbering
688 * starts at 1 on each bus.
690 i = simple_strtoul(argv[2], NULL, 10);
691 printf("config for device %d\n", i);
692 udev = usb_find_device(i);
694 printf("*** No device available ***\n");
697 usb_display_desc(udev);
698 usb_display_config(udev);
703 if (strncmp(argv[1], "test", 4) == 0) {
705 return CMD_RET_USAGE;
706 i = simple_strtoul(argv[2], NULL, 10);
707 udev = usb_find_device(i);
709 printf("Device %d does not exist.\n", i);
712 i = simple_strtoul(argv[3], NULL, 10);
713 return usb_test(udev, i, argv[4]);
715 #ifdef CONFIG_USB_STORAGE
716 if (strncmp(argv[1], "stor", 4) == 0)
717 return usb_stor_info();
719 return blk_common_cmd(argc, argv, IF_TYPE_USB, &usb_stor_curr_dev);
721 return CMD_RET_USAGE;
722 #endif /* CONFIG_USB_STORAGE */
728 "start - start (scan) USB controller\n"
729 "usb reset - reset (rescan) USB controller\n"
730 "usb stop [f] - stop USB [f]=force stop\n"
731 "usb tree - show USB device tree\n"
732 "usb info [dev] - show available USB devices\n"
733 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
734 " (specify port 0 to indicate the device's upstream port)\n"
735 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
736 #ifdef CONFIG_USB_STORAGE
737 "usb storage - show details of USB storage devices\n"
738 "usb dev [dev] - show or set current USB storage device\n"
739 "usb part [dev] - print partition table of one or all USB storage"
741 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
742 " to memory address `addr'\n"
743 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
744 " from memory address `addr'"
745 #endif /* CONFIG_USB_STORAGE */
749 #ifdef CONFIG_USB_STORAGE
751 usbboot, 3, 1, do_usbboot,
752 "boot from USB device",
755 #endif /* CONFIG_USB_STORAGE */