blob: 3879262cf4ca9351d9ed70af5d4d50e3c81bb7af [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
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
Mauro Carvalho Chehab5c07db02006-01-09 15:25:11 -020011static int offset = 0;
12module_param(offset, int, 0666);
13MODULE_PARM_DESC(offset,"Allows to specify an offset for tuner");
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015/* ---------------------------------------------------------------------- */
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
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -070060/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Michael Krufky7b0ac9c2006-01-13 14:10:25 -020082#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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93/* ---------------------------------------------------------------------- */
94
95static 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;
Mauro Carvalho Chehab56fc08c2005-06-23 22:05:07 -0700101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 return byte;
103}
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105static int tuner_signal(struct i2c_client *c)
106{
Mauro Carvalho Chehab56fc08c2005-06-23 22:05:07 -0700107 return (tuner_getstatus(c) & TUNER_SIGNAL) << 13;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108}
109
110static int tuner_stereo(struct i2c_client *c)
111{
Mauro Carvalho Chehab56fc08c2005-06-23 22:05:07 -0700112 int stereo, status;
113 struct tuner *t = i2c_get_clientdata(c);
114
115 status = tuner_getstatus (c);
116
117 switch (t->type) {
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800118 case TUNER_PHILIPS_FM1216ME_MK3:
Mauro Carvalho Chehab56fc08c2005-06-23 22:05:07 -0700119 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128}
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131/* ---------------------------------------------------------------------- */
132
133static void default_set_tv_freq(struct i2c_client *c, unsigned int freq)
134{
135 struct tuner *t = i2c_get_clientdata(c);
Michael Krufkyf4372be2005-11-08 21:38:19 -0800136 u8 config, tuneraddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 u16 div;
138 struct tunertype *tun;
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800139 unsigned char buffer[4];
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200140 int rc, IFPCoff, i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 tun = &tuners[t->type];
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200143 j = TUNER_PARAM_ANALOG;
144
145 for (i = 0; i < tun->params[j].count; i++) {
146 if (freq > tun->params[j].ranges[i].limit)
Michael Krufky90200d22006-01-09 15:25:38 -0200147 continue;
148 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 }
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200150 config = tun->params[j].ranges[i].cb;
Michael Krufky90200d22006-01-09 15:25:38 -0200151 /* i == 0 -> VHF_LO */
152 /* i == 1 -> VHF_HI */
153 /* i == 2 -> UHF */
154 tuner_dbg("tv: range %d\n",i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156 /* tv norm specific stuff for multi-norm tuners */
157 switch (t->type) {
158 case TUNER_PHILIPS_SECAM: // FI1216MF
159 /* 0x01 -> ??? no change ??? */
160 /* 0x02 -> PAL BDGHI / SECAM L */
161 /* 0x04 -> ??? PAL others / SECAM others ??? */
162 config &= ~0x02;
163 if (t->std & V4L2_STD_SECAM)
164 config |= 0x02;
165 break;
166
167 case TUNER_TEMIC_4046FM5:
168 config &= ~0x0f;
169
170 if (t->std & V4L2_STD_PAL_BG) {
171 config |= TEMIC_SET_PAL_BG;
172
173 } else if (t->std & V4L2_STD_PAL_I) {
174 config |= TEMIC_SET_PAL_I;
175
176 } else if (t->std & V4L2_STD_PAL_DK) {
177 config |= TEMIC_SET_PAL_DK;
178
179 } else if (t->std & V4L2_STD_SECAM_L) {
180 config |= TEMIC_SET_PAL_L;
181
182 }
183 break;
184
185 case TUNER_PHILIPS_FQ1216ME:
186 config &= ~0x0f;
187
188 if (t->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
189 config |= PHILIPS_SET_PAL_BGDK;
190
191 } else if (t->std & V4L2_STD_PAL_I) {
192 config |= PHILIPS_SET_PAL_I;
193
194 } else if (t->std & V4L2_STD_SECAM_L) {
195 config |= PHILIPS_SET_PAL_L;
196
197 }
198 break;
199
200 case TUNER_PHILIPS_ATSC:
201 /* 0x00 -> ATSC antenna input 1 */
202 /* 0x01 -> ATSC antenna input 2 */
203 /* 0x02 -> NTSC antenna input 1 */
204 /* 0x03 -> NTSC antenna input 2 */
205 config &= ~0x03;
206 if (!(t->std & V4L2_STD_ATSC))
207 config |= 2;
208 /* FIXME: input */
209 break;
210
211 case TUNER_MICROTUNE_4042FI5:
212 /* Set the charge pump for fast tuning */
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200213 tun->params[j].config |= TUNER_CHARGE_PUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 break;
Kirk Lapraye976f9372005-11-08 21:37:04 -0800215
216 case TUNER_PHILIPS_TUV1236D:
217 /* 0x40 -> ATSC antenna input 1 */
218 /* 0x48 -> ATSC antenna input 2 */
219 /* 0x00 -> NTSC antenna input 1 */
220 /* 0x08 -> NTSC antenna input 2 */
Kirk Laprayfde6d312005-11-08 21:38:18 -0800221 buffer[0] = 0x14;
222 buffer[1] = 0x00;
223 buffer[2] = 0x17;
224 buffer[3] = 0x00;
Kirk Lapraye976f9372005-11-08 21:37:04 -0800225 config &= ~0x40;
Kirk Laprayfde6d312005-11-08 21:38:18 -0800226 if (t->std & V4L2_STD_ATSC) {
Kirk Lapraye976f9372005-11-08 21:37:04 -0800227 config |= 0x40;
Kirk Laprayfde6d312005-11-08 21:38:18 -0800228 buffer[1] = 0x04;
229 }
230 /* set to the correct mode (analog or digital) */
Kirk Laprayfde6d312005-11-08 21:38:18 -0800231 tuneraddr = c->addr;
232 c->addr = 0x0a;
233 if (2 != (rc = i2c_master_send(c,&buffer[0],2)))
234 tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
235 if (2 != (rc = i2c_master_send(c,&buffer[2],2)))
236 tuner_warn("i2c i/o error: rc == %d (should be 2)\n",rc);
237 c->addr = tuneraddr;
Kirk Lapraye976f9372005-11-08 21:37:04 -0800238 /* FIXME: input */
239 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 }
241
242 /*
243 * Philips FI1216MK2 remark from specification :
244 * for channel selection involving band switching, and to ensure
245 * smooth tuning to the desired channel without causing
246 * unnecessary charge pump action, it is recommended to consider
247 * the difference between wanted channel frequency and the
248 * current channel frequency. Unnecessary charge pump action
249 * will result in very low tuning voltage which may drive the
250 * oscillator to extreme conditions.
251 *
252 * Progfou: specification says to send config data before
253 * frequency in case (wanted frequency < current frequency).
254 */
255
Mauro Carvalho Chehab1faf11a2006-01-09 15:25:03 -0200256 /* IFPCoff = Video Intermediate Frequency - Vif:
257 940 =16*58.75 NTSC/J (Japan)
258 732 =16*45.75 M/N STD
259 704 =16*44 ATSC (at DVB code)
260 632 =16*39.50 I U.K.
261 622.4=16*38.90 B/G D/K I, L STD
262 592 =16*37.00 D China
263 590 =16.36.875 B Australia
264 543.2=16*33.95 L' STD
265 171.2=16*10.70 FM Radio (at set_radio_freq)
266 */
267
Hans Verkuila1789d32006-01-09 15:25:19 -0200268 if (t->std == V4L2_STD_NTSC_M_JP) {
Mauro Carvalho Chehab1faf11a2006-01-09 15:25:03 -0200269 IFPCoff = 940;
Hans Verkuila1789d32006-01-09 15:25:19 -0200270 } else if ((t->std & V4L2_STD_MN) &&
271 !(t->std & ~V4L2_STD_MN)) {
Mauro Carvalho Chehab1faf11a2006-01-09 15:25:03 -0200272 IFPCoff = 732;
Hans Verkuila1789d32006-01-09 15:25:19 -0200273 } else if (t->std == V4L2_STD_SECAM_LC) {
Mauro Carvalho Chehab1faf11a2006-01-09 15:25:03 -0200274 IFPCoff = 543;
275 } else {
276 IFPCoff = 623;
277 }
278
Mauro Carvalho Chehab5c07db02006-01-09 15:25:11 -0200279 div=freq + IFPCoff + offset;
Mauro Carvalho Chehabf5b90a22006-01-09 15:25:12 -0200280
281 tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, Offset=%d.%02d MHz, div=%0d\n",
282 freq / 16, freq % 16 * 100 / 16,
283 IFPCoff / 16, IFPCoff % 16 * 100 / 16,
284 offset / 16, offset % 16 * 100 / 16,
285 div);
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 if (t->type == TUNER_PHILIPS_SECAM && freq < t->freq) {
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200288 buffer[0] = tun->params[j].config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 buffer[1] = config;
290 buffer[2] = (div>>8) & 0x7f;
291 buffer[3] = div & 0xff;
292 } else {
293 buffer[0] = (div>>8) & 0x7f;
294 buffer[1] = div & 0xff;
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200295 buffer[2] = tun->params[j].config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 buffer[3] = config;
297 }
298 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
299 buffer[0],buffer[1],buffer[2],buffer[3]);
300
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800301 if (4 != (rc = i2c_master_send(c,buffer,4)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
303
304 if (t->type == TUNER_MICROTUNE_4042FI5) {
305 // FIXME - this may also work for other tuners
306 unsigned long timeout = jiffies + msecs_to_jiffies(1);
307 u8 status_byte = 0;
308
309 /* Wait until the PLL locks */
310 for (;;) {
311 if (time_after(jiffies,timeout))
312 return;
313 if (1 != (rc = i2c_master_recv(c,&status_byte,1))) {
314 tuner_warn("i2c i/o read error: rc == %d (should be 1)\n",rc);
315 break;
316 }
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -0700317 if (status_byte & TUNER_PLL_LOCKED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 break;
319 udelay(10);
320 }
321
322 /* Set the charge pump for optimized phase noise figure */
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200323 tun->params[j].config &= ~TUNER_CHARGE_PUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 buffer[0] = (div>>8) & 0x7f;
325 buffer[1] = div & 0xff;
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200326 buffer[2] = tun->params[j].config;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 buffer[3] = config;
328 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
329 buffer[0],buffer[1],buffer[2],buffer[3]);
330
331 if (4 != (rc = i2c_master_send(c,buffer,4)))
332 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
333 }
334}
335
336static void default_set_radio_freq(struct i2c_client *c, unsigned int freq)
337{
338 struct tunertype *tun;
339 struct tuner *t = i2c_get_clientdata(c);
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800340 unsigned char buffer[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 unsigned div;
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200342 int rc, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -0700344 tun = &tuners[t->type];
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200345 j = TUNER_PARAM_ANALOG;
346
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -0700347 div = (20 * freq / 16000) + (int)(20*10.7); /* IF 10.7 MHz */
Michael Krufky7b0ac9c2006-01-13 14:10:25 -0200348 buffer[2] = (tun->params[j].config & ~TUNER_RATIO_MASK) | TUNER_RATIO_SELECT_50; /* 50 kHz step */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350 switch (t->type) {
Mauro Carvalho Chehab56fc08c2005-06-23 22:05:07 -0700351 case TUNER_TENA_9533_DI:
Mauro Carvalho Chehab391cd722005-06-23 22:02:43 -0700352 case TUNER_YMEC_TVF_5533MF:
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -0700353 tuner_dbg ("This tuner doesn't have FM. Most cards has a TEA5767 for FM\n");
354 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 case TUNER_PHILIPS_FM1216ME_MK3:
356 case TUNER_PHILIPS_FM1236_MK3:
Mauro Carvalho Chehab586b0ca2005-06-28 20:45:21 -0700357 case TUNER_PHILIPS_FMD1216ME_MK3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 buffer[3] = 0x19;
359 break;
360 case TUNER_PHILIPS_FM1256_IH3:
Mauro Carvalho Chehabf7ce3cc2005-07-12 13:58:55 -0700361 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 buffer[3] = 0x19;
363 break;
364 case TUNER_LG_PAL_FM:
365 buffer[3] = 0xa5;
366 break;
Mauro Carvalho Chehab33ac6b52005-09-09 13:03:56 -0700367 case TUNER_MICROTUNE_4049FM5:
368 div = (20 * freq) / 16000 + (int)(33.3 * 20); /* IF 33.3 MHz */
369 buffer[3] = 0xa4;
370 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 default:
372 buffer[3] = 0xa4;
373 break;
374 }
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800375 buffer[0] = (div>>8) & 0x7f;
376 buffer[1] = div & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
379 buffer[0],buffer[1],buffer[2],buffer[3]);
380
Mauro Carvalho Chehab4ac97912005-11-08 21:37:43 -0800381 if (4 != (rc = i2c_master_send(c,buffer,4)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 tuner_warn("i2c i/o error: rc == %d (should be 4)\n",rc);
383}
384
385int default_tuner_init(struct i2c_client *c)
386{
387 struct tuner *t = i2c_get_clientdata(c);
388
389 tuner_info("type set to %d (%s)\n",
390 t->type, tuners[t->type].name);
391 strlcpy(c->name, tuners[t->type].name, sizeof(c->name));
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 t->tv_freq = default_set_tv_freq;
394 t->radio_freq = default_set_radio_freq;
395 t->has_signal = tuner_signal;
396 t->is_stereo = tuner_stereo;
Mauro Carvalho Chehab793cf9e2005-09-09 13:03:37 -0700397 t->standby = NULL;
Mauro Carvalho Chehab586b0ca2005-06-28 20:45:21 -0700398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 return 0;
400}
401
402/*
403 * Overrides for Emacs so that we follow Linus's tabbing style.
404 * ---------------------------------------------------------------------------
405 * Local variables:
406 * c-basic-offset: 8
407 * End:
408 */