drivers/media/video/em28xx/em28xx-i2c.c

   1 /*
   2    em28xx-i2c.c - driver for Empia EM2800/EM2820/2840 USB video capture devices
   3
   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>
   8
   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.
  13
  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.
  18
  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.
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/kernel.h>
  26 #include <linux/usb.h>
  27 #include <linux/i2c.h>
  28
  29 #include "em28xx.h"
  30 #include "tuner-xc2028.h"
  31 #include <media/v4l2-common.h>
  32 #include <media/tuner.h>
  33
  34 /* ----------------------------------------------------------- */
  35
  36 static unsigned int i2c_scan;
  37 module_param(i2c_scan, int, 0444);
  38 MODULE_PARM_DESC(i2c_scan, "scan i2c bus at insmod time");
  39
  40 static unsigned int i2c_debug;
  41 module_param(i2c_debug, int, 0644);
  42 MODULE_PARM_DESC(i2c_debug, "enable debug messages [i2c]");
  43
  44
  45 #define dprintk1(lvl, fmt, args...)                     \
  46 do {                                                    \
  47         if (i2c_debug >= lvl) {                         \
  48         printk(fmt, ##args);                            \
  49       }                                                 \
  50 } while (0)
  51
  52 #define dprintk2(lvl, fmt, args...)                     \
  53 do {                                                    \
  54         if (i2c_debug >= lvl) {                         \
  55                 printk(KERN_DEBUG "%s at %s: " fmt,     \
  56                        dev->name, __func__ , ##args);   \
  57       }                                                 \
  58 } while (0)
  59
  60 /*
  61  * em2800_i2c_send_max4()
  62  * send up to 4 bytes to the i2c device
  63  */
  64 static int em2800_i2c_send_max4(struct em28xx *dev, unsigned char addr,
  65                                 char *buf, int len)
  66 {
  67         int ret;
  68         int write_timeout;
  69         unsigned char b2[6];
  70         BUG_ON(len < 1 || len > 4);
  71         b2[5] = 0x80 + len - 1;
  72         b2[4] = addr;
  73         b2[3] = buf[0];
  74         if (len > 1)
  75                 b2[2] = buf[1];
  76         if (len > 2)
  77                 b2[1] = buf[2];
  78         if (len > 3)
  79                 b2[0] = buf[3];
  80
  81         ret = dev->em28xx_write_regs(dev, 4 - len, &b2[4 - len], 2 + len);
  82         if (ret != 2 + len) {
  83                 em28xx_warn("writing to i2c device failed (error=%i)\n", ret);
  84                 return -EIO;
  85         }
  86         for (write_timeout = EM2800_I2C_WRITE_TIMEOUT; write_timeout > 0;
  87              write_timeout -= 5) {
  88                 ret = dev->em28xx_read_reg(dev, 0x05);
  89                 if (ret == 0x80 + len - 1)
  90                         return len;
  91                 msleep(5);
  92         }
  93         em28xx_warn("i2c write timed out\n");
  94         return -EIO;
  95 }
  96
  97 /*
  98  * em2800_i2c_send_bytes()
  99  */
 100 static int em2800_i2c_send_bytes(void *data, unsigned char addr, char *buf,
 101                                  short len)
 102 {
 103         char *bufPtr = buf;
 104         int ret;
 105         int wrcount = 0;
 106         int count;
 107         int maxLen = 4;
 108         struct em28xx *dev = (struct em28xx *)data;
 109         while (len > 0) {
 110                 count = (len > maxLen) ? maxLen : len;
 111                 ret = em2800_i2c_send_max4(dev, addr, bufPtr, count);
 112                 if (ret > 0) {
 113                         len -= count;
 114                         bufPtr += count;
 115                         wrcount += count;
 116                 } else
 117                         return (ret < 0) ? ret : -EFAULT;
 118         }
 119         return wrcount;
 120 }
 121
 122 /*
 123  * em2800_i2c_check_for_device()
 124  * check if there is a i2c_device at the supplied address
 125  */
 126 static int em2800_i2c_check_for_device(struct em28xx *dev, unsigned char addr)
 127 {
 128         char msg;
 129         int ret;
 130         int write_timeout;
 131         msg = addr;
 132         ret = dev->em28xx_write_regs(dev, 0x04, &msg, 1);
 133         if (ret < 0) {
 134                 em28xx_warn("setting i2c device address failed (error=%i)\n",
 135                             ret);
 136                 return ret;
 137         }
 138         msg = 0x84;
 139         ret = dev->em28xx_write_regs(dev, 0x05, &msg, 1);
 140         if (ret < 0) {
 141                 em28xx_warn("preparing i2c read failed (error=%i)\n", ret);
 142                 return ret;
 143         }
 144         for (write_timeout = EM2800_I2C_WRITE_TIMEOUT; write_timeout > 0;
 145              write_timeout -= 5) {
 146                 unsigned msg = dev->em28xx_read_reg(dev, 0x5);
 147                 if (msg == 0x94)
 148                         return -ENODEV;
 149                 else if (msg == 0x84)
 150                         return 0;
 151                 msleep(5);
 152         }
 153         return -ENODEV;
 154 }
 155
 156 /*
 157  * em2800_i2c_recv_bytes()
 158  * read from the i2c device
 159  */
 160 static int em2800_i2c_recv_bytes(struct em28xx *dev, unsigned char addr,
 161                                  char *buf, int len)
 162 {
 163         int ret;
 164         /* check for the device and set i2c read address */
 165         ret = em2800_i2c_check_for_device(dev, addr);
 166         if (ret) {
 167                 em28xx_warn
 168                     ("preparing read at i2c address 0x%x failed (error=%i)\n",
 169                      addr, ret);
 170                 return ret;
 171         }
 172         ret = dev->em28xx_read_reg_req_len(dev, 0x0, 0x3, buf, len);
 173         if (ret < 0) {
 174                 em28xx_warn("reading from i2c device at 0x%x failed (error=%i)",
 175                             addr, ret);
 176                 return ret;
 177         }
 178         return ret;
 179 }
 180
 181 /*
 182  * em28xx_i2c_send_bytes()
 183  * untested for more than 4 bytes
 184  */
 185 static int em28xx_i2c_send_bytes(void *data, unsigned char addr, char *buf,
 186                                  short len, int stop)
 187 {
 188         int wrcount = 0;
 189         struct em28xx *dev = (struct em28xx *)data;
 190
 191         wrcount = dev->em28xx_write_regs_req(dev, stop ? 2 : 3, addr, buf, len);
 192
 193         return wrcount;
 194 }
 195
 196 /*
 197  * em28xx_i2c_recv_bytes()
 198  * read a byte from the i2c device
 199  */
 200 static int em28xx_i2c_recv_bytes(struct em28xx *dev, unsigned char addr,
 201                                  char *buf, int len)
 202 {
 203         int ret;
 204         ret = dev->em28xx_read_reg_req_len(dev, 2, addr, buf, len);
 205         if (ret < 0) {
 206                 em28xx_warn("reading i2c device failed (error=%i)\n", ret);
 207                 return ret;
 208         }
 209         if (dev->em28xx_read_reg(dev, 0x5) != 0)
 210                 return -ENODEV;
 211         return ret;
 212 }
 213
 214 /*
 215  * em28xx_i2c_check_for_device()
 216  * check if there is a i2c_device at the supplied address
 217  */
 218 static int em28xx_i2c_check_for_device(struct em28xx *dev, unsigned char addr)
 219 {
 220         char msg;
 221         int ret;
 222         msg = addr;
 223
 224         ret = dev->em28xx_read_reg_req(dev, 2, addr);
 225         if (ret < 0) {
 226                 em28xx_warn("reading from i2c device failed (error=%i)\n", ret);
 227                 return ret;
 228         }
 229         if (dev->em28xx_read_reg(dev, 0x5) != 0)
 230                 return -ENODEV;
 231         return 0;
 232 }
 233
 234 /*
 235  * em28xx_i2c_xfer()
 236  * the main i2c transfer function
 237  */
 238 static int em28xx_i2c_xfer(struct i2c_adapter *i2c_adap,
 239                            struct i2c_msg msgs[], int num)
 240 {
 241         struct em28xx *dev = i2c_adap->algo_data;
 242         int addr, rc, i, byte;
 243
 244         if (num <= 0)
 245                 return 0;
 246         for (i = 0; i < num; i++) {
 247                 addr = msgs[i].addr << 1;
 248                 dprintk2(2, "%s %s addr=%x len=%d:",
 249                          (msgs[i].flags & I2C_M_RD) ? "read" : "write",
 250                          i == num - 1 ? "stop" : "nonstop", addr, msgs[i].len);
 251                 if (!msgs[i].len) { /* no len: check only for device presence */
 252                         if (dev->is_em2800)
 253                                 rc = em2800_i2c_check_for_device(dev, addr);
 254                         else
 255                                 rc = em28xx_i2c_check_for_device(dev, addr);
 256                         if (rc < 0) {
 257                                 dprintk2(2, " no device\n");
 258                                 return rc;
 259                         }
 260
 261                 } else if (msgs[i].flags & I2C_M_RD) {
 262                         /* read bytes */
 263                         if (dev->is_em2800)
 264                                 rc = em2800_i2c_recv_bytes(dev, addr,
 265                                                            msgs[i].buf,
 266                                                            msgs[i].len);
 267                         else
 268                                 rc = em28xx_i2c_recv_bytes(dev, addr,
 269                                                            msgs[i].buf,
 270                                                            msgs[i].len);
 271                         if (i2c_debug >= 2) {
 272                                 for (byte = 0; byte < msgs[i].len; byte++)
 273                                         printk(" %02x", msgs[i].buf[byte]);
 274                         }
 275                 } else {
 276                         /* write bytes */
 277                         if (i2c_debug >= 2) {
 278                                 for (byte = 0; byte < msgs[i].len; byte++)
 279                                         printk(" %02x", msgs[i].buf[byte]);
 280                         }
 281                         if (dev->is_em2800)
 282                                 rc = em2800_i2c_send_bytes(dev, addr,
 283                                                            msgs[i].buf,
 284                                                            msgs[i].len);
 285                         else
 286                                 rc = em28xx_i2c_send_bytes(dev, addr,
 287                                                            msgs[i].buf,
 288                                                            msgs[i].len,
 289                                                            i == num - 1);
 290                 }
 291                 if (rc < 0)
 292                         goto err;
 293                 if (i2c_debug >= 2)
 294                         printk("\n");
 295         }
 296
 297         return num;
 298 err:
 299         dprintk2(2, " ERROR: %i\n", rc);
 300         return rc;
 301 }
 302
 303 /* based on linux/sunrpc/svcauth.h and linux/hash.h
 304  * The original hash function returns a different value, if arch is x86_64
 305  *  or i386.
 306  */
 307 static inline unsigned long em28xx_hash_mem(char *buf, int length, int bits)
 308 {
 309         unsigned long hash = 0;
 310         unsigned long l = 0;
 311         int len = 0;
 312         unsigned char c;
 313         do {
 314                 if (len == length) {
 315                         c = (char)len;
 316                         len = -1;
 317                 } else
 318                         c = *buf++;
 319                 l = (l << 8) | c;
 320                 len++;
 321                 if ((len & (32 / 8 - 1)) == 0)
 322                         hash = ((hash^l) * 0x9e370001UL);
 323         } while (len);
 324
 325         return (hash >> (32 - bits)) & 0xffffffffUL;
 326 }
 327
 328 static int em28xx_i2c_eeprom(struct em28xx *dev, unsigned char *eedata, int len)
 329 {
 330         unsigned char buf, *p = eedata;
 331         struct em28xx_eeprom *em_eeprom = (void *)eedata;
 332         int i, err, size = len, block;
 333
 334         dev->i2c_client.addr = 0xa0 >> 1;
 335
 336         /* Check if board has eeprom */
 337         err = i2c_master_recv(&dev->i2c_client, &buf, 0);
 338         if (err < 0)
 339                 return -1;
 340
 341         buf = 0;
 342
 343         err = i2c_master_send(&dev->i2c_client, &buf, 1);
 344         if (err != 1) {
 345                 printk(KERN_INFO "%s: Huh, no eeprom present (err=%d)?\n",
 346                        dev->name, err);
 347                 return -1;
 348         }
 349         while (size > 0) {
 350                 if (size > 16)
 351                         block = 16;
 352                 else
 353                         block = size;
 354
 355                 if (block !=
 356                     (err = i2c_master_recv(&dev->i2c_client, p, block))) {
 357                         printk(KERN_WARNING
 358                                "%s: i2c eeprom read error (err=%d)\n",
 359                                dev->name, err);
 360                         return -1;
 361                 }
 362                 size -= block;
 363                 p += block;
 364         }
 365         for (i = 0; i < len; i++) {
 366                 if (0 == (i % 16))
 367                         printk(KERN_INFO "%s: i2c eeprom %02x:", dev->name, i);
 368                 printk(" %02x", eedata[i]);
 369                 if (15 == (i % 16))
 370                         printk("\n");
 371         }
 372
 373         if (em_eeprom->id == 0x9567eb1a)
 374                 dev->hash = em28xx_hash_mem(eedata, len, 32);
 375
 376         printk(KERN_INFO "EEPROM ID= 0x%08x, hash = 0x%08lx\n",
 377                em_eeprom->id, dev->hash);
 378         printk(KERN_INFO "Vendor/Product ID= %04x:%04x\n", em_eeprom->vendor_ID,
 379                em_eeprom->product_ID);
 380
 381         switch (em_eeprom->chip_conf >> 4 & 0x3) {
 382         case 0:
 383                 printk(KERN_INFO "No audio on board.\n");
 384                 break;
 385         case 1:
 386                 printk(KERN_INFO "AC97 audio (5 sample rates)\n");
 387                 break;
 388         case 2:
 389                 printk(KERN_INFO "I2S audio, sample rate=32k\n");
 390                 break;
 391         case 3:
 392                 printk(KERN_INFO "I2S audio, 3 sample rates\n");
 393                 break;
 394         }
 395
 396         if (em_eeprom->chip_conf & 1 << 3)
 397                 printk(KERN_INFO "USB Remote wakeup capable\n");
 398
 399         if (em_eeprom->chip_conf & 1 << 2)
 400                 printk(KERN_INFO "USB Self power capable\n");
 401
 402         switch (em_eeprom->chip_conf & 0x3) {
 403         case 0:
 404                 printk(KERN_INFO "500mA max power\n");
 405                 break;
 406         case 1:
 407                 printk(KERN_INFO "400mA max power\n");
 408                 break;
 409         case 2:
 410                 printk(KERN_INFO "300mA max power\n");
 411                 break;
 412         case 3:
 413                 printk(KERN_INFO "200mA max power\n");
 414                 break;
 415         }
 416         printk(KERN_INFO "Table at 0x%02x, strings=0x%04x, 0x%04x, 0x%04x\n",
 417                                 em_eeprom->string_idx_table,
 418                                 em_eeprom->string1,
 419                                 em_eeprom->string2,
 420                                 em_eeprom->string3);
 421
 422         return 0;
 423 }
 424
 425 /* ----------------------------------------------------------- */
 426
 427 /*
 428  * functionality()
 429  */
 430 static u32 functionality(struct i2c_adapter *adap)
 431 {
 432         return I2C_FUNC_SMBUS_EMUL;
 433 }
 434
 435
 436 /*
 437  * attach_inform()
 438  * gets called when a device attaches to the i2c bus
 439  * does some basic configuration
 440  */
 441 static int attach_inform(struct i2c_client *client)
 442 {
 443         struct em28xx *dev = client->adapter->algo_data;
 444
 445         switch (client->addr << 1) {
 446         case 0x86:
 447         case 0x84:
 448         case 0x96:
 449         case 0x94:
 450         {
 451                 struct v4l2_priv_tun_config tda9887_cfg;
 452
 453                 struct tuner_setup tun_setup;
 454
 455                 tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
 456                 tun_setup.type = TUNER_TDA9887;
 457                 tun_setup.addr = client->addr;
 458
 459                 em28xx_i2c_call_clients(dev, TUNER_SET_TYPE_ADDR,
 460                         &tun_setup);
 461
 462                 tda9887_cfg.tuner = TUNER_TDA9887;
 463                 tda9887_cfg.priv = &dev->tda9887_conf;
 464                 em28xx_i2c_call_clients(dev, TUNER_SET_CONFIG,
 465                                         &tda9887_cfg);
 466                 break;
 467         }
 468         case 0x42:
 469                 dprintk1(1, "attach_inform: saa7114 detected.\n");
 470                 break;
 471         case 0x4a:
 472                 dprintk1(1, "attach_inform: saa7113 detected.\n");
 473                 break;
 474         case 0xa0:
 475                 dprintk1(1, "attach_inform: eeprom detected.\n");
 476                 break;
 477         case 0x60:
 478         case 0x8e:
 479         {
 480                 struct IR_i2c *ir = i2c_get_clientdata(client);
 481                 dprintk1(1, "attach_inform: IR detected (%s).\n",
 482                         ir->phys);
 483                 em28xx_set_ir(dev, ir);
 484                 break;
 485         }
 486         case 0x80:
 487         case 0x88:
 488                 dprintk1(1, "attach_inform: msp34xx detected.\n");
 489                 break;
 490         case 0xb8:
 491         case 0xba:
 492                 dprintk1(1, "attach_inform: tvp5150 detected.\n");
 493                 break;
 494
 495         default:
 496                 if (!dev->tuner_addr)
 497                         dev->tuner_addr = client->addr;
 498
 499                 dprintk1(1, "attach inform: detected I2C address %x\n",
 500                                 client->addr << 1);
 501
 502         }
 503
 504         return 0;
 505 }
 506
 507 static struct i2c_algorithm em28xx_algo = {
 508         .master_xfer   = em28xx_i2c_xfer,
 509         .functionality = functionality,
 510 };
 511
 512 static struct i2c_adapter em28xx_adap_template = {
 513         .owner = THIS_MODULE,
 514         .class = I2C_CLASS_TV_ANALOG,
 515         .name = "em28xx",
 516         .id = I2C_HW_B_EM28XX,
 517         .algo = &em28xx_algo,
 518         .client_register = attach_inform,
 519 };
 520
 521 static struct i2c_client em28xx_client_template = {
 522         .name = "em28xx internal",
 523 };
 524
 525 /* ----------------------------------------------------------- */
 526
 527 /*
 528  * i2c_devs
 529  * incomplete list of known devices
 530  */
 531 static char *i2c_devs[128] = {
 532         [0x4a >> 1] = "saa7113h",
 533         [0x60 >> 1] = "remote IR sensor",
 534         [0x8e >> 1] = "remote IR sensor",
 535         [0x86 >> 1] = "tda9887",
 536         [0x80 >> 1] = "msp34xx",
 537         [0x88 >> 1] = "msp34xx",
 538         [0xa0 >> 1] = "eeprom",
 539         [0xb8 >> 1] = "tvp5150a",
 540         [0xba >> 1] = "tvp5150a",
 541         [0xc0 >> 1] = "tuner (analog)",
 542         [0xc2 >> 1] = "tuner (analog)",
 543         [0xc4 >> 1] = "tuner (analog)",
 544         [0xc6 >> 1] = "tuner (analog)",
 545 };
 546
 547 /*
 548  * do_i2c_scan()
 549  * check i2c address range for devices
 550  */
 551 void em28xx_do_i2c_scan(struct em28xx *dev)
 552 {
 553         u8 i2c_devicelist[128];
 554         unsigned char buf;
 555         int i, rc;
 556
 557         memset(i2c_devicelist, 0, ARRAY_SIZE(i2c_devicelist));
 558
 559         for (i = 0; i < ARRAY_SIZE(i2c_devs); i++) {
 560                 dev->i2c_client.addr = i;
 561                 rc = i2c_master_recv(&dev->i2c_client, &buf, 0);
 562                 if (rc < 0)
 563                         continue;
 564                 i2c_devicelist[i] = i;
 565                 printk(KERN_INFO "%s: found i2c device @ 0x%x [%s]\n",
 566                        dev->name, i << 1, i2c_devs[i] ? i2c_devs[i] : "???");
 567         }
 568
 569         dev->i2c_hash = em28xx_hash_mem(i2c_devicelist,
 570                                         ARRAY_SIZE(i2c_devicelist), 32);
 571 }
 572
 573 /*
 574  * em28xx_i2c_call_clients()
 575  * send commands to all attached i2c devices
 576  */
 577 void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg)
 578 {
 579         BUG_ON(NULL == dev->i2c_adap.algo_data);
 580         i2c_clients_command(&dev->i2c_adap, cmd, arg);
 581 }
 582
 583 /*
 584  * em28xx_i2c_register()
 585  * register i2c bus
 586  */
 587 int em28xx_i2c_register(struct em28xx *dev)
 588 {
 589         BUG_ON(!dev->em28xx_write_regs || !dev->em28xx_read_reg);
 590         BUG_ON(!dev->em28xx_write_regs_req || !dev->em28xx_read_reg_req);
 591         dev->i2c_adap = em28xx_adap_template;
 592         dev->i2c_adap.dev.parent = &dev->udev->dev;
 593         strcpy(dev->i2c_adap.name, dev->name);
 594         dev->i2c_adap.algo_data = dev;
 595         i2c_add_adapter(&dev->i2c_adap);
 596
 597         dev->i2c_client = em28xx_client_template;
 598         dev->i2c_client.adapter = &dev->i2c_adap;
 599
 600         em28xx_i2c_eeprom(dev, dev->eedata, sizeof(dev->eedata));
 601
 602         if (i2c_scan)
 603                 em28xx_do_i2c_scan(dev);
 604         return 0;
 605 }
 606
 607 /*
 608  * em28xx_i2c_unregister()
 609  * unregister i2c_bus
 610  */
 611 int em28xx_i2c_unregister(struct em28xx *dev)
 612 {
 613         i2c_del_adapter(&dev->i2c_adap);
 614         return 0;
 615 }