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/drv-intf/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/videobuf2-v4l2.h>
31 #include <media/videobuf2-dma-contig.h>
33 /* Mirror addresses are not available for all registers */
61 #define VOU_MIN_IMAGE_WIDTH 16
62 #define VOU_MAX_IMAGE_WIDTH 720
63 #define VOU_MIN_IMAGE_HEIGHT 16
65 struct sh_vou_buffer {
66 struct vb2_v4l2_buffer vb;
67 struct list_head list;
71 sh_vou_buffer *to_sh_vou_buffer(struct vb2_v4l2_buffer *vb2)
73 return container_of(vb2, struct sh_vou_buffer, vb);
76 struct sh_vou_device {
77 struct v4l2_device v4l2_dev;
78 struct video_device vdev;
79 struct sh_vou_pdata *pdata;
82 /* State information */
83 struct v4l2_pix_format pix;
84 struct v4l2_rect rect;
85 struct list_head buf_list;
88 struct vb2_queue queue;
89 struct vb2_alloc_ctx *alloc_ctx;
90 struct sh_vou_buffer *active;
91 enum sh_vou_status status;
93 struct mutex fop_lock;
96 /* Register access routines for sides A, B and mirror addresses */
97 static void sh_vou_reg_a_write(struct sh_vou_device *vou_dev, unsigned int reg,
100 __raw_writel(value, vou_dev->base + reg);
103 static void sh_vou_reg_ab_write(struct sh_vou_device *vou_dev, unsigned int reg,
106 __raw_writel(value, vou_dev->base + reg);
107 __raw_writel(value, vou_dev->base + reg + 0x1000);
110 static void sh_vou_reg_m_write(struct sh_vou_device *vou_dev, unsigned int reg,
113 __raw_writel(value, vou_dev->base + reg + 0x2000);
116 static u32 sh_vou_reg_a_read(struct sh_vou_device *vou_dev, unsigned int reg)
118 return __raw_readl(vou_dev->base + reg);
121 static void sh_vou_reg_a_set(struct sh_vou_device *vou_dev, unsigned int reg,
124 u32 old = __raw_readl(vou_dev->base + reg);
126 value = (value & mask) | (old & ~mask);
127 __raw_writel(value, vou_dev->base + reg);
130 static void sh_vou_reg_b_set(struct sh_vou_device *vou_dev, unsigned int reg,
133 sh_vou_reg_a_set(vou_dev, reg + 0x1000, value, mask);
136 static void sh_vou_reg_ab_set(struct sh_vou_device *vou_dev, unsigned int reg,
139 sh_vou_reg_a_set(vou_dev, reg, value, mask);
140 sh_vou_reg_b_set(vou_dev, reg, value, mask);
153 /* Further pixel formats can be added */
154 static struct sh_vou_fmt vou_fmt[] = {
156 .pfmt = V4L2_PIX_FMT_NV12,
159 .desc = "YVU420 planar",
164 .pfmt = V4L2_PIX_FMT_NV16,
167 .desc = "YVYU planar",
172 .pfmt = V4L2_PIX_FMT_RGB24,
180 .pfmt = V4L2_PIX_FMT_RGB565,
188 .pfmt = V4L2_PIX_FMT_RGB565X,
191 .desc = "RGB565 byteswapped",
197 static void sh_vou_schedule_next(struct sh_vou_device *vou_dev,
198 struct vb2_v4l2_buffer *vbuf)
200 dma_addr_t addr1, addr2;
202 addr1 = vb2_dma_contig_plane_dma_addr(&vbuf->vb2_buf, 0);
203 switch (vou_dev->pix.pixelformat) {
204 case V4L2_PIX_FMT_NV12:
205 case V4L2_PIX_FMT_NV16:
206 addr2 = addr1 + vou_dev->pix.width * vou_dev->pix.height;
212 sh_vou_reg_m_write(vou_dev, VOUAD1R, addr1);
213 sh_vou_reg_m_write(vou_dev, VOUAD2R, addr2);
216 static void sh_vou_stream_config(struct sh_vou_device *vou_dev)
218 unsigned int row_coeff;
219 #ifdef __LITTLE_ENDIAN
225 switch (vou_dev->pix.pixelformat) {
227 case V4L2_PIX_FMT_NV12:
228 case V4L2_PIX_FMT_NV16:
231 case V4L2_PIX_FMT_RGB565:
233 case V4L2_PIX_FMT_RGB565X:
236 case V4L2_PIX_FMT_RGB24:
241 sh_vou_reg_a_write(vou_dev, VOUSWR, dataswap);
242 sh_vou_reg_ab_write(vou_dev, VOUAIR, vou_dev->pix.width * row_coeff);
245 /* Locking: caller holds fop_lock mutex */
246 static int sh_vou_queue_setup(struct vb2_queue *vq,
247 unsigned int *nbuffers, unsigned int *nplanes,
248 unsigned int sizes[], void *alloc_ctxs[])
250 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
251 struct v4l2_pix_format *pix = &vou_dev->pix;
252 int bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
254 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
256 alloc_ctxs[0] = vou_dev->alloc_ctx;
258 return sizes[0] < pix->height * bytes_per_line ? -EINVAL : 0;
260 sizes[0] = pix->height * bytes_per_line;
264 static int sh_vou_buf_prepare(struct vb2_buffer *vb)
266 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vb->vb2_queue);
267 struct v4l2_pix_format *pix = &vou_dev->pix;
268 unsigned bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
269 unsigned size = pix->height * bytes_per_line;
271 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
273 if (vb2_plane_size(vb, 0) < size) {
274 /* User buffer too small */
275 dev_warn(vou_dev->v4l2_dev.dev, "buffer too small (%lu < %u)\n",
276 vb2_plane_size(vb, 0), size);
280 vb2_set_plane_payload(vb, 0, size);
284 /* Locking: caller holds fop_lock mutex and vq->irqlock spinlock */
285 static void sh_vou_buf_queue(struct vb2_buffer *vb)
287 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
288 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vb->vb2_queue);
289 struct sh_vou_buffer *shbuf = to_sh_vou_buffer(vbuf);
292 spin_lock_irqsave(&vou_dev->lock, flags);
293 list_add_tail(&shbuf->list, &vou_dev->buf_list);
294 spin_unlock_irqrestore(&vou_dev->lock, flags);
297 static int sh_vou_start_streaming(struct vb2_queue *vq, unsigned int count)
299 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
300 struct sh_vou_buffer *buf, *node;
303 vou_dev->sequence = 0;
304 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
306 if (ret < 0 && ret != -ENOIOCTLCMD) {
307 list_for_each_entry_safe(buf, node, &vou_dev->buf_list, list) {
308 vb2_buffer_done(&buf->vb.vb2_buf,
309 VB2_BUF_STATE_QUEUED);
310 list_del(&buf->list);
312 vou_dev->active = NULL;
316 buf = list_entry(vou_dev->buf_list.next, struct sh_vou_buffer, list);
318 vou_dev->active = buf;
320 /* Start from side A: we use mirror addresses, so, set B */
321 sh_vou_reg_a_write(vou_dev, VOURPR, 1);
322 dev_dbg(vou_dev->v4l2_dev.dev, "%s: first buffer status 0x%x\n",
323 __func__, sh_vou_reg_a_read(vou_dev, VOUSTR));
324 sh_vou_schedule_next(vou_dev, &buf->vb);
326 buf = list_entry(buf->list.next, struct sh_vou_buffer, list);
328 /* Second buffer - initialise register side B */
329 sh_vou_reg_a_write(vou_dev, VOURPR, 0);
330 sh_vou_schedule_next(vou_dev, &buf->vb);
332 /* Register side switching with frame VSYNC */
333 sh_vou_reg_a_write(vou_dev, VOURCR, 5);
335 sh_vou_stream_config(vou_dev);
336 /* Enable End-of-Frame (VSYNC) interrupts */
337 sh_vou_reg_a_write(vou_dev, VOUIR, 0x10004);
339 /* Two buffers on the queue - activate the hardware */
340 vou_dev->status = SH_VOU_RUNNING;
341 sh_vou_reg_a_write(vou_dev, VOUER, 0x107);
345 static void sh_vou_stop_streaming(struct vb2_queue *vq)
347 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
348 struct sh_vou_buffer *buf, *node;
351 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
354 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
355 /* ...but the current frame will complete */
356 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
358 spin_lock_irqsave(&vou_dev->lock, flags);
359 list_for_each_entry_safe(buf, node, &vou_dev->buf_list, list) {
360 vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR);
361 list_del(&buf->list);
363 vou_dev->active = NULL;
364 spin_unlock_irqrestore(&vou_dev->lock, flags);
367 static struct vb2_ops sh_vou_qops = {
368 .queue_setup = sh_vou_queue_setup,
369 .buf_prepare = sh_vou_buf_prepare,
370 .buf_queue = sh_vou_buf_queue,
371 .start_streaming = sh_vou_start_streaming,
372 .stop_streaming = sh_vou_stop_streaming,
373 .wait_prepare = vb2_ops_wait_prepare,
374 .wait_finish = vb2_ops_wait_finish,
378 static int sh_vou_querycap(struct file *file, void *priv,
379 struct v4l2_capability *cap)
381 struct sh_vou_device *vou_dev = video_drvdata(file);
383 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
385 strlcpy(cap->card, "SuperH VOU", sizeof(cap->card));
386 strlcpy(cap->driver, "sh-vou", sizeof(cap->driver));
387 strlcpy(cap->bus_info, "platform:sh-vou", sizeof(cap->bus_info));
388 cap->device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_READWRITE |
390 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
394 /* Enumerate formats, that the device can accept from the user */
395 static int sh_vou_enum_fmt_vid_out(struct file *file, void *priv,
396 struct v4l2_fmtdesc *fmt)
398 struct sh_vou_device *vou_dev = video_drvdata(file);
400 if (fmt->index >= ARRAY_SIZE(vou_fmt))
403 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
405 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
406 strlcpy(fmt->description, vou_fmt[fmt->index].desc,
407 sizeof(fmt->description));
408 fmt->pixelformat = vou_fmt[fmt->index].pfmt;
413 static int sh_vou_g_fmt_vid_out(struct file *file, void *priv,
414 struct v4l2_format *fmt)
416 struct sh_vou_device *vou_dev = video_drvdata(file);
418 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
420 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
421 fmt->fmt.pix = vou_dev->pix;
426 static const unsigned char vou_scale_h_num[] = {1, 9, 2, 9, 4};
427 static const unsigned char vou_scale_h_den[] = {1, 8, 1, 4, 1};
428 static const unsigned char vou_scale_h_fld[] = {0, 2, 1, 3};
429 static const unsigned char vou_scale_v_num[] = {1, 2, 4};
430 static const unsigned char vou_scale_v_den[] = {1, 1, 1};
431 static const unsigned char vou_scale_v_fld[] = {0, 1};
433 static void sh_vou_configure_geometry(struct sh_vou_device *vou_dev,
434 int pix_idx, int w_idx, int h_idx)
436 struct sh_vou_fmt *fmt = vou_fmt + pix_idx;
437 unsigned int black_left, black_top, width_max,
438 frame_in_height, frame_out_height, frame_out_top;
439 struct v4l2_rect *rect = &vou_dev->rect;
440 struct v4l2_pix_format *pix = &vou_dev->pix;
441 u32 vouvcr = 0, dsr_h, dsr_v;
443 if (vou_dev->std & V4L2_STD_525_60) {
445 /* height_max = 262; */
448 /* height_max = 312; */
451 frame_in_height = pix->height / 2;
452 frame_out_height = rect->height / 2;
453 frame_out_top = rect->top / 2;
456 * Cropping scheme: max useful image is 720x480, and the total video
457 * area is 858x525 (NTSC) or 864x625 (PAL). AK8813 / 8814 starts
458 * sampling data beginning with fixed 276th (NTSC) / 288th (PAL) clock,
459 * of which the first 33 / 25 clocks HSYNC must be held active. This
460 * has to be configured in CR[HW]. 1 pixel equals 2 clock periods.
461 * This gives CR[HW] = 16 / 12, VPR[HVP] = 138 / 144, which gives
462 * exactly 858 - 138 = 864 - 144 = 720! We call the out-of-display area,
463 * beyond DSR, specified on the left and top by the VPR register "black
464 * pixels" and out-of-image area (DPR) "background pixels." We fix VPR
465 * at 138 / 144 : 20, because that's the HSYNC timing, that our first
466 * client requires, and that's exactly what leaves us 720 pixels for the
467 * image; we leave VPR[VVP] at default 20 for now, because the client
468 * doesn't seem to have any special requirements for it. Otherwise we
469 * could also set it to max - 240 = 22 / 72. Thus VPR depends only on
470 * the selected standard, and DPR and DSR are selected according to
471 * cropping. Q: how does the client detect the first valid line? Does
472 * HSYNC stay inactive during invalid (black) lines?
474 black_left = width_max - VOU_MAX_IMAGE_WIDTH;
477 dsr_h = rect->width + rect->left;
478 dsr_v = frame_out_height + frame_out_top;
480 dev_dbg(vou_dev->v4l2_dev.dev,
481 "image %ux%u, black %u:%u, offset %u:%u, display %ux%u\n",
482 pix->width, frame_in_height, black_left, black_top,
483 rect->left, frame_out_top, dsr_h, dsr_v);
485 /* VOUISR height - half of a frame height in frame mode */
486 sh_vou_reg_ab_write(vou_dev, VOUISR, (pix->width << 16) | frame_in_height);
487 sh_vou_reg_ab_write(vou_dev, VOUVPR, (black_left << 16) | black_top);
488 sh_vou_reg_ab_write(vou_dev, VOUDPR, (rect->left << 16) | frame_out_top);
489 sh_vou_reg_ab_write(vou_dev, VOUDSR, (dsr_h << 16) | dsr_v);
492 * if necessary, we could set VOUHIR to
493 * max(black_left + dsr_h, width_max) here
497 vouvcr |= (1 << 15) | (vou_scale_h_fld[w_idx - 1] << 4);
499 vouvcr |= (1 << 14) | vou_scale_v_fld[h_idx - 1];
501 dev_dbg(vou_dev->v4l2_dev.dev, "%s: scaling 0x%x\n", fmt->desc, vouvcr);
503 /* To produce a colour bar for testing set bit 23 of VOUVCR */
504 sh_vou_reg_ab_write(vou_dev, VOUVCR, vouvcr);
505 sh_vou_reg_ab_write(vou_dev, VOUDFR,
506 fmt->pkf | (fmt->yf << 8) | (fmt->rgb << 16));
509 struct sh_vou_geometry {
510 struct v4l2_rect output;
511 unsigned int in_width;
512 unsigned int in_height;
518 * Find input geometry, that we can use to produce output, closest to the
519 * requested rectangle, using VOU scaling
521 static void vou_adjust_input(struct sh_vou_geometry *geo, v4l2_std_id std)
523 /* The compiler cannot know, that best and idx will indeed be set */
524 unsigned int best_err = UINT_MAX, best = 0, img_height_max;
527 if (std & V4L2_STD_525_60)
528 img_height_max = 480;
530 img_height_max = 576;
532 /* Image width must be a multiple of 4 */
533 v4l_bound_align_image(&geo->in_width,
534 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 2,
536 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
538 /* Select scales to come as close as possible to the output image */
539 for (i = ARRAY_SIZE(vou_scale_h_num) - 1; i >= 0; i--) {
541 unsigned int found = geo->output.width * vou_scale_h_den[i] /
544 if (found > VOU_MAX_IMAGE_WIDTH)
545 /* scales increase */
548 err = abs(found - geo->in_width);
549 if (err < best_err) {
558 geo->in_width = best;
559 geo->scale_idx_h = idx;
563 /* This loop can be replaced with one division */
564 for (i = ARRAY_SIZE(vou_scale_v_num) - 1; i >= 0; i--) {
566 unsigned int found = geo->output.height * vou_scale_v_den[i] /
569 if (found > img_height_max)
570 /* scales increase */
573 err = abs(found - geo->in_height);
574 if (err < best_err) {
583 geo->in_height = best;
584 geo->scale_idx_v = idx;
588 * Find output geometry, that we can produce, using VOU scaling, closest to
589 * the requested rectangle
591 static void vou_adjust_output(struct sh_vou_geometry *geo, v4l2_std_id std)
593 unsigned int best_err = UINT_MAX, best = geo->in_width,
594 width_max, height_max, img_height_max;
595 int i, idx_h = 0, idx_v = 0;
597 if (std & V4L2_STD_525_60) {
599 height_max = 262 * 2;
600 img_height_max = 480;
603 height_max = 312 * 2;
604 img_height_max = 576;
607 /* Select scales to come as close as possible to the output image */
608 for (i = 0; i < ARRAY_SIZE(vou_scale_h_num); i++) {
610 unsigned int found = geo->in_width * vou_scale_h_num[i] /
613 if (found > VOU_MAX_IMAGE_WIDTH)
614 /* scales increase */
617 err = abs(found - geo->output.width);
618 if (err < best_err) {
627 geo->output.width = best;
628 geo->scale_idx_h = idx_h;
629 if (geo->output.left + best > width_max)
630 geo->output.left = width_max - best;
632 pr_debug("%s(): W %u * %u/%u = %u\n", __func__, geo->in_width,
633 vou_scale_h_num[idx_h], vou_scale_h_den[idx_h], best);
637 /* This loop can be replaced with one division */
638 for (i = 0; i < ARRAY_SIZE(vou_scale_v_num); i++) {
640 unsigned int found = geo->in_height * vou_scale_v_num[i] /
643 if (found > img_height_max)
644 /* scales increase */
647 err = abs(found - geo->output.height);
648 if (err < best_err) {
657 geo->output.height = best;
658 geo->scale_idx_v = idx_v;
659 if (geo->output.top + best > height_max)
660 geo->output.top = height_max - best;
662 pr_debug("%s(): H %u * %u/%u = %u\n", __func__, geo->in_height,
663 vou_scale_v_num[idx_v], vou_scale_v_den[idx_v], best);
666 static int sh_vou_try_fmt_vid_out(struct file *file, void *priv,
667 struct v4l2_format *fmt)
669 struct sh_vou_device *vou_dev = video_drvdata(file);
670 struct v4l2_pix_format *pix = &fmt->fmt.pix;
671 unsigned int img_height_max;
674 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
676 pix->field = V4L2_FIELD_INTERLACED;
677 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
678 pix->ycbcr_enc = pix->quantization = 0;
680 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
681 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
684 if (pix_idx == ARRAY_SIZE(vou_fmt))
687 if (vou_dev->std & V4L2_STD_525_60)
688 img_height_max = 480;
690 img_height_max = 576;
692 v4l_bound_align_image(&pix->width,
693 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 2,
695 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
696 pix->bytesperline = pix->width * vou_fmt[pix_idx].bpl;
697 pix->sizeimage = pix->height * ((pix->width * vou_fmt[pix_idx].bpp) >> 3);
702 static int sh_vou_set_fmt_vid_out(struct sh_vou_device *vou_dev,
703 struct v4l2_pix_format *pix)
705 unsigned int img_height_max;
706 struct sh_vou_geometry geo;
707 struct v4l2_subdev_format format = {
708 .which = V4L2_SUBDEV_FORMAT_ACTIVE,
709 /* Revisit: is this the correct code? */
710 .format.code = MEDIA_BUS_FMT_YUYV8_2X8,
711 .format.field = V4L2_FIELD_INTERLACED,
712 .format.colorspace = V4L2_COLORSPACE_SMPTE170M,
714 struct v4l2_mbus_framefmt *mbfmt = &format.format;
718 if (vb2_is_busy(&vou_dev->queue))
721 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
722 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
725 geo.in_width = pix->width;
726 geo.in_height = pix->height;
727 geo.output = vou_dev->rect;
729 vou_adjust_output(&geo, vou_dev->std);
731 mbfmt->width = geo.output.width;
732 mbfmt->height = geo.output.height;
733 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, pad,
734 set_fmt, NULL, &format);
735 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
739 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
740 geo.output.width, geo.output.height, mbfmt->width, mbfmt->height);
742 if (vou_dev->std & V4L2_STD_525_60)
743 img_height_max = 480;
745 img_height_max = 576;
748 if ((unsigned)mbfmt->width > VOU_MAX_IMAGE_WIDTH ||
749 (unsigned)mbfmt->height > img_height_max ||
750 mbfmt->code != MEDIA_BUS_FMT_YUYV8_2X8)
753 if (mbfmt->width != geo.output.width ||
754 mbfmt->height != geo.output.height) {
755 geo.output.width = mbfmt->width;
756 geo.output.height = mbfmt->height;
758 vou_adjust_input(&geo, vou_dev->std);
761 /* We tried to preserve output rectangle, but it could have changed */
762 vou_dev->rect = geo.output;
763 pix->width = geo.in_width;
764 pix->height = geo.in_height;
766 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u\n", __func__,
767 pix->width, pix->height);
769 vou_dev->pix_idx = pix_idx;
773 sh_vou_configure_geometry(vou_dev, pix_idx,
774 geo.scale_idx_h, geo.scale_idx_v);
779 static int sh_vou_s_fmt_vid_out(struct file *file, void *priv,
780 struct v4l2_format *fmt)
782 struct sh_vou_device *vou_dev = video_drvdata(file);
783 int ret = sh_vou_try_fmt_vid_out(file, priv, fmt);
787 return sh_vou_set_fmt_vid_out(vou_dev, &fmt->fmt.pix);
790 static int sh_vou_enum_output(struct file *file, void *fh,
791 struct v4l2_output *a)
793 struct sh_vou_device *vou_dev = video_drvdata(file);
797 strlcpy(a->name, "Video Out", sizeof(a->name));
798 a->type = V4L2_OUTPUT_TYPE_ANALOG;
799 a->std = vou_dev->vdev.tvnorms;
803 static int sh_vou_g_output(struct file *file, void *fh, unsigned int *i)
809 static int sh_vou_s_output(struct file *file, void *fh, unsigned int i)
811 return i ? -EINVAL : 0;
814 static u32 sh_vou_ntsc_mode(enum sh_vou_bus_fmt bus_fmt)
818 pr_warning("%s(): Invalid bus-format code %d, using default 8-bit\n",
820 case SH_VOU_BUS_8BIT:
822 case SH_VOU_BUS_16BIT:
824 case SH_VOU_BUS_BT656:
829 static int sh_vou_s_std(struct file *file, void *priv, v4l2_std_id std_id)
831 struct sh_vou_device *vou_dev = video_drvdata(file);
834 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): 0x%llx\n", __func__, std_id);
836 if (std_id == vou_dev->std)
839 if (vb2_is_busy(&vou_dev->queue))
842 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
843 s_std_output, std_id);
844 /* Shall we continue, if the subdev doesn't support .s_std_output()? */
845 if (ret < 0 && ret != -ENOIOCTLCMD)
848 vou_dev->rect.top = vou_dev->rect.left = 0;
849 vou_dev->rect.width = VOU_MAX_IMAGE_WIDTH;
850 if (std_id & V4L2_STD_525_60) {
851 sh_vou_reg_ab_set(vou_dev, VOUCR,
852 sh_vou_ntsc_mode(vou_dev->pdata->bus_fmt) << 29, 7 << 29);
853 vou_dev->rect.height = 480;
855 sh_vou_reg_ab_set(vou_dev, VOUCR, 5 << 29, 7 << 29);
856 vou_dev->rect.height = 576;
859 vou_dev->pix.width = vou_dev->rect.width;
860 vou_dev->pix.height = vou_dev->rect.height;
861 vou_dev->pix.bytesperline =
862 vou_dev->pix.width * vou_fmt[vou_dev->pix_idx].bpl;
863 vou_dev->pix.sizeimage = vou_dev->pix.height *
864 ((vou_dev->pix.width * vou_fmt[vou_dev->pix_idx].bpp) >> 3);
865 vou_dev->std = std_id;
866 sh_vou_set_fmt_vid_out(vou_dev, &vou_dev->pix);
871 static int sh_vou_g_std(struct file *file, void *priv, v4l2_std_id *std)
873 struct sh_vou_device *vou_dev = video_drvdata(file);
875 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
882 static int sh_vou_log_status(struct file *file, void *priv)
884 struct sh_vou_device *vou_dev = video_drvdata(file);
886 pr_info("VOUER: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUER));
887 pr_info("VOUCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUCR));
888 pr_info("VOUSTR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSTR));
889 pr_info("VOUVCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUVCR));
890 pr_info("VOUISR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUISR));
891 pr_info("VOUBCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUBCR));
892 pr_info("VOUDPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDPR));
893 pr_info("VOUDSR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDSR));
894 pr_info("VOUVPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUVPR));
895 pr_info("VOUIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUIR));
896 pr_info("VOUSRR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSRR));
897 pr_info("VOUMSR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUMSR));
898 pr_info("VOUHIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUHIR));
899 pr_info("VOUDFR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDFR));
900 pr_info("VOUAD1R: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAD1R));
901 pr_info("VOUAD2R: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAD2R));
902 pr_info("VOUAIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAIR));
903 pr_info("VOUSWR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSWR));
904 pr_info("VOURCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOURCR));
905 pr_info("VOURPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOURPR));
909 static int sh_vou_g_selection(struct file *file, void *fh,
910 struct v4l2_selection *sel)
912 struct sh_vou_device *vou_dev = video_drvdata(file);
914 if (sel->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
916 switch (sel->target) {
917 case V4L2_SEL_TGT_COMPOSE:
918 sel->r = vou_dev->rect;
920 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
921 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
924 sel->r.width = VOU_MAX_IMAGE_WIDTH;
925 if (vou_dev->std & V4L2_STD_525_60)
936 /* Assume a dull encoder, do all the work ourselves. */
937 static int sh_vou_s_selection(struct file *file, void *fh,
938 struct v4l2_selection *sel)
940 struct v4l2_rect *rect = &sel->r;
941 struct sh_vou_device *vou_dev = video_drvdata(file);
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_subdev_format format = {
946 .which = V4L2_SUBDEV_FORMAT_ACTIVE,
947 /* Revisit: is this the correct code? */
948 .format.code = MEDIA_BUS_FMT_YUYV8_2X8,
949 .format.field = V4L2_FIELD_INTERLACED,
950 .format.colorspace = V4L2_COLORSPACE_SMPTE170M,
952 unsigned int img_height_max;
955 if (sel->type != V4L2_BUF_TYPE_VIDEO_OUTPUT ||
956 sel->target != V4L2_SEL_TGT_COMPOSE)
959 if (vb2_is_busy(&vou_dev->queue))
962 if (vou_dev->std & V4L2_STD_525_60)
963 img_height_max = 480;
965 img_height_max = 576;
967 v4l_bound_align_image(&rect->width,
968 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 1,
970 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
972 if (rect->width + rect->left > VOU_MAX_IMAGE_WIDTH)
973 rect->left = VOU_MAX_IMAGE_WIDTH - rect->width;
975 if (rect->height + rect->top > img_height_max)
976 rect->top = img_height_max - rect->height;
979 geo.in_width = pix->width;
980 geo.in_height = pix->height;
982 /* Configure the encoder one-to-one, position at 0, ignore errors */
983 sd_crop.c.width = geo.output.width;
984 sd_crop.c.height = geo.output.height;
986 * We first issue a S_CROP, so that the subsequent S_FMT delivers the
987 * final encoder configuration.
989 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
991 format.format.width = geo.output.width;
992 format.format.height = geo.output.height;
993 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, pad,
994 set_fmt, NULL, &format);
995 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
1000 if ((unsigned)format.format.width > VOU_MAX_IMAGE_WIDTH ||
1001 (unsigned)format.format.height > img_height_max ||
1002 format.format.code != MEDIA_BUS_FMT_YUYV8_2X8)
1005 geo.output.width = format.format.width;
1006 geo.output.height = format.format.height;
1009 * No down-scaling. According to the API, current call has precedence:
1010 * http://v4l2spec.bytesex.org/spec/x1904.htm#AEN1954 paragraph two.
1012 vou_adjust_input(&geo, vou_dev->std);
1014 /* We tried to preserve output rectangle, but it could have changed */
1015 vou_dev->rect = geo.output;
1016 pix->width = geo.in_width;
1017 pix->height = geo.in_height;
1019 sh_vou_configure_geometry(vou_dev, vou_dev->pix_idx,
1020 geo.scale_idx_h, geo.scale_idx_v);
1025 static irqreturn_t sh_vou_isr(int irq, void *dev_id)
1027 struct sh_vou_device *vou_dev = dev_id;
1028 static unsigned long j;
1029 struct sh_vou_buffer *vb;
1031 u32 irq_status = sh_vou_reg_a_read(vou_dev, VOUIR), masked;
1032 u32 vou_status = sh_vou_reg_a_read(vou_dev, VOUSTR);
1034 if (!(irq_status & 0x300)) {
1035 if (printk_timed_ratelimit(&j, 500))
1036 dev_warn(vou_dev->v4l2_dev.dev, "IRQ status 0x%x!\n",
1041 spin_lock(&vou_dev->lock);
1042 if (!vou_dev->active || list_empty(&vou_dev->buf_list)) {
1043 if (printk_timed_ratelimit(&j, 500))
1044 dev_warn(vou_dev->v4l2_dev.dev,
1045 "IRQ without active buffer: %x!\n", irq_status);
1046 /* Just ack: buf_release will disable further interrupts */
1047 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x300);
1048 spin_unlock(&vou_dev->lock);
1052 masked = ~(0x300 & irq_status) & irq_status & 0x30304;
1053 dev_dbg(vou_dev->v4l2_dev.dev,
1054 "IRQ status 0x%x -> 0x%x, VOU status 0x%x, cnt %d\n",
1055 irq_status, masked, vou_status, cnt);
1058 /* side = vou_status & 0x10000; */
1060 /* Clear only set interrupts */
1061 sh_vou_reg_a_write(vou_dev, VOUIR, masked);
1063 vb = vou_dev->active;
1064 if (list_is_singular(&vb->list)) {
1065 /* Keep cycling while no next buffer is available */
1066 sh_vou_schedule_next(vou_dev, &vb->vb);
1067 spin_unlock(&vou_dev->lock);
1071 list_del(&vb->list);
1073 vb->vb.vb2_buf.timestamp = ktime_get_ns();
1074 vb->vb.sequence = vou_dev->sequence++;
1075 vb->vb.field = V4L2_FIELD_INTERLACED;
1076 vb2_buffer_done(&vb->vb.vb2_buf, VB2_BUF_STATE_DONE);
1078 vou_dev->active = list_entry(vou_dev->buf_list.next,
1079 struct sh_vou_buffer, list);
1081 if (list_is_singular(&vou_dev->buf_list)) {
1082 /* Keep cycling while no next buffer is available */
1083 sh_vou_schedule_next(vou_dev, &vou_dev->active->vb);
1085 struct sh_vou_buffer *new = list_entry(vou_dev->active->list.next,
1086 struct sh_vou_buffer, list);
1087 sh_vou_schedule_next(vou_dev, &new->vb);
1090 spin_unlock(&vou_dev->lock);
1095 static int sh_vou_hw_init(struct sh_vou_device *vou_dev)
1097 struct sh_vou_pdata *pdata = vou_dev->pdata;
1098 u32 voucr = sh_vou_ntsc_mode(pdata->bus_fmt) << 29;
1101 /* Disable all IRQs */
1102 sh_vou_reg_a_write(vou_dev, VOUIR, 0);
1104 /* Reset VOU interfaces - registers unaffected */
1105 sh_vou_reg_a_write(vou_dev, VOUSRR, 0x101);
1106 while (--i && (sh_vou_reg_a_read(vou_dev, VOUSRR) & 0x101))
1112 dev_dbg(vou_dev->v4l2_dev.dev, "Reset took %dus\n", 100 - i);
1114 if (pdata->flags & SH_VOU_PCLK_FALLING)
1116 if (pdata->flags & SH_VOU_HSYNC_LOW)
1118 if (pdata->flags & SH_VOU_VSYNC_LOW)
1120 sh_vou_reg_ab_set(vou_dev, VOUCR, voucr, 0xfc000000);
1122 /* Manual register side switching at first */
1123 sh_vou_reg_a_write(vou_dev, VOURCR, 4);
1124 /* Default - fixed HSYNC length, can be made configurable is required */
1125 sh_vou_reg_ab_write(vou_dev, VOUMSR, 0x800000);
1127 sh_vou_set_fmt_vid_out(vou_dev, &vou_dev->pix);
1132 /* File operations */
1133 static int sh_vou_open(struct file *file)
1135 struct sh_vou_device *vou_dev = video_drvdata(file);
1138 if (mutex_lock_interruptible(&vou_dev->fop_lock))
1139 return -ERESTARTSYS;
1141 err = v4l2_fh_open(file);
1144 if (v4l2_fh_is_singular_file(file) &&
1145 vou_dev->status == SH_VOU_INITIALISING) {
1147 pm_runtime_get_sync(vou_dev->v4l2_dev.dev);
1148 err = sh_vou_hw_init(vou_dev);
1150 pm_runtime_put(vou_dev->v4l2_dev.dev);
1151 v4l2_fh_release(file);
1153 vou_dev->status = SH_VOU_IDLE;
1157 mutex_unlock(&vou_dev->fop_lock);
1161 static int sh_vou_release(struct file *file)
1163 struct sh_vou_device *vou_dev = video_drvdata(file);
1166 mutex_lock(&vou_dev->fop_lock);
1167 is_last = v4l2_fh_is_singular_file(file);
1168 _vb2_fop_release(file, NULL);
1171 vou_dev->status = SH_VOU_INITIALISING;
1172 sh_vou_reg_a_set(vou_dev, VOUER, 0, 0x101);
1173 pm_runtime_put(vou_dev->v4l2_dev.dev);
1175 mutex_unlock(&vou_dev->fop_lock);
1179 /* sh_vou display ioctl operations */
1180 static const struct v4l2_ioctl_ops sh_vou_ioctl_ops = {
1181 .vidioc_querycap = sh_vou_querycap,
1182 .vidioc_enum_fmt_vid_out = sh_vou_enum_fmt_vid_out,
1183 .vidioc_g_fmt_vid_out = sh_vou_g_fmt_vid_out,
1184 .vidioc_s_fmt_vid_out = sh_vou_s_fmt_vid_out,
1185 .vidioc_try_fmt_vid_out = sh_vou_try_fmt_vid_out,
1186 .vidioc_reqbufs = vb2_ioctl_reqbufs,
1187 .vidioc_create_bufs = vb2_ioctl_create_bufs,
1188 .vidioc_querybuf = vb2_ioctl_querybuf,
1189 .vidioc_qbuf = vb2_ioctl_qbuf,
1190 .vidioc_dqbuf = vb2_ioctl_dqbuf,
1191 .vidioc_prepare_buf = vb2_ioctl_prepare_buf,
1192 .vidioc_streamon = vb2_ioctl_streamon,
1193 .vidioc_streamoff = vb2_ioctl_streamoff,
1194 .vidioc_expbuf = vb2_ioctl_expbuf,
1195 .vidioc_g_output = sh_vou_g_output,
1196 .vidioc_s_output = sh_vou_s_output,
1197 .vidioc_enum_output = sh_vou_enum_output,
1198 .vidioc_s_std = sh_vou_s_std,
1199 .vidioc_g_std = sh_vou_g_std,
1200 .vidioc_g_selection = sh_vou_g_selection,
1201 .vidioc_s_selection = sh_vou_s_selection,
1202 .vidioc_log_status = sh_vou_log_status,
1205 static const struct v4l2_file_operations sh_vou_fops = {
1206 .owner = THIS_MODULE,
1207 .open = sh_vou_open,
1208 .release = sh_vou_release,
1209 .unlocked_ioctl = video_ioctl2,
1210 .mmap = vb2_fop_mmap,
1211 .poll = vb2_fop_poll,
1212 .write = vb2_fop_write,
1215 static const struct video_device sh_vou_video_template = {
1217 .fops = &sh_vou_fops,
1218 .ioctl_ops = &sh_vou_ioctl_ops,
1219 .tvnorms = V4L2_STD_525_60, /* PAL only supported in 8-bit non-bt656 mode */
1220 .vfl_dir = VFL_DIR_TX,
1223 static int sh_vou_probe(struct platform_device *pdev)
1225 struct sh_vou_pdata *vou_pdata = pdev->dev.platform_data;
1226 struct v4l2_rect *rect;
1227 struct v4l2_pix_format *pix;
1228 struct i2c_adapter *i2c_adap;
1229 struct video_device *vdev;
1230 struct sh_vou_device *vou_dev;
1231 struct resource *reg_res;
1232 struct v4l2_subdev *subdev;
1233 struct vb2_queue *q;
1236 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1237 irq = platform_get_irq(pdev, 0);
1239 if (!vou_pdata || !reg_res || irq <= 0) {
1240 dev_err(&pdev->dev, "Insufficient VOU platform information.\n");
1244 vou_dev = devm_kzalloc(&pdev->dev, sizeof(*vou_dev), GFP_KERNEL);
1248 INIT_LIST_HEAD(&vou_dev->buf_list);
1249 spin_lock_init(&vou_dev->lock);
1250 mutex_init(&vou_dev->fop_lock);
1251 vou_dev->pdata = vou_pdata;
1252 vou_dev->status = SH_VOU_INITIALISING;
1253 vou_dev->pix_idx = 1;
1255 rect = &vou_dev->rect;
1256 pix = &vou_dev->pix;
1258 /* Fill in defaults */
1259 vou_dev->std = V4L2_STD_NTSC_M;
1262 rect->width = VOU_MAX_IMAGE_WIDTH;
1264 pix->width = VOU_MAX_IMAGE_WIDTH;
1266 pix->pixelformat = V4L2_PIX_FMT_NV16;
1267 pix->field = V4L2_FIELD_INTERLACED;
1268 pix->bytesperline = VOU_MAX_IMAGE_WIDTH;
1269 pix->sizeimage = VOU_MAX_IMAGE_WIDTH * 2 * 480;
1270 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
1272 vou_dev->base = devm_ioremap_resource(&pdev->dev, reg_res);
1273 if (IS_ERR(vou_dev->base))
1274 return PTR_ERR(vou_dev->base);
1276 ret = devm_request_irq(&pdev->dev, irq, sh_vou_isr, 0, "vou", vou_dev);
1280 ret = v4l2_device_register(&pdev->dev, &vou_dev->v4l2_dev);
1282 dev_err(&pdev->dev, "Error registering v4l2 device\n");
1286 vdev = &vou_dev->vdev;
1287 *vdev = sh_vou_video_template;
1288 if (vou_pdata->bus_fmt == SH_VOU_BUS_8BIT)
1289 vdev->tvnorms |= V4L2_STD_PAL;
1290 vdev->v4l2_dev = &vou_dev->v4l2_dev;
1291 vdev->release = video_device_release_empty;
1292 vdev->lock = &vou_dev->fop_lock;
1294 video_set_drvdata(vdev, vou_dev);
1296 /* Initialize the vb2 queue */
1297 q = &vou_dev->queue;
1298 q->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
1299 q->io_modes = VB2_MMAP | VB2_DMABUF | VB2_WRITE;
1300 q->drv_priv = vou_dev;
1301 q->buf_struct_size = sizeof(struct sh_vou_buffer);
1302 q->ops = &sh_vou_qops;
1303 q->mem_ops = &vb2_dma_contig_memops;
1304 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
1305 q->min_buffers_needed = 2;
1306 q->lock = &vou_dev->fop_lock;
1307 ret = vb2_queue_init(q);
1311 vou_dev->alloc_ctx = vb2_dma_contig_init_ctx(&pdev->dev);
1312 if (IS_ERR(vou_dev->alloc_ctx)) {
1313 dev_err(&pdev->dev, "Can't allocate buffer context");
1314 ret = PTR_ERR(vou_dev->alloc_ctx);
1318 INIT_LIST_HEAD(&vou_dev->buf_list);
1320 pm_runtime_enable(&pdev->dev);
1321 pm_runtime_resume(&pdev->dev);
1323 i2c_adap = i2c_get_adapter(vou_pdata->i2c_adap);
1329 ret = sh_vou_hw_init(vou_dev);
1333 subdev = v4l2_i2c_new_subdev_board(&vou_dev->v4l2_dev, i2c_adap,
1334 vou_pdata->board_info, NULL);
1340 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1349 i2c_put_adapter(i2c_adap);
1351 vb2_dma_contig_cleanup_ctx(vou_dev->alloc_ctx);
1353 pm_runtime_disable(&pdev->dev);
1354 v4l2_device_unregister(&vou_dev->v4l2_dev);
1358 static int sh_vou_remove(struct platform_device *pdev)
1360 struct v4l2_device *v4l2_dev = platform_get_drvdata(pdev);
1361 struct sh_vou_device *vou_dev = container_of(v4l2_dev,
1362 struct sh_vou_device, v4l2_dev);
1363 struct v4l2_subdev *sd = list_entry(v4l2_dev->subdevs.next,
1364 struct v4l2_subdev, list);
1365 struct i2c_client *client = v4l2_get_subdevdata(sd);
1367 pm_runtime_disable(&pdev->dev);
1368 video_unregister_device(&vou_dev->vdev);
1369 i2c_put_adapter(client->adapter);
1370 vb2_dma_contig_cleanup_ctx(vou_dev->alloc_ctx);
1371 v4l2_device_unregister(&vou_dev->v4l2_dev);
1375 static struct platform_driver __refdata sh_vou = {
1376 .remove = sh_vou_remove,
1382 module_platform_driver_probe(sh_vou, sh_vou_probe);
1384 MODULE_DESCRIPTION("SuperH VOU driver");
1385 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
1386 MODULE_LICENSE("GPL v2");
1387 MODULE_VERSION("0.1.0");
1388 MODULE_ALIAS("platform:sh-vou");