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 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 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 void usb_display_string(struct usb_device *dev, int index)
155 if (usb_string(dev, index, &buffer[0], 256) > 0)
156 printf("String: \"%s\"", buffer);
160 void usb_display_desc(struct usb_device *dev)
162 if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
163 printf("%d: %s, USB Revision %x.%x\n", dev->devnum,
164 usb_get_class_desc(dev->config.if_desc[0].desc.bInterfaceClass),
165 (dev->descriptor.bcdUSB>>8) & 0xff,
166 dev->descriptor.bcdUSB & 0xff);
168 if (strlen(dev->mf) || strlen(dev->prod) ||
170 printf(" - %s %s %s\n", dev->mf, dev->prod,
172 if (dev->descriptor.bDeviceClass) {
173 printf(" - Class: ");
174 usb_display_class_sub(dev->descriptor.bDeviceClass,
175 dev->descriptor.bDeviceSubClass,
176 dev->descriptor.bDeviceProtocol);
179 printf(" - Class: (from Interface) %s\n",
181 dev->config.if_desc[0].desc.bInterfaceClass));
183 printf(" - PacketSize: %d Configurations: %d\n",
184 dev->descriptor.bMaxPacketSize0,
185 dev->descriptor.bNumConfigurations);
186 printf(" - Vendor: 0x%04x Product 0x%04x Version %d.%d\n",
187 dev->descriptor.idVendor, dev->descriptor.idProduct,
188 (dev->descriptor.bcdDevice>>8) & 0xff,
189 dev->descriptor.bcdDevice & 0xff);
194 void usb_display_conf_desc(struct usb_configuration_descriptor *config,
195 struct usb_device *dev)
197 printf(" Configuration: %d\n", config->bConfigurationValue);
198 printf(" - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
199 (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
200 (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
201 config->bMaxPower*2);
202 if (config->iConfiguration) {
204 usb_display_string(dev, config->iConfiguration);
209 void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
210 struct usb_device *dev)
212 printf(" Interface: %d\n", ifdesc->bInterfaceNumber);
213 printf(" - Alternate Setting %d, Endpoints: %d\n",
214 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
216 usb_display_class_sub(ifdesc->bInterfaceClass,
217 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
219 if (ifdesc->iInterface) {
221 usb_display_string(dev, ifdesc->iInterface);
226 void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
228 printf(" - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
229 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
230 switch ((epdesc->bmAttributes & 0x03)) {
235 printf("Isochronous");
244 printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
245 if ((epdesc->bmAttributes & 0x03) == 0x3)
246 printf(" Interval %dms", epdesc->bInterval);
250 /* main routine to diasplay the configs, interfaces and endpoints */
251 void usb_display_config(struct usb_device *dev)
253 struct usb_config *config;
254 struct usb_interface *ifdesc;
255 struct usb_endpoint_descriptor *epdesc;
258 config = &dev->config;
259 usb_display_conf_desc(&config->desc, dev);
260 for (i = 0; i < config->no_of_if; i++) {
261 ifdesc = &config->if_desc[i];
262 usb_display_if_desc(&ifdesc->desc, dev);
263 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
264 epdesc = &ifdesc->ep_desc[ii];
265 usb_display_ep_desc(epdesc);
271 static inline char *portspeed(int speed)
273 if (speed == USB_SPEED_HIGH)
275 else if (speed == USB_SPEED_LOW)
281 /* shows the device tree recursively */
282 void usb_show_tree_graph(struct usb_device *dev, char *pre)
285 int has_child, last_child;
289 /* check if the device has connected children */
291 for (i = 0; i < dev->maxchild; i++) {
292 if (dev->children[i] != NULL)
295 /* check if we are the last one */
297 if (dev->parent != NULL) {
298 for (i = 0; i < dev->parent->maxchild; i++) {
299 /* search for children */
300 if (dev->parent->children[i] == dev) {
301 /* 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;
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_RET_USAGE;
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 return bootm_maybe_autostart(cmdtp, argv[0]);
495 #endif /* CONFIG_USB_STORAGE */
498 /******************************************************************************
499 * usb command intepreter
501 int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
505 struct usb_device *dev = NULL;
506 extern char usb_started;
507 #ifdef CONFIG_USB_STORAGE
508 block_dev_desc_t *stor_dev;
512 return CMD_RET_USAGE;
514 if ((strncmp(argv[1], "reset", 5) == 0) ||
515 (strncmp(argv[1], "start", 5) == 0)) {
516 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
518 printf("(Re)start USB...\n");
521 #ifdef CONFIG_USB_STORAGE
522 /* try to recognize storage devices immediately */
523 usb_stor_curr_dev = usb_stor_scan(1);
525 #ifdef CONFIG_USB_HOST_ETHER
526 /* try to recognize ethernet devices immediately */
527 usb_ether_curr_dev = usb_host_eth_scan(1);
532 if (strncmp(argv[1], "stop", 4) == 0) {
533 #ifdef CONFIG_USB_KEYBOARD
535 if (usb_kbd_deregister() != 0) {
536 printf("USB not stopped: usbkbd still"
541 /* forced stop, switch console in to serial */
542 console_assign(stdin, "serial");
543 usb_kbd_deregister();
546 printf("stopping USB..\n");
551 printf("USB is stopped. Please issue 'usb start' first.\n");
554 if (strncmp(argv[1], "tree", 4) == 0) {
555 printf("\nDevice Tree:\n");
556 usb_show_tree(usb_get_dev_index(0));
559 if (strncmp(argv[1], "inf", 3) == 0) {
562 for (d = 0; d < USB_MAX_DEVICE; d++) {
563 dev = usb_get_dev_index(d);
566 usb_display_desc(dev);
567 usb_display_config(dev);
573 i = simple_strtoul(argv[2], NULL, 16);
574 printf("config for device %d\n", i);
575 for (d = 0; d < USB_MAX_DEVICE; d++) {
576 dev = usb_get_dev_index(d);
579 if (dev->devnum == i)
583 printf("*** No device available ***\n");
586 usb_display_desc(dev);
587 usb_display_config(dev);
592 #ifdef CONFIG_USB_STORAGE
593 if (strncmp(argv[1], "stor", 4) == 0)
594 return usb_stor_info();
596 if (strncmp(argv[1], "part", 4) == 0) {
599 for (devno = 0; ; ++devno) {
600 stor_dev = usb_stor_get_dev(devno);
601 if (stor_dev == NULL)
603 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
607 debug("print_part of %x\n", devno);
608 print_part(stor_dev);
612 devno = simple_strtoul(argv[2], NULL, 16);
613 stor_dev = usb_stor_get_dev(devno);
614 if (stor_dev != NULL &&
615 stor_dev->type != DEV_TYPE_UNKNOWN) {
617 debug("print_part of %x\n", devno);
618 print_part(stor_dev);
622 printf("\nno USB devices available\n");
627 if (strcmp(argv[1], "read") == 0) {
628 if (usb_stor_curr_dev < 0) {
629 printf("no current device selected\n");
633 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
634 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
635 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
637 printf("\nUSB read: device %d block # %ld, count %ld"
638 " ... ", usb_stor_curr_dev, blk, cnt);
639 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
640 n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
642 printf("%ld blocks read: %s\n", n,
643 (n == cnt) ? "OK" : "ERROR");
649 if (strcmp(argv[1], "write") == 0) {
650 if (usb_stor_curr_dev < 0) {
651 printf("no current device selected\n");
655 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
656 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
657 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
659 printf("\nUSB write: device %d block # %ld, count %ld"
660 " ... ", usb_stor_curr_dev, blk, cnt);
661 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
662 n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
664 printf("%ld blocks write: %s\n", n,
665 (n == cnt) ? "OK" : "ERROR");
671 if (strncmp(argv[1], "dev", 3) == 0) {
673 int dev = (int)simple_strtoul(argv[2], NULL, 10);
674 printf("\nUSB device %d: ", dev);
675 stor_dev = usb_stor_get_dev(dev);
676 if (stor_dev == NULL) {
677 printf("unknown device\n");
680 printf("\n Device %d: ", dev);
682 if (stor_dev->type == DEV_TYPE_UNKNOWN)
684 usb_stor_curr_dev = dev;
685 printf("... is now current device\n");
688 printf("\nUSB device %d: ", usb_stor_curr_dev);
689 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
691 if (stor_dev->type == DEV_TYPE_UNKNOWN)
697 #endif /* CONFIG_USB_STORAGE */
698 return CMD_RET_USAGE;
701 #ifdef CONFIG_USB_STORAGE
705 "start - start (scan) USB controller\n"
706 "usb reset - reset (rescan) USB controller\n"
707 "usb stop [f] - stop USB [f]=force stop\n"
708 "usb tree - show USB device tree\n"
709 "usb info [dev] - show available USB devices\n"
710 "usb storage - show details of USB storage devices\n"
711 "usb dev [dev] - show or set current USB storage device\n"
712 "usb part [dev] - print partition table of one or all USB storage"
714 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
715 " to memory address `addr'\n"
716 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
717 " from memory address `addr'"
722 usbboot, 3, 1, do_usbboot,
723 "boot from USB device",
731 "start - start (scan) USB controller\n"
732 "usb reset - reset (rescan) USB controller\n"
733 "usb tree - show USB device tree\n"
734 "usb info [dev] - show available USB devices"