[linux-2.6-block.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-common.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 {
	u8 regs[TOT_REGS];
	u8 gr_mode;
	u8 direct_3dycs_connect;
	u8 ext_comp_sync;
	u8 ext_vert_sync;
};

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 i2c_client *client, u8 reg)
{
	u8 buf[2];

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

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

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

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

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

/* The input changed due to new input or channel changed */
static void upd64031a_change(struct i2c_client *client)
{
	struct upd64031a_state *state = i2c_get_clientdata(client);
	u8 reg = state->regs[R00];

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

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

static int upd64031a_command(struct i2c_client *client, unsigned cmd, void *arg)
{
	struct upd64031a_state *state = i2c_get_clientdata(client);
	struct v4l2_routing *route = arg;

	switch (cmd) {
	case VIDIOC_S_FREQUENCY:
		upd64031a_change(client);
		break;

	case VIDIOC_INT_G_VIDEO_ROUTING:
		route->input = (state->gr_mode >> 6) |
			(state->direct_3dycs_connect >> 4) |
			(state->ext_comp_sync >> 1) |
			(state->ext_vert_sync >> 2);
		route->output = 0;
		break;

	case VIDIOC_INT_S_VIDEO_ROUTING:
	{
		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(client, R00, r00);
		upd64031a_write(client, R05, r05);
		upd64031a_write(client, R08, r08);
		upd64031a_change(client);
		break;
	}

	case VIDIOC_LOG_STATUS:
		v4l_info(client, "Status: SA00=0x%02x SA01=0x%02x\n",
			upd64031a_read(client, 0), upd64031a_read(client, 1));
		break;

#ifdef CONFIG_VIDEO_ADV_DEBUG
	case VIDIOC_DBG_G_REGISTER:
	case VIDIOC_DBG_S_REGISTER:
	{
		struct v4l2_register *reg = arg;

		if (!v4l2_chip_match_i2c_client(client,
					reg->match_type, reg->match_chip))
			return -EINVAL;
		if (!capable(CAP_SYS_ADMIN))
			return -EPERM;
		if (cmd == VIDIOC_DBG_G_REGISTER) {
			reg->val = upd64031a_read(client, reg->reg & 0xff);
			break;
		}
		upd64031a_write(client, reg->reg & 0xff, reg->val & 0xff);
		break;
	}
#endif

	case VIDIOC_G_CHIP_IDENT:
		return v4l2_chip_ident_i2c_client(client, arg,
				V4L2_IDENT_UPD64031A, 0);

	default:
		break;
	}
	return 0;
}

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

/* i2c implementation */

static int upd64031a_probe(struct i2c_client *client,
			   const struct i2c_device_id *id)
{
	struct upd64031a_state *state;
	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;
	i2c_set_clientdata(client, state);
	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(client, i, state->regs[i]);
	return 0;
}

static int upd64031a_remove(struct i2c_client *client)
{
	kfree(i2c_get_clientdata(client));
	return 0;
}

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


static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	.name = "upd64031a",
	.driverid = I2C_DRIVERID_UPD64031A,
	.command = upd64031a_command,
	.probe = upd64031a_probe,
	.remove = upd64031a_remove,
};
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>
	29	#include <media/v4l2-common.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 {
	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
	72	static u8 upd64031a_init[] = {
	73	0x00, 0xb8, 0x48, 0xd2, 0xe6,
	74	0x03, 0x10, 0x0b, 0xaf, 0x7f,
	75	0x00, 0x00, 0x1d, 0x5e, 0x00,
	76	0xd0
	77	};
	78
	79	/* ------------------------------------------------------------------------ */
	80
	81	static u8 upd64031a_read(struct i2c_client *client, u8 reg)
	82	{
	83	u8 buf[2];
	84
	85	if (reg >= sizeof(buf))
	86	return 0xff;
	87	i2c_master_recv(client, buf, 2);
	88	return buf[reg];
	89	}
	90
	91	/* ------------------------------------------------------------------------ */
	92
	93	static void upd64031a_write(struct i2c_client *client, u8 reg, u8 val)
	94	{
	95	u8 buf[2];
	96
	97	buf[0] = reg;
	98	buf[1] = val;
79f998a7	99	v4l_dbg(1, debug, client, "write reg: %02X val: %02X\n", reg, val);
add953ce HV	100	if (i2c_master_send(client, buf, 2) != 2)
	101	v4l_err(client, "I/O error write 0x%02x/0x%02x\n", reg, val);
	102	}
	103
	104	/* ------------------------------------------------------------------------ */
	105
	106	/* The input changed due to new input or channel changed */
	107	static void upd64031a_change(struct i2c_client *client)
	108	{
	109	struct upd64031a_state *state = i2c_get_clientdata(client);
	110	u8 reg = state->regs[R00];
	111
	112	v4l_dbg(1, debug, client, "changed input or channel\n");
	113	upd64031a_write(client, R00, reg \| 0x10);
	114	upd64031a_write(client, R00, reg & ~0x10);
	115	}
	116
	117	/* ------------------------------------------------------------------------ */
	118
79f998a7	119	static int upd64031a_command(struct i2c_client client, unsigned cmd, void arg)
add953ce HV	120	{
	121	struct upd64031a_state *state = i2c_get_clientdata(client);
	122	struct v4l2_routing *route = arg;
	123
	124	switch (cmd) {
	125	case VIDIOC_S_FREQUENCY:
	126	upd64031a_change(client);
	127	break;
	128
	129	case VIDIOC_INT_G_VIDEO_ROUTING:
	130	route->input = (state->gr_mode >> 6) \|
	131	(state->direct_3dycs_connect >> 4) \|
	132	(state->ext_comp_sync >> 1) \|
	133	(state->ext_vert_sync >> 2);
	134	route->output = 0;
	135	break;
	136
	137	case VIDIOC_INT_S_VIDEO_ROUTING:
	138	{
	139	u8 r00, r05, r08;
	140
	141	state->gr_mode = (route->input & 3) << 6;
	142	state->direct_3dycs_connect = (route->input & 0xc) << 4;
79f998a7 HV	143	state->ext_comp_sync =
	144	(route->input & UPD64031A_COMPOSITE_EXTERNAL) << 1;
	145	state->ext_vert_sync =
	146	(route->input & UPD64031A_VERTICAL_EXTERNAL) << 2;
add953ce HV	147	r00 = (state->regs[R00] & ~GR_MODE_MASK) \| state->gr_mode;
	148	r05 = (state->regs[R00] & ~SYNC_CIRCUIT_MASK) \|
	149	state->ext_comp_sync \| state->ext_vert_sync;
	150	r08 = (state->regs[R08] & ~DIRECT_3DYCS_CONNECT_MASK) \|
	151	state->direct_3dycs_connect;
	152	upd64031a_write(client, R00, r00);
	153	upd64031a_write(client, R05, r05);
	154	upd64031a_write(client, R08, r08);
	155	upd64031a_change(client);
	156	break;
	157	}
	158
	159	case VIDIOC_LOG_STATUS:
	160	v4l_info(client, "Status: SA00=0x%02x SA01=0x%02x\n",
	161	upd64031a_read(client, 0), upd64031a_read(client, 1));
	162	break;
	163
	164	#ifdef CONFIG_VIDEO_ADV_DEBUG
52ebc763	165	case VIDIOC_DBG_G_REGISTER:
52ebc763	166	case VIDIOC_DBG_S_REGISTER:
add953ce HV	167	{
add953ce HV	168	struct v4l2_register *reg = arg;
add953ce	169
79f998a7 HV	170	if (!v4l2_chip_match_i2c_client(client,
79f998a7 HV	171	reg->match_type, reg->match_chip))
add953ce HV	172	return -EINVAL;
	173	if (!capable(CAP_SYS_ADMIN))
	174	return -EPERM;
79f998a7	175	if (cmd == VIDIOC_DBG_G_REGISTER) {
62d50add	176	reg->val = upd64031a_read(client, reg->reg & 0xff);
79f998a7 HV	177	break;
	178	}
	179	upd64031a_write(client, reg->reg & 0xff, reg->val & 0xff);
add953ce HV	180	break;
	181	}
	182	#endif
	183
74cab31c	184	case VIDIOC_G_CHIP_IDENT:
79f998a7 HV	185	return v4l2_chip_ident_i2c_client(client, arg,
79f998a7 HV	186	V4L2_IDENT_UPD64031A, 0);
74cab31c	187
add953ce HV	188	default:
	189	break;
	190	}
	191	return 0;
	192	}
	193
	194	/* ------------------------------------------------------------------------ */
	195
	196	/* i2c implementation */
	197
d2653e92 JD	198	static int upd64031a_probe(struct i2c_client *client,
d2653e92 JD	199	const struct i2c_device_id *id)
add953ce	200	{
add953ce HV	201	struct upd64031a_state *state;
	202	int i;
	203
2b14e031	204	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
188f3457	205	return -EIO;
add953ce	206
79f998a7 HV	207	v4l_info(client, "chip found @ 0x%x (%s)\n",
79f998a7 HV	208	client->addr << 1, client->adapter->name);
add953ce HV	209
add953ce HV	210	state = kmalloc(sizeof(struct upd64031a_state), GFP_KERNEL);
79f998a7	211	if (state == NULL)
add953ce	212	return -ENOMEM;
add953ce HV	213	i2c_set_clientdata(client, state);
	214	memcpy(state->regs, upd64031a_init, sizeof(state->regs));
	215	state->gr_mode = UPD64031A_GR_ON << 6;
	216	state->direct_3dycs_connect = UPD64031A_3DYCS_COMPOSITE << 4;
	217	state->ext_comp_sync = state->ext_vert_sync = 0;
79f998a7	218	for (i = 0; i < TOT_REGS; i++)
add953ce	219	upd64031a_write(client, i, state->regs[i]);
add953ce HV	220	return 0;
	221	}
	222
2b14e031	223	static int upd64031a_remove(struct i2c_client *client)
add953ce	224	{
2b14e031	225	kfree(i2c_get_clientdata(client));
add953ce HV	226	return 0;
	227	}
	228
	229	/* ----------------------------------------------------------------------- */
	230
2b14e031 HV	231
	232	static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	233	.name = "upd64031a",
	234	.driverid = I2C_DRIVERID_UPD64031A,
add953ce	235	.command = upd64031a_command,
2b14e031 HV	236	.probe = upd64031a_probe,
2b14e031 HV	237	.remove = upd64031a_remove,
add953ce	238	};