// SPDX-License-Identifier: GPL-2.0-or-later /* $(CROSS_COMPILE)cc -Wall -Wextra -g -lpthread -o testusb testusb.c */ /* * Copyright (c) 2002 by David Brownell * Copyright (c) 2010 by Samsung Electronics * Author: Michal Nazarewicz */ /* * This program issues ioctls to perform the tests implemented by the * kernel driver. It can generate a variety of transfer patterns; you * should make sure to test both regular streaming and mixes of * transfer sizes (including short transfers). * * For more information on how this can be used and on USB testing * refer to . */ #include #include #include #include #include #include #include #include #include #include #include #include #include /*-------------------------------------------------------------------------*/ #define TEST_CASES 30 // FIXME make these public somewhere; usbdevfs.h? struct usbtest_param { // inputs unsigned test_num; /* 0..(TEST_CASES-1) */ unsigned iterations; unsigned length; unsigned vary; unsigned sglen; // outputs struct timeval duration; }; #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param) /*-------------------------------------------------------------------------*/ /* #include */ #define USB_DT_DEVICE 0x01 #define USB_DT_INTERFACE 0x04 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ #define USB_CLASS_VENDOR_SPEC 0xff struct usb_device_descriptor { __u8 bLength; __u8 bDescriptorType; __u16 bcdUSB; __u8 bDeviceClass; __u8 bDeviceSubClass; __u8 bDeviceProtocol; __u8 bMaxPacketSize0; __u16 idVendor; __u16 idProduct; __u16 bcdDevice; __u8 iManufacturer; __u8 iProduct; __u8 iSerialNumber; __u8 bNumConfigurations; } __attribute__ ((packed)); struct usb_interface_descriptor { __u8 bLength; __u8 bDescriptorType; __u8 bInterfaceNumber; __u8 bAlternateSetting; __u8 bNumEndpoints; __u8 bInterfaceClass; __u8 bInterfaceSubClass; __u8 bInterfaceProtocol; __u8 iInterface; } __attribute__ ((packed)); enum usb_device_speed { USB_SPEED_UNKNOWN = 0, /* enumerating */ USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ USB_SPEED_HIGH, /* usb 2.0 */ USB_SPEED_WIRELESS, /* wireless (usb 2.5) */ }; /*-------------------------------------------------------------------------*/ static char *speed (enum usb_device_speed s) { switch (s) { case USB_SPEED_UNKNOWN: return "unknown"; case USB_SPEED_LOW: return "low"; case USB_SPEED_FULL: return "full"; case USB_SPEED_HIGH: return "high"; case USB_SPEED_WIRELESS: return "wireless"; default: return "??"; } } struct testdev { struct testdev *next; char *name; pthread_t thread; enum usb_device_speed speed; unsigned ifnum : 8; unsigned forever : 1; int test; struct usbtest_param param; }; static struct testdev *testdevs; static int testdev_ffs_ifnum(FILE *fd) { union { char buf[255]; struct usb_interface_descriptor intf; } u; for (;;) { if (fread(u.buf, 1, 1, fd) != 1) return -1; if (fread(u.buf + 1, (unsigned char)u.buf[0] - 1, 1, fd) != 1) return -1; if (u.intf.bLength == sizeof u.intf && u.intf.bDescriptorType == USB_DT_INTERFACE && u.intf.bNumEndpoints == 2 && u.intf.bInterfaceClass == USB_CLASS_VENDOR_SPEC && u.intf.bInterfaceSubClass == 0 && u.intf.bInterfaceProtocol == 0) return (unsigned char)u.intf.bInterfaceNumber; } } static int testdev_ifnum(FILE *fd) { struct usb_device_descriptor dev; if (fread(&dev, sizeof dev, 1, fd) != 1) return -1; if (dev.bLength != sizeof dev || dev.bDescriptorType != USB_DT_DEVICE) return -1; /* FX2 with (tweaked) bulksrc firmware */ if (dev.idVendor == 0x0547 && dev.idProduct == 0x1002) return 0; /*----------------------------------------------------*/ /* devices that start up using the EZ-USB default device and * which we can use after loading simple firmware. hotplug * can fxload it, and then run this test driver. * * we return false positives in two cases: * - the device has a "real" driver (maybe usb-serial) that * renumerates. the device should vanish quickly. * - the device doesn't have the test firmware installed. */ /* generic EZ-USB FX controller */ if (dev.idVendor == 0x0547 && dev.idProduct == 0x2235) return 0; /* generic EZ-USB FX2 controller */ if (dev.idVendor == 0x04b4 && dev.idProduct == 0x8613) return 0; /* CY3671 development board with EZ-USB FX */ if (dev.idVendor == 0x0547 && dev.idProduct == 0x0080) return 0; /* Keyspan 19Qi uses an21xx (original EZ-USB) */ if (dev.idVendor == 0x06cd && dev.idProduct == 0x010b) return 0; /*----------------------------------------------------*/ /* "gadget zero", Linux-USB test software */ if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a0) return 0; /* user mode subset of that */ if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a4) return testdev_ffs_ifnum(fd); /* return 0; */ /* iso version of usermode code */ if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a3) return 0; /* some GPL'd test firmware uses these IDs */ if (dev.idVendor == 0xfff0 && dev.idProduct == 0xfff0) return 0; /*----------------------------------------------------*/ /* iBOT2 high speed webcam */ if (dev.idVendor == 0x0b62 && dev.idProduct == 0x0059) return 0; /*----------------------------------------------------*/ /* the FunctionFS gadget can have the source/sink interface * anywhere. We look for an interface descriptor that match * what we expect. We ignore configuratiens thou. */ if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4ac && (dev.bDeviceClass == USB_CLASS_PER_INTERFACE || dev.bDeviceClass == USB_CLASS_VENDOR_SPEC)) return testdev_ffs_ifnum(fd); return -1; } static int find_testdev(const char *name, const struct stat *sb, int flag) { FILE *fd; int ifnum; struct testdev *entry; (void)sb; /* unused */ if (flag != FTW_F) return 0; fd = fopen(name, "rb"); if (!fd) { perror(name); return 0; } ifnum = testdev_ifnum(fd); fclose(fd); if (ifnum < 0) return 0; entry = calloc(1, sizeof *entry); if (!entry) goto nomem; entry->name = strdup(name); if (!entry->name) { free(entry); nomem: perror("malloc"); return 0; } entry->ifnum = ifnum; entry->next = testdevs; testdevs = entry; return 0; } static int usbdev_ioctl (int fd, int ifno, unsigned request, void *param) { struct usbdevfs_ioctl wrapper; wrapper.ifno = ifno; wrapper.ioctl_code = request; wrapper.data = param; return ioctl (fd, USBDEVFS_IOCTL, &wrapper); } static void *handle_testdev (void *arg) { struct testdev *dev = arg; int fd, i; int status; if ((fd = open (dev->name, O_RDWR)) < 0) { perror ("can't open dev file r/w"); return 0; } status = ioctl(fd, USBDEVFS_GET_SPEED, NULL); if (status < 0) fprintf(stderr, "USBDEVFS_GET_SPEED failed %d\n", status); else dev->speed = status; fprintf(stderr, "%s speed\t%s\t%u\n", speed(dev->speed), dev->name, dev->ifnum); restart: for (i = 0; i < TEST_CASES; i++) { if (dev->test != -1 && dev->test != i) continue; dev->param.test_num = i; status = usbdev_ioctl (fd, dev->ifnum, USBTEST_REQUEST, &dev->param); if (status < 0 && errno == EOPNOTSUPP) continue; /* FIXME need a "syslog it" option for background testing */ /* NOTE: each thread emits complete lines; no fragments! */ if (status < 0) { char buf [80]; int err = errno; if (strerror_r (errno, buf, sizeof buf)) { snprintf (buf, sizeof buf, "error %d", err); errno = err; } printf ("%s test %d --> %d (%s)\n", dev->name, i, errno, buf); } else printf ("%s test %d, %4d.%.06d secs\n", dev->name, i, (int) dev->param.duration.tv_sec, (int) dev->param.duration.tv_usec); fflush (stdout); } if (dev->forever) goto restart; close (fd); return arg; } static const char *usb_dir_find(void) { static char udev_usb_path[] = "/dev/bus/usb"; if (access(udev_usb_path, F_OK) == 0) return udev_usb_path; return NULL; } static int parse_num(unsigned *num, const char *str) { unsigned long val; char *end; errno = 0; val = strtoul(str, &end, 0); if (errno || *end || val > UINT_MAX) return -1; *num = val; return 0; } int main (int argc, char **argv) { int c; struct testdev *entry; char *device; const char *usb_dir = NULL; int all = 0, forever = 0, not = 0; int test = -1 /* all */; struct usbtest_param param; /* pick defaults that works with all speeds, without short packets. * * Best per-frame data rates: * super speed,bulk 1024 * 16 * 8 = 131072 * interrupt 1024 * 3 * 8 = 24576 * high speed, bulk 512 * 13 * 8 = 53248 * interrupt 1024 * 3 * 8 = 24576 * full speed, bulk/intr 64 * 19 = 1216 * interrupt 64 * 1 = 64 * low speed, interrupt 8 * 1 = 8 */ param.iterations = 1000; param.length = 1024; param.vary = 1024; param.sglen = 32; /* for easy use when hotplugging */ device = getenv ("DEVICE"); while ((c = getopt (argc, argv, "D:aA:c:g:hlns:t:v:")) != EOF) switch (c) { case 'D': /* device, if only one */ device = optarg; continue; case 'A': /* use all devices with specified USB dir */ usb_dir = optarg; /* FALL THROUGH */ case 'a': /* use all devices */ device = NULL; all = 1; continue; case 'c': /* count iterations */ if (parse_num(¶m.iterations, optarg)) goto usage; continue; case 'g': /* scatter/gather entries */ if (parse_num(¶m.sglen, optarg)) goto usage; continue; case 'l': /* loop forever */ forever = 1; continue; case 'n': /* no test running! */ not = 1; continue; case 's': /* size of packet */ if (parse_num(¶m.length, optarg)) goto usage; continue; case 't': /* run just one test */ test = atoi (optarg); if (test < 0) goto usage; continue; case 'v': /* vary packet size by ... */ if (parse_num(¶m.vary, optarg)) goto usage; continue; case '?': case 'h': default: usage: fprintf (stderr, "usage: %s [options]\n" "Options:\n" "\t-D dev only test specific device\n" "\t-A usb-dir\n" "\t-a test all recognized devices\n" "\t-l loop forever(for stress test)\n" "\t-t testnum only run specified case\n" "\t-n no test running, show devices to be tested\n" "Case arguments:\n" "\t-c iterations default 1000\n" "\t-s transfer length default 1024\n" "\t-g sglen default 32\n" "\t-v vary default 1024\n", argv[0]); return 1; } if (optind != argc) goto usage; if (!all && !device) { fprintf (stderr, "must specify '-a' or '-D dev', " "or DEVICE=/dev/bus/usb/BBB/DDD in env\n"); goto usage; } /* Find usb device subdirectory */ if (!usb_dir) { usb_dir = usb_dir_find(); if (!usb_dir) { fputs ("USB device files are missing\n", stderr); return -1; } } /* collect and list the test devices */ if (ftw (usb_dir, find_testdev, 3) != 0) { fputs ("ftw failed; are USB device files missing?\n", stderr); return -1; } /* quit, run single test, or create test threads */ if (!testdevs && !device) { fputs ("no test devices recognized\n", stderr); return -1; } if (not) return 0; if (testdevs && !testdevs->next && !device) device = testdevs->name; for (entry = testdevs; entry; entry = entry->next) { int status; entry->param = param; entry->forever = forever; entry->test = test; if (device) { if (strcmp (entry->name, device)) continue; return handle_testdev (entry) != entry; } status = pthread_create (&entry->thread, 0, handle_testdev, entry); if (status) perror ("pthread_create"); } if (device) { struct testdev dev; /* kernel can recognize test devices we don't */ fprintf (stderr, "%s: %s may see only control tests\n", argv [0], device); memset (&dev, 0, sizeof dev); dev.name = device; dev.param = param; dev.forever = forever; dev.test = test; return handle_testdev (&dev) != &dev; } /* wait for tests to complete */ for (entry = testdevs; entry; entry = entry->next) { void *retval; if (pthread_join (entry->thread, &retval)) perror ("pthread_join"); /* testing errors discarded! */ } return 0; }