2 * ffs-test.c.c -- user mode filesystem api for usb composite function
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <mina86@mina86.com>
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.
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.
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
22 /* $(CROSS_COMPILE)cc -Wall -Wextra -g -o ffs-test ffs-test.c -lpthread */
25 #define _BSD_SOURCE /* for endian.h */
35 #include <sys/ioctl.h>
37 #include <sys/types.h>
39 #include <tools/le_byteshift.h>
41 #include "../../include/uapi/linux/usb/functionfs.h"
44 /******************** Little Endian Handling ********************************/
46 #define cpu_to_le16(x) htole16(x)
47 #define cpu_to_le32(x) htole32(x)
48 #define le32_to_cpu(x) le32toh(x)
49 #define le16_to_cpu(x) le16toh(x)
52 /******************** Messages and Errors ***********************************/
54 static const char argv0
[] = "ffs-test";
56 static unsigned verbosity
= 7;
58 static void _msg(unsigned level
, const char *fmt
, ...)
65 if (level
<= verbosity
) {
66 static const char levels
[8][6] = {
78 fprintf(stderr
, "%s: %s ", argv0
, levels
[level
]);
80 vfprintf(stderr
, fmt
, ap
);
83 if (fmt
[strlen(fmt
) - 1] != '\n') {
85 strerror_r(_errno
, buffer
, sizeof buffer
);
86 fprintf(stderr
, ": (-%d) %s\n", _errno
, buffer
);
93 #define die(...) (_msg(2, __VA_ARGS__), exit(1))
94 #define err(...) _msg(3, __VA_ARGS__)
95 #define warn(...) _msg(4, __VA_ARGS__)
96 #define note(...) _msg(5, __VA_ARGS__)
97 #define info(...) _msg(6, __VA_ARGS__)
98 #define debug(...) _msg(7, __VA_ARGS__)
100 #define die_on(cond, ...) do { \
106 /******************** Descriptors and Strings *******************************/
108 static const struct {
109 struct usb_functionfs_descs_head header
;
111 struct usb_interface_descriptor intf
;
112 struct usb_endpoint_descriptor_no_audio sink
;
113 struct usb_endpoint_descriptor_no_audio source
;
114 } __attribute__((packed
)) fs_descs
, hs_descs
;
115 } __attribute__((packed
)) descriptors
= {
117 .magic
= cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC
),
118 .length
= cpu_to_le32(sizeof descriptors
),
124 .bLength
= sizeof descriptors
.fs_descs
.intf
,
125 .bDescriptorType
= USB_DT_INTERFACE
,
127 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
131 .bLength
= sizeof descriptors
.fs_descs
.sink
,
132 .bDescriptorType
= USB_DT_ENDPOINT
,
133 .bEndpointAddress
= 1 | USB_DIR_IN
,
134 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
135 /* .wMaxPacketSize = autoconfiguration (kernel) */
138 .bLength
= sizeof descriptors
.fs_descs
.source
,
139 .bDescriptorType
= USB_DT_ENDPOINT
,
140 .bEndpointAddress
= 2 | USB_DIR_OUT
,
141 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
142 /* .wMaxPacketSize = autoconfiguration (kernel) */
147 .bLength
= sizeof descriptors
.fs_descs
.intf
,
148 .bDescriptorType
= USB_DT_INTERFACE
,
150 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
154 .bLength
= sizeof descriptors
.hs_descs
.sink
,
155 .bDescriptorType
= USB_DT_ENDPOINT
,
156 .bEndpointAddress
= 1 | USB_DIR_IN
,
157 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
158 .wMaxPacketSize
= cpu_to_le16(512),
161 .bLength
= sizeof descriptors
.hs_descs
.source
,
162 .bDescriptorType
= USB_DT_ENDPOINT
,
163 .bEndpointAddress
= 2 | USB_DIR_OUT
,
164 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
165 .wMaxPacketSize
= cpu_to_le16(512),
166 .bInterval
= 1, /* NAK every 1 uframe */
172 #define STR_INTERFACE_ "Source/Sink"
174 static const struct {
175 struct usb_functionfs_strings_head header
;
178 const char str1
[sizeof STR_INTERFACE_
];
179 } __attribute__((packed
)) lang0
;
180 } __attribute__((packed
)) strings
= {
182 .magic
= cpu_to_le32(FUNCTIONFS_STRINGS_MAGIC
),
183 .length
= cpu_to_le32(sizeof strings
),
184 .str_count
= cpu_to_le32(1),
185 .lang_count
= cpu_to_le32(1),
188 cpu_to_le16(0x0409), /* en-us */
193 #define STR_INTERFACE strings.lang0.str1
196 /******************** Files and Threads Handling ****************************/
200 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
);
201 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
);
202 static ssize_t
ep0_consume(struct thread
*t
, const void *buf
, size_t nbytes
);
203 static ssize_t
fill_in_buf(struct thread
*t
, void *buf
, size_t nbytes
);
204 static ssize_t
empty_out_buf(struct thread
*t
, const void *buf
, size_t nbytes
);
207 static struct thread
{
208 const char *const filename
;
211 ssize_t (*in
)(struct thread
*, void *, size_t);
212 const char *const in_name
;
214 ssize_t (*out
)(struct thread
*, const void *, size_t);
215 const char *const out_name
;
223 "ep0", 4 * sizeof(struct usb_functionfs_event
),
225 ep0_consume
, "<consume>",
237 empty_out_buf
, "<out>",
243 static void init_thread(struct thread
*t
)
245 t
->buf
= malloc(t
->buf_size
);
246 die_on(!t
->buf
, "malloc");
248 t
->fd
= open(t
->filename
, O_RDWR
);
249 die_on(t
->fd
< 0, "%s", t
->filename
);
252 static void cleanup_thread(void *arg
)
254 struct thread
*t
= arg
;
262 /* test the FIFO ioctls (non-ep0 code paths) */
264 ret
= ioctl(fd
, FUNCTIONFS_FIFO_STATUS
);
266 /* ENODEV reported after disconnect */
268 err("%s: get fifo status", t
->filename
);
270 warn("%s: unclaimed = %d\n", t
->filename
, ret
);
271 if (ioctl(fd
, FUNCTIONFS_FIFO_FLUSH
) < 0)
272 err("%s: fifo flush", t
->filename
);
277 err("%s: close", t
->filename
);
283 static void *start_thread_helper(void *arg
)
285 const char *name
, *op
, *in_name
, *out_name
;
286 struct thread
*t
= arg
;
289 info("%s: starts\n", t
->filename
);
290 in_name
= t
->in_name
? t
->in_name
: t
->filename
;
291 out_name
= t
->out_name
? t
->out_name
: t
->filename
;
293 pthread_cleanup_push(cleanup_thread
, arg
);
296 pthread_testcancel();
298 ret
= t
->in(t
, t
->buf
, t
->buf_size
);
300 ret
= t
->out(t
, t
->buf
, ret
);
311 debug("%s: %s: EOF", name
, op
);
313 } else if (errno
== EINTR
|| errno
== EAGAIN
) {
314 debug("%s: %s", name
, op
);
316 warn("%s: %s", name
, op
);
321 pthread_cleanup_pop(1);
324 info("%s: ends\n", t
->filename
);
328 static void start_thread(struct thread
*t
)
330 debug("%s: starting\n", t
->filename
);
332 die_on(pthread_create(&t
->id
, NULL
, start_thread_helper
, t
) < 0,
333 "pthread_create(%s)", t
->filename
);
336 static void join_thread(struct thread
*t
)
338 int ret
= pthread_join(t
->id
, NULL
);
341 err("%s: joining thread", t
->filename
);
343 debug("%s: joined\n", t
->filename
);
347 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
)
349 return read(t
->fd
, buf
, nbytes
);
352 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
)
354 return write(t
->fd
, buf
, nbytes
);
358 /******************** Empty/Fill buffer routines ****************************/
360 /* 0 -- stream of zeros, 1 -- i % 63, 2 -- pipe */
361 enum pattern
{ PAT_ZERO
, PAT_SEQ
, PAT_PIPE
};
362 static enum pattern pattern
;
365 fill_in_buf(struct thread
*ignore
, void *buf
, size_t nbytes
)
374 memset(buf
, 0, nbytes
);
378 for (p
= buf
, i
= 0; i
< nbytes
; ++i
, ++p
)
383 return fread(buf
, 1, nbytes
, stdin
);
390 empty_out_buf(struct thread
*ignore
, const void *buf
, size_t nbytes
)
402 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
408 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
409 if (*p
!= len
% 63) {
416 ret
= fwrite(buf
, nbytes
, 1, stdout
);
422 err("bad OUT byte %zd, expected %02x got %02x\n",
424 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
) {
426 fprintf(stderr
, "%4zd:", len
);
427 fprintf(stderr
, " %02x", *p
);
428 if (31 == (len
% 32))
429 fprintf(stderr
, "\n");
440 /******************** Endpoints routines ************************************/
442 static void handle_setup(const struct usb_ctrlrequest
*setup
)
444 printf("bRequestType = %d\n", setup
->bRequestType
);
445 printf("bRequest = %d\n", setup
->bRequest
);
446 printf("wValue = %d\n", le16_to_cpu(setup
->wValue
));
447 printf("wIndex = %d\n", le16_to_cpu(setup
->wIndex
));
448 printf("wLength = %d\n", le16_to_cpu(setup
->wLength
));
452 ep0_consume(struct thread
*ignore
, const void *buf
, size_t nbytes
)
454 static const char *const names
[] = {
455 [FUNCTIONFS_BIND
] = "BIND",
456 [FUNCTIONFS_UNBIND
] = "UNBIND",
457 [FUNCTIONFS_ENABLE
] = "ENABLE",
458 [FUNCTIONFS_DISABLE
] = "DISABLE",
459 [FUNCTIONFS_SETUP
] = "SETUP",
460 [FUNCTIONFS_SUSPEND
] = "SUSPEND",
461 [FUNCTIONFS_RESUME
] = "RESUME",
464 const struct usb_functionfs_event
*event
= buf
;
469 for (n
= nbytes
/ sizeof *event
; n
; --n
, ++event
)
470 switch (event
->type
) {
471 case FUNCTIONFS_BIND
:
472 case FUNCTIONFS_UNBIND
:
473 case FUNCTIONFS_ENABLE
:
474 case FUNCTIONFS_DISABLE
:
475 case FUNCTIONFS_SETUP
:
476 case FUNCTIONFS_SUSPEND
:
477 case FUNCTIONFS_RESUME
:
478 printf("Event %s\n", names
[event
->type
]);
479 if (event
->type
== FUNCTIONFS_SETUP
)
480 handle_setup(&event
->u
.setup
);
484 printf("Event %03u (unknown)\n", event
->type
);
490 static void ep0_init(struct thread
*t
)
494 info("%s: writing descriptors\n", t
->filename
);
495 ret
= write(t
->fd
, &descriptors
, sizeof descriptors
);
496 die_on(ret
< 0, "%s: write: descriptors", t
->filename
);
498 info("%s: writing strings\n", t
->filename
);
499 ret
= write(t
->fd
, &strings
, sizeof strings
);
500 die_on(ret
< 0, "%s: write: strings", t
->filename
);
504 /******************** Main **************************************************/
510 /* XXX TODO: Argument parsing missing */
512 init_thread(threads
);
515 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
516 init_thread(threads
+ i
);
518 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
519 start_thread(threads
+ i
);
521 start_thread_helper(threads
);
523 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
524 join_thread(threads
+ i
);