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->set_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],
93 /* V4L2 spec: if the freq is not possible then the closest
94 possible value should be selected */
95 if (freq < tv_range[0] * 16)
96 freq = tv_range[0] * 16;
98 freq = tv_range[1] * 16;
100 t->set_tv_freq(c, freq);
103 static void set_radio_freq(struct i2c_client *c, unsigned int freq)
105 struct tuner *t = i2c_get_clientdata(c);
107 if (t->type == UNSET) {
108 tuner_warn ("tuner type not set\n");
111 if (NULL == t->set_radio_freq) {
112 tuner_warn ("tuner has no way to set radio frequency\n");
115 if (freq < radio_range[0] * 16000 || freq > radio_range[1] * 16000) {
116 tuner_dbg ("radio freq (%d.%02d) out of range (%d-%d)\n",
117 freq / 16000, freq % 16000 * 100 / 16000,
118 radio_range[0], radio_range[1]);
119 /* V4L2 spec: if the freq is not possible then the closest
120 possible value should be selected */
121 if (freq < radio_range[0] * 16000)
122 freq = radio_range[0] * 16000;
124 freq = radio_range[1] * 16000;
127 t->set_radio_freq(c, freq);
130 static void set_freq(struct i2c_client *c, unsigned long freq)
132 struct tuner *t = i2c_get_clientdata(c);
135 case V4L2_TUNER_RADIO:
136 tuner_dbg("radio freq set to %lu.%02lu\n",
137 freq / 16000, freq % 16000 * 100 / 16000);
138 set_radio_freq(c, freq);
139 t->radio_freq = freq;
141 case V4L2_TUNER_ANALOG_TV:
142 case V4L2_TUNER_DIGITAL_TV:
143 tuner_dbg("tv freq set to %lu.%02lu\n",
144 freq / 16, freq % 16 * 100 / 16);
145 set_tv_freq(c, freq);
151 static void set_type(struct i2c_client *c, unsigned int type,
152 unsigned int new_mode_mask)
154 struct tuner *t = i2c_get_clientdata(c);
155 unsigned char buffer[4];
157 if (type == UNSET || type == TUNER_ABSENT) {
158 tuner_dbg ("tuner 0x%02x: Tuner type absent\n",c->addr);
162 if (type >= tuner_count) {
163 tuner_warn ("tuner 0x%02x: Tuner count greater than %d\n",c->addr,tuner_count);
167 /* This code detects calls by card attach_inform */
168 if (NULL == t->i2c.dev.driver) {
169 tuner_dbg ("tuner 0x%02x: called during i2c_client register by adapter's attach_inform\n", c->addr);
181 case TUNER_PHILIPS_TDA8290:
185 if (tea5767_tuner_init(c) == EINVAL) {
186 t->type = TUNER_ABSENT;
187 t->mode_mask = T_UNINITIALIZED;
190 t->mode_mask = T_RADIO;
192 case TUNER_PHILIPS_FMD1216ME_MK3:
197 i2c_master_send(c, buffer, 4);
201 i2c_master_send(c, buffer, 4);
202 default_tuner_init(c);
204 case TUNER_LG_TDVS_H062F:
205 /* Set the Auxiliary Byte. */
209 i2c_master_send(c, buffer, 4);
210 default_tuner_init(c);
212 case TUNER_PHILIPS_TD1316:
217 i2c_master_send(c,buffer,4);
218 default_tuner_init(c);
220 default_tuner_init(c);
224 if (t->mode_mask == T_UNINITIALIZED)
225 t->mode_mask = new_mode_mask;
227 set_freq(c, (V4L2_TUNER_RADIO == t->mode) ? t->radio_freq : t->tv_freq);
228 tuner_dbg("%s %s I2C addr 0x%02x with type %d used for 0x%02x\n",
229 c->adapter->name, c->driver->driver.name, c->addr << 1, type,
234 * This function apply tuner config to tuner specified
235 * by tun_setup structure. I addr is unset, then admin status
236 * and tun addr status is more precise then current status,
237 * it's applied. Otherwise status and type are applied only to
238 * tuner with exactly the same addr.
241 static void set_addr(struct i2c_client *c, struct tuner_setup *tun_setup)
243 struct tuner *t = i2c_get_clientdata(c);
245 if ( t->type == UNSET && ((tun_setup->addr == ADDR_UNSET &&
246 (t->mode_mask & tun_setup->mode_mask)) ||
247 tun_setup->addr == c->addr)) {
248 set_type(c, tun_setup->type, tun_setup->mode_mask);
252 static inline int check_mode(struct tuner *t, char *cmd)
254 if ((1 << t->mode & t->mode_mask) == 0) {
259 case V4L2_TUNER_RADIO:
260 tuner_dbg("Cmd %s accepted for radio\n", cmd);
262 case V4L2_TUNER_ANALOG_TV:
263 tuner_dbg("Cmd %s accepted for analog TV\n", cmd);
265 case V4L2_TUNER_DIGITAL_TV:
266 tuner_dbg("Cmd %s accepted for digital TV\n", cmd);
272 /* get more precise norm info from insmod option */
273 static int tuner_fixup_std(struct tuner *t)
275 if ((t->std & V4L2_STD_PAL) == V4L2_STD_PAL) {
281 tuner_dbg ("insmod fixup: PAL => PAL-BG\n");
282 t->std = V4L2_STD_PAL_BG;
286 tuner_dbg ("insmod fixup: PAL => PAL-I\n");
287 t->std = V4L2_STD_PAL_I;
293 tuner_dbg ("insmod fixup: PAL => PAL-DK\n");
294 t->std = V4L2_STD_PAL_DK;
298 tuner_dbg ("insmod fixup: PAL => PAL-M\n");
299 t->std = V4L2_STD_PAL_M;
303 if (pal[1] == 'c' || pal[1] == 'C') {
304 tuner_dbg("insmod fixup: PAL => PAL-Nc\n");
305 t->std = V4L2_STD_PAL_Nc;
307 tuner_dbg ("insmod fixup: PAL => PAL-N\n");
308 t->std = V4L2_STD_PAL_N;
312 /* default parameter, do nothing */
315 tuner_warn ("pal= argument not recognised\n");
319 if ((t->std & V4L2_STD_SECAM) == V4L2_STD_SECAM) {
327 tuner_dbg("insmod fixup: SECAM => SECAM-BGH\n");
328 t->std = V4L2_STD_SECAM_B | V4L2_STD_SECAM_G | V4L2_STD_SECAM_H;
334 tuner_dbg ("insmod fixup: SECAM => SECAM-DK\n");
335 t->std = V4L2_STD_SECAM_DK;
339 if ((secam[1]=='C')||(secam[1]=='c')) {
340 tuner_dbg ("insmod fixup: SECAM => SECAM-L'\n");
341 t->std = V4L2_STD_SECAM_LC;
343 tuner_dbg ("insmod fixup: SECAM => SECAM-L\n");
344 t->std = V4L2_STD_SECAM_L;
348 /* default parameter, do nothing */
351 tuner_warn ("secam= argument not recognised\n");
356 if ((t->std & V4L2_STD_NTSC) == V4L2_STD_NTSC) {
360 tuner_dbg("insmod fixup: NTSC => NTSC-M\n");
361 t->std = V4L2_STD_NTSC_M;
365 tuner_dbg("insmod fixup: NTSC => NTSC_M_JP\n");
366 t->std = V4L2_STD_NTSC_M_JP;
369 /* default parameter, do nothing */
372 tuner_info("ntsc= argument not recognised\n");
379 static void tuner_status(struct i2c_client *client)
381 struct tuner *t = i2c_get_clientdata(client);
382 unsigned long freq, freq_fraction;
386 case V4L2_TUNER_RADIO: p = "radio"; break;
387 case V4L2_TUNER_ANALOG_TV: p = "analog TV"; break;
388 case V4L2_TUNER_DIGITAL_TV: p = "digital TV"; break;
389 default: p = "undefined"; break;
391 if (t->mode == V4L2_TUNER_RADIO) {
392 freq = t->radio_freq / 16000;
393 freq_fraction = (t->radio_freq % 16000) * 100 / 16000;
395 freq = t->tv_freq / 16;
396 freq_fraction = (t->tv_freq % 16) * 100 / 16;
398 tuner_info("Tuner mode: %s\n", p);
399 tuner_info("Frequency: %lu.%02lu MHz\n", freq, freq_fraction);
400 tuner_info("Standard: 0x%08llx\n", t->std);
401 if (t->mode == V4L2_TUNER_RADIO) {
403 tuner_info("Signal strength: %d\n", t->has_signal(client));
406 tuner_info("Stereo: %s\n", t->is_stereo(client) ? "yes" : "no");
410 /* ---------------------------------------------------------------------- */
412 /* static var Used only in tuner_attach and tuner_probe */
413 static unsigned default_mode_mask;
415 /* During client attach, set_type is called by adapter's attach_inform callback.
416 set_type must then be completed by tuner_attach.
418 static int tuner_attach(struct i2c_adapter *adap, int addr, int kind)
422 client_template.adapter = adap;
423 client_template.addr = addr;
425 t = kzalloc(sizeof(struct tuner), GFP_KERNEL);
428 memcpy(&t->i2c, &client_template, sizeof(struct i2c_client));
429 i2c_set_clientdata(&t->i2c, t);
431 t->radio_if2 = 10700 * 1000; /* 10.7MHz - FM radio */
432 t->audmode = V4L2_TUNER_MODE_STEREO;
433 t->mode_mask = T_UNINITIALIZED;
434 if (tuner_debug_old) {
435 tuner_debug = tuner_debug_old;
436 printk(KERN_ERR "tuner: tuner_debug is deprecated and will be removed in 2.6.17.\n");
437 printk(KERN_ERR "tuner: use the debug option instead.\n");
441 unsigned char buffer[16];
444 memset(buffer, 0, sizeof(buffer));
445 rc = i2c_master_recv(&t->i2c, buffer, sizeof(buffer));
446 tuner_info("I2C RECV = ");
448 printk("%02x ",buffer[i]);
451 /* TEA5767 autodetection code - only for addr = 0xc0 */
452 if (!no_autodetect) {
458 /* If chip is not tda8290, don't register.
459 since it can be tda9887*/
460 if (tda8290_probe(&t->i2c) != 0) {
461 tuner_dbg("chip at addr %x is not a tda8290\n", addr);
467 if (tea5767_autodetection(&t->i2c) != EINVAL) {
468 t->type = TUNER_TEA5767;
469 t->mode_mask = T_RADIO;
471 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
472 default_mode_mask &= ~T_RADIO;
474 goto register_client;
480 /* Initializes only the first adapter found */
481 if (default_mode_mask != T_UNINITIALIZED) {
482 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask);
483 t->mode_mask = default_mode_mask;
484 t->tv_freq = 400 * 16; /* Sets freq to VHF High */
485 t->radio_freq = 87.5 * 16000; /* Sets freq to FM range */
486 default_mode_mask = T_UNINITIALIZED;
489 /* Should be just before return */
491 tuner_info("chip found @ 0x%x (%s)\n", addr << 1, adap->name);
492 i2c_attach_client (&t->i2c);
493 set_type (&t->i2c,t->type, t->mode_mask);
497 static int tuner_probe(struct i2c_adapter *adap)
500 normal_i2c[0] = addr;
501 normal_i2c[1] = I2C_CLIENT_END;
504 default_mode_mask = T_RADIO | T_ANALOG_TV | T_DIGITAL_TV;
506 if (adap->class & I2C_CLASS_TV_ANALOG)
507 return i2c_probe(adap, &addr_data, tuner_attach);
511 static int tuner_detach(struct i2c_client *client)
513 struct tuner *t = i2c_get_clientdata(client);
516 err = i2c_detach_client(&t->i2c);
519 ("Client deregistration failed, client not detached.\n");
528 * Switch tuner to other mode. If tuner support both tv and radio,
529 * set another frequency to some value (This is needed for some pal
530 * tuners to avoid locking). Otherwise, just put second tuner in
534 static inline int set_mode(struct i2c_client *client, struct tuner *t, int mode, char *cmd)
541 if (check_mode(t, cmd) == EINVAL) {
550 #define switch_v4l2() if (!t->using_v4l2) \
551 tuner_dbg("switching to v4l2\n"); \
554 static inline int check_v4l2(struct tuner *t)
557 tuner_dbg ("ignore v4l1 call\n");
563 static int tuner_command(struct i2c_client *client, unsigned int cmd, void *arg)
565 struct tuner *t = i2c_get_clientdata(client);
568 v4l_i2c_print_ioctl(&(t->i2c),cmd);
571 /* --- configuration --- */
572 case TUNER_SET_TYPE_ADDR:
573 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x\n",
574 ((struct tuner_setup *)arg)->type,
575 ((struct tuner_setup *)arg)->addr,
576 ((struct tuner_setup *)arg)->mode_mask);
578 set_addr(client, (struct tuner_setup *)arg);
581 if (set_mode(client, t, V4L2_TUNER_RADIO, "AUDC_SET_RADIO")
585 set_freq(client, t->radio_freq);
587 case TUNER_SET_STANDBY:
588 if (check_mode(t, "TUNER_SET_STANDBY") == EINVAL)
594 if (check_mode(t, "VIDIOCSAUDIO") == EINVAL)
596 if (check_v4l2(t) == EINVAL)
599 /* Should be implemented, since bttv calls it */
600 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
602 /* --- v4l ioctls --- */
603 /* take care: bttv does userspace copying, we'll get a
604 kernel pointer here... */
607 static const v4l2_std_id map[] = {
608 [VIDEO_MODE_PAL] = V4L2_STD_PAL,
609 [VIDEO_MODE_NTSC] = V4L2_STD_NTSC_M,
610 [VIDEO_MODE_SECAM] = V4L2_STD_SECAM,
611 [4 /* bttv */ ] = V4L2_STD_PAL_M,
612 [5 /* bttv */ ] = V4L2_STD_PAL_N,
613 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP,
615 struct video_channel *vc = arg;
617 if (check_v4l2(t) == EINVAL)
620 if (set_mode(client,t,V4L2_TUNER_ANALOG_TV, "VIDIOCSCHAN")==EINVAL)
623 if (vc->norm < ARRAY_SIZE(map))
624 t->std = map[vc->norm];
627 set_tv_freq(client, t->tv_freq);
632 unsigned long *v = arg;
634 if (check_mode(t, "VIDIOCSFREQ") == EINVAL)
636 if (check_v4l2(t) == EINVAL)
639 set_freq(client, *v);
644 struct video_tuner *vt = arg;
646 if (check_mode(t, "VIDIOCGTUNER") == EINVAL)
648 if (check_v4l2(t) == EINVAL)
651 if (V4L2_TUNER_RADIO == t->mode) {
653 vt->signal = t->has_signal(client);
655 if (t->is_stereo(client))
657 VIDEO_TUNER_STEREO_ON;
660 ~VIDEO_TUNER_STEREO_ON;
662 vt->flags |= VIDEO_TUNER_LOW; /* Allow freqs at 62.5 Hz */
664 vt->rangelow = radio_range[0] * 16000;
665 vt->rangehigh = radio_range[1] * 16000;
668 vt->rangelow = tv_range[0] * 16;
669 vt->rangehigh = tv_range[1] * 16;
676 struct video_audio *va = arg;
678 if (check_mode(t, "VIDIOCGAUDIO") == EINVAL)
680 if (check_v4l2(t) == EINVAL)
683 if (V4L2_TUNER_RADIO == t->mode && t->is_stereo)
684 va->mode = t->is_stereo(client)
685 ? VIDEO_SOUND_STEREO : VIDEO_SOUND_MONO;
691 v4l2_std_id *id = arg;
693 if (set_mode (client, t, V4L2_TUNER_ANALOG_TV, "VIDIOC_S_STD")
702 set_freq(client, t->tv_freq);
705 case VIDIOC_S_FREQUENCY:
707 struct v4l2_frequency *f = arg;
710 if (V4L2_TUNER_RADIO == f->type &&
711 V4L2_TUNER_RADIO != t->mode) {
712 if (set_mode (client, t, f->type, "VIDIOC_S_FREQUENCY")
716 set_freq(client,f->frequency);
720 case VIDIOC_G_FREQUENCY:
722 struct v4l2_frequency *f = arg;
724 if (check_mode(t, "VIDIOC_G_FREQUENCY") == EINVAL)
728 f->frequency = (V4L2_TUNER_RADIO == t->mode) ?
729 t->radio_freq : t->tv_freq;
734 struct v4l2_tuner *tuner = arg;
736 if (check_mode(t, "VIDIOC_G_TUNER") == EINVAL)
740 if (V4L2_TUNER_RADIO == t->mode) {
743 tuner->signal = t->has_signal(client);
746 if (t->is_stereo(client)) {
748 V4L2_TUNER_SUB_STEREO |
757 V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
759 tuner->audmode = t->audmode;
761 tuner->rangelow = radio_range[0] * 16000;
762 tuner->rangehigh = radio_range[1] * 16000;
764 tuner->rangelow = tv_range[0] * 16;
765 tuner->rangehigh = tv_range[1] * 16;
771 struct v4l2_tuner *tuner = arg;
773 if (check_mode(t, "VIDIOC_S_TUNER") == EINVAL)
778 if (V4L2_TUNER_RADIO == t->mode) {
779 t->audmode = tuner->audmode;
780 set_radio_freq(client, t->radio_freq);
784 case VIDIOC_LOG_STATUS:
785 tuner_status(client);
792 static int tuner_suspend(struct device *dev, pm_message_t state)
794 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
795 struct tuner *t = i2c_get_clientdata (c);
797 tuner_dbg ("suspend\n");
798 /* FIXME: power down ??? */
802 static int tuner_resume(struct device *dev)
804 struct i2c_client *c = container_of (dev, struct i2c_client, dev);
805 struct tuner *t = i2c_get_clientdata (c);
807 tuner_dbg ("resume\n");
808 if (V4L2_TUNER_RADIO == t->mode) {
810 set_freq(c, t->radio_freq);
813 set_freq(c, t->tv_freq);
818 /* ----------------------------------------------------------------------- */
820 static struct i2c_driver driver = {
821 .id = I2C_DRIVERID_TUNER,
822 .attach_adapter = tuner_probe,
823 .detach_client = tuner_detach,
824 .command = tuner_command,
827 .suspend = tuner_suspend,
828 .resume = tuner_resume,
831 static struct i2c_client client_template = {
832 .name = "(tuner unset)",
836 static int __init tuner_init_module(void)
838 return i2c_add_driver(&driver);
841 static void __exit tuner_cleanup_module(void)
843 i2c_del_driver(&driver);
846 module_init(tuner_init_module);
847 module_exit(tuner_cleanup_module);
850 * Overrides for Emacs so that we follow Linus's tabbing style.
851 * ---------------------------------------------------------------------------