]> Pileus Git - ~andy/linux/blob - drivers/media/radio/radio-cadet.c
[media] radio-cadet: upgrade to latest frameworks
[~andy/linux] / drivers / media / radio / radio-cadet.c
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
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");
52
53 static int io = -1;             /* default to isapnp activation */
54 static int radio_nr = -1;
55
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);
59
60 #define RDS_BUFFER 256
61 #define RDS_RX_FLAG 1
62 #define MBS_RX_FLAG 2
63
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         int curtuner;
70         int tunestat;
71         int sigstrength;
72         wait_queue_head_t read_queue;
73         struct timer_list readtimer;
74         __u8 rdsin, rdsout, rdsstat;
75         unsigned char rdsbuf[RDS_BUFFER];
76         struct mutex lock;
77         int reading;
78 };
79
80 static struct cadet cadet_card;
81
82 /*
83  * Signal Strength Threshold Values
84  * The V4L API spec does not define any particular unit for the signal
85  * strength value.  These values are in microvolts of RF at the tuner's input.
86  */
87 static __u16 sigtable[2][4] = {
88         {  5, 10, 30,  150 },
89         { 28, 40, 63, 1000 }
90 };
91
92
93 static int cadet_getstereo(struct cadet *dev)
94 {
95         int ret = V4L2_TUNER_SUB_MONO;
96
97         if (dev->curtuner != 0) /* Only FM has stereo capability! */
98                 return V4L2_TUNER_SUB_MONO;
99
100         outb(7, dev->io);          /* Select tuner control */
101         if ((inb(dev->io + 1) & 0x40) == 0)
102                 ret = V4L2_TUNER_SUB_STEREO;
103         return ret;
104 }
105
106 static unsigned cadet_gettune(struct cadet *dev)
107 {
108         int curvol, i;
109         unsigned fifo = 0;
110
111         /*
112          * Prepare for read
113          */
114
115         outb(7, dev->io);       /* Select tuner control */
116         curvol = inb(dev->io + 1); /* Save current volume/mute setting */
117         outb(0x00, dev->io + 1);  /* Ensure WRITE-ENABLE is LOW */
118         dev->tunestat = 0xffff;
119
120         /*
121          * Read the shift register
122          */
123         for (i = 0; i < 25; i++) {
124                 fifo = (fifo << 1) | ((inb(dev->io + 1) >> 7) & 0x01);
125                 if (i < 24) {
126                         outb(0x01, dev->io + 1);
127                         dev->tunestat &= inb(dev->io + 1);
128                         outb(0x00, dev->io + 1);
129                 }
130         }
131
132         /*
133          * Restore volume/mute setting
134          */
135         outb(curvol, dev->io + 1);
136         return fifo;
137 }
138
139 static unsigned cadet_getfreq(struct cadet *dev)
140 {
141         int i;
142         unsigned freq = 0, test, fifo = 0;
143
144         /*
145          * Read current tuning
146          */
147         fifo = cadet_gettune(dev);
148
149         /*
150          * Convert to actual frequency
151          */
152         if (dev->curtuner == 0) {    /* FM */
153                 test = 12500;
154                 for (i = 0; i < 14; i++) {
155                         if ((fifo & 0x01) != 0)
156                                 freq += test;
157                         test = test << 1;
158                         fifo = fifo >> 1;
159                 }
160                 freq -= 10700000;           /* IF frequency is 10.7 MHz */
161                 freq = (freq * 16) / 1000;   /* Make it 1/16 kHz */
162         }
163         if (dev->curtuner == 1)    /* AM */
164                 freq = ((fifo & 0x7fff) - 2010) * 16;
165
166         return freq;
167 }
168
169 static void cadet_settune(struct cadet *dev, unsigned fifo)
170 {
171         int i;
172         unsigned test;
173
174         outb(7, dev->io);                /* Select tuner control */
175         /*
176          * Write the shift register
177          */
178         test = 0;
179         test = (fifo >> 23) & 0x02;      /* Align data for SDO */
180         test |= 0x1c;                /* SDM=1, SWE=1, SEN=1, SCK=0 */
181         outb(7, dev->io);                /* Select tuner control */
182         outb(test, dev->io + 1);           /* Initialize for write */
183         for (i = 0; i < 25; i++) {
184                 test |= 0x01;              /* Toggle SCK High */
185                 outb(test, dev->io + 1);
186                 test &= 0xfe;              /* Toggle SCK Low */
187                 outb(test, dev->io + 1);
188                 fifo = fifo << 1;            /* Prepare the next bit */
189                 test = 0x1c | ((fifo >> 23) & 0x02);
190                 outb(test, dev->io + 1);
191         }
192 }
193
194 static void cadet_setfreq(struct cadet *dev, unsigned freq)
195 {
196         unsigned fifo;
197         int i, j, test;
198         int curvol;
199
200         /*
201          * Formulate a fifo command
202          */
203         fifo = 0;
204         if (dev->curtuner == 0) {    /* FM */
205                 test = 102400;
206                 freq = freq / 16;       /* Make it kHz */
207                 freq += 10700;               /* IF is 10700 kHz */
208                 for (i = 0; i < 14; i++) {
209                         fifo = fifo << 1;
210                         if (freq >= test) {
211                                 fifo |= 0x01;
212                                 freq -= test;
213                         }
214                         test = test >> 1;
215                 }
216         }
217         if (dev->curtuner == 1) {    /* AM */
218                 fifo = (freq / 16) + 2010;            /* Make it kHz */
219                 fifo |= 0x100000;            /* Select AM Band */
220         }
221
222         /*
223          * Save current volume/mute setting
224          */
225
226         outb(7, dev->io);                /* Select tuner control */
227         curvol = inb(dev->io + 1);
228
229         /*
230          * Tune the card
231          */
232         for (j = 3; j > -1; j--) {
233                 cadet_settune(dev, fifo | (j << 16));
234
235                 outb(7, dev->io);         /* Select tuner control */
236                 outb(curvol, dev->io + 1);
237
238                 msleep(100);
239
240                 cadet_gettune(dev);
241                 if ((dev->tunestat & 0x40) == 0) {   /* Tuned */
242                         dev->sigstrength = sigtable[dev->curtuner][j];
243                         return;
244                 }
245         }
246         dev->sigstrength = 0;
247 }
248
249
250 static void cadet_handler(unsigned long data)
251 {
252         struct cadet *dev = (void *)data;
253
254         /* Service the RDS fifo */
255         if (mutex_trylock(&dev->lock)) {
256                 outb(0x3, dev->io);       /* Select RDS Decoder Control */
257                 if ((inb(dev->io + 1) & 0x20) != 0)
258                         printk(KERN_CRIT "cadet: RDS fifo overflow\n");
259                 outb(0x80, dev->io);      /* Select RDS fifo */
260                 while ((inb(dev->io) & 0x80) != 0) {
261                         dev->rdsbuf[dev->rdsin] = inb(dev->io + 1);
262                         if (dev->rdsin == dev->rdsout)
263                                 printk(KERN_WARNING "cadet: RDS buffer overflow\n");
264                         else
265                                 dev->rdsin++;
266                 }
267                 mutex_unlock(&dev->lock);
268         }
269
270         /*
271          * Service pending read
272          */
273         if (dev->rdsin != dev->rdsout)
274                 wake_up_interruptible(&dev->read_queue);
275
276         /*
277          * Clean up and exit
278          */
279         init_timer(&dev->readtimer);
280         dev->readtimer.function = cadet_handler;
281         dev->readtimer.data = (unsigned long)0;
282         dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
283         add_timer(&dev->readtimer);
284 }
285
286
287 static ssize_t cadet_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
288 {
289         struct cadet *dev = video_drvdata(file);
290         unsigned char readbuf[RDS_BUFFER];
291         int i = 0;
292
293         mutex_lock(&dev->lock);
294         if (dev->rdsstat == 0) {
295                 dev->rdsstat = 1;
296                 outb(0x80, dev->io);        /* Select RDS fifo */
297                 init_timer(&dev->readtimer);
298                 dev->readtimer.function = cadet_handler;
299                 dev->readtimer.data = (unsigned long)dev;
300                 dev->readtimer.expires = jiffies + msecs_to_jiffies(50);
301                 add_timer(&dev->readtimer);
302         }
303         if (dev->rdsin == dev->rdsout) {
304                 if (file->f_flags & O_NONBLOCK) {
305                         i = -EWOULDBLOCK;
306                         goto unlock;
307                 }
308                 interruptible_sleep_on(&dev->read_queue);
309         }
310         while (i < count && dev->rdsin != dev->rdsout)
311                 readbuf[i++] = dev->rdsbuf[dev->rdsout++];
312
313         if (copy_to_user(data, readbuf, i))
314                 i = -EFAULT;
315 unlock:
316         mutex_unlock(&dev->lock);
317         return i;
318 }
319
320
321 static int vidioc_querycap(struct file *file, void *priv,
322                                 struct v4l2_capability *v)
323 {
324         strlcpy(v->driver, "ADS Cadet", sizeof(v->driver));
325         strlcpy(v->card, "ADS Cadet", sizeof(v->card));
326         strlcpy(v->bus_info, "ISA", sizeof(v->bus_info));
327         v->device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO |
328                           V4L2_CAP_READWRITE | V4L2_CAP_RDS_CAPTURE;
329         v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
330         return 0;
331 }
332
333 static int vidioc_g_tuner(struct file *file, void *priv,
334                                 struct v4l2_tuner *v)
335 {
336         struct cadet *dev = video_drvdata(file);
337
338         v->type = V4L2_TUNER_RADIO;
339         switch (v->index) {
340         case 0:
341                 strlcpy(v->name, "FM", sizeof(v->name));
342                 v->capability = V4L2_TUNER_CAP_STEREO | V4L2_TUNER_CAP_RDS |
343                         V4L2_TUNER_CAP_RDS_BLOCK_IO | V4L2_TUNER_CAP_LOW;
344                 v->rangelow = 1400000;     /* 87.5 MHz */
345                 v->rangehigh = 1728000;    /* 108.0 MHz */
346                 v->rxsubchans = cadet_getstereo(dev);
347                 v->audmode = V4L2_TUNER_MODE_STEREO;
348                 v->rxsubchans |= V4L2_TUNER_SUB_RDS;
349                 break;
350         case 1:
351                 strlcpy(v->name, "AM", sizeof(v->name));
352                 v->capability = V4L2_TUNER_CAP_LOW;
353                 v->rangelow = 8320;      /* 520 kHz */
354                 v->rangehigh = 26400;    /* 1650 kHz */
355                 v->rxsubchans = V4L2_TUNER_SUB_MONO;
356                 v->audmode = V4L2_TUNER_MODE_MONO;
357                 break;
358         default:
359                 return -EINVAL;
360         }
361         v->signal = dev->sigstrength; /* We might need to modify scaling of this */
362         return 0;
363 }
364
365 static int vidioc_s_tuner(struct file *file, void *priv,
366                                 struct v4l2_tuner *v)
367 {
368         if (v->index != 0 && v->index != 1)
369                 return -EINVAL;
370         return 0;
371 }
372
373 static int vidioc_g_frequency(struct file *file, void *priv,
374                                 struct v4l2_frequency *f)
375 {
376         struct cadet *dev = video_drvdata(file);
377
378         if (f->tuner > 1)
379                 return -EINVAL;
380         f->type = V4L2_TUNER_RADIO;
381         f->frequency = cadet_getfreq(dev);
382         return 0;
383 }
384
385
386 static int vidioc_s_frequency(struct file *file, void *priv,
387                                 struct v4l2_frequency *f)
388 {
389         struct cadet *dev = video_drvdata(file);
390
391         if (f->type != V4L2_TUNER_RADIO)
392                 return -EINVAL;
393         if (f->tuner == 0) {
394                 if (f->frequency < 1400000)
395                         f->frequency = 1400000;
396                 else if (f->frequency > 1728000)
397                         f->frequency = 1728000;
398         } else if (f->tuner == 1) {
399                 if (f->frequency < 8320)
400                         f->frequency = 8320;
401                 else if (f->frequency > 26400)
402                         f->frequency = 26400;
403         } else
404                 return -EINVAL;
405         cadet_setfreq(dev, f->frequency);
406         return 0;
407 }
408
409 static int cadet_s_ctrl(struct v4l2_ctrl *ctrl)
410 {
411         struct cadet *dev = container_of(ctrl->handler, struct cadet, ctrl_handler);
412
413         switch (ctrl->id) {
414         case V4L2_CID_AUDIO_MUTE:
415                 outb(7, dev->io);                /* Select tuner control */
416                 if (ctrl->val)
417                         outb(0x00, dev->io + 1);
418                 else
419                         outb(0x20, dev->io + 1);
420                 return 0;
421         }
422         return -EINVAL;
423 }
424
425 static int cadet_open(struct file *file)
426 {
427         struct cadet *dev = video_drvdata(file);
428         int err;
429
430         mutex_lock(&dev->lock);
431         err = v4l2_fh_open(file);
432         if (err)
433                 goto fail;
434         if (v4l2_fh_is_singular_file(file))
435                 init_waitqueue_head(&dev->read_queue);
436 fail:
437         mutex_unlock(&dev->lock);
438         return err;
439 }
440
441 static int cadet_release(struct file *file)
442 {
443         struct cadet *dev = video_drvdata(file);
444
445         mutex_lock(&dev->lock);
446         if (v4l2_fh_is_singular_file(file) && dev->rdsstat) {
447                 del_timer_sync(&dev->readtimer);
448                 dev->rdsstat = 0;
449         }
450         v4l2_fh_release(file);
451         mutex_unlock(&dev->lock);
452         return 0;
453 }
454
455 static unsigned int cadet_poll(struct file *file, struct poll_table_struct *wait)
456 {
457         struct cadet *dev = video_drvdata(file);
458         unsigned int res = v4l2_ctrl_poll(file, wait);
459
460         poll_wait(file, &dev->read_queue, wait);
461         if (dev->rdsin != dev->rdsout)
462                 res |= POLLIN | POLLRDNORM;
463         return res;
464 }
465
466
467 static const struct v4l2_file_operations cadet_fops = {
468         .owner          = THIS_MODULE,
469         .open           = cadet_open,
470         .release        = cadet_release,
471         .read           = cadet_read,
472         .unlocked_ioctl = video_ioctl2,
473         .poll           = cadet_poll,
474 };
475
476 static const struct v4l2_ioctl_ops cadet_ioctl_ops = {
477         .vidioc_querycap    = vidioc_querycap,
478         .vidioc_g_tuner     = vidioc_g_tuner,
479         .vidioc_s_tuner     = vidioc_s_tuner,
480         .vidioc_g_frequency = vidioc_g_frequency,
481         .vidioc_s_frequency = vidioc_s_frequency,
482         .vidioc_log_status  = v4l2_ctrl_log_status,
483         .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
484         .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
485 };
486
487 static const struct v4l2_ctrl_ops cadet_ctrl_ops = {
488         .s_ctrl = cadet_s_ctrl,
489 };
490
491 #ifdef CONFIG_PNP
492
493 static struct pnp_device_id cadet_pnp_devices[] = {
494         /* ADS Cadet AM/FM Radio Card */
495         {.id = "MSM0c24", .driver_data = 0},
496         {.id = ""}
497 };
498
499 MODULE_DEVICE_TABLE(pnp, cadet_pnp_devices);
500
501 static int cadet_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
502 {
503         if (!dev)
504                 return -ENODEV;
505         /* only support one device */
506         if (io > 0)
507                 return -EBUSY;
508
509         if (!pnp_port_valid(dev, 0))
510                 return -ENODEV;
511
512         io = pnp_port_start(dev, 0);
513
514         printk(KERN_INFO "radio-cadet: PnP reports device at %#x\n", io);
515
516         return io;
517 }
518
519 static struct pnp_driver cadet_pnp_driver = {
520         .name           = "radio-cadet",
521         .id_table       = cadet_pnp_devices,
522         .probe          = cadet_pnp_probe,
523         .remove         = NULL,
524 };
525
526 #else
527 static struct pnp_driver cadet_pnp_driver;
528 #endif
529
530 static void cadet_probe(struct cadet *dev)
531 {
532         static int iovals[8] = { 0x330, 0x332, 0x334, 0x336, 0x338, 0x33a, 0x33c, 0x33e };
533         int i;
534
535         for (i = 0; i < 8; i++) {
536                 dev->io = iovals[i];
537                 if (request_region(dev->io, 2, "cadet-probe")) {
538                         cadet_setfreq(dev, 1410);
539                         if (cadet_getfreq(dev) == 1410) {
540                                 release_region(dev->io, 2);
541                                 return;
542                         }
543                         release_region(dev->io, 2);
544                 }
545         }
546         dev->io = -1;
547 }
548
549 /*
550  * io should only be set if the user has used something like
551  * isapnp (the userspace program) to initialize this card for us
552  */
553
554 static int __init cadet_init(void)
555 {
556         struct cadet *dev = &cadet_card;
557         struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
558         struct v4l2_ctrl_handler *hdl;
559         int res = -ENODEV;
560
561         strlcpy(v4l2_dev->name, "cadet", sizeof(v4l2_dev->name));
562         mutex_init(&dev->lock);
563
564         /* If a probe was requested then probe ISAPnP first (safest) */
565         if (io < 0)
566                 pnp_register_driver(&cadet_pnp_driver);
567         dev->io = io;
568
569         /* If that fails then probe unsafely if probe is requested */
570         if (dev->io < 0)
571                 cadet_probe(dev);
572
573         /* Else we bail out */
574         if (dev->io < 0) {
575 #ifdef MODULE
576                 v4l2_err(v4l2_dev, "you must set an I/O address with io=0x330, 0x332, 0x334,\n");
577                 v4l2_err(v4l2_dev, "0x336, 0x338, 0x33a, 0x33c or 0x33e\n");
578 #endif
579                 goto fail;
580         }
581         if (!request_region(dev->io, 2, "cadet"))
582                 goto fail;
583
584         res = v4l2_device_register(NULL, v4l2_dev);
585         if (res < 0) {
586                 release_region(dev->io, 2);
587                 v4l2_err(v4l2_dev, "could not register v4l2_device\n");
588                 goto fail;
589         }
590
591         hdl = &dev->ctrl_handler;
592         v4l2_ctrl_handler_init(hdl, 2);
593         v4l2_ctrl_new_std(hdl, &cadet_ctrl_ops,
594                         V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
595         v4l2_dev->ctrl_handler = hdl;
596         if (hdl->error) {
597                 res = hdl->error;
598                 v4l2_err(v4l2_dev, "Could not register controls\n");
599                 goto err_hdl;
600         }
601
602         strlcpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
603         dev->vdev.v4l2_dev = v4l2_dev;
604         dev->vdev.fops = &cadet_fops;
605         dev->vdev.ioctl_ops = &cadet_ioctl_ops;
606         dev->vdev.release = video_device_release_empty;
607         dev->vdev.lock = &dev->lock;
608         set_bit(V4L2_FL_USE_FH_PRIO, &dev->vdev.flags);
609         video_set_drvdata(&dev->vdev, dev);
610
611         if (video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr) < 0)
612                 goto err_hdl;
613         v4l2_info(v4l2_dev, "ADS Cadet Radio Card at 0x%x\n", dev->io);
614         return 0;
615 err_hdl:
616         v4l2_ctrl_handler_free(hdl);
617         v4l2_device_unregister(v4l2_dev);
618         release_region(dev->io, 2);
619 fail:
620         pnp_unregister_driver(&cadet_pnp_driver);
621         return res;
622 }
623
624 static void __exit cadet_exit(void)
625 {
626         struct cadet *dev = &cadet_card;
627
628         video_unregister_device(&dev->vdev);
629         v4l2_ctrl_handler_free(&dev->ctrl_handler);
630         v4l2_device_unregister(&dev->v4l2_dev);
631         release_region(dev->io, 2);
632         pnp_unregister_driver(&cadet_pnp_driver);
633 }
634
635 module_init(cadet_init);
636 module_exit(cadet_exit);
637