2 * Virtual Video driver - This code emulates a real video device with v4l2 api
4 * Copyright (c) 2006 by:
5 * Mauro Carvalho Chehab <mchehab--a.t--infradead.org>
6 * Ted Walther <ted--a.t--enumera.com>
7 * John Sokol <sokol--a.t--videotechnology.com>
8 * http://v4l.videotechnology.com/
10 * Conversion to videobuf2 by Pawel Osciak & Marek Szyprowski
11 * Copyright (c) 2010 Samsung Electronics
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the BSD Licence, GNU General Public License
15 * as published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) any later version
18 #include <linux/module.h>
19 #include <linux/errno.h>
20 #include <linux/kernel.h>
21 #include <linux/init.h>
22 #include <linux/sched.h>
23 #include <linux/slab.h>
24 #include <linux/font.h>
25 #include <linux/mutex.h>
26 #include <linux/videodev2.h>
27 #include <linux/kthread.h>
28 #include <linux/freezer.h>
29 #include <media/videobuf2-vmalloc.h>
30 #include <media/v4l2-device.h>
31 #include <media/v4l2-ioctl.h>
32 #include <media/v4l2-ctrls.h>
33 #include <media/v4l2-fh.h>
34 #include <media/v4l2-event.h>
35 #include <media/v4l2-common.h>
37 #define VIVI_MODULE_NAME "vivi"
39 /* Wake up at about 30 fps */
40 #define WAKE_NUMERATOR 30
41 #define WAKE_DENOMINATOR 1001
42 #define BUFFER_TIMEOUT msecs_to_jiffies(500) /* 0.5 seconds */
44 #define MAX_WIDTH 1920
45 #define MAX_HEIGHT 1200
47 #define VIVI_VERSION "0.8.1"
49 MODULE_DESCRIPTION("Video Technology Magazine Virtual Video Capture Board");
50 MODULE_AUTHOR("Mauro Carvalho Chehab, Ted Walther and John Sokol");
51 MODULE_LICENSE("Dual BSD/GPL");
52 MODULE_VERSION(VIVI_VERSION);
54 static unsigned video_nr = -1;
55 module_param(video_nr, uint, 0644);
56 MODULE_PARM_DESC(video_nr, "videoX start number, -1 is autodetect");
58 static unsigned n_devs = 1;
59 module_param(n_devs, uint, 0644);
60 MODULE_PARM_DESC(n_devs, "number of video devices to create");
62 static unsigned debug;
63 module_param(debug, uint, 0644);
64 MODULE_PARM_DESC(debug, "activates debug info");
66 static unsigned int vid_limit = 16;
67 module_param(vid_limit, uint, 0644);
68 MODULE_PARM_DESC(vid_limit, "capture memory limit in megabytes");
70 /* Global font descriptor */
71 static const u8 *font8x16;
73 #define dprintk(dev, level, fmt, arg...) \
74 v4l2_dbg(level, debug, &dev->v4l2_dev, fmt, ## arg)
76 /* ------------------------------------------------------------------
78 ------------------------------------------------------------------*/
82 u32 fourcc; /* v4l2 format id */
86 static struct vivi_fmt formats[] = {
88 .name = "4:2:2, packed, YUYV",
89 .fourcc = V4L2_PIX_FMT_YUYV,
93 .name = "4:2:2, packed, UYVY",
94 .fourcc = V4L2_PIX_FMT_UYVY,
98 .name = "4:2:2, packed, YVYU",
99 .fourcc = V4L2_PIX_FMT_YVYU,
103 .name = "4:2:2, packed, VYUY",
104 .fourcc = V4L2_PIX_FMT_VYUY,
108 .name = "RGB565 (LE)",
109 .fourcc = V4L2_PIX_FMT_RGB565, /* gggbbbbb rrrrrggg */
113 .name = "RGB565 (BE)",
114 .fourcc = V4L2_PIX_FMT_RGB565X, /* rrrrrggg gggbbbbb */
118 .name = "RGB555 (LE)",
119 .fourcc = V4L2_PIX_FMT_RGB555, /* gggbbbbb arrrrrgg */
123 .name = "RGB555 (BE)",
124 .fourcc = V4L2_PIX_FMT_RGB555X, /* arrrrrgg gggbbbbb */
128 .name = "RGB24 (LE)",
129 .fourcc = V4L2_PIX_FMT_RGB24, /* rgb */
133 .name = "RGB24 (BE)",
134 .fourcc = V4L2_PIX_FMT_BGR24, /* bgr */
138 .name = "RGB32 (LE)",
139 .fourcc = V4L2_PIX_FMT_RGB32, /* argb */
143 .name = "RGB32 (BE)",
144 .fourcc = V4L2_PIX_FMT_BGR32, /* bgra */
149 static struct vivi_fmt *get_format(struct v4l2_format *f)
151 struct vivi_fmt *fmt;
154 for (k = 0; k < ARRAY_SIZE(formats); k++) {
156 if (fmt->fourcc == f->fmt.pix.pixelformat)
160 if (k == ARRAY_SIZE(formats))
166 /* buffer for one video frame */
168 /* common v4l buffer stuff -- must be first */
169 struct vb2_buffer vb;
170 struct list_head list;
171 struct vivi_fmt *fmt;
174 struct vivi_dmaqueue {
175 struct list_head active;
177 /* thread for generating video stream*/
178 struct task_struct *kthread;
179 wait_queue_head_t wq;
180 /* Counters to control fps rate */
185 static LIST_HEAD(vivi_devlist);
188 struct list_head vivi_devlist;
189 struct v4l2_device v4l2_dev;
190 struct v4l2_ctrl_handler ctrl_handler;
193 struct v4l2_ctrl *brightness;
194 struct v4l2_ctrl *contrast;
195 struct v4l2_ctrl *saturation;
196 struct v4l2_ctrl *hue;
198 /* autogain/gain cluster */
199 struct v4l2_ctrl *autogain;
200 struct v4l2_ctrl *gain;
202 struct v4l2_ctrl *volume;
203 struct v4l2_ctrl *alpha;
204 struct v4l2_ctrl *button;
205 struct v4l2_ctrl *boolean;
206 struct v4l2_ctrl *int32;
207 struct v4l2_ctrl *int64;
208 struct v4l2_ctrl *menu;
209 struct v4l2_ctrl *string;
210 struct v4l2_ctrl *bitmask;
211 struct v4l2_ctrl *int_menu;
216 /* various device info */
217 struct video_device *vfd;
219 struct vivi_dmaqueue vidq;
221 /* Several counters */
223 unsigned long jiffies;
224 unsigned button_pressed;
226 int mv_count; /* Controls bars movement */
232 struct vivi_fmt *fmt;
233 unsigned int width, height;
234 struct vb2_queue vb_vidq;
235 enum v4l2_field field;
236 unsigned int field_count;
239 u8 line[MAX_WIDTH * 8];
240 unsigned int pixelsize;
244 /* ------------------------------------------------------------------
245 DMA and thread functions
246 ------------------------------------------------------------------*/
248 /* Bars and Colors should match positions */
263 #define COLOR_WHITE {204, 204, 204}
264 #define COLOR_AMBER {208, 208, 0}
265 #define COLOR_CYAN { 0, 206, 206}
266 #define COLOR_GREEN { 0, 239, 0}
267 #define COLOR_MAGENTA {239, 0, 239}
268 #define COLOR_RED {205, 0, 0}
269 #define COLOR_BLUE { 0, 0, 255}
270 #define COLOR_BLACK { 0, 0, 0}
276 /* Maximum number of bars are 10 - otherwise, the input print code
277 should be modified */
278 static struct bar_std bars[] = {
279 { /* Standard ITU-R color bar sequence */
280 { COLOR_WHITE, COLOR_AMBER, COLOR_CYAN, COLOR_GREEN,
281 COLOR_MAGENTA, COLOR_RED, COLOR_BLUE, COLOR_BLACK, COLOR_BLACK }
283 { COLOR_WHITE, COLOR_AMBER, COLOR_BLACK, COLOR_WHITE,
284 COLOR_AMBER, COLOR_BLACK, COLOR_WHITE, COLOR_AMBER, COLOR_BLACK }
286 { COLOR_WHITE, COLOR_CYAN, COLOR_BLACK, COLOR_WHITE,
287 COLOR_CYAN, COLOR_BLACK, COLOR_WHITE, COLOR_CYAN, COLOR_BLACK }
289 { COLOR_WHITE, COLOR_GREEN, COLOR_BLACK, COLOR_WHITE,
290 COLOR_GREEN, COLOR_BLACK, COLOR_WHITE, COLOR_GREEN, COLOR_BLACK }
294 #define NUM_INPUTS ARRAY_SIZE(bars)
296 #define TO_Y(r, g, b) \
297 (((16829 * r + 33039 * g + 6416 * b + 32768) >> 16) + 16)
298 /* RGB to V(Cr) Color transform */
299 #define TO_V(r, g, b) \
300 (((28784 * r - 24103 * g - 4681 * b + 32768) >> 16) + 128)
301 /* RGB to U(Cb) Color transform */
302 #define TO_U(r, g, b) \
303 (((-9714 * r - 19070 * g + 28784 * b + 32768) >> 16) + 128)
305 /* precalculate color bar values to speed up rendering */
306 static void precalculate_bars(struct vivi_dev *dev)
311 for (k = 0; k < 9; k++) {
312 r = bars[dev->input].bar[k][0];
313 g = bars[dev->input].bar[k][1];
314 b = bars[dev->input].bar[k][2];
317 switch (dev->fmt->fourcc) {
318 case V4L2_PIX_FMT_YUYV:
319 case V4L2_PIX_FMT_UYVY:
320 case V4L2_PIX_FMT_YVYU:
321 case V4L2_PIX_FMT_VYUY:
324 case V4L2_PIX_FMT_RGB565:
325 case V4L2_PIX_FMT_RGB565X:
330 case V4L2_PIX_FMT_RGB555:
331 case V4L2_PIX_FMT_RGB555X:
336 case V4L2_PIX_FMT_RGB24:
337 case V4L2_PIX_FMT_BGR24:
338 case V4L2_PIX_FMT_RGB32:
339 case V4L2_PIX_FMT_BGR32:
344 dev->bars[k][0] = TO_Y(r, g, b); /* Luma */
345 dev->bars[k][1] = TO_U(r, g, b); /* Cb */
346 dev->bars[k][2] = TO_V(r, g, b); /* Cr */
355 #define TSTAMP_MIN_Y 24
356 #define TSTAMP_MAX_Y (TSTAMP_MIN_Y + 15)
357 #define TSTAMP_INPUT_X 10
358 #define TSTAMP_MIN_X (54 + TSTAMP_INPUT_X)
360 /* 'odd' is true for pixels 1, 3, 5, etc. and false for pixels 0, 2, 4, etc. */
361 static void gen_twopix(struct vivi_dev *dev, u8 *buf, int colorpos, bool odd)
364 u8 alpha = dev->alpha_component;
368 r_y = dev->bars[colorpos][0]; /* R or precalculated Y */
369 g_u = dev->bars[colorpos][1]; /* G or precalculated U */
370 b_v = dev->bars[colorpos][2]; /* B or precalculated V */
372 for (color = 0; color < dev->pixelsize; color++) {
375 switch (dev->fmt->fourcc) {
376 case V4L2_PIX_FMT_YUYV:
382 *p = odd ? b_v : g_u;
386 case V4L2_PIX_FMT_UYVY:
389 *p = odd ? b_v : g_u;
396 case V4L2_PIX_FMT_YVYU:
402 *p = odd ? g_u : b_v;
406 case V4L2_PIX_FMT_VYUY:
409 *p = odd ? g_u : b_v;
416 case V4L2_PIX_FMT_RGB565:
419 *p = (g_u << 5) | b_v;
422 *p = (r_y << 3) | (g_u >> 3);
426 case V4L2_PIX_FMT_RGB565X:
429 *p = (r_y << 3) | (g_u >> 3);
432 *p = (g_u << 5) | b_v;
436 case V4L2_PIX_FMT_RGB555:
439 *p = (g_u << 5) | b_v;
442 *p = (alpha & 0x80) | (r_y << 2) | (g_u >> 3);
446 case V4L2_PIX_FMT_RGB555X:
449 *p = (alpha & 0x80) | (r_y << 2) | (g_u >> 3);
452 *p = (g_u << 5) | b_v;
456 case V4L2_PIX_FMT_RGB24:
469 case V4L2_PIX_FMT_BGR24:
482 case V4L2_PIX_FMT_RGB32:
498 case V4L2_PIX_FMT_BGR32:
518 static void precalculate_line(struct vivi_dev *dev)
522 for (w = 0; w < dev->width * 2; w++) {
523 int colorpos = w / (dev->width / 8) % 8;
525 gen_twopix(dev, dev->line + w * dev->pixelsize, colorpos, w & 1);
529 static void gen_text(struct vivi_dev *dev, char *basep,
530 int y, int x, char *text)
534 /* Checks if it is possible to show string */
535 if (y + 16 >= dev->height || x + strlen(text) * 8 >= dev->width)
538 /* Print stream time */
539 for (line = y; line < y + 16; line++) {
541 char *pos = basep + line * dev->width * dev->pixelsize + x * dev->pixelsize;
544 for (s = text; *s; s++) {
545 u8 chr = font8x16[*s * 16 + line - y];
548 for (i = 0; i < 7; i++, j++) {
549 /* Draw white font on black background */
550 if (chr & (1 << (7 - i)))
551 gen_twopix(dev, pos + j * dev->pixelsize, WHITE, (x+y) & 1);
553 gen_twopix(dev, pos + j * dev->pixelsize, TEXT_BLACK, (x+y) & 1);
559 static void vivi_fillbuff(struct vivi_dev *dev, struct vivi_buffer *buf)
561 int wmax = dev->width;
562 int hmax = dev->height;
564 void *vbuf = vb2_plane_vaddr(&buf->vb, 0);
573 for (h = 0; h < hmax; h++)
574 memcpy(vbuf + h * wmax * dev->pixelsize,
575 dev->line + (dev->mv_count % wmax) * dev->pixelsize,
576 wmax * dev->pixelsize);
578 /* Updates stream time */
580 dev->ms += jiffies_to_msecs(jiffies - dev->jiffies);
581 dev->jiffies = jiffies;
583 snprintf(str, sizeof(str), " %02d:%02d:%02d:%03d ",
584 (ms / (60 * 60 * 1000)) % 24,
585 (ms / (60 * 1000)) % 60,
588 gen_text(dev, vbuf, line++ * 16, 16, str);
589 snprintf(str, sizeof(str), " %dx%d, input %d ",
590 dev->width, dev->height, dev->input);
591 gen_text(dev, vbuf, line++ * 16, 16, str);
593 gain = v4l2_ctrl_g_ctrl(dev->gain);
594 mutex_lock(dev->ctrl_handler.lock);
595 snprintf(str, sizeof(str), " brightness %3d, contrast %3d, saturation %3d, hue %d ",
596 dev->brightness->cur.val,
597 dev->contrast->cur.val,
598 dev->saturation->cur.val,
600 gen_text(dev, vbuf, line++ * 16, 16, str);
601 snprintf(str, sizeof(str), " autogain %d, gain %3d, volume %3d, alpha 0x%02x ",
602 dev->autogain->cur.val, gain, dev->volume->cur.val,
603 dev->alpha->cur.val);
604 gen_text(dev, vbuf, line++ * 16, 16, str);
605 snprintf(str, sizeof(str), " int32 %d, int64 %lld, bitmask %08x ",
607 dev->int64->cur.val64,
608 dev->bitmask->cur.val);
609 gen_text(dev, vbuf, line++ * 16, 16, str);
610 snprintf(str, sizeof(str), " boolean %d, menu %s, string \"%s\" ",
611 dev->boolean->cur.val,
612 dev->menu->qmenu[dev->menu->cur.val],
613 dev->string->cur.string);
614 gen_text(dev, vbuf, line++ * 16, 16, str);
615 snprintf(str, sizeof(str), " integer_menu %lld, value %d ",
616 dev->int_menu->qmenu_int[dev->int_menu->cur.val],
617 dev->int_menu->cur.val);
618 gen_text(dev, vbuf, line++ * 16, 16, str);
619 mutex_unlock(dev->ctrl_handler.lock);
620 if (dev->button_pressed) {
621 dev->button_pressed--;
622 snprintf(str, sizeof(str), " button pressed!");
623 gen_text(dev, vbuf, line++ * 16, 16, str);
628 buf->vb.v4l2_buf.field = dev->field;
630 buf->vb.v4l2_buf.sequence = dev->field_count >> 1;
631 do_gettimeofday(&ts);
632 buf->vb.v4l2_buf.timestamp = ts;
635 static void vivi_thread_tick(struct vivi_dev *dev)
637 struct vivi_dmaqueue *dma_q = &dev->vidq;
638 struct vivi_buffer *buf;
639 unsigned long flags = 0;
641 dprintk(dev, 1, "Thread tick\n");
643 spin_lock_irqsave(&dev->slock, flags);
644 if (list_empty(&dma_q->active)) {
645 dprintk(dev, 1, "No active queue to serve\n");
646 spin_unlock_irqrestore(&dev->slock, flags);
650 buf = list_entry(dma_q->active.next, struct vivi_buffer, list);
651 list_del(&buf->list);
652 spin_unlock_irqrestore(&dev->slock, flags);
654 do_gettimeofday(&buf->vb.v4l2_buf.timestamp);
657 vivi_fillbuff(dev, buf);
658 dprintk(dev, 1, "filled buffer %p\n", buf);
660 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_DONE);
661 dprintk(dev, 2, "[%p/%d] done\n", buf, buf->vb.v4l2_buf.index);
664 #define frames_to_ms(frames) \
665 ((frames * WAKE_NUMERATOR * 1000) / WAKE_DENOMINATOR)
667 static void vivi_sleep(struct vivi_dev *dev)
669 struct vivi_dmaqueue *dma_q = &dev->vidq;
671 DECLARE_WAITQUEUE(wait, current);
673 dprintk(dev, 1, "%s dma_q=0x%08lx\n", __func__,
674 (unsigned long)dma_q);
676 add_wait_queue(&dma_q->wq, &wait);
677 if (kthread_should_stop())
680 /* Calculate time to wake up */
681 timeout = msecs_to_jiffies(frames_to_ms(1));
683 vivi_thread_tick(dev);
685 schedule_timeout_interruptible(timeout);
688 remove_wait_queue(&dma_q->wq, &wait);
692 static int vivi_thread(void *data)
694 struct vivi_dev *dev = data;
696 dprintk(dev, 1, "thread started\n");
703 if (kthread_should_stop())
706 dprintk(dev, 1, "thread: exit\n");
710 static int vivi_start_generating(struct vivi_dev *dev)
712 struct vivi_dmaqueue *dma_q = &dev->vidq;
714 dprintk(dev, 1, "%s\n", __func__);
716 /* Resets frame counters */
719 dev->jiffies = jiffies;
722 dma_q->ini_jiffies = jiffies;
723 dma_q->kthread = kthread_run(vivi_thread, dev, dev->v4l2_dev.name);
725 if (IS_ERR(dma_q->kthread)) {
726 v4l2_err(&dev->v4l2_dev, "kernel_thread() failed\n");
727 return PTR_ERR(dma_q->kthread);
730 wake_up_interruptible(&dma_q->wq);
732 dprintk(dev, 1, "returning from %s\n", __func__);
736 static void vivi_stop_generating(struct vivi_dev *dev)
738 struct vivi_dmaqueue *dma_q = &dev->vidq;
740 dprintk(dev, 1, "%s\n", __func__);
742 /* shutdown control thread */
743 if (dma_q->kthread) {
744 kthread_stop(dma_q->kthread);
745 dma_q->kthread = NULL;
749 * Typical driver might need to wait here until dma engine stops.
750 * In this case we can abort imiedetly, so it's just a noop.
753 /* Release all active buffers */
754 while (!list_empty(&dma_q->active)) {
755 struct vivi_buffer *buf;
756 buf = list_entry(dma_q->active.next, struct vivi_buffer, list);
757 list_del(&buf->list);
758 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
759 dprintk(dev, 2, "[%p/%d] done\n", buf, buf->vb.v4l2_buf.index);
762 /* ------------------------------------------------------------------
764 ------------------------------------------------------------------*/
765 static int queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt,
766 unsigned int *nbuffers, unsigned int *nplanes,
767 unsigned int sizes[], void *alloc_ctxs[])
769 struct vivi_dev *dev = vb2_get_drv_priv(vq);
772 size = dev->width * dev->height * dev->pixelsize;
777 while (size * *nbuffers > vid_limit * 1024 * 1024)
785 * videobuf2-vmalloc allocator is context-less so no need to set
789 dprintk(dev, 1, "%s, count=%d, size=%ld\n", __func__,
795 static int buffer_init(struct vb2_buffer *vb)
797 struct vivi_dev *dev = vb2_get_drv_priv(vb->vb2_queue);
799 BUG_ON(NULL == dev->fmt);
802 * This callback is called once per buffer, after its allocation.
804 * Vivi does not allow changing format during streaming, but it is
805 * possible to do so when streaming is paused (i.e. in streamoff state).
806 * Buffers however are not freed when going into streamoff and so
807 * buffer size verification has to be done in buffer_prepare, on each
809 * It would be best to move verification code here to buf_init and
816 static int buffer_prepare(struct vb2_buffer *vb)
818 struct vivi_dev *dev = vb2_get_drv_priv(vb->vb2_queue);
819 struct vivi_buffer *buf = container_of(vb, struct vivi_buffer, vb);
822 dprintk(dev, 1, "%s, field=%d\n", __func__, vb->v4l2_buf.field);
824 BUG_ON(NULL == dev->fmt);
827 * Theses properties only change when queue is idle, see s_fmt.
828 * The below checks should not be performed here, on each
829 * buffer_prepare (i.e. on each qbuf). Most of the code in this function
830 * should thus be moved to buffer_init and s_fmt.
832 if (dev->width < 48 || dev->width > MAX_WIDTH ||
833 dev->height < 32 || dev->height > MAX_HEIGHT)
836 size = dev->width * dev->height * dev->pixelsize;
837 if (vb2_plane_size(vb, 0) < size) {
838 dprintk(dev, 1, "%s data will not fit into plane (%lu < %lu)\n",
839 __func__, vb2_plane_size(vb, 0), size);
843 vb2_set_plane_payload(&buf->vb, 0, size);
847 precalculate_bars(dev);
848 precalculate_line(dev);
853 static int buffer_finish(struct vb2_buffer *vb)
855 struct vivi_dev *dev = vb2_get_drv_priv(vb->vb2_queue);
856 dprintk(dev, 1, "%s\n", __func__);
860 static void buffer_cleanup(struct vb2_buffer *vb)
862 struct vivi_dev *dev = vb2_get_drv_priv(vb->vb2_queue);
863 dprintk(dev, 1, "%s\n", __func__);
867 static void buffer_queue(struct vb2_buffer *vb)
869 struct vivi_dev *dev = vb2_get_drv_priv(vb->vb2_queue);
870 struct vivi_buffer *buf = container_of(vb, struct vivi_buffer, vb);
871 struct vivi_dmaqueue *vidq = &dev->vidq;
872 unsigned long flags = 0;
874 dprintk(dev, 1, "%s\n", __func__);
876 spin_lock_irqsave(&dev->slock, flags);
877 list_add_tail(&buf->list, &vidq->active);
878 spin_unlock_irqrestore(&dev->slock, flags);
881 static int start_streaming(struct vb2_queue *vq, unsigned int count)
883 struct vivi_dev *dev = vb2_get_drv_priv(vq);
884 dprintk(dev, 1, "%s\n", __func__);
885 return vivi_start_generating(dev);
888 /* abort streaming and wait for last buffer */
889 static int stop_streaming(struct vb2_queue *vq)
891 struct vivi_dev *dev = vb2_get_drv_priv(vq);
892 dprintk(dev, 1, "%s\n", __func__);
893 vivi_stop_generating(dev);
897 static void vivi_lock(struct vb2_queue *vq)
899 struct vivi_dev *dev = vb2_get_drv_priv(vq);
900 mutex_lock(&dev->mutex);
903 static void vivi_unlock(struct vb2_queue *vq)
905 struct vivi_dev *dev = vb2_get_drv_priv(vq);
906 mutex_unlock(&dev->mutex);
910 static struct vb2_ops vivi_video_qops = {
911 .queue_setup = queue_setup,
912 .buf_init = buffer_init,
913 .buf_prepare = buffer_prepare,
914 .buf_finish = buffer_finish,
915 .buf_cleanup = buffer_cleanup,
916 .buf_queue = buffer_queue,
917 .start_streaming = start_streaming,
918 .stop_streaming = stop_streaming,
919 .wait_prepare = vivi_unlock,
920 .wait_finish = vivi_lock,
923 /* ------------------------------------------------------------------
924 IOCTL vidioc handling
925 ------------------------------------------------------------------*/
926 static int vidioc_querycap(struct file *file, void *priv,
927 struct v4l2_capability *cap)
929 struct vivi_dev *dev = video_drvdata(file);
931 strcpy(cap->driver, "vivi");
932 strcpy(cap->card, "vivi");
933 strlcpy(cap->bus_info, dev->v4l2_dev.name, sizeof(cap->bus_info));
934 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING |
936 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
940 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
941 struct v4l2_fmtdesc *f)
943 struct vivi_fmt *fmt;
945 if (f->index >= ARRAY_SIZE(formats))
948 fmt = &formats[f->index];
950 strlcpy(f->description, fmt->name, sizeof(f->description));
951 f->pixelformat = fmt->fourcc;
955 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
956 struct v4l2_format *f)
958 struct vivi_dev *dev = video_drvdata(file);
960 f->fmt.pix.width = dev->width;
961 f->fmt.pix.height = dev->height;
962 f->fmt.pix.field = dev->field;
963 f->fmt.pix.pixelformat = dev->fmt->fourcc;
964 f->fmt.pix.bytesperline =
965 (f->fmt.pix.width * dev->fmt->depth) >> 3;
966 f->fmt.pix.sizeimage =
967 f->fmt.pix.height * f->fmt.pix.bytesperline;
968 if (dev->fmt->fourcc == V4L2_PIX_FMT_YUYV ||
969 dev->fmt->fourcc == V4L2_PIX_FMT_UYVY)
970 f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
972 f->fmt.pix.colorspace = V4L2_COLORSPACE_SRGB;
976 static int vidioc_try_fmt_vid_cap(struct file *file, void *priv,
977 struct v4l2_format *f)
979 struct vivi_dev *dev = video_drvdata(file);
980 struct vivi_fmt *fmt;
981 enum v4l2_field field;
985 dprintk(dev, 1, "Fourcc format (0x%08x) invalid.\n",
986 f->fmt.pix.pixelformat);
990 field = f->fmt.pix.field;
992 if (field == V4L2_FIELD_ANY) {
993 field = V4L2_FIELD_INTERLACED;
994 } else if (V4L2_FIELD_INTERLACED != field) {
995 dprintk(dev, 1, "Field type invalid.\n");
999 f->fmt.pix.field = field;
1000 v4l_bound_align_image(&f->fmt.pix.width, 48, MAX_WIDTH, 2,
1001 &f->fmt.pix.height, 32, MAX_HEIGHT, 0, 0);
1002 f->fmt.pix.bytesperline =
1003 (f->fmt.pix.width * fmt->depth) >> 3;
1004 f->fmt.pix.sizeimage =
1005 f->fmt.pix.height * f->fmt.pix.bytesperline;
1006 if (fmt->fourcc == V4L2_PIX_FMT_YUYV ||
1007 fmt->fourcc == V4L2_PIX_FMT_UYVY)
1008 f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
1010 f->fmt.pix.colorspace = V4L2_COLORSPACE_SRGB;
1014 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
1015 struct v4l2_format *f)
1017 struct vivi_dev *dev = video_drvdata(file);
1018 struct vb2_queue *q = &dev->vb_vidq;
1020 int ret = vidioc_try_fmt_vid_cap(file, priv, f);
1024 if (vb2_is_streaming(q)) {
1025 dprintk(dev, 1, "%s device busy\n", __func__);
1029 dev->fmt = get_format(f);
1030 dev->pixelsize = dev->fmt->depth / 8;
1031 dev->width = f->fmt.pix.width;
1032 dev->height = f->fmt.pix.height;
1033 dev->field = f->fmt.pix.field;
1038 static int vidioc_reqbufs(struct file *file, void *priv,
1039 struct v4l2_requestbuffers *p)
1041 struct vivi_dev *dev = video_drvdata(file);
1042 return vb2_reqbufs(&dev->vb_vidq, p);
1045 static int vidioc_querybuf(struct file *file, void *priv, struct v4l2_buffer *p)
1047 struct vivi_dev *dev = video_drvdata(file);
1048 return vb2_querybuf(&dev->vb_vidq, p);
1051 static int vidioc_qbuf(struct file *file, void *priv, struct v4l2_buffer *p)
1053 struct vivi_dev *dev = video_drvdata(file);
1054 return vb2_qbuf(&dev->vb_vidq, p);
1057 static int vidioc_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p)
1059 struct vivi_dev *dev = video_drvdata(file);
1060 return vb2_dqbuf(&dev->vb_vidq, p, file->f_flags & O_NONBLOCK);
1063 static int vidioc_streamon(struct file *file, void *priv, enum v4l2_buf_type i)
1065 struct vivi_dev *dev = video_drvdata(file);
1066 return vb2_streamon(&dev->vb_vidq, i);
1069 static int vidioc_streamoff(struct file *file, void *priv, enum v4l2_buf_type i)
1071 struct vivi_dev *dev = video_drvdata(file);
1072 return vb2_streamoff(&dev->vb_vidq, i);
1075 static int vidioc_s_std(struct file *file, void *priv, v4l2_std_id *i)
1080 /* only one input in this sample driver */
1081 static int vidioc_enum_input(struct file *file, void *priv,
1082 struct v4l2_input *inp)
1084 if (inp->index >= NUM_INPUTS)
1087 inp->type = V4L2_INPUT_TYPE_CAMERA;
1088 inp->std = V4L2_STD_525_60;
1089 sprintf(inp->name, "Camera %u", inp->index);
1093 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1095 struct vivi_dev *dev = video_drvdata(file);
1101 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1103 struct vivi_dev *dev = video_drvdata(file);
1105 if (i >= NUM_INPUTS)
1108 if (i == dev->input)
1112 precalculate_bars(dev);
1113 precalculate_line(dev);
1117 /* --- controls ---------------------------------------------- */
1119 static int vivi_g_volatile_ctrl(struct v4l2_ctrl *ctrl)
1121 struct vivi_dev *dev = container_of(ctrl->handler, struct vivi_dev, ctrl_handler);
1123 if (ctrl == dev->autogain)
1124 dev->gain->val = jiffies & 0xff;
1128 static int vivi_s_ctrl(struct v4l2_ctrl *ctrl)
1130 struct vivi_dev *dev = container_of(ctrl->handler, struct vivi_dev, ctrl_handler);
1133 case V4L2_CID_ALPHA_COMPONENT:
1134 dev->alpha_component = ctrl->val;
1137 if (ctrl == dev->button)
1138 dev->button_pressed = 30;
1144 /* ------------------------------------------------------------------
1145 File operations for the device
1146 ------------------------------------------------------------------*/
1149 vivi_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
1151 struct vivi_dev *dev = video_drvdata(file);
1154 dprintk(dev, 1, "read called\n");
1155 mutex_lock(&dev->mutex);
1156 err = vb2_read(&dev->vb_vidq, data, count, ppos,
1157 file->f_flags & O_NONBLOCK);
1158 mutex_unlock(&dev->mutex);
1163 vivi_poll(struct file *file, struct poll_table_struct *wait)
1165 struct vivi_dev *dev = video_drvdata(file);
1166 struct vb2_queue *q = &dev->vb_vidq;
1168 dprintk(dev, 1, "%s\n", __func__);
1169 return vb2_poll(q, file, wait);
1172 static int vivi_close(struct file *file)
1174 struct video_device *vdev = video_devdata(file);
1175 struct vivi_dev *dev = video_drvdata(file);
1177 dprintk(dev, 1, "close called (dev=%s), file %p\n",
1178 video_device_node_name(vdev), file);
1180 if (v4l2_fh_is_singular_file(file))
1181 vb2_queue_release(&dev->vb_vidq);
1182 return v4l2_fh_release(file);
1185 static int vivi_mmap(struct file *file, struct vm_area_struct *vma)
1187 struct vivi_dev *dev = video_drvdata(file);
1190 dprintk(dev, 1, "mmap called, vma=0x%08lx\n", (unsigned long)vma);
1192 ret = vb2_mmap(&dev->vb_vidq, vma);
1193 dprintk(dev, 1, "vma start=0x%08lx, size=%ld, ret=%d\n",
1194 (unsigned long)vma->vm_start,
1195 (unsigned long)vma->vm_end - (unsigned long)vma->vm_start,
1200 static const struct v4l2_ctrl_ops vivi_ctrl_ops = {
1201 .g_volatile_ctrl = vivi_g_volatile_ctrl,
1202 .s_ctrl = vivi_s_ctrl,
1205 #define VIVI_CID_CUSTOM_BASE (V4L2_CID_USER_BASE | 0xf000)
1207 static const struct v4l2_ctrl_config vivi_ctrl_button = {
1208 .ops = &vivi_ctrl_ops,
1209 .id = VIVI_CID_CUSTOM_BASE + 0,
1211 .type = V4L2_CTRL_TYPE_BUTTON,
1214 static const struct v4l2_ctrl_config vivi_ctrl_boolean = {
1215 .ops = &vivi_ctrl_ops,
1216 .id = VIVI_CID_CUSTOM_BASE + 1,
1218 .type = V4L2_CTRL_TYPE_BOOLEAN,
1225 static const struct v4l2_ctrl_config vivi_ctrl_int32 = {
1226 .ops = &vivi_ctrl_ops,
1227 .id = VIVI_CID_CUSTOM_BASE + 2,
1228 .name = "Integer 32 Bits",
1229 .type = V4L2_CTRL_TYPE_INTEGER,
1235 static const struct v4l2_ctrl_config vivi_ctrl_int64 = {
1236 .ops = &vivi_ctrl_ops,
1237 .id = VIVI_CID_CUSTOM_BASE + 3,
1238 .name = "Integer 64 Bits",
1239 .type = V4L2_CTRL_TYPE_INTEGER64,
1242 static const char * const vivi_ctrl_menu_strings[] = {
1243 "Menu Item 0 (Skipped)",
1245 "Menu Item 2 (Skipped)",
1248 "Menu Item 5 (Skipped)",
1252 static const struct v4l2_ctrl_config vivi_ctrl_menu = {
1253 .ops = &vivi_ctrl_ops,
1254 .id = VIVI_CID_CUSTOM_BASE + 4,
1256 .type = V4L2_CTRL_TYPE_MENU,
1260 .menu_skip_mask = 0x04,
1261 .qmenu = vivi_ctrl_menu_strings,
1264 static const struct v4l2_ctrl_config vivi_ctrl_string = {
1265 .ops = &vivi_ctrl_ops,
1266 .id = VIVI_CID_CUSTOM_BASE + 5,
1268 .type = V4L2_CTRL_TYPE_STRING,
1274 static const struct v4l2_ctrl_config vivi_ctrl_bitmask = {
1275 .ops = &vivi_ctrl_ops,
1276 .id = VIVI_CID_CUSTOM_BASE + 6,
1278 .type = V4L2_CTRL_TYPE_BITMASK,
1285 static const s64 vivi_ctrl_int_menu_values[] = {
1286 1, 1, 2, 3, 5, 8, 13, 21, 42,
1289 static const struct v4l2_ctrl_config vivi_ctrl_int_menu = {
1290 .ops = &vivi_ctrl_ops,
1291 .id = VIVI_CID_CUSTOM_BASE + 7,
1292 .name = "Integer menu",
1293 .type = V4L2_CTRL_TYPE_INTEGER_MENU,
1297 .menu_skip_mask = 0x02,
1298 .qmenu_int = vivi_ctrl_int_menu_values,
1301 static const struct v4l2_file_operations vivi_fops = {
1302 .owner = THIS_MODULE,
1303 .open = v4l2_fh_open,
1304 .release = vivi_close,
1307 .unlocked_ioctl = video_ioctl2, /* V4L2 ioctl handler */
1311 static const struct v4l2_ioctl_ops vivi_ioctl_ops = {
1312 .vidioc_querycap = vidioc_querycap,
1313 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1314 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1315 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1316 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1317 .vidioc_reqbufs = vidioc_reqbufs,
1318 .vidioc_querybuf = vidioc_querybuf,
1319 .vidioc_qbuf = vidioc_qbuf,
1320 .vidioc_dqbuf = vidioc_dqbuf,
1321 .vidioc_s_std = vidioc_s_std,
1322 .vidioc_enum_input = vidioc_enum_input,
1323 .vidioc_g_input = vidioc_g_input,
1324 .vidioc_s_input = vidioc_s_input,
1325 .vidioc_streamon = vidioc_streamon,
1326 .vidioc_streamoff = vidioc_streamoff,
1327 .vidioc_log_status = v4l2_ctrl_log_status,
1328 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
1329 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1332 static struct video_device vivi_template = {
1335 .ioctl_ops = &vivi_ioctl_ops,
1336 .release = video_device_release,
1338 .tvnorms = V4L2_STD_525_60,
1339 .current_norm = V4L2_STD_NTSC_M,
1342 /* -----------------------------------------------------------------
1343 Initialization and module stuff
1344 ------------------------------------------------------------------*/
1346 static int vivi_release(void)
1348 struct vivi_dev *dev;
1349 struct list_head *list;
1351 while (!list_empty(&vivi_devlist)) {
1352 list = vivi_devlist.next;
1354 dev = list_entry(list, struct vivi_dev, vivi_devlist);
1356 v4l2_info(&dev->v4l2_dev, "unregistering %s\n",
1357 video_device_node_name(dev->vfd));
1358 video_unregister_device(dev->vfd);
1359 v4l2_device_unregister(&dev->v4l2_dev);
1360 v4l2_ctrl_handler_free(&dev->ctrl_handler);
1367 static int __init vivi_create_instance(int inst)
1369 struct vivi_dev *dev;
1370 struct video_device *vfd;
1371 struct v4l2_ctrl_handler *hdl;
1372 struct vb2_queue *q;
1375 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1379 snprintf(dev->v4l2_dev.name, sizeof(dev->v4l2_dev.name),
1380 "%s-%03d", VIVI_MODULE_NAME, inst);
1381 ret = v4l2_device_register(NULL, &dev->v4l2_dev);
1385 dev->fmt = &formats[0];
1388 dev->pixelsize = dev->fmt->depth / 8;
1389 hdl = &dev->ctrl_handler;
1390 v4l2_ctrl_handler_init(hdl, 11);
1391 dev->volume = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1392 V4L2_CID_AUDIO_VOLUME, 0, 255, 1, 200);
1393 dev->brightness = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1394 V4L2_CID_BRIGHTNESS, 0, 255, 1, 127);
1395 dev->contrast = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1396 V4L2_CID_CONTRAST, 0, 255, 1, 16);
1397 dev->saturation = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1398 V4L2_CID_SATURATION, 0, 255, 1, 127);
1399 dev->hue = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1400 V4L2_CID_HUE, -128, 127, 1, 0);
1401 dev->autogain = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1402 V4L2_CID_AUTOGAIN, 0, 1, 1, 1);
1403 dev->gain = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1404 V4L2_CID_GAIN, 0, 255, 1, 100);
1405 dev->alpha = v4l2_ctrl_new_std(hdl, &vivi_ctrl_ops,
1406 V4L2_CID_ALPHA_COMPONENT, 0, 255, 1, 0);
1407 dev->button = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_button, NULL);
1408 dev->int32 = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_int32, NULL);
1409 dev->int64 = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_int64, NULL);
1410 dev->boolean = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_boolean, NULL);
1411 dev->menu = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_menu, NULL);
1412 dev->string = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_string, NULL);
1413 dev->bitmask = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_bitmask, NULL);
1414 dev->int_menu = v4l2_ctrl_new_custom(hdl, &vivi_ctrl_int_menu, NULL);
1419 v4l2_ctrl_auto_cluster(2, &dev->autogain, 0, true);
1420 dev->v4l2_dev.ctrl_handler = hdl;
1422 /* initialize locks */
1423 spin_lock_init(&dev->slock);
1425 /* initialize queue */
1427 memset(q, 0, sizeof(dev->vb_vidq));
1428 q->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1429 q->io_modes = VB2_MMAP | VB2_USERPTR | VB2_READ;
1431 q->buf_struct_size = sizeof(struct vivi_buffer);
1432 q->ops = &vivi_video_qops;
1433 q->mem_ops = &vb2_vmalloc_memops;
1437 mutex_init(&dev->mutex);
1439 /* init video dma queues */
1440 INIT_LIST_HEAD(&dev->vidq.active);
1441 init_waitqueue_head(&dev->vidq.wq);
1444 vfd = video_device_alloc();
1448 *vfd = vivi_template;
1450 vfd->v4l2_dev = &dev->v4l2_dev;
1451 set_bit(V4L2_FL_USE_FH_PRIO, &vfd->flags);
1454 * Provide a mutex to v4l2 core. It will be used to protect
1455 * all fops and v4l2 ioctls.
1457 vfd->lock = &dev->mutex;
1459 ret = video_register_device(vfd, VFL_TYPE_GRABBER, video_nr);
1463 video_set_drvdata(vfd, dev);
1465 /* Now that everything is fine, let's add it to device list */
1466 list_add_tail(&dev->vivi_devlist, &vivi_devlist);
1472 v4l2_info(&dev->v4l2_dev, "V4L2 device registered as %s\n",
1473 video_device_node_name(vfd));
1477 video_device_release(vfd);
1479 v4l2_ctrl_handler_free(hdl);
1480 v4l2_device_unregister(&dev->v4l2_dev);
1486 /* This routine allocates from 1 to n_devs virtual drivers.
1488 The real maximum number of virtual drivers will depend on how many drivers
1489 will succeed. This is limited to the maximum number of devices that
1490 videodev supports, which is equal to VIDEO_NUM_DEVICES.
1492 static int __init vivi_init(void)
1494 const struct font_desc *font = find_font("VGA8x16");
1498 printk(KERN_ERR "vivi: could not find font\n");
1501 font8x16 = font->data;
1506 for (i = 0; i < n_devs; i++) {
1507 ret = vivi_create_instance(i);
1509 /* If some instantiations succeeded, keep driver */
1517 printk(KERN_ERR "vivi: error %d while loading driver\n", ret);
1521 printk(KERN_INFO "Video Technology Magazine Virtual Video "
1522 "Capture Board ver %s successfully loaded.\n",
1525 /* n_devs will reflect the actual number of allocated devices */
1531 static void __exit vivi_exit(void)
1536 module_init(vivi_init);
1537 module_exit(vivi_exit);