Linux 4.16.11
[linux/fpc-iii.git] / drivers / media / radio / radio-cadet.c
blob5b82e63885cdd845a744451b0f2ed8f16056c0e2
1 /* radio-cadet.c - A video4linux driver for the ADS Cadet AM/FM Radio Card
3 * by Fred Gleason <fredg@wava.com>
4 * Version 0.3.3
6 * (Loosely) based on code for the Aztech radio card by
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)
15 * History:
16 * 2000-04-29 Russell Kroll <rkroll@exploits.org>
17 * Added ISAPnP detection for Linux 2.3/2.4
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)
23 * 2002-01-17 Adam Belay <ambx1@neo.rr.com>
24 * Updated to latest pnp code
26 * 2003-01-31 Alan Cox <alan@lxorguk.ukuu.org.uk>
27 * Cleaned up locking, delay code, general odds and ends
29 * 2006-07-30 Hans J. Koch <koch@hjk-az.de>
30 * Changed API to V4L2
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>
48 MODULE_AUTHOR("Fred Gleason, Russell Kroll, Quay Lu, Donald Song, Jason Lewis, Scott McGrath, William McGrath");
49 MODULE_DESCRIPTION("A driver for the ADS Cadet AM/FM/RDS radio card.");
50 MODULE_LICENSE("GPL");
51 MODULE_VERSION("0.3.4");
53 static int io = -1; /* default to isapnp activation */
54 static int radio_nr = -1;
56 module_param(io, int, 0);
57 MODULE_PARM_DESC(io, "I/O address of Cadet card (0x330,0x332,0x334,0x336,0x338,0x33a,0x33c,0x33e)");
58 module_param(radio_nr, int, 0);
60 #define RDS_BUFFER 256
61 #define RDS_RX_FLAG 1
62 #define MBS_RX_FLAG 2
64 struct 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;
81 static struct cadet cadet_card;
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.
88 static u16 sigtable[2][4] = {
89 { 1835, 2621, 4128, 65535 },
90 { 2185, 4369, 13107, 65535 },
93 static const struct v4l2_frequency_band bands[] = {
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,
114 static int cadet_getstereo(struct cadet *dev)
116 int ret = V4L2_TUNER_SUB_MONO;
118 if (!dev->is_fm_band) /* Only FM has stereo capability! */
119 return V4L2_TUNER_SUB_MONO;
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;
127 static unsigned cadet_gettune(struct cadet *dev)
129 int curvol, i;
130 unsigned fifo = 0;
133 * Prepare for read
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;
142 * Read the shift register
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);
154 * Restore volume/mute setting
156 outb(curvol, dev->io + 1);
157 return fifo;
160 static unsigned cadet_getfreq(struct cadet *dev)
162 int i;
163 unsigned freq = 0, test, fifo = 0;
166 * Read current tuning
168 fifo = cadet_gettune(dev);
171 * Convert to actual frequency
173 if (!dev->is_fm_band) /* AM */
174 return ((fifo & 0x7fff) - 450) * 16;
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;
183 freq -= 10700000; /* IF frequency is 10.7 MHz */
184 freq = (freq * 16) / 1000; /* Make it 1/16 kHz */
185 return freq;
188 static void cadet_settune(struct cadet *dev, unsigned fifo)
190 int i;
191 unsigned test;
193 outb(7, dev->io); /* Select tuner control */
195 * Write the shift register
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);
213 static void cadet_setfreq(struct cadet *dev, unsigned freq)
215 unsigned fifo;
216 int i, j, test;
217 int curvol;
219 freq = clamp(freq, bands[dev->is_fm_band].rangelow,
220 bands[dev->is_fm_band].rangehigh);
221 dev->curfreq = freq;
223 * Formulate a fifo command
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;
236 test = test >> 1;
238 } else { /* AM */
239 fifo = (freq / 16) + 450; /* Make it kHz */
240 fifo |= 0x100000; /* Select AM Band */
244 * Save current volume/mute setting
247 outb(7, dev->io); /* Select tuner control */
248 curvol = inb(dev->io + 1);
251 * Tune the card
253 for (j = 3; j > -1; j--) {
254 cadet_settune(dev, fifo | (j << 16));
256 outb(7, dev->io); /* Select tuner control */
257 outb(curvol, dev->io + 1);
259 msleep(100);
261 cadet_gettune(dev);
262 if ((dev->tunestat & 0x40) == 0) { /* Tuned */
263 dev->sigstrength = sigtable[dev->is_fm_band][j];
264 goto reset_rds;
267 dev->sigstrength = 0;
268 reset_rds:
269 outb(3, dev->io);
270 outb(inb(dev->io + 1) & 0x7f, dev->io + 1);
273 static bool cadet_has_rds_data(struct cadet *dev)
275 bool result;
277 mutex_lock(&dev->lock);
278 result = dev->rdsin != dev->rdsout;
279 mutex_unlock(&dev->lock);
280 return result;
284 static void cadet_handler(struct timer_list *t)
286 struct cadet *dev = from_timer(dev, t, readtimer);
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 */
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++;
300 mutex_unlock(&dev->lock);
304 * Service pending read
306 if (cadet_has_rds_data(dev))
307 wake_up_interruptible(&dev->read_queue);
310 * Clean up and exit
312 dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
313 add_timer(&dev->readtimer);
316 static void cadet_start_rds(struct cadet *dev)
318 dev->rdsstat = 1;
319 outb(0x80, dev->io); /* Select RDS fifo */
320 timer_setup(&dev->readtimer, cadet_handler, 0);
321 dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
322 add_timer(&dev->readtimer);
325 static ssize_t cadet_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
327 struct cadet *dev = video_drvdata(file);
328 unsigned char readbuf[RDS_BUFFER];
329 int i = 0;
331 mutex_lock(&dev->lock);
332 if (dev->rdsstat == 0)
333 cadet_start_rds(dev);
334 mutex_unlock(&dev->lock);
336 if (!cadet_has_rds_data(dev) && (file->f_flags & O_NONBLOCK))
337 return -EWOULDBLOCK;
338 i = wait_event_interruptible(dev->read_queue, cadet_has_rds_data(dev));
339 if (i)
340 return i;
342 mutex_lock(&dev->lock);
343 while (i < count && dev->rdsin != dev->rdsout)
344 readbuf[i++] = dev->rdsbuf[dev->rdsout++];
345 mutex_unlock(&dev->lock);
347 if (i && copy_to_user(data, readbuf, i))
348 return -EFAULT;
349 return i;
353 static int vidioc_querycap(struct file *file, void *priv,
354 struct v4l2_capability *v)
356 strlcpy(v->driver, "ADS Cadet", sizeof(v->driver));
357 strlcpy(v->card, "ADS Cadet", sizeof(v->card));
358 strlcpy(v->bus_info, "ISA:radio-cadet", sizeof(v->bus_info));
359 v->device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO |
360 V4L2_CAP_READWRITE | V4L2_CAP_RDS_CAPTURE;
361 v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
362 return 0;
365 static int vidioc_g_tuner(struct file *file, void *priv,
366 struct v4l2_tuner *v)
368 struct cadet *dev = video_drvdata(file);
370 if (v->index)
371 return -EINVAL;
372 v->type = V4L2_TUNER_RADIO;
373 strlcpy(v->name, "Radio", sizeof(v->name));
374 v->capability = bands[0].capability | bands[1].capability;
375 v->rangelow = bands[0].rangelow; /* 520 kHz (start of AM band) */
376 v->rangehigh = bands[1].rangehigh; /* 108.0 MHz (end of FM band) */
377 if (dev->is_fm_band) {
378 v->rxsubchans = cadet_getstereo(dev);
379 outb(3, dev->io);
380 outb(inb(dev->io + 1) & 0x7f, dev->io + 1);
381 mdelay(100);
382 outb(3, dev->io);
383 if (inb(dev->io + 1) & 0x80)
384 v->rxsubchans |= V4L2_TUNER_SUB_RDS;
385 } else {
386 v->rangelow = 8320; /* 520 kHz */
387 v->rangehigh = 26400; /* 1650 kHz */
388 v->rxsubchans = V4L2_TUNER_SUB_MONO;
390 v->audmode = V4L2_TUNER_MODE_STEREO;
391 v->signal = dev->sigstrength; /* We might need to modify scaling of this */
392 return 0;
395 static int vidioc_s_tuner(struct file *file, void *priv,
396 const struct v4l2_tuner *v)
398 return v->index ? -EINVAL : 0;
401 static int vidioc_enum_freq_bands(struct file *file, void *priv,
402 struct v4l2_frequency_band *band)
404 if (band->tuner)
405 return -EINVAL;
406 if (band->index >= ARRAY_SIZE(bands))
407 return -EINVAL;
408 *band = bands[band->index];
409 return 0;
412 static int vidioc_g_frequency(struct file *file, void *priv,
413 struct v4l2_frequency *f)
415 struct cadet *dev = video_drvdata(file);
417 if (f->tuner)
418 return -EINVAL;
419 f->type = V4L2_TUNER_RADIO;
420 f->frequency = dev->curfreq;
421 return 0;
425 static int vidioc_s_frequency(struct file *file, void *priv,
426 const struct v4l2_frequency *f)
428 struct cadet *dev = video_drvdata(file);
430 if (f->tuner)
431 return -EINVAL;
432 dev->is_fm_band =
433 f->frequency >= (bands[0].rangehigh + bands[1].rangelow) / 2;
434 cadet_setfreq(dev, f->frequency);
435 return 0;
438 static int cadet_s_ctrl(struct v4l2_ctrl *ctrl)
440 struct cadet *dev = container_of(ctrl->handler, struct cadet, ctrl_handler);
442 switch (ctrl->id) {
443 case V4L2_CID_AUDIO_MUTE:
444 outb(7, dev->io); /* Select tuner control */
445 if (ctrl->val)
446 outb(0x00, dev->io + 1);
447 else
448 outb(0x20, dev->io + 1);
449 return 0;
451 return -EINVAL;
454 static int cadet_open(struct file *file)
456 struct cadet *dev = video_drvdata(file);
457 int err;
459 mutex_lock(&dev->lock);
460 err = v4l2_fh_open(file);
461 if (err)
462 goto fail;
463 if (v4l2_fh_is_singular_file(file))
464 init_waitqueue_head(&dev->read_queue);
465 fail:
466 mutex_unlock(&dev->lock);
467 return err;
470 static int cadet_release(struct file *file)
472 struct cadet *dev = video_drvdata(file);
474 mutex_lock(&dev->lock);
475 if (v4l2_fh_is_singular_file(file) && dev->rdsstat) {
476 del_timer_sync(&dev->readtimer);
477 dev->rdsstat = 0;
479 v4l2_fh_release(file);
480 mutex_unlock(&dev->lock);
481 return 0;
484 static __poll_t cadet_poll(struct file *file, struct poll_table_struct *wait)
486 struct cadet *dev = video_drvdata(file);
487 __poll_t req_events = poll_requested_events(wait);
488 __poll_t res = v4l2_ctrl_poll(file, wait);
490 poll_wait(file, &dev->read_queue, wait);
491 if (dev->rdsstat == 0 && (req_events & (EPOLLIN | EPOLLRDNORM))) {
492 mutex_lock(&dev->lock);
493 if (dev->rdsstat == 0)
494 cadet_start_rds(dev);
495 mutex_unlock(&dev->lock);
497 if (cadet_has_rds_data(dev))
498 res |= EPOLLIN | EPOLLRDNORM;
499 return res;
503 static const struct v4l2_file_operations cadet_fops = {
504 .owner = THIS_MODULE,
505 .open = cadet_open,
506 .release = cadet_release,
507 .read = cadet_read,
508 .unlocked_ioctl = video_ioctl2,
509 .poll = cadet_poll,
512 static const struct v4l2_ioctl_ops cadet_ioctl_ops = {
513 .vidioc_querycap = vidioc_querycap,
514 .vidioc_g_tuner = vidioc_g_tuner,
515 .vidioc_s_tuner = vidioc_s_tuner,
516 .vidioc_g_frequency = vidioc_g_frequency,
517 .vidioc_s_frequency = vidioc_s_frequency,
518 .vidioc_enum_freq_bands = vidioc_enum_freq_bands,
519 .vidioc_log_status = v4l2_ctrl_log_status,
520 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
521 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
524 static const struct v4l2_ctrl_ops cadet_ctrl_ops = {
525 .s_ctrl = cadet_s_ctrl,
528 #ifdef CONFIG_PNP
530 static const struct pnp_device_id cadet_pnp_devices[] = {
531 /* ADS Cadet AM/FM Radio Card */
532 {.id = "MSM0c24", .driver_data = 0},
533 {.id = ""}
536 MODULE_DEVICE_TABLE(pnp, cadet_pnp_devices);
538 static int cadet_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
540 if (!dev)
541 return -ENODEV;
542 /* only support one device */
543 if (io > 0)
544 return -EBUSY;
546 if (!pnp_port_valid(dev, 0))
547 return -ENODEV;
549 io = pnp_port_start(dev, 0);
551 printk(KERN_INFO "radio-cadet: PnP reports device at %#x\n", io);
553 return io;
556 static struct pnp_driver cadet_pnp_driver = {
557 .name = "radio-cadet",
558 .id_table = cadet_pnp_devices,
559 .probe = cadet_pnp_probe,
560 .remove = NULL,
563 #else
564 static struct pnp_driver cadet_pnp_driver;
565 #endif
567 static void cadet_probe(struct cadet *dev)
569 static int iovals[8] = { 0x330, 0x332, 0x334, 0x336, 0x338, 0x33a, 0x33c, 0x33e };
570 int i;
572 for (i = 0; i < 8; i++) {
573 dev->io = iovals[i];
574 if (request_region(dev->io, 2, "cadet-probe")) {
575 cadet_setfreq(dev, bands[1].rangelow);
576 if (cadet_getfreq(dev) == bands[1].rangelow) {
577 release_region(dev->io, 2);
578 return;
580 release_region(dev->io, 2);
583 dev->io = -1;
587 * io should only be set if the user has used something like
588 * isapnp (the userspace program) to initialize this card for us
591 static int __init cadet_init(void)
593 struct cadet *dev = &cadet_card;
594 struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
595 struct v4l2_ctrl_handler *hdl;
596 int res = -ENODEV;
598 strlcpy(v4l2_dev->name, "cadet", sizeof(v4l2_dev->name));
599 mutex_init(&dev->lock);
601 /* If a probe was requested then probe ISAPnP first (safest) */
602 if (io < 0)
603 pnp_register_driver(&cadet_pnp_driver);
604 dev->io = io;
606 /* If that fails then probe unsafely if probe is requested */
607 if (dev->io < 0)
608 cadet_probe(dev);
610 /* Else we bail out */
611 if (dev->io < 0) {
612 #ifdef MODULE
613 v4l2_err(v4l2_dev, "you must set an I/O address with io=0x330, 0x332, 0x334,\n");
614 v4l2_err(v4l2_dev, "0x336, 0x338, 0x33a, 0x33c or 0x33e\n");
615 #endif
616 goto fail;
618 if (!request_region(dev->io, 2, "cadet"))
619 goto fail;
621 res = v4l2_device_register(NULL, v4l2_dev);
622 if (res < 0) {
623 release_region(dev->io, 2);
624 v4l2_err(v4l2_dev, "could not register v4l2_device\n");
625 goto fail;
628 hdl = &dev->ctrl_handler;
629 v4l2_ctrl_handler_init(hdl, 2);
630 v4l2_ctrl_new_std(hdl, &cadet_ctrl_ops,
631 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
632 v4l2_dev->ctrl_handler = hdl;
633 if (hdl->error) {
634 res = hdl->error;
635 v4l2_err(v4l2_dev, "Could not register controls\n");
636 goto err_hdl;
639 dev->is_fm_band = true;
640 dev->curfreq = bands[dev->is_fm_band].rangelow;
641 cadet_setfreq(dev, dev->curfreq);
642 strlcpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
643 dev->vdev.v4l2_dev = v4l2_dev;
644 dev->vdev.fops = &cadet_fops;
645 dev->vdev.ioctl_ops = &cadet_ioctl_ops;
646 dev->vdev.release = video_device_release_empty;
647 dev->vdev.lock = &dev->lock;
648 video_set_drvdata(&dev->vdev, dev);
650 res = video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr);
651 if (res < 0)
652 goto err_hdl;
653 v4l2_info(v4l2_dev, "ADS Cadet Radio Card at 0x%x\n", dev->io);
654 return 0;
655 err_hdl:
656 v4l2_ctrl_handler_free(hdl);
657 v4l2_device_unregister(v4l2_dev);
658 release_region(dev->io, 2);
659 fail:
660 pnp_unregister_driver(&cadet_pnp_driver);
661 return res;
664 static void __exit cadet_exit(void)
666 struct cadet *dev = &cadet_card;
668 video_unregister_device(&dev->vdev);
669 v4l2_ctrl_handler_free(&dev->ctrl_handler);
670 v4l2_device_unregister(&dev->v4l2_dev);
671 outb(7, dev->io); /* Mute */
672 outb(0x00, dev->io + 1);
673 release_region(dev->io, 2);
674 pnp_unregister_driver(&cadet_pnp_driver);
677 module_init(cadet_init);
678 module_exit(cadet_exit);