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