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
);
353 /* check if the device has connected children */
357 for (i
= 0; i
< dev
->maxchild
; i
++) {
358 if (dev
->children
[i
] != NULL
)
362 /* check if we are the last one */
364 /* Not the root of the usb tree? */
365 if (device_get_uclass_id(dev
->dev
->parent
) != UCLASS_USB
) {
366 last_child
= device_is_last_sibling(dev
->dev
);
368 if (dev
->parent
!= NULL
) { /* not root? */
370 for (i
= 0; i
< dev
->parent
->maxchild
; i
++) {
371 /* search for children */
372 if (dev
->parent
->children
[i
] == dev
) {
373 /* found our pointer, see if we have a
376 while (i
++ < dev
->parent
->maxchild
) {
377 if (dev
->parent
->children
[i
] != NULL
) {
384 } /* for all children of the parent */
387 /* correct last child */
388 if (last_child
&& index
)
390 } /* if not root hub */
393 printf("%d ", dev
->devnum
);
395 pre
[index
++] = has_child
? '|' : ' ';
397 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
398 dev
->config
.if_desc
[0].desc
.bInterfaceClass
),
399 portspeed(dev
->speed
),
400 dev
->config
.desc
.bMaxPower
* 2);
401 if (strlen(dev
->mf
) || strlen(dev
->prod
) || strlen(dev
->serial
))
402 printf(" %s %s %s %s\n", pre
, dev
->mf
, dev
->prod
, dev
->serial
);
403 printf(" %s\n", pre
);
405 struct udevice
*child
;
407 for (device_find_first_child(dev
->dev
, &child
);
409 device_find_next_child(&child
)) {
410 struct usb_device
*udev
;
412 if (!device_active(child
))
415 udev
= dev_get_parent_priv(child
);
417 /* Ignore emulators, we only want real devices */
418 if (device_get_uclass_id(child
) != UCLASS_USB_EMUL
) {
419 usb_show_tree_graph(udev
, pre
);
424 if (dev
->maxchild
> 0) {
425 for (i
= 0; i
< dev
->maxchild
; i
++) {
426 if (dev
->children
[i
] != NULL
) {
427 usb_show_tree_graph(dev
->children
[i
], pre
);
435 /* main routine for the tree command */
436 static void usb_show_subtree(struct usb_device
*dev
)
440 memset(preamble
, '\0', sizeof(preamble
));
441 usb_show_tree_graph(dev
, &preamble
[0]);
445 typedef void (*usb_dev_func_t
)(struct usb_device
*udev
);
447 static void usb_for_each_root_dev(usb_dev_func_t func
)
451 for (uclass_find_first_device(UCLASS_USB
, &bus
);
453 uclass_find_next_device(&bus
)) {
454 struct usb_device
*udev
;
457 if (!device_active(bus
))
460 device_find_first_child(bus
, &dev
);
461 if (dev
&& device_active(dev
)) {
462 udev
= dev_get_parent_priv(dev
);
469 void usb_show_tree(void)
472 usb_for_each_root_dev(usb_show_subtree
);
474 struct usb_device
*udev
;
477 for (i
= 0; i
< USB_MAX_DEVICE
; i
++) {
478 udev
= usb_get_dev_index(i
);
481 if (udev
->parent
== NULL
)
482 usb_show_subtree(udev
);
487 static int usb_test(struct usb_device
*dev
, int port
, char* arg
)
491 if (port
> dev
->maxchild
) {
492 printf("Device is no hub or does not have %d ports.\n", port
);
499 printf("Setting Test_J mode");
500 mode
= USB_TEST_MODE_J
;
504 printf("Setting Test_K mode");
505 mode
= USB_TEST_MODE_K
;
509 printf("Setting Test_SE0_NAK mode");
510 mode
= USB_TEST_MODE_SE0_NAK
;
514 printf("Setting Test_Packet mode");
515 mode
= USB_TEST_MODE_PACKET
;
519 printf("Setting Test_Force_Enable mode");
520 mode
= USB_TEST_MODE_FORCE_ENABLE
;
523 printf("Unrecognized test mode: %s\nAvailable modes: "
524 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg
);
529 printf(" on downstream facing port %d...\n", port
);
531 printf(" on upstream facing port...\n");
533 if (usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_FEATURE
,
534 port
? USB_RT_PORT
: USB_RECIP_DEVICE
,
535 port
? USB_PORT_FEAT_TEST
: USB_FEAT_TEST
,
537 NULL
, 0, USB_CNTL_TIMEOUT
) == -1) {
538 printf("Error during SET_FEATURE.\n");
541 printf("Test mode successfully set. Use 'usb start' "
542 "to return to normal operation.\n");
548 /******************************************************************************
549 * usb boot command intepreter. Derived from diskboot
551 #ifdef CONFIG_USB_STORAGE
552 static int do_usbboot(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
554 return common_diskboot(cmdtp
, "usb", argc
, argv
);
556 #endif /* CONFIG_USB_STORAGE */
558 static int do_usb_stop_keyboard(int force
)
560 #if !defined CONFIG_DM_USB && defined CONFIG_USB_KEYBOARD
561 if (usb_kbd_deregister(force
) != 0) {
562 printf("USB not stopped: usbkbd still using USB\n");
569 static void do_usb_start(void)
571 bootstage_mark_name(BOOTSTAGE_ID_USB_START
, "usb_start");
576 /* Driver model will probe the devices as they are found */
577 # ifdef CONFIG_USB_STORAGE
578 /* try to recognize storage devices immediately */
579 usb_stor_curr_dev
= usb_stor_scan(1);
581 #ifndef CONFIG_DM_USB
582 # ifdef CONFIG_USB_KEYBOARD
585 #endif /* !CONFIG_DM_USB */
586 #ifdef CONFIG_USB_HOST_ETHER
587 # ifdef CONFIG_DM_ETH
588 # ifndef CONFIG_DM_USB
589 # error "You must use CONFIG_DM_USB if you want to use CONFIG_USB_HOST_ETHER with CONFIG_DM_ETH"
592 /* try to recognize ethernet devices immediately */
593 usb_ether_curr_dev
= usb_host_eth_scan(1);
599 static void usb_show_info(struct usb_device
*udev
)
601 struct udevice
*child
;
603 usb_display_desc(udev
);
604 usb_display_config(udev
);
605 for (device_find_first_child(udev
->dev
, &child
);
607 device_find_next_child(&child
)) {
608 if (device_active(child
)) {
609 udev
= dev_get_parent_priv(child
);
616 /******************************************************************************
617 * usb command intepreter
619 static int do_usb(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
621 struct usb_device
*udev
= NULL
;
623 extern char usb_started
;
626 return CMD_RET_USAGE
;
628 if (strncmp(argv
[1], "start", 5) == 0) {
630 return 0; /* Already started */
631 printf("starting USB...\n");
636 if (strncmp(argv
[1], "reset", 5) == 0) {
637 printf("resetting USB...\n");
638 if (do_usb_stop_keyboard(1) != 0)
644 if (strncmp(argv
[1], "stop", 4) == 0) {
646 console_assign(stdin
, "serial");
647 if (do_usb_stop_keyboard(0) != 0)
649 printf("stopping USB..\n");
654 printf("USB is stopped. Please issue 'usb start' first.\n");
657 if (strncmp(argv
[1], "tree", 4) == 0) {
658 puts("USB device tree:\n");
662 if (strncmp(argv
[1], "inf", 3) == 0) {
665 usb_for_each_root_dev(usb_show_info
);
668 for (d
= 0; d
< USB_MAX_DEVICE
; d
++) {
669 udev
= usb_get_dev_index(d
);
672 usb_display_desc(udev
);
673 usb_display_config(udev
);
679 * With driver model this isn't right since we can
680 * have multiple controllers and the device numbering
681 * starts at 1 on each bus.
683 i
= simple_strtoul(argv
[2], NULL
, 10);
684 printf("config for device %d\n", i
);
685 udev
= usb_find_device(i
);
687 printf("*** No device available ***\n");
690 usb_display_desc(udev
);
691 usb_display_config(udev
);
696 if (strncmp(argv
[1], "test", 4) == 0) {
698 return CMD_RET_USAGE
;
699 i
= simple_strtoul(argv
[2], NULL
, 10);
700 udev
= usb_find_device(i
);
702 printf("Device %d does not exist.\n", i
);
705 i
= simple_strtoul(argv
[3], NULL
, 10);
706 return usb_test(udev
, i
, argv
[4]);
708 #ifdef CONFIG_USB_STORAGE
709 if (strncmp(argv
[1], "stor", 4) == 0)
710 return usb_stor_info();
712 return blk_common_cmd(argc
, argv
, IF_TYPE_USB
, &usb_stor_curr_dev
);
714 return CMD_RET_USAGE
;
715 #endif /* CONFIG_USB_STORAGE */
721 "start - start (scan) USB controller\n"
722 "usb reset - reset (rescan) USB controller\n"
723 "usb stop [f] - stop USB [f]=force stop\n"
724 "usb tree - show USB device tree\n"
725 "usb info [dev] - show available USB devices\n"
726 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
727 " (specify port 0 to indicate the device's upstream port)\n"
728 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
729 #ifdef CONFIG_USB_STORAGE
730 "usb storage - show details of USB storage devices\n"
731 "usb dev [dev] - show or set current USB storage device\n"
732 "usb part [dev] - print partition table of one or all USB storage"
734 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
735 " to memory address `addr'\n"
736 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
737 " from memory address `addr'"
738 #endif /* CONFIG_USB_STORAGE */
742 #ifdef CONFIG_USB_STORAGE
744 usbboot
, 3, 1, do_usbboot
,
745 "boot from USB device",
748 #endif /* CONFIG_USB_STORAGE */