blob: bf0d35affe0beabf7db31b00dbe79593018e8212 [file] [log] [blame]
Hans Verkuil1a0adaf2007-04-27 12:31:25 -03001/*
2 I2C functions
3 Copyright (C) 2003-2004 Kevin Thayer <nufan_wfk at yahoo.com>
4 Copyright (C) 2005-2007 Hans Verkuil <hverkuil@xs4all.nl>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21/*
22 This file includes an i2c implementation that was reverse engineered
23 from the Hauppauge windows driver. Older ivtv versions used i2c-algo-bit,
24 which whilst fine under most circumstances, had trouble with the Zilog
25 CPU on the PVR-150 which handles IR functions (occasional inability to
26 communicate with the chip until it was reset) and also with the i2c
27 bus being completely unreachable when multiple PVR cards were present.
28
29 The implementation is very similar to i2c-algo-bit, but there are enough
30 subtle differences that the two are hard to merge. The general strategy
31 employed by i2c-algo-bit is to use udelay() to implement the timing
32 when putting out bits on the scl/sda lines. The general strategy taken
33 here is to poll the lines for state changes (see ivtv_waitscl and
34 ivtv_waitsda). In addition there are small delays at various locations
35 which poll the SCL line 5 times (ivtv_scldelay). I would guess that
36 since this is memory mapped I/O that the length of those delays is tied
37 to the PCI bus clock. There is some extra code to do with recovery
38 and retries. Since it is not known what causes the actual i2c problems
39 in the first place, the only goal if one was to attempt to use
40 i2c-algo-bit would be to try to make it follow the same code path.
41 This would be a lot of work, and I'm also not convinced that it would
42 provide a generic benefit to i2c-algo-bit. Therefore consider this
43 an engineering solution -- not pretty, but it works.
44
45 Some more general comments about what we are doing:
46
47 The i2c bus is a 2 wire serial bus, with clock (SCL) and data (SDA)
48 lines. To communicate on the bus (as a master, we don't act as a slave),
49 we first initiate a start condition (ivtv_start). We then write the
50 address of the device that we want to communicate with, along with a flag
51 that indicates whether this is a read or a write. The slave then issues
52 an ACK signal (ivtv_ack), which tells us that it is ready for reading /
53 writing. We then proceed with reading or writing (ivtv_read/ivtv_write),
54 and finally issue a stop condition (ivtv_stop) to make the bus available
55 to other masters.
56
57 There is an additional form of transaction where a write may be
58 immediately followed by a read. In this case, there is no intervening
59 stop condition. (Only the msp3400 chip uses this method of data transfer).
60 */
61
62#include "ivtv-driver.h"
63#include "ivtv-cards.h"
64#include "ivtv-gpio.h"
Hans Verkuil83df8e72007-03-10 06:54:58 -030065#include "ivtv-i2c.h"
Hans Verkuil72c851b2010-08-06 10:53:19 -030066#include <media/cx25840.h>
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030067
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030068/* i2c implementation for cx23415/6 chip, ivtv project.
69 * Author: Kevin Thayer (nufan_wfk at yahoo.com)
70 */
71/* i2c stuff */
72#define IVTV_REG_I2C_SETSCL_OFFSET 0x7000
73#define IVTV_REG_I2C_SETSDA_OFFSET 0x7004
74#define IVTV_REG_I2C_GETSCL_OFFSET 0x7008
75#define IVTV_REG_I2C_GETSDA_OFFSET 0x700c
76
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030077#define IVTV_CS53L32A_I2C_ADDR 0x11
Hans Verkuile2a17742007-10-30 05:50:03 -030078#define IVTV_M52790_I2C_ADDR 0x48
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030079#define IVTV_CX25840_I2C_ADDR 0x44
80#define IVTV_SAA7115_I2C_ADDR 0x21
81#define IVTV_SAA7127_I2C_ADDR 0x44
82#define IVTV_SAA717x_I2C_ADDR 0x21
83#define IVTV_MSP3400_I2C_ADDR 0x40
84#define IVTV_HAUPPAUGE_I2C_ADDR 0x50
85#define IVTV_WM8739_I2C_ADDR 0x1a
86#define IVTV_WM8775_I2C_ADDR 0x1b
87#define IVTV_TEA5767_I2C_ADDR 0x60
88#define IVTV_UPD64031A_I2C_ADDR 0x12
89#define IVTV_UPD64083_I2C_ADDR 0x5c
Hans Verkuild9009202007-12-07 21:01:15 -030090#define IVTV_VP27SMPX_I2C_ADDR 0x5b
91#define IVTV_M52790_I2C_ADDR 0x48
Andy Wallsad2fe2d2009-11-21 12:52:34 -030092#define IVTV_AVERMEDIA_IR_RX_I2C_ADDR 0x40
Andy Walls7ce5c412009-11-21 16:19:27 -030093#define IVTV_HAUP_EXT_IR_RX_I2C_ADDR 0x1a
94#define IVTV_HAUP_INT_IR_RX_I2C_ADDR 0x18
95#define IVTV_Z8F0811_IR_TX_I2C_ADDR 0x70
96#define IVTV_Z8F0811_IR_RX_I2C_ADDR 0x71
Mauro Carvalho Chehabe1e2c572010-12-30 08:31:10 -030097#define IVTV_ADAPTEC_IR_ADDR 0x6b
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030098
99/* This array should match the IVTV_HW_ defines */
Hans Verkuild9009202007-12-07 21:01:15 -0300100static const u8 hw_addrs[] = {
101 IVTV_CX25840_I2C_ADDR,
102 IVTV_SAA7115_I2C_ADDR,
103 IVTV_SAA7127_I2C_ADDR,
104 IVTV_MSP3400_I2C_ADDR,
105 0,
106 IVTV_WM8775_I2C_ADDR,
107 IVTV_CS53L32A_I2C_ADDR,
108 0,
109 IVTV_SAA7115_I2C_ADDR,
110 IVTV_UPD64031A_I2C_ADDR,
111 IVTV_UPD64083_I2C_ADDR,
112 IVTV_SAA717x_I2C_ADDR,
113 IVTV_WM8739_I2C_ADDR,
114 IVTV_VP27SMPX_I2C_ADDR,
115 IVTV_M52790_I2C_ADDR,
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300116 0, /* IVTV_HW_GPIO dummy driver ID */
Andy Walls7ce5c412009-11-21 16:19:27 -0300117 IVTV_AVERMEDIA_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_AVER */
118 IVTV_HAUP_EXT_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_HAUP_EXT */
119 IVTV_HAUP_INT_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_HAUP_INT */
120 IVTV_Z8F0811_IR_TX_I2C_ADDR, /* IVTV_HW_Z8F0811_IR_TX_HAUP */
121 IVTV_Z8F0811_IR_RX_I2C_ADDR, /* IVTV_HW_Z8F0811_IR_RX_HAUP */
Mauro Carvalho Chehabe1e2c572010-12-30 08:31:10 -0300122 IVTV_ADAPTEC_IR_ADDR, /* IVTV_HW_I2C_IR_RX_ADAPTEC */
Hans Verkuild9009202007-12-07 21:01:15 -0300123};
124
125/* This array should match the IVTV_HW_ defines */
Jean Delvareaf294862008-05-18 20:49:40 +0200126static const char * const hw_devicenames[] = {
Hans Verkuild9009202007-12-07 21:01:15 -0300127 "cx25840",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300128 "saa7115",
Jean Delvare5daed072008-07-17 13:18:31 -0300129 "saa7127_auto", /* saa7127 or saa7129 */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300130 "msp3400",
131 "tuner",
132 "wm8775",
133 "cs53l32a",
134 "tveeprom",
Jean Delvareaf294862008-05-18 20:49:40 +0200135 "saa7114",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300136 "upd64031a",
137 "upd64083",
138 "saa717x",
139 "wm8739",
Hans Verkuilac247432007-07-27 06:56:50 -0300140 "vp27smpx",
Hans Verkuile2a17742007-10-30 05:50:03 -0300141 "m52790",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300142 "gpio",
Andy Walls7ce5c412009-11-21 16:19:27 -0300143 "ir_video", /* IVTV_HW_I2C_IR_RX_AVER */
144 "ir_video", /* IVTV_HW_I2C_IR_RX_HAUP_EXT */
145 "ir_video", /* IVTV_HW_I2C_IR_RX_HAUP_INT */
146 "ir_tx_z8f0811_haup", /* IVTV_HW_Z8F0811_IR_TX_HAUP */
147 "ir_rx_z8f0811_haup", /* IVTV_HW_Z8F0811_IR_RX_HAUP */
Mauro Carvalho Chehabe1e2c572010-12-30 08:31:10 -0300148 "ir_video", /* IVTV_HW_I2C_IR_RX_ADAPTEC */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300149};
150
Mauro Carvalho Chehabe1e2c572010-12-30 08:31:10 -0300151static int get_key_adaptec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
152{
153 unsigned char keybuf[4];
154
155 keybuf[0] = 0x00;
156 i2c_master_send(ir->c, keybuf, 1);
157 /* poll IR chip */
158 if (i2c_master_recv(ir->c, keybuf, sizeof(keybuf)) != sizeof(keybuf)) {
159 return 0;
160 }
161
162 /* key pressed ? */
163 if (keybuf[2] == 0xff)
164 return 0;
165
166 /* remove repeat bit */
167 keybuf[2] &= 0x7f;
168 keybuf[3] |= 0x80;
169
170 *ir_key = (u32) keybuf;
171 *ir_raw = (u32) keybuf;
172
173 return 1;
174}
175
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300176static int ivtv_i2c_new_ir(struct ivtv *itv, u32 hw, const char *type, u8 addr)
177{
178 struct i2c_board_info info;
179 struct i2c_adapter *adap = &itv->i2c_adap;
180 struct IR_i2c_init_data *init_data = &itv->ir_i2c_init_data;
181 unsigned short addr_list[2] = { addr, I2C_CLIENT_END };
182
Andy Walls7ce5c412009-11-21 16:19:27 -0300183 /* Only allow one IR transmitter to be registered per board */
184 if (hw & IVTV_HW_IR_TX_ANY) {
185 if (itv->hw_flags & IVTV_HW_IR_TX_ANY)
186 return -1;
187 memset(&info, 0, sizeof(struct i2c_board_info));
188 strlcpy(info.type, type, I2C_NAME_SIZE);
Jean Delvare9a942412010-08-11 18:20:56 +0200189 return i2c_new_probed_device(adap, &info, addr_list, NULL)
190 == NULL ? -1 : 0;
Andy Walls7ce5c412009-11-21 16:19:27 -0300191 }
192
193 /* Only allow one IR receiver to be registered per board */
194 if (itv->hw_flags & IVTV_HW_IR_RX_ANY)
195 return -1;
196
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300197 /* Our default information for ir-kbd-i2c.c to use */
198 switch (hw) {
199 case IVTV_HW_I2C_IR_RX_AVER:
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300200 init_data->ir_codes = RC_MAP_AVERMEDIA_CARDBUS;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300201 init_data->internal_get_key_func =
202 IR_KBD_GET_KEY_AVERMEDIA_CARDBUS;
Mauro Carvalho Chehab52b66142010-11-17 14:20:52 -0300203 init_data->type = RC_TYPE_OTHER;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300204 init_data->name = "AVerMedia AVerTV card";
205 break;
Andy Walls7ce5c412009-11-21 16:19:27 -0300206 case IVTV_HW_I2C_IR_RX_HAUP_EXT:
207 case IVTV_HW_I2C_IR_RX_HAUP_INT:
208 /* Default to old black remote */
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300209 init_data->ir_codes = RC_MAP_RC5_TV;
Andy Walls7ce5c412009-11-21 16:19:27 -0300210 init_data->internal_get_key_func = IR_KBD_GET_KEY_HAUP;
Mauro Carvalho Chehab52b66142010-11-17 14:20:52 -0300211 init_data->type = RC_TYPE_RC5;
Andy Walls7ce5c412009-11-21 16:19:27 -0300212 init_data->name = itv->card_name;
213 break;
214 case IVTV_HW_Z8F0811_IR_RX_HAUP:
215 /* Default to grey remote */
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300216 init_data->ir_codes = RC_MAP_HAUPPAUGE_NEW;
Andy Walls7ce5c412009-11-21 16:19:27 -0300217 init_data->internal_get_key_func = IR_KBD_GET_KEY_HAUP_XVR;
Mauro Carvalho Chehab52b66142010-11-17 14:20:52 -0300218 init_data->type = RC_TYPE_RC5;
Andy Walls7ce5c412009-11-21 16:19:27 -0300219 init_data->name = itv->card_name;
220 break;
Mauro Carvalho Chehabe1e2c572010-12-30 08:31:10 -0300221 case IVTV_HW_I2C_IR_RX_ADAPTEC:
222 init_data->get_key = get_key_adaptec;
223 init_data->name = itv->card_name;
224 /* FIXME: The protocol and RC_MAP needs to be corrected */
225 init_data->ir_codes = RC_MAP_EMPTY;
226 init_data->type = RC_TYPE_UNKNOWN;
227 break;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300228 }
229
230 memset(&info, 0, sizeof(struct i2c_board_info));
231 info.platform_data = init_data;
232 strlcpy(info.type, type, I2C_NAME_SIZE);
233
Jean Delvare9a942412010-08-11 18:20:56 +0200234 return i2c_new_probed_device(adap, &info, addr_list, NULL) == NULL ?
235 -1 : 0;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300236}
237
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300238/* Instantiate the IR receiver device using probing -- undesirable */
239struct i2c_client *ivtv_i2c_new_ir_legacy(struct ivtv *itv)
240{
241 struct i2c_board_info info;
242 /*
243 * The external IR receiver is at i2c address 0x34.
244 * The internal IR receiver is at i2c address 0x30.
245 *
246 * In theory, both can be fitted, and Hauppauge suggests an external
247 * overrides an internal. That's why we probe 0x1a (~0x34) first. CB
248 *
249 * Some of these addresses we probe may collide with other i2c address
250 * allocations, so this function must be called after all other i2c
251 * devices we care about are registered.
252 */
253 const unsigned short addr_list[] = {
254 0x1a, /* Hauppauge IR external - collides with WM8739 */
255 0x18, /* Hauppauge IR internal */
256 0x71, /* Hauppauge IR (PVR150) */
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300257 I2C_CLIENT_END
258 };
259
260 memset(&info, 0, sizeof(struct i2c_board_info));
261 strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
Jean Delvare9a942412010-08-11 18:20:56 +0200262 return i2c_new_probed_device(&itv->i2c_adap, &info, addr_list, NULL);
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300263}
264
Hans Verkuild9009202007-12-07 21:01:15 -0300265int ivtv_i2c_register(struct ivtv *itv, unsigned idx)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300266{
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300267 struct v4l2_subdev *sd;
268 struct i2c_adapter *adap = &itv->i2c_adap;
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300269 const char *type = hw_devicenames[idx];
270 u32 hw = 1 << idx;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300271
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300272 if (idx >= ARRAY_SIZE(hw_addrs))
Hans Verkuild9009202007-12-07 21:01:15 -0300273 return -1;
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300274 if (hw == IVTV_HW_TUNER) {
275 /* special tuner handling */
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300276 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
277 itv->card_i2c->radio);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300278 if (sd)
279 sd->grp_id = 1 << idx;
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300280 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
281 itv->card_i2c->demod);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300282 if (sd)
283 sd->grp_id = 1 << idx;
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300284 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
285 itv->card_i2c->tv);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300286 if (sd)
287 sd->grp_id = 1 << idx;
288 return sd ? 0 : -1;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300289 }
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300290
291 if (hw & IVTV_HW_IR_ANY)
292 return ivtv_i2c_new_ir(itv, hw, type, hw_addrs[idx]);
293
294 /* Is it not an I2C device or one we do not wish to register? */
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300295 if (!hw_addrs[idx])
296 return -1;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300297
298 /* It's an I2C device other than an analog tuner or IR chip */
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300299 if (hw == IVTV_HW_UPD64031A || hw == IVTV_HW_UPD6408X) {
Hans Verkuil53dacb12009-08-10 02:49:08 -0300300 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300301 adap, type, 0, I2C_ADDRS(hw_addrs[idx]));
Hans Verkuil72c851b2010-08-06 10:53:19 -0300302 } else if (hw == IVTV_HW_CX25840) {
303 struct cx25840_platform_data pdata;
304
305 pdata.pvr150_workaround = itv->pvr150_workaround;
306 sd = v4l2_i2c_new_subdev_cfg(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300307 adap, type, 0, &pdata, hw_addrs[idx], NULL);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300308 } else {
Hans Verkuile6574f22009-04-01 03:57:53 -0300309 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300310 adap, type, hw_addrs[idx], NULL);
Hans Verkuild9009202007-12-07 21:01:15 -0300311 }
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300312 if (sd)
313 sd->grp_id = 1 << idx;
314 return sd ? 0 : -1;
Hans Verkuild9009202007-12-07 21:01:15 -0300315}
316
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300317struct v4l2_subdev *ivtv_find_hw(struct ivtv *itv, u32 hw)
Hans Verkuild9009202007-12-07 21:01:15 -0300318{
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300319 struct v4l2_subdev *result = NULL;
320 struct v4l2_subdev *sd;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300321
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300322 spin_lock(&itv->v4l2_dev.lock);
323 v4l2_device_for_each_subdev(sd, &itv->v4l2_dev) {
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300324 if (sd->grp_id == hw) {
325 result = sd;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300326 break;
327 }
328 }
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300329 spin_unlock(&itv->v4l2_dev.lock);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300330 return result;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300331}
332
333/* Set the serial clock line to the desired state */
334static void ivtv_setscl(struct ivtv *itv, int state)
335{
336 /* write them out */
337 /* write bits are inverted */
338 write_reg(~state, IVTV_REG_I2C_SETSCL_OFFSET);
339}
340
341/* Set the serial data line to the desired state */
342static void ivtv_setsda(struct ivtv *itv, int state)
343{
344 /* write them out */
345 /* write bits are inverted */
346 write_reg(~state & 1, IVTV_REG_I2C_SETSDA_OFFSET);
347}
348
349/* Read the serial clock line */
350static int ivtv_getscl(struct ivtv *itv)
351{
352 return read_reg(IVTV_REG_I2C_GETSCL_OFFSET) & 1;
353}
354
355/* Read the serial data line */
356static int ivtv_getsda(struct ivtv *itv)
357{
358 return read_reg(IVTV_REG_I2C_GETSDA_OFFSET) & 1;
359}
360
361/* Implement a short delay by polling the serial clock line */
362static void ivtv_scldelay(struct ivtv *itv)
363{
364 int i;
365
366 for (i = 0; i < 5; ++i)
367 ivtv_getscl(itv);
368}
369
370/* Wait for the serial clock line to become set to a specific value */
371static int ivtv_waitscl(struct ivtv *itv, int val)
372{
373 int i;
374
375 ivtv_scldelay(itv);
376 for (i = 0; i < 1000; ++i) {
377 if (ivtv_getscl(itv) == val)
378 return 1;
379 }
380 return 0;
381}
382
383/* Wait for the serial data line to become set to a specific value */
384static int ivtv_waitsda(struct ivtv *itv, int val)
385{
386 int i;
387
388 ivtv_scldelay(itv);
389 for (i = 0; i < 1000; ++i) {
390 if (ivtv_getsda(itv) == val)
391 return 1;
392 }
393 return 0;
394}
395
396/* Wait for the slave to issue an ACK */
397static int ivtv_ack(struct ivtv *itv)
398{
399 int ret = 0;
400
401 if (ivtv_getscl(itv) == 1) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300402 IVTV_DEBUG_HI_I2C("SCL was high starting an ack\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300403 ivtv_setscl(itv, 0);
404 if (!ivtv_waitscl(itv, 0)) {
405 IVTV_DEBUG_I2C("Could not set SCL low starting an ack\n");
406 return -EREMOTEIO;
407 }
408 }
409 ivtv_setsda(itv, 1);
410 ivtv_scldelay(itv);
411 ivtv_setscl(itv, 1);
412 if (!ivtv_waitsda(itv, 0)) {
413 IVTV_DEBUG_I2C("Slave did not ack\n");
414 ret = -EREMOTEIO;
415 }
416 ivtv_setscl(itv, 0);
417 if (!ivtv_waitscl(itv, 0)) {
418 IVTV_DEBUG_I2C("Failed to set SCL low after ACK\n");
419 ret = -EREMOTEIO;
420 }
421 return ret;
422}
423
424/* Write a single byte to the i2c bus and wait for the slave to ACK */
425static int ivtv_sendbyte(struct ivtv *itv, unsigned char byte)
426{
427 int i, bit;
428
Hans Verkuil11d28762007-07-17 12:47:38 -0300429 IVTV_DEBUG_HI_I2C("write %x\n",byte);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300430 for (i = 0; i < 8; ++i, byte<<=1) {
431 ivtv_setscl(itv, 0);
432 if (!ivtv_waitscl(itv, 0)) {
433 IVTV_DEBUG_I2C("Error setting SCL low\n");
434 return -EREMOTEIO;
435 }
436 bit = (byte>>7)&1;
437 ivtv_setsda(itv, bit);
438 if (!ivtv_waitsda(itv, bit)) {
439 IVTV_DEBUG_I2C("Error setting SDA\n");
440 return -EREMOTEIO;
441 }
442 ivtv_setscl(itv, 1);
443 if (!ivtv_waitscl(itv, 1)) {
444 IVTV_DEBUG_I2C("Slave not ready for bit\n");
445 return -EREMOTEIO;
446 }
447 }
448 ivtv_setscl(itv, 0);
449 if (!ivtv_waitscl(itv, 0)) {
450 IVTV_DEBUG_I2C("Error setting SCL low\n");
451 return -EREMOTEIO;
452 }
453 return ivtv_ack(itv);
454}
455
456/* Read a byte from the i2c bus and send a NACK if applicable (i.e. for the
457 final byte) */
458static int ivtv_readbyte(struct ivtv *itv, unsigned char *byte, int nack)
459{
460 int i;
461
462 *byte = 0;
463
464 ivtv_setsda(itv, 1);
465 ivtv_scldelay(itv);
466 for (i = 0; i < 8; ++i) {
467 ivtv_setscl(itv, 0);
468 ivtv_scldelay(itv);
469 ivtv_setscl(itv, 1);
470 if (!ivtv_waitscl(itv, 1)) {
471 IVTV_DEBUG_I2C("Error setting SCL high\n");
472 return -EREMOTEIO;
473 }
474 *byte = ((*byte)<<1)|ivtv_getsda(itv);
475 }
476 ivtv_setscl(itv, 0);
477 ivtv_scldelay(itv);
478 ivtv_setsda(itv, nack);
479 ivtv_scldelay(itv);
480 ivtv_setscl(itv, 1);
481 ivtv_scldelay(itv);
482 ivtv_setscl(itv, 0);
483 ivtv_scldelay(itv);
Hans Verkuil11d28762007-07-17 12:47:38 -0300484 IVTV_DEBUG_HI_I2C("read %x\n",*byte);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300485 return 0;
486}
487
488/* Issue a start condition on the i2c bus to alert slaves to prepare for
489 an address write */
490static int ivtv_start(struct ivtv *itv)
491{
492 int sda;
493
494 sda = ivtv_getsda(itv);
495 if (sda != 1) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300496 IVTV_DEBUG_HI_I2C("SDA was low at start\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300497 ivtv_setsda(itv, 1);
498 if (!ivtv_waitsda(itv, 1)) {
499 IVTV_DEBUG_I2C("SDA stuck low\n");
500 return -EREMOTEIO;
501 }
502 }
503 if (ivtv_getscl(itv) != 1) {
504 ivtv_setscl(itv, 1);
505 if (!ivtv_waitscl(itv, 1)) {
506 IVTV_DEBUG_I2C("SCL stuck low at start\n");
507 return -EREMOTEIO;
508 }
509 }
510 ivtv_setsda(itv, 0);
511 ivtv_scldelay(itv);
512 return 0;
513}
514
515/* Issue a stop condition on the i2c bus to release it */
516static int ivtv_stop(struct ivtv *itv)
517{
518 int i;
519
520 if (ivtv_getscl(itv) != 0) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300521 IVTV_DEBUG_HI_I2C("SCL not low when stopping\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300522 ivtv_setscl(itv, 0);
523 if (!ivtv_waitscl(itv, 0)) {
524 IVTV_DEBUG_I2C("SCL could not be set low\n");
525 }
526 }
527 ivtv_setsda(itv, 0);
528 ivtv_scldelay(itv);
529 ivtv_setscl(itv, 1);
530 if (!ivtv_waitscl(itv, 1)) {
531 IVTV_DEBUG_I2C("SCL could not be set high\n");
532 return -EREMOTEIO;
533 }
534 ivtv_scldelay(itv);
535 ivtv_setsda(itv, 1);
536 if (!ivtv_waitsda(itv, 1)) {
537 IVTV_DEBUG_I2C("resetting I2C\n");
538 for (i = 0; i < 16; ++i) {
539 ivtv_setscl(itv, 0);
540 ivtv_scldelay(itv);
541 ivtv_setscl(itv, 1);
542 ivtv_scldelay(itv);
543 ivtv_setsda(itv, 1);
544 }
545 ivtv_waitsda(itv, 1);
546 return -EREMOTEIO;
547 }
548 return 0;
549}
550
551/* Write a message to the given i2c slave. do_stop may be 0 to prevent
552 issuing the i2c stop condition (when following with a read) */
553static int ivtv_write(struct ivtv *itv, unsigned char addr, unsigned char *data, u32 len, int do_stop)
554{
555 int retry, ret = -EREMOTEIO;
556 u32 i;
557
558 for (retry = 0; ret != 0 && retry < 8; ++retry) {
559 ret = ivtv_start(itv);
560
561 if (ret == 0) {
562 ret = ivtv_sendbyte(itv, addr<<1);
563 for (i = 0; ret == 0 && i < len; ++i)
564 ret = ivtv_sendbyte(itv, data[i]);
565 }
566 if (ret != 0 || do_stop) {
567 ivtv_stop(itv);
568 }
569 }
570 if (ret)
571 IVTV_DEBUG_I2C("i2c write to %x failed\n", addr);
572 return ret;
573}
574
575/* Read data from the given i2c slave. A stop condition is always issued. */
576static int ivtv_read(struct ivtv *itv, unsigned char addr, unsigned char *data, u32 len)
577{
578 int retry, ret = -EREMOTEIO;
579 u32 i;
580
581 for (retry = 0; ret != 0 && retry < 8; ++retry) {
582 ret = ivtv_start(itv);
583 if (ret == 0)
584 ret = ivtv_sendbyte(itv, (addr << 1) | 1);
585 for (i = 0; ret == 0 && i < len; ++i) {
586 ret = ivtv_readbyte(itv, &data[i], i == len - 1);
587 }
588 ivtv_stop(itv);
589 }
590 if (ret)
591 IVTV_DEBUG_I2C("i2c read from %x failed\n", addr);
592 return ret;
593}
594
595/* Kernel i2c transfer implementation. Takes a number of messages to be read
596 or written. If a read follows a write, this will occur without an
597 intervening stop condition */
598static int ivtv_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg *msgs, int num)
599{
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300600 struct v4l2_device *v4l2_dev = i2c_get_adapdata(i2c_adap);
601 struct ivtv *itv = to_ivtv(v4l2_dev);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300602 int retval;
603 int i;
604
605 mutex_lock(&itv->i2c_bus_lock);
606 for (i = retval = 0; retval == 0 && i < num; i++) {
607 if (msgs[i].flags & I2C_M_RD)
608 retval = ivtv_read(itv, msgs[i].addr, msgs[i].buf, msgs[i].len);
609 else {
610 /* if followed by a read, don't stop */
611 int stop = !(i + 1 < num && msgs[i + 1].flags == I2C_M_RD);
612
613 retval = ivtv_write(itv, msgs[i].addr, msgs[i].buf, msgs[i].len, stop);
614 }
615 }
616 mutex_unlock(&itv->i2c_bus_lock);
617 return retval ? retval : num;
618}
619
620/* Kernel i2c capabilities */
621static u32 ivtv_functionality(struct i2c_adapter *adap)
622{
623 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
624}
625
626static struct i2c_algorithm ivtv_algo = {
627 .master_xfer = ivtv_xfer,
628 .functionality = ivtv_functionality,
629};
630
631/* template for our-bit banger */
632static struct i2c_adapter ivtv_i2c_adap_hw_template = {
633 .name = "ivtv i2c driver",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300634 .algo = &ivtv_algo,
635 .algo_data = NULL, /* filled from template */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300636 .owner = THIS_MODULE,
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300637};
638
639static void ivtv_setscl_old(void *data, int state)
640{
641 struct ivtv *itv = (struct ivtv *)data;
642
643 if (state)
644 itv->i2c_state |= 0x01;
645 else
646 itv->i2c_state &= ~0x01;
647
648 /* write them out */
649 /* write bits are inverted */
650 write_reg(~itv->i2c_state, IVTV_REG_I2C_SETSCL_OFFSET);
651}
652
653static void ivtv_setsda_old(void *data, int state)
654{
655 struct ivtv *itv = (struct ivtv *)data;
656
657 if (state)
658 itv->i2c_state |= 0x01;
659 else
660 itv->i2c_state &= ~0x01;
661
662 /* write them out */
663 /* write bits are inverted */
664 write_reg(~itv->i2c_state, IVTV_REG_I2C_SETSDA_OFFSET);
665}
666
667static int ivtv_getscl_old(void *data)
668{
669 struct ivtv *itv = (struct ivtv *)data;
670
671 return read_reg(IVTV_REG_I2C_GETSCL_OFFSET) & 1;
672}
673
674static int ivtv_getsda_old(void *data)
675{
676 struct ivtv *itv = (struct ivtv *)data;
677
678 return read_reg(IVTV_REG_I2C_GETSDA_OFFSET) & 1;
679}
680
681/* template for i2c-bit-algo */
682static struct i2c_adapter ivtv_i2c_adap_template = {
683 .name = "ivtv i2c driver",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300684 .algo = NULL, /* set by i2c-algo-bit */
685 .algo_data = NULL, /* filled from template */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300686 .owner = THIS_MODULE,
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300687};
688
Andy Wallsf412d362009-11-21 01:47:45 -0300689#define IVTV_ALGO_BIT_TIMEOUT (2) /* seconds */
690
Jean Delvareaeb292d2007-08-23 15:45:41 -0300691static const struct i2c_algo_bit_data ivtv_i2c_algo_template = {
692 .setsda = ivtv_setsda_old,
693 .setscl = ivtv_setscl_old,
694 .getsda = ivtv_getsda_old,
695 .getscl = ivtv_getscl_old,
Andy Wallsf412d362009-11-21 01:47:45 -0300696 .udelay = IVTV_DEFAULT_I2C_CLOCK_PERIOD / 2, /* microseconds */
697 .timeout = IVTV_ALGO_BIT_TIMEOUT * HZ, /* jiffies */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300698};
699
700static struct i2c_client ivtv_i2c_client_template = {
Andrew Mortona4157832007-03-07 11:28:33 -0300701 .name = "ivtv internal",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300702};
703
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300704/* init + register i2c adapter */
Adrian Bunk056827a2007-12-11 19:23:49 -0300705int init_ivtv_i2c(struct ivtv *itv)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300706{
Jean Delvarec668f322009-05-13 16:48:50 -0300707 int retval;
708
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300709 IVTV_DEBUG_I2C("i2c init\n");
710
Hans Verkuild9009202007-12-07 21:01:15 -0300711 /* Sanity checks for the I2C hardware arrays. They must be the
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300712 * same size.
Hans Verkuild9009202007-12-07 21:01:15 -0300713 */
Laurent Pinchart84d0d4f2010-09-24 09:58:51 -0300714 if (ARRAY_SIZE(hw_devicenames) != ARRAY_SIZE(hw_addrs)) {
Hans Verkuild9009202007-12-07 21:01:15 -0300715 IVTV_ERR("Mismatched I2C hardware arrays\n");
716 return -ENODEV;
717 }
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300718 if (itv->options.newi2c > 0) {
719 memcpy(&itv->i2c_adap, &ivtv_i2c_adap_hw_template,
720 sizeof(struct i2c_adapter));
721 } else {
722 memcpy(&itv->i2c_adap, &ivtv_i2c_adap_template,
723 sizeof(struct i2c_adapter));
724 memcpy(&itv->i2c_algo, &ivtv_i2c_algo_template,
725 sizeof(struct i2c_algo_bit_data));
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300726 }
Andy Wallsf412d362009-11-21 01:47:45 -0300727 itv->i2c_algo.udelay = itv->options.i2c_clock_period / 2;
Hans Verkuil0e614cd2007-12-21 21:33:36 -0300728 itv->i2c_algo.data = itv;
729 itv->i2c_adap.algo_data = &itv->i2c_algo;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300730
731 sprintf(itv->i2c_adap.name + strlen(itv->i2c_adap.name), " #%d",
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300732 itv->instance);
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300733 i2c_set_adapdata(&itv->i2c_adap, &itv->v4l2_dev);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300734
735 memcpy(&itv->i2c_client, &ivtv_i2c_client_template,
736 sizeof(struct i2c_client));
737 itv->i2c_client.adapter = &itv->i2c_adap;
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300738 itv->i2c_adap.dev.parent = &itv->pdev->dev;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300739
740 IVTV_DEBUG_I2C("setting scl and sda to 1\n");
741 ivtv_setscl(itv, 1);
742 ivtv_setsda(itv, 1);
743
744 if (itv->options.newi2c > 0)
Jean Delvarec668f322009-05-13 16:48:50 -0300745 retval = i2c_add_adapter(&itv->i2c_adap);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300746 else
Jean Delvarec668f322009-05-13 16:48:50 -0300747 retval = i2c_bit_add_bus(&itv->i2c_adap);
748
Jean Delvarec668f322009-05-13 16:48:50 -0300749 return retval;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300750}
751
David Millerbb374b72007-10-30 21:23:48 -0700752void exit_ivtv_i2c(struct ivtv *itv)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300753{
754 IVTV_DEBUG_I2C("i2c exit\n");
755
756 i2c_del_adapter(&itv->i2c_adap);
757}