1 // SPDX-License-Identifier: GPL-2.0
3 * SuperH Video Output Unit (VOU) driver
8 #include <linux/dma-mapping.h>
9 #include <linux/delay.h>
10 #include <linux/errno.h>
12 #include <linux/i2c.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
15 #include <linux/kernel.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/slab.h>
19 #include <linux/videodev2.h>
20 #include <linux/module.h>
22 #include <media/drv-intf/sh_vou.h>
23 #include <media/v4l2-common.h>
24 #include <media/v4l2-device.h>
25 #include <media/v4l2-ioctl.h>
26 #include <media/v4l2-mediabus.h>
27 #include <media/videobuf2-v4l2.h>
28 #include <media/videobuf2-dma-contig.h>
30 /* Mirror addresses are not available for all registers */
58 #define VOU_MIN_IMAGE_WIDTH 16
59 #define VOU_MAX_IMAGE_WIDTH 720
60 #define VOU_MIN_IMAGE_HEIGHT 16
62 struct sh_vou_buffer {
63 struct vb2_v4l2_buffer vb;
64 struct list_head list;
68 sh_vou_buffer *to_sh_vou_buffer(struct vb2_v4l2_buffer *vb2)
70 return container_of(vb2, struct sh_vou_buffer, vb);
73 struct sh_vou_device {
74 struct v4l2_device v4l2_dev;
75 struct video_device vdev;
76 struct sh_vou_pdata *pdata;
79 /* State information */
80 struct v4l2_pix_format pix;
81 struct v4l2_rect rect;
82 struct list_head buf_list;
85 struct vb2_queue queue;
86 struct sh_vou_buffer *active;
87 enum sh_vou_status status;
89 struct mutex fop_lock;
92 /* Register access routines for sides A, B and mirror addresses */
93 static void sh_vou_reg_a_write(struct sh_vou_device *vou_dev, unsigned int reg,
96 __raw_writel(value, vou_dev->base + reg);
99 static void sh_vou_reg_ab_write(struct sh_vou_device *vou_dev, unsigned int reg,
102 __raw_writel(value, vou_dev->base + reg);
103 __raw_writel(value, vou_dev->base + reg + 0x1000);
106 static void sh_vou_reg_m_write(struct sh_vou_device *vou_dev, unsigned int reg,
109 __raw_writel(value, vou_dev->base + reg + 0x2000);
112 static u32 sh_vou_reg_a_read(struct sh_vou_device *vou_dev, unsigned int reg)
114 return __raw_readl(vou_dev->base + reg);
117 static void sh_vou_reg_a_set(struct sh_vou_device *vou_dev, unsigned int reg,
120 u32 old = __raw_readl(vou_dev->base + reg);
122 value = (value & mask) | (old & ~mask);
123 __raw_writel(value, vou_dev->base + reg);
126 static void sh_vou_reg_b_set(struct sh_vou_device *vou_dev, unsigned int reg,
129 sh_vou_reg_a_set(vou_dev, reg + 0x1000, value, mask);
132 static void sh_vou_reg_ab_set(struct sh_vou_device *vou_dev, unsigned int reg,
135 sh_vou_reg_a_set(vou_dev, reg, value, mask);
136 sh_vou_reg_b_set(vou_dev, reg, value, mask);
148 /* Further pixel formats can be added */
149 static struct sh_vou_fmt vou_fmt[] = {
151 .pfmt = V4L2_PIX_FMT_NV12,
158 .pfmt = V4L2_PIX_FMT_NV16,
165 .pfmt = V4L2_PIX_FMT_RGB24,
172 .pfmt = V4L2_PIX_FMT_RGB565,
179 .pfmt = V4L2_PIX_FMT_RGB565X,
187 static void sh_vou_schedule_next(struct sh_vou_device *vou_dev,
188 struct vb2_v4l2_buffer *vbuf)
190 dma_addr_t addr1, addr2;
192 addr1 = vb2_dma_contig_plane_dma_addr(&vbuf->vb2_buf, 0);
193 switch (vou_dev->pix.pixelformat) {
194 case V4L2_PIX_FMT_NV12:
195 case V4L2_PIX_FMT_NV16:
196 addr2 = addr1 + vou_dev->pix.width * vou_dev->pix.height;
202 sh_vou_reg_m_write(vou_dev, VOUAD1R, addr1);
203 sh_vou_reg_m_write(vou_dev, VOUAD2R, addr2);
206 static void sh_vou_stream_config(struct sh_vou_device *vou_dev)
208 unsigned int row_coeff;
209 #ifdef __LITTLE_ENDIAN
215 switch (vou_dev->pix.pixelformat) {
217 case V4L2_PIX_FMT_NV12:
218 case V4L2_PIX_FMT_NV16:
221 case V4L2_PIX_FMT_RGB565:
224 case V4L2_PIX_FMT_RGB565X:
227 case V4L2_PIX_FMT_RGB24:
232 sh_vou_reg_a_write(vou_dev, VOUSWR, dataswap);
233 sh_vou_reg_ab_write(vou_dev, VOUAIR, vou_dev->pix.width * row_coeff);
236 /* Locking: caller holds fop_lock mutex */
237 static int sh_vou_queue_setup(struct vb2_queue *vq,
238 unsigned int *nbuffers, unsigned int *nplanes,
239 unsigned int sizes[], struct device *alloc_devs[])
241 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
242 struct v4l2_pix_format *pix = &vou_dev->pix;
243 int bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
245 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
248 return sizes[0] < pix->height * bytes_per_line ? -EINVAL : 0;
250 sizes[0] = pix->height * bytes_per_line;
254 static int sh_vou_buf_prepare(struct vb2_buffer *vb)
256 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vb->vb2_queue);
257 struct v4l2_pix_format *pix = &vou_dev->pix;
258 unsigned bytes_per_line = vou_fmt[vou_dev->pix_idx].bpp * pix->width / 8;
259 unsigned size = pix->height * bytes_per_line;
261 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
263 if (vb2_plane_size(vb, 0) < size) {
264 /* User buffer too small */
265 dev_warn(vou_dev->v4l2_dev.dev, "buffer too small (%lu < %u)\n",
266 vb2_plane_size(vb, 0), size);
270 vb2_set_plane_payload(vb, 0, size);
274 /* Locking: caller holds fop_lock mutex and vq->irqlock spinlock */
275 static void sh_vou_buf_queue(struct vb2_buffer *vb)
277 struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
278 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vb->vb2_queue);
279 struct sh_vou_buffer *shbuf = to_sh_vou_buffer(vbuf);
282 spin_lock_irqsave(&vou_dev->lock, flags);
283 list_add_tail(&shbuf->list, &vou_dev->buf_list);
284 spin_unlock_irqrestore(&vou_dev->lock, flags);
287 static int sh_vou_start_streaming(struct vb2_queue *vq, unsigned int count)
289 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
290 struct sh_vou_buffer *buf, *node;
293 vou_dev->sequence = 0;
294 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
296 if (ret < 0 && ret != -ENOIOCTLCMD) {
297 list_for_each_entry_safe(buf, node, &vou_dev->buf_list, list) {
298 vb2_buffer_done(&buf->vb.vb2_buf,
299 VB2_BUF_STATE_QUEUED);
300 list_del(&buf->list);
302 vou_dev->active = NULL;
306 buf = list_entry(vou_dev->buf_list.next, struct sh_vou_buffer, list);
308 vou_dev->active = buf;
310 /* Start from side A: we use mirror addresses, so, set B */
311 sh_vou_reg_a_write(vou_dev, VOURPR, 1);
312 dev_dbg(vou_dev->v4l2_dev.dev, "%s: first buffer status 0x%x\n",
313 __func__, sh_vou_reg_a_read(vou_dev, VOUSTR));
314 sh_vou_schedule_next(vou_dev, &buf->vb);
316 buf = list_entry(buf->list.next, struct sh_vou_buffer, list);
318 /* Second buffer - initialise register side B */
319 sh_vou_reg_a_write(vou_dev, VOURPR, 0);
320 sh_vou_schedule_next(vou_dev, &buf->vb);
322 /* Register side switching with frame VSYNC */
323 sh_vou_reg_a_write(vou_dev, VOURCR, 5);
325 sh_vou_stream_config(vou_dev);
326 /* Enable End-of-Frame (VSYNC) interrupts */
327 sh_vou_reg_a_write(vou_dev, VOUIR, 0x10004);
329 /* Two buffers on the queue - activate the hardware */
330 vou_dev->status = SH_VOU_RUNNING;
331 sh_vou_reg_a_write(vou_dev, VOUER, 0x107);
335 static void sh_vou_stop_streaming(struct vb2_queue *vq)
337 struct sh_vou_device *vou_dev = vb2_get_drv_priv(vq);
338 struct sh_vou_buffer *buf, *node;
341 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0,
344 sh_vou_reg_a_set(vou_dev, VOUER, 0, 1);
345 /* ...but the current frame will complete */
346 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x30000);
348 spin_lock_irqsave(&vou_dev->lock, flags);
349 list_for_each_entry_safe(buf, node, &vou_dev->buf_list, list) {
350 vb2_buffer_done(&buf->vb.vb2_buf, VB2_BUF_STATE_ERROR);
351 list_del(&buf->list);
353 vou_dev->active = NULL;
354 spin_unlock_irqrestore(&vou_dev->lock, flags);
357 static const struct vb2_ops sh_vou_qops = {
358 .queue_setup = sh_vou_queue_setup,
359 .buf_prepare = sh_vou_buf_prepare,
360 .buf_queue = sh_vou_buf_queue,
361 .start_streaming = sh_vou_start_streaming,
362 .stop_streaming = sh_vou_stop_streaming,
363 .wait_prepare = vb2_ops_wait_prepare,
364 .wait_finish = vb2_ops_wait_finish,
368 static int sh_vou_querycap(struct file *file, void *priv,
369 struct v4l2_capability *cap)
371 struct sh_vou_device *vou_dev = video_drvdata(file);
373 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
375 strscpy(cap->card, "SuperH VOU", sizeof(cap->card));
376 strscpy(cap->driver, "sh-vou", sizeof(cap->driver));
377 strscpy(cap->bus_info, "platform:sh-vou", sizeof(cap->bus_info));
381 /* Enumerate formats, that the device can accept from the user */
382 static int sh_vou_enum_fmt_vid_out(struct file *file, void *priv,
383 struct v4l2_fmtdesc *fmt)
385 struct sh_vou_device *vou_dev = video_drvdata(file);
387 if (fmt->index >= ARRAY_SIZE(vou_fmt))
390 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
392 fmt->pixelformat = vou_fmt[fmt->index].pfmt;
397 static int sh_vou_g_fmt_vid_out(struct file *file, void *priv,
398 struct v4l2_format *fmt)
400 struct sh_vou_device *vou_dev = video_drvdata(file);
402 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
404 fmt->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
405 fmt->fmt.pix = vou_dev->pix;
410 static const unsigned char vou_scale_h_num[] = {1, 9, 2, 9, 4};
411 static const unsigned char vou_scale_h_den[] = {1, 8, 1, 4, 1};
412 static const unsigned char vou_scale_h_fld[] = {0, 2, 1, 3};
413 static const unsigned char vou_scale_v_num[] = {1, 2, 4};
414 static const unsigned char vou_scale_v_den[] = {1, 1, 1};
415 static const unsigned char vou_scale_v_fld[] = {0, 1};
417 static void sh_vou_configure_geometry(struct sh_vou_device *vou_dev,
418 int pix_idx, int w_idx, int h_idx)
420 struct sh_vou_fmt *fmt = vou_fmt + pix_idx;
421 unsigned int black_left, black_top, width_max,
422 frame_in_height, frame_out_height, frame_out_top;
423 struct v4l2_rect *rect = &vou_dev->rect;
424 struct v4l2_pix_format *pix = &vou_dev->pix;
425 u32 vouvcr = 0, dsr_h, dsr_v;
427 if (vou_dev->std & V4L2_STD_525_60) {
429 /* height_max = 262; */
432 /* height_max = 312; */
435 frame_in_height = pix->height / 2;
436 frame_out_height = rect->height / 2;
437 frame_out_top = rect->top / 2;
440 * Cropping scheme: max useful image is 720x480, and the total video
441 * area is 858x525 (NTSC) or 864x625 (PAL). AK8813 / 8814 starts
442 * sampling data beginning with fixed 276th (NTSC) / 288th (PAL) clock,
443 * of which the first 33 / 25 clocks HSYNC must be held active. This
444 * has to be configured in CR[HW]. 1 pixel equals 2 clock periods.
445 * This gives CR[HW] = 16 / 12, VPR[HVP] = 138 / 144, which gives
446 * exactly 858 - 138 = 864 - 144 = 720! We call the out-of-display area,
447 * beyond DSR, specified on the left and top by the VPR register "black
448 * pixels" and out-of-image area (DPR) "background pixels." We fix VPR
449 * at 138 / 144 : 20, because that's the HSYNC timing, that our first
450 * client requires, and that's exactly what leaves us 720 pixels for the
451 * image; we leave VPR[VVP] at default 20 for now, because the client
452 * doesn't seem to have any special requirements for it. Otherwise we
453 * could also set it to max - 240 = 22 / 72. Thus VPR depends only on
454 * the selected standard, and DPR and DSR are selected according to
455 * cropping. Q: how does the client detect the first valid line? Does
456 * HSYNC stay inactive during invalid (black) lines?
458 black_left = width_max - VOU_MAX_IMAGE_WIDTH;
461 dsr_h = rect->width + rect->left;
462 dsr_v = frame_out_height + frame_out_top;
464 dev_dbg(vou_dev->v4l2_dev.dev,
465 "image %ux%u, black %u:%u, offset %u:%u, display %ux%u\n",
466 pix->width, frame_in_height, black_left, black_top,
467 rect->left, frame_out_top, dsr_h, dsr_v);
469 /* VOUISR height - half of a frame height in frame mode */
470 sh_vou_reg_ab_write(vou_dev, VOUISR, (pix->width << 16) | frame_in_height);
471 sh_vou_reg_ab_write(vou_dev, VOUVPR, (black_left << 16) | black_top);
472 sh_vou_reg_ab_write(vou_dev, VOUDPR, (rect->left << 16) | frame_out_top);
473 sh_vou_reg_ab_write(vou_dev, VOUDSR, (dsr_h << 16) | dsr_v);
476 * if necessary, we could set VOUHIR to
477 * max(black_left + dsr_h, width_max) here
481 vouvcr |= (1 << 15) | (vou_scale_h_fld[w_idx - 1] << 4);
483 vouvcr |= (1 << 14) | vou_scale_v_fld[h_idx - 1];
485 dev_dbg(vou_dev->v4l2_dev.dev, "0x%08x: scaling 0x%x\n",
488 /* To produce a colour bar for testing set bit 23 of VOUVCR */
489 sh_vou_reg_ab_write(vou_dev, VOUVCR, vouvcr);
490 sh_vou_reg_ab_write(vou_dev, VOUDFR,
491 fmt->pkf | (fmt->yf << 8) | (fmt->rgb << 16));
494 struct sh_vou_geometry {
495 struct v4l2_rect output;
496 unsigned int in_width;
497 unsigned int in_height;
503 * Find input geometry, that we can use to produce output, closest to the
504 * requested rectangle, using VOU scaling
506 static void vou_adjust_input(struct sh_vou_geometry *geo, v4l2_std_id std)
508 /* The compiler cannot know, that best and idx will indeed be set */
509 unsigned int best_err = UINT_MAX, best = 0, img_height_max;
512 if (std & V4L2_STD_525_60)
513 img_height_max = 480;
515 img_height_max = 576;
517 /* Image width must be a multiple of 4 */
518 v4l_bound_align_image(&geo->in_width,
519 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 2,
521 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
523 /* Select scales to come as close as possible to the output image */
524 for (i = ARRAY_SIZE(vou_scale_h_num) - 1; i >= 0; i--) {
526 unsigned int found = geo->output.width * vou_scale_h_den[i] /
529 if (found > VOU_MAX_IMAGE_WIDTH)
530 /* scales increase */
533 err = abs(found - geo->in_width);
534 if (err < best_err) {
543 geo->in_width = best;
544 geo->scale_idx_h = idx;
548 /* This loop can be replaced with one division */
549 for (i = ARRAY_SIZE(vou_scale_v_num) - 1; i >= 0; i--) {
551 unsigned int found = geo->output.height * vou_scale_v_den[i] /
554 if (found > img_height_max)
555 /* scales increase */
558 err = abs(found - geo->in_height);
559 if (err < best_err) {
568 geo->in_height = best;
569 geo->scale_idx_v = idx;
573 * Find output geometry, that we can produce, using VOU scaling, closest to
574 * the requested rectangle
576 static void vou_adjust_output(struct sh_vou_geometry *geo, v4l2_std_id std)
578 unsigned int best_err = UINT_MAX, best = geo->in_width,
579 width_max, height_max, img_height_max;
580 int i, idx_h = 0, idx_v = 0;
582 if (std & V4L2_STD_525_60) {
584 height_max = 262 * 2;
585 img_height_max = 480;
588 height_max = 312 * 2;
589 img_height_max = 576;
592 /* Select scales to come as close as possible to the output image */
593 for (i = 0; i < ARRAY_SIZE(vou_scale_h_num); i++) {
595 unsigned int found = geo->in_width * vou_scale_h_num[i] /
598 if (found > VOU_MAX_IMAGE_WIDTH)
599 /* scales increase */
602 err = abs(found - geo->output.width);
603 if (err < best_err) {
612 geo->output.width = best;
613 geo->scale_idx_h = idx_h;
614 if (geo->output.left + best > width_max)
615 geo->output.left = width_max - best;
617 pr_debug("%s(): W %u * %u/%u = %u\n", __func__, geo->in_width,
618 vou_scale_h_num[idx_h], vou_scale_h_den[idx_h], best);
622 /* This loop can be replaced with one division */
623 for (i = 0; i < ARRAY_SIZE(vou_scale_v_num); i++) {
625 unsigned int found = geo->in_height * vou_scale_v_num[i] /
628 if (found > img_height_max)
629 /* scales increase */
632 err = abs(found - geo->output.height);
633 if (err < best_err) {
642 geo->output.height = best;
643 geo->scale_idx_v = idx_v;
644 if (geo->output.top + best > height_max)
645 geo->output.top = height_max - best;
647 pr_debug("%s(): H %u * %u/%u = %u\n", __func__, geo->in_height,
648 vou_scale_v_num[idx_v], vou_scale_v_den[idx_v], best);
651 static int sh_vou_try_fmt_vid_out(struct file *file, void *priv,
652 struct v4l2_format *fmt)
654 struct sh_vou_device *vou_dev = video_drvdata(file);
655 struct v4l2_pix_format *pix = &fmt->fmt.pix;
656 unsigned int img_height_max;
659 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
661 pix->field = V4L2_FIELD_INTERLACED;
662 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
663 pix->ycbcr_enc = pix->quantization = 0;
665 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
666 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
669 if (pix_idx == ARRAY_SIZE(vou_fmt))
672 if (vou_dev->std & V4L2_STD_525_60)
673 img_height_max = 480;
675 img_height_max = 576;
677 v4l_bound_align_image(&pix->width,
678 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 2,
680 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
681 pix->bytesperline = pix->width * vou_fmt[pix_idx].bpl;
682 pix->sizeimage = pix->height * ((pix->width * vou_fmt[pix_idx].bpp) >> 3);
687 static int sh_vou_set_fmt_vid_out(struct sh_vou_device *vou_dev,
688 struct v4l2_pix_format *pix)
690 unsigned int img_height_max;
691 struct sh_vou_geometry geo;
692 struct v4l2_subdev_format format = {
693 .which = V4L2_SUBDEV_FORMAT_ACTIVE,
694 /* Revisit: is this the correct code? */
695 .format.code = MEDIA_BUS_FMT_YUYV8_2X8,
696 .format.field = V4L2_FIELD_INTERLACED,
697 .format.colorspace = V4L2_COLORSPACE_SMPTE170M,
699 struct v4l2_mbus_framefmt *mbfmt = &format.format;
703 if (vb2_is_busy(&vou_dev->queue))
706 for (pix_idx = 0; pix_idx < ARRAY_SIZE(vou_fmt); pix_idx++)
707 if (vou_fmt[pix_idx].pfmt == pix->pixelformat)
710 geo.in_width = pix->width;
711 geo.in_height = pix->height;
712 geo.output = vou_dev->rect;
714 vou_adjust_output(&geo, vou_dev->std);
716 mbfmt->width = geo.output.width;
717 mbfmt->height = geo.output.height;
718 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, pad,
719 set_fmt, NULL, &format);
720 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
724 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u -> %ux%u\n", __func__,
725 geo.output.width, geo.output.height, mbfmt->width, mbfmt->height);
727 if (vou_dev->std & V4L2_STD_525_60)
728 img_height_max = 480;
730 img_height_max = 576;
733 if ((unsigned)mbfmt->width > VOU_MAX_IMAGE_WIDTH ||
734 (unsigned)mbfmt->height > img_height_max ||
735 mbfmt->code != MEDIA_BUS_FMT_YUYV8_2X8)
738 if (mbfmt->width != geo.output.width ||
739 mbfmt->height != geo.output.height) {
740 geo.output.width = mbfmt->width;
741 geo.output.height = mbfmt->height;
743 vou_adjust_input(&geo, vou_dev->std);
746 /* We tried to preserve output rectangle, but it could have changed */
747 vou_dev->rect = geo.output;
748 pix->width = geo.in_width;
749 pix->height = geo.in_height;
751 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): %ux%u\n", __func__,
752 pix->width, pix->height);
754 vou_dev->pix_idx = pix_idx;
758 sh_vou_configure_geometry(vou_dev, pix_idx,
759 geo.scale_idx_h, geo.scale_idx_v);
764 static int sh_vou_s_fmt_vid_out(struct file *file, void *priv,
765 struct v4l2_format *fmt)
767 struct sh_vou_device *vou_dev = video_drvdata(file);
768 int ret = sh_vou_try_fmt_vid_out(file, priv, fmt);
772 return sh_vou_set_fmt_vid_out(vou_dev, &fmt->fmt.pix);
775 static int sh_vou_enum_output(struct file *file, void *fh,
776 struct v4l2_output *a)
778 struct sh_vou_device *vou_dev = video_drvdata(file);
782 strscpy(a->name, "Video Out", sizeof(a->name));
783 a->type = V4L2_OUTPUT_TYPE_ANALOG;
784 a->std = vou_dev->vdev.tvnorms;
788 static int sh_vou_g_output(struct file *file, void *fh, unsigned int *i)
794 static int sh_vou_s_output(struct file *file, void *fh, unsigned int i)
796 return i ? -EINVAL : 0;
799 static u32 sh_vou_ntsc_mode(enum sh_vou_bus_fmt bus_fmt)
803 pr_warn("%s(): Invalid bus-format code %d, using default 8-bit\n",
806 case SH_VOU_BUS_8BIT:
808 case SH_VOU_BUS_16BIT:
810 case SH_VOU_BUS_BT656:
815 static int sh_vou_s_std(struct file *file, void *priv, v4l2_std_id std_id)
817 struct sh_vou_device *vou_dev = video_drvdata(file);
820 dev_dbg(vou_dev->v4l2_dev.dev, "%s(): 0x%llx\n", __func__, std_id);
822 if (std_id == vou_dev->std)
825 if (vb2_is_busy(&vou_dev->queue))
828 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, video,
829 s_std_output, std_id);
830 /* Shall we continue, if the subdev doesn't support .s_std_output()? */
831 if (ret < 0 && ret != -ENOIOCTLCMD)
834 vou_dev->rect.top = vou_dev->rect.left = 0;
835 vou_dev->rect.width = VOU_MAX_IMAGE_WIDTH;
836 if (std_id & V4L2_STD_525_60) {
837 sh_vou_reg_ab_set(vou_dev, VOUCR,
838 sh_vou_ntsc_mode(vou_dev->pdata->bus_fmt) << 29, 7 << 29);
839 vou_dev->rect.height = 480;
841 sh_vou_reg_ab_set(vou_dev, VOUCR, 5 << 29, 7 << 29);
842 vou_dev->rect.height = 576;
845 vou_dev->pix.width = vou_dev->rect.width;
846 vou_dev->pix.height = vou_dev->rect.height;
847 vou_dev->pix.bytesperline =
848 vou_dev->pix.width * vou_fmt[vou_dev->pix_idx].bpl;
849 vou_dev->pix.sizeimage = vou_dev->pix.height *
850 ((vou_dev->pix.width * vou_fmt[vou_dev->pix_idx].bpp) >> 3);
851 vou_dev->std = std_id;
852 sh_vou_set_fmt_vid_out(vou_dev, &vou_dev->pix);
857 static int sh_vou_g_std(struct file *file, void *priv, v4l2_std_id *std)
859 struct sh_vou_device *vou_dev = video_drvdata(file);
861 dev_dbg(vou_dev->v4l2_dev.dev, "%s()\n", __func__);
868 static int sh_vou_log_status(struct file *file, void *priv)
870 struct sh_vou_device *vou_dev = video_drvdata(file);
872 pr_info("VOUER: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUER));
873 pr_info("VOUCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUCR));
874 pr_info("VOUSTR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSTR));
875 pr_info("VOUVCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUVCR));
876 pr_info("VOUISR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUISR));
877 pr_info("VOUBCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUBCR));
878 pr_info("VOUDPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDPR));
879 pr_info("VOUDSR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDSR));
880 pr_info("VOUVPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUVPR));
881 pr_info("VOUIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUIR));
882 pr_info("VOUSRR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSRR));
883 pr_info("VOUMSR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUMSR));
884 pr_info("VOUHIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUHIR));
885 pr_info("VOUDFR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUDFR));
886 pr_info("VOUAD1R: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAD1R));
887 pr_info("VOUAD2R: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAD2R));
888 pr_info("VOUAIR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUAIR));
889 pr_info("VOUSWR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOUSWR));
890 pr_info("VOURCR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOURCR));
891 pr_info("VOURPR: 0x%08x\n", sh_vou_reg_a_read(vou_dev, VOURPR));
895 static int sh_vou_g_selection(struct file *file, void *fh,
896 struct v4l2_selection *sel)
898 struct sh_vou_device *vou_dev = video_drvdata(file);
900 if (sel->type != V4L2_BUF_TYPE_VIDEO_OUTPUT)
902 switch (sel->target) {
903 case V4L2_SEL_TGT_COMPOSE:
904 sel->r = vou_dev->rect;
906 case V4L2_SEL_TGT_COMPOSE_DEFAULT:
907 case V4L2_SEL_TGT_COMPOSE_BOUNDS:
910 sel->r.width = VOU_MAX_IMAGE_WIDTH;
911 if (vou_dev->std & V4L2_STD_525_60)
922 /* Assume a dull encoder, do all the work ourselves. */
923 static int sh_vou_s_selection(struct file *file, void *fh,
924 struct v4l2_selection *sel)
926 struct v4l2_rect *rect = &sel->r;
927 struct sh_vou_device *vou_dev = video_drvdata(file);
928 struct v4l2_subdev_selection sd_sel = {
929 .which = V4L2_SUBDEV_FORMAT_ACTIVE,
930 .target = V4L2_SEL_TGT_COMPOSE,
932 struct v4l2_pix_format *pix = &vou_dev->pix;
933 struct sh_vou_geometry geo;
934 struct v4l2_subdev_format format = {
935 .which = V4L2_SUBDEV_FORMAT_ACTIVE,
936 /* Revisit: is this the correct code? */
937 .format.code = MEDIA_BUS_FMT_YUYV8_2X8,
938 .format.field = V4L2_FIELD_INTERLACED,
939 .format.colorspace = V4L2_COLORSPACE_SMPTE170M,
941 unsigned int img_height_max;
944 if (sel->type != V4L2_BUF_TYPE_VIDEO_OUTPUT ||
945 sel->target != V4L2_SEL_TGT_COMPOSE)
948 if (vb2_is_busy(&vou_dev->queue))
951 if (vou_dev->std & V4L2_STD_525_60)
952 img_height_max = 480;
954 img_height_max = 576;
956 v4l_bound_align_image(&rect->width,
957 VOU_MIN_IMAGE_WIDTH, VOU_MAX_IMAGE_WIDTH, 1,
959 VOU_MIN_IMAGE_HEIGHT, img_height_max, 1, 0);
961 if (rect->width + rect->left > VOU_MAX_IMAGE_WIDTH)
962 rect->left = VOU_MAX_IMAGE_WIDTH - rect->width;
964 if (rect->height + rect->top > img_height_max)
965 rect->top = img_height_max - rect->height;
968 geo.in_width = pix->width;
969 geo.in_height = pix->height;
971 /* Configure the encoder one-to-one, position at 0, ignore errors */
972 sd_sel.r.width = geo.output.width;
973 sd_sel.r.height = geo.output.height;
975 * We first issue a S_SELECTION, so that the subsequent S_FMT delivers the
976 * final encoder configuration.
978 v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, pad,
979 set_selection, NULL, &sd_sel);
980 format.format.width = geo.output.width;
981 format.format.height = geo.output.height;
982 ret = v4l2_device_call_until_err(&vou_dev->v4l2_dev, 0, pad,
983 set_fmt, NULL, &format);
984 /* Must be implemented, so, don't check for -ENOIOCTLCMD */
989 if ((unsigned)format.format.width > VOU_MAX_IMAGE_WIDTH ||
990 (unsigned)format.format.height > img_height_max ||
991 format.format.code != MEDIA_BUS_FMT_YUYV8_2X8)
994 geo.output.width = format.format.width;
995 geo.output.height = format.format.height;
998 * No down-scaling. According to the API, current call has precedence:
999 * https://linuxtv.org/downloads/v4l-dvb-apis/uapi/v4l/crop.html#cropping-structures
1001 vou_adjust_input(&geo, vou_dev->std);
1003 /* We tried to preserve output rectangle, but it could have changed */
1004 vou_dev->rect = geo.output;
1005 pix->width = geo.in_width;
1006 pix->height = geo.in_height;
1008 sh_vou_configure_geometry(vou_dev, vou_dev->pix_idx,
1009 geo.scale_idx_h, geo.scale_idx_v);
1014 static irqreturn_t sh_vou_isr(int irq, void *dev_id)
1016 struct sh_vou_device *vou_dev = dev_id;
1017 static unsigned long j;
1018 struct sh_vou_buffer *vb;
1020 u32 irq_status = sh_vou_reg_a_read(vou_dev, VOUIR), masked;
1021 u32 vou_status = sh_vou_reg_a_read(vou_dev, VOUSTR);
1023 if (!(irq_status & 0x300)) {
1024 if (printk_timed_ratelimit(&j, 500))
1025 dev_warn(vou_dev->v4l2_dev.dev, "IRQ status 0x%x!\n",
1030 spin_lock(&vou_dev->lock);
1031 if (!vou_dev->active || list_empty(&vou_dev->buf_list)) {
1032 if (printk_timed_ratelimit(&j, 500))
1033 dev_warn(vou_dev->v4l2_dev.dev,
1034 "IRQ without active buffer: %x!\n", irq_status);
1035 /* Just ack: buf_release will disable further interrupts */
1036 sh_vou_reg_a_set(vou_dev, VOUIR, 0, 0x300);
1037 spin_unlock(&vou_dev->lock);
1041 masked = ~(0x300 & irq_status) & irq_status & 0x30304;
1042 dev_dbg(vou_dev->v4l2_dev.dev,
1043 "IRQ status 0x%x -> 0x%x, VOU status 0x%x, cnt %d\n",
1044 irq_status, masked, vou_status, cnt);
1047 /* side = vou_status & 0x10000; */
1049 /* Clear only set interrupts */
1050 sh_vou_reg_a_write(vou_dev, VOUIR, masked);
1052 vb = vou_dev->active;
1053 if (list_is_singular(&vb->list)) {
1054 /* Keep cycling while no next buffer is available */
1055 sh_vou_schedule_next(vou_dev, &vb->vb);
1056 spin_unlock(&vou_dev->lock);
1060 list_del(&vb->list);
1062 vb->vb.vb2_buf.timestamp = ktime_get_ns();
1063 vb->vb.sequence = vou_dev->sequence++;
1064 vb->vb.field = V4L2_FIELD_INTERLACED;
1065 vb2_buffer_done(&vb->vb.vb2_buf, VB2_BUF_STATE_DONE);
1067 vou_dev->active = list_entry(vou_dev->buf_list.next,
1068 struct sh_vou_buffer, list);
1070 if (list_is_singular(&vou_dev->buf_list)) {
1071 /* Keep cycling while no next buffer is available */
1072 sh_vou_schedule_next(vou_dev, &vou_dev->active->vb);
1074 struct sh_vou_buffer *new = list_entry(vou_dev->active->list.next,
1075 struct sh_vou_buffer, list);
1076 sh_vou_schedule_next(vou_dev, &new->vb);
1079 spin_unlock(&vou_dev->lock);
1084 static int sh_vou_hw_init(struct sh_vou_device *vou_dev)
1086 struct sh_vou_pdata *pdata = vou_dev->pdata;
1087 u32 voucr = sh_vou_ntsc_mode(pdata->bus_fmt) << 29;
1090 /* Disable all IRQs */
1091 sh_vou_reg_a_write(vou_dev, VOUIR, 0);
1093 /* Reset VOU interfaces - registers unaffected */
1094 sh_vou_reg_a_write(vou_dev, VOUSRR, 0x101);
1095 while (--i && (sh_vou_reg_a_read(vou_dev, VOUSRR) & 0x101))
1101 dev_dbg(vou_dev->v4l2_dev.dev, "Reset took %dus\n", 100 - i);
1103 if (pdata->flags & SH_VOU_PCLK_FALLING)
1105 if (pdata->flags & SH_VOU_HSYNC_LOW)
1107 if (pdata->flags & SH_VOU_VSYNC_LOW)
1109 sh_vou_reg_ab_set(vou_dev, VOUCR, voucr, 0xfc000000);
1111 /* Manual register side switching at first */
1112 sh_vou_reg_a_write(vou_dev, VOURCR, 4);
1113 /* Default - fixed HSYNC length, can be made configurable is required */
1114 sh_vou_reg_ab_write(vou_dev, VOUMSR, 0x800000);
1116 sh_vou_set_fmt_vid_out(vou_dev, &vou_dev->pix);
1121 /* File operations */
1122 static int sh_vou_open(struct file *file)
1124 struct sh_vou_device *vou_dev = video_drvdata(file);
1127 if (mutex_lock_interruptible(&vou_dev->fop_lock))
1128 return -ERESTARTSYS;
1130 err = v4l2_fh_open(file);
1133 if (v4l2_fh_is_singular_file(file) &&
1134 vou_dev->status == SH_VOU_INITIALISING) {
1136 pm_runtime_get_sync(vou_dev->v4l2_dev.dev);
1137 err = sh_vou_hw_init(vou_dev);
1139 pm_runtime_put(vou_dev->v4l2_dev.dev);
1140 v4l2_fh_release(file);
1142 vou_dev->status = SH_VOU_IDLE;
1146 mutex_unlock(&vou_dev->fop_lock);
1150 static int sh_vou_release(struct file *file)
1152 struct sh_vou_device *vou_dev = video_drvdata(file);
1155 mutex_lock(&vou_dev->fop_lock);
1156 is_last = v4l2_fh_is_singular_file(file);
1157 _vb2_fop_release(file, NULL);
1160 vou_dev->status = SH_VOU_INITIALISING;
1161 sh_vou_reg_a_set(vou_dev, VOUER, 0, 0x101);
1162 pm_runtime_put(vou_dev->v4l2_dev.dev);
1164 mutex_unlock(&vou_dev->fop_lock);
1168 /* sh_vou display ioctl operations */
1169 static const struct v4l2_ioctl_ops sh_vou_ioctl_ops = {
1170 .vidioc_querycap = sh_vou_querycap,
1171 .vidioc_enum_fmt_vid_out = sh_vou_enum_fmt_vid_out,
1172 .vidioc_g_fmt_vid_out = sh_vou_g_fmt_vid_out,
1173 .vidioc_s_fmt_vid_out = sh_vou_s_fmt_vid_out,
1174 .vidioc_try_fmt_vid_out = sh_vou_try_fmt_vid_out,
1175 .vidioc_reqbufs = vb2_ioctl_reqbufs,
1176 .vidioc_create_bufs = vb2_ioctl_create_bufs,
1177 .vidioc_querybuf = vb2_ioctl_querybuf,
1178 .vidioc_qbuf = vb2_ioctl_qbuf,
1179 .vidioc_dqbuf = vb2_ioctl_dqbuf,
1180 .vidioc_prepare_buf = vb2_ioctl_prepare_buf,
1181 .vidioc_streamon = vb2_ioctl_streamon,
1182 .vidioc_streamoff = vb2_ioctl_streamoff,
1183 .vidioc_expbuf = vb2_ioctl_expbuf,
1184 .vidioc_g_output = sh_vou_g_output,
1185 .vidioc_s_output = sh_vou_s_output,
1186 .vidioc_enum_output = sh_vou_enum_output,
1187 .vidioc_s_std = sh_vou_s_std,
1188 .vidioc_g_std = sh_vou_g_std,
1189 .vidioc_g_selection = sh_vou_g_selection,
1190 .vidioc_s_selection = sh_vou_s_selection,
1191 .vidioc_log_status = sh_vou_log_status,
1194 static const struct v4l2_file_operations sh_vou_fops = {
1195 .owner = THIS_MODULE,
1196 .open = sh_vou_open,
1197 .release = sh_vou_release,
1198 .unlocked_ioctl = video_ioctl2,
1199 .mmap = vb2_fop_mmap,
1200 .poll = vb2_fop_poll,
1201 .write = vb2_fop_write,
1204 static const struct video_device sh_vou_video_template = {
1206 .fops = &sh_vou_fops,
1207 .ioctl_ops = &sh_vou_ioctl_ops,
1208 .tvnorms = V4L2_STD_525_60, /* PAL only supported in 8-bit non-bt656 mode */
1209 .vfl_dir = VFL_DIR_TX,
1210 .device_caps = V4L2_CAP_VIDEO_OUTPUT | V4L2_CAP_READWRITE |
1214 static int sh_vou_probe(struct platform_device *pdev)
1216 struct sh_vou_pdata *vou_pdata = pdev->dev.platform_data;
1217 struct v4l2_rect *rect;
1218 struct v4l2_pix_format *pix;
1219 struct i2c_adapter *i2c_adap;
1220 struct video_device *vdev;
1221 struct sh_vou_device *vou_dev;
1222 struct resource *reg_res;
1223 struct v4l2_subdev *subdev;
1224 struct vb2_queue *q;
1227 reg_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1228 irq = platform_get_irq(pdev, 0);
1230 if (!vou_pdata || !reg_res || irq <= 0) {
1231 dev_err(&pdev->dev, "Insufficient VOU platform information.\n");
1235 vou_dev = devm_kzalloc(&pdev->dev, sizeof(*vou_dev), GFP_KERNEL);
1239 INIT_LIST_HEAD(&vou_dev->buf_list);
1240 spin_lock_init(&vou_dev->lock);
1241 mutex_init(&vou_dev->fop_lock);
1242 vou_dev->pdata = vou_pdata;
1243 vou_dev->status = SH_VOU_INITIALISING;
1244 vou_dev->pix_idx = 1;
1246 rect = &vou_dev->rect;
1247 pix = &vou_dev->pix;
1249 /* Fill in defaults */
1250 vou_dev->std = V4L2_STD_NTSC_M;
1253 rect->width = VOU_MAX_IMAGE_WIDTH;
1255 pix->width = VOU_MAX_IMAGE_WIDTH;
1257 pix->pixelformat = V4L2_PIX_FMT_NV16;
1258 pix->field = V4L2_FIELD_INTERLACED;
1259 pix->bytesperline = VOU_MAX_IMAGE_WIDTH;
1260 pix->sizeimage = VOU_MAX_IMAGE_WIDTH * 2 * 480;
1261 pix->colorspace = V4L2_COLORSPACE_SMPTE170M;
1263 vou_dev->base = devm_ioremap_resource(&pdev->dev, reg_res);
1264 if (IS_ERR(vou_dev->base))
1265 return PTR_ERR(vou_dev->base);
1267 ret = devm_request_irq(&pdev->dev, irq, sh_vou_isr, 0, "vou", vou_dev);
1271 ret = v4l2_device_register(&pdev->dev, &vou_dev->v4l2_dev);
1273 dev_err(&pdev->dev, "Error registering v4l2 device\n");
1277 vdev = &vou_dev->vdev;
1278 *vdev = sh_vou_video_template;
1279 if (vou_pdata->bus_fmt == SH_VOU_BUS_8BIT)
1280 vdev->tvnorms |= V4L2_STD_PAL;
1281 vdev->v4l2_dev = &vou_dev->v4l2_dev;
1282 vdev->release = video_device_release_empty;
1283 vdev->lock = &vou_dev->fop_lock;
1285 video_set_drvdata(vdev, vou_dev);
1287 /* Initialize the vb2 queue */
1288 q = &vou_dev->queue;
1289 q->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
1290 q->io_modes = VB2_MMAP | VB2_DMABUF | VB2_WRITE;
1291 q->drv_priv = vou_dev;
1292 q->buf_struct_size = sizeof(struct sh_vou_buffer);
1293 q->ops = &sh_vou_qops;
1294 q->mem_ops = &vb2_dma_contig_memops;
1295 q->timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
1296 q->min_buffers_needed = 2;
1297 q->lock = &vou_dev->fop_lock;
1298 q->dev = &pdev->dev;
1299 ret = vb2_queue_init(q);
1304 INIT_LIST_HEAD(&vou_dev->buf_list);
1306 pm_runtime_enable(&pdev->dev);
1307 pm_runtime_resume(&pdev->dev);
1309 i2c_adap = i2c_get_adapter(vou_pdata->i2c_adap);
1315 ret = sh_vou_hw_init(vou_dev);
1319 subdev = v4l2_i2c_new_subdev_board(&vou_dev->v4l2_dev, i2c_adap,
1320 vou_pdata->board_info, NULL);
1326 ret = video_register_device(vdev, VFL_TYPE_GRABBER, -1);
1335 i2c_put_adapter(i2c_adap);
1337 pm_runtime_disable(&pdev->dev);
1338 v4l2_device_unregister(&vou_dev->v4l2_dev);
1342 static int sh_vou_remove(struct platform_device *pdev)
1344 struct v4l2_device *v4l2_dev = platform_get_drvdata(pdev);
1345 struct sh_vou_device *vou_dev = container_of(v4l2_dev,
1346 struct sh_vou_device, v4l2_dev);
1347 struct v4l2_subdev *sd = list_entry(v4l2_dev->subdevs.next,
1348 struct v4l2_subdev, list);
1349 struct i2c_client *client = v4l2_get_subdevdata(sd);
1351 pm_runtime_disable(&pdev->dev);
1352 video_unregister_device(&vou_dev->vdev);
1353 i2c_put_adapter(client->adapter);
1354 v4l2_device_unregister(&vou_dev->v4l2_dev);
1358 static struct platform_driver __refdata sh_vou = {
1359 .remove = sh_vou_remove,
1365 module_platform_driver_probe(sh_vou, sh_vou_probe);
1367 MODULE_DESCRIPTION("SuperH VOU driver");
1369 MODULE_LICENSE("GPL v2");
1370 MODULE_VERSION("0.1.0");
1371 MODULE_ALIAS("platform:sh-vou");