path: root/drivers/media/platform/xilinx/xilinx-rgb2yuv.c

/*
 * Xilinx RGB to YUV Convertor
 *
 * Copyright (C) 2013-2015 Ideas on Board
 * Copyright (C) 2013-2015 Xilinx, Inc.
 *
 * Contacts: Hyun Kwon <hyun.kwon@xilinx.com>
 *           Laurent Pinchart <laurent.pinchart@ideasonboard.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/device.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/xilinx-v4l2-controls.h>

#include <media/v4l2-async.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-subdev.h>

#include "xilinx-vip.h"

#define XRGB2YUV_YMAX					0x100
#define XRGB2YUV_YMIN					0x104
#define XRGB2YUV_CBMAX					0x108
#define XRGB2YUV_CBMIN					0x10c
#define XRGB2YUV_CRMAX					0x110
#define XRGB2YUV_CRMIN					0x114
#define XRGB2YUV_YOFFSET				0x118
#define XRGB2YUV_CBOFFSET				0x11c
#define XRGB2YUV_CROFFSET				0x120
#define XRGB2YUV_ACOEF					0x124
#define XRGB2YUV_BCOEF					0x128
#define XRGB2YUV_CCOEF					0x12c
#define XRGB2YUV_DCOEF					0x130

/**
 * struct xrgb2yuv_device - Xilinx RGB2YUV device structure
 * @xvip: Xilinx Video IP device
 * @pads: media pads
 * @formats: V4L2 media bus formats at the sink and source pads
 * @default_formats: default V4L2 media bus formats
 * @vip_formats: Xilinx Video IP formats
 * @ctrl_handler: control handler
 */
struct xrgb2yuv_device {
	struct xvip_device xvip;

	struct media_pad pads[2];

	struct v4l2_mbus_framefmt formats[2];
	struct v4l2_mbus_framefmt default_formats[2];
	const struct xvip_video_format *vip_formats[2];

	struct v4l2_ctrl_handler ctrl_handler;
};

static inline struct xrgb2yuv_device *to_rgb2yuv(struct v4l2_subdev *subdev)
{
	return container_of(subdev, struct xrgb2yuv_device, xvip.subdev);
}

/*
 * V4L2 Subdevice Video Operations
 */

static int xrgb2yuv_s_stream(struct v4l2_subdev *subdev, int enable)
{
	struct xrgb2yuv_device *xrgb2yuv = to_rgb2yuv(subdev);

	if (!enable) {
		xvip_stop(&xrgb2yuv->xvip);
		return 0;
	}

	xvip_set_frame_size(&xrgb2yuv->xvip, &xrgb2yuv->formats[XVIP_PAD_SINK]);

	xvip_start(&xrgb2yuv->xvip);

	return 0;
}

/*
 * V4L2 Subdevice Pad Operations
 */

static struct v4l2_mbus_framefmt *
__xrgb2yuv_get_pad_format(struct xrgb2yuv_device *xrgb2yuv,
			  struct v4l2_subdev_pad_config *cfg,
			  unsigned int pad, u32 which)
{
	switch (which) {
	case V4L2_SUBDEV_FORMAT_TRY:
		return v4l2_subdev_get_try_format(&xrgb2yuv->xvip.subdev, cfg,
						  pad);
	case V4L2_SUBDEV_FORMAT_ACTIVE:
		return &xrgb2yuv->formats[pad];
	default:
		return NULL;
	}
}

static int xrgb2yuv_get_format(struct v4l2_subdev *subdev,
			       struct v4l2_subdev_pad_config *cfg,
			       struct v4l2_subdev_format *fmt)
{
	struct xrgb2yuv_device *xrgb2yuv = to_rgb2yuv(subdev);

	fmt->format = *__xrgb2yuv_get_pad_format(xrgb2yuv, cfg, fmt->pad,
						 fmt->which);

	return 0;
}

static int xrgb2yuv_set_format(struct v4l2_subdev *subdev,
			       struct v4l2_subdev_pad_config *cfg,
			       struct v4l2_subdev_format *fmt)
{
	struct xrgb2yuv_device *xrgb2yuv = to_rgb2yuv(subdev);
	struct v4l2_mbus_framefmt *format;

	format = __xrgb2yuv_get_pad_format(xrgb2yuv, cfg, fmt->pad, fmt->which);

	if (fmt->pad == XVIP_PAD_SOURCE) {
		fmt->format = *format;
		return 0;
	}

	xvip_set_format_size(format, fmt);

	fmt->format = *format;

	/* Propagate the format to the source pad. */
	format = __xrgb2yuv_get_pad_format(xrgb2yuv, cfg, XVIP_PAD_SOURCE,
					     fmt->which);

	xvip_set_format_size(format, fmt);

	return 0;
}

/*
 * V4L2 Subdevice Operations
 */

static int xrgb2yuv_open(struct v4l2_subdev *subdev, struct v4l2_subdev_fh *fh)
{
	struct xrgb2yuv_device *xrgb2yuv = to_rgb2yuv(subdev);
	struct v4l2_mbus_framefmt *format;

	/* Initialize with default formats */
	format = v4l2_subdev_get_try_format(subdev, fh->pad, XVIP_PAD_SINK);
	*format = xrgb2yuv->default_formats[XVIP_PAD_SINK];

	format = v4l2_subdev_get_try_format(subdev, fh->pad, XVIP_PAD_SOURCE);
	*format = xrgb2yuv->default_formats[XVIP_PAD_SOURCE];

	return 0;
}

static int xrgb2yuv_close(struct v4l2_subdev *subdev, struct v4l2_subdev_fh *fh)
{
	return 0;
}

static int xrgb2yuv_s_ctrl(struct v4l2_ctrl *ctrl)
{
	struct xrgb2yuv_device *xrgb2yuv =
		container_of(ctrl->handler, struct xrgb2yuv_device,
			     ctrl_handler);

	switch (ctrl->id) {
	case V4L2_CID_XILINX_RGB2YUV_YMAX:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_YMAX, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_YMIN:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_YMIN, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CBMAX:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CBMAX, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CBMIN:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CBMIN, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CRMAX:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CRMAX, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CRMIN:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CRMIN, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_YOFFSET:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_YOFFSET, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CBOFFSET:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CBOFFSET, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CROFFSET:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CROFFSET, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_ACOEF:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_ACOEF, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_BCOEF:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_BCOEF, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_CCOEF:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_CCOEF, ctrl->val);
		return 0;
	case V4L2_CID_XILINX_RGB2YUV_DCOEF:
		xvip_write(&xrgb2yuv->xvip, XRGB2YUV_DCOEF, ctrl->val);
		return 0;
	}

	return -EINVAL;
}

static const struct v4l2_ctrl_ops xrgb2yuv_ctrl_ops = {
	.s_ctrl	= xrgb2yuv_s_ctrl,
};

static struct v4l2_subdev_video_ops xrgb2yuv_video_ops = {
	.s_stream = xrgb2yuv_s_stream,
};

static struct v4l2_subdev_pad_ops xrgb2yuv_pad_ops = {
	.enum_mbus_code		= xvip_enum_mbus_code,
	.enum_frame_size	= xvip_enum_frame_size,
	.get_fmt		= xrgb2yuv_get_format,
	.set_fmt		= xrgb2yuv_set_format,
};

static struct v4l2_subdev_ops xrgb2yuv_ops = {
	.video  = &xrgb2yuv_video_ops,
	.pad    = &xrgb2yuv_pad_ops,
};

static const struct v4l2_subdev_internal_ops xrgb2yuv_internal_ops = {
	.open	= xrgb2yuv_open,
	.close	= xrgb2yuv_close,
};

/*
 * Control Configs
 */

static struct v4l2_ctrl_config xrgb2yuv_ctrls[] = {
	{
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_YMAX,
		.name	= "RGB to YUV: Maximum Y value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_YMIN,
		.name	= "RGB to YUV: Minimum Y value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CBMAX,
		.name	= "RGB to YUV: Maximum Cb value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CBMIN,
		.name	= "RGB to YUV: Minimum Cb value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CRMAX,
		.name	= "RGB to YUV: Maximum Cr value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CRMIN,
		.name	= "RGB to YUV: Minimum Cr value",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 16) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_YOFFSET,
		.name	= "RGB to YUV: Luma offset",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CBOFFSET,
		.name	= "RGB to YUV: Chroma Cb offset",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CROFFSET,
		.name	= "RGB to YUV: Chroma Cr offset",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= 0,
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_ACOEF,
		.name	= "RGB to YUV: CA coefficient",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= -((1 << 17) - 1),
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_BCOEF,
		.name	= "RGB to YUV: CB coefficient",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= -((1 << 17) - 1),
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_CCOEF,
		.name	= "RGB to YUV: CC coefficient",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= -((1 << 17) - 1),
		.max	= (1 << 17) - 1,
		.step	= 1,
	}, {
		.ops	= &xrgb2yuv_ctrl_ops,
		.id	= V4L2_CID_XILINX_RGB2YUV_DCOEF,
		.name	= "RGB to YUV: CD coefficient",
		.type	= V4L2_CTRL_TYPE_INTEGER,
		.min	= -((1 << 17) - 1),
		.max	= (1 << 17) - 1,
		.step	= 1,
	},
};

/*
 * Media Operations
 */

static const struct media_entity_operations xrgb2yuv_media_ops = {
	.link_validate = v4l2_subdev_link_validate,
};

/*
 * Power Management
 */

static int __maybe_unused xrgb2yuv_pm_suspend(struct device *dev)
{
	struct xrgb2yuv_device *xrgb2yuv = dev_get_drvdata(dev);

	xvip_suspend(&xrgb2yuv->xvip);

	return 0;
}

static int __maybe_unused xrgb2yuv_pm_resume(struct device *dev)
{
	struct xrgb2yuv_device *xrgb2yuv = dev_get_drvdata(dev);

	xvip_resume(&xrgb2yuv->xvip);

	return 0;
}

/*
 * Platform Device Driver
 */

static int xrgb2yuv_parse_of(struct xrgb2yuv_device *xrgb2yuv)
{
	struct device *dev = xrgb2yuv->xvip.dev;
	struct device_node *node = xrgb2yuv->xvip.dev->of_node;
	struct device_node *ports;
	struct device_node *port;
	u32 port_id;
	int ret;

	ports = of_get_child_by_name(node, "ports");
	if (ports == NULL)
		ports = node;

	/* Get the format description for each pad */
	for_each_child_of_node(ports, port) {
		if (port->name && (of_node_cmp(port->name, "port") == 0)) {
			const struct xvip_video_format *vip_format;

			vip_format = xvip_of_get_format(port);
			if (IS_ERR(vip_format)) {
				dev_err(dev, "invalid format in DT");
				return PTR_ERR(vip_format);
			}

			ret = of_property_read_u32(port, "reg", &port_id);
			if (ret < 0) {
				dev_err(dev, "no reg in DT");
				return ret;
			}

			if (port_id != 0 && port_id != 1) {
				dev_err(dev, "invalid reg in DT");
				return -EINVAL;
			}

			xrgb2yuv->vip_formats[port_id] = vip_format;
		}
	}

	return 0;
}

static int xrgb2yuv_probe(struct platform_device *pdev)
{
	struct xrgb2yuv_device *xrgb2yuv;
	struct v4l2_subdev *subdev;
	struct v4l2_mbus_framefmt *default_format;
	unsigned int i;
	int ret;

	xrgb2yuv = devm_kzalloc(&pdev->dev, sizeof(*xrgb2yuv), GFP_KERNEL);
	if (!xrgb2yuv)
		return -ENOMEM;

	xrgb2yuv->xvip.dev = &pdev->dev;

	ret = xrgb2yuv_parse_of(xrgb2yuv);
	if (ret < 0)
		return ret;

	ret = xvip_init_resources(&xrgb2yuv->xvip);
	if (ret < 0)
		return ret;

	/* Reset and initialize the core */
	xvip_reset(&xrgb2yuv->xvip);

	/* Initialize V4L2 subdevice and media entity */
	subdev = &xrgb2yuv->xvip.subdev;
	v4l2_subdev_init(subdev, &xrgb2yuv_ops);
	subdev->dev = &pdev->dev;
	subdev->internal_ops = &xrgb2yuv_internal_ops;
	strlcpy(subdev->name, dev_name(&pdev->dev), sizeof(subdev->name));
	v4l2_set_subdevdata(subdev, xrgb2yuv);
	subdev->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;

	/* Initialize default and active formats */
	default_format = &xrgb2yuv->default_formats[XVIP_PAD_SINK];
	default_format->code = xrgb2yuv->vip_formats[XVIP_PAD_SINK]->code;
	default_format->field = V4L2_FIELD_NONE;
	default_format->colorspace = V4L2_COLORSPACE_SRGB;
	xvip_get_frame_size(&xrgb2yuv->xvip, default_format);

	xrgb2yuv->formats[XVIP_PAD_SINK] = *default_format;

	default_format = &xrgb2yuv->default_formats[XVIP_PAD_SOURCE];
	*default_format = xrgb2yuv->default_formats[XVIP_PAD_SINK];
	default_format->code = xrgb2yuv->vip_formats[XVIP_PAD_SOURCE]->code;

	xrgb2yuv->formats[XVIP_PAD_SOURCE] = *default_format;

	xrgb2yuv->pads[XVIP_PAD_SINK].flags = MEDIA_PAD_FL_SINK;
	xrgb2yuv->pads[XVIP_PAD_SOURCE].flags = MEDIA_PAD_FL_SOURCE;
	subdev->entity.ops = &xrgb2yuv_media_ops;
	ret = media_entity_pads_init(&subdev->entity, 2, xrgb2yuv->pads);
	if (ret < 0)
		goto error;

	v4l2_ctrl_handler_init(&xrgb2yuv->ctrl_handler, 13);

	for (i = 0; i < ARRAY_SIZE(xrgb2yuv_ctrls); i++) {
		xrgb2yuv_ctrls[i].def = xvip_read(&xrgb2yuv->xvip,
						  XRGB2YUV_YMAX + i * 4);
		v4l2_ctrl_new_custom(&xrgb2yuv->ctrl_handler,
				     &xrgb2yuv_ctrls[i], NULL);
	}

	if (xrgb2yuv->ctrl_handler.error) {
		dev_err(&pdev->dev, "failed to add controls\n");
		ret = xrgb2yuv->ctrl_handler.error;
		goto error;
	}
	subdev->ctrl_handler = &xrgb2yuv->ctrl_handler;

	platform_set_drvdata(pdev, xrgb2yuv);

	xvip_print_version(&xrgb2yuv->xvip);

	ret = v4l2_async_register_subdev(subdev);
	if (ret < 0) {
		dev_err(&pdev->dev, "failed to register subdev\n");
		goto error;
	}

	return 0;

error:
	v4l2_ctrl_handler_free(&xrgb2yuv->ctrl_handler);
	media_entity_cleanup(&subdev->entity);
	xvip_cleanup_resources(&xrgb2yuv->xvip);
	return ret;
}

static int xrgb2yuv_remove(struct platform_device *pdev)
{
	struct xrgb2yuv_device *xrgb2yuv = platform_get_drvdata(pdev);
	struct v4l2_subdev *subdev = &xrgb2yuv->xvip.subdev;

	v4l2_async_unregister_subdev(subdev);
	v4l2_ctrl_handler_free(&xrgb2yuv->ctrl_handler);
	media_entity_cleanup(&subdev->entity);

	xvip_cleanup_resources(&xrgb2yuv->xvip);

	return 0;
}

static SIMPLE_DEV_PM_OPS(xrgb2yuv_pm_ops, xrgb2yuv_pm_suspend,
			 xrgb2yuv_pm_resume);

static const struct of_device_id xrgb2yuv_of_id_table[] = {
	{ .compatible = "xlnx,v-rgb2yuv-7.1" },
	{ }
};
MODULE_DEVICE_TABLE(of, xrgb2yuv_of_id_table);

static struct platform_driver xrgb2yuv_driver = {
	.driver			= {
		.name		= "xilinx-rgb2yuv",
		.pm		= &xrgb2yuv_pm_ops,
		.of_match_table	= xrgb2yuv_of_id_table,
	},
	.probe			= xrgb2yuv_probe,
	.remove			= xrgb2yuv_remove,
};

module_platform_driver(xrgb2yuv_driver);

MODULE_DESCRIPTION("Xilinx RGB to YUV Converter Driver");
MODULE_LICENSE("GPL v2");