V4L/DVB (6127): tuner: kill i2c_client interface to tuner sub-drivers
[safe/jmp/linux-2.6] / drivers / media / video / tea5767.c
1 /*
2  * For Philips TEA5767 FM Chip used on some TV Cards like Prolink Pixelview
3  * I2C address is allways 0xC0.
4  *
5  *
6  * Copyright (c) 2005 Mauro Carvalho Chehab (mchehab@infradead.org)
7  * This code is placed under the terms of the GNU General Public License
8  *
9  * tea5767 autodetection thanks to Torsten Seeboth and Atsushi Nakagawa
10  * from their contributions on DScaler.
11  */
12
13 #include <linux/i2c.h>
14 #include <linux/delay.h>
15 #include <linux/videodev.h>
16 #include "tuner-driver.h"
17
18 #define PREFIX "TEA5767 "
19
20 /* from tuner-core.c */
21 extern int tuner_debug;
22
23 struct tea5767_priv {
24         struct tuner_i2c_props i2c_props;
25 };
26
27 /*****************************************************************************/
28
29 /******************************
30  * Write mode register values *
31  ******************************/
32
33 /* First register */
34 #define TEA5767_MUTE            0x80    /* Mutes output */
35 #define TEA5767_SEARCH          0x40    /* Activates station search */
36 /* Bits 0-5 for divider MSB */
37
38 /* Second register */
39 /* Bits 0-7 for divider LSB */
40
41 /* Third register */
42
43 /* Station search from botton to up */
44 #define TEA5767_SEARCH_UP       0x80
45
46 /* Searches with ADC output = 10 */
47 #define TEA5767_SRCH_HIGH_LVL   0x60
48
49 /* Searches with ADC output = 10 */
50 #define TEA5767_SRCH_MID_LVL    0x40
51
52 /* Searches with ADC output = 5 */
53 #define TEA5767_SRCH_LOW_LVL    0x20
54
55 /* if on, div=4*(Frf+Fif)/Fref otherwise, div=4*(Frf-Fif)/Freq) */
56 #define TEA5767_HIGH_LO_INJECT  0x10
57
58 /* Disable stereo */
59 #define TEA5767_MONO            0x08
60
61 /* Disable right channel and turns to mono */
62 #define TEA5767_MUTE_RIGHT      0x04
63
64 /* Disable left channel and turns to mono */
65 #define TEA5767_MUTE_LEFT       0x02
66
67 #define TEA5767_PORT1_HIGH      0x01
68
69 /* Fourth register */
70 #define TEA5767_PORT2_HIGH      0x80
71 /* Chips stops working. Only I2C bus remains on */
72 #define TEA5767_STDBY           0x40
73
74 /* Japan freq (76-108 MHz. If disabled, 87.5-108 MHz */
75 #define TEA5767_JAPAN_BAND      0x20
76
77 /* Unselected means 32.768 KHz freq as reference. Otherwise Xtal at 13 MHz */
78 #define TEA5767_XTAL_32768      0x10
79
80 /* Cuts weak signals */
81 #define TEA5767_SOFT_MUTE       0x08
82
83 /* Activates high cut control */
84 #define TEA5767_HIGH_CUT_CTRL   0x04
85
86 /* Activates stereo noise control */
87 #define TEA5767_ST_NOISE_CTL    0x02
88
89 /* If activate PORT 1 indicates SEARCH or else it is used as PORT1 */
90 #define TEA5767_SRCH_IND        0x01
91
92 /* Fifth register */
93
94 /* By activating, it will use Xtal at 13 MHz as reference for divider */
95 #define TEA5767_PLLREF_ENABLE   0x80
96
97 /* By activating, deemphasis=50, or else, deemphasis of 50us */
98 #define TEA5767_DEEMPH_75       0X40
99
100 /*****************************
101  * Read mode register values *
102  *****************************/
103
104 /* First register */
105 #define TEA5767_READY_FLAG_MASK 0x80
106 #define TEA5767_BAND_LIMIT_MASK 0X40
107 /* Bits 0-5 for divider MSB after search or preset */
108
109 /* Second register */
110 /* Bits 0-7 for divider LSB after search or preset */
111
112 /* Third register */
113 #define TEA5767_STEREO_MASK     0x80
114 #define TEA5767_IF_CNTR_MASK    0x7f
115
116 /* Fourth register */
117 #define TEA5767_ADC_LEVEL_MASK  0xf0
118
119 /* should be 0 */
120 #define TEA5767_CHIP_ID_MASK    0x0f
121
122 /* Fifth register */
123 /* Reserved for future extensions */
124 #define TEA5767_RESERVED_MASK   0xff
125
126 enum tea5767_xtal_freq {
127         TEA5767_LOW_LO_32768    = 0,
128         TEA5767_HIGH_LO_32768   = 1,
129         TEA5767_LOW_LO_13MHz    = 2,
130         TEA5767_HIGH_LO_13MHz   = 3,
131 };
132
133
134 /*****************************************************************************/
135
136 static void set_tv_freq(struct tuner *t, unsigned int freq)
137 {
138         tuner_warn("This tuner doesn't support TV freq.\n");
139 }
140
141 static void tea5767_status_dump(unsigned char *buffer)
142 {
143         unsigned int div, frq;
144
145         if (TEA5767_READY_FLAG_MASK & buffer[0])
146                 printk(PREFIX "Ready Flag ON\n");
147         else
148                 printk(PREFIX "Ready Flag OFF\n");
149
150         if (TEA5767_BAND_LIMIT_MASK & buffer[0])
151                 printk(PREFIX "Tuner at band limit\n");
152         else
153                 printk(PREFIX "Tuner not at band limit\n");
154
155         div = ((buffer[0] & 0x3f) << 8) | buffer[1];
156
157         switch (TEA5767_HIGH_LO_32768) {
158         case TEA5767_HIGH_LO_13MHz:
159                 frq = (div * 50000 - 700000 - 225000) / 4;      /* Freq in KHz */
160                 break;
161         case TEA5767_LOW_LO_13MHz:
162                 frq = (div * 50000 + 700000 + 225000) / 4;      /* Freq in KHz */
163                 break;
164         case TEA5767_LOW_LO_32768:
165                 frq = (div * 32768 + 700000 + 225000) / 4;      /* Freq in KHz */
166                 break;
167         case TEA5767_HIGH_LO_32768:
168         default:
169                 frq = (div * 32768 - 700000 - 225000) / 4;      /* Freq in KHz */
170                 break;
171         }
172         buffer[0] = (div >> 8) & 0x3f;
173         buffer[1] = div & 0xff;
174
175         printk(PREFIX "Frequency %d.%03d KHz (divider = 0x%04x)\n",
176                frq / 1000, frq % 1000, div);
177
178         if (TEA5767_STEREO_MASK & buffer[2])
179                 printk(PREFIX "Stereo\n");
180         else
181                 printk(PREFIX "Mono\n");
182
183         printk(PREFIX "IF Counter = %d\n", buffer[2] & TEA5767_IF_CNTR_MASK);
184
185         printk(PREFIX "ADC Level = %d\n",
186                (buffer[3] & TEA5767_ADC_LEVEL_MASK) >> 4);
187
188         printk(PREFIX "Chip ID = %d\n", (buffer[3] & TEA5767_CHIP_ID_MASK));
189
190         printk(PREFIX "Reserved = 0x%02x\n",
191                (buffer[4] & TEA5767_RESERVED_MASK));
192 }
193
194 /* Freq should be specifyed at 62.5 Hz */
195 static void set_radio_freq(struct tuner *t, unsigned int frq)
196 {
197         struct tea5767_priv *priv = t->priv;
198         unsigned char buffer[5];
199         unsigned div;
200         int rc;
201
202         tuner_dbg (PREFIX "radio freq = %d.%03d MHz\n", frq/16000,(frq/16)%1000);
203
204         /* Rounds freq to next decimal value - for 62.5 KHz step */
205         /* frq = 20*(frq/16)+radio_frq[frq%16]; */
206
207         buffer[2] = TEA5767_PORT1_HIGH;
208         buffer[3] = TEA5767_PORT2_HIGH | TEA5767_HIGH_CUT_CTRL |
209                     TEA5767_ST_NOISE_CTL | TEA5767_JAPAN_BAND;
210         buffer[4] = 0;
211
212         if (t->audmode == V4L2_TUNER_MODE_MONO) {
213                 tuner_dbg("TEA5767 set to mono\n");
214                 buffer[2] |= TEA5767_MONO;
215         } else {
216                 tuner_dbg("TEA5767 set to stereo\n");
217         }
218
219         /* Should be replaced */
220         switch (TEA5767_HIGH_LO_32768) {
221         case TEA5767_HIGH_LO_13MHz:
222                 tuner_dbg ("TEA5767 radio HIGH LO inject xtal @ 13 MHz\n");
223                 buffer[2] |= TEA5767_HIGH_LO_INJECT;
224                 buffer[4] |= TEA5767_PLLREF_ENABLE;
225                 div = (frq * (4000 / 16) + 700000 + 225000 + 25000) / 50000;
226                 break;
227         case TEA5767_LOW_LO_13MHz:
228                 tuner_dbg ("TEA5767 radio LOW LO inject xtal @ 13 MHz\n");
229
230                 buffer[4] |= TEA5767_PLLREF_ENABLE;
231                 div = (frq * (4000 / 16) - 700000 - 225000 + 25000) / 50000;
232                 break;
233         case TEA5767_LOW_LO_32768:
234                 tuner_dbg ("TEA5767 radio LOW LO inject xtal @ 32,768 MHz\n");
235                 buffer[3] |= TEA5767_XTAL_32768;
236                 /* const 700=4000*175 Khz - to adjust freq to right value */
237                 div = ((frq * (4000 / 16) - 700000 - 225000) + 16384) >> 15;
238                 break;
239         case TEA5767_HIGH_LO_32768:
240         default:
241                 tuner_dbg ("TEA5767 radio HIGH LO inject xtal @ 32,768 MHz\n");
242
243                 buffer[2] |= TEA5767_HIGH_LO_INJECT;
244                 buffer[3] |= TEA5767_XTAL_32768;
245                 div = ((frq * (4000 / 16) + 700000 + 225000) + 16384) >> 15;
246                 break;
247         }
248         buffer[0] = (div >> 8) & 0x3f;
249         buffer[1] = div & 0xff;
250
251         if (5 != (rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 5)))
252                 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
253
254         if (tuner_debug) {
255                 if (5 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 5)))
256                         tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
257                 else
258                         tea5767_status_dump(buffer);
259         }
260 }
261
262 static int tea5767_signal(struct tuner *t)
263 {
264         unsigned char buffer[5];
265         int rc;
266         struct tea5767_priv *priv = t->priv;
267
268         memset(buffer, 0, sizeof(buffer));
269         if (5 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 5)))
270                 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
271
272         return ((buffer[3] & TEA5767_ADC_LEVEL_MASK) << 8);
273 }
274
275 static int tea5767_stereo(struct tuner *t)
276 {
277         unsigned char buffer[5];
278         int rc;
279         struct tea5767_priv *priv = t->priv;
280
281         memset(buffer, 0, sizeof(buffer));
282         if (5 != (rc = tuner_i2c_xfer_recv(&priv->i2c_props, buffer, 5)))
283                 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
284
285         rc = buffer[2] & TEA5767_STEREO_MASK;
286
287         tuner_dbg("TEA5767 radio ST GET = %02x\n", rc);
288
289         return ((buffer[2] & TEA5767_STEREO_MASK) ? V4L2_TUNER_SUB_STEREO : 0);
290 }
291
292 static void tea5767_standby(struct tuner *t)
293 {
294         unsigned char buffer[5];
295         struct tea5767_priv *priv = t->priv;
296         unsigned div, rc;
297
298         div = (87500 * 4 + 700 + 225 + 25) / 50; /* Set frequency to 87.5 MHz */
299         buffer[0] = (div >> 8) & 0x3f;
300         buffer[1] = div & 0xff;
301         buffer[2] = TEA5767_PORT1_HIGH;
302         buffer[3] = TEA5767_PORT2_HIGH | TEA5767_HIGH_CUT_CTRL |
303                     TEA5767_ST_NOISE_CTL | TEA5767_JAPAN_BAND | TEA5767_STDBY;
304         buffer[4] = 0;
305
306         if (5 != (rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 5)))
307                 tuner_warn("i2c i/o error: rc == %d (should be 5)\n", rc);
308 }
309
310 int tea5767_autodetection(struct tuner *t)
311 {
312         struct tuner_i2c_props i2c = { .adap = t->i2c.adapter, .addr = t->i2c.addr };
313         unsigned char buffer[7] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
314         int rc;
315
316         if ((rc = tuner_i2c_xfer_send(&i2c, buffer, 7))< 5) {
317                 tuner_warn("It is not a TEA5767. Received %i bytes.\n", rc);
318                 return EINVAL;
319         }
320
321         /* If all bytes are the same then it's a TV tuner and not a tea5767 */
322         if (buffer[0] == buffer[1] && buffer[0] == buffer[2] &&
323             buffer[0] == buffer[3] && buffer[0] == buffer[4]) {
324                 tuner_warn("All bytes are equal. It is not a TEA5767\n");
325                 return EINVAL;
326         }
327
328         /*  Status bytes:
329          *  Byte 4: bit 3:1 : CI (Chip Identification) == 0
330          *          bit 0   : internally set to 0
331          *  Byte 5: bit 7:0 : == 0
332          */
333         if (((buffer[3] & 0x0f) != 0x00) || (buffer[4] != 0x00)) {
334                 tuner_warn("Chip ID is not zero. It is not a TEA5767\n");
335                 return EINVAL;
336         }
337
338         /* It seems that tea5767 returns 0xff after the 5th byte */
339         if ((buffer[5] != 0xff) || (buffer[6] != 0xff)) {
340                 tuner_warn("Returned more than 5 bytes. It is not a TEA5767\n");
341                 return EINVAL;
342         }
343
344         tuner_warn("TEA5767 detected.\n");
345         return 0;
346 }
347
348 static void tea5767_release(struct tuner *t)
349 {
350         kfree(t->priv);
351         t->priv = NULL;
352 }
353
354 static struct tuner_operations tea5767_tuner_ops = {
355         .set_tv_freq    = set_tv_freq,
356         .set_radio_freq = set_radio_freq,
357         .has_signal     = tea5767_signal,
358         .is_stereo      = tea5767_stereo,
359         .standby        = tea5767_standby,
360         .release        = tea5767_release,
361 };
362
363 int tea5767_tuner_init(struct tuner *t)
364 {
365         struct tea5767_priv *priv = NULL;
366
367         priv = kzalloc(sizeof(struct tea5767_priv), GFP_KERNEL);
368         if (priv == NULL)
369                 return -ENOMEM;
370         t->priv = priv;
371
372         priv->i2c_props.addr = t->i2c.addr;
373         priv->i2c_props.adap = t->i2c.adapter;
374
375         tuner_info("type set to %d (%s)\n", t->type, "Philips TEA5767HN FM Radio");
376         strlcpy(t->i2c.name, "tea5767", sizeof(t->i2c.name));
377
378         memcpy(&t->ops, &tea5767_tuner_ops, sizeof(struct tuner_operations));
379
380         return (0);
381 }