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
);
180 case TUNER_PHILIPS_TDA8290
:
184 if (tea5767_tuner_init(c
) == EINVAL
) {
185 t
->type
= TUNER_ABSENT
;
186 t
->mode_mask
= T_UNINITIALIZED
;
189 t
->mode_mask
= T_RADIO
;
191 case TUNER_PHILIPS_FMD1216ME_MK3
:
196 i2c_master_send(c
, buffer
, 4);
200 i2c_master_send(c
, buffer
, 4);
201 default_tuner_init(c
);
203 case TUNER_LG_TDVS_H062F
:
204 /* Set the Auxiliary Byte. */
208 i2c_master_send(c
, buffer
, 4);
209 default_tuner_init(c
);
211 case TUNER_PHILIPS_TD1316
:
216 i2c_master_send(c
,buffer
,4);
217 default_tuner_init(c
);
220 case TUNER_XCEIVE_XC3028
:
225 default_tuner_init(c
);
229 if (t
->mode_mask
== T_UNINITIALIZED
)
230 t
->mode_mask
= new_mode_mask
;
232 set_freq(c
, (V4L2_TUNER_RADIO
== t
->mode
) ? t
->radio_freq
: t
->tv_freq
);
233 tuner_dbg("%s %s I2C addr 0x%02x with type %d used for 0x%02x\n",
234 c
->adapter
->name
, c
->driver
->driver
.name
, c
->addr
<< 1, type
,
239 * This function apply tuner config to tuner specified
240 * by tun_setup structure. I addr is unset, then admin status
241 * and tun addr status is more precise then current status,
242 * it's applied. Otherwise status and type are applied only to
243 * tuner with exactly the same addr.
246 static void set_addr(struct i2c_client
*c
, struct tuner_setup
*tun_setup
)
248 struct tuner
*t
= i2c_get_clientdata(c
);
250 if ( t
->type
== UNSET
&& ((tun_setup
->addr
== ADDR_UNSET
&&
251 (t
->mode_mask
& tun_setup
->mode_mask
)) ||
252 tun_setup
->addr
== c
->addr
)) {
253 set_type(c
, tun_setup
->type
, tun_setup
->mode_mask
);
257 static inline int check_mode(struct tuner
*t
, char *cmd
)
259 if ((1 << t
->mode
& t
->mode_mask
) == 0) {
264 case V4L2_TUNER_RADIO
:
265 tuner_dbg("Cmd %s accepted for radio\n", cmd
);
267 case V4L2_TUNER_ANALOG_TV
:
268 tuner_dbg("Cmd %s accepted for analog TV\n", cmd
);
270 case V4L2_TUNER_DIGITAL_TV
:
271 tuner_dbg("Cmd %s accepted for digital TV\n", cmd
);
277 /* get more precise norm info from insmod option */
278 static int tuner_fixup_std(struct tuner
*t
)
280 if ((t
->std
& V4L2_STD_PAL
) == V4L2_STD_PAL
) {
286 tuner_dbg ("insmod fixup: PAL => PAL-BG\n");
287 t
->std
= V4L2_STD_PAL_BG
;
291 tuner_dbg ("insmod fixup: PAL => PAL-I\n");
292 t
->std
= V4L2_STD_PAL_I
;
298 tuner_dbg ("insmod fixup: PAL => PAL-DK\n");
299 t
->std
= V4L2_STD_PAL_DK
;
303 tuner_dbg ("insmod fixup: PAL => PAL-M\n");
304 t
->std
= V4L2_STD_PAL_M
;
308 if (pal
[1] == 'c' || pal
[1] == 'C') {
309 tuner_dbg("insmod fixup: PAL => PAL-Nc\n");
310 t
->std
= V4L2_STD_PAL_Nc
;
312 tuner_dbg ("insmod fixup: PAL => PAL-N\n");
313 t
->std
= V4L2_STD_PAL_N
;
317 /* default parameter, do nothing */
320 tuner_warn ("pal= argument not recognised\n");
324 if ((t
->std
& V4L2_STD_SECAM
) == V4L2_STD_SECAM
) {
332 tuner_dbg("insmod fixup: SECAM => SECAM-BGH\n");
333 t
->std
= V4L2_STD_SECAM_B
| V4L2_STD_SECAM_G
| V4L2_STD_SECAM_H
;
339 tuner_dbg ("insmod fixup: SECAM => SECAM-DK\n");
340 t
->std
= V4L2_STD_SECAM_DK
;
344 if ((secam
[1]=='C')||(secam
[1]=='c')) {
345 tuner_dbg ("insmod fixup: SECAM => SECAM-L'\n");
346 t
->std
= V4L2_STD_SECAM_LC
;
348 tuner_dbg ("insmod fixup: SECAM => SECAM-L\n");
349 t
->std
= V4L2_STD_SECAM_L
;
353 /* default parameter, do nothing */
356 tuner_warn ("secam= argument not recognised\n");
361 if ((t
->std
& V4L2_STD_NTSC
) == V4L2_STD_NTSC
) {
365 tuner_dbg("insmod fixup: NTSC => NTSC-M\n");
366 t
->std
= V4L2_STD_NTSC_M
;
370 tuner_dbg("insmod fixup: NTSC => NTSC_M_JP\n");
371 t
->std
= V4L2_STD_NTSC_M_JP
;
375 tuner_dbg("insmod fixup: NTSC => NTSC_M_KR\n");
376 t
->std
= V4L2_STD_NTSC_M_KR
;
379 /* default parameter, do nothing */
382 tuner_info("ntsc= argument not recognised\n");
389 static void tuner_status(struct i2c_client
*client
)
391 struct tuner
*t
= i2c_get_clientdata(client
);
392 unsigned long freq
, freq_fraction
;
396 case V4L2_TUNER_RADIO
: p
= "radio"; break;
397 case V4L2_TUNER_ANALOG_TV
: p
= "analog TV"; break;
398 case V4L2_TUNER_DIGITAL_TV
: p
= "digital TV"; break;
399 default: p
= "undefined"; break;
401 if (t
->mode
== V4L2_TUNER_RADIO
) {
402 freq
= t
->radio_freq
/ 16000;
403 freq_fraction
= (t
->radio_freq
% 16000) * 100 / 16000;
405 freq
= t
->tv_freq
/ 16;
406 freq_fraction
= (t
->tv_freq
% 16) * 100 / 16;
408 tuner_info("Tuner mode: %s\n", p
);
409 tuner_info("Frequency: %lu.%02lu MHz\n", freq
, freq_fraction
);
410 tuner_info("Standard: 0x%08llx\n", t
->std
);
411 if (t
->mode
!= V4L2_TUNER_RADIO
)
414 tuner_info("Signal strength: %d\n", t
->has_signal(client
));
417 tuner_info("Stereo: %s\n", t
->is_stereo(client
) ? "yes" : "no");
421 /* ---------------------------------------------------------------------- */
423 /* static var Used only in tuner_attach and tuner_probe */
424 static unsigned default_mode_mask
;
426 /* During client attach, set_type is called by adapter's attach_inform callback.
427 set_type must then be completed by tuner_attach.
429 static int tuner_attach(struct i2c_adapter
*adap
, int addr
, int kind
)
433 client_template
.adapter
= adap
;
434 client_template
.addr
= addr
;
436 t
= kzalloc(sizeof(struct tuner
), GFP_KERNEL
);
439 memcpy(&t
->i2c
, &client_template
, sizeof(struct i2c_client
));
440 i2c_set_clientdata(&t
->i2c
, t
);
442 t
->radio_if2
= 10700 * 1000; /* 10.7MHz - FM radio */
443 t
->audmode
= V4L2_TUNER_MODE_STEREO
;
444 t
->mode_mask
= T_UNINITIALIZED
;
445 if (tuner_debug_old
) {
446 tuner_debug
= tuner_debug_old
;
447 printk(KERN_ERR
"tuner: tuner_debug is deprecated and will be removed in 2.6.17.\n");
448 printk(KERN_ERR
"tuner: use the debug option instead.\n");
452 unsigned char buffer
[16];
455 memset(buffer
, 0, sizeof(buffer
));
456 rc
= i2c_master_recv(&t
->i2c
, buffer
, sizeof(buffer
));
457 tuner_info("I2C RECV = ");
459 printk("%02x ",buffer
[i
]);
462 /* autodetection code based on the i2c addr */
463 if (!no_autodetect
) {
469 /* If chip is not tda8290, don't register.
470 since it can be tda9887*/
471 if (tda8290_probe(&t
->i2c
) != 0) {
472 tuner_dbg("chip at addr %x is not a tda8290\n", addr
);
478 if (tea5767_autodetection(&t
->i2c
) != EINVAL
) {
479 t
->type
= TUNER_TEA5767
;
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
;
491 /* Initializes only the first adapter found */
492 if (default_mode_mask
!= T_UNINITIALIZED
) {
493 tuner_dbg ("Setting mode_mask to 0x%02x\n", default_mode_mask
);
494 t
->mode_mask
= default_mode_mask
;
495 t
->tv_freq
= 400 * 16; /* Sets freq to VHF High */
496 t
->radio_freq
= 87.5 * 16000; /* Sets freq to FM range */
497 default_mode_mask
= T_UNINITIALIZED
;
500 /* Should be just before return */
502 tuner_info("chip found @ 0x%x (%s)\n", addr
<< 1, adap
->name
);
503 i2c_attach_client (&t
->i2c
);
504 set_type (&t
->i2c
,t
->type
, t
->mode_mask
);
508 static int tuner_probe(struct i2c_adapter
*adap
)
511 normal_i2c
[0] = addr
;
512 normal_i2c
[1] = I2C_CLIENT_END
;
515 default_mode_mask
= T_RADIO
| T_ANALOG_TV
| T_DIGITAL_TV
;
517 if (adap
->class & I2C_CLASS_TV_ANALOG
)
518 return i2c_probe(adap
, &addr_data
, tuner_attach
);
522 static int tuner_detach(struct i2c_client
*client
)
524 struct tuner
*t
= i2c_get_clientdata(client
);
527 err
= i2c_detach_client(&t
->i2c
);
530 ("Client deregistration failed, client not detached.\n");
539 * Switch tuner to other mode. If tuner support both tv and radio,
540 * set another frequency to some value (This is needed for some pal
541 * tuners to avoid locking). Otherwise, just put second tuner in
545 static inline int set_mode(struct i2c_client
*client
, struct tuner
*t
, int mode
, char *cmd
)
552 if (check_mode(t
, cmd
) == EINVAL
) {
561 #define switch_v4l2() if (!t->using_v4l2) \
562 tuner_dbg("switching to v4l2\n"); \
565 static inline int check_v4l2(struct tuner
*t
)
568 tuner_dbg ("ignore v4l1 call\n");
574 static int tuner_command(struct i2c_client
*client
, unsigned int cmd
, void *arg
)
576 struct tuner
*t
= i2c_get_clientdata(client
);
579 v4l_i2c_print_ioctl(&(t
->i2c
),cmd
);
582 /* --- configuration --- */
583 case TUNER_SET_TYPE_ADDR
:
584 tuner_dbg ("Calling set_type_addr for type=%d, addr=0x%02x, mode=0x%02x\n",
585 ((struct tuner_setup
*)arg
)->type
,
586 ((struct tuner_setup
*)arg
)->addr
,
587 ((struct tuner_setup
*)arg
)->mode_mask
);
589 set_addr(client
, (struct tuner_setup
*)arg
);
592 if (set_mode(client
, t
, V4L2_TUNER_RADIO
, "AUDC_SET_RADIO")
596 set_freq(client
, t
->radio_freq
);
598 case TUNER_SET_STANDBY
:
599 if (check_mode(t
, "TUNER_SET_STANDBY") == EINVAL
)
605 if (check_mode(t
, "VIDIOCSAUDIO") == EINVAL
)
607 if (check_v4l2(t
) == EINVAL
)
610 /* Should be implemented, since bttv calls it */
611 tuner_dbg("VIDIOCSAUDIO not implemented.\n");
613 /* --- v4l ioctls --- */
614 /* take care: bttv does userspace copying, we'll get a
615 kernel pointer here... */
618 static const v4l2_std_id map
[] = {
619 [VIDEO_MODE_PAL
] = V4L2_STD_PAL
,
620 [VIDEO_MODE_NTSC
] = V4L2_STD_NTSC_M
,
621 [VIDEO_MODE_SECAM
] = V4L2_STD_SECAM
,
622 [4 /* bttv */ ] = V4L2_STD_PAL_M
,
623 [5 /* bttv */ ] = V4L2_STD_PAL_N
,
624 [6 /* bttv */ ] = V4L2_STD_NTSC_M_JP
,
626 struct video_channel
*vc
= arg
;
628 if (check_v4l2(t
) == EINVAL
)
631 if (set_mode(client
,t
,V4L2_TUNER_ANALOG_TV
, "VIDIOCSCHAN")==EINVAL
)
634 if (vc
->norm
< ARRAY_SIZE(map
))
635 t
->std
= map
[vc
->norm
];
638 set_tv_freq(client
, t
->tv_freq
);
643 unsigned long *v
= arg
;
645 if (check_mode(t
, "VIDIOCSFREQ") == EINVAL
)
647 if (check_v4l2(t
) == EINVAL
)
650 set_freq(client
, *v
);
655 struct video_tuner
*vt
= arg
;
657 if (check_mode(t
, "VIDIOCGTUNER") == EINVAL
)
659 if (check_v4l2(t
) == EINVAL
)
662 if (V4L2_TUNER_RADIO
== t
->mode
) {
664 vt
->signal
= t
->has_signal(client
);
666 if (t
->is_stereo(client
))
668 VIDEO_TUNER_STEREO_ON
;
671 ~VIDEO_TUNER_STEREO_ON
;
673 vt
->flags
|= VIDEO_TUNER_LOW
; /* Allow freqs at 62.5 Hz */
675 vt
->rangelow
= radio_range
[0] * 16000;
676 vt
->rangehigh
= radio_range
[1] * 16000;
679 vt
->rangelow
= tv_range
[0] * 16;
680 vt
->rangehigh
= tv_range
[1] * 16;
687 struct video_audio
*va
= arg
;
689 if (check_mode(t
, "VIDIOCGAUDIO") == EINVAL
)
691 if (check_v4l2(t
) == EINVAL
)
694 if (V4L2_TUNER_RADIO
== t
->mode
&& t
->is_stereo
)
695 va
->mode
= t
->is_stereo(client
)
696 ? VIDEO_SOUND_STEREO
: VIDEO_SOUND_MONO
;
702 v4l2_std_id
*id
= arg
;
704 if (set_mode (client
, t
, V4L2_TUNER_ANALOG_TV
, "VIDIOC_S_STD")
713 set_freq(client
, t
->tv_freq
);
716 case VIDIOC_S_FREQUENCY
:
718 struct v4l2_frequency
*f
= arg
;
721 if (V4L2_TUNER_RADIO
== f
->type
&&
722 V4L2_TUNER_RADIO
!= t
->mode
) {
723 if (set_mode (client
, t
, f
->type
, "VIDIOC_S_FREQUENCY")
727 set_freq(client
,f
->frequency
);
731 case VIDIOC_G_FREQUENCY
:
733 struct v4l2_frequency
*f
= arg
;
735 if (check_mode(t
, "VIDIOC_G_FREQUENCY") == EINVAL
)
739 f
->frequency
= (V4L2_TUNER_RADIO
== t
->mode
) ?
740 t
->radio_freq
: t
->tv_freq
;
745 struct v4l2_tuner
*tuner
= arg
;
747 if (check_mode(t
, "VIDIOC_G_TUNER") == EINVAL
)
751 tuner
->type
= t
->mode
;
752 if (t
->mode
!= V4L2_TUNER_RADIO
) {
753 tuner
->rangelow
= tv_range
[0] * 16;
754 tuner
->rangehigh
= tv_range
[1] * 16;
760 tuner
->signal
= t
->has_signal(client
);
763 V4L2_TUNER_SUB_MONO
| V4L2_TUNER_SUB_STEREO
;
765 tuner
->rxsubchans
= t
->is_stereo(client
) ?
766 V4L2_TUNER_SUB_STEREO
: V4L2_TUNER_SUB_MONO
;
770 V4L2_TUNER_CAP_LOW
| V4L2_TUNER_CAP_STEREO
;
771 tuner
->audmode
= t
->audmode
;
772 tuner
->rangelow
= radio_range
[0] * 16000;
773 tuner
->rangehigh
= radio_range
[1] * 16000;
778 struct v4l2_tuner
*tuner
= arg
;
780 if (check_mode(t
, "VIDIOC_S_TUNER") == EINVAL
)
785 /* do nothing unless we're a radio tuner */
786 if (t
->mode
!= V4L2_TUNER_RADIO
)
788 t
->audmode
= tuner
->audmode
;
789 set_radio_freq(client
, t
->radio_freq
);
792 case VIDIOC_LOG_STATUS
:
793 tuner_status(client
);
800 static int tuner_suspend(struct device
*dev
, pm_message_t state
)
802 struct i2c_client
*c
= container_of (dev
, struct i2c_client
, dev
);
803 struct tuner
*t
= i2c_get_clientdata (c
);
805 tuner_dbg ("suspend\n");
806 /* FIXME: power down ??? */
810 static int tuner_resume(struct device
*dev
)
812 struct i2c_client
*c
= container_of (dev
, struct i2c_client
, dev
);
813 struct tuner
*t
= i2c_get_clientdata (c
);
815 tuner_dbg ("resume\n");
816 if (V4L2_TUNER_RADIO
== t
->mode
) {
818 set_freq(c
, t
->radio_freq
);
821 set_freq(c
, t
->tv_freq
);
826 /* ----------------------------------------------------------------------- */
828 static struct i2c_driver driver
= {
829 .id
= I2C_DRIVERID_TUNER
,
830 .attach_adapter
= tuner_probe
,
831 .detach_client
= tuner_detach
,
832 .command
= tuner_command
,
835 .suspend
= tuner_suspend
,
836 .resume
= tuner_resume
,
839 static struct i2c_client client_template
= {
840 .name
= "(tuner unset)",
844 static int __init
tuner_init_module(void)
846 return i2c_add_driver(&driver
);
849 static void __exit
tuner_cleanup_module(void)
851 i2c_del_driver(&driver
);
854 module_init(tuner_init_module
);
855 module_exit(tuner_cleanup_module
);
858 * Overrides for Emacs so that we follow Linus's tabbing style.
859 * ---------------------------------------------------------------------------