2 em28xx-i2c.c - driver for Empia EM2800/EM2820/2840 USB video capture devices
4 Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
5 Markus Rechberger <mrechberger@gmail.com>
6 Mauro Carvalho Chehab <mchehab@infradead.org>
7 Sascha Sommer <saschasommer@freenet.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/usb.h>
27 #include <linux/i2c.h>
28 #include <linux/video_decoder.h>
31 #include "tuner-xc2028.h"
32 #include <media/v4l2-common.h>
33 #include <media/tuner.h>
35 /* ----------------------------------------------------------- */
37 static unsigned int i2c_scan = 0;
38 module_param(i2c_scan, int, 0444);
39 MODULE_PARM_DESC(i2c_scan, "scan i2c bus at insmod time");
41 static unsigned int i2c_debug = 0;
42 module_param(i2c_debug, int, 0644);
43 MODULE_PARM_DESC(i2c_debug, "enable debug messages [i2c]");
45 #define dprintk1(lvl,fmt, args...) if (i2c_debug>=lvl) do {\
46 printk(fmt, ##args); } while (0)
47 #define dprintk2(lvl,fmt, args...) if (i2c_debug>=lvl) do{ \
48 printk(KERN_DEBUG "%s at %s: " fmt, \
49 dev->name, __FUNCTION__ , ##args); } while (0)
52 * em2800_i2c_send_max4()
53 * send up to 4 bytes to the i2c device
55 static int em2800_i2c_send_max4(struct em28xx *dev, unsigned char addr,
61 BUG_ON(len < 1 || len > 4);
62 b2[5] = 0x80 + len - 1;
72 ret = dev->em28xx_write_regs(dev, 4 - len, &b2[4 - len], 2 + len);
74 em28xx_warn("writing to i2c device failed (error=%i)\n", ret);
77 for (write_timeout = EM2800_I2C_WRITE_TIMEOUT; write_timeout > 0;
79 ret = dev->em28xx_read_reg(dev, 0x05);
80 if (ret == 0x80 + len - 1)
84 em28xx_warn("i2c write timed out\n");
89 * em2800_i2c_send_bytes()
91 static int em2800_i2c_send_bytes(void *data, unsigned char addr, char *buf,
99 struct em28xx *dev = (struct em28xx *)data;
101 count = (len > maxLen) ? maxLen : len;
102 ret = em2800_i2c_send_max4(dev, addr, bufPtr, count);
108 return (ret < 0) ? ret : -EFAULT;
114 * em2800_i2c_check_for_device()
115 * check if there is a i2c_device at the supplied address
117 static int em2800_i2c_check_for_device(struct em28xx *dev, unsigned char addr)
123 ret = dev->em28xx_write_regs(dev, 0x04, &msg, 1);
125 em28xx_warn("setting i2c device address failed (error=%i)\n",
130 ret = dev->em28xx_write_regs(dev, 0x05, &msg, 1);
132 em28xx_warn("preparing i2c read failed (error=%i)\n", ret);
135 for (write_timeout = EM2800_I2C_WRITE_TIMEOUT; write_timeout > 0;
136 write_timeout -= 5) {
137 unsigned msg = dev->em28xx_read_reg(dev, 0x5);
140 else if (msg == 0x84)
148 * em2800_i2c_recv_bytes()
149 * read from the i2c device
151 static int em2800_i2c_recv_bytes(struct em28xx *dev, unsigned char addr,
155 /* check for the device and set i2c read address */
156 ret = em2800_i2c_check_for_device(dev, addr);
159 ("preparing read at i2c address 0x%x failed (error=%i)\n",
163 ret = dev->em28xx_read_reg_req_len(dev, 0x0, 0x3, buf, len);
165 em28xx_warn("reading from i2c device at 0x%x failed (error=%i)",
173 * em28xx_i2c_send_bytes()
174 * untested for more than 4 bytes
176 static int em28xx_i2c_send_bytes(void *data, unsigned char addr, char *buf,
180 struct em28xx *dev = (struct em28xx *)data;
182 wrcount = dev->em28xx_write_regs_req(dev, stop ? 2 : 3, addr, buf, len);
188 * em28xx_i2c_recv_bytes()
189 * read a byte from the i2c device
191 static int em28xx_i2c_recv_bytes(struct em28xx *dev, unsigned char addr,
195 ret = dev->em28xx_read_reg_req_len(dev, 2, addr, buf, len);
197 em28xx_warn("reading i2c device failed (error=%i)\n", ret);
200 if (dev->em28xx_read_reg(dev, 0x5) != 0)
206 * em28xx_i2c_check_for_device()
207 * check if there is a i2c_device at the supplied address
209 static int em28xx_i2c_check_for_device(struct em28xx *dev, unsigned char addr)
215 ret = dev->em28xx_read_reg_req(dev, 2, addr);
217 em28xx_warn("reading from i2c device failed (error=%i)\n", ret);
220 if (dev->em28xx_read_reg(dev, 0x5) != 0)
227 * the main i2c transfer function
229 static int em28xx_i2c_xfer(struct i2c_adapter *i2c_adap,
230 struct i2c_msg msgs[], int num)
232 struct em28xx *dev = i2c_adap->algo_data;
233 int addr, rc, i, byte;
237 for (i = 0; i < num; i++) {
238 addr = msgs[i].addr << 1;
239 dprintk2(2,"%s %s addr=%x len=%d:",
240 (msgs[i].flags & I2C_M_RD) ? "read" : "write",
241 i == num - 1 ? "stop" : "nonstop", addr, msgs[i].len);
242 if (!msgs[i].len) { /* no len: check only for device presence */
244 rc = em2800_i2c_check_for_device(dev, addr);
246 rc = em28xx_i2c_check_for_device(dev, addr);
248 dprintk2(2," no device\n");
252 } else if (msgs[i].flags & I2C_M_RD) {
255 rc = em2800_i2c_recv_bytes(dev, addr,
259 rc = em28xx_i2c_recv_bytes(dev, addr,
263 for (byte = 0; byte < msgs[i].len; byte++) {
264 printk(" %02x", msgs[i].buf[byte]);
270 for (byte = 0; byte < msgs[i].len; byte++)
271 printk(" %02x", msgs[i].buf[byte]);
274 rc = em2800_i2c_send_bytes(dev, addr,
278 rc = em28xx_i2c_send_bytes(dev, addr,
291 dprintk2(2," ERROR: %i\n", rc);
295 /* based on linux/sunrpc/svcauth.h and linux/hash.h
296 * The original hash function returns a different value, if arch is x86_64
299 static inline unsigned long em28xx_hash_mem(char *buf, int length, int bits)
301 unsigned long hash = 0;
313 if ((len & (32 / 8 - 1)) == 0)
314 hash = ((hash^l) * 0x9e370001UL);
317 return (hash >> (32 - bits)) & 0xffffffffUL;
320 static int em28xx_i2c_eeprom(struct em28xx *dev, unsigned char *eedata, int len)
322 unsigned char buf, *p = eedata;
323 struct em28xx_eeprom *em_eeprom = (void *)eedata;
324 int i, err, size = len, block;
326 dev->i2c_client.addr = 0xa0 >> 1;
328 /* Check if board has eeprom */
329 err = i2c_master_recv(&dev->i2c_client, &buf, 0);
334 if (1 != (err = i2c_master_send(&dev->i2c_client, &buf, 1))) {
335 printk(KERN_INFO "%s: Huh, no eeprom present (err=%d)?\n",
346 (err = i2c_master_recv(&dev->i2c_client, p, block))) {
348 "%s: i2c eeprom read error (err=%d)\n",
355 for (i = 0; i < len; i++) {
357 printk(KERN_INFO "%s: i2c eeprom %02x:", dev->name, i);
358 printk(" %02x", eedata[i]);
363 if (em_eeprom->id == 0x9567eb1a)
364 dev->hash = em28xx_hash_mem(eedata, len, 32);
366 printk(KERN_INFO "EEPROM ID= 0x%08x, hash = 0x%08lx\n",
367 em_eeprom->id, dev->hash);
368 printk(KERN_INFO "Vendor/Product ID= %04x:%04x\n", em_eeprom->vendor_ID,
369 em_eeprom->product_ID);
371 switch (em_eeprom->chip_conf >> 4 & 0x3) {
373 printk(KERN_INFO "No audio on board.\n");
376 printk(KERN_INFO "AC97 audio (5 sample rates)\n");
379 printk(KERN_INFO "I2S audio, sample rate=32k\n");
382 printk(KERN_INFO "I2S audio, 3 sample rates\n");
386 if (em_eeprom->chip_conf & 1 << 3)
387 printk(KERN_INFO "USB Remote wakeup capable\n");
389 if (em_eeprom->chip_conf & 1 << 2)
390 printk(KERN_INFO "USB Self power capable\n");
392 switch (em_eeprom->chip_conf & 0x3) {
394 printk(KERN_INFO "500mA max power\n");
397 printk(KERN_INFO "400mA max power\n");
400 printk(KERN_INFO "300mA max power\n");
403 printk(KERN_INFO "200mA max power\n");
406 printk(KERN_INFO "Table at 0x%02x, strings=0x%04x, 0x%04x, 0x%04x\n",
407 em_eeprom->string_idx_table,em_eeprom->string1,
408 em_eeprom->string2,em_eeprom->string3);
413 /* ----------------------------------------------------------- */
418 static u32 functionality(struct i2c_adapter *adap)
420 return I2C_FUNC_SMBUS_EMUL;
426 * gets called when a device attaches to the i2c bus
427 * does some basic configuration
429 static int attach_inform(struct i2c_client *client)
431 struct em28xx *dev = client->adapter->algo_data;
433 switch (client->addr << 1) {
439 struct v4l2_priv_tun_config tda9887_cfg;
441 struct tuner_setup tun_setup;
443 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
444 tun_setup.type = TUNER_TDA9887;
445 tun_setup.addr = client->addr;
447 em28xx_i2c_call_clients(dev, TUNER_SET_TYPE_ADDR, &tun_setup);
449 tda9887_cfg.tuner = TUNER_TDA9887;
450 tda9887_cfg.priv = &dev->tda9887_conf;
451 em28xx_i2c_call_clients(dev, TUNER_SET_CONFIG,
456 dprintk1(1,"attach_inform: saa7114 detected.\n");
459 dprintk1(1,"attach_inform: saa7113 detected.\n");
462 dprintk1(1,"attach_inform: eeprom detected.\n");
467 struct IR_i2c *ir = i2c_get_clientdata(client);
468 dprintk1(1,"attach_inform: IR detected (%s).\n",ir->phys);
469 em28xx_set_ir(dev,ir);
474 dprintk1(1,"attach_inform: msp34xx detected.\n");
478 dprintk1(1,"attach_inform: tvp5150 detected.\n");
482 if (!dev->tuner_addr)
483 dev->tuner_addr = client->addr;
485 dprintk1(1,"attach inform: detected I2C address %x\n", client->addr << 1);
492 static struct i2c_algorithm em28xx_algo = {
493 .master_xfer = em28xx_i2c_xfer,
494 .functionality = functionality,
497 static struct i2c_adapter em28xx_adap_template = {
498 .owner = THIS_MODULE,
499 .class = I2C_CLASS_TV_ANALOG,
501 .id = I2C_HW_B_EM28XX,
502 .algo = &em28xx_algo,
503 .client_register = attach_inform,
506 static struct i2c_client em28xx_client_template = {
507 .name = "em28xx internal",
510 /* ----------------------------------------------------------- */
514 * incomplete list of known devices
516 static char *i2c_devs[128] = {
517 [0x4a >> 1] = "saa7113h",
518 [0x60 >> 1] = "remote IR sensor",
519 [0x8e >> 1] = "remote IR sensor",
520 [0x86 >> 1] = "tda9887",
521 [0x80 >> 1] = "msp34xx",
522 [0x88 >> 1] = "msp34xx",
523 [0xa0 >> 1] = "eeprom",
524 [0xb8 >> 1] = "tvp5150a",
525 [0xba >> 1] = "tvp5150a",
526 [0xc0 >> 1] = "tuner (analog)",
527 [0xc2 >> 1] = "tuner (analog)",
528 [0xc4 >> 1] = "tuner (analog)",
529 [0xc6 >> 1] = "tuner (analog)",
534 * check i2c address range for devices
536 void em28xx_do_i2c_scan(struct em28xx *dev)
538 u8 i2c_devicelist[128];
542 memset(i2c_devicelist, 0, ARRAY_SIZE(i2c_devicelist));
544 for (i = 0; i < ARRAY_SIZE(i2c_devs); i++) {
545 dev->i2c_client.addr = i;
546 rc = i2c_master_recv(&dev->i2c_client, &buf, 0);
549 i2c_devicelist[i] = i;
550 printk(KERN_INFO "%s: found i2c device @ 0x%x [%s]\n",
551 dev->name, i << 1, i2c_devs[i] ? i2c_devs[i] : "???");
554 dev->i2c_hash = em28xx_hash_mem(i2c_devicelist,
555 ARRAY_SIZE(i2c_devicelist), 32);
559 * em28xx_i2c_call_clients()
560 * send commands to all attached i2c devices
562 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg)
564 BUG_ON(NULL == dev->i2c_adap.algo_data);
565 i2c_clients_command(&dev->i2c_adap, cmd, arg);
569 * em28xx_i2c_register()
572 int em28xx_i2c_register(struct em28xx *dev)
574 BUG_ON(!dev->em28xx_write_regs || !dev->em28xx_read_reg);
575 BUG_ON(!dev->em28xx_write_regs_req || !dev->em28xx_read_reg_req);
576 dev->i2c_adap = em28xx_adap_template;
577 dev->i2c_adap.dev.parent = &dev->udev->dev;
578 strcpy(dev->i2c_adap.name, dev->name);
579 dev->i2c_adap.algo_data = dev;
580 i2c_add_adapter(&dev->i2c_adap);
582 dev->i2c_client = em28xx_client_template;
583 dev->i2c_client.adapter = &dev->i2c_adap;
585 em28xx_i2c_eeprom(dev, dev->eedata, sizeof(dev->eedata));
588 em28xx_do_i2c_scan(dev);
593 * em28xx_i2c_unregister()
596 int em28xx_i2c_unregister(struct em28xx *dev)
598 i2c_del_adapter(&dev->i2c_adap);