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

   1 /*
   2  *  cx18 I2C functions
   3  *
   4  *  Derived from ivtv-i2c.c
   5  *
   6  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
   7  *  Copyright (C) 2008  Andy Walls <awalls@radix.net>
   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., 59 Temple Place, Suite 330, Boston, MA
  22  *  02111-1307  USA
  23  */
  24
  25 #include "cx18-driver.h"
  26 #include "cx18-io.h"
  27 #include "cx18-cards.h"
  28 #include "cx18-gpio.h"
  29 #include "cx18-i2c.h"
  30 #include "cx18-irq.h"
  31
  32 #define CX18_REG_I2C_1_WR   0xf15000
  33 #define CX18_REG_I2C_1_RD   0xf15008
  34 #define CX18_REG_I2C_2_WR   0xf25100
  35 #define CX18_REG_I2C_2_RD   0xf25108
  36
  37 #define SETSCL_BIT      0x0001
  38 #define SETSDL_BIT      0x0002
  39 #define GETSCL_BIT      0x0004
  40 #define GETSDL_BIT      0x0008
  41
  42 #define CX18_CS5345_I2C_ADDR            0x4c
  43
  44 /* This array should match the CX18_HW_ defines */
  45 static const u8 hw_addrs[] = {
  46         0,                      /* CX18_HW_TUNER */
  47         0,                      /* CX18_HW_TVEEPROM */
  48         CX18_CS5345_I2C_ADDR,   /* CX18_HW_CS5345 */
  49         0,                      /* CX18_HW_DVB */
  50         0,                      /* CX18_HW_418_AV */
  51         0,                      /* CX18_HW_GPIO_MUX */
  52         0,                      /* CX18_HW_GPIO_RESET_CTRL */
  53 };
  54
  55 /* This array should match the CX18_HW_ defines */
  56 /* This might well become a card-specific array */
  57 static const u8 hw_bus[] = {
  58         1,      /* CX18_HW_TUNER */
  59         0,      /* CX18_HW_TVEEPROM */
  60         0,      /* CX18_HW_CS5345 */
  61         0,      /* CX18_HW_DVB */
  62         0,      /* CX18_HW_418_AV */
  63         0,      /* CX18_HW_GPIO_MUX */
  64         0,      /* CX18_HW_GPIO_RESET_CTRL */
  65 };
  66
  67 /* This array should match the CX18_HW_ defines */
  68 static const char * const hw_modules[] = {
  69         "tuner",        /* CX18_HW_TUNER */
  70         NULL,           /* CX18_HW_TVEEPROM */
  71         "cs5345",       /* CX18_HW_CS5345 */
  72         NULL,           /* CX18_HW_DVB */
  73         NULL,           /* CX18_HW_418_AV */
  74         NULL,           /* CX18_HW_GPIO_MUX */
  75         NULL,           /* CX18_HW_GPIO_RESET_CTRL */
  76 };
  77
  78 /* This array should match the CX18_HW_ defines */
  79 static const char * const hw_devicenames[] = {
  80         "tuner",
  81         "tveeprom",
  82         "cs5345",
  83         "cx23418_DTV",
  84         "cx23418_AV",
  85         "gpio_mux",
  86         "gpio_reset_ctrl",
  87 };
  88
  89 int cx18_i2c_register(struct cx18 *cx, unsigned idx)
  90 {
  91         struct v4l2_subdev *sd;
  92         int bus = hw_bus[idx];
  93         struct i2c_adapter *adap = &cx->i2c_adap[bus];
  94         const char *mod = hw_modules[idx];
  95         const char *type = hw_devicenames[idx];
  96         u32 hw = 1 << idx;
  97
  98         if (idx >= ARRAY_SIZE(hw_addrs))
  99                 return -1;
 100
 101         if (hw == CX18_HW_TUNER) {
 102                 /* special tuner group handling */
 103                 sd = v4l2_i2c_new_probed_subdev(&cx->v4l2_dev,
 104                                 adap, mod, type, cx->card_i2c->radio);
 105                 if (sd != NULL)
 106                         sd->grp_id = hw;
 107                 sd = v4l2_i2c_new_probed_subdev(&cx->v4l2_dev,
 108                                 adap, mod, type, cx->card_i2c->demod);
 109                 if (sd != NULL)
 110                         sd->grp_id = hw;
 111                 sd = v4l2_i2c_new_probed_subdev(&cx->v4l2_dev,
 112                                 adap, mod, type, cx->card_i2c->tv);
 113                 if (sd != NULL)
 114                         sd->grp_id = hw;
 115                 return sd != NULL ? 0 : -1;
 116         }
 117
 118         /* Is it not an I2C device or one we do not wish to register? */
 119         if (!hw_addrs[idx])
 120                 return -1;
 121
 122         /* It's an I2C device other than an analog tuner */
 123         sd = v4l2_i2c_new_subdev(&cx->v4l2_dev, adap, mod, type, hw_addrs[idx]);
 124         if (sd != NULL)
 125                 sd->grp_id = hw;
 126         return sd != NULL ? 0 : -1;
 127 }
 128
 129 /* Find the first member of the subdev group id in hw */
 130 struct v4l2_subdev *cx18_find_hw(struct cx18 *cx, u32 hw)
 131 {
 132         struct v4l2_subdev *result = NULL;
 133         struct v4l2_subdev *sd;
 134
 135         spin_lock(&cx->v4l2_dev.lock);
 136         v4l2_device_for_each_subdev(sd, &cx->v4l2_dev) {
 137                 if (sd->grp_id == hw) {
 138                         result = sd;
 139                         break;
 140                 }
 141         }
 142         spin_unlock(&cx->v4l2_dev.lock);
 143         return result;
 144 }
 145
 146 static void cx18_setscl(void *data, int state)
 147 {
 148         struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
 149         int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
 150         u32 addr = bus_index ? CX18_REG_I2C_2_WR : CX18_REG_I2C_1_WR;
 151         u32 r = cx18_read_reg(cx, addr);
 152
 153         if (state)
 154                 cx18_write_reg(cx, r | SETSCL_BIT, addr);
 155         else
 156                 cx18_write_reg(cx, r & ~SETSCL_BIT, addr);
 157 }
 158
 159 static void cx18_setsda(void *data, int state)
 160 {
 161         struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
 162         int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
 163         u32 addr = bus_index ? CX18_REG_I2C_2_WR : CX18_REG_I2C_1_WR;
 164         u32 r = cx18_read_reg(cx, addr);
 165
 166         if (state)
 167                 cx18_write_reg(cx, r | SETSDL_BIT, addr);
 168         else
 169                 cx18_write_reg(cx, r & ~SETSDL_BIT, addr);
 170 }
 171
 172 static int cx18_getscl(void *data)
 173 {
 174         struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
 175         int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
 176         u32 addr = bus_index ? CX18_REG_I2C_2_RD : CX18_REG_I2C_1_RD;
 177
 178         return cx18_read_reg(cx, addr) & GETSCL_BIT;
 179 }
 180
 181 static int cx18_getsda(void *data)
 182 {
 183         struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
 184         int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
 185         u32 addr = bus_index ? CX18_REG_I2C_2_RD : CX18_REG_I2C_1_RD;
 186
 187         return cx18_read_reg(cx, addr) & GETSDL_BIT;
 188 }
 189
 190 /* template for i2c-bit-algo */
 191 static struct i2c_adapter cx18_i2c_adap_template = {
 192         .name = "cx18 i2c driver",
 193         .id = I2C_HW_B_CX2341X,
 194         .algo = NULL,                   /* set by i2c-algo-bit */
 195         .algo_data = NULL,              /* filled from template */
 196         .owner = THIS_MODULE,
 197 };
 198
 199 #define CX18_SCL_PERIOD (10) /* usecs. 10 usec is period for a 100 KHz clock */
 200 #define CX18_ALGO_BIT_TIMEOUT (2) /* seconds */
 201
 202 static struct i2c_algo_bit_data cx18_i2c_algo_template = {
 203         .setsda         = cx18_setsda,
 204         .setscl         = cx18_setscl,
 205         .getsda         = cx18_getsda,
 206         .getscl         = cx18_getscl,
 207         .udelay         = CX18_SCL_PERIOD/2,       /* 1/2 clock period in usec*/
 208         .timeout        = CX18_ALGO_BIT_TIMEOUT*HZ /* jiffies */
 209 };
 210
 211 /* init + register i2c algo-bit adapter */
 212 int init_cx18_i2c(struct cx18 *cx)
 213 {
 214         int i, err;
 215         CX18_DEBUG_I2C("i2c init\n");
 216
 217         for (i = 0; i < 2; i++) {
 218                 /* Setup algorithm for adapter */
 219                 memcpy(&cx->i2c_algo[i], &cx18_i2c_algo_template,
 220                         sizeof(struct i2c_algo_bit_data));
 221                 cx->i2c_algo_cb_data[i].cx = cx;
 222                 cx->i2c_algo_cb_data[i].bus_index = i;
 223                 cx->i2c_algo[i].data = &cx->i2c_algo_cb_data[i];
 224
 225                 /* Setup adapter */
 226                 memcpy(&cx->i2c_adap[i], &cx18_i2c_adap_template,
 227                         sizeof(struct i2c_adapter));
 228                 cx->i2c_adap[i].algo_data = &cx->i2c_algo[i];
 229                 sprintf(cx->i2c_adap[i].name + strlen(cx->i2c_adap[i].name),
 230                                 " #%d-%d", cx->instance, i);
 231                 i2c_set_adapdata(&cx->i2c_adap[i], &cx->v4l2_dev);
 232                 cx->i2c_adap[i].dev.parent = &cx->pci_dev->dev;
 233         }
 234
 235         if (cx18_read_reg(cx, CX18_REG_I2C_2_WR) != 0x0003c02f) {
 236                 /* Reset/Unreset I2C hardware block */
 237                 /* Clock select 220MHz */
 238                 cx18_write_reg_expect(cx, 0x10000000, 0xc71004,
 239                                           0x00000000, 0x10001000);
 240                 /* Clock Enable */
 241                 cx18_write_reg_expect(cx, 0x10001000, 0xc71024,
 242                                           0x00001000, 0x10001000);
 243         }
 244         /* courtesy of Steven Toth <stoth@hauppauge.com> */
 245         cx18_write_reg_expect(cx, 0x00c00000, 0xc7001c, 0x00000000, 0x00c000c0);
 246         mdelay(10);
 247         cx18_write_reg_expect(cx, 0x00c000c0, 0xc7001c, 0x000000c0, 0x00c000c0);
 248         mdelay(10);
 249         cx18_write_reg_expect(cx, 0x00c00000, 0xc7001c, 0x00000000, 0x00c000c0);
 250         mdelay(10);
 251
 252         /* Set to edge-triggered intrs. */
 253         cx18_write_reg(cx, 0x00c00000, 0xc730c8);
 254         /* Clear any stale intrs */
 255         cx18_write_reg_expect(cx, HW2_I2C1_INT|HW2_I2C2_INT, HW2_INT_CLR_STATUS,
 256                        ~(HW2_I2C1_INT|HW2_I2C2_INT), HW2_I2C1_INT|HW2_I2C2_INT);
 257
 258         /* Hw I2C1 Clock Freq ~100kHz */
 259         cx18_write_reg(cx, 0x00021c0f & ~4, CX18_REG_I2C_1_WR);
 260         cx18_setscl(&cx->i2c_algo_cb_data[0], 1);
 261         cx18_setsda(&cx->i2c_algo_cb_data[0], 1);
 262
 263         /* Hw I2C2 Clock Freq ~100kHz */
 264         cx18_write_reg(cx, 0x00021c0f & ~4, CX18_REG_I2C_2_WR);
 265         cx18_setscl(&cx->i2c_algo_cb_data[1], 1);
 266         cx18_setsda(&cx->i2c_algo_cb_data[1], 1);
 267
 268         cx18_call_hw(cx, CX18_HW_GPIO_RESET_CTRL,
 269                      core, reset, (u32) CX18_GPIO_RESET_I2C);
 270
 271         err = i2c_bit_add_bus(&cx->i2c_adap[0]);
 272         if (err)
 273                 goto err;
 274         err = i2c_bit_add_bus(&cx->i2c_adap[1]);
 275         if (err)
 276                 goto err_del_bus_0;
 277         return 0;
 278
 279  err_del_bus_0:
 280         i2c_del_adapter(&cx->i2c_adap[0]);
 281  err:
 282         return err;
 283 }
 284
 285 void exit_cx18_i2c(struct cx18 *cx)
 286 {
 287         int i;
 288         CX18_DEBUG_I2C("i2c exit\n");
 289         cx18_write_reg(cx, cx18_read_reg(cx, CX18_REG_I2C_1_WR) | 4,
 290                                                         CX18_REG_I2C_1_WR);
 291         cx18_write_reg(cx, cx18_read_reg(cx, CX18_REG_I2C_2_WR) | 4,
 292                                                         CX18_REG_I2C_2_WR);
 293
 294         for (i = 0; i < 2; i++) {
 295                 i2c_del_adapter(&cx->i2c_adap[i]);
 296         }
 297 }
 298
 299 /*
 300    Hauppauge HVR1600 should have:
 301    32 cx24227
 302    98 unknown
 303    a0 eeprom
 304    c2 tuner
 305    e? zilog ir
 306    */