2 * f_sourcesink.c - USB peripheral source/sink configuration driver
4 * Copyright (C) 2003-2008 David Brownell
5 * Copyright (C) 2008 by Nokia Corporation
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.
13 /* #define VERBOSE_DEBUG */
15 #include <linux/slab.h>
16 #include <linux/kernel.h>
17 #include <linux/device.h>
18 #include <linux/module.h>
19 #include <linux/usb/composite.h>
20 #include <linux/err.h>
26 * SOURCE/SINK FUNCTION ... a primary testing vehicle for USB peripheral
29 * This just sinks bulk packets OUT to the peripheral and sources them IN
30 * to the host, optionally with specific data patterns for integrity tests.
31 * As such it supports basic functionality and load tests.
33 * In terms of control messaging, this supports all the standard requests
34 * plus two that support control-OUT tests. If the optional "autoresume"
35 * mode is enabled, it provides good functional coverage for the "USBCV"
36 * test harness from USB-IF.
39 struct usb_function function;
42 struct usb_ep *out_ep;
43 struct usb_ep *iso_in_ep;
44 struct usb_ep *iso_out_ep;
48 unsigned isoc_interval;
49 unsigned isoc_maxpacket;
51 unsigned isoc_maxburst;
57 static inline struct f_sourcesink *func_to_ss(struct usb_function *f)
59 return container_of(f, struct f_sourcesink, function);
62 /*-------------------------------------------------------------------------*/
64 static struct usb_interface_descriptor source_sink_intf_alt0 = {
65 .bLength = USB_DT_INTERFACE_SIZE,
66 .bDescriptorType = USB_DT_INTERFACE,
68 .bAlternateSetting = 0,
70 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
71 /* .iInterface = DYNAMIC */
74 static struct usb_interface_descriptor source_sink_intf_alt1 = {
75 .bLength = USB_DT_INTERFACE_SIZE,
76 .bDescriptorType = USB_DT_INTERFACE,
78 .bAlternateSetting = 1,
80 .bInterfaceClass = USB_CLASS_VENDOR_SPEC,
81 /* .iInterface = DYNAMIC */
84 /* full speed support: */
86 static struct usb_endpoint_descriptor fs_source_desc = {
87 .bLength = USB_DT_ENDPOINT_SIZE,
88 .bDescriptorType = USB_DT_ENDPOINT,
90 .bEndpointAddress = USB_DIR_IN,
91 .bmAttributes = USB_ENDPOINT_XFER_BULK,
94 static struct usb_endpoint_descriptor fs_sink_desc = {
95 .bLength = USB_DT_ENDPOINT_SIZE,
96 .bDescriptorType = USB_DT_ENDPOINT,
98 .bEndpointAddress = USB_DIR_OUT,
99 .bmAttributes = USB_ENDPOINT_XFER_BULK,
102 static struct usb_endpoint_descriptor fs_iso_source_desc = {
103 .bLength = USB_DT_ENDPOINT_SIZE,
104 .bDescriptorType = USB_DT_ENDPOINT,
106 .bEndpointAddress = USB_DIR_IN,
107 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
108 .wMaxPacketSize = cpu_to_le16(1023),
112 static struct usb_endpoint_descriptor fs_iso_sink_desc = {
113 .bLength = USB_DT_ENDPOINT_SIZE,
114 .bDescriptorType = USB_DT_ENDPOINT,
116 .bEndpointAddress = USB_DIR_OUT,
117 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
118 .wMaxPacketSize = cpu_to_le16(1023),
122 static struct usb_descriptor_header *fs_source_sink_descs[] = {
123 (struct usb_descriptor_header *) &source_sink_intf_alt0,
124 (struct usb_descriptor_header *) &fs_sink_desc,
125 (struct usb_descriptor_header *) &fs_source_desc,
126 (struct usb_descriptor_header *) &source_sink_intf_alt1,
127 #define FS_ALT_IFC_1_OFFSET 3
128 (struct usb_descriptor_header *) &fs_sink_desc,
129 (struct usb_descriptor_header *) &fs_source_desc,
130 (struct usb_descriptor_header *) &fs_iso_sink_desc,
131 (struct usb_descriptor_header *) &fs_iso_source_desc,
135 /* high speed support: */
137 static struct usb_endpoint_descriptor hs_source_desc = {
138 .bLength = USB_DT_ENDPOINT_SIZE,
139 .bDescriptorType = USB_DT_ENDPOINT,
141 .bmAttributes = USB_ENDPOINT_XFER_BULK,
142 .wMaxPacketSize = cpu_to_le16(512),
145 static struct usb_endpoint_descriptor hs_sink_desc = {
146 .bLength = USB_DT_ENDPOINT_SIZE,
147 .bDescriptorType = USB_DT_ENDPOINT,
149 .bmAttributes = USB_ENDPOINT_XFER_BULK,
150 .wMaxPacketSize = cpu_to_le16(512),
153 static struct usb_endpoint_descriptor hs_iso_source_desc = {
154 .bLength = USB_DT_ENDPOINT_SIZE,
155 .bDescriptorType = USB_DT_ENDPOINT,
157 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
158 .wMaxPacketSize = cpu_to_le16(1024),
162 static struct usb_endpoint_descriptor hs_iso_sink_desc = {
163 .bLength = USB_DT_ENDPOINT_SIZE,
164 .bDescriptorType = USB_DT_ENDPOINT,
166 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
167 .wMaxPacketSize = cpu_to_le16(1024),
171 static struct usb_descriptor_header *hs_source_sink_descs[] = {
172 (struct usb_descriptor_header *) &source_sink_intf_alt0,
173 (struct usb_descriptor_header *) &hs_source_desc,
174 (struct usb_descriptor_header *) &hs_sink_desc,
175 (struct usb_descriptor_header *) &source_sink_intf_alt1,
176 #define HS_ALT_IFC_1_OFFSET 3
177 (struct usb_descriptor_header *) &hs_source_desc,
178 (struct usb_descriptor_header *) &hs_sink_desc,
179 (struct usb_descriptor_header *) &hs_iso_source_desc,
180 (struct usb_descriptor_header *) &hs_iso_sink_desc,
184 /* super speed support: */
186 static struct usb_endpoint_descriptor ss_source_desc = {
187 .bLength = USB_DT_ENDPOINT_SIZE,
188 .bDescriptorType = USB_DT_ENDPOINT,
190 .bmAttributes = USB_ENDPOINT_XFER_BULK,
191 .wMaxPacketSize = cpu_to_le16(1024),
194 static struct usb_ss_ep_comp_descriptor ss_source_comp_desc = {
195 .bLength = USB_DT_SS_EP_COMP_SIZE,
196 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
200 .wBytesPerInterval = 0,
203 static struct usb_endpoint_descriptor ss_sink_desc = {
204 .bLength = USB_DT_ENDPOINT_SIZE,
205 .bDescriptorType = USB_DT_ENDPOINT,
207 .bmAttributes = USB_ENDPOINT_XFER_BULK,
208 .wMaxPacketSize = cpu_to_le16(1024),
211 static struct usb_ss_ep_comp_descriptor ss_sink_comp_desc = {
212 .bLength = USB_DT_SS_EP_COMP_SIZE,
213 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
217 .wBytesPerInterval = 0,
220 static struct usb_endpoint_descriptor ss_iso_source_desc = {
221 .bLength = USB_DT_ENDPOINT_SIZE,
222 .bDescriptorType = USB_DT_ENDPOINT,
224 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
225 .wMaxPacketSize = cpu_to_le16(1024),
229 static struct usb_ss_ep_comp_descriptor ss_iso_source_comp_desc = {
230 .bLength = USB_DT_SS_EP_COMP_SIZE,
231 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
235 .wBytesPerInterval = cpu_to_le16(1024),
238 static struct usb_endpoint_descriptor ss_iso_sink_desc = {
239 .bLength = USB_DT_ENDPOINT_SIZE,
240 .bDescriptorType = USB_DT_ENDPOINT,
242 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
243 .wMaxPacketSize = cpu_to_le16(1024),
247 static struct usb_ss_ep_comp_descriptor ss_iso_sink_comp_desc = {
248 .bLength = USB_DT_SS_EP_COMP_SIZE,
249 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
253 .wBytesPerInterval = cpu_to_le16(1024),
256 static struct usb_descriptor_header *ss_source_sink_descs[] = {
257 (struct usb_descriptor_header *) &source_sink_intf_alt0,
258 (struct usb_descriptor_header *) &ss_source_desc,
259 (struct usb_descriptor_header *) &ss_source_comp_desc,
260 (struct usb_descriptor_header *) &ss_sink_desc,
261 (struct usb_descriptor_header *) &ss_sink_comp_desc,
262 (struct usb_descriptor_header *) &source_sink_intf_alt1,
263 #define SS_ALT_IFC_1_OFFSET 5
264 (struct usb_descriptor_header *) &ss_source_desc,
265 (struct usb_descriptor_header *) &ss_source_comp_desc,
266 (struct usb_descriptor_header *) &ss_sink_desc,
267 (struct usb_descriptor_header *) &ss_sink_comp_desc,
268 (struct usb_descriptor_header *) &ss_iso_source_desc,
269 (struct usb_descriptor_header *) &ss_iso_source_comp_desc,
270 (struct usb_descriptor_header *) &ss_iso_sink_desc,
271 (struct usb_descriptor_header *) &ss_iso_sink_comp_desc,
275 /* function-specific strings: */
277 static struct usb_string strings_sourcesink[] = {
278 [0].s = "source and sink data",
279 { } /* end of list */
282 static struct usb_gadget_strings stringtab_sourcesink = {
283 .language = 0x0409, /* en-us */
284 .strings = strings_sourcesink,
287 static struct usb_gadget_strings *sourcesink_strings[] = {
288 &stringtab_sourcesink,
292 /*-------------------------------------------------------------------------*/
294 static inline struct usb_request *ss_alloc_ep_req(struct usb_ep *ep, int len)
296 return alloc_ep_req(ep, len);
299 static void disable_ep(struct usb_composite_dev *cdev, struct usb_ep *ep)
303 value = usb_ep_disable(ep);
305 DBG(cdev, "disable %s --> %d\n", ep->name, value);
308 void disable_endpoints(struct usb_composite_dev *cdev,
309 struct usb_ep *in, struct usb_ep *out,
310 struct usb_ep *iso_in, struct usb_ep *iso_out)
312 disable_ep(cdev, in);
313 disable_ep(cdev, out);
315 disable_ep(cdev, iso_in);
317 disable_ep(cdev, iso_out);
321 sourcesink_bind(struct usb_configuration *c, struct usb_function *f)
323 struct usb_composite_dev *cdev = c->cdev;
324 struct f_sourcesink *ss = func_to_ss(f);
328 /* allocate interface ID(s) */
329 id = usb_interface_id(c, f);
332 source_sink_intf_alt0.bInterfaceNumber = id;
333 source_sink_intf_alt1.bInterfaceNumber = id;
335 /* allocate bulk endpoints */
336 ss->in_ep = usb_ep_autoconfig(cdev->gadget, &fs_source_desc);
339 ERROR(cdev, "%s: can't autoconfigure on %s\n",
340 f->name, cdev->gadget->name);
344 ss->out_ep = usb_ep_autoconfig(cdev->gadget, &fs_sink_desc);
348 /* sanity check the isoc module parameters */
349 if (ss->isoc_interval < 1)
350 ss->isoc_interval = 1;
351 if (ss->isoc_interval > 16)
352 ss->isoc_interval = 16;
353 if (ss->isoc_mult > 2)
355 if (ss->isoc_maxburst > 15)
356 ss->isoc_maxburst = 15;
358 /* fill in the FS isoc descriptors from the module parameters */
359 fs_iso_source_desc.wMaxPacketSize = ss->isoc_maxpacket > 1023 ?
360 1023 : ss->isoc_maxpacket;
361 fs_iso_source_desc.bInterval = ss->isoc_interval;
362 fs_iso_sink_desc.wMaxPacketSize = ss->isoc_maxpacket > 1023 ?
363 1023 : ss->isoc_maxpacket;
364 fs_iso_sink_desc.bInterval = ss->isoc_interval;
366 /* allocate iso endpoints */
367 ss->iso_in_ep = usb_ep_autoconfig(cdev->gadget, &fs_iso_source_desc);
371 ss->iso_out_ep = usb_ep_autoconfig(cdev->gadget, &fs_iso_sink_desc);
372 if (!ss->iso_out_ep) {
373 usb_ep_autoconfig_release(ss->iso_in_ep);
374 ss->iso_in_ep = NULL;
377 * We still want to work even if the UDC doesn't have isoc
378 * endpoints, so null out the alt interface that contains
381 fs_source_sink_descs[FS_ALT_IFC_1_OFFSET] = NULL;
382 hs_source_sink_descs[HS_ALT_IFC_1_OFFSET] = NULL;
383 ss_source_sink_descs[SS_ALT_IFC_1_OFFSET] = NULL;
386 if (ss->isoc_maxpacket > 1024)
387 ss->isoc_maxpacket = 1024;
389 /* support high speed hardware */
390 hs_source_desc.bEndpointAddress = fs_source_desc.bEndpointAddress;
391 hs_sink_desc.bEndpointAddress = fs_sink_desc.bEndpointAddress;
394 * Fill in the HS isoc descriptors from the module parameters.
395 * We assume that the user knows what they are doing and won't
396 * give parameters that their UDC doesn't support.
398 hs_iso_source_desc.wMaxPacketSize = ss->isoc_maxpacket;
399 hs_iso_source_desc.wMaxPacketSize |= ss->isoc_mult << 11;
400 hs_iso_source_desc.bInterval = ss->isoc_interval;
401 hs_iso_source_desc.bEndpointAddress =
402 fs_iso_source_desc.bEndpointAddress;
404 hs_iso_sink_desc.wMaxPacketSize = ss->isoc_maxpacket;
405 hs_iso_sink_desc.wMaxPacketSize |= ss->isoc_mult << 11;
406 hs_iso_sink_desc.bInterval = ss->isoc_interval;
407 hs_iso_sink_desc.bEndpointAddress = fs_iso_sink_desc.bEndpointAddress;
409 /* support super speed hardware */
410 ss_source_desc.bEndpointAddress =
411 fs_source_desc.bEndpointAddress;
412 ss_sink_desc.bEndpointAddress =
413 fs_sink_desc.bEndpointAddress;
416 * Fill in the SS isoc descriptors from the module parameters.
417 * We assume that the user knows what they are doing and won't
418 * give parameters that their UDC doesn't support.
420 ss_iso_source_desc.wMaxPacketSize = ss->isoc_maxpacket;
421 ss_iso_source_desc.bInterval = ss->isoc_interval;
422 ss_iso_source_comp_desc.bmAttributes = ss->isoc_mult;
423 ss_iso_source_comp_desc.bMaxBurst = ss->isoc_maxburst;
424 ss_iso_source_comp_desc.wBytesPerInterval = ss->isoc_maxpacket *
425 (ss->isoc_mult + 1) * (ss->isoc_maxburst + 1);
426 ss_iso_source_desc.bEndpointAddress =
427 fs_iso_source_desc.bEndpointAddress;
429 ss_iso_sink_desc.wMaxPacketSize = ss->isoc_maxpacket;
430 ss_iso_sink_desc.bInterval = ss->isoc_interval;
431 ss_iso_sink_comp_desc.bmAttributes = ss->isoc_mult;
432 ss_iso_sink_comp_desc.bMaxBurst = ss->isoc_maxburst;
433 ss_iso_sink_comp_desc.wBytesPerInterval = ss->isoc_maxpacket *
434 (ss->isoc_mult + 1) * (ss->isoc_maxburst + 1);
435 ss_iso_sink_desc.bEndpointAddress = fs_iso_sink_desc.bEndpointAddress;
437 ret = usb_assign_descriptors(f, fs_source_sink_descs,
438 hs_source_sink_descs, ss_source_sink_descs, NULL);
442 DBG(cdev, "%s speed %s: IN/%s, OUT/%s, ISO-IN/%s, ISO-OUT/%s\n",
443 (gadget_is_superspeed(c->cdev->gadget) ? "super" :
444 (gadget_is_dualspeed(c->cdev->gadget) ? "dual" : "full")),
445 f->name, ss->in_ep->name, ss->out_ep->name,
446 ss->iso_in_ep ? ss->iso_in_ep->name : "<none>",
447 ss->iso_out_ep ? ss->iso_out_ep->name : "<none>");
452 sourcesink_free_func(struct usb_function *f)
454 struct f_ss_opts *opts;
456 opts = container_of(f->fi, struct f_ss_opts, func_inst);
458 mutex_lock(&opts->lock);
460 mutex_unlock(&opts->lock);
462 usb_free_all_descriptors(f);
463 kfree(func_to_ss(f));
466 /* optionally require specific source/sink data patterns */
467 static int check_read_data(struct f_sourcesink *ss, struct usb_request *req)
471 struct usb_composite_dev *cdev = ss->function.config->cdev;
472 int max_packet_size = le16_to_cpu(ss->out_ep->desc->wMaxPacketSize);
474 if (ss->pattern == 2)
477 for (i = 0; i < req->actual; i++, buf++) {
478 switch (ss->pattern) {
480 /* all-zeroes has no synchronization issues */
486 /* "mod63" stays in sync with short-terminated transfers,
487 * OR otherwise when host and gadget agree on how large
488 * each usb transfer request should be. Resync is done
489 * with set_interface or set_config. (We *WANT* it to
490 * get quickly out of sync if controllers or their drivers
491 * stutter for any reason, including buffer duplication...)
494 if (*buf == (u8)((i % max_packet_size) % 63))
498 ERROR(cdev, "bad OUT byte, buf[%d] = %d\n", i, *buf);
499 usb_ep_set_halt(ss->out_ep);
505 static void reinit_write_data(struct usb_ep *ep, struct usb_request *req)
509 int max_packet_size = le16_to_cpu(ep->desc->wMaxPacketSize);
510 struct f_sourcesink *ss = ep->driver_data;
512 switch (ss->pattern) {
514 memset(req->buf, 0, req->length);
517 for (i = 0; i < req->length; i++)
518 *buf++ = (u8) ((i % max_packet_size) % 63);
525 static void source_sink_complete(struct usb_ep *ep, struct usb_request *req)
527 struct usb_composite_dev *cdev;
528 struct f_sourcesink *ss = ep->driver_data;
529 int status = req->status;
531 /* driver_data will be null if ep has been disabled */
535 cdev = ss->function.config->cdev;
539 case 0: /* normal completion? */
540 if (ep == ss->out_ep) {
541 check_read_data(ss, req);
542 if (ss->pattern != 2)
543 memset(req->buf, 0x55, req->length);
547 /* this endpoint is normally active while we're configured */
548 case -ECONNABORTED: /* hardware forced ep reset */
549 case -ECONNRESET: /* request dequeued */
550 case -ESHUTDOWN: /* disconnect from host */
551 VDBG(cdev, "%s gone (%d), %d/%d\n", ep->name, status,
552 req->actual, req->length);
553 if (ep == ss->out_ep)
554 check_read_data(ss, req);
555 free_ep_req(ep, req);
558 case -EOVERFLOW: /* buffer overrun on read means that
559 * we didn't provide a big enough
564 DBG(cdev, "%s complete --> %d, %d/%d\n", ep->name,
565 status, req->actual, req->length);
567 case -EREMOTEIO: /* short read */
571 status = usb_ep_queue(ep, req, GFP_ATOMIC);
573 ERROR(cdev, "kill %s: resubmit %d bytes --> %d\n",
574 ep->name, req->length, status);
576 /* FIXME recover later ... somehow */
580 static int source_sink_start_ep(struct f_sourcesink *ss, bool is_in,
581 bool is_iso, int speed)
584 struct usb_request *req;
585 int i, size, qlen, status = 0;
589 case USB_SPEED_SUPER:
590 size = ss->isoc_maxpacket *
591 (ss->isoc_mult + 1) *
592 (ss->isoc_maxburst + 1);
595 size = ss->isoc_maxpacket * (ss->isoc_mult + 1);
598 size = ss->isoc_maxpacket > 1023 ?
599 1023 : ss->isoc_maxpacket;
602 ep = is_in ? ss->iso_in_ep : ss->iso_out_ep;
605 ep = is_in ? ss->in_ep : ss->out_ep;
606 qlen = ss->bulk_qlen;
610 for (i = 0; i < qlen; i++) {
611 req = ss_alloc_ep_req(ep, size);
615 req->complete = source_sink_complete;
617 reinit_write_data(ep, req);
618 else if (ss->pattern != 2)
619 memset(req->buf, 0x55, req->length);
621 status = usb_ep_queue(ep, req, GFP_ATOMIC);
623 struct usb_composite_dev *cdev;
625 cdev = ss->function.config->cdev;
626 ERROR(cdev, "start %s%s %s --> %d\n",
627 is_iso ? "ISO-" : "", is_in ? "IN" : "OUT",
629 free_ep_req(ep, req);
637 static void disable_source_sink(struct f_sourcesink *ss)
639 struct usb_composite_dev *cdev;
641 cdev = ss->function.config->cdev;
642 disable_endpoints(cdev, ss->in_ep, ss->out_ep, ss->iso_in_ep,
644 VDBG(cdev, "%s disabled\n", ss->function.name);
648 enable_source_sink(struct usb_composite_dev *cdev, struct f_sourcesink *ss,
652 int speed = cdev->gadget->speed;
655 /* one bulk endpoint writes (sources) zeroes IN (to the host) */
657 result = config_ep_by_speed(cdev->gadget, &(ss->function), ep);
660 result = usb_ep_enable(ep);
663 ep->driver_data = ss;
665 result = source_sink_start_ep(ss, true, false, speed);
673 /* one bulk endpoint reads (sinks) anything OUT (from the host) */
675 result = config_ep_by_speed(cdev->gadget, &(ss->function), ep);
678 result = usb_ep_enable(ep);
681 ep->driver_data = ss;
683 result = source_sink_start_ep(ss, false, false, speed);
694 /* one iso endpoint writes (sources) zeroes IN (to the host) */
697 result = config_ep_by_speed(cdev->gadget, &(ss->function), ep);
700 result = usb_ep_enable(ep);
703 ep->driver_data = ss;
705 result = source_sink_start_ep(ss, true, true, speed);
715 /* one iso endpoint reads (sinks) anything OUT (from the host) */
718 result = config_ep_by_speed(cdev->gadget, &(ss->function), ep);
721 result = usb_ep_enable(ep);
724 ep->driver_data = ss;
726 result = source_sink_start_ep(ss, false, true, speed);
735 DBG(cdev, "%s enabled, alt intf %d\n", ss->function.name, alt);
739 static int sourcesink_set_alt(struct usb_function *f,
740 unsigned intf, unsigned alt)
742 struct f_sourcesink *ss = func_to_ss(f);
743 struct usb_composite_dev *cdev = f->config->cdev;
745 disable_source_sink(ss);
746 return enable_source_sink(cdev, ss, alt);
749 static int sourcesink_get_alt(struct usb_function *f, unsigned intf)
751 struct f_sourcesink *ss = func_to_ss(f);
756 static void sourcesink_disable(struct usb_function *f)
758 struct f_sourcesink *ss = func_to_ss(f);
760 disable_source_sink(ss);
763 /*-------------------------------------------------------------------------*/
765 static int sourcesink_setup(struct usb_function *f,
766 const struct usb_ctrlrequest *ctrl)
768 struct usb_configuration *c = f->config;
769 struct usb_request *req = c->cdev->req;
770 int value = -EOPNOTSUPP;
771 u16 w_index = le16_to_cpu(ctrl->wIndex);
772 u16 w_value = le16_to_cpu(ctrl->wValue);
773 u16 w_length = le16_to_cpu(ctrl->wLength);
775 req->length = USB_COMP_EP0_BUFSIZ;
777 /* composite driver infrastructure handles everything except
778 * the two control test requests.
780 switch (ctrl->bRequest) {
783 * These are the same vendor-specific requests supported by
784 * Intel's USB 2.0 compliance test devices. We exceed that
785 * device spec by allowing multiple-packet requests.
787 * NOTE: the Control-OUT data stays in req->buf ... better
788 * would be copying it into a scratch buffer, so that other
789 * requests may safely intervene.
791 case 0x5b: /* control WRITE test -- fill the buffer */
792 if (ctrl->bRequestType != (USB_DIR_OUT|USB_TYPE_VENDOR))
794 if (w_value || w_index)
796 /* just read that many bytes into the buffer */
797 if (w_length > req->length)
801 case 0x5c: /* control READ test -- return the buffer */
802 if (ctrl->bRequestType != (USB_DIR_IN|USB_TYPE_VENDOR))
804 if (w_value || w_index)
806 /* expect those bytes are still in the buffer; send back */
807 if (w_length > req->length)
815 "unknown control req%02x.%02x v%04x i%04x l%d\n",
816 ctrl->bRequestType, ctrl->bRequest,
817 w_value, w_index, w_length);
820 /* respond with data transfer or status phase? */
822 VDBG(c->cdev, "source/sink req%02x.%02x v%04x i%04x l%d\n",
823 ctrl->bRequestType, ctrl->bRequest,
824 w_value, w_index, w_length);
827 value = usb_ep_queue(c->cdev->gadget->ep0, req, GFP_ATOMIC);
829 ERROR(c->cdev, "source/sink response, err %d\n",
833 /* device either stalls (value < 0) or reports success */
837 static struct usb_function *source_sink_alloc_func(
838 struct usb_function_instance *fi)
840 struct f_sourcesink *ss;
841 struct f_ss_opts *ss_opts;
843 ss = kzalloc(sizeof(*ss), GFP_KERNEL);
847 ss_opts = container_of(fi, struct f_ss_opts, func_inst);
849 mutex_lock(&ss_opts->lock);
851 mutex_unlock(&ss_opts->lock);
853 ss->pattern = ss_opts->pattern;
854 ss->isoc_interval = ss_opts->isoc_interval;
855 ss->isoc_maxpacket = ss_opts->isoc_maxpacket;
856 ss->isoc_mult = ss_opts->isoc_mult;
857 ss->isoc_maxburst = ss_opts->isoc_maxburst;
858 ss->buflen = ss_opts->bulk_buflen;
859 ss->bulk_qlen = ss_opts->bulk_qlen;
860 ss->iso_qlen = ss_opts->iso_qlen;
862 ss->function.name = "source/sink";
863 ss->function.bind = sourcesink_bind;
864 ss->function.set_alt = sourcesink_set_alt;
865 ss->function.get_alt = sourcesink_get_alt;
866 ss->function.disable = sourcesink_disable;
867 ss->function.setup = sourcesink_setup;
868 ss->function.strings = sourcesink_strings;
870 ss->function.free_func = sourcesink_free_func;
872 return &ss->function;
875 static inline struct f_ss_opts *to_f_ss_opts(struct config_item *item)
877 return container_of(to_config_group(item), struct f_ss_opts,
881 static void ss_attr_release(struct config_item *item)
883 struct f_ss_opts *ss_opts = to_f_ss_opts(item);
885 usb_put_function_instance(&ss_opts->func_inst);
888 static struct configfs_item_operations ss_item_ops = {
889 .release = ss_attr_release,
892 static ssize_t f_ss_opts_pattern_show(struct config_item *item, char *page)
894 struct f_ss_opts *opts = to_f_ss_opts(item);
897 mutex_lock(&opts->lock);
898 result = sprintf(page, "%u\n", opts->pattern);
899 mutex_unlock(&opts->lock);
904 static ssize_t f_ss_opts_pattern_store(struct config_item *item,
905 const char *page, size_t len)
907 struct f_ss_opts *opts = to_f_ss_opts(item);
911 mutex_lock(&opts->lock);
917 ret = kstrtou8(page, 0, &num);
921 if (num != 0 && num != 1 && num != 2) {
929 mutex_unlock(&opts->lock);
933 CONFIGFS_ATTR(f_ss_opts_, pattern);
935 static ssize_t f_ss_opts_isoc_interval_show(struct config_item *item, char *page)
937 struct f_ss_opts *opts = to_f_ss_opts(item);
940 mutex_lock(&opts->lock);
941 result = sprintf(page, "%u\n", opts->isoc_interval);
942 mutex_unlock(&opts->lock);
947 static ssize_t f_ss_opts_isoc_interval_store(struct config_item *item,
948 const char *page, size_t len)
950 struct f_ss_opts *opts = to_f_ss_opts(item);
954 mutex_lock(&opts->lock);
960 ret = kstrtou8(page, 0, &num);
969 opts->isoc_interval = num;
972 mutex_unlock(&opts->lock);
976 CONFIGFS_ATTR(f_ss_opts_, isoc_interval);
978 static ssize_t f_ss_opts_isoc_maxpacket_show(struct config_item *item, char *page)
980 struct f_ss_opts *opts = to_f_ss_opts(item);
983 mutex_lock(&opts->lock);
984 result = sprintf(page, "%u\n", opts->isoc_maxpacket);
985 mutex_unlock(&opts->lock);
990 static ssize_t f_ss_opts_isoc_maxpacket_store(struct config_item *item,
991 const char *page, size_t len)
993 struct f_ss_opts *opts = to_f_ss_opts(item);
997 mutex_lock(&opts->lock);
1003 ret = kstrtou16(page, 0, &num);
1012 opts->isoc_maxpacket = num;
1015 mutex_unlock(&opts->lock);
1019 CONFIGFS_ATTR(f_ss_opts_, isoc_maxpacket);
1021 static ssize_t f_ss_opts_isoc_mult_show(struct config_item *item, char *page)
1023 struct f_ss_opts *opts = to_f_ss_opts(item);
1026 mutex_lock(&opts->lock);
1027 result = sprintf(page, "%u\n", opts->isoc_mult);
1028 mutex_unlock(&opts->lock);
1033 static ssize_t f_ss_opts_isoc_mult_store(struct config_item *item,
1034 const char *page, size_t len)
1036 struct f_ss_opts *opts = to_f_ss_opts(item);
1040 mutex_lock(&opts->lock);
1046 ret = kstrtou8(page, 0, &num);
1055 opts->isoc_mult = num;
1058 mutex_unlock(&opts->lock);
1062 CONFIGFS_ATTR(f_ss_opts_, isoc_mult);
1064 static ssize_t f_ss_opts_isoc_maxburst_show(struct config_item *item, char *page)
1066 struct f_ss_opts *opts = to_f_ss_opts(item);
1069 mutex_lock(&opts->lock);
1070 result = sprintf(page, "%u\n", opts->isoc_maxburst);
1071 mutex_unlock(&opts->lock);
1076 static ssize_t f_ss_opts_isoc_maxburst_store(struct config_item *item,
1077 const char *page, size_t len)
1079 struct f_ss_opts *opts = to_f_ss_opts(item);
1083 mutex_lock(&opts->lock);
1089 ret = kstrtou8(page, 0, &num);
1098 opts->isoc_maxburst = num;
1101 mutex_unlock(&opts->lock);
1105 CONFIGFS_ATTR(f_ss_opts_, isoc_maxburst);
1107 static ssize_t f_ss_opts_bulk_buflen_show(struct config_item *item, char *page)
1109 struct f_ss_opts *opts = to_f_ss_opts(item);
1112 mutex_lock(&opts->lock);
1113 result = sprintf(page, "%u\n", opts->bulk_buflen);
1114 mutex_unlock(&opts->lock);
1119 static ssize_t f_ss_opts_bulk_buflen_store(struct config_item *item,
1120 const char *page, size_t len)
1122 struct f_ss_opts *opts = to_f_ss_opts(item);
1126 mutex_lock(&opts->lock);
1132 ret = kstrtou32(page, 0, &num);
1136 opts->bulk_buflen = num;
1139 mutex_unlock(&opts->lock);
1143 CONFIGFS_ATTR(f_ss_opts_, bulk_buflen);
1145 static ssize_t f_ss_opts_bulk_qlen_show(struct config_item *item, char *page)
1147 struct f_ss_opts *opts = to_f_ss_opts(item);
1150 mutex_lock(&opts->lock);
1151 result = sprintf(page, "%u\n", opts->bulk_qlen);
1152 mutex_unlock(&opts->lock);
1157 static ssize_t f_ss_opts_bulk_qlen_store(struct config_item *item,
1158 const char *page, size_t len)
1160 struct f_ss_opts *opts = to_f_ss_opts(item);
1164 mutex_lock(&opts->lock);
1170 ret = kstrtou32(page, 0, &num);
1174 opts->bulk_qlen = num;
1177 mutex_unlock(&opts->lock);
1181 CONFIGFS_ATTR(f_ss_opts_, bulk_qlen);
1183 static ssize_t f_ss_opts_iso_qlen_show(struct config_item *item, char *page)
1185 struct f_ss_opts *opts = to_f_ss_opts(item);
1188 mutex_lock(&opts->lock);
1189 result = sprintf(page, "%u\n", opts->iso_qlen);
1190 mutex_unlock(&opts->lock);
1195 static ssize_t f_ss_opts_iso_qlen_store(struct config_item *item,
1196 const char *page, size_t len)
1198 struct f_ss_opts *opts = to_f_ss_opts(item);
1202 mutex_lock(&opts->lock);
1208 ret = kstrtou32(page, 0, &num);
1212 opts->iso_qlen = num;
1215 mutex_unlock(&opts->lock);
1219 CONFIGFS_ATTR(f_ss_opts_, iso_qlen);
1221 static struct configfs_attribute *ss_attrs[] = {
1222 &f_ss_opts_attr_pattern,
1223 &f_ss_opts_attr_isoc_interval,
1224 &f_ss_opts_attr_isoc_maxpacket,
1225 &f_ss_opts_attr_isoc_mult,
1226 &f_ss_opts_attr_isoc_maxburst,
1227 &f_ss_opts_attr_bulk_buflen,
1228 &f_ss_opts_attr_bulk_qlen,
1229 &f_ss_opts_attr_iso_qlen,
1233 static struct config_item_type ss_func_type = {
1234 .ct_item_ops = &ss_item_ops,
1235 .ct_attrs = ss_attrs,
1236 .ct_owner = THIS_MODULE,
1239 static void source_sink_free_instance(struct usb_function_instance *fi)
1241 struct f_ss_opts *ss_opts;
1243 ss_opts = container_of(fi, struct f_ss_opts, func_inst);
1247 static struct usb_function_instance *source_sink_alloc_inst(void)
1249 struct f_ss_opts *ss_opts;
1251 ss_opts = kzalloc(sizeof(*ss_opts), GFP_KERNEL);
1253 return ERR_PTR(-ENOMEM);
1254 mutex_init(&ss_opts->lock);
1255 ss_opts->func_inst.free_func_inst = source_sink_free_instance;
1256 ss_opts->isoc_interval = GZERO_ISOC_INTERVAL;
1257 ss_opts->isoc_maxpacket = GZERO_ISOC_MAXPACKET;
1258 ss_opts->bulk_buflen = GZERO_BULK_BUFLEN;
1259 ss_opts->bulk_qlen = GZERO_SS_BULK_QLEN;
1260 ss_opts->iso_qlen = GZERO_SS_ISO_QLEN;
1262 config_group_init_type_name(&ss_opts->func_inst.group, "",
1265 return &ss_opts->func_inst;
1267 DECLARE_USB_FUNCTION(SourceSink, source_sink_alloc_inst,
1268 source_sink_alloc_func);
1270 static int __init sslb_modinit(void)
1274 ret = usb_function_register(&SourceSinkusb_func);
1279 usb_function_unregister(&SourceSinkusb_func);
1282 static void __exit sslb_modexit(void)
1284 usb_function_unregister(&SourceSinkusb_func);
1287 module_init(sslb_modinit);
1288 module_exit(sslb_modexit);
1290 MODULE_LICENSE("GPL");