3 * Denis Peter, MPL AG Switzerland
5 * Most of this source has been derived from the Linux USB
8 * SPDX-License-Identifier: GPL-2.0+
13 #include <asm/byteorder.h>
14 #include <asm/unaligned.h>
18 #ifdef CONFIG_USB_STORAGE
19 static int usb_stor_curr_dev
= -1; /* current device */
21 #ifdef CONFIG_USB_HOST_ETHER
22 static int usb_ether_curr_dev
= -1; /* current ethernet device */
25 /* some display routines (info command) */
26 static char *usb_get_class_desc(unsigned char dclass
)
29 case USB_CLASS_PER_INTERFACE
:
30 return "See Interface";
34 return "Communication";
36 return "Human Interface";
37 case USB_CLASS_PRINTER
:
39 case USB_CLASS_MASS_STORAGE
:
40 return "Mass Storage";
45 case USB_CLASS_VENDOR_SPEC
:
46 return "Vendor specific";
52 static void usb_display_class_sub(unsigned char dclass
, unsigned char subclass
,
56 case USB_CLASS_PER_INTERFACE
:
57 printf("See Interface");
60 printf("Human Interface, Subclass: ");
62 case USB_SUB_HID_NONE
:
65 case USB_SUB_HID_BOOT
:
68 case USB_PROT_HID_NONE
:
71 case USB_PROT_HID_KEYBOARD
:
74 case USB_PROT_HID_MOUSE
:
87 case USB_CLASS_MASS_STORAGE
:
88 printf("Mass Storage, ");
94 printf("SFF-8020i (ATAPI)");
97 printf("QIC-157 (Tape)");
106 printf("Transp. SCSI");
115 printf("Command/Bulk");
118 printf("Command/Bulk/Int");
129 printf("%s", usb_get_class_desc(dclass
));
134 static void usb_display_string(struct usb_device
*dev
, int index
)
136 ALLOC_CACHE_ALIGN_BUFFER(char, buffer
, 256);
139 if (usb_string(dev
, index
, &buffer
[0], 256) > 0)
140 printf("String: \"%s\"", buffer
);
144 static void usb_display_desc(struct usb_device
*dev
)
146 if (dev
->descriptor
.bDescriptorType
== USB_DT_DEVICE
) {
147 printf("%d: %s, USB Revision %x.%x\n", dev
->devnum
,
148 usb_get_class_desc(dev
->config
.if_desc
[0].desc
.bInterfaceClass
),
149 (dev
->descriptor
.bcdUSB
>>8) & 0xff,
150 dev
->descriptor
.bcdUSB
& 0xff);
152 if (strlen(dev
->mf
) || strlen(dev
->prod
) ||
154 printf(" - %s %s %s\n", dev
->mf
, dev
->prod
,
156 if (dev
->descriptor
.bDeviceClass
) {
157 printf(" - Class: ");
158 usb_display_class_sub(dev
->descriptor
.bDeviceClass
,
159 dev
->descriptor
.bDeviceSubClass
,
160 dev
->descriptor
.bDeviceProtocol
);
163 printf(" - Class: (from Interface) %s\n",
165 dev
->config
.if_desc
[0].desc
.bInterfaceClass
));
167 printf(" - PacketSize: %d Configurations: %d\n",
168 dev
->descriptor
.bMaxPacketSize0
,
169 dev
->descriptor
.bNumConfigurations
);
170 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
171 dev
->descriptor
.idVendor
, dev
->descriptor
.idProduct
,
172 (dev
->descriptor
.bcdDevice
>>8) & 0xff,
173 dev
->descriptor
.bcdDevice
& 0xff);
178 static void usb_display_conf_desc(struct usb_config_descriptor
*config
,
179 struct usb_device
*dev
)
181 printf(" Configuration: %d\n", config
->bConfigurationValue
);
182 printf(" - Interfaces: %d %s%s%dmA\n", config
->bNumInterfaces
,
183 (config
->bmAttributes
& 0x40) ? "Self Powered " : "Bus Powered ",
184 (config
->bmAttributes
& 0x20) ? "Remote Wakeup " : "",
185 config
->bMaxPower
*2);
186 if (config
->iConfiguration
) {
188 usb_display_string(dev
, config
->iConfiguration
);
193 static void usb_display_if_desc(struct usb_interface_descriptor
*ifdesc
,
194 struct usb_device
*dev
)
196 printf(" Interface: %d\n", ifdesc
->bInterfaceNumber
);
197 printf(" - Alternate Setting %d, Endpoints: %d\n",
198 ifdesc
->bAlternateSetting
, ifdesc
->bNumEndpoints
);
200 usb_display_class_sub(ifdesc
->bInterfaceClass
,
201 ifdesc
->bInterfaceSubClass
, ifdesc
->bInterfaceProtocol
);
203 if (ifdesc
->iInterface
) {
205 usb_display_string(dev
, ifdesc
->iInterface
);
210 static void usb_display_ep_desc(struct usb_endpoint_descriptor
*epdesc
)
212 printf(" - Endpoint %d %s ", epdesc
->bEndpointAddress
& 0xf,
213 (epdesc
->bEndpointAddress
& 0x80) ? "In" : "Out");
214 switch ((epdesc
->bmAttributes
& 0x03)) {
219 printf("Isochronous");
228 printf(" MaxPacket %d", get_unaligned(&epdesc
->wMaxPacketSize
));
229 if ((epdesc
->bmAttributes
& 0x03) == 0x3)
230 printf(" Interval %dms", epdesc
->bInterval
);
234 /* main routine to diasplay the configs, interfaces and endpoints */
235 static void usb_display_config(struct usb_device
*dev
)
237 struct usb_config
*config
;
238 struct usb_interface
*ifdesc
;
239 struct usb_endpoint_descriptor
*epdesc
;
242 config
= &dev
->config
;
243 usb_display_conf_desc(&config
->desc
, dev
);
244 for (i
= 0; i
< config
->no_of_if
; i
++) {
245 ifdesc
= &config
->if_desc
[i
];
246 usb_display_if_desc(&ifdesc
->desc
, dev
);
247 for (ii
= 0; ii
< ifdesc
->no_of_ep
; ii
++) {
248 epdesc
= &ifdesc
->ep_desc
[ii
];
249 usb_display_ep_desc(epdesc
);
255 static struct usb_device
*usb_find_device(int devnum
)
257 struct usb_device
*dev
;
260 for (d
= 0; d
< USB_MAX_DEVICE
; d
++) {
261 dev
= usb_get_dev_index(d
);
264 if (dev
->devnum
== devnum
)
271 static inline char *portspeed(int speed
)
276 case USB_SPEED_SUPER
:
277 speed_str
= "5 Gb/s";
280 speed_str
= "480 Mb/s";
283 speed_str
= "1.5 Mb/s";
286 speed_str
= "12 Mb/s";
293 /* shows the device tree recursively */
294 static void usb_show_tree_graph(struct usb_device
*dev
, char *pre
)
297 int has_child
, last_child
;
301 /* check if the device has connected children */
303 for (i
= 0; i
< dev
->maxchild
; i
++) {
304 if (dev
->children
[i
] != NULL
)
307 /* check if we are the last one */
309 if (dev
->parent
!= NULL
) {
310 for (i
= 0; i
< dev
->parent
->maxchild
; i
++) {
311 /* search for children */
312 if (dev
->parent
->children
[i
] == dev
) {
313 /* found our pointer, see if we have a
316 while (i
++ < dev
->parent
->maxchild
) {
317 if (dev
->parent
->children
[i
] != NULL
) {
324 } /* for all children of the parent */
326 /* correct last child */
329 } /* if not root hub */
332 printf("%d ", dev
->devnum
);
334 pre
[index
++] = has_child
? '|' : ' ';
336 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
337 dev
->config
.if_desc
[0].desc
.bInterfaceClass
),
338 portspeed(dev
->speed
),
339 dev
->config
.desc
.bMaxPower
* 2);
340 if (strlen(dev
->mf
) || strlen(dev
->prod
) || strlen(dev
->serial
))
341 printf(" %s %s %s %s\n", pre
, dev
->mf
, dev
->prod
, dev
->serial
);
342 printf(" %s\n", pre
);
343 if (dev
->maxchild
> 0) {
344 for (i
= 0; i
< dev
->maxchild
; i
++) {
345 if (dev
->children
[i
] != NULL
) {
346 usb_show_tree_graph(dev
->children
[i
], pre
);
353 /* main routine for the tree command */
354 static void usb_show_tree(struct usb_device
*dev
)
358 memset(preamble
, 0, 32);
359 usb_show_tree_graph(dev
, &preamble
[0]);
362 static int usb_test(struct usb_device
*dev
, int port
, char* arg
)
366 if (port
> dev
->maxchild
) {
367 printf("Device is no hub or does not have %d ports.\n", port
);
374 printf("Setting Test_J mode");
375 mode
= USB_TEST_MODE_J
;
379 printf("Setting Test_K mode");
380 mode
= USB_TEST_MODE_K
;
384 printf("Setting Test_SE0_NAK mode");
385 mode
= USB_TEST_MODE_SE0_NAK
;
389 printf("Setting Test_Packet mode");
390 mode
= USB_TEST_MODE_PACKET
;
394 printf("Setting Test_Force_Enable mode");
395 mode
= USB_TEST_MODE_FORCE_ENABLE
;
398 printf("Unrecognized test mode: %s\nAvailable modes: "
399 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg
);
404 printf(" on downstream facing port %d...\n", port
);
406 printf(" on upstream facing port...\n");
408 if (usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0), USB_REQ_SET_FEATURE
,
409 port
? USB_RT_PORT
: USB_RECIP_DEVICE
,
410 port
? USB_PORT_FEAT_TEST
: USB_FEAT_TEST
,
412 NULL
, 0, USB_CNTL_TIMEOUT
) == -1) {
413 printf("Error during SET_FEATURE.\n");
416 printf("Test mode successfully set. Use 'usb start' "
417 "to return to normal operation.\n");
423 /******************************************************************************
424 * usb boot command intepreter. Derived from diskboot
426 #ifdef CONFIG_USB_STORAGE
427 static int do_usbboot(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
429 return common_diskboot(cmdtp
, "usb", argc
, argv
);
431 #endif /* CONFIG_USB_STORAGE */
433 static int do_usb_stop_keyboard(int force
)
435 #ifdef CONFIG_USB_KEYBOARD
436 if (usb_kbd_deregister(force
) != 0) {
437 printf("USB not stopped: usbkbd still using USB\n");
444 /******************************************************************************
445 * usb command intepreter
447 static int do_usb(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
451 struct usb_device
*dev
= NULL
;
452 extern char usb_started
;
453 #ifdef CONFIG_USB_STORAGE
454 block_dev_desc_t
*stor_dev
;
458 return CMD_RET_USAGE
;
460 if ((strncmp(argv
[1], "reset", 5) == 0) ||
461 (strncmp(argv
[1], "start", 5) == 0)) {
462 bootstage_mark_name(BOOTSTAGE_ID_USB_START
, "usb_start");
463 if (do_usb_stop_keyboard(1) != 0)
466 printf("(Re)start USB...\n");
467 if (usb_init() >= 0) {
468 #ifdef CONFIG_USB_STORAGE
469 /* try to recognize storage devices immediately */
470 usb_stor_curr_dev
= usb_stor_scan(1);
472 #ifdef CONFIG_USB_HOST_ETHER
473 /* try to recognize ethernet devices immediately */
474 usb_ether_curr_dev
= usb_host_eth_scan(1);
476 #ifdef CONFIG_USB_KEYBOARD
482 if (strncmp(argv
[1], "stop", 4) == 0) {
484 console_assign(stdin
, "serial");
485 if (do_usb_stop_keyboard(0) != 0)
487 printf("stopping USB..\n");
492 printf("USB is stopped. Please issue 'usb start' first.\n");
495 if (strncmp(argv
[1], "tree", 4) == 0) {
496 puts("USB device tree:\n");
497 for (i
= 0; i
< USB_MAX_DEVICE
; i
++) {
498 dev
= usb_get_dev_index(i
);
501 if (dev
->parent
== NULL
)
506 if (strncmp(argv
[1], "inf", 3) == 0) {
509 for (d
= 0; d
< USB_MAX_DEVICE
; d
++) {
510 dev
= usb_get_dev_index(d
);
513 usb_display_desc(dev
);
514 usb_display_config(dev
);
518 i
= simple_strtoul(argv
[2], NULL
, 10);
519 printf("config for device %d\n", i
);
520 dev
= usb_find_device(i
);
522 printf("*** No device available ***\n");
525 usb_display_desc(dev
);
526 usb_display_config(dev
);
531 if (strncmp(argv
[1], "test", 4) == 0) {
533 return CMD_RET_USAGE
;
534 i
= simple_strtoul(argv
[2], NULL
, 10);
535 dev
= usb_find_device(i
);
537 printf("Device %d does not exist.\n", i
);
540 i
= simple_strtoul(argv
[3], NULL
, 10);
541 return usb_test(dev
, i
, argv
[4]);
543 #ifdef CONFIG_USB_STORAGE
544 if (strncmp(argv
[1], "stor", 4) == 0)
545 return usb_stor_info();
547 if (strncmp(argv
[1], "part", 4) == 0) {
550 for (devno
= 0; ; ++devno
) {
551 stor_dev
= usb_stor_get_dev(devno
);
552 if (stor_dev
== NULL
)
554 if (stor_dev
->type
!= DEV_TYPE_UNKNOWN
) {
558 debug("print_part of %x\n", devno
);
559 print_part(stor_dev
);
563 devno
= simple_strtoul(argv
[2], NULL
, 16);
564 stor_dev
= usb_stor_get_dev(devno
);
565 if (stor_dev
!= NULL
&&
566 stor_dev
->type
!= DEV_TYPE_UNKNOWN
) {
568 debug("print_part of %x\n", devno
);
569 print_part(stor_dev
);
573 printf("\nno USB devices available\n");
578 if (strcmp(argv
[1], "read") == 0) {
579 if (usb_stor_curr_dev
< 0) {
580 printf("no current device selected\n");
584 unsigned long addr
= simple_strtoul(argv
[2], NULL
, 16);
585 unsigned long blk
= simple_strtoul(argv
[3], NULL
, 16);
586 unsigned long cnt
= simple_strtoul(argv
[4], NULL
, 16);
588 printf("\nUSB read: device %d block # %ld, count %ld"
589 " ... ", usb_stor_curr_dev
, blk
, cnt
);
590 stor_dev
= usb_stor_get_dev(usb_stor_curr_dev
);
591 n
= stor_dev
->block_read(usb_stor_curr_dev
, blk
, cnt
,
593 printf("%ld blocks read: %s\n", n
,
594 (n
== cnt
) ? "OK" : "ERROR");
600 if (strcmp(argv
[1], "write") == 0) {
601 if (usb_stor_curr_dev
< 0) {
602 printf("no current device selected\n");
606 unsigned long addr
= simple_strtoul(argv
[2], NULL
, 16);
607 unsigned long blk
= simple_strtoul(argv
[3], NULL
, 16);
608 unsigned long cnt
= simple_strtoul(argv
[4], NULL
, 16);
610 printf("\nUSB write: device %d block # %ld, count %ld"
611 " ... ", usb_stor_curr_dev
, blk
, cnt
);
612 stor_dev
= usb_stor_get_dev(usb_stor_curr_dev
);
613 n
= stor_dev
->block_write(usb_stor_curr_dev
, blk
, cnt
,
615 printf("%ld blocks write: %s\n", n
,
616 (n
== cnt
) ? "OK" : "ERROR");
622 if (strncmp(argv
[1], "dev", 3) == 0) {
624 int dev
= (int)simple_strtoul(argv
[2], NULL
, 10);
625 printf("\nUSB device %d: ", dev
);
626 stor_dev
= usb_stor_get_dev(dev
);
627 if (stor_dev
== NULL
) {
628 printf("unknown device\n");
631 printf("\n Device %d: ", dev
);
633 if (stor_dev
->type
== DEV_TYPE_UNKNOWN
)
635 usb_stor_curr_dev
= dev
;
636 printf("... is now current device\n");
639 printf("\nUSB device %d: ", usb_stor_curr_dev
);
640 stor_dev
= usb_stor_get_dev(usb_stor_curr_dev
);
642 if (stor_dev
->type
== DEV_TYPE_UNKNOWN
)
648 #endif /* CONFIG_USB_STORAGE */
649 return CMD_RET_USAGE
;
655 "start - start (scan) USB controller\n"
656 "usb reset - reset (rescan) USB controller\n"
657 "usb stop [f] - stop USB [f]=force stop\n"
658 "usb tree - show USB device tree\n"
659 "usb info [dev] - show available USB devices\n"
660 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
661 " (specify port 0 to indicate the device's upstream port)\n"
662 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
663 #ifdef CONFIG_USB_STORAGE
664 "usb storage - show details of USB storage devices\n"
665 "usb dev [dev] - show or set current USB storage device\n"
666 "usb part [dev] - print partition table of one or all USB storage"
668 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
669 " to memory address `addr'\n"
670 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
671 " from memory address `addr'"
672 #endif /* CONFIG_USB_STORAGE */
676 #ifdef CONFIG_USB_STORAGE
678 usbboot
, 3, 1, do_usbboot
,
679 "boot from USB device",
682 #endif /* CONFIG_USB_STORAGE */