1/*
2 * upd6408x - NEC Electronics 3-Dimensional Y/C separation driver
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
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 */
22
23#include <linux/version.h>
24#include <linux/module.h>
25#include <linux/kernel.h>
26#include <linux/i2c.h>
27#include <linux/videodev2.h>
28#include <media/v4l2-common.h>
29#include <media/v4l2-chip-ident.h>
30#include <media/upd64083.h>
31
32MODULE_DESCRIPTION("uPD64083 driver");
33MODULE_AUTHOR("T. Adachi, Takeru KOMORIYA, Hans Verkuil");
34MODULE_LICENSE("GPL");
35
36static int debug = 0;
37module_param(debug, bool, 0644);
38
39MODULE_PARM_DESC(debug, "Debug level (0-1)");
40
41static unsigned short normal_i2c[] = { 0xb8 >> 1, 0xba >> 1, I2C_CLIENT_END };
42
43
44I2C_CLIENT_INSMOD;
45
46enum {
47	R00 = 0, R01, R02, R03, R04,
48	R05, R06, R07, R08, R09,
49	R0A, R0B, R0C, R0D, R0E, R0F,
50	R10, R11, R12, R13, R14,
51	R15, R16,
52	TOT_REGS
53};
54
55struct upd64083_state {
56	u8 mode;
57	u8 ext_y_adc;
58	u8 regs[TOT_REGS];
59};
60
61/* Initial values when used in combination with the
62   NEC upd64031a ghost reduction chip. */
63static u8 upd64083_init[] = {
64	0x1f, 0x01, 0xa0, 0x2d, 0x29,  /* we use EXCSS=0 */
65	0x36, 0xdd, 0x05, 0x56, 0x48,
66	0x00, 0x3a, 0xa0, 0x05, 0x08,
67	0x44, 0x60, 0x08, 0x52, 0xf8,
68	0x53, 0x60, 0x10
69};
70
71/* ------------------------------------------------------------------------ */
72
73static void upd64083_log_status(struct i2c_client *client)
74{
75	u8 buf[7];
76
77	i2c_master_recv(client, buf, 7);
78	v4l_info(client, "Status: SA00=%02x SA01=%02x SA02=%02x SA03=%02x "
79		      "SA04=%02x SA05=%02x SA06=%02x\n",
80		buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
81}
82
83/* ------------------------------------------------------------------------ */
84
85static void upd64083_write(struct i2c_client *client, u8 reg, u8 val)
86{
87	u8 buf[2];
88
89	buf[0] = reg;
90	buf[1] = val;
91	v4l_dbg(1, debug, client, "writing reg addr: %02x val: %02x\n", reg, val);
92	if (i2c_master_send(client, buf, 2) != 2)
93		v4l_err(client, "I/O error write 0x%02x/0x%02x\n", reg, val);
94}
95
96/* ------------------------------------------------------------------------ */
97
98#ifdef CONFIG_VIDEO_ADV_DEBUG
99static u8 upd64083_read(struct i2c_client *client, u8 reg)
100{
101	u8 buf[7];
102
103	if (reg >= sizeof(buf))
104		return 0xff;
105	i2c_master_recv(client, buf, sizeof(buf));
106	return buf[reg];
107}
108#endif
109
110/* ------------------------------------------------------------------------ */
111
112static int upd64083_command(struct i2c_client *client, unsigned int cmd, void *arg)
113{
114	struct upd64083_state *state = i2c_get_clientdata(client);
115	struct v4l2_routing *route = arg;
116
117	switch (cmd) {
118	case VIDIOC_INT_G_VIDEO_ROUTING:
119		route->input = (state->mode >> 6) | (state->ext_y_adc >> 3);
120		route->output = 0;
121		break;
122
123	case VIDIOC_INT_S_VIDEO_ROUTING:
124	{
125		u8 r00, r02;
126
127		if (route->input > 7 || (route->input & 6) == 6)
128			return -EINVAL;
129		state->mode = (route->input & 3) << 6;
130		state->ext_y_adc = (route->input & UPD64083_EXT_Y_ADC) << 3;
131		r00 = (state->regs[R00] & ~(3 << 6)) | state->mode;
132		r02 = (state->regs[R02] & ~(1 << 5)) | state->ext_y_adc;
133		upd64083_write(client, R00, r00);
134		upd64083_write(client, R02, r02);
135		break;
136	}
137
138	case VIDIOC_LOG_STATUS:
139		upd64083_log_status(client);
140		break;
141
142#ifdef CONFIG_VIDEO_ADV_DEBUG
143	case VIDIOC_DBG_G_REGISTER:
144	case VIDIOC_DBG_S_REGISTER:
145	{
146		struct v4l2_register *reg = arg;
147
148		if (!v4l2_chip_match_i2c_client(client, reg->match_type, reg->match_chip))
149			return -EINVAL;
150		if (!capable(CAP_SYS_ADMIN))
151			return -EPERM;
152		if (cmd == VIDIOC_DBG_G_REGISTER)
153			reg->val = upd64083_read(client, reg->reg & 0xff);
154		else
155			upd64083_write(client, reg->reg & 0xff, reg->val & 0xff);
156		break;
157	}
158#endif
159
160	case VIDIOC_G_CHIP_IDENT:
161		return v4l2_chip_ident_i2c_client(client, arg, V4L2_IDENT_UPD64083, 0);
162
163	default:
164		break;
165	}
166
167	return 0;
168}
169
170/* ------------------------------------------------------------------------ */
171
172/* i2c implementation */
173
174static struct i2c_driver i2c_driver;
175
176static int upd64083_attach(struct i2c_adapter *adapter, int address, int kind)
177{
178	struct i2c_client *client;
179	struct upd64083_state *state;
180	int i;
181
182	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
183		return 0;
184
185	client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
186	if (client == NULL) {
187		return -ENOMEM;
188	}
189
190	client->addr = address;
191	client->adapter = adapter;
192	client->driver = &i2c_driver;
193	snprintf(client->name, sizeof(client->name) - 1, "uPD64083");
194
195	v4l_info(client, "chip found @ 0x%x (%s)\n", address << 1, adapter->name);
196
197	state = kmalloc(sizeof(struct upd64083_state), GFP_KERNEL);
198	if (state == NULL) {
199		kfree(client);
200		return -ENOMEM;
201	}
202	i2c_set_clientdata(client, state);
203	/* Initially assume that a ghost reduction chip is present */
204	state->mode = 0;  /* YCS mode */
205	state->ext_y_adc = (1 << 5);
206	memcpy(state->regs, upd64083_init, TOT_REGS);
207	for (i = 0; i < TOT_REGS; i++) {
208		upd64083_write(client, i, state->regs[i]);
209	}
210	i2c_attach_client(client);
211
212	return 0;
213}
214
215static int upd64083_probe(struct i2c_adapter *adapter)
216{
217	if (adapter->class & I2C_CLASS_TV_ANALOG)
218		return i2c_probe(adapter, &addr_data, upd64083_attach);
219	return 0;
220}
221
222static int upd64083_detach(struct i2c_client *client)
223{
224	int err;
225
226	err = i2c_detach_client(client);
227	if (err)
228		return err;
229
230	kfree(client);
231	return 0;
232}
233
234/* ----------------------------------------------------------------------- */
235
236/* i2c implementation */
237static struct i2c_driver i2c_driver = {
238	.driver = {
239		.name = "upd64083",
240	},
241	.id = I2C_DRIVERID_UPD64083,
242	.attach_adapter = upd64083_probe,
243	.detach_client  = upd64083_detach,
244	.command = upd64083_command,
245};
246
247
248static int __init upd64083_init_module(void)
249{
250	return i2c_add_driver(&i2c_driver);
251}
252
253static void __exit upd64083_exit_module(void)
254{
255	i2c_del_driver(&i2c_driver);
256}
257
258module_init(upd64083_init_module);
259module_exit(upd64083_exit_module);
260