1/* radio-cadet.c - A video4linux driver for the ADS Cadet AM/FM Radio Card
2 *
3 * by Fred Gleason <fredg@wava.com>
4 * Version 0.3.3
5 *
6 * (Loosely) based on code for the Aztech radio card by
7 *
8 * Russell Kroll    (rkroll@exploits.org)
9 * Quay Ly
10 * Donald Song
11 * Jason Lewis      (jlewis@twilight.vtc.vsc.edu)
12 * Scott McGrath    (smcgrath@twilight.vtc.vsc.edu)
13 * William McGrath  (wmcgrath@twilight.vtc.vsc.edu)
14 *
15 * History:
16 * 2000-04-29	Russell Kroll <rkroll@exploits.org>
17 *		Added ISAPnP detection for Linux 2.3/2.4
18 *
19 * 2001-01-10	Russell Kroll <rkroll@exploits.org>
20 *		Removed dead CONFIG_RADIO_CADET_PORT code
21 *		PnP detection on load is now default (no args necessary)
22 *
23 * 2002-01-17	Adam Belay <ambx1@neo.rr.com>
24 *		Updated to latest pnp code
25 *
26 * 2003-01-31	Alan Cox <alan@lxorguk.ukuu.org.uk>
27 *		Cleaned up locking, delay code, general odds and ends
28 *
29 * 2006-07-30	Hans J. Koch <koch@hjk-az.de>
30 *		Changed API to V4L2
31 */
32
33#include <linux/module.h>	/* Modules 			*/
34#include <linux/init.h>		/* Initdata			*/
35#include <linux/ioport.h>	/* request_region		*/
36#include <linux/delay.h>	/* udelay			*/
37#include <linux/videodev2.h>	/* V4L2 API defs		*/
38#include <linux/param.h>
39#include <linux/pnp.h>
40#include <linux/sched.h>
41#include <linux/io.h>		/* outb, outb_p			*/
42#include <media/v4l2-device.h>
43#include <media/v4l2-ioctl.h>
44#include <media/v4l2-ctrls.h>
45#include <media/v4l2-fh.h>
46#include <media/v4l2-event.h>
47
48MODULE_AUTHOR("Fred Gleason, Russell Kroll, Quay Lu, Donald Song, Jason Lewis, Scott McGrath, William McGrath");
49MODULE_DESCRIPTION("A driver for the ADS Cadet AM/FM/RDS radio card.");
50MODULE_LICENSE("GPL");
51MODULE_VERSION("0.3.4");
52
53static int io = -1;		/* default to isapnp activation */
54static int radio_nr = -1;
55
56module_param(io, int, 0);
57MODULE_PARM_DESC(io, "I/O address of Cadet card (0x330,0x332,0x334,0x336,0x338,0x33a,0x33c,0x33e)");
58module_param(radio_nr, int, 0);
59
60#define RDS_BUFFER 256
61#define RDS_RX_FLAG 1
62#define MBS_RX_FLAG 2
63
64struct cadet {
65	struct v4l2_device v4l2_dev;
66	struct video_device vdev;
67	struct v4l2_ctrl_handler ctrl_handler;
68	int io;
69	bool is_fm_band;
70	u32 curfreq;
71	int tunestat;
72	int sigstrength;
73	wait_queue_head_t read_queue;
74	struct timer_list readtimer;
75	u8 rdsin, rdsout, rdsstat;
76	unsigned char rdsbuf[RDS_BUFFER];
77	struct mutex lock;
78	int reading;
79};
80
81static struct cadet cadet_card;
82
83/*
84 * Signal Strength Threshold Values
85 * The V4L API spec does not define any particular unit for the signal
86 * strength value.  These values are in microvolts of RF at the tuner's input.
87 */
88static u16 sigtable[2][4] = {
89	{ 1835, 2621,  4128, 65535 },
90	{ 2185, 4369, 13107, 65535 },
91};
92
93static const struct v4l2_frequency_band bands[] = {
94	{
95		.index = 0,
96		.type = V4L2_TUNER_RADIO,
97		.capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_FREQ_BANDS,
98		.rangelow = 8320,      /* 520 kHz */
99		.rangehigh = 26400,    /* 1650 kHz */
100		.modulation = V4L2_BAND_MODULATION_AM,
101	}, {
102		.index = 1,
103		.type = V4L2_TUNER_RADIO,
104		.capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS |
105			V4L2_TUNER_CAP_RDS_BLOCK_IO | V4L2_TUNER_CAP_LOW |
106			V4L2_TUNER_CAP_FREQ_BANDS,
107		.rangelow = 1400000,   /* 87.5 MHz */
108		.rangehigh = 1728000,  /* 108.0 MHz */
109		.modulation = V4L2_BAND_MODULATION_FM,
110	},
111};
112
113
114static int cadet_getstereo(struct cadet *dev)
115{
116	int ret = V4L2_TUNER_SUB_MONO;
117
118	if (!dev->is_fm_band)	/* Only FM has stereo capability! */
119		return V4L2_TUNER_SUB_MONO;
120
121	outb(7, dev->io);          /* Select tuner control */
122	if ((inb(dev->io + 1) & 0x40) == 0)
123		ret = V4L2_TUNER_SUB_STEREO;
124	return ret;
125}
126
127static unsigned cadet_gettune(struct cadet *dev)
128{
129	int curvol, i;
130	unsigned fifo = 0;
131
132	/*
133	 * Prepare for read
134	 */
135
136	outb(7, dev->io);       /* Select tuner control */
137	curvol = inb(dev->io + 1); /* Save current volume/mute setting */
138	outb(0x00, dev->io + 1);  /* Ensure WRITE-ENABLE is LOW */
139	dev->tunestat = 0xffff;
140
141	/*
142	 * Read the shift register
143	 */
144	for (i = 0; i < 25; i++) {
145		fifo = (fifo << 1) | ((inb(dev->io + 1) >> 7) & 0x01);
146		if (i < 24) {
147			outb(0x01, dev->io + 1);
148			dev->tunestat &= inb(dev->io + 1);
149			outb(0x00, dev->io + 1);
150		}
151	}
152
153	/*
154	 * Restore volume/mute setting
155	 */
156	outb(curvol, dev->io + 1);
157	return fifo;
158}
159
160static unsigned cadet_getfreq(struct cadet *dev)
161{
162	int i;
163	unsigned freq = 0, test, fifo = 0;
164
165	/*
166	 * Read current tuning
167	 */
168	fifo = cadet_gettune(dev);
169
170	/*
171	 * Convert to actual frequency
172	 */
173	if (!dev->is_fm_band)    /* AM */
174		return ((fifo & 0x7fff) - 450) * 16;
175
176	test = 12500;
177	for (i = 0; i < 14; i++) {
178		if ((fifo & 0x01) != 0)
179			freq += test;
180		test = test << 1;
181		fifo = fifo >> 1;
182	}
183	freq -= 10700000;           /* IF frequency is 10.7 MHz */
184	freq = (freq * 16) / 1000;   /* Make it 1/16 kHz */
185	return freq;
186}
187
188static void cadet_settune(struct cadet *dev, unsigned fifo)
189{
190	int i;
191	unsigned test;
192
193	outb(7, dev->io);                /* Select tuner control */
194	/*
195	 * Write the shift register
196	 */
197	test = 0;
198	test = (fifo >> 23) & 0x02;      /* Align data for SDO */
199	test |= 0x1c;                /* SDM=1, SWE=1, SEN=1, SCK=0 */
200	outb(7, dev->io);                /* Select tuner control */
201	outb(test, dev->io + 1);           /* Initialize for write */
202	for (i = 0; i < 25; i++) {
203		test |= 0x01;              /* Toggle SCK High */
204		outb(test, dev->io + 1);
205		test &= 0xfe;              /* Toggle SCK Low */
206		outb(test, dev->io + 1);
207		fifo = fifo << 1;            /* Prepare the next bit */
208		test = 0x1c | ((fifo >> 23) & 0x02);
209		outb(test, dev->io + 1);
210	}
211}
212
213static void cadet_setfreq(struct cadet *dev, unsigned freq)
214{
215	unsigned fifo;
216	int i, j, test;
217	int curvol;
218
219	freq = clamp(freq, bands[dev->is_fm_band].rangelow,
220			   bands[dev->is_fm_band].rangehigh);
221	dev->curfreq = freq;
222	/*
223	 * Formulate a fifo command
224	 */
225	fifo = 0;
226	if (dev->is_fm_band) {    /* FM */
227		test = 102400;
228		freq = freq / 16;       /* Make it kHz */
229		freq += 10700;               /* IF is 10700 kHz */
230		for (i = 0; i < 14; i++) {
231			fifo = fifo << 1;
232			if (freq >= test) {
233				fifo |= 0x01;
234				freq -= test;
235			}
236			test = test >> 1;
237		}
238	} else {	/* AM */
239		fifo = (freq / 16) + 450;	/* Make it kHz */
240		fifo |= 0x100000;		/* Select AM Band */
241	}
242
243	/*
244	 * Save current volume/mute setting
245	 */
246
247	outb(7, dev->io);                /* Select tuner control */
248	curvol = inb(dev->io + 1);
249
250	/*
251	 * Tune the card
252	 */
253	for (j = 3; j > -1; j--) {
254		cadet_settune(dev, fifo | (j << 16));
255
256		outb(7, dev->io);         /* Select tuner control */
257		outb(curvol, dev->io + 1);
258
259		msleep(100);
260
261		cadet_gettune(dev);
262		if ((dev->tunestat & 0x40) == 0) {   /* Tuned */
263			dev->sigstrength = sigtable[dev->is_fm_band][j];
264			goto reset_rds;
265		}
266	}
267	dev->sigstrength = 0;
268reset_rds:
269	outb(3, dev->io);
270	outb(inb(dev->io + 1) & 0x7f, dev->io + 1);
271}
272
273static bool cadet_has_rds_data(struct cadet *dev)
274{
275	bool result;
276
277	mutex_lock(&dev->lock);
278	result = dev->rdsin != dev->rdsout;
279	mutex_unlock(&dev->lock);
280	return result;
281}
282
283
284static void cadet_handler(unsigned long data)
285{
286	struct cadet *dev = (void *)data;
287
288	/* Service the RDS fifo */
289	if (mutex_trylock(&dev->lock)) {
290		outb(0x3, dev->io);       /* Select RDS Decoder Control */
291		if ((inb(dev->io + 1) & 0x20) != 0)
292			pr_err("cadet: RDS fifo overflow\n");
293		outb(0x80, dev->io);      /* Select RDS fifo */
294
295		while ((inb(dev->io) & 0x80) != 0) {
296			dev->rdsbuf[dev->rdsin] = inb(dev->io + 1);
297			if (dev->rdsin + 1 != dev->rdsout)
298				dev->rdsin++;
299		}
300		mutex_unlock(&dev->lock);
301	}
302
303	/*
304	 * Service pending read
305	 */
306	if (cadet_has_rds_data(dev))
307		wake_up_interruptible(&dev->read_queue);
308
309	/*
310	 * Clean up and exit
311	 */
312	init_timer(&dev->readtimer);
313	dev->readtimer.function = cadet_handler;
314	dev->readtimer.data = data;
315	dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
316	add_timer(&dev->readtimer);
317}
318
319static void cadet_start_rds(struct cadet *dev)
320{
321	dev->rdsstat = 1;
322	outb(0x80, dev->io);        /* Select RDS fifo */
323	init_timer(&dev->readtimer);
324	dev->readtimer.function = cadet_handler;
325	dev->readtimer.data = (unsigned long)dev;
326	dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
327	add_timer(&dev->readtimer);
328}
329
330static ssize_t cadet_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
331{
332	struct cadet *dev = video_drvdata(file);
333	unsigned char readbuf[RDS_BUFFER];
334	int i = 0;
335
336	mutex_lock(&dev->lock);
337	if (dev->rdsstat == 0)
338		cadet_start_rds(dev);
339	mutex_unlock(&dev->lock);
340
341	if (!cadet_has_rds_data(dev) && (file->f_flags & O_NONBLOCK))
342		return -EWOULDBLOCK;
343	i = wait_event_interruptible(dev->read_queue, cadet_has_rds_data(dev));
344	if (i)
345		return i;
346
347	mutex_lock(&dev->lock);
348	while (i < count && dev->rdsin != dev->rdsout)
349		readbuf[i++] = dev->rdsbuf[dev->rdsout++];
350	mutex_unlock(&dev->lock);
351
352	if (i && copy_to_user(data, readbuf, i))
353		return -EFAULT;
354	return i;
355}
356
357
358static int vidioc_querycap(struct file *file, void *priv,
359				struct v4l2_capability *v)
360{
361	strlcpy(v->driver, "ADS Cadet", sizeof(v->driver));
362	strlcpy(v->card, "ADS Cadet", sizeof(v->card));
363	strlcpy(v->bus_info, "ISA:radio-cadet", sizeof(v->bus_info));
364	v->device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO |
365			  V4L2_CAP_READWRITE | V4L2_CAP_RDS_CAPTURE;
366	v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
367	return 0;
368}
369
370static int vidioc_g_tuner(struct file *file, void *priv,
371				struct v4l2_tuner *v)
372{
373	struct cadet *dev = video_drvdata(file);
374
375	if (v->index)
376		return -EINVAL;
377	v->type = V4L2_TUNER_RADIO;
378	strlcpy(v->name, "Radio", sizeof(v->name));
379	v->capability = bands[0].capability | bands[1].capability;
380	v->rangelow = bands[0].rangelow;	   /* 520 kHz (start of AM band) */
381	v->rangehigh = bands[1].rangehigh;    /* 108.0 MHz (end of FM band) */
382	if (dev->is_fm_band) {
383		v->rxsubchans = cadet_getstereo(dev);
384		outb(3, dev->io);
385		outb(inb(dev->io + 1) & 0x7f, dev->io + 1);
386		mdelay(100);
387		outb(3, dev->io);
388		if (inb(dev->io + 1) & 0x80)
389			v->rxsubchans |= V4L2_TUNER_SUB_RDS;
390	} else {
391		v->rangelow = 8320;      /* 520 kHz */
392		v->rangehigh = 26400;    /* 1650 kHz */
393		v->rxsubchans = V4L2_TUNER_SUB_MONO;
394	}
395	v->audmode = V4L2_TUNER_MODE_STEREO;
396	v->signal = dev->sigstrength; /* We might need to modify scaling of this */
397	return 0;
398}
399
400static int vidioc_s_tuner(struct file *file, void *priv,
401				const struct v4l2_tuner *v)
402{
403	return v->index ? -EINVAL : 0;
404}
405
406static int vidioc_enum_freq_bands(struct file *file, void *priv,
407				struct v4l2_frequency_band *band)
408{
409	if (band->tuner)
410		return -EINVAL;
411	if (band->index >= ARRAY_SIZE(bands))
412		return -EINVAL;
413	*band = bands[band->index];
414	return 0;
415}
416
417static int vidioc_g_frequency(struct file *file, void *priv,
418				struct v4l2_frequency *f)
419{
420	struct cadet *dev = video_drvdata(file);
421
422	if (f->tuner)
423		return -EINVAL;
424	f->type = V4L2_TUNER_RADIO;
425	f->frequency = dev->curfreq;
426	return 0;
427}
428
429
430static int vidioc_s_frequency(struct file *file, void *priv,
431				const struct v4l2_frequency *f)
432{
433	struct cadet *dev = video_drvdata(file);
434
435	if (f->tuner)
436		return -EINVAL;
437	dev->is_fm_band =
438		f->frequency >= (bands[0].rangehigh + bands[1].rangelow) / 2;
439	cadet_setfreq(dev, f->frequency);
440	return 0;
441}
442
443static int cadet_s_ctrl(struct v4l2_ctrl *ctrl)
444{
445	struct cadet *dev = container_of(ctrl->handler, struct cadet, ctrl_handler);
446
447	switch (ctrl->id) {
448	case V4L2_CID_AUDIO_MUTE:
449		outb(7, dev->io);                /* Select tuner control */
450		if (ctrl->val)
451			outb(0x00, dev->io + 1);
452		else
453			outb(0x20, dev->io + 1);
454		return 0;
455	}
456	return -EINVAL;
457}
458
459static int cadet_open(struct file *file)
460{
461	struct cadet *dev = video_drvdata(file);
462	int err;
463
464	mutex_lock(&dev->lock);
465	err = v4l2_fh_open(file);
466	if (err)
467		goto fail;
468	if (v4l2_fh_is_singular_file(file))
469		init_waitqueue_head(&dev->read_queue);
470fail:
471	mutex_unlock(&dev->lock);
472	return err;
473}
474
475static int cadet_release(struct file *file)
476{
477	struct cadet *dev = video_drvdata(file);
478
479	mutex_lock(&dev->lock);
480	if (v4l2_fh_is_singular_file(file) && dev->rdsstat) {
481		del_timer_sync(&dev->readtimer);
482		dev->rdsstat = 0;
483	}
484	v4l2_fh_release(file);
485	mutex_unlock(&dev->lock);
486	return 0;
487}
488
489static unsigned int cadet_poll(struct file *file, struct poll_table_struct *wait)
490{
491	struct cadet *dev = video_drvdata(file);
492	unsigned long req_events = poll_requested_events(wait);
493	unsigned int res = v4l2_ctrl_poll(file, wait);
494
495	poll_wait(file, &dev->read_queue, wait);
496	if (dev->rdsstat == 0 && (req_events & (POLLIN | POLLRDNORM))) {
497		mutex_lock(&dev->lock);
498		if (dev->rdsstat == 0)
499			cadet_start_rds(dev);
500		mutex_unlock(&dev->lock);
501	}
502	if (cadet_has_rds_data(dev))
503		res |= POLLIN | POLLRDNORM;
504	return res;
505}
506
507
508static const struct v4l2_file_operations cadet_fops = {
509	.owner		= THIS_MODULE,
510	.open		= cadet_open,
511	.release       	= cadet_release,
512	.read		= cadet_read,
513	.unlocked_ioctl	= video_ioctl2,
514	.poll		= cadet_poll,
515};
516
517static const struct v4l2_ioctl_ops cadet_ioctl_ops = {
518	.vidioc_querycap    = vidioc_querycap,
519	.vidioc_g_tuner     = vidioc_g_tuner,
520	.vidioc_s_tuner     = vidioc_s_tuner,
521	.vidioc_g_frequency = vidioc_g_frequency,
522	.vidioc_s_frequency = vidioc_s_frequency,
523	.vidioc_enum_freq_bands = vidioc_enum_freq_bands,
524	.vidioc_log_status  = v4l2_ctrl_log_status,
525	.vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
526	.vidioc_unsubscribe_event = v4l2_event_unsubscribe,
527};
528
529static const struct v4l2_ctrl_ops cadet_ctrl_ops = {
530	.s_ctrl = cadet_s_ctrl,
531};
532
533#ifdef CONFIG_PNP
534
535static struct pnp_device_id cadet_pnp_devices[] = {
536	/* ADS Cadet AM/FM Radio Card */
537	{.id = "MSM0c24", .driver_data = 0},
538	{.id = ""}
539};
540
541MODULE_DEVICE_TABLE(pnp, cadet_pnp_devices);
542
543static int cadet_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
544{
545	if (!dev)
546		return -ENODEV;
547	/* only support one device */
548	if (io > 0)
549		return -EBUSY;
550
551	if (!pnp_port_valid(dev, 0))
552		return -ENODEV;
553
554	io = pnp_port_start(dev, 0);
555
556	printk(KERN_INFO "radio-cadet: PnP reports device at %#x\n", io);
557
558	return io;
559}
560
561static struct pnp_driver cadet_pnp_driver = {
562	.name		= "radio-cadet",
563	.id_table	= cadet_pnp_devices,
564	.probe		= cadet_pnp_probe,
565	.remove		= NULL,
566};
567
568#else
569static struct pnp_driver cadet_pnp_driver;
570#endif
571
572static void cadet_probe(struct cadet *dev)
573{
574	static int iovals[8] = { 0x330, 0x332, 0x334, 0x336, 0x338, 0x33a, 0x33c, 0x33e };
575	int i;
576
577	for (i = 0; i < 8; i++) {
578		dev->io = iovals[i];
579		if (request_region(dev->io, 2, "cadet-probe")) {
580			cadet_setfreq(dev, bands[1].rangelow);
581			if (cadet_getfreq(dev) == bands[1].rangelow) {
582				release_region(dev->io, 2);
583				return;
584			}
585			release_region(dev->io, 2);
586		}
587	}
588	dev->io = -1;
589}
590
591/*
592 * io should only be set if the user has used something like
593 * isapnp (the userspace program) to initialize this card for us
594 */
595
596static int __init cadet_init(void)
597{
598	struct cadet *dev = &cadet_card;
599	struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
600	struct v4l2_ctrl_handler *hdl;
601	int res = -ENODEV;
602
603	strlcpy(v4l2_dev->name, "cadet", sizeof(v4l2_dev->name));
604	mutex_init(&dev->lock);
605
606	/* If a probe was requested then probe ISAPnP first (safest) */
607	if (io < 0)
608		pnp_register_driver(&cadet_pnp_driver);
609	dev->io = io;
610
611	/* If that fails then probe unsafely if probe is requested */
612	if (dev->io < 0)
613		cadet_probe(dev);
614
615	/* Else we bail out */
616	if (dev->io < 0) {
617#ifdef MODULE
618		v4l2_err(v4l2_dev, "you must set an I/O address with io=0x330, 0x332, 0x334,\n");
619		v4l2_err(v4l2_dev, "0x336, 0x338, 0x33a, 0x33c or 0x33e\n");
620#endif
621		goto fail;
622	}
623	if (!request_region(dev->io, 2, "cadet"))
624		goto fail;
625
626	res = v4l2_device_register(NULL, v4l2_dev);
627	if (res < 0) {
628		release_region(dev->io, 2);
629		v4l2_err(v4l2_dev, "could not register v4l2_device\n");
630		goto fail;
631	}
632
633	hdl = &dev->ctrl_handler;
634	v4l2_ctrl_handler_init(hdl, 2);
635	v4l2_ctrl_new_std(hdl, &cadet_ctrl_ops,
636			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
637	v4l2_dev->ctrl_handler = hdl;
638	if (hdl->error) {
639		res = hdl->error;
640		v4l2_err(v4l2_dev, "Could not register controls\n");
641		goto err_hdl;
642	}
643
644	dev->is_fm_band = true;
645	dev->curfreq = bands[dev->is_fm_band].rangelow;
646	cadet_setfreq(dev, dev->curfreq);
647	strlcpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
648	dev->vdev.v4l2_dev = v4l2_dev;
649	dev->vdev.fops = &cadet_fops;
650	dev->vdev.ioctl_ops = &cadet_ioctl_ops;
651	dev->vdev.release = video_device_release_empty;
652	dev->vdev.lock = &dev->lock;
653	video_set_drvdata(&dev->vdev, dev);
654
655	res = video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr);
656	if (res < 0)
657		goto err_hdl;
658	v4l2_info(v4l2_dev, "ADS Cadet Radio Card at 0x%x\n", dev->io);
659	return 0;
660err_hdl:
661	v4l2_ctrl_handler_free(hdl);
662	v4l2_device_unregister(v4l2_dev);
663	release_region(dev->io, 2);
664fail:
665	pnp_unregister_driver(&cadet_pnp_driver);
666	return res;
667}
668
669static void __exit cadet_exit(void)
670{
671	struct cadet *dev = &cadet_card;
672
673	video_unregister_device(&dev->vdev);
674	v4l2_ctrl_handler_free(&dev->ctrl_handler);
675	v4l2_device_unregister(&dev->v4l2_dev);
676	outb(7, dev->io);	/* Mute */
677	outb(0x00, dev->io + 1);
678	release_region(dev->io, 2);
679	pnp_unregister_driver(&cadet_pnp_driver);
680}
681
682module_init(cadet_init);
683module_exit(cadet_exit);
684
685