1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * ffs-test.c -- user mode filesystem api for usb composite function
5 * Copyright (C) 2010 Samsung Electronics
6 * Author: Michal Nazarewicz <mina86@mina86.com>
9 /* $(CROSS_COMPILE)cc -Wall -Wextra -g -o ffs-test ffs-test.c -lpthread */
12 #define _DEFAULT_SOURCE /* for endian.h */
23 #include <sys/ioctl.h>
25 #include <sys/types.h>
27 #include <tools/le_byteshift.h>
29 #include "../../include/uapi/linux/usb/functionfs.h"
32 /******************** Little Endian Handling ********************************/
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.
40 #if __BYTE_ORDER == __LITTLE_ENDIAN
41 #define cpu_to_le16(x) (x)
42 #define cpu_to_le32(x) (x)
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))
50 #define le32_to_cpu(x) le32toh(x)
51 #define le16_to_cpu(x) le16toh(x)
53 /******************** Messages and Errors ***********************************/
55 static const char argv0
[] = "ffs-test";
57 static unsigned verbosity
= 7;
59 static void _msg(unsigned level
, const char *fmt
, ...)
66 if (level
<= verbosity
) {
67 static const char levels
[8][6] = {
79 fprintf(stderr
, "%s: %s ", argv0
, levels
[level
]);
81 vfprintf(stderr
, fmt
, ap
);
84 if (fmt
[strlen(fmt
) - 1] != '\n') {
86 strerror_r(_errno
, buffer
, sizeof buffer
);
87 fprintf(stderr
, ": (-%d) %s\n", _errno
, buffer
);
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__)
101 #define die_on(cond, ...) do { \
107 /******************** Descriptors and Strings *******************************/
109 static const struct {
110 struct usb_functionfs_descs_head_v2 header
;
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
;
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
;
126 } __attribute__((packed
)) descriptors
= {
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
),
134 .fs_count
= cpu_to_le32(3),
137 .bLength
= sizeof descriptors
.fs_descs
.intf
,
138 .bDescriptorType
= USB_DT_INTERFACE
,
140 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
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) */
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) */
158 .hs_count
= cpu_to_le32(3),
161 .bLength
= sizeof descriptors
.fs_descs
.intf
,
162 .bDescriptorType
= USB_DT_INTERFACE
,
164 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
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),
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 */
183 .ss_count
= cpu_to_le32(5),
186 .bLength
= sizeof descriptors
.fs_descs
.intf
,
187 .bDescriptorType
= USB_DT_INTERFACE
,
189 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
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),
200 .bLength
= USB_DT_SS_EP_COMP_SIZE
,
201 .bDescriptorType
= USB_DT_SS_ENDPOINT_COMP
,
204 .wBytesPerInterval
= 0,
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 */
215 .bLength
= USB_DT_SS_EP_COMP_SIZE
,
216 .bDescriptorType
= USB_DT_SS_ENDPOINT_COMP
,
219 .wBytesPerInterval
= 0,
224 static size_t descs_to_legacy(void **legacy
, const void *descriptors_v2
)
226 const unsigned char *descs_end
, *descs_start
;
227 __u32 length
, fs_count
= 0, hs_count
= 0, count
;
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
;
238 if (le32_to_cpu(in
->header
.magic
) !=
239 FUNCTIONFS_DESCRIPTORS_MAGIC_V2
)
241 length
= le32_to_cpu(in
->header
.length
);
242 if (length
<= sizeof in
->header
)
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
))
250 #define GET_NEXT_COUNT_IF_FLAG(ret, flg) do { \
251 if (!(flags & (flg))) \
255 ret = le32_to_cpu(*counts); \
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
);
264 count
= fs_count
+ hs_count
;
267 descs_start
= (const void *)counts
;
269 #undef GET_NEXT_COUNT_IF_FLAG
273 * Find the end of FS and HS USB descriptors. SS descriptors
274 * are ignored since legacy format does not support them.
276 descs_end
= descs_start
;
278 if (length
< *descs_end
)
280 length
-= *descs_end
;
281 descs_end
+= *descs_end
;
284 /* Allocate legacy descriptors and copy the data. */
286 #pragma GCC diagnostic push
287 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
289 struct usb_functionfs_descs_head header
;
291 } __attribute__((packed
)) *out
;
292 #pragma GCC diagnostic pop
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
);
308 #define STR_INTERFACE_ "Source/Sink"
310 static const struct {
311 struct usb_functionfs_strings_head header
;
314 const char str1
[sizeof STR_INTERFACE_
];
315 } __attribute__((packed
)) lang0
;
316 } __attribute__((packed
)) strings
= {
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),
324 cpu_to_le16(0x0409), /* en-us */
329 #define STR_INTERFACE strings.lang0.str1
332 /******************** Files and Threads Handling ****************************/
336 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
);
337 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
);
338 static ssize_t
ep0_consume(struct thread
*t
, const void *buf
, size_t nbytes
);
339 static ssize_t
fill_in_buf(struct thread
*t
, void *buf
, size_t nbytes
);
340 static ssize_t
empty_out_buf(struct thread
*t
, const void *buf
, size_t nbytes
);
343 static struct thread
{
344 const char *const filename
;
347 ssize_t (*in
)(struct thread
*, void *, size_t);
348 const char *const in_name
;
350 ssize_t (*out
)(struct thread
*, const void *, size_t);
351 const char *const out_name
;
359 "ep0", 4 * sizeof(struct usb_functionfs_event
),
361 ep0_consume
, "<consume>",
373 empty_out_buf
, "<out>",
379 static void init_thread(struct thread
*t
)
381 t
->buf
= malloc(t
->buf_size
);
382 die_on(!t
->buf
, "malloc");
384 t
->fd
= open(t
->filename
, O_RDWR
);
385 die_on(t
->fd
< 0, "%s", t
->filename
);
388 static void cleanup_thread(void *arg
)
390 struct thread
*t
= arg
;
398 /* test the FIFO ioctls (non-ep0 code paths) */
400 ret
= ioctl(fd
, FUNCTIONFS_FIFO_STATUS
);
402 /* ENODEV reported after disconnect */
404 err("%s: get fifo status", t
->filename
);
406 warn("%s: unclaimed = %d\n", t
->filename
, ret
);
407 if (ioctl(fd
, FUNCTIONFS_FIFO_FLUSH
) < 0)
408 err("%s: fifo flush", t
->filename
);
413 err("%s: close", t
->filename
);
419 static void *start_thread_helper(void *arg
)
421 const char *name
, *op
, *in_name
, *out_name
;
422 struct thread
*t
= arg
;
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
;
429 pthread_cleanup_push(cleanup_thread
, arg
);
432 pthread_testcancel();
434 ret
= t
->in(t
, t
->buf
, t
->buf_size
);
436 ret
= t
->out(t
, t
->buf
, ret
);
447 debug("%s: %s: EOF", name
, op
);
449 } else if (errno
== EINTR
|| errno
== EAGAIN
) {
450 debug("%s: %s", name
, op
);
452 warn("%s: %s", name
, op
);
457 pthread_cleanup_pop(1);
460 info("%s: ends\n", t
->filename
);
464 static void start_thread(struct thread
*t
)
466 debug("%s: starting\n", t
->filename
);
468 die_on(pthread_create(&t
->id
, NULL
, start_thread_helper
, t
) < 0,
469 "pthread_create(%s)", t
->filename
);
472 static void join_thread(struct thread
*t
)
474 int ret
= pthread_join(t
->id
, NULL
);
477 err("%s: joining thread", t
->filename
);
479 debug("%s: joined\n", t
->filename
);
483 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
)
485 return read(t
->fd
, buf
, nbytes
);
488 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
)
490 return write(t
->fd
, buf
, nbytes
);
494 /******************** Empty/Fill buffer routines ****************************/
496 /* 0 -- stream of zeros, 1 -- i % 63, 2 -- pipe */
497 enum pattern
{ PAT_ZERO
, PAT_SEQ
, PAT_PIPE
};
498 static enum pattern pattern
;
501 fill_in_buf(struct thread
*ignore
, void *buf
, size_t nbytes
)
510 memset(buf
, 0, nbytes
);
514 for (p
= buf
, i
= 0; i
< nbytes
; ++i
, ++p
)
519 return fread(buf
, 1, nbytes
, stdin
);
526 empty_out_buf(struct thread
*ignore
, const void *buf
, size_t nbytes
)
538 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
544 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
545 if (*p
!= len
% 63) {
552 ret
= fwrite(buf
, nbytes
, 1, stdout
);
558 err("bad OUT byte %zd, expected %02x got %02x\n",
560 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
) {
562 fprintf(stderr
, "%4zd:", len
);
563 fprintf(stderr
, " %02x", *p
);
564 if (31 == (len
% 32))
565 fprintf(stderr
, "\n");
576 /******************** Endpoints routines ************************************/
578 static void handle_setup(const struct usb_ctrlrequest
*setup
)
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
));
588 ep0_consume(struct thread
*ignore
, const void *buf
, size_t nbytes
)
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",
600 const struct usb_functionfs_event
*event
= buf
;
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
);
620 printf("Event %03u (unknown)\n", event
->type
);
626 static void ep0_init(struct thread
*t
, bool legacy_descriptors
)
632 if (legacy_descriptors
) {
633 info("%s: writing descriptors\n", t
->filename
);
637 info("%s: writing descriptors (in v2 format)\n", t
->filename
);
638 ret
= write(t
->fd
, &descriptors
, sizeof descriptors
);
640 if (ret
< 0 && errno
== EINVAL
) {
641 warn("%s: new format rejected, trying legacy\n", t
->filename
);
643 len
= descs_to_legacy(&legacy
, &descriptors
);
645 ret
= write(t
->fd
, legacy
, len
);
649 die_on(ret
< 0, "%s: write: descriptors", t
->filename
);
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
);
657 /******************** Main **************************************************/
659 int main(int argc
, char **argv
)
661 bool legacy_descriptors
;
664 legacy_descriptors
= argc
> 2 && !strcmp(argv
[1], "-l");
666 init_thread(threads
);
667 ep0_init(threads
, legacy_descriptors
);
669 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
670 init_thread(threads
+ i
);
672 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
673 start_thread(threads
+ i
);
675 start_thread_helper(threads
);
677 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
678 join_thread(threads
+ i
);