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) {
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 u32 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;
406 struct uvc_format *format;
407 struct uvc_frame *frame;
412 if (parm->type != stream->type)
415 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
416 timeperframe = parm->parm.capture.timeperframe;
418 timeperframe = parm->parm.output.timeperframe;
420 interval = uvc_fraction_to_interval(timeperframe.numerator,
421 timeperframe.denominator);
422 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
423 timeperframe.numerator, timeperframe.denominator, interval);
425 mutex_lock(&stream->mutex);
427 if (uvc_queue_streaming(&stream->queue)) {
428 mutex_unlock(&stream->mutex);
432 format = stream->cur_format;
433 frame = stream->cur_frame;
434 probe = stream->ctrl;
435 probe.dwFrameInterval = uvc_try_frame_interval(frame, interval);
436 maxd = abs((s32)probe.dwFrameInterval - interval);
438 /* Try frames with matching size to find the best frame interval. */
439 for (i = 0; i < format->nframes && maxd != 0; i++) {
442 if (&format->frame[i] == stream->cur_frame)
445 if (format->frame[i].wWidth != stream->cur_frame->wWidth ||
446 format->frame[i].wHeight != stream->cur_frame->wHeight)
449 ival = uvc_try_frame_interval(&format->frame[i], interval);
450 d = abs((s32)ival - interval);
454 frame = &format->frame[i];
455 probe.bFrameIndex = frame->bFrameIndex;
456 probe.dwFrameInterval = ival;
460 /* Probe the device with the new settings. */
461 ret = uvc_probe_video(stream, &probe);
463 mutex_unlock(&stream->mutex);
467 stream->ctrl = probe;
468 stream->cur_frame = frame;
469 mutex_unlock(&stream->mutex);
471 /* Return the actual frame period. */
472 timeperframe.numerator = probe.dwFrameInterval;
473 timeperframe.denominator = 10000000;
474 uvc_simplify_fraction(&timeperframe.numerator,
475 &timeperframe.denominator, 8, 333);
477 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
478 parm->parm.capture.timeperframe = timeperframe;
479 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
481 parm->parm.output.timeperframe = timeperframe;
482 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
488 /* ------------------------------------------------------------------------
489 * Privilege management
493 * Privilege management is the multiple-open implementation basis. The current
494 * implementation is completely transparent for the end-user and doesn't
495 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
496 * Those ioctls enable finer control on the device (by making possible for a
497 * user to request exclusive access to a device), but are not mature yet.
498 * Switching to the V4L2 priority mechanism might be considered in the future
499 * if this situation changes.
501 * Each open instance of a UVC device can either be in a privileged or
502 * unprivileged state. Only a single instance can be in a privileged state at
503 * a given time. Trying to perform an operation that requires privileges will
504 * automatically acquire the required privileges if possible, or return -EBUSY
505 * otherwise. Privileges are dismissed when closing the instance or when
506 * freeing the video buffers using VIDIOC_REQBUFS.
508 * Operations that require privileges are:
515 static int uvc_acquire_privileges(struct uvc_fh *handle)
517 /* Always succeed if the handle is already privileged. */
518 if (handle->state == UVC_HANDLE_ACTIVE)
521 /* Check if the device already has a privileged handle. */
522 if (atomic_inc_return(&handle->stream->active) != 1) {
523 atomic_dec(&handle->stream->active);
527 handle->state = UVC_HANDLE_ACTIVE;
531 static void uvc_dismiss_privileges(struct uvc_fh *handle)
533 if (handle->state == UVC_HANDLE_ACTIVE)
534 atomic_dec(&handle->stream->active);
536 handle->state = UVC_HANDLE_PASSIVE;
539 static int uvc_has_privileges(struct uvc_fh *handle)
541 return handle->state == UVC_HANDLE_ACTIVE;
544 /* ------------------------------------------------------------------------
545 * V4L2 file operations
548 static int uvc_v4l2_open(struct file *file)
550 struct uvc_streaming *stream;
551 struct uvc_fh *handle;
554 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
555 stream = video_drvdata(file);
557 ret = usb_autopm_get_interface(stream->dev->intf);
561 /* Create the device handle. */
562 handle = kzalloc(sizeof(*handle), GFP_KERNEL);
563 if (handle == NULL) {
564 usb_autopm_put_interface(stream->dev->intf);
568 mutex_lock(&stream->dev->lock);
569 if (stream->dev->users == 0) {
570 ret = uvc_status_start(stream->dev, GFP_KERNEL);
572 mutex_unlock(&stream->dev->lock);
573 usb_autopm_put_interface(stream->dev->intf);
579 stream->dev->users++;
580 mutex_unlock(&stream->dev->lock);
582 v4l2_fh_init(&handle->vfh, &stream->vdev);
583 v4l2_fh_add(&handle->vfh);
584 handle->chain = stream->chain;
585 handle->stream = stream;
586 handle->state = UVC_HANDLE_PASSIVE;
587 file->private_data = handle;
592 static int uvc_v4l2_release(struct file *file)
594 struct uvc_fh *handle = file->private_data;
595 struct uvc_streaming *stream = handle->stream;
597 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
599 /* Only free resources if this is a privileged handle. */
600 if (uvc_has_privileges(handle))
601 uvc_queue_release(&stream->queue);
603 /* Release the file handle. */
604 uvc_dismiss_privileges(handle);
605 v4l2_fh_del(&handle->vfh);
606 v4l2_fh_exit(&handle->vfh);
608 file->private_data = NULL;
610 mutex_lock(&stream->dev->lock);
611 if (--stream->dev->users == 0)
612 uvc_status_stop(stream->dev);
613 mutex_unlock(&stream->dev->lock);
615 usb_autopm_put_interface(stream->dev->intf);
619 static int uvc_ioctl_querycap(struct file *file, void *fh,
620 struct v4l2_capability *cap)
622 struct video_device *vdev = video_devdata(file);
623 struct uvc_fh *handle = file->private_data;
624 struct uvc_video_chain *chain = handle->chain;
625 struct uvc_streaming *stream = handle->stream;
627 strlcpy(cap->driver, "uvcvideo", sizeof(cap->driver));
628 strlcpy(cap->card, vdev->name, sizeof(cap->card));
629 usb_make_path(stream->dev->udev, cap->bus_info, sizeof(cap->bus_info));
630 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
636 static int uvc_ioctl_enum_fmt(struct uvc_streaming *stream,
637 struct v4l2_fmtdesc *fmt)
639 struct uvc_format *format;
640 enum v4l2_buf_type type = fmt->type;
641 u32 index = fmt->index;
643 if (fmt->type != stream->type || fmt->index >= stream->nformats)
646 memset(fmt, 0, sizeof(*fmt));
650 format = &stream->format[fmt->index];
652 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
653 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
654 strlcpy(fmt->description, format->name, sizeof(fmt->description));
655 fmt->description[sizeof(fmt->description) - 1] = 0;
656 fmt->pixelformat = format->fcc;
660 static int uvc_ioctl_enum_fmt_vid_cap(struct file *file, void *fh,
661 struct v4l2_fmtdesc *fmt)
663 struct uvc_fh *handle = fh;
664 struct uvc_streaming *stream = handle->stream;
666 return uvc_ioctl_enum_fmt(stream, fmt);
669 static int uvc_ioctl_enum_fmt_vid_out(struct file *file, void *fh,
670 struct v4l2_fmtdesc *fmt)
672 struct uvc_fh *handle = fh;
673 struct uvc_streaming *stream = handle->stream;
675 return uvc_ioctl_enum_fmt(stream, fmt);
678 static int uvc_ioctl_g_fmt_vid_cap(struct file *file, void *fh,
679 struct v4l2_format *fmt)
681 struct uvc_fh *handle = fh;
682 struct uvc_streaming *stream = handle->stream;
684 return uvc_v4l2_get_format(stream, fmt);
687 static int uvc_ioctl_g_fmt_vid_out(struct file *file, void *fh,
688 struct v4l2_format *fmt)
690 struct uvc_fh *handle = fh;
691 struct uvc_streaming *stream = handle->stream;
693 return uvc_v4l2_get_format(stream, fmt);
696 static int uvc_ioctl_s_fmt_vid_cap(struct file *file, void *fh,
697 struct v4l2_format *fmt)
699 struct uvc_fh *handle = fh;
700 struct uvc_streaming *stream = handle->stream;
703 ret = uvc_acquire_privileges(handle);
707 return uvc_v4l2_set_format(stream, fmt);
710 static int uvc_ioctl_s_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;
717 ret = uvc_acquire_privileges(handle);
721 return uvc_v4l2_set_format(stream, fmt);
724 static int uvc_ioctl_try_fmt_vid_cap(struct file *file, void *fh,
725 struct v4l2_format *fmt)
727 struct uvc_fh *handle = fh;
728 struct uvc_streaming *stream = handle->stream;
729 struct uvc_streaming_control probe;
731 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
734 static int uvc_ioctl_try_fmt_vid_out(struct file *file, void *fh,
735 struct v4l2_format *fmt)
737 struct uvc_fh *handle = fh;
738 struct uvc_streaming *stream = handle->stream;
739 struct uvc_streaming_control probe;
741 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
744 static int uvc_ioctl_reqbufs(struct file *file, void *fh,
745 struct v4l2_requestbuffers *rb)
747 struct uvc_fh *handle = fh;
748 struct uvc_streaming *stream = handle->stream;
751 ret = uvc_acquire_privileges(handle);
755 mutex_lock(&stream->mutex);
756 ret = uvc_request_buffers(&stream->queue, rb);
757 mutex_unlock(&stream->mutex);
762 uvc_dismiss_privileges(handle);
767 static int uvc_ioctl_querybuf(struct file *file, void *fh,
768 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_query_buffer(&stream->queue, buf);
779 static int uvc_ioctl_qbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
781 struct uvc_fh *handle = fh;
782 struct uvc_streaming *stream = handle->stream;
784 if (!uvc_has_privileges(handle))
787 return uvc_queue_buffer(&stream->queue, buf);
790 static int uvc_ioctl_expbuf(struct file *file, void *fh,
791 struct v4l2_exportbuffer *exp)
793 struct uvc_fh *handle = fh;
794 struct uvc_streaming *stream = handle->stream;
796 if (!uvc_has_privileges(handle))
799 return uvc_export_buffer(&stream->queue, exp);
802 static int uvc_ioctl_dqbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
804 struct uvc_fh *handle = fh;
805 struct uvc_streaming *stream = handle->stream;
807 if (!uvc_has_privileges(handle))
810 return uvc_dequeue_buffer(&stream->queue, buf,
811 file->f_flags & O_NONBLOCK);
814 static int uvc_ioctl_create_bufs(struct file *file, void *fh,
815 struct v4l2_create_buffers *cb)
817 struct uvc_fh *handle = fh;
818 struct uvc_streaming *stream = handle->stream;
821 ret = uvc_acquire_privileges(handle);
825 return uvc_create_buffers(&stream->queue, cb);
828 static int uvc_ioctl_streamon(struct file *file, void *fh,
829 enum v4l2_buf_type type)
831 struct uvc_fh *handle = fh;
832 struct uvc_streaming *stream = handle->stream;
835 if (!uvc_has_privileges(handle))
838 mutex_lock(&stream->mutex);
839 ret = uvc_queue_streamon(&stream->queue, type);
840 mutex_unlock(&stream->mutex);
845 static int uvc_ioctl_streamoff(struct file *file, void *fh,
846 enum v4l2_buf_type type)
848 struct uvc_fh *handle = fh;
849 struct uvc_streaming *stream = handle->stream;
851 if (!uvc_has_privileges(handle))
854 mutex_lock(&stream->mutex);
855 uvc_queue_streamoff(&stream->queue, type);
856 mutex_unlock(&stream->mutex);
861 static int uvc_ioctl_enum_input(struct file *file, void *fh,
862 struct v4l2_input *input)
864 struct uvc_fh *handle = fh;
865 struct uvc_video_chain *chain = handle->chain;
866 const struct uvc_entity *selector = chain->selector;
867 struct uvc_entity *iterm = NULL;
868 u32 index = input->index;
871 if (selector == NULL ||
872 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
875 list_for_each_entry(iterm, &chain->entities, chain) {
876 if (UVC_ENTITY_IS_ITERM(iterm))
880 } else if (index < selector->bNrInPins) {
881 pin = selector->baSourceID[index];
882 list_for_each_entry(iterm, &chain->entities, chain) {
883 if (!UVC_ENTITY_IS_ITERM(iterm))
885 if (iterm->id == pin)
890 if (iterm == NULL || iterm->id != pin)
893 memset(input, 0, sizeof(*input));
894 input->index = index;
895 strlcpy(input->name, iterm->name, sizeof(input->name));
896 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
897 input->type = V4L2_INPUT_TYPE_CAMERA;
902 static int uvc_ioctl_g_input(struct file *file, void *fh, unsigned int *input)
904 struct uvc_fh *handle = fh;
905 struct uvc_video_chain *chain = handle->chain;
909 if (chain->selector == NULL ||
910 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
915 buf = kmalloc(1, GFP_KERNEL);
919 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, chain->selector->id,
920 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
930 static int uvc_ioctl_s_input(struct file *file, void *fh, unsigned int input)
932 struct uvc_fh *handle = fh;
933 struct uvc_video_chain *chain = handle->chain;
937 ret = uvc_acquire_privileges(handle);
941 if (chain->selector == NULL ||
942 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
948 if (input >= chain->selector->bNrInPins)
951 buf = kmalloc(1, GFP_KERNEL);
956 ret = uvc_query_ctrl(chain->dev, UVC_SET_CUR, chain->selector->id,
957 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
964 static int uvc_ioctl_queryctrl(struct file *file, void *fh,
965 struct v4l2_queryctrl *qc)
967 struct uvc_fh *handle = fh;
968 struct uvc_video_chain *chain = handle->chain;
970 return uvc_query_v4l2_ctrl(chain, qc);
973 static int uvc_ioctl_query_ext_ctrl(struct file *file, void *fh,
974 struct v4l2_query_ext_ctrl *qec)
976 struct uvc_fh *handle = fh;
977 struct uvc_video_chain *chain = handle->chain;
978 struct v4l2_queryctrl qc = { qec->id };
981 ret = uvc_query_v4l2_ctrl(chain, &qc);
987 strlcpy(qec->name, qc.name, sizeof(qec->name));
988 qec->minimum = qc.minimum;
989 qec->maximum = qc.maximum;
991 qec->default_value = qc.default_value;
992 qec->flags = qc.flags;
996 memset(qec->dims, 0, sizeof(qec->dims));
997 memset(qec->reserved, 0, sizeof(qec->reserved));
1002 static int uvc_ioctl_g_ctrl(struct file *file, void *fh,
1003 struct v4l2_control *ctrl)
1005 struct uvc_fh *handle = fh;
1006 struct uvc_video_chain *chain = handle->chain;
1007 struct v4l2_ext_control xctrl;
1010 memset(&xctrl, 0, sizeof(xctrl));
1011 xctrl.id = ctrl->id;
1013 ret = uvc_ctrl_begin(chain);
1017 ret = uvc_ctrl_get(chain, &xctrl);
1018 uvc_ctrl_rollback(handle);
1022 ctrl->value = xctrl.value;
1026 static int uvc_ioctl_s_ctrl(struct file *file, void *fh,
1027 struct v4l2_control *ctrl)
1029 struct uvc_fh *handle = fh;
1030 struct uvc_video_chain *chain = handle->chain;
1031 struct v4l2_ext_control xctrl;
1034 memset(&xctrl, 0, sizeof(xctrl));
1035 xctrl.id = ctrl->id;
1036 xctrl.value = ctrl->value;
1038 ret = uvc_ctrl_begin(chain);
1042 ret = uvc_ctrl_set(handle, &xctrl);
1044 uvc_ctrl_rollback(handle);
1048 ret = uvc_ctrl_commit(handle, &xctrl, 1);
1052 ctrl->value = xctrl.value;
1056 static int uvc_ioctl_g_ext_ctrls(struct file *file, void *fh,
1057 struct v4l2_ext_controls *ctrls)
1059 struct uvc_fh *handle = fh;
1060 struct uvc_video_chain *chain = handle->chain;
1061 struct v4l2_ext_control *ctrl = ctrls->controls;
1065 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL) {
1066 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1067 struct v4l2_queryctrl qc = { .id = ctrl->id };
1069 ret = uvc_query_v4l2_ctrl(chain, &qc);
1071 ctrls->error_idx = i;
1075 ctrl->value = qc.default_value;
1081 ret = uvc_ctrl_begin(chain);
1085 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1086 ret = uvc_ctrl_get(chain, ctrl);
1088 uvc_ctrl_rollback(handle);
1089 ctrls->error_idx = i;
1094 ctrls->error_idx = 0;
1096 return uvc_ctrl_rollback(handle);
1099 static int uvc_ioctl_s_try_ext_ctrls(struct uvc_fh *handle,
1100 struct v4l2_ext_controls *ctrls,
1103 struct v4l2_ext_control *ctrl = ctrls->controls;
1104 struct uvc_video_chain *chain = handle->chain;
1108 /* Default value cannot be changed */
1109 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL)
1112 ret = uvc_ctrl_begin(chain);
1116 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1117 ret = uvc_ctrl_set(handle, ctrl);
1119 uvc_ctrl_rollback(handle);
1120 ctrls->error_idx = commit ? ctrls->count : i;
1125 ctrls->error_idx = 0;
1128 return uvc_ctrl_commit(handle, ctrls->controls, ctrls->count);
1130 return uvc_ctrl_rollback(handle);
1133 static int uvc_ioctl_s_ext_ctrls(struct file *file, void *fh,
1134 struct v4l2_ext_controls *ctrls)
1136 struct uvc_fh *handle = fh;
1138 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, true);
1141 static int uvc_ioctl_try_ext_ctrls(struct file *file, void *fh,
1142 struct v4l2_ext_controls *ctrls)
1144 struct uvc_fh *handle = fh;
1146 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, false);
1149 static int uvc_ioctl_querymenu(struct file *file, void *fh,
1150 struct v4l2_querymenu *qm)
1152 struct uvc_fh *handle = fh;
1153 struct uvc_video_chain *chain = handle->chain;
1155 return uvc_query_v4l2_menu(chain, qm);
1158 static int uvc_ioctl_g_selection(struct file *file, void *fh,
1159 struct v4l2_selection *sel)
1161 struct uvc_fh *handle = fh;
1162 struct uvc_streaming *stream = handle->stream;
1164 if (sel->type != stream->type)
1167 switch (sel->target) {
1168 case V4L2_SEL_TGT_CROP_DEFAULT:
1169 case V4L2_SEL_TGT_CROP_BOUNDS:
1170 if (stream->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1173 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
1174 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
1175 if (stream->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
1184 mutex_lock(&stream->mutex);
1185 sel->r.width = stream->cur_frame->wWidth;
1186 sel->r.height = stream->cur_frame->wHeight;
1187 mutex_unlock(&stream->mutex);
1192 static int uvc_ioctl_g_parm(struct file *file, void *fh,
1193 struct v4l2_streamparm *parm)
1195 struct uvc_fh *handle = fh;
1196 struct uvc_streaming *stream = handle->stream;
1198 return uvc_v4l2_get_streamparm(stream, parm);
1201 static int uvc_ioctl_s_parm(struct file *file, void *fh,
1202 struct v4l2_streamparm *parm)
1204 struct uvc_fh *handle = fh;
1205 struct uvc_streaming *stream = handle->stream;
1208 ret = uvc_acquire_privileges(handle);
1212 return uvc_v4l2_set_streamparm(stream, parm);
1215 static int uvc_ioctl_enum_framesizes(struct file *file, void *fh,
1216 struct v4l2_frmsizeenum *fsize)
1218 struct uvc_fh *handle = fh;
1219 struct uvc_streaming *stream = handle->stream;
1220 struct uvc_format *format = NULL;
1221 struct uvc_frame *frame = NULL;
1225 /* Look for the given pixel format */
1226 for (i = 0; i < stream->nformats; i++) {
1227 if (stream->format[i].fcc == fsize->pixel_format) {
1228 format = &stream->format[i];
1235 /* Skip duplicate frame sizes */
1236 for (i = 0, index = 0; i < format->nframes; i++) {
1237 if (frame && frame->wWidth == format->frame[i].wWidth &&
1238 frame->wHeight == format->frame[i].wHeight)
1240 frame = &format->frame[i];
1241 if (index == fsize->index)
1246 if (i == format->nframes)
1249 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1250 fsize->discrete.width = frame->wWidth;
1251 fsize->discrete.height = frame->wHeight;
1255 static int uvc_ioctl_enum_frameintervals(struct file *file, void *fh,
1256 struct v4l2_frmivalenum *fival)
1258 struct uvc_fh *handle = fh;
1259 struct uvc_streaming *stream = handle->stream;
1260 struct uvc_format *format = NULL;
1261 struct uvc_frame *frame = NULL;
1262 unsigned int nintervals;
1266 /* Look for the given pixel format and frame size */
1267 for (i = 0; i < stream->nformats; i++) {
1268 if (stream->format[i].fcc == fival->pixel_format) {
1269 format = &stream->format[i];
1276 index = fival->index;
1277 for (i = 0; i < format->nframes; i++) {
1278 if (format->frame[i].wWidth == fival->width &&
1279 format->frame[i].wHeight == fival->height) {
1280 frame = &format->frame[i];
1281 nintervals = frame->bFrameIntervalType ?: 1;
1282 if (index < nintervals)
1284 index -= nintervals;
1287 if (i == format->nframes)
1290 if (frame->bFrameIntervalType) {
1291 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
1292 fival->discrete.numerator =
1293 frame->dwFrameInterval[index];
1294 fival->discrete.denominator = 10000000;
1295 uvc_simplify_fraction(&fival->discrete.numerator,
1296 &fival->discrete.denominator, 8, 333);
1298 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
1299 fival->stepwise.min.numerator = frame->dwFrameInterval[0];
1300 fival->stepwise.min.denominator = 10000000;
1301 fival->stepwise.max.numerator = frame->dwFrameInterval[1];
1302 fival->stepwise.max.denominator = 10000000;
1303 fival->stepwise.step.numerator = frame->dwFrameInterval[2];
1304 fival->stepwise.step.denominator = 10000000;
1305 uvc_simplify_fraction(&fival->stepwise.min.numerator,
1306 &fival->stepwise.min.denominator, 8, 333);
1307 uvc_simplify_fraction(&fival->stepwise.max.numerator,
1308 &fival->stepwise.max.denominator, 8, 333);
1309 uvc_simplify_fraction(&fival->stepwise.step.numerator,
1310 &fival->stepwise.step.denominator, 8, 333);
1316 static int uvc_ioctl_subscribe_event(struct v4l2_fh *fh,
1317 const struct v4l2_event_subscription *sub)
1319 switch (sub->type) {
1320 case V4L2_EVENT_CTRL:
1321 return v4l2_event_subscribe(fh, sub, 0, &uvc_ctrl_sub_ev_ops);
1327 static long uvc_ioctl_default(struct file *file, void *fh, bool valid_prio,
1328 unsigned int cmd, void *arg)
1330 struct uvc_fh *handle = fh;
1331 struct uvc_video_chain *chain = handle->chain;
1334 /* Dynamic controls. */
1335 case UVCIOC_CTRL_MAP:
1336 return uvc_ioctl_ctrl_map(chain, arg);
1338 case UVCIOC_CTRL_QUERY:
1339 return uvc_xu_ctrl_query(chain, arg);
1346 #ifdef CONFIG_COMPAT
1347 struct uvc_xu_control_mapping32 {
1358 compat_caddr_t menu_info;
1364 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1365 const struct uvc_xu_control_mapping32 __user *up)
1367 struct uvc_xu_control_mapping32 *p = (void *)kp;
1368 compat_caddr_t info;
1371 if (copy_from_user(p, up, sizeof(*p)))
1374 count = p->menu_count;
1375 info = p->menu_info;
1377 memset(kp->reserved, 0, sizeof(kp->reserved));
1378 kp->menu_info = count ? compat_ptr(info) : NULL;
1379 kp->menu_count = count;
1383 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1384 struct uvc_xu_control_mapping32 __user *up)
1386 if (copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1387 put_user(kp->menu_count, &up->menu_count))
1390 if (clear_user(up->reserved, sizeof(up->reserved)))
1396 struct uvc_xu_control_query32 {
1401 compat_caddr_t data;
1404 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1405 const struct uvc_xu_control_query32 __user *up)
1407 struct uvc_xu_control_query32 v;
1409 if (copy_from_user(&v, up, sizeof(v)))
1412 *kp = (struct uvc_xu_control_query){
1414 .selector = v.selector,
1417 .data = v.size ? compat_ptr(v.data) : NULL
1422 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1423 struct uvc_xu_control_query32 __user *up)
1425 if (copy_to_user(up, kp, offsetof(typeof(*up), data)))
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 __poll_t 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,