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