Merge branch 'master' of git://git.denx.de/u-boot-net
[platform/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 <asm/unaligned.h>
32 #include <part.h>
33 #include <usb.h>
34
35 #ifdef CONFIG_USB_STORAGE
36 static int usb_stor_curr_dev = -1; /* current device */
37 #endif
38 #ifdef CONFIG_USB_HOST_ETHER
39 static int usb_ether_curr_dev = -1; /* current ethernet device */
40 #endif
41
42 /* some display routines (info command) */
43 char *usb_get_class_desc(unsigned char dclass)
44 {
45         switch (dclass) {
46         case USB_CLASS_PER_INTERFACE:
47                 return "See Interface";
48         case USB_CLASS_AUDIO:
49                 return "Audio";
50         case USB_CLASS_COMM:
51                 return "Communication";
52         case USB_CLASS_HID:
53                 return "Human Interface";
54         case USB_CLASS_PRINTER:
55                 return "Printer";
56         case USB_CLASS_MASS_STORAGE:
57                 return "Mass Storage";
58         case USB_CLASS_HUB:
59                 return "Hub";
60         case USB_CLASS_DATA:
61                 return "CDC Data";
62         case USB_CLASS_VENDOR_SPEC:
63                 return "Vendor specific";
64         default:
65                 return "";
66         }
67 }
68
69 void usb_display_class_sub(unsigned char dclass, unsigned char subclass,
70                            unsigned char proto)
71 {
72         switch (dclass) {
73         case USB_CLASS_PER_INTERFACE:
74                 printf("See Interface");
75                 break;
76         case USB_CLASS_HID:
77                 printf("Human Interface, Subclass: ");
78                 switch (subclass) {
79                 case USB_SUB_HID_NONE:
80                         printf("None");
81                         break;
82                 case USB_SUB_HID_BOOT:
83                         printf("Boot ");
84                         switch (proto) {
85                         case USB_PROT_HID_NONE:
86                                 printf("None");
87                                 break;
88                         case USB_PROT_HID_KEYBOARD:
89                                 printf("Keyboard");
90                                 break;
91                         case USB_PROT_HID_MOUSE:
92                                 printf("Mouse");
93                                 break;
94                         default:
95                                 printf("reserved");
96                                 break;
97                         }
98                         break;
99                 default:
100                         printf("reserved");
101                         break;
102                 }
103                 break;
104         case USB_CLASS_MASS_STORAGE:
105                 printf("Mass Storage, ");
106                 switch (subclass) {
107                 case US_SC_RBC:
108                         printf("RBC ");
109                         break;
110                 case US_SC_8020:
111                         printf("SFF-8020i (ATAPI)");
112                         break;
113                 case US_SC_QIC:
114                         printf("QIC-157 (Tape)");
115                         break;
116                 case US_SC_UFI:
117                         printf("UFI");
118                         break;
119                 case US_SC_8070:
120                         printf("SFF-8070");
121                         break;
122                 case US_SC_SCSI:
123                         printf("Transp. SCSI");
124                         break;
125                 default:
126                         printf("reserved");
127                         break;
128                 }
129                 printf(", ");
130                 switch (proto) {
131                 case US_PR_CB:
132                         printf("Command/Bulk");
133                         break;
134                 case US_PR_CBI:
135                         printf("Command/Bulk/Int");
136                         break;
137                 case US_PR_BULK:
138                         printf("Bulk only");
139                         break;
140                 default:
141                         printf("reserved");
142                         break;
143                 }
144                 break;
145         default:
146                 printf("%s", usb_get_class_desc(dclass));
147                 break;
148         }
149 }
150
151 void usb_display_string(struct usb_device *dev, int index)
152 {
153         ALLOC_CACHE_ALIGN_BUFFER(char, buffer, 256);
154
155         if (index != 0) {
156                 if (usb_string(dev, index, &buffer[0], 256) > 0)
157                         printf("String: \"%s\"", buffer);
158         }
159 }
160
161 void usb_display_desc(struct usb_device *dev)
162 {
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);
168
169                 if (strlen(dev->mf) || strlen(dev->prod) ||
170                     strlen(dev->serial))
171                         printf(" - %s %s %s\n", dev->mf, dev->prod,
172                                 dev->serial);
173                 if (dev->descriptor.bDeviceClass) {
174                         printf(" - Class: ");
175                         usb_display_class_sub(dev->descriptor.bDeviceClass,
176                                               dev->descriptor.bDeviceSubClass,
177                                               dev->descriptor.bDeviceProtocol);
178                         printf("\n");
179                 } else {
180                         printf(" - Class: (from Interface) %s\n",
181                                usb_get_class_desc(
182                                 dev->config.if_desc[0].desc.bInterfaceClass));
183                 }
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);
191         }
192
193 }
194
195 void usb_display_conf_desc(struct usb_configuration_descriptor *config,
196                            struct usb_device *dev)
197 {
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) {
204                 printf("   - ");
205                 usb_display_string(dev, config->iConfiguration);
206                 printf("\n");
207         }
208 }
209
210 void usb_display_if_desc(struct usb_interface_descriptor *ifdesc,
211                          struct usb_device *dev)
212 {
213         printf("     Interface: %d\n", ifdesc->bInterfaceNumber);
214         printf("     - Alternate Setting %d, Endpoints: %d\n",
215                 ifdesc->bAlternateSetting, ifdesc->bNumEndpoints);
216         printf("     - Class ");
217         usb_display_class_sub(ifdesc->bInterfaceClass,
218                 ifdesc->bInterfaceSubClass, ifdesc->bInterfaceProtocol);
219         printf("\n");
220         if (ifdesc->iInterface) {
221                 printf("     - ");
222                 usb_display_string(dev, ifdesc->iInterface);
223                 printf("\n");
224         }
225 }
226
227 void usb_display_ep_desc(struct usb_endpoint_descriptor *epdesc)
228 {
229         printf("     - Endpoint %d %s ", epdesc->bEndpointAddress & 0xf,
230                 (epdesc->bEndpointAddress & 0x80) ? "In" : "Out");
231         switch ((epdesc->bmAttributes & 0x03)) {
232         case 0:
233                 printf("Control");
234                 break;
235         case 1:
236                 printf("Isochronous");
237                 break;
238         case 2:
239                 printf("Bulk");
240                 break;
241         case 3:
242                 printf("Interrupt");
243                 break;
244         }
245         printf(" MaxPacket %d", get_unaligned(&epdesc->wMaxPacketSize));
246         if ((epdesc->bmAttributes & 0x03) == 0x3)
247                 printf(" Interval %dms", epdesc->bInterval);
248         printf("\n");
249 }
250
251 /* main routine to diasplay the configs, interfaces and endpoints */
252 void usb_display_config(struct usb_device *dev)
253 {
254         struct usb_config *config;
255         struct usb_interface *ifdesc;
256         struct usb_endpoint_descriptor *epdesc;
257         int i, ii;
258
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);
267                 }
268         }
269         printf("\n");
270 }
271
272 static inline char *portspeed(int speed)
273 {
274         if (speed == USB_SPEED_HIGH)
275                 return "480 Mb/s";
276         else if (speed == USB_SPEED_LOW)
277                 return "1.5 Mb/s";
278         else
279                 return "12 Mb/s";
280 }
281
282 /* shows the device tree recursively */
283 void usb_show_tree_graph(struct usb_device *dev, char *pre)
284 {
285         int i, index;
286         int has_child, last_child;
287
288         index = strlen(pre);
289         printf(" %s", pre);
290         /* check if the device has connected children */
291         has_child = 0;
292         for (i = 0; i < dev->maxchild; i++) {
293                 if (dev->children[i] != NULL)
294                         has_child = 1;
295         }
296         /* check if we are the last one */
297         last_child = 1;
298         if (dev->parent != NULL) {
299                 for (i = 0; i < dev->parent->maxchild; i++) {
300                         /* search for children */
301                         if (dev->parent->children[i] == dev) {
302                                 /* found our pointer, see if we have a
303                                  * little sister
304                                  */
305                                 while (i++ < dev->parent->maxchild) {
306                                         if (dev->parent->children[i] != NULL) {
307                                                 /* found a sister */
308                                                 last_child = 0;
309                                                 break;
310                                         } /* if */
311                                 } /* while */
312                         } /* device found */
313                 } /* for all children of the parent */
314                 printf("\b+-");
315                 /* correct last child */
316                 if (last_child)
317                         pre[index-1] = ' ';
318         } /* if not root hub */
319         else
320                 printf(" ");
321         printf("%d ", dev->devnum);
322         pre[index++] = ' ';
323         pre[index++] = has_child ? '|' : ' ';
324         pre[index] = 0;
325         printf(" %s (%s, %dmA)\n", usb_get_class_desc(
326                                         dev->config.if_desc[0].desc.bInterfaceClass),
327                                         portspeed(dev->speed),
328                                         dev->config.desc.bMaxPower * 2);
329         if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
330                 printf(" %s  %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
331         printf(" %s\n", pre);
332         if (dev->maxchild > 0) {
333                 for (i = 0; i < dev->maxchild; i++) {
334                         if (dev->children[i] != NULL) {
335                                 usb_show_tree_graph(dev->children[i], pre);
336                                 pre[index] = 0;
337                         }
338                 }
339         }
340 }
341
342 /* main routine for the tree command */
343 void usb_show_tree(struct usb_device *dev)
344 {
345         char preamble[32];
346
347         memset(preamble, 0, 32);
348         usb_show_tree_graph(dev, &preamble[0]);
349 }
350
351
352 /******************************************************************************
353  * usb boot command intepreter. Derived from diskboot
354  */
355 #ifdef CONFIG_USB_STORAGE
356 int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
357 {
358         return common_diskboot(cmdtp, "usb", argc, argv);
359 }
360 #endif /* CONFIG_USB_STORAGE */
361
362
363 /******************************************************************************
364  * usb command intepreter
365  */
366 int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
367 {
368
369         int i;
370         struct usb_device *dev = NULL;
371         extern char usb_started;
372 #ifdef CONFIG_USB_STORAGE
373         block_dev_desc_t *stor_dev;
374 #endif
375
376         if (argc < 2)
377                 return CMD_RET_USAGE;
378
379         if ((strncmp(argv[1], "reset", 5) == 0) ||
380                  (strncmp(argv[1], "start", 5) == 0)) {
381                 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
382                 usb_stop();
383                 printf("(Re)start USB...\n");
384                 i = usb_init();
385                 if (i >= 0) {
386 #ifdef CONFIG_USB_STORAGE
387                         /* try to recognize storage devices immediately */
388                         usb_stor_curr_dev = usb_stor_scan(1);
389 #endif
390 #ifdef CONFIG_USB_HOST_ETHER
391                         /* try to recognize ethernet devices immediately */
392                         usb_ether_curr_dev = usb_host_eth_scan(1);
393 #endif
394                 }
395                 return 0;
396         }
397         if (strncmp(argv[1], "stop", 4) == 0) {
398 #ifdef CONFIG_USB_KEYBOARD
399                 if (argc == 2) {
400                         if (usb_kbd_deregister() != 0) {
401                                 printf("USB not stopped: usbkbd still"
402                                         " using USB\n");
403                                 return 1;
404                         }
405                 } else {
406                         /* forced stop, switch console in to serial */
407                         console_assign(stdin, "serial");
408                         usb_kbd_deregister();
409                 }
410 #endif
411                 printf("stopping USB..\n");
412                 usb_stop();
413                 return 0;
414         }
415         if (!usb_started) {
416                 printf("USB is stopped. Please issue 'usb start' first.\n");
417                 return 1;
418         }
419         if (strncmp(argv[1], "tree", 4) == 0) {
420                 printf("\nDevice Tree:\n");
421                 usb_show_tree(usb_get_dev_index(0));
422                 return 0;
423         }
424         if (strncmp(argv[1], "inf", 3) == 0) {
425                 int d;
426                 if (argc == 2) {
427                         for (d = 0; d < USB_MAX_DEVICE; d++) {
428                                 dev = usb_get_dev_index(d);
429                                 if (dev == NULL)
430                                         break;
431                                 usb_display_desc(dev);
432                                 usb_display_config(dev);
433                         }
434                         return 0;
435                 } else {
436                         int d;
437
438                         i = simple_strtoul(argv[2], NULL, 16);
439                         printf("config for device %d\n", i);
440                         for (d = 0; d < USB_MAX_DEVICE; d++) {
441                                 dev = usb_get_dev_index(d);
442                                 if (dev == NULL)
443                                         break;
444                                 if (dev->devnum == i)
445                                         break;
446                         }
447                         if (dev == NULL) {
448                                 printf("*** No device available ***\n");
449                                 return 0;
450                         } else {
451                                 usb_display_desc(dev);
452                                 usb_display_config(dev);
453                         }
454                 }
455                 return 0;
456         }
457 #ifdef CONFIG_USB_STORAGE
458         if (strncmp(argv[1], "stor", 4) == 0)
459                 return usb_stor_info();
460
461         if (strncmp(argv[1], "part", 4) == 0) {
462                 int devno, ok = 0;
463                 if (argc == 2) {
464                         for (devno = 0; ; ++devno) {
465                                 stor_dev = usb_stor_get_dev(devno);
466                                 if (stor_dev == NULL)
467                                         break;
468                                 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
469                                         ok++;
470                                         if (devno)
471                                                 printf("\n");
472                                         debug("print_part of %x\n", devno);
473                                         print_part(stor_dev);
474                                 }
475                         }
476                 } else {
477                         devno = simple_strtoul(argv[2], NULL, 16);
478                         stor_dev = usb_stor_get_dev(devno);
479                         if (stor_dev != NULL &&
480                             stor_dev->type != DEV_TYPE_UNKNOWN) {
481                                 ok++;
482                                 debug("print_part of %x\n", devno);
483                                 print_part(stor_dev);
484                         }
485                 }
486                 if (!ok) {
487                         printf("\nno USB devices available\n");
488                         return 1;
489                 }
490                 return 0;
491         }
492         if (strcmp(argv[1], "read") == 0) {
493                 if (usb_stor_curr_dev < 0) {
494                         printf("no current device selected\n");
495                         return 1;
496                 }
497                 if (argc == 5) {
498                         unsigned long addr = simple_strtoul(argv[2], NULL, 16);
499                         unsigned long blk  = simple_strtoul(argv[3], NULL, 16);
500                         unsigned long cnt  = simple_strtoul(argv[4], NULL, 16);
501                         unsigned long n;
502                         printf("\nUSB read: device %d block # %ld, count %ld"
503                                 " ... ", usb_stor_curr_dev, blk, cnt);
504                         stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
505                         n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
506                                                  (ulong *)addr);
507                         printf("%ld blocks read: %s\n", n,
508                                 (n == cnt) ? "OK" : "ERROR");
509                         if (n == cnt)
510                                 return 0;
511                         return 1;
512                 }
513         }
514         if (strcmp(argv[1], "write") == 0) {
515                 if (usb_stor_curr_dev < 0) {
516                         printf("no current device selected\n");
517                         return 1;
518                 }
519                 if (argc == 5) {
520                         unsigned long addr = simple_strtoul(argv[2], NULL, 16);
521                         unsigned long blk  = simple_strtoul(argv[3], NULL, 16);
522                         unsigned long cnt  = simple_strtoul(argv[4], NULL, 16);
523                         unsigned long n;
524                         printf("\nUSB write: device %d block # %ld, count %ld"
525                                 " ... ", usb_stor_curr_dev, blk, cnt);
526                         stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
527                         n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
528                                                 (ulong *)addr);
529                         printf("%ld blocks write: %s\n", n,
530                                 (n == cnt) ? "OK" : "ERROR");
531                         if (n == cnt)
532                                 return 0;
533                         return 1;
534                 }
535         }
536         if (strncmp(argv[1], "dev", 3) == 0) {
537                 if (argc == 3) {
538                         int dev = (int)simple_strtoul(argv[2], NULL, 10);
539                         printf("\nUSB device %d: ", dev);
540                         stor_dev = usb_stor_get_dev(dev);
541                         if (stor_dev == NULL) {
542                                 printf("unknown device\n");
543                                 return 1;
544                         }
545                         printf("\n    Device %d: ", dev);
546                         dev_print(stor_dev);
547                         if (stor_dev->type == DEV_TYPE_UNKNOWN)
548                                 return 1;
549                         usb_stor_curr_dev = dev;
550                         printf("... is now current device\n");
551                         return 0;
552                 } else {
553                         printf("\nUSB device %d: ", usb_stor_curr_dev);
554                         stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
555                         dev_print(stor_dev);
556                         if (stor_dev->type == DEV_TYPE_UNKNOWN)
557                                 return 1;
558                         return 0;
559                 }
560                 return 0;
561         }
562 #endif /* CONFIG_USB_STORAGE */
563         return CMD_RET_USAGE;
564 }
565
566 #ifdef CONFIG_USB_STORAGE
567 U_BOOT_CMD(
568         usb,    5,      1,      do_usb,
569         "USB sub-system",
570         "start - start (scan) USB controller\n"
571         "usb reset - reset (rescan) USB controller\n"
572         "usb stop [f] - stop USB [f]=force stop\n"
573         "usb tree - show USB device tree\n"
574         "usb info [dev] - show available USB devices\n"
575         "usb storage - show details of USB storage devices\n"
576         "usb dev [dev] - show or set current USB storage device\n"
577         "usb part [dev] - print partition table of one or all USB storage"
578         " devices\n"
579         "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
580         "    to memory address `addr'\n"
581         "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
582         "    from memory address `addr'"
583 );
584
585
586 U_BOOT_CMD(
587         usbboot,        3,      1,      do_usbboot,
588         "boot from USB device",
589         "loadAddr dev:part"
590 );
591
592 #else
593 U_BOOT_CMD(
594         usb,    5,      1,      do_usb,
595         "USB sub-system",
596         "start - start (scan) USB controller\n"
597         "usb reset - reset (rescan) USB controller\n"
598         "usb tree - show USB device tree\n"
599         "usb info [dev] - show available USB devices"
600 );
601 #endif