[deliverable/linux.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/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_try_g_mbus_fmt(struct v4l2_subdev *sd,
				 struct v4l2_mbus_framefmt *mf)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	struct ak881x *ak881x = to_ak881x(client);

	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_s_mbus_fmt(struct v4l2_subdev *sd,
			     struct v4l2_mbus_framefmt *mf)
{
	if (mf->field != V4L2_FIELD_INTERLACED ||
	    mf->code != MEDIA_BUS_FMT_YUYV8_2X8)
		return -EINVAL;

	return ak881x_try_g_mbus_fmt(sd, mf);
}

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 && !(std & ~V4L2_STD_PAL)) {
		vp1 = 0xf;
		ak881x->lines = 576;
	} else if (std && !(std & ~V4L2_STD_NTSC)) {
		vp1 = 0;
		ak881x->lines = 480;
	} 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 = {
	.s_mbus_fmt	= ak881x_s_mbus_fmt,
	.g_mbus_fmt	= ak881x_try_g_mbus_fmt,
	.try_mbus_fmt	= ak881x_try_g_mbus_fmt,
	.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,
};

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 GL	17
aec11e5d GL	18	#include <media/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
	96	static int ak881x_try_g_mbus_fmt(struct v4l2_subdev *sd,
	97	struct v4l2_mbus_framefmt *mf)
	98	{
	99	struct i2c_client *client = v4l2_get_subdevdata(sd);
	100	struct ak881x *ak881x = to_ak881x(client);
	101
	102	v4l_bound_align_image(&mf->width, 0, 720, 2,
	103	&mf->height, 0, ak881x->lines, 1, 0);
	104	mf->field = V4L2_FIELD_INTERLACED;
f5fe58fd	105	mf->code = MEDIA_BUS_FMT_YUYV8_2X8;
aec11e5d GL	106	mf->colorspace = V4L2_COLORSPACE_SMPTE170M;
	107
	108	return 0;
	109	}
	110
	111	static int ak881x_s_mbus_fmt(struct v4l2_subdev *sd,
	112	struct v4l2_mbus_framefmt *mf)
	113	{
	114	if (mf->field != V4L2_FIELD_INTERLACED \|\|
f5fe58fd	115	mf->code != MEDIA_BUS_FMT_YUYV8_2X8)
aec11e5d GL	116	return -EINVAL;
	117
	118	return ak881x_try_g_mbus_fmt(sd, mf);
	119	}
	120
ebcff5fc HV	121	static int ak881x_enum_mbus_code(struct v4l2_subdev *sd,
	122	struct v4l2_subdev_pad_config *cfg,
	123	struct v4l2_subdev_mbus_code_enum *code)
aec11e5d	124	{
ebcff5fc	125	if (code->pad \|\| code->index)
aec11e5d GL	126	return -EINVAL;
aec11e5d GL	127
ebcff5fc	128	code->code = MEDIA_BUS_FMT_YUYV8_2X8;
aec11e5d GL	129	return 0;
	130	}
	131
	132	static int ak881x_cropcap(struct v4l2_subdev sd, struct v4l2_cropcap a)
	133	{
	134	struct i2c_client *client = v4l2_get_subdevdata(sd);
	135	struct ak881x *ak881x = to_ak881x(client);
	136
	137	a->bounds.left = 0;
	138	a->bounds.top = 0;
	139	a->bounds.width = 720;
	140	a->bounds.height = ak881x->lines;
	141	a->defrect = a->bounds;
	142	a->type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
	143	a->pixelaspect.numerator = 1;
	144	a->pixelaspect.denominator = 1;
	145
	146	return 0;
	147	}
	148
	149	static int ak881x_s_std_output(struct v4l2_subdev *sd, v4l2_std_id std)
	150	{
	151	struct i2c_client *client = v4l2_get_subdevdata(sd);
	152	struct ak881x *ak881x = to_ak881x(client);
	153	u8 vp1;
	154
	155	if (std == V4L2_STD_NTSC_443) {
	156	vp1 = 3;
	157	ak881x->lines = 480;
	158	} else if (std == V4L2_STD_PAL_M) {
	159	vp1 = 5;
	160	ak881x->lines = 480;
	161	} else if (std == V4L2_STD_PAL_60) {
	162	vp1 = 7;
	163	ak881x->lines = 480;
	164	} else if (std && !(std & ~V4L2_STD_PAL)) {
	165	vp1 = 0xf;
	166	ak881x->lines = 576;
	167	} else if (std && !(std & ~V4L2_STD_NTSC)) {
	168	vp1 = 0;
	169	ak881x->lines = 480;
	170	} else {
	171	/* No SECAM or PAL_N/Nc supported */
	172	return -EINVAL;
	173	}
	174
	175	reg_set(client, AK881X_VIDEO_PROCESS1, vp1, 0xf);
	176
	177	return 0;
	178	}
	179
	180	static int ak881x_s_stream(struct v4l2_subdev *sd, int enable)
	181	{
	182	struct i2c_client *client = v4l2_get_subdevdata(sd);
	183	struct ak881x *ak881x = to_ak881x(client);
	184
	185	if (enable) {
	186	u8 dac;
	187	/* For colour-bar testing set bit 6 of AK881X_VIDEO_PROCESS1 */
	188	/* Default: composite output */
	189	if (ak881x->pdata->flags & AK881X_COMPONENT)
	190	dac = 3;
	191	else
	192	dac = 4;
193	/* Turn on the DAC(s) */
194	reg_write(client, AK881X_DAC_MODE, dac);
195	dev_dbg(&client->dev, "chip status 0x%x\n",
196	reg_read(client, AK881X_STATUS));
197	} else {
198	/* ...and clear bit 6 of AK881X_VIDEO_PROCESS1 here */
199	reg_write(client, AK881X_DAC_MODE, 0);
200	dev_dbg(&client->dev, "chip status 0x%x\n",
201	reg_read(client, AK881X_STATUS));
202	}
203
204	return 0;
205	}
206
207	static struct v4l2_subdev_core_ops ak881x_subdev_core_ops = {
aec11e5d GL	208	#ifdef CONFIG_VIDEO_ADV_DEBUG
	209	.g_register = ak881x_g_register,
	210	.s_register = ak881x_s_register,
	211	#endif
	212	};
	213
	214	static struct v4l2_subdev_video_ops ak881x_subdev_video_ops = {
	215	.s_mbus_fmt = ak881x_s_mbus_fmt,
	216	.g_mbus_fmt = ak881x_try_g_mbus_fmt,
	217	.try_mbus_fmt = ak881x_try_g_mbus_fmt,
	218	.cropcap = ak881x_cropcap,
aec11e5d GL	219	.s_std_output = ak881x_s_std_output,
	220	.s_stream = ak881x_s_stream,
	221	};
	222
ebcff5fc HV	223	static const struct v4l2_subdev_pad_ops ak881x_subdev_pad_ops = {
	224	.enum_mbus_code = ak881x_enum_mbus_code,
	225	};
	226
aec11e5d GL	227	static struct v4l2_subdev_ops ak881x_subdev_ops = {
	228	.core = &ak881x_subdev_core_ops,
	229	.video = &ak881x_subdev_video_ops,
ebcff5fc	230	.pad = &ak881x_subdev_pad_ops,
aec11e5d GL	231	};
	232
	233	static int ak881x_probe(struct i2c_client *client,
	234	const struct i2c_device_id *did)
	235	{
	236	struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
	237	struct ak881x *ak881x;
	238	u8 ifmode, data;
	239
	240	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
	241	dev_warn(&adapter->dev,
	242	"I2C-Adapter doesn't support I2C_FUNC_SMBUS_WORD\n");
	243	return -EIO;
	244	}
	245
c02b211d	246	ak881x = devm_kzalloc(&client->dev, sizeof(*ak881x), GFP_KERNEL);
aec11e5d GL	247	if (!ak881x)
	248	return -ENOMEM;
	249
	250	v4l2_i2c_subdev_init(&ak881x->subdev, client, &ak881x_subdev_ops);
	251
	252	data = reg_read(client, AK881X_DEVICE_ID);
	253
	254	switch (data) {
	255	case 0x13:
aec11e5d	256	case 0x14:
aec11e5d GL	257	break;
	258	default:
	259	dev_err(&client->dev,
	260	"No ak881x chip detected, register read %x\n", data);
aec11e5d GL	261	return -ENODEV;
	262	}
	263
	264	ak881x->revision = reg_read(client, AK881X_DEVICE_REVISION);
	265	ak881x->pdata = client->dev.platform_data;
	266
	267	if (ak881x->pdata) {
	268	if (ak881x->pdata->flags & AK881X_FIELD)
	269	ifmode = 4;
	270	else
	271	ifmode = 0;
	272
	273	switch (ak881x->pdata->flags & AK881X_IF_MODE_MASK) {
	274	case AK881X_IF_MODE_BT656:
	275	ifmode \|= 1;
	276	break;
	277	case AK881X_IF_MODE_MASTER:
	278	ifmode \|= 2;
	279	break;
	280	case AK881X_IF_MODE_SLAVE:
	281	default:
	282	break;
	283	}
	284
	285	dev_dbg(&client->dev, "IF mode %x\n", ifmode);
	286
	287	/*
	288	* "Line Blanking No." seems to be the same as the number of
	289	* "black" lines on, e.g., SuperH VOU, whose default value of 20
	290	* "incidentally" matches ak881x' default
	291	*/
	292	reg_write(client, AK881X_INTERFACE_MODE, ifmode \| (20 << 3));
	293	}
	294
	295	/* Hardware default: NTSC-M */
	296	ak881x->lines = 480;
	297
	298	dev_info(&client->dev, "Detected an ak881x chip ID %x, revision %x\n",
	299	data, ak881x->revision);
	300
	301	return 0;
	302	}
	303
	304	static int ak881x_remove(struct i2c_client *client)
	305	{
	306	struct ak881x *ak881x = to_ak881x(client);
	307
	308	v4l2_device_unregister_subdev(&ak881x->subdev);
aec11e5d GL	309
	310	return 0;
	311	}
	312
	313	static const struct i2c_device_id ak881x_id[] = {
	314	{ "ak8813", 0 },
	315	{ "ak8814", 0 },
	316	{ }
	317	};
	318	MODULE_DEVICE_TABLE(i2c, ak881x_id);
	319
	320	static struct i2c_driver ak881x_i2c_driver = {
	321	.driver = {
	322	.name = "ak881x",
	323	},
	324	.probe = ak881x_probe,
	325	.remove = ak881x_remove,
	326	.id_table = ak881x_id,
	327	};
	328
c6e8d86f	329	module_i2c_driver(ak881x_i2c_driver);
aec11e5d GL	330
	331	MODULE_DESCRIPTION("TV-output driver for ak8813/ak8814");
	332	MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
	333	MODULE_LICENSE("GPL v2");