xref: /OK3568_Linux_fs/kernel/drivers/media/usb/tm6000/tm6000-i2c.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun // tm6000-i2c.c - driver for TM5600/TM6000/TM6010 USB video capture devices
3*4882a593Smuzhiyun //
4*4882a593Smuzhiyun // Copyright (c) 2006-2007 Mauro Carvalho Chehab <mchehab@kernel.org>
5*4882a593Smuzhiyun //
6*4882a593Smuzhiyun // Copyright (c) 2007 Michel Ludwig <michel.ludwig@gmail.com>
7*4882a593Smuzhiyun //	- Fix SMBus Read Byte command
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/module.h>
10*4882a593Smuzhiyun #include <linux/kernel.h>
11*4882a593Smuzhiyun #include <linux/usb.h>
12*4882a593Smuzhiyun #include <linux/i2c.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include "tm6000.h"
15*4882a593Smuzhiyun #include "tm6000-regs.h"
16*4882a593Smuzhiyun #include <media/v4l2-common.h>
17*4882a593Smuzhiyun #include <media/tuner.h>
18*4882a593Smuzhiyun #include "tuner-xc2028.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun /* ----------------------------------------------------------- */
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun static unsigned int i2c_debug;
24*4882a593Smuzhiyun module_param(i2c_debug, int, 0644);
25*4882a593Smuzhiyun MODULE_PARM_DESC(i2c_debug, "enable debug messages [i2c]");
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #define i2c_dprintk(lvl, fmt, args...) if (i2c_debug >= lvl) do { \
28*4882a593Smuzhiyun 			printk(KERN_DEBUG "%s at %s: " fmt, \
29*4882a593Smuzhiyun 			dev->name, __func__, ##args); } while (0)
30*4882a593Smuzhiyun 
tm6000_i2c_send_regs(struct tm6000_core * dev,unsigned char addr,__u8 reg,char * buf,int len)31*4882a593Smuzhiyun static int tm6000_i2c_send_regs(struct tm6000_core *dev, unsigned char addr,
32*4882a593Smuzhiyun 				__u8 reg, char *buf, int len)
33*4882a593Smuzhiyun {
34*4882a593Smuzhiyun 	int rc;
35*4882a593Smuzhiyun 	unsigned int i2c_packet_limit = 16;
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	if (dev->dev_type == TM6010)
38*4882a593Smuzhiyun 		i2c_packet_limit = 80;
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	if (!buf)
41*4882a593Smuzhiyun 		return -1;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	if (len < 1 || len > i2c_packet_limit) {
44*4882a593Smuzhiyun 		printk(KERN_ERR "Incorrect length of i2c packet = %d, limit set to %d\n",
45*4882a593Smuzhiyun 			len, i2c_packet_limit);
46*4882a593Smuzhiyun 		return -1;
47*4882a593Smuzhiyun 	}
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	/* capture mutex */
50*4882a593Smuzhiyun 	rc = tm6000_read_write_usb(dev, USB_DIR_OUT | USB_TYPE_VENDOR |
51*4882a593Smuzhiyun 		USB_RECIP_DEVICE, REQ_16_SET_GET_I2C_WR1_RDN,
52*4882a593Smuzhiyun 		addr | reg << 8, 0, buf, len);
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	if (rc < 0) {
55*4882a593Smuzhiyun 		/* release mutex */
56*4882a593Smuzhiyun 		return rc;
57*4882a593Smuzhiyun 	}
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 	/* release mutex */
60*4882a593Smuzhiyun 	return rc;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /* Generic read - doesn't work fine with 16bit registers */
tm6000_i2c_recv_regs(struct tm6000_core * dev,unsigned char addr,__u8 reg,char * buf,int len)64*4882a593Smuzhiyun static int tm6000_i2c_recv_regs(struct tm6000_core *dev, unsigned char addr,
65*4882a593Smuzhiyun 				__u8 reg, char *buf, int len)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun 	int rc;
68*4882a593Smuzhiyun 	u8 b[2];
69*4882a593Smuzhiyun 	unsigned int i2c_packet_limit = 16;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	if (dev->dev_type == TM6010)
72*4882a593Smuzhiyun 		i2c_packet_limit = 64;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	if (!buf)
75*4882a593Smuzhiyun 		return -1;
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun 	if (len < 1 || len > i2c_packet_limit) {
78*4882a593Smuzhiyun 		printk(KERN_ERR "Incorrect length of i2c packet = %d, limit set to %d\n",
79*4882a593Smuzhiyun 			len, i2c_packet_limit);
80*4882a593Smuzhiyun 		return -1;
81*4882a593Smuzhiyun 	}
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	/* capture mutex */
84*4882a593Smuzhiyun 	if ((dev->caps.has_zl10353) && (dev->demod_addr << 1 == addr) && (reg % 2 == 0)) {
85*4882a593Smuzhiyun 		/*
86*4882a593Smuzhiyun 		 * Workaround an I2C bug when reading from zl10353
87*4882a593Smuzhiyun 		 */
88*4882a593Smuzhiyun 		reg -= 1;
89*4882a593Smuzhiyun 		len += 1;
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 		rc = tm6000_read_write_usb(dev, USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
92*4882a593Smuzhiyun 			REQ_16_SET_GET_I2C_WR1_RDN, addr | reg << 8, 0, b, len);
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 		*buf = b[1];
95*4882a593Smuzhiyun 	} else {
96*4882a593Smuzhiyun 		rc = tm6000_read_write_usb(dev, USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
97*4882a593Smuzhiyun 			REQ_16_SET_GET_I2C_WR1_RDN, addr | reg << 8, 0, buf, len);
98*4882a593Smuzhiyun 	}
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	/* release mutex */
101*4882a593Smuzhiyun 	return rc;
102*4882a593Smuzhiyun }
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun /*
105*4882a593Smuzhiyun  * read from a 16bit register
106*4882a593Smuzhiyun  * for example xc2028, xc3028 or xc3028L
107*4882a593Smuzhiyun  */
tm6000_i2c_recv_regs16(struct tm6000_core * dev,unsigned char addr,__u16 reg,char * buf,int len)108*4882a593Smuzhiyun static int tm6000_i2c_recv_regs16(struct tm6000_core *dev, unsigned char addr,
109*4882a593Smuzhiyun 				  __u16 reg, char *buf, int len)
110*4882a593Smuzhiyun {
111*4882a593Smuzhiyun 	int rc;
112*4882a593Smuzhiyun 	unsigned char ureg;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	if (!buf || len != 2)
115*4882a593Smuzhiyun 		return -1;
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	/* capture mutex */
118*4882a593Smuzhiyun 	if (dev->dev_type == TM6010) {
119*4882a593Smuzhiyun 		ureg = reg & 0xFF;
120*4882a593Smuzhiyun 		rc = tm6000_read_write_usb(dev, USB_DIR_OUT | USB_TYPE_VENDOR |
121*4882a593Smuzhiyun 			USB_RECIP_DEVICE, REQ_16_SET_GET_I2C_WR1_RDN,
122*4882a593Smuzhiyun 			addr | (reg & 0xFF00), 0, &ureg, 1);
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 		if (rc < 0) {
125*4882a593Smuzhiyun 			/* release mutex */
126*4882a593Smuzhiyun 			return rc;
127*4882a593Smuzhiyun 		}
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 		rc = tm6000_read_write_usb(dev, USB_DIR_IN | USB_TYPE_VENDOR |
130*4882a593Smuzhiyun 			USB_RECIP_DEVICE, REQ_35_AFTEK_TUNER_READ,
131*4882a593Smuzhiyun 			reg, 0, buf, len);
132*4882a593Smuzhiyun 	} else {
133*4882a593Smuzhiyun 		rc = tm6000_read_write_usb(dev, USB_DIR_IN | USB_TYPE_VENDOR |
134*4882a593Smuzhiyun 			USB_RECIP_DEVICE, REQ_14_SET_GET_I2C_WR2_RDN,
135*4882a593Smuzhiyun 			addr, reg, buf, len);
136*4882a593Smuzhiyun 	}
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	/* release mutex */
139*4882a593Smuzhiyun 	return rc;
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun 
tm6000_i2c_xfer(struct i2c_adapter * i2c_adap,struct i2c_msg msgs[],int num)142*4882a593Smuzhiyun static int tm6000_i2c_xfer(struct i2c_adapter *i2c_adap,
143*4882a593Smuzhiyun 			   struct i2c_msg msgs[], int num)
144*4882a593Smuzhiyun {
145*4882a593Smuzhiyun 	struct tm6000_core *dev = i2c_adap->algo_data;
146*4882a593Smuzhiyun 	int addr, rc, i, byte;
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	for (i = 0; i < num; i++) {
149*4882a593Smuzhiyun 		addr = (msgs[i].addr << 1) & 0xff;
150*4882a593Smuzhiyun 		i2c_dprintk(2, "%s %s addr=0x%x len=%d:",
151*4882a593Smuzhiyun 			 (msgs[i].flags & I2C_M_RD) ? "read" : "write",
152*4882a593Smuzhiyun 			 i == num - 1 ? "stop" : "nonstop", addr, msgs[i].len);
153*4882a593Smuzhiyun 		if (msgs[i].flags & I2C_M_RD) {
154*4882a593Smuzhiyun 			/* read request without preceding register selection */
155*4882a593Smuzhiyun 			/*
156*4882a593Smuzhiyun 			 * The TM6000 only supports a read transaction
157*4882a593Smuzhiyun 			 * immediately after a 1 or 2 byte write to select
158*4882a593Smuzhiyun 			 * a register.  We cannot fulfill this request.
159*4882a593Smuzhiyun 			 */
160*4882a593Smuzhiyun 			i2c_dprintk(2, " read without preceding write not supported");
161*4882a593Smuzhiyun 			rc = -EOPNOTSUPP;
162*4882a593Smuzhiyun 			goto err;
163*4882a593Smuzhiyun 		} else if (i + 1 < num && msgs[i].len <= 2 &&
164*4882a593Smuzhiyun 			   (msgs[i + 1].flags & I2C_M_RD) &&
165*4882a593Smuzhiyun 			   msgs[i].addr == msgs[i + 1].addr) {
166*4882a593Smuzhiyun 			/* 1 or 2 byte write followed by a read */
167*4882a593Smuzhiyun 			if (i2c_debug >= 2)
168*4882a593Smuzhiyun 				for (byte = 0; byte < msgs[i].len; byte++)
169*4882a593Smuzhiyun 					printk(KERN_CONT " %02x", msgs[i].buf[byte]);
170*4882a593Smuzhiyun 			i2c_dprintk(2, "; joined to read %s len=%d:",
171*4882a593Smuzhiyun 				    i == num - 2 ? "stop" : "nonstop",
172*4882a593Smuzhiyun 				    msgs[i + 1].len);
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun 			if (msgs[i].len == 2) {
175*4882a593Smuzhiyun 				rc = tm6000_i2c_recv_regs16(dev, addr,
176*4882a593Smuzhiyun 					msgs[i].buf[0] << 8 | msgs[i].buf[1],
177*4882a593Smuzhiyun 					msgs[i + 1].buf, msgs[i + 1].len);
178*4882a593Smuzhiyun 			} else {
179*4882a593Smuzhiyun 				rc = tm6000_i2c_recv_regs(dev, addr, msgs[i].buf[0],
180*4882a593Smuzhiyun 					msgs[i + 1].buf, msgs[i + 1].len);
181*4882a593Smuzhiyun 			}
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun 			i++;
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 			if (addr == dev->tuner_addr << 1) {
186*4882a593Smuzhiyun 				tm6000_set_reg(dev, REQ_50_SET_START, 0, 0);
187*4882a593Smuzhiyun 				tm6000_set_reg(dev, REQ_51_SET_STOP, 0, 0);
188*4882a593Smuzhiyun 			}
189*4882a593Smuzhiyun 			if (i2c_debug >= 2)
190*4882a593Smuzhiyun 				for (byte = 0; byte < msgs[i].len; byte++)
191*4882a593Smuzhiyun 					printk(KERN_CONT " %02x", msgs[i].buf[byte]);
192*4882a593Smuzhiyun 		} else {
193*4882a593Smuzhiyun 			/* write bytes */
194*4882a593Smuzhiyun 			if (i2c_debug >= 2)
195*4882a593Smuzhiyun 				for (byte = 0; byte < msgs[i].len; byte++)
196*4882a593Smuzhiyun 					printk(KERN_CONT " %02x", msgs[i].buf[byte]);
197*4882a593Smuzhiyun 			rc = tm6000_i2c_send_regs(dev, addr, msgs[i].buf[0],
198*4882a593Smuzhiyun 				msgs[i].buf + 1, msgs[i].len - 1);
199*4882a593Smuzhiyun 		}
200*4882a593Smuzhiyun 		if (i2c_debug >= 2)
201*4882a593Smuzhiyun 			printk(KERN_CONT "\n");
202*4882a593Smuzhiyun 		if (rc < 0)
203*4882a593Smuzhiyun 			goto err;
204*4882a593Smuzhiyun 	}
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	return num;
207*4882a593Smuzhiyun err:
208*4882a593Smuzhiyun 	i2c_dprintk(2, " ERROR: %i\n", rc);
209*4882a593Smuzhiyun 	return rc;
210*4882a593Smuzhiyun }
211*4882a593Smuzhiyun 
tm6000_i2c_eeprom(struct tm6000_core * dev)212*4882a593Smuzhiyun static int tm6000_i2c_eeprom(struct tm6000_core *dev)
213*4882a593Smuzhiyun {
214*4882a593Smuzhiyun 	int i, rc;
215*4882a593Smuzhiyun 	unsigned char *p = dev->eedata;
216*4882a593Smuzhiyun 	unsigned char bytes[17];
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun 	dev->i2c_client.addr = 0xa0 >> 1;
219*4882a593Smuzhiyun 	dev->eedata_size = 0;
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	bytes[16] = '\0';
222*4882a593Smuzhiyun 	for (i = 0; i < sizeof(dev->eedata); ) {
223*4882a593Smuzhiyun 		*p = i;
224*4882a593Smuzhiyun 		rc = tm6000_i2c_recv_regs(dev, 0xa0, i, p, 1);
225*4882a593Smuzhiyun 		if (rc < 1) {
226*4882a593Smuzhiyun 			if (p == dev->eedata)
227*4882a593Smuzhiyun 				goto noeeprom;
228*4882a593Smuzhiyun 			else {
229*4882a593Smuzhiyun 				printk(KERN_WARNING
230*4882a593Smuzhiyun 				"%s: i2c eeprom read error (err=%d)\n",
231*4882a593Smuzhiyun 				dev->name, rc);
232*4882a593Smuzhiyun 			}
233*4882a593Smuzhiyun 			return -EINVAL;
234*4882a593Smuzhiyun 		}
235*4882a593Smuzhiyun 		dev->eedata_size++;
236*4882a593Smuzhiyun 		p++;
237*4882a593Smuzhiyun 		if (0 == (i % 16))
238*4882a593Smuzhiyun 			printk(KERN_INFO "%s: i2c eeprom %02x:", dev->name, i);
239*4882a593Smuzhiyun 		printk(KERN_CONT " %02x", dev->eedata[i]);
240*4882a593Smuzhiyun 		if ((dev->eedata[i] >= ' ') && (dev->eedata[i] <= 'z'))
241*4882a593Smuzhiyun 			bytes[i%16] = dev->eedata[i];
242*4882a593Smuzhiyun 		else
243*4882a593Smuzhiyun 			bytes[i%16] = '.';
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun 		i++;
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun 		if (0 == (i % 16)) {
248*4882a593Smuzhiyun 			bytes[16] = '\0';
249*4882a593Smuzhiyun 			printk(KERN_CONT "  %s\n", bytes);
250*4882a593Smuzhiyun 		}
251*4882a593Smuzhiyun 	}
252*4882a593Smuzhiyun 	if (0 != (i%16)) {
253*4882a593Smuzhiyun 		bytes[i%16] = '\0';
254*4882a593Smuzhiyun 		for (i %= 16; i < 16; i++)
255*4882a593Smuzhiyun 			printk(KERN_CONT "   ");
256*4882a593Smuzhiyun 		printk(KERN_CONT "  %s\n", bytes);
257*4882a593Smuzhiyun 	}
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun 	return 0;
260*4882a593Smuzhiyun 
261*4882a593Smuzhiyun noeeprom:
262*4882a593Smuzhiyun 	printk(KERN_INFO "%s: Huh, no eeprom present (err=%d)?\n",
263*4882a593Smuzhiyun 	       dev->name, rc);
264*4882a593Smuzhiyun 	return -EINVAL;
265*4882a593Smuzhiyun }
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun /* ----------------------------------------------------------- */
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun /*
270*4882a593Smuzhiyun  * functionality()
271*4882a593Smuzhiyun  */
functionality(struct i2c_adapter * adap)272*4882a593Smuzhiyun static u32 functionality(struct i2c_adapter *adap)
273*4882a593Smuzhiyun {
274*4882a593Smuzhiyun 	return I2C_FUNC_SMBUS_EMUL;
275*4882a593Smuzhiyun }
276*4882a593Smuzhiyun 
277*4882a593Smuzhiyun static const struct i2c_algorithm tm6000_algo = {
278*4882a593Smuzhiyun 	.master_xfer   = tm6000_i2c_xfer,
279*4882a593Smuzhiyun 	.functionality = functionality,
280*4882a593Smuzhiyun };
281*4882a593Smuzhiyun 
282*4882a593Smuzhiyun /* ----------------------------------------------------------- */
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun /*
285*4882a593Smuzhiyun  * tm6000_i2c_register()
286*4882a593Smuzhiyun  * register i2c bus
287*4882a593Smuzhiyun  */
tm6000_i2c_register(struct tm6000_core * dev)288*4882a593Smuzhiyun int tm6000_i2c_register(struct tm6000_core *dev)
289*4882a593Smuzhiyun {
290*4882a593Smuzhiyun 	int rc;
291*4882a593Smuzhiyun 
292*4882a593Smuzhiyun 	dev->i2c_adap.owner = THIS_MODULE;
293*4882a593Smuzhiyun 	dev->i2c_adap.algo = &tm6000_algo;
294*4882a593Smuzhiyun 	dev->i2c_adap.dev.parent = &dev->udev->dev;
295*4882a593Smuzhiyun 	strscpy(dev->i2c_adap.name, dev->name, sizeof(dev->i2c_adap.name));
296*4882a593Smuzhiyun 	dev->i2c_adap.algo_data = dev;
297*4882a593Smuzhiyun 	i2c_set_adapdata(&dev->i2c_adap, &dev->v4l2_dev);
298*4882a593Smuzhiyun 	rc = i2c_add_adapter(&dev->i2c_adap);
299*4882a593Smuzhiyun 	if (rc)
300*4882a593Smuzhiyun 		return rc;
301*4882a593Smuzhiyun 
302*4882a593Smuzhiyun 	dev->i2c_client.adapter = &dev->i2c_adap;
303*4882a593Smuzhiyun 	strscpy(dev->i2c_client.name, "tm6000 internal", I2C_NAME_SIZE);
304*4882a593Smuzhiyun 	tm6000_i2c_eeprom(dev);
305*4882a593Smuzhiyun 
306*4882a593Smuzhiyun 	return 0;
307*4882a593Smuzhiyun }
308*4882a593Smuzhiyun 
309*4882a593Smuzhiyun /*
310*4882a593Smuzhiyun  * tm6000_i2c_unregister()
311*4882a593Smuzhiyun  * unregister i2c_bus
312*4882a593Smuzhiyun  */
tm6000_i2c_unregister(struct tm6000_core * dev)313*4882a593Smuzhiyun int tm6000_i2c_unregister(struct tm6000_core *dev)
314*4882a593Smuzhiyun {
315*4882a593Smuzhiyun 	i2c_del_adapter(&dev->i2c_adap);
316*4882a593Smuzhiyun 	return 0;
317*4882a593Smuzhiyun }
318