4 * Copyright (C) 2012 Ezequiel Garcia
5 * <elezegarcia--a.t--gmail.com>
7 * Based on Easycap driver by R.M. Thomas
8 * Copyright (C) 2010 R.M. Thomas
9 * <rmthomas--a.t--sciolus.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
23 #include <linux/module.h>
24 #include <linux/usb.h>
26 #include <linux/slab.h>
28 #include <linux/videodev2.h>
29 #include <media/v4l2-device.h>
30 #include <media/v4l2-common.h>
31 #include <media/v4l2-ioctl.h>
32 #include <media/v4l2-fh.h>
33 #include <media/v4l2-event.h>
34 #include <media/videobuf2-vmalloc.h>
36 #include <media/saa7115.h>
39 #include "stk1160-reg.h"
41 static bool keep_buffers;
42 module_param(keep_buffers, bool, 0644);
43 MODULE_PARM_DESC(keep_buffers, "don't release buffers upon stop streaming");
45 /* supported video standards */
46 static struct stk1160_fmt format[] = {
48 .name = "16 bpp YUY2, 4:2:2, packed",
49 .fourcc = V4L2_PIX_FMT_UYVY,
54 static void stk1160_set_std(struct stk1160 *dev)
58 static struct regval std525[] = {
63 {STK116_CFSPO_STX_L, 0x0000},
64 {STK116_CFSPO_STX_H, 0x0000},
65 {STK116_CFSPO_STY_L, 0x0003},
66 {STK116_CFSPO_STY_H, 0x0000},
69 {STK116_CFEPO_ENX_L, 0x05a0},
70 {STK116_CFEPO_ENX_H, 0x0005},
71 {STK116_CFEPO_ENY_L, 0x00f3},
72 {STK116_CFEPO_ENY_H, 0x0000},
77 static struct regval std625[] = {
81 /* TODO: Each line of frame has some junk at the end */
83 {STK116_CFSPO, 0x0000},
84 {STK116_CFSPO+1, 0x0000},
85 {STK116_CFSPO+2, 0x0001},
86 {STK116_CFSPO+3, 0x0000},
89 {STK116_CFEPO, 0x05a0},
90 {STK116_CFEPO+1, 0x0005},
91 {STK116_CFEPO+2, 0x0121},
92 {STK116_CFEPO+3, 0x0001},
97 if (dev->norm & V4L2_STD_525_60) {
98 stk1160_dbg("registers to NTSC like standard\n");
99 for (i = 0; std525[i].reg != 0xffff; i++)
100 stk1160_write_reg(dev, std525[i].reg, std525[i].val);
102 stk1160_dbg("registers to PAL like standard\n");
103 for (i = 0; std625[i].reg != 0xffff; i++)
104 stk1160_write_reg(dev, std625[i].reg, std625[i].val);
110 * Set a new alternate setting.
111 * Returns true is dev->max_pkt_size has changed, false otherwise.
113 static bool stk1160_set_alternate(struct stk1160 *dev)
115 int i, prev_alt = dev->alt;
116 unsigned int min_pkt_size;
120 * If we don't set right alternate,
121 * then we will get a green screen with junk.
123 min_pkt_size = STK1160_MIN_PKT_SIZE;
125 for (i = 0; i < dev->num_alt; i++) {
126 /* stop when the selected alt setting offers enough bandwidth */
127 if (dev->alt_max_pkt_size[i] >= min_pkt_size) {
131 * otherwise make sure that we end up with the maximum bandwidth
132 * because the min_pkt_size equation might be wrong...
134 } else if (dev->alt_max_pkt_size[i] >
135 dev->alt_max_pkt_size[dev->alt])
139 stk1160_info("setting alternate %d\n", dev->alt);
141 if (dev->alt != prev_alt) {
142 stk1160_dbg("minimum isoc packet size: %u (alt=%d)\n",
143 min_pkt_size, dev->alt);
144 stk1160_dbg("setting alt %d with wMaxPacketSize=%u\n",
145 dev->alt, dev->alt_max_pkt_size[dev->alt]);
146 usb_set_interface(dev->udev, 0, dev->alt);
149 new_pkt_size = dev->max_pkt_size != dev->alt_max_pkt_size[dev->alt];
150 dev->max_pkt_size = dev->alt_max_pkt_size[dev->alt];
155 static int stk1160_start_streaming(struct stk1160 *dev)
161 /* Check device presence */
165 if (mutex_lock_interruptible(&dev->v4l_lock))
168 * For some reason it is mandatory to set alternate *first*
169 * and only *then* initialize isoc urbs.
170 * Someone please explain me why ;)
172 new_pkt_size = stk1160_set_alternate(dev);
175 * We (re)allocate isoc urbs if:
176 * there is no allocated isoc urbs, OR
177 * a new dev->max_pkt_size is detected
179 if (!dev->isoc_ctl.num_bufs || new_pkt_size) {
180 rc = stk1160_alloc_isoc(dev);
185 /* submit urbs and enables IRQ */
186 for (i = 0; i < dev->isoc_ctl.num_bufs; i++) {
187 rc = usb_submit_urb(dev->isoc_ctl.urb[i], GFP_KERNEL);
189 stk1160_err("cannot submit urb[%d] (%d)\n", i, rc);
195 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_stream, 1);
198 stk1160_write_reg(dev, STK1160_DCTRL, 0xb3);
199 stk1160_write_reg(dev, STK1160_DCTRL+3, 0x00);
201 stk1160_dbg("streaming started\n");
203 mutex_unlock(&dev->v4l_lock);
208 stk1160_uninit_isoc(dev);
210 usb_set_interface(dev->udev, 0, 0);
211 stk1160_clear_queue(dev);
213 mutex_unlock(&dev->v4l_lock);
218 /* Must be called with v4l_lock hold */
219 static void stk1160_stop_hw(struct stk1160 *dev)
221 /* If the device is not physically present, there is nothing to do */
225 /* set alternate 0 */
227 stk1160_info("setting alternate %d\n", dev->alt);
228 usb_set_interface(dev->udev, 0, 0);
231 stk1160_write_reg(dev, STK1160_DCTRL, 0x00);
232 stk1160_write_reg(dev, STK1160_DCTRL+3, 0x00);
235 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_stream, 0);
238 static int stk1160_stop_streaming(struct stk1160 *dev)
240 if (mutex_lock_interruptible(&dev->v4l_lock))
244 * Once URBs are cancelled, the URB complete handler
245 * won't be running. This is required to safely release the
246 * current buffer (dev->isoc_ctl.buf).
248 stk1160_cancel_isoc(dev);
251 * It is possible to keep buffers around using a module parameter.
252 * This is intended to avoid memory fragmentation.
255 stk1160_free_isoc(dev);
257 stk1160_stop_hw(dev);
259 stk1160_clear_queue(dev);
261 stk1160_dbg("streaming stopped\n");
263 mutex_unlock(&dev->v4l_lock);
268 static struct v4l2_file_operations stk1160_fops = {
269 .owner = THIS_MODULE,
270 .open = v4l2_fh_open,
271 .release = vb2_fop_release,
272 .read = vb2_fop_read,
273 .poll = vb2_fop_poll,
274 .mmap = vb2_fop_mmap,
275 .unlocked_ioctl = video_ioctl2,
281 static int vidioc_querycap(struct file *file,
282 void *priv, struct v4l2_capability *cap)
284 struct stk1160 *dev = video_drvdata(file);
286 strcpy(cap->driver, "stk1160");
287 strcpy(cap->card, "stk1160");
288 usb_make_path(dev->udev, cap->bus_info, sizeof(cap->bus_info));
290 V4L2_CAP_VIDEO_CAPTURE |
293 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
297 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
298 struct v4l2_fmtdesc *f)
303 strlcpy(f->description, format[f->index].name, sizeof(f->description));
304 f->pixelformat = format[f->index].fourcc;
308 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
309 struct v4l2_format *f)
311 struct stk1160 *dev = video_drvdata(file);
313 f->fmt.pix.width = dev->width;
314 f->fmt.pix.height = dev->height;
315 f->fmt.pix.field = V4L2_FIELD_INTERLACED;
316 f->fmt.pix.pixelformat = dev->fmt->fourcc;
317 f->fmt.pix.bytesperline = dev->width * 2;
318 f->fmt.pix.sizeimage = dev->height * f->fmt.pix.bytesperline;
319 f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
324 static int vidioc_try_fmt_vid_cap(struct file *file, void *priv,
325 struct v4l2_format *f)
327 struct stk1160 *dev = video_drvdata(file);
330 * User can't choose size at his own will,
331 * so we just return him the current size chosen
332 * at standard selection.
333 * TODO: Implement frame scaling?
336 f->fmt.pix.pixelformat = dev->fmt->fourcc;
337 f->fmt.pix.width = dev->width;
338 f->fmt.pix.height = dev->height;
339 f->fmt.pix.field = V4L2_FIELD_INTERLACED;
340 f->fmt.pix.bytesperline = dev->width * 2;
341 f->fmt.pix.sizeimage = dev->height * f->fmt.pix.bytesperline;
342 f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
347 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
348 struct v4l2_format *f)
350 struct stk1160 *dev = video_drvdata(file);
351 struct vb2_queue *q = &dev->vb_vidq;
356 vidioc_try_fmt_vid_cap(file, priv, f);
358 /* We don't support any format changes */
363 static int vidioc_querystd(struct file *file, void *priv, v4l2_std_id *norm)
365 struct stk1160 *dev = video_drvdata(file);
366 v4l2_device_call_all(&dev->v4l2_dev, 0, video, querystd, norm);
370 static int vidioc_g_std(struct file *file, void *priv, v4l2_std_id *norm)
372 struct stk1160 *dev = video_drvdata(file);
378 static int vidioc_s_std(struct file *file, void *priv, v4l2_std_id norm)
380 struct stk1160 *dev = video_drvdata(file);
381 struct vb2_queue *q = &dev->vb_vidq;
383 if (dev->norm == norm)
389 /* Check device presence */
393 /* We need to set this now, before we call stk1160_set_std */
396 /* This is taken from saa7115 video decoder */
397 if (dev->norm & V4L2_STD_525_60) {
400 } else if (dev->norm & V4L2_STD_625_50) {
404 stk1160_err("invalid standard\n");
408 stk1160_set_std(dev);
410 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_std,
417 static int vidioc_enum_input(struct file *file, void *priv,
418 struct v4l2_input *i)
420 struct stk1160 *dev = video_drvdata(file);
422 if (i->index > STK1160_MAX_INPUT)
425 /* S-Video special handling */
426 if (i->index == STK1160_SVIDEO_INPUT)
427 sprintf(i->name, "S-Video");
429 sprintf(i->name, "Composite%d", i->index);
431 i->type = V4L2_INPUT_TYPE_CAMERA;
432 i->std = dev->vdev.tvnorms;
436 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
438 struct stk1160 *dev = video_drvdata(file);
443 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
445 struct stk1160 *dev = video_drvdata(file);
447 if (i > STK1160_MAX_INPUT)
452 stk1160_select_input(dev);
457 #ifdef CONFIG_VIDEO_ADV_DEBUG
458 static int vidioc_g_register(struct file *file, void *priv,
459 struct v4l2_dbg_register *reg)
461 struct stk1160 *dev = video_drvdata(file);
466 rc = stk1160_read_reg(dev, reg->reg, &val);
473 static int vidioc_s_register(struct file *file, void *priv,
474 const struct v4l2_dbg_register *reg)
476 struct stk1160 *dev = video_drvdata(file);
479 return stk1160_write_reg(dev, reg->reg, reg->val);
483 static const struct v4l2_ioctl_ops stk1160_ioctl_ops = {
484 .vidioc_querycap = vidioc_querycap,
485 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
486 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
487 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
488 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
489 .vidioc_querystd = vidioc_querystd,
490 .vidioc_g_std = vidioc_g_std,
491 .vidioc_s_std = vidioc_s_std,
492 .vidioc_enum_input = vidioc_enum_input,
493 .vidioc_g_input = vidioc_g_input,
494 .vidioc_s_input = vidioc_s_input,
496 /* vb2 takes care of these */
497 .vidioc_reqbufs = vb2_ioctl_reqbufs,
498 .vidioc_querybuf = vb2_ioctl_querybuf,
499 .vidioc_qbuf = vb2_ioctl_qbuf,
500 .vidioc_dqbuf = vb2_ioctl_dqbuf,
501 .vidioc_streamon = vb2_ioctl_streamon,
502 .vidioc_streamoff = vb2_ioctl_streamoff,
503 .vidioc_expbuf = vb2_ioctl_expbuf,
505 .vidioc_log_status = v4l2_ctrl_log_status,
506 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
507 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
509 #ifdef CONFIG_VIDEO_ADV_DEBUG
510 .vidioc_g_register = vidioc_g_register,
511 .vidioc_s_register = vidioc_s_register,
515 /********************************************************************/
518 * Videobuf2 operations
520 static int queue_setup(struct vb2_queue *vq, const struct v4l2_format *v4l_fmt,
521 unsigned int *nbuffers, unsigned int *nplanes,
522 unsigned int sizes[], void *alloc_ctxs[])
524 struct stk1160 *dev = vb2_get_drv_priv(vq);
527 size = dev->width * dev->height * 2;
530 * Here we can change the number of buffers being requested.
531 * So, we set a minimum and a maximum like this:
533 *nbuffers = clamp_t(unsigned int, *nbuffers,
534 STK1160_MIN_VIDEO_BUFFERS, STK1160_MAX_VIDEO_BUFFERS);
536 /* This means a packed colorformat */
541 stk1160_info("%s: buffer count %d, each %ld bytes\n",
542 __func__, *nbuffers, size);
547 static void buffer_queue(struct vb2_buffer *vb)
550 struct stk1160 *dev = vb2_get_drv_priv(vb->vb2_queue);
551 struct stk1160_buffer *buf =
552 container_of(vb, struct stk1160_buffer, vb);
554 spin_lock_irqsave(&dev->buf_lock, flags);
557 * If the device is disconnected return the buffer to userspace
558 * directly. The next QBUF call will fail with -ENODEV.
560 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
563 buf->mem = vb2_plane_vaddr(vb, 0);
564 buf->length = vb2_plane_size(vb, 0);
569 * If buffer length is less from expected then we return
570 * the buffer to userspace directly.
572 if (buf->length < dev->width * dev->height * 2)
573 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
575 list_add_tail(&buf->list, &dev->avail_bufs);
578 spin_unlock_irqrestore(&dev->buf_lock, flags);
581 static int start_streaming(struct vb2_queue *vq, unsigned int count)
583 struct stk1160 *dev = vb2_get_drv_priv(vq);
584 return stk1160_start_streaming(dev);
587 /* abort streaming and wait for last buffer */
588 static void stop_streaming(struct vb2_queue *vq)
590 struct stk1160 *dev = vb2_get_drv_priv(vq);
591 stk1160_stop_streaming(dev);
594 static struct vb2_ops stk1160_video_qops = {
595 .queue_setup = queue_setup,
596 .buf_queue = buffer_queue,
597 .start_streaming = start_streaming,
598 .stop_streaming = stop_streaming,
599 .wait_prepare = vb2_ops_wait_prepare,
600 .wait_finish = vb2_ops_wait_finish,
603 static struct video_device v4l_template = {
605 .tvnorms = V4L2_STD_525_60 | V4L2_STD_625_50,
606 .fops = &stk1160_fops,
607 .ioctl_ops = &stk1160_ioctl_ops,
608 .release = video_device_release_empty,
611 /********************************************************************/
613 /* Must be called with both v4l_lock and vb_queue_lock hold */
614 void stk1160_clear_queue(struct stk1160 *dev)
616 struct stk1160_buffer *buf;
619 /* Release all active buffers */
620 spin_lock_irqsave(&dev->buf_lock, flags);
621 while (!list_empty(&dev->avail_bufs)) {
622 buf = list_first_entry(&dev->avail_bufs,
623 struct stk1160_buffer, list);
624 list_del(&buf->list);
625 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
626 stk1160_info("buffer [%p/%d] aborted\n",
627 buf, buf->vb.v4l2_buf.index);
630 /* It's important to release the current buffer */
631 if (dev->isoc_ctl.buf) {
632 buf = dev->isoc_ctl.buf;
633 dev->isoc_ctl.buf = NULL;
635 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
636 stk1160_info("buffer [%p/%d] aborted\n",
637 buf, buf->vb.v4l2_buf.index);
639 spin_unlock_irqrestore(&dev->buf_lock, flags);
642 int stk1160_vb2_setup(struct stk1160 *dev)
648 q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
649 q->io_modes = VB2_READ | VB2_MMAP | VB2_USERPTR | VB2_DMABUF;
651 q->buf_struct_size = sizeof(struct stk1160_buffer);
652 q->ops = &stk1160_video_qops;
653 q->mem_ops = &vb2_vmalloc_memops;
654 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
656 rc = vb2_queue_init(q);
660 /* initialize video dma queue */
661 INIT_LIST_HEAD(&dev->avail_bufs);
666 int stk1160_video_register(struct stk1160 *dev)
670 /* Initialize video_device with a template structure */
671 dev->vdev = v4l_template;
672 dev->vdev.queue = &dev->vb_vidq;
675 * Provide mutexes for v4l2 core and for videobuf2 queue.
676 * It will be used to protect *only* v4l2 ioctls.
678 dev->vdev.lock = &dev->v4l_lock;
679 dev->vdev.queue->lock = &dev->vb_queue_lock;
681 /* This will be used to set video_device parent */
682 dev->vdev.v4l2_dev = &dev->v4l2_dev;
684 /* NTSC is default */
685 dev->norm = V4L2_STD_NTSC_M;
689 /* set default format */
690 dev->fmt = &format[0];
691 stk1160_set_std(dev);
693 v4l2_device_call_all(&dev->v4l2_dev, 0, video, s_std,
696 video_set_drvdata(&dev->vdev, dev);
697 rc = video_register_device(&dev->vdev, VFL_TYPE_GRABBER, -1);
699 stk1160_err("video_register_device failed (%d)\n", rc);
703 v4l2_info(&dev->v4l2_dev, "V4L2 device registered as %s\n",
704 video_device_node_name(&dev->vdev));