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>
23 #include <linux/module.h>
25 #include <media/sh_vou.h>
26 #include <media/v4l2-common.h>
27 #include <media/v4l2-device.h>
28 #include <media/v4l2-ioctl.h>
29 #include <media/v4l2-mediabus.h>
30 #include <media/videobuf-dma-contig.h>
32 /* Mirror addresses are not available for all registers */
60 #define VOU_MAX_IMAGE_WIDTH 720
61 #define VOU_MAX_IMAGE_HEIGHT 576
63 struct sh_vou_device {
64 struct v4l2_device v4l2_dev;
65 struct video_device *vdev;
67 struct sh_vou_pdata *pdata;
70 /* State information */
71 struct v4l2_pix_format pix;
72 struct v4l2_rect rect;
73 struct list_head queue;
76 struct videobuf_buffer *active;
77 enum sh_vou_status status;
78 struct mutex fop_lock;
82 struct videobuf_queue vbq;
85 /* Register access routines for sides A, B and mirror addresses */
86 static void sh_vou_reg_a_write(struct sh_vou_device *vou_dev, unsigned int reg,
89 __raw_writel(value, vou_dev->base + reg);
92 static void sh_vou_reg_ab_write(struct sh_vou_device *vou_dev, unsigned int reg,
95 __raw_writel(value, vou_dev->base + reg);
96 __raw_writel(value, vou_dev->base + reg + 0x1000);
99 static void sh_vou_reg_m_write(struct sh_vou_device *vou_dev, unsigned int reg,
102 __raw_writel(value, vou_dev->base + reg + 0x2000);
105 static u32 sh_vou_reg_a_read(struct sh_vou_device *vou_dev, unsigned int reg)
107 return __raw_readl(vou_dev->base + reg);
110 static void sh_vou_reg_a_set(struct sh_vou_device *vou_dev, unsigned int reg,
113 u32 old = __raw_readl(vou_dev->base + reg);
115 value = (value & mask) | (old & ~mask);
116 __raw_writel(value, vou_dev->base + reg);
119 static void sh_vou_reg_b_set(struct sh_vou_device *vou_dev, unsigned int reg,
122 sh_vou_reg_a_set(vou_dev, reg + 0x1000, value, mask);
125 static void sh_vou_reg_ab_set(struct sh_vou_device *vou_dev, unsigned int reg,
128 sh_vou_reg_a_set(vou_dev, reg, value, mask);
129 sh_vou_reg_b_set(vou_dev, reg, value, mask);
141 /* Further pixel formats can be added */
142 static struct sh_vou_fmt vou_fmt[] = {
144 .pfmt = V4L2_PIX_FMT_NV12,
146 .desc = "YVU420 planar",
151 .pfmt = V4L2_PIX_FMT_NV16,
153 .desc = "YVYU planar",
158 .pfmt = V4L2_PIX_FMT_RGB24,
165 .pfmt = V4L2_PIX_FMT_RGB565,
172 .pfmt = V4L2_PIX_FMT_RGB565X,
174 .desc = "RGB565 byteswapped",
180 static void sh_vou_schedule_next(struct sh_vou_device *vou_dev,
181 struct videobuf_buffer *vb)
183 dma_addr_t addr1, addr2;
185 addr1 = videobuf_to_dma_contig(vb);
186 switch (vou_dev->pix.pixelformat) {
187 case V4L2_PIX_FMT_NV12:
188 case V4L2_PIX_FMT_NV16:
189 addr2 = addr1 + vou_dev->pix.width * vou_dev->pix.height;
195 sh_vou_reg_m_write(vou_dev, VOUAD1R, addr1);
196 sh_vou_reg_m_write(vou_dev, VOUAD2R, addr2);
199 static void sh_vou_stream_start(struct sh_vou_device *vou_dev,
200 struct videobuf_buffer *vb)
202 unsigned int row_coeff;
203 #ifdef __LITTLE_ENDIAN
209 switch (vou_dev->pix.pixelformat) {
211 case V4L2_PIX_FMT_NV12:
212 case V4L2_PIX_FMT_NV16:
215 case V4L2_PIX_FMT_RGB565:
217 case V4L2_PIX_FMT_RGB565X:
220 case V4L2_PIX_FMT_RGB24:
225 sh_vou_reg_a_write(vou_dev, VOUSWR, dataswap);
226 sh_vou_reg_ab_write(vou_dev, VOUAIR, vou_dev->pix.width * row_coeff);
227 sh_vou_schedule_next(vou_dev, vb);
230 static void free_buffer(struct videobuf_queue *vq, struct videobuf_buffer *vb)
232 BUG_ON(in_interrupt());
234 /* Wait until this buffer is no longer in STATE_QUEUED or STATE_ACTIVE */
235 videobuf_waiton(vq, vb, 0, 0);
236 videobuf_dma_contig_free(vq, vb);
237 vb->state = VIDEOBUF_NEEDS_INIT;
240 /* Locking: caller holds fop_lock mutex */
241 static int sh_vou_buf_setup(struct videobuf_queue *vq, unsigned int *count,
244 struct video_device *vdev = vq->priv_data;
245 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
247 *size = vou_fmt[vou_dev->pix_idx].bpp * vou_dev->pix.width *
248 vou_dev->pix.height / 8;
253 /* Taking into account maximum frame size, *count will stay >= 2 */
254 if (PAGE_ALIGN(*size) * *count > 4 * 1024 * 1024)
255 *count = 4 * 1024 * 1024 / PAGE_ALIGN(*size);
257 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): count=%d, size=%d\n", __func__,
263 /* Locking: caller holds fop_lock mutex */
264 static int sh_vou_buf_prepare(struct videobuf_queue *vq,
265 struct videobuf_buffer *vb,
266 enum v4l2_field field)
268 struct video_device *vdev = vq->priv_data;
269 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
270 struct v4l2_pix_format *pix = &vou_dev->pix;
271 int bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
274 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
276 if (vb->width != pix->width ||
277 vb->height != pix->height ||
278 vb->field != pix->field) {
279 vb->width = pix->width;
280 vb->height = pix->height;
282 if (vb->state != VIDEOBUF_NEEDS_INIT)
286 vb->size = vb->height * bytes_per_line;
287 if (vb->baddr && vb->bsize < vb->size) {
288 /* User buffer too small */
289 dev_warn(vq->dev, "User buffer too small: [%zu] @ %lx\n",
290 vb->bsize, vb->baddr);
294 if (vb->state == VIDEOBUF_NEEDS_INIT) {
295 ret = videobuf_iolock(vq, vb, NULL);
297 dev_warn(vq->dev, "IOLOCK buf-type %d: %d\n",
301 vb->state = VIDEOBUF_PREPARED;
304 dev_dbg(vou_dev->v4l2_dev.dev,
305 "%s(): fmt #%d, %u bytes per line, phys %pad, type %d, state %d\n",
306 __func__, vou_dev->pix_idx, bytes_per_line,
307 ({ dma_addr_t addr = videobuf_to_dma_contig(vb); &addr; }),
308 vb->memory, vb->state);
313 /* Locking: caller holds fop_lock mutex and vq->irqlock spinlock */
314 static void sh_vou_buf_queue(struct videobuf_queue *vq,
315 struct videobuf_buffer *vb)
317 struct video_device *vdev = vq->priv_data;
318 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
320 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
322 vb->state = VIDEOBUF_QUEUED;
323 list_add_tail(&vb->queue, &vou_dev->queue);
325 if (vou_dev->status == SH_VOU_RUNNING) {
327 } else if (!vou_dev->active) {
328 vou_dev->active = vb;
329 /* Start from side A: we use mirror addresses, so, set B */
330 sh_vou_reg_a_write(vou_dev, VOURPR, 1);
331 dev_dbg(vou_dev->v4l2_dev.dev, "%s: first buffer status 0x%x\n",
332 __func__, sh_vou_reg_a_read(vou_dev, VOUSTR));
333 sh_vou_schedule_next(vou_dev, vb);
334 /* Only activate VOU after the second buffer */
335 } else if (vou_dev->active->queue.next == &vb->queue) {
336 /* Second buffer - initialise register side B */
337 sh_vou_reg_a_write(vou_dev, VOURPR, 0);
338 sh_vou_stream_start(vou_dev, vb);
340 /* Register side switching with frame VSYNC */
341 sh_vou_reg_a_write(vou_dev, VOURCR, 5);
342 dev_dbg(vou_dev->v4l2_dev.dev, "%s: second buffer status 0x%x\n",
343 __func__, sh_vou_reg_a_read(vou_dev, VOUSTR));
345 /* Enable End-of-Frame (VSYNC) interrupts */
346 sh_vou_reg_a_write(vou_dev, VOUIR, 0x10004);
347 /* Two buffers on the queue - activate the hardware */
349 vou_dev->status = SH_VOU_RUNNING;
350 sh_vou_reg_a_write(vou_dev, VOUER, 0x107);
354 static void sh_vou_buf_release(struct videobuf_queue *vq,
355 struct videobuf_buffer *vb)
357 struct video_device *vdev = vq->priv_data;
358 struct sh_vou_device *vou_dev = video_get_drvdata(vdev);
361 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
363 spin_lock_irqsave(&vou_dev->lock, flags);
365 if (vou_dev->active == vb) {
367 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
368 /* ...but the current frame will complete */
369 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
370 vou_dev->active = NULL;
373 if ((vb->state == VIDEOBUF_ACTIVE || vb->state == VIDEOBUF_QUEUED)) {
374 vb->state = VIDEOBUF_ERROR;
375 list_del(&vb->queue);
378 spin_unlock_irqrestore(&vou_dev->lock, flags);
383 static struct videobuf_queue_ops sh_vou_video_qops = {
384 .buf_setup = sh_vou_buf_setup,
385 .buf_prepare = sh_vou_buf_prepare,
386 .buf_queue = sh_vou_buf_queue,
387 .buf_release = sh_vou_buf_release,
391 static int sh_vou_querycap(struct file *file, void *priv,
392 struct v4l2_capability *cap)
394 struct sh_vou_device *vou_dev = video_drvdata(file);
396 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
398 strlcpy(cap->card, "SuperH VOU", sizeof(cap->card));
399 cap->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_STREAMING;
400 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
404 /* Enumerate formats, that the device can accept from the user */
405 static int sh_vou_enum_fmt_vid_out(struct file *file, void *priv,
406 struct v4l2_fmtdesc *fmt)
408 struct sh_vou_device *vou_dev = video_drvdata(file);
410 if (fmt->index >= ARRAY_SIZE(vou_fmt))
413 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
415 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
416 strlcpy(fmt->description, vou_fmt[fmt->index].desc,
417 sizeof(fmt->description));
418 fmt->pixelformat = vou_fmt[fmt->index].pfmt;
423 static int sh_vou_g_fmt_vid_out(struct file *file, void *priv,
424 struct v4l2_format *fmt)
426 struct sh_vou_device *vou_dev = video_drvdata(file);
428 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
430 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
431 fmt->fmt.pix = vou_dev->pix;
436 static const unsigned char vou_scale_h_num[] = {1, 9, 2, 9, 4};
437 static const unsigned char vou_scale_h_den[] = {1, 8, 1, 4, 1};
438 static const unsigned char vou_scale_h_fld[] = {0, 2, 1, 3};
439 static const unsigned char vou_scale_v_num[] = {1, 2, 4};
440 static const unsigned char vou_scale_v_den[] = {1, 1, 1};
441 static const unsigned char vou_scale_v_fld[] = {0, 1};
443 static void sh_vou_configure_geometry(struct sh_vou_device *vou_dev,
444 int pix_idx, int w_idx, int h_idx)
446 struct sh_vou_fmt *fmt = vou_fmt + pix_idx;
447 unsigned int black_left, black_top, width_max,
448 frame_in_height, frame_out_height, frame_out_top;
449 struct v4l2_rect *rect = &vou_dev->rect;
450 struct v4l2_pix_format *pix = &vou_dev->pix;
451 u32 vouvcr = 0, dsr_h, dsr_v;
453 if (vou_dev->std & V4L2_STD_525_60) {
455 /* height_max = 262; */
458 /* height_max = 312; */
461 frame_in_height = pix->height / 2;
462 frame_out_height = rect->height / 2;
463 frame_out_top = rect->top / 2;
466 * Cropping scheme: max useful image is 720x480, and the total video
467 * area is 858x525 (NTSC) or 864x625 (PAL). AK8813 / 8814 starts
468 * sampling data beginning with fixed 276th (NTSC) / 288th (PAL) clock,
469 * of which the first 33 / 25 clocks HSYNC must be held active. This
470 * has to be configured in CR[HW]. 1 pixel equals 2 clock periods.
471 * This gives CR[HW] = 16 / 12, VPR[HVP] = 138 / 144, which gives
472 * exactly 858 - 138 = 864 - 144 = 720! We call the out-of-display area,
473 * beyond DSR, specified on the left and top by the VPR register "black
474 * pixels" and out-of-image area (DPR) "background pixels." We fix VPR
475 * at 138 / 144 : 20, because that's the HSYNC timing, that our first
476 * client requires, and that's exactly what leaves us 720 pixels for the
477 * image; we leave VPR[VVP] at default 20 for now, because the client
478 * doesn't seem to have any special requirements for it. Otherwise we
479 * could also set it to max - 240 = 22 / 72. Thus VPR depends only on
480 * the selected standard, and DPR and DSR are selected according to
481 * cropping. Q: how does the client detect the first valid line? Does
482 * HSYNC stay inactive during invalid (black) lines?
484 black_left = width_max - VOU_MAX_IMAGE_WIDTH;
487 dsr_h = rect->width + rect->left;
488 dsr_v = frame_out_height + frame_out_top;
490 dev_dbg(vou_dev->v4l2_dev.dev,
491 "image %ux%u, black %u:%u, offset %u:%u, display %ux%u\n",
492 pix->width, frame_in_height, black_left, black_top,
493 rect->left, frame_out_top, dsr_h, dsr_v);
495 /* VOUISR height - half of a frame height in frame mode */
496 sh_vou_reg_ab_write(vou_dev, VOUISR, (pix->width << 16) | frame_in_height);
497 sh_vou_reg_ab_write(vou_dev, VOUVPR, (black_left << 16) | black_top);
498 sh_vou_reg_ab_write(vou_dev, VOUDPR, (rect->left << 16) | frame_out_top);
499 sh_vou_reg_ab_write(vou_dev, VOUDSR, (dsr_h << 16) | dsr_v);
502 * if necessary, we could set VOUHIR to
503 * max(black_left + dsr_h, width_max) here
507 vouvcr |= (1 << 15) | (vou_scale_h_fld[w_idx - 1] << 4);
509 vouvcr |= (1 << 14) | vou_scale_v_fld[h_idx - 1];
511 dev_dbg(vou_dev->v4l2_dev.dev, "%s: scaling 0x%x\n", fmt->desc, vouvcr);
513 /* To produce a colour bar for testing set bit 23 of VOUVCR */
514 sh_vou_reg_ab_write(vou_dev, VOUVCR, vouvcr);
515 sh_vou_reg_ab_write(vou_dev, VOUDFR,
516 fmt->pkf | (fmt->yf << 8) | (fmt->rgb << 16));
519 struct sh_vou_geometry {
520 struct v4l2_rect output;
521 unsigned int in_width;
522 unsigned int in_height;
528 * Find input geometry, that we can use to produce output, closest to the
529 * requested rectangle, using VOU scaling
531 static void vou_adjust_input(struct sh_vou_geometry *geo, v4l2_std_id std)
533 /* The compiler cannot know, that best and idx will indeed be set */
534 unsigned int best_err = UINT_MAX, best = 0, img_height_max;
537 if (std & V4L2_STD_525_60)
538 img_height_max = 480;
540 img_height_max = 576;
542 /* Image width must be a multiple of 4 */
543 v4l_bound_align_image(&geo->in_width, 0, VOU_MAX_IMAGE_WIDTH, 2,
544 &geo->in_height, 0, img_height_max, 1, 0);
546 /* Select scales to come as close as possible to the output image */
547 for (i = ARRAY_SIZE(vou_scale_h_num) - 1; i >= 0; i--) {
549 unsigned int found = geo->output.width * vou_scale_h_den[i] /
552 if (found > VOU_MAX_IMAGE_WIDTH)
553 /* scales increase */
556 err = abs(found - geo->in_width);
557 if (err < best_err) {
566 geo->in_width = best;
567 geo->scale_idx_h = idx;
571 /* This loop can be replaced with one division */
572 for (i = ARRAY_SIZE(vou_scale_v_num) - 1; i >= 0; i--) {
574 unsigned int found = geo->output.height * vou_scale_v_den[i] /
577 if (found > img_height_max)
578 /* scales increase */
581 err = abs(found - geo->in_height);
582 if (err < best_err) {
591 geo->in_height = best;
592 geo->scale_idx_v = idx;
596 * Find output geometry, that we can produce, using VOU scaling, closest to
597 * the requested rectangle
599 static void vou_adjust_output(struct sh_vou_geometry *geo, v4l2_std_id std)
601 unsigned int best_err = UINT_MAX, best = geo->in_width,
602 width_max, height_max, img_height_max;
605 if (std & V4L2_STD_525_60) {
607 height_max = 262 * 2;
608 img_height_max = 480;
611 height_max = 312 * 2;
612 img_height_max = 576;
615 /* Select scales to come as close as possible to the output image */
616 for (i = 0; i < ARRAY_SIZE(vou_scale_h_num); i++) {
618 unsigned int found = geo->in_width * vou_scale_h_num[i] /
621 if (found > VOU_MAX_IMAGE_WIDTH)
622 /* scales increase */
625 err = abs(found - geo->output.width);
626 if (err < best_err) {
635 geo->output.width = best;
636 geo->scale_idx_h = idx;
637 if (geo->output.left + best > width_max)
638 geo->output.left = width_max - best;
640 pr_debug("%s(): W %u * %u/%u = %u\n", __func__, geo->in_width,
641 vou_scale_h_num[idx], vou_scale_h_den[idx], best);
645 /* This loop can be replaced with one division */
646 for (i = 0; i < ARRAY_SIZE(vou_scale_v_num); i++) {
648 unsigned int found = geo->in_height * vou_scale_v_num[i] /
651 if (found > img_height_max)
652 /* scales increase */
655 err = abs(found - geo->output.height);
656 if (err < best_err) {
665 geo->output.height = best;
666 geo->scale_idx_v = idx;
667 if (geo->output.top + best > height_max)
668 geo->output.top = height_max - best;
670 pr_debug("%s(): H %u * %u/%u = %u\n", __func__, geo->in_height,
671 vou_scale_v_num[idx], vou_scale_v_den[idx], best);
674 static int sh_vou_s_fmt_vid_out(struct file *file, void *priv,
675 struct v4l2_format *fmt)
677 struct sh_vou_device *vou_dev = video_drvdata(file);
678 struct v4l2_pix_format *pix = &fmt->fmt.pix;
679 unsigned int img_height_max;
681 struct sh_vou_geometry geo;
682 struct v4l2_mbus_framefmt mbfmt = {
683 /* Revisit: is this the correct code? */
684 .code = MEDIA_BUS_FMT_YUYV8_2X8,
685 .field = V4L2_FIELD_INTERLACED,
686 .colorspace = V4L2_COLORSPACE_SMPTE170M,
690 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
691 vou_dev->rect.width, vou_dev->rect.height,
692 pix->width, pix->height);
694 if (pix->field == V4L2_FIELD_ANY)
695 pix->field = V4L2_FIELD_NONE;
697 if (fmt->type != V4L2_BUF_TYPE_VIDEO_OUTPUT ||
698 pix->field != V4L2_FIELD_NONE)
701 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
702 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
705 if (pix_idx == ARRAY_SIZE(vou_fmt))
708 if (vou_dev->std & V4L2_STD_525_60)
709 img_height_max = 480;
711 img_height_max = 576;
713 /* Image width must be a multiple of 4 */
714 v4l_bound_align_image(&pix->width, 0, VOU_MAX_IMAGE_WIDTH, 2,
715 &pix->height, 0, img_height_max, 1, 0);
717 geo.in_width = pix->width;
718 geo.in_height = pix->height;
719 geo.output = vou_dev->rect;
721 vou_adjust_output(&geo, vou_dev->std);
723 mbfmt.width = geo.output.width;
724 mbfmt.height = geo.output.height;
725 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
727 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
731 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
732 geo.output.width, geo.output.height, mbfmt.width, mbfmt.height);
735 if ((unsigned)mbfmt.width > VOU_MAX_IMAGE_WIDTH ||
736 (unsigned)mbfmt.height > img_height_max ||
737 mbfmt.code != MEDIA_BUS_FMT_YUYV8_2X8)
740 if (mbfmt.width != geo.output.width ||
741 mbfmt.height != geo.output.height) {
742 geo.output.width = mbfmt.width;
743 geo.output.height = mbfmt.height;
745 vou_adjust_input(&geo, vou_dev->std);
748 /* We tried to preserve output rectangle, but it could have changed */
749 vou_dev->rect = geo.output;
750 pix->width = geo.in_width;
751 pix->height = geo.in_height;
753 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u\n", __func__,
754 pix->width, pix->height);
756 vou_dev->pix_idx = pix_idx;
760 sh_vou_configure_geometry(vou_dev, pix_idx,
761 geo.scale_idx_h, geo.scale_idx_v);
766 static int sh_vou_try_fmt_vid_out(struct file *file, void *priv,
767 struct v4l2_format *fmt)
769 struct sh_vou_device *vou_dev = video_drvdata(file);
770 struct v4l2_pix_format *pix = &fmt->fmt.pix;
773 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
775 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
776 pix->field = V4L2_FIELD_NONE;
778 v4l_bound_align_image(&pix->width, 0, VOU_MAX_IMAGE_WIDTH, 1,
779 &pix->height, 0, VOU_MAX_IMAGE_HEIGHT, 1, 0);
781 for (i = 0; i < ARRAY_SIZE(vou_fmt); i++)
782 if (vou_fmt[i].pfmt == pix->pixelformat)
785 pix->pixelformat = vou_fmt[0].pfmt;
790 static int sh_vou_reqbufs(struct file *file, void *priv,
791 struct v4l2_requestbuffers *req)
793 struct sh_vou_device *vou_dev = video_drvdata(file);
794 struct sh_vou_file *vou_file = priv;
796 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
798 if (req->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
801 return videobuf_reqbufs(&vou_file->vbq, req);
804 static int sh_vou_querybuf(struct file *file, void *priv,
805 struct v4l2_buffer *b)
807 struct sh_vou_device *vou_dev = video_drvdata(file);
808 struct sh_vou_file *vou_file = priv;
810 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
812 return videobuf_querybuf(&vou_file->vbq, b);
815 static int sh_vou_qbuf(struct file *file, void *priv, struct v4l2_buffer *b)
817 struct sh_vou_device *vou_dev = video_drvdata(file);
818 struct sh_vou_file *vou_file = priv;
820 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
822 return videobuf_qbuf(&vou_file->vbq, b);
825 static int sh_vou_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b)
827 struct sh_vou_device *vou_dev = video_drvdata(file);
828 struct sh_vou_file *vou_file = priv;
830 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
832 return videobuf_dqbuf(&vou_file->vbq, b, file->f_flags & O_NONBLOCK);
835 static int sh_vou_streamon(struct file *file, void *priv,
836 enum v4l2_buf_type buftype)
838 struct sh_vou_device *vou_dev = video_drvdata(file);
839 struct sh_vou_file *vou_file = priv;
842 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
844 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
846 if (ret < 0 && ret != -ENOIOCTLCMD)
849 /* This calls our .buf_queue() (== sh_vou_buf_queue) */
850 return videobuf_streamon(&vou_file->vbq);
853 static int sh_vou_streamoff(struct file *file, void *priv,
854 enum v4l2_buf_type buftype)
856 struct sh_vou_device *vou_dev = video_drvdata(file);
857 struct sh_vou_file *vou_file = priv;
859 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
862 * This calls buf_release from host driver's videobuf_queue_ops for all
863 * remaining buffers. When the last buffer is freed, stop streaming
865 videobuf_streamoff(&vou_file->vbq);
866 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video, s_stream, 0);
871 static u32 sh_vou_ntsc_mode(enum sh_vou_bus_fmt bus_fmt)
875 pr_warning("%s(): Invalid bus-format code %d, using default 8-bit\n",
877 case SH_VOU_BUS_8BIT:
879 case SH_VOU_BUS_16BIT:
881 case SH_VOU_BUS_BT656:
886 static int sh_vou_s_std(struct file *file, void *priv, v4l2_std_id std_id)
888 struct sh_vou_device *vou_dev = video_drvdata(file);
891 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): 0x%llx\n", __func__, std_id);
893 if (std_id & ~vou_dev->vdev->tvnorms)
896 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
897 s_std_output, std_id);
898 /* Shall we continue, if the subdev doesn't support .s_std_output()? */
899 if (ret < 0 && ret != -ENOIOCTLCMD)
902 if (std_id & V4L2_STD_525_60)
903 sh_vou_reg_ab_set(vou_dev, VOUCR,
904 sh_vou_ntsc_mode(vou_dev->pdata->bus_fmt) << 29, 7 << 29);
906 sh_vou_reg_ab_set(vou_dev, VOUCR, 5 << 29, 7 << 29);
908 vou_dev->std = std_id;
913 static int sh_vou_g_std(struct file *file, void *priv, v4l2_std_id *std)
915 struct sh_vou_device *vou_dev = video_drvdata(file);
917 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
924 static int sh_vou_g_crop(struct file *file, void *fh, struct v4l2_crop *a)
926 struct sh_vou_device *vou_dev = video_drvdata(file);
928 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
930 a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
931 a->c = vou_dev->rect;
936 /* Assume a dull encoder, do all the work ourselves. */
937 static int sh_vou_s_crop(struct file *file, void *fh, const struct v4l2_crop *a)
939 struct v4l2_crop a_writable = *a;
940 struct sh_vou_device *vou_dev = video_drvdata(file);
941 struct v4l2_rect *rect = &a_writable.c;
942 struct v4l2_crop sd_crop = {.type = V4L2_BUF_TYPE_VIDEO_OUTPUT};
943 struct v4l2_pix_format *pix = &vou_dev->pix;
944 struct sh_vou_geometry geo;
945 struct v4l2_mbus_framefmt mbfmt = {
946 /* Revisit: is this the correct code? */
947 .code = MEDIA_BUS_FMT_YUYV8_2X8,
948 .field = V4L2_FIELD_INTERLACED,
949 .colorspace = V4L2_COLORSPACE_SMPTE170M,
951 unsigned int img_height_max;
954 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u@%u:%u\n", __func__,
955 rect->width, rect->height, rect->left, rect->top);
957 if (a->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
960 if (vou_dev->std & V4L2_STD_525_60)
961 img_height_max = 480;
963 img_height_max = 576;
965 v4l_bound_align_image(&rect->width, 0, VOU_MAX_IMAGE_WIDTH, 1,
966 &rect->height, 0, img_height_max, 1, 0);
968 if (rect->width + rect->left > VOU_MAX_IMAGE_WIDTH)
969 rect->left = VOU_MAX_IMAGE_WIDTH - rect->width;
971 if (rect->height + rect->top > img_height_max)
972 rect->top = img_height_max - rect->height;
975 geo.in_width = pix->width;
976 geo.in_height = pix->height;
978 /* Configure the encoder one-to-one, position at 0, ignore errors */
979 sd_crop.c.width = geo.output.width;
980 sd_crop.c.height = geo.output.height;
982 * We first issue a S_CROP, so that the subsequent S_FMT delivers the
983 * final encoder configuration.
985 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
987 mbfmt.width = geo.output.width;
988 mbfmt.height = geo.output.height;
989 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
991 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
996 if ((unsigned)mbfmt.width > VOU_MAX_IMAGE_WIDTH ||
997 (unsigned)mbfmt.height > img_height_max ||
998 mbfmt.code != MEDIA_BUS_FMT_YUYV8_2X8)
1001 geo.output.width = mbfmt.width;
1002 geo.output.height = mbfmt.height;
1005 * No down-scaling. According to the API, current call has precedence:
1006 * http://v4l2spec.bytesex.org/spec/x1904.htm#AEN1954 paragraph two.
1008 vou_adjust_input(&geo, vou_dev->std);
1010 /* We tried to preserve output rectangle, but it could have changed */
1011 vou_dev->rect = geo.output;
1012 pix->width = geo.in_width;
1013 pix->height = geo.in_height;
1015 sh_vou_configure_geometry(vou_dev, vou_dev->pix_idx,
1016 geo.scale_idx_h, geo.scale_idx_v);
1022 * Total field: NTSC 858 x 2 * 262/263, PAL 864 x 2 * 312/313, default rectangle
1023 * is the initial register values, height takes the interlaced format into
1024 * account. The actual image can only go up to 720 x 2 * 240, So, VOUVPR can
1025 * actually only meaningfully contain values <= 720 and <= 240 respectively, and
1026 * not <= 864 and <= 312.
1028 static int sh_vou_cropcap(struct file *file, void *priv,
1029 struct v4l2_cropcap *a)
1031 struct sh_vou_device *vou_dev = video_drvdata(file);
1033 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
1035 a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
1038 a->bounds.width = VOU_MAX_IMAGE_WIDTH;
1039 a->bounds.height = VOU_MAX_IMAGE_HEIGHT;
1040 /* Default = max, set VOUDPR = 0, which is not hardware default */
1041 a->defrect.left = 0;
1043 a->defrect.width = VOU_MAX_IMAGE_WIDTH;
1044 a->defrect.height = VOU_MAX_IMAGE_HEIGHT;
1045 a->pixelaspect.numerator = 1;
1046 a->pixelaspect.denominator = 1;
1051 static irqreturn_t sh_vou_isr(int irq, void *dev_id)
1053 struct sh_vou_device *vou_dev = dev_id;
1054 static unsigned long j;
1055 struct videobuf_buffer *vb;
1057 u32 irq_status = sh_vou_reg_a_read(vou_dev, VOUIR), masked;
1058 u32 vou_status = sh_vou_reg_a_read(vou_dev, VOUSTR);
1060 if (!(irq_status & 0x300)) {
1061 if (printk_timed_ratelimit(&j, 500))
1062 dev_warn(vou_dev->v4l2_dev.dev, "IRQ status 0x%x!\n",
1067 spin_lock(&vou_dev->lock);
1068 if (!vou_dev->active || list_empty(&vou_dev->queue)) {
1069 if (printk_timed_ratelimit(&j, 500))
1070 dev_warn(vou_dev->v4l2_dev.dev,
1071 "IRQ without active buffer: %x!\n", irq_status);
1072 /* Just ack: buf_release will disable further interrupts */
1073 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x300);
1074 spin_unlock(&vou_dev->lock);
1078 masked = ~(0x300 & irq_status) & irq_status & 0x30304;
1079 dev_dbg(vou_dev->v4l2_dev.dev,
1080 "IRQ status 0x%x -> 0x%x, VOU status 0x%x, cnt %d\n",
1081 irq_status, masked, vou_status, cnt);
1084 /* side = vou_status & 0x10000; */
1086 /* Clear only set interrupts */
1087 sh_vou_reg_a_write(vou_dev, VOUIR, masked);
1089 vb = vou_dev->active;
1090 list_del(&vb->queue);
1092 vb->state = VIDEOBUF_DONE;
1093 v4l2_get_timestamp(&vb->ts);
1097 if (list_empty(&vou_dev->queue)) {
1099 dev_dbg(vou_dev->v4l2_dev.dev, "%s: queue empty after %d\n",
1101 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
1102 vou_dev->active = NULL;
1103 vou_dev->status = SH_VOU_INITIALISING;
1104 /* Disable End-of-Frame (VSYNC) interrupts */
1105 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
1106 spin_unlock(&vou_dev->lock);
1110 vou_dev->active = list_entry(vou_dev->queue.next,
1111 struct videobuf_buffer, queue);
1113 if (vou_dev->active->queue.next != &vou_dev->queue) {
1114 struct videobuf_buffer *new = list_entry(vou_dev->active->queue.next,
1115 struct videobuf_buffer, queue);
1116 sh_vou_schedule_next(vou_dev, new);
1119 spin_unlock(&vou_dev->lock);
1124 static int sh_vou_hw_init(struct sh_vou_device *vou_dev)
1126 struct sh_vou_pdata *pdata = vou_dev->pdata;
1127 u32 voucr = sh_vou_ntsc_mode(pdata->bus_fmt) << 29;
1130 /* Disable all IRQs */
1131 sh_vou_reg_a_write(vou_dev, VOUIR, 0);
1133 /* Reset VOU interfaces - registers unaffected */
1134 sh_vou_reg_a_write(vou_dev, VOUSRR, 0x101);
1135 while (--i && (sh_vou_reg_a_read(vou_dev, VOUSRR) & 0x101))
1141 dev_dbg(vou_dev->v4l2_dev.dev, "Reset took %dus\n", 100 - i);
1143 if (pdata->flags & SH_VOU_PCLK_FALLING)
1145 if (pdata->flags & SH_VOU_HSYNC_LOW)
1147 if (pdata->flags & SH_VOU_VSYNC_LOW)
1149 sh_vou_reg_ab_set(vou_dev, VOUCR, voucr, 0xfc000000);
1151 /* Manual register side switching at first */
1152 sh_vou_reg_a_write(vou_dev, VOURCR, 4);
1153 /* Default - fixed HSYNC length, can be made configurable is required */
1154 sh_vou_reg_ab_write(vou_dev, VOUMSR, 0x800000);
1159 /* File operations */
1160 static int sh_vou_open(struct file *file)
1162 struct sh_vou_device *vou_dev = video_drvdata(file);
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 (mutex_lock_interruptible(&vou_dev->fop_lock))
1174 return -ERESTARTSYS;
1175 if (atomic_inc_return(&vou_dev->use_count) == 1) {
1178 vou_dev->status = SH_VOU_INITIALISING;
1179 pm_runtime_get_sync(vou_dev->v4l2_dev.dev);
1180 ret = sh_vou_hw_init(vou_dev);
1182 atomic_dec(&vou_dev->use_count);
1183 pm_runtime_put(vou_dev->v4l2_dev.dev);
1184 vou_dev->status = SH_VOU_IDLE;
1185 mutex_unlock(&vou_dev->fop_lock);
1190 videobuf_queue_dma_contig_init(&vou_file->vbq, &sh_vou_video_qops,
1191 vou_dev->v4l2_dev.dev, &vou_dev->lock,
1192 V4L2_BUF_TYPE_VIDEO_OUTPUT,
1194 sizeof(struct videobuf_buffer),
1195 vou_dev->vdev, &vou_dev->fop_lock);
1196 mutex_unlock(&vou_dev->fop_lock);
1201 static int sh_vou_release(struct file *file)
1203 struct sh_vou_device *vou_dev = video_drvdata(file);
1204 struct sh_vou_file *vou_file = file->private_data;
1206 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
1208 if (!atomic_dec_return(&vou_dev->use_count)) {
1209 mutex_lock(&vou_dev->fop_lock);
1211 vou_dev->status = SH_VOU_IDLE;
1212 sh_vou_reg_a_set(vou_dev, VOUER, 0, 0x101);
1213 pm_runtime_put(vou_dev->v4l2_dev.dev);
1214 mutex_unlock(&vou_dev->fop_lock);
1217 file->private_data = NULL;
1223 static int sh_vou_mmap(struct file *file, struct vm_area_struct *vma)
1225 struct sh_vou_device *vou_dev = video_drvdata(file);
1226 struct sh_vou_file *vou_file = file->private_data;
1229 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
1231 if (mutex_lock_interruptible(&vou_dev->fop_lock))
1232 return -ERESTARTSYS;
1233 ret = videobuf_mmap_mapper(&vou_file->vbq, vma);
1234 mutex_unlock(&vou_dev->fop_lock);
1238 static unsigned int sh_vou_poll(struct file *file, poll_table *wait)
1240 struct sh_vou_device *vou_dev = video_drvdata(file);
1241 struct sh_vou_file *vou_file = file->private_data;
1244 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
1246 mutex_lock(&vou_dev->fop_lock);
1247 res = videobuf_poll_stream(file, &vou_file->vbq, wait);
1248 mutex_unlock(&vou_dev->fop_lock);
1252 /* sh_vou display ioctl operations */
1253 static const struct v4l2_ioctl_ops sh_vou_ioctl_ops = {
1254 .vidioc_querycap = sh_vou_querycap,
1255 .vidioc_enum_fmt_vid_out = sh_vou_enum_fmt_vid_out,
1256 .vidioc_g_fmt_vid_out = sh_vou_g_fmt_vid_out,
1257 .vidioc_s_fmt_vid_out = sh_vou_s_fmt_vid_out,
1258 .vidioc_try_fmt_vid_out = sh_vou_try_fmt_vid_out,
1259 .vidioc_reqbufs = sh_vou_reqbufs,
1260 .vidioc_querybuf = sh_vou_querybuf,
1261 .vidioc_qbuf = sh_vou_qbuf,
1262 .vidioc_dqbuf = sh_vou_dqbuf,
1263 .vidioc_streamon = sh_vou_streamon,
1264 .vidioc_streamoff = sh_vou_streamoff,
1265 .vidioc_s_std = sh_vou_s_std,
1266 .vidioc_g_std = sh_vou_g_std,
1267 .vidioc_cropcap = sh_vou_cropcap,
1268 .vidioc_g_crop = sh_vou_g_crop,
1269 .vidioc_s_crop = sh_vou_s_crop,
1272 static const struct v4l2_file_operations sh_vou_fops = {
1273 .owner = THIS_MODULE,
1274 .open = sh_vou_open,
1275 .release = sh_vou_release,
1276 .unlocked_ioctl = video_ioctl2,
1277 .mmap = sh_vou_mmap,
1278 .poll = sh_vou_poll,
1281 static const struct video_device sh_vou_video_template = {
1283 .fops = &sh_vou_fops,
1284 .ioctl_ops = &sh_vou_ioctl_ops,
1285 .tvnorms = V4L2_STD_525_60, /* PAL only supported in 8-bit non-bt656 mode */
1286 .vfl_dir = VFL_DIR_TX,
1289 static int sh_vou_probe(struct platform_device *pdev)
1291 struct sh_vou_pdata *vou_pdata = pdev->dev.platform_data;
1292 struct v4l2_rect *rect;
1293 struct v4l2_pix_format *pix;
1294 struct i2c_adapter *i2c_adap;
1295 struct video_device *vdev;
1296 struct sh_vou_device *vou_dev;
1297 struct resource *reg_res, *region;
1298 struct v4l2_subdev *subdev;
1301 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1302 irq = platform_get_irq(pdev, 0);
1304 if (!vou_pdata || !reg_res || irq <= 0) {
1305 dev_err(&pdev->dev, "Insufficient VOU platform information.\n");
1309 vou_dev = kzalloc(sizeof(*vou_dev), GFP_KERNEL);
1313 INIT_LIST_HEAD(&vou_dev->queue);
1314 spin_lock_init(&vou_dev->lock);
1315 mutex_init(&vou_dev->fop_lock);
1316 atomic_set(&vou_dev->use_count, 0);
1317 vou_dev->pdata = vou_pdata;
1318 vou_dev->status = SH_VOU_IDLE;
1320 rect = &vou_dev->rect;
1321 pix = &vou_dev->pix;
1323 /* Fill in defaults */
1324 vou_dev->std = V4L2_STD_NTSC_M;
1327 rect->width = VOU_MAX_IMAGE_WIDTH;
1329 pix->width = VOU_MAX_IMAGE_WIDTH;
1331 pix->pixelformat = V4L2_PIX_FMT_YVYU;
1332 pix->field = V4L2_FIELD_NONE;
1333 pix->bytesperline = VOU_MAX_IMAGE_WIDTH * 2;
1334 pix->sizeimage = VOU_MAX_IMAGE_WIDTH * 2 * 480;
1335 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
1337 region = request_mem_region(reg_res->start, resource_size(reg_res),
1340 dev_err(&pdev->dev, "VOU region already claimed\n");
1345 vou_dev->base = ioremap(reg_res->start, resource_size(reg_res));
1346 if (!vou_dev->base) {
1351 ret = request_irq(irq, sh_vou_isr, 0, "vou", vou_dev);
1355 ret = v4l2_device_register(&pdev->dev, &vou_dev->v4l2_dev);
1357 dev_err(&pdev->dev, "Error registering v4l2 device\n");
1361 /* Allocate memory for video device */
1362 vdev = video_device_alloc();
1368 *vdev = sh_vou_video_template;
1369 if (vou_pdata->bus_fmt == SH_VOU_BUS_8BIT)
1370 vdev->tvnorms |= V4L2_STD_PAL;
1371 vdev->v4l2_dev = &vou_dev->v4l2_dev;
1372 vdev->release = video_device_release;
1373 vdev->lock = &vou_dev->fop_lock;
1375 vou_dev->vdev = vdev;
1376 video_set_drvdata(vdev, vou_dev);
1378 pm_runtime_enable(&pdev->dev);
1379 pm_runtime_resume(&pdev->dev);
1381 i2c_adap = i2c_get_adapter(vou_pdata->i2c_adap);
1387 ret = sh_vou_hw_init(vou_dev);
1391 subdev = v4l2_i2c_new_subdev_board(&vou_dev->v4l2_dev, i2c_adap,
1392 vou_pdata->board_info, NULL);
1398 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1407 i2c_put_adapter(i2c_adap);
1409 video_device_release(vdev);
1410 pm_runtime_disable(&pdev->dev);
1412 v4l2_device_unregister(&vou_dev->v4l2_dev);
1414 free_irq(irq, vou_dev);
1416 iounmap(vou_dev->base);
1418 release_mem_region(reg_res->start, resource_size(reg_res));
1424 static int sh_vou_remove(struct platform_device *pdev)
1426 int irq = platform_get_irq(pdev, 0);
1427 struct v4l2_device *v4l2_dev = platform_get_drvdata(pdev);
1428 struct sh_vou_device *vou_dev = container_of(v4l2_dev,
1429 struct sh_vou_device, v4l2_dev);
1430 struct v4l2_subdev *sd = list_entry(v4l2_dev->subdevs.next,
1431 struct v4l2_subdev, list);
1432 struct i2c_client *client = v4l2_get_subdevdata(sd);
1433 struct resource *reg_res;
1436 free_irq(irq, vou_dev);
1437 pm_runtime_disable(&pdev->dev);
1438 video_unregister_device(vou_dev->vdev);
1439 i2c_put_adapter(client->adapter);
1440 v4l2_device_unregister(&vou_dev->v4l2_dev);
1441 iounmap(vou_dev->base);
1442 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1444 release_mem_region(reg_res->start, resource_size(reg_res));
1449 static struct platform_driver __refdata sh_vou = {
1450 .remove = sh_vou_remove,
1456 module_platform_driver_probe(sh_vou, sh_vou_probe);
1458 MODULE_DESCRIPTION("SuperH VOU driver");
1459 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
1460 MODULE_LICENSE("GPL v2");
1461 MODULE_VERSION("0.1.0");
1462 MODULE_ALIAS("platform:sh-vou");