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 = 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 = 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 = i2c_get_adapdata(i2c_adap);
162 for (i = 0; i < num; i++) {
164 ret = usb_find_address(i2c_adap, pmsg, i2c_adap->retries, &addr);
166 PDEBUG(DBG_I2C,"got NAK from device, message #%d", i);
167 return (ret < 0) ? ret : -EREMOTEIO;
170 if (pmsg->flags & I2C_M_RD) {
171 /* read bytes into buffer */
172 ret = (usbvision_i2c_read(usbvision, addr, pmsg->buf, pmsg->len));
173 if (ret < pmsg->len) {
174 return (ret < 0) ? ret : -EREMOTEIO;
177 /* write bytes from buffer */
178 ret = (usbvision_i2c_write(usbvision, addr, pmsg->buf, pmsg->len));
179 if (ret < pmsg->len) {
180 return (ret < 0) ? ret : -EREMOTEIO;
187 static int algo_control(struct i2c_adapter *adapter, unsigned int cmd, unsigned long arg)
192 static u32 functionality(struct i2c_adapter *adap)
194 return I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR | I2C_FUNC_PROTOCOL_MANGLING;
198 /* -----exported algorithm data: ------------------------------------- */
200 static struct i2c_algorithm usbvision_algo = {
201 .master_xfer = usbvision_i2c_xfer,
203 .algo_control = algo_control,
204 .functionality = functionality,
208 /* ----------------------------------------------------------------------- */
209 /* usbvision specific I2C functions */
210 /* ----------------------------------------------------------------------- */
211 static struct i2c_adapter i2c_adap_template;
212 static struct i2c_client i2c_client_template;
214 int usbvision_i2c_register(struct usb_usbvision *usbvision)
218 usbvision->i2c_adap = i2c_adap_template;
219 usbvision->i2c_adap.dev.parent = &usbvision->dev->dev;
221 PDEBUG(DBG_I2C, "I2C debugging is enabled [i2c]");
223 sprintf(usbvision->i2c_adap.name + strlen(usbvision->i2c_adap.name),
224 " #%d", usbvision->vdev->minor & 0x1f);
225 PDEBUG(DBG_I2C,"I2C Registering adaptername: %s", usbvision->i2c_adap.name);
226 i2c_set_adapdata(&usbvision->i2c_adap,usbvision);
227 if ((ret = i2c_add_adapter(&usbvision->i2c_adap)) < 0) {
228 PDEBUG(DBG_I2C,"could not add I2C adapter %s", usbvision->i2c_adap.name);
232 /* TODO: use i2c_client for eeprom detection as an example... */
233 usbvision->i2c_client = i2c_client_template;
234 usbvision->i2c_client.adapter = &usbvision->i2c_adap;
236 if (usbvision_write_reg(usbvision, USBVISION_SER_MODE, USBVISION_IIC_LRNACK) < 0) {
237 printk(KERN_ERR "usbvision_i2c_register: can't write reg\n");
241 #ifdef CONFIG_MODULES
242 /* Request the load of the i2c modules we need */
243 switch (usbvision_device_data[usbvision->DevModel].Codec) {
245 request_module("saa7115");
248 request_module("saa7115");
251 if (usbvision_device_data[usbvision->DevModel].Tuner == 1) {
252 request_module("tuner");
259 int usbvision_i2c_unregister(struct usb_usbvision *usbvision)
262 i2c_del_adapter(&(usbvision->i2c_adap));
264 PDEBUG(DBG_I2C,"i2c bus for %s unregistered", usbvision->i2c_adap.name);
269 void call_i2c_clients(struct usb_usbvision *usbvision, unsigned int cmd,
272 i2c_clients_command(&usbvision->i2c_adap, cmd, arg);
275 static int attach_inform(struct i2c_client *client)
277 struct usb_usbvision *usbvision;
279 usbvision = i2c_get_adapdata(client->adapter);
280 switch (client->addr << 1) {
286 struct tuner_setup tun_setup;
288 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
289 tun_setup.type = TUNER_TDA9887;
290 tun_setup.addr = client->addr;
292 call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
297 PDEBUG(DBG_I2C,"attach_inform: saa7114 detected.");
300 PDEBUG(DBG_I2C,"attach_inform: saa7113 detected.");
303 PDEBUG(DBG_I2C,"attach_inform: saa7111 detected.");
306 PDEBUG(DBG_I2C,"attach_inform: eeprom detected.");
311 struct tuner_setup tun_setup;
313 PDEBUG(DBG_I2C,"attach inform: detected I2C address %x", client->addr << 1);
314 usbvision->tuner_addr = client->addr;
316 if ((usbvision->have_tuner) && (usbvision->tuner_type != -1)) {
317 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
318 tun_setup.type = usbvision->tuner_type;
319 tun_setup.addr = usbvision->tuner_addr;
320 call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
328 static int detach_inform(struct i2c_client *client)
330 struct usb_usbvision *usbvision;
332 usbvision = i2c_get_adapdata(client->adapter);
334 PDEBUG(DBG_I2C,"usbvision[%d] detaches %s", usbvision->nr, client->name);
339 usbvision_i2c_read_max4(struct usb_usbvision *usbvision, unsigned char addr,
340 char *buf, short len)
344 for (retries = 5;;) {
345 rc = usbvision_write_reg(usbvision, USBVISION_SER_ADRS, addr);
349 /* Initiate byte read cycle */
350 /* USBVISION_SER_CONT <- d0-d2 n. of bytes to r/w */
352 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
353 (len & 0x07) | 0x18);
357 /* Test for Busy and ACK */
359 /* USBVISION_SER_CONT -> d4 == 0 busy */
360 rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
361 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
365 /* USBVISION_SER_CONT -> d5 == 1 Not ack */
366 if ((rc & 0x20) == 0) /* Ack? */
370 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
380 buf[3] = usbvision_read_reg(usbvision, USBVISION_SER_DAT4);
382 buf[2] = usbvision_read_reg(usbvision, USBVISION_SER_DAT3);
384 buf[1] = usbvision_read_reg(usbvision, USBVISION_SER_DAT2);
386 buf[0] = usbvision_read_reg(usbvision, USBVISION_SER_DAT1);
390 "usbvision_i2c_read_max4: buffer length > 4\n");
393 if (i2c_debug & DBG_I2C) {
395 for (idx = 0; idx < len; idx++) {
396 PDEBUG(DBG_I2C,"read %x from address %x", (unsigned char)buf[idx], addr);
403 static int usbvision_i2c_write_max4(struct usb_usbvision *usbvision,
404 unsigned char addr, const char *buf,
409 unsigned char value[6];
410 unsigned char ser_cont;
412 ser_cont = (len & 0x07) | 0x10;
416 for (i = 0; i < len; i++)
417 value[i + 2] = buf[i];
419 for (retries = 5;;) {
420 rc = usb_control_msg(usbvision->dev,
421 usb_sndctrlpipe(usbvision->dev, 1),
423 USB_DIR_OUT | USB_TYPE_VENDOR |
424 USB_RECIP_ENDPOINT, 0,
425 (__u16) USBVISION_SER_ADRS, value,
431 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
432 (len & 0x07) | 0x10);
436 /* Test for Busy and ACK */
438 rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
439 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
443 if ((rc & 0x20) == 0) /* Ack? */
447 usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
454 if (i2c_debug & DBG_I2C) {
456 for (idx = 0; idx < len; idx++) {
457 PDEBUG(DBG_I2C,"wrote %x at address %x", (unsigned char)buf[idx], addr);
463 static int usbvision_i2c_write(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
473 count = (len > maxLen) ? maxLen : len;
474 retval = usbvision_i2c_write_max4(usbvision, addr, bufPtr, count);
480 return (retval < 0) ? retval : -EFAULT;
485 static int usbvision_i2c_read(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
494 count = (len > 3) ? 4 : len;
495 retval = usbvision_i2c_read_max4(usbvision, addr, temp, count);
497 for (i = 0; i < len; i++)
498 buf[rdcount + i] = temp[i];
502 return (retval < 0) ? retval : -EFAULT;
507 static struct i2c_adapter i2c_adap_template = {
508 .owner = THIS_MODULE,
510 .id = I2C_HW_B_BT848, /* FIXME */
511 .algo = &usbvision_algo,
513 .client_register = attach_inform,
514 .client_unregister = detach_inform,
515 #ifdef I2C_ADAP_CLASS_TV_ANALOG
516 .class = I2C_ADAP_CLASS_TV_ANALOG,
518 .class = I2C_CLASS_TV_ANALOG,
522 static struct i2c_client i2c_client_template = {
523 .name = "usbvision internal",
527 * Overrides for Emacs so that we follow Linus's tabbing style.
528 * ---------------------------------------------------------------------------