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/version.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/usb.h>
21 #include <linux/videodev2.h>
22 #include <linux/vmalloc.h>
24 #include <linux/wait.h>
25 #include <linux/atomic.h>
27 #include <media/v4l2-common.h>
28 #include <media/v4l2-ctrls.h>
29 #include <media/v4l2-event.h>
30 #include <media/v4l2-ioctl.h>
34 /* ------------------------------------------------------------------------
37 static int uvc_ioctl_ctrl_map(struct uvc_video_chain
*chain
,
38 struct uvc_xu_control_mapping
*xmap
)
40 struct uvc_control_mapping
*map
;
44 map
= kzalloc(sizeof *map
, GFP_KERNEL
);
49 memcpy(map
->name
, xmap
->name
, sizeof map
->name
);
50 memcpy(map
->entity
, xmap
->entity
, sizeof map
->entity
);
51 map
->selector
= xmap
->selector
;
52 map
->size
= xmap
->size
;
53 map
->offset
= xmap
->offset
;
54 map
->v4l2_type
= xmap
->v4l2_type
;
55 map
->data_type
= xmap
->data_type
;
57 switch (xmap
->v4l2_type
) {
58 case V4L2_CTRL_TYPE_INTEGER
:
59 case V4L2_CTRL_TYPE_BOOLEAN
:
60 case V4L2_CTRL_TYPE_BUTTON
:
63 case V4L2_CTRL_TYPE_MENU
:
64 /* Prevent excessive memory consumption, as well as integer
67 if (xmap
->menu_count
== 0 ||
68 xmap
->menu_count
> UVC_MAX_CONTROL_MENU_ENTRIES
) {
73 size
= xmap
->menu_count
* sizeof(*map
->menu_info
);
74 map
->menu_info
= kmalloc(size
, GFP_KERNEL
);
75 if (map
->menu_info
== NULL
) {
80 if (copy_from_user(map
->menu_info
, xmap
->menu_info
, size
)) {
85 map
->menu_count
= xmap
->menu_count
;
89 uvc_trace(UVC_TRACE_CONTROL
, "Unsupported V4L2 control type "
90 "%u.\n", xmap
->v4l2_type
);
95 ret
= uvc_ctrl_add_mapping(chain
, map
);
98 kfree(map
->menu_info
);
104 /* ------------------------------------------------------------------------
109 * Find the frame interval closest to the requested frame interval for the
110 * given frame format and size. This should be done by the device as part of
111 * the Video Probe and Commit negotiation, but some hardware don't implement
114 static __u32
uvc_try_frame_interval(struct uvc_frame
*frame
, __u32 interval
)
118 if (frame
->bFrameIntervalType
) {
119 __u32 best
= -1, dist
;
121 for (i
= 0; i
< frame
->bFrameIntervalType
; ++i
) {
122 dist
= interval
> frame
->dwFrameInterval
[i
]
123 ? interval
- frame
->dwFrameInterval
[i
]
124 : frame
->dwFrameInterval
[i
] - interval
;
132 interval
= frame
->dwFrameInterval
[i
-1];
134 const __u32 min
= frame
->dwFrameInterval
[0];
135 const __u32 max
= frame
->dwFrameInterval
[1];
136 const __u32 step
= frame
->dwFrameInterval
[2];
138 interval
= min
+ (interval
- min
+ step
/2) / step
* step
;
146 static int uvc_v4l2_try_format(struct uvc_streaming
*stream
,
147 struct v4l2_format
*fmt
, struct uvc_streaming_control
*probe
,
148 struct uvc_format
**uvc_format
, struct uvc_frame
**uvc_frame
)
150 struct uvc_format
*format
= NULL
;
151 struct uvc_frame
*frame
= NULL
;
153 unsigned int d
, maxd
;
159 if (fmt
->type
!= stream
->type
)
162 fcc
= (__u8
*)&fmt
->fmt
.pix
.pixelformat
;
163 uvc_trace(UVC_TRACE_FORMAT
, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
164 fmt
->fmt
.pix
.pixelformat
,
165 fcc
[0], fcc
[1], fcc
[2], fcc
[3],
166 fmt
->fmt
.pix
.width
, fmt
->fmt
.pix
.height
);
168 /* Check if the hardware supports the requested format, use the default
171 for (i
= 0; i
< stream
->nformats
; ++i
) {
172 format
= &stream
->format
[i
];
173 if (format
->fcc
== fmt
->fmt
.pix
.pixelformat
)
177 if (i
== stream
->nformats
) {
178 format
= stream
->def_format
;
179 fmt
->fmt
.pix
.pixelformat
= format
->fcc
;
182 /* Find the closest image size. The distance between image sizes is
183 * the size in pixels of the non-overlapping regions between the
184 * requested size and the frame-specified size.
186 rw
= fmt
->fmt
.pix
.width
;
187 rh
= fmt
->fmt
.pix
.height
;
188 maxd
= (unsigned int)-1;
190 for (i
= 0; i
< format
->nframes
; ++i
) {
191 __u16 w
= format
->frame
[i
].wWidth
;
192 __u16 h
= format
->frame
[i
].wHeight
;
194 d
= min(w
, rw
) * min(h
, rh
);
195 d
= w
*h
+ rw
*rh
- 2*d
;
198 frame
= &format
->frame
[i
];
206 uvc_trace(UVC_TRACE_FORMAT
, "Unsupported size %ux%u.\n",
207 fmt
->fmt
.pix
.width
, fmt
->fmt
.pix
.height
);
211 /* Use the default frame interval. */
212 interval
= frame
->dwDefaultFrameInterval
;
213 uvc_trace(UVC_TRACE_FORMAT
, "Using default frame interval %u.%u us "
214 "(%u.%u fps).\n", interval
/10, interval
%10, 10000000/interval
,
215 (100000000/interval
)%10);
217 /* Set the format index, frame index and frame interval. */
218 memset(probe
, 0, sizeof *probe
);
219 probe
->bmHint
= 1; /* dwFrameInterval */
220 probe
->bFormatIndex
= format
->index
;
221 probe
->bFrameIndex
= frame
->bFrameIndex
;
222 probe
->dwFrameInterval
= uvc_try_frame_interval(frame
, interval
);
223 /* Some webcams stall the probe control set request when the
224 * dwMaxVideoFrameSize field is set to zero. The UVC specification
225 * clearly states that the field is read-only from the host, so this
226 * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
227 * the webcam to work around the problem.
229 * The workaround could probably be enabled for all webcams, so the
230 * quirk can be removed if needed. It's currently useful to detect
231 * webcam bugs and fix them before they hit the market (providing
232 * developers test their webcams with the Linux driver as well as with
233 * the Windows driver).
235 mutex_lock(&stream
->mutex
);
236 if (stream
->dev
->quirks
& UVC_QUIRK_PROBE_EXTRAFIELDS
)
237 probe
->dwMaxVideoFrameSize
=
238 stream
->ctrl
.dwMaxVideoFrameSize
;
240 /* Probe the device. */
241 ret
= uvc_probe_video(stream
, probe
);
242 mutex_unlock(&stream
->mutex
);
246 fmt
->fmt
.pix
.width
= frame
->wWidth
;
247 fmt
->fmt
.pix
.height
= frame
->wHeight
;
248 fmt
->fmt
.pix
.field
= V4L2_FIELD_NONE
;
249 fmt
->fmt
.pix
.bytesperline
= format
->bpp
* frame
->wWidth
/ 8;
250 fmt
->fmt
.pix
.sizeimage
= probe
->dwMaxVideoFrameSize
;
251 fmt
->fmt
.pix
.colorspace
= format
->colorspace
;
252 fmt
->fmt
.pix
.priv
= 0;
254 if (uvc_format
!= NULL
)
255 *uvc_format
= format
;
256 if (uvc_frame
!= NULL
)
263 static int uvc_v4l2_get_format(struct uvc_streaming
*stream
,
264 struct v4l2_format
*fmt
)
266 struct uvc_format
*format
;
267 struct uvc_frame
*frame
;
270 if (fmt
->type
!= stream
->type
)
273 mutex_lock(&stream
->mutex
);
274 format
= stream
->cur_format
;
275 frame
= stream
->cur_frame
;
277 if (format
== NULL
|| frame
== NULL
) {
282 fmt
->fmt
.pix
.pixelformat
= format
->fcc
;
283 fmt
->fmt
.pix
.width
= frame
->wWidth
;
284 fmt
->fmt
.pix
.height
= frame
->wHeight
;
285 fmt
->fmt
.pix
.field
= V4L2_FIELD_NONE
;
286 fmt
->fmt
.pix
.bytesperline
= format
->bpp
* frame
->wWidth
/ 8;
287 fmt
->fmt
.pix
.sizeimage
= stream
->ctrl
.dwMaxVideoFrameSize
;
288 fmt
->fmt
.pix
.colorspace
= format
->colorspace
;
289 fmt
->fmt
.pix
.priv
= 0;
292 mutex_unlock(&stream
->mutex
);
296 static int uvc_v4l2_set_format(struct uvc_streaming
*stream
,
297 struct v4l2_format
*fmt
)
299 struct uvc_streaming_control probe
;
300 struct uvc_format
*format
;
301 struct uvc_frame
*frame
;
304 if (fmt
->type
!= stream
->type
)
307 ret
= uvc_v4l2_try_format(stream
, fmt
, &probe
, &format
, &frame
);
311 mutex_lock(&stream
->mutex
);
313 if (uvc_queue_allocated(&stream
->queue
)) {
318 memcpy(&stream
->ctrl
, &probe
, sizeof probe
);
319 stream
->cur_format
= format
;
320 stream
->cur_frame
= frame
;
323 mutex_unlock(&stream
->mutex
);
327 static int uvc_v4l2_get_streamparm(struct uvc_streaming
*stream
,
328 struct v4l2_streamparm
*parm
)
330 uint32_t numerator
, denominator
;
332 if (parm
->type
!= stream
->type
)
335 mutex_lock(&stream
->mutex
);
336 numerator
= stream
->ctrl
.dwFrameInterval
;
337 mutex_unlock(&stream
->mutex
);
339 denominator
= 10000000;
340 uvc_simplify_fraction(&numerator
, &denominator
, 8, 333);
342 memset(parm
, 0, sizeof *parm
);
343 parm
->type
= stream
->type
;
345 if (stream
->type
== V4L2_BUF_TYPE_VIDEO_CAPTURE
) {
346 parm
->parm
.capture
.capability
= V4L2_CAP_TIMEPERFRAME
;
347 parm
->parm
.capture
.capturemode
= 0;
348 parm
->parm
.capture
.timeperframe
.numerator
= numerator
;
349 parm
->parm
.capture
.timeperframe
.denominator
= denominator
;
350 parm
->parm
.capture
.extendedmode
= 0;
351 parm
->parm
.capture
.readbuffers
= 0;
353 parm
->parm
.output
.capability
= V4L2_CAP_TIMEPERFRAME
;
354 parm
->parm
.output
.outputmode
= 0;
355 parm
->parm
.output
.timeperframe
.numerator
= numerator
;
356 parm
->parm
.output
.timeperframe
.denominator
= denominator
;
362 static int uvc_v4l2_set_streamparm(struct uvc_streaming
*stream
,
363 struct v4l2_streamparm
*parm
)
365 struct uvc_streaming_control probe
;
366 struct v4l2_fract timeperframe
;
370 if (parm
->type
!= stream
->type
)
373 if (parm
->type
== V4L2_BUF_TYPE_VIDEO_CAPTURE
)
374 timeperframe
= parm
->parm
.capture
.timeperframe
;
376 timeperframe
= parm
->parm
.output
.timeperframe
;
378 interval
= uvc_fraction_to_interval(timeperframe
.numerator
,
379 timeperframe
.denominator
);
380 uvc_trace(UVC_TRACE_FORMAT
, "Setting frame interval to %u/%u (%u).\n",
381 timeperframe
.numerator
, timeperframe
.denominator
, interval
);
383 mutex_lock(&stream
->mutex
);
385 if (uvc_queue_streaming(&stream
->queue
)) {
386 mutex_unlock(&stream
->mutex
);
390 memcpy(&probe
, &stream
->ctrl
, sizeof probe
);
391 probe
.dwFrameInterval
=
392 uvc_try_frame_interval(stream
->cur_frame
, interval
);
394 /* Probe the device with the new settings. */
395 ret
= uvc_probe_video(stream
, &probe
);
397 mutex_unlock(&stream
->mutex
);
401 memcpy(&stream
->ctrl
, &probe
, sizeof probe
);
402 mutex_unlock(&stream
->mutex
);
404 /* Return the actual frame period. */
405 timeperframe
.numerator
= probe
.dwFrameInterval
;
406 timeperframe
.denominator
= 10000000;
407 uvc_simplify_fraction(&timeperframe
.numerator
,
408 &timeperframe
.denominator
, 8, 333);
410 if (parm
->type
== V4L2_BUF_TYPE_VIDEO_CAPTURE
)
411 parm
->parm
.capture
.timeperframe
= timeperframe
;
413 parm
->parm
.output
.timeperframe
= timeperframe
;
418 /* ------------------------------------------------------------------------
419 * Privilege management
423 * Privilege management is the multiple-open implementation basis. The current
424 * implementation is completely transparent for the end-user and doesn't
425 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
426 * Those ioctls enable finer control on the device (by making possible for a
427 * user to request exclusive access to a device), but are not mature yet.
428 * Switching to the V4L2 priority mechanism might be considered in the future
429 * if this situation changes.
431 * Each open instance of a UVC device can either be in a privileged or
432 * unprivileged state. Only a single instance can be in a privileged state at
433 * a given time. Trying to perform an operation that requires privileges will
434 * automatically acquire the required privileges if possible, or return -EBUSY
435 * otherwise. Privileges are dismissed when closing the instance or when
436 * freeing the video buffers using VIDIOC_REQBUFS.
438 * Operations that require privileges are:
445 static int uvc_acquire_privileges(struct uvc_fh
*handle
)
447 /* Always succeed if the handle is already privileged. */
448 if (handle
->state
== UVC_HANDLE_ACTIVE
)
451 /* Check if the device already has a privileged handle. */
452 if (atomic_inc_return(&handle
->stream
->active
) != 1) {
453 atomic_dec(&handle
->stream
->active
);
457 handle
->state
= UVC_HANDLE_ACTIVE
;
461 static void uvc_dismiss_privileges(struct uvc_fh
*handle
)
463 if (handle
->state
== UVC_HANDLE_ACTIVE
)
464 atomic_dec(&handle
->stream
->active
);
466 handle
->state
= UVC_HANDLE_PASSIVE
;
469 static int uvc_has_privileges(struct uvc_fh
*handle
)
471 return handle
->state
== UVC_HANDLE_ACTIVE
;
474 /* ------------------------------------------------------------------------
475 * V4L2 file operations
478 static int uvc_v4l2_open(struct file
*file
)
480 struct uvc_streaming
*stream
;
481 struct uvc_fh
*handle
;
484 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_open\n");
485 stream
= video_drvdata(file
);
487 if (stream
->dev
->state
& UVC_DEV_DISCONNECTED
)
490 ret
= usb_autopm_get_interface(stream
->dev
->intf
);
494 /* Create the device handle. */
495 handle
= kzalloc(sizeof *handle
, GFP_KERNEL
);
496 if (handle
== NULL
) {
497 usb_autopm_put_interface(stream
->dev
->intf
);
501 if (atomic_inc_return(&stream
->dev
->users
) == 1) {
502 ret
= uvc_status_start(stream
->dev
);
504 usb_autopm_put_interface(stream
->dev
->intf
);
505 atomic_dec(&stream
->dev
->users
);
511 v4l2_fh_init(&handle
->vfh
, stream
->vdev
);
512 v4l2_fh_add(&handle
->vfh
);
513 handle
->chain
= stream
->chain
;
514 handle
->stream
= stream
;
515 handle
->state
= UVC_HANDLE_PASSIVE
;
516 file
->private_data
= handle
;
521 static int uvc_v4l2_release(struct file
*file
)
523 struct uvc_fh
*handle
= file
->private_data
;
524 struct uvc_streaming
*stream
= handle
->stream
;
526 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_release\n");
528 /* Only free resources if this is a privileged handle. */
529 if (uvc_has_privileges(handle
)) {
530 uvc_video_enable(stream
, 0);
531 uvc_free_buffers(&stream
->queue
);
534 /* Release the file handle. */
535 uvc_dismiss_privileges(handle
);
536 v4l2_fh_del(&handle
->vfh
);
537 v4l2_fh_exit(&handle
->vfh
);
539 file
->private_data
= NULL
;
541 if (atomic_dec_return(&stream
->dev
->users
) == 0)
542 uvc_status_stop(stream
->dev
);
544 usb_autopm_put_interface(stream
->dev
->intf
);
548 static long uvc_v4l2_do_ioctl(struct file
*file
, unsigned int cmd
, void *arg
)
550 struct video_device
*vdev
= video_devdata(file
);
551 struct uvc_fh
*handle
= file
->private_data
;
552 struct uvc_video_chain
*chain
= handle
->chain
;
553 struct uvc_streaming
*stream
= handle
->stream
;
557 /* Query capabilities */
558 case VIDIOC_QUERYCAP
:
560 struct v4l2_capability
*cap
= arg
;
562 memset(cap
, 0, sizeof *cap
);
563 strlcpy(cap
->driver
, "uvcvideo", sizeof cap
->driver
);
564 strlcpy(cap
->card
, vdev
->name
, sizeof cap
->card
);
565 usb_make_path(stream
->dev
->udev
,
566 cap
->bus_info
, sizeof(cap
->bus_info
));
567 cap
->version
= LINUX_VERSION_CODE
;
568 cap
->capabilities
= V4L2_CAP_DEVICE_CAPS
| V4L2_CAP_STREAMING
570 if (stream
->type
== V4L2_BUF_TYPE_VIDEO_CAPTURE
)
571 cap
->device_caps
= V4L2_CAP_VIDEO_CAPTURE
572 | V4L2_CAP_STREAMING
;
574 cap
->device_caps
= V4L2_CAP_VIDEO_OUTPUT
575 | V4L2_CAP_STREAMING
;
580 case VIDIOC_G_PRIORITY
:
581 *(u32
*)arg
= v4l2_prio_max(vdev
->prio
);
584 case VIDIOC_S_PRIORITY
:
585 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
589 return v4l2_prio_change(vdev
->prio
, &handle
->vfh
.prio
,
592 /* Get, Set & Query control */
593 case VIDIOC_QUERYCTRL
:
594 return uvc_query_v4l2_ctrl(chain
, arg
);
598 struct v4l2_control
*ctrl
= arg
;
599 struct v4l2_ext_control xctrl
;
601 memset(&xctrl
, 0, sizeof xctrl
);
604 ret
= uvc_ctrl_begin(chain
);
608 ret
= uvc_ctrl_get(chain
, &xctrl
);
609 uvc_ctrl_rollback(handle
);
611 ctrl
->value
= xctrl
.value
;
617 struct v4l2_control
*ctrl
= arg
;
618 struct v4l2_ext_control xctrl
;
620 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
624 memset(&xctrl
, 0, sizeof xctrl
);
626 xctrl
.value
= ctrl
->value
;
628 ret
= uvc_ctrl_begin(chain
);
632 ret
= uvc_ctrl_set(chain
, &xctrl
);
634 uvc_ctrl_rollback(handle
);
637 ret
= uvc_ctrl_commit(handle
, &xctrl
, 1);
639 ctrl
->value
= xctrl
.value
;
643 case VIDIOC_QUERYMENU
:
644 return uvc_query_v4l2_menu(chain
, arg
);
646 case VIDIOC_G_EXT_CTRLS
:
648 struct v4l2_ext_controls
*ctrls
= arg
;
649 struct v4l2_ext_control
*ctrl
= ctrls
->controls
;
652 ret
= uvc_ctrl_begin(chain
);
656 for (i
= 0; i
< ctrls
->count
; ++ctrl
, ++i
) {
657 ret
= uvc_ctrl_get(chain
, ctrl
);
659 uvc_ctrl_rollback(handle
);
660 ctrls
->error_idx
= ret
== -ENOENT
665 ctrls
->error_idx
= 0;
666 ret
= uvc_ctrl_rollback(handle
);
670 case VIDIOC_S_EXT_CTRLS
:
671 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
675 case VIDIOC_TRY_EXT_CTRLS
:
677 struct v4l2_ext_controls
*ctrls
= arg
;
678 struct v4l2_ext_control
*ctrl
= ctrls
->controls
;
681 ret
= uvc_ctrl_begin(chain
);
685 for (i
= 0; i
< ctrls
->count
; ++ctrl
, ++i
) {
686 ret
= uvc_ctrl_set(chain
, ctrl
);
688 uvc_ctrl_rollback(handle
);
689 ctrls
->error_idx
= (ret
== -ENOENT
&&
690 cmd
== VIDIOC_S_EXT_CTRLS
)
696 ctrls
->error_idx
= 0;
698 if (cmd
== VIDIOC_S_EXT_CTRLS
)
699 ret
= uvc_ctrl_commit(handle
,
700 ctrls
->controls
, ctrls
->count
);
702 ret
= uvc_ctrl_rollback(handle
);
706 /* Get, Set & Enum input */
707 case VIDIOC_ENUMINPUT
:
709 const struct uvc_entity
*selector
= chain
->selector
;
710 struct v4l2_input
*input
= arg
;
711 struct uvc_entity
*iterm
= NULL
;
712 u32 index
= input
->index
;
715 if (selector
== NULL
||
716 (chain
->dev
->quirks
& UVC_QUIRK_IGNORE_SELECTOR_UNIT
)) {
719 list_for_each_entry(iterm
, &chain
->entities
, chain
) {
720 if (UVC_ENTITY_IS_ITERM(iterm
))
724 } else if (index
< selector
->bNrInPins
) {
725 pin
= selector
->baSourceID
[index
];
726 list_for_each_entry(iterm
, &chain
->entities
, chain
) {
727 if (!UVC_ENTITY_IS_ITERM(iterm
))
729 if (iterm
->id
== pin
)
734 if (iterm
== NULL
|| iterm
->id
!= pin
)
737 memset(input
, 0, sizeof *input
);
738 input
->index
= index
;
739 strlcpy(input
->name
, iterm
->name
, sizeof input
->name
);
740 if (UVC_ENTITY_TYPE(iterm
) == UVC_ITT_CAMERA
)
741 input
->type
= V4L2_INPUT_TYPE_CAMERA
;
749 if (chain
->selector
== NULL
||
750 (chain
->dev
->quirks
& UVC_QUIRK_IGNORE_SELECTOR_UNIT
)) {
755 ret
= uvc_query_ctrl(chain
->dev
, UVC_GET_CUR
,
756 chain
->selector
->id
, chain
->dev
->intfnum
,
757 UVC_SU_INPUT_SELECT_CONTROL
, &input
, 1);
761 *(int *)arg
= input
- 1;
767 u32 input
= *(u32
*)arg
+ 1;
769 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
773 if ((ret
= uvc_acquire_privileges(handle
)) < 0)
776 if (chain
->selector
== NULL
||
777 (chain
->dev
->quirks
& UVC_QUIRK_IGNORE_SELECTOR_UNIT
)) {
783 if (input
== 0 || input
> chain
->selector
->bNrInPins
)
786 return uvc_query_ctrl(chain
->dev
, UVC_SET_CUR
,
787 chain
->selector
->id
, chain
->dev
->intfnum
,
788 UVC_SU_INPUT_SELECT_CONTROL
, &input
, 1);
791 /* Try, Get, Set & Enum format */
792 case VIDIOC_ENUM_FMT
:
794 struct v4l2_fmtdesc
*fmt
= arg
;
795 struct uvc_format
*format
;
796 enum v4l2_buf_type type
= fmt
->type
;
797 __u32 index
= fmt
->index
;
799 if (fmt
->type
!= stream
->type
||
800 fmt
->index
>= stream
->nformats
)
803 memset(fmt
, 0, sizeof(*fmt
));
807 format
= &stream
->format
[fmt
->index
];
809 if (format
->flags
& UVC_FMT_FLAG_COMPRESSED
)
810 fmt
->flags
|= V4L2_FMT_FLAG_COMPRESSED
;
811 strlcpy(fmt
->description
, format
->name
,
812 sizeof fmt
->description
);
813 fmt
->description
[sizeof fmt
->description
- 1] = 0;
814 fmt
->pixelformat
= format
->fcc
;
820 struct uvc_streaming_control probe
;
822 return uvc_v4l2_try_format(stream
, arg
, &probe
, NULL
, NULL
);
826 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
830 if ((ret
= uvc_acquire_privileges(handle
)) < 0)
833 return uvc_v4l2_set_format(stream
, arg
);
836 return uvc_v4l2_get_format(stream
, arg
);
838 /* Frame size enumeration */
839 case VIDIOC_ENUM_FRAMESIZES
:
841 struct v4l2_frmsizeenum
*fsize
= arg
;
842 struct uvc_format
*format
= NULL
;
843 struct uvc_frame
*frame
;
846 /* Look for the given pixel format */
847 for (i
= 0; i
< stream
->nformats
; i
++) {
848 if (stream
->format
[i
].fcc
==
849 fsize
->pixel_format
) {
850 format
= &stream
->format
[i
];
857 if (fsize
->index
>= format
->nframes
)
860 frame
= &format
->frame
[fsize
->index
];
861 fsize
->type
= V4L2_FRMSIZE_TYPE_DISCRETE
;
862 fsize
->discrete
.width
= frame
->wWidth
;
863 fsize
->discrete
.height
= frame
->wHeight
;
867 /* Frame interval enumeration */
868 case VIDIOC_ENUM_FRAMEINTERVALS
:
870 struct v4l2_frmivalenum
*fival
= arg
;
871 struct uvc_format
*format
= NULL
;
872 struct uvc_frame
*frame
= NULL
;
875 /* Look for the given pixel format and frame size */
876 for (i
= 0; i
< stream
->nformats
; i
++) {
877 if (stream
->format
[i
].fcc
==
878 fival
->pixel_format
) {
879 format
= &stream
->format
[i
];
886 for (i
= 0; i
< format
->nframes
; i
++) {
887 if (format
->frame
[i
].wWidth
== fival
->width
&&
888 format
->frame
[i
].wHeight
== fival
->height
) {
889 frame
= &format
->frame
[i
];
896 if (frame
->bFrameIntervalType
) {
897 if (fival
->index
>= frame
->bFrameIntervalType
)
900 fival
->type
= V4L2_FRMIVAL_TYPE_DISCRETE
;
901 fival
->discrete
.numerator
=
902 frame
->dwFrameInterval
[fival
->index
];
903 fival
->discrete
.denominator
= 10000000;
904 uvc_simplify_fraction(&fival
->discrete
.numerator
,
905 &fival
->discrete
.denominator
, 8, 333);
907 fival
->type
= V4L2_FRMIVAL_TYPE_STEPWISE
;
908 fival
->stepwise
.min
.numerator
=
909 frame
->dwFrameInterval
[0];
910 fival
->stepwise
.min
.denominator
= 10000000;
911 fival
->stepwise
.max
.numerator
=
912 frame
->dwFrameInterval
[1];
913 fival
->stepwise
.max
.denominator
= 10000000;
914 fival
->stepwise
.step
.numerator
=
915 frame
->dwFrameInterval
[2];
916 fival
->stepwise
.step
.denominator
= 10000000;
917 uvc_simplify_fraction(&fival
->stepwise
.min
.numerator
,
918 &fival
->stepwise
.min
.denominator
, 8, 333);
919 uvc_simplify_fraction(&fival
->stepwise
.max
.numerator
,
920 &fival
->stepwise
.max
.denominator
, 8, 333);
921 uvc_simplify_fraction(&fival
->stepwise
.step
.numerator
,
922 &fival
->stepwise
.step
.denominator
, 8, 333);
927 /* Get & Set streaming parameters */
929 return uvc_v4l2_get_streamparm(stream
, arg
);
932 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
936 if ((ret
= uvc_acquire_privileges(handle
)) < 0)
939 return uvc_v4l2_set_streamparm(stream
, arg
);
941 /* Cropping and scaling */
944 struct v4l2_cropcap
*ccap
= arg
;
946 if (ccap
->type
!= stream
->type
)
949 ccap
->bounds
.left
= 0;
950 ccap
->bounds
.top
= 0;
952 mutex_lock(&stream
->mutex
);
953 ccap
->bounds
.width
= stream
->cur_frame
->wWidth
;
954 ccap
->bounds
.height
= stream
->cur_frame
->wHeight
;
955 mutex_unlock(&stream
->mutex
);
957 ccap
->defrect
= ccap
->bounds
;
959 ccap
->pixelaspect
.numerator
= 1;
960 ccap
->pixelaspect
.denominator
= 1;
968 /* Buffers & streaming */
970 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
974 if ((ret
= uvc_acquire_privileges(handle
)) < 0)
977 mutex_lock(&stream
->mutex
);
978 ret
= uvc_alloc_buffers(&stream
->queue
, arg
);
979 mutex_unlock(&stream
->mutex
);
984 uvc_dismiss_privileges(handle
);
989 case VIDIOC_QUERYBUF
:
991 struct v4l2_buffer
*buf
= arg
;
993 if (!uvc_has_privileges(handle
))
996 return uvc_query_buffer(&stream
->queue
, buf
);
1000 if (!uvc_has_privileges(handle
))
1003 return uvc_queue_buffer(&stream
->queue
, arg
);
1006 if (!uvc_has_privileges(handle
))
1009 return uvc_dequeue_buffer(&stream
->queue
, arg
,
1010 file
->f_flags
& O_NONBLOCK
);
1012 case VIDIOC_STREAMON
:
1016 if (*type
!= stream
->type
)
1019 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
1023 if (!uvc_has_privileges(handle
))
1026 mutex_lock(&stream
->mutex
);
1027 ret
= uvc_video_enable(stream
, 1);
1028 mutex_unlock(&stream
->mutex
);
1034 case VIDIOC_STREAMOFF
:
1038 if (*type
!= stream
->type
)
1041 ret
= v4l2_prio_check(vdev
->prio
, handle
->vfh
.prio
);
1045 if (!uvc_has_privileges(handle
))
1048 return uvc_video_enable(stream
, 0);
1051 case VIDIOC_SUBSCRIBE_EVENT
:
1053 struct v4l2_event_subscription
*sub
= arg
;
1055 switch (sub
->type
) {
1056 case V4L2_EVENT_CTRL
:
1057 return v4l2_event_subscribe(&handle
->vfh
, sub
, 0,
1058 &uvc_ctrl_sub_ev_ops
);
1064 case VIDIOC_UNSUBSCRIBE_EVENT
:
1065 return v4l2_event_unsubscribe(&handle
->vfh
, arg
);
1067 case VIDIOC_DQEVENT
:
1068 return v4l2_event_dequeue(&handle
->vfh
, arg
,
1069 file
->f_flags
& O_NONBLOCK
);
1071 /* Analog video standards make no sense for digital cameras. */
1072 case VIDIOC_ENUMSTD
:
1073 case VIDIOC_QUERYSTD
:
1077 case VIDIOC_OVERLAY
:
1079 case VIDIOC_ENUMAUDIO
:
1080 case VIDIOC_ENUMAUDOUT
:
1082 case VIDIOC_ENUMOUTPUT
:
1083 uvc_trace(UVC_TRACE_IOCTL
, "Unsupported ioctl 0x%08x\n", cmd
);
1086 case UVCIOC_CTRL_MAP
:
1087 return uvc_ioctl_ctrl_map(chain
, arg
);
1089 case UVCIOC_CTRL_QUERY
:
1090 return uvc_xu_ctrl_query(chain
, arg
);
1093 uvc_trace(UVC_TRACE_IOCTL
, "Unknown ioctl 0x%08x\n", cmd
);
1100 static long uvc_v4l2_ioctl(struct file
*file
,
1101 unsigned int cmd
, unsigned long arg
)
1103 if (uvc_trace_param
& UVC_TRACE_IOCTL
) {
1104 uvc_printk(KERN_DEBUG
, "uvc_v4l2_ioctl(");
1105 v4l_printk_ioctl(NULL
, cmd
);
1109 return video_usercopy(file
, cmd
, arg
, uvc_v4l2_do_ioctl
);
1112 #ifdef CONFIG_COMPAT
1113 struct uvc_xu_control_mapping32
{
1124 compat_caddr_t menu_info
;
1130 static int uvc_v4l2_get_xu_mapping(struct uvc_xu_control_mapping
*kp
,
1131 const struct uvc_xu_control_mapping32 __user
*up
)
1133 struct uvc_menu_info __user
*umenus
;
1134 struct uvc_menu_info __user
*kmenus
;
1137 if (!access_ok(VERIFY_READ
, up
, sizeof(*up
)) ||
1138 __copy_from_user(kp
, up
, offsetof(typeof(*up
), menu_info
)) ||
1139 __get_user(kp
->menu_count
, &up
->menu_count
))
1142 memset(kp
->reserved
, 0, sizeof(kp
->reserved
));
1144 if (kp
->menu_count
== 0) {
1145 kp
->menu_info
= NULL
;
1149 if (__get_user(p
, &up
->menu_info
))
1151 umenus
= compat_ptr(p
);
1152 if (!access_ok(VERIFY_READ
, umenus
, kp
->menu_count
* sizeof(*umenus
)))
1155 kmenus
= compat_alloc_user_space(kp
->menu_count
* sizeof(*kmenus
));
1158 kp
->menu_info
= kmenus
;
1160 if (copy_in_user(kmenus
, umenus
, kp
->menu_count
* sizeof(*umenus
)))
1166 static int uvc_v4l2_put_xu_mapping(const struct uvc_xu_control_mapping
*kp
,
1167 struct uvc_xu_control_mapping32 __user
*up
)
1169 struct uvc_menu_info __user
*umenus
;
1170 struct uvc_menu_info __user
*kmenus
= kp
->menu_info
;
1173 if (!access_ok(VERIFY_WRITE
, up
, sizeof(*up
)) ||
1174 __copy_to_user(up
, kp
, offsetof(typeof(*up
), menu_info
)) ||
1175 __put_user(kp
->menu_count
, &up
->menu_count
))
1178 if (__clear_user(up
->reserved
, sizeof(up
->reserved
)))
1181 if (kp
->menu_count
== 0)
1184 if (get_user(p
, &up
->menu_info
))
1186 umenus
= compat_ptr(p
);
1188 if (copy_in_user(umenus
, kmenus
, kp
->menu_count
* sizeof(*umenus
)))
1194 struct uvc_xu_control_query32
{
1199 compat_caddr_t data
;
1202 static int uvc_v4l2_get_xu_query(struct uvc_xu_control_query
*kp
,
1203 const struct uvc_xu_control_query32 __user
*up
)
1209 if (!access_ok(VERIFY_READ
, up
, sizeof(*up
)) ||
1210 __copy_from_user(kp
, up
, offsetof(typeof(*up
), data
)))
1213 if (kp
->size
== 0) {
1218 if (__get_user(p
, &up
->data
))
1220 udata
= compat_ptr(p
);
1221 if (!access_ok(VERIFY_READ
, udata
, kp
->size
))
1224 kdata
= compat_alloc_user_space(kp
->size
);
1229 if (copy_in_user(kdata
, udata
, kp
->size
))
1235 static int uvc_v4l2_put_xu_query(const struct uvc_xu_control_query
*kp
,
1236 struct uvc_xu_control_query32 __user
*up
)
1239 u8 __user
*kdata
= kp
->data
;
1242 if (!access_ok(VERIFY_WRITE
, up
, sizeof(*up
)) ||
1243 __copy_to_user(up
, kp
, offsetof(typeof(*up
), data
)))
1249 if (get_user(p
, &up
->data
))
1251 udata
= compat_ptr(p
);
1252 if (!access_ok(VERIFY_READ
, udata
, kp
->size
))
1255 if (copy_in_user(udata
, kdata
, kp
->size
))
1261 #define UVCIOC_CTRL_MAP32 _IOWR('u', 0x20, struct uvc_xu_control_mapping32)
1262 #define UVCIOC_CTRL_QUERY32 _IOWR('u', 0x21, struct uvc_xu_control_query32)
1264 static long uvc_v4l2_compat_ioctl32(struct file
*file
,
1265 unsigned int cmd
, unsigned long arg
)
1268 struct uvc_xu_control_mapping xmap
;
1269 struct uvc_xu_control_query xqry
;
1271 void __user
*up
= compat_ptr(arg
);
1272 mm_segment_t old_fs
;
1276 case UVCIOC_CTRL_MAP32
:
1277 cmd
= UVCIOC_CTRL_MAP
;
1278 ret
= uvc_v4l2_get_xu_mapping(&karg
.xmap
, up
);
1281 case UVCIOC_CTRL_QUERY32
:
1282 cmd
= UVCIOC_CTRL_QUERY
;
1283 ret
= uvc_v4l2_get_xu_query(&karg
.xqry
, up
);
1287 return -ENOIOCTLCMD
;
1292 ret
= uvc_v4l2_ioctl(file
, cmd
, (unsigned long)&karg
);
1299 case UVCIOC_CTRL_MAP
:
1300 ret
= uvc_v4l2_put_xu_mapping(&karg
.xmap
, up
);
1303 case UVCIOC_CTRL_QUERY
:
1304 ret
= uvc_v4l2_put_xu_query(&karg
.xqry
, up
);
1312 static ssize_t
uvc_v4l2_read(struct file
*file
, char __user
*data
,
1313 size_t count
, loff_t
*ppos
)
1315 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_read: not implemented.\n");
1319 static int uvc_v4l2_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1321 struct uvc_fh
*handle
= file
->private_data
;
1322 struct uvc_streaming
*stream
= handle
->stream
;
1324 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_mmap\n");
1326 return uvc_queue_mmap(&stream
->queue
, vma
);
1329 static unsigned int uvc_v4l2_poll(struct file
*file
, poll_table
*wait
)
1331 struct uvc_fh
*handle
= file
->private_data
;
1332 struct uvc_streaming
*stream
= handle
->stream
;
1334 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_poll\n");
1336 return uvc_queue_poll(&stream
->queue
, file
, wait
);
1340 static unsigned long uvc_v4l2_get_unmapped_area(struct file
*file
,
1341 unsigned long addr
, unsigned long len
, unsigned long pgoff
,
1342 unsigned long flags
)
1344 struct uvc_fh
*handle
= file
->private_data
;
1345 struct uvc_streaming
*stream
= handle
->stream
;
1347 uvc_trace(UVC_TRACE_CALLS
, "uvc_v4l2_get_unmapped_area\n");
1349 return uvc_queue_get_unmapped_area(&stream
->queue
, pgoff
);
1353 const struct v4l2_file_operations uvc_fops
= {
1354 .owner
= THIS_MODULE
,
1355 .open
= uvc_v4l2_open
,
1356 .release
= uvc_v4l2_release
,
1357 .unlocked_ioctl
= uvc_v4l2_ioctl
,
1358 #ifdef CONFIG_COMPAT
1359 .compat_ioctl32
= uvc_v4l2_compat_ioctl32
,
1361 .read
= uvc_v4l2_read
,
1362 .mmap
= uvc_v4l2_mmap
,
1363 .poll
= uvc_v4l2_poll
,
1365 .get_unmapped_area
= uvc_v4l2_get_unmapped_area
,