4 * Derived from ivtv-i2c.c
6 * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
24 #include "cx18-driver.h"
25 #include "cx18-cards.h"
26 #include "cx18-gpio.h"
27 #include "cx18-av-core.h"
30 #include <media/ir-kbd-i2c.h>
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
37 #define SETSCL_BIT 0x0001
38 #define SETSDL_BIT 0x0002
39 #define GETSCL_BIT 0x0004
40 #define GETSDL_BIT 0x0008
42 #ifndef I2C_ADAP_CLASS_TV_ANALOG
43 #define I2C_ADAP_CLASS_TV_ANALOG I2C_CLASS_TV_ANALOG
46 #define CX18_CS5345_I2C_ADDR 0x4c
48 /* This array should match the CX18_HW_ defines */
49 static const u8 hw_driverids[] = {
51 I2C_DRIVERID_TVEEPROM,
53 0, /* CX18_HW_GPIO dummy driver ID */
54 0 /* CX18_HW_CX23418 dummy driver ID */
57 /* This array should match the CX18_HW_ defines */
58 static const u8 hw_addrs[] = {
62 0, /* CX18_HW_GPIO dummy driver ID */
63 0, /* CX18_HW_CX23418 dummy driver ID */
66 /* This array should match the CX18_HW_ defines */
67 /* This might well become a card-specific array */
68 static const u8 hw_bus[] = {
72 0, /* CX18_HW_GPIO dummy driver ID */
73 0, /* CX18_HW_CX23418 dummy driver ID */
76 /* This array should match the CX18_HW_ defines */
77 static const char * const hw_drivernames[] = {
85 int cx18_i2c_register(struct cx18 *cx, unsigned idx)
87 struct i2c_board_info info;
92 CX18_DEBUG_I2C("i2c client register\n");
93 if (idx >= ARRAY_SIZE(hw_driverids) || hw_driverids[idx] == 0)
95 id = hw_driverids[idx];
97 memset(&info, 0, sizeof(info));
98 strlcpy(info.driver_name, hw_drivernames[idx],
99 sizeof(info.driver_name));
100 info.addr = hw_addrs[idx];
101 for (i = 0; i < I2C_CLIENTS_MAX; i++)
102 if (cx->i2c_clients[i] == NULL)
105 if (i == I2C_CLIENTS_MAX) {
106 CX18_ERR("insufficient room for new I2C client!\n");
110 if (id != I2C_DRIVERID_TUNER) {
111 c = i2c_new_device(&cx->i2c_adap[bus], &info);
112 if (c->driver == NULL)
113 i2c_unregister_device(c);
115 cx->i2c_clients[i] = c;
116 return cx->i2c_clients[i] ? 0 : -ENODEV;
119 /* special tuner handling */
120 c = i2c_new_probed_device(&cx->i2c_adap[1], &info, cx->card_i2c->radio);
121 if (c && c->driver == NULL)
122 i2c_unregister_device(c);
124 cx->i2c_clients[i++] = c;
125 c = i2c_new_probed_device(&cx->i2c_adap[1], &info, cx->card_i2c->demod);
126 if (c && c->driver == NULL)
127 i2c_unregister_device(c);
129 cx->i2c_clients[i++] = c;
130 c = i2c_new_probed_device(&cx->i2c_adap[1], &info, cx->card_i2c->tv);
131 if (c && c->driver == NULL)
132 i2c_unregister_device(c);
134 cx->i2c_clients[i++] = c;
138 static int attach_inform(struct i2c_client *client)
143 static int detach_inform(struct i2c_client *client)
146 struct cx18 *cx = (struct cx18 *)i2c_get_adapdata(client->adapter);
148 CX18_DEBUG_I2C("i2c client detach\n");
149 for (i = 0; i < I2C_CLIENTS_MAX; i++) {
150 if (cx->i2c_clients[i] == client) {
151 cx->i2c_clients[i] = NULL;
155 CX18_DEBUG_I2C("i2c detach [client=%s,%s]\n",
156 client->name, (i < I2C_CLIENTS_MAX) ? "ok" : "failed");
161 static void cx18_setscl(void *data, int state)
163 struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
164 int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
165 u32 addr = bus_index ? CX18_REG_I2C_2_WR : CX18_REG_I2C_1_WR;
166 u32 r = read_reg(addr);
169 write_reg_sync(r | SETSCL_BIT, addr);
171 write_reg_sync(r & ~SETSCL_BIT, addr);
174 static void cx18_setsda(void *data, int state)
176 struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
177 int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
178 u32 addr = bus_index ? CX18_REG_I2C_2_WR : CX18_REG_I2C_1_WR;
179 u32 r = read_reg(addr);
182 write_reg_sync(r | SETSDL_BIT, addr);
184 write_reg_sync(r & ~SETSDL_BIT, addr);
187 static int cx18_getscl(void *data)
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_RD : CX18_REG_I2C_1_RD;
193 return read_reg(addr) & GETSCL_BIT;
196 static int cx18_getsda(void *data)
198 struct cx18 *cx = ((struct cx18_i2c_algo_callback_data *)data)->cx;
199 int bus_index = ((struct cx18_i2c_algo_callback_data *)data)->bus_index;
200 u32 addr = bus_index ? CX18_REG_I2C_2_RD : CX18_REG_I2C_1_RD;
202 return read_reg(addr) & GETSDL_BIT;
205 /* template for i2c-bit-algo */
206 static struct i2c_adapter cx18_i2c_adap_template = {
207 .name = "cx18 i2c driver",
208 .id = I2C_HW_B_CX2341X,
209 .algo = NULL, /* set by i2c-algo-bit */
210 .algo_data = NULL, /* filled from template */
211 .client_register = attach_inform,
212 .client_unregister = detach_inform,
213 .owner = THIS_MODULE,
216 #define CX18_SCL_PERIOD (10) /* usecs. 10 usec is period for a 100 KHz clock */
217 #define CX18_ALGO_BIT_TIMEOUT (2) /* seconds */
219 static struct i2c_algo_bit_data cx18_i2c_algo_template = {
220 .setsda = cx18_setsda,
221 .setscl = cx18_setscl,
222 .getsda = cx18_getsda,
223 .getscl = cx18_getscl,
224 .udelay = CX18_SCL_PERIOD/2, /* 1/2 clock period in usec*/
225 .timeout = CX18_ALGO_BIT_TIMEOUT*HZ /* jiffies */
228 static struct i2c_client cx18_i2c_client_template = {
229 .name = "cx18 internal",
232 int cx18_call_i2c_client(struct cx18 *cx, int addr, unsigned cmd, void *arg)
234 struct i2c_client *client;
238 CX18_DEBUG_I2C("call_i2c_client addr=%02x\n", addr);
239 for (i = 0; i < I2C_CLIENTS_MAX; i++) {
240 client = cx->i2c_clients[i];
241 if (client == NULL || client->driver == NULL ||
242 client->driver->command == NULL)
244 if (addr == client->addr) {
245 retval = client->driver->command(client, cmd, arg);
249 if (cmd != VIDIOC_G_CHIP_IDENT)
250 CX18_ERR("i2c addr 0x%02x not found for cmd 0x%x!\n",
255 /* Find the i2c device based on the driver ID and return
256 its i2c address or -ENODEV if no matching device was found. */
257 static int cx18_i2c_id_addr(struct cx18 *cx, u32 id)
259 struct i2c_client *client;
260 int retval = -ENODEV;
263 for (i = 0; i < I2C_CLIENTS_MAX; i++) {
264 client = cx->i2c_clients[i];
265 if (client == NULL || client->driver == NULL)
267 if (id == client->driver->id) {
268 retval = client->addr;
275 /* Find the i2c device name matching the DRIVERID */
276 static const char *cx18_i2c_id_name(u32 id)
280 for (i = 0; i < ARRAY_SIZE(hw_driverids); i++)
281 if (hw_driverids[i] == id)
282 return hw_drivernames[i];
283 return "unknown device";
286 /* Find the i2c device name matching the CX18_HW_ flag */
287 static const char *cx18_i2c_hw_name(u32 hw)
291 for (i = 0; i < ARRAY_SIZE(hw_driverids); i++)
293 return hw_drivernames[i];
294 return "unknown device";
297 /* Find the i2c device matching the CX18_HW_ flag and return
298 its i2c address or -ENODEV if no matching device was found. */
299 int cx18_i2c_hw_addr(struct cx18 *cx, u32 hw)
303 for (i = 0; i < ARRAY_SIZE(hw_driverids); i++)
305 return cx18_i2c_id_addr(cx, hw_driverids[i]);
309 /* Calls i2c device based on CX18_HW_ flag. If hw == 0, then do nothing.
310 If hw == CX18_HW_GPIO then call the gpio handler. */
311 int cx18_i2c_hw(struct cx18 *cx, u32 hw, unsigned int cmd, void *arg)
315 if (hw == CX18_HW_GPIO || hw == 0)
317 if (hw == CX18_HW_CX23418)
318 return cx18_av_cmd(cx, cmd, arg);
320 addr = cx18_i2c_hw_addr(cx, hw);
322 CX18_ERR("i2c hardware 0x%08x (%s) not found for cmd 0x%x!\n",
323 hw, cx18_i2c_hw_name(hw), cmd);
326 return cx18_call_i2c_client(cx, addr, cmd, arg);
329 /* Calls i2c device based on I2C driver ID. */
330 int cx18_i2c_id(struct cx18 *cx, u32 id, unsigned int cmd, void *arg)
334 addr = cx18_i2c_id_addr(cx, id);
336 if (cmd != VIDIOC_G_CHIP_IDENT)
337 CX18_ERR("i2c ID 0x%08x (%s) not found for cmd 0x%x!\n",
338 id, cx18_i2c_id_name(id), cmd);
341 return cx18_call_i2c_client(cx, addr, cmd, arg);
344 /* broadcast cmd for all I2C clients and for the gpio subsystem */
345 void cx18_call_i2c_clients(struct cx18 *cx, unsigned int cmd, void *arg)
347 if (cx->i2c_adap[0].algo == NULL || cx->i2c_adap[1].algo == NULL) {
348 CX18_ERR("adapter is not set\n");
351 cx18_av_cmd(cx, cmd, arg);
352 i2c_clients_command(&cx->i2c_adap[0], cmd, arg);
353 i2c_clients_command(&cx->i2c_adap[1], cmd, arg);
356 /* init + register i2c algo-bit adapter */
357 int init_cx18_i2c(struct cx18 *cx)
360 CX18_DEBUG_I2C("i2c init\n");
362 for (i = 0; i < 2; i++) {
363 memcpy(&cx->i2c_adap[i], &cx18_i2c_adap_template,
364 sizeof(struct i2c_adapter));
365 memcpy(&cx->i2c_algo[i], &cx18_i2c_algo_template,
366 sizeof(struct i2c_algo_bit_data));
367 cx->i2c_algo_cb_data[i].cx = cx;
368 cx->i2c_algo_cb_data[i].bus_index = i;
369 cx->i2c_algo[i].data = &cx->i2c_algo_cb_data[i];
370 cx->i2c_adap[i].algo_data = &cx->i2c_algo[i];
372 sprintf(cx->i2c_adap[i].name + strlen(cx->i2c_adap[i].name),
373 " #%d-%d", cx->num, i);
374 i2c_set_adapdata(&cx->i2c_adap[i], cx);
376 memcpy(&cx->i2c_client[i], &cx18_i2c_client_template,
377 sizeof(struct i2c_client));
378 sprintf(cx->i2c_client[i].name +
379 strlen(cx->i2c_client[i].name), "%d", i);
380 cx->i2c_client[i].adapter = &cx->i2c_adap[i];
381 cx->i2c_adap[i].dev.parent = &cx->dev->dev;
384 if (read_reg(CX18_REG_I2C_2_WR) != 0x0003c02f) {
385 /* Reset/Unreset I2C hardware block */
386 write_reg(0x10000000, 0xc71004); /* Clock select 220MHz */
387 write_reg_sync(0x10001000, 0xc71024); /* Clock Enable */
389 /* courtesy of Steven Toth <stoth@hauppauge.com> */
390 write_reg_sync(0x00c00000, 0xc7001c);
392 write_reg_sync(0x00c000c0, 0xc7001c);
394 write_reg_sync(0x00c00000, 0xc7001c);
396 write_reg_sync(0x00c00000, 0xc730c8); /* Set to edge-triggered intrs. */
397 write_reg_sync(0x00c00000, 0xc730c4); /* Clear any stale intrs */
399 /* Hw I2C1 Clock Freq ~100kHz */
400 write_reg_sync(0x00021c0f & ~4, CX18_REG_I2C_1_WR);
401 cx18_setscl(&cx->i2c_algo_cb_data[0], 1);
402 cx18_setsda(&cx->i2c_algo_cb_data[0], 1);
404 /* Hw I2C2 Clock Freq ~100kHz */
405 write_reg_sync(0x00021c0f & ~4, CX18_REG_I2C_2_WR);
406 cx18_setscl(&cx->i2c_algo_cb_data[1], 1);
407 cx18_setsda(&cx->i2c_algo_cb_data[1], 1);
409 return i2c_bit_add_bus(&cx->i2c_adap[0]) ||
410 i2c_bit_add_bus(&cx->i2c_adap[1]);
413 void exit_cx18_i2c(struct cx18 *cx)
416 CX18_DEBUG_I2C("i2c exit\n");
417 write_reg(read_reg(CX18_REG_I2C_1_WR) | 4, CX18_REG_I2C_1_WR);
418 write_reg(read_reg(CX18_REG_I2C_2_WR) | 4, CX18_REG_I2C_2_WR);
420 for (i = 0; i < 2; i++) {
421 i2c_del_adapter(&cx->i2c_adap[i]);
426 Hauppauge HVR1600 should have: