V4L/DVB (5479): Use ARRAY_SIZE instead of a magic number
[linux-2.6.git] / drivers / media / video / saa7134 / saa7134-i2c.c
1 /*
2  *
3  * device driver for philips saa7134 based TV cards
4  * i2c interface support
5  *
6  * (c) 2001,02 Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]
7  *
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.
12  *
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.
17  *
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., 675 Mass Ave, Cambridge, MA 02139, USA.
21  */
22
23 #include <linux/init.h>
24 #include <linux/list.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/kernel.h>
28 #include <linux/slab.h>
29 #include <linux/delay.h>
30
31 #include "saa7134-reg.h"
32 #include "saa7134.h"
33 #include <media/v4l2-common.h>
34
35 /* ----------------------------------------------------------- */
36
37 static unsigned int i2c_debug = 0;
38 module_param(i2c_debug, int, 0644);
39 MODULE_PARM_DESC(i2c_debug,"enable debug messages [i2c]");
40
41 static unsigned int i2c_scan = 0;
42 module_param(i2c_scan, int, 0444);
43 MODULE_PARM_DESC(i2c_scan,"scan i2c bus at insmod time");
44
45 #define d1printk if (1 == i2c_debug) printk
46 #define d2printk if (2 == i2c_debug) printk
47
48 #define I2C_WAIT_DELAY  32
49 #define I2C_WAIT_RETRY  16
50
51 /* ----------------------------------------------------------- */
52
53 static char *str_i2c_status[] = {
54         "IDLE", "DONE_STOP", "BUSY", "TO_SCL", "TO_ARB", "DONE_WRITE",
55         "DONE_READ", "DONE_WRITE_TO", "DONE_READ_TO", "NO_DEVICE",
56         "NO_ACKN", "BUS_ERR", "ARB_LOST", "SEQ_ERR", "ST_ERR", "SW_ERR"
57 };
58
59 enum i2c_status {
60         IDLE          = 0,  // no I2C command pending
61         DONE_STOP     = 1,  // I2C command done and STOP executed
62         BUSY          = 2,  // executing I2C command
63         TO_SCL        = 3,  // executing I2C command, time out on clock stretching
64         TO_ARB        = 4,  // time out on arbitration trial, still trying
65         DONE_WRITE    = 5,  // I2C command done and awaiting next write command
66         DONE_READ     = 6,  // I2C command done and awaiting next read command
67         DONE_WRITE_TO = 7,  // see 5, and time out on status echo
68         DONE_READ_TO  = 8,  // see 6, and time out on status echo
69         NO_DEVICE     = 9,  // no acknowledge on device slave address
70         NO_ACKN       = 10, // no acknowledge after data byte transfer
71         BUS_ERR       = 11, // bus error
72         ARB_LOST      = 12, // arbitration lost during transfer
73         SEQ_ERR       = 13, // erroneous programming sequence
74         ST_ERR        = 14, // wrong status echoing
75         SW_ERR        = 15  // software error
76 };
77
78 static char *str_i2c_attr[] = {
79         "NOP", "STOP", "CONTINUE", "START"
80 };
81
82 enum i2c_attr {
83         NOP           = 0,  // no operation on I2C bus
84         STOP          = 1,  // stop condition, no associated byte transfer
85         CONTINUE      = 2,  // continue with byte transfer
86         START         = 3   // start condition with byte transfer
87 };
88
89 static inline enum i2c_status i2c_get_status(struct saa7134_dev *dev)
90 {
91         enum i2c_status status;
92
93         status = saa_readb(SAA7134_I2C_ATTR_STATUS) & 0x0f;
94         d2printk(KERN_DEBUG "%s: i2c stat <= %s\n",dev->name,
95                  str_i2c_status[status]);
96         return status;
97 }
98
99 static inline void i2c_set_status(struct saa7134_dev *dev,
100                                   enum i2c_status status)
101 {
102         d2printk(KERN_DEBUG "%s: i2c stat => %s\n",dev->name,
103                  str_i2c_status[status]);
104         saa_andorb(SAA7134_I2C_ATTR_STATUS,0x0f,status);
105 }
106
107 static inline void i2c_set_attr(struct saa7134_dev *dev, enum i2c_attr attr)
108 {
109         d2printk(KERN_DEBUG "%s: i2c attr => %s\n",dev->name,
110                  str_i2c_attr[attr]);
111         saa_andorb(SAA7134_I2C_ATTR_STATUS,0xc0,attr << 6);
112 }
113
114 static inline int i2c_is_error(enum i2c_status status)
115 {
116         switch (status) {
117         case NO_DEVICE:
118         case NO_ACKN:
119         case BUS_ERR:
120         case ARB_LOST:
121         case SEQ_ERR:
122         case ST_ERR:
123                 return true;
124         default:
125                 return false;
126         }
127 }
128
129 static inline int i2c_is_idle(enum i2c_status status)
130 {
131         switch (status) {
132         case IDLE:
133         case DONE_STOP:
134                 return true;
135         default:
136                 return false;
137         }
138 }
139
140 static inline int i2c_is_busy(enum i2c_status status)
141 {
142         switch (status) {
143         case BUSY:
144                 return true;
145         default:
146                 return false;
147         }
148 }
149
150 static int i2c_is_busy_wait(struct saa7134_dev *dev)
151 {
152         enum i2c_status status;
153         int count;
154
155         for (count = 0; count < I2C_WAIT_RETRY; count++) {
156                 status = i2c_get_status(dev);
157                 if (!i2c_is_busy(status))
158                         break;
159                 saa_wait(I2C_WAIT_DELAY);
160         }
161         if (I2C_WAIT_RETRY == count)
162                 return false;
163         return true;
164 }
165
166 static int i2c_reset(struct saa7134_dev *dev)
167 {
168         enum i2c_status status;
169         int count;
170
171         d2printk(KERN_DEBUG "%s: i2c reset\n",dev->name);
172         status = i2c_get_status(dev);
173         if (!i2c_is_error(status))
174                 return true;
175         i2c_set_status(dev,status);
176
177         for (count = 0; count < I2C_WAIT_RETRY; count++) {
178                 status = i2c_get_status(dev);
179                 if (!i2c_is_error(status))
180                         break;
181                 udelay(I2C_WAIT_DELAY);
182         }
183         if (I2C_WAIT_RETRY == count)
184                 return false;
185
186         if (!i2c_is_idle(status))
187                 return false;
188
189         i2c_set_attr(dev,NOP);
190         return true;
191 }
192
193 static inline int i2c_send_byte(struct saa7134_dev *dev,
194                                 enum i2c_attr attr,
195                                 unsigned char data)
196 {
197         enum i2c_status status;
198         __u32 dword;
199
200         /* have to write both attr + data in one 32bit word */
201         dword  = saa_readl(SAA7134_I2C_ATTR_STATUS >> 2);
202         dword &= 0x0f;
203         dword |= (attr << 6);
204         dword |= ((__u32)data << 8);
205         dword |= 0x00 << 16;  /* 100 kHz */
206 //      dword |= 0x40 << 16;  /* 400 kHz */
207         dword |= 0xf0 << 24;
208         saa_writel(SAA7134_I2C_ATTR_STATUS >> 2, dword);
209         d2printk(KERN_DEBUG "%s: i2c data => 0x%x\n",dev->name,data);
210
211         if (!i2c_is_busy_wait(dev))
212                 return -EIO;
213         status = i2c_get_status(dev);
214         if (i2c_is_error(status))
215                 return -EIO;
216         return 0;
217 }
218
219 static inline int i2c_recv_byte(struct saa7134_dev *dev)
220 {
221         enum i2c_status status;
222         unsigned char data;
223
224         i2c_set_attr(dev,CONTINUE);
225         if (!i2c_is_busy_wait(dev))
226                 return -EIO;
227         status = i2c_get_status(dev);
228         if (i2c_is_error(status))
229                 return -EIO;
230         data = saa_readb(SAA7134_I2C_DATA);
231         d2printk(KERN_DEBUG "%s: i2c data <= 0x%x\n",dev->name,data);
232         return data;
233 }
234
235 static int saa7134_i2c_xfer(struct i2c_adapter *i2c_adap,
236                             struct i2c_msg *msgs, int num)
237 {
238         struct saa7134_dev *dev = i2c_adap->algo_data;
239         enum i2c_status status;
240         unsigned char data;
241         int addr,rc,i,byte;
242
243         status = i2c_get_status(dev);
244         if (!i2c_is_idle(status))
245                 if (!i2c_reset(dev))
246                         return -EIO;
247
248         d2printk("start xfer\n");
249         d1printk(KERN_DEBUG "%s: i2c xfer:",dev->name);
250         for (i = 0; i < num; i++) {
251                 if (!(msgs[i].flags & I2C_M_NOSTART) || 0 == i) {
252                         /* send address */
253                         d2printk("send address\n");
254                         addr  = msgs[i].addr << 1;
255                         if (msgs[i].flags & I2C_M_RD)
256                                 addr |= 1;
257                         if (i > 0 && msgs[i].flags & I2C_M_RD) {
258                                 /* workaround for a saa7134 i2c bug
259                                  * needed to talk to the mt352 demux
260                                  * thanks to pinnacle for the hint */
261                                 int quirk = 0xfd;
262                                 d1printk(" [%02x quirk]",quirk);
263                                 i2c_send_byte(dev,START,quirk);
264                                 i2c_recv_byte(dev);
265                         }
266                         d1printk(" < %02x", addr);
267                         rc = i2c_send_byte(dev,START,addr);
268                         if (rc < 0)
269                                  goto err;
270                 }
271                 if (msgs[i].flags & I2C_M_RD) {
272                         /* read bytes */
273                         d2printk("read bytes\n");
274                         for (byte = 0; byte < msgs[i].len; byte++) {
275                                 d1printk(" =");
276                                 rc = i2c_recv_byte(dev);
277                                 if (rc < 0)
278                                         goto err;
279                                 d1printk("%02x", rc);
280                                 msgs[i].buf[byte] = rc;
281                         }
282                 } else {
283                         /* write bytes */
284                         d2printk("write bytes\n");
285                         for (byte = 0; byte < msgs[i].len; byte++) {
286                                 data = msgs[i].buf[byte];
287                                 d1printk(" %02x", data);
288                                 rc = i2c_send_byte(dev,CONTINUE,data);
289                                 if (rc < 0)
290                                         goto err;
291                         }
292                 }
293         }
294         d2printk("xfer done\n");
295         d1printk(" >");
296         i2c_set_attr(dev,STOP);
297         rc = -EIO;
298         if (!i2c_is_busy_wait(dev))
299                 goto err;
300         status = i2c_get_status(dev);
301         if (i2c_is_error(status))
302                 goto err;
303         /* ensure that the bus is idle for at least one bit slot */
304         msleep(1);
305
306         d1printk("\n");
307         return num;
308  err:
309         if (1 == i2c_debug) {
310                 status = i2c_get_status(dev);
311                 printk(" ERROR: %s\n",str_i2c_status[status]);
312         }
313         return rc;
314 }
315
316 /* ----------------------------------------------------------- */
317
318 static int algo_control(struct i2c_adapter *adapter,
319                         unsigned int cmd, unsigned long arg)
320 {
321         return 0;
322 }
323
324 static u32 functionality(struct i2c_adapter *adap)
325 {
326         return I2C_FUNC_SMBUS_EMUL;
327 }
328
329 static int attach_inform(struct i2c_client *client)
330 {
331         struct saa7134_dev *dev = client->adapter->algo_data;
332         int tuner = dev->tuner_type;
333         int conf  = dev->tda9887_conf;
334         struct tuner_setup tun_setup;
335
336         d1printk( "%s i2c attach [addr=0x%x,client=%s]\n",
337                 client->driver->driver.name, client->addr, client->name);
338
339         /* Am I an i2c remote control? */
340
341         switch (client->addr) {
342                 case 0x7a:
343                 case 0x47:
344                 case 0x71:
345                 {
346                         struct IR_i2c *ir = i2c_get_clientdata(client);
347                         d1printk("%s i2c IR detected (%s).\n",
348                                  client->driver->driver.name, ir->phys);
349                         saa7134_set_i2c_ir(dev,ir);
350                         break;
351                 }
352         }
353
354         if (!client->driver->command)
355                 return 0;
356
357         if (saa7134_boards[dev->board].radio_type != UNSET) {
358
359                 tun_setup.type = saa7134_boards[dev->board].radio_type;
360                 tun_setup.addr = saa7134_boards[dev->board].radio_addr;
361
362                 if ((tun_setup.addr == ADDR_UNSET) || (tun_setup.addr == client->addr)) {
363                         tun_setup.mode_mask = T_RADIO;
364
365                         client->driver->command(client, TUNER_SET_TYPE_ADDR, &tun_setup);
366                 }
367         }
368
369         if (tuner != UNSET) {
370
371                 tun_setup.type = tuner;
372                 tun_setup.addr = saa7134_boards[dev->board].tuner_addr;
373                 tun_setup.config = saa7134_boards[dev->board].tuner_config;
374                 tun_setup.tuner_callback = saa7134_tuner_callback;
375
376                 if ((tun_setup.addr == ADDR_UNSET)||(tun_setup.addr == client->addr)) {
377
378                         tun_setup.mode_mask = T_ANALOG_TV;
379
380                         client->driver->command(client,TUNER_SET_TYPE_ADDR, &tun_setup);
381                 }
382         }
383
384         client->driver->command(client, TDA9887_SET_CONFIG, &conf);
385
386         return 0;
387 }
388
389 static struct i2c_algorithm saa7134_algo = {
390         .master_xfer   = saa7134_i2c_xfer,
391         .algo_control  = algo_control,
392         .functionality = functionality,
393 };
394
395 static struct i2c_adapter saa7134_adap_template = {
396         .owner         = THIS_MODULE,
397         .class         = I2C_CLASS_TV_ANALOG,
398         .name          = "saa7134",
399         .id            = I2C_HW_SAA7134,
400         .algo          = &saa7134_algo,
401         .client_register = attach_inform,
402 };
403
404 static struct i2c_client saa7134_client_template = {
405         .name   = "saa7134 internal",
406 };
407
408 /* ----------------------------------------------------------- */
409
410 static int
411 saa7134_i2c_eeprom(struct saa7134_dev *dev, unsigned char *eedata, int len)
412 {
413         unsigned char buf;
414         int i,err;
415
416         dev->i2c_client.addr = 0xa0 >> 1;
417         buf = 0;
418         if (1 != (err = i2c_master_send(&dev->i2c_client,&buf,1))) {
419                 printk(KERN_INFO "%s: Huh, no eeprom present (err=%d)?\n",
420                        dev->name,err);
421                 return -1;
422         }
423         if (len != (err = i2c_master_recv(&dev->i2c_client,eedata,len))) {
424                 printk(KERN_WARNING "%s: i2c eeprom read error (err=%d)\n",
425                        dev->name,err);
426                 return -1;
427         }
428         for (i = 0; i < len; i++) {
429                 if (0 == (i % 16))
430                         printk(KERN_INFO "%s: i2c eeprom %02x:",dev->name,i);
431                 printk(" %02x",eedata[i]);
432                 if (15 == (i % 16))
433                         printk("\n");
434         }
435         return 0;
436 }
437
438 static char *i2c_devs[128] = {
439         [ 0x20      ] = "mpeg encoder (saa6752hs)",
440         [ 0xa0 >> 1 ] = "eeprom",
441         [ 0xc0 >> 1 ] = "tuner (analog)",
442         [ 0x86 >> 1 ] = "tda9887",
443 };
444
445 static void do_i2c_scan(char *name, struct i2c_client *c)
446 {
447         unsigned char buf;
448         int i,rc;
449
450         for (i = 0; i < ARRAY_SIZE(i2c_devs); i++) {
451                 c->addr = i;
452                 rc = i2c_master_recv(c,&buf,0);
453                 if (rc < 0)
454                         continue;
455                 printk("%s: i2c scan: found device @ 0x%x  [%s]\n",
456                        name, i << 1, i2c_devs[i] ? i2c_devs[i] : "???");
457         }
458 }
459
460 void saa7134_i2c_call_clients(struct saa7134_dev *dev,
461                               unsigned int cmd, void *arg)
462 {
463         BUG_ON(NULL == dev->i2c_adap.algo_data);
464         i2c_clients_command(&dev->i2c_adap, cmd, arg);
465 }
466
467 int saa7134_i2c_register(struct saa7134_dev *dev)
468 {
469         dev->i2c_adap = saa7134_adap_template;
470         dev->i2c_adap.dev.parent = &dev->pci->dev;
471         strcpy(dev->i2c_adap.name,dev->name);
472         dev->i2c_adap.algo_data = dev;
473         i2c_add_adapter(&dev->i2c_adap);
474
475         dev->i2c_client = saa7134_client_template;
476         dev->i2c_client.adapter = &dev->i2c_adap;
477
478         saa7134_i2c_eeprom(dev,dev->eedata,sizeof(dev->eedata));
479         if (i2c_scan)
480                 do_i2c_scan(dev->name,&dev->i2c_client);
481         return 0;
482 }
483
484 int saa7134_i2c_unregister(struct saa7134_dev *dev)
485 {
486         i2c_del_adapter(&dev->i2c_adap);
487         return 0;
488 }
489
490 /* ----------------------------------------------------------- */
491 /*
492  * Local variables:
493  * c-basic-offset: 8
494  * End:
495  */