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 = memdup_user(xmap->menu_info, size);
74 if (IS_ERR(map->menu_info)) {
75 ret = PTR_ERR(map->menu_info);
79 map->menu_count = xmap->menu_count;
83 uvc_trace(UVC_TRACE_CONTROL, "Unsupported V4L2 control type "
84 "%u.\n", xmap->v4l2_type);
89 ret = uvc_ctrl_add_mapping(chain, map);
91 kfree(map->menu_info);
98 /* ------------------------------------------------------------------------
103 * Find the frame interval closest to the requested frame interval for the
104 * given frame format and size. This should be done by the device as part of
105 * the Video Probe and Commit negotiation, but some hardware don't implement
108 static __u32 uvc_try_frame_interval(struct uvc_frame *frame, __u32 interval)
112 if (frame->bFrameIntervalType) {
113 __u32 best = -1, dist;
115 for (i = 0; i < frame->bFrameIntervalType; ++i) {
116 dist = interval > frame->dwFrameInterval[i]
117 ? interval - frame->dwFrameInterval[i]
118 : frame->dwFrameInterval[i] - interval;
126 interval = frame->dwFrameInterval[i-1];
128 const __u32 min = frame->dwFrameInterval[0];
129 const __u32 max = frame->dwFrameInterval[1];
130 const __u32 step = frame->dwFrameInterval[2];
132 interval = min + (interval - min + step/2) / step * step;
140 static __u32 uvc_v4l2_get_bytesperline(const struct uvc_format *format,
141 const struct uvc_frame *frame)
143 switch (format->fcc) {
144 case V4L2_PIX_FMT_NV12:
145 case V4L2_PIX_FMT_YVU420:
146 case V4L2_PIX_FMT_YUV420:
147 case V4L2_PIX_FMT_M420:
148 return frame->wWidth;
151 return format->bpp * frame->wWidth / 8;
155 static int uvc_v4l2_try_format(struct uvc_streaming *stream,
156 struct v4l2_format *fmt, struct uvc_streaming_control *probe,
157 struct uvc_format **uvc_format, struct uvc_frame **uvc_frame)
159 struct uvc_format *format = NULL;
160 struct uvc_frame *frame = NULL;
162 unsigned int d, maxd;
168 if (fmt->type != stream->type)
171 fcc = (__u8 *)&fmt->fmt.pix.pixelformat;
172 uvc_trace(UVC_TRACE_FORMAT, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
173 fmt->fmt.pix.pixelformat,
174 fcc[0], fcc[1], fcc[2], fcc[3],
175 fmt->fmt.pix.width, fmt->fmt.pix.height);
177 /* Check if the hardware supports the requested format, use the default
180 for (i = 0; i < stream->nformats; ++i) {
181 format = &stream->format[i];
182 if (format->fcc == fmt->fmt.pix.pixelformat)
186 if (i == stream->nformats) {
187 format = stream->def_format;
188 fmt->fmt.pix.pixelformat = format->fcc;
191 /* Find the closest image size. The distance between image sizes is
192 * the size in pixels of the non-overlapping regions between the
193 * requested size and the frame-specified size.
195 rw = fmt->fmt.pix.width;
196 rh = fmt->fmt.pix.height;
197 maxd = (unsigned int)-1;
199 for (i = 0; i < format->nframes; ++i) {
200 __u16 w = format->frame[i].wWidth;
201 __u16 h = format->frame[i].wHeight;
203 d = min(w, rw) * min(h, rh);
204 d = w*h + rw*rh - 2*d;
207 frame = &format->frame[i];
215 uvc_trace(UVC_TRACE_FORMAT, "Unsupported size %ux%u.\n",
216 fmt->fmt.pix.width, fmt->fmt.pix.height);
220 /* Use the default frame interval. */
221 interval = frame->dwDefaultFrameInterval;
222 uvc_trace(UVC_TRACE_FORMAT, "Using default frame interval %u.%u us "
223 "(%u.%u fps).\n", interval/10, interval%10, 10000000/interval,
224 (100000000/interval)%10);
226 /* Set the format index, frame index and frame interval. */
227 memset(probe, 0, sizeof *probe);
228 probe->bmHint = 1; /* dwFrameInterval */
229 probe->bFormatIndex = format->index;
230 probe->bFrameIndex = frame->bFrameIndex;
231 probe->dwFrameInterval = uvc_try_frame_interval(frame, interval);
232 /* Some webcams stall the probe control set request when the
233 * dwMaxVideoFrameSize field is set to zero. The UVC specification
234 * clearly states that the field is read-only from the host, so this
235 * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
236 * the webcam to work around the problem.
238 * The workaround could probably be enabled for all webcams, so the
239 * quirk can be removed if needed. It's currently useful to detect
240 * webcam bugs and fix them before they hit the market (providing
241 * developers test their webcams with the Linux driver as well as with
242 * the Windows driver).
244 mutex_lock(&stream->mutex);
245 if (stream->dev->quirks & UVC_QUIRK_PROBE_EXTRAFIELDS)
246 probe->dwMaxVideoFrameSize =
247 stream->ctrl.dwMaxVideoFrameSize;
249 /* Probe the device. */
250 ret = uvc_probe_video(stream, probe);
251 mutex_unlock(&stream->mutex);
255 /* After the probe, update fmt with the values returned from
256 * negotiation with the device. Some devices return invalid bFormatIndex
257 * and bFrameIndex values, in which case we can only assume they have
258 * accepted the requested format as-is.
260 for (i = 0; i < stream->nformats; ++i) {
261 if (probe->bFormatIndex == stream->format[i].index) {
262 format = &stream->format[i];
267 if (i == stream->nformats)
268 uvc_trace(UVC_TRACE_FORMAT,
269 "Unknown bFormatIndex %u, using default\n",
270 probe->bFormatIndex);
272 for (i = 0; i < format->nframes; ++i) {
273 if (probe->bFrameIndex == format->frame[i].bFrameIndex) {
274 frame = &format->frame[i];
279 if (i == format->nframes)
280 uvc_trace(UVC_TRACE_FORMAT,
281 "Unknown bFrameIndex %u, using default\n",
284 fmt->fmt.pix.width = frame->wWidth;
285 fmt->fmt.pix.height = frame->wHeight;
286 fmt->fmt.pix.field = V4L2_FIELD_NONE;
287 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
288 fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
289 fmt->fmt.pix.pixelformat = format->fcc;
290 fmt->fmt.pix.colorspace = format->colorspace;
291 fmt->fmt.pix.priv = 0;
293 if (uvc_format != NULL)
294 *uvc_format = format;
295 if (uvc_frame != NULL)
302 static int uvc_v4l2_get_format(struct uvc_streaming *stream,
303 struct v4l2_format *fmt)
305 struct uvc_format *format;
306 struct uvc_frame *frame;
309 if (fmt->type != stream->type)
312 mutex_lock(&stream->mutex);
313 format = stream->cur_format;
314 frame = stream->cur_frame;
316 if (format == NULL || frame == NULL) {
321 fmt->fmt.pix.pixelformat = format->fcc;
322 fmt->fmt.pix.width = frame->wWidth;
323 fmt->fmt.pix.height = frame->wHeight;
324 fmt->fmt.pix.field = V4L2_FIELD_NONE;
325 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
326 fmt->fmt.pix.sizeimage = stream->ctrl.dwMaxVideoFrameSize;
327 fmt->fmt.pix.colorspace = format->colorspace;
328 fmt->fmt.pix.priv = 0;
331 mutex_unlock(&stream->mutex);
335 static int uvc_v4l2_set_format(struct uvc_streaming *stream,
336 struct v4l2_format *fmt)
338 struct uvc_streaming_control probe;
339 struct uvc_format *format;
340 struct uvc_frame *frame;
343 if (fmt->type != stream->type)
346 ret = uvc_v4l2_try_format(stream, fmt, &probe, &format, &frame);
350 mutex_lock(&stream->mutex);
352 if (uvc_queue_allocated(&stream->queue)) {
357 stream->ctrl = probe;
358 stream->cur_format = format;
359 stream->cur_frame = frame;
362 mutex_unlock(&stream->mutex);
366 static int uvc_v4l2_get_streamparm(struct uvc_streaming *stream,
367 struct v4l2_streamparm *parm)
369 uint32_t numerator, denominator;
371 if (parm->type != stream->type)
374 mutex_lock(&stream->mutex);
375 numerator = stream->ctrl.dwFrameInterval;
376 mutex_unlock(&stream->mutex);
378 denominator = 10000000;
379 uvc_simplify_fraction(&numerator, &denominator, 8, 333);
381 memset(parm, 0, sizeof *parm);
382 parm->type = stream->type;
384 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
385 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
386 parm->parm.capture.capturemode = 0;
387 parm->parm.capture.timeperframe.numerator = numerator;
388 parm->parm.capture.timeperframe.denominator = denominator;
389 parm->parm.capture.extendedmode = 0;
390 parm->parm.capture.readbuffers = 0;
392 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
393 parm->parm.output.outputmode = 0;
394 parm->parm.output.timeperframe.numerator = numerator;
395 parm->parm.output.timeperframe.denominator = denominator;
401 static int uvc_v4l2_set_streamparm(struct uvc_streaming *stream,
402 struct v4l2_streamparm *parm)
404 struct uvc_streaming_control probe;
405 struct v4l2_fract timeperframe;
409 if (parm->type != stream->type)
412 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
413 timeperframe = parm->parm.capture.timeperframe;
415 timeperframe = parm->parm.output.timeperframe;
417 interval = uvc_fraction_to_interval(timeperframe.numerator,
418 timeperframe.denominator);
419 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
420 timeperframe.numerator, timeperframe.denominator, interval);
422 mutex_lock(&stream->mutex);
424 if (uvc_queue_streaming(&stream->queue)) {
425 mutex_unlock(&stream->mutex);
429 probe = stream->ctrl;
430 probe.dwFrameInterval =
431 uvc_try_frame_interval(stream->cur_frame, interval);
433 /* Probe the device with the new settings. */
434 ret = uvc_probe_video(stream, &probe);
436 mutex_unlock(&stream->mutex);
440 stream->ctrl = probe;
441 mutex_unlock(&stream->mutex);
443 /* Return the actual frame period. */
444 timeperframe.numerator = probe.dwFrameInterval;
445 timeperframe.denominator = 10000000;
446 uvc_simplify_fraction(&timeperframe.numerator,
447 &timeperframe.denominator, 8, 333);
449 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
450 parm->parm.capture.timeperframe = timeperframe;
451 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
453 parm->parm.output.timeperframe = timeperframe;
454 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
460 /* ------------------------------------------------------------------------
461 * Privilege management
465 * Privilege management is the multiple-open implementation basis. The current
466 * implementation is completely transparent for the end-user and doesn't
467 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
468 * Those ioctls enable finer control on the device (by making possible for a
469 * user to request exclusive access to a device), but are not mature yet.
470 * Switching to the V4L2 priority mechanism might be considered in the future
471 * if this situation changes.
473 * Each open instance of a UVC device can either be in a privileged or
474 * unprivileged state. Only a single instance can be in a privileged state at
475 * a given time. Trying to perform an operation that requires privileges will
476 * automatically acquire the required privileges if possible, or return -EBUSY
477 * otherwise. Privileges are dismissed when closing the instance or when
478 * freeing the video buffers using VIDIOC_REQBUFS.
480 * Operations that require privileges are:
487 static int uvc_acquire_privileges(struct uvc_fh *handle)
489 /* Always succeed if the handle is already privileged. */
490 if (handle->state == UVC_HANDLE_ACTIVE)
493 /* Check if the device already has a privileged handle. */
494 if (atomic_inc_return(&handle->stream->active) != 1) {
495 atomic_dec(&handle->stream->active);
499 handle->state = UVC_HANDLE_ACTIVE;
503 static void uvc_dismiss_privileges(struct uvc_fh *handle)
505 if (handle->state == UVC_HANDLE_ACTIVE)
506 atomic_dec(&handle->stream->active);
508 handle->state = UVC_HANDLE_PASSIVE;
511 static int uvc_has_privileges(struct uvc_fh *handle)
513 return handle->state == UVC_HANDLE_ACTIVE;
516 /* ------------------------------------------------------------------------
517 * V4L2 file operations
520 static int uvc_v4l2_open(struct file *file)
522 struct uvc_streaming *stream;
523 struct uvc_fh *handle;
526 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
527 stream = video_drvdata(file);
529 ret = usb_autopm_get_interface(stream->dev->intf);
533 /* Create the device handle. */
534 handle = kzalloc(sizeof *handle, GFP_KERNEL);
535 if (handle == NULL) {
536 usb_autopm_put_interface(stream->dev->intf);
540 mutex_lock(&stream->dev->lock);
541 if (stream->dev->users == 0) {
542 ret = uvc_status_start(stream->dev, GFP_KERNEL);
544 mutex_unlock(&stream->dev->lock);
545 usb_autopm_put_interface(stream->dev->intf);
551 stream->dev->users++;
552 mutex_unlock(&stream->dev->lock);
554 v4l2_fh_init(&handle->vfh, &stream->vdev);
555 v4l2_fh_add(&handle->vfh);
556 handle->chain = stream->chain;
557 handle->stream = stream;
558 handle->state = UVC_HANDLE_PASSIVE;
559 file->private_data = handle;
564 static int uvc_v4l2_release(struct file *file)
566 struct uvc_fh *handle = file->private_data;
567 struct uvc_streaming *stream = handle->stream;
569 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
571 /* Only free resources if this is a privileged handle. */
572 if (uvc_has_privileges(handle))
573 uvc_queue_release(&stream->queue);
575 /* Release the file handle. */
576 uvc_dismiss_privileges(handle);
577 v4l2_fh_del(&handle->vfh);
578 v4l2_fh_exit(&handle->vfh);
580 file->private_data = NULL;
582 mutex_lock(&stream->dev->lock);
583 if (--stream->dev->users == 0)
584 uvc_status_stop(stream->dev);
585 mutex_unlock(&stream->dev->lock);
587 usb_autopm_put_interface(stream->dev->intf);
591 static int uvc_ioctl_querycap(struct file *file, void *fh,
592 struct v4l2_capability *cap)
594 struct video_device *vdev = video_devdata(file);
595 struct uvc_fh *handle = file->private_data;
596 struct uvc_video_chain *chain = handle->chain;
597 struct uvc_streaming *stream = handle->stream;
599 strlcpy(cap->driver, "uvcvideo", sizeof(cap->driver));
600 strlcpy(cap->card, vdev->name, sizeof(cap->card));
601 usb_make_path(stream->dev->udev, cap->bus_info, sizeof(cap->bus_info));
602 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
604 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
605 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING;
607 cap->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
612 static int uvc_ioctl_enum_fmt(struct uvc_streaming *stream,
613 struct v4l2_fmtdesc *fmt)
615 struct uvc_format *format;
616 enum v4l2_buf_type type = fmt->type;
617 __u32 index = fmt->index;
619 if (fmt->type != stream->type || fmt->index >= stream->nformats)
622 memset(fmt, 0, sizeof(*fmt));
626 format = &stream->format[fmt->index];
628 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
629 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
630 strlcpy(fmt->description, format->name, sizeof(fmt->description));
631 fmt->description[sizeof(fmt->description) - 1] = 0;
632 fmt->pixelformat = format->fcc;
636 static int uvc_ioctl_enum_fmt_vid_cap(struct file *file, void *fh,
637 struct v4l2_fmtdesc *fmt)
639 struct uvc_fh *handle = fh;
640 struct uvc_streaming *stream = handle->stream;
642 return uvc_ioctl_enum_fmt(stream, fmt);
645 static int uvc_ioctl_enum_fmt_vid_out(struct file *file, void *fh,
646 struct v4l2_fmtdesc *fmt)
648 struct uvc_fh *handle = fh;
649 struct uvc_streaming *stream = handle->stream;
651 return uvc_ioctl_enum_fmt(stream, fmt);
654 static int uvc_ioctl_g_fmt_vid_cap(struct file *file, void *fh,
655 struct v4l2_format *fmt)
657 struct uvc_fh *handle = fh;
658 struct uvc_streaming *stream = handle->stream;
660 return uvc_v4l2_get_format(stream, fmt);
663 static int uvc_ioctl_g_fmt_vid_out(struct file *file, void *fh,
664 struct v4l2_format *fmt)
666 struct uvc_fh *handle = fh;
667 struct uvc_streaming *stream = handle->stream;
669 return uvc_v4l2_get_format(stream, fmt);
672 static int uvc_ioctl_s_fmt_vid_cap(struct file *file, void *fh,
673 struct v4l2_format *fmt)
675 struct uvc_fh *handle = fh;
676 struct uvc_streaming *stream = handle->stream;
679 ret = uvc_acquire_privileges(handle);
683 return uvc_v4l2_set_format(stream, fmt);
686 static int uvc_ioctl_s_fmt_vid_out(struct file *file, void *fh,
687 struct v4l2_format *fmt)
689 struct uvc_fh *handle = fh;
690 struct uvc_streaming *stream = handle->stream;
693 ret = uvc_acquire_privileges(handle);
697 return uvc_v4l2_set_format(stream, fmt);
700 static int uvc_ioctl_try_fmt_vid_cap(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_try_fmt_vid_out(struct file *file, void *fh,
711 struct v4l2_format *fmt)
713 struct uvc_fh *handle = fh;
714 struct uvc_streaming *stream = handle->stream;
715 struct uvc_streaming_control probe;
717 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
720 static int uvc_ioctl_reqbufs(struct file *file, void *fh,
721 struct v4l2_requestbuffers *rb)
723 struct uvc_fh *handle = fh;
724 struct uvc_streaming *stream = handle->stream;
727 ret = uvc_acquire_privileges(handle);
731 mutex_lock(&stream->mutex);
732 ret = uvc_request_buffers(&stream->queue, rb);
733 mutex_unlock(&stream->mutex);
738 uvc_dismiss_privileges(handle);
743 static int uvc_ioctl_querybuf(struct file *file, void *fh,
744 struct v4l2_buffer *buf)
746 struct uvc_fh *handle = fh;
747 struct uvc_streaming *stream = handle->stream;
749 if (!uvc_has_privileges(handle))
752 return uvc_query_buffer(&stream->queue, buf);
755 static int uvc_ioctl_qbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
757 struct uvc_fh *handle = fh;
758 struct uvc_streaming *stream = handle->stream;
760 if (!uvc_has_privileges(handle))
763 return uvc_queue_buffer(&stream->queue, buf);
766 static int uvc_ioctl_expbuf(struct file *file, void *fh,
767 struct v4l2_exportbuffer *exp)
769 struct uvc_fh *handle = fh;
770 struct uvc_streaming *stream = handle->stream;
772 if (!uvc_has_privileges(handle))
775 return uvc_export_buffer(&stream->queue, exp);
778 static int uvc_ioctl_dqbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
780 struct uvc_fh *handle = fh;
781 struct uvc_streaming *stream = handle->stream;
783 if (!uvc_has_privileges(handle))
786 return uvc_dequeue_buffer(&stream->queue, buf,
787 file->f_flags & O_NONBLOCK);
790 static int uvc_ioctl_create_bufs(struct file *file, void *fh,
791 struct v4l2_create_buffers *cb)
793 struct uvc_fh *handle = fh;
794 struct uvc_streaming *stream = handle->stream;
797 ret = uvc_acquire_privileges(handle);
801 return uvc_create_buffers(&stream->queue, cb);
804 static int uvc_ioctl_streamon(struct file *file, void *fh,
805 enum v4l2_buf_type type)
807 struct uvc_fh *handle = fh;
808 struct uvc_streaming *stream = handle->stream;
811 if (!uvc_has_privileges(handle))
814 mutex_lock(&stream->mutex);
815 ret = uvc_queue_streamon(&stream->queue, type);
816 mutex_unlock(&stream->mutex);
821 static int uvc_ioctl_streamoff(struct file *file, void *fh,
822 enum v4l2_buf_type type)
824 struct uvc_fh *handle = fh;
825 struct uvc_streaming *stream = handle->stream;
827 if (!uvc_has_privileges(handle))
830 mutex_lock(&stream->mutex);
831 uvc_queue_streamoff(&stream->queue, type);
832 mutex_unlock(&stream->mutex);
837 static int uvc_ioctl_enum_input(struct file *file, void *fh,
838 struct v4l2_input *input)
840 struct uvc_fh *handle = fh;
841 struct uvc_video_chain *chain = handle->chain;
842 const struct uvc_entity *selector = chain->selector;
843 struct uvc_entity *iterm = NULL;
844 struct uvc_entity *it;
845 u32 index = input->index;
847 if (selector == NULL ||
848 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
851 list_for_each_entry(it, &chain->entities, chain) {
852 if (UVC_ENTITY_IS_ITERM(it)) {
857 } else if (index < selector->bNrInPins) {
858 list_for_each_entry(it, &chain->entities, chain) {
859 if (!UVC_ENTITY_IS_ITERM(it))
861 if (it->id == selector->baSourceID[index]) {
871 memset(input, 0, sizeof(*input));
872 input->index = index;
873 strlcpy(input->name, iterm->name, sizeof(input->name));
874 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
875 input->type = V4L2_INPUT_TYPE_CAMERA;
880 static int uvc_ioctl_g_input(struct file *file, void *fh, unsigned int *input)
882 struct uvc_fh *handle = fh;
883 struct uvc_video_chain *chain = handle->chain;
887 if (chain->selector == NULL ||
888 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
893 buf = kmalloc(1, GFP_KERNEL);
897 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, chain->selector->id,
898 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
908 static int uvc_ioctl_s_input(struct file *file, void *fh, unsigned int input)
910 struct uvc_fh *handle = fh;
911 struct uvc_video_chain *chain = handle->chain;
915 ret = uvc_acquire_privileges(handle);
919 if (chain->selector == NULL ||
920 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
926 if (input >= chain->selector->bNrInPins)
929 buf = kmalloc(1, GFP_KERNEL);
934 ret = uvc_query_ctrl(chain->dev, UVC_SET_CUR, chain->selector->id,
935 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
942 static int uvc_ioctl_queryctrl(struct file *file, void *fh,
943 struct v4l2_queryctrl *qc)
945 struct uvc_fh *handle = fh;
946 struct uvc_video_chain *chain = handle->chain;
948 return uvc_query_v4l2_ctrl(chain, qc);
951 static int uvc_ioctl_query_ext_ctrl(struct file *file, void *fh,
952 struct v4l2_query_ext_ctrl *qec)
954 struct uvc_fh *handle = fh;
955 struct uvc_video_chain *chain = handle->chain;
956 struct v4l2_queryctrl qc = { qec->id };
959 ret = uvc_query_v4l2_ctrl(chain, &qc);
965 strlcpy(qec->name, qc.name, sizeof(qec->name));
966 qec->minimum = qc.minimum;
967 qec->maximum = qc.maximum;
969 qec->default_value = qc.default_value;
970 qec->flags = qc.flags;
974 memset(qec->dims, 0, sizeof(qec->dims));
975 memset(qec->reserved, 0, sizeof(qec->reserved));
980 static int uvc_ioctl_g_ctrl(struct file *file, void *fh,
981 struct v4l2_control *ctrl)
983 struct uvc_fh *handle = fh;
984 struct uvc_video_chain *chain = handle->chain;
985 struct v4l2_ext_control xctrl;
988 memset(&xctrl, 0, sizeof(xctrl));
991 ret = uvc_ctrl_begin(chain);
995 ret = uvc_ctrl_get(chain, &xctrl);
996 uvc_ctrl_rollback(handle);
1000 ctrl->value = xctrl.value;
1004 static int uvc_ioctl_s_ctrl(struct file *file, void *fh,
1005 struct v4l2_control *ctrl)
1007 struct uvc_fh *handle = fh;
1008 struct uvc_video_chain *chain = handle->chain;
1009 struct v4l2_ext_control xctrl;
1012 memset(&xctrl, 0, sizeof(xctrl));
1013 xctrl.id = ctrl->id;
1014 xctrl.value = ctrl->value;
1016 ret = uvc_ctrl_begin(chain);
1020 ret = uvc_ctrl_set(chain, &xctrl);
1022 uvc_ctrl_rollback(handle);
1026 ret = uvc_ctrl_commit(handle, &xctrl, 1);
1030 ctrl->value = xctrl.value;
1034 static int uvc_ioctl_g_ext_ctrls(struct file *file, void *fh,
1035 struct v4l2_ext_controls *ctrls)
1037 struct uvc_fh *handle = fh;
1038 struct uvc_video_chain *chain = handle->chain;
1039 struct v4l2_ext_control *ctrl = ctrls->controls;
1043 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL) {
1044 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1045 struct v4l2_queryctrl qc = { .id = ctrl->id };
1047 ret = uvc_query_v4l2_ctrl(chain, &qc);
1049 ctrls->error_idx = i;
1053 ctrl->value = qc.default_value;
1059 ret = uvc_ctrl_begin(chain);
1063 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1064 ret = uvc_ctrl_get(chain, ctrl);
1066 uvc_ctrl_rollback(handle);
1067 ctrls->error_idx = i;
1072 ctrls->error_idx = 0;
1074 return uvc_ctrl_rollback(handle);
1077 static int uvc_ioctl_s_try_ext_ctrls(struct uvc_fh *handle,
1078 struct v4l2_ext_controls *ctrls,
1081 struct v4l2_ext_control *ctrl = ctrls->controls;
1082 struct uvc_video_chain *chain = handle->chain;
1086 /* Default value cannot be changed */
1087 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL)
1090 ret = uvc_ctrl_begin(chain);
1094 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1095 ret = uvc_ctrl_set(chain, ctrl);
1097 uvc_ctrl_rollback(handle);
1098 ctrls->error_idx = commit ? ctrls->count : i;
1103 ctrls->error_idx = 0;
1106 return uvc_ctrl_commit(handle, ctrls->controls, ctrls->count);
1108 return uvc_ctrl_rollback(handle);
1111 static int uvc_ioctl_s_ext_ctrls(struct file *file, void *fh,
1112 struct v4l2_ext_controls *ctrls)
1114 struct uvc_fh *handle = fh;
1116 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, true);
1119 static int uvc_ioctl_try_ext_ctrls(struct file *file, void *fh,
1120 struct v4l2_ext_controls *ctrls)
1122 struct uvc_fh *handle = fh;
1124 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, false);
1127 static int uvc_ioctl_querymenu(struct file *file, void *fh,
1128 struct v4l2_querymenu *qm)
1130 struct uvc_fh *handle = fh;
1131 struct uvc_video_chain *chain = handle->chain;
1133 return uvc_query_v4l2_menu(chain, qm);
1136 static int uvc_ioctl_g_selection(struct file *file, void *fh,
1137 struct v4l2_selection *sel)
1139 struct uvc_fh *handle = fh;
1140 struct uvc_streaming *stream = handle->stream;
1142 if (sel->type != stream->type)
1145 switch (sel->target) {
1146 case V4L2_SEL_TGT_CROP_DEFAULT:
1147 case V4L2_SEL_TGT_CROP_BOUNDS:
1148 if (stream->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1151 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
1152 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
1153 if (stream->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
1162 mutex_lock(&stream->mutex);
1163 sel->r.width = stream->cur_frame->wWidth;
1164 sel->r.height = stream->cur_frame->wHeight;
1165 mutex_unlock(&stream->mutex);
1170 static int uvc_ioctl_g_parm(struct file *file, void *fh,
1171 struct v4l2_streamparm *parm)
1173 struct uvc_fh *handle = fh;
1174 struct uvc_streaming *stream = handle->stream;
1176 return uvc_v4l2_get_streamparm(stream, parm);
1179 static int uvc_ioctl_s_parm(struct file *file, void *fh,
1180 struct v4l2_streamparm *parm)
1182 struct uvc_fh *handle = fh;
1183 struct uvc_streaming *stream = handle->stream;
1186 ret = uvc_acquire_privileges(handle);
1190 return uvc_v4l2_set_streamparm(stream, parm);
1193 static int uvc_ioctl_enum_framesizes(struct file *file, void *fh,
1194 struct v4l2_frmsizeenum *fsize)
1196 struct uvc_fh *handle = fh;
1197 struct uvc_streaming *stream = handle->stream;
1198 struct uvc_format *format = NULL;
1199 struct uvc_frame *frame;
1202 /* Look for the given pixel format */
1203 for (i = 0; i < stream->nformats; i++) {
1204 if (stream->format[i].fcc == fsize->pixel_format) {
1205 format = &stream->format[i];
1212 if (fsize->index >= format->nframes)
1215 frame = &format->frame[fsize->index];
1216 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1217 fsize->discrete.width = frame->wWidth;
1218 fsize->discrete.height = frame->wHeight;
1222 static int uvc_ioctl_enum_frameintervals(struct file *file, void *fh,
1223 struct v4l2_frmivalenum *fival)
1225 struct uvc_fh *handle = fh;
1226 struct uvc_streaming *stream = handle->stream;
1227 struct uvc_format *format = NULL;
1228 struct uvc_frame *frame = NULL;
1231 /* Look for the given pixel format and frame size */
1232 for (i = 0; i < stream->nformats; i++) {
1233 if (stream->format[i].fcc == fival->pixel_format) {
1234 format = &stream->format[i];
1241 for (i = 0; i < format->nframes; i++) {
1242 if (format->frame[i].wWidth == fival->width &&
1243 format->frame[i].wHeight == fival->height) {
1244 frame = &format->frame[i];
1251 if (frame->bFrameIntervalType) {
1252 if (fival->index >= frame->bFrameIntervalType)
1255 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
1256 fival->discrete.numerator =
1257 frame->dwFrameInterval[fival->index];
1258 fival->discrete.denominator = 10000000;
1259 uvc_simplify_fraction(&fival->discrete.numerator,
1260 &fival->discrete.denominator, 8, 333);
1265 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
1266 fival->stepwise.min.numerator = frame->dwFrameInterval[0];
1267 fival->stepwise.min.denominator = 10000000;
1268 fival->stepwise.max.numerator = frame->dwFrameInterval[1];
1269 fival->stepwise.max.denominator = 10000000;
1270 fival->stepwise.step.numerator = frame->dwFrameInterval[2];
1271 fival->stepwise.step.denominator = 10000000;
1272 uvc_simplify_fraction(&fival->stepwise.min.numerator,
1273 &fival->stepwise.min.denominator, 8, 333);
1274 uvc_simplify_fraction(&fival->stepwise.max.numerator,
1275 &fival->stepwise.max.denominator, 8, 333);
1276 uvc_simplify_fraction(&fival->stepwise.step.numerator,
1277 &fival->stepwise.step.denominator, 8, 333);
1283 static int uvc_ioctl_subscribe_event(struct v4l2_fh *fh,
1284 const struct v4l2_event_subscription *sub)
1286 switch (sub->type) {
1287 case V4L2_EVENT_CTRL:
1288 return v4l2_event_subscribe(fh, sub, 0, &uvc_ctrl_sub_ev_ops);
1294 static long uvc_ioctl_default(struct file *file, void *fh, bool valid_prio,
1295 unsigned int cmd, void *arg)
1297 struct uvc_fh *handle = fh;
1298 struct uvc_video_chain *chain = handle->chain;
1301 /* Dynamic controls. */
1302 case UVCIOC_CTRL_MAP:
1303 return uvc_ioctl_ctrl_map(chain, arg);
1305 case UVCIOC_CTRL_QUERY:
1306 return uvc_xu_ctrl_query(chain, arg);
1313 #ifdef CONFIG_COMPAT
1314 struct uvc_xu_control_mapping32 {
1325 compat_caddr_t menu_info;
1331 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1332 const struct uvc_xu_control_mapping32 __user *up)
1336 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1337 __copy_from_user(kp, up, offsetof(typeof(*up), menu_info)) ||
1338 __get_user(kp->menu_count, &up->menu_count))
1341 memset(kp->reserved, 0, sizeof(kp->reserved));
1343 if (kp->menu_count == 0) {
1344 kp->menu_info = NULL;
1348 if (__get_user(p, &up->menu_info))
1350 kp->menu_info = compat_ptr(p);
1355 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1356 struct uvc_xu_control_mapping32 __user *up)
1358 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1359 __copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1360 __put_user(kp->menu_count, &up->menu_count))
1363 if (__clear_user(up->reserved, sizeof(up->reserved)))
1369 struct uvc_xu_control_query32 {
1374 compat_caddr_t data;
1377 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1378 const struct uvc_xu_control_query32 __user *up)
1382 if (!access_ok(VERIFY_READ, up, sizeof(*up)) ||
1383 __copy_from_user(kp, up, offsetof(typeof(*up), data)))
1386 if (kp->size == 0) {
1391 if (__get_user(p, &up->data))
1393 kp->data = compat_ptr(p);
1398 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1399 struct uvc_xu_control_query32 __user *up)
1401 if (!access_ok(VERIFY_WRITE, up, sizeof(*up)) ||
1402 __copy_to_user(up, kp, offsetof(typeof(*up), data)))
1408 #define UVCIOC_CTRL_MAP32 _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1409 #define UVCIOC_CTRL_QUERY32 _IOWR('u', 0x21, struct uvc_xu_control_query32)
1411 static long uvc_v4l2_compat_ioctl32(struct file *file,
1412 unsigned int cmd, unsigned long arg)
1414 struct uvc_fh *handle = file->private_data;
1416 struct uvc_xu_control_mapping xmap;
1417 struct uvc_xu_control_query xqry;
1419 void __user *up = compat_ptr(arg);
1423 case UVCIOC_CTRL_MAP32:
1424 ret = uvc_v4l2_get_xu_mapping(&karg.xmap, up);
1427 ret = uvc_ioctl_ctrl_map(handle->chain, &karg.xmap);
1430 ret = uvc_v4l2_put_xu_mapping(&karg.xmap, up);
1436 case UVCIOC_CTRL_QUERY32:
1437 ret = uvc_v4l2_get_xu_query(&karg.xqry, up);
1440 ret = uvc_xu_ctrl_query(handle->chain, &karg.xqry);
1443 ret = uvc_v4l2_put_xu_query(&karg.xqry, up);
1449 return -ENOIOCTLCMD;
1456 static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
1457 size_t count, loff_t *ppos)
1459 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1463 static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1465 struct uvc_fh *handle = file->private_data;
1466 struct uvc_streaming *stream = handle->stream;
1468 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1470 return uvc_queue_mmap(&stream->queue, vma);
1473 static unsigned int uvc_v4l2_poll(struct file *file, poll_table *wait)
1475 struct uvc_fh *handle = file->private_data;
1476 struct uvc_streaming *stream = handle->stream;
1478 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1480 return uvc_queue_poll(&stream->queue, file, wait);
1484 static unsigned long uvc_v4l2_get_unmapped_area(struct file *file,
1485 unsigned long addr, unsigned long len, unsigned long pgoff,
1486 unsigned long flags)
1488 struct uvc_fh *handle = file->private_data;
1489 struct uvc_streaming *stream = handle->stream;
1491 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_get_unmapped_area\n");
1493 return uvc_queue_get_unmapped_area(&stream->queue, pgoff);
1497 const struct v4l2_ioctl_ops uvc_ioctl_ops = {
1498 .vidioc_querycap = uvc_ioctl_querycap,
1499 .vidioc_enum_fmt_vid_cap = uvc_ioctl_enum_fmt_vid_cap,
1500 .vidioc_enum_fmt_vid_out = uvc_ioctl_enum_fmt_vid_out,
1501 .vidioc_g_fmt_vid_cap = uvc_ioctl_g_fmt_vid_cap,
1502 .vidioc_g_fmt_vid_out = uvc_ioctl_g_fmt_vid_out,
1503 .vidioc_s_fmt_vid_cap = uvc_ioctl_s_fmt_vid_cap,
1504 .vidioc_s_fmt_vid_out = uvc_ioctl_s_fmt_vid_out,
1505 .vidioc_try_fmt_vid_cap = uvc_ioctl_try_fmt_vid_cap,
1506 .vidioc_try_fmt_vid_out = uvc_ioctl_try_fmt_vid_out,
1507 .vidioc_reqbufs = uvc_ioctl_reqbufs,
1508 .vidioc_querybuf = uvc_ioctl_querybuf,
1509 .vidioc_qbuf = uvc_ioctl_qbuf,
1510 .vidioc_expbuf = uvc_ioctl_expbuf,
1511 .vidioc_dqbuf = uvc_ioctl_dqbuf,
1512 .vidioc_create_bufs = uvc_ioctl_create_bufs,
1513 .vidioc_streamon = uvc_ioctl_streamon,
1514 .vidioc_streamoff = uvc_ioctl_streamoff,
1515 .vidioc_enum_input = uvc_ioctl_enum_input,
1516 .vidioc_g_input = uvc_ioctl_g_input,
1517 .vidioc_s_input = uvc_ioctl_s_input,
1518 .vidioc_queryctrl = uvc_ioctl_queryctrl,
1519 .vidioc_query_ext_ctrl = uvc_ioctl_query_ext_ctrl,
1520 .vidioc_g_ctrl = uvc_ioctl_g_ctrl,
1521 .vidioc_s_ctrl = uvc_ioctl_s_ctrl,
1522 .vidioc_g_ext_ctrls = uvc_ioctl_g_ext_ctrls,
1523 .vidioc_s_ext_ctrls = uvc_ioctl_s_ext_ctrls,
1524 .vidioc_try_ext_ctrls = uvc_ioctl_try_ext_ctrls,
1525 .vidioc_querymenu = uvc_ioctl_querymenu,
1526 .vidioc_g_selection = uvc_ioctl_g_selection,
1527 .vidioc_g_parm = uvc_ioctl_g_parm,
1528 .vidioc_s_parm = uvc_ioctl_s_parm,
1529 .vidioc_enum_framesizes = uvc_ioctl_enum_framesizes,
1530 .vidioc_enum_frameintervals = uvc_ioctl_enum_frameintervals,
1531 .vidioc_subscribe_event = uvc_ioctl_subscribe_event,
1532 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1533 .vidioc_default = uvc_ioctl_default,
1536 const struct v4l2_file_operations uvc_fops = {
1537 .owner = THIS_MODULE,
1538 .open = uvc_v4l2_open,
1539 .release = uvc_v4l2_release,
1540 .unlocked_ioctl = video_ioctl2,
1541 #ifdef CONFIG_COMPAT
1542 .compat_ioctl32 = uvc_v4l2_compat_ioctl32,
1544 .read = uvc_v4l2_read,
1545 .mmap = uvc_v4l2_mmap,
1546 .poll = uvc_v4l2_poll,
1548 .get_unmapped_area = uvc_v4l2_get_unmapped_area,