1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * uvc_gadget.c -- USB Video Class Gadget driver
4 *
5 * Copyright (C) 2009-2010
6 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7 */
8
9 #include <linux/device.h>
10 #include <linux/errno.h>
11 #include <linux/fs.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/module.h>
15 #include <linux/mutex.h>
16 #include <linux/string.h>
17 #include <linux/usb/ch9.h>
18 #include <linux/usb/gadget.h>
19 #include <linux/usb/g_uvc.h>
20 #include <linux/usb/video.h>
21 #include <linux/vmalloc.h>
22 #include <linux/wait.h>
23
24 #include <media/v4l2-dev.h>
25 #include <media/v4l2-event.h>
26
27 #include "u_uvc.h"
28 #include "uvc.h"
29 #include "uvc_configfs.h"
30 #include "uvc_v4l2.h"
31 #include "uvc_video.h"
32
33 unsigned int uvc_gadget_trace_param;
34 module_param_named(trace, uvc_gadget_trace_param, uint, 0644);
35 MODULE_PARM_DESC(trace, "Trace level bitmask");
36
37 /* --------------------------------------------------------------------------
38 * Function descriptors
39 */
40
41 /* string IDs are assigned dynamically */
42
43 #define UVC_STRING_CONTROL_IDX 0
44 #define UVC_STRING_STREAMING_IDX 1
45
46 static struct usb_string uvc_en_us_strings[] = {
47 [UVC_STRING_CONTROL_IDX].s = "UVC Camera",
48 [UVC_STRING_STREAMING_IDX].s = "Video Streaming",
49 { }
50 };
51
52 static struct usb_gadget_strings uvc_stringtab = {
53 .language = 0x0409, /* en-us */
54 .strings = uvc_en_us_strings,
55 };
56
57 static struct usb_gadget_strings *uvc_function_strings[] = {
58 &uvc_stringtab,
59 NULL,
60 };
61
62 #define UVC_INTF_VIDEO_CONTROL 0
63 #define UVC_INTF_VIDEO_STREAMING 1
64
65 #define UVC_STATUS_MAX_PACKET_SIZE 16 /* 16 bytes status */
66
67 static struct usb_interface_assoc_descriptor uvc_iad = {
68 .bLength = sizeof(uvc_iad),
69 .bDescriptorType = USB_DT_INTERFACE_ASSOCIATION,
70 .bFirstInterface = 0,
71 .bInterfaceCount = 2,
72 .bFunctionClass = USB_CLASS_VIDEO,
73 .bFunctionSubClass = UVC_SC_VIDEO_INTERFACE_COLLECTION,
74 .bFunctionProtocol = 0x00,
75 .iFunction = 0,
76 };
77
78 static struct usb_interface_descriptor uvc_control_intf = {
79 .bLength = USB_DT_INTERFACE_SIZE,
80 .bDescriptorType = USB_DT_INTERFACE,
81 .bInterfaceNumber = UVC_INTF_VIDEO_CONTROL,
82 .bAlternateSetting = 0,
83 .bNumEndpoints = 1,
84 .bInterfaceClass = USB_CLASS_VIDEO,
85 .bInterfaceSubClass = UVC_SC_VIDEOCONTROL,
86 .bInterfaceProtocol = 0x00,
87 .iInterface = 0,
88 };
89
90 static struct usb_endpoint_descriptor uvc_control_ep = {
91 .bLength = USB_DT_ENDPOINT_SIZE,
92 .bDescriptorType = USB_DT_ENDPOINT,
93 .bEndpointAddress = USB_DIR_IN,
94 .bmAttributes = USB_ENDPOINT_XFER_INT,
95 .wMaxPacketSize = cpu_to_le16(UVC_STATUS_MAX_PACKET_SIZE),
96 .bInterval = 8,
97 };
98
99 static struct usb_ss_ep_comp_descriptor uvc_ss_control_comp = {
100 .bLength = sizeof(uvc_ss_control_comp),
101 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
102 /* The following 3 values can be tweaked if necessary. */
103 .bMaxBurst = 0,
104 .bmAttributes = 0,
105 .wBytesPerInterval = cpu_to_le16(UVC_STATUS_MAX_PACKET_SIZE),
106 };
107
108 static struct uvc_control_endpoint_descriptor uvc_control_cs_ep = {
109 .bLength = UVC_DT_CONTROL_ENDPOINT_SIZE,
110 .bDescriptorType = USB_DT_CS_ENDPOINT,
111 .bDescriptorSubType = UVC_EP_INTERRUPT,
112 .wMaxTransferSize = cpu_to_le16(UVC_STATUS_MAX_PACKET_SIZE),
113 };
114
115 static struct usb_interface_descriptor uvc_streaming_intf_alt0 = {
116 .bLength = USB_DT_INTERFACE_SIZE,
117 .bDescriptorType = USB_DT_INTERFACE,
118 .bInterfaceNumber = UVC_INTF_VIDEO_STREAMING,
119 .bAlternateSetting = 0,
120 .bNumEndpoints = 0,
121 .bInterfaceClass = USB_CLASS_VIDEO,
122 .bInterfaceSubClass = UVC_SC_VIDEOSTREAMING,
123 .bInterfaceProtocol = 0x00,
124 .iInterface = 0,
125 };
126
127 static struct usb_interface_descriptor uvc_streaming_intf_alt1 = {
128 .bLength = USB_DT_INTERFACE_SIZE,
129 .bDescriptorType = USB_DT_INTERFACE,
130 .bInterfaceNumber = UVC_INTF_VIDEO_STREAMING,
131 .bAlternateSetting = 1,
132 .bNumEndpoints = 1,
133 .bInterfaceClass = USB_CLASS_VIDEO,
134 .bInterfaceSubClass = UVC_SC_VIDEOSTREAMING,
135 .bInterfaceProtocol = 0x00,
136 .iInterface = 0,
137 };
138
139 static struct usb_endpoint_descriptor uvc_fs_streaming_ep = {
140 .bLength = USB_DT_ENDPOINT_SIZE,
141 .bDescriptorType = USB_DT_ENDPOINT,
142 .bEndpointAddress = USB_DIR_IN,
143 .bmAttributes = USB_ENDPOINT_SYNC_ASYNC
144 | USB_ENDPOINT_XFER_ISOC,
145 /* The wMaxPacketSize and bInterval values will be initialized from
146 * module parameters.
147 */
148 };
149
150 static struct usb_endpoint_descriptor uvc_hs_streaming_ep = {
151 .bLength = USB_DT_ENDPOINT_SIZE,
152 .bDescriptorType = USB_DT_ENDPOINT,
153 .bEndpointAddress = USB_DIR_IN,
154 .bmAttributes = USB_ENDPOINT_SYNC_ASYNC
155 | USB_ENDPOINT_XFER_ISOC,
156 /* The wMaxPacketSize and bInterval values will be initialized from
157 * module parameters.
158 */
159 };
160
161 static struct usb_endpoint_descriptor uvc_ss_streaming_ep = {
162 .bLength = USB_DT_ENDPOINT_SIZE,
163 .bDescriptorType = USB_DT_ENDPOINT,
164
165 .bEndpointAddress = USB_DIR_IN,
166 .bmAttributes = USB_ENDPOINT_SYNC_ASYNC
167 | USB_ENDPOINT_XFER_ISOC,
168 /* The wMaxPacketSize and bInterval values will be initialized from
169 * module parameters.
170 */
171 };
172
173 static struct usb_ss_ep_comp_descriptor uvc_ss_streaming_comp = {
174 .bLength = sizeof(uvc_ss_streaming_comp),
175 .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
176 /* The bMaxBurst, bmAttributes and wBytesPerInterval values will be
177 * initialized from module parameters.
178 */
179 };
180
181 static const struct usb_descriptor_header * const uvc_fs_streaming[] = {
182 (struct usb_descriptor_header *) &uvc_streaming_intf_alt1,
183 (struct usb_descriptor_header *) &uvc_fs_streaming_ep,
184 NULL,
185 };
186
187 static const struct usb_descriptor_header * const uvc_hs_streaming[] = {
188 (struct usb_descriptor_header *) &uvc_streaming_intf_alt1,
189 (struct usb_descriptor_header *) &uvc_hs_streaming_ep,
190 NULL,
191 };
192
193 static const struct usb_descriptor_header * const uvc_ss_streaming[] = {
194 (struct usb_descriptor_header *) &uvc_streaming_intf_alt1,
195 (struct usb_descriptor_header *) &uvc_ss_streaming_ep,
196 (struct usb_descriptor_header *) &uvc_ss_streaming_comp,
197 NULL,
198 };
199
200 /* --------------------------------------------------------------------------
201 * Control requests
202 */
203
204 static void
uvc_function_ep0_complete(struct usb_ep * ep,struct usb_request * req)205 uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
206 {
207 struct uvc_device *uvc = req->context;
208 struct v4l2_event v4l2_event;
209 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data;
210
211 if (uvc->event_setup_out) {
212 uvc->event_setup_out = 0;
213
214 memset(&v4l2_event, 0, sizeof(v4l2_event));
215 v4l2_event.type = UVC_EVENT_DATA;
216 uvc_event->data.length = req->actual;
217 memcpy(&uvc_event->data.data, req->buf, req->actual);
218 v4l2_event_queue(&uvc->vdev, &v4l2_event);
219 }
220 }
221
222 static int
uvc_function_setup(struct usb_function * f,const struct usb_ctrlrequest * ctrl)223 uvc_function_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl)
224 {
225 struct uvc_device *uvc = to_uvc(f);
226 struct v4l2_event v4l2_event;
227 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data;
228
229 if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS) {
230 uvcg_info(f, "invalid request type\n");
231 return -EINVAL;
232 }
233
234 /* Stall too big requests. */
235 if (le16_to_cpu(ctrl->wLength) > UVC_MAX_REQUEST_SIZE)
236 return -EINVAL;
237
238 /* Tell the complete callback to generate an event for the next request
239 * that will be enqueued by UVCIOC_SEND_RESPONSE.
240 */
241 uvc->event_setup_out = !(ctrl->bRequestType & USB_DIR_IN);
242 uvc->event_length = le16_to_cpu(ctrl->wLength);
243
244 memset(&v4l2_event, 0, sizeof(v4l2_event));
245 v4l2_event.type = UVC_EVENT_SETUP;
246 memcpy(&uvc_event->req, ctrl, sizeof(uvc_event->req));
247 v4l2_event_queue(&uvc->vdev, &v4l2_event);
248
249 return 0;
250 }
251
uvc_function_setup_continue(struct uvc_device * uvc)252 void uvc_function_setup_continue(struct uvc_device *uvc)
253 {
254 struct usb_composite_dev *cdev = uvc->func.config->cdev;
255
256 usb_composite_setup_continue(cdev);
257 }
258
259 static int
uvc_function_get_alt(struct usb_function * f,unsigned interface)260 uvc_function_get_alt(struct usb_function *f, unsigned interface)
261 {
262 struct uvc_device *uvc = to_uvc(f);
263
264 uvcg_info(f, "%s(%u)\n", __func__, interface);
265
266 if (interface == uvc->control_intf)
267 return 0;
268 else if (interface != uvc->streaming_intf)
269 return -EINVAL;
270 else
271 return uvc->video.ep->enabled ? 1 : 0;
272 }
273
274 static int
uvc_function_set_alt(struct usb_function * f,unsigned interface,unsigned alt)275 uvc_function_set_alt(struct usb_function *f, unsigned interface, unsigned alt)
276 {
277 struct uvc_device *uvc = to_uvc(f);
278 struct usb_composite_dev *cdev = f->config->cdev;
279 struct v4l2_event v4l2_event;
280 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data;
281 int ret;
282
283 uvcg_info(f, "%s(%u, %u)\n", __func__, interface, alt);
284
285 if (interface == uvc->control_intf) {
286 if (alt)
287 return -EINVAL;
288
289 uvcg_info(f, "reset UVC Control\n");
290 usb_ep_disable(uvc->control_ep);
291
292 if (!uvc->control_ep->desc)
293 if (config_ep_by_speed(cdev->gadget, f, uvc->control_ep))
294 return -EINVAL;
295
296 usb_ep_enable(uvc->control_ep);
297
298 if (uvc->state == UVC_STATE_DISCONNECTED) {
299 memset(&v4l2_event, 0, sizeof(v4l2_event));
300 v4l2_event.type = UVC_EVENT_CONNECT;
301 uvc_event->speed = cdev->gadget->speed;
302 v4l2_event_queue(&uvc->vdev, &v4l2_event);
303
304 uvc->state = UVC_STATE_CONNECTED;
305 }
306
307 return 0;
308 }
309
310 if (interface != uvc->streaming_intf)
311 return -EINVAL;
312
313 /* TODO
314 if (usb_endpoint_xfer_bulk(&uvc->desc.vs_ep))
315 return alt ? -EINVAL : 0;
316 */
317
318 switch (alt) {
319 case 0:
320 if (uvc->state != UVC_STATE_STREAMING)
321 return 0;
322
323 if (uvc->video.ep)
324 usb_ep_disable(uvc->video.ep);
325
326 memset(&v4l2_event, 0, sizeof(v4l2_event));
327 v4l2_event.type = UVC_EVENT_STREAMOFF;
328 v4l2_event_queue(&uvc->vdev, &v4l2_event);
329
330 uvc->state = UVC_STATE_CONNECTED;
331 return 0;
332
333 case 1:
334 if (uvc->state != UVC_STATE_CONNECTED)
335 return 0;
336
337 if (!uvc->video.ep)
338 return -EINVAL;
339
340 uvcg_info(f, "reset UVC\n");
341 usb_ep_disable(uvc->video.ep);
342
343 ret = config_ep_by_speed(f->config->cdev->gadget,
344 &(uvc->func), uvc->video.ep);
345 if (ret)
346 return ret;
347 usb_ep_enable(uvc->video.ep);
348
349 memset(&v4l2_event, 0, sizeof(v4l2_event));
350 v4l2_event.type = UVC_EVENT_STREAMON;
351 v4l2_event_queue(&uvc->vdev, &v4l2_event);
352 return USB_GADGET_DELAYED_STATUS;
353
354 default:
355 return -EINVAL;
356 }
357 }
358
359 static void
uvc_function_disable(struct usb_function * f)360 uvc_function_disable(struct usb_function *f)
361 {
362 struct uvc_device *uvc = to_uvc(f);
363 struct v4l2_event v4l2_event;
364
365 uvcg_info(f, "%s()\n", __func__);
366
367 memset(&v4l2_event, 0, sizeof(v4l2_event));
368 v4l2_event.type = UVC_EVENT_DISCONNECT;
369 v4l2_event_queue(&uvc->vdev, &v4l2_event);
370
371 uvc->state = UVC_STATE_DISCONNECTED;
372
373 usb_ep_disable(uvc->video.ep);
374 usb_ep_disable(uvc->control_ep);
375 }
376
377 /* --------------------------------------------------------------------------
378 * Connection / disconnection
379 */
380
381 void
uvc_function_connect(struct uvc_device * uvc)382 uvc_function_connect(struct uvc_device *uvc)
383 {
384 int ret;
385
386 if ((ret = usb_function_activate(&uvc->func)) < 0)
387 uvcg_info(&uvc->func, "UVC connect failed with %d\n", ret);
388 }
389
390 void
uvc_function_disconnect(struct uvc_device * uvc)391 uvc_function_disconnect(struct uvc_device *uvc)
392 {
393 int ret;
394
395 if ((ret = usb_function_deactivate(&uvc->func)) < 0)
396 uvcg_info(&uvc->func, "UVC disconnect failed with %d\n", ret);
397 }
398
399 /* --------------------------------------------------------------------------
400 * USB probe and disconnect
401 */
402
function_name_show(struct device * dev,struct device_attribute * attr,char * buf)403 static ssize_t function_name_show(struct device *dev,
404 struct device_attribute *attr, char *buf)
405 {
406 struct uvc_device *uvc = dev_get_drvdata(dev);
407
408 return sprintf(buf, "%s\n", uvc->func.fi->group.cg_item.ci_name);
409 }
410
411 static DEVICE_ATTR_RO(function_name);
412
413 static int
uvc_register_video(struct uvc_device * uvc)414 uvc_register_video(struct uvc_device *uvc)
415 {
416 struct usb_composite_dev *cdev = uvc->func.config->cdev;
417 int ret;
418
419 /* TODO reference counting. */
420 memset(&uvc->vdev, 0, sizeof(uvc->video));
421 uvc->vdev.v4l2_dev = &uvc->v4l2_dev;
422 uvc->vdev.v4l2_dev->dev = &cdev->gadget->dev;
423 uvc->vdev.fops = &uvc_v4l2_fops;
424 uvc->vdev.ioctl_ops = &uvc_v4l2_ioctl_ops;
425 uvc->vdev.release = video_device_release_empty;
426 uvc->vdev.vfl_dir = VFL_DIR_TX;
427 uvc->vdev.lock = &uvc->video.mutex;
428 uvc->vdev.device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
429 strlcpy(uvc->vdev.name, cdev->gadget->name, sizeof(uvc->vdev.name));
430
431 video_set_drvdata(&uvc->vdev, uvc);
432
433 ret = video_register_device(&uvc->vdev, VFL_TYPE_VIDEO, -1);
434 if (ret < 0)
435 return ret;
436
437 ret = device_create_file(&uvc->vdev.dev, &dev_attr_function_name);
438 if (ret < 0) {
439 video_unregister_device(&uvc->vdev);
440 return ret;
441 }
442
443 return 0;
444 }
445
446 #define UVC_COPY_DESCRIPTOR(mem, dst, desc) \
447 do { \
448 memcpy(mem, desc, (desc)->bLength); \
449 *(dst)++ = mem; \
450 mem += (desc)->bLength; \
451 } while (0);
452
453 #define UVC_COPY_DESCRIPTORS(mem, dst, src) \
454 do { \
455 const struct usb_descriptor_header * const *__src; \
456 for (__src = src; *__src; ++__src) { \
457 memcpy(mem, *__src, (*__src)->bLength); \
458 *dst++ = mem; \
459 mem += (*__src)->bLength; \
460 } \
461 } while (0)
462
463 static struct usb_descriptor_header **
uvc_copy_descriptors(struct uvc_device * uvc,enum usb_device_speed speed)464 uvc_copy_descriptors(struct uvc_device *uvc, enum usb_device_speed speed)
465 {
466 struct uvc_input_header_descriptor *uvc_streaming_header;
467 struct uvc_header_descriptor *uvc_control_header;
468 const struct uvc_descriptor_header * const *uvc_control_desc;
469 const struct uvc_descriptor_header * const *uvc_streaming_cls;
470 const struct usb_descriptor_header * const *uvc_streaming_std;
471 const struct usb_descriptor_header * const *src;
472 struct usb_descriptor_header **dst;
473 struct usb_descriptor_header **hdr;
474 unsigned int control_size;
475 unsigned int streaming_size;
476 unsigned int n_desc;
477 unsigned int bytes;
478 void *mem;
479
480 switch (speed) {
481 case USB_SPEED_SUPER:
482 uvc_control_desc = uvc->desc.ss_control;
483 uvc_streaming_cls = uvc->desc.ss_streaming;
484 uvc_streaming_std = uvc_ss_streaming;
485 break;
486
487 case USB_SPEED_HIGH:
488 uvc_control_desc = uvc->desc.fs_control;
489 uvc_streaming_cls = uvc->desc.hs_streaming;
490 uvc_streaming_std = uvc_hs_streaming;
491 break;
492
493 case USB_SPEED_FULL:
494 default:
495 uvc_control_desc = uvc->desc.fs_control;
496 uvc_streaming_cls = uvc->desc.fs_streaming;
497 uvc_streaming_std = uvc_fs_streaming;
498 break;
499 }
500
501 if (!uvc_control_desc || !uvc_streaming_cls)
502 return ERR_PTR(-ENODEV);
503
504 /* Descriptors layout
505 *
506 * uvc_iad
507 * uvc_control_intf
508 * Class-specific UVC control descriptors
509 * uvc_control_ep
510 * uvc_control_cs_ep
511 * uvc_ss_control_comp (for SS only)
512 * uvc_streaming_intf_alt0
513 * Class-specific UVC streaming descriptors
514 * uvc_{fs|hs}_streaming
515 */
516
517 /* Count descriptors and compute their size. */
518 control_size = 0;
519 streaming_size = 0;
520 bytes = uvc_iad.bLength + uvc_control_intf.bLength
521 + uvc_control_ep.bLength + uvc_control_cs_ep.bLength
522 + uvc_streaming_intf_alt0.bLength;
523
524 if (speed == USB_SPEED_SUPER) {
525 bytes += uvc_ss_control_comp.bLength;
526 n_desc = 6;
527 } else {
528 n_desc = 5;
529 }
530
531 for (src = (const struct usb_descriptor_header **)uvc_control_desc;
532 *src; ++src) {
533 control_size += (*src)->bLength;
534 bytes += (*src)->bLength;
535 n_desc++;
536 }
537 for (src = (const struct usb_descriptor_header **)uvc_streaming_cls;
538 *src; ++src) {
539 streaming_size += (*src)->bLength;
540 bytes += (*src)->bLength;
541 n_desc++;
542 }
543 for (src = uvc_streaming_std; *src; ++src) {
544 bytes += (*src)->bLength;
545 n_desc++;
546 }
547
548 mem = kmalloc((n_desc + 1) * sizeof(*src) + bytes, GFP_KERNEL);
549 if (mem == NULL)
550 return NULL;
551
552 hdr = mem;
553 dst = mem;
554 mem += (n_desc + 1) * sizeof(*src);
555
556 /* Copy the descriptors. */
557 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_iad);
558 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_intf);
559
560 uvc_control_header = mem;
561 UVC_COPY_DESCRIPTORS(mem, dst,
562 (const struct usb_descriptor_header **)uvc_control_desc);
563 uvc_control_header->wTotalLength = cpu_to_le16(control_size);
564 uvc_control_header->bInCollection = 1;
565 uvc_control_header->baInterfaceNr[0] = uvc->streaming_intf;
566
567 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_ep);
568 if (speed == USB_SPEED_SUPER)
569 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_ss_control_comp);
570
571 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_cs_ep);
572 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_streaming_intf_alt0);
573
574 uvc_streaming_header = mem;
575 UVC_COPY_DESCRIPTORS(mem, dst,
576 (const struct usb_descriptor_header**)uvc_streaming_cls);
577 uvc_streaming_header->wTotalLength = cpu_to_le16(streaming_size);
578 uvc_streaming_header->bEndpointAddress = uvc->video.ep->address;
579
580 UVC_COPY_DESCRIPTORS(mem, dst, uvc_streaming_std);
581
582 *dst = NULL;
583 return hdr;
584 }
585
586 static int
uvc_function_bind(struct usb_configuration * c,struct usb_function * f)587 uvc_function_bind(struct usb_configuration *c, struct usb_function *f)
588 {
589 struct usb_composite_dev *cdev = c->cdev;
590 struct uvc_device *uvc = to_uvc(f);
591 struct usb_string *us;
592 unsigned int max_packet_mult;
593 unsigned int max_packet_size;
594 struct usb_ep *ep;
595 struct f_uvc_opts *opts;
596 int ret = -EINVAL;
597
598 uvcg_info(f, "%s()\n", __func__);
599
600 opts = fi_to_f_uvc_opts(f->fi);
601 /* Sanity check the streaming endpoint module parameters.
602 */
603 opts->streaming_interval = clamp(opts->streaming_interval, 1U, 16U);
604 opts->streaming_maxpacket = clamp(opts->streaming_maxpacket, 1U, 3072U);
605 opts->streaming_maxburst = min(opts->streaming_maxburst, 15U);
606
607 /* For SS, wMaxPacketSize has to be 1024 if bMaxBurst is not 0 */
608 if (opts->streaming_maxburst &&
609 (opts->streaming_maxpacket % 1024) != 0) {
610 opts->streaming_maxpacket = roundup(opts->streaming_maxpacket, 1024);
611 uvcg_info(f, "overriding streaming_maxpacket to %d\n",
612 opts->streaming_maxpacket);
613 }
614
615 /* Fill in the FS/HS/SS Video Streaming specific descriptors from the
616 * module parameters.
617 *
618 * NOTE: We assume that the user knows what they are doing and won't
619 * give parameters that their UDC doesn't support.
620 */
621 if (opts->streaming_maxpacket <= 1024) {
622 max_packet_mult = 1;
623 max_packet_size = opts->streaming_maxpacket;
624 } else if (opts->streaming_maxpacket <= 2048) {
625 max_packet_mult = 2;
626 max_packet_size = opts->streaming_maxpacket / 2;
627 } else {
628 max_packet_mult = 3;
629 max_packet_size = opts->streaming_maxpacket / 3;
630 }
631
632 uvc_fs_streaming_ep.wMaxPacketSize =
633 cpu_to_le16(min(opts->streaming_maxpacket, 1023U));
634 uvc_fs_streaming_ep.bInterval = opts->streaming_interval;
635
636 uvc_hs_streaming_ep.wMaxPacketSize =
637 cpu_to_le16(max_packet_size | ((max_packet_mult - 1) << 11));
638
639 /* A high-bandwidth endpoint must specify a bInterval value of 1 */
640 if (max_packet_mult > 1)
641 uvc_hs_streaming_ep.bInterval = 1;
642 else
643 uvc_hs_streaming_ep.bInterval = opts->streaming_interval;
644
645 uvc_ss_streaming_ep.wMaxPacketSize = cpu_to_le16(max_packet_size);
646 uvc_ss_streaming_ep.bInterval = opts->streaming_interval;
647 uvc_ss_streaming_comp.bmAttributes = max_packet_mult - 1;
648 uvc_ss_streaming_comp.bMaxBurst = opts->streaming_maxburst;
649 uvc_ss_streaming_comp.wBytesPerInterval =
650 cpu_to_le16(max_packet_size * max_packet_mult *
651 (opts->streaming_maxburst + 1));
652
653 /* Allocate endpoints. */
654 ep = usb_ep_autoconfig(cdev->gadget, &uvc_control_ep);
655 if (!ep) {
656 uvcg_info(f, "Unable to allocate control EP\n");
657 goto error;
658 }
659 uvc->control_ep = ep;
660
661 if (gadget_is_superspeed(c->cdev->gadget))
662 ep = usb_ep_autoconfig_ss(cdev->gadget, &uvc_ss_streaming_ep,
663 &uvc_ss_streaming_comp);
664 else if (gadget_is_dualspeed(cdev->gadget))
665 ep = usb_ep_autoconfig(cdev->gadget, &uvc_hs_streaming_ep);
666 else
667 ep = usb_ep_autoconfig(cdev->gadget, &uvc_fs_streaming_ep);
668
669 if (!ep) {
670 uvcg_info(f, "Unable to allocate streaming EP\n");
671 goto error;
672 }
673 uvc->video.ep = ep;
674
675 uvc_fs_streaming_ep.bEndpointAddress = uvc->video.ep->address;
676 uvc_hs_streaming_ep.bEndpointAddress = uvc->video.ep->address;
677 uvc_ss_streaming_ep.bEndpointAddress = uvc->video.ep->address;
678
679 us = usb_gstrings_attach(cdev, uvc_function_strings,
680 ARRAY_SIZE(uvc_en_us_strings));
681 if (IS_ERR(us)) {
682 ret = PTR_ERR(us);
683 goto error;
684 }
685 uvc_iad.iFunction = us[UVC_STRING_CONTROL_IDX].id;
686 uvc_control_intf.iInterface = us[UVC_STRING_CONTROL_IDX].id;
687 ret = us[UVC_STRING_STREAMING_IDX].id;
688 uvc_streaming_intf_alt0.iInterface = ret;
689 uvc_streaming_intf_alt1.iInterface = ret;
690
691 /* Allocate interface IDs. */
692 if ((ret = usb_interface_id(c, f)) < 0)
693 goto error;
694 uvc_iad.bFirstInterface = ret;
695 uvc_control_intf.bInterfaceNumber = ret;
696 uvc->control_intf = ret;
697 opts->control_interface = ret;
698
699 if ((ret = usb_interface_id(c, f)) < 0)
700 goto error;
701 uvc_streaming_intf_alt0.bInterfaceNumber = ret;
702 uvc_streaming_intf_alt1.bInterfaceNumber = ret;
703 uvc->streaming_intf = ret;
704 opts->streaming_interface = ret;
705
706 /* Copy descriptors */
707 f->fs_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_FULL);
708 if (IS_ERR(f->fs_descriptors)) {
709 ret = PTR_ERR(f->fs_descriptors);
710 f->fs_descriptors = NULL;
711 goto error;
712 }
713 if (gadget_is_dualspeed(cdev->gadget)) {
714 f->hs_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_HIGH);
715 if (IS_ERR(f->hs_descriptors)) {
716 ret = PTR_ERR(f->hs_descriptors);
717 f->hs_descriptors = NULL;
718 goto error;
719 }
720 }
721 if (gadget_is_superspeed(c->cdev->gadget)) {
722 f->ss_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_SUPER);
723 if (IS_ERR(f->ss_descriptors)) {
724 ret = PTR_ERR(f->ss_descriptors);
725 f->ss_descriptors = NULL;
726 goto error;
727 }
728 }
729
730 /* Preallocate control endpoint request. */
731 uvc->control_req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL);
732 uvc->control_buf = kmalloc(UVC_MAX_REQUEST_SIZE, GFP_KERNEL);
733 if (uvc->control_req == NULL || uvc->control_buf == NULL) {
734 ret = -ENOMEM;
735 goto error;
736 }
737
738 uvc->control_req->buf = uvc->control_buf;
739 uvc->control_req->complete = uvc_function_ep0_complete;
740 uvc->control_req->context = uvc;
741
742 if (v4l2_device_register(&cdev->gadget->dev, &uvc->v4l2_dev)) {
743 uvcg_err(f, "failed to register V4L2 device\n");
744 goto error;
745 }
746
747 /* Initialise video. */
748 ret = uvcg_video_init(&uvc->video, uvc);
749 if (ret < 0)
750 goto v4l2_error;
751
752 /* Register a V4L2 device. */
753 ret = uvc_register_video(uvc);
754 if (ret < 0) {
755 uvcg_err(f, "failed to register video device\n");
756 goto v4l2_error;
757 }
758
759 return 0;
760
761 v4l2_error:
762 v4l2_device_unregister(&uvc->v4l2_dev);
763 error:
764 if (uvc->control_req)
765 usb_ep_free_request(cdev->gadget->ep0, uvc->control_req);
766 kfree(uvc->control_buf);
767
768 usb_free_all_descriptors(f);
769 return ret;
770 }
771
772 /* --------------------------------------------------------------------------
773 * USB gadget function
774 */
775
uvc_free_inst(struct usb_function_instance * f)776 static void uvc_free_inst(struct usb_function_instance *f)
777 {
778 struct f_uvc_opts *opts = fi_to_f_uvc_opts(f);
779
780 mutex_destroy(&opts->lock);
781 kfree(opts);
782 }
783
uvc_alloc_inst(void)784 static struct usb_function_instance *uvc_alloc_inst(void)
785 {
786 struct f_uvc_opts *opts;
787 struct uvc_camera_terminal_descriptor *cd;
788 struct uvc_processing_unit_descriptor *pd;
789 struct uvc_output_terminal_descriptor *od;
790 struct uvc_color_matching_descriptor *md;
791 struct uvc_descriptor_header **ctl_cls;
792 int ret;
793
794 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
795 if (!opts)
796 return ERR_PTR(-ENOMEM);
797 opts->func_inst.free_func_inst = uvc_free_inst;
798 mutex_init(&opts->lock);
799
800 cd = &opts->uvc_camera_terminal;
801 cd->bLength = UVC_DT_CAMERA_TERMINAL_SIZE(3);
802 cd->bDescriptorType = USB_DT_CS_INTERFACE;
803 cd->bDescriptorSubType = UVC_VC_INPUT_TERMINAL;
804 cd->bTerminalID = 1;
805 cd->wTerminalType = cpu_to_le16(0x0201);
806 cd->bAssocTerminal = 0;
807 cd->iTerminal = 0;
808 cd->wObjectiveFocalLengthMin = cpu_to_le16(0);
809 cd->wObjectiveFocalLengthMax = cpu_to_le16(0);
810 cd->wOcularFocalLength = cpu_to_le16(0);
811 cd->bControlSize = 3;
812 cd->bmControls[0] = 2;
813 cd->bmControls[1] = 0;
814 cd->bmControls[2] = 0;
815
816 pd = &opts->uvc_processing;
817 pd->bLength = UVC_DT_PROCESSING_UNIT_SIZE(2);
818 pd->bDescriptorType = USB_DT_CS_INTERFACE;
819 pd->bDescriptorSubType = UVC_VC_PROCESSING_UNIT;
820 pd->bUnitID = 2;
821 pd->bSourceID = 1;
822 pd->wMaxMultiplier = cpu_to_le16(16*1024);
823 pd->bControlSize = 2;
824 pd->bmControls[0] = 1;
825 pd->bmControls[1] = 0;
826 pd->iProcessing = 0;
827 pd->bmVideoStandards = 0;
828
829 od = &opts->uvc_output_terminal;
830 od->bLength = UVC_DT_OUTPUT_TERMINAL_SIZE;
831 od->bDescriptorType = USB_DT_CS_INTERFACE;
832 od->bDescriptorSubType = UVC_VC_OUTPUT_TERMINAL;
833 od->bTerminalID = 3;
834 od->wTerminalType = cpu_to_le16(0x0101);
835 od->bAssocTerminal = 0;
836 od->bSourceID = 2;
837 od->iTerminal = 0;
838
839 md = &opts->uvc_color_matching;
840 md->bLength = UVC_DT_COLOR_MATCHING_SIZE;
841 md->bDescriptorType = USB_DT_CS_INTERFACE;
842 md->bDescriptorSubType = UVC_VS_COLORFORMAT;
843 md->bColorPrimaries = 1;
844 md->bTransferCharacteristics = 1;
845 md->bMatrixCoefficients = 4;
846
847 /* Prepare fs control class descriptors for configfs-based gadgets */
848 ctl_cls = opts->uvc_fs_control_cls;
849 ctl_cls[0] = NULL; /* assigned elsewhere by configfs */
850 ctl_cls[1] = (struct uvc_descriptor_header *)cd;
851 ctl_cls[2] = (struct uvc_descriptor_header *)pd;
852 ctl_cls[3] = (struct uvc_descriptor_header *)od;
853 ctl_cls[4] = NULL; /* NULL-terminate */
854 opts->fs_control =
855 (const struct uvc_descriptor_header * const *)ctl_cls;
856
857 /* Prepare hs control class descriptors for configfs-based gadgets */
858 ctl_cls = opts->uvc_ss_control_cls;
859 ctl_cls[0] = NULL; /* assigned elsewhere by configfs */
860 ctl_cls[1] = (struct uvc_descriptor_header *)cd;
861 ctl_cls[2] = (struct uvc_descriptor_header *)pd;
862 ctl_cls[3] = (struct uvc_descriptor_header *)od;
863 ctl_cls[4] = NULL; /* NULL-terminate */
864 opts->ss_control =
865 (const struct uvc_descriptor_header * const *)ctl_cls;
866
867 opts->streaming_interval = 1;
868 opts->streaming_maxpacket = 1024;
869
870 ret = uvcg_attach_configfs(opts);
871 if (ret < 0) {
872 kfree(opts);
873 return ERR_PTR(ret);
874 }
875
876 return &opts->func_inst;
877 }
878
uvc_free(struct usb_function * f)879 static void uvc_free(struct usb_function *f)
880 {
881 struct uvc_device *uvc = to_uvc(f);
882 struct f_uvc_opts *opts = container_of(f->fi, struct f_uvc_opts,
883 func_inst);
884 --opts->refcnt;
885 kfree(uvc);
886 }
887
uvc_function_unbind(struct usb_configuration * c,struct usb_function * f)888 static void uvc_function_unbind(struct usb_configuration *c,
889 struct usb_function *f)
890 {
891 struct usb_composite_dev *cdev = c->cdev;
892 struct uvc_device *uvc = to_uvc(f);
893
894 uvcg_info(f, "%s()\n", __func__);
895
896 device_remove_file(&uvc->vdev.dev, &dev_attr_function_name);
897 video_unregister_device(&uvc->vdev);
898 v4l2_device_unregister(&uvc->v4l2_dev);
899
900 usb_ep_free_request(cdev->gadget->ep0, uvc->control_req);
901 kfree(uvc->control_buf);
902
903 usb_free_all_descriptors(f);
904 }
905
uvc_alloc(struct usb_function_instance * fi)906 static struct usb_function *uvc_alloc(struct usb_function_instance *fi)
907 {
908 struct uvc_device *uvc;
909 struct f_uvc_opts *opts;
910 struct uvc_descriptor_header **strm_cls;
911
912 uvc = kzalloc(sizeof(*uvc), GFP_KERNEL);
913 if (uvc == NULL)
914 return ERR_PTR(-ENOMEM);
915
916 mutex_init(&uvc->video.mutex);
917 uvc->state = UVC_STATE_DISCONNECTED;
918 opts = fi_to_f_uvc_opts(fi);
919
920 mutex_lock(&opts->lock);
921 if (opts->uvc_fs_streaming_cls) {
922 strm_cls = opts->uvc_fs_streaming_cls;
923 opts->fs_streaming =
924 (const struct uvc_descriptor_header * const *)strm_cls;
925 }
926 if (opts->uvc_hs_streaming_cls) {
927 strm_cls = opts->uvc_hs_streaming_cls;
928 opts->hs_streaming =
929 (const struct uvc_descriptor_header * const *)strm_cls;
930 }
931 if (opts->uvc_ss_streaming_cls) {
932 strm_cls = opts->uvc_ss_streaming_cls;
933 opts->ss_streaming =
934 (const struct uvc_descriptor_header * const *)strm_cls;
935 }
936
937 uvc->desc.fs_control = opts->fs_control;
938 uvc->desc.ss_control = opts->ss_control;
939 uvc->desc.fs_streaming = opts->fs_streaming;
940 uvc->desc.hs_streaming = opts->hs_streaming;
941 uvc->desc.ss_streaming = opts->ss_streaming;
942 ++opts->refcnt;
943 mutex_unlock(&opts->lock);
944
945 /* Register the function. */
946 uvc->func.name = "uvc";
947 uvc->func.bind = uvc_function_bind;
948 uvc->func.unbind = uvc_function_unbind;
949 uvc->func.get_alt = uvc_function_get_alt;
950 uvc->func.set_alt = uvc_function_set_alt;
951 uvc->func.disable = uvc_function_disable;
952 uvc->func.setup = uvc_function_setup;
953 uvc->func.free_func = uvc_free;
954 uvc->func.bind_deactivated = true;
955
956 return &uvc->func;
957 }
958
959 DECLARE_USB_FUNCTION_INIT(uvc, uvc_alloc_inst, uvc_alloc);
960 MODULE_LICENSE("GPL");
961 MODULE_AUTHOR("Laurent Pinchart");
962