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