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