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>
30#include <media/v4l2-chip-ident.h>
31#include <media/upd64031a.h>
32
33// --------------------- read registers functions define -----------------------
34
35/* bit masks */
36#define GR_MODE_MASK              0xc0
37#define DIRECT_3DYCS_CONNECT_MASK 0xc0
38#define SYNC_CIRCUIT_MASK         0xa0
39
40// -----------------------------------------------------------------------------
41
42MODULE_DESCRIPTION("uPD64031A driver");
43MODULE_AUTHOR("T. Adachi, Takeru KOMORIYA, Hans Verkuil");
44MODULE_LICENSE("GPL");
45
46static int debug = 0;
47module_param(debug, int, 0644);
48
49MODULE_PARM_DESC(debug, "Debug level (0-1)");
50
51static unsigned short normal_i2c[] = { 0x24 >> 1, 0x26 >> 1, I2C_CLIENT_END };
52
53
54I2C_CLIENT_INSMOD;
55
56enum {
57	R00 = 0, R01, R02, R03, R04,
58	R05, R06, R07, R08, R09,
59	R0A, R0B, R0C, R0D, R0E, R0F,
60	/* unused registers
61	 R10, R11, R12, R13, R14,
62	 R15, R16, R17,
63	 */
64	TOT_REGS
65};
66
67struct upd64031a_state {
68	u8 regs[TOT_REGS];
69	u8 gr_mode;
70	u8 direct_3dycs_connect;
71	u8 ext_comp_sync;
72	u8 ext_vert_sync;
73};
74
75static u8 upd64031a_init[] = {
76	0x00, 0xb8, 0x48, 0xd2, 0xe6,
77	0x03, 0x10, 0x0b, 0xaf, 0x7f,
78	0x00, 0x00, 0x1d, 0x5e, 0x00,
79	0xd0
80};
81
82/* ------------------------------------------------------------------------ */
83
84static u8 upd64031a_read(struct i2c_client *client, u8 reg)
85{
86	u8 buf[2];
87
88	if (reg >= sizeof(buf))
89		return 0xff;
90	i2c_master_recv(client, buf, 2);
91	return buf[reg];
92}
93
94/* ------------------------------------------------------------------------ */
95
96static void upd64031a_write(struct i2c_client *client, u8 reg, u8 val)
97{
98	u8 buf[2];
99
100	buf[0] = reg;
101	buf[1] = val;
102	v4l_dbg(1, debug, client, "writing reg addr: %02X val: %02X\n", reg, val);
103	if (i2c_master_send(client, buf, 2) != 2)
104		v4l_err(client, "I/O error write 0x%02x/0x%02x\n", reg, val);
105}
106
107/* ------------------------------------------------------------------------ */
108
109/* The input changed due to new input or channel changed */
110static void upd64031a_change(struct i2c_client *client)
111{
112	struct upd64031a_state *state = i2c_get_clientdata(client);
113	u8 reg = state->regs[R00];
114
115	v4l_dbg(1, debug, client, "changed input or channel\n");
116	upd64031a_write(client, R00, reg | 0x10);
117	upd64031a_write(client, R00, reg & ~0x10);
118}
119
120/* ------------------------------------------------------------------------ */
121
122static int upd64031a_command(struct i2c_client *client, unsigned int cmd, void *arg)
123{
124	struct upd64031a_state *state = i2c_get_clientdata(client);
125	struct v4l2_routing *route = arg;
126
127	switch (cmd) {
128	case VIDIOC_S_FREQUENCY:
129		upd64031a_change(client);
130		break;
131
132	case VIDIOC_INT_G_VIDEO_ROUTING:
133		route->input = (state->gr_mode >> 6) |
134			(state->direct_3dycs_connect >> 4) |
135			(state->ext_comp_sync >> 1) |
136			(state->ext_vert_sync >> 2);
137		route->output = 0;
138		break;
139
140	case VIDIOC_INT_S_VIDEO_ROUTING:
141	{
142		u8 r00, r05, r08;
143
144		state->gr_mode = (route->input & 3) << 6;
145		state->direct_3dycs_connect = (route->input & 0xc) << 4;
146		state->ext_comp_sync = (route->input & UPD64031A_COMPOSITE_EXTERNAL) << 1;
147		state->ext_vert_sync = (route->input & UPD64031A_VERTICAL_EXTERNAL) << 2;
148		r00 = (state->regs[R00] & ~GR_MODE_MASK) | state->gr_mode;
149		r05 = (state->regs[R00] & ~SYNC_CIRCUIT_MASK) |
150			state->ext_comp_sync | state->ext_vert_sync;
151		r08 = (state->regs[R08] & ~DIRECT_3DYCS_CONNECT_MASK) |
152			state->direct_3dycs_connect;
153		upd64031a_write(client, R00, r00);
154		upd64031a_write(client, R05, r05);
155		upd64031a_write(client, R08, r08);
156		upd64031a_change(client);
157		break;
158	}
159
160	case VIDIOC_LOG_STATUS:
161		v4l_info(client, "Status: SA00=0x%02x SA01=0x%02x\n",
162			upd64031a_read(client, 0), upd64031a_read(client, 1));
163		break;
164
165#ifdef CONFIG_VIDEO_ADV_DEBUG
166	case VIDIOC_DBG_G_REGISTER:
167	case VIDIOC_DBG_S_REGISTER:
168	{
169		struct v4l2_register *reg = arg;
170
171		if (!v4l2_chip_match_i2c_client(client, reg->match_type, reg->match_chip))
172			return -EINVAL;
173		if (!capable(CAP_SYS_ADMIN))
174			return -EPERM;
175		if (cmd == VIDIOC_DBG_G_REGISTER)
176			reg->val = upd64031a_read(client, reg->reg & 0xff);
177		else
178			upd64031a_write(client, reg->reg & 0xff, reg->val & 0xff);
179		break;
180	}
181#endif
182
183	case VIDIOC_G_CHIP_IDENT:
184		return v4l2_chip_ident_i2c_client(client, arg, V4L2_IDENT_UPD64031A, 0);
185
186	default:
187		break;
188	}
189	return 0;
190}
191
192/* ------------------------------------------------------------------------ */
193
194/* i2c implementation */
195
196static struct i2c_driver i2c_driver;
197
198static int upd64031a_attach(struct i2c_adapter *adapter, int address, int kind)
199{
200	struct i2c_client *client;
201	struct upd64031a_state *state;
202	int i;
203
204	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
205		return 0;
206
207	client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
208	if (client == NULL) {
209		return -ENOMEM;
210	}
211
212	client->addr = address;
213	client->adapter = adapter;
214	client->driver = &i2c_driver;
215	snprintf(client->name, sizeof(client->name) - 1, "uPD64031A");
216
217	v4l_info(client, "chip found @ 0x%x (%s)\n", address << 1, adapter->name);
218
219	state = kmalloc(sizeof(struct upd64031a_state), GFP_KERNEL);
220	if (state == NULL) {
221		kfree(client);
222		return -ENOMEM;
223	}
224	i2c_set_clientdata(client, state);
225	memcpy(state->regs, upd64031a_init, sizeof(state->regs));
226	state->gr_mode = UPD64031A_GR_ON << 6;
227	state->direct_3dycs_connect = UPD64031A_3DYCS_COMPOSITE << 4;
228	state->ext_comp_sync = state->ext_vert_sync = 0;
229	for (i = 0; i < TOT_REGS; i++) {
230		upd64031a_write(client, i, state->regs[i]);
231	}
232
233	i2c_attach_client(client);
234
235	return 0;
236}
237
238static int upd64031a_probe(struct i2c_adapter *adapter)
239{
240	if (adapter->class & I2C_CLASS_TV_ANALOG)
241		return i2c_probe(adapter, &addr_data, upd64031a_attach);
242	return 0;
243}
244
245static int upd64031a_detach(struct i2c_client *client)
246{
247	int err;
248
249	err = i2c_detach_client(client);
250	if (err)
251		return err;
252
253	kfree(client);
254	return 0;
255}
256
257/* ----------------------------------------------------------------------- */
258
259/* i2c implementation */
260static struct i2c_driver i2c_driver = {
261	.driver = {
262		.name = "upd64031a",
263	},
264	.id = I2C_DRIVERID_UPD64031A,
265	.attach_adapter = upd64031a_probe,
266	.detach_client  = upd64031a_detach,
267	.command = upd64031a_command,
268};
269
270
271static int __init upd64031a_init_module(void)
272{
273	return i2c_add_driver(&i2c_driver);
274}
275
276static void __exit upd64031a_exit_module(void)
277{
278	i2c_del_driver(&i2c_driver);
279}
280
281module_init(upd64031a_init_module);
282module_exit(upd64031a_exit_module);
283