3 * i2c algorithm for USB-I2C Bridges
5 * Copyright (c) 1999-2007 Joerg Heckenbach <joerg@heckenbach-aw.de>
6 * Dwaine Garden <dwainegarden@rogers.com>
8 * This module is part of usbvision driver project.
9 * Updates to driver completed by Dwaine P. Garden
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/delay.h>
30 #include <linux/slab.h>
31 #include <linux/version.h>
32 #include <linux/utsname.h>
33 #include <linux/init.h>
34 #include <asm/uaccess.h>
35 #include <linux/ioport.h>
36 #include <linux/errno.h>
37 #include <linux/usb.h>
38 #include <linux/i2c.h>
39 #include "usbvision.h"
43 static int i2c_debug = 0;
45 module_param (i2c_debug, int, 0644); // debug_i2c_usb mode of the device driver
46 MODULE_PARM_DESC(i2c_debug, "enable debug messages [i2c]");
48 #define PDEBUG(level, fmt, args...) \
49 if (i2c_debug & (level)) info("[%s:%d] " fmt, __PRETTY_FUNCTION__, __LINE__ , ## args)
51 static int usbvision_i2c_write(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
53 static int usbvision_i2c_read(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
56 static inline int try_write_address(struct i2c_adapter *i2c_adap,
57 unsigned char addr, int retries)
59 struct usb_usbvision *usbvision;
63 usbvision = (struct usb_usbvision *)i2c_get_adapdata(i2c_adap);
65 for (i = 0; i <= retries; i++) {
66 ret = (usbvision_i2c_write(usbvision, addr, buf, 1));
70 if (i == retries) /* no success */
75 PDEBUG(DBG_I2C,"Needed %d retries for address %#2x", i, addr);
76 PDEBUG(DBG_I2C,"Maybe there's no device at this address");
81 static inline int try_read_address(struct i2c_adapter *i2c_adap,
82 unsigned char addr, int retries)
84 struct usb_usbvision *usbvision;
88 usbvision = (struct usb_usbvision *)i2c_get_adapdata(i2c_adap);
89 for (i = 0; i <= retries; i++) {
90 ret = (usbvision_i2c_read(usbvision, addr, buf, 1));
94 if (i == retries) /* no success */
99 PDEBUG(DBG_I2C,"Needed %d retries for address %#2x", i, addr);
100 PDEBUG(DBG_I2C,"Maybe there's no device at this address");
105 static inline int usb_find_address(struct i2c_adapter *i2c_adap,
106 struct i2c_msg *msg, int retries,
109 unsigned short flags = msg->flags;
113 if ((flags & I2C_M_TEN)) {
114 /* a ten bit address */
115 addr = 0xf0 | ((msg->addr >> 7) & 0x03);
116 /* try extended address code... */
117 ret = try_write_address(i2c_adap, addr, retries);
119 err("died at extended address code, while writing");
123 if (flags & I2C_M_RD) {
124 /* okay, now switch into reading mode */
126 ret = try_read_address(i2c_adap, addr, retries);
128 err("died at extended address code, while reading");
133 } else { /* normal 7bit address */
134 addr = (msg->addr << 1);
135 if (flags & I2C_M_RD)
137 if (flags & I2C_M_REV_DIR_ADDR)
141 if (flags & I2C_M_RD)
142 ret = try_read_address(i2c_adap, addr, retries);
144 ret = try_write_address(i2c_adap, addr, retries);
154 usbvision_i2c_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg msgs[], int num)
156 struct i2c_msg *pmsg;
157 struct usb_usbvision *usbvision;
161 usbvision = (struct usb_usbvision *)i2c_get_adapdata(i2c_adap);
163 for (i = 0; i < num; i++) {
165 ret = usb_find_address(i2c_adap, pmsg, i2c_adap->retries, &addr);
167 PDEBUG(DBG_I2C,"got NAK from device, message #%d", i);
168 return (ret < 0) ? ret : -EREMOTEIO;
171 if (pmsg->flags & I2C_M_RD) {
172 /* read bytes into buffer */
173 ret = (usbvision_i2c_read(usbvision, addr, pmsg->buf, pmsg->len));
174 if (ret < pmsg->len) {
175 return (ret < 0) ? ret : -EREMOTEIO;
178 /* write bytes from buffer */
179 ret = (usbvision_i2c_write(usbvision, addr, pmsg->buf, pmsg->len));
180 if (ret < pmsg->len) {
181 return (ret < 0) ? ret : -EREMOTEIO;
188 static int algo_control(struct i2c_adapter *adapter, unsigned int cmd, unsigned long arg)
193 static u32 functionality(struct i2c_adapter *adap)
195 return I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR | I2C_FUNC_PROTOCOL_MANGLING;
199 /* -----exported algorithm data: ------------------------------------- */
201 static struct i2c_algorithm usbvision_algo = {
202 .master_xfer = usbvision_i2c_xfer,
204 .algo_control = algo_control,
205 .functionality = functionality,
210 * registering functions to load algorithms at runtime
212 static int usbvision_i2c_usb_add_bus(struct i2c_adapter *adap)
214 PDEBUG(DBG_I2C, "I2C debugging is enabled [i2c]");
215 PDEBUG(DBG_I2C, "ALGO debugging is enabled [i2c]");
217 /* register new adapter to i2c module... */
219 adap->algo = &usbvision_algo;
221 adap->timeout = 100; /* default values, should */
222 adap->retries = 3; /* be replaced by defines */
224 i2c_add_adapter(adap);
226 PDEBUG(DBG_I2C,"i2c bus for %s registered", adap->name);
231 /* ----------------------------------------------------------------------- */
232 /* usbvision specific I2C functions */
233 /* ----------------------------------------------------------------------- */
234 static struct i2c_adapter i2c_adap_template;
235 static struct i2c_client i2c_client_template;
237 int usbvision_i2c_register(struct usb_usbvision *usbvision)
239 memcpy(&usbvision->i2c_adap, &i2c_adap_template,
240 sizeof(struct i2c_adapter));
241 memcpy(&usbvision->i2c_client, &i2c_client_template,
242 sizeof(struct i2c_client));
244 sprintf(usbvision->i2c_adap.name + strlen(usbvision->i2c_adap.name),
245 " #%d", usbvision->vdev->minor & 0x1f);
246 PDEBUG(DBG_I2C,"Adaptername: %s", usbvision->i2c_adap.name);
247 usbvision->i2c_adap.dev.parent = &usbvision->dev->dev;
249 i2c_set_adapdata(&usbvision->i2c_adap, usbvision);
250 i2c_set_clientdata(&usbvision->i2c_client, usbvision);
252 usbvision->i2c_client.adapter = &usbvision->i2c_adap;
254 if (usbvision_write_reg(usbvision, USBVISION_SER_MODE, USBVISION_IIC_LRNACK) < 0) {
255 printk(KERN_ERR "usbvision_register: can't write reg\n");
259 #ifdef CONFIG_MODULES
260 /* Request the load of the i2c modules we need */
261 switch (usbvision_device_data[usbvision->DevModel].Codec) {
263 request_module("saa7115");
266 request_module("saa7115");
269 if (usbvision_device_data[usbvision->DevModel].Tuner == 1) {
270 request_module("tuner");
274 return usbvision_i2c_usb_add_bus(&usbvision->i2c_adap);
277 int usbvision_i2c_unregister(struct usb_usbvision *usbvision)
280 i2c_del_adapter(&(usbvision->i2c_adap));
282 PDEBUG(DBG_I2C,"i2c bus for %s unregistered", usbvision->i2c_adap.name);
287 void call_i2c_clients(struct usb_usbvision *usbvision, unsigned int cmd,
290 i2c_clients_command(&usbvision->i2c_adap, cmd, arg);
293 static int attach_inform(struct i2c_client *client)
295 struct usb_usbvision *usbvision;
297 usbvision = (struct usb_usbvision *)i2c_get_adapdata(client->adapter);
299 switch (client->addr << 1) {
305 struct tuner_setup tun_setup;
307 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
308 tun_setup.type = TUNER_TDA9887;
309 tun_setup.addr = client->addr;
311 call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
316 PDEBUG(DBG_I2C,"attach_inform: saa7114 detected.");
319 PDEBUG(DBG_I2C,"attach_inform: saa7113 detected.");
322 PDEBUG(DBG_I2C,"attach_inform: saa7111 detected.");
325 PDEBUG(DBG_I2C,"attach_inform: eeprom detected.");
330 struct tuner_setup tun_setup;
332 PDEBUG(DBG_I2C,"attach inform: detected I2C address %x", client->addr << 1);
333 usbvision->tuner_addr = client->addr;
335 if ((usbvision->have_tuner) && (usbvision->tuner_type != -1)) {
336 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
337 tun_setup.type = usbvision->tuner_type;
338 tun_setup.addr = usbvision->tuner_addr;
339 call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
347 static int detach_inform(struct i2c_client *client)
349 struct usb_usbvision *usbvision;
351 usbvision = (struct usb_usbvision *)i2c_get_adapdata(client->adapter);
353 PDEBUG(DBG_I2C,"usbvision[%d] detaches %s", usbvision->nr, client->name);
358 usbvision_i2c_read_max4(struct usb_usbvision *usbvision, unsigned char addr,
359 char *buf, short len)
363 for (retries = 5;;) {
364 rc = usbvision_write_reg(usbvision, USBVISION_SER_ADRS, addr);
368 /* Initiate byte read cycle */
369 /* USBVISION_SER_CONT <- d0-d2 n. of bytes to r/w */
371 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
372 (len & 0x07) | 0x18);
376 /* Test for Busy and ACK */
378 /* USBVISION_SER_CONT -> d4 == 0 busy */
379 rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
380 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
384 /* USBVISION_SER_CONT -> d5 == 1 Not ack */
385 if ((rc & 0x20) == 0) /* Ack? */
389 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
399 buf[3] = usbvision_read_reg(usbvision, USBVISION_SER_DAT4);
401 buf[2] = usbvision_read_reg(usbvision, USBVISION_SER_DAT3);
403 buf[1] = usbvision_read_reg(usbvision, USBVISION_SER_DAT2);
405 buf[0] = usbvision_read_reg(usbvision, USBVISION_SER_DAT1);
409 "usbvision_i2c_read_max4: buffer length > 4\n");
412 if (i2c_debug & DBG_I2C) {
414 for (idx = 0; idx < len; idx++) {
415 PDEBUG(DBG_I2C,"read %x from address %x", (unsigned char)buf[idx], addr);
422 static int usbvision_i2c_write_max4(struct usb_usbvision *usbvision,
423 unsigned char addr, const char *buf,
428 unsigned char value[6];
429 unsigned char ser_cont;
431 ser_cont = (len & 0x07) | 0x10;
435 for (i = 0; i < len; i++)
436 value[i + 2] = buf[i];
438 for (retries = 5;;) {
439 rc = usb_control_msg(usbvision->dev,
440 usb_sndctrlpipe(usbvision->dev, 1),
442 USB_DIR_OUT | USB_TYPE_VENDOR |
443 USB_RECIP_ENDPOINT, 0,
444 (__u16) USBVISION_SER_ADRS, value,
450 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
451 (len & 0x07) | 0x10);
455 /* Test for Busy and ACK */
457 rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
458 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
462 if ((rc & 0x20) == 0) /* Ack? */
466 usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
473 if (i2c_debug & DBG_I2C) {
475 for (idx = 0; idx < len; idx++) {
476 PDEBUG(DBG_I2C,"wrote %x at address %x", (unsigned char)buf[idx], addr);
482 static int usbvision_i2c_write(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
492 count = (len > maxLen) ? maxLen : len;
493 retval = usbvision_i2c_write_max4(usbvision, addr, bufPtr, count);
499 return (retval < 0) ? retval : -EFAULT;
504 static int usbvision_i2c_read(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
513 count = (len > 3) ? 4 : len;
514 retval = usbvision_i2c_read_max4(usbvision, addr, temp, count);
516 for (i = 0; i < len; i++)
517 buf[rdcount + i] = temp[i];
521 return (retval < 0) ? retval : -EFAULT;
526 static struct i2c_adapter i2c_adap_template = {
527 .owner = THIS_MODULE,
529 .id = I2C_HW_B_BT848, /* FIXME */
530 .client_register = attach_inform,
531 .client_unregister = detach_inform,
532 #ifdef I2C_ADAP_CLASS_TV_ANALOG
533 .class = I2C_ADAP_CLASS_TV_ANALOG,
535 .class = I2C_CLASS_TV_ANALOG,
539 static struct i2c_client i2c_client_template = {
540 .name = "usbvision internal",
544 * Overrides for Emacs so that we follow Linus's tabbing style.
545 * ---------------------------------------------------------------------------