Linux-libre 3.10.98-gnu
[librecmc/linux-libre.git] / drivers / media / usb / uvc / uvc_v4l2.c
1 /*
2  *      uvc_v4l2.c  --  USB Video Class driver - V4L2 API
3  *
4  *      Copyright (C) 2005-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
14 #include <linux/compat.h>
15 #include <linux/kernel.h>
16 #include <linux/version.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/usb.h>
21 #include <linux/videodev2.h>
22 #include <linux/vmalloc.h>
23 #include <linux/mm.h>
24 #include <linux/wait.h>
25 #include <linux/atomic.h>
26
27 #include <media/v4l2-common.h>
28 #include <media/v4l2-ctrls.h>
29 #include <media/v4l2-event.h>
30 #include <media/v4l2-ioctl.h>
31
32 #include "uvcvideo.h"
33
34 /* ------------------------------------------------------------------------
35  * UVC ioctls
36  */
37 static int uvc_ioctl_ctrl_map(struct uvc_video_chain *chain,
38         struct uvc_xu_control_mapping *xmap)
39 {
40         struct uvc_control_mapping *map;
41         unsigned int size;
42         int ret;
43
44         map = kzalloc(sizeof *map, GFP_KERNEL);
45         if (map == NULL)
46                 return -ENOMEM;
47
48         map->id = xmap->id;
49         memcpy(map->name, xmap->name, sizeof map->name);
50         memcpy(map->entity, xmap->entity, sizeof map->entity);
51         map->selector = xmap->selector;
52         map->size = xmap->size;
53         map->offset = xmap->offset;
54         map->v4l2_type = xmap->v4l2_type;
55         map->data_type = xmap->data_type;
56
57         switch (xmap->v4l2_type) {
58         case V4L2_CTRL_TYPE_INTEGER:
59         case V4L2_CTRL_TYPE_BOOLEAN:
60         case V4L2_CTRL_TYPE_BUTTON:
61                 break;
62
63         case V4L2_CTRL_TYPE_MENU:
64                 /* Prevent excessive memory consumption, as well as integer
65                  * overflows.
66                  */
67                 if (xmap->menu_count == 0 ||
68                     xmap->menu_count > UVC_MAX_CONTROL_MENU_ENTRIES) {
69                         ret = -EINVAL;
70                         goto done;
71                 }
72
73                 size = xmap->menu_count * sizeof(*map->menu_info);
74                 map->menu_info = kmalloc(size, GFP_KERNEL);
75                 if (map->menu_info == NULL) {
76                         ret = -ENOMEM;
77                         goto done;
78                 }
79
80                 if (copy_from_user(map->menu_info, xmap->menu_info, size)) {
81                         ret = -EFAULT;
82                         goto done;
83                 }
84
85                 map->menu_count = xmap->menu_count;
86                 break;
87
88         default:
89                 uvc_trace(UVC_TRACE_CONTROL, "Unsupported V4L2 control type "
90                           "%u.\n", xmap->v4l2_type);
91                 ret = -ENOTTY;
92                 goto done;
93         }
94
95         ret = uvc_ctrl_add_mapping(chain, map);
96
97 done:
98         kfree(map->menu_info);
99         kfree(map);
100
101         return ret;
102 }
103
104 /* ------------------------------------------------------------------------
105  * V4L2 interface
106  */
107
108 /*
109  * Find the frame interval closest to the requested frame interval for the
110  * given frame format and size. This should be done by the device as part of
111  * the Video Probe and Commit negotiation, but some hardware don't implement
112  * that feature.
113  */
114 static __u32 uvc_try_frame_interval(struct uvc_frame *frame, __u32 interval)
115 {
116         unsigned int i;
117
118         if (frame->bFrameIntervalType) {
119                 __u32 best = -1, dist;
120
121                 for (i = 0; i < frame->bFrameIntervalType; ++i) {
122                         dist = interval > frame->dwFrameInterval[i]
123                              ? interval - frame->dwFrameInterval[i]
124                              : frame->dwFrameInterval[i] - interval;
125
126                         if (dist > best)
127                                 break;
128
129                         best = dist;
130                 }
131
132                 interval = frame->dwFrameInterval[i-1];
133         } else {
134                 const __u32 min = frame->dwFrameInterval[0];
135                 const __u32 max = frame->dwFrameInterval[1];
136                 const __u32 step = frame->dwFrameInterval[2];
137
138                 interval = min + (interval - min + step/2) / step * step;
139                 if (interval > max)
140                         interval = max;
141         }
142
143         return interval;
144 }
145
146 static int uvc_v4l2_try_format(struct uvc_streaming *stream,
147         struct v4l2_format *fmt, struct uvc_streaming_control *probe,
148         struct uvc_format **uvc_format, struct uvc_frame **uvc_frame)
149 {
150         struct uvc_format *format = NULL;
151         struct uvc_frame *frame = NULL;
152         __u16 rw, rh;
153         unsigned int d, maxd;
154         unsigned int i;
155         __u32 interval;
156         int ret = 0;
157         __u8 *fcc;
158
159         if (fmt->type != stream->type)
160                 return -EINVAL;
161
162         fcc = (__u8 *)&fmt->fmt.pix.pixelformat;
163         uvc_trace(UVC_TRACE_FORMAT, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
164                         fmt->fmt.pix.pixelformat,
165                         fcc[0], fcc[1], fcc[2], fcc[3],
166                         fmt->fmt.pix.width, fmt->fmt.pix.height);
167
168         /* Check if the hardware supports the requested format, use the default
169          * format otherwise.
170          */
171         for (i = 0; i < stream->nformats; ++i) {
172                 format = &stream->format[i];
173                 if (format->fcc == fmt->fmt.pix.pixelformat)
174                         break;
175         }
176
177         if (i == stream->nformats) {
178                 format = stream->def_format;
179                 fmt->fmt.pix.pixelformat = format->fcc;
180         }
181
182         /* Find the closest image size. The distance between image sizes is
183          * the size in pixels of the non-overlapping regions between the
184          * requested size and the frame-specified size.
185          */
186         rw = fmt->fmt.pix.width;
187         rh = fmt->fmt.pix.height;
188         maxd = (unsigned int)-1;
189
190         for (i = 0; i < format->nframes; ++i) {
191                 __u16 w = format->frame[i].wWidth;
192                 __u16 h = format->frame[i].wHeight;
193
194                 d = min(w, rw) * min(h, rh);
195                 d = w*h + rw*rh - 2*d;
196                 if (d < maxd) {
197                         maxd = d;
198                         frame = &format->frame[i];
199                 }
200
201                 if (maxd == 0)
202                         break;
203         }
204
205         if (frame == NULL) {
206                 uvc_trace(UVC_TRACE_FORMAT, "Unsupported size %ux%u.\n",
207                                 fmt->fmt.pix.width, fmt->fmt.pix.height);
208                 return -EINVAL;
209         }
210
211         /* Use the default frame interval. */
212         interval = frame->dwDefaultFrameInterval;
213         uvc_trace(UVC_TRACE_FORMAT, "Using default frame interval %u.%u us "
214                 "(%u.%u fps).\n", interval/10, interval%10, 10000000/interval,
215                 (100000000/interval)%10);
216
217         /* Set the format index, frame index and frame interval. */
218         memset(probe, 0, sizeof *probe);
219         probe->bmHint = 1;      /* dwFrameInterval */
220         probe->bFormatIndex = format->index;
221         probe->bFrameIndex = frame->bFrameIndex;
222         probe->dwFrameInterval = uvc_try_frame_interval(frame, interval);
223         /* Some webcams stall the probe control set request when the
224          * dwMaxVideoFrameSize field is set to zero. The UVC specification
225          * clearly states that the field is read-only from the host, so this
226          * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
227          * the webcam to work around the problem.
228          *
229          * The workaround could probably be enabled for all webcams, so the
230          * quirk can be removed if needed. It's currently useful to detect
231          * webcam bugs and fix them before they hit the market (providing
232          * developers test their webcams with the Linux driver as well as with
233          * the Windows driver).
234          */
235         mutex_lock(&stream->mutex);
236         if (stream->dev->quirks & UVC_QUIRK_PROBE_EXTRAFIELDS)
237                 probe->dwMaxVideoFrameSize =
238                         stream->ctrl.dwMaxVideoFrameSize;
239
240         /* Probe the device. */
241         ret = uvc_probe_video(stream, probe);
242         mutex_unlock(&stream->mutex);
243         if (ret < 0)
244                 goto done;
245
246         fmt->fmt.pix.width = frame->wWidth;
247         fmt->fmt.pix.height = frame->wHeight;
248         fmt->fmt.pix.field = V4L2_FIELD_NONE;
249         fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
250         fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
251         fmt->fmt.pix.colorspace = format->colorspace;
252         fmt->fmt.pix.priv = 0;
253
254         if (uvc_format != NULL)
255                 *uvc_format = format;
256         if (uvc_frame != NULL)
257                 *uvc_frame = frame;
258
259 done:
260         return ret;
261 }
262
263 static int uvc_v4l2_get_format(struct uvc_streaming *stream,
264         struct v4l2_format *fmt)
265 {
266         struct uvc_format *format;
267         struct uvc_frame *frame;
268         int ret = 0;
269
270         if (fmt->type != stream->type)
271                 return -EINVAL;
272
273         mutex_lock(&stream->mutex);
274         format = stream->cur_format;
275         frame = stream->cur_frame;
276
277         if (format == NULL || frame == NULL) {
278                 ret = -EINVAL;
279                 goto done;
280         }
281
282         fmt->fmt.pix.pixelformat = format->fcc;
283         fmt->fmt.pix.width = frame->wWidth;
284         fmt->fmt.pix.height = frame->wHeight;
285         fmt->fmt.pix.field = V4L2_FIELD_NONE;
286         fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
287         fmt->fmt.pix.sizeimage = stream->ctrl.dwMaxVideoFrameSize;
288         fmt->fmt.pix.colorspace = format->colorspace;
289         fmt->fmt.pix.priv = 0;
290
291 done:
292         mutex_unlock(&stream->mutex);
293         return ret;
294 }
295
296 static int uvc_v4l2_set_format(struct uvc_streaming *stream,
297         struct v4l2_format *fmt)
298 {
299         struct uvc_streaming_control probe;
300         struct uvc_format *format;
301         struct uvc_frame *frame;
302         int ret;
303
304         if (fmt->type != stream->type)
305                 return -EINVAL;
306
307         ret = uvc_v4l2_try_format(stream, fmt, &probe, &format, &frame);
308         if (ret < 0)
309                 return ret;
310
311         mutex_lock(&stream->mutex);
312
313         if (uvc_queue_allocated(&stream->queue)) {
314                 ret = -EBUSY;
315                 goto done;
316         }
317
318         stream->ctrl = probe;
319         stream->cur_format = format;
320         stream->cur_frame = frame;
321
322 done:
323         mutex_unlock(&stream->mutex);
324         return ret;
325 }
326
327 static int uvc_v4l2_get_streamparm(struct uvc_streaming *stream,
328                 struct v4l2_streamparm *parm)
329 {
330         uint32_t numerator, denominator;
331
332         if (parm->type != stream->type)
333                 return -EINVAL;
334
335         mutex_lock(&stream->mutex);
336         numerator = stream->ctrl.dwFrameInterval;
337         mutex_unlock(&stream->mutex);
338
339         denominator = 10000000;
340         uvc_simplify_fraction(&numerator, &denominator, 8, 333);
341
342         memset(parm, 0, sizeof *parm);
343         parm->type = stream->type;
344
345         if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
346                 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
347                 parm->parm.capture.capturemode = 0;
348                 parm->parm.capture.timeperframe.numerator = numerator;
349                 parm->parm.capture.timeperframe.denominator = denominator;
350                 parm->parm.capture.extendedmode = 0;
351                 parm->parm.capture.readbuffers = 0;
352         } else {
353                 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
354                 parm->parm.output.outputmode = 0;
355                 parm->parm.output.timeperframe.numerator = numerator;
356                 parm->parm.output.timeperframe.denominator = denominator;
357         }
358
359         return 0;
360 }
361
362 static int uvc_v4l2_set_streamparm(struct uvc_streaming *stream,
363                 struct v4l2_streamparm *parm)
364 {
365         struct uvc_streaming_control probe;
366         struct v4l2_fract timeperframe;
367         uint32_t interval;
368         int ret;
369
370         if (parm->type != stream->type)
371                 return -EINVAL;
372
373         if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
374                 timeperframe = parm->parm.capture.timeperframe;
375         else
376                 timeperframe = parm->parm.output.timeperframe;
377
378         interval = uvc_fraction_to_interval(timeperframe.numerator,
379                 timeperframe.denominator);
380         uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
381                 timeperframe.numerator, timeperframe.denominator, interval);
382
383         mutex_lock(&stream->mutex);
384
385         if (uvc_queue_streaming(&stream->queue)) {
386                 mutex_unlock(&stream->mutex);
387                 return -EBUSY;
388         }
389
390         probe = stream->ctrl;
391         probe.dwFrameInterval =
392                 uvc_try_frame_interval(stream->cur_frame, interval);
393
394         /* Probe the device with the new settings. */
395         ret = uvc_probe_video(stream, &probe);
396         if (ret < 0) {
397                 mutex_unlock(&stream->mutex);
398                 return ret;
399         }
400
401         stream->ctrl = probe;
402         mutex_unlock(&stream->mutex);
403
404         /* Return the actual frame period. */
405         timeperframe.numerator = probe.dwFrameInterval;
406         timeperframe.denominator = 10000000;
407         uvc_simplify_fraction(&timeperframe.numerator,
408                 &timeperframe.denominator, 8, 333);
409
410         if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
411                 parm->parm.capture.timeperframe = timeperframe;
412         else
413                 parm->parm.output.timeperframe = timeperframe;
414
415         return 0;
416 }
417
418 /* ------------------------------------------------------------------------
419  * Privilege management
420  */
421
422 /*
423  * Privilege management is the multiple-open implementation basis. The current
424  * implementation is completely transparent for the end-user and doesn't
425  * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
426  * Those ioctls enable finer control on the device (by making possible for a
427  * user to request exclusive access to a device), but are not mature yet.
428  * Switching to the V4L2 priority mechanism might be considered in the future
429  * if this situation changes.
430  *
431  * Each open instance of a UVC device can either be in a privileged or
432  * unprivileged state. Only a single instance can be in a privileged state at
433  * a given time. Trying to perform an operation that requires privileges will
434  * automatically acquire the required privileges if possible, or return -EBUSY
435  * otherwise. Privileges are dismissed when closing the instance or when
436  * freeing the video buffers using VIDIOC_REQBUFS.
437  *
438  * Operations that require privileges are:
439  *
440  * - VIDIOC_S_INPUT
441  * - VIDIOC_S_PARM
442  * - VIDIOC_S_FMT
443  * - VIDIOC_REQBUFS
444  */
445 static int uvc_acquire_privileges(struct uvc_fh *handle)
446 {
447         /* Always succeed if the handle is already privileged. */
448         if (handle->state == UVC_HANDLE_ACTIVE)
449                 return 0;
450
451         /* Check if the device already has a privileged handle. */
452         if (atomic_inc_return(&handle->stream->active) != 1) {
453                 atomic_dec(&handle->stream->active);
454                 return -EBUSY;
455         }
456
457         handle->state = UVC_HANDLE_ACTIVE;
458         return 0;
459 }
460
461 static void uvc_dismiss_privileges(struct uvc_fh *handle)
462 {
463         if (handle->state == UVC_HANDLE_ACTIVE)
464                 atomic_dec(&handle->stream->active);
465
466         handle->state = UVC_HANDLE_PASSIVE;
467 }
468
469 static int uvc_has_privileges(struct uvc_fh *handle)
470 {
471         return handle->state == UVC_HANDLE_ACTIVE;
472 }
473
474 /* ------------------------------------------------------------------------
475  * V4L2 file operations
476  */
477
478 static int uvc_v4l2_open(struct file *file)
479 {
480         struct uvc_streaming *stream;
481         struct uvc_fh *handle;
482         int ret = 0;
483
484         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
485         stream = video_drvdata(file);
486
487         if (stream->dev->state & UVC_DEV_DISCONNECTED)
488                 return -ENODEV;
489
490         ret = usb_autopm_get_interface(stream->dev->intf);
491         if (ret < 0)
492                 return ret;
493
494         /* Create the device handle. */
495         handle = kzalloc(sizeof *handle, GFP_KERNEL);
496         if (handle == NULL) {
497                 usb_autopm_put_interface(stream->dev->intf);
498                 return -ENOMEM;
499         }
500
501         if (atomic_inc_return(&stream->dev->users) == 1) {
502                 ret = uvc_status_start(stream->dev);
503                 if (ret < 0) {
504                         atomic_dec(&stream->dev->users);
505                         usb_autopm_put_interface(stream->dev->intf);
506                         kfree(handle);
507                         return ret;
508                 }
509         }
510
511         v4l2_fh_init(&handle->vfh, stream->vdev);
512         v4l2_fh_add(&handle->vfh);
513         handle->chain = stream->chain;
514         handle->stream = stream;
515         handle->state = UVC_HANDLE_PASSIVE;
516         file->private_data = handle;
517
518         return 0;
519 }
520
521 static int uvc_v4l2_release(struct file *file)
522 {
523         struct uvc_fh *handle = file->private_data;
524         struct uvc_streaming *stream = handle->stream;
525
526         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
527
528         /* Only free resources if this is a privileged handle. */
529         if (uvc_has_privileges(handle)) {
530                 uvc_video_enable(stream, 0);
531                 uvc_free_buffers(&stream->queue);
532         }
533
534         /* Release the file handle. */
535         uvc_dismiss_privileges(handle);
536         v4l2_fh_del(&handle->vfh);
537         v4l2_fh_exit(&handle->vfh);
538         kfree(handle);
539         file->private_data = NULL;
540
541         if (atomic_dec_return(&stream->dev->users) == 0)
542                 uvc_status_stop(stream->dev);
543
544         usb_autopm_put_interface(stream->dev->intf);
545         return 0;
546 }
547
548 static long uvc_v4l2_do_ioctl(struct file *file, unsigned int cmd, void *arg)
549 {
550         struct video_device *vdev = video_devdata(file);
551         struct uvc_fh *handle = file->private_data;
552         struct uvc_video_chain *chain = handle->chain;
553         struct uvc_streaming *stream = handle->stream;
554         long ret = 0;
555
556         switch (cmd) {
557         /* Query capabilities */
558         case VIDIOC_QUERYCAP:
559         {
560                 struct v4l2_capability *cap = arg;
561
562                 memset(cap, 0, sizeof *cap);
563                 strlcpy(cap->driver, "uvcvideo", sizeof cap->driver);
564                 strlcpy(cap->card, vdev->name, sizeof cap->card);
565                 usb_make_path(stream->dev->udev,
566                               cap->bus_info, sizeof(cap->bus_info));
567                 cap->version = LINUX_VERSION_CODE;
568                 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
569                                   | chain->caps;
570                 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
571                         cap->device_caps = V4L2_CAP_VIDEO_CAPTURE
572                                          | V4L2_CAP_STREAMING;
573                 else
574                         cap->device_caps = V4L2_CAP_VIDEO_OUTPUT
575                                          | V4L2_CAP_STREAMING;
576                 break;
577         }
578
579         /* Priority */
580         case VIDIOC_G_PRIORITY:
581                 *(u32 *)arg = v4l2_prio_max(vdev->prio);
582                 break;
583
584         case VIDIOC_S_PRIORITY:
585                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
586                 if (ret < 0)
587                         return ret;
588
589                 return v4l2_prio_change(vdev->prio, &handle->vfh.prio,
590                                         *(u32 *)arg);
591
592         /* Get, Set & Query control */
593         case VIDIOC_QUERYCTRL:
594                 return uvc_query_v4l2_ctrl(chain, arg);
595
596         case VIDIOC_G_CTRL:
597         {
598                 struct v4l2_control *ctrl = arg;
599                 struct v4l2_ext_control xctrl;
600
601                 memset(&xctrl, 0, sizeof xctrl);
602                 xctrl.id = ctrl->id;
603
604                 ret = uvc_ctrl_begin(chain);
605                 if (ret < 0)
606                         return ret;
607
608                 ret = uvc_ctrl_get(chain, &xctrl);
609                 uvc_ctrl_rollback(handle);
610                 if (ret >= 0)
611                         ctrl->value = xctrl.value;
612                 break;
613         }
614
615         case VIDIOC_S_CTRL:
616         {
617                 struct v4l2_control *ctrl = arg;
618                 struct v4l2_ext_control xctrl;
619
620                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
621                 if (ret < 0)
622                         return ret;
623
624                 memset(&xctrl, 0, sizeof xctrl);
625                 xctrl.id = ctrl->id;
626                 xctrl.value = ctrl->value;
627
628                 ret = uvc_ctrl_begin(chain);
629                 if (ret < 0)
630                         return ret;
631
632                 ret = uvc_ctrl_set(chain, &xctrl);
633                 if (ret < 0) {
634                         uvc_ctrl_rollback(handle);
635                         return ret;
636                 }
637                 ret = uvc_ctrl_commit(handle, &xctrl, 1);
638                 if (ret == 0)
639                         ctrl->value = xctrl.value;
640                 break;
641         }
642
643         case VIDIOC_QUERYMENU:
644                 return uvc_query_v4l2_menu(chain, arg);
645
646         case VIDIOC_G_EXT_CTRLS:
647         {
648                 struct v4l2_ext_controls *ctrls = arg;
649                 struct v4l2_ext_control *ctrl = ctrls->controls;
650                 unsigned int i;
651
652                 ret = uvc_ctrl_begin(chain);
653                 if (ret < 0)
654                         return ret;
655
656                 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
657                         ret = uvc_ctrl_get(chain, ctrl);
658                         if (ret < 0) {
659                                 uvc_ctrl_rollback(handle);
660                                 ctrls->error_idx = i;
661                                 return ret;
662                         }
663                 }
664                 ctrls->error_idx = 0;
665                 ret = uvc_ctrl_rollback(handle);
666                 break;
667         }
668
669         case VIDIOC_S_EXT_CTRLS:
670                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
671                 if (ret < 0)
672                         return ret;
673                 /* Fall through */
674         case VIDIOC_TRY_EXT_CTRLS:
675         {
676                 struct v4l2_ext_controls *ctrls = arg;
677                 struct v4l2_ext_control *ctrl = ctrls->controls;
678                 unsigned int i;
679
680                 ret = uvc_ctrl_begin(chain);
681                 if (ret < 0)
682                         return ret;
683
684                 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
685                         ret = uvc_ctrl_set(chain, ctrl);
686                         if (ret < 0) {
687                                 uvc_ctrl_rollback(handle);
688                                 ctrls->error_idx = cmd == VIDIOC_S_EXT_CTRLS
689                                                  ? ctrls->count : i;
690                                 return ret;
691                         }
692                 }
693
694                 ctrls->error_idx = 0;
695
696                 if (cmd == VIDIOC_S_EXT_CTRLS)
697                         ret = uvc_ctrl_commit(handle,
698                                               ctrls->controls, ctrls->count);
699                 else
700                         ret = uvc_ctrl_rollback(handle);
701                 break;
702         }
703
704         /* Get, Set & Enum input */
705         case VIDIOC_ENUMINPUT:
706         {
707                 const struct uvc_entity *selector = chain->selector;
708                 struct v4l2_input *input = arg;
709                 struct uvc_entity *iterm = NULL;
710                 u32 index = input->index;
711                 int pin = 0;
712
713                 if (selector == NULL ||
714                     (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
715                         if (index != 0)
716                                 return -EINVAL;
717                         list_for_each_entry(iterm, &chain->entities, chain) {
718                                 if (UVC_ENTITY_IS_ITERM(iterm))
719                                         break;
720                         }
721                         pin = iterm->id;
722                 } else if (index < selector->bNrInPins) {
723                         pin = selector->baSourceID[index];
724                         list_for_each_entry(iterm, &chain->entities, chain) {
725                                 if (!UVC_ENTITY_IS_ITERM(iterm))
726                                         continue;
727                                 if (iterm->id == pin)
728                                         break;
729                         }
730                 }
731
732                 if (iterm == NULL || iterm->id != pin)
733                         return -EINVAL;
734
735                 memset(input, 0, sizeof *input);
736                 input->index = index;
737                 strlcpy(input->name, iterm->name, sizeof input->name);
738                 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
739                         input->type = V4L2_INPUT_TYPE_CAMERA;
740                 break;
741         }
742
743         case VIDIOC_G_INPUT:
744         {
745                 u8 input;
746
747                 if (chain->selector == NULL ||
748                     (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
749                         *(int *)arg = 0;
750                         break;
751                 }
752
753                 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR,
754                         chain->selector->id, chain->dev->intfnum,
755                         UVC_SU_INPUT_SELECT_CONTROL, &input, 1);
756                 if (ret < 0)
757                         return ret;
758
759                 *(int *)arg = input - 1;
760                 break;
761         }
762
763         case VIDIOC_S_INPUT:
764         {
765                 u32 input = *(u32 *)arg + 1;
766
767                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
768                 if (ret < 0)
769                         return ret;
770
771                 if ((ret = uvc_acquire_privileges(handle)) < 0)
772                         return ret;
773
774                 if (chain->selector == NULL ||
775                     (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
776                         if (input != 1)
777                                 return -EINVAL;
778                         break;
779                 }
780
781                 if (input == 0 || input > chain->selector->bNrInPins)
782                         return -EINVAL;
783
784                 return uvc_query_ctrl(chain->dev, UVC_SET_CUR,
785                         chain->selector->id, chain->dev->intfnum,
786                         UVC_SU_INPUT_SELECT_CONTROL, &input, 1);
787         }
788
789         /* Try, Get, Set & Enum format */
790         case VIDIOC_ENUM_FMT:
791         {
792                 struct v4l2_fmtdesc *fmt = arg;
793                 struct uvc_format *format;
794                 enum v4l2_buf_type type = fmt->type;
795                 __u32 index = fmt->index;
796
797                 if (fmt->type != stream->type ||
798                     fmt->index >= stream->nformats)
799                         return -EINVAL;
800
801                 memset(fmt, 0, sizeof(*fmt));
802                 fmt->index = index;
803                 fmt->type = type;
804
805                 format = &stream->format[fmt->index];
806                 fmt->flags = 0;
807                 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
808                         fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
809                 strlcpy(fmt->description, format->name,
810                         sizeof fmt->description);
811                 fmt->description[sizeof fmt->description - 1] = 0;
812                 fmt->pixelformat = format->fcc;
813                 break;
814         }
815
816         case VIDIOC_TRY_FMT:
817         {
818                 struct uvc_streaming_control probe;
819
820                 return uvc_v4l2_try_format(stream, arg, &probe, NULL, NULL);
821         }
822
823         case VIDIOC_S_FMT:
824                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
825                 if (ret < 0)
826                         return ret;
827
828                 if ((ret = uvc_acquire_privileges(handle)) < 0)
829                         return ret;
830
831                 return uvc_v4l2_set_format(stream, arg);
832
833         case VIDIOC_G_FMT:
834                 return uvc_v4l2_get_format(stream, arg);
835
836         /* Frame size enumeration */
837         case VIDIOC_ENUM_FRAMESIZES:
838         {
839                 struct v4l2_frmsizeenum *fsize = arg;
840                 struct uvc_format *format = NULL;
841                 struct uvc_frame *frame;
842                 int i;
843
844                 /* Look for the given pixel format */
845                 for (i = 0; i < stream->nformats; i++) {
846                         if (stream->format[i].fcc ==
847                                         fsize->pixel_format) {
848                                 format = &stream->format[i];
849                                 break;
850                         }
851                 }
852                 if (format == NULL)
853                         return -EINVAL;
854
855                 if (fsize->index >= format->nframes)
856                         return -EINVAL;
857
858                 frame = &format->frame[fsize->index];
859                 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
860                 fsize->discrete.width = frame->wWidth;
861                 fsize->discrete.height = frame->wHeight;
862                 break;
863         }
864
865         /* Frame interval enumeration */
866         case VIDIOC_ENUM_FRAMEINTERVALS:
867         {
868                 struct v4l2_frmivalenum *fival = arg;
869                 struct uvc_format *format = NULL;
870                 struct uvc_frame *frame = NULL;
871                 int i;
872
873                 /* Look for the given pixel format and frame size */
874                 for (i = 0; i < stream->nformats; i++) {
875                         if (stream->format[i].fcc ==
876                                         fival->pixel_format) {
877                                 format = &stream->format[i];
878                                 break;
879                         }
880                 }
881                 if (format == NULL)
882                         return -EINVAL;
883
884                 for (i = 0; i < format->nframes; i++) {
885                         if (format->frame[i].wWidth == fival->width &&
886                             format->frame[i].wHeight == fival->height) {
887                                 frame = &format->frame[i];
888                                 break;
889                         }
890                 }
891                 if (frame == NULL)
892                         return -EINVAL;
893
894                 if (frame->bFrameIntervalType) {
895                         if (fival->index >= frame->bFrameIntervalType)
896                                 return -EINVAL;
897
898                         fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
899                         fival->discrete.numerator =
900                                 frame->dwFrameInterval[fival->index];
901                         fival->discrete.denominator = 10000000;
902                         uvc_simplify_fraction(&fival->discrete.numerator,
903                                 &fival->discrete.denominator, 8, 333);
904                 } else {
905                         fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
906                         fival->stepwise.min.numerator =
907                                 frame->dwFrameInterval[0];
908                         fival->stepwise.min.denominator = 10000000;
909                         fival->stepwise.max.numerator =
910                                 frame->dwFrameInterval[1];
911                         fival->stepwise.max.denominator = 10000000;
912                         fival->stepwise.step.numerator =
913                                 frame->dwFrameInterval[2];
914                         fival->stepwise.step.denominator = 10000000;
915                         uvc_simplify_fraction(&fival->stepwise.min.numerator,
916                                 &fival->stepwise.min.denominator, 8, 333);
917                         uvc_simplify_fraction(&fival->stepwise.max.numerator,
918                                 &fival->stepwise.max.denominator, 8, 333);
919                         uvc_simplify_fraction(&fival->stepwise.step.numerator,
920                                 &fival->stepwise.step.denominator, 8, 333);
921                 }
922                 break;
923         }
924
925         /* Get & Set streaming parameters */
926         case VIDIOC_G_PARM:
927                 return uvc_v4l2_get_streamparm(stream, arg);
928
929         case VIDIOC_S_PARM:
930                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
931                 if (ret < 0)
932                         return ret;
933
934                 if ((ret = uvc_acquire_privileges(handle)) < 0)
935                         return ret;
936
937                 return uvc_v4l2_set_streamparm(stream, arg);
938
939         /* Cropping and scaling */
940         case VIDIOC_CROPCAP:
941         {
942                 struct v4l2_cropcap *ccap = arg;
943
944                 if (ccap->type != stream->type)
945                         return -EINVAL;
946
947                 ccap->bounds.left = 0;
948                 ccap->bounds.top = 0;
949
950                 mutex_lock(&stream->mutex);
951                 ccap->bounds.width = stream->cur_frame->wWidth;
952                 ccap->bounds.height = stream->cur_frame->wHeight;
953                 mutex_unlock(&stream->mutex);
954
955                 ccap->defrect = ccap->bounds;
956
957                 ccap->pixelaspect.numerator = 1;
958                 ccap->pixelaspect.denominator = 1;
959                 break;
960         }
961
962         case VIDIOC_G_CROP:
963         case VIDIOC_S_CROP:
964                 return -ENOTTY;
965
966         /* Buffers & streaming */
967         case VIDIOC_REQBUFS:
968                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
969                 if (ret < 0)
970                         return ret;
971
972                 if ((ret = uvc_acquire_privileges(handle)) < 0)
973                         return ret;
974
975                 mutex_lock(&stream->mutex);
976                 ret = uvc_alloc_buffers(&stream->queue, arg);
977                 mutex_unlock(&stream->mutex);
978                 if (ret < 0)
979                         return ret;
980
981                 if (ret == 0)
982                         uvc_dismiss_privileges(handle);
983
984                 ret = 0;
985                 break;
986
987         case VIDIOC_QUERYBUF:
988         {
989                 struct v4l2_buffer *buf = arg;
990
991                 if (!uvc_has_privileges(handle))
992                         return -EBUSY;
993
994                 return uvc_query_buffer(&stream->queue, buf);
995         }
996
997         case VIDIOC_QBUF:
998                 if (!uvc_has_privileges(handle))
999                         return -EBUSY;
1000
1001                 return uvc_queue_buffer(&stream->queue, arg);
1002
1003         case VIDIOC_DQBUF:
1004                 if (!uvc_has_privileges(handle))
1005                         return -EBUSY;
1006
1007                 return uvc_dequeue_buffer(&stream->queue, arg,
1008                         file->f_flags & O_NONBLOCK);
1009
1010         case VIDIOC_STREAMON:
1011         {
1012                 int *type = arg;
1013
1014                 if (*type != stream->type)
1015                         return -EINVAL;
1016
1017                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
1018                 if (ret < 0)
1019                         return ret;
1020
1021                 if (!uvc_has_privileges(handle))
1022                         return -EBUSY;
1023
1024                 mutex_lock(&stream->mutex);
1025                 ret = uvc_video_enable(stream, 1);
1026                 mutex_unlock(&stream->mutex);
1027                 if (ret < 0)
1028                         return ret;
1029                 break;
1030         }
1031
1032         case VIDIOC_STREAMOFF:
1033         {
1034                 int *type = arg;
1035
1036                 if (*type != stream->type)
1037                         return -EINVAL;
1038
1039                 ret = v4l2_prio_check(vdev->prio, handle->vfh.prio);
1040                 if (ret < 0)
1041                         return ret;
1042
1043                 if (!uvc_has_privileges(handle))
1044                         return -EBUSY;
1045
1046                 return uvc_video_enable(stream, 0);
1047         }
1048
1049         case VIDIOC_SUBSCRIBE_EVENT:
1050         {
1051                 struct v4l2_event_subscription *sub = arg;
1052
1053                 switch (sub->type) {
1054                 case V4L2_EVENT_CTRL:
1055                         return v4l2_event_subscribe(&handle->vfh, sub, 0,
1056                                                     &uvc_ctrl_sub_ev_ops);
1057                 default:
1058                         return -EINVAL;
1059                 }
1060         }
1061
1062         case VIDIOC_UNSUBSCRIBE_EVENT:
1063                 return v4l2_event_unsubscribe(&handle->vfh, arg);
1064
1065         case VIDIOC_DQEVENT:
1066                 return v4l2_event_dequeue(&handle->vfh, arg,
1067                                           file->f_flags & O_NONBLOCK);
1068
1069         /* Analog video standards make no sense for digital cameras. */
1070         case VIDIOC_ENUMSTD:
1071         case VIDIOC_QUERYSTD:
1072         case VIDIOC_G_STD:
1073         case VIDIOC_S_STD:
1074
1075         case VIDIOC_OVERLAY:
1076
1077         case VIDIOC_ENUMAUDIO:
1078         case VIDIOC_ENUMAUDOUT:
1079
1080         case VIDIOC_ENUMOUTPUT:
1081                 uvc_trace(UVC_TRACE_IOCTL, "Unsupported ioctl 0x%08x\n", cmd);
1082                 return -ENOTTY;
1083
1084         case UVCIOC_CTRL_MAP:
1085                 return uvc_ioctl_ctrl_map(chain, arg);
1086
1087         case UVCIOC_CTRL_QUERY:
1088                 return uvc_xu_ctrl_query(chain, arg);
1089
1090         default:
1091                 uvc_trace(UVC_TRACE_IOCTL, "Unknown ioctl 0x%08x\n", cmd);
1092                 return -ENOTTY;
1093         }
1094
1095         return ret;
1096 }
1097
1098 static long uvc_v4l2_ioctl(struct file *file,
1099                      unsigned int cmd, unsigned long arg)
1100 {
1101         if (uvc_trace_param & UVC_TRACE_IOCTL) {
1102                 uvc_printk(KERN_DEBUG, "uvc_v4l2_ioctl(");
1103                 v4l_printk_ioctl(NULL, cmd);
1104                 printk(")\n");
1105         }
1106
1107         return video_usercopy(file, cmd, arg, uvc_v4l2_do_ioctl);
1108 }
1109
1110 #ifdef CONFIG_COMPAT
1111 struct uvc_xu_control_mapping32 {
1112         __u32 id;
1113         __u8 name[32];
1114         __u8 entity[16];
1115         __u8 selector;
1116
1117         __u8 size;
1118         __u8 offset;
1119         __u32 v4l2_type;
1120         __u32 data_type;
1121
1122         compat_caddr_t menu_info;
1123         __u32 menu_count;
1124
1125         __u32 reserved[4];
1126 };
1127
1128 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1129                         const struct uvc_xu_control_mapping32 __user *up)
1130 {
1131         struct uvc_menu_info __user *umenus;
1132         struct uvc_menu_info __user *kmenus;
1133         compat_caddr_t p;
1134
1135         if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1136             __copy_from_user(kp, up, offsetof(typeof(*up), menu_info)) ||
1137             __get_user(kp->menu_count, &up->menu_count))
1138                 return -EFAULT;
1139
1140         memset(kp->reserved, 0, sizeof(kp->reserved));
1141
1142         if (kp->menu_count == 0) {
1143                 kp->menu_info = NULL;
1144                 return 0;
1145         }
1146
1147         if (__get_user(p, &up->menu_info))
1148                 return -EFAULT;
1149         umenus = compat_ptr(p);
1150         if (!access_ok(VERIFY_READ, umenus, kp->menu_count * sizeof(*umenus)))
1151                 return -EFAULT;
1152
1153         kmenus = compat_alloc_user_space(kp->menu_count * sizeof(*kmenus));
1154         if (kmenus == NULL)
1155                 return -EFAULT;
1156         kp->menu_info = kmenus;
1157
1158         if (copy_in_user(kmenus, umenus, kp->menu_count * sizeof(*umenus)))
1159                 return -EFAULT;
1160
1161         return 0;
1162 }
1163
1164 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1165                         struct uvc_xu_control_mapping32 __user *up)
1166 {
1167         struct uvc_menu_info __user *umenus;
1168         struct uvc_menu_info __user *kmenus = kp->menu_info;
1169         compat_caddr_t p;
1170
1171         if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1172             __copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1173             __put_user(kp->menu_count, &up->menu_count))
1174                 return -EFAULT;
1175
1176         if (__clear_user(up->reserved, sizeof(up->reserved)))
1177                 return -EFAULT;
1178
1179         if (kp->menu_count == 0)
1180                 return 0;
1181
1182         if (get_user(p, &up->menu_info))
1183                 return -EFAULT;
1184         umenus = compat_ptr(p);
1185
1186         if (copy_in_user(umenus, kmenus, kp->menu_count * sizeof(*umenus)))
1187                 return -EFAULT;
1188
1189         return 0;
1190 }
1191
1192 struct uvc_xu_control_query32 {
1193         __u8 unit;
1194         __u8 selector;
1195         __u8 query;
1196         __u16 size;
1197         compat_caddr_t data;
1198 };
1199
1200 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1201                         const struct uvc_xu_control_query32 __user *up)
1202 {
1203         u8 __user *udata;
1204         u8 __user *kdata;
1205         compat_caddr_t p;
1206
1207         if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1208             __copy_from_user(kp, up, offsetof(typeof(*up), data)))
1209                 return -EFAULT;
1210
1211         if (kp->size == 0) {
1212                 kp->data = NULL;
1213                 return 0;
1214         }
1215
1216         if (__get_user(p, &up->data))
1217                 return -EFAULT;
1218         udata = compat_ptr(p);
1219         if (!access_ok(VERIFY_READ, udata, kp->size))
1220                 return -EFAULT;
1221
1222         kdata = compat_alloc_user_space(kp->size);
1223         if (kdata == NULL)
1224                 return -EFAULT;
1225         kp->data = kdata;
1226
1227         if (copy_in_user(kdata, udata, kp->size))
1228                 return -EFAULT;
1229
1230         return 0;
1231 }
1232
1233 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1234                         struct uvc_xu_control_query32 __user *up)
1235 {
1236         u8 __user *udata;
1237         u8 __user *kdata = kp->data;
1238         compat_caddr_t p;
1239
1240         if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1241             __copy_to_user(up, kp, offsetof(typeof(*up), data)))
1242                 return -EFAULT;
1243
1244         if (kp->size == 0)
1245                 return 0;
1246
1247         if (get_user(p, &up->data))
1248                 return -EFAULT;
1249         udata = compat_ptr(p);
1250         if (!access_ok(VERIFY_READ, udata, kp->size))
1251                 return -EFAULT;
1252
1253         if (copy_in_user(udata, kdata, kp->size))
1254                 return -EFAULT;
1255
1256         return 0;
1257 }
1258
1259 #define UVCIOC_CTRL_MAP32       _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1260 #define UVCIOC_CTRL_QUERY32     _IOWR('u', 0x21, struct uvc_xu_control_query32)
1261
1262 static long uvc_v4l2_compat_ioctl32(struct file *file,
1263                      unsigned int cmd, unsigned long arg)
1264 {
1265         union {
1266                 struct uvc_xu_control_mapping xmap;
1267                 struct uvc_xu_control_query xqry;
1268         } karg;
1269         void __user *up = compat_ptr(arg);
1270         mm_segment_t old_fs;
1271         long ret;
1272
1273         switch (cmd) {
1274         case UVCIOC_CTRL_MAP32:
1275                 cmd = UVCIOC_CTRL_MAP;
1276                 ret = uvc_v4l2_get_xu_mapping(&karg.xmap, up);
1277                 break;
1278
1279         case UVCIOC_CTRL_QUERY32:
1280                 cmd = UVCIOC_CTRL_QUERY;
1281                 ret = uvc_v4l2_get_xu_query(&karg.xqry, up);
1282                 break;
1283
1284         default:
1285                 return -ENOIOCTLCMD;
1286         }
1287
1288         old_fs = get_fs();
1289         set_fs(KERNEL_DS);
1290         ret = uvc_v4l2_ioctl(file, cmd, (unsigned long)&karg);
1291         set_fs(old_fs);
1292
1293         if (ret < 0)
1294                 return ret;
1295
1296         switch (cmd) {
1297         case UVCIOC_CTRL_MAP:
1298                 ret = uvc_v4l2_put_xu_mapping(&karg.xmap, up);
1299                 break;
1300
1301         case UVCIOC_CTRL_QUERY:
1302                 ret = uvc_v4l2_put_xu_query(&karg.xqry, up);
1303                 break;
1304         }
1305
1306         return ret;
1307 }
1308 #endif
1309
1310 static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
1311                     size_t count, loff_t *ppos)
1312 {
1313         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1314         return -EINVAL;
1315 }
1316
1317 static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1318 {
1319         struct uvc_fh *handle = file->private_data;
1320         struct uvc_streaming *stream = handle->stream;
1321
1322         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1323
1324         return uvc_queue_mmap(&stream->queue, vma);
1325 }
1326
1327 static unsigned int uvc_v4l2_poll(struct file *file, poll_table *wait)
1328 {
1329         struct uvc_fh *handle = file->private_data;
1330         struct uvc_streaming *stream = handle->stream;
1331
1332         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1333
1334         return uvc_queue_poll(&stream->queue, file, wait);
1335 }
1336
1337 #ifndef CONFIG_MMU
1338 static unsigned long uvc_v4l2_get_unmapped_area(struct file *file,
1339                 unsigned long addr, unsigned long len, unsigned long pgoff,
1340                 unsigned long flags)
1341 {
1342         struct uvc_fh *handle = file->private_data;
1343         struct uvc_streaming *stream = handle->stream;
1344
1345         uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_get_unmapped_area\n");
1346
1347         return uvc_queue_get_unmapped_area(&stream->queue, pgoff);
1348 }
1349 #endif
1350
1351 const struct v4l2_file_operations uvc_fops = {
1352         .owner          = THIS_MODULE,
1353         .open           = uvc_v4l2_open,
1354         .release        = uvc_v4l2_release,
1355         .unlocked_ioctl = uvc_v4l2_ioctl,
1356 #ifdef CONFIG_COMPAT
1357         .compat_ioctl32 = uvc_v4l2_compat_ioctl32,
1358 #endif
1359         .read           = uvc_v4l2_read,
1360         .mmap           = uvc_v4l2_mmap,
1361         .poll           = uvc_v4l2_poll,
1362 #ifndef CONFIG_MMU
1363         .get_unmapped_area = uvc_v4l2_get_unmapped_area,
1364 #endif
1365 };
1366