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>
34 #ifdef CONFIG_USB_STORAGE
35 static int usb_stor_curr_dev = -1; /* current device */
37 #ifdef CONFIG_USB_HOST_ETHER
38 static int usb_ether_curr_dev = -1; /* current ethernet device */
41 /* some display routines (info command) */
42 char *usb_get_class_desc(unsigned char dclass)
45 case USB_CLASS_PER_INTERFACE:
46 return "See Interface";
50 return "Communication";
52 return "Human Interface";
53 case USB_CLASS_PRINTER:
55 case USB_CLASS_MASS_STORAGE:
56 return "Mass Storage";
61 case USB_CLASS_VENDOR_SPEC:
62 return "Vendor specific";
68 void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
72 case USB_CLASS_PER_INTERFACE:
73 printf("See Interface");
76 printf("Human Interface, Subclass: ");
78 case USB_SUB_HID_NONE:
81 case USB_SUB_HID_BOOT:
84 case USB_PROT_HID_NONE:
87 case USB_PROT_HID_KEYBOARD:
90 case USB_PROT_HID_MOUSE:
103 case USB_CLASS_MASS_STORAGE:
104 printf("Mass Storage, ");
110 printf("SFF-8020i (ATAPI)");
113 printf("QIC-157 (Tape)");
122 printf("Transp. SCSI");
131 printf("Command/Bulk");
134 printf("Command/Bulk/Int");
145 printf("%s", usb_get_class_desc(dclass));
150 void usb_display_string(struct usb_device *dev, int index)
154 if (usb_string(dev, index, &buffer[0], 256) > 0)
155 printf("String: \"%s\"", buffer);
159 void usb_display_desc(struct usb_device *dev)
161 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
162 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
163 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
164 (dev->descriptor.bcdUSB>>8) & 0xff,
165 dev->descriptor.bcdUSB & 0xff);
167 if (strlen(dev->mf) || strlen(dev->prod) ||
169 printf(" - %s %s %s\n", dev->mf, dev->prod,
171 if (dev->descriptor.bDeviceClass) {
172 printf(" - Class: ");
173 usb_display_class_sub(dev->descriptor.bDeviceClass,
174 dev->descriptor.bDeviceSubClass,
175 dev->descriptor.bDeviceProtocol);
178 printf(" - Class: (from Interface) %s\n",
180 dev->config.if_desc[0].desc.bInterfaceClass));
182 printf(" - PacketSize: %d Configurations: %d\n",
183 dev->descriptor.bMaxPacketSize0,
184 dev->descriptor.bNumConfigurations);
185 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
186 dev->descriptor.idVendor, dev->descriptor.idProduct,
187 (dev->descriptor.bcdDevice>>8) & 0xff,
188 dev->descriptor.bcdDevice & 0xff);
193 void usb_display_conf_desc(struct usb_configuration_descriptor *config,
194 struct usb_device *dev)
196 printf(" Configuration: %d\n", config->bConfigurationValue);
197 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
198 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
199 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
200 config->bMaxPower*2);
201 if (config->iConfiguration) {
203 usb_display_string(dev, config->iConfiguration);
208 void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
209 struct usb_device *dev)
211 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
212 printf(" - Alternate Setting %d, Endpoints: %d\n",
213 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
215 usb_display_class_sub(ifdesc->bInterfaceClass,
216 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
218 if (ifdesc->iInterface) {
220 usb_display_string(dev, ifdesc->iInterface);
225 void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
227 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
228 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
229 switch ((epdesc->bmAttributes & 0x03)) {
234 printf("Isochronous");
243 printf(" MaxPacket %d", epdesc->wMaxPacketSize);
244 if ((epdesc->bmAttributes & 0x03) == 0x3)
245 printf(" Interval %dms", epdesc->bInterval);
249 /* main routine to diasplay the configs, interfaces and endpoints */
250 void usb_display_config(struct usb_device *dev)
252 struct usb_config *config;
253 struct usb_interface *ifdesc;
254 struct usb_endpoint_descriptor *epdesc;
257 config = &dev->config;
258 usb_display_conf_desc(&config->desc, dev);
259 for (i = 0; i < config->no_of_if; i++) {
260 ifdesc = &config->if_desc[i];
261 usb_display_if_desc(&ifdesc->desc, dev);
262 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
263 epdesc = &ifdesc->ep_desc[ii];
264 usb_display_ep_desc(epdesc);
270 static inline char *portspeed(int speed)
272 if (speed == USB_SPEED_HIGH)
274 else if (speed == USB_SPEED_LOW)
280 /* shows the device tree recursively */
281 void usb_show_tree_graph(struct usb_device *dev, char *pre)
284 int has_child, last_child, port;
288 /* check if the device has connected children */
290 for (i = 0; i < dev->maxchild; i++) {
291 if (dev->children[i] != NULL)
294 /* check if we are the last one */
296 if (dev->parent != NULL) {
297 for (i = 0; i < dev->parent->maxchild; i++) {
298 /* search for children */
299 if (dev->parent->children[i] == dev) {
300 /* found our pointer, see if we have a
304 while (i++ < dev->parent->maxchild) {
305 if (dev->parent->children[i] != NULL) {
312 } /* for all children of the parent */
314 /* correct last child */
317 } /* if not root hub */
320 printf("%d ", dev->devnum);
322 pre[index++] = has_child ? '|' : ' ';
324 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
325 dev->config.if_desc[0].desc.bInterfaceClass),
326 portspeed(dev->speed),
327 dev->config.desc.bMaxPower * 2);
328 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
329 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
330 printf(" %s\n", pre);
331 if (dev->maxchild > 0) {
332 for (i = 0; i < dev->maxchild; i++) {
333 if (dev->children[i] != NULL) {
334 usb_show_tree_graph(dev->children[i], pre);
341 /* main routine for the tree command */
342 void usb_show_tree(struct usb_device *dev)
346 memset(preamble, 0, 32);
347 usb_show_tree_graph(dev, &preamble[0]);
351 /******************************************************************************
352 * usb boot command intepreter. Derived from diskboot
354 #ifdef CONFIG_USB_STORAGE
355 int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
357 char *boot_device = NULL;
359 int dev, part = 1, rcode;
361 disk_partition_t info;
363 block_dev_desc_t *stor_dev;
364 #if defined(CONFIG_FIT)
365 const void *fit_hdr = NULL;
370 addr = CONFIG_SYS_LOAD_ADDR;
371 boot_device = getenv("bootdevice");
374 addr = simple_strtoul(argv[1], NULL, 16);
375 boot_device = getenv("bootdevice");
378 addr = simple_strtoul(argv[1], NULL, 16);
379 boot_device = argv[2];
382 return cmd_usage(cmdtp);
386 puts("\n** No boot device **\n");
390 dev = simple_strtoul(boot_device, &ep, 16);
391 stor_dev = usb_stor_get_dev(dev);
392 if (stor_dev == NULL || stor_dev->type == DEV_TYPE_UNKNOWN) {
393 printf("\n** Device %d not available\n", dev);
396 if (stor_dev->block_read == NULL) {
397 printf("storage device not initialized. Use usb scan\n");
402 puts("\n** Invalid boot device, use `dev[:part]' **\n");
405 part = simple_strtoul(++ep, NULL, 16);
408 if (get_partition_info(stor_dev, part, &info)) {
409 /* try to boot raw .... */
410 strncpy((char *)&info.type[0], BOOT_PART_TYPE,
411 sizeof(BOOT_PART_TYPE));
412 strncpy((char *)&info.name[0], "Raw", 4);
416 printf("error reading partinfo...try to boot raw\n");
418 if ((strncmp((char *)info.type, BOOT_PART_TYPE,
419 sizeof(info.type)) != 0) &&
420 (strncmp((char *)info.type, BOOT_PART_COMP,
421 sizeof(info.type)) != 0)) {
422 printf("\n** Invalid partition type \"%.32s\""
423 " (expect \"" BOOT_PART_TYPE "\")\n",
427 printf("\nLoading from USB device %d, partition %d: "
428 "Name: %.32s Type: %.32s\n",
429 dev, part, info.name, info.type);
431 debug("First Block: %ld, # of blocks: %ld, Block Size: %ld\n",
432 info.start, info.size, info.blksz);
434 if (stor_dev->block_read(dev, info.start, 1, (ulong *)addr) != 1) {
435 printf("** Read error on %d:%d\n", dev, part);
439 switch (genimg_get_format((void *)addr)) {
440 case IMAGE_FORMAT_LEGACY:
441 hdr = (image_header_t *)addr;
443 if (!image_check_hcrc(hdr)) {
444 puts("\n** Bad Header Checksum **\n");
448 image_print_contents(hdr);
450 cnt = image_get_image_size(hdr);
452 #if defined(CONFIG_FIT)
453 case IMAGE_FORMAT_FIT:
454 fit_hdr = (const void *)addr;
455 puts("Fit image detected...\n");
457 cnt = fit_get_size(fit_hdr);
461 puts("** Unknown image type\n");
465 cnt += info.blksz - 1;
469 if (stor_dev->block_read(dev, info.start+1, cnt,
470 (ulong *)(addr+info.blksz)) != cnt) {
471 printf("\n** Read error on %d:%d\n", dev, part);
475 #if defined(CONFIG_FIT)
476 /* This cannot be done earlier, we need complete FIT image in RAM
479 if (genimg_get_format((void *)addr) == IMAGE_FORMAT_FIT) {
480 if (!fit_check_format(fit_hdr)) {
481 puts("** Bad FIT image format\n");
484 fit_print_contents(fit_hdr);
488 /* Loading ok, update default load address */
491 flush_cache(addr, (cnt+1)*info.blksz);
493 /* Check if we should attempt an auto-start */
494 if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
496 local_args[0] = argv[0];
497 local_args[1] = NULL;
498 printf("Automatic boot of image at addr 0x%08lX ...\n", addr);
499 rcode = do_bootm(cmdtp, 0, 1, local_args);
504 #endif /* CONFIG_USB_STORAGE */
507 /******************************************************************************
508 * usb command intepreter
510 int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
514 struct usb_device *dev = NULL;
515 extern char usb_started;
516 #ifdef CONFIG_USB_STORAGE
517 block_dev_desc_t *stor_dev;
521 return cmd_usage(cmdtp);
523 if ((strncmp(argv[1], "reset", 5) == 0) ||
524 (strncmp(argv[1], "start", 5) == 0)) {
526 printf("(Re)start USB...\n");
529 #ifdef CONFIG_USB_STORAGE
530 /* try to recognize storage devices immediately */
531 usb_stor_curr_dev = usb_stor_scan(1);
533 #ifdef CONFIG_USB_HOST_ETHER
534 /* try to recognize ethernet devices immediately */
535 usb_ether_curr_dev = usb_host_eth_scan(1);
540 if (strncmp(argv[1], "stop", 4) == 0) {
541 #ifdef CONFIG_USB_KEYBOARD
543 if (usb_kbd_deregister() != 0) {
544 printf("USB not stopped: usbkbd still"
549 /* forced stop, switch console in to serial */
550 console_assign(stdin, "serial");
551 usb_kbd_deregister();
554 printf("stopping USB..\n");
559 printf("USB is stopped. Please issue 'usb start' first.\n");
562 if (strncmp(argv[1], "tree", 4) == 0) {
563 printf("\nDevice Tree:\n");
564 usb_show_tree(usb_get_dev_index(0));
567 if (strncmp(argv[1], "inf", 3) == 0) {
570 for (d = 0; d < USB_MAX_DEVICE; d++) {
571 dev = usb_get_dev_index(d);
574 usb_display_desc(dev);
575 usb_display_config(dev);
581 i = simple_strtoul(argv[2], NULL, 16);
582 printf("config for device %d\n", i);
583 for (d = 0; d < USB_MAX_DEVICE; d++) {
584 dev = usb_get_dev_index(d);
587 if (dev->devnum == i)
591 printf("*** No device available ***\n");
594 usb_display_desc(dev);
595 usb_display_config(dev);
600 #ifdef CONFIG_USB_STORAGE
601 if (strncmp(argv[1], "stor", 4) == 0)
602 return usb_stor_info();
604 if (strncmp(argv[1], "part", 4) == 0) {
607 for (devno = 0; ; ++devno) {
608 stor_dev = usb_stor_get_dev(devno);
609 if (stor_dev == NULL)
611 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
615 debug("print_part of %x\n", devno);
616 print_part(stor_dev);
620 devno = simple_strtoul(argv[2], NULL, 16);
621 stor_dev = usb_stor_get_dev(devno);
622 if (stor_dev != NULL &&
623 stor_dev->type != DEV_TYPE_UNKNOWN) {
625 debug("print_part of %x\n", devno);
626 print_part(stor_dev);
630 printf("\nno USB devices available\n");
635 if (strcmp(argv[1], "read") == 0) {
636 if (usb_stor_curr_dev < 0) {
637 printf("no current device selected\n");
641 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
642 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
643 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
645 printf("\nUSB read: device %d block # %ld, count %ld"
646 " ... ", usb_stor_curr_dev, blk, cnt);
647 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
648 n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
650 printf("%ld blocks read: %s\n", n,
651 (n == cnt) ? "OK" : "ERROR");
657 if (strcmp(argv[1], "write") == 0) {
658 if (usb_stor_curr_dev < 0) {
659 printf("no current device selected\n");
663 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
664 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
665 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
667 printf("\nUSB write: device %d block # %ld, count %ld"
668 " ... ", usb_stor_curr_dev, blk, cnt);
669 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
670 n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
672 printf("%ld blocks write: %s\n", n,
673 (n == cnt) ? "OK" : "ERROR");
679 if (strncmp(argv[1], "dev", 3) == 0) {
681 int dev = (int)simple_strtoul(argv[2], NULL, 10);
682 printf("\nUSB device %d: ", dev);
683 stor_dev = usb_stor_get_dev(dev);
684 if (stor_dev == NULL) {
685 printf("unknown device\n");
688 printf("\n Device %d: ", dev);
690 if (stor_dev->type == DEV_TYPE_UNKNOWN)
692 usb_stor_curr_dev = dev;
693 printf("... is now current device\n");
696 printf("\nUSB device %d: ", usb_stor_curr_dev);
697 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
699 if (stor_dev->type == DEV_TYPE_UNKNOWN)
705 #endif /* CONFIG_USB_STORAGE */
706 return cmd_usage(cmdtp);
709 #ifdef CONFIG_USB_STORAGE
713 "reset - reset (rescan) USB controller\n"
714 "usb stop [f] - stop USB [f]=force stop\n"
715 "usb tree - show USB device tree\n"
716 "usb info [dev] - show available USB devices\n"
717 "usb storage - show details of USB storage devices\n"
718 "usb dev [dev] - show or set current USB storage device\n"
719 "usb part [dev] - print partition table of one or all USB storage"
721 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
722 " to memory address `addr'\n"
723 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
724 " from memory address `addr'"
729 usbboot, 3, 1, do_usbboot,
730 "boot from USB device",
738 "reset - reset (rescan) USB controller\n"
739 "usb tree - show USB device tree\n"
740 "usb info [dev] - show available USB devices"