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 void uvc_set_trace_param(unsigned int trace) 201 { 202 uvc_gadget_trace_param = trace; 203 } 204 EXPORT_SYMBOL(uvc_set_trace_param); 205 206 /* -------------------------------------------------------------------------- 207 * Control requests 208 */ 209 210 static void 211 uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req) 212 { 213 struct uvc_device *uvc = req->context; 214 struct v4l2_event v4l2_event; 215 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data; 216 217 if (uvc->event_setup_out) { 218 uvc->event_setup_out = 0; 219 220 memset(&v4l2_event, 0, sizeof(v4l2_event)); 221 v4l2_event.type = UVC_EVENT_DATA; 222 uvc_event->data.length = req->actual; 223 memcpy(&uvc_event->data.data, req->buf, req->actual); 224 v4l2_event_queue(&uvc->vdev, &v4l2_event); 225 } 226 } 227 228 static int 229 uvc_function_setup(struct usb_function *f, const struct usb_ctrlrequest *ctrl) 230 { 231 struct uvc_device *uvc = to_uvc(f); 232 struct v4l2_event v4l2_event; 233 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data; 234 235 /* printk(KERN_INFO "setup request %02x %02x value %04x index %04x %04x\n", 236 * ctrl->bRequestType, ctrl->bRequest, le16_to_cpu(ctrl->wValue), 237 * le16_to_cpu(ctrl->wIndex), le16_to_cpu(ctrl->wLength)); 238 */ 239 240 if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_CLASS) { 241 INFO(f->config->cdev, "invalid request type\n"); 242 return -EINVAL; 243 } 244 245 /* Stall too big requests. */ 246 if (le16_to_cpu(ctrl->wLength) > UVC_MAX_REQUEST_SIZE) 247 return -EINVAL; 248 249 /* Tell the complete callback to generate an event for the next request 250 * that will be enqueued by UVCIOC_SEND_RESPONSE. 251 */ 252 uvc->event_setup_out = !(ctrl->bRequestType & USB_DIR_IN); 253 uvc->event_length = le16_to_cpu(ctrl->wLength); 254 255 memset(&v4l2_event, 0, sizeof(v4l2_event)); 256 v4l2_event.type = UVC_EVENT_SETUP; 257 memcpy(&uvc_event->req, ctrl, sizeof(uvc_event->req)); 258 v4l2_event_queue(&uvc->vdev, &v4l2_event); 259 260 return 0; 261 } 262 263 void uvc_function_setup_continue(struct uvc_device *uvc) 264 { 265 struct usb_composite_dev *cdev = uvc->func.config->cdev; 266 267 usb_composite_setup_continue(cdev); 268 } 269 270 static int 271 uvc_function_get_alt(struct usb_function *f, unsigned interface) 272 { 273 struct uvc_device *uvc = to_uvc(f); 274 275 INFO(f->config->cdev, "uvc_function_get_alt(%u)\n", interface); 276 277 if (interface == uvc->control_intf) 278 return 0; 279 else if (interface != uvc->streaming_intf) 280 return -EINVAL; 281 else 282 return uvc->video.ep->enabled ? 1 : 0; 283 } 284 285 static int 286 uvc_function_set_alt(struct usb_function *f, unsigned interface, unsigned alt) 287 { 288 struct uvc_device *uvc = to_uvc(f); 289 struct usb_composite_dev *cdev = f->config->cdev; 290 struct v4l2_event v4l2_event; 291 struct uvc_event *uvc_event = (void *)&v4l2_event.u.data; 292 int ret; 293 294 INFO(cdev, "uvc_function_set_alt(%u, %u)\n", interface, alt); 295 296 if (interface == uvc->control_intf) { 297 if (alt) 298 return -EINVAL; 299 300 INFO(cdev, "reset UVC Control\n"); 301 usb_ep_disable(uvc->control_ep); 302 303 if (!uvc->control_ep->desc) 304 if (config_ep_by_speed(cdev->gadget, f, uvc->control_ep)) 305 return -EINVAL; 306 307 usb_ep_enable(uvc->control_ep); 308 309 if (uvc->state == UVC_STATE_DISCONNECTED) { 310 memset(&v4l2_event, 0, sizeof(v4l2_event)); 311 v4l2_event.type = UVC_EVENT_CONNECT; 312 uvc_event->speed = cdev->gadget->speed; 313 v4l2_event_queue(&uvc->vdev, &v4l2_event); 314 315 uvc->state = UVC_STATE_CONNECTED; 316 } 317 318 return 0; 319 } 320 321 if (interface != uvc->streaming_intf) 322 return -EINVAL; 323 324 /* TODO 325 if (usb_endpoint_xfer_bulk(&uvc->desc.vs_ep)) 326 return alt ? -EINVAL : 0; 327 */ 328 329 switch (alt) { 330 case 0: 331 if (uvc->state != UVC_STATE_STREAMING) 332 return 0; 333 334 if (uvc->video.ep) 335 usb_ep_disable(uvc->video.ep); 336 337 memset(&v4l2_event, 0, sizeof(v4l2_event)); 338 v4l2_event.type = UVC_EVENT_STREAMOFF; 339 v4l2_event_queue(&uvc->vdev, &v4l2_event); 340 341 uvc->state = UVC_STATE_CONNECTED; 342 return 0; 343 344 case 1: 345 if (uvc->state != UVC_STATE_CONNECTED) 346 return 0; 347 348 if (!uvc->video.ep) 349 return -EINVAL; 350 351 INFO(cdev, "reset UVC\n"); 352 usb_ep_disable(uvc->video.ep); 353 354 ret = config_ep_by_speed(f->config->cdev->gadget, 355 &(uvc->func), uvc->video.ep); 356 if (ret) 357 return ret; 358 usb_ep_enable(uvc->video.ep); 359 360 memset(&v4l2_event, 0, sizeof(v4l2_event)); 361 v4l2_event.type = UVC_EVENT_STREAMON; 362 v4l2_event_queue(&uvc->vdev, &v4l2_event); 363 return USB_GADGET_DELAYED_STATUS; 364 365 default: 366 return -EINVAL; 367 } 368 } 369 370 static void 371 uvc_function_disable(struct usb_function *f) 372 { 373 struct uvc_device *uvc = to_uvc(f); 374 struct v4l2_event v4l2_event; 375 376 INFO(f->config->cdev, "uvc_function_disable\n"); 377 378 memset(&v4l2_event, 0, sizeof(v4l2_event)); 379 v4l2_event.type = UVC_EVENT_DISCONNECT; 380 v4l2_event_queue(&uvc->vdev, &v4l2_event); 381 382 uvc->state = UVC_STATE_DISCONNECTED; 383 384 usb_ep_disable(uvc->video.ep); 385 usb_ep_disable(uvc->control_ep); 386 } 387 388 /* -------------------------------------------------------------------------- 389 * Connection / disconnection 390 */ 391 392 void 393 uvc_function_connect(struct uvc_device *uvc) 394 { 395 struct usb_composite_dev *cdev = uvc->func.config->cdev; 396 int ret; 397 398 if ((ret = usb_function_activate(&uvc->func)) < 0) 399 INFO(cdev, "UVC connect failed with %d\n", ret); 400 } 401 402 void 403 uvc_function_disconnect(struct uvc_device *uvc) 404 { 405 struct usb_composite_dev *cdev = uvc->func.config->cdev; 406 int ret; 407 408 if ((ret = usb_function_deactivate(&uvc->func)) < 0) 409 INFO(cdev, "UVC disconnect failed with %d\n", ret); 410 } 411 412 /* -------------------------------------------------------------------------- 413 * USB probe and disconnect 414 */ 415 416 static ssize_t function_name_show(struct device *dev, 417 struct device_attribute *attr, char *buf) 418 { 419 struct uvc_device *uvc = dev_get_drvdata(dev); 420 421 return sprintf(buf, "%s\n", uvc->func.fi->group.cg_item.ci_name); 422 } 423 424 static DEVICE_ATTR_RO(function_name); 425 426 static int 427 uvc_register_video(struct uvc_device *uvc) 428 { 429 struct usb_composite_dev *cdev = uvc->func.config->cdev; 430 int ret; 431 432 /* TODO reference counting. */ 433 uvc->vdev.v4l2_dev = &uvc->v4l2_dev; 434 uvc->vdev.fops = &uvc_v4l2_fops; 435 uvc->vdev.ioctl_ops = &uvc_v4l2_ioctl_ops; 436 uvc->vdev.release = video_device_release_empty; 437 uvc->vdev.vfl_dir = VFL_DIR_TX; 438 uvc->vdev.lock = &uvc->video.mutex; 439 strlcpy(uvc->vdev.name, cdev->gadget->name, sizeof(uvc->vdev.name)); 440 441 video_set_drvdata(&uvc->vdev, uvc); 442 443 ret = video_register_device(&uvc->vdev, VFL_TYPE_GRABBER, -1); 444 if (ret < 0) 445 return ret; 446 447 ret = device_create_file(&uvc->vdev.dev, &dev_attr_function_name); 448 if (ret < 0) { 449 video_unregister_device(&uvc->vdev); 450 return ret; 451 } 452 453 return 0; 454 } 455 456 #define UVC_COPY_DESCRIPTOR(mem, dst, desc) \ 457 do { \ 458 memcpy(mem, desc, (desc)->bLength); \ 459 *(dst)++ = mem; \ 460 mem += (desc)->bLength; \ 461 } while (0); 462 463 #define UVC_COPY_DESCRIPTORS(mem, dst, src) \ 464 do { \ 465 const struct usb_descriptor_header * const *__src; \ 466 for (__src = src; *__src; ++__src) { \ 467 memcpy(mem, *__src, (*__src)->bLength); \ 468 *dst++ = mem; \ 469 mem += (*__src)->bLength; \ 470 } \ 471 } while (0) 472 473 static struct usb_descriptor_header ** 474 uvc_copy_descriptors(struct uvc_device *uvc, enum usb_device_speed speed) 475 { 476 struct uvc_input_header_descriptor *uvc_streaming_header; 477 struct uvc_header_descriptor *uvc_control_header; 478 const struct uvc_descriptor_header * const *uvc_control_desc; 479 const struct uvc_descriptor_header * const *uvc_streaming_cls; 480 const struct usb_descriptor_header * const *uvc_streaming_std; 481 const struct usb_descriptor_header * const *src; 482 struct usb_descriptor_header **dst; 483 struct usb_descriptor_header **hdr; 484 unsigned int control_size; 485 unsigned int streaming_size; 486 unsigned int n_desc; 487 unsigned int bytes; 488 void *mem; 489 490 switch (speed) { 491 case USB_SPEED_SUPER: 492 uvc_control_desc = uvc->desc.ss_control; 493 uvc_streaming_cls = uvc->desc.ss_streaming; 494 uvc_streaming_std = uvc_ss_streaming; 495 break; 496 497 case USB_SPEED_HIGH: 498 uvc_control_desc = uvc->desc.fs_control; 499 uvc_streaming_cls = uvc->desc.hs_streaming; 500 uvc_streaming_std = uvc_hs_streaming; 501 break; 502 503 case USB_SPEED_FULL: 504 default: 505 uvc_control_desc = uvc->desc.fs_control; 506 uvc_streaming_cls = uvc->desc.fs_streaming; 507 uvc_streaming_std = uvc_fs_streaming; 508 break; 509 } 510 511 if (!uvc_control_desc || !uvc_streaming_cls) 512 return ERR_PTR(-ENODEV); 513 514 /* Descriptors layout 515 * 516 * uvc_iad 517 * uvc_control_intf 518 * Class-specific UVC control descriptors 519 * uvc_control_ep 520 * uvc_control_cs_ep 521 * uvc_ss_control_comp (for SS only) 522 * uvc_streaming_intf_alt0 523 * Class-specific UVC streaming descriptors 524 * uvc_{fs|hs}_streaming 525 */ 526 527 /* Count descriptors and compute their size. */ 528 control_size = 0; 529 streaming_size = 0; 530 bytes = uvc_iad.bLength + uvc_control_intf.bLength 531 + uvc_control_ep.bLength + uvc_control_cs_ep.bLength 532 + uvc_streaming_intf_alt0.bLength; 533 534 if (speed == USB_SPEED_SUPER) { 535 bytes += uvc_ss_control_comp.bLength; 536 n_desc = 6; 537 } else { 538 n_desc = 5; 539 } 540 541 for (src = (const struct usb_descriptor_header **)uvc_control_desc; 542 *src; ++src) { 543 control_size += (*src)->bLength; 544 bytes += (*src)->bLength; 545 n_desc++; 546 } 547 for (src = (const struct usb_descriptor_header **)uvc_streaming_cls; 548 *src; ++src) { 549 streaming_size += (*src)->bLength; 550 bytes += (*src)->bLength; 551 n_desc++; 552 } 553 for (src = uvc_streaming_std; *src; ++src) { 554 bytes += (*src)->bLength; 555 n_desc++; 556 } 557 558 mem = kmalloc((n_desc + 1) * sizeof(*src) + bytes, GFP_KERNEL); 559 if (mem == NULL) 560 return NULL; 561 562 hdr = mem; 563 dst = mem; 564 mem += (n_desc + 1) * sizeof(*src); 565 566 /* Copy the descriptors. */ 567 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_iad); 568 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_intf); 569 570 uvc_control_header = mem; 571 UVC_COPY_DESCRIPTORS(mem, dst, 572 (const struct usb_descriptor_header **)uvc_control_desc); 573 uvc_control_header->wTotalLength = cpu_to_le16(control_size); 574 uvc_control_header->bInCollection = 1; 575 uvc_control_header->baInterfaceNr[0] = uvc->streaming_intf; 576 577 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_ep); 578 if (speed == USB_SPEED_SUPER) 579 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_ss_control_comp); 580 581 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_control_cs_ep); 582 UVC_COPY_DESCRIPTOR(mem, dst, &uvc_streaming_intf_alt0); 583 584 uvc_streaming_header = mem; 585 UVC_COPY_DESCRIPTORS(mem, dst, 586 (const struct usb_descriptor_header**)uvc_streaming_cls); 587 uvc_streaming_header->wTotalLength = cpu_to_le16(streaming_size); 588 uvc_streaming_header->bEndpointAddress = uvc->video.ep->address; 589 590 UVC_COPY_DESCRIPTORS(mem, dst, uvc_streaming_std); 591 592 *dst = NULL; 593 return hdr; 594 } 595 596 static int 597 uvc_function_bind(struct usb_configuration *c, struct usb_function *f) 598 { 599 struct usb_composite_dev *cdev = c->cdev; 600 struct uvc_device *uvc = to_uvc(f); 601 struct usb_string *us; 602 unsigned int max_packet_mult; 603 unsigned int max_packet_size; 604 struct usb_ep *ep; 605 struct f_uvc_opts *opts; 606 int ret = -EINVAL; 607 608 INFO(cdev, "uvc_function_bind\n"); 609 610 opts = fi_to_f_uvc_opts(f->fi); 611 /* Sanity check the streaming endpoint module parameters. 612 */ 613 opts->streaming_interval = clamp(opts->streaming_interval, 1U, 16U); 614 opts->streaming_maxpacket = clamp(opts->streaming_maxpacket, 1U, 3072U); 615 opts->streaming_maxburst = min(opts->streaming_maxburst, 15U); 616 617 /* For SS, wMaxPacketSize has to be 1024 if bMaxBurst is not 0 */ 618 if (opts->streaming_maxburst && 619 (opts->streaming_maxpacket % 1024) != 0) { 620 opts->streaming_maxpacket = roundup(opts->streaming_maxpacket, 1024); 621 INFO(cdev, "overriding streaming_maxpacket to %d\n", 622 opts->streaming_maxpacket); 623 } 624 625 /* Fill in the FS/HS/SS Video Streaming specific descriptors from the 626 * module parameters. 627 * 628 * NOTE: We assume that the user knows what they are doing and won't 629 * give parameters that their UDC doesn't support. 630 */ 631 if (opts->streaming_maxpacket <= 1024) { 632 max_packet_mult = 1; 633 max_packet_size = opts->streaming_maxpacket; 634 } else if (opts->streaming_maxpacket <= 2048) { 635 max_packet_mult = 2; 636 max_packet_size = opts->streaming_maxpacket / 2; 637 } else { 638 max_packet_mult = 3; 639 max_packet_size = opts->streaming_maxpacket / 3; 640 } 641 642 uvc_fs_streaming_ep.wMaxPacketSize = 643 cpu_to_le16(min(opts->streaming_maxpacket, 1023U)); 644 uvc_fs_streaming_ep.bInterval = opts->streaming_interval; 645 646 uvc_hs_streaming_ep.wMaxPacketSize = 647 cpu_to_le16(max_packet_size | ((max_packet_mult - 1) << 11)); 648 uvc_hs_streaming_ep.bInterval = opts->streaming_interval; 649 650 uvc_ss_streaming_ep.wMaxPacketSize = cpu_to_le16(max_packet_size); 651 uvc_ss_streaming_ep.bInterval = opts->streaming_interval; 652 uvc_ss_streaming_comp.bmAttributes = max_packet_mult - 1; 653 uvc_ss_streaming_comp.bMaxBurst = opts->streaming_maxburst; 654 uvc_ss_streaming_comp.wBytesPerInterval = 655 cpu_to_le16(max_packet_size * max_packet_mult * 656 (opts->streaming_maxburst + 1)); 657 658 /* Allocate endpoints. */ 659 ep = usb_ep_autoconfig(cdev->gadget, &uvc_control_ep); 660 if (!ep) { 661 INFO(cdev, "Unable to allocate control EP\n"); 662 goto error; 663 } 664 uvc->control_ep = ep; 665 666 if (gadget_is_superspeed(c->cdev->gadget)) 667 ep = usb_ep_autoconfig_ss(cdev->gadget, &uvc_ss_streaming_ep, 668 &uvc_ss_streaming_comp); 669 else if (gadget_is_dualspeed(cdev->gadget)) 670 ep = usb_ep_autoconfig(cdev->gadget, &uvc_hs_streaming_ep); 671 else 672 ep = usb_ep_autoconfig(cdev->gadget, &uvc_fs_streaming_ep); 673 674 if (!ep) { 675 INFO(cdev, "Unable to allocate streaming EP\n"); 676 goto error; 677 } 678 uvc->video.ep = ep; 679 680 uvc_fs_streaming_ep.bEndpointAddress = uvc->video.ep->address; 681 uvc_hs_streaming_ep.bEndpointAddress = uvc->video.ep->address; 682 uvc_ss_streaming_ep.bEndpointAddress = uvc->video.ep->address; 683 684 us = usb_gstrings_attach(cdev, uvc_function_strings, 685 ARRAY_SIZE(uvc_en_us_strings)); 686 if (IS_ERR(us)) { 687 ret = PTR_ERR(us); 688 goto error; 689 } 690 uvc_iad.iFunction = us[UVC_STRING_CONTROL_IDX].id; 691 uvc_control_intf.iInterface = us[UVC_STRING_CONTROL_IDX].id; 692 ret = us[UVC_STRING_STREAMING_IDX].id; 693 uvc_streaming_intf_alt0.iInterface = ret; 694 uvc_streaming_intf_alt1.iInterface = ret; 695 696 /* Allocate interface IDs. */ 697 if ((ret = usb_interface_id(c, f)) < 0) 698 goto error; 699 uvc_iad.bFirstInterface = ret; 700 uvc_control_intf.bInterfaceNumber = ret; 701 uvc->control_intf = ret; 702 703 if ((ret = usb_interface_id(c, f)) < 0) 704 goto error; 705 uvc_streaming_intf_alt0.bInterfaceNumber = ret; 706 uvc_streaming_intf_alt1.bInterfaceNumber = ret; 707 uvc->streaming_intf = ret; 708 709 /* Copy descriptors */ 710 f->fs_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_FULL); 711 if (IS_ERR(f->fs_descriptors)) { 712 ret = PTR_ERR(f->fs_descriptors); 713 f->fs_descriptors = NULL; 714 goto error; 715 } 716 if (gadget_is_dualspeed(cdev->gadget)) { 717 f->hs_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_HIGH); 718 if (IS_ERR(f->hs_descriptors)) { 719 ret = PTR_ERR(f->hs_descriptors); 720 f->hs_descriptors = NULL; 721 goto error; 722 } 723 } 724 if (gadget_is_superspeed(c->cdev->gadget)) { 725 f->ss_descriptors = uvc_copy_descriptors(uvc, USB_SPEED_SUPER); 726 if (IS_ERR(f->ss_descriptors)) { 727 ret = PTR_ERR(f->ss_descriptors); 728 f->ss_descriptors = NULL; 729 goto error; 730 } 731 } 732 733 /* Preallocate control endpoint request. */ 734 uvc->control_req = usb_ep_alloc_request(cdev->gadget->ep0, GFP_KERNEL); 735 uvc->control_buf = kmalloc(UVC_MAX_REQUEST_SIZE, GFP_KERNEL); 736 if (uvc->control_req == NULL || uvc->control_buf == NULL) { 737 ret = -ENOMEM; 738 goto error; 739 } 740 741 uvc->control_req->buf = uvc->control_buf; 742 uvc->control_req->complete = uvc_function_ep0_complete; 743 uvc->control_req->context = uvc; 744 745 if (v4l2_device_register(&cdev->gadget->dev, &uvc->v4l2_dev)) { 746 printk(KERN_INFO "v4l2_device_register failed\n"); 747 goto error; 748 } 749 750 /* Initialise video. */ 751 ret = uvcg_video_init(&uvc->video); 752 if (ret < 0) 753 goto error; 754 755 /* Register a V4L2 device. */ 756 ret = uvc_register_video(uvc); 757 if (ret < 0) { 758 printk(KERN_INFO "Unable to register video device\n"); 759 goto error; 760 } 761 762 return 0; 763 764 error: 765 v4l2_device_unregister(&uvc->v4l2_dev); 766 767 if (uvc->control_req) 768 usb_ep_free_request(cdev->gadget->ep0, uvc->control_req); 769 kfree(uvc->control_buf); 770 771 usb_free_all_descriptors(f); 772 return ret; 773 } 774 775 /* -------------------------------------------------------------------------- 776 * USB gadget function 777 */ 778 779 static void uvc_free_inst(struct usb_function_instance *f) 780 { 781 struct f_uvc_opts *opts = fi_to_f_uvc_opts(f); 782 783 mutex_destroy(&opts->lock); 784 kfree(opts); 785 } 786 787 static struct usb_function_instance *uvc_alloc_inst(void) 788 { 789 struct f_uvc_opts *opts; 790 struct uvc_camera_terminal_descriptor *cd; 791 struct uvc_processing_unit_descriptor *pd; 792 struct uvc_output_terminal_descriptor *od; 793 struct uvc_color_matching_descriptor *md; 794 struct uvc_descriptor_header **ctl_cls; 795 796 opts = kzalloc(sizeof(*opts), GFP_KERNEL); 797 if (!opts) 798 return ERR_PTR(-ENOMEM); 799 opts->func_inst.free_func_inst = uvc_free_inst; 800 mutex_init(&opts->lock); 801 802 cd = &opts->uvc_camera_terminal; 803 cd->bLength = UVC_DT_CAMERA_TERMINAL_SIZE(3); 804 cd->bDescriptorType = USB_DT_CS_INTERFACE; 805 cd->bDescriptorSubType = UVC_VC_INPUT_TERMINAL; 806 cd->bTerminalID = 1; 807 cd->wTerminalType = cpu_to_le16(0x0201); 808 cd->bAssocTerminal = 0; 809 cd->iTerminal = 0; 810 cd->wObjectiveFocalLengthMin = cpu_to_le16(0); 811 cd->wObjectiveFocalLengthMax = cpu_to_le16(0); 812 cd->wOcularFocalLength = cpu_to_le16(0); 813 cd->bControlSize = 3; 814 cd->bmControls[0] = 2; 815 cd->bmControls[1] = 0; 816 cd->bmControls[2] = 0; 817 818 pd = &opts->uvc_processing; 819 pd->bLength = UVC_DT_PROCESSING_UNIT_SIZE(2); 820 pd->bDescriptorType = USB_DT_CS_INTERFACE; 821 pd->bDescriptorSubType = UVC_VC_PROCESSING_UNIT; 822 pd->bUnitID = 2; 823 pd->bSourceID = 1; 824 pd->wMaxMultiplier = cpu_to_le16(16*1024); 825 pd->bControlSize = 2; 826 pd->bmControls[0] = 1; 827 pd->bmControls[1] = 0; 828 pd->iProcessing = 0; 829 830 od = &opts->uvc_output_terminal; 831 od->bLength = UVC_DT_OUTPUT_TERMINAL_SIZE; 832 od->bDescriptorType = USB_DT_CS_INTERFACE; 833 od->bDescriptorSubType = UVC_VC_OUTPUT_TERMINAL; 834 od->bTerminalID = 3; 835 od->wTerminalType = cpu_to_le16(0x0101); 836 od->bAssocTerminal = 0; 837 od->bSourceID = 2; 838 od->iTerminal = 0; 839 840 md = &opts->uvc_color_matching; 841 md->bLength = UVC_DT_COLOR_MATCHING_SIZE; 842 md->bDescriptorType = USB_DT_CS_INTERFACE; 843 md->bDescriptorSubType = UVC_VS_COLORFORMAT; 844 md->bColorPrimaries = 1; 845 md->bTransferCharacteristics = 1; 846 md->bMatrixCoefficients = 4; 847 848 /* Prepare fs control class descriptors for configfs-based gadgets */ 849 ctl_cls = opts->uvc_fs_control_cls; 850 ctl_cls[0] = NULL; /* assigned elsewhere by configfs */ 851 ctl_cls[1] = (struct uvc_descriptor_header *)cd; 852 ctl_cls[2] = (struct uvc_descriptor_header *)pd; 853 ctl_cls[3] = (struct uvc_descriptor_header *)od; 854 ctl_cls[4] = NULL; /* NULL-terminate */ 855 opts->fs_control = 856 (const struct uvc_descriptor_header * const *)ctl_cls; 857 858 /* Prepare hs control class descriptors for configfs-based gadgets */ 859 ctl_cls = opts->uvc_ss_control_cls; 860 ctl_cls[0] = NULL; /* assigned elsewhere by configfs */ 861 ctl_cls[1] = (struct uvc_descriptor_header *)cd; 862 ctl_cls[2] = (struct uvc_descriptor_header *)pd; 863 ctl_cls[3] = (struct uvc_descriptor_header *)od; 864 ctl_cls[4] = NULL; /* NULL-terminate */ 865 opts->ss_control = 866 (const struct uvc_descriptor_header * const *)ctl_cls; 867 868 opts->streaming_interval = 1; 869 opts->streaming_maxpacket = 1024; 870 871 uvcg_attach_configfs(opts); 872 return &opts->func_inst; 873 } 874 875 static void uvc_free(struct usb_function *f) 876 { 877 struct uvc_device *uvc = to_uvc(f); 878 struct f_uvc_opts *opts = container_of(f->fi, struct f_uvc_opts, 879 func_inst); 880 --opts->refcnt; 881 kfree(uvc); 882 } 883 884 static void uvc_unbind(struct usb_configuration *c, struct usb_function *f) 885 { 886 struct usb_composite_dev *cdev = c->cdev; 887 struct uvc_device *uvc = to_uvc(f); 888 889 INFO(cdev, "%s\n", __func__); 890 891 device_remove_file(&uvc->vdev.dev, &dev_attr_function_name); 892 video_unregister_device(&uvc->vdev); 893 v4l2_device_unregister(&uvc->v4l2_dev); 894 895 usb_ep_free_request(cdev->gadget->ep0, uvc->control_req); 896 kfree(uvc->control_buf); 897 898 usb_free_all_descriptors(f); 899 } 900 901 static struct usb_function *uvc_alloc(struct usb_function_instance *fi) 902 { 903 struct uvc_device *uvc; 904 struct f_uvc_opts *opts; 905 struct uvc_descriptor_header **strm_cls; 906 907 uvc = kzalloc(sizeof(*uvc), GFP_KERNEL); 908 if (uvc == NULL) 909 return ERR_PTR(-ENOMEM); 910 911 mutex_init(&uvc->video.mutex); 912 uvc->state = UVC_STATE_DISCONNECTED; 913 opts = fi_to_f_uvc_opts(fi); 914 915 mutex_lock(&opts->lock); 916 if (opts->uvc_fs_streaming_cls) { 917 strm_cls = opts->uvc_fs_streaming_cls; 918 opts->fs_streaming = 919 (const struct uvc_descriptor_header * const *)strm_cls; 920 } 921 if (opts->uvc_hs_streaming_cls) { 922 strm_cls = opts->uvc_hs_streaming_cls; 923 opts->hs_streaming = 924 (const struct uvc_descriptor_header * const *)strm_cls; 925 } 926 if (opts->uvc_ss_streaming_cls) { 927 strm_cls = opts->uvc_ss_streaming_cls; 928 opts->ss_streaming = 929 (const struct uvc_descriptor_header * const *)strm_cls; 930 } 931 932 uvc->desc.fs_control = opts->fs_control; 933 uvc->desc.ss_control = opts->ss_control; 934 uvc->desc.fs_streaming = opts->fs_streaming; 935 uvc->desc.hs_streaming = opts->hs_streaming; 936 uvc->desc.ss_streaming = opts->ss_streaming; 937 ++opts->refcnt; 938 mutex_unlock(&opts->lock); 939 940 /* Register the function. */ 941 uvc->func.name = "uvc"; 942 uvc->func.bind = uvc_function_bind; 943 uvc->func.unbind = uvc_unbind; 944 uvc->func.get_alt = uvc_function_get_alt; 945 uvc->func.set_alt = uvc_function_set_alt; 946 uvc->func.disable = uvc_function_disable; 947 uvc->func.setup = uvc_function_setup; 948 uvc->func.free_func = uvc_free; 949 uvc->func.bind_deactivated = true; 950 951 return &uvc->func; 952 } 953 954 DECLARE_USB_FUNCTION_INIT(uvc, uvc_alloc_inst, uvc_alloc); 955 MODULE_LICENSE("GPL"); 956 MODULE_AUTHOR("Laurent Pinchart"); 957