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