2 * uvc_v4l2.c -- USB Video Class driver - V4L2 API
4 * Copyright (C) 2005-2010
5 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
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.
14 #include <linux/compat.h>
15 #include <linux/kernel.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/usb.h>
20 #include <linux/videodev2.h>
21 #include <linux/vmalloc.h>
23 #include <linux/wait.h>
24 #include <linux/atomic.h>
26 #include <media/v4l2-common.h>
27 #include <media/v4l2-ctrls.h>
28 #include <media/v4l2-event.h>
29 #include <media/v4l2-ioctl.h>
33 /* ------------------------------------------------------------------------
36 static int uvc_ioctl_ctrl_map(struct uvc_video_chain *chain,
37 struct uvc_xu_control_mapping *xmap)
39 struct uvc_control_mapping *map;
43 map = kzalloc(sizeof *map, GFP_KERNEL);
48 memcpy(map->name, xmap->name, sizeof map->name);
49 memcpy(map->entity, xmap->entity, sizeof map->entity);
50 map->selector = xmap->selector;
51 map->size = xmap->size;
52 map->offset = xmap->offset;
53 map->v4l2_type = xmap->v4l2_type;
54 map->data_type = xmap->data_type;
56 switch (xmap->v4l2_type) {
57 case V4L2_CTRL_TYPE_INTEGER:
58 case V4L2_CTRL_TYPE_BOOLEAN:
59 case V4L2_CTRL_TYPE_BUTTON:
62 case V4L2_CTRL_TYPE_MENU:
63 /* Prevent excessive memory consumption, as well as integer
66 if (xmap->menu_count == 0 ||
67 xmap->menu_count > UVC_MAX_CONTROL_MENU_ENTRIES) {
72 size = xmap->menu_count * sizeof(*map->menu_info);
73 map->menu_info = kmalloc(size, GFP_KERNEL);
74 if (map->menu_info == NULL) {
79 if (copy_from_user(map->menu_info, xmap->menu_info, size)) {
84 map->menu_count = xmap->menu_count;
88 uvc_trace(UVC_TRACE_CONTROL, "Unsupported V4L2 control type "
89 "%u.\n", xmap->v4l2_type);
94 ret = uvc_ctrl_add_mapping(chain, map);
97 kfree(map->menu_info);
103 /* ------------------------------------------------------------------------
108 * Find the frame interval closest to the requested frame interval for the
109 * given frame format and size. This should be done by the device as part of
110 * the Video Probe and Commit negotiation, but some hardware don't implement
113 static __u32 uvc_try_frame_interval(struct uvc_frame *frame, __u32 interval)
117 if (frame->bFrameIntervalType) {
118 __u32 best = -1, dist;
120 for (i = 0; i < frame->bFrameIntervalType; ++i) {
121 dist = interval > frame->dwFrameInterval[i]
122 ? interval - frame->dwFrameInterval[i]
123 : frame->dwFrameInterval[i] - interval;
131 interval = frame->dwFrameInterval[i-1];
133 const __u32 min = frame->dwFrameInterval[0];
134 const __u32 max = frame->dwFrameInterval[1];
135 const __u32 step = frame->dwFrameInterval[2];
137 interval = min + (interval - min + step/2) / step * step;
145 static __u32 uvc_v4l2_get_bytesperline(const struct uvc_format *format,
146 const struct uvc_frame *frame)
148 switch (format->fcc) {
149 case V4L2_PIX_FMT_NV12:
150 case V4L2_PIX_FMT_YVU420:
151 case V4L2_PIX_FMT_YUV420:
152 case V4L2_PIX_FMT_M420:
153 return frame->wWidth;
156 return format->bpp * frame->wWidth / 8;
160 static int uvc_v4l2_try_format(struct uvc_streaming *stream,
161 struct v4l2_format *fmt, struct uvc_streaming_control *probe,
162 struct uvc_format **uvc_format, struct uvc_frame **uvc_frame)
164 struct uvc_format *format = NULL;
165 struct uvc_frame *frame = NULL;
167 unsigned int d, maxd;
173 if (fmt->type != stream->type)
176 fcc = (__u8 *)&fmt->fmt.pix.pixelformat;
177 uvc_trace(UVC_TRACE_FORMAT, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
178 fmt->fmt.pix.pixelformat,
179 fcc[0], fcc[1], fcc[2], fcc[3],
180 fmt->fmt.pix.width, fmt->fmt.pix.height);
182 /* Check if the hardware supports the requested format, use the default
185 for (i = 0; i < stream->nformats; ++i) {
186 format = &stream->format[i];
187 if (format->fcc == fmt->fmt.pix.pixelformat)
191 if (i == stream->nformats) {
192 format = stream->def_format;
193 fmt->fmt.pix.pixelformat = format->fcc;
196 /* Find the closest image size. The distance between image sizes is
197 * the size in pixels of the non-overlapping regions between the
198 * requested size and the frame-specified size.
200 rw = fmt->fmt.pix.width;
201 rh = fmt->fmt.pix.height;
202 maxd = (unsigned int)-1;
204 for (i = 0; i < format->nframes; ++i) {
205 __u16 w = format->frame[i].wWidth;
206 __u16 h = format->frame[i].wHeight;
208 d = min(w, rw) * min(h, rh);
209 d = w*h + rw*rh - 2*d;
212 frame = &format->frame[i];
220 uvc_trace(UVC_TRACE_FORMAT, "Unsupported size %ux%u.\n",
221 fmt->fmt.pix.width, fmt->fmt.pix.height);
225 /* Use the default frame interval. */
226 interval = frame->dwDefaultFrameInterval;
227 uvc_trace(UVC_TRACE_FORMAT, "Using default frame interval %u.%u us "
228 "(%u.%u fps).\n", interval/10, interval%10, 10000000/interval,
229 (100000000/interval)%10);
231 /* Set the format index, frame index and frame interval. */
232 memset(probe, 0, sizeof *probe);
233 probe->bmHint = 1; /* dwFrameInterval */
234 probe->bFormatIndex = format->index;
235 probe->bFrameIndex = frame->bFrameIndex;
236 probe->dwFrameInterval = uvc_try_frame_interval(frame, interval);
237 /* Some webcams stall the probe control set request when the
238 * dwMaxVideoFrameSize field is set to zero. The UVC specification
239 * clearly states that the field is read-only from the host, so this
240 * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
241 * the webcam to work around the problem.
243 * The workaround could probably be enabled for all webcams, so the
244 * quirk can be removed if needed. It's currently useful to detect
245 * webcam bugs and fix them before they hit the market (providing
246 * developers test their webcams with the Linux driver as well as with
247 * the Windows driver).
249 mutex_lock(&stream->mutex);
250 if (stream->dev->quirks & UVC_QUIRK_PROBE_EXTRAFIELDS)
251 probe->dwMaxVideoFrameSize =
252 stream->ctrl.dwMaxVideoFrameSize;
254 /* Probe the device. */
255 ret = uvc_probe_video(stream, probe);
256 mutex_unlock(&stream->mutex);
260 /* After the probe, update fmt with the values returned from
261 * negotiation with the device. Some devices return invalid bFormatIndex
262 * and bFrameIndex values, in which case we can only assume they have
263 * accepted the requested format as-is.
265 for (i = 0; i < stream->nformats; ++i) {
266 if (probe->bFormatIndex == stream->format[i].index) {
267 format = &stream->format[i];
272 if (i == stream->nformats)
273 uvc_trace(UVC_TRACE_FORMAT,
274 "Unknown bFormatIndex %u, using default\n",
275 probe->bFormatIndex);
277 for (i = 0; i < format->nframes; ++i) {
278 if (probe->bFrameIndex == format->frame[i].bFrameIndex) {
279 frame = &format->frame[i];
284 if (i == format->nframes)
285 uvc_trace(UVC_TRACE_FORMAT,
286 "Unknown bFrameIndex %u, using default\n",
289 fmt->fmt.pix.width = frame->wWidth;
290 fmt->fmt.pix.height = frame->wHeight;
291 fmt->fmt.pix.field = V4L2_FIELD_NONE;
292 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
293 fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
294 fmt->fmt.pix.pixelformat = format->fcc;
295 fmt->fmt.pix.colorspace = format->colorspace;
296 fmt->fmt.pix.priv = 0;
298 if (uvc_format != NULL)
299 *uvc_format = format;
300 if (uvc_frame != NULL)
307 static int uvc_v4l2_get_format(struct uvc_streaming *stream,
308 struct v4l2_format *fmt)
310 struct uvc_format *format;
311 struct uvc_frame *frame;
314 if (fmt->type != stream->type)
317 mutex_lock(&stream->mutex);
318 format = stream->cur_format;
319 frame = stream->cur_frame;
321 if (format == NULL || frame == NULL) {
326 fmt->fmt.pix.pixelformat = format->fcc;
327 fmt->fmt.pix.width = frame->wWidth;
328 fmt->fmt.pix.height = frame->wHeight;
329 fmt->fmt.pix.field = V4L2_FIELD_NONE;
330 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
331 fmt->fmt.pix.sizeimage = stream->ctrl.dwMaxVideoFrameSize;
332 fmt->fmt.pix.colorspace = format->colorspace;
333 fmt->fmt.pix.priv = 0;
336 mutex_unlock(&stream->mutex);
340 static int uvc_v4l2_set_format(struct uvc_streaming *stream,
341 struct v4l2_format *fmt)
343 struct uvc_streaming_control probe;
344 struct uvc_format *format;
345 struct uvc_frame *frame;
348 if (fmt->type != stream->type)
351 ret = uvc_v4l2_try_format(stream, fmt, &probe, &format, &frame);
355 mutex_lock(&stream->mutex);
357 if (uvc_queue_allocated(&stream->queue)) {
362 stream->ctrl = probe;
363 stream->cur_format = format;
364 stream->cur_frame = frame;
367 mutex_unlock(&stream->mutex);
371 static int uvc_v4l2_get_streamparm(struct uvc_streaming *stream,
372 struct v4l2_streamparm *parm)
374 uint32_t numerator, denominator;
376 if (parm->type != stream->type)
379 mutex_lock(&stream->mutex);
380 numerator = stream->ctrl.dwFrameInterval;
381 mutex_unlock(&stream->mutex);
383 denominator = 10000000;
384 uvc_simplify_fraction(&numerator, &denominator, 8, 333);
386 memset(parm, 0, sizeof *parm);
387 parm->type = stream->type;
389 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
390 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
391 parm->parm.capture.capturemode = 0;
392 parm->parm.capture.timeperframe.numerator = numerator;
393 parm->parm.capture.timeperframe.denominator = denominator;
394 parm->parm.capture.extendedmode = 0;
395 parm->parm.capture.readbuffers = 0;
397 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
398 parm->parm.output.outputmode = 0;
399 parm->parm.output.timeperframe.numerator = numerator;
400 parm->parm.output.timeperframe.denominator = denominator;
406 static int uvc_v4l2_set_streamparm(struct uvc_streaming *stream,
407 struct v4l2_streamparm *parm)
409 struct uvc_streaming_control probe;
410 struct v4l2_fract timeperframe;
414 if (parm->type != stream->type)
417 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
418 timeperframe = parm->parm.capture.timeperframe;
420 timeperframe = parm->parm.output.timeperframe;
422 interval = uvc_fraction_to_interval(timeperframe.numerator,
423 timeperframe.denominator);
424 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
425 timeperframe.numerator, timeperframe.denominator, interval);
427 mutex_lock(&stream->mutex);
429 if (uvc_queue_streaming(&stream->queue)) {
430 mutex_unlock(&stream->mutex);
434 probe = stream->ctrl;
435 probe.dwFrameInterval =
436 uvc_try_frame_interval(stream->cur_frame, interval);
438 /* Probe the device with the new settings. */
439 ret = uvc_probe_video(stream, &probe);
441 mutex_unlock(&stream->mutex);
445 stream->ctrl = probe;
446 mutex_unlock(&stream->mutex);
448 /* Return the actual frame period. */
449 timeperframe.numerator = probe.dwFrameInterval;
450 timeperframe.denominator = 10000000;
451 uvc_simplify_fraction(&timeperframe.numerator,
452 &timeperframe.denominator, 8, 333);
454 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
455 parm->parm.capture.timeperframe = timeperframe;
456 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
458 parm->parm.output.timeperframe = timeperframe;
459 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
465 /* ------------------------------------------------------------------------
466 * Privilege management
470 * Privilege management is the multiple-open implementation basis. The current
471 * implementation is completely transparent for the end-user and doesn't
472 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
473 * Those ioctls enable finer control on the device (by making possible for a
474 * user to request exclusive access to a device), but are not mature yet.
475 * Switching to the V4L2 priority mechanism might be considered in the future
476 * if this situation changes.
478 * Each open instance of a UVC device can either be in a privileged or
479 * unprivileged state. Only a single instance can be in a privileged state at
480 * a given time. Trying to perform an operation that requires privileges will
481 * automatically acquire the required privileges if possible, or return -EBUSY
482 * otherwise. Privileges are dismissed when closing the instance or when
483 * freeing the video buffers using VIDIOC_REQBUFS.
485 * Operations that require privileges are:
492 static int uvc_acquire_privileges(struct uvc_fh *handle)
494 /* Always succeed if the handle is already privileged. */
495 if (handle->state == UVC_HANDLE_ACTIVE)
498 /* Check if the device already has a privileged handle. */
499 if (atomic_inc_return(&handle->stream->active) != 1) {
500 atomic_dec(&handle->stream->active);
504 handle->state = UVC_HANDLE_ACTIVE;
508 static void uvc_dismiss_privileges(struct uvc_fh *handle)
510 if (handle->state == UVC_HANDLE_ACTIVE)
511 atomic_dec(&handle->stream->active);
513 handle->state = UVC_HANDLE_PASSIVE;
516 static int uvc_has_privileges(struct uvc_fh *handle)
518 return handle->state == UVC_HANDLE_ACTIVE;
521 /* ------------------------------------------------------------------------
522 * V4L2 file operations
525 static int uvc_v4l2_open(struct file *file)
527 struct uvc_streaming *stream;
528 struct uvc_fh *handle;
531 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
532 stream = video_drvdata(file);
534 ret = usb_autopm_get_interface(stream->dev->intf);
538 /* Create the device handle. */
539 handle = kzalloc(sizeof *handle, GFP_KERNEL);
540 if (handle == NULL) {
541 usb_autopm_put_interface(stream->dev->intf);
545 mutex_lock(&stream->dev->lock);
546 if (stream->dev->users == 0) {
547 ret = uvc_status_start(stream->dev, GFP_KERNEL);
549 mutex_unlock(&stream->dev->lock);
550 usb_autopm_put_interface(stream->dev->intf);
556 stream->dev->users++;
557 mutex_unlock(&stream->dev->lock);
559 v4l2_fh_init(&handle->vfh, &stream->vdev);
560 v4l2_fh_add(&handle->vfh);
561 handle->chain = stream->chain;
562 handle->stream = stream;
563 handle->state = UVC_HANDLE_PASSIVE;
564 file->private_data = handle;
569 static int uvc_v4l2_release(struct file *file)
571 struct uvc_fh *handle = file->private_data;
572 struct uvc_streaming *stream = handle->stream;
574 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
576 /* Only free resources if this is a privileged handle. */
577 if (uvc_has_privileges(handle))
578 uvc_queue_release(&stream->queue);
580 /* Release the file handle. */
581 uvc_dismiss_privileges(handle);
582 v4l2_fh_del(&handle->vfh);
583 v4l2_fh_exit(&handle->vfh);
585 file->private_data = NULL;
587 mutex_lock(&stream->dev->lock);
588 if (--stream->dev->users == 0)
589 uvc_status_stop(stream->dev);
590 mutex_unlock(&stream->dev->lock);
592 usb_autopm_put_interface(stream->dev->intf);
596 static int uvc_ioctl_querycap(struct file *file, void *fh,
597 struct v4l2_capability *cap)
599 struct video_device *vdev = video_devdata(file);
600 struct uvc_fh *handle = file->private_data;
601 struct uvc_video_chain *chain = handle->chain;
602 struct uvc_streaming *stream = handle->stream;
604 strlcpy(cap->driver, "uvcvideo", sizeof(cap->driver));
605 strlcpy(cap->card, vdev->name, sizeof(cap->card));
606 usb_make_path(stream->dev->udev, cap->bus_info, sizeof(cap->bus_info));
607 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
609 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
610 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING;
612 cap->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
617 static int uvc_ioctl_enum_fmt(struct uvc_streaming *stream,
618 struct v4l2_fmtdesc *fmt)
620 struct uvc_format *format;
621 enum v4l2_buf_type type = fmt->type;
622 __u32 index = fmt->index;
624 if (fmt->type != stream->type || fmt->index >= stream->nformats)
627 memset(fmt, 0, sizeof(*fmt));
631 format = &stream->format[fmt->index];
633 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
634 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
635 strlcpy(fmt->description, format->name, sizeof(fmt->description));
636 fmt->description[sizeof(fmt->description) - 1] = 0;
637 fmt->pixelformat = format->fcc;
641 static int uvc_ioctl_enum_fmt_vid_cap(struct file *file, void *fh,
642 struct v4l2_fmtdesc *fmt)
644 struct uvc_fh *handle = fh;
645 struct uvc_streaming *stream = handle->stream;
647 return uvc_ioctl_enum_fmt(stream, fmt);
650 static int uvc_ioctl_enum_fmt_vid_out(struct file *file, void *fh,
651 struct v4l2_fmtdesc *fmt)
653 struct uvc_fh *handle = fh;
654 struct uvc_streaming *stream = handle->stream;
656 return uvc_ioctl_enum_fmt(stream, fmt);
659 static int uvc_ioctl_g_fmt_vid_cap(struct file *file, void *fh,
660 struct v4l2_format *fmt)
662 struct uvc_fh *handle = fh;
663 struct uvc_streaming *stream = handle->stream;
665 return uvc_v4l2_get_format(stream, fmt);
668 static int uvc_ioctl_g_fmt_vid_out(struct file *file, void *fh,
669 struct v4l2_format *fmt)
671 struct uvc_fh *handle = fh;
672 struct uvc_streaming *stream = handle->stream;
674 return uvc_v4l2_get_format(stream, fmt);
677 static int uvc_ioctl_s_fmt_vid_cap(struct file *file, void *fh,
678 struct v4l2_format *fmt)
680 struct uvc_fh *handle = fh;
681 struct uvc_streaming *stream = handle->stream;
684 ret = uvc_acquire_privileges(handle);
688 return uvc_v4l2_set_format(stream, fmt);
691 static int uvc_ioctl_s_fmt_vid_out(struct file *file, void *fh,
692 struct v4l2_format *fmt)
694 struct uvc_fh *handle = fh;
695 struct uvc_streaming *stream = handle->stream;
698 ret = uvc_acquire_privileges(handle);
702 return uvc_v4l2_set_format(stream, fmt);
705 static int uvc_ioctl_try_fmt_vid_cap(struct file *file, void *fh,
706 struct v4l2_format *fmt)
708 struct uvc_fh *handle = fh;
709 struct uvc_streaming *stream = handle->stream;
710 struct uvc_streaming_control probe;
712 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
715 static int uvc_ioctl_try_fmt_vid_out(struct file *file, void *fh,
716 struct v4l2_format *fmt)
718 struct uvc_fh *handle = fh;
719 struct uvc_streaming *stream = handle->stream;
720 struct uvc_streaming_control probe;
722 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
725 static int uvc_ioctl_reqbufs(struct file *file, void *fh,
726 struct v4l2_requestbuffers *rb)
728 struct uvc_fh *handle = fh;
729 struct uvc_streaming *stream = handle->stream;
732 ret = uvc_acquire_privileges(handle);
736 mutex_lock(&stream->mutex);
737 ret = uvc_request_buffers(&stream->queue, rb);
738 mutex_unlock(&stream->mutex);
743 uvc_dismiss_privileges(handle);
748 static int uvc_ioctl_querybuf(struct file *file, void *fh,
749 struct v4l2_buffer *buf)
751 struct uvc_fh *handle = fh;
752 struct uvc_streaming *stream = handle->stream;
754 if (!uvc_has_privileges(handle))
757 return uvc_query_buffer(&stream->queue, buf);
760 static int uvc_ioctl_qbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
762 struct uvc_fh *handle = fh;
763 struct uvc_streaming *stream = handle->stream;
765 if (!uvc_has_privileges(handle))
768 return uvc_queue_buffer(&stream->queue, buf);
771 static int uvc_ioctl_expbuf(struct file *file, void *fh,
772 struct v4l2_exportbuffer *exp)
774 struct uvc_fh *handle = fh;
775 struct uvc_streaming *stream = handle->stream;
777 if (!uvc_has_privileges(handle))
780 return uvc_export_buffer(&stream->queue, exp);
783 static int uvc_ioctl_dqbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
785 struct uvc_fh *handle = fh;
786 struct uvc_streaming *stream = handle->stream;
788 if (!uvc_has_privileges(handle))
791 return uvc_dequeue_buffer(&stream->queue, buf,
792 file->f_flags & O_NONBLOCK);
795 static int uvc_ioctl_create_bufs(struct file *file, void *fh,
796 struct v4l2_create_buffers *cb)
798 struct uvc_fh *handle = fh;
799 struct uvc_streaming *stream = handle->stream;
802 ret = uvc_acquire_privileges(handle);
806 return uvc_create_buffers(&stream->queue, cb);
809 static int uvc_ioctl_streamon(struct file *file, void *fh,
810 enum v4l2_buf_type type)
812 struct uvc_fh *handle = fh;
813 struct uvc_streaming *stream = handle->stream;
816 if (!uvc_has_privileges(handle))
819 mutex_lock(&stream->mutex);
820 ret = uvc_queue_streamon(&stream->queue, type);
821 mutex_unlock(&stream->mutex);
826 static int uvc_ioctl_streamoff(struct file *file, void *fh,
827 enum v4l2_buf_type type)
829 struct uvc_fh *handle = fh;
830 struct uvc_streaming *stream = handle->stream;
832 if (!uvc_has_privileges(handle))
835 mutex_lock(&stream->mutex);
836 uvc_queue_streamoff(&stream->queue, type);
837 mutex_unlock(&stream->mutex);
842 static int uvc_ioctl_enum_input(struct file *file, void *fh,
843 struct v4l2_input *input)
845 struct uvc_fh *handle = fh;
846 struct uvc_video_chain *chain = handle->chain;
847 const struct uvc_entity *selector = chain->selector;
848 struct uvc_entity *iterm = NULL;
849 u32 index = input->index;
852 if (selector == NULL ||
853 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
856 list_for_each_entry(iterm, &chain->entities, chain) {
857 if (UVC_ENTITY_IS_ITERM(iterm))
861 } else if (index < selector->bNrInPins) {
862 pin = selector->baSourceID[index];
863 list_for_each_entry(iterm, &chain->entities, chain) {
864 if (!UVC_ENTITY_IS_ITERM(iterm))
866 if (iterm->id == pin)
871 if (iterm == NULL || iterm->id != pin)
874 memset(input, 0, sizeof(*input));
875 input->index = index;
876 strlcpy(input->name, iterm->name, sizeof(input->name));
877 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
878 input->type = V4L2_INPUT_TYPE_CAMERA;
883 static int uvc_ioctl_g_input(struct file *file, void *fh, unsigned int *input)
885 struct uvc_fh *handle = fh;
886 struct uvc_video_chain *chain = handle->chain;
890 if (chain->selector == NULL ||
891 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
896 buf = kmalloc(1, GFP_KERNEL);
900 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, chain->selector->id,
901 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
911 static int uvc_ioctl_s_input(struct file *file, void *fh, unsigned int input)
913 struct uvc_fh *handle = fh;
914 struct uvc_video_chain *chain = handle->chain;
918 ret = uvc_acquire_privileges(handle);
922 if (chain->selector == NULL ||
923 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
929 if (input >= chain->selector->bNrInPins)
932 buf = kmalloc(1, GFP_KERNEL);
937 ret = uvc_query_ctrl(chain->dev, UVC_SET_CUR, chain->selector->id,
938 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
945 static int uvc_ioctl_queryctrl(struct file *file, void *fh,
946 struct v4l2_queryctrl *qc)
948 struct uvc_fh *handle = fh;
949 struct uvc_video_chain *chain = handle->chain;
951 return uvc_query_v4l2_ctrl(chain, qc);
954 static int uvc_ioctl_query_ext_ctrl(struct file *file, void *fh,
955 struct v4l2_query_ext_ctrl *qec)
957 struct uvc_fh *handle = fh;
958 struct uvc_video_chain *chain = handle->chain;
959 struct v4l2_queryctrl qc = { qec->id };
962 ret = uvc_query_v4l2_ctrl(chain, &qc);
968 strlcpy(qec->name, qc.name, sizeof(qec->name));
969 qec->minimum = qc.minimum;
970 qec->maximum = qc.maximum;
972 qec->default_value = qc.default_value;
973 qec->flags = qc.flags;
977 memset(qec->dims, 0, sizeof(qec->dims));
978 memset(qec->reserved, 0, sizeof(qec->reserved));
983 static int uvc_ioctl_g_ctrl(struct file *file, void *fh,
984 struct v4l2_control *ctrl)
986 struct uvc_fh *handle = fh;
987 struct uvc_video_chain *chain = handle->chain;
988 struct v4l2_ext_control xctrl;
991 memset(&xctrl, 0, sizeof(xctrl));
994 ret = uvc_ctrl_begin(chain);
998 ret = uvc_ctrl_get(chain, &xctrl);
999 uvc_ctrl_rollback(handle);
1003 ctrl->value = xctrl.value;
1007 static int uvc_ioctl_s_ctrl(struct file *file, void *fh,
1008 struct v4l2_control *ctrl)
1010 struct uvc_fh *handle = fh;
1011 struct uvc_video_chain *chain = handle->chain;
1012 struct v4l2_ext_control xctrl;
1015 memset(&xctrl, 0, sizeof(xctrl));
1016 xctrl.id = ctrl->id;
1017 xctrl.value = ctrl->value;
1019 ret = uvc_ctrl_begin(chain);
1023 ret = uvc_ctrl_set(chain, &xctrl);
1025 uvc_ctrl_rollback(handle);
1029 ret = uvc_ctrl_commit(handle, &xctrl, 1);
1033 ctrl->value = xctrl.value;
1037 static int uvc_ioctl_g_ext_ctrls(struct file *file, void *fh,
1038 struct v4l2_ext_controls *ctrls)
1040 struct uvc_fh *handle = fh;
1041 struct uvc_video_chain *chain = handle->chain;
1042 struct v4l2_ext_control *ctrl = ctrls->controls;
1046 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL) {
1047 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1048 struct v4l2_queryctrl qc = { .id = ctrl->id };
1050 ret = uvc_query_v4l2_ctrl(chain, &qc);
1052 ctrls->error_idx = i;
1056 ctrl->value = qc.default_value;
1062 ret = uvc_ctrl_begin(chain);
1066 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1067 ret = uvc_ctrl_get(chain, ctrl);
1069 uvc_ctrl_rollback(handle);
1070 ctrls->error_idx = i;
1075 ctrls->error_idx = 0;
1077 return uvc_ctrl_rollback(handle);
1080 static int uvc_ioctl_s_try_ext_ctrls(struct uvc_fh *handle,
1081 struct v4l2_ext_controls *ctrls,
1084 struct v4l2_ext_control *ctrl = ctrls->controls;
1085 struct uvc_video_chain *chain = handle->chain;
1089 /* Default value cannot be changed */
1090 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL)
1093 ret = uvc_ctrl_begin(chain);
1097 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1098 ret = uvc_ctrl_set(chain, ctrl);
1100 uvc_ctrl_rollback(handle);
1101 ctrls->error_idx = commit ? ctrls->count : i;
1106 ctrls->error_idx = 0;
1109 return uvc_ctrl_commit(handle, ctrls->controls, ctrls->count);
1111 return uvc_ctrl_rollback(handle);
1114 static int uvc_ioctl_s_ext_ctrls(struct file *file, void *fh,
1115 struct v4l2_ext_controls *ctrls)
1117 struct uvc_fh *handle = fh;
1119 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, true);
1122 static int uvc_ioctl_try_ext_ctrls(struct file *file, void *fh,
1123 struct v4l2_ext_controls *ctrls)
1125 struct uvc_fh *handle = fh;
1127 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, false);
1130 static int uvc_ioctl_querymenu(struct file *file, void *fh,
1131 struct v4l2_querymenu *qm)
1133 struct uvc_fh *handle = fh;
1134 struct uvc_video_chain *chain = handle->chain;
1136 return uvc_query_v4l2_menu(chain, qm);
1139 static int uvc_ioctl_g_selection(struct file *file, void *fh,
1140 struct v4l2_selection *sel)
1142 struct uvc_fh *handle = fh;
1143 struct uvc_streaming *stream = handle->stream;
1145 if (sel->type != stream->type)
1148 switch (sel->target) {
1149 case V4L2_SEL_TGT_CROP_DEFAULT:
1150 case V4L2_SEL_TGT_CROP_BOUNDS:
1151 if (stream->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1154 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
1155 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
1156 if (stream->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
1165 mutex_lock(&stream->mutex);
1166 sel->r.width = stream->cur_frame->wWidth;
1167 sel->r.height = stream->cur_frame->wHeight;
1168 mutex_unlock(&stream->mutex);
1173 static int uvc_ioctl_g_parm(struct file *file, void *fh,
1174 struct v4l2_streamparm *parm)
1176 struct uvc_fh *handle = fh;
1177 struct uvc_streaming *stream = handle->stream;
1179 return uvc_v4l2_get_streamparm(stream, parm);
1182 static int uvc_ioctl_s_parm(struct file *file, void *fh,
1183 struct v4l2_streamparm *parm)
1185 struct uvc_fh *handle = fh;
1186 struct uvc_streaming *stream = handle->stream;
1189 ret = uvc_acquire_privileges(handle);
1193 return uvc_v4l2_set_streamparm(stream, parm);
1196 static int uvc_ioctl_enum_framesizes(struct file *file, void *fh,
1197 struct v4l2_frmsizeenum *fsize)
1199 struct uvc_fh *handle = fh;
1200 struct uvc_streaming *stream = handle->stream;
1201 struct uvc_format *format = NULL;
1202 struct uvc_frame *frame;
1205 /* Look for the given pixel format */
1206 for (i = 0; i < stream->nformats; i++) {
1207 if (stream->format[i].fcc == fsize->pixel_format) {
1208 format = &stream->format[i];
1215 if (fsize->index >= format->nframes)
1218 frame = &format->frame[fsize->index];
1219 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1220 fsize->discrete.width = frame->wWidth;
1221 fsize->discrete.height = frame->wHeight;
1225 static int uvc_ioctl_enum_frameintervals(struct file *file, void *fh,
1226 struct v4l2_frmivalenum *fival)
1228 struct uvc_fh *handle = fh;
1229 struct uvc_streaming *stream = handle->stream;
1230 struct uvc_format *format = NULL;
1231 struct uvc_frame *frame = NULL;
1234 /* Look for the given pixel format and frame size */
1235 for (i = 0; i < stream->nformats; i++) {
1236 if (stream->format[i].fcc == fival->pixel_format) {
1237 format = &stream->format[i];
1244 for (i = 0; i < format->nframes; i++) {
1245 if (format->frame[i].wWidth == fival->width &&
1246 format->frame[i].wHeight == fival->height) {
1247 frame = &format->frame[i];
1254 if (frame->bFrameIntervalType) {
1255 if (fival->index >= frame->bFrameIntervalType)
1258 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
1259 fival->discrete.numerator =
1260 frame->dwFrameInterval[fival->index];
1261 fival->discrete.denominator = 10000000;
1262 uvc_simplify_fraction(&fival->discrete.numerator,
1263 &fival->discrete.denominator, 8, 333);
1268 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
1269 fival->stepwise.min.numerator = frame->dwFrameInterval[0];
1270 fival->stepwise.min.denominator = 10000000;
1271 fival->stepwise.max.numerator = frame->dwFrameInterval[1];
1272 fival->stepwise.max.denominator = 10000000;
1273 fival->stepwise.step.numerator = frame->dwFrameInterval[2];
1274 fival->stepwise.step.denominator = 10000000;
1275 uvc_simplify_fraction(&fival->stepwise.min.numerator,
1276 &fival->stepwise.min.denominator, 8, 333);
1277 uvc_simplify_fraction(&fival->stepwise.max.numerator,
1278 &fival->stepwise.max.denominator, 8, 333);
1279 uvc_simplify_fraction(&fival->stepwise.step.numerator,
1280 &fival->stepwise.step.denominator, 8, 333);
1286 static int uvc_ioctl_subscribe_event(struct v4l2_fh *fh,
1287 const struct v4l2_event_subscription *sub)
1289 switch (sub->type) {
1290 case V4L2_EVENT_CTRL:
1291 return v4l2_event_subscribe(fh, sub, 0, &uvc_ctrl_sub_ev_ops);
1297 static long uvc_ioctl_default(struct file *file, void *fh, bool valid_prio,
1298 unsigned int cmd, void *arg)
1300 struct uvc_fh *handle = fh;
1301 struct uvc_video_chain *chain = handle->chain;
1304 /* Dynamic controls. */
1305 case UVCIOC_CTRL_MAP:
1306 return uvc_ioctl_ctrl_map(chain, arg);
1308 case UVCIOC_CTRL_QUERY:
1309 return uvc_xu_ctrl_query(chain, arg);
1316 #ifdef CONFIG_COMPAT
1317 struct uvc_xu_control_mapping32 {
1328 compat_caddr_t menu_info;
1334 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1335 const struct uvc_xu_control_mapping32 __user *up)
1339 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1340 __copy_from_user(kp, up, offsetof(typeof(*up), menu_info)) ||
1341 __get_user(kp->menu_count, &up->menu_count))
1344 memset(kp->reserved, 0, sizeof(kp->reserved));
1346 if (kp->menu_count == 0) {
1347 kp->menu_info = NULL;
1351 if (__get_user(p, &up->menu_info))
1353 kp->menu_info = compat_ptr(p);
1358 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1359 struct uvc_xu_control_mapping32 __user *up)
1361 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1362 __copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1363 __put_user(kp->menu_count, &up->menu_count))
1366 if (__clear_user(up->reserved, sizeof(up->reserved)))
1372 struct uvc_xu_control_query32 {
1377 compat_caddr_t data;
1380 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1381 const struct uvc_xu_control_query32 __user *up)
1385 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1386 __copy_from_user(kp, up, offsetof(typeof(*up), data)))
1389 if (kp->size == 0) {
1394 if (__get_user(p, &up->data))
1396 kp->data = compat_ptr(p);
1401 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1402 struct uvc_xu_control_query32 __user *up)
1404 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1405 __copy_to_user(up, kp, offsetof(typeof(*up), data)))
1411 #define UVCIOC_CTRL_MAP32 _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1412 #define UVCIOC_CTRL_QUERY32 _IOWR('u', 0x21, struct uvc_xu_control_query32)
1414 static long uvc_v4l2_compat_ioctl32(struct file *file,
1415 unsigned int cmd, unsigned long arg)
1417 struct uvc_fh *handle = file->private_data;
1419 struct uvc_xu_control_mapping xmap;
1420 struct uvc_xu_control_query xqry;
1422 void __user *up = compat_ptr(arg);
1426 case UVCIOC_CTRL_MAP32:
1427 ret = uvc_v4l2_get_xu_mapping(&karg.xmap, up);
1430 ret = uvc_ioctl_ctrl_map(handle->chain, &karg.xmap);
1433 ret = uvc_v4l2_put_xu_mapping(&karg.xmap, up);
1439 case UVCIOC_CTRL_QUERY32:
1440 ret = uvc_v4l2_get_xu_query(&karg.xqry, up);
1443 ret = uvc_xu_ctrl_query(handle->chain, &karg.xqry);
1446 ret = uvc_v4l2_put_xu_query(&karg.xqry, up);
1452 return -ENOIOCTLCMD;
1459 static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
1460 size_t count, loff_t *ppos)
1462 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1466 static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1468 struct uvc_fh *handle = file->private_data;
1469 struct uvc_streaming *stream = handle->stream;
1471 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1473 return uvc_queue_mmap(&stream->queue, vma);
1476 static unsigned int uvc_v4l2_poll(struct file *file, poll_table *wait)
1478 struct uvc_fh *handle = file->private_data;
1479 struct uvc_streaming *stream = handle->stream;
1481 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1483 return uvc_queue_poll(&stream->queue, file, wait);
1487 static unsigned long uvc_v4l2_get_unmapped_area(struct file *file,
1488 unsigned long addr, unsigned long len, unsigned long pgoff,
1489 unsigned long flags)
1491 struct uvc_fh *handle = file->private_data;
1492 struct uvc_streaming *stream = handle->stream;
1494 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_get_unmapped_area\n");
1496 return uvc_queue_get_unmapped_area(&stream->queue, pgoff);
1500 const struct v4l2_ioctl_ops uvc_ioctl_ops = {
1501 .vidioc_querycap = uvc_ioctl_querycap,
1502 .vidioc_enum_fmt_vid_cap = uvc_ioctl_enum_fmt_vid_cap,
1503 .vidioc_enum_fmt_vid_out = uvc_ioctl_enum_fmt_vid_out,
1504 .vidioc_g_fmt_vid_cap = uvc_ioctl_g_fmt_vid_cap,
1505 .vidioc_g_fmt_vid_out = uvc_ioctl_g_fmt_vid_out,
1506 .vidioc_s_fmt_vid_cap = uvc_ioctl_s_fmt_vid_cap,
1507 .vidioc_s_fmt_vid_out = uvc_ioctl_s_fmt_vid_out,
1508 .vidioc_try_fmt_vid_cap = uvc_ioctl_try_fmt_vid_cap,
1509 .vidioc_try_fmt_vid_out = uvc_ioctl_try_fmt_vid_out,
1510 .vidioc_reqbufs = uvc_ioctl_reqbufs,
1511 .vidioc_querybuf = uvc_ioctl_querybuf,
1512 .vidioc_qbuf = uvc_ioctl_qbuf,
1513 .vidioc_expbuf = uvc_ioctl_expbuf,
1514 .vidioc_dqbuf = uvc_ioctl_dqbuf,
1515 .vidioc_create_bufs = uvc_ioctl_create_bufs,
1516 .vidioc_streamon = uvc_ioctl_streamon,
1517 .vidioc_streamoff = uvc_ioctl_streamoff,
1518 .vidioc_enum_input = uvc_ioctl_enum_input,
1519 .vidioc_g_input = uvc_ioctl_g_input,
1520 .vidioc_s_input = uvc_ioctl_s_input,
1521 .vidioc_queryctrl = uvc_ioctl_queryctrl,
1522 .vidioc_query_ext_ctrl = uvc_ioctl_query_ext_ctrl,
1523 .vidioc_g_ctrl = uvc_ioctl_g_ctrl,
1524 .vidioc_s_ctrl = uvc_ioctl_s_ctrl,
1525 .vidioc_g_ext_ctrls = uvc_ioctl_g_ext_ctrls,
1526 .vidioc_s_ext_ctrls = uvc_ioctl_s_ext_ctrls,
1527 .vidioc_try_ext_ctrls = uvc_ioctl_try_ext_ctrls,
1528 .vidioc_querymenu = uvc_ioctl_querymenu,
1529 .vidioc_g_selection = uvc_ioctl_g_selection,
1530 .vidioc_g_parm = uvc_ioctl_g_parm,
1531 .vidioc_s_parm = uvc_ioctl_s_parm,
1532 .vidioc_enum_framesizes = uvc_ioctl_enum_framesizes,
1533 .vidioc_enum_frameintervals = uvc_ioctl_enum_frameintervals,
1534 .vidioc_subscribe_event = uvc_ioctl_subscribe_event,
1535 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1536 .vidioc_default = uvc_ioctl_default,
1539 const struct v4l2_file_operations uvc_fops = {
1540 .owner = THIS_MODULE,
1541 .open = uvc_v4l2_open,
1542 .release = uvc_v4l2_release,
1543 .unlocked_ioctl = video_ioctl2,
1544 #ifdef CONFIG_COMPAT
1545 .compat_ioctl32 = uvc_v4l2_compat_ioctl32,
1547 .read = uvc_v4l2_read,
1548 .mmap = uvc_v4l2_mmap,
1549 .poll = uvc_v4l2_poll,
1551 .get_unmapped_area = uvc_v4l2_get_unmapped_area,