1 /* radio-cadet.c - A video4linux driver for the ADS Cadet AM/FM Radio Card
 
   3  * by Fred Gleason <fredg@wava.com>
 
   6  * (Loosely) based on code for the Aztech radio card by
 
   8  * Russell Kroll    (rkroll@exploits.org)
 
  11  * Jason Lewis      (jlewis@twilight.vtc.vsc.edu)
 
  12  * Scott McGrath    (smcgrath@twilight.vtc.vsc.edu)
 
  13  * William McGrath  (wmcgrath@twilight.vtc.vsc.edu)
 
  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@redhat.com>
 
  27  *              Cleaned up locking, delay code, general odds and ends
 
  29  * 2006-07-30   Hans J. Koch <koch@hjk-az.de>
 
  33 #include <linux/version.h>
 
  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 <asm/io.h>             /* outb, outb_p                 */
 
  39 #include <asm/uaccess.h>        /* copy to/from user            */
 
  40 #include <linux/videodev2.h>    /* V4L2 API defs                */
 
  41 #include <media/v4l2-common.h>
 
  42 #include <linux/param.h>
 
  43 #include <linux/pnp.h>
 
  45 #define RDS_BUFFER 256
 
  49 #define CADET_VERSION KERNEL_VERSION(0,3,3)
 
  51 static struct v4l2_queryctrl radio_qctrl[] = {
 
  53                 .id            = V4L2_CID_AUDIO_MUTE,
 
  58                 .type          = V4L2_CTRL_TYPE_BOOLEAN,
 
  60                 .id            = V4L2_CID_AUDIO_VOLUME,
 
  65                 .default_value = 0xff,
 
  66                 .type          = V4L2_CTRL_TYPE_INTEGER,
 
  70 static int io=-1;               /* default to isapnp activation */
 
  71 static int radio_nr = -1;
 
  73 static int curtuner=0;
 
  74 static int tunestat=0;
 
  75 static int sigstrength=0;
 
  76 static wait_queue_head_t read_queue;
 
  77 static struct timer_list readtimer;
 
  78 static __u8 rdsin=0,rdsout=0,rdsstat=0;
 
  79 static unsigned char rdsbuf[RDS_BUFFER];
 
  80 static spinlock_t cadet_io_lock;
 
  82 static int cadet_probe(void);
 
  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]={{5,10,30,150},{28,40,63,1000}};
 
  95         int ret = V4L2_TUNER_SUB_MONO;
 
  96         if(curtuner != 0)       /* Only FM has stereo capability! */
 
  97                 return V4L2_TUNER_SUB_MONO;
 
  99         spin_lock(&cadet_io_lock);
 
 100         outb(7,io);          /* Select tuner control */
 
 101         if( (inb(io+1) & 0x40) == 0)
 
 102                 ret = V4L2_TUNER_SUB_STEREO;
 
 103         spin_unlock(&cadet_io_lock);
 
 117         spin_lock(&cadet_io_lock);
 
 119         outb(7,io);       /* Select tuner control */
 
 120         curvol=inb(io+1); /* Save current volume/mute setting */
 
 121         outb(0x00,io+1);  /* Ensure WRITE-ENABLE is LOW */
 
 125          * Read the shift register
 
 128                 fifo=(fifo<<1)|((inb(io+1)>>7)&0x01);
 
 137          * Restore volume/mute setting
 
 140         spin_unlock(&cadet_io_lock);
 
 149         unsigned freq=0,test,fifo=0;
 
 152          * Read current tuning
 
 154         fifo=cadet_gettune();
 
 157          * Convert to actual frequency
 
 159         if(curtuner==0) {    /* FM */
 
 168                 freq-=10700000;           /* IF frequency is 10.7 MHz */
 
 169                 freq=(freq*16)/1000000;   /* Make it 1/16 MHz */
 
 171         if(curtuner==1) {    /* AM */
 
 172                 freq=((fifo&0x7fff)-2010)*16;
 
 179 cadet_settune(unsigned fifo)
 
 184         spin_lock(&cadet_io_lock);
 
 186         outb(7,io);                /* Select tuner control */
 
 188          * Write the shift register
 
 191         test=(fifo>>23)&0x02;      /* Align data for SDO */
 
 192         test|=0x1c;                /* SDM=1, SWE=1, SEN=1, SCK=0 */
 
 193         outb(7,io);                /* Select tuner control */
 
 194         outb(test,io+1);           /* Initialize for write */
 
 196                 test|=0x01;              /* Toggle SCK High */
 
 198                 test&=0xfe;              /* Toggle SCK Low */
 
 200                 fifo=fifo<<1;            /* Prepare the next bit */
 
 201                 test=0x1c|((fifo>>23)&0x02);
 
 204         spin_unlock(&cadet_io_lock);
 
 208 cadet_setfreq(unsigned freq)
 
 215          * Formulate a fifo command
 
 218         if(curtuner==0) {    /* FM */
 
 220                 freq=(freq*1000)/16;       /* Make it kHz */
 
 221                 freq+=10700;               /* IF is 10700 kHz */
 
 231         if(curtuner==1) {    /* AM */
 
 232                 fifo=(freq/16)+2010;            /* Make it kHz */
 
 233                 fifo|=0x100000;            /* Select AM Band */
 
 237          * Save current volume/mute setting
 
 240         spin_lock(&cadet_io_lock);
 
 241         outb(7,io);                /* Select tuner control */
 
 243         spin_unlock(&cadet_io_lock);
 
 249                 cadet_settune(fifo|(j<<16));
 
 251                 spin_lock(&cadet_io_lock);
 
 252                 outb(7,io);         /* Select tuner control */
 
 254                 spin_unlock(&cadet_io_lock);
 
 259                 if((tunestat & 0x40) == 0) {   /* Tuned */
 
 260                         sigstrength=sigtable[curtuner][j];
 
 273         spin_lock(&cadet_io_lock);
 
 275         outb(7,io);                /* Select tuner control */
 
 276         if((inb(io + 1) & 0x20) != 0)
 
 279         spin_unlock(&cadet_io_lock);
 
 285 cadet_setvol(int vol)
 
 287         spin_lock(&cadet_io_lock);
 
 288         outb(7,io);                /* Select tuner control */
 
 293         spin_unlock(&cadet_io_lock);
 
 297 cadet_handler(unsigned long data)
 
 300          * Service the RDS fifo
 
 303         if(spin_trylock(&cadet_io_lock))
 
 305                 outb(0x3,io);       /* Select RDS Decoder Control */
 
 306                 if((inb(io+1)&0x20)!=0) {
 
 307                         printk(KERN_CRIT "cadet: RDS fifo overflow\n");
 
 309                 outb(0x80,io);      /* Select RDS fifo */
 
 310                 while((inb(io)&0x80)!=0) {
 
 311                         rdsbuf[rdsin]=inb(io+1);
 
 313                                 printk(KERN_WARNING "cadet: RDS buffer overflow\n");
 
 317                 spin_unlock(&cadet_io_lock);
 
 321          * Service pending read
 
 324                 wake_up_interruptible(&read_queue);
 
 329         init_timer(&readtimer);
 
 330         readtimer.function=cadet_handler;
 
 331         readtimer.data=(unsigned long)0;
 
 332         readtimer.expires=jiffies+msecs_to_jiffies(50);
 
 333         add_timer(&readtimer);
 
 339 cadet_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
 
 342         unsigned char readbuf[RDS_BUFFER];
 
 345                 spin_lock(&cadet_io_lock);
 
 347                 outb(0x80,io);        /* Select RDS fifo */
 
 348                 spin_unlock(&cadet_io_lock);
 
 349                 init_timer(&readtimer);
 
 350                 readtimer.function=cadet_handler;
 
 351                 readtimer.data=(unsigned long)0;
 
 352                 readtimer.expires=jiffies+msecs_to_jiffies(50);
 
 353                 add_timer(&readtimer);
 
 356                 if (file->f_flags & O_NONBLOCK)
 
 358                 interruptible_sleep_on(&read_queue);
 
 360         while( i<count && rdsin!=rdsout)
 
 361                 readbuf[i++]=rdsbuf[rdsout++];
 
 363         if (copy_to_user(data,readbuf,i))
 
 369 static int vidioc_querycap(struct file *file, void *priv,
 
 370                                 struct v4l2_capability *v)
 
 375         v->version = CADET_VERSION;
 
 376         strcpy(v->driver, "ADS Cadet");
 
 377         strcpy(v->card, "ADS Cadet");
 
 381 static int vidioc_g_tuner(struct file *file, void *priv,
 
 382                                 struct v4l2_tuner *v)
 
 384         v->type = V4L2_TUNER_RADIO;
 
 387                 strcpy(v->name, "FM");
 
 388                 v->capability = V4L2_TUNER_CAP_STEREO;
 
 389                 v->rangelow = 1400;     /* 87.5 MHz */
 
 390                 v->rangehigh = 1728;    /* 108.0 MHz */
 
 391                 v->rxsubchans=cadet_getstereo();
 
 392                 switch (v->rxsubchans){
 
 393                 case V4L2_TUNER_SUB_MONO:
 
 394                         v->audmode = V4L2_TUNER_MODE_MONO;
 
 396                 case V4L2_TUNER_SUB_STEREO:
 
 397                         v->audmode = V4L2_TUNER_MODE_STEREO;
 
 403                 strcpy(v->name, "AM");
 
 404                 v->capability = V4L2_TUNER_CAP_LOW;
 
 405                 v->rangelow = 8320;      /* 520 kHz */
 
 406                 v->rangehigh = 26400;    /* 1650 kHz */
 
 407                 v->rxsubchans = V4L2_TUNER_SUB_MONO;
 
 408                 v->audmode = V4L2_TUNER_MODE_MONO;
 
 413         v->signal = sigstrength; /* We might need to modify scaling of this */
 
 417 static int vidioc_s_tuner(struct file *file, void *priv,
 
 418                                 struct v4l2_tuner *v)
 
 420         if((v->index != 0)&&(v->index != 1))
 
 426 static int vidioc_g_frequency(struct file *file, void *priv,
 
 427                                 struct v4l2_frequency *f)
 
 430         f->type = V4L2_TUNER_RADIO;
 
 431         f->frequency = cadet_getfreq();
 
 436 static int vidioc_s_frequency(struct file *file, void *priv,
 
 437                                 struct v4l2_frequency *f)
 
 439         if (f->type != V4L2_TUNER_RADIO)
 
 441         if((curtuner==0)&&((f->frequency<1400)||(f->frequency>1728)))
 
 443         if((curtuner==1)&&((f->frequency<8320)||(f->frequency>26400)))
 
 445         cadet_setfreq(f->frequency);
 
 449 static int vidioc_queryctrl(struct file *file, void *priv,
 
 450                                 struct v4l2_queryctrl *qc)
 
 454         for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
 
 455                 if (qc->id && qc->id == radio_qctrl[i].id) {
 
 456                         memcpy(qc, &(radio_qctrl[i]),
 
 464 static int vidioc_g_ctrl(struct file *file, void *priv,
 
 465                                 struct v4l2_control *ctrl)
 
 468         case V4L2_CID_AUDIO_MUTE: /* TODO: Handle this correctly */
 
 469                 ctrl->value = (cadet_getvol() == 0);
 
 471         case V4L2_CID_AUDIO_VOLUME:
 
 472                 ctrl->value = cadet_getvol();
 
 480 static int vidioc_s_ctrl(struct file *file, void *priv,
 
 481                                 struct v4l2_control *ctrl)
 
 484         case V4L2_CID_AUDIO_MUTE: /* TODO: Handle this correctly */
 
 488                         cadet_setvol(0xffff);
 
 490         case V4L2_CID_AUDIO_VOLUME:
 
 491                 cadet_setvol(ctrl->value);
 
 499 static int vidioc_g_audio(struct file *file, void *priv,
 
 500                                 struct v4l2_audio *a)
 
 504         strcpy(a->name, "Radio");
 
 505         a->capability = V4L2_AUDCAP_STEREO;
 
 509 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
 
 515 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
 
 522 static int vidioc_s_audio(struct file *file, void *priv,
 
 523                                 struct v4l2_audio *a)
 
 531 cadet_open(struct inode *inode, struct file *file)
 
 534         if (1 == users) init_waitqueue_head(&read_queue);
 
 539 cadet_release(struct inode *inode, struct file *file)
 
 543                 del_timer_sync(&readtimer);
 
 550 cadet_poll(struct file *file, struct poll_table_struct *wait)
 
 552         poll_wait(file,&read_queue,wait);
 
 554                 return POLLIN | POLLRDNORM;
 
 559 static const struct file_operations cadet_fops = {
 
 560         .owner          = THIS_MODULE,
 
 562         .release        = cadet_release,
 
 564         .ioctl          = video_ioctl2,
 
 566         .compat_ioctl   = v4l_compat_ioctl32,
 
 570 static struct video_device cadet_radio=
 
 572         .owner          = THIS_MODULE,
 
 573         .name           = "Cadet radio",
 
 574         .type           = VID_TYPE_TUNER,
 
 576         .vidioc_querycap    = vidioc_querycap,
 
 577         .vidioc_g_tuner     = vidioc_g_tuner,
 
 578         .vidioc_s_tuner     = vidioc_s_tuner,
 
 579         .vidioc_g_frequency = vidioc_g_frequency,
 
 580         .vidioc_s_frequency = vidioc_s_frequency,
 
 581         .vidioc_queryctrl   = vidioc_queryctrl,
 
 582         .vidioc_g_ctrl      = vidioc_g_ctrl,
 
 583         .vidioc_s_ctrl      = vidioc_s_ctrl,
 
 584         .vidioc_g_audio     = vidioc_g_audio,
 
 585         .vidioc_s_audio     = vidioc_s_audio,
 
 586         .vidioc_g_input     = vidioc_g_input,
 
 587         .vidioc_s_input     = vidioc_s_input,
 
 590 static struct pnp_device_id cadet_pnp_devices[] = {
 
 591         /* ADS Cadet AM/FM Radio Card */
 
 592         {.id = "MSM0c24", .driver_data = 0},
 
 596 MODULE_DEVICE_TABLE(pnp, cadet_pnp_devices);
 
 598 static int cadet_pnp_probe(struct pnp_dev * dev, const struct pnp_device_id *dev_id)
 
 602         /* only support one device */
 
 606         if (!pnp_port_valid(dev, 0)) {
 
 610         io = pnp_port_start(dev, 0);
 
 612         printk ("radio-cadet: PnP reports device at %#x\n", io);
 
 617 static struct pnp_driver cadet_pnp_driver = {
 
 618         .name           = "radio-cadet",
 
 619         .id_table       = cadet_pnp_devices,
 
 620         .probe          = cadet_pnp_probe,
 
 624 static int cadet_probe(void)
 
 626         static int iovals[8]={0x330,0x332,0x334,0x336,0x338,0x33a,0x33c,0x33e};
 
 631                 if (request_region(io, 2, "cadet-probe")) {
 
 633                         if(cadet_getfreq()==1410) {
 
 634                                 release_region(io, 2);
 
 637                         release_region(io, 2);
 
 644  * io should only be set if the user has used something like
 
 645  * isapnp (the userspace program) to initialize this card for us
 
 648 static int __init cadet_init(void)
 
 650         spin_lock_init(&cadet_io_lock);
 
 653          *      If a probe was requested then probe ISAPnP first (safest)
 
 656                 pnp_register_driver(&cadet_pnp_driver);
 
 658          *      If that fails then probe unsafely if probe is requested
 
 669                 printk(KERN_ERR "You must set an I/O address with io=0x???\n");
 
 673         if (!request_region(io,2,"cadet"))
 
 675         if(video_register_device(&cadet_radio,VFL_TYPE_RADIO,radio_nr)==-1) {
 
 676                 release_region(io,2);
 
 679         printk(KERN_INFO "ADS Cadet Radio Card at 0x%x\n",io);
 
 682         pnp_unregister_driver(&cadet_pnp_driver);
 
 688 MODULE_AUTHOR("Fred Gleason, Russell Kroll, Quay Lu, Donald Song, Jason Lewis, Scott McGrath, William McGrath");
 
 689 MODULE_DESCRIPTION("A driver for the ADS Cadet AM/FM/RDS radio card.");
 
 690 MODULE_LICENSE("GPL");
 
 692 module_param(io, int, 0);
 
 693 MODULE_PARM_DESC(io, "I/O address of Cadet card (0x330,0x332,0x334,0x336,0x338,0x33a,0x33c,0x33e)");
 
 694 module_param(radio_nr, int, 0);
 
 696 static void __exit cadet_cleanup_module(void)
 
 698         video_unregister_device(&cadet_radio);
 
 699         release_region(io,2);
 
 700         pnp_unregister_driver(&cadet_pnp_driver);
 
 703 module_init(cadet_init);
 
 704 module_exit(cadet_cleanup_module);