[deliverable/linux.git] / drivers / media / video / upd64031a.c

/*
 * upd64031A - NEC Electronics Ghost Reduction for NTSC in Japan
 *
 * 2003 by T.Adachi <tadachi@tadachi-net.com>
 * 2003 by Takeru KOMORIYA <komoriya@paken.org>
 * 2006 by Hans Verkuil <hverkuil@xs4all.nl>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */


#include <linux/version.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/i2c.h>
#include <linux/videodev2.h>
#include <media/v4l2-device.h>
#include <media/v4l2-chip-ident.h>
#include <media/v4l2-i2c-drv.h>
#include <media/upd64031a.h>

/* --------------------- read registers functions define -------------------- */

/* bit masks */
#define GR_MODE_MASK              0xc0
#define DIRECT_3DYCS_CONNECT_MASK 0xc0
#define SYNC_CIRCUIT_MASK         0xa0

/* -------------------------------------------------------------------------- */

MODULE_DESCRIPTION("uPD64031A driver");
MODULE_AUTHOR("T. Adachi, Takeru KOMORIYA, Hans Verkuil");
MODULE_LICENSE("GPL");

static int debug;
module_param(debug, int, 0644);

MODULE_PARM_DESC(debug, "Debug level (0-1)");


enum {
	R00 = 0, R01, R02, R03, R04,
	R05, R06, R07, R08, R09,
	R0A, R0B, R0C, R0D, R0E, R0F,
	/* unused registers
	 R10, R11, R12, R13, R14,
	 R15, R16, R17,
	 */
	TOT_REGS
};

struct upd64031a_state {
	struct v4l2_subdev sd;
	u8 regs[TOT_REGS];
	u8 gr_mode;
	u8 direct_3dycs_connect;
	u8 ext_comp_sync;
	u8 ext_vert_sync;
};

static inline struct upd64031a_state *to_state(struct v4l2_subdev *sd)
{
	return container_of(sd, struct upd64031a_state, sd);
}

static u8 upd64031a_init[] = {
	0x00, 0xb8, 0x48, 0xd2, 0xe6,
	0x03, 0x10, 0x0b, 0xaf, 0x7f,
	0x00, 0x00, 0x1d, 0x5e, 0x00,
	0xd0
};

/* ------------------------------------------------------------------------ */

static u8 upd64031a_read(struct v4l2_subdev *sd, u8 reg)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	u8 buf[2];

	if (reg >= sizeof(buf))
		return 0xff;
	i2c_master_recv(client, buf, 2);
	return buf[reg];
}

/* ------------------------------------------------------------------------ */

static void upd64031a_write(struct v4l2_subdev *sd, u8 reg, u8 val)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	u8 buf[2];

	buf[0] = reg;
	buf[1] = val;
	v4l2_dbg(1, debug, sd, "write reg: %02X val: %02X\n", reg, val);
	if (i2c_master_send(client, buf, 2) != 2)
		v4l2_err(sd, "I/O error write 0x%02x/0x%02x\n", reg, val);
}

/* ------------------------------------------------------------------------ */

/* The input changed due to new input or channel changed */
static int upd64031a_s_frequency(struct v4l2_subdev *sd, struct v4l2_frequency *freq)
{
	struct upd64031a_state *state = to_state(sd);
	u8 reg = state->regs[R00];

	v4l2_dbg(1, debug, sd, "changed input or channel\n");
	upd64031a_write(sd, R00, reg | 0x10);
	upd64031a_write(sd, R00, reg & ~0x10);
	return 0;
}

/* ------------------------------------------------------------------------ */

static int upd64031a_s_routing(struct v4l2_subdev *sd, const struct v4l2_routing *route)
{
	struct upd64031a_state *state = to_state(sd);
	u8 r00, r05, r08;

	state->gr_mode = (route->input & 3) << 6;
	state->direct_3dycs_connect = (route->input & 0xc) << 4;
	state->ext_comp_sync =
		(route->input & UPD64031A_COMPOSITE_EXTERNAL) << 1;
	state->ext_vert_sync =
		(route->input & UPD64031A_VERTICAL_EXTERNAL) << 2;
	r00 = (state->regs[R00] & ~GR_MODE_MASK) | state->gr_mode;
	r05 = (state->regs[R00] & ~SYNC_CIRCUIT_MASK) |
		state->ext_comp_sync | state->ext_vert_sync;
	r08 = (state->regs[R08] & ~DIRECT_3DYCS_CONNECT_MASK) |
		state->direct_3dycs_connect;
	upd64031a_write(sd, R00, r00);
	upd64031a_write(sd, R05, r05);
	upd64031a_write(sd, R08, r08);
	return upd64031a_s_frequency(sd, NULL);
}

static int upd64031a_g_chip_ident(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);

	return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_UPD64031A, 0);
}

static int upd64031a_log_status(struct v4l2_subdev *sd)
{
	v4l2_info(sd, "Status: SA00=0x%02x SA01=0x%02x\n",
			upd64031a_read(sd, 0), upd64031a_read(sd, 1));
	return 0;
}

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

	if (!v4l2_chip_match_i2c_client(client, &reg->match))
		return -EINVAL;
	if (!capable(CAP_SYS_ADMIN))
		return -EPERM;
	reg->val = upd64031a_read(sd, reg->reg & 0xff);
	reg->size = 1;
	return 0;
}

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

	if (!v4l2_chip_match_i2c_client(client, &reg->match))
		return -EINVAL;
	if (!capable(CAP_SYS_ADMIN))
		return -EPERM;
	upd64031a_write(sd, reg->reg & 0xff, reg->val & 0xff);
	return 0;
}
#endif

static int upd64031a_command(struct i2c_client *client, unsigned cmd, void *arg)
{
	return v4l2_subdev_command(i2c_get_clientdata(client), cmd, arg);
}

/* ----------------------------------------------------------------------- */

static const struct v4l2_subdev_core_ops upd64031a_core_ops = {
	.log_status = upd64031a_log_status,
	.g_chip_ident = upd64031a_g_chip_ident,
#ifdef CONFIG_VIDEO_ADV_DEBUG
	.g_register = upd64031a_g_register,
	.s_register = upd64031a_s_register,
#endif
};

static const struct v4l2_subdev_tuner_ops upd64031a_tuner_ops = {
	.s_frequency = upd64031a_s_frequency,
};

static const struct v4l2_subdev_video_ops upd64031a_video_ops = {
	.s_routing = upd64031a_s_routing,
};

static const struct v4l2_subdev_ops upd64031a_ops = {
	.core = &upd64031a_core_ops,
	.tuner = &upd64031a_tuner_ops,
	.video = &upd64031a_video_ops,
};

/* ------------------------------------------------------------------------ */

/* i2c implementation */

static int upd64031a_probe(struct i2c_client *client,
			   const struct i2c_device_id *id)
{
	struct upd64031a_state *state;
	struct v4l2_subdev *sd;
	int i;

	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
		return -EIO;

	v4l_info(client, "chip found @ 0x%x (%s)\n",
			client->addr << 1, client->adapter->name);

	state = kmalloc(sizeof(struct upd64031a_state), GFP_KERNEL);
	if (state == NULL)
		return -ENOMEM;
	sd = &state->sd;
	v4l2_i2c_subdev_init(sd, client, &upd64031a_ops);
	memcpy(state->regs, upd64031a_init, sizeof(state->regs));
	state->gr_mode = UPD64031A_GR_ON << 6;
	state->direct_3dycs_connect = UPD64031A_3DYCS_COMPOSITE << 4;
	state->ext_comp_sync = state->ext_vert_sync = 0;
	for (i = 0; i < TOT_REGS; i++)
		upd64031a_write(sd, i, state->regs[i]);
	return 0;
}

static int upd64031a_remove(struct i2c_client *client)
{
	struct v4l2_subdev *sd = i2c_get_clientdata(client);

	v4l2_device_unregister_subdev(sd);
	kfree(to_state(sd));
	return 0;
}

/* ----------------------------------------------------------------------- */

static const struct i2c_device_id upd64031a_id[] = {
	{ "upd64031a", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, upd64031a_id);

static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	.name = "upd64031a",
	.driverid = I2C_DRIVERID_UPD64031A,
	.command = upd64031a_command,
	.probe = upd64031a_probe,
	.remove = upd64031a_remove,
	.id_table = upd64031a_id,
};
Commit	Line	Data
add953ce HV	1	/*
	2	* upd64031A - NEC Electronics Ghost Reduction for NTSC in Japan
	3	*
	4	* 2003 by T.Adachi <tadachi@tadachi-net.com>
	5	* 2003 by Takeru KOMORIYA <komoriya@paken.org>
	6	* 2006 by Hans Verkuil <hverkuil@xs4all.nl>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
	23
	24	#include <linux/version.h>
	25	#include <linux/module.h>
	26	#include <linux/kernel.h>
	27	#include <linux/i2c.h>
	28	#include <linux/videodev2.h>
09abd506	29	#include <media/v4l2-device.h>
74cab31c	30	#include <media/v4l2-chip-ident.h>
f69d419a	31	#include <media/v4l2-i2c-drv.h>
add953ce HV	32	#include <media/upd64031a.h>
add953ce HV	33
79f998a7	34	/* --------------------- read registers functions define -------------------- */
add953ce HV	35
	36	/* bit masks */
	37	#define GR_MODE_MASK 0xc0
	38	#define DIRECT_3DYCS_CONNECT_MASK 0xc0
	39	#define SYNC_CIRCUIT_MASK 0xa0
	40
79f998a7	41	/* -------------------------------------------------------------------------- */
add953ce HV	42
	43	MODULE_DESCRIPTION("uPD64031A driver");
	44	MODULE_AUTHOR("T. Adachi, Takeru KOMORIYA, Hans Verkuil");
	45	MODULE_LICENSE("GPL");
	46
79f998a7	47	static int debug;
add953ce HV	48	module_param(debug, int, 0644);
	49
	50	MODULE_PARM_DESC(debug, "Debug level (0-1)");
	51
add953ce HV	52
	53	enum {
	54	R00 = 0, R01, R02, R03, R04,
	55	R05, R06, R07, R08, R09,
	56	R0A, R0B, R0C, R0D, R0E, R0F,
	57	/* unused registers
	58	R10, R11, R12, R13, R14,
	59	R15, R16, R17,
	60	*/
	61	TOT_REGS
	62	};
	63
	64	struct upd64031a_state {
09abd506	65	struct v4l2_subdev sd;
add953ce HV	66	u8 regs[TOT_REGS];
	67	u8 gr_mode;
	68	u8 direct_3dycs_connect;
	69	u8 ext_comp_sync;
	70	u8 ext_vert_sync;
	71	};
	72
09abd506 HV	73	static inline struct upd64031a_state to_state(struct v4l2_subdev sd)
	74	{
	75	return container_of(sd, struct upd64031a_state, sd);
	76	}
	77
add953ce HV	78	static u8 upd64031a_init[] = {
	79	0x00, 0xb8, 0x48, 0xd2, 0xe6,
	80	0x03, 0x10, 0x0b, 0xaf, 0x7f,
	81	0x00, 0x00, 0x1d, 0x5e, 0x00,
	82	0xd0
	83	};
	84
	85	/* ------------------------------------------------------------------------ */
	86
09abd506	87	static u8 upd64031a_read(struct v4l2_subdev *sd, u8 reg)
add953ce	88	{
09abd506	89	struct i2c_client *client = v4l2_get_subdevdata(sd);
add953ce HV	90	u8 buf[2];
	91
	92	if (reg >= sizeof(buf))
	93	return 0xff;
	94	i2c_master_recv(client, buf, 2);
	95	return buf[reg];
	96	}
	97
	98	/* ------------------------------------------------------------------------ */
	99
09abd506	100	static void upd64031a_write(struct v4l2_subdev *sd, u8 reg, u8 val)
add953ce	101	{
09abd506	102	struct i2c_client *client = v4l2_get_subdevdata(sd);
add953ce HV	103	u8 buf[2];
	104
	105	buf[0] = reg;
	106	buf[1] = val;
09abd506	107	v4l2_dbg(1, debug, sd, "write reg: %02X val: %02X\n", reg, val);
add953ce	108	if (i2c_master_send(client, buf, 2) != 2)
09abd506	109	v4l2_err(sd, "I/O error write 0x%02x/0x%02x\n", reg, val);
add953ce HV	110	}
	111
	112	/* ------------------------------------------------------------------------ */
	113
	114	/* The input changed due to new input or channel changed */
09abd506	115	static int upd64031a_s_frequency(struct v4l2_subdev sd, struct v4l2_frequency freq)
add953ce	116	{
09abd506	117	struct upd64031a_state *state = to_state(sd);
add953ce HV	118	u8 reg = state->regs[R00];
add953ce HV	119
09abd506 HV	120	v4l2_dbg(1, debug, sd, "changed input or channel\n");
	121	upd64031a_write(sd, R00, reg \| 0x10);
	122	upd64031a_write(sd, R00, reg & ~0x10);
	123	return 0;
add953ce HV	124	}
	125
	126	/* ------------------------------------------------------------------------ */
	127
09abd506 HV	128	static int upd64031a_s_routing(struct v4l2_subdev sd, const struct v4l2_routing route)
	129	{
	130	struct upd64031a_state *state = to_state(sd);
	131	u8 r00, r05, r08;
	132
	133	state->gr_mode = (route->input & 3) << 6;
	134	state->direct_3dycs_connect = (route->input & 0xc) << 4;
	135	state->ext_comp_sync =
	136	(route->input & UPD64031A_COMPOSITE_EXTERNAL) << 1;
	137	state->ext_vert_sync =
	138	(route->input & UPD64031A_VERTICAL_EXTERNAL) << 2;
	139	r00 = (state->regs[R00] & ~GR_MODE_MASK) \| state->gr_mode;
	140	r05 = (state->regs[R00] & ~SYNC_CIRCUIT_MASK) \|
	141	state->ext_comp_sync \| state->ext_vert_sync;
	142	r08 = (state->regs[R08] & ~DIRECT_3DYCS_CONNECT_MASK) \|
	143	state->direct_3dycs_connect;
	144	upd64031a_write(sd, R00, r00);
	145	upd64031a_write(sd, R05, r05);
	146	upd64031a_write(sd, R08, r08);
	147	return upd64031a_s_frequency(sd, NULL);
	148	}
	149
aecde8b5	150	static int upd64031a_g_chip_ident(struct v4l2_subdev sd, struct v4l2_dbg_chip_ident chip)
09abd506 HV	151	{
	152	struct i2c_client *client = v4l2_get_subdevdata(sd);
	153
	154	return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_UPD64031A, 0);
	155	}
	156
	157	static int upd64031a_log_status(struct v4l2_subdev *sd)
	158	{
	159	v4l2_info(sd, "Status: SA00=0x%02x SA01=0x%02x\n",
	160	upd64031a_read(sd, 0), upd64031a_read(sd, 1));
	161	return 0;
	162	}
	163
	164	#ifdef CONFIG_VIDEO_ADV_DEBUG
aecde8b5	165	static int upd64031a_g_register(struct v4l2_subdev sd, struct v4l2_dbg_register reg)
09abd506 HV	166	{
	167	struct i2c_client *client = v4l2_get_subdevdata(sd);
	168
aecde8b5	169	if (!v4l2_chip_match_i2c_client(client, &reg->match))
09abd506 HV	170	return -EINVAL;
	171	if (!capable(CAP_SYS_ADMIN))
	172	return -EPERM;
	173	reg->val = upd64031a_read(sd, reg->reg & 0xff);
aecde8b5	174	reg->size = 1;
09abd506 HV	175	return 0;
	176	}
	177
aecde8b5	178	static int upd64031a_s_register(struct v4l2_subdev sd, struct v4l2_dbg_register reg)
09abd506 HV	179	{
	180	struct i2c_client *client = v4l2_get_subdevdata(sd);
	181
aecde8b5	182	if (!v4l2_chip_match_i2c_client(client, &reg->match))
09abd506 HV	183	return -EINVAL;
	184	if (!capable(CAP_SYS_ADMIN))
	185	return -EPERM;
	186	upd64031a_write(sd, reg->reg & 0xff, reg->val & 0xff);
	187	return 0;
	188	}
	189	#endif
	190
79f998a7	191	static int upd64031a_command(struct i2c_client client, unsigned cmd, void arg)
add953ce	192	{
09abd506 HV	193	return v4l2_subdev_command(i2c_get_clientdata(client), cmd, arg);
	194	}
	195
	196	/* ----------------------------------------------------------------------- */
add953ce	197
09abd506 HV	198	static const struct v4l2_subdev_core_ops upd64031a_core_ops = {
	199	.log_status = upd64031a_log_status,
	200	.g_chip_ident = upd64031a_g_chip_ident,
add953ce	201	#ifdef CONFIG_VIDEO_ADV_DEBUG
09abd506 HV	202	.g_register = upd64031a_g_register,
09abd506 HV	203	.s_register = upd64031a_s_register,
add953ce	204	#endif
09abd506	205	};
add953ce	206
09abd506 HV	207	static const struct v4l2_subdev_tuner_ops upd64031a_tuner_ops = {
	208	.s_frequency = upd64031a_s_frequency,
	209	};
74cab31c	210
09abd506 HV	211	static const struct v4l2_subdev_video_ops upd64031a_video_ops = {
	212	.s_routing = upd64031a_s_routing,
	213	};
	214
	215	static const struct v4l2_subdev_ops upd64031a_ops = {
	216	.core = &upd64031a_core_ops,
	217	.tuner = &upd64031a_tuner_ops,
	218	.video = &upd64031a_video_ops,
	219	};
add953ce HV	220
	221	/* ------------------------------------------------------------------------ */
	222
	223	/* i2c implementation */
	224
d2653e92 JD	225	static int upd64031a_probe(struct i2c_client *client,
d2653e92 JD	226	const struct i2c_device_id *id)
add953ce	227	{
add953ce	228	struct upd64031a_state *state;
09abd506	229	struct v4l2_subdev *sd;
add953ce HV	230	int i;
add953ce HV	231
2b14e031	232	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
188f3457	233	return -EIO;
add953ce	234
79f998a7 HV	235	v4l_info(client, "chip found @ 0x%x (%s)\n",
79f998a7 HV	236	client->addr << 1, client->adapter->name);
add953ce HV	237
add953ce HV	238	state = kmalloc(sizeof(struct upd64031a_state), GFP_KERNEL);
79f998a7	239	if (state == NULL)
add953ce	240	return -ENOMEM;
09abd506 HV	241	sd = &state->sd;
09abd506 HV	242	v4l2_i2c_subdev_init(sd, client, &upd64031a_ops);
add953ce HV	243	memcpy(state->regs, upd64031a_init, sizeof(state->regs));
	244	state->gr_mode = UPD64031A_GR_ON << 6;
	245	state->direct_3dycs_connect = UPD64031A_3DYCS_COMPOSITE << 4;
	246	state->ext_comp_sync = state->ext_vert_sync = 0;
79f998a7	247	for (i = 0; i < TOT_REGS; i++)
09abd506	248	upd64031a_write(sd, i, state->regs[i]);
add953ce HV	249	return 0;
	250	}
	251
2b14e031	252	static int upd64031a_remove(struct i2c_client *client)
add953ce	253	{
09abd506 HV	254	struct v4l2_subdev *sd = i2c_get_clientdata(client);
	255
	256	v4l2_device_unregister_subdev(sd);
	257	kfree(to_state(sd));
add953ce HV	258	return 0;
	259	}
	260
	261	/* ----------------------------------------------------------------------- */
	262
af294867 JD	263	static const struct i2c_device_id upd64031a_id[] = {
	264	{ "upd64031a", 0 },
	265	{ }
	266	};
	267	MODULE_DEVICE_TABLE(i2c, upd64031a_id);
2b14e031 HV	268
	269	static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	270	.name = "upd64031a",
	271	.driverid = I2C_DRIVERID_UPD64031A,
add953ce	272	.command = upd64031a_command,
2b14e031 HV	273	.probe = upd64031a_probe,
2b14e031 HV	274	.remove = upd64031a_remove,
af294867	275	.id_table = upd64031a_id,
add953ce	276	};