Command usage cleanup
[kernel/u-boot.git] / common / cmd_usb.c
1 /*
2  * (C) Copyright 2001
3  * Denis Peter, MPL AG Switzerland
4  *
5  * Most of this source has been derived from the Linux USB
6  * project.
7  *
8  * See file CREDITS for list of people who contributed to this
9  * project.
10  *
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.
15  *
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.
20  *
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,
24  * MA 02111-1307 USA
25  *
26  */
27
28 #include <common.h>
29 #include <command.h>
30 #include <asm/byteorder.h>
31 #include <part.h>
32 #include <usb.h>
33
34 #ifdef CONFIG_USB_STORAGE
35 static int usb_stor_curr_dev = -1; /* current device */
36 #endif
37
38 /* some display routines (info command) */
39 char *usb_get_class_desc(unsigned char dclass)
40 {
41         switch (dclass) {
42         case USB_CLASS_PER_INTERFACE:
43                 return "See Interface";
44         case USB_CLASS_AUDIO:
45                 return "Audio";
46         case USB_CLASS_COMM:
47                 return "Communication";
48         case USB_CLASS_HID:
49                 return "Human Interface";
50         case USB_CLASS_PRINTER:
51                 return "Printer";
52         case USB_CLASS_MASS_STORAGE:
53                 return "Mass Storage";
54         case USB_CLASS_HUB:
55                 return "Hub";
56         case USB_CLASS_DATA:
57                 return "CDC Data";
58         case USB_CLASS_VENDOR_SPEC:
59                 return "Vendor specific";
60         default:
61                 return "";
62         }
63 }
64
65 void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
66                            unsigned char proto)
67 {
68         switch (dclass) {
69         case USB_CLASS_PER_INTERFACE:
70                 printf("See Interface");
71                 break;
72         case USB_CLASS_HID:
73                 printf("Human Interface, Subclass: ");
74                 switch (subclass) {
75                 case USB_SUB_HID_NONE:
76                         printf("None");
77                         break;
78                 case USB_SUB_HID_BOOT:
79                         printf("Boot ");
80                         switch (proto) {
81                         case USB_PROT_HID_NONE:
82                                 printf("None");
83                                 break;
84                         case USB_PROT_HID_KEYBOARD:
85                                 printf("Keyboard");
86                                 break;
87                         case USB_PROT_HID_MOUSE:
88                                 printf("Mouse");
89                                 break;
90                         default:
91                                 printf("reserved");
92                                 break;
93                         }
94                         break;
95                 default:
96                         printf("reserved");
97                         break;
98                 }
99                 break;
100         case USB_CLASS_MASS_STORAGE:
101                 printf("Mass Storage, ");
102                 switch (subclass) {
103                 case US_SC_RBC:
104                         printf("RBC ");
105                         break;
106                 case US_SC_8020:
107                         printf("SFF-8020i (ATAPI)");
108                         break;
109                 case US_SC_QIC:
110                         printf("QIC-157 (Tape)");
111                         break;
112                 case US_SC_UFI:
113                         printf("UFI");
114                         break;
115                 case US_SC_8070:
116                         printf("SFF-8070");
117                         break;
118                 case US_SC_SCSI:
119                         printf("Transp. SCSI");
120                         break;
121                 default:
122                         printf("reserved");
123                         break;
124                 }
125                 printf(", ");
126                 switch (proto) {
127                 case US_PR_CB:
128                         printf("Command/Bulk");
129                         break;
130                 case US_PR_CBI:
131                         printf("Command/Bulk/Int");
132                         break;
133                 case US_PR_BULK:
134                         printf("Bulk only");
135                         break;
136                 default:
137                         printf("reserved");
138                         break;
139                 }
140                 break;
141         default:
142                 printf("%s", usb_get_class_desc(dclass));
143                 break;
144         }
145 }
146
147 void usb_display_string(struct usb_device *dev, int index)
148 {
149         char buffer[256];
150         if (index != 0) {
151                 if (usb_string(dev, index, &buffer[0], 256) > 0)
152                         printf("String: \"%s\"", buffer);
153         }
154 }
155
156 void usb_display_desc(struct usb_device *dev)
157 {
158         if (dev->descriptor.bDescriptorType == USB_DT_DEVICE) {
159                 printf("%d: %s,  USB Revision %x.%x\n", dev->devnum,
160                 usb_get_class_desc(dev->config.if_desc[0].bInterfaceClass),
161                                    (dev->descriptor.bcdUSB>>8) & 0xff,
162                                    dev->descriptor.bcdUSB & 0xff);
163
164                 if (strlen(dev->mf) || strlen(dev->prod) ||
165                     strlen(dev->serial))
166                         printf(" - %s %s %s\n", dev->mf, dev->prod,
167                                 dev->serial);
168                 if (dev->descriptor.bDeviceClass) {
169                         printf(" - Class: ");
170                         usb_display_class_sub(dev->descriptor.bDeviceClass,
171                                               dev->descriptor.bDeviceSubClass,
172                                               dev->descriptor.bDeviceProtocol);
173                         printf("\n");
174                 } else {
175                         printf(" - Class: (from Interface) %s\n",
176                                usb_get_class_desc(
177                                 dev->config.if_desc[0].bInterfaceClass));
178                 }
179                 printf(" - PacketSize: %d  Configurations: %d\n",
180                         dev->descriptor.bMaxPacketSize0,
181                         dev->descriptor.bNumConfigurations);
182                 printf(" - Vendor: 0x%04x  Product 0x%04x Version %d.%d\n",
183                         dev->descriptor.idVendor, dev->descriptor.idProduct,
184                         (dev->descriptor.bcdDevice>>8) & 0xff,
185                         dev->descriptor.bcdDevice & 0xff);
186         }
187
188 }
189
190 void usb_display_conf_desc(struct usb_config_descriptor *config,
191                            struct usb_device *dev)
192 {
193         printf("   Configuration: %d\n", config->bConfigurationValue);
194         printf("   - Interfaces: %d %s%s%dmA\n", config->bNumInterfaces,
195                (config->bmAttributes & 0x40) ? "Self Powered " : "Bus Powered ",
196                (config->bmAttributes & 0x20) ? "Remote Wakeup " : "",
197                 config->MaxPower*2);
198         if (config->iConfiguration) {
199                 printf("   - ");
200                 usb_display_string(dev, config->iConfiguration);
201                 printf("\n");
202         }
203 }
204
205 void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
206                          struct usb_device *dev)
207 {
208         printf("     Interface: %d\n", ifdesc->bInterfaceNumber);
209         printf("     - Alternate Setting %d, Endpoints: %d\n",
210                 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
211         printf("     - Class ");
212         usb_display_class_sub(ifdesc->bInterfaceClass,
213                 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
214         printf("\n");
215         if (ifdesc->iInterface) {
216                 printf("     - ");
217                 usb_display_string(dev, ifdesc->iInterface);
218                 printf("\n");
219         }
220 }
221
222 void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
223 {
224         printf("     - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
225                 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
226         switch ((epdesc->bmAttributes & 0x03)) {
227         case 0:
228                 printf("Control");
229                 break;
230         case 1:
231                 printf("Isochronous");
232                 break;
233         case 2:
234                 printf("Bulk");
235                 break;
236         case 3:
237                 printf("Interrupt");
238                 break;
239         }
240         printf(" MaxPacket %d", epdesc->wMaxPacketSize);
241         if ((epdesc->bmAttributes & 0x03) == 0x3)
242                 printf(" Interval %dms", epdesc->bInterval);
243         printf("\n");
244 }
245
246 /* main routine to diasplay the configs, interfaces and endpoints */
247 void usb_display_config(struct usb_device *dev)
248 {
249         struct usb_config_descriptor *config;
250         struct usb_interface_descriptor *ifdesc;
251         struct usb_endpoint_descriptor *epdesc;
252         int i, ii;
253
254         config = &dev->config;
255         usb_display_conf_desc(config, dev);
256         for (i = 0; i < config->no_of_if; i++) {
257                 ifdesc = &config->if_desc[i];
258                 usb_display_if_desc(ifdesc, dev);
259                 for (ii = 0; ii < ifdesc->no_of_ep; ii++) {
260                         epdesc = &ifdesc->ep_desc[ii];
261                         usb_display_ep_desc(epdesc);
262                 }
263         }
264         printf("\n");
265 }
266
267 /* shows the device tree recursively */
268 void usb_show_tree_graph(struct usb_device *dev, char *pre)
269 {
270         int i, index;
271         int has_child, last_child, port;
272
273         index = strlen(pre);
274         printf(" %s", pre);
275         /* check if the device has connected children */
276         has_child = 0;
277         for (i = 0; i < dev->maxchild; i++) {
278                 if (dev->children[i] != NULL)
279                         has_child = 1;
280         }
281         /* check if we are the last one */
282         last_child = 1;
283         if (dev->parent != NULL) {
284                 for (i = 0; i < dev->parent->maxchild; i++) {
285                         /* search for children */
286                         if (dev->parent->children[i] == dev) {
287                                 /* found our pointer, see if we have a
288                                  * little sister
289                                  */
290                                 port = i;
291                                 while (i++ < dev->parent->maxchild) {
292                                         if (dev->parent->children[i] != NULL) {
293                                                 /* found a sister */
294                                                 last_child = 0;
295                                                 break;
296                                         } /* if */
297                                 } /* while */
298                         } /* device found */
299                 } /* for all children of the parent */
300                 printf("\b+-");
301                 /* correct last child */
302                 if (last_child)
303                         pre[index-1] = ' ';
304         } /* if not root hub */
305         else
306                 printf(" ");
307         printf("%d ", dev->devnum);
308         pre[index++] = ' ';
309         pre[index++] = has_child ? '|' : ' ';
310         pre[index] = 0;
311         printf(" %s (%s, %dmA)\n", usb_get_class_desc(
312                                         dev->config.if_desc[0].bInterfaceClass),
313                                         dev->slow ? "1.5MBit/s" : "12MBit/s",
314                                         dev->config.MaxPower * 2);
315         if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
316                 printf(" %s  %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
317         printf(" %s\n", pre);
318         if (dev->maxchild > 0) {
319                 for (i = 0; i < dev->maxchild; i++) {
320                         if (dev->children[i] != NULL) {
321                                 usb_show_tree_graph(dev->children[i], pre);
322                                 pre[index] = 0;
323                         }
324                 }
325         }
326 }
327
328 /* main routine for the tree command */
329 void usb_show_tree(struct usb_device *dev)
330 {
331         char preamble[32];
332
333         memset(preamble, 0, 32);
334         usb_show_tree_graph(dev, &preamble[0]);
335 }
336
337
338 /******************************************************************************
339  * usb boot command intepreter. Derived from diskboot
340  */
341 #ifdef CONFIG_USB_STORAGE
342 int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
343 {
344         char *boot_device = NULL;
345         char *ep;
346         int dev, part = 1, rcode;
347         ulong addr, cnt;
348         disk_partition_t info;
349         image_header_t *hdr;
350         block_dev_desc_t *stor_dev;
351 #if defined(CONFIG_FIT)
352         const void *fit_hdr = NULL;
353 #endif
354
355         switch (argc) {
356         case 1:
357                 addr = CONFIG_SYS_LOAD_ADDR;
358                 boot_device = getenv("bootdevice");
359                 break;
360         case 2:
361                 addr = simple_strtoul(argv[1], NULL, 16);
362                 boot_device = getenv("bootdevice");
363                 break;
364         case 3:
365                 addr = simple_strtoul(argv[1], NULL, 16);
366                 boot_device = argv[2];
367                 break;
368         default:
369                 cmd_usage(cmdtp);
370                 return 1;
371         }
372
373         if (!boot_device) {
374                 puts("\n** No boot device **\n");
375                 return 1;
376         }
377
378         dev = simple_strtoul(boot_device, &ep, 16);
379         stor_dev = usb_stor_get_dev(dev);
380         if (stor_dev->type == DEV_TYPE_UNKNOWN) {
381                 printf("\n** Device %d not available\n", dev);
382                 return 1;
383         }
384         if (stor_dev->block_read == NULL) {
385                 printf("storage device not initialized. Use usb scan\n");
386                 return 1;
387         }
388         if (*ep) {
389                 if (*ep != ':') {
390                         puts("\n** Invalid boot device, use `dev[:part]' **\n");
391                         return 1;
392                 }
393                 part = simple_strtoul(++ep, NULL, 16);
394         }
395
396         if (get_partition_info(stor_dev, part, &info)) {
397                 /* try to boot raw .... */
398                 strncpy((char *)&info.type[0], BOOT_PART_TYPE,
399                         sizeof(BOOT_PART_TYPE));
400                 strncpy((char *)&info.name[0], "Raw", 4);
401                 info.start = 0;
402                 info.blksz = 0x200;
403                 info.size = 2880;
404                 printf("error reading partinfo...try to boot raw\n");
405         }
406         if ((strncmp((char *)info.type, BOOT_PART_TYPE,
407             sizeof(info.type)) != 0) &&
408             (strncmp((char *)info.type, BOOT_PART_COMP,
409             sizeof(info.type)) != 0)) {
410                 printf("\n** Invalid partition type \"%.32s\""
411                         " (expect \"" BOOT_PART_TYPE "\")\n",
412                         info.type);
413                 return 1;
414         }
415         printf("\nLoading from USB device %d, partition %d: "
416                 "Name: %.32s  Type: %.32s\n",
417                 dev, part, info.name, info.type);
418
419         debug("First Block: %ld,  # of blocks: %ld, Block Size: %ld\n",
420                 info.start, info.size, info.blksz);
421
422         if (stor_dev->block_read(dev, info.start, 1, (ulong *)addr) != 1) {
423                 printf("** Read error on %d:%d\n", dev, part);
424                 return 1;
425         }
426
427         switch (genimg_get_format((void *)addr)) {
428         case IMAGE_FORMAT_LEGACY:
429                 hdr = (image_header_t *)addr;
430
431                 if (!image_check_hcrc(hdr)) {
432                         puts("\n** Bad Header Checksum **\n");
433                         return 1;
434                 }
435
436                 image_print_contents(hdr);
437
438                 cnt = image_get_image_size(hdr);
439                 break;
440 #if defined(CONFIG_FIT)
441         case IMAGE_FORMAT_FIT:
442                 fit_hdr = (const void *)addr;
443                 puts("Fit image detected...\n");
444
445                 cnt = fit_get_size(fit_hdr);
446                 break;
447 #endif
448         default:
449                 puts("** Unknown image type\n");
450                 return 1;
451         }
452
453         cnt += info.blksz - 1;
454         cnt /= info.blksz;
455         cnt -= 1;
456
457         if (stor_dev->block_read(dev, info.start+1, cnt,
458                       (ulong *)(addr+info.blksz)) != cnt) {
459                 printf("\n** Read error on %d:%d\n", dev, part);
460                 return 1;
461         }
462
463 #if defined(CONFIG_FIT)
464         /* This cannot be done earlier, we need complete FIT image in RAM
465          * first
466          */
467         if (genimg_get_format((void *)addr) == IMAGE_FORMAT_FIT) {
468                 if (!fit_check_format(fit_hdr)) {
469                         puts("** Bad FIT image format\n");
470                         return 1;
471                 }
472                 fit_print_contents(fit_hdr);
473         }
474 #endif
475
476         /* Loading ok, update default load address */
477         load_addr = addr;
478
479         flush_cache(addr, (cnt+1)*info.blksz);
480
481         /* Check if we should attempt an auto-start */
482         if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
483                 char *local_args[2];
484                 extern int do_bootm(cmd_tbl_t *, int, int, char *[]);
485                 local_args[0] = argv[0];
486                 local_args[1] = NULL;
487                 printf("Automatic boot of image at addr 0x%08lX ...\n", addr);
488                 rcode = do_bootm(cmdtp, 0, 1, local_args);
489                 return rcode;
490         }
491         return 0;
492 }
493 #endif /* CONFIG_USB_STORAGE */
494
495
496 /******************************************************************************
497  * usb command intepreter
498  */
499 int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
500 {
501
502         int i;
503         struct usb_device *dev = NULL;
504         extern char usb_started;
505 #ifdef CONFIG_USB_STORAGE
506         block_dev_desc_t *stor_dev;
507 #endif
508
509         if ((strncmp(argv[1], "reset", 5) == 0) ||
510                  (strncmp(argv[1], "start", 5) == 0)) {
511                 usb_stop();
512                 printf("(Re)start USB...\n");
513                 i = usb_init();
514 #ifdef CONFIG_USB_STORAGE
515                 /* try to recognize storage devices immediately */
516                 if (i >= 0)
517                         usb_stor_curr_dev = usb_stor_scan(1);
518 #endif
519                 return 0;
520         }
521         if (strncmp(argv[1], "stop", 4) == 0) {
522 #ifdef CONFIG_USB_KEYBOARD
523                 if (argc == 2) {
524                         if (usb_kbd_deregister() != 0) {
525                                 printf("USB not stopped: usbkbd still"
526                                         " using USB\n");
527                                 return 1;
528                         }
529                 } else {
530                         /* forced stop, switch console in to serial */
531                         console_assign(stdin, "serial");
532                         usb_kbd_deregister();
533                 }
534 #endif
535                 printf("stopping USB..\n");
536                 usb_stop();
537                 return 0;
538         }
539         if (!usb_started) {
540                 printf("USB is stopped. Please issue 'usb start' first.\n");
541                 return 1;
542         }
543         if (strncmp(argv[1], "tree", 4) == 0) {
544                 printf("\nDevice Tree:\n");
545                 usb_show_tree(usb_get_dev_index(0));
546                 return 0;
547         }
548         if (strncmp(argv[1], "inf", 3) == 0) {
549                 int d;
550                 if (argc == 2) {
551                         for (d = 0; d < USB_MAX_DEVICE; d++) {
552                                 dev = usb_get_dev_index(d);
553                                 if (dev == NULL)
554                                         break;
555                                 usb_display_desc(dev);
556                                 usb_display_config(dev);
557                         }
558                         return 0;
559                 } else {
560                         int d;
561
562                         i = simple_strtoul(argv[2], NULL, 16);
563                         printf("config for device %d\n", i);
564                         for (d = 0; d < USB_MAX_DEVICE; d++) {
565                                 dev = usb_get_dev_index(d);
566                                 if (dev == NULL)
567                                         break;
568                                 if (dev->devnum == i)
569                                         break;
570                         }
571                         if (dev == NULL) {
572                                 printf("*** NO Device avaiable ***\n");
573                                 return 0;
574                         } else {
575                                 usb_display_desc(dev);
576                                 usb_display_config(dev);
577                         }
578                 }
579                 return 0;
580         }
581 #ifdef CONFIG_USB_STORAGE
582         if (strncmp(argv[1], "stor", 4) == 0)
583                 return usb_stor_info();
584
585         if (strncmp(argv[1], "part", 4) == 0) {
586                 int devno, ok = 0;
587                 if (argc == 2) {
588                         for (devno = 0; devno < USB_MAX_STOR_DEV; ++devno) {
589                                 stor_dev = usb_stor_get_dev(devno);
590                                 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
591                                         ok++;
592                                         if (devno)
593                                                 printf("\n");
594                                         printf("print_part of %x\n", devno);
595                                         print_part(stor_dev);
596                                 }
597                         }
598                 } else {
599                         devno = simple_strtoul(argv[2], NULL, 16);
600                         stor_dev = usb_stor_get_dev(devno);
601                         if (stor_dev->type != DEV_TYPE_UNKNOWN) {
602                                 ok++;
603                                 printf("print_part of %x\n", devno);
604                                 print_part(stor_dev);
605                         }
606                 }
607                 if (!ok) {
608                         printf("\nno USB devices available\n");
609                         return 1;
610                 }
611                 return 0;
612         }
613         if (strcmp(argv[1], "read") == 0) {
614                 if (usb_stor_curr_dev < 0) {
615                         printf("no current device selected\n");
616                         return 1;
617                 }
618                 if (argc == 5) {
619                         unsigned long addr = simple_strtoul(argv[2], NULL, 16);
620                         unsigned long blk  = simple_strtoul(argv[3], NULL, 16);
621                         unsigned long cnt  = simple_strtoul(argv[4], NULL, 16);
622                         unsigned long n;
623                         printf("\nUSB read: device %d block # %ld, count %ld"
624                                 " ... ", usb_stor_curr_dev, blk, cnt);
625                         stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
626                         n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
627                                                  (ulong *)addr);
628                         printf("%ld blocks read: %s\n", n,
629                                 (n == cnt) ? "OK" : "ERROR");
630                         if (n == cnt)
631                                 return 0;
632                         return 1;
633                 }
634         }
635         if (strncmp(argv[1], "dev", 3) == 0) {
636                 if (argc == 3) {
637                         int dev = (int)simple_strtoul(argv[2], NULL, 10);
638                         printf("\nUSB device %d: ", dev);
639                         if (dev >= USB_MAX_STOR_DEV) {
640                                 printf("unknown device\n");
641                                 return 1;
642                         }
643                         printf("\n    Device %d: ", dev);
644                         stor_dev = usb_stor_get_dev(dev);
645                         dev_print(stor_dev);
646                         if (stor_dev->type == DEV_TYPE_UNKNOWN)
647                                 return 1;
648                         usb_stor_curr_dev = dev;
649                         printf("... is now current device\n");
650                         return 0;
651                 } else {
652                         printf("\nUSB device %d: ", usb_stor_curr_dev);
653                         stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
654                         dev_print(stor_dev);
655                         if (stor_dev->type == DEV_TYPE_UNKNOWN)
656                                 return 1;
657                         return 0;
658                 }
659                 return 0;
660         }
661 #endif /* CONFIG_USB_STORAGE */
662         cmd_usage(cmdtp);
663         return 1;
664 }
665
666 #ifdef CONFIG_USB_STORAGE
667 U_BOOT_CMD(
668         usb,    5,      1,      do_usb,
669         "USB sub-system",
670         "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 storage  - show details of USB storage devices\n"
675         "usb dev [dev] - show or set current USB storage device\n"
676         "usb part [dev] - print partition table of one or all USB storage"
677         " devices\n"
678         "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
679         "    to memory address `addr'\n"
680 );
681
682
683 U_BOOT_CMD(
684         usbboot,        3,      1,      do_usbboot,
685         "boot from USB device",
686         "loadAddr dev:part\n"
687 );
688
689 #else
690 U_BOOT_CMD(
691         usb,    5,      1,      do_usb,
692         "USB sub-system",
693         "reset - reset (rescan) USB controller\n"
694         "usb  tree  - show USB device tree\n"
695         "usb  info [dev] - show available USB devices\n"
696 );
697 #endif