V4L/DVB (3271): Update tuner comments
[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         for (i = 0; i < tun->params[j].count; i++) {
167                 if (freq > tun->params[j].ranges[i].limit)
168                         continue;
169                 break;
170         }
171         if (i == tun->params[j].count) {
172                 tuner_dbg("TV frequency out of range (%d > %d)",
173                                 freq, tun->params[j].ranges[i - 1].limit);
174                 freq = tun->params[j].ranges[--i].limit;
175         }
176         config = tun->params[j].ranges[i].config;
177         cb     = tun->params[j].ranges[i].cb;
178         /*  i == 0 -> VHF_LO
179          *  i == 1 -> VHF_HI
180          *  i == 2 -> UHF     */
181         tuner_dbg("tv: param %d, range %d\n",j,i);
182
183         div=freq + IFPCoff + offset;
184
185         tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, Offset=%d.%02d MHz, div=%0d\n",
186                                         freq / 16, freq % 16 * 100 / 16,
187                                         IFPCoff / 16, IFPCoff % 16 * 100 / 16,
188                                         offset / 16, offset % 16 * 100 / 16,
189                                         div);
190
191         /* tv norm specific stuff for multi-norm tuners */
192         switch (t->type) {
193         case TUNER_PHILIPS_SECAM: // FI1216MF
194                 /* 0x01 -> ??? no change ??? */
195                 /* 0x02 -> PAL BDGHI / SECAM L */
196                 /* 0x04 -> ??? PAL others / SECAM others ??? */
197                 cb &= ~0x02;
198                 if (t->std & V4L2_STD_SECAM)
199                         cb |= 0x02;
200                 break;
201
202         case TUNER_TEMIC_4046FM5:
203                 cb &= ~0x0f;
204
205                 if (t->std & V4L2_STD_PAL_BG) {
206                         cb |= TEMIC_SET_PAL_BG;
207
208                 } else if (t->std & V4L2_STD_PAL_I) {
209                         cb |= TEMIC_SET_PAL_I;
210
211                 } else if (t->std & V4L2_STD_PAL_DK) {
212                         cb |= TEMIC_SET_PAL_DK;
213
214                 } else if (t->std & V4L2_STD_SECAM_L) {
215                         cb |= TEMIC_SET_PAL_L;
216
217                 }
218                 break;
219
220         case TUNER_PHILIPS_FQ1216ME:
221                 cb &= ~0x0f;
222
223                 if (t->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
224                         cb |= PHILIPS_SET_PAL_BGDK;
225
226                 } else if (t->std & V4L2_STD_PAL_I) {
227                         cb |= PHILIPS_SET_PAL_I;
228
229                 } else if (t->std & V4L2_STD_SECAM_L) {
230                         cb |= PHILIPS_SET_PAL_L;
231
232                 }
233                 break;
234
235         case TUNER_PHILIPS_ATSC:
236                 /* 0x00 -> ATSC antenna input 1 */
237                 /* 0x01 -> ATSC antenna input 2 */
238                 /* 0x02 -> NTSC antenna input 1 */
239                 /* 0x03 -> NTSC antenna input 2 */
240                 cb &= ~0x03;
241                 if (!(t->std & V4L2_STD_ATSC))
242                         cb |= 2;
243                 /* FIXME: input */
244                 break;
245
246         case TUNER_MICROTUNE_4042FI5:
247                 /* Set the charge pump for fast tuning */
248                 config |= TUNER_CHARGE_PUMP;
249                 break;
250
251         case TUNER_PHILIPS_TUV1236D:
252                 /* 0x40 -> ATSC antenna input 1 */
253                 /* 0x48 -> ATSC antenna input 2 */
254                 /* 0x00 -> NTSC antenna input 1 */
255                 /* 0x08 -> NTSC antenna input 2 */
256                 buffer[0] = 0x14;
257                 buffer[1] = 0x00;
258                 buffer[2] = 0x17;
259                 buffer[3] = 0x00;
260                 cb &= ~0x40;
261                 if (t->std & V4L2_STD_ATSC) {
262                         cb |= 0x40;
263                         buffer[1] = 0x04;
264                 }
265                 /* set to the correct mode (analog or digital) */
266                 tuneraddr = c->addr;
267                 c->addr = 0x0a;
268                 if (2 != (rc = i2c_master_send(c,&buffer[0],2)))
269                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
270                 if (2 != (rc = i2c_master_send(c,&buffer[2],2)))
271                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
272                 c->addr = tuneraddr;
273                 /* FIXME: input */
274                 break;
275         }
276
277         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
278                 buffer[0] = config;
279                 buffer[1] = cb;
280                 buffer[2] = (div>>8) & 0x7f;
281                 buffer[3] = div      & 0xff;
282         } else {
283                 buffer[0] = (div>>8) & 0x7f;
284                 buffer[1] = div      & 0xff;
285                 buffer[2] = config;
286                 buffer[3] = cb;
287         }
288         t->last_div = div;
289         tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
290                   buffer[0],buffer[1],buffer[2],buffer[3]);
291
292         if (4 != (rc = i2c_master_send(c,buffer,4)))
293                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
294
295         if (t->type == TUNER_MICROTUNE_4042FI5) {
296                 // FIXME - this may also work for other tuners
297                 unsigned long timeout = jiffies + msecs_to_jiffies(1);
298                 u8 status_byte = 0;
299
300                 /* Wait until the PLL locks */
301                 for (;;) {
302                         if (time_after(jiffies,timeout))
303                                 return;
304                         if (1 != (rc = i2c_master_recv(c,&status_byte,1))) {
305                                 tuner_warn("i2c i/o read error: rc == %d (should be 1)\n",rc);
306                                 break;
307                         }
308                         if (status_byte & TUNER_PLL_LOCKED)
309                                 break;
310                         udelay(10);
311                 }
312
313                 /* Set the charge pump for optimized phase noise figure */
314                 config &= ~TUNER_CHARGE_PUMP;
315                 buffer[0] = (div>>8) & 0x7f;
316                 buffer[1] = div      & 0xff;
317                 buffer[2] = config;
318                 buffer[3] = cb;
319                 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
320                        buffer[0],buffer[1],buffer[2],buffer[3]);
321
322                 if (4 != (rc = i2c_master_send(c,buffer,4)))
323                         tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
324         }
325 }
326
327 static void default_set_radio_freq(struct i2c_client *c, unsigned int freq)
328 {
329         struct tunertype *tun;
330         struct tuner *t = i2c_get_clientdata(c);
331         u8 buffer[4];
332         u16 div;
333         int rc, j;
334         enum param_type desired_type = TUNER_PARAM_TYPE_RADIO;
335
336         tun = &tuners[t->type];
337
338         for (j = 0; j < tun->count-1; j++) {
339                 if (desired_type != tun->params[j].type)
340                         continue;
341                 break;
342         }
343
344         div = (20 * freq / 16000) + (int)(20*10.7); /* IF 10.7 MHz */
345         buffer[2] = (tun->params[j].ranges[0].config & ~TUNER_RATIO_MASK) | TUNER_RATIO_SELECT_50; /* 50 kHz step */
346
347         switch (t->type) {
348         case TUNER_TENA_9533_DI:
349         case TUNER_YMEC_TVF_5533MF:
350                 tuner_dbg ("This tuner doesn't have FM. Most cards has a TEA5767 for FM\n");
351                 return;
352         case TUNER_PHILIPS_FM1216ME_MK3:
353         case TUNER_PHILIPS_FM1236_MK3:
354         case TUNER_PHILIPS_FMD1216ME_MK3:
355                 buffer[3] = 0x19;
356                 break;
357         case TUNER_PHILIPS_FM1256_IH3:
358                 div = (20 * freq) / 16000 + (int)(33.3 * 20);  /* IF 33.3 MHz */
359                 buffer[3] = 0x19;
360                 break;
361         case TUNER_LG_PAL_FM:
362                 buffer[3] = 0xa5;
363                 break;
364         case TUNER_MICROTUNE_4049FM5:
365                 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
366                 buffer[3] = 0xa4;
367                 break;
368         default:
369                 buffer[3] = 0xa4;
370                 break;
371         }
372         buffer[0] = (div>>8) & 0x7f;
373         buffer[1] = div      & 0xff;
374         if (tuners[t->type].params->cb_first_if_lower_freq && div < t->last_div) {
375                 buffer[0] = buffer[2];
376                 buffer[1] = buffer[3];
377                 buffer[2] = (div>>8) & 0x7f;
378                 buffer[3] = div      & 0xff;
379         } else {
380                 buffer[0] = (div>>8) & 0x7f;
381                 buffer[1] = div      & 0xff;
382         }
383
384         tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
385                buffer[0],buffer[1],buffer[2],buffer[3]);
386         t->last_div = div;
387
388         if (4 != (rc = i2c_master_send(c,buffer,4)))
389                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
390 }
391
392 int default_tuner_init(struct i2c_client *c)
393 {
394         struct tuner *t = i2c_get_clientdata(c);
395
396         tuner_info("type set to %d (%s)\n",
397                    t->type, tuners[t->type].name);
398         strlcpy(c->name, tuners[t->type].name, sizeof(c->name));
399
400         t->set_tv_freq = default_set_tv_freq;
401         t->set_radio_freq = default_set_radio_freq;
402         t->has_signal = tuner_signal;
403         t->is_stereo = tuner_stereo;
404         t->standby = NULL;
405
406         return 0;
407 }
408
409 /*
410  * Overrides for Emacs so that we follow Linus's tabbing style.
411  * ---------------------------------------------------------------------------
412  * Local variables:
413  * c-basic-offset: 8
414  * End:
415  */