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 fmt->fmt.pix.width = frame->wWidth;
256 fmt->fmt.pix.height = frame->wHeight;
257 fmt->fmt.pix.field = V4L2_FIELD_NONE;
258 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
259 fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
260 fmt->fmt.pix.colorspace = format->colorspace;
261 fmt->fmt.pix.priv = 0;
263 if (uvc_format != NULL)
264 *uvc_format = format;
265 if (uvc_frame != NULL)
272 static int uvc_v4l2_get_format(struct uvc_streaming *stream,
273 struct v4l2_format *fmt)
275 struct uvc_format *format;
276 struct uvc_frame *frame;
279 if (fmt->type != stream->type)
282 mutex_lock(&stream->mutex);
283 format = stream->cur_format;
284 frame = stream->cur_frame;
286 if (format == NULL || frame == NULL) {
291 fmt->fmt.pix.pixelformat = format->fcc;
292 fmt->fmt.pix.width = frame->wWidth;
293 fmt->fmt.pix.height = frame->wHeight;
294 fmt->fmt.pix.field = V4L2_FIELD_NONE;
295 fmt->fmt.pix.bytesperline = uvc_v4l2_get_bytesperline(format, frame);
296 fmt->fmt.pix.sizeimage = stream->ctrl.dwMaxVideoFrameSize;
297 fmt->fmt.pix.colorspace = format->colorspace;
298 fmt->fmt.pix.priv = 0;
301 mutex_unlock(&stream->mutex);
305 static int uvc_v4l2_set_format(struct uvc_streaming *stream,
306 struct v4l2_format *fmt)
308 struct uvc_streaming_control probe;
309 struct uvc_format *format;
310 struct uvc_frame *frame;
313 if (fmt->type != stream->type)
316 ret = uvc_v4l2_try_format(stream, fmt, &probe, &format, &frame);
320 mutex_lock(&stream->mutex);
322 if (uvc_queue_allocated(&stream->queue)) {
327 stream->ctrl = probe;
328 stream->cur_format = format;
329 stream->cur_frame = frame;
332 mutex_unlock(&stream->mutex);
336 static int uvc_v4l2_get_streamparm(struct uvc_streaming *stream,
337 struct v4l2_streamparm *parm)
339 uint32_t numerator, denominator;
341 if (parm->type != stream->type)
344 mutex_lock(&stream->mutex);
345 numerator = stream->ctrl.dwFrameInterval;
346 mutex_unlock(&stream->mutex);
348 denominator = 10000000;
349 uvc_simplify_fraction(&numerator, &denominator, 8, 333);
351 memset(parm, 0, sizeof *parm);
352 parm->type = stream->type;
354 if (stream->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
355 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
356 parm->parm.capture.capturemode = 0;
357 parm->parm.capture.timeperframe.numerator = numerator;
358 parm->parm.capture.timeperframe.denominator = denominator;
359 parm->parm.capture.extendedmode = 0;
360 parm->parm.capture.readbuffers = 0;
362 parm->parm.output.capability = V4L2_CAP_TIMEPERFRAME;
363 parm->parm.output.outputmode = 0;
364 parm->parm.output.timeperframe.numerator = numerator;
365 parm->parm.output.timeperframe.denominator = denominator;
371 static int uvc_v4l2_set_streamparm(struct uvc_streaming *stream,
372 struct v4l2_streamparm *parm)
374 struct uvc_streaming_control probe;
375 struct v4l2_fract timeperframe;
379 if (parm->type != stream->type)
382 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
383 timeperframe = parm->parm.capture.timeperframe;
385 timeperframe = parm->parm.output.timeperframe;
387 interval = uvc_fraction_to_interval(timeperframe.numerator,
388 timeperframe.denominator);
389 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
390 timeperframe.numerator, timeperframe.denominator, interval);
392 mutex_lock(&stream->mutex);
394 if (uvc_queue_streaming(&stream->queue)) {
395 mutex_unlock(&stream->mutex);
399 probe = stream->ctrl;
400 probe.dwFrameInterval =
401 uvc_try_frame_interval(stream->cur_frame, interval);
403 /* Probe the device with the new settings. */
404 ret = uvc_probe_video(stream, &probe);
406 mutex_unlock(&stream->mutex);
410 stream->ctrl = probe;
411 mutex_unlock(&stream->mutex);
413 /* Return the actual frame period. */
414 timeperframe.numerator = probe.dwFrameInterval;
415 timeperframe.denominator = 10000000;
416 uvc_simplify_fraction(&timeperframe.numerator,
417 &timeperframe.denominator, 8, 333);
419 if (parm->type == V4L2_BUF_TYPE_VIDEO_CAPTURE)
420 parm->parm.capture.timeperframe = timeperframe;
422 parm->parm.output.timeperframe = timeperframe;
427 /* ------------------------------------------------------------------------
428 * Privilege management
432 * Privilege management is the multiple-open implementation basis. The current
433 * implementation is completely transparent for the end-user and doesn't
434 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
435 * Those ioctls enable finer control on the device (by making possible for a
436 * user to request exclusive access to a device), but are not mature yet.
437 * Switching to the V4L2 priority mechanism might be considered in the future
438 * if this situation changes.
440 * Each open instance of a UVC device can either be in a privileged or
441 * unprivileged state. Only a single instance can be in a privileged state at
442 * a given time. Trying to perform an operation that requires privileges will
443 * automatically acquire the required privileges if possible, or return -EBUSY
444 * otherwise. Privileges are dismissed when closing the instance or when
445 * freeing the video buffers using VIDIOC_REQBUFS.
447 * Operations that require privileges are:
454 static int uvc_acquire_privileges(struct uvc_fh *handle)
456 /* Always succeed if the handle is already privileged. */
457 if (handle->state == UVC_HANDLE_ACTIVE)
460 /* Check if the device already has a privileged handle. */
461 if (atomic_inc_return(&handle->stream->active) != 1) {
462 atomic_dec(&handle->stream->active);
466 handle->state = UVC_HANDLE_ACTIVE;
470 static void uvc_dismiss_privileges(struct uvc_fh *handle)
472 if (handle->state == UVC_HANDLE_ACTIVE)
473 atomic_dec(&handle->stream->active);
475 handle->state = UVC_HANDLE_PASSIVE;
478 static int uvc_has_privileges(struct uvc_fh *handle)
480 return handle->state == UVC_HANDLE_ACTIVE;
483 /* ------------------------------------------------------------------------
484 * V4L2 file operations
487 static int uvc_v4l2_open(struct file *file)
489 struct uvc_streaming *stream;
490 struct uvc_fh *handle;
493 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
494 stream = video_drvdata(file);
496 ret = usb_autopm_get_interface(stream->dev->intf);
500 /* Create the device handle. */
501 handle = kzalloc(sizeof *handle, GFP_KERNEL);
502 if (handle == NULL) {
503 usb_autopm_put_interface(stream->dev->intf);
507 mutex_lock(&stream->dev->lock);
508 if (stream->dev->users == 0) {
509 ret = uvc_status_start(stream->dev, GFP_KERNEL);
511 mutex_unlock(&stream->dev->lock);
512 usb_autopm_put_interface(stream->dev->intf);
518 stream->dev->users++;
519 mutex_unlock(&stream->dev->lock);
521 v4l2_fh_init(&handle->vfh, &stream->vdev);
522 v4l2_fh_add(&handle->vfh);
523 handle->chain = stream->chain;
524 handle->stream = stream;
525 handle->state = UVC_HANDLE_PASSIVE;
526 file->private_data = handle;
531 static int uvc_v4l2_release(struct file *file)
533 struct uvc_fh *handle = file->private_data;
534 struct uvc_streaming *stream = handle->stream;
536 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
538 /* Only free resources if this is a privileged handle. */
539 if (uvc_has_privileges(handle))
540 uvc_queue_release(&stream->queue);
542 /* Release the file handle. */
543 uvc_dismiss_privileges(handle);
544 v4l2_fh_del(&handle->vfh);
545 v4l2_fh_exit(&handle->vfh);
547 file->private_data = NULL;
549 mutex_lock(&stream->dev->lock);
550 if (--stream->dev->users == 0)
551 uvc_status_stop(stream->dev);
552 mutex_unlock(&stream->dev->lock);
554 usb_autopm_put_interface(stream->dev->intf);
558 static int uvc_ioctl_querycap(struct file *file, void *fh,
559 struct v4l2_capability *cap)
561 struct video_device *vdev = video_devdata(file);
562 struct uvc_fh *handle = file->private_data;
563 struct uvc_video_chain *chain = handle->chain;
564 struct uvc_streaming *stream = handle->stream;
566 strlcpy(cap->driver, "uvcvideo", sizeof(cap->driver));
567 strlcpy(cap->card, vdev->name, sizeof(cap->card));
568 usb_make_path(stream->dev->udev, cap->bus_info, sizeof(cap->bus_info));
569 cap->capabilities = V4L2_CAP_DEVICE_CAPS | V4L2_CAP_STREAMING
575 static int uvc_ioctl_enum_fmt(struct uvc_streaming *stream,
576 struct v4l2_fmtdesc *fmt)
578 struct uvc_format *format;
579 enum v4l2_buf_type type = fmt->type;
580 __u32 index = fmt->index;
582 if (fmt->type != stream->type || fmt->index >= stream->nformats)
585 memset(fmt, 0, sizeof(*fmt));
589 format = &stream->format[fmt->index];
591 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
592 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
593 strlcpy(fmt->description, format->name, sizeof(fmt->description));
594 fmt->description[sizeof(fmt->description) - 1] = 0;
595 fmt->pixelformat = format->fcc;
599 static int uvc_ioctl_enum_fmt_vid_cap(struct file *file, void *fh,
600 struct v4l2_fmtdesc *fmt)
602 struct uvc_fh *handle = fh;
603 struct uvc_streaming *stream = handle->stream;
605 return uvc_ioctl_enum_fmt(stream, fmt);
608 static int uvc_ioctl_enum_fmt_vid_out(struct file *file, void *fh,
609 struct v4l2_fmtdesc *fmt)
611 struct uvc_fh *handle = fh;
612 struct uvc_streaming *stream = handle->stream;
614 return uvc_ioctl_enum_fmt(stream, fmt);
617 static int uvc_ioctl_g_fmt_vid_cap(struct file *file, void *fh,
618 struct v4l2_format *fmt)
620 struct uvc_fh *handle = fh;
621 struct uvc_streaming *stream = handle->stream;
623 return uvc_v4l2_get_format(stream, fmt);
626 static int uvc_ioctl_g_fmt_vid_out(struct file *file, void *fh,
627 struct v4l2_format *fmt)
629 struct uvc_fh *handle = fh;
630 struct uvc_streaming *stream = handle->stream;
632 return uvc_v4l2_get_format(stream, fmt);
635 static int uvc_ioctl_s_fmt_vid_cap(struct file *file, void *fh,
636 struct v4l2_format *fmt)
638 struct uvc_fh *handle = fh;
639 struct uvc_streaming *stream = handle->stream;
642 ret = uvc_acquire_privileges(handle);
646 return uvc_v4l2_set_format(stream, fmt);
649 static int uvc_ioctl_s_fmt_vid_out(struct file *file, void *fh,
650 struct v4l2_format *fmt)
652 struct uvc_fh *handle = fh;
653 struct uvc_streaming *stream = handle->stream;
656 ret = uvc_acquire_privileges(handle);
660 return uvc_v4l2_set_format(stream, fmt);
663 static int uvc_ioctl_try_fmt_vid_cap(struct file *file, void *fh,
664 struct v4l2_format *fmt)
666 struct uvc_fh *handle = fh;
667 struct uvc_streaming *stream = handle->stream;
668 struct uvc_streaming_control probe;
670 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
673 static int uvc_ioctl_try_fmt_vid_out(struct file *file, void *fh,
674 struct v4l2_format *fmt)
676 struct uvc_fh *handle = fh;
677 struct uvc_streaming *stream = handle->stream;
678 struct uvc_streaming_control probe;
680 return uvc_v4l2_try_format(stream, fmt, &probe, NULL, NULL);
683 static int uvc_ioctl_reqbufs(struct file *file, void *fh,
684 struct v4l2_requestbuffers *rb)
686 struct uvc_fh *handle = fh;
687 struct uvc_streaming *stream = handle->stream;
690 ret = uvc_acquire_privileges(handle);
694 mutex_lock(&stream->mutex);
695 ret = uvc_request_buffers(&stream->queue, rb);
696 mutex_unlock(&stream->mutex);
701 uvc_dismiss_privileges(handle);
706 static int uvc_ioctl_querybuf(struct file *file, void *fh,
707 struct v4l2_buffer *buf)
709 struct uvc_fh *handle = fh;
710 struct uvc_streaming *stream = handle->stream;
712 if (!uvc_has_privileges(handle))
715 return uvc_query_buffer(&stream->queue, buf);
718 static int uvc_ioctl_qbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
720 struct uvc_fh *handle = fh;
721 struct uvc_streaming *stream = handle->stream;
723 if (!uvc_has_privileges(handle))
726 return uvc_queue_buffer(&stream->queue, buf);
729 static int uvc_ioctl_expbuf(struct file *file, void *fh,
730 struct v4l2_exportbuffer *exp)
732 struct uvc_fh *handle = fh;
733 struct uvc_streaming *stream = handle->stream;
735 if (!uvc_has_privileges(handle))
738 return uvc_export_buffer(&stream->queue, exp);
741 static int uvc_ioctl_dqbuf(struct file *file, void *fh, struct v4l2_buffer *buf)
743 struct uvc_fh *handle = fh;
744 struct uvc_streaming *stream = handle->stream;
746 if (!uvc_has_privileges(handle))
749 return uvc_dequeue_buffer(&stream->queue, buf,
750 file->f_flags & O_NONBLOCK);
753 static int uvc_ioctl_create_bufs(struct file *file, void *fh,
754 struct v4l2_create_buffers *cb)
756 struct uvc_fh *handle = fh;
757 struct uvc_streaming *stream = handle->stream;
760 ret = uvc_acquire_privileges(handle);
764 return uvc_create_buffers(&stream->queue, cb);
767 static int uvc_ioctl_streamon(struct file *file, void *fh,
768 enum v4l2_buf_type type)
770 struct uvc_fh *handle = fh;
771 struct uvc_streaming *stream = handle->stream;
774 if (!uvc_has_privileges(handle))
777 mutex_lock(&stream->mutex);
778 ret = uvc_queue_streamon(&stream->queue, type);
779 mutex_unlock(&stream->mutex);
784 static int uvc_ioctl_streamoff(struct file *file, void *fh,
785 enum v4l2_buf_type type)
787 struct uvc_fh *handle = fh;
788 struct uvc_streaming *stream = handle->stream;
790 if (!uvc_has_privileges(handle))
793 mutex_lock(&stream->mutex);
794 uvc_queue_streamoff(&stream->queue, type);
795 mutex_unlock(&stream->mutex);
800 static int uvc_ioctl_enum_input(struct file *file, void *fh,
801 struct v4l2_input *input)
803 struct uvc_fh *handle = fh;
804 struct uvc_video_chain *chain = handle->chain;
805 const struct uvc_entity *selector = chain->selector;
806 struct uvc_entity *iterm = NULL;
807 u32 index = input->index;
810 if (selector == NULL ||
811 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
814 list_for_each_entry(iterm, &chain->entities, chain) {
815 if (UVC_ENTITY_IS_ITERM(iterm))
819 } else if (index < selector->bNrInPins) {
820 pin = selector->baSourceID[index];
821 list_for_each_entry(iterm, &chain->entities, chain) {
822 if (!UVC_ENTITY_IS_ITERM(iterm))
824 if (iterm->id == pin)
829 if (iterm == NULL || iterm->id != pin)
832 memset(input, 0, sizeof(*input));
833 input->index = index;
834 strlcpy(input->name, iterm->name, sizeof(input->name));
835 if (UVC_ENTITY_TYPE(iterm) == UVC_ITT_CAMERA)
836 input->type = V4L2_INPUT_TYPE_CAMERA;
841 static int uvc_ioctl_g_input(struct file *file, void *fh, unsigned int *input)
843 struct uvc_fh *handle = fh;
844 struct uvc_video_chain *chain = handle->chain;
848 if (chain->selector == NULL ||
849 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
854 ret = uvc_query_ctrl(chain->dev, UVC_GET_CUR, chain->selector->id,
855 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
864 static int uvc_ioctl_s_input(struct file *file, void *fh, unsigned int input)
866 struct uvc_fh *handle = fh;
867 struct uvc_video_chain *chain = handle->chain;
871 ret = uvc_acquire_privileges(handle);
875 if (chain->selector == NULL ||
876 (chain->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
882 if (input >= chain->selector->bNrInPins)
886 return uvc_query_ctrl(chain->dev, UVC_SET_CUR, chain->selector->id,
887 chain->dev->intfnum, UVC_SU_INPUT_SELECT_CONTROL,
891 static int uvc_ioctl_queryctrl(struct file *file, void *fh,
892 struct v4l2_queryctrl *qc)
894 struct uvc_fh *handle = fh;
895 struct uvc_video_chain *chain = handle->chain;
897 return uvc_query_v4l2_ctrl(chain, qc);
900 static int uvc_ioctl_query_ext_ctrl(struct file *file, void *fh,
901 struct v4l2_query_ext_ctrl *qec)
903 struct uvc_fh *handle = fh;
904 struct uvc_video_chain *chain = handle->chain;
905 struct v4l2_queryctrl qc = { qec->id };
908 ret = uvc_query_v4l2_ctrl(chain, &qc);
914 strlcpy(qec->name, qc.name, sizeof(qec->name));
915 qec->minimum = qc.minimum;
916 qec->maximum = qc.maximum;
918 qec->default_value = qc.default_value;
919 qec->flags = qc.flags;
923 memset(qec->dims, 0, sizeof(qec->dims));
924 memset(qec->reserved, 0, sizeof(qec->reserved));
929 static int uvc_ioctl_g_ctrl(struct file *file, void *fh,
930 struct v4l2_control *ctrl)
932 struct uvc_fh *handle = fh;
933 struct uvc_video_chain *chain = handle->chain;
934 struct v4l2_ext_control xctrl;
937 memset(&xctrl, 0, sizeof(xctrl));
940 ret = uvc_ctrl_begin(chain);
944 ret = uvc_ctrl_get(chain, &xctrl);
945 uvc_ctrl_rollback(handle);
949 ctrl->value = xctrl.value;
953 static int uvc_ioctl_s_ctrl(struct file *file, void *fh,
954 struct v4l2_control *ctrl)
956 struct uvc_fh *handle = fh;
957 struct uvc_video_chain *chain = handle->chain;
958 struct v4l2_ext_control xctrl;
961 memset(&xctrl, 0, sizeof(xctrl));
963 xctrl.value = ctrl->value;
965 ret = uvc_ctrl_begin(chain);
969 ret = uvc_ctrl_set(chain, &xctrl);
971 uvc_ctrl_rollback(handle);
975 ret = uvc_ctrl_commit(handle, &xctrl, 1);
979 ctrl->value = xctrl.value;
983 static int uvc_ioctl_g_ext_ctrls(struct file *file, void *fh,
984 struct v4l2_ext_controls *ctrls)
986 struct uvc_fh *handle = fh;
987 struct uvc_video_chain *chain = handle->chain;
988 struct v4l2_ext_control *ctrl = ctrls->controls;
992 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL) {
993 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
994 struct v4l2_queryctrl qc = { .id = ctrl->id };
996 ret = uvc_query_v4l2_ctrl(chain, &qc);
998 ctrls->error_idx = i;
1002 ctrl->value = qc.default_value;
1008 ret = uvc_ctrl_begin(chain);
1012 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1013 ret = uvc_ctrl_get(chain, ctrl);
1015 uvc_ctrl_rollback(handle);
1016 ctrls->error_idx = i;
1021 ctrls->error_idx = 0;
1023 return uvc_ctrl_rollback(handle);
1026 static int uvc_ioctl_s_try_ext_ctrls(struct uvc_fh *handle,
1027 struct v4l2_ext_controls *ctrls,
1030 struct v4l2_ext_control *ctrl = ctrls->controls;
1031 struct uvc_video_chain *chain = handle->chain;
1035 /* Default value cannot be changed */
1036 if (ctrls->which == V4L2_CTRL_WHICH_DEF_VAL)
1039 ret = uvc_ctrl_begin(chain);
1043 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
1044 ret = uvc_ctrl_set(chain, ctrl);
1046 uvc_ctrl_rollback(handle);
1047 ctrls->error_idx = commit ? ctrls->count : i;
1052 ctrls->error_idx = 0;
1055 return uvc_ctrl_commit(handle, ctrls->controls, ctrls->count);
1057 return uvc_ctrl_rollback(handle);
1060 static int uvc_ioctl_s_ext_ctrls(struct file *file, void *fh,
1061 struct v4l2_ext_controls *ctrls)
1063 struct uvc_fh *handle = fh;
1065 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, true);
1068 static int uvc_ioctl_try_ext_ctrls(struct file *file, void *fh,
1069 struct v4l2_ext_controls *ctrls)
1071 struct uvc_fh *handle = fh;
1073 return uvc_ioctl_s_try_ext_ctrls(handle, ctrls, false);
1076 static int uvc_ioctl_querymenu(struct file *file, void *fh,
1077 struct v4l2_querymenu *qm)
1079 struct uvc_fh *handle = fh;
1080 struct uvc_video_chain *chain = handle->chain;
1082 return uvc_query_v4l2_menu(chain, qm);
1085 static int uvc_ioctl_g_selection(struct file *file, void *fh,
1086 struct v4l2_selection *sel)
1088 struct uvc_fh *handle = fh;
1089 struct uvc_streaming *stream = handle->stream;
1091 if (sel->type != stream->type)
1094 switch (sel->target) {
1095 case V4L2_SEL_TGT_CROP_DEFAULT:
1096 case V4L2_SEL_TGT_CROP_BOUNDS:
1097 if (stream->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1100 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
1101 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
1102 if (stream->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
1111 mutex_lock(&stream->mutex);
1112 sel->r.width = stream->cur_frame->wWidth;
1113 sel->r.height = stream->cur_frame->wHeight;
1114 mutex_unlock(&stream->mutex);
1119 static int uvc_ioctl_g_parm(struct file *file, void *fh,
1120 struct v4l2_streamparm *parm)
1122 struct uvc_fh *handle = fh;
1123 struct uvc_streaming *stream = handle->stream;
1125 return uvc_v4l2_get_streamparm(stream, parm);
1128 static int uvc_ioctl_s_parm(struct file *file, void *fh,
1129 struct v4l2_streamparm *parm)
1131 struct uvc_fh *handle = fh;
1132 struct uvc_streaming *stream = handle->stream;
1135 ret = uvc_acquire_privileges(handle);
1139 return uvc_v4l2_set_streamparm(stream, parm);
1142 static int uvc_ioctl_enum_framesizes(struct file *file, void *fh,
1143 struct v4l2_frmsizeenum *fsize)
1145 struct uvc_fh *handle = fh;
1146 struct uvc_streaming *stream = handle->stream;
1147 struct uvc_format *format = NULL;
1148 struct uvc_frame *frame;
1151 /* Look for the given pixel format */
1152 for (i = 0; i < stream->nformats; i++) {
1153 if (stream->format[i].fcc == fsize->pixel_format) {
1154 format = &stream->format[i];
1161 if (fsize->index >= format->nframes)
1164 frame = &format->frame[fsize->index];
1165 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1166 fsize->discrete.width = frame->wWidth;
1167 fsize->discrete.height = frame->wHeight;
1171 static int uvc_ioctl_enum_frameintervals(struct file *file, void *fh,
1172 struct v4l2_frmivalenum *fival)
1174 struct uvc_fh *handle = fh;
1175 struct uvc_streaming *stream = handle->stream;
1176 struct uvc_format *format = NULL;
1177 struct uvc_frame *frame = NULL;
1180 /* Look for the given pixel format and frame size */
1181 for (i = 0; i < stream->nformats; i++) {
1182 if (stream->format[i].fcc == fival->pixel_format) {
1183 format = &stream->format[i];
1190 for (i = 0; i < format->nframes; i++) {
1191 if (format->frame[i].wWidth == fival->width &&
1192 format->frame[i].wHeight == fival->height) {
1193 frame = &format->frame[i];
1200 if (frame->bFrameIntervalType) {
1201 if (fival->index >= frame->bFrameIntervalType)
1204 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
1205 fival->discrete.numerator =
1206 frame->dwFrameInterval[fival->index];
1207 fival->discrete.denominator = 10000000;
1208 uvc_simplify_fraction(&fival->discrete.numerator,
1209 &fival->discrete.denominator, 8, 333);
1214 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
1215 fival->stepwise.min.numerator = frame->dwFrameInterval[0];
1216 fival->stepwise.min.denominator = 10000000;
1217 fival->stepwise.max.numerator = frame->dwFrameInterval[1];
1218 fival->stepwise.max.denominator = 10000000;
1219 fival->stepwise.step.numerator = frame->dwFrameInterval[2];
1220 fival->stepwise.step.denominator = 10000000;
1221 uvc_simplify_fraction(&fival->stepwise.min.numerator,
1222 &fival->stepwise.min.denominator, 8, 333);
1223 uvc_simplify_fraction(&fival->stepwise.max.numerator,
1224 &fival->stepwise.max.denominator, 8, 333);
1225 uvc_simplify_fraction(&fival->stepwise.step.numerator,
1226 &fival->stepwise.step.denominator, 8, 333);
1232 static int uvc_ioctl_subscribe_event(struct v4l2_fh *fh,
1233 const struct v4l2_event_subscription *sub)
1235 switch (sub->type) {
1236 case V4L2_EVENT_CTRL:
1237 return v4l2_event_subscribe(fh, sub, 0, &uvc_ctrl_sub_ev_ops);
1243 static long uvc_ioctl_default(struct file *file, void *fh, bool valid_prio,
1244 unsigned int cmd, void *arg)
1246 struct uvc_fh *handle = fh;
1247 struct uvc_video_chain *chain = handle->chain;
1250 /* Dynamic controls. */
1251 case UVCIOC_CTRL_MAP:
1252 return uvc_ioctl_ctrl_map(chain, arg);
1254 case UVCIOC_CTRL_QUERY:
1255 return uvc_xu_ctrl_query(chain, arg);
1262 #ifdef CONFIG_COMPAT
1263 struct uvc_xu_control_mapping32 {
1274 compat_caddr_t menu_info;
1280 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping *kp,
1281 const struct uvc_xu_control_mapping32 __user *up)
1283 struct uvc_xu_control_mapping32 *p = (void *)kp;
1284 compat_caddr_t info;
1287 if (copy_from_user(p, up, sizeof(*p)))
1290 count = p->menu_count;
1291 info = p->menu_info;
1293 memset(kp->reserved, 0, sizeof(kp->reserved));
1294 kp->menu_info = count ? compat_ptr(info) : NULL;
1295 kp->menu_count = count;
1299 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping *kp,
1300 struct uvc_xu_control_mapping32 __user *up)
1302 if (copy_to_user(up, kp, offsetof(typeof(*up), menu_info)) ||
1303 put_user(kp->menu_count, &up->menu_count))
1306 if (clear_user(up->reserved, sizeof(up->reserved)))
1312 struct uvc_xu_control_query32 {
1317 compat_caddr_t data;
1320 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query *kp,
1321 const struct uvc_xu_control_query32 __user *up)
1323 struct uvc_xu_control_query32 v;
1325 if (copy_from_user(&v, up, sizeof(v)))
1328 *kp = (struct uvc_xu_control_query){
1330 .selector = v.selector,
1333 .data = v.size ? compat_ptr(v.data) : NULL
1338 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query *kp,
1339 struct uvc_xu_control_query32 __user *up)
1341 if (copy_to_user(up, kp, offsetof(typeof(*up), data)))
1346 #define UVCIOC_CTRL_MAP32 _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1347 #define UVCIOC_CTRL_QUERY32 _IOWR('u', 0x21, struct uvc_xu_control_query32)
1349 static long uvc_v4l2_compat_ioctl32(struct file *file,
1350 unsigned int cmd, unsigned long arg)
1352 struct uvc_fh *handle = file->private_data;
1354 struct uvc_xu_control_mapping xmap;
1355 struct uvc_xu_control_query xqry;
1357 void __user *up = compat_ptr(arg);
1361 case UVCIOC_CTRL_MAP32:
1362 ret = uvc_v4l2_get_xu_mapping(&karg.xmap, up);
1365 ret = uvc_ioctl_ctrl_map(handle->chain, &karg.xmap);
1368 ret = uvc_v4l2_put_xu_mapping(&karg.xmap, up);
1374 case UVCIOC_CTRL_QUERY32:
1375 ret = uvc_v4l2_get_xu_query(&karg.xqry, up);
1378 ret = uvc_xu_ctrl_query(handle->chain, &karg.xqry);
1381 ret = uvc_v4l2_put_xu_query(&karg.xqry, up);
1387 return -ENOIOCTLCMD;
1394 static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
1395 size_t count, loff_t *ppos)
1397 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1401 static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1403 struct uvc_fh *handle = file->private_data;
1404 struct uvc_streaming *stream = handle->stream;
1406 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1408 return uvc_queue_mmap(&stream->queue, vma);
1411 static __poll_t uvc_v4l2_poll(struct file *file, poll_table *wait)
1413 struct uvc_fh *handle = file->private_data;
1414 struct uvc_streaming *stream = handle->stream;
1416 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1418 return uvc_queue_poll(&stream->queue, file, wait);
1422 static unsigned long uvc_v4l2_get_unmapped_area(struct file *file,
1423 unsigned long addr, unsigned long len, unsigned long pgoff,
1424 unsigned long flags)
1426 struct uvc_fh *handle = file->private_data;
1427 struct uvc_streaming *stream = handle->stream;
1429 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_get_unmapped_area\n");
1431 return uvc_queue_get_unmapped_area(&stream->queue, pgoff);
1435 const struct v4l2_ioctl_ops uvc_ioctl_ops = {
1436 .vidioc_querycap = uvc_ioctl_querycap,
1437 .vidioc_enum_fmt_vid_cap = uvc_ioctl_enum_fmt_vid_cap,
1438 .vidioc_enum_fmt_vid_out = uvc_ioctl_enum_fmt_vid_out,
1439 .vidioc_g_fmt_vid_cap = uvc_ioctl_g_fmt_vid_cap,
1440 .vidioc_g_fmt_vid_out = uvc_ioctl_g_fmt_vid_out,
1441 .vidioc_s_fmt_vid_cap = uvc_ioctl_s_fmt_vid_cap,
1442 .vidioc_s_fmt_vid_out = uvc_ioctl_s_fmt_vid_out,
1443 .vidioc_try_fmt_vid_cap = uvc_ioctl_try_fmt_vid_cap,
1444 .vidioc_try_fmt_vid_out = uvc_ioctl_try_fmt_vid_out,
1445 .vidioc_reqbufs = uvc_ioctl_reqbufs,
1446 .vidioc_querybuf = uvc_ioctl_querybuf,
1447 .vidioc_qbuf = uvc_ioctl_qbuf,
1448 .vidioc_expbuf = uvc_ioctl_expbuf,
1449 .vidioc_dqbuf = uvc_ioctl_dqbuf,
1450 .vidioc_create_bufs = uvc_ioctl_create_bufs,
1451 .vidioc_streamon = uvc_ioctl_streamon,
1452 .vidioc_streamoff = uvc_ioctl_streamoff,
1453 .vidioc_enum_input = uvc_ioctl_enum_input,
1454 .vidioc_g_input = uvc_ioctl_g_input,
1455 .vidioc_s_input = uvc_ioctl_s_input,
1456 .vidioc_queryctrl = uvc_ioctl_queryctrl,
1457 .vidioc_query_ext_ctrl = uvc_ioctl_query_ext_ctrl,
1458 .vidioc_g_ctrl = uvc_ioctl_g_ctrl,
1459 .vidioc_s_ctrl = uvc_ioctl_s_ctrl,
1460 .vidioc_g_ext_ctrls = uvc_ioctl_g_ext_ctrls,
1461 .vidioc_s_ext_ctrls = uvc_ioctl_s_ext_ctrls,
1462 .vidioc_try_ext_ctrls = uvc_ioctl_try_ext_ctrls,
1463 .vidioc_querymenu = uvc_ioctl_querymenu,
1464 .vidioc_g_selection = uvc_ioctl_g_selection,
1465 .vidioc_g_parm = uvc_ioctl_g_parm,
1466 .vidioc_s_parm = uvc_ioctl_s_parm,
1467 .vidioc_enum_framesizes = uvc_ioctl_enum_framesizes,
1468 .vidioc_enum_frameintervals = uvc_ioctl_enum_frameintervals,
1469 .vidioc_subscribe_event = uvc_ioctl_subscribe_event,
1470 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1471 .vidioc_default = uvc_ioctl_default,
1474 const struct v4l2_file_operations uvc_fops = {
1475 .owner = THIS_MODULE,
1476 .open = uvc_v4l2_open,
1477 .release = uvc_v4l2_release,
1478 .unlocked_ioctl = video_ioctl2,
1479 #ifdef CONFIG_COMPAT
1480 .compat_ioctl32 = uvc_v4l2_compat_ioctl32,
1482 .read = uvc_v4l2_read,
1483 .mmap = uvc_v4l2_mmap,
1484 .poll = uvc_v4l2_poll,
1486 .get_unmapped_area = uvc_v4l2_get_unmapped_area,