2 * i2c tv tuner chip device driver
3 * controls all those simple 4-control-bytes style tuners.
5 * This "tuner-simple" module was split apart from the original "tuner" module.
7 #include <linux/delay.h>
9 #include <linux/videodev.h>
10 #include <media/tuner.h>
11 #include <media/v4l2-common.h>
12 #include <media/tuner-types.h>
13 #include "tuner-i2c.h"
14 #include "tuner-simple.h"
17 module_param(debug, int, 0644);
18 MODULE_PARM_DESC(debug, "enable verbose debug messages");
21 module_param(offset, int, 0664);
22 MODULE_PARM_DESC(offset, "Allows to specify an offset for tuner");
24 /* ---------------------------------------------------------------------- */
26 /* tv standard selection for Temic 4046 FM5
27 this value takes the low bits of control byte 2
28 from datasheet Rev.01, Feb.00
30 picture IF 38.9 38.9 38.9 33.95 38.9
31 sound 1 33.4 32.9 32.4 40.45 32.4
33 NICAM 33.05 32.348 33.05 33.05
35 #define TEMIC_SET_PAL_I 0x05
36 #define TEMIC_SET_PAL_DK 0x09
37 #define TEMIC_SET_PAL_L 0x0a /* SECAM ? */
38 #define TEMIC_SET_PAL_L2 0x0b /* change IF ! */
39 #define TEMIC_SET_PAL_BG 0x0c
41 /* tv tuner system standard selection for Philips FQ1216ME
42 this value takes the low bits of control byte 2
43 from datasheet "1999 Nov 16" (supersedes "1999 Mar 23")
45 picture carrier 38.90 38.90 38.90 38.90 33.95
46 colour 34.47 34.47 34.47 34.47 38.38
47 sound 1 33.40 32.40 32.90 32.40 40.45
49 NICAM 33.05 33.05 32.35 33.05 39.80
51 #define PHILIPS_SET_PAL_I 0x01 /* Bit 2 always zero !*/
52 #define PHILIPS_SET_PAL_BGDK 0x09
53 #define PHILIPS_SET_PAL_L2 0x0a
54 #define PHILIPS_SET_PAL_L 0x0b
56 /* system switching for Philips FI1216MF MK2
57 from datasheet "1996 Jul 09",
59 picture carrier 38.90 38.90 33.95
60 colour 34.47 34.37 38.38
61 sound 1 33.40 32.40 40.45
63 NICAM 33.05 33.05 39.80
65 #define PHILIPS_MF_SET_STD_BG 0x01 /* Bit 2 must be zero, Bit 3 is system output */
66 #define PHILIPS_MF_SET_STD_L 0x03 /* Used on Secam France */
67 #define PHILIPS_MF_SET_STD_LC 0x02 /* Used on SECAM L' */
71 #define TUNER_RATIO_MASK 0x06 /* Bit cb1:cb2 */
72 #define TUNER_RATIO_SELECT_50 0x00
73 #define TUNER_RATIO_SELECT_32 0x02
74 #define TUNER_RATIO_SELECT_166 0x04
75 #define TUNER_RATIO_SELECT_62 0x06
77 #define TUNER_CHARGE_PUMP 0x40 /* Bit cb6 */
81 #define TUNER_POR 0x80
83 #define TUNER_MODE 0x38
84 #define TUNER_AFC 0x07
85 #define TUNER_SIGNAL 0x07
86 #define TUNER_STEREO 0x10
88 #define TUNER_PLL_LOCKED 0x40
89 #define TUNER_STEREO_MK3 0x04
91 struct tuner_simple_priv {
93 struct tuner_i2c_props i2c_props;
96 struct tunertype *tun;
101 /* ---------------------------------------------------------------------- */
103 static int tuner_read_status(struct dvb_frontend *fe)
105 struct tuner_simple_priv *priv = fe->tuner_priv;
108 if (1 != tuner_i2c_xfer_recv(&priv->i2c_props, &byte, 1))
114 static inline int tuner_signal(const int status)
116 return (status & TUNER_SIGNAL) << 13;
119 static inline int tuner_stereo(const int type, const int status)
122 case TUNER_PHILIPS_FM1216ME_MK3:
123 case TUNER_PHILIPS_FM1236_MK3:
124 case TUNER_PHILIPS_FM1256_IH3:
125 case TUNER_LG_NTSC_TAPE:
126 return ((status & TUNER_SIGNAL) == TUNER_STEREO_MK3);
128 return status & TUNER_STEREO;
132 static inline int tuner_islocked(const int status)
134 return (status & TUNER_FL);
137 static inline int tuner_afcstatus(const int status)
139 return (status & TUNER_AFC) - 2;
143 static int simple_get_status(struct dvb_frontend *fe, u32 *status)
145 struct tuner_simple_priv *priv = fe->tuner_priv;
146 int tuner_status = tuner_read_status(fe);
150 if (tuner_islocked(tuner_status))
151 *status = TUNER_STATUS_LOCKED;
152 if (tuner_stereo(priv->type, tuner_status))
153 *status |= TUNER_STATUS_STEREO;
155 tuner_dbg("AFC Status: %d\n", tuner_afcstatus(tuner_status));
160 static int simple_get_rf_strength(struct dvb_frontend *fe, u16 *strength)
162 struct tuner_simple_priv *priv = fe->tuner_priv;
163 int signal = tuner_signal(tuner_read_status(fe));
167 tuner_dbg("Signal strength: %d\n", signal);
172 /* ---------------------------------------------------------------------- */
174 static inline char *tuner_param_name(enum param_type type)
179 case TUNER_PARAM_TYPE_RADIO:
182 case TUNER_PARAM_TYPE_PAL:
185 case TUNER_PARAM_TYPE_SECAM:
188 case TUNER_PARAM_TYPE_NTSC:
198 static struct tuner_params *simple_tuner_params(struct dvb_frontend *fe,
199 enum param_type desired_type)
201 struct tuner_simple_priv *priv = fe->tuner_priv;
202 struct tunertype *tun = priv->tun;
205 for (i = 0; i < tun->count; i++)
206 if (desired_type == tun->params[i].type)
209 /* use default tuner params if desired_type not available */
210 if (i == tun->count) {
211 tuner_dbg("desired params (%s) undefined for tuner %d\n",
212 tuner_param_name(desired_type), priv->type);
216 tuner_dbg("using tuner params #%d (%s)\n", i,
217 tuner_param_name(tun->params[i].type));
219 return &tun->params[i];
222 static int simple_config_lookup(struct dvb_frontend *fe,
223 struct tuner_params *t_params,
224 int *frequency, u8 *config, u8 *cb)
226 struct tuner_simple_priv *priv = fe->tuner_priv;
229 for (i = 0; i < t_params->count; i++) {
230 if (*frequency > t_params->ranges[i].limit)
234 if (i == t_params->count) {
235 tuner_dbg("frequency out of range (%d > %d)\n",
236 *frequency, t_params->ranges[i - 1].limit);
237 *frequency = t_params->ranges[--i].limit;
239 *config = t_params->ranges[i].config;
240 *cb = t_params->ranges[i].cb;
242 tuner_dbg("freq = %d.%02d (%d), range = %d, "
243 "config = 0x%02x, cb = 0x%02x\n",
244 *frequency / 16, *frequency % 16 * 100 / 16, *frequency,
250 /* ---------------------------------------------------------------------- */
252 static int simple_std_setup(struct dvb_frontend *fe,
253 struct analog_parameters *params,
254 u8 *buffer, u8 *config, u8 *cb)
256 struct tuner_simple_priv *priv = fe->tuner_priv;
260 /* tv norm specific stuff for multi-norm tuners */
261 switch (priv->type) {
262 case TUNER_PHILIPS_SECAM: /* FI1216MF */
263 /* 0x01 -> ??? no change ??? */
264 /* 0x02 -> PAL BDGHI / SECAM L */
265 /* 0x04 -> ??? PAL others / SECAM others ??? */
267 if (params->std & V4L2_STD_SECAM_L)
268 /* also valid for V4L2_STD_SECAM */
269 *cb |= PHILIPS_MF_SET_STD_L;
270 else if (params->std & V4L2_STD_SECAM_LC)
271 *cb |= PHILIPS_MF_SET_STD_LC;
272 else /* V4L2_STD_B|V4L2_STD_GH */
273 *cb |= PHILIPS_MF_SET_STD_BG;
276 case TUNER_TEMIC_4046FM5:
279 if (params->std & V4L2_STD_PAL_BG) {
280 *cb |= TEMIC_SET_PAL_BG;
282 } else if (params->std & V4L2_STD_PAL_I) {
283 *cb |= TEMIC_SET_PAL_I;
285 } else if (params->std & V4L2_STD_PAL_DK) {
286 *cb |= TEMIC_SET_PAL_DK;
288 } else if (params->std & V4L2_STD_SECAM_L) {
289 *cb |= TEMIC_SET_PAL_L;
294 case TUNER_PHILIPS_FQ1216ME:
297 if (params->std & (V4L2_STD_PAL_BG|V4L2_STD_PAL_DK)) {
298 *cb |= PHILIPS_SET_PAL_BGDK;
300 } else if (params->std & V4L2_STD_PAL_I) {
301 *cb |= PHILIPS_SET_PAL_I;
303 } else if (params->std & V4L2_STD_SECAM_L) {
304 *cb |= PHILIPS_SET_PAL_L;
309 case TUNER_PHILIPS_ATSC:
310 /* 0x00 -> ATSC antenna input 1 */
311 /* 0x01 -> ATSC antenna input 2 */
312 /* 0x02 -> NTSC antenna input 1 */
313 /* 0x03 -> NTSC antenna input 2 */
315 if (!(params->std & V4L2_STD_ATSC))
320 case TUNER_MICROTUNE_4042FI5:
321 /* Set the charge pump for fast tuning */
322 *config |= TUNER_CHARGE_PUMP;
325 case TUNER_PHILIPS_TUV1236D:
326 /* 0x40 -> ATSC antenna input 1 */
327 /* 0x48 -> ATSC antenna input 2 */
328 /* 0x00 -> NTSC antenna input 1 */
329 /* 0x08 -> NTSC antenna input 2 */
335 if (params->std & V4L2_STD_ATSC) {
339 /* set to the correct mode (analog or digital) */
340 tuneraddr = priv->i2c_props.addr;
341 priv->i2c_props.addr = 0x0a;
342 rc = tuner_i2c_xfer_send(&priv->i2c_props, &buffer[0], 2);
344 tuner_warn("i2c i/o error: rc == %d "
345 "(should be 2)\n", rc);
346 rc = tuner_i2c_xfer_send(&priv->i2c_props, &buffer[2], 2);
348 tuner_warn("i2c i/o error: rc == %d "
349 "(should be 2)\n", rc);
350 priv->i2c_props.addr = tuneraddr;
358 static int simple_post_tune(struct dvb_frontend *fe, u8 *buffer,
359 u16 div, u8 config, u8 cb)
361 struct tuner_simple_priv *priv = fe->tuner_priv;
364 switch (priv->type) {
365 case TUNER_LG_TDVS_H06XF:
366 /* Set the Auxiliary Byte. */
367 buffer[0] = buffer[2];
371 tuner_dbg("tv 0x%02x 0x%02x\n", buffer[0], buffer[1]);
373 rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 2);
375 tuner_warn("i2c i/o error: rc == %d "
376 "(should be 2)\n", rc);
378 case TUNER_MICROTUNE_4042FI5:
380 /* FIXME - this may also work for other tuners */
381 unsigned long timeout = jiffies + msecs_to_jiffies(1);
384 /* Wait until the PLL locks */
386 if (time_after(jiffies, timeout))
388 rc = tuner_i2c_xfer_recv(&priv->i2c_props,
391 tuner_warn("i2c i/o read error: rc == %d "
392 "(should be 1)\n", rc);
395 if (status_byte & TUNER_PLL_LOCKED)
400 /* Set the charge pump for optimized phase noise figure */
401 config &= ~TUNER_CHARGE_PUMP;
402 buffer[0] = (div>>8) & 0x7f;
403 buffer[1] = div & 0xff;
406 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
407 buffer[0], buffer[1], buffer[2], buffer[3]);
409 rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 4);
411 tuner_warn("i2c i/o error: rc == %d "
412 "(should be 4)\n", rc);
420 static int simple_radio_bandswitch(struct dvb_frontend *fe, u8 *buffer)
422 struct tuner_simple_priv *priv = fe->tuner_priv;
424 switch (priv->type) {
425 case TUNER_TENA_9533_DI:
426 case TUNER_YMEC_TVF_5533MF:
427 tuner_dbg("This tuner doesn't have FM. "
428 "Most cards have a TEA5767 for FM\n");
430 case TUNER_PHILIPS_FM1216ME_MK3:
431 case TUNER_PHILIPS_FM1236_MK3:
432 case TUNER_PHILIPS_FMD1216ME_MK3:
433 case TUNER_LG_NTSC_TAPE:
434 case TUNER_PHILIPS_FM1256_IH3:
437 case TUNER_TNF_5335MF:
440 case TUNER_LG_PAL_FM:
443 case TUNER_THOMSON_DTT761X:
446 case TUNER_MICROTUNE_4049FM5:
455 /* ---------------------------------------------------------------------- */
457 static int simple_set_tv_freq(struct dvb_frontend *fe,
458 struct analog_parameters *params)
460 struct tuner_simple_priv *priv = fe->tuner_priv;
463 struct tunertype *tun;
466 enum param_type desired_type;
467 struct tuner_params *t_params;
471 /* IFPCoff = Video Intermediate Frequency - Vif:
472 940 =16*58.75 NTSC/J (Japan)
473 732 =16*45.75 M/N STD
474 704 =16*44 ATSC (at DVB code)
476 622.4=16*38.90 B/G D/K I, L STD
477 592 =16*37.00 D China
478 590 =16.36.875 B Australia
479 543.2=16*33.95 L' STD
480 171.2=16*10.70 FM Radio (at set_radio_freq)
483 if (params->std == V4L2_STD_NTSC_M_JP) {
485 desired_type = TUNER_PARAM_TYPE_NTSC;
486 } else if ((params->std & V4L2_STD_MN) &&
487 !(params->std & ~V4L2_STD_MN)) {
489 desired_type = TUNER_PARAM_TYPE_NTSC;
490 } else if (params->std == V4L2_STD_SECAM_LC) {
492 desired_type = TUNER_PARAM_TYPE_SECAM;
495 desired_type = TUNER_PARAM_TYPE_PAL;
498 t_params = simple_tuner_params(fe, desired_type);
500 i = simple_config_lookup(fe, t_params, ¶ms->frequency,
503 div = params->frequency + IFPCoff + offset;
505 tuner_dbg("Freq= %d.%02d MHz, V_IF=%d.%02d MHz, "
506 "Offset=%d.%02d MHz, div=%0d\n",
507 params->frequency / 16, params->frequency % 16 * 100 / 16,
508 IFPCoff / 16, IFPCoff % 16 * 100 / 16,
509 offset / 16, offset % 16 * 100 / 16, div);
511 /* tv norm specific stuff for multi-norm tuners */
512 simple_std_setup(fe, params, &buffer[1], &config, &cb);
514 if (t_params->cb_first_if_lower_freq && div < priv->last_div) {
517 buffer[2] = (div>>8) & 0x7f;
518 buffer[3] = div & 0xff;
520 buffer[0] = (div>>8) & 0x7f;
521 buffer[1] = div & 0xff;
525 priv->last_div = div;
526 if (t_params->has_tda9887) {
527 struct v4l2_priv_tun_config tda9887_cfg;
529 int is_secam_l = (params->std & (V4L2_STD_SECAM_L |
530 V4L2_STD_SECAM_LC)) &&
531 !(params->std & ~(V4L2_STD_SECAM_L |
534 tda9887_cfg.tuner = TUNER_TDA9887;
535 tda9887_cfg.priv = &config;
537 if (params->std == V4L2_STD_SECAM_LC) {
538 if (t_params->port1_active ^ t_params->port1_invert_for_secam_lc)
539 config |= TDA9887_PORT1_ACTIVE;
540 if (t_params->port2_active ^ t_params->port2_invert_for_secam_lc)
541 config |= TDA9887_PORT2_ACTIVE;
543 if (t_params->port1_active)
544 config |= TDA9887_PORT1_ACTIVE;
545 if (t_params->port2_active)
546 config |= TDA9887_PORT2_ACTIVE;
548 if (t_params->intercarrier_mode)
549 config |= TDA9887_INTERCARRIER;
551 if (i == 0 && t_params->default_top_secam_low)
552 config |= TDA9887_TOP(t_params->default_top_secam_low);
553 else if (i == 1 && t_params->default_top_secam_mid)
554 config |= TDA9887_TOP(t_params->default_top_secam_mid);
555 else if (t_params->default_top_secam_high)
556 config |= TDA9887_TOP(t_params->default_top_secam_high);
558 if (i == 0 && t_params->default_top_low)
559 config |= TDA9887_TOP(t_params->default_top_low);
560 else if (i == 1 && t_params->default_top_mid)
561 config |= TDA9887_TOP(t_params->default_top_mid);
562 else if (t_params->default_top_high)
563 config |= TDA9887_TOP(t_params->default_top_high);
565 if (t_params->default_pll_gating_18)
566 config |= TDA9887_GATING_18;
567 i2c_clients_command(priv->i2c_props.adap, TUNER_SET_CONFIG,
570 tuner_dbg("tv 0x%02x 0x%02x 0x%02x 0x%02x\n",
571 buffer[0], buffer[1], buffer[2], buffer[3]);
573 rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 4);
575 tuner_warn("i2c i/o error: rc == %d (should be 4)\n", rc);
577 simple_post_tune(fe, &buffer[0], div, config, cb);
582 static int simple_set_radio_freq(struct dvb_frontend *fe,
583 struct analog_parameters *params)
585 struct tunertype *tun;
586 struct tuner_simple_priv *priv = fe->tuner_priv;
590 struct tuner_params *t_params;
591 unsigned int freq = params->frequency;
595 for (j = tun->count-1; j > 0; j--)
596 if (tun->params[j].type == TUNER_PARAM_TYPE_RADIO)
598 /* default t_params (j=0) will be used if desired type wasn't found */
599 t_params = &tun->params[j];
601 /* Select Radio 1st IF used */
602 switch (t_params->radio_if) {
603 case 0: /* 10.7 MHz */
604 freq += (unsigned int)(10.7*16000);
606 case 1: /* 33.3 MHz */
607 freq += (unsigned int)(33.3*16000);
609 case 2: /* 41.3 MHz */
610 freq += (unsigned int)(41.3*16000);
613 tuner_warn("Unsupported radio_if value %d\n",
618 /* Bandswitch byte */
619 simple_radio_bandswitch(fe, &buffer[0]);
621 buffer[2] = (t_params->ranges[0].config & ~TUNER_RATIO_MASK) |
622 TUNER_RATIO_SELECT_50; /* 50 kHz step */
624 /* Convert from 1/16 kHz V4L steps to 1/20 MHz (=50 kHz) PLL steps
625 freq * (1 Mhz / 16000 V4L steps) * (20 PLL steps / 1 MHz) =
627 div = (freq + 400) / 800;
629 if (t_params->cb_first_if_lower_freq && div < priv->last_div) {
630 buffer[0] = buffer[2];
631 buffer[1] = buffer[3];
632 buffer[2] = (div>>8) & 0x7f;
633 buffer[3] = div & 0xff;
635 buffer[0] = (div>>8) & 0x7f;
636 buffer[1] = div & 0xff;
639 tuner_dbg("radio 0x%02x 0x%02x 0x%02x 0x%02x\n",
640 buffer[0], buffer[1], buffer[2], buffer[3]);
641 priv->last_div = div;
643 if (t_params->has_tda9887) {
645 struct v4l2_priv_tun_config tda9887_cfg;
647 tda9887_cfg.tuner = TUNER_TDA9887;
648 tda9887_cfg.priv = &config;
650 if (t_params->port1_active &&
651 !t_params->port1_fm_high_sensitivity)
652 config |= TDA9887_PORT1_ACTIVE;
653 if (t_params->port2_active &&
654 !t_params->port2_fm_high_sensitivity)
655 config |= TDA9887_PORT2_ACTIVE;
656 if (t_params->intercarrier_mode)
657 config |= TDA9887_INTERCARRIER;
658 /* if (t_params->port1_set_for_fm_mono)
659 config &= ~TDA9887_PORT1_ACTIVE;*/
660 if (t_params->fm_gain_normal)
661 config |= TDA9887_GAIN_NORMAL;
662 if (t_params->radio_if == 2)
663 config |= TDA9887_RIF_41_3;
664 i2c_clients_command(priv->i2c_props.adap, TUNER_SET_CONFIG,
667 rc = tuner_i2c_xfer_send(&priv->i2c_props, buffer, 4);
669 tuner_warn("i2c i/o error: rc == %d (should be 4)\n", rc);
674 static int simple_set_params(struct dvb_frontend *fe,
675 struct analog_parameters *params)
677 struct tuner_simple_priv *priv = fe->tuner_priv;
680 switch (params->mode) {
681 case V4L2_TUNER_RADIO:
682 ret = simple_set_radio_freq(fe, params);
683 priv->frequency = params->frequency * 125 / 2;
685 case V4L2_TUNER_ANALOG_TV:
686 case V4L2_TUNER_DIGITAL_TV:
687 ret = simple_set_tv_freq(fe, params);
688 priv->frequency = params->frequency * 62500;
696 static int simple_release(struct dvb_frontend *fe)
698 kfree(fe->tuner_priv);
699 fe->tuner_priv = NULL;
704 static int simple_get_frequency(struct dvb_frontend *fe, u32 *frequency)
706 struct tuner_simple_priv *priv = fe->tuner_priv;
707 *frequency = priv->frequency;
711 static struct dvb_tuner_ops simple_tuner_ops = {
712 .set_analog_params = simple_set_params,
713 .release = simple_release,
714 .get_frequency = simple_get_frequency,
715 .get_status = simple_get_status,
716 .get_rf_strength = simple_get_rf_strength,
719 struct dvb_frontend *simple_tuner_attach(struct dvb_frontend *fe,
720 struct i2c_adapter *i2c_adap,
724 struct tuner_simple_priv *priv = NULL;
726 if (type >= tuner_count) {
727 printk(KERN_WARNING "%s: invalid tuner type: %d (max: %d)\n",
728 __FUNCTION__, type, tuner_count-1);
732 priv = kzalloc(sizeof(struct tuner_simple_priv), GFP_KERNEL);
735 fe->tuner_priv = priv;
737 priv->i2c_props.addr = i2c_addr;
738 priv->i2c_props.adap = i2c_adap;
739 priv->i2c_props.name = "tuner-simple";
742 priv->tun = &tuners[type];
744 memcpy(&fe->ops.tuner_ops, &simple_tuner_ops,
745 sizeof(struct dvb_tuner_ops));
747 tuner_info("type set to %d (%s)\n", priv->type, priv->tun->name);
749 strlcpy(fe->ops.tuner_ops.info.name, priv->tun->name,
750 sizeof(fe->ops.tuner_ops.info.name));
754 EXPORT_SYMBOL_GPL(simple_tuner_attach);
756 MODULE_DESCRIPTION("Simple 4-control-bytes style tuner driver");
757 MODULE_AUTHOR("Ralph Metzler, Gerd Knorr, Gunther Mayer");
758 MODULE_LICENSE("GPL");
761 * Overrides for Emacs so that we follow Linus's tabbing style.
762 * ---------------------------------------------------------------------------