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/sched.h>
11 #include <linux/string.h>
12 #include <linux/timer.h>
13 #include <linux/delay.h>
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/poll.h>
17 #include <linux/i2c.h>
18 #include <linux/types.h>
19 #include <linux/videodev.h>
20 #include <linux/init.h>
22 #include <media/tuner.h>
23 #include <media/v4l2-common.h>
24 #include <media/audiochip.h>
28 /* standard i2c insmod options */
29 static unsigned short normal_i2c[] = {
30 0x42, 0x43, 0x4a, 0x4b, /* tda8290 */
31 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
32 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
38 /* insmod options used at init time => read/only */
39 static unsigned int addr = 0;
40 static unsigned int no_autodetect = 0;
41 static unsigned int show_i2c = 0;
43 /* insmod options used at runtime => read/write */
44 static unsigned int tuner_debug_old = 0;
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 /* Note: tuner_debug is deprecated and will be removed in 2.6.17 */
59 module_param_named(tuner_debug,tuner_debug_old, int, 0444);
60 module_param_named(debug,tuner_debug, int, 0644);
61 module_param_string(pal, pal, sizeof(pal), 0644);
62 module_param_string(secam, secam, sizeof(secam), 0644);
63 module_param_string(ntsc, ntsc, sizeof(ntsc), 0644);
64 module_param_array(tv_range, int, NULL, 0644);
65 module_param_array(radio_range, int, NULL, 0644);
67 MODULE_DESCRIPTION("device driver for various TV and TV+FM radio tuners");
68 MODULE_AUTHOR("Ralph Metzler, Gerd Knorr, Gunther Mayer");
69 MODULE_LICENSE("GPL");
71 static struct i2c_driver driver;
72 static struct i2c_client client_template;
74 /* ---------------------------------------------------------------------- */
76 /* Set tuner frequency, freq in Units of 62.5kHz = 1/16MHz */
77 static void set_tv_freq(struct i2c_client *c, unsigned int freq)
79 struct tuner *t = i2c_get_clientdata(c);
81 if (t->type == UNSET) {
82 tuner_warn ("tuner type not set\n");
85 if (NULL == t->tv_freq) {
86 tuner_warn ("Tuner has no way to set tv freq\n");
89 if (freq < tv_range[0] * 16 || freq > tv_range[1] * 16) {
90 tuner_dbg ("TV freq (%d.%02d) out of range (%d-%d)\n",
91 freq / 16, freq % 16 * 100 / 16, tv_range[0],
97 static void set_radio_freq(struct i2c_client *c, unsigned int freq)
99 struct tuner *t = i2c_get_clientdata(c);
101 if (t->type == UNSET) {
102 tuner_warn ("tuner type not set\n");
105 if (NULL == t->radio_freq) {
106 tuner_warn ("tuner has no way to set radio frequency\n");
109 if (freq <= radio_range[0] * 16000 || freq >= radio_range[1] * 16000) {
110 tuner_dbg ("radio freq (%d.%02d) out of range (%d-%d)\n",
111 freq / 16000, freq % 16000 * 100 / 16000,
112 radio_range[0], radio_range[1]);
115 t->radio_freq(c, freq);
119 static void set_freq(struct i2c_client *c, unsigned long freq)
121 struct tuner *t = i2c_get_clientdata(c);
124 case V4L2_TUNER_RADIO:
125 tuner_dbg("radio freq set to %lu.%02lu\n",
126 freq / 16000, freq % 16000 * 100 / 16000);
127 set_radio_freq(c, freq);
129 case V4L2_TUNER_ANALOG_TV:
130 case V4L2_TUNER_DIGITAL_TV:
131 tuner_dbg("tv freq set to %lu.%02lu\n",
132 freq / 16, freq % 16 * 100 / 16);
133 set_tv_freq(c, freq);
139 static void set_type(struct i2c_client *c, unsigned int type,
140 unsigned int new_mode_mask)
142 struct tuner *t = i2c_get_clientdata(c);
143 unsigned char buffer[4];
145 if (type == UNSET || type == TUNER_ABSENT) {
146 tuner_dbg ("tuner 0x%02x: Tuner type absent\n",c->addr);
150 if (type >= tuner_count) {
151 tuner_warn ("tuner 0x%02x: Tuner count greater than %d\n",c->addr,tuner_count);
155 /* This code detects calls by card attach_inform */
156 if (NULL == t->i2c.dev.driver) {
157 tuner_dbg ("tuner 0x%02x: called during i2c_client register by adapter's attach_inform\n", c->addr);
169 case TUNER_PHILIPS_TDA8290:
173 if (tea5767_tuner_init(c) == EINVAL) {
174 t->type = TUNER_ABSENT;
175 t->mode_mask = T_UNINITIALIZED;
178 t->mode_mask = T_RADIO;
180 case TUNER_PHILIPS_FMD1216ME_MK3:
185 i2c_master_send(c, buffer, 4);
189 i2c_master_send(c, buffer, 4);
190 default_tuner_init(c);
192 case TUNER_LG_TDVS_H062F:
193 /* Set the Auxiliary Byte. */
197 i2c_master_send(c, buffer, 4);
198 default_tuner_init(c);
200 case TUNER_PHILIPS_TD1316:
205 i2c_master_send(c,buffer,4);
206 default_tuner_init(c);
208 default_tuner_init(c);
212 if (t->mode_mask == T_UNINITIALIZED)
213 t->mode_mask = new_mode_mask;
215 set_freq(c, t->freq);
216 tuner_dbg("%s %s I2C addr 0x%02x with type %d used for 0x%02x\n",
217 c->adapter->name, c->driver->driver.name, c->addr << 1, type,
222 * This function apply tuner config to tuner specified
223 * by tun_setup structure. I addr is unset, then admin status
224 * and tun addr status is more precise then current status,
225 * it's applied. Otherwise status and type are applied only to
226 * tuner with exactly the same addr.
229 static void set_addr(struct i2c_client *c, struct tuner_setup *tun_setup)
231 struct tuner *t = i2c_get_clientdata(c);
233 if ( t->type == UNSET && ((tun_setup->addr == ADDR_UNSET &&
234 (t->mode_mask & tun_setup->mode_mask)) ||
235 tun_setup->addr == c->addr)) {
236 set_type(c, tun_setup->type, tun_setup->mode_mask);
240 static inline int check_mode(struct tuner *t, char *cmd)
242 if ((1 << t->mode & t->mode_mask) == 0) {
247 case V4L2_TUNER_RADIO:
248 tuner_dbg("Cmd %s accepted for radio\n", cmd);
250 case V4L2_TUNER_ANALOG_TV:
251 tuner_dbg("Cmd %s accepted for analog TV\n", cmd);
253 case V4L2_TUNER_DIGITAL_TV:
254 tuner_dbg("Cmd %s accepted for digital TV\n", cmd);
260 /* get more precise norm info from insmod option */
261 static int tuner_fixup_std(struct tuner *t)
263 if ((t->std & V4L2_STD_PAL) == V4L2_STD_PAL) {
269 tuner_dbg ("insmod fixup: PAL => PAL-BG\n");
270 t->std = V4L2_STD_PAL_BG;
274 tuner_dbg ("insmod fixup: PAL => PAL-I\n");
275 t->std = V4L2_STD_PAL_I;
281 tuner_dbg ("insmod fixup: PAL => PAL-DK\n");
282 t->std = V4L2_STD_PAL_DK;
286 tuner_dbg ("insmod fixup: PAL => PAL-M\n");
287 t->std = V4L2_STD_PAL_M;
291 if (pal[1] == 'c' || pal[1] == 'C') {
292 tuner_dbg("insmod fixup: PAL => PAL-Nc\n");
293 t->std = V4L2_STD_PAL_Nc;
295 tuner_dbg ("insmod fixup: PAL => PAL-N\n");
296 t->std = V4L2_STD_PAL_N;
300 /* default parameter, do nothing */
303 tuner_warn ("pal= argument not recognised\n");
307 if ((t->std & V4L2_STD_SECAM) == V4L2_STD_SECAM) {
315 tuner_dbg("insmod fixup: SECAM => SECAM-BGH\n");
316 t->std = V4L2_STD_SECAM_B | V4L2_STD_SECAM_G | V4L2_STD_SECAM_H;
322 tuner_dbg ("insmod fixup: SECAM => SECAM-DK\n");
323 t->std = V4L2_STD_SECAM_DK;
327 if ((secam[1]=='C')||(secam[1]=='c')) {
328 tuner_dbg ("insmod fixup: SECAM => SECAM-L'\n");
329 t->std = V4L2_STD_SECAM_LC;
331 tuner_dbg ("insmod fixup: SECAM => SECAM-L\n");
332 t->std = V4L2_STD_SECAM_L;
336 /* default parameter, do nothing */
339 tuner_warn ("secam= argument not recognised\n");
344 if ((t->std & V4L2_STD_NTSC) == V4L2_STD_NTSC) {
348 tuner_dbg("insmod fixup: NTSC => NTSC-M\n");
349 t->std = V4L2_STD_NTSC_M;
353 tuner_dbg("insmod fixup: NTSC => NTSC_M_JP\n");
354 t->std = V4L2_STD_NTSC_M_JP;
357 /* default parameter, do nothing */
360 tuner_info("ntsc= argument not recognised\n");
367 static void tuner_status(struct i2c_client *client)
369 struct tuner *t = i2c_get_clientdata(client);
370 unsigned long freq, freq_fraction;
374 case V4L2_TUNER_RADIO: p = "radio"; break;
375 case V4L2_TUNER_ANALOG_TV: p = "analog TV"; break;
376 case V4L2_TUNER_DIGITAL_TV: p = "digital TV"; break;
377 default: p = "undefined"; break;
379 if (t->mode == V4L2_TUNER_RADIO) {
380 freq = t->freq / 16000;
381 freq_fraction = (t->freq % 16000) * 100 / 16000;
384 freq_fraction = (t->freq % 16) * 100 / 16;
386 tuner_info("Tuner mode: %s\n", p);
387 tuner_info("Frequency: %lu.%02lu MHz\n", freq, freq_fraction);
388 tuner_info("Standard: 0x%08llx\n", t->std);
389 if (t->mode == V4L2_TUNER_RADIO) {
391 tuner_info("Signal strength: %d\n", t->has_signal(client));
394 tuner_info("Stereo: %s\n", t->is_stereo(client) ? "yes" : "no");
398 /* ---------------------------------------------------------------------- */
400 /* static var Used only in tuner_attach and tuner_probe */
401 static unsigned default_mode_mask;
403 /* During client attach, set_type is called by adapter's attach_inform callback.
404 set_type must then be completed by tuner_attach.
406 static int tuner_attach(struct i2c_adapter *adap, int addr, int kind)
410 client_template.adapter = adap;
411 client_template.addr = addr;
413 t = kzalloc(sizeof(struct tuner), GFP_KERNEL);
416 memcpy(&t->i2c, &client_template, sizeof(struct i2c_client));
417 i2c_set_clientdata(&t->i2c, t);
419 t->radio_if2 = 10700 * 1000; /* 10.7MHz - FM radio */
420 t->audmode = V4L2_TUNER_MODE_STEREO;
421 t->mode_mask = T_UNINITIALIZED;
422 if (tuner_debug_old) {
423 tuner_debug = tuner_debug_old;
424 printk(KERN_ERR "tuner: tuner_debug is deprecated and will be removed in 2.6.17.\n");
425 printk(KERN_ERR "tuner: use the debug option instead.\n");
429 unsigned char buffer[16];
432 memset(buffer, 0, sizeof(buffer));
433 rc = i2c_master_recv(&t->i2c, buffer, sizeof(buffer));
434 tuner_info("I2C RECV = ");
436 printk("%02x ",buffer[i]);
439 /* TEA5767 autodetection code - only for addr = 0xc0 */
440 if (!no_autodetect) {
446 /* If chip is not tda8290, don't register.
447 since it can be tda9887*/
448 if (tda8290_probe(&t->i2c) != 0) {
449 tuner_dbg("chip at addr %x is not a tda8290\n", addr);
455 if (tea5767_autodetection(&t->i2c) != EINVAL) {
456 t->type = TUNER_TEA5767;
457 t->mode_mask = T_RADIO;
459 t->freq = 87.5 * 16; /* Sets freq to FM range */
460 default_mode_mask &= ~T_RADIO;
462 goto register_client;
468 /* Initializes only the first adapter found */
469 if (default_mode_mask != T_UNINITIALIZED) {
470 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask);
471 t->mode_mask = default_mode_mask;
472 t->freq = 400 * 16; /* Sets freq to VHF High */
473 default_mode_mask = T_UNINITIALIZED;
476 /* Should be just before return */
478 tuner_info("chip found @ 0x%x (%s)\n", addr << 1, adap->name);
479 i2c_attach_client (&t->i2c);
480 set_type (&t->i2c,t->type, t->mode_mask);
484 static int tuner_probe(struct i2c_adapter *adap)
487 normal_i2c[0] = addr;
488 normal_i2c[1] = I2C_CLIENT_END;
491 default_mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
493 if (adap->class & I2C_CLASS_TV_ANALOG)
494 return i2c_probe(adap, &addr_data, tuner_attach);
498 static int tuner_detach(struct i2c_client *client)
500 struct tuner *t = i2c_get_clientdata(client);
503 err = i2c_detach_client(&t->i2c);
506 ("Client deregistration failed, client not detached.\n");
515 * Switch tuner to other mode. If tuner support both tv and radio,
516 * set another frequency to some value (This is needed for some pal
517 * tuners to avoid locking). Otherwise, just put second tuner in
521 static inline int set_mode(struct i2c_client *client, struct tuner *t, int mode, char *cmd)
528 if (check_mode(t, cmd) == EINVAL) {
537 #define switch_v4l2() if (!t->using_v4l2) \
538 tuner_dbg("switching to v4l2\n"); \
541 static inline int check_v4l2(struct tuner *t)
544 tuner_dbg ("ignore v4l1 call\n");
550 static int tuner_command(struct i2c_client *client, unsigned int cmd, void *arg)
552 struct tuner *t = i2c_get_clientdata(client);
555 v4l_i2c_print_ioctl(&(t->i2c),cmd);
558 /* --- configuration --- */
559 case TUNER_SET_TYPE_ADDR:
560 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x\n",
561 ((struct tuner_setup *)arg)->type,
562 ((struct tuner_setup *)arg)->addr,
563 ((struct tuner_setup *)arg)->mode_mask);
565 set_addr(client, (struct tuner_setup *)arg);
568 set_mode(client,t,V4L2_TUNER_RADIO, "AUDC_SET_RADIO");
570 case TUNER_SET_STANDBY:
572 if (check_mode(t, "TUNER_SET_STANDBY") == EINVAL)
579 if (check_mode(t, "VIDIOCSAUDIO") == EINVAL)
581 if (check_v4l2(t) == EINVAL)
584 /* Should be implemented, since bttv calls it */
585 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
588 /* --- v4l ioctls --- */
589 /* take care: bttv does userspace copying, we'll get a
590 kernel pointer here... */
593 static const v4l2_std_id map[] = {
594 [VIDEO_MODE_PAL] = V4L2_STD_PAL,
595 [VIDEO_MODE_NTSC] = V4L2_STD_NTSC_M,
596 [VIDEO_MODE_SECAM] = V4L2_STD_SECAM,
597 [4 /* bttv */ ] = V4L2_STD_PAL_M,
598 [5 /* bttv */ ] = V4L2_STD_PAL_N,
599 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP,
601 struct video_channel *vc = arg;
603 if (check_v4l2(t) == EINVAL)
606 if (set_mode(client,t,V4L2_TUNER_ANALOG_TV, "VIDIOCSCHAN")==EINVAL)
609 if (vc->norm < ARRAY_SIZE(map))
610 t->std = map[vc->norm];
613 set_tv_freq(client, t->freq);
618 unsigned long *v = arg;
620 if (check_mode(t, "VIDIOCSFREQ") == EINVAL)
622 if (check_v4l2(t) == EINVAL)
625 set_freq(client, *v);
630 struct video_tuner *vt = arg;
632 if (check_mode(t, "VIDIOCGTUNER") == EINVAL)
634 if (check_v4l2(t) == EINVAL)
637 if (V4L2_TUNER_RADIO == t->mode) {
639 vt->signal = t->has_signal(client);
641 if (t->is_stereo(client))
643 VIDEO_TUNER_STEREO_ON;
646 ~VIDEO_TUNER_STEREO_ON;
648 vt->flags |= VIDEO_TUNER_LOW; /* Allow freqs at 62.5 Hz */
650 vt->rangelow = radio_range[0] * 16000;
651 vt->rangehigh = radio_range[1] * 16000;
654 vt->rangelow = tv_range[0] * 16;
655 vt->rangehigh = tv_range[1] * 16;
662 struct video_audio *va = arg;
664 if (check_mode(t, "VIDIOCGAUDIO") == EINVAL)
666 if (check_v4l2(t) == EINVAL)
669 if (V4L2_TUNER_RADIO == t->mode && t->is_stereo)
670 va->mode = t->is_stereo(client)
671 ? VIDEO_SOUND_STEREO : VIDEO_SOUND_MONO;
677 v4l2_std_id *id = arg;
679 if (set_mode (client, t, V4L2_TUNER_ANALOG_TV, "VIDIOC_S_STD")
688 set_freq(client, t->freq);
691 case VIDIOC_S_FREQUENCY:
693 struct v4l2_frequency *f = arg;
695 t->freq = f->frequency;
697 if (V4L2_TUNER_RADIO == f->type &&
698 V4L2_TUNER_RADIO != t->mode) {
699 if (set_mode (client, t, f->type, "VIDIOC_S_FREQUENCY")
703 set_freq(client,t->freq);
707 case VIDIOC_G_FREQUENCY:
709 struct v4l2_frequency *f = arg;
711 if (check_mode(t, "VIDIOC_G_FREQUENCY") == EINVAL)
715 f->frequency = t->freq;
720 struct v4l2_tuner *tuner = arg;
722 if (check_mode(t, "VIDIOC_G_TUNER") == EINVAL)
726 if (V4L2_TUNER_RADIO == t->mode) {
729 tuner->signal = t->has_signal(client);
732 if (t->is_stereo(client)) {
734 V4L2_TUNER_SUB_STEREO |
743 V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
745 tuner->audmode = t->audmode;
747 tuner->rangelow = radio_range[0] * 16000;
748 tuner->rangehigh = radio_range[1] * 16000;
750 tuner->rangelow = tv_range[0] * 16;
751 tuner->rangehigh = tv_range[1] * 16;
757 struct v4l2_tuner *tuner = arg;
759 if (check_mode(t, "VIDIOC_S_TUNER") == EINVAL)
764 if (V4L2_TUNER_RADIO == t->mode) {
765 t->audmode = tuner->audmode;
766 set_radio_freq(client, t->freq);
770 case VIDIOC_LOG_STATUS:
771 tuner_status(client);
778 static int tuner_suspend(struct device *dev, pm_message_t state)
780 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
781 struct tuner *t = i2c_get_clientdata (c);
783 tuner_dbg ("suspend\n");
784 /* FIXME: power down ??? */
788 static int tuner_resume(struct device *dev)
790 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
791 struct tuner *t = i2c_get_clientdata (c);
793 tuner_dbg ("resume\n");
795 set_freq(c, t->freq);
799 /* ----------------------------------------------------------------------- */
801 static struct i2c_driver driver = {
802 .id = I2C_DRIVERID_TUNER,
803 .attach_adapter = tuner_probe,
804 .detach_client = tuner_detach,
805 .command = tuner_command,
808 .suspend = tuner_suspend,
809 .resume = tuner_resume,
812 static struct i2c_client client_template = {
813 .name = "(tuner unset)",
817 static int __init tuner_init_module(void)
819 return i2c_add_driver(&driver);
822 static void __exit tuner_cleanup_module(void)
824 i2c_del_driver(&driver);
827 module_init(tuner_init_module);
828 module_exit(tuner_cleanup_module);
831 * Overrides for Emacs so that we follow Linus's tabbing style.
832 * ---------------------------------------------------------------------------