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