SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/media/video/usbvision/usbvision-i2c.c

   1 /*
   2  * usbvision_i2c.c
   3  *  i2c algorithm for USB-I2C Bridges
   4  *
   5  * Copyright (c) 1999-2007 Joerg Heckenbach <joerg@heckenbach-aw.de>
   6  *                         Dwaine Garden <dwainegarden@rogers.com>
   7  *
   8  * This module is part of usbvision driver project.
   9  * Updates to driver completed by Dwaine P. Garden
  10  *
  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.
  15  *
  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.
  20  *
  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.
  24  */
  25
  26
  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"
  40
  41 #define DBG_I2C         1<<0
  42
  43 static int i2c_debug = 0;
  44
  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]");
  47
  48 #define PDEBUG(level, fmt, args...) \
  49                 if (i2c_debug & (level)) info("[%s:%d] " fmt, __PRETTY_FUNCTION__, __LINE__ , ## args)
  50
  51 static int usbvision_i2c_write(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
  52                             short len);
  53 static int usbvision_i2c_read(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
  54                            short len);
  55
  56 static inline int try_write_address(struct i2c_adapter *i2c_adap,
  57                                     unsigned char addr, int retries)
  58 {
  59         struct usb_usbvision *usbvision;
  60         int i, ret = -1;
  61         char buf[4];
  62
  63         usbvision = i2c_get_adapdata(i2c_adap);
  64         buf[0] = 0x00;
  65         for (i = 0; i <= retries; i++) {
  66                 ret = (usbvision_i2c_write(usbvision, addr, buf, 1));
  67                 if (ret == 1)
  68                         break;  /* success! */
  69                 udelay(5);
  70                 if (i == retries)       /* no success */
  71                         break;
  72                 udelay(10);
  73         }
  74         if (i) {
  75                 PDEBUG(DBG_I2C,"Needed %d retries for address %#2x", i, addr);
  76                 PDEBUG(DBG_I2C,"Maybe there's no device at this address");
  77         }
  78         return ret;
  79 }
  80
  81 static inline int try_read_address(struct i2c_adapter *i2c_adap,
  82                                    unsigned char addr, int retries)
  83 {
  84         struct usb_usbvision *usbvision;
  85         int i, ret = -1;
  86         char buf[4];
  87
  88         usbvision = i2c_get_adapdata(i2c_adap);
  89         for (i = 0; i <= retries; i++) {
  90                 ret = (usbvision_i2c_read(usbvision, addr, buf, 1));
  91                 if (ret == 1)
  92                         break;  /* success! */
  93                 udelay(5);
  94                 if (i == retries)       /* no success */
  95                         break;
  96                 udelay(10);
  97         }
  98         if (i) {
  99                 PDEBUG(DBG_I2C,"Needed %d retries for address %#2x", i, addr);
 100                 PDEBUG(DBG_I2C,"Maybe there's no device at this address");
 101         }
 102         return ret;
 103 }
 104
 105 static inline int usb_find_address(struct i2c_adapter *i2c_adap,
 106                                    struct i2c_msg *msg, int retries,
 107                                    unsigned char *add)
 108 {
 109         unsigned short flags = msg->flags;
 110
 111         unsigned char addr;
 112         int ret;
 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);
 118                 if (ret != 1) {
 119                         err("died at extended address code, while writing");
 120                         return -EREMOTEIO;
 121                 }
 122                 add[0] = addr;
 123                 if (flags & I2C_M_RD) {
 124                         /* okay, now switch into reading mode */
 125                         addr |= 0x01;
 126                         ret = try_read_address(i2c_adap, addr, retries);
 127                         if (ret != 1) {
 128                                 err("died at extended address code, while reading");
 129                                 return -EREMOTEIO;
 130                         }
 131                 }
 132
 133         } else {                /* normal 7bit address  */
 134                 addr = (msg->addr << 1);
 135                 if (flags & I2C_M_RD)
 136                         addr |= 1;
 137                 if (flags & I2C_M_REV_DIR_ADDR)
 138                         addr ^= 1;
 139
 140                 add[0] = addr;
 141                 if (flags & I2C_M_RD)
 142                         ret = try_read_address(i2c_adap, addr, retries);
 143                 else
 144                         ret = try_write_address(i2c_adap, addr, retries);
 145
 146                 if (ret != 1) {
 147                         return -EREMOTEIO;
 148                 }
 149         }
 150         return 0;
 151 }
 152
 153 static int
 154 usbvision_i2c_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg msgs[], int num)
 155 {
 156         struct i2c_msg *pmsg;
 157         struct usb_usbvision *usbvision;
 158         int i, ret;
 159         unsigned char addr;
 160
 161         usbvision = i2c_get_adapdata(i2c_adap);
 162         for (i = 0; i < num; i++) {
 163                 pmsg = &msgs[i];
 164                 ret = usb_find_address(i2c_adap, pmsg, i2c_adap->retries, &addr);
 165                 if (ret != 0) {
 166                         PDEBUG(DBG_I2C,"got NAK from device, message #%d", i);
 167                         return (ret < 0) ? ret : -EREMOTEIO;
 168                 }
 169
 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;
 175                         }
 176                 } else {
 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;
 181                         }
 182                 }
 183         }
 184         return num;
 185 }
 186
 187 static int algo_control(struct i2c_adapter *adapter, unsigned int cmd, unsigned long arg)
 188 {
 189         return 0;
 190 }
 191
 192 static u32 functionality(struct i2c_adapter *adap)
 193 {
 194         return I2C_FUNC_SMBUS_EMUL | I2C_FUNC_10BIT_ADDR | I2C_FUNC_PROTOCOL_MANGLING;
 195 }
 196
 197
 198 /* -----exported algorithm data: -------------------------------------  */
 199
 200 static struct i2c_algorithm usbvision_algo = {
 201         .master_xfer   = usbvision_i2c_xfer,
 202         .smbus_xfer    = NULL,
 203         .algo_control  = algo_control,
 204         .functionality = functionality,
 205 };
 206
 207
 208 /* ----------------------------------------------------------------------- */
 209 /* usbvision specific I2C functions                                        */
 210 /* ----------------------------------------------------------------------- */
 211 static struct i2c_adapter i2c_adap_template;
 212 static struct i2c_client i2c_client_template;
 213
 214 int usbvision_i2c_register(struct usb_usbvision *usbvision)
 215 {
 216         int ret;
 217
 218         usbvision->i2c_adap = i2c_adap_template;
 219         usbvision->i2c_adap.dev.parent = &usbvision->dev->dev;
 220
 221         PDEBUG(DBG_I2C, "I2C   debugging is enabled [i2c]");
 222
 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);
 229                 return ret;
 230         }
 231
 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;
 235
 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");
 238                 return -EBUSY;
 239         }
 240
 241 #ifdef CONFIG_MODULES
 242         /* Request the load of the i2c modules we need */
 243         switch (usbvision_device_data[usbvision->DevModel].Codec) {
 244         case CODEC_SAA7113:
 245                 request_module("saa7115");
 246                 break;
 247         case CODEC_SAA7111:
 248                 request_module("saa7115");
 249                 break;
 250         }
 251         if (usbvision_device_data[usbvision->DevModel].Tuner == 1) {
 252                 request_module("tuner");
 253         }
 254 #endif
 255
 256         return 0;
 257 }
 258
 259 int usbvision_i2c_unregister(struct usb_usbvision *usbvision)
 260 {
 261
 262         i2c_del_adapter(&(usbvision->i2c_adap));
 263
 264         PDEBUG(DBG_I2C,"i2c bus for %s unregistered", usbvision->i2c_adap.name);
 265
 266         return 0;
 267 }
 268
 269 void call_i2c_clients(struct usb_usbvision *usbvision, unsigned int cmd,
 270                       void *arg)
 271 {
 272         i2c_clients_command(&usbvision->i2c_adap, cmd, arg);
 273 }
 274
 275 static int attach_inform(struct i2c_client *client)
 276 {
 277         struct usb_usbvision *usbvision;
 278
 279         usbvision = i2c_get_adapdata(client->adapter);
 280         switch (client->addr << 1) {
 281                 case 0x86:
 282                 case 0x43:
 283                 case 0x4b:
 284                 {
 285                         struct tuner_setup tun_setup;
 286
 287                         tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
 288                         tun_setup.type = TUNER_TDA9887;
 289                         tun_setup.addr = client->addr;
 290
 291                         call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
 292
 293                         break;
 294                 }
 295                 case 0x42:
 296                         PDEBUG(DBG_I2C,"attach_inform: saa7114 detected.");
 297                         break;
 298                 case 0x4a:
 299                         PDEBUG(DBG_I2C,"attach_inform: saa7113 detected.");
 300                         break;
 301                 case 0x48:
 302                         PDEBUG(DBG_I2C,"attach_inform: saa7111 detected.");
 303                         break;
 304                 case 0xa0:
 305                         PDEBUG(DBG_I2C,"attach_inform: eeprom detected.");
 306                         break;
 307
 308                 default:
 309                         {
 310                                 struct tuner_setup tun_setup;
 311
 312                                 PDEBUG(DBG_I2C,"attach inform: detected I2C address %x", client->addr << 1);
 313                                 usbvision->tuner_addr = client->addr;
 314
 315                                 if ((usbvision->have_tuner) && (usbvision->tuner_type != -1)) {
 316                                         tun_setup.mode_mask = T_ANALOG_TV | T_RADIO;
 317                                         tun_setup.type = usbvision->tuner_type;
 318                                         tun_setup.addr = usbvision->tuner_addr;
 319                                         call_i2c_clients(usbvision, TUNER_SET_TYPE_ADDR, &tun_setup);
 320                                 }
 321                         }
 322                         break;
 323         }
 324         return 0;
 325 }
 326
 327 static int detach_inform(struct i2c_client *client)
 328 {
 329         struct usb_usbvision *usbvision;
 330
 331         usbvision = i2c_get_adapdata(client->adapter);
 332
 333         PDEBUG(DBG_I2C,"usbvision[%d] detaches %s", usbvision->nr, client->name);
 334         return 0;
 335 }
 336
 337 static int
 338 usbvision_i2c_read_max4(struct usb_usbvision *usbvision, unsigned char addr,
 339                      char *buf, short len)
 340 {
 341         int rc, retries;
 342
 343         for (retries = 5;;) {
 344                 rc = usbvision_write_reg(usbvision, USBVISION_SER_ADRS, addr);
 345                 if (rc < 0)
 346                         return rc;
 347
 348                 /* Initiate byte read cycle                    */
 349                 /* USBVISION_SER_CONT <- d0-d2 n. of bytes to r/w */
 350                 /*                    d3 0=Wr 1=Rd             */
 351                 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
 352                                       (len & 0x07) | 0x18);
 353                 if (rc < 0)
 354                         return rc;
 355
 356                 /* Test for Busy and ACK */
 357                 do {
 358                         /* USBVISION_SER_CONT -> d4 == 0 busy */
 359                         rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
 360                 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
 361                 if (rc < 0)
 362                         return rc;
 363
 364                 /* USBVISION_SER_CONT -> d5 == 1 Not ack */
 365                 if ((rc & 0x20) == 0)   /* Ack? */
 366                         break;
 367
 368                 /* I2C abort */
 369                 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
 370                 if (rc < 0)
 371                         return rc;
 372
 373                 if (--retries < 0)
 374                         return -1;
 375         }
 376
 377         switch (len) {
 378         case 4:
 379                 buf[3] = usbvision_read_reg(usbvision, USBVISION_SER_DAT4);
 380         case 3:
 381                 buf[2] = usbvision_read_reg(usbvision, USBVISION_SER_DAT3);
 382         case 2:
 383                 buf[1] = usbvision_read_reg(usbvision, USBVISION_SER_DAT2);
 384         case 1:
 385                 buf[0] = usbvision_read_reg(usbvision, USBVISION_SER_DAT1);
 386                 break;
 387         default:
 388                 printk(KERN_ERR
 389                        "usbvision_i2c_read_max4: buffer length > 4\n");
 390         }
 391
 392         if (i2c_debug & DBG_I2C) {
 393                 int idx;
 394                 for (idx = 0; idx < len; idx++) {
 395                         PDEBUG(DBG_I2C,"read %x from address %x", (unsigned char)buf[idx], addr);
 396                 }
 397         }
 398         return len;
 399 }
 400
 401
 402 static int usbvision_i2c_write_max4(struct usb_usbvision *usbvision,
 403                                  unsigned char addr, const char *buf,
 404                                  short len)
 405 {
 406         int rc, retries;
 407         int i;
 408         unsigned char value[6];
 409         unsigned char ser_cont;
 410
 411         ser_cont = (len & 0x07) | 0x10;
 412
 413         value[0] = addr;
 414         value[1] = ser_cont;
 415         for (i = 0; i < len; i++)
 416                 value[i + 2] = buf[i];
 417
 418         for (retries = 5;;) {
 419                 rc = usb_control_msg(usbvision->dev,
 420                                      usb_sndctrlpipe(usbvision->dev, 1),
 421                                      USBVISION_OP_CODE,
 422                                      USB_DIR_OUT | USB_TYPE_VENDOR |
 423                                      USB_RECIP_ENDPOINT, 0,
 424                                      (__u16) USBVISION_SER_ADRS, value,
 425                                      len + 2, HZ);
 426
 427                 if (rc < 0)
 428                         return rc;
 429
 430                 rc = usbvision_write_reg(usbvision, USBVISION_SER_CONT,
 431                                       (len & 0x07) | 0x10);
 432                 if (rc < 0)
 433                         return rc;
 434
 435                 /* Test for Busy and ACK */
 436                 do {
 437                         rc = usbvision_read_reg(usbvision, USBVISION_SER_CONT);
 438                 } while (rc > 0 && ((rc & 0x10) != 0)); /* Retry while busy */
 439                 if (rc < 0)
 440                         return rc;
 441
 442                 if ((rc & 0x20) == 0)   /* Ack? */
 443                         break;
 444
 445                 /* I2C abort */
 446                 usbvision_write_reg(usbvision, USBVISION_SER_CONT, 0x00);
 447
 448                 if (--retries < 0)
 449                         return -1;
 450
 451         }
 452
 453         if (i2c_debug & DBG_I2C) {
 454                 int idx;
 455                 for (idx = 0; idx < len; idx++) {
 456                         PDEBUG(DBG_I2C,"wrote %x at address %x", (unsigned char)buf[idx], addr);
 457                 }
 458         }
 459         return len;
 460 }
 461
 462 static int usbvision_i2c_write(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
 463                             short len)
 464 {
 465         char *bufPtr = buf;
 466         int retval;
 467         int wrcount = 0;
 468         int count;
 469         int maxLen = 4;
 470
 471         while (len > 0) {
 472                 count = (len > maxLen) ? maxLen : len;
 473                 retval = usbvision_i2c_write_max4(usbvision, addr, bufPtr, count);
 474                 if (retval > 0) {
 475                         len -= count;
 476                         bufPtr += count;
 477                         wrcount += count;
 478                 } else
 479                         return (retval < 0) ? retval : -EFAULT;
 480         }
 481         return wrcount;
 482 }
 483
 484 static int usbvision_i2c_read(struct usb_usbvision *usbvision, unsigned char addr, char *buf,
 485                            short len)
 486 {
 487         char temp[4];
 488         int retval, i;
 489         int rdcount = 0;
 490         int count;
 491
 492         while (len > 0) {
 493                 count = (len > 3) ? 4 : len;
 494                 retval = usbvision_i2c_read_max4(usbvision, addr, temp, count);
 495                 if (retval > 0) {
 496                         for (i = 0; i < len; i++)
 497                                 buf[rdcount + i] = temp[i];
 498                         len -= count;
 499                         rdcount += count;
 500                 } else
 501                         return (retval < 0) ? retval : -EFAULT;
 502         }
 503         return rdcount;
 504 }
 505
 506 static struct i2c_adapter i2c_adap_template = {
 507         .owner = THIS_MODULE,
 508         .name              = "usbvision",
 509         .id                = I2C_HW_B_BT848, /* FIXME */
 510         .algo = &usbvision_algo,
 511         .algo_data = NULL,
 512         .client_register   = attach_inform,
 513         .client_unregister = detach_inform,
 514 #ifdef I2C_ADAP_CLASS_TV_ANALOG
 515         .class             = I2C_ADAP_CLASS_TV_ANALOG,
 516 #else
 517         .class             = I2C_CLASS_TV_ANALOG,
 518 #endif
 519 };
 520
 521 static struct i2c_client i2c_client_template = {
 522         .name           = "usbvision internal",
 523 };
 524
 525 /*
 526  * Overrides for Emacs so that we follow Linus's tabbing style.
 527  * ---------------------------------------------------------------------------
 528  * Local variables:
 529  * c-basic-offset: 8
 530  * End:
 531  */