V4L/DVB (3268): Move video std detection to top of set_tv_freq function
[linux-2.6] / drivers / media / video / tuner-simple.c
1 /*
2  *
3  * i2c tv tuner chip device driver
4  * controls all those simple 4-control-bytes style tuners.
5  */
6 #include <linux/delay.h>
7 #include <linux/i2c.h>
8 #include <linux/videodev.h>
9 #include <media/tuner.h>
10
11 static int offset = 0;
12 module_param(offset, int, 0666);
13 MODULE_PARM_DESC(offset,"Allows to specify an offset for tuner");
14
15 /* ---------------------------------------------------------------------- */
16
17 /* tv standard selection for Temic 4046 FM5
18    this value takes the low bits of control byte 2
19    from datasheet Rev.01, Feb.00
20      standard     BG      I       L       L2      D
21      picture IF   38.9    38.9    38.9    33.95   38.9
22      sound 1      33.4    32.9    32.4    40.45   32.4
23      sound 2      33.16
24      NICAM        33.05   32.348  33.05           33.05
25  */
26 #define TEMIC_SET_PAL_I         0x05
27 #define TEMIC_SET_PAL_DK        0x09
28 #define TEMIC_SET_PAL_L         0x0a // SECAM ?
29 #define TEMIC_SET_PAL_L2        0x0b // change IF !
30 #define TEMIC_SET_PAL_BG        0x0c
31
32 /* tv tuner system standard selection for Philips FQ1216ME
33    this value takes the low bits of control byte 2
34    from datasheet "1999 Nov 16" (supersedes "1999 Mar 23")
35      standard           BG      DK      I       L       L`
36      picture carrier    38.90   38.90   38.90   38.90   33.95
37      colour             34.47   34.47   34.47   34.47   38.38
38      sound 1            33.40   32.40   32.90   32.40   40.45
39      sound 2            33.16   -       -       -       -
40      NICAM              33.05   33.05   32.35   33.05   39.80
41  */
42 #define PHILIPS_SET_PAL_I       0x01 /* Bit 2 always zero !*/
43 #define PHILIPS_SET_PAL_BGDK    0x09
44 #define PHILIPS_SET_PAL_L2      0x0a
45 #define PHILIPS_SET_PAL_L       0x0b
46
47 /* system switching for Philips FI1216MF MK2
48    from datasheet "1996 Jul 09",
49     standard         BG     L      L'
50     picture carrier  38.90  38.90  33.95
51     colour           34.47  34.37  38.38
52     sound 1          33.40  32.40  40.45
53     sound 2          33.16  -      -
54     NICAM            33.05  33.05  39.80
55  */
56 #define PHILIPS_MF_SET_BG       0x01 /* Bit 2 must be zero, Bit 3 is system output */
57 #define PHILIPS_MF_SET_PAL_L    0x03 // France
58 #define PHILIPS_MF_SET_PAL_L2   0x02 // L'
59
60 /* Control byte */
61
62 #define TUNER_RATIO_MASK        0x06 /* Bit cb1:cb2 */
63 #define TUNER_RATIO_SELECT_50   0x00
64 #define TUNER_RATIO_SELECT_32   0x02
65 #define TUNER_RATIO_SELECT_166  0x04
66 #define TUNER_RATIO_SELECT_62   0x06
67
68 #define TUNER_CHARGE_PUMP       0x40  /* Bit cb6 */
69
70 /* Status byte */
71
72 #define TUNER_POR         0x80
73 #define TUNER_FL          0x40
74 #define TUNER_MODE        0x38
75 #define TUNER_AFC         0x07
76 #define TUNER_SIGNAL      0x07
77 #define TUNER_STEREO      0x10
78
79 #define TUNER_PLL_LOCKED   0x40
80 #define TUNER_STEREO_MK3   0x04
81
82 #define TUNER_PARAM_ANALOG 0  /* to be removed */
83 /* FIXME:
84  * Right now, all tuners are using the first tuner_params[] array element
85  * for analog mode. In the future, we will be merging similar tuner
86  * definitions together, such that each tuner definition will have a
87  * tuner_params struct for each available video standard. At that point,
88  * TUNER_PARAM_ANALOG will be removed, and the tuner_params[] array
89  * element will be chosen based on the video standard in use.
90  *
91  */
92
93 /* ---------------------------------------------------------------------- */
94
95 static int tuner_getstatus(struct i2c_client *c)
96 {
97         unsigned char byte;
98
99         if (1 != i2c_master_recv(c,&byte,1))
100                 return 0;
101
102         return byte;
103 }
104
105 static int tuner_signal(struct i2c_client *c)
106 {
107         return (tuner_getstatus(c) & TUNER_SIGNAL) << 13;
108 }
109
110 static int tuner_stereo(struct i2c_client *c)
111 {
112         int stereo, status;
113         struct tuner *t = i2c_get_clientdata(c);
114
115         status = tuner_getstatus (c);
116
117         switch (t->type) {
118                 case TUNER_PHILIPS_FM1216ME_MK3:
119                 case TUNER_PHILIPS_FM1236_MK3:
120                 case TUNER_PHILIPS_FM1256_IH3:
121                         stereo = ((status & TUNER_SIGNAL) == TUNER_STEREO_MK3);
122                         break;
123                 default:
124                         stereo = status & TUNER_STEREO;
125         }
126
127         return stereo;
128 }
129
130
131 /* ---------------------------------------------------------------------- */
132
133 static void default_set_tv_freq(struct i2c_client *c, unsigned int freq)
134 {
135         struct tuner *t = i2c_get_clientdata(c);
136         u8 config, cb, tuneraddr;
137         u16 div;
138         struct tunertype *tun;
139         u8 buffer[4];
140         int rc, IFPCoff, i, j;
141
142         tun = &tuners[t->type];
143         j = TUNER_PARAM_ANALOG;
144
145         /* IFPCoff = Video Intermediate Frequency - Vif:
146                 940  =16*58.75  NTSC/J (Japan)
147                 732  =16*45.75  M/N STD
148                 704  =16*44     ATSC (at DVB code)
149                 632  =16*39.50  I U.K.
150                 622.4=16*38.90  B/G D/K I, L STD
151                 592  =16*37.00  D China
152                 590  =16.36.875 B Australia
153                 543.2=16*33.95  L' STD
154                 171.2=16*10.70  FM Radio (at set_radio_freq)
155         */
156
157         if (t->std == V4L2_STD_NTSC_M_JP) {
158                 IFPCoff = 940;
159         } else if ((t->std & V4L2_STD_MN) &&
160                   !(t->std & ~V4L2_STD_MN)) {
161                 IFPCoff = 732;
162         } else if (t->std == V4L2_STD_SECAM_LC) {
163                 IFPCoff = 543;
164         } else {
165                 IFPCoff = 623;
166         }
167
168         for (i = 0; i < tun->params[j].count; i++) {
169                 if (freq > tun->params[j].ranges[i].limit)
170                         continue;
171                 break;
172         }
173         if (i == tun->params[j].count) {
174                 tuner_dbg("TV frequency out of range (%d > %d)",
175                                 freq, tun->params[j].ranges[i - 1].limit);
176                 freq = tun->params[j].ranges[--i].limit;
177         }
178         config = tun->params[j].ranges[i].config;
179         cb     = tun->params[j].ranges[i].cb;
180         /*  i == 0 -> VHF_LO
181          *  i == 1 -> VHF_HI
182          *  i == 2 -> UHF     */
183         tuner_dbg("tv: range %d\n",i);
184
185         div=freq + IFPCoff + offset;
186
187         tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, Offset=%d.%02d MHz, div=%0d\n",
188                                         freq / 16, freq % 16 * 100 / 16,
189                                         IFPCoff / 16, IFPCoff % 16 * 100 / 16,
190                                         offset / 16, offset % 16 * 100 / 16,
191                                         div);
192
193         /* tv norm specific stuff for multi-norm tuners */
194         switch (t->type) {
195         case TUNER_PHILIPS_SECAM: // FI1216MF
196                 /* 0x01 -> ??? no change ??? */
197                 /* 0x02 -> PAL BDGHI / SECAM L */
198                 /* 0x04 -> ??? PAL others / SECAM others ??? */
199                 cb &= ~0x02;
200                 if (t->std & V4L2_STD_SECAM)
201                         cb |= 0x02;
202                 break;
203
204         case TUNER_TEMIC_4046FM5:
205                 cb &= ~0x0f;
206
207                 if (t->std & V4L2_STD_PAL_BG) {
208                         cb |= TEMIC_SET_PAL_BG;
209
210                 } else if (t->std & V4L2_STD_PAL_I) {
211                         cb |= TEMIC_SET_PAL_I;
212
213                 } else if (t->std & V4L2_STD_PAL_DK) {
214                         cb |= TEMIC_SET_PAL_DK;
215
216                 } else if (t->std & V4L2_STD_SECAM_L) {
217                         cb |= TEMIC_SET_PAL_L;
218
219                 }
220                 break;
221
222         case TUNER_PHILIPS_FQ1216ME:
223                 cb &= ~0x0f;
224
225                 if (t->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
226                         cb |= PHILIPS_SET_PAL_BGDK;
227
228                 } else if (t->std & V4L2_STD_PAL_I) {
229                         cb |= PHILIPS_SET_PAL_I;
230
231                 } else if (t->std & V4L2_STD_SECAM_L) {
232                         cb |= PHILIPS_SET_PAL_L;
233
234                 }
235                 break;
236
237         case TUNER_PHILIPS_ATSC:
238                 /* 0x00 -> ATSC antenna input 1 */
239                 /* 0x01 -> ATSC antenna input 2 */
240                 /* 0x02 -> NTSC antenna input 1 */
241                 /* 0x03 -> NTSC antenna input 2 */
242                 cb &= ~0x03;
243                 if (!(t->std & V4L2_STD_ATSC))
244                         cb |= 2;
245                 /* FIXME: input */
246                 break;
247
248         case TUNER_MICROTUNE_4042FI5:
249                 /* Set the charge pump for fast tuning */
250                 config |= TUNER_CHARGE_PUMP;
251                 break;
252
253         case TUNER_PHILIPS_TUV1236D:
254                 /* 0x40 -> ATSC antenna input 1 */
255                 /* 0x48 -> ATSC antenna input 2 */
256                 /* 0x00 -> NTSC antenna input 1 */
257                 /* 0x08 -> NTSC antenna input 2 */
258                 buffer[0] = 0x14;
259                 buffer[1] = 0x00;
260                 buffer[2] = 0x17;
261                 buffer[3] = 0x00;
262                 cb &= ~0x40;
263                 if (t->std & V4L2_STD_ATSC) {
264                         cb |= 0x40;
265                         buffer[1] = 0x04;
266                 }
267                 /* set to the correct mode (analog or digital) */
268                 tuneraddr = c->addr;
269                 c->addr = 0x0a;
270                 if (2 != (rc = i2c_master_send(c,&buffer[0],2)))
271                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
272                 if (2 != (rc = i2c_master_send(c,&buffer[2],2)))
273                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
274                 c->addr = tuneraddr;
275                 /* FIXME: input */
276                 break;
277         }
278
279         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
280                 buffer[0] = config;
281                 buffer[1] = cb;
282                 buffer[2] = (div>>8) & 0x7f;
283                 buffer[3] = div      & 0xff;
284         } else {
285                 buffer[0] = (div>>8) & 0x7f;
286                 buffer[1] = div      & 0xff;
287                 buffer[2] = config;
288                 buffer[3] = cb;
289         }
290         t->last_div = div;
291         tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
292                   buffer[0],buffer[1],buffer[2],buffer[3]);
293
294         if (4 != (rc = i2c_master_send(c,buffer,4)))
295                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
296
297         if (t->type == TUNER_MICROTUNE_4042FI5) {
298                 // FIXME - this may also work for other tuners
299                 unsigned long timeout = jiffies + msecs_to_jiffies(1);
300                 u8 status_byte = 0;
301
302                 /* Wait until the PLL locks */
303                 for (;;) {
304                         if (time_after(jiffies,timeout))
305                                 return;
306                         if (1 != (rc = i2c_master_recv(c,&status_byte,1))) {
307                                 tuner_warn("i2c i/o read error: rc == %d (should be 1)\n",rc);
308                                 break;
309                         }
310                         if (status_byte & TUNER_PLL_LOCKED)
311                                 break;
312                         udelay(10);
313                 }
314
315                 /* Set the charge pump for optimized phase noise figure */
316                 config &= ~TUNER_CHARGE_PUMP;
317                 buffer[0] = (div>>8) & 0x7f;
318                 buffer[1] = div      & 0xff;
319                 buffer[2] = config;
320                 buffer[3] = cb;
321                 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
322                        buffer[0],buffer[1],buffer[2],buffer[3]);
323
324                 if (4 != (rc = i2c_master_send(c,buffer,4)))
325                         tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
326         }
327 }
328
329 static void default_set_radio_freq(struct i2c_client *c, unsigned int freq)
330 {
331         struct tunertype *tun;
332         struct tuner *t = i2c_get_clientdata(c);
333         u8 buffer[4];
334         u16 div;
335         int rc, j;
336
337         tun = &tuners[t->type];
338         j = TUNER_PARAM_ANALOG;
339
340         div = (20 * freq / 16000) + (int)(20*10.7); /* IF 10.7 MHz */
341         buffer[2] = (tun->params[j].ranges[0].config & ~TUNER_RATIO_MASK) | TUNER_RATIO_SELECT_50; /* 50 kHz step */
342
343         switch (t->type) {
344         case TUNER_TENA_9533_DI:
345         case TUNER_YMEC_TVF_5533MF:
346                 tuner_dbg ("This tuner doesn't have FM. Most cards has a TEA5767 for FM\n");
347                 return;
348         case TUNER_PHILIPS_FM1216ME_MK3:
349         case TUNER_PHILIPS_FM1236_MK3:
350         case TUNER_PHILIPS_FMD1216ME_MK3:
351                 buffer[3] = 0x19;
352                 break;
353         case TUNER_PHILIPS_FM1256_IH3:
354                 div = (20 * freq) / 16000 + (int)(33.3 * 20);  /* IF 33.3 MHz */
355                 buffer[3] = 0x19;
356                 break;
357         case TUNER_LG_PAL_FM:
358                 buffer[3] = 0xa5;
359                 break;
360         case TUNER_MICROTUNE_4049FM5:
361                 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
362                 buffer[3] = 0xa4;
363                 break;
364         default:
365                 buffer[3] = 0xa4;
366                 break;
367         }
368         buffer[0] = (div>>8) & 0x7f;
369         buffer[1] = div      & 0xff;
370         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
371                 buffer[0] = buffer[2];
372                 buffer[1] = buffer[3];
373                 buffer[2] = (div>>8) & 0x7f;
374                 buffer[3] = div      & 0xff;
375         } else {
376                 buffer[0] = (div>>8) & 0x7f;
377                 buffer[1] = div      & 0xff;
378         }
379
380         tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
381                buffer[0],buffer[1],buffer[2],buffer[3]);
382         t->last_div = div;
383
384         if (4 != (rc = i2c_master_send(c,buffer,4)))
385                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
386 }
387
388 int default_tuner_init(struct i2c_client *c)
389 {
390         struct tuner *t = i2c_get_clientdata(c);
391
392         tuner_info("type set to %d (%s)\n",
393                    t->type, tuners[t->type].name);
394         strlcpy(c->name, tuners[t->type].name, sizeof(c->name));
395
396         t->set_tv_freq = default_set_tv_freq;
397         t->set_radio_freq = default_set_radio_freq;
398         t->has_signal = tuner_signal;
399         t->is_stereo = tuner_stereo;
400         t->standby = NULL;
401
402         return 0;
403 }
404
405 /*
406  * Overrides for Emacs so that we follow Linus's tabbing style.
407  * ---------------------------------------------------------------------------
408  * Local variables:
409  * c-basic-offset: 8
410  * End:
411  */