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