Loading...
1/*
2 * ffs-test.c -- user mode filesystem api for usb composite function
3 *
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <mina86@mina86.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22/* $(CROSS_COMPILE)cc -Wall -Wextra -g -o ffs-test ffs-test.c -lpthread */
23
24
25#define _BSD_SOURCE /* for endian.h */
26
27#include <endian.h>
28#include <errno.h>
29#include <fcntl.h>
30#include <pthread.h>
31#include <stdarg.h>
32#include <stdbool.h>
33#include <stdio.h>
34#include <stdlib.h>
35#include <string.h>
36#include <sys/ioctl.h>
37#include <sys/stat.h>
38#include <sys/types.h>
39#include <unistd.h>
40#include <tools/le_byteshift.h>
41
42#include "../../include/uapi/linux/usb/functionfs.h"
43
44
45/******************** Little Endian Handling ********************************/
46
47#define cpu_to_le16(x) htole16(x)
48#define cpu_to_le32(x) htole32(x)
49#define le32_to_cpu(x) le32toh(x)
50#define le16_to_cpu(x) le16toh(x)
51
52
53/******************** Messages and Errors ***********************************/
54
55static const char argv0[] = "ffs-test";
56
57static unsigned verbosity = 7;
58
59static void _msg(unsigned level, const char *fmt, ...)
60{
61 if (level < 2)
62 level = 2;
63 else if (level > 7)
64 level = 7;
65
66 if (level <= verbosity) {
67 static const char levels[8][6] = {
68 [2] = "crit:",
69 [3] = "err: ",
70 [4] = "warn:",
71 [5] = "note:",
72 [6] = "info:",
73 [7] = "dbg: "
74 };
75
76 int _errno = errno;
77 va_list ap;
78
79 fprintf(stderr, "%s: %s ", argv0, levels[level]);
80 va_start(ap, fmt);
81 vfprintf(stderr, fmt, ap);
82 va_end(ap);
83
84 if (fmt[strlen(fmt) - 1] != '\n') {
85 char buffer[128];
86 strerror_r(_errno, buffer, sizeof buffer);
87 fprintf(stderr, ": (-%d) %s\n", _errno, buffer);
88 }
89
90 fflush(stderr);
91 }
92}
93
94#define die(...) (_msg(2, __VA_ARGS__), exit(1))
95#define err(...) _msg(3, __VA_ARGS__)
96#define warn(...) _msg(4, __VA_ARGS__)
97#define note(...) _msg(5, __VA_ARGS__)
98#define info(...) _msg(6, __VA_ARGS__)
99#define debug(...) _msg(7, __VA_ARGS__)
100
101#define die_on(cond, ...) do { \
102 if (cond) \
103 die(__VA_ARGS__); \
104 } while (0)
105
106
107/******************** Descriptors and Strings *******************************/
108
109static const struct {
110 struct usb_functionfs_descs_head_v2 header;
111 __le32 fs_count;
112 __le32 hs_count;
113 struct {
114 struct usb_interface_descriptor intf;
115 struct usb_endpoint_descriptor_no_audio sink;
116 struct usb_endpoint_descriptor_no_audio source;
117 } __attribute__((packed)) fs_descs, hs_descs;
118} __attribute__((packed)) descriptors = {
119 .header = {
120 .magic = cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC_V2),
121 .flags = cpu_to_le32(FUNCTIONFS_HAS_FS_DESC |
122 FUNCTIONFS_HAS_HS_DESC),
123 .length = cpu_to_le32(sizeof descriptors),
124 },
125 .fs_count = cpu_to_le32(3),
126 .fs_descs = {
127 .intf = {
128 .bLength = sizeof descriptors.fs_descs.intf,
129 .bDescriptorType = USB_DT_INTERFACE,
130 .bNumEndpoints = 2,
131 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
132 .iInterface = 1,
133 },
134 .sink = {
135 .bLength = sizeof descriptors.fs_descs.sink,
136 .bDescriptorType = USB_DT_ENDPOINT,
137 .bEndpointAddress = 1 | USB_DIR_IN,
138 .bmAttributes = USB_ENDPOINT_XFER_BULK,
139 /* .wMaxPacketSize = autoconfiguration (kernel) */
140 },
141 .source = {
142 .bLength = sizeof descriptors.fs_descs.source,
143 .bDescriptorType = USB_DT_ENDPOINT,
144 .bEndpointAddress = 2 | USB_DIR_OUT,
145 .bmAttributes = USB_ENDPOINT_XFER_BULK,
146 /* .wMaxPacketSize = autoconfiguration (kernel) */
147 },
148 },
149 .hs_count = cpu_to_le32(3),
150 .hs_descs = {
151 .intf = {
152 .bLength = sizeof descriptors.fs_descs.intf,
153 .bDescriptorType = USB_DT_INTERFACE,
154 .bNumEndpoints = 2,
155 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
156 .iInterface = 1,
157 },
158 .sink = {
159 .bLength = sizeof descriptors.hs_descs.sink,
160 .bDescriptorType = USB_DT_ENDPOINT,
161 .bEndpointAddress = 1 | USB_DIR_IN,
162 .bmAttributes = USB_ENDPOINT_XFER_BULK,
163 .wMaxPacketSize = cpu_to_le16(512),
164 },
165 .source = {
166 .bLength = sizeof descriptors.hs_descs.source,
167 .bDescriptorType = USB_DT_ENDPOINT,
168 .bEndpointAddress = 2 | USB_DIR_OUT,
169 .bmAttributes = USB_ENDPOINT_XFER_BULK,
170 .wMaxPacketSize = cpu_to_le16(512),
171 .bInterval = 1, /* NAK every 1 uframe */
172 },
173 },
174};
175
176static size_t descs_to_legacy(void **legacy, const void *descriptors_v2)
177{
178 const unsigned char *descs_end, *descs_start;
179 __u32 length, fs_count = 0, hs_count = 0, count;
180
181 /* Read v2 header */
182 {
183 const struct {
184 const struct usb_functionfs_descs_head_v2 header;
185 const __le32 counts[];
186 } __attribute__((packed)) *const in = descriptors_v2;
187 const __le32 *counts = in->counts;
188 __u32 flags;
189
190 if (le32_to_cpu(in->header.magic) !=
191 FUNCTIONFS_DESCRIPTORS_MAGIC_V2)
192 return 0;
193 length = le32_to_cpu(in->header.length);
194 if (length <= sizeof in->header)
195 return 0;
196 length -= sizeof in->header;
197 flags = le32_to_cpu(in->header.flags);
198 if (flags & ~(FUNCTIONFS_HAS_FS_DESC | FUNCTIONFS_HAS_HS_DESC |
199 FUNCTIONFS_HAS_SS_DESC))
200 return 0;
201
202#define GET_NEXT_COUNT_IF_FLAG(ret, flg) do { \
203 if (!(flags & (flg))) \
204 break; \
205 if (length < 4) \
206 return 0; \
207 ret = le32_to_cpu(*counts); \
208 length -= 4; \
209 ++counts; \
210 } while (0)
211
212 GET_NEXT_COUNT_IF_FLAG(fs_count, FUNCTIONFS_HAS_FS_DESC);
213 GET_NEXT_COUNT_IF_FLAG(hs_count, FUNCTIONFS_HAS_HS_DESC);
214 GET_NEXT_COUNT_IF_FLAG(count, FUNCTIONFS_HAS_SS_DESC);
215
216 count = fs_count + hs_count;
217 if (!count)
218 return 0;
219 descs_start = (const void *)counts;
220
221#undef GET_NEXT_COUNT_IF_FLAG
222 }
223
224 /*
225 * Find the end of FS and HS USB descriptors. SS descriptors
226 * are ignored since legacy format does not support them.
227 */
228 descs_end = descs_start;
229 do {
230 if (length < *descs_end)
231 return 0;
232 length -= *descs_end;
233 descs_end += *descs_end;
234 } while (--count);
235
236 /* Allocate legacy descriptors and copy the data. */
237 {
238#pragma GCC diagnostic push
239#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
240 struct {
241 struct usb_functionfs_descs_head header;
242 __u8 descriptors[];
243 } __attribute__((packed)) *out;
244#pragma GCC diagnostic pop
245
246 length = sizeof out->header + (descs_end - descs_start);
247 out = malloc(length);
248 out->header.magic = cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC);
249 out->header.length = cpu_to_le32(length);
250 out->header.fs_count = cpu_to_le32(fs_count);
251 out->header.hs_count = cpu_to_le32(hs_count);
252 memcpy(out->descriptors, descs_start, descs_end - descs_start);
253 *legacy = out;
254 }
255
256 return length;
257}
258
259
260#define STR_INTERFACE_ "Source/Sink"
261
262static const struct {
263 struct usb_functionfs_strings_head header;
264 struct {
265 __le16 code;
266 const char str1[sizeof STR_INTERFACE_];
267 } __attribute__((packed)) lang0;
268} __attribute__((packed)) strings = {
269 .header = {
270 .magic = cpu_to_le32(FUNCTIONFS_STRINGS_MAGIC),
271 .length = cpu_to_le32(sizeof strings),
272 .str_count = cpu_to_le32(1),
273 .lang_count = cpu_to_le32(1),
274 },
275 .lang0 = {
276 cpu_to_le16(0x0409), /* en-us */
277 STR_INTERFACE_,
278 },
279};
280
281#define STR_INTERFACE strings.lang0.str1
282
283
284/******************** Files and Threads Handling ****************************/
285
286struct thread;
287
288static ssize_t read_wrap(struct thread *t, void *buf, size_t nbytes);
289static ssize_t write_wrap(struct thread *t, const void *buf, size_t nbytes);
290static ssize_t ep0_consume(struct thread *t, const void *buf, size_t nbytes);
291static ssize_t fill_in_buf(struct thread *t, void *buf, size_t nbytes);
292static ssize_t empty_out_buf(struct thread *t, const void *buf, size_t nbytes);
293
294
295static struct thread {
296 const char *const filename;
297 size_t buf_size;
298
299 ssize_t (*in)(struct thread *, void *, size_t);
300 const char *const in_name;
301
302 ssize_t (*out)(struct thread *, const void *, size_t);
303 const char *const out_name;
304
305 int fd;
306 pthread_t id;
307 void *buf;
308 ssize_t status;
309} threads[] = {
310 {
311 "ep0", 4 * sizeof(struct usb_functionfs_event),
312 read_wrap, NULL,
313 ep0_consume, "<consume>",
314 0, 0, NULL, 0
315 },
316 {
317 "ep1", 8 * 1024,
318 fill_in_buf, "<in>",
319 write_wrap, NULL,
320 0, 0, NULL, 0
321 },
322 {
323 "ep2", 8 * 1024,
324 read_wrap, NULL,
325 empty_out_buf, "<out>",
326 0, 0, NULL, 0
327 },
328};
329
330
331static void init_thread(struct thread *t)
332{
333 t->buf = malloc(t->buf_size);
334 die_on(!t->buf, "malloc");
335
336 t->fd = open(t->filename, O_RDWR);
337 die_on(t->fd < 0, "%s", t->filename);
338}
339
340static void cleanup_thread(void *arg)
341{
342 struct thread *t = arg;
343 int ret, fd;
344
345 fd = t->fd;
346 if (t->fd < 0)
347 return;
348 t->fd = -1;
349
350 /* test the FIFO ioctls (non-ep0 code paths) */
351 if (t != threads) {
352 ret = ioctl(fd, FUNCTIONFS_FIFO_STATUS);
353 if (ret < 0) {
354 /* ENODEV reported after disconnect */
355 if (errno != ENODEV)
356 err("%s: get fifo status", t->filename);
357 } else if (ret) {
358 warn("%s: unclaimed = %d\n", t->filename, ret);
359 if (ioctl(fd, FUNCTIONFS_FIFO_FLUSH) < 0)
360 err("%s: fifo flush", t->filename);
361 }
362 }
363
364 if (close(fd) < 0)
365 err("%s: close", t->filename);
366
367 free(t->buf);
368 t->buf = NULL;
369}
370
371static void *start_thread_helper(void *arg)
372{
373 const char *name, *op, *in_name, *out_name;
374 struct thread *t = arg;
375 ssize_t ret;
376
377 info("%s: starts\n", t->filename);
378 in_name = t->in_name ? t->in_name : t->filename;
379 out_name = t->out_name ? t->out_name : t->filename;
380
381 pthread_cleanup_push(cleanup_thread, arg);
382
383 for (;;) {
384 pthread_testcancel();
385
386 ret = t->in(t, t->buf, t->buf_size);
387 if (ret > 0) {
388 ret = t->out(t, t->buf, ret);
389 name = out_name;
390 op = "write";
391 } else {
392 name = in_name;
393 op = "read";
394 }
395
396 if (ret > 0) {
397 /* nop */
398 } else if (!ret) {
399 debug("%s: %s: EOF", name, op);
400 break;
401 } else if (errno == EINTR || errno == EAGAIN) {
402 debug("%s: %s", name, op);
403 } else {
404 warn("%s: %s", name, op);
405 break;
406 }
407 }
408
409 pthread_cleanup_pop(1);
410
411 t->status = ret;
412 info("%s: ends\n", t->filename);
413 return NULL;
414}
415
416static void start_thread(struct thread *t)
417{
418 debug("%s: starting\n", t->filename);
419
420 die_on(pthread_create(&t->id, NULL, start_thread_helper, t) < 0,
421 "pthread_create(%s)", t->filename);
422}
423
424static void join_thread(struct thread *t)
425{
426 int ret = pthread_join(t->id, NULL);
427
428 if (ret < 0)
429 err("%s: joining thread", t->filename);
430 else
431 debug("%s: joined\n", t->filename);
432}
433
434
435static ssize_t read_wrap(struct thread *t, void *buf, size_t nbytes)
436{
437 return read(t->fd, buf, nbytes);
438}
439
440static ssize_t write_wrap(struct thread *t, const void *buf, size_t nbytes)
441{
442 return write(t->fd, buf, nbytes);
443}
444
445
446/******************** Empty/Fill buffer routines ****************************/
447
448/* 0 -- stream of zeros, 1 -- i % 63, 2 -- pipe */
449enum pattern { PAT_ZERO, PAT_SEQ, PAT_PIPE };
450static enum pattern pattern;
451
452static ssize_t
453fill_in_buf(struct thread *ignore, void *buf, size_t nbytes)
454{
455 size_t i;
456 __u8 *p;
457
458 (void)ignore;
459
460 switch (pattern) {
461 case PAT_ZERO:
462 memset(buf, 0, nbytes);
463 break;
464
465 case PAT_SEQ:
466 for (p = buf, i = 0; i < nbytes; ++i, ++p)
467 *p = i % 63;
468 break;
469
470 case PAT_PIPE:
471 return fread(buf, 1, nbytes, stdin);
472 }
473
474 return nbytes;
475}
476
477static ssize_t
478empty_out_buf(struct thread *ignore, const void *buf, size_t nbytes)
479{
480 const __u8 *p;
481 __u8 expected;
482 ssize_t ret;
483 size_t len;
484
485 (void)ignore;
486
487 switch (pattern) {
488 case PAT_ZERO:
489 expected = 0;
490 for (p = buf, len = 0; len < nbytes; ++p, ++len)
491 if (*p)
492 goto invalid;
493 break;
494
495 case PAT_SEQ:
496 for (p = buf, len = 0; len < nbytes; ++p, ++len)
497 if (*p != len % 63) {
498 expected = len % 63;
499 goto invalid;
500 }
501 break;
502
503 case PAT_PIPE:
504 ret = fwrite(buf, nbytes, 1, stdout);
505 if (ret > 0)
506 fflush(stdout);
507 break;
508
509invalid:
510 err("bad OUT byte %zd, expected %02x got %02x\n",
511 len, expected, *p);
512 for (p = buf, len = 0; len < nbytes; ++p, ++len) {
513 if (0 == (len % 32))
514 fprintf(stderr, "%4zd:", len);
515 fprintf(stderr, " %02x", *p);
516 if (31 == (len % 32))
517 fprintf(stderr, "\n");
518 }
519 fflush(stderr);
520 errno = EILSEQ;
521 return -1;
522 }
523
524 return len;
525}
526
527
528/******************** Endpoints routines ************************************/
529
530static void handle_setup(const struct usb_ctrlrequest *setup)
531{
532 printf("bRequestType = %d\n", setup->bRequestType);
533 printf("bRequest = %d\n", setup->bRequest);
534 printf("wValue = %d\n", le16_to_cpu(setup->wValue));
535 printf("wIndex = %d\n", le16_to_cpu(setup->wIndex));
536 printf("wLength = %d\n", le16_to_cpu(setup->wLength));
537}
538
539static ssize_t
540ep0_consume(struct thread *ignore, const void *buf, size_t nbytes)
541{
542 static const char *const names[] = {
543 [FUNCTIONFS_BIND] = "BIND",
544 [FUNCTIONFS_UNBIND] = "UNBIND",
545 [FUNCTIONFS_ENABLE] = "ENABLE",
546 [FUNCTIONFS_DISABLE] = "DISABLE",
547 [FUNCTIONFS_SETUP] = "SETUP",
548 [FUNCTIONFS_SUSPEND] = "SUSPEND",
549 [FUNCTIONFS_RESUME] = "RESUME",
550 };
551
552 const struct usb_functionfs_event *event = buf;
553 size_t n;
554
555 (void)ignore;
556
557 for (n = nbytes / sizeof *event; n; --n, ++event)
558 switch (event->type) {
559 case FUNCTIONFS_BIND:
560 case FUNCTIONFS_UNBIND:
561 case FUNCTIONFS_ENABLE:
562 case FUNCTIONFS_DISABLE:
563 case FUNCTIONFS_SETUP:
564 case FUNCTIONFS_SUSPEND:
565 case FUNCTIONFS_RESUME:
566 printf("Event %s\n", names[event->type]);
567 if (event->type == FUNCTIONFS_SETUP)
568 handle_setup(&event->u.setup);
569 break;
570
571 default:
572 printf("Event %03u (unknown)\n", event->type);
573 }
574
575 return nbytes;
576}
577
578static void ep0_init(struct thread *t, bool legacy_descriptors)
579{
580 void *legacy;
581 ssize_t ret;
582 size_t len;
583
584 if (legacy_descriptors) {
585 info("%s: writing descriptors\n", t->filename);
586 goto legacy;
587 }
588
589 info("%s: writing descriptors (in v2 format)\n", t->filename);
590 ret = write(t->fd, &descriptors, sizeof descriptors);
591
592 if (ret < 0 && errno == EINVAL) {
593 warn("%s: new format rejected, trying legacy\n", t->filename);
594legacy:
595 len = descs_to_legacy(&legacy, &descriptors);
596 if (len) {
597 ret = write(t->fd, legacy, len);
598 free(legacy);
599 }
600 }
601 die_on(ret < 0, "%s: write: descriptors", t->filename);
602
603 info("%s: writing strings\n", t->filename);
604 ret = write(t->fd, &strings, sizeof strings);
605 die_on(ret < 0, "%s: write: strings", t->filename);
606}
607
608
609/******************** Main **************************************************/
610
611int main(int argc, char **argv)
612{
613 bool legacy_descriptors;
614 unsigned i;
615
616 legacy_descriptors = argc > 2 && !strcmp(argv[1], "-l");
617
618 init_thread(threads);
619 ep0_init(threads, legacy_descriptors);
620
621 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
622 init_thread(threads + i);
623
624 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
625 start_thread(threads + i);
626
627 start_thread_helper(threads);
628
629 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
630 join_thread(threads + i);
631
632 return 0;
633}
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * ffs-test.c -- user mode filesystem api for usb composite function
4 *
5 * Copyright (C) 2010 Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
7 */
8
9/* $(CROSS_COMPILE)cc -Wall -Wextra -g -o ffs-test ffs-test.c -lpthread */
10
11
12#define _DEFAULT_SOURCE /* for endian.h */
13
14#include <endian.h>
15#include <errno.h>
16#include <fcntl.h>
17#include <pthread.h>
18#include <stdarg.h>
19#include <stdbool.h>
20#include <stdio.h>
21#include <stdlib.h>
22#include <string.h>
23#include <sys/ioctl.h>
24#include <sys/stat.h>
25#include <sys/types.h>
26#include <unistd.h>
27#include <tools/le_byteshift.h>
28
29#include "../../include/uapi/linux/usb/functionfs.h"
30
31
32/******************** Little Endian Handling ********************************/
33
34/*
35 * cpu_to_le16/32 are used when initializing structures, a context where a
36 * function call is not allowed. To solve this, we code cpu_to_le16/32 in a way
37 * that allows them to be used when initializing structures.
38 */
39
40#if __BYTE_ORDER == __LITTLE_ENDIAN
41#define cpu_to_le16(x) (x)
42#define cpu_to_le32(x) (x)
43#else
44#define cpu_to_le16(x) ((((x) >> 8) & 0xffu) | (((x) & 0xffu) << 8))
45#define cpu_to_le32(x) \
46 ((((x) & 0xff000000u) >> 24) | (((x) & 0x00ff0000u) >> 8) | \
47 (((x) & 0x0000ff00u) << 8) | (((x) & 0x000000ffu) << 24))
48#endif
49
50#define le32_to_cpu(x) le32toh(x)
51#define le16_to_cpu(x) le16toh(x)
52
53/******************** Messages and Errors ***********************************/
54
55static const char argv0[] = "ffs-test";
56
57static unsigned verbosity = 7;
58
59static void _msg(unsigned level, const char *fmt, ...)
60{
61 if (level < 2)
62 level = 2;
63 else if (level > 7)
64 level = 7;
65
66 if (level <= verbosity) {
67 static const char levels[8][6] = {
68 [2] = "crit:",
69 [3] = "err: ",
70 [4] = "warn:",
71 [5] = "note:",
72 [6] = "info:",
73 [7] = "dbg: "
74 };
75
76 int _errno = errno;
77 va_list ap;
78
79 fprintf(stderr, "%s: %s ", argv0, levels[level]);
80 va_start(ap, fmt);
81 vfprintf(stderr, fmt, ap);
82 va_end(ap);
83
84 if (fmt[strlen(fmt) - 1] != '\n') {
85 char buffer[128];
86 strerror_r(_errno, buffer, sizeof buffer);
87 fprintf(stderr, ": (-%d) %s\n", _errno, buffer);
88 }
89
90 fflush(stderr);
91 }
92}
93
94#define die(...) (_msg(2, __VA_ARGS__), exit(1))
95#define err(...) _msg(3, __VA_ARGS__)
96#define warn(...) _msg(4, __VA_ARGS__)
97#define note(...) _msg(5, __VA_ARGS__)
98#define info(...) _msg(6, __VA_ARGS__)
99#define debug(...) _msg(7, __VA_ARGS__)
100
101#define die_on(cond, ...) do { \
102 if (cond) \
103 die(__VA_ARGS__); \
104 } while (0)
105
106
107/******************** Descriptors and Strings *******************************/
108
109static const struct {
110 struct usb_functionfs_descs_head_v2 header;
111 __le32 fs_count;
112 __le32 hs_count;
113 __le32 ss_count;
114 struct {
115 struct usb_interface_descriptor intf;
116 struct usb_endpoint_descriptor_no_audio sink;
117 struct usb_endpoint_descriptor_no_audio source;
118 } __attribute__((packed)) fs_descs, hs_descs;
119 struct {
120 struct usb_interface_descriptor intf;
121 struct usb_endpoint_descriptor_no_audio sink;
122 struct usb_ss_ep_comp_descriptor sink_comp;
123 struct usb_endpoint_descriptor_no_audio source;
124 struct usb_ss_ep_comp_descriptor source_comp;
125 } ss_descs;
126} __attribute__((packed)) descriptors = {
127 .header = {
128 .magic = cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC_V2),
129 .flags = cpu_to_le32(FUNCTIONFS_HAS_FS_DESC |
130 FUNCTIONFS_HAS_HS_DESC |
131 FUNCTIONFS_HAS_SS_DESC),
132 .length = cpu_to_le32(sizeof descriptors),
133 },
134 .fs_count = cpu_to_le32(3),
135 .fs_descs = {
136 .intf = {
137 .bLength = sizeof descriptors.fs_descs.intf,
138 .bDescriptorType = USB_DT_INTERFACE,
139 .bNumEndpoints = 2,
140 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
141 .iInterface = 1,
142 },
143 .sink = {
144 .bLength = sizeof descriptors.fs_descs.sink,
145 .bDescriptorType = USB_DT_ENDPOINT,
146 .bEndpointAddress = 1 | USB_DIR_IN,
147 .bmAttributes = USB_ENDPOINT_XFER_BULK,
148 /* .wMaxPacketSize = autoconfiguration (kernel) */
149 },
150 .source = {
151 .bLength = sizeof descriptors.fs_descs.source,
152 .bDescriptorType = USB_DT_ENDPOINT,
153 .bEndpointAddress = 2 | USB_DIR_OUT,
154 .bmAttributes = USB_ENDPOINT_XFER_BULK,
155 /* .wMaxPacketSize = autoconfiguration (kernel) */
156 },
157 },
158 .hs_count = cpu_to_le32(3),
159 .hs_descs = {
160 .intf = {
161 .bLength = sizeof descriptors.fs_descs.intf,
162 .bDescriptorType = USB_DT_INTERFACE,
163 .bNumEndpoints = 2,
164 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
165 .iInterface = 1,
166 },
167 .sink = {
168 .bLength = sizeof descriptors.hs_descs.sink,
169 .bDescriptorType = USB_DT_ENDPOINT,
170 .bEndpointAddress = 1 | USB_DIR_IN,
171 .bmAttributes = USB_ENDPOINT_XFER_BULK,
172 .wMaxPacketSize = cpu_to_le16(512),
173 },
174 .source = {
175 .bLength = sizeof descriptors.hs_descs.source,
176 .bDescriptorType = USB_DT_ENDPOINT,
177 .bEndpointAddress = 2 | USB_DIR_OUT,
178 .bmAttributes = USB_ENDPOINT_XFER_BULK,
179 .wMaxPacketSize = cpu_to_le16(512),
180 .bInterval = 1, /* NAK every 1 uframe */
181 },
182 },
183 .ss_count = cpu_to_le32(5),
184 .ss_descs = {
185 .intf = {
186 .bLength = sizeof descriptors.fs_descs.intf,
187 .bDescriptorType = USB_DT_INTERFACE,
188 .bNumEndpoints = 2,
189 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
190 .iInterface = 1,
191 },
192 .sink = {
193 .bLength = sizeof descriptors.hs_descs.sink,
194 .bDescriptorType = USB_DT_ENDPOINT,
195 .bEndpointAddress = 1 | USB_DIR_IN,
196 .bmAttributes = USB_ENDPOINT_XFER_BULK,
197 .wMaxPacketSize = cpu_to_le16(1024),
198 },
199 .sink_comp = {
200 .bLength = USB_DT_SS_EP_COMP_SIZE,
201 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
202 .bMaxBurst = 0,
203 .bmAttributes = 0,
204 .wBytesPerInterval = 0,
205 },
206 .source = {
207 .bLength = sizeof descriptors.hs_descs.source,
208 .bDescriptorType = USB_DT_ENDPOINT,
209 .bEndpointAddress = 2 | USB_DIR_OUT,
210 .bmAttributes = USB_ENDPOINT_XFER_BULK,
211 .wMaxPacketSize = cpu_to_le16(1024),
212 .bInterval = 1, /* NAK every 1 uframe */
213 },
214 .source_comp = {
215 .bLength = USB_DT_SS_EP_COMP_SIZE,
216 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
217 .bMaxBurst = 0,
218 .bmAttributes = 0,
219 .wBytesPerInterval = 0,
220 },
221 },
222};
223
224static size_t descs_to_legacy(void **legacy, const void *descriptors_v2)
225{
226 const unsigned char *descs_end, *descs_start;
227 __u32 length, fs_count = 0, hs_count = 0, count;
228
229 /* Read v2 header */
230 {
231 const struct {
232 const struct usb_functionfs_descs_head_v2 header;
233 const __le32 counts[];
234 } __attribute__((packed)) *const in = descriptors_v2;
235 const __le32 *counts = in->counts;
236 __u32 flags;
237
238 if (le32_to_cpu(in->header.magic) !=
239 FUNCTIONFS_DESCRIPTORS_MAGIC_V2)
240 return 0;
241 length = le32_to_cpu(in->header.length);
242 if (length <= sizeof in->header)
243 return 0;
244 length -= sizeof in->header;
245 flags = le32_to_cpu(in->header.flags);
246 if (flags & ~(FUNCTIONFS_HAS_FS_DESC | FUNCTIONFS_HAS_HS_DESC |
247 FUNCTIONFS_HAS_SS_DESC))
248 return 0;
249
250#define GET_NEXT_COUNT_IF_FLAG(ret, flg) do { \
251 if (!(flags & (flg))) \
252 break; \
253 if (length < 4) \
254 return 0; \
255 ret = le32_to_cpu(*counts); \
256 length -= 4; \
257 ++counts; \
258 } while (0)
259
260 GET_NEXT_COUNT_IF_FLAG(fs_count, FUNCTIONFS_HAS_FS_DESC);
261 GET_NEXT_COUNT_IF_FLAG(hs_count, FUNCTIONFS_HAS_HS_DESC);
262 GET_NEXT_COUNT_IF_FLAG(count, FUNCTIONFS_HAS_SS_DESC);
263
264 count = fs_count + hs_count;
265 if (!count)
266 return 0;
267 descs_start = (const void *)counts;
268
269#undef GET_NEXT_COUNT_IF_FLAG
270 }
271
272 /*
273 * Find the end of FS and HS USB descriptors. SS descriptors
274 * are ignored since legacy format does not support them.
275 */
276 descs_end = descs_start;
277 do {
278 if (length < *descs_end)
279 return 0;
280 length -= *descs_end;
281 descs_end += *descs_end;
282 } while (--count);
283
284 /* Allocate legacy descriptors and copy the data. */
285 {
286#pragma GCC diagnostic push
287#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
288 struct {
289 struct usb_functionfs_descs_head header;
290 __u8 descriptors[];
291 } __attribute__((packed)) *out;
292#pragma GCC diagnostic pop
293
294 length = sizeof out->header + (descs_end - descs_start);
295 out = malloc(length);
296 out->header.magic = cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC);
297 out->header.length = cpu_to_le32(length);
298 out->header.fs_count = cpu_to_le32(fs_count);
299 out->header.hs_count = cpu_to_le32(hs_count);
300 memcpy(out->descriptors, descs_start, descs_end - descs_start);
301 *legacy = out;
302 }
303
304 return length;
305}
306
307
308#define STR_INTERFACE_ "Source/Sink"
309
310static const struct {
311 struct usb_functionfs_strings_head header;
312 struct {
313 __le16 code;
314 const char str1[sizeof STR_INTERFACE_];
315 } __attribute__((packed)) lang0;
316} __attribute__((packed)) strings = {
317 .header = {
318 .magic = cpu_to_le32(FUNCTIONFS_STRINGS_MAGIC),
319 .length = cpu_to_le32(sizeof strings),
320 .str_count = cpu_to_le32(1),
321 .lang_count = cpu_to_le32(1),
322 },
323 .lang0 = {
324 cpu_to_le16(0x0409), /* en-us */
325 STR_INTERFACE_,
326 },
327};
328
329#define STR_INTERFACE strings.lang0.str1
330
331
332/******************** Files and Threads Handling ****************************/
333
334struct thread;
335
336static ssize_t read_wrap(struct thread *t, void *buf, size_t nbytes);
337static ssize_t write_wrap(struct thread *t, const void *buf, size_t nbytes);
338static ssize_t ep0_consume(struct thread *t, const void *buf, size_t nbytes);
339static ssize_t fill_in_buf(struct thread *t, void *buf, size_t nbytes);
340static ssize_t empty_out_buf(struct thread *t, const void *buf, size_t nbytes);
341
342
343static struct thread {
344 const char *const filename;
345 size_t buf_size;
346
347 ssize_t (*in)(struct thread *, void *, size_t);
348 const char *const in_name;
349
350 ssize_t (*out)(struct thread *, const void *, size_t);
351 const char *const out_name;
352
353 int fd;
354 pthread_t id;
355 void *buf;
356 ssize_t status;
357} threads[] = {
358 {
359 "ep0", 4 * sizeof(struct usb_functionfs_event),
360 read_wrap, NULL,
361 ep0_consume, "<consume>",
362 0, 0, NULL, 0
363 },
364 {
365 "ep1", 8 * 1024,
366 fill_in_buf, "<in>",
367 write_wrap, NULL,
368 0, 0, NULL, 0
369 },
370 {
371 "ep2", 8 * 1024,
372 read_wrap, NULL,
373 empty_out_buf, "<out>",
374 0, 0, NULL, 0
375 },
376};
377
378
379static void init_thread(struct thread *t)
380{
381 t->buf = malloc(t->buf_size);
382 die_on(!t->buf, "malloc");
383
384 t->fd = open(t->filename, O_RDWR);
385 die_on(t->fd < 0, "%s", t->filename);
386}
387
388static void cleanup_thread(void *arg)
389{
390 struct thread *t = arg;
391 int ret, fd;
392
393 fd = t->fd;
394 if (t->fd < 0)
395 return;
396 t->fd = -1;
397
398 /* test the FIFO ioctls (non-ep0 code paths) */
399 if (t != threads) {
400 ret = ioctl(fd, FUNCTIONFS_FIFO_STATUS);
401 if (ret < 0) {
402 /* ENODEV reported after disconnect */
403 if (errno != ENODEV)
404 err("%s: get fifo status", t->filename);
405 } else if (ret) {
406 warn("%s: unclaimed = %d\n", t->filename, ret);
407 if (ioctl(fd, FUNCTIONFS_FIFO_FLUSH) < 0)
408 err("%s: fifo flush", t->filename);
409 }
410 }
411
412 if (close(fd) < 0)
413 err("%s: close", t->filename);
414
415 free(t->buf);
416 t->buf = NULL;
417}
418
419static void *start_thread_helper(void *arg)
420{
421 const char *name, *op, *in_name, *out_name;
422 struct thread *t = arg;
423 ssize_t ret;
424
425 info("%s: starts\n", t->filename);
426 in_name = t->in_name ? t->in_name : t->filename;
427 out_name = t->out_name ? t->out_name : t->filename;
428
429 pthread_cleanup_push(cleanup_thread, arg);
430
431 for (;;) {
432 pthread_testcancel();
433
434 ret = t->in(t, t->buf, t->buf_size);
435 if (ret > 0) {
436 ret = t->out(t, t->buf, ret);
437 name = out_name;
438 op = "write";
439 } else {
440 name = in_name;
441 op = "read";
442 }
443
444 if (ret > 0) {
445 /* nop */
446 } else if (!ret) {
447 debug("%s: %s: EOF", name, op);
448 break;
449 } else if (errno == EINTR || errno == EAGAIN) {
450 debug("%s: %s", name, op);
451 } else {
452 warn("%s: %s", name, op);
453 break;
454 }
455 }
456
457 pthread_cleanup_pop(1);
458
459 t->status = ret;
460 info("%s: ends\n", t->filename);
461 return NULL;
462}
463
464static void start_thread(struct thread *t)
465{
466 debug("%s: starting\n", t->filename);
467
468 die_on(pthread_create(&t->id, NULL, start_thread_helper, t) < 0,
469 "pthread_create(%s)", t->filename);
470}
471
472static void join_thread(struct thread *t)
473{
474 int ret = pthread_join(t->id, NULL);
475
476 if (ret < 0)
477 err("%s: joining thread", t->filename);
478 else
479 debug("%s: joined\n", t->filename);
480}
481
482
483static ssize_t read_wrap(struct thread *t, void *buf, size_t nbytes)
484{
485 return read(t->fd, buf, nbytes);
486}
487
488static ssize_t write_wrap(struct thread *t, const void *buf, size_t nbytes)
489{
490 return write(t->fd, buf, nbytes);
491}
492
493
494/******************** Empty/Fill buffer routines ****************************/
495
496/* 0 -- stream of zeros, 1 -- i % 63, 2 -- pipe */
497enum pattern { PAT_ZERO, PAT_SEQ, PAT_PIPE };
498static enum pattern pattern;
499
500static ssize_t
501fill_in_buf(struct thread *ignore, void *buf, size_t nbytes)
502{
503 size_t i;
504 __u8 *p;
505
506 (void)ignore;
507
508 switch (pattern) {
509 case PAT_ZERO:
510 memset(buf, 0, nbytes);
511 break;
512
513 case PAT_SEQ:
514 for (p = buf, i = 0; i < nbytes; ++i, ++p)
515 *p = i % 63;
516 break;
517
518 case PAT_PIPE:
519 return fread(buf, 1, nbytes, stdin);
520 }
521
522 return nbytes;
523}
524
525static ssize_t
526empty_out_buf(struct thread *ignore, const void *buf, size_t nbytes)
527{
528 const __u8 *p;
529 __u8 expected;
530 ssize_t ret;
531 size_t len;
532
533 (void)ignore;
534
535 switch (pattern) {
536 case PAT_ZERO:
537 expected = 0;
538 for (p = buf, len = 0; len < nbytes; ++p, ++len)
539 if (*p)
540 goto invalid;
541 break;
542
543 case PAT_SEQ:
544 for (p = buf, len = 0; len < nbytes; ++p, ++len)
545 if (*p != len % 63) {
546 expected = len % 63;
547 goto invalid;
548 }
549 break;
550
551 case PAT_PIPE:
552 ret = fwrite(buf, nbytes, 1, stdout);
553 if (ret > 0)
554 fflush(stdout);
555 break;
556
557invalid:
558 err("bad OUT byte %zd, expected %02x got %02x\n",
559 len, expected, *p);
560 for (p = buf, len = 0; len < nbytes; ++p, ++len) {
561 if (0 == (len % 32))
562 fprintf(stderr, "%4zd:", len);
563 fprintf(stderr, " %02x", *p);
564 if (31 == (len % 32))
565 fprintf(stderr, "\n");
566 }
567 fflush(stderr);
568 errno = EILSEQ;
569 return -1;
570 }
571
572 return len;
573}
574
575
576/******************** Endpoints routines ************************************/
577
578static void handle_setup(const struct usb_ctrlrequest *setup)
579{
580 printf("bRequestType = %d\n", setup->bRequestType);
581 printf("bRequest = %d\n", setup->bRequest);
582 printf("wValue = %d\n", le16_to_cpu(setup->wValue));
583 printf("wIndex = %d\n", le16_to_cpu(setup->wIndex));
584 printf("wLength = %d\n", le16_to_cpu(setup->wLength));
585}
586
587static ssize_t
588ep0_consume(struct thread *ignore, const void *buf, size_t nbytes)
589{
590 static const char *const names[] = {
591 [FUNCTIONFS_BIND] = "BIND",
592 [FUNCTIONFS_UNBIND] = "UNBIND",
593 [FUNCTIONFS_ENABLE] = "ENABLE",
594 [FUNCTIONFS_DISABLE] = "DISABLE",
595 [FUNCTIONFS_SETUP] = "SETUP",
596 [FUNCTIONFS_SUSPEND] = "SUSPEND",
597 [FUNCTIONFS_RESUME] = "RESUME",
598 };
599
600 const struct usb_functionfs_event *event = buf;
601 size_t n;
602
603 (void)ignore;
604
605 for (n = nbytes / sizeof *event; n; --n, ++event)
606 switch (event->type) {
607 case FUNCTIONFS_BIND:
608 case FUNCTIONFS_UNBIND:
609 case FUNCTIONFS_ENABLE:
610 case FUNCTIONFS_DISABLE:
611 case FUNCTIONFS_SETUP:
612 case FUNCTIONFS_SUSPEND:
613 case FUNCTIONFS_RESUME:
614 printf("Event %s\n", names[event->type]);
615 if (event->type == FUNCTIONFS_SETUP)
616 handle_setup(&event->u.setup);
617 break;
618
619 default:
620 printf("Event %03u (unknown)\n", event->type);
621 }
622
623 return nbytes;
624}
625
626static void ep0_init(struct thread *t, bool legacy_descriptors)
627{
628 void *legacy;
629 ssize_t ret;
630 size_t len;
631
632 if (legacy_descriptors) {
633 info("%s: writing descriptors\n", t->filename);
634 goto legacy;
635 }
636
637 info("%s: writing descriptors (in v2 format)\n", t->filename);
638 ret = write(t->fd, &descriptors, sizeof descriptors);
639
640 if (ret < 0 && errno == EINVAL) {
641 warn("%s: new format rejected, trying legacy\n", t->filename);
642legacy:
643 len = descs_to_legacy(&legacy, &descriptors);
644 if (len) {
645 ret = write(t->fd, legacy, len);
646 free(legacy);
647 }
648 }
649 die_on(ret < 0, "%s: write: descriptors", t->filename);
650
651 info("%s: writing strings\n", t->filename);
652 ret = write(t->fd, &strings, sizeof strings);
653 die_on(ret < 0, "%s: write: strings", t->filename);
654}
655
656
657/******************** Main **************************************************/
658
659int main(int argc, char **argv)
660{
661 bool legacy_descriptors;
662 unsigned i;
663
664 legacy_descriptors = argc > 2 && !strcmp(argv[1], "-l");
665
666 init_thread(threads);
667 ep0_init(threads, legacy_descriptors);
668
669 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
670 init_thread(threads + i);
671
672 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
673 start_thread(threads + i);
674
675 start_thread_helper(threads);
676
677 for (i = 1; i < sizeof threads / sizeof *threads; ++i)
678 join_thread(threads + i);
679
680 return 0;
681}