2 * SuperH Video Output Unit (VOU) driver
4 * Copyright (C) 2010, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/dma-mapping.h>
12 #include <linux/delay.h>
13 #include <linux/errno.h>
15 #include <linux/i2c.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/kernel.h>
19 #include <linux/platform_device.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/slab.h>
22 #include <linux/videodev2.h>
24 #include <media/sh_vou.h>
25 #include <media/v4l2-common.h>
26 #include <media/v4l2-device.h>
27 #include <media/v4l2-ioctl.h>
28 #include <media/v4l2-mediabus.h>
29 #include <media/videobuf-dma-contig.h>
31 /* Mirror addresses are not available for all registers */
59 #define VOU_MAX_IMAGE_WIDTH 720
60 #define VOU_MAX_IMAGE_HEIGHT 576
62 struct sh_vou_device {
63 struct v4l2_device v4l2_dev;
64 struct video_device *vdev;
66 struct sh_vou_pdata *pdata;
69 /* State information */
70 struct v4l2_pix_format pix;
71 struct v4l2_rect rect;
72 struct list_head queue;
75 struct videobuf_buffer *active;
76 enum sh_vou_status status;
77 struct mutex fop_lock;
81 struct videobuf_queue vbq;
84 /* Register access routines for sides A, B and mirror addresses */
85 static void sh_vou_reg_a_write(struct sh_vou_device *vou_dev, unsigned int reg,
88 __raw_writel(value, vou_dev->base + reg);
91 static void sh_vou_reg_ab_write(struct sh_vou_device *vou_dev, unsigned int reg,
94 __raw_writel(value, vou_dev->base + reg);
95 __raw_writel(value, vou_dev->base + reg + 0x1000);
98 static void sh_vou_reg_m_write(struct sh_vou_device *vou_dev, unsigned int reg,
101 __raw_writel(value, vou_dev->base + reg + 0x2000);
104 static u32 sh_vou_reg_a_read(struct sh_vou_device *vou_dev, unsigned int reg)
106 return __raw_readl(vou_dev->base + reg);
109 static void sh_vou_reg_a_set(struct sh_vou_device *vou_dev, unsigned int reg,
112 u32 old = __raw_readl(vou_dev->base + reg);
114 value = (value & mask) | (old & ~mask);
115 __raw_writel(value, vou_dev->base + reg);
118 static void sh_vou_reg_b_set(struct sh_vou_device *vou_dev, unsigned int reg,
121 sh_vou_reg_a_set(vou_dev, reg + 0x1000, value, mask);
124 static void sh_vou_reg_ab_set(struct sh_vou_device *vou_dev, unsigned int reg,
127 sh_vou_reg_a_set(vou_dev, reg, value, mask);
128 sh_vou_reg_b_set(vou_dev, reg, value, mask);
140 /* Further pixel formats can be added */
141 static struct sh_vou_fmt vou_fmt[] = {
143 .pfmt = V4L2_PIX_FMT_NV12,
145 .desc = "YVU420 planar",
150 .pfmt = V4L2_PIX_FMT_NV16,
152 .desc = "YVYU planar",
157 .pfmt = V4L2_PIX_FMT_RGB24,
164 .pfmt = V4L2_PIX_FMT_RGB565,
171 .pfmt = V4L2_PIX_FMT_RGB565X,
173 .desc = "RGB565 byteswapped",
179 static void sh_vou_schedule_next(struct sh_vou_device *vou_dev,
180 struct videobuf_buffer *vb)
182 dma_addr_t addr1, addr2;
184 addr1 = videobuf_to_dma_contig(vb);
185 switch (vou_dev->pix.pixelformat) {
186 case V4L2_PIX_FMT_NV12:
187 case V4L2_PIX_FMT_NV16:
188 addr2 = addr1 + vou_dev->pix.width * vou_dev->pix.height;
194 sh_vou_reg_m_write(vou_dev, VOUAD1R, addr1);
195 sh_vou_reg_m_write(vou_dev, VOUAD2R, addr2);
198 static void sh_vou_stream_start(struct sh_vou_device *vou_dev,
199 struct videobuf_buffer *vb)
201 unsigned int row_coeff;
202 #ifdef __LITTLE_ENDIAN
208 switch (vou_dev->pix.pixelformat) {
209 case V4L2_PIX_FMT_NV12:
210 case V4L2_PIX_FMT_NV16:
213 case V4L2_PIX_FMT_RGB565:
215 case V4L2_PIX_FMT_RGB565X:
218 case V4L2_PIX_FMT_RGB24:
223 sh_vou_reg_a_write(vou_dev, VOUSWR, dataswap);
224 sh_vou_reg_ab_write(vou_dev, VOUAIR, vou_dev->pix.width * row_coeff);
225 sh_vou_schedule_next(vou_dev, vb);
228 static void free_buffer(struct videobuf_queue *vq, struct videobuf_buffer *vb)
230 BUG_ON(in_interrupt());
232 /* Wait until this buffer is no longer in STATE_QUEUED or STATE_ACTIVE */
233 videobuf_waiton(vq, vb, 0, 0);
234 videobuf_dma_contig_free(vq, vb);
235 vb->state = VIDEOBUF_NEEDS_INIT;
238 /* Locking: caller holds fop_lock mutex */
239 static int sh_vou_buf_setup(struct videobuf_queue *vq, unsigned int *count,
242 struct video_device *vdev = vq->priv_data;
243 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
245 *size = vou_fmt[vou_dev->pix_idx].bpp * vou_dev->pix.width *
246 vou_dev->pix.height / 8;
251 /* Taking into account maximum frame size, *count will stay >= 2 */
252 if (PAGE_ALIGN(*size) * *count > 4 * 1024 * 1024)
253 *count = 4 * 1024 * 1024 / PAGE_ALIGN(*size);
255 dev_dbg(vq->dev, "%s(): count=%d, size=%d\n", __func__, *count, *size);
260 /* Locking: caller holds fop_lock mutex */
261 static int sh_vou_buf_prepare(struct videobuf_queue *vq,
262 struct videobuf_buffer *vb,
263 enum v4l2_field field)
265 struct video_device *vdev = vq->priv_data;
266 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
267 struct v4l2_pix_format *pix = &vou_dev->pix;
268 int bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
271 dev_dbg(vq->dev, "%s()\n", __func__);
273 if (vb->width != pix->width ||
274 vb->height != pix->height ||
275 vb->field != pix->field) {
276 vb->width = pix->width;
277 vb->height = pix->height;
279 if (vb->state != VIDEOBUF_NEEDS_INIT)
283 vb->size = vb->height * bytes_per_line;
284 if (vb->baddr && vb->bsize < vb->size) {
285 /* User buffer too small */
286 dev_warn(vq->dev, "User buffer too small: [%u] @ %lx\n",
287 vb->bsize, vb->baddr);
291 if (vb->state == VIDEOBUF_NEEDS_INIT) {
292 ret = videobuf_iolock(vq, vb, NULL);
294 dev_warn(vq->dev, "IOLOCK buf-type %d: %d\n",
298 vb->state = VIDEOBUF_PREPARED;
302 "%s(): fmt #%d, %u bytes per line, phys 0x%x, type %d, state %d\n",
303 __func__, vou_dev->pix_idx, bytes_per_line,
304 videobuf_to_dma_contig(vb), vb->memory, vb->state);
309 /* Locking: caller holds fop_lock mutex and vq->irqlock spinlock */
310 static void sh_vou_buf_queue(struct videobuf_queue *vq,
311 struct videobuf_buffer *vb)
313 struct video_device *vdev = vq->priv_data;
314 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
316 dev_dbg(vq->dev, "%s()\n", __func__);
318 vb->state = VIDEOBUF_QUEUED;
319 list_add_tail(&vb->queue, &vou_dev->queue);
321 if (vou_dev->status == SH_VOU_RUNNING) {
323 } else if (!vou_dev->active) {
324 vou_dev->active = vb;
325 /* Start from side A: we use mirror addresses, so, set B */
326 sh_vou_reg_a_write(vou_dev, VOURPR, 1);
327 dev_dbg(vq->dev, "%s: first buffer status 0x%x\n", __func__,
328 sh_vou_reg_a_read(vou_dev, VOUSTR));
329 sh_vou_schedule_next(vou_dev, vb);
330 /* Only activate VOU after the second buffer */
331 } else if (vou_dev->active->queue.next == &vb->queue) {
332 /* Second buffer - initialise register side B */
333 sh_vou_reg_a_write(vou_dev, VOURPR, 0);
334 sh_vou_stream_start(vou_dev, vb);
336 /* Register side switching with frame VSYNC */
337 sh_vou_reg_a_write(vou_dev, VOURCR, 5);
338 dev_dbg(vq->dev, "%s: second buffer status 0x%x\n", __func__,
339 sh_vou_reg_a_read(vou_dev, VOUSTR));
341 /* Enable End-of-Frame (VSYNC) interrupts */
342 sh_vou_reg_a_write(vou_dev, VOUIR, 0x10004);
343 /* Two buffers on the queue - activate the hardware */
345 vou_dev->status = SH_VOU_RUNNING;
346 sh_vou_reg_a_write(vou_dev, VOUER, 0x107);
350 static void sh_vou_buf_release(struct videobuf_queue *vq,
351 struct videobuf_buffer *vb)
353 struct video_device *vdev = vq->priv_data;
354 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
357 dev_dbg(vq->dev, "%s()\n", __func__);
359 spin_lock_irqsave(&vou_dev->lock, flags);
361 if (vou_dev->active == vb) {
363 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
364 /* ...but the current frame will complete */
365 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
366 vou_dev->active = NULL;
369 if ((vb->state == VIDEOBUF_ACTIVE || vb->state == VIDEOBUF_QUEUED)) {
370 vb->state = VIDEOBUF_ERROR;
371 list_del(&vb->queue);
374 spin_unlock_irqrestore(&vou_dev->lock, flags);
379 static struct videobuf_queue_ops sh_vou_video_qops = {
380 .buf_setup = sh_vou_buf_setup,
381 .buf_prepare = sh_vou_buf_prepare,
382 .buf_queue = sh_vou_buf_queue,
383 .buf_release = sh_vou_buf_release,
387 static int sh_vou_querycap(struct file *file, void *priv,
388 struct v4l2_capability *cap)
390 struct sh_vou_file *vou_file = priv;
392 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
394 strlcpy(cap->card, "SuperH VOU", sizeof(cap->card));
395 cap->capabilities = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
399 /* Enumerate formats, that the device can accept from the user */
400 static int sh_vou_enum_fmt_vid_out(struct file *file, void *priv,
401 struct v4l2_fmtdesc *fmt)
403 struct sh_vou_file *vou_file = priv;
405 if (fmt->index >= ARRAY_SIZE(vou_fmt))
408 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
410 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
411 strlcpy(fmt->description, vou_fmt[fmt->index].desc,
412 sizeof(fmt->description));
413 fmt->pixelformat = vou_fmt[fmt->index].pfmt;
418 static int sh_vou_g_fmt_vid_out(struct file *file, void *priv,
419 struct v4l2_format *fmt)
421 struct video_device *vdev = video_devdata(file);
422 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
424 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
426 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
427 fmt->fmt.pix = vou_dev->pix;
432 static const unsigned char vou_scale_h_num[] = {1, 9, 2, 9, 4};
433 static const unsigned char vou_scale_h_den[] = {1, 8, 1, 4, 1};
434 static const unsigned char vou_scale_h_fld[] = {0, 2, 1, 3};
435 static const unsigned char vou_scale_v_num[] = {1, 2, 4};
436 static const unsigned char vou_scale_v_den[] = {1, 1, 1};
437 static const unsigned char vou_scale_v_fld[] = {0, 1};
439 static void sh_vou_configure_geometry(struct sh_vou_device *vou_dev,
440 int pix_idx, int w_idx, int h_idx)
442 struct sh_vou_fmt *fmt = vou_fmt + pix_idx;
443 unsigned int black_left, black_top, width_max, height_max,
444 frame_in_height, frame_out_height, frame_out_top;
445 struct v4l2_rect *rect = &vou_dev->rect;
446 struct v4l2_pix_format *pix = &vou_dev->pix;
447 u32 vouvcr = 0, dsr_h, dsr_v;
449 if (vou_dev->std & V4L2_STD_525_60) {
457 frame_in_height = pix->height / 2;
458 frame_out_height = rect->height / 2;
459 frame_out_top = rect->top / 2;
462 * Cropping scheme: max useful image is 720x480, and the total video
463 * area is 858x525 (NTSC) or 864x625 (PAL). AK8813 / 8814 starts
464 * sampling data beginning with fixed 276th (NTSC) / 288th (PAL) clock,
465 * of which the first 33 / 25 clocks HSYNC must be held active. This
466 * has to be configured in CR[HW]. 1 pixel equals 2 clock periods.
467 * This gives CR[HW] = 16 / 12, VPR[HVP] = 138 / 144, which gives
468 * exactly 858 - 138 = 864 - 144 = 720! We call the out-of-display area,
469 * beyond DSR, specified on the left and top by the VPR register "black
470 * pixels" and out-of-image area (DPR) "background pixels." We fix VPR
471 * at 138 / 144 : 20, because that's the HSYNC timing, that our first
472 * client requires, and that's exactly what leaves us 720 pixels for the
473 * image; we leave VPR[VVP] at default 20 for now, because the client
474 * doesn't seem to have any special requirements for it. Otherwise we
475 * could also set it to max - 240 = 22 / 72. Thus VPR depends only on
476 * the selected standard, and DPR and DSR are selected according to
477 * cropping. Q: how does the client detect the first valid line? Does
478 * HSYNC stay inactive during invalid (black) lines?
480 black_left = width_max - VOU_MAX_IMAGE_WIDTH;
483 dsr_h = rect->width + rect->left;
484 dsr_v = frame_out_height + frame_out_top;
486 dev_dbg(vou_dev->v4l2_dev.dev,
487 "image %ux%u, black %u:%u, offset %u:%u, display %ux%u\n",
488 pix->width, frame_in_height, black_left, black_top,
489 rect->left, frame_out_top, dsr_h, dsr_v);
491 /* VOUISR height - half of a frame height in frame mode */
492 sh_vou_reg_ab_write(vou_dev, VOUISR, (pix->width << 16) | frame_in_height);
493 sh_vou_reg_ab_write(vou_dev, VOUVPR, (black_left << 16) | black_top);
494 sh_vou_reg_ab_write(vou_dev, VOUDPR, (rect->left << 16) | frame_out_top);
495 sh_vou_reg_ab_write(vou_dev, VOUDSR, (dsr_h << 16) | dsr_v);
498 * if necessary, we could set VOUHIR to
499 * max(black_left + dsr_h, width_max) here
503 vouvcr |= (1 << 15) | (vou_scale_h_fld[w_idx - 1] << 4);
505 vouvcr |= (1 << 14) | vou_scale_v_fld[h_idx - 1];
507 dev_dbg(vou_dev->v4l2_dev.dev, "%s: scaling 0x%x\n", fmt->desc, vouvcr);
509 /* To produce a colour bar for testing set bit 23 of VOUVCR */
510 sh_vou_reg_ab_write(vou_dev, VOUVCR, vouvcr);
511 sh_vou_reg_ab_write(vou_dev, VOUDFR,
512 fmt->pkf | (fmt->yf << 8) | (fmt->rgb << 16));
515 struct sh_vou_geometry {
516 struct v4l2_rect output;
517 unsigned int in_width;
518 unsigned int in_height;
524 * Find input geometry, that we can use to produce output, closest to the
525 * requested rectangle, using VOU scaling
527 static void vou_adjust_input(struct sh_vou_geometry *geo, v4l2_std_id std)
529 /* The compiler cannot know, that best and idx will indeed be set */
530 unsigned int best_err = UINT_MAX, best = 0, img_height_max;
533 if (std & V4L2_STD_525_60)
534 img_height_max = 480;
536 img_height_max = 576;
538 /* Image width must be a multiple of 4 */
539 v4l_bound_align_image(&geo->in_width, 0, VOU_MAX_IMAGE_WIDTH, 2,
540 &geo->in_height, 0, img_height_max, 1, 0);
542 /* Select scales to come as close as possible to the output image */
543 for (i = ARRAY_SIZE(vou_scale_h_num) - 1; i >= 0; i--) {
545 unsigned int found = geo->output.width * vou_scale_h_den[i] /
548 if (found > VOU_MAX_IMAGE_WIDTH)
549 /* scales increase */
552 err = abs(found - geo->in_width);
553 if (err < best_err) {
562 geo->in_width = best;
563 geo->scale_idx_h = idx;
567 /* This loop can be replaced with one division */
568 for (i = ARRAY_SIZE(vou_scale_v_num) - 1; i >= 0; i--) {
570 unsigned int found = geo->output.height * vou_scale_v_den[i] /
573 if (found > img_height_max)
574 /* scales increase */
577 err = abs(found - geo->in_height);
578 if (err < best_err) {
587 geo->in_height = best;
588 geo->scale_idx_v = idx;
592 * Find output geometry, that we can produce, using VOU scaling, closest to
593 * the requested rectangle
595 static void vou_adjust_output(struct sh_vou_geometry *geo, v4l2_std_id std)
597 unsigned int best_err = UINT_MAX, best, width_max, height_max,
601 if (std & V4L2_STD_525_60) {
603 height_max = 262 * 2;
604 img_height_max = 480;
607 height_max = 312 * 2;
608 img_height_max = 576;
611 /* Select scales to come as close as possible to the output image */
612 for (i = 0; i < ARRAY_SIZE(vou_scale_h_num); i++) {
614 unsigned int found = geo->in_width * vou_scale_h_num[i] /
617 if (found > VOU_MAX_IMAGE_WIDTH)
618 /* scales increase */
621 err = abs(found - geo->output.width);
622 if (err < best_err) {
631 geo->output.width = best;
632 geo->scale_idx_h = idx;
633 if (geo->output.left + best > width_max)
634 geo->output.left = width_max - best;
636 pr_debug("%s(): W %u * %u/%u = %u\n", __func__, geo->in_width,
637 vou_scale_h_num[idx], vou_scale_h_den[idx], best);
641 /* This loop can be replaced with one division */
642 for (i = 0; i < ARRAY_SIZE(vou_scale_v_num); i++) {
644 unsigned int found = geo->in_height * vou_scale_v_num[i] /
647 if (found > img_height_max)
648 /* scales increase */
651 err = abs(found - geo->output.height);
652 if (err < best_err) {
661 geo->output.height = best;
662 geo->scale_idx_v = idx;
663 if (geo->output.top + best > height_max)
664 geo->output.top = height_max - best;
666 pr_debug("%s(): H %u * %u/%u = %u\n", __func__, geo->in_height,
667 vou_scale_v_num[idx], vou_scale_v_den[idx], best);
670 static int sh_vou_s_fmt_vid_out(struct file *file, void *priv,
671 struct v4l2_format *fmt)
673 struct video_device *vdev = video_devdata(file);
674 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
675 struct v4l2_pix_format *pix = &fmt->fmt.pix;
676 unsigned int img_height_max;
678 struct sh_vou_geometry geo;
679 struct v4l2_mbus_framefmt mbfmt = {
680 /* Revisit: is this the correct code? */
681 .code = V4L2_MBUS_FMT_YUYV8_2X8,
682 .field = V4L2_FIELD_INTERLACED,
683 .colorspace = V4L2_COLORSPACE_SMPTE170M,
687 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
688 vou_dev->rect.width, vou_dev->rect.height,
689 pix->width, pix->height);
691 if (pix->field == V4L2_FIELD_ANY)
692 pix->field = V4L2_FIELD_NONE;
694 if (fmt->type != V4L2_BUF_TYPE_VIDEO_OUTPUT ||
695 pix->field != V4L2_FIELD_NONE)
698 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
699 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
702 if (pix_idx == ARRAY_SIZE(vou_fmt))
705 if (vou_dev->std & V4L2_STD_525_60)
706 img_height_max = 480;
708 img_height_max = 576;
710 /* Image width must be a multiple of 4 */
711 v4l_bound_align_image(&pix->width, 0, VOU_MAX_IMAGE_WIDTH, 2,
712 &pix->height, 0, img_height_max, 1, 0);
714 geo.in_width = pix->width;
715 geo.in_height = pix->height;
716 geo.output = vou_dev->rect;
718 vou_adjust_output(&geo, vou_dev->std);
720 mbfmt.width = geo.output.width;
721 mbfmt.height = geo.output.height;
722 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
724 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
728 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
729 geo.output.width, geo.output.height, mbfmt.width, mbfmt.height);
732 if ((unsigned)mbfmt.width > VOU_MAX_IMAGE_WIDTH ||
733 (unsigned)mbfmt.height > img_height_max ||
734 mbfmt.code != V4L2_MBUS_FMT_YUYV8_2X8)
737 if (mbfmt.width != geo.output.width ||
738 mbfmt.height != geo.output.height) {
739 geo.output.width = mbfmt.width;
740 geo.output.height = mbfmt.height;
742 vou_adjust_input(&geo, vou_dev->std);
745 /* We tried to preserve output rectangle, but it could have changed */
746 vou_dev->rect = geo.output;
747 pix->width = geo.in_width;
748 pix->height = geo.in_height;
750 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u\n", __func__,
751 pix->width, pix->height);
753 vou_dev->pix_idx = pix_idx;
757 sh_vou_configure_geometry(vou_dev, pix_idx,
758 geo.scale_idx_h, geo.scale_idx_v);
763 static int sh_vou_try_fmt_vid_out(struct file *file, void *priv,
764 struct v4l2_format *fmt)
766 struct sh_vou_file *vou_file = priv;
767 struct v4l2_pix_format *pix = &fmt->fmt.pix;
770 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
772 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
773 pix->field = V4L2_FIELD_NONE;
775 v4l_bound_align_image(&pix->width, 0, VOU_MAX_IMAGE_WIDTH, 1,
776 &pix->height, 0, VOU_MAX_IMAGE_HEIGHT, 1, 0);
778 for (i = 0; ARRAY_SIZE(vou_fmt); i++)
779 if (vou_fmt[i].pfmt == pix->pixelformat)
782 pix->pixelformat = vou_fmt[0].pfmt;
787 static int sh_vou_reqbufs(struct file *file, void *priv,
788 struct v4l2_requestbuffers *req)
790 struct sh_vou_file *vou_file = priv;
792 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
794 if (req->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
797 return videobuf_reqbufs(&vou_file->vbq, req);
800 static int sh_vou_querybuf(struct file *file, void *priv,
801 struct v4l2_buffer *b)
803 struct sh_vou_file *vou_file = priv;
805 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
807 return videobuf_querybuf(&vou_file->vbq, b);
810 static int sh_vou_qbuf(struct file *file, void *priv, struct v4l2_buffer *b)
812 struct sh_vou_file *vou_file = priv;
814 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
816 return videobuf_qbuf(&vou_file->vbq, b);
819 static int sh_vou_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b)
821 struct sh_vou_file *vou_file = priv;
823 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
825 return videobuf_dqbuf(&vou_file->vbq, b, file->f_flags & O_NONBLOCK);
828 static int sh_vou_streamon(struct file *file, void *priv,
829 enum v4l2_buf_type buftype)
831 struct video_device *vdev = video_devdata(file);
832 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
833 struct sh_vou_file *vou_file = priv;
836 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
838 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
840 if (ret < 0 && ret != -ENOIOCTLCMD)
843 /* This calls our .buf_queue() (== sh_vou_buf_queue) */
844 return videobuf_streamon(&vou_file->vbq);
847 static int sh_vou_streamoff(struct file *file, void *priv,
848 enum v4l2_buf_type buftype)
850 struct video_device *vdev = video_devdata(file);
851 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
852 struct sh_vou_file *vou_file = priv;
854 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
857 * This calls buf_release from host driver's videobuf_queue_ops for all
858 * remaining buffers. When the last buffer is freed, stop streaming
860 videobuf_streamoff(&vou_file->vbq);
861 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video, s_stream, 0);
866 static u32 sh_vou_ntsc_mode(enum sh_vou_bus_fmt bus_fmt)
870 pr_warning("%s(): Invalid bus-format code %d, using default 8-bit\n",
872 case SH_VOU_BUS_8BIT:
874 case SH_VOU_BUS_16BIT:
876 case SH_VOU_BUS_BT656:
881 static int sh_vou_s_std(struct file *file, void *priv, v4l2_std_id *std_id)
883 struct video_device *vdev = video_devdata(file);
884 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
887 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): 0x%llx\n", __func__, *std_id);
889 if (*std_id & ~vdev->tvnorms)
892 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
893 s_std_output, *std_id);
894 /* Shall we continue, if the subdev doesn't support .s_std_output()? */
895 if (ret < 0 && ret != -ENOIOCTLCMD)
898 if (*std_id & V4L2_STD_525_60)
899 sh_vou_reg_ab_set(vou_dev, VOUCR,
900 sh_vou_ntsc_mode(vou_dev->pdata->bus_fmt) << 29, 7 << 29);
902 sh_vou_reg_ab_set(vou_dev, VOUCR, 5 << 29, 7 << 29);
904 vou_dev->std = *std_id;
909 static int sh_vou_g_std(struct file *file, void *priv, v4l2_std_id *std)
911 struct video_device *vdev = video_devdata(file);
912 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
914 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
921 static int sh_vou_g_crop(struct file *file, void *fh, struct v4l2_crop *a)
923 struct video_device *vdev = video_devdata(file);
924 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
926 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
928 a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
929 a->c = vou_dev->rect;
934 /* Assume a dull encoder, do all the work ourselves. */
935 static int sh_vou_s_crop(struct file *file, void *fh, struct v4l2_crop *a)
937 struct video_device *vdev = video_devdata(file);
938 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
939 struct v4l2_rect *rect = &a->c;
940 struct v4l2_crop sd_crop = {.type = V4L2_BUF_TYPE_VIDEO_OUTPUT};
941 struct v4l2_pix_format *pix = &vou_dev->pix;
942 struct sh_vou_geometry geo;
943 struct v4l2_mbus_framefmt mbfmt = {
944 /* Revisit: is this the correct code? */
945 .code = V4L2_MBUS_FMT_YUYV8_2X8,
946 .field = V4L2_FIELD_INTERLACED,
947 .colorspace = V4L2_COLORSPACE_SMPTE170M,
949 unsigned int img_height_max;
952 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u@%u:%u\n", __func__,
953 rect->width, rect->height, rect->left, rect->top);
955 if (a->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
958 if (vou_dev->std & V4L2_STD_525_60)
959 img_height_max = 480;
961 img_height_max = 576;
963 v4l_bound_align_image(&rect->width, 0, VOU_MAX_IMAGE_WIDTH, 1,
964 &rect->height, 0, img_height_max, 1, 0);
966 if (rect->width + rect->left > VOU_MAX_IMAGE_WIDTH)
967 rect->left = VOU_MAX_IMAGE_WIDTH - rect->width;
969 if (rect->height + rect->top > img_height_max)
970 rect->top = img_height_max - rect->height;
973 geo.in_width = pix->width;
974 geo.in_height = pix->height;
976 /* Configure the encoder one-to-one, position at 0, ignore errors */
977 sd_crop.c.width = geo.output.width;
978 sd_crop.c.height = geo.output.height;
980 * We first issue a S_CROP, so that the subsequent S_FMT delivers the
981 * final encoder configuration.
983 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
985 mbfmt.width = geo.output.width;
986 mbfmt.height = geo.output.height;
987 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
989 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
994 if ((unsigned)mbfmt.width > VOU_MAX_IMAGE_WIDTH ||
995 (unsigned)mbfmt.height > img_height_max ||
996 mbfmt.code != V4L2_MBUS_FMT_YUYV8_2X8)
999 geo.output.width = mbfmt.width;
1000 geo.output.height = mbfmt.height;
1003 * No down-scaling. According to the API, current call has precedence:
1004 * http://v4l2spec.bytesex.org/spec/x1904.htm#AEN1954 paragraph two.
1006 vou_adjust_input(&geo, vou_dev->std);
1008 /* We tried to preserve output rectangle, but it could have changed */
1009 vou_dev->rect = geo.output;
1010 pix->width = geo.in_width;
1011 pix->height = geo.in_height;
1013 sh_vou_configure_geometry(vou_dev, vou_dev->pix_idx,
1014 geo.scale_idx_h, geo.scale_idx_v);
1020 * Total field: NTSC 858 x 2 * 262/263, PAL 864 x 2 * 312/313, default rectangle
1021 * is the initial register values, height takes the interlaced format into
1022 * account. The actual image can only go up to 720 x 2 * 240, So, VOUVPR can
1023 * actually only meaningfully contain values <= 720 and <= 240 respectively, and
1024 * not <= 864 and <= 312.
1026 static int sh_vou_cropcap(struct file *file, void *priv,
1027 struct v4l2_cropcap *a)
1029 struct sh_vou_file *vou_file = priv;
1031 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
1033 a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
1036 a->bounds.width = VOU_MAX_IMAGE_WIDTH;
1037 a->bounds.height = VOU_MAX_IMAGE_HEIGHT;
1038 /* Default = max, set VOUDPR = 0, which is not hardware default */
1039 a->defrect.left = 0;
1041 a->defrect.width = VOU_MAX_IMAGE_WIDTH;
1042 a->defrect.height = VOU_MAX_IMAGE_HEIGHT;
1043 a->pixelaspect.numerator = 1;
1044 a->pixelaspect.denominator = 1;
1049 static irqreturn_t sh_vou_isr(int irq, void *dev_id)
1051 struct sh_vou_device *vou_dev = dev_id;
1052 static unsigned long j;
1053 struct videobuf_buffer *vb;
1056 u32 irq_status = sh_vou_reg_a_read(vou_dev, VOUIR), masked;
1057 u32 vou_status = sh_vou_reg_a_read(vou_dev, VOUSTR);
1059 if (!(irq_status & 0x300)) {
1060 if (printk_timed_ratelimit(&j, 500))
1061 dev_warn(vou_dev->v4l2_dev.dev, "IRQ status 0x%x!\n",
1066 spin_lock(&vou_dev->lock);
1067 if (!vou_dev->active || list_empty(&vou_dev->queue)) {
1068 if (printk_timed_ratelimit(&j, 500))
1069 dev_warn(vou_dev->v4l2_dev.dev,
1070 "IRQ without active buffer: %x!\n", irq_status);
1071 /* Just ack: buf_release will disable further interrupts */
1072 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x300);
1073 spin_unlock(&vou_dev->lock);
1077 masked = ~(0x300 & irq_status) & irq_status & 0x30304;
1078 dev_dbg(vou_dev->v4l2_dev.dev,
1079 "IRQ status 0x%x -> 0x%x, VOU status 0x%x, cnt %d\n",
1080 irq_status, masked, vou_status, cnt);
1083 side = vou_status & 0x10000;
1085 /* Clear only set interrupts */
1086 sh_vou_reg_a_write(vou_dev, VOUIR, masked);
1088 vb = vou_dev->active;
1089 list_del(&vb->queue);
1091 vb->state = VIDEOBUF_DONE;
1092 do_gettimeofday(&vb->ts);
1096 if (list_empty(&vou_dev->queue)) {
1098 dev_dbg(vou_dev->v4l2_dev.dev, "%s: queue empty after %d\n",
1100 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
1101 vou_dev->active = NULL;
1102 vou_dev->status = SH_VOU_INITIALISING;
1103 /* Disable End-of-Frame (VSYNC) interrupts */
1104 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
1105 spin_unlock(&vou_dev->lock);
1109 vou_dev->active = list_entry(vou_dev->queue.next,
1110 struct videobuf_buffer, queue);
1112 if (vou_dev->active->queue.next != &vou_dev->queue) {
1113 struct videobuf_buffer *new = list_entry(vou_dev->active->queue.next,
1114 struct videobuf_buffer, queue);
1115 sh_vou_schedule_next(vou_dev, new);
1118 spin_unlock(&vou_dev->lock);
1123 static int sh_vou_hw_init(struct sh_vou_device *vou_dev)
1125 struct sh_vou_pdata *pdata = vou_dev->pdata;
1126 u32 voucr = sh_vou_ntsc_mode(pdata->bus_fmt) << 29;
1129 /* Disable all IRQs */
1130 sh_vou_reg_a_write(vou_dev, VOUIR, 0);
1132 /* Reset VOU interfaces - registers unaffected */
1133 sh_vou_reg_a_write(vou_dev, VOUSRR, 0x101);
1134 while (--i && (sh_vou_reg_a_read(vou_dev, VOUSRR) & 0x101))
1140 dev_dbg(vou_dev->v4l2_dev.dev, "Reset took %dus\n", 100 - i);
1142 if (pdata->flags & SH_VOU_PCLK_FALLING)
1144 if (pdata->flags & SH_VOU_HSYNC_LOW)
1146 if (pdata->flags & SH_VOU_VSYNC_LOW)
1148 sh_vou_reg_ab_set(vou_dev, VOUCR, voucr, 0xfc000000);
1150 /* Manual register side switching at first */
1151 sh_vou_reg_a_write(vou_dev, VOURCR, 4);
1152 /* Default - fixed HSYNC length, can be made configurable is required */
1153 sh_vou_reg_ab_write(vou_dev, VOUMSR, 0x800000);
1158 /* File operations */
1159 static int sh_vou_open(struct file *file)
1161 struct video_device *vdev = video_devdata(file);
1162 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
1163 struct sh_vou_file *vou_file = kzalloc(sizeof(struct sh_vou_file),
1169 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
1171 file->private_data = vou_file;
1173 if (atomic_inc_return(&vou_dev->use_count) == 1) {
1176 vou_dev->status = SH_VOU_INITIALISING;
1177 pm_runtime_get_sync(vdev->v4l2_dev->dev);
1178 ret = sh_vou_hw_init(vou_dev);
1180 atomic_dec(&vou_dev->use_count);
1181 pm_runtime_put(vdev->v4l2_dev->dev);
1182 vou_dev->status = SH_VOU_IDLE;
1187 videobuf_queue_dma_contig_init(&vou_file->vbq, &sh_vou_video_qops,
1188 vou_dev->v4l2_dev.dev, &vou_dev->lock,
1189 V4L2_BUF_TYPE_VIDEO_OUTPUT,
1191 sizeof(struct videobuf_buffer), vdev,
1192 &vou_dev->fop_lock);
1197 static int sh_vou_release(struct file *file)
1199 struct video_device *vdev = video_devdata(file);
1200 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
1201 struct sh_vou_file *vou_file = file->private_data;
1203 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
1205 if (!atomic_dec_return(&vou_dev->use_count)) {
1207 vou_dev->status = SH_VOU_IDLE;
1208 sh_vou_reg_a_set(vou_dev, VOUER, 0, 0x101);
1209 pm_runtime_put(vdev->v4l2_dev->dev);
1212 file->private_data = NULL;
1218 static int sh_vou_mmap(struct file *file, struct vm_area_struct *vma)
1220 struct sh_vou_file *vou_file = file->private_data;
1222 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
1224 return videobuf_mmap_mapper(&vou_file->vbq, vma);
1227 static unsigned int sh_vou_poll(struct file *file, poll_table *wait)
1229 struct sh_vou_file *vou_file = file->private_data;
1231 dev_dbg(vou_file->vbq.dev, "%s()\n", __func__);
1233 return videobuf_poll_stream(file, &vou_file->vbq, wait);
1236 static int sh_vou_g_chip_ident(struct file *file, void *fh,
1237 struct v4l2_dbg_chip_ident *id)
1239 struct video_device *vdev = video_devdata(file);
1240 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
1242 return v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, core, g_chip_ident, id);
1245 #ifdef CONFIG_VIDEO_ADV_DEBUG
1246 static int sh_vou_g_register(struct file *file, void *fh,
1247 struct v4l2_dbg_register *reg)
1249 struct video_device *vdev = video_devdata(file);
1250 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
1252 return v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, core, g_register, reg);
1255 static int sh_vou_s_register(struct file *file, void *fh,
1256 struct v4l2_dbg_register *reg)
1258 struct video_device *vdev = video_devdata(file);
1259 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
1261 return v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, core, s_register, reg);
1265 /* sh_vou display ioctl operations */
1266 static const struct v4l2_ioctl_ops sh_vou_ioctl_ops = {
1267 .vidioc_querycap = sh_vou_querycap,
1268 .vidioc_enum_fmt_vid_out = sh_vou_enum_fmt_vid_out,
1269 .vidioc_g_fmt_vid_out = sh_vou_g_fmt_vid_out,
1270 .vidioc_s_fmt_vid_out = sh_vou_s_fmt_vid_out,
1271 .vidioc_try_fmt_vid_out = sh_vou_try_fmt_vid_out,
1272 .vidioc_reqbufs = sh_vou_reqbufs,
1273 .vidioc_querybuf = sh_vou_querybuf,
1274 .vidioc_qbuf = sh_vou_qbuf,
1275 .vidioc_dqbuf = sh_vou_dqbuf,
1276 .vidioc_streamon = sh_vou_streamon,
1277 .vidioc_streamoff = sh_vou_streamoff,
1278 .vidioc_s_std = sh_vou_s_std,
1279 .vidioc_g_std = sh_vou_g_std,
1280 .vidioc_cropcap = sh_vou_cropcap,
1281 .vidioc_g_crop = sh_vou_g_crop,
1282 .vidioc_s_crop = sh_vou_s_crop,
1283 .vidioc_g_chip_ident = sh_vou_g_chip_ident,
1284 #ifdef CONFIG_VIDEO_ADV_DEBUG
1285 .vidioc_g_register = sh_vou_g_register,
1286 .vidioc_s_register = sh_vou_s_register,
1290 static const struct v4l2_file_operations sh_vou_fops = {
1291 .owner = THIS_MODULE,
1292 .open = sh_vou_open,
1293 .release = sh_vou_release,
1294 .unlocked_ioctl = video_ioctl2,
1295 .mmap = sh_vou_mmap,
1296 .poll = sh_vou_poll,
1299 static const struct video_device sh_vou_video_template = {
1301 .fops = &sh_vou_fops,
1302 .ioctl_ops = &sh_vou_ioctl_ops,
1303 .tvnorms = V4L2_STD_525_60, /* PAL only supported in 8-bit non-bt656 mode */
1304 .current_norm = V4L2_STD_NTSC_M,
1307 static int __devinit sh_vou_probe(struct platform_device *pdev)
1309 struct sh_vou_pdata *vou_pdata = pdev->dev.platform_data;
1310 struct v4l2_rect *rect;
1311 struct v4l2_pix_format *pix;
1312 struct i2c_adapter *i2c_adap;
1313 struct video_device *vdev;
1314 struct sh_vou_device *vou_dev;
1315 struct resource *reg_res, *region;
1316 struct v4l2_subdev *subdev;
1319 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1320 irq = platform_get_irq(pdev, 0);
1322 if (!vou_pdata || !reg_res || irq <= 0) {
1323 dev_err(&pdev->dev, "Insufficient VOU platform information.\n");
1327 vou_dev = kzalloc(sizeof(*vou_dev), GFP_KERNEL);
1331 INIT_LIST_HEAD(&vou_dev->queue);
1332 spin_lock_init(&vou_dev->lock);
1333 mutex_init(&vou_dev->fop_lock);
1334 atomic_set(&vou_dev->use_count, 0);
1335 vou_dev->pdata = vou_pdata;
1336 vou_dev->status = SH_VOU_IDLE;
1338 rect = &vou_dev->rect;
1339 pix = &vou_dev->pix;
1341 /* Fill in defaults */
1342 vou_dev->std = sh_vou_video_template.current_norm;
1345 rect->width = VOU_MAX_IMAGE_WIDTH;
1347 pix->width = VOU_MAX_IMAGE_WIDTH;
1349 pix->pixelformat = V4L2_PIX_FMT_YVYU;
1350 pix->field = V4L2_FIELD_NONE;
1351 pix->bytesperline = VOU_MAX_IMAGE_WIDTH * 2;
1352 pix->sizeimage = VOU_MAX_IMAGE_WIDTH * 2 * 480;
1353 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
1355 region = request_mem_region(reg_res->start, resource_size(reg_res),
1358 dev_err(&pdev->dev, "VOU region already claimed\n");
1363 vou_dev->base = ioremap(reg_res->start, resource_size(reg_res));
1364 if (!vou_dev->base) {
1369 ret = request_irq(irq, sh_vou_isr, 0, "vou", vou_dev);
1373 ret = v4l2_device_register(&pdev->dev, &vou_dev->v4l2_dev);
1375 dev_err(&pdev->dev, "Error registering v4l2 device\n");
1379 /* Allocate memory for video device */
1380 vdev = video_device_alloc();
1386 *vdev = sh_vou_video_template;
1387 if (vou_pdata->bus_fmt == SH_VOU_BUS_8BIT)
1388 vdev->tvnorms |= V4L2_STD_PAL;
1389 vdev->v4l2_dev = &vou_dev->v4l2_dev;
1390 vdev->release = video_device_release;
1391 vdev->lock = &vou_dev->fop_lock;
1393 vou_dev->vdev = vdev;
1394 video_set_drvdata(vdev, vou_dev);
1396 pm_runtime_enable(&pdev->dev);
1397 pm_runtime_resume(&pdev->dev);
1399 i2c_adap = i2c_get_adapter(vou_pdata->i2c_adap);
1405 ret = sh_vou_hw_init(vou_dev);
1409 subdev = v4l2_i2c_new_subdev_board(&vou_dev->v4l2_dev, i2c_adap,
1410 vou_pdata->board_info, NULL);
1416 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1425 i2c_put_adapter(i2c_adap);
1427 video_device_release(vdev);
1428 pm_runtime_disable(&pdev->dev);
1430 v4l2_device_unregister(&vou_dev->v4l2_dev);
1432 free_irq(irq, vou_dev);
1434 iounmap(vou_dev->base);
1436 release_mem_region(reg_res->start, resource_size(reg_res));
1442 static int __devexit sh_vou_remove(struct platform_device *pdev)
1444 int irq = platform_get_irq(pdev, 0);
1445 struct v4l2_device *v4l2_dev = platform_get_drvdata(pdev);
1446 struct sh_vou_device *vou_dev = container_of(v4l2_dev,
1447 struct sh_vou_device, v4l2_dev);
1448 struct v4l2_subdev *sd = list_entry(v4l2_dev->subdevs.next,
1449 struct v4l2_subdev, list);
1450 struct i2c_client *client = v4l2_get_subdevdata(sd);
1451 struct resource *reg_res;
1454 free_irq(irq, vou_dev);
1455 pm_runtime_disable(&pdev->dev);
1456 video_unregister_device(vou_dev->vdev);
1457 i2c_put_adapter(client->adapter);
1458 v4l2_device_unregister(&vou_dev->v4l2_dev);
1459 iounmap(vou_dev->base);
1460 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1462 release_mem_region(reg_res->start, resource_size(reg_res));
1467 static struct platform_driver __refdata sh_vou = {
1468 .remove = __devexit_p(sh_vou_remove),
1471 .owner = THIS_MODULE,
1475 static int __init sh_vou_init(void)
1477 return platform_driver_probe(&sh_vou, sh_vou_probe);
1480 static void __exit sh_vou_exit(void)
1482 platform_driver_unregister(&sh_vou);
1485 module_init(sh_vou_init);
1486 module_exit(sh_vou_exit);
1488 MODULE_DESCRIPTION("SuperH VOU driver");
1489 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
1490 MODULE_LICENSE("GPL v2");
1491 MODULE_VERSION("0.1.0");
1492 MODULE_ALIAS("platform:sh-vou");