]> git.ipfire.org Git - people/ms/u-boot.git/blob - common/cmd_usb.c
usb: Add new command to set USB 2.0 port test modes
[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 <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 static 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 static 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 static 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 static 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 static void usb_display_conf_desc(struct usb_config_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 static 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 static 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 static 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 struct usb_device *usb_find_device(int devnum)
273 {
274 struct usb_device *dev;
275 int d;
276
277 for (d = 0; d < USB_MAX_DEVICE; d++) {
278 dev = usb_get_dev_index(d);
279 if (dev == NULL)
280 return NULL;
281 if (dev->devnum == devnum)
282 return dev;
283 }
284
285 return NULL;
286 }
287
288 static inline char *portspeed(int speed)
289 {
290 if (speed == USB_SPEED_HIGH)
291 return "480 Mb/s";
292 else if (speed == USB_SPEED_LOW)
293 return "1.5 Mb/s";
294 else
295 return "12 Mb/s";
296 }
297
298 /* shows the device tree recursively */
299 static void usb_show_tree_graph(struct usb_device *dev, char *pre)
300 {
301 int i, index;
302 int has_child, last_child;
303
304 index = strlen(pre);
305 printf(" %s", pre);
306 /* check if the device has connected children */
307 has_child = 0;
308 for (i = 0; i < dev->maxchild; i++) {
309 if (dev->children[i] != NULL)
310 has_child = 1;
311 }
312 /* check if we are the last one */
313 last_child = 1;
314 if (dev->parent != NULL) {
315 for (i = 0; i < dev->parent->maxchild; i++) {
316 /* search for children */
317 if (dev->parent->children[i] == dev) {
318 /* found our pointer, see if we have a
319 * little sister
320 */
321 while (i++ < dev->parent->maxchild) {
322 if (dev->parent->children[i] != NULL) {
323 /* found a sister */
324 last_child = 0;
325 break;
326 } /* if */
327 } /* while */
328 } /* device found */
329 } /* for all children of the parent */
330 printf("\b+-");
331 /* correct last child */
332 if (last_child)
333 pre[index-1] = ' ';
334 } /* if not root hub */
335 else
336 printf(" ");
337 printf("%d ", dev->devnum);
338 pre[index++] = ' ';
339 pre[index++] = has_child ? '|' : ' ';
340 pre[index] = 0;
341 printf(" %s (%s, %dmA)\n", usb_get_class_desc(
342 dev->config.if_desc[0].desc.bInterfaceClass),
343 portspeed(dev->speed),
344 dev->config.desc.bMaxPower * 2);
345 if (strlen(dev->mf) || strlen(dev->prod) || strlen(dev->serial))
346 printf(" %s %s %s %s\n", pre, dev->mf, dev->prod, dev->serial);
347 printf(" %s\n", pre);
348 if (dev->maxchild > 0) {
349 for (i = 0; i < dev->maxchild; i++) {
350 if (dev->children[i] != NULL) {
351 usb_show_tree_graph(dev->children[i], pre);
352 pre[index] = 0;
353 }
354 }
355 }
356 }
357
358 /* main routine for the tree command */
359 static void usb_show_tree(struct usb_device *dev)
360 {
361 char preamble[32];
362
363 memset(preamble, 0, 32);
364 usb_show_tree_graph(dev, &preamble[0]);
365 }
366
367 static int usb_test(struct usb_device *dev, int port, char* arg)
368 {
369 int mode;
370
371 if (port > dev->maxchild) {
372 printf("Device is no hub or does not have %d ports.\n", port);
373 return 1;
374 }
375
376 switch (arg[0]) {
377 case 'J':
378 case 'j':
379 printf("Setting Test_J mode");
380 mode = USB_TEST_MODE_J;
381 break;
382 case 'K':
383 case 'k':
384 printf("Setting Test_K mode");
385 mode = USB_TEST_MODE_K;
386 break;
387 case 'S':
388 case 's':
389 printf("Setting Test_SE0_NAK mode");
390 mode = USB_TEST_MODE_SE0_NAK;
391 break;
392 case 'P':
393 case 'p':
394 printf("Setting Test_Packet mode");
395 mode = USB_TEST_MODE_PACKET;
396 break;
397 case 'F':
398 case 'f':
399 printf("Setting Test_Force_Enable mode");
400 mode = USB_TEST_MODE_FORCE_ENABLE;
401 break;
402 default:
403 printf("Unrecognized test mode: %s\nAvailable modes: "
404 "J, K, S[E0_NAK], P[acket], F[orce_Enable]\n", arg);
405 return 1;
406 }
407
408 if (port)
409 printf(" on downstream facing port %d...\n", port);
410 else
411 printf(" on upstream facing port...\n");
412
413 if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0), USB_REQ_SET_FEATURE,
414 port ? USB_RT_PORT : USB_RECIP_DEVICE,
415 port ? USB_PORT_FEAT_TEST : USB_FEAT_TEST,
416 (mode << 8) | port,
417 NULL, 0, USB_CNTL_TIMEOUT) == -1) {
418 printf("Error during SET_FEATURE.\n");
419 return 1;
420 } else {
421 printf("Test mode successfully set. Use 'usb start' "
422 "to return to normal operation.\n");
423 return 0;
424 }
425 }
426
427
428 /******************************************************************************
429 * usb boot command intepreter. Derived from diskboot
430 */
431 #ifdef CONFIG_USB_STORAGE
432 static int do_usbboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
433 {
434 return common_diskboot(cmdtp, "usb", argc, argv);
435 }
436 #endif /* CONFIG_USB_STORAGE */
437
438
439 /******************************************************************************
440 * usb command intepreter
441 */
442 static int do_usb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
443 {
444
445 int i;
446 struct usb_device *dev = NULL;
447 extern char usb_started;
448 #ifdef CONFIG_USB_STORAGE
449 block_dev_desc_t *stor_dev;
450 #endif
451
452 if (argc < 2)
453 return CMD_RET_USAGE;
454
455 if ((strncmp(argv[1], "reset", 5) == 0) ||
456 (strncmp(argv[1], "start", 5) == 0)) {
457 bootstage_mark_name(BOOTSTAGE_ID_USB_START, "usb_start");
458 usb_stop();
459 printf("(Re)start USB...\n");
460 if (usb_init() >= 0) {
461 #ifdef CONFIG_USB_STORAGE
462 /* try to recognize storage devices immediately */
463 usb_stor_curr_dev = usb_stor_scan(1);
464 #endif
465 #ifdef CONFIG_USB_HOST_ETHER
466 /* try to recognize ethernet devices immediately */
467 usb_ether_curr_dev = usb_host_eth_scan(1);
468 #endif
469 #ifdef CONFIG_USB_KEYBOARD
470 drv_usb_kbd_init();
471 #endif
472 }
473 return 0;
474 }
475 if (strncmp(argv[1], "stop", 4) == 0) {
476 #ifdef CONFIG_USB_KEYBOARD
477 if (argc == 2) {
478 if (usb_kbd_deregister() != 0) {
479 printf("USB not stopped: usbkbd still"
480 " using USB\n");
481 return 1;
482 }
483 } else {
484 /* forced stop, switch console in to serial */
485 console_assign(stdin, "serial");
486 usb_kbd_deregister();
487 }
488 #endif
489 printf("stopping USB..\n");
490 usb_stop();
491 return 0;
492 }
493 if (!usb_started) {
494 printf("USB is stopped. Please issue 'usb start' first.\n");
495 return 1;
496 }
497 if (strncmp(argv[1], "tree", 4) == 0) {
498 puts("USB device tree:\n");
499 for (i = 0; i < USB_MAX_DEVICE; i++) {
500 dev = usb_get_dev_index(i);
501 if (dev == NULL)
502 break;
503 if (dev->parent == NULL)
504 usb_show_tree(dev);
505 }
506 return 0;
507 }
508 if (strncmp(argv[1], "inf", 3) == 0) {
509 int d;
510 if (argc == 2) {
511 for (d = 0; d < USB_MAX_DEVICE; d++) {
512 dev = usb_get_dev_index(d);
513 if (dev == NULL)
514 break;
515 usb_display_desc(dev);
516 usb_display_config(dev);
517 }
518 return 0;
519 } else {
520 i = simple_strtoul(argv[2], NULL, 10);
521 printf("config for device %d\n", i);
522 dev = usb_find_device(i);
523 if (dev == NULL) {
524 printf("*** No device available ***\n");
525 return 0;
526 } else {
527 usb_display_desc(dev);
528 usb_display_config(dev);
529 }
530 }
531 return 0;
532 }
533 if (strncmp(argv[1], "test", 4) == 0) {
534 if (argc < 5)
535 return CMD_RET_USAGE;
536 i = simple_strtoul(argv[2], NULL, 10);
537 dev = usb_find_device(i);
538 if (dev == NULL) {
539 printf("Device %d does not exist.\n", i);
540 return 1;
541 }
542 i = simple_strtoul(argv[3], NULL, 10);
543 return usb_test(dev, i, argv[4]);
544 }
545 #ifdef CONFIG_USB_STORAGE
546 if (strncmp(argv[1], "stor", 4) == 0)
547 return usb_stor_info();
548
549 if (strncmp(argv[1], "part", 4) == 0) {
550 int devno, ok = 0;
551 if (argc == 2) {
552 for (devno = 0; ; ++devno) {
553 stor_dev = usb_stor_get_dev(devno);
554 if (stor_dev == NULL)
555 break;
556 if (stor_dev->type != DEV_TYPE_UNKNOWN) {
557 ok++;
558 if (devno)
559 printf("\n");
560 debug("print_part of %x\n", devno);
561 print_part(stor_dev);
562 }
563 }
564 } else {
565 devno = simple_strtoul(argv[2], NULL, 16);
566 stor_dev = usb_stor_get_dev(devno);
567 if (stor_dev != NULL &&
568 stor_dev->type != DEV_TYPE_UNKNOWN) {
569 ok++;
570 debug("print_part of %x\n", devno);
571 print_part(stor_dev);
572 }
573 }
574 if (!ok) {
575 printf("\nno USB devices available\n");
576 return 1;
577 }
578 return 0;
579 }
580 if (strcmp(argv[1], "read") == 0) {
581 if (usb_stor_curr_dev < 0) {
582 printf("no current device selected\n");
583 return 1;
584 }
585 if (argc == 5) {
586 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
587 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
588 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
589 unsigned long n;
590 printf("\nUSB read: device %d block # %ld, count %ld"
591 " ... ", usb_stor_curr_dev, blk, cnt);
592 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
593 n = stor_dev->block_read(usb_stor_curr_dev, blk, cnt,
594 (ulong *)addr);
595 printf("%ld blocks read: %s\n", n,
596 (n == cnt) ? "OK" : "ERROR");
597 if (n == cnt)
598 return 0;
599 return 1;
600 }
601 }
602 if (strcmp(argv[1], "write") == 0) {
603 if (usb_stor_curr_dev < 0) {
604 printf("no current device selected\n");
605 return 1;
606 }
607 if (argc == 5) {
608 unsigned long addr = simple_strtoul(argv[2], NULL, 16);
609 unsigned long blk = simple_strtoul(argv[3], NULL, 16);
610 unsigned long cnt = simple_strtoul(argv[4], NULL, 16);
611 unsigned long n;
612 printf("\nUSB write: device %d block # %ld, count %ld"
613 " ... ", usb_stor_curr_dev, blk, cnt);
614 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
615 n = stor_dev->block_write(usb_stor_curr_dev, blk, cnt,
616 (ulong *)addr);
617 printf("%ld blocks write: %s\n", n,
618 (n == cnt) ? "OK" : "ERROR");
619 if (n == cnt)
620 return 0;
621 return 1;
622 }
623 }
624 if (strncmp(argv[1], "dev", 3) == 0) {
625 if (argc == 3) {
626 int dev = (int)simple_strtoul(argv[2], NULL, 10);
627 printf("\nUSB device %d: ", dev);
628 stor_dev = usb_stor_get_dev(dev);
629 if (stor_dev == NULL) {
630 printf("unknown device\n");
631 return 1;
632 }
633 printf("\n Device %d: ", dev);
634 dev_print(stor_dev);
635 if (stor_dev->type == DEV_TYPE_UNKNOWN)
636 return 1;
637 usb_stor_curr_dev = dev;
638 printf("... is now current device\n");
639 return 0;
640 } else {
641 printf("\nUSB device %d: ", usb_stor_curr_dev);
642 stor_dev = usb_stor_get_dev(usb_stor_curr_dev);
643 dev_print(stor_dev);
644 if (stor_dev->type == DEV_TYPE_UNKNOWN)
645 return 1;
646 return 0;
647 }
648 return 0;
649 }
650 #endif /* CONFIG_USB_STORAGE */
651 return CMD_RET_USAGE;
652 }
653
654 U_BOOT_CMD(
655 usb, 5, 1, do_usb,
656 "USB sub-system",
657 "start - start (scan) USB controller\n"
658 "usb reset - reset (rescan) USB controller\n"
659 "usb stop [f] - stop USB [f]=force stop\n"
660 "usb tree - show USB device tree\n"
661 "usb info [dev] - show available USB devices\n"
662 "usb test [dev] [port] [mode] - set USB 2.0 test mode\n"
663 " (specify port 0 to indicate the device's upstream port)\n"
664 " Available modes: J, K, S[E0_NAK], P[acket], F[orce_Enable]\n"
665 #ifdef CONFIG_USB_STORAGE
666 "usb storage - show details of USB storage devices\n"
667 "usb dev [dev] - show or set current USB storage device\n"
668 "usb part [dev] - print partition table of one or all USB storage"
669 " devices\n"
670 "usb read addr blk# cnt - read `cnt' blocks starting at block `blk#'\n"
671 " to memory address `addr'\n"
672 "usb write addr blk# cnt - write `cnt' blocks starting at block `blk#'\n"
673 " from memory address `addr'"
674 #endif /* CONFIG_USB_STORAGE */
675 );
676
677
678 #ifdef CONFIG_USB_STORAGE
679 U_BOOT_CMD(
680 usbboot, 3, 1, do_usbboot,
681 "boot from USB device",
682 "loadAddr dev:part"
683 );
684 #endif /* CONFIG_USB_STORAGE */