drivers/usb/gadget/function/f_uvc.c

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