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 int uvc_v4l2_try_format(struct uvc_streaming *stream,
146 struct v4l2_format *fmt, struct uvc_streaming_control *probe,
147 struct uvc_format **uvc_format, struct uvc_frame **uvc_frame)
149 struct uvc_format *format = NULL;
150 struct uvc_frame *frame = NULL;
152 unsigned int d, maxd;
158 if (fmt->type != stream->type)
161 fcc = (__u8 *)&fmt->fmt.pix.pixelformat;
162 uvc_trace(UVC_TRACE_FORMAT, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
163 fmt->fmt.pix.pixelformat,
164 fcc[0], fcc[1], fcc[2], fcc[3],
165 fmt->fmt.pix.width, fmt->fmt.pix.height);
167 /* Check if the hardware supports the requested format, use the default
170 for (i = 0; i < stream->nformats; ++i) {
171 format = &stream->format[i];
172 if (format->fcc == fmt->fmt.pix.pixelformat)
176 if (i == stream->nformats) {
177 format = stream->def_format;
178 fmt->fmt.pix.pixelformat = format->fcc;
181 /* Find the closest image size. The distance between image sizes is
182 * the size in pixels of the non-overlapping regions between the
183 * requested size and the frame-specified size.
185 rw = fmt->fmt.pix.width;
186 rh = fmt->fmt.pix.height;
187 maxd = (unsigned int)-1;
189 for (i = 0; i < format->nframes; ++i) {
190 __u16 w = format->frame[i].wWidth;
191 __u16 h = format->frame[i].wHeight;
193 d = min(w, rw) * min(h, rh);
194 d = w*h + rw*rh - 2*d;
197 frame = &format->frame[i];
205 uvc_trace(UVC_TRACE_FORMAT, "Unsupported size %ux%u.\n",
206 fmt->fmt.pix.width, fmt->fmt.pix.height);
210 /* Use the default frame interval. */
211 interval = frame->dwDefaultFrameInterval;
212 uvc_trace(UVC_TRACE_FORMAT, "Using default frame interval %u.%u us "
213 "(%u.%u fps).\n", interval/10, interval%10, 10000000/interval,
214 (100000000/interval)%10);
216 /* Set the format index, frame index and frame interval. */
217 memset(probe, 0, sizeof *probe);
218 probe->bmHint = 1; /* dwFrameInterval */
219 probe->bFormatIndex = format->index;
220 probe->bFrameIndex = frame->bFrameIndex;
221 probe->dwFrameInterval = uvc_try_frame_interval(frame, interval);
222 /* Some webcams stall the probe control set request when the
223 * dwMaxVideoFrameSize field is set to zero. The UVC specification
224 * clearly states that the field is read-only from the host, so this
225 * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
226 * the webcam to work around the problem.
228 * The workaround could probably be enabled for all webcams, so the
229 * quirk can be removed if needed. It's currently useful to detect
230 * webcam bugs and fix them before they hit the market (providing
231 * developers test their webcams with the Linux driver as well as with
232 * the Windows driver).
234 mutex_lock(&stream->mutex);
235 if (stream->dev->quirks & UVC_QUIRK_PROBE_EXTRAFIELDS)
236 probe->dwMaxVideoFrameSize =
237 stream->ctrl.dwMaxVideoFrameSize;
239 /* Probe the device. */
240 ret = uvc_probe_video(stream, probe);
241 mutex_unlock(&stream->mutex);
245 /* After the probe, update fmt with the values returned from
246 * negotiation with the device. Some devices return invalid bFormatIndex
247 * and bFrameIndex values, in which case we can only assume they have
248 * accepted the requested format as-is.
250 for (i = 0; i < stream->nformats; ++i) {
251 if (probe->bFormatIndex == stream->format[i].index) {
252 format = &stream->format[i];
257 if (i == stream->nformats)
258 uvc_trace(UVC_TRACE_FORMAT,
259 "Unknown bFormatIndex %u, using default\n",
260 probe->bFormatIndex);
262 for (i = 0; i < format->nframes; ++i) {
263 if (probe->bFrameIndex == format->frame[i].bFrameIndex) {
264 frame = &format->frame[i];
269 if (i == format->nframes)
270 uvc_trace(UVC_TRACE_FORMAT,
271 "Unknown bFrameIndex %u, using default\n",
274 fmt->fmt.pix.width = frame->wWidth;
275 fmt->fmt.pix.height = frame->wHeight;
276 fmt->fmt.pix.field = V4L2_FIELD_NONE;
277 fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
278 fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
279 fmt->fmt.pix.pixelformat = format->fcc;
280 fmt->fmt.pix.colorspace = format->colorspace;
281 fmt->fmt.pix.priv = 0;
283 if (uvc_format != NULL)
284 *uvc_format = format;
285 if (uvc_frame != NULL)
292 static int uvc_v4l2_get_format(struct uvc_streaming *stream,
293 struct v4l2_format *fmt)
295 struct uvc_format *format;
296 struct uvc_frame *frame;
299 if (fmt->type != stream->type)
302 mutex_lock(&stream->mutex);
303 format = stream->cur_format;
304 frame = stream->cur_frame;
306 if (format == NULL || frame == NULL) {
311 fmt->fmt.pix.pixelformat = format->fcc;
312 fmt->fmt.pix.width = frame->wWidth;
313 fmt->fmt.pix.height = frame->wHeight;
314 fmt->fmt.pix.field = V4L2_FIELD_NONE;
315 fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
316 fmt->fmt.pix.sizeimage = stream->ctrl.dwMaxVideoFrameSize;
317 fmt->fmt.pix.colorspace = format->colorspace;
318 fmt->fmt.pix.priv = 0;
321 mutex_unlock(&stream->mutex);
325 static int uvc_v4l2_set_format(struct uvc_streaming *stream,
326 struct v4l2_format *fmt)
328 struct uvc_streaming_control probe;
329 struct uvc_format *format;
330 struct uvc_frame *frame;
333 if (fmt->type != stream->type)
336 ret = uvc_v4l2_try_format(stream, fmt, &probe, &format, &frame);
340 mutex_lock(&stream->mutex);
342 if (uvc_queue_allocated(&stream->queue)) {
347 stream->ctrl = probe;
348 stream->cur_format = format;
349 stream->cur_frame = frame;
352 mutex_unlock(&stream->mutex);
356 static int uvc_v4l2_get_streamparm(struct uvc_streaming *stream,
357 struct v4l2_streamparm *parm)
359 uint32_t numerator, denominator;
361 if (parm->type != stream->type)
364 mutex_lock(&stream->mutex);
365 numerator = stream->ctrl.dwFrameInterval;
366 mutex_unlock(&stream->mutex);
368 denominator = 10000000;
369 uvc_simplify_fraction(&numerator, &denominator, 8, 333);
371 memset(parm, 0, sizeof *parm);
372 parm->type = stream->type;
374 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
375 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
376 parm->parm.capture.capturemode = 0;
377 parm->parm.capture.timeperframe.numerator = numerator;
378 parm->parm.capture.timeperframe.denominator = denominator;
379 parm->parm.capture.extendedmode = 0;
380 parm->parm.capture.readbuffers = 0;
382 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
383 parm->parm.output.outputmode = 0;
384 parm->parm.output.timeperframe.numerator = numerator;
385 parm->parm.output.timeperframe.denominator = denominator;
391 static int uvc_v4l2_set_streamparm(struct uvc_streaming *stream,
392 struct v4l2_streamparm *parm)
394 struct uvc_streaming_control probe;
395 struct v4l2_fract timeperframe;
399 if (parm->type != stream->type)
402 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
403 timeperframe = parm->parm.capture.timeperframe;
405 timeperframe = parm->parm.output.timeperframe;
407 interval = uvc_fraction_to_interval(timeperframe.numerator,
408 timeperframe.denominator);
409 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
410 timeperframe.numerator, timeperframe.denominator, interval);
412 mutex_lock(&stream->mutex);
414 if (uvc_queue_streaming(&stream->queue)) {
415 mutex_unlock(&stream->mutex);
419 probe = stream->ctrl;
420 probe.dwFrameInterval =
421 uvc_try_frame_interval(stream->cur_frame, interval);
423 /* Probe the device with the new settings. */
424 ret = uvc_probe_video(stream, &probe);
426 mutex_unlock(&stream->mutex);
430 stream->ctrl = probe;
431 mutex_unlock(&stream->mutex);
433 /* Return the actual frame period. */
434 timeperframe.numerator = probe.dwFrameInterval;
435 timeperframe.denominator = 10000000;
436 uvc_simplify_fraction(&timeperframe.numerator,
437 &timeperframe.denominator, 8, 333);
439 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
440 parm->parm.capture.timeperframe = timeperframe;
441 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
443 parm->parm.output.timeperframe = timeperframe;
444 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
450 /* ------------------------------------------------------------------------
451 * Privilege management
455 * Privilege management is the multiple-open implementation basis. The current
456 * implementation is completely transparent for the end-user and doesn't
457 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
458 * Those ioctls enable finer control on the device (by making possible for a
459 * user to request exclusive access to a device), but are not mature yet.
460 * Switching to the V4L2 priority mechanism might be considered in the future
461 * if this situation changes.
463 * Each open instance of a UVC device can either be in a privileged or
464 * unprivileged state. Only a single instance can be in a privileged state at
465 * a given time. Trying to perform an operation that requires privileges will
466 * automatically acquire the required privileges if possible, or return -EBUSY
467 * otherwise. Privileges are dismissed when closing the instance or when
468 * freeing the video buffers using VIDIOC_REQBUFS.
470 * Operations that require privileges are:
477 static int uvc_acquire_privileges(struct uvc_fh *handle)
479 /* Always succeed if the handle is already privileged. */
480 if (handle->state == UVC_HANDLE_ACTIVE)
483 /* Check if the device already has a privileged handle. */
484 if (atomic_inc_return(&handle->stream->active) != 1) {
485 atomic_dec(&handle->stream->active);
489 handle->state = UVC_HANDLE_ACTIVE;
493 static void uvc_dismiss_privileges(struct uvc_fh *handle)
495 if (handle->state == UVC_HANDLE_ACTIVE)
496 atomic_dec(&handle->stream->active);
498 handle->state = UVC_HANDLE_PASSIVE;
501 static int uvc_has_privileges(struct uvc_fh *handle)
503 return handle->state == UVC_HANDLE_ACTIVE;
506 /* ------------------------------------------------------------------------
507 * V4L2 file operations
510 static int uvc_v4l2_open(struct file *file)
512 struct uvc_streaming *stream;
513 struct uvc_fh *handle;
516 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
517 stream = video_drvdata(file);
519 ret = usb_autopm_get_interface(stream->dev->intf);
523 /* Create the device handle. */
524 handle = kzalloc(sizeof *handle, GFP_KERNEL);
525 if (handle == NULL) {
526 usb_autopm_put_interface(stream->dev->intf);
530 mutex_lock(&stream->dev->lock);
531 if (stream->dev->users == 0) {
532 ret = uvc_status_start(stream->dev, GFP_KERNEL);
534 mutex_unlock(&stream->dev->lock);
535 usb_autopm_put_interface(stream->dev->intf);
541 stream->dev->users++;
542 mutex_unlock(&stream->dev->lock);
544 v4l2_fh_init(&handle->vfh, &stream->vdev);
545 v4l2_fh_add(&handle->vfh);
546 handle->chain = stream->chain;
547 handle->stream = stream;
548 handle->state = UVC_HANDLE_PASSIVE;
549 file->private_data = handle;
554 static int uvc_v4l2_release(struct file *file)
556 struct uvc_fh *handle = file->private_data;
557 struct uvc_streaming *stream = handle->stream;
559 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
561 /* Only free resources if this is a privileged handle. */
562 if (uvc_has_privileges(handle))
563 uvc_queue_release(&stream->queue);
565 /* Release the file handle. */
566 uvc_dismiss_privileges(handle);
567 v4l2_fh_del(&handle->vfh);
568 v4l2_fh_exit(&handle->vfh);
570 file->private_data = NULL;
572 mutex_lock(&stream->dev->lock);
573 if (--stream->dev->users == 0)
574 uvc_status_stop(stream->dev);
575 mutex_unlock(&stream->dev->lock);
577 usb_autopm_put_interface(stream->dev->intf);
581 static int uvc_ioctl_querycap(struct file *file, void *fh,
582 struct v4l2_capability *cap)
584 struct video_device *vdev = video_devdata(file);
585 struct uvc_fh *handle = file->private_data;
586 struct uvc_video_chain *chain = handle->chain;
587 struct uvc_streaming *stream = handle->stream;
589 strlcpy(cap->driver, "uvcvideo", sizeof(cap->driver));
590 strlcpy(cap->card, vdev->name, sizeof(cap->card));
591 usb_make_path(stream->dev->udev, cap->bus_info, sizeof(cap->bus_info));
592 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
594 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
595 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING;
597 cap->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
602 static int uvc_ioctl_enum_fmt(struct uvc_streaming *stream,
603 struct v4l2_fmtdesc *fmt)
605 struct uvc_format *format;
606 enum v4l2_buf_type type = fmt->type;
607 __u32 index = fmt->index;
609 if (fmt->type != stream->type || fmt->index >= stream->nformats)
612 memset(fmt, 0, sizeof(*fmt));
616 format = &stream->format[fmt->index];
618 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
619 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
620 strlcpy(fmt->description, format->name, sizeof(fmt->description));
621 fmt->description[sizeof(fmt->description) - 1] = 0;
622 fmt->pixelformat = format->fcc;
626 static int uvc_ioctl_enum_fmt_vid_cap(struct file *file, void *fh,
627 struct v4l2_fmtdesc *fmt)
629 struct uvc_fh *handle = fh;
630 struct uvc_streaming *stream = handle->stream;
632 return uvc_ioctl_enum_fmt(stream, fmt);
635 static int uvc_ioctl_enum_fmt_vid_out(struct file *file, void *fh,
636 struct v4l2_fmtdesc *fmt)
638 struct uvc_fh *handle = fh;
639 struct uvc_streaming *stream = handle->stream;
641 return uvc_ioctl_enum_fmt(stream, fmt);
644 static int uvc_ioctl_g_fmt_vid_cap(struct file *file, void *fh,
645 struct v4l2_format *fmt)
647 struct uvc_fh *handle = fh;
648 struct uvc_streaming *stream = handle->stream;
650 return uvc_v4l2_get_format(stream, fmt);
653 static int uvc_ioctl_g_fmt_vid_out(struct file *file, void *fh,
654 struct v4l2_format *fmt)
656 struct uvc_fh *handle = fh;
657 struct uvc_streaming *stream = handle->stream;
659 return uvc_v4l2_get_format(stream, fmt);
662 static int uvc_ioctl_s_fmt_vid_cap(struct file *file, void *fh,
663 struct v4l2_format *fmt)
665 struct uvc_fh *handle = fh;
666 struct uvc_streaming *stream = handle->stream;
669 ret = uvc_acquire_privileges(handle);
673 return uvc_v4l2_set_format(stream, fmt);
676 static int uvc_ioctl_s_fmt_vid_out(struct file *file, void *fh,
677 struct v4l2_format *fmt)
679 struct uvc_fh *handle = fh;
680 struct uvc_streaming *stream = handle->stream;
683 ret = uvc_acquire_privileges(handle);
687 return uvc_v4l2_set_format(stream, fmt);
690 static int uvc_ioctl_try_fmt_vid_cap(struct file *file, void *fh,
691 struct v4l2_format *fmt)
693 struct uvc_fh *handle = fh;
694 struct uvc_streaming *stream = handle->stream;
695 struct uvc_streaming_control probe;
697 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
700 static int uvc_ioctl_try_fmt_vid_out(struct file *file, void *fh,
701 struct v4l2_format *fmt)
703 struct uvc_fh *handle = fh;
704 struct uvc_streaming *stream = handle->stream;
705 struct uvc_streaming_control probe;
707 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
710 static int uvc_ioctl_reqbufs(struct file *file, void *fh,
711 struct v4l2_requestbuffers *rb)
713 struct uvc_fh *handle = fh;
714 struct uvc_streaming *stream = handle->stream;
717 ret = uvc_acquire_privileges(handle);
721 mutex_lock(&stream->mutex);
722 ret = uvc_request_buffers(&stream->queue, rb);
723 mutex_unlock(&stream->mutex);
728 uvc_dismiss_privileges(handle);
733 static int uvc_ioctl_querybuf(struct file *file, void *fh,
734 struct v4l2_buffer *buf)
736 struct uvc_fh *handle = fh;
737 struct uvc_streaming *stream = handle->stream;
739 if (!uvc_has_privileges(handle))
742 return uvc_query_buffer(&stream->queue, buf);
745 static int uvc_ioctl_qbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
747 struct uvc_fh *handle = fh;
748 struct uvc_streaming *stream = handle->stream;
750 if (!uvc_has_privileges(handle))
753 return uvc_queue_buffer(&stream->queue, buf);
756 static int uvc_ioctl_expbuf(struct file *file, void *fh,
757 struct v4l2_exportbuffer *exp)
759 struct uvc_fh *handle = fh;
760 struct uvc_streaming *stream = handle->stream;
762 if (!uvc_has_privileges(handle))
765 return uvc_export_buffer(&stream->queue, exp);
768 static int uvc_ioctl_dqbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
770 struct uvc_fh *handle = fh;
771 struct uvc_streaming *stream = handle->stream;
773 if (!uvc_has_privileges(handle))
776 return uvc_dequeue_buffer(&stream->queue, buf,
777 file->f_flags & O_NONBLOCK);
780 static int uvc_ioctl_create_bufs(struct file *file, void *fh,
781 struct v4l2_create_buffers *cb)
783 struct uvc_fh *handle = fh;
784 struct uvc_streaming *stream = handle->stream;
787 ret = uvc_acquire_privileges(handle);
791 return uvc_create_buffers(&stream->queue, cb);
794 static int uvc_ioctl_streamon(struct file *file, void *fh,
795 enum v4l2_buf_type type)
797 struct uvc_fh *handle = fh;
798 struct uvc_streaming *stream = handle->stream;
801 if (!uvc_has_privileges(handle))
804 mutex_lock(&stream->mutex);
805 ret = uvc_queue_streamon(&stream->queue, type);
806 mutex_unlock(&stream->mutex);
811 static int uvc_ioctl_streamoff(struct file *file, void *fh,
812 enum v4l2_buf_type type)
814 struct uvc_fh *handle = fh;
815 struct uvc_streaming *stream = handle->stream;
817 if (!uvc_has_privileges(handle))
820 mutex_lock(&stream->mutex);
821 uvc_queue_streamoff(&stream->queue, type);
822 mutex_unlock(&stream->mutex);
827 static int uvc_ioctl_enum_input(struct file *file, void *fh,
828 struct v4l2_input *input)
830 struct uvc_fh *handle = fh;
831 struct uvc_video_chain *chain = handle->chain;
832 const struct uvc_entity *selector = chain->selector;
833 struct uvc_entity *iterm = NULL;
834 u32 index = input->index;
837 if (selector == NULL ||
838 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
841 list_for_each_entry(iterm, &chain->entities, chain) {
842 if (UVC_ENTITY_IS_ITERM(iterm))
846 } else if (index < selector->bNrInPins) {
847 pin = selector->baSourceID[index];
848 list_for_each_entry(iterm, &chain->entities, chain) {
849 if (!UVC_ENTITY_IS_ITERM(iterm))
851 if (iterm->id == pin)
856 if (iterm == NULL || iterm->id != pin)
859 memset(input, 0, sizeof(*input));
860 input->index = index;
861 strlcpy(input->name, iterm->name, sizeof(input->name));
862 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
863 input->type = V4L2_INPUT_TYPE_CAMERA;
868 static int uvc_ioctl_g_input(struct file *file, void *fh, unsigned int *input)
870 struct uvc_fh *handle = fh;
871 struct uvc_video_chain *chain = handle->chain;
875 if (chain->selector == NULL ||
876 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
881 buf = kmalloc(1, GFP_KERNEL);
885 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, chain->selector->id,
886 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
896 static int uvc_ioctl_s_input(struct file *file, void *fh, unsigned int input)
898 struct uvc_fh *handle = fh;
899 struct uvc_video_chain *chain = handle->chain;
903 ret = uvc_acquire_privileges(handle);
907 if (chain->selector == NULL ||
908 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
914 if (input >= chain->selector->bNrInPins)
917 buf = kmalloc(1, GFP_KERNEL);
922 ret = uvc_query_ctrl(chain->dev, UVC_SET_CUR, chain->selector->id,
923 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
930 static int uvc_ioctl_queryctrl(struct file *file, void *fh,
931 struct v4l2_queryctrl *qc)
933 struct uvc_fh *handle = fh;
934 struct uvc_video_chain *chain = handle->chain;
936 return uvc_query_v4l2_ctrl(chain, qc);
939 static int uvc_ioctl_query_ext_ctrl(struct file *file, void *fh,
940 struct v4l2_query_ext_ctrl *qec)
942 struct uvc_fh *handle = fh;
943 struct uvc_video_chain *chain = handle->chain;
944 struct v4l2_queryctrl qc = { qec->id };
947 ret = uvc_query_v4l2_ctrl(chain, &qc);
953 strlcpy(qec->name, qc.name, sizeof(qec->name));
954 qec->minimum = qc.minimum;
955 qec->maximum = qc.maximum;
957 qec->default_value = qc.default_value;
958 qec->flags = qc.flags;
962 memset(qec->dims, 0, sizeof(qec->dims));
963 memset(qec->reserved, 0, sizeof(qec->reserved));
968 static int uvc_ioctl_g_ctrl(struct file *file, void *fh,
969 struct v4l2_control *ctrl)
971 struct uvc_fh *handle = fh;
972 struct uvc_video_chain *chain = handle->chain;
973 struct v4l2_ext_control xctrl;
976 memset(&xctrl, 0, sizeof(xctrl));
979 ret = uvc_ctrl_begin(chain);
983 ret = uvc_ctrl_get(chain, &xctrl);
984 uvc_ctrl_rollback(handle);
988 ctrl->value = xctrl.value;
992 static int uvc_ioctl_s_ctrl(struct file *file, void *fh,
993 struct v4l2_control *ctrl)
995 struct uvc_fh *handle = fh;
996 struct uvc_video_chain *chain = handle->chain;
997 struct v4l2_ext_control xctrl;
1000 memset(&xctrl, 0, sizeof(xctrl));
1001 xctrl.id = ctrl->id;
1002 xctrl.value = ctrl->value;
1004 ret = uvc_ctrl_begin(chain);
1008 ret = uvc_ctrl_set(chain, &xctrl);
1010 uvc_ctrl_rollback(handle);
1014 ret = uvc_ctrl_commit(handle, &xctrl, 1);
1018 ctrl->value = xctrl.value;
1022 static int uvc_ioctl_g_ext_ctrls(struct file *file, void *fh,
1023 struct v4l2_ext_controls *ctrls)
1025 struct uvc_fh *handle = fh;
1026 struct uvc_video_chain *chain = handle->chain;
1027 struct v4l2_ext_control *ctrl = ctrls->controls;
1031 ret = uvc_ctrl_begin(chain);
1035 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1036 ret = uvc_ctrl_get(chain, ctrl);
1038 uvc_ctrl_rollback(handle);
1039 ctrls->error_idx = i;
1044 ctrls->error_idx = 0;
1046 return uvc_ctrl_rollback(handle);
1049 static int uvc_ioctl_s_try_ext_ctrls(struct uvc_fh *handle,
1050 struct v4l2_ext_controls *ctrls,
1053 struct v4l2_ext_control *ctrl = ctrls->controls;
1054 struct uvc_video_chain *chain = handle->chain;
1058 ret = uvc_ctrl_begin(chain);
1062 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1063 ret = uvc_ctrl_set(chain, ctrl);
1065 uvc_ctrl_rollback(handle);
1066 ctrls->error_idx = commit ? ctrls->count : i;
1071 ctrls->error_idx = 0;
1074 return uvc_ctrl_commit(handle, ctrls->controls, ctrls->count);
1076 return uvc_ctrl_rollback(handle);
1079 static int uvc_ioctl_s_ext_ctrls(struct file *file, void *fh,
1080 struct v4l2_ext_controls *ctrls)
1082 struct uvc_fh *handle = fh;
1084 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, true);
1087 static int uvc_ioctl_try_ext_ctrls(struct file *file, void *fh,
1088 struct v4l2_ext_controls *ctrls)
1090 struct uvc_fh *handle = fh;
1092 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, false);
1095 static int uvc_ioctl_querymenu(struct file *file, void *fh,
1096 struct v4l2_querymenu *qm)
1098 struct uvc_fh *handle = fh;
1099 struct uvc_video_chain *chain = handle->chain;
1101 return uvc_query_v4l2_menu(chain, qm);
1104 static int uvc_ioctl_g_selection(struct file *file, void *fh,
1105 struct v4l2_selection *sel)
1107 struct uvc_fh *handle = fh;
1108 struct uvc_streaming *stream = handle->stream;
1110 if (sel->type != stream->type)
1113 switch (sel->target) {
1114 case V4L2_SEL_TGT_CROP_DEFAULT:
1115 case V4L2_SEL_TGT_CROP_BOUNDS:
1116 if (stream->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1119 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
1120 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
1121 if (stream->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
1130 mutex_lock(&stream->mutex);
1131 sel->r.width = stream->cur_frame->wWidth;
1132 sel->r.height = stream->cur_frame->wHeight;
1133 mutex_unlock(&stream->mutex);
1138 static int uvc_ioctl_g_parm(struct file *file, void *fh,
1139 struct v4l2_streamparm *parm)
1141 struct uvc_fh *handle = fh;
1142 struct uvc_streaming *stream = handle->stream;
1144 return uvc_v4l2_get_streamparm(stream, parm);
1147 static int uvc_ioctl_s_parm(struct file *file, void *fh,
1148 struct v4l2_streamparm *parm)
1150 struct uvc_fh *handle = fh;
1151 struct uvc_streaming *stream = handle->stream;
1154 ret = uvc_acquire_privileges(handle);
1158 return uvc_v4l2_set_streamparm(stream, parm);
1161 static int uvc_ioctl_enum_framesizes(struct file *file, void *fh,
1162 struct v4l2_frmsizeenum *fsize)
1164 struct uvc_fh *handle = fh;
1165 struct uvc_streaming *stream = handle->stream;
1166 struct uvc_format *format = NULL;
1167 struct uvc_frame *frame;
1170 /* Look for the given pixel format */
1171 for (i = 0; i < stream->nformats; i++) {
1172 if (stream->format[i].fcc == fsize->pixel_format) {
1173 format = &stream->format[i];
1180 if (fsize->index >= format->nframes)
1183 frame = &format->frame[fsize->index];
1184 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1185 fsize->discrete.width = frame->wWidth;
1186 fsize->discrete.height = frame->wHeight;
1190 static int uvc_ioctl_enum_frameintervals(struct file *file, void *fh,
1191 struct v4l2_frmivalenum *fival)
1193 struct uvc_fh *handle = fh;
1194 struct uvc_streaming *stream = handle->stream;
1195 struct uvc_format *format = NULL;
1196 struct uvc_frame *frame = NULL;
1199 /* Look for the given pixel format and frame size */
1200 for (i = 0; i < stream->nformats; i++) {
1201 if (stream->format[i].fcc == fival->pixel_format) {
1202 format = &stream->format[i];
1209 for (i = 0; i < format->nframes; i++) {
1210 if (format->frame[i].wWidth == fival->width &&
1211 format->frame[i].wHeight == fival->height) {
1212 frame = &format->frame[i];
1219 if (frame->bFrameIntervalType) {
1220 if (fival->index >= frame->bFrameIntervalType)
1223 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
1224 fival->discrete.numerator =
1225 frame->dwFrameInterval[fival->index];
1226 fival->discrete.denominator = 10000000;
1227 uvc_simplify_fraction(&fival->discrete.numerator,
1228 &fival->discrete.denominator, 8, 333);
1233 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
1234 fival->stepwise.min.numerator = frame->dwFrameInterval[0];
1235 fival->stepwise.min.denominator = 10000000;
1236 fival->stepwise.max.numerator = frame->dwFrameInterval[1];
1237 fival->stepwise.max.denominator = 10000000;
1238 fival->stepwise.step.numerator = frame->dwFrameInterval[2];
1239 fival->stepwise.step.denominator = 10000000;
1240 uvc_simplify_fraction(&fival->stepwise.min.numerator,
1241 &fival->stepwise.min.denominator, 8, 333);
1242 uvc_simplify_fraction(&fival->stepwise.max.numerator,
1243 &fival->stepwise.max.denominator, 8, 333);
1244 uvc_simplify_fraction(&fival->stepwise.step.numerator,
1245 &fival->stepwise.step.denominator, 8, 333);
1251 static int uvc_ioctl_subscribe_event(struct v4l2_fh *fh,
1252 const struct v4l2_event_subscription *sub)
1254 switch (sub->type) {
1255 case V4L2_EVENT_CTRL:
1256 return v4l2_event_subscribe(fh, sub, 0, &uvc_ctrl_sub_ev_ops);
1262 static long uvc_ioctl_default(struct file *file, void *fh, bool valid_prio,
1263 unsigned int cmd, void *arg)
1265 struct uvc_fh *handle = fh;
1266 struct uvc_video_chain *chain = handle->chain;
1269 /* Dynamic controls. */
1270 case UVCIOC_CTRL_MAP:
1271 return uvc_ioctl_ctrl_map(chain, arg);
1273 case UVCIOC_CTRL_QUERY:
1274 return uvc_xu_ctrl_query(chain, arg);
1281 #ifdef CONFIG_COMPAT
1282 struct uvc_xu_control_mapping32 {
1293 compat_caddr_t menu_info;
1299 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1300 const struct uvc_xu_control_mapping32 __user *up)
1302 struct uvc_menu_info __user *umenus;
1303 struct uvc_menu_info __user *kmenus;
1306 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1307 __copy_from_user(kp, up, offsetof(typeof(*up), menu_info)) ||
1308 __get_user(kp->menu_count, &up->menu_count))
1311 memset(kp->reserved, 0, sizeof(kp->reserved));
1313 if (kp->menu_count == 0) {
1314 kp->menu_info = NULL;
1318 if (__get_user(p, &up->menu_info))
1320 umenus = compat_ptr(p);
1321 if (!access_ok(VERIFY_READ, umenus, kp->menu_count * sizeof(*umenus)))
1324 kmenus = compat_alloc_user_space(kp->menu_count * sizeof(*kmenus));
1327 kp->menu_info = kmenus;
1329 if (copy_in_user(kmenus, umenus, kp->menu_count * sizeof(*umenus)))
1335 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1336 struct uvc_xu_control_mapping32 __user *up)
1338 struct uvc_menu_info __user *umenus;
1339 struct uvc_menu_info __user *kmenus = kp->menu_info;
1342 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1343 __copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1344 __put_user(kp->menu_count, &up->menu_count))
1347 if (__clear_user(up->reserved, sizeof(up->reserved)))
1350 if (kp->menu_count == 0)
1353 if (get_user(p, &up->menu_info))
1355 umenus = compat_ptr(p);
1357 if (copy_in_user(umenus, kmenus, kp->menu_count * sizeof(*umenus)))
1363 struct uvc_xu_control_query32 {
1368 compat_caddr_t data;
1371 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1372 const struct uvc_xu_control_query32 __user *up)
1378 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1379 __copy_from_user(kp, up, offsetof(typeof(*up), data)))
1382 if (kp->size == 0) {
1387 if (__get_user(p, &up->data))
1389 udata = compat_ptr(p);
1390 if (!access_ok(VERIFY_READ, udata, kp->size))
1393 kdata = compat_alloc_user_space(kp->size);
1398 if (copy_in_user(kdata, udata, kp->size))
1404 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1405 struct uvc_xu_control_query32 __user *up)
1408 u8 __user *kdata = kp->data;
1411 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1412 __copy_to_user(up, kp, offsetof(typeof(*up), data)))
1418 if (get_user(p, &up->data))
1420 udata = compat_ptr(p);
1421 if (!access_ok(VERIFY_READ, udata, kp->size))
1424 if (copy_in_user(udata, kdata, kp->size))
1430 #define UVCIOC_CTRL_MAP32 _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1431 #define UVCIOC_CTRL_QUERY32 _IOWR('u', 0x21, struct uvc_xu_control_query32)
1433 static long uvc_v4l2_compat_ioctl32(struct file *file,
1434 unsigned int cmd, unsigned long arg)
1436 struct uvc_fh *handle = file->private_data;
1438 struct uvc_xu_control_mapping xmap;
1439 struct uvc_xu_control_query xqry;
1441 void __user *up = compat_ptr(arg);
1445 case UVCIOC_CTRL_MAP32:
1446 ret = uvc_v4l2_get_xu_mapping(&karg.xmap, up);
1449 ret = uvc_ioctl_ctrl_map(handle->chain, &karg.xmap);
1452 ret = uvc_v4l2_put_xu_mapping(&karg.xmap, up);
1458 case UVCIOC_CTRL_QUERY32:
1459 ret = uvc_v4l2_get_xu_query(&karg.xqry, up);
1462 ret = uvc_xu_ctrl_query(handle->chain, &karg.xqry);
1465 ret = uvc_v4l2_put_xu_query(&karg.xqry, up);
1471 return -ENOIOCTLCMD;
1478 static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
1479 size_t count, loff_t *ppos)
1481 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1485 static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1487 struct uvc_fh *handle = file->private_data;
1488 struct uvc_streaming *stream = handle->stream;
1490 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1492 return uvc_queue_mmap(&stream->queue, vma);
1495 static unsigned int uvc_v4l2_poll(struct file *file, poll_table *wait)
1497 struct uvc_fh *handle = file->private_data;
1498 struct uvc_streaming *stream = handle->stream;
1500 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1502 return uvc_queue_poll(&stream->queue, file, wait);
1506 static unsigned long uvc_v4l2_get_unmapped_area(struct file *file,
1507 unsigned long addr, unsigned long len, unsigned long pgoff,
1508 unsigned long flags)
1510 struct uvc_fh *handle = file->private_data;
1511 struct uvc_streaming *stream = handle->stream;
1513 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_get_unmapped_area\n");
1515 return uvc_queue_get_unmapped_area(&stream->queue, pgoff);
1519 const struct v4l2_ioctl_ops uvc_ioctl_ops = {
1520 .vidioc_querycap = uvc_ioctl_querycap,
1521 .vidioc_enum_fmt_vid_cap = uvc_ioctl_enum_fmt_vid_cap,
1522 .vidioc_enum_fmt_vid_out = uvc_ioctl_enum_fmt_vid_out,
1523 .vidioc_g_fmt_vid_cap = uvc_ioctl_g_fmt_vid_cap,
1524 .vidioc_g_fmt_vid_out = uvc_ioctl_g_fmt_vid_out,
1525 .vidioc_s_fmt_vid_cap = uvc_ioctl_s_fmt_vid_cap,
1526 .vidioc_s_fmt_vid_out = uvc_ioctl_s_fmt_vid_out,
1527 .vidioc_try_fmt_vid_cap = uvc_ioctl_try_fmt_vid_cap,
1528 .vidioc_try_fmt_vid_out = uvc_ioctl_try_fmt_vid_out,
1529 .vidioc_reqbufs = uvc_ioctl_reqbufs,
1530 .vidioc_querybuf = uvc_ioctl_querybuf,
1531 .vidioc_qbuf = uvc_ioctl_qbuf,
1532 .vidioc_expbuf = uvc_ioctl_expbuf,
1533 .vidioc_dqbuf = uvc_ioctl_dqbuf,
1534 .vidioc_create_bufs = uvc_ioctl_create_bufs,
1535 .vidioc_streamon = uvc_ioctl_streamon,
1536 .vidioc_streamoff = uvc_ioctl_streamoff,
1537 .vidioc_enum_input = uvc_ioctl_enum_input,
1538 .vidioc_g_input = uvc_ioctl_g_input,
1539 .vidioc_s_input = uvc_ioctl_s_input,
1540 .vidioc_queryctrl = uvc_ioctl_queryctrl,
1541 .vidioc_query_ext_ctrl = uvc_ioctl_query_ext_ctrl,
1542 .vidioc_g_ctrl = uvc_ioctl_g_ctrl,
1543 .vidioc_s_ctrl = uvc_ioctl_s_ctrl,
1544 .vidioc_g_ext_ctrls = uvc_ioctl_g_ext_ctrls,
1545 .vidioc_s_ext_ctrls = uvc_ioctl_s_ext_ctrls,
1546 .vidioc_try_ext_ctrls = uvc_ioctl_try_ext_ctrls,
1547 .vidioc_querymenu = uvc_ioctl_querymenu,
1548 .vidioc_g_selection = uvc_ioctl_g_selection,
1549 .vidioc_g_parm = uvc_ioctl_g_parm,
1550 .vidioc_s_parm = uvc_ioctl_s_parm,
1551 .vidioc_enum_framesizes = uvc_ioctl_enum_framesizes,
1552 .vidioc_enum_frameintervals = uvc_ioctl_enum_frameintervals,
1553 .vidioc_subscribe_event = uvc_ioctl_subscribe_event,
1554 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1555 .vidioc_default = uvc_ioctl_default,
1558 const struct v4l2_file_operations uvc_fops = {
1559 .owner = THIS_MODULE,
1560 .open = uvc_v4l2_open,
1561 .release = uvc_v4l2_release,
1562 .unlocked_ioctl = video_ioctl2,
1563 #ifdef CONFIG_COMPAT
1564 .compat_ioctl32 = uvc_v4l2_compat_ioctl32,
1566 .read = uvc_v4l2_read,
1567 .mmap = uvc_v4l2_mmap,
1568 .poll = uvc_v4l2_poll,
1570 .get_unmapped_area = uvc_v4l2_get_unmapped_area,