2 * Driver for the Auvitek AU0828 USB bridge
4 * Copyright (c) 2008 Steven Toth <stoth@linuxtv.org>
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.
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
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/module.h>
23 #include <linux/moduleparam.h>
24 #include <linux/init.h>
25 #include <linux/delay.h>
29 #include "media/tuner.h"
30 #include <media/v4l2-common.h>
33 module_param(i2c_scan, int, 0444);
34 MODULE_PARM_DESC(i2c_scan, "scan i2c bus at insmod time");
36 #define I2C_WAIT_DELAY 25
37 #define I2C_WAIT_RETRY 1000
39 static inline int i2c_slave_did_write_ack(struct i2c_adapter *i2c_adap)
41 struct au0828_dev *dev = i2c_adap->algo_data;
42 return au0828_read(dev, AU0828_I2C_STATUS_201) &
43 AU0828_I2C_STATUS_NO_WRITE_ACK ? 0 : 1;
46 static inline int i2c_slave_did_read_ack(struct i2c_adapter *i2c_adap)
48 struct au0828_dev *dev = i2c_adap->algo_data;
49 return au0828_read(dev, AU0828_I2C_STATUS_201) &
50 AU0828_I2C_STATUS_NO_READ_ACK ? 0 : 1;
53 static int i2c_wait_read_ack(struct i2c_adapter *i2c_adap)
57 for (count = 0; count < I2C_WAIT_RETRY; count++) {
58 if (!i2c_slave_did_read_ack(i2c_adap))
60 udelay(I2C_WAIT_DELAY);
63 if (I2C_WAIT_RETRY == count)
69 static inline int i2c_is_read_busy(struct i2c_adapter *i2c_adap)
71 struct au0828_dev *dev = i2c_adap->algo_data;
72 return au0828_read(dev, AU0828_I2C_STATUS_201) &
73 AU0828_I2C_STATUS_READ_DONE ? 0 : 1;
76 static int i2c_wait_read_done(struct i2c_adapter *i2c_adap)
80 for (count = 0; count < I2C_WAIT_RETRY; count++) {
81 if (!i2c_is_read_busy(i2c_adap))
83 udelay(I2C_WAIT_DELAY);
86 if (I2C_WAIT_RETRY == count)
92 static inline int i2c_is_write_done(struct i2c_adapter *i2c_adap)
94 struct au0828_dev *dev = i2c_adap->algo_data;
95 return au0828_read(dev, AU0828_I2C_STATUS_201) &
96 AU0828_I2C_STATUS_WRITE_DONE ? 1 : 0;
99 static int i2c_wait_write_done(struct i2c_adapter *i2c_adap)
103 for (count = 0; count < I2C_WAIT_RETRY; count++) {
104 if (i2c_is_write_done(i2c_adap))
106 udelay(I2C_WAIT_DELAY);
109 if (I2C_WAIT_RETRY == count)
115 static inline int i2c_is_busy(struct i2c_adapter *i2c_adap)
117 struct au0828_dev *dev = i2c_adap->algo_data;
118 return au0828_read(dev, AU0828_I2C_STATUS_201) &
119 AU0828_I2C_STATUS_BUSY ? 1 : 0;
122 static int i2c_wait_done(struct i2c_adapter *i2c_adap)
126 for (count = 0; count < I2C_WAIT_RETRY; count++) {
127 if (!i2c_is_busy(i2c_adap))
129 udelay(I2C_WAIT_DELAY);
132 if (I2C_WAIT_RETRY == count)
138 /* FIXME: Implement join handling correctly */
139 static int i2c_sendbytes(struct i2c_adapter *i2c_adap,
140 const struct i2c_msg *msg, int joined_rlen)
143 struct au0828_dev *dev = i2c_adap->algo_data;
144 u8 i2c_speed = dev->board.i2c_clk_divider;
146 dprintk(4, "%s()\n", __func__);
148 au0828_write(dev, AU0828_I2C_MULTIBYTE_MODE_2FF, 0x01);
150 if (((dev->board.tuner_type == TUNER_XC5000) ||
151 (dev->board.tuner_type == TUNER_XC5000C)) &&
152 (dev->board.tuner_addr == msg->addr)) {
154 * Due to I2C clock stretch, we need to use a lower speed
155 * on xc5000 for commands. However, firmware transfer can
156 * speed up to 400 KHz.
159 i2c_speed = AU0828_I2C_CLK_250KHZ;
161 i2c_speed = AU0828_I2C_CLK_20KHZ;
163 /* Set the I2C clock */
164 au0828_write(dev, AU0828_I2C_CLK_DIVIDER_202, i2c_speed);
166 /* Hardware needs 8 bit addresses */
167 au0828_write(dev, AU0828_I2C_DEST_ADDR_203, msg->addr << 1);
169 dprintk(4, "SEND: %02x\n", msg->addr);
171 /* Deal with i2c_scan */
173 /* The analog tuner detection code makes use of the SMBUS_QUICK
174 message (which involves a zero length i2c write). To avoid
175 checking the status register when we didn't strobe out any
176 actual bytes to the bus, just do a read check. This is
177 consistent with how I saw i2c device checking done in the
178 USB trace of the Windows driver */
179 au0828_write(dev, AU0828_I2C_TRIGGER_200,
180 AU0828_I2C_TRIGGER_READ);
182 if (!i2c_wait_done(i2c_adap))
185 if (i2c_wait_read_ack(i2c_adap))
191 for (i = 0; i < msg->len;) {
193 dprintk(4, " %02x\n", msg->buf[i]);
195 au0828_write(dev, AU0828_I2C_WRITE_FIFO_205, msg->buf[i]);
200 if ((strobe >= 4) || (i >= msg->len)) {
202 /* Strobe the byte into the bus */
204 au0828_write(dev, AU0828_I2C_TRIGGER_200,
205 AU0828_I2C_TRIGGER_WRITE |
206 AU0828_I2C_TRIGGER_HOLD);
208 au0828_write(dev, AU0828_I2C_TRIGGER_200,
209 AU0828_I2C_TRIGGER_WRITE);
211 /* Reset strobe trigger */
214 if (!i2c_wait_write_done(i2c_adap))
220 if (!i2c_wait_done(i2c_adap))
228 /* FIXME: Implement join handling correctly */
229 static int i2c_readbytes(struct i2c_adapter *i2c_adap,
230 const struct i2c_msg *msg, int joined)
232 struct au0828_dev *dev = i2c_adap->algo_data;
233 u8 i2c_speed = dev->board.i2c_clk_divider;
236 dprintk(4, "%s()\n", __func__);
238 au0828_write(dev, AU0828_I2C_MULTIBYTE_MODE_2FF, 0x01);
241 * Due to xc5000c clock stretch, we cannot use full speed at
242 * readings from xc5000, as otherwise they'll fail.
244 if (((dev->board.tuner_type == TUNER_XC5000) ||
245 (dev->board.tuner_type == TUNER_XC5000C)) &&
246 (dev->board.tuner_addr == msg->addr))
247 i2c_speed = AU0828_I2C_CLK_20KHZ;
249 /* Set the I2C clock */
250 au0828_write(dev, AU0828_I2C_CLK_DIVIDER_202, i2c_speed);
252 /* Hardware needs 8 bit addresses */
253 au0828_write(dev, AU0828_I2C_DEST_ADDR_203, msg->addr << 1);
255 dprintk(4, " RECV:\n");
257 /* Deal with i2c_scan */
259 au0828_write(dev, AU0828_I2C_TRIGGER_200,
260 AU0828_I2C_TRIGGER_READ);
262 if (i2c_wait_read_ack(i2c_adap))
267 for (i = 0; i < msg->len;) {
272 au0828_write(dev, AU0828_I2C_TRIGGER_200,
273 AU0828_I2C_TRIGGER_READ |
274 AU0828_I2C_TRIGGER_HOLD);
276 au0828_write(dev, AU0828_I2C_TRIGGER_200,
277 AU0828_I2C_TRIGGER_READ);
279 if (!i2c_wait_read_done(i2c_adap))
282 msg->buf[i-1] = au0828_read(dev, AU0828_I2C_READ_FIFO_209) &
285 dprintk(4, " %02x\n", msg->buf[i-1]);
287 if (!i2c_wait_done(i2c_adap))
295 static int i2c_xfer(struct i2c_adapter *i2c_adap,
296 struct i2c_msg *msgs, int num)
300 dprintk(4, "%s(num = %d)\n", __func__, num);
302 for (i = 0; i < num; i++) {
303 dprintk(4, "%s(num = %d) addr = 0x%02x len = 0x%x\n",
304 __func__, num, msgs[i].addr, msgs[i].len);
305 if (msgs[i].flags & I2C_M_RD) {
307 retval = i2c_readbytes(i2c_adap, &msgs[i], 0);
308 } else if (i + 1 < num && (msgs[i + 1].flags & I2C_M_RD) &&
309 msgs[i].addr == msgs[i + 1].addr) {
310 /* write then read from same address */
311 retval = i2c_sendbytes(i2c_adap, &msgs[i],
316 retval = i2c_readbytes(i2c_adap, &msgs[i], 1);
319 retval = i2c_sendbytes(i2c_adap, &msgs[i], 0);
330 static u32 au0828_functionality(struct i2c_adapter *adap)
332 return I2C_FUNC_SMBUS_EMUL | I2C_FUNC_I2C;
335 static struct i2c_algorithm au0828_i2c_algo_template = {
336 .master_xfer = i2c_xfer,
337 .functionality = au0828_functionality,
340 /* ----------------------------------------------------------------------- */
342 static struct i2c_adapter au0828_i2c_adap_template = {
344 .owner = THIS_MODULE,
345 .algo = &au0828_i2c_algo_template,
348 static struct i2c_client au0828_i2c_client_template = {
349 .name = "au0828 internal",
352 static char *i2c_devs[128] = {
353 [0x8e >> 1] = "au8522",
354 [0xa0 >> 1] = "eeprom",
355 [0xc2 >> 1] = "tuner/xc5000",
358 static void do_i2c_scan(char *name, struct i2c_client *c)
363 for (i = 0; i < 128; i++) {
365 rc = i2c_master_recv(c, &buf, 0);
368 printk(KERN_INFO "%s: i2c scan: found device @ 0x%x [%s]\n",
369 name, i << 1, i2c_devs[i] ? i2c_devs[i] : "???");
373 /* init + register i2c adapter */
374 int au0828_i2c_register(struct au0828_dev *dev)
376 dprintk(1, "%s()\n", __func__);
378 dev->i2c_adap = au0828_i2c_adap_template;
379 dev->i2c_algo = au0828_i2c_algo_template;
380 dev->i2c_client = au0828_i2c_client_template;
382 dev->i2c_adap.dev.parent = &dev->usbdev->dev;
384 strlcpy(dev->i2c_adap.name, DRIVER_NAME,
385 sizeof(dev->i2c_adap.name));
387 dev->i2c_adap.algo = &dev->i2c_algo;
388 dev->i2c_adap.algo_data = dev;
389 #ifdef CONFIG_VIDEO_AU0828_V4L2
390 i2c_set_adapdata(&dev->i2c_adap, &dev->v4l2_dev);
392 i2c_set_adapdata(&dev->i2c_adap, dev);
394 i2c_add_adapter(&dev->i2c_adap);
396 dev->i2c_client.adapter = &dev->i2c_adap;
398 if (0 == dev->i2c_rc) {
399 printk(KERN_INFO "%s: i2c bus registered\n", DRIVER_NAME);
401 do_i2c_scan(DRIVER_NAME, &dev->i2c_client);
403 printk(KERN_INFO "%s: i2c bus register FAILED\n", DRIVER_NAME);
408 int au0828_i2c_unregister(struct au0828_dev *dev)
410 i2c_del_adapter(&dev->i2c_adap);