3 * Denis Peter, MPL AG Switzerland
5 * Most of this source has been derived from the Linux USB
8 * See file CREDITS for list of people who contributed to this
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30 #include <asm/byteorder.h>
31 #include <asm/unaligned.h>
35 #ifdef CONFIG_USB_STORAGE
36 static int usb_stor_curr_dev = -1; /* current device */
38 #ifdef CONFIG_USB_HOST_ETHER
39 static int usb_ether_curr_dev = -1; /* current ethernet device */
42 /* some display routines (info command) */
43 static char *usb_get_class_desc(unsigned char dclass)
46 case USB_CLASS_PER_INTERFACE:
47 return "See Interface";
51 return "Communication";
53 return "Human Interface";
54 case USB_CLASS_PRINTER:
56 case USB_CLASS_MASS_STORAGE:
57 return "Mass Storage";
62 case USB_CLASS_VENDOR_SPEC:
63 return "Vendor specific";
69 static void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
73 case USB_CLASS_PER_INTERFACE:
74 printf("See Interface");
77 printf("Human Interface, Subclass: ");
79 case USB_SUB_HID_NONE:
82 case USB_SUB_HID_BOOT:
85 case USB_PROT_HID_NONE:
88 case USB_PROT_HID_KEYBOARD:
91 case USB_PROT_HID_MOUSE:
104 case USB_CLASS_MASS_STORAGE:
105 printf("Mass Storage, ");
111 printf("SFF-8020i (ATAPI)");
114 printf("QIC-157 (Tape)");
123 printf("Transp. SCSI");
132 printf("Command/Bulk");
135 printf("Command/Bulk/Int");
146 printf("%s", usb_get_class_desc(dclass));
151 static void usb_display_string(struct usb_device *dev, int index)
153 ALLOC_CACHE_ALIGN_BUFFER(char, buffer, 256);
156 if (usb_string(dev, index, &buffer[0], 256) > 0)
157 printf("String: \"%s\"", buffer);
161 static void usb_display_desc(struct usb_device *dev)
163 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
164 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
165 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
166 (dev->descriptor.bcdUSB>>8) & 0xff,
167 dev->descriptor.bcdUSB & 0xff);
169 if (strlen(dev->mf) || strlen(dev->prod) ||
171 printf(" - %s %s %s\n", dev->mf, dev->prod,
173 if (dev->descriptor.bDeviceClass) {
174 printf(" - Class: ");
175 usb_display_class_sub(dev->descriptor.bDeviceClass,
176 dev->descriptor.bDeviceSubClass,
177 dev->descriptor.bDeviceProtocol);
180 printf(" - Class: (from Interface) %s\n",
182 dev->config.if_desc[0].desc.bInterfaceClass));
184 printf(" - PacketSize: %d Configurations: %d\n",
185 dev->descriptor.bMaxPacketSize0,
186 dev->descriptor.bNumConfigurations);
187 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
188 dev->descriptor.idVendor, dev->descriptor.idProduct,
189 (dev->descriptor.bcdDevice>>8) & 0xff,
190 dev->descriptor.bcdDevice & 0xff);
195 static void usb_display_conf_desc(struct usb_config_descriptor *config,
196 struct usb_device *dev)
198 printf(" Configuration: %d\n", config->bConfigurationValue);
199 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
200 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
201 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
202 config->bMaxPower*2);
203 if (config->iConfiguration) {
205 usb_display_string(dev, config->iConfiguration);
210 static void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
211 struct usb_device *dev)
213 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
214 printf(" - Alternate Setting %d, Endpoints: %d\n",
215 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
217 usb_display_class_sub(ifdesc->bInterfaceClass,
218 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
220 if (ifdesc->iInterface) {
222 usb_display_string(dev, ifdesc->iInterface);
227 static void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
229 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
230 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
231 switch ((epdesc->bmAttributes & 0x03)) {
236 printf("Isochronous");
245 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
246 if ((epdesc->bmAttributes & 0x03) == 0x3)
247 printf(" Interval %dms", epdesc->bInterval);
251 /* main routine to diasplay the configs, interfaces and endpoints */
252 static void usb_display_config(struct usb_device *dev)
254 struct usb_config *config;
255 struct usb_interface *ifdesc;
256 struct usb_endpoint_descriptor *epdesc;
259 config = &dev->config;
260 usb_display_conf_desc(&config->desc, dev);
261 for (i = 0; i < config->no_of_if; i++) {
262 ifdesc = &config->if_desc[i];
263 usb_display_if_desc(&ifdesc->desc, dev);
264 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
265 epdesc = &ifdesc->ep_desc[ii];
266 usb_display_ep_desc(epdesc);
272 static struct usb_device *usb_find_device(int devnum)
274 struct usb_device *dev;
277 for (d = 0; d < USB_MAX_DEVICE; d++) {
278 dev = usb_get_dev_index(d);
281 if (dev->devnum == devnum)
288 static inline char *portspeed(int speed)
293 case USB_SPEED_SUPER:
294 speed_str = "5 Gb/s";
297 speed_str = "480 Mb/s";
300 speed_str = "1.5 Mb/s";
303 speed_str = "12 Mb/s";
310 /* shows the device tree recursively */
311 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
314 int has_child, last_child;
318 /* check if the device has connected children */
320 for (i = 0; i < dev->maxchild; i++) {
321 if (dev->children[i] != NULL)
324 /* check if we are the last one */
326 if (dev->parent != NULL) {
327 for (i = 0; i < dev->parent->maxchild; i++) {
328 /* search for children */
329 if (dev->parent->children[i] == dev) {
330 /* found our pointer, see if we have a
333 while (i++ < dev->parent->maxchild) {
334 if (dev->parent->children[i] != NULL) {
341 } /* for all children of the parent */
343 /* correct last child */
346 } /* if not root hub */
349 printf("%d ", dev->devnum);
351 pre[index++] = has_child ? '|' : ' ';
353 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
354 dev->config.if_desc[0].desc.bInterfaceClass),
355 portspeed(dev->speed),
356 dev->config.desc.bMaxPower * 2);
357 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
358 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
359 printf(" %s\n", pre);
360 if (dev->maxchild > 0) {
361 for (i = 0; i < dev->maxchild; i++) {
362 if (dev->children[i] != NULL) {
363 usb_show_tree_graph(dev->children[i], pre);
370 /* main routine for the tree command */
371 static void usb_show_tree(struct usb_device *dev)
375 memset(preamble, 0, 32);
376 usb_show_tree_graph(dev, &preamble[0]);
379 static int usb_test(struct usb_device *dev, int port, char* arg)
383 if (port > dev->maxchild) {
384 printf("Device is no hub or does not have %d ports.\n", port);
391 printf("Setting Test_J mode");
392 mode = USB_TEST_MODE_J;
396 printf("Setting Test_K mode");
397 mode = USB_TEST_MODE_K;
401 printf("Setting Test_SE0_NAK mode");
402 mode = USB_TEST_MODE_SE0_NAK;
406 printf("Setting Test_Packet mode");
407 mode = USB_TEST_MODE_PACKET;
411 printf("Setting Test_Force_Enable mode");
412 mode = USB_TEST_MODE_FORCE_ENABLE;
415 printf("Unrecognized test mode: %s\nAvailable modes: "
416 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
421 printf(" on downstream facing port %d...\n", port);
423 printf(" on upstream facing port...\n");
425 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
426 port ? USB_RT_PORT : USB_RECIP_DEVICE,
427 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
429 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
430 printf("Error during SET_FEATURE.\n");
433 printf("Test mode successfully set. Use 'usb start' "
434 "to return to normal operation.\n");
440 /******************************************************************************
441 * usb boot command intepreter. Derived from diskboot
443 #ifdef CONFIG_USB_STORAGE
444 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
446 return common_diskboot(cmdtp, "usb", argc, argv);
448 #endif /* CONFIG_USB_STORAGE */
451 /******************************************************************************
452 * usb command intepreter
454 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
458 struct usb_device *dev = NULL;
459 extern char usb_started;
460 #ifdef CONFIG_USB_STORAGE
461 block_dev_desc_t *stor_dev;
465 return CMD_RET_USAGE;
467 if ((strncmp(argv[1], "reset", 5) == 0) ||
468 (strncmp(argv[1], "start", 5) == 0)) {
469 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
471 printf("(Re)start USB...\n");
472 if (usb_init() >= 0) {
473 #ifdef CONFIG_USB_STORAGE
474 /* try to recognize storage devices immediately */
475 usb_stor_curr_dev = usb_stor_scan(1);
477 #ifdef CONFIG_USB_HOST_ETHER
478 /* try to recognize ethernet devices immediately */
479 usb_ether_curr_dev = usb_host_eth_scan(1);
481 #ifdef CONFIG_USB_KEYBOARD
487 if (strncmp(argv[1], "stop", 4) == 0) {
488 #ifdef CONFIG_USB_KEYBOARD
490 if (usb_kbd_deregister() != 0) {
491 printf("USB not stopped: usbkbd still"
496 /* forced stop, switch console in to serial */
497 console_assign(stdin, "serial");
498 usb_kbd_deregister();
501 printf("stopping USB..\n");
506 printf("USB is stopped. Please issue 'usb start' first.\n");
509 if (strncmp(argv[1], "tree", 4) == 0) {
510 puts("USB device tree:\n");
511 for (i = 0; i < USB_MAX_DEVICE; i++) {
512 dev = usb_get_dev_index(i);
515 if (dev->parent == NULL)
520 if (strncmp(argv[1], "inf", 3) == 0) {
523 for (d = 0; d < USB_MAX_DEVICE; d++) {
524 dev = usb_get_dev_index(d);
527 usb_display_desc(dev);
528 usb_display_config(dev);
532 i = simple_strtoul(argv[2], NULL, 10);
533 printf("config for device %d\n", i);
534 dev = usb_find_device(i);
536 printf("*** No device available ***\n");
539 usb_display_desc(dev);
540 usb_display_config(dev);
545 if (strncmp(argv[1], "test", 4) == 0) {
547 return CMD_RET_USAGE;
548 i = simple_strtoul(argv[2], NULL, 10);
549 dev = usb_find_device(i);
551 printf("Device %d does not exist.\n", i);
554 i = simple_strtoul(argv[3], NULL, 10);
555 return usb_test(dev, i, argv[4]);
557 #ifdef CONFIG_USB_STORAGE
558 if (strncmp(argv[1], "stor", 4) == 0)
559 return usb_stor_info();
561 if (strncmp(argv[1], "part", 4) == 0) {
564 for (devno = 0; ; ++devno) {
565 stor_dev = usb_stor_get_dev(devno);
566 if (stor_dev == NULL)
568 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
572 debug("print_part of %x\n", devno);
573 print_part(stor_dev);
577 devno = simple_strtoul(argv[2], NULL, 16);
578 stor_dev = usb_stor_get_dev(devno);
579 if (stor_dev != NULL &&
580 stor_dev->type != DEV_TYPE_UNKNOWN) {
582 debug("print_part of %x\n", devno);
583 print_part(stor_dev);
587 printf("\nno USB devices available\n");
592 if (strcmp(argv[1], "read") == 0) {
593 if (usb_stor_curr_dev < 0) {
594 printf("no current device selected\n");
598 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
599 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
600 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
602 printf("\nUSB read: device %d block # %ld, count %ld"
603 " ... ", usb_stor_curr_dev, blk, cnt);
604 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
605 n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
607 printf("%ld blocks read: %s\n", n,
608 (n == cnt) ? "OK" : "ERROR");
614 if (strcmp(argv[1], "write") == 0) {
615 if (usb_stor_curr_dev < 0) {
616 printf("no current device selected\n");
620 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
621 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
622 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
624 printf("\nUSB write: device %d block # %ld, count %ld"
625 " ... ", usb_stor_curr_dev, blk, cnt);
626 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
627 n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
629 printf("%ld blocks write: %s\n", n,
630 (n == cnt) ? "OK" : "ERROR");
636 if (strncmp(argv[1], "dev", 3) == 0) {
638 int dev = (int)simple_strtoul(argv[2], NULL, 10);
639 printf("\nUSB device %d: ", dev);
640 stor_dev = usb_stor_get_dev(dev);
641 if (stor_dev == NULL) {
642 printf("unknown device\n");
645 printf("\n Device %d: ", dev);
647 if (stor_dev->type == DEV_TYPE_UNKNOWN)
649 usb_stor_curr_dev = dev;
650 printf("... is now current device\n");
653 printf("\nUSB device %d: ", usb_stor_curr_dev);
654 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
656 if (stor_dev->type == DEV_TYPE_UNKNOWN)
662 #endif /* CONFIG_USB_STORAGE */
663 return CMD_RET_USAGE;
669 "start - start (scan) USB controller\n"
670 "usb reset - reset (rescan) USB controller\n"
671 "usb stop [f] - stop USB [f]=force stop\n"
672 "usb tree - show USB device tree\n"
673 "usb info [dev] - show available USB devices\n"
674 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
675 " (specify port 0 to indicate the device's upstream port)\n"
676 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
677 #ifdef CONFIG_USB_STORAGE
678 "usb storage - show details of USB storage devices\n"
679 "usb dev [dev] - show or set current USB storage device\n"
680 "usb part [dev] - print partition table of one or all USB storage"
682 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
683 " to memory address `addr'\n"
684 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
685 " from memory address `addr'"
686 #endif /* CONFIG_USB_STORAGE */
690 #ifdef CONFIG_USB_STORAGE
692 usbboot, 3, 1, do_usbboot,
693 "boot from USB device",
696 #endif /* CONFIG_USB_STORAGE */