1 /* GemTek radio card driver for Linux (C) 1998 Jonas Munsin <jmunsin@iki.fi>
3 * GemTek hasn't released any specs on the card, so the protocol had to
4 * be reverse engineered with dosemu.
6 * Besides the protocol changes, this is mostly a copy of:
8 * RadioTrack II driver for Linux radio support (C) 1998 Ben Pfaff
10 * Based on RadioTrack I/RadioReveal (C) 1997 M. Kirkwood
11 * Converted to new API by Alan Cox <Alan.Cox@linux.org>
12 * Various bugfixes and enhancements by Russell Kroll <rkroll@exploits.org>
14 * TODO: Allow for more than one of these foolish entities :-)
16 * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
19 #include <linux/module.h> /* Modules */
20 #include <linux/init.h> /* Initdata */
21 #include <linux/ioport.h> /* request_region */
22 #include <linux/delay.h> /* udelay */
23 #include <asm/io.h> /* outb, outb_p */
24 #include <asm/uaccess.h> /* copy to/from user */
25 #include <linux/videodev2.h> /* kernel radio structs */
26 #include <media/v4l2-common.h>
27 #include <linux/spinlock.h>
29 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
30 #define RADIO_VERSION KERNEL_VERSION(0,0,3)
31 #define RADIO_BANNER "GemTek Radio card driver: v0.0.3"
37 MODULE_AUTHOR("Jonas Munsin, Pekka Seppänen <pexu@kapsi.fi>");
38 MODULE_DESCRIPTION("A driver for the GemTek Radio card.");
39 MODULE_LICENSE("GPL");
45 #ifndef CONFIG_RADIO_GEMTEK_PORT
46 #define CONFIG_RADIO_GEMTEK_PORT -1
48 #ifndef CONFIG_RADIO_GEMTEK_PROBE
49 #define CONFIG_RADIO_GEMTEK_PROBE 1
52 static int io
= CONFIG_RADIO_GEMTEK_PORT
;
53 static int probe
= CONFIG_RADIO_GEMTEK_PROBE
;
55 static int shutdown
= 1;
56 static int keepmuted
= 1;
57 static int initmute
= 1;
58 static int radio_nr
= -1;
60 module_param(io
, int, 0444);
61 MODULE_PARM_DESC(io
, "Force I/O port for the GemTek Radio card if automatic"
62 "probing is disabled or fails. The most common I/O ports are: 0x20c "
63 "0x30c, 0x24c or 0x34c (0x20c, 0x248 and 0x28c have been reported to "
64 " work for the combined sound/radiocard).");
66 module_param(probe
, bool, 0444);
67 MODULE_PARM_DESC(probe
, "Enable automatic device probing. Note: only the most "
68 "common I/O ports used by the card are probed.");
70 module_param(hardmute
, bool, 0644);
71 MODULE_PARM_DESC(hardmute
, "Enable `hard muting' by shutting down PLL, may "
72 "reduce static noise.");
74 module_param(shutdown
, bool, 0644);
75 MODULE_PARM_DESC(shutdown
, "Enable shutting down PLL and muting line when "
76 "module is unloaded.");
78 module_param(keepmuted
, bool, 0644);
79 MODULE_PARM_DESC(keepmuted
, "Keep card muted even when frequency is changed.");
81 module_param(initmute
, bool, 0444);
82 MODULE_PARM_DESC(initmute
, "Mute card when module is loaded.");
84 module_param(radio_nr
, int, 0444);
87 * Functions for controlling the card.
89 #define GEMTEK_LOWFREQ (87*16000)
90 #define GEMTEK_HIGHFREQ (108*16000)
93 * Frequency calculation constants. Intermediate frequency 10.52 MHz (nominal
94 * value 10.7 MHz), reference divisor 6.39 kHz (nominal 6.25 kHz).
97 #define IF_OFFSET ((unsigned int)(10.52 * 16000 * (1<<FSCALE)))
98 #define REF_FREQ ((unsigned int)(6.39 * 16 * (1<<FSCALE)))
100 #define GEMTEK_CK 0x01 /* Clock signal */
101 #define GEMTEK_DA 0x02 /* Serial data */
102 #define GEMTEK_CE 0x04 /* Chip enable */
103 #define GEMTEK_NS 0x08 /* No signal */
104 #define GEMTEK_MT 0x10 /* Line mute */
105 #define GEMTEK_STDF_3_125_KHZ 0x01 /* Standard frequency 3.125 kHz */
106 #define GEMTEK_PLL_OFF 0x07 /* PLL off */
108 #define BU2614_BUS_SIZE 32 /* BU2614 / BU2614FS bus size */
110 #define SHORT_DELAY 5 /* usec */
111 #define LONG_DELAY 75 /* usec */
113 struct gemtek_device
{
114 unsigned long lastfreq
;
119 #define BU2614_FREQ_BITS 16 /* D0..D15, Frequency data */
120 #define BU2614_PORT_BITS 3 /* P0..P2, Output port control data */
121 #define BU2614_VOID_BITS 4 /* unused */
122 #define BU2614_FMES_BITS 1 /* CT, Frequency measurement beginning data */
123 #define BU2614_STDF_BITS 3 /* R0..R2, Standard frequency data */
124 #define BU2614_SWIN_BITS 1 /* S, Switch between FMIN / AMIN */
125 #define BU2614_SWAL_BITS 1 /* PS, Swallow counter division (AMIN only)*/
126 #define BU2614_VOID2_BITS 1 /* unused */
127 #define BU2614_FMUN_BITS 1 /* GT, Frequency measurement time & unlock */
128 #define BU2614_TEST_BITS 1 /* TS, Test data is input */
130 #define BU2614_FREQ_SHIFT 0
131 #define BU2614_PORT_SHIFT (BU2614_FREQ_BITS + BU2614_FREQ_SHIFT)
132 #define BU2614_VOID_SHIFT (BU2614_PORT_BITS + BU2614_PORT_SHIFT)
133 #define BU2614_FMES_SHIFT (BU2614_VOID_BITS + BU2614_VOID_SHIFT)
134 #define BU2614_STDF_SHIFT (BU2614_FMES_BITS + BU2614_FMES_SHIFT)
135 #define BU2614_SWIN_SHIFT (BU2614_STDF_BITS + BU2614_STDF_SHIFT)
136 #define BU2614_SWAL_SHIFT (BU2614_SWIN_BITS + BU2614_SWIN_SHIFT)
137 #define BU2614_VOID2_SHIFT (BU2614_SWAL_BITS + BU2614_SWAL_SHIFT)
138 #define BU2614_FMUN_SHIFT (BU2614_VOID2_BITS + BU2614_VOID2_SHIFT)
139 #define BU2614_TEST_SHIFT (BU2614_FMUN_BITS + BU2614_FMUN_SHIFT)
141 #define MKMASK(field) (((1<<BU2614_##field##_BITS) - 1) << \
142 BU2614_##field##_SHIFT)
143 #define BU2614_PORT_MASK MKMASK(PORT)
144 #define BU2614_FREQ_MASK MKMASK(FREQ)
145 #define BU2614_VOID_MASK MKMASK(VOID)
146 #define BU2614_FMES_MASK MKMASK(FMES)
147 #define BU2614_STDF_MASK MKMASK(STDF)
148 #define BU2614_SWIN_MASK MKMASK(SWIN)
149 #define BU2614_SWAL_MASK MKMASK(SWAL)
150 #define BU2614_VOID2_MASK MKMASK(VOID2)
151 #define BU2614_FMUN_MASK MKMASK(FMUN)
152 #define BU2614_TEST_MASK MKMASK(TEST)
154 static struct gemtek_device gemtek_unit
;
156 static spinlock_t lock
;
159 * Set data which will be sent to BU2614FS.
161 #define gemtek_bu2614_set(dev, field, data) ((dev)->bu2614data = \
162 ((dev)->bu2614data & ~field##_MASK) | ((data) << field##_SHIFT))
165 * Transmit settings to BU2614FS over GemTek IC.
167 static void gemtek_bu2614_transmit(struct gemtek_device
*dev
)
173 mute
= dev
->muted
? GEMTEK_MT
: 0x00;
175 outb_p(mute
| GEMTEK_DA
| GEMTEK_CK
, io
);
177 outb_p(mute
| GEMTEK_CE
| GEMTEK_DA
| GEMTEK_CK
, io
);
180 for (i
= 0, q
= dev
->bu2614data
; i
< 32; i
++, q
>>= 1) {
181 bit
= (q
& 1) ? GEMTEK_DA
: 0;
182 outb_p(mute
| GEMTEK_CE
| bit
, io
);
184 outb_p(mute
| GEMTEK_CE
| bit
| GEMTEK_CK
, io
);
188 outb_p(mute
| GEMTEK_DA
| GEMTEK_CK
, io
);
190 outb_p(mute
| GEMTEK_CE
| GEMTEK_DA
| GEMTEK_CK
, io
);
197 * Calculate divisor from FM-frequency for BU2614FS (3.125 KHz STDF expected).
199 static unsigned long gemtek_convfreq(unsigned long freq
)
201 return ((freq
<<FSCALE
) + IF_OFFSET
+ REF_FREQ
/2) / REF_FREQ
;
207 static void gemtek_setfreq(struct gemtek_device
*dev
, unsigned long freq
)
210 if (keepmuted
&& hardmute
&& dev
->muted
)
213 if (freq
< GEMTEK_LOWFREQ
)
214 freq
= GEMTEK_LOWFREQ
;
215 else if (freq
> GEMTEK_HIGHFREQ
)
216 freq
= GEMTEK_HIGHFREQ
;
218 dev
->lastfreq
= freq
;
221 gemtek_bu2614_set(dev
, BU2614_PORT
, 0);
222 gemtek_bu2614_set(dev
, BU2614_FMES
, 0);
223 gemtek_bu2614_set(dev
, BU2614_SWIN
, 0); /* FM-mode */
224 gemtek_bu2614_set(dev
, BU2614_SWAL
, 0);
225 gemtek_bu2614_set(dev
, BU2614_FMUN
, 1); /* GT bit set */
226 gemtek_bu2614_set(dev
, BU2614_TEST
, 0);
228 gemtek_bu2614_set(dev
, BU2614_STDF
, GEMTEK_STDF_3_125_KHZ
);
229 gemtek_bu2614_set(dev
, BU2614_FREQ
, gemtek_convfreq(freq
));
231 gemtek_bu2614_transmit(dev
);
237 static void gemtek_mute(struct gemtek_device
*dev
)
243 /* Turn off PLL, disable data output */
244 gemtek_bu2614_set(dev
, BU2614_PORT
, 0);
245 gemtek_bu2614_set(dev
, BU2614_FMES
, 0); /* CT bit off */
246 gemtek_bu2614_set(dev
, BU2614_SWIN
, 0); /* FM-mode */
247 gemtek_bu2614_set(dev
, BU2614_SWAL
, 0);
248 gemtek_bu2614_set(dev
, BU2614_FMUN
, 0); /* GT bit off */
249 gemtek_bu2614_set(dev
, BU2614_TEST
, 0);
250 gemtek_bu2614_set(dev
, BU2614_STDF
, GEMTEK_PLL_OFF
);
251 gemtek_bu2614_set(dev
, BU2614_FREQ
, 0);
252 gemtek_bu2614_transmit(dev
);
256 /* Read bus contents (CE, CK and DA). */
258 /* Write it back with mute flag set. */
259 outb_p((i
>> 5) | GEMTEK_MT
, io
);
269 static void gemtek_unmute(struct gemtek_device
*dev
)
275 /* Turn PLL back on. */
276 gemtek_setfreq(dev
, dev
->lastfreq
);
289 * Get signal strength (= stereo status).
291 static inline int gemtek_getsigstr(void)
293 return inb_p(io
) & GEMTEK_NS
? 0 : 1;
297 * Check if requested card acts like GemTek Radio card.
299 static int gemtek_verify(int port
)
301 static int verified
= -1;
304 if (verified
== port
)
309 q
= inb_p(port
); /* Read bus contents before probing. */
310 /* Try to turn on CE, CK and DA respectively and check if card responds
312 for (i
= 0; i
< 3; ++i
) {
313 outb_p(1 << i
, port
);
316 if ((inb_p(port
) & (~GEMTEK_NS
)) != (0x17 | (1 << (i
+ 5)))) {
321 outb_p(q
>> 5, port
); /* Write bus contents back. */
331 * Automatic probing for card.
333 static int gemtek_probe(void)
335 int ioports
[] = { 0x20c, 0x30c, 0x24c, 0x34c, 0x248, 0x28c };
339 printk(KERN_INFO
"Automatic device probing disabled.\n");
343 printk(KERN_INFO
"Automatic device probing enabled.\n");
345 for (i
= 0; i
< ARRAY_SIZE(ioports
); ++i
) {
346 printk(KERN_INFO
"Trying I/O port 0x%x...\n", ioports
[i
]);
348 if (!request_region(ioports
[i
], 1, "gemtek-probe")) {
349 printk(KERN_WARNING
"I/O port 0x%x busy!\n",
354 if (gemtek_verify(ioports
[i
])) {
355 printk(KERN_INFO
"Card found from I/O port "
356 "0x%x!\n", ioports
[i
]);
358 release_region(ioports
[i
], 1);
364 release_region(ioports
[i
], 1);
367 printk(KERN_ERR
"Automatic probing failed!\n");
373 * Video 4 Linux stuff.
376 static struct v4l2_queryctrl radio_qctrl
[] = {
378 .id
= V4L2_CID_AUDIO_MUTE
,
383 .type
= V4L2_CTRL_TYPE_BOOLEAN
,
385 .id
= V4L2_CID_AUDIO_VOLUME
,
390 .default_value
= 0xff,
391 .type
= V4L2_CTRL_TYPE_INTEGER
,
395 static struct file_operations gemtek_fops
= {
396 .owner
= THIS_MODULE
,
397 .open
= video_exclusive_open
,
398 .release
= video_exclusive_release
,
399 .ioctl
= video_ioctl2
,
400 .compat_ioctl
= v4l_compat_ioctl32
,
404 static int vidioc_querycap(struct file
*file
, void *priv
,
405 struct v4l2_capability
*v
)
407 strlcpy(v
->driver
, "radio-gemtek", sizeof(v
->driver
));
408 strlcpy(v
->card
, "GemTek", sizeof(v
->card
));
409 sprintf(v
->bus_info
, "ISA");
410 v
->version
= RADIO_VERSION
;
411 v
->capabilities
= V4L2_CAP_TUNER
;
415 static int vidioc_g_tuner(struct file
*file
, void *priv
, struct v4l2_tuner
*v
)
420 strcpy(v
->name
, "FM");
421 v
->type
= V4L2_TUNER_RADIO
;
422 v
->rangelow
= GEMTEK_LOWFREQ
;
423 v
->rangehigh
= GEMTEK_HIGHFREQ
;
424 v
->capability
= V4L2_TUNER_CAP_LOW
| V4L2_TUNER_CAP_STEREO
;
425 v
->signal
= 0xffff * gemtek_getsigstr();
427 v
->audmode
= V4L2_TUNER_MODE_STEREO
;
428 v
->rxsubchans
= V4L2_TUNER_SUB_STEREO
;
430 v
->audmode
= V4L2_TUNER_MODE_MONO
;
431 v
->rxsubchans
= V4L2_TUNER_SUB_MONO
;
437 static int vidioc_s_tuner(struct file
*file
, void *priv
, struct v4l2_tuner
*v
)
444 static int vidioc_s_frequency(struct file
*file
, void *priv
,
445 struct v4l2_frequency
*f
)
447 struct video_device
*dev
= video_devdata(file
);
448 struct gemtek_device
*rt
= dev
->priv
;
450 gemtek_setfreq(rt
, f
->frequency
);
455 static int vidioc_g_frequency(struct file
*file
, void *priv
,
456 struct v4l2_frequency
*f
)
458 struct video_device
*dev
= video_devdata(file
);
459 struct gemtek_device
*rt
= dev
->priv
;
461 f
->type
= V4L2_TUNER_RADIO
;
462 f
->frequency
= rt
->lastfreq
;
466 static int vidioc_queryctrl(struct file
*file
, void *priv
,
467 struct v4l2_queryctrl
*qc
)
471 for (i
= 0; i
< ARRAY_SIZE(radio_qctrl
); ++i
) {
472 if (qc
->id
&& qc
->id
== radio_qctrl
[i
].id
) {
473 memcpy(qc
, &(radio_qctrl
[i
]), sizeof(*qc
));
480 static int vidioc_g_ctrl(struct file
*file
, void *priv
,
481 struct v4l2_control
*ctrl
)
483 struct video_device
*dev
= video_devdata(file
);
484 struct gemtek_device
*rt
= dev
->priv
;
487 case V4L2_CID_AUDIO_MUTE
:
488 ctrl
->value
= rt
->muted
;
490 case V4L2_CID_AUDIO_VOLUME
:
500 static int vidioc_s_ctrl(struct file
*file
, void *priv
,
501 struct v4l2_control
*ctrl
)
503 struct video_device
*dev
= video_devdata(file
);
504 struct gemtek_device
*rt
= dev
->priv
;
507 case V4L2_CID_AUDIO_MUTE
:
513 case V4L2_CID_AUDIO_VOLUME
:
523 static int vidioc_g_audio(struct file
*file
, void *priv
, struct v4l2_audio
*a
)
528 strcpy(a
->name
, "Radio");
529 a
->capability
= V4L2_AUDCAP_STEREO
;
533 static int vidioc_g_input(struct file
*filp
, void *priv
, unsigned int *i
)
539 static int vidioc_s_input(struct file
*filp
, void *priv
, unsigned int i
)
546 static int vidioc_s_audio(struct file
*file
, void *priv
, struct v4l2_audio
*a
)
553 static struct video_device gemtek_radio
= {
554 .owner
= THIS_MODULE
,
555 .name
= "GemTek Radio card",
556 .type
= VID_TYPE_TUNER
,
557 .hardware
= VID_HARDWARE_GEMTEK
,
558 .fops
= &gemtek_fops
,
559 .vidioc_querycap
= vidioc_querycap
,
560 .vidioc_g_tuner
= vidioc_g_tuner
,
561 .vidioc_s_tuner
= vidioc_s_tuner
,
562 .vidioc_g_audio
= vidioc_g_audio
,
563 .vidioc_s_audio
= vidioc_s_audio
,
564 .vidioc_g_input
= vidioc_g_input
,
565 .vidioc_s_input
= vidioc_s_input
,
566 .vidioc_g_frequency
= vidioc_g_frequency
,
567 .vidioc_s_frequency
= vidioc_s_frequency
,
568 .vidioc_queryctrl
= vidioc_queryctrl
,
569 .vidioc_g_ctrl
= vidioc_g_ctrl
,
570 .vidioc_s_ctrl
= vidioc_s_ctrl
574 * Initialization / cleanup related stuff.
580 static int __init
gemtek_init(void)
582 printk(KERN_INFO RADIO_BANNER
"\n");
584 spin_lock_init(&lock
);
588 if (!request_region(io
, 1, "gemtek")) {
589 printk(KERN_ERR
"I/O port 0x%x already in use.\n", io
);
593 if (!gemtek_verify(io
))
594 printk(KERN_WARNING
"Card at I/O port 0x%x does not "
595 "respond properly, check your "
596 "configuration.\n", io
);
598 printk(KERN_INFO
"Using I/O port 0x%x.\n", io
);
600 printk(KERN_ERR
"Automatic probing failed and no "
601 "fixed I/O port defined.\n");
604 printk(KERN_ERR
"Automatic probing disabled but no fixed "
605 "I/O port defined.");
609 gemtek_radio
.priv
= &gemtek_unit
;
611 if (video_register_device(&gemtek_radio
, VFL_TYPE_RADIO
,
613 release_region(io
, 1);
618 gemtek_unit
.lastfreq
= GEMTEK_LOWFREQ
;
619 gemtek_unit
.bu2614data
= 0;
622 gemtek_mute(&gemtek_unit
);
630 static void __exit
gemtek_exit(void)
633 hardmute
= 1; /* Turn off PLL */
634 gemtek_mute(&gemtek_unit
);
636 printk(KERN_INFO
"Module unloaded but card not muted!\n");
639 video_unregister_device(&gemtek_radio
);
640 release_region(io
, 1);
643 module_init(gemtek_init
);
644 module_exit(gemtek_exit
);