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
= 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
[] = "-";
54 module_param(addr
, int, 0444);
55 module_param(no_autodetect
, int, 0444);
56 module_param(show_i2c
, int, 0444);
57 /* Note: tuner_debug is deprecated and will be removed in 2.6.17 */
58 module_param(tuner_debug
, int, 0444);
59 module_param(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
= kmalloc(sizeof(struct tuner
), GFP_KERNEL
);
416 memset(t
, 0, sizeof(struct tuner
));
417 memcpy(&t
->i2c
, &client_template
, sizeof(struct i2c_client
));
418 i2c_set_clientdata(&t
->i2c
, t
);
420 t
->radio_if2
= 10700 * 1000; /* 10.7MHz - FM radio */
421 t
->audmode
= V4L2_TUNER_MODE_STEREO
;
422 t
->mode_mask
= T_UNINITIALIZED
;
425 printk(KERN_ERR
"tuner: tuner_debug is deprecated and will be removed in 2.6.17.\n");
426 printk(KERN_ERR
"tuner: use the debug option instead.\n");
430 unsigned char buffer
[16];
433 memset(buffer
, 0, sizeof(buffer
));
434 rc
= i2c_master_recv(&t
->i2c
, buffer
, sizeof(buffer
));
435 tuner_info("I2C RECV = ");
437 printk("%02x ",buffer
[i
]);
440 /* TEA5767 autodetection code - only for addr = 0xc0 */
441 if (!no_autodetect
) {
447 /* If chip is not tda8290, don't register.
448 since it can be tda9887*/
449 if (tda8290_probe(&t
->i2c
) != 0) {
450 tuner_dbg("chip at addr %x is not a tda8290\n", addr
);
456 if (tea5767_autodetection(&t
->i2c
) != EINVAL
) {
457 t
->type
= TUNER_TEA5767
;
458 t
->mode_mask
= T_RADIO
;
460 t
->freq
= 87.5 * 16; /* Sets freq to FM range */
461 default_mode_mask
&= ~T_RADIO
;
463 goto register_client
;
469 /* Initializes only the first adapter found */
470 if (default_mode_mask
!= T_UNINITIALIZED
) {
471 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask
);
472 t
->mode_mask
= default_mode_mask
;
473 t
->freq
= 400 * 16; /* Sets freq to VHF High */
474 default_mode_mask
= T_UNINITIALIZED
;
477 /* Should be just before return */
479 tuner_info("chip found @ 0x%x (%s)\n", addr
<< 1, adap
->name
);
480 i2c_attach_client (&t
->i2c
);
481 set_type (&t
->i2c
,t
->type
, t
->mode_mask
);
485 static int tuner_probe(struct i2c_adapter
*adap
)
488 normal_i2c
[0] = addr
;
489 normal_i2c
[1] = I2C_CLIENT_END
;
492 default_mode_mask
= T_RADIO
| T_ANALOG_TV
| T_DIGITAL_TV
;
494 if (adap
->class & I2C_CLASS_TV_ANALOG
)
495 return i2c_probe(adap
, &addr_data
, tuner_attach
);
499 static int tuner_detach(struct i2c_client
*client
)
501 struct tuner
*t
= i2c_get_clientdata(client
);
504 err
= i2c_detach_client(&t
->i2c
);
507 ("Client deregistration failed, client not detached.\n");
516 * Switch tuner to other mode. If tuner support both tv and radio,
517 * set another frequency to some value (This is needed for some pal
518 * tuners to avoid locking). Otherwise, just put second tuner in
522 static inline int set_mode(struct i2c_client
*client
, struct tuner
*t
, int mode
, char *cmd
)
529 if (check_mode(t
, cmd
) == EINVAL
) {
538 #define switch_v4l2() if (!t->using_v4l2) \
539 tuner_dbg("switching to v4l2\n"); \
542 static inline int check_v4l2(struct tuner
*t
)
545 tuner_dbg ("ignore v4l1 call\n");
551 static int tuner_command(struct i2c_client
*client
, unsigned int cmd
, void *arg
)
553 struct tuner
*t
= i2c_get_clientdata(client
);
556 v4l_i2c_print_ioctl(&(t
->i2c
),cmd
);
559 /* --- configuration --- */
560 case TUNER_SET_TYPE_ADDR
:
561 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x\n",
562 ((struct tuner_setup
*)arg
)->type
,
563 ((struct tuner_setup
*)arg
)->addr
,
564 ((struct tuner_setup
*)arg
)->mode_mask
);
566 set_addr(client
, (struct tuner_setup
*)arg
);
569 set_mode(client
,t
,V4L2_TUNER_RADIO
, "AUDC_SET_RADIO");
571 case TUNER_SET_STANDBY
:
573 if (check_mode(t
, "TUNER_SET_STANDBY") == EINVAL
)
580 if (check_mode(t
, "VIDIOCSAUDIO") == EINVAL
)
582 if (check_v4l2(t
) == EINVAL
)
585 /* Should be implemented, since bttv calls it */
586 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
589 /* --- v4l ioctls --- */
590 /* take care: bttv does userspace copying, we'll get a
591 kernel pointer here... */
594 static const v4l2_std_id map
[] = {
595 [VIDEO_MODE_PAL
] = V4L2_STD_PAL
,
596 [VIDEO_MODE_NTSC
] = V4L2_STD_NTSC_M
,
597 [VIDEO_MODE_SECAM
] = V4L2_STD_SECAM
,
598 [4 /* bttv */ ] = V4L2_STD_PAL_M
,
599 [5 /* bttv */ ] = V4L2_STD_PAL_N
,
600 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP
,
602 struct video_channel
*vc
= arg
;
604 if (check_v4l2(t
) == EINVAL
)
607 if (set_mode(client
,t
,V4L2_TUNER_ANALOG_TV
, "VIDIOCSCHAN")==EINVAL
)
610 if (vc
->norm
< ARRAY_SIZE(map
))
611 t
->std
= map
[vc
->norm
];
614 set_tv_freq(client
, t
->freq
);
619 unsigned long *v
= arg
;
621 if (check_mode(t
, "VIDIOCSFREQ") == EINVAL
)
623 if (check_v4l2(t
) == EINVAL
)
626 set_freq(client
, *v
);
631 struct video_tuner
*vt
= arg
;
633 if (check_mode(t
, "VIDIOCGTUNER") == EINVAL
)
635 if (check_v4l2(t
) == EINVAL
)
638 if (V4L2_TUNER_RADIO
== t
->mode
) {
640 vt
->signal
= t
->has_signal(client
);
642 if (t
->is_stereo(client
))
644 VIDEO_TUNER_STEREO_ON
;
647 ~VIDEO_TUNER_STEREO_ON
;
649 vt
->flags
|= VIDEO_TUNER_LOW
; /* Allow freqs at 62.5 Hz */
651 vt
->rangelow
= radio_range
[0] * 16000;
652 vt
->rangehigh
= radio_range
[1] * 16000;
655 vt
->rangelow
= tv_range
[0] * 16;
656 vt
->rangehigh
= tv_range
[1] * 16;
663 struct video_audio
*va
= arg
;
665 if (check_mode(t
, "VIDIOCGAUDIO") == EINVAL
)
667 if (check_v4l2(t
) == EINVAL
)
670 if (V4L2_TUNER_RADIO
== t
->mode
&& t
->is_stereo
)
671 va
->mode
= t
->is_stereo(client
)
672 ? VIDEO_SOUND_STEREO
: VIDEO_SOUND_MONO
;
678 v4l2_std_id
*id
= arg
;
680 if (set_mode (client
, t
, V4L2_TUNER_ANALOG_TV
, "VIDIOC_S_STD")
689 set_freq(client
, t
->freq
);
692 case VIDIOC_S_FREQUENCY
:
694 struct v4l2_frequency
*f
= arg
;
696 t
->freq
= f
->frequency
;
698 if (V4L2_TUNER_RADIO
== f
->type
&&
699 V4L2_TUNER_RADIO
!= t
->mode
) {
700 if (set_mode (client
, t
, f
->type
, "VIDIOC_S_FREQUENCY")
704 set_freq(client
,t
->freq
);
708 case VIDIOC_G_FREQUENCY
:
710 struct v4l2_frequency
*f
= arg
;
712 if (check_mode(t
, "VIDIOC_G_FREQUENCY") == EINVAL
)
716 f
->frequency
= t
->freq
;
721 struct v4l2_tuner
*tuner
= arg
;
723 if (check_mode(t
, "VIDIOC_G_TUNER") == EINVAL
)
727 if (V4L2_TUNER_RADIO
== t
->mode
) {
730 tuner
->signal
= t
->has_signal(client
);
733 if (t
->is_stereo(client
)) {
735 V4L2_TUNER_SUB_STEREO
|
744 V4L2_TUNER_CAP_LOW
| V4L2_TUNER_CAP_STEREO
;
746 tuner
->audmode
= t
->audmode
;
748 tuner
->rangelow
= radio_range
[0] * 16000;
749 tuner
->rangehigh
= radio_range
[1] * 16000;
751 tuner
->rangelow
= tv_range
[0] * 16;
752 tuner
->rangehigh
= tv_range
[1] * 16;
758 struct v4l2_tuner
*tuner
= arg
;
760 if (check_mode(t
, "VIDIOC_S_TUNER") == EINVAL
)
765 if (V4L2_TUNER_RADIO
== t
->mode
) {
766 t
->audmode
= tuner
->audmode
;
767 set_radio_freq(client
, t
->freq
);
771 case VIDIOC_LOG_STATUS
:
772 tuner_status(client
);
779 static int tuner_suspend(struct device
*dev
, pm_message_t state
)
781 struct i2c_client
*c
= container_of (dev
, struct i2c_client
, dev
);
782 struct tuner
*t
= i2c_get_clientdata (c
);
784 tuner_dbg ("suspend\n");
785 /* FIXME: power down ??? */
789 static int tuner_resume(struct device
*dev
)
791 struct i2c_client
*c
= container_of (dev
, struct i2c_client
, dev
);
792 struct tuner
*t
= i2c_get_clientdata (c
);
794 tuner_dbg ("resume\n");
796 set_freq(c
, t
->freq
);
800 /* ----------------------------------------------------------------------- */
802 static struct i2c_driver driver
= {
803 .id
= I2C_DRIVERID_TUNER
,
804 .attach_adapter
= tuner_probe
,
805 .detach_client
= tuner_detach
,
806 .command
= tuner_command
,
809 .suspend
= tuner_suspend
,
810 .resume
= tuner_resume
,
813 static struct i2c_client client_template
= {
814 .name
= "(tuner unset)",
818 static int __init
tuner_init_module(void)
820 return i2c_add_driver(&driver
);
823 static void __exit
tuner_cleanup_module(void)
825 i2c_del_driver(&driver
);
828 module_init(tuner_init_module
);
829 module_exit(tuner_cleanup_module
);
832 * Overrides for Emacs so that we follow Linus's tabbing style.
833 * ---------------------------------------------------------------------------