Root/tools/usb/testusb.c

1/* $(CROSS_COMPILE)cc -Wall -Wextra -g -lpthread -o testusb testusb.c */
2
3/*
4 * Copyright (c) 2002 by David Brownell
5 * Copyright (c) 2010 by Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23/*
24 * This program issues ioctls to perform the tests implemented by the
25 * kernel driver. It can generate a variety of transfer patterns; you
26 * should make sure to test both regular streaming and mixes of
27 * transfer sizes (including short transfers).
28 *
29 * For more information on how this can be used and on USB testing
30 * refer to <URL:http://www.linux-usb.org/usbtest/>.
31 */
32
33#include <stdio.h>
34#include <string.h>
35#include <ftw.h>
36#include <stdlib.h>
37#include <pthread.h>
38#include <unistd.h>
39#include <errno.h>
40#include <limits.h>
41
42#include <sys/types.h>
43#include <sys/stat.h>
44#include <fcntl.h>
45
46#include <sys/ioctl.h>
47#include <linux/usbdevice_fs.h>
48
49/*-------------------------------------------------------------------------*/
50
51#define TEST_CASES 30
52
53// FIXME make these public somewhere; usbdevfs.h?
54
55struct usbtest_param {
56    // inputs
57    unsigned test_num; /* 0..(TEST_CASES-1) */
58    unsigned iterations;
59    unsigned length;
60    unsigned vary;
61    unsigned sglen;
62
63    // outputs
64    struct timeval duration;
65};
66#define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
67
68/*-------------------------------------------------------------------------*/
69
70/* #include <linux/usb_ch9.h> */
71
72#define USB_DT_DEVICE 0x01
73#define USB_DT_INTERFACE 0x04
74
75#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
76#define USB_CLASS_VENDOR_SPEC 0xff
77
78
79struct usb_device_descriptor {
80    __u8 bLength;
81    __u8 bDescriptorType;
82    __u16 bcdUSB;
83    __u8 bDeviceClass;
84    __u8 bDeviceSubClass;
85    __u8 bDeviceProtocol;
86    __u8 bMaxPacketSize0;
87    __u16 idVendor;
88    __u16 idProduct;
89    __u16 bcdDevice;
90    __u8 iManufacturer;
91    __u8 iProduct;
92    __u8 iSerialNumber;
93    __u8 bNumConfigurations;
94} __attribute__ ((packed));
95
96struct usb_interface_descriptor {
97    __u8 bLength;
98    __u8 bDescriptorType;
99
100    __u8 bInterfaceNumber;
101    __u8 bAlternateSetting;
102    __u8 bNumEndpoints;
103    __u8 bInterfaceClass;
104    __u8 bInterfaceSubClass;
105    __u8 bInterfaceProtocol;
106    __u8 iInterface;
107} __attribute__ ((packed));
108
109enum usb_device_speed {
110    USB_SPEED_UNKNOWN = 0, /* enumerating */
111    USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
112    USB_SPEED_HIGH /* usb 2.0 */
113};
114
115/*-------------------------------------------------------------------------*/
116
117static char *speed (enum usb_device_speed s)
118{
119    switch (s) {
120    case USB_SPEED_UNKNOWN: return "unknown";
121    case USB_SPEED_LOW: return "low";
122    case USB_SPEED_FULL: return "full";
123    case USB_SPEED_HIGH: return "high";
124    default: return "??";
125    }
126}
127
128struct testdev {
129    struct testdev *next;
130    char *name;
131    pthread_t thread;
132    enum usb_device_speed speed;
133    unsigned ifnum : 8;
134    unsigned forever : 1;
135    int test;
136
137    struct usbtest_param param;
138};
139static struct testdev *testdevs;
140
141static int testdev_ffs_ifnum(FILE *fd)
142{
143    union {
144        char buf[255];
145        struct usb_interface_descriptor intf;
146    } u;
147
148    for (;;) {
149        if (fread(u.buf, 1, 1, fd) != 1)
150            return -1;
151        if (fread(u.buf + 1, (unsigned char)u.buf[0] - 1, 1, fd) != 1)
152            return -1;
153
154        if (u.intf.bLength == sizeof u.intf
155         && u.intf.bDescriptorType == USB_DT_INTERFACE
156         && u.intf.bNumEndpoints == 2
157         && u.intf.bInterfaceClass == USB_CLASS_VENDOR_SPEC
158         && u.intf.bInterfaceSubClass == 0
159         && u.intf.bInterfaceProtocol == 0)
160            return (unsigned char)u.intf.bInterfaceNumber;
161    }
162}
163
164static int testdev_ifnum(FILE *fd)
165{
166    struct usb_device_descriptor dev;
167
168    if (fread(&dev, sizeof dev, 1, fd) != 1)
169        return -1;
170
171    if (dev.bLength != sizeof dev || dev.bDescriptorType != USB_DT_DEVICE)
172        return -1;
173
174    /* FX2 with (tweaked) bulksrc firmware */
175    if (dev.idVendor == 0x0547 && dev.idProduct == 0x1002)
176        return 0;
177
178    /*----------------------------------------------------*/
179
180    /* devices that start up using the EZ-USB default device and
181     * which we can use after loading simple firmware. hotplug
182     * can fxload it, and then run this test driver.
183     *
184     * we return false positives in two cases:
185     * - the device has a "real" driver (maybe usb-serial) that
186     * renumerates. the device should vanish quickly.
187     * - the device doesn't have the test firmware installed.
188     */
189
190    /* generic EZ-USB FX controller */
191    if (dev.idVendor == 0x0547 && dev.idProduct == 0x2235)
192        return 0;
193
194    /* generic EZ-USB FX2 controller */
195    if (dev.idVendor == 0x04b4 && dev.idProduct == 0x8613)
196        return 0;
197
198    /* CY3671 development board with EZ-USB FX */
199    if (dev.idVendor == 0x0547 && dev.idProduct == 0x0080)
200        return 0;
201
202    /* Keyspan 19Qi uses an21xx (original EZ-USB) */
203    if (dev.idVendor == 0x06cd && dev.idProduct == 0x010b)
204        return 0;
205
206    /*----------------------------------------------------*/
207
208    /* "gadget zero", Linux-USB test software */
209    if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a0)
210        return 0;
211
212    /* user mode subset of that */
213    if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a4)
214        return testdev_ffs_ifnum(fd);
215        /* return 0; */
216
217    /* iso version of usermode code */
218    if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4a3)
219        return 0;
220
221    /* some GPL'd test firmware uses these IDs */
222
223    if (dev.idVendor == 0xfff0 && dev.idProduct == 0xfff0)
224        return 0;
225
226    /*----------------------------------------------------*/
227
228    /* iBOT2 high speed webcam */
229    if (dev.idVendor == 0x0b62 && dev.idProduct == 0x0059)
230        return 0;
231
232    /*----------------------------------------------------*/
233
234    /* the FunctionFS gadget can have the source/sink interface
235     * anywhere. We look for an interface descriptor that match
236     * what we expect. We ignore configuratiens thou. */
237
238    if (dev.idVendor == 0x0525 && dev.idProduct == 0xa4ac
239     && (dev.bDeviceClass == USB_CLASS_PER_INTERFACE
240      || dev.bDeviceClass == USB_CLASS_VENDOR_SPEC))
241        return testdev_ffs_ifnum(fd);
242
243    return -1;
244}
245
246static int find_testdev(const char *name, const struct stat *sb, int flag)
247{
248    FILE *fd;
249    int ifnum;
250    struct testdev *entry;
251
252    (void)sb; /* unused */
253
254    if (flag != FTW_F)
255        return 0;
256    /* ignore /proc/bus/usb/{devices,drivers} */
257    if (strrchr(name, '/')[1] == 'd')
258        return 0;
259
260    fd = fopen(name, "rb");
261    if (!fd) {
262        perror(name);
263        return 0;
264    }
265
266    ifnum = testdev_ifnum(fd);
267    fclose(fd);
268    if (ifnum < 0)
269        return 0;
270
271    entry = calloc(1, sizeof *entry);
272    if (!entry)
273        goto nomem;
274
275    entry->name = strdup(name);
276    if (!entry->name) {
277        free(entry);
278nomem:
279        perror("malloc");
280        return 0;
281    }
282
283    entry->ifnum = ifnum;
284
285    /* FIXME ask usbfs what speed; update USBDEVFS_CONNECTINFO so
286     * it tells about high speed etc */
287
288    fprintf(stderr, "%s speed\t%s\t%u\n",
289        speed(entry->speed), entry->name, entry->ifnum);
290
291    entry->next = testdevs;
292    testdevs = entry;
293    return 0;
294}
295
296static int
297usbdev_ioctl (int fd, int ifno, unsigned request, void *param)
298{
299    struct usbdevfs_ioctl wrapper;
300
301    wrapper.ifno = ifno;
302    wrapper.ioctl_code = request;
303    wrapper.data = param;
304
305    return ioctl (fd, USBDEVFS_IOCTL, &wrapper);
306}
307
308static void *handle_testdev (void *arg)
309{
310    struct testdev *dev = arg;
311    int fd, i;
312    int status;
313
314    if ((fd = open (dev->name, O_RDWR)) < 0) {
315        perror ("can't open dev file r/w");
316        return 0;
317    }
318
319restart:
320    for (i = 0; i < TEST_CASES; i++) {
321        if (dev->test != -1 && dev->test != i)
322            continue;
323        dev->param.test_num = i;
324
325        status = usbdev_ioctl (fd, dev->ifnum,
326                USBTEST_REQUEST, &dev->param);
327        if (status < 0 && errno == EOPNOTSUPP)
328            continue;
329
330        /* FIXME need a "syslog it" option for background testing */
331
332        /* NOTE: each thread emits complete lines; no fragments! */
333        if (status < 0) {
334            char buf [80];
335            int err = errno;
336
337            if (strerror_r (errno, buf, sizeof buf)) {
338                snprintf (buf, sizeof buf, "error %d", err);
339                errno = err;
340            }
341            printf ("%s test %d --> %d (%s)\n",
342                dev->name, i, errno, buf);
343        } else
344            printf ("%s test %d, %4d.%.06d secs\n", dev->name, i,
345                (int) dev->param.duration.tv_sec,
346                (int) dev->param.duration.tv_usec);
347
348        fflush (stdout);
349    }
350    if (dev->forever)
351        goto restart;
352
353    close (fd);
354    return arg;
355}
356
357static const char *usbfs_dir_find(void)
358{
359    static char usbfs_path_0[] = "/dev/usb/devices";
360    static char usbfs_path_1[] = "/proc/bus/usb/devices";
361    static char udev_usb_path[] = "/dev/bus/usb";
362
363    static char *const usbfs_paths[] = {
364        usbfs_path_0, usbfs_path_1
365    };
366
367    static char *const *
368        end = usbfs_paths + sizeof usbfs_paths / sizeof *usbfs_paths;
369
370    char *const *it = usbfs_paths;
371    do {
372        int fd = open(*it, O_RDONLY);
373        close(fd);
374        if (fd >= 0) {
375            strrchr(*it, '/')[0] = '\0';
376            return *it;
377        }
378    } while (++it != end);
379
380    /* real device-nodes managed by udev */
381    if (access(udev_usb_path, F_OK) == 0)
382        return udev_usb_path;
383
384    return NULL;
385}
386
387static int parse_num(unsigned *num, const char *str)
388{
389    unsigned long val;
390    char *end;
391
392    errno = 0;
393    val = strtoul(str, &end, 0);
394    if (errno || *end || val > UINT_MAX)
395        return -1;
396    *num = val;
397    return 0;
398}
399
400int main (int argc, char **argv)
401{
402
403    int c;
404    struct testdev *entry;
405    char *device;
406    const char *usbfs_dir = NULL;
407    int all = 0, forever = 0, not = 0;
408    int test = -1 /* all */;
409    struct usbtest_param param;
410
411    /* pick defaults that works with all speeds, without short packets.
412     *
413     * Best per-frame data rates:
414     * high speed, bulk 512 * 13 * 8 = 53248
415     * interrupt 1024 * 3 * 8 = 24576
416     * full speed, bulk/intr 64 * 19 = 1216
417     * interrupt 64 * 1 = 64
418     * low speed, interrupt 8 * 1 = 8
419     */
420    param.iterations = 1000;
421    param.length = 512;
422    param.vary = 512;
423    param.sglen = 32;
424
425    /* for easy use when hotplugging */
426    device = getenv ("DEVICE");
427
428    while ((c = getopt (argc, argv, "D:aA:c:g:hns:t:v:")) != EOF)
429    switch (c) {
430    case 'D': /* device, if only one */
431        device = optarg;
432        continue;
433    case 'A': /* use all devices with specified usbfs dir */
434        usbfs_dir = optarg;
435        /* FALL THROUGH */
436    case 'a': /* use all devices */
437        device = NULL;
438        all = 1;
439        continue;
440    case 'c': /* count iterations */
441        if (parse_num(&param.iterations, optarg))
442            goto usage;
443        continue;
444    case 'g': /* scatter/gather entries */
445        if (parse_num(&param.sglen, optarg))
446            goto usage;
447        continue;
448    case 'l': /* loop forever */
449        forever = 1;
450        continue;
451    case 'n': /* no test running! */
452        not = 1;
453        continue;
454    case 's': /* size of packet */
455        if (parse_num(&param.length, optarg))
456            goto usage;
457        continue;
458    case 't': /* run just one test */
459        test = atoi (optarg);
460        if (test < 0)
461            goto usage;
462        continue;
463    case 'v': /* vary packet size by ... */
464        if (parse_num(&param.vary, optarg))
465            goto usage;
466        continue;
467    case '?':
468    case 'h':
469    default:
470usage:
471        fprintf (stderr, "usage: %s [-n] [-D dev | -a | -A usbfs-dir]\n"
472            "\t[-c iterations] [-t testnum]\n"
473            "\t[-s packetsize] [-g sglen] [-v vary]\n",
474            argv [0]);
475        return 1;
476    }
477    if (optind != argc)
478        goto usage;
479    if (!all && !device) {
480        fprintf (stderr, "must specify '-a' or '-D dev', "
481            "or DEVICE=/proc/bus/usb/BBB/DDD in env\n");
482        goto usage;
483    }
484
485    /* Find usbfs mount point */
486    if (!usbfs_dir) {
487        usbfs_dir = usbfs_dir_find();
488        if (!usbfs_dir) {
489            fputs ("usbfs files are missing\n", stderr);
490            return -1;
491        }
492    }
493
494    /* collect and list the test devices */
495    if (ftw (usbfs_dir, find_testdev, 3) != 0) {
496        fputs ("ftw failed; is usbfs missing?\n", stderr);
497        return -1;
498    }
499
500    /* quit, run single test, or create test threads */
501    if (!testdevs && !device) {
502        fputs ("no test devices recognized\n", stderr);
503        return -1;
504    }
505    if (not)
506        return 0;
507    if (testdevs && testdevs->next == 0 && !device)
508        device = testdevs->name;
509    for (entry = testdevs; entry; entry = entry->next) {
510        int status;
511
512        entry->param = param;
513        entry->forever = forever;
514        entry->test = test;
515
516        if (device) {
517            if (strcmp (entry->name, device))
518                continue;
519            return handle_testdev (entry) != entry;
520        }
521        status = pthread_create (&entry->thread, 0, handle_testdev, entry);
522        if (status) {
523            perror ("pthread_create");
524            continue;
525        }
526    }
527    if (device) {
528        struct testdev dev;
529
530        /* kernel can recognize test devices we don't */
531        fprintf (stderr, "%s: %s may see only control tests\n",
532                argv [0], device);
533
534        memset (&dev, 0, sizeof dev);
535        dev.name = device;
536        dev.param = param;
537        dev.forever = forever;
538        dev.test = test;
539        return handle_testdev (&dev) != &dev;
540    }
541
542    /* wait for tests to complete */
543    for (entry = testdevs; entry; entry = entry->next) {
544        void *retval;
545
546        if (pthread_join (entry->thread, &retval))
547            perror ("pthread_join");
548        /* testing errors discarded! */
549    }
550
551    return 0;
552}
553

Archive Download this file



interactive