V4L/DVB (5753): Tuner: create struct tuner_operations
[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 #include <media/v4l2-common.h>
11
12 static int offset = 0;
13 module_param(offset, int, 0664);
14 MODULE_PARM_DESC(offset,"Allows to specify an offset for tuner");
15
16 /* ---------------------------------------------------------------------- */
17
18 /* tv standard selection for Temic 4046 FM5
19    this value takes the low bits of control byte 2
20    from datasheet Rev.01, Feb.00
21      standard     BG      I       L       L2      D
22      picture IF   38.9    38.9    38.9    33.95   38.9
23      sound 1      33.4    32.9    32.4    40.45   32.4
24      sound 2      33.16
25      NICAM        33.05   32.348  33.05           33.05
26  */
27 #define TEMIC_SET_PAL_I         0x05
28 #define TEMIC_SET_PAL_DK        0x09
29 #define TEMIC_SET_PAL_L         0x0a // SECAM ?
30 #define TEMIC_SET_PAL_L2        0x0b // change IF !
31 #define TEMIC_SET_PAL_BG        0x0c
32
33 /* tv tuner system standard selection for Philips FQ1216ME
34    this value takes the low bits of control byte 2
35    from datasheet "1999 Nov 16" (supersedes "1999 Mar 23")
36      standard           BG      DK      I       L       L`
37      picture carrier    38.90   38.90   38.90   38.90   33.95
38      colour             34.47   34.47   34.47   34.47   38.38
39      sound 1            33.40   32.40   32.90   32.40   40.45
40      sound 2            33.16   -       -       -       -
41      NICAM              33.05   33.05   32.35   33.05   39.80
42  */
43 #define PHILIPS_SET_PAL_I       0x01 /* Bit 2 always zero !*/
44 #define PHILIPS_SET_PAL_BGDK    0x09
45 #define PHILIPS_SET_PAL_L2      0x0a
46 #define PHILIPS_SET_PAL_L       0x0b
47
48 /* system switching for Philips FI1216MF MK2
49    from datasheet "1996 Jul 09",
50     standard         BG     L      L'
51     picture carrier  38.90  38.90  33.95
52     colour           34.47  34.37  38.38
53     sound 1          33.40  32.40  40.45
54     sound 2          33.16  -      -
55     NICAM            33.05  33.05  39.80
56  */
57 #define PHILIPS_MF_SET_STD_BG   0x01 /* Bit 2 must be zero, Bit 3 is system output */
58 #define PHILIPS_MF_SET_STD_L    0x03 /* Used on Secam France */
59 #define PHILIPS_MF_SET_STD_LC   0x02 /* Used on SECAM L' */
60
61 /* Control byte */
62
63 #define TUNER_RATIO_MASK        0x06 /* Bit cb1:cb2 */
64 #define TUNER_RATIO_SELECT_50   0x00
65 #define TUNER_RATIO_SELECT_32   0x02
66 #define TUNER_RATIO_SELECT_166  0x04
67 #define TUNER_RATIO_SELECT_62   0x06
68
69 #define TUNER_CHARGE_PUMP       0x40  /* Bit cb6 */
70
71 /* Status byte */
72
73 #define TUNER_POR         0x80
74 #define TUNER_FL          0x40
75 #define TUNER_MODE        0x38
76 #define TUNER_AFC         0x07
77 #define TUNER_SIGNAL      0x07
78 #define TUNER_STEREO      0x10
79
80 #define TUNER_PLL_LOCKED   0x40
81 #define TUNER_STEREO_MK3   0x04
82
83 /* ---------------------------------------------------------------------- */
84
85 static int tuner_getstatus(struct i2c_client *c)
86 {
87         unsigned char byte;
88
89         if (1 != i2c_master_recv(c,&byte,1))
90                 return 0;
91
92         return byte;
93 }
94
95 static int tuner_signal(struct i2c_client *c)
96 {
97         return (tuner_getstatus(c) & TUNER_SIGNAL) << 13;
98 }
99
100 static int tuner_stereo(struct i2c_client *c)
101 {
102         int stereo, status;
103         struct tuner *t = i2c_get_clientdata(c);
104
105         status = tuner_getstatus (c);
106
107         switch (t->type) {
108                 case TUNER_PHILIPS_FM1216ME_MK3:
109                 case TUNER_PHILIPS_FM1236_MK3:
110                 case TUNER_PHILIPS_FM1256_IH3:
111                 case TUNER_LG_NTSC_TAPE:
112                         stereo = ((status & TUNER_SIGNAL) == TUNER_STEREO_MK3);
113                         break;
114                 default:
115                         stereo = status & TUNER_STEREO;
116         }
117
118         return stereo;
119 }
120
121
122 /* ---------------------------------------------------------------------- */
123
124 static void default_set_tv_freq(struct i2c_client *c, unsigned int freq)
125 {
126         struct tuner *t = i2c_get_clientdata(c);
127         u8 config, cb, tuneraddr;
128         u16 div;
129         struct tunertype *tun;
130         u8 buffer[4];
131         int rc, IFPCoff, i, j;
132         enum param_type desired_type;
133         struct tuner_params *params;
134
135         tun = &tuners[t->type];
136
137         /* IFPCoff = Video Intermediate Frequency - Vif:
138                 940  =16*58.75  NTSC/J (Japan)
139                 732  =16*45.75  M/N STD
140                 704  =16*44     ATSC (at DVB code)
141                 632  =16*39.50  I U.K.
142                 622.4=16*38.90  B/G D/K I, L STD
143                 592  =16*37.00  D China
144                 590  =16.36.875 B Australia
145                 543.2=16*33.95  L' STD
146                 171.2=16*10.70  FM Radio (at set_radio_freq)
147         */
148
149         if (t->std == V4L2_STD_NTSC_M_JP) {
150                 IFPCoff      = 940;
151                 desired_type = TUNER_PARAM_TYPE_NTSC;
152         } else if ((t->std & V4L2_STD_MN) &&
153                   !(t->std & ~V4L2_STD_MN)) {
154                 IFPCoff      = 732;
155                 desired_type = TUNER_PARAM_TYPE_NTSC;
156         } else if (t->std == V4L2_STD_SECAM_LC) {
157                 IFPCoff      = 543;
158                 desired_type = TUNER_PARAM_TYPE_SECAM;
159         } else {
160                 IFPCoff      = 623;
161                 desired_type = TUNER_PARAM_TYPE_PAL;
162         }
163
164         for (j = 0; j < tun->count-1; j++) {
165                 if (desired_type != tun->params[j].type)
166                         continue;
167                 break;
168         }
169         /* use default tuner_params if desired_type not available */
170         if (desired_type != tun->params[j].type) {
171                 tuner_dbg("IFPCoff = %d: tuner_params undefined for tuner %d\n",
172                           IFPCoff,t->type);
173                 j = 0;
174         }
175         params = &tun->params[j];
176
177         for (i = 0; i < params->count; i++) {
178                 if (freq > params->ranges[i].limit)
179                         continue;
180                 break;
181         }
182         if (i == params->count) {
183                 tuner_dbg("TV frequency out of range (%d > %d)",
184                                 freq, params->ranges[i - 1].limit);
185                 freq = params->ranges[--i].limit;
186         }
187         config = params->ranges[i].config;
188         cb     = params->ranges[i].cb;
189         /*  i == 0 -> VHF_LO
190          *  i == 1 -> VHF_HI
191          *  i == 2 -> UHF     */
192         tuner_dbg("tv: param %d, range %d\n",j,i);
193
194         div=freq + IFPCoff + offset;
195
196         tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, Offset=%d.%02d MHz, div=%0d\n",
197                                         freq / 16, freq % 16 * 100 / 16,
198                                         IFPCoff / 16, IFPCoff % 16 * 100 / 16,
199                                         offset / 16, offset % 16 * 100 / 16,
200                                         div);
201
202         /* tv norm specific stuff for multi-norm tuners */
203         switch (t->type) {
204         case TUNER_PHILIPS_SECAM: // FI1216MF
205                 /* 0x01 -> ??? no change ??? */
206                 /* 0x02 -> PAL BDGHI / SECAM L */
207                 /* 0x04 -> ??? PAL others / SECAM others ??? */
208                 cb &= ~0x03;
209                 if (t->std & V4L2_STD_SECAM_L) //also valid for V4L2_STD_SECAM
210                         cb |= PHILIPS_MF_SET_STD_L;
211                 else if (t->std & V4L2_STD_SECAM_LC)
212                         cb |= PHILIPS_MF_SET_STD_LC;
213                 else /* V4L2_STD_B|V4L2_STD_GH */
214                         cb |= PHILIPS_MF_SET_STD_BG;
215                 break;
216
217         case TUNER_TEMIC_4046FM5:
218                 cb &= ~0x0f;
219
220                 if (t->std & V4L2_STD_PAL_BG) {
221                         cb |= TEMIC_SET_PAL_BG;
222
223                 } else if (t->std & V4L2_STD_PAL_I) {
224                         cb |= TEMIC_SET_PAL_I;
225
226                 } else if (t->std & V4L2_STD_PAL_DK) {
227                         cb |= TEMIC_SET_PAL_DK;
228
229                 } else if (t->std & V4L2_STD_SECAM_L) {
230                         cb |= TEMIC_SET_PAL_L;
231
232                 }
233                 break;
234
235         case TUNER_PHILIPS_FQ1216ME:
236                 cb &= ~0x0f;
237
238                 if (t->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
239                         cb |= PHILIPS_SET_PAL_BGDK;
240
241                 } else if (t->std & V4L2_STD_PAL_I) {
242                         cb |= PHILIPS_SET_PAL_I;
243
244                 } else if (t->std & V4L2_STD_SECAM_L) {
245                         cb |= PHILIPS_SET_PAL_L;
246
247                 }
248                 break;
249
250         case TUNER_PHILIPS_ATSC:
251                 /* 0x00 -> ATSC antenna input 1 */
252                 /* 0x01 -> ATSC antenna input 2 */
253                 /* 0x02 -> NTSC antenna input 1 */
254                 /* 0x03 -> NTSC antenna input 2 */
255                 cb &= ~0x03;
256                 if (!(t->std & V4L2_STD_ATSC))
257                         cb |= 2;
258                 /* FIXME: input */
259                 break;
260
261         case TUNER_MICROTUNE_4042FI5:
262                 /* Set the charge pump for fast tuning */
263                 config |= TUNER_CHARGE_PUMP;
264                 break;
265
266         case TUNER_PHILIPS_TUV1236D:
267                 /* 0x40 -> ATSC antenna input 1 */
268                 /* 0x48 -> ATSC antenna input 2 */
269                 /* 0x00 -> NTSC antenna input 1 */
270                 /* 0x08 -> NTSC antenna input 2 */
271                 buffer[0] = 0x14;
272                 buffer[1] = 0x00;
273                 buffer[2] = 0x17;
274                 buffer[3] = 0x00;
275                 cb &= ~0x40;
276                 if (t->std & V4L2_STD_ATSC) {
277                         cb |= 0x40;
278                         buffer[1] = 0x04;
279                 }
280                 /* set to the correct mode (analog or digital) */
281                 tuneraddr = c->addr;
282                 c->addr = 0x0a;
283                 if (2 != (rc = i2c_master_send(c,&buffer[0],2)))
284                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
285                 if (2 != (rc = i2c_master_send(c,&buffer[2],2)))
286                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
287                 c->addr = tuneraddr;
288                 /* FIXME: input */
289                 break;
290         }
291
292         if (params->cb_first_if_lower_freq && div < t->last_div) {
293                 buffer[0] = config;
294                 buffer[1] = cb;
295                 buffer[2] = (div>>8) & 0x7f;
296                 buffer[3] = div      & 0xff;
297         } else {
298                 buffer[0] = (div>>8) & 0x7f;
299                 buffer[1] = div      & 0xff;
300                 buffer[2] = config;
301                 buffer[3] = cb;
302         }
303         t->last_div = div;
304         if (params->has_tda9887) {
305                 int config = 0;
306                 int is_secam_l = (t->std & (V4L2_STD_SECAM_L | V4L2_STD_SECAM_LC)) &&
307                         !(t->std & ~(V4L2_STD_SECAM_L | V4L2_STD_SECAM_LC));
308
309                 if (t->std == V4L2_STD_SECAM_LC) {
310                         if (params->port1_active ^ params->port1_invert_for_secam_lc)
311                                 config |= TDA9887_PORT1_ACTIVE;
312                         if (params->port2_active ^ params->port2_invert_for_secam_lc)
313                                 config |= TDA9887_PORT2_ACTIVE;
314                 }
315                 else {
316                         if (params->port1_active)
317                                 config |= TDA9887_PORT1_ACTIVE;
318                         if (params->port2_active)
319                                 config |= TDA9887_PORT2_ACTIVE;
320                 }
321                 if (params->intercarrier_mode)
322                         config |= TDA9887_INTERCARRIER;
323                 if (is_secam_l) {
324                         if (i == 0 && params->default_top_secam_low)
325                                 config |= TDA9887_TOP(params->default_top_secam_low);
326                         else if (i == 1 && params->default_top_secam_mid)
327                                 config |= TDA9887_TOP(params->default_top_secam_mid);
328                         else if (params->default_top_secam_high)
329                                 config |= TDA9887_TOP(params->default_top_secam_high);
330                 }
331                 else {
332                         if (i == 0 && params->default_top_low)
333                                 config |= TDA9887_TOP(params->default_top_low);
334                         else if (i == 1 && params->default_top_mid)
335                                 config |= TDA9887_TOP(params->default_top_mid);
336                         else if (params->default_top_high)
337                                 config |= TDA9887_TOP(params->default_top_high);
338                 }
339                 if (params->default_pll_gating_18)
340                         config |= TDA9887_GATING_18;
341                 i2c_clients_command(c->adapter, TDA9887_SET_CONFIG, &config);
342         }
343         tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
344                   buffer[0],buffer[1],buffer[2],buffer[3]);
345
346         if (4 != (rc = i2c_master_send(c,buffer,4)))
347                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
348
349         switch (t->type) {
350         case TUNER_LG_TDVS_H06XF:
351                 /* Set the Auxiliary Byte. */
352                 buffer[0] = buffer[2];
353                 buffer[0] &= ~0x20;
354                 buffer[0] |= 0x18;
355                 buffer[1] = 0x20;
356                 tuner_dbg("tv 0x%02x 0x%02x\n",buffer[0],buffer[1]);
357
358                 if (2 != (rc = i2c_master_send(c,buffer,2)))
359                         tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
360                 break;
361         case TUNER_MICROTUNE_4042FI5:
362         {
363                 // FIXME - this may also work for other tuners
364                 unsigned long timeout = jiffies + msecs_to_jiffies(1);
365                 u8 status_byte = 0;
366
367                 /* Wait until the PLL locks */
368                 for (;;) {
369                         if (time_after(jiffies,timeout))
370                                 return;
371                         if (1 != (rc = i2c_master_recv(c,&status_byte,1))) {
372                                 tuner_warn("i2c i/o read error: rc == %d (should be 1)\n",rc);
373                                 break;
374                         }
375                         if (status_byte & TUNER_PLL_LOCKED)
376                                 break;
377                         udelay(10);
378                 }
379
380                 /* Set the charge pump for optimized phase noise figure */
381                 config &= ~TUNER_CHARGE_PUMP;
382                 buffer[0] = (div>>8) & 0x7f;
383                 buffer[1] = div      & 0xff;
384                 buffer[2] = config;
385                 buffer[3] = cb;
386                 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
387                           buffer[0],buffer[1],buffer[2],buffer[3]);
388
389                 if (4 != (rc = i2c_master_send(c,buffer,4)))
390                         tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
391                 break;
392         }
393         }
394 }
395
396 static void default_set_radio_freq(struct i2c_client *c, unsigned int freq)
397 {
398         struct tunertype *tun;
399         struct tuner *t = i2c_get_clientdata(c);
400         u8 buffer[4];
401         u16 div;
402         int rc, j;
403         enum param_type desired_type = TUNER_PARAM_TYPE_RADIO;
404         struct tuner_params *params;
405
406         tun = &tuners[t->type];
407
408         for (j = 0; j < tun->count-1; j++) {
409                 if (desired_type != tun->params[j].type)
410                         continue;
411                 break;
412         }
413         /* use default tuner_params if desired_type not available */
414         if (desired_type != tun->params[j].type)
415                 j = 0;
416
417         div = (20 * freq / 16000) + (int)(20*10.7); /* IF 10.7 MHz */
418         params = &tun->params[j];
419         buffer[2] = (params->ranges[0].config & ~TUNER_RATIO_MASK) | TUNER_RATIO_SELECT_50; /* 50 kHz step */
420
421         switch (t->type) {
422         case TUNER_TENA_9533_DI:
423         case TUNER_YMEC_TVF_5533MF:
424                 tuner_dbg ("This tuner doesn't have FM. Most cards has a TEA5767 for FM\n");
425                 return;
426         case TUNER_PHILIPS_FM1216ME_MK3:
427         case TUNER_PHILIPS_FM1236_MK3:
428         case TUNER_PHILIPS_FMD1216ME_MK3:
429         case TUNER_LG_NTSC_TAPE:
430                 buffer[3] = 0x19;
431                 break;
432         case TUNER_TNF_5335MF:
433                 buffer[3] = 0x11;
434                 break;
435         case TUNER_PHILIPS_FM1256_IH3:
436                 div = (20 * freq) / 16000 + (int)(33.3 * 20);  /* IF 33.3 MHz */
437                 buffer[3] = 0x19;
438                 break;
439         case TUNER_LG_PAL_FM:
440                 buffer[3] = 0xa5;
441                 break;
442         case TUNER_MICROTUNE_4049FM5:
443                 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
444                 buffer[3] = 0xa4;
445                 break;
446         default:
447                 buffer[3] = 0xa4;
448                 break;
449         }
450         if (params->cb_first_if_lower_freq && div < t->last_div) {
451                 buffer[0] = buffer[2];
452                 buffer[1] = buffer[3];
453                 buffer[2] = (div>>8) & 0x7f;
454                 buffer[3] = div      & 0xff;
455         } else {
456                 buffer[0] = (div>>8) & 0x7f;
457                 buffer[1] = div      & 0xff;
458         }
459
460         tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
461                buffer[0],buffer[1],buffer[2],buffer[3]);
462         t->last_div = div;
463
464         if (params->has_tda9887) {
465                 int config = 0;
466                 if (params->port1_active && !params->port1_fm_high_sensitivity)
467                         config |= TDA9887_PORT1_ACTIVE;
468                 if (params->port2_active && !params->port2_fm_high_sensitivity)
469                         config |= TDA9887_PORT2_ACTIVE;
470                 if (params->intercarrier_mode)
471                         config |= TDA9887_INTERCARRIER;
472 /*              if (params->port1_set_for_fm_mono)
473                         config &= ~TDA9887_PORT1_ACTIVE;*/
474                 if (params->fm_gain_normal)
475                         config |= TDA9887_GAIN_NORMAL;
476                 i2c_clients_command(c->adapter, TDA9887_SET_CONFIG, &config);
477         }
478         if (4 != (rc = i2c_master_send(c,buffer,4)))
479                 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
480 }
481
482 int default_tuner_init(struct i2c_client *c)
483 {
484         struct tuner *t = i2c_get_clientdata(c);
485
486         tuner_info("type set to %d (%s)\n",
487                    t->type, tuners[t->type].name);
488         strlcpy(c->name, tuners[t->type].name, sizeof(c->name));
489
490         t->ops.set_tv_freq = default_set_tv_freq;
491         t->ops.set_radio_freq = default_set_radio_freq;
492         t->ops.has_signal = tuner_signal;
493         t->ops.is_stereo = tuner_stereo;
494         t->ops.standby = NULL;
495
496         return 0;
497 }
498
499 /*
500  * Overrides for Emacs so that we follow Linus's tabbing style.
501  * ---------------------------------------------------------------------------
502  * Local variables:
503  * c-basic-offset: 8
504  * End:
505  */