blob: 8361367806a98f89e171b4f075b91a199dcdd1d2 [file] [log] [blame]
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001/*
2 * uvc_v4l2.c -- USB Video Class driver - V4L2 API
3 *
4 * Copyright (C) 2005-2008
5 * Laurent Pinchart (laurent.pinchart@skynet.be)
6 *
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.
11 *
12 */
13
14#include <linux/kernel.h>
15#include <linux/version.h>
16#include <linux/list.h>
17#include <linux/module.h>
18#include <linux/usb.h>
19#include <linux/videodev2.h>
20#include <linux/vmalloc.h>
21#include <linux/mm.h>
22#include <linux/wait.h>
23#include <asm/atomic.h>
24
25#include <media/v4l2-common.h>
Hans Verkuil35ea11f2008-07-20 08:12:02 -030026#include <media/v4l2-ioctl.h>
Laurent Pinchartc0efd232008-06-30 15:04:50 -030027
28#include "uvcvideo.h"
29
30/* ------------------------------------------------------------------------
31 * V4L2 interface
32 */
33
34/*
35 * Mapping V4L2 controls to UVC controls can be straighforward if done well.
36 * Most of the UVC controls exist in V4L2, and can be mapped directly. Some
37 * must be grouped (for instance the Red Balance, Blue Balance and Do White
38 * Balance V4L2 controls use the White Balance Component UVC control) or
39 * otherwise translated. The approach we take here is to use a translation
40 * table for the controls which can be mapped directly, and handle the others
41 * manually.
42 */
43static int uvc_v4l2_query_menu(struct uvc_video_device *video,
44 struct v4l2_querymenu *query_menu)
45{
46 struct uvc_menu_info *menu_info;
47 struct uvc_control_mapping *mapping;
48 struct uvc_control *ctrl;
49
50 ctrl = uvc_find_control(video, query_menu->id, &mapping);
51 if (ctrl == NULL || mapping->v4l2_type != V4L2_CTRL_TYPE_MENU)
52 return -EINVAL;
53
54 if (query_menu->index >= mapping->menu_count)
55 return -EINVAL;
56
57 menu_info = &mapping->menu_info[query_menu->index];
58 strncpy(query_menu->name, menu_info->name, 32);
59 return 0;
60}
61
62/*
63 * Find the frame interval closest to the requested frame interval for the
64 * given frame format and size. This should be done by the device as part of
65 * the Video Probe and Commit negotiation, but some hardware don't implement
66 * that feature.
67 */
68static __u32 uvc_try_frame_interval(struct uvc_frame *frame, __u32 interval)
69{
70 unsigned int i;
71
72 if (frame->bFrameIntervalType) {
73 __u32 best = -1, dist;
74
75 for (i = 0; i < frame->bFrameIntervalType; ++i) {
76 dist = interval > frame->dwFrameInterval[i]
77 ? interval - frame->dwFrameInterval[i]
78 : frame->dwFrameInterval[i] - interval;
79
80 if (dist > best)
81 break;
82
83 best = dist;
84 }
85
86 interval = frame->dwFrameInterval[i-1];
87 } else {
88 const __u32 min = frame->dwFrameInterval[0];
89 const __u32 max = frame->dwFrameInterval[1];
90 const __u32 step = frame->dwFrameInterval[2];
91
92 interval = min + (interval - min + step/2) / step * step;
93 if (interval > max)
94 interval = max;
95 }
96
97 return interval;
98}
99
100static int uvc_v4l2_try_format(struct uvc_video_device *video,
101 struct v4l2_format *fmt, struct uvc_streaming_control *probe,
102 struct uvc_format **uvc_format, struct uvc_frame **uvc_frame)
103{
104 struct uvc_format *format = NULL;
105 struct uvc_frame *frame = NULL;
106 __u16 rw, rh;
107 unsigned int d, maxd;
108 unsigned int i;
109 __u32 interval;
110 int ret = 0;
111 __u8 *fcc;
112
113 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
114 return -EINVAL;
115
116 fcc = (__u8 *)&fmt->fmt.pix.pixelformat;
117 uvc_trace(UVC_TRACE_FORMAT, "Trying format 0x%08x (%c%c%c%c): %ux%u.\n",
118 fmt->fmt.pix.pixelformat,
119 fcc[0], fcc[1], fcc[2], fcc[3],
120 fmt->fmt.pix.width, fmt->fmt.pix.height);
121
122 /* Check if the hardware supports the requested format. */
123 for (i = 0; i < video->streaming->nformats; ++i) {
124 format = &video->streaming->format[i];
125 if (format->fcc == fmt->fmt.pix.pixelformat)
126 break;
127 }
128
129 if (format == NULL || format->fcc != fmt->fmt.pix.pixelformat) {
130 uvc_trace(UVC_TRACE_FORMAT, "Unsupported format 0x%08x.\n",
131 fmt->fmt.pix.pixelformat);
132 return -EINVAL;
133 }
134
135 /* Find the closest image size. The distance between image sizes is
136 * the size in pixels of the non-overlapping regions between the
137 * requested size and the frame-specified size.
138 */
139 rw = fmt->fmt.pix.width;
140 rh = fmt->fmt.pix.height;
141 maxd = (unsigned int)-1;
142
143 for (i = 0; i < format->nframes; ++i) {
144 __u16 w = format->frame[i].wWidth;
145 __u16 h = format->frame[i].wHeight;
146
147 d = min(w, rw) * min(h, rh);
148 d = w*h + rw*rh - 2*d;
149 if (d < maxd) {
150 maxd = d;
151 frame = &format->frame[i];
152 }
153
154 if (maxd == 0)
155 break;
156 }
157
158 if (frame == NULL) {
159 uvc_trace(UVC_TRACE_FORMAT, "Unsupported size %ux%u.\n",
160 fmt->fmt.pix.width, fmt->fmt.pix.height);
161 return -EINVAL;
162 }
163
164 /* Use the default frame interval. */
165 interval = frame->dwDefaultFrameInterval;
166 uvc_trace(UVC_TRACE_FORMAT, "Using default frame interval %u.%u us "
167 "(%u.%u fps).\n", interval/10, interval%10, 10000000/interval,
168 (100000000/interval)%10);
169
170 /* Set the format index, frame index and frame interval. */
171 memset(probe, 0, sizeof *probe);
172 probe->bmHint = 1; /* dwFrameInterval */
173 probe->bFormatIndex = format->index;
174 probe->bFrameIndex = frame->bFrameIndex;
175 probe->dwFrameInterval = uvc_try_frame_interval(frame, interval);
176 /* Some webcams stall the probe control set request when the
177 * dwMaxVideoFrameSize field is set to zero. The UVC specification
178 * clearly states that the field is read-only from the host, so this
179 * is a webcam bug. Set dwMaxVideoFrameSize to the value reported by
180 * the webcam to work around the problem.
181 *
182 * The workaround could probably be enabled for all webcams, so the
183 * quirk can be removed if needed. It's currently useful to detect
184 * webcam bugs and fix them before they hit the market (providing
185 * developers test their webcams with the Linux driver as well as with
186 * the Windows driver).
187 */
188 if (video->dev->quirks & UVC_QUIRK_PROBE_EXTRAFIELDS)
189 probe->dwMaxVideoFrameSize =
190 video->streaming->ctrl.dwMaxVideoFrameSize;
191
192 /* Probe the device */
193 if ((ret = uvc_probe_video(video, probe)) < 0)
194 goto done;
195
196 fmt->fmt.pix.width = frame->wWidth;
197 fmt->fmt.pix.height = frame->wHeight;
198 fmt->fmt.pix.field = V4L2_FIELD_NONE;
199 fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
200 fmt->fmt.pix.sizeimage = probe->dwMaxVideoFrameSize;
201 fmt->fmt.pix.colorspace = format->colorspace;
202 fmt->fmt.pix.priv = 0;
203
204 if (uvc_format != NULL)
205 *uvc_format = format;
206 if (uvc_frame != NULL)
207 *uvc_frame = frame;
208
209done:
210 return ret;
211}
212
213static int uvc_v4l2_get_format(struct uvc_video_device *video,
214 struct v4l2_format *fmt)
215{
216 struct uvc_format *format = video->streaming->cur_format;
217 struct uvc_frame *frame = video->streaming->cur_frame;
218
219 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
220 return -EINVAL;
221
222 if (format == NULL || frame == NULL)
223 return -EINVAL;
224
225 fmt->fmt.pix.pixelformat = format->fcc;
226 fmt->fmt.pix.width = frame->wWidth;
227 fmt->fmt.pix.height = frame->wHeight;
228 fmt->fmt.pix.field = V4L2_FIELD_NONE;
229 fmt->fmt.pix.bytesperline = format->bpp * frame->wWidth / 8;
230 fmt->fmt.pix.sizeimage = video->streaming->ctrl.dwMaxVideoFrameSize;
231 fmt->fmt.pix.colorspace = format->colorspace;
232 fmt->fmt.pix.priv = 0;
233
234 return 0;
235}
236
237static int uvc_v4l2_set_format(struct uvc_video_device *video,
238 struct v4l2_format *fmt)
239{
240 struct uvc_streaming_control probe;
241 struct uvc_format *format;
242 struct uvc_frame *frame;
243 int ret;
244
245 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
246 return -EINVAL;
247
248 if (uvc_queue_streaming(&video->queue))
249 return -EBUSY;
250
251 ret = uvc_v4l2_try_format(video, fmt, &probe, &format, &frame);
252 if (ret < 0)
253 return ret;
254
255 if ((ret = uvc_set_video_ctrl(video, &probe, 0)) < 0)
256 return ret;
257
258 memcpy(&video->streaming->ctrl, &probe, sizeof probe);
259 video->streaming->cur_format = format;
260 video->streaming->cur_frame = frame;
261
262 return 0;
263}
264
265static int uvc_v4l2_get_streamparm(struct uvc_video_device *video,
266 struct v4l2_streamparm *parm)
267{
268 uint32_t numerator, denominator;
269
270 if (parm->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
271 return -EINVAL;
272
273 numerator = video->streaming->ctrl.dwFrameInterval;
274 denominator = 10000000;
275 uvc_simplify_fraction(&numerator, &denominator, 8, 333);
276
277 memset(parm, 0, sizeof *parm);
278 parm->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
279 parm->parm.capture.capability = V4L2_CAP_TIMEPERFRAME;
280 parm->parm.capture.capturemode = 0;
281 parm->parm.capture.timeperframe.numerator = numerator;
282 parm->parm.capture.timeperframe.denominator = denominator;
283 parm->parm.capture.extendedmode = 0;
284 parm->parm.capture.readbuffers = 0;
285
286 return 0;
287}
288
289static int uvc_v4l2_set_streamparm(struct uvc_video_device *video,
290 struct v4l2_streamparm *parm)
291{
292 struct uvc_frame *frame = video->streaming->cur_frame;
293 struct uvc_streaming_control probe;
294 uint32_t interval;
295 int ret;
296
297 if (parm->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
298 return -EINVAL;
299
300 if (uvc_queue_streaming(&video->queue))
301 return -EBUSY;
302
303 memcpy(&probe, &video->streaming->ctrl, sizeof probe);
304 interval = uvc_fraction_to_interval(
305 parm->parm.capture.timeperframe.numerator,
306 parm->parm.capture.timeperframe.denominator);
307
308 uvc_trace(UVC_TRACE_FORMAT, "Setting frame interval to %u/%u (%u).\n",
309 parm->parm.capture.timeperframe.numerator,
310 parm->parm.capture.timeperframe.denominator,
311 interval);
312 probe.dwFrameInterval = uvc_try_frame_interval(frame, interval);
313
314 /* Probe the device with the new settings. */
315 if ((ret = uvc_probe_video(video, &probe)) < 0)
316 return ret;
317
318 /* Commit the new settings. */
319 if ((ret = uvc_set_video_ctrl(video, &probe, 0)) < 0)
320 return ret;
321
322 memcpy(&video->streaming->ctrl, &probe, sizeof probe);
323
324 /* Return the actual frame period. */
325 parm->parm.capture.timeperframe.numerator = probe.dwFrameInterval;
326 parm->parm.capture.timeperframe.denominator = 10000000;
327 uvc_simplify_fraction(&parm->parm.capture.timeperframe.numerator,
328 &parm->parm.capture.timeperframe.denominator,
329 8, 333);
330
331 return 0;
332}
333
334/* ------------------------------------------------------------------------
335 * Privilege management
336 */
337
338/*
339 * Privilege management is the multiple-open implementation basis. The current
340 * implementation is completely transparent for the end-user and doesn't
341 * require explicit use of the VIDIOC_G_PRIORITY and VIDIOC_S_PRIORITY ioctls.
342 * Those ioctls enable finer control on the device (by making possible for a
343 * user to request exclusive access to a device), but are not mature yet.
344 * Switching to the V4L2 priority mechanism might be considered in the future
345 * if this situation changes.
346 *
347 * Each open instance of a UVC device can either be in a privileged or
348 * unprivileged state. Only a single instance can be in a privileged state at
349 * a given time. Trying to perform an operation which requires privileges will
350 * automatically acquire the required privileges if possible, or return -EBUSY
351 * otherwise. Privileges are dismissed when closing the instance.
352 *
353 * Operations which require privileges are:
354 *
355 * - VIDIOC_S_INPUT
356 * - VIDIOC_S_PARM
357 * - VIDIOC_S_FMT
358 * - VIDIOC_TRY_FMT
359 * - VIDIOC_REQBUFS
360 */
361static int uvc_acquire_privileges(struct uvc_fh *handle)
362{
363 int ret = 0;
364
365 /* Always succeed if the handle is already privileged. */
366 if (handle->state == UVC_HANDLE_ACTIVE)
367 return 0;
368
369 /* Check if the device already has a privileged handle. */
370 mutex_lock(&uvc_driver.open_mutex);
371 if (atomic_inc_return(&handle->device->active) != 1) {
372 atomic_dec(&handle->device->active);
373 ret = -EBUSY;
374 goto done;
375 }
376
377 handle->state = UVC_HANDLE_ACTIVE;
378
379done:
380 mutex_unlock(&uvc_driver.open_mutex);
381 return ret;
382}
383
384static void uvc_dismiss_privileges(struct uvc_fh *handle)
385{
386 if (handle->state == UVC_HANDLE_ACTIVE)
387 atomic_dec(&handle->device->active);
388
389 handle->state = UVC_HANDLE_PASSIVE;
390}
391
392static int uvc_has_privileges(struct uvc_fh *handle)
393{
394 return handle->state == UVC_HANDLE_ACTIVE;
395}
396
397/* ------------------------------------------------------------------------
398 * V4L2 file operations
399 */
400
401static int uvc_v4l2_open(struct inode *inode, struct file *file)
402{
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300403 struct uvc_video_device *video;
404 struct uvc_fh *handle;
405 int ret = 0;
406
407 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_open\n");
408 mutex_lock(&uvc_driver.open_mutex);
Hans Verkuilc170ecf2008-08-23 08:32:09 -0300409 video = video_drvdata(file);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300410
411 if (video->dev->state & UVC_DEV_DISCONNECTED) {
412 ret = -ENODEV;
413 goto done;
414 }
415
416 ret = usb_autopm_get_interface(video->dev->intf);
417 if (ret < 0)
418 goto done;
419
420 /* Create the device handle. */
421 handle = kzalloc(sizeof *handle, GFP_KERNEL);
422 if (handle == NULL) {
423 usb_autopm_put_interface(video->dev->intf);
424 ret = -ENOMEM;
425 goto done;
426 }
427
428 handle->device = video;
429 handle->state = UVC_HANDLE_PASSIVE;
430 file->private_data = handle;
431
432 kref_get(&video->dev->kref);
433
434done:
435 mutex_unlock(&uvc_driver.open_mutex);
436 return ret;
437}
438
439static int uvc_v4l2_release(struct inode *inode, struct file *file)
440{
Hans Verkuilc170ecf2008-08-23 08:32:09 -0300441 struct uvc_video_device *video = video_drvdata(file);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300442 struct uvc_fh *handle = (struct uvc_fh *)file->private_data;
443
444 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_release\n");
445
446 /* Only free resources if this is a privileged handle. */
447 if (uvc_has_privileges(handle)) {
448 uvc_video_enable(video, 0);
449
450 mutex_lock(&video->queue.mutex);
451 if (uvc_free_buffers(&video->queue) < 0)
452 uvc_printk(KERN_ERR, "uvc_v4l2_release: Unable to "
453 "free buffers.\n");
454 mutex_unlock(&video->queue.mutex);
455 }
456
457 /* Release the file handle. */
458 uvc_dismiss_privileges(handle);
459 kfree(handle);
460 file->private_data = NULL;
461
462 usb_autopm_put_interface(video->dev->intf);
463 kref_put(&video->dev->kref, uvc_delete);
464 return 0;
465}
466
Hans Verkuilf473bf72008-11-01 08:25:11 -0300467static int uvc_v4l2_do_ioctl(struct file *file, unsigned int cmd, void *arg)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300468{
469 struct video_device *vdev = video_devdata(file);
470 struct uvc_video_device *video = video_get_drvdata(vdev);
471 struct uvc_fh *handle = (struct uvc_fh *)file->private_data;
472 int ret = 0;
473
474 if (uvc_trace_param & UVC_TRACE_IOCTL)
475 v4l_printk_ioctl(cmd);
476
477 switch (cmd) {
478 /* Query capabilities */
479 case VIDIOC_QUERYCAP:
480 {
481 struct v4l2_capability *cap = arg;
482
483 memset(cap, 0, sizeof *cap);
484 strncpy(cap->driver, "uvcvideo", sizeof cap->driver);
485 strncpy(cap->card, vdev->name, 32);
486 strncpy(cap->bus_info, video->dev->udev->bus->bus_name,
487 sizeof cap->bus_info);
488 cap->version = DRIVER_VERSION_NUMBER;
489 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
490 | V4L2_CAP_STREAMING;
491 break;
492 }
493
494 /* Get, Set & Query control */
495 case VIDIOC_QUERYCTRL:
496 return uvc_query_v4l2_ctrl(video, arg);
497
498 case VIDIOC_G_CTRL:
499 {
500 struct v4l2_control *ctrl = arg;
501 struct v4l2_ext_control xctrl;
502
503 memset(&xctrl, 0, sizeof xctrl);
504 xctrl.id = ctrl->id;
505
506 uvc_ctrl_begin(video);
507 ret = uvc_ctrl_get(video, &xctrl);
508 uvc_ctrl_rollback(video);
509 if (ret >= 0)
510 ctrl->value = xctrl.value;
511 break;
512 }
513
514 case VIDIOC_S_CTRL:
515 {
516 struct v4l2_control *ctrl = arg;
517 struct v4l2_ext_control xctrl;
518
519 memset(&xctrl, 0, sizeof xctrl);
520 xctrl.id = ctrl->id;
521 xctrl.value = ctrl->value;
522
523 uvc_ctrl_begin(video);
524 ret = uvc_ctrl_set(video, &xctrl);
525 if (ret < 0) {
526 uvc_ctrl_rollback(video);
527 return ret;
528 }
529 ret = uvc_ctrl_commit(video);
530 break;
531 }
532
533 case VIDIOC_QUERYMENU:
534 return uvc_v4l2_query_menu(video, arg);
535
536 case VIDIOC_G_EXT_CTRLS:
537 {
538 struct v4l2_ext_controls *ctrls = arg;
539 struct v4l2_ext_control *ctrl = ctrls->controls;
540 unsigned int i;
541
542 uvc_ctrl_begin(video);
543 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
544 ret = uvc_ctrl_get(video, ctrl);
545 if (ret < 0) {
546 uvc_ctrl_rollback(video);
547 ctrls->error_idx = i;
548 return ret;
549 }
550 }
551 ctrls->error_idx = 0;
552 ret = uvc_ctrl_rollback(video);
553 break;
554 }
555
556 case VIDIOC_S_EXT_CTRLS:
557 case VIDIOC_TRY_EXT_CTRLS:
558 {
559 struct v4l2_ext_controls *ctrls = arg;
560 struct v4l2_ext_control *ctrl = ctrls->controls;
561 unsigned int i;
562
563 ret = uvc_ctrl_begin(video);
564 if (ret < 0)
565 return ret;
566
567 for (i = 0; i < ctrls->count; ++ctrl, ++i) {
568 ret = uvc_ctrl_set(video, ctrl);
569 if (ret < 0) {
570 uvc_ctrl_rollback(video);
571 ctrls->error_idx = i;
572 return ret;
573 }
574 }
575
576 ctrls->error_idx = 0;
577
578 if (cmd == VIDIOC_S_EXT_CTRLS)
579 ret = uvc_ctrl_commit(video);
580 else
581 ret = uvc_ctrl_rollback(video);
582 break;
583 }
584
585 /* Get, Set & Enum input */
586 case VIDIOC_ENUMINPUT:
587 {
588 const struct uvc_entity *selector = video->selector;
589 struct v4l2_input *input = arg;
590 struct uvc_entity *iterm = NULL;
591 u32 index = input->index;
592 int pin = 0;
593
594 if (selector == NULL ||
595 (video->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
596 if (index != 0)
597 return -EINVAL;
598 iterm = list_first_entry(&video->iterms,
599 struct uvc_entity, chain);
600 pin = iterm->id;
601 } else if (pin < selector->selector.bNrInPins) {
602 pin = selector->selector.baSourceID[index];
603 list_for_each_entry(iterm, video->iterms.next, chain) {
604 if (iterm->id == pin)
605 break;
606 }
607 }
608
609 if (iterm == NULL || iterm->id != pin)
610 return -EINVAL;
611
612 memset(input, 0, sizeof *input);
613 input->index = index;
614 strncpy(input->name, iterm->name, sizeof input->name);
615 if (UVC_ENTITY_TYPE(iterm) == ITT_CAMERA)
616 input->type = V4L2_INPUT_TYPE_CAMERA;
617 break;
618 }
619
620 case VIDIOC_G_INPUT:
621 {
622 u8 input;
623
624 if (video->selector == NULL ||
625 (video->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
626 *(int *)arg = 0;
627 break;
628 }
629
630 ret = uvc_query_ctrl(video->dev, GET_CUR, video->selector->id,
631 video->dev->intfnum, SU_INPUT_SELECT_CONTROL,
632 &input, 1);
633 if (ret < 0)
634 return ret;
635
636 *(int *)arg = input - 1;
637 break;
638 }
639
640 case VIDIOC_S_INPUT:
641 {
642 u8 input = *(u32 *)arg + 1;
643
644 if ((ret = uvc_acquire_privileges(handle)) < 0)
645 return ret;
646
647 if (video->selector == NULL ||
648 (video->dev->quirks & UVC_QUIRK_IGNORE_SELECTOR_UNIT)) {
649 if (input != 1)
650 return -EINVAL;
651 break;
652 }
653
654 if (input > video->selector->selector.bNrInPins)
655 return -EINVAL;
656
657 return uvc_query_ctrl(video->dev, SET_CUR, video->selector->id,
658 video->dev->intfnum, SU_INPUT_SELECT_CONTROL,
659 &input, 1);
660 }
661
662 /* Try, Get, Set & Enum format */
663 case VIDIOC_ENUM_FMT:
664 {
665 struct v4l2_fmtdesc *fmt = arg;
666 struct uvc_format *format;
667
668 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE ||
669 fmt->index >= video->streaming->nformats)
670 return -EINVAL;
671
672 format = &video->streaming->format[fmt->index];
673 fmt->flags = 0;
674 if (format->flags & UVC_FMT_FLAG_COMPRESSED)
675 fmt->flags |= V4L2_FMT_FLAG_COMPRESSED;
676 strncpy(fmt->description, format->name,
677 sizeof fmt->description);
678 fmt->description[sizeof fmt->description - 1] = 0;
679 fmt->pixelformat = format->fcc;
680 break;
681 }
682
683 case VIDIOC_TRY_FMT:
684 {
685 struct uvc_streaming_control probe;
686
687 if ((ret = uvc_acquire_privileges(handle)) < 0)
688 return ret;
689
690 return uvc_v4l2_try_format(video, arg, &probe, NULL, NULL);
691 }
692
693 case VIDIOC_S_FMT:
694 if ((ret = uvc_acquire_privileges(handle)) < 0)
695 return ret;
696
697 return uvc_v4l2_set_format(video, arg);
698
699 case VIDIOC_G_FMT:
700 return uvc_v4l2_get_format(video, arg);
701
702 /* Frame size enumeration */
703 case VIDIOC_ENUM_FRAMESIZES:
704 {
705 struct v4l2_frmsizeenum *fsize = arg;
706 struct uvc_format *format = NULL;
707 struct uvc_frame *frame;
708 int i;
709
710 /* Look for the given pixel format */
711 for (i = 0; i < video->streaming->nformats; i++) {
712 if (video->streaming->format[i].fcc ==
713 fsize->pixel_format) {
714 format = &video->streaming->format[i];
715 break;
716 }
717 }
718 if (format == NULL)
719 return -EINVAL;
720
721 if (fsize->index >= format->nframes)
722 return -EINVAL;
723
724 frame = &format->frame[fsize->index];
725 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
726 fsize->discrete.width = frame->wWidth;
727 fsize->discrete.height = frame->wHeight;
728 break;
729 }
730
731 /* Frame interval enumeration */
732 case VIDIOC_ENUM_FRAMEINTERVALS:
733 {
734 struct v4l2_frmivalenum *fival = arg;
735 struct uvc_format *format = NULL;
736 struct uvc_frame *frame = NULL;
737 int i;
738
739 /* Look for the given pixel format and frame size */
740 for (i = 0; i < video->streaming->nformats; i++) {
741 if (video->streaming->format[i].fcc ==
742 fival->pixel_format) {
743 format = &video->streaming->format[i];
744 break;
745 }
746 }
747 if (format == NULL)
748 return -EINVAL;
749
750 for (i = 0; i < format->nframes; i++) {
751 if (format->frame[i].wWidth == fival->width &&
752 format->frame[i].wHeight == fival->height) {
753 frame = &format->frame[i];
754 break;
755 }
756 }
757 if (frame == NULL)
758 return -EINVAL;
759
760 if (frame->bFrameIntervalType) {
761 if (fival->index >= frame->bFrameIntervalType)
762 return -EINVAL;
763
764 fival->type = V4L2_FRMIVAL_TYPE_DISCRETE;
765 fival->discrete.numerator =
766 frame->dwFrameInterval[fival->index];
767 fival->discrete.denominator = 10000000;
768 uvc_simplify_fraction(&fival->discrete.numerator,
769 &fival->discrete.denominator, 8, 333);
770 } else {
771 fival->type = V4L2_FRMIVAL_TYPE_STEPWISE;
772 fival->stepwise.min.numerator =
773 frame->dwFrameInterval[0];
774 fival->stepwise.min.denominator = 10000000;
775 fival->stepwise.max.numerator =
776 frame->dwFrameInterval[1];
777 fival->stepwise.max.denominator = 10000000;
778 fival->stepwise.step.numerator =
779 frame->dwFrameInterval[2];
780 fival->stepwise.step.denominator = 10000000;
781 uvc_simplify_fraction(&fival->stepwise.min.numerator,
782 &fival->stepwise.min.denominator, 8, 333);
783 uvc_simplify_fraction(&fival->stepwise.max.numerator,
784 &fival->stepwise.max.denominator, 8, 333);
785 uvc_simplify_fraction(&fival->stepwise.step.numerator,
786 &fival->stepwise.step.denominator, 8, 333);
787 }
788 break;
789 }
790
791 /* Get & Set streaming parameters */
792 case VIDIOC_G_PARM:
793 return uvc_v4l2_get_streamparm(video, arg);
794
795 case VIDIOC_S_PARM:
796 if ((ret = uvc_acquire_privileges(handle)) < 0)
797 return ret;
798
799 return uvc_v4l2_set_streamparm(video, arg);
800
801 /* Cropping and scaling */
802 case VIDIOC_CROPCAP:
803 {
804 struct v4l2_cropcap *ccap = arg;
805 struct uvc_frame *frame = video->streaming->cur_frame;
806
807 if (ccap->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
808 return -EINVAL;
809
810 ccap->bounds.left = 0;
811 ccap->bounds.top = 0;
812 ccap->bounds.width = frame->wWidth;
813 ccap->bounds.height = frame->wHeight;
814
815 ccap->defrect = ccap->bounds;
816
817 ccap->pixelaspect.numerator = 1;
818 ccap->pixelaspect.denominator = 1;
819 break;
820 }
821
822 case VIDIOC_G_CROP:
823 case VIDIOC_S_CROP:
824 return -EINVAL;
825
826 /* Buffers & streaming */
827 case VIDIOC_REQBUFS:
828 {
829 struct v4l2_requestbuffers *rb = arg;
830 unsigned int bufsize =
831 video->streaming->ctrl.dwMaxVideoFrameSize;
832
833 if (rb->type != V4L2_BUF_TYPE_VIDEO_CAPTURE ||
834 rb->memory != V4L2_MEMORY_MMAP)
835 return -EINVAL;
836
837 if ((ret = uvc_acquire_privileges(handle)) < 0)
838 return ret;
839
840 ret = uvc_alloc_buffers(&video->queue, rb->count, bufsize);
841 if (ret < 0)
842 return ret;
843
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300844 rb->count = ret;
845 ret = 0;
846 break;
847 }
848
849 case VIDIOC_QUERYBUF:
850 {
851 struct v4l2_buffer *buf = arg;
852
853 if (buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
854 return -EINVAL;
855
856 if (!uvc_has_privileges(handle))
857 return -EBUSY;
858
859 return uvc_query_buffer(&video->queue, buf);
860 }
861
862 case VIDIOC_QBUF:
863 if (!uvc_has_privileges(handle))
864 return -EBUSY;
865
866 return uvc_queue_buffer(&video->queue, arg);
867
868 case VIDIOC_DQBUF:
869 if (!uvc_has_privileges(handle))
870 return -EBUSY;
871
872 return uvc_dequeue_buffer(&video->queue, arg,
873 file->f_flags & O_NONBLOCK);
874
875 case VIDIOC_STREAMON:
876 {
877 int *type = arg;
878
879 if (*type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
880 return -EINVAL;
881
882 if (!uvc_has_privileges(handle))
883 return -EBUSY;
884
885 if ((ret = uvc_video_enable(video, 1)) < 0)
886 return ret;
887 break;
888 }
889
890 case VIDIOC_STREAMOFF:
891 {
892 int *type = arg;
893
894 if (*type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
895 return -EINVAL;
896
897 if (!uvc_has_privileges(handle))
898 return -EBUSY;
899
900 return uvc_video_enable(video, 0);
901 }
902
903 /* Analog video standards make no sense for digital cameras. */
904 case VIDIOC_ENUMSTD:
905 case VIDIOC_QUERYSTD:
906 case VIDIOC_G_STD:
907 case VIDIOC_S_STD:
908
909 case VIDIOC_OVERLAY:
910
911 case VIDIOC_ENUMAUDIO:
912 case VIDIOC_ENUMAUDOUT:
913
914 case VIDIOC_ENUMOUTPUT:
915 uvc_trace(UVC_TRACE_IOCTL, "Unsupported ioctl 0x%08x\n", cmd);
916 return -EINVAL;
917
918 /* Dynamic controls. */
919 case UVCIOC_CTRL_ADD:
920 {
921 struct uvc_xu_control_info *xinfo = arg;
922 struct uvc_control_info *info;
923
924 if (!capable(CAP_SYS_ADMIN))
925 return -EPERM;
926
927 info = kmalloc(sizeof *info, GFP_KERNEL);
928 if (info == NULL)
929 return -ENOMEM;
930
931 memcpy(info->entity, xinfo->entity, sizeof info->entity);
932 info->index = xinfo->index;
933 info->selector = xinfo->selector;
934 info->size = xinfo->size;
935 info->flags = xinfo->flags;
936
937 info->flags |= UVC_CONTROL_GET_MIN | UVC_CONTROL_GET_MAX |
938 UVC_CONTROL_GET_RES | UVC_CONTROL_GET_DEF;
939
940 ret = uvc_ctrl_add_info(info);
941 if (ret < 0)
942 kfree(info);
943 break;
944 }
945
946 case UVCIOC_CTRL_MAP:
947 {
948 struct uvc_xu_control_mapping *xmap = arg;
949 struct uvc_control_mapping *map;
950
951 if (!capable(CAP_SYS_ADMIN))
952 return -EPERM;
953
954 map = kmalloc(sizeof *map, GFP_KERNEL);
955 if (map == NULL)
956 return -ENOMEM;
957
958 map->id = xmap->id;
959 memcpy(map->name, xmap->name, sizeof map->name);
960 memcpy(map->entity, xmap->entity, sizeof map->entity);
961 map->selector = xmap->selector;
962 map->size = xmap->size;
963 map->offset = xmap->offset;
964 map->v4l2_type = xmap->v4l2_type;
965 map->data_type = xmap->data_type;
966
967 ret = uvc_ctrl_add_mapping(map);
968 if (ret < 0)
969 kfree(map);
970 break;
971 }
972
973 case UVCIOC_CTRL_GET:
974 return uvc_xu_ctrl_query(video, arg, 0);
975
976 case UVCIOC_CTRL_SET:
977 return uvc_xu_ctrl_query(video, arg, 1);
978
979 default:
Mauro Carvalho Chehabb1f88402008-10-21 11:27:20 -0300980 if ((ret = v4l_compat_translate_ioctl(file, cmd, arg,
Hans Verkuilf473bf72008-11-01 08:25:11 -0300981 uvc_v4l2_do_ioctl)) == -ENOIOCTLCMD)
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300982 uvc_trace(UVC_TRACE_IOCTL, "Unknown ioctl 0x%08x\n",
983 cmd);
984 return ret;
985 }
986
987 return ret;
988}
989
990static int uvc_v4l2_ioctl(struct inode *inode, struct file *file,
991 unsigned int cmd, unsigned long arg)
992{
993 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_ioctl\n");
Hans Verkuilf473bf72008-11-01 08:25:11 -0300994 return video_usercopy(file, cmd, arg, uvc_v4l2_do_ioctl);
Laurent Pinchartc0efd232008-06-30 15:04:50 -0300995}
996
997static ssize_t uvc_v4l2_read(struct file *file, char __user *data,
998 size_t count, loff_t *ppos)
999{
1000 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_read: not implemented.\n");
1001 return -ENODEV;
1002}
1003
1004/*
1005 * VMA operations.
1006 */
1007static void uvc_vm_open(struct vm_area_struct *vma)
1008{
1009 struct uvc_buffer *buffer = vma->vm_private_data;
1010 buffer->vma_use_count++;
1011}
1012
1013static void uvc_vm_close(struct vm_area_struct *vma)
1014{
1015 struct uvc_buffer *buffer = vma->vm_private_data;
1016 buffer->vma_use_count--;
1017}
1018
1019static struct vm_operations_struct uvc_vm_ops = {
1020 .open = uvc_vm_open,
1021 .close = uvc_vm_close,
1022};
1023
1024static int uvc_v4l2_mmap(struct file *file, struct vm_area_struct *vma)
1025{
Hans Verkuilc170ecf2008-08-23 08:32:09 -03001026 struct uvc_video_device *video = video_drvdata(file);
Andrew Morton6f80e1b2008-07-04 06:33:23 -03001027 struct uvc_buffer *uninitialized_var(buffer);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001028 struct page *page;
1029 unsigned long addr, start, size;
1030 unsigned int i;
1031 int ret = 0;
1032
1033 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_mmap\n");
1034
1035 start = vma->vm_start;
1036 size = vma->vm_end - vma->vm_start;
1037
1038 mutex_lock(&video->queue.mutex);
1039
1040 for (i = 0; i < video->queue.count; ++i) {
1041 buffer = &video->queue.buffer[i];
1042 if ((buffer->buf.m.offset >> PAGE_SHIFT) == vma->vm_pgoff)
1043 break;
1044 }
1045
1046 if (i == video->queue.count || size != video->queue.buf_size) {
1047 ret = -EINVAL;
1048 goto done;
1049 }
1050
1051 /*
1052 * VM_IO marks the area as being an mmaped region for I/O to a
1053 * device. It also prevents the region from being core dumped.
1054 */
1055 vma->vm_flags |= VM_IO;
1056
1057 addr = (unsigned long)video->queue.mem + buffer->buf.m.offset;
1058 while (size > 0) {
1059 page = vmalloc_to_page((void *)addr);
1060 if ((ret = vm_insert_page(vma, start, page)) < 0)
1061 goto done;
1062
1063 start += PAGE_SIZE;
1064 addr += PAGE_SIZE;
1065 size -= PAGE_SIZE;
1066 }
1067
1068 vma->vm_ops = &uvc_vm_ops;
1069 vma->vm_private_data = buffer;
1070 uvc_vm_open(vma);
1071
1072done:
1073 mutex_unlock(&video->queue.mutex);
1074 return ret;
1075}
1076
1077static unsigned int uvc_v4l2_poll(struct file *file, poll_table *wait)
1078{
Hans Verkuilc170ecf2008-08-23 08:32:09 -03001079 struct uvc_video_device *video = video_drvdata(file);
Laurent Pinchartc0efd232008-06-30 15:04:50 -03001080
1081 uvc_trace(UVC_TRACE_CALLS, "uvc_v4l2_poll\n");
1082
1083 return uvc_queue_poll(&video->queue, file, wait);
1084}
1085
1086struct file_operations uvc_fops = {
1087 .owner = THIS_MODULE,
1088 .open = uvc_v4l2_open,
1089 .release = uvc_v4l2_release,
1090 .ioctl = uvc_v4l2_ioctl,
1091 .compat_ioctl = v4l_compat_ioctl32,
1092 .llseek = no_llseek,
1093 .read = uvc_v4l2_read,
1094 .mmap = uvc_v4l2_mmap,
1095 .poll = uvc_v4l2_poll,
1096};
Hans Verkuilf87086e2008-07-18 00:50:58 -03001097