bttv-i2c.c revision abb0362f49c361f71b5aa6d244d4847145ed53c1 
1/*
2
3    bttv-i2c.c  --  all the i2c code is here
4
5    bttv - Bt848 frame grabber driver
6
7    Copyright (C) 1996,97,98 Ralph  Metzler (rjkm@thp.uni-koeln.de)
8			   & Marcus Metzler (mocm@thp.uni-koeln.de)
9    (c) 1999-2003 Gerd Knorr <kraxel@bytesex.org>
10
11    (c) 2005 Mauro Carvalho Chehab <mchehab@infradead.org>
12	- Multituner support and i2c address binding
13
14    This program is free software; you can redistribute it and/or modify
15    it under the terms of the GNU General Public License as published by
16    the Free Software Foundation; either version 2 of the License, or
17    (at your option) any later version.
18
19    This program is distributed in the hope that it will be useful,
20    but WITHOUT ANY WARRANTY; without even the implied warranty of
21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22    GNU General Public License for more details.
23
24    You should have received a copy of the GNU General Public License
25    along with this program; if not, write to the Free Software
26    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27
28*/
29
30#include <linux/module.h>
31#include <linux/init.h>
32#include <linux/delay.h>
33
34#include "bttvp.h"
35#include <media/v4l2-common.h>
36#include <linux/jiffies.h>
37#include <asm/io.h>
38
39static int attach_inform(struct i2c_client *client);
40
41static int i2c_debug;
42static int i2c_hw;
43static int i2c_scan;
44module_param(i2c_debug, int, 0644);
45MODULE_PARM_DESC(i2c_hw,"configure i2c debug level");
46module_param(i2c_hw,    int, 0444);
47MODULE_PARM_DESC(i2c_hw,"force use of hardware i2c support, "
48			"instead of software bitbang");
49module_param(i2c_scan,  int, 0444);
50MODULE_PARM_DESC(i2c_scan,"scan i2c bus at insmod time");
51
52static unsigned int i2c_udelay = 5;
53module_param(i2c_udelay, int, 0444);
54MODULE_PARM_DESC(i2c_udelay,"soft i2c delay at insmod time, in usecs "
55		"(should be 5 or higher). Lower value means higher bus speed.");
56
57/* ----------------------------------------------------------------------- */
58/* I2C functions - bitbanging adapter (software i2c)                       */
59
60static void bttv_bit_setscl(void *data, int state)
61{
62	struct bttv *btv = (struct bttv*)data;
63
64	if (state)
65		btv->i2c_state |= 0x02;
66	else
67		btv->i2c_state &= ~0x02;
68	btwrite(btv->i2c_state, BT848_I2C);
69	btread(BT848_I2C);
70}
71
72static void bttv_bit_setsda(void *data, int state)
73{
74	struct bttv *btv = (struct bttv*)data;
75
76	if (state)
77		btv->i2c_state |= 0x01;
78	else
79		btv->i2c_state &= ~0x01;
80	btwrite(btv->i2c_state, BT848_I2C);
81	btread(BT848_I2C);
82}
83
84static int bttv_bit_getscl(void *data)
85{
86	struct bttv *btv = (struct bttv*)data;
87	int state;
88
89	state = btread(BT848_I2C) & 0x02 ? 1 : 0;
90	return state;
91}
92
93static int bttv_bit_getsda(void *data)
94{
95	struct bttv *btv = (struct bttv*)data;
96	int state;
97
98	state = btread(BT848_I2C) & 0x01;
99	return state;
100}
101
102static struct i2c_algo_bit_data __devinitdata bttv_i2c_algo_bit_template = {
103	.setsda  = bttv_bit_setsda,
104	.setscl  = bttv_bit_setscl,
105	.getsda  = bttv_bit_getsda,
106	.getscl  = bttv_bit_getscl,
107	.udelay  = 16,
108	.timeout = 200,
109};
110
111/* ----------------------------------------------------------------------- */
112/* I2C functions - hardware i2c                                            */
113
114static u32 functionality(struct i2c_adapter *adap)
115{
116	return I2C_FUNC_SMBUS_EMUL;
117}
118
119static int
120bttv_i2c_wait_done(struct bttv *btv)
121{
122	int rc = 0;
123
124	/* timeout */
125	if (wait_event_interruptible_timeout(btv->i2c_queue,
126		btv->i2c_done, msecs_to_jiffies(85)) == -ERESTARTSYS)
127
128	rc = -EIO;
129
130	if (btv->i2c_done & BT848_INT_RACK)
131		rc = 1;
132	btv->i2c_done = 0;
133	return rc;
134}
135
136#define I2C_HW (BT878_I2C_MODE  | BT848_I2C_SYNC |\
137		BT848_I2C_SCL | BT848_I2C_SDA)
138
139static int
140bttv_i2c_sendbytes(struct bttv *btv, const struct i2c_msg *msg, int last)
141{
142	u32 xmit;
143	int retval,cnt;
144
145	/* sanity checks */
146	if (0 == msg->len)
147		return -EINVAL;
148
149	/* start, address + first byte */
150	xmit = (msg->addr << 25) | (msg->buf[0] << 16) | I2C_HW;
151	if (msg->len > 1 || !last)
152		xmit |= BT878_I2C_NOSTOP;
153	btwrite(xmit, BT848_I2C);
154	retval = bttv_i2c_wait_done(btv);
155	if (retval < 0)
156		goto err;
157	if (retval == 0)
158		goto eio;
159	if (i2c_debug) {
160		printk(" <W %02x %02x", msg->addr << 1, msg->buf[0]);
161		if (!(xmit & BT878_I2C_NOSTOP))
162			printk(" >\n");
163	}
164
165	for (cnt = 1; cnt < msg->len; cnt++ ) {
166		/* following bytes */
167		xmit = (msg->buf[cnt] << 24) | I2C_HW | BT878_I2C_NOSTART;
168		if (cnt < msg->len-1 || !last)
169			xmit |= BT878_I2C_NOSTOP;
170		btwrite(xmit, BT848_I2C);
171		retval = bttv_i2c_wait_done(btv);
172		if (retval < 0)
173			goto err;
174		if (retval == 0)
175			goto eio;
176		if (i2c_debug) {
177			printk(" %02x", msg->buf[cnt]);
178			if (!(xmit & BT878_I2C_NOSTOP))
179				printk(" >\n");
180		}
181	}
182	return msg->len;
183
184 eio:
185	retval = -EIO;
186 err:
187	if (i2c_debug)
188		printk(" ERR: %d\n",retval);
189	return retval;
190}
191
192static int
193bttv_i2c_readbytes(struct bttv *btv, const struct i2c_msg *msg, int last)
194{
195	u32 xmit;
196	u32 cnt;
197	int retval;
198
199	for(cnt = 0; cnt < msg->len; cnt++) {
200		xmit = (msg->addr << 25) | (1 << 24) | I2C_HW;
201		if (cnt < msg->len-1)
202			xmit |= BT848_I2C_W3B;
203		if (cnt < msg->len-1 || !last)
204			xmit |= BT878_I2C_NOSTOP;
205		if (cnt)
206			xmit |= BT878_I2C_NOSTART;
207		btwrite(xmit, BT848_I2C);
208		retval = bttv_i2c_wait_done(btv);
209		if (retval < 0)
210			goto err;
211		if (retval == 0)
212			goto eio;
213		msg->buf[cnt] = ((u32)btread(BT848_I2C) >> 8) & 0xff;
214		if (i2c_debug) {
215			if (!(xmit & BT878_I2C_NOSTART))
216				printk(" <R %02x", (msg->addr << 1) +1);
217			printk(" =%02x", msg->buf[cnt]);
218			if (!(xmit & BT878_I2C_NOSTOP))
219				printk(" >\n");
220		}
221	}
222	return msg->len;
223
224 eio:
225	retval = -EIO;
226 err:
227	if (i2c_debug)
228		printk(" ERR: %d\n",retval);
229	return retval;
230}
231
232static int bttv_i2c_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg *msgs, int num)
233{
234	struct bttv *btv = i2c_get_adapdata(i2c_adap);
235	int retval = 0;
236	int i;
237
238	if (i2c_debug)
239		printk("bt-i2c:");
240	btwrite(BT848_INT_I2CDONE|BT848_INT_RACK, BT848_INT_STAT);
241	for (i = 0 ; i < num; i++) {
242		if (msgs[i].flags & I2C_M_RD) {
243			/* read */
244			retval = bttv_i2c_readbytes(btv, &msgs[i], i+1 == num);
245			if (retval < 0)
246				goto err;
247		} else {
248			/* write */
249			retval = bttv_i2c_sendbytes(btv, &msgs[i], i+1 == num);
250			if (retval < 0)
251				goto err;
252		}
253	}
254	return num;
255
256 err:
257	return retval;
258}
259
260static const struct i2c_algorithm bttv_algo = {
261	.master_xfer   = bttv_i2c_xfer,
262	.functionality = functionality,
263};
264
265/* ----------------------------------------------------------------------- */
266/* I2C functions - common stuff                                            */
267
268static int attach_inform(struct i2c_client *client)
269{
270	struct bttv *btv = i2c_get_adapdata(client->adapter);
271	int addr=ADDR_UNSET;
272
273
274	if (ADDR_UNSET != bttv_tvcards[btv->c.type].tuner_addr)
275		addr = bttv_tvcards[btv->c.type].tuner_addr;
276
277
278	if (bttv_debug)
279		printk(KERN_DEBUG "bttv%d: %s i2c attach [addr=0x%x,client=%s]\n",
280			btv->c.nr, client->driver->driver.name, client->addr,
281			client->name);
282	if (!client->driver->command)
283		return 0;
284
285	if (client->driver->id == I2C_DRIVERID_MSP3400)
286		btv->i2c_msp34xx_client = client;
287	if (client->driver->id == I2C_DRIVERID_TVAUDIO)
288		btv->i2c_tvaudio_client = client;
289	if (btv->tuner_type != TUNER_ABSENT) {
290		struct tuner_setup tun_setup;
291
292		if (addr == ADDR_UNSET || addr == client->addr) {
293			tun_setup.mode_mask = T_ANALOG_TV | T_DIGITAL_TV | T_RADIO;
294			tun_setup.type = btv->tuner_type;
295			tun_setup.addr = addr;
296			bttv_call_i2c_clients(btv, TUNER_SET_TYPE_ADDR, &tun_setup);
297		}
298
299	}
300
301	return 0;
302}
303
304void bttv_call_i2c_clients(struct bttv *btv, unsigned int cmd, void *arg)
305{
306	if (0 != btv->i2c_rc)
307		return;
308	i2c_clients_command(&btv->c.i2c_adap, cmd, arg);
309}
310
311
312/* read I2C */
313int bttv_I2CRead(struct bttv *btv, unsigned char addr, char *probe_for)
314{
315	unsigned char buffer = 0;
316
317	if (0 != btv->i2c_rc)
318		return -1;
319	if (bttv_verbose && NULL != probe_for)
320		printk(KERN_INFO "bttv%d: i2c: checking for %s @ 0x%02x... ",
321		       btv->c.nr,probe_for,addr);
322	btv->i2c_client.addr = addr >> 1;
323	if (1 != i2c_master_recv(&btv->i2c_client, &buffer, 1)) {
324		if (NULL != probe_for) {
325			if (bttv_verbose)
326				printk("not found\n");
327		} else
328			printk(KERN_WARNING "bttv%d: i2c read 0x%x: error\n",
329			       btv->c.nr,addr);
330		return -1;
331	}
332	if (bttv_verbose && NULL != probe_for)
333		printk("found\n");
334	return buffer;
335}
336
337/* write I2C */
338int bttv_I2CWrite(struct bttv *btv, unsigned char addr, unsigned char b1,
339		    unsigned char b2, int both)
340{
341	unsigned char buffer[2];
342	int bytes = both ? 2 : 1;
343
344	if (0 != btv->i2c_rc)
345		return -1;
346	btv->i2c_client.addr = addr >> 1;
347	buffer[0] = b1;
348	buffer[1] = b2;
349	if (bytes != i2c_master_send(&btv->i2c_client, buffer, bytes))
350		return -1;
351	return 0;
352}
353
354/* read EEPROM content */
355void __devinit bttv_readee(struct bttv *btv, unsigned char *eedata, int addr)
356{
357	memset(eedata, 0, 256);
358	if (0 != btv->i2c_rc)
359		return;
360	btv->i2c_client.addr = addr >> 1;
361	tveeprom_read(&btv->i2c_client, eedata, 256);
362}
363
364static char *i2c_devs[128] = {
365	[ 0x1c >> 1 ] = "lgdt330x",
366	[ 0x30 >> 1 ] = "IR (hauppauge)",
367	[ 0x80 >> 1 ] = "msp34xx",
368	[ 0x86 >> 1 ] = "tda9887",
369	[ 0xa0 >> 1 ] = "eeprom",
370	[ 0xc0 >> 1 ] = "tuner (analog)",
371	[ 0xc2 >> 1 ] = "tuner (analog)",
372};
373
374static void do_i2c_scan(char *name, struct i2c_client *c)
375{
376	unsigned char buf;
377	int i,rc;
378
379	for (i = 0; i < ARRAY_SIZE(i2c_devs); i++) {
380		c->addr = i;
381		rc = i2c_master_recv(c,&buf,0);
382		if (rc < 0)
383			continue;
384		printk("%s: i2c scan: found device @ 0x%x  [%s]\n",
385		       name, i << 1, i2c_devs[i] ? i2c_devs[i] : "???");
386	}
387}
388
389/* init + register i2c algo-bit adapter */
390int __devinit init_bttv_i2c(struct bttv *btv)
391{
392	strlcpy(btv->i2c_client.name, "bttv internal", I2C_NAME_SIZE);
393
394	if (i2c_hw)
395		btv->use_i2c_hw = 1;
396	if (btv->use_i2c_hw) {
397		/* bt878 */
398		strlcpy(btv->c.i2c_adap.name, "bt878",
399			sizeof(btv->c.i2c_adap.name));
400		btv->c.i2c_adap.id = I2C_HW_B_BT848;	/* FIXME */
401		btv->c.i2c_adap.algo = &bttv_algo;
402	} else {
403		/* bt848 */
404	/* Prevents usage of invalid delay values */
405		if (i2c_udelay<5)
406			i2c_udelay=5;
407
408		strlcpy(btv->c.i2c_adap.name, "bttv",
409			sizeof(btv->c.i2c_adap.name));
410		btv->c.i2c_adap.id = I2C_HW_B_BT848;
411		memcpy(&btv->i2c_algo, &bttv_i2c_algo_bit_template,
412		       sizeof(bttv_i2c_algo_bit_template));
413		btv->i2c_algo.udelay = i2c_udelay;
414		btv->i2c_algo.data = btv;
415		btv->c.i2c_adap.algo_data = &btv->i2c_algo;
416	}
417	btv->c.i2c_adap.owner = THIS_MODULE;
418	btv->c.i2c_adap.class = I2C_CLASS_TV_ANALOG;
419	btv->c.i2c_adap.client_register = attach_inform;
420
421	btv->c.i2c_adap.dev.parent = &btv->c.pci->dev;
422	snprintf(btv->c.i2c_adap.name, sizeof(btv->c.i2c_adap.name),
423		 "bt%d #%d [%s]", btv->id, btv->c.nr,
424		 btv->use_i2c_hw ? "hw" : "sw");
425
426	i2c_set_adapdata(&btv->c.i2c_adap, btv);
427	btv->i2c_client.adapter = &btv->c.i2c_adap;
428
429	if (bttv_tvcards[btv->c.type].no_video)
430		btv->c.i2c_adap.class &= ~I2C_CLASS_TV_ANALOG;
431	if (bttv_tvcards[btv->c.type].has_dvb)
432		btv->c.i2c_adap.class |= I2C_CLASS_TV_DIGITAL;
433
434	if (btv->use_i2c_hw) {
435		btv->i2c_rc = i2c_add_adapter(&btv->c.i2c_adap);
436	} else {
437		bttv_bit_setscl(btv,1);
438		bttv_bit_setsda(btv,1);
439		btv->i2c_rc = i2c_bit_add_bus(&btv->c.i2c_adap);
440	}
441	if (0 == btv->i2c_rc && i2c_scan)
442		do_i2c_scan(btv->c.name,&btv->i2c_client);
443	return btv->i2c_rc;
444}
445
446int __devexit fini_bttv_i2c(struct bttv *btv)
447{
448	if (0 != btv->i2c_rc)
449		return 0;
450
451	return i2c_del_adapter(&btv->c.i2c_adap);
452}
453
454/*
455 * Local variables:
456 * c-basic-offset: 8
457 * End:
458 */
459