2 * ffs-test.c.c -- user mode filesystem api for usb composite function
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <m.nazarewicz@samsung.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>
40 #include "../../include/linux/usb/functionfs.h"
43 /******************** Little Endian Handling ********************************/
45 #define cpu_to_le16(x) htole16(x)
46 #define cpu_to_le32(x) htole32(x)
47 #define le32_to_cpu(x) le32toh(x)
48 #define le16_to_cpu(x) le16toh(x)
50 static inline __u16
get_unaligned_le16(const void *_ptr
)
52 const __u8
*ptr
= _ptr
;
53 return ptr
[0] | (ptr
[1] << 8);
56 static inline __u32
get_unaligned_le32(const void *_ptr
)
58 const __u8
*ptr
= _ptr
;
59 return ptr
[0] | (ptr
[1] << 8) | (ptr
[2] << 16) | (ptr
[3] << 24);
62 static inline void put_unaligned_le16(__u16 val
, void *_ptr
)
69 static inline void put_unaligned_le32(__u32 val
, void *_ptr
)
79 /******************** Messages and Errors ***********************************/
81 static const char argv0
[] = "ffs-test";
83 static unsigned verbosity
= 7;
85 static void _msg(unsigned level
, const char *fmt
, ...)
92 if (level
<= verbosity
) {
93 static const char levels
[8][6] = {
105 fprintf(stderr
, "%s: %s ", argv0
, levels
[level
]);
107 vfprintf(stderr
, fmt
, ap
);
110 if (fmt
[strlen(fmt
) - 1] != '\n') {
112 strerror_r(_errno
, buffer
, sizeof buffer
);
113 fprintf(stderr
, ": (-%d) %s\n", _errno
, buffer
);
120 #define die(...) (_msg(2, __VA_ARGS__), exit(1))
121 #define err(...) _msg(3, __VA_ARGS__)
122 #define warn(...) _msg(4, __VA_ARGS__)
123 #define note(...) _msg(5, __VA_ARGS__)
124 #define info(...) _msg(6, __VA_ARGS__)
125 #define debug(...) _msg(7, __VA_ARGS__)
127 #define die_on(cond, ...) do { \
133 /******************** Descriptors and Strings *******************************/
135 static const struct {
136 struct usb_functionfs_descs_head header
;
138 struct usb_interface_descriptor intf
;
139 struct usb_endpoint_descriptor_no_audio sink
;
140 struct usb_endpoint_descriptor_no_audio source
;
141 } __attribute__((packed
)) fs_descs
, hs_descs
;
142 } __attribute__((packed
)) descriptors
= {
144 .magic
= cpu_to_le32(FUNCTIONFS_DESCRIPTORS_MAGIC
),
145 .length
= cpu_to_le32(sizeof descriptors
),
151 .bLength
= sizeof descriptors
.fs_descs
.intf
,
152 .bDescriptorType
= USB_DT_INTERFACE
,
154 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
158 .bLength
= sizeof descriptors
.fs_descs
.sink
,
159 .bDescriptorType
= USB_DT_ENDPOINT
,
160 .bEndpointAddress
= 1 | USB_DIR_IN
,
161 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
162 /* .wMaxPacketSize = autoconfiguration (kernel) */
165 .bLength
= sizeof descriptors
.fs_descs
.source
,
166 .bDescriptorType
= USB_DT_ENDPOINT
,
167 .bEndpointAddress
= 2 | USB_DIR_OUT
,
168 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
169 /* .wMaxPacketSize = autoconfiguration (kernel) */
174 .bLength
= sizeof descriptors
.fs_descs
.intf
,
175 .bDescriptorType
= USB_DT_INTERFACE
,
177 .bInterfaceClass
= USB_CLASS_VENDOR_SPEC
,
181 .bLength
= sizeof descriptors
.hs_descs
.sink
,
182 .bDescriptorType
= USB_DT_ENDPOINT
,
183 .bEndpointAddress
= 1 | USB_DIR_IN
,
184 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
185 .wMaxPacketSize
= cpu_to_le16(512),
188 .bLength
= sizeof descriptors
.hs_descs
.source
,
189 .bDescriptorType
= USB_DT_ENDPOINT
,
190 .bEndpointAddress
= 2 | USB_DIR_OUT
,
191 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
192 .wMaxPacketSize
= cpu_to_le16(512),
193 .bInterval
= 1, /* NAK every 1 uframe */
199 #define STR_INTERFACE_ "Source/Sink"
201 static const struct {
202 struct usb_functionfs_strings_head header
;
205 const char str1
[sizeof STR_INTERFACE_
];
206 } __attribute__((packed
)) lang0
;
207 } __attribute__((packed
)) strings
= {
209 .magic
= cpu_to_le32(FUNCTIONFS_STRINGS_MAGIC
),
210 .length
= cpu_to_le32(sizeof strings
),
211 .str_count
= cpu_to_le32(1),
212 .lang_count
= cpu_to_le32(1),
215 cpu_to_le16(0x0409), /* en-us */
220 #define STR_INTERFACE strings.lang0.str1
223 /******************** Files and Threads Handling ****************************/
227 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
);
228 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
);
229 static ssize_t
ep0_consume(struct thread
*t
, const void *buf
, size_t nbytes
);
230 static ssize_t
fill_in_buf(struct thread
*t
, void *buf
, size_t nbytes
);
231 static ssize_t
empty_out_buf(struct thread
*t
, const void *buf
, size_t nbytes
);
234 static struct thread
{
235 const char *const filename
;
238 ssize_t (*in
)(struct thread
*, void *, size_t);
239 const char *const in_name
;
241 ssize_t (*out
)(struct thread
*, const void *, size_t);
242 const char *const out_name
;
250 "ep0", 4 * sizeof(struct usb_functionfs_event
),
252 ep0_consume
, "<consume>",
264 empty_out_buf
, "<out>",
270 static void init_thread(struct thread
*t
)
272 t
->buf
= malloc(t
->buf_size
);
273 die_on(!t
->buf
, "malloc");
275 t
->fd
= open(t
->filename
, O_RDWR
);
276 die_on(t
->fd
< 0, "%s", t
->filename
);
279 static void cleanup_thread(void *arg
)
281 struct thread
*t
= arg
;
289 /* test the FIFO ioctls (non-ep0 code paths) */
291 ret
= ioctl(fd
, FUNCTIONFS_FIFO_STATUS
);
293 /* ENODEV reported after disconnect */
295 err("%s: get fifo status", t
->filename
);
297 warn("%s: unclaimed = %d\n", t
->filename
, ret
);
298 if (ioctl(fd
, FUNCTIONFS_FIFO_FLUSH
) < 0)
299 err("%s: fifo flush", t
->filename
);
304 err("%s: close", t
->filename
);
310 static void *start_thread_helper(void *arg
)
312 const char *name
, *op
, *in_name
, *out_name
;
313 struct thread
*t
= arg
;
316 info("%s: starts\n", t
->filename
);
317 in_name
= t
->in_name
? t
->in_name
: t
->filename
;
318 out_name
= t
->out_name
? t
->out_name
: t
->filename
;
320 pthread_cleanup_push(cleanup_thread
, arg
);
323 pthread_testcancel();
325 ret
= t
->in(t
, t
->buf
, t
->buf_size
);
327 ret
= t
->out(t
, t
->buf
, t
->buf_size
);
338 debug("%s: %s: EOF", name
, op
);
340 } else if (errno
== EINTR
|| errno
== EAGAIN
) {
341 debug("%s: %s", name
, op
);
343 warn("%s: %s", name
, op
);
348 pthread_cleanup_pop(1);
351 info("%s: ends\n", t
->filename
);
355 static void start_thread(struct thread
*t
)
357 debug("%s: starting\n", t
->filename
);
359 die_on(pthread_create(&t
->id
, NULL
, start_thread_helper
, t
) < 0,
360 "pthread_create(%s)", t
->filename
);
363 static void join_thread(struct thread
*t
)
365 int ret
= pthread_join(t
->id
, NULL
);
368 err("%s: joining thread", t
->filename
);
370 debug("%s: joined\n", t
->filename
);
374 static ssize_t
read_wrap(struct thread
*t
, void *buf
, size_t nbytes
)
376 return read(t
->fd
, buf
, nbytes
);
379 static ssize_t
write_wrap(struct thread
*t
, const void *buf
, size_t nbytes
)
381 return write(t
->fd
, buf
, nbytes
);
385 /******************** Empty/Fill buffer routines ****************************/
387 /* 0 -- stream of zeros, 1 -- i % 63, 2 -- pipe */
388 enum pattern
{ PAT_ZERO
, PAT_SEQ
, PAT_PIPE
};
389 static enum pattern pattern
;
392 fill_in_buf(struct thread
*ignore
, void *buf
, size_t nbytes
)
401 memset(buf
, 0, nbytes
);
405 for (p
= buf
, i
= 0; i
< nbytes
; ++i
, ++p
)
410 return fread(buf
, 1, nbytes
, stdin
);
417 empty_out_buf(struct thread
*ignore
, const void *buf
, size_t nbytes
)
429 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
435 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
)
436 if (*p
!= len
% 63) {
443 ret
= fwrite(buf
, nbytes
, 1, stdout
);
449 err("bad OUT byte %zd, expected %02x got %02x\n",
451 for (p
= buf
, len
= 0; len
< nbytes
; ++p
, ++len
) {
453 fprintf(stderr
, "%4zd:", len
);
454 fprintf(stderr
, " %02x", *p
);
455 if (31 == (len
% 32))
456 fprintf(stderr
, "\n");
467 /******************** Endpoints routines ************************************/
469 static void handle_setup(const struct usb_ctrlrequest
*setup
)
471 printf("bRequestType = %d\n", setup
->bRequestType
);
472 printf("bRequest = %d\n", setup
->bRequest
);
473 printf("wValue = %d\n", le16_to_cpu(setup
->wValue
));
474 printf("wIndex = %d\n", le16_to_cpu(setup
->wIndex
));
475 printf("wLength = %d\n", le16_to_cpu(setup
->wLength
));
479 ep0_consume(struct thread
*ignore
, const void *buf
, size_t nbytes
)
481 static const char *const names
[] = {
482 [FUNCTIONFS_BIND
] = "BIND",
483 [FUNCTIONFS_UNBIND
] = "UNBIND",
484 [FUNCTIONFS_ENABLE
] = "ENABLE",
485 [FUNCTIONFS_DISABLE
] = "DISABLE",
486 [FUNCTIONFS_SETUP
] = "SETUP",
487 [FUNCTIONFS_SUSPEND
] = "SUSPEND",
488 [FUNCTIONFS_RESUME
] = "RESUME",
491 const struct usb_functionfs_event
*event
= buf
;
496 for (n
= nbytes
/ sizeof *event
; n
; --n
, ++event
)
497 switch (event
->type
) {
498 case FUNCTIONFS_BIND
:
499 case FUNCTIONFS_UNBIND
:
500 case FUNCTIONFS_ENABLE
:
501 case FUNCTIONFS_DISABLE
:
502 case FUNCTIONFS_SETUP
:
503 case FUNCTIONFS_SUSPEND
:
504 case FUNCTIONFS_RESUME
:
505 printf("Event %s\n", names
[event
->type
]);
506 if (event
->type
== FUNCTIONFS_SETUP
)
507 handle_setup(&event
->u
.setup
);
511 printf("Event %03u (unknown)\n", event
->type
);
517 static void ep0_init(struct thread
*t
)
521 info("%s: writing descriptors\n", t
->filename
);
522 ret
= write(t
->fd
, &descriptors
, sizeof descriptors
);
523 die_on(ret
< 0, "%s: write: descriptors", t
->filename
);
525 info("%s: writing strings\n", t
->filename
);
526 ret
= write(t
->fd
, &strings
, sizeof strings
);
527 die_on(ret
< 0, "%s: write: strings", t
->filename
);
531 /******************** Main **************************************************/
537 /* XXX TODO: Argument parsing missing */
539 init_thread(threads
);
542 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
543 init_thread(threads
+ i
);
545 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
546 start_thread(threads
+ i
);
548 start_thread_helper(threads
);
550 for (i
= 1; i
< sizeof threads
/ sizeof *threads
; ++i
)
551 join_thread(threads
+ i
);