[mirror_ubuntu-artful-kernel.git] / drivers / media / i2c / ak881x.c

/*
 * Driver for AK8813 / AK8814 TV-ecoders from Asahi Kasei Microsystems Co., Ltd. (AKM)
 *
 * Copyright (C) 2010, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/videodev2.h>
#include <linux/module.h>

#include <media/i2c/ak881x.h>
#include <media/v4l2-common.h>
#include <media/v4l2-device.h>

#define AK881X_INTERFACE_MODE	0
#define AK881X_VIDEO_PROCESS1	1
#define AK881X_VIDEO_PROCESS2	2
#define AK881X_VIDEO_PROCESS3	3
#define AK881X_DAC_MODE		5
#define AK881X_STATUS		0x24
#define AK881X_DEVICE_ID	0x25
#define AK881X_DEVICE_REVISION	0x26

struct ak881x {
	struct v4l2_subdev subdev;
	struct ak881x_pdata *pdata;
	unsigned int lines;
	char revision;	/* DEVICE_REVISION content */
};

static int reg_read(struct i2c_client *client, const u8 reg)
{
	return i2c_smbus_read_byte_data(client, reg);
}

static int reg_write(struct i2c_client *client, const u8 reg,
		     const u8 data)
{
	return i2c_smbus_write_byte_data(client, reg, data);
}

static int reg_set(struct i2c_client *client, const u8 reg,
		   const u8 data, u8 mask)
{
	int ret = reg_read(client, reg);
	if (ret < 0)
		return ret;
	return reg_write(client, reg, (ret & ~mask) | (data & mask));
}

static struct ak881x *to_ak881x(const struct i2c_client *client)
{
	return container_of(i2c_get_clientdata(client), struct ak881x, subdev);
}

#ifdef CONFIG_VIDEO_ADV_DEBUG
static int ak881x_g_register(struct v4l2_subdev *sd,
			     struct v4l2_dbg_register *reg)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);

	if (reg->reg > 0x26)
		return -EINVAL;

	reg->size = 1;
	reg->val = reg_read(client, reg->reg);

	if (reg->val > 0xffff)
		return -EIO;

	return 0;
}

static int ak881x_s_register(struct v4l2_subdev *sd,
			     const struct v4l2_dbg_register *reg)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);

	if (reg->reg > 0x26)
		return -EINVAL;

	if (reg_write(client, reg->reg, reg->val) < 0)
		return -EIO;

	return 0;
}
#endif

static int ak881x_fill_fmt(struct v4l2_subdev *sd,
		struct v4l2_subdev_pad_config *cfg,
		struct v4l2_subdev_format *format)
{
	struct v4l2_mbus_framefmt *mf = &format->format;
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	struct ak881x *ak881x = to_ak881x(client);

	if (format->pad)
		return -EINVAL;

	v4l_bound_align_image(&mf->width, 0, 720, 2,
			      &mf->height, 0, ak881x->lines, 1, 0);
	mf->field	= V4L2_FIELD_INTERLACED;
	mf->code	= MEDIA_BUS_FMT_YUYV8_2X8;
	mf->colorspace	= V4L2_COLORSPACE_SMPTE170M;

	return 0;
}

static int ak881x_enum_mbus_code(struct v4l2_subdev *sd,
		struct v4l2_subdev_pad_config *cfg,
		struct v4l2_subdev_mbus_code_enum *code)
{
	if (code->pad || code->index)
		return -EINVAL;

	code->code = MEDIA_BUS_FMT_YUYV8_2X8;
	return 0;
}

static int ak881x_cropcap(struct v4l2_subdev *sd, struct v4l2_cropcap *a)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	struct ak881x *ak881x = to_ak881x(client);

	a->bounds.left			= 0;
	a->bounds.top			= 0;
	a->bounds.width			= 720;
	a->bounds.height		= ak881x->lines;
	a->defrect			= a->bounds;
	a->type				= V4L2_BUF_TYPE_VIDEO_OUTPUT;
	a->pixelaspect.numerator	= 1;
	a->pixelaspect.denominator	= 1;

	return 0;
}

static int ak881x_s_std_output(struct v4l2_subdev *sd, v4l2_std_id std)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	struct ak881x *ak881x = to_ak881x(client);
	u8 vp1;

	if (std == V4L2_STD_NTSC_443) {
		vp1 = 3;
		ak881x->lines = 480;
	} else if (std == V4L2_STD_PAL_M) {
		vp1 = 5;
		ak881x->lines = 480;
	} else if (std == V4L2_STD_PAL_60) {
		vp1 = 7;
		ak881x->lines = 480;
	} else if (std & V4L2_STD_NTSC) {
		vp1 = 0;
		ak881x->lines = 480;
	} else if (std & V4L2_STD_PAL) {
		vp1 = 0xf;
		ak881x->lines = 576;
	} else {
		/* No SECAM or PAL_N/Nc supported */
		return -EINVAL;
	}

	reg_set(client, AK881X_VIDEO_PROCESS1, vp1, 0xf);

	return 0;
}

static int ak881x_s_stream(struct v4l2_subdev *sd, int enable)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	struct ak881x *ak881x = to_ak881x(client);

	if (enable) {
		u8 dac;
		/* For colour-bar testing set bit 6 of AK881X_VIDEO_PROCESS1 */
		/* Default: composite output */
		if (ak881x->pdata->flags & AK881X_COMPONENT)
			dac = 3;
		else
			dac = 4;
		/* Turn on the DAC(s) */
		reg_write(client, AK881X_DAC_MODE, dac);
		dev_dbg(&client->dev, "chip status 0x%x\n",
			reg_read(client, AK881X_STATUS));
	} else {
		/* ...and clear bit 6 of AK881X_VIDEO_PROCESS1 here */
		reg_write(client, AK881X_DAC_MODE, 0);
		dev_dbg(&client->dev, "chip status 0x%x\n",
			reg_read(client, AK881X_STATUS));
	}

	return 0;
}

static struct v4l2_subdev_core_ops ak881x_subdev_core_ops = {
#ifdef CONFIG_VIDEO_ADV_DEBUG
	.g_register	= ak881x_g_register,
	.s_register	= ak881x_s_register,
#endif
};

static struct v4l2_subdev_video_ops ak881x_subdev_video_ops = {
	.cropcap	= ak881x_cropcap,
	.s_std_output	= ak881x_s_std_output,
	.s_stream	= ak881x_s_stream,
};

static const struct v4l2_subdev_pad_ops ak881x_subdev_pad_ops = {
	.enum_mbus_code = ak881x_enum_mbus_code,
	.set_fmt	= ak881x_fill_fmt,
	.get_fmt	= ak881x_fill_fmt,
};

static struct v4l2_subdev_ops ak881x_subdev_ops = {
	.core	= &ak881x_subdev_core_ops,
	.video	= &ak881x_subdev_video_ops,
	.pad	= &ak881x_subdev_pad_ops,
};

static int ak881x_probe(struct i2c_client *client,
			const struct i2c_device_id *did)
{
	struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
	struct ak881x *ak881x;
	u8 ifmode, data;

	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
		dev_warn(&adapter->dev,
			 "I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
		return -EIO;
	}

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

	v4l2_i2c_subdev_init(&ak881x->subdev, client, &ak881x_subdev_ops);

	data = reg_read(client, AK881X_DEVICE_ID);

	switch (data) {
	case 0x13:
	case 0x14:
		break;
	default:
		dev_err(&client->dev,
			"No ak881x chip detected, register read %x\n", data);
		return -ENODEV;
	}

	ak881x->revision = reg_read(client, AK881X_DEVICE_REVISION);
	ak881x->pdata = client->dev.platform_data;

	if (ak881x->pdata) {
		if (ak881x->pdata->flags & AK881X_FIELD)
			ifmode = 4;
		else
			ifmode = 0;

		switch (ak881x->pdata->flags & AK881X_IF_MODE_MASK) {
		case AK881X_IF_MODE_BT656:
			ifmode |= 1;
			break;
		case AK881X_IF_MODE_MASTER:
			ifmode |= 2;
			break;
		case AK881X_IF_MODE_SLAVE:
		default:
			break;
		}

		dev_dbg(&client->dev, "IF mode %x\n", ifmode);

		/*
		 * "Line Blanking No." seems to be the same as the number of
		 * "black" lines on, e.g., SuperH VOU, whose default value of 20
		 * "incidentally" matches ak881x' default
		 */
		reg_write(client, AK881X_INTERFACE_MODE, ifmode | (20 << 3));
	}

	/* Hardware default: NTSC-M */
	ak881x->lines = 480;

	dev_info(&client->dev, "Detected an ak881x chip ID %x, revision %x\n",
		 data, ak881x->revision);

	return 0;
}

static int ak881x_remove(struct i2c_client *client)
{
	struct ak881x *ak881x = to_ak881x(client);

	v4l2_device_unregister_subdev(&ak881x->subdev);

	return 0;
}

static const struct i2c_device_id ak881x_id[] = {
	{ "ak8813", 0 },
	{ "ak8814", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, ak881x_id);

static struct i2c_driver ak881x_i2c_driver = {
	.driver = {
		.name = "ak881x",
	},
	.probe		= ak881x_probe,
	.remove		= ak881x_remove,
	.id_table	= ak881x_id,
};

module_i2c_driver(ak881x_i2c_driver);

MODULE_DESCRIPTION("TV-output driver for ak8813/ak8814");
MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
aec11e5d GL	1	/*
	2	* Driver for AK8813 / AK8814 TV-ecoders from Asahi Kasei Microsystems Co., Ltd. (AKM)
	3	*
	4	* Copyright (C) 2010, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
	5	*
	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.
	9	*/
	10
	11	#include <linux/i2c.h>
	12	#include <linux/init.h>
	13	#include <linux/platform_device.h>
1db2c22b	14	#include <linux/slab.h>
aec11e5d	15	#include <linux/videodev2.h>
7a707b89	16	#include <linux/module.h>
aec11e5d	17
b5dcee22	18	#include <media/i2c/ak881x.h>
aec11e5d GL	19	#include <media/v4l2-common.h>
	20	#include <media/v4l2-device.h>
	21
	22	#define AK881X_INTERFACE_MODE 0
	23	#define AK881X_VIDEO_PROCESS1 1
	24	#define AK881X_VIDEO_PROCESS2 2
	25	#define AK881X_VIDEO_PROCESS3 3
	26	#define AK881X_DAC_MODE 5
	27	#define AK881X_STATUS 0x24
	28	#define AK881X_DEVICE_ID 0x25
	29	#define AK881X_DEVICE_REVISION 0x26
	30
	31	struct ak881x {
	32	struct v4l2_subdev subdev;
	33	struct ak881x_pdata *pdata;
	34	unsigned int lines;
aec11e5d GL	35	char revision; /* DEVICE_REVISION content */
	36	};
	37
	38	static int reg_read(struct i2c_client *client, const u8 reg)
	39	{
	40	return i2c_smbus_read_byte_data(client, reg);
	41	}
	42
	43	static int reg_write(struct i2c_client *client, const u8 reg,
	44	const u8 data)
	45	{
	46	return i2c_smbus_write_byte_data(client, reg, data);
	47	}
	48
	49	static int reg_set(struct i2c_client *client, const u8 reg,
	50	const u8 data, u8 mask)
	51	{
	52	int ret = reg_read(client, reg);
	53	if (ret < 0)
	54	return ret;
	55	return reg_write(client, reg, (ret & ~mask) \| (data & mask));
	56	}
	57
	58	static struct ak881x to_ak881x(const struct i2c_client client)
	59	{
	60	return container_of(i2c_get_clientdata(client), struct ak881x, subdev);
	61	}
	62
aec11e5d GL	63	#ifdef CONFIG_VIDEO_ADV_DEBUG
	64	static int ak881x_g_register(struct v4l2_subdev *sd,
	65	struct v4l2_dbg_register *reg)
	66	{
	67	struct i2c_client *client = v4l2_get_subdevdata(sd);
	68
e1277110	69	if (reg->reg > 0x26)
aec11e5d GL	70	return -EINVAL;
aec11e5d GL	71
15c4fee3	72	reg->size = 1;
aec11e5d GL	73	reg->val = reg_read(client, reg->reg);
	74
	75	if (reg->val > 0xffff)
	76	return -EIO;
	77
	78	return 0;
	79	}
	80
	81	static int ak881x_s_register(struct v4l2_subdev *sd,
977ba3b1	82	const struct v4l2_dbg_register *reg)
aec11e5d GL	83	{
	84	struct i2c_client *client = v4l2_get_subdevdata(sd);
	85
e1277110	86	if (reg->reg > 0x26)
aec11e5d GL	87	return -EINVAL;
aec11e5d GL	88
aec11e5d GL	89	if (reg_write(client, reg->reg, reg->val) < 0)
	90	return -EIO;
	91
	92	return 0;
	93	}
	94	#endif
	95
da298c6d HV	96	static int ak881x_fill_fmt(struct v4l2_subdev *sd,
	97	struct v4l2_subdev_pad_config *cfg,
	98	struct v4l2_subdev_format *format)
aec11e5d	99	{
da298c6d	100	struct v4l2_mbus_framefmt *mf = &format->format;
aec11e5d GL	101	struct i2c_client *client = v4l2_get_subdevdata(sd);
	102	struct ak881x *ak881x = to_ak881x(client);
	103
da298c6d HV	104	if (format->pad)
	105	return -EINVAL;
	106
aec11e5d GL	107	v4l_bound_align_image(&mf->width, 0, 720, 2,
	108	&mf->height, 0, ak881x->lines, 1, 0);
	109	mf->field = V4L2_FIELD_INTERLACED;
f5fe58fd	110	mf->code = MEDIA_BUS_FMT_YUYV8_2X8;
aec11e5d GL	111	mf->colorspace = V4L2_COLORSPACE_SMPTE170M;
	112
	113	return 0;
	114	}
	115
ebcff5fc HV	116	static int ak881x_enum_mbus_code(struct v4l2_subdev *sd,
	117	struct v4l2_subdev_pad_config *cfg,
	118	struct v4l2_subdev_mbus_code_enum *code)
aec11e5d	119	{
ebcff5fc	120	if (code->pad \|\| code->index)
aec11e5d GL	121	return -EINVAL;
aec11e5d GL	122
ebcff5fc	123	code->code = MEDIA_BUS_FMT_YUYV8_2X8;
aec11e5d GL	124	return 0;
	125	}
	126
	127	static int ak881x_cropcap(struct v4l2_subdev sd, struct v4l2_cropcap a)
	128	{
	129	struct i2c_client *client = v4l2_get_subdevdata(sd);
	130	struct ak881x *ak881x = to_ak881x(client);
	131
	132	a->bounds.left = 0;
	133	a->bounds.top = 0;
	134	a->bounds.width = 720;
	135	a->bounds.height = ak881x->lines;
	136	a->defrect = a->bounds;
	137	a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
	138	a->pixelaspect.numerator = 1;
	139	a->pixelaspect.denominator = 1;
	140
	141	return 0;
	142	}
	143
	144	static int ak881x_s_std_output(struct v4l2_subdev *sd, v4l2_std_id std)
	145	{
	146	struct i2c_client *client = v4l2_get_subdevdata(sd);
	147	struct ak881x *ak881x = to_ak881x(client);
	148	u8 vp1;
	149
	150	if (std == V4L2_STD_NTSC_443) {
	151	vp1 = 3;
	152	ak881x->lines = 480;
	153	} else if (std == V4L2_STD_PAL_M) {
	154	vp1 = 5;
	155	ak881x->lines = 480;
	156	} else if (std == V4L2_STD_PAL_60) {
	157	vp1 = 7;
	158	ak881x->lines = 480;
517ef255	159	} else if (std & V4L2_STD_NTSC) {
aec11e5d GL	160	vp1 = 0;
aec11e5d GL	161	ak881x->lines = 480;
517ef255 HV	162	} else if (std & V4L2_STD_PAL) {
	163	vp1 = 0xf;
	164	ak881x->lines = 576;
aec11e5d GL	165	} else {
	166	/* No SECAM or PAL_N/Nc supported */
	167	return -EINVAL;
	168	}
	169
	170	reg_set(client, AK881X_VIDEO_PROCESS1, vp1, 0xf);
	171
	172	return 0;
	173	}
	174
	175	static int ak881x_s_stream(struct v4l2_subdev *sd, int enable)
	176	{
	177	struct i2c_client *client = v4l2_get_subdevdata(sd);
	178	struct ak881x *ak881x = to_ak881x(client);
	179
	180	if (enable) {
	181	u8 dac;
	182	/* For colour-bar testing set bit 6 of AK881X_VIDEO_PROCESS1 */
	183	/* Default: composite output */
	184	if (ak881x->pdata->flags & AK881X_COMPONENT)
	185	dac = 3;
	186	else
	187	dac = 4;
	188	/* Turn on the DAC(s) */
	189	reg_write(client, AK881X_DAC_MODE, dac);
	190	dev_dbg(&client->dev, "chip status 0x%x\n",
	191	reg_read(client, AK881X_STATUS));
	192	} else {
	193	/* ...and clear bit 6 of AK881X_VIDEO_PROCESS1 here */
	194	reg_write(client, AK881X_DAC_MODE, 0);
	195	dev_dbg(&client->dev, "chip status 0x%x\n",
	196	reg_read(client, AK881X_STATUS));
	197	}
	198
	199	return 0;
	200	}
	201
	202	static struct v4l2_subdev_core_ops ak881x_subdev_core_ops = {
aec11e5d GL	203	#ifdef CONFIG_VIDEO_ADV_DEBUG
	204	.g_register = ak881x_g_register,
	205	.s_register = ak881x_s_register,
	206	#endif
	207	};
	208
	209	static struct v4l2_subdev_video_ops ak881x_subdev_video_ops = {
aec11e5d	210	.cropcap = ak881x_cropcap,
aec11e5d GL	211	.s_std_output = ak881x_s_std_output,
	212	.s_stream = ak881x_s_stream,
	213	};
	214
ebcff5fc HV	215	static const struct v4l2_subdev_pad_ops ak881x_subdev_pad_ops = {
ebcff5fc HV	216	.enum_mbus_code = ak881x_enum_mbus_code,
da298c6d HV	217	.set_fmt = ak881x_fill_fmt,
da298c6d HV	218	.get_fmt = ak881x_fill_fmt,
ebcff5fc HV	219	};
ebcff5fc HV	220
aec11e5d GL	221	static struct v4l2_subdev_ops ak881x_subdev_ops = {
	222	.core = &ak881x_subdev_core_ops,
	223	.video = &ak881x_subdev_video_ops,
ebcff5fc	224	.pad = &ak881x_subdev_pad_ops,
aec11e5d GL	225	};
	226
	227	static int ak881x_probe(struct i2c_client *client,
	228	const struct i2c_device_id *did)
	229	{
	230	struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
	231	struct ak881x *ak881x;
	232	u8 ifmode, data;
	233
	234	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
	235	dev_warn(&adapter->dev,
	236	"I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
	237	return -EIO;
	238	}
	239
c02b211d	240	ak881x = devm_kzalloc(&client->dev, sizeof(*ak881x), GFP_KERNEL);
aec11e5d GL	241	if (!ak881x)
	242	return -ENOMEM;
	243
	244	v4l2_i2c_subdev_init(&ak881x->subdev, client, &ak881x_subdev_ops);
	245
	246	data = reg_read(client, AK881X_DEVICE_ID);
	247
	248	switch (data) {
	249	case 0x13:
aec11e5d	250	case 0x14:
aec11e5d GL	251	break;
	252	default:
	253	dev_err(&client->dev,
	254	"No ak881x chip detected, register read %x\n", data);
aec11e5d GL	255	return -ENODEV;
	256	}
	257
	258	ak881x->revision = reg_read(client, AK881X_DEVICE_REVISION);
	259	ak881x->pdata = client->dev.platform_data;
	260
	261	if (ak881x->pdata) {
	262	if (ak881x->pdata->flags & AK881X_FIELD)
	263	ifmode = 4;
	264	else
	265	ifmode = 0;
	266
	267	switch (ak881x->pdata->flags & AK881X_IF_MODE_MASK) {
	268	case AK881X_IF_MODE_BT656:
	269	ifmode \|= 1;
	270	break;
	271	case AK881X_IF_MODE_MASTER:
	272	ifmode \|= 2;
	273	break;
	274	case AK881X_IF_MODE_SLAVE:
	275	default:
	276	break;
	277	}
	278
	279	dev_dbg(&client->dev, "IF mode %x\n", ifmode);
	280
	281	/*
	282	* "Line Blanking No." seems to be the same as the number of
	283	* "black" lines on, e.g., SuperH VOU, whose default value of 20
	284	* "incidentally" matches ak881x' default
	285	*/
	286	reg_write(client, AK881X_INTERFACE_MODE, ifmode \| (20 << 3));
	287	}
	288
	289	/* Hardware default: NTSC-M */
	290	ak881x->lines = 480;
	291
	292	dev_info(&client->dev, "Detected an ak881x chip ID %x, revision %x\n",
	293	data, ak881x->revision);
	294
	295	return 0;
	296	}
	297
	298	static int ak881x_remove(struct i2c_client *client)
	299	{
	300	struct ak881x *ak881x = to_ak881x(client);
	301
	302	v4l2_device_unregister_subdev(&ak881x->subdev);
aec11e5d GL	303
	304	return 0;
	305	}
	306
	307	static const struct i2c_device_id ak881x_id[] = {
	308	{ "ak8813", 0 },
	309	{ "ak8814", 0 },
	310	{ }
	311	};
	312	MODULE_DEVICE_TABLE(i2c, ak881x_id);
	313
	314	static struct i2c_driver ak881x_i2c_driver = {
	315	.driver = {
	316	.name = "ak881x",
	317	},
	318	.probe = ak881x_probe,
	319	.remove = ak881x_remove,
	320	.id_table = ak881x_id,
	321	};
	322
c6e8d86f	323	module_i2c_driver(ak881x_i2c_driver);
aec11e5d GL	324
	325	MODULE_DESCRIPTION("TV-output driver for ak8813/ak8814");
	326	MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
	327	MODULE_LICENSE("GPL v2");