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 0x42, 0x43, 0x4a, 0x4b, /* tda8290 */
29 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
30 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
36 /* insmod options used at init time => read/only */
37 static unsigned int addr = 0;
38 static unsigned int no_autodetect = 0;
39 static unsigned int show_i2c = 0;
41 /* insmod options used at runtime => read/write */
44 static unsigned int tv_range[2] = { 44, 958 };
45 static unsigned int radio_range[2] = { 65, 108 };
47 static char pal[] = "--";
48 static char secam[] = "--";
49 static char ntsc[] = "-";
52 module_param(addr, int, 0444);
53 module_param(no_autodetect, int, 0444);
54 module_param(show_i2c, int, 0444);
55 module_param_named(debug,tuner_debug, int, 0644);
56 module_param_string(pal, pal, sizeof(pal), 0644);
57 module_param_string(secam, secam, sizeof(secam), 0644);
58 module_param_string(ntsc, ntsc, sizeof(ntsc), 0644);
59 module_param_array(tv_range, int, NULL, 0644);
60 module_param_array(radio_range, int, NULL, 0644);
62 MODULE_DESCRIPTION("device driver for various TV and TV+FM radio tuners");
63 MODULE_AUTHOR("Ralph Metzler, Gerd Knorr, Gunther Mayer");
64 MODULE_LICENSE("GPL");
66 static struct i2c_driver driver;
67 static struct i2c_client client_template;
69 /* ---------------------------------------------------------------------- */
71 /* Set tuner frequency, freq in Units of 62.5kHz = 1/16MHz */
72 static void set_tv_freq(struct i2c_client *c, unsigned int freq)
74 struct tuner *t = i2c_get_clientdata(c);
76 if (t->type == UNSET) {
77 tuner_warn ("tuner type not set\n");
80 if (NULL == t->set_tv_freq) {
81 tuner_warn ("Tuner has no way to set tv freq\n");
84 if (freq < tv_range[0] * 16 || freq > tv_range[1] * 16) {
85 tuner_dbg ("TV freq (%d.%02d) out of range (%d-%d)\n",
86 freq / 16, freq % 16 * 100 / 16, tv_range[0],
88 /* V4L2 spec: if the freq is not possible then the closest
89 possible value should be selected */
90 if (freq < tv_range[0] * 16)
91 freq = tv_range[0] * 16;
93 freq = tv_range[1] * 16;
95 t->set_tv_freq(c, freq);
98 static void set_radio_freq(struct i2c_client *c, unsigned int freq)
100 struct tuner *t = i2c_get_clientdata(c);
102 if (t->type == UNSET) {
103 tuner_warn ("tuner type not set\n");
106 if (NULL == t->set_radio_freq) {
107 tuner_warn ("tuner has no way to set radio frequency\n");
110 if (freq < radio_range[0] * 16000 || freq > radio_range[1] * 16000) {
111 tuner_dbg ("radio freq (%d.%02d) out of range (%d-%d)\n",
112 freq / 16000, freq % 16000 * 100 / 16000,
113 radio_range[0], radio_range[1]);
114 /* V4L2 spec: if the freq is not possible then the closest
115 possible value should be selected */
116 if (freq < radio_range[0] * 16000)
117 freq = radio_range[0] * 16000;
119 freq = radio_range[1] * 16000;
122 t->set_radio_freq(c, freq);
125 static void set_freq(struct i2c_client *c, unsigned long freq)
127 struct tuner *t = i2c_get_clientdata(c);
130 case V4L2_TUNER_RADIO:
131 tuner_dbg("radio freq set to %lu.%02lu\n",
132 freq / 16000, freq % 16000 * 100 / 16000);
133 set_radio_freq(c, freq);
134 t->radio_freq = freq;
136 case V4L2_TUNER_ANALOG_TV:
137 case V4L2_TUNER_DIGITAL_TV:
138 tuner_dbg("tv freq set to %lu.%02lu\n",
139 freq / 16, freq % 16 * 100 / 16);
140 set_tv_freq(c, freq);
146 static void set_type(struct i2c_client *c, unsigned int type,
147 unsigned int new_mode_mask)
149 struct tuner *t = i2c_get_clientdata(c);
150 unsigned char buffer[4];
152 if (type == UNSET || type == TUNER_ABSENT) {
153 tuner_dbg ("tuner 0x%02x: Tuner type absent\n",c->addr);
157 if (type >= tuner_count) {
158 tuner_warn ("tuner 0x%02x: Tuner count greater than %d\n",c->addr,tuner_count);
162 /* This code detects calls by card attach_inform */
163 if (NULL == t->i2c.dev.driver) {
164 tuner_dbg ("tuner 0x%02x: called during i2c_client register by adapter's attach_inform\n", c->addr);
175 case TUNER_PHILIPS_TDA8290:
179 if (tea5767_tuner_init(c) == EINVAL) {
180 t->type = TUNER_ABSENT;
181 t->mode_mask = T_UNINITIALIZED;
184 t->mode_mask = T_RADIO;
186 case TUNER_PHILIPS_FMD1216ME_MK3:
191 i2c_master_send(c, buffer, 4);
195 i2c_master_send(c, buffer, 4);
196 default_tuner_init(c);
198 case TUNER_PHILIPS_TD1316:
203 i2c_master_send(c,buffer,4);
204 default_tuner_init(c);
207 tda9887_tuner_init(c);
210 default_tuner_init(c);
214 if (t->mode_mask == T_UNINITIALIZED)
215 t->mode_mask = new_mode_mask;
217 set_freq(c, (V4L2_TUNER_RADIO == t->mode) ? t->radio_freq : t->tv_freq);
218 tuner_dbg("%s %s I2C addr 0x%02x with type %d used for 0x%02x\n",
219 c->adapter->name, c->driver->driver.name, c->addr << 1, type,
224 * This function apply tuner config to tuner specified
225 * by tun_setup structure. I addr is unset, then admin status
226 * and tun addr status is more precise then current status,
227 * it's applied. Otherwise status and type are applied only to
228 * tuner with exactly the same addr.
231 static void set_addr(struct i2c_client *c, struct tuner_setup *tun_setup)
233 struct tuner *t = i2c_get_clientdata(c);
235 tuner_dbg("set addr for type %i\n", t->type);
237 if ( t->type == UNSET && ((tun_setup->addr == ADDR_UNSET &&
238 (t->mode_mask & tun_setup->mode_mask)) ||
239 tun_setup->addr == c->addr)) {
240 set_type(c, tun_setup->type, tun_setup->mode_mask);
244 static inline int check_mode(struct tuner *t, char *cmd)
246 if ((1 << t->mode & t->mode_mask) == 0) {
251 case V4L2_TUNER_RADIO:
252 tuner_dbg("Cmd %s accepted for radio\n", cmd);
254 case V4L2_TUNER_ANALOG_TV:
255 tuner_dbg("Cmd %s accepted for analog TV\n", cmd);
257 case V4L2_TUNER_DIGITAL_TV:
258 tuner_dbg("Cmd %s accepted for digital TV\n", cmd);
264 /* get more precise norm info from insmod option */
265 static int tuner_fixup_std(struct tuner *t)
267 if ((t->std & V4L2_STD_PAL) == V4L2_STD_PAL) {
270 tuner_dbg ("insmod fixup: PAL => PAL-60\n");
271 t->std = V4L2_STD_PAL_60;
277 tuner_dbg ("insmod fixup: PAL => PAL-BG\n");
278 t->std = V4L2_STD_PAL_BG;
282 tuner_dbg ("insmod fixup: PAL => PAL-I\n");
283 t->std = V4L2_STD_PAL_I;
289 tuner_dbg ("insmod fixup: PAL => PAL-DK\n");
290 t->std = V4L2_STD_PAL_DK;
294 tuner_dbg ("insmod fixup: PAL => PAL-M\n");
295 t->std = V4L2_STD_PAL_M;
299 if (pal[1] == 'c' || pal[1] == 'C') {
300 tuner_dbg("insmod fixup: PAL => PAL-Nc\n");
301 t->std = V4L2_STD_PAL_Nc;
303 tuner_dbg ("insmod fixup: PAL => PAL-N\n");
304 t->std = V4L2_STD_PAL_N;
308 /* default parameter, do nothing */
311 tuner_warn ("pal= argument not recognised\n");
315 if ((t->std & V4L2_STD_SECAM) == V4L2_STD_SECAM) {
323 tuner_dbg("insmod fixup: SECAM => SECAM-BGH\n");
324 t->std = V4L2_STD_SECAM_B | V4L2_STD_SECAM_G | V4L2_STD_SECAM_H;
330 tuner_dbg ("insmod fixup: SECAM => SECAM-DK\n");
331 t->std = V4L2_STD_SECAM_DK;
335 if ((secam[1]=='C')||(secam[1]=='c')) {
336 tuner_dbg ("insmod fixup: SECAM => SECAM-L'\n");
337 t->std = V4L2_STD_SECAM_LC;
339 tuner_dbg ("insmod fixup: SECAM => SECAM-L\n");
340 t->std = V4L2_STD_SECAM_L;
344 /* default parameter, do nothing */
347 tuner_warn ("secam= argument not recognised\n");
352 if ((t->std & V4L2_STD_NTSC) == V4L2_STD_NTSC) {
356 tuner_dbg("insmod fixup: NTSC => NTSC-M\n");
357 t->std = V4L2_STD_NTSC_M;
361 tuner_dbg("insmod fixup: NTSC => NTSC_M_JP\n");
362 t->std = V4L2_STD_NTSC_M_JP;
366 tuner_dbg("insmod fixup: NTSC => NTSC_M_KR\n");
367 t->std = V4L2_STD_NTSC_M_KR;
370 /* default parameter, do nothing */
373 tuner_info("ntsc= argument not recognised\n");
380 static void tuner_status(struct i2c_client *client)
382 struct tuner *t = i2c_get_clientdata(client);
383 unsigned long freq, freq_fraction;
387 case V4L2_TUNER_RADIO: p = "radio"; break;
388 case V4L2_TUNER_ANALOG_TV: p = "analog TV"; break;
389 case V4L2_TUNER_DIGITAL_TV: p = "digital TV"; break;
390 default: p = "undefined"; break;
392 if (t->mode == V4L2_TUNER_RADIO) {
393 freq = t->radio_freq / 16000;
394 freq_fraction = (t->radio_freq % 16000) * 100 / 16000;
396 freq = t->tv_freq / 16;
397 freq_fraction = (t->tv_freq % 16) * 100 / 16;
399 tuner_info("Tuner mode: %s\n", p);
400 tuner_info("Frequency: %lu.%02lu MHz\n", freq, freq_fraction);
401 tuner_info("Standard: 0x%08lx\n", (unsigned long)t->std);
402 if (t->mode != V4L2_TUNER_RADIO)
405 tuner_info("Signal strength: %d\n", t->has_signal(client));
408 tuner_info("Stereo: %s\n", t->is_stereo(client) ? "yes" : "no");
412 /* ---------------------------------------------------------------------- */
414 /* static vars: used only in tuner_attach and tuner_probe */
415 static unsigned default_mode_mask;
417 /* During client attach, set_type is called by adapter's attach_inform callback.
418 set_type must then be completed by tuner_attach.
420 static int tuner_attach(struct i2c_adapter *adap, int addr, int kind)
424 client_template.adapter = adap;
425 client_template.addr = addr;
427 t = kzalloc(sizeof(struct tuner), GFP_KERNEL);
430 memcpy(&t->i2c, &client_template, sizeof(struct i2c_client));
431 i2c_set_clientdata(&t->i2c, t);
433 t->radio_if2 = 10700 * 1000; /* 10.7MHz - FM radio */
434 t->audmode = V4L2_TUNER_MODE_STEREO;
435 t->mode_mask = T_UNINITIALIZED;
436 t->tuner_status = tuner_status;
439 unsigned char buffer[16];
442 memset(buffer, 0, sizeof(buffer));
443 rc = i2c_master_recv(&t->i2c, buffer, sizeof(buffer));
444 tuner_info("I2C RECV = ");
446 printk("%02x ",buffer[i]);
449 /* HACK: This test were added to avoid tuner to probe tda9840 and tea6415c on the MXB card */
450 if (adap->id == I2C_HW_SAA7146 && addr < 0x4a)
453 /* autodetection code based on the i2c addr */
454 if (!no_autodetect) {
460 /* If chip is not tda8290, don't register.
461 since it can be tda9887*/
462 if (tda8290_probe(&t->i2c) == 0) {
463 tuner_dbg("chip at addr %x is a tda8290\n", addr);
465 /* Default is being tda9887 */
466 t->type = TUNER_TDA9887;
467 t->mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
469 goto register_client;
473 if (tea5767_autodetection(&t->i2c) != EINVAL) {
474 t->type = TUNER_TEA5767;
475 t->mode_mask = T_RADIO;
477 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
478 default_mode_mask &= ~T_RADIO;
480 goto register_client;
486 /* Initializes only the first adapter found */
487 if (default_mode_mask != T_UNINITIALIZED) {
488 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask);
489 t->mode_mask = default_mode_mask;
490 t->tv_freq = 400 * 16; /* Sets freq to VHF High */
491 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
492 default_mode_mask = T_UNINITIALIZED;
495 /* Should be just before return */
497 tuner_info("chip found @ 0x%x (%s)\n", addr << 1, adap->name);
498 i2c_attach_client (&t->i2c);
499 set_type (&t->i2c,t->type, t->mode_mask);
503 static int tuner_probe(struct i2c_adapter *adap)
506 normal_i2c[0] = addr;
507 normal_i2c[1] = I2C_CLIENT_END;
510 default_mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
512 if (adap->class & I2C_CLASS_TV_ANALOG)
513 return i2c_probe(adap, &addr_data, tuner_attach);
517 static int tuner_detach(struct i2c_client *client)
519 struct tuner *t = i2c_get_clientdata(client);
522 err = i2c_detach_client(&t->i2c);
525 ("Client deregistration failed, client not detached.\n");
534 * Switch tuner to other mode. If tuner support both tv and radio,
535 * set another frequency to some value (This is needed for some pal
536 * tuners to avoid locking). Otherwise, just put second tuner in
540 static inline int set_mode(struct i2c_client *client, struct tuner *t, int mode, char *cmd)
547 if (check_mode(t, cmd) == EINVAL) {
556 #define switch_v4l2() if (!t->using_v4l2) \
557 tuner_dbg("switching to v4l2\n"); \
560 static inline int check_v4l2(struct tuner *t)
562 /* bttv still uses both v4l1 and v4l2 calls to the tuner (v4l2 for
563 TV, v4l1 for radio), until that is fixed this code is disabled.
564 Otherwise the radio (v4l1) wouldn't tune after using the TV (v4l2)
569 static int tuner_command(struct i2c_client *client, unsigned int cmd, void *arg)
571 struct tuner *t = i2c_get_clientdata(client);
574 v4l_i2c_print_ioctl(&(t->i2c),cmd);
577 /* --- configuration --- */
578 case TUNER_SET_TYPE_ADDR:
579 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x\n",
580 ((struct tuner_setup *)arg)->type,
581 ((struct tuner_setup *)arg)->addr,
582 ((struct tuner_setup *)arg)->mode_mask);
584 set_addr(client, (struct tuner_setup *)arg);
587 if (set_mode(client, t, V4L2_TUNER_RADIO, "AUDC_SET_RADIO")
591 set_freq(client, t->radio_freq);
593 case TUNER_SET_STANDBY:
594 if (check_mode(t, "TUNER_SET_STANDBY") == EINVAL)
600 #ifdef CONFIG_VIDEO_V4L1
602 if (check_mode(t, "VIDIOCSAUDIO") == EINVAL)
604 if (check_v4l2(t) == EINVAL)
607 /* Should be implemented, since bttv calls it */
608 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
612 static const v4l2_std_id map[] = {
613 [VIDEO_MODE_PAL] = V4L2_STD_PAL,
614 [VIDEO_MODE_NTSC] = V4L2_STD_NTSC_M,
615 [VIDEO_MODE_SECAM] = V4L2_STD_SECAM,
616 [4 /* bttv */ ] = V4L2_STD_PAL_M,
617 [5 /* bttv */ ] = V4L2_STD_PAL_N,
618 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP,
620 struct video_channel *vc = arg;
622 if (check_v4l2(t) == EINVAL)
625 if (set_mode(client,t,V4L2_TUNER_ANALOG_TV, "VIDIOCSCHAN")==EINVAL)
628 if (vc->norm < ARRAY_SIZE(map))
629 t->std = map[vc->norm];
632 set_tv_freq(client, t->tv_freq);
637 unsigned long *v = arg;
639 if (check_mode(t, "VIDIOCSFREQ") == EINVAL)
641 if (check_v4l2(t) == EINVAL)
644 set_freq(client, *v);
649 struct video_tuner *vt = arg;
651 if (check_mode(t, "VIDIOCGTUNER") == EINVAL)
653 if (check_v4l2(t) == EINVAL)
656 if (V4L2_TUNER_RADIO == t->mode) {
658 vt->signal = t->has_signal(client);
660 if (t->is_stereo(client))
662 VIDEO_TUNER_STEREO_ON;
665 ~VIDEO_TUNER_STEREO_ON;
667 vt->flags |= VIDEO_TUNER_LOW; /* Allow freqs at 62.5 Hz */
669 vt->rangelow = radio_range[0] * 16000;
670 vt->rangehigh = radio_range[1] * 16000;
673 vt->rangelow = tv_range[0] * 16;
674 vt->rangehigh = tv_range[1] * 16;
681 struct video_audio *va = arg;
683 if (check_mode(t, "VIDIOCGAUDIO") == EINVAL)
685 if (check_v4l2(t) == EINVAL)
688 if (V4L2_TUNER_RADIO == t->mode && t->is_stereo)
689 va->mode = t->is_stereo(client)
690 ? VIDEO_SOUND_STEREO : VIDEO_SOUND_MONO;
694 case TDA9887_SET_CONFIG:
695 if (t->type == TUNER_TDA9887) {
698 t->tda9887_config = *i;
699 set_freq(client, t->tv_freq);
702 /* --- v4l ioctls --- */
703 /* take care: bttv does userspace copying, we'll get a
704 kernel pointer here... */
707 v4l2_std_id *id = arg;
709 if (set_mode (client, t, V4L2_TUNER_ANALOG_TV, "VIDIOC_S_STD")
718 set_freq(client, t->tv_freq);
721 case VIDIOC_S_FREQUENCY:
723 struct v4l2_frequency *f = arg;
725 if (set_mode (client, t, f->type, "VIDIOC_S_FREQUENCY")
729 set_freq(client,f->frequency);
733 case VIDIOC_G_FREQUENCY:
735 struct v4l2_frequency *f = arg;
737 if (check_mode(t, "VIDIOC_G_FREQUENCY") == EINVAL)
741 f->frequency = (V4L2_TUNER_RADIO == t->mode) ?
742 t->radio_freq : t->tv_freq;
747 struct v4l2_tuner *tuner = arg;
749 if (check_mode(t, "VIDIOC_G_TUNER") == EINVAL)
753 tuner->type = t->mode;
755 tuner->afc=t->get_afc(client);
756 if (t->mode == V4L2_TUNER_ANALOG_TV)
757 tuner->capability |= V4L2_TUNER_CAP_NORM;
758 if (t->mode != V4L2_TUNER_RADIO) {
759 tuner->rangelow = tv_range[0] * 16;
760 tuner->rangehigh = tv_range[1] * 16;
766 tuner->signal = t->has_signal(client);
769 V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
771 tuner->rxsubchans = t->is_stereo(client) ?
772 V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
776 V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
777 tuner->audmode = t->audmode;
778 tuner->rangelow = radio_range[0] * 16000;
779 tuner->rangehigh = radio_range[1] * 16000;
784 struct v4l2_tuner *tuner = arg;
786 if (check_mode(t, "VIDIOC_S_TUNER") == EINVAL)
791 /* do nothing unless we're a radio tuner */
792 if (t->mode != V4L2_TUNER_RADIO)
794 t->audmode = tuner->audmode;
795 set_radio_freq(client, t->radio_freq);
798 case VIDIOC_LOG_STATUS:
800 t->tuner_status(client);
807 static int tuner_suspend(struct device *dev, pm_message_t state)
809 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
810 struct tuner *t = i2c_get_clientdata (c);
812 tuner_dbg ("suspend\n");
813 /* FIXME: power down ??? */
817 static int tuner_resume(struct device *dev)
819 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
820 struct tuner *t = i2c_get_clientdata (c);
822 tuner_dbg ("resume\n");
823 if (V4L2_TUNER_RADIO == t->mode) {
825 set_freq(c, t->radio_freq);
828 set_freq(c, t->tv_freq);
833 /* ----------------------------------------------------------------------- */
835 static struct i2c_driver driver = {
836 .id = I2C_DRIVERID_TUNER,
837 .attach_adapter = tuner_probe,
838 .detach_client = tuner_detach,
839 .command = tuner_command,
842 .suspend = tuner_suspend,
843 .resume = tuner_resume,
846 static struct i2c_client client_template = {
847 .name = "(tuner unset)",
851 static int __init tuner_init_module(void)
853 return i2c_add_driver(&driver);
856 static void __exit tuner_cleanup_module(void)
858 i2c_del_driver(&driver);
861 module_init(tuner_init_module);
862 module_exit(tuner_cleanup_module);
865 * Overrides for Emacs so that we follow Linus's tabbing style.
866 * ---------------------------------------------------------------------------