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@lxorguk.ukuu.org.uk>
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 <linux/videodev2.h> /* kernel radio structs */
24 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
25 #include <linux/mutex.h>
26 #include <linux/io.h> /* outb, outb_p */
27 #include <media/v4l2-ioctl.h>
28 #include <media/v4l2-device.h>
30 #define RADIO_VERSION KERNEL_VERSION(0, 0, 3)
36 MODULE_AUTHOR("Jonas Munsin, Pekka Seppänen <pexu@kapsi.fi>");
37 MODULE_DESCRIPTION("A driver for the GemTek Radio card.");
38 MODULE_LICENSE("GPL");
44 #ifndef CONFIG_RADIO_GEMTEK_PORT
45 #define CONFIG_RADIO_GEMTEK_PORT -1
47 #ifndef CONFIG_RADIO_GEMTEK_PROBE
48 #define CONFIG_RADIO_GEMTEK_PROBE 1
51 static int io
= CONFIG_RADIO_GEMTEK_PORT
;
52 static int probe
= CONFIG_RADIO_GEMTEK_PROBE
;
54 static int shutdown
= 1;
55 static int keepmuted
= 1;
56 static int initmute
= 1;
57 static int radio_nr
= -1;
59 module_param(io
, int, 0444);
60 MODULE_PARM_DESC(io
, "Force I/O port for the GemTek Radio card if automatic "
61 "probing is disabled or fails. The most common I/O ports are: 0x20c "
62 "0x30c, 0x24c or 0x34c (0x20c, 0x248 and 0x28c have been reported to "
63 "work for the combined sound/radiocard).");
65 module_param(probe
, bool, 0444);
66 MODULE_PARM_DESC(probe
, "Enable automatic device probing. Note: only the most "
67 "common I/O ports used by the card are probed.");
69 module_param(hardmute
, bool, 0644);
70 MODULE_PARM_DESC(hardmute
, "Enable `hard muting' by shutting down PLL, may "
71 "reduce static noise.");
73 module_param(shutdown
, bool, 0644);
74 MODULE_PARM_DESC(shutdown
, "Enable shutting down PLL and muting line when "
75 "module is unloaded.");
77 module_param(keepmuted
, bool, 0644);
78 MODULE_PARM_DESC(keepmuted
, "Keep card muted even when frequency is changed.");
80 module_param(initmute
, bool, 0444);
81 MODULE_PARM_DESC(initmute
, "Mute card when module is loaded.");
83 module_param(radio_nr
, int, 0444);
86 * Functions for controlling the card.
88 #define GEMTEK_LOWFREQ (87*16000)
89 #define GEMTEK_HIGHFREQ (108*16000)
92 * Frequency calculation constants. Intermediate frequency 10.52 MHz (nominal
93 * value 10.7 MHz), reference divisor 6.39 kHz (nominal 6.25 kHz).
96 #define IF_OFFSET ((unsigned int)(10.52 * 16000 * (1<<FSCALE)))
97 #define REF_FREQ ((unsigned int)(6.39 * 16 * (1<<FSCALE)))
99 #define GEMTEK_CK 0x01 /* Clock signal */
100 #define GEMTEK_DA 0x02 /* Serial data */
101 #define GEMTEK_CE 0x04 /* Chip enable */
102 #define GEMTEK_NS 0x08 /* No signal */
103 #define GEMTEK_MT 0x10 /* Line mute */
104 #define GEMTEK_STDF_3_125_KHZ 0x01 /* Standard frequency 3.125 kHz */
105 #define GEMTEK_PLL_OFF 0x07 /* PLL off */
107 #define BU2614_BUS_SIZE 32 /* BU2614 / BU2614FS bus size */
109 #define SHORT_DELAY 5 /* usec */
110 #define LONG_DELAY 75 /* usec */
113 struct v4l2_device v4l2_dev
;
114 struct video_device vdev
;
116 unsigned long lastfreq
;
123 static struct gemtek gemtek_card
;
125 #define BU2614_FREQ_BITS 16 /* D0..D15, Frequency data */
126 #define BU2614_PORT_BITS 3 /* P0..P2, Output port control data */
127 #define BU2614_VOID_BITS 4 /* unused */
128 #define BU2614_FMES_BITS 1 /* CT, Frequency measurement beginning data */
129 #define BU2614_STDF_BITS 3 /* R0..R2, Standard frequency data */
130 #define BU2614_SWIN_BITS 1 /* S, Switch between FMIN / AMIN */
131 #define BU2614_SWAL_BITS 1 /* PS, Swallow counter division (AMIN only)*/
132 #define BU2614_VOID2_BITS 1 /* unused */
133 #define BU2614_FMUN_BITS 1 /* GT, Frequency measurement time & unlock */
134 #define BU2614_TEST_BITS 1 /* TS, Test data is input */
136 #define BU2614_FREQ_SHIFT 0
137 #define BU2614_PORT_SHIFT (BU2614_FREQ_BITS + BU2614_FREQ_SHIFT)
138 #define BU2614_VOID_SHIFT (BU2614_PORT_BITS + BU2614_PORT_SHIFT)
139 #define BU2614_FMES_SHIFT (BU2614_VOID_BITS + BU2614_VOID_SHIFT)
140 #define BU2614_STDF_SHIFT (BU2614_FMES_BITS + BU2614_FMES_SHIFT)
141 #define BU2614_SWIN_SHIFT (BU2614_STDF_BITS + BU2614_STDF_SHIFT)
142 #define BU2614_SWAL_SHIFT (BU2614_SWIN_BITS + BU2614_SWIN_SHIFT)
143 #define BU2614_VOID2_SHIFT (BU2614_SWAL_BITS + BU2614_SWAL_SHIFT)
144 #define BU2614_FMUN_SHIFT (BU2614_VOID2_BITS + BU2614_VOID2_SHIFT)
145 #define BU2614_TEST_SHIFT (BU2614_FMUN_BITS + BU2614_FMUN_SHIFT)
147 #define MKMASK(field) (((1<<BU2614_##field##_BITS) - 1) << \
148 BU2614_##field##_SHIFT)
149 #define BU2614_PORT_MASK MKMASK(PORT)
150 #define BU2614_FREQ_MASK MKMASK(FREQ)
151 #define BU2614_VOID_MASK MKMASK(VOID)
152 #define BU2614_FMES_MASK MKMASK(FMES)
153 #define BU2614_STDF_MASK MKMASK(STDF)
154 #define BU2614_SWIN_MASK MKMASK(SWIN)
155 #define BU2614_SWAL_MASK MKMASK(SWAL)
156 #define BU2614_VOID2_MASK MKMASK(VOID2)
157 #define BU2614_FMUN_MASK MKMASK(FMUN)
158 #define BU2614_TEST_MASK MKMASK(TEST)
161 * Set data which will be sent to BU2614FS.
163 #define gemtek_bu2614_set(dev, field, data) ((dev)->bu2614data = \
164 ((dev)->bu2614data & ~field##_MASK) | ((data) << field##_SHIFT))
167 * Transmit settings to BU2614FS over GemTek IC.
169 static void gemtek_bu2614_transmit(struct gemtek
*gt
)
173 mutex_lock(>
->lock
);
175 mute
= gt
->muted
? GEMTEK_MT
: 0x00;
177 outb_p(mute
| GEMTEK_DA
| GEMTEK_CK
, gt
->io
);
179 outb_p(mute
| GEMTEK_CE
| GEMTEK_DA
| GEMTEK_CK
, gt
->io
);
182 for (i
= 0, q
= gt
->bu2614data
; i
< 32; i
++, q
>>= 1) {
183 bit
= (q
& 1) ? GEMTEK_DA
: 0;
184 outb_p(mute
| GEMTEK_CE
| bit
, gt
->io
);
186 outb_p(mute
| GEMTEK_CE
| bit
| GEMTEK_CK
, gt
->io
);
190 outb_p(mute
| GEMTEK_DA
| GEMTEK_CK
, gt
->io
);
192 outb_p(mute
| GEMTEK_CE
| GEMTEK_DA
| GEMTEK_CK
, gt
->io
);
195 mutex_unlock(>
->lock
);
199 * Calculate divisor from FM-frequency for BU2614FS (3.125 KHz STDF expected).
201 static unsigned long gemtek_convfreq(unsigned long freq
)
203 return ((freq
<<FSCALE
) + IF_OFFSET
+ REF_FREQ
/2) / REF_FREQ
;
209 static void gemtek_setfreq(struct gemtek
*gt
, unsigned long freq
)
211 if (keepmuted
&& hardmute
&& gt
->muted
)
214 freq
= clamp_val(freq
, GEMTEK_LOWFREQ
, GEMTEK_HIGHFREQ
);
219 gemtek_bu2614_set(gt
, BU2614_PORT
, 0);
220 gemtek_bu2614_set(gt
, BU2614_FMES
, 0);
221 gemtek_bu2614_set(gt
, BU2614_SWIN
, 0); /* FM-mode */
222 gemtek_bu2614_set(gt
, BU2614_SWAL
, 0);
223 gemtek_bu2614_set(gt
, BU2614_FMUN
, 1); /* GT bit set */
224 gemtek_bu2614_set(gt
, BU2614_TEST
, 0);
226 gemtek_bu2614_set(gt
, BU2614_STDF
, GEMTEK_STDF_3_125_KHZ
);
227 gemtek_bu2614_set(gt
, BU2614_FREQ
, gemtek_convfreq(freq
));
229 gemtek_bu2614_transmit(gt
);
235 static void gemtek_mute(struct gemtek
*gt
)
242 /* Turn off PLL, disable data output */
243 gemtek_bu2614_set(gt
, BU2614_PORT
, 0);
244 gemtek_bu2614_set(gt
, BU2614_FMES
, 0); /* CT bit off */
245 gemtek_bu2614_set(gt
, BU2614_SWIN
, 0); /* FM-mode */
246 gemtek_bu2614_set(gt
, BU2614_SWAL
, 0);
247 gemtek_bu2614_set(gt
, BU2614_FMUN
, 0); /* GT bit off */
248 gemtek_bu2614_set(gt
, BU2614_TEST
, 0);
249 gemtek_bu2614_set(gt
, BU2614_STDF
, GEMTEK_PLL_OFF
);
250 gemtek_bu2614_set(gt
, BU2614_FREQ
, 0);
251 gemtek_bu2614_transmit(gt
);
255 mutex_lock(>
->lock
);
257 /* Read bus contents (CE, CK and DA). */
259 /* Write it back with mute flag set. */
260 outb_p((i
>> 5) | GEMTEK_MT
, gt
->io
);
263 mutex_unlock(>
->lock
);
269 static void gemtek_unmute(struct gemtek
*gt
)
275 /* Turn PLL back on. */
276 gemtek_setfreq(gt
, gt
->lastfreq
);
279 mutex_lock(>
->lock
);
282 outb_p(i
>> 5, gt
->io
);
285 mutex_unlock(>
->lock
);
289 * Get signal strength (= stereo status).
291 static inline int gemtek_getsigstr(struct gemtek
*gt
)
295 mutex_lock(>
->lock
);
296 sig
= inb_p(gt
->io
) & GEMTEK_NS
? 0 : 1;
297 mutex_unlock(>
->lock
);
302 * Check if requested card acts like GemTek Radio card.
304 static int gemtek_verify(struct gemtek
*gt
, int port
)
308 if (gt
->verified
== port
)
311 mutex_lock(>
->lock
);
313 q
= inb_p(port
); /* Read bus contents before probing. */
314 /* Try to turn on CE, CK and DA respectively and check if card responds
316 for (i
= 0; i
< 3; ++i
) {
317 outb_p(1 << i
, port
);
320 if ((inb_p(port
) & (~GEMTEK_NS
)) != (0x17 | (1 << (i
+ 5)))) {
321 mutex_unlock(>
->lock
);
325 outb_p(q
>> 5, port
); /* Write bus contents back. */
328 mutex_unlock(>
->lock
);
335 * Automatic probing for card.
337 static int gemtek_probe(struct gemtek
*gt
)
339 struct v4l2_device
*v4l2_dev
= >
->v4l2_dev
;
340 int ioports
[] = { 0x20c, 0x30c, 0x24c, 0x34c, 0x248, 0x28c };
344 v4l2_info(v4l2_dev
, "Automatic device probing disabled.\n");
348 v4l2_info(v4l2_dev
, "Automatic device probing enabled.\n");
350 for (i
= 0; i
< ARRAY_SIZE(ioports
); ++i
) {
351 v4l2_info(v4l2_dev
, "Trying I/O port 0x%x...\n", ioports
[i
]);
353 if (!request_region(ioports
[i
], 1, "gemtek-probe")) {
354 v4l2_warn(v4l2_dev
, "I/O port 0x%x busy!\n",
359 if (gemtek_verify(gt
, ioports
[i
])) {
360 v4l2_info(v4l2_dev
, "Card found from I/O port "
361 "0x%x!\n", ioports
[i
]);
363 release_region(ioports
[i
], 1);
368 release_region(ioports
[i
], 1);
371 v4l2_err(v4l2_dev
, "Automatic probing failed!\n");
376 * Video 4 Linux stuff.
379 static const struct v4l2_file_operations gemtek_fops
= {
380 .owner
= THIS_MODULE
,
381 .unlocked_ioctl
= video_ioctl2
,
384 static int vidioc_querycap(struct file
*file
, void *priv
,
385 struct v4l2_capability
*v
)
387 strlcpy(v
->driver
, "radio-gemtek", sizeof(v
->driver
));
388 strlcpy(v
->card
, "GemTek", sizeof(v
->card
));
389 strlcpy(v
->bus_info
, "ISA", sizeof(v
->bus_info
));
390 v
->version
= RADIO_VERSION
;
391 v
->capabilities
= V4L2_CAP_TUNER
| V4L2_CAP_RADIO
;
395 static int vidioc_g_tuner(struct file
*file
, void *priv
, struct v4l2_tuner
*v
)
397 struct gemtek
*gt
= video_drvdata(file
);
402 strlcpy(v
->name
, "FM", sizeof(v
->name
));
403 v
->type
= V4L2_TUNER_RADIO
;
404 v
->rangelow
= GEMTEK_LOWFREQ
;
405 v
->rangehigh
= GEMTEK_HIGHFREQ
;
406 v
->capability
= V4L2_TUNER_CAP_LOW
| V4L2_TUNER_CAP_STEREO
;
407 v
->signal
= 0xffff * gemtek_getsigstr(gt
);
409 v
->audmode
= V4L2_TUNER_MODE_STEREO
;
410 v
->rxsubchans
= V4L2_TUNER_SUB_STEREO
;
412 v
->audmode
= V4L2_TUNER_MODE_MONO
;
413 v
->rxsubchans
= V4L2_TUNER_SUB_MONO
;
418 static int vidioc_s_tuner(struct file
*file
, void *priv
, struct v4l2_tuner
*v
)
420 return (v
->index
!= 0) ? -EINVAL
: 0;
423 static int vidioc_g_frequency(struct file
*file
, void *priv
,
424 struct v4l2_frequency
*f
)
426 struct gemtek
*gt
= video_drvdata(file
);
430 f
->type
= V4L2_TUNER_RADIO
;
431 f
->frequency
= gt
->lastfreq
;
435 static int vidioc_s_frequency(struct file
*file
, void *priv
,
436 struct v4l2_frequency
*f
)
438 struct gemtek
*gt
= video_drvdata(file
);
440 if (f
->tuner
!= 0 || f
->type
!= V4L2_TUNER_RADIO
)
442 gemtek_setfreq(gt
, f
->frequency
);
446 static int vidioc_queryctrl(struct file
*file
, void *priv
,
447 struct v4l2_queryctrl
*qc
)
450 case V4L2_CID_AUDIO_MUTE
:
451 return v4l2_ctrl_query_fill(qc
, 0, 1, 1, 0);
457 static int vidioc_g_ctrl(struct file
*file
, void *priv
,
458 struct v4l2_control
*ctrl
)
460 struct gemtek
*gt
= video_drvdata(file
);
463 case V4L2_CID_AUDIO_MUTE
:
464 ctrl
->value
= gt
->muted
;
470 static int vidioc_s_ctrl(struct file
*file
, void *priv
,
471 struct v4l2_control
*ctrl
)
473 struct gemtek
*gt
= video_drvdata(file
);
476 case V4L2_CID_AUDIO_MUTE
:
486 static int vidioc_g_input(struct file
*filp
, void *priv
, unsigned int *i
)
492 static int vidioc_s_input(struct file
*filp
, void *priv
, unsigned int i
)
494 return (i
!= 0) ? -EINVAL
: 0;
497 static int vidioc_g_audio(struct file
*file
, void *priv
, struct v4l2_audio
*a
)
500 strlcpy(a
->name
, "Radio", sizeof(a
->name
));
501 a
->capability
= V4L2_AUDCAP_STEREO
;
505 static int vidioc_s_audio(struct file
*file
, void *priv
, struct v4l2_audio
*a
)
507 return (a
->index
!= 0) ? -EINVAL
: 0;
510 static const struct v4l2_ioctl_ops gemtek_ioctl_ops
= {
511 .vidioc_querycap
= vidioc_querycap
,
512 .vidioc_g_tuner
= vidioc_g_tuner
,
513 .vidioc_s_tuner
= vidioc_s_tuner
,
514 .vidioc_g_audio
= vidioc_g_audio
,
515 .vidioc_s_audio
= vidioc_s_audio
,
516 .vidioc_g_input
= vidioc_g_input
,
517 .vidioc_s_input
= vidioc_s_input
,
518 .vidioc_g_frequency
= vidioc_g_frequency
,
519 .vidioc_s_frequency
= vidioc_s_frequency
,
520 .vidioc_queryctrl
= vidioc_queryctrl
,
521 .vidioc_g_ctrl
= vidioc_g_ctrl
,
522 .vidioc_s_ctrl
= vidioc_s_ctrl
526 * Initialization / cleanup related stuff.
529 static int __init
gemtek_init(void)
531 struct gemtek
*gt
= &gemtek_card
;
532 struct v4l2_device
*v4l2_dev
= >
->v4l2_dev
;
535 strlcpy(v4l2_dev
->name
, "gemtek", sizeof(v4l2_dev
->name
));
537 v4l2_info(v4l2_dev
, "GemTek Radio card driver: v0.0.3\n");
539 mutex_init(>
->lock
);
545 if (!request_region(gt
->io
, 1, "gemtek")) {
546 v4l2_err(v4l2_dev
, "I/O port 0x%x already in use.\n", gt
->io
);
550 if (!gemtek_verify(gt
, gt
->io
))
551 v4l2_warn(v4l2_dev
, "Card at I/O port 0x%x does not "
552 "respond properly, check your "
553 "configuration.\n", gt
->io
);
555 v4l2_info(v4l2_dev
, "Using I/O port 0x%x.\n", gt
->io
);
557 v4l2_err(v4l2_dev
, "Automatic probing failed and no "
558 "fixed I/O port defined.\n");
561 v4l2_err(v4l2_dev
, "Automatic probing disabled but no fixed "
562 "I/O port defined.");
566 res
= v4l2_device_register(NULL
, v4l2_dev
);
568 v4l2_err(v4l2_dev
, "Could not register v4l2_device\n");
569 release_region(gt
->io
, 1);
573 strlcpy(gt
->vdev
.name
, v4l2_dev
->name
, sizeof(gt
->vdev
.name
));
574 gt
->vdev
.v4l2_dev
= v4l2_dev
;
575 gt
->vdev
.fops
= &gemtek_fops
;
576 gt
->vdev
.ioctl_ops
= &gemtek_ioctl_ops
;
577 gt
->vdev
.release
= video_device_release_empty
;
578 video_set_drvdata(>
->vdev
, gt
);
581 gt
->lastfreq
= GEMTEK_LOWFREQ
;
587 if (video_register_device(>
->vdev
, VFL_TYPE_RADIO
, radio_nr
) < 0) {
588 v4l2_device_unregister(v4l2_dev
);
589 release_region(gt
->io
, 1);
599 static void __exit
gemtek_exit(void)
601 struct gemtek
*gt
= &gemtek_card
;
602 struct v4l2_device
*v4l2_dev
= >
->v4l2_dev
;
605 hardmute
= 1; /* Turn off PLL */
608 v4l2_info(v4l2_dev
, "Module unloaded but card not muted!\n");
611 video_unregister_device(>
->vdev
);
612 v4l2_device_unregister(>
->v4l2_dev
);
613 release_region(gt
->io
, 1);
616 module_init(gemtek_init
);
617 module_exit(gemtek_exit
);