blob: 665191c9b4079a2cae48f453c74832acb21d7b8d [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
Hans Verkuil1a0adaf2007-04-27 12:31:25 -030097
98/* This array should match the IVTV_HW_ defines */
Hans Verkuild9009202007-12-07 21:01:15 -030099static const u8 hw_addrs[] = {
100 IVTV_CX25840_I2C_ADDR,
101 IVTV_SAA7115_I2C_ADDR,
102 IVTV_SAA7127_I2C_ADDR,
103 IVTV_MSP3400_I2C_ADDR,
104 0,
105 IVTV_WM8775_I2C_ADDR,
106 IVTV_CS53L32A_I2C_ADDR,
107 0,
108 IVTV_SAA7115_I2C_ADDR,
109 IVTV_UPD64031A_I2C_ADDR,
110 IVTV_UPD64083_I2C_ADDR,
111 IVTV_SAA717x_I2C_ADDR,
112 IVTV_WM8739_I2C_ADDR,
113 IVTV_VP27SMPX_I2C_ADDR,
114 IVTV_M52790_I2C_ADDR,
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300115 0, /* IVTV_HW_GPIO dummy driver ID */
Andy Walls7ce5c412009-11-21 16:19:27 -0300116 IVTV_AVERMEDIA_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_AVER */
117 IVTV_HAUP_EXT_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_HAUP_EXT */
118 IVTV_HAUP_INT_IR_RX_I2C_ADDR, /* IVTV_HW_I2C_IR_RX_HAUP_INT */
119 IVTV_Z8F0811_IR_TX_I2C_ADDR, /* IVTV_HW_Z8F0811_IR_TX_HAUP */
120 IVTV_Z8F0811_IR_RX_I2C_ADDR, /* IVTV_HW_Z8F0811_IR_RX_HAUP */
Hans Verkuild9009202007-12-07 21:01:15 -0300121};
122
123/* This array should match the IVTV_HW_ defines */
Jean Delvareaf294862008-05-18 20:49:40 +0200124static const char * const hw_devicenames[] = {
Hans Verkuild9009202007-12-07 21:01:15 -0300125 "cx25840",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300126 "saa7115",
Jean Delvare5daed072008-07-17 13:18:31 -0300127 "saa7127_auto", /* saa7127 or saa7129 */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300128 "msp3400",
129 "tuner",
130 "wm8775",
131 "cs53l32a",
132 "tveeprom",
Jean Delvareaf294862008-05-18 20:49:40 +0200133 "saa7114",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300134 "upd64031a",
135 "upd64083",
136 "saa717x",
137 "wm8739",
Hans Verkuilac247432007-07-27 06:56:50 -0300138 "vp27smpx",
Hans Verkuile2a17742007-10-30 05:50:03 -0300139 "m52790",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300140 "gpio",
Andy Walls7ce5c412009-11-21 16:19:27 -0300141 "ir_video", /* IVTV_HW_I2C_IR_RX_AVER */
142 "ir_video", /* IVTV_HW_I2C_IR_RX_HAUP_EXT */
143 "ir_video", /* IVTV_HW_I2C_IR_RX_HAUP_INT */
144 "ir_tx_z8f0811_haup", /* IVTV_HW_Z8F0811_IR_TX_HAUP */
145 "ir_rx_z8f0811_haup", /* IVTV_HW_Z8F0811_IR_RX_HAUP */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300146};
147
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300148static int ivtv_i2c_new_ir(struct ivtv *itv, u32 hw, const char *type, u8 addr)
149{
150 struct i2c_board_info info;
151 struct i2c_adapter *adap = &itv->i2c_adap;
152 struct IR_i2c_init_data *init_data = &itv->ir_i2c_init_data;
153 unsigned short addr_list[2] = { addr, I2C_CLIENT_END };
154
Andy Walls7ce5c412009-11-21 16:19:27 -0300155 /* Only allow one IR transmitter to be registered per board */
156 if (hw & IVTV_HW_IR_TX_ANY) {
157 if (itv->hw_flags & IVTV_HW_IR_TX_ANY)
158 return -1;
159 memset(&info, 0, sizeof(struct i2c_board_info));
160 strlcpy(info.type, type, I2C_NAME_SIZE);
Jean Delvare9a942412010-08-11 18:20:56 +0200161 return i2c_new_probed_device(adap, &info, addr_list, NULL)
162 == NULL ? -1 : 0;
Andy Walls7ce5c412009-11-21 16:19:27 -0300163 }
164
165 /* Only allow one IR receiver to be registered per board */
166 if (itv->hw_flags & IVTV_HW_IR_RX_ANY)
167 return -1;
168
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300169 /* Our default information for ir-kbd-i2c.c to use */
170 switch (hw) {
171 case IVTV_HW_I2C_IR_RX_AVER:
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300172 init_data->ir_codes = RC_MAP_AVERMEDIA_CARDBUS;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300173 init_data->internal_get_key_func =
174 IR_KBD_GET_KEY_AVERMEDIA_CARDBUS;
175 init_data->type = IR_TYPE_OTHER;
176 init_data->name = "AVerMedia AVerTV card";
177 break;
Andy Walls7ce5c412009-11-21 16:19:27 -0300178 case IVTV_HW_I2C_IR_RX_HAUP_EXT:
179 case IVTV_HW_I2C_IR_RX_HAUP_INT:
180 /* Default to old black remote */
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300181 init_data->ir_codes = RC_MAP_RC5_TV;
Andy Walls7ce5c412009-11-21 16:19:27 -0300182 init_data->internal_get_key_func = IR_KBD_GET_KEY_HAUP;
183 init_data->type = IR_TYPE_RC5;
184 init_data->name = itv->card_name;
185 break;
186 case IVTV_HW_Z8F0811_IR_RX_HAUP:
187 /* Default to grey remote */
Mauro Carvalho Chehab02858ee2010-04-02 20:01:00 -0300188 init_data->ir_codes = RC_MAP_HAUPPAUGE_NEW;
Andy Walls7ce5c412009-11-21 16:19:27 -0300189 init_data->internal_get_key_func = IR_KBD_GET_KEY_HAUP_XVR;
190 init_data->type = IR_TYPE_RC5;
191 init_data->name = itv->card_name;
192 break;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300193 }
194
195 memset(&info, 0, sizeof(struct i2c_board_info));
196 info.platform_data = init_data;
197 strlcpy(info.type, type, I2C_NAME_SIZE);
198
Jean Delvare9a942412010-08-11 18:20:56 +0200199 return i2c_new_probed_device(adap, &info, addr_list, NULL) == NULL ?
200 -1 : 0;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300201}
202
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300203/* Instantiate the IR receiver device using probing -- undesirable */
204struct i2c_client *ivtv_i2c_new_ir_legacy(struct ivtv *itv)
205{
206 struct i2c_board_info info;
207 /*
208 * The external IR receiver is at i2c address 0x34.
209 * The internal IR receiver is at i2c address 0x30.
210 *
211 * In theory, both can be fitted, and Hauppauge suggests an external
212 * overrides an internal. That's why we probe 0x1a (~0x34) first. CB
213 *
214 * Some of these addresses we probe may collide with other i2c address
215 * allocations, so this function must be called after all other i2c
216 * devices we care about are registered.
217 */
218 const unsigned short addr_list[] = {
219 0x1a, /* Hauppauge IR external - collides with WM8739 */
220 0x18, /* Hauppauge IR internal */
221 0x71, /* Hauppauge IR (PVR150) */
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300222 0x6b, /* Adaptec IR */
223 I2C_CLIENT_END
224 };
225
226 memset(&info, 0, sizeof(struct i2c_board_info));
227 strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
Jean Delvare9a942412010-08-11 18:20:56 +0200228 return i2c_new_probed_device(&itv->i2c_adap, &info, addr_list, NULL);
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300229}
230
Hans Verkuild9009202007-12-07 21:01:15 -0300231int ivtv_i2c_register(struct ivtv *itv, unsigned idx)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300232{
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300233 struct v4l2_subdev *sd;
234 struct i2c_adapter *adap = &itv->i2c_adap;
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300235 const char *type = hw_devicenames[idx];
236 u32 hw = 1 << idx;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300237
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300238 if (idx >= ARRAY_SIZE(hw_addrs))
Hans Verkuild9009202007-12-07 21:01:15 -0300239 return -1;
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300240 if (hw == IVTV_HW_TUNER) {
241 /* special tuner handling */
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300242 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
243 itv->card_i2c->radio);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300244 if (sd)
245 sd->grp_id = 1 << idx;
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300246 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
247 itv->card_i2c->demod);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300248 if (sd)
249 sd->grp_id = 1 << idx;
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300250 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev, adap, type, 0,
251 itv->card_i2c->tv);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300252 if (sd)
253 sd->grp_id = 1 << idx;
254 return sd ? 0 : -1;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300255 }
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300256
257 if (hw & IVTV_HW_IR_ANY)
258 return ivtv_i2c_new_ir(itv, hw, type, hw_addrs[idx]);
259
260 /* Is it not an I2C device or one we do not wish to register? */
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300261 if (!hw_addrs[idx])
262 return -1;
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300263
264 /* It's an I2C device other than an analog tuner or IR chip */
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300265 if (hw == IVTV_HW_UPD64031A || hw == IVTV_HW_UPD6408X) {
Hans Verkuil53dacb12009-08-10 02:49:08 -0300266 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300267 adap, type, 0, I2C_ADDRS(hw_addrs[idx]));
Hans Verkuil72c851b2010-08-06 10:53:19 -0300268 } else if (hw == IVTV_HW_CX25840) {
269 struct cx25840_platform_data pdata;
270
271 pdata.pvr150_workaround = itv->pvr150_workaround;
272 sd = v4l2_i2c_new_subdev_cfg(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300273 adap, type, 0, &pdata, hw_addrs[idx], NULL);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300274 } else {
Hans Verkuile6574f22009-04-01 03:57:53 -0300275 sd = v4l2_i2c_new_subdev(&itv->v4l2_dev,
Laurent Pinchart9a1f8b32010-09-24 10:16:44 -0300276 adap, type, hw_addrs[idx], NULL);
Hans Verkuild9009202007-12-07 21:01:15 -0300277 }
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300278 if (sd)
279 sd->grp_id = 1 << idx;
280 return sd ? 0 : -1;
Hans Verkuild9009202007-12-07 21:01:15 -0300281}
282
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300283struct v4l2_subdev *ivtv_find_hw(struct ivtv *itv, u32 hw)
Hans Verkuild9009202007-12-07 21:01:15 -0300284{
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300285 struct v4l2_subdev *result = NULL;
286 struct v4l2_subdev *sd;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300287
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300288 spin_lock(&itv->v4l2_dev.lock);
289 v4l2_device_for_each_subdev(sd, &itv->v4l2_dev) {
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300290 if (sd->grp_id == hw) {
291 result = sd;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300292 break;
293 }
294 }
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300295 spin_unlock(&itv->v4l2_dev.lock);
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300296 return result;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300297}
298
299/* Set the serial clock line to the desired state */
300static void ivtv_setscl(struct ivtv *itv, int state)
301{
302 /* write them out */
303 /* write bits are inverted */
304 write_reg(~state, IVTV_REG_I2C_SETSCL_OFFSET);
305}
306
307/* Set the serial data line to the desired state */
308static void ivtv_setsda(struct ivtv *itv, int state)
309{
310 /* write them out */
311 /* write bits are inverted */
312 write_reg(~state & 1, IVTV_REG_I2C_SETSDA_OFFSET);
313}
314
315/* Read the serial clock line */
316static int ivtv_getscl(struct ivtv *itv)
317{
318 return read_reg(IVTV_REG_I2C_GETSCL_OFFSET) & 1;
319}
320
321/* Read the serial data line */
322static int ivtv_getsda(struct ivtv *itv)
323{
324 return read_reg(IVTV_REG_I2C_GETSDA_OFFSET) & 1;
325}
326
327/* Implement a short delay by polling the serial clock line */
328static void ivtv_scldelay(struct ivtv *itv)
329{
330 int i;
331
332 for (i = 0; i < 5; ++i)
333 ivtv_getscl(itv);
334}
335
336/* Wait for the serial clock line to become set to a specific value */
337static int ivtv_waitscl(struct ivtv *itv, int val)
338{
339 int i;
340
341 ivtv_scldelay(itv);
342 for (i = 0; i < 1000; ++i) {
343 if (ivtv_getscl(itv) == val)
344 return 1;
345 }
346 return 0;
347}
348
349/* Wait for the serial data line to become set to a specific value */
350static int ivtv_waitsda(struct ivtv *itv, int val)
351{
352 int i;
353
354 ivtv_scldelay(itv);
355 for (i = 0; i < 1000; ++i) {
356 if (ivtv_getsda(itv) == val)
357 return 1;
358 }
359 return 0;
360}
361
362/* Wait for the slave to issue an ACK */
363static int ivtv_ack(struct ivtv *itv)
364{
365 int ret = 0;
366
367 if (ivtv_getscl(itv) == 1) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300368 IVTV_DEBUG_HI_I2C("SCL was high starting an ack\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300369 ivtv_setscl(itv, 0);
370 if (!ivtv_waitscl(itv, 0)) {
371 IVTV_DEBUG_I2C("Could not set SCL low starting an ack\n");
372 return -EREMOTEIO;
373 }
374 }
375 ivtv_setsda(itv, 1);
376 ivtv_scldelay(itv);
377 ivtv_setscl(itv, 1);
378 if (!ivtv_waitsda(itv, 0)) {
379 IVTV_DEBUG_I2C("Slave did not ack\n");
380 ret = -EREMOTEIO;
381 }
382 ivtv_setscl(itv, 0);
383 if (!ivtv_waitscl(itv, 0)) {
384 IVTV_DEBUG_I2C("Failed to set SCL low after ACK\n");
385 ret = -EREMOTEIO;
386 }
387 return ret;
388}
389
390/* Write a single byte to the i2c bus and wait for the slave to ACK */
391static int ivtv_sendbyte(struct ivtv *itv, unsigned char byte)
392{
393 int i, bit;
394
Hans Verkuil11d28762007-07-17 12:47:38 -0300395 IVTV_DEBUG_HI_I2C("write %x\n",byte);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300396 for (i = 0; i < 8; ++i, byte<<=1) {
397 ivtv_setscl(itv, 0);
398 if (!ivtv_waitscl(itv, 0)) {
399 IVTV_DEBUG_I2C("Error setting SCL low\n");
400 return -EREMOTEIO;
401 }
402 bit = (byte>>7)&1;
403 ivtv_setsda(itv, bit);
404 if (!ivtv_waitsda(itv, bit)) {
405 IVTV_DEBUG_I2C("Error setting SDA\n");
406 return -EREMOTEIO;
407 }
408 ivtv_setscl(itv, 1);
409 if (!ivtv_waitscl(itv, 1)) {
410 IVTV_DEBUG_I2C("Slave not ready for bit\n");
411 return -EREMOTEIO;
412 }
413 }
414 ivtv_setscl(itv, 0);
415 if (!ivtv_waitscl(itv, 0)) {
416 IVTV_DEBUG_I2C("Error setting SCL low\n");
417 return -EREMOTEIO;
418 }
419 return ivtv_ack(itv);
420}
421
422/* Read a byte from the i2c bus and send a NACK if applicable (i.e. for the
423 final byte) */
424static int ivtv_readbyte(struct ivtv *itv, unsigned char *byte, int nack)
425{
426 int i;
427
428 *byte = 0;
429
430 ivtv_setsda(itv, 1);
431 ivtv_scldelay(itv);
432 for (i = 0; i < 8; ++i) {
433 ivtv_setscl(itv, 0);
434 ivtv_scldelay(itv);
435 ivtv_setscl(itv, 1);
436 if (!ivtv_waitscl(itv, 1)) {
437 IVTV_DEBUG_I2C("Error setting SCL high\n");
438 return -EREMOTEIO;
439 }
440 *byte = ((*byte)<<1)|ivtv_getsda(itv);
441 }
442 ivtv_setscl(itv, 0);
443 ivtv_scldelay(itv);
444 ivtv_setsda(itv, nack);
445 ivtv_scldelay(itv);
446 ivtv_setscl(itv, 1);
447 ivtv_scldelay(itv);
448 ivtv_setscl(itv, 0);
449 ivtv_scldelay(itv);
Hans Verkuil11d28762007-07-17 12:47:38 -0300450 IVTV_DEBUG_HI_I2C("read %x\n",*byte);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300451 return 0;
452}
453
454/* Issue a start condition on the i2c bus to alert slaves to prepare for
455 an address write */
456static int ivtv_start(struct ivtv *itv)
457{
458 int sda;
459
460 sda = ivtv_getsda(itv);
461 if (sda != 1) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300462 IVTV_DEBUG_HI_I2C("SDA was low at start\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300463 ivtv_setsda(itv, 1);
464 if (!ivtv_waitsda(itv, 1)) {
465 IVTV_DEBUG_I2C("SDA stuck low\n");
466 return -EREMOTEIO;
467 }
468 }
469 if (ivtv_getscl(itv) != 1) {
470 ivtv_setscl(itv, 1);
471 if (!ivtv_waitscl(itv, 1)) {
472 IVTV_DEBUG_I2C("SCL stuck low at start\n");
473 return -EREMOTEIO;
474 }
475 }
476 ivtv_setsda(itv, 0);
477 ivtv_scldelay(itv);
478 return 0;
479}
480
481/* Issue a stop condition on the i2c bus to release it */
482static int ivtv_stop(struct ivtv *itv)
483{
484 int i;
485
486 if (ivtv_getscl(itv) != 0) {
Hans Verkuil11d28762007-07-17 12:47:38 -0300487 IVTV_DEBUG_HI_I2C("SCL not low when stopping\n");
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300488 ivtv_setscl(itv, 0);
489 if (!ivtv_waitscl(itv, 0)) {
490 IVTV_DEBUG_I2C("SCL could not be set low\n");
491 }
492 }
493 ivtv_setsda(itv, 0);
494 ivtv_scldelay(itv);
495 ivtv_setscl(itv, 1);
496 if (!ivtv_waitscl(itv, 1)) {
497 IVTV_DEBUG_I2C("SCL could not be set high\n");
498 return -EREMOTEIO;
499 }
500 ivtv_scldelay(itv);
501 ivtv_setsda(itv, 1);
502 if (!ivtv_waitsda(itv, 1)) {
503 IVTV_DEBUG_I2C("resetting I2C\n");
504 for (i = 0; i < 16; ++i) {
505 ivtv_setscl(itv, 0);
506 ivtv_scldelay(itv);
507 ivtv_setscl(itv, 1);
508 ivtv_scldelay(itv);
509 ivtv_setsda(itv, 1);
510 }
511 ivtv_waitsda(itv, 1);
512 return -EREMOTEIO;
513 }
514 return 0;
515}
516
517/* Write a message to the given i2c slave. do_stop may be 0 to prevent
518 issuing the i2c stop condition (when following with a read) */
519static int ivtv_write(struct ivtv *itv, unsigned char addr, unsigned char *data, u32 len, int do_stop)
520{
521 int retry, ret = -EREMOTEIO;
522 u32 i;
523
524 for (retry = 0; ret != 0 && retry < 8; ++retry) {
525 ret = ivtv_start(itv);
526
527 if (ret == 0) {
528 ret = ivtv_sendbyte(itv, addr<<1);
529 for (i = 0; ret == 0 && i < len; ++i)
530 ret = ivtv_sendbyte(itv, data[i]);
531 }
532 if (ret != 0 || do_stop) {
533 ivtv_stop(itv);
534 }
535 }
536 if (ret)
537 IVTV_DEBUG_I2C("i2c write to %x failed\n", addr);
538 return ret;
539}
540
541/* Read data from the given i2c slave. A stop condition is always issued. */
542static int ivtv_read(struct ivtv *itv, unsigned char addr, unsigned char *data, u32 len)
543{
544 int retry, ret = -EREMOTEIO;
545 u32 i;
546
547 for (retry = 0; ret != 0 && retry < 8; ++retry) {
548 ret = ivtv_start(itv);
549 if (ret == 0)
550 ret = ivtv_sendbyte(itv, (addr << 1) | 1);
551 for (i = 0; ret == 0 && i < len; ++i) {
552 ret = ivtv_readbyte(itv, &data[i], i == len - 1);
553 }
554 ivtv_stop(itv);
555 }
556 if (ret)
557 IVTV_DEBUG_I2C("i2c read from %x failed\n", addr);
558 return ret;
559}
560
561/* Kernel i2c transfer implementation. Takes a number of messages to be read
562 or written. If a read follows a write, this will occur without an
563 intervening stop condition */
564static int ivtv_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg *msgs, int num)
565{
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300566 struct v4l2_device *v4l2_dev = i2c_get_adapdata(i2c_adap);
567 struct ivtv *itv = to_ivtv(v4l2_dev);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300568 int retval;
569 int i;
570
571 mutex_lock(&itv->i2c_bus_lock);
572 for (i = retval = 0; retval == 0 && i < num; i++) {
573 if (msgs[i].flags & I2C_M_RD)
574 retval = ivtv_read(itv, msgs[i].addr, msgs[i].buf, msgs[i].len);
575 else {
576 /* if followed by a read, don't stop */
577 int stop = !(i + 1 < num && msgs[i + 1].flags == I2C_M_RD);
578
579 retval = ivtv_write(itv, msgs[i].addr, msgs[i].buf, msgs[i].len, stop);
580 }
581 }
582 mutex_unlock(&itv->i2c_bus_lock);
583 return retval ? retval : num;
584}
585
586/* Kernel i2c capabilities */
587static u32 ivtv_functionality(struct i2c_adapter *adap)
588{
589 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
590}
591
592static struct i2c_algorithm ivtv_algo = {
593 .master_xfer = ivtv_xfer,
594 .functionality = ivtv_functionality,
595};
596
597/* template for our-bit banger */
598static struct i2c_adapter ivtv_i2c_adap_hw_template = {
599 .name = "ivtv i2c driver",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300600 .algo = &ivtv_algo,
601 .algo_data = NULL, /* filled from template */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300602 .owner = THIS_MODULE,
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300603};
604
605static void ivtv_setscl_old(void *data, int state)
606{
607 struct ivtv *itv = (struct ivtv *)data;
608
609 if (state)
610 itv->i2c_state |= 0x01;
611 else
612 itv->i2c_state &= ~0x01;
613
614 /* write them out */
615 /* write bits are inverted */
616 write_reg(~itv->i2c_state, IVTV_REG_I2C_SETSCL_OFFSET);
617}
618
619static void ivtv_setsda_old(void *data, int state)
620{
621 struct ivtv *itv = (struct ivtv *)data;
622
623 if (state)
624 itv->i2c_state |= 0x01;
625 else
626 itv->i2c_state &= ~0x01;
627
628 /* write them out */
629 /* write bits are inverted */
630 write_reg(~itv->i2c_state, IVTV_REG_I2C_SETSDA_OFFSET);
631}
632
633static int ivtv_getscl_old(void *data)
634{
635 struct ivtv *itv = (struct ivtv *)data;
636
637 return read_reg(IVTV_REG_I2C_GETSCL_OFFSET) & 1;
638}
639
640static int ivtv_getsda_old(void *data)
641{
642 struct ivtv *itv = (struct ivtv *)data;
643
644 return read_reg(IVTV_REG_I2C_GETSDA_OFFSET) & 1;
645}
646
647/* template for i2c-bit-algo */
648static struct i2c_adapter ivtv_i2c_adap_template = {
649 .name = "ivtv i2c driver",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300650 .algo = NULL, /* set by i2c-algo-bit */
651 .algo_data = NULL, /* filled from template */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300652 .owner = THIS_MODULE,
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300653};
654
Andy Wallsf412d362009-11-21 01:47:45 -0300655#define IVTV_ALGO_BIT_TIMEOUT (2) /* seconds */
656
Jean Delvareaeb292d2007-08-23 15:45:41 -0300657static const struct i2c_algo_bit_data ivtv_i2c_algo_template = {
658 .setsda = ivtv_setsda_old,
659 .setscl = ivtv_setscl_old,
660 .getsda = ivtv_getsda_old,
661 .getscl = ivtv_getscl_old,
Andy Wallsf412d362009-11-21 01:47:45 -0300662 .udelay = IVTV_DEFAULT_I2C_CLOCK_PERIOD / 2, /* microseconds */
663 .timeout = IVTV_ALGO_BIT_TIMEOUT * HZ, /* jiffies */
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300664};
665
666static struct i2c_client ivtv_i2c_client_template = {
Andrew Mortona4157832007-03-07 11:28:33 -0300667 .name = "ivtv internal",
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300668};
669
Andy Wallsbfbde8e2009-11-21 11:41:33 -0300670/* init + register i2c adapter */
Adrian Bunk056827a2007-12-11 19:23:49 -0300671int init_ivtv_i2c(struct ivtv *itv)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300672{
Jean Delvarec668f322009-05-13 16:48:50 -0300673 int retval;
674
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300675 IVTV_DEBUG_I2C("i2c init\n");
676
Hans Verkuild9009202007-12-07 21:01:15 -0300677 /* Sanity checks for the I2C hardware arrays. They must be the
Andy Wallsad2fe2d2009-11-21 12:52:34 -0300678 * same size.
Hans Verkuild9009202007-12-07 21:01:15 -0300679 */
Laurent Pinchart84d0d4f2010-09-24 09:58:51 -0300680 if (ARRAY_SIZE(hw_devicenames) != ARRAY_SIZE(hw_addrs)) {
Hans Verkuild9009202007-12-07 21:01:15 -0300681 IVTV_ERR("Mismatched I2C hardware arrays\n");
682 return -ENODEV;
683 }
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300684 if (itv->options.newi2c > 0) {
685 memcpy(&itv->i2c_adap, &ivtv_i2c_adap_hw_template,
686 sizeof(struct i2c_adapter));
687 } else {
688 memcpy(&itv->i2c_adap, &ivtv_i2c_adap_template,
689 sizeof(struct i2c_adapter));
690 memcpy(&itv->i2c_algo, &ivtv_i2c_algo_template,
691 sizeof(struct i2c_algo_bit_data));
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300692 }
Andy Wallsf412d362009-11-21 01:47:45 -0300693 itv->i2c_algo.udelay = itv->options.i2c_clock_period / 2;
Hans Verkuil0e614cd2007-12-21 21:33:36 -0300694 itv->i2c_algo.data = itv;
695 itv->i2c_adap.algo_data = &itv->i2c_algo;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300696
697 sprintf(itv->i2c_adap.name + strlen(itv->i2c_adap.name), " #%d",
Hans Verkuil67ec09f2008-11-29 19:38:23 -0300698 itv->instance);
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300699 i2c_set_adapdata(&itv->i2c_adap, &itv->v4l2_dev);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300700
701 memcpy(&itv->i2c_client, &ivtv_i2c_client_template,
702 sizeof(struct i2c_client));
703 itv->i2c_client.adapter = &itv->i2c_adap;
Hans Verkuil8ac05ae2009-02-07 07:02:27 -0300704 itv->i2c_adap.dev.parent = &itv->pdev->dev;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300705
706 IVTV_DEBUG_I2C("setting scl and sda to 1\n");
707 ivtv_setscl(itv, 1);
708 ivtv_setsda(itv, 1);
709
710 if (itv->options.newi2c > 0)
Jean Delvarec668f322009-05-13 16:48:50 -0300711 retval = i2c_add_adapter(&itv->i2c_adap);
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300712 else
Jean Delvarec668f322009-05-13 16:48:50 -0300713 retval = i2c_bit_add_bus(&itv->i2c_adap);
714
Jean Delvarec668f322009-05-13 16:48:50 -0300715 return retval;
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300716}
717
David Millerbb374b72007-10-30 21:23:48 -0700718void exit_ivtv_i2c(struct ivtv *itv)
Hans Verkuil1a0adaf2007-04-27 12:31:25 -0300719{
720 IVTV_DEBUG_I2C("i2c exit\n");
721
722 i2c_del_adapter(&itv->i2c_adap);
723}