1 /* Typhoon Radio Card driver for radio support
2  * (c) 1999 Dr. Henrik Seidel <Henrik.Seidel@gmx.de>
3  *
4  * Card manufacturer:
5  * http://194.18.155.92/idc/prod2.idc?nr=50753&lang=e
6  *
7  * Notes on the hardware
8  *
9  * This card has two output sockets, one for speakers and one for line.
10  * The speaker output has volume control, but only in four discrete
11  * steps. The line output has neither volume control nor mute.
12  *
13  * The card has auto-stereo according to its manual, although it all
14  * sounds mono to me (even with the Win/DOS drivers). Maybe it's my
15  * antenna - I really don't know for sure.
16  *
17  * Frequency control is done digitally.
18  *
19  * Volume control is done digitally, but there are only four different
20  * possible values. So you should better always turn the volume up and
21  * use line control. I got the best results by connecting line output
22  * to the sound card microphone input. For such a configuration the
23  * volume control has no effect, since volume control only influences
24  * the speaker output.
25  *
26  * There is no explicit mute/unmute. So I set the radio frequency to a
27  * value where I do expect just noise and turn the speaker volume down.
28  * The frequency change is necessary since the card never seems to be
29  * completely silent.
30  *
31  * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
32  */
33 
34 #include <linux/module.h>	/* Modules                        */
35 #include <linux/init.h>		/* Initdata                       */
36 #include <linux/ioport.h>	/* request_region		  */
37 #include <linux/proc_fs.h>	/* radio card status report	  */
38 #include <asm/io.h>		/* outb, outb_p                   */
39 #include <asm/uaccess.h>	/* copy to/from user              */
40 #include <linux/videodev2.h>	/* kernel radio structs           */
41 #include <media/v4l2-common.h>
42 
43 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
44 #define RADIO_VERSION KERNEL_VERSION(0,1,1)
45 #define BANNER "Typhoon Radio Card driver v0.1.1\n"
46 
47 static struct v4l2_queryctrl radio_qctrl[] = {
48 	{
49 		.id            = V4L2_CID_AUDIO_MUTE,
50 		.name          = "Mute",
51 		.minimum       = 0,
52 		.maximum       = 1,
53 		.default_value = 1,
54 		.type          = V4L2_CTRL_TYPE_BOOLEAN,
55 	},{
56 		.id            = V4L2_CID_AUDIO_VOLUME,
57 		.name          = "Volume",
58 		.minimum       = 0,
59 		.maximum       = 65535,
60 		.step          = 1<<14,
61 		.default_value = 0xff,
62 		.type          = V4L2_CTRL_TYPE_INTEGER,
63 	}
64 };
65 
66 
67 #ifndef CONFIG_RADIO_TYPHOON_PORT
68 #define CONFIG_RADIO_TYPHOON_PORT -1
69 #endif
70 
71 #ifndef CONFIG_RADIO_TYPHOON_MUTEFREQ
72 #define CONFIG_RADIO_TYPHOON_MUTEFREQ 0
73 #endif
74 
75 #ifndef CONFIG_PROC_FS
76 #undef CONFIG_RADIO_TYPHOON_PROC_FS
77 #endif
78 
79 struct typhoon_device {
80 	int users;
81 	int iobase;
82 	int curvol;
83 	int muted;
84 	unsigned long curfreq;
85 	unsigned long mutefreq;
86 	struct mutex lock;
87 };
88 
89 static void typhoon_setvol_generic(struct typhoon_device *dev, int vol);
90 static int typhoon_setfreq_generic(struct typhoon_device *dev,
91 				   unsigned long frequency);
92 static int typhoon_setfreq(struct typhoon_device *dev, unsigned long frequency);
93 static void typhoon_mute(struct typhoon_device *dev);
94 static void typhoon_unmute(struct typhoon_device *dev);
95 static int typhoon_setvol(struct typhoon_device *dev, int vol);
96 #ifdef CONFIG_RADIO_TYPHOON_PROC_FS
97 static int typhoon_get_info(char *buf, char **start, off_t offset, int len);
98 #endif
99 
100 static void typhoon_setvol_generic(struct typhoon_device *dev, int vol)
101 {
102 	mutex_lock(&dev->lock);
103 	vol >>= 14;				/* Map 16 bit to 2 bit */
104 	vol &= 3;
105 	outb_p(vol / 2, dev->iobase);		/* Set the volume, high bit. */
106 	outb_p(vol % 2, dev->iobase + 2);	/* Set the volume, low bit. */
107 	mutex_unlock(&dev->lock);
108 }
109 
110 static int typhoon_setfreq_generic(struct typhoon_device *dev,
111 				   unsigned long frequency)
112 {
113 	unsigned long outval;
114 	unsigned long x;
115 
116 	/*
117 	 * The frequency transfer curve is not linear. The best fit I could
118 	 * get is
119 	 *
120 	 * outval = -155 + exp((f + 15.55) * 0.057))
121 	 *
122 	 * where frequency f is in MHz. Since we don't have exp in the kernel,
123 	 * I approximate this function by a third order polynomial.
124 	 *
125 	 */
126 
127 	mutex_lock(&dev->lock);
128 	x = frequency / 160;
129 	outval = (x * x + 2500) / 5000;
130 	outval = (outval * x + 5000) / 10000;
131 	outval -= (10 * x * x + 10433) / 20866;
132 	outval += 4 * x - 11505;
133 
134 	outb_p((outval >> 8) & 0x01, dev->iobase + 4);
135 	outb_p(outval >> 9, dev->iobase + 6);
136 	outb_p(outval & 0xff, dev->iobase + 8);
137 	mutex_unlock(&dev->lock);
138 
139 	return 0;
140 }
141 
142 static int typhoon_setfreq(struct typhoon_device *dev, unsigned long frequency)
143 {
144 	typhoon_setfreq_generic(dev, frequency);
145 	dev->curfreq = frequency;
146 	return 0;
147 }
148 
149 static void typhoon_mute(struct typhoon_device *dev)
150 {
151 	if (dev->muted == 1)
152 		return;
153 	typhoon_setvol_generic(dev, 0);
154 	typhoon_setfreq_generic(dev, dev->mutefreq);
155 	dev->muted = 1;
156 }
157 
158 static void typhoon_unmute(struct typhoon_device *dev)
159 {
160 	if (dev->muted == 0)
161 		return;
162 	typhoon_setfreq_generic(dev, dev->curfreq);
163 	typhoon_setvol_generic(dev, dev->curvol);
164 	dev->muted = 0;
165 }
166 
167 static int typhoon_setvol(struct typhoon_device *dev, int vol)
168 {
169 	if (dev->muted && vol != 0) {	/* user is unmuting the card */
170 		dev->curvol = vol;
171 		typhoon_unmute(dev);
172 		return 0;
173 	}
174 	if (vol == dev->curvol)		/* requested volume == current */
175 		return 0;
176 
177 	if (vol == 0) {			/* volume == 0 means mute the card */
178 		typhoon_mute(dev);
179 		dev->curvol = vol;
180 		return 0;
181 	}
182 	typhoon_setvol_generic(dev, vol);
183 	dev->curvol = vol;
184 	return 0;
185 }
186 
187 static int vidioc_querycap(struct file *file, void  *priv,
188 					struct v4l2_capability *v)
189 {
190 	strlcpy(v->driver, "radio-typhoon", sizeof(v->driver));
191 	strlcpy(v->card, "Typhoon Radio", sizeof(v->card));
192 	sprintf(v->bus_info, "ISA");
193 	v->version = RADIO_VERSION;
194 	v->capabilities = V4L2_CAP_TUNER;
195 	return 0;
196 }
197 
198 static int vidioc_g_tuner(struct file *file, void *priv,
199 					struct v4l2_tuner *v)
200 {
201 	if (v->index > 0)
202 		return -EINVAL;
203 
204 	strcpy(v->name, "FM");
205 	v->type = V4L2_TUNER_RADIO;
206 	v->rangelow = (87.5*16000);
207 	v->rangehigh = (108*16000);
208 	v->rxsubchans = V4L2_TUNER_SUB_MONO;
209 	v->capability = V4L2_TUNER_CAP_LOW;
210 	v->audmode = V4L2_TUNER_MODE_MONO;
211 	v->signal = 0xFFFF;     /* We can't get the signal strength */
212 	return 0;
213 }
214 
215 static int vidioc_s_tuner(struct file *file, void *priv,
216 					struct v4l2_tuner *v)
217 {
218 	if (v->index > 0)
219 		return -EINVAL;
220 
221 	return 0;
222 }
223 
224 static int vidioc_s_frequency(struct file *file, void *priv,
225 					struct v4l2_frequency *f)
226 {
227 	struct video_device *dev = video_devdata(file);
228 	struct typhoon_device *typhoon = dev->priv;
229 
230 	typhoon->curfreq = f->frequency;
231 	typhoon_setfreq(typhoon, typhoon->curfreq);
232 	return 0;
233 }
234 
235 static int vidioc_g_frequency(struct file *file, void *priv,
236 					struct v4l2_frequency *f)
237 {
238 	struct video_device *dev = video_devdata(file);
239 	struct typhoon_device *typhoon = dev->priv;
240 
241 	f->type = V4L2_TUNER_RADIO;
242 	f->frequency = typhoon->curfreq;
243 
244 	return 0;
245 }
246 
247 static int vidioc_queryctrl(struct file *file, void *priv,
248 					struct v4l2_queryctrl *qc)
249 {
250 	int i;
251 
252 	for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
253 		if (qc->id && qc->id == radio_qctrl[i].id) {
254 			memcpy(qc, &(radio_qctrl[i]),
255 						sizeof(*qc));
256 			return 0;
257 		}
258 	}
259 	return -EINVAL;
260 }
261 
262 static int vidioc_g_ctrl(struct file *file, void *priv,
263 					struct v4l2_control *ctrl)
264 {
265 	struct video_device *dev = video_devdata(file);
266 	struct typhoon_device *typhoon = dev->priv;
267 
268 	switch (ctrl->id) {
269 	case V4L2_CID_AUDIO_MUTE:
270 		ctrl->value = typhoon->muted;
271 		return 0;
272 	case V4L2_CID_AUDIO_VOLUME:
273 		ctrl->value = typhoon->curvol;
274 		return 0;
275 	}
276 	return -EINVAL;
277 }
278 
279 static int vidioc_s_ctrl (struct file *file, void *priv,
280 					struct v4l2_control *ctrl)
281 {
282 	struct video_device *dev = video_devdata(file);
283 	struct typhoon_device *typhoon = dev->priv;
284 
285 	switch (ctrl->id) {
286 	case V4L2_CID_AUDIO_MUTE:
287 		if (ctrl->value)
288 			typhoon_mute(typhoon);
289 		else
290 			typhoon_unmute(typhoon);
291 		return 0;
292 	case V4L2_CID_AUDIO_VOLUME:
293 		typhoon_setvol(typhoon, ctrl->value);
294 		return 0;
295 	}
296 	return -EINVAL;
297 }
298 
299 static int vidioc_g_audio(struct file *file, void *priv,
300 					struct v4l2_audio *a)
301 {
302 	if (a->index > 1)
303 		return -EINVAL;
304 
305 	strcpy(a->name, "Radio");
306 	a->capability = V4L2_AUDCAP_STEREO;
307 	return 0;
308 }
309 
310 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
311 {
312 	*i = 0;
313 	return 0;
314 }
315 
316 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
317 {
318 	if (i != 0)
319 		return -EINVAL;
320 	return 0;
321 }
322 
323 static int vidioc_s_audio(struct file *file, void *priv,
324 					struct v4l2_audio *a)
325 {
326 	if (a->index != 0)
327 		return -EINVAL;
328 	return 0;
329 }
330 
331 static struct typhoon_device typhoon_unit =
332 {
333 	.iobase		= CONFIG_RADIO_TYPHOON_PORT,
334 	.curfreq	= CONFIG_RADIO_TYPHOON_MUTEFREQ,
335 	.mutefreq	= CONFIG_RADIO_TYPHOON_MUTEFREQ,
336 };
337 
338 static const struct file_operations typhoon_fops = {
339 	.owner		= THIS_MODULE,
340 	.open           = video_exclusive_open,
341 	.release        = video_exclusive_release,
342 	.ioctl		= video_ioctl2,
343 	.compat_ioctl	= v4l_compat_ioctl32,
344 	.llseek         = no_llseek,
345 };
346 
347 static struct video_device typhoon_radio =
348 {
349 	.owner		= THIS_MODULE,
350 	.name		= "Typhoon Radio",
351 	.type		= VID_TYPE_TUNER,
352 	.fops           = &typhoon_fops,
353 	.vidioc_querycap    = vidioc_querycap,
354 	.vidioc_g_tuner     = vidioc_g_tuner,
355 	.vidioc_s_tuner     = vidioc_s_tuner,
356 	.vidioc_g_audio     = vidioc_g_audio,
357 	.vidioc_s_audio     = vidioc_s_audio,
358 	.vidioc_g_input     = vidioc_g_input,
359 	.vidioc_s_input     = vidioc_s_input,
360 	.vidioc_g_frequency = vidioc_g_frequency,
361 	.vidioc_s_frequency = vidioc_s_frequency,
362 	.vidioc_queryctrl   = vidioc_queryctrl,
363 	.vidioc_g_ctrl      = vidioc_g_ctrl,
364 	.vidioc_s_ctrl      = vidioc_s_ctrl,
365 };
366 
367 #ifdef CONFIG_RADIO_TYPHOON_PROC_FS
368 
369 static int typhoon_get_info(char *buf, char **start, off_t offset, int len)
370 {
371 	char *out = buf;
372 
373 	#ifdef MODULE
374 	    #define MODULEPROCSTRING "Driver loaded as a module"
375 	#else
376 	    #define MODULEPROCSTRING "Driver compiled into kernel"
377 	#endif
378 
379 	/* output must be kept under PAGE_SIZE */
380 	out += sprintf(out, BANNER);
381 	out += sprintf(out, "Load type: " MODULEPROCSTRING "\n\n");
382 	out += sprintf(out, "frequency = %lu kHz\n",
383 		typhoon_unit.curfreq >> 4);
384 	out += sprintf(out, "volume = %d\n", typhoon_unit.curvol);
385 	out += sprintf(out, "mute = %s\n", typhoon_unit.muted ?
386 		"on" : "off");
387 	out += sprintf(out, "iobase = 0x%x\n", typhoon_unit.iobase);
388 	out += sprintf(out, "mute frequency = %lu kHz\n",
389 		typhoon_unit.mutefreq >> 4);
390 	return out - buf;
391 }
392 
393 #endif /* CONFIG_RADIO_TYPHOON_PROC_FS */
394 
395 MODULE_AUTHOR("Dr. Henrik Seidel");
396 MODULE_DESCRIPTION("A driver for the Typhoon radio card (a.k.a. EcoRadio).");
397 MODULE_LICENSE("GPL");
398 
399 static int io = -1;
400 static int radio_nr = -1;
401 
402 module_param(io, int, 0);
403 MODULE_PARM_DESC(io, "I/O address of the Typhoon card (0x316 or 0x336)");
404 module_param(radio_nr, int, 0);
405 
406 #ifdef MODULE
407 static unsigned long mutefreq = 0;
408 module_param(mutefreq, ulong, 0);
409 MODULE_PARM_DESC(mutefreq, "Frequency used when muting the card (in kHz)");
410 #endif
411 
412 static int __init typhoon_init(void)
413 {
414 #ifdef MODULE
415 	if (io == -1) {
416 		printk(KERN_ERR "radio-typhoon: You must set an I/O address with io=0x316 or io=0x336\n");
417 		return -EINVAL;
418 	}
419 	typhoon_unit.iobase = io;
420 
421 	if (mutefreq < 87000 || mutefreq > 108500) {
422 		printk(KERN_ERR "radio-typhoon: You must set a frequency (in kHz) used when muting the card,\n");
423 		printk(KERN_ERR "radio-typhoon: e.g. with \"mutefreq=87500\" (87000 <= mutefreq <= 108500)\n");
424 		return -EINVAL;
425 	}
426 	typhoon_unit.mutefreq = mutefreq;
427 #endif /* MODULE */
428 
429 	printk(KERN_INFO BANNER);
430 	mutex_init(&typhoon_unit.lock);
431 	io = typhoon_unit.iobase;
432 	if (!request_region(io, 8, "typhoon")) {
433 		printk(KERN_ERR "radio-typhoon: port 0x%x already in use\n",
434 		       typhoon_unit.iobase);
435 		return -EBUSY;
436 	}
437 
438 	typhoon_radio.priv = &typhoon_unit;
439 	if (video_register_device(&typhoon_radio, VFL_TYPE_RADIO, radio_nr) == -1)
440 	{
441 		release_region(io, 8);
442 		return -EINVAL;
443 	}
444 	printk(KERN_INFO "radio-typhoon: port 0x%x.\n", typhoon_unit.iobase);
445 	printk(KERN_INFO "radio-typhoon: mute frequency is %lu kHz.\n",
446 	       typhoon_unit.mutefreq);
447 	typhoon_unit.mutefreq <<= 4;
448 
449 	/* mute card - prevents noisy bootups */
450 	typhoon_mute(&typhoon_unit);
451 
452 #ifdef CONFIG_RADIO_TYPHOON_PROC_FS
453 	if (!create_proc_info_entry("driver/radio-typhoon", 0, NULL,
454 				    typhoon_get_info))
455 		printk(KERN_ERR "radio-typhoon: registering /proc/driver/radio-typhoon failed\n");
456 #endif
457 
458 	return 0;
459 }
460 
461 static void __exit typhoon_cleanup_module(void)
462 {
463 
464 #ifdef CONFIG_RADIO_TYPHOON_PROC_FS
465 	remove_proc_entry("driver/radio-typhoon", NULL);
466 #endif
467 
468 	video_unregister_device(&typhoon_radio);
469 	release_region(io, 8);
470 }
471 
472 module_init(typhoon_init);
473 module_exit(typhoon_cleanup_module);
474 
475