V4L/DVB (3365): Kworld ATSC110: cleanups
[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 /* ---------------------------------------------------------------------- */
83
84 static int tuner_getstatus(struct i2c_client *c)
85 {
86         unsigned char byte;
87
88         if (1 != i2c_master_recv(c,&byte,1))
89                 return 0;
90
91         return byte;
92 }
93
94 static int tuner_signal(struct i2c_client *c)
95 {
96         return (tuner_getstatus(c) & TUNER_SIGNAL) << 13;
97 }
98
99 static int tuner_stereo(struct i2c_client *c)
100 {
101         int stereo, status;
102         struct tuner *t = i2c_get_clientdata(c);
103
104         status = tuner_getstatus (c);
105
106         switch (t->type) {
107                 case TUNER_PHILIPS_FM1216ME_MK3:
108                 case TUNER_PHILIPS_FM1236_MK3:
109                 case TUNER_PHILIPS_FM1256_IH3:
110                         stereo = ((status & TUNER_SIGNAL) == TUNER_STEREO_MK3);
111                         break;
112                 default:
113                         stereo = status & TUNER_STEREO;
114         }
115
116         return stereo;
117 }
118
119
120 /* ---------------------------------------------------------------------- */
121
122 static void default_set_tv_freq(struct i2c_client *c, unsigned int freq)
123 {
124         struct tuner *t = i2c_get_clientdata(c);
125         u8 config, cb, tuneraddr;
126         u16 div;
127         struct tunertype *tun;
128         u8 buffer[4];
129         int rc, IFPCoff, i, j;
130         enum param_type desired_type;
131
132         tun = &tuners[t->type];
133
134         /* IFPCoff = Video Intermediate Frequency - Vif:
135                 940  =16*58.75  NTSC/J (Japan)
136                 732  =16*45.75  M/N STD
137                 704  =16*44     ATSC (at DVB code)
138                 632  =16*39.50  I U.K.
139                 622.4=16*38.90  B/G D/K I, L STD
140                 592  =16*37.00  D China
141                 590  =16.36.875 B Australia
142                 543.2=16*33.95  L' STD
143                 171.2=16*10.70  FM Radio (at set_radio_freq)
144         */
145
146         if (t->std == V4L2_STD_NTSC_M_JP) {
147                 IFPCoff      = 940;
148                 desired_type = TUNER_PARAM_TYPE_NTSC;
149         } else if ((t->std & V4L2_STD_MN) &&
150                   !(t->std & ~V4L2_STD_MN)) {
151                 IFPCoff      = 732;
152                 desired_type = TUNER_PARAM_TYPE_NTSC;
153         } else if (t->std == V4L2_STD_SECAM_LC) {
154                 IFPCoff      = 543;
155                 desired_type = TUNER_PARAM_TYPE_SECAM;
156         } else {
157                 IFPCoff      = 623;
158                 desired_type = TUNER_PARAM_TYPE_PAL;
159         }
160
161         for (j = 0; j < tun->count-1; j++) {
162                 if (desired_type != tun->params[j].type)
163                         continue;
164                 break;
165         }
166         /* use default tuner_params if desired_type not available */
167         if (desired_type != tun->params[j].type) {
168                 tuner_dbg("IFPCoff = %d: tuner_params undefined for tuner %d\n",
169                           IFPCoff,t->type);
170                 j = 0;
171         }
172
173         for (i = 0; i < tun->params[j].count; i++) {
174                 if (freq > tun->params[j].ranges[i].limit)
175                         continue;
176                 break;
177         }
178         if (i == tun->params[j].count) {
179                 tuner_dbg("TV frequency out of range (%d > %d)",
180                                 freq, tun->params[j].ranges[i - 1].limit);
181                 freq = tun->params[j].ranges[--i].limit;
182         }
183         config = tun->params[j].ranges[i].config;
184         cb     = tun->params[j].ranges[i].cb;
185         /*  i == 0 -> VHF_LO
186          *  i == 1 -> VHF_HI
187          *  i == 2 -> UHF     */
188         tuner_dbg("tv: param %d, range %d\n",j,i);
189
190         div=freq + IFPCoff + offset;
191
192         tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, Offset=%d.%02d MHz, div=%0d\n",
193                                         freq / 16, freq % 16 * 100 / 16,
194                                         IFPCoff / 16, IFPCoff % 16 * 100 / 16,
195                                         offset / 16, offset % 16 * 100 / 16,
196                                         div);
197
198         /* tv norm specific stuff for multi-norm tuners */
199         switch (t->type) {
200         case TUNER_PHILIPS_SECAM: // FI1216MF
201                 /* 0x01 -> ??? no change ??? */
202                 /* 0x02 -> PAL BDGHI / SECAM L */
203                 /* 0x04 -> ??? PAL others / SECAM others ??? */
204                 cb &= ~0x02;
205                 if (t->std & V4L2_STD_SECAM)
206                         cb |= 0x02;
207                 break;
208
209         case TUNER_TEMIC_4046FM5:
210                 cb &= ~0x0f;
211
212                 if (t->std & V4L2_STD_PAL_BG) {
213                         cb |= TEMIC_SET_PAL_BG;
214
215                 } else if (t->std & V4L2_STD_PAL_I) {
216                         cb |= TEMIC_SET_PAL_I;
217
218                 } else if (t->std & V4L2_STD_PAL_DK) {
219                         cb |= TEMIC_SET_PAL_DK;
220
221                 } else if (t->std & V4L2_STD_SECAM_L) {
222                         cb |= TEMIC_SET_PAL_L;
223
224                 }
225                 break;
226
227         case TUNER_PHILIPS_FQ1216ME:
228                 cb &= ~0x0f;
229
230                 if (t->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
231                         cb |= PHILIPS_SET_PAL_BGDK;
232
233                 } else if (t->std & V4L2_STD_PAL_I) {
234                         cb |= PHILIPS_SET_PAL_I;
235
236                 } else if (t->std & V4L2_STD_SECAM_L) {
237                         cb |= PHILIPS_SET_PAL_L;
238
239                 }
240                 break;
241
242         case TUNER_PHILIPS_ATSC:
243                 /* 0x00 -> ATSC antenna input 1 */
244                 /* 0x01 -> ATSC antenna input 2 */
245                 /* 0x02 -> NTSC antenna input 1 */
246                 /* 0x03 -> NTSC antenna input 2 */
247                 cb &= ~0x03;
248                 if (!(t->std & V4L2_STD_ATSC))
249                         cb |= 2;
250                 /* FIXME: input */
251                 break;
252
253         case TUNER_MICROTUNE_4042FI5:
254                 /* Set the charge pump for fast tuning */
255                 config |= TUNER_CHARGE_PUMP;
256                 break;
257
258         case TUNER_PHILIPS_TUV1236D:
259                 /* 0x40 -> ATSC antenna input 1 */
260                 /* 0x48 -> ATSC antenna input 2 */
261                 /* 0x00 -> NTSC antenna input 1 */
262                 /* 0x08 -> NTSC antenna input 2 */
263                 buffer[0] = 0x14;
264                 buffer[1] = 0x00;
265                 buffer[2] = 0x17;
266                 buffer[3] = 0x00;
267                 cb &= ~0x40;
268                 if (t->std & V4L2_STD_ATSC) {
269                         cb |= 0x40;
270                         buffer[1] = 0x04;
271                 }
272                 /* set to the correct mode (analog or digital) */
273                 tuneraddr = c->addr;
274                 c->addr = 0x0a;
275                 if (2 != (rc = i2c_master_send(c,&buffer[0],2)))
276                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
277                 if (2 != (rc = i2c_master_send(c,&buffer[2],2)))
278                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
279                 c->addr = tuneraddr;
280                 /* FIXME: input */
281                 break;
282         }
283
284         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
285                 buffer[0] = config;
286                 buffer[1] = cb;
287                 buffer[2] = (div>>8) & 0x7f;
288                 buffer[3] = div      & 0xff;
289         } else {
290                 buffer[0] = (div>>8) & 0x7f;
291                 buffer[1] = div      & 0xff;
292                 buffer[2] = config;
293                 buffer[3] = cb;
294         }
295         t->last_div = div;
296         tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
297                   buffer[0],buffer[1],buffer[2],buffer[3]);
298
299         if (4 != (rc = i2c_master_send(c,buffer,4)))
300                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
301
302         if (t->type == TUNER_MICROTUNE_4042FI5) {
303                 // FIXME - this may also work for other tuners
304                 unsigned long timeout = jiffies + msecs_to_jiffies(1);
305                 u8 status_byte = 0;
306
307                 /* Wait until the PLL locks */
308                 for (;;) {
309                         if (time_after(jiffies,timeout))
310                                 return;
311                         if (1 != (rc = i2c_master_recv(c,&status_byte,1))) {
312                                 tuner_warn("i2c i/o read error: rc == %d (should be 1)\n",rc);
313                                 break;
314                         }
315                         if (status_byte & TUNER_PLL_LOCKED)
316                                 break;
317                         udelay(10);
318                 }
319
320                 /* Set the charge pump for optimized phase noise figure */
321                 config &= ~TUNER_CHARGE_PUMP;
322                 buffer[0] = (div>>8) & 0x7f;
323                 buffer[1] = div      & 0xff;
324                 buffer[2] = config;
325                 buffer[3] = cb;
326                 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
327                        buffer[0],buffer[1],buffer[2],buffer[3]);
328
329                 if (4 != (rc = i2c_master_send(c,buffer,4)))
330                         tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
331         }
332 }
333
334 static void default_set_radio_freq(struct i2c_client *c, unsigned int freq)
335 {
336         struct tunertype *tun;
337         struct tuner *t = i2c_get_clientdata(c);
338         u8 buffer[4];
339         u16 div;
340         int rc, j;
341         enum param_type desired_type = TUNER_PARAM_TYPE_RADIO;
342
343         tun = &tuners[t->type];
344
345         for (j = 0; j < tun->count-1; j++) {
346                 if (desired_type != tun->params[j].type)
347                         continue;
348                 break;
349         }
350         /* use default tuner_params if desired_type not available */
351         if (desired_type != tun->params[j].type)
352                 j = 0;
353
354         div = (20 * freq / 16000) + (int)(20*10.7); /* IF 10.7 MHz */
355         buffer[2] = (tun->params[j].ranges[0].config & ~TUNER_RATIO_MASK) | TUNER_RATIO_SELECT_50; /* 50 kHz step */
356
357         switch (t->type) {
358         case TUNER_TENA_9533_DI:
359         case TUNER_YMEC_TVF_5533MF:
360                 tuner_dbg ("This tuner doesn't have FM. Most cards has a TEA5767 for FM\n");
361                 return;
362         case TUNER_PHILIPS_FM1216ME_MK3:
363         case TUNER_PHILIPS_FM1236_MK3:
364         case TUNER_PHILIPS_FMD1216ME_MK3:
365                 buffer[3] = 0x19;
366                 break;
367         case TUNER_PHILIPS_FM1256_IH3:
368                 div = (20 * freq) / 16000 + (int)(33.3 * 20);  /* IF 33.3 MHz */
369                 buffer[3] = 0x19;
370                 break;
371         case TUNER_LG_PAL_FM:
372                 buffer[3] = 0xa5;
373                 break;
374         case TUNER_MICROTUNE_4049FM5:
375                 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
376                 buffer[3] = 0xa4;
377                 break;
378         default:
379                 buffer[3] = 0xa4;
380                 break;
381         }
382         buffer[0] = (div>>8) & 0x7f;
383         buffer[1] = div      & 0xff;
384         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
385                 buffer[0] = buffer[2];
386                 buffer[1] = buffer[3];
387                 buffer[2] = (div>>8) & 0x7f;
388                 buffer[3] = div      & 0xff;
389         } else {
390                 buffer[0] = (div>>8) & 0x7f;
391                 buffer[1] = div      & 0xff;
392         }
393
394         tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
395                buffer[0],buffer[1],buffer[2],buffer[3]);
396         t->last_div = div;
397
398         if (4 != (rc = i2c_master_send(c,buffer,4)))
399                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
400 }
401
402 int default_tuner_init(struct i2c_client *c)
403 {
404         struct tuner *t = i2c_get_clientdata(c);
405
406         tuner_info("type set to %d (%s)\n",
407                    t->type, tuners[t->type].name);
408         strlcpy(c->name, tuners[t->type].name, sizeof(c->name));
409
410         t->set_tv_freq = default_set_tv_freq;
411         t->set_radio_freq = default_set_radio_freq;
412         t->has_signal = tuner_signal;
413         t->is_stereo = tuner_stereo;
414         t->standby = NULL;
415
416         return 0;
417 }
418
419 /*
420  * Overrides for Emacs so that we follow Linus's tabbing style.
421  * ---------------------------------------------------------------------------
422  * Local variables:
423  * c-basic-offset: 8
424  * End:
425  */