3 * i2c tv tuner chip device driver
4 * core core, i.e. kernel interfaces, registering and so on
7 #include <linux/module.h>
8 #include <linux/moduleparam.h>
9 #include <linux/kernel.h>
10 #include <linux/string.h>
11 #include <linux/timer.h>
12 #include <linux/delay.h>
13 #include <linux/errno.h>
14 #include <linux/slab.h>
15 #include <linux/poll.h>
16 #include <linux/i2c.h>
17 #include <linux/types.h>
18 #include <linux/videodev.h>
19 #include <linux/init.h>
21 #include <media/tuner.h>
22 #include <media/v4l2-common.h>
26 /* standard i2c insmod options */
27 static unsigned short normal_i2c[] = {
28 #ifdef CONFIG_TUNER_5761
31 0x42, 0x43, 0x4a, 0x4b, /* tda8290 */
32 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
33 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
39 /* insmod options used at init time => read/only */
40 static unsigned int addr = 0;
41 static unsigned int no_autodetect = 0;
42 static unsigned int show_i2c = 0;
44 /* insmod options used at runtime => read/write */
47 static unsigned int tv_range[2] = { 44, 958 };
48 static unsigned int radio_range[2] = { 65, 108 };
50 static char pal[] = "--";
51 static char secam[] = "--";
52 static char ntsc[] = "-";
55 module_param(addr, int, 0444);
56 module_param(no_autodetect, int, 0444);
57 module_param(show_i2c, int, 0444);
58 module_param_named(debug,tuner_debug, int, 0644);
59 module_param_string(pal, pal, sizeof(pal), 0644);
60 module_param_string(secam, secam, sizeof(secam), 0644);
61 module_param_string(ntsc, ntsc, sizeof(ntsc), 0644);
62 module_param_array(tv_range, int, NULL, 0644);
63 module_param_array(radio_range, int, NULL, 0644);
65 MODULE_DESCRIPTION("device driver for various TV and TV+FM radio tuners");
66 MODULE_AUTHOR("Ralph Metzler, Gerd Knorr, Gunther Mayer");
67 MODULE_LICENSE("GPL");
69 static struct i2c_driver driver;
70 static struct i2c_client client_template;
72 /* ---------------------------------------------------------------------- */
74 /* Set tuner frequency, freq in Units of 62.5kHz = 1/16MHz */
75 static void set_tv_freq(struct i2c_client *c, unsigned int freq)
77 struct tuner *t = i2c_get_clientdata(c);
79 if (t->type == UNSET) {
80 tuner_warn ("tuner type not set\n");
83 if (NULL == t->set_tv_freq) {
84 tuner_warn ("Tuner has no way to set tv freq\n");
87 if (freq < tv_range[0] * 16 || freq > tv_range[1] * 16) {
88 tuner_dbg ("TV freq (%d.%02d) out of range (%d-%d)\n",
89 freq / 16, freq % 16 * 100 / 16, tv_range[0],
91 /* V4L2 spec: if the freq is not possible then the closest
92 possible value should be selected */
93 if (freq < tv_range[0] * 16)
94 freq = tv_range[0] * 16;
96 freq = tv_range[1] * 16;
98 t->set_tv_freq(c, freq);
101 static void set_radio_freq(struct i2c_client *c, unsigned int freq)
103 struct tuner *t = i2c_get_clientdata(c);
105 if (t->type == UNSET) {
106 tuner_warn ("tuner type not set\n");
109 if (NULL == t->set_radio_freq) {
110 tuner_warn ("tuner has no way to set radio frequency\n");
113 if (freq < radio_range[0] * 16000 || freq > radio_range[1] * 16000) {
114 tuner_dbg ("radio freq (%d.%02d) out of range (%d-%d)\n",
115 freq / 16000, freq % 16000 * 100 / 16000,
116 radio_range[0], radio_range[1]);
117 /* V4L2 spec: if the freq is not possible then the closest
118 possible value should be selected */
119 if (freq < radio_range[0] * 16000)
120 freq = radio_range[0] * 16000;
122 freq = radio_range[1] * 16000;
125 t->set_radio_freq(c, freq);
128 static void set_freq(struct i2c_client *c, unsigned long freq)
130 struct tuner *t = i2c_get_clientdata(c);
133 case V4L2_TUNER_RADIO:
134 tuner_dbg("radio freq set to %lu.%02lu\n",
135 freq / 16000, freq % 16000 * 100 / 16000);
136 set_radio_freq(c, freq);
137 t->radio_freq = freq;
139 case V4L2_TUNER_ANALOG_TV:
140 case V4L2_TUNER_DIGITAL_TV:
141 tuner_dbg("tv freq set to %lu.%02lu\n",
142 freq / 16, freq % 16 * 100 / 16);
143 set_tv_freq(c, freq);
149 static void set_type(struct i2c_client *c, unsigned int type,
150 unsigned int new_mode_mask, unsigned int new_config,
151 int (*tuner_callback) (void *dev, int command,int arg))
153 struct tuner *t = i2c_get_clientdata(c);
154 unsigned char buffer[4];
156 if (type == UNSET || type == TUNER_ABSENT) {
157 tuner_dbg ("tuner 0x%02x: Tuner type absent\n",c->addr);
161 if (type >= tuner_count) {
162 tuner_warn ("tuner 0x%02x: Tuner count greater than %d\n",c->addr,tuner_count);
167 t->config = new_config;
168 if (tuner_callback != NULL) {
169 tuner_dbg("defining GPIO callback\n");
170 t->tuner_callback = tuner_callback;
173 /* This code detects calls by card attach_inform */
174 if (NULL == t->i2c.dev.driver) {
175 tuner_dbg ("tuner 0x%02x: called during i2c_client register by adapter's attach_inform\n", c->addr);
184 case TUNER_PHILIPS_TDA8290:
188 if (tea5767_tuner_init(c) == EINVAL) {
189 t->type = TUNER_ABSENT;
190 t->mode_mask = T_UNINITIALIZED;
193 t->mode_mask = T_RADIO;
195 #ifdef CONFIG_TUNER_5761
197 if (tea5761_tuner_init(c) == EINVAL) {
198 t->type = TUNER_ABSENT;
199 t->mode_mask = T_UNINITIALIZED;
202 t->mode_mask = T_RADIO;
205 case TUNER_PHILIPS_FMD1216ME_MK3:
210 i2c_master_send(c, buffer, 4);
214 i2c_master_send(c, buffer, 4);
215 default_tuner_init(c);
217 case TUNER_PHILIPS_TD1316:
222 i2c_master_send(c,buffer,4);
223 default_tuner_init(c);
226 tda9887_tuner_init(c);
229 default_tuner_init(c);
233 if (t->mode_mask == T_UNINITIALIZED)
234 t->mode_mask = new_mode_mask;
236 set_freq(c, (V4L2_TUNER_RADIO == t->mode) ? t->radio_freq : t->tv_freq);
237 tuner_dbg("%s %s I2C addr 0x%02x with type %d used for 0x%02x\n",
238 c->adapter->name, c->driver->driver.name, c->addr << 1, type,
243 * This function apply tuner config to tuner specified
244 * by tun_setup structure. I addr is unset, then admin status
245 * and tun addr status is more precise then current status,
246 * it's applied. Otherwise status and type are applied only to
247 * tuner with exactly the same addr.
250 static void set_addr(struct i2c_client *c, struct tuner_setup *tun_setup)
252 struct tuner *t = i2c_get_clientdata(c);
254 tuner_dbg("set addr for type %i\n", t->type);
256 if ( (t->type == UNSET && ((tun_setup->addr == ADDR_UNSET) &&
257 (t->mode_mask & tun_setup->mode_mask))) ||
258 (tun_setup->addr == c->addr)) {
259 set_type(c, tun_setup->type, tun_setup->mode_mask,
260 tun_setup->config, tun_setup->tuner_callback);
264 static inline int check_mode(struct tuner *t, char *cmd)
266 if ((1 << t->mode & t->mode_mask) == 0) {
271 case V4L2_TUNER_RADIO:
272 tuner_dbg("Cmd %s accepted for radio\n", cmd);
274 case V4L2_TUNER_ANALOG_TV:
275 tuner_dbg("Cmd %s accepted for analog TV\n", cmd);
277 case V4L2_TUNER_DIGITAL_TV:
278 tuner_dbg("Cmd %s accepted for digital TV\n", cmd);
284 /* get more precise norm info from insmod option */
285 static int tuner_fixup_std(struct tuner *t)
287 if ((t->std & V4L2_STD_PAL) == V4L2_STD_PAL) {
290 tuner_dbg ("insmod fixup: PAL => PAL-60\n");
291 t->std = V4L2_STD_PAL_60;
297 tuner_dbg ("insmod fixup: PAL => PAL-BG\n");
298 t->std = V4L2_STD_PAL_BG;
302 tuner_dbg ("insmod fixup: PAL => PAL-I\n");
303 t->std = V4L2_STD_PAL_I;
309 tuner_dbg ("insmod fixup: PAL => PAL-DK\n");
310 t->std = V4L2_STD_PAL_DK;
314 tuner_dbg ("insmod fixup: PAL => PAL-M\n");
315 t->std = V4L2_STD_PAL_M;
319 if (pal[1] == 'c' || pal[1] == 'C') {
320 tuner_dbg("insmod fixup: PAL => PAL-Nc\n");
321 t->std = V4L2_STD_PAL_Nc;
323 tuner_dbg ("insmod fixup: PAL => PAL-N\n");
324 t->std = V4L2_STD_PAL_N;
328 /* default parameter, do nothing */
331 tuner_warn ("pal= argument not recognised\n");
335 if ((t->std & V4L2_STD_SECAM) == V4L2_STD_SECAM) {
343 tuner_dbg("insmod fixup: SECAM => SECAM-BGH\n");
344 t->std = V4L2_STD_SECAM_B | V4L2_STD_SECAM_G | V4L2_STD_SECAM_H;
350 tuner_dbg ("insmod fixup: SECAM => SECAM-DK\n");
351 t->std = V4L2_STD_SECAM_DK;
355 if ((secam[1]=='C')||(secam[1]=='c')) {
356 tuner_dbg ("insmod fixup: SECAM => SECAM-L'\n");
357 t->std = V4L2_STD_SECAM_LC;
359 tuner_dbg ("insmod fixup: SECAM => SECAM-L\n");
360 t->std = V4L2_STD_SECAM_L;
364 /* default parameter, do nothing */
367 tuner_warn ("secam= argument not recognised\n");
372 if ((t->std & V4L2_STD_NTSC) == V4L2_STD_NTSC) {
376 tuner_dbg("insmod fixup: NTSC => NTSC-M\n");
377 t->std = V4L2_STD_NTSC_M;
381 tuner_dbg("insmod fixup: NTSC => NTSC_M_JP\n");
382 t->std = V4L2_STD_NTSC_M_JP;
386 tuner_dbg("insmod fixup: NTSC => NTSC_M_KR\n");
387 t->std = V4L2_STD_NTSC_M_KR;
390 /* default parameter, do nothing */
393 tuner_info("ntsc= argument not recognised\n");
400 static void tuner_status(struct i2c_client *client)
402 struct tuner *t = i2c_get_clientdata(client);
403 unsigned long freq, freq_fraction;
407 case V4L2_TUNER_RADIO: p = "radio"; break;
408 case V4L2_TUNER_ANALOG_TV: p = "analog TV"; break;
409 case V4L2_TUNER_DIGITAL_TV: p = "digital TV"; break;
410 default: p = "undefined"; break;
412 if (t->mode == V4L2_TUNER_RADIO) {
413 freq = t->radio_freq / 16000;
414 freq_fraction = (t->radio_freq % 16000) * 100 / 16000;
416 freq = t->tv_freq / 16;
417 freq_fraction = (t->tv_freq % 16) * 100 / 16;
419 tuner_info("Tuner mode: %s\n", p);
420 tuner_info("Frequency: %lu.%02lu MHz\n", freq, freq_fraction);
421 tuner_info("Standard: 0x%08lx\n", (unsigned long)t->std);
422 if (t->mode != V4L2_TUNER_RADIO)
425 tuner_info("Signal strength: %d\n", t->has_signal(client));
428 tuner_info("Stereo: %s\n", t->is_stereo(client) ? "yes" : "no");
432 /* ---------------------------------------------------------------------- */
434 /* static vars: used only in tuner_attach and tuner_probe */
435 static unsigned default_mode_mask;
437 /* During client attach, set_type is called by adapter's attach_inform callback.
438 set_type must then be completed by tuner_attach.
440 static int tuner_attach(struct i2c_adapter *adap, int addr, int kind)
444 client_template.adapter = adap;
445 client_template.addr = addr;
447 t = kzalloc(sizeof(struct tuner), GFP_KERNEL);
450 memcpy(&t->i2c, &client_template, sizeof(struct i2c_client));
451 i2c_set_clientdata(&t->i2c, t);
453 t->radio_if2 = 10700 * 1000; /* 10.7MHz - FM radio */
454 t->audmode = V4L2_TUNER_MODE_STEREO;
455 t->mode_mask = T_UNINITIALIZED;
456 t->tuner_status = tuner_status;
459 unsigned char buffer[16];
462 memset(buffer, 0, sizeof(buffer));
463 rc = i2c_master_recv(&t->i2c, buffer, sizeof(buffer));
464 tuner_info("I2C RECV = ");
466 printk("%02x ",buffer[i]);
469 /* HACK: This test were added to avoid tuner to probe tda9840 and tea6415c on the MXB card */
470 if (adap->id == I2C_HW_SAA7146 && addr < 0x4a)
473 /* autodetection code based on the i2c addr */
474 if (!no_autodetect) {
476 #ifdef CONFIG_TUNER_5761
478 if (tea5761_autodetection(&t->i2c) != EINVAL) {
479 t->type = TUNER_TEA5761;
480 t->mode_mask = T_RADIO;
482 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
483 default_mode_mask &= ~T_RADIO;
485 goto register_client;
493 /* If chip is not tda8290, don't register.
494 since it can be tda9887*/
495 if (tda8290_probe(&t->i2c) == 0) {
496 tuner_dbg("chip at addr %x is a tda8290\n", addr);
498 /* Default is being tda9887 */
499 t->type = TUNER_TDA9887;
500 t->mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
502 goto register_client;
506 if (tea5767_autodetection(&t->i2c) != EINVAL) {
507 t->type = TUNER_TEA5767;
508 t->mode_mask = T_RADIO;
510 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
511 default_mode_mask &= ~T_RADIO;
513 goto register_client;
519 /* Initializes only the first adapter found */
520 if (default_mode_mask != T_UNINITIALIZED) {
521 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask);
522 t->mode_mask = default_mode_mask;
523 t->tv_freq = 400 * 16; /* Sets freq to VHF High */
524 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
525 default_mode_mask = T_UNINITIALIZED;
528 /* Should be just before return */
530 tuner_info("chip found @ 0x%x (%s)\n", addr << 1, adap->name);
531 i2c_attach_client (&t->i2c);
532 set_type (&t->i2c,t->type, t->mode_mask, t->config, t->tuner_callback);
536 static int tuner_probe(struct i2c_adapter *adap)
539 normal_i2c[0] = addr;
540 normal_i2c[1] = I2C_CLIENT_END;
543 default_mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
545 if (adap->class & I2C_CLASS_TV_ANALOG)
546 return i2c_probe(adap, &addr_data, tuner_attach);
550 static int tuner_detach(struct i2c_client *client)
552 struct tuner *t = i2c_get_clientdata(client);
555 err = i2c_detach_client(&t->i2c);
558 ("Client deregistration failed, client not detached.\n");
567 * Switch tuner to other mode. If tuner support both tv and radio,
568 * set another frequency to some value (This is needed for some pal
569 * tuners to avoid locking). Otherwise, just put second tuner in
573 static inline int set_mode(struct i2c_client *client, struct tuner *t, int mode, char *cmd)
580 if (check_mode(t, cmd) == EINVAL) {
589 #define switch_v4l2() if (!t->using_v4l2) \
590 tuner_dbg("switching to v4l2\n"); \
593 static inline int check_v4l2(struct tuner *t)
595 /* bttv still uses both v4l1 and v4l2 calls to the tuner (v4l2 for
596 TV, v4l1 for radio), until that is fixed this code is disabled.
597 Otherwise the radio (v4l1) wouldn't tune after using the TV (v4l2)
602 static int tuner_command(struct i2c_client *client, unsigned int cmd, void *arg)
604 struct tuner *t = i2c_get_clientdata(client);
607 v4l_i2c_print_ioctl(&(t->i2c),cmd);
610 /* --- configuration --- */
611 case TUNER_SET_TYPE_ADDR:
612 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x, config=0x%02x\n",
613 ((struct tuner_setup *)arg)->type,
614 ((struct tuner_setup *)arg)->addr,
615 ((struct tuner_setup *)arg)->mode_mask,
616 ((struct tuner_setup *)arg)->config);
618 set_addr(client, (struct tuner_setup *)arg);
621 if (set_mode(client, t, V4L2_TUNER_RADIO, "AUDC_SET_RADIO")
625 set_freq(client, t->radio_freq);
627 case TUNER_SET_STANDBY:
628 if (check_mode(t, "TUNER_SET_STANDBY") == EINVAL)
634 #ifdef CONFIG_VIDEO_V4L1
636 if (check_mode(t, "VIDIOCSAUDIO") == EINVAL)
638 if (check_v4l2(t) == EINVAL)
641 /* Should be implemented, since bttv calls it */
642 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
646 static const v4l2_std_id map[] = {
647 [VIDEO_MODE_PAL] = V4L2_STD_PAL,
648 [VIDEO_MODE_NTSC] = V4L2_STD_NTSC_M,
649 [VIDEO_MODE_SECAM] = V4L2_STD_SECAM,
650 [4 /* bttv */ ] = V4L2_STD_PAL_M,
651 [5 /* bttv */ ] = V4L2_STD_PAL_N,
652 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP,
654 struct video_channel *vc = arg;
656 if (check_v4l2(t) == EINVAL)
659 if (set_mode(client,t,V4L2_TUNER_ANALOG_TV, "VIDIOCSCHAN")==EINVAL)
662 if (vc->norm < ARRAY_SIZE(map))
663 t->std = map[vc->norm];
666 set_tv_freq(client, t->tv_freq);
671 unsigned long *v = arg;
673 if (check_mode(t, "VIDIOCSFREQ") == EINVAL)
675 if (check_v4l2(t) == EINVAL)
678 set_freq(client, *v);
683 struct video_tuner *vt = arg;
685 if (check_mode(t, "VIDIOCGTUNER") == EINVAL)
687 if (check_v4l2(t) == EINVAL)
690 if (V4L2_TUNER_RADIO == t->mode) {
692 vt->signal = t->has_signal(client);
694 if (t->is_stereo(client))
696 VIDEO_TUNER_STEREO_ON;
699 ~VIDEO_TUNER_STEREO_ON;
701 vt->flags |= VIDEO_TUNER_LOW; /* Allow freqs at 62.5 Hz */
703 vt->rangelow = radio_range[0] * 16000;
704 vt->rangehigh = radio_range[1] * 16000;
707 vt->rangelow = tv_range[0] * 16;
708 vt->rangehigh = tv_range[1] * 16;
715 struct video_audio *va = arg;
717 if (check_mode(t, "VIDIOCGAUDIO") == EINVAL)
719 if (check_v4l2(t) == EINVAL)
722 if (V4L2_TUNER_RADIO == t->mode && t->is_stereo)
723 va->mode = t->is_stereo(client)
724 ? VIDEO_SOUND_STEREO : VIDEO_SOUND_MONO;
728 case TDA9887_SET_CONFIG:
729 if (t->type == TUNER_TDA9887) {
732 t->tda9887_config = *i;
733 set_freq(client, t->tv_freq);
736 /* --- v4l ioctls --- */
737 /* take care: bttv does userspace copying, we'll get a
738 kernel pointer here... */
741 v4l2_std_id *id = arg;
743 if (set_mode (client, t, V4L2_TUNER_ANALOG_TV, "VIDIOC_S_STD")
752 set_freq(client, t->tv_freq);
755 case VIDIOC_S_FREQUENCY:
757 struct v4l2_frequency *f = arg;
759 if (set_mode (client, t, f->type, "VIDIOC_S_FREQUENCY")
763 set_freq(client,f->frequency);
767 case VIDIOC_G_FREQUENCY:
769 struct v4l2_frequency *f = arg;
771 if (check_mode(t, "VIDIOC_G_FREQUENCY") == EINVAL)
775 f->frequency = (V4L2_TUNER_RADIO == t->mode) ?
776 t->radio_freq : t->tv_freq;
781 struct v4l2_tuner *tuner = arg;
783 if (check_mode(t, "VIDIOC_G_TUNER") == EINVAL)
787 tuner->type = t->mode;
789 tuner->afc=t->get_afc(client);
790 if (t->mode == V4L2_TUNER_ANALOG_TV)
791 tuner->capability |= V4L2_TUNER_CAP_NORM;
792 if (t->mode != V4L2_TUNER_RADIO) {
793 tuner->rangelow = tv_range[0] * 16;
794 tuner->rangehigh = tv_range[1] * 16;
800 tuner->signal = t->has_signal(client);
803 V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
805 tuner->rxsubchans = t->is_stereo(client) ?
806 V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
810 V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
811 tuner->audmode = t->audmode;
812 tuner->rangelow = radio_range[0] * 16000;
813 tuner->rangehigh = radio_range[1] * 16000;
818 struct v4l2_tuner *tuner = arg;
820 if (check_mode(t, "VIDIOC_S_TUNER") == EINVAL)
825 /* do nothing unless we're a radio tuner */
826 if (t->mode != V4L2_TUNER_RADIO)
828 t->audmode = tuner->audmode;
829 set_radio_freq(client, t->radio_freq);
832 case VIDIOC_LOG_STATUS:
834 t->tuner_status(client);
841 static int tuner_suspend(struct i2c_client *c, pm_message_t state)
843 struct tuner *t = i2c_get_clientdata (c);
845 tuner_dbg ("suspend\n");
846 /* FIXME: power down ??? */
850 static int tuner_resume(struct i2c_client *c)
852 struct tuner *t = i2c_get_clientdata (c);
854 tuner_dbg ("resume\n");
855 if (V4L2_TUNER_RADIO == t->mode) {
857 set_freq(c, t->radio_freq);
860 set_freq(c, t->tv_freq);
865 /* ----------------------------------------------------------------------- */
867 static struct i2c_driver driver = {
868 .id = I2C_DRIVERID_TUNER,
869 .attach_adapter = tuner_probe,
870 .detach_client = tuner_detach,
871 .command = tuner_command,
872 .suspend = tuner_suspend,
873 .resume = tuner_resume,
878 static struct i2c_client client_template = {
879 .name = "(tuner unset)",
883 static int __init tuner_init_module(void)
885 return i2c_add_driver(&driver);
888 static void __exit tuner_cleanup_module(void)
890 i2c_del_driver(&driver);
893 module_init(tuner_init_module);
894 module_exit(tuner_cleanup_module);
897 * Overrides for Emacs so that we follow Linus's tabbing style.
898 * ---------------------------------------------------------------------------