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